vanshi-sdk 1.0.4 → 1.0.6

package/README.md

@@ -1,96 +1,215 @@
-# vanshi-chat-ws
+# Vanshi Chat SDK
 
+浏览器侧 IM SDK，提供 socket 连接、登录、会话、文本消息、媒体消息、历史消息、消息回执和事件监听能力。
 
+当前版本：`vanshi-sdk@1.0.5`
 
-## Getting started
+## 安装
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+内网 npm：
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+```bash
+npm install vanshi-sdk@1.0.5 --registry=https://npm.whatimcloud.com/
+```
+
+默认 registry 已配置到内网时：
+
+```bash
+npm install vanshi-sdk@1.0.5
+```
+
+## 引入方式
 
-## Add your files
+### ESM
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+```ts
+import VanshiSdk from 'vanshi-sdk'
 
+await VanshiSdk.create()
+await VanshiSdk.login({ token: 'your_token' })
 ```
-cd existing_repo
-git remote add origin https://gitlab.whatimcloud.com/web/fe/vanshi-chat-ws.git
-git branch -M main
-git push -uf origin main
+
+### 命名导入
+
+```ts
+import { create, login, sendMessage } from 'vanshi-sdk'
+
+await create()
+await login({ token: 'your_token' })
+```
+
+### CommonJS
+
+```js
+const VanshiSdkModule = require('vanshi-sdk')
+const VanshiSdk = VanshiSdkModule.default || VanshiSdkModule
 ```
 
-## Integrate with your tools
+### script 标签
+
+```html
+<script src="./node_modules/vanshi-sdk/dist/index.js"></script>
+<script>
+  async function main() {
+    await VanshiSdk.create()
+    await VanshiSdk.login({ token: 'your_token' })
+  }
 
-- [ ] [Set up project integrations](https://gitlab.whatimcloud.com/web/fe/vanshi-chat-ws/-/settings/integrations)
+  main()
+</script>
+```
 
-## Collaborate with your team
+script 引入后会暴露全局变量：
+
+```ts
+window.VanshiSdk
+```
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+## 服务地址配置
 
-## Test and Deploy
+如需切换环境，请在调用 `create()` 前设置：
 
-Use the built-in continuous integration in GitLab.
+```ts
+window.__VANSHI_SOCKET_URL = 'wss://your-socket-host'
+window.__VANSHI_HTTP_URL = 'https://your-api-host/api/files/sdkUpload'
+```
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+## 快速开始
 
-***
+```ts
+import VanshiSdk from 'vanshi-sdk'
 
-# Editing this README
+async function bootstrap() {
+  await VanshiSdk.create()
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+  const success = await VanshiSdk.login({
+    token: 'your_token',
+  })
 
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+  if (!success) {
+    throw new Error('SDK 登录失败')
+  }
 
-## Name
-Choose a self-explaining name for your project.
+  const conversations = await VanshiSdk.queryConversation({
+    count: 20,
+    nextConversation: undefined,
+  })
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+  console.log('会话列表', conversations)
+}
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+bootstrap().catch(console.error)
+```
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+## 发送文本消息
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+SDK 会在发送消息前自动生成 `clientBizId`。该字段包含时间戳，可用于客户端本地消息和服务端返回消息合并。
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+```ts
+const result = await VanshiSdk.sendMessage({
+  message: {
+    type: '1',
+    message: '你好',
+    extendedData: '{}',
+    // 可选；不传时 SDK 自动生成 cbiz_${timestamp}_${sequence}_${random}
+    clientBizId: `biz_${Date.now()}_${Math.random().toString(36).slice(2)}`,
+  },
+  toConversationID: 'conversation_id',
+  conversationType: 2,
+})
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+console.log(result.clientBizId)
+```
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+## 发送媒体消息并即时渲染
+
+`sendMediaMessage` 支持 `onMessageAttached`。SDK 会先生成 `clientBizId` 和本地媒体消息，立即回调给客户端渲染，然后继续上传文件并发送到后端。
+
+```ts
+const file = input.files?.[0]
+
+if (file) {
+  const result = await VanshiSdk.sendMediaMessage(
+    {
+      message: {
+        type: '12',
+        message: '文件消息',
+        extendedData: '{}',
+        file,
+      },
+      toConversationID: 'conversation_id',
+      conversationType: 2,
+    },
+    {
+      onMessageAttached(localMessage) {
+        // localMessage.clientBizId 可用于后续和服务端返回消息合并
+        // localMessage.localPreviewUrl 可用于本地预览
+        appendMessage(localMessage)
+      },
+    },
+  )
+
+  updateMessage(result.clientBizId, result)
+}
+```
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+`onMessageAttached` 不会影响 SDK 后续发送流程；回调内部异常会被 SDK 忽略。
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+本地媒体消息常用字段：
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+| 字段 | 类型 | 说明 |
+| --- | --- | --- |
+| `clientBizId` | `string` | 客户端业务预发 ID |
+| `localMessageID` | `string` | 本地消息 ID，默认等于 `clientBizId` |
+| `conversationID` | `string` | 会话 ID |
+| `conversationType` | `number` | 会话类型 |
+| `type` | `string` | 消息类型 |
+| `message` | `string` | 消息内容 |
+| `sentStatus` | `number` | 本地发送状态，`0` 表示发送中 |
+| `fileName` | `string` | 文件名，最长 20 个字符；上传接口也使用截取后的文件名 |
+| `fileSize` | `string` | 文件大小 |
+| `localPreviewUrl` | `string` | 浏览器本地预览地址 |
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+## 常用事件
 
