@azure/communication-react 1.4.3-alpha-202212180014.0 → 1.4.3-alpha-202212210013.0

package/dist/communication-react.d.ts

@@ -52,8 +52,6 @@ import { IContextualMenuItem } from '@fluentui/react';
 import { IContextualMenuItemStyles } from '@fluentui/react';
 import { IContextualMenuProps } from '@fluentui/react';
 import { IContextualMenuStyles } from '@fluentui/react';
-import { IDropdownOption } from '@fluentui/react';
-import { IDropdownStyles } from '@fluentui/react';
 import { ILinkStyles } from '@fluentui/react';
 import { IMessageBarProps } from '@fluentui/react';
 import { IncomingCall } from '@azure/communication-calling';
@@ -1189,15 +1187,11 @@ export declare type CallCompositeOptions = {
      */
     callControls?: boolean | CallControlOptions;
     /**
-     * Device permission restrictions for your call.
-     * Require device permissions to be set or have them as optional or not required to start a call
+     * Device permissions check options for your call.
+     * Here you can choose what device permissions you prompt the user for,
+     * as well as what device permissions must be accepted before starting a call.
      */
-    devicePermissions?: DevicePermissionRestrictions;
-    /**
-     * Opt in call readiness feature for your call
-     * Setting this to `true` will add call readiness features to the call experience
-     */
-    callReadinessOptedIn?: boolean;
+    deviceChecks?: DeviceCheckOptions;
     /**
      * Callback you may provide to supply users with further steps to troubleshoot why they have been
      * unable to grant your site the required permissions for the call.
@@ -2479,10 +2473,11 @@ export declare type CallWithChatCompositeOptions = {
      */
     fileSharing?: FileSharingOptions;
     /**
-     * Device permission restrictions for your call.
-     * Require device permissions to be set or have them as optional or not required to start a call
+     * Device permissions check options for your call.
+     * Here you can choose what device permissions you prompt the user for,
+     * as well as what device permissions must be accepted before starting a call.
      */
-    devicePermissions?: DevicePermissionRestrictions;
+    deviceChecks?: DeviceCheckOptions;
     /**
      * Callback you may provide to supply users with further steps to troubleshoot why they have been
      * unable to grant your site the required permissions for the call.
@@ -2515,10 +2510,18 @@ export declare type CallWithChatCompositeOptions = {
      */
     onNetworkingTroubleShootingClick?: () => void;
     /**
-     * Opt in call readiness feature for your call
-     * setting this to True will add call readiness feature in call experience
+     * Callback you may provide to supply users with a provided page to showcase supported browsers by ACS.
+     *
+     * @example
+     * ```ts
+     * onBrowserTroubleShootingClick?: () =>
+     *  window.open('https://contoso.com/browser-troubleshooting', '_blank');
+     * ```
+     *
+     * @remarks
+     * if this is not supplied, the composite will not show a unsupported browser page.
      */
-    callReadinessOptedIn?: boolean;
+    onEnvironmentInfoTroubleshootingClick?: () => void;
 };
 
 /**
@@ -2781,28 +2784,28 @@ export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded'
  * Component to allow Contoso to help their end user with their devices should their permissions be blocked
  * by their browsers settings.
  */
-export declare const CameraAndMicrophoneDomainPermissions: (props: CameraAndMicrophoneDomainPermissionsProps) => JSX.Element;
+export declare const CameraAndMicrophoneSitePermissions: (props: CameraAndMicrophoneSitePermissionsProps) => JSX.Element;
 
 /**
  * @beta
- * Props for CameraAndMicrophoneDomainPermissions component.
+ * Props for CameraAndMicrophoneSitePermissions component.
  */
