@cg-devcenter/rtc-fpnn-webjs-sdk 1.0.0-cg.2

package/docs/TLV.md

@@ -0,0 +1,62 @@
+# TLV v1 传输 API
+
+TLV v1 使用 MessagePack over WebSocket。公开方法见 [SDK API](USAGE.md)，完整 URI 与字段见
+[TLV v1 Client 契约](TLV_CONTRACT.md)。
+
+## 连接接口
+
+| 项目 | 规则 |
+| --- | --- |
+| 协议模式 | `protocol: 'tlv-v1'` |
+| 端点 | `tlvEndpoint` 为完整 `ws://` 或 `wss://` URL |
+| WebSocket | 每个 binary message 恰好一个完整 TLV frame |
+| 非浏览器运行时 | 提供 `webSocketFactory(url)`；旧 `fpnn` 不可用 |
+| 鉴权 | `login(uid, credential, callback, timeout)`；仅 `accepted === true` 进入登录态 |
+
+## Frame 接口
+
+| 字段 | 规则 |
+| --- | --- |
+| Header | `magic=0xCC`、`version=1`、`flags=0x04`、正整数 little-endian `sequence` |
+| Metadata | 唯一 `mt`，值为 `'0'`、`'1'` 或 `'2'` |
+| Message | 唯一 URI、空 `passThrough`、MessagePack map body |
+| WebSocket body | 仅 binary；不含 TCP length header |
+
+| 方向 | `mt` | URI |
+| --- | --- | --- |
+| Client → Gate 请求 | `'1'` | 业务 URI、`control.ping`、`connection.close` |
+| Gate → Client 应答 | `'2'` | 原请求 URI 或 `control.error` |
+| Gate → Client 可靠 Push | `'1'` | `event.direct`、`event.group`、`event.room`、`event.broadcast` |
+| Client → Gate Push ACK | `'2'` | `control.ack` |
+| Gate → Client 控制 Push | `'0'` | `event.kicked`、`event.room_removed` |
+
+## 编码接口
+
+- body 必须是 string-keyed MessagePack map；无参数 body 为 `{}`。
+- 整数使用安全 JavaScript 整数或 `RTMConfig.Int64`；不得以十进制字符串替代整数。
+- `payload` 支持 string、MessagePack bin 或 Chat map；按实际 MessagePack 类型读取。
+- `Uint8Array`、`ArrayBuffer`、`Buffer` 和 typed array 编码为 MessagePack bin。
+- `requestMetadata()` 可附加 `trace:string`、`sent_ms:int64`。
+
+## 控制 API
+
+| URI | 请求/响应 body | 行为 |
+| --- | --- | --- |
+| `control.ping` | `{}` / `{}` | SDK 空闲心跳。 |
+| `control.ack` | `{}` | 复用可靠 Push sequence；无需应答。 |
+| `control.error` | `{status:int32, reason:string}` | Gate 请求失败应答。 |
+| `connection.close` | `{}` / `{}` | Gate 应答后关闭连接。 |
+
+## Push 接口
+
+| URI | SDK 事件 | ACK |
+| --- | --- | --- |
+| `event.direct` | `TLV_SERVER_PUSH.recvMessage` | 自动 |
+| `event.group` | `TLV_SERVER_PUSH.recvGroupMessage` | 自动 |
+| `event.room` | `TLV_SERVER_PUSH.recvRoomMessage` | 自动 |
+| `event.broadcast` | `TLV_SERVER_PUSH.recvBroadcastMessage` | 自动 |
+| `event.kicked` | `TLV_SERVER_PUSH.kickOut` | 不发送 |
+| `event.room_removed` | `TLV_SERVER_PUSH.kickOutRoom` | 不发送 |
+
+可靠 Push 以 `message_ref` 去重；每次重传仍发送 ACK。协议错误、心跳失败或连接关闭会失败当前
+pending 请求；SDK 不重放结果未知的修改请求。

package/docs/TLV_CONTRACT.md

