merge dev to main (v2.2.0) (#1497)

zenstackhq · Jun 9, 2024 · b9c7572 · b9c7572
2 parents 71a389c + 28c2bc8
commit b9c7572
Show file tree

Hide file tree

Showing 80 changed files with 5,521 additions and 1,363 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,3 @@
+* text=auto eol=lf
+
+*.bat text=auto eol=crlf
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,10 +5,24 @@ I want to think you first for considering contributing to ZenStack 🙏🏻. It'
 ## Prerequisites
 
 -   [Node.js](https://nodejs.org/): v18 or above
--   [pnpm](https://pnpm.io/): latest version
+-   [pnpm](https://pnpm.io/): v8.x
+
+If you want to run the tests, you should be aware that some of the integration tests run against postgres. These tests will attempt to set up and subsequently their own database, so you'll need to provide a connection details for a postgres user with at least those permissions. To provide connection details, you can configure the following environment variables or provide them when executing `pnpm test` commands.
+
+- `ZENSTACK_TEST_DB_USER`: The postgres username, for a user with permission to create/drop databases. Default: `postgres`.
+- `ZENSTACK_TEST_DB_PASS`: Password for said user. Default: `abc123`.
+- `ZENSTACK_TEST_DB_NAME`: Default database to connect onto. This database isn't used any further, so it's recommended to just use the default `postgres` database. Default: `postgres`.
+- `ZENSTACK_TEST_DB_HOST`: Hostname or IP to connect onto. Default: `localhost`.
+- `ZENSTACK_TEST_DB_PORT`: Port number to connect onto. Default: `5432`.
 
 ## Get started
 
+1. (Windows only) Your environment should support symlinks, by enabling "Developer mode" in `Settings => System => For developers` (Windows 10/11 only) and setting the `core.symlinks` setting in git to `true`. For more info [refer to this StackOverflow answer](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows/59761201#59761201).
+
+    ```pwsh
+    git config --global core.symlinks true
+    ```
+
 1. Make a fork of the repository
 
     Make sure all branches are included.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "zenstack-monorepo",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "description": "",
     "scripts": {
         "build": "pnpm -r build",

diff --git a/packages/ide/jetbrains/build.gradle.kts b/packages/ide/jetbrains/build.gradle.kts
@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "dev.zenstack"
-version = "2.1.2"
+version = "2.2.0"
 
 repositories {
     mavenCentral()

diff --git a/packages/ide/jetbrains/package.json b/packages/ide/jetbrains/package.json
@@ -1,17 +1,20 @@
 {
   "name": "jetbrains",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "displayName": "ZenStack JetBrains IDE Plugin",
   "description": "ZenStack JetBrains IDE plugin",
   "homepage": "https://zenstack.dev",
   "private": true,
   "scripts": {
-    "build": "./gradlew buildPlugin"
+    "build": "run-script-os",
+    "build:win32": "gradlew.bat buildPlugin",
+    "build:default": "./gradlew buildPlugin"
   },
   "author": "ZenStack Team",
   "license": "MIT",
   "devDependencies": {
-    "zenstack": "workspace:*",
-    "@zenstackhq/language": "workspace:*"
+    "@zenstackhq/language": "workspace:*",
+    "run-script-os": "^1.1.6",
+    "zenstack": "workspace:*"
   }
 }
diff --git a/packages/language/package.json b/packages/language/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/language",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "displayName": "ZenStack modeling language compiler",
     "description": "ZenStack modeling language compiler",
     "homepage": "https://zenstack.dev",
@@ -9,7 +9,7 @@
         "generate": "langium generate && npx ts-node script/generate-plist.ts",
         "watch": "concurrently \"langium generate --watch\" \"tsc --watch\"",
         "lint": "eslint src --ext ts",
-        "build": "pnpm lint --max-warnings=0 && pnpm clean && pnpm generate && tsc && copyfiles -F ./README.md ./LICENSE ./package.json 'syntaxes/**/*' dist && pnpm pack dist --pack-destination ../../../.build",
+        "build": "pnpm lint --max-warnings=0 && pnpm clean && pnpm generate && tsc && copyfiles -F ./README.md ./LICENSE ./package.json \"syntaxes/**/*\" dist && pnpm pack dist --pack-destination ../../../.build",
         "prepublishOnly": "pnpm build"
     },
     "publishConfig": {

diff --git a/packages/misc/redwood/package.json b/packages/misc/redwood/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/redwood",
     "displayName": "ZenStack RedwoodJS Integration",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "description": "CLI and runtime for integrating ZenStack with RedwoodJS projects.",
     "repository": {
         "type": "git",

diff --git a/packages/plugins/openapi/package.json b/packages/plugins/openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@zenstackhq/openapi",
   "displayName": "ZenStack Plugin and Runtime for OpenAPI",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "ZenStack plugin and runtime supporting OpenAPI",
   "main": "index.js",
   "repository": {

diff --git a/packages/plugins/swr/package.json b/packages/plugins/swr/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/swr",
     "displayName": "ZenStack plugin for generating SWR hooks",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "description": "ZenStack plugin for generating SWR hooks",
     "main": "index.js",
     "repository": {

diff --git a/packages/plugins/tanstack-query/package.json b/packages/plugins/tanstack-query/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/tanstack-query",
     "displayName": "ZenStack plugin for generating tanstack-query hooks",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "description": "ZenStack plugin for generating tanstack-query hooks",
     "main": "index.js",
     "exports": {
@@ -110,6 +110,7 @@
         "replace-in-file": "^7.0.1",
         "svelte": "^4.2.1",
         "swr": "^2.0.3",
+        "tmp": "^0.2.3",
         "vue": "^3.3.4"
     }
 }
diff --git a/packages/plugins/tanstack-query/src/generator.ts b/packages/plugins/tanstack-query/src/generator.ts
@@ -136,8 +136,8 @@ function generateQueryHook(
         });
 
         if (version === 'v5' && infinite && ['react', 'svelte'].includes(target)) {
-            // initialPageParam and getNextPageParam options are required in v5
-            func.addStatements([`options = options ?? { initialPageParam: undefined, getNextPageParam: () => null };`]);
+            // getNextPageParam option is required in v5
+            func.addStatements([`options = options ?? { getNextPageParam: () => null };`]);
         }
 
         func.addStatements([
@@ -668,20 +668,20 @@ function makeQueryOptions(
                     ? `Omit<UseInfiniteQueryOptions<${returnType}, TError, ${dataType}>, 'queryKey'>`
                     : `Omit<Use${
                           suspense ? 'Suspense' : ''
-                      }InfiniteQueryOptions<${returnType}, TError, InfiniteData<${dataType}>>, 'queryKey'>`
+                      }InfiniteQueryOptions<${returnType}, TError, InfiniteData<${dataType}>>, 'queryKey' | 'initialPageParam'>`
                 : `Omit<Use${suspense ? 'Suspense' : ''}QueryOptions<${returnType}, TError, ${dataType}>, 'queryKey'>`
         )
         .with('vue', () => {
-            const baseOption = `Omit<Use${
-                infinite ? 'Infinite' : ''
-            }QueryOptions<${returnType}, TError, ${dataType}>, 'queryKey'>`;
+            const baseOption = infinite
+                ? `Omit<UseInfiniteQueryOptions<${returnType}, TError, InfiniteData<${dataType}>>, 'queryKey' | 'initialPageParam'>`
+                : `Omit<UseQueryOptions<${returnType}, TError, ${dataType}>, 'queryKey'>`;
             return `MaybeRefOrGetter<${baseOption}> | ComputedRef<${baseOption}>`;
         })
         .with('svelte', () =>
             infinite
                 ? version === 'v4'
                     ? `Omit<CreateInfiniteQueryOptions<${returnType}, TError, ${dataType}>, 'queryKey'>`
-                    : `StoreOrVal<Omit<CreateInfiniteQueryOptions<${returnType}, TError, InfiniteData<${dataType}>>, 'queryKey'>>`
+                    : `StoreOrVal<Omit<CreateInfiniteQueryOptions<${returnType}, TError, InfiniteData<${dataType}>>, 'queryKey' | 'initialPageParam'>>`
                 : version === 'v4'
                 ? `Omit<CreateQueryOptions<${returnType}, TError, ${dataType}>, 'queryKey'>`
                 : `StoreOrVal<Omit<CreateQueryOptions<${returnType}, TError, ${dataType}>, 'queryKey'>>`

diff --git a/packages/plugins/tanstack-query/src/runtime-v5/react.ts b/packages/plugins/tanstack-query/src/runtime-v5/react.ts
@@ -120,14 +120,15 @@ export function useInfiniteModelQuery<TQueryFnData, TData, TError>(
     model: string,
     url: string,
     args: unknown,
-    options: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey'>,
+    options: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>,
     fetch?: FetchFn
 ) {
     return useInfiniteQuery({
         queryKey: getQueryKey(model, url, args, { infinite: true, optimisticUpdate: false }),
         queryFn: ({ pageParam }) => {
             return fetcher<TQueryFnData, false>(makeUrl(url, pageParam ?? args), undefined, fetch, false);
         },
+        initialPageParam: args,
         ...options,
     });
 }
@@ -146,14 +147,18 @@ export function useSuspenseInfiniteModelQuery<TQueryFnData, TData, TError>(
     model: string,
     url: string,
     args: unknown,
-    options: Omit<UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey'>,
+    options: Omit<
+        UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>,
+        'queryKey' | 'initialPageParam'
+    >,
     fetch?: FetchFn
 ) {
     return useSuspenseInfiniteQuery({
         queryKey: getQueryKey(model, url, args, { infinite: true, optimisticUpdate: false }),
         queryFn: ({ pageParam }) => {
             return fetcher<TQueryFnData, false>(makeUrl(url, pageParam ?? args), undefined, fetch, false);
         },
+        initialPageParam: args,
         ...options,
     });
 }

diff --git a/packages/plugins/tanstack-query/src/runtime-v5/svelte.ts b/packages/plugins/tanstack-query/src/runtime-v5/svelte.ts
@@ -91,7 +91,7 @@ export function useModelQuery<TQueryFnData, TData, TError>(
             ...options,
         };
     }
-    return createQuery(mergedOpt);
+    return createQuery<TQueryFnData, TError, TData>(mergedOpt);
 }
 
 /**
@@ -107,20 +107,27 @@ export function useInfiniteModelQuery<TQueryFnData, TData, TError>(
     model: string,
     url: string,
     args: unknown,
-    options: StoreOrVal<Omit<CreateInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey'>>,
+    options: StoreOrVal<
+        Omit<CreateInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>
+    >,
     fetch?: FetchFn
 ) {
     const queryKey = getQueryKey(model, url, args, { infinite: true, optimisticUpdate: false });
     const queryFn = ({ pageParam }: { pageParam: unknown }) =>
         fetcher<TQueryFnData, false>(makeUrl(url, pageParam ?? args), undefined, fetch, false);
 
     let mergedOpt: StoreOrVal<CreateInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>>;
-    if (isStore<CreateInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>>(options)) {
+    if (
+        isStore<
+            Omit<CreateInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>
+        >(options)
+    ) {
         // options is store
         mergedOpt = derived([options], ([$opt]) => {
             return {
                 queryKey,
                 queryFn,
+                initialPageParam: args,
                 ...$opt,
             };
         });
@@ -129,6 +136,7 @@ export function useInfiniteModelQuery<TQueryFnData, TData, TError>(
         mergedOpt = {
             queryKey,
             queryFn,
+            initialPageParam: args,
             ...options,
         };
     }

diff --git a/packages/plugins/tanstack-query/src/runtime/vue.ts b/packages/plugins/tanstack-query/src/runtime/vue.ts
@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/ban-types */
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import type { InfiniteData } from '@tanstack/react-query-v5';
 import {
     useInfiniteQuery,
     useMutation,
@@ -103,8 +104,12 @@ export function useInfiniteModelQuery<TQueryFnData, TData, TError>(
     url: string,
     args?: MaybeRefOrGetter<unknown> | ComputedRef<unknown>,
     options?:
-        | MaybeRefOrGetter<Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData>, 'queryKey'>>
-        | ComputedRef<Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData>, 'queryKey'>>,
+        | MaybeRefOrGetter<
+              Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>
+          >
+        | ComputedRef<
+              Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>
+          >,
     fetch?: FetchFn
 ) {
     // CHECKME: vue-query's `useInfiniteQuery`'s input typing seems wrong
@@ -115,10 +120,11 @@ export function useInfiniteModelQuery<TQueryFnData, TData, TError>(
             const reqUrl = makeUrl(url, pageParam ?? toValue(args));
             return fetcher<TQueryFnData, false>(reqUrl, undefined, fetch, false);
         },
+        initialPageParam: toValue(args),
         ...toValue(options),
     }));
 
-    return useInfiniteQuery<TQueryFnData, TError, TData>(queryOptions);
+    return useInfiniteQuery<TQueryFnData, TError, InfiniteData<TData>>(queryOptions);
 }
 
 /**