@domain.js/main 0.2.0 → 0.2.3

package/dist/http/defines.d.ts

@@ -1,3 +1,4 @@
+import { Opt as Sign } from "../deps/signer";
 export interface Cnf {
     proxyIps?: string;
     port?: number;
@@ -7,15 +8,6 @@ export interface Cnf {
     socket?: boolean;
     [propName: string]: any;
 }
-interface Sign {
-    signature: string;
-    uri: string;
-    key: string;
-    timestamp: number;
-    signMethod: string;
-    signVersion: string;
-    method: string;
-}
 export interface Profile {
     clientIp: string;
     remoteIp: string;
@@ -23,15 +15,19 @@ export interface Profile {
     userAgent: string;
     startedAt: Date;
     requestId: string;
+    /** 用户类型，例如 user, worker */
+    type: string;
     /** 自由挂载信息的节点 */
     extra: Record<string, any>;
     revision?: string;
     uuid?: string;
     token?: string;
-    sign?: Sign;
+    sign?: Sign & {
+        signature: string;
+    };
     isSocket?: boolean;
-    /** socket 的时候汇报自己的位置 */
-    position?: string;
+    /** socket 的时候加入的房间 */
+    roomId?: string;
 }
 export interface HttpCodes {
     [propName: string]: number;
@@ -45,4 +41,3 @@ export interface Err {
     code?: number | string;
     data?: any;
 }
-export {};

package/dist/http/router.d.ts

@@ -14,7 +14,7 @@ interface Deps {
 /** 对 params 的处理函数 */
 declare type Handler = (params: any) => void;
 /** 对执行结构的处理 */
-declare type ResHandler = (results: any, res: restify.Response) => void;
+declare type ResHandler = (results: any, res: restify.Response, params?: any) => void;
 export declare function Router(deps: Deps): {
     get: (routePath: string, ctlAct: string, code?: number, isList?: boolean, handler?: Handler | undefined, resHandler?: ResHandler | undefined) => void;
     post: (routePath: string, ctlAct: string, code?: number, isList?: boolean, handler?: Handler | undefined, resHandler?: ResHandler | undefined) => void;

package/dist/http/router.js

@@ -74,7 +74,7 @@ function Router(deps) {
     // eslint-disable-next-line max-params
     function register(verb, route, methodPath, code = 200, isList = false, handler, resHandler) {
         /**
-         * 暂存起来，提供给apis接口来用
+         * 暂存起来，提供给apis接口来
          *  apis接口用来返回当前 services 提供的可用的 api
          */
         apis.push(`[${verb.toUpperCase()}] ${route} Domain: ${methodPath}`);
@@ -97,7 +97,7 @@ function Router(deps) {
                 if (results === null || results === undefined)
                     results = "Ok";
                 if (resHandler) {
-                    resHandler(results, res);
+                    resHandler(results, res, params);
                 }
                 else if (isList) {
                     const { _ignoreTotal, _format } = params;

package/dist/http/socket.d.ts

@@ -1,3 +1,15 @@
-import { Server } from "socket.io";
-import { Domain } from "./defines";
+import { Server, Socket } from "socket.io";
+import { DefaultEventsMap } from "socket.io/dist/typed-events";
+import { Opt as Sign } from "../deps/signer";
+import { Domain, Profile } from "./defines";
+declare type Signature = Sign & {
+    signature: string;
+};
+export declare type Client = Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> & {
+    profile?: ReturnType<typeof makeProfile>;
+    inited?: boolean;
+    roomId?: string;
+};
+declare const makeProfile: (client: Client, type: string | undefined, auth: string | Signature, extra?: Profile["extra"]) => Profile;
 export declare function BridgeSocket(io: Server, domain: Domain): void;
+export {};

package/dist/http/socket.js

@@ -1,6 +1,10 @@
 "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) {
@@ -37,9 +41,8 @@ const utils = {
         return realIp.split(",")[0];
     },
 };
-const makeProfile = (client, token, params, extra) => {
+const makeProfile = (client, type = "user", auth, extra = {}) => {
     const obj = {
-        token,
         clientIp: utils.clientIp(client),
         remoteIp: utils.remoteIp(client),
         realIp: utils.realIp(client),
@@ -47,43 +50,84 @@ const makeProfile = (client, token, params, extra) => {
         startedAt: new Date(),
         userAgent: client.handshake.headers["user-agent"] || "Not captured",
         requestId: client.id,
-        /** 客户端发布号 */
-        revision: params.revision,
-        /** 用户uuid 可以长期跨app */
-        uuid: params.uuid,
-        /** 额外信息，自由扩展 */
+        type,
         extra,
     };
+    if (extra) {
+        /** 客户端发布号 */
+        if (extra.revision)
+            obj.revision = extra.revision;
+        /** 用户uuid 可以长期跨app */
+        if (extra.uuid)
+            obj.uuid = extra.uuid;
+    }
+    if (typeof auth === "string") {
+        obj.token = auth;
+    }
+    else {
+        obj.sign = auth;
+        obj.sign.uri = "/socket.io";
+        obj.sign.method = "socket.init";
+    }
     return obj;
 };
 function BridgeSocket(io, domain) {
-    const subscribe = domain["message.subscribe"];
-    const unsubscribe = domain["message.unsubscribe"];
+    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");
     if (!subscribe)
         throw Error("要启用 socket 服务，必须要要有 message.subscribe 方法，用来处理 socket 订阅");
     if (!unsubscribe)
         throw Error("要启用 socket 服务，必须要要有 message.unsubscribe 方法，用来处理 socket 退订");
+    if (!entrance)
+        throw Error("要启用 socket 服务，必须要要有 message.entrance 方法，用来处理 加入某个房间");
     io.on("connection", (client) => {
+        // 定义toJSON 避免 schema 验证报错
+        Object.assign(client, {
+            toJSON() {
+                return {};
+            },
+        });
         console.log("[%s] connection: client.id: %s", new Date(), client.id);
-        client.on("init", async (token, params, extra) => {
+        client.on("init", async (type, auth, extra = {}) => {
             console.log("[%s] socket.init: client.id: %s", new Date(), client.id);
-            if (!token) {
-                client.emit("initError", "Token lost");
+            if (!auth) {
+                client.emit("initError", "auth info lost");
                 return;
             }
             try {
-                Object.assign(client, { profile: makeProfile(client, token, params, extra) });
+                Object.assign(client, { profile: makeProfile(client, type, auth, extra) });
                 if (!client.profile)
                     throw new MyError("noAuth", "请先登录");
-                const session = await domain["auth.session"](client.profile, {});
                 // 创建消息监听函数
-                if (!client.listener)
-                    client.listener = client.emit.bind(client);
+                if (!client.inited)
+                    client.inited = true;
                 // 向领域注册改用户的监听函数
-                domain["message.subscribe"](client.profile, client.listener);
+                const session = await subscribe(client.profile, client);
                 client.emit("inited", session);
             }
             catch (e) {
+                client.inited = false;
+                if (e instanceof MyError) {
+                    client.emit("internalError", e.message, e.code || "unknown");
+                    return;
+                }
+                console.error(e);
+            }
+        });
+        client.on("entrance", async (roomId) => {
+            try {
+                if (!client.profile || !client.inited)
+                    return;
+                const res = await entrance({ roomId, ...client.profile }, client);
+                client.profile.roomId = roomId;
+                client.roomId = roomId;
+                client.emit("entranced", res);
+            }
+            catch (e) {
+                client.roomId = undefined;
+                if (client.profile)
+                    client.profile.roomId = undefined;
                 if (e instanceof MyError) {
                     client.emit("internalError", e.message, e.code || "unknown");
                     return;
@@ -92,7 +136,7 @@ function BridgeSocket(io, domain) {
             }
         });
         client.use(async ([name, params, responseId], next) => {
-            if (name === "init")
+            if (name === "init" || name === "entrance")
                 return next();
             const method = domain[name];
             try {
@@ -124,10 +168,10 @@ function BridgeSocket(io, domain) {
         client.on("disconnect", () => {
             if (!client.profile)
                 return;
-            if (!client.listener)
+            if (!client.inited)
                 return;
             // 这里要取消对领域消息的监听
-            unsubscribe(client.profile, client.listener);
+            unsubscribe(client.profile, client);
         });
     });
 }

package/dist/http/utils.js

@@ -71,8 +71,12 @@ function Utils(cnf) {
                 userAgent: req.userAgent(),
                 startedAt: new Date(),
                 requestId: req.id(),
+                type: "user",
                 extra: {},
             };
+            if (req.headers["x-auth-user-type"]) {
+                obj.type = req.headers["x-auth-user-type"].toString();
+            }
             const token = req.headers["x-auth-token"] || req.query.access_token || req.query.accessToken;
             // token 和签名认证只能二选一
             if (token) {

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { Defaults } from "./defaults";
 import Deps = require("./deps/defines");
-export { Main as Http } from "./http";
-export { Errors } from "./Errors";
+export { Main as Cfg } from "./cfg";
 export * as DM from "./dm";
+export { Errors } from "./Errors";
+export { Main as Http } from "./http";
 export * as utils from "./utils";
-export { Main as Cfg } from "./cfg";
 export declare const basicErrors: Readonly<Record<"notFound" | "notAllowed" | "noAuth", import("./Errors").ErrorFn>>;
 declare type TDeps = typeof Deps;
 declare type Merge<T> = {

package/dist/index.js

@@ -19,18 +19,18 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Main = exports.basicErrors = exports.Cfg = exports.utils = exports.DM = exports.Errors = exports.Http = void 0;
+exports.Main = exports.basicErrors = exports.utils = exports.Http = exports.Errors = exports.DM = exports.Cfg = void 0;
 const defaults_1 = require("./defaults");
 const DM = __importStar(require("./dm"));
 const Deps = require("./deps/defines");
-var http_1 = require("./http");
-Object.defineProperty(exports, "Http", { enumerable: true, get: function () { return http_1.Main; } });
+var cfg_1 = require("./cfg");
+Object.defineProperty(exports, "Cfg", { enumerable: true, get: function () { return cfg_1.Main; } });
+exports.DM = __importStar(require("./dm"));
 var Errors_1 = require("./Errors");
 Object.defineProperty(exports, "Errors", { enumerable: true, get: function () { return Errors_1.Errors; } });
-exports.DM = __importStar(require("./dm"));
+var http_1 = require("./http");
+Object.defineProperty(exports, "Http", { enumerable: true, get: function () { return http_1.Main; } });
 exports.utils = __importStar(require("./utils"));
-var cfg_1 = require("./cfg");
-Object.defineProperty(exports, "Cfg", { enumerable: true, get: function () { return cfg_1.Main; } });
 exports.basicErrors = defaults_1.defaults.errors;
 function Main(features) {
     const { _ } = defaults_1.defaults;

package/dist/utils/index.d.ts

@@ -12,7 +12,7 @@ export declare const md5: (str: {
  * @param type "strong" or "normal" or other string that custom character range string
  */
 export declare function randStr(len: number, type: "strong"): string;
-export declare function randStr(len: number, type: "normal"): string;
+export declare function randStr(len: number, type?: "normal"): string;
 export declare function randStr(len: number, type: string): string;
 /**
  * Replace line breaks and tabs in the string with ordinary spaces
@@ -75,4 +75,25 @@ declare type Params = {
  * @returns Modified address
  */
 export declare const modifiyURL: (address: string, adds?: Params | undefined, removes?: string[] | undefined) => string;
+/**
+ * 等待，知道 test 返回 true
+ * @param test 检测函数
+ * @param intervalMS 间隔多久判断一次, 单位毫秒 默认 100
+ */
+export declare const waitFor: (test: () => boolean, intervalMS?: number) => Promise<void>;
+/**
+ * 读取录下的所有文件，之后返回数组
+ * params
+ *   dir 要加载的目录
+ *   exts 要加载的模块文件后缀，多个可以是数组, 默认为 coffee
+ *   excludes 要排除的文件, 默认排除 index
+ */
+/**
+ * 读取录下的所有文件，之后返回数组
+ * @param dir 要读取的目录
+ * @param exts 要读取的文件后缀，不包含 (.) 点，例如 jpg 而非 .jpg
+ * @param excludes 要排除的文件列表
+ * @param files 读取到的文件路径存放地址
+ */
+export declare const deepReaddir: (dir: string, exts: Set<string>, excludes?: Set<string>, files?: string[]) => string[];
 export {};

package/dist/utils/index.js

@@ -18,9 +18,15 @@ 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.modifiyURL = exports.inExpired = exports.tryCatchLog = exports.deepFreeze = exports.sleep = exports.lcfirst = exports.ucfirst = exports.nt2space = exports.randStr = exports.md5 = void 0;
+exports.deepReaddir = exports.waitFor = exports.modifiyURL = exports.inExpired = exports.tryCatchLog = exports.deepFreeze = exports.sleep = exports.lcfirst = exports.ucfirst = exports.nt2space = exports.randStr = exports.md5 = void 0;
+const async_1 = __importDefault(require("async"));
 const crypto = __importStar(require("crypto"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 /** 随机字符串字典 */
 const RAND_STR_DICT = {
     normal: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
@@ -40,9 +46,8 @@ function randStr(len, type = "normal") {
     const dict = type === "strong" || type === "normal" ? RAND_STR_DICT[type] : type;
     const { length } = dict;
     /** 随机字符串的长度不能等于 0 或者负数 */
-    len |= 0;
-    len = Math.max(len, 3);
-    return Array(len)
+    const _len = Math.max(3, len | 0);
+    return Array(_len)
         .fill("")
         .map(() => dict[Math.floor(Math.random() * length)])
         .join("");
@@ -147,3 +152,51 @@ const modifiyURL = (address, adds, removes) => {
     return obj.toString();
 };
 exports.modifiyURL = modifiyURL;
+/**
+ * 等待，知道 test 返回 true
+ * @param test 检测函数
+ * @param intervalMS 间隔多久判断一次, 单位毫秒 默认 100
+ */
+const waitFor = async (test, intervalMS = 100) => {
+    await async_1.default.doUntil(async () => {
+        await (0, exports.sleep)(intervalMS);
+    }, async () => test());
+};
+exports.waitFor = waitFor;
+/**
+ * 读取录下的所有文件，之后返回数组
+ * params
+ *   dir 要加载的目录
+ *   exts 要加载的模块文件后缀，多个可以是数组, 默认为 coffee
+ *   excludes 要排除的文件, 默认排除 index
+ */
+/**
+ * 读取录下的所有文件，之后返回数组
+ * @param dir 要读取的目录
+ * @param exts 要读取的文件后缀，不包含 (.) 点，例如 jpg 而非 .jpg
+ * @param excludes 要排除的文件列表
+ * @param files 读取到的文件路径存放地址
+ */
+const deepReaddir = (dir, exts, excludes = new Set(), files = []) => {
+    for (const x of fs_1.default.readdirSync(dir)) {
+        const file = path_1.default.resolve(dir, x);
+        const stat = fs_1.default.lstatSync(file);
+        if (stat.isFile()) {
+            // 忽略隐藏文件
+            if (x[0] === ".")
+                continue;
+            const arr = x.split(".");
+            const ext = arr.pop();
+            const name = arr.join(".");
+            // 如果是不希望的后缀或者排除的名称，则直接忽略/跳过
+            if ((ext && !exts.has(ext)) || excludes.has(name))
+                continue;
+            files.push(file);
+        }
+        else if (stat.isDirectory()) {
+            (0, exports.deepReaddir)(file, exts, excludes, files);
+        }
+    }
+    return files;
+};
+exports.deepReaddir = deepReaddir;

package/package.json

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