@azure/communication-react 1.13.0-alpha-202402080012 → 1.13.0-alpha-202402100012

package/dist/communication-react.d.ts

@@ -98,7 +98,6 @@ import { SendMessageOptions } from '@azure/communication-chat';
 import { SpotlightedParticipant } from '@azure/communication-calling';
 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';
@@ -925,16 +924,12 @@ export declare interface CallAdapterCallOperations {
     submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
     /**
      * Start spotlight
-     *
-     * @beta
      */
-    startSpotlight(userId: string): Promise<void>;
+    startSpotlight(userIds?: string[]): Promise<void>;
     /**
      * Stop spotlight
-     *
-     * @beta
      */
-    stopSpotlight(userId: string): Promise<void>;
+    stopSpotlight(userIds?: string[]): Promise<void>;
 }
 
 /**
@@ -1193,6 +1188,10 @@ export declare interface CallAdapterSubscribers {
      * Subscribe function for 'roleChanged' event.
      */
     on(event: 'roleChanged', listener: PropertyChangedEvent): void;
+    /**
+     * Subscribe function for 'spotlightChanged' event.
+     */
+    on(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
     /**
      * Unsubscribe function for 'participantsJoined' event.
      */
@@ -1269,6 +1268,10 @@ export declare interface CallAdapterSubscribers {
      * Unsubscribe function for 'roleChanged' event.
      */
     off(event: 'roleChanged', listener: PropertyChangedEvent): void;
+    /**
+     * Subscribe function for 'spotlightChanged' event.
+     */
+    off(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
 }
 
 /**
@@ -1959,6 +1962,10 @@ export declare interface CallCompositeStrings {
      * Label for menu item to stop spotlight on local user
      */
     stopSpotlightOnSelfParticipantListMenuLabel: string;
+    /**
+     * Label for menu item to stop spotlight on local user
+     */
+    spotlightLimitReachedParticipantListMenuTitle: string;
     /**
      * Label for add people dropdown
      */
@@ -2610,12 +2617,8 @@ export declare type CallParticipantListParticipant = ParticipantListParticipant
      * @beta
      * */
     reaction?: Reaction;
-    /**
-     * Whether calling participant is spotlighted
-     *
-     * @beta
-     * */
-    isSpotlighted?: Spotlight;
+    /** Whether calling participant is spotlighted **/
+    spotlight?: Spotlight;
 };
 
 /**
@@ -3212,16 +3215,12 @@ export declare interface CallWithChatAdapterManagement {
     submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
     /**
      * Start spotlight
-     *
-     * @beta
      */
-    startSpotlight(userId: string): Promise<void>;
+    startSpotlight(userIds?: string[]): Promise<void>;
     /**
      * Stop spotlight
-     *
-     * @beta
      */
-    stopSpotlight(userId: string): Promise<void>;
+    stopSpotlight(userIds?: string[]): Promise<void>;
 }
 
 /**
@@ -3254,6 +3253,7 @@ export declare interface CallWithChatAdapterSubscriptions {
     on(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
     on(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
     on(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
+    on(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
     off(event: 'callEnded', listener: CallEndedListener): void;
     off(event: 'isMutedChanged', listener: IsMutedChangedListener): void;
     off(event: 'callIdChanged', listener: CallIdChangedListener): void;
@@ -3270,6 +3270,7 @@ export declare interface CallWithChatAdapterSubscriptions {
     off(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
     off(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
     off(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
+    off(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
     on(event: 'messageReceived', listener: MessageReceivedListener): void;
     on(event: 'messageEdited', listener: MessageEditedListener): void;
     on(event: 'messageDeleted', listener: MessageDeletedListener): void;
@@ -3831,7 +3832,7 @@ export declare interface CallWithChatControlOptions extends CommonCallControlOpt
  *
  * @public
  */
