@onyx-p/imlib-web 1.2.3 → 1.2.4

package/{types → dist/types}/index.d.ts

@@ -6,8 +6,10 @@ import IReceivedMessage from './model/iReceivedMessage';
 import IReceivedConversation from './model/iReceivedConversation';
 import { CommonReqResult, PBCodec } from './net/connection/webSocketServer';
 import { BaseResp } from './net/pbs/rpc.base';
-export { TextMessage, ImageMessage, HQVoiceMessage, GIFMessage, FileMessage, CommandMessage } from './model/messages';
-export type { ITextMessageBody, IImageMessageBody, IGIFMessageBody, IFileMessageBody, IHQVoiceMessageBody, IRecallCommandMessageBody, ICommandMessageBody } from './model/messages';
+import { IChatRecordMsgDetail } from './model/messages/otherMediaMessages';
+export { TextMessage, ImageMessage, HQVoiceMessage, GIFMessage, FileMessage, VideoMessage, RecallCommandMessage, LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage } from './model/messages';
+export type { ITextMessageBody, IImageMessageBody, IGIFMessageBody, IFileMessageBody, IHQVoiceMessageBody, IRecallCommandMessageBody, IVideoMessageBody, ILocationMessageBody, IChatRecordMessageBody, IContactMessageBody, IInvitationMessageBody, IRedEnvelopeMessageBody, ITransferMessageBody, IBurnAfterReadingMessageBody } from './model/messages';
+export { MessageTypes, NotiMessageTypes } from './constants/messageTypes';
 export type { IBaseMessageBody, IReceivedMessage, IReceivedConversation };
 export * from './types';
 export * from './model/statusTypes';
@@ -96,6 +98,10 @@ export declare const getUnreadMentionedCount: (options: IConversationOption) =>
  * 获取所有群会话 @ 消息未读数
  */
 export declare const getAllUnreadMentionedCount: () => IPromiseResult<number>;
+/**
+ * 获取本地单个会话的状态
+ */
+export declare const getConversationState: (options: IConversationOption) => IConversationState | null;
 /**
  * 获取本地全部会话的状态
  * @description
@@ -168,7 +174,7 @@ export declare const getTopConversationList: () => IPromiseResult<IBaseConversat
  * @param prototypes  消息属性名称
  * @param isStatusMessage  是否是状态消息
  */
-export declare const registerMessageType: <T extends IBaseMessageBody>(messageType: string, isPersited: boolean, isCounted: boolean, prototypes?: string[], isStatusMessage?: boolean) => new (content: T) => BaseMessage<T>;
+export declare const registerMessageType: <T extends IBaseMessageBody>(messageType: number, isPersited: boolean, isCounted: boolean, isStatusMessage?: boolean) => new (content: T) => BaseMessage<T>;
 /**
  * 发送消息
  * @param options
@@ -194,15 +200,15 @@ export declare const sendHQVoiceMessage: (conversation: IConversationOption, msg
  * 发送文件消息
  */
 export declare const sendFileMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks, sendOptions?: IUploadMessageOption) => IPromiseResult<IReceivedMessage>;
+/**
+ * 发送短视频消息
+ */
+export declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks, sendOptions?: IUploadMessageOption) => IPromiseResult<IReceivedMessage>;
 /**
  * 撤回消息
  * @param options
  */
 export declare const recallMessage: (conversation: IConversationOption, options: IRecallMessageOptions) => IPromiseResult<IReceivedMessage>;
-/**
- * 获取历史消息
- */
-export declare const getHistoryMessages: (conversation: IConversationOption, options: GetHistoryMessageOption) => IPromiseResult<GetHistoryMessageResult>;
 /**
  * 获取远程历史消息
  */
