@microsoft/teams-js 2.4.2-beta.1 → 2.5.0-beta.0

package/dist/MicrosoftTeams.js

@@ -1133,7 +1133,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.4.2-beta.1";
+var version = "2.5.0-beta.0";
 
 ;// CONCATENATED MODULE: ./src/internal/globalVars.ts
 var GlobalVars = /** @class */ (function () {
@@ -1481,12 +1481,14 @@ var validOrigins = [
     'outlook.office365.com',
     'outlook-sdf.office365.com',
     '*.teams.microsoft.com',
+    '*.www.office.com',
     'www.office.com',
     'word.office.com',
     'excel.office.com',
     'powerpoint.office.com',
     'www.officeppe.com',
-    '*.www.office.com',
+    '*.www.microsoft365.com',
+    'www.microsoft365.com',
 ];
 /**
  * @hidden
@@ -1513,6 +1515,21 @@ var teamsDeepLinkProtocol = 'https';
  */
 var teamsDeepLinkHost = 'teams.microsoft.com';
 
+// EXTERNAL MODULE: ./node_modules/debug/src/browser.js
+var browser = __webpack_require__(227);
+;// CONCATENATED MODULE: ./src/internal/telemetry.ts
+
+var topLevelLogger = (0,browser.debug)('teamsJs');
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * Returns a logger for a given namespace, within the pre-defined top-level teamsJs namespace
+ */
+function getLogger(namespace) {
+    return topLevelLogger.extend(namespace);
+}
+
 // EXTERNAL MODULE: ../../node_modules/uuid/index.js
 var uuid = __webpack_require__(22);
 ;// CONCATENATED MODULE: ./src/internal/utils.ts
@@ -1846,7 +1863,33 @@ function createTeamsAppLink(params) {
 
 
 
+
+var internalLogger = getLogger('internal');
+var ensureInitializeCalledLogger = internalLogger.extend('ensureInitializeCalled');
+var ensureInitializedLogger = internalLogger.extend('ensureInitialized');
 /**
+ * Ensures `initialize` was called. This function does NOT verify that a response from Host was received and initialization completed.
+ *
+ * `ensureInitializeCalled` should only be used for APIs which:
+ * - work in all FrameContexts
+ * - are part of a required Capability
+ * - are suspected to be used directly after calling `initialize`, potentially without awaiting the `initialize` call itself
+ *
+ * For most APIs {@link ensureInitialized} is the right validation function to use instead.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function ensureInitializeCalled() {
+    if (!GlobalVars.initializeCalled) {
+        ensureInitializeCalledLogger('The library has not yet been initialized.');
+        throw new Error('The library has not yet been initialized');
+    }
+}
+/**
+ * Ensures `initialize` was called and response from Host was received and processed.
+ * If expected FrameContexts are provided, it also validates that the current FrameContext matches one of the expected ones.
+ *
  * @internal
  * Limited to Microsoft-internal use
  */
@@ -1855,10 +1898,11 @@ function ensureInitialized() {
     for (var _i = 0; _i < arguments.length; _i++) {
         expectedFrameContexts[_i] = arguments[_i];
     }
-    if (!GlobalVars.initializeCalled) {
+    if (!GlobalVars.initializeCompleted) {
+        ensureInitializedLogger('The library has not yet been initialized. initializeCalled: %s', GlobalVars.initializeCalled.toString());
         throw new Error('The library has not yet been initialized');
     }
-    if (GlobalVars.frameContext && expectedFrameContexts && expectedFrameContexts.length > 0) {
+    if (expectedFrameContexts && expectedFrameContexts.length > 0) {
         var found = false;
         for (var i = 0; i < expectedFrameContexts.length; i++) {
             if (expectedFrameContexts[i] === GlobalVars.frameContext) {
@@ -1943,21 +1987,6 @@ function processAdditionalValidOrigins(validMessageOrigins) {
     GlobalVars.additionalValidOrigins = combinedOriginUrls;
 }
 
-// EXTERNAL MODULE: ./node_modules/debug/src/browser.js
-var browser = __webpack_require__(227);
-;// CONCATENATED MODULE: ./src/internal/telemetry.ts
-
-var topLevelLogger = (0,browser.debug)('teamsJs');
-/**
- * @internal
- * Limited to Microsoft-internal use
- *
- * Returns a logger for a given namespace, within the pre-defined top-level teamsJs namespace
- */
-function getLogger(namespace) {
-    return topLevelLogger.extend(namespace);
-}
-
 ;// CONCATENATED MODULE: ./src/public/authentication.ts
 
 
@@ -1968,8 +1997,6 @@ function getLogger(namespace) {
  * Namespace to interact with the authentication-specific part of the SDK.
  *
  * This object is used for starting or completing authentication flows.
- *
- * @beta
  */
 var authentication;
 (function (authentication) {
@@ -2072,7 +2099,7 @@ var authentication;
         });
     }
     function getAuthToken(authTokenRequest) {
-        ensureInitialized();
+        ensureInitializeCalled();
         return getAuthTokenHelper(authTokenRequest)
             .then(function (value) {
             if (authTokenRequest && authTokenRequest.successCallback) {
@@ -2108,7 +2135,7 @@ var authentication;
         });
     }
     function getUser(userRequest) {
-        ensureInitialized();
+        ensureInitializeCalled();
         return getUserHelper()
             .then(function (value) {
             if (userRequest && userRequest.successCallback) {
@@ -2480,6 +2507,10 @@ var versionConstants = {
             capability: { webStorage: {} },
             hostClientTypes: [HostClientType.desktop],
         },
+        {
+            capability: { profile: {} },
+            hostClientTypes: [HostClientType.desktop, HostClientType.web],
+        },
     ],
     '2.0.5': [
         {
@@ -2575,6 +2606,8 @@ var dialog;
      * Function is called during app initialization
      * @internal
      * Limited to Microsoft-internal use
+     *
+     * @beta
      */
     function initialize() {
         registerHandler('messageForChild', handleDialogMessage, false);
@@ -2604,6 +2637,8 @@ var dialog;
      * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
      *
      * @returns a function that can be used to send messages to the dialog.
+     *
+     * @beta
      */
     function open(urlDialogInfo, submitHandler, messageFromChildHandler) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
@@ -2623,8 +2658,12 @@ var dialog;
     /**
      * Submit the dialog module and close the dialog
      *
-     * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
+     * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
+     *  If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
+     *
      * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
+     *
+     * @beta
      */
     function submit(result, appIds) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
@@ -2642,6 +2681,8 @@ var dialog;
      * This function is only called from inside of a dialog
      *
      * @param message - The message to send to the parent
+     *
+     * @beta
      */
     function sendMessageToParentFromDialog(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -2657,6 +2698,8 @@ var dialog;
      *  Send message to the dialog from the parent
      *
      * @param message - The message to send
+     *
+     * @beta
      */
     function sendMessageToDialog(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -2675,6 +2718,8 @@ var dialog;
      * This function is only called from inside of a dialog.
      *
      * @param listener - The listener that will be triggered.
+     *
+     * @beta
      */
     function registerOnMessageFromParent(listener) {
         ensureInitialized(FrameContexts.task);
@@ -2697,6 +2742,8 @@ var dialog;
      * Checks if dialog module is supported by the host
      *
      * @returns boolean to represent whether dialog module is supported
+     *
+     * @beta
      */
     function isSupported() {
         return runtime.supports.dialog ? true : false;
@@ -2704,6 +2751,8 @@ var dialog;
     dialog.isSupported = isSupported;
     /**
      * Namespace to update the dialog
+     *
+     * @beta
      */
     var update;
     (function (update) {
@@ -2711,6 +2760,8 @@ var dialog;
          * Update dimensions - height/width of a dialog.
          *
          * @param dimensions - An object containing width and height properties.
+         *
+         * @beta
          */
         function resize(dimensions) {
             ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
@@ -2724,6 +2775,8 @@ var dialog;
          * Checks if dialog.update capability is supported by the host
          *
          * @returns boolean to represent whether dialog.update is supported
+         *
+         * @beta
          */
         function isSupported() {
             return runtime.supports.dialog ? (runtime.supports.dialog.update ? true : false) : false;
@@ -2732,6 +2785,8 @@ var dialog;
     })(update = dialog.update || (dialog.update = {}));
     /**
      * Namespace to open a dialog that sends results to the bot framework
+     *
+     * @beta
      */
     var bot;
     (function (bot) {
@@ -2743,6 +2798,8 @@ var dialog;
          * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
          *
          * @returns a function that can be used to send messages to the dialog.
+         *
+         * @beta
          */
         function open(botUrlDialogInfo, submitHandler, messageFromChildHandler) {
             ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
@@ -2763,6 +2820,8 @@ var dialog;
          * Checks if dialog.bot capability is supported by the host
          *
          * @returns boolean to represent whether dialog.bot is supported
+         *
+         * @beta
          */
         function isSupported() {
             return runtime.supports.dialog ? (runtime.supports.dialog.bot ? true : false) : false;
@@ -2776,6 +2835,8 @@ var dialog;
      *
      * @internal
      * Limited to Microsoft-internal use
+     *
+     * @beta
      */
     function getDialogInfoFromUrlDialogInfo(urlDialogInfo) {
         var dialogInfo = {
@@ -2795,6 +2856,8 @@ var dialog;
      *
      * @internal
      * Limited to Microsoft-internal use
+     *
+     * @beta
      */
     function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo) {
         var dialogInfo = {
@@ -3016,7 +3079,8 @@ var teamsCore;
      * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
      */
     function registerOnLoadHandlerHelper(handler, versionSpecificHelper) {
-        ensureInitialized();
+        // allow for registration cleanup even when not finished initializing
+        handler && ensureInitialized();
         if (versionSpecificHelper) {
             versionSpecificHelper();
         }
@@ -3052,7 +3116,8 @@ var teamsCore;
      * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
      */
     function registerBeforeUnloadHandlerHelper(handler, versionSpecificHelper) {
-        ensureInitialized();
+        // allow for registration cleanup even when not finished initializing
+        handler && ensureInitialized();
         if (versionSpecificHelper) {
             versionSpecificHelper();
         }
@@ -3092,8 +3157,6 @@ var teamsCore;
 
 /**
  * Namespace to interact with app initialization and lifecycle.
- *
- * @beta
  */
 var app_app;
 (function (app) {
@@ -3155,7 +3218,7 @@ var app_app;
      * @returns whether the Teams client SDK has been initialized.
      */
     function isInitialized() {
-        return GlobalVars.initializeCalled;
+        return GlobalVars.initializeCompleted;
     }
     app.isInitialized = isInitialized;
     /**
@@ -3321,7 +3384,7 @@ var app_app;
      */
     function getContext() {
         return new Promise(function (resolve) {
-            ensureInitialized();
+            ensureInitializeCalled();
             resolve(sendAndUnwrap('getContext'));
         }).then(function (legacyContext) { return transformLegacyContextToAppContext(legacyContext); }); // converts globalcontext to app.context
     }
@@ -3330,7 +3393,7 @@ var app_app;
      * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
      */
     function notifyAppLoaded() {
-        ensureInitialized();
+        ensureInitializeCalled();
         sendMessageToParent(app.Messages.AppLoaded, [version]);
     }
     app.notifyAppLoaded = notifyAppLoaded;
@@ -3338,7 +3401,7 @@ var app_app;
      * Notifies the frame that app initialization is successful and is ready for user interaction.
      */
     function notifySuccess() {
-        ensureInitialized();
+        ensureInitializeCalled();
         sendMessageToParent(app.Messages.Success, [version]);
     }
     app.notifySuccess = notifySuccess;
@@ -3349,7 +3412,7 @@ var app_app;
      * during initialization as well as an optional message.
      */
     function notifyFailure(appInitializationFailedRequest) {
-        ensureInitialized();
+        ensureInitializeCalled();
         sendMessageToParent(app.Messages.Failure, [
             appInitializationFailedRequest.reason,
             appInitializationFailedRequest.message,
@@ -3362,7 +3425,7 @@ var app_app;
      * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
      */
     function notifyExpectedFailure(expectedFailureRequest) {
-        ensureInitialized();
+        ensureInitializeCalled();
         sendMessageToParent(app.Messages.ExpectedFailure, [expectedFailureRequest.reason, expectedFailureRequest.message]);
     }
     app.notifyExpectedFailure = notifyExpectedFailure;
@@ -3375,7 +3438,8 @@ var app_app;
      * @param handler - The handler to invoke when the user changes their theme.
      */
     function registerOnThemeChangeHandler(handler) {
-        ensureInitialized();
+        // allow for registration cleanup even when not called initialize
+        handler && ensureInitializeCalled();
         handlers_registerOnThemeChangeHandler(handler);
     }
     app.registerOnThemeChangeHandler = registerOnThemeChangeHandler;
@@ -3504,14 +3568,14 @@ function transformLegacyContextToAppContext(legacyContext) {
 
 /**
  * Navigation-specific part of the SDK.
- *
- * @beta
  */
 var pages;
 (function (pages) {
     /**
      * Return focus to the host. Will move focus forward or backward based on where the application container falls in
      * the F6/tab order in the host.
+     * On mobile hosts or hosts where there is no keyboard interaction or UI notion of "focus" this function has no
+     * effect and will be a no-op when called.
      * @param navigateForward - Determines the direction to focus in host.
      */
     function returnFocus(navigateForward) {
@@ -3526,6 +3590,8 @@ var pages;
      * @hidden
      *
      * Registers a handler for specifying focus when it passes from the host to the application.
+     * On mobile hosts or hosts where there is no UI notion of "focus" the handler registered with
+     * this function will never be called.
      *
      * @param handler - The handler for placing focus within the application.
      *
@@ -3628,6 +3694,7 @@ var pages;
     pages.navigateToApp = navigateToApp;
     /**
      * Shares a deep link that a user can use to navigate back to a specific state in this page.
+     * Please note that this method does yet work on mobile hosts.
      *
      * @param deepLinkParameters - ID and label for the link and fallback URL.
      */
@@ -3646,6 +3713,8 @@ var pages;
     /**
      * 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.
+     * On hosts where there is no support for making an app full screen, the handler registered
+     * with this function will never be called.
      * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
      */
     function registerFullScreenHandler(handler) {
@@ -3806,7 +3875,8 @@ var pages;
          * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
          */
         function registerOnSaveHandlerHelper(handler, versionSpecificHelper) {
-            ensureInitialized(FrameContexts.settings);
+            // allow for registration cleanup even when not finished initializing
+            handler && ensureInitialized(FrameContexts.settings);
             if (versionSpecificHelper) {
                 versionSpecificHelper();
             }
@@ -3840,7 +3910,8 @@ var pages;
          * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
          */
         function registerOnRemoveHandlerHelper(handler, versionSpecificHelper) {
-            ensureInitialized(FrameContexts.remove, FrameContexts.settings);
+            // allow for registration cleanup even when not finished initializing
+            handler && ensureInitialized(FrameContexts.remove, FrameContexts.settings);
             if (versionSpecificHelper) {
                 versionSpecificHelper();
             }
@@ -3998,7 +4069,8 @@ var pages;
          * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
          */
         function registerBackButtonHandlerHelper(handler, versionSpecificHelper) {
-            ensureInitialized();
+            // allow for registration cleanup even when not finished initializing
+            handler && ensureInitialized();
             if (versionSpecificHelper) {
                 versionSpecificHelper();
             }
@@ -4284,7 +4356,8 @@ function doesHandlerExist(name) {
  * @param registrationHelper - The helper function containing logic pertaining to a specific version of the API.
  */
 function registerHandlerHelper(name, handler, contexts, registrationHelper) {
-    ensureInitialized.apply(void 0, contexts);
+    // allow for registration cleanup even when not finished initializing
+    handler && ensureInitialized.apply(void 0, contexts);
     if (registrationHelper) {
         registrationHelper();
     }
@@ -4734,7 +4807,6 @@ function handleChildMessage(evt) {
         }
         else {
             // No handler, proxy to parent
-            // tslint:disable-next-line:no-any
             sendMessageToParent(message_1.func, message_1.args, function () {
                 var args = [];
                 for (var _i = 0; _i < arguments.length; _i++) {
@@ -4806,9 +4878,7 @@ function waitForMessageQueue(targetWindow, callback) {
  * @internal
  * Limited to Microsoft-internal use
  */
-function sendMessageResponseToChild(id, 
-// tslint:disable-next-line:no-any
-args, isPartialResponse) {
+function sendMessageResponseToChild(id, args, isPartialResponse) {
     var targetWindow = Communication.childWindow;
     /* eslint-disable-next-line strict-null-checks/all */ /* Fix tracked by 5730662 */
     var response = createMessageResponse(id, args, isPartialResponse);
@@ -4825,9 +4895,7 @@ args, isPartialResponse) {
  * @internal
  * Limited to Microsoft-internal use
  */
-function sendMessageEventToChild(actionName, 
-// tslint:disable-next-line: no-any
-args) {
+function sendMessageEventToChild(actionName, args) {
     var targetWindow = Communication.childWindow;
     /* eslint-disable-next-line strict-null-checks/all */ /* Fix tracked by 5730662 */
     var customEvent = createMessageEvent(actionName, args);
@@ -4845,7 +4913,6 @@ args) {
  * @internal
  * Limited to Microsoft-internal use
  */
-// tslint:disable-next-line:no-any
 function createMessageRequest(func, args) {
     return {
         id: CommunicationPrivate.nextMessageId++,
@@ -4858,7 +4925,6 @@ function createMessageRequest(func, args) {
  * @internal
  * Limited to Microsoft-internal use
  */
-// tslint:disable-next-line:no-any
 function createMessageResponse(id, args, isPartialResponse) {
     return {
         id: id,
@@ -4873,7 +4939,6 @@ function createMessageResponse(id, args, isPartialResponse) {
  * @internal
  * Limited to Microsoft-internal use
  */
-// tslint:disable-next-line:no-any
 function createMessageEvent(func, args) {
     return {
         func: func,
@@ -4908,7 +4973,8 @@ var logs;
      * Limited to Microsoft-internal use
      */
     function registerGetLogHandler(handler) {
-        ensureInitialized();
+        // allow for registration cleanup even when not finished initializing
+        handler && ensureInitialized();
         if (!isSupported()) {
             throw errorNotSupportedOnPlatform;
         }
@@ -5017,11 +5083,7 @@ function uploadCustomApp(manifestBlob, onComplete) {
  * @internal
  * Limited to Microsoft-internal use
  */
-function sendCustomMessage(actionName, 
-// tslint:disable-next-line:no-any
-args, 
-// tslint:disable-next-line:no-any
-callback) {
+function sendCustomMessage(actionName, args, callback) {
     ensureInitialized();
     sendMessageToParent(actionName, args, callback);
 }
@@ -5037,9 +5099,7 @@ callback) {
  * @internal
  * Limited to Microsoft-internal use
  */
-function sendCustomEvent(actionName, 
-// tslint:disable-next-line:no-any
-args) {
+function sendCustomEvent(actionName, args) {
     ensureInitialized();
     //validate childWindow
     if (!Communication.childWindow) {
@@ -6105,6 +6165,8 @@ var chat;
      * @param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
      *
      * @returns Promise resolved upon completion
+     *
+     * @beta
      */
     function openChat(openChatRequest) {
         return new Promise(function (resolve) {
@@ -6133,6 +6195,8 @@ var chat;
      * @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
      *
      * @returns Promise resolved upon completion
+     *
+     * @beta
      */
     function openGroupChat(openChatRequest) {
         return new Promise(function (resolve) {
@@ -6166,6 +6230,13 @@ var chat;
         });
     }
     chat.openGroupChat = openGroupChat;
+    /**
+     * Checks if chat capability is supported by the host
+     *
+     * @returns boolean to represent whether the chat capability is supported
+     *
+     * @beta
+     */
     function isSupported() {
         return runtime.supports.chat ? true : false;
     }
@@ -7018,6 +7089,8 @@ var profile;
      * Opens a profile card at a specified position to show profile information about a persona.
      * @param showProfileRequest The parameters to position the card and identify the target user.
      * @returns Promise that will be fulfilled when the operation has completed
+     *
+     * @beta
      */
     function showProfile(showProfileRequest) {
         ensureInitialized(FrameContexts.content);
@@ -7042,6 +7115,13 @@ var profile;
         });
     }
     profile.showProfile = showProfile;
+    /**
+     * Checks if the profile capability is supported by the host
+     *
+     * @returns boolean to represent whether the profile capability is supported
+     *
+     * @beta
+     */
     function isSupported() {
         return runtime.supports.profile ? true : false;
     }
@@ -7633,7 +7713,7 @@ function print() {
  * @param callback - The callback to invoke when the {@link Context} object is retrieved.
  */
 function getContext(callback) {
-    ensureInitialized();
+    ensureInitializeCalled();
     app_app.getContext().then(function (context) {
         if (callback) {
             callback(transformAppContextToLegacyContext(context));