@azure/communication-react 1.17.0-beta.1 → 1.18.0-alpha-202406080014

package/dist/dist-esm/react-components/src/components/MessageThread.d.ts

@@ -130,7 +130,7 @@ export type MessageRenderer = (props: MessageProps) => JSX.Element;
  * @public
  * Callback function run when a message is updated.
  */
-export type UpdateMessageCallback = (messageId: string, content: string, /* @conditional-compile-remove(attachment-upload) */ options?: MessageOptions) => Promise<void>;
+export type UpdateMessageCallback = (messageId: string, content: string, options?: MessageOptions) => Promise<void>;
 /**
  * @public
  * Callback function run when a message edit is cancelled.
@@ -263,7 +263,7 @@ export type MessageThreadProps = {
      * @param options - message options to be included in the message
      *
      */
-    onSendMessage?: (content: string, /* @conditional-compile-remove(attachment-upload) */ options?: MessageOptions) => Promise<void>;
+    onSendMessage?: (content: string, options?: MessageOptions) => Promise<void>;
     /**
     /**
      * Disable editing messages.
@@ -299,12 +299,24 @@ export type MessageThreadProps = {
      */
     inlineImageOptions?: InlineImageOptions;
     /**
-     * enables rich text editor for the edit box
-     *
-     * @defaultValue `false`
+     * Options to enable rich text editor for the edit box.
+     * @beta
      */
-    richTextEditor?: boolean;
+    richTextEditorOptions?: RichTextEditorOptions;
 };
+/**
+ * Options for the rich text editor configuration.
+ *
+ * @beta
+ */
+export interface RichTextEditorOptions {
+    /**
+     * Optional callback to handle paste event.
+     */
+    onPaste?: (event: {
+        content: DocumentFragment;
+    }) => void;
+}
 /**
  * Props to render a single message.
  *
@@ -366,7 +378,7 @@ export type MessageProps = {
      * @param options - message options to be included in the message
      *
      */
