@domain.js/main 0.1.0 → 0.1.1

package/dist/deps/signer/index.js

@@ -2,35 +2,58 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Deps = exports.Main = void 0;
 const crypto = require("crypto");
+/**
+ * API interface encryption signature algorithm module, based on sha256
+ * @returns generator And request Methods
+ */
 function Main() {
-    const generator = (opt, secret) => {
-        const string = Object.keys(opt)
-            .map((k) => `${k}=${encodeURIComponent(opt[k])}`)
-            .sort()
-            .join("&");
-        const h = crypto.createHmac("sha256", secret);
-        return h.update(string).digest("base64");
+    /**
+     * API interface encryption signature algorithm module, based on sha256
+     */
+    const returns = {
+        /**
+         * Core encryption algorithm, the result is returned as Base64 string
+         * @param opt Objects to be encrypted
+         * @param secret Calculate the private key of the signature
+         * @returns The result of the signature is in the format of Base64 string
+         */
+        generator(opt, secret) {
+            const string = Object.keys(opt)
+                .map((k) => `${k}=${encodeURIComponent(opt[k])}`)
+                .sort()
+                .join("&");
+            const h = crypto.createHmac("sha256", secret);
+            return h.update(string).digest("base64");
+        },
+        /**
+         * Get all the signature encryption information required for a request
+         * @param uri The URI does not contain the root path part
+         * @param method Method name of the request interface, internal domain method name not HTTP verb
+         * @param key Key for signature calculation
+         * @param secret Calculate the private key of the signature
+         * @returns
+         */
+        request(uri, method, key, secret) {
+            const opt = {
+                uri,
+                key,
+                timestamp: (Date.now() / 1000) | 0,
+                signMethod: "HmacSHA256",
+                signVersion: "1",
+                method,
+            };
+            const signature = returns.generator(opt, secret);
+            return {
+                "x-auth-signature": signature,
+                "x-auth-key": key,
+                "x-auth-method": method,
+                "x-auth-timestamp": opt.timestamp,
+                "x-auth-sign-method": opt.signMethod,
+                "x-auth-sign-version": opt.signVersion,
+            };
+        },
     };
-    const request = (uri, method, key, secret) => {
-        const opt = {
-            uri,
-            key,
-            timestamp: (Date.now() / 1000) | 0,
-            signMethod: "HmacSHA256",
-            signVersion: "1",
-            method,
-        };
-        const signature = generator(opt, secret);
-        return {
-            "x-auth-signature": signature,
-            "x-auth-key": key,
-            "x-auth-method": method,
-            "x-auth-timestamp": opt.timestamp,
-            "x-auth-sign-method": opt.signMethod,
-            "x-auth-sign-version": opt.signVersion,
-        };
-    };
-    return { generator, request };
+    return returns;
 }
 exports.Main = Main;
 exports.Deps = [];

package/dist/dm/index.d.ts

@@ -5,8 +5,23 @@ interface ModuleInterface {
     After?: (...args: any[]) => void;
 }
 declare type ModuleFn = (((...args: any[]) => any) | {}) & ModuleInterface;
+/**
+ * Initialize a module
+ * @param Main The function is module main function
+ * @param Before The function is module before hook
+ * @param After The function is module after hook
+ * @param _args The array is module function arguments
+ * @returns Main function returns
+ */
 export declare function exec<Args extends any[], BeforeFn extends (...args: Args) => any[], MainFn extends (...args: ReturnType<BeforeFn>) => any, AfterFn extends (main: ReturnType<MainFn>, ...args: ReturnType<BeforeFn>) => void>(Main: MainFn, Before?: BeforeFn, After?: AfterFn | undefined, _args?: Args): ReturnType<MainFn>;
+/**
+ * Automatically initialize a series of modules
+ * @param modules The Object that key is name of module, value is module
+ * @param deps This object is used to receive the object after module initialization
+ * @param args This array is used to initialize each module
+ * @returns Objects after initialization of all modules merged into deps
+ */
 export declare function auto<Modules extends {
     [k in string]: ModuleFn;
-}, Deps extends object, Args extends any[]>(modules: Modules, deps: Deps, args: Args): { [k in keyof Modules]: ReturnType<Modules[k]["Main"]>; };
+}, Deps extends object, Args extends any[]>(modules: Modules, deps: Deps, args: Args): { [k in keyof Modules]: ReturnType<Modules[k]["Main"]>; } & Deps;
 export {};

package/dist/dm/index.js

@@ -2,6 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auto = exports.exec = void 0;
 const _ = require("lodash");
