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

package/@types/@config/config.d.ts

@@ -0,0 +1,2 @@
+declare const CONFIG: XLab.IConfig;
+export default CONFIG;

package/@types/@config/config.dev.d.ts

@@ -0,0 +1,2 @@
+declare const CONFIG: XLab.IConfig;
+export default CONFIG;

package/@types/@config/config.sand.d.ts

@@ -0,0 +1,2 @@
+declare const CONFIG: XLab.IConfig;
+export default CONFIG;

package/@types/business/utils/cookie/1.1.0/clean/index.d.ts

@@ -0,0 +1,3 @@
+import type Koa from "koa";
+declare function onClean(ctx: Koa.Context): void;
+export default onClean;

package/@types/business/utils/cookie/1.1.0/clean/js/index.d.ts

@@ -0,0 +1,2 @@
+declare function onJsClean(ctx: any): void;
+export default onJsClean;

package/@types/cluster.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+import type { Server } from "http";
+/**尝试以 cluster 模式启动服务 */
+declare function start(): Server;
+export default start;

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

@@ -0,0 +1,7 @@
+/**
+ * 获取资源
+ * @param   name  资源名称
+ * @return        资源
+ */
+declare function get(name: string): string;
+export { get };

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

@@ -0,0 +1,2 @@
+import { create } from "./lru";
+export { create as local };

package/@types/components/cache/lru.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 生成或获取一个缓存实例
+ * @param  cacheName 实例名称
+ * @param  conf      缓存配置，仅在生成的时候有效
+ * @return           缓存实例
+ */
+declare function create(cacheName: string, conf: Record<string, XLab.JsonValue>): any;
+export { create };
+/**
+ * 获取一个缓存实例
+ * @param name 缓存名称
+ * @param conf 缓存配置
+ */
+declare function get(name: string, conf?: Record<string, XLab.JsonValue>): any;
+export { get };
+/**
+ * 获取当前缓存实例数量
+ * @return 缓存数量
+ */
+declare function len(): number;
+export { len };

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

@@ -0,0 +1,20 @@
+/**
+ * 获取一个消息处理函数
+ * @param  cmd 消息名称
+ * @return     消息对应处理函数
+ */
+declare function get(cmd: string): Function;
+export { get };
+/**
+ * 添加一个消息处理函数
+ * @param  cmd 消息名称
+ * @param  cb  消息处理函数
+ */
+declare function add(cmd: string, cb: Function): void;
+export { add };
+/**
+ * 删除一个消息处理函数
+ * @param  {String} cmd 消息名称
+ */
+declare function del(cmd: string): void;
+export { del };

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

@@ -0,0 +1,4 @@
+import type Koa from "koa";
+declare function handle(ctx: Koa.Context, next: Koa.Next): Promise<void>;
+declare function init(): typeof handle;
+export { init };

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

