@maplibre/maplibre-react-native 11.0.0-alpha.12 → 11.0.0-alpha.14

package/src/modules/location/LocationManager.ts

@@ -1,160 +1,153 @@
 import {
-  NativeModules,
-  NativeEventEmitter,
-  type EmitterSubscription,
+  type EventSubscription,
+  type Permission,
+  PermissionsAndroid,
 } from "react-native";
 
-const MLRNModule = NativeModules.MLRNModule;
-const MLRNLocationModule = NativeModules.MLRNLocationModule;
+import NativeLocationModule from "./NativeLocationModule";
+import { isAndroid } from "../../utils";
 
-export const LocationModuleEventEmitter = new NativeEventEmitter(
-  MLRNLocationModule,
-);
-
-/*
- * Location sent by LocationManager
- */
-export interface Location {
-  coords: Coordinates;
-  timestamp?: number;
-}
-
-/*
- * Coordinates sent by LocationManager
- */
-interface Coordinates {
-  /*
-   * The heading (measured in degrees) relative to true north.
-   * Heading is used to describe the direction the device is pointing to (the value of the compass).
-   * Note that on Android this is incorrectly reporting the course value as mentioned in issue https://github.com/rnmapbox/maps/issues/1213
-   * and will be corrected in a future update.
+interface GeolocationCoordinates {
+  /**
+   * Longitude in degrees
    */
-  heading?: number;
+  longitude: number;
 
-  /*
-   * The direction in which the device is traveling, measured in degrees and relative to due north.
-   * The course refers to the direction the device is actually moving (not the same as heading).
+  /**
+   * Latitude in degrees
    */
-  course?: number;
+  latitude: number;
 
-  /*
-   * The instantaneous speed of the device, measured in meters per second.
+  /**
+   * Accuracy for longitude/latitude in meters
    */
-  speed?: number;
+  accuracy: number;
 
-  /*
-   * The latitude in degrees.
+  /**
+   * Altitude in meters
    */
-  latitude: number;
+  altitude: number;
 
-  /*
-   * The longitude in degrees.
+  /**
+   * Accuracy for altitude in meters
    */
-  longitude: number;
+  altitudeAccuracy: number | null;
 
-  /*
-   * The radius of uncertainty for the location, measured in meters.
+  /**
+   * Direction in which the device is traveling in degrees, relative to north
    */
-  accuracy?: number;
+  heading: number;
 
-  /*
-   * The altitude, measured in meters.
+  /**
+   * Instantaneous speed of the device in meters per second
    */
-  altitude?: number;
+  speed: number;
+}
+
+export interface GeolocationPosition {
+  coords: GeolocationCoordinates;
+
+  timestamp: number;
 }
 
 class LocationManager {
-  _listeners: ((location: Location) => void)[];
-  _lastKnownLocation: Location | null;
-  _isListening: boolean;
-  subscription: EmitterSubscription | null;
+  private listeners: ((location: GeolocationPosition) => void)[] = [];
+  private currentPosition: GeolocationPosition | undefined = undefined;
+  private isListening: boolean = false;
+
+  private subscription: EventSubscription | undefined = undefined;
 
   constructor() {
-    this._listeners = [];
-    this._lastKnownLocation = null;
-    this._isListening = false;
-    this.onUpdate = this.onUpdate.bind(this);
-    this.subscription = null;
+    this.handleUpdate = this.handleUpdate.bind(this);
   }
 
-  async getLastKnownLocation(): Promise<Location | null> {
-    if (!this._lastKnownLocation) {
-      let lastKnownLocation;
-
-      // as location can be brittle it might happen,
-      // that we get an exception from native land
-      // let's silently catch it and simply log out
-      // instead of throwing an exception
-      try {
-        lastKnownLocation = await MLRNLocationModule.getLastKnownLocation();
-      } catch (error) {
-        console.log("LocationManager Error: ", error);
-      }
+  async getCurrentPosition(): Promise<GeolocationPosition | undefined> {
+    let currentPosition;
 
-      if (!this._lastKnownLocation && lastKnownLocation) {
-        this._lastKnownLocation = lastKnownLocation;
-      }
+    try {
+      currentPosition = await NativeLocationModule.getCurrentPosition();
+    } catch (error) {
+      console.log("LocationManager [error]: ", error);
     }
 
-    return this._lastKnownLocation;
+    this.currentPosition = currentPosition;
+
+    return this.currentPosition;
   }
 
-  addListener(listener: (location: Location) => void): void {
-    if (!this._isListening) {
+  addListener(newListener: (location: GeolocationPosition) => void): void {
+    if (!this.isListening) {
       this.start();
     }
-    if (!this._listeners.includes(listener)) {
-      this._listeners.push(listener);
 
-      if (this._lastKnownLocation) {
-        listener(this._lastKnownLocation);
+    if (!this.listeners.includes(newListener)) {
+      this.listeners.push(newListener);
+
+      if (this.currentPosition) {
+        newListener(this.currentPosition);
       }
     }
   }
 
-  removeListener(listener: (location: Location) => void): void {
-    this._listeners = this._listeners.filter((l) => l !== listener);
-    if (this._listeners.length === 0) {
+  removeListener(oldListener: (location: GeolocationPosition) => void): void {
+    this.listeners = this.listeners.filter(
+      (listener) => listener !== oldListener,
+    );
+
+    if (this.listeners.length === 0) {
       this.stop();
     }
   }
 
   removeAllListeners(): void {
-    this._listeners = [];
+    this.listeners = [];
+
     this.stop();
   }
 
-  start(displacement = 0): void {
-    if (!this._isListening) {
-      MLRNLocationModule.start(displacement);
+  start(): void {
+    if (!this.isListening) {
+      NativeLocationModule.start();
 
-      this.subscription = LocationModuleEventEmitter.addListener(
-        MLRNModule.LocationCallbackName.Update,
-        this.onUpdate,
-      );
+      this.subscription = NativeLocationModule.onUpdate(this.handleUpdate);
 
-      this._isListening = true;
+      this.isListening = true;
     }
   }
 
   stop(): void {
-    MLRNLocationModule.stop();
+    NativeLocationModule.stop();
 
-    if (this._isListening) {
+    if (this.isListening) {
       this.subscription?.remove();
     }
 
-    this._isListening = false;
+    this.isListening = false;
   }
 
   setMinDisplacement(minDisplacement: number): void {
-    MLRNLocationModule.setMinDisplacement(minDisplacement);
+    NativeLocationModule.setMinDisplacement(minDisplacement);
   }
 
-  onUpdate(location: Location): void {
-    this._lastKnownLocation = location;
+  private handleUpdate(location: GeolocationPosition): void {
+    this.currentPosition = location;
+
+    this.listeners.forEach((listener) => listener(location));
+  }
+
+  async requestAndroidPermissions(): Promise<boolean> {
+    if (isAndroid()) {
+      const res = await PermissionsAndroid.requestMultiple([
+        PermissionsAndroid.PERMISSIONS.ACCESS_FINE_LOCATION as Permission,
+        PermissionsAndroid.PERMISSIONS.ACCESS_COARSE_LOCATION as Permission,
+      ]);
+
+      return Object.values(res).every(
+        (permission) => permission === PermissionsAndroid.RESULTS.GRANTED,
+      );
+    }
 
-    this._listeners.forEach((l) => l(location));
+    throw new Error("This method should only be called on Android");
   }
 }
 

package/src/modules/location/NativeLocationModule.ts

@@ -0,0 +1,31 @@
+import type { TurboModule, CodegenTypes } from "react-native";
+import { TurboModuleRegistry } from "react-native";
+
+type NativeGeolocationCoordinates = {
+  longitude: CodegenTypes.Double;
+  latitude: CodegenTypes.Double;
+  accuracy: CodegenTypes.Double;
+  altitude: CodegenTypes.Double;
+  altitudeAccuracy: CodegenTypes.Double | null;
+  heading: CodegenTypes.Double;
+  speed: CodegenTypes.Double;
+};
+
+type NativeGeolocationPosition = {
+  coords: NativeGeolocationCoordinates;
+  timestamp: number;
+};
+
+export interface Spec extends TurboModule {
+  start(): void;
+
+  stop(): void;
+
+  getCurrentPosition(): Promise<NativeGeolocationPosition>;
+
+  setMinDisplacement(minDisplacement: number): void;
+
+  readonly onUpdate: CodegenTypes.EventEmitter<NativeGeolocationPosition>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>("MLRNLocationModule");

package/src/modules/location/requestAndroidLocationPermissions.ts

@@ -0,0 +1,8 @@
+import { LocationManager } from "./LocationManager";
+
+/**
+ * @deprected Use `LocationManager.requestAndroidPermissions` instead
+ */
+export async function requestAndroidLocationPermissions(): Promise<boolean> {
+  return LocationManager.requestAndroidPermissions();
+}

package/android/src/main/java/org/maplibre/reactnative/events/LocationEvent.java

@@ -1,100 +0,0 @@
-package org.maplibre.reactnative.events;
-
-import android.location.Location;
-import androidx.annotation.NonNull;
-
-import com.facebook.react.bridge.Arguments;
-import com.facebook.react.bridge.WritableMap;
-import com.facebook.react.bridge.WritableNativeMap;
-import org.maplibre.reactnative.components.mapview.MLRNMapView;
-import org.maplibre.reactnative.events.constants.EventKeys;
-import org.maplibre.reactnative.events.constants.EventTypes;
-
-import java.util.UUID;
-
-public class LocationEvent implements IEvent {
-    private UUID uuid;
-    private MLRNMapView mapView;
-    private Location location;
-
-    public LocationEvent(@NonNull Location location, MLRNMapView mapView) {
-        this.mapView = mapView;
-        this.location = location;
-        this.uuid = UUID.randomUUID();
-    }
-
-    public LocationEvent(Location location) {
-        this(location, null);
-    }
-
-    @Override
-    public int getID() {
-        if (mapView != null) {
-            return mapView.getId();
-        }
-        return -1;
-    }
-
-    public UUID getUUID() {
-        return uuid;
-    }
-
-    @Override
-    public String getKey() {
-        return EventKeys.USER_LOCATION_UPDATE;
-    }
-
-    @Override
-    public String getType() {
-        return EventTypes.USER_LOCATION_UPDATED;
-    }
-
-    @Override
-    public long getTimestamp() {
-        return System.currentTimeMillis();
-    }
-
-    @Override
-    public boolean equals(IEvent event) {
-        LocationEvent other = (LocationEvent) event;
-        return getUUID().equals(other.getUUID());
-    }
-
-    public boolean equals(LocationEvent event) {
-        return uuid.equals(event.getUUID());
-    }
-
-    @Override
-    public WritableMap getPayload() {
-        WritableMap positionProperties = new WritableNativeMap();
-        WritableMap coords = new WritableNativeMap();
-
-        coords.putDouble("longitude", location.getLongitude());
-        coords.putDouble("latitude", location.getLatitude());
-        coords.putDouble("altitude", location.getAltitude());
-        coords.putDouble("accuracy", location.getAccuracy());
-        // A better solution will be to pull the heading from the compass engine, 
-        // unfortunately the api is not publicly available in the mapbox sdk
-        coords.putDouble("heading", location.getBearing());
-        coords.putDouble("course", location.getBearing());
-        coords.putDouble("speed", location.getSpeed());
-
-        positionProperties.putMap("coords", coords);
-        positionProperties.putDouble("timestamp", location.getTime());
-
-        return positionProperties;
-    }
-
-    @Override
-    public WritableMap toJSON() {
-        WritableMap map = Arguments.createMap();
-        map.putString("type", getType());
-        map.putMap("payload", getPayload());
-        return map;
-    }
-
-    @Override
-    public boolean canCoalesce() {
-        return true;
-    }
-}

package/android/src/main/java/org/maplibre/reactnative/events/TrackUserLocationChangeEvent.kt

@@ -1,24 +0,0 @@
-package org.maplibre.reactnative.events
-
-import android.view.View
-import com.facebook.react.bridge.Arguments
-import com.facebook.react.bridge.WritableMap
-import com.facebook.react.uimanager.events.Event
-import org.maplibre.reactnative.events.constants.EventKeys
-import org.maplibre.reactnative.events.constants.EventTypes
-import org.maplibre.reactnative.location.TrackUserLocationMode
-
-class TrackUserLocationChangeEvent(
-    surfaceId: Int,
-    viewId: Int,
-    private val trackUserLocationMode: Int
-) :
-    Event<TrackUserLocationChangeEvent>(surfaceId, viewId) {
-    override fun getEventName() = "onTrackUserLocationChange"
-
-    override fun getEventData(): WritableMap? {
-        return Arguments.createMap().apply {
-            putString("trackUserLocation", TrackUserLocationMode.toString(trackUserLocationMode))
-        }
-    }
-}

package/android/src/main/java/org/maplibre/reactnative/location/LocationManager.java

@@ -1,160 +0,0 @@
-package org.maplibre.reactnative.location;
-
-import android.content.Context;
-import android.location.Location;
-import android.os.Looper;
-import android.util.Log;
-
-import org.maplibre.android.location.engine.LocationEngine;
-import org.maplibre.android.location.engine.LocationEngineCallback;
-import org.maplibre.android.location.engine.LocationEngineRequest;
-import org.maplibre.android.location.engine.LocationEngineResult;
-import org.maplibre.android.location.permissions.PermissionsManager;
-import org.maplibre.reactnative.location.engine.LocationEngineProvider;
-
-import java.lang.ref.WeakReference;
-import java.util.ArrayList;
-import java.util.List;
-
-@SuppressWarnings({"MissingPermission"})
-public class LocationManager implements LocationEngineCallback<LocationEngineResult> {
-    static final long DEFAULT_FASTEST_INTERVAL_MILLIS = 1000;
-    static final long DEFAULT_INTERVAL_MILLIS = 1000;
-
-    public static final String LOG_TAG = "LocationManager";
-
-    private LocationEngine locationEngine;
-    private Context context;
-    private List<OnUserLocationChange> listeners = new ArrayList<>();
-
-    private float mMinDisplacement = 0;
-    private boolean isActive = false;
-    private Location lastLocation = null;
-
-    private LocationEngineRequest locationEngineRequest = null;
-
-    private static WeakReference<LocationManager> INSTANCE = null;
-
-    public static LocationManager getInstance(Context context) {
-        if (INSTANCE == null) {
-            INSTANCE = new WeakReference<>(new LocationManager(context));
-        }
-        return INSTANCE.get();
-    }
-
-    public interface OnUserLocationChange {
-        void onLocationChange(Location location);
-    }
-
-    private LocationManager(Context context) {
-        this.context = context;
-        this.buildEngineRequest();
-
-    }
-
-    private void buildEngineRequest() {
-        locationEngine = new LocationEngineProvider().getLocationEngine(context);
-
-        locationEngineRequest = new LocationEngineRequest.Builder(DEFAULT_INTERVAL_MILLIS)
-                .setFastestInterval(DEFAULT_FASTEST_INTERVAL_MILLIS)
-                .setPriority(LocationEngineRequest.PRIORITY_HIGH_ACCURACY)
-                .setDisplacement(mMinDisplacement)
-                .build();
-    }
-
-    public void addLocationListener(OnUserLocationChange listener) {
-        if (!listeners.contains(listener)) {
-            listeners.add(listener);
-        }
-    }
-
-    public void removeLocationListener(OnUserLocationChange listener) {
-        if (listeners.contains(listener)) {
-            listeners.remove(listener);
-        }
-    }
-
-    public void setMinDisplacement(float minDisplacement) {
-        mMinDisplacement = minDisplacement;
-    }
-
-    public void enable() {
-        if (!PermissionsManager.areLocationPermissionsGranted(context)) {
-            return;
-        }
-
-        // remove existing listeners
-        locationEngine.removeLocationUpdates(this);
-
-        // refresh location engine request with new values
-        this.buildEngineRequest();
-
-        // add new listeners
-        locationEngine.requestLocationUpdates(
-                locationEngineRequest,
-                this,
-                Looper.getMainLooper()
-        );
-        isActive = true;
-    }
-
-
-    public void disable() {
-        locationEngine.removeLocationUpdates(this);
-        isActive = false;
-    }
-
-    public void dispose() {
-        if (locationEngine == null) {
-            return;
-        }
-        disable();
-        locationEngine.removeLocationUpdates(this);
-    }
-
-    public boolean isActive() {
-        return locationEngine != null && this.isActive;
-    }
-
-    public Location getLastKnownLocation() {
-        if (locationEngine == null) {
-            return null;
-        }
-        return lastLocation;
-    }
-
-
-    public void getLastKnownLocation(LocationEngineCallback<LocationEngineResult> callback) {
-        if (locationEngine == null) {
-            callback.onFailure(new Exception("LocationEngine not initialized"));
-        }
-
-        try {
-            locationEngine.getLastLocation(callback);
-        } catch (Exception exception) {
-            Log.w(LOG_TAG, exception);
-            callback.onFailure(exception);
-        }
-    }
-
-    public LocationEngine getEngine() {
-        return locationEngine;
-    }
-
-    public void onLocationChanged(Location location) {
-        lastLocation = location;
-        for (OnUserLocationChange listener : listeners) {
-            listener.onLocationChange(location);
-        }
-    }
-
-    @Override
-    public void onFailure(Exception exception) {
-        // TODO handle this.
-    }
-
-    @Override
-    public void onSuccess(LocationEngineResult result) {
-        onLocationChanged(result.getLastLocation());
-    }
-}

package/android/src/main/java/org/maplibre/reactnative/location/TrackUserLocationState.java

@@ -1,15 +0,0 @@
-package org.maplibre.reactnative.location;
-
-public class TrackUserLocationState {
-    // The map view not yet tracked the user location
-    public static final int POSSIBLE = 0;
-
-    // The map view has begun to move to the first user location
-    public static final int BEGAN = 1;
-
-    // The map views begins a significant transition
-    public static final int SIGNIFICANT_TRANSITION = 2;
-
-    // The map view has finished moving to the user location
-    public static final int CHANGED = 3;
-}

package/android/src/main/java/org/maplibre/reactnative/location/UserLocation.java

@@ -1,59 +0,0 @@
-package org.maplibre.reactnative.location;
-
-import android.location.Location;
-
-import org.maplibre.android.geometry.LatLng;
-
-public class UserLocation {
-    private Location currentLocation;
-    private Location previousLocation;
-
-    private int userTrackingMode = TrackUserLocationMode.NONE;
-
-    public UserLocation() {
-        this(null);
-    }
-
-    public UserLocation(Location currentLocation) {
-        this.currentLocation = currentLocation;
-    }
-
-    public Location getCurrentLocation() {
-        return currentLocation;
-    }
-
-    public double getBearing() {
-        if (currentLocation == null) {
-            return 0.0;
-        }
-        return currentLocation.getBearing();
-    }
-
-    public LatLng getCoordinate() {
-        if (currentLocation == null) {
-            return null;
-        }
-
-        return new LatLng(currentLocation.getLatitude(), currentLocation.getLongitude());
-    }
-
-    public void setCurrentLocation(Location currentLocation) {
-        this.previousLocation = this.currentLocation;
-        this.currentLocation = currentLocation;
-    }
-
-    public void setTrackingMode(int userTrackingMode) {
-        this.userTrackingMode = userTrackingMode;
-    }
-
-    public int getTrackingMode() {
-        return userTrackingMode;
-    }
-
-    public float getDistance(Location location) {
-        if (currentLocation == null) {
-            return 0.0f;
-        }
-        return currentLocation.distanceTo(location);
-    }
-}

package/android/src/main/java/org/maplibre/reactnative/location/engine/DefaultLocationEngineProvider.java

@@ -1,18 +0,0 @@
-package org.maplibre.reactnative.location.engine;
-
-import android.content.Context;
-import android.util.Log;
-
-import org.maplibre.android.location.engine.LocationEngine;
-import org.maplibre.android.location.engine.LocationEngineDefault;
-
-public class DefaultLocationEngineProvider implements LocationEngineProvidable {
-    private static final String LOG_TAG = "DefaultLocationEngineProvider";
-
-    @Override
-    public LocationEngine getLocationEngine(Context context) {
-        LocationEngine locationEngine = LocationEngineDefault.INSTANCE.getDefaultLocationEngine(context.getApplicationContext());
-        Log.d(LOG_TAG, "DefaultLocationEngine will be used.");
-        return locationEngine;
-    }
-}

package/android/src/main/java/org/maplibre/reactnative/location/engine/LocationEngineProvidable.java

@@ -1,9 +0,0 @@
-package org.maplibre.reactnative.location.engine;
-
-import android.content.Context;
-
-import org.maplibre.android.location.engine.LocationEngine;
-
-public interface LocationEngineProvidable {
-    LocationEngine getLocationEngine(Context context);
-}