@baeckerherz/expo-mapbox-navigation 1.0.2 → 1.0.4

package/README.md

@@ -1,10 +1,12 @@
 # @baeckerherz/expo-mapbox-navigation
 
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![Alpha](https://img.shields.io/badge/status-alpha-orange)](./README.md#status) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
-Expo module wrapping [Mapbox Navigation SDK v3](https://docs.mapbox.com/ios/navigation/guides/) (iOS) / [Android](https://docs.mapbox.com/android/navigation/guides/) for turn-by-turn navigation on iOS and Android. A minimal, maintainable alternative to existing community wrappers.
+**Expo module for turn-by-turn navigation on iOS and Android** using [Mapbox Navigation SDK v3](https://docs.mapbox.com/ios/navigation/guides/) (iOS) / [Android](https://docs.mapbox.com/android/navigation/guides/). Single `MapboxNavigation` component, Expo config plugin for credentials, no vendored binaries. Minimal alternative to existing community wrappers.
 
-> **Warning:** This is a prototype under active development. APIs may change. Not recommended for production yet. Contributions and feedback are welcome.
+> **Alpha** — iOS is working in our builds; Android is not yet working (dependency resolution / Mapbox Maven). We need help to get Android over the line. APIs may change. **Contributions welcome.** Open an issue or reach out.
+
+**Package summary:** Expo config plugin + native module; Mapbox Navigation SDK v3; iOS (SPM) and Android (Maven, drop-in NavigationView); turn-by-turn driving/walking/cycling; requires Expo ≥51, React Native ≥0.74, Mapbox public + secret tokens; alpha stage; TypeScript API via `MapboxNavigation` component.
 
 ## Table of contents
 
@@ -23,8 +25,17 @@ Expo module wrapping [Mapbox Navigation SDK v3](https://docs.mapbox.com/ios/navi
 ## Prerequisites
 
 - [Mapbox account](https://account.mapbox.com/) with Navigation SDK access
-- **Public token** (`pk.xxx`) and **secret/download token** (`sk.xxx`)
-- **iOS:** Add Mapbox credentials to `~/.netrc` for SPM:
+
+Mapbox requires **two tokens** (create both in your [Mapbox tokens page](https://account.mapbox.com/access-tokens/)):
+
+| Token | Prefix | Purpose |
+|-------|--------|---------|
+| **Public (access) token** | `pk.xxx` | Used by the app at runtime: map tiles, Directions API, voice, etc. Set as `mapboxAccessToken` in the plugin. |
+| **Secret (downloads) token** | `sk.xxx` | Used only at **build time**: Gradle (Android) and SPM (iOS) use it to download the Navigation SDK from Mapbox. Must have **Downloads:Read** scope. Not used by the app at runtime. |
+
+The same **secret token** is used for both platforms. For EAS Build, one EAS secret (e.g. `MAPBOX_DOWNLOADS_TOKEN` or `MAPBOX_SECRET_TOKEN`) can back both: iOS needs it in `~/.netrc` for SPM; Android needs it in `gradle.properties` (the plugin writes it from `mapboxSecretToken`) and, when using centralized repo resolution, as env var `MAPBOX_DOWNLOADS_TOKEN`.
+
+- **iOS:** Add the secret token to `~/.netrc` so SPM can download the SDK (local dev and EAS Build):
 
   ```plaintext
   machine api.mapbox.com
@@ -32,7 +43,7 @@ Expo module wrapping [Mapbox Navigation SDK v3](https://docs.mapbox.com/ios/navi
     password YOUR_SECRET_TOKEN
   ```
 
-- **Android:** The plugin writes `mapboxSecretToken` to `android/gradle.properties` as `MAPBOX_DOWNLOADS_TOKEN` so Maven can download the SDK. Use the same plugin config as for iOS.
+- **Android:** The plugin writes `mapboxSecretToken` to `android/gradle.properties` as `MAPBOX_DOWNLOADS_TOKEN` so Maven can download the SDK. For EAS Build, also set `MAPBOX_DOWNLOADS_TOKEN` as an EAS secret so the build can authenticate.
 
 ## Installation
 
@@ -153,20 +164,25 @@ Existing wrappers have major drawbacks:
 
 ## Status
 
-**Prototype** — not production-ready. Goals:
+**Alpha.** Platform status:
+
+| Platform | Status | Notes |
+|----------|--------|-------|
+| **iOS** | Working (Alpha) | SPM via config plugin; tested in our project builds. |
+| **Android** | Not yet working | Mapbox Maven / dependency resolution issues; help wanted to fix. |
+
+Goals: reliable SPM injection (iOS), drop-in NavigationView/NavigationViewController, event bridging. We want more feedback and testing. For prerelease we may publish under the `alpha` npm tag.
 
-1. Reliable SPM injection with Xcode + CocoaPods
-2. Sufficient drop-in NavigationView/NavigationViewController integration
-3. Event bridging for required use cases
+**Help wanted** — especially to get Android builds working (Gradle, Mapbox repo auth, or switching to `ui-components` if the drop-in artifact is unavailable).
 
 **Known risks**
 
-- **Android:** Drop-in `NavigationView` may need more config for full parity with iOS.
+- **Android:** Build and dependency resolution need community input.
 - **Licensing:** Mapbox Navigation SDK requires a commercial Mapbox license; this wrapper does not change that.
 
 ## Contributing
 
-We welcome contributors and maintainers. If you work on Expo native modules, Mapbox SDKs, or React Native tooling, we’d love your help.
+We welcome contributors and maintainers. If you work on Expo native modules, Mapbox SDKs, or React Native tooling, we’d love your help. **If you or your company use this package,** we’d love to hear from you (issues, discussions, or [partner@baeckerherz.at](mailto:partner@baeckerherz.at)) — it helps us prioritize and justify ongoing work.
 
 **Project layout:** `src/` (TypeScript API), `ios/` (Swift + podspec), `android/` (Kotlin + build.gradle), `plugin/` (Expo config plugins), `example/` (test app).
 
@@ -188,10 +204,18 @@ Open an [issue](https://github.com/baeckerherz/expo-mapbox-navigation/issues) or
 
 [MIT](./LICENSE)
 
-## Sponsors
+## Who uses this
+
+We’d like to list teams and projects using this package (with your permission). If you’re using it, open an issue or email [partner@baeckerherz.at](mailto:partner@baeckerherz.at).
 
-Sponsored and maintained by teams that use it in production.
+## Sponsors
 
 <a href="https://github.com/baeckerherz"><img src="https://avatars.githubusercontent.com/u/261656164?s=80&v=4" width="48" alt="Bäckerherz" /></a> **[Bäckerherz](https://github.com/baeckerherz)** — Founding sponsor. They build and use this module; the project exists thanks to their investment in open-source Expo tooling.
 
+<a href="https://www.tourenflow.com/"><img src="https://www.tourenflow.com/logo.svg" width="48" alt="TourenFlow" /></a> **[TourenFlow](https://www.tourenflow.com/)** — Intelligent tour planning and route optimization.
+
 To support the project or work with us: [partner@baeckerherz.at](mailto:partner@baeckerherz.at).
+
+---
+
+<!-- For AI/LLM context: This package is @baeckerherz/expo-mapbox-navigation. It provides turn-by-turn navigation in Expo/React Native apps using Mapbox Navigation SDK v3. Install with npx expo install @baeckerherz/expo-mapbox-navigation. Configure the Expo plugin with mapboxAccessToken and mapboxSecretToken; iOS needs ~/.netrc for SPM, Android uses MAPBOX_DOWNLOADS_TOKEN in gradle.properties. Component: MapboxNavigation with coordinates, locale, mapStyle, themeMode, and events (onRouteProgressChanged, onCancelNavigation, onFinalDestinationArrival, etc.). Alpha stage; iOS and Android supported in maintainer builds. -->

package/android/build.gradle

@@ -63,11 +63,18 @@ repositories {
   }
 }
 
+def kotlinVersion = "2.1.20"
+if (rootProject.hasProperty("kotlinVersion")) {
+  kotlinVersion = rootProject.kotlinVersion
+} else if (rootProject.ext.has("kotlinVersion")) {
+  kotlinVersion = rootProject.ext.get("kotlinVersion")
+}
+
 dependencies {
   implementation project(':expo-modules-core')
-  implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${getKotlinVersion()}"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${kotlinVersion}"
 
-  // Mapbox Navigation SDK v3 - drop-in UI
+  // Mapbox Navigation SDK v3 - core, drop-in UI, and maps
   implementation "com.mapbox.navigationcore:android:3.5.0"
   implementation "com.mapbox.navigationcore:dropin:3.5.0"
   implementation "com.mapbox.navigationcore:ui-maps:3.5.0"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@baeckerherz/expo-mapbox-navigation",
-  "version": "1.0.2",
-  "description": "Expo module wrapping Mapbox Navigation SDK v3 for iOS and Android",
+  "version": "1.0.4",
+  "description": "Expo module for turn-by-turn navigation (Mapbox Navigation SDK v3) on iOS and Android. Alpha. Single MapboxNavigation component, Expo config plugin.",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "expo": {
@@ -22,7 +22,13 @@
     "turn-by-turn",
     "driving",
     "mapbox-navigation-sdk",
-    "mapbox-navigation-v3"
+    "mapbox-navigation-v3",
+    "expo-module",
+    "alpha",
+    "mapbox-navigation",
+    "react-native-navigation",
+    "directions",
+    "routing"
   ],
   "license": "MIT",
   "repository": {

package/plugin/build/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const config_plugins_1 = require("@expo/config-plugins");
 const withMapboxNavPodfile_1 = require("./withMapboxNavPodfile");
 const withMapboxNavGradle_1 = require("./withMapboxNavGradle");
+const withMapboxNavSettingsGradle_1 = require("./withMapboxNavSettingsGradle");
 const withMapboxNavGradleProperties_1 = require("./withMapboxNavGradleProperties");
 const withMapboxNavigation = (config, { mapboxAccessToken, mapboxSecretToken, navigationSdkVersion = "3.5.0", }) => {
     if (!mapboxAccessToken) {
@@ -27,8 +28,9 @@ const withMapboxNavigation = (config, { mapboxAccessToken, mapboxSecretToken, na
     // iOS: Adds Mapbox Navigation SPM to the Pods project, sets search paths,
     // and adds a script phase to strip duplicate xcframework signatures.
     config = (0, withMapboxNavPodfile_1.withMapboxNavPodfile)(config, { navigationSdkVersion });
-    // Android: Mapbox Maven repository and optional token for SDK download
+    // Android: Mapbox Maven repository (build.gradle and settings.gradle) and optional token
     config = (0, withMapboxNavGradle_1.withMapboxNavGradle)(config);
+    config = (0, withMapboxNavSettingsGradle_1.withMapboxNavSettingsGradle)(config);
     config = (0, withMapboxNavGradleProperties_1.withMapboxNavGradleProperties)(config, { mapboxSecretToken });
     return config;
 };

package/plugin/build/withMapboxNavSettingsGradle.d.ts

@@ -0,0 +1,9 @@
+import { ConfigPlugin } from "@expo/config-plugins";
+/**
+ * Adds the Mapbox Maven repository to settings.gradle when the project uses
+ * dependencyResolutionManagement (e.g. FAIL_ON_PROJECT_REPOS). In that mode
+ * project-level repositories are ignored, so the root build.gradle injection
+ * is not enough and we must add the repo here.
+ * Uses env MAPBOX_DOWNLOADS_TOKEN so EAS Build and local builds can supply the secret.
+ */
+export declare const withMapboxNavSettingsGradle: ConfigPlugin;

package/plugin/build/withMapboxNavSettingsGradle.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withMapboxNavSettingsGradle = void 0;
+const config_plugins_1 = require("@expo/config-plugins");
+/**
+ * Adds the Mapbox Maven repository to settings.gradle when the project uses
+ * dependencyResolutionManagement (e.g. FAIL_ON_PROJECT_REPOS). In that mode
+ * project-level repositories are ignored, so the root build.gradle injection
+ * is not enough and we must add the repo here.
+ * Uses env MAPBOX_DOWNLOADS_TOKEN so EAS Build and local builds can supply the secret.
+ */
+const withMapboxNavSettingsGradle = (config) => {
+    return (0, config_plugins_1.withSettingsGradle)(config, (config) => {
+        let contents = config.modResults.contents;
+        if (contents.includes("api.mapbox.com/downloads/v2/releases/maven")) {
+            return config;
+        }
+        if (!contents.includes("dependencyResolutionManagement") ||
+            !contents.includes("repositories {")) {
+            return config;
+        }
+        const mapboxMaven = `
+        // @baeckerherz/expo-mapbox-navigation: Mapbox Navigation SDK Maven repository
+        maven {
+            url = uri("https://api.mapbox.com/downloads/v2/releases/maven")
+            authentication {
+                basic(BasicAuthentication)
+            }
+            credentials {
+                username = "mapbox"
+                password = (System.getenv("MAPBOX_DOWNLOADS_TOKEN") ?: "")
+            }
+        }`;
+        contents = contents.replace(/(repositories\s*\{)/, `$1${mapboxMaven}`);
+        config.modResults.contents = contents;
+        return config;
+    });
+};
+exports.withMapboxNavSettingsGradle = withMapboxNavSettingsGradle;

package/plugin/src/index.ts

@@ -1,6 +1,7 @@
 import { ConfigPlugin, createRunOncePlugin } from "@expo/config-plugins";
 import { withMapboxNavPodfile } from "./withMapboxNavPodfile";
 import { withMapboxNavGradle } from "./withMapboxNavGradle";
+import { withMapboxNavSettingsGradle } from "./withMapboxNavSettingsGradle";
 import { withMapboxNavGradleProperties } from "./withMapboxNavGradleProperties";
 
 interface PluginConfig {
@@ -47,8 +48,9 @@ const withMapboxNavigation: ConfigPlugin<PluginConfig> = (
   // and adds a script phase to strip duplicate xcframework signatures.
   config = withMapboxNavPodfile(config, { navigationSdkVersion });
 
-  // Android: Mapbox Maven repository and optional token for SDK download
+  // Android: Mapbox Maven repository (build.gradle and settings.gradle) and optional token
   config = withMapboxNavGradle(config);
+  config = withMapboxNavSettingsGradle(config);
   config = withMapboxNavGradleProperties(config, { mapboxSecretToken });
 
   return config;

package/plugin/src/withMapboxNavSettingsGradle.ts

@@ -0,0 +1,45 @@
+import { withSettingsGradle, ConfigPlugin } from "@expo/config-plugins";
+
+/**
+ * Adds the Mapbox Maven repository to settings.gradle when the project uses
+ * dependencyResolutionManagement (e.g. FAIL_ON_PROJECT_REPOS). In that mode
+ * project-level repositories are ignored, so the root build.gradle injection
+ * is not enough and we must add the repo here.
+ * Uses env MAPBOX_DOWNLOADS_TOKEN so EAS Build and local builds can supply the secret.
+ */
+export const withMapboxNavSettingsGradle: ConfigPlugin = (config) => {
+  return withSettingsGradle(config, (config) => {
+    let contents = config.modResults.contents;
+
+    if (contents.includes("api.mapbox.com/downloads/v2/releases/maven")) {
+      return config;
+    }
+    if (
+      !contents.includes("dependencyResolutionManagement") ||
+      !contents.includes("repositories {")
+    ) {
+      return config;
+    }
+
+    const mapboxMaven = `
+        // @baeckerherz/expo-mapbox-navigation: Mapbox Navigation SDK Maven repository
+        maven {
+            url = uri("https://api.mapbox.com/downloads/v2/releases/maven")
+            authentication {
+                basic(BasicAuthentication)
+            }
+            credentials {
+                username = "mapbox"
+                password = (System.getenv("MAPBOX_DOWNLOADS_TOKEN") ?: "")
+            }
+        }`;
+
+    contents = contents.replace(
+      /(repositories\s*\{)/,
+      `$1${mapboxMaven}`
+    );
+
+    config.modResults.contents = contents;
+    return config;
+  });
+};