@@ -0,0 +1,169 @@
+/// <reference types="node" />
+import fs from "fs";
+/**
+ * ascii字符串转为base64字符串
+ * @param  str 要转化的字符串
+ * @return     转化后的字符串
+ */
+declare function asciiTobase64(str: string): string;
+export { asciiTobase64 };
+/**
+ * base64字符串转为ascii字符串
+ * @param  str 要转化的字符串
+ * @return     转化后的字符串
+ */
+declare function base64Toascii(str: string): string;
+export { base64Toascii };
+/**
+ * 序列化请求参数
+ * @param  dat 请求参数对象
+ * @param  url 要附加请求参数的URL
+ * @return     序列化完的参数
+ */
+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   时间戳
+ * @return        格式化后的时间
+ */
+declare function date(format: string, ts: number): string;
+/**
+ * 格式化时间
+ * @param  format 日期格式
+ * @param  date   日期字符串
+ * @return        格式化后的时间
+ */
+declare function date(format: string, ts: string): string;
+/**
+ * 格式化时间
+ * @param  format 日期格式
+ * @param  date   日期对象
+ * @return        格式化后的时间
+ */
+declare function date(format: string, ts: Date): string;
+export { date };
+/**
+ * 生成操作结果数据对象
+ * @param  status 返回码
+ * @param  result 返回的数据，数据格式根据具体模块而定
+ * @param  msg    返回的提示性信息
+ * @return        数据对象
+ */
+declare function responseResult<T = any>(status: number, result?: T, msg?: string): XLab.IStdRes;
+/**
+ * 生成操作结果数据对象
+ * @param  status 操作结果
+ * @param  result 返回的数据，数据格式根据具体模块而定
+ * @param  msg    返回的提示性信息
+ * @return        数据对象
+ */
+declare function responseResult<T = any>(status: boolean, result?: T, msg?: string): XLab.IStdRes;
+/**
+ * 生成操作结果数据对象
+ * @param  status 返回结果数据
+ * @param  result 返回的数据，数据格式根据具体模块而定
+ * @param  msg    返回的提示性信息
+ * @return        数据对象
+ */
+declare function responseResult<T = any>(status: XLab.ICodeItem, result?: T, msg?: string): XLab.IStdRes;
+export { responseResult };
+/**
+ * 根据传入的参数生成一个 MD5 值
+ */
+declare function getMD5(...args: any[]): string;
+export { getMD5 };
+/**
+ * 对象值转化为数组
+ * @param  obj 待转的对象
+ * @return     转化后的数组
+ */
+declare function object2Array(obj: XLab.JsonObject): any[];
+export { object2Array };
+/**
+ * 默认 Promise 处理函数
+ * @param resolve Promise 成功处理函数
+ * @param reject  Promise 异常处理函数
+ */
+declare function defPromiseHandler<T = any>(resolve: Function, reject: Function): (err: Error, re: T) => void;
+export { defPromiseHandler };
+/**Promise 包装函数 */
+declare function promiseWapper(...args: any[]): Promise<unknown>;
+export { promiseWapper };
+/**
+ * 封装一个 promise 形式的 request 方法
+ */
+declare function requestWapper<T = any>(...args: any[]): Promise<unknown>;
+export { requestWapper };
+/**
+ * 格式化 JSON 数据
+ * @param  data 原始数据字符串
+ * @return      格式化后的数据
+ */
+declare function formatJson<T = XLab.JsonObject>(data: string): T;
+export { formatJson };
+/**
+ * 输出 sjonp 格式
+ * @param  data  待处理数据
+ * @param  jsonp jsonp 回调函数名称
+ * @return       当是 jsonp 格式时返回 String, 不是时返回原始数据
+ */
+declare function toJsonp(data: XLab.JsonObject, jsonp: string): string | XLab.JsonObject;
+export { toJsonp };
+/**
+ * 查找到文件时的处理函数
+ * @param tmpPath 文件地址
+ */
+declare type WalkCallback = (tmpPath: string, item: string) => void;
+/**
+ * 递归处理文件夹
+ * @param  path      文件目录
+ * @param  floor     层级
+ * @param  callback  查找到文件时的处理函数
+ */
+declare function walk(path: string, floor: number, callback: WalkCallback): void;
+export { walk };
+/**
+ * 检测指定文件是否存在
+ * @param  pathStr    文件路径
+ * @param  resolve    是否使用 path 模块重新处理路径
+ * @return            文件信息，文件不存在为 null
+ */
+declare function checkFileStat(pathStr: string, resolve?: boolean): fs.Stats;
+export { checkFileStat };
+/**获取真正可执行的模块 */
+declare function getRealDefaultMod(mod: any): any;
+export { getRealDefaultMod };

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

@@ -0,0 +1,23 @@
+/**定时任务模块 */
+interface ICronJob {
+    /**定时任务 */
+    (): void;
+    /**获取定时任务间隔时间 */
+    getDelay?: () => number;
+    /**获取定时任务开启状态 */
+    enable?: () => boolean;
+}
+export type { ICronJob };
+/**
+ * 启动指定目录下的所有计时任务
+ * @param  dirPath 任务目录
+ * @return         无返回值
+ */
+declare function on(dirPath: string): void;
+export { on };
+/**
+ * 停止一个或所有的计时器
+ * @param  name 计时器名称
+ */
+declare function kill(name: string): void;
+export { kill };

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

@@ -0,0 +1,41 @@
+import type Koa from "koa";
+/**
+ * 设置 Cache-Control
+ * @param options max-age 缓存时间字符串
+ * @param res 请求上下文
+ */
+declare function cacheControl(options: string, res: Koa.Context): void;
+/**
+ * 设置 Cache-Control
+ * @param options max-age 缓存时间数
+ * @param res 请求上下文
+ */
+declare function cacheControl(options: number, res: Koa.Context): void;
+export { cacheControl };
+/**
+ * 设置 Expires
+ * @param options Expires 缓存时间字符串
+ * @param res 请求上下文
+ */
+declare function expire(options: string, res: Koa.Context): void;
+/**
+ * 设置 Expires
+ * @param options Expires 缓存时间
+ * @param res 请求上下文
+ */
+declare function expire(options: number, res: Koa.Context): void;
+export { expire };
+/**
+ * 设置 Content-Type
+ * @param options 类型
+ * @param res 请求上下文
+ */
+declare function contentType(options: string, res: Koa.Context): void;
+export { contentType };
+/**
+ * 设置 Last-Modified
+ * @param options 最后更新时间，传入非 String 类型时会使用当前时间
+ * @param res 请求上下文
+ */
+declare function lastModified(options: string, res: Koa.Context): void;
+export { lastModified };

