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

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

@@ -11,6 +11,10 @@ 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";
@@ -32,12 +36,20 @@ class CallContext {
             call: undefined,
             page: 'configuration',
             latestErrors: clientState.latestErrors,
-            isTeamsCall
+            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();
     }
-    bindPublicMethods() { }
+    bindPublicMethods() {
+        /* @conditional-compile-remove(unsupported-browser) */
+        this.setAllowedUnsupportedBrowser.bind(this);
+    }
     onStateChange(handler) {
         this.emitter.on('stateChanged', handler);
     }
@@ -70,20 +82,31 @@ 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;
-        const newPage = getCallCompositePage(call, latestEndedCall);
+        /* @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);
         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 }));
+            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;
@@ -118,9 +141,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
@@ -186,6 +209,16 @@ 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();
@@ -226,26 +259,51 @@ 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
-            };
+            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 call = this._joinCall(audioOptions, videoOptions);
             this.processNewCall(call);
             return call;
         });
     }
     _joinCall(audioOptions, videoOptions) {
-        const isTeamsMeeting = ('meetingLink' in this.locator);
+        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
+            });
+        }
         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
@@ -364,12 +422,17 @@ 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);
@@ -402,9 +465,46 @@ 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();
     }
@@ -443,10 +543,10 @@ export class AzureCommunicationCallAdapter {
         if (removed && removed.length > 0) {
             this.emitter.emit('participantsLeft', 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));
@@ -454,15 +554,11 @@ 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) {
@@ -510,12 +606,14 @@ export class AzureCommunicationCallAdapter {
  *
  * @public
  */
-export const createAzureCommunicationCallAdapter = ({ userId, displayName, credential, locator }) => __awaiter(void 0, void 0, void 0, function* () {
+export const createAzureCommunicationCallAdapter = ({ userId, displayName, credential, locator, 
+/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId }) => __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
+        userId,
+        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId
     });
     const callAgent = yield callClient.createCallAgent(credential, {
         displayName
@@ -523,12 +621,30 @@ 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.
@@ -571,10 +687,19 @@ const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispos
                     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 if (adapterKind === 'Teams') { }
             else {
                 throw new Error('Unreachable code, unknown adapterKind');
             }
@@ -589,7 +714,20 @@ const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispos
         }))();
     }, 
     // Explicitly list all arguments so that caller doesn't have to memoize the `args` object.
-    [adapterRef, afterCreateRef, beforeDisposeRef, credential, locator, adapterKind, userId, displayName]);
+    [
+        adapterRef,
+        afterCreateRef,
+        beforeDisposeRef,
+        credential,
+        locator,
+        adapterKind,
+        userId,
+        displayName,
+        /* @conditional-compile-remove(PSTN-calls) */
+        alternateCallerId,
+        /* @conditional-compile-remove(rooms) */
+        options
+    ]);
     // Dispose any existing adapter when the component unmounts.
     useEffect(() => {
         return () => {
@@ -620,9 +758,65 @@ const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispos
  *
  * @public
  */
-export const useAzureCommunicationCallAdapter = (args, afterCreate, beforeDispose) => {
+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) => {
     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}.
  *
@@ -632,10 +826,33 @@ export const useAzureCommunicationCallAdapter = (args, afterCreate, beforeDispos
  * @public
  */
 export const createAzureCommunicationCallAdapterFromClient = (callClient, callAgent, locator, options) => __awaiter(void 0, void 0, void 0, function* () {
-    const deviceManager = yield callClient.getDeviceManager();
+    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();
     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