@x-9lab/xlab 1.0.0 → 1.0.4-alpha.1

package/@types/components/{common.d.ts → common/index.d.ts}

@@ -1,5 +1,7 @@
 /// <reference types="node" />
+import { sleep, labelReplace, fix0, numberFormat } from "@x-drive/utils";
 import fs from "fs";
+export { labelReplace, fix0, numberFormat, sleep };
 /**
  * ascii字符串转为base64字符串
  * @param  str 要转化的字符串
@@ -22,56 +24,24 @@ export { base64Toascii };
  */
 declare function params(dat: Record<string, any>, url: string): string;
 export { params };
-/**
- * 按位数格式化数字
- * @param  val       要格式化的数字
- * @param  separator 分割符
- * @param  size      分割位数间隔
- * @return           格式化完的字符串
- */
-declare function numberFormat(val: number, separator: string, size: number): string;
-export { numberFormat };
-/**
- * 批量替换字符串中带花括号标签为指定数据
- * @param  tpl  待处理的字符串
- * @param  data 替换数据
- * @return      替换后端字符串
- */
-declare function labelReplace(tpl: string, data: Record<string, XLab.JsonValue>): string;
-/**
- * 批量替换字符串中带花括号标签为指定数据
- * @param  tpl  待处理的字符串
- * @param  data 替换数据
- * @return      替换后端字符串
- */
-declare function labelReplace(tpl: string, data: XLab.JsonValue): string;
-export { labelReplace };
-/**
- * 格式化数字, 自动补0前续
- * @param  number 要格式化的数字
- * @param  size   格式化后出来的数字位数
- * @return        格式化结果
- */
-declare function fix0(number: number, size: number): string;
-export { fix0 };
 /**
  * 格式化时间
  * @param  format 日期格式
- * @param  date   时间戳
+ * @param  ts     时间戳
  * @return        格式化后的时间
  */
 declare function date(format: string, ts: number): string;
 /**
  * 格式化时间
  * @param  format 日期格式
- * @param  date   日期字符串
+ * @param  ts     日期字符串
  * @return        格式化后的时间
  */
 declare function date(format: string, ts: string): string;
 /**
  * 格式化时间
  * @param  format 日期格式
- * @param  date   日期对象
+ * @param  ts     日期对象
  * @return        格式化后的时间
  */
 declare function date(format: string, ts: Date): string;
@@ -125,6 +95,7 @@ declare function promiseWapper(...args: any[]): Promise<unknown>;
 export { promiseWapper };
 /**
  * 封装一个 promise 形式的 request 方法
+ * @deprecated 请直接使用 component 中的 request 模块
  */
 declare function requestWapper<T = any>(...args: any[]): Promise<unknown>;
 export { requestWapper };

package/@types/components/html-processor/index.d.ts

@@ -1,5 +1,5 @@
 import type Koa from "koa";
-declare type RouteOption = Record<string, string | string[]>;
+declare type RouteOption = Record<string, string | string[] | Function>;
 interface HtmlProcessorOptions {
     route?: RouteOption;
 }

package/@types/components/index.d.ts

@@ -0,0 +1,42 @@
+/**内置组件 */
+interface InternalComponents {
+    /**资产 */
+    assets: typeof import("./assets");
+    /**缓存 */
+    cache: typeof import("./cache");
+    /**cluster */
+    cluster: typeof import("./cluster");
+    /**Http header 相关 */
+    header: typeof import("./header");
+    /**Html 内容处理器 */
+    "html-processor": typeof import("./html-processor");
+    /**JS 内容处理器 */
+    "js-processor": typeof import("./js-processor");
+    /**数据注入 */
+    injection: typeof import("./injection");
+    /**MD5 */
+    md5: typeof import("./md5");
+    /**MIME */
+    mime: typeof import("./mime");
+    /**客户端判断 */
+    platform: typeof import("./platform");
+    /**请求参数处理 */
+    querystring: typeof import("./querystring");
+    /**各种重定向方法 */
+    redirect: typeof import("./redirect");
+    /**简单的 uuid */
+    uuid: typeof import("./uuid");
+    /**版本比对 */
+    version: typeof import("./version");
+    /**定时任务 */
+    cron: typeof import("./cron");
+    /**日志 */
+    log: typeof import("./log");
+    /**业务返回码 */
+    "return-code": typeof import("./return-code");
+    /**通用工具函数集 */
+    common: typeof import("./common");
+    /**内部请求模块 */
+    request: typeof import("./request");
+}
+export type { InternalComponents };

