@microsoft/teams-js 2.34.0-beta.1 → 2.34.0

package/dist/umd/MicrosoftTeams.js

@@ -3156,6 +3156,8 @@ var HostClientType;
     HostClientType["ipados"] = "ipados";
     /** The host is running on a macOS client, which runs on devices such as MacBooks. */
     HostClientType["macos"] = "macos";
+    /** The host is running on a visionOS client, which runs on devices such as Apple Vision. */
+    HostClientType["visionOS"] = "visionOS";
     /**
      * @deprecated
      * As of TeamsJS v2.0.0, please use {@link teamsRoomsWindows} instead.
@@ -4013,6 +4015,14 @@ const validOriginsLocal = artifactsForCDN_validDomains_namespaceObject;
  * Limited to Microsoft-internal use
  */
 const validOriginsFallback = validOriginsLocal.validOrigins;
+/**
+ * @hidden
+ * Timeout length for Fetch Call for Valid Origins
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+const ORIGIN_LIST_FETCH_TIMEOUT_IN_MS = 1500;
 /**
  * @hidden
  * CDN endpoint of the list of valid origins
@@ -4188,7 +4198,12 @@ const v1NonMobileHostClientTypes = [
     HostClientType.teamsPhones,
     HostClientType.teamsDisplays,
 ];
-const v1MobileHostClientTypes = [HostClientType.android, HostClientType.ios, HostClientType.ipados];
+const v1MobileHostClientTypes = [
+    HostClientType.android,
+    HostClientType.ios,
+    HostClientType.ipados,
+    HostClientType.visionOS,
+];
 const v1HostClientTypes = [...v1NonMobileHostClientTypes, ...v1MobileHostClientTypes];
 /**
  * @hidden
@@ -4338,7 +4353,7 @@ const mapTeamsVersionToSupportedCapabilities = {
     '2.1.1': [
         {
             capability: { nestedAppAuth: {} },
-            hostClientTypes: [HostClientType.android, HostClientType.ios, HostClientType.ipados],
+            hostClientTypes: [HostClientType.android, HostClientType.ios, HostClientType.ipados, HostClientType.visionOS],
         },
     ],
 };
@@ -4470,7 +4485,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.34.0-beta.1";
+const version = "2.34.0";
 
 ;// ./src/internal/internalAPIs.ts
 
@@ -4549,7 +4564,7 @@ function isCurrentSDKVersionAtLeast(requiredVersion = defaultSDKVersionForCompat
 }
 /**
  * @hidden
- * Helper function to identify if host client is either android, ios, or ipados
+ * Helper function to identify if host client is either android, ios, ipados, or visionOS
  *
  * @internal
  * Limited to Microsoft-internal use
@@ -4557,7 +4572,8 @@ function isCurrentSDKVersionAtLeast(requiredVersion = defaultSDKVersionForCompat
 function isHostClientMobile() {
     return (GlobalVars.hostClientType == HostClientType.android ||
         GlobalVars.hostClientType == HostClientType.ios ||
-        GlobalVars.hostClientType == HostClientType.ipados);
+        GlobalVars.hostClientType == HostClientType.ipados ||
+        GlobalVars.hostClientType == HostClientType.visionOS);
 }
 /**
  * @hidden
@@ -4697,139 +4713,8 @@ function isNullOrUndefined(value) {
     return value === null || value === undefined;
 }
 
-;// ./src/internal/validOrigins.ts
-var __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());
-    });
-};
-
-
-
-
-let validOriginsCache = [];
-const validateOriginLogger = getLogger('validateOrigin');
-function prefetchOriginsFromCDN() {
-    return __awaiter(this, void 0, void 0, function* () {
-        yield getValidOriginsListFromCDN();
-    });
-}
-function isValidOriginsCacheEmpty() {
-    return validOriginsCache.length === 0;
-}
-function getValidOriginsListFromCDN() {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!isValidOriginsCacheEmpty()) {
-            return validOriginsCache;
-        }
-        if (!inServerSideRenderingEnvironment()) {
-            return fetch(validOriginsCdnEndpoint)
-                .then((response) => {
-                if (!response.ok) {
-                    throw new Error('Invalid Response from Fetch Call');
-                }
-                return response.json().then((validOriginsCDN) => {
-                    if (isValidOriginsJSONValid(JSON.stringify(validOriginsCDN))) {
-                        validOriginsCache = validOriginsCDN.validOrigins;
-                        return validOriginsCache;
-                    }
-                    else {
-                        throw new Error('Valid Origins List Is Invalid');
-                    }
-                });
-            })
-                .catch((e) => {
-                validateOriginLogger('validOrigins fetch call to CDN failed with error: %s. Defaulting to fallback list', e);
-                validOriginsCache = validOriginsFallback;
-                return validOriginsCache;
-            });
-        }
-        else {
-            validOriginsCache = validOriginsFallback;
-            return validOriginsFallback;
-        }
-    });
-}
-function isValidOriginsJSONValid(validOriginsJSON) {
-    let validOriginsCDN = JSON.parse(validOriginsJSON);
-    try {
-        validOriginsCDN = JSON.parse(validOriginsJSON);
-    }
-    catch (_) {
-        return false;
-    }
-    if (!validOriginsCDN.validOrigins) {
-        return false;
-    }
-    for (const validOrigin of validOriginsCDN.validOrigins) {
-        try {
-            new URL('https://' + validOrigin);
-        }
-        catch (_) {
-            validateOriginLogger('isValidOriginsFromCDN call failed to validate origin: %s', validOrigin);
-            return false;
-        }
-    }
-    return true;
-}
-/**
- * @param pattern - reference pattern
- * @param host - candidate string
- * @returns returns true if host matches pre-know valid pattern
- *
- * @example
- *    validateHostAgainstPattern('*.teams.microsoft.com', 'subdomain.teams.microsoft.com') returns true
- *    validateHostAgainstPattern('teams.microsoft.com', 'team.microsoft.com') returns false
- *
- * @internal
- * Limited to Microsoft-internal use
- */
-function validateHostAgainstPattern(pattern, host) {
-    if (pattern.substring(0, 2) === '*.') {
-        const suffix = pattern.substring(1);
-        if (host.length > suffix.length &&
-            host.split('.').length === suffix.split('.').length &&
-            host.substring(host.length - suffix.length) === suffix) {
-            return true;
-        }
-    }
-    else if (pattern === host) {
-        return true;
-    }
-    return false;
-}
-/**
- * @internal
- * Limited to Microsoft-internal use
- */
-function validateOrigin(messageOrigin) {
-    return getValidOriginsListFromCDN().then((validOriginsList) => {
-        // Check whether the url is in the pre-known allowlist or supplied by user
-        if (!isValidHttpsURL(messageOrigin)) {
-            validateOriginLogger('Origin %s is invalid because it is not using https protocol. Protocol being used: %s', messageOrigin, messageOrigin.protocol);
-            return false;
-        }
-        const messageOriginHost = messageOrigin.host;
-        if (validOriginsList.some((pattern) => validateHostAgainstPattern(pattern, messageOriginHost))) {
-            return true;
-        }
-        for (const domainOrPattern of GlobalVars.additionalValidOrigins) {
-            const pattern = domainOrPattern.substring(0, 8) === 'https://' ? domainOrPattern.substring(8) : domainOrPattern;
-            if (validateHostAgainstPattern(pattern, messageOriginHost)) {
-                return true;
-            }
-        }
-        validateOriginLogger('Origin %s is invalid because it is not an origin approved by this library or included in the call to app.initialize.\nOrigins approved by this library: %o\nOrigins included in app.initialize: %o', messageOrigin, validOriginsList, GlobalVars.additionalValidOrigins);
-        return false;
-    });
-}
-
 ;// ./src/private/messageChannels/telemetry.ts
