@azure/communication-react 1.19.0-beta.3 → 1.20.0-alpha-202409180015

package/dist/dist-esm/react-composites/src/composites/CallWithChatComposite/adapter/AzureCommunicationCallWithChatAdapter.js

@@ -9,16 +9,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+/* @conditional-compile-remove(breakout-rooms) */
 import { toFlatCommunicationIdentifier } from "../../../../../acs-ui-common/src";
 import { callWithChatAdapterStateFromBackingStates, mergeCallAdapterStateIntoCallWithChatAdapterState, mergeChatAdapterStateIntoCallWithChatAdapterState } from '../state/CallWithChatAdapterState';
 import { _createAzureCommunicationChatAdapterInner, _createLazyAzureCommunicationChatAdapterInner, createAzureCommunicationChatAdapterFromClient } from '../../ChatComposite/adapter/AzureCommunicationChatAdapter';
 import { EventEmitter } from 'events';
+/* @conditional-compile-remove(PSTN-calls) */
 import { isCommunicationUserIdentifier } from '@azure/communication-common';
 import { getChatThreadFromTeamsLink } from './parseTeamsUrl';
 import { _createAzureCommunicationCallAdapterInner } from '../../CallComposite/adapter/AzureCommunicationCallAdapter';
 import { createAzureCommunicationCallAdapterFromClient } from '../../CallComposite/adapter/AzureCommunicationCallAdapter';
 import { useEffect, useRef, useState } from 'react';
 import { _toCommunicationIdentifier } from "../../../../../acs-ui-common/src";
+/* @conditional-compile-remove(breakout-rooms) */
 import { busyWait } from '../../common/utils';
 /** Context of Call with Chat, which is a centralized context for all state updates */
 class CallWithChatContext {
@@ -46,6 +49,7 @@ class CallWithChatContext {
     updateClientStateWithChatState(chatAdapterState) {
         this.updateClientState(mergeChatAdapterStateIntoCallWithChatAdapterState(this.state, chatAdapterState));
     }
+    /* @conditional-compile-remove(breakout-rooms) */
     unsetChatState() {
         this.updateClientState(Object.assign(Object.assign({}, this.state), { chat: undefined }));
     }
@@ -70,12 +74,14 @@ export class AzureCommunicationCallWithChatAdapter {
         this.onChatStateChange = onChatStateChange;
         if (chatAdapter) {
             this.updateChatAdapter(chatAdapter);
+            /* @conditional-compile-remove(breakout-rooms) */
             this.originCallChatAdapter = chatAdapter;
         }
         const onCallStateChange = (newCallAdapterState) => {
             this.context.updateClientStateWithCallState(newCallAdapterState);
         };
         this.callAdapter.onStateChange(onCallStateChange);
+        /* @conditional-compile-remove(breakout-rooms) */
         this.callAdapter.on('breakoutRoomsUpdated', (eventData) => __awaiter(this, void 0, void 0, function* () {
             if (eventData.type === 'join') {
                 yield this.breakoutRoomJoined(eventData.data);
@@ -86,6 +92,7 @@ export class AzureCommunicationCallWithChatAdapter {
                 }
             }
         }));
+        /* @conditional-compile-remove(breakout-rooms) */
         this.callAdapter.on('callEnded', () => {
             var _a, _b, _c;
             const originCallId = (_b = (_a = this.context.getState().call) === null || _a === void 0 ? void 0 : _a.breakoutRooms) === null || _b === void 0 ? void 0 : _b.breakoutRoomOriginCallId;
@@ -97,6 +104,7 @@ export class AzureCommunicationCallWithChatAdapter {
         });
         this.onCallStateChange = onCallStateChange;
     }
+    /* @conditional-compile-remove(breakout-rooms) */
     breakoutRoomJoined(call) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -131,6 +139,7 @@ export class AzureCommunicationCallWithChatAdapter {
             }
         });
     }
