@microsoft/teams-js 2.0.0-beta.3-dev.10 → 2.0.0-beta.3-dev.14

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.
 

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.
             */
@@ -4244,6 +4280,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
@@ -4253,7 +4303,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.10';
+var version = '2.0.0-beta.3-dev.14';
 /**
  * @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.
@@ -4482,6 +4550,7 @@ var video;
 
 
 
+
 /**
  * @alpha
  */
@@ -4490,88 +4559,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;