-var telemetry_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+var __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); } }
@@ -4861,7 +4746,7 @@ const logger = getLogger('messageChannels.telemetry');
  * Limited to Microsoft-internal use
  */
 function getTelemetryPort() {
-    return telemetry_awaiter(this, void 0, void 0, function* () {
+    return __awaiter(this, void 0, void 0, function* () {
         // If the port has already been initialized, return it.
         if (telemetryPort) {
             logger('Returning telemetry port from cache');
@@ -5155,7 +5040,6 @@ logWhereTeamsJsIsBeingUsed();
  * @returns Promise that will be fulfilled when initialization has completed, or rejected if the initialization fails or times out
  */
 function initialize(validMessageOrigins) {
-    prefetchOriginsFromCDN();
     return appInitializeHelper(getApiVersionTag(appTelemetryVersionNumber, "app.initialize" /* ApiName.App_Initialize */), validMessageOrigins);
 }
 /**
@@ -5319,6 +5203,8 @@ function transformLegacyContextToAppContext(legacyContext) {
                 ringId: legacyContext.ringId,
             },
             appLaunchId: legacyContext.appLaunchId,
+            appId: legacyContext.appId ? new AppId(legacyContext.appId) : undefined,
+            manifestVersion: legacyContext.manifestVersion,
         },
         page: {
             id: legacyContext.entityId,
@@ -6818,6 +6704,148 @@ function openLinkHelper(apiVersionTag, deepLink) {
     });
 }
 
+;// ./src/internal/validOrigins.ts
+var validOrigins_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());
+    });
+};
+
+
+
+
+let validOriginsCache = [];
+const validateOriginLogger = getLogger('validateOrigin');
+function prefetchOriginsFromCDN() {
+    return validOrigins_awaiter(this, void 0, void 0, function* () {
+        yield getValidOriginsListFromCDN();
+    });
+}
+function isValidOriginsCacheEmpty() {
+    return validOriginsCache.length === 0;
+}
+function getValidOriginsListFromCDN(shouldDisableCache = false) {
+    return validOrigins_awaiter(this, void 0, void 0, function* () {
+        if (!isValidOriginsCacheEmpty() && !shouldDisableCache) {
+            return validOriginsCache;
+        }
+        if (!inServerSideRenderingEnvironment()) {
+            validateOriginLogger('Initiating fetch call to acquire valid origins list from CDN');
+            const controller = new AbortController();
+            const timeoutId = setTimeout(() => controller.abort(), ORIGIN_LIST_FETCH_TIMEOUT_IN_MS);
+            return fetch(validOriginsCdnEndpoint, { signal: controller.signal })
+                .then((response) => {
+                clearTimeout(timeoutId);
+                if (!response.ok) {
+                    throw new Error('Invalid Response from Fetch Call');
+                }
+                validateOriginLogger('Fetch call completed and retrieved valid origins list from CDN');
+                return response.json().then((validOriginsCDN) => {
+                    if (isValidOriginsJSONValid(JSON.stringify(validOriginsCDN))) {
+                        validOriginsCache = validOriginsCDN.validOrigins;
+                        return validOriginsCache;
+                    }
+                    else {
+                        throw new Error('Valid origins list retrieved from CDN is invalid');
+                    }
+                });
+            })
+                .catch((e) => {
+                if (e.name === 'AbortError') {
+                    validateOriginLogger(`validOrigins fetch call to CDN failed due to Timeout of ${ORIGIN_LIST_FETCH_TIMEOUT_IN_MS} ms. Defaulting to fallback list`);
+                }
+                else {
+                    validateOriginLogger('validOrigins fetch call to CDN failed with error: %s. Defaulting to fallback list', e);
+                }
+                validOriginsCache = validOriginsFallback;
+                return validOriginsCache;
+            });
+        }
+        else {
+            validOriginsCache = validOriginsFallback;
+            return validOriginsFallback;
+        }
+    });
+}
+function isValidOriginsJSONValid(validOriginsJSON) {
+    let validOriginsCDN = JSON.parse(validOriginsJSON);
+    try {
+        validOriginsCDN = JSON.parse(validOriginsJSON);
+    }
+    catch (_) {
+        return false;
+    }
+    if (!validOriginsCDN.validOrigins) {
+        return false;
+    }
+    for (const validOrigin of validOriginsCDN.validOrigins) {
+        try {
+            new URL('https://' + validOrigin);
+        }
+        catch (_) {
+            validateOriginLogger('isValidOriginsFromCDN call failed to validate origin: %s', validOrigin);
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * @param pattern - reference pattern
+ * @param host - candidate string
+ * @returns returns true if host matches pre-know valid pattern
+ *
+ * @example
+ *    validateHostAgainstPattern('*.teams.microsoft.com', 'subdomain.teams.microsoft.com') returns true
+ *    validateHostAgainstPattern('teams.microsoft.com', 'team.microsoft.com') returns false
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function validateHostAgainstPattern(pattern, host) {
+    if (pattern.substring(0, 2) === '*.') {
+        const suffix = pattern.substring(1);
+        if (host.length > suffix.length &&
+            host.split('.').length === suffix.split('.').length &&
+            host.substring(host.length - suffix.length) === suffix) {
+            return true;
+        }
+    }
+    else if (pattern === host) {
+        return true;
+    }
+    return false;
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function validateOrigin(messageOrigin, disableCache) {
+    return getValidOriginsListFromCDN(disableCache).then((validOriginsList) => {
+        // Check whether the url is in the pre-known allowlist or supplied by user
+        if (!isValidHttpsURL(messageOrigin)) {
+            validateOriginLogger('Origin %s is invalid because it is not using https protocol. Protocol being used: %s', messageOrigin, messageOrigin.protocol);
+            return false;
+        }
+        const messageOriginHost = messageOrigin.host;
+        if (validOriginsList.some((pattern) => validateHostAgainstPattern(pattern, messageOriginHost))) {
+            return true;
+        }
+        for (const domainOrPattern of GlobalVars.additionalValidOrigins) {
+            const pattern = domainOrPattern.substring(0, 8) === 'https://' ? domainOrPattern.substring(8) : domainOrPattern;
+            if (validateHostAgainstPattern(pattern, messageOriginHost)) {
+                return true;
+            }
+        }
+        validateOriginLogger('Origin %s is invalid because it is not an origin approved by this library or included in the call to app.initialize.\nOrigins approved by this library: %o\nOrigins included in app.initialize: %o', messageOrigin, validOriginsList, GlobalVars.additionalValidOrigins);
+        return false;
+    });
+}
+prefetchOriginsFromCDN();
+
 ;// ./src/public/pages/appButton.ts
 /**
  * Provides APIs to interact with the app button part of the SDK.
@@ -8354,10 +8382,10 @@ const sendMessageToParentHelperLogger = communicationLogger.extend('sendMessageT
  * @internal
  * Limited to Microsoft-internal use
  */
-function sendMessageToParentHelper(apiVersionTag, actionName, args) {
+function sendMessageToParentHelper(apiVersionTag, actionName, args, isProxiedFromChild) {
     const logger = sendMessageToParentHelperLogger;
     const targetWindow = Communication.parentWindow;
-    const request = createMessageRequest(apiVersionTag, actionName, args);
+    const request = createMessageRequest(apiVersionTag, actionName, args, isProxiedFromChild);
     HostToAppMessageDelayTelemetry.storeCallbackInformation(request.uuid, {
         name: actionName,
         calledAt: request.timestamp,
@@ -8684,15 +8712,7 @@ function handleIncomingMessageFromChild(evt) {
         else {
             // No handler, proxy to parent
             handleIncomingMessageFromChildLogger('No handler for message %s from child found; relaying message on to parent, action: %s. Relayed message will have a new id.', getMessageIdsAsLogString(message), message.func);
-            sendMessageToParent(getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "tasks.startTask" /* ApiName.Tasks_StartTask */), message.func, message.args, (...args) => {
-                if (Communication.childWindow) {
-                    const isPartialResponse = args.pop();
-                    handleIncomingMessageFromChildLogger('Message from parent being relayed to child, id: %s', getMessageIdsAsLogString(message));
-                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                    // @ts-ignore
-                    sendMessageResponseToChild(message.id, message.uuid, args, isPartialResponse);
-                }
-            });
+            proxyChildMessageToParent(message);
         }
     }
 }
@@ -8839,7 +8859,7 @@ function sendMessageEventToChild(actionName, args) {
  * @internal
  * Limited to Microsoft-internal use
  */
-function createMessageRequest(apiVersionTag, func, args) {
+function createMessageRequest(apiVersionTag, func, args, isProxiedFromChild) {
     const messageId = CommunicationPrivate.nextMessageId++;
     const messageUuid = new UUID();
     CommunicationPrivate.legacyMessageIdsToUuidMap[messageId] = messageUuid;
@@ -8851,6 +8871,7 @@ function createMessageRequest(apiVersionTag, func, args) {
         monotonicTimestamp: getCurrentTimestamp(),
         args: args || [],
         apiVersionTag: apiVersionTag,
+        isProxiedFromChild: isProxiedFromChild !== null && isProxiedFromChild !== void 0 ? isProxiedFromChild : false,
     };
 }
 /**
@@ -8916,6 +8937,22 @@ function getMessageIdsAsLogString(message) {
         return `legacy id: ${message.id} (no uuid)`;
     }
 }
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function proxyChildMessageToParent(message) {
+    const request = sendMessageToParentHelper(getApiVersionTag("v2" /* ApiVersionNumber.V_2 */, "tasks.startTask" /* ApiName.Tasks_StartTask */), message.func, message.args, true);
+    CommunicationPrivate.callbacks.set(request.uuid, (...args) => {
+        if (Communication.childWindow) {
+            const isPartialResponse = args.pop();
+            handleIncomingMessageFromChildLogger('Message from parent being relayed to child, id: %s', getMessageIdsAsLogString(message));
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            sendMessageResponseToChild(message.id, message.uuid, args, isPartialResponse);
+        }
+    });
+}
 
 ;// ./src/private/logs.ts
 /**
@@ -14341,16 +14378,17 @@ function isNAAChannelRecommended() {
 }
 function isNAAChannelRecommendedForLegacyTeamsMobile() {
     return ensureInitialized(runtime) &&
-        isHostAndroidOrIOSOrIPadOS() &&
+        isHostAndroidOrIOSOrIPadOSOrVisionOS() &&
         runtime.isLegacyTeams &&
         runtime.supports.nestedAppAuth
         ? true
         : false;
 }
-function isHostAndroidOrIOSOrIPadOS() {
+function isHostAndroidOrIOSOrIPadOSOrVisionOS() {
     return (GlobalVars.hostClientType === HostClientType.android ||
         GlobalVars.hostClientType === HostClientType.ios ||
-        GlobalVars.hostClientType === HostClientType.ipados);
+        GlobalVars.hostClientType === HostClientType.ipados ||
+        GlobalVars.hostClientType === HostClientType.visionOS);
 }
 
 ;// ./src/public/geoLocation/map.ts
@@ -16739,7 +16777,8 @@ function isWebStorageClearedOnUserLogOut() {
         if (runtime.isLegacyTeams &&
             (GlobalVars.hostClientType === HostClientType.android ||
                 GlobalVars.hostClientType === HostClientType.ios ||
-                GlobalVars.hostClientType === HostClientType.ipados) &&
+                GlobalVars.hostClientType === HostClientType.ipados ||
+                GlobalVars.hostClientType === HostClientType.visionOS) &&
             (yield getHostName()) === HostName.teams) {
             // On Teams Mobile, they haven't yet implemented this capability. However, for compatibility reasons, we need
             // to act as if they do. If they did implement it, they would return true, so that's what we do here.