@callstack/brownfield-cli 3.13.1 → 3.14.0

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,
+  };
+}

package/src/types.ts

@@ -7,6 +7,9 @@ import type { BuildFlags as AppleBuildFlags } from '@rock-js/platform-apple-help
 export type Platform = 'swift' | 'kotlin';
 
 export type BrownfieldCommonOptions = Partial<{
+  /**
+   * Enables verbose CLI logging.
+   */
   verbose: boolean;
 }>;
 
@@ -15,13 +18,24 @@ export type BrownfieldConfigMetadata = Partial<{
 }>;
 
 export type BrownieConfig = {
+  /**
+   * The output path to generate Kotlin Brownie store files at.
+   */
   kotlin?: string;
+
+  /**
+   * The package name for the Kotlin source code.
+   */
   kotlinPackageName?: string;
 };
 
-export type PackageIosOptions = AppleBuildFlags & {
+export type PackageIosOptions = Omit<AppleBuildFlags, 'archive' | 'local'> & {
   /** Set when `--use-prebuilt-rn-core` is passed; omitted when the flag is absent (Rock applies RN version defaults). */
   usePrebuiltRnCore?: boolean;
+
+  /** Set when `--use-prebuilt-expo` is passed; omitted when the flag is absent (Rock applies Expo version defaults). */
+  usePrebuiltExpo?: boolean;
+
   /** When set, generate a local Swift Package Manager manifest next to the packaged XCFramework outputs. */
   addSpmPackage?: boolean;
 };
@@ -33,19 +47,114 @@ export type BrownfieldPublishAndroidOptions = BrownfieldCommonOptions &
 export type BrownfieldPackageIosOptions = BrownfieldCommonOptions &
   Partial<PackageIosOptions>;
 
+/**
+ * Expo config plugin options for Android prebuild scaffolding.
+ */
+export type BrownfieldExpoAndroidConfig = {
+  /**
+   * The package name for the Android library module.
+   */
+  packageName?: string;
+
+  /**
+   * Minimum SDK version for the Android library.
+   */
+  minSdkVersion?: number;
+
+  /**
+   * Target SDK version for the Android library.
+   */
+  targetSdkVersion?: number;
+
+  /**
+   * Compile SDK version for the Android library.
+   */
+  compileSdkVersion?: number;
+
+  /**
+   * Maven group ID used when publishing the AAR.
+   */
+  groupId?: string;
+
+  /**
+   * Maven artifact ID used when publishing the AAR.
+   */
+  artifactId?: string;
+
+  /**
+   * Maven version used when publishing the AAR.
+   */
+  version?: string;
+
+  /**
+   * 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.
+   */
+  useLocalGradlePlugin?: boolean;
+};
+
+/**
+ * Expo config plugin options for iOS prebuild scaffolding.
+ */
+export type BrownfieldExpoIosConfig = {
+  /**
+   * The bundle identifier for the framework.
+   */
+  bundleIdentifier?: string;
+
+  /**
+   * Custom build settings applied when building the framework.
+   */
+  buildSettings?: Record<string, string | boolean | number>;
+
+  /**
+   * Minimum iOS deployment target for the generated framework.
+   */
+  deploymentTarget?: string;
+
+  /**
+   * Framework version used for Apple build settings.
+   */
+  frameworkVersion?: string;
+};
+
 export type BrownfieldAndroidConfig = Omit<
   Partial<PackageAarFlags> & Partial<PublishLocalAarFlags>,
   keyof BrownfieldCommonOptions
->;
+> & {
+  /**
+   * Expo config plugin options for Android Expo prebuild phase.
+   */
+  expo?: BrownfieldExpoAndroidConfig;
+};
+
 export type BrownfieldIosConfig = Omit<
   Partial<PackageIosOptions>,
   keyof BrownfieldCommonOptions
->;
+> & {
+  /**
+   * Expo config plugin options for iOS Expo prebuild phase.
+   */
+  expo?: BrownfieldExpoIosConfig;
+};
 
 export type BrownfieldConfig = BrownfieldConfigMetadata &
   BrownfieldCommonOptions &
   Partial<{
+    /**
+     * Brownfield Android configuration.
+     */
     android: BrownfieldAndroidConfig;
+
+    /**
+     * Brownfield iOS configuration.
+     */
     ios: BrownfieldIosConfig;
+
+    /**
+     * Brownie (state library) configuration.
+     */
     brownie: BrownieConfig;
   }>;