customer-chat-sdk 1.3.5 → 1.3.6

package/README.md

@@ -252,14 +252,48 @@ interface ScreenshotMessageCallback {
 
 #### onIconClick(callback)
 
-设置图标点击回调
+设置图标点击回调（也可以在 init 中配置）
 
 ```typescript
+// 方式1: 使用函数式 API（default 导出）- 可以直接调用
+const CustomerSDK = await import('customer-chat-sdk')
+await CustomerSDK.default.init(config)
+CustomerSDK.default.onIconClick(() => {
+  openChatPopup()
+})
+
+// 方式2: 使用类（命名导出）- 在 init 中配置（推荐）
+const sdk = new CustomerSDK()
+await sdk.init(config, screenshotCallback, {
+  onIconClick: () => {
+    openChatPopup()
+  }
+})
+
+// 方式3: 使用类（命名导出）- 单独设置
+const sdk = new CustomerSDK()
+await sdk.init(config)
 sdk.onIconClick(() => {
   openChatPopup()
 })
 ```
 
+#### updateToken(token, screenshotCallback?, initCallback?)
+
+更新 token（用于用户登录/退出场景）
+
+```typescript
+// 更新 token（会自动重新初始化）
+await sdk.updateToken('new-token')
+
+// 更新 token 并更新回调
+await sdk.updateToken('new-token', {
+  sendData: (data) => { /* ... */ }
+}, {
+  onIconClick: () => { /* ... */ }
+})
+```
+
 #### showNotification(badgeCount, options?)
 
 显示通知
@@ -361,9 +395,20 @@ const initResult = await sdk.init({
   iconPosition: { x: 20, y: 80 },
   target: '#app'
 }, {
+  // 截图回调
   sendData: (data) => {
     // 处理截图数据
   }
+}, {
+  // 初始化回调（图标点击）
+  onIconClick: async () => {
+    openChatPopup()
+    // 启用截图
+    const config = await fetchScreenshotConfig()
+    if (config) {
+      sdk.triggerScreenshotConfig(JSON.stringify(config))
+    }
+  }
 })
 
 // 获取设备ID等信息
@@ -374,6 +419,16 @@ console.log('Referrer:', initResult.referrer)
 ### 2. 弹窗打开时启用截图
 
 ```typescript
+// 方式1: 在 init 中配置（推荐）
+await sdk.init(config, screenshotCallback, {
+  onIconClick: async () => {
+    openChatPopup()
+    const config = await fetchScreenshotConfig()
+    sdk.triggerScreenshotConfig(JSON.stringify(config))
+  }
+})
+
+// 方式2: 单独设置
 sdk.onIconClick(async () => {
   openChatPopup()
   const config = await fetchScreenshotConfig()
@@ -381,6 +436,13 @@ sdk.onIconClick(async () => {
 })
 ```
 
+### 2.1. 更新 token
+
+```typescript
+// 用户登录后更新 token
+await sdk.updateToken('new-token')
+```
+
 ### 3. 弹窗关闭时停止截图
 
 ```typescript
@@ -443,6 +505,94 @@ await sdk.init({
 4. **错误处理**：所有异步操作都应添加错误处理
 5. **CORS 问题**：如果遇到跨域问题，配置 `proxyUrl` 或调整 `corsMode`
 
+## 动态导入示例
+
+### 方式 1: 使用类（推荐）
+
+```typescript
+const initCustomerSDK = async () => {
+  // 动态导入
+  const mod = await import('customer-chat-sdk')
+  
+  // 获取 CustomerSDK 类（命名导出）
+  const { CustomerSDK } = mod
+  
+  // ✅ 重要：必须先实例化
+  const sdk = new CustomerSDK()
+
+  // 初始化（调用实例方法）
+  const initResult = await sdk.init({
+    debug: true,
+    iconPosition: { x: 20, y: 80 },
+    target: '#app'
+  }, {
+    sendData: (data) => {
+      // 处理截图数据
+    }
+  })
+
+  // 设置图标点击回调（调用实例方法）
+  sdk.onIconClick(() => {
+    openChatPopup()
+  })
+
+  return sdk
+}
+```
+
+### 方式 2: 使用函数式 API（default 导出）
+
+```typescript
+const initCustomerSDK = async () => {
+  // 动态导入
+  const mod = await import('customer-chat-sdk')
+  
+  // 获取 default 导出（函数式 API）
+  const SDK = mod.default
+  
+  // ✅ 直接调用函数（不需要实例化）
+  const initResult = await SDK.init({
+    debug: true,
+    iconPosition: { x: 20, y: 80 },
+    target: '#app'
+  })
+
+  // 使用其他函数式 API
+  SDK.showIcon()
+  SDK.showNotification(5)
+  
+  return SDK
+}
+```
+
+**注意**：函数式 API 使用全局单例，只能有一个实例。如果需要多个实例或更好的类型支持，推荐使用类的方式。
+
+### 兼容性动态导入（自动检测）
+
+```typescript
+const initCustomerSDK = async () => {
+  const mod = await import('customer-chat-sdk')
+  
+  // 优先使用类的方式（推荐）
+  if (mod.CustomerSDK && typeof mod.CustomerSDK === 'function') {
+    const sdk = new mod.CustomerSDK()
+    await sdk.init({ /* ... */ })
+    sdk.onIconClick(() => { /* ... */ })
+    return sdk
+  }
+  
+  // 回退到函数式 API
+  if (mod.default && mod.default.init) {
+    const SDK = mod.default
+    await SDK.init({ /* ... */ })
+    SDK.showIcon()
+    return SDK
+  }
+  
+  throw new Error('CustomerSDK 未找到')
+}
+```
+
 ## 类型定义
 
 ```typescript
@@ -450,7 +600,8 @@ import type {
   CustomerSDK,
   ScreenshotMessageCallback,
   SDKConfig,
-  ScreenshotOptions
+  ScreenshotOptions,
+  InitResult
 } from 'customer-chat-sdk'
 ```
 

package/dist/core/CustomerSDK.d.ts

@@ -16,20 +16,33 @@ export interface ScreenshotMessageCallback {
      */
     sendData?: (data: any) => void;
 }
+/**
+ * SDK 初始化回调接口
+ */
+export interface SDKInitCallback {
+    /**
+     * 图标点击回调
+     */
+    onIconClick?: () => void | Promise<void>;
+}
 export declare class CustomerSDK {
     private iconManager;
     private screenshotManager;
     private debug;
     private deviceId;
     private initResult;
+    private config;
+    private screenshotCallback;
+    private initCallback;
     constructor();
     /**
      * 初始化SDK
      * @param config SDK配置
      * @param screenshotCallback 截图消息回调（可选）
+     * @param initCallback 初始化回调（可选，包含图标点击回调等）
      * @returns 返回初始化信息（包含设备ID等）
      */
-    init(config: SDKConfig, screenshotCallback?: ScreenshotMessageCallback): Promise<InitResult>;
+    init(config: SDKConfig, screenshotCallback?: ScreenshotMessageCallback, initCallback?: SDKInitCallback): Promise<InitResult>;
     /**
      * 设置截图配置监听器（可选，用于兼容 postMessage 场景）
      */
@@ -67,6 +80,15 @@ export declare class CustomerSDK {
      * 获取初始化信息（设备ID等）
      */
     getInitResult(): InitResult | null;
+    /**
+     * 更新 token（用于用户登录/退出场景）
+     * 如果已初始化，会重新初始化以应用新的 token
+     * @param token 新的 token（传空字符串或 undefined 表示移除 token）
+     * @param screenshotCallback 截图消息回调（可选，如果不传则使用之前的回调）
+     * @param initCallback 初始化回调（可选，如果不传则使用之前的回调）
+     * @returns 返回更新后的初始化信息
+     */
+    updateToken(token: string | undefined, screenshotCallback?: ScreenshotMessageCallback, initCallback?: SDKInitCallback): Promise<InitResult>;
     /**
      * 获取设备指纹ID（原始）
      */

package/dist/core/CustomerSDK.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomerSDK.d.ts","sourceRoot":"","sources":["../../src/core/CustomerSDK.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAIvD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IAEnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAA;CAC/B;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,KAAK,CAAiB;IAC9B,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,UAAU,CAA0B;;IAI5C;;;;;OAKG;IACG,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,kBAAkB,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,UAAU,CAAC;IAkFlG;;OAEG;IACH,OAAO,CAAC,6BAA6B;IA6BrC;;;OAGG;IACH,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAWjD;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAIvC;;OAEG;IACH,oBAAoB,IAAI,iBAAiB,GAAG,IAAI;IAIhD;;OAEG;IACH,cAAc,IAAI,WAAW,GAAG,IAAI;IAIpC;;OAEG;IACH,WAAW,IAAI,MAAM,GAAG,IAAI;IAI5B;;OAEG;IACH,aAAa,IAAI,UAAU,GAAG,IAAI;IAIlC;;OAEG;YACW,cAAc;IA8B5B;;OAEG;IACH,gBAAgB,CAAC,UAAU,GAAE,MAAM,GAAG,MAAU,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,IAAI;IAsB7G;;OAEG;IACH,iBAAiB,IAAI,IAAI;IAIzB;;OAEG;IACH,OAAO,IAAI,IAAI;CAmBhB"}
+{"version":3,"file":"CustomerSDK.d.ts","sourceRoot":"","sources":["../../src/core/CustomerSDK.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAIvD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IAEnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,KAAK,CAAiB;IAC9B,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,UAAU,CAA0B;IAC5C,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,kBAAkB,CAAyC;IACnE,OAAO,CAAC,YAAY,CAA+B;;IAInD;;;;;;OAMG;IACG,IAAI,CACR,MAAM,EAAE,SAAS,EACjB,kBAAkB,CAAC,EAAE,yBAAyB,EAC9C,YAAY,CAAC,EAAE,eAAe,GAC7B,OAAO,CAAC,UAAU,CAAC;IA0FtB;;OAEG;IACH,OAAO,CAAC,6BAA6B;IA6BrC;;;OAGG;IACH,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAWjD;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAIvC;;OAEG;IACH,oBAAoB,IAAI,iBAAiB,GAAG,IAAI;IAIhD;;OAEG;IACH,cAAc,IAAI,WAAW,GAAG,IAAI;IAIpC;;OAEG;IACH,WAAW,IAAI,MAAM,GAAG,IAAI;IAI5B;;OAEG;IACH,aAAa,IAAI,UAAU,GAAG,IAAI;IAIlC;;;;;;;OAOG;IACG,WAAW,CACf,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,kBAAkB,CAAC,EAAE,yBAAyB,EAC9C,YAAY,CAAC,EAAE,eAAe,GAC7B,OAAO,CAAC,UAAU,CAAC;IA2BtB;;OAEG;YACW,cAAc;IA8B5B;;OAEG;IACH,gBAAgB,CAAC,UAAU,GAAE,MAAM,GAAG,MAAU,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,IAAI;IAsB7G;;OAEG;IACH,iBAAiB,IAAI,IAAI;IAIzB;;OAEG;IACH,OAAO,IAAI,IAAI;CAoBhB"}

package/dist/customer-sdk.cjs.js

@@ -29340,15 +29340,22 @@ class CustomerSDK {
         this.debug = false; // debug 模式标志
         this.deviceId = null; // 设备ID（md5后的）
         this.initResult = null; // 保存初始化结果
+        this.config = null; // 保存配置，用于更新 token
+        this.screenshotCallback = null; // 保存截图回调
+        this.initCallback = null; // 保存初始化回调
     }
     /**
      * 初始化SDK
      * @param config SDK配置
      * @param screenshotCallback 截图消息回调（可选）
+     * @param initCallback 初始化回调（可选，包含图标点击回调等）
      * @returns 返回初始化信息（包含设备ID等）
      */
-    async init(config, screenshotCallback) {
+    async init(config, screenshotCallback, initCallback) {
         try {
+            this.config = config; // 保存配置，用于后续更新 token
+            this.screenshotCallback = screenshotCallback || null; // 保存截图回调
+            this.initCallback = initCallback || null; // 保存初始化回调
             this.debug = config.debug ?? false;
             // 获取设备指纹ID
             const rawDeviceId = await this.getRawDeviceId();
@@ -29381,6 +29388,10 @@ class CustomerSDK {
                 autoAttachDelay: config.autoAttachDelay
             });
             await this.iconManager.show();
+            // 设置图标点击回调（如果提供了）
+            if (initCallback?.onIconClick) {
+                this.iconManager.onClick(initCallback.onIconClick);
+            }
             // 初始化截图管理器（如果配置了截图）
             if (config.screenshot) {
                 const targetElement = typeof iconTarget === 'string'
@@ -29489,6 +29500,32 @@ class CustomerSDK {
     getInitResult() {
         return this.initResult;
     }
+    /**
+     * 更新 token（用于用户登录/退出场景）
+     * 如果已初始化，会重新初始化以应用新的 token
+     * @param token 新的 token（传空字符串或 undefined 表示移除 token）
+     * @param screenshotCallback 截图消息回调（可选，如果不传则使用之前的回调）
+     * @param initCallback 初始化回调（可选，如果不传则使用之前的回调）
+     * @returns 返回更新后的初始化信息
+     */
+    async updateToken(token, screenshotCallback, initCallback) {
+        if (!this.config) {
+            throw new Error('SDK not initialized. Call init() first.');
+        }
+        if (this.debug) {
+            console.log('Updating token:', token ? 'Token provided' : 'Token removed');
+        }
+        // 更新配置中的 token
+        const updatedConfig = {
+            ...this.config,
+            token: token && token.trim() !== '' ? token : undefined
+        };
+        // 先销毁旧实例
+        this.destroy();
+        // 重新初始化以应用新的 token
+        // 使用新的回调（如果提供），否则使用之前保存的回调
+        return await this.init(updatedConfig, screenshotCallback || this.screenshotCallback || undefined, initCallback || this.initCallback || undefined);
+    }
     /**
      * 获取设备指纹ID（原始）
      */
@@ -29565,6 +29602,7 @@ class CustomerSDK {
         this.screenshotManager = null;
         this.initResult = null;
         this.deviceId = null;
+        // 注意：不清理 config 和回调，以便 updateToken 时使用
         if (this.debug) {
             console.log('CustomerSDK destroyed');
         }
@@ -29788,6 +29826,12 @@ class CustomerServiceSDK {
     setIconStyle(style) {
         this.iconManager?.setStyle(style);
     }
+    /**
+     * 设置图标点击回调
+     */
+    onIconClick(callback) {
+        this.iconManager?.onClick(callback);
+    }
     /**
      * 获取连接状态
      * 注意：真正的连接状态保存在iframe中的SSE连接中
@@ -30017,6 +30061,13 @@ const setIconStyle = (style) => {
     const sdk = getInstance();
     sdk.setIconStyle(style);
 };
+/**
+ * 设置图标点击回调
+ */
+const onIconClick = (callback) => {
+    const sdk = getInstance();
+    sdk.onIconClick(callback);
+};
 /**
  * 其他API
  */
@@ -30080,6 +30131,7 @@ var index = {
     setIconPosition,
     setIconCoordinates,
     setIconStyle,
+    onIconClick,
     getConnectionStatus,
     showNotification,
     clearNotification,
@@ -30104,6 +30156,7 @@ exports.getInstance = getInstance;
 exports.getScreenshotState = getScreenshotState;
 exports.hideIcon = hideIcon;
 exports.init = init;
+exports.onIconClick = onIconClick;
 exports.setIconCoordinates = setIconCoordinates;
 exports.setIconPosition = setIconPosition;
 exports.setIconStyle = setIconStyle;

package/dist/customer-sdk.esm.js

@@ -29336,15 +29336,22 @@ class CustomerSDK {
         this.debug = false; // debug 模式标志
         this.deviceId = null; // 设备ID（md5后的）
         this.initResult = null; // 保存初始化结果
+        this.config = null; // 保存配置，用于更新 token
+        this.screenshotCallback = null; // 保存截图回调
+        this.initCallback = null; // 保存初始化回调
     }
     /**
      * 初始化SDK
      * @param config SDK配置
      * @param screenshotCallback 截图消息回调（可选）
+     * @param initCallback 初始化回调（可选，包含图标点击回调等）
      * @returns 返回初始化信息（包含设备ID等）
      */
-    async init(config, screenshotCallback) {
+    async init(config, screenshotCallback, initCallback) {
         try {
+            this.config = config; // 保存配置，用于后续更新 token
+            this.screenshotCallback = screenshotCallback || null; // 保存截图回调
+            this.initCallback = initCallback || null; // 保存初始化回调
             this.debug = config.debug ?? false;
             // 获取设备指纹ID
             const rawDeviceId = await this.getRawDeviceId();
@@ -29377,6 +29384,10 @@ class CustomerSDK {
                 autoAttachDelay: config.autoAttachDelay
             });
             await this.iconManager.show();
+            // 设置图标点击回调（如果提供了）
+            if (initCallback?.onIconClick) {
+                this.iconManager.onClick(initCallback.onIconClick);
+            }
             // 初始化截图管理器（如果配置了截图）
             if (config.screenshot) {
                 const targetElement = typeof iconTarget === 'string'
@@ -29485,6 +29496,32 @@ class CustomerSDK {
     getInitResult() {
         return this.initResult;
     }
+    /**
+     * 更新 token（用于用户登录/退出场景）
+     * 如果已初始化，会重新初始化以应用新的 token
+     * @param token 新的 token（传空字符串或 undefined 表示移除 token）
+     * @param screenshotCallback 截图消息回调（可选，如果不传则使用之前的回调）
+     * @param initCallback 初始化回调（可选，如果不传则使用之前的回调）
+     * @returns 返回更新后的初始化信息
+     */
+    async updateToken(token, screenshotCallback, initCallback) {
+        if (!this.config) {
+            throw new Error('SDK not initialized. Call init() first.');
+        }
+        if (this.debug) {
+            console.log('Updating token:', token ? 'Token provided' : 'Token removed');
+        }
+        // 更新配置中的 token
+        const updatedConfig = {
+            ...this.config,
+            token: token && token.trim() !== '' ? token : undefined
+        };
+        // 先销毁旧实例
+        this.destroy();
+        // 重新初始化以应用新的 token
+        // 使用新的回调（如果提供），否则使用之前保存的回调
+        return await this.init(updatedConfig, screenshotCallback || this.screenshotCallback || undefined, initCallback || this.initCallback || undefined);
+    }
     /**
      * 获取设备指纹ID（原始）
      */
@@ -29561,6 +29598,7 @@ class CustomerSDK {
         this.screenshotManager = null;
         this.initResult = null;
         this.deviceId = null;
+        // 注意：不清理 config 和回调，以便 updateToken 时使用
         if (this.debug) {
             console.log('CustomerSDK destroyed');
         }
@@ -29784,6 +29822,12 @@ class CustomerServiceSDK {
     setIconStyle(style) {
         this.iconManager?.setStyle(style);
     }
+    /**
+     * 设置图标点击回调
+     */
+    onIconClick(callback) {
+        this.iconManager?.onClick(callback);
+    }
     /**
      * 获取连接状态
      * 注意：真正的连接状态保存在iframe中的SSE连接中
@@ -30013,6 +30057,13 @@ const setIconStyle = (style) => {
     const sdk = getInstance();
     sdk.setIconStyle(style);
 };
+/**
+ * 设置图标点击回调
+ */
+const onIconClick = (callback) => {
+    const sdk = getInstance();
+    sdk.onIconClick(callback);
+};
 /**
  * 其他API
  */
@@ -30076,6 +30127,7 @@ var index = {
     setIconPosition,
     setIconCoordinates,
     setIconStyle,
+    onIconClick,
     getConnectionStatus,
     showNotification,
     clearNotification,
@@ -30087,4 +30139,4 @@ var index = {
     destroy
 };
 
-export { CustomerSDK, CustomerServiceSDK, captureScreenshot, clearNotification, index as default, destroy, enableScreenshot, getConnectionStatus, getInitResult, getInstance, getScreenshotState, hideIcon, init, setIconCoordinates, setIconPosition, setIconStyle, setScreenshotTarget, showIcon, showNotification, updateScreenshotOptions };
+export { CustomerSDK, CustomerServiceSDK, captureScreenshot, clearNotification, index as default, destroy, enableScreenshot, getConnectionStatus, getInitResult, getInstance, getScreenshotState, hideIcon, init, onIconClick, setIconCoordinates, setIconPosition, setIconStyle, setScreenshotTarget, showIcon, showNotification, updateScreenshotOptions };