@@ -0,0 +1,180 @@
+# TLV v1 Client API 契约
+
+本页定义 `RTMClient` 的 TLV v1 URI、请求字段与成功返回字段。公开方法参数见
+[SDK API](USAGE.md)，传输规则见 [TLV v1 传输 API](TLV.md)。
+
+## 类型与回调
+
+| 标记 | 含义 |
+| --- | --- |
+| `id` / `i64` | `id` 为正整数，`i64` 为 signed int64；超出安全整数范围使用 `RTMConfig.Int64`。 |
+| `i32` | MessagePack integer。 |
+| `str` | UTF-8 string。 |
+| `bin` | MessagePack binary。 |
+| `id[]` | ID 数组；请求是否允许空数组由对应 URI 规定。 |
+| `str-map` | `map<string, string>`。 |
+| `tuple8` | `[cursor_id, sender_or_direction, kind, message_ref, deleted, payload, extra, time_ms]`；`cursor_id` 为不透明 int64 游标，不是 `message_ref`。 |
+| `?` | 可选字段；未标记 `?` 的字段为必填。 |
+
+表中的 `Gate Answer` 是 Gate 的 TLV body；除特别说明的兼容包装外，SDK 将其作为 `data`
+传给 `callback(err, data)`。`login` 为 `callback(accepted, errorCode)`。所有请求可由
+`requestMetadata` 附加 `trace:str`、`sent_ms:i64`。
+
+## 控制 URI 与 Push
+
+| URI | `mt` | body |
+| --- | --- | --- |
+| `control.ping` | `'1'` / `'2'` | `{}` |
+| `control.ack` | `'2'` | `{}` |
+| `control.error` | `'2'` | `{status:i32, reason:str}` |
+| `event.direct` | `'1'` | `recipient, sender, message_ref, kind, payload, extra, time_ms` |
+| `event.group` | `'1'` | `group_ref, sender, message_ref, kind, payload, extra, time_ms` |
+| `event.room` | `'1'` | `room_ref, sender, message_ref, kind, payload, extra, time_ms` |
+| `event.broadcast` | `'1'` | `sender, message_ref, kind, payload, extra, time_ms` |
+| `event.kicked` | `'0'` | `{}` |
+| `event.room_removed` | `'0'` | `{room_ref:id}` |
+
+可靠 Push 自动回复 `control.ack` 并按 `message_ref` 去重；`event.kicked` 与
+`event.room_removed` 不回复 ACK。
+
+## Auth、连接与系统
+
+| SDK API | Gate URI | 请求字段 | Gate Answer |
+| --- | --- | --- | --- |
+| `login` | `auth.login` | `project, user, credential, client_ver, auth_sec?, auth_ver?, locale?, props?` | `accepted` |
+| `bye` | `connection.close` | 无 | 无 |
+| `getServerTime` | `system.time` | 无 | `server_ms` |
+| `addAttrs` | `connection.set_props` | `props` | 无 |
+| `getAttrs` | `connection.get_props` | 无 | `props` |
+| `addDebugLog` | `system.debug` | `entry, context` | 无 |
+
+`auth_sec` 与 `auth_ver` 必须同时存在或同时省略；存在时 `auth_ver` 必须为 `2`。
+
+## 用户、存储与黑名单
+
+| SDK API | Gate URI | 请求字段 | Gate Answer |
+| --- | --- | --- | --- |
+| `getOnlineUsers` | `presence.online` | `users` | `online_users` |
+| `setUserInfo` | `user.set_profile` | `public_data?, private_data?` | 无 |
+| `getUserInfo` | `user.get_profile` | 无 | `public_data, private_data` |
+| `getUserOpenInfo` | `user.get_public` | `users` | `profiles` |
+| `setTranslationLanguage` | `user.set_locale` | `locale` | `updated` |
+| `dataGet` | `storage.get` | `slot` | `value` |
+| `dataSet` | `storage.set` | `slot, value` | 无 |
+| `dataDelete` | `storage.delete` | `slot` | 无 |
+| `addBlacks` | `blacklist.add` | `blocked_users` | 无 |
+| `deleteBlacks` | `blacklist.remove` | `blocked_users` | 无 |
+| `getBlacks` | `blacklist.list` | 无 | `blocked_users` |
+
+`getOnlineUsers`、`getBlacks` 的 SDK 回调 data 均为 `RTMConfig.Int64[]`，不是 Gate Answer map。
+
+## 群组
+
+| SDK API | Gate URI | 请求字段 | Gate Answer |
+| --- | --- | --- | --- |
+| `addGroupMembers` | `group.add` | `group_ref, members` | 无 |
+| `deleteGroupMembers` | `group.remove` | `group_ref, members` | 无 |
+| `getGroupMembers` | `group.members` | `group_ref, with_online?` | `members, active_members?` |
+| `getGroupCount` | `group.count` | `group_ref, with_online?` | `total, active_total?` |
+| `getUserGroups` | `group.joined` | 无 | `group_refs` |
+| `setGroupInfo` | `group.set_profile` | `group_ref, public_data?, private_data?` | 无 |
+| `getGroupInfo` | `group.get_profile` | `group_ref` | `public_data, private_data` |
+| `getGroupOpenInfo` | `group.get_public` | `group_ref` | `public_data` |
+| `getGroupsOpenInfo` | `group.get_public_batch` | `group_refs` | `profiles` |
+
+`getUserGroups` 的 SDK 回调 data 为 `RTMConfig.Int64[]`，不是 `{group_refs}`。
+
+## 房间
+
+| SDK API | Gate URI | 请求字段 | Gate Answer |
+| --- | --- | --- | --- |
+| `enterRoom` | `room.join` | `room_ref` | 无 |
+| `enterRooms` | `room.join_batch` | `room_refs` | 无 |
+| `leaveRoom` | `room.leave` | `room_ref` | 无 |
+| `getUserRooms` | `room.joined` | 无 | `room_refs` |
+| `getRoomMembers` | `room.members` | `room_ref` | `members` |
+| `getRoomCount` | `room.counts` | `room_refs` | `totals` |
+| `setRoomInfo` / `setRoomProfile` | `room.set_profile` | `room_ref, public_data?, private_data?, label?, avatar?` | 无 |
+| `getRoomInfo` | `room.get_profile` | `room_ref` | `public_data, private_data` |
+| `getRoomOpenInfo` | `room.get_public` | `room_ref` | `public_data` |
+| `getRoomsOpenInfo` | `room.get_public_batch` | `room_refs` | `profiles` |
+| `getUserRoomsAndLastMessage` | `room.last_messages` | `kinds?` | `last_by_room` |
+
+`last_by_room` 的 key 为十进制房间 ID，value 为 `tuple8`。
+`getUserRooms` 的 SDK 回调 data 为 `RTMConfig.Int64[]`，不是 `{room_refs}`。
+
+## 消息发送、审核与翻译
+
+| SDK API | Gate URI | 请求字段 | Gate Answer |
+| --- | --- | --- | --- |
+| `sendMessage` | `message.send` | `recipient, message_ref, kind, payload, extra, strategyid?, checkParams?` | `message_ref, time_ms` |
+| `sendMessages` | `message.send_batch` | `recipients, message_ref, kind, payload, extra` | `message_ref, time_ms` |
+| `sendGroupMessage` | `message.send_group` | `group_ref, message_ref, kind, payload, extra, strategyid?, checkParams?` | `message_ref, time_ms` |
+| `sendRoomMessage` | `message.send_room` | `room_ref, message_ref, kind, payload, extra, strategyid?, checkParams?` | `message_ref, time_ms` |
+| `textCheck` | `moderation.check` | `payload, strategyId?, checkParams?, zone?` | `decision, filtered, detected_locale, matches?` |
+| `translate` | `translation.run` | `input, to_locale, from_locale?, format, filter_mode` | `detected_locale, resolved_locale, original, translated, from_locale, to_locale, input, output` |
+
+`sendMessage`、`sendMessages`、`sendGroupMessage`、`sendRoomMessage` 的 SDK 成功回调为
+`callback(null, {message_ref, payload: {message_ref, time_ms}})`；失败回调为
+`callback({message_ref, error}, null)`。
+
+## 历史、单条消息与撤回
+
+历史分页字段：`reverse, limit, start_ms, end_ms, cursor, kinds?`；返回 `HistoryResult`：
+`size, items, next, first_ms, last_ms`。`items` 的元素为 `tuple8`。
+
+| SDK API | Gate URI | 额外请求字段 | Gate Answer |
+| --- | --- | --- | --- |
+| `getP2PMessage` | `history.direct` | `peer` | `HistoryResult` |
+| `getGroupMessage` | `history.group` | `group_ref` | `HistoryResult` |
+| `getRoomMessage` | `history.room` | `room_ref` | `HistoryResult` |
+| `getBroadcastMessage` | `history.broadcast` | 无 | `HistoryResult` |
+| `getP2PMessageByMessageId` | `history.direct_anchor` | `peer, anchor, reverse, limit, start_ms, end_ms, kinds?` | `HistoryResult` |
+| `getGroupMessageByMessageId` | `history.group_anchor` | `group_ref, anchor, reverse, limit, start_ms, end_ms, kinds?` | `HistoryResult` |
+| `getRoomMessageByMessageId` | `history.room_anchor` | `room_ref, anchor, reverse, limit, start_ms, end_ms, kinds?` | `HistoryResult` |
+| `getBroadcastMessageByMessageId` | `history.broadcast_anchor` | `anchor, reverse, limit, start_ms, end_ms, kinds?` | `HistoryResult` |
+| `getP2PMessageCount` | `history.direct_count` | `peer, start_ms, end_ms, kinds?` | `total` |
+| `getGroupMessageCount` | `history.group_count` | `group_ref, start_ms, end_ms, kinds?` | `total` |
+| `getRoomMessageCount` | `history.room_count` | `room_ref, start_ms, end_ms, kinds?` | `total` |
+| `getBroadcastMessageCount` | `history.broadcast_count` | `start_ms, end_ms, kinds?` | `total` |
+| `getMessage` | `message.get` | `sender, message_ref, target_ref, channel` | `sequence, message_ref, sender, kind, payload, extra, time_ms` |
+| `deleteMessage` | `message.revoke` | `sender, message_ref, target_ref, channel` | 无 |
+
+`getP2PChat`、`getGroupChat`、`getRoomChat`、`getBroadcastChat` 复用相应 history URI；
+`getChat`、`deleteChat` 分别复用 `message.get`、`message.revoke`。
+
+## 未读、会话与会话列表
+
+| SDK API | Gate URI | 请求字段 | Gate Answer |
+| --- | --- | --- | --- |
+| `getUnreadMessage` | `unread.summary` | `mark_read, with_logout?` | `peers, group_refs, logout_sec?` |
+| `getSession` | `session.list` | 无 | `peers, group_refs` |
+| `cleanUnreadMessage` | `unread.clear` | 无 | 无 |
+| `setSessionRead` | `session.read` | `channel, target_ref, through` | 无 |
+| `getP2PUnreadMessageNum` | `unread.direct` | `peers, since_ms?, kinds?` | `counts, times` |
+| `getGroupUnreadMessageNum` | `unread.group` | `group_refs, since_ms?, kinds?` | `counts, times` |
+| `removeSession` | `session.remove` | `peer, local_only` | 无 |
+| `getP2PConversationList` | `conversation.direct` | `since_ms?, kinds?` | `peers, badges, last_items` |
+| `getP2PUnreadConversationList` | `conversation.direct_unread` | `since_ms?, kinds?` | `peers, badges, last_items` |
+| `getGroupConversationList` | `conversation.group` | `since_ms?, kinds?` | `group_refs, badges, last_items` |
+| `getGroupUnreadConversationList` | `conversation.group_unread` | `since_ms?, kinds?` | `group_refs, badges, last_items` |
+| `getUnreadConversationList` | `conversation.unread` | `mark_read, since_ms?, kinds?` | `group_refs, group_badges, group_last, peers, peer_badges, peer_last` |
+
+## 状态
+
+| status | 接口含义 |
+| ---: | --- |
+| `10009` / `10010` | 字段缺失或类型不匹配。 |
+| `200010` | 限流。 |
+| `200020` | TLV 未开放能力。 |
+| `200021` | 权限不足。 |
+| `200022` | 未鉴权。 |
+| `200023` | 重复鉴权。 |
+| `200024` / `200027` | credential 拒绝或失效。 |
+| `200030` | payload 或 extra 超限。 |
+| `200032` / `200033` | 批量或空参数非法。 |
+| `200034` | 契约字段、类型或范围非法。 |
+| `200040` / `200041` | 房间或群组成员状态不满足。 |
+| `200053` | `message_ref` 重复。 |
+| `200070` | `anchor` 不存在。 |
+| `200999` | 连接、超时或内部错误。 |