package/@types/components/request/index.d.ts

@@ -0,0 +1,51 @@
+import type { RequestInit, Response } from "node-fetch";
+/**支持的返回数据类型 */
+declare type IFetchType = "text" | "json" | "blob" | "buffer" | "arrayBuffer";
+/**请求配置 */
+interface IFetchConfig extends Partial<Omit<RequestInit, "body" | "method">> {
+    /**数据返回类型 */
+    type?: IFetchType;
+    /**是否强制同源 */
+    sameOrigin?: boolean;
+    /**请求自动重试次数 */
+    retry?: number;
+    /**自动重试间隔时间 */
+    retryDelay?: number;
+    /**是否自动追加随机数retry，默认 false */
+    random?: boolean;
+    /**数据返回时的钩子 */
+    onResponse?: (res?: Response) => Promise<unknown>;
+}
+export type { IFetchConfig };
+/**给指定对象增加一个随机字符串 */
+declare function setRandomStr(query: any): void;
+export { setRandomStr };
+/**设置默认 Headers */
+declare function setDefHeaders(headers: Record<string, any>): void;
+export { setDefHeaders };
+/**
+ * 获取数据
+ * @param type              请求类型
+ * @param uri               请求地址
+ * @param query             请求参数
+ * @param data              发送数据
+ * @param config            请求配置
+ * @param needProcessConfig 是否需要处理配置
+ */
+declare function httpFetch<T = unknown>(type: string, uri: string, query?: Record<string, any>, data?: any, config?: IFetchConfig, retry?: number, needProcessConfig?: boolean): Promise<T>;
+export { httpFetch as fetch };
+/**
+ * 发起一个 get 请求
+ * @param uri   请求地址
+ * @param query 请求参数
+ */
+declare function requsetGet<T = unknown>(uri: string, query?: Record<string, any>, config?: IFetchConfig): Promise<T>;
+export { requsetGet as get };
+/**
+ * 发起一个 post 请求
+ * @param uri   请求地址
+ * @param query 请求参数
+ * @param data  请求数据
+ */
+declare function requestPost<T>(uri: string, query?: any, data?: any, config?: IFetchConfig): Promise<T>;
+export { requestPost as post };

package/@types/components/request/resolve-uri.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 解析请求别名
+ * @param uri 请求地址
+ */
+declare function resolve(uri: string): string;
+export default resolve;

package/@types/components/uuid/index.d.ts

@@ -1,3 +1,5 @@
+/**当前机器的 mac */
+export declare const X_MAC: string;
 /**
  * 生成一个 uuid
  * @param one 第一节数据

package/@types/default-x-config.d.ts

@@ -0,0 +1,6 @@
+declare class Config {
+    get businessDir(): string;
+    set businessDir(val: string);
+}
+declare const _default: Config;
+export default _default;

package/@types/global.d.ts

@@ -1,27 +1,6 @@
+import type { InternalComponents } from "./components";
 export type { IPlat } from "./components/platform";
 import type Koa from "koa";
-/**内置组件 */
-interface InternalComponents {
-    assets: typeof import("./components/assets");
-    cache: typeof import("./components/cache");
-    cluster: typeof import("./components/cluster");
-    combo: typeof import("./components/combo");
-    header: typeof import("./components/header");
-    "html-processor": typeof import("./components/html-processor");
-    injection: typeof import("./components/injection");
-    "js-processor": typeof import("./components/js-processor");
-    md5: typeof import("./components/md5");
-    mime: typeof import("./components/mime");
-    platform: typeof import("./components/platform");
-    querystring: typeof import("./components/querystring");
-    redirect: typeof import("./components/redirect");
-    uuid: typeof import("./components/uuid");
-    version: typeof import("./components/version");
-    cron: typeof import("./components/cron");
-    log: typeof import("./components/log");
-    "return-code": typeof import("./components/return-code");
-    common: typeof import("./components/common");
-}
 declare global {
     /**全局日志对象 */
     var log: any;
@@ -137,6 +116,10 @@ declare global {
             strictSSL?: boolean;
             /**页端注入的 api 设置 */
             apis?: Record<string, string>;
+            /**内部服务域名 */
+            internalServers?: Record<string, string>;
+            /**内部服务地址 */
+            internalApis?: Record<string, string>;
             /**服务 ip 地址 */
             ip?: string;
             /**本地是否存在本地开发配置文件 config.lo.json */
@@ -181,5 +164,15 @@ declare global {
         }
         /**业务错误定义 */
         type ICodeDetail = Record<string, ICodeItem>;
+        /**模块配置 */
+        interface XConfig {
+            /**watch 模式配置 */
+            watch?: {
+                /**是否启用 watch */
+                enable: boolean;
+            };
+            /**服务端业务目录，默认是 @server */
+            businessDir?: string;
+        }
     }
 }

