@azure/communication-react 1.14.1-alpha-202403290012 → 1.15.0-beta.1

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

@@ -4,7 +4,7 @@ import { BaseCustomStyles, ChatMessage, CustomMessage, SystemMessage, OnRenderAv
 import { BlockedMessage } from '../types';
 import { MessageStatusIndicatorProps } from './MessageStatusIndicator';
 import { MessageStatus } from "../../../acs-ui-common/src";
-import { AttachmentMetadata, AttachmentOptions } from '../types/Attachment';
+import { AttachmentMetadata, FileDownloadHandler } from '../types/Attachment';
 import { MentionOptions } from './MentionPopover';
 import { InlineImageOptions } from './ChatMessage/ChatMessageContent';
 /**
@@ -96,15 +96,13 @@ export interface MessageThreadStrings {
     actionMenuMoreOptions?: string;
     /** Aria label to announce when a message is deleted */
     messageDeletedAnnouncementAriaLabel: string;
-    /** String for download attachment button in attachment card */
+    /** String for download file button in attachment card */
     downloadAttachment: string;
-    /** String for open attachment button in attachment card */
-    openAttachment: string;
     /** String for policy violation message removal */
     blockedWarningText: string;
     /** String for policy violation message removal details link */
     blockedWarningLinkText: string;
-    /** String for aria text in attachment card group*/
+    /** String for aria text in file attachment group*/
     attachmentCardGroupMessage: string;
 }
 /**
@@ -128,7 +126,7 @@ export type MessageRenderer = (props: MessageProps) => JSX.Element;
  * @public
  * Callback function run when a message is updated.
  */
-export type UpdateMessageCallback = (messageId: string, content: string, options?: {
+export type UpdateMessageCallback = (messageId: string, content: string, /* @conditional-compile-remove(file-sharing) */ options?: {
     metadata?: Record<string, string>;
     attachmentMetadata?: AttachmentMetadata[];
 }) => Promise<void>;
@@ -232,10 +230,10 @@ export type MessageThreadProps = {
      */
     onRenderMessage?: (messageProps: MessageProps, messageRenderer?: MessageRenderer) => JSX.Element;
     /**
-     * Optional callback to render attachments in the message component.
+     * Optional callback to render attached files in the message component.
      * @beta
      */
-    onRenderAttachmentDownloads?: (userId: string, message: ChatMessage) => JSX.Element;
+    onRenderFileDownloads?: (userId: string, message: ChatMessage) => JSX.Element;
     /**
      * Optional callback to edit a message.
      *
@@ -279,10 +277,11 @@ export type MessageThreadProps = {
     strings?: Partial<MessageThreadStrings>;
     /**
      * @beta
-     * Optional attachment options, which defines behvaiour for uploading and downloading attachments.
-     * As this moment, the uploadOptions would be ignored and this option is intended for download only.
+     * Optional function called when someone clicks on the file download icon.
+     * If file attachments are defined in the `message.metadata` property using the `fileSharingMetadata` key,
+     * this function will be called with the data inside `fileSharingMetadata` key.
      */
-    attachmentOptions?: AttachmentOptions;
+    fileDownloadHandler?: FileDownloadHandler;
     /**
      * Optional function to provide customized date format.
      * @beta

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

@@ -27,13 +27,7 @@ import { ChatMessageComponentWrapper } from './ChatMessage/ChatMessageComponentW
 import { MessageStatusIndicatorInternal } from './MessageStatusIndicatorInternal';
 import { Announcer } from './Announcer';
 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.
@@ -60,8 +54,7 @@ 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
@@ -76,35 +69,36 @@ 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') {
@@ -158,8 +152,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);
 };
@@ -173,10 +167,8 @@ export const MessageThreadWrapper = (props) => {
     onDisplayDateTimeString, 
     /* @conditional-compile-remove(mention) */
     mentionOptions, inlineImageOptions, 
-    /* @conditional-compile-remove(attachment-download) @conditional-compile-remove(attachment-upload) */
-    attachmentOptions, 
-    /* @conditional-compile-remove(attachment-download) @conditional-compile-remove(attachment-upload) */
-    onRenderAttachmentDownloads } = props;
+    /* @conditional-compile-remove(file-sharing) */
+    onRenderFileDownloads } = 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);
@@ -237,12 +229,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);
@@ -284,14 +276,10 @@ 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) {
@@ -299,10 +287,7 @@ 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,8 +308,7 @@ 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) {
@@ -340,9 +324,7 @@ 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);
                     }
@@ -369,8 +351,7 @@ 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(() => {
@@ -440,12 +421,10 @@ 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
@@ -473,54 +452,38 @@ 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 },
+                latestDeletedMessageId && React.createElement(Announcer, { key: latestDeletedMessageId, announcementString: deletedMessageAriaLabel, ariaLive: 'assertive' }),
                 React.createElement(Chat
                 // styles?.chatContainer used in className and style prop as style prop can't handle CSS selectors
                 , { 
                     // 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' })),
-                    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 })));
-                    }))))));
+                    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)) }, messagesToDisplay.map((message) => {
+                    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) */ fileDownloadHandler: props.fileDownloadHandler, inlineImageOptions: inlineImageOptions, 
+                        /* @conditional-compile-remove(date-time-customization) */ onDisplayDateTimeString: onDisplayDateTimeString, 
+                        /* @conditional-compile-remove(mention) */ mentionOptions: mentionOptions, 
+                        /* @conditional-compile-remove(file-sharing) */ onRenderFileDownloads: onRenderFileDownloads }));
+                })))));
 };
 const MemoChatMessageComponentWrapper = React.memo((obj) => {
     return React.createElement(ChatMessageComponentWrapper, Object.assign({}, obj));