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

package/README.md

@@ -0,0 +1,61 @@
+# @cg-devcenter/rtc-fpnn-webjs-sdk
+
+RTC WebSocket Client SDK。新接入使用 `tlv-v1`；`fpnn` 仅保留浏览器兼容能力。
+
+## 模块导出
+
+- `RTMClient`
+- `RTMConfig`
+- `RTMProcessor`
+- `TLVCodec`
+- `TLVWebSocketClient`
+
+## 客户端构造
+
+`new rtm.RTMClient(options)`
+
+| 参数 | 类型 | TLV v1 规则 |
+| --- | --- | --- |
+| `pid` | `number` | 必填。 |
+| `protocol` | `'tlv-v1' \| 'fpnn'` | 新接入为 `'tlv-v1'`。 |
+| `tlvEndpoint` | `string` | 必填完整 WebSocket URL。 |
+| `autoReconnect` | `boolean` | 缺省为 `true`。 |
+| `connectionTimeout` | `number` | 毫秒。 |
+| `requestMetadata` | `() => Record<string, unknown>` | 可返回 `trace`、`sent_ms`。 |
+| `webSocketFactory` | `(url) => RTMWebSocket` | 无全局 `WebSocket` 时必填。 |
+| `locale` | `string` | 映射为 `auth.login.locale`。 |
+| `clientVersion` | `string` | 映射为 `auth.login.client_ver`。 |
+
+`fpnn` 仅支持浏览器。TLV credential 由业务服务端签发，项目密钥不属于客户端参数。
+
+## 生命周期 API
+
+| API | 回调/结果 |
+| --- | --- |
+| `login(uid, credential, callback, timeout)` | `callback(accepted, errorCode)` |
+| `bye()` | 发送 `connection.close`。 |
+| `close()` | 主动关闭。 |
+| `startAutoReconnect()` | 关闭当前连接后重新登录。 |
+| `destroy()` | 释放客户端资源。 |
+| `getServerTime(timeout, callback)` | `callback(err, data)` |
+
+`uid`、消息 ID、群 ID、房间 ID 和时间游标超出安全整数范围时使用 `RTMConfig.Int64`。
+
+## Push API
+
+通过 `client.processor.on(name, callback)` 注册：
+
+- `RTMConfig.TLV_SERVER_PUSH.recvMessage`：`event.direct`
+- `RTMConfig.TLV_SERVER_PUSH.recvGroupMessage`：`event.group`
+- `RTMConfig.TLV_SERVER_PUSH.recvRoomMessage`：`event.room`
+- `RTMConfig.TLV_SERVER_PUSH.recvBroadcastMessage`：`event.broadcast`
+- `RTMConfig.TLV_SERVER_PUSH.kickOut`：`event.kicked`
+- `RTMConfig.TLV_SERVER_PUSH.kickOutRoom`：`event.room_removed`
+
+可靠消息 Push 由 SDK 自动 ACK 并按 `message_ref` 去重。
+
+## API 文档
+
+- [公开方法与参数](docs/USAGE.md)
+- [TLV v1 wire 契约](docs/TLV_CONTRACT.md)
+- [TLV v1 传输规则](docs/TLV.md)

package/dist/rtm.d.ts

