ly-utils-lib 1.0.12 → 2.5.0

package/dist/index-Cq1GhjpY.d.cts

@@ -0,0 +1,229 @@
+/**
+ * WebSocket Module - WebSocket 工具
+ *
+ * 提供简化的 WebSocket 连接、消息发送、心跳检测和重连机制
+ */
+/**
+ * WebSocket 连接状态
+ */
+declare enum WebSocketState {
+    CONNECTING = 0,
+    OPEN = 1,
+    CLOSING = 2,
+    CLOSED = 3
+}
+/**
+ * WebSocket 配置选项
+ */
+interface WebSocketOptions {
+    /** WebSocket 服务器地址 */
+    url: string;
+    /** 协议（wss:// 或 ws://），默认自动检测 */
+    protocol?: 'ws' | 'wss';
+    /** 子协议 */
+    protocols?: string | string[];
+    /** 是否自动重连，默认 true */
+    autoReconnect?: boolean;
+    /** 重连次数，默认 3 */
+    reconnectAttempts?: number;
+    /** 重连间隔（毫秒），默认 3000 */
+    reconnectInterval?: number;
+    /** 心跳检测间隔（毫秒），默认 30000 */
+    heartbeatInterval?: number;
+    /** 心跳消息内容，默认 'ping' */
+    heartbeatMessage?: string | object;
+    /** 心跳超时时间（毫秒），默认 5000 */
+    heartbeatTimeout?: number;
+    /** 连接超时时间（毫秒），默认 10000 */
+    connectTimeout?: number;
+    /** 是否记录日志，默认 true */
+    debug?: boolean;
+}
+/**
+ * WebSocket 消息类型
+ */
+type WebSocketMessage = string | object | ArrayBuffer | Blob;
+/**
+ * WebSocket 事件处理器
+ */
+interface WebSocketEventHandlers {
+    /** 连接成功回调 */
+    onOpen?: (event: Event) => void;
+    /** 接收消息回调 */
+    onMessage?: (data: WebSocketMessage, event: MessageEvent) => void;
+    /** 连接关闭回调 */
+    onClose?: (event: CloseEvent) => void;
+    /** 错误回调 */
+    onError?: (event: Event) => void;
+    /** 重连开始回调 */
+    onReconnect?: (attempt: number) => void;
+    /** 重连成功回调 */
+    onReconnectSuccess?: (attempt: number) => void;
+    /** 重连失败回调 */
+    onReconnectFailed?: () => void;
+    /** 心跳回调 */
+    onHeartbeat?: () => void;
+    /** 心跳超时回调 */
+    onHeartbeatTimeout?: () => void;
+}
+/**
+ * WebSocket 实例接口
+ */
+interface IWebSocketClient {
+    /** 连接 WebSocket */
+    connect(): void;
+    /** 断开连接 */
+    disconnect(): void;
+    /** 发送消息 */
+    send(data: WebSocketMessage): Promise<void>;
+    /** 发送消息（不带 Promise） */
+    sendSync(data: WebSocketMessage): void;
+    /** 获取连接状态 */
+    getState(): WebSocketState;
+    /** 是否已连接 */
+    isConnected(): boolean;
+    /** 获取 WebSocket 实例 */
+    getInstance(): WebSocket | null;
+    /** 设置事件处理器 */
+    on<K extends keyof WebSocketEventHandlers>(event: K, handler: WebSocketEventHandlers[K]): void;
+    /** 移除事件处理器 */
+    off<K extends keyof WebSocketEventHandlers>(event: K, handler?: WebSocketEventHandlers[K]): void;
+    /** 重新连接 */
+    reconnect(): void;
+}
+/**
+ * WebSocket 客户端类
+ */
+declare class WebSocketClient implements IWebSocketClient {
+    private ws;
+    private options;
+    private handlers;
+    private reconnectTimer;
+    private heartbeatTimer;
+    private heartbeatTimeoutTimer;
+    private reconnectCount;
+    private isManualDisconnect;
+    private messageQueue;
+    private connectResolve;
+    private connectReject;
+    constructor(options: WebSocketOptions);
+    /**
+     * 连接 WebSocket
+     */
+    connect(): void;
+    /**
+     * 断开连接
+     */
+    disconnect(): void;
+    /**
+     * 发送消息（异步）
+     */
+    send(data: WebSocketMessage): Promise<void>;
+    /**
+     * 发送消息（同步）
+     */
+    sendSync(data: WebSocketMessage): void;
+    /**
+     * 获取连接状态
+     */
+    getState(): WebSocketState;
+    /**
+     * 是否已连接
+     */
+    isConnected(): boolean;
+    /**
+     * 获取 WebSocket 实例
+     */
+    getInstance(): WebSocket | null;
+    /**
+     * 设置事件处理器
+     */
+    on<K extends keyof WebSocketEventHandlers>(event: K, handler: WebSocketEventHandlers[K]): void;
+    /**
+     * 移除事件处理器
+     */
+    off<K extends keyof WebSocketEventHandlers>(event: K, handler?: WebSocketEventHandlers[K]): void;
+    /**
+     * 重新连接
+     */
+    reconnect(): void;
+    /**
+     * 设置事件处理器
+     */
+    private setupEventHandlers;
+    /**
+     * 尝试重连
+     */
+    private attemptReconnect;
+    /**
+     * 启动心跳
+     */
+    private startHeartbeat;
+    /**
+     * 停止心跳
+     */
+    private stopHeartbeat;
+    /**
+     * 清理资源
+     */
+    private cleanup;
+    /**
+     * 处理错误
+     */
+    private handleError;
+    /**
+     * 日志输出
+     */
+    private log;
+}
+/**
+ * 创建 WebSocket 客户端
+ * @param options - 配置选项
+ * @returns WebSocket 客户端实例
+ * @example
+ * ```ts
+ * const ws = createWebSocket({
+ *   url: 'echo.websocket.org',
+ *   autoReconnect: true,
+ *   onMessage: (data) => console.log('Received:', data)
+ * })
+ *
+ * ws.send('Hello, WebSocket!')
+ * ```
+ */
+declare function createWebSocket(options: WebSocketOptions): IWebSocketClient;
+/**
+ * 快速连接 WebSocket
+ * @param url - WebSocket 服务器地址
+ * @param handlers - 事件处理器
+ * @returns WebSocket 客户端实例
+ * @example
+ * ```ts
+ * const ws = quickConnect('echo.websocket.org', {
+ *   onMessage: (data) => console.log('Received:', data)
+ * })
+ * ```
+ */
+declare function quickConnect(url: string, handlers?: WebSocketEventHandlers): IWebSocketClient;
+declare const _default: {
+    WebSocketClient: typeof WebSocketClient;
+    createWebSocket: typeof createWebSocket;
+    quickConnect: typeof quickConnect;
+    WebSocketState: typeof WebSocketState;
+};
+
+type index_IWebSocketClient = IWebSocketClient;
+type index_WebSocketClient = WebSocketClient;
+declare const index_WebSocketClient: typeof WebSocketClient;
+type index_WebSocketEventHandlers = WebSocketEventHandlers;
+type index_WebSocketMessage = WebSocketMessage;
+type index_WebSocketOptions = WebSocketOptions;
+type index_WebSocketState = WebSocketState;
+declare const index_WebSocketState: typeof WebSocketState;
+declare const index_createWebSocket: typeof createWebSocket;
+declare const index_quickConnect: typeof quickConnect;
+declare namespace index {
+  export { type index_IWebSocketClient as IWebSocketClient, index_WebSocketClient as WebSocketClient, type index_WebSocketEventHandlers as WebSocketEventHandlers, type index_WebSocketMessage as WebSocketMessage, type index_WebSocketOptions as WebSocketOptions, index_WebSocketState as WebSocketState, index_createWebSocket as createWebSocket, _default as default, index_quickConnect as quickConnect };
+}
+
+export { type IWebSocketClient as I, WebSocketClient as W, _default as _, type WebSocketEventHandlers as a, type WebSocketMessage as b, type WebSocketOptions as c, WebSocketState as d, createWebSocket as e, index as i, quickConnect as q };

