@microsoft/teams-js 2.9.0 → 2.10.0-beta.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.9.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.9.1/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.9.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-wh4L8gn9alg8jFXiHwEw/IgcfK7aT/6Pyby/p5B7zHM+a0Jek5MxzO7AvSlRFvsC"
+  src="https://res.cdn.office.net/teams-js/2.9.1/js/MicrosoftTeams.min.js"
+  integrity="sha384-xnsUQ1tUqsrutBJl0vuf4/hufzLFWW8ZhGnhItfpQ0/BtWgM2uw6YT6BQ5YaKBSM"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.9.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.9.1/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2647,7 +2647,11 @@ export enum HostName {
         /**
             * Teams
             */
-        teams = "Teams"
+        teams = "Teams",
+        /**
+            * Modern Teams
+            */
+        teamsModern = "TeamsModern"
 }
 export enum FrameContexts {
         settings = "settings",
@@ -4243,7 +4247,15 @@ export namespace chat {
 export {};
 
 /**
-    * Namespace to interact with the dialog module-specific part of the SDK.
+    * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
+    * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
+    * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
+    *   - For URL dialogs, use the functions and interfaces in the {@link dialog.url} namespace.
+    * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
+    *   - For Adaptive Card dialogs, use the functions and interfaces in the {@link dialog.adaptiveCard} namespace.
+    *
+    * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
+    * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
     *
     * @beta
     */
@@ -4274,6 +4286,9 @@ export namespace dialog {
         /**
             * Handler used for receiving results when a dialog closes, either the value passed by {@linkcode url.submit}
             * or an error if the dialog was closed by the user.
+            *
+            * @see {@linkcode ISdkResponse}
+            *
             * @beta
             */
         type DialogSubmitHandler = (result: ISdkResponse) => void;
@@ -4406,14 +4421,11 @@ export namespace dialog {
                 function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
         }
         /**
-            * Checks if dialog capability is supported by the host
-            * @returns boolean to represent whether dialog capabilty is supported
+            * This function currently serves no purpose and should not be used. All functionality that used
+            * to be covered by this method is now in subcapabilities and those isSupported methods should be
+            * used directly.
             *
-            * @throws Error if {@linkcode app.initialize} has not successfully completed
-            *
-            * @throws Error if {@linkcode app.initialize} has not successfully completed
-            *
-            * @beta
+            * @hidden
             */
         function isSupported(): boolean;
         /**
@@ -7519,9 +7531,13 @@ export namespace settings {
 export namespace tasks {
         /**
             * @deprecated
-            * As of 2.8.0, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
-            * and {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot-based dialogs. In Teams,
-            * this function can be used for Adaptive Card-based dialogs. Support for Adaptive Card-based dialogs is coming to other hosts in the future.
+            * As of 2.8.0:
+            * - For url-based dialogs, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} .
+            * - For url-based dialogs with bot interaction, please use {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
+            * - For Adaptive Card-based dialogs:
+            *   - In Teams, please continue to use this function until the new functions in {@link dialog.adaptiveCard} have been fully implemented. You can tell at runtime when they are implemented in Teams by checking
+            *     the return value of the {@link dialog.adaptiveCard.isSupported} function. This documentation line will also be removed once they have been fully implemented in Teams.
+            *   - In all other hosts, please use {@link dialog.adaptiveCard.open dialog.adaptiveCard.open(cardDialogInfo: CardDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
             *
             * Allows an app to open the task module.
             *

package/dist/MicrosoftTeams.js

@@ -7,7 +7,7 @@
 		exports["microsoftTeams"] = factory();
 	else
 		root["microsoftTeams"] = factory();
-})(self, function() {
+})(self, () => {
 return /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
@@ -1477,6 +1477,10 @@ var HostName;
      * Teams
      */
     HostName["teams"] = "Teams";
+    /**
+     * Modern Teams
+     */
+    HostName["teamsModern"] = "TeamsModern";
 })(HostName || (HostName = {}));
 // Ensure these declarations stay in sync with the framework.
 var FrameContexts;
@@ -2151,7 +2155,7 @@ var _minRuntimeConfigToUninitialize = {
 };
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.9.0";
+var version = "2.10.0-beta.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -2713,7 +2717,15 @@ var authentication;
 
 
 /**
- * Namespace to interact with the dialog module-specific part of the SDK.
+ * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
+ * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
+ * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
+ *   - For URL dialogs, use the functions and interfaces in the {@link dialog.url} namespace.
+ * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
+ *   - For Adaptive Card dialogs, use the functions and interfaces in the {@link dialog.adaptiveCard} namespace.
+ *
+ * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
+ * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
  *
  * @beta
  */
@@ -2962,14 +2974,11 @@ var dialog;
         url.getDialogInfoFromBotUrlDialogInfo = getDialogInfoFromBotUrlDialogInfo;
     })(url = dialog.url || (dialog.url = {}));
     /**
-     * Checks if dialog capability is supported by the host
-     * @returns boolean to represent whether dialog capabilty is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     * This function currently serves no purpose and should not be used. All functionality that used
+     * to be covered by this method is now in subcapabilities and those isSupported methods should be
+     * used directly.
      *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @beta
+     * @hidden
      */
     function isSupported() {
         return ensureInitialized(runtime) && runtime.supports.dialog ? true : false;
@@ -9033,9 +9042,13 @@ var tasks;
 (function (tasks) {
     /**
      * @deprecated
-     * As of 2.8.0, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
-     * and {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot-based dialogs. In Teams,
-     * this function can be used for Adaptive Card-based dialogs. Support for Adaptive Card-based dialogs is coming to other hosts in the future.
+     * As of 2.8.0:
+     * - For url-based dialogs, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} .
+     * - For url-based dialogs with bot interaction, please use {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
+     * - For Adaptive Card-based dialogs:
+     *   - In Teams, please continue to use this function until the new functions in {@link dialog.adaptiveCard} have been fully implemented. You can tell at runtime when they are implemented in Teams by checking
+     *     the return value of the {@link dialog.adaptiveCard.isSupported} function. This documentation line will also be removed once they have been fully implemented in Teams.
+     *   - In all other hosts, please use {@link dialog.adaptiveCard.open dialog.adaptiveCard.open(cardDialogInfo: CardDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
      *
      * Allows an app to open the task module.
      *