@domain.js/main 0.3.3 → 0.3.6

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

@@ -5,12 +5,14 @@ interface Cnf {
     };
 }
 interface Deps {
-    redis: Pick<Redis, "hget" | "hset" | "hincrby">;
+    redis: Pick<Redis, "hget" | "hset" | "hincrby" | "hmget">;
 }
 export declare function Main(cnf: Cnf, deps: Deps): {
+    mget: (keys: string[]) => Promise<number[]>;
     get: (key: string) => Promise<number>;
     set: (key: string, val: number) => Promise<number>;
     incr: (key: string) => Promise<number>;
+    decr: (key: string) => Promise<number>;
 };
 export declare const Deps: string[];
 export {};

package/dist/deps/counter/index.js

@@ -4,13 +4,39 @@ exports.Deps = exports.Main = void 0;
 function Main(cnf, deps) {
     const { counter: { key: REDIS_KEY }, } = cnf;
     const { redis } = deps;
+    /**
+     * 获取指定 key 的统计数
+     * @param key 要获取的 key
+     */
     const get = async (key) => {
         const num = await redis.hget(REDIS_KEY, key);
         return Number(num) | 0;
     };
+    /**
+     * 主动设置某个key为一个数字
+     * @param key 要设置的key
+     * @param val 要设置的值
+     */
     const set = (key, val) => redis.hset(REDIS_KEY, key, Math.max(0, val | 0));
+    /**
+     * 某个key自增长1
+     * @param key 要自增长的key
+     */
     const incr = (key) => redis.hincrby(REDIS_KEY, key, 1);
-    return { get, set, incr };
+    /**
+     * 某个key自减少1
+     * @param key 要自减少的key
+     */
+    const decr = (key) => redis.hincrby(REDIS_KEY, key, -1);
+    /**
+     * 一次获取多个key的统计值
+     * @param keys 多个key按序输入, 返回的统计数据为数组，和keys数组保持对应关系
+     */
+    const mget = async (keys) => {
+        const res = await redis.hmget(REDIS_KEY, ...keys);
+        return res.map((x) => Number(x) | 0);
+    };
+    return { mget, get, set, incr, decr };
 }
 exports.Main = Main;
 exports.Deps = ["redis"];

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

