@domain.js/main 0.1.0

package/dist/http/utils.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utils = void 0;
+const os = require("os");
+const fs = require("fs");
+const crypto = require("crypto");
+const _ = require("lodash");
+const xlsx = require("xlsx");
+const csv_stringify_1 = require("csv-stringify");
+const str2arr = ["_includes", "dimensions", "metrics", "_attrs"];
+const enc = encodeURI;
+const TMPDIR = os.tmpdir();
+function Utils(cnf) {
+    const proxyIps = new Set((cnf.proxyIps || "127.0.0.1").split(","));
+    const utils = {
+        ucwords(value) {
+            return `${value[0].toUpperCase()}${value.substring(1)}`;
+        },
+        /** 真实的连接请求端ip */
+        remoteIp(req) {
+            const { socket } = req;
+            return socket.remoteAddress || "";
+        },
+        /**
+         * 获取客户端真实ip地址
+         */
+        clientIp(req) {
+            return (req.headers["x-forwarded-for"] || req.headers["x-real-ip"] || utils.remoteIp(req))
+                .toString()
+                .split(",")[0];
+        },
+        /**
+         * 获取可信任的真实ip
+         */
+        realIp(req) {
+            const remoteIp = utils.remoteIp(req);
+            if (!proxyIps.has(remoteIp))
+                return remoteIp;
+            return (req.headers["x-real-ip"] || remoteIp).toString();
+        },
+        /**
+         * 构造profile参数
+         */
+        makeProfile(req, method, customFn) {
+            const obj = {
+                clientIp: utils.clientIp(req),
+                remoteIp: utils.remoteIp(req),
+                realIp: utils.realIp(req),
+                userAgent: req.userAgent(),
+                startedAt: new Date(),
+                requestId: req.id(),
+            };
+            const token = req.headers["x-auth-token"] || req.query.access_token || req.query.accessToken;
+            // token 和签名认证只能二选一
+            if (token) {
+                obj.token = token;
+            }
+            else {
+                // 处理签名认证的方式
+                const signature = req.headers["x-auth-signature"];
+                if (signature) {
+                    obj.sign = {
+                        signature,
+                        uri: req.url || "/",
+                        key: req.headers["x-auth-key"],
+                        timestamp: Number(req.headers["x-auth-timestamp"]) | 0,
+                        signMethod: req.headers["x-auth-sign-method"],
+                        signVersion: req.headers["x-auth-sign-version"],
+                        method,
+                    };
+                }
+            }
+            // 客户端发布号
+            obj.revision = req.headers["x-auth-revision"];
+            // 用户uuid 可以长期跨app
+            obj.uuid = req.headers["x-auth-uuid"];
+            if (customFn)
+                Object.assign(obj, customFn(obj, req));
+            return Object.freeze(obj);
+        },
+        /**
+         * 构造领域方法所需的 params 参数
+         */
+        makeParams(req) {
+            let params = { ...req.params, ...req.query };
+            if (_.isObject(req.body) && !Array.isArray(req.body)) {
+                params = { ...req.body, ...params };
+            }
+            else if (req.body) {
+                params.__raw = req.body;
+            }
+            // 逗号分隔的属性，自动转换为 array
+            for (const k of str2arr) {
+                if (params[k] && _.isString(params[k]))
+                    params[k] = params[k].split(",");
+            }
+            if (_.size(req.files))
+                params.__files = req.files;
+            return params;
+        },
+        /**
+         *
+         * 输出csv相关
+         */
+        async outputCSV(rows, params, res, isXLSX = false) {
+            const { _names, _cols, _filename } = params;
+            if (!_.isString(_cols))
+                return false;
+            if (_names && !_.isString(_names))
+                return false;
+            const keys = _cols.split(",");
+            const titles = (_names || _cols).split(",");
+            const filename = _filename || `data.${isXLSX ? "xlsx" : "csv"}`;
+            res.header("Content-disposition", `attachment; filename*=UTF-8''${enc(filename)}`);
+            const mimeType = isXLSX ? "application/xlsx" : "text/csv";
+            res.header("Content-type", mimeType);
+            if (isXLSX) {
+                const file = `${TMPDIR}/${crypto.randomBytes(16).toString("hex")}.xlsx`;
+                const workBook = xlsx.utils.book_new();
+                const workSheet = xlsx.utils.aoa_to_sheet([
+                    titles,
+                    ...rows.map((x) => keys.map((k) => x[k])),
+                ]);
+                xlsx.utils.book_append_sheet(workBook, workSheet);
+                xlsx.writeFile(workBook, file, { bookType: "xlsx", type: "binary" });
+                await new Promise((resolve) => {
+                    const stream = fs.createReadStream(file);
+                    stream.pipe(res);
+                    stream.on("end", () => {
+                        resolve();
+                        fs.unlinkSync(file);
+                    });
+                });
+            }
+            else {
+                await new Promise((resolve) => {
+                    const stream = (0, csv_stringify_1.stringify)(rows, {
+                        header: true,
+                        columns: _.zipObject(keys, titles),
+                    });
+                    stream.pipe(res);
+                    stream.on("end", resolve);
+                });
+            }
+            return true;
+        },
+        jsonSchema2Swagger(schema, verb, methodPath, swaggerDocJson) {
+            if (verb === "post" || verb === "put" || verb === "patch") {
+                swaggerDocJson.definitions[methodPath] = schema;
+                return [
+                    {
+                        name: "body",
+                        in: "body",
+                        require: true,
+                        description: schema.description,
+                        operationId: methodPath,
+                        schema: {
+                            $ref: `#/definitions/${methodPath}`,
+                        },
+                    },
+                ];
+            }
+            const parameters = [];
+            if (!_.has(schema, "properties")) {
+                return parameters;
+            }
+            const requireds = schema.required ? schema.required : [];
+            for (const prop of Object.keys(schema.properties)) {
+                const val = schema.properties[prop];
+                const param = {
+                    name: prop,
+                    in: "query",
+                    ...val,
+                };
+                if (requireds.includes("prop")) {
+                    param.required = true;
+                }
+                parameters.push(param);
+            }
+            return parameters;
+        },
+    };
+    return utils;
+}
+exports.Utils = Utils;

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import Deps = require("./deps/defines");
+export { Main as Http } from "./http";
+export * as DM from "./dm";
+export * as utils from "./utils";
+declare type TDeps = typeof Deps;
+declare type Merge<T> = {
+    [k in keyof T]: T[k];
+};
+/**
+ * Include from T those types that are assignable to U
+ */
+declare type Include<T, U> = T extends U ? T : never;
+declare type RemoveReadonlyArray<T> = T extends ReadonlyArray<infer T1> ? T1 : false;
+export declare function Main<T extends Readonly<Array<keyof TDeps>>>(features: T): (cnf: Merge<{
+    aes: typeof import("./deps/aes");
+    axios: typeof import("./deps/axios");
+    cache: typeof import("./deps/cache");
+    checker: typeof import("./deps/checker");
+    cia: typeof import("./deps/cia");
+    counter: typeof import("./deps/counter");
+    cron: typeof import("./deps/cron");
+    graceful: typeof import("./deps/graceful");
+    hash: typeof import("./deps/hash");
+    logger: typeof import("./deps/logger");
+    parallel: typeof import("./deps/parallel");
+    redis: typeof import("./deps/redis");
+    rest: typeof import("./deps/rest");
+    schema: typeof import("./deps/schema");
+    sequelize: typeof import("./deps/sequelize");
+    signer: typeof import("./deps/signer");
+}[Include<"logger", RemoveReadonlyArray<T>> | Include<"aes", RemoveReadonlyArray<T>> | Include<"cache", RemoveReadonlyArray<T>> | Include<"redis", RemoveReadonlyArray<T>> | Include<"graceful", RemoveReadonlyArray<T>> | Include<"cia", RemoveReadonlyArray<T>> | Include<"counter", RemoveReadonlyArray<T>> | Include<"cron", RemoveReadonlyArray<T>> | Include<"hash", RemoveReadonlyArray<T>> | Include<"parallel", RemoveReadonlyArray<T>> | Include<"sequelize", RemoveReadonlyArray<T>> | Include<"schema", RemoveReadonlyArray<T>> | Include<"rest", RemoveReadonlyArray<T>> | Include<"axios", RemoveReadonlyArray<T>> | Include<"checker", RemoveReadonlyArray<T>> | Include<"signer", RemoveReadonlyArray<T>>]["Main"] extends (arg: infer R, ...args: any[]) => any ? R : {}>) => { [k in keyof Pick<{
+    aes: typeof import("./deps/aes");
+    axios: typeof import("./deps/axios");
+    cache: typeof import("./deps/cache");
+    checker: typeof import("./deps/checker");
+    cia: typeof import("./deps/cia");
+    counter: typeof import("./deps/counter");
+    cron: typeof import("./deps/cron");
+    graceful: typeof import("./deps/graceful");
+    hash: typeof import("./deps/hash");
+    logger: typeof import("./deps/logger");
+    parallel: typeof import("./deps/parallel");
+    redis: typeof import("./deps/redis");
+    rest: typeof import("./deps/rest");
+    schema: typeof import("./deps/schema");
+    sequelize: typeof import("./deps/sequelize");
+    signer: typeof import("./deps/signer");
+}, RemoveReadonlyArray<T>>]: ReturnType<Pick<{
+    aes: typeof import("./deps/aes");
+    axios: typeof import("./deps/axios");
+    cache: typeof import("./deps/cache");
+    checker: typeof import("./deps/checker");
+    cia: typeof import("./deps/cia");
+    counter: typeof import("./deps/counter");
+    cron: typeof import("./deps/cron");
+    graceful: typeof import("./deps/graceful");
+    hash: typeof import("./deps/hash");
+    logger: typeof import("./deps/logger");
+    parallel: typeof import("./deps/parallel");
+    redis: typeof import("./deps/redis");
+    rest: typeof import("./deps/rest");
+    schema: typeof import("./deps/schema");
+    sequelize: typeof import("./deps/sequelize");
+    signer: typeof import("./deps/signer");
+}, RemoveReadonlyArray<T>>[k]["Main"]>; };

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Main = exports.utils = exports.DM = exports.Http = void 0;
+const _ = require("lodash");
+const DM = require("./dm");
+const Deps = require("./deps/defines");
+var http_1 = require("./http");
+Object.defineProperty(exports, "Http", { enumerable: true, get: function () { return http_1.Main; } });
+exports.DM = require("./dm");
+exports.utils = require("./utils");
+function Main(features) {
+    return (cnf) => {
+        const deps = {};
+        const modules = DM.auto(_.pick(Deps, features), deps, [cnf, deps]);
+        return modules;
+    };
+}
+exports.Main = Main;