package/docs/USAGE.md

@@ -0,0 +1,168 @@
+# RTC WebSocket SDK API
+
+本页定义公开 JavaScript API。TLV v1 的 URI、wire 字段和返回结构见
+[TLV v1 Client 契约](TLV_CONTRACT.md)。
+
+## 通用约定
+
+- 新接入使用 `protocol: 'tlv-v1'`。
+- 除 `login` 外，回调为 `callback(err, data)`；`timeout` 单位为毫秒。
+- `uid`、`gid`、`rid`、`mid`、游标和时间戳超出安全整数范围时使用 `RTMConfig.Int64`。
+- `RTMConfig.TLV_SERVER_PUSH` 为 TLV Push 名称集合。
+
+## 构造参数
+
+`new rtm.RTMClient(options)`
+
+| 参数 | 类型 | 说明 |
+| --- | --- | --- |
+| `pid` | `number` | 必填。 |
+| `protocol` | `'tlv-v1' \| 'fpnn'` | TLV 新接入为 `'tlv-v1'`。 |
+| `tlvEndpoint` | `string` | TLV 必填完整 WebSocket URL。 |
+| `autoReconnect` | `boolean` | 缺省 `true`。 |
+| `connectionTimeout` | `number` | 连接超时。 |
+| `requestTimeout` | `number` | 请求超时。 |
+| `requestMetadata` / `requestMetadataProvider` | `() => Record<string, unknown>` | 可返回 `trace`、`sent_ms`。 |
+| `webSocketFactory` | `(url: string) => RTMWebSocket` | 非浏览器运行时的 WebSocket 工厂。 |
+| `authSec` / `authVer` | `number` | 自签鉴权参数；`authVer` 固定为 `2`。 |
+| `locale` | `string` | 登录语言。 |
+| `clientVersion` | `string` | 客户端版本。 |
+| `attrs` | `Record<string, string>` | 连接属性。 |
+| `tlvHeartbeatIdleMs` / `tlvHeartbeatTimeoutMs` | `number` | TLV 心跳参数。 |
+| `pushDedupTtlMs` | `number` | 可靠 Push 去重窗口。 |
+| `regressiveStrategy` | `RTMRegressiveStrategy` | 重连退避参数。 |
+
+`RTMWebSocket` 必须提供 `send(data)`、`close(code?, reason?)`、`onopen`、`onmessage`、
+`onerror`、`onclose`。
+
+## 生命周期与连接
+
+| API | 回调 |
+| --- | --- |
+| `login(uid, credential, callback, timeout)` | `callback(accepted, errorCode)` |
+| `bye()` | 无 |
+| `close()` | 无 |
+| `startAutoReconnect()` | 无 |
+| `destroy()` | 无 |
+| `getServerTime(timeout, callback)` | `callback(err, data)` |
+| `addAttrs(attrs, timeout, callback)` | `callback(err, data)` |
+| `getAttrs(timeout, callback)` | `callback(err, data)` |
+| `addDebugLog(msg, attrs, timeout, callback)` | `callback(err, data)` |
+
+事件：`ErrorRecorder(error)`、`ReloginCompleted(successful, retryAgain, errorCode, retriedCount)`、
+`SessionClosed(errorCode)`。
+
+## 用户、存储与黑名单
+
+- `getOnlineUsers(uids, timeout, callback)`
+- `setUserInfo(oinfo, pinfo, timeout, callback)`
+- `getUserInfo(timeout, callback)`
+- `getUserOpenInfo(uids, timeout, callback)`
+- `setTranslationLanguage(targetLanguage, timeout, callback)`
+- `dataSet(key, value, timeout, callback)`
+- `dataGet(key, timeout, callback)`
+- `dataDelete(key, timeout, callback)`
+- `addBlacks(blacks, timeout, callback)`
+- `deleteBlacks(blacks, timeout, callback)`
+- `getBlacks(timeout, callback)`
+
+## 群组与房间
+
+### 群组
+
+- `addGroupMembers(gid, uids, timeout, callback)`
+- `deleteGroupMembers(gid, uids, timeout, callback)`
+- `getGroupMembers(gid, online, timeout, callback)`
+- `getGroupCount(gid, online, timeout, callback)`
+- `getUserGroups(timeout, callback)`
+- `setGroupInfo(gid, oinfo, pinfo, timeout, callback)`
+- `getGroupInfo(gid, timeout, callback)`
+- `getGroupOpenInfo(gid, timeout, callback)`
+- `getGroupsOpenInfo(gids, timeout, callback)`
+
+### 房间
+
+- `enterRoom(rid, timeout, callback)`
+- `enterRooms(rids, timeout, callback)`
+- `leaveRoom(rid, timeout, callback)`
+- `getUserRooms(timeout, callback)`
+- `getUserRoomsAndLastMessage(mtypes, timeout, callback)`
+- `getRoomMembers(rid, timeout, callback)`
+- `getRoomCount(rids, timeout, callback)`
+- `setRoomInfo(rid, oinfo, pinfo, timeout, callback)`
+- `setRoomProfile(rid, publicData, privateData, label, avatar, timeout, callback)`
+- `getRoomInfo(rid, timeout, callback)`
+- `getRoomOpenInfo(rid, timeout, callback)`
+- `getRoomsOpenInfo(rids, timeout, callback)`
+
+## 消息
+
+### 发送
+
+- `sendMessage(to, mtype, msg, attrs, mid, timeout, callback)`
+- `sendMessages(tos, mtype, msg, attrs, mid, timeout, callback)`
+- `sendGroupMessage(gid, mtype, msg, attrs, mid, timeout, callback)`
+- `sendRoomMessage(rid, mtype, msg, attrs, mid, timeout, callback)`
+- `sendChat(to, msg, attrs, mid, timeout, callback)`
+- `sendAudio(to, msg, attrs, mid, timeout, callback)`
+- `sendCmd(to, msg, attrs, mid, timeout, callback)`
+- `sendGroupChat(gid, msg, attrs, mid, timeout, callback)`
+- `sendGroupAudio(gid, msg, attrs, mid, timeout, callback)`
+- `sendGroupCmd(gid, msg, attrs, mid, timeout, callback)`
+- `sendRoomChat(rid, msg, attrs, mid, timeout, callback)`
+- `sendRoomAudio(rid, msg, attrs, mid, timeout, callback)`
+- `sendRoomCmd(rid, msg, attrs, mid, timeout, callback)`
+
+发送 API 的成功回调为 `callback(null, {message_ref, payload})`，其中 `payload` 为 Gate 的
+`{message_ref, time_ms}`；失败回调为 `callback({message_ref, error}, null)`。
+
+### 查询、历史与撤回
+
+- `getMessage(from, mid, xid, type, timeout, callback)`
+- `deleteMessage(from, mid, xid, type, timeout, callback)`
+- `getChat(from, mid, xid, type, timeout, callback)`
+- `deleteChat(from, mid, xid, type, timeout, callback)`
+- `getP2PMessage(ouid, desc, num, begin, end, lastid, mtypes, timeout, callback)`
+- `getGroupMessage(gid, desc, num, begin, end, lastid, mtypes, timeout, callback)`
+- `getRoomMessage(rid, desc, num, begin, end, lastid, mtypes, timeout, callback)`
+- `getBroadcastMessage(desc, num, begin, end, lastid, mtypes, timeout, callback)`
+- `getP2PMessageByMessageId(ouid, mid, desc, num, begin, end, mtypes, timeout, callback)`
+- `getGroupMessageByMessageId(gid, mid, desc, num, begin, end, mtypes, timeout, callback)`
+- `getRoomMessageByMessageId(rid, mid, desc, num, begin, end, mtypes, timeout, callback)`
+- `getBroadcastMessageByMessageId(mid, desc, num, begin, end, mtypes, timeout, callback)`
+- `getP2PMessageCount(ouid, begin, end, mtypes, timeout, callback)`
+- `getGroupMessageCount(gid, begin, end, mtypes, timeout, callback)`
+- `getRoomMessageCount(rid, begin, end, mtypes, timeout, callback)`
+- `getBroadcastMessageCount(begin, end, mtypes, timeout, callback)`
+- `getP2PChat(ouid, desc, num, begin, end, lastid, timeout, callback)`
+- `getGroupChat(gid, desc, num, begin, end, lastid, timeout, callback)`
+- `getRoomChat(rid, desc, num, begin, end, lastid, timeout, callback)`
+- `getBroadcastChat(desc, num, begin, end, lastid, timeout, callback)`
+
+## 未读与会话
+
+- `getUnreadMessage(clear, withLogout, timeout, callback)`
+- `getP2PUnreadMessageNum(uids, mtime, mtypes, timeout, callback)`
+- `getGroupUnreadMessageNum(gids, mtime, mtypes, timeout, callback)`
+- `cleanUnreadMessage(timeout, callback)`
+- `setSessionRead(category, xid, readSeq, timeout, callback)`
+- `getSession(timeout, callback)`
+- `removeSession(to, localOnly, timeout, callback)`
+- `getP2PConversationList(mtime, mtypes, timeout, callback)`
+- `getP2PUnreadConversationList(mtime, mtypes, timeout, callback)`
+- `getGroupConversationList(mtime, mtypes, timeout, callback)`
+- `getGroupUnreadConversationList(mtime, mtypes, timeout, callback)`
+- `getUnreadConversationList(clear, mtime, mtypes, timeout, callback)`
+
+## 文本能力与 Push
+
+- `textCheck(text, strategyId, timeout, callback)`
+- `translate(originalMessage, originalLanguage, targetLanguage, type, profanity, timeout, callback)`
+- `client.processor.on(RTMConfig.TLV_SERVER_PUSH.recvMessage, callback)`
+- `client.processor.on(RTMConfig.TLV_SERVER_PUSH.recvGroupMessage, callback)`
+- `client.processor.on(RTMConfig.TLV_SERVER_PUSH.recvRoomMessage, callback)`
+- `client.processor.on(RTMConfig.TLV_SERVER_PUSH.recvBroadcastMessage, callback)`
+- `client.processor.on(RTMConfig.TLV_SERVER_PUSH.kickOut, callback)`
+- `client.processor.on(RTMConfig.TLV_SERVER_PUSH.kickOutRoom, callback)`
+
+TLV 未开放 API 返回 `200020`：文件、好友、设备 Push 和未迁移增值能力。

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@cg-devcenter/rtc-fpnn-webjs-sdk",
+  "version": "1.0.0-cg.2",
+  "description": "Browser RTM SDK with FPNN and TLV v1 MessagePack WebSocket transports",
+  "main": "./dist/rtm.min.js",
+  "browser": "./dist/rtm.min.js",
+  "types": "./dist/rtm.d.ts",
+  "unpkg": "./dist/rtm.min.js",
+  "jsdelivr": "./dist/rtm.min.js",
+  "files": [
+    "dist",
+    "docs/TLV.md",
+    "docs/TLV_CONTRACT.md",
+    "docs/USAGE.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.diandian.info/rtc/rtc-client-sdk-websocket.git"
+  },
+  "homepage": "https://gitlab.diandian.info/rtc/rtc-client-sdk-websocket",
+  "exports": {
+    ".": {
+      "types": "./dist/rtm.d.ts",
+      "require": "./dist/rtm.min.js",
+      "default": "./dist/rtm.min.js"
+    },
+    "./dist/*": "./dist/*",
+    "./package.json": "./package.json"
+  },
+  "author": "Dixun",
+  "license": "MIT",
+  "scripts": {
+    "build": "webpack --mode production",
+    "test": "npm run test:unit && npm run test:package",
+    "test:unit": "node test/tlv/run.js && node test/tlv/documentation.js",
+    "test:package": "npm run build && node test/package-smoke.js",
+    "prepack": "npm run build"
+  },
+  "devDependencies": {
+    "babel-core": "^6.26.3",
+    "babel-loader": "^7.1.5",
+    "babel-preset-env": "^1.7.0",
+    "babel-preset-es2015": "^6.24.1",
+    "babel-preset-stage-2": "^6.24.1",
+    "buffer": "^5.1.0",
+    "int64-buffer": "^0.1.10",
+    "webpack": "^4.1.1",
+    "webpack-cli": "^3.3.12"
+  }
+}