baja-lite 1.0.7 → 1.0.10

package/cjs/sql.d.ts

@@ -1,11 +1,13 @@
 import { XML } from './convert-xml';
 import { ArrayList } from './list';
+import { EnumMap } from 'enum';
 declare const _daoDBName: unique symbol;
 declare const _tableName: unique symbol;
 declare const _className: unique symbol;
 declare const _ClassName: unique symbol;
 declare const _vueName: unique symbol;
 declare const _ids: unique symbol;
+declare const _logicIds: unique symbol;
 declare const _columns: unique symbol;
 declare const _columnsNoId: unique symbol;
 declare const _fields: unique symbol;
@@ -14,16 +16,19 @@ declare const _deleteState: unique symbol;
 declare const _transformer: unique symbol;
 declare const _index: unique symbol;
 declare const _def: unique symbol;
+declare const _comment: unique symbol;
 export declare const _sqlCache: unique symbol;
 export declare const _dao: unique symbol;
 export declare const _primaryDB: unique symbol;
 declare const _dbType: unique symbol;
+declare const _formatDialect: unique symbol;
 declare const _sqlite_version: unique symbol;
 declare const _daoConnection: unique symbol;
 declare const _inTransaction: unique symbol;
 declare const _daoDB: unique symbol;
 declare const _sqliteRemoteName: unique symbol;
 declare const _SqlOption: unique symbol;
+export declare const _enums: unique symbol;
 export declare const _Hump: unique symbol;
 export declare const _GlobalSqlOption: unique symbol;
 export declare const _EventBus: unique symbol;
@@ -213,6 +218,8 @@ interface ServiceOption {
     dbType?: DBType;
     /** SQLite版本以及升级为该版本时需要执行的SQL,初始版本为0.0.1,切记每个位置不要变为两位数*/
     sqliteVersion?: string;
+    /** 备注 */
+    comment?: string;
 }
 /**
  # 全局行为配置文件
@@ -274,6 +281,23 @@ export interface GlobalSqlOptionForWeb {
     ]
      */
     sqlMapperMap?: SqlMappers;
+    /** 提供的枚举MAP */
+    enums?: EnumMap;
+    /**
+     * `列名与属性映射` 是否自动将下划线转为驼峰，默认NONE，即不转.
+     * 当设置为columnMode.HUMP时，切记将代码生成器中属性名称改对
+     * # 自定义sql查询时，无法自动转换哦,可使用标签转换：
+     *```
+        SELECT
+     *  {{#hump}} seller_sku2, seller_sku {{/hump}}
+     * ```
+     * 转换为
+     *```
+        SELECT
+     *  {{#hump}} seller_sku2 sellerSku2, seller_sku sellerSku {{/hump}}
+     * ```
+     */
+    columnMode?: ColumnMode;
 }
 /**
  # 全局行为配置文件
@@ -335,12 +359,13 @@ export interface GlobalSqlOption extends GlobalSqlOptionForWeb {
        export default {
             'sql_1': 'SELECT * FROM user WHERE username = :username',
             'sql_2': (options: {
-                ctx: any;
+                ctx?: any;
                 isCount?: boolean;
+                isSum?: boolean;
                 limitStart?: number;
                 limitEnd?: number;
                 orderBy?: string;
-                [k: string]: any;
+                params?: Record<string, any>;
             }) => {
                 return   `
                     SELECT * FROM user u LEFT JOIN organ o ON u.orgid = o.orgid
@@ -405,21 +430,6 @@ export interface GlobalSqlOption extends GlobalSqlOptionForWeb {
     ```
      */
     Redis?: Record<string, Record<string, any>> | Record<string, any>;
-    /**
-     * `列名与属性映射` 是否自动将下划线转为驼峰，默认NONE，即不转.
-     * 当设置为columnMode.HUMP时，切记将代码生成器中属性名称改对
-     * # 自定义sql查询时，无法自动转换哦,可使用标签转换：
-     *```
-        SELECT
-     *  {{#hump}} seller_sku2, seller_sku {{/hump}}
-     * ```
-     * 转换为
-     *```
-        SELECT
-     *  {{#hump}} seller_sku2 sellerSku2, seller_sku sellerSku {{/hump}}
-     * ```
-     */
-    columnMode?: ColumnMode;
     /**
      * 读取查询语句时，是否扫描JS文件？
      * JS文件需要默认导出一个 SqlModel对象
@@ -436,9 +446,16 @@ interface FieldOption extends Object {
     index?: boolean;
     id?: boolean;
     logicDelete?: string | number;
+    /** 是否逻辑唯一，用于导入时检测数据是否存在 */
+    logicId?: boolean;
     /** 仅在生成 表时有效 */
     notNull?: boolean;
+    /** 注释，影响到默认导出导入标题 */
     comment?: string;
+    /** 可以导入的字段,默认TRUE,ID默认FALSE */
+    importable?: boolean;
+    /** 可以导出的字段,默认TRUE,ID默认FALSE */
+    exportable?: boolean;
     /** sqlite 无效,与UUID只能有一个 */
     uuidShort?: boolean;
     /** 与uuidShort只能有一个 */
