@domain.js/main 0.3.2 → 0.3.5

package/.vscode/settings.json

@@ -1,3 +1,11 @@
 {
-  "typescript.tsdk": "node_modules/typescript/lib"
-}
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "[markdown]": {
+    "editor.quickSuggestions": true
+  },
+  "editor.quickSuggestions": {
+    "other": true,
+    "comments": true,
+    "strings": true
+  }
+}

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,26 +20,39 @@ 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;
 };
 declare type TRouter = ReturnType<typeof Router>;
-export declare type ReplaceArrayItem<T extends any[], index extends number, R, S extends any[] = [], L extends number = S["length"]> = T extends [infer A, ...infer rest] ? L extends index ? [...S, R, ...rest] : ReplaceArrayItem<rest, index, R, [...S, A]> : never;
-/** 普通 route 方法名称 */
-declare type Keys = "get" | "post" | "put" | "patch" | "del";
-/** 从servers 路径字符串中提取可用作model的名称，目前还不严谨，聊胜于无 */
-declare type PickModelNames<paths extends string> = paths extends string ? paths extends `${infer F}.${string}` ? F : never : never;
-/** 替换函数的某个参数类型定义 */
-export declare type ParameterReplace<T extends (...args: any[]) => any, Index extends number, TR> = (...args: ReplaceArrayItem<Parameters<T>, Index, TR>) => ReturnType<T>;
+/** 普通路径动作类型集合 */
+declare type normalVerb = "get" | "post" | "put" | "del";
+declare type NoramVerbArguments = Parameters<TRouter["get"]>;
+/** 从用点分隔的字符串中提取第一部分 */
+declare type PickFirst<paths extends string> = paths extends string ? paths extends `${infer F}.${string}` ? F : never : never;
+/**
+ * 从 services 路径中题可能的 model 名称的联合类型
+ */
+declare type PickModels<paths extends string, Keys extends string = PickFirst<paths>> = Keys extends any ? `${Keys}.detail` | `${Keys}.modify` | `${Keys}.remove` extends paths ? Keys : never : never;
+/**
+ * 从 services 路径中题可能的 resource 名称的联合类型
+ */
+declare type PickResources<paths extends string, Keys extends string = PickFirst<paths>> = Keys extends any ? `${Keys}.add` | `${Keys}.list` | `${Keys}.detail` | `${Keys}.modify` | `${Keys}.remove` extends paths ? Keys : never : never;
+/**
+ * 根据指定的 controller 尝试提取存在的 collectname
+ * 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 ? `${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, 同时可以自动提示
  */
-export declare type NarrowDomainPaths<Paths extends string, ModelNames = PickModelNames<Paths>> = Omit<TRouter, Keys> & {
-    [k in Keys]: ParameterReplace<TRouter["get"], 1, Paths>;
+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: ParameterReplace<TRouter["model"], 0, ModelNames>;
-    collection: ParameterReplace<ParameterReplace<TRouter["collection"], 0, ModelNames>, 2, ModelNames>;
-    resource: ParameterReplace<TRouter["resource"], 0, ModelNames>;
+    model: (res: PickModels<Paths>, routePath?: string) => ReturnType<TRouter["model"]>;
+    collection: (res: PickCollections<Paths>, routePath?: string) => ReturnType<TRouter["collection"]>;
+    resource: (res: PickResources<Paths>, routePath?: string) => ReturnType<TRouter["resource"]>;
 };
 export {};

package/dist/http/router.js

@@ -18,9 +18,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Router = void 0;
-const _ = __importStar(require("lodash"));
+const lodash_1 = __importDefault(require("lodash"));
 const errors = __importStar(require("restify-errors"));
 function Router(deps) {
     const { domain, apisRoute, utils, server, httpCodes = {}, makeProfileHook } = deps;
@@ -84,7 +87,7 @@ function Router(deps) {
             throw Error(`Missing domain method: ${methodPath}`);
         const { method } = domain[methodPath];
         /** 如果都没有则抛出异常 */
-        if (!method || !_.isFunction(method)) {
+        if (!method || !lodash_1.default.isFunction(method)) {
             throw Error(`Missing domain method: ${methodPath}`);
         }
         server[verb](route, async (req, res, next) => {
@@ -115,7 +118,7 @@ function Router(deps) {
                     if (!ok)
                         res.send(code, results.rows);
                 }
-                else if (!_.isObject(results)) {
+                else if (!lodash_1.default.isObject(results)) {
                     if (code === 204) {
                         res.send(code);
                     }
@@ -150,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.2",
+  "version": "0.3.5",
   "description": "DDD framework",
   "main": "dist/index.js",
   "bin": {