@azure/communication-react 1.10.0-beta.1 → 1.10.1-alpha-202311110012

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

@@ -32,10 +32,14 @@ import { createProfileStateModifier } from './OnFetchProfileCallback';
 /* @conditional-compile-remove(video-background-effects) */
 import { getBackgroundEffectFromSelectedEffect } from '../utils';
 import { getSelectedCameraFromAdapterState } from '../utils';
+/* @conditional-compile-remove(calling-sounds) */
+import { CallingSoundSubscriber } from './CallingSoundSubscriber';
 /** Context of call, which is a centralized context for all state updates */
 class CallContext {
-    constructor(clientState, isTeamsCall, /* @conditional-compile-remove(rooms) */ isRoomsCall, options) {
-        var _a, _b, _c, _d;
+    constructor(clientState, isTeamsCall, 
+    /* @conditional-compile-remove(rooms) */
+    isRoomsCall, options) {
+        var _a, _b, _c, _d, _e;
         this.emitter = new EventEmitter();
         this.state = {
             isLocalPreviewMicrophoneEnabled: false,
@@ -54,13 +58,16 @@ class CallContext {
             /* @conditional-compile-remove(video-background-effects) */
             onResolveVideoEffectDependency: (_c = options === null || options === void 0 ? void 0 : options.videoBackgroundOptions) === null || _c === void 0 ? void 0 : _c.onResolveDependency,
             /* @conditional-compile-remove(video-background-effects) */ selectedVideoBackgroundEffect: undefined,
-            cameraStatus: undefined
+            cameraStatus: undefined,
+            /* @conditional-compile-remove(calling-sounds) */ sounds: (_d = options === null || options === void 0 ? void 0 : options.soundOptions) === null || _d === void 0 ? void 0 : _d.callingSounds
         };
-        this.emitter.setMaxListeners((_d = options === null || options === void 0 ? void 0 : options.maxListeners) !== null && _d !== void 0 ? _d : 50);
+        this.emitter.setMaxListeners((_e = options === null || options === void 0 ? void 0 : options.maxListeners) !== null && _e !== void 0 ? _e : 50);
         this.bindPublicMethods();
-        this.displayNameModifier = (options === null || options === void 0 ? void 0 : options.onFetchProfile) ? createProfileStateModifier(options.onFetchProfile, () => {
-            this.setState(this.getState());
-        }) : undefined;
+        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) */
@@ -104,21 +111,26 @@ class CallContext {
             unsupportedBrowserVersionOptedIn: this.state.unsupportedBrowserVersionsAllowed
         };
         /* @conditional-compile-remove(call-transfer) */
-        const latestAcceptedTransfer = (call === null || call === void 0 ? void 0 : call.transfer.acceptedTransfers) ? findLatestAcceptedTransfer(call.transfer.acceptedTransfers) : undefined;
+        const latestAcceptedTransfer = (call === null || call === void 0 ? void 0 : call.transfer.acceptedTransfers)
+            ? findLatestAcceptedTransfer(call.transfer.acceptedTransfers)
+            : undefined;
         /* @conditional-compile-remove(call-transfer) */
         const transferCall = latestAcceptedTransfer ? clientState.calls[latestAcceptedTransfer.callId] : undefined;
-        const newPage = getCallCompositePage(call, latestEndedCall, /* @conditional-compile-remove(unsupported-browser) */ environmentInfo, /* @conditional-compile-remove(call-transfer) */ transferCall);
+        const newPage = getCallCompositePage(call, latestEndedCall, 
+        /* @conditional-compile-remove(unsupported-browser) */ environmentInfo, 
+        /* @conditional-compile-remove(call-transfer) */ transferCall);
         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(call-transfer) */ acceptedTransferCallState: transferCall }));
         }
     }
