midway-fatcms 0.0.1-beta.1

package/src/libs/crud-pro/sql.txt

@@ -0,0 +1,120 @@
+drop table sys_configs;
+create table sys_configs
+(
+	id bigint unsigned auto_increment primary key,
+	config_name varchar(256) not null comment '配置项的中文名',
+	config_code varchar(128) not null comment '配置项的唯一编码',
+	config_type varchar(64) not null comment '配置类型: json/xml/sheet/text',
+	config_content longtext not null comment '配置内容',
+
+	created_by varchar(128) null comment '创建人',
+	modified_by varchar(128) null comment '修改人',
+	created_at datetime default CURRENT_TIMESTAMP not null comment '创建时间',
+	modified_at datetime default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '修改时间',
+	status int default 0 not null comment '状态: 0 未启用， 1 已启用',
+
+	constraint code_idx unique (config_code)
+)
+charset=utf8;
+
+
+
+
+
+drop table sys_crud_methods;
+create table sys_crud_methods
+(
+	id bigint unsigned auto_increment comment '自增ID'
+		primary key,
+	method varchar(256) not null comment '方法名，全局唯一',
+	columns varchar(256) null comment '返回哪些列，为空就是返回所有列',
+	max_limit bigint default 20 null comment '最大一次性返回的数量',
+	sql_simple_name varchar(256) null comment '简单查询模式；SQL缩写名称',
+	sql_cfg_list text null comment '自定义查询模式查询模式；大JSON; ISqlCfgModel数组',
+	sql_table varchar(256) null comment '操作哪个表；可以为空, originSql中不包含@@table时可以为空',
+	sql_schema varchar(256) null comment '操作哪个数据库Schema；可以为空,',
+	sql_database varchar(256) null comment '操作哪个数据库；可以为空,用于运行时选择数据库链接',
+	transaction_enable bigint default 0 null comment '是否开启事务，默认不开启，每条语句都是autocommit',
+	transaction_isolation bigint default 1 null comment '事务隔离级别; 实际只能是(0,1,2,4,8)',
+	more_config longtext null comment '更多自定义配置；大JSON',
+
+	created_by varchar(128) null comment '创建人',
+	modified_by varchar(128) null comment '修改人',
+	created_at datetime default CURRENT_TIMESTAMP not null comment '创建时间',
+	modified_at datetime default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '修改时间',
+	status int default 0 not null comment '状态: 0 未启用， 1 已启用',
+
+	constraint method_idx unique (method)
+)
+comment 'CrudPro方法配置' charset=utf8;
+
+
+
+
+
+drop table sys_data_dict;
+create table sys_data_dict
+(
+	id bigint unsigned auto_increment
+		primary key,
+	dict_code varchar(128) not null comment '唯一编码，字母数字下划线点号',
+	dict_name varchar(256) not null comment '中文名称',
+	dict_desc varchar(512) null comment '中文描述',
+	dict_type bigint default 1 not null comment '1普通，2树状',
+	ext_info_desc longtext null comment '扩展字段描述信息',
+
+	created_by varchar(128) null comment '创建人',
+	modified_by varchar(128) null comment '修改人',
+	created_at datetime default CURRENT_TIMESTAMP not null comment '创建时间',
+	modified_at datetime default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '修改时间',
+	status int default 0 not null comment '状态: 0 未启用， 1 已启用',
+
+	constraint code_idx unique (dict_code)
+)
+comment '数据字典' charset=utf8;
+
+
+
+drop table sys_data_dict_item;
+create table sys_data_dict_item
+(
+	id bigint unsigned auto_increment comment '条目ID'
+		primary key,
+	parent_id bigint default 0 null comment '条目父ID',
+	dict_code varchar(128) default '0' not null comment '字典编码',
+
+	label varchar(256) not null comment '条目显示名称；如SexEnum 男，女',
+	value varchar(128) not null comment '条目值；如SexEnum 0，1',
+	code varchar(128) not null comment '条目代码；如SexEnum BOY，GIRL; 如果不需要，请将code的值设置成与value一样。',
+	icon varchar(256) null comment '条目图标: 图标URL',
+	style varchar(64) null comment '条目样式；样式枚举值：red，yellow，...',
+	sort bigint default 1 null comment '排序码',
+
+	ext1 varchar(128) null comment '扩展字段1',
+	ext2 varchar(128) null comment '扩展字段2',
+	ext3 varchar(128) null comment '扩展字段3',
+	ext4 varchar(128) null comment '扩展字段4',
+	ext5 varchar(128) null comment '扩展字段5',
+	ext6 varchar(128) null comment '扩展字段6',
+	ext7 varchar(128) null comment '扩展字段7',
+	ext8 varchar(128) null comment '扩展字段8',
+	ext9 varchar(128) null comment '扩展字段9',
+	ext10 varchar(128) null comment '扩展字段10',
+	ext_more longtext null comment '扩展字段大JSON',
+
+	created_by varchar(128) null comment '创建人',
+	modified_by varchar(128) null comment '修改人',
+	created_at datetime default CURRENT_TIMESTAMP not null comment '创建时间',
+	modified_at datetime default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '修改时间',
+	status int default 0 not null comment '状态: 0 未启用， 1 已启用',
+
+	constraint code_dict_code_uindex
+		unique (code, dict_code),
+	constraint code_dict_value_uindex
+		unique (value, dict_code)
+)
+comment '数据字典每一项; 如常见枚举类定义：class SexEnum { BOY(''男'', 1)，GIRL(''女'', 0)}' charset=utf8;
+
+create index code_idx
+	on sys_data_dict_item (dict_code);
+

