@microsoft/teams-js 2.16.0 → 2.17.0-beta.1

package/dist/MicrosoftTeams.js

@@ -2138,6 +2138,41 @@ var mapTeamsVersionToSupportedCapabilities = {
     ],
 };
 var generateBackCompatRuntimeConfigLogger = runtimeLogger.extend('generateBackCompatRuntimeConfig');
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * Merges the capabilities of two runtime objects. Fully supports arbitrarily nested capabilities/subcapabilities.
+ *
+ * Note that this function isn't actually doing anything specific to capabilities/runtime. It's just doing a
+ * generic merge of two objects.
+ *
+ * This function is NOT intended to handle objects that are NOT "shaped" like runtime objects. Specifically
+ * this means that it doesn't know how to merge values that aren't themselves objects. For example, it cannot
+ * properly handle situations where both objects contain a string or number with the same property name since the proper way to
+ * merge such values would be domain-dependent. For now it just happens to keep the value in the baseline and ignore the other.
+ * Since the runtime is only supposed to have objects, this limitation is fine.
+ *
+ * @param baselineRuntime the baseline runtime object
+ * @param runtimeToMergeIntoBaseline the runtime object to merge into the baseline
+ * @returns the merged runtime object which is the union of baselineRuntime and runtimeToMergeIntoBaseline
+ */
+function mergeRuntimeCapabilities(baselineRuntime, runtimeToMergeIntoBaseline) {
+    var merged = __assign({}, baselineRuntime);
+    for (var key in runtimeToMergeIntoBaseline) {
+        if (Object.prototype.hasOwnProperty.call(runtimeToMergeIntoBaseline, key)) {
+            if (typeof runtimeToMergeIntoBaseline[key] === 'object' && !Array.isArray(runtimeToMergeIntoBaseline[key])) {
+                merged[key] = mergeRuntimeCapabilities(baselineRuntime[key] || {}, runtimeToMergeIntoBaseline[key]);
+            }
+            else {
+                if (!(key in baselineRuntime)) {
+                    merged[key] = runtimeToMergeIntoBaseline[key];
+                }
+            }
+        }
+    }
+    return merged;
+}
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -2149,15 +2184,15 @@ var generateBackCompatRuntimeConfigLogger = runtimeLogger.extend('generateBackCo
  * @param highestSupportedVersion - The highest client SDK version that the host client can support.
  * @returns runtime which describes the APIs supported by the legacy host client.
  */
-function generateVersionBasedTeamsRuntimeConfig(highestSupportedVersion) {
+function generateVersionBasedTeamsRuntimeConfig(highestSupportedVersion, versionAgnosticRuntimeConfig, mapVersionToSupportedCapabilities) {
     generateBackCompatRuntimeConfigLogger('generating back compat runtime config for %s', highestSupportedVersion);
-    var newSupports = __assign({}, versionAndPlatformAgnosticTeamsRuntimeConfig.supports);
+    var newSupports = __assign({}, versionAgnosticRuntimeConfig.supports);
     generateBackCompatRuntimeConfigLogger('Supported capabilities in config before updating based on highestSupportedVersion: %o', newSupports);
-    Object.keys(mapTeamsVersionToSupportedCapabilities).forEach(function (versionNumber) {
+    Object.keys(mapVersionToSupportedCapabilities).forEach(function (versionNumber) {
         if (compareSDKVersions(highestSupportedVersion, versionNumber) >= 0) {
-            mapTeamsVersionToSupportedCapabilities[versionNumber].forEach(function (capabilityReqs) {
+            mapVersionToSupportedCapabilities[versionNumber].forEach(function (capabilityReqs) {
                 if (capabilityReqs.hostClientTypes.includes(GlobalVars.hostClientType)) {
-                    newSupports = __assign(__assign({}, newSupports), capabilityReqs.capability);
+                    newSupports = mergeRuntimeCapabilities(newSupports, capabilityReqs.capability);
                 }
             });
         }
@@ -2214,7 +2249,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.16.0";
+var version = "2.17.0-beta.1";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -3543,7 +3578,7 @@ var app;
                             }
                             catch (e) {
                                 if (e instanceof SyntaxError) {
-                                    applyRuntimeConfig(generateVersionBasedTeamsRuntimeConfig(GlobalVars.clientSupportedSDKVersion));
+                                    applyRuntimeConfig(generateVersionBasedTeamsRuntimeConfig(GlobalVars.clientSupportedSDKVersion, versionAndPlatformAgnosticTeamsRuntimeConfig, mapTeamsVersionToSupportedCapabilities));
                                 }
                                 else {
                                     throw e;
@@ -4612,8 +4647,6 @@ var HandlersPrivate = /** @class */ (function () {
         HandlersPrivate.handlers['themeChange'] = handleThemeChange;
         HandlersPrivate.handlers['load'] = handleLoad;
         HandlersPrivate.handlers['beforeUnload'] = handleBeforeUnload;
-        HandlersPrivate.handlers['beforeSuspendOrTerminate'] = handleBeforeSuspendOrTerminate;
-        HandlersPrivate.handlers['resume'] = handleResume;
         pages.backStack._initialize();
     };
     /**
@@ -4749,11 +4782,12 @@ function handlers_registerOnLoadHandler(handler) {
 /**
  * @internal
  * Limited to Microsoft-internal use
- *
- * @deprecated
  */
 function handleLoad(context) {
-    if (HandlersPrivate.loadHandler) {
+    if (HandlersPrivate.resumeHandler) {
+        HandlersPrivate.resumeHandler(context);
+    }
+    else if (HandlersPrivate.loadHandler) {
         HandlersPrivate.loadHandler(context);
     }
     if (Communication.childWindow) {
@@ -4773,14 +4807,21 @@ function handlers_registerBeforeUnloadHandler(handler) {
 /**
  * @internal
  * Limited to Microsoft-internal use
- *
- * @deprecated
  */
 function handleBeforeUnload() {
     var readyToUnload = function () {
         sendMessageToParent('readyToUnload', []);
     };
-    if (!HandlersPrivate.beforeUnloadHandler || !HandlersPrivate.beforeUnloadHandler(readyToUnload)) {
+    if (HandlersPrivate.beforeSuspendOrTerminateHandler) {
+        HandlersPrivate.beforeSuspendOrTerminateHandler();
+        if (Communication.childWindow) {
+            sendMessageEventToChild('beforeUnload');
+        }
+        else {
+            readyToUnload();
+        }
+    }
+    else if (!HandlersPrivate.beforeUnloadHandler || !HandlersPrivate.beforeUnloadHandler(readyToUnload)) {
         if (Communication.childWindow) {
             sendMessageEventToChild('beforeUnload');
         }
@@ -4795,45 +4836,15 @@ function handleBeforeUnload() {
  */
 function handlers_registerBeforeSuspendOrTerminateHandler(handler) {
     HandlersPrivate.beforeSuspendOrTerminateHandler = handler;
-    handler && sendMessageToParent('registerHandler', ['beforeSuspendOrTerminate']);
-}
-/**
- * @internal
- * Limited to Microsoft-internal use
- */
-function handleBeforeSuspendOrTerminate() {
-    var readyToSuspendOrTerminate = function () {
-        sendMessageToParent('readyToSuspendOrTerminate', []);
-    };
-    if (HandlersPrivate.beforeSuspendOrTerminateHandler) {
-        HandlersPrivate.beforeSuspendOrTerminateHandler();
-    }
-    if (Communication.childWindow) {
-        sendMessageEventToChild('beforeSuspendOrTerminate');
-    }
-    else {
-        readyToSuspendOrTerminate();
-    }
+    handler && sendMessageToParent('registerHandler', ['beforeUnload']);
 }
 /**
  * @internal
  * Limited to Microsoft-internal use
  */
 function handlers_registerOnResumeHandler(handler) {
-    HandlersPrivate.loadHandler = handler;
-    handler && sendMessageToParent('registerHandler', ['resume']);
-}
-/**
- * @internal
- * Limited to Microsoft-internal use
- */
-function handleResume(context) {
-    if (HandlersPrivate.loadHandler) {
-        HandlersPrivate.loadHandler(context);
-    }
-    if (Communication.childWindow) {
-        sendMessageEventToChild('resume', [context]);
-    }
+    HandlersPrivate.resumeHandler = handler;
+    handler && sendMessageToParent('registerHandler', ['load']);
 }
 
 ;// CONCATENATED MODULE: ./src/internal/communication.ts
@@ -8142,9 +8153,6 @@ var teamsCore;
      *
      * @param handler - The handler to invoke when the page is loaded.
      *
-     * @deprecated
-     * As of 2.14.1, please use {@link app.lifecycle.registerOnResumeHandler} instead.
-     *
      * @beta
      */
     function registerOnLoadHandler(handler) {
@@ -8185,7 +8193,6 @@ var teamsCore;
      * @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
      * invoke the readyToUnload function provided to it once it's ready to be unloaded.
      *
-     * @deprecated
      * @beta
      */
     function registerBeforeUnloadHandler(handler) {
@@ -9709,6 +9716,24 @@ var sharing;
  */
 var stageView;
 (function (stageView) {
+    /**
+     * The open mode for stage content.
+     */
+    var StageViewOpenMode;
+    (function (StageViewOpenMode) {
+        /**
+         * Open the content in a modal.
+         */
+        StageViewOpenMode["modal"] = "modal";
+        /**
+         * Open the content in a popped-out window.
+         */
+        StageViewOpenMode["popout"] = "popout";
+        /**
+         * Open the content in a popped-out window with chat collaboration.
+         */
+        StageViewOpenMode["popoutWithChat"] = "popoutWithChat";
+    })(StageViewOpenMode = stageView.StageViewOpenMode || (stageView.StageViewOpenMode = {}));
     /**
      * @hidden
      * Feature is under development