-    onSendMessage?: (content: string, /* @conditional-compile-remove(attachment-upload) */ options?: MessageOptions) => Promise<void>;
+    onSendMessage?: (content: string, options?: MessageOptions) => Promise<void>;
 };
 /**
  * @internal

package/dist/dist-esm/react-components/src/components/MessageThread.js

@@ -29,7 +29,13 @@ import { Announcer } from './Announcer';
 /* @conditional-compile-remove(rich-text-editor) */
 import { loadChatMessageComponentAsRichTextEditBox } from './ChatMessage/MyMessageComponents/ChatMessageComponentAsEditBoxPicker';
 const isMessageSame = (first, second) => {
-    return first.messageId === second.messageId && first.content === second.content && first.contentType === second.contentType && JSON.stringify(first.createdOn) === JSON.stringify(second.createdOn) && first.senderId === second.senderId && first.senderDisplayName === second.senderDisplayName && JSON.stringify(first.editedOn) === JSON.stringify(second.editedOn);
+    return (first.messageId === second.messageId &&
+        first.content === second.content &&
+        first.contentType === second.contentType &&
+        JSON.stringify(first.createdOn) === JSON.stringify(second.createdOn) &&
+        first.senderId === second.senderId &&
+        first.senderDisplayName === second.senderDisplayName &&
+        JSON.stringify(first.editedOn) === JSON.stringify(second.editedOn));
 };
 /**
  * Get the latest message from the message array.
@@ -56,7 +62,8 @@ const isThereNewMessageNotFromCurrentUser = (userId, latestMessageFromPreviousMe
     if (latestMessageFromPreviousMessages === undefined) {
         return latestMessageFromNewMessages.senderId !== userId;
     }
-    return !isMessageSame(latestMessageFromNewMessages, latestMessageFromPreviousMessages) && latestMessageFromNewMessages.senderId !== userId;
+    return (!isMessageSame(latestMessageFromNewMessages, latestMessageFromPreviousMessages) &&
+        latestMessageFromNewMessages.senderId !== userId);
 };
 /**
  * Returns true if the current user sent the latest message and false otherwise. It will ignore messages that have no
@@ -71,36 +78,35 @@ const didUserSendTheLatestMessage = (userId, latestMessageFromPreviousMessages,
     if (latestMessageFromPreviousMessages === undefined) {
         return latestMessageFromNewMessages.senderId === userId;
     }
-    return !isMessageSame(latestMessageFromNewMessages, latestMessageFromPreviousMessages) && latestMessageFromNewMessages.senderId === userId;
+    return (!isMessageSame(latestMessageFromNewMessages, latestMessageFromPreviousMessages) &&
+        latestMessageFromNewMessages.senderId === userId);
 };
 const DefaultJumpToNewMessageButton = (props) => {
     const { text, onClick } = props;
-    return React.createElement(PrimaryButton, { className: newMessageButtonStyle, styles: buttonWithIconStyles, text: text, onClick: onClick, onRenderIcon: () => React.createElement(Icon, { iconName: "Down", className: DownIconStyle }) });
+    return (React.createElement(PrimaryButton, { className: newMessageButtonStyle, styles: buttonWithIconStyles, text: text, onClick: onClick, onRenderIcon: () => React.createElement(Icon, { iconName: "Down", className: DownIconStyle }) }));
 };
 const memoizeAllMessages = memoizeFnAll((message, showMessageDate, showMessageStatus, strings, index, onUpdateMessage, onCancelEditMessage, onDeleteMessage, onSendMessage, disableEditing, lastSeenChatMessage, lastSendingChatMessage, lastDeliveredChatMessage) => {
     let key = message.messageId;
     let statusToRender = undefined;
-    if (message.messageType === 'chat' || /* @conditional-compile-remove(data-loss-prevention) */ message.messageType === 'blocked') {
+    if (message.messageType === 'chat' ||
+        /* @conditional-compile-remove(data-loss-prevention) */ message.messageType === 'blocked') {
         if ((!message.messageId || message.messageId === '') && 'clientMessageId' in message) {
             key = message.clientMessageId;
         }
         if (showMessageStatus && message.mine) {
             switch (message.messageId) {
-                case lastSeenChatMessage:
-                    {
-                        statusToRender = 'seen';
-                        break;
-                    }
-                case lastSendingChatMessage:
-                    {
-                        statusToRender = 'sending';
-                        break;
-                    }
-                case lastDeliveredChatMessage:
-                    {
-                        statusToRender = 'delivered';
-                        break;
-                    }
+                case lastSeenChatMessage: {
+                    statusToRender = 'seen';
+                    break;
+                }
+                case lastSendingChatMessage: {
+                    statusToRender = 'sending';
+                    break;
+                }
+                case lastDeliveredChatMessage: {
+                    statusToRender = 'delivered';
+                    break;
+                }
             }
         }
         if (message.mine && message.status === 'failed') {
@@ -154,8 +160,8 @@ export const MessageThread = (props) => {
     var _a;
     const theme = useTheme();
     const chatBody = useMemo(() => {
-        return React.createElement(FluentV9ThemeProvider, { v8Theme: theme },
-            React.createElement(MessageThreadWrapper, Object.assign({}, props)));
+        return (React.createElement(FluentV9ThemeProvider, { v8Theme: theme },
+            React.createElement(MessageThreadWrapper, Object.assign({}, props))));
     }, [theme, props]);
     return React.createElement("div", { className: mergeStyles(messageThreadContainerStyle, (_a = props.styles) === null || _a === void 0 ? void 0 : _a.root) }, chatBody);
 };
@@ -169,12 +175,12 @@ export const MessageThreadWrapper = (props) => {
     onDisplayDateTimeString, 
     /* @conditional-compile-remove(mention) */
     mentionOptions, inlineImageOptions, 
-    /* @conditional-compile-remove(attachment-download) @conditional-compile-remove(attachment-upload) */
+    /* @conditional-compile-remove(file-sharing-acs) */
     attachmentOptions, 
-    /* @conditional-compile-remove(attachment-download) @conditional-compile-remove(attachment-upload) */
+    /* @conditional-compile-remove(file-sharing-acs) */
     onRenderAttachmentDownloads, 
     /* @conditional-compile-remove(rich-text-editor) */
-    richTextEditor = false } = props;
+    richTextEditorOptions } = props;
     // We need this state to wait for one tick and scroll to bottom after messages have been initialized.
     // Otherwise chatScrollDivRef.current.clientHeight is wrong if we scroll to bottom before messages are initialized.
     const [chatMessagesInitialized, setChatMessagesInitialized] = useState(false);
@@ -203,12 +209,12 @@ export const MessageThreadWrapper = (props) => {
     /* @conditional-compile-remove(rich-text-editor) */
     useEffect(() => {
         // if rich text editor is enabled, the rich text editor component should be loaded early for good UX
-        if (richTextEditor !== undefined && richTextEditor) {
+        if (richTextEditorOptions !== undefined) {
             // this line is needed to load the Rooster JS dependencies early in the lifecycle
             // when the rich text editor is enabled
             loadChatMessageComponentAsRichTextEditBox();
         }
-    }, [richTextEditor]);
+    }, [richTextEditorOptions]);
     const onDeleteMessageCallback = useCallback((messageId) => __awaiter(void 0, void 0, void 0, function* () {
         if (!onDeleteMessage) {
             return;
@@ -244,12 +250,12 @@ export const MessageThreadWrapper = (props) => {
             setDeletedMessageAriaLabel(undefined);
         }
         else {
-            if (!previousMessagesRef.current.find(message => message.messageId === latestDeletedMessageId)) {
+            if (!previousMessagesRef.current.find((message) => message.messageId === latestDeletedMessageId)) {
                 // the message is deleted in previousMessagesRef
                 // no need to update deletedMessageAriaLabel
                 setDeletedMessageAriaLabel(undefined);
             }
-            else if (!messages.find(message => message.messageId === latestDeletedMessageId)) {
+            else if (!messages.find((message) => message.messageId === latestDeletedMessageId)) {
                 // the message is deleted in messages array but still exists in previousMessagesRef
                 // update deletedMessageAriaLabel
                 setDeletedMessageAriaLabel(strings.messageDeletedAnnouncementAriaLabel);
@@ -291,10 +297,14 @@ export const MessageThreadWrapper = (props) => {
     const clientHeight = (_a = chatThreadRef.current) === null || _a === void 0 ? void 0 : _a.clientHeight;
     // we try to only send those message status if user is scrolled to the bottom.
     const sendMessageStatusIfAtBottom = useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
-        if (!isAtBottomOfScrollRef.current || !document.hasFocus() || !messagesRef.current || messagesRef.current.length === 0 || !showMessageStatus) {
+        if (!isAtBottomOfScrollRef.current ||
+            !document.hasFocus() ||
+            !messagesRef.current ||
+            messagesRef.current.length === 0 ||
+            !showMessageStatus) {
             return;
         }
-        const messagesWithId = messagesRef.current.filter(message => {
+        const messagesWithId = messagesRef.current.filter((message) => {
             return message.messageType === 'chat' && !message.mine && !!message.messageId;
         });
         if (messagesWithId.length === 0) {
@@ -302,7 +312,10 @@ export const MessageThreadWrapper = (props) => {
         }
         const lastMessage = messagesWithId[messagesWithId.length - 1];
         try {
-            if (onMessageSeen && lastMessage && lastMessage.messageId && lastMessage.messageId !== messageIdSeenByMeRef.current) {
+            if (onMessageSeen &&
+                lastMessage &&
+                lastMessage.messageId &&
+                lastMessage.messageId !== messageIdSeenByMeRef.current) {
                 yield onMessageSeen(lastMessage.messageId);
                 messageIdSeenByMeRef.current = lastMessage.messageId;
             }
@@ -323,7 +336,8 @@ export const MessageThreadWrapper = (props) => {
         if (!chatScrollDivRef.current) {
             return;
         }
-        const atBottom = Math.ceil(chatScrollDivRef.current.scrollTop) >= chatScrollDivRef.current.scrollHeight - chatScrollDivRef.current.clientHeight;
+        const atBottom = Math.ceil(chatScrollDivRef.current.scrollTop) >=
+            chatScrollDivRef.current.scrollHeight - chatScrollDivRef.current.clientHeight;
         if (atBottom) {
             sendMessageStatusIfAtBottom();
             if (!isAtBottomOfScrollRef.current) {
@@ -339,7 +353,9 @@ export const MessageThreadWrapper = (props) => {
                 isLoadingChatMessagesRef.current = true;
                 try {
                     // Fetch message until scrollTop reach the threshold for fetching new message
-                    while (!isAllChatMessagesLoadedRef.current && chatScrollDivRef.current && chatScrollDivRef.current.scrollTop <= 500) {
+                    while (!isAllChatMessagesLoadedRef.current &&
+                        chatScrollDivRef.current &&
+                        chatScrollDivRef.current.scrollTop <= 500) {
                         isAllChatMessagesLoadedRef.current = yield onLoadPreviousChatMessages(numberOfChatMessagesToReload);
                         yield delay(200);
                     }
@@ -366,7 +382,8 @@ export const MessageThreadWrapper = (props) => {
         if (!chatScrollDivRef.current) {
             return;
         }
-        chatScrollDivRef.current.scrollTop = chatScrollDivRef.current.scrollHeight - (previousHeightRef.current - previousTopRef.current);
+        chatScrollDivRef.current.scrollTop =
+            chatScrollDivRef.current.scrollHeight - (previousHeightRef.current - previousTopRef.current);
     }, [messages]);
     // Fetch more messages to make the scroll bar appear, infinity scroll is then handled in the handleScroll function.
     useEffect(() => {
@@ -436,10 +453,12 @@ export const MessageThreadWrapper = (props) => {
      */
     useEffect(() => {
         // If user just sent the latest message then we assume we can move user to bottom of scroll.
-        if (isThereNewMessageNotFromCurrentUser(userId, latestPreviousChatMessage, latestCurrentChatMessage) && !isAtBottomOfScrollRef.current) {
+        if (isThereNewMessageNotFromCurrentUser(userId, latestPreviousChatMessage, latestCurrentChatMessage) &&
+            !isAtBottomOfScrollRef.current) {
             setExistsNewChatMessage(true);
         }
-        else if (didUserSendTheLatestMessage(userId, latestPreviousChatMessage, latestCurrentChatMessage) || isAtBottomOfScrollRef.current) {
+        else if (didUserSendTheLatestMessage(userId, latestPreviousChatMessage, latestCurrentChatMessage) ||
+            isAtBottomOfScrollRef.current) {
             scrollToBottom();
         }
         // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -467,24 +486,34 @@ export const MessageThreadWrapper = (props) => {
                 setReadCountForHoveredIndicator(undefined);
             }
         };
-        return React.createElement(MessageStatusIndicatorInternal, { status: status, readCount: readCount, onToggleToolTip: onToggleToolTip, 
+        return (React.createElement(MessageStatusIndicatorInternal, { status: status, readCount: readCount, onToggleToolTip: onToggleToolTip, 
             // -1 because participant count does not include myself
-            remoteParticipantsCount: participantCount ? participantCount - 1 : 0, shouldAnnounce: shouldAnnounce });
+            remoteParticipantsCount: participantCount ? participantCount - 1 : 0, shouldAnnounce: shouldAnnounce }));
     }, []);
     const theme = useTheme();
     const messagesToDisplay = useMemo(() => {
-        return memoizeAllMessages(memoizedMessageFn => {
+        return memoizeAllMessages((memoizedMessageFn) => {
             return messages.map((message, index) => {
                 return memoizedMessageFn(message, showMessageDate, showMessageStatus, strings, index, onUpdateMessage, onCancelEditMessage, onDeleteMessageCallback, onSendMessage, props.disableEditing, lastDeliveredChatMessage, lastSeenChatMessage, lastSendingChatMessage);
             });
         });
-    }, [lastDeliveredChatMessage, lastSeenChatMessage, lastSendingChatMessage, messages, onCancelEditMessage, onDeleteMessageCallback, onSendMessage, onUpdateMessage, props.disableEditing, showMessageDate, showMessageStatus, strings]);
+    }, [
+        lastDeliveredChatMessage,
+        lastSeenChatMessage,
+        lastSendingChatMessage,
+        messages,
+        onCancelEditMessage,
+        onDeleteMessageCallback,
+        onSendMessage,
+        onUpdateMessage,
+        props.disableEditing,
+        showMessageDate,
+        showMessageStatus,
+        strings
+    ]);
     const classes = useChatStyles();
-    return React.createElement("div", { className: mergeStyles(messageThreadWrapperContainerStyle), ref: chatThreadRef },
-        existsNewChatMessage && !disableJumpToNewMessageButton && React.createElement("div", { className: mergeStyles(newMessageButtonContainerStyle, styles === null || styles === void 0 ? void 0 : styles.newMessageButtonContainer) }, onRenderJumpToNewMessageButton ? onRenderJumpToNewMessageButton({
-            text: strings.newMessagesIndicator,
-            onClick: scrollToBottom
-        }) : React.createElement(DefaultJumpToNewMessageButton, { text: strings.newMessagesIndicator, onClick: scrollToBottom })),
+    return (React.createElement("div", { className: mergeStyles(messageThreadWrapperContainerStyle), ref: chatThreadRef },
+        existsNewChatMessage && !disableJumpToNewMessageButton && (React.createElement("div", { className: mergeStyles(newMessageButtonContainerStyle, styles === null || styles === void 0 ? void 0 : styles.newMessageButtonContainer) }, onRenderJumpToNewMessageButton ? (onRenderJumpToNewMessageButton({ text: strings.newMessagesIndicator, onClick: scrollToBottom })) : (React.createElement(DefaultJumpToNewMessageButton, { text: strings.newMessagesIndicator, onClick: scrollToBottom })))),
         React.createElement(LiveAnnouncer, null,
             React.createElement(FluentV9ThemeProvider, { v8Theme: theme },
                 React.createElement(Chat
@@ -492,16 +521,21 @@ export const MessageThreadWrapper = (props) => {
                 , { 
                     // styles?.chatContainer used in className and style prop as style prop can't handle CSS selectors
                     className: mergeClasses(classes.root, mergeStyles(styles === null || styles === void 0 ? void 0 : styles.chatContainer)), ref: chatScrollDivRef, style: Object.assign({}, createStyleFromV8Style(styles === null || styles === void 0 ? void 0 : styles.chatContainer)) },
-                    latestDeletedMessageId && React.createElement(Announcer, { key: latestDeletedMessageId, announcementString: deletedMessageAriaLabel, ariaLive: 'polite' }),
+                    latestDeletedMessageId && (React.createElement(Announcer, { key: latestDeletedMessageId, announcementString: deletedMessageAriaLabel, ariaLive: 'polite' })),
                     messagesToDisplay.map((message) => {
                         var _a;
-                        return React.createElement(MemoChatMessageComponentWrapper, Object.assign({}, message, { userId: userId, key: message.key, styles: styles, shouldOverlapAvatarAndMessage: isNarrow, strings: strings, onRenderAvatar: onRenderAvatar, onRenderMessage: onRenderMessage, onRenderMessageStatus: onRenderMessageStatus, defaultStatusRenderer: defaultStatusRenderer, onActionButtonClick: onActionButtonClickMemo, readCount: readCountForHoveredIndicator, participantCount: participantCount, 
-                            /* @conditional-compile-remove(attachment-download) @conditional-compile-remove(attachment-upload) */ actionsForAttachment: (_a = attachmentOptions === null || attachmentOptions === void 0 ? void 0 : attachmentOptions.downloadOptions) === null || _a === void 0 ? void 0 : _a.actionsForAttachment, inlineImageOptions: inlineImageOptions, 
-                            /* @conditional-compile-remove(date-time-customization) */ onDisplayDateTimeString: onDisplayDateTimeString, 
-                            /* @conditional-compile-remove(mention) */ mentionOptions: mentionOptions, 
-                            /* @conditional-compile-remove(attachment-download) @conditional-compile-remove(attachment-upload) */ onRenderAttachmentDownloads: onRenderAttachmentDownloads, 
-                            /* @conditional-compile-remove(rich-text-editor) */ richTextEditor: richTextEditor }));
-                    })))));
+                        return (React.createElement(MemoChatMessageComponentWrapper, Object.assign({}, message, { userId: userId, key: message.key, styles: styles, shouldOverlapAvatarAndMessage: isNarrow, strings: strings, onRenderAvatar: onRenderAvatar, onRenderMessage: onRenderMessage, onRenderMessageStatus: onRenderMessageStatus, defaultStatusRenderer: defaultStatusRenderer, onActionButtonClick: onActionButtonClickMemo, readCount: readCountForHoveredIndicator, participantCount: participantCount, 
+                            /* @conditional-compile-remove(file-sharing-acs) */
+                            actionsForAttachment: (_a = attachmentOptions === null || attachmentOptions === void 0 ? void 0 : attachmentOptions.downloadOptions) === null || _a === void 0 ? void 0 : _a.actionsForAttachment, inlineImageOptions: inlineImageOptions, 
+                            /* @conditional-compile-remove(date-time-customization) */
+                            onDisplayDateTimeString: onDisplayDateTimeString, 
+                            /* @conditional-compile-remove(mention) */
+                            mentionOptions: mentionOptions, 
+                            /* @conditional-compile-remove(file-sharing-acs) */
+                            onRenderAttachmentDownloads: onRenderAttachmentDownloads, 
+                            /* @conditional-compile-remove(rich-text-editor) */
+                            richTextEditorOptions: richTextEditorOptions })));
+                    }))))));
 };
 const MemoChatMessageComponentWrapper = React.memo((obj) => {
     return React.createElement(ChatMessageComponentWrapper, Object.assign({}, obj));