@zenstackhq/runtime 3.0.0-beta.4 → 3.0.0-beta.5

package/dist/{contract-hoS-Sd87.d.cts → contract-BJce14-p.d.cts}

@@ -203,15 +203,12 @@ type OmitInput<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
 };
 type SelectIncludeOmit<Schema extends SchemaDef, Model extends GetModels<Schema>, AllowCount extends boolean> = {
     select?: SelectInput<Schema, Model, AllowCount, boolean>;
-    include?: IncludeInput<Schema, Model>;
+    include?: IncludeInput<Schema, Model, AllowCount>;
     omit?: OmitInput<Schema, Model>;
 };
 type SelectInput<Schema extends SchemaDef, Model extends GetModels<Schema>, AllowCount extends boolean = true, AllowRelation extends boolean = true> = {
     [Key in NonRelationFields<Schema, Model>]?: boolean;
-} & (AllowRelation extends true ? IncludeInput<Schema, Model> : {}) & // relation fields
-(AllowCount extends true ? HasToManyRelations<Schema, Model> extends true ? {
-    _count?: SelectCount<Schema, Model>;
-} : {} : {});
+} & (AllowRelation extends true ? IncludeInput<Schema, Model, AllowCount> : {});
 type SelectCount<Schema extends SchemaDef, Model extends GetModels<Schema>> = boolean | {
     select: {
         [Key in RelationFields<Schema, Model> as FieldIsArray<Schema, Model, Key> extends true ? Key : never]?: boolean | {
@@ -219,9 +216,11 @@ type SelectCount<Schema extends SchemaDef, Model extends GetModels<Schema>> = bo
         };
     };
 };
-type IncludeInput<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
+type IncludeInput<Schema extends SchemaDef, Model extends GetModels<Schema>, AllowCount extends boolean = true> = {
     [Key in RelationFields<Schema, Model>]?: boolean | FindArgs<Schema, RelationFieldType<Schema, Model, Key>, FieldIsArray<Schema, Model, Key>, FieldIsArray<Schema, Model, Key> extends true ? true : ModelFieldIsOptional<Schema, Model, Key> extends true ? true : false>;
-};
+} & (AllowCount extends true ? HasToManyRelations<Schema, Model> extends true ? {
+    _count?: SelectCount<Schema, Model>;
+} : {} : {});
 type Subset<T, U> = {
     [key in keyof T]: key extends keyof U ? T[key] : never;
 };
