@atomiqlab/react-native-mapbox-navigation 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 1.1.0
+
+- Added iOS current-location fallback for full-screen `startNavigation` when `startOrigin` is omitted.
+- Improved release readiness with `npm run verify` script (`tsc`, Android module compile, package dry-run).
+- Added lightweight GitHub Actions CI workflow for package checks.
+- Expanded docs with richer usage and troubleshooting guides.
+- Tightened package publish surface to keep tarballs clean and focused.
+
+## 1.0.0
+
+- Added Android/iOS navigation module API with route, camera, style, and simulation options.
+- Added event listeners for location, route progress, banner instructions, arrival, cancel, and errors.
+- Added Android config plugin automation for repository/token wiring and required permissions.
+- Added iOS config plugin defaults for location usage strings and background modes.
+- Added runtime JS validation for coordinates in `startNavigation`.
+- Added updated package docs (`README.md`, `QUICKSTART.md`) for developer onboarding.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ATOMIQ 
+
+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/QUICKSTART.md

@@ -0,0 +1,46 @@
+# Quick Start
+
+## 1. Install
+
+```bash
+npm install @atomiqlab/react-native-mapbox-navigation
+npx expo install expo-build-properties
+```
+
+## 2. Configure plugin
+
+In `app.json` / `app.config.js`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      "@atomiqlab/react-native-mapbox-navigation"
+    ]
+  }
+}
+```
+
+## 3. Set tokens
+
+- Public token: `EXPO_PUBLIC_MAPBOX_ACCESS_TOKEN=pk...`
+- Downloads token: `MAPBOX_DOWNLOADS_TOKEN=sk...` (`DOWNLOADS:READ` required)
+
+## 4. Regenerate native projects
+
+```bash
+npx expo prebuild --clean
+```
+
+## 5. Start navigation
+
+```ts
+import { startNavigation } from '@atomiqlab/react-native-mapbox-navigation';
+
+await startNavigation({
+  destination: { latitude: 37.7847, longitude: -122.4073, name: 'Downtown' },
+  startOrigin: { latitude: 37.7749, longitude: -122.4194 },
+  shouldSimulateRoute: true,
+  cameraMode: 'following',
+});
+```

package/README.md

@@ -0,0 +1,131 @@
+# @atomiqlab/react-native-mapbox-navigation
+
+Native Mapbox turn-by-turn navigation bridge for Expo / React Native (iOS + Android).
+
+## Highlights
+
+- Full-screen native navigation (`startNavigation`).
+- Embedded native navigation (`MapboxNavigationView`).
+- Event stream: location, route progress, banner instruction, arrival, cancel, error.
+- Flexible camera/theme/style controls.
+- Expo config plugin for Android + iOS setup defaults.
+
+## Installation
+
+```bash
+npm install @atomiqlab/react-native-mapbox-navigation
+npx expo install expo-build-properties
+```
+
+## Expo Config
+
+Add plugin in app config:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      "@atomiqlab/react-native-mapbox-navigation"
+    ]
+  }
+}
+```
+
+### Required tokens
+
+- `EXPO_PUBLIC_MAPBOX_ACCESS_TOKEN`: Mapbox public token (`pk...`)
+- `MAPBOX_DOWNLOADS_TOKEN`: Mapbox downloads token (`sk...`) with `DOWNLOADS:READ`
+
+Then regenerate native projects:
+
+```bash
+npx expo prebuild --clean
+```
+
+## Quick Usage
+
+```ts
+import {
+  startNavigation,
+  stopNavigation,
+  addLocationChangeListener,
+  addRouteProgressChangeListener,
+  addBannerInstructionListener,
+  addArriveListener,
+  addCancelNavigationListener,
+  addErrorListener,
+} from "@atomiqlab/react-native-mapbox-navigation";
+
+await startNavigation({
+  destination: { latitude: 37.7847, longitude: -122.4073, name: "Downtown" },
+  startOrigin: { latitude: 37.7749, longitude: -122.4194 },
+  shouldSimulateRoute: true,
+  cameraMode: "following",
+  uiTheme: "system",
+});
+
+const subs = [
+  addLocationChangeListener((location) => console.log(location)),
+  addRouteProgressChangeListener((progress) => console.log(progress)),
+  addBannerInstructionListener((instruction) => console.log(instruction.primaryText)),
+  addArriveListener((arrival) => console.log(arrival)),
+  addCancelNavigationListener(() => console.log("cancelled")),
+  addErrorListener((error) => console.warn(error)),
+];
+
+// Cleanup
+subs.forEach((sub) => sub.remove());
+await stopNavigation();
+```
+
+## Embedded View
+
+```tsx
+import { MapboxNavigationView } from "@atomiqlab/react-native-mapbox-navigation";
+
+<MapboxNavigationView
+  style={{ flex: 1 }}
+  destination={{ latitude: 37.7847, longitude: -122.4073, name: "Downtown" }}
+  startOrigin={{ latitude: 37.7749, longitude: -122.4194 }}
+  shouldSimulateRoute
+  cameraMode="following"
+  onBannerInstruction={(instruction) => console.log(instruction.primaryText)}
+/>;
+```
+
+## API Surface
+
+### Core functions
+
+- `startNavigation(options)`
+- `stopNavigation()`
+- `isNavigating()`
+- `getNavigationSettings()`
+- `setMuted(muted)`
+- `setVoiceVolume(volume)`
+- `setDistanceUnit(unit)`
+- `setLanguage(language)`
+
+### Listener helpers
+
+- `addLocationChangeListener(listener)`
+- `addRouteProgressChangeListener(listener)`
+- `addBannerInstructionListener(listener)`
+- `addArriveListener(listener)`
+- `addCancelNavigationListener(listener)`
+- `addErrorListener(listener)`
+
+### Key navigation options
+
+- Routing: `destination`, `startOrigin`, `waypoints`, `routeAlternatives`, `shouldSimulateRoute`
+- Camera: `cameraMode`, `cameraPitch`, `cameraZoom`
+- Theme/style: `uiTheme`, `mapStyleUri`, `mapStyleUriDay`, `mapStyleUriNight`
+- Guidance/UI: `distanceUnit`, `language`, `mute`, `voiceVolume`
+- Visibility toggles: `showsSpeedLimits`, `showsWayNameLabel`, `showsTripProgress`, `showsManeuverView`, `showsActionButtons`
+
+Full type reference: `src/MapboxNavigation.types.ts`
+
+## Platform behavior
+
+- Android: `startOrigin` optional; current location start is supported.
+- iOS: `startOrigin` optional; when omitted, the module resolves current device location (requires location permission).