+    /* @conditional-compile-remove(breakout-rooms) */
     setBreakoutRoomChatAdapterToThread(targetThreadId) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.breakoutRoomChatAdapter) {
@@ -154,16 +163,19 @@ export class AzureCommunicationCallWithChatAdapter {
         });
     }
     setChatAdapterPromise(chatAdapter) {
-        chatAdapter.then(adapter => {
+        chatAdapter.then((adapter) => {
             if (!this.isAdapterDisposed) {
                 this.updateChatAdapter(adapter);
+                /* @conditional-compile-remove(breakout-rooms) */
                 this.originCallChatAdapter = adapter;
             }
         });
     }
+    /* @conditional-compile-remove(breakout-rooms) */
     setCreateChatAdapterCallback(chatThreadCallBack) {
         this.createChatAdapterCallback = chatThreadCallBack;
     }
+    /* @conditional-compile-remove(breakout-rooms) */
     createNewChatAdapterForThread(threadId) {
         if (this.createChatAdapterCallback) {
             return this.createChatAdapterCallback(threadId);
@@ -208,7 +220,9 @@ export class AzureCommunicationCallWithChatAdapter {
         this.disposeScreenShareStreamView.bind(this);
         this.fetchInitialData.bind(this);
         this.sendMessage.bind(this);
+        /* @conditional-compile-remove(rich-text-editor-image-upload) */
         this.uploadImage.bind(this);
+        /* @conditional-compile-remove(rich-text-editor-image-upload) */
         this.deleteImage.bind(this);
         this.sendReadReceipt.bind(this);
         this.sendTypingIndicator.bind(this);
@@ -219,10 +233,14 @@ export class AzureCommunicationCallWithChatAdapter {
         this.off.bind(this);
         this.downloadResourceToCache = this.downloadResourceToCache.bind(this);
         this.removeResourceFromCache = this.removeResourceFromCache.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.addParticipant.bind(this);
         this.sendDtmfTone.bind(this);
+        /* @conditional-compile-remove(unsupported-browser) */
         this.allowUnsupportedBrowserVersion.bind(this);
         this.startCaptions.bind(this);
         this.stopCaptions.bind(this);
@@ -231,6 +249,10 @@ export class AzureCommunicationCallWithChatAdapter {
         this.startVideoBackgroundEffect.bind(this);
         this.stopVideoBackgroundEffects.bind(this);
         this.updateBackgroundPickerImages.bind(this);
+        /* @conditional-compile-remove(DNS) */
+        this.startNoiseSuppressionEffect.bind(this);
+        /* @conditional-compile-remove(DNS) */
+        this.stopNoiseSuppressionEffect.bind(this);
     }
     /** Join existing Call. */
     joinCall(options) {
@@ -292,6 +314,7 @@ export class AzureCommunicationCallWithChatAdapter {
     removeParticipant(userId) {
         return __awaiter(this, void 0, void 0, function* () {
             let participant = userId;
+            /* @conditional-compile-remove(PSTN-calls) */
             participant = _toCommunicationIdentifier(userId);
             yield this.callAdapter.removeParticipant(participant);
         });
@@ -423,31 +446,35 @@ export class AzureCommunicationCallWithChatAdapter {
     /** Fetch initial Call and Chat data such as chat messages. */
     fetchInitialData() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.fetchInitialData();
             });
         });
     }
     /** Send a chat message. */
-    sendMessage(content, options) {
+    sendMessage(content, 
+    /* @conditional-compile-remove(file-sharing-acs) */
+    options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
-                return adapter.sendMessage(content, options);
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
+                return adapter.sendMessage(content, /* @conditional-compile-remove(file-sharing-acs) */ options);
             });
         });
     }
+    /* @conditional-compile-remove(rich-text-editor-image-upload) */
     /** Upload a chat image. */
     uploadImage(image, imageFileName) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.uploadImage(image, imageFileName);
             });
         });
     }
+    /* @conditional-compile-remove(rich-text-editor-image-upload) */
     /** Delete a chat image. */
     deleteImage(imageId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.deleteImage(imageId);
             });
         });
@@ -455,7 +482,7 @@ export class AzureCommunicationCallWithChatAdapter {
     /** Send a chat read receipt. */
     sendReadReceipt(chatMessageId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.sendReadReceipt(chatMessageId);
             });
         });
@@ -463,7 +490,7 @@ export class AzureCommunicationCallWithChatAdapter {
     /** Send an isTyping indicator. */
     sendTypingIndicator() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.sendTypingIndicator();
             });
         });
@@ -471,7 +498,7 @@ export class AzureCommunicationCallWithChatAdapter {
     /** Load previous Chat messages. */
     loadPreviousChatMessages(messagesToLoad) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.loadPreviousChatMessages(messagesToLoad);
             });
         });
