@capgo/background-geolocation 7.0.9 → 7.0.11

package/dist/docs.json

@@ -2,10 +2,10 @@
   "api": {
     "name": "BackgroundGeolocationPlugin",
     "slug": "backgroundgeolocationplugin",
-    "docs": "Main plugin interface for background geolocation functionality.\nProvides methods to manage location watchers and access device settings.",
+    "docs": "Main plugin interface for background geolocation functionality.\nProvides methods to manage location updates and access device settings.",
     "tags": [
       {
-        "text": "1.0.0",
+        "text": "7.0.0",
         "name": "since"
       }
     ],
@@ -16,7 +16,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "The watcher configuration options",
+            "docs": "The configuration options",
             "type": "StartOptions"
           },
           {
@@ -29,7 +29,7 @@
         "tags": [
           {
             "name": "param",
-            "text": "options The watcher configuration options"
+            "text": "options The configuration options"
           },
           {
             "name": "param",
@@ -37,18 +37,18 @@
           },
           {
             "name": "returns",
-            "text": "A promise that resolves to a unique identifier for the watcher ID"
+            "text": "A promise that resolves when the method is successfully called"
           },
           {
             "name": "since",
-            "text": "1.0.0"
+            "text": "7.0.9"
           },
           {
             "name": "example",
             "text": "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);"
           }
         ],
-        "docs": "Adds a watcher for location updates.\nThe watcher will be invoked with the latest location whenever it is available.\nIf an error occurs, the callback will be invoked with the error.",
+        "docs": "To start listening for changes in the device's location, call this method.\nA Promise is returned to indicate that it finished the call. The callback will be called every time a new location\nis available, or if there was an error when calling this method. Don't rely on promise rejection for this.",
         "complexTypes": [
           "StartOptions",
           "Location",
@@ -64,11 +64,11 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A promise that resolves when the watcher is successfully removed"
+            "text": "A promise that resolves when the plugin stops successfully removed"
           },
           {
             "name": "since",
-            "text": "1.0.0"
+            "text": "7.0.9"
           },
           {
             "name": "example",
@@ -91,7 +91,7 @@
           },
           {
             "name": "since",
-            "text": "1.0.0"
+            "text": "7.0.0"
           },
           {
             "name": "example",
@@ -101,6 +101,41 @@
         "docs": "Opens the device's location settings page.\nUseful for directing users to enable location services or adjust permissions.",
         "complexTypes": [],
         "slug": "opensettings"
+      },
+      {
+        "name": "setPlannedRoute",
+        "signature": "(options: SetPlannedRouteOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The options for setting the planned route and sound file",
+            "type": "SetPlannedRouteOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The options for setting the planned route and sound file"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the route is set successfully"
+          },
+          {
+            "name": "since",
+            "text": "7.0.11"
+          },
+          {
+            "name": "example",
+            "text": "await BackgroundGeolocation.setPlannedRoute({\n  soundFile: \"notification.mp3\",\n  route: [[-74.0060, 40.7128], [-118.2437, 34.0522]]\n});"
+          }
+        ],
+        "docs": "Plays a sound file when the user deviates from the planned route.\nThis should be used to play a sound (in the background too, only for native).",
+        "complexTypes": [
+          "SetPlannedRouteOptions"
+        ],
+        "slug": "setplannedroute"
       }
     ],
     "properties": []
@@ -112,7 +147,7 @@
       "docs": "The options for configuring for location updates.",
       "tags": [
         {
-          "text": "1.0.0",
+          "text": "7.0.9",
           "name": "since"
         }
       ],
@@ -122,7 +157,7 @@
           "name": "backgroundMessage",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -130,7 +165,7 @@
               "name": "example"
             }
           ],
