feat: implement XR API (#81)

* feat: implement Spatial API

* feat: make RCTSpatial decoupled from RCTMainWindow()

* feat: implement XR module

docs: add image to README, annotate nightly APIs

fix: export XR library from typescript

Author: okwasniewski

.gitignore

@@ -155,6 +155,7 @@ vendor/
 
 # CircleCI
 .circleci/generated_config.yml
-
 # Jest Integration
 /jest/integration/build/
+.circleci/storage
+.yarn

packages/react-native/Libraries/SwiftExtensions/React-RCTSwiftExtensions.podspec

@@ -24,4 +24,5 @@ Pod::Spec.new do |s|
   s.frameworks = ["UIKit", "SwiftUI"]
 
   s.dependency "React-Core"
+  s.dependency "React-RCTXR" 
 end

packages/react-native/Libraries/XR/ImmersiveBridge.swift

@@ -0,0 +1,55 @@
+import Foundation
+import SwiftUI
+
+@objc public enum ImmersiveSpaceResult: Int {
+  case opened
+  case userCancelled
+  case error
+}
+
+public typealias CompletionHandlerType = (_ result: ImmersiveSpaceResult) -> Void
+
+/**
+ * Utility view used to bridge the gap between SwiftUI environment and UIKit.
+ *
+ * Calls `openImmersiveSpace` when view appears in the UIKit hierarchy and `dismissImmersiveSpace` when removed.
+ */
+struct ImmersiveBridgeView: View {
+  @Environment(\.openImmersiveSpace) private var openImmersiveSpace
+  @Environment(\.dismissImmersiveSpace) private var dismissImmersiveSpace
+  
+  var spaceId: String
+  var completionHandler: CompletionHandlerType
+  
+  var body: some View {
+    EmptyView()
+      .onAppear {
+        Task {
+          let result = await openImmersiveSpace(id: spaceId)
+          
+          switch result {
+          case .opened:
+            completionHandler(.opened)
+          case .error:
+            completionHandler(.error)
+          case .userCancelled:
+            completionHandler(.userCancelled)
+          default:
+            break
+          }
+        }
+      }
+      .onDisappear {
+        Task { await dismissImmersiveSpace() }
+      }
+  }
+}
+
+@objc public class ImmersiveBridgeFactory: NSObject {
+  @objc public static func makeImmersiveBridgeView(
+    spaceId: String,
+    completionHandler: @escaping CompletionHandlerType
+  ) -> UIViewController {
+    return UIHostingController(rootView: ImmersiveBridgeView(spaceId: spaceId, completionHandler: completionHandler))
+  }
+}

packages/react-native/Libraries/XR/NativeXRModule.js

@@ -0,0 +1,8 @@
+/**
+ * @flow strict
+ * @format
+ */
+
+export * from '../../src/private/specs/visionos_modules/NativeXRModule';
+import NativeXRModule from '../../src/private/specs/visionos_modules/NativeXRModule';
+export default NativeXRModule;

packages/react-native/Libraries/XR/RCTXRModule.h

@@ -0,0 +1,6 @@
+#import <Foundation/Foundation.h>
+#import <React/RCTBridgeModule.h>
+
+@interface RCTXRModule : NSObject <RCTBridgeModule>
+
+@end

packages/react-native/Libraries/XR/RCTXRModule.mm

@@ -0,0 +1,88 @@
+#import <React/RCTXRModule.h>
+
+#import <FBReactNativeSpec_visionOS/FBReactNativeSpec_visionOS.h>
+
+#import <React/RCTBridge.h>
+#import <React/RCTConvert.h>
+#import <React/RCTUtils.h>
+#import "RCTXR-Swift.h"
+
+@interface RCTXRModule () <NativeXRModuleSpec>
+@end
+
+@implementation RCTXRModule {
+  UIViewController *_immersiveBridgeView;
+}
+
+RCT_EXPORT_MODULE()
+
+RCT_EXPORT_METHOD(endSession
+                  : (RCTPromiseResolveBlock)resolve reject
+                  : (RCTPromiseRejectBlock)reject)
+{
+  [self removeImmersiveBridge];
+  resolve(nil);
+}
+
+
+RCT_EXPORT_METHOD(requestSession
+                  : (NSString *)sessionId resolve
+                  : (RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
+{
+  RCTExecuteOnMainQueue(^{
+    UIWindow *keyWindow = RCTKeyWindow();
+    UIViewController *rootViewController = keyWindow.rootViewController;
+    
+    if (self->_immersiveBridgeView == nil) {
+      self->_immersiveBridgeView = [ImmersiveBridgeFactory makeImmersiveBridgeViewWithSpaceId:sessionId
+                                                                            completionHandler:^(enum ImmersiveSpaceResult result){
+        if (result == ImmersiveSpaceResultError) {
+          reject(@"ERROR", @"Immersive Space failed to open, the system cannot fulfill the request.", nil);
+          [self removeImmersiveBridge];
+        } else if (result == ImmersiveSpaceResultUserCancelled) {
+          reject(@"ERROR", @"Immersive Space canceled by user", nil);
+          [self removeImmersiveBridge];
+        } else if (result == ImmersiveSpaceResultOpened) {
+          resolve(nil);
+        }
+      }];
+      
+      [rootViewController.view addSubview:self->_immersiveBridgeView.view];
+      [rootViewController addChildViewController:self->_immersiveBridgeView];
+      [self->_immersiveBridgeView didMoveToParentViewController:rootViewController];
+    } else {
+      reject(@"ERROR", @"Immersive Space already opened", nil);
+    }
+  });
+}
+
+- (facebook::react::ModuleConstants<JS::NativeXRModule::Constants::Builder>)constantsToExport {
+  return [self getConstants];
+}
+
+- (facebook::react::ModuleConstants<JS::NativeXRModule::Constants>)getConstants {
+  __block facebook::react::ModuleConstants<JS::NativeXRModule::Constants> constants;
+  RCTUnsafeExecuteOnMainQueueSync(^{
+    constants = facebook::react::typedConstants<JS::NativeXRModule::Constants>({
+      .supportsMultipleScenes = RCTSharedApplication().supportsMultipleScenes
+    });
+  });
+  
+  return constants;
+}
+
+- (void) removeImmersiveBridge
+{
+  RCTExecuteOnMainQueue(^{
+    [self->_immersiveBridgeView willMoveToParentViewController:nil];
+    [self->_immersiveBridgeView.view removeFromSuperview];
+    [self->_immersiveBridgeView removeFromParentViewController];
+    self->_immersiveBridgeView = nil;
+  });
+}
+
+- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:(const facebook::react::ObjCTurboModule::InitParams &)params {
+  return std::make_shared<facebook::react::NativeXRModuleSpecJSI>(params);
+}
+
+@end

packages/react-native/Libraries/XR/XR.d.ts

@@ -0,0 +1,9 @@
+
+export interface XRStatic {
+  requestSession(sessionId: string): Promise<void>;
+  endSession(): Promise<void>;
+  supportsMultipleScenes: boolean;
+}
+
+export const XR: XRStatic;
+export type XR = XRStatic;

packages/react-native/Libraries/XR/XR.js

@@ -0,0 +1,33 @@
+/**
+ * @format
+ * @flow strict
+ * @jsdoc
+ */
+
+import NativeXRModule from './NativeXRModule';
+
+const XR = {
+  requestSession: (sessionId?: string): Promise<void> => {
+    if (NativeXRModule != null && NativeXRModule.requestSession != null) {
+      return NativeXRModule.requestSession(sessionId);
+    }
+    return Promise.reject(new Error('NativeXRModule is not available'));
+  },
+  endSession: (): Promise<void> => {
+    if (NativeXRModule != null && NativeXRModule.endSession != null) {
+      return NativeXRModule.endSession();
+    }
+    return Promise.reject(new Error('NativeXRModule is not available'));
+  },
+  // $FlowIgnore[unsafe-getters-setters]
+  get supportsMultipleScenes(): boolean {
+    if (NativeXRModule == null) {
+      return false;
+    }
+
+    const nativeConstants = NativeXRModule.getConstants();
+    return nativeConstants.supportsMultipleScenes || false;
+  },
+};
+
+module.exports = XR;

packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap

@@ -9507,6 +9507,22 @@ declare module.exports: WebSocketInterceptor;
 "
 `;
 
+exports[`public API should not change unintentionally Libraries/XR/NativeXRModule.js 1`] = `
+"export * from \\"../../src/private/specs/visionos_modules/NativeXRModule\\";
+declare export default typeof NativeXRModule;
+"
+`;
+
+exports[`public API should not change unintentionally Libraries/XR/XR.js 1`] = `
+"declare const XR: {
+  requestSession: (sessionId?: string) => Promise<void>,
+  endSession: () => Promise<void>,
+  get supportsMultipleScenes(): boolean,
+};
+declare module.exports: XR;
+"
+`;
+
 exports[`public API should not change unintentionally Libraries/YellowBox/YellowBoxDeprecated.js 1`] = `
 "declare const React: $FlowFixMe;
 type Props = $ReadOnly<{||}>;
@@ -9626,6 +9642,7 @@ declare module.exports: {
   get PushNotificationIOS(): PushNotificationIOS,
   get Settings(): Settings,
   get Share(): Share,
+  get XR(): XR,
   get StyleSheet(): StyleSheet,
   get Systrace(): Systrace,
   get ToastAndroid(): ToastAndroid,

packages/react-native/React-Core.podspec

@@ -41,6 +41,7 @@ header_subspecs = {
   'RCTSettingsHeaders'          => 'Libraries/Settings/*.h',
   'RCTTextHeaders'              => 'Libraries/Text/**/*.h',
   'RCTVibrationHeaders'         => 'Libraries/Vibration/*.h',
+  'RCTXRHeaders'                => 'Libraries/XR/*.h',
 }
 
 frameworks_search_paths = []

packages/react-native/React.podspec

@@ -53,4 +53,5 @@ Pod::Spec.new do |s|
   s.dependency "React-RCTSettings", version
   s.dependency "React-RCTText", version
   s.dependency "React-RCTVibration", version
+  s.dependency "React-RCTXR", version
 end

packages/react-native/React/Base/RCTUtils.m

@@ -580,6 +580,13 @@ BOOL RCTRunningInAppExtension(void)
       continue;
     }
 
+    #if TARGET_OS_VISION
+    /// Presenting scenes over Immersive Spaces leads to crash: "Presentations are not permitted within volumetric window scenes."
+    if (scene.session.role == UISceneSessionRoleImmersiveSpaceApplication) {
+      continue;
+    }
+#endif
+
     if (scene.activationState == UISceneActivationStateForegroundActive) {
       foregroundActiveScene = scene;
       break;

packages/react-native/index.js

@@ -95,6 +95,7 @@ import typeof Platform from './Libraries/Utilities/Platform';
 import typeof useColorScheme from './Libraries/Utilities/useColorScheme';
 import typeof useWindowDimensions from './Libraries/Utilities/useWindowDimensions';
 import typeof Vibration from './Libraries/Vibration/Vibration';
+import typeof XR from './Libraries/XR/XR';
 import typeof YellowBox from './Libraries/YellowBox/YellowBoxDeprecated';
 import typeof DevMenu from './src/private/devmenu/DevMenu';
 
@@ -309,6 +310,9 @@ module.exports = {
   get Share(): Share {
     return require('./Libraries/Share/Share');
   },
+  get XR(): XR {
+    return require('./Libraries/XR/XR');
+  },
   get StyleSheet(): StyleSheet {
     return require('./Libraries/StyleSheet/StyleSheet');
   },

packages/react-native/package.json

@@ -154,6 +154,13 @@
         "android": {},
         "jsSrcsDir": "src"
       },
+      {
+        "name": "FBReactNativeSpec_visionOS",
+        "type": "modules",
+        "ios": {},
+        "android": {},
+        "jsSrcsDir": "src/private/specs/visionos_modules"
+      },
       {
         "name": "rncore",
         "type": "components",

packages/react-native/scripts/cocoapods/utils.rb

@@ -645,6 +645,7 @@ def self.react_native_pods
             "glog",
             "hermes-engine",
             "React-hermes",
+            "React-RCTXR", # visionOS
         ]
     end
 

packages/react-native/scripts/react_native_pods.rb

@@ -136,6 +136,7 @@ def use_react_native! (
   pod 'RCTDeprecation', :path => "#{prefix}/ReactApple/Libraries/RCTFoundation/RCTDeprecation"
   pod 'React-RCTFBReactNativeSpec', :path => "#{prefix}/React"
   pod 'React-RCTSwiftExtensions', :path => "#{prefix}/Libraries/SwiftExtensions"
+  pod 'React-RCTXR', :path => "#{prefix}/Libraries/XR"
 
   if hermes_enabled
     setup_hermes!(:react_native_path => prefix)

packages/react-native/src/private/specs/visionos_modules/NativeXRModule.js

@@ -0,0 +1,21 @@
+/**
+ * @flow strict
+ * @format
+ */
+
+import type {TurboModule} from '../../../../Libraries/TurboModule/RCTExport';
+
+import * as TurboModuleRegistry from '../../../../Libraries/TurboModule/TurboModuleRegistry';
+
+export type XRModuleConstants = {|
+  +supportsMultipleScenes?: boolean,
+|};
+
+export interface Spec extends TurboModule {
+  +getConstants: () => XRModuleConstants;
+
+  +requestSession: (sessionId?: string) => Promise<void>;
+  +endSession: () => Promise<void>;
+}
+
+export default (TurboModuleRegistry.get<Spec>('XRModule'): ?Spec);

packages/react-native/types/index.d.ts

@@ -147,6 +147,7 @@ export * from '../Libraries/Utilities/Dimensions';
 export * from '../Libraries/Utilities/PixelRatio';
 export * from '../Libraries/Utilities/Platform';
 export * from '../Libraries/Vibration/Vibration';
+export * from '../Libraries/XR/XR';
 export * from '../Libraries/YellowBox/YellowBoxDeprecated';
 export * from '../Libraries/vendor/core/ErrorUtils';
 export {