package/@types/components/header/time.d.ts

@@ -0,0 +1,3 @@
+/**字符串转为秒数 */
+declare function string2seconds(string: string): number;
+export { string2seconds };

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

@@ -0,0 +1,9 @@
+import type Koa from "koa";
+declare type RouteOption = Record<string, string | string[]>;
+interface HtmlProcessorOptions {
+    route?: RouteOption;
+}
+declare function htmlProcessor(pathname: string, options: HtmlProcessorOptions, context: Koa.Context): string;
+declare function init(): void;
+export { init };
+export { htmlProcessor };

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

@@ -0,0 +1,25 @@
+import type Koa from "koa";
+/**
+ * 数据注入方法
+ * @param  html 待处理的字符串
+ * @param  req  请求对象
+ * @return      处理完的字符串
+ */
+declare function inject(html: string, req: Koa.Context): string;
+export { inject };
+/**
+ * 添加一个字段到缓存对象
+ * @param  key 字段名
+ * @param  val 数据
+ * @return     存储的数据
+ */
+declare function add(key: string, val: XLab.JsonValue): any;
+export { add };
+/**
+ * 修改一个字段
+ * @param  key 字段名
+ * @param  val 数据
+ * @return     存储的数据
+ */
+declare function modify(key: string, val: XLab.JsonValue): boolean;
+export { modify };

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

@@ -0,0 +1,5 @@
+import type Koa from "koa";
+declare function jsProcessor(pathname: string, context: Koa.Context): string;
+declare function init(): void;
+export { init };
+export { jsProcessor };

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

@@ -0,0 +1,4 @@
+declare function Log(config: Record<string, any>): void;
+export { Log };
+declare const globalLog: any;
+export { globalLog };

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

@@ -0,0 +1,2 @@
+declare function md5(str: string): string;
+export { md5 };

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

@@ -0,0 +1,11 @@
+declare const MIME: {
+    html: string;
+    css: string;
+    js: string;
+    png: string;
+    jpg: string;
+    gif: string;
+    xml: string;
+    json: string;
+};
+export { MIME };

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

@@ -0,0 +1,21 @@
+interface IPlat {
+    /**平台类型，mobile 或 desktop */
+    is: string;
+    /**是否是微信 */
+    wechat?: boolean;
+    /**是否是支付宝 */
+    alipay?: boolean;
+    /**是否是微博 */
+    weibo?: boolean;
+    /**是否是 Windows 系统 */
+    win?: boolean;
+    /**是否是 Mac 系统 */
+    mac?: boolean;
+    /**是否是 Linux 系统 */
+    linux?: string;
+    /**操作系统信息 */
+    os?: string;
+}
+export type { IPlat };
+declare function check(ua: string): IPlat;
+export { check };

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

@@ -0,0 +1,26 @@
+import type Koa from "koa";
+/**代理配置项 */
+interface IProxyOption {
+    /**代理目标 */
+    target: string;
+    /**代理域名 */
+    host: string;
+}
+declare module "http" {
+    interface IncomingMessage {
+        /**代理类型 */
+        proxyType: string;
+    }
+}
+/**
+ * 设置代理配置
+ * @param type     代理配置名称
+ * @param options  配置信息
+ */
+declare function set(type: string, options: IProxyOption | string): IProxyOption;
+export { set };
+/**
+ * web 代理
+ */
+declare function web(reqObj: Koa.Context, headers: any): Promise<unknown>;
+export { web };

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

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import qs from "querystring";
+/**
+ * 将 URL 参数转换为字符串
+ * @example
+ * ```ts
+ * query2string({"pf":"145","ss":"320x240"});
+ * query2string({"pf":"145","ss":"320x240"},["pf"]);
+ * query2string({"pf":"145","ss":"320x240"},{"fr":"android"});
+ * query2string({"pf":"145","ss":"320x240"},{"fr":"android"},["fr"]);
+ * ```
+ */
+declare function query2string(...args: Array<XLab.JsonObject | string[]>): string;
+export { query2string };
+/**
+ * 字符串转成参数对象
+ * @param  qString  参数字符串
+ * @return          处理完的对象
+ * @example
+ * ```ts
+ * string2query("pf=145&ss=320x240");
+ * ```
+ */
+declare function string2query(qString: string): qs.ParsedUrlQuery;
+export { string2query };

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

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import type { ParsedUrlQuery } from "querystring";
+import type Koa from "koa";
+declare function by302(context: Koa.Context, url: string): void;
+export { by302 };
+declare function byJS(context: Koa.Context, url: string, msg: string, origin: string): void;
+export { byJS };
+declare function byMeta(context: Koa.Context, url: string): void;
+export { byMeta };
+declare function makeRedirectUrl(query: ParsedUrlQuery, url: string): string;
+export { makeRedirectUrl };

