@maiyunnet/kebab 2.0.7 → 2.0.9

package/lib/zip.js

@@ -41,13 +41,23 @@ exports.get = get;
 const jszip_1 = __importDefault(require("jszip"));
 const mime = __importStar(require("@litert/mime"));
 const lText = __importStar(require("../lib/text"));
+/**
+ * --- 本库主要用于读取 zip，请尽量不要用来写入 zip，尤其是大文件 zip ---
+ */
 class Zip {
     constructor(zip) {
+        /** --- 当前路径，以 / 开头以 / 结尾 --- */
         this._path = '/';
+        /** --- 目录列表缓存 --- */
         this._list = {};
         this._zip = zip;
         this._refreshList();
     }
+    /**
+     * --- 读取完整文件 ---
+     * @param path 文件路径
+     * @param type 返回类型
+     */
     async getContent(path, type = 'string') {
         path = lText.urlResolve(this._path, path);
         const f = this._zip.file(path.slice(1));
@@ -61,6 +71,12 @@ class Zip {
             return f.async(type);
         }
     }
+    /**
+     * --- 写入文件内容 ---
+     * @param path 文件路径
+     * @param data 要写入的内容
+     * @param options 选项
+     */
     putContent(path, data, options = {}) {
         path = lText.urlResolve(this._path, path);
         this._zip.file(path.slice(1), data, {
@@ -70,22 +86,34 @@ class Zip {
         });
         this._refreshList();
     }
+    /**
+     * --- 删除一个文件/文件夹（深度删除） ---
+     * @param path 要删除的文件路径
+     */
     unlink(path) {
         path = lText.urlResolve(this._path, path);
         this._zip.remove(path.slice(1));
         this._refreshList();
     }
+    /**
+     * --- 获取对象是否存在，存在则返回 stats 对象，否则返回 null ---
+     * @param path 对象路径
+     * @param options 选项
+     */
     stats(path) {
         path = lText.urlResolve(this._path, path);
         let dirpath = path.endsWith('/') ? path : path + '/';
         if (!this._list[dirpath]) {
+            // --- 可能是文件 ---
             if (path.endsWith('/')) {
+                // --- 不可能是文件 ---
                 return null;
             }
             const lio = path.lastIndexOf('/') + 1;
             const dpath = path.slice(0, lio);
             const fname = path.slice(lio);
             if (!this._list[dpath]) {
+                // --- 上层目录不存在 ---
                 return null;
             }
             const file = this._list[dpath][fname];
@@ -101,6 +129,7 @@ class Zip {
             };
         }
         else {
+            // --- 文件夹 ---
             if (dirpath === '/') {
                 return {
                     'compressedSize': 0,
@@ -125,6 +154,10 @@ class Zip {
             };
         }
     }
+    /**
+     * --- 判断是否是目录或目录是否存在，是的话返回 stats ---
+     * @param path 判断路径
+     */
     isDir(path) {
         const pstats = this.stats(path);
         if (!pstats?.isDirectory) {
@@ -132,6 +165,10 @@ class Zip {
         }
         return pstats;
     }
+    /**
+     * --- 判断是否是文件或文件是否存在，是的话返回 stats ---
+     * @param path 判断路径
+     */
     isFile(path) {
         const pstats = this.stats(path);
         if (!pstats?.isFile) {
@@ -139,6 +176,11 @@ class Zip {
         }
         return pstats;
     }
+    /**
+     * --- 获取文件夹下文件列表 ---
+     * @param path 文件夹路径
+     * @param opt 选项
+     */
     readDir(path, opt = {}) {
         if (opt.hasChildren === undefined) {
             opt.hasChildren = false;
@@ -175,8 +217,10 @@ class Zip {
             }
             return list;
         }
+        // --- 定义 list ---
         if (opt.pathAsKey) {
             const list = {};
+            // --- 遍历子项 ---
             for (const k in this._list[path]) {
                 const item = this._list[path][k];
                 if (item.isFile || opt.hasDir) {
@@ -193,6 +237,7 @@ class Zip {
         }
         else {
             let list = [];
+            // --- 遍历子项 ---
             for (const k in this._list[path]) {
                 const item = this._list[path][k];
                 if (item.isFile || opt.hasDir) {
@@ -208,6 +253,10 @@ class Zip {
             return list;
         }
     }
+    /**
+     * --- 根据 item 文件夹读取子层及所有子层项 ---
+     * @param item 文件夹
+     */
     _readDir(item, opt) {
         if (opt.pathAsKey) {
             const list = {};
@@ -248,8 +297,12 @@ class Zip {
             return list;
         }
     }
+    /**
+     * --- 重建目录列表缓存 ---
+     */
     _refreshList() {
         const list = {};
+        // eslint-disable-next-line @litert/rules/disable-for-each-method
         this._zip.forEach(function (relativePath, item) {
             if (relativePath.startsWith('/')) {
                 relativePath = relativePath.slice(1);
@@ -288,9 +341,18 @@ class Zip {
         });
         this._list = list;
     }
+    /**
+     * --- 获取当前目录，末尾不带 / ---
+     * @return string
+     */
     pwd() {
         return this._path.slice(0, -1);
     }
+    /**
+     * --- 进入一个目录（不存在也能进入，需要自行判断） ---
+     * --- 返回进入后的路径值 ---
+     * @param dir 相对路径或绝对路径
+     */
     cd(dir) {
         this._path = lText.urlResolve(this._path, dir);
         if (!this._path.endsWith('/')) {
@@ -298,6 +360,10 @@ class Zip {
         }
         return this._path;
     }
+    /**
+     * --- 打包 zip ---
+     * @param options 选项
+     */
     generate(options = {}) {
         const opt = {};
         if (options.type === undefined) {
@@ -319,6 +385,9 @@ class Zip {
             options.onUpdate?.(meta.percent, meta.currentFile);
         });
     }
+    /**
+     * --- 获取 path 和 string/Buffer 对应的文件列表 ---
+     */
     getList() {
         return new Promise((resolve) => {
             const files = {};
@@ -367,6 +436,10 @@ class Zip {
     }
 }
 exports.Zip = Zip;
+/**
+ * --- 获取 zip 对象 ---
+ * @param data 对象数据
+ */
 async function get(data) {
     const z = (0, jszip_1.default)();
     try {

package/lib/zlib.d.ts

@@ -1,25 +1,101 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-4-9 16:00:55
+ * Last: 2020-03-20 14:45:47, 2022-09-13 13:43:32
+ */
 import * as zlib from 'zlib';
+/** 某个压缩对象 */
 export interface ICompress {
     readonly type: string;
     readonly compress: zlib.Deflate | zlib.Gzip | zlib.BrotliCompress | zlib.Inflate | zlib.Gunzip | zlib.BrotliDecompress;
 }
+/** 某个压缩后的变量 */
 export interface ICompressBuffer {
     readonly type: string;
     readonly buffer: Buffer;
 }
+/**
+ * --- 创建 Gzip 对象 ---
+ * @param options 选项
+ */
 export declare function createGzip(options?: zlib.ZlibOptions): zlib.Gzip;
+/**
+ * --- 创建 Gzip 解压对象 ---
+ */
 export declare function createGunzip(): zlib.Gunzip;
+/**
+ * --- 创建 Deflate 对象 ---
+ * @param options 选项
+ */
 export declare function createDeflate(options?: zlib.ZlibOptions): zlib.Deflate;
+/**
+ * --- 创建 Deflate 解压对象 ---
+ */
 export declare function createInflate(): zlib.Inflate;
+/**
+ * --- 创建 Brotli 压缩对象 ---
+ * @param options 选项
+ */
 export declare function createBrotliCompress(options?: zlib.ZlibOptions): zlib.BrotliCompress;
+/**
+ * --- 创建 Brotli 解压对象 ---
+ */
 export declare function createBrotliDecompress(): zlib.BrotliDecompress;
+/**
+ * --- 根据字符串创建压缩类型 ---
+ * @param types 用 , 间隔的字符串，如 gzip,deflate
+ * @param options 选项
+ */
 export declare function createCompress(types: string, options?: zlib.ZlibOptions): ICompress | null;
+/**
+ * --- 根据字符串创建解压类型 ---
+ * @param types 用 , 间隔的字符串，如 gzip,deflate
+ * @param options 选项
+ */
 export declare function createDecompress(types: string): ICompress | null;
+/**
+ * Gzip 压缩一段
+ * @param buffer 段
+ * @param options 选项
+ */
 export declare function gzip(buffer: zlib.InputType, options?: zlib.ZlibOptions): Promise<Buffer | null>;
+/**
+ * Gzip 解压一段
+ * @param buffer 段
+ */
 export declare function gunzip(buffer: zlib.InputType): Promise<Buffer | null>;
+/**
+ * Deflate 压缩一段
+ * @param buffer 段
+ * @param options 选项
+ */
 export declare function deflate(buffer: zlib.InputType, options?: zlib.ZlibOptions): Promise<Buffer | null>;
+/**
+ * Deflate 解压一段
+ * @param buffer 段
+ */
 export declare function inflate(buffer: zlib.InputType): Promise<Buffer | null>;
+/**
+ * Brotli 压缩一段
+ * @param buffer 段
+ * @param options 选项
+ */
 export declare function brotliCompress(buffer: zlib.InputType, options?: zlib.ZlibOptions): Promise<Buffer | null>;
+/**
+ * Brotli 解压一段
+ * @param buffer 段
+ */
 export declare function brotliDecompress(buffer: zlib.InputType): Promise<Buffer | null>;
+/**
+ * --- 根据 types 判断用什么加密的段 ---
+ * @param types 用,间隔的字符串，如 gzip,deflate
+ * @param buffer 段
+ * @param options 选项
+ */
 export declare function compress(types: string, buffer: zlib.InputType | null, options?: zlib.ZlibOptions): Promise<ICompressBuffer | null>;
+/**
+ * --- 根据 types 判断用什么解密的段 ---
+ * @param types 用,间隔的字符串，如 gzip,deflate
+ * @param buffer 段
+ */
 export declare function decompress(types: string, buffer: zlib.InputType | null): Promise<ICompressBuffer | null>;

package/lib/zlib.js

@@ -49,34 +49,65 @@ exports.brotliCompress = brotliCompress;
 exports.brotliDecompress = brotliDecompress;
 exports.compress = compress;
 exports.decompress = decompress;
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-4-9 16:00:55
+ * Last: 2020-03-20 14:45:47, 2022-09-13 13:43:32
+ */
 const zlib = __importStar(require("zlib"));
+/**
+ * --- 创建 Gzip 对象 ---
+ * @param options 选项
+ */
 function createGzip(options = {}) {
     if (!options.level) {
         options.level = 7;
     }
     return zlib.createGzip(options);
 }
+/**
+ * --- 创建 Gzip 解压对象 ---
+ */
 function createGunzip() {
     return zlib.createGunzip();
 }
+/**
+ * --- 创建 Deflate 对象 ---
+ * @param options 选项
+ */
 function createDeflate(options = {}) {
     if (!options.level) {
         options.level = 7;
     }
     return zlib.createDeflate(options);
 }
+/**
+ * --- 创建 Deflate 解压对象 ---
+ */
 function createInflate() {
     return zlib.createInflate();
 }
+/**
+ * --- 创建 Brotli 压缩对象 ---
+ * @param options 选项
+ */
 function createBrotliCompress(options = {}) {
     if (!options.level) {
         options.level = 7;
     }
     return zlib.createBrotliCompress(options);
 }
+/**
+ * --- 创建 Brotli 解压对象 ---
+ */
 function createBrotliDecompress() {
     return zlib.createBrotliDecompress();
 }
+/**
+ * --- 根据字符串创建压缩类型 ---
+ * @param types 用 , 间隔的字符串，如 gzip,deflate
+ * @param options 选项
+ */
 function createCompress(types, options = {}) {
     if (!options.level) {
         options.level = 7;
@@ -107,6 +138,11 @@ function createCompress(types, options = {}) {
     }
     return null;
 }
+/**
+ * --- 根据字符串创建解压类型 ---
+ * @param types 用 , 间隔的字符串，如 gzip,deflate
+ * @param options 选项
+ */
 function createDecompress(types) {
     const type = getTypeByTypes(types);
     if (!type) {
@@ -134,6 +170,11 @@ function createDecompress(types) {
     }
     return null;
 }
+/**
+ * Gzip 压缩一段
+ * @param buffer 段
+ * @param options 选项
+ */
 function gzip(buffer, options = {}) {
     if (!options.level) {
         options.level = 7;
@@ -149,6 +190,10 @@ function gzip(buffer, options = {}) {
         });
     });
 }
+/**
+ * Gzip 解压一段
+ * @param buffer 段
+ */
 function gunzip(buffer) {
     return new Promise(function (resolve) {
         zlib.gunzip(buffer, function (error, result) {
@@ -161,6 +206,11 @@ function gunzip(buffer) {
         });
     });
 }
+/**
+ * Deflate 压缩一段
+ * @param buffer 段
+ * @param options 选项
+ */
 function deflate(buffer, options = {}) {
     if (!options.level) {
         options.level = 7;
@@ -176,6 +226,10 @@ function deflate(buffer, options = {}) {
         });
     });
 }
+/**
+ * Deflate 解压一段
+ * @param buffer 段
+ */
 function inflate(buffer) {
     return new Promise(function (resolve) {
         zlib.inflate(buffer, function (error, result) {
@@ -188,6 +242,11 @@ function inflate(buffer) {
         });
     });
 }
+/**
+ * Brotli 压缩一段
+ * @param buffer 段
+ * @param options 选项
+ */
 function brotliCompress(buffer, options = {}) {
     if (!options.level) {
         options.level = 7;
@@ -203,6 +262,10 @@ function brotliCompress(buffer, options = {}) {
         });
     });
 }
+/**
+ * Brotli 解压一段
+ * @param buffer 段
+ */
 function brotliDecompress(buffer) {
     return new Promise(function (resolve) {
         zlib.brotliDecompress(buffer, function (error, result) {
@@ -215,6 +278,12 @@ function brotliDecompress(buffer) {
         });
     });
 }
+/**
+ * --- 根据 types 判断用什么加密的段 ---
+ * @param types 用,间隔的字符串，如 gzip,deflate
+ * @param buffer 段
+ * @param options 选项
+ */
 async function compress(types, buffer, options) {
     if (!buffer) {
         return null;
@@ -246,6 +315,11 @@ async function compress(types, buffer, options) {
         'buffer': outBuffer
     };
 }
+/**
+ * --- 根据 types 判断用什么解密的段 ---
+ * @param types 用,间隔的字符串，如 gzip,deflate
+ * @param buffer 段
+ */
 async function decompress(types, buffer) {
     if (!buffer) {
         return null;
@@ -277,6 +351,10 @@ async function decompress(types, buffer) {
         'buffer': outBuffer
     };
 }
+/**
+ * --- 根据 types 字符串获取优先 type
+ * @param types types 字符串
+ */
 function getTypeByTypes(types) {
     const typesArray = types.split(',');
     for (let type of typesArray) {

package/main.d.ts

@@ -1 +1,6 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-3-29 18:55:35
+ * Last: 2020-3-6 22:19:37, 2022-3-30 01:01:22, 2022-9-27 16:11:40, 2025-6-13 12:56:18
+ */
 import 'ts-alias-loader';

package/main.js

@@ -1,4 +1,11 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-floating-promises */
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-3-29 18:55:35
+ * Last: 2020-3-6 22:19:37, 2022-3-30 01:01:22, 2022-9-27 16:11:40, 2025-6-13 12:56:18
+ */
+// git config core.ignorecase false
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -37,12 +44,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const cluster_1 = __importDefault(require("cluster"));
+// --- 虽然框架本身不用，但是业务侧会用到，所以这个库不能删 ---
 require("ts-alias-loader");
+// --- 初始化 ---
+// --- 一定要分别隔离加载 Master 和 Child 代码，防止执行串了 ---
 if (cluster_1.default.isPrimary) {
     if (process.argv.length > 2) {
+        // --- 传入的命令方式启动，则执行 RPC 相关命令 ---
         Promise.resolve().then(() => __importStar(require('./sys/cmd')));
     }
     else {
+        // --- 正常启动 ---
         Promise.resolve().then(() => __importStar(require('./sys/master')));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maiyunnet/kebab",
-  "version": "2.0.7",
+  "version": "2.0.9",
   "description": "Simple, easy-to-use, and fully-featured Node.js framework that is ready-to-use out of the box.",
   "keywords": [
     "kebab",
@@ -25,7 +25,8 @@
     "jszip": "^3.10.1",
     "mysql2": "^3.14.1",
     "ssh2": "^1.16.0",
-    "svg-captcha": "^1.4.0"
+    "svg-captcha": "^1.4.0",
+    "ts-alias-loader": "^0.1.5"
   },
   "devDependencies": {
     "@litert/eslint-plugin-rules": "^0.3.1",