package/README.md

@@ -14,6 +14,10 @@ X-9lab 通用服务端
         }
     }
     ```
+- 配置文件 `xlab.config.js`
+    模块会自动检测执行根目录中是否存在 `xlab.config.js` 文件。如存在该文件则会使用该文件为模块的启动配置文件。支持的配置项：
+    1. `watch` 是否开启 watch 模式
+    1. `business` 业务目录名称。注意当前只支持根目录下的文件夹
 - `watch` 模式
     `xlab` 支持自动重启业务，开发中使用该功能可以减少大量手动重启业务的操作。
     启用方式：
@@ -96,14 +100,55 @@ X-9lab 通用服务端
     function setSysConfig(conf: XLab.IConfig): void;
     ```
 - `requireModel` 全局获取 model 的方法
+    该方法只是为获取 model 提供一个快捷方式，也可以通过正常的方式去 require
+    - 存放路径 `business/@models`
+    - 使用方式
+        ```js
+        const { testModel } = requireModel("test");
+        ```
+    - 类型支持
+        由于 `requireModel` 是一个 `xlab` 的内置方法没有业务本身的 model 定义，因此需要业务方自行追加。出于管理方面的考虑，建议将所有的 model 定义放在一个文件中
+        ```ts
+        declare global {
+            namespace XLab {
+                interface IModels {
+                    /**测试 model */
+                    test: typeof import("./business/@models/test");
+                }
+            }
+        }
+        export { }
+        ```
 - `requireService` 全局获取 service 的方法
+    该方法只是为获取 service 提供一个快捷方式，也可以通过正常的方式去 require
+    - 存放路径 `business/@services`
+    - 使用方式
+        ```js
+        const { testFn } = requireService("test");
+        ```
+    - 类型支持
+        由于 `requireService` 是一个 `xlab` 的内置方法没有业务本身的 service 定义，因此需要业务方自行追加。出于管理方面的考虑，建议将所有的 service 定义放在一个文件中
+        ```ts
+        declare global {
+            namespace XLab {
+                interface IServices {
+                    /**测试 model */
+                    test: typeof import("./business/@services/test");
+                }
+            }
+        }
+        export { }
+        ```
 
 #### Namespace `XLab`
 `XLab` 提供了一些标准化的定义及系统配置
 - `IStdRes` 标准返回数据
 - `IConfig` 系统配置对象
+    - 外部模块追加配置项
 - `ICodeItem` 错误信息对象
 - `ICodeDetail` 错误定义
+- `IServices` 业务 services 定义
+- `IModels` 业务 model 定义
 
 ### 配置项
 |名称|类型|默认值|说明|

package/dist/bin/watch.js

@@ -1,4 +1,5 @@
 "use strict";
+const XConfig = require("../default-x-config");
 const { date  } = require("@x-drive/utils");
 const crossSpawn = require("cross-spawn");
 const colors = require("colors/safe");
