Add visionOS client type (#2670)

* Add visionOS as new HostClientType * Add change file * Update change file placeholder comment * Fix linting issues
OfficeDev · Feb 3, 2025 · 87cce22 · 87cce22
1 parent d10369a
commit 87cce22
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 8 deletions.
diff --git a/change/@microsoft-teams-js-585a4c58-b352-4c2d-9bb6-36db75e05820.json b/change/@microsoft-teams-js-585a4c58-b352-4c2d-9bb6-36db75e05820.json
@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Add visionOS client type support for Teams SDK. This change will enable app developers to find out if app is running on visionOS",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/teams-js/src/internal/internalAPIs.ts b/packages/teams-js/src/internal/internalAPIs.ts
@@ -91,7 +91,7 @@ export function isCurrentSDKVersionAtLeast(requiredVersion: string = defaultSDKV
 
 /**
  * @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
@@ -100,7 +100,8 @@ export function isHostClientMobile(): boolean {
   return (
     GlobalVars.hostClientType == HostClientType.android ||
     GlobalVars.hostClientType == HostClientType.ios ||
-    GlobalVars.hostClientType == HostClientType.ipados
+    GlobalVars.hostClientType == HostClientType.ipados ||
+    GlobalVars.hostClientType == HostClientType.visionOS
   );
 }
 

diff --git a/packages/teams-js/src/public/constants.ts b/packages/teams-js/src/public/constants.ts
@@ -12,6 +12,8 @@ export enum HostClientType {
   ipados = 'ipados',
   /** The host is running on a macOS client, which runs on devices such as MacBooks. */
   macos = 'macos',
+  /** The host is running on a visionOS client, which runs on devices such as Apple Vision. */
+  visionOS = 'visionOS',
   /**
    * @deprecated
    * As of TeamsJS v2.0.0, please use {@link teamsRoomsWindows} instead.

diff --git a/packages/teams-js/src/public/nestedAppAuth.ts b/packages/teams-js/src/public/nestedAppAuth.ts
@@ -27,17 +27,18 @@ export function isNAAChannelRecommended(): boolean {
 
 function isNAAChannelRecommendedForLegacyTeamsMobile(): boolean {
   return ensureInitialized(runtime) &&
-    isHostAndroidOrIOSOrIPadOS() &&
+    isHostAndroidOrIOSOrIPadOSOrVisionOS() &&
     runtime.isLegacyTeams &&
     runtime.supports.nestedAppAuth
     ? true
     : false;
 }
 
-function isHostAndroidOrIOSOrIPadOS(): boolean {
+function isHostAndroidOrIOSOrIPadOSOrVisionOS(): boolean {
   return (
     GlobalVars.hostClientType === HostClientType.android ||
     GlobalVars.hostClientType === HostClientType.ios ||
-    GlobalVars.hostClientType === HostClientType.ipados
+    GlobalVars.hostClientType === HostClientType.ipados ||
+    GlobalVars.hostClientType === HostClientType.visionOS
   );
 }
diff --git a/packages/teams-js/src/public/runtime.ts b/packages/teams-js/src/public/runtime.ts
@@ -426,7 +426,12 @@ const v1NonMobileHostClientTypes = [
   HostClientType.teamsDisplays,
 ];
 
-export const v1MobileHostClientTypes = [HostClientType.android, HostClientType.ios, HostClientType.ipados];
+export const v1MobileHostClientTypes = [
+  HostClientType.android,
+  HostClientType.ios,
+  HostClientType.ipados,
+  HostClientType.visionOS,
+];
 
 export const v1HostClientTypes = [...v1NonMobileHostClientTypes, ...v1MobileHostClientTypes];
 
@@ -599,7 +604,7 @@ export const mapTeamsVersionToSupportedCapabilities: Record<string, Array<ICapab
   '2.1.1': [
     {
       capability: { nestedAppAuth: {} },
-      hostClientTypes: [HostClientType.android, HostClientType.ios, HostClientType.ipados],
+      hostClientTypes: [HostClientType.android, HostClientType.ios, HostClientType.ipados, HostClientType.visionOS],
     },
   ],
 };

diff --git a/packages/teams-js/src/public/webStorage.ts b/packages/teams-js/src/public/webStorage.ts
@@ -32,7 +32,8 @@ export async function isWebStorageClearedOnUserLogOut(): Promise<boolean> {
     runtime.isLegacyTeams &&
     (GlobalVars.hostClientType === HostClientType.android ||
       GlobalVars.hostClientType === HostClientType.ios ||
-      GlobalVars.hostClientType === HostClientType.ipados) &&
+      GlobalVars.hostClientType === HostClientType.ipados ||
+      GlobalVars.hostClientType === HostClientType.visionOS) &&
     (await getHostName()) === HostName.teams
   ) {
     // On Teams Mobile, they haven't yet implemented this capability. However, for compatibility reasons, we need

diff --git a/packages/teams-js/test/public/authentication.spec.ts b/packages/teams-js/test/public/authentication.spec.ts
@@ -57,6 +57,7 @@ describe('Testing authentication capability', () => {
     HostClientType.ios,
     HostClientType.ipados,
     HostClientType.macos,
+    HostClientType.visionOS,
     HostClientType.rigel,
     HostClientType.teamsRoomsWindows,
     HostClientType.teamsRoomsAndroid,

diff --git a/packages/teams-js/test/public/clipboard.spec.ts b/packages/teams-js/test/public/clipboard.spec.ts
@@ -318,6 +318,7 @@ describe('clipboard', () => {
           HostClientType.desktop,
           HostClientType.ios,
           HostClientType.ipados,
+          HostClientType.visionOS,
           HostClientType.macos,
         ]).forEach((mobilePlatform) => {
           if (allowedContexts.some((allowedContext) => allowedContext === context)) {