lz-nframe 1.0.1 → 1.0.3

package/lib/NConfigsMgr.d.ts

@@ -11,7 +11,7 @@
 
     获取配置时的顺序：【动态配置】->【本地配置】->【默认配置】
 *******************************************************************************/
-import { NestedKeyOf, ValueAtPath } from './NType';
+import { NestedKeyOf, ValueAtPath } from './NType.js';
 export default class NConfigsMgr<T extends object> {
     get configs(): T;
     private defaultConfigs;

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/NWSClient.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { EventEmitter } from 'events';
 import WebSocket from 'ws';
-import { NWSSocket } from './NWSSocket';
+import { NWSSocket } from './NWSSocket.js';
 class NWSClient extends EventEmitter {
     get connected() {
         return this._connected;

package/lib/NWSServer.d.ts

@@ -14,7 +14,7 @@ websocket事件：
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
-import { NWSSocket } from './NWSSocket';
+import { NWSSocket } from './NWSSocket.js';
 export default class NWSServer extends EventEmitter {
     static EventError: string;
     static EventServiceStarted: string;

package/lib/NWSServer.js

@@ -12,9 +12,9 @@ websocket事件：
     ✦onmessage 接收到消息
 *******************************************************************************/
 import { EventEmitter } from 'events';
-import WebSocket from 'ws'; // 1. 替换导入
-import { NWSSocket } from './NWSSocket';
-import NHttpClient from './NHttpClient';
+import WebSocket, { WebSocketServer } from 'ws';
+import { NWSSocket } from './NWSSocket.js';
+import NHttpClient from './NHttpClient.js';
 class NWSServer extends EventEmitter {
     constructor(params) {
         super();
@@ -28,7 +28,7 @@ class NWSServer extends EventEmitter {
             this.wsServer.close();
             this.wsServer = null;
         }
-        this.wsServer = new WebSocket.Server({
+        this.wsServer = new WebSocketServer({
             port,
             host,
             WebSocket: NWSSocket,

package/lib/NWSServiceHub.js

@@ -83,8 +83,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { EventEmitter } from 'events';
-import NWSClient from './NWSClient';
-import NWSServer from './NWSServer';
+import NWSClient from './NWSClient.js';
+import NWSServer from './NWSServer.js';
 class NWSServiceHub extends EventEmitter {
     constructor(options) {
         super();

package/lib/NWSUserClientJ.js

@@ -24,7 +24,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { EventEmitter } from 'events';
-import NWSClient from './NWSClient';
+import NWSClient from './NWSClient.js';
 /** 与 NWSUserMgrJ 配套的 JSON WebSocket 客户端 */
 class NWSUserClientJ extends EventEmitter {
     /** 是否已与服务器建立 WebSocket（不代表已完成 _si_ 验证） */

package/lib/NWSUserMgrJ.d.ts

@@ -28,7 +28,7 @@ TODO 复用http服务端口，https://blog.csdn.net/qq_44856695/article/details/
 *******************************************************************************/
 /// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
-import NWSServer from './NWSServer';
+import NWSServer from './NWSServer.js';
 /** 基于NWSServer的实时联网用户管理，通信格式使用json */
 export default class NWSUserMgrJ extends EventEmitter {
     /** 用户掉线，已考虑超时问题，如果设置超时非0，则socket掉线会等候用户重连，重连成功不认定掉线 */

package/lib/NWSUserMgrJ.js

@@ -27,7 +27,7 @@
 TODO 复用http服务端口，https://blog.csdn.net/qq_44856695/article/details/120250286
 *******************************************************************************/
 import { EventEmitter } from 'events';
-import NWSServer from './NWSServer';
+import NWSServer from './NWSServer.js';
 import NUtils from 'lz-nutils';
 /** 基于NWSServer的实时联网用户管理，通信格式使用json */
 class NWSUserMgrJ extends EventEmitter {

package/lib/index.d.ts

@@ -0,0 +1,24 @@
+/*******************************************************************************
+文件: index.ts
+描述:
+    包聚合导出：发布后可通过 import from 'lz-nframe' 引用下列公开 API；
+    仍支持子路径 import 'lz-nframe/lib/xxx.js'（见 package.json exports）。
+*******************************************************************************/
+export { default as NApp } from './NApp.js';
+export { default as NConfigsMgr } from './NConfigsMgr.js';
+export { default as NHttpClient } from './NHttpClient.js';
+export type { ApiResult } from './NHttpClient.js';
+export { default as NSimpleHttpServer, ContentType } from './NSimpleHttpServer.js';
+export type { SimplePage } from './NSimpleHttpServer.js';
+export { NWSSocket } from './NWSSocket.js';
+export { default as NWSClient } from './NWSClient.js';
+export { default as NWSServer } from './NWSServer.js';
+export { default as NWSServiceHub } from './NWSServiceHub.js';
+export type { NWSServiceHubOptions, NWSServicePeerConfig } from './NWSServiceHub.js';
+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

@@ -0,0 +1,19 @@
+/*******************************************************************************
+文件: index.ts
+描述:
+    包聚合导出：发布后可通过 import from 'lz-nframe' 引用下列公开 API；
+    仍支持子路径 import 'lz-nframe/lib/xxx.js'（见 package.json exports）。
+*******************************************************************************/
+export { default as NApp } from './NApp.js';
+export { default as NConfigsMgr } from './NConfigsMgr.js';
+export { default as NHttpClient } from './NHttpClient.js';
+export { default as NSimpleHttpServer, ContentType } from './NSimpleHttpServer.js';
+export { NWSSocket } from './NWSSocket.js';
+export { default as NWSClient } from './NWSClient.js';
+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,13 +1,22 @@
 {
   "name": "lz-nframe",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "",
   "type": "module",
-  "main": "./lib/NApp.js",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./lib/*": "./lib/*"
+  },
   "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",