@@ -188,13 +200,15 @@ export class AzureCommunicationCallAdapter {
         this.callAgent = callAgent;
         this.locator = locator;
         this.deviceManager = deviceManager;
-        const isTeamsMeeting = ('meetingLink' in this.locator);
+        const isTeamsMeeting = 'meetingLink' in this.locator;
         /* @conditional-compile-remove(rooms) */
-        const isRoomsCall = ('roomId' in this.locator);
+        const isRoomsCall = 'roomId' in this.locator;
         /* @conditional-compile-remove(video-background-effects) */
         this.onResolveVideoBackgroundEffectsDependency = (_a = options === null || options === void 0 ? void 0 : options.videoBackgroundOptions) === null || _a === void 0 ? void 0 : _a.onResolveDependency;
-        this.context = new CallContext(callClient.getState(), isTeamsMeeting, /* @conditional-compile-remove(rooms) */ isRoomsCall, /* @conditional-compile-remove(video-background-effects) */ options);
-        this.context.onCallEnded(endCallData => this.emitter.emit('callEnded', endCallData));
+        this.context = new CallContext(callClient.getState(), isTeamsMeeting, 
+        /* @conditional-compile-remove(rooms) */ isRoomsCall, 
+        /* @conditional-compile-remove(video-background-effects) */ options);
+        this.context.onCallEnded((endCallData) => this.emitter.emit('callEnded', endCallData));
         const onStateChange = (clientState) => {
             var _a, _b;
             // unsubscribe when the instance gets disposed
@@ -217,9 +231,12 @@ export class AzureCommunicationCallAdapter {
             // TODO: Remove this if statement when Calling SDK prevents accepting transfer requests that have timed out
             // This is to handle the case when there has been an accepted transfer call that is now in the connected state
             // AND is not the current call. Ensure we leave the current call.
-            if (acceptedTransferCallState && acceptedTransferCallState.state === 'Connected' && ((_b = this.call) === null || _b === void 0 ? void 0 : _b.id) && acceptedTransferCallState.id !== this.call.id) {
+            if (acceptedTransferCallState &&
+                acceptedTransferCallState.state === 'Connected' &&
+                ((_b = this.call) === null || _b === void 0 ? void 0 : _b.id) &&
+                acceptedTransferCallState.id !== this.call.id) {
                 const cAgent = callAgent;
-                const transferCall = cAgent.calls.find(call => call.id === acceptedTransferCallState.id);
+                const transferCall = cAgent.calls.find((call) => call.id === acceptedTransferCallState.id);
                 if (transferCall) {
                     const oldCall = this.call;
                     this.processNewCall(transferCall);
@@ -234,7 +251,8 @@ export class AzureCommunicationCallAdapter {
                 }
             }
         };
-        this.handlers = createHandlers(callClient, callAgent, deviceManager, undefined, /* @conditional-compile-remove(video-background-effects) */ {
+        this.handlers = createHandlers(callClient, callAgent, deviceManager, undefined, 
+        /* @conditional-compile-remove(video-background-effects) */ {
             onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency
         });
         this.onClientStateChange = onStateChange;
@@ -245,7 +263,7 @@ export class AzureCommunicationCallAdapter {
             const onCallsUpdated = (args) => {
                 var _a;
                 if ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id) {
-                    const removedCall = args.removed.find(call => { var _a; return call.id === ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id); });
+                    const removedCall = args.removed.find((call) => { var _a; return call.id === ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id); });
                     if (removedCall) {
                         const removedCallState = this.callClient.getState().callsEnded[removedCall.id];
                         const latestAcceptedTransfer = findLatestAcceptedTransfer(removedCallState.transfer.acceptedTransfers);
@@ -263,7 +281,7 @@ export class AzureCommunicationCallAdapter {
             const onTeamsCallsUpdated = (args) => {
                 var _a;
                 if ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id) {
-                    const removedCall = args.removed.find(call => { var _a; return call.id === ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id); });
+                    const removedCall = args.removed.find((call) => { var _a; return call.id === ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id); });
                     if (removedCall) {
                         const removedCallState = this.callClient.getState().callsEnded[removedCall.id];
                         const latestAcceptedTransfer = findLatestAcceptedTransfer(removedCallState.transfer.acceptedTransfers);
@@ -423,21 +441,17 @@ export class AzureCommunicationCallAdapter {
                     shouldCameraBeOnInCall = options.cameraOn;
                 }
             }
-            const audioOptions = {
-                muted: !shouldMicrophoneBeOnInCall
-            };
+            const audioOptions = { muted: !shouldMicrophoneBeOnInCall };
             const selectedCamera = getSelectedCameraFromAdapterState(this.getState());
-            const videoOptions = selectedCamera && shouldCameraBeOnInCall ? {
-                localVideoStreams: [new SDKLocalVideoStream(selectedCamera)]
-            } : {};
+            const videoOptions = selectedCamera && shouldCameraBeOnInCall
+                ? { localVideoStreams: [new SDKLocalVideoStream(selectedCamera)] }
+                : {};
             /* @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,
+                    alternateCallerId: phoneNumber ? { phoneNumber: phoneNumber } : undefined,
                     audioOptions,
                     videoOptions
                 });
@@ -448,9 +462,9 @@ export class AzureCommunicationCallAdapter {
         });
     }
     _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);
+        const isRoomsCall = 'roomId' in this.locator;
         /* @conditional-compile-remove(teams-identity-support) */
         if (_isTeamsCallAgent(this.callAgent)) {
             if (!isTeamsMeeting) {
@@ -518,7 +532,8 @@ export class AzureCommunicationCallAdapter {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.handlers.onHangUp(forEveryone);
             this.unsubscribeCallEvents();
-            this.handlers = createHandlers(this.callClient, this.callAgent, this.deviceManager, undefined, /* @conditional-compile-remove(video-background-effects) */ {
+            this.handlers = createHandlers(this.callClient, this.callAgent, this.deviceManager, undefined, 
+            /* @conditional-compile-remove(video-background-effects) */ {
                 onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency
             });
             // We set the adapter.call object to undefined immediately when a call is ended.
@@ -679,7 +694,7 @@ export class AzureCommunicationCallAdapter {
         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) => {
             let backendId = participant;
             if (typeof participant === 'string') {
                 backendId = _toCommunicationIdentifier(participant);
@@ -704,7 +719,8 @@ export class AzureCommunicationCallAdapter {
         this.context.setCurrentCallId(call.id);
         // Resync state after callId is set
         this.context.updateClientState(this.callClient.getState());
-        this.handlers = createHandlers(this.callClient, this.callAgent, this.deviceManager, this.call, /* @conditional-compile-remove(video-background-effects) */ {
+        this.handlers = createHandlers(this.callClient, this.callAgent, this.deviceManager, this.call, 
+        /* @conditional-compile-remove(video-background-effects) */ {
             onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency
         });
         this.subscribeCallEvents();
@@ -822,6 +838,10 @@ export class AzureCommunicationCallAdapter {
     }
     subscribeCallEvents() {
         var _a, _b, _c, _d, _e, _f, _g;
+        /* @conditional-compile-remove(calling-sounds) */
+        if (this.call) {
+            this.callingSoundSubscriber = new CallingSoundSubscriber(this.call, this.emitter, this.getState().sounds);
+        }
         (_a = this.call) === null || _a === void 0 ? void 0 : _a.on('remoteParticipantsUpdated', this.onRemoteParticipantsUpdated.bind(this));
         (_b = this.call) === null || _b === void 0 ? void 0 : _b.on('isMutedChanged', this.isMyMutedChanged.bind(this));
         (_c = this.call) === null || _c === void 0 ? void 0 : _c.on('isScreenSharingOnChanged', this.isScreenSharingOnChanged.bind(this));
@@ -845,22 +865,22 @@ export class AzureCommunicationCallAdapter {
         (_d = this.call) === null || _d === void 0 ? void 0 : _d.off('idChanged', this.callIdChanged.bind(this));
         /* @conditional-compile-remove(close-captions) */
         this.unsubscribeFromCaptionEvents();
+        /* @conditional-compile-remove(calling-sounds) */
+        if (this.callingSoundSubscriber) {
+            this.callingSoundSubscriber.unsubscribeAll();
+        }
     }
     onRemoteParticipantsUpdated({ added, removed }) {
         if (added && added.length > 0) {
-            this.emitter.emit('participantsJoined', {
-                joined: added
-            });
+            this.emitter.emit('participantsJoined', { joined: added });
         }
         if (removed && removed.length > 0) {
-            this.emitter.emit('participantsLeft', {
-                removed: 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));
@@ -868,15 +888,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 });
     }
     /* @conditional-compile-remove(close-captions) */
     captionsReceived(captionsInfo) {
-        this.emitter.emit('captionsReceived', {
-            captionsInfo
-        });
+        this.emitter.emit('captionsReceived', { captionsInfo });
     }
     /* @conditional-compile-remove(close-captions) */
     isCaptionsActiveChanged() {
@@ -911,9 +927,9 @@ export class AzureCommunicationCallAdapter {
                     audioOptions: (_d = options === null || options === void 0 ? void 0 : options.audioOptions) !== null && _d !== void 0 ? _d : {
                         muted: !!((_e = this.context.getState().call) === null || _e === void 0 ? void 0 : _e.isMuted)
                     },
-                    videoOptions: (_f = options === null || options === void 0 ? void 0 : options.videoOptions) !== null && _f !== void 0 ? _f : ( /* maintain video state if options.videoOptions is not defined */videoSource ? {
-                        localVideoStreams: [new LocalVideoStream(videoSource)]
-                    } : undefined)
+                    videoOptions: (_f = options === null || options === void 0 ? void 0 : options.videoOptions) !== null && _f !== void 0 ? _f : 
+                    /* maintain video state if options.videoOptions is not defined */
+                    (videoSource ? { localVideoStreams: [new LocalVideoStream(videoSource)] } : undefined)
                 });
             } });
         this.emitter.emit('transferRequested', newArgs);
@@ -934,9 +950,7 @@ export class AzureCommunicationCallAdapter {
     }
     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) {
@@ -997,7 +1011,8 @@ export const createAzureCommunicationCallAdapter = ({ userId, displayName, crede
     const callAgent = yield callClient.createCallAgent(credential, {
         displayName
     });
-    const adapter = createAzureCommunicationCallAdapterFromClient(callClient, callAgent, locator, /* @conditional-compile-remove(video-background-effects) */ options);
+    const adapter = createAzureCommunicationCallAdapterFromClient(callClient, callAgent, locator, 
+    /* @conditional-compile-remove(video-background-effects) */ options);
     return adapter;
 });
 /* @conditional-compile-remove(teams-identity-support) */
@@ -1106,9 +1121,20 @@ const useAzureCommunicationCallAdapterGeneric = (args, afterCreate, beforeDispos
         }))();
     }, 
     // Explicitly list all arguments so that caller doesn't have to memoize the `args` object.
-    [adapterRef, afterCreateRef, beforeDisposeRef, adapterKind, credential, locator, userId, displayName,
+    [
+        adapterRef,
+        afterCreateRef,
+        beforeDisposeRef,
+        adapterKind,
+        credential,
+        locator,
+        userId,
+        displayName,
+        /* @conditional-compile-remove(PSTN-calls) */
         alternateCallerId,
-        options]);
+        /* @conditional-compile-remove(teams-identity-support) */
+        options
+    ]);
     // Dispose any existing adapter when the component unmounts.
     useEffect(() => {
         return () => {
@@ -1139,7 +1165,26 @@ 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) */
@@ -1157,7 +1202,26 @@ export const useAzureCommunicationCallAdapter = (args, afterCreate, beforeDispos
  *
  * @beta
  */
-export const useTeamsCallAdapter = (args, afterCreate, beforeDispose) => {
+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');
 };
 /**
@@ -1169,14 +1233,15 @@ export const useTeamsCallAdapter = (args, afterCreate, beforeDispose) => {
  * @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());
     yield Promise.all([deviceManager.getCameras(), deviceManager.getMicrophones()]);
     if (deviceManager.isSpeakerSelectionAvailable) {
         yield deviceManager.getSpeakers();
     }
     /* @conditional-compile-remove(unsupported-browser) */
     yield callClient.feature(Features.DebugInfo).getEnvironmentInfo();
-    return new AzureCommunicationCallAdapter(callClient, locator, callAgent, deviceManager, /* @conditional-compile-remove(video-background-effects) */ options);
+    return new AzureCommunicationCallAdapter(callClient, locator, callAgent, deviceManager, 
+    /* @conditional-compile-remove(video-background-effects) */ options);
 });
 /* @conditional-compile-remove(teams-identity-support) */
 /**
@@ -1188,7 +1253,7 @@ export const createAzureCommunicationCallAdapterFromClient = (callClient, callAg
  * @beta
  */
 export const createTeamsCallAdapterFromClient = (callClient, callAgent, locator, options) => __awaiter(void 0, void 0, void 0, function* () {
-    const deviceManager = yield callClient.getDeviceManager();
+    const deviceManager = (yield callClient.getDeviceManager());
     yield Promise.all([deviceManager.getCameras(), deviceManager.getMicrophones()]);
     if (deviceManager.isSpeakerSelectionAvailable) {
         yield deviceManager.getSpeakers();