@typexim/web-sdk 0.0.3

package/dist/types/enums/business.d.ts

@@ -0,0 +1,115 @@
+export declare enum Boolean {
+    yes = 1,
+    no = 0
+}
+export declare enum ApiResponseCode {
+    SDK_ERROR = -10000,
+    NETWORK_ERROR = -9999,
+    MAKE_SIGN_FAIL = -9998,
+    REQUEST_SINGLETON_LOCK_FAIL = -9997,
+    PARAMS_INVALID = -9996,
+    SUCCESS = 0
+}
+export declare enum PushMessageType {
+    CREATE_FEED = 0,
+    UPDATE_FEED = 1,
+    ADD_MESSAGE = 2,
+    UPDATE_MESSAGE = 3,
+    UPDATE_USER_DATA = 4,
+    USER_LOGIN = 5,
+    READ_MESSAGE = 6,
+    PONG_MESSAGE = 8,
+    DELETE_MESSAGE = 9,
+    UPDATE_GROUP = 12,
+    DELETE_GROUP = 13,
+    UPDATE_LOGIN_USER = 17,
+    UPDATE_MESSAGE_REACTION = 19,
+    ADD_GROUP_MEMBER = 21,
+    DEL_GROUP_MEMBER = 22,
+    ADD_CONTACTS = 23,
+    UPDATE_CONTACTS = 24,
+    DEL_CONTACTS = 25,
+    BLOCK_USER = 26,
+    DEVICE_CODE = 27,
+    MSG_OPEN_CLOCK = 28,
+    DELETE_SECRET_CHAT = 29,
+    DELETE_FEED = 30,
+    FAVORITE_UPDATE = 31,
+    STICKERS_UPDATE = 32,// 系统商店表情包 状态更新
+    CUSTOM_STICKERS_UPDATE = 33,// 用户自定义表情包 更新
+    MANAGE_DEVICE_UPDATE = 34,// 用户设备列表更新
+    MASS_MESSAGE_UPDATE = 35,// 群发助手列表更新
+    CHAT_WALLPAPER_DELETE = 36,// 聊天壁纸列表更新
+    CHAT_WALLPAPER_ADD = 37,
+    CONTACT_REQUEST = 40,
+    USER_PREFERENCE_CHANGE = 38,
+    UPDATE_GROUP_PIN = 41,
+    RTC_CANCEL = 46,// 通话取消
+    ADD_FEED_FOLDER = 43,
+    UPDATE_FEED_FOLDER = 44,
+    UPDATE_FOLDER_FEED_LIST = 47,
+    DELETE_FEED_FOLDER = 45,
+    UPDATE_CHATTER = 42,
+    PAPER_KEY = 48,
+    PAPER_KEY_LOG = 49,
+    USER_LOGIN_SCAN = 50,
+    RTC_RINGING = 51,// 通话取消
+    ON_UPDATE_PRIVATE_SETTING = 52,
+    ON_DELETE_PRIVATE_SETTING = 53,
+    ON_UPDATE_LOGIN_PRIVATE_SETTING = 54,
+    PUSH_LIVE_MESSAGE = 56,
+    BIG_PACKAGE_PUSH = 126,
+    KICK_OUT_DEVICE = 127,
+    CLEAR_HISTORY = 128,
+    CLEAR_DATA = 255
+}
+export declare enum ChatType {
+    /**
+     * 单聊
+     */
+    singleChat = 1,
+    /**
+     * 群聊
+     */
+    groupChat = 2
+}
+export declare enum MessageKind {
+    text = 0,//普通
+    system = 1
+}
+export declare enum MessageType {
+    text = 0,
+    image = 1,
+    card = 2,
+    audio = 3,
+    video = 4,
+    file = 5,
+    mergeForward = 6,//合并转发
+    sticker = 7,//表情
+    richText = 8,//富文本消息
+    custom = 9
+}
+export declare enum MessageSendStatus {
+    success = 0,
+    sending = 1,
+    failed = 2
+}
+/** 群成员角色 */
+export declare enum GroupRole {
+    Owner = 1,
+    Admin = 2,
+    Common = 3,
+    Bot = 4
+}
+export declare enum MessageOperation {
+    normal = 0,//正常
+    recall = 1
+}
+export declare enum GroupType {
+    /** 加密群聊  */
+    private = 1,
+    /** 超级群聊  */
+    public = 0,
+    /** 匿名群聊，新增群聊类型  */
+    anonymous = 2
+}