package/@types/components/return-code.d.ts

@@ -0,0 +1,159 @@
+/**
+ * 状态详细信息
+ */
+declare const CODE_DETAIL: {
+    FAIL: {
+        errorcode: number;
+        msg: string;
+    };
+    SUCCESS: {
+        errorcode: number;
+        msg: string;
+    };
+    BUSY: {
+        errorcode: number;
+        msg: string;
+    };
+    WRONG_PARAMETER: {
+        errorcode: number;
+        msg: string;
+    };
+    NOT_FOUND: {
+        errorcode: number;
+        msg: string;
+    };
+    PERMISSION_DENIED: {
+        errorcode: number;
+        msg: string;
+    };
+    SERVER_BUSY: {
+        errorcode: number;
+        msg: string;
+    };
+    SERVER_TIMEOUT: {
+        errorcode: number;
+        msg: string;
+    };
+    UNCHECK_ERROR: {
+        errorcode: number;
+        msg: string;
+    };
+};
+/**
+ * 根据状态码获取错误定义信息
+ * @param  code 状态码
+ * @param  msg  返回信息<可选>
+ * @return      状态对象
+ */
+declare function getReturnCode(code: number, msg?: string): XLab.ICodeItem;
+/**
+ * 根据状态名称获取错误定义信息
+ * @param  code 状态名称
+ * @param  msg  返回信息<可选>
+ * @return      状态对象
+ */
+declare function getReturnCode(code: keyof typeof CODE_DETAIL, msg?: string): XLab.ICodeItem;
+/**
+ * 根据状态名称获取错误定义信息
+ * @param  code 状态名称
+ * @param  msg  返回信息<可选>
+ * @return      状态对象
+ */
+declare function getReturnCode(code: string, msg?: string): XLab.ICodeItem;
+/**
+ * 根据状态获取错误定义信息
+ * @param  code 状态
+ * @param  msg  返回信息<可选>
+ * @return      状态对象
+ */
+declare function getReturnCode(code: boolean, msg?: string): XLab.ICodeItem;
+export { getReturnCode };
+/**
+ * 获取错误代码
+ * @return 错误代码
+ */
+declare function getCodeDetail(): {
+    FAIL: {
+        errorcode: number;
+        msg: string;
+    };
+    SUCCESS: {
+        errorcode: number;
+        msg: string;
+    };
+    BUSY: {
+        errorcode: number;
+        msg: string;
+    };
+    WRONG_PARAMETER: {
+        errorcode: number;
+        msg: string;
+    };
+    NOT_FOUND: {
+        errorcode: number;
+        msg: string;
+    };
+    PERMISSION_DENIED: {
+        errorcode: number;
+        msg: string;
+    };
+    SERVER_BUSY: {
+        errorcode: number;
+        msg: string;
+    };
+    SERVER_TIMEOUT: {
+        errorcode: number;
+        msg: string;
+    };
+    UNCHECK_ERROR: {
+        errorcode: number;
+        msg: string;
+    };
+};
+export { getCodeDetail };
+/**
+ * 设置新的错误代码
+ * @param data 新的错误代码数据
+ */
+declare function set(data: XLab.ICodeDetail): void;
+export { set };
+/**错误类型对象 */
+declare const ErrorTypes: {
+    FAIL: {
+        errorcode: number;
+        msg: string;
+    };
+    SUCCESS: {
+        errorcode: number;
+        msg: string;
+    };
+    BUSY: {
+        errorcode: number;
+        msg: string;
+    };
+    WRONG_PARAMETER: {
+        errorcode: number;
+        msg: string;
+    };
+    NOT_FOUND: {
+        errorcode: number;
+        msg: string;
+    };
+    PERMISSION_DENIED: {
+        errorcode: number;
+        msg: string;
+    };
+    SERVER_BUSY: {
+        errorcode: number;
+        msg: string;
+    };
+    SERVER_TIMEOUT: {
+        errorcode: number;
+        msg: string;
+    };
+    UNCHECK_ERROR: {
+        errorcode: number;
+        msg: string;
+    };
+};
+export { ErrorTypes };

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

