@azure/communication-react 1.5.2-alpha-202301190014.0 → 1.6.0

package/dist/dist-esm/react-composites/src/composites/CallComposite/adapter/AzureCommunicationCallAdapter.js

@@ -11,18 +11,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { _isInCall } from "../../../../../calling-component-bindings/src";
 import { createStatefulCallClient } from "../../../../../calling-stateful-client/src";
-/* @conditional-compile-remove(teams-identity-support) */
-import { _isTeamsCallAgent } from "../../../../../calling-stateful-client/src";
-/* @conditional-compile-remove(unsupported-browser) */
-import { Features } from '@azure/communication-calling';
 import { EventEmitter } from 'events';
-import { getCallCompositePage, IsCallEndedPage, isCameraOn, isValidIdentifier } from '../utils';
-import { toFlatCommunicationIdentifier, _toCommunicationIdentifier } from "../../../../../acs-ui-common/src";
+import { getCallCompositePage, IsCallEndedPage, isCameraOn } from '../utils';
+import { toFlatCommunicationIdentifier, _toCommunicationIdentifier, _isValidIdentifier } from "../../../../../acs-ui-common/src";
 import { isCommunicationUserIdentifier, isPhoneNumberIdentifier } from '@azure/communication-common';
 import { ParticipantSubscriber } from './ParticipantSubcriber';
 import { DiagnosticsForwarder } from './DiagnosticsForwarder';
 import { useEffect, useRef, useState } from 'react';
 import { createHandlers } from './createHandlers';
