@microsoft/teams-js 2.10.0-beta.2 → 2.10.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.9.1/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.10.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.9.1/js/MicrosoftTeams.min.js"
-  integrity="sha384-xnsUQ1tUqsrutBJl0vuf4/hufzLFWW8ZhGnhItfpQ0/BtWgM2uw6YT6BQ5YaKBSM"
+  src="https://res.cdn.office.net/teams-js/2.10.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-7ZMvcfeIUPV84BQMdPBAJDk+zIac00KLvdNWZGZ0nF8FIDH0YE80EKj4ilp/VwZ1"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.9.1/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.10.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2026,18 +2026,6 @@ export namespace teams {
     * Limited to Microsoft-internal use
     */
 export namespace videoEx {
-        /**
-            * @hidden
-            * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
-            * @beta
-            *
-            * @internal
-            * Limited to Microsoft-internal use
-            */
-        enum ErrorLevel {
-                Fatal = "fatal",
-                Warn = "warn"
-        }
         /**
             * @hidden
             * Video frame configuration supplied to the host to customize the generated video frame parameters
@@ -2069,44 +2057,16 @@ export namespace videoEx {
         }
         /**
             * @hidden
-            * Represents a video frame
+            * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
             * @beta
             *
             * @internal
             * Limited to Microsoft-internal use
             */
-        interface VideoFrame extends video.VideoFrameData {
-                /**
-                    * @hidden
-                    * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
-                    * @beta
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    */
-                audioInferenceResult?: Uint8Array;
+        enum ErrorLevel {
+                Fatal = "fatal",
+                Warn = "warn"
         }
-        /**
-            * @hidden
-            * Video frame call back function
-            * @beta
-            *
-            * @internal
-            * Limited to Microsoft-internal use
-            */
-        type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
-        /**
-            * @hidden
-            * Register to process video frames
-            * @beta
-            *
-            * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
-            * @param config - VideoFrameConfig to customize generated video frame parameters
-            *
-            * @internal
-            * Limited to Microsoft-internal use
-            */
-        function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
         /**
             * @hidden
             * Video extension should call this to notify host that the current selected effect parameter changed.
@@ -2200,6 +2160,69 @@ export namespace videoEx {
             * Limited to Microsoft-internal use
             */
         function notifyFatalError(errorMessage: string): void;
+        /**
+            * @hidden
+            * @internal
+            * @beta
+            * Namespace to get shared video framed.
+            * When the host supports this capability, developer should call {@link sharedFrame.registerForVideoFrame} to get the video frames.
+            */
+        namespace sharedFrame {
+                /**
+                    * @hidden
+                    *
+                    * Checks if video.sharedFrame capability is supported by the host
+                    * @beta
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    * @returns boolean to represent whether the video.sharedFrame capability is supported
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function isSupported(): boolean;
+                /**
+                    * @hidden
+                    * Represents a video frame
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                interface VideoFrame extends video.sharedFrame.VideoFrameData {
+                        /**
+                            * @hidden
+                            * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
+                            * @beta
+                            *
+                            * @internal
+                            * Limited to Microsoft-internal use
+                            */
+                        audioInferenceResult?: Uint8Array;
+                }
+                /**
+                    * @hidden
+                    * Video frame call back function
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+                /**
+                    * @hidden
+                    * Register to process video frames
+                    * @beta
+                    *
+                    * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
+                    * @param config - VideoFrameConfig to customize generated video frame parameters
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
+        }
 }
 
 /**
@@ -3738,11 +3761,11 @@ export namespace app {
             */
         interface AppHostInfo {
                 /**
-                    * The name of the host client. Possible values are: Office, Orange, Outlook, Teams
+                    * Identifies which host is running your app
                     */
                 name: HostName;
                 /**
-                    * The type of the host client. Possible values are : android, ios, web, desktop, rigel
+                    * The client type on which the host is running
                     */
                 clientType: HostClientType;
                 /**
@@ -3868,6 +3891,7 @@ export namespace app {
                 templateId?: string;
                 /**
                     * The user's role in the team.
+        
                     * Because a malicious party can run your content in a browser, this value should
                     * be used only as a hint as to the user's role, and never as proof of her role.
                     */
@@ -3879,8 +3903,13 @@ export namespace app {
         interface UserInfo {
                 /**
                     * The Azure AD 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.
+                    *
+                    * 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.
+                    * Specifically, this value should never be used to determine if a user is authorized to access
+                    * a resource; access tokens should be used for that.
+                    * See {@link authentication.getAuthToken} and {@link authentication.authenticate} for more information on access tokens.
+                    *
                     * This field is available only when the identity permission is requested in the manifest.
                     */
                 id: string;
@@ -3898,21 +3927,29 @@ export namespace app {
                 isPSTNCallingAllowed?: boolean;
                 /**
                     * The license type for the current user. Possible values are:
-                    * "Unknown", "Teacher", "Student", "Free", "SmbBusinessVoice", "SmbNonVoice", "FrontlineWorker"
+                    * "Unknown", "Teacher", "Student", "Free", "SmbBusinessVoice", "SmbNonVoice", "FrontlineWorker", "Anonymous"
                     */
                 licenseType?: string;
                 /**
-                    * A value suitable for use as a login_hint when authenticating with Azure AD.
+                    * A value suitable for use when providing a login_hint to Azure Active Directory 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
+                    *
                     * 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.
+                    * be used only as a optimization hint as to who the user is and never as proof of identity.
+                    * Specifically, this value should never be used to determine if a user is authorized to access
+                    * a resource; access tokens should be used for that.
+                    * See {@link authentication.getAuthToken} and {@link authentication.authenticate} for more information on access tokens.
                     */
                 loginHint?: string;
                 /**
                     * The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users).
-                    * 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.
+        
+                    * 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.
+                    * Specifically, this value should never be used to determine if a user is authorized to access
+                    * a resource; access tokens should be used for that.
+                    * See {@link authentication.getAuthToken} and {@link authentication.authenticate} for more information on access tokens.
                     */
                 userPrincipalName?: string;
                 /**
@@ -3926,9 +3963,12 @@ export namespace app {
         interface TenantInfo {
                 /**
                     * The Azure AD 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.
+                    * be used only as a optimization hint as to who the user is and never as proof of identity.
+                    * Specifically, this value should never be used to determine if a user is authorized to access
+                    * a resource; access tokens should be used for that.
+                    * See {@link authentication.getAuthToken} and {@link authentication.authenticate} for more information on access tokens.
                     */
                 id: string;
                 /**
@@ -6382,24 +6422,54 @@ export namespace mail {
                 Forward = "forward"
         }
         /**
-            * Base of a discriminated union between compose scenarios.
+            * Foundational interface for all other mail compose interfaces
+            * Used for holding the type of mail item being composed
+            *
+            * @see {@link ComposeMailType}
             */
         interface ComposeMailBase<T extends ComposeMailType> {
                 type: T;
         }
         /**
-            * Interfaces for each type.
+            * Parameters supplied when composing a new mail item
             */
         export interface ComposeNewParams extends ComposeMailBase<ComposeMailType.New> {
+                /**
+                    * The To: recipients for the message
+                    */
                 toRecipients?: string[];
+                /**
+                    * The Cc: recipients for the message
+                    */
                 ccRecipients?: string[];
+                /**
+                    * The Bcc: recipients for the message
+                    */
                 bccRecipients?: string[];
+                /**
+                    * The subject of the message
+                    */
                 subject?: string;
+                /**
+                    * The body of the message
+                    */
                 message?: string;
         }
+        /**
+            * Parameters supplied when composing a reply to or forward of a message
+            *
+            * @see {@link ComposeMailType}
+            */
         export interface ComposeReplyOrForwardParams<T extends ComposeMailType> extends ComposeMailBase<T> {
                 itemid: string;
         }
+        /**
+            * Parameters supplied to {@link composeMail} when composing a new mail item
+            *
+            * @see {@link ComposeNewParams}
+            * @see {@link ComposeReplyOrForwardParams}
+            * @see {@link ComposeMailType}
+            */
         export type ComposeMailParams = ComposeNewParams | ComposeReplyOrForwardParams<ComposeMailType.Reply> | ComposeReplyOrForwardParams<ComposeMailType.ReplyAll> | ComposeReplyOrForwardParams<ComposeMailType.Forward>;
         export {};
 }
@@ -6679,40 +6749,6 @@ export interface ShowProfileRequestInternal {
     * @beta
     */
 export namespace video {
-        /**
-            * Represents a video frame
-            * @beta
-            */
-        interface VideoFrameData {
-                /**
-                    * Video frame width
-                    */
-                width: number;
-                /**
-                    * Video frame height
-                    */
-                height: number;
-                /**
-                    * Video frame buffer
-                    */
-                videoFrameBuffer: Uint8ClampedArray;
-                /**
-                    * NV12 luma stride, valid only when video frame format is NV12
-                    */
-                lumaStride?: number;
-                /**
-                    * NV12 chroma stride, valid only when video frame format is NV12
-                    */
-                chromaStride?: number;
-                /**
-                    * RGB stride, valid only when video frame format is RGB
-                    */
-                stride?: number;
-                /**
-                    * The time stamp of the current video frame
-                    */
-                timestamp?: number;
-        }
         /**
             * Video frame format enum, currently only support NV12
             * @beta
@@ -6738,17 +6774,12 @@ export namespace video {
                 /**
                     * Current video effect changed
                     */
-                EffectChanged = 0,
+                EffectChanged = "EffectChanged",
                 /**
                     * Disable the video effect
                     */
-                EffectDisabled = 1
+                EffectDisabled = "EffectDisabled"
         }
-        /**
-            * Video frame call back function definition
-            * @beta
-            */
-        type VideoFrameCallback = (frame: VideoFrameData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
         /**
             * Predefined failure reasons for preparing the selected video effect
             * @beta
@@ -6770,13 +6801,6 @@ export namespace video {
             * @beta
             */
         type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
-        /**
-            * Register to read the video frames in Permissions section
-            * @beta
-            * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
-            * @param config - VideoFrameConfig to customize generated video frame parameters
-            */
-        function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
         /**
             * Video extension should call this to notify host that the current selected effect parameter changed.
             * If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
@@ -6804,7 +6828,7 @@ export namespace video {
         /**
             * @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.
+            * When the host supports this capability, developer should call {@link mediaStream.registerForVideoFrame} to get the video frames.
             */
         namespace mediaStream {
                 /**
@@ -6851,6 +6875,68 @@ export namespace video {
                     */
                 function registerForVideoFrame(frameCallback: VideoFrameCallback): void;
         }
+        /**
+            * @beta
+            * Namespace to get shared video framed.
+            * When the host supports this capability, developer should call {@link sharedFrame.registerForVideoFrame} to get the video frames.
+            */
+        namespace sharedFrame {
+                /**
+                    * Checks if video.sharedFrame capability is supported by the host
+                    * @beta
+                    * @returns boolean to represent whether the video capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    */
+                function isSupported(): boolean;
+                /**
+                    * Represents a video frame
+                    * @beta
+                    */
+                interface VideoFrameData {
+                        /**
+                            * Video frame width
+                            */
+                        width: number;
+                        /**
+                            * Video frame height
+                            */
+                        height: number;
+                        /**
+                            * Video frame buffer
+                            */
+                        videoFrameBuffer: Uint8ClampedArray;
+                        /**
+                            * NV12 luma stride, valid only when video frame format is NV12
+                            */
+                        lumaStride?: number;
+                        /**
+                            * NV12 chroma stride, valid only when video frame format is NV12
+                            */
+                        chromaStride?: number;
+                        /**
+                            * RGB stride, valid only when video frame format is RGB
+                            */
+                        stride?: number;
+                        /**
+                            * The time stamp of the current video frame
+                            */
+                        timestamp?: number;
+                }
+                /**
+                    * Video frame call back function definition
+                    * @beta
+                    */
+                type VideoFrameCallback = (frame: VideoFrameData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+                /**
+                    * Register to read the video frames in Permissions section
+                    * @beta
+                    * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
+                    * @param config - VideoFrameConfig to customize generated video frame parameters
+                    */
+                function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
+        }
 }
 
 /**
@@ -7097,7 +7183,7 @@ export namespace call {
                     * @remarks
                     * Currently the User ID field supports the Azure AD UserPrincipalName,
                     * typically an email address, or in case of a PSTN call, it supports a pstn
-                    * mri 4:<phonenumber>.
+                    * mri 4:\<phonenumber>.
                     */
                 targets: string[];
                 /**
@@ -7566,7 +7652,7 @@ export namespace tasks {
         function submitTask(result?: string | object, appIds?: string | string[]): void;
         /**
             * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
-            * otherwise uses the height and width values corresponding to {@link TaskModuleDimension | TaskModuleDimension.Small}
+            * otherwise uses the height and width values corresponding to {@link DialogDimension | TaskModuleDimension.Small}
             * @param taskInfo TaskInfo object from which to extract size info, if specified
             * @returns TaskInfo with height and width specified
             */