node-nim 7.8.3 → 9.1.0-rc.3

package/README.md

@@ -1,36 +1,83 @@
 # NetEase IM Node.js addon wrapper
+[![codecov](https://codecov.io/gh/netease-im/node-nim/branch/master/graph/badge.svg?token=YUP8T7ZG6U)](https://codecov.io/gh/netease-im/node-nim) [![GitHub all releases](https://img.shields.io/github/downloads/netease-im/node-nim/total)](https://github.com/netease-im/node-nim/releases)
 
-## Build environment
+## Table of Contents
+  - [Introduction](#introduction)
+  - [Installation](#installation)
+  - [Build From Source](#build-from-source)
+  - [Unit Test](#unit-test)
+  - [Sample Code](#sample-code)
+  - [Quick Start](#quick-start)
 
- - CMake 3.10 or higher
- - Visual Studio 2017 or MSBuild 2017
+## Introduction
+node-nim is a wrapper of [NetEase IM](https://netease.im/).  
+node-nim will download the nim SDK which has the same version, you can override the version by add `NIM_SDK_VERSION="${version}"` or `NIM_SDK_URL="${url}"` to environment variables.  
+For more detailed documentation, changelog and tech support. See https://dev.yunxin.163.com/. 
 
-## Command line
-
-|Options|Descroption|
-|---|---|
-|fetch-wrapper|Download NIM C++ SDK source files and C binary files|
-|build-wrapper|Build NIM C++ SDK|
-|package|Package the compiled artifacts|
-|build|Build with specified parameters (build-wrapper+package)|
+## Installation
+node-nim runs on Node.js and is available as a NPM package.
+```
+npm install node-nim --save-dev
+```
 
-Examples:
+## Build From Source
+Technically, nim sdk is shipped with a prebuilt node-nim.node binary file, so you don't need to build it yourself.  
+But if you want to add some personal features or you just want to do so, feel free to build it!  
+Build Requirements:
+  - Node.js
+  - npm
+  - CMake
+  - CMake supported generator(Unix Makefiles, Ninja, Visual Studio, Xcode...)  
 
-Fetch C++ wrapper source files and build C++ addon for node.js.
+Now you are all set to build, run following command in the root directory of the project:
+```cmake
+cmake -S . -B build
+cmake --build build --config Release
+```
+And voilà, you now have your own node-nim binary file in the `build` directory.
 
-```bash
-npx just fetch-wrapper --target_platform=win32 --target_arch=ia32
-npx just build --runtime=electron --target=13.1.2 --target_platform=win32 --target_arch=ia32
+## Unit Test
+Execute following script to run unit test, [check this](./test/test_all.js), and you can also get an coverage report under 'coverage'.
+```
+npm run coverage
 ```
 
-Just build NIM C++ wrapper, needs `npx just fetch-wrapper` before.
+## Sample Code
+```js
+const NIM = require('node-nim')
+const assert = require('assert')
+const client = new NIM.NIMClient()
+const talk = new NIM.NIMTalk()
+const result = client.init('app_key', 'app_data_dir', 'app_install_dir', {
+    db_encrypt_key: 'abcdefghijklmnopqrstuvwxyz012345'
+})
 
-```bash
-npx just build-wrapper --target_platform=win32 --target_arch=ia32
-```
+client.login('app_key', 'username', 'password_in_md5', (result) => {
+    assert.strictEqual(result.err_code, 200)
+    if (loginResult.login_step === 3) { // login has 3 steps, step 3 succeeded
+        talk.initEventHandlers() // init callbacks
+
+        talk.on('receiveMsg', function (result) {
+            console.log(result)
+        })
 
-Packing a compiled artifact as `.tar.gz` in `packages` folder.
+        talk.sendMsg({
+            to_type: 0, // p2p
+            to_accid: 'receiver_accid',
+            time: new Date().getTime(),
+            msg_type: 0, // text message
+            msg_body: 'Send from NIM node quick start.',
+            client_msg_id: new Date().getTime().toString(), // use an uuid
+        }, '', function () { })
 
-```bash
-npx just package --runtime=electron --target=13.1.2 --target_platform=win32 --target_arch=ia32
+        client.logout(1, (err_code) => {
+            assert.strictEqual(err_code, 200)
+        }, '')
+
+        client.cleanUp('')
+    }
+}, '')
 ```
+
+## Quick Start
+Check out this [quick start project](https://github.com/netease-im/node-nim-quick-start) and try out NIM's outstanding features!

package/download-sdk.mjs

@@ -0,0 +1,59 @@
+import fetch from 'node-fetch';
+import compareVersions from 'compare-versions';
+import download from 'download';
+
+const arch = process.arch;
+const platform = process.platform;
+const sdk_group = "message";
+const sdk_name = "nim";
+const sdk_path = "sdk";
+let sdk_url = process.env.NIM_SDK_URL;
+let sdk_version = process.env.npm_package_version.split('-')[0];
+if (process.env.NIM_SDK_VERSION) {
+    sdk_version = process.env.NIM_SDK_VERSION;
+}
+// fetch publish list
+fetch('http://publish.netease.im/api/list').then((res) => res.json()).then((publish_json) => {
+    // get sdk list
+    if (!sdk_url) {
+        let sdk_list = [];
+        let latest_version = "0.0.0";
+        let latest_sdk_list = [];
+        Object.keys(publish_json[sdk_group]).forEach((temp) => {
+            if (compareVersions.compare(latest_version, temp, '<')) {
+                latest_version = temp;
+                latest_sdk_list = publish_json[sdk_group][temp];
+            }
+            if (sdk_version === temp) {
+                sdk_list = publish_json[sdk_group][temp];
+            }
+        });
+        if (sdk_list.length === 0) {
+            console.log(`${sdk_name} sdk version ${sdk_version} not found, use latest version ${latest_version}`);
+            sdk_list = latest_sdk_list;
+        }
+        console.log(`[node_pre_build] downloadSDK sdk_name:${sdk_name}, platform:${platform}, arch:${arch}`)
+        // use platform and arch to find the sdk
+        sdk_list.forEach((member) => {
+            if (member.filename.includes(sdk_name) && member.filename.includes(platform) && member.filename.includes(arch)) {
+                sdk_url = member.cdnlink;
+            }
+        });
+    }
+    if (!sdk_url) {
+        console.error(`[node_pre_build] downloadSDK sdk_name:${sdk_name}, platform:${platform}, arch:${arch} not found`);
+        return;
+    }
+    console.info(`[node_pre_build] Downloading prebuilt sdk from ${sdk_url} to ${sdk_path}`);
+    // download sdk
+    download(sdk_url, sdk_path, {
+        extract: true,
+        filter: (file) => {
+            return !file.path.includes('._');
+        },
+    }).then(() => {
+        console.info(`[node_pre_build] Downloading prebuilt sdk complete`);
+    }).catch((err) => {
+        console.error(`[node_pre_build] downloadSDK error:${err}`)
+    });
+});

package/js/api/client.js

@@ -3,78 +3,145 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const nim_1 = __importDefault(require("./nim"));
+exports.NIMClient = void 0;
+const loader_1 = __importDefault(require("../loader"));
 const events_1 = __importDefault(require("events"));
 class NIMClient extends events_1.default.EventEmitter {
     constructor() {
         super();
-        this.client = new nim_1.default.Client();
-    }
+        this.client = new loader_1.default.NIMClient({ "emit": this.emit.bind(this) });
+    }
+    /** NIM SDK初始化
+      * @param appKey 应用注册的APP KEY
+      * @param appDataDir 推荐用户目录放置在系统目录{AppData\Local}，默认只需要传入目录名，SDK会默认在系统目录下创建该级用户目录。如果要使用其他自定义路径，需传入绝对路径路径，并确保该目录有正确的读写权限。
+      * @param appInstallDir SDK动态库所在的目录全路径（如果传入为空，则按照默认规则搜索该动态库）
+      * @param config 初始化参数
+      * @return bool 返回值true: 成功， false: 失败
+      */
     init(appKey, appDataDir, appInstallDir, config) {
         return this.client.Init(appKey, appDataDir, appInstallDir, config);
     }
+    /** 注册全局回调 */
+    initEventHandlers() {
+        return this.client.InitEventHandlers();
+    }
+    /** NIM客户端登录
+       * @param appKey
+       * @param account 帐号
+       * @param password 密码
+       * @param cb 登录流程的回调函数
+       * @param jsonExtension json扩展参数（v5.7.0 项目增加自定义参数字段）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 302:账号或密码错误
+       * 403:禁止操作
+       * 408:请求超时
+       * 414:参数错误
+       * 415:网络连接出现错误
+       * 416:频率超限
+       * 422:账号被禁用
+       * </pre>
+       */
     login(appKey, account, password, cb, jsonExtension) {
         return this.client.Login(appKey, account, password, cb, jsonExtension);
     }
+    /** NIM客户端注销/退出
+       * @param logoutType Logout操作类型，其定义见nim_client_def.h
+       * @param cb 注销/退出的回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * 500:未知错误
+       * </pre>
+       */
     logout(logoutType, cb, jsonExtension) {
         return this.client.Logout(logoutType, cb, jsonExtension);
     }
-    cleanUp(jsonExtension) {
-        return this.client.CleanUp(jsonExtension);
+    /** NIM SDK清理
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       */
+    cleanup(jsonExtension) {
+        return this.client.Cleanup(jsonExtension);
     }
+    /** 获取SDK配置
+       * @return SDKConfig 返回值SDKConfig的引用 const类型，不可试图修改
+       */
     getSDKConfig() {
         return this.client.GetSDKConfig();
     }
-    cleanUp2(jsonExtension) {
-        return this.client.CleanUp2(jsonExtension);
-    }
-    loginCustomDataToJson(customData) {
-        return this.client.LoginCustomDataToJson(customData);
-    }
+    /** 获取客户端登录状态
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return NIMLoginState 登录状态
+       */
     getLoginState(jsonExtension) {
         return this.client.GetLoginState(jsonExtension);
     }
+    /** NIM客户端手动重连（注意 APP需要统一处理自动重连/手动重连的回调，因为如果处于某次自动重连的过程中调用手动重连接口，不起作用！）
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       */
     relogin(jsonExtension) {
         return this.client.Relogin(jsonExtension);
     }
+    /** 将本帐号的其他端踢下线
+       * @param clients 设备标识
+       * @return bool 检查参数如果不符合要求则返回失败, 接口调用成功后的结果通过注册RegKickOtherClientCb回调得到
+       */
     kickOtherClient(clients) {
         return this.client.KickOtherClient(clients);
     }
-    regReloginCb(cb, jsonExtension) {
-        return this.client.RegReloginCb(cb, jsonExtension);
-    }
-    regKickoutCb(cb, jsonExtension) {
-        return this.client.RegKickoutCb(cb, jsonExtension);
-    }
-    regDisconnectCb(cb, jsonExtension) {
-        return this.client.RegDisconnectCb(cb, jsonExtension);
-    }
-    regMultispotLoginCb(cb, jsonExtension) {
-        return this.client.RegMultispotLoginCb(cb, jsonExtension);
-    }
-    regKickOtherClientCb(cb, jsonExtension) {
-        return this.client.RegKickOtherClientCb(cb, jsonExtension);
-    }
-    regSyncMultiportPushConfigCb(cb, jsonExtension) {
-        return this.client.RegSyncMultiportPushConfigCb(cb, jsonExtension);
-    }
-    setMultiportPushConfigAsync(switchOn, cb, jsonExtension) {
-        return this.client.SetMultiportPushConfigAsync(switchOn, cb, jsonExtension);
-    }
+    /** (全局回调)设置多端推送
+       * @param switch_on 开关
+       * @param cb 回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setMultiportPushConfigAsync(switch_on, cb, jsonExtension) {
+        return this.client.SetMultiportPushConfigAsync(switch_on, cb, jsonExtension);
+    }
+    /** 获得多端推送设置
+       * @param cb 回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void
+       */
     getMultiportPushConfigAsync(cb, jsonExtension) {
         return this.client.GetMultiportPushConfigAsync(cb, jsonExtension);
     }
+    /** 获取SDK版本号
+       * @return string 版本号
+       */
     getSDKVersion() {
         return this.client.GetSDKVersion();
     }
+    /** 获取当前服务器时间
+       * @param cb 操作结果的回调函数
+       * @param calc_local 是否在本地计算，false:直接到服务端查询 ,true:根据上次查询到的服务端时间与本地系统启动时间来计算，不会到服务端查询
+       * @return void
+       * @note
+       * <pre>
+       * 由于网络上/下行的原因，返回的时间会存在一定误差，
+       * 当 calc_local == false 时,如果跟上次调用该方法的时间间隔小于1000ms，SDK会采用 calc_local == true
+       * 时的方案以减少服务端的压力，并会在回调中指明返回的时间是由本地计算的。 如果返回 code != 200,同样会返回一个本地计算结果
+       * </pre>
+       */
     getServerCurrentTime(cb, calcLocal) {
         return this.client.GetServerCurrentTime(cb, calcLocal);
     }
-    unregClientCb() {
-        return this.client.UnregClientCb();
-    }
+    /** 获取当前登录的用户账号(accid)
+       * @return string 当前登录的用户账号(accid)
+       * @note 没有登录时将返回空字符串	*/
     getCurrentUserAccount() {
         return this.client.GetCurrentUserAccount();
     }
 }
-exports.default = NIMClient;
+exports.NIMClient = NIMClient;
+//# sourceMappingURL=client.js.map

package/js/api/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../ts/api/client.ts"],"names":[],"mappings":";;;;;;AAIA,uDAA4B;AAC5B,oDAAwB;AAuBxB,MAAa,SAAU,SAAQ,gBAAE,CAAC,YAAY;IAE1C;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAG,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;QAMI;IACJ,IAAI,CAAC,MAAc,EACf,UAAkB,EAClB,aAAqB,EACrB,MAAiB;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,aAAa;IACb,iBAAiB;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;SAkBK;IACL,KAAK,CAAC,MAAc,EAChB,OAAe,EACf,QAAgB,EAChB,EAAiB,EACjB,aAAqB;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;SAUK;IACL,MAAM,CAAC,UAAyB,EAC5B,EAAkB,EAClB,aAAqB;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC7D,CAAC;IAED;;;SAGK;IACL,OAAO,CAAC,aAAqB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC;IAED;;SAEK;IACL,YAAY;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;IACtC,CAAC;IAED;;;SAGK;IACL,aAAa,CAAC,aAAqB;QAC/B,OAAsB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACnE,CAAC;IAED;;;SAGK;IACL,OAAO,CAAC,aAAqB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC;IAED;;;SAGK;IACL,eAAe,CAAC,OAAsB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;SASK;IACL,2BAA2B,CAAC,SAAkB,EAC1C,EAA+B,EAC/B,aAAqB;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,SAAS,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACjF,CAAC;IAED;;;;SAIK;IACL,2BAA2B,CAAC,EAA+B,EAAE,aAAqB;QAC9E,OAAO,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IAED;;SAEK;IACL,aAAa;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;;;;SAUK;IACL,oBAAoB,CAAC,EAAgC,EAAE,SAAkB;QACrE,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED;;8BAE0B;IAC1B,qBAAqB;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC;IAC/C,CAAC;CACJ;AAlKD,8BAkKC"}

package/js/api/data_sync.js

@@ -3,18 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const nim_1 = __importDefault(require("./nim"));
+exports.NIMDataSync = void 0;
+const loader_1 = __importDefault(require("../loader"));
 const events_1 = __importDefault(require("events"));
 class NIMDataSync extends events_1.default.EventEmitter {
     constructor() {
         super();
-        this.dataSync = new nim_1.default.DataSync();
+        this.dataSync = new loader_1.default.NIMDataSync({ "emit": this.emit.bind(this) });
     }
-    regCompleteCb(cb) {
-        return this.dataSync.RegCompleteCb(cb);
-    }
-    unregDataSyncCb() {
-        return this.dataSync.UnregDataSyncCb();
+    /** 注册全局回调 */
+    initEventHandlers() {
+        return this.dataSync.InitEventHandlers();
     }
 }
-exports.default = NIMDataSync;
+exports.NIMDataSync = NIMDataSync;
+//# sourceMappingURL=data_sync.js.map

package/js/api/data_sync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data_sync.js","sourceRoot":"","sources":["../../ts/api/data_sync.ts"],"names":[],"mappings":";;;;;;AAAA,uDAA4B;AAC5B,oDAAwB;AASxB,MAAa,WAAY,SAAQ,gBAAE,CAAC,YAAY;IAE5C;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,aAAa;IACb,iBAAiB;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IAC7C,CAAC;CACJ;AAXD,kCAWC"}

package/js/api/friend.js

@@ -3,36 +3,99 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const nim_1 = __importDefault(require("./nim"));
+exports.NIMFriend = void 0;
+const loader_1 = __importDefault(require("../loader"));
 const events_1 = __importDefault(require("events"));
 class NIMFriend extends events_1.default.EventEmitter {
     constructor() {
         super();
-        this.friend = new nim_1.default.Friend();
+        this.friend = new loader_1.default.NIMFriend({ "emit": this.emit.bind(this) });
     }
-    regChangeCb(cb, jsonExtension) {
-        return this.friend.RegChangeCb(cb, jsonExtension);
+    /** 注册全局回调 */
+    initEventHandlers() {
+        return this.friend.InitEventHandlers();
     }
-    request(accid, verifyType, msg, cb, jsonExtension) {
-        return this.friend.Request(accid, verifyType, msg, cb, jsonExtension);
+    /** 添加、验证好友
+       * @param accid	对方帐号
+       * @param verify_type 好友验证类型
+       * @param msg 接口扩展字段
+       * @param cb	好友请求回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 404:用户不存在
+       * 500:未知错误
+       * </pre>
+       */
+    request(accid, verify_type, msg, cb, jsonExtension) {
+        return this.friend.Request(accid, verify_type, msg, cb, jsonExtension);
     }
-    deleteEx(accid, option, cb) {
-        return this.friend.DeleteEx(accid, option, cb);
+    /** 删除好友
+       * @param accid	对方帐号
+       * @param option 删除好友选项，目前仅有是否删除备注信息选项
+       * @param cb	删除好友回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 404:用户不存在
+       * 500:未知错误
+       * </pre>
+       */
+    delete(accid, option, cb) {
+        return this.friend.Delete(accid, option, cb);
     }
+    /** 更新好友资料
+       * @param profile 好友资料
+       * @param cb	更新好友资料回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 404:用户不存在
+       * 500:未知错误
+       * </pre>
+       */
     update(profile, cb, jsonExtension) {
         return this.friend.Update(profile, cb, jsonExtension);
     }
+    /** 增量获取好友列表
+       * @param cb	获取好友列表回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
     getList(cb, jsonExtension) {
         return this.friend.GetList(cb, jsonExtension);
     }
+    /** 获取好友信息
+       * @param accid	对方帐号
+       * @param cb	获取好友信息回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       */
     getFriendProfile(accid, cb, jsonExtension) {
         return this.friend.GetFriendProfile(accid, cb, jsonExtension);
     }
+    /** 增量获取好友列表
+       * @param keyword 要查询的关键字
+       * @param cb	获取好友列表回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 返回 true 表示发送查询请求成功，返回 false 表示关键字为空
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
     queryFriendListByKeyword(keyword, cb, jsonExtension) {
         return this.friend.QueryFriendListByKeyword(keyword, cb, jsonExtension);
     }
-    unregFriendCb() {
-        return this.friend.UnregFriendCb();
-    }
 }
-exports.default = NIMFriend;
+exports.NIMFriend = NIMFriend;
+//# sourceMappingURL=friend.js.map

package/js/api/friend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"friend.js","sourceRoot":"","sources":["../../ts/api/friend.ts"],"names":[],"mappings":";;;;;;AAAA,uDAA4B;AAC5B,oDAAwB;AAYxB,MAAa,SAAU,SAAQ,gBAAE,CAAC,YAAY;IAE1C;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAG,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,aAAa;IACb,iBAAiB;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;SAaK;IACL,OAAO,CAAC,KAAa,EAAE,WAA0B,EAAE,GAAW,EAAE,EAAqB,EAAE,aAAqB;QACxG,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;SAWK;IACL,MAAM,CAAC,KAAa,EAAE,MAA0B,EAAE,EAAqB;QACnE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;SAWK;IACL,MAAM,CAAC,OAAsB,EAAE,EAAqB,EAAE,aAAqB;QACvE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;SAQK;IACL,OAAO,CAAC,EAA0B,EAAE,aAAqB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAClD,CAAC;IAED;;;;;SAKK;IACL,gBAAgB,CAAC,KAAa,EAAE,EAA4B,EAAE,aAAqB;QAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;SASK;IACL,wBAAwB,CAAC,OAAe,EAAE,EAA0B,EAAE,aAAqB;QACvF,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC5E,CAAC;CACJ;AAlGD,8BAkGC"}

package/js/api/global.js

@@ -3,36 +3,88 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const nim_1 = __importDefault(require("./nim"));
+exports.NIMGlobal = void 0;
+const loader_1 = __importDefault(require("../loader"));
 const events_1 = __importDefault(require("events"));
 class NIMGlobal extends events_1.default.EventEmitter {
     constructor() {
         super();
-        this.global = new nim_1.default.Global();
+        this.global = new loader_1.default.NIMGlobal({ "emit": this.emit.bind(this) });
     }
-    setExceptionReportCallback(cb, jsonExtension) {
-        return this.global.SetExceptionReportCallback(cb, jsonExtension);
+    /** 注册全局回调 */
+    initEventHandlers() {
+        return this.global.InitEventHandlers();
     }
+    /** 注册输出系统环境异常的回调
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    setExceptionReportCallback(jsonExtension, cb) {
+        return this.global.SetExceptionReportCallback(jsonExtension, cb);
+    }
+    /** 设置SDK统一的网络代理。不需要代理时，type设置为kNIMProxyNone，其余参数都传空字符串（端口设为0）。有些代理不需要用户名和密码，相应参数也传空字符串。
+       * @param type 代理类型，见NIMProxyType定义
+       * @param host 代理地址
+       * @param port 代理端口
+       * @param user 代理用户名
+       * @param password 代理密码
+       * @return void 无返回值
+       */
     setProxy(type, host, port, user, password) {
         return this.global.SetProxy(type, host, port, user, password);
     }
+    /** 测试代理
+       * @param type 代理类型，见NIMProxyType定义
+       * @param host 代理地址
+       * @param port 代理端口
+       * @param user 代理用户名
+       * @param password 代理密码
+       * @param cb 回调函数
+       * @return void 无返回值
+       */
     detectProxy(type, host, port, user, password, cb) {
         return this.global.DetectProxy(type, host, port, user, password, cb);
     }
-    getSDKCachedFileInfoAsync(loginId, fileType, endTimestamp, cb, jsonExtension) {
-        return this.global.GetSDKCachedFileInfoAsync(loginId, fileType, endTimestamp, cb, jsonExtension);
-    }
-    deleteSDKCachedFileAsync(loginId, fileType, endTimestamp, cb, jsonExtension) {
-        return this.global.DeleteSDKCachedFileAsync(loginId, fileType, endTimestamp, cb, jsonExtension);
+    /** 获取sdk缓存文件信息
+       * @param loginId 查询的账号ID
+       * @param fileType 文件类型，常量定义见NIMCachedFileType
+       * @param endTimestamp  查询时间截止点（查询全部填0）
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    getSDKCachedFileInfoAsync(loginId, fileType, endTimestamp, jsonExtension, cb) {
+        return this.global.GetSDKCachedFileInfoAsync(loginId, fileType, endTimestamp, jsonExtension, cb);
     }
-    sdkFeedbackAsync(url, cb, jsonExtension) {
-        return this.global.SDKFeedbackAsync(url, cb, jsonExtension);
+    /** 删除sdk缓存文件
+       * @param loginId 查询的账号ID
+       * @param fileType 文件类型，常量定义见NIMCachedFileType
+       * @param endTimestamp  删除时间截止点（查询全部填0）
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    deleteSDKCachedFileAsync(loginId, fileType, endTimestamp, jsonExtension, cb) {
+        return this.global.DeleteSDKCachedFileAsync(loginId, fileType, endTimestamp, jsonExtension, cb);
     }
-    regSDKDBError(cb) {
-        return this.global.RegSDKDBError(cb);
+    /** SDK 反馈
+       * @param url 开发者需将所需要反馈的文件（dump，应用日志等）上传至nos。
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb
+       * @return void 无返回值
+       */
+    sdkFeedbackAsync(url, jsonExtension, cb) {
+        return this.global.SDKFeedbackAsync(url, jsonExtension, cb);
     }
+    /** 上传SDK日志到服务器
+       * @param feedbackStr 反馈信息
+       * @param cb 操作结果的回调函数
+       * @return void
+       */
     uploadSDKLog(feedbackStr, cb) {
         return this.global.UploadSDKLog(feedbackStr, cb);
     }
 }
-exports.default = NIMGlobal;
+exports.NIMGlobal = NIMGlobal;
+//# sourceMappingURL=global.js.map

package/js/api/global.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.js","sourceRoot":"","sources":["../../ts/api/global.ts"],"names":[],"mappings":";;;;;;AAAA,uDAA4B;AAC5B,oDAAwB;AASxB,MAAa,SAAU,SAAQ,gBAAE,CAAC,YAAY;IAE1C;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAG,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,aAAa;IACb,iBAAiB;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAC3C,CAAC;IAED;;;;SAIK;IACL,0BAA0B,CAAC,aAAqB,EAAE,EAAqB;QACnE,OAAO,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;SAOK;IACL,QAAQ,CAAC,IAAkB,EAAE,IAAY,EAAE,IAAY,EAAE,IAAY,EAAE,QAAgB;QACnF,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;SAQK;IACL,WAAW,CAAC,IAAkB,EAAE,IAAY,EAAE,IAAY,EAAE,IAAY,EAAE,QAAgB,EAAE,EAAuB;QAC/G,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;SAOK;IACL,yBAAyB,CAAC,OAAe,EAAE,QAA2B,EAAE,YAAoB,EACxF,aAAqB,EAAE,EAA6B;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;SAOK;IACL,wBAAwB,CAAC,OAAe,EAAE,QAA2B,EAAE,YAAoB,EACvF,aAAqB,EAAE,EAA4B;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;SAKK;IACL,gBAAgB,CAAC,GAAW,EAAE,aAAqB,EAAE,EAAuB;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;SAIK;IACL,YAAY,CAAC,WAAmB,EAAE,EAAwB;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACrD,CAAC;CACJ;AA1FD,8BA0FC"}