@forthtilliath/expo-config-plugins 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Forthtilliath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,73 @@
-# Temporary Holding Version
+# @forthtilliath/expo-config-plugins
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Expo config plugins for sideloaded Android apps (APKs shared directly, not through a store).
+
+## Install
+
+```bash
+npm install --save-dev @forthtilliath/expo-config-plugins
+```
+
+`expo` is a peer dependency. Then list the plugins in `app.json`, and run `npx expo prebuild` again.
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@forthtilliath/expo-config-plugins/withReleaseSigning",
+        { "propertyPrefix": "MYAPP" }
+      ],
+      "@forthtilliath/expo-config-plugins/withAndroidAbis",
+      "@forthtilliath/expo-config-plugins/withShortCxxPath"
+    ]
+  }
+}
+```
+
+## `withReleaseSigning` — sign releases with your own key
+
+Out of the box, an Expo release APK is signed with React Native's `debug.keystore` — **the same public key in every React Native project**: anyone could sign an APK that Android accepts as an update of yours. This plugin makes the release build use your upload key instead, read from Gradle properties that stay out of the repository:
+
+```properties
+# ~/.gradle/gradle.properties (or ORG_GRADLE_PROJECT_MYAPP_UPLOAD_* variables)
+MYAPP_UPLOAD_STORE_FILE=C:/keys/myapp-upload.jks
+MYAPP_UPLOAD_STORE_PASSWORD=…
+MYAPP_UPLOAD_KEY_ALIAS=upload
+MYAPP_UPLOAD_KEY_PASSWORD=…
+```
+
+Without these properties the release build **fails** ("Keystore file not set") rather than falling back to the debug key. If Expo's Gradle template changes and the signing block can't be found, the prebuild fails too. The debug build is untouched.
+
+| Option           | Type     | Notes                                                                              |
+| ---------------- | -------- | ---------------------------------------------------------------------------------- |
+| `propertyPrefix` | `string` | Required, upper case (`MYAPP` → `MYAPP_UPLOAD_*`). One prefix per app and per key. |
+
+## `withAndroidAbis` — real phones only
+
+Ships native code for 32- and 64-bit ARM only: x86 / x86_64 only serve emulators and nearly double the APK's size. `expo run:android` still builds for the connected device's ABI.
+
+| Option | Type       | Default                        |
+| ------ | ---------- | ------------------------------ |
+| `abis` | `string[]` | `["armeabi-v7a", "arm64-v8a"]` |
+
+## `withShortCxxPath` — Windows path length
+
+On Windows, release builds can overflow the 260-character path limit inside `android/app/.cxx` (react-native-gesture-handler's codegen paths). This plugin moves CMake's staging directory to a short path. It does nothing on other systems unless `stagingDir` is set.
+
+| Option       | Type     | Default                           |
+| ------------ | -------- | --------------------------------- |
+| `stagingDir` | `string` | `C:/rncxx` on Windows, else unset |
+
+## Testing your own setup
+
+The transforms behind the plugins are exported as pure functions from `@forthtilliath/expo-config-plugins/transforms` (`applyReleaseSigning`, `applyAndroidAbis`, `applyShortCxxPath`).
+
+## Scripts
+
+| Script        | What it does                   |
+| ------------- | ------------------------------ |
+| `build`       | Compiles `src/` to CommonJS.   |
+| `test`        | Runs the transform tests.      |
+| `lint`        | ESLint, zero warnings allowed. |
+| `check-types` | Type-checks without emitting.  |

package/dist/transforms.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Makes `android/app/build.gradle` sign release builds with the app's own
+ * upload key, read from `<PREFIX>_UPLOAD_*` Gradle properties, instead of
+ * React Native's **public** `debug.keystore`. The debug build is untouched;
+ * already-patched contents are returned as is.
+ *
+ * @throws When `prefix` isn't an upper-case identifier, or when the expected
+ *   signing block isn't there — failing the prebuild beats shipping an APK
+ *   signed with the debug key.
+ */
+export declare function applyReleaseSigning(contents: string, prefix: string | undefined): string;
+/** One entry of `gradle.properties`, as Expo's `withGradleProperties` exposes it. */
+export type GradlePropertiesItem = {
+    type: "property";
+    key: string;
+    value: string;
+} | {
+    type: "comment";
+    value: string;
+} | {
+    type: "empty";
+};
+/** Real phones only: 32- and 64-bit ARM. */
+export declare const ARM_ABIS: readonly string[];
+/**
+ * Sets `reactNativeArchitectures` in `gradle.properties` (in place), so the
+ * APK only ships native code for `abis` — x86 / x86_64 only serve emulators
+ * and nearly double the APK's size. `expo run:android` still passes the
+ * device's own ABI, which wins over this value in development.
+ */
+export declare function applyAndroidAbis(properties: GradlePropertiesItem[], abis?: readonly string[]): GradlePropertiesItem[];
+/**
+ * Moves the CMake staging directory (`.cxx`) out of `android/app` to
+ * `stagingDir`: nested in the project, release builds overflow Windows'
+ * 260-character path limit on react-native-gesture-handler's codegen paths.
+ * Already-patched contents are returned as is.
+ *
+ * @throws When the `namespace` line to anchor on isn't found.
+ */
+export declare function applyShortCxxPath(contents: string, stagingDir: string): string;
+export interface ReleaseSigningOptions {
+    /**
+     * Prefix of the Gradle properties holding the upload key, e.g. `MYAPP` for
+     * `MYAPP_UPLOAD_STORE_FILE`, `MYAPP_UPLOAD_STORE_PASSWORD`,
+     * `MYAPP_UPLOAD_KEY_ALIAS`, `MYAPP_UPLOAD_KEY_PASSWORD`.
+     */
+    propertyPrefix?: string;
+}
+export interface AndroidAbisOptions {
+    /** @defaultValue `["armeabi-v7a", "arm64-v8a"]` — real phones only */
+    abis?: string[];
+}
+export interface ShortCxxPathOptions {
+    /**
+     * Where CMake stages native builds. Given, it always applies; omitted, the
+     * plugin only acts on Windows, with `C:/rncxx`.
+     */
+    stagingDir?: string;
+}
+//# sourceMappingURL=transforms.d.ts.map

package/dist/transforms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transforms.d.ts","sourceRoot":"","sources":["../src/transforms.ts"],"names":[],"mappings":"AAoBA;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,MAAM,CAmBR;AAED,qFAAqF;AACrF,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtB,4CAA4C;AAC5C,eAAO,MAAM,QAAQ,EAAE,SAAS,MAAM,EAAiC,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,oBAAoB,EAAE,EAClC,IAAI,GAAE,SAAS,MAAM,EAAa,GACjC,oBAAoB,EAAE,CAcxB;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,MAAM,CAiBR;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/transforms.js

@@ -0,0 +1,89 @@
+"use strict";
+// The plugins' actual work, as pure functions over the generated files'
+// contents — testable without running `expo prebuild` — and their options.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ARM_ABIS = void 0;
+exports.applyReleaseSigning = applyReleaseSigning;
+exports.applyAndroidAbis = applyAndroidAbis;
+exports.applyShortCxxPath = applyShortCxxPath;
+/** The `signingConfig signingConfigs.debug` of the `release` build type (not the `debug` one's). */
+const RELEASE_USES_DEBUG_KEY = /(buildTypes\s*\{[\s\S]*?release\s*\{[^}]*?)signingConfig signingConfigs\.debug/;
+function releaseSigningConfig(prefix) {
+    const property = (name) => `findProperty('${prefix}_UPLOAD_${name}')`;
+    return `signingConfigs {
+        release {
+            if (${property("STORE_FILE")}) {
+                storeFile file(${property("STORE_FILE")})
+                storePassword ${property("STORE_PASSWORD")}
+                keyAlias ${property("KEY_ALIAS")}
+                keyPassword ${property("KEY_PASSWORD")}
+            }
+        }`;
+}
+/**
+ * Makes `android/app/build.gradle` sign release builds with the app's own
+ * upload key, read from `<PREFIX>_UPLOAD_*` Gradle properties, instead of
+ * React Native's **public** `debug.keystore`. The debug build is untouched;
+ * already-patched contents are returned as is.
+ *
+ * @throws When `prefix` isn't an upper-case identifier, or when the expected
+ *   signing block isn't there — failing the prebuild beats shipping an APK
+ *   signed with the debug key.
+ */
+function applyReleaseSigning(contents, prefix) {
+    if (prefix === undefined || !/^[A-Z][A-Z0-9_]*$/.test(prefix)) {
+        throw new Error("withReleaseSigning: missing or invalid propertyPrefix option (e.g. MYAPP)");
+    }
+    if (contents.includes("signingConfig signingConfigs.release"))
+        return contents;
+    if (!RELEASE_USES_DEBUG_KEY.test(contents) ||
+        !contents.includes("signingConfigs {")) {
+        throw new Error("withReleaseSigning: signing block not found in android/app/build.gradle");
+    }
+    return contents
+        .replace(RELEASE_USES_DEBUG_KEY, "$1signingConfig signingConfigs.release")
+        .replace("signingConfigs {", releaseSigningConfig(prefix));
+}
+/** Real phones only: 32- and 64-bit ARM. */
+exports.ARM_ABIS = ["armeabi-v7a", "arm64-v8a"];
+/**
+ * Sets `reactNativeArchitectures` in `gradle.properties` (in place), so the
+ * APK only ships native code for `abis` — x86 / x86_64 only serve emulators
+ * and nearly double the APK's size. `expo run:android` still passes the
+ * device's own ABI, which wins over this value in development.
+ */
+function applyAndroidAbis(properties, abis = exports.ARM_ABIS) {
+    const value = abis.join(",");
+    const existing = properties.find((item) => item.type === "property" && item.key === "reactNativeArchitectures");
+    if (existing)
+        existing.value = value;
+    else
+        properties.push({
+            type: "property",
+            key: "reactNativeArchitectures",
+            value,
+        });
+    return properties;
+}
+/**
+ * Moves the CMake staging directory (`.cxx`) out of `android/app` to
+ * `stagingDir`: nested in the project, release builds overflow Windows'
+ * 260-character path limit on react-native-gesture-handler's codegen paths.
+ * Already-patched contents are returned as is.
+ *
+ * @throws When the `namespace` line to anchor on isn't found.
+ */
+function applyShortCxxPath(contents, stagingDir) {
+    if (contents.includes("buildStagingDirectory"))
+        return contents;
+    if (!contents.includes("    namespace")) {
+        throw new Error("withShortCxxPath: `namespace` line not found in android/app/build.gradle");
+    }
+    return contents.replace("    namespace", `    externalNativeBuild {
+        cmake {
+            buildStagingDirectory "${stagingDir.replace(/\\/g, "/")}"
+        }
+    }
+
+    namespace`);
+}

package/dist/withAndroidAbis.d.ts

@@ -0,0 +1,13 @@
+import { type ConfigPlugin } from "expo/config-plugins";
+import { type AndroidAbisOptions } from "./transforms.js";
+/**
+ * Ships native code for real phones only (32- and 64-bit ARM) by default:
+ * x86 / x86_64 only serve emulators and nearly double the APK's size.
+ * `expo run:android` still passes the device's own ABI in development.
+ *
+ * `"@forthtilliath/expo-config-plugins/withAndroidAbis"`, or
+ * `["@forthtilliath/expo-config-plugins/withAndroidAbis", { "abis": ["arm64-v8a"] }]`
+ */
+declare const withAndroidAbis: ConfigPlugin<AndroidAbisOptions | undefined>;
+export = withAndroidAbis;
+//# sourceMappingURL=withAndroidAbis.d.ts.map

package/dist/withAndroidAbis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withAndroidAbis.d.ts","sourceRoot":"","sources":["../src/withAndroidAbis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAwB,MAAM,qBAAqB,CAAC;AAE9E,OAAO,EAAE,KAAK,kBAAkB,EAAoB,MAAM,iBAAiB,CAAC;AAE5E;;;;;;;GAOG;AACH,QAAA,MAAM,eAAe,EAAE,YAAY,CAAC,kBAAkB,GAAG,SAAS,CAO9D,CAAC;AAEL,SAAS,eAAe,CAAC"}

package/dist/withAndroidAbis.js

@@ -0,0 +1,16 @@
+"use strict";
+const config_plugins_1 = require("expo/config-plugins");
+const transforms_js_1 = require("./transforms.js");
+/**
+ * Ships native code for real phones only (32- and 64-bit ARM) by default:
+ * x86 / x86_64 only serve emulators and nearly double the APK's size.
+ * `expo run:android` still passes the device's own ABI in development.
+ *
+ * `"@forthtilliath/expo-config-plugins/withAndroidAbis"`, or
+ * `["@forthtilliath/expo-config-plugins/withAndroidAbis", { "abis": ["arm64-v8a"] }]`
+ */
+const withAndroidAbis = (config, options) => (0, config_plugins_1.withGradleProperties)(config, (mod) => {
+    (0, transforms_js_1.applyAndroidAbis)(mod.modResults, options?.abis);
+    return mod;
+});
+module.exports = withAndroidAbis;

package/dist/withReleaseSigning.d.ts

@@ -0,0 +1,15 @@
+import { type ConfigPlugin } from "expo/config-plugins";
+import { type ReleaseSigningOptions } from "./transforms.js";
+/**
+ * Signs the release APK with the app's own upload key instead of React
+ * Native's public `debug.keystore` (the same key in every RN project: anyone
+ * could sign a fake update). The key and its passwords stay out of the repo,
+ * read as Gradle properties (`~/.gradle/gradle.properties` or
+ * `ORG_GRADLE_PROJECT_*` variables). Without them the release build fails
+ * ("Keystore file not set") instead of falling back to the debug key.
+ *
+ * `["@forthtilliath/expo-config-plugins/withReleaseSigning", { "propertyPrefix": "MYAPP" }]`
+ */
+declare const withReleaseSigning: ConfigPlugin<ReleaseSigningOptions | undefined>;
+export = withReleaseSigning;
+//# sourceMappingURL=withReleaseSigning.d.ts.map

package/dist/withReleaseSigning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withReleaseSigning.d.ts","sourceRoot":"","sources":["../src/withReleaseSigning.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,iBAAiB,CAAC;AAEzB;;;;;;;;;GASG;AACH,QAAA,MAAM,kBAAkB,EAAE,YAAY,CAAC,qBAAqB,GAAG,SAAS,CAUpE,CAAC;AAEL,SAAS,kBAAkB,CAAC"}

package/dist/withReleaseSigning.js

@@ -0,0 +1,18 @@
+"use strict";
+const config_plugins_1 = require("expo/config-plugins");
+const transforms_js_1 = require("./transforms.js");
+/**
+ * Signs the release APK with the app's own upload key instead of React
+ * Native's public `debug.keystore` (the same key in every RN project: anyone
+ * could sign a fake update). The key and its passwords stay out of the repo,
+ * read as Gradle properties (`~/.gradle/gradle.properties` or
+ * `ORG_GRADLE_PROJECT_*` variables). Without them the release build fails
+ * ("Keystore file not set") instead of falling back to the debug key.
+ *
+ * `["@forthtilliath/expo-config-plugins/withReleaseSigning", { "propertyPrefix": "MYAPP" }]`
+ */
+const withReleaseSigning = (config, options) => (0, config_plugins_1.withAppBuildGradle)(config, (mod) => {
+    mod.modResults.contents = (0, transforms_js_1.applyReleaseSigning)(mod.modResults.contents, options?.propertyPrefix);
+    return mod;
+});
+module.exports = withReleaseSigning;

package/dist/withShortCxxPath.d.ts

@@ -0,0 +1,13 @@
+import { type ConfigPlugin } from "expo/config-plugins";
+import { type ShortCxxPathOptions } from "./transforms.js";
+/**
+ * Moves the CMake staging directory (`.cxx`) out of the project: on Windows,
+ * release builds overflow the 260-character path limit on
+ * react-native-gesture-handler's codegen paths. A no-op on other systems
+ * unless `stagingDir` is set.
+ *
+ * `"@forthtilliath/expo-config-plugins/withShortCxxPath"`
+ */
+declare const withShortCxxPath: ConfigPlugin<ShortCxxPathOptions | undefined>;
+export = withShortCxxPath;
+//# sourceMappingURL=withShortCxxPath.d.ts.map

package/dist/withShortCxxPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withShortCxxPath.d.ts","sourceRoot":"","sources":["../src/withShortCxxPath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EAAqB,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;;;;;;GAOG;AACH,QAAA,MAAM,gBAAgB,EAAE,YAAY,CAAC,mBAAmB,GAAG,SAAS,CAcnE,CAAC;AAEF,SAAS,gBAAgB,CAAC"}

package/dist/withShortCxxPath.js

@@ -0,0 +1,21 @@
+"use strict";
+const config_plugins_1 = require("expo/config-plugins");
+const transforms_js_1 = require("./transforms.js");
+/**
+ * Moves the CMake staging directory (`.cxx`) out of the project: on Windows,
+ * release builds overflow the 260-character path limit on
+ * react-native-gesture-handler's codegen paths. A no-op on other systems
+ * unless `stagingDir` is set.
+ *
+ * `"@forthtilliath/expo-config-plugins/withShortCxxPath"`
+ */
+const withShortCxxPath = (config, options) => {
+    const stagingDir = options?.stagingDir ?? (process.platform === "win32" ? "C:/rncxx" : null);
+    if (!stagingDir)
+        return config;
+    return (0, config_plugins_1.withAppBuildGradle)(config, (mod) => {
+        mod.modResults.contents = (0, transforms_js_1.applyShortCxxPath)(mod.modResults.contents, stagingDir);
+        return mod;
+    });
+};
+module.exports = withShortCxxPath;

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@forthtilliath/expo-config-plugins",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Expo config plugins for sideloaded Android apps: release signing with your own key, ARM-only native code, short CMake paths on Windows.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Forthtilliath/forthtilliath-packages.git",
+    "directory": "packages/expo-config-plugins"
+  },
+  "homepage": "https://github.com/Forthtilliath/forthtilliath-packages/tree/main/packages/expo-config-plugins#readme",
+  "bugs": "https://github.com/Forthtilliath/forthtilliath-packages/issues",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./withReleaseSigning": "./dist/withReleaseSigning.js",
+    "./withAndroidAbis": "./dist/withAndroidAbis.js",
+    "./withShortCxxPath": "./dist/withShortCxxPath.js",
+    "./transforms": "./dist/transforms.js",
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "expo": ">=54.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.2.0",
+    "@vitest/coverage-v8": "5.0.2",
+    "eslint": "10.7.0",
+    "expo": "~57.0.9",
+    "typescript": "^5.9.3",
+    "vitest": "^5.0.2",
+    "@forthtilliath/eslint-config": "0.9.0",
+    "@forthtilliath/typescript-config": "0.1.1"
+  },
+  "scripts": {
+    "lint": "eslint . --max-warnings 0",
+    "check-types": "tsc --noEmit",
+    "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
+    "dev": "tsc --watch -p tsconfig.build.json",
+    "build": "pnpm run clean && tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage"
+  }
 }