+import { createProfileStateModifier } from './OnFetchProfileCallback';
 /** Context of call, which is a centralized context for all state updates */
 class CallContext {
     constructor(clientState, isTeamsCall, options) {
@@ -37,19 +34,15 @@ class CallContext {
             page: 'configuration',
             latestErrors: clientState.latestErrors,
             isTeamsCall,
-            /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId: clientState.alternateCallerId,
-            /* @conditional-compile-remove(unsupported-browser) */ environmentInfo: clientState.environmentInfo,
-            /* @conditional-compile-remove(unsupported-browser) */ unsupportedBrowserVersionsAllowed: false,
-            /* @conditional-compile-remove(rooms) */ roleHint: options === null || options === void 0 ? void 0 : options.roleHint,
             cameraStatus: undefined
         };
         this.emitter.setMaxListeners((_b = options === null || options === void 0 ? void 0 : options.maxListeners) !== null && _b !== void 0 ? _b : 50);
         this.bindPublicMethods();
+        this.displayNameModifier = (options === null || options === void 0 ? void 0 : options.onFetchProfile) ? createProfileStateModifier(options.onFetchProfile, () => {
+            this.setState(this.getState());
+        }) : undefined;
     }
-    bindPublicMethods() {
-        /* @conditional-compile-remove(unsupported-browser) */
-        this.setAllowedUnsupportedBrowser.bind(this);
-    }
+    bindPublicMethods() { }
     onStateChange(handler) {
         this.emitter.on('stateChanged', handler);
     }
@@ -57,7 +50,7 @@ class CallContext {
         this.emitter.off('stateChanged', handler);
     }
     setState(state) {
-        this.state = state;
+        this.state = this.displayNameModifier ? this.displayNameModifier(state) : state;
         this.emitter.emit('stateChanged', this.state);
     }
     getState() {
@@ -82,31 +75,20 @@ class CallContext {
         const latestEndedCall = clientState.callsEnded ? findLatestEndedCall(clientState.callsEnded) : undefined;
         // As the state is transitioning to a new state, trigger appropriate callback events.
         const oldPage = this.state.page;
-        /* @conditional-compile-remove(unsupported-browser) */
-        const environmentInfo = {
-            environmentInfo: this.state.environmentInfo,
-            unsupportedBrowserVersionOptedIn: this.state.unsupportedBrowserVersionsAllowed
-        };
-        const newPage = getCallCompositePage(call, latestEndedCall, 
-        /* @conditional-compile-remove(unsupported-browser) */ environmentInfo);
+        const newPage = getCallCompositePage(call, latestEndedCall);
         if (!IsCallEndedPage(oldPage) && IsCallEndedPage(newPage)) {
-            this.emitter.emit('callEnded', { callId: this.callId });
+            this.emitter.emit('callEnded', {
+                callId: this.callId
+            });
             // Reset the callId to undefined as the call has ended.
             this.setCurrentCallId(undefined);
             // Make sure that the call is set to undefined in the state.
             call = undefined;
         }
         if (this.state.page) {
-            this.setState(Object.assign(Object.assign({}, this.state), { userId: clientState.userId, displayName: (_a = clientState.callAgent) === null || _a === void 0 ? void 0 : _a.displayName, call, page: newPage, endedCall: latestEndedCall, devices: clientState.deviceManager, latestErrors: clientState.latestErrors, cameraStatus: (call === null || call === void 0 ? void 0 : call.localVideoStreams.find((s) => s.mediaStreamType === 'Video')) ||
-                    clientState.deviceManager.unparentedViews.find((s) => s.mediaStreamType === 'Video')
-                    ? 'On'
-                    : 'Off' }));
+            this.setState(Object.assign(Object.assign({}, this.state), { userId: clientState.userId, displayName: (_a = clientState.callAgent) === null || _a === void 0 ? void 0 : _a.displayName, call, page: newPage, endedCall: latestEndedCall, devices: clientState.deviceManager, latestErrors: clientState.latestErrors, cameraStatus: (call === null || call === void 0 ? void 0 : call.localVideoStreams.find(s => s.mediaStreamType === 'Video')) || clientState.deviceManager.unparentedViews.find(s => s.mediaStreamType === 'Video') ? 'On' : 'Off' }));
         }
     }
-    /* @conditional-compile-remove(unsupported-browser) */
-    setAllowedUnsupportedBrowser() {
-        this.setState(Object.assign(Object.assign({}, this.state), { unsupportedBrowserVersionsAllowed: true }));
-    }
 }
 const findLatestEndedCall = (calls) => {
     var _a, _b, _c, _d;
@@ -141,9 +123,9 @@ export class AzureCommunicationCallAdapter {
         this.callAgent = callAgent;
         this.locator = locator;
         this.deviceManager = deviceManager;
-        const isTeamsMeeting = 'meetingLink' in this.locator;
+        const isTeamsMeeting = ('meetingLink' in this.locator);
         this.context = new CallContext(callClient.getState(), isTeamsMeeting, options);
-        this.context.onCallEnded((endCallData) => this.emitter.emit('callEnded', endCallData));
+        this.context.onCallEnded(endCallData => this.emitter.emit('callEnded', endCallData));
         const onStateChange = (clientState) => {
             var _a;
             // unsubscribe when the instance gets disposed
@@ -209,16 +191,6 @@ export class AzureCommunicationCallAdapter {
         this.on.bind(this);
         this.off.bind(this);
         this.processNewCall.bind(this);
-        /* @conditional-compile-remove(PSTN-calls) */
-        this.addParticipant.bind(this);
-        /* @conditional-compile-remove(PSTN-calls) */
-        this.holdCall.bind(this);
-        /* @conditional-compile-remove(PSTN-calls) */
-        this.resumeCall.bind(this);
-        /* @conditional-compile-remove(PSTN-calls) */
-        this.sendDtmfTone.bind(this);
-        /* @conditional-compile-remove(unsupported-browser) */
-        this.allowUnsupportedBrowserVersion.bind(this);
     }
     dispose() {
         this.resetDiagnosticsForwarder();
@@ -259,51 +231,26 @@ export class AzureCommunicationCallAdapter {
             throw new Error('You are already in the call!');
         }
         return this.teeErrorToEventEmitter(() => {
-            const audioOptions = { muted: !(microphoneOn !== null && microphoneOn !== void 0 ? microphoneOn : this.getState().isLocalPreviewMicrophoneEnabled) };
+            const audioOptions = {
+                muted: !(microphoneOn !== null && microphoneOn !== void 0 ? microphoneOn : this.getState().isLocalPreviewMicrophoneEnabled)
+            };
             // TODO: find a way to expose stream to here
-            const videoOptions = { localVideoStreams: this.localStream ? [this.localStream] : undefined };
-            /* @conditional-compile-remove(teams-adhoc-call) */
-            /* @conditional-compile-remove(PSTN-calls) */
-            if (isOutboundCall(this.locator)) {
-                const phoneNumber = this.getState().alternateCallerId;
-                return this.startCall(this.locator.participantIds, {
-                    alternateCallerId: phoneNumber ? { phoneNumber: phoneNumber } : undefined,
-                    audioOptions,
-                    videoOptions
-                });
-            }
+            const videoOptions = {
+                localVideoStreams: this.localStream ? [this.localStream] : undefined
+            };
             const call = this._joinCall(audioOptions, videoOptions);
             this.processNewCall(call);
             return call;
         });
     }
     _joinCall(audioOptions, videoOptions) {
-        const isTeamsMeeting = 'meetingLink' in this.locator;
-        /* @conditional-compile-remove(rooms) */
-        const isRoomsCall = 'roomId' in this.locator;
-        /* @conditional-compile-remove(teams-identity-support) */
-        if (_isTeamsCallAgent(this.callAgent)) {
-            if (!isTeamsMeeting) {
-                throw new Error('Locator not supported by TeamsCallAgent');
-            }
-            return this.callAgent.join(this.locator, {
-                audioOptions,
-                videoOptions
-            });
-        }
+        const isTeamsMeeting = ('meetingLink' in this.locator);
         if (isTeamsMeeting) {
             return this.callAgent.join(this.locator, {
                 audioOptions,
                 videoOptions
             });
         }
-        /* @conditional-compile-remove(rooms) */
-        if (isRoomsCall) {
-            return this.callAgent.join(this.locator, {
-                audioOptions,
-                videoOptions
-            });
-        }
         return this.callAgent.join(this.locator, {
             audioOptions,
             videoOptions
@@ -366,6 +313,8 @@ export class AzureCommunicationCallAdapter {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.asyncTeeErrorToEventEmitter(() => __awaiter(this, void 0, void 0, function* () {
                 if (!isCameraOn(this.getState())) {
+                    // First kick off the effect on the local device before starting the camera in the call.
+                    // This prevents the effect not being applied for a brief moment when the camera is started.
                     yield this.handlers.onToggleCamera(options);
                 }
             }));
@@ -422,17 +371,12 @@ export class AzureCommunicationCallAdapter {
             }));
         });
     }
-    /* @conditional-compile-remove(unsupported-browser) */
-    allowUnsupportedBrowserVersion() {
-        this.context.setAllowedUnsupportedBrowser();
-        this.context.updateClientState(this.callClient.getState());
-    }
     startCall(participants, options) {
         var _a, _b;
         if (_isInCall((_b = (_a = this.getState().call) === null || _a === void 0 ? void 0 : _a.state) !== null && _b !== void 0 ? _b : 'None')) {
             throw new Error('You are already in the call.');
         }
-        const idsToAdd = participants.map((participant) => {
+        const idsToAdd = participants.map(participant => {
             // FIXME: `onStartCall` does not allow a Teams user.
             // Need some way to return an error if a Teams user is provided.
             const backendId = _toCommunicationIdentifier(participant);
@@ -465,46 +409,9 @@ export class AzureCommunicationCallAdapter {
     removeParticipant(userId) {
         return __awaiter(this, void 0, void 0, function* () {
             let participant = userId;
-            /* @conditional-compile-remove(PSTN-calls) */
-            participant = _toCommunicationIdentifier(userId);
             this.handlers.onRemoveParticipant(participant);
         });
     }
-    /* @conditional-compile-remove(PSTN-calls) */
-    addParticipant(participant, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (isPhoneNumberIdentifier(participant) && options) {
-                this.handlers.onAddParticipant(participant, options);
-            }
-            else if (isCommunicationUserIdentifier(participant)) {
-                this.handlers.onAddParticipant(participant);
-            }
-        });
-    }
-    /* @conditional-compile-remove(PSTN-calls) */
-    holdCall() {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (((_a = this.call) === null || _a === void 0 ? void 0 : _a.state) !== 'LocalHold') {
-                this.handlers.onToggleHold();
-            }
-        });
-    }
-    /* @conditional-compile-remove(PSTN-calls) */
-    resumeCall() {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (((_a = this.call) === null || _a === void 0 ? void 0 : _a.state) === 'LocalHold') {
-                this.handlers.onToggleHold();
-            }
-        });
-    }
-    /* @conditional-compile-remove(PSTN-calls) */
-    sendDtmfTone(dtmfTone) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.handlers.onSendDtmfTone(dtmfTone);
-        });
-    }
     getState() {
         return this.context.getState();
     }
