feat(visionos): support for xros platform (#235)

Author: NathanWalker

.github/workflows/npm_release.yml

@@ -59,7 +59,7 @@ jobs:
           echo NPM_VERSION=$NPM_VERSION >> $GITHUB_OUTPUT
           echo NPM_TAG=$NPM_TAG >> $GITHUB_OUTPUT
       - name: Build
-        run: npm run build
+        run: npm run build-ios
       - name: Upload npm package artifact
         uses: actions/upload-artifact@v3
         with:

.github/workflows/pull_request.yml

@@ -43,7 +43,7 @@ jobs:
           echo NPM_VERSION=$NPM_VERSION >> $GITHUB_ENV
           npm version $NPM_VERSION --no-git-tag-version
       - name: Build
-        run: npm run build
+        run: npm run build-ios
       - name: Upload npm package artifact
         uses: actions/upload-artifact@v3
         with:

.gitignore

@@ -50,3 +50,9 @@ v8_build
 # v8 build files...
 .gclient*
 .cipd/
+
+# project template
+/project-template-ios/.build_env_vars.sh
+/project-template-ios/__PROJECT_NAME__.xcodeproj/project.xcworkspace/xcshareddata/
+/project-template-vision/.build_env_vars.sh
+/project-template-vision/__PROJECT_NAME__.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

NativeScript/NativeScript-Prefix.pch

@@ -1,7 +1,7 @@
 #ifndef NativeScript_Prefix_pch
 #define NativeScript_Prefix_pch
 
-#define NATIVESCRIPT_VERSION "8.6.1"
+#define NATIVESCRIPT_VERSION "8.7.0-rc.1"
 
 #ifdef DEBUG
 #define SIZEOF_OFF_T 8

NativeScript/inspector/utils.mm

@@ -19,6 +19,7 @@
     }
 
     NSString* fileExtension = [fullPath pathExtension];
+    #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
     CFStringRef uti = UTTypeCreatePreferredIdentifierForTag(kUTTagClassFilenameExtension, (__bridge CFStringRef)fileExtension, nil);
     if (uti == nil) {
         return std::string();

NativeScript/lib/arm64-xros/libcppgc_base.a

@@ -0,0 +1 @@
+!<arch>

NativeScript/lib/arm64-xros/libcrdtp.a

@@ -0,0 +1 @@
+!<arch>

NativeScript/lib/arm64-xros/libcrdtp_platform.a

@@ -17,22 +17,25 @@ void LogMetadataUnavailable(const char* identifierString, uint8_t majorVersion,
     );
 }
 
+#if !TARGET_OS_VISION
 /**
  * \brief Gets the system version of the current device.
  */
 static UInt8 getSystemVersion() {
-    static UInt8 iosVersion;
-    if (iosVersion != 0) {
-        return iosVersion;
-    }
+   static UInt8 iosVersion;
+   if (iosVersion != 0) {
+       return iosVersion;
+   }
 
-    NSString* version = [[UIDevice currentDevice] systemVersion];
-    NSArray* versionTokens = [version componentsSeparatedByCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"."]];
-    UInt8 majorVersion = (UInt8)[versionTokens[0] intValue];
-    UInt8 minorVersion = (UInt8)[versionTokens[1] intValue];
+   NSString* version = [[UIDevice currentDevice] systemVersion];
+   NSArray* versionTokens = [version componentsSeparatedByCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"."]];
+   UInt8 majorVersion = (UInt8)[versionTokens[0] intValue];
+   UInt8 minorVersion = (UInt8)[versionTokens[1] intValue];
 
-    return iosVersion = encodeVersion(majorVersion, minorVersion);
+   return iosVersion = encodeVersion(majorVersion, minorVersion);
 }
