react-native-background-geolocation 5.1.1 → 5.3.0

package/README.md

@@ -57,8 +57,8 @@ See [`/example`](example/README.md) — example apps are included in this repo.
 | <img src="assets/images/platforms/flutter.svg" width="16" height="16"> [Flutter](https://github.com/transistorsoft/flutter_background_geolocation) | `flutter_background_geolocation` |
 | <img src="assets/images/platforms/capacitor.svg" width="16" height="16"> [Capacitor](https://github.com/transistorsoft/capacitor-background-geolocation) | `@transistorsoft/capacitor-background-geolocation` |
 | <img src="assets/images/platforms/cordova.svg" width="16" height="16"> [Cordova](https://github.com/transistorsoft/cordova-background-geolocation-lt) | `cordova-background-geolocation-lt` |
-| <img src="assets/images/platforms/swift.svg" width="16" height="16"> [Swift / iOS](https://github.com/transistorsoft/background-geolocation) | `background-geolocation` |
-| <img src="assets/images/platforms/kotlin.svg" width="16" height="16"> [Kotlin / Android](https://github.com/transistorsoft/background-geolocation) | `background-geolocation` |
+| <img src="assets/images/platforms/swift.svg" width="16" height="16"> [Swift / iOS](https://github.com/transistorsoft/native-background-geolocation) | `background-geolocation` |
+| <img src="assets/images/platforms/kotlin.svg" width="16" height="16"> [Kotlin / Android](https://github.com/transistorsoft/native-background-geolocation) | `background-geolocation` |
 
 ---
 

package/RNBackgroundGeolocation.podspec

@@ -26,7 +26,7 @@ Pod::Spec.new do |s|
   s.source_files        = 'ios/RNBackgroundGeolocation/*.{h,m,mm}'
   s.preserve_paths      = 'docs', 'CHANGELOG.md', 'LICENSE', 'package.json', 'RNBackgroundGeolocation.ios.js'
 
-  tslm_version = ENV['TSLOCATIONMANAGER_VERSION'] || '~> 4.1.0'
+  tslm_version = ENV['TSLOCATIONMANAGER_VERSION'] || '~> 4.3.0'
   s.dependency 'TSLocationManager', tslm_version
 
   s.libraries           = 'sqlite3', 'z', 'stdc++'

package/android/build.gradle

@@ -9,7 +9,7 @@ def DEFAULT_TARGET_SDK_VERSION                      = 35
 
 // Plugin dependencies
 def DEFAULT_PLAY_SERVICES_LOCATION_VERSION          = "21.3.0"
-def DEFAULT_TSLOCATIONMANAGER_VERSION               = "4.1.+"
+def DEFAULT_TSLOCATIONMANAGER_VERSION               = "4.3.+"
 def DEFAULT_OK_HTTP_VERSION                         = "4.12.0"
 def DEFAULT_ANDROID_PERMISSIONS_VERSION             = "2.1.6"
 def DEFAULT_EVENTBUS_VERSION                        = "3.3.1"
@@ -25,6 +25,38 @@ def safeExtGet(prop, fallback) {
     rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
 }
 
+// Guards against the missing-symbol crash that occurs when an app pins an `ext.tslocationmanagerVersion`
+// older than the SDK this plugin's bridge adapter was built against. Returns `minVersion` (with a
+// warning) when the pinned version's entire range is below it; otherwise returns the pin unchanged.
+// Dynamic pins are handled by comparing the pin's ceiling to the minimum's floor, so "4.2.+" is
+// overridden while "4.+"/"+" are respected. Drop-in identical across the four plugin SDKs.
+def ensureTSLocationManagerVersion(String configured, String minVersion) {
+    def parse = { String v, boolean asCeiling ->
+        def parts = (v ?: "").trim().tokenize(".")
+        def out = [0, 0, 0]
+        boolean wild = false
+        for (int i = 0; i < 3; i++) {
+            if (wild) { out[i] = asCeiling ? Integer.MAX_VALUE : 0; continue }
+            def p = (i < parts.size()) ? parts[i] : null
+            if (p != null && p.isInteger()) {
+                out[i] = p as int
+            } else if (p != null) {          // "+" wildcard or qualifier
+                wild = true
+                out[i] = asCeiling ? Integer.MAX_VALUE : 0
+            }                                // missing trailing component stays 0
+        }
+        return out
+    }
+    def c = parse(configured, true)          // ceiling of the app's pin
+    def f = parse(minVersion, false)         // floor of the required minimum
+    def cmp = (c[0] <=> f[0]) ?: (c[1] <=> f[1]) ?: (c[2] <=> f[2])
+    if (cmp < 0) {
+        println("[tslocationmanager] ⚠️  ext.tslocationmanagerVersion '${configured}' is older than the '${minVersion}' required by this plugin release and has been overridden to '${minVersion}'. The native bridge adapter references symbols added in '${minVersion}'; an older SDK causes missing-symbol build failures / runtime crashes. Update or remove ext.tslocationmanagerVersion in your root build.gradle to silence this warning.")
+        return minVersion
+    }
+    return configured
+}
+
 react {
     libraryName = "react-native-background-geolocation"
     codegenJavaPackageName = "com.transistorsoft.rnbackgroundgeolocation"
@@ -61,7 +93,7 @@ repositories{
 
 dependencies {
     def playServicesLocationVersion = safeExtGet('playServicesLocationVersion', safeExtGet('googlePlayServicesLocationVersion', DEFAULT_PLAY_SERVICES_LOCATION_VERSION))
-    def tslocationmanagerVersion = safeExtGet('tslocationmanagerVersion', DEFAULT_TSLOCATIONMANAGER_VERSION)
+    def tslocationmanagerVersion = ensureTSLocationManagerVersion(safeExtGet('tslocationmanagerVersion', DEFAULT_TSLOCATIONMANAGER_VERSION), DEFAULT_TSLOCATIONMANAGER_VERSION)
     implementation "com.facebook.react:react-native:${safeExtGet('reactNativeVersion', '+')}"
 
     def locationMajorVersion = playServicesLocationVersion.split('\\.')[0] as int

package/android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTask.java

@@ -62,6 +62,8 @@ public class HeadlessTask {
             params = event.getProviderChangeEvent().toMap();
         } else if (name.equals(EventName.ACTIVITYCHANGE)) {
             params = event.getActivityChangeEvent().toMap();
+        } else if (name.equals(EventName.LOCATIONFILTER)) {
+            params = event.getLocationFilterEvent().toMap();
         } else if (name.equals(EventName.SCHEDULE)) {
             params = config.toMap(false);
         } else if (name.equals(EventName.BOOT)) {

package/android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java

@@ -43,10 +43,12 @@ import com.transistorsoft.locationmanager.adapter.BackgroundGeolocation;
 import com.transistorsoft.locationmanager.adapter.callback.*;
 
 import com.transistorsoft.locationmanager.data.LocationModel;
+import com.transistorsoft.locationmanager.data.LocationQuery;
 
 import com.transistorsoft.locationmanager.data.SQLQuery;
 import com.transistorsoft.locationmanager.device.DeviceInfo;
 import com.transistorsoft.locationmanager.event.ActivityChangeEvent;
+import com.transistorsoft.locationmanager.event.LocationFilterEvent;
 import com.transistorsoft.locationmanager.event.AuthorizationEvent;
 import com.transistorsoft.locationmanager.event.ConnectivityChangeEvent;
 import com.transistorsoft.locationmanager.event.GeofenceEvent;
@@ -118,6 +120,7 @@ public class RNBackgroundGeolocationModule
         mEvents.add(EventName.LOCATION);
         mEvents.add(EventName.MOTIONCHANGE);
         mEvents.add(EventName.ACTIVITYCHANGE);
+        mEvents.add(EventName.LOCATIONFILTER);
         mEvents.add(EventName.PROVIDERCHANGE);
         mEvents.add(EventName.GEOFENCESCHANGE);
         mEvents.add(EventName.GEOFENCE);
@@ -146,6 +149,7 @@ public class RNBackgroundGeolocationModule
         adapter.onLocation(new LocationCallback());
         adapter.onMotionChange(new MotionChangeCallback());
         adapter.onActivityChange(new ActivityChangeCallback());
+        adapter.onLocationFilter(new LocationFilterCallback());
         adapter.onLocationProviderChange(new LocationProviderChangeCallback());
         adapter.onGeofencesChange(new GeofencesChangeCallback());
         adapter.onGeofence(new GeofenceCallback());
@@ -199,6 +203,15 @@ public class RNBackgroundGeolocationModule
         }
     }
 
+    /**
+     * locationfilter event callback
+     */
+    private class LocationFilterCallback implements TSLocationFilterCallback {
+        @Override public void onLocationFilter(LocationFilterEvent event) {
+            sendEvent(EventName.LOCATIONFILTER, mapToWritableMap(event.toMap()));
+        }
+    }
+
     /**
      * providerchange event callback
      */
@@ -477,8 +490,9 @@ public class RNBackgroundGeolocationModule
     }
 
     @ReactMethod
-    public void getLocations(final Promise response) {
-        getAdapter().getLocations(new TSGetLocationsCallback() {
+    public void getLocations(ReadableMap params, final Promise response) {
+        LocationQuery query = LocationQuery.fromMap(params != null ? params.toHashMap() : null);
+        getAdapter().getLocations(query, new TSGetLocationsCallback() {
             @Override public void onSuccess(List<LocationModel> records) {
                 try {
                     JSONArray data = new JSONArray();

package/ios/RNBackgroundGeolocation/RNBackgroundGeolocation.mm

@@ -30,6 +30,7 @@ static NSString *const EVENT_WATCHPOSITION      = @"watchposition";
 static NSString *const EVENT_PROVIDERCHANGE     = @"providerchange";
 static NSString *const EVENT_MOTIONCHANGE       = @"motionchange";
 static NSString *const EVENT_ACTIVITYCHANGE     = @"activitychange";
+static NSString *const EVENT_LOCATIONFILTER     = @"locationfilter";
 static NSString *const EVENT_GEOFENCESCHANGE    = @"geofenceschange";
 static NSString *const EVENT_HTTP               = @"http";
 static NSString *const EVENT_SCHEDULE           = @"schedule";
@@ -89,6 +90,9 @@ RCT_EXPORT_MODULE();
         NSDictionary *params = @{@"activity": event.activity, @"confidence": @(event.confidence)};
         [me sendEvent:EVENT_ACTIVITYCHANGE body:params];
     }];
+    [locationManager onLocationFilter:^(TSLocationFilterEvent *event) {
+        [me sendEvent:EVENT_LOCATIONFILTER body:[event toDictionary]];
+    }];
     [locationManager onHeartbeat:^(TSHeartbeatEvent *event) {
         [me sendEvent:EVENT_HEARTBEAT body:[event toDictionary]];
     }];
@@ -131,6 +135,7 @@ RCT_EXPORT_MODULE();
         EVENT_PROVIDERCHANGE,
         EVENT_MOTIONCHANGE,
         EVENT_ACTIVITYCHANGE,
+        EVENT_LOCATIONFILTER,
         EVENT_GEOFENCESCHANGE,
         EVENT_POWERSAVECHANGE,
         EVENT_HTTP,
@@ -384,9 +389,10 @@ RCT_EXPORT_METHOD(stopWatchPosition:(NSInteger)watchId resolve:(RCTPromiseResolv
     resolve(@(YES));
 }
 
-RCT_EXPORT_METHOD(getLocations:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(getLocations:(NSDictionary*)params resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
 {
-    [locationManager getLocations:^(NSArray* records) {
+    LocationQuery *query = [[LocationQuery alloc] initWithDictionary:params];
+    [locationManager getLocations:query success:^(NSArray* records) {
         resolve(records);
     } failure:^(NSString* error) {
         reject(@"get_locations_error", error, nil);

package/package.json

@@ -1,7 +1,7 @@
 {
 
   "name": "react-native-background-geolocation",  
-  "version": "5.1.1",
+  "version": "5.3.0",
   "description": "The most sophisticated cross-platform background location-tracking & geofencing module with battery-conscious motion-detection intelligence",
   "scripts": {
     "build": "yarn run build:expo",
@@ -41,7 +41,7 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.26.0",
-    "@transistorsoft/background-geolocation-types": "^5.1.0",
+    "@transistorsoft/background-geolocation-types": "^5.2.0",
     "tslib": "^2.6.3"
   },
   "author": "Chris Scott <chris@transistorsoft.com>",

package/src/NativeModule.js

@@ -330,8 +330,8 @@ export default class NativeModule {
   * HTTP & Persistence Methods
   */
 
-  static getLocations() {    
-    return RNBackgroundGeolocation.getLocations();    
+  static getLocations(query) {
+    return RNBackgroundGeolocation.getLocations(query || {});
   }
 
   static getCount() {

package/src/index.js

@@ -89,6 +89,7 @@ export default class BackgroundGeolocation {
   static get EVENT_HEARTBEAT()             { return Event.Heartbeat; }
   static get EVENT_PROVIDERCHANGE()        { return Event.ProviderChange; }
   static get EVENT_ACTIVITYCHANGE()        { return Event.ActivityChange; }
+  static get EVENT_LOCATIONFILTER()        { return Event.LocationFilter; }
   static get EVENT_GEOFENCE()              { return Event.Geofence; }
   static get EVENT_GEOFENCESCHANGE()       { return Event.GeofencesChange; }
   static get EVENT_ENABLEDCHANGE()         { return Event.EnabledChange; }
@@ -275,6 +276,10 @@ export default class BackgroundGeolocation {
     return this.addListener(Event.ActivityChange, callback);
   }
 
+  static onLocationFilter(callback) {
+    return this.addListener(Event.LocationFilter, callback);
+  }
+
   static onGeofence(callback) {
     return this.addListener(Event.Geofence, callback);
   }
@@ -434,8 +439,8 @@ export default class BackgroundGeolocation {
   * HTTP & Persistence
   *
   */
-  static getLocations() {
-    return NativeModule.getLocations();
+  static getLocations(query) {
+    return NativeModule.getLocations(query);
   }
 
   /**

package/src/native/specs/NativeBackgroundGeolocation.ts

@@ -21,7 +21,7 @@ export interface Spec extends TurboModule {
   setOdometer(value: number): Promise<Object>;
 
   // HTTP & DB
-  getLocations(): Promise<Array<Object>>;
+  getLocations(query: Object): Promise<Array<Object>>;
   getCount(): Promise<number>;
   destroyLocations(): Promise<void>;
   sync(): Promise<Array<Object>>;

package/src/specs/NativeRNBackgroundGeolocation.js

@@ -28,7 +28,7 @@ export interface Spec extends TurboModule {
   +getState: () => Promise<Object>;
 
   // Locations / persistence
-  +getLocations: () => Promise<Array<Object>>;
+  +getLocations: (query: Object) => Promise<Array<Object>>;
   +getCount: () => Promise<Int32>;
   +insertLocation: (params: Object) => Promise<string>;
 

package/tests/location-filter-event.test.js

@@ -0,0 +1,30 @@
+jest.mock('../src/NativeModule', () => ({
+  addListener: jest.fn(() => ({ remove: jest.fn() })),
+}));
+
+const NativeModule = require('../src/NativeModule');
+const BG = require('../src/index.js').default;
+const Shared = require('@transistorsoft/background-geolocation-types');
+
+// onLocationFilter event wiring (issue #2585).
+test('exposes the locationfilter event name + subscription method', () => {
+  // Shared enum carries the new event name.
+  expect(Shared.Event.LocationFilter).toBe('locationfilter');
+
+  // Backward-compat static getter mirrors the shared enum.
+  expect(BG.EVENT_LOCATIONFILTER).toBe('locationfilter');
+
+  // Subscription method is exposed.
+  expect(typeof BG.onLocationFilter).toBe('function');
+});
+
+test('onLocationFilter routes through the native bridge with the locationfilter event', () => {
+  NativeModule.addListener.mockClear();
+  const cb = jest.fn();
+
+  const subscription = BG.onLocationFilter(cb);
+
+  expect(NativeModule.addListener).toHaveBeenCalledWith('locationfilter', cb);
+  expect(subscription).toBeDefined();
+  expect(typeof subscription.remove).toBe('function');
+});