@azure/communication-react 1.19.0-alpha-202408270015 → 1.19.0-alpha-202408290015

package/dist/communication-react.d.ts

@@ -19,6 +19,7 @@
 
 import { AddPhoneNumberOptions } from '@azure/communication-calling';
 import { AudioDeviceInfo } from '@azure/communication-calling';
+import { AudioEffectsStartConfig } from '@azure/communication-calling';
 import { BackgroundBlurConfig } from '@azure/communication-calling';
 import { BackgroundBlurEffect } from '@azure/communication-calling';
 import { BackgroundReplacementConfig } from '@azure/communication-calling';
@@ -164,38 +165,6 @@ export declare interface ActiveErrorMessage {
     timestamp?: Date;
 }
 
-/**
- * Represents an active incoming call.
- * @beta
- */
-export declare interface ActiveIncomingCall {
-    /**
-     * Unique identifier for the incoming call.
-     */
-    id: string;
-    /**
-     * Information about the caller.
-     */
-    callerInfo: {
-        /**
-         * Display name of the caller.
-         */
-        displayName: string;
-    };
-    /**
-     * Start time of the incoming call.
-     */
-    startTime: Date;
-    /**
-     * End time of the incoming call.
-     */
-    endTime?: Date;
-    /**
-     * Whether or not the call is a voip capable call.
-     */
-    videoAvailable: boolean;
-}
-
 /**
  * Active notifications to be shown via {@link NotificationStack}.
  *
@@ -578,11 +547,6 @@ export declare type AzureCommunicationCallAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAdapterLocator;
-    /**
-     * 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
      */
