@feng3d/chuantou-shared 0.0.4 → 0.0.6

package/README.md

@@ -23,18 +23,9 @@ import { MessageType, ProxyConfig, ClientConfig } from '@feng3d/chuantou-shared'
 // 创建代理配置
 const proxyConfig: ProxyConfig = {
   remotePort: 8080,
-  protocol: 'http',
   localPort: 3000,
   localHost: 'localhost'
 };
-
-// 创建消息
-const message = createMessage(MessageType.REGISTER, {
-  remotePort: 8080,
-  protocol: 'http',
-  localPort: 3000,
-  localHost: 'localhost'
-});
 ```
 
 ## 类型
@@ -46,12 +37,15 @@ const message = createMessage(MessageType.REGISTER, {
 ```typescript
 interface ProxyConfig {
   remotePort: number;      // 公网端口
-  protocol: 'http' | 'websocket';  // 协议类型
   localPort: number;       // 本地端口
-  localHost?: string;      // 本地地址
+  localHost?: string;      // 本地地址（默认：localhost）
 }
 ```
 
+**推荐**：本地地址为 localhost 时推荐省略，使用 `8080:3000` 而非 `8080:3000:localhost`。
+
+每个代理端口同时支持 HTTP 和 WebSocket 协议，无需单独指定协议类型。
+
 ### ClientConfig
 
 客户端配置接口：

package/dist/index.d.ts

@@ -1,3 +1,15 @@
+/**
+ * @module shared
+ *
+ * 穿透代理共享模块入口。
+ *
+ * 本模块统一导出穿透代理系统中客户端与服务端共用的所有类型定义、
+ * 消息结构、协议常量和工具函数，作为 `@chuantou/shared` 包的公共 API 入口。
+ */
+/** 导出所有消息类型、消息接口及消息工具函数 */
 export * from './messages.js';
+/** 导出协议常量、错误码、默认配置及各类配置接口 */
 export * from './protocol.js';
+/** 导出日志工具 */
+export * from './logger.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAE9B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,2BAA2B;AAC3B,cAAc,eAAe,CAAC;AAC9B,6BAA6B;AAC7B,cAAc,eAAe,CAAC;AAC9B,aAAa;AACb,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -1,5 +1,15 @@
-// 导出所有消息类型
+/**
+ * @module shared
+ *
+ * 穿透代理共享模块入口。
+ *
+ * 本模块统一导出穿透代理系统中客户端与服务端共用的所有类型定义、
+ * 消息结构、协议常量和工具函数，作为 `@chuantou/shared` 包的公共 API 入口。
+ */
+/** 导出所有消息类型、消息接口及消息工具函数 */
 export * from './messages.js';
-// 导出协议定义
+/** 导出协议常量、错误码、默认配置及各类配置接口 */
 export * from './protocol.js';
+/** 导出日志工具 */
+export * from './logger.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,cAAc,eAAe,CAAC;AAC9B,SAAS;AACT,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,2BAA2B;AAC3B,cAAc,eAAe,CAAC;AAC9B,6BAA6B;AAC7B,cAAc,eAAe,CAAC;AAC9B,aAAa;AACb,cAAc,aAAa,CAAC"}

package/dist/logger.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @module logger
+ *
+ * 日志工具模块，提供带时间戳的日志输出功能。
+ */
+/**
+ * 带时间戳的日志工具
+ */
+export declare const logger: {
+    /**
+     * 输出信息日志
+     *
+     * @param message - 日志消息
+     */
+    log: (...message: unknown[]) => void;
+    /**
+     * 输出信息日志（别名）
+     *
+     * @param message - 日志消息
+     */
+    info: (...message: unknown[]) => void;
+    /**
+     * 输出警告日志
+     *
+     * @param message - 日志消息
+     */
+    warn: (...message: unknown[]) => void;
+    /**
+     * 输出错误日志
+     *
+     * @param message - 日志消息
+     */
+    error: (...message: unknown[]) => void;
+};
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAgBH;;GAEG;AACH,eAAO,MAAM,MAAM;IACjB;;;;OAIG;sBACe,OAAO,EAAE,KAAG,IAAI;IAIlC;;;;OAIG;uBACgB,OAAO,EAAE,KAAG,IAAI;IAInC;;;;OAIG;uBACgB,OAAO,EAAE,KAAG,IAAI;IAInC;;;;OAIG;wBACiB,OAAO,EAAE,KAAG,IAAI;CAGrC,CAAC"}

package/dist/logger.js

@@ -0,0 +1,56 @@
+/**
+ * @module logger
+ *
+ * 日志工具模块，提供带时间戳的日志输出功能。
+ */
+/**
+ * 格式化当前时间为日志时间戳
+ *
+ * @returns 格式化的时间字符串，格式为 HH:MM:SS.mmm
+ */
+function formatTimestamp() {
+    const now = new Date();
+    const hours = String(now.getHours()).padStart(2, '0');
+    const minutes = String(now.getMinutes()).padStart(2, '0');
+    const seconds = String(now.getSeconds()).padStart(2, '0');
+    const ms = String(now.getMilliseconds()).padStart(3, '0');
+    return `${hours}:${minutes}:${seconds}.${ms}`;
+}
+/**
+ * 带时间戳的日志工具
+ */
+export const logger = {
+    /**
+     * 输出信息日志
+     *
+     * @param message - 日志消息
+     */
+    log: (...message) => {
+        console.log(`[${formatTimestamp()}]`, ...message);
+    },
+    /**
+     * 输出信息日志（别名）
+     *
+     * @param message - 日志消息
+     */
+    info: (...message) => {
+        console.log(`[${formatTimestamp()}]`, ...message);
+    },
+    /**
+     * 输出警告日志
+     *
+     * @param message - 日志消息
+     */
+    warn: (...message) => {
+        console.warn(`[${formatTimestamp()}]`, ...message);
+    },
+    /**
+     * 输出错误日志
+     *
+     * @param message - 日志消息
+     */
+    error: (...message) => {
+        console.error(`[${formatTimestamp()}]`, ...message);
+    },
+};
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,SAAS,eAAe;IACtB,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1D,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1D,OAAO,GAAG,KAAK,IAAI,OAAO,IAAI,OAAO,IAAI,EAAE,EAAE,CAAC;AAChD,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB;;;;OAIG;IACH,GAAG,EAAE,CAAC,GAAG,OAAkB,EAAQ,EAAE;QACnC,OAAO,CAAC,GAAG,CAAC,IAAI,eAAe,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE,CAAC,GAAG,OAAkB,EAAQ,EAAE;QACpC,OAAO,CAAC,GAAG,CAAC,IAAI,eAAe,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE,CAAC,GAAG,OAAkB,EAAQ,EAAE;QACpC,OAAO,CAAC,IAAI,CAAC,IAAI,eAAe,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,KAAK,EAAE,CAAC,GAAG,OAAkB,EAAQ,EAAE;QACrC,OAAO,CAAC,KAAK,CAAC,IAAI,eAAe,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC;IACtD,CAAC;CACF,CAAC"}

package/dist/messages.d.ts

@@ -1,176 +1,316 @@
+/**
+ * @module messages
+ *
+ * 穿透代理消息定义模块。
+ *
+ * 本模块定义了穿透代理系统中客户端与服务端之间通过 WebSocket 控制通道传输的所有消息类型，
+ * 包括认证消息、控制消息（注册/注销/心跳）、连接通知消息等，
+ * 以及消息的创建、序列化、反序列化和类型守卫等工具函数。
+ */
 /**
  * 消息类型枚举
+ *
+ * 定义穿透代理协议中所有消息的类型标识，
+ * 涵盖认证、控制和连接通知三大类消息。
  */
 export declare enum MessageType {
+    /** 客户端发送的认证请求消息 */
     AUTH = "auth",
+    /** 服务端返回的认证响应消息 */
     AUTH_RESP = "auth_resp",
+    /** 客户端发送的代理注册请求消息 */
     REGISTER = "register",
+    /** 客户端发送的代理注销请求消息 */
     UNREGISTER = "unregister",
+    /** 服务端返回的注册响应消息 */
     REGISTER_RESP = "register_resp",
+    /** 客户端发送的心跳消息 */
     HEARTBEAT = "heartbeat",
+    /** 服务端返回的心跳响应消息 */
     HEARTBEAT_RESP = "heartbeat_resp",
+    /** 服务端发送的新连接通知消息 */
     NEW_CONNECTION = "new_connection",
+    /** 连接关闭通知消息 */
     CONNECTION_CLOSE = "connection_close",
+    /** 连接错误通知消息 */
     CONNECTION_ERROR = "connection_error"
 }
 /**
  * 协议类型
+ *
+ * 穿透代理支持的传输协议类型，可选 HTTP 或 WebSocket。
  */
 export type Protocol = 'http' | 'websocket';
 /**
  * 基础消息接口
+ *
+ * 所有消息的公共基类，定义了消息的类型、唯一标识和负载数据。
  */
 export interface Message {
+    /** 消息类型标识，参见 {@link MessageType} */
     type: MessageType;
+    /** 消息的唯一标识符，用于请求-响应配对 */
     id: string;
+    /** 消息的负载数据，具体结构取决于消息类型 */
     payload: unknown;
 }
 /**
  * 认证消息
+ *
+ * 客户端在建立控制通道后发送的第一条消息，携带认证令牌。
  */
 export interface AuthMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.AUTH} */
     type: MessageType.AUTH;
+    /** 认证消息负载 */
     payload: {
+        /** 客户端的认证令牌 */
         token: string;
     };
 }
 /**
  * 认证响应消息
+ *
+ * 服务端对客户端认证请求的响应，表明认证是否成功。
  */
 export interface AuthRespMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.AUTH_RESP} */
     type: MessageType.AUTH_RESP;
+    /** 认证响应负载 */
     payload: {
+        /** 认证是否成功 */
         success: boolean;
+        /** 认证失败时的错误描述信息 */
         error?: string;
     };
 }
 /**
  * 注册代理服务消息
+ *
+ * 客户端向服务端请求注册一条代理隧道，指定远程端口到本地服务的映射。
+ * 每个端口同时支持 HTTP 和 WebSocket 协议。
  */
 export interface RegisterMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.REGISTER} */
     type: MessageType.REGISTER;
+    /** 注册请求负载 */
     payload: {
+        /** 请求在服务端监听的远程端口号 */
         remotePort: number;
-        protocol: Protocol;
+        /** 本地服务监听的端口号 */
         localPort: number;
+        /** 本地服务的主机地址，默认为 localhost */
         localHost?: string;
     };
 }
 /**
  * 注册响应消息
+ *
+ * 服务端对客户端注册请求的响应，表明注册是否成功及分配的远程端口信息。
  */
 export interface RegisterRespMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.REGISTER_RESP} */
     type: MessageType.REGISTER_RESP;
+    /** 注册响应负载 */
     payload: {
+        /** 注册是否成功 */
         success: boolean;
+        /** 服务端实际分配的远程端口号 */
         remotePort?: number;
+        /** 可通过此 URL 访问代理服务的完整地址 */
         remoteUrl?: string;
+        /** 注册失败时的错误描述信息 */
         error?: string;
     };
 }
 /**
  * 注销代理服务消息
+ *
+ * 客户端向服务端请求注销一条已注册的代理隧道。
  */
 export interface UnregisterMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.UNREGISTER} */
     type: MessageType.UNREGISTER;
+    /** 注销请求负载 */
     payload: {
+        /** 要注销的远程端口号 */
         remotePort: number;
     };
 }
 /**
  * 心跳消息
+ *
+ * 客户端定期发送的心跳消息，用于保持控制通道连接活跃。
  */
 export interface HeartbeatMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.HEARTBEAT} */
     type: MessageType.HEARTBEAT;
+    /** 心跳消息负载 */
     payload: {
+        /** 发送心跳时的时间戳（Unix 毫秒） */
         timestamp: number;
     };
 }
 /**
  * 心跳响应消息
+ *
+ * 服务端对客户端心跳消息的响应。
  */
 export interface HeartbeatRespMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.HEARTBEAT_RESP} */
     type: MessageType.HEARTBEAT_RESP;
+    /** 心跳响应负载 */
     payload: {
+        /** 服务端响应时的时间戳（Unix 毫秒） */
         timestamp: number;
     };
 }
 /**
- * HTTP请求头信息
+ * HTTP 请求头信息
+ *
+ * 表示 HTTP 请求或响应的头部字段映射，值可以是单个字符串、字符串数组或未定义。
  */
 export interface HttpHeaders {
+    /** HTTP 头部字段，键为头部名称，值为头部内容 */
     [key: string]: string | string[] | undefined;
 }
 /**
  * 新连接通知消息
+ *
+ * 当外部用户连接到服务端的代理端口时，服务端向客户端发送此消息通知新连接的到来，
+ * 并携带连接的详细信息（HTTP 请求数据或 WebSocket 握手头）。
  */
 export interface NewConnectionMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.NEW_CONNECTION} */
     type: MessageType.NEW_CONNECTION;
+    /** 新连接通知负载 */
     payload: {
+        /** 新连接的唯一标识符 */
         connectionId: string;
+        /** 连接使用的传输协议类型 */
         protocol: Protocol;
+        /** HTTP 请求方法（仅 HTTP 协议时存在），如 GET、POST 等 */
         method?: string;
+        /** HTTP 请求的 URL 路径（仅 HTTP 协议时存在） */
         url?: string;
+        /** HTTP 请求头（仅 HTTP 协议时存在） */
         headers?: HttpHeaders;
+        /** HTTP 请求体（仅 HTTP 协议时存在） */
         body?: string | Buffer;
+        /** WebSocket 握手请求头（仅 WebSocket 协议时存在） */
         wsHeaders?: HttpHeaders;
     };
 }
 /**
- * HTTP响应数据
+ * HTTP 响应数据
+ *
+ * 描述一个 HTTP 响应的结构，包含状态码、响应头和可选的响应体。
  */
 export interface HttpResponseData {
+    /** HTTP 响应状态码 */
     statusCode: number;
+    /** HTTP 响应头 */
     headers: HttpHeaders;
+    /** HTTP 响应体 */
     body?: string | Buffer;
 }
 /**
  * 连接关闭消息
+ *
+ * 通知对方某个代理连接已关闭。
  */
 export interface ConnectionCloseMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.CONNECTION_CLOSE} */
     type: MessageType.CONNECTION_CLOSE;
+    /** 连接关闭负载 */
     payload: {
+        /** 已关闭的连接的唯一标识符 */
         connectionId: string;
     };
 }
 /**
  * 连接错误消息
+ *
+ * 通知对方某个代理连接发生了错误。
  */
 export interface ConnectionErrorMessage extends Message {
+    /** 消息类型，固定为 {@link MessageType.CONNECTION_ERROR} */
     type: MessageType.CONNECTION_ERROR;
+    /** 连接错误负载 */
     payload: {
+        /** 发生错误的连接的唯一标识符 */
         connectionId: string;
+        /** 错误描述信息 */
         error: string;
     };
 }
 /**
  * 所有消息类型的联合类型
+ *
+ * 包含穿透代理协议中所有具体消息类型的联合，可用于消息处理函数的参数类型。
  */
 export type AnyMessage = AuthMessage | AuthRespMessage | RegisterMessage | RegisterRespMessage | UnregisterMessage | HeartbeatMessage | HeartbeatRespMessage | NewConnectionMessage | ConnectionCloseMessage | ConnectionErrorMessage;
 /**
  * 消息类型守卫
+ *
+ * 检查一个未知对象是否符合 {@link Message} 接口的基本结构。
+ *
+ * @param obj - 待检查的未知对象
+ * @returns 如果对象包含有效的 `type` 和 `id` 字段则返回 `true`
  */
 export declare function isMessage(obj: unknown): obj is Message;
 /**
  * 检查消息是否为指定类型
+ *
+ * 类型守卫函数，判断一条消息是否属于特定的消息类型，并在类型系统中收窄类型。
+ *
+ * @typeParam T - 目标消息类型，必须是 {@link AnyMessage} 的子类型
+ * @param msg - 待检查的消息对象
+ * @param type - 期望的消息类型标识
+ * @returns 如果消息的 `type` 字段与期望类型匹配则返回 `true`
  */
 export declare function isMessageType<T extends AnyMessage>(msg: Message, type: T['type']): msg is T;
 /**
  * 创建消息
+ *
+ * 工厂函数，根据指定的消息类型和负载数据创建一条新的消息实例。
+ * 若未提供消息 ID，将自动生成一个唯一 ID。
+ *
+ * @typeParam T - 目标消息类型（不含 `id` 字段），必须是 {@link AnyMessage} 的子类型
+ * @param type - 消息类型标识
+ * @param payload - 消息负载数据
+ * @param id - 可选的消息唯一标识符，若不提供则自动生成
+ * @returns 包含完整字段的消息对象
  */
 export declare function createMessage<T extends Omit<AnyMessage, 'id'>>(type: T['type'], payload: T['payload'], id?: string): T & {
     id: string;
 };
 /**
  * 生成消息ID
+ *
+ * 生成一个格式为 `msg_{timestamp}_{random}` 的唯一消息标识符。
+ *
+ * @returns 唯一的消息 ID 字符串
  */
 export declare function generateMessageId(): string;
 /**
  * 序列化消息
+ *
+ * 将消息对象转换为 JSON 字符串，用于通过 WebSocket 发送。
+ *
+ * @param msg - 要序列化的消息对象
+ * @returns 消息的 JSON 字符串表示
  */
 export declare function serializeMessage(msg: Message): string;
 /**
  * 反序列化消息
+ *
+ * 将 JSON 字符串解析为消息对象。如果字符串不是有效的 JSON 或解析后的对象不符合消息格式，
+ * 将抛出错误。
+ *
+ * @param data - 要反序列化的 JSON 字符串
+ * @returns 解析后的消息对象
+ * @throws 当 JSON 解析失败或消息格式无效时抛出错误
  */
 export declare function deserializeMessage(data: string): Message;
 //# sourceMappingURL=messages.d.ts.map

package/dist/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IAErB,IAAI,SAAS;IACb,SAAS,cAAc;IAGvB,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,cAAc,mBAAmB;IAGjC,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,WAAW,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IAC1C,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IACvB,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IAC5B,OAAO,EAAE;QACP,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC;IAC3B,OAAO,EAAE;QACP,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,QAAQ,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,OAAO;IAClD,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC;IAChC,OAAO,EAAE;QACP,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,OAAO;IAChD,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;IAC7B,OAAO,EAAE;QACP,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,OAAO;IAC/C,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IAC5B,OAAO,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,OAAO;IACnD,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC;IACjC,OAAO,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,OAAO;IACnD,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC;IACjC,OAAO,EAAE;QACP,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,QAAQ,CAAC;QAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAEvB,SAAS,CAAC,EAAE,WAAW,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,OAAO;IACrD,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC;IACnC,OAAO,EAAE;QACP,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,OAAO;IACrD,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC;IACnC,OAAO,EAAE;QACP,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,WAAW,GACX,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,CAAC;AAE3B;;GAEG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,OAAO,CAMtD;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAChD,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GACd,GAAG,IAAI,CAAC,CAEV;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAC5D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EACf,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,EACrB,EAAE,CAAC,EAAE,MAAM,GACV,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAMpB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAErD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAUxD"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;GAKG;AACH,oBAAY,WAAW;IACrB,mBAAmB;IACnB,IAAI,SAAS;IACb,mBAAmB;IACnB,SAAS,cAAc;IAEvB,qBAAqB;IACrB,QAAQ,aAAa;IACrB,qBAAqB;IACrB,UAAU,eAAe;IACzB,mBAAmB;IACnB,aAAa,kBAAkB;IAC/B,iBAAiB;IACjB,SAAS,cAAc;IACvB,mBAAmB;IACnB,cAAc,mBAAmB;IAEjC,oBAAoB;IACpB,cAAc,mBAAmB;IACjC,eAAe;IACf,gBAAgB,qBAAqB;IACrC,eAAe;IACf,gBAAgB,qBAAqB;CACtC;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;AAE5C;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,oCAAoC;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IAC1C,wCAAwC;IACxC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IACvB,aAAa;IACb,OAAO,EAAE;QACP,eAAe;QACf,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C,6CAA6C;IAC7C,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IAC5B,aAAa;IACb,OAAO,EAAE;QACP,aAAa;QACb,OAAO,EAAE,OAAO,CAAC;QACjB,mBAAmB;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C,4CAA4C;IAC5C,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC;IAC3B,aAAa;IACb,OAAO,EAAE;QACP,qBAAqB;QACrB,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,8BAA8B;QAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,OAAO;IAClD,iDAAiD;IACjD,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC;IAChC,aAAa;IACb,OAAO,EAAE;QACP,aAAa;QACb,OAAO,EAAE,OAAO,CAAC;QACjB,oBAAoB;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,2BAA2B;QAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,mBAAmB;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,OAAO;IAChD,8CAA8C;IAC9C,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;IAC7B,aAAa;IACb,OAAO,EAAE;QACP,gBAAgB;QAChB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,OAAO;IAC/C,6CAA6C;IAC7C,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IAC5B,aAAa;IACb,OAAO,EAAE;QACP,yBAAyB;QACzB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,OAAO;IACnD,kDAAkD;IAClD,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC;IACjC,aAAa;IACb,OAAO,EAAE;QACP,0BAA0B;QAC1B,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,8BAA8B;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;CAC9C;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAqB,SAAQ,OAAO;IACnD,kDAAkD;IAClD,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC;IACjC,cAAc;IACd,OAAO,EAAE;QACP,gBAAgB;QAChB,YAAY,EAAE,MAAM,CAAC;QACrB,kBAAkB;QAClB,QAAQ,EAAE,QAAQ,CAAC;QACnB,2CAA2C;QAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,oCAAoC;QACpC,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,6BAA6B;QAC7B,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB,6BAA6B;QAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,yCAAyC;QACzC,SAAS,CAAC,EAAE,WAAW,CAAC;KACzB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iBAAiB;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe;IACf,OAAO,EAAE,WAAW,CAAC;IACrB,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,OAAO;IACrD,oDAAoD;IACpD,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC;IACnC,aAAa;IACb,OAAO,EAAE;QACP,mBAAmB;QACnB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,OAAO;IACrD,oDAAoD;IACpD,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC;IACnC,aAAa;IACb,OAAO,EAAE;QACP,oBAAoB;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,aAAa;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,WAAW,GACX,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,CAAC;AAE3B;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,OAAO,CAMtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAChD,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GACd,GAAG,IAAI,CAAC,CAEV;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAC5D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EACf,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,EACrB,EAAE,CAAC,EAAE,MAAM,GACV,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAMpB;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAErD;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAUxD"}

package/dist/messages.js

@@ -1,24 +1,48 @@
+/**
+ * @module messages
+ *
+ * 穿透代理消息定义模块。
+ *
+ * 本模块定义了穿透代理系统中客户端与服务端之间通过 WebSocket 控制通道传输的所有消息类型，
+ * 包括认证消息、控制消息（注册/注销/心跳）、连接通知消息等，
+ * 以及消息的创建、序列化、反序列化和类型守卫等工具函数。
+ */
 /**
  * 消息类型枚举
+ *
+ * 定义穿透代理协议中所有消息的类型标识，
+ * 涵盖认证、控制和连接通知三大类消息。
  */
 export var MessageType;
 (function (MessageType) {
-    // 认证消息
+    /** 客户端发送的认证请求消息 */
     MessageType["AUTH"] = "auth";
+    /** 服务端返回的认证响应消息 */
     MessageType["AUTH_RESP"] = "auth_resp";
-    // 控制消息
+    /** 客户端发送的代理注册请求消息 */
     MessageType["REGISTER"] = "register";
+    /** 客户端发送的代理注销请求消息 */
     MessageType["UNREGISTER"] = "unregister";
+    /** 服务端返回的注册响应消息 */
     MessageType["REGISTER_RESP"] = "register_resp";
+    /** 客户端发送的心跳消息 */
     MessageType["HEARTBEAT"] = "heartbeat";
+    /** 服务端返回的心跳响应消息 */
     MessageType["HEARTBEAT_RESP"] = "heartbeat_resp";
-    // 连接通知
+    /** 服务端发送的新连接通知消息 */
     MessageType["NEW_CONNECTION"] = "new_connection";
+    /** 连接关闭通知消息 */
     MessageType["CONNECTION_CLOSE"] = "connection_close";
+    /** 连接错误通知消息 */
     MessageType["CONNECTION_ERROR"] = "connection_error";
 })(MessageType || (MessageType = {}));
 /**
  * 消息类型守卫
+ *
+ * 检查一个未知对象是否符合 {@link Message} 接口的基本结构。
+ *
+ * @param obj - 待检查的未知对象
+ * @returns 如果对象包含有效的 `type` 和 `id` 字段则返回 `true`
  */
 export function isMessage(obj) {
     if (typeof obj !== 'object' || obj === null) {
@@ -29,12 +53,28 @@ export function isMessage(obj) {
 }
 /**
  * 检查消息是否为指定类型
+ *
+ * 类型守卫函数，判断一条消息是否属于特定的消息类型，并在类型系统中收窄类型。
+ *
+ * @typeParam T - 目标消息类型，必须是 {@link AnyMessage} 的子类型
+ * @param msg - 待检查的消息对象
+ * @param type - 期望的消息类型标识
+ * @returns 如果消息的 `type` 字段与期望类型匹配则返回 `true`
  */
 export function isMessageType(msg, type) {
     return msg.type === type;
 }
 /**
  * 创建消息
+ *
+ * 工厂函数，根据指定的消息类型和负载数据创建一条新的消息实例。
+ * 若未提供消息 ID，将自动生成一个唯一 ID。
+ *
+ * @typeParam T - 目标消息类型（不含 `id` 字段），必须是 {@link AnyMessage} 的子类型
+ * @param type - 消息类型标识
+ * @param payload - 消息负载数据
+ * @param id - 可选的消息唯一标识符，若不提供则自动生成
+ * @returns 包含完整字段的消息对象
  */
 export function createMessage(type, payload, id) {
     return {
@@ -45,29 +85,45 @@ export function createMessage(type, payload, id) {
 }
 /**
  * 生成消息ID
+ *
+ * 生成一个格式为 `msg_{timestamp}_{random}` 的唯一消息标识符。
+ *
+ * @returns 唯一的消息 ID 字符串
  */
 export function generateMessageId() {
     return `msg_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;
 }
 /**
  * 序列化消息
+ *
+ * 将消息对象转换为 JSON 字符串，用于通过 WebSocket 发送。
+ *
+ * @param msg - 要序列化的消息对象
+ * @returns 消息的 JSON 字符串表示
  */
 export function serializeMessage(msg) {
     return JSON.stringify(msg);
 }
 /**
  * 反序列化消息
+ *
+ * 将 JSON 字符串解析为消息对象。如果字符串不是有效的 JSON 或解析后的对象不符合消息格式，
+ * 将抛出错误。
+ *
+ * @param data - 要反序列化的 JSON 字符串
+ * @returns 解析后的消息对象
+ * @throws 当 JSON 解析失败或消息格式无效时抛出错误
  */
 export function deserializeMessage(data) {
     try {
         const msg = JSON.parse(data);
         if (!isMessage(msg)) {
-            throw new Error('Invalid message format');
+            throw new Error('无效的消息格式');
         }
         return msg;
     }
     catch (error) {
-        throw new Error(`Failed to deserialize message: ${error}`);
+        throw new Error(`消息反序列化失败: ${error}`);
     }
 }
 //# sourceMappingURL=messages.js.map

