@rongcloud/engine 5.5.2 → 5.5.3

package/index.d.ts

@@ -992,7 +992,7 @@ declare enum ConnectionStatus {
      */
     APPKEY_IS_FAKE = 20,
     /**
-    * 其他端登录，本端禁止连接和重连
+    * Electron 中，其他端登录，本端禁止连接和重连
     */
     FORBID_RECONNECT_BY_OTHER_SAME_CLIENT = 31023,
     /**
@@ -1356,6 +1356,8 @@ declare enum LogTagId {
     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",
     A_SEND_MSG_T = "A-send_msg-T",
     A_SEND_MSG_R = "A-send_msg-R",
     P_SEND_MSG_T = "P-send_msg-T",
@@ -1413,7 +1415,10 @@ declare enum LogTagId {
      */
     L_PB_ENCODE_E = "L-pb-encode-E",
     L_PB_DECODE_E = "L-pb-decode-E",
-    L_NOTIFY_NAVI_CHANGE_E = "L-notify_navi_change-E"
+    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"
 }
 
 /**
@@ -3188,6 +3193,96 @@ interface IExtraMethod {
     updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
 }
 
+/**
+ * 当前运行时设备信息
+ */
+interface IOSInfo {
+    /** 软件运行时的 CPU 架构信息 */
+    arch: string;
+    /** 平台标识 */
+    platform: string;
+    /** 操作系统名称 */
+    type: string;
+    /** 操作系统 release 标识 */
+    release: string;
+    /** 操作系统版本信息 */
+    version: string;
+    /** 内存余量 */
+    freemem: number;
+    /** 系统内存总量 */
+    totalmem: number;
+    /** 本次操作系统运行时长 */
+    uptime: number;
+    cpus: {
+        /** CPU 型号标识 */
+        model: string;
+        /** 主频 MHz */
+        speed: number;
+        times: {
+            user: number;
+            nice: number;
+            sys: number;
+            idle: number;
+            irq: number;
+        };
+    }[];
+    networkInterfaces: {
+        /** 网卡接口标识 */
+        [link: string]: {
+            /** IP */
+            address: string;
+            /** 子网掩码 */
+            netmask: string;
+            /** IP 协议版本 */
+            family: string;
+            /** Mac Address */
+            mac: string;
+            /** 是否回环地址 */
+            internal: boolean;
+            /** CIDR */
+            cidr: string | null;
+        }[] | undefined;
+    };
+}
+
+interface IProcessInfo {
+    title: string;
+    platform: string;
+    arch: string;
+    pid: number;
+    ppid: number;
+    uptime: number;
+    cpuUsage: {
+        user: number;
+        system: number;
+    };
+    memoryUsage: {
+        rss: number;
+        heapTotal: number;
+        heapUsed: number;
+        external: number;
+        arrayBuffers: number;
+    };
+    resourceUsage: {
+        userCPUTime: number;
+        systemCPUTime: number;
+        maxRSS: number;
+        sharedMemorySize: number;
+        unsharedDataSize: number;
+        unsharedStackSize: number;
+        minorPageFault: number;
+        majorPageFault: number;
+        swappedOut: number;
+        fsRead: number;
+        fsWrite: number;
+        ipcSent: number;
+        ipcReceived: number;
+        signalsCount: number;
+        voluntaryContextSwitches: number;
+        involuntaryContextSwitches: number;
+    };
+}
+
 /**
  * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
  */
@@ -3691,6 +3786,14 @@ interface IEngine {
      */
     getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
     clearData(): Promise<IAsyncRes<boolean>>;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    getMainProcessInfo(): IPromiseResult<IProcessInfo>;
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
     rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
         code: ErrorCode;
@@ -5131,6 +5234,18 @@ declare class APIContext {
      * @param args
      */
     callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取当前渲染进程信息，仅限 Electron 平台可用
+     */
+    getProcessInfo(): IPromiseResult<IProcessInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    getMainProcessInfo(): IPromiseResult<IProcessInfo>;
     /**
      * 删除所有会话
     */
@@ -5407,13 +5522,21 @@ declare class PluginContext {
      * 获取服务时间
      */
     getServerTime(): number;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取当前渲染进程信息，仅限 Electron 平台可用
+     */
+    getProcessInfo(): IPromiseResult<IProcessInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    getMainProcessInfo(): IPromiseResult<IProcessInfo>;
 }
 
 declare class RTCPluginContext extends PluginContext {
-    /**
-     * 获取当前的导航数据
-     */
-    getNaviInfo(): INaviInfo | null;
     /**
      * 加入 RTC 房间
      * @deprecated
@@ -6329,6 +6452,18 @@ declare abstract class AEngine implements IEngine {
      * 超级群获取指定会话第一条未读消息时间戳
     */
     abstract getUltraGroupFirstUnreadMessageTimestamp(options: IUltraGroupOption): Promise<IAsyncRes<IUltraUnreadMsg>>;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    abstract getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取当前渲染进程信息，仅限 Electron 平台可用
+     */
+    abstract getProcessInfo(): IPromiseResult<IProcessInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    abstract getMainProcessInfo(): IPromiseResult<IProcessInfo>;
     /**
      * RTC 通用调用接口
      * 在非 Comet 协议下，入参 sourceData 应为 ArrayBuffer 数据，返回结果为 Uint8Array 数据
@@ -6949,4 +7084,4 @@ declare const ONE_LOG_SIZE_MAX = 1000;
  */
 declare const version: string;
 
-export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, IM_CHATROOM_PULL_INTERVAL_TIME, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IOperateStatusNotify, IPluginGenerator, 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, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCKeyMaps, 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, randomNum, todo, usingCppEngine, validate, version };
+export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, IM_CHATROOM_PULL_INTERVAL_TIME, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, 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, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCKeyMaps, 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, randomNum, todo, usingCppEngine, validate, version };