midway-fatcms 0.0.7 → 0.0.9

package/dist/libs/crud-pro/interfaces.d.ts

@@ -13,6 +13,7 @@ export interface ITableColumn {
     type: string;
     isNullable: boolean;
     isPrimaryKey?: boolean;
+    isIdentity?: boolean;
     defaultValue?: any;
     maxLength?: number;
     comment?: string;
@@ -45,7 +46,7 @@ export interface IPoolConnectionClient {
 export interface IRequestModel {
     method?: string;
     columns?: string | string[];
-    condition?: Record<string, any>;
+    condition?: IRequestCondition;
     data?: Record<string, any> | Record<string, any>[];
     orderBy?: string | IOrderByItem[];
     limit?: number;
@@ -54,21 +55,42 @@ export interface IRequestModel {
     pageNo?: number;
 }
 declare type IBasicType = boolean | string | number;
+/**
+ * 比较操作符条件
+ * 支持 MongoDB 风格的所有查询操作符
+ */
 export interface ICompareCondition {
-    $gt?: IBasicType;
-    $gte?: IBasicType;
+    $ne?: IBasicType;
     $lt?: IBasicType;
     $lte?: IBasicType;
-    $ne?: IBasicType;
-    $in?: IRequestCondition[];
-    $nin?: IRequestCondition[];
-    $like?: IBasicType;
-    $match?: IBasicType;
-    $matchBool?: IBasicType;
-    $range?: number[];
-}
-export interface IRequestCondition extends Record<string, any>, ICompareCondition {
+    $gt?: IBasicType;
+    $gte?: IBasicType;
+    $in?: IBasicType[];
+    $nin?: IBasicType[];
+    $range?: [number, number];
+    $like?: string;
+    $notLike?: string;
+    $likeInclude?: string;
+    $notLikeInclude?: string;
+    $match?: string;
+    $matchBool?: string | boolean;
+    $null?: boolean;
+    $notNull?: boolean;
+    $jsonArrayContains?: string;
+}
+/**
+ * 逻辑操作符条件
+ */
+export interface ILogicalCondition {
     $or?: IRequestCondition[];
+    $and?: IRequestCondition[];
+}
+/**
+ * 查询条件类型
+ * 支持字段值直接匹配或比较操作符
+ * 支持 $or, $and 逻辑组合
+ */
+export interface IRequestCondition extends Record<string, IBasicType | ICompareCondition | ILogicalCondition | IRequestCondition[] | undefined>, ILogicalCondition {
 }
 /**
  * 用户基本信息
@@ -139,6 +161,55 @@ export interface ISqlCfgModel extends IBaseCfgModel {
     executeSqlArgs?: any[];
     crudType?: string;
 }
+/**
+ * executeSQL 的返回结果类型说明（未被包装的直接结果）
+ *
+ * 注意：executeSQL 返回的是数据库查询的原始结果，没有 {code, data, message} 包装层。
+ * 返回类型取决于 resPicker 配置，请根据实际 SQL 类型选择合适的类型断言。
+ *
+ * 使用示例：
+ *   // 查询列表 - 返回数组
+ *   const rows = await executeSQL({ executeSql: 'SELECT * FROM users', resPicker: KeysOfSqlResPicker.RESULT_ROWS }) as ExecuteSQLRowResult<User>;
+ *
+ *   // 查询单行 - 返回对象或null
+ *   const user = await executeSQL({ executeSql: 'SELECT * FROM users WHERE id=?', executeSqlArgs: [1], resPicker: KeysOfSqlResPicker.RESULT_FIRST_ROW }) as ExecuteSQLSingleResult<User>;
+ *
+ *   // 查询总数 - 返回数字
+ *   const count = await executeSQL({ executeSql: 'SELECT COUNT(*) as total_count FROM users', resPicker: KeysOfSqlResPicker.RESULT_TOTAL_COUNT }) as ExecuteSQLCountResult;
+ *
+ *   // 判断存在 - 返回布尔
+ *   const exists = await executeSQL({ executeSql: 'SELECT 1 as is_exist FROM users WHERE id=?', executeSqlArgs: [1], resPicker: KeysOfSqlResPicker.RESULT_IS_EXIST }) as ExecuteSQLExistResult;
+ *
+ *   // 增删改操作 - 返回受影响行数信息
+ *   const result = await executeSQL({ executeSql: 'INSERT INTO users(name) VALUES(?)', executeSqlArgs: ['张三'], resPicker: KeysOfSqlResPicker.UPDATE_RESULT }) as ExecuteSQLUpdateResult;
+ */
+/** 查询多行时的返回类型（默认情况）：原始数据行数组，无包装 */
+export declare type ExecuteSQLRowsResult<T = Record<string, any>> = T[];
+/** 查询单行时的返回类型：首行对象或null，无包装 */
+export declare type ExecuteSQLSingleResult<T = Record<string, any>> = T | null;
+/** 查询数量时的返回类型：数字，无包装 */
+export declare type ExecuteSQLCountResult = number;
+/** 判断存在时的返回类型：布尔值，无包装 */
+export declare type ExecuteSQLExistResult = boolean;
+/** 增删改操作时的返回类型：包含 insertId 和 affectedRows，无包装 */
+export interface ExecuteSQLUpdateResult {
+    /** 插入记录的自增ID（仅INSERT操作有效） */
+    insertId: any;
+    /** 受影响的行数 */
+    affectedRows: number;
+}
+/**
+ * executeSQL 的通用返回类型（未被包装的直接结果）
+ * 根据 resPicker 的不同配置，实际返回类型可能是：
+ * - ExecuteSQLRowResult<T> : 多行数据（默认）
+ * - ExecuteSQLSingleResult<T> : 单行数据或null
+ * - ExecuteSQLCountResult : 数字
+ * - ExecuteSQLExistResult : 布尔值
+ * - ExecuteSQLUpdateResult : 增删改结果
+ *
+ * 警告：此类型为联合类型，使用时建议根据实际 resPicker 进行类型断言以获得精确类型提示
+ */
+export declare type ExecuteSQLResult<T = Record<string, any>> = ExecuteSQLRowsResult<T> | ExecuteSQLSingleResult<T> | ExecuteSQLCountResult | ExecuteSQLExistResult | ExecuteSQLUpdateResult;
 /**
  * 自定义校验函数。如果不正确请抛出异常。{code:'xxx',message:'xxx'}
  */

package/dist/libs/crud-pro/models/CrudResult.d.ts

@@ -0,0 +1,116 @@
+import { ResModelAffected } from './ResModel';
+import { ExecuteContext } from './ExecuteContext';
+/**
+ * 结果基类的辅助定位信息
+ * 用于错误排查和日志记录
+ */
+export interface CrudResultDebugInfo {
+    /** 数据库名 */
+    sqlDatabase?: string;
+    /** 表名 */
+    sqlTable?: string;
+    /** 方法名（配置中的 method 字段） */
+    method?: string;
+    /** 查询条件（用于定位问题） */
+    condition?: Record<string, any>;
+}
+/**
+ * 结果基类
+ *
+ * 使用 ES2022 私有字段 #rawContext 存储 ExecuteContext 引用。
+ * ES2022 私有字段特性：JSON.stringify 不会序列化 # 开头的私有字段。
+ * 因此结果对象可直接返回给 API 前端，自动过滤掉内部上下文。
+ *
+ * Node.js 兼容性：Node.js 14.6+ 完全支持 ES2022 私有字段。
+ */
+declare abstract class CrudResultBase {
+    #private;
+    /** 辅助定位信息，用于错误排查 */
+    readonly debugInfo: CrudResultDebugInfo;
+    constructor(rawContext: ExecuteContext, debugInfo?: CrudResultDebugInfo);
+    getRawContext(): ExecuteContext;
+    /**
+     * 生成带辅助定位信息的错误消息
+     * @param baseMessage 基础错误信息
+     * @returns 包含定位信息的完整错误消息
+     */
+    protected buildErrorMessage(baseMessage: string): string;
+}
+/** 写操作结果（INSERT/UPDATE/DELETE） */
+declare class CrudWriteResult extends CrudResultBase {
+    readonly affectedRows: number;
+    readonly insertId?: string | number;
+    constructor(data: {
+        affectedRows: number;
+        insertId?: string | number;
+        rawContext: ExecuteContext;
+        debugInfo?: CrudResultDebugInfo;
+    });
+}
+/** 单条查询结果 */
+declare class CrudQueryOneResult<T = Record<string, any>> extends CrudResultBase {
+    readonly row: T | null;
+    readonly found: boolean;
+    /** 数据来源的物理表名（分表场景下为实际分表名，如 t_order_202403） */
+    readonly fromTable: string;
+    constructor(data: {
+        row: T | null;
+        rawContext: ExecuteContext;
+        debugInfo?: CrudResultDebugInfo;
+        fromTable: string;
+    });
+}
+/** 列表查询结果 */
+declare class CrudQueryListResult<T = Record<string, any>> extends CrudResultBase {
+    readonly rows: T[];
+    readonly count: number;
+    constructor(data: {
+        rows: T[];
+        rawContext: ExecuteContext;
+        debugInfo?: CrudResultDebugInfo;
+    });
+}
+/** 分页查询结果 */
+declare class CrudQueryPageResult<T = Record<string, any>> extends CrudResultBase {
+    readonly rows: T[];
+    readonly totalCount: number;
+    readonly count: number;
+    constructor(data: {
+        rows: T[];
+        totalCount: number;
+        rawContext: ExecuteContext;
+        debugInfo?: CrudResultDebugInfo;
+    });
+}
+/** 存在性判断结果 */
+declare class CrudExistResult extends CrudResultBase {
+    readonly exists: boolean;
+    constructor(data: {
+        exists: boolean;
+        rawContext: ExecuteContext;
+        debugInfo?: CrudResultDebugInfo;
+    });
+}
+/** 计数结果 */
+declare class CrudCountResult extends CrudResultBase {
+    readonly count: number;
+    constructor(data: {
+        count: number;
+        rawContext: ExecuteContext;
+        debugInfo?: CrudResultDebugInfo;
+    });
+}
+/** InsertOrUpdate 结果 */
+declare class CrudUpsertResult extends CrudResultBase {
+    readonly insertAffected?: ResModelAffected;
+    readonly updateAffected?: ResModelAffected;
+    readonly isExist: boolean;
+    constructor(data: {
+        insertAffected?: ResModelAffected;
+        updateAffected?: ResModelAffected;
+        isExist: boolean;
+        rawContext: ExecuteContext;
+        debugInfo?: CrudResultDebugInfo;
+    });
+}
+export { CrudResultBase, CrudWriteResult, CrudQueryOneResult, CrudQueryListResult, CrudQueryPageResult, CrudExistResult, CrudCountResult, CrudUpsertResult, };

package/dist/libs/crud-pro/models/CrudResult.js

@@ -0,0 +1,126 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _CrudResultBase_rawContext;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudUpsertResult = exports.CrudCountResult = exports.CrudExistResult = exports.CrudQueryPageResult = exports.CrudQueryListResult = exports.CrudQueryOneResult = exports.CrudWriteResult = exports.CrudResultBase = void 0;
+/**
+ * 结果基类
+ *
+ * 使用 ES2022 私有字段 #rawContext 存储 ExecuteContext 引用。
+ * ES2022 私有字段特性：JSON.stringify 不会序列化 # 开头的私有字段。
+ * 因此结果对象可直接返回给 API 前端，自动过滤掉内部上下文。
+ *
+ * Node.js 兼容性：Node.js 14.6+ 完全支持 ES2022 私有字段。
+ */
+class CrudResultBase {
+    constructor(rawContext, debugInfo) {
+        _CrudResultBase_rawContext.set(this, void 0);
+        __classPrivateFieldSet(this, _CrudResultBase_rawContext, rawContext, "f");
+        this.debugInfo = debugInfo || {};
+    }
+    getRawContext() {
+        return __classPrivateFieldGet(this, _CrudResultBase_rawContext, "f");
+    }
+    /**
+     * 生成带辅助定位信息的错误消息
+     * @param baseMessage 基础错误信息
+     * @returns 包含定位信息的完整错误消息
+     */
+    buildErrorMessage(baseMessage) {
+        const parts = [baseMessage];
+        if (this.debugInfo.sqlDatabase) {
+            parts.push(`数据库: ${this.debugInfo.sqlDatabase}`);
+        }
+        if (this.debugInfo.sqlTable) {
+            parts.push(`表: ${this.debugInfo.sqlTable}`);
+        }
+        if (this.debugInfo.method) {
+            parts.push(`方法: ${this.debugInfo.method}`);
+        }
+        if (this.debugInfo.condition) {
+            try {
+                parts.push(`条件: ${JSON.stringify(this.debugInfo.condition)}`);
+            }
+            catch (_a) {
+                parts.push(`条件: [无法序列化]`);
+            }
+        }
+        return parts.join(' | ');
+    }
+}
+exports.CrudResultBase = CrudResultBase;
+_CrudResultBase_rawContext = new WeakMap();
+/** 写操作结果（INSERT/UPDATE/DELETE） */
+class CrudWriteResult extends CrudResultBase {
+    constructor(data) {
+        super(data.rawContext, data.debugInfo);
+        this.affectedRows = data.affectedRows;
+        this.insertId = data.insertId;
+    }
+}
+exports.CrudWriteResult = CrudWriteResult;
+/** 单条查询结果 */
+class CrudQueryOneResult extends CrudResultBase {
+    constructor(data) {
+        super(data.rawContext, data.debugInfo);
+        this.row = data.row;
+        this.found = (this.row !== null && this.row !== undefined);
+        this.fromTable = data.fromTable;
+    }
+}
+exports.CrudQueryOneResult = CrudQueryOneResult;
+/** 列表查询结果 */
+class CrudQueryListResult extends CrudResultBase {
+    constructor(data) {
+        super(data.rawContext, data.debugInfo);
+        this.rows = data.rows || [];
+        this.count = this.rows.length;
+    }
+}
+exports.CrudQueryListResult = CrudQueryListResult;
+/** 分页查询结果 */
+class CrudQueryPageResult extends CrudResultBase {
+    constructor(data) {
+        super(data.rawContext, data.debugInfo);
+        this.rows = data.rows || [];
+        this.totalCount = data.totalCount;
+        this.count = this.rows.length;
+    }
+}
+exports.CrudQueryPageResult = CrudQueryPageResult;
+/** 存在性判断结果 */
+class CrudExistResult extends CrudResultBase {
+    constructor(data) {
+        super(data.rawContext, data.debugInfo);
+        this.exists = data.exists;
+    }
+}
+exports.CrudExistResult = CrudExistResult;
+/** 计数结果 */
+class CrudCountResult extends CrudResultBase {
+    constructor(data) {
+        super(data.rawContext, data.debugInfo);
+        this.count = data.count;
+    }
+}
+exports.CrudCountResult = CrudCountResult;
+/** InsertOrUpdate 结果 */
+class CrudUpsertResult extends CrudResultBase {
+    constructor(data) {
+        super(data.rawContext, data.debugInfo);
+        this.insertAffected = data.insertAffected;
+        this.updateAffected = data.updateAffected;
+        this.isExist = data.isExist;
+    }
+}
+exports.CrudUpsertResult = CrudUpsertResult;

package/dist/libs/crud-pro/models/RequestModel.d.ts

@@ -1,9 +1,9 @@
-import { IOrderByItem, IRequestModel, IVisitor } from '../interfaces';
+import { IOrderByItem, IRequestModel, IVisitor, IRequestCondition } from '../interfaces';
 declare class RequestModel {
     visitor: IVisitor;
     method: string;
     columns?: string[];
-    condition?: Record<string, any>;
+    condition?: IRequestCondition;
     data?: Record<string, any> | Record<string, any>[];
     limit: number;
     offset: number;

package/dist/libs/crud-pro/models/ServiceHub.d.ts

@@ -17,5 +17,7 @@ export interface ICurdProServiceHub {
     convertOriginToExecuteSql(sqlCfgModel: SqlCfgModel): Promise<void>;
     executeFuncCfg(tmpFunCfg: IFuncCfgModel, exeFunCtx: FuncContext): string;
     getTableMeta(query: ITableMetaQuery): Promise<ITableMeta>;
+    getPrimaryKeyColumns(query: ITableMetaQuery): Promise<string[]>;
     convertDataTypeByTableMeta(reqModel: RequestModel, cfgModel: RequestCfgModel): Promise<void>;
+    convertConditionTypeByTableMeta(reqModel: RequestModel, cfgModel: RequestCfgModel): Promise<void>;
 }

package/dist/libs/crud-pro/services/CrudProDataTypeConvertService.d.ts

@@ -3,10 +3,11 @@ import { RequestModel } from '../models/RequestModel';
 import { RequestCfgModel } from '../models/RequestCfgModel';
 /**
  * 数据类型转换服务
- * 根据表结构字段类型，在 INSERT/UPDATE 操作前自动转换数据格式，确保数据与数据库方言兼容
+ * 根据表结构字段类型，自动转换数据格式，确保数据与数据库方言兼容，防止隐式类型转换导致索引失效
  *
  * 当前支持的转换：
- * - PostgreSQL ARRAY 类型：JSON 数组 → PG 数组字面量 {"a","b","c"}
+ * - PostgreSQL ARRAY 类型（INSERT/UPDATE data）：JSON 数组 → PG 数组字面量 {"a","b","c"}
+ * - 查询条件类型强转（SELECT/DELETE/UPDATE condition）：字符串 → 数字/布尔，防止隐式类型转换导致索引失效
  */
 declare class CrudProDataTypeConvertService extends CrudProServiceBase {
     /**
@@ -44,6 +45,73 @@ declare class CrudProDataTypeConvertService extends CrudProServiceBase {
      * 将单个 JS 值转为 PG 数组元素的字面量表示
      */
     private toPgArrayItem;
+    /**
+     * 查询时：根据表结构字段类型，自动转换 condition 中的数据格式
+     * 防止数据库隐式类型转换导致索引失效
+     *
+     * 实现步骤：
+     * 1. 判断操作类型是否为查询/删除/更新（这些操作包含 WHERE 条件）
+     * 2. 获取表元数据，构建字段名→类型映射
+     * 3. 递归遍历 condition（支持 $or/$and 嵌套），按字段类型转换值
+     *
+     * 转换规则（双向保护，仅处理最常建索引的列类型）：
+     * - 整数列(int/bigint/smallint/tinyint/mediumint) + 字符串值 → number
+     * - 整数列 + 布尔值 → 0/1
+     * - 字符串列(varchar/char/text等) + 数字值 → string
+     * - 字符串列 + 布尔值 → string
+     *
+     * @param reqModel 请求模型
+     * @param cfgModel 配置模型
+     */
+    convertConditionTypeByTableMeta(reqModel: RequestModel, cfgModel: RequestCfgModel): Promise<void>;
+    /**
+     * 递归遍历 condition，对每个字段值做类型转换
+     *
+     * 实现步骤：
+     * 1. 遍历 condition 的每个 key
+     * 2. 若 key 为 $or/$and 逻辑操作符，递归处理子条件数组
+     * 3. 若 key 为字段名且值为基本类型，直接转换
+     * 4. 若 key 为字段名且值为比较操作符对象($gt/$in等)，遍历操作符逐值转换
+     *
+     * @param condition 查询条件对象
+     * @param typeMap 字段名→类型映射
+     * @param sqlDbType 数据库类型
+     */
+    private convertConditionFields;
+    /**
+      * 根据字段类型转换单个值，防止隐式类型转换导致索引失效
+      *
+      * 转换规则（双向保护）：
+      * - 整数列 + 字符串值 → number（WHERE int_col = '123' 索引失效）
+      * - 整数列 + 布尔值 → 0/1
+      * - 字符串列 + 数字值 → string（WHERE varchar_col = 123 索引失效）
+      * - 字符串列 + 布尔值 → string
+      *
+      * @param value 原始值
+      * @param fieldType 字段类型（小写）
+      * @param sqlDbType 数据库类型
+      * @returns 转换后的值
+      */
+    private convertValueByType;
+    /**
+      * 判断字段类型是否为整数类型
+      * 覆盖 MySQL/PostgreSQL/SQL Server 三种数据库的整数类型名
+      */
+    private isIntegerType;
+    /**
+     * 判断字段类型是否为字符串类型
+     * 覆盖 MySQL/PostgreSQL/SQL Server 三种数据库的字符串类型名
+     */
+    private isStringType;
+    /**
+     * 判断 sqlSimpleName 是否为包含 WHERE 条件的操作类型（查询/删除/更新）
+     * 这些操作的 condition 会参与 WHERE 子句，索引失效问题同样存在
+     */
+    private isConditionType;
+    /**
+     * 判断值是否为基本类型（string | number | boolean）
+     */
+    private isBasicType;
     /**
      * 判断 sqlSimpleName 是否为 INSERT/UPDATE 类型
      */