@capgo/background-geolocation 7.0.12 → 7.0.18

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

@@ -22,354 +22,296 @@ import com.getcapacitor.Logger;
 // added, and demoted when the last background watcher is removed.
 public class BackgroundGeolocationService extends Service {
 
-  static final String ACTION_BROADCAST =
-    (BackgroundGeolocationService.class.getPackage().getName() + ".broadcast");
-  private final IBinder binder = new LocalBinder();
-
-  private static final double EARTH_RADIUS_M = 6371000;
-
-  // Must be unique for this application.
-  private static final int NOTIFICATION_ID = 28351;
-
-  private String callbackId;
-
-  private LocationManager client;
-  private LocationListener locationCallback;
-  private MediaPlayer mediaPlayer;
-  private double[][] route;
-  private double distanceThreshold;
-  private boolean isOffRoute;
-
-  @Override
-  public IBinder onBind(Intent intent) {
-    return binder;
-  }
-
-  // Some devices allow a foreground service to outlive the application's main
-  // activity, leading to nasty crashes as reported in issue #59. If we learn
-  // that the application has been killed, all watchers are stopped and the
-  // service is terminated immediately.
-  @Override
-  public boolean onUnbind(Intent intent) {
-    client.removeUpdates(locationCallback);
-    releaseMediaPlayer();
-    stopSelf();
-    return false;
-  }
-
-  @Override
-  public void onDestroy() {
-    client.removeUpdates(locationCallback);
-    super.onDestroy();
-    releaseMediaPlayer();
-  }
-
-  private void releaseMediaPlayer() {
-    if (mediaPlayer == null) {
-      return;
-    }
-    try {
-      if (mediaPlayer.isPlaying()) {
-        mediaPlayer.stop();
-      }
-      mediaPlayer.release();
-    } catch (Exception e) {
-      Logger.error("Error releasing MediaPlayer", e);
-    }
-    mediaPlayer = null;
-  }
-
-  // Handles requests from the activity.
-  public class LocalBinder extends Binder {
-
-    void start(
-      final String id,
-      final String notificationTitle,
-      final String notificationMessage,
-      float distanceFilter
-    ) {
-      releaseMediaPlayer();
-      client = (LocationManager) getSystemService(Context.LOCATION_SERVICE);
-      callbackId = id;
-
-      locationCallback = location -> {
-        if (mediaPlayer != null) {
-          double[] point = { location.getLongitude(), location.getLatitude() };
-          var offRoute = distancePointToRoute(point) > distanceThreshold;
-          if (offRoute == true && isOffRoute == false) {
-            mediaPlayer.start();
-          }
-          isOffRoute = offRoute;
-        }
-        Intent intent = new Intent(ACTION_BROADCAST);
-        intent.putExtra("location", location);
-        intent.putExtra("id", callbackId);
-        LocalBroadcastManager.getInstance(
-          getApplicationContext()
-        ).sendBroadcast(intent);
-      };
-
-      try {
-        client.requestLocationUpdates(
-          LocationManager.GPS_PROVIDER,
-          1000,
-          distanceFilter,
-          locationCallback
-        );
-      } catch (SecurityException ignore) {
-        // According to Android Studio, this method can throw a Security Exception if
-        // permissions are not yet granted. Rather than check the permissions, which is fiddly,
-        // we simply ignore the exception.
-      }
-
-      // Promote the service to the foreground if necessary.
-      // Ideally we would only call 'startForeground' if the service is not already
-      // foregrounded. Unfortunately, 'getForegroundServiceType' was only introduced
-      // in API level 29 and seems to behave weirdly, as reported in #120. However,
-      // it appears that 'startForeground' is idempotent, so we just call it repeatedly
-      // each time a background watcher is added.
-      try {
-        // This method has been known to fail due to weird
-        // permission bugs, so we prevent any exceptions from
-        // crashing the app. See issue #86.
-        startForeground(
-          NOTIFICATION_ID,
-          createBackgroundNotification(notificationTitle, notificationMessage)
-        );
-      } catch (Exception exception) {
-        Logger.error("Failed to foreground service", exception);
-      }
-    }
+    static final String ACTION_BROADCAST = (BackgroundGeolocationService.class.getPackage().getName() + ".broadcast");
+    private final IBinder binder = new LocalBinder();
+
+    private static final double EARTH_RADIUS_M = 6371000;
+
+    // Must be unique for this application.
+    private static final int NOTIFICATION_ID = 28351;
 
-    String stop() {
-      client.removeUpdates(locationCallback);
-      stopForeground(true);
-      stopSelf();
-      releaseMediaPlayer();
-      return callbackId;
+    private String callbackId;
+
+    private LocationManager client;
+    private LocationListener locationCallback;
+    private MediaPlayer mediaPlayer;
+    private double[][] route;
+    private double distanceThreshold;
+    private boolean isOffRoute;
+
+    @Override
+    public IBinder onBind(Intent intent) {
+        return binder;
     }
 
-    void setPlannedRoute(
-      String filePath,
-      double[][] routeCoordinates,
-      float distance
-    ) {
-      route = routeCoordinates;
-      distanceThreshold = distance;
-      isOffRoute = true;
-      try {
-        if (mediaPlayer != null) {
-          return;
+    // Some devices allow a foreground service to outlive the application's main
+    // activity, leading to nasty crashes as reported in issue #59. If we learn
+    // that the application has been killed, all watchers are stopped and the
+    // service is terminated immediately.
+    @Override
+    public boolean onUnbind(Intent intent) {
+        if (client != null && locationCallback != null) {
+            client.removeUpdates(locationCallback);
         }
-        mediaPlayer = new MediaPlayer();
-        AssetManager am = getApplicationContext().getResources().getAssets();
-        AssetFileDescriptor assetFileDescriptor = am.openFd(
-          "public/" + filePath
-        );
-
-        mediaPlayer.setDataSource(
-          assetFileDescriptor.getFileDescriptor(),
-          assetFileDescriptor.getStartOffset(),
-          assetFileDescriptor.getLength()
-        );
-        mediaPlayer.setLooping(false);
-
-        mediaPlayer.setOnErrorListener((mp, what, extra) -> {
-          Logger.error("MediaPlayer error: what=" + what + ", extra=" + extra);
-          releaseMediaPlayer();
-          return true; // Indicate we handled the error
-        });
-
-        mediaPlayer.prepareAsync();
-      } catch (Exception e) {
-        Logger.error("PlaySound: Unexpected error", e);
         releaseMediaPlayer();
-      }
-    }
-  }
-
-  private Notification createBackgroundNotification(
-    String backgroundTitle,
-    String backgroundMessage
-  ) {
-    Notification.Builder builder = new Notification.Builder(
-      getApplicationContext()
-    )
-      .setContentTitle(backgroundTitle)
-      .setContentText(backgroundMessage)
-      .setOngoing(true)
-      .setPriority(Notification.PRIORITY_HIGH)
-      .setWhen(System.currentTimeMillis());
-
-    try {
-      String name = getAppString(
-        "capacitor_background_geolocation_notification_icon",
-        "mipmap/ic_launcher",
-        getApplicationContext()
-      );
-      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], getApplicationContext())
-      );
-    } catch (Exception e) {
-      Logger.error("Could not set notification icon", e);
+        stopSelf();
+        return false;
     }
 
-    try {
-      String color = getAppString(
-        "capacitor_background_geolocation_notification_color",
-        null,
-        getApplicationContext()
-      );
-      if (color != null) {
-        builder.setColor(Color.parseColor(color));
-      }
-    } catch (Exception e) {
-      Logger.error("Could not set notification color", e);
+    @Override
+    public void onDestroy() {
+        if (client != null && locationCallback != null) {
+            client.removeUpdates(locationCallback);
+        }
+        super.onDestroy();
+        releaseMediaPlayer();
     }
 
-    Intent launchIntent = getApplicationContext()
-      .getPackageManager()
-      .getLaunchIntentForPackage(getApplicationContext().getPackageName());
-    if (launchIntent != null) {
-      launchIntent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
-      builder.setContentIntent(
-        PendingIntent.getActivity(
-          getApplicationContext(),
-          0,
-          launchIntent,
-          PendingIntent.FLAG_CANCEL_CURRENT | PendingIntent.FLAG_IMMUTABLE
-        )
-      );
+    private void releaseMediaPlayer() {
+        if (mediaPlayer == null) {
+            return;
+        }
+        try {
+            if (mediaPlayer.isPlaying()) {
+                mediaPlayer.stop();
+            }
+            mediaPlayer.release();
+        } catch (Exception e) {
+            Logger.error("Error releasing MediaPlayer", e);
+        }
+        mediaPlayer = null;
     }
 
-    // Set the Channel ID for Android O.
-    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
-      builder.setChannelId(
-        BackgroundGeolocationService.class.getPackage().getName()
-      );
+    // Handles requests from the activity.
+    public class LocalBinder extends Binder {
+
+        void start(final String id, final String notificationTitle, final String notificationMessage, float distanceFilter) {
+            releaseMediaPlayer();
+            client = (LocationManager) getSystemService(Context.LOCATION_SERVICE);
+            callbackId = id;
+
+            locationCallback = (location) -> {
+                if (mediaPlayer != null) {
+                    double[] point = { location.getLongitude(), location.getLatitude() };
+                    var offRoute = distancePointToRoute(point) > distanceThreshold;
+                    if (offRoute == true && isOffRoute == false) {
+                        mediaPlayer.start();
+                    }
+                    isOffRoute = offRoute;
+                }
+                Intent intent = new Intent(ACTION_BROADCAST);
+                intent.putExtra("location", location);
+                intent.putExtra("id", callbackId);
+                LocalBroadcastManager.getInstance(getApplicationContext()).sendBroadcast(intent);
+            };
+
+            try {
+                client.requestLocationUpdates(LocationManager.GPS_PROVIDER, 1000, distanceFilter, locationCallback);
+            } catch (SecurityException ignore) {
+                // According to Android Studio, this method can throw a Security Exception if
+                // permissions are not yet granted. Rather than check the permissions, which is fiddly,
+                // we simply ignore the exception.
+            }
+
+            // Promote the service to the foreground if necessary.
+            // Ideally we would only call 'startForeground' if the service is not already
+            // foregrounded. Unfortunately, 'getForegroundServiceType' was only introduced
+            // in API level 29 and seems to behave weirdly, as reported in #120. However,
+            // it appears that 'startForeground' is idempotent, so we just call it repeatedly
+            // each time a background watcher is added.
+            try {
+                // This method has been known to fail due to weird
+                // permission bugs, so we prevent any exceptions from
+                // crashing the app. See issue #86.
+                startForeground(NOTIFICATION_ID, createBackgroundNotification(notificationTitle, notificationMessage));
+            } catch (Exception exception) {
+                Logger.error("Failed to foreground service", exception);
+            }
+        }
+
+        String stop() {
+            client.removeUpdates(locationCallback);
+            stopForeground(true);
+            stopSelf();
+            releaseMediaPlayer();
+            return callbackId;
+        }
+
+        void setPlannedRoute(String filePath, double[][] routeCoordinates, float distance) {
+            route = routeCoordinates;
+            distanceThreshold = distance;
+            isOffRoute = true;
+            try {
+                if (mediaPlayer != null) {
+                    return;
+                }
+                mediaPlayer = new MediaPlayer();
+                AssetManager am = getApplicationContext().getResources().getAssets();
+                AssetFileDescriptor assetFileDescriptor = am.openFd("public/" + filePath);
+
+                mediaPlayer.setDataSource(
+                    assetFileDescriptor.getFileDescriptor(),
+                    assetFileDescriptor.getStartOffset(),
+                    assetFileDescriptor.getLength()
+                );
+                mediaPlayer.setLooping(false);
+
+                mediaPlayer.setOnErrorListener((mp, what, extra) -> {
+                    Logger.error("MediaPlayer error: what=" + what + ", extra=" + extra);
+                    releaseMediaPlayer();
+                    return true; // Indicate we handled the error
+                });
+
+                mediaPlayer.prepareAsync();
+            } catch (Exception e) {
+                Logger.error("PlaySound: Unexpected error", e);
+                releaseMediaPlayer();
+            }
+        }
     }
 
-    return builder.build();
-  }
-
-  // Gets the identifier of the app's resource by name, returning 0 if not found.
-  private static int getAppResourceIdentifier(
-    String name,
-    String defType,
-    Context context
-  ) {
-    return context
-      .getResources()
-      .getIdentifier(name, defType, context.getPackageName());
-  }
-
-  // Gets a string from the app's strings.xml file, resorting to a fallback if it is not defined.
-  public static String getAppString(
-    String name,
-    String fallback,
-    Context context
-  ) {
-    int id = getAppResourceIdentifier(name, "string", context);
-    return id == 0 ? fallback : context.getString(id);
-  }
-
-  private static double haversine(double[] point1, double[] point2) {
-    double lon1 = point1[0];
-    double lat1 = point1[1];
-    double lon2 = point2[0];
-    double lat2 = point2[1];
-
-    double dLat = Math.toRadians(lat2 - lat1);
-    double dLon = Math.toRadians(lon2 - lon1);
-
-    double a =
-      Math.sin(dLat / 2) * Math.sin(dLat / 2) +
-      Math.cos(Math.toRadians(lat1)) *
-      Math.cos(Math.toRadians(lat2)) *
-      Math.sin(dLon / 2) *
-      Math.sin(dLon / 2);
-
-    double c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));
-
-    return EARTH_RADIUS_M * c;
-  }
-
-  private static double distancePointToLineSegment(
-    double[] point,
-    double[] lineStart,
-    double[] lineEnd
-  ) {
-    // Calculate the distances between the three points using Haversine
-    double dist_A_B = haversine(point, lineStart);
-    double dist_A_C = haversine(point, lineEnd);
-    double dist_B_C = haversine(lineStart, lineEnd);
-
-    // Handle the edge case where the line segment is a single point
-    if (dist_B_C == 0) {
-      return dist_A_B;
+    private Notification createBackgroundNotification(String backgroundTitle, String backgroundMessage) {
+        Notification.Builder builder = new Notification.Builder(getApplicationContext())
+            .setContentTitle(backgroundTitle)
+            .setContentText(backgroundMessage)
+            .setOngoing(true)
+            .setPriority(Notification.PRIORITY_HIGH)
+            .setWhen(System.currentTimeMillis());
+
+        try {
+            String name = getAppString("capacitor_background_geolocation_notification_icon", "mipmap/ic_launcher", getApplicationContext());
+            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], getApplicationContext()));
+        } catch (Exception e) {
+            Logger.error("Could not set notification icon", e);
+        }
+
+        try {
+            String color = getAppString("capacitor_background_geolocation_notification_color", null, getApplicationContext());
+            if (color != null) {
+                builder.setColor(Color.parseColor(color));
+            }
+        } catch (Exception e) {
+            Logger.error("Could not set notification color", e);
+        }
+
+        Intent launchIntent = getApplicationContext()
+            .getPackageManager()
+            .getLaunchIntentForPackage(getApplicationContext().getPackageName());
+        if (launchIntent != null) {
+            launchIntent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
+            builder.setContentIntent(
+                PendingIntent.getActivity(
+                    getApplicationContext(),
+                    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();
     }
 
-    // Check if the angles at the line segment's endpoints are obtuse.
-    // We use the Law of Cosines (c^2 = a^2 + b^2 - 2ab*cos(C))
-    // If cos(C) < 0, the angle is obtuse.
-
-    // Angle at B (lineStart)
-    // Use a small epsilon to handle floating point inaccuracies in division by zero
-    double cos_B =
-      (Math.pow(dist_A_B, 2) + Math.pow(dist_B_C, 2) - Math.pow(dist_A_C, 2)) /
-      (2 * dist_A_B * dist_B_C);
-    if (cos_B < 0) {
-      return dist_A_B;
+    // Gets the identifier of the app's resource by name, returning 0 if not found.
+    private static int getAppResourceIdentifier(String name, String defType, Context context) {
+        return context.getResources().getIdentifier(name, defType, context.getPackageName());
     }
 
-    // Angle at C (lineEnd)
-    double cos_C =
-      (Math.pow(dist_A_C, 2) + Math.pow(dist_B_C, 2) - Math.pow(dist_A_B, 2)) /
-      (2 * dist_A_C * dist_B_C);
-    if (cos_C < 0) {
-      return dist_A_C;
+    // Gets a string from the app's strings.xml file, resorting to a fallback if it is not defined.
+    public static String getAppString(String name, String fallback, Context context) {
+        int id = getAppResourceIdentifier(name, "string", context);
+        return id == 0 ? fallback : context.getString(id);
     }
 
-    // If both angles are acute, the closest point is on the line segment itself.
-    // We can calculate the distance (height of the triangle) using its area.
-
-    // 1. Calculate the semi-perimeter of the triangle ABC
-    double s = (dist_A_B + dist_A_C + dist_B_C) / 2;
-
-    // 2. Calculate the area using Heron's formula
-    double area = Math.sqrt(
-      Math.max(0, s * (s - dist_A_B) * (s - dist_A_C) * (s - dist_B_C))
-    );
-
-    // 3. The distance is the height of the triangle from point A to the base BC
-    // Area = 0.5 * base * height  =>  height = 2 * Area / base
-    return (2 * area) / dist_B_C;
-  }
-
-  public double distancePointToRoute(double[] point) {
-    // If the polyline has less than 2 points, we can't form a segment.
-    if (this.route.length < 2) {
-      if (this.route.length == 1) {
-        return haversine(point, this.route[0]);
-      }
-      return Double.POSITIVE_INFINITY; // No line segments to measure against
+    private static double haversine(double[] point1, double[] point2) {
+        double lon1 = point1[0];
+        double lat1 = point1[1];
+        double lon2 = point2[0];
+        double lat2 = point2[1];
+
+        double dLat = Math.toRadians(lat2 - lat1);
+        double dLon = Math.toRadians(lon2 - lon1);
+
+        double a =
+            Math.sin(dLat / 2) * Math.sin(dLat / 2) +
+            Math.cos(Math.toRadians(lat1)) * Math.cos(Math.toRadians(lat2)) * Math.sin(dLon / 2) * Math.sin(dLon / 2);
+
+        double c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));
+
+        return EARTH_RADIUS_M * c;
     }
 
-    double minDistance = Double.POSITIVE_INFINITY;
+    private static double distancePointToLineSegment(double[] point, double[] lineStart, double[] lineEnd) {
+        // Calculate the distances between the three points using Haversine
+        double dist_A_B = haversine(point, lineStart);
+        double dist_A_C = haversine(point, lineEnd);
+        double dist_B_C = haversine(lineStart, lineEnd);
+
+        // Handle the edge case where the line segment is a single point
+        if (dist_B_C == 0) {
+            return dist_A_B;
+        }
+
+        // Check if the angles at the line segment's endpoints are obtuse.
+        // We use the Law of Cosines (c^2 = a^2 + b^2 - 2ab*cos(C))
+        // If cos(C) < 0, the angle is obtuse.
+
+        // Angle at B (lineStart)
+        // Use a small epsilon to handle floating point inaccuracies in division by zero
+        double cos_B = (Math.pow(dist_A_B, 2) + Math.pow(dist_B_C, 2) - Math.pow(dist_A_C, 2)) / (2 * dist_A_B * dist_B_C);
+        if (cos_B < 0) {
+            return dist_A_B;
+        }
 
-    for (int i = 0; i < this.route.length - 1; i++) {
-      double[] lineStart = this.route[i];
-      double[] lineEnd = this.route[i + 1];
-      double distance = distancePointToLineSegment(point, lineStart, lineEnd);
-      if (distance < minDistance) {
-        minDistance = distance;
-      }
+        // Angle at C (lineEnd)
+        double cos_C = (Math.pow(dist_A_C, 2) + Math.pow(dist_B_C, 2) - Math.pow(dist_A_B, 2)) / (2 * dist_A_C * dist_B_C);
+        if (cos_C < 0) {
+            return dist_A_C;
+        }
+
+        // If both angles are acute, the closest point is on the line segment itself.
+        // We can calculate the distance (height of the triangle) using its area.
+
+        // 1. Calculate the semi-perimeter of the triangle ABC
+        double s = (dist_A_B + dist_A_C + dist_B_C) / 2;
+
+        // 2. Calculate the area using Heron's formula
+        double area = Math.sqrt(Math.max(0, s * (s - dist_A_B) * (s - dist_A_C) * (s - dist_B_C)));
+
+        // 3. The distance is the height of the triangle from point A to the base BC
+        // Area = 0.5 * base * height  =>  height = 2 * Area / base
+        return (2 * area) / dist_B_C;
     }
 
-    return minDistance;
-  }
+    public double distancePointToRoute(double[] point) {
+        // If the polyline has less than 2 points, we can't form a segment.
+        if (this.route.length < 2) {
+            if (this.route.length == 1) {
+                return haversine(point, this.route[0]);
+            }
+            return Double.POSITIVE_INFINITY; // No line segments to measure against
+        }
+
+        double minDistance = Double.POSITIVE_INFINITY;
+
+        for (int i = 0; i < this.route.length - 1; i++) {
+            double[] lineStart = this.route[i];
+            double[] lineEnd = this.route[i + 1];
+            double distance = distancePointToLineSegment(point, lineStart, lineEnd);
+            if (distance < minDistance) {
+                minDistance = distance;
+            }
+        }
+
+        return minDistance;
+    }
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The options for configuring for location updates.\n *\n * @since 7.0.9\n */\nexport interface StartOptions {\n  /**\n   * If the \"backgroundMessage\" option is defined, the plugin will\n   * provide location updates whether the app is in the background or the\n   * foreground. If it is not defined, location updates are only\n   * guaranteed in the foreground. This is true on both platforms.\n   *\n   * On Android, a notification must be shown to continue receiving\n   * location updates in the background. This option specifies the text of\n   * that notification.\n   *\n   * @since 7.0.9\n   * @example \"Getting your location to provide better service\"\n   */\n  backgroundMessage?: string;\n  /**\n   * The title of the notification mentioned above.\n   *\n   * @since 7.0.9\n   * @default \"Using your location\"\n   * @example \"Location Service\"\n   */\n  backgroundTitle?: string;\n  /**\n   * Whether permissions should be requested from the user automatically,\n   * if they are not already granted.\n   *\n   * @since 7.0.9\n   * @default true\n   * @example\n   * // Auto-request permissions\n   * requestPermissions: true\n   *\n   * // Don't auto-request, handle manually\n   * requestPermissions: false\n   */\n  requestPermissions?: boolean;\n  /**\n   * If \"true\", stale locations may be delivered while the device\n   * obtains a GPS fix. You are responsible for checking the \"time\"\n   * property. If \"false\", locations are guaranteed to be up to date.\n   *\n   * @since 7.0.9\n   * @default false\n   * @example\n   * // Allow stale locations for faster initial response\n   * stale: true\n   *\n   * // Only fresh locations\n   * stale: false\n   */\n  stale?: boolean;\n  /**\n   * The distance in meters that the device must move before a new location update is triggered.\n   * This is used to filter out small movements and reduce the number of updates.\n   *\n   * @since 7.0.9\n   * @default 0\n   * @example\n   * // Update every 10 meters\n   * distanceFilter: 10\n   *\n   * // Update on any movement\n   * distanceFilter: 0\n   */\n  distanceFilter?: number;\n}\n\n/**\n * Represents a geographical location with various attributes.\n * Contains all the standard location properties returned by GPS/network providers.\n *\n * @since 7.0.0\n */\nexport interface Location {\n  /**\n   * Latitude in degrees.\n   * Range: -90.0 to +90.0\n   *\n   * @since 7.0.0\n   * @example 40.7128\n   */\n  latitude: number;\n  /**\n   * Longitude in degrees.\n   * Range: -180.0 to +180.0\n   *\n   * @since 7.0.0\n   * @example -74.0060\n   */\n  longitude: number;\n  /**\n   * Radius of horizontal uncertainty in metres, with 68% confidence.\n   * Lower values indicate more accurate location.\n   *\n   * @since 7.0.0\n   * @example 5.0\n   */\n  accuracy: number;\n  /**\n   * Metres above sea level (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 10.5\n   */\n  altitude: number | null;\n  /**\n   * Vertical uncertainty in metres, with 68% confidence (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 3.0\n   */\n  altitudeAccuracy: number | null;\n  /**\n   * `true` if the location was simulated by software, rather than GPS.\n   * Useful for detecting mock locations in development or testing.\n   *\n   * @since 7.0.0\n   * @example false\n   */\n  simulated: boolean;\n  /**\n   * Deviation from true north in degrees (or null if not available).\n   * Range: 0.0 to 360.0\n   *\n   * @since 7.0.0\n   * @example 45.5\n   */\n  bearing: number | null;\n  /**\n   * Speed in metres per second (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 2.5\n   */\n  speed: number | null;\n  /**\n   * Time the location was produced, in milliseconds since the unix epoch.\n   * Use this to check if a location is stale when using stale: true.\n   *\n   * @since 7.0.0\n   * @example 1640995200000\n   */\n  time: number | null;\n}\n\n/**\n * Error object that may be passed to the location start callback.\n * Extends the standard Error with optional error codes.\n *\n * @since 7.0.0\n */\nexport interface CallbackError extends Error {\n  /**\n   * Optional error code for more specific error handling.\n   *\n   * @since 7.0.0\n   * @example \"PERMISSION_DENIED\"\n   */\n  code?: string;\n}\n\nexport interface SetPlannedRouteOptions {\n  /**\n   * The name of the sound file to play.\n   * Must be a valid sound relative path in the app's public folder to work for both web and native platforms.\n   * There's no need to include the public folder in the path.\n   * @since 7.0.10\n   * @example \"notification.mp3\"\n   * */\n  soundFile: string;\n  /**\n   * The planned route as an array of longitude and latitude pairs.\n   * Each pair represents a point on the route.\n   * This is used to define a route that the user can follow.\n   * The route is used to play a sound when the user deviates from it.\n   * @since 7.0.11\n   * @example [[-74.0060, 40.7128], [-118.2437, 34.0522]]\n   */\n  route: [number, number][];\n\n  /**\n   * The distance in meters that the user must deviate from the planned route to trigger the sound.\n   * This is used to determine how far off the route the user can be before the sound is played.\n   * If not specified, a default value of 50 meters is used.\n   * @since 7.0.11\n   * @default 50\n   * @example 50\n   */\n  distance: number;\n}\n\n/**\n * Main plugin interface for background geolocation functionality.\n * Provides methods to manage location updates and access device settings.\n *\n * @since 7.0.0\n */\nexport interface BackgroundGeolocationPlugin {\n  /**\n   * To start listening for changes in the device's location, call this method.\n   * A Promise is returned to indicate that it finished the call. The callback will be called every time a new location\n   * is available, or if there was an error when calling this method. Don't rely on promise rejection for this.\n   *\n   * @param options The configuration options\n   * @param callback The callback function invoked when a new location is available or an error occurs\n   * @returns A promise that resolves when the method is successfully called\n   *\n   * @since 7.0.9\n   * @example\n   * await BackgroundGeolocation.start(\n   *   {\n   *     backgroundMessage: \"App is using your location in the background\",\n   *     backgroundTitle: \"Location Service\",\n   *     requestPermissions: true,\n   *     stale: false,\n   *     distanceFilter: 10\n   *   },\n   *   (location, error) => {\n   *     if (error) {\n   *       console.error('Location error:', error);\n   *       return;\n   *     }\n   *     if (location) {\n   *       console.log('New location:', location.latitude, location.longitude);\n   *     }\n   *   }\n   * );\n   */\n  start(\n    options: StartOptions,\n    callback: (position?: Location, error?: CallbackError) => void,\n  ): Promise<void>;\n\n  /**\n   * Stops location updates.\n   *\n   * @returns A promise that resolves when the plugin stops successfully removed\n   *\n   * @since 7.0.9\n   * @example\n   * await BackgroundGeolocation.stop();\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Opens the device's location settings page.\n   * Useful for directing users to enable location services or adjust permissions.\n   *\n   * @returns A promise that resolves when the settings page is opened\n   *\n   * @since 7.0.0\n   * @example\n   * // Direct user to location settings\n   * await BackgroundGeolocation.openSettings();\n   */\n  openSettings(): Promise<void>;\n\n  /**\n   * Plays a sound file when the user deviates from the planned route.\n   * This should be used to play a sound (in the background too, only for native).\n   *\n   * @param options The options for setting the planned route and sound file\n   * @returns A promise that resolves when the route is set successfully\n   *\n   * @since 7.0.11\n   * @example\n   * await BackgroundGeolocation.setPlannedRoute({\n   *   soundFile: \"notification.mp3\",\n   *   route: [[-74.0060, 40.7128], [-118.2437, 34.0522]]\n   * });\n   */\n  setPlannedRoute(options: SetPlannedRouteOptions): Promise<void>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The options for configuring for location updates.\n *\n * @since 7.0.9\n */\nexport interface StartOptions {\n  /**\n   * If the \"backgroundMessage\" option is defined, the plugin will\n   * provide location updates whether the app is in the background or the\n   * foreground. If it is not defined, location updates are only\n   * guaranteed in the foreground. This is true on both platforms.\n   *\n   * On Android, a notification must be shown to continue receiving\n   * location updates in the background. This option specifies the text of\n   * that notification.\n   *\n   * @since 7.0.9\n   * @example \"Getting your location to provide better service\"\n   */\n  backgroundMessage?: string;\n  /**\n   * The title of the notification mentioned above.\n   *\n   * @since 7.0.9\n   * @default \"Using your location\"\n   * @example \"Location Service\"\n   */\n  backgroundTitle?: string;\n  /**\n   * Whether permissions should be requested from the user automatically,\n   * if they are not already granted.\n   *\n   * @since 7.0.9\n   * @default true\n   * @example\n   * // Auto-request permissions\n   * requestPermissions: true\n   *\n   * // Don't auto-request, handle manually\n   * requestPermissions: false\n   */\n  requestPermissions?: boolean;\n  /**\n   * If \"true\", stale locations may be delivered while the device\n   * obtains a GPS fix. You are responsible for checking the \"time\"\n   * property. If \"false\", locations are guaranteed to be up to date.\n   *\n   * @since 7.0.9\n   * @default false\n   * @example\n   * // Allow stale locations for faster initial response\n   * stale: true\n   *\n   * // Only fresh locations\n   * stale: false\n   */\n  stale?: boolean;\n  /**\n   * The distance in meters that the device must move before a new location update is triggered.\n   * This is used to filter out small movements and reduce the number of updates.\n   *\n   * @since 7.0.9\n   * @default 0\n   * @example\n   * // Update every 10 meters\n   * distanceFilter: 10\n   *\n   * // Update on any movement\n   * distanceFilter: 0\n   */\n  distanceFilter?: number;\n}\n\n/**\n * Represents a geographical location with various attributes.\n * Contains all the standard location properties returned by GPS/network providers.\n *\n * @since 7.0.0\n */\nexport interface Location {\n  /**\n   * Latitude in degrees.\n   * Range: -90.0 to +90.0\n   *\n   * @since 7.0.0\n   * @example 40.7128\n   */\n  latitude: number;\n  /**\n   * Longitude in degrees.\n   * Range: -180.0 to +180.0\n   *\n   * @since 7.0.0\n   * @example -74.0060\n   */\n  longitude: number;\n  /**\n   * Radius of horizontal uncertainty in metres, with 68% confidence.\n   * Lower values indicate more accurate location.\n   *\n   * @since 7.0.0\n   * @example 5.0\n   */\n  accuracy: number;\n  /**\n   * Metres above sea level (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 10.5\n   */\n  altitude: number | null;\n  /**\n   * Vertical uncertainty in metres, with 68% confidence (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 3.0\n   */\n  altitudeAccuracy: number | null;\n  /**\n   * `true` if the location was simulated by software, rather than GPS.\n   * Useful for detecting mock locations in development or testing.\n   *\n   * @since 7.0.0\n   * @example false\n   */\n  simulated: boolean;\n  /**\n   * Deviation from true north in degrees (or null if not available).\n   * Range: 0.0 to 360.0\n   *\n   * @since 7.0.0\n   * @example 45.5\n   */\n  bearing: number | null;\n  /**\n   * Speed in metres per second (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 2.5\n   */\n  speed: number | null;\n  /**\n   * Time the location was produced, in milliseconds since the unix epoch.\n   * Use this to check if a location is stale when using stale: true.\n   *\n   * @since 7.0.0\n   * @example 1640995200000\n   */\n  time: number | null;\n}\n\n/**\n * Error object that may be passed to the location start callback.\n * Extends the standard Error with optional error codes.\n *\n * @since 7.0.0\n */\nexport interface CallbackError extends Error {\n  /**\n   * Optional error code for more specific error handling.\n   *\n   * @since 7.0.0\n   * @example \"PERMISSION_DENIED\"\n   */\n  code?: string;\n}\n\nexport interface SetPlannedRouteOptions {\n  /**\n   * The name of the sound file to play.\n   * Must be a valid sound relative path in the app's public folder to work for both web and native platforms.\n   * There's no need to include the public folder in the path.\n   * @since 7.0.10\n   * @example \"notification.mp3\"\n   * */\n  soundFile: string;\n  /**\n   * The planned route as an array of longitude and latitude pairs.\n   * Each pair represents a point on the route.\n   * This is used to define a route that the user can follow.\n   * The route is used to play a sound when the user deviates from it.\n   * @since 7.0.11\n   * @example [[-74.0060, 40.7128], [-118.2437, 34.0522]]\n   */\n  route: [number, number][];\n\n  /**\n   * The distance in meters that the user must deviate from the planned route to trigger the sound.\n   * This is used to determine how far off the route the user can be before the sound is played.\n   * If not specified, a default value of 50 meters is used.\n   * @since 7.0.11\n   * @default 50\n   * @example 50\n   */\n  distance: number;\n}\n\n/**\n * Main plugin interface for background geolocation functionality.\n * Provides methods to manage location updates and access device settings.\n *\n * @since 7.0.0\n */\nexport interface BackgroundGeolocationPlugin {\n  /**\n   * To start listening for changes in the device's location, call this method.\n   * A Promise is returned to indicate that it finished the call. The callback will be called every time a new location\n   * is available, or if there was an error when calling this method. Don't rely on promise rejection for this.\n   *\n   * @param options The configuration options\n   * @param callback The callback function invoked when a new location is available or an error occurs\n   * @returns A promise that resolves when the method is successfully called\n   *\n   * @since 7.0.9\n   * @example\n   * await BackgroundGeolocation.start(\n   *   {\n   *     backgroundMessage: \"App is using your location in the background\",\n   *     backgroundTitle: \"Location Service\",\n   *     requestPermissions: true,\n   *     stale: false,\n   *     distanceFilter: 10\n   *   },\n   *   (location, error) => {\n   *     if (error) {\n   *       console.error('Location error:', error);\n   *       return;\n   *     }\n   *     if (location) {\n   *       console.log('New location:', location.latitude, location.longitude);\n   *     }\n   *   }\n   * );\n   */\n  start(options: StartOptions, callback: (position?: Location, error?: CallbackError) => void): Promise<void>;\n\n  /**\n   * Stops location updates.\n   *\n   * @returns A promise that resolves when the plugin stops successfully removed\n   *\n   * @since 7.0.9\n   * @example\n   * await BackgroundGeolocation.stop();\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Opens the device's location settings page.\n   * Useful for directing users to enable location services or adjust permissions.\n   *\n   * @returns A promise that resolves when the settings page is opened\n   *\n   * @since 7.0.0\n   * @example\n   * // Direct user to location settings\n   * await BackgroundGeolocation.openSettings();\n   */\n  openSettings(): Promise<void>;\n\n  /**\n   * Plays a sound file when the user deviates from the planned route.\n   * This should be used to play a sound (in the background too, only for native).\n   *\n   * @param options The options for setting the planned route and sound file\n   * @returns A promise that resolves when the route is set successfully\n   *\n   * @since 7.0.11\n   * @example\n   * await BackgroundGeolocation.setPlannedRoute({\n   *   soundFile: \"notification.mp3\",\n   *   route: [[-74.0060, 40.7128], [-118.2437, 34.0522]]\n   * });\n   */\n  setPlannedRoute(options: SetPlannedRouteOptions): Promise<void>;\n}\n"]}