@@ -479,7 +506,7 @@ export class AzureCommunicationCallWithChatAdapter {
     /** Update an existing message. */
     updateMessage(messageId, content, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.executeWithResolvedChatAdapter(adapter => {
+            return this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.updateMessage(messageId, content, options);
             });
         });
@@ -487,33 +514,36 @@ export class AzureCommunicationCallWithChatAdapter {
     /** Delete an existing message. */
     deleteMessage(messageId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.executeWithResolvedChatAdapter(adapter => {
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
                 return adapter.deleteMessage(messageId);
             });
         });
     }
     downloadResourceToCache(resourceDetails) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.executeWithResolvedChatAdapter(adapter => {
+            this.executeWithResolvedChatAdapter((adapter) => {
                 adapter.downloadResourceToCache(resourceDetails);
             });
         });
     }
     removeResourceFromCache(resourceDetails) {
-        this.executeWithResolvedChatAdapter(adapter => {
+        this.executeWithResolvedChatAdapter((adapter) => {
             adapter.removeResourceFromCache(resourceDetails);
         });
     }
+    /* @conditional-compile-remove(PSTN-calls) */
     holdCall() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.callAdapter.holdCall();
         });
     }
+    /* @conditional-compile-remove(PSTN-calls) */
     resumeCall() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.callAdapter.resumeCall();
         });
     }
+    /* @conditional-compile-remove(PSTN-calls) */
     addParticipant(participant, options) {
         return __awaiter(this, void 0, void 0, function* () {
             if (isCommunicationUserIdentifier(participant)) {
@@ -529,6 +559,7 @@ export class AzureCommunicationCallWithChatAdapter {
             return yield this.callAdapter.sendDtmfTone(dtmfTone);
         });
     }
+    /* @conditional-compile-remove(unsupported-browser) */
     allowUnsupportedBrowserVersion() {
         return this.callAdapter.allowUnsupportedBrowserVersion();
     }
@@ -537,9 +568,9 @@ export class AzureCommunicationCallWithChatAdapter {
             yield this.callAdapter.startCaptions(options);
         });
     }
-    stopCaptions() {
+    stopCaptions(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.callAdapter.stopCaptions();
+            yield this.callAdapter.stopCaptions(options);
         });
     }
     setCaptionLanguage(language) {
@@ -568,6 +599,18 @@ export class AzureCommunicationCallWithChatAdapter {
     updateSelectedVideoBackgroundEffect(selectedVideoBackground) {
         return this.callAdapter.updateSelectedVideoBackgroundEffect(selectedVideoBackground);
     }
+    /* @conditional-compile-remove(DNS) */
+    startNoiseSuppressionEffect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.callAdapter.startNoiseSuppressionEffect();
+        });
+    }
+    /* @conditional-compile-remove(DNS) */
+    stopNoiseSuppressionEffect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.callAdapter.stopNoiseSuppressionEffect();
+        });
+    }
     submitSurvey(survey) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.callAdapter.submitSurvey(survey);
@@ -588,20 +631,24 @@ export class AzureCommunicationCallWithChatAdapter {
             return this.callAdapter.stopAllSpotlight();
         });
     }
+    /* @conditional-compile-remove(soft-mute) */
     muteParticipant(userId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.callAdapter.muteParticipant(userId);
         });
     }
+    /* @conditional-compile-remove(soft-mute) */
     muteAllRemoteParticipants() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.callAdapter.muteAllRemoteParticipants();
         });
     }
+    /* @conditional-compile-remove(breakout-rooms) */
     returnFromBreakoutRoom() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
-            if (this.originCallChatAdapter && ((_a = this.context.getState().chat) === null || _a === void 0 ? void 0 : _a.threadId) !== this.originCallChatAdapter.getState().thread.threadId) {
+            if (this.originCallChatAdapter &&
+                ((_a = this.context.getState().chat) === null || _a === void 0 ? void 0 : _a.threadId) !== this.originCallChatAdapter.getState().thread.threadId) {
                 (_b = this.breakoutRoomChatAdapter) === null || _b === void 0 ? void 0 : _b.dispose();
                 this.updateChatAdapter(this.originCallChatAdapter);
             }
@@ -657,37 +704,37 @@ export class AzureCommunicationCallWithChatAdapter {
                 this.callAdapter.on('isSpokenLanguageChanged', listener);
                 break;
             case 'messageReceived':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('messageReceived', listener);
                 });
                 break;
             case 'messageEdited':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('messageEdited', listener);
                 });
                 break;
             case 'messageDeleted':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('messageDeleted', listener);
                 });
                 break;
             case 'messageSent':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('messageSent', listener);
                 });
                 break;
             case 'messageRead':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('messageRead', listener);
                 });
                 break;
             case 'chatParticipantsAdded':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('participantsAdded', listener);
                 });
                 break;
             case 'chatParticipantsRemoved':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('participantsRemoved', listener);
                 });
                 break;
