imodel 0.5.2 → 0.7.0

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
- * imodel v0.5.2
+ * imodel v0.7.0
  * (c) 2019-2025 undefined
  * @license undefined
  */
@@ -686,6 +686,16 @@ interface IndexInfo extends IndexOptions {
 interface Index extends IndexInfo {
     name: string;
 }
+interface Hooks<T extends Record<string, any> = Record<string, any>> {
+    beforeCreateMany(conn: Connection, records: Record<string, any>[]): PromiseLike<void | Record<string, any>[]> | void | Record<string, any>[];
+    afterCreateMany(conn: Connection, records: Record<string, any>[]): PromiseLike<void> | void;
+    beforeCreate(conn: Connection, record: Record<string, any>): PromiseLike<void | Record<string, any>> | void | Record<string, any>;
+    afterCreate(conn: Connection, record: Record<string, any>): PromiseLike<void> | void;
+    beforeUpdate(conn: Connection, record: Record<string, any>, set: Record<string, any>): PromiseLike<void | Record<string, any>> | void | Record<string, any>;
+    afterUpdate(conn: Connection, record: Record<string, any>, oldRecord: Record<string, any>): PromiseLike<void> | void;
+    beforeDelete(conn: Connection, record: T, update: Record<string, any> | null): PromiseLike<void> | void;
+    afterDelete(conn: Connection, record: T, update: Record<string, any> | null): PromiseLike<void> | void;
+}
 interface TableDefine<T extends Fields = Fields, TT extends string | VirtualTable | undefined = string | VirtualTable | undefined> {
     /** 字段信息 */
     readonly fields: T;
@@ -695,6 +705,8 @@ interface TableDefine<T extends Fields = Fields, TT extends string | VirtualTabl
     readonly pseudo?: string;
     /** 索引信息 */
     readonly indexes?: readonly IndexInfo[];
+    /** 钩子 */
+    readonly hooks?: Partial<Hooks>;
 }
 
 type deleted = typeof deleted;
@@ -863,7 +875,7 @@ interface Save {
 }
 declare const Create: unique symbol;
 interface Create<T = unknown> {
-    [Create](connection: Connection, data: object, run: (data: any) => Promise<object>, table: TableDefine): PromiseLike<T>;
+    [Create](connection: Connection, data: object, run: (data: any, that: any) => Promise<object>, table: TableDefine): PromiseLike<T>;
 }
 declare const Build: unique symbol;
 interface Build<T = unknown> {
@@ -1032,21 +1044,21 @@ declare class Connection<E extends {} = {}> {
     /**
      * @param {TableDefine} tableDefine
      * @param {Record<string, any>} update
-     * @param {WhereValue[]?} [where]
+     * @param {Wheres?} [where]
      * @param {boolean | Skip} [skip]
      * @returns {Promise<number>}
      */
-    update({ table, fields }: TableDefine, update: Record<string, any>, where?: WhereValue[] | null, skip?: boolean | Skip): Promise<number>;
+    update({ table, fields }: TableDefine, update: Record<string, any>, where?: Wheres | null, skip?: boolean | Skip): Promise<number>;
     /**
      * @template {Fields<MainFieldType>} T
      * @param {TableDefine<T>} tableDefine
      * @param {Record<string, any>} update
      * @param {string[]?} [returning]
-     * @param {WhereValue[]?} [where]
+     * @param {Wheres?} [where]
      * @param {boolean | Skip} [skip]
      * @returns {Promise<any[]>}
      */
-    updateReturn<T extends Fields<MainFieldType>>({ table, fields }: TableDefine<T>, update: Record<string, any>, returning?: string[] | null, where?: WhereValue[] | null, skip?: boolean | Skip): Promise<any[]>;
+    updateReturn<T extends Fields<MainFieldType>>({ table, fields }: TableDefine<T>, update: Record<string, any>, returning?: string[] | null, where?: Wheres | null, skip?: boolean | Skip): Promise<any[]>;
     /**
      * @param {TableDefine} tableDefine
      * @param {string[]} pKeys
@@ -1069,18 +1081,18 @@ declare class Connection<E extends {} = {}> {
     updateManyReturn<T extends Fields<MainFieldType>>({ table, fields }: TableDefine<T>, pKeys: string[], setKeys: string[], list: Record<string, any>[], returning?: string[] | null, skip?: boolean | Skip): Promise<any[]>;
     /**
      * @param {TableDefine} tableDefine
-     * @param {WhereValue[]} [where]
+     * @param {Wheres?} [where]
      * @returns {Promise<number>}
      */
-    delete({ table, fields }: TableDefine, where?: WhereValue[]): Promise<number>;
+    delete({ table, fields }: TableDefine, where?: Wheres | null): Promise<number>;
     /**
      * @template {Fields<MainFieldType>} T
      * @param {TableDefine<T>} tableDefine
      * @param {string[]?} [returning]
-     * @param {WhereValue[]} [where]
+     * @param {Wheres?} [where]
      * @returns {Promise<any[]>}
      */
-    deleteReturn<T extends Fields<MainFieldType>>({ table, fields }: TableDefine<T>, returning?: string[] | null, where?: WhereValue[]): Promise<any[]>;
+    deleteReturn<T extends Fields<MainFieldType>>({ table, fields }: TableDefine<T>, returning?: string[] | null, where?: Wheres | null): Promise<any[]>;
     /**
      *
      * @param {Queryable} queryable
@@ -1549,7 +1561,7 @@ declare function defaultValue<T>(value: T): FieldDecorator<T>;
  * @param {string} table
  * @returns {ClassDecorator}
  */
-declare function submodel(table: string): ClassDecorator;
+declare function model(table: string): ClassDecorator;
 /**
  * @template {Record<string, any>} T
  * @overload
@@ -1559,7 +1571,7 @@ declare function submodel(table: string): ClassDecorator;
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<T[]>}
  */
-declare function submodel<T extends Record<string, any>>(type: TableDefine & {
+declare function model<T extends Record<string, any>>(type: TableDefine & {
     new (...a: any): T;
 }, constraints: Record<string, Constraint>, array: true, options?: FieldDefineOption | undefined): FieldDecorator<T[]>;
 /**
@@ -1571,7 +1583,7 @@ declare function submodel<T extends Record<string, any>>(type: TableDefine & {
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<T>}
  */
-declare function submodel<T extends Record<string, any>>(type: TableDefine & {
+declare function model<T extends Record<string, any>>(type: TableDefine & {
     new (...a: any): T;
 }, constraints: Record<string, Constraint>, array?: false | undefined, options?: FieldDefineOption | undefined): FieldDecorator<T>;
 /**
@@ -1582,7 +1594,7 @@ declare function submodel<T extends Record<string, any>>(type: TableDefine & {
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<T>}
  */
-declare function submodel<T extends Record<string, any>>(type: TableDefine & {
+declare function model<T extends Record<string, any>>(type: TableDefine & {
     new (...a: any): T;
 }, constraints: Record<string, Constraint>, options?: FieldDefineOption | undefined): FieldDecorator<T>;
 /**
@@ -1595,7 +1607,7 @@ declare function submodel<T extends Record<string, any>>(type: TableDefine & {
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<A extends false ? T : A extends true ? T[] : T | T[]>}
  */
-declare function submodel<T extends Record<string, any>, A extends boolean = boolean>(type: TableDefine & {
+declare function model<T extends Record<string, any>, A extends boolean = boolean>(type: TableDefine & {
     new (...a: any): T;
 }, constraints: Record<string, Constraint>, array: A, options?: FieldDefineOption | undefined): FieldDecorator<A extends false ? T : A extends true ? T[] : T | T[]>;
 /**
@@ -1607,7 +1619,7 @@ declare function submodel<T extends Record<string, any>, A extends boolean = boo
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<T[]>}
  */
-declare function submodel<T extends Record<string, any>>(type: TableDefine, constraints: Record<string, Constraint>, array: true, options?: FieldDefineOption | undefined): FieldDecorator<T[]>;
+declare function model<T extends Record<string, any>>(type: TableDefine, constraints: Record<string, Constraint>, array: true, options?: FieldDefineOption | undefined): FieldDecorator<T[]>;
 /**
  * @template {object} T
  * @overload
@@ -1617,7 +1629,7 @@ declare function submodel<T extends Record<string, any>>(type: TableDefine, cons
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<T>}
  */
-declare function submodel<T extends Record<string, any>>(type: TableDefine, constraints: Record<string, Constraint>, array?: false | undefined, options?: FieldDefineOption | undefined): FieldDecorator<T>;
+declare function model<T extends Record<string, any>>(type: TableDefine, constraints: Record<string, Constraint>, array?: false | undefined, options?: FieldDefineOption | undefined): FieldDecorator<T>;
 /**
  * @template {object} T
  * @overload
@@ -1626,7 +1638,7 @@ declare function submodel<T extends Record<string, any>>(type: TableDefine, cons
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<T>}
  */
-declare function submodel<T extends Record<string, any>>(type: TableDefine, constraints: Record<string, Constraint>, options?: FieldDefineOption | undefined): FieldDecorator<T>;
+declare function model<T extends Record<string, any>>(type: TableDefine, constraints: Record<string, Constraint>, options?: FieldDefineOption | undefined): FieldDecorator<T>;
 /**
  * @template {object} T
  * @template {boolean} [A=boolean]
@@ -1637,7 +1649,7 @@ declare function submodel<T extends Record<string, any>>(type: TableDefine, cons
  * @param {FieldDefineOption} [options]
  * @returns {FieldDecorator<A extends false ? T :A extends true ? T[] : T | T[]>}
  */
-declare function submodel<T extends Record<string, any>, A extends boolean = boolean>(type: TableDefine, constraints: Record<string, Constraint>, array: A, options?: FieldDefineOption | undefined): FieldDecorator<A extends false ? T : A extends true ? T[] : T | T[]>;
+declare function model<T extends Record<string, any>, A extends boolean = boolean>(type: TableDefine, constraints: Record<string, Constraint>, array: A, options?: FieldDefineOption | undefined): FieldDecorator<A extends false ? T : A extends true ? T[] : T | T[]>;
 
 /**
  * @param {number} [size]
@@ -1655,11 +1667,29 @@ declare function updating(size?: number): FieldDecorator<Date | null>;
  */
 declare function deleting(size?: number): FieldDecorator<Date | null>;
 
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['beforeCreateMany']>} */
+declare const beforeCreateMany: (insert?: boolean) => MethodDecorator<Hooks["beforeCreateMany"]>;
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['afterCreateMany']>} */
+declare const afterCreateMany: (insert?: boolean) => MethodDecorator<Hooks["afterCreateMany"]>;
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['beforeCreate']>} */
+declare const beforeCreate: (insert?: boolean) => MethodDecorator<Hooks["beforeCreate"]>;
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['afterCreate']>} */
+declare const afterCreate: (insert?: boolean) => MethodDecorator<Hooks["afterCreate"]>;
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['beforeUpdate']>} */
+declare const beforeUpdate: (insert?: boolean) => MethodDecorator<Hooks["beforeUpdate"]>;
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['afterUpdate']>} */
+declare const afterUpdate: (insert?: boolean) => MethodDecorator<Hooks["afterUpdate"]>;
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['beforeDelete']>} */
+declare const beforeDelete: (insert?: boolean) => MethodDecorator<Hooks["beforeDelete"]>;
+/** @type {(insert?: boolean) => MethodDecorator<Hooks['afterDelete']>} */
+declare const afterDelete: (insert?: boolean) => MethodDecorator<Hooks["afterDelete"]>;
+
 type ClassDecorator = (val: Function, ctx: ClassDecoratorContext) => any;
 type FieldDecorator<T> = (val: {
     get(): T;
     set(v: T): void;
 }, ctx: ClassAccessorDecoratorContext) => any;
+type MethodDecorator<T extends Function> = (val: T, ctx: ClassMethodDecoratorContext<any, T>) => any;
 
 type QueryOptions<T extends Fields, TB extends unknown = any> = {
     table?: string | VirtualTable<object> | undefined;
@@ -1921,6 +1951,7 @@ declare class Model implements Save, Destroy, PseudoDestroy {
     static readonly fields: Fields;
     /** @readonly @type {readonly IndexInfo[]} */
     static readonly indexes: readonly IndexInfo[];
+    static get hooks(): Readonly<Partial<Hooks<Record<string, any>>>>;
     /**
      * @template {typeof Model} T
      * @this {T}
@@ -1941,10 +1972,10 @@ declare class Model implements Save, Destroy, PseudoDestroy {
      * @this {T}
      * @param {Connection} t
      * @param {object} p
-     * @param {(data: object) => Promise<object>} run
+     * @param {(data: object, that: any) => Promise<object>} run
      * @returns {Promise<InstanceType<T>>}
      */
-    static [Create]<T extends typeof Model>(this: T, t: Connection, p: object, run: (data: object) => Promise<object>): Promise<InstanceType<T>>;
+    static [Create]<T extends typeof Model>(this: T, t: Connection, p: object, run: (data: object, that: any) => Promise<object>): Promise<InstanceType<T>>;
     /**
      * @template {typeof Model} T
      * @this {T}
@@ -2272,4 +2303,4 @@ declare function field<T extends MainFieldType>(type: T, options: {
 declare function setDevelopment(d?: boolean): void;
 declare let isDevelopment: boolean;
 
-export { Build, type ClassDecorator, type Column, type ColumnOptions, Connection, type Constraint, Create, type DBColumn, type DBIndex, type DBTable, Destroy, type Environment, type FieldDecorator, type FieldDefine, type FieldDefineOption, type FieldDefineType, type FieldSpecific, type FieldSpecificValue, type FieldType, type FieldTypeDefine, type FieldValue, type Fields, type FindArg, type FindRange, type GetName, type IConnection, type Index, type IndexInfo, type IndexOptions, type Join, type JoinType, type MainFieldType, type MaybePromise, Model, type Options, PseudoDestroy, Query, type QueryOptions, type Queryable, Save, Scene, Select, SetValue, type Skip, Submodel, type Support, type TableDefine, type TableType, type ToFieldType, type ToType, type TransactionFn, type VirtualTable, Where, type WhereItem, type WhereLike, type WhereOr, type WhereRaw, type WhereValue, type Wheres, column, creating, decrement, defaultValue, field as define, deleted, deleting, divide, field$1 as field, getPrimaryFields, getPrimaryKeys, immutable, increment, index, isDevelopment, isPseudo, submodel as model, multiply, now, primary, prop, pseudo, setDevelopment, sort, submodel, toNot, toPrimaries, toPrimary, uncreatable, undeleted, updating, uuid, values, withDeleted };
+export { Build, type ClassDecorator, type Column, type ColumnOptions, Connection, type Constraint, Create, type DBColumn, type DBIndex, type DBTable, Destroy, type Environment, type FieldDecorator, type FieldDefine, type FieldDefineOption, type FieldDefineType, type FieldSpecific, type FieldSpecificValue, type FieldType, type FieldTypeDefine, type FieldValue, type Fields, type FindArg, type FindRange, type GetName, type Hooks, type IConnection, type Index, type IndexInfo, type IndexOptions, type Join, type JoinType, type MainFieldType, type MaybePromise, type MethodDecorator, Model, type Options, PseudoDestroy, Query, type QueryOptions, type Queryable, Save, Scene, Select, SetValue, type Skip, Submodel, type Support, type TableDefine, type TableType, type ToFieldType, type ToType, type TransactionFn, type VirtualTable, Where, type WhereItem, type WhereLike, type WhereOr, type WhereRaw, type WhereValue, type Wheres, afterCreate, afterCreateMany, afterDelete, afterUpdate, beforeCreate, beforeCreateMany, beforeDelete, beforeUpdate, column, creating, decrement, defaultValue, field as define, deleted, deleting, divide, field$1 as field, getPrimaryFields, getPrimaryKeys, immutable, increment, index, isDevelopment, isPseudo, model, multiply, now, primary, prop, pseudo, setDevelopment, sort, model as submodel, toNot, toPrimaries, toPrimary, uncreatable, undeleted, updating, uuid, values, withDeleted };