easemob-chat-uikit 2.2.1 → 2.3.0-beta.2

package/types/eventHandler/index.d.ts

@@ -1,5 +1,5 @@
 import { ChatSDK } from '../module/SDK';
-export type EventName = 'joinChatRoom' | 'leaveChatRoom' | 'reportMessage' | 'getChatRoomDetails' | 'sendMessage' | 'fetchUserInfoById' | 'translateMessage' | 'recallMessage' | 'deleteConversation' | 'modifyMessage' | 'createChatThread' | 'destroyChatThread' | 'leaveChatThread' | 'setGroupMemberAttributes' | 'muteChatRoomMember' | 'getChatRoomMutelist' | 'unmuteChatRoomMember' | 'removeChatRoomMember' | 'getSilentModeForConversations' | 'setSilentModeForConversation' | 'clearRemindTypeForConversation' | 'getGroupInfo' | 'modifyGroup' | 'destroyGroup' | 'leaveGroup' | 'createGroup' | 'inviteToGroup' | 'removeGroupMembers' | 'changeGroupOwner' | 'pinConversation' | 'getServerPinnedConversations' | 'removeHistoryMessages' | 'addReaction' | 'deleteReaction' | 'getReactionDetail' | 'joinChatThread' | 'getChatThreads' | 'getChatThreadLastMessage' | 'getAllContacts' | 'getJoinedGroups' | 'open' | 'setContactRemark' | 'addContact' | 'deleteContact' | 'getPinnedMessages' | 'pinMessage' | 'unpinMessage' | 'jumpToPinnedMessage' | 'addUsersToBlocklist' | 'removeUserFromBlocklist' | 'publishPresence' | 'getBlockList';
+export type EventName = 'joinChatRoom' | 'leaveChatRoom' | 'reportMessage' | 'getChatRoomDetails' | 'sendMessage' | 'fetchUserInfoById' | 'translateMessage' | 'recallMessage' | 'deleteConversation' | 'modifyMessage' | 'createChatThread' | 'destroyChatThread' | 'leaveChatThread' | 'setGroupMemberAttributes' | 'muteChatRoomMember' | 'getChatRoomMutelist' | 'unmuteChatRoomMember' | 'removeChatRoomMember' | 'getSilentModeForConversations' | 'setSilentModeForConversation' | 'clearRemindTypeForConversation' | 'getGroupInfo' | 'modifyGroup' | 'destroyGroup' | 'leaveGroup' | 'createGroup' | 'inviteToGroup' | 'removeGroupMembers' | 'changeGroupOwner' | 'pinConversation' | 'getServerPinnedConversations' | 'removeHistoryMessages' | 'addReaction' | 'deleteReaction' | 'getReactionDetail' | 'joinChatThread' | 'getChatThreads' | 'getChatThreadLastMessage' | 'getAllContacts' | 'getJoinedGroups' | 'open' | 'setContactRemark' | 'addContact' | 'deleteContact' | 'getPinnedMessages' | 'pinMessage' | 'unpinMessage' | 'jumpToPinnedMessage' | 'addUsersToBlocklist' | 'removeUserFromBlocklist' | 'publishPresence' | 'getBlockList' | 'getConversationlist';
 export type EventHandlerData = {
     [key in EventName]?: {
         success?: () => void;

package/types/module/baseMessage/BaseMessage.d.ts

@@ -1,5 +1,6 @@
 import React, { ReactNode } from 'react';
 import { MessageStatusProps } from '../messageStatus';
+import { CustomMessageQuoteRenderer } from '../repliedMessage';
 import { ChatSDK } from '../SDK';
 import { ReactionData, ReactionMessageProps } from '../reaction';
 interface CustomAction {
@@ -65,6 +66,8 @@ export interface BaseMessageProps {
     reactionConfig?: ReactionMessageProps['reactionConfig'];
     formatDateTime?: (time: number) => string;
     onClick?: (message: ChatSDK.MessageBody) => boolean;
+    /** 自定义消息被引用时的渲染器 */
+    renderCustomMessageQuote?: CustomMessageQuoteRenderer;
 }
 declare let BaseMessage: (props: BaseMessageProps) => import("react/jsx-runtime").JSX.Element;
 export { BaseMessage };

package/types/module/callkit/services/CallService.d.ts

@@ -87,6 +87,7 @@ export interface CallServiceConfig {
     encoderConfig?: VideoEncoderConfigurationPreset;
     onRingtoneStart?: (type: 'outgoing' | 'incoming') => void;
     onRingtoneEnd?: (type: 'outgoing' | 'incoming') => void;
+    useRTCToken?: boolean;
 }
 export declare class CallService {
     private client;
@@ -147,6 +148,7 @@ export declare class CallService {
     private creatingAudioTrack;
     private UIdToUserIdMap;
     private enableMic;
+    private useRTCToken;
     constructor(config: CallServiceConfig);
     setUIdToUserIdMap(uid: string, userId: string): void;
     getAccessToken(): Promise<string | null>;

package/types/module/callkit/types/index.d.ts

@@ -141,6 +141,7 @@ export interface CallKitProps {
     screenSharing?: boolean;
     chatClient?: ChatSDK.Connection;
     enableRealCall?: boolean;
+    useRTCToken?: boolean;
     outgoingRingtoneSrc?: string;
     incomingRingtoneSrc?: string;
     enableRingtone?: boolean;

package/types/module/chat/MessageList.d.ts

@@ -4,12 +4,27 @@ import { renderUserProfileProps } from '../baseMessage';
 import { CurrentConversation } from '../store/ConversationStore';
 import { BaseMessageProps } from '../baseMessage';
 import { NoticeMessageBody } from '../noticeMessage/NoticeMessage';
+export interface MessageRenderContext {
+    message: ChatSDK.MessageBody | NoticeMessageBody;
+    style: React.CSSProperties;
+    renderUserProfile?: (props: renderUserProfileProps) => React.ReactNode;
+    isThread?: boolean;
+    messageProps?: BaseMessageProps;
+    onOpenThreadPanel?: (threadId: string) => void;
+    onRtcInviteMessageClick?: (message: ChatSDK.MessageBody) => void;
+    scrollToBottom?: () => void;
+}
+export type MessageType = 'txt' | 'img' | 'audio' | 'video' | 'file' | 'loc' | 'combine' | 'custom' | 'notice' | 'recall';
+export type MessageRenderer = (context: MessageRenderContext) => ReactNode;
 export interface MsgListProps {
     prefix?: string;
     className?: string;
     style?: React.CSSProperties;
     isThread?: boolean;
+    /** @deprecated 使用 customRenderers 替代，支持按类型自定义 */
     renderMessage?: (message: ChatSDK.MessageBody | NoticeMessageBody) => ReactNode;
+    /** 按消息类型自定义渲染器，只需要传入想自定义的类型即可，其他类型会使用默认渲染 */
+    customRenderers?: Partial<Record<MessageType, MessageRenderer>>;
     renderUserProfile?: (props: renderUserProfileProps) => React.ReactNode;
     conversation?: CurrentConversation;
     messageProps?: BaseMessageProps;

package/types/module/chat/index.d.ts

@@ -1,6 +1,6 @@
 import { Chat } from './Chat';
 import { MessageList } from './MessageList';
 export type { ChatProps } from './Chat';
-export type { MsgListProps } from './MessageList';
+export type { MsgListProps, MessageRenderContext, MessageRenderer, MessageType, } from './MessageList';
 export { MessageList };
 export default Chat;

package/types/module/chatroom/Chatroom.d.ts

@@ -2,6 +2,7 @@ import React, { ReactNode } from 'react';
 import { HeaderProps } from '../header';
 import { MessageInputProps } from '../messageInput';
 import { MsgListProps } from '../chat/MessageList';
+import { ChatroomMessageActionConfig } from '../chatroomMessage';
 import { BroadcastProps } from '../../component/broadcast';
 import { ChatroomInfo } from '../store/AddressStore';
 export declare let reportType: Record<string, string>;
@@ -25,6 +26,7 @@ export interface ChatroomProps {
     broadcastProps?: BroadcastProps;
     chatroomId: string;
     reportType?: Record<string, string>;
+    messageActionConfig?: ChatroomMessageActionConfig;
 }
 declare let Chatroom: (props: ChatroomProps) => import("react/jsx-runtime").JSX.Element;
 export { Chatroom };

package/types/module/chatroomMessage/ChatroomMessage.d.ts

@@ -1,5 +1,18 @@
-import React from 'react';
+import React, { ReactNode } from 'react';
 import { ChatSDK } from '../SDK';
+export interface ChatroomMessageActionConfig {
+    recall?: boolean;
+    translate?: boolean;
+    mute?: boolean;
+    report?: boolean;
+    pin?: boolean;
+    customActions?: Array<{
+        content: string | ReactNode;
+        icon?: ReactNode;
+        onClick: (message: ChatSDK.MessageBody) => void;
+        visible?: (message: ChatSDK.MessageBody) => boolean;
+    }>;
+}
 export interface ChatroomMessageProps {
     prefix?: string;
     className?: string;
@@ -7,6 +20,7 @@ export interface ChatroomMessageProps {
     message: ChatSDK.MessageBody;
     targetLanguage?: string;
     onReport?: (message: ChatSDK.MessageBody) => void;
+    actionConfig?: ChatroomMessageActionConfig;
 }
 declare const ChatroomMessageOut: ((props: ChatroomMessageProps) => import("react/jsx-runtime").JSX.Element) & {
     displayName: string;

package/types/module/chatroomMessage/index.d.ts

@@ -1,3 +1,3 @@
 import ChatroomMessage from './ChatroomMessage';
-export type { ChatroomMessageProps } from './ChatroomMessage';
+export type { ChatroomMessageProps, ChatroomMessageActionConfig } from './ChatroomMessage';
 export default ChatroomMessage;

package/types/module/imageMessage/ImageMessage.d.ts

@@ -12,6 +12,13 @@ export interface ImageMessageProps extends BaseMessageProps {
     nickName?: string;
     renderUserProfile?: (props: renderUserProfileProps) => React.ReactNode;
     imgProps?: React.ImgHTMLAttributes<HTMLImageElement>;
+    /** 自定义图片预览组件，用于替换默认的预览弹窗 */
+    renderImagePreview?: (props: {
+        visible: boolean;
+        imageUrl: string;
+        onClose: () => void;
+        message: ImageMessageType;
+    }) => React.ReactNode;
 }
 export interface ImagePreviewProps {
     visible: boolean;

package/types/module/index.d.ts

@@ -10,7 +10,7 @@ import MessageStatus, { MessageStatusProps } from './messageStatus';
 import CombinedMessage, { CombinedMessageProps } from './combinedMessage';
 import PinnedMessage, { PinnedMessageProps } from './pinnedMessage';
 import { RepliedMsg, UnsentRepliedMsg, RepliedMsgProps, UnsentRepliedMsgProps } from './repliedMessage';
-import Chat, { MessageList, ChatProps, MsgListProps } from './chat';
+import Chat, { MessageList, ChatProps, MsgListProps, MessageRenderContext, MessageRenderer, MessageType } from './chat';
 import { ConversationList, ConversationItem, ConversationItemProps, ConversationListProps, ConversationData } from './conversation';
 import MessageInput, { MessageInputProps, MoreActionProps, RecorderProps, EmojiProps, SelectedControlsProps, SuggestListProps, TextareaProps } from './messageInput';
 import Header, { HeaderProps } from './header';
@@ -44,6 +44,6 @@ import ChatroomMessage from './chatroomMessage';
 import CallKit from './callkit';
 import { CallKitProps, CallInfo, CallErrorCode, CallError } from './callkit';
 import { CallKitRef } from './callkit/types/index';
-export type { AudioMessageProps, BaseMessageProps, FileMessageProps, ImageMessageProps, ImagePreviewProps, NoticeMessageProps, TextMessageProps, VideoMessageProps, MessageStatusProps, CombinedMessageProps, PinnedMessageProps, RepliedMsgProps, UnsentRepliedMsgProps, ChatProps, MsgListProps, ConversationItemProps, ConversationListProps, ConversationData, MessageInputProps, MoreActionProps, RecorderProps, EmojiProps, SelectedControlsProps, SuggestListProps, TextareaProps, HeaderProps, EmptyProps, RecalledMessageProps, RootStore, InitConfig, MessageStore, Message, SelectedMessage, Typing, ConversationStore, AT_TYPE, Conversation, CurrentConversation, ById, AddressStore, MemberRole, MemberItem, GroupItem, AppUserInfo, ThreadStore, ThreadData, CurrentThread, ProviderProps, ContextProps, ThreadProps, UserProfileProps, BlocklistProps, ContactListProps, ContactDetailProps, GroupDetailProps, GroupMemberProps, UserCardMessageProps, UserSelectProps, CallKitProps, CallKitRef, CallInfo, CallErrorCode, CallError, };
+export type { AudioMessageProps, BaseMessageProps, FileMessageProps, ImageMessageProps, ImagePreviewProps, NoticeMessageProps, TextMessageProps, VideoMessageProps, MessageStatusProps, CombinedMessageProps, PinnedMessageProps, RepliedMsgProps, UnsentRepliedMsgProps, ChatProps, MsgListProps, ConversationItemProps, ConversationListProps, ConversationData, MessageInputProps, MoreActionProps, RecorderProps, EmojiProps, SelectedControlsProps, SuggestListProps, TextareaProps, HeaderProps, EmptyProps, RecalledMessageProps, RootStore, InitConfig, MessageStore, Message, SelectedMessage, Typing, ConversationStore, AT_TYPE, Conversation, CurrentConversation, ById, AddressStore, MemberRole, MemberItem, GroupItem, AppUserInfo, ThreadStore, ThreadData, CurrentThread, ProviderProps, ContextProps, ThreadProps, UserProfileProps, BlocklistProps, ContactListProps, ContactDetailProps, GroupDetailProps, GroupMemberProps, UserCardMessageProps, UserSelectProps, CallKitProps, CallKitRef, CallInfo, CallErrorCode, CallError, MessageRenderContext, MessageRenderer, MessageType, };
 declare const UIKitProvider: import("react").NamedExoticComponent<ProviderProps>;
 export { AudioMessage, BaseMessage, FileMessage, ImageMessage, NoticeMessage, TextMessage, VideoMessage, CombinedMessage, PinnedMessage, RepliedMsg, UnsentRepliedMsg, MessageStatus, Chat, MessageList, ContactList, ConversationList, ConversationItem, MessageInput, Header, Empty, RecalledMessage, rootStore, RootContext, RootProvider, RootConsumer, Provider, UIKitProvider, Thread, UserProfile, Blocklist, useClient, useConversations, usePinnedMessage, useHistoryMessages, useSDK, useIsMobile, useScreen, useConversationContext, useChatContext, useAddressContext, useThreadContext, useChatroomContext, Chatroom, ChatroomMember, ChatroomMessage, ContactItem, ContactDetail, GroupDetail, GroupMember, UserCardMessage, UserSelect, CallKit, };

package/types/module/repliedMessage/RepliedMsg.d.ts

@@ -1,5 +1,17 @@
-import React from 'react';
+import React, { ReactNode } from 'react';
+import { ChatSDK } from '../SDK';
 import { BaseMessageType } from '../baseMessage/BaseMessage';
+export interface CustomMessageQuoteContext {
+    message: ChatSDK.CustomMsgBody;
+    msgQuote?: {
+        msgID: string;
+        msgPreview: string;
+        msgSender: string;
+        msgType: ChatSDK.MessageBody['type'];
+    };
+    prefixCls: string;
+}
+export type CustomMessageQuoteRenderer = (context: CustomMessageQuoteContext) => ReactNode;
 export interface RepliedMsgProps {
     prefixCls?: string;
     className?: string;
@@ -7,6 +19,27 @@ export interface RepliedMsgProps {
     shape?: 'round' | 'square';
     direction?: 'ltr' | 'rtl';
     message: BaseMessageType;
+    /**
+     * 自定义消息被引用时的渲染器
+     * 用于渲染用户自定义的 custom 消息在被引用时的展示内容
+     *
+     * @example
+     * ```tsx
+     * renderCustomMessageQuote={(context) => {
+     *   const { message, prefixCls } = context;
+     *   if (message.customEvent === 'myCustomType') {
+     *     return (
+     *       <div className={`${prefixCls}-content-text`}>
+     *         <Icon type="CUSTOM_ICON" />
+     *         <span>我的自定义消息: {message.customExts?.title}</span>
+     *       </div>
+     *     );
+     *   }
+     *   return null; // 返回 null 使用默认渲染
+     * }}
+     * ```
+     */
+    renderCustomMessageQuote?: CustomMessageQuoteRenderer;
 }
 declare const RepliedMsg: (props: RepliedMsgProps) => import("react/jsx-runtime").JSX.Element | null;
 export { RepliedMsg };

package/types/module/repliedMessage/index.d.ts

@@ -2,4 +2,4 @@ import { UnsentRepliedMsg } from './UnsentRepliedMsg';
 import { RepliedMsg } from './RepliedMsg';
 export { UnsentRepliedMsg, RepliedMsg };
 export type { UnsentRepliedMsgProps } from './UnsentRepliedMsg';
-export type { RepliedMsgProps } from './RepliedMsg';
+export type { RepliedMsgProps, CustomMessageQuoteRenderer, CustomMessageQuoteContext } from './RepliedMsg';