@@ -695,7 +742,7 @@ export class AzureCommunicationCallWithChatAdapter {
                 this.callAdapter.on('error', listener);
                 break;
             case 'chatError':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('error', listener);
                 });
                 break;
@@ -708,6 +755,7 @@ export class AzureCommunicationCallWithChatAdapter {
             case 'spotlightChanged':
                 this.callAdapter.on('spotlightChanged', listener);
                 break;
+            /* @conditional-compile-remove(breakout-rooms) */
             case 'breakoutRoomsUpdated':
                 this.callAdapter.on('breakoutRoomsUpdated', listener);
                 break;
@@ -761,37 +809,37 @@ export class AzureCommunicationCallWithChatAdapter {
                 this.callAdapter.off('isSpokenLanguageChanged', listener);
                 break;
             case 'messageReceived':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('messageReceived', listener);
                 });
                 break;
             case 'messageEdited':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('messageEdited', listener);
                 });
                 break;
             case 'messageDeleted':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('messageDeleted', listener);
                 });
                 break;
             case 'messageSent':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('messageSent', listener);
                 });
                 break;
             case 'messageRead':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('messageRead', listener);
                 });
                 break;
             case 'chatParticipantsAdded':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('participantsAdded', listener);
                 });
                 break;
             case 'chatParticipantsRemoved':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('participantsRemoved', listener);
                 });
                 break;
@@ -799,7 +847,7 @@ export class AzureCommunicationCallWithChatAdapter {
                 this.callAdapter.off('error', listener);
                 break;
             case 'chatError':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('error', listener);
                 });
                 break;