+/**
+ * Initialize a module
+ * @param Main The function is module main function
+ * @param Before The function is module before hook
+ * @param After The function is module after hook
+ * @param _args The array is module function arguments
+ * @returns Main function returns
+ */
 function exec(Main, Before = ((...args) => args), After = undefined, _args = []) {
     const args = Before(..._args);
     const main = Main(...args);
@@ -10,6 +18,13 @@ function exec(Main, Before = ((...args) => args), After = undefined, _args = [])
     return main;
 }
 exports.exec = exec;
+/**
+ * Automatically initialize a series of modules
+ * @param modules The Object that key is name of module, value is module
+ * @param deps This object is used to receive the object after module initialization
+ * @param args This array is used to initialize each module
+ * @returns Objects after initialization of all modules merged into deps
+ */
 function auto(modules, deps, args) {
     // 获取全部即将初始化的模块名称，此时的 modules 是扁平的一级结构
     const names = new Set(Object.keys(modules));

package/dist/errors/index.d.ts

@@ -0,0 +1,16 @@
+export interface MyError {
+    message: string;
+    code?: string | number;
+    data?: any;
+}
+export interface ErrorFn {
+    (...args: any): MyError;
+}
+declare type RemoveReadonlyArray<T extends readonly any[]> = T extends readonly (infer A)[] ? A extends readonly [infer key, any] ? key : never : never;
+/**
+ * Convert error configuration to errors function
+ * @param defines error configuration
+ * @returns errors function
+ */
+export declare function Errors<T extends ReadonlyArray<readonly [string, string]>>(defines: T): Record<RemoveReadonlyArray<T>, ErrorFn>;
+export {};

package/dist/errors/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Errors = void 0;
+/**
+ * Convert error configuration to errors function
+ * @param defines error configuration
+ * @returns errors function
+ */
+function Errors(defines) {
+    const errors = {};
+    for (const [code, msg] of defines) {
+        errors[code] = (...args) => {
+            if (Array.isArray(args) && args.length === 1) {
+                const [first] = args;
+                // 只有一个参数且，参数已经是一个封装后的
+                if (first && first.code)
+                    return first;
+            }
+            return Object.assign(new Error(msg), {
+                code,
+                data: args,
+            });
+        };
+    }
+    return errors;
+}
+exports.Errors = Errors;

package/dist/errors.d.ts

@@ -0,0 +1 @@
+export declare const errors: Readonly<Record<"notFound" | "notAllowed" | "noAuth", import("./Errors/index").ErrorFn>>;

package/dist/errors.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errors = void 0;
+const index_1 = require("./Errors/index");
+const defines = [
+    ["notFound", "Resource not found"],
+    ["notAllowed", "No access"],
+    ["noAuth", "Not authentication"],
+];
+exports.errors = Object.freeze((0, index_1.Errors)(defines));

package/dist/http/defines.d.ts

@@ -0,0 +1,45 @@
+export interface Cnf {
+    proxyIps?: string;
+    port?: number;
+    host?: string;
+    bodyMaxBytes?: number;
+    apisRoute?: string;
+    swaggerApiPath?: string;
+    [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;
+    realIp: string;
+    userAgent: string;
+    startedAt: Date;
+    requestId: string;
+    revision?: string;
+    uuid?: string;
+    token?: string;
+    sign?: Sign;
+}
+export interface HttpCodes {
+    [propName: string]: number;
+}
+interface _Domain {
+    [propName: string]: (profile: Profile, params: any) => any | _Domain;
+}
+export declare type Domain = _Domain & {
+    _getSchemaByPath(methodPath: string): [any, any];
+};
+export interface Err {
+    message: string;
+    code?: number | string;
+    data?: any;
+}
+export {};

package/dist/http/defines.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1,7 +1,11 @@
+import { Defaults } from "./defaults";
 import Deps = require("./deps/defines");
 export { Main as Http } from "./http";
+export { Errors } from "./Errors";
 export * as DM from "./dm";
 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> = {
     [k in keyof T]: T[k];
@@ -13,7 +17,6 @@ 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");
@@ -23,14 +26,14 @@ export declare function Main<T extends Readonly<Array<keyof TDeps>>>(features: T
     hash: typeof import("./deps/hash");
     logger: typeof import("./deps/logger");
     parallel: typeof import("./deps/parallel");
-    redis: typeof import("./deps/redis");
+    redis: typeof import("./deps/redis"); /** 模块名称联合类型 */
+    request: typeof import("./deps/request");
     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<{
+}[Include<"schema", RemoveReadonlyArray<T>> | Include<"logger", RemoveReadonlyArray<T>> | Include<"aes", RemoveReadonlyArray<T>> | Include<"request", RemoveReadonlyArray<T>> | Include<"sequelize", RemoveReadonlyArray<T>> | Include<"cache", RemoveReadonlyArray<T>> | Include<"redis", RemoveReadonlyArray<T>> | Include<"rest", RemoveReadonlyArray<T>> | Include<"parallel", RemoveReadonlyArray<T>> | Include<"graceful", RemoveReadonlyArray<T>> | Include<"cia", RemoveReadonlyArray<T>> | Include<"counter", RemoveReadonlyArray<T>> | Include<"cron", RemoveReadonlyArray<T>> | Include<"hash", 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");
@@ -40,14 +43,14 @@ export declare function Main<T extends Readonly<Array<keyof TDeps>>>(features: T
     hash: typeof import("./deps/hash");
     logger: typeof import("./deps/logger");
     parallel: typeof import("./deps/parallel");
-    redis: typeof import("./deps/redis");
+    redis: typeof import("./deps/redis"); /** 模块名称联合类型 */
+    request: typeof import("./deps/request");
     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");
@@ -57,9 +60,10 @@ export declare function Main<T extends Readonly<Array<keyof TDeps>>>(features: T
     hash: typeof import("./deps/hash");
     logger: typeof import("./deps/logger");
     parallel: typeof import("./deps/parallel");
-    redis: typeof import("./deps/redis");
+    redis: typeof import("./deps/redis"); /** 模块名称联合类型 */
+    request: typeof import("./deps/request");
     rest: typeof import("./deps/rest");
     schema: typeof import("./deps/schema");
     sequelize: typeof import("./deps/sequelize");
     signer: typeof import("./deps/signer");
-}, RemoveReadonlyArray<T>>[k]["Main"]>; };
+}, RemoveReadonlyArray<T>>[k]["Main"]>; } & Defaults;

package/dist/index.js

@@ -1,17 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Main = exports.utils = exports.DM = exports.Http = void 0;
-const _ = require("lodash");
+exports.Main = exports.basicErrors = exports.Cfg = exports.utils = exports.DM = exports.Errors = exports.Http = void 0;
+const defaults_1 = require("./defaults");
 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; } });
