@rongcloud/engine 5.5.8-beem → 5.6.0-beem-alpha.2

package/index.d.ts

@@ -251,110 +251,222 @@ declare class RongStreamWriter {
 }
 
 /**
- * @description
- * 读数据处理基类
-*/
-declare class BaseReader {
-    readonly header: Header;
-    messageId: number;
-    timestamp: number;
-    syncMsg: boolean;
-    protected identifier: string;
-    constructor(header: Header);
-    getIdentifier(): string | number;
-    read(stream: RongStreamReader, length: number, protocolVer: ConnAckProtocolVer): void;
-    readMessage(stream: RongStreamReader, length?: number, protocolVer?: ConnAckProtocolVer): {
-        stream: RongStreamReader;
-        length: number | undefined;
-    };
+ * LogLevel 等级定义，与大数据服务器日志等级保持一致
+ */
+declare enum LogL {
+    /**
+     * IM 质量数据日志，控制台不打印
+     */
+    STATISTICS = -2,
+    /**
+     * 未明确使用场景，暂未使用，控制台不打印
+     * TODO:
+     * 暂未明确使用场景，实时日志系统上报？
+     * 需要明确下为什么会有 -1，以及与 -2 的区别，并在注释中补充
+     */
+    RECORD = -1,
+    /**
+     * 未明确使用场景，暂未使用，控制台不打印
+     */
+    FATAL = 0,
+    /**
+     * ERROR 级
+     */
+    ERROR = 1,
+    /**
+     * WARN 级
+     */
+    WARN = 2,
+    /**
+     * INFO 级
+     */
+    INFO = 3,
+    /**
+     * DEBUG 级
+     */
+    DEBUG = 4
 }
 /**
- * @description
- * 写数据处理基类
+ * 有效的日志等级声明
  */
-declare abstract class BaseWriter {
-    private _header;
-    lengthSize: number;
-    data: any;
-    messageId: number;
-    topic: string;
-    targetId: string;
-    identifier: string;
-    constructor(headerType: OperationType);
-    getIdentifier(): string | number;
-    write(stream: RongStreamWriter): void;
-    abstract writeMessage(stream: RongStreamWriter): void;
-    setHeaderQos(qos: number): void;
-    getHeaderFlag(): number;
-    getLengthSize(): number;
-    getBufferData(): Int8Array;
+declare type EnableLogL = LogL.DEBUG | LogL.INFO | LogL.WARN | LogL.ERROR;
+
+declare type LogContent = string | number | boolean | null;
+declare type LogType = 'IM' | 'RTC';
+/**
+ * 对外暴露的 Logger 工具接口定义，以隐藏 BasicLogger 其他实现
+ */
+interface ILogger {
+    debug(tag: string, content?: LogContent, traceId?: string): void;
+    info(tag: string, content?: LogContent, traceId?: string): void;
+    warn(tag: string, content?: LogContent, traceId?: string): void;
+    error(tag: string, content?: LogContent, traceId?: string): void;
+    /**
+     * 设置日志打印等级，默认为 `LogL.WARN`
+     * @param level
+     */
+    setOutputLevel(level?: EnableLogL): void;
+    /**
+     * 创建事务追踪 ID，全局唯一，便于跨进程、异步事务追踪，需要考虑多进程
+     */
+    createTraceId(): string;
 }
-declare class RetryableReader extends BaseReader {
-    messageId: number;
-    readMessage(stream: RongStreamReader, length: number): {
-        stream: RongStreamReader;
-        length: number;
-    };
+
+interface ILogData {
+    /**
+     * 日志原始内容
+     */
+    content?: LogContent;
+    /**
+     * 日志标签，如 `L-INIT-O`
+     */
+    tag: string;
+    /**
+     * logger 实例 Id，用于确定日志由谁埋点，如 `RCEngien` 为 engine 包埋点日志
+     */
+    loggerId: string;
+    /**
+     * 日志生成时间
+     */
+    time: number;
+    /**
+     * 应用的声明周期 sessionId
+     * @description
+     * Electron 环境下，以主进程 sessionId 入库，渲染进程 sessionId 存储于 content 内。
+     * 日志上报时，通过 `${mainSessionId}:${renderSessionId}` 形式作为 sessionId 上报
+     * @TODO 需确认服务是否允许 `${mainSessionId}:${renderSessionId}` 的方式，以及 sessionId 是否超出长度。
+     */
+    sessionId: string;
+    /**
+     * 日志类型，仅用于大数据后台查阅统计
+     */
+    type: 'IM' | 'RTC';
+    /**
+     * 日志等级，该等级与服务器统计等级保持一致，为入库等级
+     */
+    level: LogL;
+    /**
+     * 事务跟踪 ID
+     */
+    traceId?: string;
 }
-declare class RetryableWriter extends BaseWriter {
-    writeMessage(stream: RongStreamWriter): void;
+/**
+ * 日志数据库接口
+ */
+interface ILogDB {
+    /**
+     * 获取实时日志上报的时间戳记录
+     */
+    getTimestamp4RealtimeLog(userId: string): Promise<number>;
+    /**
+     * 设置实时日志上报的时间戳记录
+     * @param userId 当前用户 ID
+     * @param timestamp
+     */
+    setTimestamp4RealtimeLog(userId: string, timestamp: number): Promise<void>;
+    /**
+     * 根据时间戳和日志等级获取全量日志
+     * @param startTime
+     * @param endTime
+     * @param level
+     * @param includeStatistics 是否包含质量统计日志
+     */
+    getLogs(startTime: number, endTime: number, level: LogL, includeStatistics: boolean): Promise<{
+        logs: ILogData[];
+        dbReady: boolean;
+    }>;
 }
-declare class PublishReader extends RetryableReader {
-    topic: string;
-    data: any;
-    targetId: string;
-    date: any;
-    syncMsg: boolean;
-    identifier: string;
-    readMessage(stream: RongStreamReader, length: number): {
-        stream: RongStreamReader;
-        length: number;
-    };
+
+/**
+ * Logger 抽象基类，定义日志采集接口与进程内打印，
+ * 由子类继承实现入库逻辑
+ */
+declare abstract class BasicLogger implements ILogger {
+    protected readonly _appkey: string;
+    protected readonly _id: string;
+    protected readonly _type: LogType;
+    constructor(_appkey: string, _id: string, _type: LogType);
+    private _stdout;
+    /**
+     * 用户的打印日志等级配置
+     */
+    private outputLevel;
+    setOutputLevel(level?: EnableLogL): void;
+    /**
+     * 由子类继承实现日志入库
+     * @override
+     */
+    protected abstract flush(data: ILogData): void;
+    private _log;
+    debug: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
+    info: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
+    warn: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
+    error: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
+    /**
+     * 内部质量数据统计接口，仅限 IMLib 与 RTCLib 内部使用
+     */
+    __statistics: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
+    /**
+     * 创建事务追踪 ID，全局唯一，便于跨进程、异步事务追踪，需要考虑多进程
+     */
+    createTraceId(): string;
+    /**
+     * 获取当前进程的 sessionId，全局唯一
+     * @returns
+     */
+    getSessionId(): string;
 }
+
 /**
- * @description
- * 发消息使用
+ * 实现基于 IndexDB 存储的日志类
  */
-declare class PublishWriter extends RetryableWriter {
-    topic: string;
-    data: any;
-    targetId: string;
-    date: any;
-    syncMsg: boolean;
-    identifier: string;
-    constructor(topic: string, data: any, targetId: string);
-    writeMessage(stream: RongStreamWriter): void;
+declare class IndexDBLogger extends BasicLogger {
+    protected flush(data: ILogData): void;
 }
+
 /**
- * @description
- * 发消息, Server 给的 Ack 回执
+ * 消息被拦截类型
+ * @category Enum
  */
-declare class PubAckReader extends RetryableReader {
-    status: number;
-    date: number;
-    data: any;
-    millisecond: number;
-    messageUId: string;
-    timestamp: number;
-    identifier: string;
-    topic: string;
-    targetId: string;
-    readMessage(stream: RongStreamReader, length: number): {
-        stream: RongStreamReader;
-        length: number;
-    };
+declare enum MessageBlockType {
+    /**
+    全局敏感词：命中了融云内置的全局敏感词
+   */
+    GLOBAL = 1,
+    /**
+     自定义敏感词拦截：命中了客户在融云自定义的敏感词
+    */
+    CUSTOM = 2,
+    /**
+     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
+    */
+    THIRD_PARTY = 3
 }
 /**
- * @description
- * Web 主动查询
+ * 消息被拦截源触发类型
  */
-declare class QueryWriter extends RetryableWriter {
-    topic: string;
-    data: any;
-    targetId: string;
-    identifier: string;
-    constructor(topic: string, data: any, targetId: string);
-    writeMessage(stream: RongStreamWriter): void;
+declare enum MessageBlockSourceType {
+    /** 原始消息 */
+    MSG_ORIGINAL = 0,
+    /** 消息扩展 */
+    MSG_EXPANSION = 1,
+    /** 消息修改 */
+    MSG_MODIFY = 2
+}
+
+/**
+ * 消息方向
+ * @category Enum
+ */
+declare enum MessageDirection {
+    /**
+     * 己方发送消息
+     */
+    SEND = 1,
+    /**
+     * 己方接收消息
+     */
+    RECEIVE = 2
 }
 
 /**
@@ -395,21 +507,6 @@ declare enum FileType {
     COMBINE_HTML = 6
 }
 
-/**
- * 消息方向
- * @category Enum
- */
-declare enum MessageDirection {
-    /**
-     * 己方发送消息
-     */
-    SEND = 1,
-    /**
-     * 己方接收消息
-     */
-    RECEIVE = 2
-}
-
 /**
  * IM  错误码范围段
  * 2 开头为 IM Server 返回错误码
@@ -1384,6 +1481,7 @@ declare enum ChatroomEntryType {
 }
 
 /**
+ * @deprecated
  * 日志级别
  * @category Enum
  */
@@ -1397,13 +1495,15 @@ declare enum LogLevel {
     STATISTICS = 6,
     NONE = 1000
 }
+/**
+ * @deprecated
+ */
 declare enum LogSource {
     IM = "IM",
     RTC = "RTC"
 }
 /**
  * IMLib 埋点日志 Id 枚举
- * @desc 参考文档-https://rongcloud.yuque.com/tbvylv/znhprz/dpt9wf#fE9u
  */
 declare enum LogTagId {
     L_IMSDK_VER_O = "L-imsdk_ver-O",
@@ -1412,7 +1512,6 @@ declare enum LogTagId {
     L_INIT_O = "L-init-O",
     A_DESTROY_O = "A_DESTROY_O",
     L_DESTROY_O = "L_DESTROY_O",
-    P_INIT_O = "P-init-O",
     A_CONNECT_T = "A-connect-T",
     A_CONNECT_R = "A-connect-R",
     A_CONNECT_S = "A-connect-S",
@@ -1422,14 +1521,24 @@ declare enum LogTagId {
     L_CONNECT_T = "L-connect-T",
     L_CONNECT_R = "L-connect-R",
     L_CONNECT_S = "L-connect-S",
-    P_CONNECT_O = "P-connect-O",
-    P_CONNECT_S = "P-connect-S",
     L_NOTIFY_ULTRA_ONLINE_S = "L-notify-ultra-online-S",
     L_ULTRA_SYNC_DONE_S = "L-ultra-sync-done-S",
+    L_BATCH_MESSAGE_O = "L-BATCH_MESSAGE-O",
+    /** 业务层 APIContext onmessage 回调报错 */
+    A_MSG_LISTENER_E = "A-MSG_LISTENER-E",
+    /**
+     * @deprecated
+     * 用于保留迁移前的日志，后续删除
+     */
+    O = "L-original-O",
+    /** 插件安装 */
+    L_INSTALL_PLUGIN_T = "L-INSTALL_PLUGIN-T",
+    /** 插件安装结果 */
+    L_INSTALL_PLUGIN_R = "L-INSTALL_PLUGIN-R",
+    /** navi 配置错误 */
+    L_NAVI_CONF_E = "L-NAVI_CONF_ERROR-E",
     A_SEND_MSG_T = "A-send_msg-T",
     A_SEND_MSG_R = "A-send_msg-R",
-    P_SEND_MSG_T = "P-send_msg-T",
-    P_SEND_MSG_R = "P-send_msg-R",
     L_SEND_MSG_T = "L-send_msg-T",
     L_SEND_MSG_R = "L-send_msg-R",
     L_PULL_MSG_T = "L-pull_msg-T",
@@ -1449,7 +1558,6 @@ declare enum LogTagId {
     L_PULL_CONVERSATION_S = "L-pull_conversation-S",
     L_RECALL_ULTRA_MSG_S = "L-recall_ultra_msg-S",
     A_REGTYP_O = "A-regtyp-O",
-    P_REGTYP_O = "P-regtype-O",
     P_REGTYP_E = "P-regtype-E",
     L_GET_NAVI_T = "L-get_navi-T",
     L_GET_NAVI_R = "L-get_navi-R",
@@ -1487,7 +1595,26 @@ declare enum LogTagId {
     L_NOTIFY_NAVI_CHANGE_E = "L-notify_navi_change-E",
     L_REPORT_FULL_LOG_O = "L-report_full_log-O",
     L_REPORT_FULL_LOG_T = "L-report_full_log-T",
-    L_REPORT_FULL_LOG_R = "L-report_full_log-R"
+    L_REPORT_FULL_LOG_R = "L-report_full_log-R",
+    /** 解析 navi logPolicy 报错 */
+    L_REPORT_LOG_POLICY_E = "L-parse_navi_logpolicy-E",
+    /** 运行时环境不支持 IndexDB */
+    L_UNSUPPORT_INDEXDB_O = "L-unsupport_IndexDB-O",
+    L_LOGDB_OPEN_FAILED_E = "L-logDB_open_failed-E",
+    L_LOGDB_CLOSED_S = "L-logDB_closed-S",
+    L_LOGDB_ERROR_E = "L-logDB_error-S",
+    L_LOGDB_ABORT_S = "L-logDB_abort-S",
+    /** 实时日志上报 */
+    L_REALTIME_LOG_R = "L_REALTIME_LOG_R",
+    /** 实时日志上报结果 */
+    L_REALTIME_LOG_T = "L_REALTIME_LOG_T",
+    L_UNKNOWN_TOPIC_E = "L_UNKNOWN_TOPIC_E",
+    L_RECV_RMTP_O = "L_RECV_RMTP_O",
+    L_RECV_RMTP_E = "L_RECV_RMTP_E",
+    /** 版本号上报 */
+    L_VER_REPORT_T = "L-VER_REPORT-T",
+    /** 版本号上报结果 */
+    L_VER_REPORT_R = "L-VER_REPORT-R"
 }
 
 /**
@@ -1499,34 +1626,15 @@ declare enum ChatroomUserChangeType {
     JOIN = 1
 }
 
-/**
- * 消息被拦截类型
- * @category Enum
- */
-declare enum MessageBlockType {
-    /**
-    全局敏感词：命中了融云内置的全局敏感词
-   */
-    GLOBAL = 1,
+declare enum StoreKeys {
     /**
-     自定义敏感词拦截：命中了客户在融云自定义的敏感词
-    */
-    CUSTOM = 2,
+     * Navi 数据缓存，暂未使用
+     */
+    NAVI = "rc-navi",
     /**
-     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
-    */
-    THIRD_PARTY = 3
-}
-/**
- * 消息被拦截源触发类型
- */
-declare enum MessageBlockSourceType {
-    /** 原始消息 */
-    MSG_ORIGINAL = 0,
-    /** 消息扩展 */
-    MSG_EXPANSION = 1,
-    /** 消息修改 */
-    MSG_MODIFY = 2
+     * 实时日志已上报的时间戳
+     */
+    REALTIME_LOG_TIMESTAMP = "rc-realtime-log-timestamp"
 }
 
 declare enum UltraGroupChannelType {
@@ -1649,102 +1757,6 @@ declare enum RTCJoinType {
     COEXIST = 2
 }
 
-/**
- * 会话属性
- * @category Interface
- */
-interface IConversationOption {
-    conversationType: ConversationType;
-    targetId: string;
-    channelId?: string;
-}
-interface IServerRTCRoomEntry {
-    key: string;
-    value: string;
-    status: number;
-    timestamp: number;
-    uid: string;
-}
-interface IChrmKVEntry {
-    key: string;
-    value?: string;
-    isSendNotification?: boolean;
-    notificationExtra?: string;
-    isOverwrite?: boolean;
-    isAutoDelete?: boolean;
-    timestamp?: number;
-    userId?: string;
-    type?: number;
-    isDeleted?: boolean;
-    version?: number;
-}
-interface IChrmKVEntries {
-    entries: {
-        key: string;
-        value?: string;
-        timestamp?: number;
-        version?: number;
-    }[];
-    notificationExtra?: string;
-    isOverwrite?: boolean;
-    isAutoDelete?: boolean;
-    timestamp?: number;
-    userId?: string;
-    type?: number;
-    isDeleted?: boolean;
-}
-interface IChrmKVPullData {
-    kvEntries: IChrmKVEntry[];
-    isFullUpdate?: boolean;
-    syncTime?: number;
-}
-interface IServerConversationStatus {
-    conversationType: number;
-    targetId: string;
-    updatedTime?: number;
-    notificationStatus?: number;
-    notificationLevel?: number;
-    isTop?: boolean;
-    type?: number;
-    tags?: IConversationTag[];
-    channelId?: string;
-}
-interface IUserSettingItem {
-    targetId: number;
-    type: number;
-    key: string;
-    value: any;
-    version: number;
-    status: number;
-    tags: IConversationTag[];
-}
-interface IServerUserSetting {
-    settings: {
-        [key: string]: IUserSettingItem;
-    };
-    version: number;
-}
-interface ISyncMsgArgs {
-    inboxTime: number;
-    sendboxTime: number;
-    broadcastSyncTime?: number;
-}
-interface IGetMsgOption {
-    timestamp?: number;
-    count?: number;
-    order?: number;
-    channelId?: string;
-}
-interface IGetConversationListOption {
-    type?: number;
-    count?: number;
-    startTime?: number;
-    order?: 0 | 1;
-}
-interface IClearMsgOption {
-    timestamp?: number;
-}
-
 /**
  * @category Interface
  */
@@ -2405,189 +2417,6 @@ interface IUltraUnreadMsg {
     mentionedType?: number;
 }
 
-/**
- * TODO: 确定对外暴露的必要性
- * @deprecated
- */
-declare const DelayTimer: {
-    _delayTime: number;
-    /**
-     * 方法并未引用，getTimer 实际返回值始终为 Date.now()
-     * @deprecated
-     */
-    setTime: (time: number) => void;
-    getTime: () => number;
-};
-
-declare enum HttpMethod {
-    GET = "GET",
-    POST = "POST"
-}
-interface IRequest {
-    url: string;
-    /**
-     * @default `HttpMethod.GET`
-     */
-    method?: HttpMethod | 'GET' | 'POST';
-    /**
-     * 查询数据
-     */
-    query?: {
-        [key: string]: string | number | null;
-    };
-    /**
-     * Request Header 信息
-     */
-    headers?: {
-        [key: string]: string;
-    };
-    /**
-     * Request Body 数据
-     */
-    body?: Object | string;
-    /**
-     * 超时设置，默认 `60s`
-     */
-    timeout?: number;
-    /**
-     * 【Alipay-Only】
-     * 期望返回的数据格式，如果为 json 则返回后会对返回的数据进行一次 JSON.parse
-     */
-    dataType?: 'json' | 'text' | 'base64' | 'arraybuffer';
-}
-interface IStorage {
-    setItem(key: string, value: string): void;
-    getItem(key: string): string | null;
-    removeItem(key: string): void;
-    clear(): void;
-}
-interface IResponse {
-    status: number;
-    data?: string;
-}
-/**
- * 网络状态枚举
- */
-declare enum NetworkType {
-    WIFI = "wifi",
-    FOUR_G = "4g",
-    THREE_G = "3g",
-    TWO_G = "2g",
-    FIVE_G = "2g",
-    THREE_GENT = "3gnet",
-    UNKONWN = "unknown"
-}
-interface IWebSocket {
-    /**
-     * 监听连接建立事件，此时 WebSocket 实例已准备好收发数据
-     * @param callback
-     */
-    onOpen(callback: () => void): void;
-    /**
-     * 监听连接关闭事件
-     * @param callback
-     */
-    onClose(callback: (code?: number, reason?: string) => void): void;
-    /**
-     * 监听接收服务器消息事件
-     * @param callback
-     */
-    onMessage(callback: (data: string | ArrayBuffer) => void): void;
-    /**
-     * 监听链接错误事件
-     * @param callback
-     */
-    onError(callback: (error: unknown) => void): void;
-    /**
-     * 向服务器发送数据
-     * @param data
-     */
-    send(data: ArrayBuffer | string): void;
-    /**
-     * 关闭连接
-     * @param code
-     * @param reason
-     */
-    close(code?: number, reason?: string): void;
-}
-/**
- * 平台运行时抽象
- */
-interface IRuntime {
-    /**
-     * 平台标识
-     */
-    tag: string;
-    /**
-     * 发送 http 请求
-     * @param options
-     */
-    httpReq(options: IRequest): Promise<IResponse>;
-    /**
-     * 是否使用导航
-     */
-    useNavi: boolean;
-    /**
-     * websocket 地址上附加的平台字段
-     */
-    connectPlatform: string;
-    /**
-     * websocket 地址上 apiVer 字段，代表代码是否来源于 uniapp
-     */
-    isFromUniapp: boolean;
-    /**
-     * 创建长连接实例
-     */
-    createWebSocket?(url: string, protocols?: string[]): IWebSocket;
-    /**
-     * 存储模块
-     */
-    localStorage: IStorage;
-    /**
-     * 在某些非浏览器平台，其等同于 localStorage
-     */
-    sessionStorage: IStorage;
-    /**
-     * 获取网络状态
-     * 2g 3g 4g wifi unkown
-     */
-    getNetworkType(): Promise<NetworkType>;
-}
-
-/**
- * @category Interface
- */
-interface IAsyncRes<T = void> {
-    /**
-     * Promise 执行结果
-     */
-    code: ErrorCode;
-    /**
-     * 结果数据
-     */
-    data?: T;
-    /**
-     * 错误消息
-     */
-    msg?: string;
-}
-/**
- * 异步任务结果定义
- * @description
- * 通过 `Promise.resolve` 来处理预期内的异常，进而通过 Uncatch Promise Error 暴露预期外的异常
- */
-declare type IPromiseResult<T = void> = Promise<IAsyncRes<T>>;
-interface IConnectResult {
-    /**
-     * 连接错误码
-     */
-    code: ErrorCode;
-    /**
-     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
-     */
-    userId?: string;
-}
-
 /**
  * 从服务器拉取到的会话数据结构
  * @category Interface
@@ -2929,8 +2758,13 @@ interface INaviInfo {
      */
     logSwitch: number;
     /**
-     * 实时日志上传策略
-     * @example `'{ "url": "logcollection.ronghub.com", "level": 1,"itv": 6, "times": 5 }'`
+     * 实时日志上传策略，值为 JSON 字符串
+     * @example `'{
+     * "url": "logcollection.ronghub.com", // 上传地址
+     * "level": 1,                         // 日志等级
+     * "itv": 6,                           // 上传频率，即时间间隔，单位 s
+     * "times": 5                          // 重试次数？
+     * }'`
      */
     logPolicy: string;
     /**
@@ -3278,64 +3112,233 @@ interface IUploadAuth {
      */
     s3BucketName: string;
     /**
-     * stc  Authorization 头
+     * stc  Authorization 头
+     */
+    stcAuthorization: string;
+    /**
+     * stc  xAmzContentSha256
+     */
+    stcContentSha256: string;
+    /**
+     * stc date
+     */
+    stcDate: string;
+    /**
+     * stc 存储空间名称
+     */
+    stcBucketName: string;
+}
+
+interface IRTCRoomInfo {
+    roomId: string;
+    roomData: unknown[];
+    userCount: number;
+    list: unknown[];
+}
+interface IRtcTokenData {
+    rtcToken: string;
+}
+interface IRTCUsers {
+    users: {
+        [userId: string]: {
+            /**
+             * 发布的资源数据，是一个 JSON 字符串，解析后为发布的资源列表
+             */
+            uris?: string;
+            /**
+             * 加房间的身份标识，保存主房间 roomId
+             */
+            extra?: string;
+        };
+    };
+}
+interface IJoinRTCRoomData extends IRTCUsers {
+    token: string;
+    sessionId: string;
+    roomInfo: {
+        key: string;
+        value: string;
+    }[];
+    kvEntries: IServerRTCRoomEntry[];
+    offlineKickTime: number;
+}
+interface KVString {
+    [key: string]: string;
+}
+/**
+ * 设置 RTC 人员 inner、outer 数据
+ */
+interface IRTCUserData {
+    [key: string]: string;
+}
+
+/**
+ * @category Interface
+ */
+interface IAsyncRes<T = void> {
+    /**
+     * Promise 执行结果
+     */
+    code: ErrorCode;
+    /**
+     * 结果数据
+     */
+    data?: T;
+    /**
+     * 错误消息
+     */
+    msg?: string;
+}
+/**
+ * 异步任务结果定义
+ * @description
+ * 通过 `Promise.resolve` 来处理预期内的异常，进而通过 Uncatch Promise Error 暴露预期外的异常
+ */
+declare type IPromiseResult<T = void> = Promise<IAsyncRes<T>>;
+interface IConnectResult {
+    /**
+     * 连接错误码
+     */
+    code: ErrorCode;
+    /**
+     * 导航获取成功后即可有相应的值，在导航数据获取完成之前该值为 undefined
+     */
+    userId?: string;
+}
+
+declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST"
+}
+interface IRequest {
+    url: string;
+    /**
+     * @default `HttpMethod.GET`
+     */
+    method?: HttpMethod | 'GET' | 'POST';
+    /**
+     * 查询数据
+     */
+    query?: {
+        [key: string]: string | number | null;
+    };
+    /**
+     * Request Header 信息
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * Request Body 数据
+     */
+    body?: Object | string;
+    /**
+     * 超时设置，默认 `60s`
+     */
+    timeout?: number;
+    /**
+     * 【Alipay-Only】
+     * 期望返回的数据格式，如果为 json 则返回后会对返回的数据进行一次 JSON.parse
+     */
+    dataType?: 'json' | 'text' | 'base64' | 'arraybuffer';
+}
+interface IStorage {
+    setItem(key: string, value: string): void;
+    getItem(key: string): string | null;
+    removeItem(key: string): void;
+    clear(): void;
+}
+interface IResponse {
+    status: number;
+    data?: string;
+}
+/**
+ * 网络状态枚举
+ */
+declare enum NetworkType {
+    WIFI = "wifi",
+    FOUR_G = "4g",
+    THREE_G = "3g",
+    TWO_G = "2g",
+    FIVE_G = "2g",
+    THREE_GENT = "3gnet",
+    UNKONWN = "unknown"
+}
+interface IWebSocket {
+    /**
+     * 监听连接建立事件，此时 WebSocket 实例已准备好收发数据
+     * @param callback
+     */
+    onOpen(callback: () => void): void;
+    /**
+     * 监听连接关闭事件
+     * @param callback
+     */
+    onClose(callback: (code?: number, reason?: string) => void): void;
+    /**
+     * 监听接收服务器消息事件
+     * @param callback
+     */
+    onMessage(callback: (data: string | ArrayBuffer) => void): void;
+    /**
+     * 监听链接错误事件
+     * @param callback
+     */
+    onError(callback: (error: unknown) => void): void;
+    /**
+     * 向服务器发送数据
+     * @param data
+     */
+    send(data: ArrayBuffer | string): void;
+    /**
+     * 关闭连接
+     * @param code
+     * @param reason
+     */
+    close(code?: number, reason?: string): void;
+}
+/**
+ * 平台运行时抽象
+ */
+interface IRuntime {
+    /**
+     * 平台标识
+     */
+    tag: string;
+    /**
+     * 发送 http 请求
+     * @param options
+     */
+    httpReq(options: IRequest): Promise<IResponse>;
+    /**
+     * 是否使用导航
+     */
+    useNavi: boolean;
+    /**
+     * websocket 地址上附加的平台字段
+     */
+    connectPlatform: string;
+    /**
+     * websocket 地址上 apiVer 字段，代表代码是否来源于 uniapp
+     */
+    isFromUniapp: boolean;
+    /**
+     * 创建长连接实例
      */
-    stcAuthorization: string;
+    createWebSocket?(url: string, protocols?: string[]): IWebSocket;
     /**
-     * stc  xAmzContentSha256
+     * 存储模块
      */
-    stcContentSha256: string;
+    localStorage: IStorage;
     /**
-     * stc date
+     * 在某些非浏览器平台，其等同于 localStorage
      */
-    stcDate: string;
+    sessionStorage: IStorage;
     /**
-     * stc 存储空间名称
+     * 获取网络状态
+     * 2g 3g 4g wifi unkown
      */
-    stcBucketName: string;
-}
-
-interface IRTCRoomInfo {
-    roomId: string;
-    roomData: unknown[];
-    userCount: number;
-    list: unknown[];
-}
-interface IRtcTokenData {
-    rtcToken: string;
-}
-interface IRTCUsers {
-    users: {
-        [userId: string]: {
-            /**
-             * 发布的资源数据，是一个 JSON 字符串，解析后为发布的资源列表
-             */
-            uris?: string;
-            /**
-             * 加房间的身份标识，保存主房间 roomId
-             */
-            extra?: string;
-        };
-    };
-}
-interface IJoinRTCRoomData extends IRTCUsers {
-    token: string;
-    sessionId: string;
-    roomInfo: {
-        key: string;
-        value: string;
-    }[];
-    kvEntries: IServerRTCRoomEntry[];
-    offlineKickTime: number;
-}
-interface KVString {
-    [key: string]: string;
-}
-/**
- * 设置 RTC 人员 inner、outer 数据
- */
-interface IRTCUserData {
-    [key: string]: string;
+    getNetworkType(): Promise<NetworkType>;
 }
 
 /**
@@ -4202,73 +4205,411 @@ interface IGroupMessageDeliveredStatusInfo {
     MessageUId: string;
     deliveryCount: number;
 }
-interface IGroupMessageDeliverStatus {
-    totalCount: number;
-    list: IGroupMessageDeliveredStatusInfo[];
+interface IGroupMessageDeliverStatus {
+    totalCount: number;
+    list: IGroupMessageDeliveredStatusInfo[];
+}
+
+/**
+ * IndexDB中存储的log数据
+ */
+interface ILogInfo {
+    sessionId: string;
+    time: number;
+    level: LogLevel;
+    content: string;
+    userId?: string;
+    logSource?: LogSource;
+    tagId?: LogTagId;
+}
+interface IRealTimeLog {
+    level: LogLevel;
+    content: string;
+}
+interface ILogExtensions {
+    traceId?: string;
+    logSource?: LogSource;
+}
+interface ILogInit {
+    userId?: string;
+    localLogLevel?: LogLevel;
+    customLogPrint?: (logLevel: LogLevel, msg: string) => void;
+}
+interface IInitBigDataOption {
+    runtime?: IRuntime;
+    appkey?: string;
+    version?: string;
+    userId?: string;
+}
+interface IBigdataLogInit extends IInitBigDataOption {
+    logUrl: string;
+    sessionId: string;
+}
+
+/**
+ * 定义已废弃，请使用 `IRemoveChatroomEntries` 替换
+ * @deprecated
+ */
+declare type IRemoveChatRoomEntries = IRemoveChatroomEntries;
+/**
+ * 定义已废弃，请使用 `IChatroomEntry` 替换
+ * @deprecated
+ */
+declare type IChatRoomEntry = IChatroomEntry;
+/**
+ * 定义已废弃，请使用 `IChatroomEntries` 替换
+ * @deprecated
+ */
+declare type IChatRoomEntries = IChatroomEntries;
+/**
+ * 定义已废弃，请使用 `IRemoveChatroomEntry` 替换
+ * @deprecated
+ */
+declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
+
+/**
+ * 日志上报工具，负责处理实时日志上报和下消息拉日志业务。
+ * 通过 DB 和 Logger 两个抽象接口组合使用，
+ * 避免业务与不同平台不同的 DB 数据库耦合，从而最大限度代码复用，
+ * 上报工具仅处理业务，无需关心 DB 和 Logger 的实际类型
+ */
+declare abstract class BasicReporter {
+    private appkey;
+    private deviceId;
+    /**
+     * 设备描述信息
+     */
+    private deviceInfo;
+    /**
+     * Logger 数据库实例，有日志数据库的读写方法，使上报与数据库解耦
+     */
+    protected readonly logDB: ILogDB;
+    /**
+     * logger 实例
+     */
+    protected readonly logger: BasicLogger;
+    /**
+     * 当前用户 id
+     */
+    protected userId: string;
+    constructor(appkey: string, deviceId: string, 
+    /**
+     * 设备描述信息
+     */
+    deviceInfo: string, 
+    /**
+     * Logger 数据库实例，有日志数据库的读写方法，使上报与数据库解耦
+     */
+    logDB: ILogDB, 
+    /**
+     * logger 实例
+     */
+    logger: BasicLogger);
+    private timer;
+    protected started: boolean;
+    /**
+     * 根据配置启动实时日志上报，在导航获取完成后启动，导航中包含 userId 信息
+     * 实时日志仅获取当前时间 - 10s 以前的日志上报，避免多页面并行写库造成数据遗漏
+     */
+    checkStart(navi: INaviInfo): Promise<void>;
+    /**
+     * 实时日志上报
+     * @override IndexDBReporter 重载此方法，增加同设备多页面多端时进程竞争检测
+     */
+    protected realtimeReport(url: string, level: LogL, itv: number): Promise<void>;
+    private sendLogs;
+    /**
+     * 处理下消息拉日志，以拉取包含 `LogL.DEBUG` 级别的全量日志
+     * @param startTime 拉取起始时间
+     * @param endTime 拉取结束时间
+     * @param platform 平台
+     * @param uri 本次拉取的上传地址，若无值，使用导航配置下发地址
+     * @param logId 拉取事务 Id，用于上传日志时的 Http 请求
+     * @param messageUId 消息 messageUId
+     */
+    report(startTime: number, endTime: number, platform: string, uri: string, logId: string, messageUId: string): Promise<void>;
+    private transcsv;
+    /**
+     * 以 `POST` 方法向服务发送日志数据
+     * @param url
+     * @param content
+     */
+    protected abstract send(req: IRequest): Promise<IResponse>;
+    /**
+     * 清理计时器，停止定时任务
+     */
+    stop(): void;
+}
+
+declare class IndexDBReporter extends BasicReporter {
+    private runtime;
+    /**
+     * 客户端配置的上报等级，仅限 Beem IndexDB 日志版本可用，不设置时，以服务器 navi 下发配置为准
+     */
+    private clientReportLevel?;
+    constructor(appkey: string, runtime: IRuntime, logger: BasicLogger, 
+    /**
+     * 客户端配置的上报等级，仅限 Beem IndexDB 日志版本可用，不设置时，以服务器 navi 下发配置为准
+     */
+    clientReportLevel?: EnableLogL | undefined);
+    protected send(req: IRequest): Promise<IResponse>;
+    /**
+     * @override 重写实现
+     */
+    checkStart(navi: INaviInfo): Promise<void>;
+    /**
+     * 进程竞争检测，检查是否为执行上报的进程
+     * @param callback
+     * @returns
+     */
+    private isReporter;
+    /**
+     * @param startTime
+     * @param endTime
+     * @param platform
+     * @param uri
+     * @param logId
+     * @param messageUId
+     */
+    report(startTime: number, endTime: number, platform: string, uri: string, logId: string, messageUId: string): Promise<void>;
+    protected realtimeReport(url: string, level: LogL, itv: number): Promise<void>;
+}
+
+/**
+ * 初始化 DB 模块，按 APPKEY 分库，后续需要将日志与业务数据库也分开
+ * @param appkey
+ */
+declare const initLogDB: (appkey: string, logger: ILogger) => void;
+/**
+ * IndexDB 日志数据库反初始化，在切换 APPKEY 时调用
+ * @returns
+ */
+declare const deInitLogDB: () => Promise<void>;
+
+/**
+ * @description
+ * 读数据处理基类
+*/
+declare class BaseReader {
+    readonly header: Header;
+    messageId: number;
+    timestamp: number;
+    syncMsg: boolean;
+    protected identifier: string;
+    constructor(header: Header);
+    getIdentifier(): string | number;
+    read(logger: ILogger, stream: RongStreamReader, length: number, protocolVer: ConnAckProtocolVer): void;
+    readMessage(logger: ILogger, stream: RongStreamReader, length?: number, protocolVer?: ConnAckProtocolVer): {
+        stream: RongStreamReader;
+        length: number | undefined;
+    };
+}
+/**
+ * @description
+ * 写数据处理基类
+ */
+declare abstract class BaseWriter {
+    private _header;
+    lengthSize: number;
+    data: any;
+    messageId: number;
+    topic: string;
+    targetId: string;
+    identifier: string;
+    constructor(headerType: OperationType);
+    getIdentifier(): string | number;
+    write(stream: RongStreamWriter): void;
+    abstract writeMessage(stream: RongStreamWriter): void;
+    setHeaderQos(qos: number): void;
+    getHeaderFlag(): number;
+    getLengthSize(): number;
+    getBufferData(): Int8Array;
+}
+declare class RetryableReader extends BaseReader {
+    messageId: number;
+    readMessage(logger: ILogger, stream: RongStreamReader, length: number): {
+        stream: RongStreamReader;
+        length: number;
+    };
+}
+declare class RetryableWriter extends BaseWriter {
+    writeMessage(stream: RongStreamWriter): void;
+}
+declare class PublishReader extends RetryableReader {
+    topic: string;
+    data: any;
+    targetId: string;
+    date: any;
+    syncMsg: boolean;
+    identifier: string;
+    readMessage(logger: ILogger, stream: RongStreamReader, length: number): {
+        stream: RongStreamReader;
+        length: number;
+    };
+}
+/**
+ * @description
+ * 发消息使用
+ */
+declare class PublishWriter extends RetryableWriter {
+    topic: string;
+    data: any;
+    targetId: string;
+    date: any;
+    syncMsg: boolean;
+    identifier: string;
+    constructor(topic: string, data: any, targetId: string);
+    writeMessage(stream: RongStreamWriter): void;
+}
+/**
+ * @description
+ * 发消息, Server 给的 Ack 回执
+ */
+declare class PubAckReader extends RetryableReader {
+    status: number;
+    date: number;
+    data: any;
+    millisecond: number;
+    messageUId: string;
+    timestamp: number;
+    identifier: string;
+    topic: string;
+    targetId: string;
+    readMessage(logger: ILogger, stream: RongStreamReader, length: number): {
+        stream: RongStreamReader;
+        length: number;
+    };
+}
+/**
+ * @description
+ * Web 主动查询
+ */
+declare class QueryWriter extends RetryableWriter {
+    topic: string;
+    data: any;
+    targetId: string;
+    identifier: string;
+    constructor(topic: string, data: any, targetId: string);
+    writeMessage(stream: RongStreamWriter): void;
 }
 
 /**
- * IndexDB中存储的log数据
+ * 会话属性
+ * @category Interface
  */
-interface ILogInfo {
-    sessionId: string;
-    time: number;
-    level: LogLevel;
-    content: string;
-    userId?: string;
-    logSource?: LogSource;
-    tagId?: LogTagId;
-}
-interface IRealTimeLog {
-    level: LogLevel;
-    content: string;
+interface IConversationOption {
+    conversationType: ConversationType;
+    targetId: string;
+    channelId?: string;
 }
-interface ILogExtensions {
-    traceId?: string;
-    logSource?: LogSource;
+interface IServerRTCRoomEntry {
+    key: string;
+    value: string;
+    status: number;
+    timestamp: number;
+    uid: string;
 }
-interface ILogInit {
+interface IChrmKVEntry {
+    key: string;
+    value?: string;
+    isSendNotification?: boolean;
+    notificationExtra?: string;
+    isOverwrite?: boolean;
+    isAutoDelete?: boolean;
+    timestamp?: number;
     userId?: string;
-    localLogLevel?: LogLevel;
-    customLogPrint?: (logLevel: LogLevel, msg: string) => void;
+    type?: number;
+    isDeleted?: boolean;
+    version?: number;
 }
-interface IInitBigDataOption {
-    runtime?: IRuntime;
-    appkey?: string;
-    version?: string;
+interface IChrmKVEntries {
+    entries: {
+        key: string;
+        value?: string;
+        timestamp?: number;
+        version?: number;
+    }[];
+    notificationExtra?: string;
+    isOverwrite?: boolean;
+    isAutoDelete?: boolean;
+    timestamp?: number;
     userId?: string;
+    type?: number;
+    isDeleted?: boolean;
 }
-interface IBigdataLogInit extends IInitBigDataOption {
-    logUrl: string;
-    sessionId: string;
+interface IChrmKVPullData {
+    kvEntries: IChrmKVEntry[];
+    isFullUpdate?: boolean;
+    syncTime?: number;
+}
+interface IServerConversationStatus {
+    conversationType: number;
+    targetId: string;
+    updatedTime?: number;
+    notificationStatus?: number;
+    notificationLevel?: number;
+    isTop?: boolean;
+    type?: number;
+    tags?: IConversationTag[];
+    channelId?: string;
+}
+interface IUserSettingItem {
+    targetId: number;
+    type: number;
+    key: string;
+    value: any;
+    version: number;
+    status: number;
+    tags: IConversationTag[];
+}
+interface IServerUserSetting {
+    settings: {
+        [key: string]: IUserSettingItem;
+    };
+    version: number;
+}
+interface ISyncMsgArgs {
+    inboxTime: number;
+    sendboxTime: number;
+    broadcastSyncTime?: number;
+}
+interface IGetMsgOption {
+    timestamp?: number;
+    count?: number;
+    order?: number;
+    channelId?: string;
+}
+interface IGetConversationListOption {
+    type?: number;
+    count?: number;
+    startTime?: number;
+    order?: 0 | 1;
+}
+interface IClearMsgOption {
+    timestamp?: number;
 }
 
 /**
- * 定义已废弃，请使用 `IRemoveChatroomEntries` 替换
- * @deprecated
- */
-declare type IRemoveChatRoomEntries = IRemoveChatroomEntries;
-/**
- * 定义已废弃，请使用 `IChatroomEntry` 替换
- * @deprecated
- */
-declare type IChatRoomEntry = IChatroomEntry;
-/**
- * 定义已废弃，请使用 `IChatroomEntries` 替换
- * @deprecated
- */
-declare type IChatRoomEntries = IChatroomEntries;
-/**
- * 定义已废弃，请使用 `IRemoveChatroomEntry` 替换
+ * TODO: 确定对外暴露的必要性
  * @deprecated
  */
-declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
+declare const DelayTimer: {
+    _delayTime: number;
+    /**
+     * 方法并未引用，getTimer 实际返回值始终为 Date.now()
+     * @deprecated
+     */
+    setTime: (time: number) => void;
+    getTime: () => number;
+};
 
 /**
  * 序列化、反序列化数据通道
 */
 declare class DataCodec {
+    private logger;
     private _codec;
+    constructor(logger: BasicLogger);
     private static createPBCodec;
     /**
      * PB 数据 转为 rmtp 数据 反序列化 通用数据
@@ -4550,6 +4891,7 @@ interface IDataChannelWatcher {
 declare class WebSocketChannel {
     private _runtime;
     private _watcher;
+    private logger;
     readonly codec: DataCodec;
     connectedTime: number;
     userId: string;
@@ -4564,7 +4906,7 @@ declare class WebSocketChannel {
      * 接收多端同步消息时，等待 PubAck 的 Promise.resolve 函数
      */
     private _syncMessageIds;
-    constructor(_runtime: IRuntime, _watcher: IDataChannelWatcher);
+    constructor(_runtime: IRuntime, _watcher: IDataChannelWatcher, logger: BasicLogger);
     /**
      * 建立连接，连接成功则返回 Websocket 实例，否则返回连接错误码
      * @param appkey
@@ -4691,10 +5033,6 @@ interface IAPIContextOption {
      * IMLib 版本号
      */
     apiVersion: string;
-    /**
-    * IMLib 包名
-    */
-    apiPKGName?: string;
     /**
      * 自定义导航地址:
      * 1. 私有云环境下该值为必填项
@@ -4706,55 +5044,18 @@ interface IAPIContextOption {
      * 7. 公有云默认使用 https 协议
      */
     navigators: string[];
-    /**
-     * (参数已废弃)~~c++ 协议栈数据库地址~~
-     * @deprecated
-    */
-    dbPath?: string;
     /**
      * 小程序的 CMP 代理地址
      */
     miniCMPProxy: string[];
-    /**
-     * 修改 engine log 打印等级
-     */
-    logLevel?: LogLevel;
-    /**
-     * 修改默认的 log 输出函数
-     */
-    logStdout?: (logLevel: LogLevel, content: string) => void;
-    /**
-     * （已废弃）私有云标识
-     * @deprecated
-     */
-    isEnterPrise?: boolean;
     /**
      * typing状态过期时间
      */
     typingExpireTime?: number;
-    /**
-     * 是否打开 IndexDB 存储，默认为 true
-     */
-    indexDBSwitch?: boolean;
     /**
      * 是否校验证书，默认为 true
      */
     checkCA?: boolean;
-    /**
-     * TODO: 自定义策略覆盖服务策略有安全风险，等产品确认通用化逻辑，是否前后端共同建立双重开关
-     * 目前仅 Beem Web-Meeting 使用
-     * @deprecated
-     * @hidden
-     * 实时日志收集功能自定义上传策略
-     * @param {number} logSwitch 日志收集功能开关，0 关闭；1 开启
-     * @param {LogLevel} level 日志上传级别
-     * @param {number} itv: interval 即日志上传间隔，单位秒，最小时间间隔 1 秒
-     */
-    logPolicy?: {
-        logSwitch?: number;
-        level?: LogLevel;
-        itv?: number;
-    };
     /**
      * 开启后，SDK 内的 HTTP 请求将由 Electron 主进程内发送。
      * @since 5.6.0
@@ -4766,6 +5067,16 @@ interface IAPIContextOption {
      * @defautl `false`
      */
     httpInMainProcess: boolean;
+    /**
+     * 修改内部日志打印等级，默认输出 `LogL.WARN` 及以上级别
+     */
+    logOutputLevel?: EnableLogL;
+    /**
+     * 自定义实时日志上报等级。当实时日志开启时，该等级配置会覆盖服务下发配置！不配置时，以服务下发配置为准。
+     * @hidden
+     * @deprecated
+     */
+    __reportLogLevel?: EnableLogL;
 }
 
 interface IPluginGenerator<API, InitOption> {
@@ -4806,12 +5117,20 @@ declare class Codec<T> {
      * Key 对应的 Value 结构映射表，用于不同 Key 数据的编解码
      */
     private pbmaps;
+    /**
+     * 允许不传 logger 实例以向前兼容
+     */
+    private logger?;
     private readonly pbModules;
     constructor(
     /**
      * Key 对应的 Value 结构映射表，用于不同 Key 数据的编解码
      */
-    pbmaps: T, pbDefined: string);
+    pbmaps: T, pbDefined: string, 
+    /**
+     * 允许不传 logger 实例以向前兼容
+     */
+    logger?: ILogger | undefined);
     getModule(pbname: string): any;
     /**
      * 数据序列化
@@ -4856,7 +5175,6 @@ declare class APIContext {
     readonly coreVersion: string;
     readonly appkey: string;
     readonly apiVersion: string;
-    readonly apiPKGName: string;
     private readonly _options;
     private _versionInfo;
     private _typingInfo;
@@ -4869,6 +5187,10 @@ declare class APIContext {
      * 包括向 CppEngine 提供 RTC 业务编解码能力
      */
     private readonly _rtcCodec;
+    /**
+     * engine 内部日志工具
+     */
+    readonly logger: BasicLogger;
     constructor(_runtime: IRuntime, options: IAPIContextOption);
     createCodec<T extends CodecPBMaps>(keymaps: T, pbDesc: string): Codec<T>;
     /**
@@ -5570,6 +5892,7 @@ declare class APIContext {
     getConversationListWithAllChannel(): Promise<IAsyncRes<IReceivedConversation[]>>;
     getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
     clearData(): Promise<IAsyncRes<boolean>>;
+    createLogger(id: string, type: LogType): BasicLogger;
     rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
         code: ErrorCode;
         buffer?: Uint8Array;
@@ -5744,6 +6067,12 @@ declare class PluginContext {
         key: string;
         value: string;
     }>;
+    /**
+     * 创建 logger 实例
+     * @param id 日志工具 ID，用于区分日志实例，以确定日志调用者身份
+     * @param type 目前仅支持 `IM` 与 `RTC` 两个值
+     */
+    createLogger(id: string, type: LogType): BasicLogger;
 }
 
 declare class RTCPluginContext extends PluginContext {
@@ -5934,7 +6263,6 @@ declare class RTCPluginContext extends PluginContext {
     onrtcdatachange?(data: IServerRTCRoomEntry[], roomdId?: string): void;
     /**
      * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
-     * @deprecated
      */
     getRTCJoinedUserInfo(userId: string): IPromiseResult<IRTCJoinedInfo[]>;
 }
@@ -5984,6 +6312,7 @@ declare abstract class AEngine implements IEngine {
     readonly rtcCodec: Codec<RTCKeyMaps>;
     protected readonly _watcher: IEngineWatcher;
     protected readonly _options: IAPIContextOption;
+    protected readonly logger: BasicLogger;
     /**
      * 连接时间
     */
@@ -5996,7 +6325,7 @@ declare abstract class AEngine implements IEngine {
      * 引擎初始化
      * @param _appkey
      */
-    constructor(runtime: IRuntime, rtcCodec: Codec<RTCKeyMaps>, _watcher: IEngineWatcher, _options: IAPIContextOption);
+    constructor(runtime: IRuntime, rtcCodec: Codec<RTCKeyMaps>, _watcher: IEngineWatcher, _options: IAPIContextOption, logger: BasicLogger);
     protected _rtcSignalingListener?: (buffer: Uint8Array) => void;
     /**
      * 注册 RTC KV 变更监听器
@@ -6005,6 +6334,14 @@ declare abstract class AEngine implements IEngine {
     registerRTCSignalingListener(listener: ((buffer: Uint8Array) => void) | undefined): void;
     abstract requestNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
     abstract updateNaviInfo(naviInfo: INaviInfo): void;
+    /**
+     * 为非 engine 包创建 logger 工具实例
+     */
+    abstract createLogger(id: string, type: LogType): BasicLogger;
+    /**
+     * 获取 engine 包内部 logger 工具
+     */
+    getInnerLogger(): BasicLogger;
     /**
      * 获取导航数据
      * @param token
@@ -6737,6 +7074,10 @@ declare abstract class AEngine implements IEngine {
      * 接收 rtc 资源变更
      */
     protected _receiveRtcKv(buffer: Uint8Array): void;
+    /**
+     * Engine 反初始化
+     */
+    destroy(): void;
 }
 
 declare class AppStorage {
@@ -6894,8 +7235,8 @@ declare const isValidExpansion: (expansion: {
     [key: string]: string;
 } | undefined) => IIsValidExpansion;
 
-declare const sessionId: string;
 /**
+ * @deprecated
  * logLevelTransformer
  * @description 数据中心与前端日志规范LogLevel定义不统一
  *              WebLogLevel(前端日志级别) -> ServerLogLevel（服务器日志级别）
@@ -6904,40 +7245,40 @@ declare const sessionId: string;
  */
 declare function logLevelTransformer(level: LogLevel): number;
 /**
- * 序列化引用型数据为字符串
- * @value value
+ * @deprecated
+ * Trace ID 生成器
  */
-declare const formatLogObj: (value: unknown) => unknown;
-/**
-* 缓存日志
-* @param logLevel 打印等级
-* @param logObj 日志内容
-* @param tagId 日志tag
-*/
-declare function insertIntoLogCache(logLevel: LogLevel, tagId: string, logObj: any, logSource?: LogSource): ILogInfo;
+declare function ID(): string;
 /**
- * 本地默认输出函数
- * @param level
- * @param args
+ * @deprecated
  */
-declare function _defaultStdout(level: LogLevel, msgTag: string, ...logContents: any[]): void;
+declare function init(userLogInfo: ILogInit): void;
 /**
- *  Trace ID 生成器
+ * @deprecated
  */
-declare function ID(): string;
-declare function init(userLogInfo: ILogInit): void;
 declare function log(logLevel: LogLevel, tagId: LogTagId | string, logObj?: Object, logExtens?: ILogExtensions): void;
+/**
+ * @deprecated
+ */
 declare const debug: (tagId: string, logObj?: Object | undefined, logExtens?: ILogExtensions | undefined) => void;
+/**
+ * @deprecated
+ */
 declare const info: (tagId: string, logObj?: Object | undefined, logExtens?: ILogExtensions | undefined) => void;
+/**
+ * @deprecated
+ */
 declare const warn: (tagId: string, logObj?: Object | undefined, logExtens?: ILogExtensions | undefined) => void;
+/**
+ * @deprecated
+ */
 declare const error: (tagId: string, logObj?: Object | undefined, logExtens?: ILogExtensions | undefined) => void;
+/**
+ * @deprecated
+ */
 declare const fatal: (tagId: string, logObj?: Object | undefined, logExtens?: ILogExtensions | undefined) => void;
 
-declare const base_sessionId: typeof sessionId;
 declare const base_logLevelTransformer: typeof logLevelTransformer;
-declare const base_formatLogObj: typeof formatLogObj;
-declare const base_insertIntoLogCache: typeof insertIntoLogCache;
-declare const base__defaultStdout: typeof _defaultStdout;
 declare const base_ID: typeof ID;
 declare const base_init: typeof init;
 declare const base_log: typeof log;
@@ -6948,11 +7289,7 @@ declare const base_error: typeof error;
 declare const base_fatal: typeof fatal;
 declare namespace base {
   export {
-    base_sessionId as sessionId,
     base_logLevelTransformer as logLevelTransformer,
-    base_formatLogObj as formatLogObj,
-    base_insertIntoLogCache as insertIntoLogCache,
-    base__defaultStdout as _defaultStdout,
     base_ID as ID,
     base_init as init,
     base_log as log,
@@ -6964,18 +7301,8 @@ declare namespace base {
   };
 }
 
-/** *********************实时日志上报***************** */
-
 /**
  * @deprecated
- * 缓存日志实时
- * @param {LogLevel} logLevel 日志等级
- * @param tagId 日志标签
- * @param content 日志内容
- */
-declare function reportLog(logLevel: LogLevel, tagId: string, content: string, logSource?: LogSource): void;
-
-/**
  * @description 兼容旧版用法，建议用Logger静态方法
  *  1、不符合新版Web日志规范
  *  2、不支持自定义TagId
@@ -6993,31 +7320,39 @@ declare class Logger {
      */
     constructor(tagId: string, logSource?: LogSource | undefined, initiator?: string | undefined);
     /**
-     *  本地控制台日志输出级别
-     */
-    private _localLogLevel;
-    /**
-     * 自定义本地日志输出函数
-     */
-    private _customLogPrint?;
-    /**
-     * 为向前兼容，暂不删除
-     */
-    private _stdout?;
-    /**
+     * @deprecated
      * 自定义本地打印日志级别
      * @param logLevel
      */
     setLogLevel(logLevel?: LogLevel): void;
     /**
+     * @deprecated
      * 自定义本地打印函数
      */
     setLogStdout(stdout?: (level: LogLevel, content: string) => void): void;
-    log(logLevel: LogLevel, ...args: any[]): void;
+    /**
+     * @deprecated
+     */
+    private log;
+    /**
+     * @deprecated
+     */
     debug: (...args: any[]) => void;
+    /**
+     * @deprecated
+     */
     info: (...args: any[]) => void;
+    /**
+     * @deprecated
+     */
     warn: (...args: any[]) => void;
+    /**
+     * @deprecated
+     */
     error: (...args: any[]) => void;
+    /**
+     * @deprecated
+     */
     fatal: (...args: any[]) => void;
     /**
      * @deprecated
@@ -7030,9 +7365,11 @@ declare class Logger {
      * @deprecated
      */
     setStdout(stdout?: (level: LogLevel, msgTag: string, ...args: any[]) => void): void;
-    reportLog: typeof reportLog;
 }
-declare const _default: Logger;
+/**
+ * @deprecated
+ */
+declare const logger: Logger;
 
 declare const getUUID: () => string;
 declare const getUUID22: () => string;
@@ -7106,10 +7443,6 @@ declare const assert: (key: string, value: any, validator: AssertRules | ((value
  */
 declare const validate: (key: string, value: any, validator: AssertRules | ((value?: any) => boolean), required?: boolean) => boolean;
 
-/**
- * engine 层业务相关工具方法
-*/
-
 /**
  * 通过文件类型生成上传唯一文件名
 */
@@ -7128,7 +7461,7 @@ declare const pushConfigsToJSON: (iOSConfig?: IiOSPushConfig, androidConfig?: IA
  * 将服务端返回的 push 信息格式化
  * @param pushStr
  */
-declare const pushJSONToConfigs: (pushStr: string, pushId: string) => {
+declare const pushJSONToConfigs: (logger: BasicLogger, pushStr: string, pushId: string) => {
     iOSConfig: IiOSPushConfig;
     androidConfig: IAndroidPushConfig;
 };
@@ -7286,4 +7619,4 @@ declare type AbsCodec<T> = Codec<T>;
  */
 declare const version: string;
 
-export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, Codec, CodecPBMaps, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBigdataLogInit, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IInitBigDataOption, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IOSInfo, IOperateStatusNotify, IPluginGenerator, IProcessInfo, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRealTimeLog, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, RTCKeyMaps as InnerRTCKeyMaps, ItypingStateListener, KVString, LOG_REPORT_URI, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, _default as engineLogger, forEach, formatConnectResponseCode, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, reportLog, todo, usingCppEngine, validate, version };
+export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, BasicLogger, BasicReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, Codec, CodecPBMaps, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EnableLogL, ErrorCode, EventEmitter, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBigdataLogInit, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IInitBigDataOption, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogExtensions, ILogInfo, ILogInit, ILogger, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IOSInfo, IOperateStatusNotify, IPluginGenerator, IProcessInfo, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRealTimeLog, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, RTCKeyMaps as InnerRTCKeyMaps, ItypingStateListener, KVString, LOG_REPORT_URI, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, StoreKeys, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, deInitLogDB, logger as engineLogger, forEach, formatConnectResponseCode, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, initLogDB, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };