@zjw-jszn/shared-imsdk 1.0.9 → 1.0.10

package/README.md

@@ -51,6 +51,7 @@ const config: IMSDKConfig = {
     siteId: '6',
   },
   ws: {
+    url: 'wss://aox.api.orchiport.asia',
     controller: 'Site',
     platform: 'site',
   },
@@ -66,12 +67,27 @@ controls.show()
 | --- | --- |
 | `phone` | 首次鉴权必填（无 token 场景） |
 | `api.baseURL` | HTTP 基础地址（默认 `https://aox.api.orchiport.asia`） |
+| `api.resourceBaseURL` | 资源基础地址（默认 `https://resource.api.orchiport.asia`，用于补全上传图片相对路径） |
+| `api.uploadURL` | 上传接口地址（默认 `https://resource.api.orchiport.asia/system/uploadImage`） |
 | `api.prefix` | API 前缀，`shared` 模式下必须显式传入 |
 | `api.siteId` | 站点 ID，用于鉴权后 WS 连接 |
+| `ws.url` | WebSocket 地址（可选；未传时会基于 `api.baseURL` 自动推导） |
 | `ws.controller` | WebSocket 控制器，必须显式传入 |
 | `ws.platform` | 平台标识，必须为小写，且等于 `controller.toLowerCase()` |
+| `ws.reconnectInterval` | 自动重连间隔（毫秒，默认 `3000`） |
+| `ws.heartbeatInterval` | 心跳间隔（毫秒，默认 `3000`） |
+| `ws.maxReconnectAttempts` | 最大自动重连次数（默认 `5`） |
+| `ws.connectTimeout` | 连接超时（毫秒，默认 `30000`） |
+| `ws.traceEnabled` | 是否输出 WS Trace 日志（默认 `false`） |
+| `ws.protocol.controller` | 协议控制器（可选，默认跟随 `ws.controller`） |
+| `ws.protocol.action.send` | 发送消息动作名映射（默认 `send`） |
+| `ws.protocol.action.msgRead` | 已读动作名映射（默认 `msgRead`） |
+| `ws.protocol.action.onConnect` | 上线动作名映射（默认 `onConnect`） |
+| `ws.protocol.action.offLine` | 离线动作名映射（默认 `offLine`） |
+| `ws.protocol.action.heartbeat` | 心跳动作名映射（默认 `heartbeat`） |
 | `sound` | 消息提示音开关与地址 |
 | `auth.authorizationPayload` | 鉴权扩展参数透传 |
+| `chat.platformServicePhone` | 平台客服默认手机号 |
 | `runtimeApi` | 运行时扩展接口（`getChatConfig/closeSession/getCustomerChatList`） |
 
 ## 常用导出
@@ -96,8 +112,10 @@ import {
 - 缺少 `api.prefix` 会抛错。
 - 缺少 `ws.controller` 或 `ws.platform` 会抛错。
 - `ws.platform` 必须小写，且需与 `ws.controller.toLowerCase()` 一致。
+- 未传 `ws.url` 时，SDK 会优先使用 `api.baseURL` 推导 WS 地址（`https -> wss`，`http -> ws`）。
 - 首次初始化且无 token 时，必须传 `phone`。
 - 已以某模式初始化后，不允许在同页面切换到另一模式。
+- 调用 `getChatList` 且参数为 `friend_type=4` + `customeronly=1/true` 时，如未传 `phone`，会自动回落到 `chat.platformServicePhone`。
 
 ## 样式
 

package/dist/api/index.d.ts

@@ -152,6 +152,8 @@ export declare function getChatRewordBySession(data: {
  * @param data.session_id - 会话ID
  * @param data.user_type - 用户类型
  * @param data.msg_type - 消息类型
+ * @param data.friend_type - 对话对象类型
+ * @param data.customeronly - 平台客服模式标记（1/true）
  */
 export declare function getChatList(data: {
     page: number;
@@ -161,4 +163,6 @@ export declare function getChatList(data: {
     session_id?: string;
     user_type?: number;
     msg_type?: number;
+    friend_type?: number;
+    customeronly?: number | string | boolean;
 }): Promise<PageResponse<Message>>;

package/dist/config/index.d.ts

@@ -4,6 +4,7 @@
 export interface SDKConfig {
     api: {
         baseURL: string;
+        resourceBaseURL: string;
         prefix: string;
         uploadURL: string;
         signKey: string;
@@ -14,8 +15,25 @@ export interface SDKConfig {
         userType?: number;
     };
     ws: {
+        url: string;
         controller: string;
         platform: string;
+        reconnectInterval: number;
+        heartbeatInterval: number;
+        maxReconnectAttempts: number;
+        connectTimeout: number;
+        traceEnabled: boolean;
+        protocol: {
+            controller: string;
+            action: {
+                send: string;
+                msgRead: string;
+                onConnect: string;
+                offLine: string;
+                heartbeat: string;
+            };
+            heartbeatSignals: string[];
+        };
     };
     sound?: {
         enabled: boolean;
@@ -24,6 +42,9 @@ export interface SDKConfig {
     auth: {
         authorizationPayload?: Record<string, unknown>;
     };
+    chat: {
+        platformServicePhone: string;
+    };
     runtimeApi: {
         getChatConfig?: () => Promise<{
             quick_receive?: string[] | string;
@@ -69,6 +90,29 @@ export declare function getWSController(): string;
  * 获取 WebSocket 平台标识
  */
 export declare function getWSPlatform(): string;
+/**
+ * 是否开启 WebSocket Trace 日志
+ */
+export declare function isWSTraceEnabled(): boolean;
+/**
+ * 获取 WebSocket 协议控制器（优先 protocol.controller）
+ */
+export declare function getWSProtocolController(): string;
+/**
+ * 获取 WebSocket 协议动作映射
+ */
+export declare function getWSProtocolAction(): {
+    send: string;
+    msgRead: string;
+    onConnect: string;
+    offLine: string;
+    heartbeat: string;
+};
+/**
+ * 获取 WebSocket 基础地址
+ * 优先级：ws.url > api.baseURL 推导 > 默认地址
+ */
+export declare function getWSBaseURL(): string;
 /**
  * 获取鉴权扩展参数（平台默认为空，门店可注入 username/avatar）
  */