@azure/communication-react 1.14.1-alpha-202403290012 → 1.14.1-alpha-202404020012

package/dist/communication-react.d.ts

@@ -150,38 +150,6 @@ export declare interface ActiveErrorMessage {
     timestamp?: Date;
 }
 
-/**
- * Attributes required for SendBox to show attachment uploads like name, progress etc.
- * @beta
- */
-export declare interface ActiveFileUpload {
-    /**
-     * Unique identifier for the file upload.
-     */
-    id: string;
-    /**
-     * File name to be rendered for uploaded file.
-     */
-    filename: string;
-    /**
-     * A number between 0 and 1 indicating the progress of the upload.
-     * This is unrelated to the `uploadComplete` property.
-     * It is only used to show the progress of the upload.
-     * Progress of 1 doesn't mark the upload as complete, set the `uploadComplete`
-     * property to true to mark the upload as complete.
-     */
-    progress: number;
-    /**
-     * Error to be displayed to the user if the upload fails.
-     */
-    error?: SendBoxErrorBarError;
-    /**
-     * `true` means that the upload is completed.
-     * This is independent of the upload `progress`.
-     */
-    uploadComplete?: boolean;
-}
-
 /**
  * Error reported via error events and stored in adapter state.
  *
@@ -300,7 +268,7 @@ export declare interface AttachmentMetadata {
     /**
      * A object contains status message would be shown to the user.
      */
-    uploadStatus?: AttachmentUploadStatus;
+    uploadError?: AttachmentUploadStatus;
 }
 
 /**
@@ -315,7 +283,20 @@ export declare interface AttachmentOptions {
 
 /**
  * @beta
- * A callback function for handling file uploads.
+ */
+export declare interface AttachmentUploadAdapter {
+    registerActiveUploads: (files: File[]) => AttachmentUploadManager[];
+    registerCompletedUploads: (metadata: AttachmentMetadata[]) => AttachmentUploadManager[];
+    clearUploads: () => void;
+    cancelUpload: (id: string) => void;
+    updateUploadProgress: (id: string, progress: number) => void;
+    updateUploadStatusMessage: (id: string, errorMessage: string) => void;
+    updateUploadMetadata: (id: string, metadata: AttachmentMetadata) => void;
+}
+
+/**
+ * @beta
+ * A callback function for handling attachment uploads.
  *
  * @param AttachmentUploads - The list of uploaded files. Each file is represented by an {@link AttachmentUpload} object.
  */
