@microsoft/teams-js 2.8.1-beta.0 → 2.9.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.8.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.9.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.8.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-/DJ9oJEFZSpGiUQx9Na5Yb5svOPPqSb3khKxJ/YgoZ2GtrkzWgSTBpESy3LvMPVk"
+  src="https://res.cdn.office.net/teams-js/2.9.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-wh4L8gn9alg8jFXiHwEw/IgcfK7aT/6Pyby/p5B7zHM+a0Jek5MxzO7AvSlRFvsC"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.8.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.9.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2075,7 +2075,7 @@ export namespace videoEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        interface VideoFrame extends video.VideoFrame {
+        interface VideoFrame extends video.VideoFrameData {
                 /**
                     * @hidden
                     * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
@@ -2208,26 +2208,45 @@ export namespace videoEx {
     * This object is used for starting or completing authentication flows.
     */
 export namespace authentication {
+        /**
+            * @hidden
+            * @internal
+            * Limited to Microsoft-internal use; automatically called when library is initialized
+            */
         function initialize(): void;
         /**
             * @deprecated
-            * As of 2.0.0, this function has been deprecated in favor of a Promise-based pattern.
-            * Registers the authentication Communication.handlers
+            * As of 2.0.0, this function has been deprecated in favor of a Promise-based pattern using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
             *
-            * @param authenticateParameters - A set of values that configure the authentication pop-up.
+            * Registers handlers to be called with the result of an authentication flow triggered using {@link authentication.authenticate authentication.authenticate(authenticateParameters?: AuthenticateParameters): void}
+            *
+            * @param authenticateParameters - Configuration for authentication flow pop-up result communication
             */
         function registerAuthenticationHandlers(authenticateParameters: AuthenticateParameters): void;
         /**
-            * Initiates an authentication request, which opens a new window with the specified settings.
+            * 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)
+            *
+            * 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
+            * [Enable SSO for tab apps](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/tab-sso-overview))
             *
             * @remarks
             * The authentication flow must start and end from the same domain, otherwise success and failure messages won't be returned to the window that initiated the call.
+            * The [Teams authentication flow](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/auth-flow-tab) starts and ends at an endpoint on
+            * your own service (with a redirect round-trip to the 3rd party identity provider in the middle).
             *
-            * @param authenticateParameters - The parameters for the authentication request. It is a required parameter since v2 upgrade
+            * @param authenticateParameters - Parameters describing the authentication window used for executing the authentication flow
             *
-            * @returns Promise that will be fulfilled with the result from the authentication pop-up if successful.
+            * @returns `Promise` that will be fulfilled with the result from the authentication pop-up, if successful. The string in this result is provided in the parameter
+            * passed by your app when it calls {@link notifySuccess} in the pop-up window after returning from the identity provider redirect.
             *
-            * @throws Error if the authentication request fails or is canceled by the user.
+            * @throws `Error` if the authentication request fails or is canceled by the user. This error is provided in the parameter passed by your app when it calls
+            * {@link notifyFailure} in the pop-up window after returning from the identity provider redirect. However, in some cases it can also be provided by
+            * the infrastructure depending on the failure (e.g., a user cancelation)
             *
             */
         function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
@@ -2235,30 +2254,36 @@ export namespace authentication {
             * @deprecated
             * As of 2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} instead.
             *
-            * Initiates an authentication request, which opens a new window with the specified settings.
+            * The documentation for {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} applies
+            * to this function.
+            * The one difference is that instead of the result being returned via the `Promise`, the result is returned to the callback functions provided in the
+            * `authenticateParameters` parameter.
             *
-            * @remarks
-            * The authentication flow must start and end from the same domain, otherwise success and failure messages won't be returned to the window that initiated the call.
-            *
-            * @param authenticateParameters - The parameters for the authentication request.
+            * @param authenticateParameters - Parameters describing the authentication window used for executing the authentication flow and callbacks used for indicating the result
             *
             */
         function authenticate(authenticateParameters?: AuthenticateParameters): void;
         /**
-            * Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
-            * if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
+            * 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
+            * 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.
             *
             * @param authTokenRequest - An optional set of values that configure the token request.
             *
-            * @returns Promise that will be fulfilled with the token if successful.
+            * @returns `Promise` that will be resolved with the token, if successful.
+            *
+            * @throws `Error` if the request fails in some way
             */
         function getAuthToken(authTokenRequest?: AuthTokenRequestParameters): Promise<string>;
         /**
             * @deprecated
             * As of 2.0.0, please use {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} instead.
             *
-            * Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
-            * if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
+            * The documentation {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} applies to this
+            * function as well. The one difference when using this function is that the result is provided in the callbacks in the `authTokenRequest` parameter
+            * instead of as a `Promise`.
             *
             * @param authTokenRequest - An optional set of values that configure the token request.
             * It contains callbacks to call in case of success/failure
@@ -2287,30 +2312,39 @@ export namespace authentication {
             */
         function getUser(userRequest: UserRequest): void;
         /**
-            * Notifies the frame that initiated this authentication request that the request was successful.
+            * When using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}, the
+            * window that was opened to execute the authentication flow should call this method after authentiction to notify the caller of
+            * {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} that the
+            * authentication request was successful.
             *
             * @remarks
-            * This function is usable only on the authentication window.
+            * This function is usable only from the authentication window.
             * This call causes the authentication window to be closed.
             *
-            * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
+            * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
+            * this value in its callback or via the `Promise` return value
             * @param callbackUrl - Specifies the url to redirect back to if the client is Win32 Outlook.
             */
         function notifySuccess(result?: string, callbackUrl?: string): void;
         /**
-            * Notifies the frame that initiated this authentication request that the request failed.
+            * When using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}, the
+            * window that was opened to execute the authentication flow should call this method after authentiction to notify the caller of
+            * {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} that the
+            * authentication request failed.
+    
             *
             * @remarks
             * This function is usable only on the authentication window.
             * This call causes the authentication window to be closed.
             *
-            * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
+            * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
+            * this value in its callback or via the `Promise` return value
             * @param callbackUrl - Specifies the url to redirect back to if the client is Win32 Outlook.
             */
         function notifyFailure(reason?: string, callbackUrl?: string): void;
         /**
             * @deprecated
-            * As of 2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
+            * As of 2.0.0, this interface has been deprecated in favor of leveraging the `Promise` returned from {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
             *-------------------------
             * Used in {@link AuthenticateParameters} and {@link AuthTokenRequest}
             */
@@ -2318,12 +2352,14 @@ export namespace authentication {
                 /**
                     * @deprecated
                     * As of 2.0.0, this property has been deprecated in favor of a Promise-based pattern.
+                    *
                     * A function that is called if the request succeeds.
                     */
                 successCallback?: (result: string) => void;
                 /**
                     * @deprecated
                     * As of 2.0.0, this property has been deprecated in favor of a Promise-based pattern.
+                    *
                     * A function that is called if the request fails, with the reason for the failure.
                     */
                 failureCallback?: (reason: string) => void;
@@ -2345,13 +2381,22 @@ export namespace authentication {
                     */
                 height?: number;
                 /**
-                    * The flag which indicates whether the auth page should be opened in an external browser. This flag has no effect on the web client.
+                    * Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
+                    * If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page specified in
+                    * the {@link url} property to be opened in an external browser.
+                    * If this flag is `false`, the page will be opened directly within the current hosting application.
+                    *
+                    * This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
+                    * environment without an embedded browser.
                     */
                 isExternal?: boolean;
         }
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link AuthenticatePopUpParameters} instead.
+            * As of 2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} and
+            * the associated {@link AuthenticatePopUpParameters} instead.
+            *
+            * @see {@link LegacyCallBacks}
             */
         type AuthenticateParameters = AuthenticatePopUpParameters & LegacyCallBacks;
         /**
@@ -2359,7 +2404,9 @@ export namespace authentication {
             */
         interface AuthTokenRequestParameters {
                 /**
-                    * An optional list of resource for which to acquire the access token; only used for full trust apps.
+                    * @hidden
+                    * @internal
+                    * An list of resources for which to acquire the access token; only for internal Microsoft usage
                     */
                 resources?: string[];
                 /**
@@ -6624,7 +6671,7 @@ export namespace video {
             * Represents a video frame
             * @beta
             */
-        interface VideoFrame {
+        interface VideoFrameData {
                 /**
                     * Video frame width
                     */
@@ -6636,7 +6683,7 @@ export namespace video {
                 /**
                     * Video frame buffer
                     */
-                data: Uint8ClampedArray;
+                videoFrameBuffer: Uint8ClampedArray;
                 /**
                     * NV12 luma stride, valid only when video frame format is NV12
                     */
@@ -6659,7 +6706,7 @@ export namespace video {
             * @beta
             */
         enum VideoFrameFormat {
-                NV12 = 0
+                NV12 = "NV12"
         }
         /**
             * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
@@ -6689,12 +6736,28 @@ export namespace video {
             * Video frame call back function definition
             * @beta
             */
-        type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+        type VideoFrameCallback = (frame: VideoFrameData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+        /**
+            * Predefined failure reasons for preparing the selected video effect
+            * @beta
+            */
+        enum EffectFailureReason {
+                /**
+                    * A wrong effect id is provide.
+                    * Use this reason when the effect id is not found or empty, this may indicate a mismatch between the app and its manifest or a bug of the host.
+                    */
+                InvalidEffectId = "InvalidEffectId",
+                /**
+                    * The effect can't be initialized
+                    */
+                InitializationFailure = "InitializationFailure"
+        }
         /**
             * Video effect change call back function definition
+            * Return a Promise which will be resolved when the effect is prepared, or throw an {@link EffectFailureReason} on error.
             * @beta
             */
-        type VideoEffectCallBack = (effectId: string | undefined) => void;
+        type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
         /**
             * Register to read the video frames in Permissions section
             * @beta
@@ -6712,11 +6775,11 @@ export namespace video {
             */
         function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
         /**
-            * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
+            * Register a callback to be notified when a new video effect is applied.
             * @beta
-            * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
+            * @param callback - Function to be called when new video effect is applied.
             */
-        function registerForVideoEffect(callback: VideoEffectCallBack): void;
+        function registerForVideoEffect(callback: VideoEffectCallback): void;
         /**
             * Checks if video capability is supported by the host
             * @beta
@@ -6726,6 +6789,56 @@ export namespace video {
             *
             */
         function isSupported(): boolean;
+        /**
+            * @beta
+            * Namespace to get video frames from a media stream.
+            * When the host supports this capability, developer should call {@link mediaStream.registerForVideoFrame} to get the video frames instead of {@link registerForVideoFrame} to get the video frames, callback of {@link registerForVideoFrame} will be ignored when the host supports this capability.
+            */
+        namespace mediaStream {
+                /**
+                    * @beta
+                    * Checks if video.mediaStream capability is supported by the host
+                    * @returns boolean to represent whether the video.medisStream capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    */
+                function isSupported(): boolean;
+                /**
+                    * @beta
+                    * Video frame data extracted from the media stream. More properties may be added in the future.
+                    */
+                type MediaStreamFrameData = {
+                        /**
+                            * The video frame from the media stream.
+                            */
+                        videoFrame: VideoFrame;
+                };
+                /**
+                    * @beta
+                    * Video effect change call back function definition.
+                    * The video app should resolve the promise to notify a successfully processed video frame.
+                    * The video app should reject the promise to notify a failure.
+                    */
+                type VideoFrameCallback = (receivedVideoFrame: MediaStreamFrameData) => Promise<VideoFrame>;
+                /**
+                    * @beta
+                    * Register to read the video frames from the media stream provided by the host.
+                    * @param frameCallback - The callback to invoke when recieve a video frame from the media stream.
+                    * @example
+                    * ```typescript
+                    * video.mediaStream.registerForVideoFrame(async (receivedVideoFrame) => {
+                    *  const { videoFrame } = receivedVideoFrame;
+                    *  try {
+                    *    return await processVideoFrame(videoFrame);
+                    *  } catch (error) {
+                    *   throw error;
+                    *  }
+                    * });
+                    * ```
+                    */
+                function registerForVideoFrame(frameCallback: VideoFrameCallback): void;
+        }
 }
 
 /**