@@ -538,15 +445,19 @@ export class AzureCommunicationCallAdapter {
     }
     onRemoteParticipantsUpdated({ added, removed }) {
         if (added && added.length > 0) {
-            this.emitter.emit('participantsJoined', added);
+            this.emitter.emit('participantsJoined', {
+                joined: added
+            });
         }
         if (removed && removed.length > 0) {
-            this.emitter.emit('participantsLeft', removed);
+            this.emitter.emit('participantsLeft', {
+                removed: removed
+            });
         }
-        added.forEach((participant) => {
+        added.forEach(participant => {
             this.participantSubscribers.set(toFlatCommunicationIdentifier(participant.identifier), new ParticipantSubscriber(participant, this.emitter));
         });
-        removed.forEach((participant) => {
+        removed.forEach(participant => {
             const subscriber = this.participantSubscribers.get(toFlatCommunicationIdentifier(participant.identifier));
             subscriber && subscriber.unsubscribeAll();
             this.participantSubscribers.delete(toFlatCommunicationIdentifier(participant.identifier));
@@ -554,11 +465,15 @@ export class AzureCommunicationCallAdapter {
     }
     isScreenSharingOnChanged() {
         var _a;
-        this.emitter.emit('isLocalScreenSharingActiveChanged', { isScreenSharingOn: (_a = this.call) === null || _a === void 0 ? void 0 : _a.isScreenSharingOn });
+        this.emitter.emit('isLocalScreenSharingActiveChanged', {
+            isScreenSharingOn: (_a = this.call) === null || _a === void 0 ? void 0 : _a.isScreenSharingOn
+        });
     }
     callIdChanged() {
         var _a;
-        ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id) && this.emitter.emit('callIdChanged', { callId: this.call.id });
+        ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id) && this.emitter.emit('callIdChanged', {
+            callId: this.call.id
+        });
     }
     resetDiagnosticsForwarder(newCall) {
         if (this.diagnosticsForwarder) {
@@ -606,14 +521,12 @@ export class AzureCommunicationCallAdapter {
  *
  * @public
  */
-export const createAzureCommunicationCallAdapter = ({ userId, displayName, credential, locator, 
-/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId }) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!isValidIdentifier(userId)) {
+export const createAzureCommunicationCallAdapter = ({ userId, displayName, credential, locator }) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!_isValidIdentifier(userId)) {
         throw new Error('Invalid identifier. Please provide valid identifier object.');
     }
     const callClient = createStatefulCallClient({
-        userId,
-        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId
+        userId
     });
     const callAgent = yield callClient.createCallAgent(credential, {
         displayName
@@ -621,34 +534,17 @@ export const createAzureCommunicationCallAdapter = ({ userId, displayName, crede
     const adapter = createAzureCommunicationCallAdapterFromClient(callClient, callAgent, locator);
     return adapter;
 });
-/* @conditional-compile-remove(teams-identity-support) */
-/**
- * @beta
- */
-export const createTeamsCallAdapter = ({ userId, credential, locator }) => __awaiter(void 0, void 0, void 0, function* () {
-    const callClient = createStatefulCallClient({
-        userId
-    });
-    const callAgent = yield callClient.createTeamsCallAgent(credential, {
-        undefined
-    });
-    const adapter = createTeamsCallAdapterFromClient(callClient, callAgent, locator);
-    return adapter;
-});
 /**
  * @private
  */
 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] = useState(undefined);
     // Ref needed for cleanup to access the old adapter created asynchronously.
     const adapterRef = useRef(undefined);
+    const creatingAdapterRef = useRef(false);
     const afterCreateRef = useRef(undefined);
     const beforeDisposeRef = useRef(undefined);
     // These refs are updated on *each* render, so that the latest values
@@ -683,22 +579,25 @@ const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispos
                 if (!displayName) {
                     throw new Error('Unreachable code, displayName already checked above.');
                 }
+                // This is just the type check to ensure that roleHint is defined.
+                if (creatingAdapterRef.current) {
+                    console.warn('Adapter is already being created, please see storybook for more information: https://azure.github.io/communication-ui-library/?path=/story/troubleshooting--page');
+                    return;
+                }
+                creatingAdapterRef.current = true;
                 newAdapter = (yield createAzureCommunicationCallAdapter({
                     credential,
                     displayName: displayName,
                     locator,
-                    userId: userId,
-                    /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
-                    /* @conditional-compile-remove(rooms) */ options
+                    userId: userId
                 }));
             }
             else if (adapterKind === 'Teams') {
-                /* @conditional-compile-remove(teams-identity-support) */
-                newAdapter = (yield createTeamsCallAdapter({
-                    credential,
-                    locator: locator,
-                    userId: userId
-                }));
+                if (creatingAdapterRef.current) {
+                    console.warn('Adapter is already being created, skipping creation.');
+                    return;
+                }
+                creatingAdapterRef.current = true;
             }
             else {
                 throw new Error('Unreachable code, unknown adapterKind');
@@ -710,24 +609,12 @@ const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispos
                 newAdapter = yield afterCreateRef.current(newAdapter);
             }
             adapterRef.current = newAdapter;
+            creatingAdapterRef.current = false;
             setAdapter(newAdapter);
         }))();
     }, 
     // Explicitly list all arguments so that caller doesn't have to memoize the `args` object.
-    [
-        adapterRef,
-        afterCreateRef,
-        beforeDisposeRef,
-        credential,
-        locator,
-        adapterKind,
-        userId,
-        displayName,
-        /* @conditional-compile-remove(PSTN-calls) */
-        alternateCallerId,
-        /* @conditional-compile-remove(rooms) */
-        options
-    ]);
+    [adapterRef, afterCreateRef, beforeDisposeRef, adapterKind, credential, locator, userId, displayName]);
     // Dispose any existing adapter when the component unmounts.
     useEffect(() => {
         return () => {
@@ -758,65 +645,9 @@ const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispos
  *
  * @public
  */
-export const useAzureCommunicationCallAdapter = (
-/**
- * Arguments to be passed to {@link createAzureCommunicationCallAdapter}.
- *
- * 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.
- */
-args, 
-/**
- * Optional callback to modify the adapter once it is created.
- *
- * If set, must return the modified adapter.
- */
-afterCreate, 
-/**
- * Optional callback called before the adapter is disposed.
- *
- * This is useful for clean up tasks, e.g., leaving any ongoing calls.
- */
-beforeDispose) => {
+export const useAzureCommunicationCallAdapter = (args, afterCreate, beforeDispose) => {
     return useAzureCommunicationCallAdapterGeneric(args, afterCreate, beforeDispose, 'AzureCommunication');
 };
-/* @conditional-compile-remove(teams-identity-support) */
-/**
- * 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 const useTeamsCallAdapter = (
-/**
- * Arguments to be passed to {@link createAzureCommunicationCallAdapter}.
- *
- * 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.
- */
-args, 
-/**
- * Optional callback to modify the adapter once it is created.
- *
- * If set, must return the modified adapter.
- */
-afterCreate, 
-/**
- * Optional callback called before the adapter is disposed.
- *
- * This is useful for clean up tasks, e.g., leaving any ongoing calls.
- */
-beforeDispose) => {
-    return useAzureCommunicationCallAdapterGeneric(args, afterCreate, beforeDispose, 'Teams');
-};
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
  *
@@ -826,33 +657,10 @@ beforeDispose) => {
  * @public
  */
 export const createAzureCommunicationCallAdapterFromClient = (callClient, callAgent, locator, options) => __awaiter(void 0, void 0, void 0, function* () {
-    const deviceManager = (yield callClient.getDeviceManager());
-    /* @conditional-compile-remove(unsupported-browser) */
-    yield callClient.feature(Features.DebugInfo).getEnvironmentInfo();
-    return new AzureCommunicationCallAdapter(callClient, locator, callAgent, deviceManager, 
-    /* @conditional-compile-remove(rooms) */ options);
-});
-/* @conditional-compile-remove(teams-identity-support) */
-/**
- * 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 const createTeamsCallAdapterFromClient = (callClient, callAgent, locator) => __awaiter(void 0, void 0, void 0, function* () {
-    const deviceManager = (yield callClient.getDeviceManager());
-    /* @conditional-compile-remove(unsupported-browser) */
-    yield callClient.feature(Features.DebugInfo).getEnvironmentInfo();
+    const deviceManager = yield callClient.getDeviceManager();
     return new AzureCommunicationCallAdapter(callClient, locator, callAgent, deviceManager);
 });
 const isCallError = (e) => {
     return e['target'] !== undefined && e['innerError'] !== undefined;
 };
-/* @conditional-compile-remove(teams-adhoc-call) */
-/* @conditional-compile-remove(PSTN-calls) */
-const isOutboundCall = (callLocator) => {
-    return 'participantIds' in callLocator;
-};
 //# sourceMappingURL=AzureCommunicationCallAdapter.js.map