@rongcloud/im-kit 5.40.0-alpha.1 → 5.42.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { IQuoteInfo, IPushConfig, IConversationOption, RCConnectionStatus, ErrorCode, LogL, PluginContext, ILogger, IPluginGenerator } from '@rongcloud/engine';
+import { IPushConfig, IConversationOption, RCConnectionStatus, ErrorCode, LogL, PluginContext, ILogger, IPluginGenerator } from '@rongcloud/engine';
 export { IPushConfig } from '@rongcloud/engine';
-import { IAReceivedMessage, ReadReceiptInfoV5, ConversationType, NotificationLevel, BaseMessage, ISendMessageOptions } from '@rongcloud/imlib-next';
+import { IMessageReaction, IAReceivedMessage, ReadReceiptInfoV5, IQuoteInfo, ConversationType, NotificationLevel, BaseMessage, ISendMessageOptions } from '@rongcloud/imlib-next';
 
 /**
  * 功能开关定义
@@ -52,8 +52,23 @@ declare enum RCKitCommand {
      * 使用 V2 版本引用消息
      * * true - 开启
      * * false - 关闭（Default）
+     * @since 5.38.0
      */
-    USE_QUOTE_MESSAGE_V2 = "USE_QUOTE_MESSAGE_V2"
+    USE_QUOTE_MESSAGE_V2 = "USE_QUOTE_MESSAGE_V2",
+    /**
+     * 消息回应功能开关
+     * * false - 关闭（Default）
+     * * true - 开启
+     * @since 5.42.0
+     */
+    MESSAGE_REACTION_ENABLED = "MESSAGE_REACTION_ENABLED",
+    /**
+     * 消息气泡中显示详细的回应用户名称，需配合 `MESSAGE_REACTION_ENABLED` 开启消息回应功能才能生效
+     * * false - 关闭（Default），默认仅显示回应用户数量
+     * * true - 开启，显示回应用户名称列表
+     * @since 5.42.0
+     */
+    SHOW_MESSAGE_REACT_USERS = "SHOW_MESSAGE_REACT_USERS"
 }
 
 declare class EventDispatcher<T> {
@@ -70,7 +85,7 @@ declare class EventDispatcher<T> {
      * @param event - 事件对象
      * @param defer - 异步执行事件监听器，默认为 `true`。
      */
-    dispatchEvent<K extends keyof T>(event: T[K], defer?: boolean): void;
+    dispatch<K extends keyof T>(event: T[K], defer?: boolean): void;
     private _handleDispatchEvent;
 }
 
@@ -97,6 +112,15 @@ interface IRCKitQuoteInfo extends IQuoteInfo {
      */
     quoteMessage?: IAReceivedMessage;
 }
+/**
+ * @since 5.42.0
+ */
+interface IRCKitMessageReaction extends Omit<IMessageReaction, 'users'> {
+    /**
+     * 回应用户 ID 列表，最多保留 10 个用户 ID，且当前登录用户优先
+     */
+    users: string[];
+}
 interface IRCKitCachedMessage extends Omit<IAReceivedMessage, 'quoteInfo'> {
     /**
      * 对应的发送事务 ID，本地生成的消息会携带此 ID，用于匹配相关事件
@@ -117,6 +141,10 @@ interface IRCKitCachedMessage extends Omit<IAReceivedMessage, 'quoteInfo'> {
      * 引用消息信息
      */
     quoteInfo?: IRCKitQuoteInfo;
+    /**
+     * 消息回应数据
+     */
+    reactions: IRCKitMessageReaction[];
 }
 
 /** 群组会话中的汇总 @ 信息类型 */
@@ -456,6 +484,11 @@ interface IRCKitLanguageEntries {
     'quote.status.deleted': string;
     'quote.status.recalled': string;
     'quote.status.load-error': string;
+    'reaction.detail.title': string;
+    'reaction.detail.loading': string;
+    'reaction.total.users': string;
+    'alert.reaction.limit.reached': string;
+    'alert.reaction.failed': string;
 }
 
 /**
@@ -881,6 +914,46 @@ declare type AudioPlayState = {
  */
 declare type AudioPlayEvent = RCKitEvent<'AUDIO_PLAY_EVENT', AudioPlayState>;
 declare type SetTextareaValueEvent = RCKitEvent<'SET_TEXTAREA_VALUE_EVENT', string>;
+/**
+ * 输入框事件数据。
+ * @since 5.42.0
+ */
+interface InputTextareaEventData {
+    /** 当前输入框文本内容 */
+    value: string;
+}
+/**
+ * 输入框获取焦点事件。
+ * @since 5.42.0
+ */
+declare type InputTextareaFocusEvent = RCKitEvent<'INPUT_TEXTAREA_FOCUS', InputTextareaEventData>;
+/**
+ * 输入框失去焦点事件。
+ * @since 5.42.0
+ */
+declare type InputTextareaBlurEvent = RCKitEvent<'INPUT_TEXTAREA_BLUR', InputTextareaEventData>;
+/**
+ * 输入框内容变更事件。
+ * @since 5.42.0
+ */
+declare type InputTextareaChangeEvent = RCKitEvent<'INPUT_TEXTAREA_CHANGE', InputTextareaEventData>;
+/**
+ * 消息发送前事件数据。
+ * @since 5.42.0
+ */
+interface BeforeSendMessageEventData<T extends BaseMessage = BaseMessage> {
+    /** 目标会话 */
+    conversation: IConversationOption;
+    /** 即将发送的消息对象，业务方可同步修改 */
+    message: T;
+    /** 即将发送的消息选项，业务方可同步修改或替换 */
+    options?: ISendMessageOptions;
+}
+/**
+ * 消息发送前事件。
+ * @since 5.42.0
+ */
+declare type BeforeSendMessageEvent<T extends BaseMessage = BaseMessage> = RCKitEvent<'BEFORE_SEND_MESSAGE', BeforeSendMessageEventData<T>>;
 /**
  * 语音转文字状态变更事件
  */
@@ -994,6 +1067,13 @@ interface EventDefined {
      * 拍照弹框事件
      */
     TAKE_PHOTO_MODAL_EVENT: RCKitEvent<'TAKE_PHOTO_MODAL_EVENT'>;
+    /**
+     * 消息回应详情弹框事件
+     */
+    REACTIONS_DETAIL_EVENT: RCKitEvent<'REACTIONS_DETAIL_EVENT', {
+        message: IRCKitCachedMessage;
+        reactionId: string;
+    }>;
     /**
      * 消息被删除或撤回通知
      */
@@ -1018,6 +1098,22 @@ interface EventDefined {
      * 系统会话打开前的事件，业务层可通过监听该事件拦截系统会话打开，以自定义系统会话的打开方式
      */
     BEFORE_SYSTEM_CONVERSATION_OPEN: BeforeSystemConversationOpenEvent;
+    /**
+     * 输入框获取焦点事件
+     */
+    INPUT_TEXTAREA_FOCUS: InputTextareaFocusEvent;
+    /**
+     * 输入框失去焦点事件
+     */
+    INPUT_TEXTAREA_BLUR: InputTextareaBlurEvent;
+    /**
+     * 输入框内容变更事件
+     */
+    INPUT_TEXTAREA_CHANGE: InputTextareaChangeEvent;
+    /**
+     * 消息发送前事件
+     */
+    BEFORE_SEND_MESSAGE: BeforeSendMessageEvent;
     /**
      * 接收到新消息，UI 和各数据模块可根据该事件处理 UI 变更
      */
@@ -1172,6 +1268,10 @@ declare enum RCKitEvents {
      * 拍照弹框事件
      */
     TAKE_PHOTO_MODAL_EVENT = "TAKE_PHOTO_MODAL_EVENT",
+    /**
+     * 消息回应详情弹框事件
+     */
+    REACTIONS_DETAIL_EVENT = "REACTIONS_DETAIL_EVENT",
     /**
      * 接收到 SDK 内部无法处理的消息，业务层可通过监听该事件获取消息
      */
@@ -1224,6 +1324,26 @@ declare enum RCKitEvents {
      * 消息被删除或撤回通知
      */
     MESSAGES_DELETED = "MESSAGES_DELETED",
+    /**
+     * 输入框获取焦点事件
+     * @since 5.42.0
+     */
+    INPUT_TEXTAREA_FOCUS = "INPUT_TEXTAREA_FOCUS",
+    /**
+     * 输入框失去焦点事件
+     * @since 5.42.0
+     */
+    INPUT_TEXTAREA_BLUR = "INPUT_TEXTAREA_BLUR",
+    /**
+     * 输入框内容变更事件
+     * @since 5.42.0
+     */
+    INPUT_TEXTAREA_CHANGE = "INPUT_TEXTAREA_CHANGE",
+    /**
+     * 消息发送前事件
+     * @since 5.42.0
+     */
+    BEFORE_SEND_MESSAGE = "BEFORE_SEND_MESSAGE",
     /**
      * 提示框显示事件
      */
@@ -1290,13 +1410,40 @@ interface IRCKitConversationItemCfg {
     activeBackgroundColor?: number | string;
 }
 
+/**
+ * 消息组件被渲染位置位置标识，开发者可根据不同的渲染位置调整 UI 状态
+ */
+declare enum RCKitMessageComponentRenderPosition {
+    /**
+     * 消息列表渲染
+     */
+    MESSAGE_LIST = 0,
+    /**
+     * 显示在消息被引用时
+     */
+    QUOTE_INFO = 1
+}
+/**
+ * 消息组件 Props 数据结构定义
+ */
+declare type IRCKitMessageComponentProps = {
+    /**
+     * 消息数据
+     */
+    message: IRCKitCachedMessage;
+    /**
+     * 标识组件被渲染的位置
+     */
+    position: RCKitMessageComponentRenderPosition;
+};
+
 interface IRCKitHQVoiceMessageComponentProps {
     /**
      * 是否为己方发送的消息
      */
     isOwner: boolean;
     /**
-     * 是否播放中
+     * 播放状态
      */
     playing: boolean;
     /**
@@ -1311,6 +1458,33 @@ interface IRCKitHQVoiceMessageComponentProps {
      * 切换播放与暂停状态
      */
     toggle: () => void;
+    /**
+     * 消息渲染位置
+     */
+    position: RCKitMessageComponentRenderPosition;
+}
+
+interface IRCKitReplyPreviewBarComponentProps {
+    /**
+     * 被引用消息数据原始数据
+     */
+    message: IRCKitCachedMessage;
+    /**
+     * 被引用消息发送者名称
+     */
+    username: string;
+    /**
+     * 被引用消息预览信息
+     */
+    previewText: string;
+    /**
+     * 缩率图数据，仅被回复消息为图片消息或小视频消息时有值
+     */
+    thumbnail?: string;
+    /**
+     * 取消回复
+     */
+    cancel: () => void;
 }
 
 interface IRCKitComponentContext {
@@ -1349,25 +1523,20 @@ declare enum RCKitOverrideAbleComponent {
     /**
      * 语音消息组件
      */
-    HQVoiceMessageComponent = "HQVoiceMessageComponent"
+    HQVoiceMessageComponent = "HQVoiceMessageComponent",
+    /**
+     * 输入框回复预览组件
+     */
+    ReplyPreviewBarComponent = "ReplyPreviewBarComponent"
 }
 /**
  * 定义可重写组件 Props 类型定义
  */
 interface IRCKitOverrideAbleComponentProps {
     HQVoiceMessageComponent: IRCKitHQVoiceMessageComponentProps;
+    ReplyPreviewBarComponent: IRCKitReplyPreviewBarComponentProps;
 }
 
-/**
- * 消息组件 Props 数据结构定义
- */
-declare type IRCKitMessageComponentProps = {
-    /**
-     * 消息数据
-     */
-    message: IRCKitCachedMessage;
-};
-
 interface IRCKitCustomMessageComponentOpts extends IRCKitDefineCustomElementOptions<IRCKitMessageComponentProps> {
     /**
      * 消息组件标签
@@ -1485,9 +1654,7 @@ declare class RCKitApplication extends EventDispatcher<EventDefined> {
      * });
      * ```
      */
-    registerCustomElement<T extends keyof IRCKitOverrideAbleComponentProps>(tag: T, opts: IRCKitDefineCustomElementOptions<{
-        value: IRCKitOverrideAbleComponentProps[T];
-    }>): void;
+    registerCustomElement<T extends keyof IRCKitOverrideAbleComponentProps>(tag: T, opts: IRCKitDefineCustomElementOptions<IRCKitOverrideAbleComponentProps[T]>): void;
     /**
      * 注册自定义消息类型，必须在 `ready` 之前调用。
      */
@@ -1686,4 +1853,4 @@ declare const isMobileDevice: () => boolean;
 
 declare const RCKitInstaller: IPluginGenerator<RCKitApplication, IRCKitInitOpts>;
 
-export { BeforeSystemConversationOpenEvent, DeleteMessageModalEvent, IRCKitCachedConversation, IRCKitCachedMessage, IRCKitChatEmojiLibrary, IRCKitComponentContext, IRCKitConversationExtension, IRCKitConversationExtensionClick, IRCKitConversationIconClick, IRCKitConversationItemCfg, IRCKitConversationMenuItem, IRCKitConversationMenuItemClick, IRCKitCustomMessageComponentOpts, IRCKitDefineCustomElementOptions, IRCKitDeleteMessageData, IRCKitGifImageInfo, IRCKitGroupMemberProfile, IRCKitGroupProfile, IRCKitHQVoiceMessageComponentProps, IRCKitImageEmoji, IRCKitImageEmojiLibrary, IRCKitInitOpts, IRCKitInputMenu, IRCKitInputMenuItem, IRCKitInputMenuItemClick, IRCKitLanguageEntries, IRCKitMessageBubbleCfg, IRCKitMessageLinkClick, IRCKitMessageMenuItem, IRCKitMessageMenuItemClick, IRCKitModalDeleteMessage, IRCKitModalDeleteMessageResult, IRCKitModalForwardingResult, IRCKitOverrideAbleComponentProps, IRCKitPushConfigHook, IRCKitRegisterMessageTypeOpts, IRCKitServiceHooks, IRCKitSystemProfile, IRCKitUserOnlineStatus, IRCKitUserProfile, RCKIT_COMMIT_VERSION, RCKIT_VERSION, RCKitApplication, RCKitBubbleLayout, RCKitChatEmojiLibraryID, RCKitCommand, RCKitConversationMenuID, RCKitEvent, RCKitEvents, RCKitInputMenuID, RCKitInputMenuPosition, RCKitInstaller, RCKitLanguageDirection, RCKitMentionedType, RCKitMessageMenuID, RCKitModalBtnType, RCKitModalForwardingType, RCKitOverrideAbleComponent, isMobileDevice };
+export { BeforeSendMessageEvent, BeforeSendMessageEventData, BeforeSystemConversationOpenEvent, DeleteMessageModalEvent, IRCKitCachedConversation, IRCKitCachedMessage, IRCKitChatEmojiLibrary, IRCKitComponentContext, IRCKitConversationExtension, IRCKitConversationExtensionClick, IRCKitConversationIconClick, IRCKitConversationItemCfg, IRCKitConversationMenuItem, IRCKitConversationMenuItemClick, IRCKitCustomMessageComponentOpts, IRCKitDefineCustomElementOptions, IRCKitDeleteMessageData, IRCKitGifImageInfo, IRCKitGroupMemberProfile, IRCKitGroupProfile, IRCKitHQVoiceMessageComponentProps, IRCKitImageEmoji, IRCKitImageEmojiLibrary, IRCKitInitOpts, IRCKitInputMenu, IRCKitInputMenuItem, IRCKitInputMenuItemClick, IRCKitLanguageEntries, IRCKitMessageBubbleCfg, IRCKitMessageComponentProps, IRCKitMessageLinkClick, IRCKitMessageMenuItem, IRCKitMessageMenuItemClick, IRCKitMessageReaction, IRCKitModalDeleteMessage, IRCKitModalDeleteMessageResult, IRCKitModalForwardingResult, IRCKitOverrideAbleComponentProps, IRCKitPushConfigHook, IRCKitRegisterMessageTypeOpts, IRCKitReplyPreviewBarComponentProps, IRCKitServiceHooks, IRCKitSystemProfile, IRCKitUserOnlineStatus, IRCKitUserProfile, InputTextareaBlurEvent, InputTextareaChangeEvent, InputTextareaEventData, InputTextareaFocusEvent, RCKIT_COMMIT_VERSION, RCKIT_VERSION, RCKitApplication, RCKitBubbleLayout, RCKitChatEmojiLibraryID, RCKitCommand, RCKitConversationMenuID, RCKitEvent, RCKitEvents, RCKitInputMenuID, RCKitInputMenuPosition, RCKitInstaller, RCKitLanguageDirection, RCKitMentionedType, RCKitMessageComponentRenderPosition, RCKitMessageMenuID, RCKitModalBtnType, RCKitModalForwardingType, RCKitOverrideAbleComponent, isMobileDevice };