@domain.js/main 0.1.14 → 0.1.15

package/dist/deps/rest/defines.d.ts

@@ -1,50 +1,5 @@
-import * as Sequelize from "sequelize";
+import { ModelBase } from "../sequelize";
 export interface Params {
     [propName: string]: any;
 }
-export declare type TModel = typeof Sequelize.Model & {
-    filterAttrs?: string[];
-    writableCols?: string[];
-    editableCols?: string[];
-    allowIncludeCols?: string[];
-    onlyAdminCols?: string[];
-    pagination?: {
-        maxResults: number;
-        maxStartIndex: number;
-        maxResultsLimit: number;
-    };
-    sort?: {
-        default: string;
-        allow: string[];
-        defaultDirection?: "DESC" | "ASC";
-    };
-    includes?: {
-        [k: string]: {
-            as: string;
-            required: boolean;
-            model: TModel;
-        };
-    };
-    searchCols?: {
-        [k: string]: {
-            op: "=" | "LIKE";
-            match: string[];
-        };
-    };
-    stats?: {
-        dimensions?: Record<string, string>;
-        metrics: Record<string, string>;
-        pagination?: {
-            maxResults: number;
-            maxStartIndex: number;
-            maxResultsLimit: number;
-        };
-    };
-    unique?: string[];
-};
-export declare type ModelExtraAtts = Omit<TModel, keyof typeof Sequelize.Model>;
-export interface Include {
-    as: string;
-    required: boolean;
-    model: TModel;
-}
+export declare type TModel = typeof ModelBase;

package/dist/deps/rest/index.d.ts

@@ -1,6 +1,6 @@
 import _ from "lodash";
 import * as Sequelize from "sequelize";
-import { TModel, Params } from "./defines";
+import { ModelBase, ModelStatic } from "../sequelize";
 import { Stats } from "./stats";
 import { Utils } from "./utils";
 export { Before } from "./Before";