@@ -1141,7 +1105,7 @@ export declare interface CallAdapterCallOperations {
      * Function to Start captions
      * @param options - options for start captions
      */
-    startCaptions(options?: StartCaptionsOptions): Promise<void>;
+    startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>;
     /**
      * Function to set caption language
      * @param language - language set for caption
@@ -1155,7 +1119,7 @@ export declare interface CallAdapterCallOperations {
     /**
      * Funtion to stop captions
      */
-    stopCaptions(): Promise<void>;
+    stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>;
     /**
      * Start the video background effect.
      *
@@ -1182,6 +1146,18 @@ export declare interface CallAdapterCallOperations {
      * @public
      */
     updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
+    /**
+     * Start the noise suppression effect.
+     *
+     * @beta
+     */
+    startNoiseSuppressionEffect(): Promise<void>;
+    /**
+     * Stop the noise suppression effect.
+     *
+     * @beta
+     */
+    stopNoiseSuppressionEffect(): Promise<void>;
     /**
      * Send the end of call survey result
      *
@@ -1275,6 +1251,11 @@ export declare type CallAdapterClientState = {
      * Dependency to be injected for video background effect.
      */
     onResolveVideoEffectDependency?: () => Promise<VideoBackgroundEffectsDependency>;
+    /**
+     * Dependency to be injected for deep noise suppression effect.
+     * @beta
+     */
+    onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>;
     /**
      * State to track the selected video background effect.
      */
@@ -2296,23 +2277,23 @@ export declare interface CallCompositeStrings {
     /**
      * Side pane People section subheader.
      */
-    peoplePaneSubTitle: string;
+    peoplePaneSubTitle?: string;
     /**
      * Label for button to copy invite link
      */
-    copyInviteLinkButtonLabel: string;
+    copyInviteLinkButtonLabel?: string;
     /**
      * Label for button to copy invite link when it has been actioned
      */
-    copyInviteLinkButtonActionedLabel: string;
+    copyInviteLinkButtonActionedLabel?: string;
     /**
      * Label for button to open dialpad
      */
-    openDialpadButtonLabel: string;
+    openDialpadButtonLabel?: string;
     /**
      * Label for menu item to remove participant
      */
-    removeMenuLabel: string;
+    removeMenuLabel?: string;
     /**
      * Label for menu item to start spotlight on participant
      */
@@ -2340,23 +2321,23 @@ export declare interface CallCompositeStrings {
     /**
      * Label for add people dropdown
      */
-    peoplePaneAddPeopleButtonLabel: string;
+    peoplePaneAddPeopleButtonLabel?: string;
     /**
      * Label for button to start a call
      */
-    dialpadStartCallButtonLabel: string;
+    dialpadStartCallButtonLabel?: string;
     /**
      * Title for dialpad Modal
      */
-    dialpadModalTitle: string;
+    dialpadModalTitle?: string;
     /**
      * Aria Label for dialpad Modal
      */
-    dialpadModalAriaLabel: string;
+    dialpadModalAriaLabel?: string;
     /**
      * Aria Label for dialpad Modal close button
      */
-    dialpadCloseModalButtonAriaLabel: string;
+    dialpadCloseModalButtonAriaLabel?: string;
     /**
      * label for more button in the Calling composite
      */
@@ -2364,31 +2345,31 @@ export declare interface CallCompositeStrings {
     /**
      * Label for the resume call button on the hold pane
      */
-    resumeCallButtonLabel: string;
+    resumeCallButtonLabel?: string;
     /**
      * Label for the resume call button on the hold pane when call is resuming
      */
-    resumingCallButtonLabel: string;
+    resumingCallButtonLabel?: string;
     /**
      * Aria label for the resume call button on the hold pane
      */
-    resumeCallButtonAriaLabel: string;
+    resumeCallButtonAriaLabel?: string;
     /**
      * Aria label for the resume call button on the hold pane when call is resuming
      */
-    resumingCallButtonAriaLabel: string;
+    resumingCallButtonAriaLabel?: string;
     /**
      * Label for the hold pane
      */
-    holdScreenLabel: string;
+    holdScreenLabel?: string;
     /**
      * Placeholder text for dtmf dialpad
      */
-    dtmfDialpadPlaceholderText: string;
+    dtmfDialpadPlaceholderText?: string;
     /**
      * Label for the button to open dtmf dialpad
      */
-    openDtmfDialpadLabel: string;
+    openDtmfDialpadLabel?: string;
     /**
      * aria label for when the invite link has been actioned
      */
@@ -3055,8 +3036,6 @@ export declare type CallingBaseSelectorProps = {
  */
 export declare interface CallingHandlers extends CommonCallingHandlers {
     onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => Call | undefined;
-    onAcceptCall: (incomingCallId: string, useVideo?: boolean) => Promise<void>;
-    onRejectCall: (incomingCallId: string) => Promise<void>;
 }
 
 /**
@@ -3065,6 +3044,7 @@ export declare interface CallingHandlers extends CommonCallingHandlers {
  */
 export declare type CallingHandlersOptions = {
     onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency>;
+    onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>;
 };
 
 /**
@@ -3729,7 +3709,7 @@ export declare interface CallWithChatAdapterManagement {
      * Function to Start captions
      * @param options - options for start captions
      */
-    startCaptions(options?: StartCaptionsOptions): Promise<void>;
+    startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>;
     /**
      * Function to set caption language
      * @param language - language set for caption
@@ -3743,7 +3723,7 @@ export declare interface CallWithChatAdapterManagement {
     /**
      * Funtion to stop captions
      */
-    stopCaptions(): Promise<void>;
+    stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>;
     /**
      * Start the video background effect.
      *
@@ -3770,6 +3750,18 @@ export declare interface CallWithChatAdapterManagement {
      * @public
      */
     updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
+    /**
+     * Start the noise suppression effect.
+     *
+     * @beta
+     */
+    startNoiseSuppressionEffect(): Promise<void>;
+    /**
+     * Start the noise suppression effect.
+     *
+     * @beta
+     */
+    stopNoiseSuppressionEffect(): Promise<void>;
     /**
      * Send the end of call survey result
      *
@@ -3934,6 +3926,8 @@ export declare interface CallWithChatClientState {
     videoBackgroundImages?: VideoBackgroundImage[];
     /** Dependency to be injected for video background effects */
     onResolveVideoEffectDependency?: () => Promise<VideoBackgroundEffectsDependency>;
+    /** Dependency to be injected for deep noise suppression effect. */
+    onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>;
     /** State to track the selected video background effect */
     selectedVideoBackgroundEffect?: VideoBackgroundEffect;
     /** Hide attendee names in teams meeting */
@@ -4634,6 +4628,10 @@ export declare interface CameraButtonStrings {
      * Title for video effects menu item
      */
     videoEffectsMenuItemTitle?: string;
+    /**
+     * Aria description for camera button
+     */
+    cameraButtonAriaDescription?: string;
 }
 
 /**
@@ -5586,6 +5584,12 @@ export declare type CommonCallAdapterOptions = {
         videoBackgroundImages?: VideoBackgroundImage[];
         onResolveDependency?: () => Promise<VideoBackgroundEffectsDependency>;
     };
+    /**
+     * `DeepNoiseSuppressionEffect` options to be used for noise suppression.
+     */
+    deepNoiseSuppressionOptions?: {
+        onResolveDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>;
+    };
     /**
      * Use this to fetch profile information which will override data in {@link CallAdapterState} like display name
      * The onFetchProfile is fetch-and-forget one time action for each user, once a user profile is updated, the value will be cached
@@ -5601,6 +5605,11 @@ export declare type CommonCallAdapterOptions = {
      * @beta
      */
     reactionResources?: ReactionResources;
+    /**
+     * 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;
 };
 
 /**
@@ -5765,9 +5774,13 @@ export declare interface CommonCallingHandlers {
     onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>;
     askDevicePermission: (constrain: PermissionConstraints) => Promise<void>;
     onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => void;
+    onAcceptCall: (incomingCallId: string, useVideo?: boolean) => Promise<void>;
+    onRejectCall: (incomingCallId: string) => Promise<void>;
     onRemoveVideoBackgroundEffects: () => Promise<void>;
     onBlurVideoBackground: (backgroundBlurConfig?: BackgroundBlurConfig) => Promise<void>;
     onReplaceVideoBackground: (backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>;
+    onStartNoiseSuppressionEffect: () => Promise<void>;
+    onStopNoiseSuppressionEffect: () => Promise<void>;
     onStartCaptions: (options?: CaptionsOptions) => Promise<void>;
     onStopCaptions: () => Promise<void>;
     onSetSpokenLanguage: (language: string) => Promise<void>;
@@ -6614,6 +6627,7 @@ export declare const createDefaultChatHandlers: (chatClient: StatefulChatClient,
  */
 export declare const createDefaultTeamsCallingHandlers: (callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: {
     onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency>;
+    onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>;
 }) => TeamsCallingHandlers;
 
 /**
@@ -6852,6 +6866,15 @@ export declare type DeclarativeCallAgent = CallAgent & IncomingCallManagement;
  */
 export declare type DeclarativeTeamsCallAgent = TeamsCallAgent & TeamsIncomingCallManagement;
 
+/**
+ * Dependency type to be injected for deep noise suppression
+ *
+ * @beta
+ */
+export declare type DeepNoiseSuppressionEffectDependency = {
+    deepNoiseSuppressionEffect: AudioEffectsStartConfig;
+};
+
 /**
  * The default set of icons that are available to use in the UI components.
  *
@@ -7954,19 +7977,19 @@ export declare interface HoldButtonStrings {
     /**
      * Label for when action is to resume call.
      */
-    onLabel: string;
+    onLabel?: string;
     /**
      * Label for when action is to hold call.
      */
-    offLabel: string;
+    offLabel?: string;
     /**
      * Content for when button is checked
      */
-    tooltipOnContent: string;
+    tooltipOnContent?: string;
     /**
      * Content for when button is unchecked
      */
-    tooltipOffContent: string;
+    tooltipOffContent?: string;
 }
 
 /**
@@ -8242,6 +8265,10 @@ export declare interface IncomingCallNotificationStrings {
      * label for the reject button in the incoming call notification.
      */
     incomingCallNotificationRejectButtonLabel?: string;
+    /**
+     * Aria label for the incoming call dismiss button
+     */
+    incomingCallNotificationDismissButtonAriaLabel?: string;
 }
 
 /**
@@ -8276,6 +8303,30 @@ export declare interface IncomingCallNotificationStyles {
  */
 export declare const IncomingCallStack: (props: IncomingCallStackProps) => JSX.Element;
 
+/**
+ * Represents an active incoming call.
+ * @beta
+ */
+export declare interface IncomingCallStackCall {
+    /**
+     * Unique identifier for the incoming call.
+     */
+    id: string;
+    /**
+     * Information about the caller.
+     */
+    callerInfo: {
+        /**
+         * Display name of the caller.
+         */
+        displayName?: string;
+    };
+    /**
+     * Whether or not the call is a voip capable call.
+     */
+    videoAvailable: boolean;
+}
+
 /**
  * Props for the IncomingCallManager component.
  * @beta
@@ -8284,11 +8335,11 @@ export declare interface IncomingCallStackProps {
     /**
      * List of incoming calls.
      */
-    activeIncomingCalls: ActiveIncomingCall[];
+    activeIncomingCalls: IncomingCallStackCall[];
     /**
      * List of incoming calls that have ended.
      */
-    removedIncomingCalls: ActiveIncomingCall[];
+    removedIncomingCalls: IncomingCallStackCall[];
     /**
      * Handler to accept the incoming call.
      * @param incomingCallId - Id of the incoming call to accept.
@@ -8310,6 +8361,11 @@ export declare interface IncomingCallStackProps {
      * Strings for the incoming call notifications.
      */
     strings?: IncomingCallNotificationStrings;
+    /**
+     * Tab index for the incoming Call stack, this will set the tab order of the
+     * incoming call notifications in your application.
+     */
+    tabIndex?: number;
 }
 
 /**
@@ -8317,8 +8373,8 @@ export declare interface IncomingCallStackProps {
  * @beta
  */
 export declare type IncomingCallStackSelector = (state: CallClientState) => {
-    activeIncomingCalls: ActiveIncomingCall[];
-    removedIncomingCalls: ActiveIncomingCall[];
+    activeIncomingCalls: IncomingCallStackCall[];
+    removedIncomingCalls: IncomingCallStackCall[];
 };
 
 /**
@@ -9383,6 +9439,14 @@ export declare interface MicrophoneButtonProps extends ControlBarButtonProps {
      * Styles for {@link MicrophoneButton} and the device selection flyout.
      */
     styles?: Partial<MicrophoneButtonStyles>;
+    /**
+     * Whether the deep noise suppression is on or off
+     */
+    isDeepNoiseSuppressionOn?: boolean;
+    /**
+     * Callback when noise suppression is clicked
+     */
+    onClickNoiseSuppression?: () => void;
 }
 
 /**
@@ -9463,6 +9527,26 @@ export declare interface MicrophoneButtonStrings {
      * Title for primary action section of split button
      */
     microphonePrimaryActionSplitButtonTitle?: string;
+    /**
+     * Aria description for the microphone button
+     */
+    microphoneAriaDescription?: string;
+    /**
+     * Title when deep noise suppression is on
+     */
+    deepNoiseSuppresionOnTitle?: string;
+    /**
+     * Title when deep noise suppression is off
+     */
+    deepNoiseSuppresionOffTitle?: string;
+    /**
+     * Noise Suppression turned on string for announcer
+     */
+    deepNoiseSuppresionOnAnnouncement?: string;
+    /**
+     * Noise Suppression turned off string for announcer
+     */
+    deepNoiseSuppresionOffAnnouncement?: string;
 }
 
 /**
@@ -9876,6 +9960,20 @@ userId?: string, options?: CustomAvatarOptions,
  */
 defaultOnRender?: (props: CustomAvatarOptions) => JSX.Element) => JSX.Element | undefined;
 
