expo-build-properties 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -10,6 +10,16 @@
 
 ### 💡 Others
 
+## 0.10.0 — 2023-10-17
+
+### 🎉 New features
+
+- Add `android.manifestQueries` to allow adding and modifying the `<queries>` tag in the App Manifest. ([#24619](https://github.com/expo/expo/pull/24619) by [@alanjhughes](https://github.com/alanjhughes))
+
+## 0.9.1 — 2023-09-04
+
+_This version does not introduce any user-facing changes._
+
 ## 0.9.0 — 2023-07-28
 
 _This version does not introduce any user-facing changes._

package/README.md

@@ -46,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/home/config-plugins/introduction
+[config-plugins]: https://docs.expo.dev/config-plugins/introduction

package/build/android.d.ts

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

package/build/android.js

@@ -3,10 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withAndroidCleartextTraffic = exports.updateAndroidProguardRules = exports.withAndroidPurgeProguardRulesOnce = exports.withAndroidProguardRules = exports.withAndroidFlipper = exports.withAndroidBuildProperties = void 0;
+exports.withAndroidQueries = 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"));
+const androidQueryUtils_1 = require("./androidQueryUtils");
 const fileContentsUtils_1 = require("./fileContentsUtils");
 const { createBuildGradlePropsConfigPlugin } = config_plugins_1.AndroidConfig.BuildProperties;
 exports.withAndroidBuildProperties = createBuildGradlePropsConfigPlugin([
@@ -191,3 +192,24 @@ function setUsesCleartextTraffic(androidManifest, value) {
     }
     return androidManifest;
 }
+const withAndroidQueries = (config, props) => {
+    return (0, config_plugins_1.withAndroidManifest)(config, (config) => {
+        if (props.android?.manifestQueries == null) {
+            return config;
+        }
+        const { manifestQueries } = props.android;
+        // Default template adds a single intent to the `queries` tag
+        const defaultIntents = config.modResults.manifest.queries.map((q) => q.intent ?? []).flat() ?? [];
+        const additionalQueries = {
+            package: (0, androidQueryUtils_1.renderQueryPackages)(manifestQueries.package),
+            intent: [...defaultIntents, ...(0, androidQueryUtils_1.renderQueryIntents)(manifestQueries.intent)],
+        };
+        const provider = (0, androidQueryUtils_1.renderQueryProviders)(manifestQueries.provider);
+        if (provider != null) {
+            additionalQueries.provider = provider;
+        }
+        config.modResults.manifest.queries = [additionalQueries];
+        return config;
+    });
+};
+exports.withAndroidQueries = withAndroidQueries;

package/build/androidQueryUtils.d.ts

@@ -0,0 +1,26 @@
+import { PluginConfigTypeAndroidQueriesIntent } from './pluginConfig';
+export declare function renderQueryProviders(data?: string | string[]): {
+    $: {
+        'android:authorities': string;
+    };
+} | undefined;
+export declare function renderQueryPackages(data: string | string[]): {
+    $: {
+        'android:name': string;
+    };
+}[];
+export declare function renderQueryIntents(queryIntents?: PluginConfigTypeAndroidQueriesIntent[]): {
+    action: {
+        $: {
+            'android:name': string;
+        };
+    }[];
+    data: {
+        $: {};
+    }[];
+    category: {
+        $: {
+            'android:name': string;
+        };
+    }[];
+}[];

package/build/androidQueryUtils.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderQueryIntents = exports.renderQueryPackages = exports.renderQueryProviders = void 0;
+function renderQueryProviders(data) {
+    const dataStr = Array.isArray(data) ? data.join(';') : data;
+    return dataStr ? { $: { 'android:authorities': dataStr } } : undefined;
+}
+exports.renderQueryProviders = renderQueryProviders;
+function renderQueryPackages(data) {
+    return (Array.isArray(data) ? data : [data]).filter(Boolean).map((datum) => ({
+        $: {
+            'android:name': datum,
+        },
+    }));
+}
+exports.renderQueryPackages = renderQueryPackages;
+function renderQueryIntents(queryIntents) {
+    return (queryIntents?.map((intent) => {
+        const { data, category, action } = intent;
+        return {
+            action: [
+                {
+                    $: {
+                        'android:name': `android.intent.action.${action}`,
+                    },
+                },
+            ],
+            data: (Array.isArray(data) ? data : [data]).filter(Boolean).map((datum) => ({
+                $: Object.entries(datum ?? {}).reduce((prev, [key, value]) => ({ ...prev, [`android:${key}`]: value }), {}),
+            })),
+            category: (Array.isArray(category) ? category : [category]).filter(Boolean).map((cat) => ({
+                $: {
+                    'android:name': `android.intent.category.${cat}`,
+                },
+            })),
+        };
+    }) ?? []);
+}
+exports.renderQueryIntents = renderQueryIntents;

package/build/pluginConfig.d.ts

@@ -99,6 +99,13 @@ export interface PluginConfigTypeAndroid {
      * @see [Android documentation](https://developer.android.com/guide/topics/manifest/application-element#usesCleartextTraffic)
      */
     usesCleartextTraffic?: boolean;
+    /**
+     * Specifies the set of other apps that an app intends to interact with. These other apps are specified by package name,
+     * by intent signature, or by provider authority.
+     *
+     *  @see [Android documentation](https://developer.android.com/guide/topics/manifest/queries-element)
+     */
+    manifestQueries?: PluginConfigTypeAndroidQueries;
 }
 /**
  * Interface representing available configuration for iOS native build properties.
@@ -248,6 +255,53 @@ export interface PluginConfigTypeAndroidPackagingOptions {
      */
     doNotStrip?: string[];
 }
+export interface PluginConfigTypeAndroidQueries {
+    /**
+     * Specifies a single app that your app intends to access. This other app might integrate with your app, or your app might use services that the other app provides.
+     */
+    package: string[];
+    /**
+     * Specifies an intent filter signature. Your app can discover other apps that have matching <intent-filter> elements.
+     * These intents have restrictions compared to typical intent filter signatures.
+     *
+     * @see [Android documentation](https://developer.android.com/training/package-visibility/declaring#intent-filter-signature) for details
+     */
+    intent?: PluginConfigTypeAndroidQueriesIntent[];
+    /**
+     * Specifies one or more content provider authorities. Your app can discover other apps whose content providers use the specified authorities.
+     * There are some restrictions on the options that you can include in this <provider> element, compared to a typical <provider> manifest element. You may only specify the android:authorities attribute.
+     */
+    provider?: string[];
+}
+export interface PluginConfigTypeAndroidQueriesIntent {
+    /**
+     * A string naming the action to perform. Usually one of the platform-defined values, such as ACTION_SEND or ACTION_VIEW
+     */
+    action?: string;
+    /**
+     * A description of the data associated with the intent.
+     */
+    data?: PluginConfigTypeAndroidQueriesData;
+    /**
+     * Provides an additional way to characterize the activity handling the intent,
+     * usually related to the user gesture or location from which it's started.
+     */
+    category?: string | string[];
+}
+export interface PluginConfigTypeAndroidQueriesData {
+    /**
+     * Specify a URI scheme that is handled
+     */
+    scheme?: string;
+    /**
+     * Specify a URI authority host that is handled
+     */
+    host?: string;
+    /**
+     * Specify a MIME type that is handled
+     */
+    mimeType?: string;
+}
 /**
  * @ignore
  */

package/build/pluginConfig.js

@@ -53,6 +53,35 @@ const schema = {
                 networkInspector: { type: 'boolean', nullable: true },
                 extraMavenRepos: { type: 'array', items: { type: 'string' }, nullable: true },
                 usesCleartextTraffic: { type: 'boolean', nullable: true },
+                manifestQueries: {
+                    required: ['package'],
+                    type: 'object',
+                    properties: {
+                        package: { type: 'array', items: { type: 'string' }, minItems: 1, nullable: false },
+                        intent: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    action: { type: 'string', nullable: true },
+                                    data: {
+                                        type: 'object',
+                                        properties: {
+                                            scheme: { type: 'string', nullable: true },
+                                            host: { type: 'string', nullable: true },
+                                            mimeType: { type: 'string', nullable: true },
+                                        },
+                                        nullable: true,
+                                    },
+                                    category: { type: 'array', items: { type: 'string' }, nullable: true },
+                                },
+                            },
+                            nullable: true,
+                        },
+                        provider: { type: 'array', items: { type: 'string' }, nullable: true },
+                    },
+                    nullable: true,
+                },
             },
             nullable: true,
         },

