@callstack/brownfield-cli 3.10.0 → 3.11.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @callstack/brownfield-cli
 
+## 3.11.0
+
+### Minor Changes
+
+- [#358](https://github.com/callstack/react-native-brownfield/pull/358) [`3715ac7`](https://github.com/callstack/react-native-brownfield/commit/3715ac7783000756ef1c66ecfe24a85c5e43abab) Thanks [@adamTrz](https://github.com/adamTrz)! - Add `--add-spm-package` to `brownfield package:ios` so packaging can also generate a local Swift Package Manager wrapper around the produced XCFrameworks, including a generated `Package.swift`, `README.md`, and Xcode integration instructions. Fail fast when Debug packaging cannot resolve the app framework name while local SPM output is requested.
+
+- [#364](https://github.com/callstack/react-native-brownfield/pull/364) [`05c557d`](https://github.com/callstack/react-native-brownfield/commit/05c557da9e2b6fca02e6e1a0b0fe71a909bab15f) Thanks [@hurali97](https://github.com/hurali97)! - keep only one reference of xcframeworks when spm enabled
+
 ## 3.10.0
 
 ### Minor Changes

package/dist/brownfield/commands/packageIos.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageIos.d.ts","sourceRoot":"","sources":["../../../src/brownfield/commands/packageIos.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,OAAO,EAAU,MAAM,WAAW,CAAC;AAK5C,OAAO,EAGL,YAAY,EACb,MAAM,uBAAuB,CAAC;AAY/B,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,MAAM,GAAG,OAAO,GACtB,OAAO,CAcT;AAOD,eAAO,MAAM,iBAAiB,SA6L3B,CAAC;AAEJ,eAAO,MAAM,iBAAiB,cAG7B,CAAC"}
+{"version":3,"file":"packageIos.d.ts","sourceRoot":"","sources":["../../../src/brownfield/commands/packageIos.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,OAAO,EAAU,MAAM,WAAW,CAAC;AAK5C,OAAO,EAGL,YAAY,EACb,MAAM,uBAAuB,CAAC;AAe/B,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,MAAM,GAAG,OAAO,GACtB,OAAO,CAcT;AAqBD,eAAO,MAAM,iBAAiB,SA8P3B,CAAC;AAEJ,eAAO,MAAM,iBAAiB,cAG7B,CAAC"}

package/dist/brownfield/commands/packageIos.js

@@ -10,7 +10,10 @@ import { supportsPrebuiltRNCore } from '../utils/supportsPrebuiltRNCore.js';
 import { actionRunner, curryOptions, ExampleUsage, } from '../../shared/index.js';
 import { runBrownieCodegenIfApplicable } from '../../brownie/helpers/runBrownieCodegenIfApplicable.js';
 import { runNavigationCodegenIfApplicable } from '../../navigation/helpers/runNavigationCodegenIfApplicable.js';
+import { copyDebugBundleToSimulatorSlice } from '../utils/copyDebugBundleToSimulatorSlice.js';
+import { resolvePackagedFrameworkName } from '../utils/resolvePackagedFrameworkName.js';
 import { stripFrameworkBinary } from '../utils/stripFrameworkBinary.js';
+import { createLocalSpmPackage } from '../utils/createLocalSpmPackage.js';
 /** Help text for `--use-prebuilt-rn-core` (keep in sync with docs/docs/docs/getting-started/ios.mdx, "React Native Prebuilts" section). */
 const USE_PREBUILT_RN_CORE_HELP = 'Whether the Xcode build for packaging should use React Native Apple prebuilt binaries (via CocoaPods). ' +
     'If you omit this flag, Brownfield follows version-aware defaults: for React Native 0.84 and newer, prebuilts are enabled by default; for RN 0.83, they are disabled unless you opt in. ' +
@@ -29,6 +32,11 @@ export function parseUsePrebuiltRnCoreArgument(value) {
     }
     throw new RockError(`Invalid value for --use-prebuilt-rn-core: expected true or false, received "${value}"`);
 }
+function getPackagedFrameworkResolutionFailureMessage({ resolution, candidates, }) {
+    return resolution === 'ambiguous'
+        ? `found multiple bundled framework candidates (${candidates?.join(', ') ?? 'none'}); pass --scheme explicitly`
+        : 'could not resolve the packaged framework output automatically; pass --scheme explicitly';
+}
 export const packageIosCommand = curryOptions(new Command('package:ios').description('Build iOS XCFramework'), getBuildOptions({ platformName: 'ios' }).map((option) => option.name.startsWith('--build-folder')
     ? {
         ...option,
@@ -39,6 +47,7 @@ export const packageIosCommand = curryOptions(new Command('package:ios').descrip
     .addOption(new Option('--use-prebuilt-rn-core [bool]', USE_PREBUILT_RN_CORE_HELP)
     .preset(true)
     .argParser(parseUsePrebuiltRnCoreArgument))
+    .addOption(new Option('--add-spm-package', 'Generate a local Swift Package Manager manifest next to the packaged XCFramework outputs'))
     .action(actionRunner(async (options) => {
     const { projectRoot, platformConfig, userConfig } = getProjectInfo('ios');
     const prebuiltRNCoreSupport = supportsPrebuiltRNCore({ projectRoot });
@@ -93,6 +102,42 @@ export const packageIosCommand = curryOptions(new Command('package:ios').descrip
         skipCache: true, // cache is dependent on existence of Rock config file
         usePrebuiltRNCore: options.usePrebuiltRnCore,
     }, platformConfig);
+    const productsPath = path.join(options.buildFolder, 'Build', 'Products');
+    const { frameworkName, resolution, candidates } = resolvePackagedFrameworkName({
+        explicitScheme: options.scheme,
+        productsPath,
+        configuration,
+    });
+    if (!frameworkName && options.addSpmPackage) {
+        throw new RockError(`Cannot generate local SPM package: ${getPackagedFrameworkResolutionFailureMessage({
+            resolution,
+            candidates,
+        })}`);
+    }
+    if (frameworkName) {
+        copyDebugBundleToSimulatorSlice({
+            productsPath,
+            configuration,
+            frameworkName,
+        });
+        if (configuration.includes('Debug')) {
+            // Re-merge only Debug frameworks so the simulator slice includes main.jsbundle.
+            await mergeFrameworks({
+                sourceDir: userConfig.project.ios.sourceDir,
+                frameworkPaths: [
+                    path.join(productsPath, `${configuration}-iphoneos`, `${frameworkName}.framework`),
+                    path.join(productsPath, `${configuration}-iphonesimulator`, `${frameworkName}.framework`),
+                ],
+                outputPath: path.join(packageDir, `${frameworkName}.xcframework`),
+            });
+        }
+    }
+    else if (configuration.includes('Debug')) {
+        logger.warn(`Skipping Debug simulator JS bundle copy: ${getPackagedFrameworkResolutionFailureMessage({
+            resolution,
+            candidates,
+        })}`);
+    }
     const reactBrownfieldXcframeworkPath = path.join(packageDir, 'ReactBrownfield.xcframework');
     if (fs.existsSync(reactBrownfieldXcframeworkPath)) {
         // Strip the binary from ReactBrownfield.xcframework to make it interface-only.
@@ -101,7 +146,6 @@ export const packageIosCommand = curryOptions(new Command('package:ios').descrip
         stripFrameworkBinary(reactBrownfieldXcframeworkPath);
     }
     if (hasBrownie) {
-        const productsPath = path.join(options.buildFolder, 'Build', 'Products');
         const brownieOutputPath = path.join(packageDir, 'Brownie.xcframework');
         await mergeFrameworks({
             sourceDir: userConfig.project.ios.sourceDir,
@@ -118,7 +162,6 @@ export const packageIosCommand = curryOptions(new Command('package:ios').descrip
         logger.success(`Brownie.xcframework created at ${colorLink(relativeToCwd(brownieOutputPath))}`);
     }
     if (hasNavigation) {
-        const productsPath = path.join(options.buildFolder, 'Build', 'Products');
         const brownfieldNavigationOutputPath = path.join(packageDir, 'BrownfieldNavigation.xcframework');
         await mergeFrameworks({
             sourceDir: userConfig.project.ios.sourceDir,
@@ -131,5 +174,14 @@ export const packageIosCommand = curryOptions(new Command('package:ios').descrip
         stripFrameworkBinary(brownfieldNavigationOutputPath);
         logger.success(`BrownfieldNavigation.xcframework created at ${colorLink(relativeToCwd(brownfieldNavigationOutputPath))}`);
     }
+    if (options.addSpmPackage) {
+        const { packageManifestPath } = createLocalSpmPackage({
+            packageDir,
+            frameworkName: frameworkName ?? undefined,
+        });
+        logger.success(`Local SPM package manifest created at ${colorLink(relativeToCwd(packageManifestPath))}`);
+        logger.info(`Add the local package folder in Xcode: ${colorLink(relativeToCwd(packageDir))}`);
+        logger.info("In Xcode, choose File > Add Package Dependencies..., click Add Local..., and select that folder.");
+    }
 }));
 export const packageIosExample = new ExampleUsage('package:ios --scheme BrownfieldLib --configuration Release', "Build iOS XCFramework for 'BrownfieldLib' scheme in Release configuration");

package/dist/brownfield/utils/copyDebugBundleToSimulatorSlice.d.ts

@@ -0,0 +1,8 @@
+interface CopyDebugBundleToSimulatorSliceOptions {
+    productsPath: string;
+    configuration: string;
+    frameworkName: string;
+}
+export declare function copyDebugBundleToSimulatorSlice({ productsPath, configuration, frameworkName, }: CopyDebugBundleToSimulatorSliceOptions): void;
+export {};
+//# sourceMappingURL=copyDebugBundleToSimulatorSlice.d.ts.map

package/dist/brownfield/utils/copyDebugBundleToSimulatorSlice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyDebugBundleToSimulatorSlice.d.ts","sourceRoot":"","sources":["../../../src/brownfield/utils/copyDebugBundleToSimulatorSlice.ts"],"names":[],"mappings":"AAKA,UAAU,sCAAsC;IAC9C,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,wBAAgB,+BAA+B,CAAC,EAC9C,YAAY,EACZ,aAAa,EACb,aAAa,GACd,EAAE,sCAAsC,QA0CxC"}

package/dist/brownfield/utils/copyDebugBundleToSimulatorSlice.js

@@ -0,0 +1,21 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { colorLink, logger, relativeToCwd } from '@rock-js/tools';
+export function copyDebugBundleToSimulatorSlice({ productsPath, configuration, frameworkName, }) {
+    if (!configuration.includes('Debug')) {
+        return;
+    }
+    const deviceBundlePath = path.join(productsPath, `${configuration}-iphoneos`, `${frameworkName}.framework`, 'main.jsbundle');
+    const simulatorFrameworkPath = path.join(productsPath, `${configuration}-iphonesimulator`, `${frameworkName}.framework`);
+    const simulatorBundlePath = path.join(simulatorFrameworkPath, 'main.jsbundle');
+    if (!fs.existsSync(deviceBundlePath)) {
+        logger.warn(`Skipping simulator JS bundle copy: missing ${relativeToCwd(deviceBundlePath)}`);
+        return;
+    }
+    if (!fs.existsSync(simulatorFrameworkPath)) {
+        logger.warn(`Skipping simulator JS bundle copy: missing ${relativeToCwd(simulatorFrameworkPath)}`);
+        return;
+    }
+    fs.copyFileSync(deviceBundlePath, simulatorBundlePath);
+    logger.success(`Copied Debug JS bundle to simulator slice at ${colorLink(relativeToCwd(simulatorBundlePath))}`);
+}

package/dist/brownfield/utils/createLocalSpmPackage.d.ts

@@ -0,0 +1,10 @@
+type CreateLocalSpmPackageOptions = {
+    packageDir: string;
+    frameworkName?: string;
+};
+type CreateLocalSpmPackageResult = {
+    packageManifestPath: string;
+};
+export declare function createLocalSpmPackage({ packageDir, frameworkName, }: CreateLocalSpmPackageOptions): CreateLocalSpmPackageResult;
+export {};
+//# sourceMappingURL=createLocalSpmPackage.d.ts.map

package/dist/brownfield/utils/createLocalSpmPackage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createLocalSpmPackage.d.ts","sourceRoot":"","sources":["../../../src/brownfield/utils/createLocalSpmPackage.ts"],"names":[],"mappings":"AAQA,KAAK,4BAA4B,GAAG;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,KAAK,2BAA2B,GAAG;IACjC,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAuJF,wBAAgB,qBAAqB,CAAC,EACpC,UAAU,EACV,aAAa,GACd,EAAE,4BAA4B,GAAG,2BAA2B,CAsC5D"}

package/dist/brownfield/utils/createLocalSpmPackage.js

@@ -0,0 +1,138 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { prepareLocalSpmArtifacts, SPM_ARTIFACTS_DIR_NAME, } from './prepareLocalSpmArtifacts.js';
+const RESERVED_FRAMEWORK_NAMES = new Set([
+    'hermes',
+    'hermesvm',
+    'ReactBrownfield',
+    'Brownie',
+    'BrownfieldNavigation',
+    'React',
+    'ReactNativeDependencies',
+]);
+function requireXcframework(packageDir, name) {
+    const xcframeworkPath = path.join(packageDir, `${name}.xcframework`);
+    if (!fs.existsSync(xcframeworkPath)) {
+        throw new Error(`Missing required XCFramework: ${name}.xcframework`);
+    }
+    return name;
+}
+function optionalXcframework(packageDir, name) {
+    return fs.existsSync(path.join(packageDir, `${name}.xcframework`))
+        ? name
+        : null;
+}
+function requireHermesXcframework(packageDir) {
+    return (optionalXcframework(packageDir, 'hermesvm') ??
+        requireXcframework(packageDir, 'hermes'));
+}
+function resolveAppFrameworkName(packageDir, explicitFrameworkName) {
+    if (explicitFrameworkName) {
+        return requireXcframework(packageDir, explicitFrameworkName);
+    }
+    const candidates = fs
+        .readdirSync(packageDir, { withFileTypes: true })
+        .filter((entry) => entry.isDirectory() &&
+        entry.name.endsWith('.xcframework') &&
+        !RESERVED_FRAMEWORK_NAMES.has(path.basename(entry.name, '.xcframework')))
+        .map((entry) => path.basename(entry.name, '.xcframework'))
+        .sort();
+    if (candidates.length === 1 && candidates[0]) {
+        return candidates[0];
+    }
+    if (candidates.length === 0) {
+        throw new Error('Could not resolve the packaged app XCFramework automatically. Pass --scheme explicitly when packaging.');
+    }
+    throw new Error(`Found multiple packaged app XCFramework candidates (${candidates.join(', ')}). Pass --scheme explicitly when packaging.`);
+}
+function renderPackageSwift({ packageName, libraryName, targetNames, }) {
+    const binaryTargets = targetNames
+        .map((targetName) => `    .binaryTarget(name: "${targetName}", path: "./${SPM_ARTIFACTS_DIR_NAME}/${targetName}.xcframework")`)
+        .join(',\n');
+    const targetDependencies = targetNames
+        .map((targetName) => `"${targetName}"`)
+        .join(', ');
+    return `// swift-tools-version: 5.9
+
+import PackageDescription
+
+let package = Package(
+  name: "${packageName}",
+  platforms: [
+    .iOS(.v14),
+  ],
+  products: [
+    .library(name: "${libraryName}", targets: [${targetDependencies}]),
+  ],
+  targets: [
+${binaryTargets}
+  ]
+)
+`;
+}
+function renderReadme({ packageName, libraryName, targetNames, }) {
+    const frameworks = targetNames.map((targetName) => `- \`${targetName}\``).join('\n');
+    return `# ${packageName}
+
+This is a generated local Swift Package Manager package for the packaged React Native brownfield artifacts.
+
+## Product
+
+- Library product: \`${libraryName}\`
+
+## Included Binary Targets
+
+${frameworks}
+
+## How To Use
+
+1. In Xcode, choose **File > Add Package Dependencies...**
+2. Click **Add Local...**
+3. Select this folder, the one containing \`Package.swift\` and the \`spm-artifacts\` directory
+4. Add the \`${libraryName}\` library product to your app target
+
+## Troubleshooting
+
+If Xcode builds your host app but the simulator installation fails, check the host app target first:
+
+- Make sure the target still includes its app entry point source files, such as \`App.swift\`, \`SceneDelegate\`, \`AppDelegate\`, or equivalent startup files
+- Make sure the host target uses the same React Native module name that the packaged app registers for its brownfield surface. This repo's example apps use \`RNApp\` for both the plain React Native and Expo variants
+- If the install error says the app is "missing its bundle executable", the host app target produced an invalid \`.app\` bundle and the issue is not in this generated SPM package
+- If you are migrating an existing target from direct \`*.xcframework\` linking to local SPM, remove the old direct XCFramework references before building again
+
+This folder is generated by \`brownfield package:ios --add-spm-package\`. Re-run that command whenever the packaged XCFrameworks change so this package stays in sync.
+`;
+}
+export function createLocalSpmPackage({ packageDir, frameworkName, }) {
+    const resolvedFrameworkName = resolveAppFrameworkName(packageDir, frameworkName);
+    const targetNames = [
+        resolvedFrameworkName,
+        requireHermesXcframework(packageDir),
+        requireXcframework(packageDir, 'ReactBrownfield'),
+        optionalXcframework(packageDir, 'Brownie'),
+        optionalXcframework(packageDir, 'BrownfieldNavigation'),
+        optionalXcframework(packageDir, 'React'),
+        optionalXcframework(packageDir, 'ReactNativeDependencies'),
+    ].filter((targetName) => targetName !== null);
+    const packageManifestPath = path.join(packageDir, 'Package.swift');
+    const readmePath = path.join(packageDir, 'README.md');
+    prepareLocalSpmArtifacts({
+        packageDir,
+        targetNames,
+    });
+    const manifest = renderPackageSwift({
+        packageName: `${resolvedFrameworkName}Package`,
+        libraryName: resolvedFrameworkName,
+        targetNames,
+    });
+    const readme = renderReadme({
+        packageName: `${resolvedFrameworkName}Package`,
+        libraryName: resolvedFrameworkName,
+        targetNames,
+    });
+    fs.writeFileSync(packageManifestPath, manifest, 'utf8');
+    fs.writeFileSync(readmePath, readme, 'utf8');
+    return {
+        packageManifestPath,
+    };
+}

package/dist/brownfield/utils/prepareLocalSpmArtifacts.d.ts

@@ -0,0 +1,8 @@
+type PrepareLocalSpmArtifactsOptions = {
+    packageDir: string;
+    targetNames: string[];
+};
+export declare const SPM_ARTIFACTS_DIR_NAME = "spm-artifacts";
+export declare function prepareLocalSpmArtifacts({ packageDir, targetNames, }: PrepareLocalSpmArtifactsOptions): string;
+export {};
+//# sourceMappingURL=prepareLocalSpmArtifacts.d.ts.map

package/dist/brownfield/utils/prepareLocalSpmArtifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareLocalSpmArtifacts.d.ts","sourceRoot":"","sources":["../../../src/brownfield/utils/prepareLocalSpmArtifacts.ts"],"names":[],"mappings":"AAIA,KAAK,+BAA+B,GAAG;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,sBAAsB,kBAAkB,CAAC;AAyFtD,wBAAgB,wBAAwB,CAAC,EACvC,UAAU,EACV,WAAW,GACZ,EAAE,+BAA+B,UAejC"}

package/dist/brownfield/utils/prepareLocalSpmArtifacts.js

@@ -0,0 +1,77 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { execFileSync } from 'node:child_process';
+export const SPM_ARTIFACTS_DIR_NAME = 'spm-artifacts';
+function removeCodeSignatureArtifacts(dirPath) {
+    for (const entry of fs.readdirSync(dirPath, { withFileTypes: true })) {
+        const entryPath = path.join(dirPath, entry.name);
+        if (entry.isDirectory()) {
+            if (entry.name === '_CodeSignature') {
+                fs.rmSync(entryPath, { recursive: true, force: true });
+                continue;
+            }
+            removeCodeSignatureArtifacts(entryPath);
+            continue;
+        }
+        if (entry.name === 'CodeResources') {
+            fs.rmSync(entryPath, { force: true });
+        }
+    }
+}
+function resolveFrameworkExecutablePath(frameworkDir, frameworkName) {
+    const directExecutablePath = path.join(frameworkDir, frameworkName);
+    if (fs.existsSync(directExecutablePath)) {
+        return directExecutablePath;
+    }
+    const versionedExecutablePath = path.join(frameworkDir, 'Versions', 'Current', frameworkName);
+    if (fs.existsSync(versionedExecutablePath)) {
+        return versionedExecutablePath;
+    }
+    return null;
+}
+function removeExecutableSignature(executablePath) {
+    try {
+        execFileSync('codesign', ['--remove-signature', executablePath], {
+            stdio: 'pipe',
+        });
+    }
+    catch (error) {
+        if (error instanceof Error &&
+            error.message.includes('code object is not signed at all')) {
+            return;
+        }
+        throw error;
+    }
+}
+function normalizeCopiedXcframeworkSignature(xcframeworkPath) {
+    removeCodeSignatureArtifacts(xcframeworkPath);
+    for (const sliceName of fs.readdirSync(xcframeworkPath)) {
+        const slicePath = path.join(xcframeworkPath, sliceName);
+        if (!fs.statSync(slicePath).isDirectory()) {
+            continue;
+        }
+        for (const entry of fs.readdirSync(slicePath)) {
+            if (!entry.endsWith('.framework')) {
+                continue;
+            }
+            const frameworkName = path.basename(entry, '.framework');
+            const frameworkDir = path.join(slicePath, entry);
+            const executablePath = resolveFrameworkExecutablePath(frameworkDir, frameworkName);
+            if (executablePath) {
+                removeExecutableSignature(executablePath);
+            }
+        }
+    }
+}
+export function prepareLocalSpmArtifacts({ packageDir, targetNames, }) {
+    const spmArtifactsDir = path.join(packageDir, SPM_ARTIFACTS_DIR_NAME);
+    fs.rmSync(spmArtifactsDir, { recursive: true, force: true });
+    fs.mkdirSync(spmArtifactsDir, { recursive: true });
+    for (const targetName of targetNames) {
+        const sourcePath = path.join(packageDir, `${targetName}.xcframework`);
+        const destinationPath = path.join(spmArtifactsDir, `${targetName}.xcframework`);
+        fs.renameSync(sourcePath, destinationPath);
+        normalizeCopiedXcframeworkSignature(destinationPath);
+    }
+    return spmArtifactsDir;
+}

package/dist/brownfield/utils/resolvePackagedFrameworkName.d.ts

@@ -0,0 +1,14 @@
+type Resolution = 'explicit' | 'detected' | 'not_found' | 'ambiguous';
+export interface ResolvePackagedFrameworkNameResult {
+    frameworkName: string | null;
+    resolution: Resolution;
+    candidates?: string[];
+}
+interface ResolvePackagedFrameworkNameOptions {
+    explicitScheme?: string;
+    productsPath: string;
+    configuration: string;
+}
+export declare function resolvePackagedFrameworkName({ explicitScheme, productsPath, configuration, }: ResolvePackagedFrameworkNameOptions): ResolvePackagedFrameworkNameResult;
+export {};
+//# sourceMappingURL=resolvePackagedFrameworkName.d.ts.map

package/dist/brownfield/utils/resolvePackagedFrameworkName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePackagedFrameworkName.d.ts","sourceRoot":"","sources":["../../../src/brownfield/utils/resolvePackagedFrameworkName.ts"],"names":[],"mappings":"AAGA,KAAK,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC;AAEtE,MAAM,WAAW,kCAAkC;IACjD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,UAAU,mCAAmC;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AA4CD,wBAAgB,4BAA4B,CAAC,EAC3C,cAAc,EACd,YAAY,EACZ,aAAa,GACd,EAAE,mCAAmC,GAAG,kCAAkC,CAkC1E"}

package/dist/brownfield/utils/resolvePackagedFrameworkName.js

@@ -0,0 +1,61 @@
+import fs from 'node:fs';
+import path from 'node:path';
+function collectFrameworkCandidates(configurationProductsPath) {
+    if (!fs.existsSync(configurationProductsPath)) {
+        return [];
+    }
+    const discoveredFrameworks = new Set();
+    for (const entry of fs.readdirSync(configurationProductsPath, { withFileTypes: true })) {
+        const entryPath = path.join(configurationProductsPath, entry.name);
+        if (entry.isDirectory() && entry.name.endsWith('.framework')) {
+            const frameworkName = path.basename(entry.name, '.framework');
+            const bundlePath = path.join(entryPath, 'main.jsbundle');
+            if (fs.existsSync(bundlePath)) {
+                discoveredFrameworks.add(frameworkName);
+            }
+            continue;
+        }
+        if (!entry.isDirectory()) {
+            continue;
+        }
+        for (const nestedEntry of fs.readdirSync(entryPath, { withFileTypes: true })) {
+            if (!nestedEntry.isDirectory() || !nestedEntry.name.endsWith('.framework')) {
+                continue;
+            }
+            const frameworkName = path.basename(nestedEntry.name, '.framework');
+            const bundlePath = path.join(entryPath, nestedEntry.name, 'main.jsbundle');
+            if (fs.existsSync(bundlePath)) {
+                discoveredFrameworks.add(frameworkName);
+            }
+        }
+    }
+    return [...discoveredFrameworks].sort();
+}
+export function resolvePackagedFrameworkName({ explicitScheme, productsPath, configuration, }) {
+    if (explicitScheme) {
+        return {
+            frameworkName: explicitScheme,
+            resolution: 'explicit',
+        };
+    }
+    const configurationProductsPath = path.join(productsPath, `${configuration}-iphoneos`);
+    const candidates = collectFrameworkCandidates(configurationProductsPath);
+    if (candidates.length === 1) {
+        return {
+            frameworkName: candidates[0] ?? null,
+            resolution: 'detected',
+        };
+    }
+    if (candidates.length === 0) {
+        return {
+            frameworkName: null,
+            resolution: 'not_found',
+            candidates,
+        };
+    }
+    return {
+        frameworkName: null,
+        resolution: 'ambiguous',
+        candidates,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@callstack/brownfield-cli",
-  "version": "3.10.0",
+  "version": "3.11.0",
   "license": "MIT",
   "author": "Artur Morys-Magiera <artus9033@gmail.com>",
   "bin": {

package/src/brownfield/commands/packageIos.ts

@@ -27,7 +27,10 @@ import {
 } from '../../shared/index.js';
 import { runBrownieCodegenIfApplicable } from '../../brownie/helpers/runBrownieCodegenIfApplicable.js';
 import { runNavigationCodegenIfApplicable } from '../../navigation/helpers/runNavigationCodegenIfApplicable.js';
+import { copyDebugBundleToSimulatorSlice } from '../utils/copyDebugBundleToSimulatorSlice.js';
+import { resolvePackagedFrameworkName } from '../utils/resolvePackagedFrameworkName.js';
 import { stripFrameworkBinary } from '../utils/stripFrameworkBinary.js';
+import { createLocalSpmPackage } from '../utils/createLocalSpmPackage.js';
 
 /** Help text for `--use-prebuilt-rn-core` (keep in sync with docs/docs/docs/getting-started/ios.mdx, "React Native Prebuilts" section). */
 const USE_PREBUILT_RN_CORE_HELP =
@@ -54,9 +57,23 @@ export function parseUsePrebuiltRnCoreArgument(
   );
 }
 
+function getPackagedFrameworkResolutionFailureMessage({
+  resolution,
+  candidates,
+}: {
+  resolution: string | null | undefined;
+  candidates?: string[];
+}) {
+  return resolution === 'ambiguous'
+    ? `found multiple bundled framework candidates (${candidates?.join(', ') ?? 'none'}); pass --scheme explicitly`
+    : 'could not resolve the packaged framework output automatically; pass --scheme explicitly';
+}
+
 type PackageIosCliFlags = AppleBuildFlags & {
   /** Set when `--use-prebuilt-rn-core` is passed; omitted when the flag is absent (Rock applies RN version defaults). */
   usePrebuiltRnCore?: boolean;
+  /** When set, generate a local Swift Package Manager manifest next to the packaged XCFramework outputs. */
+  addSpmPackage?: boolean;
 };
 
 export const packageIosCommand = curryOptions(
@@ -77,6 +94,12 @@ export const packageIosCommand = curryOptions(
       .preset(true)
       .argParser(parseUsePrebuiltRnCoreArgument)
   )
+  .addOption(
+    new Option(
+      '--add-spm-package',
+      'Generate a local Swift Package Manager manifest next to the packaged XCFramework outputs'
+    )
+  )
   .action(
     actionRunner(async (options: PackageIosCliFlags) => {
       const { projectRoot, platformConfig, userConfig } = getProjectInfo('ios');
@@ -163,6 +186,58 @@ export const packageIosCommand = curryOptions(
         platformConfig
       );
 
+      const productsPath = path.join(options.buildFolder, 'Build', 'Products');
+      const { frameworkName, resolution, candidates } =
+        resolvePackagedFrameworkName({
+          explicitScheme: options.scheme,
+          productsPath,
+          configuration,
+        });
+
+      if (!frameworkName && options.addSpmPackage) {
+        throw new RockError(
+          `Cannot generate local SPM package: ${getPackagedFrameworkResolutionFailureMessage({
+            resolution,
+            candidates,
+          })}`
+        );
+      }
+
+      if (frameworkName) {
+        copyDebugBundleToSimulatorSlice({
+          productsPath,
+          configuration,
+          frameworkName,
+        });
+
+        if (configuration.includes('Debug')) {
+          // Re-merge only Debug frameworks so the simulator slice includes main.jsbundle.
+          await mergeFrameworks({
+            sourceDir: userConfig.project.ios.sourceDir,
+            frameworkPaths: [
+              path.join(
+                productsPath,
+                `${configuration}-iphoneos`,
+                `${frameworkName}.framework`
+              ),
+              path.join(
+                productsPath,
+                `${configuration}-iphonesimulator`,
+                `${frameworkName}.framework`
+              ),
+            ],
+            outputPath: path.join(packageDir, `${frameworkName}.xcframework`),
+          });
+        }
+      } else if (configuration.includes('Debug')) {
+        logger.warn(
+          `Skipping Debug simulator JS bundle copy: ${getPackagedFrameworkResolutionFailureMessage({
+            resolution,
+            candidates,
+          })}`
+        );
+      }
+
       const reactBrownfieldXcframeworkPath = path.join(
         packageDir,
         'ReactBrownfield.xcframework'
@@ -175,11 +250,6 @@ export const packageIosCommand = curryOptions(
       }
 
       if (hasBrownie) {
-        const productsPath = path.join(
-          options.buildFolder,
-          'Build',
-          'Products'
-        );
         const brownieOutputPath = path.join(packageDir, 'Brownie.xcframework');
 
         await mergeFrameworks({
@@ -212,11 +282,6 @@ export const packageIosCommand = curryOptions(
       }
 
       if (hasNavigation) {
-        const productsPath = path.join(
-          options.buildFolder,
-          'Build',
-          'Products'
-        );
         const brownfieldNavigationOutputPath = path.join(
           packageDir,
           'BrownfieldNavigation.xcframework'
@@ -247,6 +312,23 @@ export const packageIosCommand = curryOptions(
           `BrownfieldNavigation.xcframework created at ${colorLink(relativeToCwd(brownfieldNavigationOutputPath))}`
         );
       }
+
+      if (options.addSpmPackage) {
+        const { packageManifestPath } = createLocalSpmPackage({
+          packageDir,
+          frameworkName: frameworkName ?? undefined,
+        });
+
+        logger.success(
+          `Local SPM package manifest created at ${colorLink(relativeToCwd(packageManifestPath))}`
+        );
+        logger.info(
+          `Add the local package folder in Xcode: ${colorLink(relativeToCwd(packageDir))}`
+        );
+        logger.info(
+          "In Xcode, choose File > Add Package Dependencies..., click Add Local..., and select that folder."
+        );
+      }
     })
   );
 

package/src/brownfield/utils/copyDebugBundleToSimulatorSlice.ts

@@ -0,0 +1,58 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import { colorLink, logger, relativeToCwd } from '@rock-js/tools';
+
+interface CopyDebugBundleToSimulatorSliceOptions {
+  productsPath: string;
+  configuration: string;
+  frameworkName: string;
+}
+
+export function copyDebugBundleToSimulatorSlice({
+  productsPath,
+  configuration,
+  frameworkName,
+}: CopyDebugBundleToSimulatorSliceOptions) {
+  if (!configuration.includes('Debug')) {
+    return;
+  }
+
+  const deviceBundlePath = path.join(
+    productsPath,
+    `${configuration}-iphoneos`,
+    `${frameworkName}.framework`,
+    'main.jsbundle'
+  );
+
+  const simulatorFrameworkPath = path.join(
+    productsPath,
+    `${configuration}-iphonesimulator`,
+    `${frameworkName}.framework`
+  );
+
+  const simulatorBundlePath = path.join(
+    simulatorFrameworkPath,
+    'main.jsbundle'
+  );
+
+  if (!fs.existsSync(deviceBundlePath)) {
+    logger.warn(
+      `Skipping simulator JS bundle copy: missing ${relativeToCwd(deviceBundlePath)}`
+    );
+    return;
+  }
+
+  if (!fs.existsSync(simulatorFrameworkPath)) {
+    logger.warn(
+      `Skipping simulator JS bundle copy: missing ${relativeToCwd(simulatorFrameworkPath)}`
+    );
+    return;
+  }
+
+  fs.copyFileSync(deviceBundlePath, simulatorBundlePath);
+
+  logger.success(
+    `Copied Debug JS bundle to simulator slice at ${colorLink(relativeToCwd(simulatorBundlePath))}`
+  );
+}

package/src/brownfield/utils/createLocalSpmPackage.ts

@@ -0,0 +1,208 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import {
+  prepareLocalSpmArtifacts,
+  SPM_ARTIFACTS_DIR_NAME,
+} from './prepareLocalSpmArtifacts.js';
+
+type CreateLocalSpmPackageOptions = {
+  packageDir: string;
+  frameworkName?: string;
+};
+
+type CreateLocalSpmPackageResult = {
+  packageManifestPath: string;
+};
+
+const RESERVED_FRAMEWORK_NAMES = new Set([
+  'hermes',
+  'hermesvm',
+  'ReactBrownfield',
+  'Brownie',
+  'BrownfieldNavigation',
+  'React',
+  'ReactNativeDependencies',
+]);
+
+function requireXcframework(packageDir: string, name: string) {
+  const xcframeworkPath = path.join(packageDir, `${name}.xcframework`);
+
+  if (!fs.existsSync(xcframeworkPath)) {
+    throw new Error(`Missing required XCFramework: ${name}.xcframework`);
+  }
+
+  return name;
+}
+
+function optionalXcframework(packageDir: string, name: string) {
+  return fs.existsSync(path.join(packageDir, `${name}.xcframework`))
+    ? name
+    : null;
+}
+
+function requireHermesXcframework(packageDir: string) {
+  return (
+    optionalXcframework(packageDir, 'hermesvm') ??
+    requireXcframework(packageDir, 'hermes')
+  );
+}
+
+function resolveAppFrameworkName(
+  packageDir: string,
+  explicitFrameworkName?: string
+) {
+  if (explicitFrameworkName) {
+    return requireXcframework(packageDir, explicitFrameworkName);
+  }
+
+  const candidates = fs
+    .readdirSync(packageDir, { withFileTypes: true })
+    .filter(
+      (entry) =>
+        entry.isDirectory() &&
+        entry.name.endsWith('.xcframework') &&
+        !RESERVED_FRAMEWORK_NAMES.has(path.basename(entry.name, '.xcframework'))
+    )
+    .map((entry) => path.basename(entry.name, '.xcframework'))
+    .sort();
+
+  if (candidates.length === 1 && candidates[0]) {
+    return candidates[0];
+  }
+
+  if (candidates.length === 0) {
+    throw new Error(
+      'Could not resolve the packaged app XCFramework automatically. Pass --scheme explicitly when packaging.'
+    );
+  }
+
+  throw new Error(
+    `Found multiple packaged app XCFramework candidates (${candidates.join(', ')}). Pass --scheme explicitly when packaging.`
+  );
+}
+
+function renderPackageSwift({
+  packageName,
+  libraryName,
+  targetNames,
+}: {
+  packageName: string;
+  libraryName: string;
+  targetNames: string[];
+}) {
+  const binaryTargets = targetNames
+    .map(
+      (targetName) =>
+        `    .binaryTarget(name: "${targetName}", path: "./${SPM_ARTIFACTS_DIR_NAME}/${targetName}.xcframework")`
+    )
+    .join(',\n');
+
+  const targetDependencies = targetNames
+    .map((targetName) => `"${targetName}"`)
+    .join(', ');
+
+  return `// swift-tools-version: 5.9
+
+import PackageDescription
+
+let package = Package(
+  name: "${packageName}",
+  platforms: [
+    .iOS(.v14),
+  ],
+  products: [
+    .library(name: "${libraryName}", targets: [${targetDependencies}]),
+  ],
+  targets: [
+${binaryTargets}
+  ]
+)
+`;
+}
+
+function renderReadme({
+  packageName,
+  libraryName,
+  targetNames,
+}: {
+  packageName: string;
+  libraryName: string;
+  targetNames: string[];
+}) {
+  const frameworks = targetNames.map((targetName) => `- \`${targetName}\``).join('\n');
+
+  return `# ${packageName}
+
+This is a generated local Swift Package Manager package for the packaged React Native brownfield artifacts.
+
+## Product
+
+- Library product: \`${libraryName}\`
+
+## Included Binary Targets
+
+${frameworks}
+
+## How To Use
+
+1. In Xcode, choose **File > Add Package Dependencies...**
+2. Click **Add Local...**
+3. Select this folder, the one containing \`Package.swift\` and the \`spm-artifacts\` directory
+4. Add the \`${libraryName}\` library product to your app target
+
+## Troubleshooting
+
+If Xcode builds your host app but the simulator installation fails, check the host app target first:
+
+- Make sure the target still includes its app entry point source files, such as \`App.swift\`, \`SceneDelegate\`, \`AppDelegate\`, or equivalent startup files
+- Make sure the host target uses the same React Native module name that the packaged app registers for its brownfield surface. This repo's example apps use \`RNApp\` for both the plain React Native and Expo variants
+- If the install error says the app is "missing its bundle executable", the host app target produced an invalid \`.app\` bundle and the issue is not in this generated SPM package
+- If you are migrating an existing target from direct \`*.xcframework\` linking to local SPM, remove the old direct XCFramework references before building again
+
+This folder is generated by \`brownfield package:ios --add-spm-package\`. Re-run that command whenever the packaged XCFrameworks change so this package stays in sync.
+`;
+}
+
+export function createLocalSpmPackage({
+  packageDir,
+  frameworkName,
+}: CreateLocalSpmPackageOptions): CreateLocalSpmPackageResult {
+  const resolvedFrameworkName = resolveAppFrameworkName(
+    packageDir,
+    frameworkName
+  );
+  const targetNames = [
+    resolvedFrameworkName,
+    requireHermesXcframework(packageDir),
+    requireXcframework(packageDir, 'ReactBrownfield'),
+    optionalXcframework(packageDir, 'Brownie'),
+    optionalXcframework(packageDir, 'BrownfieldNavigation'),
+    optionalXcframework(packageDir, 'React'),
+    optionalXcframework(packageDir, 'ReactNativeDependencies'),
+  ].filter((targetName): targetName is string => targetName !== null);
+
+  const packageManifestPath = path.join(packageDir, 'Package.swift');
+  const readmePath = path.join(packageDir, 'README.md');
+  prepareLocalSpmArtifacts({
+    packageDir,
+    targetNames,
+  });
+  const manifest = renderPackageSwift({
+    packageName: `${resolvedFrameworkName}Package`,
+    libraryName: resolvedFrameworkName,
+    targetNames,
+  });
+  const readme = renderReadme({
+    packageName: `${resolvedFrameworkName}Package`,
+    libraryName: resolvedFrameworkName,
+    targetNames,
+  });
+
+  fs.writeFileSync(packageManifestPath, manifest, 'utf8');
+  fs.writeFileSync(readmePath, readme, 'utf8');
+
+  return {
+    packageManifestPath,
+  };
+}

package/src/brownfield/utils/prepareLocalSpmArtifacts.ts

@@ -0,0 +1,117 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { execFileSync } from 'node:child_process';
+
+type PrepareLocalSpmArtifactsOptions = {
+  packageDir: string;
+  targetNames: string[];
+};
+
+export const SPM_ARTIFACTS_DIR_NAME = 'spm-artifacts';
+
+function removeCodeSignatureArtifacts(dirPath: string) {
+  for (const entry of fs.readdirSync(dirPath, { withFileTypes: true })) {
+    const entryPath = path.join(dirPath, entry.name);
+
+    if (entry.isDirectory()) {
+      if (entry.name === '_CodeSignature') {
+        fs.rmSync(entryPath, { recursive: true, force: true });
+        continue;
+      }
+
+      removeCodeSignatureArtifacts(entryPath);
+      continue;
+    }
+
+    if (entry.name === 'CodeResources') {
+      fs.rmSync(entryPath, { force: true });
+    }
+  }
+}
+
+function resolveFrameworkExecutablePath(
+  frameworkDir: string,
+  frameworkName: string
+) {
+  const directExecutablePath = path.join(frameworkDir, frameworkName);
+  if (fs.existsSync(directExecutablePath)) {
+    return directExecutablePath;
+  }
+
+  const versionedExecutablePath = path.join(
+    frameworkDir,
+    'Versions',
+    'Current',
+    frameworkName
+  );
+  if (fs.existsSync(versionedExecutablePath)) {
+    return versionedExecutablePath;
+  }
+
+  return null;
+}
+
+function removeExecutableSignature(executablePath: string) {
+  try {
+    execFileSync('codesign', ['--remove-signature', executablePath], {
+      stdio: 'pipe',
+    });
+  } catch (error) {
+    if (
+      error instanceof Error &&
+      error.message.includes('code object is not signed at all')
+    ) {
+      return;
+    }
+
+    throw error;
+  }
+}
+
+function normalizeCopiedXcframeworkSignature(xcframeworkPath: string) {
+  removeCodeSignatureArtifacts(xcframeworkPath);
+
+  for (const sliceName of fs.readdirSync(xcframeworkPath)) {
+    const slicePath = path.join(xcframeworkPath, sliceName);
+    if (!fs.statSync(slicePath).isDirectory()) {
+      continue;
+    }
+
+    for (const entry of fs.readdirSync(slicePath)) {
+      if (!entry.endsWith('.framework')) {
+        continue;
+      }
+
+      const frameworkName = path.basename(entry, '.framework');
+      const frameworkDir = path.join(slicePath, entry);
+      const executablePath = resolveFrameworkExecutablePath(
+        frameworkDir,
+        frameworkName
+      );
+
+      if (executablePath) {
+        removeExecutableSignature(executablePath);
+      }
+    }
+  }
+}
+
+export function prepareLocalSpmArtifacts({
+  packageDir,
+  targetNames,
+}: PrepareLocalSpmArtifactsOptions) {
+  const spmArtifactsDir = path.join(packageDir, SPM_ARTIFACTS_DIR_NAME);
+
+  fs.rmSync(spmArtifactsDir, { recursive: true, force: true });
+  fs.mkdirSync(spmArtifactsDir, { recursive: true });
+
+  for (const targetName of targetNames) {
+    const sourcePath = path.join(packageDir, `${targetName}.xcframework`);
+    const destinationPath = path.join(spmArtifactsDir, `${targetName}.xcframework`);
+
+    fs.renameSync(sourcePath, destinationPath);
+    normalizeCopiedXcframeworkSignature(destinationPath);
+  }
+
+  return spmArtifactsDir;
+}

package/src/brownfield/utils/resolvePackagedFrameworkName.ts

@@ -0,0 +1,98 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+type Resolution = 'explicit' | 'detected' | 'not_found' | 'ambiguous';
+
+export interface ResolvePackagedFrameworkNameResult {
+  frameworkName: string | null;
+  resolution: Resolution;
+  candidates?: string[];
+}
+
+interface ResolvePackagedFrameworkNameOptions {
+  explicitScheme?: string;
+  productsPath: string;
+  configuration: string;
+}
+
+function collectFrameworkCandidates(configurationProductsPath: string): string[] {
+  if (!fs.existsSync(configurationProductsPath)) {
+    return [];
+  }
+
+  const discoveredFrameworks = new Set<string>();
+
+  for (const entry of fs.readdirSync(configurationProductsPath, { withFileTypes: true })) {
+    const entryPath = path.join(configurationProductsPath, entry.name);
+
+    if (entry.isDirectory() && entry.name.endsWith('.framework')) {
+      const frameworkName = path.basename(entry.name, '.framework');
+      const bundlePath = path.join(entryPath, 'main.jsbundle');
+
+      if (fs.existsSync(bundlePath)) {
+        discoveredFrameworks.add(frameworkName);
+      }
+
+      continue;
+    }
+
+    if (!entry.isDirectory()) {
+      continue;
+    }
+
+    for (const nestedEntry of fs.readdirSync(entryPath, { withFileTypes: true })) {
+      if (!nestedEntry.isDirectory() || !nestedEntry.name.endsWith('.framework')) {
+        continue;
+      }
+
+      const frameworkName = path.basename(nestedEntry.name, '.framework');
+      const bundlePath = path.join(entryPath, nestedEntry.name, 'main.jsbundle');
+
+      if (fs.existsSync(bundlePath)) {
+        discoveredFrameworks.add(frameworkName);
+      }
+    }
+  }
+
+  return [...discoveredFrameworks].sort();
+}
+
+export function resolvePackagedFrameworkName({
+  explicitScheme,
+  productsPath,
+  configuration,
+}: ResolvePackagedFrameworkNameOptions): ResolvePackagedFrameworkNameResult {
+  if (explicitScheme) {
+    return {
+      frameworkName: explicitScheme,
+      resolution: 'explicit',
+    };
+  }
+
+  const configurationProductsPath = path.join(
+    productsPath,
+    `${configuration}-iphoneos`
+  );
+  const candidates = collectFrameworkCandidates(configurationProductsPath);
+
+  if (candidates.length === 1) {
+    return {
+      frameworkName: candidates[0] ?? null,
+      resolution: 'detected',
+    };
+  }
+
+  if (candidates.length === 0) {
+    return {
+      frameworkName: null,
+      resolution: 'not_found',
+      candidates,
+    };
+  }
+
+  return {
+    frameworkName: null,
+    resolution: 'ambiguous',
+    candidates,
+  };
+}