@azure/communication-react 1.22.0 → 1.23.0-alpha-202412200016

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

@@ -9,6 +9,8 @@ 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';
@@ -17,6 +19,8 @@ import { _createAzureCommunicationCallAdapterInner } from '../../CallComposite/a
 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 {
     constructor(clientState, maxListeners = 50) {
@@ -43,6 +47,10 @@ 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 }));
+    }
     updateClientStateWithCallState(callAdapterState) {
         this.updateClientState(mergeCallAdapterStateIntoCallWithChatAdapterState(this.state, callAdapterState));
     }
@@ -64,20 +72,114 @@ 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);
+            }
+            else if (eventData.type === 'assignedBreakoutRooms') {
+                if (!eventData.data || eventData.data.state === 'closed') {
+                    yield this.returnFromBreakoutRoom();
+                }
+            }
+        }));
+        /* @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;
+            // If the call ended is a breakout room call, return to the origin call chat adapter
+            if (originCallId && this.originCallChatAdapter) {
+                (_c = this.breakoutRoomChatAdapter) === null || _c === void 0 ? void 0 : _c.dispose();
+                this.updateChatAdapter(this.originCallChatAdapter);
+            }
+        });
         this.onCallStateChange = onCallStateChange;
     }
+    /* @conditional-compile-remove(breakout-rooms) */
+    breakoutRoomJoined(call) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const targetThreadId = call.info.threadId;
+            // If the chat adapter is not on the target thread then we need to switch to the breakout room chat adapter
+            if (targetThreadId && this.chatAdapter && this.chatAdapter.getState().thread.threadId !== targetThreadId) {
+                // Unsubscribe from chat adapter state changes
+                this.chatAdapter.offStateChange(this.onChatStateChange);
+                // Set chat state to undefined to prevent showing chat thread of origin call
+                this.context.unsetChatState();
+                // Check if the breakout room chat adapter has been initialized
+                this.breakoutRoomChatAdapter = yield this.setBreakoutRoomChatAdapterToThread(targetThreadId);
+                // Wait for the user to be added to the thread of chat adapter before updating the current chat adapter
+                // to avoid chat errors of not having access to the chat thread. This delayed access to the chat thread
+                // is also seen in Teams
+                // Check up to 20 times every 500ms and then continue.
+                yield busyWait(() => {
+                    var _a, _b;
+                    // If the call adapter's call id has been changed, then stop waiting and don't update the chat adapter
+                    if (((_a = this.context.getState().call) === null || _a === void 0 ? void 0 : _a.id) !== call.id) {
+                        return true;
+                    }
+                    const userAddedToThread = !!((_b = this.breakoutRoomChatAdapter) === null || _b === void 0 ? void 0 : _b.getState().thread.participants[toFlatCommunicationIdentifier(this.context.getState().userId)]);
+                    return userAddedToThread;
+                }, 20);
+                // If the call adapter's call has been changed while for waiting for breakout room chat adapter to be ready
+                // then don't update the chat adapter
+                if (((_a = this.context.getState().call) === null || _a === void 0 ? void 0 : _a.id) !== call.id) {
+                    return;
+                }
+                this.updateChatAdapter(this.breakoutRoomChatAdapter);
+            }
+        });
+    }
+    /* @conditional-compile-remove(breakout-rooms) */
+    setBreakoutRoomChatAdapterToThread(targetThreadId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.breakoutRoomChatAdapter) {
+                // If the breakout room chat adapter is not set on the target thread then unsubscribe, dispose, and
+                // reinitialize the chat adapter for the target thread
+                if (this.breakoutRoomChatAdapter.getState().thread.threadId !== targetThreadId) {
+                    this.breakoutRoomChatAdapter.offStateChange(this.onChatStateChange);
+                    this.breakoutRoomChatAdapter.dispose();
+                    const newBreakoutRoomChatAdapter = yield this.createNewChatAdapterForThread(targetThreadId);
+                    return newBreakoutRoomChatAdapter;
+                }
+                else {
+                    return this.breakoutRoomChatAdapter;
+                }
+            }
+            else {
+                // Initiliaze the breakout room chat adapter for the target thread
+                const newBreakoutRoomChatAdapter = yield this.createNewChatAdapterForThread(targetThreadId);
+                return newBreakoutRoomChatAdapter;
+            }
+        });
+    }
     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);
+        }
+        throw new Error('Unable to create chat adapter for thread because createChatAdapterCallback is not set');
+    }
     updateChatAdapter(chatAdapter) {
         var _a;
         (_a = this.chatAdapter) === null || _a === void 0 ? void 0 : _a.offStateChange(this.onChatStateChange);
@@ -116,6 +218,10 @@ 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);
         this.loadPreviousChatMessages.bind(this);
@@ -129,6 +235,8 @@ export class AzureCommunicationCallWithChatAdapter {
         this.resumeCall.bind(this);
         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);
         this.setSpokenLanguage.bind(this);
