@microsoft/teams-js 2.14.0-beta.2 → 2.15.0-beta.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.13.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.14.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.13.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-F9Iwc2j9qTKP1PITJeEV0OOS8NDzEUzrP//Fz0t2gzapTMPvNjhYdQjF0idJOuG3"
+  src="https://res.cdn.office.net/teams-js/2.14.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-+DItxkmrHBjTqyGZe60m2HxjR/eDhdYpaTux8gT9/YqHSMxASoTe+Y66GvNEMT8k"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.13.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.14.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2273,12 +2273,12 @@ export namespace authentication {
         /**
             * Initiates an authentication flow which requires a new window.
             * There are two primary uses for this function:
-            * 1. When your app needs to authenticate using a 3rd-party identity provider (not Azure Active Directory)
-            * 2. When your app needs to show authentication UI that is blocked from being shown in an iframe (e.g., Azure Active Directory consent prompts)
+            * 1. When your app needs to authenticate using a 3rd-party identity provider (not Microsoft Entra ID)
+            * 2. When your app needs to show authentication UI that is blocked from being shown in an iframe (e.g., Microsoft Entra consent prompts)
             *
             * For more details, see [Enable authentication using third-party OAuth provider](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/auth-flow-tab)
             *
-            * This function is *not* needed for "standard" Azure SSO usage. Using {@link getAuthToken} is usually sufficient in that case. For more, see
+            * This function is *not* needed for "standard" Microsoft Entra SSO usage. Using {@link getAuthToken} is usually sufficient in that case. For more, see
             * [Enable SSO for tab apps](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/tab-sso-overview))
             *
             * @remarks
@@ -2311,8 +2311,8 @@ export namespace authentication {
             */
         function authenticate(authenticateParameters?: AuthenticateParameters): void;
         /**
-            * Requests an Azure AD token to be issued on behalf of your app in an SSO flow.
-            * The token is acquired from the cache if it is not expired. Otherwise a request is sent to Azure AD to
+            * Requests an Microsoft Entra token to be issued on behalf of your app in an SSO flow.
+            * The token is acquired from the cache if it is not expired. Otherwise a request is sent to Microsoft Entra to
             * obtain a new token.
             * This function is used to enable SSO scenarios. See [Enable SSO for tab apps](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/tab-sso-overview)
             * for more details.
@@ -2338,7 +2338,7 @@ export namespace authentication {
         function getAuthToken(authTokenRequest?: AuthTokenRequest): void;
         /**
             * @hidden
-            * Requests the decoded Azure AD user identity on behalf of the app.
+            * Requests the decoded Microsoft Entra user identity on behalf of the app.
             *
             * @returns Promise that resolves with the {@link UserProfile}.
             *
@@ -2351,7 +2351,7 @@ export namespace authentication {
             * As of 2.0.0, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
             *
             * @hidden
-            * Requests the decoded Azure AD user identity on behalf of the app.
+            * Requests the decoded Microsoft Entra user identity on behalf of the app.
             *
             * @param userRequest - It passes success/failure callbacks in the userRequest object(deprecated)
             * @internal
@@ -2457,7 +2457,7 @@ export namespace authentication {
                     */
                 resources?: string[];
                 /**
-                    * An optional list of claims which to pass to AAD when requesting the access token.
+                    * An optional list of claims which to pass to Microsoft Entra when requesting the access token.
                     */
                 claims?: string[];
                 /**
@@ -2504,8 +2504,8 @@ export namespace authentication {
                 iat: number;
                 /**
                     * @hidden
-                    * Identifies the security token service (STS) that constructs and returns the token. In the tokens that Azure AD
-                    * returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Azure AD
+                    * Identifies the security token service (STS) that constructs and returns the token. In the tokens that Microsoft Entra
+                    * returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Microsoft Entra
                     * directory. The tenant ID is an immutable and reliable identifier of the directory.
                     *
                     * @internal
@@ -2514,7 +2514,7 @@ export namespace authentication {
                 iss: string;
                 /**
                     * @hidden
-                    * Provides the last name, surname, or family name of the user as defined in the Azure AD user object.
+                    * Provides the last name, surname, or family name of the user as defined in the Microsoft Entra user object.
                     *
                     * @internal
                     * Limited to Microsoft-internal use
@@ -2522,7 +2522,7 @@ export namespace authentication {
                 family_name: string;
                 /**
                     * @hidden
-                    * Provides the first or "given" name of the user, as set on the Azure AD user object.
+                    * Provides the first or "given" name of the user, as set on the Microsoft Entra user object.
                     *
                     * @internal
                     * Limited to Microsoft-internal use
@@ -2539,8 +2539,8 @@ export namespace authentication {
                 unique_name: string;
                 /**
                     * @hidden
-                    * Contains a unique identifier of an object in Azure AD. This value is immutable and cannot be reassigned or
-                    * reused. Use the object ID to identify an object in queries to Azure AD.
+                    * Contains a unique identifier of an object in Microsoft Entra. This value is immutable and cannot be reassigned or
+                    * reused. Use the object ID to identify an object in queries to Microsoft Entra.
                     *
                     * @internal
                     * Limited to Microsoft-internal use
@@ -2550,7 +2550,7 @@ export namespace authentication {
                     * @hidden
                     * Identifies the principal about which the token asserts information, such as the user of an application.
                     * This value is immutable and cannot be reassigned or reused, so it can be used to perform authorization
-                    * checks safely. Because the subject is always present in the tokens the Azure AD issues, we recommended
+                    * checks safely. Because the subject is always present in the tokens the Microsoft Entra issues, we recommended
                     * using this value in a general-purpose authorization system.
                     *
                     * @internal
@@ -2572,7 +2572,7 @@ export namespace authentication {
                     * Defines the end of the time interval within which a token is valid. The service that validates the token
                     * should verify that the current date is within the token lifetime; otherwise it should reject the token. The
                     * service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
-                    * time ("time skew") between Azure AD and the service.
+                    * time ("time skew") between Microsoft Entra and the service.
                     *
                     * @internal
                     * Limited to Microsoft-internal use
@@ -2583,7 +2583,7 @@ export namespace authentication {
                     * Defines the start of the time interval within which a token is valid. The service that validates the token
                     * should verify that the current date is within the token lifetime; otherwise it should reject the token. The
                     * service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
-                    * time ("time skew") between Azure AD and the service.
+                    * time ("time skew") between Microsoft Entra and the service.
                     *
                     * @internal
                     * Limited to Microsoft-internal use
@@ -3165,7 +3165,7 @@ export interface Context {
             * @deprecated
             * As of 2.0.0, please use {@link app.TenantInfo.id | app.Context.user.tenant.id} instead
             *
-            * The Azure AD tenant ID of the current user.
+            * The Microsoft Entra tenant ID of the current user.
             * Because a malicious party can run your content in a browser, this value should
             * be used only as a hint as to who the user is and never as proof of identity.
             * This field is available only when the identity permission is requested in the manifest.
@@ -3224,7 +3224,7 @@ export interface Context {
             * @deprecated
             * As of 2.0.0, please use {@link app.ChannelInfo.ownerGroupId | app.Context.channel.ownerGroupId} instead
             *
-            * The AAD group ID of the host team.
+            * The Microsoft Entra group ID of the host team.
             */
         hostTeamGroupId?: string;
         /**
@@ -3261,7 +3261,7 @@ export interface Context {
             * @deprecated
             * As of 2.0.0, please use {@link app.UserInfo.loginHint | app.Context.user.loginHint} instead
             *
-            * A value suitable for use as a login_hint when authenticating with Azure AD.
+            * A value suitable for use as a login_hint when authenticating with Microsoft Entra ID.
             * Because a malicious party can run your content in a browser, this value should
             * be used only as a hint as to who the user is and never as proof of identity.
             * This field is available only when the identity permission is requested in the manifest.
@@ -3281,7 +3281,7 @@ export interface Context {
             * @deprecated
             * As of 2.0.0, please use {@link app.UserInfo.id | app.Context.user.id} instead
             *
-            * The Azure AD object id of the current user.
+            * The Microsoft Entra object ID of the current user.
             * Because a malicious party run your content in a browser, this value should
             * be used only as a hint as to who the user is and never as proof of identity.
             * This field is available only when the identity permission is requested in the manifest.
@@ -3930,7 +3930,7 @@ export namespace app {
                     */
                 ownerTenantId?: string;
                 /**
-                    * The AAD group ID of the team which owns the channel.
+                    * The Microsoft Entra group ID of the team which owns the channel.
                     */
                 ownerGroupId?: string;
         }
