feat: implement XR module

Author: okwasniewski

README.md

@@ -69,14 +69,110 @@ This is a prop on `<View />` component allowing to add hover effect. It's applie
 
 If you want to customize it you can use the `visionos_hoverEffect` prop, like so:
 
-```jsx
+```tsx
 <TouchableOpacity visionos_hoverEffect="lift">
   <Text>Click me</Text>
 </TouchableOpacity>
 ```
 
 The available options are: `lift` or `highlight`.
 
+### `XR` API 
+Manage Immersive Experiences.
+
+#### Methods
+**`requestSession`**
+```js
+requestSession: (sessionId?: string) => Promise<void>
+```
+Opens a new [`ImmersiveSpace`](https://developer.apple.com/documentation/swiftui/immersive-spaces) given it's unique `Id`.
+
+**`endSession`**
+```js
+endSession: () => Promise<void>
+```
+Closes currently open `ImmersiveSpace`.
+
+#### Constants
+**`supportsMultipleScenes`**
+```js
+supportsMultipleScenes: boolean
+```
+A Boolean value that indicates whether the app may display multiple scenes simultaneously. Returns the value of `UIApplicationSupportsMultipleScenes` key from `Info.plist`.
+
+### Example Usage
+
+1. Set `UIApplicationSupportsMultipleScenes` to `true` in `Info.plist`:
+```diff
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>UIApplicationSceneManifest</key>
+	<dict>
+		<key>UIApplicationPreferredDefaultSceneSessionRole</key>
+		<string>UIWindowSceneSessionRoleApplication</string>
+		<key>UIApplicationSupportsMultipleScenes</key>
+-   <false/>
++		<true/>
+		<key>UISceneConfigurations</key>
+		<dict/>
+	</dict>
+</dict>
+</plist>
+
+```
+
+
+1. Inside `App.swift` add new `ImmersiveSpace`:
+```diff
+@main
+struct HelloWorldApp: App {
+  @UIApplicationDelegateAdaptor var delegate: AppDelegate
++ @State private var immersionLevel: ImmersionStyle = .mixed
+  
+  var body: some Scene {
+    RCTMainWindow(moduleName: "HelloWorldApp")
++   ImmersiveSpace(id: "TestImmersiveSpace") {
++     // RealityKit content goes here
++   }
++    .immersionStyle(selection: $immersionLevel, in: .mixed, .progressive, .full)
+  }
+}
+```
+For more information about `ImmersiveSpace` API refer to [Apple documentation](https://developer.apple.com/documentation/swiftui/immersive-spaces).
+
+In the above example we set `ImmersiveSpace` id to `TestImmersiveSpace`.
+
+Now in our JS code, we can call: 
+
+```js
+import {XR} from "@callstack/react-native-visionos"
+//...
+const openXRSession = async () => {
+  try {
+    if (!XR.supportsMultipleScenes) {
+      Alert.alert('Error', 'Multiple scenes are not supported');
+      return;
+    }
+    await XR.requestSession('TestImmersiveSpace'); // Pass the same identifier from `App.swift`
+  } catch (e) {
+    Alert.alert('Error', e.message);
+  }
+};
+
+const closeXRSession = async () => {
+  await XR.endSession();
+};
+```
+> [!CAUTION]
+> Opening an `ImmersiveSpace` can fail in this secarios:
+> - `ImmersiveSpace` is not declared.
+> - `UIApplicationSupportsMultipleScenes` is set to `false`.
+> - User cancels the request.
+
+For a full example usage, refer to [`XRExample.js`](https://github.com/callstack/react-native-visionos/blob/main/packages/rn-tester/js/examples/XR/XRExample.js).
+
 ## Contributing
 
 1. Follow the same steps as in the `New project creation` section.

packages/react-native/Libraries/Spatial/NativeSpatialManager.js

@@ -1,6 +1,4 @@
 import SwiftUI
-import React
-
 
 /**
  This SwiftUI struct returns main React Native scene. It should be used only once as it conains setup code.

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

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

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

@@ -9,6 +9,11 @@ import SwiftUI
 
 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

packages/react-native/Libraries/SwiftExtensions/RCTMainWindow.swift

@@ -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/SwiftExtensions/React-RCTSwiftExtensions.podspec

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

packages/react-native/Libraries/Spatial/ImmersiveBridge.swift renamed to packages/react-native/Libraries/XR/ImmersiveBridge.swift

@@ -1,53 +1,47 @@
-#import <React/RCTSpatialManager.h>
+#import <React/RCTXRModule.h>
+
+#import <FBReactNativeSpec_visionOS/FBReactNativeSpec_visionOS.h>
 
-#import <FBReactNativeSpec/FBReactNativeSpec.h>
 #import <React/RCTBridge.h>
 #import <React/RCTConvert.h>
 #import <React/RCTUtils.h>
-#import "RCTSpatial-Swift.h"
+#import "RCTXR-Swift.h"
 
-@interface RCTSpatialManager () <NativeSpatialManagerSpec>
+@interface RCTXRModule () <NativeXRModuleSpec>
 @end
 
-@implementation RCTSpatialManager {
+@implementation RCTXRModule {
   UIViewController *_immersiveBridgeView;
 }
 
 RCT_EXPORT_MODULE()
 
-- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:(const facebook::react::ObjCTurboModule::InitParams &)params {
-  return std::make_shared<facebook::react::NativeSpatialManagerSpecJSI>(params);
-}
-
-RCT_EXPORT_METHOD(dismissImmersiveSpace
+RCT_EXPORT_METHOD(endSession
                   : (RCTPromiseResolveBlock)resolve reject
                   : (RCTPromiseRejectBlock)reject)
 {
-  RCTExecuteOnMainQueue(^{
-    [self->_immersiveBridgeView willMoveToParentViewController:nil];
-    [self->_immersiveBridgeView.view removeFromSuperview];
-    [self->_immersiveBridgeView removeFromParentViewController];
-    self->_immersiveBridgeView = nil;
-    
-    resolve(nil);
-  });
+  [self removeImmersiveBridge];
+  resolve(nil);
 }
 
-RCT_EXPORT_METHOD(openImmersiveSpace
-                  : (NSString *)sceneId resolve
+
+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:sceneId
-                                                                         completionHandler:^(enum ImmersiveSpaceResult result){
+      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);
         }
@@ -62,4 +56,33 @@ @implementation RCTSpatialManager {
   });
 }
 
+- (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/NativeXRModule.js

@@ -21,9 +21,9 @@ header_search_paths = [
 ]
 
 Pod::Spec.new do |s|
-  s.name                   = "React-RCTSpatial"
+  s.name                   = "React-RCTXR"
   s.version                = version
-  s.summary                = "Spatial module for React Native."
+  s.summary                = "XR module for React Native."
   s.homepage               = "https://reactnative.dev/"
   s.documentation_url      = "https://reactnative.dev/docs/settings"
   s.license                = package["license"]
@@ -33,7 +33,7 @@ Pod::Spec.new do |s|
   s.source                 = source
   s.source_files           = "*.{m,mm,swift}"
   s.preserve_paths         = "package.json", "LICENSE", "LICENSE-docs"
-  s.header_dir             = "RCTSpatial"
+  s.header_dir             = "RCTXR"
   s.pod_target_xcconfig    = {
                                "USE_HEADERMAP" => "YES",
                                "CLANG_CXX_LANGUAGE_STANDARD" => "c++20",
@@ -43,7 +43,7 @@ Pod::Spec.new do |s|
   s.dependency "RCT-Folly", folly_version
   s.dependency "RCTTypeSafety"
   s.dependency "React-jsi"
-  s.dependency "React-Core/RCTSpatialHeaders"
+  s.dependency "React-Core/RCTXRHeaders"
 
   add_dependency(s, "React-Codegen", :additional_framework_paths => ["build/generated/ios"])
   add_dependency(s, "ReactCommon", :subspec => "turbomodule/core", :additional_framework_paths => ["react/nativemodule/core"])

packages/react-native/Libraries/Spatial/RCTSpatialManager.h renamed to packages/react-native/Libraries/XR/RCTXRModule.h

@@ -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/Spatial/RCTSpatialManager.mm renamed to packages/react-native/Libraries/XR/RCTXRModule.mm

@@ -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/Spatial/React-RCTSpatial.podspec renamed to packages/react-native/Libraries/XR/React-RCTXR.podspec

@@ -9151,6 +9151,22 @@ exports[`public API should not change unintentionally Libraries/WebSocket/WebSoc
 
 exports[`public API should not change unintentionally Libraries/WebSocket/WebSocketInterceptor.js 1`] = `"UNTYPED MODULE"`;
 
+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<{||}>;
@@ -9268,6 +9284,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/Libraries/XR/XR.d.ts

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