+#endif
+
 robin_hood::unordered_map<std::string, MembersCollection> getMetasByJSNames(MembersCollection members) {
     robin_hood::unordered_map<std::string, MembersCollection> result;
     for (auto member : members) {
@@ -43,9 +46,13 @@ static UInt8 getSystemVersion() {
 
 // Meta
 bool Meta::isAvailable() const {
-    UInt8 introducedIn = this->introducedIn();
-    UInt8 systemVersion = getSystemVersion();
-    return introducedIn == 0 || introducedIn <= systemVersion;
+     #if TARGET_OS_VISION
+         return true;
+     #else
+        UInt8 introducedIn = this->introducedIn();
+        UInt8 systemVersion = getSystemVersion();
+        return introducedIn == 0 || introducedIn <= systemVersion;
+     #endif
 }
 
 // MethodMeta class

NativeScript/lib/arm64-xros/libffi.a

@@ -3,6 +3,7 @@
 
 #include <objc/runtime.h>
 #include "StringHasher.h"
+#include <cassert>
 
 namespace tns {
 

NativeScript/lib/arm64-xros/libinspector.a

@@ -225,6 +225,8 @@ static Counts& counts() {
 #    define ROBIN_HOOD_PRIVATE_DEFINITION_NODISCARD()
 #endif
 
+#pragma GCC diagnostic ignored "-Wdeprecated-builtins"
+
 namespace robin_hood {
 
 #if ROBIN_HOOD(CXX) >= ROBIN_HOOD(CXX14)

NativeScript/lib/arm64-xros/libinspector_string_conversions.a

@@ -4,7 +4,7 @@ set -e
 rm -rf ./dist
 ./update_version.sh
 ./build_metadata_generator.sh
-./build_nativescript.sh
-./build_tklivesync.sh
+./build_nativescript.sh --no-vision
+./build_tklivesync.sh --no-vision
 ./prepare_dSYMs.sh
-./build_npm.sh
+./build_npm_ios.sh

NativeScript/lib/arm64-xros/libtorque_generated_definitions.a

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+rm -rf ./dist
+./update_version.sh
+./build_metadata_generator.sh
+./build_nativescript.sh --no-catalyst --no-iphone --no-sim
+./build_tklivesync.sh --no-catalyst --no-iphone --no-sim
+./prepare_dSYMs.sh
+./build_npm_vision.sh

NativeScript/lib/arm64-xros/libtorque_generated_initializers.a

@@ -23,8 +23,13 @@ rm -rf dist
 mkdir dist
 checkpoint "Building metadata generator for x86_64 ..."
 build "x86_64"
+# make sure the binary is linked against the system libc++ instead of an @rpath one (which happens when compiling on arm64)
+# todo: perhaps there is a better way to do this with cmake?
+install_name_tool -change @rpath/libc++.1.dylib /usr/lib/libc++.1.dylib dist/x86_64/bin/objc-metadata-generator
+otool -L  dist/x86_64/bin/objc-metadata-generator
 
 checkpoint "Building metadata generator for arm64 ..."
 build "arm64"
+otool -L  dist/arm64/bin/objc-metadata-generator
 rm -rf build
 popd

NativeScript/lib/arm64-xros/libv8_base_without_compiler.a

@@ -26,6 +26,7 @@ function to_bool() {
 BUILD_CATALYST=$(to_bool ${BUILD_CATALYST:=true})
 BUILD_IPHONE=$(to_bool ${BUILD_IPHONE:=true})
 BUILD_SIMULATOR=$(to_bool ${BUILD_SIMULATOR:=true})
+BUILD_VISION=$(to_bool ${BUILD_VISION:=true})
 VERBOSE=$(to_bool ${VERBOSE:=false})
 
 for arg in $@; do
@@ -36,6 +37,8 @@ for arg in $@; do
     --no-sim|--no-simulator) BUILD_SIMULATOR=false ;;
     --iphone|--device) BUILD_IPHONE=true ;;
     --no-iphone|--no-device) BUILD_IPHONE=false ;;
+    --xr|--vision) BUILD_VISION=true ;;
+    --no-xr|--no-vision) BUILD_VISION=false ;;
     --verbose|-v) VERBOSE=true ;;
     *) ;;
   esac
@@ -58,52 +61,17 @@ xcodebuild -project v8ios.xcodeproj \
            -configuration Release clean \
            $QUIET
 
-
-if $BUILD_CATALYST; then
-checkpoint "Building NativeScript for Mac Catalyst"
-xcodebuild archive -project v8ios.xcodeproj \
-                   -scheme "NativeScript" \
-                   -configuration Release \
-                   -destination "platform=macOS,variant=Mac Catalyst" \
-                   $QUIET \
-                   EXCLUDED_ARCHS="x86_64" \
-                   SKIP_INSTALL=NO \
-                   -archivePath $DIST/intermediates/NativeScript.maccatalyst.xcarchive
-fi
-
 if $BUILD_SIMULATOR; then