package/dist/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,WAgBX;AAhBD,WAAY,WAAW;IACrB,OAAO;IACP,4BAAa,CAAA;IACb,sCAAuB,CAAA;IAEvB,OAAO;IACP,oCAAqB,CAAA;IACrB,wCAAyB,CAAA;IACzB,8CAA+B,CAAA;IAC/B,sCAAuB,CAAA;IACvB,gDAAiC,CAAA;IAEjC,OAAO;IACP,gDAAiC,CAAA;IACjC,oDAAqC,CAAA;IACrC,oDAAqC,CAAA;AACvC,CAAC,EAhBW,WAAW,KAAX,WAAW,QAgBtB;AAmKD;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,GAAY;IACpC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,GAAG,GAAG,GAAuB,CAAC;IACpC,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ,CAAC;AACpE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAC3B,GAAY,EACZ,IAAe;IAEf,OAAO,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAe,EACf,OAAqB,EACrB,EAAW;IAEX,OAAO;QACL,IAAI;QACJ,EAAE,EAAE,EAAE,IAAI,iBAAiB,EAAE;QAC7B,OAAO;KACc,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO,OAAO,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;AAC5E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAY;IAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC"}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,WAuBX;AAvBD,WAAY,WAAW;IACrB,mBAAmB;IACnB,4BAAa,CAAA;IACb,mBAAmB;IACnB,sCAAuB,CAAA;IAEvB,qBAAqB;IACrB,oCAAqB,CAAA;IACrB,qBAAqB;IACrB,wCAAyB,CAAA;IACzB,mBAAmB;IACnB,8CAA+B,CAAA;IAC/B,iBAAiB;IACjB,sCAAuB,CAAA;IACvB,mBAAmB;IACnB,gDAAiC,CAAA;IAEjC,oBAAoB;IACpB,gDAAiC,CAAA;IACjC,eAAe;IACf,oDAAqC,CAAA;IACrC,eAAe;IACf,oDAAqC,CAAA;AACvC,CAAC,EAvBW,WAAW,KAAX,WAAW,QAuBtB;AAkPD;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,GAAY;IACpC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,GAAG,GAAG,GAAuB,CAAC;IACpC,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ,CAAC;AACpE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAC3B,GAAY,EACZ,IAAe;IAEf,OAAO,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAe,EACf,OAAqB,EACrB,EAAW;IAEX,OAAO;QACL,IAAI;QACJ,EAAE,EAAE,EAAE,IAAI,iBAAiB,EAAE;QAC7B,OAAO;KACc,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO,OAAO,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;AAC5E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAY;IAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,aAAa,KAAK,EAAE,CAAC,CAAC;IACxC,CAAC;AACH,CAAC"}

