docs: add JSDoc (#22)

Author: ymc9

TODO.md

@@ -55,6 +55,7 @@
         -   [x] Computed fields
         -   [ ] Prisma client extension
     -   [ ] Misc
+        -   [x] JSDoc for CRUD methods
         -   [x] Cache validation schemas
         -   [x] Compound ID
         -   [ ] Cross field comparison

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

@@ -36,7 +36,7 @@ import type { ToKysely } from './query-builder';
 import { ResultProcessor } from './result-processor';
 
 /**
- * Creates a new ZenStack client instance.
+ * ZenStack client.
  */
 export const ZenStackClient = function <Schema extends SchemaDef>(
     this: any,
@@ -424,6 +424,15 @@ function createModelCrudHandler<
             );
         },
 
+        updateManyAndReturn: (args: unknown) => {
+            return createPromise(
+                'updateManyAndReturn',
+                args,
+                new UpdateOperationHandler(client, model, inputValidator),
+                true
+            );
+        },
+
         upsert: (args: unknown) => {
             return createPromise(
                 'upsert',

packages/runtime/src/client/contract.ts

@@ -64,6 +64,7 @@ export type ClientContract<Schema extends SchemaDef> = {
 
     /**
      * Pushes the schema to the database. For testing purposes only.
+     * @private
      */
     $pushSchema(): Promise<void>;
 } & {