-# checkpoint "Building for x86_64 iphone simulator"
-# xcodebuild archive -project v8ios.xcodeproj \
-#                    -scheme "NativeScript" \
-#                    -configuration Release \
-#                    -arch x86_64 \
-#                    -sdk iphonesimulator \
-#                    $QUIET \
-#                    DEVELOPMENT_TEAM=$DEV_TEAM \
-#                    SKIP_INSTALL=NO \
-#                    -archivePath $DIST/NativeScript.x86_64-iphonesimulator.xcarchive
-
-# checkpoint "Building for ARM64 iphone simulator"
-# xcodebuild archive -project v8ios.xcodeproj \
-#                    -scheme "NativeScript" \
-#                    -configuration Release \
-#                    -arch arm64 \
-#                    -sdk iphonesimulator \
-#                    $QUIET \
-#                    DEVELOPMENT_TEAM=$DEV_TEAM \
-#                    SKIP_INSTALL=NO \
-#                    -archivePath $DIST/NativeScript.arm64-iphonesimulator.xcarchive
-
 checkpoint "Building NativeScript for iphone simulators (multi-arch)"
 xcodebuild archive -project v8ios.xcodeproj \
                    -scheme "NativeScript" \
                    -configuration Release \
                    -destination "generic/platform=iOS Simulator" \
-                   -sdk iphonesimulator \
                    $QUIET \
                    EXCLUDED_ARCHS="i386" \
                    DEVELOPMENT_TEAM=$DEV_TEAM \
                    SKIP_INSTALL=NO \
+                   BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
                    -archivePath $DIST/intermediates/NativeScript.iphonesimulator.xcarchive
 fi
 
@@ -113,27 +81,54 @@ xcodebuild archive -project v8ios.xcodeproj \
                    -scheme "NativeScript" \
                    -configuration Release \
                    -destination "generic/platform=iOS" \
-                   -sdk iphoneos \
                    $QUIET \
                    EXCLUDED_ARCHS="armv7" \
                    DEVELOPMENT_TEAM=$DEV_TEAM \
                    SKIP_INSTALL=NO \
+                   BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
                    -archivePath $DIST/intermediates/NativeScript.iphoneos.xcarchive
+fi
 
-#Create fat library for simulator
-# rm -rf "$DIST/NativeScript.iphonesimulator.xcarchive"
+if $BUILD_CATALYST; then
+checkpoint "Building NativeScript for Mac Catalyst"
+xcodebuild archive -project v8ios.xcodeproj \
+                   -scheme "NativeScript" \
+                   -configuration Release \
+                   -destination "generic/platform=macOS,variant=Mac Catalyst" \
+                   $QUIET \
+                   EXCLUDED_ARCHS="x86_64" \
+                   SKIP_INSTALL=NO \
+                   BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
+                   -archivePath $DIST/intermediates/NativeScript.maccatalyst.xcarchive
+fi
 
-# cp -R \
-#     "$DIST/NativeScript.x86_64-iphonesimulator.xcarchive" \
-#     "$DIST/NativeScript.iphonesimulator.xcarchive"
+if $BUILD_VISION; then
 
-# rm "$DIST/NativeScript.iphonesimulator.xcarchive/Products/Library/Frameworks/NativeScript.framework/NativeScript"
+checkpoint "Building NativeScript for visionOS Device"
+xcodebuild archive -project v8ios.xcodeproj \
+                   -scheme "NativeScript" \
+                   -configuration Release \
+                   -destination "generic/platform=visionOS" \
+                   $QUIET \
+                   EXCLUDED_ARCHS="i386 x86_64" \
+                   VALID_ARCHS=arm64 \
+                   DEVELOPMENT_TEAM=$DEV_TEAM \
+                   SKIP_INSTALL=NO \
+                   BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
+                   -archivePath $DIST/intermediates/NativeScript.xros.xcarchive
 
-# lipo -create \
-#     "$DIST/NativeScript.x86_64-iphonesimulator.xcarchive/Products/Library/Frameworks/NativeScript.framework/NativeScript" \
-#     "$DIST/NativeScript.arm64-iphonesimulator.xcarchive/Products/Library/Frameworks/NativeScript.framework/NativeScript" \
-#     -output \
-#     "$DIST/NativeScript.iphonesimulator.xcarchive/Products/Library/Frameworks/NativeScript.framework/NativeScript"
+checkpoint "Building NativeScript for visionOS Simulators"
+xcodebuild archive -project v8ios.xcodeproj \
+                   -scheme "NativeScript" \
+                   -configuration Release \
+                   -destination "generic/platform=visionOS Simulator" \
+                   $QUIET \
+                   EXCLUDED_ARCHS="i386 x86_64" \
+                   VALID_ARCHS=arm64 \
+                   DEVELOPMENT_TEAM=$DEV_TEAM \
+                   SKIP_INSTALL=NO \
+                   BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
+                   -archivePath $DIST/intermediates/NativeScript.xrsimulator.xcarchive
 fi
 
 XCFRAMEWORKS=()