package/src/libs/crud-pro/utils/CompareUtils.ts

@@ -0,0 +1,23 @@
+const CompareUtils = {
+  eq: (a: any, b: any) => {
+    // eslint-disable-next-line eqeqeq
+    return a == b; // 就是两个等号，兼容性比较。
+  },
+  ne: (a: any, b: any) => {
+    return !CompareUtils.eq(a, b);
+  },
+  gt: (a: any, b: any) => {
+    return a > b;
+  },
+  gte: (a: any, b: any) => {
+    return a >= b;
+  },
+  lt: (a: any, b: any) => {
+    return a < b;
+  },
+  lte: (a: any, b: any) => {
+    return a <= b;
+  },
+};
+
+export { CompareUtils };

package/src/libs/crud-pro/utils/DatabaseName.ts

@@ -0,0 +1,40 @@
+import { SqlDbType } from '../models/keys'
+
+interface IDbTypeAndName {
+  dbType: SqlDbType,
+  dbName: string;
+}
+
+const SPLIT_CONST = "_________"
+
+function parseDatabaseName(databaseName: string): IDbTypeAndName {
+  const dbNameArr = databaseName.split(SPLIT_CONST);
+  if (dbNameArr.length === 1) {
+    return {
+      dbType: SqlDbType.mysql, // 默认
+      dbName: dbNameArr[0]
+    }
+  }
+
+  if (dbNameArr.length > 1) {
+    const [dbType0, dbName] = dbNameArr;
+    const dbType = dbType0 as any;
+    return {
+      dbType,
+      dbName
+    }
+  }
+  return null;
+}
+
+
+function toDatabaseNameStr(dbType: SqlDbType, dbName: string): string {
+  return [dbType, dbName].join(SPLIT_CONST)
+}
+
+
+export {
+  SPLIT_CONST,
+  parseDatabaseName,
+  toDatabaseNameStr
+}

package/src/libs/crud-pro/utils/DateTimeUtils.ts

@@ -0,0 +1,20 @@
+import * as moment from 'moment';
+
+const DateTimeUtils = {
+  // 以毫秒为单位的时间戳
+  getCurrentTimeStampMs(): number {
+    return Date.now();
+  },
+  // 以秒为单位的时间戳
+  getCurrentTimeStampSecond(): number {
+    return Math.floor(Date.now() / 1000);
+  },
+  getCurrentDateFormat(format:string): string {
+    return moment(Date.now()).format(format);
+  },
+  getYesterdayDateFormat(format:string): string {
+    return moment(Date.now()).add(-1, 'day').format(format);
+  },
+};
+
+export { DateTimeUtils };

package/src/libs/crud-pro/utils/MemoryRefreshCache.ts