@@ -323,13 +304,13 @@ export declare type AttachmentUploadHandler = (attachmentUploads: AttachmentUplo
 
 /**
  * A wrapper object for a file that is being uploaded.
- * Allows managing file uploads by providing common functions for updating the
+ * Allows managing attachment uploads by providing common functions for updating the
  * upload progress, canceling an upload, completing an upload etc.
  * @beta
  */
 export declare interface AttachmentUploadManager {
     /**
-     * Unique identifier for the file upload.
+     * Unique identifier for the attachment upload.
      */
     id: string;
     /**
@@ -337,21 +318,22 @@ export declare interface AttachmentUploadManager {
      */
     file?: File;
     /**
-     * Update the progress of the upload.
+     * Update the progress of the upload changed.
+     * A upload is considered complete when the progress reaches 1.
      * @param value - number between 0 and 1
      */
-    notifyUploadProgressChanged: (value: number) => void;
+    notifyProgressChanged: (value: number) => void;
     /**
      * Mark the upload as complete.
      * Requires the `metadata` param containing uploaded file information.
      * @param metadata - {@link AttachmentMetadata}
      */
-    notifyUploadCompleted: (metadata: AttachmentMetadata) => void;
+    notifyCompleted: (metadata: AttachmentMetadata) => void;
     /**
      * Mark the upload as failed.
      * @param message - An error message that can be displayed to the user.
      */
-    notifyUploadFailed: (message: string) => void;
+    notifyFailed: (message: string) => void;
 }
 
 /**
@@ -359,21 +341,22 @@ export declare interface AttachmentUploadManager {
  */
 export declare interface AttachmentUploadOptions {
     /**
-     * A string containing the comma separated list of accepted file types.
+     * A list of strings containing the comma separated list of supported media (aka. mime) types.
+     * i.e. ['image/*', 'video/*', 'audio/*']
+     * Default value is `['*']`, meaning all media types are supported.
      * Similar to the `accept` attribute of the `<input type="file" />` element.
-     * Accepts any type of file if not specified.
      * @beta
      */
     supportedMediaTypes?: string[];
     /**
-     * Allows multiple files to be selected if set to `true`.
+     * Disable multiple files to be selected if set to `true`.
+     * Default value is `false`, meaning multiple files can be selected.
      * Similar to the `multiple` attribute of the `<input type="file" />` element.
-     * @defaultValue false
      * @beta
      */
     disableMultipleUploads?: boolean;
     /**
-     * A function of type {@link AttachmentUploadHandler} for handling file uploads.
+     * A function of type {@link AttachmentUploadHandler} for handling attachment uploads.
      * @beta
      */
     handler: AttachmentUploadHandler;
@@ -389,6 +372,12 @@ export declare interface AttachmentUploadStatus {
     timestamp: number;
 }
 
+/**
+ * A record containing {@link AttachmentMetadata} mapped to unique ids.
+ * @beta
+ */
+export declare type AttachmentUploadsUiState = Record<string, AttachmentMetadata>;
+
 /**
  * Custom data attributes for displaying avatar for a user.
  *
@@ -2583,6 +2572,30 @@ export declare interface CallCompositeStrings {
      * Tooltip for button to exit spotlight
      */
     exitSpotlightButtonTooltip: string;
+    /**
+     * Label for confirm button in hang up confirm dialog
+     */
+    hangUpConfirmButtonLabel?: string;
+    /**
+     * Label for cancel button in hang up confirm dialog
+     */
+    hangUpCancelButtonLabel?: string;
+    /**
+     * Title of confirm dialog when leaving
+     */
+    leaveConfirmDialogTitle?: string;
+    /**
+     * Content of confirm dialog when leaving
+     */
+    leaveConfirmDialogContent?: string;
+    /**
+     * Title of confirm dialog when leaving
+     */
+    endCallConfirmDialogTitle?: string;
+    /**
+     * Content of confirm dialog when leaving
+     */
+    endCallConfirmDialogContent?: string;
     /**
      * Error message when the meeting identifier or passcode is invalid
      */
@@ -2902,7 +2915,7 @@ export declare interface CallState {
     /**
      * Proxy of {@link @azure/communication-calling#PPTLiveCallFeature}.
      *
-     *@public
+     *@beta
      */
     pptLive: PPTLiveCallFeatureState;
     /**
@@ -2934,7 +2947,7 @@ export declare interface CallState {
      *
      * This property is added by the stateful layer and is not a proxy of SDK state
      *
-     *@public
+     *@beta
      */
     contentSharingRemoteParticipant?: string;
     /**
@@ -3299,19 +3312,19 @@ export declare interface CallWithChatAdapterManagement {
      */
     loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>;
     /** @beta */
-    registerActiveFileUploads: (files: File[]) => FileUploadManager[];
+    registerActiveUploads: (files: File[]) => AttachmentUploadManager[];
     /** @beta */
-    registerCompletedFileUploads: (metadata: AttachmentMetadata[]) => FileUploadManager[];
+    registerCompletedUploads: (metadata: AttachmentMetadata[]) => AttachmentUploadManager[];
     /** @beta */
-    clearFileUploads: () => void;
+    clearUploads: () => void;
     /** @beta */
-    cancelFileUpload: (id: string) => void;
+    cancelUpload: (id: string) => void;
     /** @beta */
-    updateFileUploadProgress: (id: string, progress: number) => void;
+    updateUploadProgress: (id: string, progress: number) => void;
     /** @beta */
-    updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
+    updateUploadStatusMessage: (id: string, errorMessage: string) => void;
     /** @beta */
-    updateFileUploadMetadata: (id: string, metadata: AttachmentMetadata) => void;
+    updateUploadMetadata: (id: string, metadata: AttachmentMetadata) => void;
     /** @public */
     downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>;
     /** @public */
@@ -3497,11 +3510,11 @@ export declare interface CallWithChatAdapterUiState {
     /**
      * Files being uploaded by a user in the current thread.
      * Should be set to null once the upload is complete.
-     * Array of type {@link FileUploadsUiState}
+     * Array of type {@link AttachmentUploadsUiState}
      *
      * @beta
      */
-    fileUploads?: FileUploadsUiState;
+    attachmentUploads?: AttachmentUploadsUiState;
     /**
      * State to track whether the end user has opted in to using a
      * out of date version of a supported browser. Allows the user
@@ -3657,7 +3670,7 @@ export declare type CallWithChatCompositeOptions = {
      * If undefined, file sharing feature will be disabled.
      * @beta
      */
-    fileSharing?: FileSharingOptions;
+    attachmentOptions?: AttachmentOptions;
     /**
      * Device permissions check options for your call.
      * Here you can choose what device permissions you prompt the user for,
@@ -4448,7 +4461,7 @@ export declare type CaptionsReceivedListener = (event: {
  *
  * @public
  */
-export declare type ChatAdapter = ChatAdapterThreadManagement & AdapterState<ChatAdapterState> & Disposable_2 & ChatAdapterSubscribers & FileUploadAdapter;
+export declare type ChatAdapter = ChatAdapterThreadManagement & AdapterState<ChatAdapterState> & Disposable_2 & ChatAdapterSubscribers & AttachmentUploadAdapter;
 
 /**
  * {@link ChatAdapter} state.
@@ -4607,10 +4620,10 @@ export declare type ChatAdapterUiState = {
     /**
      * Files being uploaded by a user in the current thread.
      * Should be set to null once the upload is complete.
-     * Array of type {@link FileUploadsUiState}
+     * Array of type {@link AttachmentUploadsUiState}
      * @beta
      */
-    fileUploads?: FileUploadsUiState;
+    attachmentUploads?: AttachmentUploadsUiState;
 };
 
 /**
@@ -4756,7 +4769,7 @@ export declare type ChatCompositeOptions = {
      * If undefined, file sharing feature will be disabled.
      * @beta
      */
-    fileSharing?: FileSharingOptions;
+    attachmentOptions?: AttachmentOptions;
     /**
      * Properties for configuring the richTextEditor feature.
      * @defaultValue false
@@ -5140,7 +5153,13 @@ export declare type CommonCallControlOptions = {
      * Show or Hide EndCall button during a call.
      * @defaultValue true
      */
-    endCallButton?: boolean;
+    endCallButton?: boolean | /* @conditional-compile-remove(end-call-options) */ {
+        /**
+         * whether to make end call button to trigger a menu, which will enable end call for everybody functionality.
+         * @defaultValue false
+         */
+        hangUpForEveryone?: false | 'endCallOptions';
+    };
     /**
      * Show or Hide Microphone button during a call.
      * @defaultValue true
@@ -6600,6 +6619,13 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     RichTextTableDeleteMenuIcon: React_2.JSX.Element;
 };
 
+/**
+ * @beta
+ *
+ * The default menu action for downloading attachments. This action will open the attachment's URL in a new tab.
+ */
+export declare const defaultAttachmentMenuAction: AttachmentMenuAction;
+
 /**
  * Device Checks.
  * Choose whether or not to block starting a call depending on camera and microphone permission options.
@@ -6988,7 +7014,12 @@ export declare interface EndCallButtonProps extends ControlBarButtonProps {
      * Utility property for using this component with `communication react eventHandlers`.
      * Maps directly to the `onClick` property.
      */
-    onHangUp?: () => Promise<void>;
+    onHangUp?: (forEveryone?: boolean) => Promise<void>;
+    /**
+     * Set this to true to make it a split button.
+     * The split arrow will trigger a contextual menu to allow end for everyone or just for the user.
+     */
+    enableEndCallMenu?: boolean;
     /**
      * Optional strings to override in component
      */
@@ -7007,6 +7038,10 @@ export declare interface EndCallButtonStrings {
     label: string;
     /** Tooltip content. */
     tooltipContent?: string;
+    /** Label for leave option when ending call */
+    leaveOption?: string;
+    /** Label for end the whole call option when ending call */
+    endCallOption?: string;
 }
 
 /**
@@ -7217,134 +7252,6 @@ export declare interface ErrorBarStrings {
  */
 export declare type ErrorType = keyof ErrorBarStrings;
 
-/**
- * Properties for configuring the File Sharing feature.
- * @beta
- */
-export declare interface FileSharingOptions {
-    /**
-     * A string containing the comma separated list of accepted file types.
-     * Similar to the `accept` attribute of the `<input type="file" />` element.
-     * Accepts any type of file if not specified.
-     * @beta
-     */
-    accept?: string;
-    /**
-     * Allows multiple files to be selected if set to `true`.
-     * Similar to the `multiple` attribute of the `<input type="file" />` element.
-     * @defaultValue false
-     * @beta
-     */
-    multiple?: boolean;
-    /**
-     * A function of type {@link FileUploadHandler} for handling file uploads.
-     * @beta
-     */
-    uploadHandler: FileUploadHandler;
-    /**
-     * A temp function until this interface is deprecated
-     */
-    actionsForAttachment?: (attachment: AttachmentMetadata, message?: ChatMessage) => AttachmentMenuAction[];
-}
-
-/**
- * @beta
- */
-export declare interface FileUploadAdapter {
-    registerActiveFileUploads: (files: File[]) => FileUploadManager[];
-    registerCompletedFileUploads: (metadata: AttachmentMetadata[]) => FileUploadManager[];
-    clearFileUploads: () => void;
-    cancelFileUpload: (id: string) => void;
-    updateFileUploadProgress: (id: string, progress: number) => void;
-    updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
-    updateFileUploadMetadata: (id: string, metadata: AttachmentMetadata) => void;
-}
-
-/**
- * @beta
- * Error message to be displayed to the user if the upload fails.
- */
-export declare type FileUploadError = {
-    message: string;
-    timestamp: number;
-};
-
-/**
- * @beta
- * A callback function for handling file uploads.
- *
- * @param userId - The user ID of the user uploading the file.
- * @param fileUploads - The list of uploaded files. Each file is represented by an {@link FileUpload} object.
- */
-export declare type FileUploadHandler = (userId: string, fileUploads: FileUploadManager[]) => void;
-
-/**
- * A wrapper object for a file that is being uploaded.
- * Allows managing file uploads by providing common functions for updating the
- * upload progress, canceling an upload, completing an upload etc.
- * @beta
- */
-export declare interface FileUploadManager {
-    /**
-     * Unique identifier for the file upload.
-     */
-    id: string;
-    /**
-     * HTML {@link File} object for the uploaded file.
-     */
-    file?: File;
-    /**
-     * Update the progress of the upload.
-     * @param value - number between 0 and 1
-     */
-    notifyUploadProgressChanged: (value: number) => void;
-    /**
-     * Mark the upload as complete.
-     * Requires the `metadata` param containing uploaded file information.
-     * @param metadata - {@link AttachmentMetadata}
-     */
-    notifyUploadCompleted: (metadata: AttachmentMetadata) => void;
-    /**
-     * Mark the upload as failed.
-     * @param message - An error message that can be displayed to the user.
-     */
-    notifyUploadFailed: (message: string) => void;
-}
-
-/**
- * Contains the state attributes of a file upload like name, progress etc.
- * @beta
- */
-export declare interface FileUploadState {
-    /**
-     * Unique identifier for the file upload.
-     */
-    id: string;
-    /**
-     * Filename extracted from the {@link File} object.
-     * This attribute is used to render the filename if `metadata.name` is not available.
-     */
-    filename: string;
-    /**
-     * A number between 0 and 1 indicating the progress of the upload.
-     */
-    progress: number;
-    /**
-     * Metadata {@link AttachmentMetadata} containing information about the uploaded file.
-     */
-    metadata?: AttachmentMetadata;
-    /**
-     * Error message to be displayed to the user if the upload fails.
-     */
-    error?: FileUploadError;
-}
-
-/**
- * A record containing {@link FileUploadState} mapped to unique ids.
- * @beta
- */
-export declare type FileUploadsUiState = Record<string, FileUploadState>;
-
 /**
  * Provider to apply a Fluent theme across this library's react components.
  *
@@ -9264,7 +9171,7 @@ export declare type ParticipantState = 'Idle' | 'Connecting' | 'Ringing' | 'Conn
  * State only version of {@link @azure/communication-calling#PPTLiveCallFeature}. {@link StatefulCallClient} will
  * automatically listen for pptLive on the call and update the state exposed by {@link StatefulCallClient} accordingly.
  *
- * @public
+ * @beta
  */
 export declare interface PPTLiveCallFeatureState {
     /**
@@ -9428,10 +9335,10 @@ export declare interface ReactionButtonStrings {
     likeReactionTooltipContent?: string;
     /** Tooltip content of heart reaction button. */
     heartReactionTooltipContent?: string;
-    /** Tooltip content of laugh reaction button. */
-    laughReactionTooltipContent?: string;
     /** Tooltip content of clap reaction button. */
     applauseReactionTooltipContent?: string;
+    /** Tooltip content of laugh reaction button. */
+    laughReactionTooltipContent?: string;
     /** Tooltip content of surprised reaction button. */
     surprisedReactionTooltipContent?: string;
 }
@@ -9582,7 +9489,7 @@ export declare interface RemoteParticipantState {
     /**
      * Proxy of {@link @azure/communication-calling#Call.PPTLive.target}.
      *
-     * @public
+     * @beta
      */
     contentSharingStream?: HTMLElement;
     /**
@@ -9704,17 +9611,17 @@ export declare interface RichTextSendBoxProps {
      */
     systemMessage?: string;
     /**
-     * Optional array of active file uploads where each object has attributes
-     * of a file upload like name, progress, errorMessage etc.
+     * Optional array of active attachment uploads where each object has attributes
+     * of a attachment upload like name, progress, errorMessage etc.
      * @beta
      */
-    activeFileUploads?: ActiveFileUpload[];
+    activeAttachmentUploads?: AttachmentMetadata[];
     /**
-     * Optional callback to remove the file upload before sending by clicking on
+     * Optional callback to remove the attachment upload before sending by clicking on
      * cancel icon.
      * @beta
      */
-    onCancelFileUpload?: (fileId: string) => void;
+    onCancelAttachmentUpload?: (fileId: string) => void;
     /**
      * Callback function used when the send button is clicked.
      */
@@ -9951,23 +9858,23 @@ export declare interface SendBoxProps {
     autoFocus?: 'sendBoxTextField';
     /**
      * Optional callback to render uploaded files in the SendBox. The sendBox will expand
-     * vertically to accommodate the uploaded files. File uploads will
+     * vertically to accommodate the uploaded files. Attachment uploads will
      * be rendered below the text area in sendBox.
      * @beta
      */
-    onRenderFileUploads?: () => JSX.Element;
+    onRenderAttachmentUploads?: () => JSX.Element;
     /**
      * Optional array of active attachment uploads where each object has attributes
      * of a attachment upload like name, progress, errorMessage etc.
      * @beta
      */
-    activeFileUploads?: ActiveFileUpload[];
+    activeAttachmentUploads?: AttachmentMetadata[];
     /**
      * Optional callback to remove the attachment upload before sending by clicking on
      * cancel icon.
      * @beta
      */
-    onCancelFileUpload?: (fileId: string) => void;
+    onCancelAttachmentUpload?: (fileId: string) => void;
 }
 
 /**

package/dist/dist-cjs/communication-react/{RichTextSendBoxWrapper-CH6WvEGZ.js → RichTextSendBoxWrapper-BTyywbnH.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 var React = require('react');
-var index = require('./index-qxnuqL7s.js');
+var index = require('./index-Bj9ORqhl.js');
 require('@fluentui/react');
 require('@fluentui/react-components');
 require('@fluentui-contrib/react-chat');
@@ -51,4 +51,4 @@ const RichTextSendBoxWrapper = () => {
 };
 
 exports.RichTextSendBoxWrapper = RichTextSendBoxWrapper;
-//# sourceMappingURL=RichTextSendBoxWrapper-CH6WvEGZ.js.map
+//# sourceMappingURL=RichTextSendBoxWrapper-BTyywbnH.js.map

package/dist/dist-cjs/communication-react/{RichTextSendBoxWrapper-CH6WvEGZ.js.map → RichTextSendBoxWrapper-BTyywbnH.js.map}

@@ -1 +1 @@
-{"version":3,"file":"RichTextSendBoxWrapper-CH6WvEGZ.js","sources":["../../../../react-composites/src/composites/common/RichTextSendBoxWrapper.tsx"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/* @conditional-compile-remove(rich-text-editor) */\nimport React from 'react';\n/* @conditional-compile-remove(rich-text-editor) */\nimport { usePropsFor } from '../ChatComposite/hooks/usePropsFor';\n/* @conditional-compile-remove(rich-text-editor) */\nimport { RichTextSendBox } from '@internal/react-components';\n\n/* @conditional-compile-remove(rich-text-editor) */\n/**\n * @private\n *\n * Wrapper for RichTextSendBox component to allow us to use usePropsFor with richTextSendBox\n * before lazyLoading is done\n */\nexport const RichTextSendBoxWrapper = (): JSX.Element => {\n  const richTextSendBoxProps = usePropsFor(RichTextSendBox);\n\n  return <RichTextSendBox {...richTextSendBoxProps} />;\n};\n"],"names":["usePropsFor","RichTextSendBox"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAEA;AAOA;AACA;;;;;AAKG;AACI,MAAM,sBAAsB,GAAG,MAAkB;AACtD,IAAA,MAAM,oBAAoB,GAAGA,iBAAW,CAACC,qBAAe,CAAC,CAAC;AAE1D,IAAA,OAAO,KAAC,CAAA,aAAA,CAAAA,qBAAe,EAAK,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,oBAAoB,EAAI,CAAC;AACvD;;;;"}
+{"version":3,"file":"RichTextSendBoxWrapper-BTyywbnH.js","sources":["../../../../react-composites/src/composites/common/RichTextSendBoxWrapper.tsx"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/* @conditional-compile-remove(rich-text-editor) */\nimport React from 'react';\n/* @conditional-compile-remove(rich-text-editor) */\nimport { usePropsFor } from '../ChatComposite/hooks/usePropsFor';\n/* @conditional-compile-remove(rich-text-editor) */\nimport { RichTextSendBox } from '@internal/react-components';\n\n/* @conditional-compile-remove(rich-text-editor) */\n/**\n * @private\n *\n * Wrapper for RichTextSendBox component to allow us to use usePropsFor with richTextSendBox\n * before lazyLoading is done\n */\nexport const RichTextSendBoxWrapper = (): JSX.Element => {\n  const richTextSendBoxProps = usePropsFor(RichTextSendBox);\n\n  return <RichTextSendBox {...richTextSendBoxProps} />;\n};\n"],"names":["usePropsFor","RichTextSendBox"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAEA;AAOA;AACA;;;;;AAKG;AACI,MAAM,sBAAsB,GAAG,MAAkB;AACtD,IAAA,MAAM,oBAAoB,GAAGA,iBAAW,CAACC,qBAAe,CAAC,CAAC;AAE1D,IAAA,OAAO,KAAC,CAAA,aAAA,CAAAA,qBAAe,EAAK,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,oBAAoB,EAAI,CAAC;AACvD;;;;"}