@@ -107,7 +108,7 @@ const fs = require("fs");
         if (chokidar) {
             if (!config.paths) {
                 // 默认业务自定义服务端业务文件夹
-                const customDir = path.resolve(process.cwd(), "@server");
+                const customDir = path.resolve(process.cwd(), XConfig.businessDir);
                 config.paths = [
                     customDir
                 ];

package/dist/bin/xlab

@@ -1,14 +1,15 @@
 #!/usr/bin/env node
 
 const argv = require("minimist")(process.argv.slice(2));
-const { merge } = require("@x-drive/utils");
+const { merge, isString } = require("@x-drive/utils");
+const XConfig = require("../default-x-config").default;
 const Liftoff = require("liftoff");
 
 const cli = new Liftoff({
     "name": "x-lab"
     , "processTitle": "X Lab"
     , "moduleName": "xlab"
-    , "configName": "xlab-config"
+    , "configName": "xlab.config"
     , "extensions": {
         ".js": null
     }
@@ -16,34 +17,42 @@ const cli = new Liftoff({
 
 const hasWatch = argv.w || argv.watch;
 
-cli.launch(
+function onLaunch(env) {
+    /**@type {XLab.XConfig} */
+    let config = {
+        "watch": {
+            "enable": false
+        }
+    }
+    if (env.configPath) {
+        try {
+            let customConfig = require(env.configPath);
+            if (customConfig) {
+                merge(config, customConfig);
+            }
+        } catch (e) { }
+    }
+    if (isString(config.businessDir)) {
+        XConfig.businessDir = config.businessDir;
+    }
+    if (hasWatch) {
+        config.watch.enable = true;
+    }
+    if (config.watch && config.watch.enable) {
+        const watch = require("./watch");
+        watch(config.watch);
+    } else {
+        const server = require("../server");
+        server.boot();
+    }
+}
+
+cli.prepare(
     {
         "cwd": argv.r || argv.root
         , "configPath": argv.f || argv.file
     }
     , function (env) {
-        let config = {
-            "watch": {
-                "enable": false
-            }
-        }
-        if (env.configPath) {
-            try {
-                let customConfig = require(env.configPath);
-                if (customConfig) {
-                    merge(config, customConfig);
-                }
-            } catch (e) { }
-        }
-        if (hasWatch) {
-            config.watch.enable = true;
-        }
-        if (config.watch && config.watch.enable) {
-            const watch = require("./watch");
-            watch(config.watch);
-        } else {
-            const server = require("../server");
-            server.boot();
-        }
+        cli.execute(env, onLaunch);
     }
 );

package/dist/components/{common.js → common/index.js}

@@ -9,12 +9,13 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    labelReplace: ()=>_utils.labelReplace,
+    fix0: ()=>_utils.fix0,
+    numberFormat: ()=>_utils.numberFormat,
+    sleep: ()=>_utils.sleep,
     asciiTobase64: ()=>asciiTobase64,
     base64Toascii: ()=>base64Toascii,
     params: ()=>params,
-    numberFormat: ()=>numberFormat,
-    labelReplace: ()=>labelReplace,
-    fix0: ()=>fix0,
     date: ()=>date,
     responseResult: ()=>responseResult,
     getMD5: ()=>getMD5,
@@ -28,10 +29,9 @@ _export(exports, {
     checkFileStat: ()=>checkFileStat,
     getRealDefaultMod: ()=>getRealDefaultMod
 });
-const _returnCode = require("./return-code");
 const _utils = require("@x-drive/utils");
+const _returnCode = require("../return-code");
 const _querystring = /*#__PURE__*/ _interopRequireDefault(require("querystring"));
-const _request = /*#__PURE__*/ _interopRequireDefault(require("request"));
 const _crypto = /*#__PURE__*/ _interopRequireDefault(require("crypto"));
 const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
 const _fs = /*#__PURE__*/ _interopRequireDefault(require("fs"));
@@ -41,6 +41,12 @@ function _interopRequireDefault(obj) {
     };
 }
 var logger;
+function checkLogger() {
+    if (!logger) {
+        logger = log.getLogger("common");
+    }
+    return logger;
+}
 /**
  * ascii字符串转为base64字符串
  * @param  str 要转化的字符串
@@ -73,73 +79,11 @@ var logger;
     }
     return data;
 }
-/**
- * 按位数格式化数字
- * @param  val       要格式化的数字
- * @param  separator 分割符
- * @param  size      分割位数间隔
- * @return           格式化完的字符串
- */ function numberFormat(val, separator, size) {
-    if (typeof val !== "number") {
-        return "0";
-    }
-    if (!separator) {
-        separator = ",";
-    }
-    if (!size) {
-        size = 3;
-    }
-    var last = size;
-    const valStr = val.toString();
-    var pos = valStr.indexOf(".");
-    var res = "";
-    if (pos === -1) {
-        pos = valStr.length;
-    } else {
-        res = valStr.substr(pos);
-    }
-    if (valStr.charAt(0) === "-") {
-        last++;
-    }
-    while(pos > last){
-        pos -= size;
-        res = separator + valStr.substr(pos, size) + res;
-    }
-    if (pos) {
-        res = valStr.substr(0, pos) + res;
-    }
-    return res;
-}
-/**
- * 带花括号标签检测正则
- */ const labelReplaceExp = /\{(\w+)\}/g;
-/**
- * 批量替换字符串中带花括号标签为指定数据
- * @param  tpl  待处理的字符串
- * @param  data 替换数据
- * @return      替换后端字符串
- */ function labelReplace(tpl, data) {
-    return tpl.replace(labelReplaceExp, function(label, key) {
-        return typeof data === "object" ? data[key] : data;
-    });
-}
-/**
- * 格式化数字, 自动补0前续
- * @param  number 要格式化的数字
- * @param  size   格式化后出来的数字位数
- * @return        格式化结果
- */ function fix0(number, size) {
-    var num = number.toString();
-    while(num.length < size){
-        num = "0" + num;
-    }
-    return num;
-}
 const format_exp = /[YymndjNwaAghGHis]/g;
 /**
  * 格式化时间
  * @param  format 日期格式
- * @param  date   日期数据(时间戳, 字符串)
+ * @param  ts     日期数据(时间戳, 字符串)
  * @return        格式化后的时间
  */ function date(format, ts) {
     ts = new Date(ts);
@@ -150,11 +94,11 @@ const format_exp = /[YymndjNwaAghGHis]/g;
             case "y":
                 return ts.getFullYear() % 100;
             case "m":
-                return fix0(ts.getMonth() + 1, 2);
+                return (0, _utils.fix0)(ts.getMonth() + 1, 2);
             case "n":
                 return ts.getMonth() + 1;
             case "d":
-                return fix0(ts.getDate(), 2);
+                return (0, _utils.fix0)(ts.getDate(), 2);
             case "j":
                 return ts.getDate();
             case "N":
@@ -168,15 +112,15 @@ const format_exp = /[YymndjNwaAghGHis]/g;
             case "g":
                 return ts.getHours() % 12 + 1;
             case "h":
-                return fix0(ts.getHours() % 12 + 1, 2);
+                return (0, _utils.fix0)(ts.getHours() % 12 + 1, 2);
             case "G":
                 return ts.getHours();
             case "H":
-                return fix0(ts.getHours(), 2);
+                return (0, _utils.fix0)(ts.getHours(), 2);
             case "i":
-                return fix0(ts.getMinutes(), 2);
+                return (0, _utils.fix0)(ts.getMinutes(), 2);
             case "s":
-                return fix0(ts.getSeconds(), 2);
+                return (0, _utils.fix0)(ts.getSeconds(), 2);
         }
         return tag;
     });
@@ -241,16 +185,10 @@ const format_exp = /[YymndjNwaAghGHis]/g;
 }
 /**
  * 封装一个 promise 形式的 request 方法
+ * @deprecated 请直接使用 component 中的 request 模块
  */ function requestWapper(...args) {
-    return new Promise(function(resolve, reject) {
-        args.push(function(err, res, body) {
-            if (err) {
-                reject(err);
-            } else {
-                resolve(body);
-            }
-        });
-        _request.default.apply(_request.default, args);
+    return new Promise(function(_, reject) {
+        reject(new Error("请直接使用 component 中的 request 模块"));
     });
 }
 /**
@@ -262,9 +200,7 @@ const format_exp = /[YymndjNwaAghGHis]/g;
     try {
         re = JSON.parse(data);
     } catch (err) {
-        if (!logger) {
-            log.getLogger("common");
-        }
+        checkLogger();
         logger.error("Pares create menu return data fail.", data);
         return null;
     }

package/dist/components/html-processor/index.js

@@ -39,7 +39,7 @@ function processorVar(html, req) {
 //   设置缓存头
 //   根据配置设置相应头部
 function htmlProcessor(pathname, options, context) {
-    var filename = _path.default.resolve(conf.root + pathname);
+    var filename = _path.default.resolve(conf.root, pathname);
     // ua = req.get('user-agent'),
     var cacheKey;
     var html;
@@ -55,11 +55,11 @@ function htmlProcessor(pathname, options, context) {
     try {
         html = html_cache.get(cacheKey);
         if (!html) {
-            html = _fs.default.readFileSync(filename, 'utf8');
+            html = _fs.default.readFileSync(filename, "utf8");
             html_cache.set(cacheKey, html);
         }
     } catch (e) {
-        logger.error('HTML Process Error', e);
+        logger.error("HTML Process Error", e);
         return null;
     }
     // 无法正确读取 HTML
@@ -79,7 +79,7 @@ function htmlProcessor(pathname, options, context) {
         Object.keys(headers).forEach((key)=>{
             let val;
             if ((0, _utils.isFunction)(headers[key])) {
-                val = headers[key].call();
+                val = headers[key]();
             } else {
                 val = headers[key];
             }

package/dist/components/index.js

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