nim-web-sdk-ng 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.3.0
+
+* feature: 追加 deleteSelfMsgs 单向删除接口。
+* feature: 推送插件以及适配代码，推送功能的使用参见文章：
+* chore: uniapp 平台适配优化，能够支持编译去支付宝小程序，微信小程序
+* chore: 优化撤回消息逻辑，使撤回消息后 session 的 unread 数等参数能得到正确的更新。
+* chore: 聊天室追加鉴权方式
+* fix: 修复登出协议的一些问题
+
 ## 0.2.0
 
 * feature: 追加 superTeam 超级群逻辑

package/dist/CHATROOM_BROWSER_SDK.d.ts

@@ -126,6 +126,14 @@ interface MsgServiceInterface {
      * 如果同时在多个端登录了同一个账号, 那么其它端也会收到这条系统通知.
      */
     recallMsg(options: RecallMsgOptions): Promise<IMMessage>;
+    /**
+     * 单向删除消息
+     *
+     * 不同与直接删除消息，单向删除消息后，自己看不到删除的消息，但对方仍能看到，也就是仅删除自己这侧的消息
+     *
+     * 如果同时在多个端登录了同一个账号, 其他端会收到一个单向删除的事件.
+     */
+    deleteSelfMsgs(options: deleteSelfMsgsOptions): Promise<DeleteSelfMsgsResult[]>;
     sendMsgReceipt(options: SendMsgReceiptOptions): Promise<SendMsgReceiptResult | void>;
     /**
      * 查看这条消息对方是否已读过。
@@ -589,6 +597,46 @@ declare type RecallMsgOptions = {
      */
     env?: string;
 };
+declare type deleteSelfMsgsOptions = {
+    /**
+     * 待删除的消息对象
+     */
+    msgs: IMMessage[];
+    /**
+     * 扩展字段
+     */
+    ext?: string;
+};
+declare type DeleteSelfMsgsResult = {
+    /**
+     * 删除时间
+     */
+    deletedTime: number;
+    /**
+     * 此消息的发送者
+     */
+    from: string;
+    /**
+     * 此消息的 idClient
+     */
+    idClient: string;
+    /**
+     * 此消息的 idServer
+     */
+    idServer: string;
+    /**
+     * 此消息的场景，只有 p2p, team ，超大群暂时不允许单向删除
+     */
+    scene: 'p2p' | 'team';
+    /**
+     * 此消息的发送时间
+     */
+    time: number;
+    /**
+     * 此消息的接收者
+     */
+    to: string;
+};
 declare type SendMsgReceiptOptions = {
     msg: IMMessage;
 };
