@zenstackhq/runtime 3.0.0-alpha.16 → 3.0.0-alpha.18

package/dist/{contract-C6xcEG6Q.d.cts → contract-Cn4sSxg8.d.cts}

@@ -561,6 +561,10 @@ declare abstract class BaseCrudDialect<Schema extends SchemaDef> {
      * Whether the dialect supports DISTINCT ON.
      */
     abstract get supportsDistinctOn(): boolean;
+    /**
+     * Whether the dialect support inserting with `DEFAULT` as field value.
+     */
+    abstract get supportInsertWithDefault(): boolean;
 }
 
 type CrudOperation = 'findMany' | 'findUnique' | 'findFirst' | 'create' | 'createMany' | 'createManyAndReturn' | 'update' | 'updateMany' | 'updateManyAndReturn' | 'upsert' | 'delete' | 'deleteMany' | 'count' | 'aggregate' | 'groupBy';
@@ -796,7 +800,7 @@ type ClientContract<Schema extends SchemaDef> = {
      * Executes a prepared raw query and returns the number of affected rows.
      * @example
      * ```
-     * const result = await client.$executeRaw`UPDATE User SET cool = ${true} WHERE email = ${'user@email.com'};`
+     * const result = await db.$executeRaw`UPDATE User SET cool = ${true} WHERE email = ${'user@email.com'};`
      * ```
      */
     $executeRaw(query: TemplateStringsArray, ...values: any[]): ZenStackPromise<Schema, number>;
@@ -805,7 +809,7 @@ type ClientContract<Schema extends SchemaDef> = {
      * This method is susceptible to SQL injections.
      * @example
      * ```
-     * const result = await client.$executeRawUnsafe('UPDATE User SET cool = $1 WHERE email = $2 ;', true, 'user@email.com')
+     * const result = await db.$executeRawUnsafe('UPDATE User SET cool = $1 WHERE email = $2 ;', true, 'user@email.com')
      * ```
      */
     $executeRawUnsafe(query: string, ...values: any[]): ZenStackPromise<Schema, number>;
@@ -813,7 +817,7 @@ type ClientContract<Schema extends SchemaDef> = {
      * Performs a prepared raw query and returns the `SELECT` data.
      * @example
      * ```
-     * const result = await client.$queryRaw`SELECT * FROM User WHERE id = ${1} OR email = ${'user@email.com'};`
+     * const result = await db.$queryRaw`SELECT * FROM User WHERE id = ${1} OR email = ${'user@email.com'};`
      * ```
      */
     $queryRaw<T = unknown>(query: TemplateStringsArray, ...values: any[]): ZenStackPromise<Schema, T>;
@@ -822,7 +826,7 @@ type ClientContract<Schema extends SchemaDef> = {
      * This method is susceptible to SQL injections.
      * @example
      * ```
-     * const result = await client.$queryRawUnsafe('SELECT * FROM User WHERE id = $1 OR email = $2;', 1, 'user@email.com')
+     * const result = await db.$queryRawUnsafe('SELECT * FROM User WHERE id = $1 OR email = $2;', 1, 'user@email.com')
      * ```
      */
     $queryRawUnsafe<T = unknown>(query: string, ...values: any[]): ZenStackPromise<Schema, T>;
@@ -920,17 +924,17 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // find all users and return all scalar fields
-     * await client.user.findMany();
+     * await db.user.findMany();
      *
      * // find all users with name 'Alex'
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     where: {
      *         name: 'Alex'
      *     }
      * });
      *
      * // select fields
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     select: {
      *         name: true,
      *         email: true,
@@ -938,21 +942,21 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * }); // result: `Array<{ name: string, email: string }>`
      *
      * // omit fields
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     omit: {
      *         name: true,
      *     }
      * }); // result: `Array<{ id: number; email: string; ... }>`
      *
      * // include relations (and all scalar fields)
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     include: {
      *         posts: true,
      *     }
      * }); // result: `Array<{ ...; posts: Post[] }>`
      *
      * // include relations with filter
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     include: {
      *         posts: {
      *             where: {
@@ -963,14 +967,14 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // pagination and sorting
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     skip: 10,
      *     take: 10,
      *     orderBy: [{ name: 'asc' }, { email: 'desc' }],
      * });
      *
      * // pagination with cursor (https://www.prisma.io/docs/orm/prisma-client/queries/pagination#cursor-based-pagination)
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     cursor: { id: 10 },
      *     skip: 1,
      *     take: 10,
@@ -978,17 +982,17 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // distinct
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     distinct: ['name']
      * });
      *
      * // count all relations
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     _count: true,
      * }); // result: `{ _count: { posts: number; ... } }`
      *
      * // count selected relations
