@azure/communication-react 1.10.0 → 1.10.1-alpha-202311110012

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

@@ -1,12 +1,19 @@
 import { AudioDeviceInfo, Call, CallAgent, GroupCallLocator, PermissionConstraints, PropertyChangedEvent, TeamsMeetingLinkLocator, StartCallOptions, VideoDeviceInfo } from '@azure/communication-calling';
 import { StartCaptionsOptions } from '@azure/communication-calling';
+import { AddPhoneNumberOptions, DtmfTone } from '@azure/communication-calling';
 import { CreateVideoStreamViewResult, VideoStreamOptions } from "../../../../../react-components/src";
+import { AttachmentDownloadResult } from "../../../../../react-components/src";
+import { FileMetadata } from "../../../../../react-components/src";
 import { ParticipantsJoinedListener, ParticipantsLeftListener, IsMutedChangedListener, CallIdChangedListener, IsLocalScreenSharingActiveChangedListener, DisplayNameChangedListener, IsSpeakingChangedListener, CallAdapter, CallEndedListener } from '../../CallComposite';
 import { MessageReceivedListener, MessageReadListener, ChatAdapter, ParticipantsRemovedListener, ParticipantsAddedListener } from '../../ChatComposite';
+import { FileUploadManager } from '../../ChatComposite';
 import { CallWithChatAdapter } from './CallWithChatAdapter';
 import { CallWithChatAdapterState } from '../state/CallWithChatAdapterState';
+import { AzureCommunicationChatAdapterOptions } from '../../ChatComposite/adapter/AzureCommunicationChatAdapter';
 import { CommunicationTokenCredential, CommunicationUserIdentifier } from '@azure/communication-common';
+import { CommunicationIdentifier, PhoneNumberIdentifier } from '@azure/communication-common';
 import { AdapterError } from '../../common/adapters';
+import { CallParticipantsLocator } from '../../CallComposite/adapter/AzureCommunicationCallAdapter';
 import { CallAdapterLocator } from '../../CallComposite/adapter/AzureCommunicationCallAdapter';
 import { StatefulCallClient } from "../../../../../calling-stateful-client/src";
 import { StatefulChatClient } from "../../../../../chat-stateful-client/src";
@@ -33,7 +40,7 @@ export declare class AzureCommunicationCallWithChatAdapter implements CallWithCh
     /** Leave current Call. */
     leaveCall(forEveryone?: boolean): Promise<void>;
     /** Start a new Call. */
