@onyx-p/imlib-web 3.0.2 → 3.0.4

package/package.json

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

package/types/constants/messageTypes.d.ts

@@ -26,4 +26,6 @@ export declare const NotiMessageTypes: {
     MESSAGE_READ: number;
     CHANGE_GROUP_TITLE: number;
     CHANGE_GROUP_AVATAR: number;
+    PRIVATE_MESSAGE_PINNED: number;
+    GROUP_MESSAGE_PINNED: number;
 };

package/types/database/contracts.d.ts

@@ -1,7 +1,7 @@
 export declare const DATABASE_GLOBAL: "acimDatabase";
 export declare const DATABASE_CHANNEL: "acim-database:request";
-export declare const READ_METHOD_NAMES: readonly ["getMessages", "getLatestMessage", "getLatestMessages", "getDialogLoadedState", "getMessageById", "getMessageByUId", "getMessageIdRange", "searchMessages", "searchTextMessages", "getLegacyMigrationState"];
-export declare const WRITE_METHOD_NAMES: readonly ["addMessages", "clearConversationCache", "clearAllCache", "removeMessagesByUId", "updateMessageReceiptStatus", "clearBurnAfterReadingExpiredMessages", "upsertMessage", "convertToRecallMessages", "importLegacyBatch", "completeLegacyMigration"];
+export declare const READ_METHOD_NAMES: readonly ["getMessages", "getLatestMessage", "getLatestMessages", "getDialogLoadedState", "getMessageById", "getMessageByUId", "getMessageIdRange", "getMessagesByType", "getPinnedMessages", "searchMessages", "searchTextMessages", "getLegacyMigrationState"];
+export declare const WRITE_METHOD_NAMES: readonly ["addMessages", "clearConversationCache", "clearAllCache", "removeMessagesByUId", "updateMessageReceiptStatus", "setMessagePinned", "unpinAllMessages", "clearBurnAfterReadingExpiredMessages", "upsertMessage", "convertToRecallMessages", "importLegacyBatch", "completeLegacyMigration"];
 export type DatabaseReadMethod = (typeof READ_METHOD_NAMES)[number];
 export type DatabaseWriteMethod = (typeof WRITE_METHOD_NAMES)[number];
 export type DatabaseMethod = DatabaseReadMethod | DatabaseWriteMethod;

package/types/database/main/messageStore.d.ts

@@ -33,10 +33,15 @@ export declare class MessageStore {
         messages: StoredMessage[];
         hasMore: boolean;
     };
+    getMessagesByType(dialogId: string, messageTypes: ReadonlyArray<number>, timestamp?: string, count?: number, isForward?: boolean): {
+        messages: StoredMessage[];
+        hasMore: boolean;
+    };
     getLatestMessage(dialogId: string): StoredMessage | null;
     getLatestMessages(dialogIds: ReadonlyArray<string>): Record<string, StoredMessage | null>;
     getMessageById(messageId: number): StoredMessage | null;
     getMessageByUId(messageUId: string): StoredMessage | null;
