@onyx-p/imlib-web 1.2.4 → 1.2.7

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import { ConnectionStatus, ConversationType, NotificationLevel, NotificationStatus } from './model/statusTypes';
-import { EventListeners, Events, GetHistoryMessageOption, GetHistoryMessageResult, IBaseConversationInfo, IConversationOption, IConversationState, IDeleteMessageOptions, IGetConversationListOptions, IImageMessageOption, IInitOption, IPromiseResult, IRecallMessageOptions, ISendBody, ISendMessageOptions, IUploadHooks, IUploadMessageOption, ProfileInfo } from './types';
+import { EventListeners, Events, GetHistoryMessageOption, GetHistoryMessageResult, IAsyncRes, IBaseConversationInfo, IConversationOption, IConversationState, IDeleteMessageOptions, IGetConversationListOptions, IImageMessageOption, IInitOption, IPromiseResult, IRecallMessageOptions, ISendBody, ISenderEnrichedMessage, ISendMessageOptions, IUploadHooks, IUploadMessageOption, ProfileInfo, IInsertOptions } from './types';
 import { BaseMessage, IBaseMessageBody } from './model/baseMessage';
 import { ITextMessageBody } from './model/messages/textMessage';
 import IReceivedMessage from './model/iReceivedMessage';
@@ -7,8 +7,8 @@ import IReceivedConversation from './model/iReceivedConversation';
 import { CommonReqResult, PBCodec } from './net/connection/webSocketServer';
 import { BaseResp } from './net/pbs/rpc.base';
 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 { TextMessage, ImageMessage, HQVoiceMessage, GIFMessage, FileMessage, VideoMessage, RecallCommandMessage, LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage, LinkMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage } from './model/messages';
+export type { ITextMessageBody, IImageMessageBody, IGIFMessageBody, IFileMessageBody, IHQVoiceMessageBody, IRecallCommandMessageBody, IVideoMessageBody, ILocationMessageBody, IChatRecordMessageBody, IContactMessageBody, IInvitationMessageBody, IRedEnvelopeMessageBody, ITransferMessageBody, IBurnAfterReadingMessageBody, ILinkMessageBody } from './model/messages';
 export { MessageTypes, NotiMessageTypes } from './constants/messageTypes';
 export type { IBaseMessageBody, IReceivedMessage, IReceivedConversation };
 export * from './types';
@@ -175,6 +175,7 @@ export declare const getTopConversationList: () => IPromiseResult<IBaseConversat
  * @param isStatusMessage  是否是状态消息
  */
 export declare const registerMessageType: <T extends IBaseMessageBody>(messageType: number, isPersited: boolean, isCounted: boolean, isStatusMessage?: boolean) => new (content: T) => BaseMessage<T>;
+export declare const insertMessage: (conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions) => Promise<IAsyncRes<IReceivedMessage>>;
 /**
  * 发送消息
  * @param options
@@ -223,7 +224,19 @@ export declare const deleteMessages: (conversation: IConversationOption, message
  * @param timestamp 清除时间点, 该时间之前的消息将被清除
  */
 export declare const clearHistoryMessages: (conversation: IConversationOption) => IPromiseResult<void>;
+/**
+ * 解析聊天记录消息详情
+ * @param conversation 会话
+ * @param detailItems 消息详情
+ * @returns 消息列表
+ */
 export declare const parseChatRecordMsgDetails: (conversation: IConversationOption, detailItems: IChatRecordMsgDetail[]) => IReceivedMessage[];
+/**
+ * 将消息编码为聊天记录消息详情
+ * @param message 消息
+ * @returns 消息详情
+ */
+export declare const encodeReceivedMessage2ChatRecordMsgDetail: (message: ISenderEnrichedMessage) => IChatRecordMsgDetail | null;
 /**
  * 发送已读回执
  * @param messages 消息列表
@@ -235,9 +248,36 @@ export declare const mockLogin: (config: {
     phone: string;
     password: string;
 }) => CommonReqResult<import("./net/pbs/rpc.login").AuthSignIn2Resp>;
+export declare const mockGetLoginCode: (config: {
+    langCode: string;
+    phone: string;
+}) => CommonReqResult<import("./net/pbs/rpc.login").WebGetLoginCodeResp>;
+export declare const mockVerifyLoginCode: (config: {
+    country: string;
+    phone: string;
+    code: string;
+}) => CommonReqResult<import("./net/pbs/rpc.login").ClickOKToWebResp>;
 /**
  * 清除指定会话中阅后即焚过期的消息
  * @param conversation 会话信息
  * @returns 被清除的消息ID列表
  */
 export declare const clearBurnAfterReadingExpiredMessages: (conversation: IConversationOption) => IPromiseResult<string[]>;
+/**
+ * 发送引用回复消息
+ * @param message 消息
+ * @param quoteReply 引用回复消息
+ * @param options 发送选项
+ * @returns 发送结果
+ */
+export declare const sendQuoteReplyMessage: (message: BaseMessage, quoteReply: IReceivedMessage, options?: ISendMessageOptions) => IPromiseResult<IReceivedMessage>;
+/**
+ * 获取消息
+ * @param messageId 消息ID
+ * @returns 消息
+ */
+export declare const getMessageById: (messageId: number) => IPromiseResult<IReceivedMessage | null | undefined>;
+/**
+ * 获取消息
+ */
+export declare const getMessageByUId: (messageUId: string) => IPromiseResult<IReceivedMessage | null | undefined>;

package/dist/types/model/iQuotedReplyMessage.d.ts

