@microsoft/teams-js 2.41.0 → 2.43.0

package/dist/umd/MicrosoftTeams.js

@@ -1093,6 +1093,7 @@ __webpack_require__.d(__webpack_exports__, {
   settings: () => (/* reexport */ settings_namespaceObject),
   shareDeepLink: () => (/* reexport */ publicAPIs_shareDeepLink),
   sharing: () => (/* reexport */ sharing_namespaceObject),
+  shortcutRelay: () => (/* reexport */ shortcutRelay_namespaceObject),
   sidePanelInterfaces: () => (/* reexport */ sidePanelInterfaces_namespaceObject),
   stageView: () => (/* reexport */ stageView_namespaceObject),
   store: () => (/* reexport */ store_namespaceObject),
@@ -2037,6 +2038,17 @@ __webpack_require__.d(marketplace_namespaceObject, {
   updateCartStatus: () => (updateCartStatus)
 });
 
+// NAMESPACE OBJECT: ./src/public/shortcutRelay.ts
+var shortcutRelay_namespaceObject = {};
+__webpack_require__.r(shortcutRelay_namespaceObject);
+__webpack_require__.d(shortcutRelay_namespaceObject, {
+  DISABLE_SHORTCUT_FORWARDING_ATTRIBUTE: () => (DISABLE_SHORTCUT_FORWARDING_ATTRIBUTE),
+  enableShortcutRelayCapability: () => (enableShortcutRelayCapability),
+  isSupported: () => (shortcutRelay_isSupported),
+  resetIsShortcutRelayCapabilityEnabled: () => (resetIsShortcutRelayCapabilityEnabled),
+  setOverridableShortcutHandler: () => (setOverridableShortcutHandler)
+});
+
 ;// ./src/public/interfaces.ts
 /* eslint-disable @typescript-eslint/no-explicit-any*/
 /**
@@ -2211,7 +2223,12 @@ var LegalAgeGroupClassification;
      * United Kingdom, European Union, or South Korea, and the user's age is between a minor and an adult age
      * (as stipulated based on country or region). Generally, this means that teenagers are considered as notAdult in regulated countries.
      */
-    LegalAgeGroupClassification["NonAdult"] = "nonAdult";
+    LegalAgeGroupClassification["NotAdult"] = "notAdult";
+    /**
+     * @deprecated To provide back compatibility for the NonAdult enum value coming from the hubs
+     */
+    //  eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
+    LegalAgeGroupClassification["NonAdult"] = "notAdult";
 })(LegalAgeGroupClassification || (LegalAgeGroupClassification = {}));
 /**
  * @hidden
@@ -2245,7 +2262,7 @@ var ClipboardSupportedMimeType;
 })(ClipboardSupportedMimeType || (ClipboardSupportedMimeType = {}));
 
 ;// ./src/artifactsForCDN/validDomains.json
-const validDomains_namespaceObject = /*#__PURE__*/JSON.parse('{"validOrigins":["teams.microsoft.com","teams.microsoft.us","gov.teams.microsoft.us","dod.teams.microsoft.us","int.teams.microsoft.com","outlook.office.com","outlook-sdf.office.com","outlook.office365.com","outlook-sdf.office365.com","outlook.live.com","outlook-sdf.live.com","teams.live.com","local.teams.live.com","local.teams.live.com:8080","local.teams.office.com","local.teams.office.com:8080","devspaces.skype.com","*.www.office.com","www.office.com","word.office.com","excel.office.com","powerpoint.office.com","www.officeppe.com","*.www.microsoft365.com","www.microsoft365.com","bing.com","edgeservices.bing.com","work.bing.com","www.bing.com","www.staging-bing-int.com","*.cloud.microsoft","*.m365.cloud.microsoft","*.outlook.cloud.microsoft","chatuxmanager.svc.cloud.microsoft","copilot.microsoft.com","windows.msn.com","fa000000125.resources.office.net","fa000000129.resources.office.net","fa000000124.resources.office.net","fa000000128.resources.office.net","fa000000136.resources.office.net"]}');
+const validDomains_namespaceObject = /*#__PURE__*/JSON.parse('{"validOrigins":["teams.microsoft.com","teams.microsoft.us","gov.teams.microsoft.us","dod.teams.microsoft.us","int.teams.microsoft.com","outlook.office.com","outlook-sdf.office.com","outlook.office365.com","outlook-sdf.office365.com","outlook.office365.us","outlook-dod.office365.us","webmail.apps.mil","outlook.live.com","outlook-sdf.live.com","teams.live.com","local.teams.live.com","local.teams.live.com:8080","local.teams.office.com","local.teams.office.com:8080","devspaces.skype.com","*.www.office.com","www.office.com","word.office.com","excel.office.com","powerpoint.office.com","www.officeppe.com","*.www.microsoft365.com","www.microsoft365.com","bing.com","edgeservices.bing.com","work.bing.com","www.bing.com","www.staging-bing-int.com","*.cloud.microsoft","*.m365.cloud.microsoft","*.outlook.cloud.microsoft","chatuxmanager.svc.cloud.microsoft","copilot.microsoft.com","windows.msn.com","fa000000125.resources.office.net","fa000000129.resources.office.net","fa000000124.resources.office.net","fa000000128.resources.office.net","fa000000136.resources.office.net","fa000000125.officeapps.live.com","fa000000129.officeapps.live.com","fa000000124.officeapps.live.com","fa000000128.officeapps.live.com"]}');
 var artifactsForCDN_validDomains_namespaceObject = /*#__PURE__*/__webpack_require__.t(validDomains_namespaceObject, 2);
 ;// ./src/internal/constants.ts
 