@@ -0,0 +1,64 @@
+import { MixinUtils } from './MixinUtils';
+
+interface MemoryCacheProps {
+  keepTime?: number;
+  requestFn: () => Promise<any[]>;
+  getKeyFn: (obj: any) => string;
+}
+
+const DEFAULT_KEEP_TIME = 1000 * 60; // 内存缓存时间默认 1分钟
+
+export default class MemoryRefreshCache {
+  private props: MemoryCacheProps;
+
+  private expireTime: number;
+  private loadingPromise: any;
+  private itemsMap: Record<string, any> = {};
+  private itemsList: any[] = [];
+
+  constructor(props?: MemoryCacheProps) {
+    this.props = props;
+    this.expireTime = 0;
+  }
+
+  setProps(props: MemoryCacheProps) {
+    this.props = props;
+  }
+
+  public async getItem(key: string): Promise<any> {
+    await this.makeSureCacheAvailable();
+    return this.itemsMap[key];
+  }
+
+  public async getList(): Promise<any> {
+    await this.makeSureCacheAvailable();
+    return this.itemsList;
+  }
+
+  private async makeSureCacheAvailable() {
+    if (this.expireTime < Date.now()) {
+      await this.refreshMemoryCache();
+    }
+  }
+
+  private async refreshMemoryCache() {
+    const keepTime = this.props.keepTime || DEFAULT_KEEP_TIME;
+    const getKeyFn = this.props.getKeyFn;
+    const requestFn = this.props.requestFn;
+
+    if (!this.loadingPromise) {
+      this.loadingPromise = new Promise(resolve => {
+        (async () => {
+          const itemsList = await requestFn();
+          this.itemsList = itemsList || [];
+          this.itemsMap = MixinUtils.toMap(itemsList, getKeyFn);
+
+          this.expireTime = Date.now() + keepTime;
+          this.loadingPromise = null;
+          resolve(true);
+        })();
+      });
+    }
+    return this.loadingPromise;
+  }
+}

package/src/libs/crud-pro/utils/MessageParseUtils.ts

@@ -0,0 +1,33 @@
+import { ExecuteContext } from '../models/ExecuteContext';
+import { KeysOfSimpleSQL } from '../models/keys';
+import * as _ from 'lodash';
+
+const messageParseUtils = {
+  getResMessage(ExecuteContext: ExecuteContext): string {
+    const cfgModel = ExecuteContext.getCfgModel();
+    const resModel = ExecuteContext.getResModel();
+    if (cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_QUERY) {
+      const rows = _.get(resModel, 'rows') || [];
+      return `成功查询到${rows.length}条数据`;
+    }
+    if (cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_QUERY_PAGE) {
+      const total_count = _.get(resModel, 'total_count') || 0;
+      return `成功查询到${total_count}条数据`;
+    }
+    if (cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_INSERT) {
+      const affectedRows = _.get(resModel, 'affected.affectedRows');
+      return `成功保存${affectedRows}条数据`;
+    }
+    if (cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_UPDATE) {
+      const affectedRows = _.get(resModel, 'affected.affectedRows');
+      return `成功修改${affectedRows}条数据`;
+    }
+    if (cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_DELETE) {
+      const affectedRows = _.get(resModel, 'affected.affectedRows');
+      return `成功删除${affectedRows}条数据`;
+    }
+    return null;
+  },
+};
+
+export { messageParseUtils };

package/src/libs/crud-pro/utils/MixinUtils.ts

