expo-build-properties 0.7.0 → 0.8.1

package/CHANGELOG.md

@@ -10,6 +10,21 @@
 
 ### 💡 Others
 
+## 0.8.1 — 2023-06-23
+
+_This version does not introduce any user-facing changes._
+
+## 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))
+- Added `android.usesCleartextTraffic` support. ([#23043](https://github.com/expo/expo/pull/23043) by [@alanjhughes](https://github.com/alanjhughes))
+
 ## 0.7.0 — 2023-05-08
 
 ### 🐛 Bug fixes

package/build/android.d.ts

@@ -19,3 +19,4 @@ export declare const withAndroidPurgeProguardRulesOnce: ConfigPlugin;
  * @returns return updated contents
  */
 export declare function updateAndroidProguardRules(contents: string, newProguardRules: string | null, updateMode: 'append' | 'overwrite'): string;
+export declare const withAndroidCleartextTraffic: ConfigPlugin<PluginConfigType>;

package/build/android.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateAndroidProguardRules = exports.withAndroidPurgeProguardRulesOnce = exports.withAndroidProguardRules = exports.withAndroidFlipper = exports.withAndroidBuildProperties = void 0;
+exports.withAndroidCleartextTraffic = exports.updateAndroidProguardRules = exports.withAndroidPurgeProguardRulesOnce = exports.withAndroidProguardRules = exports.withAndroidFlipper = exports.withAndroidBuildProperties = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
@@ -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) => {
@@ -174,3 +174,20 @@ function updateAndroidProguardRules(contents, newProguardRules, updateMode) {
     return newContents;
 }
 exports.updateAndroidProguardRules = updateAndroidProguardRules;
+const withAndroidCleartextTraffic = (config, props) => {
+    return (0, config_plugins_1.withAndroidManifest)(config, (config) => {
+        if (props.android?.usesCleartextTraffic == null) {
+            return config;
+        }
+        config.modResults = setUsesCleartextTraffic(config.modResults, props.android?.usesCleartextTraffic);
+        return config;
+    });
+};
+exports.withAndroidCleartextTraffic = withAndroidCleartextTraffic;
+function setUsesCleartextTraffic(androidManifest, value) {
+    const mainApplication = config_plugins_1.AndroidConfig.Manifest.getMainApplicationOrThrow(androidManifest);
+    if (mainApplication?.$) {
+        mainApplication.$['android:usesCleartextTraffic'] = String(value);
+    }
+    return androidManifest;
+}

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

@@ -68,10 +68,37 @@ export interface PluginConfigTypeAndroid {
      */
     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[];
+    /**
+     * Indicates whether the app intends to use cleartext network traffic.
+     *
+     * @default false
+     *
+     * @see [Android documentation](https://developer.android.com/guide/topics/manifest/application-element#usesCleartextTraffic)
+     */
+    usesCleartextTraffic?: boolean;
 }
 /**
  * Interface representing available configuration for iOS native build properties.
@@ -107,10 +134,97 @@ export interface PluginConfigTypeIos {
      */
     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,9 @@ const schema = {
                     },
                     nullable: true,
                 },
-                unstable_networkInspector: { type: 'boolean', nullable: true },
+                networkInspector: { type: 'boolean', nullable: true },
+                extraMavenRepos: { type: 'array', items: { type: 'string' }, nullable: true },
+                usesCleartextTraffic: { type: 'boolean', nullable: true },
             },
             nullable: true,
         },
@@ -64,7 +66,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,
         },

package/build/withBuildProperties.js

@@ -13,6 +13,7 @@ const withBuildProperties = (config, props) => {
     const pluginConfig = (0, pluginConfig_1.validateConfig)(props || {});
     config = (0, android_1.withAndroidBuildProperties)(config, pluginConfig);
     config = (0, android_1.withAndroidProguardRules)(config, pluginConfig);
+    config = (0, android_1.withAndroidCleartextTraffic)(config, pluginConfig);
     // Assuming `withBuildProperties` could be called multiple times from different config-plugins,
     // the `withAndroidProguardRules` always appends new rules by default.
     // That is not ideal if we leave generated contents from previous prebuild there.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-build-properties",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "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": "4ba50c428c8369bb6b3a51a860d4898ad4ccbe78"
+  "gitHead": "a72ae33519fe54eaf195dc3e61a49db8345103db"
 }

package/src/android.ts

@@ -2,6 +2,7 @@ import {
   AndroidConfig,
   ConfigPlugin,
   History,
+  withAndroidManifest,
   withDangerousMod,
   withGradleProperties,
 } from 'expo/config-plugins';
@@ -65,7 +66,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'
@@ -207,3 +208,33 @@ export function updateAndroidProguardRules(
   }
   return newContents;
 }
+
+export const withAndroidCleartextTraffic: ConfigPlugin<PluginConfigType> = (config, props) => {
+  return withAndroidManifest(config, (config) => {
+    if (props.android?.usesCleartextTraffic == null) {
+      return config;
+    }
+
+    config.modResults = setUsesCleartextTraffic(
+      config.modResults,
+      props.android?.usesCleartextTraffic
+    );
+
+    return config;
+  });
+};
+
+function setUsesCleartextTraffic(
+  androidManifest: AndroidConfig.Manifest.AndroidManifest,
+  value: boolean
+) {
+  const mainApplication = AndroidConfig.Manifest.getMainApplicationOrThrow(androidManifest);
+
+  if (mainApplication?.$) {
+    mainApplication.$['android:usesCleartextTraffic'] = String(
+      value
+    ) as AndroidConfig.Manifest.StringBoolean;
+  }
+
+  return androidManifest;
+}

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

@@ -90,10 +90,38 @@ export interface PluginConfigTypeAndroid {
   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.
+   */
+  extraMavenRepos?: string[];
+  /**
+   * Indicates whether the app intends to use cleartext network traffic.
+   *
+   * @default false
+   *
+   * @see [Android documentation](https://developer.android.com/guide/topics/manifest/application-element#usesCleartextTraffic)
    */
-  unstable_networkInspector?: boolean;
+  usesCleartextTraffic?: boolean;
 }
 
 /**
@@ -133,10 +161,99 @@ export interface PluginConfigTypeIos {
   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
    */
-  unstable_networkInspector?: boolean;
+  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.
+   */
+  commit?: string;
 }
 
 /**
@@ -195,7 +312,11 @@ 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 },
+
+        usesCleartextTraffic: { type: 'boolean', nullable: true },
       },
       nullable: true,
     },
@@ -211,7 +332,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,
     },

package/src/withBuildProperties.ts

@@ -5,6 +5,7 @@ import {
   withAndroidProguardRules,
   withAndroidPurgeProguardRulesOnce,
   withAndroidFlipper,
+  withAndroidCleartextTraffic,
 } from './android';
 import { withIosBuildProperties, withIosDeploymentTarget } from './ios';
 import { PluginConfigType, validateConfig } from './pluginConfig';
@@ -20,6 +21,7 @@ export const withBuildProperties: ConfigPlugin<PluginConfigType> = (config, prop
   config = withAndroidBuildProperties(config, pluginConfig);
 
   config = withAndroidProguardRules(config, pluginConfig);
+  config = withAndroidCleartextTraffic(config, pluginConfig);
   // Assuming `withBuildProperties` could be called multiple times from different config-plugins,
   // the `withAndroidProguardRules` always appends new rules by default.
   // That is not ideal if we leave generated contents from previous prebuild there.