-## License
-For open source projects, say how it is licensed.
+```ts
+const handler = (payload: unknown) => {
+  console.log(payload)
+}
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+VanshiSdk.on('conversationChanged', handler)
+VanshiSdk.on('receiveGroupMessage', handler)
+VanshiSdk.on('messageReceiptChanged', handler)
 
-## Socket SDK usage (示例)
+VanshiSdk.off('conversationChanged', handler)
+```
 
-http://127.0.0.1:3000/debug/index.html
+## 常用 API
+
+| API | 说明 |
+| --- | --- |
+| `create()` | 创建 socket 连接 |
+| `login({ token })` | 登录 SDK |
+| `logout()` | 退出登录并清理本地 token |
+| `isConnected()` | 判断 socket 是否连接 |
+| `queryConversation(params)` | 查询会话列表 |
+| `sendMessage(params)` | 发送文本消息 |
+| `sendMediaMessage(params, options?)` | 发送媒体消息，支持本地消息预回调 |
+| `queryHistoryMessage(params)` | 查询历史消息 |
+| `sendMessageReceiptsRead(...)` | 发送已读回执 |
+| `queryMessageReceiptsInfo(...)` | 查询消息回执 |
+
+## 详细文档
+
+- [VANSHI_SDK.md](./VANSHI_SDK.md)：客户接入完整文档
+- [SDK.md](./SDK.md)：SDK API 说明
+- [USAGE.md](./USAGE.md)：基础使用示例
+
+## 发布产物
+
+| 文件 | 用途 |
+| --- | --- |
+| `dist/index.js` | 浏览器 script 标签全局版本 |
+| `dist/index.mjs` | ESM 版本 |
+| `dist/index.cjs` | CommonJS 版本 |
+| `dist/index.d.ts` | TypeScript 类型声明 |

package/dist/index.cjs

@@ -774,6 +774,62 @@ var postSdkDeleteAllMessageApiRequest = (data) => {
 };
 
 // src/sdk/message.ts
