feat: creating zod schemas for zmodel constructs and ORM query input validations (#2389)

Author: ymc9

packages/orm/package.json

@@ -95,6 +95,7 @@
         "@paralleldrive/cuid2": "^2.2.2",
         "@zenstackhq/common-helpers": "workspace:*",
         "@zenstackhq/schema": "workspace:*",
+        "@zenstackhq/zod": "workspace:*",
         "cuid": "^3.0.0",
         "decimal.js": "catalog:",
         "json-stable-stringify": "^1.3.0",

packages/orm/src/client/client-impl.ts

@@ -133,6 +133,10 @@ export class ClientImpl {
         return this.kyselyRaw;
     }
 
+    get $zod() {
+        return this.inputValidator.zodFactory;
+    }
+
     get isTransaction() {
         return this.kysely.isTransaction;
     }

packages/orm/src/client/constants.ts

@@ -1,7 +1,7 @@
-/**
- * The comment prefix for annotation generated Kysely queries with context information.
- */
-export const CONTEXT_COMMENT_PREFIX = '-- $$context:';
+// /**
+//  * The comment prefix for annotation generated Kysely queries with context information.
+//  */
+// export const CONTEXT_COMMENT_PREFIX = '-- $$context:';
 
 /**
  * The types of fields that are numeric.

packages/orm/src/client/contract.ts

@@ -39,45 +39,15 @@ import type {
     UpdateManyArgs,
     UpsertArgs,
 } from './crud-types';
-import type {
-    CoreCreateOperations,
-    CoreCrudOperations,
-    CoreDeleteOperations,
-    CoreReadOperations,
-    CoreUpdateOperations,
-} from './crud/operations/base';
 import type { ClientOptions, QueryOptions } from './options';
 import type { ExtClientMembersBase, ExtQueryArgsBase, RuntimePlugin } from './plugin';
 import type { ZenStackPromise } from './promise';
 import type { ToKysely } from './query-builder';
 import type { GetSlicedModels, GetSlicedOperations, GetSlicedProcedures } from './type-utils';
+import type { ZodSchemaFactory } from './zod/factory';
 
 type TransactionUnsupportedMethods = (typeof TRANSACTION_UNSUPPORTED_METHODS)[number];
 
-/**
- * Extracts extended query args for a specific operation.
- */
-type ExtractExtQueryArgs<ExtQueryArgs, Operation extends CoreCrudOperations> = (Operation extends keyof ExtQueryArgs
-    ? ExtQueryArgs[Operation]
-    : {}) &
-    ('$create' extends keyof ExtQueryArgs
-        ? Operation extends CoreCreateOperations
-            ? ExtQueryArgs['$create']
-            : {}
-        : {}) &
-    ('$read' extends keyof ExtQueryArgs ? (Operation extends CoreReadOperations ? ExtQueryArgs['$read'] : {}) : {}) &
-    ('$update' extends keyof ExtQueryArgs
-        ? Operation extends CoreUpdateOperations
-            ? ExtQueryArgs['$update']
-            : {}
-        : {}) &
-    ('$delete' extends keyof ExtQueryArgs
-        ? Operation extends CoreDeleteOperations
-            ? ExtQueryArgs['$delete']
-            : {}
-        : {}) &
-    ('$all' extends keyof ExtQueryArgs ? ExtQueryArgs['$all'] : {});
-
 /**
  * Transaction isolation levels.
  */
@@ -232,6 +202,11 @@ export type ClientContract<
      */
     $disconnect(): Promise<void>;
 
+    /**
+     * Factory for creating zod schemas to validate query args.
+     */
+    get $zod(): ZodSchemaFactory<Schema, Options, ExtQueryArgs>;
+
     /**
      * Pushes the schema to the database. For testing purposes only.
      * @private
@@ -317,7 +292,7 @@ export type AllModelOperations<
     Schema extends SchemaDef,
     Model extends GetModels<Schema>,
     Options extends QueryOptions<Schema>,
-    ExtQueryArgs,
+    ExtQueryArgs extends ExtQueryArgsBase,
 > = CommonModelOperations<Schema, Model, Options, ExtQueryArgs> &
     // provider-specific operations
     (Schema['provider']['type'] extends 'mysql'
@@ -341,15 +316,8 @@ export type AllModelOperations<
                * });
                * ```
                */
-              createManyAndReturn<
-                  T extends CreateManyAndReturnArgs<Schema, Model, Options> &
-                      ExtractExtQueryArgs<ExtQueryArgs, 'createManyAndReturn'>,
-              >(
-                  args?: SelectSubset<
-                      T,
-                      CreateManyAndReturnArgs<Schema, Model, Options> &
-                          ExtractExtQueryArgs<ExtQueryArgs, 'createManyAndReturn'>
-                  >,
+              createManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model, Options, ExtQueryArgs>>(
+                  args?: SelectSubset<T, CreateManyAndReturnArgs<Schema, Model, Options, ExtQueryArgs>>,
               ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>[]>;
 
               /**
@@ -374,23 +342,16 @@ export type AllModelOperations<
                * });
                * ```
                */
-              updateManyAndReturn<
-                  T extends UpdateManyAndReturnArgs<Schema, Model, Options> &
-                      ExtractExtQueryArgs<ExtQueryArgs, 'updateManyAndReturn'>,
-              >(
-                  args: Subset<
-                      T,
-                      UpdateManyAndReturnArgs<Schema, Model, Options> &
-                          ExtractExtQueryArgs<ExtQueryArgs, 'updateManyAndReturn'>
-                  >,
+              updateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model, Options, ExtQueryArgs>>(
+                  args: Subset<T, UpdateManyAndReturnArgs<Schema, Model, Options, ExtQueryArgs>>,
               ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>[]>;
           });
 
 type CommonModelOperations<
     Schema extends SchemaDef,
     Model extends GetModels<Schema>,
     Options extends QueryOptions<Schema>,
-    ExtQueryArgs,
+    ExtQueryArgs extends ExtQueryArgsBase,
 > = {
     /**
      * Returns a list of entities.
@@ -473,8 +434,8 @@ type CommonModelOperations<
      * }); // result: `{ _count: { posts: number } }`
      * ```
      */
-    findMany<T extends FindManyArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findMany'>>(
-        args?: SelectSubset<T, FindManyArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findMany'>>,
+    findMany<T extends FindManyArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args?: SelectSubset<T, FindManyArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>[]>;
 
     /**
@@ -483,8 +444,8 @@ type CommonModelOperations<
      * @returns a single entity or null if not found
      * @see {@link findMany}
      */
-    findUnique<T extends FindUniqueArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findUnique'>>(
-        args: SelectSubset<T, FindUniqueArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findUnique'>>,
+    findUnique<T extends FindUniqueArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: SelectSubset<T, FindUniqueArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options> | null>;
 
     /**
@@ -493,10 +454,8 @@ type CommonModelOperations<
      * @returns a single entity
      * @see {@link findMany}
      */
-    findUniqueOrThrow<
-        T extends FindUniqueArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findUnique'>,
-    >(
-        args: SelectSubset<T, FindUniqueArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findUnique'>>,
+    findUniqueOrThrow<T extends FindUniqueArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: SelectSubset<T, FindUniqueArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>>;
 
     /**
@@ -505,8 +464,8 @@ type CommonModelOperations<
      * @returns a single entity or null if not found
      * @see {@link findMany}
      */
-    findFirst<T extends FindFirstArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findFirst'>>(
-        args?: SelectSubset<T, FindFirstArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findFirst'>>,
+    findFirst<T extends FindFirstArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args?: SelectSubset<T, FindFirstArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options> | null>;
 
     /**
@@ -515,8 +474,8 @@ type CommonModelOperations<
      * @returns a single entity
      * @see {@link findMany}
      */
-    findFirstOrThrow<T extends FindFirstArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findFirst'>>(
-        args?: SelectSubset<T, FindFirstArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'findFirst'>>,
+    findFirstOrThrow<T extends FindFirstArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args?: SelectSubset<T, FindFirstArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>>;
 
     /**
@@ -571,8 +530,8 @@ type CommonModelOperations<
      * });
      * ```
      */
-    create<T extends CreateArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'create'>>(
-        args: SelectSubset<T, CreateArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'create'>>,
+    create<T extends CreateArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: SelectSubset<T, CreateArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>>;
 
     /**
@@ -600,8 +559,8 @@ type CommonModelOperations<
      * });
      * ```
      */
-    createMany<T extends CreateManyArgs<Schema, Model> & ExtractExtQueryArgs<ExtQueryArgs, 'createMany'>>(
-        args?: SelectSubset<T, CreateManyArgs<Schema, Model> & ExtractExtQueryArgs<ExtQueryArgs, 'createMany'>>,
+    createMany<T extends CreateManyArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args?: SelectSubset<T, CreateManyArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, BatchResult>;
 
     /**
@@ -721,8 +680,8 @@ type CommonModelOperations<
      * });
      * ```
      */
-    update<T extends UpdateArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'update'>>(
-        args: SelectSubset<T, UpdateArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'update'>>,
+    update<T extends UpdateArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: SelectSubset<T, UpdateArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>>;
 
     /**
@@ -745,8 +704,8 @@ type CommonModelOperations<
      *     limit: 10
      * });
      */
-    updateMany<T extends UpdateManyArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'updateMany'>>(
-        args: Subset<T, UpdateManyArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'updateMany'>>,
+    updateMany<T extends UpdateManyArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: Subset<T, UpdateManyArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, BatchResult>;
 
     /**
@@ -769,8 +728,8 @@ type CommonModelOperations<
      * });
      * ```
      */
-    upsert<T extends UpsertArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'upsert'>>(
-        args: SelectSubset<T, UpsertArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'upsert'>>,
+    upsert<T extends UpsertArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: SelectSubset<T, UpsertArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>>;
 
     /**
@@ -792,8 +751,8 @@ type CommonModelOperations<
      * }); // result: `{ id: string; email: string }`
      * ```
      */
-    delete<T extends DeleteArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'delete'>>(
-        args: SelectSubset<T, DeleteArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'delete'>>,
+    delete<T extends DeleteArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: SelectSubset<T, DeleteArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, SimplifiedPlainResult<Schema, Model, T, Options>>;
 
     /**
@@ -815,8 +774,8 @@ type CommonModelOperations<
      * });
      * ```
      */
-    deleteMany<T extends DeleteManyArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'deleteMany'>>(
-        args?: Subset<T, DeleteManyArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'deleteMany'>>,
+    deleteMany<T extends DeleteManyArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args?: Subset<T, DeleteManyArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, BatchResult>;
 
     /**
@@ -837,8 +796,8 @@ type CommonModelOperations<
      *     select: { _all: true, email: true }
      * }); // result: `{ _all: number, email: number }`
      */
-    count<T extends CountArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'count'>>(
-        args?: Subset<T, CountArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'count'>>,
+    count<T extends CountArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args?: Subset<T, CountArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, Simplify<CountResult<Schema, Model, T>>>;
 
     /**
@@ -858,8 +817,8 @@ type CommonModelOperations<
      *     _max: { age: true }
      * }); // result: `{ _count: number, _avg: { age: number }, ... }`
      */
-    aggregate<T extends AggregateArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'aggregate'>>(
-        args: Subset<T, AggregateArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'aggregate'>>,
+    aggregate<T extends AggregateArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: Subset<T, AggregateArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, Simplify<AggregateResult<Schema, Model, T>>>;
 
     /**
@@ -895,8 +854,8 @@ type CommonModelOperations<
      *     having: { country: 'US', age: { _avg: { gte: 18 } } }
      * });
      */
-    groupBy<T extends GroupByArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'groupBy'>>(
-        args: Subset<T, GroupByArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'groupBy'>>,
+    groupBy<T extends GroupByArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args: Subset<T, GroupByArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, Simplify<GroupByResult<Schema, Model, T>>>;
 
     /**
@@ -916,8 +875,8 @@ type CommonModelOperations<
      *     where: { posts: { some: { published: true } } },
      * }); // result: `boolean`
      */
-    exists<T extends ExistsArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'exists'>>(
-        args?: Subset<T, ExistsArgs<Schema, Model, Options> & ExtractExtQueryArgs<ExtQueryArgs, 'exists'>>,
+    exists<T extends ExistsArgs<Schema, Model, Options, ExtQueryArgs>>(
+        args?: Subset<T, ExistsArgs<Schema, Model, Options, ExtQueryArgs>>,
     ): ZenStackPromise<Schema, boolean>;
 };
 
@@ -927,7 +886,7 @@ export type ModelOperations<
     Schema extends SchemaDef,
     Model extends GetModels<Schema>,
     Options extends ClientOptions<Schema> = ClientOptions<Schema>,
-    ExtQueryArgs = {},
+    ExtQueryArgs extends ExtQueryArgsBase = {},
 > = SliceOperations<AllModelOperations<Schema, Model, Options, ExtQueryArgs>, Schema, Model, Options>;
 
 //#endregion