@@ -873,6 +921,7 @@ declare type TSystemInfo = {
  * 尽量使用规范或接近规范的定义
  */
 declare class Adapters {
+    static setLogger(logger: any): void;
     static platform: string;
     static WebSocket: typeof WebSocket;
     static localStorage: Storage;
@@ -922,6 +971,10 @@ declare type RequestParams = {
         [key: string]: string | number;
     };
     timeout?: number;
+    /**
+     * 支付宝需要传 dataType: text 才能让 socket io 嗅探请求不挂
+     */
+    dataType: string;
 };
 declare function setAdapters(newAdapters: Adapters): void;
 
@@ -981,6 +1034,11 @@ declare type CoreOptions = {
      */
     reconnectionAttempts?: number;
 };
+declare enum DisconnectType {
+    ACTIVE = 1,
+    KICKED = 2,
+    OFFLINE = 3
+}
 declare type NIMStatus = 'unconnected' | 'connecting' | 'connected' | 'logined' | 'waitReconnect' | 'destroyed';
 declare class Core extends EventEmitter {
     status: NIMStatus;
@@ -1007,9 +1065,20 @@ declare class Core extends EventEmitter {
     connect(options?: ConnectOptions): Promise<void>;
     private doConnect;
     resetConnectStatus(): void;
-    onDisconnect(from?: string, shouldReconnect?: boolean, shouldNotify?: boolean): void;
-    private willReconnect;
-    private clearOldSocket;
+    /**
+     * 断开连接
+     *
+     * 1. 标记未完成的 cmd 无效
+     * 2. 取消心跳定时
+     * 3. 关闭长连接通道
+     * 4. 区分断开类型（是否需要重连，是否需要通知）
+     *   4a. 主动断开的（登陆失败也算主动断开了）: 1. 不需要重连、2. 移除网络监听、3. 通知上层 disconnect 事件
+     *   4b. 被踢下线的: 1. 不需要重连、2. 移除网络监听、3. 通知上层 kicked 事件和原因
+     *   4c. 因网络变化，心跳超时，发包失败等被动断开的: 1. 需要尝试重连、2. 不移除网络监听、3. 通知 willReconnect 事件、4. 设置重连定时
+     *   4d. 因网络变化，心跳超时，发包失败等被动断开的，但是用户不开启重连配置，或者重连尝试最大次数已经达到：处理逻辑同 5a.
+     */
+    doDisconnect(type: DisconnectType, description: string | StrAnyObj$1): void;
+    private attempToReconnect;
     /**
      * @ignore
      */
@@ -1022,6 +1091,7 @@ declare class Core extends EventEmitter {
      */
     ping(): void;
     private initOnlineListener;
+    private destroyOnlineListener;
     /**
      * 退出登录，并断开websocket连接
      *
@@ -1029,6 +1099,15 @@ declare class Core extends EventEmitter {
      * 如需销毁实例，请用 destroy
      */
     disconnect(): Promise<void>;
+    /**
+     * 销毁实例
+     *
+     * 实现法则：不能使正在运行中的promise/callback访问不到某实例的变量报错，因此只是掐断实例接收新消息的通道，并且移除所有的监听，移除所有能通知上层的事件。
+     *
+     * 在 disconnect 断开连接后：
+     * 1. 标明 status 为 destroy
+     * 2. 移除 connect 等方法使连接状态无法再此更改。
+     */
     destroy(): Promise<void>;
 }
 
@@ -1476,6 +1555,17 @@ declare type ChatroomInitializeOptions = {
      * 登录登出等通知目标的标签，是一个标签表达式
      */
     notifyTargetTags?: string;
+    /**
+     * 鉴权方式，默认0
+     * 0 表示最初的loginToken的校验方式，
+     * 1 表示基于appSecret计算的token鉴权方式，
+     * 2表示基于第三方回调的token鉴权方式，
+     */
+    authType: number;
+    /**
+     * 登录自定义字段，用于提交给用户的第三方回调服务进行登录检测
+     */
+    loginExt: string;
 };
 
 interface ChatroomServiceInterface {
@@ -1875,9 +1965,13 @@ declare type Session = {
      */
     unread: number;
     /**
-     * 上一条消息
+     * 上一条消息.
+     *
+     * 若 lastMsg 为 undefined ，那么可能是从未设置过的，会话不完整。getSessions 将过滤掉此会话
+     *
+     * 若 lastMsg 为 null，lastMsg 为 null 则可能是撤回消息，也可能是清除了这个会话的历史消息
      */
-    lastMsg: IMMessage | null;
+    lastMsg?: IMMessage | null;
     /**
      * 更新时间
      */
@@ -3232,6 +3326,38 @@ declare type Relations = {
     blackList: MarkedUserInfo[];
     muteList: MarkedUserInfo[];
 };
+/**
+ * 推送专用，更新并上报厂商推送（APNs、小米推送等）的devicetoken
+ */
+declare type UpdatePushTokenOptions = {
+    /**
+     * 证书名
+     */
+    tokenName: string;
+    /**
+     * 推送 token
+     */
+    token: string;
+    /**
+     * 推送通道。默认 0，表示 apns 通道
+     */
+    pushkit: number;
+};
+/**
+ * 推送专用
+ */
+declare type UpdateAppBackgroundOptions = {
+    /**
+     * app 是否正处在后台。
+     * true 为 app 转入后台运行
+     * false 为 app 切回前台运行
+     */
+    isBackground: boolean;
+    /**
+     * 未读数（角标数字），只有ios需要传这个参数。
+     */
+    badge: number;
+};
 
 interface NIMInterface {
     /**
@@ -3395,7 +3521,7 @@ declare type SyncOptions = {
     /**
      * 是否同步单向删除信息，默认 true
      */
-    deleteMsgSelf?: boolean;
+    deleteSelfMsgs?: boolean;
     /**
      * 是否同步置顶会话信息，默认 false
      */
@@ -3464,6 +3590,7 @@ declare class MsgService extends Service implements MsgServiceInterface {
     sendVideoMsg(options: IBaseSendFileOptions$1): Promise<IMMessage>;
     private doSendFile;
     recallMsg(options: RecallMsgOptions): Promise<IMMessage>;
+    deleteSelfMsgs(options: deleteSelfMsgsOptions): Promise<DeleteSelfMsgsResult[]>;
     sendMsgReceipt(options: SendMsgReceiptOptions): Promise<SendMsgReceiptResult | void>;
     sendTeamMsgReceipt(options: SendTeamMsgReceiptOptions): Promise<void>;
     getTeamMsgReads(options: GetTeamMsgReadsOptions): Promise<GetTeamMsgReadsResult>;
@@ -3474,6 +3601,9 @@ declare class MsgService extends Service implements MsgServiceInterface {
     private syncOfflineMsgsHandler;
     private onMsgReceiptHandler;
     private syncMsgReceiptsHandler;
+    private syncDeleteSelfMsgsHandler;
+    private onDeleteSelfMsgHandler;
+    private onDeleteSelfMsgsHandler;
 }
 
 interface MiscServiceInterface {
@@ -3513,6 +3643,8 @@ declare class UserService extends Service implements UserServiceInterface {
     getRelations(): Promise<Relations>;
     getBlackList(): Promise<MarkedUserInfo[]>;
     getMuteList(): Promise<MarkedUserInfo[]>;
+    updatePushToken(options: UpdatePushTokenOptions): Promise<void>;
+    updateAppBackground(options: UpdateAppBackgroundOptions): Promise<void>;
     getUsersNameCardFromServer(options: getUsersOptions): Promise<UserNameCard[]>;
     updateMyNameCard(options: updateMyInfoOptions): Promise<UserNameCard>;
     private onUpdateBlackListHandler;
@@ -3555,6 +3687,7 @@ declare class SessionService extends Service implements SessionServiceInterface
     /** 设置当前会话，同时清空其未读数，返回的Promise状态表示未读数是否清空成功 */
     /** 收到消息，更新会话 */
     private updateSessionWithMsg;
+    /** 收到 msg receipt，更新会话已读计数 */
     private updateSessionMsgReceiptTime;
     /** 根据ack计算未读数，并存储结果 */
     private storeUnreadByAck;
@@ -3567,6 +3700,8 @@ declare class SessionService extends Service implements SessionServiceInterface
     onSyncDone(): void;
     /** 初始化同步时，收到漫游/离线消息后，会话相关的处理 */
     private onSyncMsgs;
+    /** 多端同步/在线时，收到单向删除通知，需要更新会话 */
+    private updateSessionForDeletedMsg;
 }
 
 declare class ModuleService$1 {
@@ -3646,7 +3781,7 @@ declare class SystemMessageService extends Service implements SystemMessageServi
     private onSysMsgHandler;
     private syncOfflineSysMsgsHandler;
     private onRecallMsgHandler;
-    private syncDeleteMsgOfflineRoamingHandler;
+    private syncRecallMsgOfflineAndRoamingHandler;
 }
 
 declare class FriendService extends Service implements FriendServiceInterface {