@microsoft/teams-js 2.31.0-beta.0 → 2.31.0-beta.2

package/dist/esm/packages/teams-js/dts/public/menus.d.ts

@@ -1,188 +1,187 @@
 /**
- * Namespace to interact with the menu-specific part of the SDK.
+ * Module to interact with the menu-specific part of the SDK.
  * This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
+ * @module
  */
-export declare namespace menus {
+/**
+ * @hidden
+ * Represents information about item in View Configuration.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface ViewConfiguration {
     /**
      * @hidden
-     * Represents information about item in View Configuration.
+     * Unique identifier of view.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    interface ViewConfiguration {
-        /**
-         * @hidden
-         * Unique identifier of view.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        id: string;
-        /**
-         * @hidden
-         * Display title of the view.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        title: string;
-        /**
-         * @hidden
-         * Additional information for accessibility.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        contentDescription?: string;
-    }
-    /**
-     * Defines how a menu item should appear in the NavBar.
-     */
-    enum DisplayMode {
-        /**
-         * Only place this item in the NavBar if there's room for it.
-         * If there's no room, item is shown in the overflow menu.
-         */
-        ifRoom = 0,
-        /**
-         * Never place this item in the NavBar.
-         * The item would always be shown in NavBar's overflow menu.
-         */
-        overflowOnly = 1
-    }
-    /**
-     * @hidden
-     * Represents information about menu item for Action Menu and Navigation Bar Menu.
-     */
-    class MenuItem {
-        /**
-         * @hidden
-         * Unique identifier for the menu item.
-         */
-        id: string;
-        /**
-         * @hidden
-         * Display title of the menu item.
-         */
-        title: string;
-        /**
-         * @hidden
-         * Display icon of the menu item. The icon value must be a string having SVG icon content.
-         */
-        icon: string;
-        /**
-         * @hidden
-         * Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
-         */
-        iconSelected?: string;
-        /**
-         * @hidden
-         * Additional information for accessibility.
-         */
-        contentDescription?: string;
-        /**
-         * @hidden
-         * State of the menu item
-         */
-        enabled: boolean;
-        /**
-         * @hidden
-         * Interface to show list of items on selection of menu item.
-         */
-        viewData?: ViewData;
-        /**
-         * @hidden
-         * Whether the menu item is selected or not
-         */
-        selected: boolean;
-        /**
-         * The Display Mode of the menu item.
-         * Default Behaviour would be DisplayMode.ifRoom if null.
-         * Refer {@link DisplayMode}
-         */
-        displayMode?: DisplayMode;
-    }
-    /**
-     * @hidden
-     * Represents information about view to show on Navigation Bar Menu item selection
-     */
-    interface ViewData {
-        /**
-         * @hidden
-         * Display header title of the item list.
-         */
-        listTitle?: string;
-        /**
-         * @hidden
-         * Type of the menu item.
-         */
-        listType: MenuListType;
-        /**
-         * @hidden
-         * Array of MenuItem. Icon value will be required for all items in the list.
-         */
-        listItems: MenuItem[];
-    }
-    /**
-     * @hidden
-     * Represents information about type of list to display in Navigation Bar Menu.
-     */
-    enum MenuListType {
-        dropDown = "dropDown",
-        popOver = "popOver"
-    }
-    /**
-     * @hidden
-     * Register navBarMenuItemPress, actionMenuItemPress, setModuleView handlers.
+    id: string;
+    /**
+     * @hidden
+     * Display title of the view.
      *
      * @internal
-     * Limited to Microsoft-internal use.
+     * Limited to Microsoft-internal use
      */
-    function initialize(): void;
+    title: string;
     /**
      * @hidden
-     * Registers list of view configurations and it's handler.
-     * Handler is responsible for listening selection of View Configuration.
+     * Additional information for accessibility.
      *
-     * @param viewConfig - List of view configurations. Minimum 1 value is required.
-     * @param handler - The handler to invoke when the user selects view configuration.
+     * @internal
+     * Limited to Microsoft-internal use
      */
-    function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
+    contentDescription?: string;
+}
+/**
+ * Defines how a menu item should appear in the NavBar.
+ */
+export declare enum DisplayMode {
+    /**
+     * Only place this item in the NavBar if there's room for it.
+     * If there's no room, item is shown in the overflow menu.
+     */
+    ifRoom = 0,
+    /**
+     * Never place this item in the NavBar.
+     * The item would always be shown in NavBar's overflow menu.
+     */
+    overflowOnly = 1
+}
+/**
+ * @hidden
+ * Represents information about menu item for Action Menu and Navigation Bar Menu.
+ */
+export declare class MenuItem {
     /**
      * @hidden
-     * Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
-     *
-     * @param items List of MenuItems for Navigation Bar Menu.
-     * @param handler The handler to invoke when the user selects menu item.
-     */
-    function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
-    /** Parameters used to create an action menu within an app */
-    interface ActionMenuParameters {
-        /**
-         * @hidden
-         * Display title for Action Menu
-         */
-        title: string;
-        /**
-         * @hidden
-         * List of MenuItems for Action Menu
-         */
-        items: MenuItem[];
-    }
-    /**
-     * @hidden
-     * Used to show Action Menu.
-     *
-     * @param params - Parameters for Menu Parameters
-     * @param handler - The handler to invoke when the user selects menu item.
+     * Unique identifier for the menu item.
      */
-    function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
+    id: string;
     /**
-     * Checks if the menus capability is supported by the host
-     * @returns boolean to represent whether the menus capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     * @hidden
+     * Display title of the menu item.
+     */
+    title: string;
+    /**
+     * @hidden
+     * Display icon of the menu item. The icon value must be a string having SVG icon content.
+     */
+    icon: string;
+    /**
+     * @hidden
+     * Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
+     */
+    iconSelected?: string;
+    /**
+     * @hidden
+     * Additional information for accessibility.
+     */
+    contentDescription?: string;
+    /**
+     * @hidden
+     * State of the menu item
      */
-    function isSupported(): boolean;
+    enabled: boolean;
+    /**
+     * @hidden
+     * Interface to show list of items on selection of menu item.
+     */
+    viewData?: ViewData;
+    /**
+     * @hidden
+     * Whether the menu item is selected or not
+     */
+    selected: boolean;
+    /**
+     * The Display Mode of the menu item.
+     * Default Behaviour would be DisplayMode.ifRoom if null.
+     * Refer {@link DisplayMode}
+     */
+    displayMode?: DisplayMode;
+}
+/**
+ * @hidden
+ * Represents information about view to show on Navigation Bar Menu item selection
+ */
+export interface ViewData {
+    /**
+     * @hidden
+     * Display header title of the item list.
+     */
+    listTitle?: string;
+    /**
+     * @hidden
+     * Type of the menu item.
+     */
+    listType: MenuListType;
+    /**
+     * @hidden
+     * Array of MenuItem. Icon value will be required for all items in the list.
+     */
+    listItems: MenuItem[];
+}
+/**
+ * @hidden
+ * Represents information about type of list to display in Navigation Bar Menu.
+ */
+export declare enum MenuListType {
+    dropDown = "dropDown",
+    popOver = "popOver"
+}
+/**
+ * @hidden
+ * Register navBarMenuItemPress, actionMenuItemPress, setModuleView handlers.
+ *
+ * @internal
+ * Limited to Microsoft-internal use.
+ */
+export declare function initialize(): void;
+/**
+ * @hidden
+ * Registers list of view configurations and it's handler.
+ * Handler is responsible for listening selection of View Configuration.
+ *
+ * @param viewConfig - List of view configurations. Minimum 1 value is required.
+ * @param handler - The handler to invoke when the user selects view configuration.
+ */
+export declare function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
+/**
+ * @hidden
+ * Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
+ *
+ * @param items List of MenuItems for Navigation Bar Menu.
+ * @param handler The handler to invoke when the user selects menu item.
+ */
+export declare function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
+/** Parameters used to create an action menu within an app */
+export interface ActionMenuParameters {
+    /**
+     * @hidden
+     * Display title for Action Menu
+     */
+    title: string;
+    /**
+     * @hidden
+     * List of MenuItems for Action Menu
+     */
+    items: MenuItem[];
 }