@@ -0,0 +1,7 @@
+/**
+ * 生成一个 uuid
+ * @param one 第一节数据
+ * @param tow 第二节数据
+ */
+declare function uuid(one: string, tow: string): string;
+export { uuid };

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

@@ -0,0 +1,26 @@
+/**
+ * 比较版本
+ * @param  v1 样本版本
+ * @param  v2 对比版本
+ * @returns   对比结果：
+ *              - 1 样本大于对比
+ *              - 0 两者相等
+ *              - -1 对比大于样本
+ */
+declare function compareVersion(v1: string, v2: string): 1 | -1 | 0;
+export { compareVersion };
+/**
+ * 匹配范围
+ * @param range 版本范围
+ * @param v 对比版本
+ */
+declare function matchRange(range: string, v: string): boolean;
+export { matchRange };
+/**
+ * 匹配任意
+ * @param range      范围
+ * @param v          对比
+ * @param ignoreCase 忽略大小写
+ */
+declare function matchAny(range: string, v: string, ignoreCase?: boolean): boolean;
+export { matchAny };

package/@types/config/getEnv.d.ts

@@ -0,0 +1,10 @@
+interface IEnvData {
+    /**环境名称 */
+    env: string;
+    /**是否为生产环境 */
+    isProd: boolean;
+    /**环境配置文件地址 */
+    envAddConfPath: string;
+}
+declare const _default: (argv: Record<string, string>) => IEnvData;
+export default _default;

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

@@ -0,0 +1,17 @@
+/**
+ * 通用日志方法
+ * @param  cat  业务类型
+ * @param  type 日志等级
+ */
+declare function commonLog(cat: string, type: string): void;
+export { commonLog as log };
+/**
+ * 默认配置
+ */
+declare const CONFIG: XLab.IConfig;
+export default CONFIG;
+declare function get(): XLab.IConfig;
+export { get };
+/**更新配置 */
+declare function update(conf: XLab.IConfig): XLab.IConfig;
+export { update };

package/@types/config/process-custom-config-files.d.ts

@@ -0,0 +1,2 @@
+declare function customConfigProcessor(conf: XLab.IConfig, env: string, envAddConfPath: string): void;
+export default customConfigProcessor;

package/@types/config/process-def-config-file.d.ts

@@ -0,0 +1,2 @@
+declare function defConfigProcessor(argv: Record<string, string>): XLab.IConfig;
+export default defConfigProcessor;

package/@types/custom.d.ts

@@ -0,0 +1,3 @@
+/**处理自定义业务 */
+declare function processCustom(): void;
+export default processCustom;

package/@types/global.d.ts

