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

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

@@ -0,0 +1,188 @@
+/**
+ * Namespace to interact with the menu-specific part of the SDK.
+ * This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
+ */
+export declare namespace menus {
+    /**
+     * @hidden
+     * Represents information about item in View Configuration.
+     *
+     * @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.
+     *
+     * @internal
+     * Limited to Microsoft-internal use.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    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
+     */
+    function isSupported(): boolean;
+}

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

@@ -0,0 +1,58 @@
+import { SdkError } from './interfaces';
+export declare namespace monetization {
+    /**
+     * @hidden
+     * Data structure to represent a subscription plan.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    interface PlanInfo {
+        /**
+         * @hidden
+         * plan id
+         */
+        planId: string;
+        /**
+         * @hidden
+         * term of the plan
+         */
+        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
+     */
+    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;
+}

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

@@ -0,0 +1,45 @@
+import { TabInstance } from './interfaces';
+/**
+ * Navigation specific part of the SDK.
+ */
+/** Navigation on complete handler function type */
+export type onCompleteHandlerFunctionType = (status: boolean, reason?: string) => void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
+ *
+ * Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
+ *
+ * @param navigateForward - Determines the direction to focus in teams app.
+ */
+export declare function returnFocus(navigateForward?: boolean): void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
+ *
+ * Navigates the Microsoft Teams app to the specified tab instance.
+ *
+ * @param tabInstance - The tab instance to navigate to.
+ * @param onComplete - The callback to invoke when the action is complete.
+ */
+export declare function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteHandlerFunctionType): void;
+/**
+ * @deprecated
+ * As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript
+ * API, window.location.href, when navigating the app to a new cross-domain URL. Any URL
+ * that is redirected to must be listed in the validDomains block of the manifest. Please
+ * remove any calls to this API.
+ * @param url - The URL to navigate the frame to.
+ * @param onComplete - The callback to invoke when the action is complete.
+ */
+export declare function navigateCrossDomain(url: string, onComplete?: onCompleteHandlerFunctionType): void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
+ *
+ * Navigates back in the Teams client.
+ * See registerBackButtonHandler for more information on when it's appropriate to use this method.
+ *
+ * @param onComplete - The callback to invoke when the action is complete.
+ */
+export declare function navigateBack(onComplete?: onCompleteHandlerFunctionType): void;

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

@@ -0,0 +1,15 @@
+/**
+ * @beta
+ * Nested app auth capabilities
+ */
+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;
+}