nim-web-sdk-ng 0.5.2 → 0.6.2

package/README.md

@@ -1,31 +1,140 @@
-网易云信即时通讯 uniapp sdk 为 uniapp 应用提供完善的即时通信功能开发框架，屏蔽其内部复杂细节，对外提供较为简洁的 API 接口，方便第三方应用快速集成即时通信功能。
+网易云信即时通讯 Web Elite SDK，为 web sdk 的下一代版本，提供完善的即时通信功能开发框架，屏蔽其内部复杂细节，对外提供较为简洁的 API 接口，方便第三方应用快速集成即时通信功能。
+
+安装
+
+```
+npm install nim-web-sdk-ng@latest
+```
 
 ## sdk 选择
 
-引入
+sdk 默认提供以下几种形式
+
+```
+dist/
+├── CHATROOM_BROWSER_SDK.js  聊天室浏览器适配版 UMD 格式
+├── CHATROOM_MINIAPP_SDK.js  聊天室小程序适配版 UMD 格式
+├── CHATROOM_UNIAPP_SDK.js   聊天室 UNIAPP 适配版 UMD 格式
+├── NIM_BROWSER_SDK.js       IM 浏览器适配版 UMD 格式
+├── NIM_MINIAPP_SDK.js       IM 小程序适配版 UMD 格式
+├── NIM_UNIAPP_SDK.js        IM UNIAPP 适配版 UMD 格式
+├── QCHAT_BROWSER_SDK.js     圈组浏览器适配版 UMD 格式
+├── esm
+│   ├── adapters.d.ts
+│   ├── index.d.ts
+│   ├── index.js             ESM 模式，汇总各模块的，ES Module 格式
+```
+
+注意：
+
+1. 这里的小程序适配版，其实是指四种小程序：微信、头条、百度、支付宝
+2. ESM 模式的 SDK，导出了 IM、聊天室、圈组三个 SDK，以及适配器，对体积有比较严格的需求的建议使用这个模式。
+
+#### 基础引入例子
 
 ```js
 // 若使用 IM 能力则引入
-import NIMSDK from 'nim-web-sdk-ng'
+import NIM from 'nim-web-sdk-ng'
 // 等效于
-import NIMSDK from 'nim-web-sdk-ng/dist/NIM_BROWSER_SDK'
+import NIM from 'nim-web-sdk-ng/dist/NIM_BROWSER_SDK'
 
 // 若使用聊天室能力则引入
-import ChatroomSDK from 'nim-web-sdk-ng/dist/CHATROOM_BROWSER_SDK'
+import Chatroom from 'nim-web-sdk-ng/dist/CHATROOM_BROWSER_SDK'
+
+const nim = new NIM(
+  {
+    debugLevel: 'debug',
+    appkey: 'YOUR_APPKEY',
+    account: 'YOUR_ACCOUNT',
+    token: 'YOUR_TOKEN'
+  },
+  {}
+)
+
+const chatroom = new Chatroom({
+  debugLevel: 'debug',
+  appkey: 'YOUR_APPKEY',
+  account: 'YOUR_ACCOUNT',
+  token: 'YOUR_TOKEN',
+  isAnonymous: false,
+  chatroomId: 'YOUR_CHATROOM_ID',
+  chatroomAddresses: ['YOUR_CHATRROM_ADDR']
+})
+
+async function init() {
+  await nim.connect()
+
+  await chatroom.connect()
+}
+
+init()
+```
+
+#### ESM 模式的使用例子
+
+**需要 version >= 0.6.1**，对于开发者有体积要求的需求，单独引入 上述 SDK，会使得代码总体积比较大，故而可以选用 ESM 形式引入。
+
+IM 需要自行注册模块，和适配器。
+
+参见 node_modules 里关于 esm 模块的 ts 定义来获知有多少种模块和适配器选择，最终希望开发者的工程能够 tree-shaking 掉不需要的模块。
+
+```js
+import { NIM, MsgService, SessionService } from 'nim-web-sdk-ng/dist/esm'
+import browserAdapters from 'nim-web-sdk-ng/dist/esm/browserAdapters'
+// import miniAdapters from 'nim-web-sdk-ng/dist/esm/miniAppAdapters'
+// import uniAppAdapters from 'nim-web-sdk-ng/dist/esm/uniAppAdapters'
+
+// ESM 模式，IM 依赖的能力需要自行注册，以便于不用的模块最后能被 tree-shaking 掉。
+NIM.setAdapters(browserAppAdapters)
+NIM.registerService(MsgService)
+NIM.registerService(SessionService)
+
+const nim = new NIM(
+  {
+    debugLevel: 'debug',
+    appkey: 'YOUR_APPKEY',
+    account: 'YOUR_ACCOUNT',
+    token: 'YOUR_TOKEN'
+  },
+  {}
+)
+
+async function init() {
+  await nim.connect()
+}
+
+init()
 ```
 