package/dist/types/enums/index.d.ts

@@ -0,0 +1,2 @@
+export * from './business';
+export * from './sdk';

package/dist/types/enums/sdk.d.ts

@@ -0,0 +1,5 @@
+export declare enum LogLevel {
+    error = "ERROR",
+    warning = "WARNING",
+    info = "INFO"
+}

package/dist/types/events.d.ts

@@ -0,0 +1,56 @@
+import { Feed, Message } from './interfaces';
+export declare const CHAT_SDK_EVENT: {
+    /**
+     * sdk用户已登录，可以调用发送消息等API
+     */
+    readonly SDK_READY: "sdkReady";
+    /**
+     * sdk用户已登出，无法调用发送消息等API，需要重新登录
+     */
+    readonly SDK_NOT_READY: "sdkNotReady";
+    /**
+     * feed列表有更新
+     */
+    readonly FEED_LIST_UPDATED: "feedListUpdated";
+    /**
+     * sdk收到新message
+     */
+    readonly MESSAGE_RECEIVED: "messageReceived";
+    /**
+     * message有更新
+     */
+    readonly MESSAGE_UPDATED: "messageUpdated";
+    /**
+     * sdk收到message已读回执
+     */
+    readonly MESSAGE_RECEIPT_RECEIVED: "messageReceiptReceived";
+    /**
+     * sdk收到直播间message
+     */
+    readonly ROOM_MESSAGE_RECEIVED: "roomMessageReceived";
+};
+export type CHAT_SDK_EVENT_MAP = {
+    [CHAT_SDK_EVENT.SDK_READY]: void;
+    [CHAT_SDK_EVENT.SDK_NOT_READY]: void;
+    [CHAT_SDK_EVENT.FEED_LIST_UPDATED]: {
+        is_sync_completed: boolean;
+        list: Feed[];
+    };
+    [CHAT_SDK_EVENT.MESSAGE_RECEIVED]: Message;
+    [CHAT_SDK_EVENT.MESSAGE_UPDATED]: Message;
+    [CHAT_SDK_EVENT.MESSAGE_RECEIPT_RECEIVED]: {
+        /**
+         * feed id
+         */
+        feed_id: string;
+        /**
+         * 已读消息id列表
+         */
+        message_ids: string[];
+        /**
+         * 发送已读回执的用户id
+         */
+        reader_user_ids: string[];
+    };
+    [CHAT_SDK_EVENT.ROOM_MESSAGE_RECEIVED]: string;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,21 @@
+import * as enums from './enums';
+import * as events from './events';
+import * as interfaces from './interfaces';
+import { ChatSDKConfig } from './interfaces/sdk';
+import ChatSDK from './modules/ChatSDK';
+export declare function create(config: ChatSDKConfig): ChatSDK;
+export declare const utils: {
+    parseSystemMessageContent: (str: string) => {
+        text?: string;
+        text_i18n?: Record<string, string>;
+    };
+    parseTextMessageContent: (str: string) => {
+        text?: string;
+        client_msg_id?: string;
+    };
+    parseCustomMessageContent: <T = any>(str: string) => {
+        client_msg_id?: string;
+        content?: T;
+    };
+};
+export { ChatSDK, enums, events, interfaces };

package/dist/types/interfaces/business.d.ts

@@ -0,0 +1,141 @@
+import { ChatType, MessageKind, MessageOperation, MessageType } from '../enums';
+export type ApiResponse<T = any> = {
+    code: number;
+    data: T;
+    msg: string;
+    msg_i18n?: Record<string, string>;
+};
+export type User = {
+    id: string;
+    email: string;
+    phone: string;
+    name: string;
+    avatar: string;
+    last_active_at: string;
+    logoff: number;
+    language: string;
+    token: string;
+    token_expired: string;
+    first_name: string;
+    last_name: string;
+    is_online: boolean;
+    last_online_time: number;
+    key: string;
+    session_id: string;
+};
+export type Feed = {
+    /**
+     * feedId
+     */
+    id: string;
+    /**
+     * 会话id
+     */
+    chat_id: string;
+    /**
+     * 单聊时对方的id
+     */
+    target_id: string;
+    /**
+     * 聊天类型
+     */
+    chat_type: ChatType;
+    /**
+     * 会话成员id
+     */
+    chat_member: string[];
+    /**
+     * 头像
+     */
+    avatar: string;
+    /**
+     * 会话名称
+     */
+    name: string;
+    /**
+     * 未读消息ids
+     */
+    unread_message_ids?: string[];
+    /**
+     * 未读数
+     */
+    badge: number;
+    /**
+     * 最后更新时间，'2025-09-18T02:24:25Z'
+     */
+    last_updated_at: string;
+    /**
+     * 首条消息的position
+     */
+    first_position: number;
+    /**
+     * 最后一条消息的position
+     */
+    last_message_position: number;
+    /**
+     * 最后一条消息的发送时间
+     */
+    last_message_send_at: string;
+    /**
+     * 最后一条消息的内容(content)
+     */
+    last_message: string;
+    /**
+     * 最后一条消息的来源类别
+     */
+    last_message_kind_id: MessageKind;
+    /**
+     * 最后一条消息的消息类别
+     */
+    last_message_type_id: MessageType;
+};
+export type Message = {
+    /**
+     * 消息id
+     */
+    id: string;
+    /**
+     * chat id
+     */
+    chat_id: string;
+    /**
+     * 消息位置
+     */
+    position: number;
+    /**
+     * 发送者Id
+     */
+    sender_id: string;
+    /**
+     * 消息来源类别，系统触发，普通触发
+     */
+    message_kind_id: MessageKind;
+    /**
+     * 消息类别
+     */
+    message_type_id: MessageType;
+    /**
+     * 消息内容
+     */
+    content: string;
+    /**
+     * 发送时间
+     */
+    send_at: string;
+    /**
+     * 已读信息的用户id
+     */
+    reader_ids: string[];
+    /**
+     * 存放对某些隐藏消息的用户的Id
+     */
+    hide_ids: string[];
+    /**
+     * 消息操作状态
+     */
+    operation: MessageOperation;
+    /**
+     * 消息操作人id
+     */
+    operation_user_id: string;
+};

package/dist/types/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export * from './business';
+export * from './pushMessage';
+export * from './sdk';

package/dist/types/interfaces/pushMessage.d.ts

@@ -0,0 +1,33 @@
+import { PushMessageType } from '../enums';
+import { Feed, Message } from './business';
+export type PushMessageBase<T = PushMessageType, U = unknown> = {
+    id: string;
+    timestamp?: number;
+    type: T;
+    content: U;
+};
+export type PushMessagePong = PushMessageBase<PushMessageType.PONG_MESSAGE>;
+export type PushMessageBigPackageContent = {
+    big_push: PushMessage[];
+};
+export type PushMessageBigPackage = PushMessageBase<PushMessageType.BIG_PACKAGE_PUSH, PushMessageBigPackageContent>;
+export type PushMessageCreateFeed = PushMessageBase<PushMessageType.CREATE_FEED, Feed>;
+export type PushMessageUpdateFeeds = PushMessageBase<PushMessageType.UPDATE_FEED>;
+export type PushMessageAddMessage = PushMessageBase<PushMessageType.ADD_MESSAGE, Message>;
+export type PushMessageUpdateMessage = PushMessageBase<PushMessageType.UPDATE_MESSAGE, Message>;
+export type PushMessageUserLogin = PushMessageBase<PushMessageType.USER_LOGIN>;
+export type PushMessageDeleteFeed = PushMessageBase<PushMessageType.DELETE_FEED, {
+    /**
+     * feed id
+     */
+    id: string;
+}>;
+export type PushMessagePushLiveMessage = PushMessageBase<PushMessageType.PUSH_LIVE_MESSAGE, string>;
+export type PushMessageReadMessage = PushMessageBase<PushMessageType.READ_MESSAGE, {
+    chat_id: string;
+    message_ids: string[];
+    reader_ids: string[];
+    threadid: string;
+}>;
+export type SpecialPushMessage = PushMessagePong | PushMessageBigPackage | PushMessageCreateFeed | PushMessageUpdateFeeds | PushMessageAddMessage | PushMessageUpdateMessage | PushMessageUserLogin | PushMessageDeleteFeed | PushMessagePushLiveMessage | PushMessageReadMessage;
+export type PushMessage = PushMessageBase<Exclude<PushMessageType, SpecialPushMessage['type']>> | SpecialPushMessage;

package/dist/types/interfaces/sdk/api.d.ts

@@ -0,0 +1,74 @@
+import { Feed, Message } from '../business';
+import { HttpClientResponse } from './common';
+export type SDKLoginReq = {
+    user_code: string;
+};
+export type SDKGetFeedListRespData = {
+    /**
+     * feed列表
+     */
+    list: Feed[];
+    /**
+     * 是否拉取完成
+     */
+    is_sync_completed: boolean;
+};
+export type SDKGetFeedListResp = HttpClientResponse<SDKGetFeedListRespData>;
+export type SDKGetFeedMessageListReq = {
+    /**
+     * feed id
+     */
+    feed_id: string;
+    /**
+     * 上一次分页查询返回的last_message_position
+     */
+    last_message_position?: number;
+    limit: number;
+};
+export type SDKGetFeedMessageListRespData = {
+    /**
+     * 是否还有更多
+     */
+    has_more: boolean;
+    /**
+     * 消息列表
+     */
+    list: Message[];
+    /**
+     * 最后一条消息的position，下一页查询时需要携带
+     */
+    last_message_position?: number;
+};
+export type SDKGetFeedMessageListResp = HttpClientResponse<SDKGetFeedMessageListRespData>;
+export type SDKCreateCustomMessageReq<T = any> = {
+    feed_id: string;
+    /**
+     * 自定义消息内容
+     */
+    content: T;
+    /**
+     * 客户端自定义的消息id，发送成功后content会带
+     */
+    client_msg_id?: string;
+};
+export type SDKSendMessageReadReceiptReq = {
+    /**
+     * feed id
+     */
+    feed_id: string;
+    /**
+     * 消息id列表
+     */
+    message_ids: string[];
+};
+export type SDKGetRoomRecentMessageListResp = HttpClientResponse<string[]>;
+export type SDKSendMessageToRoomReq = {
+    /**
+     * 直播间id
+     */
+    room_id: string;
+    /**
+     * 内容
+     */
+    content: string;
+};

package/dist/types/interfaces/sdk/common.d.ts

@@ -0,0 +1,42 @@
+export type ChatSDKConfig = {
+    /**
+     * API服务器域名
+     */
+    httpHost: string;
+    /**
+     * websocket服务器域名
+     */
+    websocketHost: string;
+    /**
+     * 为http请求添加x-developer消息头(调试用)
+     */
+    developer?: string;
+};
+type ChatSDKContextBase = {
+    isReady: boolean;
+    deviceId: string | null;
+};
+type ChatSDKContextLogin = ChatSDKContextBase & {
+    isLogin: true;
+    loginUser: {
+        userId: string;
+        secretKey: string;
+        sessionId: string;
+    };
+};
+type ChatSDKContextNotLogin = ChatSDKContextBase & {
+    isLogin: false;
+};
+export type ChatSDKContext = ChatSDKContextLogin | ChatSDKContextNotLogin;
+export type HttpClientResponseOk<T = unknown> = {
+    ok: true;
+    data: T;
+};
+export type HttpClientResponseFail = {
+    ok: false;
+    code: number;
+    msg: string;
+    msg_i18n?: Record<string, string>;
+};
+export type HttpClientResponse<T = unknown> = HttpClientResponseOk<T> | HttpClientResponseFail;
+export {};

package/dist/types/interfaces/sdk/index.d.ts

@@ -0,0 +1,2 @@
+export * from './api';
+export * from './common';

package/dist/types/modules/Base.d.ts

@@ -0,0 +1,51 @@
+export type EventType = string | symbol;
+export type Handler<T = unknown> = (event: T) => void;
+export type WildcardHandler<T = Record<string, unknown>> = (type: keyof T, event: T[keyof T]) => void;
+export type EventHandlerList<T = unknown> = Array<Handler<T>>;
+export type WildCardEventHandlerList<T = Record<string, unknown>> = Array<WildcardHandler<T>>;
+export type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<keyof Events | '*', EventHandlerList<Events[keyof Events]> | WildCardEventHandlerList<Events>>;
+export type GenericEventHandler<Events extends Record<EventType, unknown>> = Handler<Events[keyof Events]> | WildcardHandler<Events>;
+export default class Base<Events extends Record<EventType, unknown>> {
+    all: EventHandlerMap<Events>;
+    constructor(all?: EventHandlerMap<Events>);
+    /**
+     * Register an event handler for the given type.
+     * @param {string|symbol} type Type of event to listen for, or `'*'` for all events
+     * @param {Function} handler Function to call in response to given event
+     * @memberOf Emitter
+     * @returns {Function} Function to remove the event handler
+     */
+    on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): () => void;
+    on(type: '*', handler: WildcardHandler<Events>): () => void;
+    /**
+     * Remove an event handler for the given type.
+     * If `handler` is omitted, all handlers of the given type are removed.
+     *
+     * @param {string|symbol} type Type of event to unregister `handler` from (`'*'` to remove a wildcard handler)
+     * @param {Function} [handler] Handler function to remove
+     * @memberOf mitt
+     */
+    off<Key extends keyof Events>(type: Key, handler?: Handler<Events[Key]>): void;
+    off(type: '*', handler: WildcardHandler<Events>): void;
+    /**
+     * Invoke all handlers for the given type.
+     * If present, `'*'` handlers are invoked after type-matched handlers.
+     *
+     * Note: Manually firing '*' handlers is not supported.
+     *
+     * @param {string|symbol} type The event type to invoke
+     * @param {Any} [evt] Any value (object is recommended and powerful), passed to each handler
+     * @memberOf Emitter
+     */
+    emit<Key extends keyof Events>(type: Key, evt: Events[Key]): void;
+    emit<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): void;
+    /**
+     * Register an event handler for the given type that will be invoked only once.
+     *
+     * @param {string|symbol} type Type of event to listen for, or `'*'` for all events
+     * @param {Function} handler Function to call in response to given event
+     * @memberOf Emitter
+     */
+    once<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
+    once(type: '*', handler: WildcardHandler<Events>): void;
+}

