@brewer/dj-common 1.0.0-beta.0 → 1.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -139
- package/dist/MessageSocket.cjs.js +1 -1
- package/dist/MessageSocket.cjs.js.map +1 -1
- package/dist/MessageSocket.esm.js +1 -1
- package/dist/MessageSocket.esm.js.map +1 -1
- package/dist/index.cjs.js +1 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/package.json +6 -1
- package/.claude/settings.local.json +0 -28
- package/.gitattributes +0 -19
- package/.github/workflows/release.yml +0 -56
- package/.husky/commit-msg +0 -1
- package/.husky/pre-commit +0 -1
- package/.lintstagedrc.json +0 -4
- package/.prettierignore +0 -4
- package/.prettierrc +0 -9
- package/.versionrc.json +0 -22
- package/commitlint.config.cjs +0 -23
- package/docs/README.md +0 -80
- package/eslint.config.js +0 -76
- package/examples/basic-test/README.md +0 -39
- package/examples/basic-test/index.js +0 -56
- package/examples/basic-test/package.json +0 -10
- package/scripts/release.sh +0 -98
- package/tsconfig.json +0 -25
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":["../src/WebSocketClient.ts","../src/MessageSocket.ts"],"sourcesContent":["/**\n * WebSocket 配置选项\n */\nexport interface WebSocketConfig {\n /** WebSocket 服务器地址(可选,可以在 connect 时指定) */\n url?: string\n /** 心跳间隔(毫秒),默认 25000 */\n heartbeatInterval?: number\n /** 最大重连次数,默认 10 */\n maxReconnectAttempts?: number\n /** 重连延迟(毫秒),默认 3000 */\n reconnectDelay?: number\n /** 最大重连延迟(毫秒),默认 10000 */\n reconnectDelayMax?: number\n /** 心跳消息生成器 */\n heartbeatMessage?: () => string | object\n /** 是否自动重连,默认 true */\n autoReconnect?: boolean\n}\n\n/**\n * 消息数据结构\n */\nexport interface MessageData<T = unknown> {\n /** 消息类型 */\n type: string\n /** 消息数据 */\n data: T\n /** 元数据 */\n meta?: Record<string, unknown>\n /** 时间戳 */\n timestamp?: number\n}\n\n/**\n * 消息回调函数\n */\nexport type MessageCallback<T = unknown> = (data: T, message?: MessageData<T>) => void\n\n/**\n * 消息回调配置\n */\nexport interface MessageCallbackEntry<T = unknown> {\n /** 消息类型 */\n type: string\n /** 回调函数 */\n callback: MessageCallback<T>\n}\n\n/**\n * WebSocket 基础封装类\n * 提供连接管理、心跳、自动重连、消息回调等基础功能\n */\nexport class WebSocketClient {\n /** WebSocket 连接实例 */\n protected socket: WebSocket | null = null\n\n /** 心跳定时器 */\n protected heartbeatTimer: number | null = null\n\n /** 重连定时器 */\n protected reconnectTimer: number | null = null\n\n /** 消息回调列表 */\n protected callbackList: MessageCallbackEntry<unknown>[] = []\n\n /** 当前连接的 URL */\n protected currentUrl: string | null = null\n\n /** 配置选项 */\n protected config: Required<WebSocketConfig>\n\n /** 重连次数 */\n protected reconnectAttempts = 0\n\n /** 是否手动关闭 */\n protected manualClose = false\n\n /**\n * 默认配置\n */\n protected static readonly DEFAULT_CONFIG: Required<WebSocketConfig> = {\n url: '',\n heartbeatInterval: 25000,\n maxReconnectAttempts: 10,\n reconnectDelay: 3000,\n reconnectDelayMax: 10000,\n autoReconnect: true,\n heartbeatMessage: () => ({\n type: 'PING',\n timestamp: Date.now(),\n }),\n }\n\n /**\n * 构造函数\n * @param config 配置选项\n */\n constructor(config: WebSocketConfig = {}) {\n this.config = { ...WebSocketClient.DEFAULT_CONFIG, ...config }\n }\n\n /**\n * 更新配置\n * @param config 新的配置选项\n */\n public updateConfig(config: Partial<WebSocketConfig>): void {\n this.config = { ...this.config, ...config }\n }\n\n /**\n * 连接到 WebSocket 服务器\n * @param url WebSocket 地址(可选,如果不传则使用配置中的 url)\n */\n public connect(url?: string): void {\n const targetUrl = url || this.config.url\n if (!targetUrl) {\n console.error('[WebSocketClient] 缺少 WebSocket URL')\n return\n }\n\n this.currentUrl = targetUrl\n this.manualClose = false\n\n try {\n this.socket = new WebSocket(targetUrl)\n\n this.socket.onopen = () => {\n console.log('[WebSocketClient] 连接成功')\n this.reconnectAttempts = 0\n this.startHeartbeat()\n this.onOpen()\n }\n\n this.socket.onmessage = (event: MessageEvent) => {\n this.handleIncoming(event.data)\n }\n\n this.socket.onclose = (event: CloseEvent) => {\n console.log('[WebSocketClient] 连接关闭', event.code, event.reason)\n this.stopHeartbeat()\n this.onClose(event)\n\n if (!this.manualClose && this.config.autoReconnect) {\n this.scheduleReconnect()\n }\n }\n\n this.socket.onerror = (event: Event) => {\n console.error('[WebSocketClient] 连接错误', event)\n this.stopHeartbeat()\n this.onError(event)\n }\n } catch (error) {\n console.error('[WebSocketClient] 连接失败', error)\n if (this.config.autoReconnect && !this.manualClose) {\n this.scheduleReconnect()\n }\n }\n }\n\n /**\n * 计划重连\n */\n protected scheduleReconnect(): void {\n if (this.reconnectAttempts >= this.config.maxReconnectAttempts || !this.currentUrl || this.manualClose) {\n if (this.reconnectAttempts >= this.config.maxReconnectAttempts) {\n console.warn('[WebSocketClient] 已达到最大重连次数')\n }\n return\n }\n\n this.reconnectAttempts += 1\n const delay = Math.min(this.config.reconnectDelay * this.reconnectAttempts, this.config.reconnectDelayMax)\n\n console.log(`[WebSocketClient] 将在 ${delay}ms 后进行第 ${this.reconnectAttempts} 次重连`)\n\n this.reconnectTimer = window.setTimeout(() => {\n this.connect(this.currentUrl!)\n }, delay)\n }\n\n /**\n * 断开连接\n */\n public disconnect(): void {\n this.manualClose = true\n this.stopHeartbeat()\n\n if (this.reconnectTimer) {\n clearTimeout(this.reconnectTimer)\n this.reconnectTimer = null\n }\n\n if (this.socket) {\n this.socket.close()\n this.socket = null\n }\n\n this.currentUrl = null\n this.reconnectAttempts = 0\n }\n\n /**\n * 发送消息\n * @param data 消息数据\n */\n public send(data: string | object): void {\n if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {\n console.warn('[WebSocketClient] WebSocket 未连接,无法发送消息')\n return\n }\n\n const message = typeof data === 'string' ? data : JSON.stringify(data)\n this.socket.send(message)\n }\n\n /**\n * 处理接收的消息\n * @param data 接收到的数据\n */\n protected handleIncoming(data: string): void {\n if (!data) return\n\n let message: MessageData\n try {\n message = JSON.parse(data)\n } catch {\n console.warn('[WebSocketClient] 无法解析消息', data)\n return\n }\n\n if (!message?.type) {\n return\n }\n\n // 触发匹配的回调\n const matched = this.callbackList.filter((entry) => entry.type === message.type)\n matched.forEach(({ callback }) => {\n try {\n callback(message.data, message)\n } catch (error) {\n console.error('[WebSocketClient] 回调执行失败', error)\n }\n })\n\n // 调用钩子\n this.onMessage(message)\n }\n\n /**\n * 启动心跳\n */\n protected startHeartbeat(): void {\n this.stopHeartbeat()\n\n if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {\n return\n }\n\n this.heartbeatTimer = window.setInterval(() => {\n if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {\n return\n }\n\n const heartbeatData = this.config.heartbeatMessage()\n this.send(heartbeatData)\n }, this.config.heartbeatInterval)\n }\n\n /**\n * 停止心跳\n */\n protected stopHeartbeat(): void {\n if (this.heartbeatTimer) {\n clearInterval(this.heartbeatTimer)\n this.heartbeatTimer = null\n }\n }\n\n /**\n * 注册消息回调\n * @param entry 回调配置\n */\n public on<T = unknown>(type: string, callback: MessageCallback<T>): void\n public on<T = unknown>(entry: MessageCallbackEntry<T>): void\n public on<T = unknown>(typeOrEntry: string | MessageCallbackEntry<T>, callback?: MessageCallback<T>): void {\n const entry: MessageCallbackEntry<T> =\n typeof typeOrEntry === 'string' ? { type: typeOrEntry, callback: callback! } : typeOrEntry\n\n if (!entry.type || typeof entry.callback !== 'function') {\n console.warn('[WebSocketClient] 无效的回调配置', entry)\n return\n }\n\n this.callbackList.push(entry as MessageCallbackEntry<unknown>)\n }\n\n /**\n * 取消注册消息回调\n * @param type 消息类型\n * @param callback 回调函数(可选,如果不传则移除该类型的所有回调)\n */\n public off<T = unknown>(type: string, callback?: MessageCallback<T>): void {\n if (callback) {\n this.callbackList = this.callbackList.filter((entry) => !(entry.type === type && entry.callback === callback))\n } else {\n this.callbackList = this.callbackList.filter((entry) => entry.type !== type)\n }\n }\n\n /**\n * 清空所有回调\n */\n public clearCallbacks(): void {\n this.callbackList = []\n }\n\n /**\n * 获取当前连接状态\n */\n public getReadyState(): number {\n return this.socket?.readyState ?? WebSocket.CLOSED\n }\n\n /**\n * 是否已连接\n */\n public isConnected(): boolean {\n return this.socket?.readyState === WebSocket.OPEN\n }\n\n // ========== 钩子方法(子类可以重写) ==========\n\n /**\n * 连接打开时的钩子\n */\n protected onOpen(): void {\n // 子类可以重写\n }\n\n /**\n * 连接关闭时的钩子\n */\n protected onClose(_event: CloseEvent): void {\n // 子类可以重写\n }\n\n /**\n * 连接错误时的钩子\n */\n protected onError(_event: Event): void {\n // 子类可以重写\n }\n\n /**\n * 收到消息时的钩子\n */\n protected onMessage(_message: MessageData): void {\n // 子类可以重写\n }\n}\n","import { WebSocketClient, WebSocketConfig, MessageCallbackEntry } from './WebSocketClient'\n\n/**\n * MessageSocket 配置选项\n */\nexport interface MessageSocketConfig extends WebSocketConfig {\n /** WebSocket 服务器基础地址,默认 'ws://dev-gateway.chinamarket.cn' */\n baseUrl?: string\n /** WebSocket 路径,默认 '/api/user-web/websocket/messageServer' */\n path?: string\n}\n\n/**\n * MessageSocket 启动选项\n */\nexport interface MessageSocketStartOptions {\n /** 用户ID(必需) */\n userId: string\n /** 认证令牌(必需) */\n token: string\n /** 消息回调列表 */\n callbacks?: MessageCallbackEntry[]\n}\n\n/**\n * 消息 Socket 类\n * 基于 WebSocketClient,提供用户认证和消息管理功能\n * 用于获取用户未读消息数量等业务场景\n *\n * @example\n * ```typescript\n * // 启动连接\n * MessageSocket.start({\n * userId: '1234567890',\n * token: 'your-token',\n * callbacks: [\n * {\n * type: 'UNREAD_COUNT',\n * callback: (payload) => {\n * console.log('未读消息数:', payload)\n * }\n * }\n * ]\n * })\n *\n * // 停止连接\n * MessageSocket.stop()\n *\n * // 动态注册回调\n * MessageSocket.registerCallbacks({\n * type: 'NEW_MESSAGE',\n * callback: (payload) => {\n * console.log('新消息:', payload)\n * }\n * })\n * ```\n */\nexport class MessageSocket {\n /** 默认配置 */\n private static readonly DEFAULT_CONFIG: MessageSocketConfig = {\n baseUrl: 'ws://dev-gateway.chinamarket.cn',\n path: '/api/user-web/websocket/messageServer',\n heartbeatInterval: 25000,\n maxReconnectAttempts: 10,\n reconnectDelay: 3000,\n reconnectDelayMax: 10000,\n autoReconnect: true,\n }\n\n /** WebSocket 客户端实例 */\n private static client: WebSocketClient | null = null\n\n /** 当前用户ID */\n private static currentUserId: string | null = null\n\n /** 当前token */\n private static currentToken: string | null = null\n\n /** 当前配置 */\n private static config: MessageSocketConfig = { ...MessageSocket.DEFAULT_CONFIG }\n\n /**\n * 配置 MessageSocket\n * @param config 配置选项\n */\n public static configure(config: Partial<MessageSocketConfig>): void {\n MessageSocket.config = { ...MessageSocket.config, ...config }\n }\n\n /**\n * 启动连接\n * @param options 启动选项\n */\n public static start(options: MessageSocketStartOptions): void {\n const { userId, token, callbacks = [] } = options\n\n if (!userId || !token) {\n console.warn('[MessageSocket] 缺少 userId 或 token,无法启动')\n return\n }\n\n // 检查是否可以复用现有连接\n const shouldReuse =\n MessageSocket.client &&\n MessageSocket.client.isConnected() &&\n MessageSocket.currentUserId === userId &&\n MessageSocket.currentToken === token\n\n if (shouldReuse) {\n console.log('[MessageSocket] 复用现有连接')\n // 重新注册回调\n callbacks.forEach((entry) => MessageSocket.registerCallbacks(entry))\n return\n }\n\n // 停止旧连接\n MessageSocket.stop()\n\n // 保存当前用户信息\n MessageSocket.currentUserId = userId\n MessageSocket.currentToken = token\n\n // 构建 WebSocket URL\n const { baseUrl, path, ...clientConfig } = MessageSocket.config\n const url = `${baseUrl}${path}/${userId}?token=${encodeURIComponent(token)}`\n\n // 创建新的 WebSocket 客户端\n MessageSocket.client = new WebSocketClient({\n ...clientConfig,\n url,\n })\n\n // 注册回调\n callbacks.forEach((entry) => MessageSocket.registerCallbacks(entry))\n\n // 连接\n MessageSocket.client.connect()\n }\n\n /**\n * 停止连接\n */\n public static stop(): void {\n if (MessageSocket.client) {\n MessageSocket.client.disconnect()\n MessageSocket.client.clearCallbacks()\n MessageSocket.client = null\n }\n\n MessageSocket.currentUserId = null\n MessageSocket.currentToken = null\n }\n\n /**\n * 注册消息回调\n * @param entry 回调配置\n */\n public static registerCallbacks<T = unknown>(entry: MessageCallbackEntry<T>): void {\n if (!entry) {\n console.warn('[MessageSocket] 注册回调失败,缺少 entry', entry)\n return\n }\n\n if (typeof entry !== 'object') {\n console.warn('[MessageSocket] 注册回调失败,entry 不是对象', entry)\n return\n }\n\n if (typeof entry.callback !== 'function') {\n console.warn('[MessageSocket] 注册回调失败,callback 不是函数', entry)\n return\n }\n\n if (typeof entry.type !== 'string') {\n console.warn('[MessageSocket] 注册回调失败,type 不是字符串', entry)\n return\n }\n\n if (!MessageSocket.client) {\n console.warn('[MessageSocket] WebSocket 客户端未初始化,无法注册回调')\n return\n }\n\n MessageSocket.client.on(entry)\n }\n\n /**\n * 取消注册消息回调\n * @param type 消息类型\n * @param callback 回调函数(可选)\n */\n public static unregisterCallbacks<T = unknown>(type: string, callback?: (data: T, message?: unknown) => void): void {\n if (!MessageSocket.client) {\n return\n }\n\n MessageSocket.client.off(type, callback)\n }\n\n /**\n * 发送消息\n * @param data 消息数据\n */\n public static send(data: string | object): void {\n if (!MessageSocket.client) {\n console.warn('[MessageSocket] WebSocket 客户端未初始化,无法发送消息')\n return\n }\n\n MessageSocket.client.send(data)\n }\n\n /**\n * 获取连接状态\n */\n public static getReadyState(): number {\n return MessageSocket.client?.getReadyState() ?? WebSocket.CLOSED\n }\n\n /**\n * 是否已连接\n */\n public static isConnected(): boolean {\n return MessageSocket.client?.isConnected() ?? false\n }\n\n /**\n * 获取当前用户ID\n */\n public static getCurrentUserId(): string | null {\n return MessageSocket.currentUserId\n }\n\n /**\n * 获取当前token\n */\n public static getCurrentToken(): string | null {\n return MessageSocket.currentToken\n }\n}\n"],"names":["WebSocketClient","constructor","config","this","socket","heartbeatTimer","reconnectTimer","callbackList","currentUrl","reconnectAttempts","manualClose","DEFAULT_CONFIG","updateConfig","connect","url","targetUrl","WebSocket","onopen","console","log","startHeartbeat","onOpen","onmessage","event","handleIncoming","data","onclose","code","reason","stopHeartbeat","onClose","autoReconnect","scheduleReconnect","onerror","error","onError","maxReconnectAttempts","warn","delay","Math","min","reconnectDelay","reconnectDelayMax","window","setTimeout","disconnect","clearTimeout","close","send","readyState","OPEN","message","JSON","stringify","parse","type","filter","entry","forEach","callback","onMessage","setInterval","heartbeatData","heartbeatMessage","heartbeatInterval","clearInterval","on","typeOrEntry","push","off","clearCallbacks","getReadyState","CLOSED","isConnected","_event","_message","timestamp","Date","now","MessageSocket","configure","start","options","userId","token","callbacks","client","currentUserId","currentToken","registerCallbacks","stop","baseUrl","path","clientConfig","encodeURIComponent","unregisterCallbacks","getCurrentUserId","getCurrentToken"],"mappings":"MAqDaA,EA6CX,WAAAC,CAAYC,EAA0B,IA3C5BC,KAAAC,OAA2B,KAG3BD,KAAAE,eAAgC,KAGhCF,KAAAG,eAAgC,KAGhCH,KAAAI,aAAgD,GAGhDJ,KAAAK,WAA4B,KAM5BL,KAAAM,kBAAoB,EAGpBN,KAAAO,aAAc,EAuBtBP,KAAKD,OAAS,IAAKF,EAAgBW,kBAAmBT,EACxD,CAMO,YAAAU,CAAaV,GAClBC,KAAKD,OAAS,IAAKC,KAAKD,UAAWA,EACrC,CAMO,OAAAW,CAAQC,GACb,MAAMC,EAAYD,GAAOX,KAAKD,OAAOY,IACrC,GAAKC,EAAL,CAKAZ,KAAKK,WAAaO,EAClBZ,KAAKO,aAAc,EAEnB,IACEP,KAAKC,OAAS,IAAIY,UAAUD,GAE5BZ,KAAKC,OAAOa,OAAS,KACnBC,QAAQC,IAAI,0BACZhB,KAAKM,kBAAoB,EACzBN,KAAKiB,iBACLjB,KAAKkB,UAGPlB,KAAKC,OAAOkB,UAAaC,IACvBpB,KAAKqB,eAAeD,EAAME,OAG5BtB,KAAKC,OAAOsB,QAAWH,IACrBL,QAAQC,IAAI,yBAA0BI,EAAMI,KAAMJ,EAAMK,QACxDzB,KAAK0B,gBACL1B,KAAK2B,QAAQP,IAERpB,KAAKO,aAAeP,KAAKD,OAAO6B,eACnC5B,KAAK6B,qBAIT7B,KAAKC,OAAO6B,QAAWV,IACrBL,QAAQgB,MAAM,yBAA0BX,GACxCpB,KAAK0B,gBACL1B,KAAKgC,QAAQZ,GAEjB,CAAE,MAAOW,GACPhB,QAAQgB,MAAM,yBAA0BA,GACpC/B,KAAKD,OAAO6B,gBAAkB5B,KAAKO,aACrCP,KAAK6B,mBAET,CAvCA,MAFEd,QAAQgB,MAAM,qCA0ClB,CAKU,iBAAAF,GACR,GAAI7B,KAAKM,mBAAqBN,KAAKD,OAAOkC,uBAAyBjC,KAAKK,YAAcL,KAAKO,YAIzF,YAHIP,KAAKM,mBAAqBN,KAAKD,OAAOkC,sBACxClB,QAAQmB,KAAK,gCAKjBlC,KAAKM,mBAAqB,EAC1B,MAAM6B,EAAQC,KAAKC,IAAIrC,KAAKD,OAAOuC,eAAiBtC,KAAKM,kBAAmBN,KAAKD,OAAOwC,mBAExFxB,QAAQC,IAAI,wBAAwBmB,YAAgBnC,KAAKM,yBAEzDN,KAAKG,eAAiBqC,OAAOC,WAAW,KACtCzC,KAAKU,QAAQV,KAAKK,aACjB8B,EACL,CAKO,UAAAO,GACL1C,KAAKO,aAAc,EACnBP,KAAK0B,gBAED1B,KAAKG,iBACPwC,aAAa3C,KAAKG,gBAClBH,KAAKG,eAAiB,MAGpBH,KAAKC,SACPD,KAAKC,OAAO2C,QACZ5C,KAAKC,OAAS,MAGhBD,KAAKK,WAAa,KAClBL,KAAKM,kBAAoB,CAC3B,CAMO,IAAAuC,CAAKvB,GACV,IAAKtB,KAAKC,QAAUD,KAAKC,OAAO6C,aAAejC,UAAUkC,KAEvD,YADAhC,QAAQmB,KAAK,0CAIf,MAAMc,EAA0B,iBAAT1B,EAAoBA,EAAO2B,KAAKC,UAAU5B,GACjEtB,KAAKC,OAAO4C,KAAKG,EACnB,CAMU,cAAA3B,CAAeC,GACvB,IAAKA,EAAM,OAEX,IAAI0B,EACJ,IACEA,EAAUC,KAAKE,MAAM7B,EACvB,CAAE,MAEA,YADAP,QAAQmB,KAAK,2BAA4BZ,EAE3C,CAEA,IAAK0B,GAASI,KACZ,OAIcpD,KAAKI,aAAaiD,OAAQC,GAAUA,EAAMF,OAASJ,EAAQI,MACnEG,QAAQ,EAAGC,eACjB,IACEA,EAASR,EAAQ1B,KAAM0B,EACzB,CAAE,MAAOjB,GACPhB,QAAQgB,MAAM,2BAA4BA,EAC5C,IAIF/B,KAAKyD,UAAUT,EACjB,CAKU,cAAA/B,GACRjB,KAAK0B,gBAEA1B,KAAKC,QAAUD,KAAKC,OAAO6C,aAAejC,UAAUkC,OAIzD/C,KAAKE,eAAiBsC,OAAOkB,YAAY,KACvC,IAAK1D,KAAKC,QAAUD,KAAKC,OAAO6C,aAAejC,UAAUkC,KACvD,OAGF,MAAMY,EAAgB3D,KAAKD,OAAO6D,mBAClC5D,KAAK6C,KAAKc,IACT3D,KAAKD,OAAO8D,mBACjB,CAKU,aAAAnC,GACJ1B,KAAKE,iBACP4D,cAAc9D,KAAKE,gBACnBF,KAAKE,eAAiB,KAE1B,CAQO,EAAA6D,CAAgBC,EAA+CR,GACpE,MAAMF,EACmB,iBAAhBU,EAA2B,CAAEZ,KAAMY,EAAaR,SAAUA,GAAcQ,EAE5EV,EAAMF,MAAkC,mBAAnBE,EAAME,SAKhCxD,KAAKI,aAAa6D,KAAKX,GAJrBvC,QAAQmB,KAAK,4BAA6BoB,EAK9C,CAOO,GAAAY,CAAiBd,EAAcI,GAElCxD,KAAKI,aADHoD,EACkBxD,KAAKI,aAAaiD,OAAQC,KAAYA,EAAMF,OAASA,GAAQE,EAAME,WAAaA,IAEhFxD,KAAKI,aAAaiD,OAAQC,GAAUA,EAAMF,OAASA,EAE3E,CAKO,cAAAe,GACLnE,KAAKI,aAAe,EACtB,CAKO,aAAAgE,GACL,OAAOpE,KAAKC,QAAQ6C,YAAcjC,UAAUwD,MAC9C,CAKO,WAAAC,GACL,OAAOtE,KAAKC,QAAQ6C,aAAejC,UAAUkC,IAC/C,CAOU,MAAA7B,GAEV,CAKU,OAAAS,CAAQ4C,GAElB,CAKU,OAAAvC,CAAQuC,GAElB,CAKU,SAAAd,CAAUe,GAEpB,EAvR0B3E,EAAAW,eAA4C,CACpEG,IAAK,GACLkD,kBAAmB,KACnB5B,qBAAsB,GACtBK,eAAgB,IAChBC,kBAAmB,IACnBX,eAAe,EACfgC,iBAAkB,KAAA,CAChBR,KAAM,OACNqB,UAAWC,KAAKC,eCjCTC,EA4BJ,gBAAOC,CAAU9E,GACtB6E,EAAc7E,OAAS,IAAK6E,EAAc7E,UAAWA,EACvD,CAMO,YAAO+E,CAAMC,GAClB,MAAMC,OAAEA,EAAMC,MAAEA,EAAKC,UAAEA,EAAY,IAAOH,EAE1C,IAAKC,IAAWC,EAEd,YADAlE,QAAQmB,KAAK,0CAWf,GALE0C,EAAcO,QACdP,EAAcO,OAAOb,eACrBM,EAAcQ,gBAAkBJ,GAChCJ,EAAcS,eAAiBJ,EAM/B,OAHAlE,QAAQC,IAAI,+BAEZkE,EAAU3B,QAASD,GAAUsB,EAAcU,kBAAkBhC,IAK/DsB,EAAcW,OAGdX,EAAcQ,cAAgBJ,EAC9BJ,EAAcS,aAAeJ,EAG7B,MAAMO,QAAEA,EAAOC,KAAEA,KAASC,GAAiBd,EAAc7E,OACnDY,EAAM,GAAG6E,IAAUC,KAAQT,WAAgBW,mBAAmBV,KAGpEL,EAAcO,OAAS,IAAItF,EAAgB,IACtC6F,EACH/E,QAIFuE,EAAU3B,QAASD,GAAUsB,EAAcU,kBAAkBhC,IAG7DsB,EAAcO,OAAOzE,SACvB,CAKO,WAAO6E,GACRX,EAAcO,SAChBP,EAAcO,OAAOzC,aACrBkC,EAAcO,OAAOhB,iBACrBS,EAAcO,OAAS,MAGzBP,EAAcQ,cAAgB,KAC9BR,EAAcS,aAAe,IAC/B,CAMO,wBAAOC,CAA+BhC,GACtCA,EAKgB,iBAAVA,EAKmB,mBAAnBA,EAAME,SAKS,iBAAfF,EAAMF,KAKZwB,EAAcO,OAKnBP,EAAcO,OAAOpB,GAAGT,GAJtBvC,QAAQmB,KAAK,4CALbnB,QAAQmB,KAAK,oCAAqCoB,GALlDvC,QAAQmB,KAAK,uCAAwCoB,GALrDvC,QAAQmB,KAAK,oCAAqCoB,GALlDvC,QAAQmB,KAAK,kCAAmCoB,EAyBpD,CAOO,0BAAOsC,CAAiCxC,EAAcI,GACtDoB,EAAcO,QAInBP,EAAcO,OAAOjB,IAAId,EAAMI,EACjC,CAMO,WAAOX,CAAKvB,GACZsD,EAAcO,OAKnBP,EAAcO,OAAOtC,KAAKvB,GAJxBP,QAAQmB,KAAK,2CAKjB,CAKO,oBAAOkC,GACZ,OAAOQ,EAAcO,QAAQf,iBAAmBvD,UAAUwD,MAC5D,CAKO,kBAAOC,GACZ,OAAOM,EAAcO,QAAQb,gBAAiB,CAChD,CAKO,uBAAOuB,GACZ,OAAOjB,EAAcQ,aACvB,CAKO,sBAAOU,GACZ,OAAOlB,EAAcS,YACvB,EAnLwBT,EAAApE,eAAsC,CAC5DgF,QAAS,kCACTC,KAAM,wCACN5B,kBAAmB,KACnB5B,qBAAsB,GACtBK,eAAgB,IAChBC,kBAAmB,IACnBX,eAAe,GAIFgD,EAAAO,OAAiC,KAGjCP,EAAAQ,cAA+B,KAG/BR,EAAAS,aAA8B,KAG9BT,EAAA7E,OAA8B,IAAK6E,EAAcpE"}
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":["../src/WebSocketClient.ts","../src/MessageSocket.ts"],"sourcesContent":["/**\n * WebSocket 配置选项\n */\nexport interface WebSocketConfig {\n /** WebSocket 服务器地址(可选,可以在 connect 时指定) */\n url?: string\n /** 心跳间隔(毫秒),默认 25000 */\n heartbeatInterval?: number\n /** 最大重连次数,默认 10 */\n maxReconnectAttempts?: number\n /** 重连延迟(毫秒),默认 3000 */\n reconnectDelay?: number\n /** 最大重连延迟(毫秒),默认 10000 */\n reconnectDelayMax?: number\n /** 心跳消息生成器 */\n heartbeatMessage?: () => string | object\n /** 是否自动重连,默认 true */\n autoReconnect?: boolean\n}\n\n/**\n * 消息数据结构\n */\nexport interface MessageData<T = unknown> {\n /** 消息类型 */\n type: string\n /** 消息数据 */\n data: T\n /** 元数据 */\n meta?: Record<string, unknown>\n /** 时间戳 */\n timestamp?: number\n}\n\n/**\n * 消息回调函数\n */\nexport type MessageCallback<T = unknown> = (data: T, message?: MessageData<T>) => void\n\n/**\n * 消息回调配置\n */\nexport interface MessageCallbackEntry<T = unknown> {\n /** 消息类型 */\n type: string\n /** 回调函数 */\n callback: MessageCallback<T>\n}\n\n/**\n * WebSocket 基础封装类\n * 提供连接管理、心跳、自动重连、消息回调等基础功能\n */\nexport class WebSocketClient {\n /** WebSocket 连接实例 */\n protected socket: WebSocket | null = null\n\n /** 心跳定时器 */\n protected heartbeatTimer: number | null = null\n\n /** 重连定时器 */\n protected reconnectTimer: number | null = null\n\n /** 消息回调列表 */\n protected callbackList: MessageCallbackEntry<unknown>[] = []\n\n /** 当前连接的 URL */\n protected currentUrl: string | null = null\n\n /** 配置选项 */\n protected config: Required<WebSocketConfig>\n\n /** 重连次数 */\n protected reconnectAttempts = 0\n\n /** 是否手动关闭 */\n protected manualClose = false\n\n /**\n * 默认配置\n */\n protected static readonly DEFAULT_CONFIG: Required<WebSocketConfig> = {\n url: '',\n heartbeatInterval: 25000,\n maxReconnectAttempts: 10,\n reconnectDelay: 3000,\n reconnectDelayMax: 10000,\n autoReconnect: true,\n heartbeatMessage: () => ({\n type: 'PING',\n timestamp: Date.now(),\n }),\n }\n\n /**\n * 构造函数\n * @param config 配置选项\n */\n constructor(config: WebSocketConfig = {}) {\n this.config = { ...WebSocketClient.DEFAULT_CONFIG, ...config }\n }\n\n /**\n * 更新配置\n * @param config 新的配置选项\n */\n public updateConfig(config: Partial<WebSocketConfig>): void {\n this.config = { ...this.config, ...config }\n }\n\n /**\n * 连接到 WebSocket 服务器\n * @param url WebSocket 地址(可选,如果不传则使用配置中的 url)\n */\n public connect(url?: string): void {\n const targetUrl = url || this.config.url\n if (!targetUrl) {\n console.error('[WebSocketClient] 缺少 WebSocket URL')\n return\n }\n\n this.currentUrl = targetUrl\n this.manualClose = false\n\n try {\n this.socket = new WebSocket(targetUrl)\n\n this.socket.onopen = () => {\n console.log('[WebSocketClient] 连接成功')\n this.reconnectAttempts = 0\n this.startHeartbeat()\n this.onOpen()\n }\n\n this.socket.onmessage = (event: MessageEvent) => {\n this.handleIncoming(event.data)\n }\n\n this.socket.onclose = (event: CloseEvent) => {\n console.log('[WebSocketClient] 连接关闭', event.code, event.reason)\n this.stopHeartbeat()\n this.onClose(event)\n\n if (!this.manualClose && this.config.autoReconnect) {\n this.scheduleReconnect()\n }\n }\n\n this.socket.onerror = (event: Event) => {\n console.error('[WebSocketClient] 连接错误', event)\n this.stopHeartbeat()\n this.onError(event)\n }\n } catch (error) {\n console.error('[WebSocketClient] 连接失败', error)\n if (this.config.autoReconnect && !this.manualClose) {\n this.scheduleReconnect()\n }\n }\n }\n\n /**\n * 计划重连\n */\n protected scheduleReconnect(): void {\n if (this.reconnectAttempts >= this.config.maxReconnectAttempts || !this.currentUrl || this.manualClose) {\n if (this.reconnectAttempts >= this.config.maxReconnectAttempts) {\n console.warn('[WebSocketClient] 已达到最大重连次数')\n }\n return\n }\n\n this.reconnectAttempts += 1\n const delay = Math.min(this.config.reconnectDelay * this.reconnectAttempts, this.config.reconnectDelayMax)\n\n console.log(`[WebSocketClient] 将在 ${delay}ms 后进行第 ${this.reconnectAttempts} 次重连`)\n\n this.reconnectTimer = window.setTimeout(() => {\n this.connect(this.currentUrl!)\n }, delay)\n }\n\n /**\n * 断开连接\n */\n public disconnect(): void {\n this.manualClose = true\n this.stopHeartbeat()\n\n if (this.reconnectTimer) {\n clearTimeout(this.reconnectTimer)\n this.reconnectTimer = null\n }\n\n if (this.socket) {\n this.socket.close()\n this.socket = null\n }\n\n this.currentUrl = null\n this.reconnectAttempts = 0\n }\n\n /**\n * 发送消息\n * @param data 消息数据\n */\n public send(data: string | object): void {\n if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {\n console.warn('[WebSocketClient] WebSocket 未连接,无法发送消息')\n return\n }\n\n const message = typeof data === 'string' ? data : JSON.stringify(data)\n this.socket.send(message)\n }\n\n /**\n * 处理接收的消息\n * @param data 接收到的数据\n */\n protected handleIncoming(data: string): void {\n if (!data) return\n\n let message: MessageData\n try {\n message = JSON.parse(data)\n } catch {\n console.warn('[WebSocketClient] 无法解析消息', data)\n return\n }\n\n if (!message?.type) {\n return\n }\n\n // 触发匹配的回调\n const matched = this.callbackList.filter((entry) => entry.type === message.type)\n matched.forEach(({ callback }) => {\n try {\n callback(message.data, message)\n } catch (error) {\n console.error('[WebSocketClient] 回调执行失败', error)\n }\n })\n\n // 调用钩子\n this.onMessage(message)\n }\n\n /**\n * 启动心跳\n */\n protected startHeartbeat(): void {\n this.stopHeartbeat()\n\n if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {\n return\n }\n\n this.heartbeatTimer = window.setInterval(() => {\n if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {\n return\n }\n\n const heartbeatData = this.config.heartbeatMessage()\n this.send(heartbeatData)\n }, this.config.heartbeatInterval)\n }\n\n /**\n * 停止心跳\n */\n protected stopHeartbeat(): void {\n if (this.heartbeatTimer) {\n clearInterval(this.heartbeatTimer)\n this.heartbeatTimer = null\n }\n }\n\n /**\n * 注册消息回调\n * @param entry 回调配置\n */\n public on<T = unknown>(type: string, callback: MessageCallback<T>): void\n public on<T = unknown>(entry: MessageCallbackEntry<T>): void\n public on<T = unknown>(typeOrEntry: string | MessageCallbackEntry<T>, callback?: MessageCallback<T>): void {\n const entry: MessageCallbackEntry<T> =\n typeof typeOrEntry === 'string' ? { type: typeOrEntry, callback: callback! } : typeOrEntry\n\n if (!entry.type || typeof entry.callback !== 'function') {\n console.warn('[WebSocketClient] 无效的回调配置', entry)\n return\n }\n\n this.callbackList.push(entry as MessageCallbackEntry<unknown>)\n }\n\n /**\n * 取消注册消息回调\n * @param type 消息类型\n * @param callback 回调函数(可选,如果不传则移除该类型的所有回调)\n */\n public off<T = unknown>(type: string, callback?: MessageCallback<T>): void {\n if (callback) {\n this.callbackList = this.callbackList.filter((entry) => !(entry.type === type && entry.callback === callback))\n } else {\n this.callbackList = this.callbackList.filter((entry) => entry.type !== type)\n }\n }\n\n /**\n * 清空所有回调\n */\n public clearCallbacks(): void {\n this.callbackList = []\n }\n\n /**\n * 获取当前连接状态\n */\n public getReadyState(): number {\n return this.socket?.readyState ?? WebSocket.CLOSED\n }\n\n /**\n * 是否已连接\n */\n public isConnected(): boolean {\n return this.socket?.readyState === WebSocket.OPEN\n }\n\n // ========== 钩子方法(子类可以重写) ==========\n\n /**\n * 连接打开时的钩子\n */\n protected onOpen(): void {\n // 子类可以重写\n }\n\n /**\n * 连接关闭时的钩子\n */\n protected onClose(_event: CloseEvent): void {\n // 子类可以重写\n }\n\n /**\n * 连接错误时的钩子\n */\n protected onError(_event: Event): void {\n // 子类可以重写\n }\n\n /**\n * 收到消息时的钩子\n */\n protected onMessage(_message: MessageData): void {\n // 子类可以重写\n }\n}\n","import { WebSocketClient, WebSocketConfig, MessageCallbackEntry } from './WebSocketClient'\n\n/**\n * MessageSocket 配置选项\n */\nexport interface MessageSocketConfig extends WebSocketConfig {\n /** WebSocket 服务器基础地址,默认 'ws://dev-gateway.chinamarket.cn' */\n baseUrl?: string\n /** WebSocket 路径,默认 '/api/user-web/websocket/messageServer' */\n path?: string\n}\n\n/**\n * MessageSocket 启动选项\n */\nexport interface MessageSocketStartOptions {\n /** 用户ID(必需) */\n userId: string\n /** 认证令牌(必需) */\n token: string\n /** 消息回调列表 */\n callbacks?: MessageCallbackEntry[]\n}\n\n/**\n * 消息 Socket 类\n * 基于 WebSocketClient,提供用户认证和消息管理功能\n * 用于获取用户未读消息数量等业务场景\n *\n * @example\n * ```typescript\n * // 启动连接\n * MessageSocket.start({\n * userId: '1234567890',\n * token: 'your-token',\n * callbacks: [\n * {\n * type: 'UNREAD_COUNT',\n * callback: (payload) => {\n * console.log('未读消息数:', payload)\n * }\n * }\n * ]\n * })\n *\n * // 停止连接\n * MessageSocket.stop()\n *\n * // 动态注册回调\n * MessageSocket.registerCallbacks({\n * type: 'NEW_MESSAGE',\n * callback: (payload) => {\n * console.log('新消息:', payload)\n * }\n * })\n * ```\n */\nexport class MessageSocket {\n /** 默认配置 */\n private static readonly DEFAULT_CONFIG: MessageSocketConfig = {\n baseUrl: 'wss://dev-gateway.chinamarket.cn',\n path: '/api/user-web/websocket/messageServer',\n heartbeatInterval: 25000,\n maxReconnectAttempts: 10,\n reconnectDelay: 3000,\n reconnectDelayMax: 10000,\n autoReconnect: true,\n }\n\n /** WebSocket 客户端实例 */\n private static client: WebSocketClient | null = null\n\n /** 当前用户ID */\n private static currentUserId: string | null = null\n\n /** 当前token */\n private static currentToken: string | null = null\n\n /** 当前配置 */\n private static config: MessageSocketConfig = { ...MessageSocket.DEFAULT_CONFIG }\n\n /**\n * 配置 MessageSocket\n * @param config 配置选项\n */\n public static configure(config: Partial<MessageSocketConfig>): void {\n MessageSocket.config = { ...MessageSocket.config, ...config }\n }\n\n /**\n * 启动连接\n * @param options 启动选项\n */\n public static start(options: MessageSocketStartOptions): void {\n const { userId, token, callbacks = [] } = options\n\n if (!userId || !token) {\n console.warn('[MessageSocket] 缺少 userId 或 token,无法启动')\n return\n }\n\n // 检查是否可以复用现有连接\n const shouldReuse =\n MessageSocket.client &&\n MessageSocket.client.isConnected() &&\n MessageSocket.currentUserId === userId &&\n MessageSocket.currentToken === token\n\n if (shouldReuse) {\n console.log('[MessageSocket] 复用现有连接')\n // 重新注册回调\n callbacks.forEach((entry) => MessageSocket.registerCallbacks(entry))\n return\n }\n\n // 停止旧连接\n MessageSocket.stop()\n\n // 保存当前用户信息\n MessageSocket.currentUserId = userId\n MessageSocket.currentToken = token\n\n // 构建 WebSocket URL\n const { baseUrl, path, ...clientConfig } = MessageSocket.config\n const url = `${baseUrl}${path}/${userId}?token=${encodeURIComponent(token)}`\n\n // 创建新的 WebSocket 客户端\n MessageSocket.client = new WebSocketClient({\n ...clientConfig,\n url,\n })\n\n // 注册回调\n callbacks.forEach((entry) => MessageSocket.registerCallbacks(entry))\n\n // 连接\n MessageSocket.client.connect()\n }\n\n /**\n * 停止连接\n */\n public static stop(): void {\n if (MessageSocket.client) {\n MessageSocket.client.disconnect()\n MessageSocket.client.clearCallbacks()\n MessageSocket.client = null\n }\n\n MessageSocket.currentUserId = null\n MessageSocket.currentToken = null\n }\n\n /**\n * 注册消息回调\n * @param entry 回调配置\n */\n public static registerCallbacks<T = unknown>(entry: MessageCallbackEntry<T>): void {\n if (!entry) {\n console.warn('[MessageSocket] 注册回调失败,缺少 entry', entry)\n return\n }\n\n if (typeof entry !== 'object') {\n console.warn('[MessageSocket] 注册回调失败,entry 不是对象', entry)\n return\n }\n\n if (typeof entry.callback !== 'function') {\n console.warn('[MessageSocket] 注册回调失败,callback 不是函数', entry)\n return\n }\n\n if (typeof entry.type !== 'string') {\n console.warn('[MessageSocket] 注册回调失败,type 不是字符串', entry)\n return\n }\n\n if (!MessageSocket.client) {\n console.warn('[MessageSocket] WebSocket 客户端未初始化,无法注册回调')\n return\n }\n\n MessageSocket.client.on(entry)\n }\n\n /**\n * 取消注册消息回调\n * @param type 消息类型\n * @param callback 回调函数(可选)\n */\n public static unregisterCallbacks<T = unknown>(type: string, callback?: (data: T, message?: unknown) => void): void {\n if (!MessageSocket.client) {\n return\n }\n\n MessageSocket.client.off(type, callback)\n }\n\n /**\n * 发送消息\n * @param data 消息数据\n */\n public static send(data: string | object): void {\n if (!MessageSocket.client) {\n console.warn('[MessageSocket] WebSocket 客户端未初始化,无法发送消息')\n return\n }\n\n MessageSocket.client.send(data)\n }\n\n /**\n * 获取连接状态\n */\n public static getReadyState(): number {\n return MessageSocket.client?.getReadyState() ?? WebSocket.CLOSED\n }\n\n /**\n * 是否已连接\n */\n public static isConnected(): boolean {\n return MessageSocket.client?.isConnected() ?? false\n }\n\n /**\n * 获取当前用户ID\n */\n public static getCurrentUserId(): string | null {\n return MessageSocket.currentUserId\n }\n\n /**\n * 获取当前token\n */\n public static getCurrentToken(): string | null {\n return MessageSocket.currentToken\n }\n}\n"],"names":["WebSocketClient","constructor","config","this","socket","heartbeatTimer","reconnectTimer","callbackList","currentUrl","reconnectAttempts","manualClose","DEFAULT_CONFIG","updateConfig","connect","url","targetUrl","WebSocket","onopen","console","log","startHeartbeat","onOpen","onmessage","event","handleIncoming","data","onclose","code","reason","stopHeartbeat","onClose","autoReconnect","scheduleReconnect","onerror","error","onError","maxReconnectAttempts","warn","delay","Math","min","reconnectDelay","reconnectDelayMax","window","setTimeout","disconnect","clearTimeout","close","send","readyState","OPEN","message","JSON","stringify","parse","type","filter","entry","forEach","callback","onMessage","setInterval","heartbeatData","heartbeatMessage","heartbeatInterval","clearInterval","on","typeOrEntry","push","off","clearCallbacks","getReadyState","CLOSED","isConnected","_event","_message","timestamp","Date","now","MessageSocket","configure","start","options","userId","token","callbacks","client","currentUserId","currentToken","registerCallbacks","stop","baseUrl","path","clientConfig","encodeURIComponent","unregisterCallbacks","getCurrentUserId","getCurrentToken"],"mappings":"MAqDaA,EA6CX,WAAAC,CAAYC,EAA0B,IA3C5BC,KAAAC,OAA2B,KAG3BD,KAAAE,eAAgC,KAGhCF,KAAAG,eAAgC,KAGhCH,KAAAI,aAAgD,GAGhDJ,KAAAK,WAA4B,KAM5BL,KAAAM,kBAAoB,EAGpBN,KAAAO,aAAc,EAuBtBP,KAAKD,OAAS,IAAKF,EAAgBW,kBAAmBT,EACxD,CAMO,YAAAU,CAAaV,GAClBC,KAAKD,OAAS,IAAKC,KAAKD,UAAWA,EACrC,CAMO,OAAAW,CAAQC,GACb,MAAMC,EAAYD,GAAOX,KAAKD,OAAOY,IACrC,GAAKC,EAAL,CAKAZ,KAAKK,WAAaO,EAClBZ,KAAKO,aAAc,EAEnB,IACEP,KAAKC,OAAS,IAAIY,UAAUD,GAE5BZ,KAAKC,OAAOa,OAAS,KACnBC,QAAQC,IAAI,0BACZhB,KAAKM,kBAAoB,EACzBN,KAAKiB,iBACLjB,KAAKkB,UAGPlB,KAAKC,OAAOkB,UAAaC,IACvBpB,KAAKqB,eAAeD,EAAME,OAG5BtB,KAAKC,OAAOsB,QAAWH,IACrBL,QAAQC,IAAI,yBAA0BI,EAAMI,KAAMJ,EAAMK,QACxDzB,KAAK0B,gBACL1B,KAAK2B,QAAQP,IAERpB,KAAKO,aAAeP,KAAKD,OAAO6B,eACnC5B,KAAK6B,qBAIT7B,KAAKC,OAAO6B,QAAWV,IACrBL,QAAQgB,MAAM,yBAA0BX,GACxCpB,KAAK0B,gBACL1B,KAAKgC,QAAQZ,GAEjB,CAAE,MAAOW,GACPhB,QAAQgB,MAAM,yBAA0BA,GACpC/B,KAAKD,OAAO6B,gBAAkB5B,KAAKO,aACrCP,KAAK6B,mBAET,CAvCA,MAFEd,QAAQgB,MAAM,qCA0ClB,CAKU,iBAAAF,GACR,GAAI7B,KAAKM,mBAAqBN,KAAKD,OAAOkC,uBAAyBjC,KAAKK,YAAcL,KAAKO,YAIzF,YAHIP,KAAKM,mBAAqBN,KAAKD,OAAOkC,sBACxClB,QAAQmB,KAAK,gCAKjBlC,KAAKM,mBAAqB,EAC1B,MAAM6B,EAAQC,KAAKC,IAAIrC,KAAKD,OAAOuC,eAAiBtC,KAAKM,kBAAmBN,KAAKD,OAAOwC,mBAExFxB,QAAQC,IAAI,wBAAwBmB,YAAgBnC,KAAKM,yBAEzDN,KAAKG,eAAiBqC,OAAOC,WAAW,KACtCzC,KAAKU,QAAQV,KAAKK,aACjB8B,EACL,CAKO,UAAAO,GACL1C,KAAKO,aAAc,EACnBP,KAAK0B,gBAED1B,KAAKG,iBACPwC,aAAa3C,KAAKG,gBAClBH,KAAKG,eAAiB,MAGpBH,KAAKC,SACPD,KAAKC,OAAO2C,QACZ5C,KAAKC,OAAS,MAGhBD,KAAKK,WAAa,KAClBL,KAAKM,kBAAoB,CAC3B,CAMO,IAAAuC,CAAKvB,GACV,IAAKtB,KAAKC,QAAUD,KAAKC,OAAO6C,aAAejC,UAAUkC,KAEvD,YADAhC,QAAQmB,KAAK,0CAIf,MAAMc,EAA0B,iBAAT1B,EAAoBA,EAAO2B,KAAKC,UAAU5B,GACjEtB,KAAKC,OAAO4C,KAAKG,EACnB,CAMU,cAAA3B,CAAeC,GACvB,IAAKA,EAAM,OAEX,IAAI0B,EACJ,IACEA,EAAUC,KAAKE,MAAM7B,EACvB,CAAE,MAEA,YADAP,QAAQmB,KAAK,2BAA4BZ,EAE3C,CAEA,IAAK0B,GAASI,KACZ,OAIcpD,KAAKI,aAAaiD,OAAQC,GAAUA,EAAMF,OAASJ,EAAQI,MACnEG,QAAQ,EAAGC,eACjB,IACEA,EAASR,EAAQ1B,KAAM0B,EACzB,CAAE,MAAOjB,GACPhB,QAAQgB,MAAM,2BAA4BA,EAC5C,IAIF/B,KAAKyD,UAAUT,EACjB,CAKU,cAAA/B,GACRjB,KAAK0B,gBAEA1B,KAAKC,QAAUD,KAAKC,OAAO6C,aAAejC,UAAUkC,OAIzD/C,KAAKE,eAAiBsC,OAAOkB,YAAY,KACvC,IAAK1D,KAAKC,QAAUD,KAAKC,OAAO6C,aAAejC,UAAUkC,KACvD,OAGF,MAAMY,EAAgB3D,KAAKD,OAAO6D,mBAClC5D,KAAK6C,KAAKc,IACT3D,KAAKD,OAAO8D,mBACjB,CAKU,aAAAnC,GACJ1B,KAAKE,iBACP4D,cAAc9D,KAAKE,gBACnBF,KAAKE,eAAiB,KAE1B,CAQO,EAAA6D,CAAgBC,EAA+CR,GACpE,MAAMF,EACmB,iBAAhBU,EAA2B,CAAEZ,KAAMY,EAAaR,SAAUA,GAAcQ,EAE5EV,EAAMF,MAAkC,mBAAnBE,EAAME,SAKhCxD,KAAKI,aAAa6D,KAAKX,GAJrBvC,QAAQmB,KAAK,4BAA6BoB,EAK9C,CAOO,GAAAY,CAAiBd,EAAcI,GAElCxD,KAAKI,aADHoD,EACkBxD,KAAKI,aAAaiD,OAAQC,KAAYA,EAAMF,OAASA,GAAQE,EAAME,WAAaA,IAEhFxD,KAAKI,aAAaiD,OAAQC,GAAUA,EAAMF,OAASA,EAE3E,CAKO,cAAAe,GACLnE,KAAKI,aAAe,EACtB,CAKO,aAAAgE,GACL,OAAOpE,KAAKC,QAAQ6C,YAAcjC,UAAUwD,MAC9C,CAKO,WAAAC,GACL,OAAOtE,KAAKC,QAAQ6C,aAAejC,UAAUkC,IAC/C,CAOU,MAAA7B,GAEV,CAKU,OAAAS,CAAQ4C,GAElB,CAKU,OAAAvC,CAAQuC,GAElB,CAKU,SAAAd,CAAUe,GAEpB,EAvR0B3E,EAAAW,eAA4C,CACpEG,IAAK,GACLkD,kBAAmB,KACnB5B,qBAAsB,GACtBK,eAAgB,IAChBC,kBAAmB,IACnBX,eAAe,EACfgC,iBAAkB,KAAA,CAChBR,KAAM,OACNqB,UAAWC,KAAKC,eCjCTC,EA4BJ,gBAAOC,CAAU9E,GACtB6E,EAAc7E,OAAS,IAAK6E,EAAc7E,UAAWA,EACvD,CAMO,YAAO+E,CAAMC,GAClB,MAAMC,OAAEA,EAAMC,MAAEA,EAAKC,UAAEA,EAAY,IAAOH,EAE1C,IAAKC,IAAWC,EAEd,YADAlE,QAAQmB,KAAK,0CAWf,GALE0C,EAAcO,QACdP,EAAcO,OAAOb,eACrBM,EAAcQ,gBAAkBJ,GAChCJ,EAAcS,eAAiBJ,EAM/B,OAHAlE,QAAQC,IAAI,+BAEZkE,EAAU3B,QAASD,GAAUsB,EAAcU,kBAAkBhC,IAK/DsB,EAAcW,OAGdX,EAAcQ,cAAgBJ,EAC9BJ,EAAcS,aAAeJ,EAG7B,MAAMO,QAAEA,EAAOC,KAAEA,KAASC,GAAiBd,EAAc7E,OACnDY,EAAM,GAAG6E,IAAUC,KAAQT,WAAgBW,mBAAmBV,KAGpEL,EAAcO,OAAS,IAAItF,EAAgB,IACtC6F,EACH/E,QAIFuE,EAAU3B,QAASD,GAAUsB,EAAcU,kBAAkBhC,IAG7DsB,EAAcO,OAAOzE,SACvB,CAKO,WAAO6E,GACRX,EAAcO,SAChBP,EAAcO,OAAOzC,aACrBkC,EAAcO,OAAOhB,iBACrBS,EAAcO,OAAS,MAGzBP,EAAcQ,cAAgB,KAC9BR,EAAcS,aAAe,IAC/B,CAMO,wBAAOC,CAA+BhC,GACtCA,EAKgB,iBAAVA,EAKmB,mBAAnBA,EAAME,SAKS,iBAAfF,EAAMF,KAKZwB,EAAcO,OAKnBP,EAAcO,OAAOpB,GAAGT,GAJtBvC,QAAQmB,KAAK,4CALbnB,QAAQmB,KAAK,oCAAqCoB,GALlDvC,QAAQmB,KAAK,uCAAwCoB,GALrDvC,QAAQmB,KAAK,oCAAqCoB,GALlDvC,QAAQmB,KAAK,kCAAmCoB,EAyBpD,CAOO,0BAAOsC,CAAiCxC,EAAcI,GACtDoB,EAAcO,QAInBP,EAAcO,OAAOjB,IAAId,EAAMI,EACjC,CAMO,WAAOX,CAAKvB,GACZsD,EAAcO,OAKnBP,EAAcO,OAAOtC,KAAKvB,GAJxBP,QAAQmB,KAAK,2CAKjB,CAKO,oBAAOkC,GACZ,OAAOQ,EAAcO,QAAQf,iBAAmBvD,UAAUwD,MAC5D,CAKO,kBAAOC,GACZ,OAAOM,EAAcO,QAAQb,gBAAiB,CAChD,CAKO,uBAAOuB,GACZ,OAAOjB,EAAcQ,aACvB,CAKO,sBAAOU,GACZ,OAAOlB,EAAcS,YACvB,EAnLwBT,EAAApE,eAAsC,CAC5DgF,QAAS,mCACTC,KAAM,wCACN5B,kBAAmB,KACnB5B,qBAAsB,GACtBK,eAAgB,IAChBC,kBAAmB,IACnBX,eAAe,GAIFgD,EAAAO,OAAiC,KAGjCP,EAAAQ,cAA+B,KAG/BR,EAAAS,aAA8B,KAG9BT,EAAA7E,OAA8B,IAAK6E,EAAcpE"}
|
package/package.json
CHANGED
|
@@ -1,11 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brewer/dj-common",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.3",
|
|
4
4
|
"description": "多端通用的公共方法库,支持 PC、H5、APP 等平台",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.cjs.js",
|
|
7
7
|
"module": "dist/index.esm.js",
|
|
8
8
|
"types": "dist/index.d.ts",
|
|
9
|
+
"files": [
|
|
10
|
+
"dist",
|
|
11
|
+
"README.md",
|
|
12
|
+
"LICENSE"
|
|
13
|
+
],
|
|
9
14
|
"exports": {
|
|
10
15
|
".": {
|
|
11
16
|
"import": "./dist/index.esm.js",
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"permissions": {
|
|
3
|
-
"allow": [
|
|
4
|
-
"Bash(npm install:*)",
|
|
5
|
-
"Bash(npm run build:*)",
|
|
6
|
-
"Bash(npx husky init)",
|
|
7
|
-
"Bash(git init:*)",
|
|
8
|
-
"Bash(git add:*)",
|
|
9
|
-
"Bash(git commit:*)",
|
|
10
|
-
"Bash(npx eslint:*)",
|
|
11
|
-
"Bash(npx lint-staged:*)",
|
|
12
|
-
"Bash(npx prettier:*)",
|
|
13
|
-
"Bash(git reset:*)",
|
|
14
|
-
"Bash(npm run release:dry-run:*)",
|
|
15
|
-
"Bash(npm token:*)",
|
|
16
|
-
"Bash(node:*)",
|
|
17
|
-
"Bash(npm whoami:*)",
|
|
18
|
-
"Bash(git checkout:*)",
|
|
19
|
-
"Bash(npm run lint)",
|
|
20
|
-
"Bash(npx standard-version --prerelease beta)",
|
|
21
|
-
"Bash(npm publish:*)",
|
|
22
|
-
"Bash(npm view:*)",
|
|
23
|
-
"Bash(git push:*)",
|
|
24
|
-
"Bash(ls:*)",
|
|
25
|
-
"Bash(git tag:*)"
|
|
26
|
-
]
|
|
27
|
-
}
|
|
28
|
-
}
|
package/.gitattributes
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# 强制所有文本文件使用 LF 换行符
|
|
2
|
-
* text=auto eol=lf
|
|
3
|
-
|
|
4
|
-
# 明确指定文件类型
|
|
5
|
-
*.ts text eol=lf
|
|
6
|
-
*.js text eol=lf
|
|
7
|
-
*.json text eol=lf
|
|
8
|
-
*.md text eol=lf
|
|
9
|
-
*.yml text eol=lf
|
|
10
|
-
*.yaml text eol=lf
|
|
11
|
-
|
|
12
|
-
# 二进制文件
|
|
13
|
-
*.png binary
|
|
14
|
-
*.jpg binary
|
|
15
|
-
*.jpeg binary
|
|
16
|
-
*.gif binary
|
|
17
|
-
*.ico binary
|
|
18
|
-
*.woff binary
|
|
19
|
-
*.woff2 binary
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
name: Release
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
push:
|
|
5
|
-
tags:
|
|
6
|
-
- 'v*' # 当推送 v 开头的 tag 时触发,如 v1.0.0
|
|
7
|
-
|
|
8
|
-
jobs:
|
|
9
|
-
publish:
|
|
10
|
-
runs-on: ubuntu-latest
|
|
11
|
-
|
|
12
|
-
permissions:
|
|
13
|
-
contents: write # 需要写权限来创建 release
|
|
14
|
-
|
|
15
|
-
steps:
|
|
16
|
-
- name: 检出代码
|
|
17
|
-
uses: actions/checkout@v4
|
|
18
|
-
with:
|
|
19
|
-
fetch-depth: 0 # 获取完整的 git 历史,用于生成 CHANGELOG
|
|
20
|
-
|
|
21
|
-
- name: 设置 Node.js
|
|
22
|
-
uses: actions/setup-node@v4
|
|
23
|
-
with:
|
|
24
|
-
node-version: '22.x'
|
|
25
|
-
registry-url: 'https://registry.npmjs.org'
|
|
26
|
-
cache: 'npm'
|
|
27
|
-
|
|
28
|
-
- name: 指定 npm registry 为官方源
|
|
29
|
-
run: npm config set registry https://registry.npmjs.org
|
|
30
|
-
|
|
31
|
-
- name: 安装依赖
|
|
32
|
-
run: npm install
|
|
33
|
-
|
|
34
|
-
- name: 运行 ESLint 检查
|
|
35
|
-
run: npm run lint
|
|
36
|
-
|
|
37
|
-
- name: 构建项目
|
|
38
|
-
run: npm run build
|
|
39
|
-
|
|
40
|
-
- name: 发布到 NPM
|
|
41
|
-
run: |
|
|
42
|
-
if [[ ${{ github.ref }} == refs/tags/*-beta.* ]]; then
|
|
43
|
-
npm publish --tag beta --access public
|
|
44
|
-
else
|
|
45
|
-
npm publish --access public
|
|
46
|
-
fi
|
|
47
|
-
env:
|
|
48
|
-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
49
|
-
|
|
50
|
-
- name: 创建 GitHub Release
|
|
51
|
-
uses: softprops/action-gh-release@v1
|
|
52
|
-
with:
|
|
53
|
-
body_path: CHANGELOG.md
|
|
54
|
-
generate_release_notes: true
|
|
55
|
-
env:
|
|
56
|
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
package/.husky/commit-msg
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
npx --no -- commitlint --edit $1
|
package/.husky/pre-commit
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
npx lint-staged
|
package/.lintstagedrc.json
DELETED
package/.prettierignore
DELETED
package/.prettierrc
DELETED
package/.versionrc.json
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"header": "# 更新日志\n\n所有重要的变更都将记录在此文件中。\n\n",
|
|
3
|
-
"types": [
|
|
4
|
-
{ "type": "feat", "section": "✨ 新功能" },
|
|
5
|
-
{ "type": "fix", "section": "🐛 Bug 修复" },
|
|
6
|
-
{ "type": "perf", "section": "⚡ 性能优化" },
|
|
7
|
-
{ "type": "refactor", "section": "♻️ 代码重构" },
|
|
8
|
-
{ "type": "docs", "section": "📝 文档更新" },
|
|
9
|
-
{ "type": "style", "section": "💄 代码格式" },
|
|
10
|
-
{ "type": "test", "section": "✅ 测试" },
|
|
11
|
-
{ "type": "build", "section": "📦 构建" },
|
|
12
|
-
{ "type": "ci", "section": "👷 CI" },
|
|
13
|
-
{ "type": "chore", "section": "🔧 其他" }
|
|
14
|
-
],
|
|
15
|
-
"skip": {
|
|
16
|
-
"bump": false,
|
|
17
|
-
"changelog": false,
|
|
18
|
-
"commit": false,
|
|
19
|
-
"tag": false
|
|
20
|
-
},
|
|
21
|
-
"releaseCommitMessageFormat": "chore(release): {{currentTag}} [skip ci]"
|
|
22
|
-
}
|
package/commitlint.config.cjs
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
module.exports = {
|
|
2
|
-
extends: ['@commitlint/config-conventional'],
|
|
3
|
-
rules: {
|
|
4
|
-
'type-enum': [
|
|
5
|
-
2,
|
|
6
|
-
'always',
|
|
7
|
-
[
|
|
8
|
-
'feat', // 新功能
|
|
9
|
-
'fix', // 修复 bug
|
|
10
|
-
'docs', // 文档更新
|
|
11
|
-
'style', // 代码格式(不影响代码运行的变动)
|
|
12
|
-
'refactor', // 重构(既不是新增功能,也不是修复 bug)
|
|
13
|
-
'perf', // 性能优化
|
|
14
|
-
'test', // 增加测试
|
|
15
|
-
'build', // 构建过程或辅助工具的变动
|
|
16
|
-
'ci', // CI 配置文件和脚本的变动
|
|
17
|
-
'chore', // 其他不修改 src 或 test 的变动
|
|
18
|
-
'revert', // 回退
|
|
19
|
-
],
|
|
20
|
-
],
|
|
21
|
-
'subject-case': [0], // 不限制主题大小写
|
|
22
|
-
},
|
|
23
|
-
}
|
package/docs/README.md
DELETED
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
# @brewer/dj-common API 文档
|
|
2
|
-
|
|
3
|
-
> 多端通用的公共方法库 API 文档
|
|
4
|
-
|
|
5
|
-
## 快速开始
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install @brewer/dj-common
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## 模块列表
|
|
12
|
-
|
|
13
|
-
### WebSocket 相关
|
|
14
|
-
|
|
15
|
-
- [WebSocketClient](./api/WebSocketClient.md) - 通用 WebSocket 客户端基类
|
|
16
|
-
- [MessageSocket](./api/MessageSocket.md) - 业务层 WebSocket 封装
|
|
17
|
-
|
|
18
|
-
## 使用指南
|
|
19
|
-
|
|
20
|
-
### 基础使用
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { WebSocketClient } from '@brewer/dj-common'
|
|
24
|
-
|
|
25
|
-
const client = new WebSocketClient({
|
|
26
|
-
heartbeatInterval: 30000,
|
|
27
|
-
autoReconnect: true,
|
|
28
|
-
})
|
|
29
|
-
|
|
30
|
-
client.on('message', (data) => {
|
|
31
|
-
console.log('收到消息:', data)
|
|
32
|
-
})
|
|
33
|
-
|
|
34
|
-
client.connect('ws://localhost:8080')
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### 类型安全
|
|
38
|
-
|
|
39
|
-
所有模块都提供完整的 TypeScript 类型定义:
|
|
40
|
-
|
|
41
|
-
```typescript
|
|
42
|
-
import { WebSocketClient, WebSocketConfig, MessageData } from '@brewer/dj-common'
|
|
43
|
-
|
|
44
|
-
const config: WebSocketConfig = {
|
|
45
|
-
heartbeatInterval: 30000,
|
|
46
|
-
maxReconnectAttempts: 10,
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
const client = new WebSocketClient(config)
|
|
50
|
-
|
|
51
|
-
client.on<{ content: string }>('message', (data) => {
|
|
52
|
-
// data 类型为 { content: string }
|
|
53
|
-
console.log(data.content)
|
|
54
|
-
})
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## 特性
|
|
58
|
-
|
|
59
|
-
- 📘 **TypeScript** - 完整的类型定义
|
|
60
|
-
- 📦 **多格式支持** - ESM 和 CommonJS
|
|
61
|
-
- 🔌 **按需引入** - Tree-shaking 支持
|
|
62
|
-
- 🔧 **可配置** - 灵活的配置选项
|
|
63
|
-
- 🔄 **自动重连** - 智能重连机制
|
|
64
|
-
- 💓 **心跳检测** - 保持连接活性
|
|
65
|
-
|
|
66
|
-
## 相关链接
|
|
67
|
-
|
|
68
|
-
- [GitHub 仓库](https://github.com/beerui/dj-common)
|
|
69
|
-
- [NPM 包](https://www.npmjs.com/package/@brewer/dj-common)
|
|
70
|
-
- [更新日志](../CHANGELOG.md)
|
|
71
|
-
- [开发指南](../DEVELOPMENT.md)
|
|
72
|
-
- [测试指南](../TESTING.md)
|
|
73
|
-
|
|
74
|
-
## 贡献
|
|
75
|
-
|
|
76
|
-
欢迎贡献代码!请查看 [开发指南](../DEVELOPMENT.md) 了解如何参与开发。
|
|
77
|
-
|
|
78
|
-
## 许可证
|
|
79
|
-
|
|
80
|
-
MIT © BeerUi
|
package/eslint.config.js
DELETED
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import js from '@eslint/js'
|
|
2
|
-
import typescript from '@typescript-eslint/eslint-plugin'
|
|
3
|
-
import typescriptParser from '@typescript-eslint/parser'
|
|
4
|
-
import prettier from 'eslint-plugin-prettier'
|
|
5
|
-
import prettierConfig from 'eslint-config-prettier'
|
|
6
|
-
|
|
7
|
-
export default [
|
|
8
|
-
// 全局忽略文件
|
|
9
|
-
{
|
|
10
|
-
ignores: ['node_modules/**', 'dist/**', 'examples/**'],
|
|
11
|
-
},
|
|
12
|
-
|
|
13
|
-
// JavaScript/TypeScript 通用配置
|
|
14
|
-
{
|
|
15
|
-
files: ['**/*.{js,mjs,cjs,ts}'],
|
|
16
|
-
ignores: ['**/*.config.{js,mjs,cjs}'], // 忽略配置文件
|
|
17
|
-
languageOptions: {
|
|
18
|
-
ecmaVersion: 'latest',
|
|
19
|
-
sourceType: 'module',
|
|
20
|
-
parser: typescriptParser,
|
|
21
|
-
parserOptions: {
|
|
22
|
-
project: './tsconfig.json',
|
|
23
|
-
},
|
|
24
|
-
globals: {
|
|
25
|
-
// 浏览器环境
|
|
26
|
-
window: 'readonly',
|
|
27
|
-
document: 'readonly',
|
|
28
|
-
navigator: 'readonly',
|
|
29
|
-
// Node.js 环境
|
|
30
|
-
process: 'readonly',
|
|
31
|
-
__dirname: 'readonly',
|
|
32
|
-
__filename: 'readonly',
|
|
33
|
-
module: 'readonly',
|
|
34
|
-
require: 'readonly',
|
|
35
|
-
exports: 'writable',
|
|
36
|
-
global: 'readonly',
|
|
37
|
-
// ES2021
|
|
38
|
-
console: 'readonly',
|
|
39
|
-
// 定时器相关(浏览器和 Node.js 都有)
|
|
40
|
-
setTimeout: 'readonly',
|
|
41
|
-
clearTimeout: 'readonly',
|
|
42
|
-
setInterval: 'readonly',
|
|
43
|
-
clearInterval: 'readonly',
|
|
44
|
-
setImmediate: 'readonly',
|
|
45
|
-
clearImmediate: 'readonly',
|
|
46
|
-
},
|
|
47
|
-
},
|
|
48
|
-
plugins: {
|
|
49
|
-
'@typescript-eslint': typescript,
|
|
50
|
-
prettier: prettier,
|
|
51
|
-
},
|
|
52
|
-
rules: {
|
|
53
|
-
// ESLint 推荐规则
|
|
54
|
-
...js.configs.recommended.rules,
|
|
55
|
-
// TypeScript 推荐规则
|
|
56
|
-
...typescript.configs.recommended.rules,
|
|
57
|
-
// Prettier 配置
|
|
58
|
-
...prettierConfig.rules,
|
|
59
|
-
|
|
60
|
-
// 自定义规则
|
|
61
|
-
'no-console': 'off',
|
|
62
|
-
'no-unused-vars': 'off',
|
|
63
|
-
'@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
|
|
64
|
-
'@typescript-eslint/no-explicit-any': 'warn',
|
|
65
|
-
'prettier/prettier': 'warn',
|
|
66
|
-
},
|
|
67
|
-
},
|
|
68
|
-
|
|
69
|
-
// .js 和 .cjs 文件特殊配置
|
|
70
|
-
{
|
|
71
|
-
files: ['**/*.{js,cjs}'],
|
|
72
|
-
rules: {
|
|
73
|
-
'@typescript-eslint/no-var-requires': 'off',
|
|
74
|
-
},
|
|
75
|
-
},
|
|
76
|
-
]
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# dj-common 测试示例
|
|
2
|
-
|
|
3
|
-
这是一个简单的测试项目,用于验证 dj-common 包是否正常工作。
|
|
4
|
-
|
|
5
|
-
## 运行测试
|
|
6
|
-
|
|
7
|
-
在项目根目录(dj-common)执行:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
# 1. 构建项目
|
|
11
|
-
npm run build
|
|
12
|
-
|
|
13
|
-
# 2. 运行测试
|
|
14
|
-
node examples/basic-test/index.js
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## 测试内容
|
|
18
|
-
|
|
19
|
-
- ✅ 创建 WebSocketClient 实例
|
|
20
|
-
- ✅ 注册消息回调
|
|
21
|
-
- ✅ 检查模块导出
|
|
22
|
-
|
|
23
|
-
## 使用 npm link 测试
|
|
24
|
-
|
|
25
|
-
如果想在其他项目中测试:
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
# 在 dj-common 根目录
|
|
29
|
-
npm link
|
|
30
|
-
|
|
31
|
-
# 在其他项目中
|
|
32
|
-
npm link @brewer/dj-common
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
然后就可以像正常安装的包一样使用了:
|
|
36
|
-
|
|
37
|
-
```javascript
|
|
38
|
-
import { WebSocketClient } from '@brewer/dj-common'
|
|
39
|
-
```
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
// 基础测试示例
|
|
2
|
-
import { WebSocketClient } from '../../dist/index.esm.js'
|
|
3
|
-
|
|
4
|
-
console.log('🧪 开始测试 dj-common...\n')
|
|
5
|
-
|
|
6
|
-
// 测试 1: 创建实例
|
|
7
|
-
console.log('✓ 测试 1: 创建 WebSocketClient 实例')
|
|
8
|
-
try {
|
|
9
|
-
const client = new WebSocketClient({
|
|
10
|
-
heartbeatInterval: 30000,
|
|
11
|
-
maxReconnectAttempts: 5,
|
|
12
|
-
autoReconnect: true,
|
|
13
|
-
})
|
|
14
|
-
console.log(' ✅ 实例创建成功')
|
|
15
|
-
console.log(' 配置:', {
|
|
16
|
-
heartbeatInterval: 30000,
|
|
17
|
-
maxReconnectAttempts: 5,
|
|
18
|
-
autoReconnect: true,
|
|
19
|
-
})
|
|
20
|
-
} catch (error) {
|
|
21
|
-
console.error(' ❌ 实例创建失败:', error.message)
|
|
22
|
-
process.exit(1)
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
// 测试 2: 注册消息回调
|
|
26
|
-
console.log('\n✓ 测试 2: 注册消息回调')
|
|
27
|
-
try {
|
|
28
|
-
const client = new WebSocketClient()
|
|
29
|
-
client.on('test-message', (data) => {
|
|
30
|
-
console.log('收到消息:', data)
|
|
31
|
-
})
|
|
32
|
-
console.log(' ✅ 消息回调注册成功')
|
|
33
|
-
} catch (error) {
|
|
34
|
-
console.error(' ❌ 消息回调注册失败:', error.message)
|
|
35
|
-
process.exit(1)
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
// 测试 3: 检查类型导出
|
|
39
|
-
console.log('\n✓ 测试 3: 检查导出')
|
|
40
|
-
try {
|
|
41
|
-
console.log(' ✅ WebSocketClient 已导出')
|
|
42
|
-
console.log(' 类型:', typeof WebSocketClient)
|
|
43
|
-
} catch (error) {
|
|
44
|
-
console.error(' ❌ 导出检查失败:', error.message)
|
|
45
|
-
process.exit(1)
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
console.log('\n🎉 所有测试通过!\n')
|
|
49
|
-
console.log('💡 提示:')
|
|
50
|
-
console.log(' - 要测试 WebSocket 连接,需要启动一个 WebSocket 服务器')
|
|
51
|
-
console.log(' - 然后取消注释下面的连接代码\n')
|
|
52
|
-
|
|
53
|
-
// 实际连接测试(需要 WebSocket 服务器)
|
|
54
|
-
// console.log('✓ 测试 4: 连接 WebSocket 服务器')
|
|
55
|
-
// const client = new WebSocketClient()
|
|
56
|
-
// client.connect('ws://localhost:8080')
|