-export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | /* @conditional-compile-remove(close-captions) */ 'isCaptionsActiveChanged' | /* @conditional-compile-remove(close-captions) */ 'captionsReceived' | /* @conditional-compile-remove(close-captions) */ 'isCaptionLanguageChanged' | /* @conditional-compile-remove(close-captions) */ 'isSpokenLanguageChanged' | /* @conditional-compile-remove(capabilities) */ 'capabilitiesChanged' | 'messageReceived' | 'messageEdited' | 'messageDeleted' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
+export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | /* @conditional-compile-remove(close-captions) */ 'isCaptionsActiveChanged' | /* @conditional-compile-remove(close-captions) */ 'captionsReceived' | /* @conditional-compile-remove(close-captions) */ 'isCaptionLanguageChanged' | /* @conditional-compile-remove(close-captions) */ 'isSpokenLanguageChanged' | /* @conditional-compile-remove(capabilities) */ 'capabilitiesChanged' | /* @conditional-compile-remove(spotlight) */ 'spotlightChanged' | 'messageReceived' | 'messageEdited' | 'messageDeleted' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
 
 /**
  * @beta
@@ -4744,26 +4745,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}.
  *
@@ -5075,8 +5056,8 @@ export declare interface CommonCallingHandlers {
     onSetSpokenLanguage: (language: string) => Promise<void>;
     onSetCaptionLanguage: (language: string) => Promise<void>;
     onSubmitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
-    onStartSpotlight: (userId: string) => Promise<void>;
-    onStopSpotlight: (userId: string) => Promise<void>;
+    onStartSpotlight: (userIds?: string[]) => Promise<void>;
+    onStopSpotlight: (userIds?: string[]) => Promise<void>;
 }
 
 /**
@@ -6108,7 +6089,7 @@ export declare interface CustomMessage extends MessageCommon {
  *
  * @public
  */
-export declare const darkTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-overlay) */ ChatTheme;
+export declare const darkTheme: PartialTheme & CallingTheme;
 
 /**
  * @beta
@@ -6973,6 +6954,10 @@ export declare interface ErrorBarStrings {
      * Unable to start effect
      */
     unableToStartVideoEffect?: string;
+    /**
+     * An error message when starting spotlight while max participants are spotlighted
+     */
+    startSpotlightWhileMaxParticipantsAreSpotlighted: string;
 }
 
 /**
@@ -7468,13 +7453,9 @@ export declare interface ImageOverlayProps {
      */
     onDismiss: () => void;
     /**
-     * Callback called when the download button is clicked.
-     */
-    onDownloadButtonClicked: (imageSrc: string) => void;
-    /**
-     * Callback called when there's an error loading the image.
+     * Optional callback called when the download button is clicked. If not provided, the download button will not be rendered.
      */
-    onError?: (event: SyntheticEvent<HTMLImageElement, Event>) => void;
+    onDownloadButtonClicked?: (imageSrc: string) => void;
 }
 
 /**
@@ -7493,6 +7474,13 @@ export declare interface ImageOverlayStrings {
     dismissButtonAriaLabel: string;
 }
 
+/**
+ * Preset dark theme for the ImageOverlay component.
+ *
+ * @beta
+ */
+export declare const imageOverlayTheme: PartialTheme;
+
 /**
  * @beta
  * This contains a readonly array that returns all the active `incomingCalls`.
@@ -7679,7 +7667,7 @@ export declare interface JumpToNewMessageButtonProps {
  *
  * @public
  */
-export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-overlay) */ ChatTheme;
+export declare const lightTheme: PartialTheme & CallingTheme;
 
 /**
  * Whether the stream is loading or not.
@@ -8835,11 +8823,6 @@ export declare type ParticipantListProps = {
     onFetchParticipantMenuItems?: ParticipantMenuItemsCallback;
     /** Optional callback when rendered ParticipantItem is clicked */
     onParticipantClick?: (participant?: ParticipantListParticipant) => void;
-    /** Optional callback to generate context menu item to stop spotlight of each participant */
-    onStartSpotlight?: (userId: string) => void;
-    /** Optional callback to generate context menu item to stop spotlight of each participant */
-    onStopSpotlight?: (userId: string) => void;
-    /** Styles for the {@link ParticipantList} */
     styles?: ParticipantListStyles;
     /** Optional value to determine if the tooltip should be shown for participants or not */
     showParticipantOverflowTooltip?: boolean;
@@ -9395,7 +9378,7 @@ export declare interface RemoteParticipantState {
     /**
      * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.spotlightedParticipants}.
      */
-    spotlighted?: SpotlightState;
+    spotlight?: SpotlightState;
 }
 
 /**
@@ -9785,7 +9768,7 @@ export declare type Spotlight = {
     /**
      * Specifies the order position of the spotlight
      */
