imodel 0.3.0 → 0.4.0

package/index.d.mts

@@ -1,18 +1,20 @@
 /*!
- * imodel v0.3.0
+ * imodel v0.4.0
  * (c) 2019-2025 undefined
  * @license undefined
  */
 
 declare const now: unique symbol;
+declare const uuid: unique symbol;
 declare const increment$1: unique symbol;
 declare const decrement$1: unique symbol;
 declare const multiply$1: unique symbol;
 declare const divide$1: unique symbol;
 
 declare const values_now: typeof now;
+declare const values_uuid: typeof uuid;
 declare namespace values {
-  export { decrement$1 as decrement, divide$1 as divide, increment$1 as increment, multiply$1 as multiply, values_now as now };
+  export { decrement$1 as decrement, divide$1 as divide, increment$1 as increment, multiply$1 as multiply, values_now as now, values_uuid as uuid };
 }
 
 interface Environment<T extends object> {
@@ -512,7 +514,7 @@ declare class Where {
     #private;
 }
 
-/** @typedef {SetValue.Increment | SetValue.Decrement | SetValue.Multiply | SetValue.Divide | string | number | bigint | boolean | null | typeof now | (string | number | bigint | boolean)[]} SetValue */
+/** @typedef {SetValue.Increment | SetValue.Decrement | SetValue.Multiply | SetValue.Divide | string | number | bigint | boolean | null | typeof now | typeof uuid | (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 */
@@ -537,8 +539,7 @@ declare function multiply(value: number | bigint): SetValue.Multiply;
  * @returns {SetValue.Divide}
  */
 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 | (string | number | bigint | boolean)[];
+type SetValue = SetValue.Increment | SetValue.Decrement | SetValue.Multiply | SetValue.Divide | string | number | bigint | boolean | null | typeof now | typeof uuid | (string | number | bigint | boolean)[];
 declare namespace SetValue {
     type Increment = {
         [increment$1]: number | bigint;
@@ -555,15 +556,15 @@ declare namespace SetValue {
 }
 
 interface VirtualTable<E extends object = object> {
-    insert(environment: Environment<E>, conn: IConnection<E>, table: string, fields: Fields<keyof FieldType>, data: object[], key: string[]): PromiseLike<any[]>;
-    update(environment: Environment<E>, conn: IConnection<E>, args: MatchArg, update: Record<string, SetValue>): PromiseLike<number>;
-    updateReturn(environment: Environment<E>, conn: IConnection<E>, args: MatchArg, update: Record<string, SetValue>, returning: string[]): PromiseLike<any[]>;
-    updateMany(environment: Environment<E>, conn: IConnection<E>, table: string, fields: Fields<keyof FieldType>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[]): PromiseLike<number>;
-    updateManyReturn(environment: Environment<E>, conn: IConnection<E>, table: string, fields: Fields<keyof FieldType>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[], returning: string[]): PromiseLike<any[]>;
-    count(environment: Environment<E>, conn: IConnection<E>, argv: CountArg): PromiseLike<number>;
-    select(environment: Environment<E>, conn: IConnection<E>, argv: SelectArg): PromiseLike<any[]>;
-    delete(environment: Environment<E>, conn: IConnection<E>, argv: MatchArg): PromiseLike<number>;
-    deleteReturn(environment: Environment<E>, conn: IConnection<E>, argv: MatchArg, returning: string[]): PromiseLike<any[]>;
+    insert(environment: Environment<E>, conn: IConnection<E>, fields: Fields<keyof FieldType>, data: object[], key: string[]): PromiseLike<any[]>;
+    update(environment: Environment<E>, conn: IConnection<E>, columns: Record<string, DBColumn>, update: Record<string, SetValue>, where?: WhereValue[] | null): PromiseLike<number>;
+    updateReturn(environment: Environment<E>, conn: IConnection<E>, returning: string[], columns: Record<string, DBColumn>, update: Record<string, SetValue>, where?: WhereValue[] | null): PromiseLike<any[]>;
+    updateMany(environment: Environment<E>, conn: IConnection<E>, fields: Fields<keyof FieldType>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[]): PromiseLike<number>;
+    updateManyReturn(environment: Environment<E>, conn: IConnection<E>, fields: Fields<keyof FieldType>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[], returning: string[]): PromiseLike<any[]>;
+    count(environment: Environment<E>, conn: IConnection<E>, columns: Record<string, DBColumn>, where: WhereValue[]): PromiseLike<number>;
+    find(environment: Environment<E>, conn: IConnection<E>, columns: Record<string, DBColumn>, argv: FindArg): PromiseLike<any[]>;
+    delete(environment: Environment<E>, conn: IConnection<E>, columns: Record<string, DBColumn>, where?: WhereValue[] | null): PromiseLike<number>;
+    deleteReturn(environment: Environment<E>, conn: IConnection<E>, returning: string[], columns: Record<string, DBColumn>, where?: WhereValue[] | null): PromiseLike<any[]>;
 }
 
 /** 字段基本类型 */
@@ -612,14 +613,15 @@ interface Constraint {
     field?: string;
     value?: any;
 }
-type MainFieldType = keyof FieldType | TableDefine;
+type MainFieldType = keyof FieldType | TableDefine | null;
 type ToFieldType<T> = T extends keyof FieldType ? FieldType[T] : unknown;
-type FieldSpecificValue = (string | number | bigint | boolean)[] | string | number | bigint | boolean | null | typeof now;
+type FieldSpecificValue = (string | number | bigint | boolean)[] | string | number | bigint | boolean | null | typeof now | typeof uuid;
 type FieldSpecific = FieldSpecificValue | {
     value: FieldSpecificValue;
     computed?(): PromiseLike<FieldSpecificValue> | FieldSpecificValue;
 };
 interface FieldDefineOption {
+    column?: string;
     /** 缩放比 */
     scale?: number;
     /** 占用空间大小 */
@@ -679,11 +681,11 @@ interface IndexInfo extends IndexOptions {
 interface Index extends IndexInfo {
     name: string;
 }
-interface TableDefine<T extends Fields = Fields> {
+interface TableDefine<T extends Fields = Fields, TT extends string | VirtualTable | void = string | VirtualTable | void> {
     /** 字段信息 */
     readonly fields: T;
     /** 表名 */
-    readonly table?: string | VirtualTable;
+    readonly table: TT;
     /** 是否启用软删除 */
     readonly pseudo?: string;
     /** 索引信息 */
@@ -745,78 +747,42 @@ interface ColumnOptions<T = unknown> extends FieldDefineOption {
     default?: T extends never ? never : T;
 }
 interface Column<T> extends ColumnOptions<T> {
-    name: string;
+    column: string;
     type: string;
 }
 
-/** 特性支持情况 */
-interface Support {
-    /** 是否支持 sql 查询 */
-    sql?: boolean;
-    /** 是否支持数组类型 */
-    array?: boolean;
-    /** 是否支持对象存储 */
-    object?: boolean;
-    /** 是否支持递归查询 */
-    recursive?: boolean;
-    [key: string]: undefined | boolean;
-}
-
-type MaybePromise<T> = PromiseLike<T> | T;
-
-declare const Destroy: unique symbol;
-interface Destroy {
-    [Destroy](connection: Connection, run: (data: any) => Promise<object | null>, table: TableDefine<Fields<MainFieldType>>): PromiseLike<this | null>;
-}
-declare const PseudoDestroy: unique symbol;
-interface PseudoDestroy {
-    [PseudoDestroy](connection: Connection, update: Record<string, SetValue>, run: (data: any) => Promise<object | null>, table: TableDefine<Fields<MainFieldType>>): PromiseLike<this | null>;
-}
-declare const Save: unique symbol;
-interface Save {
-    [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> {
-    [Create](connection: Connection, data: object, run: (data: any) => Promise<object>, table: TableDefine): PromiseLike<T>;
-}
-declare const Build: unique symbol;
-interface Build<T = unknown> {
-    [Build](data: object, others: object | boolean): T;
-}
-
 type TableType = '' | 'table' | 'view';
-interface CountArg extends Omit<TableDefine, 'table'>, Omit<Options, 'select'> {
-    table: string;
-}
-interface SelectArg extends CountArg {
+interface FindArg {
+    /** 排序配置，true 表示逆序 */
+    sort?: [field: string, desc: boolean][];
+    /** 匹配信息 */
+    where: WhereValue[];
     select: [string, Select][];
+    /** 偏移量 */
+    offset?: number;
+    /** 最大返回数 */
+    limit?: number;
 }
 type GetName = (table?: string) => string;
-interface MatchArg extends Omit<TableDefine<Fields<keyof FieldType>>, 'table'> {
-    table: string;
-    where?: WhereValue[];
-}
-type BuildValue<T extends TableDefine> = T extends Build<infer R> ? R : object;
-interface DBField {
+interface DBColumn {
     type: string;
-    size: number;
-    scale: number;
+    size?: number;
+    scale?: number;
     default?: any;
-    nullable: boolean;
-    array: boolean;
+    nullable?: boolean;
+    array?: boolean;
     primary?: number;
 }
 interface DBIndex {
     fields: string[];
-    includes: string[];
-    unique: boolean;
+    includes?: string[];
+    unique?: boolean;
     name?: string;
 }
 interface DBTable {
     table: string;
-    fields: Record<string, DBField>;
-    indexes: DBIndex[];
+    fields: Record<string, DBColumn>;
+    indexes?: DBIndex[];
     primary?: string;
 }
 interface IConnection<E extends object = object> {
@@ -831,16 +797,16 @@ interface IConnection<E extends object = object> {
      */
     query(environment: Environment<E>, ...values: any): PromiseLike<any[]>;
     type(environment: Environment<E>, table: string): PromiseLike<TableType | null>;
-    insert(environment: Environment<E>, table: string, fields: Fields<keyof FieldType>, data: object[], key: string[]): PromiseLike<any[]>;
-    update(environment: Environment<E>, args: MatchArg, update: Record<string, SetValue>): PromiseLike<number>;
-    updateReturn(environment: Environment<E>, args: MatchArg, update: Record<string, SetValue>, returning: string[]): PromiseLike<any[]>;
-    updateMany(environment: Environment<E>, table: string, fields: Fields<keyof FieldType>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[]): PromiseLike<number>;
-    updateManyReturn(environment: Environment<E>, table: string, fields: Fields<keyof FieldType>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[], returning: string[]): PromiseLike<any[]>;
-    count(environment: Environment<E>, argv: CountArg): PromiseLike<number>;
-    select(environment: Environment<E>, argv: SelectArg): PromiseLike<any[]>;
-    delete(environment: Environment<E>, argv: MatchArg): PromiseLike<number>;
-    deleteReturn(environment: Environment<E>, argv: MatchArg, returning: string[]): PromiseLike<any[]>;
-    createTable(environment: Environment<E>, table: string, fields: Column<any>[]): PromiseLike<number>;
+    insert(environment: Environment<E>, table: string, columns: Record<string, DBColumn>, data: object[], key: string[], conflict?: boolean | Record<string, SetValue>): PromiseLike<any[]>;
+    update(environment: Environment<E>, table: string, columns: Record<string, DBColumn>, update: Record<string, SetValue>, where?: WhereValue[] | null): PromiseLike<number>;
+    updateReturn(environment: Environment<E>, returning: string[], table: string, columns: Record<string, DBColumn>, update: Record<string, SetValue>, where?: WhereValue[] | null): PromiseLike<any[]>;
+    updateMany(environment: Environment<E>, table: string, columns: Record<string, DBColumn>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[]): PromiseLike<number>;
+    updateManyReturn(environment: Environment<E>, table: string, columns: Record<string, DBColumn>, update: Record<string, any>, pKeys: string[], setKeys: string[], list: Record<string, any>[], where: WhereValue[], returning: string[]): PromiseLike<any[]>;
+    count(environment: Environment<E>, table: string, columns: Record<string, DBColumn>, where?: WhereValue[] | null): PromiseLike<number>;
+    find(environment: Environment<E>, table: string, columns: Record<string, DBColumn>, argv: FindArg): PromiseLike<any[]>;
+    delete(environment: Environment<E>, table: string, columns: Record<string, DBColumn>, where?: WhereValue[] | null): PromiseLike<number>;
+    deleteReturn(environment: Environment<E>, returning: string[], table: string, columns: Record<string, DBColumn>, where?: WhereValue[] | null): PromiseLike<any[]>;
+    createTable(environment: Environment<E>, table: string, columns: Column<any>[]): PromiseLike<number>;
     dropTable(environment: Environment<E>, table: string): PromiseLike<number>;
     renameTable(environment: Environment<E>, table: string, newName: string): PromiseLike<number>;
     addColumn(environment: Environment<E>, table: string, column: string, type: string, options: ColumnOptions<any>): PromiseLike<number>;
@@ -848,12 +814,8 @@ interface IConnection<E extends object = object> {
     changeColumnNull(environment: Environment<E>, table: string, column: string, nullable: boolean): PromiseLike<number>;
     dropColumn(environment: Environment<E>, table: string, column: string): PromiseLike<number>;
     renameColumn(environment: Environment<E>, table: string, column: string, newName: string): PromiseLike<number>;
-    addIndex(environment: Environment<E>, table: string, name: string, fields: string[], options: IndexOptions): PromiseLike<number>;
+    addIndex(environment: Environment<E>, table: string, name: string, columns: string[], options: IndexOptions): PromiseLike<number>;
     dropIndex(environment: Environment<E>, table: string, name: string): PromiseLike<number>;
-    createView(environment: Environment<E>, name: string, q: SelectArg): PromiseLike<number>;
-    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>;
@@ -865,9 +827,41 @@ interface Skip {
 interface TransactionFn {
     <T>(fn: (t: Connection) => PromiseLike<T> | T): Promise<T>;
 }
-/** @deprecated */
-interface Querier<T> {
-    (t: Connection): PromiseLike<T> | T;
+
+/** 特性支持情况 */
+interface Support {
+    /** 是否支持 sql 查询 */
+    sql?: boolean;
+    /** 是否支持数组类型 */
+    array?: boolean;
+    /** 是否支持对象存储 */
+    object?: boolean;
+    /** 是否支持递归查询 */
+    recursive?: boolean;
+    [key: string]: undefined | boolean;
+}
+
+type MaybePromise<T> = PromiseLike<T> | T;
+
+declare const Destroy: unique symbol;
+interface Destroy {
+    [Destroy](connection: Connection, run: (data: any) => Promise<object | null>, table: TableDefine<Fields<MainFieldType>>): PromiseLike<this | null>;
+}
+declare const PseudoDestroy: unique symbol;
+interface PseudoDestroy {
+    [PseudoDestroy](connection: Connection, update: Record<string, SetValue>, run: (data: any) => Promise<object | null>, table: TableDefine<Fields<MainFieldType>>): PromiseLike<this | null>;
+}
+declare const Save: unique symbol;
+interface Save {
+    [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> {
+    [Create](connection: Connection, data: object, run: (data: any) => Promise<object>, table: TableDefine): PromiseLike<T>;
+}
+declare const Build: unique symbol;
+interface Build<T = unknown> {
+    [Build](data: object, others: object | boolean): T;
 }
 
 /**
@@ -1158,28 +1152,6 @@ declare class Connection<E extends {} = {}> {
      * @returns {Promise<number>}
      */
     renameTable(table: string, newName: string): Promise<number>;
-    /**
-     * @param {string} view
-     * @param {Queryable} queryable
-     * @returns {Promise<number>}
-     */
-    createView(view: string, queryable: Queryable): Promise<number>;
-    /**
-     * @param {string} view
-     * @returns {Promise<number>}
-     */
-    dropView(view: string): Promise<number>;
-    /**
-     * @param {string} view
-     * @param {Queryable} queryable
-     * @returns {Promise<number>}
-     */
-    createMaterializedView(view: string, queryable: Queryable): Promise<number>;
-    /**
-     * @param {string} view
-     * @returns {Promise<number>}
-     */
-    dropMaterializedView(view: string): Promise<number>;
     abort(): boolean;
     /**
      * @param {string} table
@@ -1192,10 +1164,15 @@ declare class Connection<E extends {} = {}> {
      */
     loadTables(tables: string[]): Promise<DBTable[]>;
     /**
-     * @param {DBTable[]} tables
+     * @param {TableDefine | DBTable} table
+     * @returns {Promise<void>}
+     */
+    syncTable(table: TableDefine | DBTable): Promise<void>;
+    /**
+     * @param {(TableDefine | DBTable)[]} tables
      * @returns {Promise<void>}
      */
-    syncTables(tables: DBTable[]): Promise<void>;
+    syncTables(tables: (TableDefine | DBTable)[]): Promise<void>;
     /**
      * @template T
      * @overload
@@ -1214,10 +1191,10 @@ declare class Connection<E extends {} = {}> {
 /** @import { Fields } from './types' */
 /**
  *
- * @param {Fields} fields
+ * @param {Fields} fieldsOrColumns
  * @returns {string[]}
  */
-declare function getPrimaryKeys(fields: Fields): string[];
+declare function getPrimaryKeys(fieldsOrColumns: Fields): string[];
 
 /**
  *
@@ -1473,6 +1450,14 @@ declare function field$1<T extends keyof FieldType>(type: T, options: {
  */
 declare function prop(prop: string, value: any): FieldDecorator<any>;
 
+/** @import { FieldDecorator } from './index.mjs' */
+/**
+ *
+ * @param {string} [column]
+ * @returns {FieldDecorator<any>}
+ */
+declare function column(column?: string): FieldDecorator<any>;
+
 /** @import { FieldDecorator } from './index.mjs' */
 /**
  *
@@ -2213,4 +2198,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, 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 };
+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, 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, 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, uuid, values, withDeleted };