@@ -27,11 +27,17 @@ export declare function Main(cnf: Cnf, deps: Deps, utils: ReturnType<typeof Util
     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: <T_2 extends ModelBase<any, any>>(Model: ModelStatic<T_2>, params: Record<string, any>, allowAttrs?: string[] | undefined, toJSON?: boolean | undefined) => Promise<{
-        count: number;
-        rows: T_2[];
-    }>;
-    stats: <T_3 extends ModelBase<any, any>>(Model: ModelStatic<T_3>, params: Record<string, any>, where?: any, conf?: {
+    list: {
+        <T_2 extends ModelBase<any, any>, J = ReturnType<T_2["toJSON"]>>(Model: ModelStatic<T_2>, params: Record<string, any>, allowAttrs?: string[] | undefined, toJSON?: false | undefined): Promise<{
+            rows: T_2[];
+            count: number;
+        }>;
+        <T_3 extends ModelBase<any, any>, J_1 = ReturnType<T_3["toJSON"]>>(Model: ModelStatic<T_3>, params: Record<string, any>, allowAttrs?: string[] | undefined, toJSON?: true | undefined): Promise<{
+            rows: J_1[];
+            count: number;
+        }>;
+    };
+    stats: <T_4 extends ModelBase<any, any>>(Model: ModelStatic<T_4>, params: Record<string, any>, where?: any, conf?: {
         dimensions?: Record<string, string> | undefined;
         metrics: Record<string, string>;
         pagination?: {

package/dist/deps/rest/index.js

@@ -99,15 +99,7 @@ function Main(cnf, deps, utils) {
     };
     // count条件所需属性
     const COUNT_OPT = Object.freeze(["where", "include"]);
-    /**
-     * Restful list (R of CRUD) for list resource
-     * @param Model Model definition of resources
-     * @param params parameters for updating
-     * @param allowAttrs Allow columns to be returned
-     * @param toJSON Whether to directly return JSON formatted objects
-     * @returns findAll resource result, object propoties has count, rows
-     */
-    const list = async (Model, params, allowAttrs, toJSON) => {
+    async function list(Model, params, allowAttrs, toJSON) {
         const opt = findAllOpts(Model, params);
         const { _ignoreTotal } = params;
         // 提高查询速度
@@ -117,13 +109,10 @@ function Main(cnf, deps, utils) {
         if (Array.isArray(allowAttrs) && allowAttrs.length)
             opt.attributes = allowAttrs;
         const rows = await Model.findAll(opt);
-        if (toJSON) {
-            for (let i = 0; i < rows.length; i += 1) {
-                rows[i] = rows[i].toJSON();
-            }
-        }
-        return { count, rows };
-    };
+        if (!toJSON)
+            return { rows, count };
+        return { count, rows: rows.map((x) => x.toJSON()) };
+    }
     return { modify, add, remove, list, stats: (0, stats_1.Stats)(cnf, deps, utils) };
 }
 exports.Main = Main;

package/dist/http/router.d.ts

@@ -20,7 +20,7 @@ export declare function Router(deps: Deps): {
     put: (routePath: string, ctlAct: string, code?: number, isList?: boolean, handler?: Handler | undefined, resHandler?: ResHandler | undefined) => void;
     del: (routePath: string, ctlAct: string, code?: number, isList?: boolean, handler?: Handler | undefined, resHandler?: ResHandler | undefined) => void;
 } & {
-    collection: (res: string, _routePath?: string | undefined, controller?: string | undefined) => void;
+    collection: (res: string, _routePath?: string | undefined) => void;
     model: (res: string, routePath?: string) => void;
     resource: (res: string, routePath?: string) => void;
 };
@@ -43,8 +43,8 @@ declare type PickResources<paths extends string, Keys extends string = PickFirst
  * type t2 = PickCollection<"user", "user.addFile" | "user.Files"> // File
  */
 declare type PickCollect<Keys extends string, paths extends string> = paths extends `${Keys}.add${infer A}` ? A : never;
-declare type PickCollection<Keys extends string, paths extends string, Collects extends string = PickCollect<Keys, paths>> = Collects extends any ? `${Keys}.add${Collects}` | `${Keys}.${Lowercase<Collects>}s` extends paths ? [Lowercase<Collects>, Keys] : never : never;
-export declare type PickCollections<paths extends string, Keys extends string = PickFirst<paths>> = Keys extends any ? PickCollection<Keys, paths> : never;
+declare type PickCollection<Keys extends string, paths extends string, Collects extends string = PickCollect<Keys, paths>> = Collects extends any ? `${Keys}.add${Collects}` | `${Keys}.${Lowercase<Collects>}s` extends paths ? `${Keys}::${Lowercase<Collects>}` : never : never;
+export declare type PickCollections<paths extends string, Keys extends string = PickFirst<paths>> = Keys extends any ? PickCollection<Keys, paths> | (`${Keys}.add` | `${Keys}.list` extends paths ? Keys : never) : never;
 /**
  * 利用领域方法路径类型集合，收窄 methodPath, 同时可以自动提示
  */
@@ -52,7 +52,7 @@ export declare type NarrowDomainPaths<Paths extends string> = {
     [k in normalVerb]: (routePath: NoramVerbArguments[0], ctlAct: Paths, code?: NoramVerbArguments[2], isList?: NoramVerbArguments[3], handler?: NoramVerbArguments[4], resHandler?: NoramVerbArguments[5]) => ReturnType<TRouter["get"]>;
 } & {
     model: (res: PickModels<Paths>, routePath?: string) => ReturnType<TRouter["model"]>;
-    collection: PickCollections<Paths> extends [infer R, infer C] ? (res: R, _routePath?: string, controller?: C) => ReturnType<TRouter["collection"]> : never;
+    collection: (res: PickCollections<Paths>, routePath?: string) => ReturnType<TRouter["collection"]>;
     resource: (res: PickResources<Paths>, routePath?: string) => ReturnType<TRouter["resource"]>;
 };
 export {};

package/dist/http/router.js

@@ -153,29 +153,33 @@ function Router(deps) {
         del: RouterVerbFn("del"),
     };
     /**
-     * controller 为可选参数，如果不填写则控制器名称直接就是 res ，方法为 list,add
-     * 如果设置了controller 则控制器为 controller，方法为 #{res}s, add{Res}
+     * 集合方法，集合方法包含了向集合添加元素，以及查看集合(列表)
+     * @param res 资源名称，如果有父级资源用双分号隔开 eg user, user::file
+     * @param _routePath 路径地址，可选，默认按照既定规则拼接
      */
-    const collection = (res, _routePath, controller) => {
+    const collection = (res, _routePath) => {
+        const arr = res.split("::");
+        const name = arr[1] ? arr[1] : arr[0];
+        const controller = arr[1] ? arr[0] : null;
         let routePath;
         if (typeof _routePath !== "string") {
             if (controller) {
-                routePath = `/${controller}s/:${controller}Id/${res}s`;
+                routePath = `/${controller}s/:${controller}Id/${name}s`;
             }
             else {
-                routePath = `/${res}s`;
+                routePath = `/${name}s`;
             }
         }
         else {
             routePath = _routePath;
         }
         if (controller) {
-            register("get", routePath, `${controller}.${res}s`, 200, true);
-            register("post", routePath, `${controller}.add${ucwords(res)}`, 201);
+            register("get", routePath, `${controller}.${name}s`, 200, true);
+            register("post", routePath, `${controller}.add${ucwords(name)}`, 201);
         }
         else {
-            register("get", routePath, `${res}.list`, 200, true);
-            register("post", routePath, `${res}.add`, 201);
+            register("get", routePath, `${name}.list`, 200, true);
+            register("post", routePath, `${name}.add`, 201);
         }
     };
     const model = (res, routePath = `/${res}s/:id`) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domain.js/main",
-  "version": "0.3.3",
+  "version": "0.3.6",
   "description": "DDD framework",
   "main": "dist/index.js",
   "bin": {