@azure/communication-react 1.4.2-alpha-202211220015.0 → 1.4.2-alpha-202211240014.0

package/dist/communication-react.d.ts

@@ -44,6 +44,7 @@ import { DeviceAccess } from '@azure/communication-calling';
 import { DeviceManager } from '@azure/communication-calling';
 import { DominantSpeakersInfo } from '@azure/communication-calling';
 import { DtmfTone as DtmfTone_2 } from '@azure/communication-calling';
+import { EnvironmentInfo } from '@azure/communication-calling';
 import { GroupCallLocator } from '@azure/communication-calling';
 import { IButtonProps } from '@fluentui/react';
 import { IButtonStyles } from '@fluentui/react';
@@ -290,6 +291,10 @@ export declare type AzureCommunicationCallAdapterOptions = {
      * {@link CallComposite}. The true role of the user will be synced with ACS services when a Rooms call starts.
      */
     roleHint?: Role;
+    /**
+     * Optional feature flags to be enabled in the CallAdapter.
+     */
+    features?: CallAdapterOptionalFeatures;
 };
 
 /**
@@ -304,6 +309,7 @@ export declare type AzureCommunicationCallWithChatAdapterArgs = {
     credential: CommunicationTokenCredential;
     locator: CallAndChatLocator | TeamsMeetingLinkLocator;
     alternateCallerId?: string;
+    callAdapterOptions?: AzureCommunicationCallAdapterOptions;
 };
 
 /**
@@ -518,11 +524,33 @@ export declare interface BrowserPermissionDeniedStyles extends BaseCustomStyles
 }
 
 /**
- * {@link CallComposite} Adapter interface.
+ *  An Adapter interface specific for Azure Communication identity which extends {@link CommonCallAdapter}.
  *
  * @public
  */