-     * await client.user.findMany({
+     * await db.user.findMany({
      *     _count: { select: { posts: true } },
      * }); // result: `{ _count: { posts: number } }`
      * ```
@@ -1000,14 +1004,14 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @returns a single entity or null if not found
      * @see {@link findMany}
      */
-    findUnique<T extends FindUniqueArgs<Schema, Model>>(args?: SelectSubset<T, FindUniqueArgs<Schema, Model>>): ZenStackPromise<Schema, Simplify<ModelResult<Schema, Model, T>> | null>;
+    findUnique<T extends FindUniqueArgs<Schema, Model>>(args: SelectSubset<T, FindUniqueArgs<Schema, Model>>): ZenStackPromise<Schema, Simplify<ModelResult<Schema, Model, T>> | null>;
     /**
      * Returns a uniquely identified entity or throws `NotFoundError` if not found.
      * @param args - query args
      * @returns a single entity
      * @see {@link findMany}
      */
-    findUniqueOrThrow<T extends FindUniqueArgs<Schema, Model>>(args?: SelectSubset<T, FindUniqueArgs<Schema, Model>>): ZenStackPromise<Schema, Simplify<ModelResult<Schema, Model, T>>>;
+    findUniqueOrThrow<T extends FindUniqueArgs<Schema, Model>>(args: SelectSubset<T, FindUniqueArgs<Schema, Model>>): ZenStackPromise<Schema, Simplify<ModelResult<Schema, Model, T>>>;
     /**
      * Returns the first entity.
      * @param args - query args
@@ -1030,12 +1034,12 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // simple create
-     * await client.user.create({
+     * await db.user.create({
      *    data: { name: 'Alex', email: 'alex@zenstack.dev' }
      * });
      *
      * // nested create with relation
-     * await client.user.create({
+     * await db.user.create({
      *    data: {
      *        email: 'alex@zenstack.dev',
      *        posts: { create: { title: 'Hello World' } }
@@ -1044,7 +1048,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      *
      * // you can use `select`, `omit`, and `include` to control
      * // the fields returned by the query, as with `findMany`
-     * await client.user.create({
+     * await db.user.create({
      *    data: {
      *        email: 'alex@zenstack.dev',
      *        posts: { create: { title: 'Hello World' } }
@@ -1053,7 +1057,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * }); // result: `{ id: number; posts: Post[] }`
      *
      * // connect relations
-     * await client.user.create({
+     * await db.user.create({
      *    data: {
      *        email: 'alex@zenstack.dev',
      *        posts: { connect: { id: 1 } }
@@ -1061,7 +1065,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // connect relations, and create if not found
-     * await client.user.create({
+     * await db.user.create({
      *    data: {
      *        email: 'alex@zenstack.dev',
      *        posts: {
@@ -1083,7 +1087,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // create multiple entities
-     * await client.user.createMany({
+     * await db.user.createMany({
      *     data: [
      *         { name: 'Alex', email: 'alex@zenstack.dev' },
      *         { name: 'John', email: 'john@zenstack.dev' }
@@ -1091,7 +1095,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // skip items that cause unique constraint violation
-     * await client.user.createMany({
+     * await db.user.createMany({
      *     data: [
      *         { name: 'Alex', email: 'alex@zenstack.dev' },
      *         { name: 'John', email: 'john@zenstack.dev' }
@@ -1110,7 +1114,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // create multiple entities and return selected fields
-     * await client.user.createManyAndReturn({
+     * await db.user.createManyAndReturn({
      *     data: [
      *         { name: 'Alex', email: 'alex@zenstack.dev' },
      *         { name: 'John', email: 'john@zenstack.dev' }
@@ -1129,19 +1133,19 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // update fields
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: { name: 'Alex' }
      * });
      *
      * // connect a relation
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: { posts: { connect: { id: 1 } } }
      * });
      *
      * // connect relation, and create if not found
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: {
      *         posts: {
@@ -1154,7 +1158,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // create many related entities (only available for one-to-many relations)
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: {
      *         posts: {
@@ -1166,19 +1170,19 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // disconnect a one-to-many relation
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: { posts: { disconnect: { id: 1 } } }
      * });
      *
      * // disconnect a one-to-one relation
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: { profile: { disconnect: true } }
      * });
      *
      * // replace a relation (only available for one-to-many relations)
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: {
      *         posts: {
@@ -1188,7 +1192,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // update a relation
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: {
      *         posts: {
@@ -1198,7 +1202,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // upsert a relation
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: {
      *         posts: {
@@ -1212,7 +1216,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // update many related entities (only available for one-to-many relations)
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: {
      *         posts: {
@@ -1225,13 +1229,13 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * });
      *
      * // delete a one-to-many relation
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: { posts: { delete: { id: 1 } } }
      * });
      *
      * // delete a one-to-one relation
-     * await client.user.update({
+     * await db.user.update({
      *     where: { id: 1 },
      *     data: { profile: { delete: true } }
      * });
@@ -1246,13 +1250,13 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // update many entities
-     * await client.user.updateMany({
+     * await db.user.updateMany({
      *     where: { email: { endsWith: '@zenstack.dev' } },
      *     data: { role: 'ADMIN' }
      * });
      *
      * // limit the number of updated entities
-     * await client.user.updateMany({
+     * await db.user.updateMany({
      *     where: { email: { endsWith: '@zenstack.dev' } },
      *     data: { role: 'ADMIN' },
      *     limit: 10
@@ -1267,14 +1271,14 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // update many entities and return selected fields
-     * await client.user.updateManyAndReturn({
+     * await db.user.updateManyAndReturn({
      *     where: { email: { endsWith: '@zenstack.dev' } },
      *     data: { role: 'ADMIN' },
      *     select: { id: true, email: true }
      * }); // result: `Array<{ id: string; email: string }>`
      *
      * // limit the number of updated entities
-     * await client.user.updateManyAndReturn({
+     * await db.user.updateManyAndReturn({
      *     where: { email: { endsWith: '@zenstack.dev' } },
      *     data: { role: 'ADMIN' },
      *     limit: 10
@@ -1290,7 +1294,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // upsert an entity
-     * await client.user.upsert({
+     * await db.user.upsert({
      *     // `where` clause is used to find the entity
      *     where: { id: 1 },
      *     // `create` clause is used if the entity is not found
@@ -1311,12 +1315,12 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // delete an entity
-     * await client.user.delete({
+     * await db.user.delete({
      *     where: { id: 1 }
      * });
      *
      * // delete an entity and return selected fields
-     * await client.user.delete({
+     * await db.user.delete({
      *     where: { id: 1 },
      *     select: { id: true, email: true }
      * }); // result: `{ id: string; email: string }`
@@ -1331,12 +1335,12 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // delete many entities
-     * await client.user.deleteMany({
+     * await db.user.deleteMany({
      *     where: { email: { endsWith: '@zenstack.dev' } }
      * });
      *
      * // limit the number of deleted entities
-     * await client.user.deleteMany({
+     * await db.user.deleteMany({
      *     where: { email: { endsWith: '@zenstack.dev' } },
      *     limit: 10
      * });
@@ -1351,13 +1355,13 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // count all
-     * await client.user.count();
+     * await db.user.count();
      *
      * // count with a filter
-     * await client.user.count({ where: { email: { endsWith: '@zenstack.dev' } } });
+     * await db.user.count({ where: { email: { endsWith: '@zenstack.dev' } } });
      *
      * // count rows and field values
-     * await client.user.count({
+     * await db.user.count({
      *     select: { _all: true, email: true }
      * }); // result: `{ _all: number, email: number }`
      */
@@ -1370,7 +1374,7 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // aggregate rows
-     * await client.profile.aggregate({
+     * await db.profile.aggregate({
      *     where: { email: { endsWith: '@zenstack.dev' } },
      *     _count: true,
      *     _avg: { age: true },
@@ -1388,26 +1392,26 @@ type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>>
      * @example
      * ```ts
      * // group by a field
-     * await client.profile.groupBy({
+     * await db.profile.groupBy({
      *     by: 'country',
      *     _count: true
      * }); // result: `Array<{ country: string, _count: number }>`
      *
      * // group by multiple fields
-     * await client.profile.groupBy({
+     * await db.profile.groupBy({
      *     by: ['country', 'city'],
      *     _count: true
      * }); // result: `Array<{ country: string, city: string, _count: number }>`
      *
      * // group by with sorting, the `orderBy` fields must be in the `by` list
-     * await client.profile.groupBy({
+     * await db.profile.groupBy({
      *     by: 'country',
      *     orderBy: { country: 'desc' }
      * });
      *
      * // group by with having (post-aggregation filter), the `having` fields must
      * // be in the `by` list
-     * await client.profile.groupBy({
+     * await db.profile.groupBy({
      *     by: 'country',
      *     having: { country: 'US' }
      * });