midway-fatcms 0.0.1-beta.7 → 0.0.1-beta.71

package/src/libs/crud-pro/interfaces.ts

@@ -1,183 +1,194 @@
-// import { Pool as MysqlPool } from 'mysql2/promise';
-// import { Pool as PostgresPool } from 'pg';
-import {KeysOfAuthType, KeysOfSimpleSQL, KeysOfValidators, SqlDbType} from './models/keys';
-
-export interface ICrudProCfg {
-  sysDatabaseName?: string; // 默认系统数据库名称，默认 fatcms
-  methodsTableName?: string; // 方法配置的表名，默认 sys_crud_methods
-  methodsCacheTime?: number; //内存缓存时间默认 1分钟
-  dictItemTableName?: string; // 字典项表名称，默认：sys_data_dict_item
-  sysConfigTableName?: string; // 字典项表名称，默认：sys_configs
-  tableMetaCacheTime?: number; // 表格元信息缓存时间
-}
-
-export interface ITableMeta {
-  expiredTime: number; // 过期时间
-  tableColumns: string[]; // 表格所有字段
-}
-
-export interface IConnectionPool {
-  dbType: SqlDbType;
-  poolName: string;
-  poolInstance: any; //MysqlPool | PostgresPool;
-}
-
-export interface IPoolConnectionClient {
-  query: (sql: string, values: any[]) => Promise<any[]>;
-}
-
-/**
- * 用户请求
- */
-export interface IRequestModel {
-  method?: string;
-  columns?: string | string[]; // "columns": "id,name,age,sex,addr",
-  condition?: Record<string, any>; // 拼接查询条件
-  data?: Record<string, any>; //拼接update/insert语句的数据部分
-  orderBy?: string | IOrderByItem[];
-  limit?: number;
-  offset?: number;
-  pageSize?: number;
-  pageNo?: number;
-}
-
-type IBasicType = boolean | string | number;
-
-export interface ICompareCondition {
-  $gt?: IBasicType;
-  $gte?: 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 {
-  $or?: IRequestCondition[];
-}
-
-/**
- * 用户基本信息
- */
-export interface IVisitor {
-  isLogin: boolean;
-  isSuperAdmin: boolean;
-  accountId: string;
-  nickName: string;
-  roleCodes: string[];
-  functionCodes: string[];
-}
-
-/**
- * 系统只支持Dict和SysConfigEnum两种
- * 实际配置时，可以配置其他的枚举值，但系统不处理，用户需要在自己的crudConfigFactory.afterExecuteSQLList进行处理
- */
-export enum BasicRecordEnum {
-  dict = 'dict', // 关联数据字典
-  sysCfgEnum = 'sysCfgEnum', // 配置文件中，必须包含code一列，作为唯一键。
-}
-
-export interface CopyAttr {
-  from: string;
-  to: string;
-}
-
-export interface ColumnRelation {
-  relatedType: any; // 如： dict
-  relatedCode?: string; // SexEnum
-  sourceColumn: string; // 从row中取值的字段名
-  targetColumns?: CopyAttr[]; //[{from:'label', to:'user_sex_text'}]
-}
-
-/**
- * 基本响应配置
- */
-export interface IBaseCfgModel {
-  sqlTable?: string; // 可以为空. originSql中不包含@@table时可以为空
-  sqlSchema?: string; // 可以为空
-  sqlDatabase?: string; // 可以为空，用此字段进行connection的选择和切换。配合getBizConnectionPool使用
-  sqlDdType?: SqlDbType; // 数据库类型，mysql(默认) 、postgres
-  maxLimit?: number; // 最大一次性返回的数量
-  columns?: string | string[]; // "columns": "id,name,age,sex,addr",
-  columnsRelation?: ColumnRelation[];
-}
-
-export type IFunctionParam = IFuncCfgModel | string | number | boolean | null;
-export interface IFuncCfgModel extends Record<any, any> {
-  ___PLAIN_OBJECT___?: boolean; // 本身就是一个对象
-  functionName?: string; // 函数名
-  functionParams?: IFunctionParam[]; // 函数参数
-
-  const?: any; // 常量,任意类型。可以是json对象
-  constString?: any; // 常量字符串
-  constNumber?: number; // 常量数字，任意形式, int,bigDecimal,bigInteger，字符串，等。
-  constBool?: boolean; // 常量bool值。与js的判断逻辑一致，false, null, 0 , "" 被认为是 false，其他认为是true
-
-  context?: string; // 从context中取值
-  contextAsString?: string; // 从context中取值
-  contextAsNumber?: string; // 从context中取值
-  contextAsBool?: string; // 从context中取值
-
-  message?: string; // 在校验阶段有用，其他阶段没有用
-}
-
-export interface ISqlCfgModel extends IBaseCfgModel {
-  resName?: string;
-  resPicker?: string;
-  originSql?: string; // 有特殊占位符的SQL, 原始的SQL
-  validate?: IFuncCfgModel; //执行前，进行校验，校验不通过就抛出异常. 校验函数可以返回 boolean或直接抛出异常
-  executeWhen?: IFuncCfgModel; //满足表达式的结果，才能执行。 默认：true 校验函数必须返回 boolean
-  executeSql?: string; // 可以运行的SQL
-  executeSqlArgs?: any[]; //可以运行的SQL的参数
-  crudType?: string;
-}
-
-/**
- * 自定义校验函数。如果不正确请抛出异常。{code:'xxx',message:'xxx'}
- */
-export type ICustomValidateFunc = (value: string) => void;
-
-/**
- * validateCfg中允许的配置
- */
-export type IValidatorCfgItem = IFuncCfgModel | KeysOfValidators | string | ICustomValidateFunc;
-
-/**
- * 接口响应配置
- */
-export interface IRequestCfgModel extends IBaseCfgModel {
-  method?: string; // 不能为空
-  transactionEnable?: boolean; // 是否开启事务，默认不开启，每条语句都是autocommit
-  transactionIsolation?: number; // 事务隔离级别
-  sqlSimpleName?: KeysOfSimpleSQL; // 二选一 sqlSimpleName  sqlCfgList；； sqlCfgList 优先级高于sqlSimpleName
-  sqlCfgList?: ISqlCfgModel[]; // 二选一 sqlSimpleName  sqlCfgList；； sqlCfgList 优先级高于sqlSimpleName
-  updateCfg?: Record<string, IFuncCfgModel>;
-  allowCfg?: Record<string, string[]>;
-  rejectCfg?: Record<string, string[]>;
-  validateCfg?: Record<string, IValidatorCfgItem[]>;
-  authType?: KeysOfAuthType;
-  authConfig?: string | string[];
-}
-
-export interface IOrderByItem {
-  fieldName: string;
-  orderType: string;
-}
-
-export interface ILimitOffset {
-  limit: number;
-  offset: number;
-}
-
-export interface ILogger {
-  info(msg: any, ...args: any[]): void;
-  debug(msg: any, ...args: any[]): void;
-  error(msg: any, ...args: any[]): void;
-  warn(msg: any, ...args: any[]): void;
-}
+// import { Pool as MysqlPool } from 'mysql2/promise';
+// import { Pool as PostgresPool } from 'pg';
+import { KeysOfAuthType, KeysOfSimpleSQL, KeysOfValidators, SqlDbType } from './models/keys';
+
+export interface ICrudProCfg {
+  sysDatabaseName?: string; // 默认系统数据库名称，默认 fatcms
+  sysDatabaseDbType?: SqlDbType; // 默认系统数据库名称，默认 mysql
+  methodsTableName?: string; // 方法配置的表名，默认 sys_crud_methods
+  methodsCacheTime?: number; //内存缓存时间默认 1分钟
+  dictItemTableName?: string; // 字典项表名称，默认：sys_data_dict_item
+  sysConfigTableName?: string; // 字典项表名称，默认：sys_configs
+  tableMetaCacheTime?: number; // 表格元信息缓存时间
+}
+
+export interface ITableMeta {
+  expiredTime: number; // 过期时间
+  tableColumns: string[]; // 表格所有字段
+}
+
+export interface IConnectionPool {
+  dbType: SqlDbType;
+  poolName: string;
+  poolInstance: any; //MysqlPool | PostgresPool;
+}
+
+export interface IPoolConnectionClient {
+  query: (sql: string, values: any[]) => Promise<any[]>;
+}
+
+/**
+ * 用户请求
+ */
+export interface IRequestModel {
+  method?: string;
+  columns?: string | string[]; // "columns": "id,name,age,sex,addr",
+  condition?: Record<string, any>; // 拼接查询条件
+  data?: Record<string, any>; //拼接update/insert语句的数据部分
+  orderBy?: string | IOrderByItem[];
+  limit?: number;
+  offset?: number;
+  pageSize?: number;
+  pageNo?: number;
+}
+
+type IBasicType = boolean | string | number;
+
+export interface ICompareCondition {
+  $gt?: IBasicType;
+  $gte?: 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 {
+  $or?: IRequestCondition[];
+}
+
+/**
+ * 用户基本信息
+ */
+export interface IVisitor {
+  isLogin: boolean;
+  isSuperAdmin: boolean;
+  accountId: string;
+  nickName: string;
+  roleCodes: string[];
+  functionCodes: string[];
+}
+
+/**
+ * 系统只支持Dict和SysConfigEnum两种
+ * 实际配置时，可以配置其他的枚举值，但系统不处理，用户需要在自己的crudConfigFactory.afterExecuteSQLList进行处理
+ */
+export enum BasicRecordEnum {
+  dict = 'dict', // 关联数据字典
+  sysCfgEnum = 'sysCfgEnum', // 配置文件中，必须包含code一列，作为唯一键。
+}
+
+export interface CopyAttr {
+  from: string;
+  to: string;
+}
+
+export interface ColumnRelation {
+  relatedType: any; // 如： dict
+  relatedCode?: string; // SexEnum
+  sourceColumn: string; // 从row中取值的字段名
+  targetColumns?: CopyAttr[]; //[{from:'label', to:'user_sex_text'}]
+}
+
+/**
+ * 基本响应配置
+ */
+export interface IBaseCfgModel {
+  sqlTable?: string; // 可以为空. originSql中不包含@@table时可以为空
+  sqlSchema?: string; // 可以为空
+  sqlDatabase?: string; // 可以为空，用此字段进行connection的选择和切换。配合getBizConnectionPool使用
+  sqlDbType?: SqlDbType; // 数据库类型，mysql(默认) 、postgres
+  maxLimit?: number; // 最大一次性返回的数量
+  columns?: string | string[]; // "columns": "id,name,age,sex,addr",
+  columnsRelation?: ColumnRelation[];
+}
+
+export type IFunctionParam = IFuncCfgModel | string | number | boolean | null;
+export interface IFuncCfgModel extends Record<any, any> {
+  ___PLAIN_OBJECT___?: boolean; // 本身就是一个对象
+  functionName?: string; // 函数名
+  functionParams?: IFunctionParam[]; // 函数参数
+
+  const?: any; // 常量,任意类型。可以是json对象
+  constString?: any; // 常量字符串
+  constNumber?: number; // 常量数字，任意形式, int,bigDecimal,bigInteger，字符串，等。
+  constBool?: boolean; // 常量bool值。与js的判断逻辑一致，false, null, 0 , "" 被认为是 false，其他认为是true
+
+  context?: string; // 从context中取值
+  contextAsString?: string; // 从context中取值
+  contextAsNumber?: string; // 从context中取值
+  contextAsBool?: string; // 从context中取值
+
+  executeExpressReturnObject?: string; // 执行表达式，返回对象。可以包含context中的变量。
+  executeExpressReturnString?: string; // 执行表达式，返回字符串。可以包含context中的变量。
+
+  message?: string; // 在校验阶段有用，其他阶段没有用
+}
+
+export interface ISqlCfgModel extends IBaseCfgModel {
+  resName?: string;
+  resPicker?: string;
+  originSql?: string; // 有特殊占位符的SQL, 原始的SQL
+  validate?: IFuncCfgModel; //执行前，进行校验，校验不通过就抛出异常. 校验函数可以返回 boolean或直接抛出异常
+  executeWhen?: IFuncCfgModel; //满足表达式的结果，才能执行。 默认：true 校验函数必须返回 boolean
+  isNativeSQL?: boolean; // 可以运行的SQL。在postgres/sqlserver环境下也可以使用问号。
+  executeSql?: string; // 可以运行的SQL。在postgres/sqlserver环境下也可以使用问号。
+  executeSqlArgs?: any[]; //可以运行的SQL的参数
+  crudType?: string;
+}
+
+/**
+ * 自定义校验函数。如果不正确请抛出异常。{code:'xxx',message:'xxx'}
+ */
+export type ICustomValidateFunc = (value: string) => void;
+
+/**
+ * validateCfg中允许的配置
+ */
+export type IValidatorCfgItem = IFuncCfgModel | KeysOfValidators | string | ICustomValidateFunc;
+
+/**
+ * 接口响应配置
+ */
+export interface IRequestCfgModel extends IBaseCfgModel {
+  method?: string; // 不能为空
+  transactionEnable?: boolean; // 是否开启事务，默认不开启，每条语句都是autocommit
+  transactionIsolation?: number; // 事务隔离级别
+  sqlSimpleName?: KeysOfSimpleSQL; // 二选一 sqlSimpleName  sqlCfgList；； sqlCfgList 优先级高于sqlSimpleName
+  sqlCfgList?: ISqlCfgModel[]; // 二选一 sqlSimpleName  sqlCfgList；； sqlCfgList 优先级高于sqlSimpleName
+  updateCfg?: Record<string, IFuncCfgModel>;
+  allowCfg?: Record<string, string[]>;
+  rejectCfg?: Record<string, string[]>;
+  validateCfg?: Record<string, IValidatorCfgItem[]>;
+  authType?: KeysOfAuthType;
+  authConfig?: string | string[];
+}
+
+export interface IOrderByItem {
+  fieldName: string;
+  orderType: string;
+}
+
+export interface ILimitOffset {
+  limit: number;
+  offset: number;
+}
+
+export interface ILogger {
+  info(msg: any, ...args: any[]): void;
+  debug(msg: any, ...args: any[]): void;
+  error(msg: any, ...args: any[]): void;
+  warn(msg: any, ...args: any[]): void;
+}
+
+export interface IExecuteUnsafeQueryCtx {
+  sqlTable: string;
+  sqlDatabase: string;
+  sqlDbType: SqlDbType;
+}

package/src/libs/crud-pro/models/ExecuteContext.ts

@@ -1,111 +1,129 @@
-import * as _ from 'lodash';
-import { RequestModel } from './RequestModel';
-import { RequestCfgModel } from './RequestCfgModel';
-import { SqlCfgModel } from './SqlCfgModel';
-import { messageParseUtils } from '../utils/MessageParseUtils';
-import { Transaction } from './Transaction';
-import { ICrudProCfg, ILogger, IVisitor } from '../interfaces';
-import { IExecuteContextFunc } from './ExecuteContextFunc';
-import { defaultCrudProCfg } from '../defaultConfigs';
-
-
-class ExecuteContext {
-  // 运行前设置的
-  private transaction: Transaction;
-  private logger: ILogger;
-  private visitor: IVisitor;
-  private contextCfg: ICrudProCfg = defaultCrudProCfg;
-  public contextFunc: IExecuteContextFunc;
-
-  // 运行时设置的。
-  private sqlCfgModels: SqlCfgModel[] = [];
-  private reqModel: RequestModel = null;
-  private resModel: Record<string, any> = {};
-  private cfgModel: RequestCfgModel = null;
-
-  setTransaction(transaction: Transaction) {
-    this.transaction = transaction;
-  }
-  getTransaction(): Transaction {
-    return this.transaction;
-  }
-
-  setContextCfg(contextCfg: ICrudProCfg) {
-    if (typeof contextCfg === 'object') {
-      Object.assign(this.contextCfg, contextCfg);
-    }
-  }
-
-  getContextCfg(): ICrudProCfg {
-    return this.contextCfg;
-  }
-
-  setLogger(logger: ILogger) {
-    this.logger = logger;
-  }
-  getLogger(): ILogger {
-    return this.logger;
-  }
-
-  setVisitor(visitor: IVisitor) {
-    this.visitor = visitor;
-  }
-  getVisitor(): IVisitor {
-    return this.visitor;
-  }
-
-  getReqModel(): RequestModel {
-    return this.reqModel;
-  }
-
-  setReqModel(reqModel: RequestModel) {
-    this.reqModel = reqModel;
-  }
-
-  getResModel(): Record<string, any> {
-    return this.resModel;
-  }
-
-  getOneObj() {
-    return this.resModel['row'];
-  }
-
-  getResRows(): any[] {
-    return this.resModel['rows'];
-  }
-
-  setResModelItem(resName: string, data: any) {
-    this.resModel[resName] = data;
-  }
-
-  getResModelItem(resName: string): any {
-    return this.resModel[resName];
-  }
-
-  getResModelItemLodash(resName: string): any {
-    return _.get(this.resModel, resName);
-  }
-
-  setCfgModel(cfgModel: RequestCfgModel) {
-    this.cfgModel = cfgModel;
-  }
-
-  getCfgModel(): RequestCfgModel {
-    return this.cfgModel;
-  }
-
-  getSqlCfgModels(): SqlCfgModel[] {
-    return this.sqlCfgModels;
-  }
-
-  getResMessage(): string {
-    return messageParseUtils.getResMessage(this);
-  }
-}
-
-interface IExecuteContextHandler {
-  handleExecuteContextPrepare(executeContext: ExecuteContext): Promise<void>;
-  handleExecuteContext(executeContext: ExecuteContext): Promise<void>;
-}
-
-export { ExecuteContext, IExecuteContextHandler };
+import * as _ from 'lodash';
+import { RequestModel } from './RequestModel';
+import { RequestCfgModel } from './RequestCfgModel';
+import { SqlCfgModel } from './SqlCfgModel';
+import { messageParseUtils } from '../utils/MessageParseUtils';
+import { Transaction } from './Transaction';
+import { ColumnRelation, ICrudProCfg, ILogger, IVisitor } from '../interfaces';
+import { IExecuteContextFunc } from './ExecuteContextFunc';
+import { defaultCrudProCfg } from '../defaultConfigs';
+import {ResModelFlexible, ResModelPageQuery} from './ResModel';
+
+class ExecuteContext {
+  // 运行前设置的
+  private transaction: Transaction;
+  private logger: ILogger;
+  private visitor: IVisitor;
+  private contextCfg: ICrudProCfg = defaultCrudProCfg;
+  public contextFunc: IExecuteContextFunc;
+
+  // 运行时设置的。
+  private sqlCfgModels: SqlCfgModel[] = [];
+  private reqModel: RequestModel = null;
+  private resModel: ResModelFlexible = {};
+  private cfgModel: RequestCfgModel = null;
+
+  setTransaction(transaction: Transaction) {
+    this.transaction = transaction;
+  }
+  getTransaction(): Transaction {
+    return this.transaction;
+  }
+
+  setContextCfg(contextCfg: ICrudProCfg) {
+    if (typeof contextCfg === 'object') {
+      Object.assign(this.contextCfg, contextCfg);
+    }
+  }
+
+  getContextCfg(): ICrudProCfg {
+    return this.contextCfg;
+  }
+
+  setLogger(logger: ILogger) {
+    this.logger = logger;
+  }
+  getLogger(): ILogger {
+    return this.logger;
+  }
+
+  setVisitor(visitor: IVisitor) {
+    this.visitor = visitor;
+  }
+  getVisitor(): IVisitor {
+    return this.visitor;
+  }
+
+  getReqModel(): RequestModel {
+    return this.reqModel;
+  }
+
+  setReqModel(reqModel: RequestModel) {
+    this.reqModel = reqModel;
+  }
+
+  getResModel(): ResModelFlexible {
+    return this.resModel;
+  }
+
+  getOneObj() {
+    return this.resModel['row'];
+  }
+
+  getResRows(): any[] {
+    return this.resModel['rows'];
+  }
+
+  setResModelItem(resName: string, data: any) {
+    this.resModel[resName] = data;
+  }
+
+  getResModelItem(resName: string): any {
+    return this.resModel[resName];
+  }
+
+  getResModelForQueryPage(): ResModelPageQuery {
+    const rows =  this.resModel['rows'];
+    const total_count =  this.resModel['total_count'];
+    return {
+      rows: rows || [],
+      total_count: total_count || 0
+    }
+  }
+
+  getResModelItemLodash(resName: string): any {
+    return _.get(this.resModel, resName);
+  }
+
+  setCfgModel(cfgModel: RequestCfgModel) {
+    this.cfgModel = cfgModel;
+  }
+
+  getCfgModel(): RequestCfgModel {
+    return this.cfgModel;
+  }
+
+  getSqlCfgModels(): SqlCfgModel[] {
+    return this.sqlCfgModels;
+  }
+
+  getResMessage(): string {
+    return messageParseUtils.getResMessage(this);
+  }
+}
+
+interface IExecuteContextCustom {
+  rows: any[];
+  columnsRelation?: ColumnRelation[];
+  isCustomContext?: boolean;
+}
+
+type HandleExecuteContextType = ExecuteContext | IExecuteContextCustom;
+// type HandleExecuteContextType = IExecuteContextCustom
+
+interface IExecuteContextHandler {
+  handleExecuteContextPrepare(executeContext: HandleExecuteContextType): Promise<void>;
+  handleExecuteContext(executeContext: HandleExecuteContextType): Promise<void>;
+}
+
+export { ExecuteContext, IExecuteContextHandler, HandleExecuteContextType, IExecuteContextCustom };