@@ -3597,6 +3614,7 @@ const errorInvalidResponse = new Error('Invalid response: Received more images t
 
 
 
+
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -4074,6 +4092,25 @@ function isPrimitiveOrPlainObject(value, depth = 0) {
     // Check all properties of the object recursively
     return Object.keys(value).every((key) => isPrimitiveOrPlainObject(value[key], depth + 1));
 }
+/**
+ * Normalizes legacy ageGroup values for backward compatibility
+ * @param runtimeConfig - The runtime configuration object to normalize
+ * @returns A new IBaseRuntime object with normalized ageGroup values
+ */
+function normalizeAgeGroupValue(runtimeConfig) {
+    var _a, _b;
+    // If no ageGroup exists, return the original config
+    if (!((_b = (_a = runtimeConfig.hostVersionsInfo) === null || _a === void 0 ? void 0 : _a.appEligibilityInformation) === null || _b === void 0 ? void 0 : _b.ageGroup)) {
+        return runtimeConfig;
+    }
+    const ageGroup = runtimeConfig.hostVersionsInfo.appEligibilityInformation.ageGroup;
+    // If the ageGroup doesn't need normalization, return the original config
+    if ((ageGroup === null || ageGroup === void 0 ? void 0 : ageGroup.toLowerCase()) !== 'nonadult') {
+        return runtimeConfig;
+    }
+    // Create a new config with the normalized ageGroup value
+    return Object.assign(Object.assign({}, runtimeConfig), { hostVersionsInfo: Object.assign(Object.assign({}, runtimeConfig.hostVersionsInfo), { appEligibilityInformation: Object.assign(Object.assign({}, runtimeConfig.hostVersionsInfo.appEligibilityInformation), { ageGroup: LegalAgeGroupClassification.NotAdult }) }) });
+}
 
 ;// ./src/public/uuidObject.ts
 
@@ -4607,7 +4644,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.41.0";
+const version = "2.43.0";
 
 ;// ./src/public/featureFlags.ts
 // All build feature flags are defined inside this object. Any build feature flag must have its own unique getter and setter function. This pattern allows for client apps to treeshake unused code and avoid including code guarded by this feature flags in the final bundle. If this property isn't desired, use the below runtime feature flags object.
@@ -5489,6 +5526,7 @@ function transformLegacyContextToAppContext(legacyContext) {
             theme: legacyContext.theme ? legacyContext.theme : 'default',
             iconPositionVertical: legacyContext.appIconPosition,
             osLocaleInfo: legacyContext.osLocaleInfo,
+            messageId: legacyContext.messageId,
             parentMessageId: legacyContext.parentMessageId,
             userClickTime: legacyContext.userClickTime,
             userClickTimeV2: legacyContext.userClickTimeV2,
@@ -6575,12 +6613,14 @@ function initializeHelper(apiVersionTag, validMessageOrigins) {
                 // After Teams updates its client code, we can remove this default code.
                 try {
                     initializeHelperLogger('Parsing %s', runtimeConfig);
-                    const givenRuntimeConfig = JSON.parse(runtimeConfig);
+                    let givenRuntimeConfig = JSON.parse(runtimeConfig);
                     initializeHelperLogger('Checking if %o is a valid runtime object', givenRuntimeConfig !== null && givenRuntimeConfig !== void 0 ? givenRuntimeConfig : 'null');
                     // Check that givenRuntimeConfig is a valid instance of IBaseRuntime
                     if (!givenRuntimeConfig || !givenRuntimeConfig.apiVersion) {
                         throw new Error('Received runtime config is invalid');
                     }
+                    // Normalize ageGroup value for backward compatibility
+                    givenRuntimeConfig = normalizeAgeGroupValue(givenRuntimeConfig);
                     runtimeConfig && applyRuntimeConfig(givenRuntimeConfig);
                 }
                 catch (e) {
@@ -6594,12 +6634,13 @@ function initializeHelper(apiVersionTag, validMessageOrigins) {
                             if (!isNaN(compareSDKVersions(runtimeConfig, defaultSDKVersionForCompatCheck))) {
                                 GlobalVars.clientSupportedSDKVersion = runtimeConfig;
                             }
-                            const givenRuntimeConfig = JSON.parse(clientSupportedSDKVersion);
+                            let givenRuntimeConfig = JSON.parse(clientSupportedSDKVersion);
                             initializeHelperLogger('givenRuntimeConfig parsed to %o', givenRuntimeConfig !== null && givenRuntimeConfig !== void 0 ? givenRuntimeConfig : 'null');
                             if (!givenRuntimeConfig) {
                                 throw new Error('givenRuntimeConfig string was successfully parsed. However, it parsed to value of null');
                             }
                             else {
+                                givenRuntimeConfig = normalizeAgeGroupValue(givenRuntimeConfig);
                                 applyRuntimeConfig(givenRuntimeConfig);
                             }
                         }
@@ -9431,7 +9472,7 @@ function eligibility_isSupported() {
  * @beta
  */
 function getEligibilityInfo(forceRefresh) {
-    var _a, _b;
+    var _a, _b, _c;
     return eligibility_awaiter(this, void 0, void 0, function* () {
         ensureInitialized(runtime);
         if (!eligibility_isSupported()) {
@@ -9452,6 +9493,10 @@ function getEligibilityInfo(forceRefresh) {
         if (!isEligibilityInfoValid(response)) {
             throw new Error('Error deserializing eligibility information');
         }
+        // convert nonAdult age group to NotAdult
+        if (((_c = response.ageGroup) === null || _c === void 0 ? void 0 : _c.toLowerCase()) === 'nonadult') {
+            response.ageGroup = LegalAgeGroupClassification.NotAdult;
+        }
         return response;
     });
 }
@@ -19480,6 +19525,262 @@ function marketplace_isSupported() {
     return ensureInitialized(runtime) && runtime.supports.marketplace ? true : false;
 }
 
+;// ./src/public/shortcutRelay.ts
+/**
+ * Allows host shortcuts to function in your application by forwarding keyboard shortcuts to the host.
+ *
+ * This functionality is in Beta.
+ * @beta
+ * @module
+ */
+var shortcutRelay_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());
+    });
+};
+
+
+
+
+
+
+
+/* ------------------------------------------------------------------ */
+/* Utils                                                              */
+/* ------------------------------------------------------------------ */
+class SerializableKeyboardEvent {
+    constructor(event) {
+        this.event = event;
+    }
+    serialize() {
+        return {
+            altKey: this.event.altKey,
+            bubbles: this.event.bubbles,
+            cancelBubble: this.event.cancelBubble,
+            charCode: this.event.charCode,
+            code: this.event.code,
+            composed: this.event.composed,
+            ctrlKey: this.event.ctrlKey,
+            // currentTarget: skipped
+            defaultPrevented: this.event.defaultPrevented,
+            detail: this.event.detail,
+            eventPhase: this.event.eventPhase,
+            isComposing: this.event.isComposing,
+            isTrusted: this.event.isTrusted,
+            key: this.event.key,
+            keyCode: this.event.keyCode,
+            location: this.event.location,
+            metaKey: this.event.metaKey,
+            // path - skipped,
+            repeat: this.event.repeat,
+            returnValue: this.event.returnValue,
+            shiftKey: this.event.shiftKey,
+            // sourceCapabilities - skipped,
+            // srcElement - slipped.
+            // target - skipped.
+            timeStamp: this.event.timeStamp,
+            type: this.event.type,
+            // view - skipped
+            which: this.event.which,
+        };
+    }
+}
+/**
+ * Normalizes a shortcut string to a canonical form.
+ */
+function normalizeShortcut(shortcut) {
+    return shortcut.toLowerCase().split('+').sort().join('+');
+}
+/**
+ * Build a canonical, lower-case “ctrl+shift+x” representation of the
+ * currently pressed keys.  The array is sorted so the order in which
+ * modifiers are pressed does not matter.
+ */
+function eventToCanonicalShortcut(e) {
+    return [e.ctrlKey && 'ctrl', e.shiftKey && 'shift', e.altKey && 'alt', e.metaKey && 'meta', e.key.toLowerCase()]
+        .filter(Boolean)
+        .sort()
+        .join('+');
+}
+/**
+ * Checks if the event is a valid shortcut event.
+ * A valid shortcut event is one that has at least one modifier key pressed
+ * (ctrl, shift, alt, meta) or the Escape key.
+ */
+function isValidShortcutEvent(e) {
+    return e.ctrlKey || e.shiftKey || e.altKey || e.metaKey || (!!e.key && e.key.toLowerCase() === 'escape');
+}
+function isMatchingShortcut(shortcuts, e) {
+    if (isValidShortcutEvent(e)) {
+        const pressedShortcut = eventToCanonicalShortcut(e);
+        const isMatching = shortcuts.has(pressedShortcut);
+        if (isMatching) {
+            return {
+                matchedShortcut: pressedShortcut,
+                isOverridable: overridableShortcuts.has(pressedShortcut),
+            };
+        }
+    }
+    return {
+        matchedShortcut: undefined,
+        isOverridable: false,
+    };
+}
+function updateHostShortcuts(data) {
+    hostShortcuts.clear();
+    data.shortcuts.forEach((shortcut) => {
+        hostShortcuts.add(normalizeShortcut(shortcut));
+    });
+    overridableShortcuts.clear();
+    data.overridableShortcuts.forEach((shortcut) => {
+        overridableShortcuts.add(normalizeShortcut(shortcut));
+    });
+}
+class HostShortcutsResponseHandler extends ResponseHandler {
+    validate(response) {
+        return response && Array.isArray(response.shortcuts) && Array.isArray(response.overridableShortcuts);
+    }
+    deserialize(response) {
+        return response;
+    }
+}
+/**
+ * register a handler to be called when shortcuts are updated in the host.
+ */
+function registerOnHostShortcutChangedHandler(handler) {
+    registerHandler(getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "shortcutRelay.hostShortcutChanged" /* ApiName.ShortcutRelay_HostShortcutChanged */), "shortcutRelay.hostShortcutChanged" /* ApiName.ShortcutRelay_HostShortcutChanged */, handler);
+}
+function keydownHandler(event) {
+    // Skip if the event target is within an element that has the `data-disable-shortcuts-forwarding` attribute
+    if (event.target.closest(`[${DISABLE_SHORTCUT_FORWARDING_ATTRIBUTE}]`)) {
+        return;
+    }
+    const { matchedShortcut, isOverridable } = isMatchingShortcut(hostShortcuts, event);
+    if (!matchedShortcut) {
+        return; // ignore unrelated events
+    }
+    if (isOverridable && overridableShortcutHandler) {
+        const shouldOverride = overridableShortcutHandler(event, { matchedShortcut });
+        if (shouldOverride) {
+            return; // Do not forward shortcut to host
+        }
+    }
+    /* Forward shortcut to host */
+    const payload = new SerializableKeyboardEvent(event);
+    callFunctionInHost("shortcutRelay.forwardShortcutEvent" /* ApiName.ShortcutRelay_ForwardShortcutEvent */, [payload], getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "shortcutRelay.forwardShortcutEvent" /* ApiName.ShortcutRelay_ForwardShortcutEvent */));
+    event.preventDefault();
+    event.stopImmediatePropagation();
+}
+/* ------------------------------------------------------------------ */
+/* In-memory                                                          */
+/* ------------------------------------------------------------------ */
+/**
+ * @hidden
+ * @internal
+ * Stores the shortcuts that can be overridden by the app.
+ */
+const overridableShortcuts = new Set();
+/**
+ * @hidden
+ * @internal
+ * Stores the shortcuts that are enabled in host.
+ * This set is populated when the host sends the list of enabled shortcuts.
+ */
+const hostShortcuts = new Set();
+/**
+ * @hidden
+ * @internal
+ * Stores the handler for overridable shortcuts.
+ */
+let overridableShortcutHandler = undefined;
+/**
+ * @hidden
+ * @internal
+ * Flag to indicate if the shortcut relay capability has been enabled, so that we do not register the event listener multiple times.
+ */
+let isShortcutRelayCapabilityEnabled = false;
+/* ------------------------------------------------------------------ */
+/* API                                                                */
+/* ------------------------------------------------------------------ */
+/**
+ * Replace the current overridable-shortcut handler.
+ *
+ * • Pass `undefined` to remove an existing handler.
+ * • Returns the previous handler so callers can restore it if needed.
+ *
+ * @beta
+ */
+function setOverridableShortcutHandler(handler) {
+    if (!shortcutRelay_isSupported()) {
+        throw errorNotSupportedOnPlatform;
+    }
+    const previous = overridableShortcutHandler;
+    overridableShortcutHandler = handler;
+    return previous;
+}
+/**
+ * Reset the state of the shortcut relay capability.
+ * This is useful for tests to ensure a clean state.
+ *
+ * @beta
+ */
+function resetIsShortcutRelayCapabilityEnabled() {
+    if (!shortcutRelay_isSupported()) {
+        throw errorNotSupportedOnPlatform;
+    }
+    isShortcutRelayCapabilityEnabled = false;
+    hostShortcuts.clear();
+    overridableShortcuts.clear();
+    overridableShortcutHandler = undefined;
+    document.removeEventListener('keydown', keydownHandler, { capture: true });
+}
+/**
+ * Enable capability to support host shortcuts.
+ *
+ * @beta
+ */
+function enableShortcutRelayCapability() {
+    return shortcutRelay_awaiter(this, void 0, void 0, function* () {
+        if (!shortcutRelay_isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+        /* 1. Ask host for the list of enabled shortcuts */
+        const response = yield callFunctionInHostAndHandleResponse("shortcutRelay.getHostShortcuts" /* ApiName.ShortcutRelay_GetHostShortcuts */, [], new HostShortcutsResponseHandler(), getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "shortcutRelay.getHostShortcuts" /* ApiName.ShortcutRelay_GetHostShortcuts */));
+        updateHostShortcuts(response);
+        /* 2. Global key-down handler */
+        if (!isShortcutRelayCapabilityEnabled) {
+            document.addEventListener('keydown', keydownHandler, { capture: true });
+        }
+        isShortcutRelayCapabilityEnabled = true;
+        /* 3. Register handler for host shortcut updates */
+        registerOnHostShortcutChangedHandler((hostShortcuts) => {
+            updateHostShortcuts(hostShortcuts);
+        });
+    });
+}
+/**
+ * Checks if shortcutRelay capability is supported by the host
+ * @returns boolean to represent whether the shortcutRelay capability is supported
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+function shortcutRelay_isSupported() {
+    return ensureInitialized(runtime) && runtime.supports.shortcutRelay ? true : false;
+}
+/**
+ * Allow apps to define zones where shortcuts should not be forwarded to the host.
+ * This is useful for input fields for password where shortcuts should not trigger host actions.
+ *
+ * @beta
+ */
+const DISABLE_SHORTCUT_FORWARDING_ATTRIBUTE = 'data-disable-shortcuts-forwarding';
+
 ;// ./src/public/index.ts
 
 
@@ -19564,6 +19865,8 @@ function marketplace_isSupported() {
 
 
 
+
+
 
 ;// ./src/index.ts