package/dist/types/modules/BusinessWebsocket.d.ts

@@ -0,0 +1,21 @@
+import { PushMessage } from '../interfaces';
+import { ChatSDKContext } from '../interfaces/sdk';
+import Base from './Base';
+import Logger from './Logger';
+export type BusinessWebsocketConfig = {
+    host: string;
+    context: ChatSDKContext;
+    logger: Logger;
+};
+export default class BusinessWebsocket extends Base<{
+    message: PushMessage;
+    kickoff: void;
+}> {
+    private host;
+    private context;
+    private logger;
+    private ws;
+    constructor(config: BusinessWebsocketConfig);
+    connect(): void;
+    disconnect(): void;
+}

package/dist/types/modules/ChatSDK.d.ts

@@ -0,0 +1,120 @@
+import { LogLevel } from '../enums';
+import { CHAT_SDK_EVENT_MAP } from '../events';
+import { Feed, Message } from '../interfaces';
+import { ChatSDKConfig, HttpClientResponse, SDKCreateCustomMessageReq, SDKGetFeedListResp, SDKGetFeedMessageListReq, SDKGetFeedMessageListResp, SDKGetRoomRecentMessageListResp, SDKLoginReq, SDKSendMessageReadReceiptReq, SDKSendMessageToRoomReq } from '../interfaces/sdk';
+import Base from './Base';
+export default class ChatSDK extends Base<CHAT_SDK_EVENT_MAP> {
+    private context;
+    private version;
+    private singletonLock;
+    private logger;
+    private httpClient;
+    private feedCache;
+    private ws;
+    private pushMessageProcessor;
+    constructor(config: ChatSDKConfig);
+    private init;
+    private requestDeviceId;
+    private saveContext;
+    private loadContext;
+    private applyLoginStatus;
+    private loadFeedList;
+    /**
+     * SDK 是否已就绪（登录成功且 WebSocket 已连接）。
+     * @returns {boolean} true 表示可用，false 表示未就绪
+     */
+    isReady(): boolean;
+    /**
+     * 设置 SDK 的日志级别。
+     * @param {LogLevel} level 要设置的日志级别
+     */
+    setLogLevel(level: LogLevel): void;
+    /**
+     * 使用一次性 userCode 登录，建立会话并连接 WebSocket。
+     * 成功后会触发事件：SDK_READY。
+     * @param {SDKLoginReq} req 登录请求参数（包含 userCode）
+     * @returns {Promise<HttpClientResponse>} 成功返回 ok，失败返回错误信息
+     */
+    login(req: SDKLoginReq): Promise<HttpClientResponse>;
+    /**
+     * 退出当前登录用户并断开 WebSocket。
+     * 成功后会触发事件：SDK_NOT_READY。
+     * @returns {Promise<HttpClientResponse>} 成功返回 ok，失败返回错误信息
+     */
+    logout(): Promise<HttpClientResponse>;
+    private handleKickoff;
+    /**
+     * 获取当前登录用户的 userId。
+     * @returns {string | null} 已登录返回 userId，未登录返回 null
+     */
+    getLoginUser(): string | null;
+    /**
+     *  创建单聊feed，如果已创建就返回已创建的feed
+     * @param user_id
+     * @returns
+     */
+    createSingleChatFeed(user_id: string): Promise<HttpClientResponse<Feed>>;
+    /**
+     * 删除指定feed
+     * @param feed_id
+     * @returns
+     */
+    deleteFeed(feed_id: string): Promise<HttpClientResponse>;
+    /**
+     * 获取当前用户的 Feed 列表
+     * @returns
+     */
+    getFeedList(): Promise<SDKGetFeedListResp>;
+    /**
+     * 根据 Feed ID 获取详情
+     * @param feed_id
+     * @returns
+     */
+    getFeedDetail(feed_id: string): Promise<HttpClientResponse<Feed | null>>;
+    /**
+     * 获取某个 Feed 的消息列表
+     * @param req
+     * @returns
+     */
+    getFeedMessageList(req: SDKGetFeedMessageListReq): Promise<SDKGetFeedMessageListResp>;
+    /**
+     * 本地创建一条 Feed 自定义消息
+     * @param req
+     * @returns
+     */
+    createCustomMessage<T = any>(req: SDKCreateCustomMessageReq<T>): HttpClientResponse<Message>;
+    /**
+     * 发送一条消息到指定 Feed。
+     */
+    sendMessageToFeed(message: Message): Promise<HttpClientResponse>;
+    /**
+     * 发送消息已读回执
+     * @param req
+     * @returns
+     */
+    sendMessageReadReceipt(req: SDKSendMessageReadReceiptReq): Promise<HttpClientResponse>;
+    /**
+     * 加入直播间
+     * @param {string} room_id 直播间id
+     * @returns {Promise<HttpClientResponse>} 请求结果
+     */
+    joinRoom(room_id: string): Promise<HttpClientResponse>;
+    /**
+     * 离开直播间
+     * @param {string} room_id 直播间id
+     * @returns {Promise<HttpClientResponse>} 请求结果
+     */
+    leaveRoom(room_id: string): Promise<HttpClientResponse>;
+    /**
+     * 获取直播间的最近50条消息
+     * @param room_id 直播间id
+     * @returns
+     */
+    getRoomRecentMessageList(room_id: string): Promise<SDKGetRoomRecentMessageListResp>;
+    /**
+     * 向直播间发送一条消息。
+     * @param req
+     * @returns
+     */
+    sendMessageToRoom(req: SDKSendMessageToRoomReq): Promise<HttpClientResponse>;
+}