@microsoft/teams-js 2.0.0-beta.3-dev.8 → 2.0.0-beta.3-dev.12

package/dist/MicrosoftTeams.d.ts

@@ -2717,7 +2717,7 @@ export namespace app {
             *
             * @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
-            * @returns Promise that will be fulfilled when initialization has completed
+            * @returns Promise that will be fulfilled when initialization has completed, or rejected if the initialization fails or times out
             */
         function initialize(validMessageOrigins?: string[]): Promise<void>;
         /**
@@ -2853,6 +2853,16 @@ export namespace pages {
             * @returns Promise that resolves when the navigation has completed.
             */
         function navigateCrossDomain(url: string): Promise<void>;
+        /**
+            * Navigate to the given App ID and Page ID, with optional parameters for a WebURL (if the app cannot
+            * be navigated to, such as if it is not installed), Channel ID (for apps installed as a channel tab), and
+            * Sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
+            * a deep link with the above data, but does not require the app to build a URL or worry about different
+            * deep link formats for different hosts.
+            * @param params Parameters for the navigation
+            * @returns a promise that will resolve if the navigation was successful
+            */
+        function navigateToApp(params: NavigateToAppParams): Promise<void>;
         /**
             * Registers a handler for changes from or to full-screen view for a tab.
             * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -2863,6 +2873,32 @@ export namespace pages {
             * Checks if page capability is supported currently
             */
         function isSupported(): boolean;
+        /**
+            * Parameters for the NavigateToApp API
+            */
+        interface NavigateToAppParams {
+                /**
+                    * ID of the App to navigate to
+                    */
+                appId: string;
+                /**
+                    * Developer-defined ID of the Page to navigate to within the app (Formerly EntityID)
+                    */
+                pageId: string;
+                /**
+                    * Optional URL to open if the navigation cannot be completed within the host
+                    */
+                webUrl?: string;
+                /**
+                    * Optional developer-defined ID describing the content to navigate to within the Page. This will be passed
+                    * back to the App via the Context object.
+                    */
+                subPageId?: string;
+                /**
+                    * Optional ID of the Teams Channel where the app should be opened
+                    */
+                channelId?: string;
+        }
         /**
             * Namespace to interact with the teams specific part of the SDK.
             */

package/dist/MicrosoftTeams.js

@@ -395,7 +395,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = '2.0.0-beta.3-dev.8';
+var version = '2.0.0-beta.3-dev.12';
 /**
  * @hidden
  * The SDK version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -780,6 +780,44 @@ function callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(funcHelp
     });
     return p;
 }
+/**
+ * A helper function to add a timeout to an asynchronous operation.
+ *
+ * @param action Action to wrap the timeout around
+ * @param timeoutInMs Timeout period in milliseconds
+ * @param timeoutError Error to reject the promise with if timeout elapses before the action completed
+ * @returns A promise which resolves to the result of provided action or rejects with a provided timeout error
+ * if the initial action didn't complete within provided timeout.
+ *
+ * @internal
+ */
+function runWithTimeout(action, timeoutInMs, timeoutError) {
+    return new Promise(function (resolve, reject) {
+        var timeoutHandle = setTimeout(reject, timeoutInMs, timeoutError);
+        action()
+            .then(function (result) {
+            clearTimeout(timeoutHandle);
+            resolve(result);
+        })
+            .catch(function (error) {
+            clearTimeout(timeoutHandle);
+            reject(error);
+        });
+    });
+}
+function createTeamsAppLink(params) {
+    var url = new URL('https://teams.microsoft.com/l/entity/' +
+        encodeURIComponent(params.appId) +
+        '/' +
+        encodeURIComponent(params.pageId));
+    if (params.webUrl) {
+        url.searchParams.append('webUrl', params.webUrl);
+    }
+    if (params.channelId || params.subPageId) {
+        url.searchParams.append('context', JSON.stringify({ channelId: params.channelId, subEntityId: params.subPageId }));
+    }
+    return url.toString();
+}
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -887,6 +925,7 @@ var runtime = {
 };
 var teamsRuntimeConfig = {
     apiVersion: 1,
+    isLegacyTeams: true,
     supports: {
         appInstallDialog: {},
         appEntity: {},
@@ -1794,6 +1833,10 @@ var app_app;
         return GlobalVars.frameContext;
     }
     app.getFrameContext = getFrameContext;
+    /**
+     * Number of milliseconds we'll give the initialization call to return before timing it out
+     */
+    var initializationTimeoutInMs = 5000;
     /**
      * Initializes the library.
      *
@@ -1803,9 +1846,13 @@ var app_app;
      *
      * @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
-     * @returns Promise that will be fulfilled when initialization has completed
+     * @returns Promise that will be fulfilled when initialization has completed, or rejected if the initialization fails or times out
      */
     function initialize(validMessageOrigins) {
+        return runWithTimeout(function () { return initializeHelper(validMessageOrigins); }, initializationTimeoutInMs, new Error('SDK initialization timed out.'));
+    }
+    app.initialize = initialize;
+    function initializeHelper(validMessageOrigins) {
         return new Promise(function (resolve) {
             // Independent components might not know whether the SDK is initialized so might call it to be safe.
             // Just no-op if that happens to make it easier to use.
@@ -1870,7 +1917,6 @@ var app_app;
             resolve(GlobalVars.initializePromise);
         });
     }
-    app.initialize = initialize;
     /**
      * @hidden
      * Hide from docs.
@@ -2110,6 +2156,7 @@ function transformLegacyContextToAppContext(legacyContext) {
 
 
 
+
 /**
  * Navigation specific part of the SDK.
  *
@@ -2154,6 +2201,27 @@ var pages;
         });
     }
     pages.navigateCrossDomain = navigateCrossDomain;
+    /**
+     * Navigate to the given App ID and Page ID, with optional parameters for a WebURL (if the app cannot
+     * be navigated to, such as if it is not installed), Channel ID (for apps installed as a channel tab), and
+     * Sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
+     * a deep link with the above data, but does not require the app to build a URL or worry about different
+     * deep link formats for different hosts.
+     * @param params Parameters for the navigation
+     * @returns a promise that will resolve if the navigation was successful
+     */
+    function navigateToApp(params) {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
+            if (runtime.isLegacyTeams) {
+                resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsAppLink(params)));
+            }
+            else {
+                resolve(sendAndHandleStatusAndReason('pages.navigateToApp', params));
+            }
+        });
+    }
+    pages.navigateToApp = navigateToApp;
     /**
      * Registers a handler for changes from or to full-screen view for a tab.
      * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.