@atomiqlab/react-native-mapbox-navigation 1.1.0

package/docs/TROUBLESHOOTING.md

@@ -0,0 +1,35 @@
+# Troubleshooting
+
+## Build Fails Downloading Mapbox Dependencies
+
+Check `MAPBOX_DOWNLOADS_TOKEN`:
+
+- It must be a secret `sk...` token.
+- It must include `DOWNLOADS:READ`.
+- It must be available to native build steps (`gradle` and `pod install`).
+
+## Navigation Does Not Start
+
+- Confirm destination coordinates are valid.
+- Confirm location permissions are granted.
+- Confirm `mapbox_access_token` resolves correctly in native resources/config.
+
+## iOS Starts in Preview-Like Camera
+
+- Use `cameraMode: "following"`.
+- Avoid forcing fixed camera behavior unless needed.
+- Keep SDK adaptive camera enabled for turn-by-turn behavior.
+
+## No Banner/Progress Events
+
+- Ensure listeners are registered before `startNavigation`.
+- Verify active guidance is started (especially with simulation settings).
+
+## Android Uses External Navigation App
+
+Current package behavior is native Mapbox navigation and should stay in-app.
+If not, verify you are running the latest package version and rebuilt native code:
+
+```bash
+npx expo prebuild --clean
+```

package/docs/USAGE.md

@@ -0,0 +1,100 @@
+# Usage Guide
+
+## Start Full-Screen 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,
+  routeAlternatives: true,
+  distanceUnit: "metric",
+  language: "en",
+  mute: false,
+  voiceVolume: 1,
+  cameraMode: "following",
+  cameraPitch: 45,
+  cameraZoom: 15,
+  uiTheme: "system",
+  mapStyleUriDay: "mapbox://styles/mapbox/navigation-day-v1",
+  mapStyleUriNight: "mapbox://styles/mapbox/navigation-night-v1",
+  showsSpeedLimits: true,
+  showsWayNameLabel: true,
+  showsTripProgress: true,
+  showsManeuverView: true,
+  showsActionButtons: true,
+});
+```
+
+## Stop Navigation
+
+```ts
+import { stopNavigation } from "@atomiqlab/react-native-mapbox-navigation";
+
+await stopNavigation();
+```
+
+## Listen to Events
+
+```ts
+import {
+  addLocationChangeListener,
+  addRouteProgressChangeListener,
+  addBannerInstructionListener,
+  addArriveListener,
+  addCancelNavigationListener,
+  addErrorListener,
+} from "@atomiqlab/react-native-mapbox-navigation";
+
+const subscriptions = [
+  addLocationChangeListener((location) => {
+    console.log("location", location.latitude, location.longitude);
+  }),
+  addRouteProgressChangeListener((progress) => {
+    console.log("progress", progress.fractionTraveled);
+  }),
+  addBannerInstructionListener((instruction) => {
+    console.log("banner", instruction.primaryText);
+  }),
+  addArriveListener((arrival) => {
+    console.log("arrive", arrival.name);
+  }),
+  addCancelNavigationListener(() => {
+    console.log("cancel");
+  }),
+  addErrorListener((error) => {
+    console.warn("navigation error", error.code, error.message);
+  }),
+];
+
+// cleanup
+subscriptions.forEach((sub) => sub.remove());
+```
+
+## Embedded Navigation View
+
+```tsx
+import { MapboxNavigationView } from "@atomiqlab/react-native-mapbox-navigation";
+
+export function EmbeddedNavigationScreen() {
+  return (
+    <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)}
+      onError={(error) => console.warn(error.message)}
+    />
+  );
+}
+```
+
+## Platform Notes
+
+- Android supports omitting `startOrigin` to start from current location.
+- iOS supports omitting `startOrigin`; current location is resolved at runtime (with permission).
+- Both platforms support embedded navigation view and camera/style customization.

package/expo-module.config.json

@@ -0,0 +1,9 @@
+{
+  "platforms": ["ios", "android"],
+  "ios": {
+    "modules": ["MapboxNavigationModule"]
+  },
+  "android": {
+    "modules": ["expo.modules.mapboxnavigation.MapboxNavigationModule"]
+  }
+}

package/ios/ExpoMapboxNavigationNative.podspec

@@ -0,0 +1,31 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
+
+Pod::Spec.new do |s|
+  # Must not collide with Mapbox's internal pod named "MapboxNavigationNative".
+  s.name           = 'ExpoMapboxNavigationNative'
+  s.version        = package['version']
+  s.summary        = 'Native Mapbox Navigation module for Expo'
+  s.description    = 'A custom Expo module that wraps the native Mapbox Navigation SDKs for iOS and Android.'
+  s.license        = { :type => 'MIT' }
+  s.author         = { 'author' => 'author@example.com' }
+  s.homepage       = 'https://github.com/yourusername/react-native-mapbox-navigation'
+  s.platform       = :ios, '14.0'
+  s.swift_version  = '5.4'
+  s.source         = { :git => 'https://github.com/yourusername/react-native-mapbox-navigation.git', :tag => s.version.to_s }
+  # Let CocoaPods choose linkage to avoid circular static-framework graphs
+  # with MapboxNavigation / MapboxCoreNavigation.
+  s.static_framework = false
+
+  s.dependency 'ExpoModulesCore'
+  s.dependency 'MapboxNavigation', '~> 2.19'
+
+  # Swift/Objective-C compatibility
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES',
+    'SWIFT_COMPILATION_MODE' => 'wholemodule'
+  }
+
+  s.source_files = "**/*.{h,m,mm,swift,hpp,cpp}"
+end