-          "docs": "If the \"backgroundMessage\" option is defined, the watcher will\nprovide location updates whether the app is in the background or the\nforeground. If it is not defined, location updates are only\nguaranteed in the foreground. This is true on both platforms.\n\nOn Android, a notification must be shown to continue receiving\nlocation updates in the background. This option specifies the text of\nthat notification.",
+          "docs": "If the \"backgroundMessage\" option is defined, the plugin will\nprovide location updates whether the app is in the background or the\nforeground. If it is not defined, location updates are only\nguaranteed in the foreground. This is true on both platforms.\n\nOn Android, a notification must be shown to continue receiving\nlocation updates in the background. This option specifies the text of\nthat notification.",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -138,7 +173,7 @@
           "name": "backgroundTitle",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -158,7 +193,7 @@
           "name": "requestPermissions",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -178,7 +213,7 @@
           "name": "stale",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -198,7 +233,7 @@
           "name": "distanceFilter",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -222,7 +257,7 @@
       "docs": "Represents a geographical location with various attributes.\nContains all the standard location properties returned by GPS/network providers.",
       "tags": [
         {
-          "text": "1.0.0",
+          "text": "7.0.0",
           "name": "since"
         }
       ],
@@ -232,7 +267,7 @@
           "name": "latitude",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -248,7 +283,7 @@
           "name": "longitude",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -264,7 +299,7 @@
           "name": "accuracy",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -280,7 +315,7 @@
           "name": "altitude",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -296,7 +331,7 @@
           "name": "altitudeAccuracy",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -312,7 +347,7 @@
           "name": "simulated",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -328,7 +363,7 @@
           "name": "bearing",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -344,7 +379,7 @@
           "name": "speed",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -360,7 +395,7 @@
           "name": "time",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -377,10 +412,10 @@
     {
       "name": "CallbackError",
       "slug": "callbackerror",
-      "docs": "Error object that may be passed to the location watcher callback.\nExtends the standard Error with optional error codes.",
+      "docs": "Error object that may be passed to the location start callback.\nExtends the standard Error with optional error codes.",
       "tags": [
         {
-          "text": "1.0.0",
+          "text": "7.0.0",
           "name": "since"
         }
       ],
@@ -390,7 +425,7 @@
           "name": "code",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -403,6 +438,67 @@
           "type": "string | undefined"
         }
       ]
