@callstack/brownfield-cli 3.13.0 → 3.13.2

package/schema.json

@@ -0,0 +1,195 @@
+{
+  "$ref": "#/definitions/BrownfieldConfig",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "BrownfieldAndroidConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "expo": {
+          "$ref": "#/definitions/BrownfieldExpoAndroidConfig",
+          "description": "Expo config plugin options for Android Expo prebuild phase."
+        },
+        "moduleName": {
+          "description": "AAR module name.",
+          "type": "string"
+        },
+        "variant": {
+          "description": "Your app's build variant, which is constructed from build type and product flavor, e.g. 'debug' or 'freeRelease'.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "BrownfieldConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "$schema": {
+          "type": "string"
+        },
+        "android": {
+          "$ref": "#/definitions/BrownfieldAndroidConfig",
+          "description": "Brownfield Android configuration."
+        },
+        "brownie": {
+          "$ref": "#/definitions/BrownieConfig",
+          "description": "Brownie (state library) configuration."
+        },
+        "ios": {
+          "$ref": "#/definitions/BrownfieldIosConfig",
+          "description": "Brownfield iOS configuration."
+        },
+        "verbose": {
+          "description": "Enables verbose CLI logging.",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "BrownfieldExpoAndroidConfig": {
+      "additionalProperties": false,
+      "description": "Expo config plugin options for Android prebuild scaffolding.",
+      "properties": {
+        "artifactId": {
+          "description": "Maven artifact ID used when publishing the AAR.",
+          "type": "string"
+        },
+        "compileSdkVersion": {
+          "description": "Compile SDK version for the Android library.",
+          "type": "number"
+        },
+        "groupId": {
+          "description": "Maven group ID used when publishing the AAR.",
+          "type": "string"
+        },
+        "minSdkVersion": {
+          "description": "Minimum SDK version for the Android library.",
+          "type": "number"
+        },
+        "packageName": {
+          "description": "The package name for the Android library module.",
+          "type": "string"
+        },
+        "targetSdkVersion": {
+          "description": "Target SDK version for the Android library.",
+          "type": "number"
+        },
+        "useLocalGradlePlugin": {
+          "description": "When true, load the Brownfield Gradle plugin from `@callstack/react-native-brownfield/gradle-plugin/brownfield` via `includeBuild` instead of adding the Maven classpath dependency. Disabled by default.",
+          "type": "boolean"
+        },
+        "version": {
+          "description": "Maven version used when publishing the AAR.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "BrownfieldExpoIosConfig": {
+      "additionalProperties": false,
+      "description": "Expo config plugin options for iOS prebuild scaffolding.",
+      "properties": {
+        "buildSettings": {
+          "additionalProperties": {
+            "type": ["string", "boolean", "number"]
+          },
+          "description": "Custom build settings applied when building the framework.",
+          "type": "object"
+        },
+        "bundleIdentifier": {
+          "description": "The bundle identifier for the framework.",
+          "type": "string"
+        },
+        "deploymentTarget": {
+          "description": "Minimum iOS deployment target for the generated framework.",
+          "type": "string"
+        },
+        "frameworkVersion": {
+          "description": "Framework version used for Apple build settings.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "BrownfieldIosConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "addSpmPackage": {
+          "description": "When set, generate a local Swift Package Manager manifest next to the packaged XCFramework outputs.",
+          "type": "boolean"
+        },
+        "buildFolder": {
+          "description": "Location for iOS build artifacts.",
+          "type": "string"
+        },
+        "configuration": {
+          "description": "Xcode scheme configuration (case sensitive).",
+          "type": "string"
+        },
+        "destination": {
+          "description": "Destination(s) for the build. You can pass multiple destinations as separate values or repeated use of the flag. Values can be either: \"simulator\", \"device\" or destinations supported by \"xcodebuild -destination\" flag, e.g. \"generic/platform=iOS\".",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "expo": {
+          "$ref": "#/definitions/BrownfieldExpoIosConfig",
+          "description": "Expo config plugin options for iOS Expo prebuild phase."
+        },
+        "exportExtraParams": {
+          "description": "Custom xcodebuild export archive parameters.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "exportOptionsPlist": {
+          "description": "Export options file name for archiving (default: ExportOptions.plist).",
+          "type": "string"
+        },
+        "extraParams": {
+          "description": "Custom xcodebuild parameters.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "installPods": {
+          "description": "Whether to install CocoaPods.",
+          "type": "boolean"
+        },
+        "newArch": {
+          "description": "Whether to build in new architecture.",
+          "type": "boolean"
+        },
+        "scheme": {
+          "description": "Xcode scheme to use.",
+          "type": "string"
+        },
+        "target": {
+          "description": "Xcode target to use.",
+          "type": "string"
+        },
+        "usePrebuiltRnCore": {
+          "description": "Set when `--use-prebuilt-rn-core` is passed; omitted when the flag is absent (Rock applies RN version defaults).",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "BrownieConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "kotlin": {
+          "description": "The output path to generate Kotlin Brownie store files at.",
+          "type": "string"
+        },
+        "kotlinPackageName": {
+          "description": "The package name for the Kotlin source code.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  }
+}

package/src/brownfield/commands/packageAndroid.ts

@@ -12,6 +12,7 @@ import {
   curryOptions,
 } from '../../shared/index.js';
 import { runExpoPrebuildIfNeeded } from '../utils/expo.js';
+import { findProjectRoot } from '../utils/paths.js';
 import { getProjectInfo } from '../utils/project.js';
 import { runBrownieCodegenIfApplicable } from '../../brownie/helpers/runBrownieCodegenIfApplicable.js';
 import { runNavigationCodegenIfApplicable } from '../../navigation/helpers/runNavigationCodegenIfApplicable.js';
@@ -23,13 +24,15 @@ export const packageAndroidCommand = curryOptions(
 ).action(
   actionRunner(async (cliOptions: PackageAarFlags) => {
     const options = mergeBrownfieldConfigWithOptions(cliOptions, 'android');
+    const projectRoot = findProjectRoot();
 
-    const { projectRoot, platformConfig } = getProjectInfo('android');
     await runExpoPrebuildIfNeeded({
       projectRoot,
       platform: 'android',
     });
 
+    const { platformConfig } = getProjectInfo('android');
+
     await runBrownieCodegenIfApplicable(projectRoot, 'kotlin');
     await runNavigationCodegenIfApplicable(projectRoot);
 

package/src/brownfield/commands/packageIos.ts

@@ -17,6 +17,7 @@ import {
 import { Command, Option } from 'commander';
 
 import { runExpoPrebuildIfNeeded } from '../utils/expo.js';
+import { findProjectRoot } from '../utils/paths.js';
 import { getProjectInfo } from '../utils/project.js';
 import { supportsPrebuiltRNCore } from '../utils/supportsPrebuiltRNCore.js';
 import {
@@ -97,8 +98,11 @@ export const packageIosCommand = curryOptions(
   .action(
     actionRunner(async (cliOptions: PackageIosOptions) => {
       const options = mergeBrownfieldConfigWithOptions(cliOptions, 'ios');
+      const projectRoot = findProjectRoot();
 
-      const { projectRoot, platformConfig, userConfig } = getProjectInfo('ios');
+      await runExpoPrebuildIfNeeded({ projectRoot, platform: 'ios' });
+
+      const { platformConfig, userConfig } = getProjectInfo('ios');
 
       const prebuiltRNCoreSupport = supportsPrebuiltRNCore({ projectRoot });
 
@@ -126,8 +130,6 @@ export const packageIosCommand = curryOptions(
         throw new RockError(prebuiltRNCoreSupport.reason);
       }
 
-      await runExpoPrebuildIfNeeded({ projectRoot, platform: 'ios' });
-
       if (!userConfig.project.ios) {
         throw new Error('iOS project not found.');
       }

package/src/brownfield/commands/publishAndroid.ts

@@ -12,6 +12,7 @@ import {
   ExampleUsage,
 } from '../../shared/index.js';
 import { getProjectInfo } from '../utils/project.js';
+import { findProjectRoot } from '../utils/paths.js';
 import { runExpoPrebuildIfNeeded } from '../utils/expo.js';
 import { runBrownieCodegenIfApplicable } from '../../brownie/helpers/runBrownieCodegenIfApplicable.js';
 import { runNavigationCodegenIfApplicable } from '../../navigation/helpers/runNavigationCodegenIfApplicable.js';
@@ -25,13 +26,15 @@ export const publishAndroidCommand = curryOptions(
 ).action(
   actionRunner(async (cliOptions: PublishLocalAarFlags) => {
     const options = mergeBrownfieldConfigWithOptions(cliOptions, 'android');
+    const projectRoot = findProjectRoot();
 
-    const { projectRoot, platformConfig } = getProjectInfo('android');
     await runExpoPrebuildIfNeeded({
       projectRoot,
       platform: 'android',
     });
 
+    const { platformConfig } = getProjectInfo('android');
+
     await runBrownieCodegenIfApplicable(projectRoot, 'kotlin');
     await runNavigationCodegenIfApplicable(projectRoot);
 

package/src/brownfield/utils/project.ts

@@ -21,15 +21,46 @@ const cliConfig: typeof cliConfigImport =
     : // @ts-expect-error: interop default
       cliConfigImport.default;
 
+function hasExpoAppConfig(projectRoot: string): boolean {
+  return (
+    fs.existsSync(path.join(projectRoot, 'app.json')) ||
+    fs.existsSync(path.join(projectRoot, 'app.config.js')) ||
+    fs.existsSync(path.join(projectRoot, 'app.config.ts')) ||
+    fs.existsSync(path.join(projectRoot, 'app.config.mjs'))
+  );
+}
+
+function projectDependsOnExpo(projectRoot: string): boolean {
+  const packageJsonPath = path.join(projectRoot, 'package.json');
+
+  if (!fs.existsSync(packageJsonPath)) {
+    return false;
+  }
+
+  const packageJson = JSON.parse(
+    fs.readFileSync(packageJsonPath, 'utf-8')
+  ) as Record<string, Record<string, string>>;
+
+  return ['dependencies', 'peerDependencies', 'devDependencies'].some(
+    (key) => packageJson[key]?.expo
+  );
+}
+
 /**
  * Gets the Expo config if the project is an Expo project
  * @param projectRoot The project root path
  * @returns The Expo config if the project is an Expo project, null otherwise
  */
 export function getExpoConfigIfIsExpo(projectRoot: string) {
+  const hasAppConfig = hasExpoAppConfig(projectRoot);
+
   try {
     return getConfig(projectRoot, { skipSDKVersionRequirement: true });
-  } catch {
+  } catch (error) {
+    if (hasAppConfig) {
+      throw error;
+    }
+
     return null;
   }
 }
@@ -41,19 +72,7 @@ export function getExpoConfigIfIsExpo(projectRoot: string) {
  * @returns Whether the project is an Expo project
  */
 export function isExpoProject(projectRoot: string): boolean {
-  const hasExpoConfig = getExpoConfigIfIsExpo(projectRoot) !== null;
-
-  // additionally, it is needed to check if the project depends on Expo packages explicitly
-  // to prevent false positives in a monorepo setup
-  const rnProjectRoot = findProjectRoot();
-  const packageJsonPath = path.join(rnProjectRoot, 'package.json');
-  const dependsOnExpo =
-    fs.existsSync(packageJsonPath) &&
-    ['dependencies', 'peerDependencies', 'devDependencies'].some(
-      (key) => JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'))[key]?.expo
-    );
-
-  return hasExpoConfig && dependsOnExpo;
+  return hasExpoAppConfig(projectRoot) && projectDependsOnExpo(projectRoot);
 }
 
 export function getExpoSdkMajor(projectRoot: string): number | null {

package/src/brownie/config.ts

@@ -108,7 +108,7 @@ export function resolveBrownieCodegenConfig({
   const legacyConfig = hasLegacyConfig(projectRoot)
     ? loadConfig(projectRoot)
     : undefined;
-  const brownfieldBrownie = loadBrownfieldConfig(projectRoot).brownie;
+  const brownfieldBrownie = loadBrownfieldConfig(projectRoot)?.brownie;
 
   if (legacyConfig !== undefined && (brownie ?? brownfieldBrownie)) {
     throw new Error(LEGACY_AND_NEW_BROWNIE_CONFIG_ERROR);

package/src/config.ts

@@ -10,13 +10,13 @@ import { findProjectRoot } from './brownfield/utils/paths.js';
 import BrownfieldSchema from '../schema.json' with { type: 'json' };
 import { logger } from '@rock-js/tools';
 
-const CONFIG_BASE_NAME = 'brownfield';
-const JS_CONFIG_FILE_NAME = `${CONFIG_BASE_NAME}.config.js`;
-const JSON_CONFIG_FILE_NAME = `${CONFIG_BASE_NAME}.config.json`;
+export const CONFIG_BASE_NAME = 'brownfield';
+export const JS_CONFIG_FILE_NAME = `${CONFIG_BASE_NAME}.config.js`;
+export const JSON_CONFIG_FILE_NAME = `${CONFIG_BASE_NAME}.config.json`;
 
 const SEPARATOR = '\n● ';
 
-const ajv = new Ajv({ allErrors: true });
+const ajv = new Ajv({ allErrors: true, allowUnionTypes: true });
 const validateBrownfieldConfig = ajv.compile(BrownfieldSchema);
 
 export function validateBrownfieldCLIConfig(config: unknown): void {
@@ -29,7 +29,7 @@ export function validateBrownfieldCLIConfig(config: unknown): void {
 
 export function loadBrownfieldConfig(
   projectRoot: string = findProjectRoot()
-): BrownfieldConfig {
+): BrownfieldConfig | null {
   const require = createRequire(path.join(projectRoot, 'package.json'));
 
   const jsConfigFilePath = path.join(projectRoot, JS_CONFIG_FILE_NAME);
@@ -41,7 +41,7 @@ export function loadBrownfieldConfig(
     [
       fs.existsSync(jsConfigFilePath),
       fs.existsSync(jsonConfigFilePath),
-      packageJson[CONFIG_BASE_NAME],
+      CONFIG_BASE_NAME in packageJson,
     ].filter(Boolean).length > 1
   ) {
     throw new Error('Project has multiple Brownfield configuration files');
@@ -55,7 +55,11 @@ export function loadBrownfieldConfig(
     return require(jsonConfigFilePath) as BrownfieldConfig;
   }
 
-  return packageJson[CONFIG_BASE_NAME] || {};
+  if (CONFIG_BASE_NAME in packageJson) {
+    return (packageJson[CONFIG_BASE_NAME] as BrownfieldConfig) ?? {};
+  }
+
+  return null;
 }
 
 type BrownfieldPlatform = 'android' | 'ios';
@@ -77,7 +81,7 @@ export function mergeBrownfieldConfigWithOptions<T extends object>(
   options: T,
   platform: BrownfieldPlatform
 ): T {
-  const reactNativeBrownfieldConfig = loadBrownfieldConfig();
+  const reactNativeBrownfieldConfig = loadBrownfieldConfig() ?? {};
 
   validateBrownfieldCLIConfig(reactNativeBrownfieldConfig);
 

package/src/expoPluginConfig.ts

@@ -0,0 +1,195 @@
+import type { BrownfieldConfig } from './types.js';
+
+export { loadBrownfieldConfig } from './config.js';
+
+/**
+ * Legacy Expo config plugin props shape accepted via app.json plugins tuple.
+ */
+export type BrownfieldPluginProps = {
+  debug?: boolean;
+  ios?: {
+    frameworkName?: string;
+    bundleIdentifier?: string;
+    buildSettings?: Record<string, string | boolean | number>;
+    deploymentTarget?: string;
+    frameworkVersion?: string;
+  };
+  android?: {
+    moduleName?: string;
+    packageName?: string;
+    minSdkVersion?: number;
+    targetSdkVersion?: number;
+    compileSdkVersion?: number;
+    groupId?: string;
+    artifactId?: string;
+    version?: string;
+    useLocalGradlePlugin?: boolean;
+  };
+};
+
+export type ResolvedBrownfieldPluginAndroidConfig = {
+  moduleName: string;
+  packageName: string;
+  minSdkVersion: number;
+  targetSdkVersion: number;
+  compileSdkVersion: number;
+  groupId: string;
+  artifactId: string;
+  version: string;
+  useLocalGradlePlugin: boolean;
+};
+
+export type ResolvedBrownfieldPluginIosConfig = {
+  frameworkName: string;
+  bundleIdentifier: string;
+  buildSettings: Record<string, string | boolean | number>;
+  deploymentTarget: string;
+  frameworkVersion: string;
+};
+
+export type ResolvedBrownfieldPluginConfig = {
+  debug: boolean;
+  ios: ResolvedBrownfieldPluginIosConfig | null;
+  android: ResolvedBrownfieldPluginAndroidConfig | null;
+};
+
+type BrownfieldExpoConfig = {
+  ios?: {
+    bundleIdentifier?: string;
+  };
+  android?: {
+    package?: string;
+  };
+};
+
+const CONFIG_FILE_PLUGIN_OVERLAP_ERROR =
+  'Brownfield configuration is defined in both a brownfield config file and app.json plugin options. ' +
+  'Use only one source: either brownfield.config.js, brownfield.config.json, package.json#brownfield, or the plugin options in app.json.';
+
+/**
+ * Checks if the plugin props are non-empty.
+ * @param props - The plugin props to check.
+ * @returns True if the plugin props are non-empty, false otherwise.
+ */
+function isPluginPropsNonEmpty(props: BrownfieldPluginProps): boolean {
+  if (props.debug !== undefined) {
+    return true;
+  }
+
+  if (props.ios && Object.keys(props.ios).length > 0) {
+    return true;
+  }
+
+  if (props.android && Object.keys(props.android).length > 0) {
+    return true;
+  }
+
+  return false;
+}
+
+/**
+ * Converts the file config to plugin props.
+ * @param fileConfig - The file config to convert to plugin props.
+ * @returns The plugin props.
+ */
+function fileConfigToPluginProps(
+  fileConfig: BrownfieldConfig
+): BrownfieldPluginProps {
+  const props: BrownfieldPluginProps = {};
+
+  if (fileConfig.verbose !== undefined) {
+    props.debug = fileConfig.verbose;
+  }
+
+  if (fileConfig.android) {
+    props.android = {
+      moduleName: fileConfig.android.moduleName,
+      ...fileConfig.android.expo,
+    };
+  }
+
+  if (fileConfig.ios) {
+    props.ios = {
+      frameworkName: fileConfig.ios.scheme,
+      ...fileConfig.ios.expo,
+    };
+  }
+
+  return props;
+}
+
+/**
+ * Asserts that there is no overlap between the file config and the plugin props.
+ * @param fileConfig - The loaded file config, or null when no config source exists.
+ * @param pluginProps - The plugin props to check for overlap.
+ * @throws An error if there is overlap.
+ * @returns void
+ */
+export function assertNoConfigFilePluginOverlap(
+  fileConfig: BrownfieldConfig | null,
+  pluginProps: BrownfieldPluginProps
+): void {
+  if (fileConfig === null) {
+    return;
+  }
+
+  if (isPluginPropsNonEmpty(pluginProps)) {
+    throw new Error(CONFIG_FILE_PLUGIN_OVERLAP_ERROR);
+  }
+}
+
+/**
+ * Resolves the plugin config from the file config and the plugin props.
+ * @param pluginProps - The plugin props to resolve.
+ * @param fileConfig - The file config to resolve.
+ * @param expoConfig - The Expo plugin config to resolve.
+ * @returns The resolved plugin config.
+ */
+export function resolveBrownfieldPluginConfig(
+  pluginProps: BrownfieldPluginProps,
+  fileConfig: BrownfieldConfig | null,
+  expoConfig: BrownfieldExpoConfig
+): ResolvedBrownfieldPluginConfig {
+  const effectiveProps =
+    fileConfig !== null ? fileConfigToPluginProps(fileConfig) : pluginProps;
+
+  const androidPackage = expoConfig.android?.package;
+  /**
+   * Below: android.moduleName may be provided in the fully-qualified Gradle format
+   * (e.g. :BrownfieldLib — this is shown in the CLI example usage).
+   * The Expo prebuild side expects a raw module folder/name (it later
+   * prepends : itself and uses it as a path), so a leading : is removed.
+   */
+  const androidModuleName = (
+    effectiveProps.android?.moduleName ?? 'brownfieldlib'
+  ).replace(/^:/, '');
+
+  return {
+    debug: effectiveProps.debug ?? false,
+    ios: expoConfig.ios
+      ? {
+          frameworkName: effectiveProps.ios?.frameworkName ?? 'BrownfieldLib',
+          bundleIdentifier:
+            effectiveProps.ios?.bundleIdentifier ??
+            `${expoConfig.ios.bundleIdentifier}.brownfield`,
+          buildSettings: effectiveProps.ios?.buildSettings ?? {},
+          deploymentTarget: effectiveProps.ios?.deploymentTarget ?? '15.0',
+          frameworkVersion: effectiveProps.ios?.frameworkVersion ?? '1',
+        }
+      : null,
+    android: androidPackage
+      ? {
+          moduleName: androidModuleName,
+          packageName: effectiveProps.android?.packageName ?? androidPackage,
+          minSdkVersion: effectiveProps.android?.minSdkVersion ?? 24,
+          targetSdkVersion: effectiveProps.android?.targetSdkVersion ?? 35,
+          compileSdkVersion: effectiveProps.android?.compileSdkVersion ?? 35,
+          groupId: effectiveProps.android?.groupId ?? androidPackage,
+          artifactId: effectiveProps.android?.artifactId ?? androidModuleName,
+          version: effectiveProps.android?.version ?? '0.0.1-SNAPSHOT',
+          useLocalGradlePlugin:
+            effectiveProps.android?.useLocalGradlePlugin ?? false,
+        }
+      : null,
+  };
+}