expo-build-properties 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -10,7 +10,13 @@
 
 ### 💡 Others
 
-## 0.4.1 — 2022-11-24
+## 0.5.0 — 2023-02-03
+
+### 🎉 New features
+
+- Add support for enabling [React Native new architecture mode](https://reactnative.dev/docs/new-architecture-intro). ([#20861](https://github.com/expo/expo/pull/20861) by [@gabrieldonadel](https://github.com/gabrieldonadel))
+
+## 0.4.1 - 2022-11-24
 
 ### 🐛 Bug fixes
 

package/README.md

@@ -43,7 +43,7 @@ Add plugin to `app.json`. For example:
 
 Contributions are very welcome! Please refer to guidelines described in the [contributing guide][contributing].
 
-[docs-main]: https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/build-properties.md
+[docs-main]: https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/build-properties.mdx
 [docs-stable]: https://docs.expo.dev/versions/latest/sdk/build-properties/
 [contributing]: https://github.com/expo/expo#contributing
 [config-plugins]: https://docs.expo.dev/guides/config-plugins/

package/build/android.js

@@ -10,6 +10,10 @@ const path_1 = __importDefault(require("path"));
 const fileContentsUtils_1 = require("./fileContentsUtils");
 const { createBuildGradlePropsConfigPlugin } = config_plugins_1.AndroidConfig.BuildProperties;
 exports.withAndroidBuildProperties = createBuildGradlePropsConfigPlugin([
+    {
+        propName: 'newArchEnabled',
+        propValueGetter: (config) => config.android?.newArchEnabled?.toString(),
+    },
     {
         propName: 'android.minSdkVersion',
         propValueGetter: (config) => config.android?.minSdkVersion?.toString(),

package/build/ios.js

@@ -4,6 +4,10 @@ exports.withIosDeploymentTarget = exports.withIosBuildProperties = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const { createBuildPodfilePropsConfigPlugin } = config_plugins_1.IOSConfig.BuildProperties;
 exports.withIosBuildProperties = createBuildPodfilePropsConfigPlugin([
+    {
+        propName: 'newArchEnabled',
+        propValueGetter: (config) => config.ios?.newArchEnabled?.toString(),
+    },
     {
         propName: 'ios.useFrameworks',
         propValueGetter: (config) => config.ios?.useFrameworks,

package/build/pluginConfig.d.ts

@@ -1,55 +1,101 @@
 /**
- * Configuration for `expo-build-properties`
+ * Interface representing base build properties configuration.
  */
 export interface PluginConfigType {
+    /**
+     * Interface representing available configuration for Android native build properties.
+     * @platform android
+     */
     android?: PluginConfigTypeAndroid;
+    /**
+     * Interface representing available configuration for iOS native build properties.
+     * @platform ios
+     */
     ios?: PluginConfigTypeIos;
 }
 /**
- * Config for Android native build properties
+ * Interface representing available configuration for Android native build properties.
+ * @platform android
  */
 export interface PluginConfigTypeAndroid {
-    /** Override the default `minSdkVersion` version number in `build.gradle` */
+    /**
+     * Enable React Native new architecture for Android platform.
+     */
+    newArchEnabled?: boolean;
+    /**
+     * Override the default `minSdkVersion` version number in **build.gradle**.
+     * */
     minSdkVersion?: number;
-    /** Override the default `compileSdkVersion` version number in `build.gradle` */
+    /**
+     * Override the default `compileSdkVersion` version number in **build.gradle**.
+     */
     compileSdkVersion?: number;
-    /** Override the default `targetSdkVersion` version number in `build.gradle` */
+    /**
+     * Override the default `targetSdkVersion` version number in **build.gradle**.
+     */
     targetSdkVersion?: number;
-    /** Override the default `buildToolsVersion` version number in `build.gradle` */
+    /**
+     *  Override the default `buildToolsVersion` version number in **build.gradle**.
+     */
     buildToolsVersion?: string;
-    /** Override the default Kotlin version when building the app */
+    /**
+     * Override the Kotlin version used when building the app.
+     */
     kotlinVersion?: string;
-    /** Enable Proguard (R8) in release builds to obfuscate Java code and reduce app size */
+    /**
+     * Enable [Proguard or R8](https://developer.android.com/studio/build/shrink-code) in release builds to obfuscate Java code and reduce app size.
+     */
     enableProguardInReleaseBuilds?: boolean;
-    /** Append custom [Proguard rules](https://www.guardsquare.com/manual/configuration/usage) to `android/app/proguard-rules.pro` */
+    /**
+     * Append custom [Proguard rules](https://www.guardsquare.com/manual/configuration/usage) to **android/app/proguard-rules.pro**.
+     */
     extraProguardRules?: string;
-    /** AGP [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions) */
+    /**
+     * Interface representing available configuration for Android Gradle plugin [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions).
+     */
     packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
 }
 /**
- * Config for iOS native build properties
+ * Interface representing available configuration for iOS native build properties.
+ * @platform ios
  */
 export interface PluginConfigTypeIos {
     /**
-     * Override the default iOS *Deployment Target* version in the following projects:
-     *  - in CocoaPods projects
-     *  - `PBXNativeTarget` with `com.apple.product-type.application` productType in the app project
+     * Enable React Native new architecture for iOS platform.
+     */
+    newArchEnabled?: boolean;
+    /**
+     * Override the default iOS "Deployment Target" version in the following projects:
+     *  - in CocoaPods projects,
+     *  - `PBXNativeTarget` with "com.apple.product-type.application" `productType` in the app project.
      */
     deploymentTarget?: string;
-    /** Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang) in `Podfile` */
+    /**
+     * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
+     * in `Podfile` to use frameworks instead of static libraries for Pods.
+     */
     useFrameworks?: 'static' | 'dynamic';
 }
 /**
- * AGP [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions)
+ * Interface representing available configuration for Android Gradle plugin [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions).
+ * @platform android
  */
 export interface PluginConfigTypeAndroidPackagingOptions {
-    /** Adds a first-pick pattern */
+    /**
+     * Array of patterns for native libraries where only the first occurrence is packaged in the APK.
+     */
     pickFirst?: string[];
-    /** Adds an excluded pattern */
+    /**
+     * Array of patterns for native libraries that should be excluded from being packaged in the APK.
+     */
     exclude?: string[];
-    /** Adds a merge pattern */
+    /**
+     * Array of patterns for native libraries where all occurrences are concatenated and packaged in the APK.
+     */
     merge?: string[];
-    /** Adds a doNotStrip pattern */
+    /**
+     * Array of patterns for native libraries that should not be stripped of debug symbols.
+     */
     doNotStrip?: string[];
 }
 /**

package/build/pluginConfig.js

@@ -7,7 +7,7 @@ exports.validateConfig = void 0;
 const ajv_1 = __importDefault(require("ajv"));
 const semver_1 = __importDefault(require("semver"));
 /**
- * The minimal supported versions. These values should align to SDK
+ * The minimal supported versions. These values should align to SDK.
  * @ignore
  */
 const EXPO_SDK_MINIMAL_SUPPORTED_VERSIONS = {
@@ -27,6 +27,7 @@ const schema = {
         android: {
             type: 'object',
             properties: {
+                newArchEnabled: { type: 'boolean', nullable: true },
                 minSdkVersion: { type: 'integer', nullable: true },
                 compileSdkVersion: { type: 'integer', nullable: true },
                 targetSdkVersion: { type: 'integer', nullable: true },
@@ -50,6 +51,7 @@ const schema = {
         ios: {
             type: 'object',
             properties: {
+                newArchEnabled: { type: 'boolean', nullable: true },
                 deploymentTarget: { type: 'string', pattern: '\\d+\\.\\d+', nullable: true },
                 useFrameworks: { type: 'string', enum: ['static', 'dynamic'], nullable: true },
             },
@@ -57,12 +59,12 @@ const schema = {
         },
     },
 };
+// note(Kudo): For the implementation, we check items one by one because Ajv does not well support custom error message.
 /**
- * Check versions to meet expo minimal supported versions.
+ * Checks if specified versions meets Expo minimal supported versions.
  * Will throw error message whenever there are invalid versions.
- * For the implementation, we check items one by one because ajv does not well support custom error message.
  *
- * @param config the validated config passed from ajv
+ * @param config The validated config passed from Ajv.
  * @ignore
  */
 function maybeThrowInvalidVersions(config) {

package/build/withBuildProperties.d.ts

@@ -1,10 +1,9 @@
-import type { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigPlugin } from 'expo/config-plugins';
 import { PluginConfigType } from './pluginConfig';
 /**
- * Config plugin to customize native Android or iOS build properties for managed apps
- *
- * @param config ExpoConfig
- * @param props Configuration for the config plugin
+ * Config plugin allowing customizing native Android and iOS build properties for managed apps.
+ * @param config Expo config for application.
+ * @param props Configuration for the build properties plugin.
  */
 export declare const withBuildProperties: ConfigPlugin<PluginConfigType>;
 export default withBuildProperties;

package/build/withBuildProperties.js

@@ -5,10 +5,9 @@ const android_1 = require("./android");
 const ios_1 = require("./ios");
 const pluginConfig_1 = require("./pluginConfig");
 /**
- * Config plugin to customize native Android or iOS build properties for managed apps
- *
- * @param config ExpoConfig
- * @param props Configuration for the config plugin
+ * Config plugin allowing customizing native Android and iOS build properties for managed apps.
+ * @param config Expo config for application.
+ * @param props Configuration for the build properties plugin.
  */
 const withBuildProperties = (config, props) => {
     const pluginConfig = (0, pluginConfig_1.validateConfig)(props || {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-build-properties",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Config plugin to customize native build properties on prebuild",
   "main": "build/withBuildProperties.js",
   "types": "build/withBuildProperties.d.ts",
@@ -37,11 +37,8 @@
   "devDependencies": {
     "expo-module-scripts": "^3.0.0"
   },
-  "jest": {
-    "preset": "expo-module-scripts"
-  },
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "1c5b1b798ecf9801a8004614140441c4d37f3935"
+  "gitHead": "1815e2eaad8c753588c7b1eb74420174a28e01f4"
 }

package/src/android.ts

@@ -9,6 +9,10 @@ const { createBuildGradlePropsConfigPlugin } = AndroidConfig.BuildProperties;
 
 export const withAndroidBuildProperties = createBuildGradlePropsConfigPlugin<PluginConfigType>(
   [
+    {
+      propName: 'newArchEnabled',
+      propValueGetter: (config) => config.android?.newArchEnabled?.toString(),
+    },
     {
       propName: 'android.minSdkVersion',
       propValueGetter: (config) => config.android?.minSdkVersion?.toString(),

package/src/ios.ts

@@ -6,6 +6,10 @@ const { createBuildPodfilePropsConfigPlugin } = IOSConfig.BuildProperties;
 
 export const withIosBuildProperties = createBuildPodfilePropsConfigPlugin<PluginConfigType>(
   [
+    {
+      propName: 'newArchEnabled',
+      propValueGetter: (config) => config.ios?.newArchEnabled?.toString(),
+    },
     {
       propName: 'ios.useFrameworks',
       propValueGetter: (config) => config.ios?.useFrameworks,

package/src/pluginConfig.ts

@@ -2,7 +2,7 @@ import Ajv, { JSONSchemaType } from 'ajv';
 import semver from 'semver';
 
 /**
- * The minimal supported versions. These values should align to SDK
+ * The minimal supported versions. These values should align to SDK.
  * @ignore
  */
 const EXPO_SDK_MINIMAL_SUPPORTED_VERSIONS = {
@@ -18,71 +18,106 @@ const EXPO_SDK_MINIMAL_SUPPORTED_VERSIONS = {
 };
 
 /**
- * Configuration for `expo-build-properties`
+ * Interface representing base build properties configuration.
  */
 export interface PluginConfigType {
+  /**
+   * Interface representing available configuration for Android native build properties.
+   * @platform android
+   */
   android?: PluginConfigTypeAndroid;
+  /**
+   * Interface representing available configuration for iOS native build properties.
+   * @platform ios
+   */
   ios?: PluginConfigTypeIos;
 }
 
 /**
- * Config for Android native build properties
+ * Interface representing available configuration for Android native build properties.
+ * @platform android
  */
 export interface PluginConfigTypeAndroid {
-  /** Override the default `minSdkVersion` version number in `build.gradle` */
+  /**
+   * Enable React Native new architecture for Android platform.
+   */
+  newArchEnabled?: boolean;
+  /**
+   * Override the default `minSdkVersion` version number in **build.gradle**.
+   * */
   minSdkVersion?: number;
-
-  /** Override the default `compileSdkVersion` version number in `build.gradle` */
+  /**
+   * Override the default `compileSdkVersion` version number in **build.gradle**.
+   */
   compileSdkVersion?: number;
-
-  /** Override the default `targetSdkVersion` version number in `build.gradle` */
+  /**
+   * Override the default `targetSdkVersion` version number in **build.gradle**.
+   */
   targetSdkVersion?: number;
-
-  /** Override the default `buildToolsVersion` version number in `build.gradle` */
+  /**
+   *  Override the default `buildToolsVersion` version number in **build.gradle**.
+   */
   buildToolsVersion?: string;
-
-  /** Override the default Kotlin version when building the app */
+  /**
+   * Override the Kotlin version used when building the app.
+   */
   kotlinVersion?: string;
-
-  /** Enable Proguard (R8) in release builds to obfuscate Java code and reduce app size */
+  /**
+   * Enable [Proguard or R8](https://developer.android.com/studio/build/shrink-code) in release builds to obfuscate Java code and reduce app size.
+   */
   enableProguardInReleaseBuilds?: boolean;
-
-  /** Append custom [Proguard rules](https://www.guardsquare.com/manual/configuration/usage) to `android/app/proguard-rules.pro` */
+  /**
+   * Append custom [Proguard rules](https://www.guardsquare.com/manual/configuration/usage) to **android/app/proguard-rules.pro**.
+   */
   extraProguardRules?: string;
-
-  /** AGP [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions) */
+  /**
+   * Interface representing available configuration for Android Gradle plugin [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions).
+   */
   packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
 }
 
 /**
- * Config for iOS native build properties
+ * Interface representing available configuration for iOS native build properties.
+ * @platform ios
  */
 export interface PluginConfigTypeIos {
   /**
-   * Override the default iOS *Deployment Target* version in the following projects:
-   *  - in CocoaPods projects
-   *  - `PBXNativeTarget` with `com.apple.product-type.application` productType in the app project
+   * Enable React Native new architecture for iOS platform.
+   */
+  newArchEnabled?: boolean;
+  /**
+   * Override the default iOS "Deployment Target" version in the following projects:
+   *  - in CocoaPods projects,
+   *  - `PBXNativeTarget` with "com.apple.product-type.application" `productType` in the app project.
    */
   deploymentTarget?: string;
-
-  /** Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang) in `Podfile` */
+  /**
+   * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
+   * in `Podfile` to use frameworks instead of static libraries for Pods.
+   */
   useFrameworks?: 'static' | 'dynamic';
 }
 
 /**
- * AGP [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions)
+ * Interface representing available configuration for Android Gradle plugin [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions).
+ * @platform android
  */
 export interface PluginConfigTypeAndroidPackagingOptions {
-  /** Adds a first-pick pattern */
+  /**
+   * Array of patterns for native libraries where only the first occurrence is packaged in the APK.
+   */
   pickFirst?: string[];
-
-  /** Adds an excluded pattern */
+  /**
+   * Array of patterns for native libraries that should be excluded from being packaged in the APK.
+   */
   exclude?: string[];
-
-  /** Adds a merge pattern */
+  /**
+   * Array of patterns for native libraries where all occurrences are concatenated and packaged in the APK.
+   */
   merge?: string[];
-
-  /** Adds a doNotStrip pattern */
+  /**
+   * Array of patterns for native libraries that should not be stripped of debug symbols.
+   */
   doNotStrip?: string[];
 }
 
@@ -92,6 +127,7 @@ const schema: JSONSchemaType<PluginConfigType> = {
     android: {
       type: 'object',
       properties: {
+        newArchEnabled: { type: 'boolean', nullable: true },
         minSdkVersion: { type: 'integer', nullable: true },
         compileSdkVersion: { type: 'integer', nullable: true },
         targetSdkVersion: { type: 'integer', nullable: true },
@@ -117,6 +153,7 @@ const schema: JSONSchemaType<PluginConfigType> = {
     ios: {
       type: 'object',
       properties: {
+        newArchEnabled: { type: 'boolean', nullable: true },
         deploymentTarget: { type: 'string', pattern: '\\d+\\.\\d+', nullable: true },
         useFrameworks: { type: 'string', enum: ['static', 'dynamic'], nullable: true },
       },
@@ -125,12 +162,12 @@ const schema: JSONSchemaType<PluginConfigType> = {
   },
 };
 
+// note(Kudo): For the implementation, we check items one by one because Ajv does not well support custom error message.
 /**
- * Check versions to meet expo minimal supported versions.
+ * Checks if specified versions meets Expo minimal supported versions.
  * Will throw error message whenever there are invalid versions.
- * For the implementation, we check items one by one because ajv does not well support custom error message.
  *
- * @param config the validated config passed from ajv
+ * @param config The validated config passed from Ajv.
  * @ignore
  */
 function maybeThrowInvalidVersions(config: PluginConfigType) {

package/src/withBuildProperties.ts

@@ -1,4 +1,4 @@
-import type { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigPlugin } from 'expo/config-plugins';
 
 import {
   withAndroidBuildProperties,
@@ -9,10 +9,9 @@ import { withIosBuildProperties, withIosDeploymentTarget } from './ios';
 import { PluginConfigType, validateConfig } from './pluginConfig';
 
 /**
- * Config plugin to customize native Android or iOS build properties for managed apps
- *
- * @param config ExpoConfig
- * @param props Configuration for the config plugin
+ * Config plugin allowing customizing native Android and iOS build properties for managed apps.
+ * @param config Expo config for application.
+ * @param props Configuration for the build properties plugin.
  */
 export const withBuildProperties: ConfigPlugin<PluginConfigType> = (config, props) => {
   const pluginConfig = validateConfig(props || {});