@@ -216,9 +222,22 @@ export declare const deleteMessages: (conversation: IConversationOption, message
  * @param conversation 会话
  * @param timestamp 清除时间点, 该时间之前的消息将被清除
  */
-export declare const clearHistoryMessages: (conversation: IConversationOption, timestamp: number) => IPromiseResult<void>;
+export declare const clearHistoryMessages: (conversation: IConversationOption) => IPromiseResult<void>;
+export declare const parseChatRecordMsgDetails: (conversation: IConversationOption, detailItems: IChatRecordMsgDetail[]) => IReceivedMessage[];
+/**
+ * 发送已读回执
+ * @param messages 消息列表
+ * @returns
+ */
+export declare const sendReadReceipts: (messages: IReceivedMessage[]) => IPromiseResult<void>;
 export declare const mockLogin: (config: {
     langCode: string;
     phone: string;
     password: string;
 }) => CommonReqResult<import("./net/pbs/rpc.login").AuthSignIn2Resp>;
+/**
+ * 清除指定会话中阅后即焚过期的消息
+ * @param conversation 会话信息
+ * @returns 被清除的消息ID列表
+ */
+export declare const clearBurnAfterReadingExpiredMessages: (conversation: IConversationOption) => IPromiseResult<string[]>;

package/{types → dist/types}/model/baseMessage.d.ts

@@ -34,17 +34,14 @@ export interface IUserInfo {
 /**
  * 消息基本结构
  */
-export type IBaseMessageBody = IUserInfo & IExtraData & IMentionedInfo;
+export type IBaseMessageBody = Record<string, any>;
 export type MessageCodingData = Record<string, any>;
 export declare class BaseMessage<T extends IBaseMessageBody = any> {
-    readonly messageType: string;
+    messageType: number;
     content: T;
     readonly isPersited: boolean;
     readonly isCounted: boolean;
     readonly isStatusMessage: boolean;
-    constructor(messageType: string, content: T, isPersited?: boolean, isCounted?: boolean, isStatusMessage?: boolean);
-    get objectId(): number;
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<any>;
-    encode(): MessageCodingData;
+    constructor(messageType: number, content: T, isPersited?: boolean, isCounted?: boolean, isStatusMessage?: boolean);
 }
+export declare const registerMessageType: <T extends IBaseMessageBody>(messageType: number, isPersited: boolean, isCounted: boolean, isStatusMessage?: boolean) => new (content: T) => BaseMessage<T>;

package/{types → dist/types}/model/iReceivedConversation.d.ts

@@ -4,10 +4,6 @@ import IReceivedMessage from './iReceivedMessage';
  * 从服务器拉取到的会话数据结构
  */
 export default interface IReceivedConversation {
-    /**
-     * 会话的业务标识
-     */
-    channelId?: string;
     /**
      * 会话类型
      */
@@ -26,7 +22,7 @@ export default interface IReceivedConversation {
     /**
      * 会话中的最后一条消息
      */
-    latestMessage?: IReceivedMessage;
+    latestMessage?: IReceivedMessage | null;
     /**
      * 是否包含 @ 自己的消息，此数据仅在 `conversationType` 为 `ConversationType.GROUP` 时有效
      */
@@ -46,9 +42,29 @@ export default interface IReceivedConversation {
     /**
      * 会话中消息的最后未读时间
      */
-    lastUnreadTime: number;
+    lastUnreadTime: string;
     /**
      * @ 消息未读数
      */
     unreadMentionedCount?: number;
+    /**
+     * 会话名称
+     */
+    dialogTitle?: string | null;
+    /**
+     * 会话头像
+     */
+    smallAvatarUrl?: string | null;
+    /**
+    * 是否开启了阅后即焚
+    */
+    burnAfterReadingFlag: boolean;
+    /**
+     * 阅后即焚的时长
+     */
+    burnAfterReadingTime?: number | null;
+    /**
+     * 会话更新时间，根据这个排序
+     */
+    updateTime?: number | null;
 }

package/{types → dist/types}/model/iReceivedMessage.d.ts

@@ -1,12 +1,8 @@
-import { ConversationType, MessageDirection, SentStatus } from './statusTypes';
+import { ConversationType, MessageDirection, ReceivedStatus, SentStatus } from './statusTypes';
 /**
  * 消息数据
  */
 export default interface IReceivedMessage {
-    /**
-     * 会话的业务标识
-     */
-    channelId?: string;
     /**
      * 会话类型
      */
@@ -27,7 +23,7 @@ export default interface IReceivedMessage {
      * 消息结构名称，即消息类型
      * @example RC:TxtMsg
      */
-    messageType: string;
+    messageType: number;
     /**
      * 服务端存储的消息 Id
      */
@@ -43,12 +39,12 @@ export default interface IReceivedMessage {
     /**
      * 消息在服务器端的发送时间
      */
-    sentTime: number;
+    sentTime: string;
     /**
      * 消息接收时间，该时间通过消息的 `sentTime` 值在本地进行计算得出，不推荐使用
      * @description 当 isOffLineMessage 为 true 时，该值无效
      */
-    receivedTime: number;
+    receivedTime: string;
     /**
      * 是否存储
      * @default true
@@ -75,13 +71,21 @@ export default interface IReceivedMessage {
     /**
      * 消息接收状态
      */
-    receivedStatus: number;
+    receivedStatus: ReceivedStatus;
     /**
      * CPP 独有字段 消息本地 ID
      */
-    messageId?: number;
+    messageId?: string;
     /**
      * 消息发送状态
      */
     sentStatus: SentStatus;
+    /**
+     * 是否为阅后即焚消息
+     */
+    burnAfterReadingFlag: boolean;
+    /**
+     * 阅后即焚消息的时长
+     */
+    burnAfterReadingTime?: number;
 }

package/dist/types/model/messages/fileMessage.d.ts

@@ -0,0 +1,24 @@
+export interface IFileMessageBody {
+    /**
+     * 文件名称
+     */
+    title: string;
+    /**
+    * 文件类型
+    */
+    extension: string;
+    /**
+     * 文件尺寸，单位: Byte
+     */
+    size: number;
+    /**
+     * 远程文件资源地址
+     */
+    fileKey: string;
+    /**
+     * 文件的加密密钥
+     */
+    encryptKey?: string;
+}
+declare const FileMessage: new (content: IFileMessageBody) => import("../baseMessage").BaseMessage<IFileMessageBody>;
+export default FileMessage;

package/dist/types/model/messages/gifMessage.d.ts

@@ -0,0 +1,27 @@
+/**
+ * GIF 消息
+ */
+export interface IGIFMessageBody {
+    /**
+     * GIF 图片资源 url 地址
+     */
+    originalObjectKey: string;
+    /**
+     * 图片扩展名
+     */
+    extension: string;
+    /**
+     * 图片宽度
+     */
+    width: number;
+    /**
+     * 图片高度
+     */
+    height: number;
+    /**
+     * 图片的加密密钥
+     */
+    encryptKey?: string;
+}
+declare const GIFMessage: new (content: IGIFMessageBody) => import("../baseMessage").BaseMessage<IGIFMessageBody>;
+export default GIFMessage;

package/dist/types/model/messages/imageMessage.d.ts

@@ -0,0 +1,32 @@
+import { IUserInfo, IExtraData, IMentionedInfo } from '../baseMessage';
+/**
+ * 图片消息
+ */
+export interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
+    /**
+     * 图片的扩展名
+     */
+    extension?: string;
+    /**
+     * 缩略图远程地址
+     */
+    thumbnailObjectKey: string;
+    /**
+     * 原图远程地址
+     */
+    originalObjectKey: string;
+    /**
+     * 图片的加密密钥
+     */
+    encryptKey?: string;
+    /**
+     * 图片的宽
+     */
+    width: number;
+    /**
+     * 图片的高
+     */
+    height: number;
+}
+declare const ImageMessage: new (content: IImageMessageBody) => import("../baseMessage").BaseMessage<IImageMessageBody>;
+export default ImageMessage;

package/dist/types/model/messages/index.d.ts

@@ -0,0 +1,12 @@
+import TextMessage, { ITextMessageBody } from './textMessage';
+import ImageMessage, { IImageMessageBody } from './imageMessage';
+import GIFMessage, { IGIFMessageBody } from './gifMessage';
+import HQVoiceMessage, { IHQVoiceMessageBody } from './voiceMessage';
+import FileMessage, { IFileMessageBody } from './fileMessage';
+import VideoMessage, { IVideoMessageBody } from './videoMessage';
+import { ILocationMessageBody, LocationMessage, IChatRecordMessageBody, ChatRecordMessage, IContactMessageBody, ContactMessage, IInvitationMessageBody, InvitationMessage, IRedEnvelopeMessageBody, RedEnvelopeMessage, ITransferMessageBody, TransferMessage } from './otherMediaMessages';
+import { IBurnAfterReadingMessageBody } from './notificationMessages';
+import { PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage } from './notificationMessages';
+import RecallCommandMessage, { IRecallCommandMessageBody } from './recallCommandMessage';
+export { TextMessage, ImageMessage, GIFMessage, HQVoiceMessage, FileMessage, RecallCommandMessage, VideoMessage, LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage };
+export type { ITextMessageBody, IImageMessageBody, IGIFMessageBody, IHQVoiceMessageBody, IFileMessageBody, IRecallCommandMessageBody, IVideoMessageBody, ILocationMessageBody, IChatRecordMessageBody, IContactMessageBody, IInvitationMessageBody, IRedEnvelopeMessageBody, ITransferMessageBody, IBurnAfterReadingMessageBody };

package/dist/types/model/messages/notificationMessages.d.ts

@@ -0,0 +1,20 @@
+import { IBaseMessageBody } from "../baseMessage";
+export interface IReceiptMessageBody extends IBaseMessageBody {
+    groupId?: string;
+    destId?: string;
+    msgIdList: string[];
+}
+export interface IBurnAfterReadingMessageBody extends IBaseMessageBody {
+    burnAfterReadingTime: number;
+    params?: string[];
+    templateId: number;
+}
+declare const GroupArrivalReceiptMessage: new (content: IReceiptMessageBody) => import("../baseMessage").BaseMessage<IReceiptMessageBody>;
+declare const GroupReadReceiptMessage: new (content: IReceiptMessageBody) => import("../baseMessage").BaseMessage<IReceiptMessageBody>;
+declare const PrivateArrivalReceiptMessage: new (content: IReceiptMessageBody) => import("../baseMessage").BaseMessage<IReceiptMessageBody>;
+declare const PrivateReadReceiptMessage: new (content: IReceiptMessageBody) => import("../baseMessage").BaseMessage<IReceiptMessageBody>;
+declare const PrivateOpenBurnAfterReadingMessage: new (content: IBurnAfterReadingMessageBody) => import("../baseMessage").BaseMessage<IBurnAfterReadingMessageBody>;
+declare const PrivateCloseBurnAfterReadingMessage: new (content: IBurnAfterReadingMessageBody) => import("../baseMessage").BaseMessage<IBurnAfterReadingMessageBody>;
+declare const GroupOpenBurnAfterReadingMessage: new (content: IBurnAfterReadingMessageBody) => import("../baseMessage").BaseMessage<IBurnAfterReadingMessageBody>;
+declare const GroupCloseBurnAfterReadingMessage: new (content: IBurnAfterReadingMessageBody) => import("../baseMessage").BaseMessage<IBurnAfterReadingMessageBody>;
+export { GroupArrivalReceiptMessage, GroupReadReceiptMessage, PrivateArrivalReceiptMessage, PrivateReadReceiptMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage };

package/dist/types/model/messages/otherMediaMessages.d.ts

@@ -0,0 +1,99 @@
+export interface ILocationMessageBody {
+    thumbnailObjectKey: string;
+    title: string;
+    desc: string;
+    locationType: number;
+    encryptKey?: string;
+    lat: number;
+    lon: number;
+}
+export interface IChatRecordMessageBody {
+    chatTitle: string;
+    msgDataFileKey: string;
+    msgList: Array<{
+        srcId: string;
+        senderNickname: string;
+        mediaConstructor: number;
+        msgPostContent: string;
+    }>;
+    encryptKey?: string;
+}
+export interface IChatRecordMsgDetail {
+    senderNickname: string;
+    senderAvatar?: string;
+    msgId: string;
+    srcId: string;
+    destId: string;
+    msgPreContent?: string;
+    msgPostContent?: string;
+    mediaConstructor: number;
+    mediaAttribute?: string;
+    msgSendTime: string;
+}
+export interface IContactMessageBody {
+    uid: string;
+    nickname: string;
+    phoneNumber: string;
+    langcode: string;
+    smallAvatarUrl?: string;
+    gender: number;
+}
+export interface IInvitationMessageBody {
+    groupUin: string;
+    groupTitle: string;
+    inviteFromUin: string;
+    inviteFromNickName: string;
+    totalMemberCount: number;
+    createTime: number;
+    smallAvatarUrl?: string;
+    groupMemberSmallAvatarUrlArr?: string[];
+}
+export interface IRedEnvelopeMessageBody {
+    id: number;
+    createTime: string;
+    updateTime: string;
+    amount: string;
+    count: number;
+    uid: string;
+    nativeNumber: string;
+    nativeType: number;
+    sendSign: string;
+    title: string;
+    symbol: string;
+    receivedStatus: number;
+    status: number;
+    expireTime: number;
+    currency: string;
+    currencyLogo: string;
+    refundAmount: string;
+    receivedAmount?: string;
+}
+export interface ITransferMessageBody {
+    id: number;
+    createTime: string;
+    updateTime: string;
+    uid: string;
+    orderId: string;
+    src: string;
+    symbol: string;
+    type: number;
+    toUid: string;
+    nativeType: number;
+    money: number;
+    refName: string;
+    transNo: string;
+    status: number;
+    pushStatus: number;
+    currency: string;
+    currencyLogo: string;
+    network: string;
+    networkLogo: string;
+    refId: string;
+}
+declare let LocationMessage: new (content: ILocationMessageBody) => import("../baseMessage").BaseMessage<ILocationMessageBody>;
+declare let ChatRecordMessage: new (content: IChatRecordMessageBody) => import("../baseMessage").BaseMessage<IChatRecordMessageBody>;
+declare let ContactMessage: new (content: IContactMessageBody) => import("../baseMessage").BaseMessage<IContactMessageBody>;
+declare let InvitationMessage: new (content: IInvitationMessageBody) => import("../baseMessage").BaseMessage<IInvitationMessageBody>;
+declare let RedEnvelopeMessage: new (content: IRedEnvelopeMessageBody) => import("../baseMessage").BaseMessage<IRedEnvelopeMessageBody>;
+declare let TransferMessage: new (content: ITransferMessageBody) => import("../baseMessage").BaseMessage<ITransferMessageBody>;
+export { LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage };

package/dist/types/model/messages/recallCommandMessage.d.ts

@@ -0,0 +1,9 @@
+import { IBaseMessageBody } from "../baseMessage";
+/**
+ *  撤回通知消息（被撤回消息摘要）
+ */
+export interface IRecallCommandMessageBody extends IBaseMessageBody {
+    messageUId: string;
+}
+declare const RecallCommandMessage: new (content: IRecallCommandMessageBody) => import("../baseMessage").BaseMessage<IRecallCommandMessageBody>;
+export default RecallCommandMessage;

package/dist/types/model/messages/textMessage.d.ts

@@ -0,0 +1,12 @@
+import { IMentionedInfo } from '../baseMessage';
+/**
+ * 文本消息
+ */
+export interface ITextMessageBody extends IMentionedInfo {
+    /**
+     * 文本消息内容
+     */
+    content: string;
+}
+declare const TextMessage: new (content: ITextMessageBody) => import("../baseMessage").BaseMessage<ITextMessageBody>;
+export default TextMessage;

package/dist/types/model/messages/videoMessage.d.ts

@@ -0,0 +1,30 @@
+import { IMentionedInfo } from '../baseMessage';
+export interface IVideoMessageBody extends IMentionedInfo {
+    /**
+     * 远程媒体资源地址
+     */
+    videoObjectKey: string;
+    /**
+     * 缩略图的远程媒体资源地址
+     */
+    thumbnailObjectKey: string;
+    /**
+     * 编解码类型，默认为 mp4
+     */
+    extension?: string;
+    encryptKey?: string;
+    /**
+     * 视频宽度
+     */
+    width: number;
+    /**
+     * 视频高度
+     */
+    height: number;
+    /**
+     * 视频时长描述
+     */
+    during: string;
+}
+declare const VideoMessage: new (content: IVideoMessageBody) => import("../baseMessage").BaseMessage<IVideoMessageBody>;
+export default VideoMessage;

package/dist/types/model/messages/voiceMessage.d.ts

@@ -0,0 +1,18 @@
+import { IMentionedInfo } from '../baseMessage';
+export interface IHQVoiceMessageBody extends IMentionedInfo {
+    /**
+     * 远程媒体资源地址
+     */
+    audioObjectKey: string;
+    /**
+     * 语音消息的时长，最大值为 60 （单位：秒）
+     */
+    length: number;
+    /**
+     * 编解码类型，默认为 m4a 音频
+     */
+    extension?: string;
+    encryptKey?: string;
+}
+declare const VoiceMessage: new (content: IHQVoiceMessageBody) => import("../baseMessage").BaseMessage<IHQVoiceMessageBody>;
+export default VoiceMessage;

package/{types → dist/types}/model/statusTypes.d.ts

@@ -281,11 +281,7 @@ export declare enum ConversationType {
     /**
      * 群组聊天
      */
-    GROUP = 3,
-    /**
-     * 超级群
-     */
-    ULTRA_GROUP = 10
+    GROUP = 3
 }
 /**
  * 群组 @ 类型
@@ -363,25 +359,21 @@ export declare enum SentStatus {
 }
 export declare enum ReceivedStatus {
     /**
-     * 已读
-     */
-    READ = 1,
-    /**
-     * 已听
+     * 初始状态
      */
-    LISTENED = 2,
+    IDLE = 0,
     /**
-     * 已下载
+     * 已接收
      */
-    DOWNLOADED = 4,
+    RECEIVED = 1,
     /**
-     * 该消息已经被其他登录的多端收取过。( 即该消息已经被其他端收取过后。当前端才登录，并重新拉取了这条消息。客户可以通过这个状态更新 UI，比如不再提示 )
+     * 已读
      */
-    RETRIEVED = 8,
+    READ = 2,
     /**
-     * 未读
+     * 已听
      */
-    UNREAD = 0
+    LISTENED = 3
 }
 /**
  * 免打扰等级