@x-9lab/xlab 1.6.0 → 2.0.0

package/package.json

@@ -1,49 +1,45 @@
 {
     "name": "@x-9lab/xlab",
-    "version": "1.6.0",
+    "version": "2.0.0",
     "description": "9lab 服务端模块",
-    "versionDesc": "日志信息输出优化",
+    "versionDesc": "v2: 移除全局挂载改为模块导出、显式生命周期与优雅退出、路由归一化",
     "scripts": {
-        "dev": "swc src -D ./src/bin --config-file .swcrc -d dist -w",
-        "compile": "swc src -D ./src/bin --config-file .swcrc -d dist",
+        "dev": "swc src --copy-files --strip-leading-paths --config-file .swcrc -d dist -w",
+        "compile": "swc src --copy-files --strip-leading-paths --config-file .swcrc -d dist",
         "build": "yarn compile && yarn gen-declaration",
         "gen-declaration": "tsc --emitDeclarationOnly",
+        "test": "node --test",
         "changelog": "changelog"
     },
     "engines": {
-        "node": ">10.0.0"
+        "node": ">=20.0.0"
     },
-    "main": "./dist/server.js",
-    "types": "./@types/global.d.ts",
+    "main": "./dist/index.js",
+    "types": "./@types/index.d.ts",
     "files": [
         "dist",
-        "@types"
+        "@types",
+        "MIGRATION.md"
     ],
     "dependencies": {
-        "koa": "3.1.2",
-        "cron": "1.8.2",
-        "log4js": "^1.1.1",
-        "liftoff": "4.0.0",
-        "minimist": "1.2.6",
-        "koa-static": "5.0.0",
+        "@x-drive/utils": "1.1.32",
+        "koa": "3.2.1",
+        "koa-compress": "5.2.2",
         "koa-router": "14.0.0",
-        "koa-compress": "5.2.1",
-        "@x-drive/utils": "1.1.32"
+        "koa-static": "5.0.0",
+        "liftoff": "5.0.1",
+        "log4js": "^6.9.1",
+        "minimist": "1.2.8"
     },
     "devDependencies": {
-        "tslib": "2.3.0",
-        "colors": "1.4.0",
-        "should": "11.2.1",
-        "nodemon": "2.0.12",
-        "chokidar": "3.5.3",
-        "@swc/cli": "0.1.57",
-        "typescript": "4.3.4",
-        "@swc/core": "1.2.171",
-        "@types/log4js": "2.3.5",
-        "@types/node": "16.11.40",
-        "@types/koa-static": "4.0.4",
+        "@swc/cli": "^0.7.7",
+        "@swc/core": "^1.13.2",
         "@types/koa-router": "7.4.9",
-        "@x-drive/changelog": "1.1.6"
+        "@types/koa-static": "4.0.4",
+        "@types/node": "^20.19.0",
+        "@x-drive/changelog": "1.1.6",
+        "chokidar": "^3.6.0",
+        "typescript": "^5.9.2"
     },
     "bin": {
         "xlab": "dist/bin/xlab"
@@ -52,4 +48,4 @@
         "type": "git",
         "url": "git+https://github.com/x-9lab/xlab.git"
     }
-}
+}

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

@@ -1,3 +0,0 @@
-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

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

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

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

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

@@ -1,21 +0,0 @@
-/**
- * 生成或获取一个缓存实例
- * @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/html-processor/index.d.ts

@@ -1,9 +0,0 @@
-import type Koa from "koa";
-declare type RouteOption = Record<string, string | string[] | Function>;
-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

@@ -1,25 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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/md5/index.d.ts

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

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

@@ -1,21 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,25 +0,0 @@
-/// <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

@@ -1,11 +0,0 @@
-/// <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/request/helper.d.ts

@@ -1,3 +0,0 @@
-import type Fetch from "node-fetch";
-declare function getFetch(): Promise<typeof Fetch>;
-export { getFetch };

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

@@ -1,51 +0,0 @@
-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

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

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

@@ -1,26 +0,0 @@
-/**
- * 比较版本
- * @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/env.d.ts

@@ -1 +0,0 @@
-export {};