node-nim 9.2.8-rc.1 → 9.3.0-rc.2

package/types/{api → nim}/client.d.ts

@@ -1,26 +1,25 @@
-/// <reference types="node" />
-import { NIMClientAPI, GetCurrentServerTimeCallback, LoginCallback, LogoutCallback, MultiportPushConfigCallback, NIMLoginState, NIMLogoutType, SDKConfig, MultiSpotLoginRes, KickOtherRes, KickoutRes, LoginRes } from '../def/client_def';
-import { EventEmitter } from 'events';
-export declare interface NIMClient {
-    on(event: 'disconnect', listener: () => void): this;
-    on(event: 'multispotLogin', listener: (result: MultiSpotLoginRes) => void): this;
-    on(event: 'syncMultiportPushConfig', listener: (rescode: number, open: boolean) => void): this;
-    on(event: 'kickout', listener: (result: KickoutRes) => void): this;
-    on(event: 'kickOtherClient', listener: (result: KickOtherRes) => void): this;
-    on(event: 'relogin', listener: (result: LoginRes) => void): this;
-    once(event: 'disconnect', listener: () => void): this;
-    once(event: 'multispotLogin', listener: (result: MultiSpotLoginRes) => void): this;
-    once(event: 'syncMultiportPushConfig', listener: (rescode: number, open: boolean) => void): this;
-    once(event: 'kickout', listener: (result: KickoutRes) => void): this;
-    once(event: 'kickOtherClient', listener: (result: KickOtherRes) => void): this;
-    once(event: 'relogin', listener: (result: LoginRes) => void): this;
+import { NIMClientAPI, GetCurrentServerTimeCallback, LoginCallback, LogoutCallback, MultiportPushConfigCallback, NIMLoginState, NIMLogoutType, SDKConfig, MultiSpotLoginRes, KickOtherRes, KickoutRes, LoginRes, NIMResCode } from '../nim_def/client_def';
+import { EventEmitter } from 'eventemitter3';
+export declare interface NIMClientEvents {
+    /** NIM客户端掉线 */
+    disconnect: [];
+    /** NIM客户端多点登录通知 */
+    multispotLogin: [MultiSpotLoginRes];
+    /** 多端推送开关同步 */
+    syncMultiportPushConfig: [number, boolean];
+    /** NIM客户端被踢 */
+    kickOtherClient: [KickOtherRes];
+    /** NIM客户端将本帐号的其他端踢下线结果 */
+    kickout: [KickoutRes];
+    /** NIM客户端自动重连 */
+    relogin: [LoginRes];
 }
-export declare class NIMClient extends EventEmitter {
+export declare class NIMClient extends EventEmitter<NIMClientEvents> {
     client: NIMClientAPI;
     constructor();
     /** NIM SDK初始化
      * @param appKey 应用注册的APP KEY
-     * @param appDataDir 推荐用户目录放置在系统目录{AppData\Local}，默认只需要传入目录名，SDK会默认在系统目录下创建该级用户目录。如果要使用其他自定义路径，需传入绝对路径路径，并确保该目录有正确的读写权限。
+     * @param appDataDir 推荐用户目录放置在系统目录AppData\Local，默认只需要传入目录名，SDK会默认在系统目录下创建该级用户目录。如果要使用其他自定义路径，需传入绝对路径路径，并确保该目录有正确的读写权限。
      * @param appInstallDir SDK动态库所在的目录全路径（如果传入为空，则按照默认规则搜索该动态库）
      * @param config 初始化参数
      * @return bool 返回值true: 成功， false: 失败
@@ -47,7 +46,7 @@ export declare class NIMClient extends EventEmitter {
      * 422:账号被禁用
      * </pre>
      */
-    login(appKey: string, account: string, password: string, cb: LoginCallback, jsonExtension: string): boolean;
+    login(appKey: string, account: string, password: string, cb: LoginCallback, jsonExtension: string): Promise<[LoginRes]>;
     /** NIM客户端注销/退出
      * @param logoutType Logout操作类型，其定义见nim_client_def.h
      * @param cb 注销/退出的回调函数
@@ -59,7 +58,7 @@ export declare class NIMClient extends EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    logout(logoutType: NIMLogoutType, cb: LogoutCallback, jsonExtension: string): void;
+    logout(logoutType: NIMLogoutType, cb: LogoutCallback, jsonExtension: string): Promise<[NIMResCode]>;
     /** NIM SDK清理
      * @param jsonExtension json扩展参数（备用，目前不需要）
      * @return void 无返回值
@@ -94,13 +93,13 @@ export declare class NIMClient extends EventEmitter {
      * 200:成功
      * </pre>
      */
-    setMultiportPushConfigAsync(switch_on: boolean, cb: MultiportPushConfigCallback, jsonExtension: string): void;
+    setMultiportPushConfigAsync(switch_on: boolean, cb: MultiportPushConfigCallback, jsonExtension: string): Promise<[NIMResCode, boolean]>;
     /** 获得多端推送设置
      * @param cb 回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
      * @return void
      */
-    getMultiportPushConfigAsync(cb: MultiportPushConfigCallback, jsonExtension: string): void;
+    getMultiportPushConfigAsync(cb: MultiportPushConfigCallback, jsonExtension: string): Promise<[NIMResCode, boolean]>;
     /** 获取SDK版本号
      * @return string 版本号
      */
@@ -116,7 +115,7 @@ export declare class NIMClient extends EventEmitter {
      * 时的方案以减少服务端的压力，并会在回调中指明返回的时间是由本地计算的。 如果返回 code != 200,同样会返回一个本地计算结果
      * </pre>
      */
-    getServerCurrentTime(cb: GetCurrentServerTimeCallback, calcLocal: boolean): void;
+    getServerCurrentTime(cb: GetCurrentServerTimeCallback, calcLocal: boolean): Promise<[number, boolean, number]>;
     /** 获取当前登录的用户账号(accid)
      * @return string 当前登录的用户账号(accid)
      * @note 没有登录时将返回空字符串	*/

package/types/nim/data_sync.d.ts

@@ -0,0 +1,12 @@
+import { EventEmitter } from 'eventemitter3';
+import { NIMDataSyncAPI, NIMDataSyncStatus, NIMDataSyncType } from '../nim_def/data_sync_def';
+export declare interface NIMDataSyncEvents {
+    /** 数据同步完成 */
+    complete: [NIMDataSyncType, NIMDataSyncStatus, string];
+}
+export declare class NIMDataSync extends EventEmitter<NIMDataSyncEvents> {
+    dataSync: NIMDataSyncAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+}

package/types/{api → nim}/friend.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="node" />
-import ev from 'events';
-import { DeleteFriendOption, FriendProfile, NIMFriendAPI, FriendOptCallback, GetFriendProfileCallback, GetFriendsListCallback, NIMVerifyType, FriendChangeEvent } from '../def/friend_def';
-export declare interface NIMFriend {
-    on(event: 'change', listener: (result: FriendChangeEvent) => void): this;
-    once(event: 'change', listener: (result: FriendChangeEvent) => void): this;
+import { EventEmitter } from 'eventemitter3';
+import { DeleteFriendOption, FriendProfile, NIMFriendAPI, FriendOptCallback, GetFriendProfileCallback, GetFriendsListCallback, NIMVerifyType, FriendChangeEvent } from '../nim_def/friend_def';
+import { NIMResCode } from 'ts/nim_def/client_def';
+export declare interface NIMFriendEvents {
+    /** 好友变更通知 */
+    change: [FriendChangeEvent];
 }
-export declare class NIMFriend extends ev.EventEmitter {
+export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
     friend: NIMFriendAPI;
     constructor();
     /** 注册全局回调 */
@@ -16,7 +16,7 @@ export declare class NIMFriend extends ev.EventEmitter {
      * @param msg 接口扩展字段
      * @param cb	好友请求回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -24,12 +24,12 @@ export declare class NIMFriend extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    request(accid: string, verify_type: NIMVerifyType, msg: string, cb: FriendOptCallback, jsonExtension: string): boolean;
+    request(accid: string, verify_type: NIMVerifyType, msg: string, cb: FriendOptCallback, jsonExtension: string): Promise<[NIMResCode] | null>;
     /** 删除好友
      * @param accid	对方帐号
      * @param option 删除好友选项，目前仅有是否删除备注信息选项
      * @param cb	删除好友回调函数
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -37,12 +37,12 @@ export declare class NIMFriend extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    delete(accid: string, option: DeleteFriendOption, cb: FriendOptCallback): boolean;
+    delete(accid: string, option: DeleteFriendOption, cb: FriendOptCallback): Promise<[NIMResCode] | null>;
     /** 更新好友资料
      * @param profile 好友资料
      * @param cb	更新好友资料回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 检查参数如果不符合要求则返回失败
+     * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
      * 200:成功
@@ -50,7 +50,7 @@ export declare class NIMFriend extends ev.EventEmitter {
      * 500:未知错误
      * </pre>
      */
-    update(profile: FriendProfile, cb: FriendOptCallback, jsonExtension: string): boolean;
+    update(profile: FriendProfile, cb: FriendOptCallback, jsonExtension: string): Promise<[NIMResCode] | null>;
     /** 增量获取好友列表
      * @param cb	获取好友列表回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
@@ -60,23 +60,23 @@ export declare class NIMFriend extends ev.EventEmitter {
      * 200:成功
      * </pre>
      */
-    getList(cb: GetFriendsListCallback, jsonExtension: string): void;
+    getList(cb: GetFriendsListCallback, jsonExtension: string): Promise<[NIMResCode, Array<FriendProfile>]>;
     /** 获取好友信息
      * @param accid	对方帐号
      * @param cb	获取好友信息回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
      * @return void 无返回值
      */
-    getFriendProfile(accid: string, cb: GetFriendProfileCallback, jsonExtension: string): void;
+    getFriendProfile(accid: string, cb: GetFriendProfileCallback, jsonExtension: string): Promise<[string, FriendProfile]>;
     /** 增量获取好友列表
      * @param keyword 要查询的关键字
      * @param cb	获取好友列表回调函数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @return bool 返回 true 表示发送查询请求成功，返回 false 表示关键字为空
+     * @return boolean 返回 true 表示发送查询请求成功，返回 false 表示关键字为空
      * @note
      * <pre>
      * 200:成功
      * </pre>
      */
-    queryFriendListByKeyword(keyword: string, cb: GetFriendsListCallback, jsonExtension: string): boolean;
+    queryFriendListByKeyword(keyword: string, cb: GetFriendsListCallback, jsonExtension: string): Promise<[NIMResCode, Array<FriendProfile>] | null>;
 }

package/types/{api → nim}/global.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="node" />
-import ev from 'events';
-import { DeleteCachedFileCallback, DetectProxyCallback, ExceptionCallback, GetCachedFileInfoCallback, NIMCachedFileType, NIMGlobalAPI, NIMProxyType, SDKDBErrorInfo, SDKFeedbackCallback, UploadSDKLogCallback } from '../def/global_def';
-export declare interface NIMGlobal {
-    on(event: 'dbError', listener: (result: SDKDBErrorInfo) => void): this;
-    once(event: 'dbError', listener: (result: SDKDBErrorInfo) => void): this;
+import { EventEmitter } from 'eventemitter3';
+import { CachedFileInfo, DeleteCachedFileCallback, DetectProxyCallback, ExceptionCallback, GetCachedFileInfoCallback, NIMCachedFileType, NIMGlobalAPI, NIMProxyDetectStep, NIMProxyType, NIMSDKException, SDKDBErrorInfo, SDKFeedbackCallback, UploadSDKLogCallback } from '../nim_def/global_def';
+import { NIMResCode } from 'ts/nim_def/client_def';
+export declare interface NIMGlobalEvents {
+    /** SDK DB操作出错 */
+    dbError: [SDKDBErrorInfo];
 }
-export declare class NIMGlobal extends ev.EventEmitter {
+export declare class NIMGlobal extends EventEmitter<NIMGlobalEvents> {
     global: NIMGlobalAPI;
     constructor();
     /** 注册全局回调 */
@@ -15,7 +15,7 @@ export declare class NIMGlobal extends ev.EventEmitter {
      * @param cb
      * @return void 无返回值
      */
-    setExceptionReportCallback(jsonExtension: string, cb: ExceptionCallback): void;
+    setExceptionReportCallback(jsonExtension: string, cb: ExceptionCallback): Promise<[NIMSDKException, string]>;
     /** 设置SDK统一的网络代理。不需要代理时，type设置为kNIMProxyNone，其余参数都传空字符串（端口设为0）。有些代理不需要用户名和密码，相应参数也传空字符串。
      * @param type 代理类型，见NIMProxyType定义
      * @param host 代理地址
@@ -34,7 +34,7 @@ export declare class NIMGlobal extends ev.EventEmitter {
      * @param cb 回调函数
      * @return void 无返回值
      */
-    detectProxy(type: NIMProxyType, host: string, port: number, user: string, password: string, cb: DetectProxyCallback): void;
+    detectProxy(type: NIMProxyType, host: string, port: number, user: string, password: string, cb: DetectProxyCallback): Promise<[boolean, NIMProxyDetectStep, string]>;
     /** 获取sdk缓存文件信息
      * @param loginId 查询的账号ID
      * @param fileType 文件类型，常量定义见NIMCachedFileType
@@ -43,7 +43,7 @@ export declare class NIMGlobal extends ev.EventEmitter {
      * @param cb
      * @return void 无返回值
      */
-    getSDKCachedFileInfoAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: GetCachedFileInfoCallback): void;
+    getSDKCachedFileInfoAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: GetCachedFileInfoCallback): Promise<[NIMResCode, CachedFileInfo]>;
     /** 删除sdk缓存文件
      * @param loginId 查询的账号ID
      * @param fileType 文件类型，常量定义见NIMCachedFileType
@@ -52,18 +52,18 @@ export declare class NIMGlobal extends ev.EventEmitter {
      * @param cb
      * @return void 无返回值
      */
-    deleteSDKCachedFileAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: DeleteCachedFileCallback): void;
+    deleteSDKCachedFileAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: DeleteCachedFileCallback): Promise<[NIMResCode]>;
     /** SDK 反馈
      * @param url 开发者需将所需要反馈的文件（dump，应用日志等）上传至nos。
      * @param jsonExtension json扩展参数（备用，目前不需要）
      * @param cb
      * @return void 无返回值
      */
-    sdkFeedbackAsync(url: string, jsonExtension: string, cb: SDKFeedbackCallback): void;
+    sdkFeedbackAsync(url: string, jsonExtension: string, cb: SDKFeedbackCallback): Promise<[NIMResCode]>;
     /** 上传SDK日志到服务器
      * @param feedbackStr 反馈信息
      * @param cb 操作结果的回调函数
      * @return void
      */
-    uploadSDKLog(feedbackStr: string, cb: UploadSDKLogCallback): void;
+    uploadSDKLog(feedbackStr: string, cb: UploadSDKLogCallback): Promise<[NIMResCode]>;
 }