package/dist/protocol.d.ts

@@ -1,110 +1,205 @@
+/**
+ * @module protocol
+ *
+ * 穿透代理协议定义模块。
+ *
+ * 本模块定义了穿透代理系统的核心协议常量、错误码、默认配置以及各类配置接口。
+ * 包括服务端与客户端通信所需的协议版本、控制通道路径、心跳参数、端口范围等关键配置，
+ * 以及代理配置、服务器配置、客户端配置、连接信息等数据结构的类型定义。
+ */
 /**
  * 协议常量
+ *
+ * 定义穿透代理系统的基础协议参数。
  */
 export declare const PROTOCOL: {
+    /** 穿透协议版本号 */
     readonly VERSION: "1.0.0";
+    /** 客户端与服务端建立 WebSocket 控制通道的 URL 路径，如 ws://host:9000/control */
     readonly CONTROL_PATH: "/control";
 };
 /**
  * 协议错误码
+ *
+ * 枚举穿透代理系统中可能出现的各类错误码，
+ * 涵盖认证错误、注册错误、连接错误和通用错误四大类。
  */
 export declare enum ErrorCode {
+    /** 认证失败，令牌无效或不匹配 */
     AUTH_FAILED = "AUTH_FAILED",
+    /** 认证超时，客户端未在规定时间内完成认证 */
     AUTH_TIMEOUT = "AUTH_TIMEOUT",
+    /** 端口已被注册，其他客户端已占用该远程端口 */
     PORT_ALREADY_REGISTERED = "PORT_ALREADY_REGISTERED",
+    /** 端口超出允许范围 */
     PORT_OUT_OF_RANGE = "PORT_OUT_OF_RANGE",
+    /** 无效端口号 */
     INVALID_PORT = "INVALID_PORT",
+    /** 未找到指定的连接 */
     CONNECTION_NOT_FOUND = "CONNECTION_NOT_FOUND",
+    /** 连接超时 */
     CONNECTION_TIMEOUT = "CONNECTION_TIMEOUT",
+    /** 未找到指定的客户端 */
     CLIENT_NOT_FOUND = "CLIENT_NOT_FOUND",
+    /** 无效的消息格式 */
     INVALID_MESSAGE = "INVALID_MESSAGE",
+    /** 内部服务器错误 */
     INTERNAL_ERROR = "INTERNAL_ERROR"
 }
 /**
  * 协议错误类
+ *
+ * 继承自 {@link Error}，附带 {@link ErrorCode} 错误码，
+ * 用于在穿透代理协议处理过程中抛出结构化的错误信息。
  */
 export declare class ProtocolError extends Error {
     code: ErrorCode;
+    /**
+     * 创建一个协议错误实例。
+     *
+     * @param code - 协议错误码，参见 {@link ErrorCode}
+     * @param message - 可读的错误描述信息
+     */
     constructor(code: ErrorCode, message: string);
 }
 /**
- * HTTP状态码
+ * HTTP 状态码常量
+ *
+ * 定义穿透代理系统中常用的 HTTP 状态码。
  */
 export declare const HTTP_STATUS: {
+    /** 请求成功 */
     readonly OK: 200;
+    /** 请求参数错误 */
     readonly BAD_REQUEST: 400;
+    /** 未授权，认证失败 */
     readonly UNAUTHORIZED: 401;
+    /** 未找到请求的资源 */
     readonly NOT_FOUND: 404;
+    /** 服务器内部错误 */
     readonly INTERNAL_SERVER_ERROR: 500;
+    /** 网关错误，上游服务不可用 */
     readonly BAD_GATEWAY: 502;
+    /** 服务不可用 */
     readonly SERVICE_UNAVAILABLE: 503;
 };
 /**
  * 默认配置
+ *
+ * 穿透代理系统的默认运行参数，包括端口、心跳、会话、重连及缓冲区等配置项。
  */
 export declare const DEFAULT_CONFIG: {
+    /** 服务端监听的控制端口，客户端通过此端口建立 WebSocket 控制通道进行认证、注册代理等操作 */
     readonly CONTROL_PORT: 9000;
+    /** 控制通道的 WebSocket URL 路径，客户端连接地址为 ws://host:{CONTROL_PORT}{CONTROL_PATH} */
     readonly CONTROL_PATH: "/control";
+    /** 心跳发送间隔时间，单位毫秒（默认 30 秒） */
     readonly HEARTBEAT_INTERVAL: 30000;
+    /** 心跳超时时间，超过此时间未收到心跳视为断连，单位毫秒（默认 60 秒） */
     readonly HEARTBEAT_TIMEOUT: 60000;
+    /** 会话超时时间，超时后会话将被清理，单位毫秒（默认 2 分钟） */
     readonly SESSION_TIMEOUT: 120000;
+    /** 断线重连间隔时间，单位毫秒（默认 5 秒） */
     readonly RECONNECT_INTERVAL: 5000;
+    /** 最大重连尝试次数（默认 10 次） */
     readonly MAX_RECONNECT_ATTEMPTS: 10;
+    /** 允许注册的最小端口号 */
     readonly MIN_PORT: 1024;
+    /** 允许注册的最大端口号 */
     readonly MAX_PORT: 65535;
+    /** 数据传输缓冲区大小，单位字节（默认 64KB） */
     readonly BUFFER_SIZE: number;
 };
 /**
  * 代理配置接口
+ *
+ * 描述单条代理隧道的配置，指定远程端口到本地端口的映射关系。
+ * 每个端口同时支持 HTTP 和 WebSocket 协议，无需单独指定。
  */
 export interface ProxyConfig {
+    /** 服务端监听的远程端口号，外部用户通过此端口访问代理服务 */
     remotePort: number;
-    protocol: 'http' | 'websocket';
+    /** 本地服务监听的端口号，代理流量将被转发到此端口 */
     localPort: number;
+    /** 本地服务的主机地址，默认为 localhost */
     localHost?: string;
 }
 /**
  * 服务器配置接口
+ *
+ * 定义穿透代理服务端的运行参数，包括监听地址、认证令牌、心跳和 TLS 配置。
  */
 export interface ServerConfig {
+    /** 服务端监听的主机地址 */
     host: string;
+    /** 服务端控制通道监听的端口号 */
     controlPort: number;
+    /** 允许认证的令牌列表，客户端需提供其中之一才能通过认证 */
     authTokens: string[];
+    /** 心跳发送间隔时间，单位毫秒 */
     heartbeatInterval: number;
+    /** 会话超时时间，单位毫秒 */
     sessionTimeout: number;
+    /**
+     * TLS 证书配置，用于启用安全的 WSS 连接。
+     * 若不提供则使用非加密的 WS 连接。
+     */
     tls?: {
+        /** TLS 私钥文件路径或内容 */
         key: string;
+        /** TLS 证书文件路径或内容 */
         cert: string;
     };
 }
 /**
  * 客户端配置接口
+ *
+ * 定义穿透代理客户端的运行参数，包括服务器地址、认证令牌、重连策略和代理列表。
  */
 export interface ClientConfig {
+    /** 服务端 WebSocket 控制通道的完整 URL，如 ws://host:9000/control */
     serverUrl: string;
+    /** 客户端认证令牌，需与服务端配置的 authTokens 之一匹配 */
     token: string;
+    /** 断线重连间隔时间，单位毫秒 */
     reconnectInterval: number;
+    /** 最大重连尝试次数，超过后停止重连 */
     maxReconnectAttempts: number;
+    /** 需要注册的代理隧道配置列表 */
     proxies: ProxyConfig[];
 }
 /**
  * 连接信息接口
+ *
+ * 描述单个代理连接的运行时信息。
  */
 export interface ConnectionInfo {
+    /** 连接的唯一标识符 */
     id: string;
+    /** 发起连接的远程客户端 IP 地址 */
     remoteAddress: string;
+    /** 该连接使用的传输协议类型 */
     protocol: 'http' | 'websocket';
+    /** 连接建立的时间戳（Unix 毫秒） */
     createdAt: number;
 }
 /**
  * 客户端信息接口
+ *
+ * 描述已连接到服务端的客户端的运行时状态信息。
  */
 export interface ClientInfo {
+    /** 客户端的唯一标识符 */
     id: string;
+    /** 客户端是否已通过认证 */
     authenticated: boolean;
+    /** 客户端通过认证的时间戳（Unix 毫秒） */
     authenticatedAt?: number;
+    /** 最近一次收到心跳的时间戳（Unix 毫秒） */
     lastHeartbeat?: number;
+    /** 客户端已注册的远程端口集合 */
     registeredPorts: Set<number>;
+    /** 客户端当前活跃的连接映射表，键为连接 ID */
     connections: Map<string, ConnectionInfo>;
 }
 //# sourceMappingURL=protocol.d.ts.map

