imodel 0.1.0 → 0.3.0

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
- * imodel v0.1.0
+ * imodel v0.3.0
  * (c) 2019-2025 undefined
  * @license undefined
  */
@@ -18,8 +18,6 @@ declare namespace values {
 interface Environment<T extends object> {
     transaction: T | null;
     isDevelopment: boolean;
-    names?: Record<string, string> | null;
-    getName(table: string): string;
     values: typeof values;
 }
 
@@ -514,7 +512,7 @@ declare class Where {
     #private;
 }
 
-/** @typedef {SetValue.Increment | SetValue.Decrement | SetValue.Multiply | SetValue.Divide | string | number | bigint | boolean | null | typeof now} SetValue */
+/** @typedef {SetValue.Increment | SetValue.Decrement | SetValue.Multiply | SetValue.Divide | string | number | bigint | boolean | null | typeof now | (string | number | bigint | boolean)[]} SetValue */
 /** @typedef {{[values.increment]: number | bigint}} SetValue.Increment */
 /** @typedef {{[values.decrement]: number | bigint}} SetValue.Decrement */
 /** @typedef {{[values.multiply]: number | bigint}} SetValue.Multiply */
@@ -540,7 +538,7 @@ declare function multiply(value: number | bigint): SetValue.Multiply;
  */
 declare function divide(value: number | bigint): SetValue.Divide;
 
-type SetValue = SetValue.Increment | SetValue.Decrement | SetValue.Multiply | SetValue.Divide | string | number | bigint | boolean | null | typeof now;
+type SetValue = SetValue.Increment | SetValue.Decrement | SetValue.Multiply | SetValue.Divide | string | number | bigint | boolean | null | typeof now | (string | number | bigint | boolean)[];
 declare namespace SetValue {
     type Increment = {
         [increment$1]: number | bigint;
@@ -570,18 +568,9 @@ interface VirtualTable<E extends object = object> {
 
 /** 字段基本类型 */
 interface FieldType {
-    /** 基本的 Id 类型，具体数据库实现由数据库决定 */
-    id: string;
-    /** 引用类型，具体数据库实现由数据库决定，需要与 id 类型一致 */
-    rid: string;
-    /** 弱引用类型，需要考虑跨数据库引擎实现 */
-    ref: string;
     i16: number;
     i32: number;
     i64: bigint;
-    u16: number;
-    u32: number;
-    u64: bigint;
     f32: number;
     f64: number;
     decimal: number;
@@ -595,12 +584,13 @@ interface FieldType {
     ip: string;
     ipv4: string;
     ipv6: string;
+    ipnet: string;
+    ipnetv4: string;
+    ipnetv6: string;
     mac48: string;
     mac64: string;
     /** 布尔型 */
     bool: boolean;
-    /** 二进制类型 */
-    binary: ArrayBuffer | ArrayBufferView;
     /** 日期类型 */
     date: Date;
     /** 时间类型 */
@@ -624,27 +614,28 @@ interface Constraint {
 }
 type MainFieldType = keyof FieldType | TableDefine;
 type ToFieldType<T> = T extends keyof FieldType ? FieldType[T] : unknown;
+type FieldSpecificValue = (string | number | bigint | boolean)[] | string | number | bigint | boolean | null | typeof now;
+type FieldSpecific = FieldSpecificValue | {
+    value: FieldSpecificValue;
+    computed?(): PromiseLike<FieldSpecificValue> | FieldSpecificValue;
+};
 interface FieldDefineOption {
-    /** 精确度 */
-    precision?: number;
     /** 缩放比 */
     scale?: number;
     /** 占用空间大小 */
     size?: number;
     /** 是否为主键 */
-    primary?: number | boolean;
-    /** 序列字段 */
-    serial?: boolean;
+    primary?: number;
     /** 唯一索引? */
     unique?: boolean;
     /** 索引信息 */
     index?: string | boolean;
-    /** 创建时，作为时间戳 */
-    timestampCreating?: boolean;
-    /** 更新时，作为时间戳 */
-    timestampUpdating?: boolean;
-    /** 伪删除时，作为时间戳 */
-    timestampDeleting?: boolean;
+    /** 创建时，自定义数据 */
+    creating?: FieldSpecific;
+    /** 更新时，自定义数据 */
+    updating?: FieldSpecific;
+    /** 伪删除时，自定义数据 */
+    deleting?: FieldSpecific;
     /** 是否为固定值 */
     immutable?: boolean;
     /** 文本查询 */
@@ -783,7 +774,7 @@ interface PseudoDestroy {
 }
 declare const Save: unique symbol;
 interface Save {
-    [Save](connection: Connection, run: (data: any, newData?: any) => Promise<object | null>, table: TableDefine): PromiseLike<this | null>;
+    [Save](connection: Connection, run: (data: any, newData?: any) => Promise<object | null>, newData: Record<string, any> | null, table: TableDefine): PromiseLike<this | null>;
 }
 declare const Create: unique symbol;
 interface Create<T = unknown> {
@@ -807,6 +798,27 @@ interface MatchArg extends Omit<TableDefine<Fields<keyof FieldType>>, 'table'> {
     where?: WhereValue[];
 }
 type BuildValue<T extends TableDefine> = T extends Build<infer R> ? R : object;
+interface DBField {
+    type: string;
+    size: number;
+    scale: number;
+    default?: any;
+    nullable: boolean;
+    array: boolean;
+    primary?: number;
+}
+interface DBIndex {
+    fields: string[];
+    includes: string[];
+    unique: boolean;
+    name?: string;
+}
+interface DBTable {
+    table: string;
+    fields: Record<string, DBField>;
+    indexes: DBIndex[];
+    primary?: string;
+}
 interface IConnection<E extends object = object> {
     /** 数据库类型 */
     readonly dbType: string;
@@ -842,8 +854,14 @@ interface IConnection<E extends object = object> {
     dropView(environment: Environment<E>, name: string): PromiseLike<number>;
     createMaterializedView(environment: Environment<E>, name: string, q: SelectArg): PromiseLike<number>;
     dropMaterializedView(environment: Environment<E>, name: string): PromiseLike<number>;
+    loadTables(environment: Environment<E>, tables: string[]): PromiseLike<DBTable[]>;
+    syncTables(environment: Environment<E>, tables: DBTable[]): PromiseLike<void>;
     transaction<R>(environment: Environment<E>, fn: (t: E) => R | PromiseLike<R>): PromiseLike<R>;
 }
+interface Skip {
+    immutable?: boolean;
+    specific?: boolean;
+}
 interface TransactionFn {
     <T>(fn: (t: Connection) => PromiseLike<T> | T): Promise<T>;
 }
@@ -860,18 +878,13 @@ declare class Connection<E extends {} = {}> {
      *
      * @param {PromiseLike<IConnection<E>> | IConnection<E>} connection
      * @param {E?} [transaction]
-     * @param {Record<string, string>?} [names]
      */
-    constructor(connection: PromiseLike<IConnection<E>> | IConnection<E>, transaction?: E | null, names?: Record<string, string> | null);
+    constructor(connection: PromiseLike<IConnection<E>> | IConnection<E>, transaction?: E | null);
     /**
      *
-     * @param {object} [options]
-     * @param {Record<string, string>?} [options.names]
      * @returns {Connection<E>}
      */
-    clone({ names }?: {
-        names?: Record<string, string> | null | undefined;
-    }): Connection<E>;
+    clone(): Connection<E>;
     /** @return {Promise<string>} */
     dbType(): Promise<string>;
     /** @return {Promise<string>} */
@@ -954,9 +967,10 @@ declare class Connection<E extends {} = {}> {
      * @template T
      * @param {TableDefine} model
      * @param {T} data
+     * @param {Record<string, any>?} [newData]
      * @returns {Promise<(T extends Save ? T : object)?>}
      */
-    save<T>(model: TableDefine, data: T): Promise<(T extends Save ? T : object) | null>;
+    save<T>(model: TableDefine, data: T, newData?: Record<string, any> | null): Promise<(T extends Save ? T : object) | null>;
     /**
      *
      * @template T
@@ -970,7 +984,7 @@ declare class Connection<E extends {} = {}> {
      * @template {object} T
      * @param {TableDefine} tableDef
      * @param {T} data
-* @param {Record<string, SetValue>} value
+     * @param {Record<string, SetValue>} value
      * @returns {Promise<(T extends PseudoDestroy ? T : object)?>}
      */
     pseudoDestroy<T extends unknown>(tableDef: TableDefine, data: T, value: Record<string, SetValue>): Promise<(T extends PseudoDestroy ? T : object) | null>;
@@ -1018,29 +1032,29 @@ declare class Connection<E extends {} = {}> {
      * @param {TableDefine} tableDefine
      * @param {Record<string, any>} update
      * @param {WhereValue[]?} [where]
-     * @param {boolean} [skip]
+     * @param {boolean | Skip} [skip]
      * @returns {Promise<number>}
      */
-    update({ table, fields }: TableDefine, update: Record<string, any>, where?: WhereValue[] | null, skip?: boolean): Promise<number>;
+    update({ table, fields }: TableDefine, update: Record<string, any>, where?: WhereValue[] | 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 {boolean} [skip]
+     * @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): 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[]>;
     /**
      * @param {TableDefine} tableDefine
      * @param {string[]} pKeys
      * @param {string[]} setKeys
      * @param {Record<string, any>[]} list
-     * @param {boolean} [skip]
+     * @param {boolean | Skip} [skip]
      * @returns {Promise<number>}
      */
-    updateMany({ table, fields }: TableDefine, pKeys: string[], setKeys: string[], list: Record<string, any>[], skip?: boolean): Promise<number>;
+    updateMany({ table, fields }: TableDefine, pKeys: string[], setKeys: string[], list: Record<string, any>[], skip?: boolean | Skip): Promise<number>;
     /**
      * @template {Fields<MainFieldType>} T
      * @param {TableDefine<T>} tableDefine
@@ -1048,10 +1062,10 @@ declare class Connection<E extends {} = {}> {
      * @param {string[]} setKeys
      * @param {Record<string, any>[]} list
      * @param {string[]?} [returning]
-     * @param {boolean} [skip]
+     * @param {boolean | Skip} [skip]
      * @returns {Promise<any[]>}
      */
-    updateManyReturn<T extends Fields<MainFieldType>>({ table, fields }: TableDefine<T>, pKeys: string[], setKeys: string[], list: Record<string, any>[], returning?: string[] | null, skip?: boolean): Promise<any[]>;
+    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]
@@ -1167,6 +1181,21 @@ declare class Connection<E extends {} = {}> {
      */
     dropMaterializedView(view: string): Promise<number>;
     abort(): boolean;
+    /**
+     * @param {string} table
+     * @returns {Promise<DBTable?>}
+     */
+    loadTable(table: string): Promise<DBTable | null>;
+    /**
+     * @param {string[]} tables
+     * @returns {Promise<DBTable[]>}
+     */
+    loadTables(tables: string[]): Promise<DBTable[]>;
+    /**
+     * @param {DBTable[]} tables
+     * @returns {Promise<void>}
+     */
+    syncTables(tables: DBTable[]): Promise<void>;
     /**
      * @template T
      * @overload
@@ -1436,17 +1465,6 @@ declare function field$1<T extends keyof FieldType>(type: T, options: {
     [k: string]: any;
 } & FieldDefineOption): FieldDecorator<ToType<T, boolean, boolean>>;
 
-/** @import { ToFieldType } from '../types' */
-/** @import { FieldDecorator } from './index.mjs' */
-/**
- * @param {object} [options]
- * @param {number?} [options.sort]
- * @returns {FieldDecorator<ToFieldType<'id'>>}
- */
-declare function id({ sort }?: {
-    sort?: number | null | undefined;
-}): FieldDecorator<ToFieldType<"id">>;
-
 /** @import { FieldDecorator } from './index.mjs' */
 /**
  * @param {string} prop
@@ -1604,20 +1622,20 @@ declare function submodel<T extends Record<string, any>>(type: TableDefine, cons
 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[]>;
 
 /**
- * @param {number} [precision]
+ * @param {number} [size]
  * @returns {FieldDecorator<Date?>}
  */
-declare function creating(precision?: number): FieldDecorator<Date | null>;
+declare function creating(size?: number): FieldDecorator<Date | null>;
 /**
- * @param {number} [precision]
+ * @param {number} [size]
  * @returns {FieldDecorator<Date?>}
  */
-declare function updating(precision?: number): FieldDecorator<Date | null>;
+declare function updating(size?: number): FieldDecorator<Date | null>;
 /**
- * @param {number} [precision]
+ * @param {number} [size]
  * @returns {FieldDecorator<Date?>}
  */
-declare function deleting(precision?: number): FieldDecorator<Date | null>;
+declare function deleting(size?: number): FieldDecorator<Date | null>;
 
 type ClassDecorator = (val: Function, ctx: ClassDecoratorContext) => any;
 type FieldDecorator<T> = (val: {
@@ -1626,7 +1644,7 @@ type FieldDecorator<T> = (val: {
 }, ctx: ClassAccessorDecoratorContext) => any;
 
 type QueryOptions<T extends Fields, TB extends unknown = any> = {
-    table: string;
+    table?: string | VirtualTable<object> | undefined;
     fields: T;
     pseudo?: string | undefined;
     build?: ((a: object, b?: object | boolean) => TB) | null | undefined;
@@ -1635,7 +1653,7 @@ type QueryOptions<T extends Fields, TB extends unknown = any> = {
  * @template {Fields} T
  * @template {object} [TB=object]
  * @typedef {object} QueryOptions
- * @property {string} table
+ * @property {string | VirtualTable} [table]
  * @property {T} fields
  * @property {string} [pseudo]
  * @property {((a: object, b?: object | boolean) => TB)?} [build]
@@ -1660,8 +1678,8 @@ declare class Query<T extends Fields, TB extends unknown = any> implements Query
      * @param {QueryOptions<T, TB> | Query<T, TB>} options
      */
     constructor(options: QueryOptions<T, TB> | Query<T, TB>);
-    /** @readonly @type {string} */
-    readonly table: string;
+    /** @readonly @type {string | VirtualTable | undefined} */
+    readonly table: string | VirtualTable | undefined;
     /** @readonly @type {T} */
     readonly fields: T;
     /** @readonly @type {string} */
@@ -1821,6 +1839,23 @@ declare class Query<T extends Fields, TB extends unknown = any> implements Query
     #private;
 }
 
+/** @import { Fields, IndexInfo, FieldDefine } from './types' */
+/**
+ *
+ * @param {Fields} fields
+ * @returns
+ */
+declare function getPrimaryFields(fields: Fields): string[];
+/**
+ * @param {string[]} fields
+ * @param {Record<string, any>} data
+ */
+declare function toPrimary(fields: string[], data: Record<string, any>): string; /**
+ * @param {{fields: Fields}} model
+ * @param {Record<string, any> | Record<string, any>[]} documents
+ */
+declare function toPrimaries(model: any, documents: any): string | string[];
+
 /**
  * @implements {Save}
  * @implements {Destroy}
@@ -1885,6 +1920,7 @@ declare class Model implements Save, Destroy, PseudoDestroy {
         [x: string]: any;
     };
     get $fieldChanged(): boolean;
+    $primary(): string;
     /**
      * @overload
      * @param {Record<string, any>} key
@@ -1971,9 +2007,10 @@ declare class Model implements Save, Destroy, PseudoDestroy {
     /**
      * @param {Connection} t
      * @param {(data: any, newData?: any) => Promise<object?>} run
+     * @param {Record<string, any>?} newData
      * @returns {Promise<this?>}
      */
-    [Save](t: Connection, run: (data: any, newData?: any) => Promise<object | null>): Promise<this | null>;
+    [Save](t: Connection, run: (data: any, newData?: any) => Promise<object | null>, newData: Record<string, any> | null): Promise<this | null>;
     /**
      * @param {Connection} t
      * @param {(data: any) => Promise<object?>} run
@@ -2176,4 +2213,4 @@ declare function field<T extends MainFieldType>(type: T, options: {
 declare function setDevelopment(d?: boolean): void;
 declare let isDevelopment: boolean;
 
-export { Build, type BuildValue, type ClassDecorator, type Column, type ColumnOptions, Connection, type Constraint, type CountArg, Create, Destroy, type Environment, type FieldDecorator, type FieldDefine, type FieldDefineOption, type FieldDefineType, type FieldType, type FieldTypeDefine, type FieldValue, type Fields, type FindRange, type GetName, type IConnection, type Index, type IndexInfo, type IndexOptions, type Join, type JoinType, type MainFieldType, type MatchArg, type MaybePromise, Model, type Options, PseudoDestroy, type Querier, Query, type QueryOptions, type Queryable, Save, Select, type SelectArg, SetValue, Submodel, type Support, type TableDefine, type TableType, type ToFieldType, type ToType, type TransactionFn, Where, type WhereItem, type WhereLike, type WhereOr, type WhereRaw, type WhereValue, type Wheres, creating, decrement, field as define, deleted, deleting, divide, field$1 as field, getPrimaryKeys, id, immutable, increment, index, isDevelopment, isPseudo, submodel as model, multiply, now, primary, prop, pseudo, setDevelopment, sort, submodel, toNot, undeleted, updating, values, withDeleted };
+export { Build, type BuildValue, type ClassDecorator, type Column, type ColumnOptions, Connection, type Constraint, type CountArg, Create, type DBField, 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 FindRange, type GetName, type IConnection, type Index, type IndexInfo, type IndexOptions, type Join, type JoinType, type MainFieldType, type MatchArg, type MaybePromise, Model, type Options, PseudoDestroy, type Querier, Query, type QueryOptions, type Queryable, Save, Select, type SelectArg, 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, creating, decrement, 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, undeleted, updating, values, withDeleted };