midway-fatcms 0.0.1-beta.1

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

@@ -0,0 +1,157 @@
+import { KeysOfAuthType, KeysOfSimpleSQL, KeysOfValidators, SqlDbType } from './models/keys';
+export interface ICrudProCfg {
+    sysDatabaseName?: string;
+    methodsTableName?: string;
+    methodsCacheTime?: number;
+    dictItemTableName?: string;
+    sysConfigTableName?: string;
+    tableMetaCacheTime?: number;
+}
+export interface ITableMeta {
+    expiredTime: number;
+    tableColumns: string[];
+}
+export interface IConnectionPool {
+    dbType: SqlDbType;
+    poolName: string;
+    poolInstance: any;
+}
+export interface IPoolConnectionClient {
+    query: (sql: string, values: any[]) => Promise<any[]>;
+}
+/**
+ * 用户请求
+ */
+export interface IRequestModel {
+    method?: string;
+    columns?: string | string[];
+    condition?: Record<string, any>;
+    data?: Record<string, any>;
+    orderBy?: string | IOrderByItem[];
+    limit?: number;
+    offset?: number;
+    pageSize?: number;
+    pageNo?: number;
+}
+declare 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 declare enum BasicRecordEnum {
+    dict = "dict",
+    sysCfgEnum = "sysCfgEnum"
+}
+export interface CopyAttr {
+    from: string;
+    to: string;
+}
+export interface ColumnRelation {
+    relatedType: any;
+    relatedCode?: string;
+    sourceColumn: string;
+    targetColumns?: CopyAttr[];
+}
+/**
+ * 基本响应配置
+ */
+export interface IBaseCfgModel {
+    sqlTable?: string;
+    sqlSchema?: string;
+    sqlDatabase?: string;
+    sqlDdType?: SqlDbType;
+    maxLimit?: number;
+    columns?: string | string[];
+    columnsRelation?: ColumnRelation[];
+}
+export declare type IFunctionParam = IFuncCfgModel | string | number | boolean | null;
+export interface IFuncCfgModel extends Record<any, any> {
+    ___PLAIN_OBJECT___?: boolean;
+    functionName?: string;
+    functionParams?: IFunctionParam[];
+    const?: any;
+    constString?: any;
+    constNumber?: number;
+    constBool?: boolean;
+    context?: string;
+    contextAsString?: string;
+    contextAsNumber?: string;
+    contextAsBool?: string;
+    message?: string;
+}
+export interface ISqlCfgModel extends IBaseCfgModel {
+    resName?: string;
+    resPicker?: string;
+    originSql?: string;
+    validate?: IFuncCfgModel;
+    executeWhen?: IFuncCfgModel;
+    executeSql?: string;
+    executeSqlArgs?: any[];
+    crudType?: string;
+}
+/**
+ * 自定义校验函数。如果不正确请抛出异常。{code:'xxx',message:'xxx'}
+ */
+export declare type ICustomValidateFunc = (value: string) => void;
+/**
+ * validateCfg中允许的配置
+ */
+export declare type IValidatorCfgItem = IFuncCfgModel | KeysOfValidators | string | ICustomValidateFunc;
+/**
+ * 接口响应配置
+ */
+export interface IRequestCfgModel extends IBaseCfgModel {
+    method?: string;
+    transactionEnable?: boolean;
+    transactionIsolation?: number;
+    sqlSimpleName?: KeysOfSimpleSQL;
+    sqlCfgList?: ISqlCfgModel[];
+    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 {};

package/dist/libs/crud-pro/interfaces.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicRecordEnum = void 0;
+/**
+ * 系统只支持Dict和SysConfigEnum两种
+ * 实际配置时，可以配置其他的枚举值，但系统不处理，用户需要在自己的crudConfigFactory.afterExecuteSQLList进行处理
+ */
+var BasicRecordEnum;
+(function (BasicRecordEnum) {
+    BasicRecordEnum["dict"] = "dict";
+    BasicRecordEnum["sysCfgEnum"] = "sysCfgEnum";
+})(BasicRecordEnum = exports.BasicRecordEnum || (exports.BasicRecordEnum = {}));

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

@@ -0,0 +1,42 @@
+import { RequestModel } from './RequestModel';
+import { RequestCfgModel } from './RequestCfgModel';
+import { SqlCfgModel } from './SqlCfgModel';
+import { Transaction } from './Transaction';
+import { ICrudProCfg, ILogger, IVisitor } from '../interfaces';
+import { IExecuteContextFunc } from './ExecuteContextFunc';
+declare class ExecuteContext {
+    private transaction;
+    private logger;
+    private visitor;
+    private contextCfg;
+    contextFunc: IExecuteContextFunc;
+    private sqlCfgModels;
+    private reqModel;
+    private resModel;
+    private cfgModel;
+    setTransaction(transaction: Transaction): void;
+    getTransaction(): Transaction;
+    setContextCfg(contextCfg: ICrudProCfg): void;
+    getContextCfg(): ICrudProCfg;
+    setLogger(logger: ILogger): void;
+    getLogger(): ILogger;
+    setVisitor(visitor: IVisitor): void;
+    getVisitor(): IVisitor;
+    getReqModel(): RequestModel;
+    setReqModel(reqModel: RequestModel): void;
+    getResModel(): Record<string, any>;
+    getOneObj(): any;
+    getResRows(): any[];
+    setResModelItem(resName: string, data: any): void;
+    getResModelItem(resName: string): any;
+    getResModelItemLodash(resName: string): any;
+    setCfgModel(cfgModel: RequestCfgModel): void;
+    getCfgModel(): RequestCfgModel;
+    getSqlCfgModels(): SqlCfgModel[];
+    getResMessage(): string;
+}
+interface IExecuteContextHandler {
+    handleExecuteContextPrepare(executeContext: ExecuteContext): Promise<void>;
+    handleExecuteContext(executeContext: ExecuteContext): Promise<void>;
+}
+export { ExecuteContext, IExecuteContextHandler };

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

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecuteContext = void 0;
+const _ = require("lodash");
+const MessageParseUtils_1 = require("../utils/MessageParseUtils");
+const defaultConfigs_1 = require("../defaultConfigs");
+class ExecuteContext {
+    constructor() {
+        this.contextCfg = defaultConfigs_1.defaultCrudProCfg;
+        // 运行时设置的。
+        this.sqlCfgModels = [];
+        this.reqModel = null;
+        this.resModel = {};
+        this.cfgModel = null;
+    }
+    setTransaction(transaction) {
+        this.transaction = transaction;
+    }
+    getTransaction() {
+        return this.transaction;
+    }
+    setContextCfg(contextCfg) {
+        if (typeof contextCfg === 'object') {
+            Object.assign(this.contextCfg, contextCfg);
+        }
+    }
+    getContextCfg() {
+        return this.contextCfg;
+    }
+    setLogger(logger) {
+        this.logger = logger;
+    }
+    getLogger() {
+        return this.logger;
+    }
+    setVisitor(visitor) {
+        this.visitor = visitor;
+    }
+    getVisitor() {
+        return this.visitor;
+    }
+    getReqModel() {
+        return this.reqModel;
+    }
+    setReqModel(reqModel) {
+        this.reqModel = reqModel;
+    }
+    getResModel() {
+        return this.resModel;
+    }
+    getOneObj() {
+        return this.resModel['row'];
+    }
+    getResRows() {
+        return this.resModel['rows'];
+    }
+    setResModelItem(resName, data) {
+        this.resModel[resName] = data;
+    }
+    getResModelItem(resName) {
+        return this.resModel[resName];
+    }
+    getResModelItemLodash(resName) {
+        return _.get(this.resModel, resName);
+    }
+    setCfgModel(cfgModel) {
+        this.cfgModel = cfgModel;
+    }
+    getCfgModel() {
+        return this.cfgModel;
+    }
+    getSqlCfgModels() {
+        return this.sqlCfgModels;
+    }
+    getResMessage() {
+        return MessageParseUtils_1.messageParseUtils.getResMessage(this);
+    }
+}
+exports.ExecuteContext = ExecuteContext;

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

@@ -0,0 +1,31 @@
+import { IConnectionPool } from '../interfaces';
+import { ExecuteContext } from './ExecuteContext';
+import { SqlCfgModel } from './SqlCfgModel';
+import { RequestCfgModel } from './RequestCfgModel';
+import { RequestModel } from './RequestModel';
+export interface IExecuteContextFunc {
+    setExecuteContext(exeCtx: ExecuteContext): any;
+    getExecuteContext(): ExecuteContext;
+    getConnectionPool(sqlCfgModel: SqlCfgModel): Promise<IConnectionPool>;
+    getFunctionMap(): any;
+    validateByAuthCfg(cfgModel: RequestCfgModel, reqModel: RequestModel): Promise<any>;
+    afterExecuteSQLList(): Promise<any>;
+}
+export declare class BaseExecuteContextFunc implements IExecuteContextFunc {
+    private executeContext;
+    getConnectionPool(sqlCfgModel: SqlCfgModel): Promise<IConnectionPool>;
+    getFunctionMap(): any;
+    /**
+     * 校验请求权限
+     * @param cfgModel
+     * @param reqModel
+     */
+    validateByAuthCfg(cfgModel: RequestCfgModel, reqModel: RequestModel): Promise<any>;
+    /**
+     * SQL执行完之后做一些额外操作，可以处理一下将要返回的数据。
+     * @param exeCtx
+     */
+    afterExecuteSQLList(): Promise<any>;
+    getExecuteContext(): ExecuteContext;
+    setExecuteContext(executeContext: ExecuteContext): void;
+}

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

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseExecuteContextFunc = void 0;
+const keys_1 = require("./keys");
+const exceptions_1 = require("../exceptions");
+const MixinUtils_1 = require("../utils/MixinUtils");
+class BaseExecuteContextFunc {
+    async getConnectionPool(sqlCfgModel) {
+        throw 'getConnectionPool not implemented';
+    }
+    getFunctionMap() {
+        return {};
+    }
+    /**
+     * 校验请求权限
+     * @param cfgModel
+     * @param reqModel
+     */
+    async validateByAuthCfg(cfgModel, reqModel) {
+        if (cfgModel.authType === keys_1.KeysOfAuthType.free || !cfgModel.authType) {
+            return; // 无需校验
+        }
+        const visitor = reqModel.visitor;
+        if (!visitor.isLogin) {
+            throw new exceptions_1.CommonException(exceptions_1.Exceptions.NOT_LOGIN, '用户没有登陆');
+        }
+        // 超级管理员 无需校验
+        if (visitor.isSuperAdmin === true) {
+            return;
+        }
+        if (cfgModel.authType === keys_1.KeysOfAuthType.byFuncCode) {
+            const funcCodes = cfgModel.authConfig;
+            if (MixinUtils_1.MixinUtils.isEmpty(funcCodes)) {
+                throw new exceptions_1.CommonException(exceptions_1.Exceptions.CFG_AUTH_CODE_EMPTY, '缺少权限编码配置');
+            }
+            if (!MixinUtils_1.MixinUtils.hasAny(visitor.functionCodes, funcCodes)) {
+                throw new exceptions_1.CommonException(exceptions_1.Exceptions.NO_AUTH, '缺少权限: ' + JSON.stringify(funcCodes));
+            }
+        }
+        if (cfgModel.authType === keys_1.KeysOfAuthType.byRoleCode) {
+            const roleCodes = cfgModel.authConfig;
+            if (MixinUtils_1.MixinUtils.isEmpty(roleCodes)) {
+                throw new exceptions_1.CommonException(exceptions_1.Exceptions.CFG_AUTH_CODE_EMPTY, '缺少角色编码配置');
+            }
+            if (!MixinUtils_1.MixinUtils.hasAny(visitor.roleCodes, roleCodes)) {
+                throw new exceptions_1.CommonException(exceptions_1.Exceptions.NO_AUTH, '缺少角色: ' + JSON.stringify(roleCodes));
+            }
+        }
+    }
+    /**
+     * SQL执行完之后做一些额外操作，可以处理一下将要返回的数据。
+     * @param exeCtx
+     */
+    afterExecuteSQLList() {
+        return null;
+    }
+    getExecuteContext() {
+        return this.executeContext;
+    }
+    setExecuteContext(executeContext) {
+        this.executeContext = executeContext;
+    }
+}
+exports.BaseExecuteContextFunc = BaseExecuteContextFunc;

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

@@ -0,0 +1,18 @@
+import { RequestModel } from './RequestModel';
+declare class FuncContext {
+    /**
+     * 执行结果:
+     *  在validate/update阶段为空
+     *  在execute阶段不为空
+     */
+    resModel: any;
+    /**
+     * 请求中的数据
+     */
+    reqModel: RequestModel;
+    /**
+     * 当前行中的数据
+     */
+    currentValue: any;
+}
+export { FuncContext };

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FuncContext = void 0;
+class FuncContext {
+}
+exports.FuncContext = FuncContext;

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

@@ -0,0 +1,65 @@
+import { ColumnRelation, IFuncCfgModel, IRequestCfgModel, IValidatorCfgItem } from '../interfaces';
+import { SqlCfgModel } from './SqlCfgModel';
+import { KeysOfAuthType, KeysOfSimpleSQL, KeysOfSqlResPicker, SqlDbType } from './keys';
+/**
+ *  sqlSimpleName/sqlCfgList 二选一
+ *  sqlCfgList 优先级高于 sqlSimpleName
+ *  如果设置了sqlCfgList，则sqlSimpleName不再生效。
+ */
+declare class RequestCfgModel {
+    columns?: string[];
+    columnsRelation?: ColumnRelation[];
+    uniqueColumn?: string[];
+    sqlTable: string;
+    sqlSchema?: string;
+    sqlDatabase?: string;
+    sqlDdType?: SqlDbType;
+    maxLimit: number;
+    method: string;
+    transactionEnable: boolean;
+    transactionIsolation: number;
+    sqlSimpleName: KeysOfSimpleSQL;
+    sqlCfgList: SqlCfgModel[];
+    functionCfg: Record<string, IFuncCfgModel>;
+    /**
+     *  key 为update哪个字段。 如：{'data.userName': { constString: 'zhangsan' }}
+     */
+    updateCfg: Record<string, IFuncCfgModel>;
+    /**
+     *  key 为update哪个字段。 如：{'data.userName': [{ constString: 'zhangsan' },'required']}
+     *  value 是一个数组，允许添加多个校验器。
+     */
+    validateCfg: Record<string, IValidatorCfgItem[]>;
+    /**
+     * key为data或condition；value为字段数组
+     * 如：{
+     *   allowCfg: {
+     *      data: ['id','name','age']
+     *   }
+     * }
+     */
+    allowCfg: Record<string, string[]>;
+    /**
+     * key为data或condition；value为字段数组
+     * 如：{
+     *   rejectCfg: {
+     *      data: ['id','name','age']
+     *   }
+     * }
+     */
+    rejectCfg: Record<string, string[]>;
+    /**
+     * 鉴权类型；free无需鉴权，login仅登录即可，byRoleCode校验角色，byFuncCode校验功能点
+     */
+    authType: KeysOfAuthType;
+    /**
+     * 鉴权类型为byRole或byFunc时，额外的配置。角色code或功能点code
+     */
+    authConfig: string[];
+    constructor(json: Partial<IRequestCfgModel>);
+    private parseAuthConfig;
+    addSqlCfgModel(resName: string, originSql: string, resPicker?: KeysOfSqlResPicker, executeWhenFunCfg?: IFuncCfgModel): void;
+    private addSqlCfgModelList;
+    private addSqlCfgModelIf;
+}
+export { RequestCfgModel };

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

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestCfgModel = void 0;
+const SqlCfgModel_1 = require("./SqlCfgModel");
+const MixinUtils_1 = require("../utils/MixinUtils");
+const defaultConfigs_1 = require("../defaultConfigs");
+//
+// const columnsRelation = [
+//   {
+//     relatedType: 'dict',
+//     relatedCode: 'SexEnum',
+//     sourceColumns: ['sex'],
+//     targetColumns: [{ from: 'label', to: 'sexLabel' }],
+//   },
+//   {
+//     relatedType: 'userBasic',
+//     // relatedCode: 'SexEnum',
+//     sourceColumns: ['created_by'],
+//     targetColumns: [{ from: 'userNick', to: 'created_by_user_nick' }],
+//   },
+//   {
+//     relatedType: 'sysConfig',
+//     relatedCode: 'SexEnum',
+//     sourceColumns: ['sex'],
+//     targetColumns: [{ from: 'userNick', to: 'created_by_user_nick' }],
+//   },
+// ];
+/**
+ *  sqlSimpleName/sqlCfgList 二选一
+ *  sqlCfgList 优先级高于 sqlSimpleName
+ *  如果设置了sqlCfgList，则sqlSimpleName不再生效。
+ */
+class RequestCfgModel {
+    constructor(json) {
+        this.maxLimit = defaultConfigs_1.DEFAULT_MAX_LIMIT; // 最大一次性返回的数量
+        Object.assign(this, json);
+        this.columns = MixinUtils_1.MixinUtils.parseColumns(json.columns);
+        this.authConfig = this.parseAuthConfig(json.authConfig);
+        this.sqlCfgList = [];
+        this.addSqlCfgModelList(json.sqlCfgList);
+    }
+    parseAuthConfig(cfg) {
+        if (!cfg) {
+            return null;
+        }
+        if (Array.isArray(cfg)) {
+            return cfg;
+        }
+        if (typeof cfg === 'string') {
+            return [cfg];
+        }
+        return null;
+    }
+    addSqlCfgModel(resName, originSql, resPicker, executeWhenFunCfg) {
+        const model = new SqlCfgModel_1.SqlCfgModel({ resName, originSql });
+        if (resPicker) {
+            model.resPicker = resPicker;
+        }
+        if (executeWhenFunCfg) {
+            model.executeWhen = executeWhenFunCfg;
+        }
+        this.addSqlCfgModelIf(model);
+    }
+    addSqlCfgModelList(list) {
+        if (!list || !Array.isArray(list)) {
+            return;
+        }
+        for (let i = 0; i < list.length; i++) {
+            const listElement = list[i];
+            const model = new SqlCfgModel_1.SqlCfgModel(listElement);
+            this.addSqlCfgModelIf(model);
+        }
+    }
+    addSqlCfgModelIf(model) {
+        if (!this.sqlCfgList) {
+            this.sqlCfgList = [];
+        }
+        this.sqlCfgList.push(model);
+    }
+}
+exports.RequestCfgModel = RequestCfgModel;

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

@@ -0,0 +1,25 @@
+import { IOrderByItem, IRequestModel, IVisitor } from '../interfaces';
+declare class RequestModel {
+    visitor: IVisitor;
+    method: string;
+    columns?: string[];
+    condition?: Record<string, any>;
+    data?: Record<string, any>;
+    limit: number;
+    offset: number;
+    orderBys?: IOrderByItem[];
+    constructor(req: IRequestModel, visitor: IVisitor);
+    private parseOrderBys;
+    private parseOffsetList;
+    /**
+     * 获取对象数据类型
+     * @param attrName
+     */
+    getCondOrDataJsonObject(attrName: string): any;
+    /**
+     * 获取基本数据类型
+     * @param attrName
+     */
+    getJsonObjectValue(attrName: string): any;
+}
+export { RequestModel };