@azure/communication-react 1.11.1-alpha-202312210012 → 1.11.1-alpha-202312220012

package/dist/communication-react.d.ts

@@ -241,18 +241,24 @@ export declare type AreTypeEqual<A, B> = A extends B ? (B extends A ? true : fal
 
 /**
  * Metadata of the attachment object returned by the ACS SDK.
- * @beta
+ * @public
  */
 export declare interface AttachmentDownloadResult {
+    /**
+     * Unique ID of the attachment.
+     */
     attachmentId: string;
+    /**
+     * Blob URL for the attachment.
+     */
     blobUrl: string;
 }
 
 /**
  * Metadata containing information about the uploaded file.
- * @beta
+ * @public
  */
-export declare type AttachmentMetadata = FileMetadata | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ InlineImageMetadata;
+export declare type AttachmentMetadata = InlineImageMetadata | /* @conditional-compile-remove(file-sharing) */ FileMetadata;
 
 /**
  * Custom data attributes for displaying avatar for a user.
@@ -372,7 +378,8 @@ export declare type AzureCommunicationChatAdapterArgs = {
 
 /**
  * Configuration options to include when creating AzureCommunicationChatAdapter.
- * @beta
+ *
+ * @public
  */
 export declare type AzureCommunicationChatAdapterOptions = {
     credential?: CommunicationTokenCredential;
@@ -2392,7 +2399,7 @@ export declare type CallErrors = {
  *
  * @public
  */
-export declare type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'TeamsCall.addParticipant' | 'VideoEffectsFeature.startEffects' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallAgent.handlePushNotification' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admit' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.rejectParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admitAll' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteAllRemoteParticipants' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.setConstraints';
+export declare type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'TeamsCall.addParticipant' | 'VideoEffectsFeature.startEffects' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallAgent.handlePushNotification' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admit' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.rejectParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admitAll' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteAllRemoteParticipants' | 'Call.setConstraints';
 
 /**
  * Callback for {@link CallAdapterSubscribers} 'callIdChanged' event.
@@ -4222,9 +4229,9 @@ export declare type ChatAdapterUiState = {
 
 /**
  * Represents the type of attachment
- * @beta
+ * @public
  */
-export declare type ChatAttachmentType = 'file' | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ 'inlineImage' | 'unknown';
+export declare type ChatAttachmentType = 'inlineImage' | /* @conditional-compile-remove(file-sharing) */ 'file' | 'unknown';
 
 /**
  * Common props for selectors for {@link ChatClientState}.
@@ -4517,7 +4524,7 @@ export declare interface ChatMessage extends MessageCommon {
      */
     files?: FileMetadata[];
     /**
-     * @beta
+     * @public
      * A list of inline images embedded in the message.
      * {@link InlineImageMetadata}
      */
@@ -4558,20 +4565,20 @@ export declare type ChatReturnProps<Component extends (props: any) => JSX.Elemen
 /**
  * Custom Fluent theme palette used by chat related components in this library.
  *
- * @beta
+ * @public
  */
 export declare interface ChatTheme {
     /**
      * Custom Fluent theme palette used by chat related components in this library.
      *
-     * @beta
+     * @public
      */
     chatPalette: {
-        modalOverlayBlack: string;
-        modalTitleWhite: string;
-        modalButtonBackground: string;
-        modalButtonBackgroundHover: string;
-        modalButtonBackgroundActive: string;
+        imageGalleryOverlayBlack: string;
+        imageGalleryTitleWhite: string;
+        imageGalleryDefaultButtonBackground: string;
+        imageGalleryButtonBackgroundHover: string;
+        imageGalleryButtonBackgroundActive: string;
     };
 }
 
@@ -5869,7 +5876,7 @@ export declare interface CustomMessage extends MessageCommon {
  *
  * @public
  */
-export declare const darkTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
+export declare const darkTheme: PartialTheme & CallingTheme & ChatTheme;
 
 /**
  * @beta
@@ -7149,14 +7156,14 @@ export declare interface _Identifiers {
 /**
  * Component to render a fullscreen modal for a selected image.
  *
- * @beta
+ * @public
  */
 export declare const ImageGallery: (props: ImageGalleryProps) => JSX.Element;
 
 /**
  * Props for {@link ImageGallery}.
  *
- * @beta
+ * @public
  */
 export declare interface ImageGalleryImageProps {
     /** Image Url used to display the image in a large scale. */
@@ -7174,7 +7181,7 @@ export declare interface ImageGalleryImageProps {
 /**
  * Props for {@link ImageGallery}.
  *
- * @beta
+ * @public
  */
 export declare interface ImageGalleryProps {
     /**
@@ -7206,7 +7213,7 @@ export declare interface ImageGalleryProps {
 /**
  * Strings of {@link ImageGallery} that can be overridden.
  *
- * @beta
+ * @public
  */
 export declare interface ImageGalleryStrings {
     /**
@@ -7268,7 +7275,7 @@ export declare interface IncomingCallState {
 /**
  * Metadata for rendering images inline with a message.
  * This does not include images attached as files.
- * @beta
+ * @public
  */
 export declare interface InlineImageMetadata {
     attachmentType: 'inlineImage';
@@ -7381,7 +7388,7 @@ export declare interface JumpToNewMessageButtonProps {
  *
  * @public
  */
-export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
+export declare const lightTheme: PartialTheme & CallingTheme & ChatTheme;
 
 /**
  * Whether the stream is loading or not.
@@ -7896,7 +7903,7 @@ export declare type MessageThreadProps = {
     /**
      * Optional callback to retrieve the inline image in a message.
      * @param attachment - AttachmentMetadata object we want to render
-     * @beta
+     * @public
      */
     onFetchAttachments?: (attachments: AttachmentMetadata[]) => Promise<AttachmentDownloadResult[]>;
     /**
@@ -7959,7 +7966,7 @@ export declare type MessageThreadProps = {
     mentionOptions?: MentionOptions;
     /**
      * Optional callback called when an inline image is clicked.
-     * @beta
+     * @public
      */
     onInlineImageClicked?: (attachmentId: string, messageId: string) => Promise<void>;
 };