@@ -0,0 +1,208 @@
+export as namespace rtm;
+
+declare namespace rtm {
+    type RTMProtocol = 'fpnn' | 'tlv-v1';
+
+    interface RTMRegressiveStrategy {
+        startConnectFailedCount: number;
+        maxIntervalSeconds: number;
+        linearRegressiveCount: number;
+    }
+
+    interface RTMWebSocket {
+        binaryType?: string;
+        send(data: unknown): void;
+        close(code?: number, reason?: string): void;
+        onopen?: ((event?: unknown) => void) | null;
+        onmessage?: ((event: { data: unknown }) => void) | null;
+        onerror?: ((event?: unknown) => void) | null;
+        onclose?: ((event?: unknown) => void) | null;
+    }
+
+    interface RTMClientOptions {
+        pid: number;
+        protocol?: RTMProtocol;
+        endpoint?: string;
+        ssl_endpoint?: string;
+        tlvEndpoint?: string;
+        tlv_endpoint?: string;
+        autoReconnect?: boolean;
+        connectionTimeout?: number;
+        requestTimeout?: number;
+        locale?: string;
+        clientVersion?: string;
+        authSec?: number;
+        authVer?: 2;
+        requestMetadata?: () => Record<string, unknown>;
+        requestMetadataProvider?: () => Record<string, unknown>;
+        webSocketFactory?: (url: string) => RTMWebSocket;
+        attrs?: Record<string, string>;
+        tlvHeartbeatIdleMs?: number;
+        tlvHeartbeatTimeoutMs?: number;
+        pushDedupTtlMs?: number;
+        regressiveStrategy?: RTMRegressiveStrategy;
+        [key: string]: unknown;
+    }
+
+    export class RTMClient {
+        constructor(options: RTMClientOptions);
+        processor;
+        login(uid, token, callback, timeout);
+        destroy();
+        getServerTime(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);
+        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);
+        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);
+        getP2PMessage(ouid, 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);
+        fileToken(cmd, tos, to, rid, gid, timeout, callback);
+        close();
+        startAutoReconnect();
+        bye();
+        addAttrs(attrs, timeout, callback);
+        getAttrs(timeout, callback);
+        addDebugLog(msg, attrs, timeout, callback);
+        addDevice(apptype, devicetoken, timeout, callback);
+        removeDevice(devicetoken, timeout, callback);
+        setTranslationLanguage(targetLanguage, timeout, callback);
+        translate(originalMessage, originalLanguage, targetLanguage, type, profanity, timeout, callback);
+        profanity(text, classify, timeout, callback);
+        textCheck(text, strategyId, timeout, callback);
+        imageCheck(image, type, strategyId, timeout, callback);
+        audioCheck(audio, type, lang, codec, srate, strategyId, timeout, callback);
+        videoCheck(video, type, videoName, strategyId, timeout, callback);
+        speech2Text(audio, type, lang, codec, srate, timeout, callback);
+        getGroupsOpenInfo(gids, timeout, callback);
+        getRoomsOpenInfo(rids, timeout, callback);
+        getRoomMembers(rid, timeout, callback);
+        getRoomCount(rids, timeout, callback);
+        addDevicePushOption(type, xid, mtypes, timeout, callback);
+        removeDevicePushOption(type, xid, mtypes, timeout, callback);
+        getDevicePushOption(timeout, callback);
+        addFriends(friends, timeout, callback);
+        deleteFriends(friends, timeout, callback);
+        getFriends(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);
+        enterRoom(rid, timeout, callback);
+        enterRooms(rids, timeout, callback);
+        leaveRoom(rid, timeout, callback);
+        getUserRooms(timeout, callback);
+        getUserRoomsAndLastMessage(mtypes, timeout, callback);
+        getOnlineUsers(uids, timeout, callback);
+        deleteMessage(from, mid, xid, type, timeout, callback);
+		getMessage(from, mid, xid, type, 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);
+		getGroupChat(gid, desc, num, begin, end, lastid, timeout, callback);
+		getRoomChat(rid, desc, num, begin, end, lastid, timeout, callback);
+		getP2PChat(ouid, desc, num, begin, end, lastid, timeout, callback);
+		getBroadcastChat(desc, num, begin, end, lastid, timeout, callback);
+		deleteChat(from, mid, xid, type, timeout, callback);
+		getChat(from, mid, xid, type, timeout, callback);
+		setUserInfo(oinfo, pinfo, timeout, callback);
+		getUserInfo(timeout, callback);
+		getUserOpenInfo(uids, timeout, callback);
+		setGroupInfo(gid, oinfo, pinfo, timeout, callback);
+		getGroupInfo(gid, timeout, callback);
+		getGroupOpenInfo(gid, timeout, callback);
+		setRoomInfo(rid, oinfo, pinfo, timeout, callback);
+		setRoomProfile(rid, publicData, privateData, label, avatar, timeout, callback);
+		getRoomInfo(rid, timeout, callback);
+		getRoomOpenInfo(rid, timeout, callback);
+        dataGet(key, timeout, callback);
+        dataSet(key, value, timeout, callback);
+		dataDelete(key, timeout, callback);
+		addBlacks(blacks, timeout, callback);
+		deleteBlacks(blacks, timeout, callback);
+		getBlacks(timeout, callback);
+        sendFile(mtype, to, file, mid, timeout, callback);
+        sendGroupFile(mtype, gid, file, mid, timeout, callback);
+        sendRoomFile(mtype, rid, file, mid, 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);
+        removeSession(to, localOnly, timeout, callback);
+        on(type, callback);
+        emit();
+        removeEvent();
+    }
+
+    export class RTMConfig {
+        static ERROR_CODE;
+        static Int64;
+        static Uint64;
+        static MsgPack;
+        static FILE_TYPE;
+        static CHAT_TYPE;
+        static SERVER_PUSH;
+        static TLV_SERVER_PUSH;
+        static MID_TTL;
+        static API_VERSION;
+        static SDK_VERSION;
+        static MAX_PING_SECONDS;
+    }
+
+    export class RTMProcessor {
+        constructor();
+        service(data, cb);
+        destroy();
+        kickout(data);
+        kickoutroom(data);
+        pushmsg(data);
+        pushgroupmsg(data);
+        pushroommsg(data);
+        pushbroadcastmsg(data);
+        ping(data);
+        on(type, callback);
+        emit();
+        removeEvent();
+    }
+
+    export class TLVCodec {
+        static encodeFrame(sequence, mt, uri, payload);
+        static decodeFrame(frame);
+    }
+
+    export class TLVWebSocketClient {
+        constructor(options);
+        connect();
+        close();
+        destroy();
+        markAuthenticated();
+        sendQuest(options, callback, timeout);
+        on(type, callback);
+        off(type, callback);
+    }
+}
+
+export = rtm;