Merge pull request #375 from zenstackhq/dev

ymc9 · web-flow · commit aa97bc2d9ec2 · 2025-11-06T16:58:27.000Z
merge dev to main (v3.0.0-beta.19)
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "zenstack-v3",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack",
     "packageManager": "pnpm@10.20.0",
     "scripts": {
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack CLI",
     "description": "FullStack database toolkit with built-in access control and automatic API generation.",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "type": "module",
     "author": {
         "name": "ZenStack Team"
diff --git a/packages/clients/tanstack-query/package.json b/packages/clients/tanstack-query/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/tanstack-query",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "TanStack Query Client for consuming ZenStack v3's CRUD service",
     "main": "index.js",
     "type": "module",
diff --git a/packages/clients/tanstack-query/src/react.ts b/packages/clients/tanstack-query/src/react.ts
@@ -57,7 +57,7 @@ import {
     type ExtraMutationOptions,
     type ExtraQueryOptions,
 } from './utils/common';
-import type { TrimDelegateModelOperations } from './utils/types';
+import type { TrimDelegateModelOperations, WithOptimistic } from './utils/types';
 
 export type { FetchFn } from './utils/common';
 
@@ -93,12 +93,14 @@ function useHooksContext() {
 
 export type ModelQueryOptions<T> = Omit<UseQueryOptions<T, DefaultError>, 'queryKey'> & ExtraQueryOptions;
 
-export type ModelQueryResult<T> = UseQueryResult<T, DefaultError> & { queryKey: QueryKey };
+export type ModelQueryResult<T> = UseQueryResult<WithOptimistic<T>, DefaultError> & { queryKey: QueryKey };
 
 export type ModelSuspenseQueryOptions<T> = Omit<UseSuspenseQueryOptions<T, DefaultError>, 'queryKey'> &
     ExtraQueryOptions;
 
-export type ModelSuspenseQueryResult<T> = UseSuspenseQueryResult<T, DefaultError> & { queryKey: QueryKey };
+export type ModelSuspenseQueryResult<T> = UseSuspenseQueryResult<WithOptimistic<T>, DefaultError> & {
+    queryKey: QueryKey;
+};
 
 export type ModelInfiniteQueryOptions<T> = Omit<
     UseInfiniteQueryOptions<T, DefaultError, InfiniteData<T>>,
diff --git a/packages/clients/tanstack-query/src/svelte.ts b/packages/clients/tanstack-query/src/svelte.ts
@@ -54,7 +54,7 @@ import {
     type ExtraMutationOptions,
     type ExtraQueryOptions,
 } from './utils/common';
-import type { TrimDelegateModelOperations } from './utils/types';
+import type { TrimDelegateModelOperations, WithOptimistic } from './utils/types';
 
 export type { FetchFn } from './utils/common';
 
@@ -91,7 +91,9 @@ function getQuerySettings() {
 
 export type ModelQueryOptions<T> = Omit<CreateQueryOptions<T, DefaultError>, 'queryKey'> & ExtraQueryOptions;
 
-export type ModelQueryResult<T> = Readable<UnwrapStore<CreateQueryResult<T, DefaultError>> & { queryKey: QueryKey }>;
+export type ModelQueryResult<T> = Readable<
+    UnwrapStore<CreateQueryResult<WithOptimistic<T>, DefaultError>> & { queryKey: QueryKey }
+>;
 
 export type ModelInfiniteQueryOptions<T> = Omit<
     CreateInfiniteQueryOptions<T, DefaultError, InfiniteData<T>>,
diff --git a/packages/clients/tanstack-query/src/utils/types.ts b/packages/clients/tanstack-query/src/utils/types.ts
@@ -30,3 +30,14 @@ export type TrimDelegateModelOperations<
     Model extends GetModels<Schema>,
     T extends Record<string, unknown>,
 > = IsDelegateModel<Schema, Model> extends true ? Omit<T, HooksOperationsIneligibleForDelegateModels> : T;
+
+type WithOptimisticFlag<T> = T extends object
+    ? T & {
+          /**
+           * Indicates if the item is in an optimistic update state
+           */
+          $optimistic?: boolean;
+      }
+    : T;
+
+export type WithOptimistic<T> = T extends Array<infer U> ? Array<WithOptimisticFlag<U>> : WithOptimisticFlag<T>;
diff --git a/packages/clients/tanstack-query/src/vue.ts b/packages/clients/tanstack-query/src/vue.ts
@@ -52,7 +52,7 @@ import {
     type ExtraMutationOptions,
     type ExtraQueryOptions,
 } from './utils/common';
-import type { TrimDelegateModelOperations } from './utils/types';
+import type { TrimDelegateModelOperations, WithOptimistic } from './utils/types';
 
 export type { FetchFn } from './utils/common';
 export const VueQueryContextKey = 'zenstack-vue-query-context';
@@ -86,7 +86,7 @@ export type ModelQueryOptions<T> = MaybeRefOrGetter<
     Omit<UnwrapRef<UseQueryOptions<T, DefaultError>>, 'queryKey'> & ExtraQueryOptions
 >;
 
-export type ModelQueryResult<T> = UseQueryReturnType<T, DefaultError> & { queryKey: QueryKey };
+export type ModelQueryResult<T> = UseQueryReturnType<WithOptimistic<T>, DefaultError> & { queryKey: QueryKey };
 
 export type ModelInfiniteQueryOptions<T> = MaybeRefOrGetter<
     Omit<UnwrapRef<UseInfiniteQueryOptions<T, DefaultError, InfiniteData<T>>>, 'queryKey' | 'initialPageParam'>
diff --git a/packages/clients/tanstack-query/test/react-typing-test.ts b/packages/clients/tanstack-query/test/react-typing-test.ts
@@ -16,8 +16,10 @@ check(client.user.useFindUnique({ select: { email: true } }).data.name);
 check(client.user.useFindUnique({ where: { id: '1' }, include: { posts: true } }).data?.posts[0]?.title);
 
 check(client.user.useFindFirst().data?.email);
+check(client.user.useFindFirst().data?.$optimistic);
 
 check(client.user.useFindMany().data?.[0]?.email);
+check(client.user.useFindMany().data?.[0]?.$optimistic);
 
 check(client.user.useInfiniteFindMany().data?.pages[0]?.[0]?.email);
 check(
@@ -28,6 +30,8 @@ check(
         },
     ).data?.pages[1]?.[0]?.email,
 );
+// @ts-expect-error
+check(client.user.useInfiniteFindMany().data?.pages[0]?.[0]?.$optimistic);
 
 check(client.user.useSuspenseFindMany().data[0]?.email);
 check(client.user.useSuspenseInfiniteFindMany().data.pages[0]?.[0]?.email);
diff --git a/packages/clients/tanstack-query/test/svelte-typing-test.ts b/packages/clients/tanstack-query/test/svelte-typing-test.ts
@@ -17,8 +17,11 @@ check(get(client.user.useFindUnique({ select: { email: true } })).data.name);
 check(get(client.user.useFindUnique({ where: { id: '1' }, include: { posts: true } })).data?.posts[0]?.title);
 
 check(get(client.user.useFindFirst()).data?.email);
+check(get(client.user.useFindFirst()).data?.$optimistic);
 
 check(get(client.user.useFindMany()).data?.[0]?.email);
+check(get(client.user.useFindMany()).data?.[0]?.$optimistic);
+
 check(get(client.user.useInfiniteFindMany()).data?.pages[0]?.[0]?.email);
 check(
     get(
@@ -30,6 +33,8 @@ check(
         ),
     ).data?.pages[1]?.[0]?.email,
 );
+// @ts-expect-error
+check(get(client.user.useInfiniteFindMany()).data?.pages[0]?.[0]?.$optimistic);
 
 check(get(client.user.useCount()).data?.toFixed(2));
 check(get(client.user.useCount({ select: { email: true } })).data?.email.toFixed(2));
diff --git a/packages/clients/tanstack-query/test/vue-typing-test.ts b/packages/clients/tanstack-query/test/vue-typing-test.ts
@@ -16,8 +16,10 @@ check(client.user.useFindUnique({ select: { email: true } }).data.name);
 check(client.user.useFindUnique({ where: { id: '1' }, include: { posts: true } }).data.value?.posts[0]?.title);
 
 check(client.user.useFindFirst().data.value?.email);
+check(client.user.useFindFirst().data.value?.$optimistic);
 
 check(client.user.useFindMany().data.value?.[0]?.email);
+check(client.user.useFindMany().data.value?.[0]?.$optimistic);
 
 check(client.user.useInfiniteFindMany().data.value?.pages[0]?.[0]?.email);
 check(
@@ -28,6 +30,8 @@ check(
         },
     ).data.value?.pages[1]?.[0]?.email,
 );
+// @ts-expect-error
+check(client.user.useInfiniteFindMany().data.value?.pages[0]?.[0]?.$optimistic);
 
 check(client.user.useCount().data.value?.toFixed(2));
 check(client.user.useCount({ select: { email: true } }).data.value?.email.toFixed(2));
diff --git a/packages/common-helpers/package.json b/packages/common-helpers/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/common-helpers",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack Common Helpers",
     "type": "module",
     "scripts": {
diff --git a/packages/config/eslint-config/package.json b/packages/config/eslint-config/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/eslint-config",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "type": "module",
     "private": true,
     "license": "MIT"
diff --git a/packages/config/typescript-config/package.json b/packages/config/typescript-config/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/typescript-config",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "private": true,
     "license": "MIT"
 }
diff --git a/packages/config/vitest-config/package.json b/packages/config/vitest-config/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/vitest-config",
     "type": "module",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "private": true,
     "license": "MIT",
     "exports": {
diff --git a/packages/create-zenstack/package.json b/packages/create-zenstack/package.json
@@ -1,6 +1,6 @@
 {
     "name": "create-zenstack",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "Create a new ZenStack project",
     "type": "module",
     "scripts": {
diff --git a/packages/dialects/sql.js/package.json b/packages/dialects/sql.js/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/kysely-sql-js",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "Kysely dialect for sql.js",
     "type": "module",
     "scripts": {
diff --git a/packages/language/package.json b/packages/language/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/language",
     "description": "ZenStack ZModel language specification",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "license": "MIT",
     "author": "ZenStack Team",
     "files": [
diff --git a/packages/orm/package.json b/packages/orm/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/orm",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack ORM",
     "type": "module",
     "scripts": {
diff --git a/packages/plugins/policy/package.json b/packages/plugins/policy/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/plugin-policy",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack Policy Plugin",
     "type": "module",
     "scripts": {
diff --git a/packages/schema/package.json b/packages/schema/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/schema",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack Runtime Schema",
     "type": "module",
     "scripts": {
diff --git a/packages/schema/src/schema.ts b/packages/schema/src/schema.ts
@@ -52,6 +52,7 @@ export type RelationInfo = {
     name?: string;
     fields?: string[];
     references?: string[];
+    hasDefault?: boolean;
     opposite?: string;
     onDelete?: CascadeAction;
     onUpdate?: CascadeAction;
@@ -253,7 +254,9 @@ export type FieldHasDefault<
     ? true
     : GetModelField<Schema, Model, Field>['updatedAt'] extends true
       ? true
-      : false;
+      : GetModelField<Schema, Model, Field>['relation'] extends { hasDefault: true }
+        ? true
+        : false;
 
 export type FieldIsRelationArray<
     Schema extends SchemaDef,
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/sdk",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack SDK",
     "type": "module",
     "scripts": {
diff --git a/packages/sdk/src/ts-schema-generator.ts b/packages/sdk/src/ts-schema-generator.ts
@@ -707,12 +707,16 @@ export class TsSchemaGenerator {
         }
 
         const relation = getAttribute(field, '@relation');
+        const fkFields: string[] = [];
         if (relation) {
             for (const arg of relation.args) {
                 const param = arg.$resolvedParam.name;
                 if (param === 'fields' || param === 'references') {
                     const fieldNames = this.getReferenceNames(arg.value);
                     if (fieldNames) {
+                        if (param === 'fields') {
+                            fkFields.push(...fieldNames);
+                        }
                         relationFields.push(
                             ts.factory.createPropertyAssignment(
                                 param,
@@ -733,6 +737,17 @@ export class TsSchemaGenerator {
             }
         }
 
+        // check if all fk fields have default values
+        if (fkFields.length > 0) {
+            const allHaveDefault = fkFields.every((fieldName) => {
+                const fieldDef = field.$container.fields.find((f) => f.name === fieldName);
+                return fieldDef && hasAttribute(fieldDef, '@default');
+            });
+            if (allHaveDefault) {
+                relationFields.push(ts.factory.createPropertyAssignment('hasDefault', ts.factory.createTrue()));
+            }
+        }
+
         return ts.factory.createObjectLiteralExpression(relationFields);
     }
 
diff --git a/packages/server/package.json b/packages/server/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/server",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack automatic CRUD API handlers and server adapters",
     "type": "module",
     "scripts": {
diff --git a/packages/testtools/package.json b/packages/testtools/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/testtools",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "ZenStack Test Tools",
     "type": "module",
     "scripts": {
diff --git a/packages/zod/package.json b/packages/zod/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/zod",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "",
     "type": "module",
     "main": "index.js",
diff --git a/samples/next.js/package.json b/samples/next.js/package.json
@@ -1,6 +1,6 @@
 {
     "name": "next.js",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "private": true,
     "scripts": {
         "generate": "zen generate --lite",
diff --git a/samples/orm/package.json b/samples/orm/package.json
@@ -1,6 +1,6 @@
 {
     "name": "sample-blog",
-    "version": "3.0.0-beta.18",
+    "version": "3.0.0-beta.19",
     "description": "",
     "main": "index.js",
     "private": true,
diff --git a/tests/e2e/orm/client-api/default-auth.test.ts b/tests/e2e/orm/client-api/default-auth.test.ts
@@ -0,0 +1,21 @@
+import { createTestClient } from '@zenstackhq/testtools';
+import { describe, expect, it } from 'vitest';
+import { schema } from '../schemas/default-auth/schema';
+
+describe('Auth as default value tests', () => {
+    it('should create without requiring the default auth field', async () => {
+        const db = await createTestClient(schema);
+        const user1 = await db.user.create({ data: {} });
+        await expect(db.$setAuth(user1).profile.create({ data: { bio: 'My bio' } })).resolves.toMatchObject({
+            userId: user1.id,
+        });
+
+        const address = await db.address.create({ data: { city: 'Seattle ' } });
+        const user2 = await db.user.create({ data: {} });
+        await expect(
+            db.$setAuth(user2).profile.create({ data: { bio: 'My bio', address: { connect: { id: address.id } } } }),
+        ).resolves.toMatchObject({
+            userId: user2.id,
+        });
+    });
+});
diff --git a/tests/e2e/orm/schemas/default-auth/input.ts b/tests/e2e/orm/schemas/default-auth/input.ts
diff --git a/tests/e2e/orm/schemas/default-auth/models.ts b/tests/e2e/orm/schemas/default-auth/models.ts
diff --git a/tests/e2e/orm/schemas/default-auth/schema.ts b/tests/e2e/orm/schemas/default-auth/schema.ts
diff --git a/tests/e2e/orm/schemas/default-auth/schema.zmodel b/tests/e2e/orm/schemas/default-auth/schema.zmodel
diff --git a/tests/e2e/package.json b/tests/e2e/package.json
diff --git a/tests/regression/package.json b/tests/regression/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "zenstack-v3",`
`3`		`- "version": "3.0.0-beta.18",`
	`3`	`+ "version": "3.0.0-beta.19",`
`4`	`4`	`"description": "ZenStack",`
`5`	`5`	`"packageManager": "[email protected]",`
`6`	`6`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@zenstackhq/tanstack-query",`
`3`		`- "version": "3.0.0-beta.18",`
	`3`	`+ "version": "3.0.0-beta.19",`
`4`	`4`	`"description": "TanStack Query Client for consuming ZenStack v3's CRUD service",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"type": "module",`