-export declare interface CameraAndMicrophoneDomainPermissionsProps extends CommonDomainPermissionsProps {
+export declare interface CameraAndMicrophoneSitePermissionsProps extends CommonSitePermissionsProps {
     /** Icon name for the camera icon */
     cameraIconName?: string;
     /** Icon name for the microphone icon */
     microphoneIconName?: string;
     /** Icon name for the central icon between the camera and microphone icons */
     connectorIconName?: string;
-    /** Strings for use with the {@link CameraAndMicrophoneDomainPermissions} */
-    strings?: CameraAndMicrophoneDomainPermissionsStrings;
+    /** Strings for use with the {@link CameraAndMicrophoneSitePermissions} */
+    strings?: CameraAndMicrophoneSitePermissionsStrings;
 }
 
 /**
  * @beta
- * Strings for CameraAndMicrophoneDomainPermissions component.
+ * Strings for CameraAndMicrophoneSitePermissions component.
  */
-export declare type CameraAndMicrophoneDomainPermissionsStrings = DomainPermissionsStrings;
+export declare type CameraAndMicrophoneSitePermissionsStrings = SitePermissionsStrings;
 
 /**
  * A button to turn camera on / off.
@@ -2946,24 +2949,24 @@ export declare interface CameraButtonStyles extends ControlBarButtonStyles {
  *
  * @beta
  */
-export declare const CameraDomainPermissions: (props: CameraDomainPermissionsProps) => JSX.Element;
+export declare const CameraSitePermissions: (props: CameraSitePermissionsProps) => JSX.Element;
 
 /**
  * @beta
- * Props for CameraDomainPermissions component.
+ * Props for CameraSitePermissions component.
  */
-export declare interface CameraDomainPermissionsProps extends CommonDomainPermissionsProps {
+export declare interface CameraSitePermissionsProps extends CommonSitePermissionsProps {
     /** Icon name for the camera icon */
     cameraIconName?: string;
-    /** Strings for use with the {@link CameraDomainPermissions} */
-    strings?: CameraDomainPermissionsStrings;
+    /** Strings for use with the {@link CameraSitePermissions} */
+    strings?: CameraSitePermissionsStrings;
 }
 
 /**
  * @beta
- * Strings for CameraDomainPermissions component.
+ * Strings for CameraSitePermissions component.
  */
-export declare type CameraDomainPermissionsStrings = DomainPermissionsStrings;
+export declare type CameraSitePermissionsStrings = SitePermissionsStrings;
 
 /**
  * {@link ChatComposite} Adapter interface.
@@ -3586,21 +3589,30 @@ export declare interface CommonCallingHandlers {
     onStartCall: (participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | UnknownIdentifier)[], options?: StartCallOptions) => void;
 }
 
+/**
+ * Return intersect properties of 2 types
+ *
+ * @public
+ */
+export declare type CommonProperties<A, B> = {
+    [P in keyof A & keyof B]: A[P] extends B[P] ? P : never;
+}[keyof A & keyof B];
+
 /**
  * @beta
- * Props for DomainPermissions components.
+ * Props for SitePermissions components.
  */
-export declare interface CommonDomainPermissionsProps {
+export declare interface CommonSitePermissionsProps {
     /**
      * Name of application calling experience is in.
      */
     appName: string;
     /**
-     * Type of the Domain Permissions component.
+     * Type of the Site Permissions component.
      */
     type: 'request' | 'denied' | 'check';
     /**
-     * Type of the browser used, the domain permission component will show different guidance text based on the browser type
+     * Type of the browser used, the Site permission component will show different guidance text based on the browser type
      */
     browserHint?: 'safari' | 'unset';
     /**
@@ -3614,20 +3626,11 @@ export declare interface CommonDomainPermissionsProps {
      */
     onContinueAnywayClick?: () => void;
     /**
-     * Styles for DomainPermissions component.
+     * Styles for SitePermissions component.
      */
-    styles?: DomainPermissionsStyles;
+    styles?: SitePermissionsStyles;
 }
 
-/**
- * Return intersect properties of 2 types
- *
- * @public
- */
-export declare type CommonProperties<A, B> = {
-    [P in keyof A & keyof B]: A[P] extends B[P] ? P : never;
-}[keyof A & keyof B];
-
 /**
  * A Chat or Calling participant's state, as reflected in the UI.
  *
@@ -3807,30 +3810,30 @@ export declare interface ComponentStrings {
     videoTile: VideoTileStrings;
     /** Strings for HoldButton */
     holdButton: HoldButtonStrings;
-    /** Strings for a domain permission request prompt */
-    CameraAndMicrophoneDomainPermissionsRequest: DomainPermissionsStrings;
-    /** Strings for a domain permission request prompt */
-    CameraDomainPermissionsRequest: DomainPermissionsStrings;
-    /** Strings for a domain permission request prompt */
-    MicrophoneDomainPermissionsRequest: DomainPermissionsStrings;
-    /** Strings for a domain permission generic checking prompt */
-    CameraAndMicrophoneDomainPermissionsCheck: DomainPermissionsStrings;
-    /** Strings for a domain permission generic checking prompt */
-    CameraDomainPermissionsCheck: DomainPermissionsStrings;
-    /** Strings for a domain permission generic checking prompt */
-    MicrophoneDomainPermissionsCheck: DomainPermissionsStrings;
-    /** Strings for a domain permission denied prompt */
-    CameraAndMicrophoneDomainPermissionsDenied: DomainPermissionsStrings;
-    /** Strings for a domain permission denied prompt for safari browsers*/
-    CameraAndMicrophoneDomainPermissionsDeniedSafari: DomainPermissionsStrings;
-    /** Strings for a domain permission denied prompt */
-    CameraDomainPermissionsDenied: DomainPermissionsStrings;
-    /** Strings for a domain permission denied prompt */
-    MicrophoneDomainPermissionsDenied: DomainPermissionsStrings;
-    /** Strings for a domain permission denied prompt for safari browsers*/
-    CameraDomainPermissionsDeniedSafari: DomainPermissionsStrings;
-    /** Strings for a domain permission denied prompt for safari browsers*/
-    MicrophoneDomainPermissionsDeniedSafari: DomainPermissionsStrings;
+    /** Strings for a site's permission request prompt */
+    CameraAndMicrophoneSitePermissionsRequest: SitePermissionsStrings;
+    /** Strings for a site's permission request prompt */
+    CameraSitePermissionsRequest: SitePermissionsStrings;
+    /** Strings for a site's permission request prompt */
+    MicrophoneSitePermissionsRequest: SitePermissionsStrings;
+    /** Strings for a site's permission generic checking prompt */
+    CameraAndMicrophoneSitePermissionsCheck: SitePermissionsStrings;
+    /** Strings for a site's permission generic checking prompt */
+    CameraSitePermissionsCheck: SitePermissionsStrings;
+    /** Strings for a site's permission generic checking prompt */
+    MicrophoneSitePermissionsCheck: SitePermissionsStrings;
+    /** Strings for a site's permission denied prompt */
+    CameraAndMicrophoneSitePermissionsDenied: SitePermissionsStrings;
+    /** Strings for a site's permission denied prompt for safari browsers*/
+    CameraAndMicrophoneSitePermissionsDeniedSafari: SitePermissionsStrings;
+    /** Strings for a site's permission denied prompt */
+    CameraSitePermissionsDenied: SitePermissionsStrings;
+    /** Strings for a site's permission denied prompt */
+    MicrophoneSitePermissionsDenied: SitePermissionsStrings;
+    /** Strings for a site's permission denied prompt for safari browsers*/
+    CameraSitePermissionsDeniedSafari: SitePermissionsStrings;
+    /** Strings for a site's permission denied prompt for safari browsers*/
+    MicrophoneSitePermissionsDeniedSafari: SitePermissionsStrings;
     /** Strings for unsupported browser UI */
     UnsupportedBrowser: UnsupportedBrowserStrings;
     /** Strings for unsupported browser version UI */
@@ -4568,11 +4571,11 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     SendBoxSendHovered: JSX.Element;
     VideoTileMicOff: JSX.Element;
     DialpadBackspace: JSX.Element;
-    DomainPermissionsSparkle: JSX.Element;
-    DomainPermissionCamera: JSX.Element;
-    DomainPermissionMic: JSX.Element;
-    DomainPermissionCameraDenied: JSX.Element;
-    DomainPermissionMicDenied: JSX.Element;
+    SitePermissionsSparkle: JSX.Element;
+    SitePermissionCamera: JSX.Element;
+    SitePermissionMic: JSX.Element;
+    SitePermissionCameraDenied: JSX.Element;
+    SitePermissionMicDenied: JSX.Element;
     UnsupportedEnvironmentWarning: JSX.Element;
     BrowserPermissionDeniedError: JSX.Element;
     VideoTilePinned: JSX.Element;
@@ -4669,11 +4672,11 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     HoldCallButton: JSX.Element;
     ResumeCall: JSX.Element;
     DialpadBackspace: JSX.Element;
-    DomainPermissionsSparkle: JSX.Element;
-    DomainPermissionCamera: JSX.Element;
-    DomainPermissionMic: JSX.Element;
-    DomainPermissionCameraDenied: JSX.Element;
-    DomainPermissionMicDenied: JSX.Element;
+    SitePermissionsSparkle: JSX.Element;
+    SitePermissionCamera: JSX.Element;
+    SitePermissionMic: JSX.Element;
+    SitePermissionCameraDenied: JSX.Element;
+    SitePermissionMicDenied: JSX.Element;
     UnsupportedEnvironmentWarning: JSX.Element;
     BrowserPermissionDeniedError: JSX.Element;
     VideoTilePinned: JSX.Element;
@@ -4684,6 +4687,29 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     UnpinParticipant: JSX.Element;
 };
 
+/**
+ * Device Checks.
+ * Choose whether or not to block starting a call depending on camera and microphone permission options.
+ *
+ * @beta
+ */
+export declare interface DeviceCheckOptions {
+    /**
+     * Camera Permission prompts for your call.
+     * 'required' - requires the permission to be allowed before permitting the user join the call.
+     * 'optional' - permission can be disallowed and the user is still permitted to join the call.
+     * 'doNotPrompt' - permission is not required and the user is not prompted to allow the permission.
+     */
+    camera: 'required' | 'optional' | 'doNotPrompt';
+    /**
+     * Microphone permission prompts for your call.
+     * 'required' - requires the permission to be allowed before permitting the user join the call.
+     * 'optional' - permission can be disallowed and the user is still permitted to join the call.
+     * 'doNotPrompt' - permission is not required and the user is not prompted to allow the permission.
+     */
+    microphone: 'required' | 'optional' | 'doNotPrompt';
+}
+
 /**
  * This type is meant to encapsulate all the state inside {@link @azure/communication-calling#DeviceManager}. For
  * optional parameters they may not be available until permission is granted by the user. The cameras, microphones,
@@ -4739,95 +4765,6 @@ export declare type DeviceManagerState = {
     unparentedViews: LocalVideoStreamState[];
 };
 
-/**
- * A dropdown to trigger device permission prompt
- *
- * @internal
- */
-export declare const _DevicePermissionDropdown: (props: _DevicePermissionDropdownProps) => JSX.Element;
-
-/**
- * Props for {@link _DevicePermissionDropdown}.
- *
- * @internal
- */
-export declare interface _DevicePermissionDropdownProps {
-    /**
-     * icon shown in dropdown placeholder
-     */
-    icon?: JSX.Element;
-    /**
-     * Dropdown content
-     */
-    options?: IDropdownOption[];
-    /**
-     * Ask for permissions of devices.
-     *
-     * @remarks
-     * Browser permission window will pop up if permissions are not granted yet
-     *
-     * @param constrain - Define constraints for accessing local devices {@link @azure/communication-calling#PermissionConstraints }
-     */
-    askDevicePermission?(constrain: _PermissionConstraints): Promise<void>;
-    /**
-     * Optional callback when component is clicked
-     */
-    onClick?: () => void;
-    /**
-     * Define constraints for accessing local devices  {@link @azure/communication-calling#PermissionConstraints }
-     */
-    constrain?: _PermissionConstraints;
-    /**
-     * Strings for devicepermissiondropdown
-     */
-    strings?: _DevicePermissionDropdownStrings;
-    /**
-     * Styles for devicepermissiondropdown
-     */
-    styles?: Partial<IDropdownStyles>;
-}
-
-/**
- * Strings of {@link DevicePermissionDropdown} that can be overridden.
- *
- * @internal
- */
-export declare interface _DevicePermissionDropdownStrings {
-    /**
-     * dropdown label
-     */
-    label?: string;
-    /**
-     * dropdown placeholder
-     */
-    placeHolderText: string;
-    /** string for action button  */
-    actionButtonContent?: string;
-}
-
-/**
- * Device Permission restrictions.
- * Be able to start a call depending on camera and microphone permission options.
- *
- * @beta
- */
-export declare interface DevicePermissionRestrictions {
-    /**
-     * Camera Permission prompts for your call.
-     * 'required' - requires the permission to be allowed before permitting the user join the call.
-     * 'optional' - permission can be disallowed and the user is still permitted to join the call.
-     * 'doNotPrompt' - permission is not required and the user is not prompted to allow the permission.
-     */
-    camera: 'required' | 'optional' | 'doNotPrompt';
-    /**
-     * Microphone permission prompts for your call.
-     * 'required' - requires the permission to be allowed before permitting the user join the call.
-     * 'optional' - permission can be disallowed and the user is still permitted to join the call.
-     * 'doNotPrompt' - permission is not required and the user is not prompted to allow the permission.
-     */
-    microphone: 'required' | 'optional' | 'doNotPrompt';
-}
-
 /**
  * A button to open a menu that controls device options.
  *
@@ -5065,45 +5002,6 @@ export declare interface Disposable {
     dispose(): void;
 }
 
-/**
- * @beta
- * Strings for DomainPermissions component
- */
-export declare type DomainPermissionsStrings = {
-    /**
-     * Main text string.
-     */
-    primaryText?: string;
-    /**
-     * Subtext string.
-     */
-    secondaryText?: string;
-    /**
-     * More help link string.
-     */
-    linkText?: string;
-    /**
-     * Primary button text string.
-     */
-    primaryButtonText?: string;
-    /**
-     * Aria label describing the content of the container
-     */
-    ariaLabel?: string;
-};
-
-/**
- * Fluent styles for {@link DomainPermissionsContainer}.
- *
- * @beta
- */
-export declare interface DomainPermissionsStyles extends BaseCustomStyles {
-    /** Styles for the primary button. */
-    primaryButton?: IButtonStyles;
-    /** Styles for the help troubleshooting link text. */
-    troubleshootingLink?: ILinkStyles;
-}
-
 /**
  * DTMF tone for PSTN calls.
  *
@@ -5584,7 +5482,7 @@ export declare const fromFlatCommunicationIdentifier: (id: string) => Communicat
  *
  * @public
  */
-export declare type GetCallingSelector<Component extends (props: any) => JSX.Element | undefined> = AreEqual<Component, typeof VideoGallery> extends true ? VideoGallerySelector : AreEqual<Component, typeof DevicesButton> extends true ? DevicesButtonSelector : AreEqual<Component, typeof MicrophoneButton> extends true ? MicrophoneButtonSelector : AreEqual<Component, typeof CameraButton> extends true ? CameraButtonSelector : AreEqual<Component, typeof ScreenShareButton> extends true ? ScreenShareButtonSelector : AreEqual<Component, typeof ParticipantList> extends true ? ParticipantListSelector : AreEqual<Component, typeof ParticipantsButton> extends true ? ParticipantsButtonSelector : AreEqual<Component, typeof EndCallButton> extends true ? EmptySelector : AreEqual<Component, typeof ErrorBar> extends true ? CallErrorBarSelector : AreEqual<Component, typeof Dialpad> extends true ? EmptySelector : AreEqual<Component, typeof HoldButton> extends true ? HoldButtonSelector : AreEqual<Component, typeof _DevicePermissionDropdown> extends true ? EmptySelector : undefined;
+export declare type GetCallingSelector<Component extends (props: any) => JSX.Element | undefined> = AreEqual<Component, typeof VideoGallery> extends true ? VideoGallerySelector : AreEqual<Component, typeof DevicesButton> extends true ? DevicesButtonSelector : AreEqual<Component, typeof MicrophoneButton> extends true ? MicrophoneButtonSelector : AreEqual<Component, typeof CameraButton> extends true ? CameraButtonSelector : AreEqual<Component, typeof ScreenShareButton> extends true ? ScreenShareButtonSelector : AreEqual<Component, typeof ParticipantList> extends true ? ParticipantListSelector : AreEqual<Component, typeof ParticipantsButton> extends true ? ParticipantsButtonSelector : AreEqual<Component, typeof EndCallButton> extends true ? EmptySelector : AreEqual<Component, typeof ErrorBar> extends true ? CallErrorBarSelector : AreEqual<Component, typeof Dialpad> extends true ? EmptySelector : AreEqual<Component, typeof HoldButton> extends true ? HoldButtonSelector : undefined;
 
 /**
  * Get the selector for a specified component.
@@ -6576,24 +6474,24 @@ export declare interface MicrophoneButtonStyles extends ControlBarButtonStyles {
  *
  * @beta
  */
-export declare const MicrophoneDomainPermissions: (props: MicrophoneDomainPermissionsProps) => JSX.Element;
+export declare const MicrophoneSitePermissions: (props: MicrophoneSitePermissionsProps) => JSX.Element;
 
 /**
  * @beta
- * Props for MicrophoneDomainPermissions component.
+ * Props for MicrophoneSitePermissions component.
  */
-export declare interface MicrophoneDomainPermissionsProps extends CommonDomainPermissionsProps {
+export declare interface MicrophoneSitePermissionsProps extends CommonSitePermissionsProps {
     /** Icon name for the microphone icon */
     microphoneIconName?: string;
-    /** Strings for use with the {@link MicrophoneDomainPermissions} */
-    strings?: MicrophoneDomainPermissionsStrings;
+    /** Strings for use with the {@link MicrophoneSitePermissions} */
+    strings?: MicrophoneSitePermissionsStrings;
 }
 
 /**
  * @beta
- * Strings for MicrophoneDomainPermissions component.
+ * Strings for MicrophoneSitePermissions component.
  */
-export declare type MicrophoneDomainPermissionsStrings = DomainPermissionsStrings;
+export declare type MicrophoneSitePermissionsStrings = SitePermissionsStrings;
 
 /**
  * Payload for {@link DiagnosticChangedEventListner} where there is a change in a network diagnostic.
@@ -7043,16 +6941,6 @@ export declare type ParticipantsRemovedListener = (event: {
  */
 export declare type ParticipantState = 'Idle' | 'Connecting' | 'Ringing' | 'Connected' | 'Hold' | 'InLobby' | 'EarlyMedia' | 'Disconnected';
 
-/**
- * Define constraints for accessing local devices  {@link @azure/communication-calling#PermissionConstraints }
- *
- * @internal
- */
-export declare type _PermissionConstraints = {
-    audio: boolean;
-    video: boolean;
-};
-
 /**
  * An array of key value pairs that stores each sender's display name and last read message
  *
@@ -7382,6 +7270,45 @@ export declare interface SendBoxStylesProps extends BaseCustomStyles {
     systemMessage?: IStyle;
 }
 
+/**
+ * @beta
+ * Strings for SitePermissions component
+ */
+export declare type SitePermissionsStrings = {
+    /**
+     * Main text string.
+     */
+    primaryText?: string;
+    /**
+     * Subtext string.
+     */
+    secondaryText?: string;
+    /**
+     * More help link string.
+     */
+    linkText?: string;
+    /**
+     * Primary button text string.
+     */
+    primaryButtonText?: string;
+    /**
+     * Aria label describing the content of the container
+     */
+    ariaLabel?: string;
+};
+
+/**
+ * Fluent styles for {@link SitePermissionsContainer}.
+ *
+ * @beta
+ */
+export declare interface SitePermissionsStyles extends BaseCustomStyles {
+    /** Styles for the primary button. */
+    primaryButton?: IButtonStyles;
+    /** Styles for the help troubleshooting link text. */
+    troubleshootingLink?: ILinkStyles;
+}
+
 /**
  * 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