@microsoft/teams-js 2.31.0 → 2.32.0-beta.0

package/dist/umd/MicrosoftTeams.js

@@ -837,6 +837,7 @@ __webpack_require__.d(__webpack_exports__, {
   ChannelType: () => (/* reexport */ ChannelType),
   ChildAppWindow: () => (/* reexport */ ChildAppWindow),
   DialogDimension: () => (/* reexport */ DialogDimension),
+  EduType: () => (/* reexport */ EduType),
   EmailAddress: () => (/* reexport */ EmailAddress),
   ErrorCode: () => (/* reexport */ ErrorCode),
   FileOpenPreference: () => (/* reexport */ FileOpenPreference),
@@ -926,6 +927,7 @@ __webpack_require__.d(__webpack_exports__, {
   shareDeepLink: () => (/* reexport */ publicAPIs_shareDeepLink),
   sharing: () => (/* reexport */ sharing_namespaceObject),
   stageView: () => (/* reexport */ stageView_namespaceObject),
+  store: () => (/* reexport */ store_namespaceObject),
   tasks: () => (/* reexport */ tasks_namespaceObject),
   teams: () => (/* reexport */ teams_namespaceObject),
   teamsCore: () => (/* reexport */ teamsAPIs_namespaceObject),
@@ -1327,6 +1329,7 @@ var otherAppStateChange_namespaceObject = {};
 __webpack_require__.r(otherAppStateChange_namespaceObject);
 __webpack_require__.d(otherAppStateChange_namespaceObject, {
   isSupported: () => (otherAppStateChange_isSupported),
+  notifyInstallCompleted: () => (notifyInstallCompleted),
   registerAppInstallationHandler: () => (registerAppInstallationHandler),
   unregisterAppInstallationHandler: () => (unregisterAppInstallationHandler)
 });
@@ -1433,6 +1436,18 @@ __webpack_require__.d(hostEntity_namespaceObject, {
   tab: () => (tab_namespaceObject)
 });
 
+// NAMESPACE OBJECT: ./src/private/store.ts
+var store_namespaceObject = {};
+__webpack_require__.r(store_namespaceObject);
+__webpack_require__.d(store_namespaceObject, {
+  StoreDialogType: () => (StoreDialogType),
+  errorInvalidDialogType: () => (errorInvalidDialogType),
+  errorMissingAppId: () => (errorMissingAppId),
+  errorMissingCollectionId: () => (errorMissingCollectionId),
+  isSupported: () => (store_isSupported),
+  openStoreExperience: () => (openStoreExperience)
+});
+
 // NAMESPACE OBJECT: ./src/public/appInstallDialog.ts
 var appInstallDialog_namespaceObject = {};
 __webpack_require__.r(appInstallDialog_namespaceObject);
@@ -3325,6 +3340,12 @@ const mapTeamsVersionToSupportedCapabilities = {
             hostClientTypes: [HostClientType.android, HostClientType.ios],
         },
     ],
+    '2.1.1': [
+        {
+            capability: { nestedAppAuth: {} },
+            hostClientTypes: [HostClientType.android, HostClientType.ios, HostClientType.ipados],
+        },
+    ],
 };
 const generateBackCompatRuntimeConfigLogger = runtimeLogger.extend('generateBackCompatRuntimeConfig');
 /**
@@ -3454,7 +3475,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.31.0";
+const version = "2.32.0-beta.0";
 
 ;// ./src/internal/internalAPIs.ts
 
@@ -4751,7 +4772,6 @@ var DataResidency;
 /**
  * Module to update the dialog
  *
- * @beta
  * @module
  */
 
@@ -4762,8 +4782,6 @@ var DataResidency;
  * Update dimensions - height/width of a dialog.
  *
  * @param dimensions - An object containing width and height properties.
- *
- * @beta
  */
 function resize(dimensions) {
     updateResizeHelper(getApiVersionTag(dialogTelemetryVersionNumber, "dialog.update.resize" /* ApiName.Dialog_Update_Resize */), dimensions);
@@ -4773,8 +4791,6 @@ function resize(dimensions) {
  * @returns boolean to represent whether dialog.update capabilty is supported
  *
  * @throws Error if {@linkcode app.initialize} has not successfully completed
- *
- * @beta
  */
 function update_isSupported() {
     return ensureInitialized(runtime) && runtime.supports.dialog
@@ -4788,7 +4804,6 @@ function update_isSupported() {
 /**
  * Module to open a dialog that sends results to the bot framework
  *
- * @beta
  * @module
  */
 
@@ -4803,8 +4818,6 @@ function update_isSupported() {
  * @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 bot_open(botUrlDialogInfo, submitHandler, messageFromChildHandler) {
     botUrlOpenHelper(getApiVersionTag(dialogTelemetryVersionNumber, "dialog.url.bot.open" /* ApiName.Dialog_Url_Bot_Open */), botUrlDialogInfo, submitHandler, messageFromChildHandler);
@@ -4815,8 +4828,6 @@ function bot_open(botUrlDialogInfo, submitHandler, messageFromChildHandler) {
  * @returns boolean to represent whether dialog.url.bot is supported
  *
  * @throws Error if {@linkcode app.initialize} has not successfully completed
- *
- * @beta
  */
 function bot_isSupported() {
     return (ensureInitialized(runtime) &&
@@ -4830,7 +4841,6 @@ function bot_isSupported() {
  * @remarks
  * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
  *
- * @beta
  * @module
  */
 
@@ -4847,8 +4857,6 @@ function bot_isSupported() {
  * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
  *
  * @param message - The message to send to the parent
- *
- * @beta
  */
 function sendMessageToParentFromDialog(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -4863,8 +4871,6 @@ message) {
  *  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
@@ -4882,8 +4888,6 @@ message) {
  * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
  *
  * @param listener - The listener that will be triggered.
- *
- * @beta
  */
 function registerOnMessageFromParent(listener) {
     ensureInitialized(runtime, FrameContexts.task);
@@ -4907,8 +4911,6 @@ function registerOnMessageFromParent(listener) {
  * @returns boolean to represent whether dialog.url.parentCommunication capability is supported
  *
  * @throws Error if {@linkcode app.initialize} has not successfully completed
- *
- * @beta
  */
 function parentCommunication_isSupported() {
     var _a, _b;
@@ -4933,8 +4935,6 @@ function parentCommunication_isSupported() {
  * @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.
- *
- * @beta
  */
 function url_open(urlDialogInfo, submitHandler, messageFromChildHandler) {
     urlOpenHelper(getApiVersionTag(dialogTelemetryVersionNumber, "dialog.url.open" /* ApiName.Dialog_Url_Open */), urlDialogInfo, submitHandler, messageFromChildHandler);
@@ -4949,8 +4949,6 @@ function url_open(urlDialogInfo, submitHandler, messageFromChildHandler) {
  *  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 url_submit(result, appIds) {
     urlSubmitHelper(getApiVersionTag(dialogTelemetryVersionNumber, "dialog.url.submit" /* ApiName.Dialog_Url_Submit */), result, appIds);
@@ -4961,8 +4959,6 @@ function url_submit(result, appIds) {
  * @returns boolean to represent whether dialog.url module is supported
  *
  * @throws Error if {@linkcode app.initialize} has not successfully completed
- *
- * @beta
  */
 function url_isSupported() {
     return ensureInitialized(runtime) && (runtime.supports.dialog && runtime.supports.dialog.url) !== undefined;
@@ -5111,7 +5107,6 @@ function handleDialogMessage(message) {
 /**
  * Module for interaction with adaptive card dialogs that need to communicate with the bot framework
  *
- * @beta
  * @module
  */
 
@@ -5126,8 +5121,6 @@ function handleDialogMessage(message) {
  *
  * @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
  * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
- *
- * @beta
  */
 function adaptiveCard_bot_open(botAdaptiveCardDialogInfo, submitHandler) {
     ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
@@ -5145,8 +5138,6 @@ function adaptiveCard_bot_open(botAdaptiveCardDialogInfo, submitHandler) {
  * @returns boolean to represent whether dialog.adaptiveCard.bot is supported
  *
  * @throws Error if {@linkcode app.initialize} has not successfully completed
- *
- * @beta
  */
 function adaptiveCard_bot_isSupported() {
     const isAdaptiveCardVersionSupported = runtime.hostVersionsInfo &&
@@ -5163,7 +5154,6 @@ function adaptiveCard_bot_isSupported() {
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /**
  * Subcapability for interacting with adaptive card dialogs
- * @beta
  * @module
  */
 
@@ -5182,8 +5172,6 @@ function adaptiveCard_bot_isSupported() {
  *
  * @param adaptiveCardDialogInfo - An object containing the parameters of the dialog module {@link AdaptiveCardDialogInfo}.
  * @param submitHandler - Handler that triggers when a dialog fires an [Action.Submit](https://adaptivecards.io/explorer/Action.Submit.html) or when the user closes the dialog.
- *
- * @beta
  */
 function adaptiveCard_open(adaptiveCardDialogInfo, submitHandler) {
     ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
@@ -5201,8 +5189,6 @@ function adaptiveCard_open(adaptiveCardDialogInfo, submitHandler) {
  * @returns boolean to represent whether dialog.adaptiveCard module is supported
  *
  * @throws Error if {@linkcode app.initialize} has not successfully completed
- *
- * @beta
  */
 function adaptiveCard_isSupported() {
     const isAdaptiveCardVersionSupported = runtime.hostVersionsInfo &&
@@ -5228,7 +5214,6 @@ function adaptiveCard_isSupported() {
  * @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
  * @module
  */
 
@@ -5247,8 +5232,6 @@ function adaptiveCard_isSupported() {
  * Function is called during app initialization
  * @internal
  * Limited to Microsoft-internal use
- *
- * @beta
  */
 function dialog_initialize() {
     registerHandler(getApiVersionTag(dialogTelemetryVersionNumber, "dialog.registerMessageForChildHandler" /* ApiName.Dialog_RegisterMessageForChildHandler */), 'messageForChild', handleDialogMessage, false);
@@ -9984,6 +9967,24 @@ function unregisterAppInstallationHandler() {
     sendMessageToParent(getApiVersionTag(otherAppStateChangeTelemetryVersionNumber, "otherApp.unregisterInstall" /* ApiName.OtherAppStateChange_UnregisterInstall */), "otherApp.unregisterInstall" /* ApiName.OtherAppStateChange_UnregisterInstall */);
     handlers_removeHandler("otherApp.install" /* ApiName.OtherAppStateChange_Install */);
 }
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * This function should be called by the Store App to notify the host that the
+ * app with the given appId has been installed.
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed or if the platform
+ * does not support the otherAppStateChange capability.
+ */
+function notifyInstallCompleted(appId) {
+    if (!otherAppStateChange_isSupported()) {
+        throw new Error(ErrorCode.NOT_SUPPORTED_ON_PLATFORM.toString());
+    }
+    return callFunctionInHost("otherApp.notifyInstallCompleted" /* ApiName.OtherAppStateChange_NotifyInstallCompleted */, [appId.toString()], getApiVersionTag(otherAppStateChangeTelemetryVersionNumber, "otherApp.notifyInstallCompleted" /* ApiName.OtherAppStateChange_NotifyInstallCompleted */));
+}
 /**
  * Checks if the otherAppStateChange capability is supported by the host
  * @returns boolean to represent whether the otherAppStateChange capability is supported
@@ -11969,6 +11970,123 @@ function hostEntity_isSupported() {
 }
 
 
+;// ./src/private/store.ts
+var store_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+
+
+
+
+
+
+/**
+ * @beta
+ * @hidden
+ * @module
+ * Namespace to open app store
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+const StoreVersionTagNum = "v2" /* ApiVersionNumber.V_2 */;
+/**
+ * @beta
+ * @hidden
+ * Enum of store dialog type
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var StoreDialogType;
+(function (StoreDialogType) {
+    /**
+     * open a store without navigation
+     */
+    StoreDialogType["FullStore"] = "fullstore";
+    /**
+     * open a store with navigation to a specific collection
+     */
+    StoreDialogType["SpecificStore"] = "specificstore";
+    /**
+     * open in-context-store
+     */
+    StoreDialogType["InContextStore"] = "ics";
+    /**
+     * open detail dialog (DD)
+     */
+    StoreDialogType["AppDetail"] = "appdetail";
+})(StoreDialogType || (StoreDialogType = {}));
+/**
+ * @beta
+ * @hidden
+ * error message when getting invalid store dialog type
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+const errorInvalidDialogType = 'Invalid store dialog type, but type needed to specify store to open';
+/**
+ * @beta
+ * @hidden
+ * error message when getting wrong app id or missing app id
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+const errorMissingAppId = 'No App Id present, but AppId needed to open AppDetail store';
+/**
+ * @beta
+ * @hidden
+ * error message when getting wrong collection id or missing collection id
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+const errorMissingCollectionId = 'No Collection Id present, but CollectionId needed to open a store specific to a collection';
+/**
+ * @beta
+ * @hidden
+ * Api to open a store
+ *
+ * @param openStoreParams - params to call openStoreExperience
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function openStoreExperience(openStoreParams) {
+    return store_awaiter(this, void 0, void 0, function* () {
+        ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+        if (!store_isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+        if (openStoreParams === undefined || !Object.values(StoreDialogType).includes(openStoreParams.dialogType)) {
+            throw new Error(errorInvalidDialogType);
+        }
+        if (openStoreParams.dialogType === StoreDialogType.AppDetail && !(openStoreParams.appId instanceof AppId)) {
+            throw new Error(errorMissingAppId);
+        }
+        if (openStoreParams.dialogType === StoreDialogType.SpecificStore && !openStoreParams.collectionId) {
+            throw new Error(errorMissingCollectionId);
+        }
+        return callFunctionInHost("store.open" /* ApiName.Store_Open */, [
+            openStoreParams.dialogType,
+            openStoreParams.appId,
+            openStoreParams.collectionId,
+        ], getApiVersionTag(StoreVersionTagNum, "store.open" /* ApiName.Store_Open */));
+    });
+}
+/**
+ * Checks if the store capability is supported by the host
+ * @returns boolean to represent whether the store capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+function store_isSupported() {
+    return ensureInitialized(runtime) && !!runtime.supports.store;
+}
+
 ;// ./src/private/index.ts
 
 
@@ -12005,6 +12123,8 @@ function hostEntity_isSupported() {
 
 
 
+
+
 
 
 
@@ -13144,6 +13264,8 @@ function clipboard_isSupported() {
  */
 
 
+
+
 /**
  * Checks if MSAL-NAA channel recommended by the host
  * @returns true if host is recommending NAA channel and false otherwise
@@ -13154,7 +13276,21 @@ function clipboard_isSupported() {
  */
 function isNAAChannelRecommended() {
     var _a;
-    return (_a = (ensureInitialized(runtime) && runtime.isNAAChannelRecommended)) !== null && _a !== void 0 ? _a : false;
+    return ((_a = (ensureInitialized(runtime) &&
+        (runtime.isNAAChannelRecommended || isNAAChannelRecommendedForLegacyTeamsMobile()))) !== null && _a !== void 0 ? _a : false);
+}
+function isNAAChannelRecommendedForLegacyTeamsMobile() {
+    return ensureInitialized(runtime) &&
+        isHostAndroidOrIOSOrIPadOS() &&
+        runtime.isLegacyTeams &&
+        runtime.supports.nestedAppAuth
+        ? true
+        : false;
+}
+function isHostAndroidOrIOSOrIPadOS() {
+    return (GlobalVars.hostClientType === HostClientType.android ||
+        GlobalVars.hostClientType === HostClientType.ios ||
+        GlobalVars.hostClientType === HostClientType.ipados);
 }
 
 ;// ./src/public/geoLocation/map.ts