-export declare interface CallAdapter extends AdapterState<CallAdapterState>, Disposable, CallAdapterCallManagement, CallAdapterDeviceManagement, CallAdapterSubscribers {
+export declare interface CallAdapter extends CommonCallAdapter {
+    /**
+     * Join the call with microphone initially on/off.
+     *
+     * @param microphoneOn - Whether microphone is initially enabled
+     *
+     * @public
+     */
+    joinCall(microphoneOn?: boolean): Call | undefined;
+    /**
+     * Start the call.
+     *
+     * @param participants - An array of participant ids to join
+     *
+     * @public
+     */
+    startCall(participants: string[], options?: StartCallOptions): Call | undefined;
+    /**
+     * Start the call.
+     * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
+     * @beta
+     */
+    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
 }
 
 /**
@@ -535,11 +563,11 @@ export declare type CallAdapterCallEndedEvent = {
 };
 
 /**
- * Functionality for managing the current call.
- *
+ * Functionality for managing the current call or start a new call
+ * @deprecated CallAdapter interface will be flatten, consider using CallAdapter directly
  * @public
  */
-export declare interface CallAdapterCallManagement {
+export declare interface CallAdapterCallManagement extends CallAdapterCallOperations {
     /**
      * Join the call with microphone initially on/off.
      *
@@ -548,6 +576,28 @@ export declare interface CallAdapterCallManagement {
      * @public
      */
     joinCall(microphoneOn?: boolean): Call | undefined;
+    /**
+     * Start the call.
+     *
+     * @param participants - An array of participant ids to join
+     *
+     * @public
+     */
+    startCall(participants: string[], options?: StartCallOptions): Call | undefined;
+    /**
+     * Start the call.
+     * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
+     * @beta
+     */
+    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
+}
+
+/**
+ * Functionality for managing the current call.
+ *
+ * @public
+ */
+export declare interface CallAdapterCallOperations {
     /**
      * Leave the call
      *
@@ -584,20 +634,6 @@ export declare interface CallAdapterCallManagement {
      * @public
      */
     unmute(): Promise<void>;
-    /**
-     * Start the call.
-     *
-     * @param participants - An array of participant ids to join
-     *
-     * @public
-     */
-    startCall(participants: string[], options?: StartCallOptions): Call | undefined;
-    /**
-     * Start the call.
-     * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
-     */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
     /**
      * Start sharing the screen during a call.
      *
@@ -676,7 +712,7 @@ export declare interface CallAdapterCallManagement {
 }
 
 /**
- * {@link CallAdapter} state inferred from Azure Communication Services backend.
+ * {@link CommonCallAdapter} state inferred from Azure Communication Services backend.
  *
  * @public
  */
@@ -695,6 +731,14 @@ export declare type CallAdapterClientState = {
      * Azure communications Phone number to make PSTN calls with.
      */
     alternateCallerId?: string;
+    /**
+     * Environment information about system the adapter is made on
+     */
+    environmentInfo?: EnvironmentInfo;
+    /**
+     * Optional features that are to be enabled through the adapter.
+     */
+    features?: CallAdapterOptionalFeatures;
     /**
      * Use this to hint the role of the user when the role is not available before a Rooms call is started. This value
      * should be obtained using the Rooms API. This role will determine permissions in the configuration page of the
@@ -788,7 +832,19 @@ export declare interface CallAdapterDeviceManagement {
 export declare type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator | /* @conditional-compile-remove(rooms) */ RoomCallLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator;
 
 /**
- * {@link CallAdapter} state.
+ * options object to enable opt in features for the CallAdapter
+ *
+ * @beta
+ */
+export declare type CallAdapterOptionalFeatures = {
+    /**
+     * Feature flag for enabling the unsupported environment logic in the CallAdapter.
+     */
+    unsupportedEnvironment?: boolean;
+};
+
+/**
+ * {@link CommonCallAdapter} state.
  *
  * @public
  */
@@ -913,7 +969,7 @@ export declare interface CallAdapterSubscribers {
 }
 
 /**
- * {@link CallAdapter} state for pure UI purposes.
+ * {@link CommonCallAdapter} state for pure UI purposes.
  *
  * @public
  */
@@ -1056,6 +1112,10 @@ export declare interface CallClientState {
      * be used as the caller id in the PSTN call.
      */
     alternateCallerId?: string;
+    /**
+     * state to track the environment that the stateful client was made in is supported
+     */
+    environmentInfo?: EnvironmentInfo;
 }
 
 /**
@@ -1216,7 +1276,7 @@ export declare interface CallCompositeProps extends BaseCompositeProps<CallCompo
      * An adapter provides logic and data to the composite.
      * Composite can also be controlled using the adapter.
      */
-    adapter: CallAdapter;
+    adapter: CommonCallAdapter;
     /**
      * Optimizes the composite form factor for either desktop or mobile.
      * @remarks `mobile` is currently only optimized for Portrait mode on mobile devices and does not support landscape.
@@ -2262,6 +2322,8 @@ export declare interface CallWithChatClientState {
     isTeamsCall: boolean;
     /** alternateCallerId for PSTN call */
     alternateCallerId?: string | undefined;
+    /** Environment information for system adapter is made on */
+    environmentInfo?: EnvironmentInfo;
 }
 
 /**
@@ -3408,6 +3470,36 @@ export declare type ClientState = CallClientState & ChatClientState;
  */
 export declare type Common<A, B> = Pick<A, CommonProperties<A, B>>;
 
+/**
+ * {@link CallComposite} Adapter interface.
+ *
+ * @public
+ */
+export declare interface CommonCallAdapter extends AdapterState<CallAdapterState>, Disposable, CallAdapterCallOperations, CallAdapterDeviceManagement, CallAdapterSubscribers {
+    /**
+     * Join the call with microphone initially on/off.
+     *
+     * @param microphoneOn - Whether microphone is initially enabled
+     *
+     * @public
+     */
+    joinCall(microphoneOn?: boolean): void;
+    /**
+     * Start the call.
+     *
+     * @param participants - An array of participant ids to join
+     *
+     * @public
+     */
+    startCall(participants: string[], options?: StartCallOptions): void;
+    /**
+     * Start the call.
+     * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
+     * @beta
+     */
+    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): void;
+}
+
 /**
  * Object containing all the handlers required for calling components.
  *
@@ -3999,9 +4091,7 @@ export declare const createAzureCommunicationCallAdapter: ({ userId, displayName
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: {
-    roleHint?: Role;
-}) => Promise<CallAdapter>;
+export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
 
 /**
  * Create a CallWithChatAdapter backed by Azure Communication services
@@ -4009,7 +4099,7 @@ export declare const createAzureCommunicationCallAdapterFromClient: (callClient:
  *
  * @public
  */
-export declare const createAzureCommunicationCallWithChatAdapter: ({ userId, displayName, credential, endpoint, locator, alternateCallerId }: AzureCommunicationCallWithChatAdapterArgs) => Promise<CallWithChatAdapter>;
+export declare const createAzureCommunicationCallWithChatAdapter: ({ userId, displayName, credential, endpoint, locator, alternateCallerId, callAdapterOptions }: AzureCommunicationCallWithChatAdapterArgs) => Promise<CallWithChatAdapter>;
 
 /**
  * Create a {@link CallWithChatAdapter} using the provided {@link StatefulChatClient} and {@link StatefulCallClient}.
@@ -4040,6 +4130,21 @@ export declare const createAzureCommunicationChatAdapter: ({ endpoint: endpointU
  */
 export declare const createAzureCommunicationChatAdapterFromClient: (chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient) => Promise<ChatAdapter>;
 
+/**
+ * @beta
+ */
+export declare const createAzureCommunicationTeamsCallAdapter: ({ userId, credential, locator, alternateCallerId }: AzureCommunicationCallAdapterArgs) => Promise<TeamsCallAdapter>;
+
+/**
+ * Create a {@link TeamsCallAdapter} using the provided {@link StatefulCallClient}.
+ *
+ * Useful if you want to keep a reference to {@link StatefulCallClient}.
+ * Consider using {@link createAzureCommunicationCallAdapter} for a simpler API.
+ *
+ * @beta
+ */
+export declare const createAzureCommunicationTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator) => Promise<TeamsCallAdapter>;
+
 /**
  * Create the default implementation of {@link CallingHandlers} for teams call.
  *
@@ -5011,6 +5116,16 @@ export declare interface ErrorBarProps extends IMessageBarProps {
      * Currently active errors.
      */
     activeErrorMessages: ActiveErrorMessage[];
+    /**
+     * If set, errors with {@link ActiveErrorMessage.timestamp} older than the time this component is mounted
+     * are not shown.
+     *
+     * This is useful when using the {@link ErrorBar} with a stateful client that handles more than one call
+     * or chat thread. Set this prop to ignore errors from previous call or chat.
+     *
+     * @defaultValue false
+     */
+    ignorePremountErrors?: boolean;
 }
 
 /**
@@ -7458,6 +7573,36 @@ export declare interface SystemMessageCommon extends MessageCommon {
     iconName: string;
 }
 
+/**
+ * An Adapter interface specific for Teams identity which extends {@link CommonCallAdapter}.
+ *
+ * @beta
+ */
+export declare interface TeamsCallAdapter extends CommonCallAdapter {
+    /**
+     * Join the call with microphone initially on/off.
+     *
+     * @param microphoneOn - Whether microphone is initially enabled
+     *
+     * @beta
+     */
+    joinCall(microphoneOn?: boolean): TeamsCall | undefined;
+    /**
+     * Start the call.
+     *
+     * @param participants - An array of participant ids to join
+     *
+     * @beta
+     */
+    startCall(participants: string[], options?: StartCallOptions): TeamsCall | undefined;
+    /**
+     * Start the call.
+     * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
+     * @beta
+     */
+    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): TeamsCall | undefined;
+}
+
 /**
  * Object containing all the teams call handlers required for calling components.
  *
@@ -7738,6 +7883,22 @@ export declare const useAzureCommunicationCallWithChatAdapter: (args: Partial<Az
  */
 export declare const useAzureCommunicationChatAdapter: (args: Partial<AzureCommunicationChatAdapterArgs>, afterCreate?: ((adapter: ChatAdapter) => Promise<ChatAdapter>) | undefined, beforeDispose?: ((adapter: ChatAdapter) => Promise<void>) | undefined) => ChatAdapter | undefined;
 
+/**
+ * A custom React hook to simplify the creation of {@link TeamsCallAdapter}.
+ *
+ * Similar to {@link createTeamsAzureCommunicationCallAdapter}, but takes care of asynchronous
+ * creation of the adapter internally.
+ *
+ * Allows arguments to be undefined so that you can respect the rule-of-hooks and pass in arguments
+ * as they are created. The adapter is only created when all arguments are defined.
+ *
+ * Note that you must memoize the arguments to avoid recreating adapter on each render.
+ * See storybook for typical usage examples.
+ *
+ * @beta
+ */
+export declare const useAzureCommunicationTeamsCallAdapter: (args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: ((adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>) | undefined, beforeDispose?: ((adapter: TeamsCallAdapter) => Promise<void>) | undefined) => TeamsCallAdapter | undefined;
+
 /**
  * Hook to obtain {@link @azure/communication-calling#Call} from the provider.
  *