@microsoft/teams-js 2.0.0-beta.6-dev.2 → 2.0.0-beta.6-dev.5

package/dist/MicrosoftTeams.d.ts

@@ -2827,6 +2827,15 @@ export namespace dialog {
         }
         type PostMessageChannel = (message: any) => void;
         type DialogSubmitHandler = (result: ISdkResponse) => void;
+        /**
+            * @hidden
+            * Hide from docs because this function is only used during initialization
+            * ------------------
+            * Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
+            * Function is called during app intitialization
+            * @internal
+            */
+        function initialize(): void;
         /**
             * Allows app to open a url based dialog.
             *
@@ -2915,6 +2924,24 @@ export namespace dialog {
                     */
                 function isSupported(): boolean;
         }
+        /**
+            * @hidden
+            * Hide from docs
+            * --------
+            * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
+            *
+            * @internal
+            */
+        function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
+        /**
+            * @hidden
+            * Hide from docs
+            * --------
+            * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
+            *
+            * @internal
+            */
+        function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
 }
 
 /**

package/dist/MicrosoftTeams.js

@@ -1121,7 +1121,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.6-dev.2";
+var version = "2.0.0-beta.6-dev.5";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2467,6 +2467,245 @@ function applyRuntimeConfig(runtimeConfig) {
     runtime = deepFreeze(runtimeConfig);
 }
 
+;// CONCATENATED MODULE: ./src/public/dialog.ts
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/ban-types */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+
+
+
+
+
+/**
+ * Namespace to interact with the dialog module-specific part of the SDK.
+ *
+ * @beta
+ */
+var dialog;
+(function (dialog) {
+    var storedMessages = [];
+    /**
+     * @hidden
+     * Hide from docs because this function is only used during initialization
+     * ------------------
+     * Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
+     * Function is called during app intitialization
+     * @internal
+     */
+    function initialize() {
+        registerHandler('messageForChild', handleDialogMessage, false);
+    }
+    dialog.initialize = initialize;
+    function handleDialogMessage(message) {
+        if (!GlobalVars.frameContext) {
+            // GlobalVars.frameContext is currently not set
+            return;
+        }
+        if (GlobalVars.frameContext === FrameContexts.task) {
+            storedMessages.push(message);
+        }
+        else {
+            // Not in task FrameContext, remove 'messageForChild' handler
+            removeHandler('messageForChild');
+        }
+    }
+    /**
+     * Allows app to open a url based dialog.
+     *
+     * @remarks
+     * This function cannot be called from inside of a dialog
+     *
+     * @param urlDialogInfo - An object containing the parameters of the dialog module.
+     * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the 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.
+     */
+    function open(urlDialogInfo, submitHandler, messageFromChildHandler) {
+        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+        if (messageFromChildHandler) {
+            registerHandler('messageForParent', messageFromChildHandler);
+        }
+        var dialogInfo = getDialogInfoFromUrlDialogInfo(urlDialogInfo);
+        sendMessageToParent('tasks.startTask', [dialogInfo], function (err, result) {
+            submitHandler({ err: err, result: result });
+            removeHandler('messageForParent');
+        });
+    }
+    dialog.open = open;
+    /**
+     * Submit the dialog module.
+     *
+     * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
+     * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
+     */
+    function submit(result, appIds) {
+        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
+        // Send tasks.completeTask instead of tasks.submitTask message for backward compatibility with Mobile clients
+        sendMessageToParent('tasks.completeTask', [result, appIds ? (Array.isArray(appIds) ? appIds : [appIds]) : []]);
+    }
+    dialog.submit = submit;
+    /**
+     *  Send message to the parent from dialog
+     *
+     *  @remarks
+     * This function is only called from inside of a dialog
+     *
+     * @param message - The message to send to the parent
+     */
+    function sendMessageToParentFromDialog(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    message) {
+        ensureInitialized(FrameContexts.task);
+        sendMessageToParent('messageForParent', [message]);
+    }
+    dialog.sendMessageToParentFromDialog = sendMessageToParentFromDialog;
+    /**
+     *  Send message to the dialog from the parent
+     *
+     * @param message - The message to send
+     */
+    function sendMessageToDialog(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    message) {
+        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+        sendMessageToParent('messageForChild', [message]);
+    }
+    dialog.sendMessageToDialog = sendMessageToDialog;
+    /**
+     * Register a listener that will be triggered when a message is received from the app that opened the dialog.
+     *
+     * @remarks
+     * This function is only called from inside of a dialog.
+     *
+     * @param listener - The listener that will be triggered.
+     */
+    function registerOnMessageFromParent(listener) {
+        ensureInitialized(FrameContexts.task);
+        // We need to remove the original 'messageForChild'
+        // handler since the original does not allow for post messages.
+        // It is replaced by the user specified listener that is passed in.
+        removeHandler('messageForChild');
+        registerHandler('messageForChild', listener);
+        storedMessages.reverse();
+        while (storedMessages.length > 0) {
+            var message = storedMessages.pop();
+            listener(message);
+        }
+    }
+    dialog.registerOnMessageFromParent = registerOnMessageFromParent;
+    /**
+     * Checks if dialog module is supported by the host
+     *
+     * @returns boolean to represent whether dialog module is supported
+     */
+    function isSupported() {
+        return runtime.supports.dialog ? true : false;
+    }
+    dialog.isSupported = isSupported;
+    /**
+     * Namespace to update the dialog
+     */
+    var update;
+    (function (update) {
+        /**
+         * Update dimensions - height/width of a dialog.
+         *
+         * @param dimensions - An object containing width and height properties.
+         */
+        function resize(dimensions) {
+            ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
+            sendMessageToParent('tasks.updateTask', [dimensions]);
+        }
+        update.resize = resize;
+        /**
+         * Checks if dialog.update capability is supported by the host
+         *
+         * @returns boolean to represent whether dialog.update is supported
+         */
+        function isSupported() {
+            return runtime.supports.dialog ? (runtime.supports.dialog.update ? true : false) : false;
+        }
+        update.isSupported = isSupported;
+    })(update = dialog.update || (dialog.update = {}));
+    /**
+     * Namespace to open a dialog that sends results to the bot framework
+     */
+    var bot;
+    (function (bot) {
+        /**
+         * Allows an app to open the dialog module using bot.
+         *
+         * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
+         * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
+         * @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.
+         */
+        function open(botUrlDialogInfo, submitHandler, messageFromChildHandler) {
+            ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+            if (messageFromChildHandler) {
+                registerHandler('messageForParent', messageFromChildHandler);
+            }
+            var dialogInfo = getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo);
+            sendMessageToParent('tasks.startTask', [dialogInfo], function (err, result) {
+                submitHandler({ err: err, result: result });
+                removeHandler('messageForParent');
+            });
+        }
+        bot.open = open;
+        /**
+         * Checks if dialog.bot capability is supported by the host
+         *
+         * @returns boolean to represent whether dialog.bot is supported
+         */
+        function isSupported() {
+            return runtime.supports.dialog ? (runtime.supports.dialog.bot ? true : false) : false;
+        }
+        bot.isSupported = isSupported;
+    })(bot = dialog.bot || (dialog.bot = {}));
+    /**
+     * @hidden
+     * Hide from docs
+     * --------
+     * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
+     *
+     * @internal
+     */
+    function getDialogInfoFromUrlDialogInfo(urlDialogInfo) {
+        var dialogInfo = {
+            url: urlDialogInfo.url,
+            height: urlDialogInfo.size ? urlDialogInfo.size.height : DialogDimension.Small,
+            width: urlDialogInfo.size ? urlDialogInfo.size.width : DialogDimension.Small,
+            title: urlDialogInfo.title,
+            fallbackUrl: urlDialogInfo.fallbackUrl,
+        };
+        return dialogInfo;
+    }
+    dialog.getDialogInfoFromUrlDialogInfo = getDialogInfoFromUrlDialogInfo;
+    /**
+     * @hidden
+     * Hide from docs
+     * --------
+     * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
+     *
+     * @internal
+     */
+    function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo) {
+        var dialogInfo = {
+            url: botUrlDialogInfo.url,
+            height: botUrlDialogInfo.size ? botUrlDialogInfo.size.height : DialogDimension.Small,
+            width: botUrlDialogInfo.size ? botUrlDialogInfo.size.width : DialogDimension.Small,
+            title: botUrlDialogInfo.title,
+            fallbackUrl: botUrlDialogInfo.fallbackUrl,
+            completionBotId: botUrlDialogInfo.completionBotId,
+        };
+        return dialogInfo;
+    }
+    dialog.getDialogInfoFromBotUrlDialogInfo = getDialogInfoFromBotUrlDialogInfo;
+})(dialog || (dialog = {}));
+
 ;// CONCATENATED MODULE: ./src/public/menus.ts
 
 