@@ -327,26 +435,68 @@ export class AzureCommunicationCallWithChatAdapter {
             yield this.callAdapter.disposeLocalVideoStreamView();
         });
     }
+    /* @conditional-compile-remove(together-mode) */
+    createTogetherModeStreamView(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.callAdapter.createTogetherModeStreamView(options);
+        });
+    }
+    /* @conditional-compile-remove(together-mode) */
+    startTogetherMode() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.callAdapter.startTogetherMode();
+        });
+    }
+    /* @conditional-compile-remove(together-mode) */
+    setTogetherModeSceneSize(width, height) {
+        return this.callAdapter.setTogetherModeSceneSize(width, height);
+    }
+    /* @conditional-compile-remove(together-mode) */
+    disposeTogetherModeStreamView() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.callAdapter.disposeTogetherModeStreamView();
+        });
+    }
     /** 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) {
+    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, /* @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 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 adapter.sendMessage(content);
+            return yield this.executeWithResolvedChatAdapter((adapter) => {
+                return adapter.deleteImage(imageId);
             });
         });
     }
     /** 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);
             });
         });
@@ -354,7 +504,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();
             });
         });
@@ -362,7 +512,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);
             });
         });
@@ -370,7 +520,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);
             });
         });
@@ -378,20 +528,20 @@ 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);
         });
     }
@@ -420,6 +570,10 @@ export class AzureCommunicationCallWithChatAdapter {
             return yield this.callAdapter.sendDtmfTone(dtmfTone);
         });
     }
+    /* @conditional-compile-remove(unsupported-browser) */
+    allowUnsupportedBrowserVersion() {
+        return this.callAdapter.allowUnsupportedBrowserVersion();
+    }
     startCaptions(options) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.callAdapter.startCaptions(options);
@@ -496,6 +650,21 @@ export class AzureCommunicationCallWithChatAdapter {
             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) {
+                (_b = this.breakoutRoomChatAdapter) === null || _b === void 0 ? void 0 : _b.dispose();
+                this.updateChatAdapter(this.originCallChatAdapter);
+            }
+            const originCallId = (_d = (_c = this.callAdapter.getState().call) === null || _c === void 0 ? void 0 : _c.breakoutRooms) === null || _d === void 0 ? void 0 : _d.breakoutRoomOriginCallId;
+            if (originCallId) {
+                yield this.callAdapter.returnFromBreakoutRoom();
+            }
+        });
+    }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, listener) {
         switch (event) {
@@ -542,37 +711,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;
@@ -580,7 +749,7 @@ export class AzureCommunicationCallWithChatAdapter {
                 this.callAdapter.on('error', listener);
                 break;
             case 'chatError':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.on('error', listener);
                 });
                 break;
@@ -593,6 +762,10 @@ export class AzureCommunicationCallWithChatAdapter {
             case 'spotlightChanged':
                 this.callAdapter.on('spotlightChanged', listener);
                 break;
+            /* @conditional-compile-remove(breakout-rooms) */
+            case 'breakoutRoomsUpdated':
+                this.callAdapter.on('breakoutRoomsUpdated', listener);
+                break;
             default:
                 throw `Unknown AzureCommunicationCallWithChatAdapter Event: ${event}`;
         }
@@ -643,37 +816,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;
@@ -681,7 +854,7 @@ export class AzureCommunicationCallWithChatAdapter {
                 this.callAdapter.off('error', listener);
                 break;
             case 'chatError':
-                this.executeWithResolvedChatAdapter(adapter => {
+                this.executeWithResolvedChatAdapter((adapter) => {
                     adapter.off('error', listener);
                 });
                 break;
@@ -694,6 +867,10 @@ export class AzureCommunicationCallWithChatAdapter {
             case 'spotlightChanged':
                 this.callAdapter.off('spotlightChanged', listener);
                 break;
+            /* @conditional-compile-remove(breakout-rooms) */
+            case 'breakoutRoomsUpdated':
+                this.callAdapter.off('breakoutRoomsUpdated', listener);
+                break;
             default:
                 throw `Unknown AzureCommunicationCallWithChatAdapter Event: ${event}`;
         }
@@ -748,8 +925,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) => {
@@ -790,17 +967,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;
@@ -837,11 +1014,15 @@ 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;
     }
 });
@@ -859,7 +1040,26 @@ export const createAzureCommunicationCallWithChatAdapter = (_a) => __awaiter(voi
  *
  * @public
  */
-export const useAzureCommunicationCallWithChatAdapter = (args, afterCreate, beforeDispose) => {
+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, alternateCallerId, callAdapterOptions } = args;
     // State update needed to rerender the parent component when a new adapter is created.
     const [adapter, setAdapter] = useState(undefined);
@@ -914,7 +1114,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,
+        alternateCallerId,
+        beforeDisposeRef,
+        credential,
+        displayName,
+        endpoint,
+        locator,
+        userId,
+        callAdapterOptions
+    ]);
     // Dispose any existing adapter when the component unmounts.
     useEffect(() => {
         return () => {