@azure/communication-react 1.4.3-alpha-202212220013.0 → 1.4.3-alpha-202301040014.0

package/dist/communication-react.d.ts

@@ -65,6 +65,7 @@ import { LatestMediaDiagnostics } from '@azure/communication-calling';
 import { LatestNetworkDiagnostics } from '@azure/communication-calling';
 import type { MediaDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { MediaStreamType } from '@azure/communication-calling';
+import { MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
 import { MicrosoftTeamsUserKind } from '@azure/communication-common';
 import type { NetworkDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { PartialTheme } from '@fluentui/react';
@@ -4151,7 +4152,7 @@ export declare interface ControlBarProps {
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId, options }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
+export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
 
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
@@ -4200,21 +4201,6 @@ 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.
  *
@@ -4272,6 +4258,21 @@ export declare const createStatefulCallClient: (args: StatefulCallClientArgs, op
  */
 export declare const createStatefulChatClient: (args: StatefulChatClientArgs, options?: StatefulChatClientOptions | undefined) => StatefulChatClient;
 
+/**
+ * @beta
+ */
+export declare const createTeamsCallAdapter: ({ userId, credential, locator }: TeamsCallAdapterArgs) => 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 createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator) => Promise<TeamsCallAdapter>;
+
 /**
  * Object returned after creating a local or remote VideoStream.
  * This contains helper functions to manipulate the render of the stream.
@@ -7440,7 +7441,7 @@ export declare type StatefulCallClientArgs = {
      * UserId from SDK. This is provided for developer convenience to easily access the userId from the
      * state. It is not used by StatefulCallClient.
      */
-    userId: CommunicationUserIdentifier;
+    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.
@@ -7619,6 +7620,17 @@ export declare interface TeamsCallAdapter extends CommonCallAdapter {
     startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): TeamsCall | undefined;
 }
 
+/**
+ * Arguments for creating the Azure Communication Services implementation of {@link TeamsCallAdapter}.
+ *
+ * @beta
+ */
+export declare type TeamsCallAdapterArgs = {
+    userId: MicrosoftTeamsUserIdentifier;
+    credential: CommunicationTokenCredential;
+    locator: TeamsMeetingLinkLocator;
+};
+
 /**
  * Object containing all the teams call handlers required for calling components.
  *
@@ -7970,22 +7982,6 @@ 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.
  *
@@ -8096,6 +8092,22 @@ export declare const useSelector: <ParamT extends Selector | undefined>(selector
  */
 export declare const useTeamsCall: () => undefined | /* @conditional-compile-remove(teams-identity-support) */ TeamsCall;
 
+/**
+ * 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 useTeamsCallAdapter: (args: Partial<TeamsCallAdapterArgs>, afterCreate?: ((adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>) | undefined, beforeDispose?: ((adapter: TeamsCallAdapter) => Promise<void>) | undefined) => TeamsCallAdapter | undefined;
+
 /**
  * Hook to obtain {@link @azure/communication-calling#TeamsCallAgent} from the provider.
  *

package/dist/dist-cjs/communication-react/index.js

@@ -127,7 +127,7 @@ const COMMUNICATION_USER_PREFIX = '8:acs:';
 const PHONE_NUMBER_PREFIX = '4:';
 const TEAMS_DOD_PREFIX = '8:dod:';
 const TEAMS_GCCH_PREFIX = '8:gcch:';
-const TEAMS_USER_PREFIX = '8:origid:';
+const TEAMS_USER_PREFIX = '8:orgid:';
 const TEAMS_VISITOR_PREFIX = '8:teamsvisitor:';
 /**
  * A string representation of a {@link @azure/communication-common#CommunicationIdentifier}.
@@ -202,7 +202,7 @@ const _toCommunicationIdentifier = (id) => {
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 // GENERATED FILE. DO NOT EDIT MANUALLY.
-var telemetryVersion = '1.4.3-alpha-202212220013.0';
+var telemetryVersion = '1.4.3-alpha-202301040014.0';
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -20973,8 +20973,7 @@ class AzureCommunicationCallAdapter {
  * @public
  */
 const createAzureCommunicationCallAdapter = ({ userId, displayName, credential, locator, 
-/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId, 
-/* @conditional-compile-remove(rooms) */ options }) => __awaiter$4(void 0, void 0, void 0, function* () {
+/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId }) => __awaiter$4(void 0, void 0, void 0, function* () {
     if (!isValidIdentifier(userId)) {
         throw new Error('Invalid identifier. Please provide valid identifier object.');
     }
@@ -20985,33 +20984,33 @@ const createAzureCommunicationCallAdapter = ({ userId, displayName, credential,
     const callAgent = yield callClient.createCallAgent(credential, {
         displayName
     });
-    const adapter = createAzureCommunicationCallAdapterFromClient(callClient, callAgent, locator, 
-    /* @conditional-compile-remove(rooms) */ options);
+    const adapter = createAzureCommunicationCallAdapterFromClient(callClient, callAgent, locator);
     return adapter;
 });
 /* @conditional-compile-remove(teams-identity-support) */
 /**
  * @beta
  */
-const createAzureCommunicationTeamsCallAdapter = ({ userId, credential, locator, 
-/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId }) => __awaiter$4(void 0, void 0, void 0, function* () {
+const createTeamsCallAdapter = ({ userId, credential, locator }) => __awaiter$4(void 0, void 0, void 0, function* () {
     const callClient = createStatefulCallClient({
-        userId,
-        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId
+        userId
     });
     const callAgent = yield callClient.createTeamsCallAgent(credential, {
         undefined
     });
-    const adapter = createAzureCommunicationTeamsCallAdapterFromClient(callClient, callAgent, locator);
+    const adapter = createTeamsCallAdapterFromClient(callClient, callAgent, locator);
     return adapter;
 });
 /**
  * @private
  */
-const useAzureCommunicationCallAdapterGeneric = (args, createAzureCommunicationCallAdapter, afterCreate, beforeDispose) => {
-    const { credential, displayName, locator, userId, 
-    /*@conditional-compile-remove(PSTN-calls) */ alternateCallerId, 
-    /*@conditional-compile-remove(rooms) */ options } = args;
+const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispose, adapterKind = 'AzureCommunication') => {
+    const { credential, locator, userId } = args;
+    const displayName = 'displayName' in args ? args.displayName : undefined;
+    /* @conditional-compile-remove(PSTN-calls) */
+    const alternateCallerId = 'alternateCallerId' in args ? args.alternateCallerId : undefined;
+    /* @conditional-compile-remove(rooms) */
+    const options = 'options' in args ? args.options : undefined;
     // State update needed to rerender the parent component when a new adapter is created.
     const [adapter, setAdapter] = React.useState(undefined);
     // Ref needed for cleanup to access the old adapter created asynchronously.
@@ -21025,7 +21024,10 @@ const useAzureCommunicationCallAdapterGeneric = (args, createAzureCommunicationC
     afterCreateRef.current = afterCreate;
     beforeDisposeRef.current = beforeDispose;
     React.useEffect(() => {
-        if (!credential || !displayName || !locator || !userId) {
+        if (!credential || !locator || !userId) {
+            return;
+        }
+        if (adapterKind === 'AzureCommunication' && !displayName) {
             return;
         }
         (() => __awaiter$4(void 0, void 0, void 0, function* () {
@@ -21041,14 +21043,35 @@ const useAzureCommunicationCallAdapterGeneric = (args, createAzureCommunicationC
                 adapterRef.current.dispose();
                 adapterRef.current = undefined;
             }
-            let newAdapter = yield createAzureCommunicationCallAdapter({
-                credential,
-                displayName,
-                locator,
-                userId,
-                /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
-                /* @conditional-compile-remove(rooms) */ options
-            });
+            let newAdapter = undefined;
+            if (adapterKind === 'AzureCommunication') {
+                // This is just the type check to ensure that displayName is defined.
+                if (!displayName) {
+                    throw new Error('Unreachable code, displayName already checked above.');
+                }
+                newAdapter = (yield createAzureCommunicationCallAdapter({
+                    credential,
+                    displayName: displayName,
+                    locator,
+                    userId: userId,
+                    /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
+                    /* @conditional-compile-remove(rooms) */ options
+                }));
+            }
+            else if (adapterKind === 'Teams') {
+                /* @conditional-compile-remove(teams-identity-support) */
+                newAdapter = (yield createTeamsCallAdapter({
+                    credential,
+                    locator: locator,
+                    userId: userId
+                }));
+            }
+            else {
+                throw new Error('Unreachable code, unknown adapterKind');
+            }
+            if (!newAdapter) {
+                throw Error('Unreachable code! Get undefined adapter');
+            }
             if (afterCreateRef.current) {
                 newAdapter = yield afterCreateRef.current(newAdapter);
             }
@@ -21060,14 +21083,16 @@ const useAzureCommunicationCallAdapterGeneric = (args, createAzureCommunicationC
     [
         adapterRef,
         afterCreateRef,
-        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
         beforeDisposeRef,
-        createAzureCommunicationCallAdapter,
         credential,
-        displayName,
         locator,
-        /* @conditional-compile-remove(rooms) */ options,
-        userId
+        adapterKind,
+        userId,
+        displayName,
+        /* @conditional-compile-remove(PSTN-calls) */
+        alternateCallerId,
+        /* @conditional-compile-remove(rooms) */
+        options
     ]);
     // Dispose any existing adapter when the component unmounts.
     React.useEffect(() => {
@@ -21119,7 +21144,7 @@ afterCreate,
  * This is useful for clean up tasks, e.g., leaving any ongoing calls.
  */
 beforeDispose) => {
-    return useAzureCommunicationCallAdapterGeneric(args, createAzureCommunicationCallAdapter, afterCreate, beforeDispose);
+    return useAzureCommunicationCallAdapterGeneric(args, afterCreate, beforeDispose, 'AzureCommunication');
 };
 /* @conditional-compile-remove(teams-identity-support) */
 /**
@@ -21136,7 +21161,7 @@ beforeDispose) => {
  *
  * @beta
  */
-const useAzureCommunicationTeamsCallAdapter = (
+const useTeamsCallAdapter = (
 /**
  * Arguments to be passed to {@link createAzureCommunicationCallAdapter}.
  *
@@ -21156,7 +21181,7 @@ afterCreate,
  * This is useful for clean up tasks, e.g., leaving any ongoing calls.
  */
 beforeDispose) => {
-    return useAzureCommunicationCallAdapterGeneric(args, createAzureCommunicationTeamsCallAdapter, afterCreate, beforeDispose);
+    return useAzureCommunicationCallAdapterGeneric(args, afterCreate, beforeDispose, 'Teams');
 };
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
@@ -21182,7 +21207,7 @@ const createAzureCommunicationCallAdapterFromClient = (callClient, callAgent, lo
  *
  * @beta
  */
-const createAzureCommunicationTeamsCallAdapterFromClient = (callClient, callAgent, locator) => __awaiter$4(void 0, void 0, void 0, function* () {
+const createTeamsCallAdapterFromClient = (callClient, callAgent, locator) => __awaiter$4(void 0, void 0, void 0, function* () {
     const deviceManager = (yield callClient.getDeviceManager());
     /* @conditional-compile-remove(unsupported-browser) */
     yield callClient.feature(communicationCalling.Features.DebugInfo).getEnvironmentInfo();
@@ -23261,13 +23286,13 @@ exports.createAzureCommunicationCallWithChatAdapter = createAzureCommunicationCa
 exports.createAzureCommunicationCallWithChatAdapterFromClients = createAzureCommunicationCallWithChatAdapterFromClients;
 exports.createAzureCommunicationChatAdapter = createAzureCommunicationChatAdapter;
 exports.createAzureCommunicationChatAdapterFromClient = createAzureCommunicationChatAdapterFromClient;
-exports.createAzureCommunicationTeamsCallAdapter = createAzureCommunicationTeamsCallAdapter;
-exports.createAzureCommunicationTeamsCallAdapterFromClient = createAzureCommunicationTeamsCallAdapterFromClient;
 exports.createDefaultCallingHandlers = createDefaultCallingHandlers;
 exports.createDefaultChatHandlers = createDefaultChatHandlers;
 exports.createDefaultTeamsCallingHandlers = createDefaultTeamsCallingHandlers;
 exports.createStatefulCallClient = createStatefulCallClient;
 exports.createStatefulChatClient = createStatefulChatClient;
+exports.createTeamsCallAdapter = createTeamsCallAdapter;
+exports.createTeamsCallAdapterFromClient = createTeamsCallAdapterFromClient;
 exports.darkTheme = darkTheme;
 exports.fromFlatCommunicationIdentifier = fromFlatCommunicationIdentifier;
 exports.getCallingSelector = getSelector$1;
@@ -23277,7 +23302,6 @@ exports.toFlatCommunicationIdentifier = toFlatCommunicationIdentifier;
 exports.useAzureCommunicationCallAdapter = useAzureCommunicationCallAdapter;
 exports.useAzureCommunicationCallWithChatAdapter = useAzureCommunicationCallWithChatAdapter;
 exports.useAzureCommunicationChatAdapter = useAzureCommunicationChatAdapter;
-exports.useAzureCommunicationTeamsCallAdapter = useAzureCommunicationTeamsCallAdapter;
 exports.useCall = useCall;
 exports.useCallAgent = useCallAgent;
 exports.useCallClient = useCallClient;
@@ -23287,6 +23311,7 @@ exports.useDeviceManager = useDeviceManager;
 exports.usePropsFor = usePropsFor;
 exports.useSelector = useSelector;
 exports.useTeamsCall = useTeamsCall;
+exports.useTeamsCallAdapter = useTeamsCallAdapter;
 exports.useTeamsCallAgent = useTeamsCallAgent;
 exports.useTheme = useTheme;
 //# sourceMappingURL=index.js.map