+    getPinnedMessages(dialogId: string, count?: number): StoredMessage[];
     getMessageIdRange(): {
         newest: number;
         oldest: number;
@@ -46,6 +51,8 @@ export declare class MessageStore {
     clearAllCache(): void;
     removeMessagesByUId(messageUIds: ReadonlyArray<string>): void;
     updateMessageReceiptStatus(messageUIds: ReadonlyArray<string>, receivedStatus: number): void;
+    setMessagePinned(dialogId: string, messageUId: string, pinned: boolean): void;
+    unpinAllMessages(dialogId: string): void;
     clearBurnAfterReadingExpiredMessages(dialogId: string, now?: number): string[];
     convertToRecallMessages(messageUIds: ReadonlyArray<string>, recallMessageType: number): void;
     searchTextMessages(dialogId: string, keyword: string): StoredMessage[];

package/types/database/renderer/messageRepository.d.ts

@@ -20,10 +20,15 @@ export declare class SqlMessageRepository {
         messages: IReceivedMessage[];
         hasMore: boolean;
     }>;
+    getMessagesByType(conversation: IConversationOption, messageTypes: ReadonlyArray<number>, timestamp?: string, count?: number, isForward?: boolean): Promise<{
+        messages: IReceivedMessage[];
+        hasMore: boolean;
+    }>;
     getLatestMessage(conversation: IConversationOption): Promise<IReceivedMessage | null>;
     getLatestMessages(conversations: ReadonlyArray<IConversationOption>): Promise<Record<string, IReceivedMessage | null>>;
     getMessageById(messageId: number): Promise<IReceivedMessage | null>;
     getMessageByUId(messageUId: string): Promise<IReceivedMessage | null>;
+    getPinnedMessages(conversation: IConversationOption, count?: number): Promise<IReceivedMessage[]>;
     getMessageIdRange(): Promise<{
         newest: number;
         oldest: number;
@@ -33,6 +38,8 @@ export declare class SqlMessageRepository {
     clearAllCache(): Promise<void>;
     removeMessagesByUId(messageUIds: string[]): Promise<void>;
     updateMessageReceiptStatus(event: IReceiptReceivedEvent, type: 0 | 1): Promise<void>;
+    setMessagePinned(conversation: IConversationOption, messageUId: string, pinned: boolean): Promise<void>;
+    unpinAllMessages(conversation: IConversationOption): Promise<void>;
     clearBurnAfterReadingExpiredMessages(conversation: IConversationOption): Promise<string[]>;
     upsertMessage(message: IReceivedMessage): Promise<void>;
     convertToRecallMessages(messageUIds: string[]): Promise<void>;

package/types/index.d.ts

@@ -8,8 +8,8 @@ import { CommonReqResult, PBCodec } from './net/connection/webSocketServer';
 import { BaseResp } from './net/pbs/rpc.base';
 import { IChatRecordMsgDetail } from './model/messages/otherMediaMessages';
 import type { LegacyMigrationProgress, LegacyMigrationResult } from './database/renderer/legacyIndexedDbMigration';
-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 { TextMessage, ImageMessage, HQVoiceMessage, GIFMessage, FileMessage, VideoMessage, RecallCommandMessage, LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage, LinkMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage, PrivateMessagePinnedNotification, GroupMessagePinnedNotification } from './model/messages';
+export type { ITextMessageBody, ITextMessageEntity, ITextMessageLinkPreview, ITextMessageStyleAttribute, TextMessageEntityType, IImageMessageBody, IGIFMessageBody, IFileMessageBody, IHQVoiceMessageBody, IRecallCommandMessageBody, IVideoMessageBody, ILocationMessageBody, IChatRecordMessageBody, IContactMessageBody, IInvitationMessageBody, IRedEnvelopeMessageBody, ITransferMessageBody, IBurnAfterReadingMessageBody, IMessagePinnedNotificationBody, ILinkMessageBody } from './model/messages';
 export { MessageTypes, NotiMessageTypes } from './constants/messageTypes';
 export type { IBaseMessageBody, IReceivedMessage, IReceivedConversation };
 export * from './types';
@@ -224,6 +224,18 @@ export declare const getRemoteHistoryMessages: (conversation: IConversationOptio
  * 从本地数据库中获取消息
  */
 export declare const getHistoryMessages: (conversation: IConversationOption, options: GetHistoryMessageOption) => IPromiseResult<GetHistoryMessageResult>;
+/**
+ * 设置或取消置顶一条消息。状态将在服务端置顶通知到达后更新。
+ */
+export declare const setMessagePinned: (conversation: IConversationOption, messageUId: string, pinned: boolean) => IPromiseResult<void>;
+/**
+ * 取消当前会话的全部置顶消息。
+ */
+export declare const unpinAllMessages: (conversation: IConversationOption) => IPromiseResult<void>;
+/**
+ * 获取当前会话的本地置顶消息。
+ */
+export declare const getPinnedMessages: (conversation: IConversationOption, count?: number) => IPromiseResult<IReceivedMessage[]>;
 /**
  * 按消息 id 删除消息
  */
@@ -291,6 +303,12 @@ export declare const getMessageById: (messageId: number) => IPromiseResult<IRece
  * 获取消息
  */
 export declare const getMessageByUId: (messageUId: string) => IPromiseResult<IReceivedMessage | null | undefined>;
+/**
+ * 按消息类型查询当前会话的本地缓存消息。
+ * 只读 IMLib 本地库，不向服务端补历史。
+ * timestamp / order 语义与 getHistoryMessages 一致；count 默认 50。
+ */
+export declare const getMessagesByType: (conversation: IConversationOption, messageTypes: number | ReadonlyArray<number>, options?: GetHistoryMessageOption) => IPromiseResult<GetHistoryMessageResult>;
 export declare const searchTextMessages: (conversation: IConversationOption, keyword: string) => IPromiseResult<IReceivedMessage[]>;
 /**
  * 全局搜索本地消息，按发送时间倒序返回。

package/types/model/iReceivedMessage.d.ts

@@ -85,6 +85,11 @@ export default interface IReceivedMessage {
      * 是否为阅后即焚消息
      */
     burnAfterReadingFlag: boolean;
+    /**
+     * 消息是否已置顶
+     * @default false
+     */
+    pinned: boolean;
     /**
      * 阅后即焚消息的时长
      */

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

@@ -1,12 +1,12 @@
-import TextMessage, { ITextMessageBody } from './textMessage';
+import TextMessage, { ITextMessageBody, ITextMessageEntity, ITextMessageLinkPreview, ITextMessageStyleAttribute, TextMessageEntityType } 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, ILinkMessageBody, LinkMessage } from './otherMediaMessages';
-import { IBurnAfterReadingMessageBody } from './notificationMessages';
-import { PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage } from './notificationMessages';
+import { IBurnAfterReadingMessageBody, IMessagePinnedNotificationBody } from './notificationMessages';
+import { PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage, PrivateMessagePinnedNotification, GroupMessagePinnedNotification } 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, LinkMessage };
-export type { ITextMessageBody, IImageMessageBody, IGIFMessageBody, IHQVoiceMessageBody, IFileMessageBody, IRecallCommandMessageBody, IVideoMessageBody, ILocationMessageBody, IChatRecordMessageBody, IContactMessageBody, IInvitationMessageBody, IRedEnvelopeMessageBody, ITransferMessageBody, IBurnAfterReadingMessageBody, ILinkMessageBody };
+export { TextMessage, ImageMessage, GIFMessage, HQVoiceMessage, FileMessage, RecallCommandMessage, VideoMessage, LocationMessage, ChatRecordMessage, ContactMessage, InvitationMessage, RedEnvelopeMessage, TransferMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage, PrivateMessagePinnedNotification, GroupMessagePinnedNotification, LinkMessage };
+export type { ITextMessageBody, ITextMessageEntity, ITextMessageLinkPreview, ITextMessageStyleAttribute, TextMessageEntityType, IImageMessageBody, IGIFMessageBody, IHQVoiceMessageBody, IFileMessageBody, IRecallCommandMessageBody, IVideoMessageBody, ILocationMessageBody, IChatRecordMessageBody, IContactMessageBody, IInvitationMessageBody, IRedEnvelopeMessageBody, ITransferMessageBody, IBurnAfterReadingMessageBody, IMessagePinnedNotificationBody, ILinkMessageBody };

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

@@ -21,6 +21,14 @@ export interface IChangeGroupAvatarMessageBody extends IBaseMessageBody {
     smallAvatarUrl: string;
     groupId: string;
 }
+export interface IMessagePinnedNotificationBody extends IBaseMessageBody {
+    operatorUserId?: string;
+    operatorNickeName?: string;
+    params?: string[];
+    templateId?: number;
+    msgId: string;
+    pinned: 0 | 1 | 2;
+}
 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>;
@@ -32,4 +40,6 @@ declare const GroupCloseBurnAfterReadingMessage: new (content: IBurnAfterReading
 declare const MessageReadMessage: new (content: IMessageReadMessageBody) => import("../baseMessage").BaseMessage<IMessageReadMessageBody>;
 declare const ChangeGroupTitleMessage: new (content: IChangeGroupTitleMessageBody) => import("../baseMessage").BaseMessage<IChangeGroupTitleMessageBody>;
 declare const ChangeGroupAvatarMessage: new (content: IChangeGroupAvatarMessageBody) => import("../baseMessage").BaseMessage<IChangeGroupAvatarMessageBody>;
-export { GroupArrivalReceiptMessage, GroupReadReceiptMessage, PrivateArrivalReceiptMessage, PrivateReadReceiptMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage, MessageReadMessage, ChangeGroupTitleMessage, ChangeGroupAvatarMessage };
+declare const PrivateMessagePinnedNotification: new (content: IMessagePinnedNotificationBody) => import("../baseMessage").BaseMessage<IMessagePinnedNotificationBody>;
+declare const GroupMessagePinnedNotification: new (content: IMessagePinnedNotificationBody) => import("../baseMessage").BaseMessage<IMessagePinnedNotificationBody>;
+export { GroupArrivalReceiptMessage, GroupReadReceiptMessage, PrivateArrivalReceiptMessage, PrivateReadReceiptMessage, PrivateOpenBurnAfterReadingMessage, PrivateCloseBurnAfterReadingMessage, GroupOpenBurnAfterReadingMessage, GroupCloseBurnAfterReadingMessage, MessageReadMessage, ChangeGroupTitleMessage, ChangeGroupAvatarMessage, PrivateMessagePinnedNotification, GroupMessagePinnedNotification };

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

@@ -1,12 +1,44 @@
-import { IMentionedInfo } from '../baseMessage';
+import { IExtraData, IMentionedInfo, IUserInfo } from '../baseMessage';
+export type TextMessageEntityType = 'bold' | 'italic' | 'code' | 'pre' | 'strikethrough' | 'strike' | 'underline' | 'spoiler' | 'blockquote' | 'url' | 'text_url' | 'textUrl' | 'email' | 'mention' | 'mention_name' | 'mentionName' | 'hashtag' | 'bot_command' | 'botCommand' | 'phone_number' | 'phoneNumber' | 'custom_emoji' | 'customEmoji' | 'bank_card' | 'bankCard' | (string & {});
+export interface ITextMessageEntity {
+    type: TextMessageEntityType;
+    offset: number;
+    length: number;
+    language?: string;
+    url?: string;
+    userId?: string | number;
+}
+export interface ITextMessageStyleAttribute {
+    type: number;
+    location: number;
+    length: number;
+}
+export interface ITextMessageLinkPreview {
+    url: string;
+    domain?: string;
+    title?: string;
+    previewDescription?: string;
+    width?: number;
+    height?: number;
+    encryptKey?: string;
+    originalObjectKey?: string;
+    youtubeVideoId?: string;
+    oldOriginalObjectKey?: string;
+}
 /**
  * 文本消息
  */
-export interface ITextMessageBody extends IMentionedInfo {
+export interface ITextMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
     /**
      * 文本消息内容
      */
     content: string;
+    /** 服务端下发或发送的富文本实体。 */
+    entities?: ITextMessageEntity[];
+    /** 兼容旧版客户端的文本样式字段。 */
+    attributes?: ITextMessageStyleAttribute[];
+    linkPreview?: ITextMessageLinkPreview;
+    linkPreviewFailed?: boolean;
 }
 declare const TextMessage: new (content: ITextMessageBody) => import("../baseMessage").BaseMessage<ITextMessageBody>;
 export default TextMessage;

package/types/types.d.ts

@@ -41,7 +41,18 @@ export declare enum Events {
     PUSH = "PUSH",
     RECALL = "RECALL",
     ARRIVAL_RECEIPT_RECEIVED = "ARRIVAL_RECEIPT_RECEIVED",
-    READ_RECEIPT_RECEIVED = "READ_RECEIPT_RECEIVED"
+    READ_RECEIPT_RECEIVED = "READ_RECEIPT_RECEIVED",
+    MESSAGE_PINNED_CHANGED = "MESSAGE_PINNED_CHANGED"
+}
+export declare enum MessagePinnedOperation {
+    PIN = 0,
+    UNPIN = 1,
+    UNPIN_ALL = 2
+}
+export interface IMessagePinnedChangedEvent {
+    conversation: IConversationOption;
+    messageUId?: string;
+    operation: MessagePinnedOperation;
 }
 /**
  * 收到已读/已发送回执数据结构
@@ -76,6 +87,7 @@ export type EventListeners = {
     [Events.RECALL]: (messageUId: string) => void;
     [Events.ARRIVAL_RECEIPT_RECEIVED]: (event: IReceiptReceivedEvent) => void;
     [Events.READ_RECEIPT_RECEIVED]: (event: IReceiptReceivedEvent) => void;
+    [Events.MESSAGE_PINNED_CHANGED]: (event: IMessagePinnedChangedEvent) => void;
 };
 export interface IBaseConversationInfo {
     conversationType: ConversationType;