@azure/communication-react 1.7.1-alpha-202308290013 → 1.7.1-alpha-202308310013

package/dist/communication-react.d.ts

@@ -30,7 +30,7 @@ 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 type { CapabilitiesChangeInfo } 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';
@@ -1390,6 +1390,8 @@ 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;
@@ -2119,6 +2121,10 @@ export declare interface CallCompositeStrings {
      * Label for the selection of the focusedContentLayout (Focused content) layout
      */
     moreButtonGalleryFocusedContentLayoutLabel?: string;
+    /**
+     * All strings for capability changed notification
+     */
+    capabilityChangedNotification?: CapabilityChangedNotificationStrings;
 }
 
 /**
@@ -2251,7 +2257,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 pallete used by calling related components in this library.
+ * Custom Fluent theme palette used by calling related components in this library.
  *
  * @public
  */
@@ -2443,7 +2449,7 @@ export declare interface CallState {
     /**
      * Proxy of {@link @azure/communication-calling#CapabilitiesFeature}.
      */
-    capabilities?: CapabilitiesCallFeature;
+    capabilitiesFeature?: CapabilitiesFeatureState;
 }
 
 /**
@@ -2987,6 +2993,8 @@ 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;
@@ -3549,24 +3557,74 @@ 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 CapabilitiesCallFeature {
+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;
 }
 
 /**
- * Callback for {@link CallAdapterSubscribers} 'capabilitiesChanged' event.
- *
+ * Strings for capability changed notification
  * @beta
  */
-export declare type CapabilitiesChangedListener = (data: CapabilitiesChangeInfo) => void;
+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
@@ -4164,6 +4222,26 @@ 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}.
  *
@@ -5472,7 +5550,7 @@ export declare interface CustomMessage extends MessageCommon {
  *
  * @public
  */
-export declare const darkTheme: PartialTheme & CallingTheme;
+export declare const darkTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
 
 /**
  * @beta
@@ -5611,6 +5689,8 @@ 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;
@@ -5705,6 +5785,13 @@ 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;
@@ -6955,7 +7042,7 @@ export declare interface JumpToNewMessageButtonProps {
  *
  * @public
  */
-export declare const lightTheme: PartialTheme & CallingTheme;
+export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
 
 /**
  * Whether the stream is loading or not.