+var Errors_1 = require("./Errors");
+Object.defineProperty(exports, "Errors", { enumerable: true, get: function () { return Errors_1.Errors; } });
 exports.DM = require("./dm");
 exports.utils = 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;
     return (cnf) => {
-        const deps = {};
-        const modules = DM.auto(_.pick(Deps, features), deps, [cnf, deps]);
+        /** 这里之所以要浅拷贝，是为了避免多次初始化之间互相干扰 */
+        const _deps = { ...defaults_1.defaults };
+        const modules = DM.auto(_.pick(Deps, features) /** 要启用的内部模块 */, _deps /** 初始的模块依赖对象 */, [cnf, _deps] /** 内部模块初始化参数 */);
         return modules;
     };
 }

package/dist/npms.d.ts

@@ -0,0 +1,88 @@
+import * as _ from "lodash";
+import * as uuid from "uuid";
+import * as ajv from "ajv";
+import * as ajvFormats from "ajv-formats";
+import * as async from "async";
+import * as axios from "axios";
+import * as cronParser from "cron-parser";
+import humanInterval = require("human-interval");
+import * as IORedis from "ioredis";
+import * as LRU from "lru-cache";
+import * as mysql from "mysql2";
+import * as Sequelize from "sequelize";
+import * as moment from "moment";
+/** npm packages injection */
+export interface MDeps {
+    /**
+     * The Lodash library exported as Node.js modules.
+     * @link https://www.npmjs.com/package/lodash
+     */
+    _: typeof _;
+    /**
+     * For the creation of RFC4122 UUIDs
+     * @link https://www.npmjs.com/package/uuid
+     */
+    uuid: typeof uuid;
+    /**
+     * Ajv JSON schema validator
+     * @link https://www.npmjs.com/package/ajv
+     */
+    ajv: typeof ajv;
+    /**
+     * JSON Schema formats for Ajv
+     * @link https://www.npmjs.com/package/ajv-formats
+     */
+    ajvFormats: typeof ajvFormats;
+    /**
+     * Async is a utility module which provides straight-forward
+     * powerful functions for working with asynchronous JavaScript.
+     * @link https://www.npmjs.com/package/async
+     */
+    async: typeof async;
+    /**
+     * Promise based HTTP client for the browser and node.js
+     * @Link https://www.npmjs.com/package/axios
+     */
+    axios: typeof axios;
+    /**
+     * Node.js library for parsing and manipulating crontab instructions.
+     * It includes support for timezones and DST transitions.
+     * @link https://www.npmjs.com/package/cron-parser
+     */
+    cronParser: typeof cronParser;
+    /**
+     * Human-readable interval parser for Javascript.
+     * @link https://www.npmjs.com/package/human-interval
+     */
+    humanInterval: typeof humanInterval;
+    /**
+     * A robust, performance-focused and full-featured Redis client for Node.js.
+     * @link https://www.npmjs.com/package/ioredis
+     */
+    IORedis: typeof IORedis;
+    /**
+     * A cache object that deletes the least-recently-used items.
+     * https://www.npmjs.com/package/lru-cache
+     */
+    LRU: typeof LRU;
+    /**
+     * MySQL client for Node.js with focus on performance.
+     * Supports prepared statements, non-utf8 encodings,
+     * binary log protocol, compression, ssl much more
+     * @link https://www.npmjs.com/package/mysql2
+     */
+    mysql: typeof mysql;
+    /**
+     * Sequelize is a promise-based Node.js ORM tool for Postgres, MySQL, MariaDB,
+     *  SQLite and Microsoft SQL Server.
+     * It features solid transaction support, relations,
+     *  eager and lazy loading, read replication and more.
+     * @link https://www.npmjs.com/package/sequelize
+     */
+    Sequelize: typeof Sequelize;
+    /**
+     * A JavaScript date library for parsing, validating, manipulating, and formatting dates.
+     */
+    moment: typeof moment;
+}
+export declare const deps: MDeps;

