nim-web-sdk-ng 0.9.2 → 0.11.0

package/README.md

@@ -41,7 +41,8 @@ import NIM from 'nim-web-sdk-ng/dist/NIM_BROWSER_SDK'
 // 若使用聊天室能力则引入
 import Chatroom from 'nim-web-sdk-ng/dist/CHATROOM_BROWSER_SDK'
 
-const nim = new NIM(
+// 0.11.0 版开始支持单例模式获取实例, 在此之前通过 new 创建实例
+const nim = NIM.getInstance(
   {
     debugLevel: 'debug',
     appkey: 'YOUR_APPKEY',
@@ -51,7 +52,8 @@ const nim = new NIM(
   {}
 )
 
-const chatroom = new Chatroom({
+// 0.11.0 版开始支持单例模式获取实例, 在此之前通过 new 创建实例
+const chatroom = Chatroom.getInstance({
   debugLevel: 'debug',
   appkey: 'YOUR_APPKEY',
   account: 'YOUR_ACCOUNT',
@@ -62,9 +64,21 @@ const chatroom = new Chatroom({
 })
 
 async function init() {
-  await nim.connect()
-
-  await chatroom.connect()
+  try {
+    if (nim.status === 'unconnected' || nim.status === 'waitReconnect') {
+      await nim.connect()
+    }
+  } catch (err) {
+    console.error('login failed cause', err)
+  }
+
+  try {
+    if (chatroom.status === 'unconnected' || chatroom.status === 'waitReconnect') {
+      await chatroom.connect()
+    }
+  } catch (err) {
+    console.error('login failed cause', err)
+  }
 }
 
 init()
@@ -89,7 +103,8 @@ NIM.setAdapters(browserAppAdapters)
 NIM.registerService(MsgService, 'msg')
 NIM.registerService(SessionService, 'session')
 
-const nim = new NIM(
+// 0.11.0 版开始支持单例模式获取实例, 在此之前通过 new 创建实例
+const nim = NIM.getInstance(
   {
     debugLevel: 'debug',
     appkey: 'YOUR_APPKEY',
@@ -100,7 +115,13 @@ const nim = new NIM(
 )
 
 async function init() {
-  await nim.connect()
+  try {
+    if (nim.status === 'unconnected' || nim.status === 'waitReconnect') {
+      await nim.connect()
+    }
+  } catch (err) {
+    console.error('login failed cause', err)
+  }
 }
 
 init()
@@ -114,7 +135,8 @@ import browserAdapters from 'nim-web-sdk-ng/dist/esm/browserAdapters'
 
 Chatroom.setAdapters(browserAppAdapters)
 
-const chatroom = new Chatroom({
+// 0.11.0 版开始支持单例模式获取实例, 在此之前通过 new 创建实例
+const chatroom = Chatroom.getInstance({
   debugLevel: 'debug',
   appkey: 'YOUR_APPKEY',
   account: 'YOUR_ACCOUNT',
@@ -125,7 +147,13 @@ const chatroom = new Chatroom({
 })
 
 async function init() {
-  await chatroom.connect()
+  try {
+    if (chatroom.status === 'unconnected' || chatroom.status === 'waitReconnect') {
+      await chatroom.connect()
+    }
+  } catch (err) {
+    console.error('login failed cause', err)
+  }
 }
 
 init()
@@ -135,29 +163,29 @@ 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)
-- [消息扩展](https://doc.yunxin.163.com/docs/TM5MzM5Njk/zA0NDIyMzA?platformId=120901)
-- [会话](https://doc.yunxin.163.com/docs/TM5MzM5Njk/TIwNDYzNTE?platformId=120901)
-- [用户](https://doc.yunxin.163.com/docs/TM5MzM5Njk/Tg0MzYyODA?platformId=120901)
-- [好友](https://doc.yunxin.163.com/docs/TM5MzM5Njk/jI1NDQzNjk?platformId=120901)
-- [订阅](https://doc.yunxin.163.com/docs/TM5MzM5Njk/TU5NzgyMTY?platformId=120901)
-- [系统通知](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)
-- [uniapp 推送相关](https://doc.yunxin.163.com/docs/TM5MzM5Njk/jAzOTIwMDk?platformId=120901)
+- [快速开始](https://doc.yunxin.163.com/messaging-enhanced/docs/DQwMDE5MDk?platform=web)
+- [初始化与登录](https://doc.yunxin.163.com/messaging-enhanced/docs/DE1MTcxNzg?platform=web)
+- [消息收发](https://doc.yunxin.163.com/messaging-enhanced/docs/TQ2NTUxNTM?platform=web)
+- [消息扩展](https://doc.yunxin.163.com/messaging-enhanced/docs/DYzMDAyMjg?platform=web)
+- [会话](https://doc.yunxin.163.com/messaging-enhanced/docs/TgxNjczNzk?platform=web)
+- [用户](https://doc.yunxin.163.com/messaging-enhanced/docs/Dc0Njg0NjY?platform=web)
+- [好友](https://doc.yunxin.163.com/messaging-enhanced/docs/zc2MTk2MjE?platform=web)
+- [订阅](https://doc.yunxin.163.com/messaging-enhanced/docs/TE2ODU3NjM?platform=web)
+- [系统通知](https://doc.yunxin.163.com/messaging-enhanced/docs/DIyMDE2NDM?platform=web)
+- [群组](https://doc.yunxin.163.com/messaging-enhanced/docs/DA4OTc3NDc?platform=web)
+- [超级群](https://doc.yunxin.163.com/messaging-enhanced/docs/TY3MzM1ODg?platform=web)
+- [uniapp 推送相关](https://doc.yunxin.163.com/messaging-enhanced/docs/TAwMTEyNzE?platform=web)
 
 聊天室
 
-- [聊天室](https://doc.yunxin.163.com/docs/TM5MzM5Njk/jk5NTk1NTg?platformId=120901)
+- [聊天室](https://doc.yunxin.163.com/messaging-enhanced/docs/jM2MzczOTE?platform=web)
 
 圈组
 
-- [圈组](https://doc.yunxin.163.com/docs/TM5MzM5Njk/Tc4ODUzODk?platformId=120901)
+- [圈组](https://doc.yunxin.163.com/messaging-enhanced/docs/TczMjgzMzU?platform=web)
 
 其他
 
-- [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)
+- [API 参考](https://doc.yunxin.163.com/docs/interface/messaging-enhanced/web/typedoc/Latest/zh/NIM/index.html)
+- [已知问题](https://doc.yunxin.163.com/messaging-enhanced/docs/jE5NTczNTI?platform=web)
+- [更新日志](https://doc.yunxin.163.com/messaging-enhanced/docs/zMwOTk5MjI?platform=web)

package/dist/CHATROOM_BROWSER_SDK/ChatroomInterface.d.ts

@@ -1,5 +1,9 @@
 import { Chatroom, ChatroomMember, ChatroomMessage } from './types';
 export interface ChatroomInterface {
+    /**
+     * 实例状态
+     */
+    status: NIMEChatroomInstanceStatus;
     /**
      * @Multi_Lang_Tag
      * @locale cn
@@ -252,6 +256,56 @@ export declare type ChatroomOtherOptions = {
         s3?: any;
     };
 };
+/**
+ * @Multi_Lang_Tag
+ * @locale cn
+ * 静态方法
+ * @locale
+ *
+ * @locale en
+ * Static method
+ * @locale
+ */
+export interface ChatroomInterfaceStatic {
+    /**
+     * 构造函数
+     */
+    new (options?: ChatroomInitializeOptions, otherOptions?: ChatroomOtherOptions): ChatroomInterface;
+    /**
+     * 单例模式获取实例
+     */
+    getInstance(_options?: ChatroomInitializeOptions, _otherOptions?: ChatroomOtherOptions): ChatroomInterface;
+    /**
+     * 设置适配器
+     * @param _newAdapters 适配器
+     */
+    setAdapters(_newAdapters: any): void;
+}
+/**
+ * @Multi_Lang_Tag
+ * @locale cn
+ * 实例的状态标识
+ *
+ * - unconnected: 尚未建立连接(初始化、主动登出、达到最大重连次数)
+ * - connecting: 正在建立连接中
+ * - connected: 已连接，尚未完成鉴权认证
+ * - logined: 已连接, 并且完成了鉴权认证，可以正常开始发送协议
+ * - waitReconnect: 等待重连中
+ * - destroyed: 实例已经销毁
+ * @locale
+ *
+ * @locale en
+ * Status of the instance
+ *
+ * - unconnected: no connection has been established(Initialization, active logout, and maximum reconnection times)
+ * - connecting: Establishing connection
+ * - connected: Connected, authentication has not been completed
+ * - logined: Connected and completed the authentication
+ * - waitReconnect: Waiting for reconnection
+ * - destroyed: The instance has been destroyed
+ * @locale
+ */
+export declare type NIMEChatroomInstanceStatus = 'unconnected' | 'connecting' | 'connected' | 'logined' | 'waitReconnect' | 'destroyed';
 /**
  * Example：
  *

package/dist/CHATROOM_BROWSER_SDK/ChatroomMsgServiceInterface.d.ts

@@ -103,6 +103,17 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      */
     queryMessageHistory(options: QueryMessageHistoryOptions): Promise<ChatroomMessage[]>;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 根据标签查询历史消息
+     * @locale
+     *
+     * @locale en
+     * Query historical messages by tags
+     * @locale
+     */
+    getHistoryMsgsByTags(options: GetHistoryMsgsByTagsOptions): Promise<ChatroomMessage[]>;
 }
 export declare type QueryMessageHistoryOptions = {
     timetag?: number;

package/dist/CHATROOM_BROWSER_SDK/CloudStorageServiceInterface.d.ts

@@ -22,4 +22,84 @@ export interface CloudStorageServiceInterface {
      * @locale
      */
     getOriginUrl(options: string): Promise<string>;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 获取文件鉴权的token
+     * @locale
+     * @locale en
+     * Get the token for the authorization of file access.
+     * @locale
+     */
+    getFileToken(options: GetFileTokenOptions): Promise<GetFileTokenResult | void>;
 }
+export declare type GetFileTokenOptions = {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 类型 2表示带过期时间的全局token鉴权，3表示文件级别的url鉴权
+     * @locale
+     *
+     * @locale en
+     *
+     * @locale
+     */
+    type: 2 | 3;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 如果type=3,是url鉴权，需要传url数组
+     * @locale
+     *
+     * @locale en
+     *
+     * @locale
+     */
+    urls?: string[] | string;
+};
+export declare type GetFileTokenResult = {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 类型 2表示带过期时间的全局token鉴权，3表示文件级别的url鉴权
+     * @locale
+     *
+     * @locale en
+     *
+     * @locale
+     */
+    type: 2 | 3;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 如果是url鉴权，就返回url数组对应的tokens
+     * @locale
+     *
+     * @locale en
+     *
+     * @locale
+     */
+    tokens?: string[];
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 基于过期时间鉴权的token
+     * @locale
+     *
+     * @locale en
+     *
+     * @locale
+     */
+    token?: string;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * token的过期时间，单位s
+     * @locale
+     *
+     * @locale en
+     *
+     * @locale
+     */
+    ttl: number;
+};

package/dist/CHATROOM_BROWSER_SDK/index.d.ts

@@ -1,11 +1,22 @@
-import { ChatroomEventInterface, ChatroomInitializeOptions, ChatroomInterface } from './ChatroomInterface';
+import { ChatroomEventInterface, ChatroomInitializeOptions, ChatroomInterface, ChatroomOtherOptions, NIMEChatroomInstanceStatus } from './ChatroomInterface';
 import { ChatroomServiceInterface } from './ChatroomServiceInterface';
 import { ChatroomMsgServiceInterface } from './ChatroomMsgServiceInterface';
 import { ChatroomMemberServiceInterface } from './ChatroomMemberServiceInterface';
 import { CloudStorageServiceInterface } from './CloudStorageServiceInterface';
 import { EventEmitter } from 'eventemitter3';
-export default class QChat extends EventEmitter<ChatroomEventInterface> implements ChatroomInterface {
+export default class Chatroom extends EventEmitter<ChatroomEventInterface> implements ChatroomInterface {
+    static instance: Chatroom | null;
+    /**
+     * 实例的状态
+     */
+    status: NIMEChatroomInstanceStatus;
+    /**
+     * 账号
+     */
     account: string;
+    /**
+     * 连接参数
+     */
     options: ChatroomInitializeOptions;
     chatroom: ChatroomServiceInterface;
     chatroomMsg: ChatroomMsgServiceInterface;
@@ -16,5 +27,13 @@ export default class QChat extends EventEmitter<ChatroomEventInterface> implemen
     setOptions(): Promise<void>;
     disconnect(): Promise<void>;
     destroy(): Promise<void>;
-    static setAdapters(newAdapters: any): void;
+    /**
+     * 单例模式获取实例
+     */
+    static getInstance(_options?: ChatroomInitializeOptions, _otherOptions?: ChatroomOtherOptions): Chatroom;
+    /**
+     * 设置适配器
+     * @param _newAdapters 适配器
+     */
+    static setAdapters(_newAdapters: any): void;
 }