@@ -454,6 +471,7 @@ interface AField extends FieldOption {
     [DBType.Mysql]: () => string;
     [DBType.Sqlite]: () => string;
     [DBType.SqliteRemote]: () => string;
+    Data2SQL: (data: any) => any;
 }
 export interface PageQuery<L> {
     sum?: Record<string, number>;
@@ -463,14 +481,11 @@ export interface PageQuery<L> {
 }
 /** sqlite electron服务端需要支持的接口 */
 export interface SqliteRemoteInterface {
-    execute(dbName: string, sql?: string, params?: any): Promise<{
-        affectedRows: number;
-        insertId: bigint;
-    }>;
-    pluck<One_Row_Many_Column = any>(dbName: string, sql?: string, params?: any): Promise<One_Row_Many_Column | null>;
-    get<One_Row_Many_Column = any>(dbName: string, sql?: string, params?: any): Promise<One_Row_Many_Column | null>;
-    raw<Many_Row_One_Column = any>(dbName: string, sql?: string, params?: any): Promise<Many_Row_One_Column[]>;
-    query<Many_Row_Many_Column = any>(dbName: string, sql?: string, params?: any): Promise<Many_Row_Many_Column[]>;
+    execute(inData: Uint8Array): Promise<Uint8Array>;
+    pluck(inData: Uint8Array): Promise<Uint8Array>;
+    get(inData: Uint8Array): Promise<Uint8Array>;
+    raw(inData: Uint8Array): Promise<Uint8Array>;
+    query(inData: Uint8Array): Promise<Uint8Array>;
     initDB(dbName: string): Promise<void>;
     export(dbName: string): Promise<void>;
     restore(dbName: string, fromName: string): Promise<void>;
@@ -575,6 +590,7 @@ export declare class SqliteRemoteConnection implements Connection {
 export declare class SqliteRemote implements Dao {
     [_sqliteRemoteName]: string;
     [_daoDB]: SqliteRemoteInterface;
+    private connection?;
     constructor(db: SqliteRemoteInterface, name: string);
     createConnection(sync: SyncMode.Sync): Connection | null;
     createConnection(sync: SyncMode.Async): Promise<Connection | null>;
@@ -592,22 +608,22 @@ export declare class SqliteRemote implements Dao {
 export type SqlMapper = ([string, string[], any?])[];
 export type SqlMappers = Record<string, SqlMapper>;
 export type SqlModel = Record<string, string | ((options: {
-    ctx: any;
+    ctx?: any;
     isCount?: boolean;
     isSum?: boolean;
     limitStart?: number;
     limitEnd?: number;
     orderBy?: string;
-    [k: string]: any;
+    params?: any;
 }) => string)>;
 type _SqlModel = Record<string, string | ((options: {
-    ctx: any;
+    ctx?: any;
     isCount?: boolean;
     isSum?: boolean;
     limitStart?: number;
     limitEnd?: number;
     orderBy?: string;
-    [k: string]: any;
+    params?: any;
 }) => string) | XML[]>;
 /**
  * ifUndefined默认是MapperIfUndefined.Skip
@@ -644,7 +660,7 @@ export declare class SqlCache {
         jsMode?: boolean;
     }): Promise<void>;
     load(sqlids: string[], options: {
-        ctx: any;
+        ctx?: any;
         isCount?: boolean;
         isSum?: boolean;
         limitStart?: number;
@@ -664,6 +680,7 @@ export declare const DB: (config: ServiceOption) => <C extends {
         [_vueName]: string | undefined;
         [_daoDBName]: string | undefined;
         [_dbType]: DBType;
+        [_formatDialect]: any;
         [_sqlite_version]: string | undefined;
         [_SqlOption]: {
             maxDeal: number;
@@ -672,11 +689,13 @@ export declare const DB: (config: ServiceOption) => <C extends {
             skipEmptyString: boolean;
         } & ServiceOption;
         [_ids]: any;
+        [_logicIds]: any;
         [_fields]: any;
         [_columns]: any;
         [_columnsNoId]: any;
         [_index]: any;
         [_def]: any;
+        [_comment]: string | undefined;
         [_stateFileName]: any;
         [_deleteState]: any;
         [_transformer]: <L extends Object>(data: L, option?: MethodOption & {
@@ -733,6 +752,7 @@ export declare class SqlService<T extends object> {
     private [_ClassName]?;
     private [_vueName]?;
     private [_daoDBName]?;
+    private [_comment]?;
     private [_ids]?;
     private [_fields]?;
     private [_columns]?;
@@ -741,6 +761,7 @@ export declare class SqlService<T extends object> {
     private [_deleteState]?;
     private [_SqlOption]?;
     private [_dbType]?;
+    private [_formatDialect]?;
     private [_sqlite_version]?;
     private [_index]?;
     private [_def]?;
@@ -1246,8 +1267,8 @@ export declare class SqlService<T extends object> {
         sqlId: string;
         context?: any;
         params: Record<string, any>;
-        pageSize: number;
-        pageNumber: number;
+        pageSize?: number;
+        pageNumber?: number;
         limitSelf?: boolean;
         countSelf?: boolean;
         sumSelf?: boolean;
@@ -1261,8 +1282,8 @@ export declare class SqlService<T extends object> {
         sqlId: string;
         context?: any;
         params: Record<string, any>;
-        pageSize: number;
-        pageNumber: number;
+        pageSize?: number;
+        pageNumber?: number;
         limitSelf?: boolean;
         countSelf?: boolean;
         sumSelf?: boolean;
@@ -1271,6 +1292,40 @@ export declare class SqlService<T extends object> {
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
     }): PageQuery<L>;
+    /**
+     * 导出数据，可以为EJS-EXCEL直接使用
+     * @param list
+     * @returns
+     */
+    exp<L = T>(list: L[]): {
+        title: string | undefined;
+        titleSpan: string;
+        columnTitles: string[];
+        datas: any[][];
+    };
+    /**
+     * 导入数据的模板
+     * @returns
+     */
+    imp(): {
+        title: string | undefined;
+        titleSpan: string;
+        columnTitles: string[];
+    };
+    /**
+     * 初始化表结构
+     * 只有sqlite、sqliteremote需要
+     * force: 是否强制，默认false, 强制时会删除再创建
+     * @param option
+     */
+    init(option?: MethodOption & {
+        sync?: SyncMode.Async;
+        force?: boolean;
+    }): Promise<void>;
+    init(option: MethodOption & {
+        sync: SyncMode.Sync;
+        force?: boolean;
+    }): void;
     /**
     #创建表
     ** `tableName` 表名称