+var clientBizIdSeq = 0;
+var MAX_FILE_NAME_LENGTH = 20;
+function generateClientBizId() {
+  clientBizIdSeq = (clientBizIdSeq + 1) % 1e6;
+  const timestamp = Date.now();
+  const sequence = clientBizIdSeq.toString(36);
+  const random = Math.random().toString(36).slice(2, 10);
+  return `cbiz_${timestamp}_${sequence}_${random}`;
+}
+function withClientBizId(message) {
+  return {
+    ...message,
+    clientBizId: message.clientBizId || generateClientBizId()
+  };
+}
+function truncateFileName(fileName) {
+  return fileName.length > MAX_FILE_NAME_LENGTH ? fileName.slice(0, MAX_FILE_NAME_LENGTH) : fileName;
+}
+function getDisplayFileName(file, fallback = "") {
+  return truncateFileName(file?.name || fallback || "");
+}
+function createLocalMediaMessage(message, toConversationID, conversationType) {
+  const file = message.file;
+  const localPreviewUrl = file && typeof URL !== "undefined" && URL.createObjectURL ? URL.createObjectURL(file) : void 0;
+  return {
+    massage: message.message,
+    message: message.message,
+    type: message.type,
+    extendedData: message.extendedData,
+    messageID: "",
+    orderKey: "",
+    clientSid: "",
+    localMessageID: message.clientBizId,
+    clientBizId: message.clientBizId,
+    conversationID: toConversationID,
+    conversationType,
+    senderUserID: "",
+    direction: 0,
+    sentStatus: 0,
+    timestamp: Date.now(),
+    receiptStatus: 0,
+    isServerMessage: false,
+    isBroadcastMessage: false,
+    isGroupTargetedMessage: "",
+    id: "",
+    file,
+    fileName: getDisplayFileName(file, message.fileName),
+    fileSize: file ? String(file.size) : message.fileSize || "",
+    fileDownloadUrl: message.fileDownloadUrl || localPreviewUrl || "",
+    thumbnailDownloadUrl: message.thumbnailDownloadUrl || localPreviewUrl || "",
+    thumbnailWidth: message.thumbnailWidth || "",
+    thumbnailHeight: message.thumbnailHeight || "",
+    duration: message.duration || "",
+    localPreviewUrl
+  };
+}
 async function getImageSize(file) {
   return new Promise((resolve, reject) => {
     const url = URL.createObjectURL(file);
@@ -792,9 +848,14 @@ async function getImageSize(file) {
     img.src = url;
   });
 }
-async function uploadSdkFile(file) {
+async function uploadSdkFile(file, fileName) {
   const formData = new FormData();
-  formData.append("file", file);
+  const uploadFileName = truncateFileName(fileName || file.name || "");
+  if (uploadFileName) {
+    formData.append("file", file, uploadFileName);
+  } else {
+    formData.append("file", file);
+  }
   const response = await fetch(getUploadUrl(), {
     method: "POST",
     headers: {
@@ -821,7 +882,7 @@ async function enrichMediaMessage(message) {
   }
   const enrichedMessage = {
     ...message,
-    fileName: file.name || message.fileName || "",
+    fileName: getDisplayFileName(file, message.fileName),
     fileSize: String(file.size)
   };
   if (isSameUid(message.type, "11" /* Image */)) {
@@ -836,9 +897,12 @@ async function enrichMediaMessage(message) {
     enrichedMessage.duration = String(res.duration);
     enrichedMessage.thumbnailWidth = String(res.videoWidth);
     enrichedMessage.thumbnailHeight = String(res.videoHeight);
-    enrichedMessage.thumbnailDownloadUrl = await uploadSdkFile(res.firstFrameFile);
+    enrichedMessage.thumbnailDownloadUrl = await uploadSdkFile(
+      res.firstFrameFile,
+      res.firstFrameFile.name
+    );
   }
-  const fileDownloadUrl = await uploadSdkFile(file);
+  const fileDownloadUrl = await uploadSdkFile(file, enrichedMessage.fileName);
   enrichedMessage.fileDownloadUrl = fileDownloadUrl;
   if (isSameUid(message.type, "11" /* Image */)) {
     enrichedMessage.thumbnailDownloadUrl = fileDownloadUrl;
@@ -847,13 +911,29 @@ async function enrichMediaMessage(message) {
   return enrichedMessage;
 }
 async function sendMessage(payload) {
-  const response = await postSdkSendMessageApiRequest(payload);
+  const response = await postSdkSendMessageApiRequest({
+    ...payload,
+    message: withClientBizId(payload.message)
+  });
   return unwrapSdkData(response);
 }
-async function sendMediaMessage(payload) {
+async function sendMediaMessage(payload, options) {
+  const messageWithClientBizId = withClientBizId(payload.message);
+  if (options?.onMessageAttached) {
+    try {
+      options.onMessageAttached(
+        createLocalMediaMessage(
+          messageWithClientBizId,
+          payload.toConversationID,
+          payload.conversationType
+        )
+      );
+    } catch {
+    }
+  }
   const response = await postSdkSendMediaMessageApiRequest({
     ...payload,
-    message: await enrichMediaMessage(payload.message)
+    message: await enrichMediaMessage(messageWithClientBizId)
   });
   return unwrapSdkData(response);
 }

package/dist/index.d.ts

@@ -226,6 +226,10 @@ interface YapiPostSdkSendMediaMessageData {
    * 消息表 id
    */
   localMessageID: string
+  /**
+   * 预发 id
+   */
+  clientBizId: string
   /**
    * 会话 id
    */
@@ -366,6 +370,10 @@ interface LastMessageData {
      * SDK 本地生成的 MessageID，开发者无需关注。
      */
     localMessageID: string;
+    /**
+     * 预发 id
+     */
+    clientBizId: string;
     /**
      * 0-不是回执。，1-回执进行中。2-回执已完成。3-回执已过期。3-回执已失败。
      */
@@ -569,6 +577,10 @@ interface ZIMSEDMessage {
      * 自定义的拓展字段
      */
     extendedData: string;
+    /**
+     * 客户端业务预发 ID。未传时 SDK 会自动生成。
+     */
+    clientBizId?: string;
 }
 interface ZIMSEDMediaMessage {
     message: string;
@@ -577,6 +589,10 @@ interface ZIMSEDMediaMessage {
      * 自定义的拓展字段
      */
     extendedData: string;
+    /**
+     * 客户端业务预发 ID。未传时 SDK 会自动生成。
+     */
+    clientBizId?: string;
     file?: File;
     thumbnailHeight?: string;
     thumbnailWidth?: string;
@@ -586,6 +602,49 @@ interface ZIMSEDMediaMessage {
     fileName?: string;
     fileSize?: string;
 }
+interface ZIMLocalMediaMessage {
+    /**
+     * 服务端返回消息内容字段兼容名。
+     */
+    massage: string;
+    /**
+     * 消息内容。
+     */
+    message: string;
+    type: SEDMessageType$1;
+    extendedData: string;
+    messageID: string;
+    orderKey: string;
+    clientSid: string;
+    localMessageID: string;
+    clientBizId: string;
+    conversationID: string;
+    conversationType: ZIMConversationType;
+    senderUserID: string;
+    direction: number;
+    sentStatus: number;
+    timestamp: number;
+    receiptStatus: number;
+    isServerMessage: boolean;
+    isBroadcastMessage: boolean;
+    isGroupTargetedMessage: string;
+    id: string;
+    file?: File;
+    fileName: string;
+    fileSize: string;
+    fileDownloadUrl: string;
+    thumbnailDownloadUrl: string;
+    thumbnailWidth: string;
+    thumbnailHeight: string;
+    duration: string;
+    /**
+     * 浏览器本地预览 URL。客户端使用完后可自行 URL.revokeObjectURL。
+     */
+    localPreviewUrl?: string;
+}
+interface ZIMMediaMessageSendOptions {
+    onMessageAttached?: (message: ZIMLocalMediaMessage) => void;
+}
 interface ZIMMessageSeDResult {
     /**
     * 消息
@@ -630,6 +689,10 @@ interface ZIMMessageSeDResult {
      * 消息表 id
      */
     localMessageID: string;
+    /**
+     * 预发 id
+     */
+    clientBizId: string;
     /**
      * 会话 id
      */
@@ -707,7 +770,7 @@ interface ZIM {
         message: ZIMSEDMediaMessage;
         toConversationID: string;
         conversationType: ZIMConversationType;
-    }): Promise<IYapiPostSdkSendMediaMessageApiResponse['data']>;
+    }, options?: ZIMMediaMessageSendOptions): Promise<IYapiPostSdkSendMediaMessageApiResponse['data']>;
     deleteAllConversationMessages(): Promise<{
         code: string;
         message: string;
@@ -847,10 +910,14 @@ interface IYapiPostSdkSendMessageApiRequestMessage {
    *
    */
   type: string
-  /**
-   * 自定义的拓展字段
-   */
-  extendedData: string
+  /**
+   * 自定义的拓展字段
+   */
+  extendedData: string
+  /**
+   * 客户端业务预发 ID。未传时 SDK 会自动生成。
+   */
+  clientBizId?: string
 }
 declare enum SEDMessageType {
   Unknown = '0',
@@ -911,6 +978,10 @@ interface YapiPostSdkSendMessageMessage {
    * 消息表 id
    */
   localMessageID: string
+  /**
+   * 预发 id
+   */
+  clientBizId: string
   /**
    * 会话 id
    */
@@ -1148,7 +1219,7 @@ declare function sendMediaMessage(payload: {
     message: ZIMSEDMediaMessage;
     toConversationID: string;
     conversationType: ZIMConversationType;
-}): Promise<IYapiPostSdkSendMediaMessageApiResponse['data']>;
+}, options?: ZIMMediaMessageSendOptions): Promise<IYapiPostSdkSendMediaMessageApiResponse['data']>;
 /**
  * 查询历史消息
  * @param payload 查询参数

package/dist/index.js

@@ -4142,6 +4142,62 @@ var VanshiSdk = (() => {
   };
 
   // src/sdk/message.ts
+  var clientBizIdSeq = 0;
+  var MAX_FILE_NAME_LENGTH = 20;
+  function generateClientBizId() {
+    clientBizIdSeq = (clientBizIdSeq + 1) % 1e6;
+    const timestamp = Date.now();
+    const sequence = clientBizIdSeq.toString(36);
+    const random = Math.random().toString(36).slice(2, 10);
+    return `cbiz_${timestamp}_${sequence}_${random}`;
+  }
+  function withClientBizId(message) {
+    return {
+      ...message,
+      clientBizId: message.clientBizId || generateClientBizId()
+    };
+  }
+  function truncateFileName(fileName) {
+    return fileName.length > MAX_FILE_NAME_LENGTH ? fileName.slice(0, MAX_FILE_NAME_LENGTH) : fileName;
+  }
+  function getDisplayFileName(file, fallback = "") {
+    return truncateFileName(file?.name || fallback || "");
+  }
+  function createLocalMediaMessage(message, toConversationID, conversationType) {
+    const file = message.file;
+    const localPreviewUrl = file && typeof URL !== "undefined" && URL.createObjectURL ? URL.createObjectURL(file) : void 0;
+    return {
+      massage: message.message,
+      message: message.message,
+      type: message.type,
+      extendedData: message.extendedData,
+      messageID: "",
+      orderKey: "",
+      clientSid: "",
+      localMessageID: message.clientBizId,
+      clientBizId: message.clientBizId,
+      conversationID: toConversationID,
+      conversationType,
+      senderUserID: "",
+      direction: 0,
+      sentStatus: 0,
+      timestamp: Date.now(),
+      receiptStatus: 0,
+      isServerMessage: false,
+      isBroadcastMessage: false,
+      isGroupTargetedMessage: "",
+      id: "",
+      file,
+      fileName: getDisplayFileName(file, message.fileName),
+      fileSize: file ? String(file.size) : message.fileSize || "",
+      fileDownloadUrl: message.fileDownloadUrl || localPreviewUrl || "",
+      thumbnailDownloadUrl: message.thumbnailDownloadUrl || localPreviewUrl || "",
+      thumbnailWidth: message.thumbnailWidth || "",
+      thumbnailHeight: message.thumbnailHeight || "",
+      duration: message.duration || "",
+      localPreviewUrl
+    };
+  }
   async function getImageSize(file) {
     return new Promise((resolve, reject) => {
       const url2 = URL.createObjectURL(file);
@@ -4160,9 +4216,14 @@ var VanshiSdk = (() => {
       img.src = url2;
     });
   }
-  async function uploadSdkFile(file) {
+  async function uploadSdkFile(file, fileName) {
     const formData = new FormData();
-    formData.append("file", file);
+    const uploadFileName = truncateFileName(fileName || file.name || "");
+    if (uploadFileName) {
+      formData.append("file", file, uploadFileName);
+    } else {
+      formData.append("file", file);
+    }
     const response = await fetch(getUploadUrl(), {
       method: "POST",
       headers: {
@@ -4189,7 +4250,7 @@ var VanshiSdk = (() => {
     }
     const enrichedMessage = {
       ...message,
-      fileName: file.name || message.fileName || "",
+      fileName: getDisplayFileName(file, message.fileName),
       fileSize: String(file.size)
     };
     if (isSameUid(message.type, "11" /* Image */)) {
@@ -4204,9 +4265,12 @@ var VanshiSdk = (() => {
       enrichedMessage.duration = String(res.duration);
       enrichedMessage.thumbnailWidth = String(res.videoWidth);
       enrichedMessage.thumbnailHeight = String(res.videoHeight);
-      enrichedMessage.thumbnailDownloadUrl = await uploadSdkFile(res.firstFrameFile);
+      enrichedMessage.thumbnailDownloadUrl = await uploadSdkFile(
+        res.firstFrameFile,
+        res.firstFrameFile.name
+      );
     }
-    const fileDownloadUrl = await uploadSdkFile(file);
+    const fileDownloadUrl = await uploadSdkFile(file, enrichedMessage.fileName);
     enrichedMessage.fileDownloadUrl = fileDownloadUrl;
     if (isSameUid(message.type, "11" /* Image */)) {
       enrichedMessage.thumbnailDownloadUrl = fileDownloadUrl;
@@ -4215,13 +4279,29 @@ var VanshiSdk = (() => {
     return enrichedMessage;
   }
   async function sendMessage(payload) {
-    const response = await postSdkSendMessageApiRequest(payload);
+    const response = await postSdkSendMessageApiRequest({
+      ...payload,
+      message: withClientBizId(payload.message)
+    });
     return unwrapSdkData(response);
   }
-  async function sendMediaMessage(payload) {
+  async function sendMediaMessage(payload, options) {
+    const messageWithClientBizId = withClientBizId(payload.message);
+    if (options?.onMessageAttached) {
+      try {
+        options.onMessageAttached(
+          createLocalMediaMessage(
+            messageWithClientBizId,
+            payload.toConversationID,
+            payload.conversationType
+          )
+        );
+      } catch {
+      }
+    }
     const response = await postSdkSendMediaMessageApiRequest({
       ...payload,
-      message: await enrichMediaMessage(payload.message)
+      message: await enrichMediaMessage(messageWithClientBizId)
     });
     return unwrapSdkData(response);
   }

package/dist/index.mjs

@@ -717,6 +717,62 @@ var postSdkDeleteAllMessageApiRequest = (data) => {
 };
 
 // src/sdk/message.ts
+var clientBizIdSeq = 0;
+var MAX_FILE_NAME_LENGTH = 20;
+function generateClientBizId() {
+  clientBizIdSeq = (clientBizIdSeq + 1) % 1e6;
+  const timestamp = Date.now();
+  const sequence = clientBizIdSeq.toString(36);
+  const random = Math.random().toString(36).slice(2, 10);
+  return `cbiz_${timestamp}_${sequence}_${random}`;
+}
+function withClientBizId(message) {
+  return {
+    ...message,
+    clientBizId: message.clientBizId || generateClientBizId()
+  };
+}
+function truncateFileName(fileName) {
+  return fileName.length > MAX_FILE_NAME_LENGTH ? fileName.slice(0, MAX_FILE_NAME_LENGTH) : fileName;
+}
+function getDisplayFileName(file, fallback = "") {
+  return truncateFileName(file?.name || fallback || "");
+}
+function createLocalMediaMessage(message, toConversationID, conversationType) {
+  const file = message.file;
+  const localPreviewUrl = file && typeof URL !== "undefined" && URL.createObjectURL ? URL.createObjectURL(file) : void 0;
+  return {
+    massage: message.message,
+    message: message.message,
+    type: message.type,
+    extendedData: message.extendedData,
+    messageID: "",
+    orderKey: "",
+    clientSid: "",
+    localMessageID: message.clientBizId,
+    clientBizId: message.clientBizId,
+    conversationID: toConversationID,
+    conversationType,
+    senderUserID: "",
+    direction: 0,
+    sentStatus: 0,
+    timestamp: Date.now(),
+    receiptStatus: 0,
+    isServerMessage: false,
+    isBroadcastMessage: false,
+    isGroupTargetedMessage: "",
+    id: "",
+    file,
+    fileName: getDisplayFileName(file, message.fileName),
+    fileSize: file ? String(file.size) : message.fileSize || "",
+    fileDownloadUrl: message.fileDownloadUrl || localPreviewUrl || "",
+    thumbnailDownloadUrl: message.thumbnailDownloadUrl || localPreviewUrl || "",
+    thumbnailWidth: message.thumbnailWidth || "",
+    thumbnailHeight: message.thumbnailHeight || "",
+    duration: message.duration || "",
+    localPreviewUrl
+  };
+}
 async function getImageSize(file) {
   return new Promise((resolve, reject) => {
     const url = URL.createObjectURL(file);
@@ -735,9 +791,14 @@ async function getImageSize(file) {
     img.src = url;
   });
 }
-async function uploadSdkFile(file) {
+async function uploadSdkFile(file, fileName) {
   const formData = new FormData();
-  formData.append("file", file);
+  const uploadFileName = truncateFileName(fileName || file.name || "");
+  if (uploadFileName) {
+    formData.append("file", file, uploadFileName);
+  } else {
+    formData.append("file", file);
+  }
   const response = await fetch(getUploadUrl(), {
     method: "POST",
     headers: {
@@ -764,7 +825,7 @@ async function enrichMediaMessage(message) {
   }
   const enrichedMessage = {
     ...message,
-    fileName: file.name || message.fileName || "",
+    fileName: getDisplayFileName(file, message.fileName),
     fileSize: String(file.size)
   };
   if (isSameUid(message.type, "11" /* Image */)) {
@@ -779,9 +840,12 @@ async function enrichMediaMessage(message) {
     enrichedMessage.duration = String(res.duration);
     enrichedMessage.thumbnailWidth = String(res.videoWidth);
     enrichedMessage.thumbnailHeight = String(res.videoHeight);
-    enrichedMessage.thumbnailDownloadUrl = await uploadSdkFile(res.firstFrameFile);
+    enrichedMessage.thumbnailDownloadUrl = await uploadSdkFile(
+      res.firstFrameFile,
+      res.firstFrameFile.name
+    );
   }
-  const fileDownloadUrl = await uploadSdkFile(file);
+  const fileDownloadUrl = await uploadSdkFile(file, enrichedMessage.fileName);
   enrichedMessage.fileDownloadUrl = fileDownloadUrl;
   if (isSameUid(message.type, "11" /* Image */)) {
     enrichedMessage.thumbnailDownloadUrl = fileDownloadUrl;
@@ -790,13 +854,29 @@ async function enrichMediaMessage(message) {
   return enrichedMessage;
 }
 async function sendMessage(payload) {
-  const response = await postSdkSendMessageApiRequest(payload);
+  const response = await postSdkSendMessageApiRequest({
+    ...payload,
+    message: withClientBizId(payload.message)
+  });
   return unwrapSdkData(response);
 }
-async function sendMediaMessage(payload) {
+async function sendMediaMessage(payload, options) {
+  const messageWithClientBizId = withClientBizId(payload.message);
+  if (options?.onMessageAttached) {
+    try {
+      options.onMessageAttached(
+        createLocalMediaMessage(
+          messageWithClientBizId,
+          payload.toConversationID,
+          payload.conversationType
+        )
+      );
+    } catch {
+    }
+  }
   const response = await postSdkSendMediaMessageApiRequest({
     ...payload,
-    message: await enrichMediaMessage(payload.message)
+    message: await enrichMediaMessage(messageWithClientBizId)
   });
   return unwrapSdkData(response);
 }

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "type": "module",
   "name": "vanshi-sdk",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "browser": "./dist/index.js",