@azure/communication-react 1.10.1-alpha-202311290014 → 1.11.0-alpha-202312020013

package/dist/communication-react.d.ts

@@ -238,7 +238,7 @@ export declare type AreParamEqual<A extends (props: any) => JSX.Element | undefi
 export declare type AreTypeEqual<A, B> = A extends B ? (B extends A ? true : false) : false;
 
 /**
- * Meta Data of the attachment object returned by the ACS SDK.
+ * Metadata of the attachment object returned by the ACS SDK.
  * @beta
  */
 export declare interface AttachmentDownloadResult {
@@ -246,6 +246,12 @@ export declare interface AttachmentDownloadResult {
     blobUrl: string;
 }
 
+/**
+ * Metadata containing information about the uploaded file.
+ * @beta
+ */
+export declare type AttachmentMetadata = FileMetadata | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ InlineImageMetadata;
+
 /**
  * Custom data attributes for displaying avatar for a user.
  *
@@ -425,36 +431,6 @@ export declare interface BaseCustomStyles {
     root?: IStyle;
 }
 
-/**
- * Base interface that all Meta Data should extend.
- * Typically used for ACS to ACS file transfers.
- * @beta
- */
-export declare interface BaseFileMetadata {
-    /**
-     * File name to be displayed.
-     */
-    name: string;
-    /**
-     * Extension is used for rendering the file icon.
-     * An unknown extension will be rendered as a generic icon.
-     * Example: `jpeg`
-     */
-    extension: string;
-    /**
-     * Download URL for the file.
-     */
-    url: string;
-    /**
-     * Unique ID of the file.
-     */
-    id: string;
-    /**
-     * Attachment Type
-     */
-    attachmentType: FileMetadataAttachmentType;
-}
-
 /**
  * Content blocked message type.
  *
@@ -2862,7 +2838,7 @@ export declare interface CallWithChatAdapterManagement {
     /** @beta */
     registerActiveFileUploads: (files: File[]) => FileUploadManager[];
     /** @beta */
-    registerCompletedFileUploads: (metadata: FileMetadata[]) => FileUploadManager[];
+    registerCompletedFileUploads: (metadata: AttachmentMetadata[]) => FileUploadManager[];
     /** @beta */
     clearFileUploads: () => void;
     /** @beta */
@@ -2872,7 +2848,7 @@ export declare interface CallWithChatAdapterManagement {
     /** @beta */
     updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
     /** @beta */
-    updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
+    updateFileUploadMetadata: (id: string, metadata: AttachmentMetadata) => void;
     downloadAttachments: (options: {
         attachmentUrls: Record<string, string>;
     }) => Promise<AttachmentDownloadResult[]>;
@@ -4041,7 +4017,7 @@ export declare interface ChatAdapterThreadManagement {
      * Update a message content.
      */
     updateMessage(messageId: string, content: string, metadata?: Record<string, string>, options?: {
-        attachedFilesMetadata?: FileMetadata[];
+        attachmentMetadata?: AttachmentMetadata[];
     }): Promise<void>;
     /**
      * Delete a message in the thread.
@@ -4076,6 +4052,12 @@ export declare type ChatAdapterUiState = {
     fileUploads?: FileUploadsUiState;
 };
 
+/**
+ * Represents the type of attachment
+ * @beta
+ */
+export declare type ChatAttachmentType = 'file' | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ 'inlineImage' | 'unknown';
+
 /**
  * Common props for selectors for {@link ChatClientState}.
  *
@@ -4332,7 +4314,7 @@ export declare type ChatHandlers = {
     onLoadPreviousChatMessages: (messagesToLoad: number) => Promise<boolean>;
     onUpdateMessage: (messageId: string, content: string, options?: {
         metadata?: Record<string, string>;
-        attachedFilesMetadata?: FileMetadata[];
+        attachmentMetadata?: AttachmentMetadata[];
     }) => Promise<void>;
     onDeleteMessage: (messageId: string) => Promise<void>;
 };
@@ -4362,10 +4344,16 @@ export declare interface ChatMessage extends MessageCommon {
     metadata?: Record<string, string>;
     /**
      * @beta
-     * A list of files attached to the message.
+     * A list of file attachments for the message.
      * {@link FileMetadata}
      */
-    attachedFilesMetadata?: FileMetadata[];
+    files?: FileMetadata[];
+    /**
+     * @beta
+     * A list of inline images embedded in the message.
+     * {@link InlineImageMetadata}
+     */
+    inlineImages?: InlineImageMetadata[];
 }
 
 /**
@@ -6573,28 +6561,35 @@ export declare interface FileDownloadError {
  *
  * ```
  * @param userId - The user ID of the user downloading the file.
- * @param fileMetadata - The {@link FileMetadata} containing file `url`, `extension` and `name`.
+ * @param fileMetadata - The {@link AttachmentMetadata} containing file `url`, `extension` and `name`.
  */
-export declare type FileDownloadHandler = (userId: string, fileMetadata: FileMetadata) => Promise<URL | FileDownloadError>;
+export declare type FileDownloadHandler = (userId: string, fileMetadata: AttachmentMetadata) => Promise<URL | FileDownloadError>;
 
 /**
- * Meta Data containing information about the uploaded file.
- * @beta
- */
-export declare type FileMetadata = FileSharingMetadata | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ ImageFileMetadata;
-
-/**
- * @beta
- */
-export declare type FileMetadataAttachmentType = 'fileSharing' | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ 'inlineImage' | 'unknown';
-
-/**
- * Meta Data containing basic information about the uploaded file.
- * Typically used for ACS to ACS file transfers.
+ * Metadata containing basic information about the uploaded file.
+ *
  * @beta
  */
-export declare interface FileSharingMetadata extends BaseFileMetadata {
-    attachmentType: 'fileSharing';
+export declare interface FileMetadata {
+    attachmentType: 'file';
+    /**
+     * Extension hint, useful for rendering a specific icon.
+     * An unknown or empty extension will be rendered as a generic icon.
+     * Example: `pdf`
+     */
+    extension: string;
+    /**
+     * Unique ID of the file.
+     */
+    id: string;
+    /**
+     * File name to be displayed.
+     */
+    name: string;
+    /**
+     * Download URL for the file.
+     */
+    url: string;
     payload?: Record<string, string>;
 }
 
@@ -6635,12 +6630,12 @@ export declare interface FileSharingOptions {
  */
 export declare interface FileUploadAdapter {
     registerActiveFileUploads: (files: File[]) => FileUploadManager[];
-    registerCompletedFileUploads: (metadata: FileMetadata[]) => FileUploadManager[];
+    registerCompletedFileUploads: (metadata: AttachmentMetadata[]) => FileUploadManager[];
     clearFileUploads: () => void;
     cancelFileUpload: (id: string) => void;
     updateFileUploadProgress: (id: string, progress: number) => void;
     updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
-    updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
+    updateFileUploadMetadata: (id: string, metadata: AttachmentMetadata) => void;
 }
 
 /**
@@ -6663,7 +6658,7 @@ export declare type FileUploadHandler = (userId: string, fileUploads: FileUpload
 
 /**
  * A wrapper object for a file that is being uploaded.
- * Allows mmanaging file uploads by providing common functions for updating the
+ * Allows managing file uploads by providing common functions for updating the
  * upload progress, canceling an upload, completing an upload etc.
  * @beta
  */
@@ -6684,9 +6679,9 @@ export declare interface FileUploadManager {
     /**
      * Mark the upload as complete.
      * Requires the `metadata` param containing uploaded file information.
-     * @param metadata - {@link FileMetadata}
+     * @param metadata - {@link AttachmentMetadata}
      */
-    notifyUploadCompleted: (metadata: FileMetadata) => void;
+    notifyUploadCompleted: (metadata: AttachmentMetadata) => void;
     /**
      * Mark the upload as failed.
      * @param message - An error message that can be displayed to the user.
@@ -6695,7 +6690,7 @@ export declare interface FileUploadManager {
 }
 
 /**
- * Contains the state attibutes of a file upload like name, progress etc.
+ * Contains the state attributes of a file upload like name, progress etc.
  * @beta
  */
 export declare interface FileUploadState {
@@ -6713,9 +6708,9 @@ export declare interface FileUploadState {
      */
     progress: number;
     /**
-     * Meta Data {@link FileMetadata} containing information about the uploaded file.
+     * Metadata {@link AttachmentMetadata} containing information about the uploaded file.
      */
-    metadata?: FileMetadata;
+    metadata?: AttachmentMetadata;
     /**
      * Error message to be displayed to the user if the upload fails.
      */
@@ -6976,15 +6971,6 @@ export declare interface _Identifiers {
     mentionSuggestionItem: string;
 }
 
-/**
- * Meta Data containing data for images.
- * @beta
- */
-export declare interface ImageFileMetadata extends BaseFileMetadata {
-    attachmentType: 'inlineImage';
-    previewUrl?: string;
-}
-
 /**
  * Component to render a fullscreen modal for a selected image.
  *
@@ -7104,6 +7090,24 @@ export declare interface IncomingCallState {
     endTime?: Date;
 }
 
+/**
+ * Metadata for rendering images inline with a message.
+ * This does not include images attached as files.
+ * @beta
+ */
+export declare interface InlineImageMetadata {
+    attachmentType: 'inlineImage';
+    /**
+     * Unique ID of the attachment.
+     */
+    id: string;
+    previewUrl?: string;
+    /**
+     * Download URL for the full resolution version.
+     */
+    url: string;
+}
+
 /**
  * Callback for {@link CallAdapterSubscribers} 'isCaptionLanguageChanged' event.
  *
@@ -7708,16 +7712,16 @@ export declare type MessageThreadProps = {
      */
     onRenderMessage?: (messageProps: MessageProps, messageRenderer?: MessageRenderer) => JSX.Element;
     /**
-     * Optional callback to render uploaded files in the message component.
+     * Optional callback to render attached files in the message component.
      * @beta
      */
     onRenderFileDownloads?: (userId: string, message: ChatMessage) => JSX.Element;
     /**
      * Optional callback to retrieve the inline image in a message.
-     * @param attachment - FileMetadata object we want to render
+     * @param attachment - AttachmentMetadata object we want to render
      * @beta
      */
-    onFetchAttachments?: (attachments: FileMetadata[]) => Promise<AttachmentDownloadResult[]>;
+    onFetchAttachments?: (attachments: AttachmentMetadata[]) => Promise<AttachmentDownloadResult[]>;
     /**
      * Optional callback to edit a message.
      *
@@ -9818,7 +9822,7 @@ export declare interface UnsupportedOperatingSystemStrings {
  */
 export declare type UpdateMessageCallback = (messageId: string, content: string, options?: {
     metadata?: Record<string, string>;
-    attachedFilesMetadata?: FileMetadata[];
+    attachmentMetadata?: AttachmentMetadata[];
 }) => Promise<void>;
 
 /**