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

package/README.md

@@ -1,229 +1 @@
 # @meet-im/meet-bot-jssdk
-
-MeetIM Chatbot JavaScript SDK - 支持 Long Polling 消息获取和消息发送
-
-## 安装
-
-```bash
-pnpm add @meet-im/meet-bot-jssdk
-```
-
-## 快速开始
-
-### 类实例风格
-
-```typescript
-import { MeetBot } from '@meet-im/meet-bot-jssdk'
-
-const bot = new MeetBot({
-  token: 'bot_id:secret',
-  // baseUrl: 'https://staging-meet-api.miyachat.com', // 可选，默认值
-})
-
-bot.on('message', (msg) => {
-  console.log('收到消息:', msg.content)
-
-  if (msg.sessionInfo) {
-    bot.sendMessage(msg.sessionInfo, { content: `收到: ${msg.content}` })
-  }
-})
-
-bot.startPolling()
-```
-
-### 函数式风格
-
-```typescript
-import { getUpdates, 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 })
-
-for (const update of updates) {
-  if (update.message?.sessionInfo) {
-    console.log('收到消息:', update.message.content)
-
-    await sendMessage({
-      token,
-      baseUrl,
-      sessionInfo: update.message.sessionInfo,
-      msgContent: { content: '收到！' },
-    })
-  }
-}
-```
-
-## API 文档
-
-### MeetBot 类
-
-#### 构造函数
-
-```typescript
-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 或 (botId + botToken) 二选一
-
-#### 方法
-
-| 方法                                   | 说明         |
-| -------------------------------------- | ------------ |
-| `on(event, handler)`                   | 监听事件     |
-| `off(event, handler)`                  | 移除事件监听 |
-| `startPolling(options?)`               | 启动长轮询   |
-| `stopPolling()`                        | 停止轮询     |
-| `isPolling()`                          | 获取轮询状态 |
-| `getUpdates(options?)`                 | 手动获取消息 |
-| `sendMessage(sessionInfo, msgContent)` | 发送消息     |
-
-#### startPolling options
-
-| 参数           | 类型                     | 默认值 | 说明                           |
-| -------------- | ------------------------ | ------ | ------------------------------ |
-| timeout        | number                   | 30     | 长轮询超时时间（秒）           |
-| limit          | number                   | 100    | 每次拉取消息条数               |
-| retryDelay     | number                   | 1000   | 重试延迟基础时间（毫秒）       |
-| maxRetries     | number                   | 0      | 最大重试次数（0 表示无限重试） |
-| onOffsetUpdate | (offset: number) => void | -      | offset 更新回调                |
-
-#### 事件
-
-| 事件            | 参数         | 说明       |
-| --------------- | ------------ | ---------- |
-| `message`       | `MsgContent` | 收到新消息 |
-| `error`         | `Error`      | 发生错误   |
-| `polling_start` | `void`       | 轮询开始   |
-| `polling_stop`  | `void`       | 轮询停止   |
-
-### 函数式 API
-
-#### getUpdates
-
-```typescript
-getUpdates(params: GetUpdatesParams): Promise<BotUpdate[]>
-```
-
-| 参数    | 类型   | 必填 | 默认值 | 说明                    |
-| ------- | ------ | ---- | ------ | ----------------------- |
-| token   | string | 是   | -      | Bot Token               |
-| baseUrl | string | 否   | -      | API 地址                |
-| timeout | number | 否   | 0      | Long Polling 超时（秒） |
-| offset  | number | 否   | 0      | 从该 seqId 之后获取     |
-| limit   | number | 否   | 100    | 最大返回条数            |
-
-#### sendMessage
-
-```typescript
-sendMessage(params: SendMessageParams): Promise<SendMessageResult>
-```
-
-| 参数        | 类型        | 必填 | 说明      |
-| ----------- | ----------- | ---- | --------- |
-| token       | string      | 是   | Bot Token |
-| baseUrl     | string      | 否   | API 地址  |
-| sessionInfo | SessionInfo | 是   | 会话信息  |
-| msgContent  | MsgContent  | 是   | 消息内容  |
-
-## 类型定义
-
-```typescript
-type SessionType = 1 | 3 // 1: 私聊, 3: 群聊
-
-interface SessionInfo {
-  firstID: number // 会话第一方 ID
-  secondID: number // 会话第二方 ID（私聊为用户ID，群聊为群ID）
-  sessionType: SessionType
-  companyID?: number
-}
-
-type MsgType = 'NORMAL' | 'RECALL' | 'QUOTE'
-
-interface ExtraInfo {
-  msgType?: MsgType
-  [key: string]: unknown
-}
-
-interface MsgContent {
-  content: string // 消息文本内容
-  seqId?: number // 消息序列号
-  timestamp?: number // 时间戳（秒）
-  fromUid?: number // 发送者 UID
-  atIds?: number[] // @用户 ID 列表
-  extraInfo?: ExtraInfo // 额外信息
-  sessionInfo?: SessionInfo
-}
-
-interface BotUpdate {
-  message?: MsgContent
-}
-
-interface SendMessageResult {
-  msgContent: MsgContent
-  quoteMsg: unknown
-  userProfileMap: Record<number, unknown>
-}
-```
-
-## 错误处理
-
-SDK 提供以下错误类型：
-
-| 错误类            | 说明           |
-| ----------------- | -------------- |
-| `MeetBotError`    | 基础错误类     |
-| `ApiError`        | API 返回的错误 |
-| `NetworkError`    | 网络连接错误   |
-| `TimeoutError`    | 请求超时错误   |
-| `ValidationError` | 参数验证错误   |
-
-```typescript
-import { ApiError, NetworkError } from '@meet-im/meet-bot-jssdk'
-
-try {
-  await bot.sendMessage(sessionInfo, { content: 'Hello' })
-} catch (error) {
-  if (error instanceof ApiError) {
-    console.error('API 错误:', error.code, error.statusCode)
-  } else if (error instanceof NetworkError) {
-    console.error('网络错误:', error.message)
-  }
-}
-```
-
-## 开发
-
-```bash
-# 安装依赖
-pnpm install
-
-# 构建
-pnpm build
-
-# 测试
-pnpm test
-
-# 类型检查
-pnpm typecheck
-
-# 代码格式化
-pnpm format
-
-# 代码检查
-pnpm lint
-```
-
-## License
-
-MIT