@domain.js/main 0.2.5 → 0.3.2

package/dist/cli/index.js

@@ -62,7 +62,7 @@ const makeDefineFile = async (modules, targetFile, isTS) => {
         else {
             content.push(`const ${variable} = require("./${name}")`);
         }
-        _exports.push(`"${file2Module(name)}": ${variable},`);
+        _exports.push(`"${file2Module(name).replace(/[/]/, ".")}": ${variable},`);
     }
     // 处理导出
     content.push("\n");
@@ -116,28 +116,33 @@ const loadDeps = async (rootDir, ext = "js") => {
     const targetFile = path.resolve(rootDir, `./defines.${ext}`);
     await makeDefineFile(modules.sort(), targetFile, isTS);
 };
-const checkService = (_dir) => {
-    const TSFile = path.resolve(_dir, "index.ts");
-    const JSFile = path.resolve(_dir, "index.js");
-    if (!fs.existsSync(TSFile) && !fs.existsSync(JSFile)) {
-        throw Error("目录下缺少index.ts 或 index.js 文件");
-    }
-};
-const loadServices = async (rootDir = process.cwd(), ext = "js") => {
+/**
+ * 自动加载领域方法
+ * @param rootDir 项目根目录
+ * @param ext 文件后缀
+ */
+const loadDomain = async (rootDir = process.cwd(), ext = "js") => {
     const isTS = ext === "ts";
     const modules = [];
     const dir = path.resolve(rootDir, "src/domain/services/");
-    for (const x of fs.readdirSync(dir)) {
+    for (const domain of fs.readdirSync(dir)) {
         // 忽略隐藏目录, 忽略私有目录
-        if (x[0] === "." || x[0] === "_")
+        if (domain[0] === "." || domain[0] === "_")
             continue;
-        const _dir = path.resolve(dir, x);
+        const _dir = path.resolve(dir, domain);
         const stat = fs.statSync(_dir);
         // 非目录忽略，模块必须是目录
         if (!stat.isDirectory())
             continue;
-        checkService(_dir);
-        modules.push(path.join(dir, x));
+        for (const name of fs.readdirSync(_dir)) {
+            // 忽略隐藏目录, 忽略私有目录
+            if (name[0] === "." || name[0] === "_")
+                continue;
+            const extname = path.extname(name);
+            if (extname.toLowerCase() !== `.${ext}`)
+                continue;
+            modules.push(path.join(dir, domain, path.basename(name, extname)));
+        }
     }
     // 按字典排序，后续有变动的时候不容易冲突
     const targetFile = path.resolve(rootDir, `src/domain/services/defines.${ext}`);
@@ -185,7 +190,7 @@ const loadSchemas = async (rootDir = process.cwd(), ext = "js") => {
     const targetFile = path.resolve(rootDir, `src/domain/services/schemas.${ext}`);
     await makeDefineFile(modules.sort(), targetFile, isTS);
 };
-const actions = { loadDeps, loadServices, loadSchemas };
+const actions = { loadDeps, loadSchemas, loadDomain };
 const main = async (command) => {
     const action = actions[command];
     if (!action) {

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

@@ -33,9 +33,15 @@ export interface HttpCodes {
     [propName: string]: number;
 }
 export interface Domain {
-    [propName: string]: (profile: Profile, params: any) => any | Domain;
+    [propName: string]: {
+        /** 领域方法第一个参数 schema 定义 */
+        profile: any;
+        /** 领域方法第二个参数 schema 定义 */
+        params: any;
+        /** 领域方法 */
+        method: (profile: any, params?: any) => any;
+    };
 }
-export declare type GetSchemaByPath = (methodPath: string) => [any, any];
 export interface Err {
     message: string;
     code?: number | string;

package/dist/http/index.d.ts

@@ -1,12 +1,8 @@
 import * as restify from "restify";
-import { Cnf, Domain, GetSchemaByPath, HttpCodes, Profile } from "./defines";
-import { Router } from "./router";
-interface Deps {
-    routers: (r: ReturnType<typeof Router>) => void;
+import { Cnf, Domain, HttpCodes, Profile } from "./defines";
+export declare function Main(cnf: Cnf, deps: {
+    routers: (r: any) => void;
     domain: Domain;
     httpCodes: HttpCodes;
-    getSchemaByPath: GetSchemaByPath;
     makeProfileHook?: (obj: Profile, req: restify.Request) => any;
-}
-export declare function Main(cnf: Cnf, deps: Deps): () => restify.Server;
-export {};
+}): () => restify.Server;

package/dist/http/index.js

@@ -27,7 +27,7 @@ const socket_1 = require("./socket");
 const utils_1 = require("./utils");
 function Main(cnf, deps) {
     const utils = (0, utils_1.Utils)(cnf);
-    const { routers, getSchemaByPath, domain, httpCodes, makeProfileHook } = deps;
+    const { routers, domain, httpCodes, makeProfileHook } = deps;
     const server = restify.createServer();
     server.use(restify.plugins.queryParser());
     server.use(restify.plugins.bodyParser({
@@ -39,7 +39,6 @@ function Main(cnf, deps) {
         server,
         httpCodes,
         makeProfileHook,
-        getSchemaByPath,
         domain,
         apisRoute: cnf.apisRoute,
     });

package/dist/http/router.d.ts

@@ -1,9 +1,8 @@
 import * as restify from "restify";
-import { Domain, GetSchemaByPath, HttpCodes, Profile } from "./defines";
+import { Domain, HttpCodes, Profile } from "./defines";
 import { Utils } from "./utils";
 interface Deps {
     domain: Domain;
-    getSchemaByPath: GetSchemaByPath;
     utils: ReturnType<typeof Utils>;
     server: restify.Server;
     httpCodes: HttpCodes;
@@ -25,4 +24,22 @@ export declare function Router(deps: Deps): {
     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>;
+/**
+ * 利用领域方法路径类型集合，收窄 methodPath, 同时可以自动提示
+ */
+export declare type NarrowDomainPaths<Paths extends string, ModelNames = PickModelNames<Paths>> = Omit<TRouter, Keys> & {
+    [k in Keys]: ParameterReplace<TRouter["get"], 1, Paths>;
+} & {
+    model: ParameterReplace<TRouter["model"], 0, ModelNames>;
+    collection: ParameterReplace<ParameterReplace<TRouter["collection"], 0, ModelNames>, 2, ModelNames>;
+    resource: ParameterReplace<TRouter["resource"], 0, ModelNames>;
+};
 export {};

package/dist/http/router.js

@@ -23,7 +23,7 @@ exports.Router = void 0;
 const _ = __importStar(require("lodash"));
 const errors = __importStar(require("restify-errors"));
 function Router(deps) {
-    const { domain, apisRoute, getSchemaByPath, utils, server, httpCodes = {}, makeProfileHook, } = deps;
+    const { domain, apisRoute, utils, server, httpCodes = {}, makeProfileHook } = deps;
     const { ucwords, makeParams, makeProfile, outputCSV } = utils;
     // 改写 HttpErrorToJSON 处理 data
     const HttpErrorToJSON = errors.HttpError.prototype.toJSON;
@@ -61,8 +61,9 @@ function Router(deps) {
             const { path } = req.query;
             try {
                 const { all } = req.query;
-                const schema = getSchemaByPath(path);
-                res.send(all === undefined ? schema[1] : schema);
+                const profile = domain[path]["profile"];
+                const params = domain[path]["params"];
+                res.send(all === undefined ? params : [profile, params]);
             }
             catch (e) {
                 next(error2httpError(e));
@@ -79,7 +80,9 @@ function Router(deps) {
          */
         apis.push(`[${verb.toUpperCase()}] ${route} Domain: ${methodPath}`);
         apisHTML += `\n<li><a href="./${apisRoute}/_schema?path=${methodPath}">[${verb.toUpperCase()}] ${route} Domain: ${methodPath}</a></li>`;
-        const method = _.get(domain, methodPath);
+        if (!domain[methodPath])
+            throw Error(`Missing domain method: ${methodPath}`);
+        const { method } = domain[methodPath];
         /** 如果都没有则抛出异常 */
         if (!method || !_.isFunction(method)) {
             throw Error(`Missing domain method: ${methodPath}`);

package/dist/http/socket.js

@@ -1,10 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BridgeSocket = void 0;
-const lodash_1 = __importDefault(require("lodash"));
 const proxyIps = new Set(["127.0.0.1"]);
 class MyError extends Error {
     constructor(code, message, data) {
@@ -72,9 +68,9 @@ const makeProfile = (client, type = "user", auth, extra = {}) => {
     return obj;
 };
 function BridgeSocket(io, domain) {
-    const subscribe = lodash_1.default.get(domain, "message.subscribe");
-    const unsubscribe = lodash_1.default.get(domain, "message.unsubscribe");
-    const entrance = lodash_1.default.get(domain, "message.entrance");
+    const { method: subscribe } = domain["message.subscribe"];
+    const { method: unsubscribe } = domain["message.unsubscribe"];
+    const { method: entrance } = domain["message.entrance"];
     if (!subscribe)
         throw Error("要启用 socket 服务，必须要要有 message.subscribe 方法，用来处理 socket 订阅");
     if (!unsubscribe)
@@ -138,7 +134,7 @@ function BridgeSocket(io, domain) {
         client.use(async ([name, params, responseId], next) => {
             if (name === "init" || name === "entrance")
                 return next();
-            const method = domain[name];
+            const { method } = domain[name];
             try {
                 if (!method)
                     throw new MyError("notFound", "不存在该领域方法");

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.2.5",
+  "version": "0.3.2",
   "description": "DDD framework",
   "main": "dist/index.js",
   "bin": {