-    spotlightOrderPosition?: number;
+    spotlightedOrderPosition?: number;
 };
 
 /**
@@ -9798,8 +9781,22 @@ export declare interface SpotlightCallFeatureState {
      * Ordered array of spotlighted participants in call
      */
     spotlightedParticipants: SpotlightedParticipant[];
+    /**
+     * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.maxParticipantsToSpotlight}.
+     */
+    maxParticipantsToSpotlight: number;
 }
 
+/**
+ * Callback for {@link CallAdapterSubscribers} 'spotlightChanged' event.
+ *
+ * @public
+ */
+export declare type SpotlightChangedListener = (args: {
+    added: SpotlightedParticipant[];
+    removed: SpotlightedParticipant[];
+}) => void;
+
 /**
  * Strings used in prompt related to spotlight
  * @beta
@@ -10044,6 +10041,10 @@ export declare type StatefulCallClientOptions = {
  * @public
  */
 export declare interface StatefulChatClient extends ChatClient {
+    /**
+     * Cleans up the resource cache from the chat thread client.
+     */
+    dispose(): void;
     /**
      * Holds all the state that we could proxy from ChatClient {@Link @azure/communication-chat#ChatClient} as
      * ChatClientState {@Link ChatClientState}.
@@ -10061,6 +10062,22 @@ export declare interface StatefulChatClient extends ChatClient {
      * @param handler - Original callback to be unsubscribed.
      */
     offStateChange(handler: (state: ChatClientState) => void): void;
+    /**
+     * Downloads a resource for specific message and caches it.
+     *
+     * @param threadId - The thread id of the chat thread.
+     * @param messageId - The message id of the chat message.
+     * @param resourceUrl - The resource url to fetch and cache.
+     */
+    downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string): void;
+    /**
+     * Removes a resource from cache for a specific message.
+     *
+     * @param threadId - The thread id of the chat thread.
+     * @param messageId - The message id of the chat message.
+     * @param resourceUrl - The resource url to remove from cache.
+     */
+    removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string): void;
 }
 
 /**
@@ -10965,6 +10982,8 @@ export declare type VideoGalleryParticipant = {
     videoStream?: VideoGalleryStream;
     /** Whether participant is screen sharing or not */
     isScreenSharingOn?: boolean;
+    /** Whether participant is spotlighted **/
+    spotlight?: Spotlight;
 };
 
 /**
@@ -11053,13 +11072,17 @@ export declare interface VideoGalleryProps {
      */
     spotlightedParticipants?: string[];
     /**
-     * This callback will be called when spotlight is started for participant video tile.
+     * This callback will be called when spotlight is started for participant video tiles.
+     */
+    onStartSpotlight?: (userIds?: string[]) => Promise<void>;
+    /**
+     * This callback will be called when spotlight is stopped for participant video tiles.
      */
-    onStartSpotlight?: (userId: string) => Promise<void>;
+    onStopSpotlight?: (userIds?: string[]) => Promise<void>;
     /**
-     * This callback will be called when spotlight is stopped for participant video tile.
+     * Maximum participants that can be spotlighted
      */
-    onStopSpotlight?: (userId: string) => Promise<void>;
+    maxParticipantsToSpotlight?: number;
     /**
      * Options for showing the remote video tile menu.
      *
@@ -11122,6 +11145,7 @@ export declare type VideoGallerySelector = (state: CallClientState, props: Calli
     dominantSpeakers?: string[];
     optimalVideoCount?: number;
     spotlightedParticipants?: string[];
+    maxParticipantsToSpotlight?: number;
 };
 
 /**
@@ -11189,6 +11213,8 @@ export declare interface VideoGalleryStrings {
     startSpotlightVideoTileMenuLabel: string;
     /** Menu text shown in Video Tile contextual menu to add spotlight to participant's video tile */
     addSpotlightVideoTileMenuLabel: string;
+    /** Menu title for start spotlight menu item when spotlight limit is reached */
+    spotlightLimitReachedMenuTitle: string;
     /** Menu text shown in Video Tile contextual menu to stop spotlight on participant's video tile */
     stopSpotlightVideoTileMenuLabel: string;
     /** Menu text shown in Video Tile contextual menu to stop spotlight on local user's video tile */