@@ -2685,6 +2924,7 @@ var teamsCore;
 
 
 
+
 /**
  * Namespace to interact with app initialization and lifecycle.
  *
@@ -2809,6 +3049,7 @@ var app_app;
                 authentication.initialize();
                 menus.initialize();
                 pages.config.initialize();
+                dialog.initialize();
                 initializePrivateApis();
             }
             // Handle additional valid message origins if specified
@@ -4432,168 +4673,6 @@ var chat;
     chat.isSupported = isSupported;
 })(chat || (chat = {}));
 
-;// CONCATENATED MODULE: ./src/public/dialog.ts
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-/* eslint-disable @typescript-eslint/ban-types */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-
-
-
-
-
-/**
- * Namespace to interact with the dialog module-specific part of the SDK.
- *
- * @beta
- */
-var dialog;
-(function (dialog) {
-    /**
-     * Allows app to open a url based dialog.
-     *
-     * @remarks
-     * This function cannot be called from inside of a dialog
-     *
-     * @param urlDialogInfo - An object containing the parameters of the dialog module.
-     * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the 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.
-     */
-    function open(urlDialogInfo, submitHandler, messageFromChildHandler) {
-        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
-        if (messageFromChildHandler) {
-            registerHandler('messageForParent', messageFromChildHandler);
-        }
-        sendMessageToParent('tasks.startTask', [urlDialogInfo], function (err, result) {
-            submitHandler({ err: err, result: result });
-            removeHandler('messageForParent');
-        });
-    }
-    dialog.open = open;
-    /**
-     * Submit the dialog module.
-     *
-     * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
-     * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
-     */
-    function submit(result, appIds) {
-        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
-        // Send tasks.completeTask instead of tasks.submitTask message for backward compatibility with Mobile clients
-        sendMessageToParent('tasks.completeTask', [result, appIds ? (Array.isArray(appIds) ? appIds : [appIds]) : []]);
-    }
-    dialog.submit = submit;
-    /**
-     *  Send message to the parent from dialog
-     *
-     *  @remarks
-     * This function is only called from inside of a dialog
-     *
-     * @param message - The message to send to the parent
-     */
-    function sendMessageToParentFromDialog(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    message) {
-        ensureInitialized(FrameContexts.task);
-        sendMessageToParent('messageForParent', [message]);
-    }
-    dialog.sendMessageToParentFromDialog = sendMessageToParentFromDialog;
-    /**
-     *  Send message to the dialog from the parent
-     *
-     * @param message - The message to send
-     */
-    function sendMessageToDialog(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    message) {
-        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
-        sendMessageToParent('messageForChild', [message]);
-    }
-    dialog.sendMessageToDialog = sendMessageToDialog;
-    /**
-     * Register a listener that will be triggered when a message is received from the app that opened the dialog.
-     *
-     * @remarks
-     * This function is only called from inside of a dialog.
-     *
-     * @param listener - The listener that will be triggered.
-     */
-    function registerOnMessageFromParent(listener) {
-        ensureInitialized(FrameContexts.task);
-        registerHandler('messageForChild', listener);
-    }
-    dialog.registerOnMessageFromParent = registerOnMessageFromParent;
-    /**
-     * Checks if dialog module is supported by the host
-     *
-     * @returns boolean to represent whether dialog module is supported
-     */
-    function isSupported() {
-        return runtime.supports.dialog ? true : false;
-    }
-    dialog.isSupported = isSupported;
-    /**
-     * Namespace to update the dialog
-     */
-    var update;
-    (function (update) {
-        /**
-         * Update dimensions - height/width of a dialog.
-         *
-         * @param dimensions - An object containing width and height properties.
-         */
-        function resize(dimensions) {
-            ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
-            sendMessageToParent('tasks.updateTask', [dimensions]);
-        }
-        update.resize = resize;
-        /**
-         * Checks if dialog.update capability is supported by the host
-         *
-         * @returns boolean to represent whether dialog.update is supported
-         */
-        function isSupported() {
-            return runtime.supports.dialog ? (runtime.supports.dialog.update ? true : false) : false;
-        }
-        update.isSupported = isSupported;
-    })(update = dialog.update || (dialog.update = {}));
-    /**
-     * Namespace to open a dialog that sends results to the bot framework
-     */
-    var bot;
-    (function (bot) {
-        /**
-         * Allows an app to open the dialog module using bot.
-         *
-         * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
-         * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
-         * @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.
-         */
-        function open(botUrlDialogInfo, submitHandler, messageFromChildHandler) {
-            ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
-            if (messageFromChildHandler) {
-                registerHandler('messageForParent', messageFromChildHandler);
-            }
-            sendMessageToParent('tasks.startTask', [botUrlDialogInfo], function (err, result) {
-                submitHandler({ err: err, result: result });
-                removeHandler('messageForParent');
-            });
-        }
-        bot.open = open;
-        /**
-         * Checks if dialog.bot capability is supported by the host
-         *
-         * @returns boolean to represent whether dialog.bot is supported
-         */
-        function isSupported() {
-            return runtime.supports.dialog ? (runtime.supports.dialog.bot ? true : false) : false;
-        }
-        bot.isSupported = isSupported;
-    })(bot = dialog.bot || (dialog.bot = {}));
-})(dialog || (dialog = {}));
-
 ;// CONCATENATED MODULE: ./src/public/appWindow.ts
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -7108,6 +7187,9 @@ var legacy;
             function getUserJoinedTeams(teamInstanceParameters) {
                 return new Promise(function (resolve) {
                     ensureInitialized();
+                    if (!isSupported()) {
+                        throw errorNotSupportedOnPlatform;
+                    }
                     if ((GlobalVars.hostClientType === HostClientType.android ||
                         GlobalVars.hostClientType === HostClientType.teamsRoomsAndroid ||
                         GlobalVars.hostClientType === HostClientType.teamsPhones ||
@@ -7143,6 +7225,9 @@ var legacy;
         function getConfigSetting(key) {
             return new Promise(function (resolve) {
                 ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 resolve(sendAndUnwrap('getConfigSetting', key));
             });
         }
@@ -7286,6 +7371,9 @@ var notifications;
      */
     function showNotification(showNotificationParameters) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('notifications.showNotification', [showNotificationParameters]);
     }
     notifications.showNotification = showNotification;