@@ -0,0 +1,185 @@
+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;
+    /**只在 master 上输出的日志 */
+    var masterLog: any;
+    /**
+    * 获取应用实例对象
+    */
+    function getApp(): Koa;
+    /**
+    * 获取内置组件
+    * @param  name 模块名
+    * @return      模块对象
+    */
+    function requireMod<T extends InternalComponents[K], K extends keyof InternalComponents>(name: K): T;
+    /**
+    * 全局获取 model 的方法
+    * @param  name model 名称
+    * @return      model 模块
+    */
+    function requireModel<T extends XLab.IModels[K], K extends keyof XLab.IModels>(name: K): T;
+    /**
+    * 全局获取 service 的方法
+    * @param  name service 名称
+    * @return      service 模块
+    */
+    function requireService<T extends XLab.IServices[K], K extends keyof XLab.IServices>(name: K): T;
+    /**
+     * 获取系统配置
+     */
+    function getSysConfig(): XLab.IConfig;
+    /**
+     * 获取系统配置
+     * @param  key 配置项
+     */
+    function getSysConfig<T extends XLab.IConfig[K], K extends keyof XLab.IConfig>(key?: K): T;
+    /**
+     * 获取系统配置
+     * @param  key 配置项
+     */
+    function getSysConfig(key?: any): any;
+    /**
+    * 更新系统配置
+    * @param  conf 配置项
+    */
+    function setSysConfig(conf: XLab.IConfig): void;
+    namespace XLab {
+        /**JSON 基本数据类型 */
+        type JsonValue = boolean | string | number | null | undefined | JsonArray | JsonObject;
+        /**包含 JSON 的数组 */
+        type JsonArray = JsonValue[];
+        /**包含 JSON 数据的 JSON */
+        interface JsonObject {
+            [key: string]: JsonValue;
+        }
+        /**包含复合值的数组 */
+        type CompositeArray = CompositeValue[];
+        /**复合值 */
+        type CompositeValue = JsonValue | CompositeArray | CompositeObject;
+        /**包含复合值的对象 */
+        interface CompositeObject {
+            [key: string]: CompositeValue;
+        }
+        /**业务服务 */
+        interface IServices {
+        }
+        /**业务数据模型 */
+        interface IModels {
+        }
+        /**标准返回数据 */
+        interface IStdRes<T = any> {
+            /**业务执行状态码 */
+            code: number;
+            /**业务数据 */
+            result: T;
+            /**操作信息 */
+            msg?: string;
+            /**操作结果 */
+            success?: boolean;
+        }
+        interface IConfig {
+            /**服务(应用)名称 */
+            name?: string;
+            /**版本 */
+            version?: string;
+            /**环境标识 */
+            env?: string;
+            /**业务绑定的域名 */
+            host?: string;
+            /**是否开启 304 协商缓存 */
+            304?: boolean;
+            /**Worker 数量 */
+            workers?: number;
+            /**业务服务器地址 */
+            biServer?: string;
+            /**业务服务器协议 */
+            protocol?: string;
+            /**是否开启 debug 模式 */
+            debug?: boolean;
+            /**静态文件缓存时间 */
+            staticMaxage?: number;
+            /**静态 html 文件缓存时间 */
+            staticHtmlFileMaxage?: number;
+            /**是否开启 Combo 缓存 */
+            enableComboCache?: boolean;
+            /**是否开启定时任务 */
+            enableCron?: boolean;
+            /**开启的中间件列表 */
+            middleware?: (string | (string | Record<string, any>)[])[];
+            /**自定模块配置 */
+            custom?: string[];
+            /**是否启用严格 ssl */
+            strictSSL?: boolean;
+            /**页端注入的 api 设置 */
+            apis?: Record<string, string>;
+            /**服务 ip 地址 */
+            ip?: string;
+            /**本地是否存在本地开发配置文件 config.lo.json */
+            hasLo?: boolean;
+            /**不处理业务 api */
+            passExtApis?: boolean;
+            /**是否是生产环境 */
+            isProd?: boolean;
+            /**是否允许页端缓存 */
+            allowCache?: boolean;
+            /**静态文件根目录 */
+            root?: string;
+            /**监听端口 */
+            port?: number;
+            /**是否是主进程 */
+            isMaster?: boolean;
+            /**是否每次都强制清除 LocalStorage */
+            clearLocalStorage?: boolean;
+            /**处理代理过来多余的地址层级路径替换判断正则 */
+            pathReplaceRegExp?: string;
+            /**移动端入口文件地址(旧版逻辑) */
+            routeMobile?: string;
+            /**不同端入口地址设置 */
+            launchRouter?: Record<string, string>;
+            /**定时任务设置 */
+            cron?: {
+                def?: number;
+            };
+            /**注入参数列表 */
+            injection?: string[];
+            /**首页缓存时间 */
+            indexPageCacheTime?: number;
+            /**静态资源缓存时间 */
+            staticResourceCacheTime?: number;
+        }
+        /**业务错误数据对象 */
+        interface ICodeItem {
+            /**错误码 */
+            errorcode: number;
+            /**错误信息 */
+            msg: string;
+        }
+        /**业务错误定义 */
+        type ICodeDetail = Record<string, ICodeItem>;
+    }
+}

package/@types/middleware/@bin/html-filter.d.ts

@@ -0,0 +1,3 @@
+declare function filter(url: string): Record<string, string>;
+export { filter };
+export default function (): void;

package/@types/middleware/bad-request.d.ts

@@ -0,0 +1,3 @@
+import type Koa from "koa";
+declare function handler(ctx: Koa.Context): void;
+export default handler;

package/@types/middleware/combo.d.ts

