joytalk 0.0.38 → 0.0.40

package/README.md

@@ -44,19 +44,36 @@ pnpm add joytalk
 **示例：**
 
 ```typescript
-import JoyTalk, { EventType, ChatType, MessageCode } from 'joytalk';
+import JoyTalk, { EventType, ChatType, MessageCode } from "joytalk";
 
 // 创建 SDK 实例
 const JTalk = new JoyTalk();
 
 // 初始化：传入 token 等配置（必须在使用前调用）
 await JTalk.init({
-  token: 'your-token',
+  token: "your-token",
 });
 ```
 
 ---
 
+### 设置语言
+
+通过 `setLanguage` 方法，设置语言。
+
+**示例：**
+
+```typescript
+JTalk.setLanguage("zh-CN");
+```
+
+**参数说明：**
+| 参数 | 说明 | 是否必填 | 默认值 |
+|------|------|----------|--------|
+| `language` | 语言 | 否 | en-US |
+
+---
+
 ### 获取咨询列表
 
 通过 `getConsultationList` 方法，传入入口 ID，获取咨询列表。
@@ -64,7 +81,7 @@ await JTalk.init({
 **示例：**
 
 ```typescript
-const entranceId = '123456';
+const entranceId = "123456";
 // 获取咨询列表
 const result = await JTalk.getConsultationList(entranceId);
 console.log(result);
@@ -127,7 +144,7 @@ console.log(userInfo);
 **示例：**
 
 ```typescript
-const consultationTypeId = '123456';
+const consultationTypeId = "123456";
 // 连接到服务器
 JTalk.connect(consultationTypeId);
 ```
@@ -148,6 +165,7 @@ JTalk.connect(consultationTypeId);
 ```typescript
 JTalk.disconnect();
 ```
+
 ---
 
 ### 监听消息事件
@@ -163,20 +181,20 @@ JTalk.disconnect();
 ```typescript
 // 监听连接事件
 JTalk.on(EventType.CONNECTED, () => {
-  console.log('已连接到服务器');
+  console.log("已连接到服务器");
 });
 
 // 监听消息事件
 JTalk.on(EventType.MESSAGE, (message) => {
-  console.log('收到消息:', message);
+  console.log("收到消息:", message);
 
   // 根据消息类型处理
   switch (message.code) {
     case MessageCode.SEND_SUCCESS:
-      console.log('消息发送成功:', message.data);
+      console.log("消息发送成功:", message.data);
       break;
     case MessageCode.MATCH_SUCCESS:
-      console.log('匹配成功:', message.data);
+      console.log("匹配成功:", message.data);
       break;
     // ... 其他消息类型
   }
@@ -184,27 +202,27 @@ JTalk.on(EventType.MESSAGE, (message) => {
 
 // 监听错误事件
 JTalk.on(EventType.ERROR, (error) => {
-  console.error('发生错误:', error);
+  console.error("发生错误:", error);
 });
 
 // 监听状态变化
 JTalk.on(EventType.STATUS_CHANGE, (status) => {
-  console.log('连接状态变化:', status);
+  console.log("连接状态变化:", status);
 });
 
 // 监听心跳超时事件
 JTalk.on(EventType.HEARTBEAT_TIMEOUT, () => {
-  console.log('心跳超时');
+  console.log("心跳超时");
 });
 
 // 监听连接断开事件
 JTalk.on(EventType.DISCONNECTED, () => {
-  console.log('连接断开');
+  console.log("连接断开");
 });
 
 // 取消监听消息事件
 const callback = (message) => {
-  console.log('收到消息', message);
+  console.log("收到消息", message);
 };
 JTalk.on(EventType.MESSAGE, callback);
 // 取消监听消息事件
@@ -213,7 +231,6 @@ JTalk.off(EventType.MESSAGE, callback);
 // 移除所有事件监听器
 JTalk.removeAllListeners(); // 移除所有事件监听器
 JTalk.removeAllListeners(EventType.MESSAGE); // 移除指定事件类型的事件监听器
-
 ```
 
 **参数说明：**
@@ -232,6 +249,7 @@ JTalk.removeAllListeners(EventType.MESSAGE); // 移除指定事件类型的事
 - `EventType.HEARTBEAT_TIMEOUT` - 心跳超时
 
 ---
+
 ### 消息处理示例
 
 通过监听 `EventType.MESSAGE`，根据 `message.code` 区分消息类型并处理。
@@ -240,7 +258,7 @@ JTalk.removeAllListeners(EventType.MESSAGE); // 移除指定事件类型的事
 
 ```typescript
 JTalk.on(EventType.MESSAGE, (message) => {
-  const msgData = message.data
+  const msgData = message.data;
   // 根据消息类型处理
   switch (message.code) {
     case MessageCode.MATCH_INFO:
@@ -248,38 +266,41 @@ JTalk.on(EventType.MESSAGE, (message) => {
     case MessageCode.TRANSFER_USER_SUCCESS:
     case MessageCode.REMATCH:
       // 匹配成功/分配成功/转接成功/重新匹配，msgData 为 SessionData 类型
-      sessionData.value = msgData
-      if (message.code === MessageCode.MATCH_INFO || message.code === MessageCode.MATCH_SUCCESS) {
+      sessionData.value = msgData;
+      if (
+        message.code === MessageCode.MATCH_INFO ||
+        message.code === MessageCode.MATCH_SUCCESS
+      ) {
         // 匹配成功/分配成功，获取聊天记录
-        getHistoryMessages()
+        getHistoryMessages();
       }
-      break
+      break;
     case MessageCode.MATCH_FAIL:
-      console.error(message.msg || '匹配失败')
-      break
+      console.error(message.msg || "匹配失败");
+      break;
     case MessageCode.SEND_SUCCESS:
     case MessageCode.REPLY_SUCCESS:
       // 发送成功/回复成功，msgData 为 MessageData 类型
-      console.log('收到消息', msgData)
+      console.log("收到消息", msgData);
       // 消息类型：ChatType枚举值 文字、图片、视频、文件、FAQ
-      console.log('消息类型', msgData.contentType)
+      console.log("消息类型", msgData.contentType);
       // 消息类型：MessageType枚举值 发送、撤回、编辑、系统通知、转接、进线、回复、解绑
-      console.log('消息类型', msgData.msgType)
-      break
+      console.log("消息类型", msgData.msgType);
+      break;
     case MessageCode.RETRACT:
       // 撤回消息，msgData 为 MessageData 类型
-      console.log('收到撤回消息', msgData)
-      console.log('撤回消息的 messageId', messageId)
-      break
+      console.log("收到撤回消息", msgData);
+      console.log("撤回消息的 messageId", messageId);
+      break;
     case MessageCode.EDIT:
       // 编辑消息，msgData 为 MessageData 类型
-      console.log('收到编辑消息', msgData)
-      console.log('编辑消息的 messageId', messageId)
-      console.log('编辑后消息的内容', msgData.content)
-      break
+      console.log("收到编辑消息", msgData);
+      console.log("编辑消息的 messageId", messageId);
+      console.log("编辑后消息的内容", msgData.content);
+      break;
     default:
-      console.log('收到其他消息', msgData)
-      break
+      console.log("收到其他消息", msgData);
+      break;
   }
 });
 ```
@@ -320,6 +341,7 @@ JTalk.on(EventType.MESSAGE, (message) => {
 - `MessageType.UNBIND` - 解绑
 
 **ChatType 枚举：**
+
 - `ChatType.TEXT` - 文字
 - `ChatType.IMAGE` - 图片
 - `ChatType.VIDEO` - 视频
@@ -337,7 +359,10 @@ JTalk.on(EventType.MESSAGE, (message) => {
 
 ```typescript
 const getHistoryMessages = async (lastMsgId?: string) => {
-  const { list, hasMore } = await JTalk.getHistoryMessages({ lastMsgId, size: 50 });
+  const { list, hasMore } = await JTalk.getHistoryMessages({
+    lastMsgId,
+    size: 50,
+  });
   console.log(list, hasMore);
   return { list, hasMore };
 };
@@ -366,7 +391,7 @@ const getHistoryMessages = async (lastMsgId?: string) => {
 **示例：**
 
 ```typescript
-const content = '你好！';
+const content = "你好！";
 const { messageId } = await JTalk.sendText(content);
 console.log(messageId);
 ```
@@ -394,7 +419,10 @@ console.log(messageId);
 // 发送图片
 const file = document.querySelector('input[type="file"]').files?.[0];
 if (file) {
-  const { messageId } = await JTalk.sendFile({ file, chatType: ChatType.IMAGE });
+  const { messageId } = await JTalk.sendFile({
+    file,
+    chatType: ChatType.IMAGE,
+  });
   console.log(messageId);
 }
 
@@ -403,7 +431,11 @@ const videoFile = document.querySelector('input[type="file"]').files?.[0];
 if (videoFile) {
   // 获取视频缩略图
   const thumbnailFile = await JTalk.getVideoThumbnail(videoFile);
-  const { messageId } = await JTalk.sendFile({ file: videoFile, thumbnailFile, chatType: ChatType.VIDEO });
+  const { messageId } = await JTalk.sendFile({
+    file: videoFile,
+    thumbnailFile,
+    chatType: ChatType.VIDEO,
+  });
   console.log(messageId);
 }
 
@@ -442,9 +474,9 @@ const faqItem = {
   faqId: 1,
   faqItemId: 1,
   id: 1,
-  imageUrl: ['https://example.com/image.jpg'],
-  question: '问题',
-  answer: '答案',
+  imageUrl: ["https://example.com/image.jpg"],
+  question: "问题",
+  answer: "答案",
   sortOrder: 1,
   isMulti: false,
   item: [],
@@ -490,23 +522,25 @@ await JTalk.sendFaq(faqItem);
 </template>
 
 <script setup lang="ts">
-import { onMounted, onUnmounted } from 'vue';
-import JoyTalk, { EventType, ChatType } from 'joytalk';
+import { onMounted, onUnmounted } from "vue";
+import JoyTalk, { EventType, ChatType } from "joytalk";
 
 const JTalk = new JoyTalk();
 
 onMounted(async () => {
-  await JTalk.init({ token: 'your-token' });
+  await JTalk.init({ token: "your-token" });
 
-  const entranceId = '123456';
+  const entranceId = "123456";
   const consultationList = await JTalk.getConsultationList(entranceId);
-  console.log('咨询列表', consultationList);
+  console.log("咨询列表", consultationList);
 
   // 获取默认客服组
-  const defaultCustomerGroup = consultationList.list.find((item) => item.isDefault) || consultationList.list[0];
+  const defaultCustomerGroup =
+    consultationList.list.find((item) => item.isDefault) ||
+    consultationList.list[0];
 
   JTalk.connect(defaultCustomerGroup.id);
-  JTalk.on(EventType.MESSAGE, (message) => console.log('收到消息:', message));
+  JTalk.on(EventType.MESSAGE, (message) => console.log("收到消息:", message));
 });
 
 onUnmounted(() => {
@@ -515,7 +549,7 @@ onUnmounted(() => {
 });
 
 const sendText = async () => {
-  await JTalk.sendText('Hello');
+  await JTalk.sendText("Hello");
 };
 
 const handleFileChange = async (e: Event) => {
@@ -536,31 +570,31 @@ const handleFileChange = async (e: Event) => {
 ```html
 <!DOCTYPE html>
 <html lang="zh-CN">
-<head>
-  <meta charset="UTF-8">
-  <title>客服 SDK 简化示例</title>
-  <script src="https://your-cdn.com/joytalk/dist/index.umd.js"></script>
-</head>
-<body>
-  <script>
-    const JoyTalk = window.JoyTalk.default;
-    const { EventType } = window.JoyTalk;
-
-    const JTalk = new JoyTalk();
-
-    await JTalk.init({ token: 'your-token' });
-
-    const entranceId = '123456';
-    const consultationList = await JTalk.getConsultationList(entranceId);
-    console.log('咨询列表', consultationList);
-
-    const defaultCustomerGroup = consultationList.list.find((item) => item.isDefault) || consultationList.list[0];
-    JTalk.connect(defaultCustomerGroup.id);
-
-    JTalk.on(EventType.MESSAGE, (message) => console.log('收到消息:', message));
-    JTalk.sendText('你好');
-  </script>
-</body>
+  <head>
+    <meta charset="UTF-8" />
+    <title>客服 SDK 简化示例</title>
+    <script src="https://your-cdn.com/joytalk/dist/index.umd.js"></script>
+  </head>
+  <body>
+    <script>
+      const JoyTalk = window.JoyTalk.default;
+      const { EventType } = window.JoyTalk;
+
+      const JTalk = new JoyTalk();
+
+      await JTalk.init({ token: 'your-token' });
+
+      const entranceId = '123456';
+      const consultationList = await JTalk.getConsultationList(entranceId);
+      console.log('咨询列表', consultationList);
+
+      const defaultCustomerGroup = consultationList.list.find((item) => item.isDefault) || consultationList.list[0];
+      JTalk.connect(defaultCustomerGroup.id);
+
+      JTalk.on(EventType.MESSAGE, (message) => console.log('收到消息:', message));
+      JTalk.sendText('你好');
+    </script>
+  </body>
 </html>
 ```
 
@@ -569,7 +603,6 @@ const handleFileChange = async (e: Event) => {
 - 将 `https://your-cdn.com/joytalk/dist/index.umd.js` 替换为实际的 CDN 地址
 - 如果使用本地构建文件，可以使用相对路径：`<script src="./dist/index.umd.js"></script>`
 
-
 **注意事项：**
 
 - CDN 引入后，SDK 会挂载到 `window.JoyTalk` 全局对象上
@@ -578,7 +611,6 @@ const handleFileChange = async (e: Event) => {
 - 确保 CDN 地址可访问，并且版本正确
 - 如果页面中已经使用了模块化构建工具（如 Webpack、Vite），建议使用 NPM 安装方式而不是 CDN
 
-
 ## 类型定义
 
 SDK 提供完整的 TypeScript 类型定义，可从 `joytalk` 按需导入。
@@ -599,5 +631,3 @@ SDK 提供完整的 TypeScript 类型定义，可从 `joytalk` 按需导入。
 | `MatchStatus`           | 匹配状态枚举         |
 | `HistoryMessagesParams` | 聊天记录查询参数     |
 | `RequestResponse<T>`    | 接口响应包装         |
-
-