@microsoft/teams-js 2.4.0-beta.1 → 2.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
 
-This JavaScript library is part of the [Microsoft Teams developer platform](https://docs.microsoft.com/en-us/microsoftteams/platform/). See full [SDK reference documentation](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
+This JavaScript library is part of the [Microsoft Teams developer platform](https://learn.microsoft.com/microsoftteams/platform/). See full [SDK reference documentation](https://learn.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
 
 ## Getting Started
 
@@ -12,7 +12,7 @@ Whenever building or testing the Teams client SDK, you can run `yarn build` or `
 
 ## Installation
 
-To install the stable [version](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
+To install the stable [version](https://learn.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
 
 ### npm
 
@@ -24,7 +24,7 @@ To install the stable [version](https://docs.microsoft.com/javascript/api/overvi
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.3.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.4.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the SDK inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.3.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-LI9E631Gz4tFN2IFwM29y0lSXUgqhkoTtdiH4ghd6eNOA1lAzX9F+D8w1NnFF9xM"
+  src="https://res.cdn.office.net/teams-js/2.4.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-j7W8hHXQwShVeahI0Wmo/IDzHAYFCfOT6I/FEc9GzfriHk0ebQogvOx6bId6o9pL"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.3.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.4.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2793,7 +2793,7 @@ export interface ActionInfo {
     *
     * @remarks
     * For more details about the updated {@link app.Context} interface, visit the
-    * [Teams JavaScript client SDK](https://docs.microsoft.com/microsoftteams/platform/tabs/how-to/using-teams-client-sdk#updates-to-the-context-interface)
+    * [Teams JavaScript client SDK](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/using-teams-client-sdk#updates-to-the-context-interface)
     * overview article.
     *
     * Represents the structure of the received context message.
@@ -3863,8 +3863,7 @@ export namespace app {
             * Initializes the library.
             *
             * @remarks
-            * This must be called before any other SDK calls
-            * but after the frame is loaded successfully.
+            * Initialize must have completed successfully (as determined by the resolved Promise) before any other library calls are made
             *
             * @param validMessageOrigins - Optionally specify a list of cross frame message origins. They must have
             * https: protocol otherwise they will be ignored. Example: https:www.example.com
@@ -4114,7 +4113,7 @@ export namespace dialog {
             * Submit the dialog module and close the dialog
             *
             * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
-            * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
+            * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
             */
         function submit(result?: string | object, appIds?: string | string[]): void;
         /**
@@ -4686,6 +4685,53 @@ export namespace pages {
                     */
                 function isSupported(): boolean;
         }
+        /**
+            * Provides functions for navigating without needing to specify your application ID.
+            *
+            * @beta
+            */
+        namespace currentApp {
+                /**
+                    * Parameters for the NavigateWithinApp
+                    *
+                    * @beta
+                    */
+                interface NavigateWithinAppParams {
+                        /**
+                            * The developer-defined unique ID for the page defined in the manifest or when first configuring
+                            * the page. (Known as {entityId} prior to TeamsJS v.2.0.0)
+                            */
+                        pageId: string;
+                        /**
+                            * Optional developer-defined unique ID describing the content to navigate to within the page. This
+                            * can be retrieved from the Context object {@link app.PageInfo.subPageId | app.Context.page.subPageId}
+                            */
+                        subPageId?: string;
+                }
+                /**
+                    * Navigate within the currently running application with page ID, and sub-page ID (for navigating to
+                    * specific content within the page).
+                    * @param params - Parameters for the navigation
+                    * @returns a promise that will resolve if the navigation was successful
+                    *
+                    * @beta
+                    */
+                function navigateTo(params: NavigateWithinAppParams): Promise<void>;
+                /**
+                    * Navigate to the currently running application's first static page defined in the application
+                    * manifest.
+                    * @beta
+                    */
+                function navigateToDefaultPage(): Promise<void>;
+                /**
+                    * Checks if pages.currentApp capability is supported by the host
+                    * @returns true if the pages.currentApp capability is enabled in runtime.supports.pages.currentApp and
+                    * false if it is disabled
+                    *
+                    * @beta
+                    */
+                function isSupported(): boolean;
+        }
 }
 
 export interface IAppWindow {
@@ -5976,7 +6022,7 @@ export namespace profile {
                     *
                     * This id is guaranteed to be unique for an object within a tenant,
                     * and so if provided will lead to a more performant lookup. It can
-                    * be resolved via MS Graph (see https://docs.microsoft.com/en-us/graph/api/resources/users
+                    * be resolved via MS Graph (see https://learn.microsoft.com/graph/api/resources/users
                     * for examples).
                     */
                 readonly AadObjectId?: string;
@@ -6843,7 +6889,7 @@ export namespace tasks {
             * Submit the task module.
             *
             * @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
-            * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
+            * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
             */
         function submitTask(result?: string | object, appIds?: string | string[]): void;
         /**

package/dist/MicrosoftTeams.js

@@ -909,7 +909,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.4.0-beta.1";
+var version = "2.4.0";
 
 ;// CONCATENATED MODULE: ./src/internal/globalVars.ts
 var GlobalVars = /** @class */ (function () {
@@ -2241,10 +2241,11 @@ var runtime = {
         notifications: undefined,
         pages: {
             appButton: undefined,
-            tabs: undefined,
-            config: undefined,
             backStack: undefined,
+            config: undefined,
+            currentApp: undefined,
             fullTrust: undefined,
+            tabs: undefined,
         },
         people: undefined,
         permissions: undefined,
@@ -2483,7 +2484,7 @@ var dialog;
      * Submit the dialog module and close the dialog
      *
      * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
-     * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
+     * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
      */
     function submit(result, appIds) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
@@ -3033,8 +3034,7 @@ var app_app;
      * Initializes the library.
      *
      * @remarks
-     * This must be called before any other SDK calls
-     * but after the frame is loaded successfully.
+     * Initialize must have completed successfully (as determined by the resolved Promise) before any other library calls are made
      *
      * @param validMessageOrigins - Optionally specify a list of cross frame message origins. They must have
      * https: protocol otherwise they will be ignored. Example: https:www.example.com
@@ -3862,7 +3862,13 @@ var pages;
         backStack.registerBackButtonHandlerHelper = registerBackButtonHandlerHelper;
         function handleBackButtonPress() {
             if (!backButtonPressHandler || !backButtonPressHandler()) {
-                navigateBack();
+                if (Communication.childWindow) {
+                    // If the current window did not handle it let the child window
+                    sendMessageEventToChild('backButtonPress', []);
+                }
+                else {
+                    navigateBack();
+                }
             }
         }
         /**
@@ -3978,6 +3984,58 @@ var pages;
         }
         appButton.isSupported = isSupported;
     })(appButton = pages.appButton || (pages.appButton = {}));
+    /**
+     * Provides functions for navigating without needing to specify your application ID.
+     *
+     * @beta
+     */
+    var currentApp;
+    (function (currentApp) {
+        /**
+         * Navigate within the currently running application with page ID, and sub-page ID (for navigating to
+         * specific content within the page).
+         * @param params - Parameters for the navigation
+         * @returns a promise that will resolve if the navigation was successful
+         *
+         * @beta
+         */
+        function navigateTo(params) {
+            return new Promise(function (resolve) {
+                ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
+                resolve(sendAndHandleSdkError('pages.currentApp.navigateTo', params));
+            });
+        }
+        currentApp.navigateTo = navigateTo;
+        /**
+         * Navigate to the currently running application's first static page defined in the application
+         * manifest.
+         * @beta
+         */
+        function navigateToDefaultPage() {
+            return new Promise(function (resolve) {
+                ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
+                resolve(sendAndHandleSdkError('pages.currentApp.navigateToDefaultPage'));
+            });
+        }
+        currentApp.navigateToDefaultPage = navigateToDefaultPage;
+        /**
+         * Checks if pages.currentApp capability is supported by the host
+         * @returns true if the pages.currentApp capability is enabled in runtime.supports.pages.currentApp and
+         * false if it is disabled
+         *
+         * @beta
+         */
+        function isSupported() {
+            return runtime.supports.pages ? (runtime.supports.pages.currentApp ? true : false) : false;
+        }
+        currentApp.isSupported = isSupported;
+    })(currentApp = pages.currentApp || (pages.currentApp = {}));
 })(pages || (pages = {}));
 
 ;// CONCATENATED MODULE: ./src/internal/handlers.ts
@@ -4029,6 +4087,10 @@ function callHandler(name, args) {
         var result = handler.apply(this, args);
         return [true, result];
     }
+    else if (Communication.childWindow) {
+        sendMessageEventToChild(name, [args]);
+        return [false, undefined];
+    }
     else {
         callHandlerLogger('Handler for action message %s not found.', name);
         return [false, undefined];
@@ -4139,7 +4201,12 @@ function handleBeforeUnload() {
         sendMessageToParent('readyToUnload', []);
     };
     if (!HandlersPrivate.beforeUnloadHandler || !HandlersPrivate.beforeUnloadHandler(readyToUnload)) {
-        readyToUnload();
+        if (Communication.childWindow) {
+            sendMessageEventToChild('beforeUnload');
+        }
+        else {
+            readyToUnload();
+        }
     }
 }
 
@@ -7981,7 +8048,7 @@ var tasks;
      * Submit the task module.
      *
      * @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
-     * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
+     * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
      */
     function submitTask(result, appIds) {
         dialog.submit(result, appIds);