node-nim 9.11.0 → 9.12.0

package/README.md

@@ -1,37 +1,106 @@
-# NetEase IM Node.js addon wrapper
+# NetEase Electron IM SDK
 
-[![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)
+[![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)  
+[中文](README_CN.md)  
+[API Document](https://github.com/netease-im/node-nim/wiki)
 
 ## Table of Contents
 
--   [NetEase IM Node.js addon wrapper](#netease-im-nodejs-addon-wrapper)
+-   [NetEase Electron IM SDK](#netease-electron-im-sdk)
     -   [Table of Contents](#table-of-contents)
     -   [Introduction](#introduction)
+    -   [Runtime Requirements](#runtime-requirements)
+    -   [System Requirements](#system-requirements)
+    -   [Supported Platforms](#supported-platforms)
     -   [Installation](#installation)
     -   [Build From Source](#build-from-source)
-    -   [Unit Test](#unit-test)
-    -   [Sample Code](#sample-code)
     -   [Quick Start](#quick-start)
+        -   [Initialize SDK](#initialize-sdk)
+        -   [Login](#login)
+        -   [Send Message](#send-message)
 
 ## Introduction
 
-node-nim is a wrapper of [NetEase IM](https://netease.im/).  
-For more detailed documentation, changelog and tech support. See https://dev.yunxin.163.com/.
+`node-nim` is a Node.js wrapper for the [NetEase IM PC SDK](https://doc.yunxin.163.com/messaging/docs/home-page?platform=pc), enabling you to utilize all of its features in your preferred frontend framework with native platform performance.  
+For comprehensive documentation, changelog, and technical support, please visit https://dev.yunxin.163.com/.
+
+## Runtime Requirements
+
+| Runtime  | Version     |
+| -------- | ----------- |
+| Electron | >= v8.5.5   |
+| Node.js  | >= v12.13.0 |
+
+## System Requirements
+
+| System  | Requirements  |
+| ------- | ------------- |
+| Windows | >= Windows 7  |
+| macOS   | >= 10.14.0    |
+| Linux   | glibc >= 2.23 |
+
+## Supported Platforms
+
+| Platform | Architecture |
+| -------- | ------------ |
+| Windows  | x64          |
+| Windows  | ia32         |
+| macOS    | x64          |
+| macOS    | arm64        |
+| Linux    | x64          |
+| Linux    | arm64        |
 
 ## Installation
 
-node-nim runs on Node.js and is available as a NPM package. You can specify architecture and platform by `--arch` and `--platform` flags.
+`node-nim` is an NPM package that can be installed using the `npm install` command.  
+It will automatically download the prebuilt binary file that fits your current platform.
+
+```bash
+npm install node-nim --save-dev
+```
+
+Maybe you need to build ia32 app on x64 platform or something like that, you can use `--arch` and `--platform` to specify the platform you want to build.
+
+-   Windows x64
+
+```bash
+npm install node-nim --save-dev --arch=x64 --platform=win32
+```
+
+-   Windows x86
+
+```bash
+npm install node-nim --save-dev --arch=ia32 --platform=win32
+```
 
-node-nim will download the nim SDK which has the same version, you can override the version by add `--nimSdkVersion` or `--nimSdkUrl` flag.
+-   macOS x64
 
+```bash
+npm install node-nim --save-dev --arch=x64 --platform=darwin
 ```
-npm install node-nim --save-dev --arch=x64 --platform=win32 --nimSdkVersion=9.1.0
+
+-   macOS arm64
+
+```bash
+npm install node-nim --save-dev --arch=arm64 --platform=darwin
+```
+
+-   Linux x64
+
+```bash
+npm install node-nim --save-dev --arch=x64 --platform=linux
+```
+
+-   Linux arm64
+
+```bash
+npm install node-nim --save-dev --arch=arm64 --platform=linux
 ```
 
 ## 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!  
+Technically, native nim sdk is shipped with a prebuilt node-nim.node binary file, so `there is no need to build it yourself.`.  
+But if you want to add personal features or simply prefer to do so, feel free to build it!  
 Build Requirements:
 
 -   Node.js
@@ -48,79 +117,53 @@ cmake --build build --config Release
 
 And voilà, you now have your own node-nim binary file in the `build` directory.
 
-## 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
-```
-
-## Sample Code
+## Quick Start
 
-```js
-// Chatroom
+```ts
 import * as node_nim from 'node-nim'
-let ret = node_nim.chatroom.init('', '')
-if (!ret) {
-    console.log('init failed')
-    process.exit(1)
-}
-node_nim.chatroom.initEventHandlers()
-ret = node_nim.chatroom.enter('room_id', 'login_data', {}, '')
-if (!ret) {
-    console.log('enter failed')
-    process.exit(1)
-}
 ```
 
-```js
-// NIM
-import * as node_nim from 'node-nim'
-const result = node_nim.nim.client.init('app_key', 'app_data_dir', 'app_install_dir', {
-    db_encrypt_key: 'abcdefghijklmnopqrstuvwxyz012345'
-})
+### Initialize SDK
 
-if (!result) {
-    console.log('init failed')
-    process.exit(1)
+```ts
+const result = node_nim.nim.client.init('appkey', '', '', {
+    database_encrypt_key_: 'abcdefghijklmnopqrstuvwxyz012345'
+})
+if (result) {
+    node_nim.nim.initEventHandlers() // init event handlers
+    node_nim.nim.talk.on('receiveMsg', (result) => {
+        console.log('receiveMsg', result)
+    })
+    node_nim.nim.talk.on('sendMsg', (message: node_nim.IMMessage) => {
+        console.log('sendMsg: ', message)
+    })
+    // add more event handlers here
+    // ...
 }
+return result
+```
 
-node_nim.nim.initEventHandlers()
+### Login
 
-let resp = await node_nim.nim.client.login(
-    'app_key',
-    'username',
-    'password',
-    null, // pass your callback function if you dont use the return Promise
-    ''
-)
-if (resp[0].res_code_ != node_nim.NIMResCode.kNIMResSuccess) {
+```ts
+let [loginResult] = await node_nim.nim.client.login('appkey', 'account', 'password', null, '')
+if (loginResult.res_code_ == node_nim.NIMResCode.kNIMResSuccess) {
+    console.log('login succeeded')
+} else {
     console.log('login failed')
-    process.exit(1)
 }
-console.log('loginResult', res)
-// login has 3 steps, step 3 succeeded
-node_nim.nim.talk.on('receiveMsg', function (result) {
-    console.log('receiveMsg', result)
-})
-node_nim.nim.talk.on('sendMsg', (msg) => {
-    console.log('sendMsg', msg)
-})
+```
+
+### Send Message
 
+```ts
 node_nim.nim.talk.sendMsg(
     {
-        session_type_: 0, // p2p
-        receiver_accid_: 'receiver_accid',
-        timetag_: new Date().getTime(),
-        type_: 0, // text message
-        content_: 'Send from NIM node quick start.',
-        client_msg_id_: new Date().getTime().toString() // use an uuid
+        session_type_: node_nim.NIMSessionType.kNIMSessionTypeP2P,
+        receiver_accid_: 'receiver',
+        type_: node_nim.NIMMessageType.kNIMMessageTypeText,
+        content_: 'Send from NIM node quick start.'
     },
     ''
 )
 ```
-
-## 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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-nim",
-    "version": "9.11.0",
+    "version": "9.12.0",
     "description": "NetEase IM nodejs wrapper based on NetEase IM C++ SDK",
     "main": "dist/node-nim.js",
     "bin": {
@@ -17,7 +17,8 @@
     "scripts": {
         "coverage": "nyc mocha test/test_all.js -slow 200 -timeout 10000",
         "build_ts": "rimraf ./dist && rimraf ./types && tsc",
-        "build_doc": "typedoc",
+        "build_wiki_doc": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --theme github-wiki --out wiki_doc",
+        "build_markdown_doc": "typedoc --plugin typedoc-plugin-markdown --theme markdown --out markdown_doc",
         "prepublishOnly": "npm run build_ts",
         "install": "npm run download_sdk",
         "download_sdk": "node -e \"require('./script/download-sdk.js').downloadSDK()\"",

package/types/chatroom/chatroom.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'eventemitter3';
 import { ChatRoomIndependentEnterInfo, ChatRoomAnoymityEnterInfo, ChatRoomEnterInfo, NIMChatRoomLoginState, ChatRoomMessage, ChatRoomGetMembersParameters, GetMembersCallback, GetMembersCountByTagCallback, ChatRoomGetMsgHistoryParameters, GetMsgHistoryCallback, ChatRoomSetMemberAttributeParameters, SetMemberAttributeCallback, GetChatRoomInfoCallback, KickMemberCallback, NIMChatRoomProxyType, TempMuteMemberCallback, ChatRoomInfo, UpdateRoomInfoCallback, ChatRoomMemberInfo, UpdateMyRoomRoleCallback, ChatRoomQueueElement, ChatRoomQueueOfferOption, QueueOfferCallback, QueuePollCallback, QueueListCallback, QueueHeaderCallback, QueueDropCallback, QueueBatchUpdateCallback, NIMChatRoomLocation, UpdateLocationCallback, ChatRoomUpdateTagsInfo, UpdateTagsCallback, ChatRoomNotification, NIMChatRoomEnterStep, NIMChatRoomExitReason, NIMChatRoomLinkCondition, ChatRoomGetMsgHistoryByTagsParameters, ChatRoomConfig, ChatRoomGetMembersByTagParameters, ChatRoomBatchMembers } from '../chatroom_def/chatroom_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface ChatRoomEvents {
     /** 登录 */
     enter: [number, NIMChatRoomEnterStep, number, ChatRoomInfo, ChatRoomMemberInfo];

package/types/chatroom_def/chatroom_def.d.ts

@@ -1,4 +1,4 @@
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare enum NIMChatRoomLoginState {
     kNIMChatRoomLoginStateLogin = 1 /**< 登录状态 */,
     kNIMChatRoomLoginStateUnLogin = 2 /**< 未登录状态 */

package/types/nim/friend.d.ts

@@ -1,6 +1,6 @@
 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';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMFriendEvents {
     /** 好友变更通知 */
     change: [FriendChangeEvent];

package/types/nim/global.d.ts

@@ -1,6 +1,6 @@
 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';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMGlobalEvents {
     /** SDK DB操作出错 */
     dbError: [SDKDBErrorInfo];

package/types/nim/msglog.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMSessionType } from '../nim_def/session_def';
 import { NIMMsgLogAPI, QuerySingleMsgCallback, QueryMsgCallback, NIMMessageType, ModifyMultipleMsglogCallback, NIMMsgLogStatus, ModifySingleMsglogCallback, NIMMsgLogSubStatus, DBFunctionCallback, ImportDbPrgCallback, MessageStatusChangedCallback, LogsBackupExportInfo, LogsBackupImportInfo, DeleteHistoryOnLineAsyncCallback, DeleteHistoryOnLineAsyncExCallback, DeleteMessageSelfAsyncCallback, QueryMessageIsThreadRootCallback, QueryMsgAsyncParam, QueryMessageOnlineCallback, QueryThreadHistoryMsgAsyncParam, QueryThreadHistoryMsgCallback, FullTextSearchOnlineAsyncParam, FullTextSearchOnlineAsyncCallback, IMMessage, QueryMsgByKeywordOnlineParam, QueryMsgOnlineAsyncParam, DeleteMsglogSelfNotifyItemInfo, DeleteMsglogSelfNotifyParam, MessageStatusChangedResult, QueryMsgByOptionsAsyncParam, QueryMsglogResult, NIMMsglogSearchDirection, GetMessagesDynamicallyCallback, GetMessagesResult } from '../nim_def/msglog_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMMsgLogEvents {
     /** 单向删除消息记录通知 */
     localMsgDeleted: [Array<DeleteMsglogSelfNotifyItemInfo>];

package/types/nim/nos.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { DownloadMediaCallback, DownloadMediaExCallback, DownloadMediaResult, InitNosConfigParam, InitNosResult, InitNosResultCallback, NIMNOSAPI, NOSParams, ProgressCallback, ProgressExCallback, SafeURLToOriginURLCallback, SpeedCallback, TransferInfoCallback, UploadMediaExCallback, UploadMediaResult } from '../nim_def/nos_def';
 import { IMMessage } from '../nim_def/msglog_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMNOSEvents {
     /** 下载回调 */
     downloadComplete: [number, string, string, string];

package/types/nim/online_session.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMSessionType } from '../nim_def/session_def';
 import { DeleteOnlineSessionInfoCallback, DeleteSessionParam, NIMOnlineSessionAPI, QueryOnlineSessionInfoCallback, QueryOnlineSessionListCallback, QuerySessionListResult, SessionInfo, UpdateOnlineSessionInfoCallback } from '../nim_def/online_session_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMOnlineSessionEvents {
     /** 会话变更 */
     change: [SessionInfo];

package/types/nim/pass_through_proxy.d.ts

@@ -1,6 +1,6 @@
 import { NIMPassThroughProxyAPI, NIMSendHttpRequestMethods, SendHttpRequestCallback } from '../nim_def/pass_through_proxy_def';
 import { EventEmitter } from 'eventemitter3';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMPassThroughProxyEvents {
     /** 接受到 HTTP 透传消息 */
     receiveHttpMsg: [string, string, number];

package/types/nim/plugin.d.ts

@@ -1,6 +1,6 @@
 import { NIMPluginAPI, ChatRoomRequestEnterCallback, QChatRequestLinkAddressCallback } from '../nim_def/plugin_def';
 import { EventEmitter } from 'eventemitter3';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMPluginEvents {
 }
 export declare class NIMPlugin extends EventEmitter<NIMPluginEvents> {

package/types/nim/session.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { IMMessage, NIMMessageType } from '../nim_def/msglog_def';
 import { CancelToStickTopSessionCallback, DeleteHasmoreRoammsgCallback, DeleteSessionRoamingMessageCallback, MultiUnreadCountZeroInfo, NIMSessionAPI, NIMSessionType, QueryAllHasmoreRoammsgCallback, QueryHasmoreRoammsgCallback, QuerySessionDataCallback, QuerySessionListCallback, QueryStickTopSessionListCallback, SessionChangeCallback, SessionData, SessionDataList, SessionRoamMsgHasMoreTagInfo, SetMultiUnreadCountZeroAsyncCallback, SetToStickTopSessionCallback, UpdateHasmoreRoammsgCallback, UpdateStickTopSessionCallback } from '../nim_def/session_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMSessionEvents {
     /** 会话变更 */
     change: [number, SessionData, number];

package/types/nim/subscribe_event.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMSubscribeEventAPI, EventData, PublishEventCallback, NIMEventType, NIMEventSubscribeSyncEventType, SubscribeEventCallback, UnSubscribeEventCallback, BatchUnSubscribeEventCallback, QuerySubscribeEventCallback, EventSubscribeData } from '../nim_def/subscribe_event_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMSubscribeEventEvents {
     /** 订阅的事件 */
     push: [number, EventData];

package/types/nim/sysmsg.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMSysMsgAPI, SysMessage, NIMSysMsgStatus, NIMSysMsgType, NotifySingleSysmsgCallback, NotifySysmsgResCallback, QuerySysmsgCallback } from '../nim_def/sysmsg_def';
 import { SendMessageArc } from '../nim_def/talk_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMSysMsgEvents {
     /** 系统通知 */
     receiveSystemMsg: [SysMessage];

package/types/nim/talk.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { IMMessage, NIMMessageType } from '../nim_def/msglog_def';
 import { BroadcastMessage, MessageFilterCallback, NIMTalkAPI, RecallMsgNotify, RecallMsgsCallback, SendMessageArc, TeamNotificationFilterCallback } from '../nim_def/talk_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMTalkEvents {
     /** 发送消息回调 */
     sendMsg: [SendMessageArc];

package/types/nim/talkex.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMTalkExAPI, CollectInfo, AddCollectCallback, RemoveCollectsParm, RemoveCollectsCallback, MatchCollectParm, UpdateCollectCallback, QueryCollectsParm, QueryCollectsCallback, QuickCommentInfo, AddQuickCommentCallback, RemoveQuickCommentParam, RemoveQuickCommentCallback, QueryQuickCommentsParam, QueryQuickCommentCallback, PinMessageInfo, PinMessageCallback, ModifyPinMessageParam, UnPinMessageCallback, UpdatePinMessageCallback, QueryPinMessageCallback, CollectInfoList, QueryQuickCommentsResponse, QueryAllPinMessageResponse } from '../nim_def/talkex_def';
 import { IMMessage } from '../nim_def/msglog_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMTalkExEvents {
     /** 添加快捷回复 */
     addQuickComment: [number, QuickCommentInfo];

package/types/nim/team.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'eventemitter3';
 import { IMMessage } from '../nim_def/msglog_def';
 import { NIMTeamAPI, TeamInfo, TeamEventCallback, QueryAllMyTeamsCallback, QueryAllMyTeamsInfoCallback, QueryTeamMyAllMemberInfosCallback, QueryTeamMembersCallback, QueryTeamMemberCallback, QueryTeamInfoCallback, QueryTeamMembersOnlineCallback, TeamMsgAckReadCallback, QueryTeamMembersInvitorCallback, QueryTeamsInfoCallback, UpdateTInfoLocalCallback, GetTeamInfoBatchSFTransCallback, GetTeamInfoListCallback, TeamMemberProperty, TeamEvent } from '../nim_def/team_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMTeamEvents {
     /** 群事件 */
     teamEvent: [TeamEvent];

package/types/nim/tool.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMToolAPI, NIMAppDataType, AudioInfo, GetAudioTextCallback, FilterClientAntispamCallback } from '../nim_def/tool_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMToolEvents {
 }
 export declare class NIMTool extends EventEmitter<NIMToolEvents> {

package/types/nim/user.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'eventemitter3';
 import { NIMUserAPI, SetRelationCallback, GetSpecialListCallback, GetUserNameCardCallback, UpdateMyUserNameCardCallback, NINPushType, UserNameCard, SpecialRelationshipChangeEvent, BlackMuteListInfo } from '../nim_def/user_def';
-import { NIMResCode } from 'ts/nim_def/client_def';
+import { NIMResCode } from '../nim_def/client_def';
 export declare interface NIMUserEvents {
     /** 用户属性变更 */
     specialRelationChange: [SpecialRelationshipChangeEvent];

package/types/qchat_def/instance_def.d.ts

@@ -170,6 +170,8 @@ export interface QChatInitParam {
     auth_timeout?: number;
     /** 数据库加密密钥，如果为空，则使用默认值 */
     database_encrypt_key?: string;
+    /** 自动订阅 */
+    auto_subscribe?: boolean;
     /** 加密配置 */
     encryption_configuration?: QChatEncryptionConfiguration;
     /** FCS配置 */