@@ -0,0 +1,285 @@
+import { CommonException, Exceptions } from '../exceptions';
+
+const FIELD_NAME_REG_EXP = /^[a-zA-Z][0-9a-zA-Z_]+$/;
+
+const MixinUtils = {
+  isNil(obj: any): boolean {
+    return typeof obj === 'undefined' || obj === null;
+  },
+  isNotNil(obj: any): boolean {
+    return !MixinUtils.isNil(obj);
+  },
+  isEmpty(obj: any): boolean {
+    if (typeof obj === 'number') {
+      return false;
+    }
+
+    if (obj) {
+      if (typeof obj === 'string') {
+        const str = obj as string;
+        return str.length === 0;
+      }
+
+      if (Array.isArray(obj)) {
+        return obj.length === 0;
+      }
+
+      if (typeof obj === 'object') {
+        return Object.keys(obj).length === 0;
+      }
+    }
+
+    return !obj;
+  },
+
+  isNotEmpty(obj: any): boolean {
+    return !MixinUtils.isEmpty(obj);
+  },
+
+  equals(obj1: any, obj2: any): boolean {
+    return obj1 === obj2;
+  },
+
+  equalsIgnoreCase(str1: string, str2: string): boolean {
+    if (str1 && str2) {
+      const str1Upper = str1.toUpperCase();
+      const str2Upper = str2.toUpperCase();
+      return str1Upper === str2Upper;
+    }
+    return !str1 && !str2;
+  },
+
+  startsWith(str1: string, str2: string): boolean {
+    if (typeof str1 === "string" && typeof str2 === "string") {
+      return str1.startsWith(str2);
+    }
+    return false;
+  },
+
+  isValidFieldName(s: string): boolean {
+    if (MixinUtils.isEmpty(s)) {
+      return false;
+    }
+    return FIELD_NAME_REG_EXP.test(s);
+  },
+
+  isElementAllMatch(array: any, match: (e: any) => boolean): boolean {
+    for (let i = 0; i < array.length; i++) {
+      const e = array[i];
+      if (!match(e)) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  parseColumns(columns: string | string[]) {
+    return MixinUtils.parseStringArray(columns);
+  },
+
+  parseStringArray(columns: string | string[]): any[] {
+    if (!columns || columns === '*') {
+      return [];
+    }
+
+    if (typeof columns === 'string') {
+      const columnsTrim = columns.trim();
+      // JSON形式
+      if (columnsTrim.startsWith('[') && columnsTrim.endsWith(']')) {
+        return MixinUtils.parseJsonObject(columnsTrim);
+      }
+      //逗号形式
+      return columnsTrim.split(',').filter(s => {
+        return s.length > 0;
+      });
+    }
+
+    if (!Array.isArray(columns)) {
+      throw new CommonException(Exceptions.CFG_PARSE_ERROR, 'params must be an array or string');
+    }
+
+    return columns.filter(s => {
+      return !MixinUtils.isEmpty(s);
+    });
+  },
+
+  removeStringPrefix(str: string, prefix: string): string {
+    if (!str) {
+      return '';
+    }
+    if (str === prefix) {
+      return '';
+    }
+    if (str.startsWith(prefix)) {
+      return str.substring(prefix.length);
+    }
+    return str;
+  },
+  getErrorMessage(e: any) {
+    if (!e) {
+      return '';
+    }
+    const obj = {};
+    let fieldCount = 0;
+    const keys = ['code', 'message', 'errno', 'sql', 'sqlState', 'sqlMessage', 'stack'];
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const value = e[key];
+      if (value) {
+        obj[key] = value;
+        fieldCount++;
+      }
+    }
+
+    if (fieldCount > 0) {
+      return JSON.stringify(obj);
+    }
+
+    return '' + e;
+  },
+
+  parseJsonObject(str: any): any {
+    if (!str) {
+      return null;
+    }
+
+    if (typeof str === 'object' || Array.isArray(str)) {
+      return str;
+    }
+
+    if (typeof str === 'string') {
+      str = str.trim();
+      if (str.startsWith('{') || str.startsWith('[')) {
+        try {
+          return JSON.parse(str);
+        } catch (e) {
+          return null;
+        }
+      }
+    }
+
+    return null;
+  },
+
+  /**
+   * 将数组转换成Map方便查询
+   * @param list
+   * @param getKey
+   */
+  toMap<T>(list: T[], getKey: (e: T) => string): Record<string, T> {
+    const map = {};
+    if (list && list.length) {
+      for (let i = 0; i < list.length; i++) {
+        const e = list[i];
+        const key = getKey(e);
+        map[key] = e;
+      }
+    }
+    return map;
+  },
+
+  /**
+   * 将数组转换成Map方便查询
+   * @param list
+   * @param getKey
+   */
+  toNewMap<T>(list: T[], getKey: (e: T) => string): Map<string, T> {
+    const map = new Map();
+    if (list && list.length) {
+      for (let i = 0; i < list.length; i++) {
+        const e = list[i];
+        const key = getKey(e);
+        map.set(key, e);
+      }
+    }
+    return map;
+  },
+
+  deepTravelObject(obj: any, objTravelCallback: (value, key, index, keyPath) => void, keyPath: string) {
+    if (!obj || !objTravelCallback) {
+      return;
+    }
+
+    if (typeof obj === 'object') {
+      const keys = Object.keys(obj);
+
+      for (let i = 0; i < keys.length; i++) {
+        const objKey = keys[i];
+        const keyStr = objKey;
+        const value = obj[objKey];
+        const curKeyPath = keyPath + '.' + keyStr;
+        objTravelCallback(value, keyStr, null, curKeyPath);
+        MixinUtils.deepTravelObject(value, objTravelCallback, curKeyPath);
+      }
+    }
+
+    if (Array.isArray(obj)) {
+      const collection = obj;
+      for (let i = 0; i < collection.length; i++) {
+        const value = collection[i];
+        const curKeyPath = keyPath + '[' + i + ']';
+        objTravelCallback(value, null, i, curKeyPath);
+        MixinUtils.deepTravelObject(value, objTravelCallback, curKeyPath);
+      }
+    }
+  },
+  removeEmptyAttrs(obj: any): any {
+    const result = {};
+    const keys = Object.keys(obj);
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const value = obj[key];
+      if (MixinUtils.isNotNil(value)) {
+        result[key] = value;
+      }
+    }
+    return result;
+  },
+
+  /**
+   * 判断集合A中，是否包含任意一个集合B中的元素
+   * @param a
+   * @param b
+   */
+  hasAny(a: string[], b: string[]): boolean {
+    const aSet = new Set(a);
+    for (let i = 0; i < b.length; i++) {
+      const bElement = b[i];
+      if (aSet.has(bElement)) {
+        return true;
+      }
+    }
+    return false;
+  },
+
+  selectNotEmpty(a: any, b: any): any {
+    if (MixinUtils.isNotEmpty(a)) {
+      return a;
+    }
+    return b;
+  },
+
+  parseValueByType(value: any, targetType: string): any {
+    if (value === undefined || value === null) {
+      return value;
+    }
+    if (targetType === 'string') {
+      return '' + value;
+    }
+    if (targetType === 'number') {
+      return Number(value);
+    }
+    if (targetType === 'boolean') {
+      return value === 1 || value === true || value === 'true';
+    }
+    if (targetType === 'array') {
+      return MixinUtils.parseStringArray(value);
+    }
+    if (targetType === 'JSONObject') {
+      return MixinUtils.parseJsonObject(value);
+    }
+    return value;
+  },
+};
+
+export { MixinUtils };

