@capgo/background-geolocation 7.0.8 → 7.0.10

package/README.md

@@ -9,48 +9,39 @@
 A Capacitor plugin that lets you receive geolocation updates even while the app is backgrounded.
 It has a web API to facilitate for a similar usage, but background geolocation is not supported in a regular browser, only in an app environment.
 
+## This plugin's history
+
+Interestingly enough, this plugin has a lot of history. The initial solution from [Transistorsoft](https://github.com/transistorsoft) was a great piece of software, and I encourage using it if it fits your needs.  
+I tried it and understood that it prioritizes battery life over accuracy, which wasn't the right fit for my hiking app.  
+There was a very good fork maintained by **mauron85** specifically for that use case, and I was happy to help maintain it.  
+But at some point, **mauron85** stopped responding to messages on GitHub, and no one could continue maintaining it.  
+I hope mauron85 is safe and sound somewhere.  
+
+So I created a fork and started maintaining it [here](https://github.com/HaylLtd/cordova-background-geolocation-plugin).  
+It served me well for over half a decade, but I felt it was hard to maintain due to all its history, features, and bug fixes.  
+I also felt like there was a barrier to introducing new features because of its complexity.
+
+So I started exploring what it would take to reduce that complexity—at the same time, I was envious of how small [`@capacitor-community/background-geolocation`](https://github.com/capacitor-community/background-geolocation) is.  
+I took the best of both worlds: tried to reduce the codebase in the original Cordova plugin and add some robustness to the Capacitor plugin.  
+
+That's how I ended up maintaining this one.  
+I hope you'll enjoy it!
+
+
 ## Usage
 
 ```javascript
 import { BackgroundGeolocation } from "@capgo/background-geolocation";
 
-// To start listening for changes in the device's location, add a new watcher.
-// You do this by calling 'addWatcher' with an options object and a callback. A
-// Promise is returned, which resolves to the callback ID used to remove the
-// watcher in the future. The callback will be called every time a new location
-// is available. Watchers can not be paused, only removed. Multiple watchers may
-// exist simultaneously.
-BackgroundGeolocation.addWatcher(
+BackgroundGeolocation.start(
     {
-        // If the "backgroundMessage" option is defined, the watcher will
-        // provide location updates whether the app is in the background or the
-        // foreground. If it is not defined, location updates are only
-        // guaranteed in the foreground. This is true on both platforms.
-
-        // On Android, a notification must be shown to continue receiving
-        // location updates in the background. This option specifies the text of
-        // that notification.
         backgroundMessage: "Cancel to prevent battery drain.",
-
-        // The title of the notification mentioned above. Defaults to "Using
-        // your location".
         backgroundTitle: "Tracking You.",
-        
-        // Whether permissions should be requested from the user automatically,
-        // if they are not already granted. Defaults to "true".
         requestPermissions: true,
-
-        // If "true", stale locations may be delivered while the device
-        // obtains a GPS fix. You are responsible for checking the "time"
-        // property. If "false", locations are guaranteed to be up to date.
-        // Defaults to "false".
         stale: false,
-
-        // The minimum number of metres between subsequent locations. Defaults
-        // to 0.
         distanceFilter: 50
     },
-    function callback(location, error) {
+    (location, error) => {
         if (error) {
             if (error.code === "NOT_AUTHORIZED") {
                 if (window.confirm(
@@ -67,56 +58,31 @@ BackgroundGeolocation.addWatcher(
             }
             return console.error(error);
         }
-
+        // in case of off-track for example, play a sound:
+        BackgroundGeolocation.playSound({soundFile: "assets/myFile.mp3" });
         return console.log(location);
     }
-).then(function after_the_watcher_has_been_added(watcher_id) {
-    // When a watcher is no longer needed, it should be removed by calling
-    // 'removeWatcher' with an object containing its ID.
-    BackgroundGeolocation.removeWatcher({
-        id: watcher_id
-    });
+).then(() => {
+    // When location updates are no longer needed, the plugin should be stopped by calling
+    BackgroundGeolocation.stop();
 });
 
-// The location object.
-{
-    // Longitude in degrees.
-    longitude: 131.723423719132,
-    // Latitude in degrees.
-    latitude: -22.40106297456,
-    // Radius of horizontal uncertainty in metres, with 68% confidence.
-    accuracy: 11,
-    // Metres above sea level (or null).
-    altitude: 65,
-    // Vertical uncertainty in metres, with 68% confidence (or null).
-    altitudeAccuracy: 4,
-    // Deviation from true north in degrees (or null).
-    bearing: 159.60000610351562,
-    // True if the location was simulated by software, rather than GPS.
-    simulated: false,
-    // Speed in metres per second (or null).
-    speed: 23.51068878173828,
-    // Time the location was produced, in milliseconds since the unix epoch.
-    time: 1562731602000
-}
-
 // If you just want the current location, try something like this. The longer
-// the timeout, the more accurate the guess will be. I wouldn't go below about
-// 100ms.
-function guess_location(callback, timeout) {
+// the timeout, the more accurate the guess will be. I wouldn't go below about 100ms.
+function guessLocation(callback, timeout) {
     let last_location;
-    BackgroundGeolocation.addWatcher(
+    BackgroundGeolocation.start(
         {
             requestPermissions: false,
             stale: true
         },
-        function (location) {
+        (location) => {
             last_location = location || undefined;
         }
-    ).then(function (id) {
-        setTimeout(function () {
+    ).then(() => {
+        setTimeout(() => {
             callback(last_location);
-            BackgroundGeolocation.removeWatcher({id});
+            BackgroundGeolocation.stop();
         }, timeout);
     });
 }
@@ -128,7 +94,7 @@ This plugin supports Capacitor v7:
 
 | Capacitor  | Plugin |
 |------------|--------|
-| v7         | v1     |
+| v7         | v7     |
 
 ```sh
 npm install @capgo/background-geolocation
@@ -208,9 +174,136 @@ Configration specific to Android can be made in `strings.xml`:
 
 <docgen-index>
 
-* [`addWatcher(...)`](#addwatcher)
-* [`removeWatcher(...)`](#removewatcher)
+* [`start(...)`](#start)
+* [`stop()`](#stop)
 * [`openSettings()`](#opensettings)
+* [`playSound(...)`](#playsound)
 * [Interfaces](#interfaces)
 
 </docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+Main plugin interface for background geolocation functionality.
+Provides methods to manage location updates and access device settings.
+
+### start(...)
+
+```typescript
+start(options: StartOptions, callback: (position?: Location | undefined, error?: CallbackError | undefined) => void) => Promise<void>
+```
+
+To start listening for changes in the device's location, call this method.
+A Promise is returned to indicate that it finished the call. The callback will be called every time a new location
+is available, or if there was an error when calling this method. Don't rely on promise rejection for this.
+
+| Param          | Type                                                                                                                      | Description                                                                       |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| **`options`**  | <code><a href="#startoptions">StartOptions</a></code>                                                                     | The configuration options                                                         |
+| **`callback`** | <code>(position?: <a href="#location">Location</a>, error?: <a href="#callbackerror">CallbackError</a>) =&gt; void</code> | The callback function invoked when a new location is available or an error occurs |
+
+**Since:** 7.0.9
+
+--------------------
+
+
+### stop()
+
+```typescript
+stop() => Promise<void>
+```
+
+Stops location updates.
+
+**Since:** 7.0.9
+
+--------------------
+
+
+### openSettings()
+
+```typescript
+openSettings() => Promise<void>
+```
+
+Opens the device's location settings page.
+Useful for directing users to enable location services or adjust permissions.
+
+**Since:** 7.0.0
+
+--------------------
+
+
+### playSound(...)
+
+```typescript
+playSound(options: PlaySoundOptions) => Promise<void>
+```
+
+Plays a sound file.
+This should be used to play a sound, in the background too.
+The idea behind this is to allow the user to hear a sound when a new location is available or when going off track.
+If you simply need to play a sound, you can use `@capgo/native-audio` plugin instead.
+For Android, there's a need to start monitoring location updates first, otherwise the sound will not play.
+
+| Param         | Type                                                          | Description                       |
+| ------------- | ------------------------------------------------------------- | --------------------------------- |
+| **`options`** | <code><a href="#playsoundoptions">PlaySoundOptions</a></code> | The options for playing the sound |
+
+**Since:** 7.0.10
+
+--------------------
+
+
+### Interfaces
+
+
+#### StartOptions
+
+The options for configuring for location updates.
+
+| Prop                     | Type                 | Description                                                                                                                                                                                                                                                                                                                                                                                                          | Default                            | Since |
+| ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----- |
+| **`backgroundMessage`**  | <code>string</code>  | If the "backgroundMessage" option is defined, the plugin will provide location updates whether the app is in the background or the foreground. If it is not defined, location updates are only guaranteed in the foreground. This is true on both platforms. On Android, a notification must be shown to continue receiving location updates in the background. This option specifies the text of that notification. |                                    | 7.0.9 |
+| **`backgroundTitle`**    | <code>string</code>  | The title of the notification mentioned above.                                                                                                                                                                                                                                                                                                                                                                       | <code>"Using your location"</code> | 7.0.9 |
+| **`requestPermissions`** | <code>boolean</code> | Whether permissions should be requested from the user automatically, if they are not already granted.                                                                                                                                                                                                                                                                                                                | <code>true</code>                  | 7.0.9 |
+| **`stale`**              | <code>boolean</code> | If "true", stale locations may be delivered while the device obtains a GPS fix. You are responsible for checking the "time" property. If "false", locations are guaranteed to be up to date.                                                                                                                                                                                                                         | <code>false</code>                 | 7.0.9 |
+| **`distanceFilter`**     | <code>number</code>  | The distance in meters that the device must move before a new location update is triggered. This is used to filter out small movements and reduce the number of updates.                                                                                                                                                                                                                                             | <code>0</code>                     | 7.0.9 |
+
+
+#### Location
+
+Represents a geographical location with various attributes.
+Contains all the standard location properties returned by GPS/network providers.
+
+| Prop                   | Type                        | Description                                                                                                                            | Since |
+| ---------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`latitude`**         | <code>number</code>         | Latitude in degrees. Range: -90.0 to +90.0                                                                                             | 7.0.0 |
+| **`longitude`**        | <code>number</code>         | Longitude in degrees. Range: -180.0 to +180.0                                                                                          | 7.0.0 |
+| **`accuracy`**         | <code>number</code>         | Radius of horizontal uncertainty in metres, with 68% confidence. Lower values indicate more accurate location.                         | 7.0.0 |
+| **`altitude`**         | <code>number \| null</code> | Metres above sea level (or null if not available).                                                                                     | 7.0.0 |
+| **`altitudeAccuracy`** | <code>number \| null</code> | Vertical uncertainty in metres, with 68% confidence (or null if not available).                                                        | 7.0.0 |
+| **`simulated`**        | <code>boolean</code>        | `true` if the location was simulated by software, rather than GPS. Useful for detecting mock locations in development or testing.      | 7.0.0 |
+| **`bearing`**          | <code>number \| null</code> | Deviation from true north in degrees (or null if not available). Range: 0.0 to 360.0                                                   | 7.0.0 |
+| **`speed`**            | <code>number \| null</code> | Speed in metres per second (or null if not available).                                                                                 | 7.0.0 |
+| **`time`**             | <code>number \| null</code> | Time the location was produced, in milliseconds since the unix epoch. Use this to check if a location is stale when using stale: true. | 7.0.0 |
+
+
+#### CallbackError
+
+Error object that may be passed to the location start callback.
+Extends the standard Error with optional error codes.
+
+| Prop       | Type                | Description                                           | Since |
+| ---------- | ------------------- | ----------------------------------------------------- | ----- |
+| **`code`** | <code>string</code> | Optional error code for more specific error handling. | 7.0.0 |
+
+
+#### PlaySoundOptions
+
+| Prop            | Type                | Description                                                                                                                                                                                             | Since  |
+| --------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
+| **`soundFile`** | <code>string</code> | The name of the sound file to play. Must be a valid sound relative path in the app's public folder to work for both web and native platforms. There's no need to include the public folder in the path. | 7.0.10 |
+
+</docgen-api>

package/android/src/main/java/com/capgo/capacitor_background_geolocation/BackgroundGeolocation.java

@@ -1,17 +1,14 @@
 package com.capgo.capacitor_background_geolocation;
 
 import android.Manifest;
-import android.app.Notification;
 import android.app.NotificationChannel;
 import android.app.NotificationManager;
-import android.app.PendingIntent;
 import android.content.BroadcastReceiver;
 import android.content.ComponentName;
 import android.content.Context;
 import android.content.Intent;
 import android.content.IntentFilter;
 import android.content.ServiceConnection;
-import android.graphics.Color;
 import android.location.Location;
 import android.location.LocationManager;
 import android.net.Uri;
@@ -68,7 +65,7 @@ public class BackgroundGeolocation extends Plugin {
   }
 
   @PluginMethod(returnType = PluginMethod.RETURN_CALLBACK)
-  public void addWatcher(final PluginCall call) {
+  public void start(final PluginCall call) {
     if (
       getPermissionState("location") != PermissionState.GRANTED &&
       !call.getBoolean("requestPermissions", true)
@@ -77,6 +74,11 @@ public class BackgroundGeolocation extends Plugin {
       return;
     }
 
+    if (serviceConnectionFuture != null) {
+      call.reject("Service already started", "ALREADY_STARTED");
+      return;
+    }
+
     if (
       getPermissionState("location") != PermissionState.GRANTED &&
       call.getBoolean("requestPermissions", true)
@@ -84,7 +86,7 @@ public class BackgroundGeolocation extends Plugin {
       call.setKeepAlive(true);
       requestLocationPermissions(call)
         .thenRun(() -> {
-          proceedWithWatcher(call);
+          proceedWithStart(call);
         })
         .exceptionally(throwable -> {
           call.reject("User denied location permission", "NOT_AUTHORIZED");
@@ -101,17 +103,18 @@ public class BackgroundGeolocation extends Plugin {
 
     // Everything is OK, continuing to adding a watcher
     call.setKeepAlive(true);
-    proceedWithWatcher(call);
+    proceedWithStart(call);
   }
 
-  private void proceedWithWatcher(PluginCall call) {
+  private void proceedWithStart(PluginCall call) {
     if (call.getBoolean("stale", false)) {
       fetchLastLocation(call);
     }
     getServiceConnection().thenAccept(serviceBinder -> {
-        serviceBinder.addWatcher(
+        serviceBinder.start(
           call.getCallbackId(),
-          createBackgroundNotification(call),
+          call.getString("backgroundTitle", "Using your location"),
+          call.getString("backgroundMessage", ""),
           call.getFloat("distanceFilter", 0f)
         );
       });
@@ -126,67 +129,6 @@ public class BackgroundGeolocation extends Plugin {
     return locationPermissionFuture;
   }
 
-  private Notification createBackgroundNotification(PluginCall call) {
-    String backgroundMessage = call.getString("backgroundMessage", "");
-
-    Notification.Builder builder = new Notification.Builder(getContext())
-      .setContentTitle(call.getString("backgroundTitle", "Using your location"))
-      .setContentText(backgroundMessage)
-      .setOngoing(true)
-      .setPriority(Notification.PRIORITY_HIGH)
-      .setWhen(System.currentTimeMillis());
-
-    try {
-      String name = getAppString(
-        "capacitor_background_geolocation_notification_icon",
-        "mipmap/ic_launcher"
-      );
-      String[] parts = name.split("/");
-      // It is actually necessary to set a valid icon for the notification to behave
-      // correctly when tapped. If there is no icon specified, tapping it will open the
-      // app's settings, rather than bringing the application to the foreground.
-      builder.setSmallIcon(getAppResourceIdentifier(parts[1], parts[0]));
-    } catch (Exception e) {
-      Logger.error("Could not set notification icon", e);
-    }
-
-    try {
-      String color = getAppString(
-        "capacitor_background_geolocation_notification_color",
-        null
-      );
-      if (color != null) {
-        builder.setColor(Color.parseColor(color));
-      }
-    } catch (Exception e) {
-      Logger.error("Could not set notification color", e);
-    }
-
-    Intent launchIntent = getContext()
-      .getPackageManager()
-      .getLaunchIntentForPackage(getContext().getPackageName());
-    if (launchIntent != null) {
-      launchIntent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
-      builder.setContentIntent(
-        PendingIntent.getActivity(
-          getContext(),
-          0,
-          launchIntent,
-          PendingIntent.FLAG_CANCEL_CURRENT | PendingIntent.FLAG_IMMUTABLE
-        )
-      );
-    }
-
-    // Set the Channel ID for Android O.
-    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
-      builder.setChannelId(
-        BackgroundGeolocationService.class.getPackage().getName()
-      );
-    }
-
-    return builder.build();
-  }
-
   @PermissionCallback
   private void locationPermissionsCallback(PluginCall call) {
     if (locationPermissionFuture == null) {
@@ -217,21 +159,19 @@ public class BackgroundGeolocation extends Plugin {
   }
 
   @PluginMethod
-  public void removeWatcher(PluginCall call) {
-    String callbackId = call.getString("id");
-    if (callbackId == null) {
-      call.reject("Missing id.");
-      return;
+  public void stop(PluginCall call) {
+    if (serviceConnectionFuture == null) {
+      call.resolve();
     }
-
     getServiceConnection()
       .thenAccept(service -> {
-        service.removeWatcher(callbackId);
+        var callbackId = service.stop();
         PluginCall savedCall = getBridge().getSavedCall(callbackId);
         if (savedCall != null) {
           savedCall.release(getBridge());
         }
         call.resolve();
+        serviceConnectionFuture = null;
       })
       .exceptionally(throwable -> {
         call.reject("Service connection failed: " + throwable.getMessage());
@@ -248,6 +188,31 @@ public class BackgroundGeolocation extends Plugin {
     call.resolve();
   }
 
+  @PluginMethod
+  public void playSound(PluginCall call) {
+    String soundFile = call.getString("soundFile");
+    if (soundFile == null || soundFile.isEmpty()) {
+      call.reject("Sound file is required");
+      return;
+    }
+    if (serviceConnectionFuture == null) {
+      call.reject(
+        "Service not started, make sure to call start() first",
+        "NOT_STARTED"
+      );
+      return;
+    }
+    serviceConnectionFuture
+      .thenAccept(service -> {
+        service.playSound(soundFile);
+        call.resolve();
+      })
+      .exceptionally(throwable -> {
+        call.reject("Failed to play sound: " + throwable.getMessage());
+        return null;
+      });
+  }
+
   // Checks if device-wide location services are disabled
   private static Boolean isLocationEnabled(Context context) {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
@@ -321,19 +286,6 @@ public class BackgroundGeolocation extends Plugin {
     }
   }
 
-  // Gets the identifier of the app's resource by name, returning 0 if not found.
-  private int getAppResourceIdentifier(String name, String defType) {
-    return getContext()
-      .getResources()
-      .getIdentifier(name, defType, getContext().getPackageName());
-  }
-
-  // Gets a string from the app's strings.xml file, resorting to a fallback if it is not defined.
-  private String getAppString(String name, String fallback) {
-    int id = getAppResourceIdentifier(name, "string");
-    return id == 0 ? fallback : getContext().getString(id);
-  }
-
   @Override
   public void load() {
     super.load();
@@ -346,9 +298,10 @@ public class BackgroundGeolocation extends Plugin {
         );
       NotificationChannel channel = new NotificationChannel(
         BackgroundGeolocationService.class.getPackage().getName(),
-        getAppString(
+        BackgroundGeolocationService.getAppString(
           "capacitor_background_geolocation_notification_channel_name",
-          "Background Tracking"
+          "Background Tracking",
+          getContext()
         ),
         NotificationManager.IMPORTANCE_DEFAULT
       );
@@ -407,21 +360,11 @@ public class BackgroundGeolocation extends Plugin {
     return serviceConnectionFuture;
   }
 
-  @Override
-  protected void handleOnResume() {
-    super.handleOnResume();
-  }
-
-  @Override
-  protected void handleOnPause() {
-    super.handleOnPause();
-  }
-
   @Override
   protected void handleOnDestroy() {
     if (serviceConnectionFuture != null) {
       serviceConnectionFuture.thenAccept(
-        BackgroundGeolocationService.LocalBinder::stopService
+        BackgroundGeolocationService.LocalBinder::stop
       );
     }