package/dist/utils/index.d.ts

@@ -0,0 +1,36 @@
+/** 计算给定字符串的md5值 */
+export declare const md5: (str: {
+    toString: () => string;
+}) => string;
+/**
+ 生成随机字符串,
+ @type: "strong" 强壮型 包括特殊字符
+ @type: "normal" 普通型 不包括特殊字符
+ @type: 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: string): string;
+/** 将字符串里的换行，制表符替换为普通空格 */
+export declare const nt2space: (value: string) => string;
+/** 首字符大写 */
+export declare const ucfirst: (value: string) => string;
+/** 首字符小写 */
+export declare const lcfirst: (value: string) => string;
+/** 睡眠等待 */
+export declare const sleep: (ms: number) => Promise<unknown>;
+/** 深度冻结一个对象，防止被不小心篡改 */
+export declare const deepFreeze: <T>(object: T) => Readonly<T>;
+/** try catch 包裹执行, 记录错误日志 */
+declare type TryCatchLogFn = <T extends (...args: any[]) => Promise<void>, L extends (...args: any[]) => void>(fn: T, errorLog: L) => (...args: Parameters<T>) => Promise<void>;
+export declare const tryCatchLog: TryCatchLogFn;
+/**
+ 判断某个秒级时间戳是否已过期，基于当前时间
+ */
+export declare const inExpired: (time: number, life: number) => boolean;
+declare type Params = {
+    [K: string]: string;
+};
+/** 修改指定url上添加一些参数 */
+export declare const modifiyURL: (address: string, adds?: Params | undefined, removes?: string[] | undefined) => string;
+export {};

