@domain.js/main 0.3.0 → 0.3.3

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/sequelize/index.d.ts

@@ -18,6 +18,12 @@ export declare function Main(cnf: Cnf, deps: Deps): {
     [propName: string]: Sequelize;
 };
 export declare const Deps: string[];
+/** Model 上的 sort 设定类型 */
+export interface ModelSort<Fields extends string> {
+    default: Fields;
+    allow: Fields[];
+    defaultDirection?: "DESC" | "ASC";
+}
 /**
  * Model 基类
  */
@@ -49,11 +55,7 @@ export declare class ModelBase<Attrs extends {} = any, Attrs4Create extends {} =
         maxResultsLimit: number;
     };
     /** 列表查询时候排序控制参数 */
-    static sort?: {
-        default: string;
-        allow: string[];
-        defaultDirection?: "DESC" | "ASC";
-    };
+    static sort?: ModelSort<string>;
     /** 关联资源设定, 除非要关联过滤，否则不要设置资源之间的关联关系 */
     static includes?: {
         [k: string]: {

package/dist/http/router.d.ts

@@ -25,13 +25,34 @@ export declare function Router(deps: Deps): {
     resource: (res: string, routePath?: string) => void;
 };
 declare type TRouter = ReturnType<typeof Router>;
-declare type normal = Parameters<TRouter["get"]>;
-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;
-declare type Keys = "get" | "post" | "put" | "patch" | "del";
+/** 普通路径动作类型集合 */
+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 ? [Lowercase<Collects>, Keys] : never : never;
+export declare type PickCollections<paths extends string, Keys extends string = PickFirst<paths>> = Keys extends any ? PickCollection<Keys, paths> : never;
 /**
  * 利用领域方法路径类型集合，收窄 methodPath, 同时可以自动提示
  */
-export declare type NarrowDomainPaths<Paths extends string> = Omit<TRouter, Keys> & {
-    [k in Keys]: (...args: ReplaceArrayItem<normal, 1, Paths>) => void;
+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;
+    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);
                     }

package/dist/types/index.d.ts

@@ -1 +1,22 @@
+/** 将 readonly string[] 转换成联合类型 */
 export declare type ReadonlyArray2union<T extends ReadonlyArray<any>> = T extends ReadonlyArray<infer A> ? A : never;
+/** 接口参数 schema 定义的类型 */
+export interface ParamsSchema<Params extends {}, Keys extends string | number | symbol = keyof Params> {
+    /** 接口整体描述信息 */
+    description: string;
+    /** 固定为 object params 必然是一个对象, 可以是一个空对象 */
+    type: "object";
+    /** 必填选项  */
+    required?: (keyof Params)[];
+    /** 多选1的设定 */
+    oneOf?: any[];
+    /** 是否允许添加额外的属性 */
+    additionalProperties?: boolean;
+    /** params 参数每一个属性的描述 */
+    properties: Record<Keys, Record<string, any> & {
+        /** 当前参数的描述信息 */
+        description: string;
+        /** 当前参数的类型 */
+        type: "string" | "number" | "integer" | "object" | "array";
+    }>;
+}

package/package.json

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