Use ".apple.node" instead of ".xcframeworks"

Author: kraenhansen

packages/ferric-example/.gitignore

@@ -2,6 +2,7 @@
 Cargo.lock
 
 /*.xcframework/
+/*.apple.node/
 /*.android.node/
 
 # Generated files

packages/ferric/src/build.ts

@@ -66,6 +66,11 @@ const ndkVersionOption = new Option(
   "--ndk-version <version>",
   "The NDK version to use for Android builds"
 ).default(DEFAULT_NDK_VERSION);
+const xcframeworkExtensionOption = new Option(
+  "--xcframework-extension",
+  "Don't rename the xcframework to .apple.node"
+).default(false);
+
 const outputPathOption = new Option(
   "--output <path>",
   "Writing outputs to this directory"
@@ -85,6 +90,7 @@ export const buildCommand = new Command("build")
   .addOption(ndkVersionOption)
   .addOption(outputPathOption)
   .addOption(configurationOption)
+  .addOption(xcframeworkExtensionOption)
   .action(
     async ({
       target: targetArg,
@@ -93,6 +99,7 @@ export const buildCommand = new Command("build")
       ndkVersion,
       output: outputPath,
       configuration,
+      xcframeworkExtension,
     }) => {
       try {
         const targets = new Set([...targetArg]);
@@ -221,8 +228,10 @@ export const buildCommand = new Command("build")
         if (appleLibraries.length > 0) {
           const libraryPaths = await combineLibraries(appleLibraries);
           const frameworkPaths = libraryPaths.map(createAppleFramework);
-          const xcframeworkFilename =
-            determineXCFrameworkFilename(frameworkPaths);
+          const xcframeworkFilename = determineXCFrameworkFilename(
+            frameworkPaths,
+            xcframeworkExtension ? ".xcframework" : ".apple.node"
+          );
 
           // Create the xcframework
           const xcframeworkOutputPath = path.resolve(

packages/react-native-node-api-cmake/src/cli.ts

@@ -91,6 +91,11 @@ const noWeakNodeApiLinkageOption = new Option(
   "Don't pass the path of the weak-node-api library from react-native-node-api-modules"
 );
 
+const xcframeworkExtensionOption = new Option(
+  "--xcframework-extension",
+  "Don't rename the xcframework to .apple.node"
+).default(false);
+
 export const program = new Command("react-native-node-api-cmake")
   .description("Build React Native Node API modules with CMake")
   .addOption(sourcePathOption)
@@ -104,6 +109,7 @@ export const program = new Command("react-native-node-api-cmake")
   .addOption(ndkVersionOption)
   .addOption(noAutoLinkOption)
   .addOption(noWeakNodeApiLinkageOption)
+  .addOption(xcframeworkExtensionOption)
   .action(async ({ triplet: tripletValues, ...globalContext }) => {
     try {
       const buildPath = getBuildPath(globalContext);
@@ -212,8 +218,10 @@ export const program = new Command("react-native-node-api-cmake")
           })
         );
         const frameworkPaths = libraryPaths.map(createAppleFramework);
-        const xcframeworkFilename =
-          determineXCFrameworkFilename(frameworkPaths);
+        const xcframeworkFilename = determineXCFrameworkFilename(
+          frameworkPaths,
+          globalContext.xcframeworkExtension ? ".xcframework" : ".apple.node"
+        );
 
         // Create the xcframework
         const xcframeworkOutputPath = path.resolve(

packages/react-native-node-api-modules/package.json

@@ -42,7 +42,7 @@
     "copy-node-api-headers": "tsx scripts/copy-node-api-headers.ts",
     "generate-weak-node-api": "tsx scripts/generate-weak-node-api.ts",
     "generate-weak-node-api-injector": "tsx scripts/generate-weak-node-api-injector.ts",
-    "build-weak-node-api": "npm run generate-weak-node-api && react-native-node-api-cmake --android --apple --no-auto-link --no-weak-node-api-linkage --source ./weak-node-api",
+    "build-weak-node-api": "npm run generate-weak-node-api && react-native-node-api-cmake --android --apple --no-auto-link --no-weak-node-api-linkage --xcframework-extension --source ./weak-node-api",
     "test": "tsx --test src/node/**/*.test.ts src/node/*.test.ts"
   },
   "keywords": [

packages/react-native-node-api-modules/src/node/path-utils.ts

@@ -13,8 +13,7 @@ export type PlatformName = "android" | "apple";
 
 export const PLATFORM_EXTENSIONS = {
   android: ".android.node",
-  // TODO: Change to .apple.node
-  apple: ".xcframework",
+  apple: ".apple.node",
 } as const satisfies Record<PlatformName, string>;
 export type PlatformExtentions = (typeof PLATFORM_EXTENSIONS)[PlatformName];
 

packages/react-native-node-api-modules/src/node/prebuilds/apple.ts

@@ -95,18 +95,28 @@ export async function createXCframework({
   // Ideally, it would only be necessary to delete the specific platform+arch, to allow selectively building from source.
   fs.rmSync(outputPath, { recursive: true, force: true });
 
+  // Xcodebuild requires the output path to end with ".xcframework"
+  const xcodeOutputPath =
+    path.extname(outputPath) === ".xcframework"
+      ? outputPath
+      : `${outputPath}.xcframework`;
+
   await spawn(
     "xcodebuild",
     [
       "-create-xcframework",
       ...frameworkPaths.flatMap((p) => ["-framework", p]),
       "-output",
-      outputPath,
+      xcodeOutputPath,
     ],
     {
       outputMode: "buffered",
     }
   );
+  if (xcodeOutputPath !== outputPath) {
+    // Rename the xcframework to the original output path
+    await fs.promises.rename(xcodeOutputPath, outputPath);
+  }
   if (autoLink) {
     // Write a file to mark the xcframework is a Node-API module
     // TODO: Consider including this in the Info.plist file instead
@@ -122,9 +132,12 @@ export async function createXCframework({
  * Determine the filename of the xcframework based on the framework paths.
  * Ensuring that all framework paths have the same base name.
  */
-export function determineXCFrameworkFilename(frameworkPaths: string[]) {
+export function determineXCFrameworkFilename(
+  frameworkPaths: string[],
+  extension: ".xcframework" | ".apple.node" = ".xcframework"
+) {
   const name = determineLibraryBasename(frameworkPaths);
-  return `${name}.xcframework`;
+  return `${name}${extension}`;
 }
 
 export async function createUniversalAppleLibrary(libraryPaths: string[]) {