package/android/build.gradle

@@ -0,0 +1,64 @@
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+group = 'expo.modules.mapboxnavigation'
+version = '1.1.0'
+
+def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
+apply from: expoModulesCorePlugin
+applyKotlinExpoModulesCorePlugin()
+
+def mapboxNavigationVersion = "2.21.0"
+def mapboxDownloadsToken = (project.findProperty("MAPBOX_DOWNLOADS_TOKEN") ?: System.getenv("MAPBOX_DOWNLOADS_TOKEN") ?: "")
+  .toString()
+  .replace('"', '')
+  .trim()
+
+android {
+  compileSdkVersion 35
+
+  defaultConfig {
+    minSdkVersion 24
+    targetSdkVersion 35
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_17
+    targetCompatibility JavaVersion.VERSION_17
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  kotlinOptions {
+    jvmTarget = '17'
+  }
+}
+
+repositories {
+  mavenCentral()
+  maven {
+    url 'https://api.mapbox.com/downloads/v2/releases/maven'
+    authentication {
+      basic(BasicAuthentication)
+    }
+    credentials {
+      username = "mapbox"
+      password = mapboxDownloadsToken
+    }
+  }
+}
+
+dependencies {
+  implementation project(':expo-modules-core')
+  implementation "org.jetbrains.kotlin:kotlin-stdlib"
+  implementation "androidx.activity:activity-ktx:1.8.2"
+  implementation "androidx.appcompat:appcompat:1.7.0"
+  
+  // Mapbox Navigation SDK (NDK 27 artifacts for better native compatibility).
+  // Mapbox docs recommend -ndk27 variants when 16 KB page-size support is needed.
+  implementation "com.mapbox.navigation:ui-dropin-ndk27:$mapboxNavigationVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,8 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="expo.modules.mapboxnavigation">
+  <application>
+    <activity
+      android:name="expo.modules.mapboxnavigation.MapboxNavigationActivity"
+      android:exported="false"
+      android:theme="@style/Theme.AppCompat.Light.NoActionBar" />
+  </application>
+</manifest>