+/**
+ * @hidden
+ * Used to show Action Menu.
+ *
+ * @param params - Parameters for Menu Parameters
+ * @param handler - The handler to invoke when the user selects menu item.
+ */
+export declare function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
+/**
+ * Checks if the menus capability is supported by the host
+ * @returns boolean to represent whether the menus capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/monetization.d.ts

@@ -1,58 +1,64 @@
+/**
+ * @hidden
+ * Hidden from Docs
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
 import { SdkError } from './interfaces';
-export declare namespace monetization {
+/**
+ * @hidden
+ * Data structure to represent a subscription plan.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface PlanInfo {
     /**
      * @hidden
-     * Data structure to represent a subscription plan.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * plan id
      */
-    interface PlanInfo {
-        /**
-         * @hidden
-         * plan id
-         */
-        planId: string;
-        /**
-         * @hidden
-         * term of the plan
-         */
-        term: string;
-    }
+    planId: string;
     /**
      * @hidden
-     * Open dialog to start user's purchase experience
-     *
-     * @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
-     * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-     * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * term of the plan
      */
-    function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
-    /**
-     * @deprecated
-     * As of TeamsJS v2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
-     *
-     * @hidden
-     * Open dialog to start user's purchase experience
-     *
-     * @param callback Callback contains 1 parameters, error.
-     * @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
-     * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function openPurchaseExperience(callback: (error: SdkError | null) => void, planInfo?: PlanInfo): void;
-    /**
-     * @hidden
-     *
-     * Checks if the monetization capability is supported by the host
-     * @returns boolean to represent whether the monetization capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     */
-    function isSupported(): boolean;
+    term: string;
 }