@@ -0,0 +1,2 @@
+declare function handler(): (ctx: import("koa").Context, next: import("koa").Next) => Promise<void>;
+export default handler;

package/@types/middleware/compress.d.ts

@@ -0,0 +1,2 @@
+declare function handler(config: Record<string, any>): any;
+export default handler;

package/@types/middleware/cors.d.ts

@@ -0,0 +1,12 @@
+import type Koa from "koa";
+interface ICorsConfig {
+    /**检测函数, 与 type 互斥 */
+    check?: (origin?: string, url?: string) => boolean;
+    /**跨域类型, 与 check 互斥 */
+    type?: "sameroot" | "all";
+    /**跨域开关 */
+    enable?: boolean;
+}
+/**跨域请求处理中间件初始化函数 */
+export default function (config?: ICorsConfig): (ctx: Koa.Context, next: Koa.Next) => Promise<void>;
+export {};

package/@types/middleware/fresh-filter.d.ts

@@ -0,0 +1,4 @@
+import type Koa from "koa";
+declare function handle(ctx: Koa.Context, next: Koa.Next): Promise<void>;
+export default function (): typeof handle;
+export {};

package/@types/middleware/handle-pre-dir.d.ts

@@ -0,0 +1,6 @@
+import type Koa from "koa";
+/**
+ * 处理代理过来多余的地址层级
+ */
+declare function handlPreDir(ctx: Koa.Context, next: Koa.Next): Promise<void>;
+export default handlPreDir;

package/@types/middleware/request-filter.d.ts

@@ -0,0 +1,4 @@
+import type Koa from "koa";
+declare function filter(ctx: Koa.Context, next: Koa.Next): Promise<void>;
+export default function (): typeof filter;
+export {};

package/@types/middleware/service-mark.d.ts

@@ -0,0 +1,7 @@
+import type Koa from "koa";
+/**
+ * 处理函数
+ */
+declare function handler(ctx: Koa.Context, next: Koa.Next): Promise<void>;
+export default function (): typeof handler;
+export {};

package/@types/middlewares.d.ts

@@ -0,0 +1,4 @@
+import type koa from "koa";
+/**加载中间件 */
+declare function loadMiddleware(app: koa): void;
+export default loadMiddleware;

package/@types/router.d.ts

@@ -0,0 +1,4 @@
+import type Router from "koa-router";
+/**加载业务服务接口 */
+declare function appRouter(router: Router): void;
+export default appRouter;

package/@types/server.d.ts

@@ -0,0 +1,10 @@
+import "./global";
+import koa from "koa";
+declare const app: koa<koa.DefaultState, koa.DefaultContext>;
+/**启动服务 */
+declare function boot(): void;
+export { boot };
+/**退出服务 */
+declare function exit(): void;
+export { exit };
+export default app;

package/README.md

