@azure/communication-react 1.13.0-alpha-202402030013 → 1.13.0-alpha-202402060012

package/dist/communication-react.d.ts

@@ -75,6 +75,7 @@ import { LatestNetworkDiagnostics } from '@azure/communication-calling';
 import { LocalVideoStream } from '@azure/communication-calling';
 import type { MediaDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { MediaStreamType } from '@azure/communication-calling';
+import { MicrosoftTeamsAppIdentifier } from '@azure/communication-common';
 import { MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
 import type { NetworkDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { PartialTheme } from '@fluentui/react';
@@ -104,6 +105,7 @@ import { TeamsMeetingLinkLocator } from '@azure/communication-calling';
 import { Theme } from '@fluentui/react';
 import { TransferRequestedEventArgs } from '@azure/communication-calling';
 import { TypingIndicatorReceivedEvent } from '@azure/communication-chat';
+import { UnknownIdentifier } from '@azure/communication-common';
 import { VideoDeviceInfo } from '@azure/communication-calling';
 import { VideoEffectName } from '@azure/communication-calling';
 import { VideoStreamRenderer } from '@azure/communication-calling';
@@ -383,6 +385,31 @@ export declare type AzureCommunicationChatAdapterOptions = {
     credential?: CommunicationTokenCredential;
 };
 
+/**
+ * Arguments for creating the Azure Communication Services implementation of {@link CallAdapter}.
+ *
+ * These arguments are used to create an outbound call scenarios.
+ *
+ * Note: `displayName` can be a maximum of 256 characters.
+ *
+ * @public
+ */
+export declare type AzureCommunicationOutboundCallAdapterArgs = {
+    userId: CommunicationUserIdentifier;
+    displayName: string;
+    credential: CommunicationTokenCredential;
+    targetCallees: StartCallIdentifier[];
+    /**
+     * A phone number in E.164 format procured using Azure Communication Services that will be used to represent callers identity.
+     * E.164 numbers are formatted as [+] [country code] [phone number including area code]. For example, +14255550123 for a US phone number.
+     */
+    alternateCallerId?: string;
+    /**
+     * Optional parameters for the {@link AzureCommunicationCallAdapter} created
+     */
+    options?: AzureCommunicationCallAdapterOptions;
+};
+
 /**
  * Properties common to all composites exported from this library.
  *
@@ -624,9 +651,9 @@ export declare interface CallAdapter extends CommonCallAdapter {
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
+    startCall(participants: StartCallIdentifier[], options?: StartCallOptions): Call | undefined;
 }
 
 /**
@@ -674,9 +701,9 @@ export declare interface CallAdapterCallManagement extends CallAdapterCallOperat
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
+    startCall(participants: StartCallIdentifier[], options?: StartCallOptions): Call | undefined;
 }
 
 /**
@@ -1584,9 +1611,10 @@ export declare type CallCompositeOptions = {
          */
         disableSurvey?: boolean;
         /**
-         * Optional callback to add extra logic when survey is dismissed. For self-host only
+         * Optional callback to redirect users to custom screens when survey is done, note that default end call screen will be shown if this callback is not provided
+         * This callback can be used to redirect users to different screens depending on survey state, whether it is submitted, skipped or has a problem when submitting the survey
          */
-        onSurveyDismissed?: () => void;
+        onSurveyClosed?: (surveyState: 'sent' | 'skipped' | 'error', surveyError?: string) => void;
         /**
          * Optional callback to handle survey data including free form text response
          * Note that free form text response survey option is only going to be enabled when this callback is provided
@@ -2276,9 +2304,9 @@ export declare interface CallCompositeStrings {
      */
     capabilityChangedNotification?: CapabilityChangedNotificationStrings;
     /**
-     * Question for the survey
+     * Title for the survey
      */
-    surveyQuestion: string;
+    surveyTitle: string;
     /**
      * Helper text to explain what the survey is for
      */
@@ -2324,13 +2352,17 @@ export declare interface CallCompositeStrings {
      */
     surveyConfirmButtonLabel: string;
     /**
-     * Aria Label for cancel button
+     * Cancel button label for survey
      */
-    surveyCancelButtonAriaLabel: string;
+    surveySkipButtonLabel: string;
     /**
      * Default text for free form text box
      */
     surveyTextboxDefaultText: string;
+    /**
+     * Thank you text appeared on screen after survey is submitted
+     */
+    endOfSurveyText: string;
     /**
      * Corresponding texts to each call issue
      */
@@ -2878,9 +2910,9 @@ export declare interface CallWithChatAdapterManagement {
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
+    startCall(participants: (MicrosoftTeamsAppIdentifier | /* @conditional-compile-remove(PSTN-calls) */ PhoneNumberIdentifier | /* @conditional-compile-remove(one-to-n-calling) */ CommunicationUserIdentifier | /* @conditional-compile-remove(teams-adhoc-call) */ MicrosoftTeamsUserIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call | undefined;
     /**
      * Start sharing the screen during a call.
      *
@@ -3322,7 +3354,10 @@ export declare interface CallWithChatClientState {
     selectedVideoBackgroundEffect?: VideoBackgroundEffect;
     /** Hide attendee names in teams meeting */
     hideAttendeeNames?: boolean;
-    /** Reaction resources to render in meetings */
+    /**
+     * Reaction resources to render in meetings
+     * @beta
+     * */
     reactions?: ReactionResources;
 }
 
@@ -3508,9 +3543,10 @@ export declare type CallWithChatCompositeOptions = {
          */
         disableSurvey?: boolean;
         /**
-         * Optional callback to add extra logic when survey is dismissed. For self-host only
+         * Optional callback to redirect users to custom screens when survey is done, note that default end call screen will be shown if this callback is not provided
+         * This callback can be used to redirect users to different screens depending on survey state, whether it is submitted, skipped or has a problem when submitting the survey
          */
-        onSurveyDismissed?: () => void;
+        onSurveyClosed?: (surveyState: 'sent' | 'skipped' | 'error', surveyError?: string) => void;
         /**
          * Optional callback to handle survey data including free form text response
          * Note that free form text response survey option is only going to be enabled when this callback is provided
@@ -4852,9 +4888,9 @@ export declare interface CommonCallAdapter extends AdapterState<CallAdapterState
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): void;
+    startCall(participants: StartCallIdentifier[], options?: StartCallOptions): void;
 }
 
 /**
@@ -4880,6 +4916,11 @@ export declare type CommonCallAdapterOptions = {
      * Sounds to use for calling events
      */
     callingSounds?: CallingSounds;
+    /**
+     * Reaction resource for reaction resources
+     * @beta
+     */
+    reactionResources?: ReactionResources;
 };
 
 /**
@@ -5001,6 +5042,9 @@ export declare interface CommonCallingHandlers {
     onRaiseHand: () => Promise<void>;
     onLowerHand: () => Promise<void>;
     onToggleRaiseHand: () => Promise<void>;
+    /**
+     * @beta
+     */
     onReactionClicked: (reaction: Reaction_2) => Promise<void>;
     onToggleHold: () => Promise<void>;
     onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>;
@@ -5295,7 +5339,10 @@ export declare interface ComponentStrings {
     screenShareButton: ScreenShareButtonStrings;
     /** Strings for RaiseHandButton */
     raiseHandButton: RaiseHandButtonStrings;
-    /** Strings for ReactionButton */
+    /**
+     * Strings for ReactionButton
+     * @beta
+     * */
     reactionButton: ReactionButtonStrings;
     /** Strings for TypingIndicator */
     typingIndicator: TypingIndicatorStrings;
@@ -5303,8 +5350,8 @@ export declare interface ComponentStrings {
     sendBox: SendBoxStrings;
     /** Strings for MentionPopover */
     mentionPopover: MentionPopoverStrings;
-    /** Strings for ImageGallery */
-    imageGallery: ImageGalleryStrings;
+    /** Strings for ImageOverlay */
+    imageOverlay: ImageOverlayStrings;
     /** Strings for MessageStatusIndicator */
     messageStatusIndicator: MessageStatusIndicatorStrings;
     /** Strings for ErroBar */
@@ -5721,7 +5768,18 @@ export declare interface ControlBarProps {
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId, options }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
+export declare function createAzureCommunicationCallAdapter(args: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>;
+
+/**
+ * Create a {@link CallAdapter} backed by Azure Communication Services.
+ *
+ * This is the default implementation of {@link CallAdapter} provided by this library.
+ *
+ * Note: `displayName` can be a maximum of 256 characters.
+ *
+ * @public
+ */
+export declare function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>;
 
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
@@ -5731,7 +5789,17 @@ export declare const createAzureCommunicationCallAdapter: ({ userId, displayName
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
+export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: StartCallIdentifier[], options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
+
+/**
+ * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
+ *
+ * Useful if you want to keep a reference to {@link StatefulCallClient}.
+ * Consider using {@link createAzureCommunicationCallAdapter} for a simpler API.
+ *
+ * @public
+ */
+export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
 
 /**
  * Create a CallWithChatAdapter backed by Azure Communication services
@@ -6036,7 +6104,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 & /* @conditional-compile-remove(image-overlay) */ ChatTheme;
 
 /**
  * @beta
@@ -7363,70 +7431,60 @@ export declare interface _Identifiers {
  *
  * @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. */
-    downloadFilename: 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;
-}
+export declare const ImageOverlay: (props: ImageOverlayProps) => JSX.Element;
 
 /**
- * Props for {@link ImageGallery}.
+ * Props for {@link ImageOverlay}.
  *
  * @beta
  */
-export declare interface ImageGalleryProps {
+export declare interface ImageOverlayProps {
     /**
      * Boolean that controls whether the modal is displayed.
      */
     isOpen: boolean;
     /**
-     * Array of images used to populate the ImageGallery
+     * Image source used to display the image in a large scale.
+     */
+    imageSrc: 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 ImageOverlay.
+     */
+    title?: string;
+    /**
+     * Optional JSX element used as a title icon and displayed to the left of the title element.
      */
-    images: Array<ImageGalleryImageProps>;
+    titleIcon?: JSX.Element;
     /**
-     * Callback to invoke when the ImageGallery modal is dismissed
+     * Callback to invoke when the ImageOverlay modal is dismissed
      */
     onDismiss: () => void;
     /**
      * Callback called when the download button is clicked.
      */
-    onImageDownloadButtonClicked: (imageUrl: string, downloadFilename: string) => void;
+    onDownloadButtonClicked: (imageSrc: 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.
+ * Strings of {@link ImageOverlay} that can be overridden.
  *
  * @beta
  */
-export declare interface ImageGalleryStrings {
+export declare interface ImageOverlayStrings {
     /**
-     * Download button label for ImageGallery
+     * Download button label for ImageOverlay
      */
     downloadButtonLabel: string;
     /**
-     * Dismiss button aria label for ImageGallery
+     * Dismiss button aria label for ImageOverlay
      */
     dismissButtonAriaLabel: string;
 }
@@ -7617,7 +7675,7 @@ export declare interface JumpToNewMessageButtonProps {
  *
  * @public
  */
-export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
+export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-overlay) */ ChatTheme;
 
 /**
  * Whether the stream is loading or not.
@@ -9750,6 +9808,12 @@ export declare interface SpotlightState {
     spotlightedOrderPosition?: number;
 }
 
+/**
+ * Identifier types for initiating a call using the CallAdapter
+ * @public
+ */
+export declare type StartCallIdentifier = (MicrosoftTeamsAppIdentifier | /* @conditional-compile-remove(PSTN-calls) */ PhoneNumberIdentifier | /* @conditional-compile-remove(one-to-n-calling) */ CommunicationUserIdentifier | /* @conditional-compile-remove(teams-adhoc-call) */ MicrosoftTeamsUserIdentifier | UnknownIdentifier) | /* @conditional-compile-remove(start-call-beta) */ CommunicationIdentifier;
+
 /**
  * Defines the methods that allow CallClient {@link @azure/communication-calling#CallClient} to be used statefully.
  * The interface provides access to proxied state and also allows registering a handler for state change events. For
@@ -10499,7 +10563,7 @@ export declare type UpdateMessageCallback = (messageId: string, content: string,
  *
  * @public
  */
-export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: ((adapter: CallAdapter) => Promise<CallAdapter>) | undefined, beforeDispose?: ((adapter: CallAdapter) => Promise<void>) | undefined) => CallAdapter | undefined;
+export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, afterCreate?: ((adapter: CallAdapter) => Promise<CallAdapter>) | undefined, beforeDispose?: ((adapter: CallAdapter) => Promise<void>) | undefined) => CallAdapter | undefined;
 
 /**
  * A custom React hook to simplify the creation of {@link CallWithChatAdapter}.
@@ -10957,6 +11021,7 @@ export declare interface VideoGalleryProps {
     localVideoTileSize?: LocalVideoTileSize;
     /**
      * Reaction resources for like, heart, laugh, applause and surprised.
+     * @beta
      */
     reactionResources?: ReactionResources;
 }
@@ -11230,7 +11295,10 @@ export declare interface VideoTileProps {
     isSpeaking?: boolean;
     /** Whether the participant is raised hand. Show a indicator (border) and icon with order */
     raisedHand?: RaisedHand;
-    /** When the participant has reacted, animate the reaction. */
+    /**
+     * When the participant has reacted, animate the reaction.
+     * @beta
+     * */
     reaction?: Reaction;
     /**
      * The call connection state of the participant.
@@ -11254,6 +11322,7 @@ export declare interface VideoTileProps {
     isSpotlighted?: boolean;
     /**
      * Reactions resources' url and metadata.
+     * @beta
      */
     reactionResources?: ReactionResources;
 }