@zenstackhq/orm 3.3.0-beta.1 → 3.3.0-beta.2

package/dist/index.d.cts

@@ -3,7 +3,7 @@ import { SchemaDef, GetModels, ScalarFields, ForeignKeyFields, GetModelFields, F
 import * as kysely from 'kysely';
 import { OperationNodeVisitor, OperationNode, SelectQueryNode, SelectionNode, ColumnNode, AliasNode, TableNode, FromNode, ReferenceNode, AndNode, OrNode, ValueListNode, ParensNode, JoinNode, RawNode, WhereNode, InsertQueryNode, DeleteQueryNode, ReturningNode, CreateTableNode, AddColumnNode, ColumnDefinitionNode, DropTableNode, OrderByNode, OrderByItemNode, GroupByNode, GroupByItemNode, UpdateQueryNode, ColumnUpdateNode, LimitNode, OffsetNode, OnConflictNode, OnDuplicateKeyNode, CheckConstraintNode, DataTypeNode, SelectAllNode, IdentifierNode, SchemableIdentifierNode, ValueNode, PrimitiveValueListNode, OperatorNode, CreateIndexNode, DropIndexNode, ListNode, PrimaryKeyConstraintNode, UniqueConstraintNode, ReferencesNode, WithNode, CommonTableExpressionNode, CommonTableExpressionNameNode, HavingNode, CreateSchemaNode, DropSchemaNode, AlterTableNode, DropColumnNode, RenameColumnNode, AlterColumnNode, ModifyColumnNode, AddConstraintNode, DropConstraintNode, ForeignKeyConstraintNode, CreateViewNode, DropViewNode, GeneratedNode, DefaultValueNode, OnNode, ValuesNode, SelectModifierNode, CreateTypeNode, DropTypeNode, ExplainNode, DefaultInsertValueNode, AggregateFunctionNode, OverNode, PartitionByNode, PartitionByItemNode, SetOperationNode, BinaryOperationNode, UnaryOperationNode, UsingNode, FunctionNode, CaseNode, WhenNode, JSONReferenceNode, JSONPathNode, JSONPathLegNode, JSONOperatorChainNode, TupleNode, MergeQueryNode, MatchedNode, AddIndexNode, CastNode, FetchNode, TopNode, OutputNode, RenameConstraintNode, RefreshMaterializedViewNode, OrActionNode, CollateNode, Kysely, Generated, ExpressionBuilder, OperandExpression, SqlBool, SelectQueryBuilder, Expression, ExpressionWrapper, QueryId, RootOperationNode, QueryResult, UnknownRow, Dialect, KyselyConfig } from 'kysely';
 import Decimal from 'decimal.js';
-import { z, ZodObject } from 'zod';
+import { z, ZodType } from 'zod';
 
 type JsonValue = string | number | boolean | JsonObject | JsonArray;
 type JsonObject = {
@@ -343,6 +343,10 @@ type CommonPrimitiveFilter<DataType, T extends BuiltinType, Nullable extends boo
      * Checks if the value is greater than or equal to the specified value.
      */
     gte?: DataType;
+    /**
+     * Checks if the value is between the specified values (inclusive).
+     */
+    between?: [start: DataType, end: DataType];
     /**
      * Builds a negated filter.
      */
@@ -1354,6 +1358,7 @@ declare class InputValidator<Schema extends SchemaDef> {
     private setSchemaCache;
     private validate;
     private mergePluginArgsSchema;
+    private getPluginExtQueryArgsSchema;
     private makeFindSchema;
     private makeExistsSchema;
     private makeScalarSchema;
@@ -1445,6 +1450,30 @@ declare const CoreWriteOperations: readonly ["create", "createMany", "createMany
  * List of core write operations.
  */
 type CoreWriteOperations = (typeof CoreWriteOperations)[number];
+/**
+ * List of core create operations.
+ */
+declare const CoreCreateOperations: readonly ["create", "createMany", "createManyAndReturn", "upsert"];
+/**
+ * List of core create operations.
+ */
+type CoreCreateOperations = (typeof CoreCreateOperations)[number];
+/**
+ * List of core update operations.
+ */
+declare const CoreUpdateOperations: readonly ["update", "updateMany", "updateManyAndReturn", "upsert"];
+/**
+ * List of core update operations.
+ */
+type CoreUpdateOperations = (typeof CoreUpdateOperations)[number];
+/**
+ * List of core delete operations.
+ */
+declare const CoreDeleteOperations: readonly ["delete", "deleteMany"];
+/**
+ * List of core delete operations.
+ */
+type CoreDeleteOperations = (typeof CoreDeleteOperations)[number];
 /**
  * List of all CRUD operations, including 'orThrow' variants.
  */
@@ -1462,16 +1491,22 @@ declare const AllReadOperations: readonly ["findMany", "findUnique", "findFirst"
  */
 type AllReadOperations = (typeof AllReadOperations)[number];
 
+type AllowedExtQueryArgKeys = CoreCrudOperations | '$create' | '$read' | '$update' | '$delete' | '$all';
 /**
  * Base shape of plugin-extended query args.
  */
 type ExtQueryArgsBase = {
-    [K in CoreCrudOperations | 'all']?: object;
+    [K in AllowedExtQueryArgKeys]?: object;
 };
+/**
+ * Base type for plugin-extended client members (methods and properties).
+ * Member names should start with '$' to avoid model name conflicts.
+ */
+type ExtClientMembersBase = Record<string, unknown>;
 /**
  * ZenStack runtime plugin.
  */
-interface RuntimePlugin<Schema extends SchemaDef = SchemaDef, _ExtQueryArgs extends ExtQueryArgsBase = {}> {
+interface RuntimePlugin<Schema extends SchemaDef, ExtQueryArgs extends ExtQueryArgsBase, ExtClientMembers extends Record<string, unknown>> {
     /**
      * Plugin ID.
      */
@@ -1508,17 +1543,19 @@ interface RuntimePlugin<Schema extends SchemaDef = SchemaDef, _ExtQueryArgs exte
     /**
      * Extended query args configuration.
      */
-    extQueryArgs?: {
-        /**
-         * Callback for getting a Zod schema to validate the extended query args for the given operation.
-         */
-        getValidationSchema: (operation: CoreCrudOperations) => ZodObject | undefined;
+    queryArgs?: {
+        [K in keyof ExtQueryArgs]: ZodType<ExtQueryArgs[K]>;
     };
+    /**
+     * Extended client members (methods and properties).
+     */
+    client?: ExtClientMembers;
 }
+type AnyPlugin = RuntimePlugin<any, any, any>;
 /**
  * Defines a ZenStack runtime plugin.
  */
-declare function definePlugin<Schema extends SchemaDef = SchemaDef, ExtQueryArgs extends ExtQueryArgsBase = {}>(plugin: RuntimePlugin<Schema, ExtQueryArgs>): RuntimePlugin<Schema, ExtQueryArgs>;
+declare function definePlugin<Schema extends SchemaDef, const ExtQueryArgs extends ExtQueryArgsBase = {}, const ExtClientMembers extends Record<string, unknown> = {}>(plugin: RuntimePlugin<Schema, ExtQueryArgs, ExtClientMembers>): RuntimePlugin<any, ExtQueryArgs, ExtClientMembers>;
 type OnProcedureCallback<Schema extends SchemaDef> = (ctx: OnProcedureHookContext<Schema>) => Promise<unknown>;
 type OnProcedureHookContext<Schema extends SchemaDef> = {
     /**
@@ -1667,7 +1704,7 @@ type TransactionUnsupportedMethods = (typeof TRANSACTION_UNSUPPORTED_METHODS)[nu
 /**
  * Extracts extended query args for a specific operation.
  */
-type ExtractExtQueryArgs<ExtQueryArgs, Operation extends CoreCrudOperations> = Operation extends keyof ExtQueryArgs ? NonNullable<ExtQueryArgs[Operation]> : 'all' extends keyof ExtQueryArgs ? NonNullable<ExtQueryArgs['all']> : {};
+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.
  */
@@ -1681,7 +1718,7 @@ declare enum TransactionIsolationLevel {
 /**
  * ZenStack client interface.
  */
-type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema> = ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase = {}> = {
+type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema> = ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase = {}, ExtClientMembers extends ExtClientMembersBase = {}> = {
     /**
      * The schema definition.
      */
@@ -1731,7 +1768,7 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     /**
      * Sets the current user identity.
      */
-    $setAuth(auth: AuthType<Schema> | undefined): ClientContract<Schema, Options, ExtQueryArgs>;
+    $setAuth(auth: AuthType<Schema> | undefined): ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>;
     /**
      * Returns a new client with new options applied.
      * @example
@@ -1739,14 +1776,14 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
      * const dbNoValidation = db.$setOptions({ ...db.$options, validateInput: false });
      * ```
      */
-    $setOptions<Options extends ClientOptions<Schema>>(options: Options): ClientContract<Schema, Options, ExtQueryArgs>;
+    $setOptions<NewOptions extends ClientOptions<Schema>>(options: NewOptions): ClientContract<Schema, NewOptions, ExtQueryArgs, ExtClientMembers>;
     /**
      * Returns a new client enabling/disabling input validations expressed with attributes like
      * `@email`, `@regex`, `@@validate`, etc.
      *
      * @deprecated Use {@link $setOptions} instead.
      */
-    $setInputValidation(enable: boolean): ClientContract<Schema, Options, ExtQueryArgs>;
+    $setInputValidation(enable: boolean): ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>;
     /**
      * The Kysely query builder instance.
      */
@@ -1758,7 +1795,7 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     /**
      * Starts an interactive transaction.
      */
-    $transaction<T>(callback: (tx: TransactionClientContract<Schema, Options, ExtQueryArgs>) => Promise<T>, options?: {
+    $transaction<T>(callback: (tx: TransactionClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>) => Promise<T>, options?: {
         isolationLevel?: TransactionIsolationLevel;
     }): Promise<T>;
     /**
@@ -1770,11 +1807,11 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     /**
      * Returns a new client with the specified plugin installed.
      */
-    $use<PluginSchema extends SchemaDef = Schema, PluginExtQueryArgs extends ExtQueryArgsBase = {}>(plugin: RuntimePlugin<PluginSchema, PluginExtQueryArgs>): ClientContract<Schema, Options, ExtQueryArgs & PluginExtQueryArgs>;
+    $use<PluginSchema extends SchemaDef = Schema, PluginExtQueryArgs extends ExtQueryArgsBase = {}, PluginExtClientMembers extends ExtClientMembersBase = {}>(plugin: RuntimePlugin<PluginSchema, PluginExtQueryArgs, PluginExtClientMembers>): ClientContract<Schema, Options, ExtQueryArgs & PluginExtQueryArgs, ExtClientMembers & PluginExtClientMembers>;
     /**
      * Returns a new client with the specified plugin removed.
      */
-    $unuse(pluginId: string): ClientContract<Schema, Options, ExtQueryArgs>;
+    $unuse(pluginId: string): ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>;
     /**
      * Returns a new client with all plugins removed.
      */
@@ -1794,11 +1831,11 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     $pushSchema(): Promise<void>;
 } & {
     [Key in GetModels<Schema> as Uncapitalize<Key>]: ModelOperations<Schema, Key, ToQueryOptions<Options>, ExtQueryArgs>;
-} & ProcedureOperations<Schema>;
+} & ProcedureOperations<Schema> & ExtClientMembers;
 /**
  * The contract for a client in a transaction.
  */
-type TransactionClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase> = Omit<ClientContract<Schema, Options, ExtQueryArgs>, TransactionUnsupportedMethods>;
+type TransactionClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase, ExtClientMembers extends ExtClientMembersBase> = Omit<ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>, TransactionUnsupportedMethods>;
 type ProcedureOperations<Schema extends SchemaDef> = Schema['procedures'] extends Record<string, ProcedureDef> ? {
     /**
      * Custom procedures.
@@ -2402,7 +2439,7 @@ type ClientOptions<Schema extends SchemaDef> = {
     /**
      * Plugins.
      */
-    plugins?: RuntimePlugin<any, any>[];
+    plugins?: AnyPlugin[];
     /**
      * Logging configuration.
      */
@@ -2705,4 +2742,4 @@ declare namespace schemaUtils {
   export { schemaUtils_ExpressionVisitor as ExpressionVisitor, schemaUtils_MatchingExpressionVisitor as MatchingExpressionVisitor, type schemaUtils_VisitResult as VisitResult };
 }
 
-export { type AfterEntityMutationCallback, type AggregateArgs, type AggregateResult, AllCrudOperations, type AllModelOperations, AllReadOperations, AnyNull, AnyNullClass, type AuthType, BaseCrudDialect, type BatchResult, type BeforeEntityMutationCallback, type BooleanFilter, type BytesFilter, CRUD, CRUD_EXT, type ClientConstructor, type ClientContract, type ClientOptions, type ComputedFieldsOptions, CoreCrudOperations, CoreReadOperations, CoreWriteOperations, type CountArgs, type CountResult, type CreateArgs, type CreateInput, type CreateManyAndReturnArgs, type CreateManyArgs, type CreateManyInput, type DateTimeFilter, DbNull, DbNullClass, type DefaultModelResult, type DeleteArgs, type DeleteManyArgs, type EntityMutationHooksDef, type ExistsArgs, type ExtQueryArgsBase, type FindArgs, type FindFirstArgs, type FindManyArgs, type FindUniqueArgs, type GetProcedure, type GetProcedureNames, type GetProcedureParams, type GroupByArgs, type GroupByResult, type HasComputedFields, type HasProcedures, type IncludeInput, InputValidator, type JsonArray, type JsonFilter, JsonNull, JsonNullClass, type JsonNullValues, type JsonObject, type JsonValue, kyselyUtils as KyselyUtils, type ModelOperations, type ModelResult, type NullsOrder, type NumberFilter, ORMError, ORMErrorReason, type OmitConfig, type OmitInput, type OnKyselyQueryArgs, type OnKyselyQueryCallback, type OnProcedureHookContext, type OperationsIneligibleForDelegateModels, type OrderBy, type PluginAfterEntityMutationArgs, type PluginBeforeEntityMutationArgs, type ProcedureEnvelope, type ProcedureFunc, type ProcedureHandlerFunc, type ProcedureOperations, type ProceduresOptions, type ProceedKyselyQueryFunction, type QueryOptions, queryUtils as QueryUtils, RejectedByPolicyReason, type RuntimePlugin, schemaUtils as SchemaUtils, type SelectIncludeOmit, type SelectInput, type SelectSubset, type SimplifiedPlainResult, type SimplifiedResult, type SortOrder, type StringFilter, type Subset, type ToKysely, type ToQueryOptions, type TransactionClientContract, TransactionIsolationLevel, type TypeDefResult, type TypedJsonFilter, type UpdateArgs, type UpdateInput, type UpdateManyAndReturnArgs, type UpdateManyArgs, type UpsertArgs, type WhereInput, type WhereUniqueInput, type ZModelFunction, type ZModelFunctionContext, ZenStackClient, type ZenStackPromise, definePlugin, getCrudDialect };
+export { type AfterEntityMutationCallback, type AggregateArgs, type AggregateResult, AllCrudOperations, type AllModelOperations, AllReadOperations, AnyNull, AnyNullClass, type AnyPlugin, type AuthType, BaseCrudDialect, type BatchResult, type BeforeEntityMutationCallback, type BooleanFilter, type BytesFilter, CRUD, CRUD_EXT, type ClientConstructor, type ClientContract, type ClientOptions, type ComputedFieldsOptions, CoreCreateOperations, CoreCrudOperations, CoreDeleteOperations, CoreReadOperations, CoreUpdateOperations, CoreWriteOperations, type CountArgs, type CountResult, type CreateArgs, type CreateInput, type CreateManyAndReturnArgs, type CreateManyArgs, type CreateManyInput, type DateTimeFilter, DbNull, DbNullClass, type DefaultModelResult, type DeleteArgs, type DeleteManyArgs, type EntityMutationHooksDef, type ExistsArgs, type ExtClientMembersBase, type ExtQueryArgsBase, type FindArgs, type FindFirstArgs, type FindManyArgs, type FindUniqueArgs, type GetProcedure, type GetProcedureNames, type GetProcedureParams, type GroupByArgs, type GroupByResult, type HasComputedFields, type HasProcedures, type IncludeInput, InputValidator, type JsonArray, type JsonFilter, JsonNull, JsonNullClass, type JsonNullValues, type JsonObject, type JsonValue, kyselyUtils as KyselyUtils, type ModelOperations, type ModelResult, type NullsOrder, type NumberFilter, ORMError, ORMErrorReason, type OmitConfig, type OmitInput, type OnKyselyQueryArgs, type OnKyselyQueryCallback, type OnProcedureHookContext, type OperationsIneligibleForDelegateModels, type OrderBy, type PluginAfterEntityMutationArgs, type PluginBeforeEntityMutationArgs, type ProcedureEnvelope, type ProcedureFunc, type ProcedureHandlerFunc, type ProcedureOperations, type ProceduresOptions, type ProceedKyselyQueryFunction, type QueryOptions, queryUtils as QueryUtils, RejectedByPolicyReason, type RuntimePlugin, schemaUtils as SchemaUtils, type SelectIncludeOmit, type SelectInput, type SelectSubset, type SimplifiedPlainResult, type SimplifiedResult, type SortOrder, type StringFilter, type Subset, type ToKysely, type ToQueryOptions, type TransactionClientContract, TransactionIsolationLevel, type TypeDefResult, type TypedJsonFilter, type UpdateArgs, type UpdateInput, type UpdateManyAndReturnArgs, type UpdateManyArgs, type UpsertArgs, type WhereInput, type WhereUniqueInput, type ZModelFunction, type ZModelFunctionContext, ZenStackClient, type ZenStackPromise, definePlugin, getCrudDialect };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { SchemaDef, GetModels, ScalarFields, ForeignKeyFields, GetModelFields, F
 import * as kysely from 'kysely';
 import { OperationNodeVisitor, OperationNode, SelectQueryNode, SelectionNode, ColumnNode, AliasNode, TableNode, FromNode, ReferenceNode, AndNode, OrNode, ValueListNode, ParensNode, JoinNode, RawNode, WhereNode, InsertQueryNode, DeleteQueryNode, ReturningNode, CreateTableNode, AddColumnNode, ColumnDefinitionNode, DropTableNode, OrderByNode, OrderByItemNode, GroupByNode, GroupByItemNode, UpdateQueryNode, ColumnUpdateNode, LimitNode, OffsetNode, OnConflictNode, OnDuplicateKeyNode, CheckConstraintNode, DataTypeNode, SelectAllNode, IdentifierNode, SchemableIdentifierNode, ValueNode, PrimitiveValueListNode, OperatorNode, CreateIndexNode, DropIndexNode, ListNode, PrimaryKeyConstraintNode, UniqueConstraintNode, ReferencesNode, WithNode, CommonTableExpressionNode, CommonTableExpressionNameNode, HavingNode, CreateSchemaNode, DropSchemaNode, AlterTableNode, DropColumnNode, RenameColumnNode, AlterColumnNode, ModifyColumnNode, AddConstraintNode, DropConstraintNode, ForeignKeyConstraintNode, CreateViewNode, DropViewNode, GeneratedNode, DefaultValueNode, OnNode, ValuesNode, SelectModifierNode, CreateTypeNode, DropTypeNode, ExplainNode, DefaultInsertValueNode, AggregateFunctionNode, OverNode, PartitionByNode, PartitionByItemNode, SetOperationNode, BinaryOperationNode, UnaryOperationNode, UsingNode, FunctionNode, CaseNode, WhenNode, JSONReferenceNode, JSONPathNode, JSONPathLegNode, JSONOperatorChainNode, TupleNode, MergeQueryNode, MatchedNode, AddIndexNode, CastNode, FetchNode, TopNode, OutputNode, RenameConstraintNode, RefreshMaterializedViewNode, OrActionNode, CollateNode, Kysely, Generated, ExpressionBuilder, OperandExpression, SqlBool, SelectQueryBuilder, Expression, ExpressionWrapper, QueryId, RootOperationNode, QueryResult, UnknownRow, Dialect, KyselyConfig } from 'kysely';
 import Decimal from 'decimal.js';
-import { z, ZodObject } from 'zod';
+import { z, ZodType } from 'zod';
 
 type JsonValue = string | number | boolean | JsonObject | JsonArray;
 type JsonObject = {
@@ -343,6 +343,10 @@ type CommonPrimitiveFilter<DataType, T extends BuiltinType, Nullable extends boo
      * Checks if the value is greater than or equal to the specified value.
      */
     gte?: DataType;
+    /**
+     * Checks if the value is between the specified values (inclusive).
+     */
+    between?: [start: DataType, end: DataType];
     /**
      * Builds a negated filter.
      */
@@ -1354,6 +1358,7 @@ declare class InputValidator<Schema extends SchemaDef> {
     private setSchemaCache;
     private validate;
     private mergePluginArgsSchema;
+    private getPluginExtQueryArgsSchema;
     private makeFindSchema;
     private makeExistsSchema;
     private makeScalarSchema;
@@ -1445,6 +1450,30 @@ declare const CoreWriteOperations: readonly ["create", "createMany", "createMany
  * List of core write operations.
  */
 type CoreWriteOperations = (typeof CoreWriteOperations)[number];
+/**
+ * List of core create operations.
+ */
+declare const CoreCreateOperations: readonly ["create", "createMany", "createManyAndReturn", "upsert"];
+/**
+ * List of core create operations.
+ */
+type CoreCreateOperations = (typeof CoreCreateOperations)[number];
+/**
+ * List of core update operations.
+ */
+declare const CoreUpdateOperations: readonly ["update", "updateMany", "updateManyAndReturn", "upsert"];
+/**
+ * List of core update operations.
+ */
+type CoreUpdateOperations = (typeof CoreUpdateOperations)[number];
+/**
+ * List of core delete operations.
+ */
+declare const CoreDeleteOperations: readonly ["delete", "deleteMany"];
+/**
+ * List of core delete operations.
+ */
+type CoreDeleteOperations = (typeof CoreDeleteOperations)[number];
 /**
  * List of all CRUD operations, including 'orThrow' variants.
  */
@@ -1462,16 +1491,22 @@ declare const AllReadOperations: readonly ["findMany", "findUnique", "findFirst"
  */
 type AllReadOperations = (typeof AllReadOperations)[number];
 
+type AllowedExtQueryArgKeys = CoreCrudOperations | '$create' | '$read' | '$update' | '$delete' | '$all';
 /**
  * Base shape of plugin-extended query args.
  */
 type ExtQueryArgsBase = {
-    [K in CoreCrudOperations | 'all']?: object;
+    [K in AllowedExtQueryArgKeys]?: object;
 };
+/**
+ * Base type for plugin-extended client members (methods and properties).
+ * Member names should start with '$' to avoid model name conflicts.
+ */
+type ExtClientMembersBase = Record<string, unknown>;
 /**
  * ZenStack runtime plugin.
  */
-interface RuntimePlugin<Schema extends SchemaDef = SchemaDef, _ExtQueryArgs extends ExtQueryArgsBase = {}> {
+interface RuntimePlugin<Schema extends SchemaDef, ExtQueryArgs extends ExtQueryArgsBase, ExtClientMembers extends Record<string, unknown>> {
     /**
      * Plugin ID.
      */
@@ -1508,17 +1543,19 @@ interface RuntimePlugin<Schema extends SchemaDef = SchemaDef, _ExtQueryArgs exte
     /**
      * Extended query args configuration.
      */
-    extQueryArgs?: {
-        /**
-         * Callback for getting a Zod schema to validate the extended query args for the given operation.
-         */
-        getValidationSchema: (operation: CoreCrudOperations) => ZodObject | undefined;
+    queryArgs?: {
+        [K in keyof ExtQueryArgs]: ZodType<ExtQueryArgs[K]>;
     };
+    /**
+     * Extended client members (methods and properties).
+     */
+    client?: ExtClientMembers;
 }
+type AnyPlugin = RuntimePlugin<any, any, any>;
 /**
  * Defines a ZenStack runtime plugin.
  */
-declare function definePlugin<Schema extends SchemaDef = SchemaDef, ExtQueryArgs extends ExtQueryArgsBase = {}>(plugin: RuntimePlugin<Schema, ExtQueryArgs>): RuntimePlugin<Schema, ExtQueryArgs>;
+declare function definePlugin<Schema extends SchemaDef, const ExtQueryArgs extends ExtQueryArgsBase = {}, const ExtClientMembers extends Record<string, unknown> = {}>(plugin: RuntimePlugin<Schema, ExtQueryArgs, ExtClientMembers>): RuntimePlugin<any, ExtQueryArgs, ExtClientMembers>;
 type OnProcedureCallback<Schema extends SchemaDef> = (ctx: OnProcedureHookContext<Schema>) => Promise<unknown>;
 type OnProcedureHookContext<Schema extends SchemaDef> = {
     /**
@@ -1667,7 +1704,7 @@ type TransactionUnsupportedMethods = (typeof TRANSACTION_UNSUPPORTED_METHODS)[nu
 /**
  * Extracts extended query args for a specific operation.
  */
-type ExtractExtQueryArgs<ExtQueryArgs, Operation extends CoreCrudOperations> = Operation extends keyof ExtQueryArgs ? NonNullable<ExtQueryArgs[Operation]> : 'all' extends keyof ExtQueryArgs ? NonNullable<ExtQueryArgs['all']> : {};
+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.
  */
@@ -1681,7 +1718,7 @@ declare enum TransactionIsolationLevel {
 /**
  * ZenStack client interface.
  */
-type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema> = ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase = {}> = {
+type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema> = ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase = {}, ExtClientMembers extends ExtClientMembersBase = {}> = {
     /**
      * The schema definition.
      */
@@ -1731,7 +1768,7 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     /**
      * Sets the current user identity.
      */
-    $setAuth(auth: AuthType<Schema> | undefined): ClientContract<Schema, Options, ExtQueryArgs>;
+    $setAuth(auth: AuthType<Schema> | undefined): ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>;
     /**
      * Returns a new client with new options applied.
      * @example
@@ -1739,14 +1776,14 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
      * const dbNoValidation = db.$setOptions({ ...db.$options, validateInput: false });
      * ```
      */
-    $setOptions<Options extends ClientOptions<Schema>>(options: Options): ClientContract<Schema, Options, ExtQueryArgs>;
+    $setOptions<NewOptions extends ClientOptions<Schema>>(options: NewOptions): ClientContract<Schema, NewOptions, ExtQueryArgs, ExtClientMembers>;
     /**
      * Returns a new client enabling/disabling input validations expressed with attributes like
      * `@email`, `@regex`, `@@validate`, etc.
      *
      * @deprecated Use {@link $setOptions} instead.
      */
-    $setInputValidation(enable: boolean): ClientContract<Schema, Options, ExtQueryArgs>;
+    $setInputValidation(enable: boolean): ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>;
     /**
      * The Kysely query builder instance.
      */
@@ -1758,7 +1795,7 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     /**
      * Starts an interactive transaction.
      */
-    $transaction<T>(callback: (tx: TransactionClientContract<Schema, Options, ExtQueryArgs>) => Promise<T>, options?: {
+    $transaction<T>(callback: (tx: TransactionClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>) => Promise<T>, options?: {
         isolationLevel?: TransactionIsolationLevel;
     }): Promise<T>;
     /**
@@ -1770,11 +1807,11 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     /**
      * Returns a new client with the specified plugin installed.
      */
-    $use<PluginSchema extends SchemaDef = Schema, PluginExtQueryArgs extends ExtQueryArgsBase = {}>(plugin: RuntimePlugin<PluginSchema, PluginExtQueryArgs>): ClientContract<Schema, Options, ExtQueryArgs & PluginExtQueryArgs>;
+    $use<PluginSchema extends SchemaDef = Schema, PluginExtQueryArgs extends ExtQueryArgsBase = {}, PluginExtClientMembers extends ExtClientMembersBase = {}>(plugin: RuntimePlugin<PluginSchema, PluginExtQueryArgs, PluginExtClientMembers>): ClientContract<Schema, Options, ExtQueryArgs & PluginExtQueryArgs, ExtClientMembers & PluginExtClientMembers>;
     /**
      * Returns a new client with the specified plugin removed.
      */
-    $unuse(pluginId: string): ClientContract<Schema, Options, ExtQueryArgs>;
+    $unuse(pluginId: string): ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>;
     /**
      * Returns a new client with all plugins removed.
      */
@@ -1794,11 +1831,11 @@ type ClientContract<Schema extends SchemaDef, Options extends ClientOptions<Sche
     $pushSchema(): Promise<void>;
 } & {
     [Key in GetModels<Schema> as Uncapitalize<Key>]: ModelOperations<Schema, Key, ToQueryOptions<Options>, ExtQueryArgs>;
-} & ProcedureOperations<Schema>;
+} & ProcedureOperations<Schema> & ExtClientMembers;
 /**
  * The contract for a client in a transaction.
  */
-type TransactionClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase> = Omit<ClientContract<Schema, Options, ExtQueryArgs>, TransactionUnsupportedMethods>;
+type TransactionClientContract<Schema extends SchemaDef, Options extends ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase, ExtClientMembers extends ExtClientMembersBase> = Omit<ClientContract<Schema, Options, ExtQueryArgs, ExtClientMembers>, TransactionUnsupportedMethods>;
 type ProcedureOperations<Schema extends SchemaDef> = Schema['procedures'] extends Record<string, ProcedureDef> ? {
     /**
      * Custom procedures.
@@ -2402,7 +2439,7 @@ type ClientOptions<Schema extends SchemaDef> = {
     /**
      * Plugins.
      */
-    plugins?: RuntimePlugin<any, any>[];
+    plugins?: AnyPlugin[];
     /**
      * Logging configuration.
      */
@@ -2705,4 +2742,4 @@ declare namespace schemaUtils {
   export { schemaUtils_ExpressionVisitor as ExpressionVisitor, schemaUtils_MatchingExpressionVisitor as MatchingExpressionVisitor, type schemaUtils_VisitResult as VisitResult };
 }
 
-export { type AfterEntityMutationCallback, type AggregateArgs, type AggregateResult, AllCrudOperations, type AllModelOperations, AllReadOperations, AnyNull, AnyNullClass, type AuthType, BaseCrudDialect, type BatchResult, type BeforeEntityMutationCallback, type BooleanFilter, type BytesFilter, CRUD, CRUD_EXT, type ClientConstructor, type ClientContract, type ClientOptions, type ComputedFieldsOptions, CoreCrudOperations, CoreReadOperations, CoreWriteOperations, type CountArgs, type CountResult, type CreateArgs, type CreateInput, type CreateManyAndReturnArgs, type CreateManyArgs, type CreateManyInput, type DateTimeFilter, DbNull, DbNullClass, type DefaultModelResult, type DeleteArgs, type DeleteManyArgs, type EntityMutationHooksDef, type ExistsArgs, type ExtQueryArgsBase, type FindArgs, type FindFirstArgs, type FindManyArgs, type FindUniqueArgs, type GetProcedure, type GetProcedureNames, type GetProcedureParams, type GroupByArgs, type GroupByResult, type HasComputedFields, type HasProcedures, type IncludeInput, InputValidator, type JsonArray, type JsonFilter, JsonNull, JsonNullClass, type JsonNullValues, type JsonObject, type JsonValue, kyselyUtils as KyselyUtils, type ModelOperations, type ModelResult, type NullsOrder, type NumberFilter, ORMError, ORMErrorReason, type OmitConfig, type OmitInput, type OnKyselyQueryArgs, type OnKyselyQueryCallback, type OnProcedureHookContext, type OperationsIneligibleForDelegateModels, type OrderBy, type PluginAfterEntityMutationArgs, type PluginBeforeEntityMutationArgs, type ProcedureEnvelope, type ProcedureFunc, type ProcedureHandlerFunc, type ProcedureOperations, type ProceduresOptions, type ProceedKyselyQueryFunction, type QueryOptions, queryUtils as QueryUtils, RejectedByPolicyReason, type RuntimePlugin, schemaUtils as SchemaUtils, type SelectIncludeOmit, type SelectInput, type SelectSubset, type SimplifiedPlainResult, type SimplifiedResult, type SortOrder, type StringFilter, type Subset, type ToKysely, type ToQueryOptions, type TransactionClientContract, TransactionIsolationLevel, type TypeDefResult, type TypedJsonFilter, type UpdateArgs, type UpdateInput, type UpdateManyAndReturnArgs, type UpdateManyArgs, type UpsertArgs, type WhereInput, type WhereUniqueInput, type ZModelFunction, type ZModelFunctionContext, ZenStackClient, type ZenStackPromise, definePlugin, getCrudDialect };
+export { type AfterEntityMutationCallback, type AggregateArgs, type AggregateResult, AllCrudOperations, type AllModelOperations, AllReadOperations, AnyNull, AnyNullClass, type AnyPlugin, type AuthType, BaseCrudDialect, type BatchResult, type BeforeEntityMutationCallback, type BooleanFilter, type BytesFilter, CRUD, CRUD_EXT, type ClientConstructor, type ClientContract, type ClientOptions, type ComputedFieldsOptions, CoreCreateOperations, CoreCrudOperations, CoreDeleteOperations, CoreReadOperations, CoreUpdateOperations, CoreWriteOperations, type CountArgs, type CountResult, type CreateArgs, type CreateInput, type CreateManyAndReturnArgs, type CreateManyArgs, type CreateManyInput, type DateTimeFilter, DbNull, DbNullClass, type DefaultModelResult, type DeleteArgs, type DeleteManyArgs, type EntityMutationHooksDef, type ExistsArgs, type ExtClientMembersBase, type ExtQueryArgsBase, type FindArgs, type FindFirstArgs, type FindManyArgs, type FindUniqueArgs, type GetProcedure, type GetProcedureNames, type GetProcedureParams, type GroupByArgs, type GroupByResult, type HasComputedFields, type HasProcedures, type IncludeInput, InputValidator, type JsonArray, type JsonFilter, JsonNull, JsonNullClass, type JsonNullValues, type JsonObject, type JsonValue, kyselyUtils as KyselyUtils, type ModelOperations, type ModelResult, type NullsOrder, type NumberFilter, ORMError, ORMErrorReason, type OmitConfig, type OmitInput, type OnKyselyQueryArgs, type OnKyselyQueryCallback, type OnProcedureHookContext, type OperationsIneligibleForDelegateModels, type OrderBy, type PluginAfterEntityMutationArgs, type PluginBeforeEntityMutationArgs, type ProcedureEnvelope, type ProcedureFunc, type ProcedureHandlerFunc, type ProcedureOperations, type ProceduresOptions, type ProceedKyselyQueryFunction, type QueryOptions, queryUtils as QueryUtils, RejectedByPolicyReason, type RuntimePlugin, schemaUtils as SchemaUtils, type SelectIncludeOmit, type SelectInput, type SelectSubset, type SimplifiedPlainResult, type SimplifiedResult, type SortOrder, type StringFilter, type Subset, type ToKysely, type ToQueryOptions, type TransactionClientContract, TransactionIsolationLevel, type TypeDefResult, type TypedJsonFilter, type UpdateArgs, type UpdateInput, type UpdateManyAndReturnArgs, type UpdateManyArgs, type UpsertArgs, type WhereInput, type WhereUniqueInput, type ZModelFunction, type ZModelFunctionContext, ZenStackClient, type ZenStackPromise, definePlugin, getCrudDialect };

package/dist/index.js

@@ -1122,7 +1122,15 @@ var BaseCrudDialect = class {
         } else {
           return this.eb.not(this.eb(lhs, "in", rhs));
         }
-      }).with("lt", () => this.eb(lhs, "<", rhs)).with("lte", () => this.eb(lhs, "<=", rhs)).with("gt", () => this.eb(lhs, ">", rhs)).with("gte", () => this.eb(lhs, ">=", rhs)).with("not", () => this.eb.not(recurse(value))).with(P.union(...AGGREGATE_OPERATORS), (op2) => {
+      }).with("lt", () => this.eb(lhs, "<", rhs)).with("lte", () => this.eb(lhs, "<=", rhs)).with("gt", () => this.eb(lhs, ">", rhs)).with("gte", () => this.eb(lhs, ">=", rhs)).with("between", () => {
+        invariant2(Array.isArray(rhs), "right hand side must be an array");
+        invariant2(rhs.length === 2, "right hand side must have a length of 2");
+        const [start, end] = rhs;
+        return this.eb.and([
+          this.eb(lhs, ">=", start),
+          this.eb(lhs, "<=", end)
+        ]);
+      }).with("not", () => this.eb.not(recurse(value))).with(P.union(...AGGREGATE_OPERATORS), (op2) => {
         const innerResult = this.buildStandardFilter(type, value, aggregate(this.eb, lhs, op2), getRhs, recurse, throwIfInvalid);
         consumedKeys.push(...innerResult.consumedKeys);
         return this.and(...innerResult.conditions);
@@ -2108,6 +2116,22 @@ var CoreWriteOperations = [
   "delete",
   "deleteMany"
 ];
+var CoreCreateOperations = [
+  "create",
+  "createMany",
+  "createManyAndReturn",
+  "upsert"
+];
+var CoreUpdateOperations = [
+  "update",
+  "updateMany",
+  "updateManyAndReturn",
+  "upsert"
+];
+var CoreDeleteOperations = [
+  "delete",
+  "deleteMany"
+];
 var AllCrudOperations = [
   ...CoreCrudOperations,
   "findUniqueOrThrow",
@@ -4572,8 +4596,8 @@ var InputValidator = class {
   mergePluginArgsSchema(schema, operation) {
     let result = schema;
     for (const plugin of this.options.plugins ?? []) {
-      if (plugin.extQueryArgs) {
-        const pluginSchema = plugin.extQueryArgs.getValidationSchema(operation);
+      if (plugin.queryArgs) {
+        const pluginSchema = this.getPluginExtQueryArgsSchema(plugin, operation);
         if (pluginSchema) {
           result = result.extend(pluginSchema.shape);
         }
@@ -4581,6 +4605,42 @@ var InputValidator = class {
     }
     return result.strict();
   }
+  getPluginExtQueryArgsSchema(plugin, operation) {
+    if (!plugin.queryArgs) {
+      return void 0;
+    }
+    let result;
+    if (operation in plugin.queryArgs && plugin.queryArgs[operation]) {
+      result = plugin.queryArgs[operation];
+    } else if (operation === "upsert") {
+      const createSchema = "$create" in plugin.queryArgs && plugin.queryArgs["$create"] ? plugin.queryArgs["$create"] : void 0;
+      const updateSchema = "$update" in plugin.queryArgs && plugin.queryArgs["$update"] ? plugin.queryArgs["$update"] : void 0;
+      if (createSchema && updateSchema) {
+        invariant7(createSchema instanceof z3.ZodObject, "Plugin extended query args schema must be a Zod object");
+        invariant7(updateSchema instanceof z3.ZodObject, "Plugin extended query args schema must be a Zod object");
+        result = createSchema.extend(updateSchema.shape);
+      } else if (createSchema) {
+        result = createSchema;
+      } else if (updateSchema) {
+        result = updateSchema;
+      }
+    } else if (
+      // then comes grouped operations: $create, $read, $update, $delete
+      CoreCreateOperations.includes(operation) && "$create" in plugin.queryArgs && plugin.queryArgs["$create"]
+    ) {
+      result = plugin.queryArgs["$create"];
+    } else if (CoreReadOperations.includes(operation) && "$read" in plugin.queryArgs && plugin.queryArgs["$read"]) {
+      result = plugin.queryArgs["$read"];
+    } else if (CoreUpdateOperations.includes(operation) && "$update" in plugin.queryArgs && plugin.queryArgs["$update"]) {
+      result = plugin.queryArgs["$update"];
+    } else if (CoreDeleteOperations.includes(operation) && "$delete" in plugin.queryArgs && plugin.queryArgs["$delete"]) {
+      result = plugin.queryArgs["$delete"];
+    } else if ("$all" in plugin.queryArgs && plugin.queryArgs["$all"]) {
+      result = plugin.queryArgs["$all"];
+    }
+    invariant7(result === void 0 || result instanceof z3.ZodObject, "Plugin extended query args schema must be a Zod object");
+    return result;
+  }
   // #region Find
   makeFindSchema(model, operation) {
     const fields = {};
@@ -4965,6 +5025,7 @@ var InputValidator = class {
       lte: baseSchema.optional(),
       gt: baseSchema.optional(),
       gte: baseSchema.optional(),
+      between: baseSchema.array().length(2).optional(),
       not: makeThis().optional(),
       ...withAggregations?.includes("_count") ? {
         _count: this.makeNumberFilterSchema(z3.number().int(), false, false).optional()
@@ -7577,6 +7638,14 @@ function createClientProxy(client) {
   return new Proxy(client, {
     get: /* @__PURE__ */ __name((target, prop, receiver) => {
       if (typeof prop === "string" && prop.startsWith("$")) {
+        const plugins = target.$options.plugins ?? [];
+        for (let i = plugins.length - 1; i >= 0; i--) {
+          const plugin = plugins[i];
+          const clientMembers = plugin?.client;
+          if (clientMembers && prop in clientMembers) {
+            return clientMembers[prop];
+          }
+        }
         return Reflect.get(target, prop, receiver);
       }
       if (typeof prop === "string") {
@@ -8116,8 +8185,11 @@ export {
   BaseCrudDialect,
   CRUD,
   CRUD_EXT,
+  CoreCreateOperations,
   CoreCrudOperations,
+  CoreDeleteOperations,
   CoreReadOperations,
+  CoreUpdateOperations,
   CoreWriteOperations,
   DbNull,
   DbNullClass,