@@ -14,6 +14,19 @@ X-9lab 通用服务端
         }
     }
     ```
+- `watch` 模式
+    `xlab` 支持自动重启业务，开发中使用该功能可以减少大量手动重启业务的操作。
+    启用方式：
+    - 启动命令使用 `w` 参数
+    - 在配置文件中开启
+        ```js
+        const { NODE_ENV } = process.env;
+        module.exports = {
+            "watch": {
+                "enable": NODE_ENV === "development"
+            }
+        }
+        ```
 - 除了静态资源，服务端业务需要放在项目根目录下的 `@server` 目录中
 - 支持业务自定义以下内容 (无特殊说明的都是存放在 @server 目录中)
     - 配置项，存放于 `@config` 目录

package/dist/bin/watch.js

@@ -1,7 +1,7 @@
 "use strict";
 const { date  } = require("@x-drive/utils");
 const crossSpawn = require("cross-spawn");
-colors = require("colors/safe");
+const colors = require("colors/safe");
 const path = require("path");
 const fs = require("fs");
 /**输出内容名称 */ const X_LAB_STR = colors.bold(colors.cyan("🛸 XLab"));

package/dist/components/cache/lru.js

@@ -10,8 +10,10 @@ function _export(target, all) {
 }
 _export(exports, {
     create: ()=>create,
+    get: ()=>get,
     len: ()=>len
 });
+const _utils = require("@x-drive/utils");
 const _lruCache = /*#__PURE__*/ _interopRequireDefault(require("lru-cache"));
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
@@ -67,6 +69,22 @@ const CACHE_LIST = [];
     }
     return LRU_CACHES[cacheName];
 }
+/**
+ * 获取一个缓存实例
+ * @param name 缓存名称
+ * @param conf 缓存配置
+ */ function get(name, conf) {
+    if (!(0, _utils.isString)(name)) {
+        throw new Error("必须指定缓存名称");
+    }
+    if (LRU_CACHES[name]) {
+        return LRU_CACHES[name];
+    }
+    if ((0, _utils.isObject)(conf)) {
+        return create(name, conf);
+    }
+    throw new Error(`找不到缓存 ${name}, 你可以先创建再调用本方法获取,或传入配置对象自动生成`);
+}
 /**
  * 获取当前缓存实例数量
  * @return 缓存数量

package/dist/components/common.js

@@ -29,6 +29,7 @@ _export(exports, {
     getRealDefaultMod: ()=>getRealDefaultMod
 });
 const _returnCode = require("./return-code");
+const _utils = require("@x-drive/utils");
 const _querystring = /*#__PURE__*/ _interopRequireDefault(require("querystring"));
 const _request = /*#__PURE__*/ _interopRequireDefault(require("request"));
 const _crypto = /*#__PURE__*/ _interopRequireDefault(require("crypto"));
@@ -187,7 +188,7 @@ const format_exp = /[YymndjNwaAghGHis]/g;
  * @param  msg    返回的提示性信息
  * @return        数据对象
  */ function responseResult(status, result, msg) {
-    var code = (0, _returnCode.getReturnCode)(status);
+    var code = (0, _utils.isObject)(status) ? status : (0, _returnCode.getReturnCode)(status);
     var dat = {
         "success": code.errorcode === 0,
         "code": code.errorcode,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@x-9lab/xlab",
-    "version": "1.0.0-alpha.1",
+    "version": "1.0.0",
     "description": "9lab 服务端模块",
     "versionDesc": "",
     "scripts": {
@@ -16,7 +16,8 @@
     "main": "./dist/server.js",
     "types": "./@types/global.d.ts",
     "files": [
-        "dist"
+        "dist",
+        "@types"
     ],
     "dependencies": {
         "koa": "2.13.1",
@@ -55,5 +56,9 @@
     },
     "bin": {
         "xlab": "dist/bin/xlab"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/x-9lab/xlab.git"
     }
 }

package/dist/package.json

@@ -1,61 +0,0 @@
-{
-    "name": "@x-9lab/xlab",
-    "version": "1.0.0",
-    "private": true,
-    "description": "9lab 服务端模块",
-    "versionDesc": "",
-    "scripts": {
-        "dev": "swc src -D ./src/bin --config-file .swcrc -d dist -w",
-        "compile": "swc src -D ./src/bin --config-file .swcrc -d dist",
-        "build": "yarn compile && yarn gen-declaration",
-        "gen-declaration": "tsc --emitDeclarationOnly",
-        "changelog": "changelog"
-    },
-    "engines": {
-        "node": ">10.0.0"
-    },
-    "main": "./dist/server.js",
-    "types": "./@types/global.d.ts",
-    "files": [
-        "dist",
-        "@types"
-    ],
-    "dependencies": {
-        "koa": "2.13.1",
-        "cron": "1.8.2",
-        "redis": "4.0.3",
-        "log4js": "1.1.1",
-        "liftoff": "3.1.0",
-        "koa-ejs": "4.3.0",
-        "minimist": "1.2.5",
-        "request": "2.86.0",
-        "koa-body": "4.2.0",
-        "lru-cache": "6.0.0",
-        "koa-static": "5.0.0",
-        "koa-router": "10.0.0",
-        "http-proxy": "1.18.1",
-        "koa-compress": "5.0.1",
-        "@x-drive/utils": "1.1.19"
-    },
-    "devDependencies": {
-        "co": "4.6.0",
-        "mocha": "10.0.0",
-        "tslib": "2.3.0",
-        "colors": "1.4.0",
-        "should": "11.2.1",
-        "nodemon": "2.0.12",
-        "socket.io": "2.0.3",
-        "chokidar": "3.5.3",
-        "typescript": "4.3.4",
-        "@types/node": "16.11.40",
-        "@types/log4js": "2.3.5",
-        "@types/koa-static": "4.0.2",
-        "@types/koa-router": "7.4.4",
-        "@swc/cli": "0.1.57",
-        "@swc/core": "1.2.212",
-        "@x-drive/changelog": "1.1.6"
-    },
-    "bin": {
-        "xlab": "dist/bin/xlab"
-    }
-}