@microsoft/teams-js 2.0.0-beta.4-dev.14 → 2.0.0-beta.4-dev.17

package/dist/MicrosoftTeams.d.ts

@@ -2109,6 +2109,39 @@ export interface DeepLinkParameters {
             */
         subEntityWebUrl?: string;
 }
+export interface DialogSize {
+        /**
+            * The requested height of the webview/iframe.
+            */
+        height: DialogDimension | number;
+        /**
+            * The requested width of the webview/iframe.
+            */
+        width: DialogDimension | number;
+}
+export interface UrlDialogInfo {
+        /**
+            * The url to be rendered in the webview/iframe.
+            */
+        url: string;
+        size: DialogSize;
+        /**
+            * Title of the task module.
+            */
+        title?: string;
+        /**
+            * If client doesnt support the URL, the URL that needs to be opened in the browser.
+            */
+        fallbackUrl?: string;
+}
+export interface BotUrlDialogInfo extends UrlDialogInfo {
+        /**
+            * Specifies a bot ID to send the result of the user's interaction with the task module.
+            * The bot will receive a task/complete invoke event with a JSON object
+            * in the event payload.
+            */
+        completionBotId: string;
+}
 export interface DialogInfo {
         /**
             * The url to be rendered in the webview/iframe.
@@ -2146,6 +2179,10 @@ export interface DialogInfo {
     * As of 2.0.0-beta.1, please use {@link DialogInfo} instead.
     */
 export type TaskInfo = DialogInfo;
+export interface DialogSize {
+        height: DialogDimension | number;
+        width: DialogDimension | number;
+}
 /**
     * @hidden
     * Hide from docs.
@@ -2749,20 +2786,23 @@ export namespace appInstallDialog {
     *
     * @beta
     */
+export interface SdkResponse {
+        err: string;
+        result: string | object;
+}
 export namespace dialog {
+        type PostMessageChannel = (message: any, onComplete?: (status: boolean, reason?: string) => void) => void;
+        type DialogSubmitHandler = (result: SdkResponse) => void;
         /**
             * Allows an app to open the dialog module.
             *
-            * @param dialogInfo - An object containing the parameters of the dialog module
-            * @param submitHandler - Handler to call when the task module is completed
-            */
-        function open(dialogInfo: DialogInfo, submitHandler?: (err: string, result: string | object) => void): IAppWindow;
-        /**
-            * Update height/width dialog info properties.
+            * @param urlDialogInfo - An object containing the parameters of the dialog module.
+            * @param submitHandler - This Handler is called when the dialog has been submitted or closed.
+            * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
             *
-            * @param dialogInfo - An object containing width and height properties
+            * @returns a function that can be used to send messages to the dialog.
             */
-        function resize(dialogInfo: DialogInfo): void;
+        function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel;
         /**
             * Submit the dialog module.
             *
@@ -2785,6 +2825,19 @@ export namespace dialog {
             */
         function registerOnMessageFromParent(listener: (message: any) => void): void;
         function isSupported(): boolean;
+        namespace update {
+                /**
+                    * Update dimensions - height/width of a dialog.
+                    *
+                    * @param dimensions - An object containing width and height properties.
+                    */
+                function resize(dimensions: DialogSize): void;
+                function isSupported(): boolean;
+        }
+        namespace bot {
+                function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel;
+                function isSupported(): boolean;
+        }
 }
 
 /**
@@ -5048,7 +5101,7 @@ export namespace settings {
 export namespace tasks {
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link dialog.open dialog.open(dialogInfo: DialogInfo, submitHandler?: (err: string, result: string) => void): IAppWindow} instead.
+            * As of 2.0.0-beta.4, please use {@link dialog.open(dialogInfo: DialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} instead.
             *
             * Allows an app to open the task module.
             *
@@ -5058,7 +5111,7 @@ export namespace tasks {
         function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string | object) => void): IAppWindow;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link dialog.resize dialog.resize(dialogInfo: DialogInfo): void} instead.
+            * As of 2.0.0-beta.4, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
             *
             * Update height/width task info properties.
             *
@@ -5075,5 +5128,8 @@ export namespace tasks {
             * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
             */
         function submitTask(result?: string | object, appIds?: string | string[]): void;
+        function getUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): UrlDialogInfo;
+        function getBotUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotUrlDialogInfo;
+        function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
 }
 

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.4-dev.14";
+var version = "2.0.0-beta.4-dev.17";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1820,7 +1820,10 @@ var runtime = {
         calendar: undefined,
         call: undefined,
         chat: undefined,
-        dialog: undefined,
+        dialog: {
+            bot: undefined,
+            update: undefined,
+        },
         location: undefined,
         logs: undefined,
         mail: undefined,
@@ -1856,7 +1859,10 @@ var teamsRuntimeConfig = {
         bot: {},
         call: {},
         chat: {},
-        dialog: {},
+        dialog: {
+            bot: {},
+            update: {},
+        },
         files: {},
         location: {},
         logs: {},
@@ -4247,6 +4253,124 @@ var appInstallDialog;
     appInstallDialog.isSupported = isSupported;
 })(appInstallDialog || (appInstallDialog = {}));
 
