lz-nframe 1.0.2 → 1.0.3

package/lib/NApp.d.ts

@@ -5,6 +5,7 @@
 描述:
     应用基类
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
 export default abstract class NApp extends EventEmitter {
     protected appName: string;

package/lib/NCrypto.d.ts

@@ -0,0 +1,55 @@
+/*******************************************************************************
+文件: NCrypto.ts
+创建: 2026年05月10日
+作者: 老张
+描述:
+    常用编码与摘要工具：Base64、RC4 流密码、MD5/SHA1/SHA256。
+    说明：RC4 已过时，仅建议用于兼容旧协议；新系统请使用现代 AEAD 算法。
+*******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
+/** 可参与编码或摘要的二进制或文本输入（文本按 UTF-8 编码为字节） */
+export type NCryptoInput = string | Buffer | Uint8Array;
+export default class NCrypto {
+    /**
+     * 将数据编码为 Base64 字符串。
+     */
+    static base64Encode(data: NCryptoInput): string;
+    /**
+     * 将 Base64 字符串解码。
+     * @param asUtf8 为 true 时返回 UTF-8 文本；默认返回 Buffer 便于承载任意二进制。
+     */
+    static base64Decode(b64: string): Buffer;
+    static base64Decode(b64: string, asUtf8: true): string;
+    /**
+     * RC4 加密（流密码：与解密使用同一变换）。
+     */
+    static rc4Encrypt(data: NCryptoInput, key: NCryptoInput): Buffer;
+    /**
+     * RC4 解密（与加密相同，满足对称语义）。
+     */
+    static rc4Decrypt(data: NCryptoInput, key: NCryptoInput): Buffer;
+    /**
+     * MD5 摘要，返回小写十六进制字符串。
+     */
+    static md5(data: NCryptoInput): string;
+    /**
+     * SHA-1 摘要，返回小写十六进制字符串。
+     */
+    static sha1(data: NCryptoInput): string;
+    /**
+     * SHA-256 摘要，返回小写十六进制字符串。
+     */
+    static sha256(data: NCryptoInput): string;
+    /**
+     * 统一将输入转为 Buffer：字符串按 UTF-8，Buffer/Uint8Array 原样拷贝视图。
+     */
+    private static toBuffer;
+    /**
+     * 纯算法 RC4：KSA 初始化 S 盒，PRGA 生成密钥流并与数据异或。
+     */
+    private static rc4Transform;
+    /**
+     * Node crypto 摘要，输出 hex。
+     */
+    private static hashHex;
+}

package/lib/NCrypto.js

@@ -0,0 +1,108 @@
+/*******************************************************************************
+文件: NCrypto.ts
+创建: 2026年05月10日
+作者: 老张
+描述:
+    常用编码与摘要工具：Base64、RC4 流密码、MD5/SHA1/SHA256。
+    说明：RC4 已过时，仅建议用于兼容旧协议；新系统请使用现代 AEAD 算法。
+*******************************************************************************/
+import { createHash } from 'node:crypto';
+export default class NCrypto {
+    /**
+     * 将数据编码为 Base64 字符串。
+     */
+    static base64Encode(data) {
+        return NCrypto.toBuffer(data).toString('base64');
+    }
+    static base64Decode(b64, asUtf8) {
+        const buf = Buffer.from(b64, 'base64');
+        if (asUtf8 === true) {
+            return buf.toString('utf8');
+        }
+        return buf;
+    }
+    /**
+     * RC4 加密（流密码：与解密使用同一变换）。
+     */
+    static rc4Encrypt(data, key) {
+        const dataBuf = NCrypto.toBuffer(data);
+        const keyBuf = NCrypto.toBuffer(key);
+        if (keyBuf.length === 0) {
+            throw new Error('RC4 密钥长度不能为 0');
+        }
+        return NCrypto.rc4Transform(dataBuf, keyBuf);
+    }
+    /**
+     * RC4 解密（与加密相同，满足对称语义）。
+     */
+    static rc4Decrypt(data, key) {
+        return NCrypto.rc4Encrypt(data, key);
+    }
+    /**
+     * MD5 摘要，返回小写十六进制字符串。
+     */
+    static md5(data) {
+        return NCrypto.hashHex('md5', data);
+    }
+    /**
+     * SHA-1 摘要，返回小写十六进制字符串。
+     */
+    static sha1(data) {
+        return NCrypto.hashHex('sha1', data);
+    }
+    /**
+     * SHA-256 摘要，返回小写十六进制字符串。
+     */
+    static sha256(data) {
+        return NCrypto.hashHex('sha256', data);
+    }
+    /**
+     * 统一将输入转为 Buffer：字符串按 UTF-8，Buffer/Uint8Array 原样拷贝视图。
+     */
+    static toBuffer(data) {
+        if (typeof data === 'string') {
+            return Buffer.from(data, 'utf8');
+        }
+        if (Buffer.isBuffer(data)) {
+            return data;
+        }
+        return Buffer.from(data);
+    }
+    /**
+     * 纯算法 RC4：KSA 初始化 S 盒，PRGA 生成密钥流并与数据异或。
+     */
+    static rc4Transform(data, key) {
+        const s = new Uint8Array(256);
+        for (let i = 0; i < 256; i++) {
+            s[i] = i;
+        }
+        let j = 0;
+        for (let i = 0; i < 256; i++) {
+            j = (j + s[i] + key[i % key.length]) % 256;
+            const si = s[i];
+            s[i] = s[j];
+            s[j] = si;
+        }
+        let i = 0;
+        j = 0;
+        const out = Buffer.alloc(data.length);
+        for (let k = 0; k < data.length; k++) {
+            i = (i + 1) % 256;
+            j = (j + s[i]) % 256;
+            const si = s[i];
+            s[i] = s[j];
+            s[j] = si;
+            const t = (s[i] + s[j]) % 256;
+            out[k] = data[k] ^ s[t];
+        }
+        return out;
+    }
+    /**
+     * Node crypto 摘要，输出 hex。
+     */
+    static hashHex(algorithm, data) {
+        const buf = NCrypto.toBuffer(data);
+        // 使用 Uint8Array 视图满足当前 @types/node 下 Hash.update 对 BinaryLike 的推导
+        return createHash(algorithm).update(new Uint8Array(buf)).digest('hex');
+    }
+}

package/lib/NHttpClient.d.ts

@@ -7,6 +7,7 @@
     - 支持自动处理中文 URL 编码
     - 支持泛型与类型安全
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
 import * as http from 'http';
 /**
  * 请求配置接口

package/lib/NHttpClient.js

@@ -126,10 +126,10 @@ export default class NHttpClient {
         // 依次检查各代理 header
         const candidates = [
             getHeader('x-real-ip'),
-            getHeader('cf-connecting-ip'), // Cloudflare
-            getHeader('true-client-ip'), // Akamai / Cloudflare Enterprise
+            getHeader('cf-connecting-ip'),
+            getHeader('true-client-ip'),
             getHeader('x-client-ip'),
-            getHeader('x-forwarded-for'), // 通用代理，可能含多个 IP
+            getHeader('x-forwarded-for'),
             getHeader('proxy-client-ip'),
             getHeader('wl-proxy-client-ip'),
         ];

package/lib/NSimpleHttpServer.d.ts

@@ -21,6 +21,7 @@
         }, {contentType: ContentType.TextPlain})
         .start(3000);
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
 import * as http from 'http';
 export default class NSimpleHttpServer {
     private server;

package/lib/NSimpleHttpServer.js

@@ -219,4 +219,4 @@ export var ContentType;
     ContentType["TextHtml"] = "Content-Type: text/html; charset=utf-8;";
     ContentType["TextPlain"] = "Content-Type: text/plain; charset=utf-8;";
     ContentType["ApplicationJson"] = "Content-Type: application/json; charset=utf-8;";
-})(ContentType || (ContentType = {}));
+})(ContentType = ContentType || (ContentType = {}));

package/lib/NWSClient.d.ts

@@ -11,6 +11,8 @@ websocket事件：
     ✦onclose websocket关闭时触发该事件
     ✦onmessage 接收到消息
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
 export default class NWSClient extends EventEmitter {
     static EventError: string;

package/lib/NWSServer.d.ts

@@ -11,6 +11,8 @@ websocket事件：
     ✦onclose websocket关闭时触发该事件
     ✦onmessage 接收到消息
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
 import { NWSSocket } from './NWSSocket.js';
 export default class NWSServer extends EventEmitter {

package/lib/NWSServiceHub.d.ts

@@ -73,6 +73,7 @@
 TODO:
     1.路由
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
 /**
  * 协议名说明（PacketType）：

package/lib/NWSUserClientJ.d.ts

@@ -14,6 +14,7 @@
     ✦_si_  服务端下发 resign 时须回传登录载荷；服务端下发 ok 表示登录完成
     ✦_hb_  心跳，收到后原样应答
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
 /** 与 NWSUserMgrJ 配套的 JSON WebSocket 客户端 */
 export default class NWSUserClientJ extends EventEmitter {

package/lib/NWSUserMgrJ.d.ts

@@ -26,6 +26,7 @@
 
 TODO 复用http服务端口，https://blog.csdn.net/qq_44856695/article/details/120250286
 *******************************************************************************/
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
 import NWSServer from './NWSServer.js';
 /** 基于NWSServer的实时联网用户管理，通信格式使用json */

package/lib/index.d.ts

@@ -18,5 +18,7 @@ export type { NWSServiceHubOptions, NWSServicePeerConfig } from './NWSServiceHub
 export { default as NWSUserClientJ } from './NWSUserClientJ.js';
 export { default as NWSUserMgrJ } from './NWSUserMgrJ.js';
 export type { NestedKeyOf, PlainType, PlainValue, ValueAtPath } from './NType.js';
+export { default as NCrypto } from './NCrypto.js';
+export type { NCryptoInput } from './NCrypto.js';
 /** 与旧版 main 指向 NApp.js 一致：默认导出仍为 NApp */
 export { default } from './NApp.js';

package/lib/index.js

@@ -14,5 +14,6 @@ export { default as NWSServer } from './NWSServer.js';
 export { default as NWSServiceHub } from './NWSServiceHub.js';
 export { default as NWSUserClientJ } from './NWSUserClientJ.js';
 export { default as NWSUserMgrJ } from './NWSUserMgrJ.js';
+export { default as NCrypto } from './NCrypto.js';
 /** 与旧版 main 指向 NApp.js 一致：默认导出仍为 NApp */
 export { default } from './NApp.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lz-nframe",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
   "type": "module",
   "main": "./lib/index.js",
@@ -15,8 +15,8 @@
   },
   "scripts": {
     "build": "tsc",
-    "test": "node --import tsx --test test/NConfigsMgr.test.ts test/NHttpClient.test.ts test/NWSClient.test.ts test/NWSUserClientJ.test.ts test/NWSServiceHub.test.ts",
-    "test:watch": "node --import tsx --test --watch test/NConfigsMgr.test.ts test/NHttpClient.test.ts test/NWSClient.test.ts test/NWSUserClientJ.test.ts test/NWSServiceHub.test.ts"
+    "test": "node --import tsx --test test/NConfigsMgr.test.ts test/NHttpClient.test.ts test/NWSClient.test.ts test/NWSUserClientJ.test.ts test/NWSServiceHub.test.ts test/NCrypto.test.ts",
+    "test:watch": "node --import tsx --test --watch test/NConfigsMgr.test.ts test/NHttpClient.test.ts test/NWSClient.test.ts test/NWSUserClientJ.test.ts test/NWSServiceHub.test.ts test/NCrypto.test.ts"
   },
   "author": "",
   "license": "ISC",