expo-build-properties 0.6.0 → 0.8.0

package/CHANGELOG.md

@@ -10,7 +10,23 @@
 
 ### 💡 Others
 
-## 0.6.0 — 2023-04-14
+## 0.8.0 — 2023-06-21
+
+### 🛠 Breaking changes
+
+- Replaced `unstable_networkInspector` as `networkInspector` and enabled the feature by default. ([#22994](https://github.com/expo/expo/pull/22994) by [@kudo](https://github.com/kudo))
+
+### 🎉 New features
+
+- Added `android.extraMavenRepos` and `ios.extraPods` support. ([#22785](https://github.com/expo/expo/pull/22785) by [@kudo](https://github.com/kudo))
+
+## 0.7.0 — 2023-05-08
+
+### 🐛 Bug fixes
+
+- Fixed false alarm error throwing when `ios.flipper=false` and `useFrameworks`. ([#22296](https://github.com/expo/expo/pull/22296) by [@kudo](https://github.com/kudo))
+
+## 0.6.0 - 2023-04-14
 
 ### 🎉 New features
 

package/README.md

@@ -1,6 +1,6 @@
 # expo-build-properties
 
-**`expo-build-properties`** is a config plugin for managed apps to override the default native build properties.
+**`expo-build-properties`** is a [config plugin](https://docs.expo.dev/config-plugins/introduction/) to customize native build properties when using [`npx expo prebuild`](https://docs.expo.dev/workflow/prebuild/).
 
 ## API documentation
 
@@ -9,10 +9,8 @@
 
 ### Installation
 
-**Note:** To use this config plugin, your apps must be a managed app and build by either [EAS Build](/build/introduction.md) or `expo run:[android|ios]`.
-
 ```
-expo install expo-build-properties
+npx expo install expo-build-properties
 ```
 
 Add plugin to `app.json`. For example:
@@ -48,4 +46,4 @@ Contributions are very welcome! Please refer to guidelines described in the [con
 [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/
+[config-plugins]: https://docs.expo.dev/home/config-plugins/introduction

package/build/android.js

@@ -60,7 +60,7 @@ exports.withAndroidBuildProperties = createBuildGradlePropsConfigPlugin([
     },
     {
         propName: 'EX_DEV_CLIENT_NETWORK_INSPECTOR',
-        propValueGetter: (config) => config.android?.unstable_networkInspector?.toString(),
+        propValueGetter: (config) => (config.android?.networkInspector ?? true).toString(),
     },
 ], 'withAndroidBuildProperties');
 const withAndroidFlipper = (config, props) => {

package/build/ios.js

@@ -23,7 +23,7 @@ exports.withIosBuildProperties = createBuildPodfilePropsConfigPlugin([
     },
     {
         propName: 'EX_DEV_CLIENT_NETWORK_INSPECTOR',
-        propValueGetter: (config) => config.ios?.unstable_networkInspector?.toString(),
+        propValueGetter: (config) => (config.ios?.networkInspector ?? true).toString(),
     },
 ], 'withIosBuildProperties');
 const withIosDeploymentTarget = (config, props) => {

package/build/pluginConfig.d.ts

@@ -60,17 +60,37 @@ export interface PluginConfigTypeAndroid {
      */
     packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
     /**
-     * Change the [Flipper](https://fbflipper.com/) version when running your app on Android.
-     * Flipper is by default enabled with the version that comes bundled with react-native.
-     * However, you can set the `flipper` property to a semver string and specify an
-     * alternate Flipper version.
+     * By default, Flipper is enabled with the version that comes bundled with `react-native`.
+     *
+     * Use this to change the [Flipper](https://fbflipper.com/) version when
+     * running your app on Android. You can set the `flipper` property to a
+     * semver string and specify an alternate Flipper version.
      */
     flipper?: string;
     /**
-     * Enable the experimental Network Inspector for [Development builds](https://docs.expo.dev/develop/development-builds/introduction/).
-     * SDK 49+ is required.
+     * Enable the Network Inspector.
+     *
+     * @default true
+     */
+    networkInspector?: boolean;
+    /**
+     * Add extra maven repositories to all gradle projects.
+     *
+     * This acts like to add the following code to **android/build.gradle**:
+     * ```groovy
+     * allprojects {
+     *   repositories {
+     *     maven {
+     *       url [THE_EXTRA_MAVEN_REPOSITORY]
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @hide For the implementation details,
+     * this property is actually handled by `expo-modules-autolinking` but not the config-plugins inside expo-build-properties.
      */
-    unstable_networkInspector?: boolean;
+    extraMavenRepos?: string[];
 }
 /**
  * Interface representing available configuration for iOS native build properties.
@@ -91,24 +111,112 @@ export interface PluginConfigTypeIos {
      * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
      * in `Podfile` to use frameworks instead of static libraries for Pods.
      *
-     * Note: You cannot use `useFrameworks` and `flipper` at the same time
+     * > You cannot use `useFrameworks` and `flipper` at the same time , and
+     * doing so will generate an error.
      */
     useFrameworks?: 'static' | 'dynamic';
     /**
      * Enable [Flipper](https://fbflipper.com/) when running your app on iOS in
      * Debug mode. Setting `true` enables the default version of Flipper, while
      * setting a semver string will enable a specific version of Flipper you've
-     * declared in your package.json. The default for this configuration is `false`.
+     * declared in your **package.json**. The default for this configuration is `false`.
      *
-     * Note: You cannot use `flipper` at the same time as `useFrameworks`, and
+     * > You cannot use `flipper` at the same time as `useFrameworks`, and
      * doing so will generate an error.
      */
     flipper?: boolean | string;
     /**
-     * Enable the experimental Network Inspector for [Development builds](https://docs.expo.dev/develop/development-builds/introduction/).
-     * SDK 49+ is required.
+     * Enable the Network Inspector.
+     *
+     * @default true
+     */
+    networkInspector?: boolean;
+    /**
+     * Add extra CocoaPods dependencies for all targets.
+     *
+     * This acts like to add the following code to **ios/Podfile**:
+     * ```
+     * pod '[EXTRA_POD_NAME]', '~> [EXTRA_POD_VERSION]'
+     * # e.g.
+     * pod 'Protobuf', '~> 3.14.0'
+     * ```
+     *
+     * @hide For the implementation details,
+     * this property is actually handled by `expo-modules-autolinking` but not the config-plugins inside expo-build-properties.
+     */
+    extraPods?: ExtraIosPodDependency[];
+}
+/**
+ * Interface representing extra CocoaPods dependency.
+ * @see [Podfile syntax reference](https://guides.cocoapods.org/syntax/podfile.html#pod)
+ * @platform ios
+ */
+export interface ExtraIosPodDependency {
+    /**
+     * Name of the pod.
+     */
+    name: string;
+    /**
+     * Version of the pod.
+     * CocoaPods supports various [versioning options](https://guides.cocoapods.org/using/the-podfile.html#pod).
+     * @example `~> 0.1.2`
+     */
+    version?: string;
+    /**
+     * Build configurations for which the pod should be installed.
+     * @example `['Debug', 'Release']`
+     */
+    configurations?: string[];
+    /**
+     * Whether this pod should use modular headers.
+     */
+    modular_headers?: boolean;
+    /**
+     * Custom source to search for this dependency.
+     * @example `https://github.com/CocoaPods/Specs.git`
+     */
+    source?: string;
+    /**
+     * Custom local filesystem path to add the dependency.
+     * @example `~/Documents/AFNetworking`
+     */
+    path?: string;
+    /**
+     * Custom podspec path.
+     * @example `https://example.com/JSONKit.podspec`
+     */
+    podspec?: string;
+    /**
+     * Test specs can be optionally included via the :testspecs option. By default, none of a Pod's test specs are included.
+     * @example `['UnitTests', 'SomeOtherTests']`
+     */
+    testspecs?: string[];
+    /**
+     * Use the bleeding edge version of a Pod.
+     *
+     * @example
+     * ```
+     * { "name": "AFNetworking", "git": "https://github.com/gowalla/AFNetworking.git", "tag": "0.7.0" }
+     * ```
+     *
+     * This acts like to add this pod dependency statement:
+     * ```
+     * pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :tag => '0.7.0'
+     * ```
+     */
+    git?: string;
+    /**
+     * The git branch to fetch. See the {@link git} property for more information.
+     */
+    branch?: string;
+    /**
+     * The git tag to fetch. See the {@link git} property for more information.
+     */
+    tag?: string;
+    /**
+     * The git commit to fetch. See the {@link git} property for more information.
      */
-    unstable_networkInspector?: boolean;
+    commit?: string;
 }
 /**
  * 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).

package/build/pluginConfig.js

@@ -50,7 +50,8 @@ const schema = {
                     },
                     nullable: true,
                 },
-                unstable_networkInspector: { type: 'boolean', nullable: true },
+                networkInspector: { type: 'boolean', nullable: true },
+                extraMavenRepos: { type: 'array', items: { type: 'string' }, nullable: true },
             },
             nullable: true,
         },
@@ -64,7 +65,29 @@ const schema = {
                     type: ['boolean', 'string'],
                     nullable: true,
                 },
-                unstable_networkInspector: { type: 'boolean', nullable: true },
+                networkInspector: { type: 'boolean', nullable: true },
+                extraPods: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: ['name'],
+                        properties: {
+                            name: { type: 'string' },
+                            version: { type: 'string', nullable: true },
+                            configurations: { type: 'array', items: { type: 'string' }, nullable: true },
+                            modular_headers: { type: 'boolean', nullable: true },
+                            source: { type: 'string', nullable: true },
+                            path: { type: 'string', nullable: true },
+                            podspec: { type: 'string', nullable: true },
+                            testspecs: { type: 'array', items: { type: 'string' }, nullable: true },
+                            git: { type: 'string', nullable: true },
+                            branch: { type: 'string', nullable: true },
+                            tag: { type: 'string', nullable: true },
+                            commit: { type: 'string', nullable: true },
+                        },
+                    },
+                    nullable: true,
+                },
             },
             nullable: true,
         },
@@ -130,7 +153,7 @@ function validateConfig(config) {
     maybeThrowInvalidVersions(config);
     // explicitly block using use_frameworks and Flipper in iOS
     // https://github.com/facebook/flipper/issues/2414
-    if (config?.ios?.flipper !== undefined && config?.ios?.useFrameworks !== undefined) {
+    if (Boolean(config.ios?.flipper) && config.ios?.useFrameworks !== undefined) {
         throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
     }
     if (config.android?.enableShrinkResourcesInReleaseBuilds === true &&

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-build-properties",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Config plugin to customize native build properties on prebuild",
   "main": "build/withBuildProperties.js",
   "types": "build/withBuildProperties.d.ts",
@@ -40,5 +40,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "6b73082d014ebe93f091aa75cd06f4d4d90eff19"
+  "gitHead": "fa5ecca8251986b9f197cc14074eec0ab6dfb6db"
 }

package/src/android.ts

@@ -65,7 +65,7 @@ export const withAndroidBuildProperties = createBuildGradlePropsConfigPlugin<Plu
     },
     {
       propName: 'EX_DEV_CLIENT_NETWORK_INSPECTOR',
-      propValueGetter: (config) => config.android?.unstable_networkInspector?.toString(),
+      propValueGetter: (config) => (config.android?.networkInspector ?? true).toString(),
     },
   ],
   'withAndroidBuildProperties'

package/src/ios.ts

@@ -25,7 +25,7 @@ export const withIosBuildProperties = createBuildPodfilePropsConfigPlugin<Plugin
     },
     {
       propName: 'EX_DEV_CLIENT_NETWORK_INSPECTOR',
-      propValueGetter: (config) => config.ios?.unstable_networkInspector?.toString(),
+      propValueGetter: (config) => (config.ios?.networkInspector ?? true).toString(),
     },
   ],
   'withIosBuildProperties'

package/src/pluginConfig.ts

@@ -81,18 +81,39 @@ export interface PluginConfigTypeAndroid {
   packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
 
   /**
-   * Change the [Flipper](https://fbflipper.com/) version when running your app on Android.
-   * Flipper is by default enabled with the version that comes bundled with react-native.
-   * However, you can set the `flipper` property to a semver string and specify an
-   * alternate Flipper version.
+   * By default, Flipper is enabled with the version that comes bundled with `react-native`.
+   *
+   * Use this to change the [Flipper](https://fbflipper.com/) version when
+   * running your app on Android. You can set the `flipper` property to a
+   * semver string and specify an alternate Flipper version.
    */
   flipper?: string;
 
   /**
-   * Enable the experimental Network Inspector for [Development builds](https://docs.expo.dev/develop/development-builds/introduction/).
-   * SDK 49+ is required.
+   * Enable the Network Inspector.
+   *
+   * @default true
+   */
+  networkInspector?: boolean;
+
+  /**
+   * Add extra maven repositories to all gradle projects.
+   *
+   * This acts like to add the following code to **android/build.gradle**:
+   * ```groovy
+   * allprojects {
+   *   repositories {
+   *     maven {
+   *       url [THE_EXTRA_MAVEN_REPOSITORY]
+   *     }
+   *   }
+   * }
+   * ```
+   *
+   * @hide For the implementation details,
+   * this property is actually handled by `expo-modules-autolinking` but not the config-plugins inside expo-build-properties.
    */
-  unstable_networkInspector?: boolean;
+  extraMavenRepos?: string[];
 }
 
 /**
@@ -115,7 +136,8 @@ export interface PluginConfigTypeIos {
    * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
    * in `Podfile` to use frameworks instead of static libraries for Pods.
    *
-   * Note: You cannot use `useFrameworks` and `flipper` at the same time
+   * > You cannot use `useFrameworks` and `flipper` at the same time , and
+   * doing so will generate an error.
    */
   useFrameworks?: 'static' | 'dynamic';
 
@@ -123,18 +145,107 @@ export interface PluginConfigTypeIos {
    * Enable [Flipper](https://fbflipper.com/) when running your app on iOS in
    * Debug mode. Setting `true` enables the default version of Flipper, while
    * setting a semver string will enable a specific version of Flipper you've
-   * declared in your package.json. The default for this configuration is `false`.
+   * declared in your **package.json**. The default for this configuration is `false`.
    *
-   * Note: You cannot use `flipper` at the same time as `useFrameworks`, and
+   * > You cannot use `flipper` at the same time as `useFrameworks`, and
    * doing so will generate an error.
    */
   flipper?: boolean | string;
 
   /**
-   * Enable the experimental Network Inspector for [Development builds](https://docs.expo.dev/develop/development-builds/introduction/).
-   * SDK 49+ is required.
+   * Enable the Network Inspector.
+   *
+   * @default true
+   */
+  networkInspector?: boolean;
+
+  /**
+   * Add extra CocoaPods dependencies for all targets.
+   *
+   * This acts like to add the following code to **ios/Podfile**:
+   * ```
+   * pod '[EXTRA_POD_NAME]', '~> [EXTRA_POD_VERSION]'
+   * # e.g.
+   * pod 'Protobuf', '~> 3.14.0'
+   * ```
+   *
+   * @hide For the implementation details,
+   * this property is actually handled by `expo-modules-autolinking` but not the config-plugins inside expo-build-properties.
+   */
+  extraPods?: ExtraIosPodDependency[];
+}
+
+/**
+ * Interface representing extra CocoaPods dependency.
+ * @see [Podfile syntax reference](https://guides.cocoapods.org/syntax/podfile.html#pod)
+ * @platform ios
+ */
+export interface ExtraIosPodDependency {
+  /**
+   * Name of the pod.
+   */
+  name: string;
+  /**
+   * Version of the pod.
+   * CocoaPods supports various [versioning options](https://guides.cocoapods.org/using/the-podfile.html#pod).
+   * @example `~> 0.1.2`
+   */
+  version?: string;
+  /**
+   * Build configurations for which the pod should be installed.
+   * @example `['Debug', 'Release']`
    */
-  unstable_networkInspector?: boolean;
+  configurations?: string[];
+  /**
+   * Whether this pod should use modular headers.
+   */
+  modular_headers?: boolean;
+  /**
+   * Custom source to search for this dependency.
+   * @example `https://github.com/CocoaPods/Specs.git`
+   */
+  source?: string;
+  /**
+   * Custom local filesystem path to add the dependency.
+   * @example `~/Documents/AFNetworking`
+   */
+  path?: string;
+  /**
+   * Custom podspec path.
+   * @example `https://example.com/JSONKit.podspec`
+   */
+  podspec?: string;
+  /**
+   * Test specs can be optionally included via the :testspecs option. By default, none of a Pod's test specs are included.
+   * @example `['UnitTests', 'SomeOtherTests']`
+   */
+  testspecs?: string[];
+  /**
+   * Use the bleeding edge version of a Pod.
+   *
+   * @example
+   * ```
+   * { "name": "AFNetworking", "git": "https://github.com/gowalla/AFNetworking.git", "tag": "0.7.0" }
+   * ```
+   *
+   * This acts like to add this pod dependency statement:
+   * ```
+   * pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :tag => '0.7.0'
+   * ```
+   */
+  git?: string;
+  /**
+   * The git branch to fetch. See the {@link git} property for more information.
+   */
+  branch?: string;
+  /**
+   * The git tag to fetch. See the {@link git} property for more information.
+   */
+  tag?: string;
+  /**
+   * The git commit to fetch. See the {@link git} property for more information.
+   */
+  commit?: string;
 }
 
 /**
@@ -193,7 +304,9 @@ const schema: JSONSchemaType<PluginConfigType> = {
           nullable: true,
         },
 
-        unstable_networkInspector: { type: 'boolean', nullable: true },
+        networkInspector: { type: 'boolean', nullable: true },
+
+        extraMavenRepos: { type: 'array', items: { type: 'string' }, nullable: true },
       },
       nullable: true,
     },
@@ -209,7 +322,30 @@ const schema: JSONSchemaType<PluginConfigType> = {
           nullable: true,
         },
 
-        unstable_networkInspector: { type: 'boolean', nullable: true },
+        networkInspector: { type: 'boolean', nullable: true },
+
+        extraPods: {
+          type: 'array',
+          items: {
+            type: 'object',
+            required: ['name'],
+            properties: {
+              name: { type: 'string' },
+              version: { type: 'string', nullable: true },
+              configurations: { type: 'array', items: { type: 'string' }, nullable: true },
+              modular_headers: { type: 'boolean', nullable: true },
+              source: { type: 'string', nullable: true },
+              path: { type: 'string', nullable: true },
+              podspec: { type: 'string', nullable: true },
+              testspecs: { type: 'array', items: { type: 'string' }, nullable: true },
+              git: { type: 'string', nullable: true },
+              branch: { type: 'string', nullable: true },
+              tag: { type: 'string', nullable: true },
+              commit: { type: 'string', nullable: true },
+            },
+          },
+          nullable: true,
+        },
       },
       nullable: true,
     },
@@ -284,7 +420,7 @@ export function validateConfig(config: any): PluginConfigType {
 
   // explicitly block using use_frameworks and Flipper in iOS
   // https://github.com/facebook/flipper/issues/2414
-  if (config?.ios?.flipper !== undefined && config?.ios?.useFrameworks !== undefined) {
+  if (Boolean(config.ios?.flipper) && config.ios?.useFrameworks !== undefined) {
     throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
   }