+;// 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 */
+
+
+
+
+
+
+var dialog;
+(function (dialog) {
+    /**
+     * Allows an app to open the dialog module.
+     *
+     * @param urlDialogInfo - An object containing the parameters of the dialog module.
+     * @param submitHandler - This Handler is called 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(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 });
+        });
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        var sendMessageToDialog = function (message, onComplete) {
+            sendMessageToParent('messageForChild', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
+        };
+        return sendMessageToDialog;
+    }
+    dialog.open = open;
+    /**
+     * Submit the dialog module.
+     *
+     * @param result - Contains 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, Array.isArray(appIds) ? appIds : [appIds]]);
+    }
+    dialog.submit = submit;
+    /**
+     *  Send message to the parent from dialog
+     *
+     * @param message - The message to send
+     * @param onComplete - The callback to know if the message to parent has been success/failed.
+     */
+    function sendMessageToParentFromDialog(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    message, onComplete) {
+        ensureInitialized(FrameContexts.task);
+        sendMessageToParent('messageForParent', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
+    }
+    dialog.sendMessageToParentFromDialog = sendMessageToParentFromDialog;
+    /**
+     * Fucntion to call when an event is received from the Parent
+     *
+     * @param type - The event to listen to. Currently the only supported type is 'message'.
+     * @param listener - listener - The listener that will be called.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    function registerOnMessageFromParent(listener) {
+        ensureInitialized();
+        registerHandler('messageForChild', listener);
+    }
+    dialog.registerOnMessageFromParent = registerOnMessageFromParent;
+    function isSupported() {
+        return runtime.supports.dialog ? true : false;
+    }
+    dialog.isSupported = isSupported;
+    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;
+        function isSupported() {
+            return runtime.supports.dialog ? (runtime.supports.dialog.update ? true : false) : false;
+        }
+        update.isSupported = isSupported;
+    })(update = dialog.update || (dialog.update = {}));
+    var bot;
+    (function (bot) {
+        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 });
+            });
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            var sendMessageToDialog = function (message, onComplete) {
+                sendMessageToParent('messageForChild', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
+            };
+            return sendMessageToDialog;
+        }
+        bot.open = open;
+        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 */
@@ -4319,109 +4443,6 @@ var ParentAppWindow = /** @class */ (function () {
 }());
 
 
-;// 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 */
-var __rest = (undefined && undefined.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-
-
-
-
-
-
-
-/**
- * Namespace to interact with the dialog module-specific part of the SDK.
- *
- * @remarks
- * This object is usable only on the content frame.
- *
- * @beta
- */
-var dialog;
-(function (dialog) {
-    /**
-     * Allows an app to open the dialog module.
-     *
-     * @param dialogInfo - An object containing the parameters of the dialog module
-     * @param submitHandler - Handler to call when the task module is completed
-     */
-    function open(dialogInfo, submitHandler) {
-        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
-        sendMessageToParent('tasks.startTask', [dialogInfo], submitHandler);
-        return new ChildAppWindow();
-    }
-    dialog.open = open;
-    /**
-     * Update height/width dialog info properties.
-     *
-     * @param dialogInfo - An object containing width and height properties
-     */
-    function resize(dialogInfo) {
-        ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
-        var width = dialogInfo.width, height = dialogInfo.height, extra = __rest(dialogInfo, ["width", "height"]);
-        if (!Object.keys(extra).length) {
-            sendMessageToParent('tasks.updateTask', [dialogInfo]);
-        }
-        else {
-            throw new Error('resize requires a dialogInfo argument containing only width and height');
-        }
-    }
-    dialog.resize = resize;
-    /**
-     * Submit the dialog module.
-     *
-     * @param result - Contains 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, Array.isArray(appIds) ? appIds : [appIds]]);
-    }
-    dialog.submit = submit;
-    /**
-     *  Send message to the parent from dialog
-     *
-     * @param message - The message to send
-     * @param onComplete - The callback to know if the message to parent has been success/failed.
-     */
-    function sendMessageToParentFromDialog(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    message, onComplete) {
-        ensureInitialized(FrameContexts.task);
-        sendMessageToParent('messageForParent', [message], onComplete ? onComplete : getGenericOnCompleteHandler());
-    }
-    dialog.sendMessageToParentFromDialog = sendMessageToParentFromDialog;
-    /**
-     * Fucntion to call when an event is received from the Parent
-     *
-     * @param type - The event to listen to. Currently the only supported type is 'message'.
-     * @param listener - listener - The listener that will be called.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    function registerOnMessageFromParent(listener) {
-        ensureInitialized();
-        registerHandler('messageForChild', listener);
-    }
-    dialog.registerOnMessageFromParent = registerOnMessageFromParent;
-    function isSupported() {
-        return runtime.supports.dialog ? true : false;
-    }
-    dialog.isSupported = isSupported;
-})(dialog || (dialog = {}));
-
 ;// CONCATENATED MODULE: ./src/internal/mediaUtil.ts
 
 
@@ -6322,6 +6343,20 @@ var settings;
 
 ;// CONCATENATED MODULE: ./src/public/tasks.ts
 /* eslint-disable @typescript-eslint/ban-types */
+var __rest = (undefined && undefined.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+
+
+
 
 
 /**
@@ -6336,7 +6371,7 @@ var tasks;
 (function (tasks) {
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link dialog.open dialog.open(dialogInfo: DialogInfo, submitHandler?: (err: string, result: string) => void): IAppWindow} instead.
+     * As of 2.0.0-beta.4, please use {@link dialog.open(dialogInfo: DialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} instead.
      *
      * Allows an app to open the task module.
      *
@@ -6344,19 +6379,40 @@ var tasks;
      * @param submitHandler - Handler to call when the task module is completed
      */
     function startTask(taskInfo, submitHandler) {
-        return dialog.open(getDialogInfoFromTaskInfo(taskInfo), submitHandler);
+        taskInfo = getDefaultSizeIfNotProvided(taskInfo);
+        if (taskInfo.card !== undefined || taskInfo.url === undefined) {
+            ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+            sendMessageToParent('tasks.startTask', [taskInfo], submitHandler);
+        }
+        else if (taskInfo.completionBotId !== undefined) {
+            dialog.bot.open(getBotUrlDialogInfoFromTaskInfo(taskInfo), function (sdkResponse) {
+                return submitHandler(sdkResponse.err, sdkResponse.result);
+            });
+        }
+        else {
+            dialog.open(getUrlDialogInfoFromTaskInfo(taskInfo), function (sdkResponse) {
+                return submitHandler(sdkResponse.err, sdkResponse.result);
+            });
+        }
+        return new ChildAppWindow();
     }
     tasks.startTask = startTask;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link dialog.resize dialog.resize(dialogInfo: DialogInfo): void} instead.
+     * As of 2.0.0-beta.4, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
      *
      * Update height/width task info properties.
      *
      * @param taskInfo - An object containing width and height properties
      */
     function updateTask(taskInfo) {
-        dialog.resize(taskInfo);
+        taskInfo = getDefaultSizeIfNotProvided(taskInfo);
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        var width = taskInfo.width, height = taskInfo.height, extra = __rest(taskInfo, ["width", "height"]);
+        if (Object.keys(extra).length) {
+            throw new Error('resize requires a TaskInfo argument containing only width and height');
+        }
+        dialog.update.resize(taskInfo);
     }
     tasks.updateTask = updateTask;
     /**
@@ -6372,35 +6428,39 @@ var tasks;
         dialog.submit(result, appIds);
     }
     tasks.submitTask = submitTask;
-    function getDialogInfoFromTaskInfo(taskInfo) {
-        var dialogHeight = taskInfo.height && typeof taskInfo.height !== 'number'
-            ? getDialogDimensionFromTaskModuleDimension(taskInfo.height)
-            : taskInfo.height;
-        var dialogWidth = taskInfo.width && typeof taskInfo.width !== 'number'
-            ? getDialogDimensionFromTaskModuleDimension(taskInfo.width)
-            : taskInfo.width;
-        var dialogInfo = {
+    function getUrlDialogInfoFromTaskInfo(taskInfo) {
+        var urldialogInfo = {
+            url: taskInfo.url,
+            size: {
+                height: taskInfo.height,
+                width: taskInfo.width,
+            },
+            title: taskInfo.title,
+            fallbackUrl: taskInfo.fallbackUrl,
+        };
+        return urldialogInfo;
+    }
+    tasks.getUrlDialogInfoFromTaskInfo = getUrlDialogInfoFromTaskInfo;
+    function getBotUrlDialogInfoFromTaskInfo(taskInfo) {
+        var botUrldialogInfo = {
             url: taskInfo.url,
-            card: taskInfo.card,
-            height: dialogHeight,
-            width: dialogWidth,
+            size: {
+                height: taskInfo.height,
+                width: taskInfo.width,
+            },
             title: taskInfo.title,
             fallbackUrl: taskInfo.fallbackUrl,
             completionBotId: taskInfo.completionBotId,
         };
-        return dialogInfo;
+        return botUrldialogInfo;
     }
-    function getDialogDimensionFromTaskModuleDimension(taskModuleDimension) {
-        if (taskModuleDimension === TaskModuleDimension.Large) {
-            return TaskModuleDimension.Large;
-        }
-        else if (taskModuleDimension === TaskModuleDimension.Medium) {
-            return TaskModuleDimension.Medium;
-        }
-        else {
-            return TaskModuleDimension.Small;
-        }
+    tasks.getBotUrlDialogInfoFromTaskInfo = getBotUrlDialogInfoFromTaskInfo;
+    function getDefaultSizeIfNotProvided(taskInfo) {
+        taskInfo.height = taskInfo.height ? taskInfo.height : TaskModuleDimension.Small;
+        taskInfo.width = taskInfo.width ? taskInfo.width : TaskModuleDimension.Small;
+        return taskInfo;
     }
+    tasks.getDefaultSizeIfNotProvided = getDefaultSizeIfNotProvided;
 })(tasks || (tasks = {}));
 
 ;// CONCATENATED MODULE: ./src/public/index.ts