@azure/communication-react 1.7.1-alpha-202309010013 → 1.8.0-beta.1

package/dist/communication-react.d.ts

@@ -30,7 +30,6 @@ import { CallEndReason } from '@azure/communication-calling';
 import { CallerInfo } from '@azure/communication-calling';
 import { CallKind } from '@azure/communication-calling';
 import { CallState as CallState_2 } from '@azure/communication-calling';
-import { CapabilitiesChangeInfo } from '@azure/communication-calling';
 import { CaptionsResultType } from '@azure/communication-calling';
 import { ChatClient } from '@azure/communication-chat';
 import { ChatClientOptions } from '@azure/communication-chat';
@@ -76,7 +75,6 @@ import { MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
 import { MicrosoftTeamsUserKind } from '@azure/communication-common';
 import type { NetworkDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { PartialTheme } from '@fluentui/react';
-import { ParticipantCapabilities } from '@azure/communication-calling';
 import { ParticipantRole } from '@azure/communication-calling';
 import { PermissionConstraints } from '@azure/communication-calling';
 import { PersonaInitialsColor } from '@fluentui/react';
@@ -93,7 +91,6 @@ import { ScalingMode } from '@azure/communication-calling';
 import { SendMessageOptions } from '@azure/communication-chat';
 import { StartCallOptions } from '@azure/communication-calling';
 import { StartCaptionsOptions } from '@azure/communication-calling';
-import { SyntheticEvent } from 'react';
 import { TeamsCall } from '@azure/communication-calling';
 import { TeamsCallAgent } from '@azure/communication-calling';
 import { TeamsMeetingLinkLocator } from '@azure/communication-calling';
@@ -1134,10 +1131,6 @@ export declare interface CallAdapterSubscribers {
      * Subscribe function for 'transferRequested' event.
      */
     on(event: 'transferRequested', listener: TransferRequestedListener): void;
-    /**
-     * Unsubscribe function for 'capabilitiesChanged' event.
-     */
-    on(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
     /**
      * Unsubscribe function for 'participantsJoined' event.
      */
@@ -1206,10 +1199,6 @@ export declare interface CallAdapterSubscribers {
      * Unsubscribe function for 'transferRequested' event.
      */
     off(event: 'transferRequested', listener: TransferRequestedListener): void;
-    /**
-     * Unsubscribe function for 'capabilitiesChanged' event.
-     */
-    off(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
 }
 
 /**
@@ -1390,8 +1379,6 @@ export declare type CallCompositeIcons = {
     ControlButtonParticipants?: JSX.Element;
     ControlButtonScreenShareStart?: JSX.Element;
     ControlButtonScreenShareStop?: JSX.Element;
-    ControlButtonCameraProhibited?: JSX.Element;
-    ControlButtonMicProhibited?: JSX.Element;
     ControlButtonRaiseHand?: JSX.Element;
     ControlButtonLowerHand?: JSX.Element;
     RaiseHandContextualMenuItem?: JSX.Element;
@@ -1437,12 +1424,6 @@ export declare type CallCompositeIcons = {
     NoticePageAccessDeniedRoomsCall?: JSX.Element;
     BlurVideoBackground?: JSX.Element;
     RemoveVideoBackgroundEffect?: JSX.Element;
-    GalleryOptions?: JSX.Element;
-    SpeakerGalleryLayout?: JSX.Element;
-    FloatingLocalVideoGalleryLayout?: JSX.Element;
-    DefaultGalleryLayout?: JSX.Element;
-    FocusedContentGalleryLayout?: JSX.Element;
-    OverflowGalleryTop?: JSX.Element;
 };
 
 /**
@@ -1523,15 +1504,6 @@ export declare type CallCompositeOptions = {
      * @remarks if 'false' the local video tile will not be rendered.
      */
     localVideoTile?: boolean | LocalVideoTileOptions;
-    /**
-     * Options for controlling the starting layout of the composite's video gallery
-     */
-    galleryOptions?: {
-        /**
-         * Layout for the gallery when the call starts
-         */
-        layout?: VideoGalleryLayout;
-    };
 };
 
 /**
@@ -2097,34 +2069,6 @@ export declare interface CallCompositeStrings {
      * More details text of the page shown to the user when target participant id is malformed
      */
     participantIdIsMalformedMoreDetails?: string;
-    /**
-     * Controls label to move the overflow gallery around
-     */
-    moreButtonGalleryControlLabel?: string;
-    /**
-     * Label for the toggle to move the overflow gallery to the top
-     */
-    moreButtonGalleryPositionToggleLabel?: string;
-    /**
-     * Label for the selection of the speaker layout
-     */
-    moreButtonGallerySpeakerLayoutLabel?: string;
-    /**
-     * Label for the selection of the default (Gallery) layout
-     */
-    moreButtonGalleryDefaultLayoutLabel?: string;
-    /**
-     * Label for the selection of the floatingLocalVideo (Dynamic) layout
-     */
-    moreButtonGalleryFloatingLocalLayoutLabel?: string;
-    /**
-     * Label for the selection of the focusedContentLayout (Focused content) layout
-     */
-    moreButtonGalleryFocusedContentLayoutLabel?: string;
-    /**
-     * All strings for capability changed notification
-     */
-    capabilityChangedNotification?: CapabilityChangedNotificationStrings;
 }
 
 /**
@@ -2139,7 +2083,7 @@ export declare type CallControlDisplayType = 'default' | 'compact';
  *
  * @public
  */
-export declare type CallControlOptions = CommonCallControlOptions & {
+export declare type CallControlOptions = (CommonCallControlOptions & {
     /**
      * Show, Hide or Disable participants button during a call. This is the option only work for legacyControl bar.
      * @defaultValue true
@@ -2148,7 +2092,7 @@ export declare type CallControlOptions = CommonCallControlOptions & {
         disabled: boolean;
     };
     legacyControlBarExperience?: boolean;
-};
+});
 
 /**
  * Callback for {@link CallAdapterSubscribers} 'callEnded' event.
@@ -2257,7 +2201,7 @@ export declare type CallingHandlersOptions = {
 export declare type CallingReturnProps<Component extends (props: any) => JSX.Element> = GetCallingSelector<Component> extends (state: CallClientState, props: any) => any ? ReturnType<GetCallingSelector<Component>> & Common<CallingHandlers, Parameters<Component>[0]> : never;
 
 /**
- * Custom Fluent theme palette used by calling related components in this library.
+ * Custom Fluent theme pallete used by calling related components in this library.
  *
  * @public
  */
@@ -2446,10 +2390,6 @@ export declare interface CallState {
      * Transfer state of call
      */
     transfer: TransferFeature;
-    /**
-     * Proxy of {@link @azure/communication-calling#CapabilitiesFeature}.
-     */
-    capabilitiesFeature?: CapabilitiesFeatureState;
 }
 
 /**
@@ -2993,8 +2933,6 @@ export declare type CallWithChatCompositeIcons = {
     ControlButtonOptions?: JSX.Element;
     ControlButtonScreenShareStart?: JSX.Element;
     ControlButtonScreenShareStop?: JSX.Element;
-    ControlButtonCameraProhibited?: JSX.Element;
-    ControlButtonMicProhibited?: JSX.Element;
     ErrorBarCallCameraAccessDenied?: JSX.Element;
     ErrorBarCallCameraAlreadyInUse?: JSX.Element;
     ErrorBarCallLocalVideoFreeze?: JSX.Element;
@@ -3113,15 +3051,6 @@ export declare type CallWithChatCompositeOptions = {
      * if this is not supplied, the composite will not show a unsupported browser page.
      */
     onEnvironmentInfoTroubleshootingClick?: () => void;
-    /**
-     * Options for controlling the starting layout of the composite's video gallery
-     */
-    galleryOptions?: {
-        /**
-         * Layout for the gallery when the call starts
-         */
-        layout?: VideoGalleryLayout;
-    };
 };
 
 /**
@@ -3557,75 +3486,6 @@ export declare type CameraSitePermissionsStrings = SitePermissionsStrings;
  */
 export declare type CancelEditCallback = (messageId: string) => void;
 
-/**
- * Callback for {@link CallAdapterSubscribers} 'capabilitiesChanged' event.
- *
- * @beta
- */
-export declare type CapabilitiesChangedListener = (data: CapabilitiesChangeInfo) => void;
-
-/**
- * State only version of {@link @azure/communication-calling#CapabilitiesFeature}
- *
- * @beta
- */
-export declare interface CapabilitiesFeatureState {
-    /**
-     * Proxy of {@link @azure/communication-calling#CapabilitiesFeature.capabilities}.
-     */
-    capabilities: ParticipantCapabilities;
-    /**
-     * Proxy of the latest {@link @azure/communication-calling#CapabilitiesChangeInfo}
-     */
-    latestCapabilitiesChangeInfo: CapabilitiesChangeInfo;
-}
-
-/**
- * Strings for capability changed notification
- * @beta
- */
-export declare interface CapabilityChangedNotificationStrings {
-    /**
-     * Strings for 'turnVideoOn' capability
-     */
-    turnVideoOn?: {
-        /**
-         * Notification message shown to the user when capability to turn video on is lost due to a meeting option change
-         */
-        lostDueToMeetingOption?: string;
-        /**
-         * Notification message shown to the user when capability to turn video on is granted due to a meeting option change
-         */
-        grantedDueToMeetingOption?: string;
-    };
-    /**
-     * Strings for 'unmuteMic' capability
-     */
-    unmuteMic?: {
-        /**
-         * Notification message shown to the user when capability to unmute mic is lost due to a meeting option change
-         */
-        lostDueToMeetingOption?: string;
-        /**
-         * Notification message shown to the user when capability to unmute mic is granted due to a meeting option change
-         */
-        grantedDueToMeetingOption?: string;
-    };
-    /**
-     * Strings for 'shareScreen' capability
-     */
-    shareScreen?: {
-        /**
-         * Notification message shown to the user when capability to share screen is lost due to a role change to Attendeee
-         */
-        lostDueToRoleChangeToAttendee?: string;
-        /**
-         * Notification message shown to the user when capability to share screen is granted due to a role change to Presenter
-         */
-        grantedDueToRoleChangeToPresenter?: string;
-    };
-}
-
 /**
  * @beta
  * caption language strings for captions setting modal
@@ -3756,7 +3616,7 @@ export declare type CaptionsReceivedListener = (event: {
  *
  * @public
  */
-export declare type ChatAdapter = ChatAdapterThreadManagement & AdapterState<ChatAdapterState> & Disposable & ChatAdapterSubscribers & FileUploadAdapter;
+export declare type ChatAdapter = ChatAdapterThreadManagement & AdapterState<ChatAdapterState> & Disposable & ChatAdapterSubscribers & /* @conditional-compile-remove(file-sharing) */ FileUploadAdapter;
 
 /**
  * {@link ChatAdapter} state.
@@ -3864,7 +3724,7 @@ export declare interface ChatAdapterThreadManagement {
     /**
      * Update a message content.
      */
-    updateMessage(messageId: string, content: string, metadata?: Record<string, string>, options?: {
+    updateMessage(messageId: string, content: string, metadata?: Record<string, string>, /* @conditional-compile-remove(file-sharing) */ options?: {
         attachedFilesMetadata?: FileMetadata[];
     }): Promise<void>;
     /**
@@ -4154,7 +4014,7 @@ export declare type ChatHandlers = {
     onRemoveParticipant: (userId: string) => Promise<void>;
     updateThreadTopicName: (topicName: string) => Promise<void>;
     onLoadPreviousChatMessages: (messagesToLoad: number) => Promise<boolean>;
-    onUpdateMessage: (messageId: string, content: string, metadata?: Record<string, string>, options?: {
+    onUpdateMessage: (messageId: string, content: string, /* @conditional-compile-remove(file-sharing) */ metadata?: Record<string, string>, /* @conditional-compile-remove(file-sharing) */ options?: {
         attachedFilesMetadata?: FileMetadata[];
     }) => Promise<void>;
     onDeleteMessage: (messageId: string) => Promise<void>;
@@ -4222,26 +4082,6 @@ export declare type ChatParticipantListSelector = (state: ChatClientState, props
  */
 export declare type ChatReturnProps<Component extends (props: any) => JSX.Element> = GetChatSelector<Component> extends (state: ChatClientState, props: any) => any ? ReturnType<GetChatSelector<Component>> & Common<ChatHandlers, Parameters<Component>[0]> : never;
 
-/**
- * Custom Fluent theme palette used by chat related components in this library.
- *
- * @beta
- */
-export declare interface ChatTheme {
-    /**
-     * Custom Fluent theme palette used by chat related components in this library.
-     *
-     * @beta
-     */
-    chatPalette: {
-        modalOverlayBlack: string;
-        modalTitleWhite: string;
-        modalButtonBackground: string;
-        modalButtonBackgroundHover: string;
-        modalButtonBackgroundActive: string;
-    };
-}
-
 /**
  * A {@link React.Context} that stores a {@link @azure/communication-chat#ChatThreadClient}.
  *
@@ -4800,8 +4640,6 @@ export declare interface ComponentStrings {
     sendBox: SendBoxStrings;
     /** Strings for MentionPopover */
     mentionPopover: MentionPopoverStrings;
-    /** Strings for ImageGallery */
-    imageGallery: ImageGalleryStrings;
     /** Strings for MessageStatusIndicator */
     messageStatusIndicator: MessageStatusIndicatorStrings;
     /** Strings for ErroBar */
@@ -5220,7 +5058,7 @@ export declare const createAzureCommunicationCallAdapter: ({ userId, displayName
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
+export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, /* @conditional-compile-remove(video-background-effects) */ options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
 
 /**
  * Create a CallWithChatAdapter backed by Azure Communication services
@@ -5258,7 +5096,7 @@ export declare const createAzureCommunicationChatAdapter: ({ endpoint: endpointU
  *
  * @public
  */
-export declare function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, options?: {
+export declare function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ options?: {
     credential?: CommunicationTokenCredential;
 }): Promise<ChatAdapter>;
 
@@ -5267,7 +5105,7 @@ export declare function createAzureCommunicationChatAdapterFromClient(chatClient
  *
  * @public
  */
-export declare type CreateDefaultCallingHandlers = (callClient: StatefulCallClient, callAgent: CallAgent | undefined, deviceManager: StatefulDeviceManager | undefined, call: Call | undefined, options?: CallingHandlersOptions) => CallingHandlers;
+export declare type CreateDefaultCallingHandlers = (callClient: StatefulCallClient, callAgent: CallAgent | undefined, deviceManager: StatefulDeviceManager | undefined, call: Call | undefined, /* @conditional-compile-remove(video-background-effects) */ options?: CallingHandlersOptions) => CallingHandlers;
 
 /**
  * Create the default implementation of {@link CallingHandlers} for teams call.
@@ -5550,13 +5388,13 @@ 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;
 
 /**
  * @beta
  * `DeclarativeCallAgent` extends and proxies the {@link @azure/communication-calling#CallAgent}
  */
-export declare type DeclarativeCallAgent = CallAgent & IncomingCallManagement;
+export declare type DeclarativeCallAgent = CallAgent & /* @conditional-compile-remove(one-to-n-calling) */ IncomingCallManagement;
 
 /**
  * @beta
@@ -5689,8 +5527,6 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     ControlButtonParticipants: JSX.Element;
     ControlButtonScreenShareStart: JSX.Element;
     ControlButtonScreenShareStop: JSX.Element;
-    ControlButtonCameraProhibited?: JSX.Element | undefined;
-    ControlButtonMicProhibited?: JSX.Element | undefined;
     ControlButtonRaiseHand: JSX.Element;
     ControlButtonLowerHand: JSX.Element;
     RaiseHandContextualMenuItem: JSX.Element;
@@ -5734,12 +5570,6 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     NoticePageAccessDeniedRoomsCall?: JSX.Element | undefined;
     BlurVideoBackground?: JSX.Element | undefined;
     RemoveVideoBackgroundEffect?: JSX.Element | undefined;
-    GalleryOptions?: JSX.Element | undefined;
-    SpeakerGalleryLayout?: JSX.Element | undefined;
-    FloatingLocalVideoGalleryLayout?: JSX.Element | undefined;
-    DefaultGalleryLayout?: JSX.Element | undefined;
-    FocusedContentGalleryLayout?: JSX.Element | undefined;
-    OverflowGalleryTop?: JSX.Element | undefined;
     ChevronLeft?: JSX.Element | undefined;
     ControlBarChatButtonActive?: JSX.Element | undefined;
     ControlBarChatButtonInactive?: JSX.Element | undefined;
@@ -5785,13 +5615,6 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     CaptionsIcon: JSX.Element;
     CaptionsOffIcon: JSX.Element;
     CaptionsSettingsIcon: JSX.Element;
-    /**
-     * Icon wrapper to use when including customizable icons inside the CallWithChatComposite.
-     * This wrapper ensures the icon name is being type-checked helping ensure no typos
-     * and ensure that icon is customizable through the composite API.
-     *
-     * @private
-     */
     ChangeSpokenLanguageIcon: JSX.Element;
     ChangeCaptionLanguageIcon: JSX.Element;
     ContextMenuCameraIcon: JSX.Element;
@@ -6825,79 +6648,6 @@ export declare interface ImageFileMetadata extends BaseFileMetadata {
     previewUrl?: string;
 }
 
-/**
- * Component to render a fullscreen modal for a selected image.
- *
- * @beta
- */
-export declare const ImageGallery: (props: ImageGalleryProps) => JSX.Element;
-
-/**
- * Props for {@link ImageGallery}.
- *
- * @beta
- */
-export declare interface ImageGalleryImageProps {
-    /** Image Url used to display the image in a large scale. */
-    imageUrl: string;
-    /** String used as a file name when downloading this image to user's local device. */
-    saveAsName: string;
-    /** Optional string used as a alt text for the image. @default 'image' */
-    altText?: string;
-    /** Optional string used as the title of the image and displayed on the top left corner of the ImageGallery. */
-    title?: string;
-    /** Optional JSX element used as a title icon and displayed to the left of the title element. */
-    titleIcon?: JSX.Element;
-}
-
-/**
- * Props for {@link ImageGallery}.
- *
- * @beta
- */
-export declare interface ImageGalleryProps {
-    /**
-     * Boolean that controls whether the modal is displayed.
-     */
-    isOpen: boolean;
-    /**
-     * Array of images used to populate the ImageGallery
-     */
-    images: Array<ImageGalleryImageProps>;
-    /**
-     * Callback to invoke when the ImageGallery modal is dismissed
-     */
-    onDismiss: () => void;
-    /**
-     * Callback called when the download button is clicked.
-     */
-    onImageDownloadButtonClicked: (imageUrl: string, saveAsName: string) => void;
-    /**
-     * Callback called when there's an error loading the image.
-     */
-    onError?: (event: SyntheticEvent<HTMLImageElement, Event>) => void;
-    /**
-     * Indicating which index of the images array to start with.
-     */
-    startIndex?: number;
-}
-
-/**
- * Strings of {@link ImageGallery} that can be overridden.
- *
- * @beta
- */
-export declare interface ImageGalleryStrings {
-    /**
-     * Download button label for ImageGallery
-     */
-    downloadButtonLabel: string;
-    /**
-     * Dismiss button aria label for ImageGallery
-     */
-    dismissButtonAriaLabel: string;
-}
-
 /**
  * @beta
  * This contains a readonly array that returns all the active `incomingCalls`.
@@ -7042,7 +6792,7 @@ export declare interface JumpToNewMessageButtonProps {
  *
  * @public
  */
-export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
+export declare const lightTheme: PartialTheme & CallingTheme;
 
 /**
  * Whether the stream is loading or not.
@@ -7618,11 +7368,6 @@ export declare type MessageThreadProps = {
      * @beta
      */
     mentionOptions?: MentionOptions;
-    /**
-     * Optional callback called when an inline image is clicked.
-     * @beta
-     */
-    onInlineImageClicked?: (attachmentId: string, messageId: string) => Promise<void>;
 };
 
 /**
@@ -8011,7 +7756,7 @@ export declare interface OptionsDevice {
  *
  * @beta
  */
-export declare type OverflowGalleryPosition = 'HorizontalBottom' | 'VerticalRight' | /* @conditional-compile-remove(gallery-layouts) */ 'HorizontalTop';
+export declare type OverflowGalleryPosition = 'HorizontalBottom' | 'VerticalRight';
 
 /**
  * A system message notifying that a participant was added to the chat thread.
@@ -9647,7 +9392,7 @@ export declare interface UnsupportedOperatingSystemStrings {
  * @public
  * Callback function run when a message is updated.
  */
-export declare type UpdateMessageCallback = (messageId: string, content: string, metadata?: Record<string, string>, options?: {
+export declare type UpdateMessageCallback = (messageId: string, content: string, /* @conditional-compile-remove(file-sharing) */ metadata?: Record<string, string>, /* @conditional-compile-remove(file-sharing) */ options?: {
     attachedFilesMetadata?: FileMetadata[];
 }) => Promise<void>;
 
@@ -9974,7 +9719,7 @@ export declare const VideoGallery: (props: VideoGalleryProps) => JSX.Element;
 /**
  * @public
  */
-export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo' | /* @conditional-compile-remove(gallery-layouts) */ 'speaker' | /* @conditional-compile-remove(gallery-layouts) */ 'focusedContent';
+export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo';
 
 /**
  * The state of the local participant in the {@link VideoGallery}.