@@ -4026,7 +4026,7 @@ export namespace app {
             */
         export interface UserInfo {
                 /**
-                    * The Azure AD object id of the current user.
+                    * The Microsoft Entra object id of the current user.
                     *
                     * Because a malicious party can run your content in a browser, this value should
                     * be used only as a optimization hint as to who the user is and never as proof of identity.
@@ -4055,7 +4055,7 @@ export namespace app {
                     */
                 licenseType?: string;
                 /**
-                    * A value suitable for use when providing a login_hint to Azure Active Directory for authentication purposes.
+                    * A value suitable for use when providing a login_hint to Microsoft Entra ID for authentication purposes.
                     * See [Provide optional claims to your app](https://learn.microsoft.com/azure/active-directory/develop/active-directory-optional-claims#v10-and-v20-optional-claims-set)
                     * for more information about the use of login_hint
                     *
@@ -4086,7 +4086,7 @@ export namespace app {
             */
         export interface TenantInfo {
                 /**
-                    * The Azure AD tenant ID of the current user.
+                    * The Microsoft Entra tenant ID of the current user.
         
                     * Because a malicious party can run your content in a browser, this value should
                     * be used only as a optimization hint as to who the user is and never as proof of identity.
@@ -4285,6 +4285,97 @@ export namespace appInstallDialog {
         function isSupported(): boolean;
 }
 
+/**
+    * Namespace to interact with the appNotification specific part of the SDK
+    * @beta
+    */
+export namespace appNotification {
+        /**
+            * Data structure to represent appNotification information
+            *
+            * @beta
+            */
+        interface NotificationDisplayParam {
+                /**
+                    * Notification title(maximum length: 75 characters)
+                    */
+                title: string;
+                /**
+                    * Notification content (maximum length: 1500 characters)
+                    */
+                content: string;
+                /**
+                    * This would represent an optional icon that can be displayed on the notification. It should have a max size of 49 pixels by 49 pixels
+                    * If no icon is provided, the notification card would be displayed without an icon
+                    * The url link to where the icon is stored should be provided as the input string
+                    */
+                icon?: URL;
+                /**
+                    * This would specify how long a notification would be displayed on the screen for (unit: seconds)
+                    *
+                    */
+                displayDurationInSeconds: number;
+                /**
+                    * A url link to the page in which the notification would direct the user to.
+                    */
+                notificationActionUrl: URL;
+        }
+        /**
+            * @internal
+            *
+            * @hidden
+            *
+            * @beta
+            *
+            * Data structure to represent appNotification information that would be sent to the host SDK
+            */
+        interface NotificationDisplayParamForAppHost {
+                /**
+                    * Notification title(maximum length: 75 characters)
+                    */
+                title: string;
+                /**
+                    * Notification content (maximum length: 1500 characters)
+                    */
+                content: string;
+                /**
+                    * This would represent an optional icon that can be displayed on the notification. It should have a max size of 49 pixels by 49 pixels
+                    * If no icon is provided, the notification card would be displayed without an icon
+                    * The url link to where the icon is stored should be provided as the input string
+                    */
+                notificationIconAsString?: string;
+                /**
+                    * This would specify how long a notification would be displayed on the screen for (unit: seconds)
+                    *
+                    */
+                displayDurationInSeconds: number;
+                /**
+                    * A url string type to the page in which the notification would direct the user to.
+                    */
+                notificationActionUrlAsString: string;
+        }
+        /**
+            * Displays appNotification after making a validiity check on all of the required parameters, by calling the validateNotificationDisplayParams helper function
+            * An interface object containing all the required parameters to be displayed on the notification would be passed in here
+            * The notificationDisplayParam would be serialized before passing across to the message handler to ensure all objects passed contain simple parameters that would properly pass across the Iframe
+            * @param notificationdisplayparam - Interface object with all the parameters required to display an appNotificiation
+            * @returns a promise resolution upon conclusion
+            * @throws Error if appNotification capability is not supported
+            * @throws Error if notficationDisplayParam was not validated successfully
+            *
+            * @beta
+            */
+        function displayInAppNotification(notificationDisplayParam: NotificationDisplayParam): Promise<void>;
+        /**
+            * Checks if appNotification is supported by the host
+            * @returns boolean to represent whether the appNotification capability is supported
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @beta
+            */
+        function isSupported(): boolean;
+}
+
 /**
     * Namespace to interact with the barcode scanning-specific part of the SDK.
     *
@@ -4361,7 +4452,7 @@ interface OpenChatRequest {
     */
 export interface OpenSingleChatRequest extends OpenChatRequest {
         /**
-            * The Azure Active Directory UPN (e-mail address) of the user to chat with
+            * The Microsoft Entra UPN (e-mail address) of the user to chat with
             */
         user: string;
 }
@@ -4374,7 +4465,7 @@ export interface OpenSingleChatRequest extends OpenChatRequest {
     */
 export interface OpenGroupChatRequest extends OpenChatRequest {
         /**
-            * Array containing Azure Active Directory UPNs (e-mail addresss) of users to open chat with
+            * Array containing Microsoft Entra UPNs (e-mail addresss) of users to open chat with
             */
         users: string[];
         /**
@@ -4556,7 +4647,7 @@ export namespace dialog {
                     */
                 namespace bot {
                         /**
-                            * Allows an app to open the dialog module using bot.
+                            * Allows an app to open a dialog that sends submitted data to a bot.
                             *
                             * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
                             * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
@@ -6873,7 +6964,7 @@ export namespace people {
             * Launches a people picker and allows the user to select one or more people from the list
             * If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
          
-            * @param callback - Returns list of JSON object of type PeoplePickerResult which consists of AAD IDs, display names and emails of the selected users
+            * @param callback - Returns list of JSON object of type PeoplePickerResult which consists of Microsoft Entra IDs, display names and emails of the selected users
             * @param peoplePickerInputs - Input parameters to launch customized people picker
             * @returns Promise that will be fulfilled when the operation has completed
             */
@@ -6885,7 +6976,7 @@ export namespace people {
             * Launches a people picker and allows the user to select one or more people from the list
             * If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
          
-            * @param callback - Returns list of JSON object of type PeoplePickerResult which consists of AAD IDs, display names and emails of the selected users
+            * @param callback - Returns list of JSON object of type PeoplePickerResult which consists of Microsoft Entra IDs, display names and emails of the selected users
             * @param peoplePickerInputs - Input parameters to launch customized people picker
             */
         function selectPeople(callback: selectPeopleCallbackFunctionType, peoplePickerInputs?: PeoplePickerInputs): void;
@@ -6899,7 +6990,7 @@ export namespace people {
                     */
                 title?: string;
                 /**
-                    * Optional; AAD ids of the users to be pre-populated in the search box of people picker control
+                    * Optional; Microsoft Entra IDs of the users to be pre-populated in the search box of people picker control
                     * If single select is enabled this value, only the first user in the list will be pre-populated
                     * Default value is null
                     */
@@ -6920,7 +7011,7 @@ export namespace people {
             */
         interface PeoplePickerResult {
                 /**
-                    * user object Id (also known as aad id) of the selected user
+                    * user object ID (also known as Microsoft Entra ID) of the selected user
                     */
                 objectId: string;
                 /**
@@ -6976,13 +7067,13 @@ export namespace profile {
             * The set of identifiers that are supported for resolving the persona.
             *
             * At least one is required, and if multiple are provided then only the highest
-            * priority one will be used (AadObjectId > Upn > Smtp).
+            * priority one will be used (AadObjectId > Upn > Smtp). AAD is now known as "Microsoft Entra ID"
             *
             * @beta
             */
         type PersonaIdentifiers = {
                 /**
-                    * The object id in Azure Active Directory.
+                    * The object id in Microsoft Entra.
                     *
                     * This id is guaranteed to be unique for an object within a tenant,
                     * and so if provided will lead to a more performant lookup. It can
@@ -7562,7 +7653,7 @@ export namespace call {
                     * Comma-separated list of user IDs representing the participants of the call.
                     *
                     * @remarks
-                    * Currently the User ID field supports the Azure AD UserPrincipalName,
+                    * Currently the User ID field supports the Microsoft Entra UserPrincipalName,
                     * typically an email address, or in case of a PSTN call, it supports a pstn
                     * mri 4:\<phonenumber>.
                     */
@@ -8621,7 +8712,7 @@ export namespace marketplace {
     * @hidden
     * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
     */
-export function processMediaStream(streamId: string, videoFrameHandler: video.VideoFrameHandler, notifyError: (string: any) => void): Promise<MediaStreamTrack>;
+export function processMediaStream(streamId: string, videoFrameHandler: video.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<MediaStreamTrack>;
 /**
     * @hidden
     * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
@@ -8630,7 +8721,7 @@ export function processMediaStream(streamId: string, videoFrameHandler: video.Vi
     * @internal
     * Limited to Microsoft-internal use
     */
-export function processMediaStreamWithMetadata(streamId: string, videoFrameHandler: videoEx.VideoFrameHandler, notifyError: (string: any) => void): Promise<MediaStreamTrack>;
+export function processMediaStreamWithMetadata(streamId: string, videoFrameHandler: videoEx.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<MediaStreamTrack>;
 /**
     * @hidden
     * Video effect change call back function definition
@@ -8643,6 +8734,48 @@ type VideoEffectCallBack = (effectId: string | undefined, effectParam?: string)
 /**
     * @hidden
     */
-export function createEffectParameterChangeCallback(callback: VideoEffectCallBack): (effectId: string | undefined, effectParam?: string) => void;
+export function createEffectParameterChangeCallback(callback: VideoEffectCallBack, videoPerformanceMonitor?: VideoPerformanceMonitor): (effectId: string | undefined, effectParam?: string) => void;
 export { VideoEffectCallBack as DefaultVideoEffectCallBack };
 
+/**
+    * This class is used to monitor the performance of video processing, and report performance events.
+    */
+export class VideoPerformanceMonitor {
+        constructor(reportPerformanceEvent: (actionName: string, args: unknown[]) => void);
+        /**
+            * Start to check frame processing time intervally
+            * and report performance event if the average frame processing time is too long.
+            */
+        startMonitorSlowFrameProcessing(): void;
+        /**
+            * Define the time limit of frame processing.
+            * When the average frame processing time is longer than the time limit, a "video.performance.frameProcessingSlow" event will be reported.
+            * @param timeLimit
+            */
+        setFrameProcessTimeLimit(timeLimit: number): void;
+        /**
+            * Call this function when the app starts to switch to the new video effect
+            */
+        reportApplyingVideoEffect(effectId: string, effectParam?: string): void;
+        /**
+            * Call this function when the new video effect is ready
+            */
+        reportVideoEffectChanged(effectId: string, effectParam?: string): void;
+        /**
+            * Call this function when the app starts to process a video frame
+            */
+        reportStartFrameProcessing(frameWidth: number, frameHeight: number): void;
+        /**
+            * Call this function when the app finishes successfully processing a video frame
+            */
+        reportFrameProcessed(): void;
+        /**
+            * Call this function when the app starts to get the texture stream
+            */
+        reportGettingTextureStream(streamId: string): void;
+        /**
+            * Call this function when the app finishes successfully getting the texture stream
+            */
+        reportTextureStreamAcquired(): void;
+}
+