package/dist/protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,QAAQ;;;CAGX,CAAC;AAEX;;GAEG;AACH,oBAAY,SAAS;IAEnB,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAG7B,uBAAuB,4BAA4B;IACnD,iBAAiB,sBAAsB;IACvC,YAAY,iBAAiB;IAG7B,oBAAoB,yBAAyB;IAC7C,kBAAkB,uBAAuB;IACzC,gBAAgB,qBAAqB;IAGrC,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAE7B,IAAI,EAAE,SAAS;gBAAf,IAAI,EAAE,SAAS,EACtB,OAAO,EAAE,MAAM;CAKlB;AAED;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;CAQd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;CAsBjB,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,WAAW,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IAEvB,GAAG,CAAC,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,WAAW,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAC1C"}
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;GAIG;AACH,eAAO,MAAM,QAAQ;IACnB,cAAc;;IAEd,gEAAgE;;CAExD,CAAC;AAEX;;;;;GAKG;AACH,oBAAY,SAAS;IACnB,oBAAoB;IACpB,WAAW,gBAAgB;IAC3B,0BAA0B;IAC1B,YAAY,iBAAiB;IAE7B,2BAA2B;IAC3B,uBAAuB,4BAA4B;IACnD,eAAe;IACf,iBAAiB,sBAAsB;IACvC,YAAY;IACZ,YAAY,iBAAiB;IAE7B,eAAe;IACf,oBAAoB,yBAAyB;IAC7C,WAAW;IACX,kBAAkB,uBAAuB;IACzC,gBAAgB;IAChB,gBAAgB,qBAAqB;IAErC,cAAc;IACd,eAAe,oBAAoB;IACnC,cAAc;IACd,cAAc,mBAAmB;CAClC;AAED;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAQ7B,IAAI,EAAE,SAAS;IAPxB;;;;;OAKG;gBAEM,IAAI,EAAE,SAAS,EACtB,OAAO,EAAE,MAAM;CAKlB;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW;IACtB,WAAW;;IAEX,aAAa;;IAEb,eAAe;;IAEf,eAAe;;IAEf,cAAc;;IAEd,mBAAmB;;IAEnB,YAAY;;CAEJ,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,cAAc;IACzB,uDAAuD;;IAEvD,6EAA6E;;IAG7E,6BAA6B;;IAE7B,0CAA0C;;IAG1C,qCAAqC;;IAGrC,4BAA4B;;IAE5B,wBAAwB;;IAGxB,iBAAiB;;IAEjB,iBAAiB;;IAGjB,8BAA8B;;CAEtB,CAAC;AAEX;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,oBAAoB;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,GAAG,CAAC,EAAE;QACJ,oBAAoB;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,oBAAoB;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,uBAAuB;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB;IACpB,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB;IACnB,QAAQ,EAAE,MAAM,GAAG,WAAW,CAAC;IAC/B,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,gBAAgB;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,aAAa,EAAE,OAAO,CAAC;IACvB,2BAA2B;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4BAA4B;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oBAAoB;IACpB,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,4BAA4B;IAC5B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAC1C"}

