@microsoft/teams-js 2.0.0-beta.3-dev.11 → 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>;
         /**

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.11';
+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,31 @@ 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) +
@@ -1808,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.
      *
@@ -1817,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.
@@ -1884,7 +1917,6 @@ var app_app;
             resolve(GlobalVars.initializePromise);
         });
     }
-    app.initialize = initialize;
     /**
      * @hidden
      * Hide from docs.