@@ -812,6 +860,7 @@ export class AzureCommunicationCallWithChatAdapter {
             case 'spotlightChanged':
                 this.callAdapter.off('spotlightChanged', listener);
                 break;
+            /* @conditional-compile-remove(breakout-rooms) */
             case 'breakoutRoomsUpdated':
                 this.callAdapter.off('breakoutRoomsUpdated', listener);
                 break;
@@ -870,8 +919,8 @@ export class TeamsMeetingLinkProvider {
         return __awaiter(this, void 0, void 0, function* () {
             {
                 // Wait for the call to be connected and get the chat thread ID from `call.callInfo`.
-                const chatThreadPromise = new Promise(resolve => {
-                    this.callAdapterPromise.then(callAdapter => {
+                const chatThreadPromise = new Promise((resolve) => {
+                    this.callAdapterPromise.then((callAdapter) => {
                         // Ensure function is idempotent by removing any existing subscription.
                         this.callAdapterSubscription && callAdapter.offStateChange(this.callAdapterSubscription);
                         this.callAdapterSubscription = (state) => {
@@ -913,17 +962,17 @@ export class TeamsMeetingIdProvider {
      */
     getChatThreadPromise() {
         return __awaiter(this, void 0, void 0, function* () {
-            return new Promise(resolve => {
+            return new Promise((resolve) => {
                 const stateChangeListener = (state) => {
                     var _a, _b, _c;
                     if (((_a = state.call) === null || _a === void 0 ? void 0 : _a.state) === 'Connected' && ((_b = state.call.info) === null || _b === void 0 ? void 0 : _b.threadId)) {
-                        this.callAdapter.then(adapter => {
+                        this.callAdapter.then((adapter) => {
                             adapter.offStateChange(stateChangeListener);
                         });
                         resolve((_c = state.call.info) === null || _c === void 0 ? void 0 : _c.threadId);
                     }
                 };
-                this.callAdapter.then(adapter => {
+                this.callAdapter.then((adapter) => {
                     var _a, _b, _c;
                     const callState = (_a = adapter.getState().call) === null || _a === void 0 ? void 0 : _a.state;
                     const threadId = (_c = (_b = adapter.getState().call) === null || _b === void 0 ? void 0 : _b.info) === null || _c === void 0 ? void 0 : _c.threadId;
@@ -944,14 +993,15 @@ export class TeamsMeetingIdProvider {
  *
  * @public
  */
-export const createAzureCommunicationCallWithChatAdapter = (_a) => __awaiter(void 0, [_a], void 0, function* ({ userId, displayName, credential, endpoint, locator, alternateCallerId, callAdapterOptions }) {
+export const createAzureCommunicationCallWithChatAdapter = (_a) => __awaiter(void 0, [_a], void 0, function* ({ userId, displayName, credential, endpoint, locator, 
+/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId, callAdapterOptions }) {
     const callAdapterLocator = isTeamsMeetingLocator(locator) ? locator : locator.callLocator;
     const callAdapter = _createAzureCommunicationCallAdapterInner({
         userId,
         displayName,
         credential,
         locator: callAdapterLocator,
-        alternateCallerId,
+        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
         options: callAdapterOptions,
         telemetryImplementationHint: 'CallWithChat'
     });
@@ -960,12 +1010,14 @@ export const createAzureCommunicationCallWithChatAdapter = (_a) => __awaiter(voi
         const callWithChatAdapter = new AzureCommunicationCallWithChatAdapter(yield callAdapter);
         const chatAdapterPromise = _createLazyAzureCommunicationChatAdapterInner(endpoint, userId, displayName, credential, chatThreadAdapter.getChatThreadPromise(), 'CallWithChat');
         callWithChatAdapter.setChatAdapterPromise(chatAdapterPromise);
+        /* @conditional-compile-remove(breakout-rooms) */
         callWithChatAdapter.setCreateChatAdapterCallback((threadId) => _createAzureCommunicationChatAdapterInner(endpoint, userId, displayName, credential, threadId, 'CallWithChat'));
         return callWithChatAdapter;
     }
     else {
         const chatAdapter = _createAzureCommunicationChatAdapterInner(endpoint, userId, displayName, credential, chatThreadAdapter.getChatThread(), 'CallWithChat');
         const callWithChatAdapter = new AzureCommunicationCallWithChatAdapter(yield callAdapter, yield chatAdapter);
+        /* @conditional-compile-remove(breakout-rooms) */
         callWithChatAdapter.setCreateChatAdapterCallback((threadId) => _createAzureCommunicationChatAdapterInner(endpoint, userId, displayName, credential, threadId, 'CallWithChat'));
         return callWithChatAdapter;
     }
@@ -984,8 +1036,28 @@ export const createAzureCommunicationCallWithChatAdapter = (_a) => __awaiter(voi
  *
  * @public
  */
-export const useAzureCommunicationCallWithChatAdapter = (args, afterCreate, beforeDispose) => {
-    const { credential, displayName, endpoint, locator, userId, alternateCallerId, callAdapterOptions } = args;
+export const useAzureCommunicationCallWithChatAdapter = (
+/**
+ * Arguments to be passed to {@link createAzureCommunicationCallWithChatAdapter}.
+ *
+ * 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) => {
+    const { credential, displayName, endpoint, locator, userId, 
+    /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId, callAdapterOptions } = args;
     // 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.
@@ -1027,7 +1099,7 @@ export const useAzureCommunicationCallWithChatAdapter = (args, afterCreate, befo
                 endpoint,
                 locator,
                 userId,
-                alternateCallerId,
+                /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
                 callAdapterOptions
             });
             if (afterCreateRef.current) {
@@ -1039,7 +1111,18 @@ export const useAzureCommunicationCallWithChatAdapter = (args, afterCreate, befo
         }))();
     }, 
     // Explicitly list all arguments so that caller doesn't have to memoize the `args` object.
-    [adapterRef, afterCreateRef, alternateCallerId, beforeDisposeRef, credential, displayName, endpoint, locator, userId, callAdapterOptions]);
+    [
+        adapterRef,
+        afterCreateRef,
+        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
+        beforeDisposeRef,
+        credential,
+        displayName,
+        endpoint,
+        locator,
+        userId,
+        callAdapterOptions
+    ]);
     // Dispose any existing adapter when the component unmounts.
     useEffect(() => {
         return () => {