@@ -152,6 +147,13 @@ if $BUILD_IPHONE; then
                   -debug-symbols "$DIST/intermediates/NativeScript.iphoneos.xcarchive/dSYMs/NativeScript.framework.dSYM" )
 fi
 
+if $BUILD_VISION; then
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/NativeScript.xros.xcarchive/Products/Library/Frameworks/NativeScript.framework" \
+                  -debug-symbols "$DIST/intermediates/NativeScript.xros.xcarchive/dSYMs/NativeScript.framework.dSYM" )
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/NativeScript.xrsimulator.xcarchive/Products/Library/Frameworks/NativeScript.framework" \
+                  -debug-symbols "$DIST/intermediates/NativeScript.xrsimulator.xcarchive/dSYMs/NativeScript.framework.dSYM" )
+fi
+
 checkpoint "Creating NativeScript.xcframework"
 OUTPUT_DIR="$DIST/NativeScript.xcframework"
 rm -rf $OUTPUT_DIR

NativeScript/lib/arm64-xros/libv8_bigint.a

@@ -1,12 +1,15 @@
 #!/bin/bash
 set -e
+source "$(dirname "$0")/build_utils.sh"
 
+checkpoint "Preparing npm package for iOS..."
 OUTPUT_DIR="dist/npm"
 rm -rf "$OUTPUT_DIR"
 mkdir -p "$OUTPUT_DIR"
 mkdir -p "$OUTPUT_DIR/framework"
 cp ./package.json "$OUTPUT_DIR"
-cp -r "./project-template/" "$OUTPUT_DIR/framework"
+
+cp -r "./project-template-ios/" "$OUTPUT_DIR/framework"
 
 cp -r "dist/NativeScript.xcframework" "$OUTPUT_DIR/framework/internal"
 cp -r "dist/TKLiveSync.xcframework" "$OUTPUT_DIR/framework/internal"
@@ -28,4 +31,6 @@ cp -r "metadata-generator/dist/arm64/." "$OUTPUT_DIR/framework/internal/metadata
 pushd "$OUTPUT_DIR"
 npm pack
 mv *.tgz ../
-popd
+popd
+
+checkpoint "npm package created."

NativeScript/lib/arm64-xros/libv8_compiler.a

@@ -0,0 +1,36 @@
+#!/bin/bash
+set -e
+source "$(dirname "$0")/build_utils.sh"
+
+checkpoint "Preparing npm package for visionOS..."
+OUTPUT_DIR="dist/npm"
+rm -rf "$OUTPUT_DIR"
+mkdir -p "$OUTPUT_DIR"
+mkdir -p "$OUTPUT_DIR/framework"
+cp ./package.json "$OUTPUT_DIR"
+
+cp -r "./project-template-vision/" "$OUTPUT_DIR/framework"
+
+cp -r "dist/NativeScript.xcframework" "$OUTPUT_DIR/framework/internal"
+cp -r "dist/TKLiveSync.xcframework" "$OUTPUT_DIR/framework/internal"
+
+mkdir -p "$OUTPUT_DIR/framework/internal/metadata-generator-x86_64"
+cp -r "metadata-generator/dist/x86_64/." "$OUTPUT_DIR/framework/internal/metadata-generator-x86_64"
+
+mkdir -p "$OUTPUT_DIR/framework/internal/metadata-generator-arm64"
+cp -r "metadata-generator/dist/arm64/." "$OUTPUT_DIR/framework/internal/metadata-generator-arm64"
+
+# Add xcframeworks to .zip (NPM modules do not support symlinks, unzipping is done by {N} CLI)
+(
+    set -e
+    cd $OUTPUT_DIR/framework/internal
+    zip -qr --symlinks XCFrameworks.zip *.xcframework
+    rm -rf *.xcframework
+)
+
+pushd "$OUTPUT_DIR"
+npm pack
+mv *.tgz ../
+popd
+
+checkpoint "npm package created."