package/src/libs/crud-pro/utils/ModelUtils.ts

@@ -0,0 +1,55 @@
+import { SqlCfgModel } from '../models/SqlCfgModel';
+import { RequestCfgModel } from '../models/RequestCfgModel';
+import { MixinUtils } from './MixinUtils';
+import { IFuncCfgModel } from '../interfaces';
+import { DEFAULT_MAX_LIMIT } from '../defaultConfigs';
+
+const ModelUtils = {
+  getColumnList(sqlCfg: SqlCfgModel, reqCfg: RequestCfgModel): string[] {
+    const sqlCfgColumnList = sqlCfg.columns;
+    if (MixinUtils.isNotEmpty(sqlCfgColumnList)) {
+      return sqlCfgColumnList;
+    }
+    return reqCfg.columns;
+  },
+
+  getSqlTable(sqlCfg: SqlCfgModel, reqCfg: RequestCfgModel): string {
+    const s = sqlCfg.sqlTable;
+    if (MixinUtils.isNotEmpty(s)) {
+      return s;
+    }
+    return reqCfg.sqlTable;
+  },
+
+  getSqlSchema(sqlCfg: SqlCfgModel, reqCfg: RequestCfgModel): string {
+    const s = sqlCfg.sqlSchema;
+    if (MixinUtils.isNotEmpty(s)) {
+      return s;
+    }
+    return reqCfg.sqlSchema;
+  },
+
+  getMaxLimit(sqlCfg: SqlCfgModel, requestCfg: RequestCfgModel): number {
+    let s = sqlCfg.maxLimit;
+    if (typeof s === 'number' && s > 0) {
+      return s;
+    }
+    s = requestCfg.maxLimit;
+
+    if (typeof s === 'number' && s > 0) return s;
+
+    return DEFAULT_MAX_LIMIT;
+  },
+  checkFuncCfgValid(cfgModel: IFuncCfgModel): boolean {
+    const arr = [cfgModel.functionName, cfgModel.const, cfgModel.constString, cfgModel.constNumber, cfgModel.constBool, cfgModel.context, cfgModel.contextAsString, cfgModel.contextAsNumber, cfgModel.contextAsBool];
+    for (let i = 0; i < arr.length; i++) {
+      const arrElement = arr[i];
+      if (typeof arrElement !== 'undefined') {
+        return true;
+      }
+    }
+    return false;
+  },
+};
+
+export { ModelUtils };