@@ -0,0 +1,7 @@
+import IReceivedMessage from "./iReceivedMessage";
+export default interface IQuotedReplyMessage extends IReceivedMessage {
+    /**
+     * 消息发送者的用户名
+     */
+    senderUserName?: string | null;
+}

package/dist/types/model/iReceivedMessage.d.ts

@@ -1,4 +1,5 @@
 import { ConversationType, MessageDirection, ReceivedStatus, SentStatus } from './statusTypes';
+import IQuotedReplyMessage from './iQuotedReplyMessage';
 /**
  * 消息数据
  */
@@ -75,7 +76,7 @@ export default interface IReceivedMessage {
     /**
      * CPP 独有字段 消息本地 ID
      */
-    messageId?: string;
+    messageId: number;
     /**
      * 消息发送状态
      */
@@ -88,4 +89,8 @@ export default interface IReceivedMessage {
      * 阅后即焚消息的时长
      */
     burnAfterReadingTime?: number;
+    /**
+     * 引用消息
+     */
+    quotedReply?: IQuotedReplyMessage;
 }

package/dist/types/model/mentionedInfo.d.ts

@@ -1,9 +1,9 @@
-import { MentionedType } from './statusTypes';
 /**
  * 群组内的消息包含的 @ 数据
  */
 export default interface MentionedInfo {
-    type?: MentionedType | undefined;
-    userIdList?: string[] | undefined;
-    mentionedContent?: string | undefined;
+    userList?: {
+        uin: string;
+        nickname: string;
+    }[] | undefined;
 }

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

@@ -4,9 +4,9 @@ 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 { ILocationMessageBody, LocationMessage, IChatRecordMessageBody, ChatRecordMessage, IContactMessageBody, ContactMessage, IInvitationMessageBody, InvitationMessage, IRedEnvelopeMessageBody, RedEnvelopeMessage, ITransferMessageBody, TransferMessage, ILinkMessageBody, LinkMessage } 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 };
+export { TextMessage, ImageMessage, GIFMessage, HQVoiceMessage, FileMessage, RecallCommandMessage, VideoMessage, LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage, LinkMessage };
+export type { ITextMessageBody, IImageMessageBody, IGIFMessageBody, IHQVoiceMessageBody, IFileMessageBody, IRecallCommandMessageBody, IVideoMessageBody, ILocationMessageBody, IChatRecordMessageBody, IContactMessageBody, IInvitationMessageBody, IRedEnvelopeMessageBody, ITransferMessageBody, IBurnAfterReadingMessageBody, ILinkMessageBody };

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

@@ -90,10 +90,16 @@ export interface ITransferMessageBody {
     networkLogo: string;
     refId: string;
 }
+export interface ILinkMessageBody {
+    url: string;
+    title?: string;
+    content?: 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 };
+declare let LinkMessage: new (content: ILinkMessageBody) => import("../baseMessage").BaseMessage<ILinkMessageBody>;
+export { LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage, LinkMessage };

package/dist/types/types.d.ts

@@ -137,7 +137,7 @@ export interface ISendMessageOptions {
     /**
      * 消息发送之前的回调
      */
-    onSendBefore?: (message: IReceivedMessage) => void;
+    onSendBefore?: (message: IReceivedMessage, uploadOptions?: IUploadMessageParams) => void;
     /**
      * 重发消息时用到，重发消息的 messageId。
      * 当要重发消息时所有参数需与原始消息参数一致，messageId 必须存在。
@@ -166,11 +166,19 @@ export interface IUploadHooks {
     /**
      * 文件上传完成回调，可通过修改返回值以修改待发布的消息内容，如实现自定义消息
      */
-    onComplete?: (fileInfo: IUploadCompletedResult) => void | BaseMessage;
+    onComplete?: (result: IUploadCompletedResult) => void | BaseMessage;
 }
+export interface IUploadMessageParams {
+    items: {
+        url: string;
+        file: Blob;
+    }[];
+    encryptKey: string;
+}
+export type IUploadPrepareResult = IUploadMessageParams;
 export type IUploadCompletedResult = {
     urls: string[];
-    encryptedKey?: string;
+    encryptedKey: string;
 };
 export type IUploadCallback = {
     onProgress?: (progress: number) => void;
@@ -178,13 +186,15 @@ export type IUploadCallback = {
     onError?: (reason: string) => void;
 };
 export interface IUploader {
-    upload(files: Blob[], callback: IUploadCallback): void;
+    upload(params: IUploadMessageParams, callback: IUploadCallback): void;
     cancel(): void;
+    prepare(files: Blob[]): Promise<IUploadPrepareResult>;
 }
 /**
  * 文件消息配置
  */
 export interface IUploadMessageOption extends ISendMessageOptions {
+    full?: boolean;
 }
 /**
  * 图片消息配置
@@ -192,6 +202,12 @@ export interface IUploadMessageOption extends ISendMessageOptions {
 export interface IImageMessageOption extends IUploadMessageOption {
     thumbnailConfig?: IThumbnailConfig;
 }
+export interface IInsertOptions {
+    /**
+     * 插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
+     */
+    isUnread?: boolean;
+}
 /**
  * 缩略图配置
  */
@@ -295,3 +311,7 @@ export interface IAsyncRes<T = any> {
  * 通过 `Promise.resolve` 来处理预期内的异常，进而通过 Uncatch Promise Error 暴露预期外的异常
  */
 export type IPromiseResult<T> = Promise<IAsyncRes<T>>;
+export interface ISenderEnrichedMessage extends IReceivedMessage {
+    senderNickname: string;
+    senderAvatar?: string | null | undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onyx-p/imlib-web",
-  "version": "1.2.4",
+  "version": "1.2.7",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.esm.js",
   "types": "./dist/types/index.d.ts",