@meet-im/meet-bot-jssdk 0.0.7 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # @meet-im/meet-bot-jssdk
 
-MeetIM Chatbot JavaScript SDK - 支持 Long Polling 消息获取和消息发送
+MeetIM Chatbot JavaScript SDK - 支持 Long Polling 消息获取、消息发送和媒体文件处理
 
 ## 安装
 
@@ -17,14 +17,30 @@ import { MeetBot } from '@meet-im/meet-bot-jssdk'
 
 const bot = new MeetBot({
   token: 'bot_id:secret',
-  // baseUrl: 'https://staging-meet-api.miyachat.com', // 可选，默认值
+  useV2: true, // 启用 getUpdatesV2，支持引用消息
 })
 
-bot.on('message', (msg) => {
-  console.log('收到消息:', msg.content)
+bot.on('message', ({ message, quoteMsgMap }) => {
+  console.log('收到消息:', message.content)
+
+  // 处理引用消息
+  if (message.quoteSeqID && message.sessionInfo) {
+    const { getConvID, getQuoteMsgKey } = await import('@meet-im/meet-bot-jssdk')
+    const convID = getConvID(
+      message.sessionInfo.firstID,
+      message.sessionInfo.secondID,
+      message.sessionInfo.sessionType,
+      message.sessionInfo.companyID
+    )
+    const quoteKey = getQuoteMsgKey(convID, message.quoteSeqID)
+    const quoteMsg = quoteMsgMap[quoteKey]
+    if (quoteMsg) {
+      console.log('引用消息:', quoteMsg.content)
+    }
+  }
 
-  if (msg.sessionInfo) {
-    bot.sendMessage(msg.sessionInfo, { content: `收到: ${msg.content}` })
+  if (message.sessionInfo) {
+    bot.sendMessage(message.sessionInfo, { content: `收到: ${message.content}` })
   }
 })
 
@@ -34,21 +50,21 @@ bot.startPolling()
 ### 函数式风格
 
 ```typescript
-import { getUpdates, sendMessage } from '@meet-im/meet-bot-jssdk'
+import { getUpdatesV2, sendMessage } from '@meet-im/meet-bot-jssdk'
 
 const token = 'bot_id:secret'
 const baseUrl = 'https://staging-meet-api.miyachat.com'
 
-const updates = await getUpdates({ token, baseUrl })
+const { msgs, quoteMsgMap } = await getUpdatesV2({ token, baseUrl })
 
-for (const update of updates) {
-  if (update.message?.sessionInfo) {
-    console.log('收到消息:', update.message.content)
+for (const { message } of msgs) {
+  if (message.sessionInfo) {
+    console.log('收到消息:', message.content)
 
     await sendMessage({
       token,
       baseUrl,
-      sessionInfo: update.message.sessionInfo,
+      sessionInfo: message.sessionInfo,
       msgContent: { content: '收到！' },
     })
   }
@@ -65,28 +81,37 @@ for (const update of updates) {
 new MeetBot(config: MeetBotConfig)
 ```
 
-| 参数               | 类型             | 必填 | 说明                                                   |
-| ------------------ | ---------------- | ---- | ------------------------------------------------------ |
-| token              | string           | 是\* | Bot Token，格式：`bot_id:secret`                       |
-| botId              | string \| number | 是\* | Bot ID（与 botToken 配合使用）                         |
-| botToken           | string           | 是\* | Bot Token（与 botId 配合使用）                         |
-| baseUrl            | string           | 否   | API 地址，默认 `https://staging-meet-api.miyachat.com` |
-| pollingLimit       | number           | 否   | 每次拉取消息条数，默认 100                             |
-| longPollingTimeout | number           | 否   | 长轮询超时时间（秒），默认 30                          |
+| 参数               | 类型               | 必填 | 说明                                                   |
+| ------------------ | ------------------ | ---- | ------------------------------------------------------ |
+| token              | string             | 是\* | Bot Token，格式：`bot_id:secret`                       |
+| botId              | string \| number   | 是\* | Bot ID（与 botToken 配合使用）                         |
+| botToken           | string             | 是\* | Bot Token（与 botId 配合使用）                         |
+| baseUrl            | string             | 否   | API 地址，默认 `https://staging-meet-api.miyachat.com` |
+| pollingLimit       | number             | 否   | 每次拉取消息条数，默认 100                             |
+| longPollingTimeout | number             | 否   | 长轮询超时时间（秒），默认 30                          |
+| useV2              | boolean            | 否   | 使用 getUpdatesV2 接口，默认 false                     |
+| logLevel           | 'silent' \| 'info' | 否   | 日志级别，默认 'silent'                                |
 
 \*token 或 (botId + botToken) 二选一
 
 #### 方法
 
-| 方法                                   | 说明         |
-| -------------------------------------- | ------------ |
-| `on(event, handler)`                   | 监听事件     |
-| `off(event, handler)`                  | 移除事件监听 |
-| `startPolling(options?)`               | 启动长轮询   |
-| `stopPolling()`                        | 停止轮询     |
-| `isPolling()`                          | 获取轮询状态 |
-| `getUpdates(options?)`                 | 手动获取消息 |
-| `sendMessage(sessionInfo, msgContent)` | 发送消息     |
+| 方法                                   | 说明               |
+| -------------------------------------- | ------------------ |
+| `on(event, handler)`                   | 监听事件           |
+| `off(event, handler)`                  | 移除事件监听       |
+| `startPolling(options?)`               | 启动长轮询         |
+| `stopPolling()`                        | 停止轮询           |
+| `isPolling()`                          | 获取轮询状态       |
+| `getUpdates(options?)`                 | 手动获取消息（V1） |
+| `getUpdatesV2(options?)`               | 手动获取消息（V2） |
+| `sendMessage(sessionInfo, msgContent)` | 发送消息           |
+| `getUploadURL(params)`                 | 获取单文件上传地址 |
+| `getMultiPartUploadURL(params)`        | 获取分片上传地址   |
+| `completeMultipartUpload(params)`      | 完成分片上传       |
+| `getAccessURL(params)`                 | 获取文件下载地址   |
+| `uploadFile(buffer, options)`          | 上传文件           |
+| `sendMedia(sessionInfo, options)`      | 发送媒体消息       |
 
 #### startPolling options
 
@@ -100,16 +125,16 @@ new MeetBot(config: MeetBotConfig)
 
 #### 事件
 
-| 事件            | 参数         | 说明       |
-| --------------- | ------------ | ---------- |
-| `message`       | `MsgContent` | 收到新消息 |
-| `error`         | `Error`      | 发生错误   |
-| `polling_start` | `void`       | 轮询开始   |
-| `polling_stop`  | `void`       | 轮询停止   |
+| 事件            | 参数                                   | 说明       |
+| --------------- | -------------------------------------- | ---------- |
+| `message`       | `{ message: MsgContent, quoteMsgMap }` | 收到新消息 |
+| `error`         | `Error`                                | 发生错误   |
+| `polling_start` | `void`                                 | 轮询开始   |
+| `polling_stop`  | `void`                                 | 轮询停止   |
 
 ### 函数式 API
 
-#### getUpdates
+#### getUpdates（已废弃）
 
 ```typescript
 getUpdates(params: GetUpdatesParams): Promise<BotUpdate[]>
@@ -123,6 +148,28 @@ getUpdates(params: GetUpdatesParams): Promise<BotUpdate[]>
 | offset  | number | 否   | 0      | 从该 seqId 之后获取     |
 | limit   | number | 否   | 100    | 最大返回条数            |
 
+#### getUpdatesV2（推荐）
+
+```typescript
+getUpdatesV2(params: GetUpdatesV2Params): Promise<GetUpdatesV2Result>
+```
+
+| 参数    | 类型   | 必填 | 默认值 | 说明                    |
+| ------- | ------ | ---- | ------ | ----------------------- |
+| token   | string | 是   | -      | Bot Token               |
+| baseUrl | string | 否   | -      | API 地址                |
+| timeout | number | 否   | 0      | Long Polling 超时（秒） |
+| limit   | number | 否   | 100    | 最大返回条数            |
+
+返回值：
+
+```typescript
+interface GetUpdatesV2Result {
+  msgs: { message: MsgContent }[]
+  quoteMsgMap: Record<string, MsgContent> // key: "convID:seqID"
+}
+```
+
 #### sendMessage
 
 ```typescript
@@ -136,32 +183,118 @@ sendMessage(params: SendMessageParams): Promise<SendMessageResult>
 | sessionInfo | SessionInfo | 是   | 会话信息  |
 | msgContent  | MsgContent  | 是   | 消息内容  |
 
+### 媒体文件 API
+
+#### getUploadURL
+
+获取单文件上传签名地址。
+
+```typescript
+getUploadURL(params): Promise<UploadURLResult>
+```
+
+| 参数           | 类型   | 必填 | 说明             |
+| -------------- | ------ | ---- | ---------------- |
+| token          | string | 是   | Bot Token        |
+| originFileName | string | 是   | 原始文件名       |
+| contentType    | string | 是   | MIME 类型        |
+| md5            | string | 是   | 格式：`md5_hash` |
+| size           | number | 是   | 文件大小（字节） |
+
+#### getAccessURL
+
+获取文件下载地址。
+
+```typescript
+// 方式1：完整参数
+getAccessURL({ token, firstId, secondId, sessionType, seqId, fileId })
+
+// 方式2：使用 sessionInfo
+getAccessURL({ token, sessionInfo, seqId, fileId })
+```
+
+#### uploadFile
+
+上传文件（自动选择单文件或分片上传）。
+
+```typescript
+uploadFile(token, buffer, { fileName, contentType, onProgress? })
+```
+
+#### sendMedia
+
+发送媒体消息（上传并发送）。
+
+```typescript
+sendMedia(token, sessionInfo, { buffer, fileName, contentType, content?, onProgress? })
+```
+
+### 工具函数
+
+#### getConvID
+
+生成会话 ID。
+
+```typescript
+import { getConvID } from '@meet-im/meet-bot-jssdk'
+
+const convID = getConvID(firstID, secondID, sessionType, companyID?)
+```
+
+| 会话类型 | convID 格式                            |
+| -------- | -------------------------------------- |
+| 私聊 (1) | `min:max` 或 `min:max:companyID`       |
+| 群聊 (3) | `firstID+secondID` 或追加 `+companyID` |
+| 频道     | `firstID_secondID` 或追加 `_companyID` |
+
+#### getQuoteMsgKey
+
+生成引用消息的 key。
+
+```typescript
+import { getQuoteMsgKey } from '@meet-im/meet-bot-jssdk'
+
+const key = getQuoteMsgKey(convID, seqID) // "convID:seqID"
+```
+
 ## 类型定义
 
 ```typescript
 type SessionType = 1 | 3 // 1: 私聊, 3: 群聊
 
 interface SessionInfo {
-  firstID: number // 会话第一方 ID
-  secondID: number // 会话第二方 ID（私聊为用户ID，群聊为群ID）
+  firstID: number
+  secondID: number
   sessionType: SessionType
   companyID?: number
 }
 
 type MsgType = 'NORMAL' | 'RECALL' | 'QUOTE'
 
+interface AttachmentInfo {
+  fileID: string | number
+  fileName?: string
+  filePath?: string
+  fileSize?: number
+  mimeType?: string
+  fileUrl?: string
+}
+
 interface ExtraInfo {
   msgType?: MsgType
+  attechmentInfo?: AttachmentInfo // 单附件
+  attechmentInfos?: AttachmentInfo[] // 多附件
   [key: string]: unknown
 }
 
 interface MsgContent {
-  content: string // 消息文本内容
-  seqId?: number // 消息序列号
-  timestamp?: number // 时间戳（秒）
-  fromUid?: number // 发送者 UID
-  atIds?: number[] // @用户 ID 列表
-  extraInfo?: ExtraInfo // 额外信息
+  content: string
+  seqId?: number
+  timestamp?: number
+  fromUid?: number
+  atIds?: number[]
+  quoteSeqID?: number // 引用消息 seqID
+  extraInfo?: ExtraInfo
   sessionInfo?: SessionInfo
 }
 
@@ -169,6 +302,11 @@ interface BotUpdate {
   message?: MsgContent
 }
 
+interface GetUpdatesV2Result {
+  msgs: { message: MsgContent }[]
+  quoteMsgMap: Record<string, MsgContent>
+}
+
 interface SendMessageResult {
   msgContent: MsgContent
   quoteMsg: unknown

package/dist/index.cjs

@@ -128,6 +128,11 @@ var CHUNK_RULES = [
   { maxSize: Infinity, chunks: 50 }
   // > 100MB: 50 片
 ];
+var SESSION_TYPE = {
+  PRIVATE: 1,
+  GROUP: 3,
+  CHANNEL: 4
+};
 function getChunkNum(size) {
   for (const rule of CHUNK_RULES) {
     if (size < rule.maxSize) {
@@ -136,6 +141,31 @@ function getChunkNum(size) {
   }
   return 50;
 }
+function getConvID(firstID, secondID, sessionType, companyID = 1) {
+  let convID;
+  if (sessionType === SESSION_TYPE.PRIVATE) {
+    const min = Math.min(firstID, secondID);
+    const max = Math.max(firstID, secondID);
+    convID = `${min}:${max}`;
+    if (companyID > 1) {
+      convID += `:${companyID}`;
+    }
+  } else if (sessionType === SESSION_TYPE.GROUP) {
+    convID = `${firstID}+${secondID}`;
+    if (companyID > 1) {
+      convID += `+${companyID}`;
+    }
+  } else {
+    convID = `${firstID}_${secondID}`;
+    if (companyID > 1) {
+      convID += `_${companyID}`;
+    }
+  }
+  return convID;
+}
+function getQuoteMsgKey(convID, seqID) {
+  return `${convID}:${seqID}`;
+}
 
 // src/utils/logger.ts
 var Logger = class {
@@ -337,9 +367,8 @@ async function getAccessURL(params) {
       sessionType: queryParams.sessionType,
       seqId: queryParams.seqId,
       fileId: queryParams.fileId,
+      companyId: queryParams.companyId,
       "x-oss-process": queryParams["x-oss-process"],
-      origin: queryParams.origin,
-      bestDomain: queryParams.bestDomain,
       printResult: queryParams.printResult ?? "1"
     }
   });
@@ -534,6 +563,20 @@ async function getUpdates(params) {
     timeout: (timeout || 0) * 1e3 + HTTP.POLLING_TIMEOUT_BUFFER
   });
 }
+async function getUpdatesV2(params) {
+  const { token, baseUrl, timeout = API.DEFAULT_TIMEOUT, limit = API.DEFAULT_LIMIT } = params;
+  return request({
+    token,
+    baseUrl,
+    method: "POST",
+    path: "getUpdatesV2",
+    body: {
+      timeout,
+      limit
+    },
+    timeout: (timeout || 0) * 1e3 + HTTP.POLLING_TIMEOUT_BUFFER
+  });
+}
 async function sendMessage(params) {
   const { token, baseUrl, sessionInfo, msgContent } = params;
   const hasContent = msgContent.content && msgContent.content.trim() !== "";
@@ -561,6 +604,7 @@ var MeetBot = class {
   baseUrl;
   pollingLimit;
   longPollingTimeout;
+  useV2;
   eventHandlers = /* @__PURE__ */ new Map();
   polling = false;
   offset = 0;
@@ -579,6 +623,7 @@ var MeetBot = class {
     this.baseUrl = config.baseUrl || DEFAULT_BASE_URL;
     this.pollingLimit = config.pollingLimit ?? POLLING.DEFAULT_LIMIT;
     this.longPollingTimeout = config.longPollingTimeout ?? POLLING.DEFAULT_TIMEOUT;
+    this.useV2 = config.useV2 ?? false;
     logger.setLevel(config.logLevel ?? "silent");
   }
   on(event, handler) {
@@ -618,7 +663,7 @@ var MeetBot = class {
     this.abortController = new AbortController();
     const limit = options?.limit ?? this.pollingLimit;
     const timeout = options?.timeout ?? this.longPollingTimeout;
-    logger.info(`\u5F00\u59CB\u957F\u8F6E\u8BE2\u6D88\u606F... (\u6761\u6570: ${limit}, \u8D85\u65F6: ${timeout}s)`);
+    logger.info(`\u5F00\u59CB\u957F\u8F6E\u8BE2\u6D88\u606F... (\u6761\u6570: ${limit}, \u8D85\u65F6: ${timeout}s, V2: ${this.useV2})`);
     this.emit("polling_start", void 0);
     const retryDelay = options?.retryDelay ?? POLLING.DEFAULT_RETRY_DELAY;
     const maxRetries = options?.maxRetries ?? POLLING.DEFAULT_MAX_RETRIES;
@@ -626,20 +671,35 @@ var MeetBot = class {
     let retryCount = 0;
     while (this.polling) {
       try {
-        const updates = await getUpdates({
-          token: this.token,
-          baseUrl: this.baseUrl,
-          timeout,
-          offset: this.offset,
-          limit
-        });
-        retryCount = 0;
-        for (const update of updates) {
-          if (update.message) {
-            this.emit("message", update.message);
-            this.offset = (update.message.seqId || 0) + 1;
+        if (this.useV2) {
+          const result = await getUpdatesV2({
+            token: this.token,
+            baseUrl: this.baseUrl,
+            timeout,
+            limit
+          });
+          retryCount = 0;
+          for (const msgUpdate of result.msgs) {
+            this.emit("message", { message: msgUpdate.message, quoteMsgMap: result.quoteMsgMap });
+            this.offset = (msgUpdate.message.seqId || 0) + 1;
             onOffsetUpdate?.(this.offset);
           }
+        } else {
+          const updates = await getUpdates({
+            token: this.token,
+            baseUrl: this.baseUrl,
+            timeout,
+            offset: this.offset,
+            limit
+          });
+          retryCount = 0;
+          for (const update of updates) {
+            if (update.message) {
+              this.emit("message", { message: update.message, quoteMsgMap: {} });
+              this.offset = (update.message.seqId || 0) + 1;
+              onOffsetUpdate?.(this.offset);
+            }
+          }
         }
         await this.sleep(POLLING.SUCCESS_DELAY);
       } catch (error) {
@@ -670,6 +730,13 @@ var MeetBot = class {
       ...options
     });
   }
+  async getUpdatesV2(options) {
+    return getUpdatesV2({
+      token: this.token,
+      baseUrl: this.baseUrl,
+      ...options
+    });
+  }
   async sendMessage(sessionInfo, msgContent) {
     return sendMessage({
       token: this.token,
@@ -712,10 +779,18 @@ var MeetBot = class {
    * 获取文件下载地址
    */
   async getAccessURL(params) {
+    const apiParams = "sessionInfo" in params ? {
+      firstId: params.sessionInfo.firstID,
+      secondId: params.sessionInfo.secondID,
+      sessionType: params.sessionInfo.sessionType,
+      seqId: params.seqId,
+      fileId: params.fileId,
+      printResult: params.printResult
+    } : params;
     return getAccessURL({
       token: this.token,
       baseUrl: this.baseUrl,
-      ...params
+      ...apiParams
     });
   }
   /**
@@ -744,13 +819,17 @@ exports.DEFAULT_BASE_URL = DEFAULT_BASE_URL;
 exports.HTTP = HTTP;
 exports.MeetBot = MeetBot;
 exports.POLLING = POLLING;
+exports.SESSION_TYPE = SESSION_TYPE;
 exports.UPLOAD = UPLOAD;
 exports.completeMultipartUpload = completeMultipartUpload;
 exports.computeMD5 = computeMD5;
 exports.getAccessURL = getAccessURL;
 exports.getChunkNum = getChunkNum;
+exports.getConvID = getConvID;
 exports.getMultiPartUploadURL = getMultiPartUploadURL;
+exports.getQuoteMsgKey = getQuoteMsgKey;
 exports.getUpdates = getUpdates;
+exports.getUpdatesV2 = getUpdatesV2;
 exports.getUploadURL = getUploadURL;
 exports.sendMediaMessage = sendMediaMessage;
 exports.sendMessage = sendMessage;