@microsoft/teams-js 2.0.0-beta.3-dev.11 → 2.0.0-beta.3-dev.15

package/README.md

@@ -1,6 +1,6 @@
 # Microsoft Teams JavaScript client SDK
 
-Welcome to the Teams client SDK monorepo! For breaking changes, please refer to our changelog in the monorepo root.
+Welcome to the Teams client SDK monorepo! For breaking changes, please refer to our changelog in the monorepo root of the `2.0-preview` branch.
 
 This JavaScript library is part of the [Microsoft Teams developer platform](https://developer.microsoft.com/microsoft-teams/). See full [SDK reference documentation](https://docs.microsoft.com/en-us/javascript/api/overview/msteams-client).
 
@@ -11,8 +11,8 @@ This JavaScript library is part of the [Microsoft Teams developer platform](http
 
 1.  Clone the repo
 2.  Navigate to the repo root and run `yarn install`
-3.  `yarn build` from repo root
-4.  to run Unit test `yarn test`
+3.  Run `yarn build` from repo root
+4.  To run Unit tests, run `yarn test`
 
   TIP: whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
 
@@ -52,7 +52,7 @@ Reference the SDK inside of your `.html` page using:
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
   src="https://res.cdn.office.net/teams-js/2.0.0-beta.2/js/MicrosoftTeams.min.js"
-  integrity="sha384-Q2Z9S56exI6Oz/ThvYaV0SUn8j4HwS8BveGPmuwLXe4CvCUEGlL80qSzHMnvGqee"
+  integrity="sha384-RhShpWwRxSnc+keX0WZxCsf8olaKOOw416Jky+StW6qhctsNR3GMwav/hMB1Snas"
   crossorigin="anonymous"
 ></script>
 

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>;
         /**
@@ -3970,6 +3970,21 @@ export namespace monetization {
                 term: string;
         }
         /**
+            * @hidden
+            * Hide from docs
+            * 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
+            */
+        function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
+        /**
+            * @deprecated
+            * As of 2.0.0-beta.3, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
+            *
             * @hidden
             * Hide from docs
             * Open dialog to start user's purchase experience
@@ -4280,6 +4295,20 @@ export namespace sharing {
                 preview?: boolean;
         }
         /**
+            * @hidden
+            * Feature is under development
+            * Opens a share dialog for web content
+            *
+            * @param shareWebContentRequest - web content info
+            * @returns Promise that will be fulfilled when the operation has completed
+            *
+            * @internal
+            */
+        export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>;
+        /**
+            * @deprecated
+            * As of 2.0.0-beta.3, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
+            *
             * @hidden
             * Feature is under development
             * Opens a share dialog for web content
@@ -4289,7 +4318,7 @@ export namespace sharing {
             *
             * @internal
             */
-        export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>, callback?: (err?: SdkError) => void): void;
+        export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>, callback: (err?: SdkError) => void): void;
         export function isSupported(): boolean;
         export {};
 }

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.15';
 /**
  * @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.
@@ -2694,10 +2726,15 @@ function initializeCommunication(validMessageOrigins) {
         Communication.currentWindow.addEventListener('message', CommunicationPrivate.messageListener, false);
     }
     if (!Communication.parentWindow) {
-        GlobalVars.isFramelessWindow = true;
-        /* eslint-disable  @typescript-eslint/ban-ts-comment */
-        // @ts-ignore: window as ExtendedWindow
-        window.onNativeMessage = handleParentMessage;
+        var extendedWindow = Communication.currentWindow;
+        if (extendedWindow.nativeInterface) {
+            GlobalVars.isFramelessWindow = true;
+            extendedWindow.onNativeMessage = handleParentMessage;
+        }
+        else {
+            // at this point we weren't able to find a parent to talk to, no way initialization will succeed
+            return Promise.reject(new Error('Initialization Failed. No Parent window found.'));
+        }
     }
     try {
         // Send the initialized message to any origin, because at this point we most likely don't know the origin
@@ -4261,6 +4298,7 @@ var meeting;
 
 
 
+
 /**
  * @alpha
  */
@@ -4268,21 +4306,30 @@ var monetization;
 (function (monetization) {
     /**
      * @hidden
-     * Hide from docs
-     * 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
+     * This function is the overloaded implementation of openPurchaseExperience.
+     * Since the method signatures of the v1 callback and v2 promise differ in the type of the first parameter,
+     * we need to do an extra check to know the typeof the @param1 to set the proper arguments of the utility function.
+     * @param param1
+     * @param param2
+     * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
      */
-    function openPurchaseExperience(callback, planInfo) {
-        if (!callback) {
-            throw new Error('[open purchase experience] Callback cannot be null');
+    function openPurchaseExperience(param1, param2) {
+        var callback;
+        var planInfo;
+        if (typeof param1 === 'function') {
+            callback = param1;
+            planInfo = param2;
         }
+        else {
+            planInfo = param1;
+        }
+        var wrappedFunction = function () {
+            return new Promise(function (resolve) {
+                resolve(sendAndHandleSdkError('monetization.openPurchaseExperience', planInfo));
+            });
+        };
         ensureInitialized(FrameContexts.content);
-        sendMessageToParent('monetization.openPurchaseExperience', [planInfo], callback);
+        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(wrappedFunction, callback);
     }
     monetization.openPurchaseExperience = openPurchaseExperience;
     function isSupported() {
@@ -4518,6 +4565,7 @@ var video;
 
 
 
+
 /**
  * @alpha
  */
@@ -4526,88 +4574,74 @@ var sharing;
     sharing.SharingAPIMessages = {
         shareWebContent: 'sharing.shareWebContent',
     };
-    /**
-     * @hidden
-     * Feature is under development
-     * Opens a share dialog for web content
-     *
-     * @param shareWebContentRequest - web content info
-     * @param callback - optional callback
-     *
-     * @internal
-     */
     function shareWebContent(shareWebContentRequest, callback) {
-        if (!validateNonEmptyContent(shareWebContentRequest, callback)) {
-            return;
-        }
-        if (!validateTypeConsistency(shareWebContentRequest, callback)) {
-            return;
+        // validate the given input (synchronous check)
+        try {
+            validateNonEmptyContent(shareWebContentRequest);
+            validateTypeConsistency(shareWebContentRequest);
+            validateContentForSupportedTypes(shareWebContentRequest);
         }
-        if (!validateContentForSupportedTypes(shareWebContentRequest, callback)) {
-            return;
+        catch (err) {
+            //return the error via callback(v1) or rejected promise(v2)
+            var wrappedFunction = function () { return Promise.reject(err); };
+            return callCallbackWithSdkErrorFromPromiseAndReturnPromise(wrappedFunction, callback);
         }
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
-        sendMessageToParent(sharing.SharingAPIMessages.shareWebContent, [shareWebContentRequest], callback);
+        return callCallbackWithSdkErrorFromPromiseAndReturnPromise(shareWebContentHelper, callback, shareWebContentRequest);
     }
     sharing.shareWebContent = shareWebContent;
+    function shareWebContentHelper(shareWebContentRequest) {
+        return new Promise(function (resolve) {
+            resolve(sendAndHandleSdkError(sharing.SharingAPIMessages.shareWebContent, shareWebContentRequest));
+        });
+    }
     /**
-     * Error checks
+     * Functions for validating the shareRequest input parameter
      */
-    function validateNonEmptyContent(shareRequest, callback) {
+    function validateNonEmptyContent(shareRequest) {
         if (!(shareRequest && shareRequest.content && shareRequest.content.length)) {
-            if (callback) {
-                callback({
-                    errorCode: ErrorCode.INVALID_ARGUMENTS,
-                    message: 'Shared content is missing',
-                });
-            }
-            return false;
+            var err = {
+                errorCode: ErrorCode.INVALID_ARGUMENTS,
+                message: 'Shared content is missing',
+            };
+            throw err;
         }
-        return true;
     }
-    function validateTypeConsistency(shareRequest, callback) {
+    function validateTypeConsistency(shareRequest) {
+        var err;
         if (shareRequest.content.some(function (item) { return !item.type; })) {
-            if (callback) {
-                callback({
-                    errorCode: ErrorCode.INVALID_ARGUMENTS,
-                    message: 'Shared content type cannot be undefined',
-                });
-            }
-            return false;
+            err = {
+                errorCode: ErrorCode.INVALID_ARGUMENTS,
+                message: 'Shared content type cannot be undefined',
+            };
+            throw err;
         }
         if (shareRequest.content.some(function (item) { return item.type !== shareRequest.content[0].type; })) {
-            if (callback) {
-                callback({
-                    errorCode: ErrorCode.INVALID_ARGUMENTS,
-                    message: 'Shared content must be of the same type',
-                });
-            }
-            return false;
+            err = {
+                errorCode: ErrorCode.INVALID_ARGUMENTS,
+                message: 'Shared content must be of the same type',
+            };
+            throw err;
         }
-        return true;
     }
-    function validateContentForSupportedTypes(shareRequest, callback) {
+    function validateContentForSupportedTypes(shareRequest) {
+        var err;
         if (shareRequest.content[0].type === 'URL') {
             if (shareRequest.content.some(function (item) { return !item.url; })) {
-                if (callback) {
-                    callback({
-                        errorCode: ErrorCode.INVALID_ARGUMENTS,
-                        message: 'URLs are required for URL content types',
-                    });
-                }
-                return false;
+                err = {
+                    errorCode: ErrorCode.INVALID_ARGUMENTS,
+                    message: 'URLs are required for URL content types',
+                };
+                throw err;
             }
         }
         else {
-            if (callback) {
-                callback({
-                    errorCode: ErrorCode.INVALID_ARGUMENTS,
-                    message: 'Content type is unsupported',
-                });
-            }
-            return false;
+            err = {
+                errorCode: ErrorCode.INVALID_ARGUMENTS,
+                message: 'Content type is unsupported',
+            };
+            throw err;
         }
-        return true;
     }
     function isSupported() {
         return runtime.supports.sharing ? true : false;
@@ -4725,6 +4759,7 @@ var appInitialization;
 
 
 
+
 /**
  * @deprecated
  * As of 2.0.0-beta.1, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
@@ -4979,16 +5014,13 @@ function shareDeepLink(deepLinkParameters) {
  */
 function executeDeepLink(deepLink, onComplete) {
     ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
+    onComplete = onComplete ? onComplete : getGenericOnCompleteHandler();
     core.executeDeepLink(deepLink)
         .then(function () {
-        if (onComplete) {
-            onComplete(true);
-        }
+        onComplete(true);
     })
         .catch(function (err) {
-        if (onComplete) {
-            onComplete(false, err.message);
-        }
+        onComplete(false, err.message);
     });
 }
 /**
@@ -5095,6 +5127,7 @@ function transformAppContextToLegacyContext(appContext) {
 
 
 
+
 /**
  * Navigation specific part of the SDK.
  */
@@ -5120,16 +5153,13 @@ function returnFocus(navigateForward) {
  */
 function navigateToTab(tabInstance, onComplete) {
     ensureInitialized();
+    onComplete = onComplete ? onComplete : getGenericOnCompleteHandler();
     pages.tabs.navigateToTab(tabInstance)
         .then(function () {
-        if (onComplete) {
-            onComplete(true);
-        }
+        onComplete(true);
     })
         .catch(function (error) {
-        if (onComplete) {
-            onComplete(false, error.message);
-        }
+        onComplete(false, error.message);
     });
 }
 /**
@@ -5147,16 +5177,13 @@ function navigateToTab(tabInstance, onComplete) {
  */
 function navigateCrossDomain(url, onComplete) {
     ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.remove, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
+    onComplete = onComplete ? onComplete : getGenericOnCompleteHandler();
     pages.navigateCrossDomain(url)
         .then(function () {
-        if (onComplete) {
-            onComplete(true);
-        }
+        onComplete(true);
     })
         .catch(function (error) {
-        if (onComplete) {
-            onComplete(false, error.message);
-        }
+        onComplete(false, error.message);
     });
 }
 /**
@@ -5170,16 +5197,13 @@ function navigateCrossDomain(url, onComplete) {
  */
 function navigateBack(onComplete) {
     ensureInitialized();
+    onComplete = onComplete ? onComplete : getGenericOnCompleteHandler();
     pages.backStack.navigateBack()
         .then(function () {
-        if (onComplete) {
-            onComplete(true);
-        }
+        onComplete(true);
     })
         .catch(function (error) {
-        if (onComplete) {
-            onComplete(false, error.message);
-        }
+        onComplete(false, error.message);
     });
 }
 
@@ -5187,6 +5211,7 @@ function navigateBack(onComplete) {
 
 
 
+
 /**
  * @deprecated
  * As of 2.0.0-beta.1, please use {@link pages.config} namespace instead.
@@ -5235,16 +5260,13 @@ var settings;
      */
     function setSettings(instanceSettings, onComplete) {
         ensureInitialized(FrameContexts.content, FrameContexts.settings, FrameContexts.sidePanel);
+        onComplete = onComplete ? onComplete : getGenericOnCompleteHandler();
         pages.config.setConfig(instanceSettings)
             .then(function () {
-            if (onComplete) {
-                onComplete(true);
-            }
+            onComplete(true);
         })
             .catch(function (error) {
-            if (onComplete) {
-                onComplete(false, error.message);
-            }
+            onComplete(false, error.message);
         });
     }
     settings.setSettings = setSettings;