@azure/communication-react 1.18.0-beta.1 → 1.19.0-alpha-202407230014

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

@@ -61,9 +61,11 @@ class CallContext {
         };
         this.emitter.setMaxListeners((_d = options === null || options === void 0 ? void 0 : options.maxListeners) !== null && _d !== void 0 ? _d : 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) */
@@ -109,20 +111,24 @@ class CallContext {
             environmentInfo: this.state.environmentInfo,
             unsupportedBrowserVersionOptedIn: this.state.unsupportedBrowserVersionsAllowed
         };
-        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;
         const transferCall = latestAcceptedTransfer ? clientState.calls[latestAcceptedTransfer.callId] : undefined;
-        const newPage = getCallCompositePage(call, latestEndedCall, transferCall, /* @conditional-compile-remove(unsupported-browser) */ environmentInfo);
+        const newPage = getCallCompositePage(call, latestEndedCall, transferCall, 
+        /* @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, 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', acceptedTransferCallState: transferCall }));
+            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', acceptedTransferCallState: transferCall }));
         }
     }
     /* @conditional-compile-remove(unsupported-browser) */
@@ -192,12 +198,20 @@ export class AzureCommunicationCallAdapter {
         this.bindPublicMethods();
         this.callClient = callClient;
         this.callAgent = callAgent;
-        this.targetCallees = getLocatorOrTargetCallees(locatorOrTargetCalless) === true ? locatorOrTargetCalless : undefined;
-        this.locator = getLocatorOrTargetCallees(locatorOrTargetCalless) === false ? locatorOrTargetCalless : undefined;
+        this.targetCallees =
+            getLocatorOrTargetCallees(locatorOrTargetCalless) === true
+                ? locatorOrTargetCalless
+                : undefined;
+        this.locator =
+            getLocatorOrTargetCallees(locatorOrTargetCalless) === false
+                ? locatorOrTargetCalless
+                : undefined;
         this.deviceManager = deviceManager;
-        const isTeamsMeeting = this.locator ? 'meetingLink' in this.locator || /* @conditional-compile-remove(meeting-id) */ 'meetingId' in this.locator : false;
+        const isTeamsMeeting = this.locator
+            ? 'meetingLink' in this.locator || /* @conditional-compile-remove(meeting-id) */ 'meetingId' in this.locator
+            : false;
         let isTeamsCall;
-        (_a = this.targetCallees) === null || _a === void 0 ? void 0 : _a.forEach(callee => {
+        (_a = this.targetCallees) === null || _a === void 0 ? void 0 : _a.forEach((callee) => {
             if (isMicrosoftTeamsUserIdentifier(callee) || isMicrosoftTeamsAppIdentifier(callee)) {
                 isTeamsCall = true;
             }
@@ -205,9 +219,9 @@ export class AzureCommunicationCallAdapter {
         const isRoomsCall = this.locator ? 'roomId' in this.locator : false;
         this.onResolveVideoBackgroundEffectsDependency = (_b = options === null || options === void 0 ? void 0 : options.videoBackgroundOptions) === null || _b === void 0 ? void 0 : _b.onResolveDependency;
         this.context = new CallContext(callClient.getState(), !!isTeamsCall, isTeamsMeeting, isRoomsCall, options, this.targetCallees);
-        this.context.onCallEnded(endCallData => this.emitter.emit('callEnded', endCallData));
+        this.context.onCallEnded((endCallData) => this.emitter.emit('callEnded', endCallData));
         const onStateChange = (clientState) => {
-            var _a, _b, _c;
+            var _a, _b, _c, _d, _e;
             // unsubscribe when the instance gets disposed
             if (!this) {
                 callClient.offStateChange(onStateChange);
@@ -221,9 +235,14 @@ export class AzureCommunicationCallAdapter {
             if ((_a = this.call) === null || _a === void 0 ? void 0 : _a.id) {
                 this.context.setCurrentCallId(this.call.id);
             }
+            // if the call hits the connected state we want to pause all calling sounds if playing.
+            if (((_b = this.call) === null || _b === void 0 ? void 0 : _b.state) === 'Connected' && ((_c = this.callingSoundSubscriber) === null || _c === void 0 ? void 0 : _c.playingSounds)) {
+                this.callingSoundSubscriber.pauseSounds();
+            }
             // If the call connects we need to clean up any previous unparentedViews
-            if ((((_b = this.call) === null || _b === void 0 ? void 0 : _b.state) === 'InLobby' || ((_c = this.call) === null || _c === void 0 ? void 0 : _c.state) === 'Connected') && this.callClient.getState().deviceManager.unparentedViews.length > 0) {
-                this.callClient.getState().deviceManager.unparentedViews.forEach(view => {
+            if ((((_d = this.call) === null || _d === void 0 ? void 0 : _d.state) === 'InLobby' || ((_e = this.call) === null || _e === void 0 ? void 0 : _e.state) === 'Connected') &&
+                this.callClient.getState().deviceManager.unparentedViews.length > 0) {
+                this.callClient.getState().deviceManager.unparentedViews.forEach((view) => {
                     this.callClient.disposeView(undefined, undefined, view);
                 });
             }
@@ -239,7 +258,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);
@@ -258,7 +277,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);
@@ -335,6 +354,10 @@ export class AzureCommunicationCallAdapter {
         this.startSpotlight.bind(this);
         this.stopSpotlight.bind(this);
         this.stopAllSpotlight.bind(this);
+        /* @conditional-compile-remove(soft-mute) */
+        this.muteParticipant.bind(this);
+        /* @conditional-compile-remove(soft-mute) */
+        this.muteAllRemoteParticipants.bind(this);
     }
     dispose() {
         this.resetDiagnosticsForwarder();
@@ -410,13 +433,11 @@ 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)] }
+                : {};
             const call = this._joinCall(audioOptions, videoOptions);
             this.processNewCall(call);
             return call;
@@ -506,7 +527,7 @@ export class AzureCommunicationCallAdapter {
     leaveCall(forEveryone) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.getState().page === 'transferring') {
-                const transferCall = this.callAgent.calls.filter(call => { var _a; return call.id === ((_a = this.getState().acceptedTransferCallState) === null || _a === void 0 ? void 0 : _a.id); })[0];
+                const transferCall = this.callAgent.calls.filter((call) => { var _a; return call.id === ((_a = this.getState().acceptedTransferCallState) === null || _a === void 0 ? void 0 : _a.id); })[0];
                 transferCall === null || transferCall === void 0 ? void 0 : transferCall.hangUp();
             }
             yield this.handlers.onHangUp(forEveryone);
@@ -675,13 +696,13 @@ export class AzureCommunicationCallAdapter {
         const isCameraOn = this.getState().cameraStatus === 'On';
         const selectedCamera = getSelectedCameraFromAdapterState(this.getState());
         /* we only configure the video options here since the Calling SDK always unmutes the participant when starting a call */
-        const startCallVideoOptions = selectedCamera ? {
-            videoOptions: isCameraOn ? {
-                localVideoStreams: [new SDKLocalVideoStream(selectedCamera)]
-            } : undefined
-        } : {};
+        const startCallVideoOptions = selectedCamera
+            ? {
+                videoOptions: isCameraOn ? { localVideoStreams: [new SDKLocalVideoStream(selectedCamera)] } : undefined
+            }
+            : {};
         const combinedCallOptions = Object.assign(Object.assign({}, startCallVideoOptions), options);
-        const idsToAdd = participants.map(participant => {
+        const idsToAdd = participants.map((participant) => {
             const backendId = _toCommunicationIdentifier(participant);
             if ('phoneNumber' in backendId) {
                 if ((options === null || options === void 0 ? void 0 : options.alternateCallerId) === undefined) {
@@ -793,6 +814,18 @@ export class AzureCommunicationCallAdapter {
             return this.handlers.onSubmitSurvey(survey);
         });
     }
+    /* @conditional-compile-remove(soft-mute) */
+    muteParticipant(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.handlers.onMuteParticipant(userId);
+        });
+    }
+    /* @conditional-compile-remove(soft-mute) */
+    muteAllRemoteParticipants() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.handlers.onMuteAllRemoteParticipants();
+        });
+    }
     startSpotlight(userIds) {
         return __awaiter(this, void 0, void 0, function* () {
             this.handlers.onStartSpotlight(userIds);
@@ -825,7 +858,8 @@ export class AzureCommunicationCallAdapter {
         var _a;
         if (this.call && this.call.state === 'Connected') {
             const captionsFeature = (_a = this.call) === null || _a === void 0 ? void 0 : _a.feature(Features.Captions);
-            if (captionsFeature.captions.kind === 'TeamsCaptions' && (this.context.getState().isTeamsCall || this.context.getState().isTeamsMeeting)) {
+            if (captionsFeature.captions.kind === 'TeamsCaptions' &&
+                (this.context.getState().isTeamsCall || this.context.getState().isTeamsMeeting)) {
                 const teamsCaptionsFeature = captionsFeature.captions;
                 teamsCaptionsFeature.on('CaptionsReceived', this.teamsCaptionsReceived.bind(this));
                 teamsCaptionsFeature.on('CaptionsActiveChanged', this.isCaptionsActiveChanged.bind(this));
@@ -850,7 +884,8 @@ export class AzureCommunicationCallAdapter {
         var _a, _b;
         if (this.call && this.call.state === 'Connected') {
             const captionsFeature = (_a = this.call) === null || _a === void 0 ? void 0 : _a.feature(Features.Captions);
-            if (captionsFeature.captions.kind === 'TeamsCaptions' && (this.context.getState().isTeamsCall || this.context.getState().isTeamsMeeting)) {
+            if (captionsFeature.captions.kind === 'TeamsCaptions' &&
+                (this.context.getState().isTeamsCall || this.context.getState().isTeamsMeeting)) {
                 const teamsCaptionsFeature = captionsFeature.captions;
                 teamsCaptionsFeature.off('CaptionsReceived', this.teamsCaptionsReceived.bind(this));
                 teamsCaptionsFeature.off('CaptionsActiveChanged', this.isCaptionsActiveChanged.bind(this));
@@ -917,19 +952,15 @@ export class AzureCommunicationCallAdapter {
     }
     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));
@@ -937,20 +968,14 @@ 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 });
     }
     teamsCaptionsReceived(captionsInfo) {
-        this.emitter.emit('captionsReceived', {
-            captionsInfo
-        });
+        this.emitter.emit('captionsReceived', { captionsInfo });
     }
     /* @conditional-compile-remove(acs-close-captions) */
     captionsReceived(captionsInfo) {
-        this.emitter.emit('captionsReceived', {
-            captionsInfo
-        });
+        this.emitter.emit('captionsReceived', { captionsInfo });
     }
     isCaptionsActiveChanged() {
         var _a;
@@ -1006,9 +1031,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) {
@@ -1150,7 +1173,7 @@ function useAzureCommunicationCallAdapterGeneric(args, adapterKind = 'AzureCommu
     afterCreateRef.current = afterCreate;
     beforeDisposeRef.current = beforeDispose;
     useEffect(() => {
-        if (!credential || !locator && !targetCallees || !userId) {
+        if (!credential || (!locator && !targetCallees) || !userId) {
             return;
         }
         if (adapterKind === 'AzureCommunication' && !displayName) {
@@ -1241,8 +1264,20 @@ function useAzureCommunicationCallAdapterGeneric(args, adapterKind = 'AzureCommu
         }))();
     }, 
     // Explicitly list all arguments so that caller doesn't have to memoize the `args` object.
-    [adapterRef, afterCreateRef, beforeDisposeRef, adapterKind, credential, locator, userId, displayName, /* @conditional-compile-remove(PSTN-calls) */
-        alternateCallerId, options, targetCallees]);
+    [
+        adapterRef,
+        afterCreateRef,
+        beforeDisposeRef,
+        adapterKind,
+        credential,
+        locator,
+        userId,
+        displayName,
+        /* @conditional-compile-remove(PSTN-calls) */
+        alternateCallerId,
+        options,
+        targetCallees
+    ]);
     // Dispose any existing adapter when the component unmounts.
     useEffect(() => {
         return () => {
@@ -1273,7 +1308,26 @@ function useAzureCommunicationCallAdapterGeneric(args, adapterKind = 'AzureCommu
  *
  * @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, 'AzureCommunication', afterCreate, beforeDispose);
 };
 /* @conditional-compile-remove(teams-identity-support) */
@@ -1291,7 +1345,26 @@ export const useAzureCommunicationCallAdapter = (args, afterCreate, beforeDispos
  *
  * @public
  */
-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, 'Teams', afterCreate, beforeDispose);
 };
 /**
@@ -1304,7 +1377,7 @@ export const useTeamsCallAdapter = (args, afterCreate, beforeDispose) => {
  */
 export function createAzureCommunicationCallAdapterFromClient(callClient, callAgent, locatorOrtargetCallees, options) {
     return __awaiter(this, 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();
@@ -1329,7 +1402,7 @@ export function createAzureCommunicationCallAdapterFromClient(callClient, callAg
  * @public
  */
 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();