-若是 uniapp 环境
+而聊天室和圈组的 SDK，只需要注册适配器，不需要注册模块，因为其各模块在功能上是不可拆分的，所以全都合并在 SDK 中。
 
 ```js
-// IM
-import NIMSDK from 'nim-web-sdk-ng/dist/NIM_UNIAPP_SDK'
+import { Chatroom } from 'nim-web-sdk-ng/dist/esm'
+import browserAdapters from 'nim-web-sdk-ng/dist/esm/browserAdapters'
+
+Chatroom.setAdapters(browserAppAdapters)
+
+const chatroom = new Chatroom({
+  debugLevel: 'debug',
+  appkey: 'YOUR_APPKEY',
+  account: 'YOUR_ACCOUNT',
+  token: 'YOUR_TOKEN',
+  isAnonymous: false,
+  chatroomId: 'YOUR_CHATROOM_ID',
+  chatroomAddresses: ['YOUR_CHATRROM_ADDR']
+})
+
+async function init() {
+  await chatroom.connect()
+}
 
-// 聊天室
-import ChatroomSDK from 'nim-web-sdk-ng/dist/CHATROOM_UNIAPP_SDK'
+init()
 ```
 
 ## 使用指引目录
 
+IM
+
 - [快速开始](https://doc.yunxin.163.com/docs/TM5MzM5Njk/zg2Nzg2MDM?platformId=120901)
 - [初始化与登录](https://doc.yunxin.163.com/docs/TM5MzM5Njk/zA5MzQ3NDc?platformId=120901)
 - [消息收发](https://doc.yunxin.163.com/docs/TM5MzM5Njk/Dc5NTIyMDk?platformId=120901)
@@ -37,8 +146,18 @@ import ChatroomSDK from 'nim-web-sdk-ng/dist/CHATROOM_UNIAPP_SDK'
 - [系统通知](https://doc.yunxin.163.com/docs/TM5MzM5Njk/DY2NDE5MzI?platformId=120901)
 - [群组](https://doc.yunxin.163.com/docs/TM5MzM5Njk/Tg0MDA3NjA?platformId=120901)
 - [超级群](https://doc.yunxin.163.com/docs/TM5MzM5Njk/DI5NDY3ODM?platformId=120901)
-- [聊天室](https://doc.yunxin.163.com/docs/TM5MzM5Njk/jk5NTk1NTg?platformId=120901)
 - [uniapp 推送相关](https://doc.yunxin.163.com/docs/TM5MzM5Njk/jAzOTIwMDk?platformId=120901)
+
+聊天室
+
+- [聊天室](https://doc.yunxin.163.com/docs/TM5MzM5Njk/jk5NTk1NTg?platformId=120901)
+
+圈组
+
+- [圈组](https://doc.yunxin.163.com/docs/TM5MzM5Njk/Tc4ODUzODk?platformId=120901)
+
+其他
+
 - [API 参考](https://doc.yunxin.163.com/docs/TM5MzM5Njk/Tg4NDU5Mjg?platformId=120901)
 - [已知问题](https://doc.yunxin.163.com/docs/TM5MzM5Njk/DMwNjQzNjY?platformId=120901)
 - [更新日志](https://doc.yunxin.163.com/docs/TM5MzM5Njk/DE2MTUzMDE?platformId=120901)

package/dist/CHATROOM_BROWSER_SDK/ChatroomInterface.d.ts

@@ -181,7 +181,7 @@ export declare type ChatroomInitializeOptions = {
      * 2 indicates the authentication method based on the token got from third-party callback.
      * @locale
      */
-    authType: number;
+    authType?: number;
     /**
      * @Multi_Lang_Tag
      * @locale cn
@@ -192,7 +192,7 @@ export declare type ChatroomInitializeOptions = {
      * Login customization field, used for submitting to the user's third-party callback service for login authentication.
      * @locale
      */
-    loginExt: string;
+    loginExt?: string;
 };
 /**
  * Example：

package/dist/CHATROOM_BROWSER_SDK/index.d.ts

@@ -6,6 +6,7 @@ import { CloudStorageServiceInterface } from './CloudStorageServiceInterface';
 import { EventEmitter } from 'eventemitter3';
 export default class QChat extends EventEmitter<ChatroomEventInterface> implements ChatroomInterface {
     account: string;
+    options: ChatroomInitializeOptions;
     chatroom: ChatroomServiceInterface;
     chatroomMsg: ChatroomMsgServiceInterface;
     chatroomMember: ChatroomMemberServiceInterface;
@@ -14,4 +15,5 @@ export default class QChat extends EventEmitter<ChatroomEventInterface> implemen
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     destroy(): Promise<void>;
+    static setAdapters(newAdapters: any): void;
 }