+/**
+ *
+ * Dependency resolution for video background effects using lazy loading.
+ * @beta
+ */
+export declare const onResolveDeepNoiseSuppressionDependency: () => Promise<DeepNoiseSuppressionEffectDependency>;
+
+/**
+ *
+ * Dependency resolution for video background effects using lazy loading.
+ * @beta
+ */
+export declare const onResolveDeepNoiseSuppressionDependencyLazy: () => Promise<DeepNoiseSuppressionEffectDependency>;
+
 /**
  * Dependency resolution for video background effects.
  *
@@ -11505,6 +11603,20 @@ export declare interface SpotlightState {
  */
 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;
 
+/**
+ * Options passed to adapter.startCaptions
+ *
+ * @public
+ */
+export declare interface StartCaptionsAdapterOptions extends StartCaptionsOptions {
+    /**
+     * Start captions in the background without showing the captions UI to the Composite user.
+     *
+     * @defaultValue false
+     */
+    startInBackground?: boolean;
+}
+
 /**
  * Parameter to start a call using a Teams user identity.
  *
@@ -11661,15 +11773,6 @@ export declare type StatefulCallClientArgs = {
      * state. It is not used by StatefulCallClient.
      */
     userId: CommunicationUserIdentifier | /* @conditional-compile-remove(teams-identity-support) */ MicrosoftTeamsUserIdentifier;
