evaengine 1.0.13 → 2.0.0

package/dist/entities/index.js

@@ -0,0 +1,228 @@
+import fs from 'fs';
+import path from 'path';
+import assert from 'assert';
+import cloneDeep from 'lodash/cloneDeep.js';
+import { Sequelize, Op, QueryTypes } from 'sequelize';
+import { createRequire } from 'module';
+import DI from "../di.js";
+import { getMicroTimestamp } from "../utils/index.js";
+import { StandardException } from "../exceptions/index.js";
+const require = createRequire(import.meta.url);
+Sequelize.prototype.validateIsUnique = (col, msg) => {
+    const conditions = { where: {} };
+    const message = msg || `${col} must be unique`;
+    return function v(value, next) {
+        //原实现的 this 别名，闭包内沿用
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const self = this;
+        this.Model.describe().then((schema) => {
+            conditions.where[col] = value;
+            Object
+                .keys(schema)
+                .filter(field => schema[field].primaryKey)
+                .forEach((pk) => {
+                conditions.where[pk] = { [Op.ne]: self[pk] };
+            });
+        }).then(() => self.Model.count(conditions).then((found) => {
+            if (found !== 0) {
+                return next(message);
+            }
+            return next();
+        })).catch(next);
+    };
+};
+export default class Entities {
+    entitiesPath;
+    sequelize;
+    entities;
+    scanned;
+    constructor(entitiesPath, sequelizeInstance = null) {
+        this.entitiesPath = entitiesPath;
+        this.sequelize = sequelizeInstance;
+        this.entities = {};
+        this.scanned = false;
+    }
+    /**
+     * Add tracer info to end of SQL query logging
+     */
+    static addTracer(options = {}) {
+        return Object.assign(options, {
+            benchmark: true,
+            logging: (...args) => {
+                // namespace.get 返回 unknown，sequelize 回调里只使用 queries 数组
+                const tracer = DI.get('namespace').get('tracer');
+                const [query, cost] = args;
+                // sequelize 在 benchmark 模式下以 (sql, 耗时 ms) 调用 logging，cost 为 unknown 时与原实现同样按假值/NaN 处理
+                if (tracer && cost > 0) {
+                    tracer.queries.push({
+                        query,
+                        cost: cost * 1000,
+                        finishedAt: getMicroTimestamp()
+                    });
+                }
+            }
+        });
+    }
+    /**
+     * Scan all entity schemas under a special path
+     */
+    scan(entitiesPath, withAssociate = true) {
+        assert(this.sequelize && this.sequelize instanceof Sequelize, 'Scan entities require a sequelize instance');
+        // assert 收窄后的引用提为局部变量，供下方闭包使用
+        const sequelize = this.sequelize;
+        fs
+            .readdirSync(entitiesPath)
+            .filter((file) => {
+            const fileArray = file.split('.');
+            // split('.') 至少产生一段，pop() 不会返回 undefined
+            return (file.indexOf('.') !== 0) &&
+                (['js', 'es6', 'cjs'].indexOf(fileArray.pop()) !== -1) && (fileArray[0] !== 'index');
+        })
+            .forEach((file) => {
+            const entityModule = require(path.join(entitiesPath, file));
+            const entityFactory = (entityModule.default || entityModule);
+            // 模型类同样满足 typeof 'function'（带构造签名），运行时保持原判定：仅工厂被调用
+            const entity = typeof entityFactory === 'function' ?
+                entityFactory(sequelize, Sequelize) : entityFactory;
+            this.entities[entity.name] = entity;
+        });
+        if (!withAssociate) {
+            return this;
+        }
+        Object.values(this.entities).forEach((entity) => {
+            if ('associate' in entity) {
+                entity.associate(this.entities);
+            }
+        });
+        return this;
+    }
+    /**
+     * Init sequelize instance from DI config
+     */
+    init(withAssociate = true) {
+        if (this.sequelize && this.scanned) {
+            return this.sequelize;
+        }
+        const logger = DI.get('logger').getInstance();
+        if (!this.sequelize) {
+            // Config.get 公共签名返回 unknown，这里只消费 db 与 sequelize 两个配置段
+            const config = DI.get('config').get();
+            const ns = DI.get('namespace');
+            if (ns.isEnabled()) {
+                //Inject sequelize inner namespace, refer: http://docs.sequelizejs.com/en/latest/docs/transactions/
+                const context = ns.use().getContext();
+                if (typeof Sequelize.useCLS === 'function') {
+                    Sequelize.useCLS(context);
+                }
+                else {
+                    // 老版本回退分支；sequelize 自带类型未声明 cls 静态属性
+                    Sequelize.cls = context;
+                }
+            }
+            const dbConfig = cloneDeep(config.db);
+            if (process.env.SEQUELIZE_REPLICATION_CONFIG_KEY) {
+                dbConfig.replication = dbConfig[process.env.SEQUELIZE_REPLICATION_CONFIG_KEY];
+            }
+            const sequelizeOptions = Object.assign({}, config.sequelize, dbConfig);
+            if (sequelizeOptions.logging !== false) {
+                Object.assign(sequelizeOptions, Entities.addTracer());
+            }
+            // sequelize 类型声明 username/password 为必填 string；运行时保留原 null 实参
+            this.sequelize = new Sequelize(config.db.database, null, null, sequelizeOptions);
+        }
+        else {
+            this.sequelize = typeof this.sequelize === 'function' ? this.sequelize() : this.sequelize;
+        }
+        this.scan(this.entitiesPath, withAssociate);
+        this.scanned = true;
+        logger.debug('Entities init by scanned %s', this.entitiesPath);
+        return this;
+    }
+    /**
+     * Shortcut for Sequelize query
+     */
+    query(sql, bind = {}, options = {}) {
+        return this.getInstance().query(sql, Object.assign({
+            type: QueryTypes.SELECT
+        }, options, { bind }));
+    }
+    /**
+     * A shortcut to prevent repeat insert
+     */
+    uniqueInsert({ tableName, input, uniqueCondition, transaction }, options = {}) {
+        const inputObj = Object.assign({}, input);
+        const typeAllowed = ['number', 'string', 'boolean'];
+        Object.entries(inputObj).forEach((p) => {
+            const valType = typeof p[1];
+            //Allow null type here
+            if (typeAllowed.indexOf(valType) === -1 && p[1] !== null) {
+                throw new StandardException(`SQL inputObj ${p[0]}:${p[1]} with unsupported type ${valType}.`);
+            }
+            else if (valType === 'boolean') {
+                if (p[1] === true) {
+                    inputObj[p[0]] = 1;
+                }
+                else {
+                    inputObj[p[0]] = 0;
+                }
+            }
+        });
+        const columns = Object.keys(inputObj);
+        const columnString = ['`', columns.join('`, `'), '`'].join('');
+        const valueString = Object.entries(inputObj).map(([key]) => `$${key} \`${key}\``).join(' , ');
+        // sequelize 自带类型未声明实例的 dialect 属性
+        const uniqueString = typeof uniqueCondition === 'string' ? uniqueCondition :
+            [`SELECT * FROM ${tableName} WHERE `, this.getInstance().dialect.QueryGenerator.getWhereConditions(uniqueCondition)].join('');
+        /*
+         Original Example:
+         entities.getInstance().query(`INSERT INTO ${tableName}
+         (userId, status)
+         (
+         SELECT *
+         FROM (SELECT $userId userId, $status status) AS tmp
+         WHERE NOT EXISTS (
+         SELECT id FROM ${auditTable} WHERE userId = $userId AND status = 'pending'
+         ) LIMIT 1
+         )`, { bind, transaction, type: entities.getSequelize().QueryTypes.INSERT });
+         */
+        const sql = `INSERT INTO ${tableName}
+      (${columnString})
+      (
+        SELECT *
+        FROM (SELECT ${valueString}) AS tmp
+        WHERE NOT EXISTS (
+          ${uniqueString} FOR UPDATE
+        ) LIMIT 1
+      )`; //add FOR UPDATE to use eXclusive Lock
+        return this.getInstance().query(sql, Object.assign({
+            bind: inputObj,
+            transaction,
+            type: QueryTypes.INSERT
+        }, options));
+    }
+    /**
+     * A short cut to start a database transaction
+     */
+    getTransaction(options = {}) {
+        return this.getInstance().transaction(Object.assign({
+            autocommit: true
+        }, options));
+    }
+    getSequelize() {
+        return Sequelize;
+    }
+    getInstance() {
+        this.init();
+        // scan() 内的 instanceof 断言保证 init() 之后必为 Sequelize 实例
+        return this.sequelize;
+    }
+    get(name) {
+        this.init();
+        return this.entities[name];
+    }
+    getAll() {
+        this.init();
+        return this.entities;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/entities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAUtD,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAY9C,SAAS,CAAC,SAIT,CAAC,gBAAgB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACjC,MAAM,UAAU,GAAuC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACrE,MAAM,OAAO,GAAG,GAAG,IAAI,GAAG,GAAG,iBAAiB,CAAC;IAC/C,OAAO,SAAS,CAAC,CAA6B,KAAc,EAAE,IAA6B;QACzF,oBAAoB;QACpB,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACpC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC9B,MAAM;iBACH,IAAI,CAAC,MAAM,CAAC;iBACZ,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC;iBACzC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;gBACd,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAC/C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CACX,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1C,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAChB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAgBF,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,YAAY,CAAS;IACrB,SAAS,CAAuC;IAChD,QAAQ,CAA8B;IACtC,OAAO,CAAU;IAEjB,YAAY,YAAoB,EAAE,oBAA0D,IAAI;QAC9F,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,UAAmC,EAAE;QACpD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YAC5B,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,CAAC,GAAG,IAAe,EAAE,EAAE;gBAC9B,uDAAuD;gBACvD,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAuC,CAAC;gBACvF,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC;gBAC3B,sFAAsF;gBACtF,IAAI,MAAM,IAAK,IAAe,GAAG,CAAC,EAAE,CAAC;oBACnC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;wBAClB,KAAK;wBACL,IAAI,EAAG,IAAe,GAAG,IAAI;wBAC7B,UAAU,EAAE,iBAAiB,EAAE;qBAChC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,YAAoB,EAAE,aAAa,GAAG,IAAI;QAC7C,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,YAAY,SAAS,EAAE,4CAA4C,CAAC,CAAC;QAC5G,8BAA8B;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEjC,EAAE;aACC,WAAW,CAAC,YAAY,CAAC;aACzB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACf,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAClC,yCAAyC;YACzC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC;QACnG,CAAC,CAAC;aACD,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,YAAY,GAAY,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;YACrE,MAAM,aAAa,GAAG,CAAE,YAAsC,CAAC,OAAO,IAAI,YAAY,CACzD,CAAC;YAC9B,mDAAmD;YACnD,MAAM,MAAM,GAAG,OAAO,aAAa,KAAK,UAAU,CAAC,CAAC;gBACjD,aAA+B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACzE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QACtC,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC9C,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;gBAC1B,MAAM,CAAC,SAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,aAAa,GAAG,IAAI;QACvB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,uDAAuD;YACvD,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,EAGlC,CAAC;YACF,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC;gBACnB,mGAAmG;gBACnG,MAAM,OAAO,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,UAAU,EAAY,CAAC;gBAChD,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC3C,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC;qBAAM,CAAC;oBACN,qCAAqC;oBACpC,SAAyC,CAAC,GAAG,GAAG,OAAO,CAAC;gBAC3D,CAAC;YACH,CAAC;YAED,MAAM,QAAQ,GAA4B,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC/D,IAAI,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,CAAC;gBACjD,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gCAA0C,CAAC,CAAC;YAC1F,CAAC;YACD,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACvE,IAAI,gBAAgB,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBACvC,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;YACxD,CAAC;YACD,6DAA6D;YAC7D,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAC5B,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAyB,EAAE,IAAyB,EACxE,gBAA+C,CAChD,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,OAAO,IAAI,CAAC,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QAC5F,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEpB,MAAM,CAAC,KAAK,CAAC,6BAA6B,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAW,EAAE,OAAgC,EAAE,EAAE,UAAwB,EAAE;QAC/E,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;YACjD,IAAI,EAAE,UAAU,CAAC,MAAM;SACxB,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,EACX,SAAS,EACT,KAAK,EACL,eAAe,EACf,WAAW,EAMZ,EAAE,UAAwB,EAAE;QAC3B,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5B,sBAAsB;YACtB,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACzD,MAAM,IAAI,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,0BAA0B,OAAO,GAAG,CAAC,CAAC;YAChG,CAAC;iBAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;oBAClB,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACrB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9F,kCAAkC;QAClC,MAAM,YAAY,GAAG,OAAO,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;YAC1E,CAAC,iBAAiB,SAAS,SAAS,EAAG,IAAI,CAAC,WAAW,EAIrD,CAAC,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1E;;;;;;;;;;;WAWG;QAEH,MAAM,GAAG,GAAG,eAAe,SAAS;SAC/B,YAAY;;;uBAGE,WAAW;;YAEtB,YAAY;;QAEhB,CAAC,CAAC,sCAAsC;QAC5C,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;YACjD,IAAI,EAAE,QAAQ;YACd,WAAW;YACX,IAAI,EAAE,UAAU,CAAC,MAAM;SACxB,EAAE,OAAO,CAAC,CAAC,CAAC;IACf,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,UAA8B,EAAE;QAC7C,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;YAClD,UAAU,EAAE,IAAI;SACjB,EAAE,OAAO,CAAC,CAAC,CAAC;IACf,CAAC;IAED,YAAY;QACV,OAAO,SAA4B,CAAC;IACtC,CAAC;IAED,WAAW;QACT,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,qDAAqD;QACrD,OAAO,IAAI,CAAC,SAAsB,CAAC;IACrC,CAAC;IAED,GAAG,CAAsC,IAAY;QACnD,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAM,CAAC;IAClC,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF"}

package/dist/exceptions/index.d.ts

@@ -0,0 +1,153 @@
+/**
+ * Accepted constructor inputs for exceptions
+ */
+export type ExceptionInput = StandardException | Error | string | null | undefined;
+/**
+ * Exception interface
+ * Support usages:
+ * throw new Exception();
+ * throw new Exception('Something');
+ * throw new Exception(new Error());
+ * throw new Exception(new Exception());
+ * throw (new Exception()).i18n('some %d', 123)
+ */
+export declare class StandardException extends Error {
+    /**
+     * Generate string hash by crc32
+     */
+    static hash(str: string, padstr?: string): string;
+    /**
+     * Hash an exception into an 18 bits code
+     */
+    static generateCode(className: string, fileName?: string): number;
+    /**
+     * Remove useless info from error stack
+     */
+    static stackBeautifier(stack: string): string[];
+    static setI18nHandler(handler: (...args: unknown[]) => string): void;
+    /**
+     * Deserialize an exception from a JSON object
+     */
+    static factory(json?: Record<string, unknown>): StandardException | Record<string, unknown> | undefined;
+    /**
+     * Http status code
+     */
+    get statusCode(): number;
+    humanMessage: string;
+    throwingError: boolean;
+    details: unknown;
+    prevError: unknown;
+    code: number | null;
+    filename: string;
+    translated: boolean;
+    importance: number;
+    /**
+     * If throw a StandardException, keep throw to above
+     * If throw a Error, set Error message to exception message, set Error to details
+     * If throw a String, set String to exception message
+     * If throw a null or undefined, set exception name as exception message
+     * Otherwise, throw a TypeError
+     */
+    constructor(exceptionOrMsg?: ExceptionInput);
+    i18n(...args: unknown[]): this;
+    getHumanMessage(): string;
+    setMessage(message: string): this;
+    setCode(code: number | string): this;
+    getCode(): number;
+    getStatusCode(): number;
+    setImportance(importance: number | string): this;
+    getImportance(): number;
+    setFileName(filename: string): this;
+    getFileName(): string;
+    setDetails(details: unknown): this;
+    getDetails(): unknown[];
+    setPrevError(prevError: unknown): this;
+    getPrevError(): unknown;
+    toJSON(): {
+        statusCode: number;
+        code: number;
+        name: string;
+        message: string;
+        humanMessage: string;
+        filename: string;
+        prevError: unknown;
+        errors: unknown[];
+        stack: string[];
+        fullStack: string[];
+    };
+}
+export declare class LogicException extends StandardException {
+    get statusCode(): number;
+}
+export declare class InvalidArgumentException extends LogicException {
+}
+export declare class FormInvalidateException extends InvalidArgumentException {
+    constructor(exceptionOrMsg?: ExceptionInput);
+}
+export declare class ModelInvalidateException extends InvalidArgumentException {
+    constructor(exceptionOrMsg?: ExceptionInput);
+}
+export declare class HttpRequestLogicException extends InvalidArgumentException {
+    response: unknown;
+    request: unknown;
+    requestParams: unknown;
+    responseParams: unknown;
+    businessCode: unknown;
+    /**
+     * Support request promise error
+     * https://github.com/request/promise-core/blob/master/lib/errors.js
+     */
+    constructor(exceptionOrMsg?: ExceptionInput);
+    setResponse(response: unknown): this;
+    getRequest(): {};
+    getResponse(): {};
+    setRequestParams(params: unknown): this;
+    getRequestParams(): unknown;
+    setResponseParams(params: unknown): this;
+    getResponseParams(): unknown;
+    setBusinessCode(code: unknown): this;
+    getBusinessCode(): unknown;
+}
+export declare class RestServiceLogicException extends HttpRequestLogicException {
+    constructor(exceptionOrMsg?: ExceptionInput);
+}
+export declare class UnauthorizedException extends LogicException {
+    get statusCode(): number;
+}
+export declare class OperationNotPermittedException extends LogicException {
+    get statusCode(): number;
+}
+export declare class ResourceNotFoundException extends LogicException {
+    get statusCode(): number;
+}
+export declare class OperationUnsupportedException extends LogicException {
+    get statusCode(): number;
+}
+export declare class ResourceConflictedException extends LogicException {
+    get statusCode(): number;
+}
+export declare class RuntimeException extends StandardException {
+}
+export declare class IOException extends RuntimeException {
+}
+export declare class HttpRequestIOException extends IOException {
+    response: unknown;
+    request: unknown;
+    requestParams: unknown;
+    responseParams: unknown;
+    businessCode: unknown;
+    constructor(exceptionOrMsg?: ExceptionInput);
+    getRequest(): unknown;
+    getResponse(): unknown;
+    setRequestParams(params: unknown): this;
+    getRequestParams(): unknown;
+    setResponseParams(params: unknown): this;
+    getResponseParams(): unknown;
+    setBusinessCode(code: unknown): this;
+    getBusinessCode(): unknown;
+}
+export declare class RestServiceIOException extends HttpRequestIOException {
+    constructor(exceptionOrMsg?: ExceptionInput);
+}
+export declare class DatabaseIOException extends IOException {
+}