package/dist/npms.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deps = void 0;
+const _ = require("lodash");
+const uuid = require("uuid");
+const ajv = require("ajv");
+const ajvFormats = require("ajv-formats");
+const async = require("async");
+const axios = require("axios");
+const cronParser = require("cron-parser");
+const humanInterval = require("human-interval");
+const IORedis = require("ioredis");
+const LRU = require("lru-cache");
+const mysql = require("mysql2");
+const Sequelize = require("sequelize");
+const moment = require("moment");
+exports.deps = {
+    _,
+    uuid,
+    ajv,
+    ajvFormats,
+    async,
+    axios,
+    cronParser,
+    humanInterval,
+    IORedis,
+    LRU,
+    mysql,
+    Sequelize,
+    moment,
+};

package/dist/utils/index.d.ts

@@ -1,36 +1,78 @@
-/** 计算给定字符串的md5值 */
+/**
+ * Calculates the MD5 value of the given string
+ * @param str string or An object that contains a toString method that returns a string
+ * @returns hex md5 string
+ */
 export declare const md5: (str: {
     toString: () => string;
 }) => string;
 /**
- 生成随机字符串,
- @type: "strong" 强壮型 包括特殊字符
- @type: "normal" 普通型 不包括特殊字符
- @type: string 随机串字典手动指定
-*/
+ * Return random string
+ * @param len string length
+ * @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: string): string;
-/** 将字符串里的换行，制表符替换为普通空格 */
+/**
+ * Replace line breaks and tabs in the string with ordinary spaces
+ * @param value string that will be replaced
+ * @returns has been replaced string
+ */
 export declare const nt2space: (value: string) => string;
-/** 首字符大写 */
+/**
+ * The first character of the string is capitalized
+ * @param value string
+ * @returns string
+ * @example ufrist("hello"); // Return a string is: "Hello"
+ * @see lcfirst
+ */
 export declare const ucfirst: (value: string) => string;
-/** 首字符小写 */
+/**
+ * The first character of the string is lowercase
+ * @param value string
+ * @returns string
+ * @example ufrist("Hello"); // Return a string is: "hello"
+ * @see ucfirst
+ */
 export declare const lcfirst: (value: string) => string;
-/** 睡眠等待 */
+/**
+ * Pause, waiting
+ * @param ms The time you want to wait, in milliseconds
+ * @returns None
+ */
 export declare const sleep: (ms: number) => Promise<unknown>;
-/** 深度冻结一个对象，防止被不小心篡改 */
+/**
+ * Freeze a object and deepth
+ * @param object The object that will be freezed
+ * @returns freezed object
+ */
 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>;
+/**
+ * Mask exceptions of functions
+ * @param fn The function will be mask exceptions
+ * @param errorLog Error handle function, when has happed throw exception
+ * @returns Wrapped function
+ */
 export declare const tryCatchLog: TryCatchLogFn;
 /**
- 判断某个秒级时间戳是否已过期，基于当前时间
+ * Determine whether a second timestamp has expired
+ * @param time timestamp
+ * @param life Effective time, seconds
+ * @returns true or false
  */
 export declare const inExpired: (time: number, life: number) => boolean;
 declare type Params = {
     [K: string]: string;
 };
-/** 修改指定url上添加一些参数 */
+/**
+ * Modify a URL address, add some attributes and delete some attributes
+ * @param address URL address
+ * @param adds The params will be expand to address
+ * @param removes The string list will be remove from address
+ * @returns Modified address
+ */
 export declare const modifiyURL: (address: string, adds?: Params | undefined, removes?: string[] | undefined) => string;
 export {};