@maiyunnet/kebab 3.1.4 → 3.1.5

package/lib/ws.d.ts

@@ -1,11 +1,12 @@
 /**
  * Project: Kebab, User: JianSuoQiYue
  * Date: 2019-6-2 20:42
- * Last: 2020-4-9 22:33:11, 2022-09-13 13:32:01, 2022-12-30 19:13:07, 2024-2-6 23:53:45, 2024-12-23 01:33:16, 2025-1-28 21:05:51
+ * Last: 2020-4-9 22:33:11, 2022-09-13 13:32:01, 2022-12-30 19:13:07, 2024-2-6 23:53:45, 2024-12-23 01:33:16, 2025-1-28 21:05:51, 2025-9-23 12:27:48
  */
 import * as http from 'http';
 import * as net from 'net';
-import * as types from '#types/index.js';
+import * as kebab from '#index.js';
+import * as lNet from '#lib/net.js';
 import * as sCtr from '#sys/ctr.js';
 /** --- 一般用 SIMPLE --- */
 export declare enum EFrameReceiveMode {
@@ -28,9 +29,9 @@ export interface IConnectOptions {
     'timeout'?: number;
     'hosts'?: Record<string, string>;
     'local'?: string;
-    'headers'?: types.THttpHeaders;
+    'headers'?: lNet.THttpHeaders;
     /** --- cookie 托管对象 --- */
-    'cookie'?: Record<string, types.ICookie>;
+    'cookie'?: Record<string, lNet.ICookie>;
     /** --- 小帧模式，默认 false --- */
     'mode'?: EFrameReceiveMode;
     /** --- 加密模式，默认 true --- */
@@ -47,7 +48,7 @@ export interface IMproxyOptions {
     'timeout'?: number;
     'hosts'?: Record<string, string>;
     'local'?: string;
-    'headers'?: types.THttpHeaders;
+    'headers'?: lNet.THttpHeaders;
     /** --- 小帧模式，默认 false --- */
     'mode'?: EFrameReceiveMode;
     /** --- 加密模式，默认 true --- */
@@ -59,7 +60,7 @@ export interface IRproxyOptions {
     'timeout'?: number;
     'hosts'?: Record<string, string>;
     'local'?: string;
-    'headers'?: types.THttpHeaders;
+    'headers'?: lNet.THttpHeaders;
     /** --- 小帧模式，默认 false --- */
     'mode'?: EFrameReceiveMode;
     /** --- 加密模式，默认 true --- */
@@ -105,7 +106,7 @@ export declare class Socket {
     /** --- 发送文本 --- */
     writeText(data: string): boolean;
     /** --- 发送结果对象字符串 --- */
-    writeResult(data: types.Json): boolean;
+    writeResult(data: kebab.Json): boolean;
     /** --- 发送二进制 --- */
     writeBinary(data: string | Buffer | Array<string | Buffer>): boolean;
     /** --- 当前是否是可写状态 --- */

package/lib/ws.js

@@ -1,7 +1,6 @@
 import * as net from 'net';
 // --- 第三方 ---
 import * as liws from '@litert/websocket';
-// --- 库 ---
 import * as lText from '#lib/text.js';
 import * as lNet from '#lib/net.js';
 /** --- 一般用 SIMPLE --- */

package/lib/zip.d.ts

@@ -1,5 +1,4 @@
 import jszip from 'jszip';
-import * as types from '#types/index.js';
 /**
  * --- 本库主要用于读取 zip，请尽量不要用来写入 zip，尤其是大文件 zip ---
  */
@@ -10,14 +9,14 @@ export declare class Zip {
     private _path;
     constructor(zip: jszip);
     getContent(path: string): Promise<string | null>;
-    getContent<T extends types.TZipOutputType>(path: string, type: T): Promise<types.IZipOutputByType[T] | null>;
+    getContent<T extends TZipOutputType>(path: string, type: T): Promise<IZipOutputByType[T] | null>;
     /**
      * --- 写入文件内容 ---
      * @param path 文件路径
      * @param data 要写入的内容
      * @param options 选项
      */
-    putContent<T extends types.TZipInputType>(path: string, data: types.IZipInputByType[T], options?: {
+    putContent<T extends TZipInputType>(path: string, data: IZipInputByType[T], options?: {
         'base64'?: boolean;
         'binary'?: boolean;
         'date'?: Date;
@@ -32,28 +31,28 @@ export declare class Zip {
      * @param path 对象路径
      * @param options 选项
      */
-    stats(path: string): types.IZipStats | null;
+    stats(path: string): IZipStats | null;
     /**
      * --- 判断是否是目录或目录是否存在，是的话返回 stats ---
      * @param path 判断路径
      */
-    isDir(path: string): types.IZipStats | false;
+    isDir(path: string): IZipStats | false;
     /**
      * --- 判断是否是文件或文件是否存在，是的话返回 stats ---
      * @param path 判断路径
      */
-    isFile(path: string): types.IZipStats | false;
+    isFile(path: string): IZipStats | false;
     /** --- 读取目录，hasChildren: false, hasDir: true, pathAsKey: false --- */
     readDir(path?: string, opt?: {
         'hasChildren'?: boolean;
         'hasDir'?: boolean;
         'pathAsKey'?: false;
-    }): types.IZipItem[];
+    }): IZipItem[];
     readDir(path?: string, opt?: {
         'hasChildren'?: boolean;
         'hasDir'?: boolean;
         'pathAsKey': true;
-    }): Record<string, types.IZipItem>;
+    }): Record<string, IZipItem>;
     private _readDir;
     /** --- 目录列表缓存 --- */
     private _list;
@@ -76,11 +75,11 @@ export declare class Zip {
      * --- 打包 zip ---
      * @param options 选项
      */
-    generate<T extends types.TZipOutputType>(options?: {
+    generate<T extends TZipOutputType>(options?: {
         'type'?: T;
         'level'?: number;
         'onUpdate'?: (percent: number, currentFile: string | null) => void;
-    }): Promise<types.IZipOutputByType[T]>;
+    }): Promise<IZipOutputByType[T]>;
     /**
      * --- 获取 path 和 string/Buffer 对应的文件列表 ---
      */
@@ -90,4 +89,49 @@ export declare class Zip {
  * --- 获取 zip 对象 ---
  * @param data 对象数据
  */
-export declare function get(data?: types.TZipInputFileFormat): Promise<Zip | null>;
+export declare function get(data?: TZipInputFileFormat): Promise<Zip | null>;
+export interface IZipItem {
+    'name': string;
+    'compressedSize': number;
+    'uncompressedSize': number;
+    'date': Date;
+    'isFile': boolean;
+    'isDirectory': boolean;
+    'path': string;
+}
+export interface IZipStats {
+    'compressedSize': number;
+    'uncompressedSize': number;
+    'date': Date;
+    'isFile': boolean;
+    'isDirectory': boolean;
+}
+export interface IZipOutputByType {
+    'base64': string;
+    'string': string;
+    'text': string;
+    'binarystring': string;
+    'array': number[];
+    'uint8array': Uint8Array;
+    'arraybuffer': ArrayBuffer;
+    'blob': Blob;
+    'nodebuffer': Buffer;
+}
+export type TZipOutputType = keyof IZipOutputByType;
+export interface IZipInputByType {
+    'base64': string;
+    'string': string;
+    'text': string;
+    'binarystring': string;
+    'array': number[];
+    'uint8array': Uint8Array;
+    'arraybuffer': ArrayBuffer;
+    'blob': Blob;
+    'nodebuffer': Buffer;
+}
+export type TZipInputType = keyof IZipInputByType;
+export type TZipInputFileFormat = IZipInputByType[keyof IZipInputByType];
+export interface IZipMetadata {
+    'percent': number;
+    'currentFile': string | null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maiyunnet/kebab",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "Simple, easy-to-use, and fully-featured Node.js framework that is ready-to-use out of the box.",
   "type": "module",
   "keywords": [
@@ -11,6 +11,7 @@
   "main": "index.js",
   "author": "hanguoshuai",
   "license": "Apache-2.0",
+  "types": "./index.d.ts",
   "bin": {
     "kebab": "./bin/kebab.js"
   },
@@ -18,8 +19,8 @@
     "#*": "./*"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.893.0",
-    "@aws-sdk/lib-storage": "^3.893.0",
+    "@aws-sdk/client-s3": "^3.894.0",
+    "@aws-sdk/lib-storage": "^3.894.0",
     "@litert/http-client": "^1.1.2",
     "@litert/mime": "^0.1.3",
     "@litert/redis": "^3.0.5",
@@ -30,7 +31,7 @@
     "mysql2": "^3.15.0",
     "ssh2": "^1.17.0",
     "svg-captcha": "^1.4.0",
-    "tencentcloud-sdk-nodejs": "^4.1.119"
+    "tencentcloud-sdk-nodejs": "^4.1.120"
   },
   "devDependencies": {
     "@litert/eslint-plugin-rules": "^0.3.1",

package/sys/child.js

@@ -7,7 +7,7 @@ import * as http2 from 'http2';
 import * as tls from 'tls';
 import * as http from 'http';
 import * as crypto from 'crypto';
-// --- 库和定义 ---
+// --- 库 ---
 import * as fs from '#lib/fs.js';
 import * as lCore from '#lib/core.js';
 import * as lText from '#lib/text.js';

package/sys/ctr.d.ts

@@ -5,11 +5,11 @@
  */
 import * as http from 'http';
 import * as http2 from 'http2';
-import * as session from '../lib/session.js';
-import * as db from '../lib/db.js';
-import * as kv from '../lib/kv.js';
-import * as lWs from '../lib/ws.js';
-import * as types from '../types/index.js';
+import * as kebab from '#index.js';
+import * as lSession from '#lib/session.js';
+import * as lDb from '#lib/db.js';
+import * as lKv from '#lib/kv.js';
+import * as lWs from '#lib/ws.js';
 /**
  * --- 清除已经加载的 data 与语言包文件缓存 ---
  */
@@ -24,13 +24,13 @@ export declare class Ctr {
     /** --- GET 数据 --- */
     protected _get: Record<string, string>;
     /** --- 原始 POST 数据 --- */
-    protected _rawPost: Record<string, types.Json>;
+    protected _rawPost: Record<string, kebab.Json>;
     /** --- POST 数据 --- */
-    protected _post: Record<string, types.Json>;
+    protected _post: Record<string, kebab.Json>;
     /** --- 原始 input 字符串 */
     protected _input: string;
     /** --- 上传的文件列表 --- */
-    protected _files: Record<string, types.IPostFile | types.IPostFile[]>;
+    protected _files: Record<string, kebab.IPostFile | kebab.IPostFile[]>;
     /** --- Cookie 数组 --- */
     protected _cookie: Record<string, string>;
     /** --- Jwt 数组 --- */
@@ -38,7 +38,7 @@ export declare class Ctr {
     /** --- Session 数组 --- */
     protected _session: Record<string, any>;
     /** --- Session --- 对象 */
-    protected _sess: session.Session | null;
+    protected _sess: lSession.Session | null;
     /** --- 页面浏览器客户端缓存 --- */
     protected _cacheTTL: number;
     /** --- XSRF TOKEN 值 --- */
@@ -48,7 +48,7 @@ export declare class Ctr {
     /** --- 当前语言名 --- */
     protected _locale: string;
     /** --- vhost 的 kebab.json 以及全局常量 --- */
-    protected readonly _config: types.IConfig;
+    protected readonly _config: kebab.IConfig;
     protected readonly _req: http2.Http2ServerRequest | http.IncomingMessage;
     protected readonly _res: http2.Http2ServerResponse | http.ServerResponse;
     protected readonly _socket: lWs.Socket;
@@ -56,7 +56,7 @@ export declare class Ctr {
     protected _localeFiles: string[];
     /** --- 本 ctr 的 locale data --- */
     protected _localeData: Record<string, Record<string, string>>;
-    constructor(config: types.IConfig, req: http2.Http2ServerRequest | http.IncomingMessage, res?: http2.Http2ServerResponse | http.ServerResponse);
+    constructor(config: kebab.IConfig, req: http2.Http2ServerRequest | http.IncomingMessage, res?: http2.Http2ServerResponse | http.ServerResponse);
     /** --- 当前用户连接是否还在连接中 --- */
     get isAvail(): boolean;
     /** --- timeout 的 timer --- */
@@ -79,26 +79,26 @@ export declare class Ctr {
      */
     protected _asyncTask(func: () => void | Promise<void>): void;
     /** --- 获取类内部的 prototype --- */
-    getPrototype(name: '_config'): types.IConfig;
-    getPrototype(name: '_sess'): session.Session | null;
+    getPrototype(name: '_config'): kebab.IConfig;
+    getPrototype(name: '_sess'): lSession.Session | null;
     getPrototype(name: '_headers'): http.IncomingHttpHeaders;
     getPrototype(name: '_req'): http2.Http2ServerRequest | http.IncomingMessage;
     getPrototype(name: '_res'): http2.Http2ServerResponse | http.ServerResponse;
     getPrototype(name: '_socket'): lWs.Socket;
-    getPrototype(name: '_rawPost' | '_post' | '_get' | '_session'): Record<string, types.Json>;
+    getPrototype(name: '_rawPost' | '_post' | '_get' | '_session'): Record<string, kebab.Json>;
     getPrototype(name: '_input'): string;
-    getPrototype(name: string): types.Json;
+    getPrototype(name: string): kebab.Json;
     /** --- 设置类内部的 prototype --- */
-    setPrototype(name: string, val: string | string[] | http.IncomingHttpHeaders | Record<string, types.Json> | session.Session | lWs.Socket | null): void;
+    setPrototype(name: string, val: string | string[] | http.IncomingHttpHeaders | Record<string, kebab.Json> | lSession.Session | lWs.Socket | null): void;
     /**
      * --- 实例化后会执行的方法，可重写此方法 ---
      */
-    onLoad(): boolean | string | types.DbValue[] | Promise<boolean | string | types.DbValue[]>;
+    onLoad(): boolean | string | kebab.DbValue[] | Promise<boolean | string | kebab.DbValue[]>;
     /**
      * --- 整个结束前会执行本方法，可重写此方法对输出结果再处理一次（Websocket 模式无效） ---
      * @param rtn 之前用户的输出结果
      */
-    onUnload(rtn: boolean | string | types.DbValue[]): boolean | string | types.DbValue[] | Promise<boolean | string | types.DbValue[]>;
+    onUnload(rtn: boolean | string | kebab.DbValue[]): boolean | string | kebab.DbValue[] | Promise<boolean | string | kebab.DbValue[]>;
     /**
      * --- WebSocket 下在建立 Server 连接之前可对 WebSocket 的信息进行配置 ---
      */
@@ -109,7 +109,7 @@ export declare class Ctr {
     /**
      * --- WebSocket 下当收到数据时会自动被调用的事件，即只文本和二进制数据，返回内容会被发送给 socket，但返回 false 连接会被中断 ---
      */
-    onData(data: Buffer | string, opcode: lWs.EOpcode): types.Json;
+    onData(data: Buffer | string, opcode: lWs.EOpcode): kebab.Json;
     /**
      * --- 包含所有 opcode 的消息，若要发送数据需自行调用 write 方法，返回 false 则不会执行默认方法 ---
      * @param data 数据
@@ -138,21 +138,21 @@ export declare class Ctr {
      * @param path
      * @param data
      */
-    protected _loadView(path: string, data?: types.Json): Promise<string>;
+    protected _loadView(path: string, data?: kebab.Json): Promise<string>;
     /**
      * --- 检测提交的数据类型 ---
      * @param input 要校验的输入项
      * @param rule 规则
      * @param rtn 返回值
      */
-    protected _checkInput(input: Record<string, types.Json>, rule: Record<string, types.Json[]>, rtn: types.Json[]): boolean;
+    protected _checkInput(input: Record<string, kebab.Json>, rule: Record<string, kebab.Json[]>, rtn: kebab.Json[]): boolean;
     /**
      * --- 检测提交的数据类型（会检测 XSRF） ---
      * @param input 要校验的输入项
      * @param rule 规则
      * @param rtn 返回值
      */
-    protected _checkXInput(input: Record<string, types.Json>, rule: Record<string, types.Json[]>, rtn: types.Json[]): boolean;
+    protected _checkXInput(input: Record<string, kebab.Json>, rule: Record<string, kebab.Json[]>, rtn: kebab.Json[]): boolean;
     /**
      * --- 当前页面开启 XSRF 支持（主要检测 cookie 是否存在） ---
      * --- 如果当前页面有 CDN，请不要使用 ---
@@ -193,7 +193,7 @@ export declare class Ctr {
      * @param auth 设为 true 则从头 Authorization 或 post _auth 值读取 token
      * @param opt name, ttl, ssl, sqlPre
      */
-    protected _startSession(link: db.Pool | kv.Pool, auth?: boolean, opt?: session.IOptions): Promise<void>;
+    protected _startSession(link: lDb.Pool | lKv.Pool, auth?: boolean, opt?: lSession.IOptions): Promise<void>;
     /**
      * --- 设定语言并加载语言包 ---
      * @param loc 要加载的目标语言
@@ -230,7 +230,7 @@ export declare class Ctr {
      * --- 发送结果对象文本 ---
      * @param data 要发送的结果对象，如 [0, 'Failed.']
      */
-    protected _writeResult(data: types.Json): boolean;
+    protected _writeResult(data: kebab.Json): boolean;
     /**
      * --- 发送 socket 二进制 ---
      * @param data 要发送的信息

package/sys/ctr.js

@@ -1,10 +1,10 @@
 import * as ejs from 'ejs';
-import * as lCore from '../lib/core.js';
-import * as fs from '../lib/fs.js';
-import * as crypto from '../lib/crypto.js';
-import * as session from '../lib/session.js';
-import * as text from '../lib/text.js';
-import * as sRoute from '../sys/route.js';
+import * as lCore from '#lib/core.js';
+import * as lFs from '#lib/fs.js';
+import * as lCrypto from '#lib/crypto.js';
+import * as lSession from '#lib/session.js';
+import * as lText from '#lib/text.js';
+import * as sRoute from '#sys/route.js';
 /** --- 已加载的 DATA 数据缓存（不是语言包）-- */
 let loadedData = {};
 /** --- 已加载的语言文件列表 --- */
@@ -112,7 +112,7 @@ export class Ctr {
                 }
             })().catch(e => {
                 lCore.display('[ERROR][CTR][ASYNCTASK]', e);
-                lCore.log(this, '[CTR][_asyncTask] ' + text.stringifyJson(e.stack).slice(1, -1), '-error');
+                lCore.log(this, '[CTR][_asyncTask] ' + lText.stringifyJson(e.stack).slice(1, -1), '-error');
                 --this._waitInfo.asyncTask.count;
                 if (!this._waitInfo.asyncTask.count) {
                     this._waitInfo.asyncTask.resolve();
@@ -184,7 +184,7 @@ export class Ctr {
      * @param data
      */
     async _loadView(path, data = {}) {
-        const content = await fs.getContent(this._config.const.viewPath + path + '.ejs', 'utf8');
+        const content = await lFs.getContent(this._config.const.viewPath + path + '.ejs', 'utf8');
         if (!content) {
             return '';
         }
@@ -485,7 +485,7 @@ export class Ctr {
      * @param pwd 密码
      */
     _getBasicAuth(user, pwd) {
-        return 'Basic ' + crypto.base64Encode(user + ':' + pwd);
+        return 'Basic ' + lCrypto.base64Encode(user + ':' + pwd);
     }
     /**
      * --- 根据用户 ua 获取当前用户的设备类型 ---
@@ -532,7 +532,7 @@ export class Ctr {
             // --- 不解析，解析使用 JWT 类解析 ---
             return authArr[1];
         }
-        if (!(auth = crypto.base64Decode(authArr[1]))) {
+        if (!(auth = lCrypto.base64Decode(authArr[1]))) {
             return false;
         }
         authArr = auth.split(':');
@@ -548,11 +548,11 @@ export class Ctr {
         if (loadedData[realPath]) {
             return loadedData[realPath];
         }
-        const content = await fs.getContent(realPath, 'utf8');
+        const content = await lFs.getContent(realPath, 'utf8');
         if (!content) {
             return null;
         }
-        const json = text.parseJson(content);
+        const json = lText.parseJson(content);
         loadedData[realPath] = json;
         return json;
     }
@@ -562,7 +562,7 @@ export class Ctr {
      */
     _location(location) {
         if (this._res) {
-            this._res.setHeader('location', text.urlResolve(this._config.const.urlBase, location));
+            this._res.setHeader('location', lText.urlResolve(this._config.const.urlBase, location));
             // this._res.writeHead(302); Kebab 中要在最后设置，否则会报错：ERR_HTTP_HEADERS_SENT
         }
         return false;
@@ -574,7 +574,7 @@ export class Ctr {
      * @param opt name, ttl, ssl, sqlPre
      */
     async _startSession(link, auth = false, opt = {}) {
-        this._sess = new session.Session();
+        this._sess = new lSession.Session();
         await this._sess.init(this, link, auth, opt);
     }
     // --- 本地化 ---
@@ -632,7 +632,7 @@ export class Ctr {
      */
     _getLocaleJsonString() {
         if (this._localeData[this._locale] !== undefined) {
-            return text.stringifyJson(this._localeData[this._locale]);
+            return lText.stringifyJson(this._localeData[this._locale]);
         }
         else {
             return '{}';