@microsoft/teams-js 2.13.0-beta.1 → 2.14.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.12.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.13.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.12.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-H8/uiTqHq6b1eqm04U0wlhoD92qH4Ibgxrj4QLh8F5iomB4eqTdvi5dzPZkyKNxz"
+  src="https://res.cdn.office.net/teams-js/2.13.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-F9Iwc2j9qTKP1PITJeEV0OOS8NDzEUzrP//Fz0t2gzapTMPvNjhYdQjF0idJOuG3"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.12.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.13.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2088,13 +2088,47 @@ export namespace videoEx {
         }
         /**
             * @hidden
-            * Video frame call back function
+            * The callback will be called on every frame when running on the supported host.
+            * We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
+            * The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
+            * The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
             * @beta
             *
             * @internal
             * Limited to Microsoft-internal use
             */
         type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+        /**
+            * @hidden
+            * Video frame data extracted from the media stream. More properties may be added in the future.
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type VideoFrameData = video.VideoFrameData & {
+                /**
+                    * @hidden
+                    * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                audioInferenceResult?: Uint8Array;
+        };
+        /**
+            * @hidden
+            * The callback will be called on every frame when running on the supported host.
+            * We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
+            * 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. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<video.VideoFrame>;
         /**
             * @hidden
             * @beta
@@ -2103,6 +2137,10 @@ export namespace videoEx {
             * Limited to Microsoft-internal use
             */
         type RegisterForVideoFrameParameters = {
+                /**
+                    * Callback function to process the video frames extracted from a media stream.
+                    */
+                videoFrameHandler: VideoFrameHandler;
                 /**
                     * Callback function to process the video frames shared by the host.
                     */
@@ -2117,8 +2155,9 @@ export namespace videoEx {
             * 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
+            * @param parameters - Callbacks and configuration to process the video frames. A host may support either {@link VideoFrameHandler} or {@link VideoBufferHandler}, but not both.
+            * To ensure the video effect works on all supported hosts, the video app must provide both {@link VideoFrameHandler} and {@link VideoBufferHandler}.
+            * The host will choose the appropriate callback based on the host's capability.
             *
             * @internal
             * Limited to Microsoft-internal use
@@ -5529,6 +5568,27 @@ export namespace media {
             *
             */
         export function captureImage(callback: captureImageCallbackFunctionType): void;
+        /**
+            * Checks whether or not media has user permission
+            *
+            * @returns Promise that will resolve with true if the user had granted the app permission to media information, or with false otherwise,
+            * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+            */
+        export function hasPermission(): Promise<boolean>;
+        /**
+            * Requests user permission for media
+            *
+            * @returns Promise that will resolve with true if the user consented permission for media, or with false otherwise,
+            * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+            */
+        export function requestPermission(): Promise<boolean>;
+        /**
+            * Checks if media capability is supported by the host
+            * @returns boolean to represent whether media is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            */
+        export function isSupported(): boolean;
         /**
             * Media object returned by the select Media API
             */
@@ -7420,7 +7480,7 @@ export namespace stageView {
                 /**
                     * The title to give the stage view.
                     */
-                title: string;
+                title?: string;
                 /**
                     * The Teams application website URL.
                     */
@@ -8238,11 +8298,342 @@ export class LiveShareHost {
         static create(): LiveShareHost;
 }
 
+/**
+    * @hidden
+    * Namespace for an app to support a checkout flow by interacting with the marketplace cart in the host.
+    * @beta
+    */
+export namespace marketplace {
+        /**
+            * @hidden
+            * the version of the current cart interface
+            * which is forced to send to the host in the calls.
+            * @internal
+            * Limited to Microsoft-internal use
+            * @beta
+            */
+        export const cartVersion: CartVersion;
+        /**
+            * @hidden
+            * Represents the cart object for the app checkout flow.
+            * @beta
+            */
+        export interface Cart {
+                /**
+                    * @hidden
+                    * Version of the cart.
+                    */
+                readonly version: CartVersion;
+                /**
+                    * @hidden
+                    * The uuid of the cart.
+                    */
+                readonly id: string;
+                /**
+                    * @hidden
+                    * The cart info.
+                    */
+                readonly cartInfo: CartInfo;
+                /**
+                    * @hidden
+                    * The cart items.
+                    */
+                readonly cartItems: CartItem[];
+        }
+        /**
+            * @hidden
+            * Version of the cart that is used by the app.
+            * @internal
+            * Limited to Microsoft-internal use
+            * @beta
+            */
+        interface CartVersion {
+                /**
+                    * @hidden
+                    * Represents the major version of a cart, it
+                    * not compatible with the previous major version.
+                    */
+                readonly majorVersion: number;
+                /**
+                    * @hidden
+                    * The minor version of a cart, which is compatible
+                    * with the previous minor version in the same major version.
+                    */
+                readonly minorVersion: number;
+        }
+        /**
+            * @hidden
+            * Represents the cart information
+            * @beta
+            */
+        interface CartInfo {
+                /**
+                    * @hidden
+                    * The country market where the products are selling.
+                    * Should be country code in ISO 3166-1 alpha-2 format, e.g. CA for Canada.
+                    * https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+                    */
+                readonly market: string;
+                /**
+                    * @hidden
+                    * The identifier to tell the cart is checked out by admin or end user.
+                    */
+                readonly intent: Intent;
+                /**
+                    * @hidden
+                    * Locale the app should render for the user
+                    * Should be a BCP 47 language tag, e.g. en-US ([primary tag]-[ISO 3166-1 alpha-2 code]).
+                    * https://en.wikipedia.org/wiki/IETF_language_tag
+                    */
+                readonly locale: string;
+                /**
+                    * @hidden
+                    * The status of the cart.
+                    */
+                readonly status: CartStatus;
+                /**
+                    * @hidden
+                    * ISO 4217 currency code for the cart item price, e.g. USD for US Dollar.
+                    * https://en.wikipedia.org/wiki/ISO_4217
+                    */
+                readonly currency: string;
+                /**
+                    * @hidden
+                    * ISO 8601 timestamp string in UTC, indicates when the cart is created.
+                    * e.g. 2023-06-19T22:06:59Z
+                    * https://en.wikipedia.org/wiki/ISO_8601
+                    */
+                readonly createdAt: string;
+                /**
+                    * @hidden
+                    * ISO 8601 timestamp string in UTC, indicates when the cart is updated.
+                    * e.g. 2023-06-19T22:06:59Z
+                    * https://en.wikipedia.org/wiki/ISO_8601
+                    */
+                readonly updatedAt: string;
+        }
+        /**
+            * @hidden
+            * Represents the basic cart item information.
+            * @beta
+            */
+        export interface Item {
+                /**
+                    * @hidden
+                    * The id of the cart item.
+                    */
+                readonly id: string;
+                /**
+                    * @hidden
+                    * The display name of the cart item.
+                    */
+                readonly name: string;
+                /**
+                    * @hidden
+                    * The quantity of the cart item.
+                    */
+                readonly quantity: number;
+                /**
+                    * @hidden
+                    * The price of the single cart item.
+                    */
+                readonly price: number;
+                /**
+                    * @hidden
+                    * The thumbnail imageURL of the cart item.
+                    */
+                readonly imageURL?: URL;
+        }
+        /**
+            * @hidden
+            * Represents the cart item that could have accessories
+            * @beta
+            */
+        export interface CartItem extends Item {
+                /**
+                    * @hidden
+                    * Accessories to the item if existing.
+                    */
+                readonly accessories?: Item[];
+                /**
+                    * @hidden
+                    * The thumbnail imageURL of the cart item.
+                    */
+                readonly imageURL?: URL;
+        }
+        /**
+            * @hidden
+            * Represents the persona creating the cart.
+            * @beta
+            */
+        export enum Intent {
+                /**
+                    * @hidden
+                    * The cart is created by admin of an organization in Teams Admin Center.
+                    */
+                TACAdminUser = "TACAdminUser",
+                /**
+                    * @hidden
+                    * The cart is created by admin of an organization in Teams.
+                    */
+                TeamsAdminUser = "TeamsAdminUser",
+                /**
+                    * @hidden
+                    * The cart is created by end user of an organization in Teams.
+                    */
+                TeamsEndUser = "TeamsEndUser"
+        }
+        /**
+            * @hidden
+            * Represents the status of the cart.
+            * @beta
+            */
+        export enum CartStatus {
+                /**
+                    * @hidden
+                    * Cart is created but not checked out yet.
+                    */
+                Open = "Open",
+                /**
+                    * @hidden
+                    * Cart is checked out but not completed yet.
+                    */
+                Processing = "Processing",
+                /**
+                    * @hidden
+                    * Indicate checking out is completed and the host should
+                    * return a new cart in the next getCart call.
+                    */
+                Processed = "Processed",
+                /**
+                    * @hidden
+                    * Indicate checking out process is manually cancelled by the user
+                    */
+                Closed = "Closed",
+                /**
+                    * @hidden
+                    * Indicate checking out is failed and the host should
+                    * return a new cart in the next getCart call.
+                    */
+                Error = "Error"
+        }
+        /**
+            * @hidden
+            * Represents the parameters to update the cart items.
+            * @beta
+            */
+        export interface AddOrUpdateCartItemsParams {
+                /**
+                    * @hidden
+                    * The uuid of the cart to be updated, target on the cart
+                    * being checked out  if cartId is not provided.
+                    */
+                cartId?: string;
+                /**
+                    * @hidden
+                    * A list of cart items object, for each item,
+                    * if item id exists in the cart, overwrite the item price and quantity,
+                    * otherwise add new items to cart.
+                    */
+                cartItems: CartItem[];
+        }
+        /**
+            * @hidden
+            * Represents the parameters to remove the cart items.
+            * @beta
+            */
+        export interface RemoveCartItemsParams {
+                /**
+                    * @hidden
+                    * The uuid of the cart to be updated, target on the cart
+                    * being checked out if cartId is not provided.
+                    */
+                cartId?: string;
+                /**
+                    * @hidden
+                    * A list of cart id, delete the cart item accordingly.
+                    */
+                cartItemIds: string[];
+        }
+        /**
+            * @hidden
+            * Represents the parameters to update the cart status.
+            * @beta
+            */
+        export interface UpdateCartStatusParams {
+                /**
+                    * @hidden
+                    * The uuid of the cart to be updated, target on the cart
+                    * being checked out if cartId is not provided.
+                    */
+                cartId?: string;
+                /**
+                    * @hidden
+                    * Status of the cart.
+                    */
+                cartStatus: CartStatus;
+                /**
+                    * @hidden
+                    * Extra info to the status.
+                    */
+                statusInfo?: string;
+        }
+        /**
+            * @hidden
+            * Get the cart object owned by the host to checkout.
+            * @returns A promise of the cart object in the cartVersion.
+            * @beta
+            */
+        export function getCart(): Promise<Cart>;
+        /**
+            * @hidden
+            * Add or update cart items in the cart owned by the host.
+            * @param addOrUpdateCartItemsParams Represents the parameters to update the cart items.
+            * @returns A promise of the updated cart object in the cartVersion.
+            * @beta
+            */
+        export function addOrUpdateCartItems(addOrUpdateCartItemsParams: AddOrUpdateCartItemsParams): Promise<Cart>;
+        /**
+            * @hidden
+            * Remove cart items from the cart owned by the host.
+            * @param removeCartItemsParams The parameters to remove the cart items.
+            * @returns A promise of the updated cart object in the cartVersion.
+            * @beta
+            */
+        export function removeCartItems(removeCartItemsParams: RemoveCartItemsParams): Promise<Cart>;
+        /**
+            * @hidden
+            * Update cart status in the cart owned by the host.
+            * @param updateCartStatusParams The parameters to update the cart status.
+            * @returns A promise of the updated cart object in the cartVersion.
+            * @beta
+            */
+        export function updateCartStatus(updateCartStatusParams: UpdateCartStatusParams): Promise<Cart>;
+        /**
+            * @hidden
+            * Checks if the marketplace capability is supported by the host.
+            * @returns Boolean to represent whether the marketplace capability is supported.
+            * @throws Error if {@linkcode app.initialize} has not successfully completed.
+            * @beta
+            */
+        export function isSupported(): boolean;
+        export {};
+}
+
 /**
     * @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>;
+/**
+    * @hidden
+    * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
+    * The videoFrameHandler will receive metadata of the video frame.
+    *
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export function processMediaStreamWithMetadata(streamId: string, videoFrameHandler: videoEx.VideoFrameHandler, notifyError: (string: any) => void): Promise<MediaStreamTrack>;
 /**
     * @hidden
     * Video effect change call back function definition