package/build/withBuildProperties.js

@@ -14,6 +14,7 @@ const withBuildProperties = (config, props) => {
     config = (0, android_1.withAndroidBuildProperties)(config, pluginConfig);
     config = (0, android_1.withAndroidProguardRules)(config, pluginConfig);
     config = (0, android_1.withAndroidCleartextTraffic)(config, pluginConfig);
+    config = (0, android_1.withAndroidQueries)(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.9.0",
+  "version": "0.10.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": "663654577a7068c641b5e9474efbc502e3f334ea"
+  "gitHead": "da25937e2a99661cbe5eb60ca1d8d6245fc96a50"
 }

package/src/android.ts

@@ -9,6 +9,7 @@ import {
 import fs from 'fs';
 import path from 'path';
 
+import { renderQueryIntents, renderQueryPackages, renderQueryProviders } from './androidQueryUtils';
 import { appendContents, purgeContents } from './fileContentsUtils';
 import type { PluginConfigType } from './pluginConfig';
 
@@ -238,3 +239,30 @@ function setUsesCleartextTraffic(
 
   return androidManifest;
 }
+
+export const withAndroidQueries: ConfigPlugin<PluginConfigType> = (config, props) => {
+  return withAndroidManifest(config, (config) => {
+    if (props.android?.manifestQueries == null) {
+      return config;
+    }
+
+    const { manifestQueries } = props.android;
+
+    // Default template adds a single intent to the `queries` tag
+    const defaultIntents =
+      config.modResults.manifest.queries.map((q) => q.intent ?? []).flat() ?? [];
+
+    const additionalQueries: AndroidConfig.Manifest.ManifestQuery = {
+      package: renderQueryPackages(manifestQueries.package),
+      intent: [...defaultIntents, ...renderQueryIntents(manifestQueries.intent)],
+    };
+
+    const provider = renderQueryProviders(manifestQueries.provider);
+    if (provider != null) {
+      additionalQueries.provider = provider;
+    }
+
+    config.modResults.manifest.queries = [additionalQueries];
+    return config;
+  });
+};

package/src/androidQueryUtils.ts

@@ -0,0 +1,42 @@
+import { PluginConfigTypeAndroidQueriesIntent } from './pluginConfig';
+
+export function renderQueryProviders(data?: string | string[]) {
+  const dataStr = Array.isArray(data) ? data.join(';') : data;
+  return dataStr ? { $: { 'android:authorities': dataStr } } : undefined;
+}
+
+export function renderQueryPackages(data: string | string[]) {
+  return (Array.isArray(data) ? data : [data]).filter(Boolean).map((datum) => ({
+    $: {
+      'android:name': datum,
+    },
+  }));
+}
+
+export function renderQueryIntents(queryIntents?: PluginConfigTypeAndroidQueriesIntent[]) {
+  return (
+    queryIntents?.map((intent) => {
+      const { data, category, action } = intent;
+      return {
+        action: [
+          {
+            $: {
+              'android:name': `android.intent.action.${action}`,
+            },
+          },
+        ],
+        data: (Array.isArray(data) ? data : [data]).filter(Boolean).map((datum) => ({
+          $: Object.entries(datum ?? {}).reduce(
+            (prev, [key, value]) => ({ ...prev, [`android:${key}`]: value }),
+            {}
+          ),
+        })),
+        category: (Array.isArray(category) ? category : [category]).filter(Boolean).map((cat) => ({
+          $: {
+            'android:name': `android.intent.category.${cat}`,
+          },
+        })),
+      };
+    }) ?? []
+  );
+}

package/src/pluginConfig.ts

@@ -122,6 +122,13 @@ export interface PluginConfigTypeAndroid {
    * @see [Android documentation](https://developer.android.com/guide/topics/manifest/application-element#usesCleartextTraffic)
    */
   usesCleartextTraffic?: boolean;
+  /**
+   * Specifies the set of other apps that an app intends to interact with. These other apps are specified by package name,
+   * by intent signature, or by provider authority.
+   *
+   *  @see [Android documentation](https://developer.android.com/guide/topics/manifest/queries-element)
+   */
+  manifestQueries?: PluginConfigTypeAndroidQueries;
 }
 
 /**
@@ -279,6 +286,56 @@ export interface PluginConfigTypeAndroidPackagingOptions {
   doNotStrip?: string[];
 }
 
+export interface PluginConfigTypeAndroidQueries {
+  /**
+   * Specifies a single app that your app intends to access. This other app might integrate with your app, or your app might use services that the other app provides.
+   */
+  package: string[];
+  /**
+   * Specifies an intent filter signature. Your app can discover other apps that have matching <intent-filter> elements.
+   * These intents have restrictions compared to typical intent filter signatures.
+   *
+   * @see [Android documentation](https://developer.android.com/training/package-visibility/declaring#intent-filter-signature) for details
+   */
+  intent?: PluginConfigTypeAndroidQueriesIntent[];
+  /**
+   * Specifies one or more content provider authorities. Your app can discover other apps whose content providers use the specified authorities.
+   * There are some restrictions on the options that you can include in this <provider> element, compared to a typical <provider> manifest element. You may only specify the android:authorities attribute.
+   */
+  provider?: string[];
+}
+
+export interface PluginConfigTypeAndroidQueriesIntent {
+  /**
+   * A string naming the action to perform. Usually one of the platform-defined values, such as ACTION_SEND or ACTION_VIEW
+   */
+  action?: string;
+  /**
+   * A description of the data associated with the intent.
+   */
+  data?: PluginConfigTypeAndroidQueriesData;
+  /**
+   * Provides an additional way to characterize the activity handling the intent,
+   * usually related to the user gesture or location from which it's started.
+   */
+  category?: string | string[];
+}
+
+export interface PluginConfigTypeAndroidQueriesData {
+  /**
+   * Specify a URI scheme that is handled
+   */
+  scheme?: string;
+  /**
+   * Specify a URI authority host that is handled
+   */
+  host?: string;
+  /**
+   * Specify a MIME type that is handled
+   */
+  mimeType?: string;
+}
+
 const schema: JSONSchemaType<PluginConfigType> = {
   type: 'object',
   properties: {
@@ -317,6 +374,36 @@ const schema: JSONSchemaType<PluginConfigType> = {
         extraMavenRepos: { type: 'array', items: { type: 'string' }, nullable: true },
 
         usesCleartextTraffic: { type: 'boolean', nullable: true },
+
+        manifestQueries: {
+          required: ['package'],
+          type: 'object',
+          properties: {
+            package: { type: 'array', items: { type: 'string' }, minItems: 1, nullable: false },
+            intent: {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  action: { type: 'string', nullable: true },
+                  data: {
+                    type: 'object',
+                    properties: {
+                      scheme: { type: 'string', nullable: true },
+                      host: { type: 'string', nullable: true },
+                      mimeType: { type: 'string', nullable: true },
+                    },
+                    nullable: true,
+                  },
+                  category: { type: 'array', items: { type: 'string' }, nullable: true },
+                },
+              },
+              nullable: true,
+            },
+            provider: { type: 'array', items: { type: 'string' }, nullable: true },
+          },
+          nullable: true,
+        },
       },
       nullable: true,
     },

package/src/withBuildProperties.ts

@@ -6,6 +6,7 @@ import {
   withAndroidPurgeProguardRulesOnce,
   withAndroidFlipper,
   withAndroidCleartextTraffic,
+  withAndroidQueries,
 } from './android';
 import { withIosBuildProperties, withIosDeploymentTarget } from './ios';
 import { PluginConfigType, validateConfig } from './pluginConfig';
@@ -22,6 +23,7 @@ export const withBuildProperties: ConfigPlugin<PluginConfigType> = (config, prop
 
   config = withAndroidProguardRules(config, pluginConfig);
   config = withAndroidCleartextTraffic(config, pluginConfig);
+  config = withAndroidQueries(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.