+    },
+    {
+      "name": "SetPlannedRouteOptions",
+      "slug": "setplannedrouteoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "soundFile",
+          "tags": [
+            {
+              "text": "7.0.10",
+              "name": "since"
+            },
+            {
+              "text": "\"notification.mp3\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the sound file to play.\nMust be a valid sound relative path in the app's public folder to work for both web and native platforms.\nThere's no need to include the public folder in the path.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "route",
+          "tags": [
+            {
+              "text": "7.0.11",
+              "name": "since"
+            },
+            {
+              "text": "[[-74.0060, 40.7128], [-118.2437, 34.0522]]",
+              "name": "example"
+            }
+          ],
+          "docs": "The planned route as an array of longitude and latitude pairs.\nEach pair represents a point on the route.\nThis is used to define a route that the user can follow.\nThe route is used to play a sound when the user deviates from it.",
+          "complexTypes": [],
+          "type": "[number, number][]"
+        },
+        {
+          "name": "distance",
+          "tags": [
+            {
+              "text": "7.0.11",
+              "name": "since"
+            },
+            {
+              "text": "50",
+              "name": "default"
+            },
+            {
+              "text": "50",
+              "name": "example"
+            }
+          ],
+          "docs": "The distance in meters that the user must deviate from the planned route to trigger the sound.\nThis is used to determine how far off the route the user can be before the sound is played.\nIf not specified, a default value of 50 meters is used.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
     }
   ],
   "enums": [],

package/dist/esm/definitions.d.ts

@@ -1,11 +1,11 @@
 /**
  * The options for configuring for location updates.
  *
- * @since 1.0.0
+ * @since 7.0.9
  */
 export interface StartOptions {
     /**
-     * If the "backgroundMessage" option is defined, the watcher will
+     * 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.
@@ -14,14 +14,14 @@ export interface StartOptions {
      * location updates in the background. This option specifies the text of
      * that notification.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @example "Getting your location to provide better service"
      */
     backgroundMessage?: string;
     /**
      * The title of the notification mentioned above.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default "Using your location"
      * @example "Location Service"
      */
@@ -30,7 +30,7 @@ export interface StartOptions {
      * Whether permissions should be requested from the user automatically,
      * if they are not already granted.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default true
      * @example
      * // Auto-request permissions
@@ -45,7 +45,7 @@ export interface StartOptions {
      * obtains a GPS fix. You are responsible for checking the "time"
      * property. If "false", locations are guaranteed to be up to date.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default false
      * @example
      * // Allow stale locations for faster initial response
@@ -59,7 +59,7 @@ export interface StartOptions {
      * 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.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default 0
      * @example
      * // Update every 10 meters
@@ -74,14 +74,14 @@ export interface StartOptions {
  * Represents a geographical location with various attributes.
  * Contains all the standard location properties returned by GPS/network providers.
  *
- * @since 1.0.0
+ * @since 7.0.0
  */
 export interface Location {
     /**
      * Latitude in degrees.
      * Range: -90.0 to +90.0
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 40.7128
      */
     latitude: number;
@@ -89,7 +89,7 @@ export interface Location {
      * Longitude in degrees.
      * Range: -180.0 to +180.0
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example -74.0060
      */
     longitude: number;
@@ -97,21 +97,21 @@ export interface Location {
      * Radius of horizontal uncertainty in metres, with 68% confidence.
      * Lower values indicate more accurate location.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 5.0
      */
     accuracy: number;
     /**
      * Metres above sea level (or null if not available).
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 10.5
      */
     altitude: number | null;
     /**
      * Vertical uncertainty in metres, with 68% confidence (or null if not available).
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 3.0
      */
     altitudeAccuracy: number | null;
@@ -119,7 +119,7 @@ export interface Location {
      * `true` if the location was simulated by software, rather than GPS.
      * Useful for detecting mock locations in development or testing.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example false
      */
     simulated: boolean;
@@ -127,14 +127,14 @@ export interface Location {
      * Deviation from true north in degrees (or null if not available).
      * Range: 0.0 to 360.0
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 45.5
      */
     bearing: number | null;
     /**
      * Speed in metres per second (or null if not available).
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 2.5
      */
     speed: number | null;
@@ -142,43 +142,71 @@ export interface Location {
      * Time the location was produced, in milliseconds since the unix epoch.
      * Use this to check if a location is stale when using stale: true.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 1640995200000
      */
     time: number | null;
 }
 /**
- * Error object that may be passed to the location watcher callback.
+ * Error object that may be passed to the location start callback.
  * Extends the standard Error with optional error codes.
  *
- * @since 1.0.0
+ * @since 7.0.0
  */
 export interface CallbackError extends Error {
     /**
      * Optional error code for more specific error handling.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example "PERMISSION_DENIED"
      */
     code?: string;
 }
+export interface SetPlannedRouteOptions {
+    /**
+     * 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.
+     * @since 7.0.10
+     * @example "notification.mp3"
+     * */
+    soundFile: string;
+    /**
+     * The planned route as an array of longitude and latitude pairs.
+     * Each pair represents a point on the route.
+     * This is used to define a route that the user can follow.
+     * The route is used to play a sound when the user deviates from it.
+     * @since 7.0.11
+     * @example [[-74.0060, 40.7128], [-118.2437, 34.0522]]
+     */
+    route: [number, number][];
+    /**
+     * The distance in meters that the user must deviate from the planned route to trigger the sound.
+     * This is used to determine how far off the route the user can be before the sound is played.
+     * If not specified, a default value of 50 meters is used.
+     * @since 7.0.11
+     * @default 50
+     * @example 50
+     */
+    distance: number;
+}
 /**
  * Main plugin interface for background geolocation functionality.
- * Provides methods to manage location watchers and access device settings.
+ * Provides methods to manage location updates and access device settings.
  *
- * @since 1.0.0
+ * @since 7.0.0
  */
 export interface BackgroundGeolocationPlugin {
     /**
-     * Adds a watcher for location updates.
-     * The watcher will be invoked with the latest location whenever it is available.
-     * If an error occurs, the callback will be invoked with the error.
+     * 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 options The watcher configuration options
+     * @param options The configuration options
      * @param callback The callback function invoked when a new location is available or an error occurs
-     * @returns A promise that resolves to a unique identifier for the watcher ID
+     * @returns A promise that resolves when the method is successfully called
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @example
      * await BackgroundGeolocation.start(
      *   {
@@ -203,9 +231,9 @@ export interface BackgroundGeolocationPlugin {
     /**
      * Stops location updates.
      *
-     * @returns A promise that resolves when the watcher is successfully removed
+     * @returns A promise that resolves when the plugin stops successfully removed
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @example
      * await BackgroundGeolocation.stop();
      */
@@ -216,10 +244,25 @@ export interface BackgroundGeolocationPlugin {
      *
      * @returns A promise that resolves when the settings page is opened
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example
      * // Direct user to location settings
      * await BackgroundGeolocation.openSettings();
      */
     openSettings(): Promise<void>;
+    /**
+     * Plays a sound file when the user deviates from the planned route.
+     * This should be used to play a sound (in the background too, only for native).
+     *
+     * @param options The options for setting the planned route and sound file
+     * @returns A promise that resolves when the route is set successfully
+     *
+     * @since 7.0.11
+     * @example
+     * await BackgroundGeolocation.setPlannedRoute({
+     *   soundFile: "notification.mp3",
+     *   route: [[-74.0060, 40.7128], [-118.2437, 34.0522]]
+     * });
+     */
+    setPlannedRoute(options: SetPlannedRouteOptions): Promise<void>;
 }

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 1.0.0\n */\nexport interface StartOptions {\n  /**\n   * If the \"backgroundMessage\" option is defined, the watcher 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 1.0.0\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 1.0.0\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 1.0.0\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 1.0.0\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 1.0.0\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 1.0.0\n */\nexport interface Location {\n  /**\n   * Latitude in degrees.\n   * Range: -90.0 to +90.0\n   *\n   * @since 1.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 1.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 1.0.0\n   * @example 5.0\n   */\n  accuracy: number;\n  /**\n   * Metres above sea level (or null if not available).\n   *\n   * @since 1.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 1.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 1.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 1.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 1.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 1.0.0\n   * @example 1640995200000\n   */\n  time: number | null;\n}\n\n/**\n * Error object that may be passed to the location watcher callback.\n * Extends the standard Error with optional error codes.\n *\n * @since 1.0.0\n */\nexport interface CallbackError extends Error {\n  /**\n   * Optional error code for more specific error handling.\n   *\n   * @since 1.0.0\n   * @example \"PERMISSION_DENIED\"\n   */\n  code?: string;\n}\n\n/**\n * Main plugin interface for background geolocation functionality.\n * Provides methods to manage location watchers and access device settings.\n *\n * @since 1.0.0\n */\nexport interface BackgroundGeolocationPlugin {\n  /**\n   * Adds a watcher for location updates.\n   * The watcher will be invoked with the latest location whenever it is available.\n   * If an error occurs, the callback will be invoked with the error.\n   *\n   * @param options The watcher 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 to a unique identifier for the watcher ID\n   *\n   * @since 1.0.0\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 watcher is successfully removed\n   *\n   * @since 1.0.0\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 1.0.0\n   * @example\n   * // Direct user to location settings\n   * await BackgroundGeolocation.openSettings();\n   */\n  openSettings(): 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(\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"]}

package/dist/esm/web.d.ts

@@ -1,8 +1,18 @@
 import { WebPlugin } from "@capacitor/core";
-import type { BackgroundGeolocationPlugin, StartOptions, Location, CallbackError } from "./definitions";
+import type { BackgroundGeolocationPlugin, StartOptions, Location, CallbackError, SetPlannedRouteOptions } from "./definitions";
 export declare class BackgroundGeolocationWeb extends WebPlugin implements BackgroundGeolocationPlugin {
+    private static readonly EARTH_RADIUS_M;
     private watchId;
+    private plannedRoute;
+    private audio;
+    private isOffRoute;
+    private distanceThreshold;
     start(options: StartOptions, callback: (position?: Location, error?: CallbackError) => void): Promise<void>;
     stop(): Promise<void>;
     openSettings(): Promise<void>;
+    setPlannedRoute(options: SetPlannedRouteOptions): Promise<void>;
+    private toRadians;
+    private haversine;
+    private distancePointToLineSegment;
+    private distancePointToRoute;
 }