[Chat] Remove AttachmentMetadata

change-beta/@azure-communication-react-e4833c07-1bee-49be-ace6-f059887ff1d6.json

@@ -0,0 +1,9 @@
+{
+  "type": "minor",
+  "area": "improvement",
+  "workstream": "InlineImage",
+  "comment": "Remove AttachmentMetadata",
+  "packageName": "@azure/communication-react",
+  "email": "107075081+Leah-Xia-Microsoft@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

change/@azure-communication-react-e4833c07-1bee-49be-ace6-f059887ff1d6.json

@@ -0,0 +1,9 @@
+{
+  "type": "minor",
+  "area": "improvement",
+  "workstream": "InlineImage",
+  "comment": "Remove AttachmentMetadata",
+  "packageName": "@azure/communication-react",
+  "email": "107075081+Leah-Xia-Microsoft@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

packages/chat-component-bindings/src/messageThreadSelector.ts

@@ -29,7 +29,7 @@ import { DEFAULT_DATA_LOSS_PREVENTION_POLICY_URL } from './utils/constants';
 import { ACSKnownMessageType } from './utils/constants';
 import { updateMessagesWithAttached } from './utils/updateMessagesWithAttached';
 /* @conditional-compile-remove(file-sharing) */
-import { FileMetadata } from '@internal/react-components';
+import { AttachmentMetadata } from '@internal/react-components';
 /* @conditional-compile-remove(file-sharing) */
 import { ChatAttachmentType } from '@azure/communication-chat';
 import { ChatAttachment } from '@azure/communication-chat';
@@ -63,7 +63,7 @@ const memoizedAllConvertChatMessage = memoizeFnAll(
 );
 
 /* @conditional-compile-remove(file-sharing) */
-const extractAttachedFilesMetadata = (metadata: Record<string, string>): FileMetadata[] => {
+const extractAttachedFilesMetadata = (metadata: Record<string, string>): AttachmentMetadata[] => {
   const fileMetadata = metadata.fileSharingMetadata;
   if (!fileMetadata) {
     return [];
@@ -79,18 +79,17 @@ const extractAttachedFilesMetadata = (metadata: Record<string, string>): FileMet
 const extractTeamsAttachmentsMetadata = (
   attachments: ChatAttachment[]
 ): {
-  /* @conditional-compile-remove(file-sharing) */ files: FileMetadata[];
+  /* @conditional-compile-remove(file-sharing) */ files: AttachmentMetadata[];
 } => {
   /* @conditional-compile-remove(file-sharing) */
-  const files: FileMetadata[] = [];
+  const files: AttachmentMetadata[] = [];
   attachments.forEach((attachment) => {
     const attachmentType = mapAttachmentType(attachment.attachmentType);
     /* @conditional-compile-remove(file-sharing) */
     const contentType = extractAttachmentContentTypeFromName(attachment.name);
     /* @conditional-compile-remove(file-sharing) */
     if (attachmentType === 'file') {
       files.push({
-        attachmentType: attachmentType,
         id: attachment.id,
         name: attachment.name ?? '',
         extension: contentType ?? '',
@@ -140,9 +139,7 @@ const mapAttachmentType = (attachmentType: ChatAttachmentType): AttachmentType =
 
 /* @conditional-compile-remove(file-sharing) */
 const extractAttachmentUrl = (attachment: ChatAttachment): string => {
-  /* @conditional-compile-remove(file-sharing) */
-  return attachment.attachmentType === 'file' && attachment.previewUrl ? attachment.previewUrl : attachment.url || '';
-  return attachment.url || '';
+  return attachment.previewUrl ? attachment.previewUrl : attachment.url || '';
 };
 const processChatMessageContent = (message: ChatMessageWithStatus): string | undefined => {
   let content = message.content?.message;
@@ -212,10 +209,10 @@ const extractAttachmentContentTypeFromName = (name?: string): string => {
 const extractAttachmentsMetadata = (
   message: ChatMessageWithStatus
 ): {
-  /* @conditional-compile-remove(file-sharing) */ files: FileMetadata[];
+  /* @conditional-compile-remove(file-sharing) */ files: AttachmentMetadata[];
 } => {
   /* @conditional-compile-remove(file-sharing) */
-  let files: FileMetadata[] = [];
+  let files: AttachmentMetadata[] = [];
 
   /* @conditional-compile-remove(file-sharing) */
   if (message.metadata) {

packages/communication-react/review/beta/communication-react.api.md

@@ -149,7 +149,14 @@ export type AreParamEqual<A extends (props: any) => JSX.Element | undefined, B e
 export type AreTypeEqual<A, B> = A extends B ? (B extends A ? true : false) : false;
 
 // @beta
-export type AttachmentMetadata = FileMetadata;
+export interface AttachmentMetadata {
+    extension: string;
+    id: string;
+    name: string;
+    // (undocumented)
+    payload?: Record<string, string>;
+    url: string;
+}
 
 // @public
 export type AvatarPersonaData = {
@@ -1782,7 +1789,7 @@ export interface ChatMessage extends MessageCommon {
     // (undocumented)
     failureReason?: string;
     // @beta
-    files?: FileMetadata[];
+    files?: AttachmentMetadata[];
     // (undocumented)
     messageType: 'chat';
     metadata?: Record<string, string>;
@@ -2869,18 +2876,6 @@ export interface FileDownloadError {
 // @beta
 export type FileDownloadHandler = (userId: string, fileMetadata: AttachmentMetadata) => Promise<URL | FileDownloadError>;
 
-// @beta
-export interface FileMetadata {
-    // (undocumented)
-    attachmentType: 'file';
-    extension: string;
-    id: string;
-    name: string;
-    // (undocumented)
-    payload?: Record<string, string>;
-    url: string;
-}
-
 // @beta
 export interface FileSharingOptions {
     accept?: string;

packages/communication-react/src/index.ts

@@ -335,8 +335,6 @@ export type {
 } from '../../react-components/src';
 /* @conditional-compile-remove(file-sharing) */
 export type { AttachmentMetadata } from '../../react-components/src';
-/* @conditional-compile-remove(file-sharing) */
-export type { FileMetadata } from '../../react-components/src';
 /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
 export type { ChatAttachmentType } from '../../react-components/src';
 /* @conditional-compile-remove(image-overlay) */

packages/react-components/review/beta/react-components.api.md

@@ -66,7 +66,14 @@ export type AnnouncerProps = {
 };
 
 // @beta
-export type AttachmentMetadata = FileMetadata;
+export interface AttachmentMetadata {
+    extension: string;
+    id: string;
+    name: string;
+    // (undocumented)
+    payload?: Record<string, string>;
+    url: string;
+}
 
 // @internal
 export type _AudioIssue = 'NoLocalAudio' | 'NoRemoteAudio' | 'Echo' | 'AudioNoise' | 'LowVolume' | 'AudioStoppedUnexpectedly' | 'DistortedSpeech' | 'AudioInterruption' | 'OtherIssues';
@@ -467,7 +474,7 @@ export interface ChatMessage extends MessageCommon {
     // (undocumented)
     failureReason?: string;
     // @beta
-    files?: FileMetadata[];
+    files?: AttachmentMetadata[];
     // (undocumented)
     messageType: 'chat';
     metadata?: Record<string, string>;
@@ -1198,18 +1205,6 @@ export interface FileDownloadError {
 // @beta
 export type FileDownloadHandler = (userId: string, fileMetadata: AttachmentMetadata) => Promise<URL | FileDownloadError>;
 
-// @beta
-export interface FileMetadata {
-    // (undocumented)
-    attachmentType: 'file';
-    extension: string;
-    id: string;
-    name: string;
-    // (undocumented)
-    payload?: Record<string, string>;
-    url: string;
-}
-
 // @internal
 export interface _FileUploadCardsStrings {
     removeFile: string;

packages/react-components/review/stable/react-components.api.md

@@ -56,7 +56,11 @@ export type AnnouncerProps = {
 };
 
 // @beta
-export type AttachmentMetadata = FileMetadata;
+export interface AttachmentMetadata {
+    extension: string;
+    name: string;
+    url: string;
+}
 
 // @public
 export interface BaseCustomStyles {
@@ -970,13 +974,6 @@ export interface FileDownloadError {
 // @beta
 export type FileDownloadHandler = (userId: string, fileMetadata: AttachmentMetadata) => Promise<URL | FileDownloadError>;
 
-// @beta
-export interface FileMetadata {
-    extension: string;
-    name: string;
-    url: string;
-}
-
 // @internal
 export interface _FileUploadCardsStrings {
     removeFile: string;

packages/react-components/src/components/ChatMessage/ChatMessageComponentAsEditBox.tsx

@@ -15,7 +15,7 @@ import { useChatMyMessageStyles } from '../styles/MessageThread.styles';
 import { ChatMessage } from '../../types';
 import { _FileUploadCards } from '../FileUploadCards';
 /* @conditional-compile-remove(file-sharing) */
-import { FileMetadata } from '../FileDownloadCards';
+import { AttachmentMetadata } from '../FileDownloadCards';
 import {
   chatMessageFailedTagStyle,
   editChatMessageFailedTagStyle,
@@ -38,7 +38,7 @@ export type ChatMessageComponentAsEditBoxProps = {
     metadata?: Record<string, string>,
     options?: {
       /* @conditional-compile-remove(file-sharing) */
-      attachmentMetadata?: FileMetadata[];
+      attachmentMetadata?: AttachmentMetadata[];
     }
   ) => void;
   message: ChatMessage;

packages/react-components/src/components/FileDownloadCards.test.tsx

@@ -3,7 +3,6 @@
 
 import React from 'react';
 import { AttachmentMetadata, _FileDownloadCards } from './FileDownloadCards';
-import { FileMetadata } from './FileDownloadCards';
 import { render, screen } from '@testing-library/react';
 import { registerIcons } from '@fluentui/react';
 
@@ -19,13 +18,13 @@ describe('FileDownloadCards should be rendered properly', () => {
   });
 
   it('should render if it is FileSharingMetadata', async () => {
-    const metadata = {
+    const metadata: AttachmentMetadata = {
       name: 'MockFileCard',
       extension: 'docx',
       url: 'mockUrl',
-      id: 'mockId',
-      attachmentType: 'file'
-    } as FileMetadata;
+      /* @conditional-compile-remove(file-sharing) */
+      id: 'mockId'
+    };
 
     const props = {
       userId: 'MockUserId',

packages/react-components/src/components/FileDownloadCards.tsx

@@ -26,9 +26,7 @@ export type ChatAttachmentType =
  *
  * @beta
  */
-export interface FileMetadata {
-  /* @conditional-compile-remove(file-sharing) */
-  attachmentType: 'file';
+export interface AttachmentMetadata {
   /**
    * Extension hint, useful for rendering a specific icon.
    * An unknown or empty extension will be rendered as a generic icon.
@@ -55,12 +53,6 @@ export interface FileMetadata {
   payload?: Record<string, string>;
 }
 
-/**
- * Metadata containing information about the uploaded file.
- * @beta
- */
-export type AttachmentMetadata = FileMetadata;
-
 /**
  * Strings of _FileDownloadCards that can be overridden.
  *
@@ -166,16 +158,10 @@ export const _FileDownloadCards = (props: _FileDownloadCardsProps): JSX.Element
     [props.strings?.downloadFile, localeStrings.downloadFile]
   );
 
-  const isFileSharingAttachment = useCallback((attachment: AttachmentMetadata): boolean => {
-    /* @conditional-compile-remove(file-sharing) */
-    return attachment.attachmentType === 'file';
-    return false;
-  }, []);
-
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
   const isShowDownloadIcon = useCallback((attachment: AttachmentMetadata): boolean => {
     /* @conditional-compile-remove(file-sharing) */
-    return attachment.attachmentType === 'file' && attachment.payload?.teamsFileAttachment !== 'true';
+    return attachment.payload?.teamsFileAttachment !== 'true';
     return true;
   }, []);
 
@@ -184,13 +170,13 @@ export const _FileDownloadCards = (props: _FileDownloadCardsProps): JSX.Element
       const fileGroupLocaleString = props.strings?.fileCardGroupMessage ?? localeStrings.fileCardGroupMessage;
       /* @conditional-compile-remove(file-sharing) */
       return _formatString(fileGroupLocaleString, {
-        fileCount: `${fileMetadata?.filter(isFileSharingAttachment).length ?? 0}`
+        fileCount: `${fileMetadata?.length ?? 0}`
       });
       return _formatString(fileGroupLocaleString, {
         fileCount: `${fileMetadata?.length ?? 0}`
       });
     },
-    [props.strings?.fileCardGroupMessage, localeStrings.fileCardGroupMessage, fileMetadata, isFileSharingAttachment]
+    [props.strings?.fileCardGroupMessage, localeStrings.fileCardGroupMessage, fileMetadata]
   );
 
   const fileDownloadHandler = useCallback(
@@ -217,7 +203,7 @@ export const _FileDownloadCards = (props: _FileDownloadCardsProps): JSX.Element
   if (
     !fileMetadata ||
     fileMetadata.length === 0 ||
-    /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ !fileMetadata.some(isFileSharingAttachment)
+    /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ !fileMetadata
   ) {
     return <></>;
   }
@@ -226,35 +212,26 @@ export const _FileDownloadCards = (props: _FileDownloadCardsProps): JSX.Element
     <div style={fileDownloadCardsStyle} data-ui-id="file-download-card-group">
       <_FileCardGroup ariaLabel={fileCardGroupDescription()}>
         {fileMetadata &&
-          fileMetadata
-            .filter((attachment) => {
-              /* @conditional-compile-remove(file-sharing) */
-              return isFileSharingAttachment(attachment);
-              return true;
-            })
-            .map((file) => file as unknown as FileMetadata)
-            .map((file) => (
-              <TooltipHost content={downloadFileButtonString()} key={file.name}>
-                <_FileCard
-                  fileName={file.name}
-                  key={file.name}
-                  fileExtension={file.extension}
-                  actionIcon={
-                    showSpinner ? (
-                      <Spinner size={SpinnerSize.medium} aria-live={'polite'} role={'status'} />
-                    ) : true &&
-                      /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ isShowDownloadIcon(
-                        file as unknown as AttachmentMetadata
-                      ) ? (
-                      <IconButton className={iconButtonClassName} ariaLabel={downloadFileButtonString()}>
-                        <DownloadIconTrampoline />
-                      </IconButton>
-                    ) : undefined
-                  }
-                  actionHandler={() => fileDownloadHandler(userId, file as unknown as AttachmentMetadata)}
-                />
-              </TooltipHost>
-            ))}
+          fileMetadata.map((file) => (
+            <TooltipHost content={downloadFileButtonString()} key={file.name}>
+              <_FileCard
+                fileName={file.name}
+                key={file.name}
+                fileExtension={file.extension}
+                actionIcon={
+                  showSpinner ? (
+                    <Spinner size={SpinnerSize.medium} aria-live={'polite'} role={'status'} />
+                  ) : true &&
+                    /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ isShowDownloadIcon(file) ? (
+                    <IconButton className={iconButtonClassName} ariaLabel={downloadFileButtonString()}>
+                      <DownloadIconTrampoline />
+                    </IconButton>
+                  ) : undefined
+                }
+                actionHandler={() => fileDownloadHandler(userId, file)}
+              />
+            </TooltipHost>
+          ))}
       </_FileCardGroup>
     </div>
   );

packages/react-components/src/types/ChatMessage.ts

@@ -4,7 +4,7 @@
 import { MessageStatus } from '@internal/acs-ui-common';
 import { CommunicationParticipant } from './CommunicationParticipant';
 /* @conditional-compile-remove(file-sharing) */
-import { FileMetadata } from '../components/FileDownloadCards';
+import { AttachmentMetadata } from '../components/FileDownloadCards';
 
 /**
  * Indicate whether a chat message should be displayed merged with the message before / after it.
@@ -75,9 +75,9 @@ export interface ChatMessage extends MessageCommon {
   /**
    * @beta
    * A list of file attachments for the message.
-   * {@link FileMetadata}
+   * {@link AttachmentMetadata}
    */
-  files?: FileMetadata[];
+  files?: AttachmentMetadata[];
 }
 
 /**