-    /**
-     * A phone number in E.164 format that will be used to represent the callers identity. This number is required
-     * to start a PSTN call.
-     *
-     * example: +11234567
-     *
-     * This is not a cached value from the headless calling client.
-     */
-    alternateCallerId?: string;
 };
 
 /**
@@ -11787,6 +11890,23 @@ export declare interface StatefulDeviceManager extends DeviceManager {
     getUnparentedVideoStreams: () => LocalVideoStream[];
 }
 
+/**
+ * Options passed to adapter.stopCaptions
+ *
+ * @public
+ */
+export declare interface StopCaptionsAdapterOptions {
+    /**
+     * Stop captions that have been started in the background.
+     *
+     * @remarks
+     * This option is only applicable when stopping captions that have been started using the `startInBackground` property of adpater.startCaptions.
+     *
+     * @defaultValue false
+     */
+    stopInBackground?: boolean;
+}
+
 /**
  * Utility component to convert an HTMLElement with a video stream into a JSX element.
  *
@@ -11969,8 +12089,6 @@ export declare type TeamsCallAdapterArgsCommon = {
  */
 export declare interface TeamsCallingHandlers extends CommonCallingHandlers {
     onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | /* @conditional-compile-remove(teams-identity-support) */ TeamsCall;
-    onAcceptCall: (incomingCallId: string, useVideo?: boolean) => Promise<void>;
-    onRejectCall: (incomingCallId: string) => Promise<void>;
 }
 
 /**

package/dist/dist-cjs/communication-react/{ChatMessageComponentAsRichTextEditBox-qEJmtx93.js → ChatMessageComponentAsRichTextEditBox-K_vrVBbn.js}

@@ -4,7 +4,7 @@ var react = require('@fluentui/react');
 var reactChat = require('@fluentui-contrib/react-chat');
 var reactComponents = require('@fluentui/react-components');
 require('@azure/communication-common');
-var index = require('./index-DejG4i9h.js');
+var index = require('./index-CLXDq-Ko.js');
 var React = require('react');
 require('react-dom/client');
 require('@azure/communication-chat');
@@ -273,4 +273,4 @@ const ChatMessageComponentAsRichTextEditBox = (props) => {
 
 exports.ChatMessageComponentAsRichTextEditBox = ChatMessageComponentAsRichTextEditBox;
 exports.default = ChatMessageComponentAsRichTextEditBox;
-//# sourceMappingURL=ChatMessageComponentAsRichTextEditBox-qEJmtx93.js.map
+//# sourceMappingURL=ChatMessageComponentAsRichTextEditBox-K_vrVBbn.js.map