package/dist/utils/index.js

@@ -0,0 +1,84 @@
+"use strict";
+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;
+const crypto = require("crypto");
+/** 随机字符串字典 */
+const RAND_STR_DICT = {
+    normal: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
+    strong: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%&’()*+,-./:;<=>?@[]^_`{|}~",
+};
+/** 计算给定字符串的md5值 */
+const md5 = (str) => {
+    const hash = crypto.createHash("md5");
+    return hash.update(str.toString()).digest().toString("hex");
+};
+exports.md5 = md5;
+function randStr(len, type) {
+    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)
+        .fill("")
+        .map(() => dict[Math.floor(Math.random() * length)])
+        .join("");
+}
+exports.randStr = randStr;
+/** 将字符串里的换行，制表符替换为普通空格 */
+const nt2space = (value) => value.replace(/(\\[ntrfv]|\s)+/g, " ").trim();
+exports.nt2space = nt2space;
+/** 首字符大写 */
+const ucfirst = (value) => value[0].toUpperCase() + value.substring(1);
+exports.ucfirst = ucfirst;
+/** 首字符小写 */
+const lcfirst = (value) => value[0].toLowerCase() + value.substring(1);
+exports.lcfirst = lcfirst;
+/** 睡眠等待 */
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+exports.sleep = sleep;
+/** 深度冻结一个对象，防止被不小心篡改 */
+const deepFreeze = (object) => {
+    // Retrieve the property names defined on object
+    const propNames = Object.getOwnPropertyNames(object);
+    for (const name of propNames) {
+        const value = object[name];
+        if (value && typeof value === "object") {
+            (0, exports.deepFreeze)(value);
+        }
+    }
+    return Object.freeze(object);
+};
+exports.deepFreeze = deepFreeze;
+const tryCatchLog = (fn, errorLog) => async (...args) => {
+    try {
+        await fn(...args);
+    }
+    catch (e) {
+        errorLog(e);
+    }
+};
+exports.tryCatchLog = tryCatchLog;
+/**
+ 判断某个秒级时间戳是否已过期，基于当前时间
+ */
+const inExpired = (time, life) => {
+    const now = (Date.now() / 1000) | 0;
+    return time < now - life;
+};
+exports.inExpired = inExpired;
+/** 修改指定url上添加一些参数 */
+const modifiyURL = (address, adds, removes) => {
+    const obj = new URL(address);
+    if (typeof adds === "object") {
+        for (const key of Object.keys(adds)) {
+            obj.searchParams.append(key, adds[key]);
+        }
+    }
+    if (Array.isArray(removes)) {
+        for (const key of removes)
+            obj.searchParams.delete(key);
+    }
+    return obj.toString();
+};
+exports.modifiyURL = modifiyURL;

package/jest.config.js

@@ -0,0 +1,6 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  forceExit: true,
+};

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@domain.js/main",
+  "version": "0.1.0",
+  "description": "DDD framework",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "export NODE_ENV=test && jest ./src --coverage",
+    "test:watch": "export NODE_ENV=test && jest ./src --watch",
+    "prepare": "husky install",
+    "lint-staged": "lint-staged",
+    "lint-staged:js": "eslint --ext .js,.ts",
+    "loadDeps": "ts-node src/cli/index.ts loadDeps ./ ts"
+  },
+  "author": "Redstone Zhao",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/async": "^3.2.10",
+    "@types/crypto-js": "^4.0.2",
+    "@types/ioredis": "^4.28.1",
+    "@types/jest": "^27.0.3",
+    "@types/lodash": "^4.14.177",
+    "@types/lru-cache": "^5.1.1",
+    "@types/restify": "^8.5.4",
+    "@types/restify-errors": "^4.3.4",
+    "@types/uuid": "^8.3.3",
+    "@types/validator": "^13.7.0",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "babel-eslint": "^10.1.0",
+    "codecov": "^3.8.3",
+    "eslint": "^7.11.0",
+    "eslint-config-airbnb": "^18.2.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.3.1",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-react": "^7.21.4",
+    "husky": "^7.0.0",
+    "jest": "^27.3.1",
+    "lint-staged": "^11.0.0",
+    "prettier": "^2.3.0",
+    "sequelize-json-schema": "^2.1.1",
+    "ts-jest": "^27.0.7",
+    "typescript": "^4.5.2"
+  },
+  "prettier": {
+    "printWidth": 100,
+    "trailingComma": "all"
+  },
+  "lint-staged": {
+    "**/*.{js,ts}": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "dependencies": {
+    "ajv": "^8.8.1",
+    "ajv-formats": "^2.1.1",
+    "async": "^3.2.2",
+    "axios": "^0.24.0",
+    "cron-parser": "^4.1.0",
+    "crypto-js": "^4.1.1",
+    "csv-stringify": "^6.0.2",
+    "human-interval": "^2.0.1",
+    "ioredis": "^4.28.0",
+    "lodash": "^4.17.21",
+    "lru-cache": "^6.0.0",
+    "moment": "^2.29.1",
+    "mysql2": "^2.3.3",
+    "restify": "^8.6.0",
+    "restify-errors": "^8.0.2",
+    "sequelize": "^6.9.0",
+    "swagger-ui-restify": "^3.0.8",
+    "ts-node": "^10.4.0",
+    "uuid": "^8.3.2",
+    "xlsx": "^0.17.4"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "rootDir": "./src/"
+  },
+  "include": ["./"],
+  "exclude": ["./src/**/*.test.ts", "./src/**/samples/*", "node_modules", "dist"]
+}