merge dev to main (v1.10.0)

.github/workflows/build-test.yml

@@ -97,4 +97,4 @@ jobs:
               run: pnpm install --frozen-lockfile
 
             - name: Test
-              run: pnpm run test-ci
+              run: pnpm run test-scaffold && pnpm run test-ci

.gitignore

@@ -7,3 +7,4 @@ dist
 .npmcache
 coverage
 .build
+.test

CONTRIBUTING.md

@@ -35,6 +35,14 @@ I want to think you first for considering contributing to ZenStack 🙏🏻. It'
     pnpm build
     ```
 
+1. Scaffold the project used for testing
+
+    ```bash
+    pnpm test-scaffold
+    ```
+
+    You only need to run this command once.
+
 1. Run tests
 
     ```bash

jest.config.ts

@@ -3,15 +3,21 @@
  * https://jestjs.io/docs/configuration
  */
 
+import path from 'path';
+
 export default {
     // Automatically clear mock calls, instances, contexts and results before every test
     clearMocks: true,
 
+    globalSetup: path.join(__dirname, './script/test-global-setup.ts'),
+
+    setupFiles: [path.join(__dirname, './script/set-test-env.ts')],
+
     // Indicates whether the coverage information should be collected while executing the test
     collectCoverage: true,
 
     // The directory where Jest should output its coverage files
-    coverageDirectory: 'tests/coverage',
+    coverageDirectory: path.join(__dirname, '.test/coverage'),
 
     // An array of regexp pattern strings used to skip coverage collection
     coveragePathIgnorePatterns: ['/node_modules/', '/tests/'],

package.json

@@ -1,12 +1,13 @@
 {
     "name": "zenstack-monorepo",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "description": "",
     "scripts": {
         "build": "pnpm -r build",
         "lint": "pnpm -r lint",
-        "test": "ZENSTACK_TEST=1 pnpm -r run test --silent --forceExit",
-        "test-ci": "ZENSTACK_TEST=1 pnpm -r run test --silent --forceExit",
+        "test": "pnpm -r --parallel run test --silent --forceExit",
+        "test-ci": "pnpm -r --parallel run test --silent --forceExit",
+        "test-scaffold": "tsx script/test-scaffold.ts",
         "publish-all": "pnpm --filter \"./packages/**\" -r publish --access public",
         "publish-preview": "pnpm --filter \"./packages/**\" -r publish --force --registry https://preview.registry.zenstack.dev/",
         "unpublish-preview": "pnpm --recursive --shell-mode exec -- npm unpublish -f --registry https://preview.registry.zenstack.dev/ \"\\$PNPM_PACKAGE_NAME\""
@@ -30,6 +31,7 @@
         "ts-jest": "^29.1.1",
         "ts-node": "^10.9.1",
         "tsup": "^8.0.1",
+        "tsx": "^4.7.1",
         "typescript": "^5.3.2"
     }
 }

packages/ide/jetbrains/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- Added support to complex usage of `@@index` attribute like `@@index([content(ops: raw("gin_trgm_ops"))], type: Gin)`.
+### Fixed
+- Fixed several ZModel validation issues related to model inheritance.
 
+## 1.7.0
 ### Added
 - Auto-completion is now supported inside attributes.

packages/ide/jetbrains/build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "dev.zenstack"
-version = "1.9.0"
+version = "1.10.0"
 
 repositories {
     mavenCentral()

packages/ide/jetbrains/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jetbrains",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "displayName": "ZenStack JetBrains IDE Plugin",
     "description": "ZenStack JetBrains IDE plugin",
     "homepage": "https://zenstack.dev",

packages/language/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/language",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "displayName": "ZenStack modeling language compiler",
     "description": "ZenStack modeling language compiler",
     "homepage": "https://zenstack.dev",

packages/misc/redwood/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/redwood",
     "displayName": "ZenStack RedwoodJS Integration",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "description": "CLI and runtime for integrating ZenStack with RedwoodJS projects.",
     "repository": {
         "type": "git",

packages/plugins/openapi/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenstackhq/openapi",
   "displayName": "ZenStack Plugin and Runtime for OpenAPI",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "ZenStack plugin and runtime supporting OpenAPI",
   "main": "index.js",
   "repository": {
@@ -17,7 +17,7 @@
     "build": "pnpm lint --max-warnings=0 && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE dist && copyfiles -u 1 ./src/plugin.zmodel dist && pnpm pack dist --pack-destination '../../../../.build'",
     "watch": "tsc --watch",
     "lint": "eslint src --ext ts",
-    "test": "ZENSTACK_TEST=1 jest",
+    "test": "jest",
     "prepublishOnly": "pnpm build"
   },
   "keywords": [

packages/plugins/swr/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/swr",
     "displayName": "ZenStack plugin for generating SWR hooks",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "description": "ZenStack plugin for generating SWR hooks",
     "main": "index.js",
     "repository": {
@@ -13,7 +13,7 @@
         "build": "pnpm lint --max-warnings=0 && pnpm clean && tsc && tsup-node --config ./tsup.config.ts && copyfiles ./package.json ./README.md ./LICENSE dist && pnpm pack dist --pack-destination '../../../../.build'",
         "watch": "concurrently \"tsc --watch\" \"tsup-node --config ./tsup.config.ts --watch\"",
         "lint": "eslint src --ext ts",
-        "test": "ZENSTACK_TEST=1 jest",
+        "test": "jest",
         "prepublishOnly": "pnpm build"
     },
     "publishConfig": {

packages/plugins/tanstack-query/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/tanstack-query",
     "displayName": "ZenStack plugin for generating tanstack-query hooks",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "description": "ZenStack plugin for generating tanstack-query hooks",
     "main": "index.js",
     "exports": {
@@ -69,7 +69,7 @@
         "build": "pnpm lint --max-warnings=0 && pnpm clean && tsc && tsup-node --config ./tsup.config.ts && tsup-node --config ./tsup-v5.config.ts && node scripts/postbuild && copyfiles ./package.json ./README.md ./LICENSE dist && pnpm pack dist --pack-destination '../../../../.build'",
         "watch": "concurrently \"tsc --watch\" \"tsup-node --config ./tsup.config.ts --watch\" \"tsup-node --config ./tsup-v5.config.ts --watch\"",
         "lint": "eslint src --ext ts",
-        "test": "ZENSTACK_TEST=1 jest",
+        "test": "jest",
         "prepublishOnly": "pnpm build"
     },
     "publishConfig": {

packages/plugins/tanstack-query/src/generator.ts

@@ -216,7 +216,7 @@ function generateMutationHook(
             {
                 name: `_mutation`,
                 initializer: `
-                    useModelMutation<${argsType}, ${
+                    useModelMutation<${argsType}, DefaultError, ${
                     overrideReturnType ?? model
                 }, ${checkReadBack}>('${model}', '${httpVerb.toUpperCase()}', \`\${endpoint}/${lowerCaseFirst(
                     model
@@ -565,9 +565,9 @@ function makeBaseImports(target: TargetFramework, version: TanStackVersion) {
     const runtimeImportBase = makeRuntimeImportBase(version);
     const shared = [
         `import { useModelQuery, useInfiniteModelQuery, useModelMutation } from '${runtimeImportBase}/${target}';`,
-        `import type { PickEnumerable, CheckSelect } from '${runtimeImportBase}';`,
+        `import type { PickEnumerable, CheckSelect, QueryError } from '${runtimeImportBase}';`,
         `import metadata from './__model_meta';`,
-        `type DefaultError = Error;`,
+        `type DefaultError = QueryError;`,
     ];
     switch (target) {
         case 'react': {
@@ -643,11 +643,11 @@ function makeQueryOptions(
 function makeMutationOptions(target: string, returnType: string, argsType: string) {
     switch (target) {
         case 'react':
-            return `UseMutationOptions<${returnType}, unknown, ${argsType}>`;
+            return `UseMutationOptions<${returnType}, DefaultError, ${argsType}>`;
         case 'vue':
-            return `UseMutationOptions<${returnType}, unknown, ${argsType}, unknown>`;
+            return `UseMutationOptions<${returnType}, DefaultError, ${argsType}, unknown>`;
         case 'svelte':
-            return `MutationOptions<${returnType}, unknown, ${argsType}>`;
+            return `MutationOptions<${returnType}, DefaultError, ${argsType}>`;
         default:
             throw new PluginError(name, `Unsupported target: ${target}`);
     }

packages/plugins/tanstack-query/src/runtime-v5/index.ts

@@ -1,2 +1,2 @@
 export * from '../runtime/prisma-types';
-export { type FetchFn, getQueryKey } from '../runtime/common';
+export { type FetchFn, type QueryError, getQueryKey } from '../runtime/common';

packages/plugins/tanstack-query/src/runtime-v5/react.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import {
+    UseSuspenseInfiniteQueryOptions,
+    UseSuspenseQueryOptions,
     useInfiniteQuery,
     useMutation,
     useQuery,
@@ -10,21 +12,19 @@ import {
     type UseInfiniteQueryOptions,
     type UseMutationOptions,
     type UseQueryOptions,
-    UseSuspenseInfiniteQueryOptions,
-    UseSuspenseQueryOptions,
 } from '@tanstack/react-query-v5';
 import type { ModelMeta } from '@zenstackhq/runtime/cross';
 import { createContext, useContext } from 'react';
 import {
     DEFAULT_QUERY_ENDPOINT,
-    FetchFn,
     fetcher,
     getQueryKey,
     makeUrl,
     marshal,
     setupInvalidation,
     setupOptimisticUpdate,
     type APIContext,
+    type FetchFn,
 } from '../runtime/common';
 
 /**
@@ -167,12 +167,18 @@ export function useSuspenseInfiniteModelQuery<TQueryFnData, TData, TError>(
  * @param checkReadBack Whether to check for read back errors and return undefined if found.
  * @param optimisticUpdate Whether to enable automatic optimistic update
  */
-export function useModelMutation<T, R = any, C extends boolean = boolean, Result = C extends true ? R | undefined : R>(
+export function useModelMutation<
+    TArgs,
+    TError,
+    R = any,
+    C extends boolean = boolean,
+    Result = C extends true ? R | undefined : R
+>(
     model: string,
     method: 'POST' | 'PUT' | 'DELETE',
     url: string,
     modelMeta: ModelMeta,
-    options?: Omit<UseMutationOptions<Result, unknown, T>, 'mutationFn'>,
+    options?: Omit<UseMutationOptions<Result, TError, TArgs>, 'mutationFn'>,
     fetch?: FetchFn,
     invalidateQueries = true,
     checkReadBack?: C,