+/**
+ * @hidden
+ * Open dialog to start user's purchase experience
+ *
+ * @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
+ * error can either contain an error of type SdkError, incase of an error, or null when get is successful
+ * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
+ *
+ * @hidden
+ * Open dialog to start user's purchase experience
+ *
+ * @param callback Callback contains 1 parameters, error.
+ * @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
+ * error can either contain an error of type SdkError, incase of an error, or null when get is successful
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function openPurchaseExperience(callback: (error: SdkError | null) => void, planInfo?: PlanInfo): void;
+/**
+ * @hidden
+ *
+ * Checks if the monetization capability is supported by the host
+ * @returns boolean to represent whether the monetization capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/navigation.d.ts

@@ -1,7 +1,8 @@
-import { TabInstance } from './interfaces';
 /**
  * Navigation specific part of the SDK.
+ * @module
  */
+import { TabInstance } from './interfaces';
 /** Navigation on complete handler function type */
 export type onCompleteHandlerFunctionType = (status: boolean, reason?: string) => void;
 /**

package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts

@@ -1,15 +1,14 @@
 /**
  * @beta
  * Nested app auth capabilities
+ * @module
  */
-export declare namespace nestedAppAuth {
-    /**
-     * Checks if MSAL-NAA channel recommended by the host
-     * @returns true if host is recommending NAA channel and false otherwise
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @beta
-     */
-    function isNAAChannelRecommended(): boolean;
-}
+/**
+ * Checks if MSAL-NAA channel recommended by the host
+ * @returns true if host is recommending NAA channel and false otherwise
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isNAAChannelRecommended(): boolean;

package/dist/esm/packages/teams-js/dts/public/pages/appButton.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Provides APIs to interact with the app button part of the SDK.
+ * @module
+ */
+import { handlerFunctionType } from './pages';
+/**
+ * Registers a handler for clicking the app button.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler - The handler to invoke when the personal app button is clicked in the app bar.
+ */
+export declare function onClick(handler: handlerFunctionType): void;
+/**
+ * Registers a handler for entering hover of the app button.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
+ */
+export declare function onHoverEnter(handler: handlerFunctionType): void;
+/**
+ * Registers a handler for exiting hover of the app button.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler - The handler to invoke when exiting hover of the personal app button in the app bar.
+ */
+export declare function onHoverLeave(handler: handlerFunctionType): void;
+/**
+ * Checks if pages.appButton capability is supported by the host
+ * @returns boolean to represent whether the pages.appButton capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/public/pages/backStack.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Provides APIs for handling the user's navigational history.
+ * @module
+ */
+import { backButtonHandlerFunctionType } from './pages';
+/**
+ * @hidden
+ * Register backButtonPress handler.
+ *
+ * @internal
+ * Limited to Microsoft-internal use.
+ */
+export declare function _initialize(): void;
+/**
+ * Navigates back in the hosted application. See {@link pages.backStack.registerBackButtonHandler} for notes on usage.
+ * @returns Promise that resolves when the navigation has completed.
+ */
+export declare function navigateBack(): Promise<void>;
+/**
+ * Registers a handler for user presses of the host client's back button. Experiences that maintain an internal
+ * navigation stack should use this handler to navigate the user back within their frame. If an application finds
+ * that after running its back button handler it cannot handle the event it should call the navigateBack
+ * method to ask the host client to handle it instead.
+ * @param handler - The handler to invoke when the user presses the host client's back button.
+ */
+export declare function registerBackButtonHandler(handler: backButtonHandlerFunctionType): void;
+/**
+ * @hidden
+ * Undocumented helper function with shared code between deprecated version and current version of the registerBackButtonHandler API.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param apiVersionTag - The tag indicating API version number with name
+ * @param handler - The handler to invoke when the user presses the host client's back button.
+ * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+ */
+export declare function registerBackButtonHandlerHelper(apiVersionTag: string, handler: () => boolean, versionSpecificHelper?: () => void): void;
+/**
+ * Checks if the pages.backStack capability is supported by the host
+ * @returns boolean to represent whether the pages.backStack capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;