package/dist/index-Cq1GhjpY.d.ts

@@ -0,0 +1,229 @@
+/**
+ * WebSocket Module - WebSocket 工具
+ *
+ * 提供简化的 WebSocket 连接、消息发送、心跳检测和重连机制
+ */
+/**
+ * WebSocket 连接状态
+ */
+declare enum WebSocketState {
+    CONNECTING = 0,
+    OPEN = 1,
+    CLOSING = 2,
+    CLOSED = 3
+}
+/**
+ * WebSocket 配置选项
+ */
+interface WebSocketOptions {
+    /** WebSocket 服务器地址 */
+    url: string;
+    /** 协议（wss:// 或 ws://），默认自动检测 */
+    protocol?: 'ws' | 'wss';
+    /** 子协议 */
+    protocols?: string | string[];
+    /** 是否自动重连，默认 true */
+    autoReconnect?: boolean;
+    /** 重连次数，默认 3 */
+    reconnectAttempts?: number;
+    /** 重连间隔（毫秒），默认 3000 */
+    reconnectInterval?: number;
+    /** 心跳检测间隔（毫秒），默认 30000 */
+    heartbeatInterval?: number;
+    /** 心跳消息内容，默认 'ping' */
+    heartbeatMessage?: string | object;
+    /** 心跳超时时间（毫秒），默认 5000 */
+    heartbeatTimeout?: number;
+    /** 连接超时时间（毫秒），默认 10000 */
+    connectTimeout?: number;
+    /** 是否记录日志，默认 true */
+    debug?: boolean;
+}
+/**
+ * WebSocket 消息类型
+ */
+type WebSocketMessage = string | object | ArrayBuffer | Blob;
+/**
+ * WebSocket 事件处理器
+ */
+interface WebSocketEventHandlers {
+    /** 连接成功回调 */
+    onOpen?: (event: Event) => void;
+    /** 接收消息回调 */
+    onMessage?: (data: WebSocketMessage, event: MessageEvent) => void;
+    /** 连接关闭回调 */
+    onClose?: (event: CloseEvent) => void;
+    /** 错误回调 */
+    onError?: (event: Event) => void;
+    /** 重连开始回调 */
+    onReconnect?: (attempt: number) => void;
+    /** 重连成功回调 */
+    onReconnectSuccess?: (attempt: number) => void;
+    /** 重连失败回调 */
+    onReconnectFailed?: () => void;
+    /** 心跳回调 */
+    onHeartbeat?: () => void;
+    /** 心跳超时回调 */
+    onHeartbeatTimeout?: () => void;
+}
+/**
+ * WebSocket 实例接口
+ */
+interface IWebSocketClient {
+    /** 连接 WebSocket */
+    connect(): void;
+    /** 断开连接 */
+    disconnect(): void;
+    /** 发送消息 */
+    send(data: WebSocketMessage): Promise<void>;
+    /** 发送消息（不带 Promise） */
+    sendSync(data: WebSocketMessage): void;
+    /** 获取连接状态 */
+    getState(): WebSocketState;
+    /** 是否已连接 */
+    isConnected(): boolean;
+    /** 获取 WebSocket 实例 */
+    getInstance(): WebSocket | null;
+    /** 设置事件处理器 */
+    on<K extends keyof WebSocketEventHandlers>(event: K, handler: WebSocketEventHandlers[K]): void;
+    /** 移除事件处理器 */
+    off<K extends keyof WebSocketEventHandlers>(event: K, handler?: WebSocketEventHandlers[K]): void;
+    /** 重新连接 */
+    reconnect(): void;
+}
+/**
+ * WebSocket 客户端类
+ */
+declare class WebSocketClient implements IWebSocketClient {
+    private ws;
+    private options;
+    private handlers;
+    private reconnectTimer;
+    private heartbeatTimer;
+    private heartbeatTimeoutTimer;
+    private reconnectCount;
+    private isManualDisconnect;
+    private messageQueue;
+    private connectResolve;
+    private connectReject;
+    constructor(options: WebSocketOptions);
+    /**
+     * 连接 WebSocket
+     */
+    connect(): void;
+    /**
+     * 断开连接
+     */
+    disconnect(): void;
+    /**
+     * 发送消息（异步）
+     */
+    send(data: WebSocketMessage): Promise<void>;
+    /**
+     * 发送消息（同步）
+     */
+    sendSync(data: WebSocketMessage): void;
+    /**
+     * 获取连接状态
+     */
+    getState(): WebSocketState;
+    /**
+     * 是否已连接
+     */
+    isConnected(): boolean;
+    /**
+     * 获取 WebSocket 实例
+     */
+    getInstance(): WebSocket | null;
+    /**
+     * 设置事件处理器
+     */
+    on<K extends keyof WebSocketEventHandlers>(event: K, handler: WebSocketEventHandlers[K]): void;
+    /**
+     * 移除事件处理器
+     */
+    off<K extends keyof WebSocketEventHandlers>(event: K, handler?: WebSocketEventHandlers[K]): void;
+    /**
+     * 重新连接
+     */
+    reconnect(): void;
+    /**
+     * 设置事件处理器
+     */
+    private setupEventHandlers;
+    /**
+     * 尝试重连
+     */
+    private attemptReconnect;
+    /**
+     * 启动心跳
+     */
+    private startHeartbeat;
+    /**
+     * 停止心跳
+     */
+    private stopHeartbeat;
+    /**
+     * 清理资源
+     */
+    private cleanup;
+    /**
+     * 处理错误
+     */
+    private handleError;
+    /**
+     * 日志输出
+     */
+    private log;
+}
+/**
+ * 创建 WebSocket 客户端
+ * @param options - 配置选项
+ * @returns WebSocket 客户端实例
+ * @example
+ * ```ts
+ * const ws = createWebSocket({
+ *   url: 'echo.websocket.org',
+ *   autoReconnect: true,
+ *   onMessage: (data) => console.log('Received:', data)
+ * })
+ *
+ * ws.send('Hello, WebSocket!')
+ * ```
+ */
+declare function createWebSocket(options: WebSocketOptions): IWebSocketClient;
+/**
+ * 快速连接 WebSocket
+ * @param url - WebSocket 服务器地址
+ * @param handlers - 事件处理器
+ * @returns WebSocket 客户端实例
+ * @example
+ * ```ts
+ * const ws = quickConnect('echo.websocket.org', {
+ *   onMessage: (data) => console.log('Received:', data)
+ * })
+ * ```
+ */
+declare function quickConnect(url: string, handlers?: WebSocketEventHandlers): IWebSocketClient;
+declare const _default: {
+    WebSocketClient: typeof WebSocketClient;
+    createWebSocket: typeof createWebSocket;
+    quickConnect: typeof quickConnect;
+    WebSocketState: typeof WebSocketState;
+};
+
+type index_IWebSocketClient = IWebSocketClient;
+type index_WebSocketClient = WebSocketClient;
+declare const index_WebSocketClient: typeof WebSocketClient;
+type index_WebSocketEventHandlers = WebSocketEventHandlers;
+type index_WebSocketMessage = WebSocketMessage;
+type index_WebSocketOptions = WebSocketOptions;
+type index_WebSocketState = WebSocketState;
+declare const index_WebSocketState: typeof WebSocketState;
+declare const index_createWebSocket: typeof createWebSocket;
+declare const index_quickConnect: typeof quickConnect;
+declare namespace index {
+  export { type index_IWebSocketClient as IWebSocketClient, index_WebSocketClient as WebSocketClient, type index_WebSocketEventHandlers as WebSocketEventHandlers, type index_WebSocketMessage as WebSocketMessage, type index_WebSocketOptions as WebSocketOptions, index_WebSocketState as WebSocketState, index_createWebSocket as createWebSocket, _default as default, index_quickConnect as quickConnect };
+}
+
+export { type IWebSocketClient as I, WebSocketClient as W, _default as _, type WebSocketEventHandlers as a, type WebSocketMessage as b, type WebSocketOptions as c, WebSocketState as d, createWebSocket as e, index as i, quickConnect as q };