-    startCall(participants: string[], options?: StartCallOptions): Call | undefined;
+    startCall(participants: string[] | /* @conditional-compile-remove(PSTN-calls) */ CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
     /**
      * Subscribe to state change events.
      * @param handler - handler to be called when the state changes. This is passed the new state.
@@ -49,7 +56,7 @@ export declare class AzureCommunicationCallWithChatAdapter implements CallWithCh
     /** Dispose of the current CallWithChatAdapter. */
     dispose(): void;
     /** Remove a participant from the Call only. */
-    removeParticipant(userId: string): Promise<void>;
+    removeParticipant(userId: string | /* @conditional-compile-remove(PSTN-calls) */ CommunicationIdentifier): Promise<void>;
     setCamera(device: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>;
     /** Set the microphone to be used in the Call. */
     setMicrophone(device: AudioDeviceInfo): Promise<void>;
@@ -99,9 +106,27 @@ export declare class AzureCommunicationCallWithChatAdapter implements CallWithCh
     /** Load previous Chat messages. */
     loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>;
     /** Update an existing message. */
-    updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>;
+    updateMessage(messageId: string, content: string, metadata?: Record<string, string>, options?: {
+        attachedFilesMetadata?: FileMetadata[];
+    }): Promise<void>;
     /** Delete an existing message. */
     deleteMessage(messageId: string): Promise<void>;
+    registerActiveFileUploads: (files: File[]) => FileUploadManager[];
+    registerCompletedFileUploads: (metadata: FileMetadata[]) => FileUploadManager[];
+    clearFileUploads: () => void;
+    cancelFileUpload: (id: string) => void;
+    updateFileUploadProgress: (id: string, progress: number) => void;
+    updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
+    updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
+    downloadAttachments(options: {
+        attachmentUrls: Record<string, string>;
+    }): Promise<AttachmentDownloadResult[]>;
+    holdCall(): Promise<void>;
+    resumeCall(): Promise<void>;
+    addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>;
+    addParticipant(participant: CommunicationUserIdentifier): Promise<void>;
+    sendDtmfTone(dtmfTone: DtmfTone): Promise<void>;
+    allowUnsupportedBrowserVersion(): void;
     startCaptions(options?: StartCaptionsOptions): Promise<void>;
     stopCaptions(): Promise<void>;
     setCaptionLanguage(language: string): Promise<void>;
@@ -162,7 +187,7 @@ export declare class AzureCommunicationCallWithChatAdapter implements CallWithCh
  */
 export interface CallAndChatLocator {
     /** Locator used by {@link createAzureCommunicationCallWithChatAdapter} to locate the call to join */
-    callLocator: GroupCallLocator;
+    callLocator: GroupCallLocator | /* @conditional-compile-remove(teams-adhoc-call) */ CallParticipantsLocator;
     /** Chat thread ID used by {@link createAzureCommunicationCallWithChatAdapter} to locate the chat thread to join */
     chatThreadId: string;
 }
@@ -177,6 +202,7 @@ export declare type AzureCommunicationCallWithChatAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAndChatLocator | TeamsMeetingLinkLocator;
+    alternateCallerId?: string;
     callAdapterOptions?: AzureCommunicationCallAdapterOptions;
 };
 /**
@@ -185,7 +211,7 @@ export declare type AzureCommunicationCallWithChatAdapterArgs = {
  *
  * @public
  */
-export declare const createAzureCommunicationCallWithChatAdapter: ({ userId, displayName, credential, endpoint, locator, callAdapterOptions }: AzureCommunicationCallWithChatAdapterArgs) => Promise<CallWithChatAdapter>;
+export declare const createAzureCommunicationCallWithChatAdapter: ({ userId, displayName, credential, endpoint, locator, alternateCallerId, callAdapterOptions }: AzureCommunicationCallWithChatAdapterArgs) => Promise<CallWithChatAdapter>;
 /**
  * A custom React hook to simplify the creation of {@link CallWithChatAdapter}.
  *
@@ -213,6 +239,7 @@ export declare type AzureCommunicationCallWithChatAdapterFromClientArgs = {
     chatClient: StatefulChatClient;
     chatThreadClient: ChatThreadClient;
     callAdapterOptions?: AzureCommunicationCallAdapterOptions;
+    chatAdapterOptions?: AzureCommunicationChatAdapterOptions;
 };
 /**
  * Create a {@link CallWithChatAdapter} using the provided {@link StatefulChatClient} and {@link StatefulCallClient}.
@@ -223,7 +250,7 @@ export declare type AzureCommunicationCallWithChatAdapterFromClientArgs = {
  *
  * @public
  */
-export declare const createAzureCommunicationCallWithChatAdapterFromClients: ({ callClient, callAgent, callLocator, chatClient, chatThreadClient, callAdapterOptions }: AzureCommunicationCallWithChatAdapterFromClientArgs) => Promise<CallWithChatAdapter>;
+export declare const createAzureCommunicationCallWithChatAdapterFromClients: ({ callClient, callAgent, callLocator, chatClient, chatThreadClient, callAdapterOptions, chatAdapterOptions }: AzureCommunicationCallWithChatAdapterFromClientArgs) => Promise<CallWithChatAdapter>;
 /**
  * Create a {@link CallWithChatAdapter} from the underlying adapters.
  *

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

@@ -13,9 +13,12 @@ import { createAzureCommunicationCallAdapter } from '../../CallComposite';
 import { callWithChatAdapterStateFromBackingStates, mergeCallAdapterStateIntoCallWithChatAdapterState, mergeChatAdapterStateIntoCallWithChatAdapterState } from '../state/CallWithChatAdapterState';
 import { createAzureCommunicationChatAdapter, 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 { createAzureCommunicationCallAdapterFromClient } from '../../CallComposite/adapter/AzureCommunicationCallAdapter';
 import { useEffect, useRef, useState } from 'react';
+import { _toCommunicationIdentifier } from "../../../../../acs-ui-common/src";
 /** Context of Call with Chat, which is a centralized context for all state updates */
 class CallWithChatContext {
     constructor(clientState, maxListeners = 50) {
@@ -52,6 +55,34 @@ class CallWithChatContext {
  */
 export class AzureCommunicationCallWithChatAdapter {
     constructor(callAdapter, chatAdapter) {
+        /* @conditional-compile-remove(file-sharing) */
+        this.registerActiveFileUploads = (files) => {
+            return this.chatAdapter.registerActiveFileUploads(files);
+        };
+        /* @conditional-compile-remove(file-sharing) */
+        this.registerCompletedFileUploads = (metadata) => {
+            return this.chatAdapter.registerCompletedFileUploads(metadata);
+        };
+        /* @conditional-compile-remove(file-sharing) */
+        this.clearFileUploads = () => {
+            this.chatAdapter.clearFileUploads();
+        };
+        /* @conditional-compile-remove(file-sharing) */
+        this.cancelFileUpload = (id) => {
+            this.chatAdapter.cancelFileUpload(id);
+        };
+        /* @conditional-compile-remove(file-sharing) */
+        this.updateFileUploadProgress = (id, progress) => {
+            this.chatAdapter.updateFileUploadProgress(id, progress);
+        };
+        /* @conditional-compile-remove(file-sharing) */
+        this.updateFileUploadErrorMessage = (id, errorMessage) => {
+            this.chatAdapter.updateFileUploadErrorMessage(id, errorMessage);
+        };
+        /* @conditional-compile-remove(file-sharing) */
+        this.updateFileUploadMetadata = (id, metadata) => {
+            this.chatAdapter.updateFileUploadMetadata(id, metadata);
+        };
         this.bindPublicMethods();
         this.callAdapter = callAdapter;
         this.chatAdapter = chatAdapter;
@@ -105,6 +136,32 @@ export class AzureCommunicationCallWithChatAdapter {
         this.deleteMessage.bind(this);
         this.on.bind(this);
         this.off.bind(this);
+        /* @conditional-compile-remove(file-sharing) */
+        this.registerActiveFileUploads = this.registerActiveFileUploads.bind(this);
+        /* @conditional-compile-remove(file-sharing) */
+        this.registerCompletedFileUploads = this.registerCompletedFileUploads.bind(this);
+        /* @conditional-compile-remove(file-sharing) */
+        this.clearFileUploads = this.clearFileUploads.bind(this);
+        /* @conditional-compile-remove(file-sharing) */
+        this.cancelFileUpload = this.cancelFileUpload.bind(this);
+        /* @conditional-compile-remove(file-sharing) */
+        this.updateFileUploadProgress = this.updateFileUploadProgress.bind(this);
+        /* @conditional-compile-remove(file-sharing) */
+        this.updateFileUploadErrorMessage = this.updateFileUploadErrorMessage.bind(this);
+        /* @conditional-compile-remove(file-sharing) */
+        this.updateFileUploadMetadata = this.updateFileUploadMetadata.bind(this);
+        /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
+        this.downloadAttachments = this.downloadAttachments.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);
+        /* @conditional-compile-remove(PSTN-calls) */
+        this.sendDtmfTone.bind(this);
+        /* @conditional-compile-remove(unsupported-browser) */
+        this.allowUnsupportedBrowserVersion.bind(this);
         /* @conditional-compile-remove(close-captions) */ {
             this.startCaptions.bind(this);
             this.stopCaptions.bind(this);
@@ -137,6 +194,8 @@ export class AzureCommunicationCallWithChatAdapter {
     /** Start a new Call. */
     startCall(participants, options) {
         let communicationParticipants = participants;
+        /* @conditional-compile-remove(PSTN-calls) */
+        communicationParticipants = participants.map(_toCommunicationIdentifier);
         return this.callAdapter.startCall(communicationParticipants, options);
     }
     /**
@@ -168,6 +227,8 @@ 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);
         });
     }
@@ -322,9 +383,10 @@ export class AzureCommunicationCallWithChatAdapter {
         });
     }
     /** Update an existing message. */
-    updateMessage(messageId, content, metadata) {
+    updateMessage(messageId, content, metadata, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.chatAdapter.updateMessage(messageId, content, metadata);
+            return yield this.chatAdapter.updateMessage(messageId, content, metadata, 
+            /* @conditional-compile-remove(file-sharing) */ options);
         });
     }
     /** Delete an existing message. */
@@ -333,6 +395,45 @@ export class AzureCommunicationCallWithChatAdapter {
             return yield this.chatAdapter.deleteMessage(messageId);
         });
     }
+    /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
+    downloadAttachments(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.chatAdapter.downloadAttachments(options);
+        });
+    }
+    /* @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)) {
+                return yield this.callAdapter.addParticipant(participant);
+            }
+            else {
+                return yield this.callAdapter.addParticipant(participant, options);
+            }
+        });
+    }
+    /* @conditional-compile-remove(PSTN-calls) */
+    sendDtmfTone(dtmfTone) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.callAdapter.sendDtmfTone(dtmfTone);
+        });
+    }
+    /* @conditional-compile-remove(unsupported-browser) */
+    allowUnsupportedBrowserVersion() {
+        return this.callAdapter.allowUnsupportedBrowserVersion();
+    }
     /* @conditional-compile-remove(close-captions) */
     startCaptions(options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -533,6 +634,7 @@ export class AzureCommunicationCallWithChatAdapter {
  * @public
  */
 export const createAzureCommunicationCallWithChatAdapter = ({ userId, displayName, credential, endpoint, locator, 
+/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId, 
 /* @conditional-compile-remove(video-background-effects) */ callAdapterOptions }) => __awaiter(void 0, void 0, void 0, function* () {
     const callAdapterLocator = isTeamsMeetingLinkLocator(locator) ? locator : locator.callLocator;
     const createCallAdapterPromise = createAzureCommunicationCallAdapter({
@@ -540,9 +642,12 @@ export const createAzureCommunicationCallWithChatAdapter = ({ userId, displayNam
         displayName,
         credential,
         locator: callAdapterLocator,
+        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
         /* @conditional-compile-remove(video-background-effects) */ options: callAdapterOptions
     });
-    const threadId = isTeamsMeetingLinkLocator(locator) ? getChatThreadFromTeamsLink(locator.meetingLink) : locator.chatThreadId;
+    const threadId = isTeamsMeetingLinkLocator(locator)
+        ? getChatThreadFromTeamsLink(locator.meetingLink)
+        : locator.chatThreadId;
     const createChatAdapterPromise = createAzureCommunicationChatAdapter({
         endpoint,
         userId,
@@ -567,8 +672,28 @@ export const createAzureCommunicationCallWithChatAdapter = ({ userId, displayNam
  *
  * @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, 
+    /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId, 
     /* @conditional-compile-remove(video-background-effects) */ callAdapterOptions } = args;
     // State update needed to rerender the parent component when a new adapter is created.
     const [adapter, setAdapter] = useState(undefined);
@@ -611,6 +736,7 @@ export const useAzureCommunicationCallWithChatAdapter = (args, afterCreate, befo
                 endpoint,
                 locator,
                 userId,
+                /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
                 /* @conditional-compile-remove(video-background-effects) */ callAdapterOptions
             });
             if (afterCreateRef.current) {
@@ -621,7 +747,18 @@ export const useAzureCommunicationCallWithChatAdapter = (args, afterCreate, befo
         }))();
     }, 
     // Explicitly list all arguments so that caller doesn't have to memoize the `args` object.
-    [adapterRef, afterCreateRef, beforeDisposeRef, credential, displayName, endpoint, locator, userId, /* @conditional-compile-remove(video-background-effects) */ callAdapterOptions]);
+    [
+        adapterRef,
+        afterCreateRef,
+        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
+        beforeDisposeRef,
+        credential,
+        displayName,
+        endpoint,
+        locator,
+        userId,
+        /* @conditional-compile-remove(video-background-effects) */ callAdapterOptions
+    ]);
     // Dispose any existing adapter when the component unmounts.
     useEffect(() => {
         return () => {
@@ -649,9 +786,15 @@ export const useAzureCommunicationCallWithChatAdapter = (args, afterCreate, befo
  */
 export const createAzureCommunicationCallWithChatAdapterFromClients = ({ callClient, callAgent, callLocator, chatClient, chatThreadClient, 
 /* @conditional-compile-remove(video-background-effects) */
-callAdapterOptions }) => __awaiter(void 0, void 0, void 0, function* () {
-    const createCallAdapterPromise = createAzureCommunicationCallAdapterFromClient(callClient, callAgent, callLocator, /* @conditional-compile-remove(video-background-effects) */ callAdapterOptions);
-    const createChatAdapterPromise = createAzureCommunicationChatAdapterFromClient(chatClient, chatThreadClient);
+callAdapterOptions, 
+/* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
+chatAdapterOptions }) => __awaiter(void 0, void 0, void 0, function* () {
+    const createCallAdapterPromise = createAzureCommunicationCallAdapterFromClient(callClient, callAgent, callLocator, 
+    /* @conditional-compile-remove(video-background-effects) */
+    callAdapterOptions);
+    const createChatAdapterPromise = createAzureCommunicationChatAdapterFromClient(chatClient, chatThreadClient, 
+    /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
+    chatAdapterOptions);
     const [callAdapter, chatAdapter] = yield Promise.all([createCallAdapterPromise, createChatAdapterPromise]);
     return new AzureCommunicationCallWithChatAdapter(callAdapter, chatAdapter);
 });