@@ -273,7 +272,7 @@ type FindUniqueArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> =
 } & SelectIncludeOmit<Schema, Model, true>;
 type CreateArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     data: CreateInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -320,7 +319,7 @@ type NestedCreateManyInput<Schema extends SchemaDef, Model extends GetModels<Sch
 type UpdateArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     data: UpdateInput<Schema, Model>;
     where: WhereUniqueInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -338,7 +337,7 @@ type UpsertArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     create: CreateInput<Schema, Model>;
     update: UpdateInput<Schema, Model>;
     where: WhereUniqueInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -385,7 +384,7 @@ type ToOneRelationUpdateInput<Schema extends SchemaDef, Model extends GetModels<
 } : {}), FieldIsDelegateRelation<Schema, Model, Field> extends true ? 'create' | 'connectOrCreate' | 'upsert' : never>;
 type DeleteArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     where: WhereUniqueInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -536,6 +535,7 @@ declare abstract class BaseCrudDialect<Schema extends SchemaDef> {
     protected readonly options: ClientOptions<Schema>;
     constructor(schema: Schema, options: ClientOptions<Schema>);
     transformPrimitive(value: unknown, _type: BuiltinType, _forArrayField: boolean): unknown;
+    transformOutput(value: unknown, _type: BuiltinType): unknown;
     buildSelectModel(eb: ExpressionBuilder<any, any>, model: string, modelAlias: string): SelectQueryBuilder<any, any, {}>;
     buildFilterSortTake(model: GetModels<Schema>, args: FindArgs<Schema, GetModels<Schema>, true>, query: SelectQueryBuilder<any, any, {}>, modelAlias: string): SelectQueryBuilder<any, any, {}>;
     buildFilter(eb: ExpressionBuilder<any, any>, model: string, modelAlias: string, where: boolean | object | undefined): Expression<SqlBool>;
@@ -609,6 +609,14 @@ declare abstract class BaseCrudDialect<Schema extends SchemaDef> {
      * Whether the dialect support inserting with `DEFAULT` as field value.
      */
     abstract get supportInsertWithDefault(): boolean;
+    /**
+     * Gets the SQL column type for the given field definition.
+     */
+    abstract getFieldSqlType(fieldDef: FieldDef): string;
+    abstract getStringCasingBehavior(): {
+        supportsILike: boolean;
+        likeCaseSensitive: boolean;
+    };
 }
 
 type CoreCrudOperation = 'findMany' | 'findUnique' | 'findFirst' | 'create' | 'createMany' | 'createManyAndReturn' | 'update' | 'updateMany' | 'updateManyAndReturn' | 'upsert' | 'delete' | 'deleteMany' | 'count' | 'aggregate' | 'groupBy';
@@ -630,6 +638,10 @@ interface RuntimePlugin<Schema extends SchemaDef = SchemaDef> {
      * Plugin description.
      */
     description?: string;
+    /**
+     * Custom function implementations.
+     */
+    functions?: Record<string, ZModelFunction<Schema>>;
     /**
      * Intercepts an ORM query.
      */
@@ -756,8 +768,25 @@ type ProceedKyselyQueryFunction = (query: RootOperationNode) => Promise<QueryRes
 type OnKyselyQueryCallback<Schema extends SchemaDef> = (args: OnKyselyQueryArgs<Schema>) => Promise<QueryResult<UnknownRow>>;
 
 type ZModelFunctionContext<Schema extends SchemaDef> = {
+    /**
+     * ZenStack client instance
+     */
+    client: ClientContract<Schema>;
+    /**
+     * Database dialect
+     */
     dialect: BaseCrudDialect<Schema>;
+    /**
+     * The containing model name
+     */
     model: GetModels<Schema>;
+    /**
+     * The alias name that can be used to refer to the containing model
+     */
+    modelAlias: string;
+    /**
+     * The CRUD operation being performed
+     */
     operation: CRUD;
 };
 type ZModelFunction<Schema extends SchemaDef> = (eb: ExpressionBuilder<ToKyselySchema<Schema>, keyof ToKyselySchema<Schema>>, args: Expression<any>[], context: ZModelFunctionContext<Schema>) => Expression<unknown>;
@@ -781,6 +810,15 @@ type ClientOptions<Schema extends SchemaDef> = {
      * Logging configuration.
      */
     log?: KyselyConfig['log'];
+    /**
+     * Whether to automatically fix timezone for `DateTime` fields returned by node-pg. Defaults
+     * to `true`.
+     *
+     * Node-pg has a terrible quirk that it interprets the date value as local timezone (as a
+     * `Date` object) although for `DateTime` field the data in DB is stored in UTC.
+     * @see https://github.com/brianc/node-postgres/issues/429
+     */
+    fixPostgresTimezone?: boolean;
 } & (HasComputedFields<Schema> extends true ? {
     /**
      * Computed field definitions.
@@ -957,6 +995,10 @@ interface ClientConstructor {
  * CRUD operations.
  */
 type CRUD = 'create' | 'read' | 'update' | 'delete';
+/**
+ * CRUD operations.
+ */
+declare const CRUD: readonly ["create", "read", "update", "delete"];
 type AllModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     /**
      * Returns a list of entities.
@@ -1463,4 +1505,4 @@ type AllModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema
 };
 type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>> = Omit<AllModelOperations<Schema, Model>, IsDelegateModel<Schema, Model> extends true ? 'create' | 'createMany' | 'createManyAndReturn' | 'upsert' : never>;
 
-export { type DeleteArgs as A, type BatchResult as B, type ClientConstructor as C, type DateTimeFilter as D, type DeleteManyArgs as E, type FindArgs as F, type CountArgs as G, type CountResult as H, type IncludeInput as I, type JsonArray as J, type AggregateArgs as K, type AggregateResult as L, type ModelResult as M, type NumberFilter as N, type OrderBy as O, type GroupByArgs as P, type GroupByResult as Q, type RuntimePlugin as R, type SimplifiedModelResult as S, type ToKysely as T, type UpdateArgs as U, type OnKyselyQueryArgs as V, type WhereInput as W, type ZenStackPromise as Z, type JsonObject as a, type JsonValue as b, type ClientContract as c, type ClientOptions as d, definePlugin as e, type TypeDefResult as f, type StringFilter as g, type BytesFilter as h, type BooleanFilter as i, type SortOrder as j, type NullsOrder as k, type WhereUniqueInput as l, type OmitInput as m, type SelectIncludeOmit as n, type SelectInput as o, type Subset as p, type SelectSubset as q, type FindManyArgs as r, type FindFirstArgs as s, type FindUniqueArgs as t, type CreateArgs as u, type CreateManyArgs as v, type CreateManyAndReturnArgs as w, type UpdateManyArgs as x, type UpdateManyAndReturnArgs as y, type UpsertArgs as z };
+export { type DeleteArgs as A, type BatchResult as B, type ClientConstructor as C, type DateTimeFilter as D, type DeleteManyArgs as E, type FindArgs as F, type CountArgs as G, type CountResult as H, type IncludeInput as I, type JsonArray as J, type AggregateArgs as K, type AggregateResult as L, type ModelResult as M, type NumberFilter as N, type OrderBy as O, type GroupByArgs as P, type GroupByResult as Q, type RuntimePlugin as R, type SimplifiedModelResult as S, type ToKysely as T, type UpdateArgs as U, type ZModelFunction as V, type WhereInput as W, type OnKyselyQueryArgs as X, type ZenStackPromise as Z, type JsonObject as a, type JsonValue as b, type ClientContract as c, type ClientOptions as d, definePlugin as e, type TypeDefResult as f, type StringFilter as g, type BytesFilter as h, type BooleanFilter as i, type SortOrder as j, type NullsOrder as k, type WhereUniqueInput as l, type OmitInput as m, type SelectIncludeOmit as n, type SelectInput as o, type Subset as p, type SelectSubset as q, type FindManyArgs as r, type FindFirstArgs as s, type FindUniqueArgs as t, type CreateArgs as u, type CreateManyArgs as v, type CreateManyAndReturnArgs as w, type UpdateManyArgs as x, type UpdateManyAndReturnArgs as y, type UpsertArgs as z };

package/dist/{contract-hoS-Sd87.d.ts → contract-BJce14-p.d.ts}

@@ -203,15 +203,12 @@ type OmitInput<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
 };
 type SelectIncludeOmit<Schema extends SchemaDef, Model extends GetModels<Schema>, AllowCount extends boolean> = {
     select?: SelectInput<Schema, Model, AllowCount, boolean>;
-    include?: IncludeInput<Schema, Model>;
+    include?: IncludeInput<Schema, Model, AllowCount>;
     omit?: OmitInput<Schema, Model>;
 };
 type SelectInput<Schema extends SchemaDef, Model extends GetModels<Schema>, AllowCount extends boolean = true, AllowRelation extends boolean = true> = {
     [Key in NonRelationFields<Schema, Model>]?: boolean;
-} & (AllowRelation extends true ? IncludeInput<Schema, Model> : {}) & // relation fields
-(AllowCount extends true ? HasToManyRelations<Schema, Model> extends true ? {
-    _count?: SelectCount<Schema, Model>;
-} : {} : {});
+} & (AllowRelation extends true ? IncludeInput<Schema, Model, AllowCount> : {});
 type SelectCount<Schema extends SchemaDef, Model extends GetModels<Schema>> = boolean | {
     select: {
         [Key in RelationFields<Schema, Model> as FieldIsArray<Schema, Model, Key> extends true ? Key : never]?: boolean | {
@@ -219,9 +216,11 @@ type SelectCount<Schema extends SchemaDef, Model extends GetModels<Schema>> = bo
         };
     };
 };
-type IncludeInput<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
+type IncludeInput<Schema extends SchemaDef, Model extends GetModels<Schema>, AllowCount extends boolean = true> = {
     [Key in RelationFields<Schema, Model>]?: boolean | FindArgs<Schema, RelationFieldType<Schema, Model, Key>, FieldIsArray<Schema, Model, Key>, FieldIsArray<Schema, Model, Key> extends true ? true : ModelFieldIsOptional<Schema, Model, Key> extends true ? true : false>;
-};
+} & (AllowCount extends true ? HasToManyRelations<Schema, Model> extends true ? {
+    _count?: SelectCount<Schema, Model>;
+} : {} : {});
 type Subset<T, U> = {
     [key in keyof T]: key extends keyof U ? T[key] : never;
 };
@@ -273,7 +272,7 @@ type FindUniqueArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> =
 } & SelectIncludeOmit<Schema, Model, true>;
 type CreateArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     data: CreateInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -320,7 +319,7 @@ type NestedCreateManyInput<Schema extends SchemaDef, Model extends GetModels<Sch
 type UpdateArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     data: UpdateInput<Schema, Model>;
     where: WhereUniqueInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -338,7 +337,7 @@ type UpsertArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     create: CreateInput<Schema, Model>;
     update: UpdateInput<Schema, Model>;
     where: WhereUniqueInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -385,7 +384,7 @@ type ToOneRelationUpdateInput<Schema extends SchemaDef, Model extends GetModels<
 } : {}), FieldIsDelegateRelation<Schema, Model, Field> extends true ? 'create' | 'connectOrCreate' | 'upsert' : never>;
 type DeleteArgs<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     where: WhereUniqueInput<Schema, Model>;
-    select?: SelectInput<Schema, Model, true>;
+    select?: SelectInput<Schema, Model>;
     include?: IncludeInput<Schema, Model>;
     omit?: OmitInput<Schema, Model>;
 };
@@ -536,6 +535,7 @@ declare abstract class BaseCrudDialect<Schema extends SchemaDef> {
     protected readonly options: ClientOptions<Schema>;
     constructor(schema: Schema, options: ClientOptions<Schema>);
     transformPrimitive(value: unknown, _type: BuiltinType, _forArrayField: boolean): unknown;
+    transformOutput(value: unknown, _type: BuiltinType): unknown;
     buildSelectModel(eb: ExpressionBuilder<any, any>, model: string, modelAlias: string): SelectQueryBuilder<any, any, {}>;
     buildFilterSortTake(model: GetModels<Schema>, args: FindArgs<Schema, GetModels<Schema>, true>, query: SelectQueryBuilder<any, any, {}>, modelAlias: string): SelectQueryBuilder<any, any, {}>;
     buildFilter(eb: ExpressionBuilder<any, any>, model: string, modelAlias: string, where: boolean | object | undefined): Expression<SqlBool>;
@@ -609,6 +609,14 @@ declare abstract class BaseCrudDialect<Schema extends SchemaDef> {
      * Whether the dialect support inserting with `DEFAULT` as field value.
      */
     abstract get supportInsertWithDefault(): boolean;
+    /**
+     * Gets the SQL column type for the given field definition.
+     */
+    abstract getFieldSqlType(fieldDef: FieldDef): string;
+    abstract getStringCasingBehavior(): {
+        supportsILike: boolean;
+        likeCaseSensitive: boolean;
+    };
 }
 
 type CoreCrudOperation = 'findMany' | 'findUnique' | 'findFirst' | 'create' | 'createMany' | 'createManyAndReturn' | 'update' | 'updateMany' | 'updateManyAndReturn' | 'upsert' | 'delete' | 'deleteMany' | 'count' | 'aggregate' | 'groupBy';
@@ -630,6 +638,10 @@ interface RuntimePlugin<Schema extends SchemaDef = SchemaDef> {
      * Plugin description.
      */
     description?: string;
+    /**
+     * Custom function implementations.
+     */
+    functions?: Record<string, ZModelFunction<Schema>>;
     /**
      * Intercepts an ORM query.
      */
@@ -756,8 +768,25 @@ type ProceedKyselyQueryFunction = (query: RootOperationNode) => Promise<QueryRes
 type OnKyselyQueryCallback<Schema extends SchemaDef> = (args: OnKyselyQueryArgs<Schema>) => Promise<QueryResult<UnknownRow>>;
 
 type ZModelFunctionContext<Schema extends SchemaDef> = {
+    /**
+     * ZenStack client instance
+     */
+    client: ClientContract<Schema>;
+    /**
+     * Database dialect
+     */
     dialect: BaseCrudDialect<Schema>;
+    /**
+     * The containing model name
+     */
     model: GetModels<Schema>;
+    /**
+     * The alias name that can be used to refer to the containing model
+     */
+    modelAlias: string;
+    /**
+     * The CRUD operation being performed
+     */
     operation: CRUD;
 };
 type ZModelFunction<Schema extends SchemaDef> = (eb: ExpressionBuilder<ToKyselySchema<Schema>, keyof ToKyselySchema<Schema>>, args: Expression<any>[], context: ZModelFunctionContext<Schema>) => Expression<unknown>;
@@ -781,6 +810,15 @@ type ClientOptions<Schema extends SchemaDef> = {
      * Logging configuration.
      */
     log?: KyselyConfig['log'];
+    /**
+     * Whether to automatically fix timezone for `DateTime` fields returned by node-pg. Defaults
+     * to `true`.
+     *
+     * Node-pg has a terrible quirk that it interprets the date value as local timezone (as a
+     * `Date` object) although for `DateTime` field the data in DB is stored in UTC.
+     * @see https://github.com/brianc/node-postgres/issues/429
+     */
+    fixPostgresTimezone?: boolean;
 } & (HasComputedFields<Schema> extends true ? {
     /**
      * Computed field definitions.
@@ -957,6 +995,10 @@ interface ClientConstructor {
  * CRUD operations.
  */
 type CRUD = 'create' | 'read' | 'update' | 'delete';
+/**
+ * CRUD operations.
+ */
+declare const CRUD: readonly ["create", "read", "update", "delete"];
 type AllModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
     /**
      * Returns a list of entities.
@@ -1463,4 +1505,4 @@ type AllModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema
 };
 type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>> = Omit<AllModelOperations<Schema, Model>, IsDelegateModel<Schema, Model> extends true ? 'create' | 'createMany' | 'createManyAndReturn' | 'upsert' : never>;
 
-export { type DeleteArgs as A, type BatchResult as B, type ClientConstructor as C, type DateTimeFilter as D, type DeleteManyArgs as E, type FindArgs as F, type CountArgs as G, type CountResult as H, type IncludeInput as I, type JsonArray as J, type AggregateArgs as K, type AggregateResult as L, type ModelResult as M, type NumberFilter as N, type OrderBy as O, type GroupByArgs as P, type GroupByResult as Q, type RuntimePlugin as R, type SimplifiedModelResult as S, type ToKysely as T, type UpdateArgs as U, type OnKyselyQueryArgs as V, type WhereInput as W, type ZenStackPromise as Z, type JsonObject as a, type JsonValue as b, type ClientContract as c, type ClientOptions as d, definePlugin as e, type TypeDefResult as f, type StringFilter as g, type BytesFilter as h, type BooleanFilter as i, type SortOrder as j, type NullsOrder as k, type WhereUniqueInput as l, type OmitInput as m, type SelectIncludeOmit as n, type SelectInput as o, type Subset as p, type SelectSubset as q, type FindManyArgs as r, type FindFirstArgs as s, type FindUniqueArgs as t, type CreateArgs as u, type CreateManyArgs as v, type CreateManyAndReturnArgs as w, type UpdateManyArgs as x, type UpdateManyAndReturnArgs as y, type UpsertArgs as z };
+export { type DeleteArgs as A, type BatchResult as B, type ClientConstructor as C, type DateTimeFilter as D, type DeleteManyArgs as E, type FindArgs as F, type CountArgs as G, type CountResult as H, type IncludeInput as I, type JsonArray as J, type AggregateArgs as K, type AggregateResult as L, type ModelResult as M, type NumberFilter as N, type OrderBy as O, type GroupByArgs as P, type GroupByResult as Q, type RuntimePlugin as R, type SimplifiedModelResult as S, type ToKysely as T, type UpdateArgs as U, type ZModelFunction as V, type WhereInput as W, type OnKyselyQueryArgs as X, type ZenStackPromise as Z, type JsonObject as a, type JsonValue as b, type ClientContract as c, type ClientOptions as d, definePlugin as e, type TypeDefResult as f, type StringFilter as g, type BytesFilter as h, type BooleanFilter as i, type SortOrder as j, type NullsOrder as k, type WhereUniqueInput as l, type OmitInput as m, type SelectIncludeOmit as n, type SelectInput as o, type Subset as p, type SelectSubset as q, type FindManyArgs as r, type FindFirstArgs as s, type FindUniqueArgs as t, type CreateArgs as u, type CreateManyArgs as v, type CreateManyAndReturnArgs as w, type UpdateManyArgs as x, type UpdateManyAndReturnArgs as y, type UpsertArgs as z };