@@ -24,14 +24,14 @@ export interface CreatorAndClientIp {
  * @returns modify, add, remove, list, stats five methods
  */
 export declare function Main(cnf: Cnf, deps: Deps, utils: ReturnType<typeof Utils>): {
-    modify: (Model: TModel, model: Sequelize.Model<any, any>, params: Params, isAdmin?: boolean, _cols?: string[] | undefined) => Promise<Sequelize.Model<any, any>>;
-    add: (Model: TModel, params: Params, isAdmin: boolean | undefined, _cols: string[] | undefined, { creatorId, clientIp }: CreatorAndClientIp) => Promise<any>;
+    modify: <T extends ModelBase<any, any>>(Model: ModelStatic<T>, model: T, params: Record<string, any>, isAdmin?: boolean, _cols?: string[] | undefined) => Promise<T>;
+    add: <T_1 extends ModelBase<any, any>>(Model: ModelStatic<T_1>, params: Record<string, any>, isAdmin: boolean | undefined, _cols: string[] | undefined, { creatorId, clientIp }: CreatorAndClientIp) => Promise<T_1>;
     remove: (model: Sequelize.Model, deletorId: UserId) => Promise<void | Sequelize.Model<any, any>>;
-    list: (Model: TModel, params: Params, allowAttrs?: string[] | undefined, toJSON?: boolean | undefined) => Promise<{
+    list: <T_2 extends ModelBase<any, any>>(Model: ModelStatic<T_2>, params: Record<string, any>, allowAttrs?: string[] | undefined, toJSON?: boolean | undefined) => Promise<{
         count: number;
-        rows: any[];
+        rows: T_2[];
     }>;
-    stats: (Model: TModel, params: Params, where?: any, conf?: {
+    stats: <T_3 extends ModelBase<any, any>>(Model: ModelStatic<T_3>, params: Record<string, any>, where?: any, conf?: {
         dimensions?: Record<string, string> | undefined;
         metrics: Record<string, string>;
         pagination?: {
@@ -41,7 +41,7 @@ export declare function Main(cnf: Cnf, deps: Deps, utils: ReturnType<typeof Util
         } | undefined;
     } | undefined) => Promise<{
         count: number;
-        rows: any;
+        rows: Record<string, string | number>[];
     }>;
 };
 export declare const Deps: string[];

package/dist/deps/rest/index.js

@@ -116,7 +116,7 @@ function Main(cnf, deps, utils) {
             count = await Model.count(lodash_1.default.pick(opt, COUNT_OPT));
         if (Array.isArray(allowAttrs) && allowAttrs.length)
             opt.attributes = allowAttrs;
-        const rows = (await Model.findAll(opt));
+        const rows = await Model.findAll(opt);
         if (toJSON) {
             for (let i = 0; i < rows.length; i += 1) {
                 rows[i] = rows[i].toJSON();

package/dist/deps/rest/stats.d.ts

@@ -1,13 +1,21 @@
 import _ from "lodash";
 import * as Sequelize from "sequelize";
-import { Params, ModelExtraAtts, TModel } from "./defines";
+import { ModelBase, ModelStatic } from "../sequelize";
 import { Utils } from "./utils";
 interface Deps {
     _: typeof _;
     Sequelize: Pick<typeof Sequelize, "literal" | "and" | "fn">;
 }
-export declare function Stats(cnf: {}, deps: Deps, utils: ReturnType<typeof Utils>): (Model: TModel, params: Params, where?: any, conf?: ModelExtraAtts["stats"]) => Promise<{
+export declare function Stats(cnf: {}, deps: Deps, utils: ReturnType<typeof Utils>): <T extends ModelBase<any, any>>(Model: ModelStatic<T>, params: Record<string, any>, where?: any, conf?: {
+    dimensions?: Record<string, string> | undefined;
+    metrics: Record<string, string>;
+    pagination?: {
+        maxResults: number;
+        maxStartIndex: number;
+        maxResultsLimit: number;
+    } | undefined;
+} | undefined) => Promise<{
     count: number;
-    rows: any;
+    rows: Record<string, string | number>[];
 }>;
 export {};

package/dist/deps/rest/stats.js

@@ -149,7 +149,7 @@ function Stats(cnf, deps, utils) {
         let count = 0;
         if (_ignoreTotal !== "yes")
             count = await statsCount(Model, opt, dims);
-        const rows = await Model.findAll(opt);
+        const rows = (await Model.findAll(opt));
         for (const x of rows) {
             for (const met of metrics) {
                 x[met] = x[met] ? Number(x[met]) : 0;

package/dist/deps/rest/utils.d.ts

@@ -1,8 +1,8 @@
 import type { LoDashStatic } from "lodash";
+import moment from "moment";
 import * as mysql from "mysql2";
 import * as Sequelize from "sequelize";
-import moment from "moment";
-import { ModelExtraAtts, TModel, Params } from "./defines";
+import { ModelBase, ModelStatic } from "../sequelize";
 interface Cnf {
     rest: {
         relativeMaxRangeDays?: number;
@@ -19,11 +19,15 @@ interface Deps {
     };
 }
 export declare function Utils(cnf: Cnf, deps: Deps): Readonly<{
-    pickParams: (params: any, cols: string[], Model: TModel, isAdmin: boolean) => {
+    pickParams: <T extends ModelBase<any, any>>(params: any, cols: string[], Model: ModelStatic<T>, isAdmin: boolean) => {
         [propName: string]: any;
     };
-    findAllOpts: (Model: TModel, params: Params) => any;
-    pageParams: (pagination: ModelExtraAtts["pagination"], params: Params) => {
+    findAllOpts: <T_1 extends ModelBase<any, any>>(Model: ModelStatic<T_1>, params: Record<string, any>) => any;
+    pageParams: (pagination: {
+        maxResults: number;
+        maxStartIndex: number;
+        maxResultsLimit: number;
+    } | undefined, params: Record<string, any>) => {
         offset: number;
         limit: number;
     };

package/dist/deps/rest/utils.js

@@ -199,6 +199,7 @@ function Utils(cnf, deps) {
     };
     const RELATIVE_RANGE_ERROR = errors.notAllowed(`相对时间跨度最多 ${RELATIVE_MAX_RANGE} 天`);
     // findOptFilter 的处理
+    // eslint-disable-next-line complexity
     const findOptFilter = (params, name, where, Op, col = name) => {
         let value;
         if (!params)
@@ -391,10 +392,12 @@ function Utils(cnf, deps) {
                 const searchOptResII = searchOpt(x.model, params._searchs, params.q, x.as);
                 if (searchOptResII)
                     searchOrs.push(searchOptResII);
-                x.where = includeWhere;
                 // 以及关联资源允许返回的字段
-                if (x.model.allowIncludeCols)
-                    x.attributes = x.model.allowIncludeCols;
+                let attributes;
+                if (x.model.allowIncludeCols && x.model.allowIncludeCols.length)
+                    attributes = x.model.allowIncludeCols;
+                // 将过滤条件和查询的字段附加上去
+                Object.assign(x, { where: includeWhere, attributes });
             });
         }
         const ret = {

package/dist/deps/sequelize/index.d.ts

@@ -1,16 +1,85 @@
-import * as Sequelize from "sequelize";
+import { Model, Options, Sequelize } from "sequelize";
 interface Cnf {
     sequelize: {
-        [propName: string]: Sequelize.Options;
+        [propName: string]: Options;
     };
 }
 interface Deps {
     Sequelize: {
-        Sequelize: typeof Sequelize.Sequelize;
+        Sequelize: typeof Sequelize;
     };
 }
+declare type NonConstructorKeys<T> = {
+    [P in keyof T]: T[P] extends new () => any ? never : P;
+}[keyof T];
+declare type NonConstructor<T> = Pick<T, NonConstructorKeys<T>>;
+export declare type ModelStatic<M extends ModelBase> = NonConstructor<typeof ModelBase> & (new () => M);
 export declare function Main(cnf: Cnf, deps: Deps): {
-    [propName: string]: Sequelize.Sequelize;
+    [propName: string]: Sequelize;
 };
 export declare const Deps: string[];
+/**
+ * Model 基类
+ */
+export declare class ModelBase<Attrs extends {} = any, Attrs4Create extends {} = Attrs> extends Model<Attrs, Attrs4Create> {
+    /**
+     * 基于主键获取某条数据的Mode实例，自动维护内存级 cache
+     * @param pk 主键
+     */
+    static getByPk<M extends ModelBase>(this: ModelStatic<M>, pk: string | number): Promise<M | null>;
+    /**
+     * 基于主键获取某些数据的Mode实例列表，维持参数的顺序，自动维护内存级 cache
+     * @param pks 主键数组
+     */
+    static getByPks<M extends ModelBase>(this: ModelStatic<M>, pks: string[] | number[]): Promise<M[]>;
+    /** 允许过滤的字段, 对于某些隐私、敏感信息，应该禁止基于其过滤, 使用者反复尝试可以暴力破解敏感信息 */
+    static filterAttrs?: string[];
+    /** 新增资源的时候可以写入的列名称集合 */
+    static writableCols?: string[];
+    /** 编辑资源的时候可以写入的列名称集合 */
+    static editableCols?: string[];
+    /** 关联资源的时候允许被关联展示的列名称集合 */
+    static allowIncludeCols?: string[];
+    /** 编辑过程中，仅管理可以更改的列名称集合 */
+    static onlyAdminCols?: string[];
+    /** 列表查询时候分页控制参数 */
+    static pagination?: {
+        maxResults: number;
+        maxStartIndex: number;
+        maxResultsLimit: number;
+    };
+    /** 列表查询时候排序控制参数 */
+    static sort?: {
+        default: string;
+        allow: string[];
+        defaultDirection?: "DESC" | "ASC";
+    };
+    /** 关联资源设定, 除非要关联过滤，否则不要设置资源之间的关联关系 */
+    static includes?: {
+        [k: string]: {
+            as: string;
+            required: boolean;
+            model: typeof ModelBase;
+        };
+    };
+    /** 模糊搜索相关设定 */
+    static searchCols?: {
+        [k: string]: {
+            op: "=" | "LIKE";
+            match: string[];
+        };
+    };
+    /** 统计相关设定 */
+    static stats?: {
+        dimensions?: Record<string, string>;
+        metrics: Record<string, string>;
+        pagination?: {
+            maxResults: number;
+            maxStartIndex: number;
+            maxResultsLimit: number;
+        };
+    };
+    /** 联合唯一列名称集合，用来自动恢复软删除的资源 */
+    static unique?: string[];
+}
 export {};

package/dist/deps/sequelize/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Deps = exports.Main = void 0;
+exports.ModelBase = exports.Deps = exports.Main = void 0;
+const sequelize_1 = require("sequelize");
 function Main(cnf, deps) {
     // 这里之所以要注入 Sequelize 是为了保证项目自身可以灵活选择自己的 Sequelize 版本, 这样改公共模块就会更加稳定, 避免频繁升级
     const { sequelize: dbs } = cnf;
@@ -14,3 +15,49 @@ function Main(cnf, deps) {
 }
 exports.Main = Main;
 exports.Deps = ["Sequelize"];
+/**
+ * Model 基类
+ */
+class ModelBase extends sequelize_1.Model {
+    /**
+     * 基于主键获取某条数据的Mode实例，自动维护内存级 cache
+     * @param pk 主键
+     */
+    static getByPk(pk) {
+        return this.findByPk(pk);
+    }
+    /**
+     * 基于主键获取某些数据的Mode实例列表，维持参数的顺序，自动维护内存级 cache
+     * @param pks 主键数组
+     */
+    static async getByPks(pks) {
+        if (!Array.isArray(pks) || !pks.length)
+            return [];
+        //静态方法调用同一个类中的其他静态方法，可使用 this 关键字
+        // eslint-disable-next-line no-undef
+        const list = [];
+        for await (const x of pks) {
+            const item = await this.getByPk(x);
+            if (item)
+                list.push(item);
+        }
+        return list;
+    }
+}
+exports.ModelBase = ModelBase;
+/** 新增资源的时候可以写入的列名称集合 */
+ModelBase.writableCols = [];
+/** 编辑资源的时候可以写入的列名称集合 */
+ModelBase.editableCols = [];
+/** 列表查询时候分页控制参数 */
+ModelBase.pagination = {
+    maxResults: 10,
+    maxStartIndex: 50000,
+    maxResultsLimit: 5000,
+};
+/** 列表查询时候排序控制参数 */
+ModelBase.sort = {
+    default: "id",
+    defaultDirection: "DESC",
+    allow: ["id"],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domain.js/main",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "description": "DDD framework",
   "main": "dist/index.js",
   "bin": {
@@ -77,7 +77,7 @@
     "mysql2": "^2.3.3",
     "restify": "^8.6.0",
     "restify-errors": "^8.0.2",
-    "sequelize": "6.12.1",
+    "sequelize": "6.16.1",
     "type-fest": "^2.8.0",
     "uuid": "^8.3.2",
     "xlsx": "^0.17.4"