package/dist/protocol.js

@@ -1,34 +1,65 @@
+/**
+ * @module protocol
+ *
+ * 穿透代理协议定义模块。
+ *
+ * 本模块定义了穿透代理系统的核心协议常量、错误码、默认配置以及各类配置接口。
+ * 包括服务端与客户端通信所需的协议版本、控制通道路径、心跳参数、端口范围等关键配置，
+ * 以及代理配置、服务器配置、客户端配置、连接信息等数据结构的类型定义。
+ */
 /**
  * 协议常量
+ *
+ * 定义穿透代理系统的基础协议参数。
  */
 export const PROTOCOL = {
+    /** 穿透协议版本号 */
     VERSION: '1.0.0',
+    /** 客户端与服务端建立 WebSocket 控制通道的 URL 路径，如 ws://host:9000/control */
     CONTROL_PATH: '/control',
 };
 /**
  * 协议错误码
+ *
+ * 枚举穿透代理系统中可能出现的各类错误码，
+ * 涵盖认证错误、注册错误、连接错误和通用错误四大类。
  */
 export var ErrorCode;
 (function (ErrorCode) {
-    // 认证错误
+    /** 认证失败，令牌无效或不匹配 */
     ErrorCode["AUTH_FAILED"] = "AUTH_FAILED";
+    /** 认证超时，客户端未在规定时间内完成认证 */
     ErrorCode["AUTH_TIMEOUT"] = "AUTH_TIMEOUT";
-    // 注册错误
+    /** 端口已被注册，其他客户端已占用该远程端口 */
     ErrorCode["PORT_ALREADY_REGISTERED"] = "PORT_ALREADY_REGISTERED";
+    /** 端口超出允许范围 */
     ErrorCode["PORT_OUT_OF_RANGE"] = "PORT_OUT_OF_RANGE";
+    /** 无效端口号 */
     ErrorCode["INVALID_PORT"] = "INVALID_PORT";
-    // 连接错误
+    /** 未找到指定的连接 */
     ErrorCode["CONNECTION_NOT_FOUND"] = "CONNECTION_NOT_FOUND";
+    /** 连接超时 */
     ErrorCode["CONNECTION_TIMEOUT"] = "CONNECTION_TIMEOUT";
+    /** 未找到指定的客户端 */
     ErrorCode["CLIENT_NOT_FOUND"] = "CLIENT_NOT_FOUND";
-    // 通用错误
+    /** 无效的消息格式 */
     ErrorCode["INVALID_MESSAGE"] = "INVALID_MESSAGE";
+    /** 内部服务器错误 */
     ErrorCode["INTERNAL_ERROR"] = "INTERNAL_ERROR";
 })(ErrorCode || (ErrorCode = {}));
 /**
  * 协议错误类
+ *
+ * 继承自 {@link Error}，附带 {@link ErrorCode} 错误码，
+ * 用于在穿透代理协议处理过程中抛出结构化的错误信息。
  */
 export class ProtocolError extends Error {
+    /**
+     * 创建一个协议错误实例。
+     *
+     * @param code - 协议错误码，参见 {@link ErrorCode}
+     * @param message - 可读的错误描述信息
+     */
     constructor(code, message) {
         super(message);
         this.code = code;
@@ -36,36 +67,51 @@ export class ProtocolError extends Error {
     }
 }
 /**
- * HTTP状态码
+ * HTTP 状态码常量
+ *
+ * 定义穿透代理系统中常用的 HTTP 状态码。
  */
 export const HTTP_STATUS = {
+    /** 请求成功 */
     OK: 200,
+    /** 请求参数错误 */
     BAD_REQUEST: 400,
+    /** 未授权，认证失败 */
     UNAUTHORIZED: 401,
+    /** 未找到请求的资源 */
     NOT_FOUND: 404,
+    /** 服务器内部错误 */
     INTERNAL_SERVER_ERROR: 500,
+    /** 网关错误，上游服务不可用 */
     BAD_GATEWAY: 502,
+    /** 服务不可用 */
     SERVICE_UNAVAILABLE: 503,
 };
 /**
  * 默认配置
+ *
+ * 穿透代理系统的默认运行参数，包括端口、心跳、会话、重连及缓冲区等配置项。
  */
 export const DEFAULT_CONFIG = {
-    // 控制通道配置
+    /** 服务端监听的控制端口，客户端通过此端口建立 WebSocket 控制通道进行认证、注册代理等操作 */
     CONTROL_PORT: 9000,
+    /** 控制通道的 WebSocket URL 路径，客户端连接地址为 ws://host:{CONTROL_PORT}{CONTROL_PATH} */
     CONTROL_PATH: '/control',
-    // 心跳配置
-    HEARTBEAT_INTERVAL: 30000, // 30秒
-    HEARTBEAT_TIMEOUT: 60000, // 60秒
-    // 会话配置
-    SESSION_TIMEOUT: 120000, // 2分钟
-    // 重连配置
-    RECONNECT_INTERVAL: 5000, // 5秒
-    MAX_RECONNECT_ATTEMPTS: 10, // 最多重连10次
-    // 端口范围
+    /** 心跳发送间隔时间，单位毫秒（默认 30 秒） */
+    HEARTBEAT_INTERVAL: 30000,
+    /** 心跳超时时间，超过此时间未收到心跳视为断连，单位毫秒（默认 60 秒） */
+    HEARTBEAT_TIMEOUT: 60000,
+    /** 会话超时时间，超时后会话将被清理，单位毫秒（默认 2 分钟） */
+    SESSION_TIMEOUT: 120000,
+    /** 断线重连间隔时间，单位毫秒（默认 5 秒） */
+    RECONNECT_INTERVAL: 5000,
+    /** 最大重连尝试次数（默认 10 次） */
+    MAX_RECONNECT_ATTEMPTS: 10,
+    /** 允许注册的最小端口号 */
     MIN_PORT: 1024,
+    /** 允许注册的最大端口号 */
     MAX_PORT: 65535,
-    // 缓冲区大小
-    BUFFER_SIZE: 64 * 1024, // 64KB
+    /** 数据传输缓冲区大小，单位字节（默认 64KB） */
+    BUFFER_SIZE: 64 * 1024,
 };
 //# sourceMappingURL=protocol.js.map

package/dist/protocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,OAAO;IAChB,YAAY,EAAE,UAAU;CAChB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAN,IAAY,SAkBX;AAlBD,WAAY,SAAS;IACnB,OAAO;IACP,wCAA2B,CAAA;IAC3B,0CAA6B,CAAA;IAE7B,OAAO;IACP,gEAAmD,CAAA;IACnD,oDAAuC,CAAA;IACvC,0CAA6B,CAAA;IAE7B,OAAO;IACP,0DAA6C,CAAA;IAC7C,sDAAyC,CAAA;IACzC,kDAAqC,CAAA;IAErC,OAAO;IACP,gDAAmC,CAAA;IACnC,8CAAiC,CAAA;AACnC,CAAC,EAlBW,SAAS,KAAT,SAAS,QAkBpB;AAED;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YACS,IAAe,EACtB,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,SAAI,GAAJ,IAAI,CAAW;QAItB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,EAAE,EAAE,GAAG;IACP,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,GAAG;IACjB,SAAS,EAAE,GAAG;IACd,qBAAqB,EAAE,GAAG;IAC1B,WAAW,EAAE,GAAG;IAChB,mBAAmB,EAAE,GAAG;CAChB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS;IACT,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,UAAU;IAExB,OAAO;IACP,kBAAkB,EAAE,KAAK,EAAE,MAAM;IACjC,iBAAiB,EAAE,KAAK,EAAG,MAAM;IAEjC,OAAO;IACP,eAAe,EAAE,MAAM,EAAG,MAAM;IAEhC,OAAO;IACP,kBAAkB,EAAE,IAAI,EAAM,KAAK;IACnC,sBAAsB,EAAE,EAAE,EAAI,UAAU;IAExC,OAAO;IACP,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,KAAK;IAEf,QAAQ;IACR,WAAW,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO;CACvB,CAAC"}
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,cAAc;IACd,OAAO,EAAE,OAAO;IAChB,gEAAgE;IAChE,YAAY,EAAE,UAAU;CAChB,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAwBX;AAxBD,WAAY,SAAS;IACnB,oBAAoB;IACpB,wCAA2B,CAAA;IAC3B,0BAA0B;IAC1B,0CAA6B,CAAA;IAE7B,2BAA2B;IAC3B,gEAAmD,CAAA;IACnD,eAAe;IACf,oDAAuC,CAAA;IACvC,YAAY;IACZ,0CAA6B,CAAA;IAE7B,eAAe;IACf,0DAA6C,CAAA;IAC7C,WAAW;IACX,sDAAyC,CAAA;IACzC,gBAAgB;IAChB,kDAAqC,CAAA;IAErC,cAAc;IACd,gDAAmC,CAAA;IACnC,cAAc;IACd,8CAAiC,CAAA;AACnC,CAAC,EAxBW,SAAS,KAAT,SAAS,QAwBpB;AAED;;;;;GAKG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC;;;;;OAKG;IACH,YACS,IAAe,EACtB,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,SAAI,GAAJ,IAAI,CAAW;QAItB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,WAAW;IACX,EAAE,EAAE,GAAG;IACP,aAAa;IACb,WAAW,EAAE,GAAG;IAChB,eAAe;IACf,YAAY,EAAE,GAAG;IACjB,eAAe;IACf,SAAS,EAAE,GAAG;IACd,cAAc;IACd,qBAAqB,EAAE,GAAG;IAC1B,mBAAmB;IACnB,WAAW,EAAE,GAAG;IAChB,YAAY;IACZ,mBAAmB,EAAE,GAAG;CAChB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,uDAAuD;IACvD,YAAY,EAAE,IAAI;IAClB,6EAA6E;IAC7E,YAAY,EAAE,UAAU;IAExB,6BAA6B;IAC7B,kBAAkB,EAAE,KAAK;IACzB,0CAA0C;IAC1C,iBAAiB,EAAE,KAAK;IAExB,qCAAqC;IACrC,eAAe,EAAE,MAAM;IAEvB,4BAA4B;IAC5B,kBAAkB,EAAE,IAAI;IACxB,wBAAwB;IACxB,sBAAsB,EAAE,EAAE;IAE1B,iBAAiB;IACjB,QAAQ,EAAE,IAAI;IACd,iBAAiB;IACjB,QAAQ,EAAE,KAAK;IAEf,8BAA8B;IAC9B,WAAW,EAAE,EAAE,GAAG,IAAI;CACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@feng3d/chuantou-shared",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",