@transistorsoft/capacitor-background-geolocation 4.9.4 → 4.9.5

package/dist/declarations/HttpEvent.d.ts

@@ -1,313 +0,0 @@
-declare module "@transistorsoft/capacitor-background-geolocation" {
-  /**
-  * The event-object provided to [[BackgroundGeolocation.onHttp]] when an HTTP response arrives from your configured [[Config.url]].
-  *
-  * @example
-  * ```typescript
-  * BackgroundGeolocation.onHttp(httpEvent => {
-  *   console.log("[http] ", httpEvent.success, httpEvent.status);
-  * });
-  * ```
-  *
-  * # HTTP Guide
-  * ---------------------------------------------------------------------------------------
-  *
-  * The [[BackgroundGeolocation]] SDK hosts its own flexible and robust native HTTP & SQLite persistence services.  To enable the HTTP service, simply configure the SDK with an [[Config.url]]:
-  *
-  * @example
-  * ```typescript
-  * // Listen for HTTP responses.
-  * BackgroundGeolocation.onHttp(response => {
-  *   console.log("[http] response: ", response.success, response.status, response.responseText);
-  * });
-  *
-  * BackgroundGeolocation.ready({
-  *   url: "https://my-server.com/locations",
-  *   autoSync: true,
-  *   autoSyncThreshold: 5,
-  *   batchSync: true,
-  *   maxBatchSize: 50,
-  *   headers: {
-  *     AUTHENTICATION_TOKEN: "23kasdlfkjlksjflkasdZIds"
-  *   },
-  *   params: {
-  *     user_id: 1234
-  *   },
-  *   extras: {
-  *     route_id: 8675309
-  *   },
-  *   locationsOrderDirection: "DESC",
-  *   maxDaysToPersist: 14
-  * }, state => {
-  *   console.log("[ready] success: ", state);
-  * });
-  * ```
-  *
-  * ## The SQLite Database
-  *
-  * The SDK immediately inserts each recorded location into its SQLite database.  This database is designed to act as a temporary buffer for the HTTP service and the SDK __strongly__ desires an *empty* database.  The only way that locations are destroyed from the database are:
-  * - Successful HTTP response from your server (`200`, `201`, `204`).
-  * - Executing [[BackgroundGeolocation.destroyLocations]].
-  * - [[maxDaysToPersist]] elapses and the location is destroyed.
-  * - [[maxRecordsToPersist]] destroys oldest record in favor of latest.
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## The HTTP Service
-  *
-  * The SDK's HTTP service operates by selecting records from the database, locking them to prevent duplicate requests then uploading to your server.
-  * - By default, the HTTP Service will select a single record (oldest first; see [[locationsOrderDirection]]) and execute an HTTP request to your [[Config.url]].
-  * - Each HTTP request is *synchronous* — the HTTP service will await the response from your server before selecting and uploading another record.
-  * - If your server returns an error or doesn't respond, the HTTP Service will immediately **halt**.
-  * - Configuring [[batchSync]] __`true`__ instructs the HTTP Service to select *all* records in the database and upload them to your server in a single HTTP request.
-  * - Use [[maxBatchSize]] to limit the number of records selected for each [[batchSync]] request.  The HTTP service will execute *synchronous* HTTP *batch* requests until the database is empty.
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## Capturing the data at your server
-  *
-  * The SDK's HTTP Service will upload recorded locations as JSON to your [[Config.url]] (See [[Location]] for the JSON schema) with `Content-Type application/json`.  The data can be found by your server in the ["HTTP request body"](https://www.google.com/search?q=http+post+application%2Fjson+request+body+text).
-  *
-  * ### PHP
-  *
-  * ```php
-  * <?php
-  *  $json = file_get_contents('php://input');
-  *  $data = json_decode($json);
-  *  echo "POST /locations: " . $data;
-  * ?>
-  * ```
-  *
-  * ### Node with `express`
-  *
-  * ```javascript
-  * import express from 'express';
-  * import bodyParser from 'body-parser';
-  *
-  * const app = express();
-  *
-  * app.use(bodyParser.json());  // <-- use body-parser
-  *
-  * app.post('/locations', (req, res) => {
-  *   console.log('POST /locations: ', req.body);
-  * });
-  * ```
-  *
-  * ### Rails
-  *
-  * ```ruby
-  * class LocationsController < ApplicationController
-  *   def create
-  *     data = params
-  *     puts "POST /locations: #{data}"
-  *   end
-  * end
-  * ```
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## HTTP Failures
-  *
-  * If your server does *not* return a `20x` response (eg: `200`, `201`, `204`), the SDK will __`UNLOCK`__ that record.  Another attempt to upload will be made in the future (until [[maxDaysToPersist]]) when:
-  * - When another location is recorded.
-  * - Application `pause` / `resume` events.
-  * - Application boot.
-  * - [[onHeartbeat]] events.
-  * - [[onConnectivityChange]] events.
-  * - __[iOS]__ Background `fetch` events.
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## Receiving the HTTP Response.
-  *
-  * You can capture the HTTP response from your server by listening to the [[onHttp]] event.
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## `autoSync: true`
-  *
-  * By default, the SDK is configured for [[autoSync]]:true and will attempt to immediately upload each recorded location to your configured [[Config.url]].
-  * - Use [[autoSyncThreshold]] to throttle HTTP requests.  This will instruct the SDK to accumulate that number of records in the database before calling upon the HTTP Service.  This is a good way to **conserve battery**, since HTTP requests consume more energy/second than the GPS.
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## Manual Invoking Upload
-  *
-  * The SDK's HTTP Service can be summoned into action at __any time__ via the method [[BackgroundGeolocation.sync]].
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## [[Config.params]], [[headers]] and [[extras]]
-  *
-  * - The SDK's HTTP Service appends configured [[Config.params]] to root of the `JSON` data of each HTTP request.
-  * - [[headers]] are appended to each HTTP Request.
-  * - [[extras]] are appended to each recorded location and persisted to the database record.
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## Custom `JSON` Schema:  [[locationTemplate]] and [[geofenceTemplate]]
-  *
-  * The default HTTP `JSON` schema for both [[Location]] and [[Geofence]] can be overridden by the configuration options [[locationTemplate]] and [[geofenceTemplate]], allowing you to create any schema you wish.
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## Disabling HTTP requests on Cellular connections
-  *
-  * If you're concerned with Cellular data-usage, you can configure the plugin's HTTP Service to upload only when connected to Wifi:
-  *
-  * @example
-  * ```javascript
-  * BackgroundGeolocation.ready({
-  *   autoSync: true,
-  *   disableAutoSyncOnCellular: true
-  * });
-  * ```
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## HTTP Logging
-  *
-  * You can observe the plugin performing HTTP requests in the logs for both iOS and Android (_See Wiki [Debugging](github:wiki/Debugging)_):
-  *
-  * @example
-  * ```
-  * ╔═════════════════════════════════════════════
-  * ║ LocationService: location
-  * ╠═════════════════════════════════════════════
-  * ╟─ 📍 Location[45.519199,-73.617054]
-  * ✅ INSERT: 70727f8b-df7d-48d0-acbd-15f10cacdf33
-  * ╔═════════════════════════════════════════════
-  * ║ HTTP Service
-  * ╠═════════════════════════════════════════════
-  * ✅ Locked 1 records
-  * 🔵 HTTP POST: 70727f8b-df7d-48d0-acbd-15f10cacdf33
-  * 🔵 Response: 200
-  * ✅ DESTROY: 70727f8b-df7d-48d0-acbd-15f10cacdf33
-  * ```
-  *
-  * |#| Log entry               | Description                                                           |
-  * |-|-------------------------|-----------------------------------------------------------------------|
-  * |1| `📍Location`            | Location received from native Location API.                           |
-  * |2| `✅INSERT`              | Location record inserted into SDK's SQLite database.                  |
-  * |3| `✅Locked`              | SDK's HTTP service locks a record (to prevent duplicate HTTP uploads).|
-  * |4| `🔵HTTP POST`           | SDK's HTTP service attempts an HTTP request to your configured `url`. |
-  * |5| `🔵Response`            | Response from your server.                                            |
-  * |6| `✅DESTROY\|UNLOCK`     | After your server returns a __`20x`__ response, the SDK deletes that record from the database.  Otherwise, the SDK will __`UNLOCK`__ that record and try again in the future. |
-  *
-  * &nbsp;
-  *
-  * ----------------------------------------------------------------------------------------------------------
-  *
-  * ## Controlling the SDK with HTTP Responses (*RPC*)
-  *
-  * The SDK has a *"Remote Procedure Call" (RPC)* mechanism, allowing you to invoke commands upon the SDK's API by returing a JSON response from the server containing the key `"background_geolocation": [...]`.
-  *
-  * Within the returned `[...]`, you may return one or more commands to invoke upon the SDK.  Each command takes the form of an `[]`, with a required first element `String command`, along with an optional
-  * second element `Argument:string|boolean|number|Object` depending upon the context of the `command`.
-  *
-  * @example
-  * ```javascript
-  * {
-  *   "background_geolocation": [
-  *     ["command1", argument:string|boolean|number|Object],
-  *     ["command2"]
-  *     .
-  *     .
-  *     .
-  *   ]
-  * }
-  * ```
-  *
-  * The SDK will run each of these commands synchronously upon itself.
-  *
-  * ### Supported RPC Commands
-  *
-  * | Command               | Arguments                   | Description                               |
-  * |-----------------------|-----------------------------|-------------------------------------------|
-  * | `start`               | None. | `BackgroundGeolocation.start()` |
-  * | `stop`                | None. | `BackgroundGeolocation.stop()` |
-  * | `startGeofences`      | None. | `BackgroundGeolocation.startGeofences()` |
-  * | `changePace`          | `Boolean` | `BackgroundGeolocation.changePace(argument)` |
-  * | `setConfig`           | `{Config}` | `BackgroundGeolocation.setConfig(argument)` |
-  * | `addGeofence`         | `{Geofence}` | `BackgroundGeolocation.addGeofence(argument)` |
-  * | `addGeofences`        | `[{Geofence}, ...]` | `BackgroundGeolocation.addGeofences(argument)` |
-  * | `removeGeofence`      | `identifier:String` | `BackgroundGeolocation.removeGeofence(argument)` |
-  * | `removeGeofences`     | None or `[identifier:String,...]` | `BackgroundGeolocation.removeGeofences(argument)` If provided no argument, remove all; otherwise remove provided list of identifiers |
-  * | `uploadLog`           | `url:String` | The url to upload log to. |
-  * | `destroyLog`          | None | `BackgroundGeolocation.destroyLog` |
-  *
-  * ### Simple Example: `#stop`
-  *
-  * Your server could return a response telling the SDK to [[BackgroundGeolocation.stop]]:
-  *
-  * @example
-  * ```json
-  * {
-  *   "background_geolocation": [
-  *     ["stop"]
-  *   ]
-  * }
-  * ```
-  *
-  * When returning just a single command, you can optionally omit the root `[ ]`:
-  *
-  * @example
-  * ```json
-  * {
-  *   "background_geolocation": ["stop"]
-  * }
-  * ```
-  *
-  * ### Arguments
-  *
-  * The 2nd param to each action is optional but depends upon the context of the command.  For example, `#changePace` requires a `boolean` argument:
-  *
-  * @example
-  * ```json
-  * {
-  *   "background_geolocation": [
-  *     ["changePace", true]
-  *   ]
-  * }
-  * ```
-  *
-  * ### Object Arguments
-  *
-  * Some commands receive an `{ }` argument, like `#setConfig`:
-  *
-  * @example
-  * ```json
-  * {
-  *   "background_geolocation": ["setConfig", {"distanceFilter": 0, "locationUpdateInterval": 1000}]
-  * }
-  * ```
-  *
-  * ### Multiple Actions
-  *
-  * You could tell the plugin to both `#start` and `#changePace`:
-  *
-  * @example
-  * ```json
-  * {
-  *   "background_geolocation": [
-  *     ["start"],
-  *     ["changePace", true]
-  *   ]
-  * }
-  * ```
-  */
-  interface HttpEvent {
-    /**
-    * True if the HTTP request was successful (eg: `200`, `201`, `204`).
-    */
-    success: boolean;
-    /**
-    * HTTP status code (eg: `200`, `500`, `404`).
-    */
-    status: number;
-    /**
-    * HTTP response text provided by the server.
-    */
-    responseText: string;
-  }
-}

package/dist/declarations/Location.d.ts

@@ -1,225 +0,0 @@
-/// <reference path="./GeofenceEvent.d.ts" />
-/// <reference path="./MotionActivityEvent.d.ts" />
-/// <reference path="./ProviderChangeEvent.d.ts" />
-/// <reference path="../types.d.ts" />
-///
-declare module "@transistorsoft/capacitor-background-geolocation" {
-  /**
-  * This object is attached to instances of [[Location.coords]].
-  */
-  interface Coords {
-    /**
-    * __[iOS Only]__ When the environment contains indoor-tracking hardware (eg: bluetooth beacons) the current floor within a building.
-    */
-    floor?: number;
-    /**
-    * Latitude of the location.
-    */
-    latitude: number;
-    /**
-    * Longitude of the location.
-    */
-    longitude: number;
-    /**
-    * Accuracy in meters.
-    */
-    accuracy: number;
-    /**
-    * [iOS] Altitude above sea-level in meters.
-    * [Android] The altitude of this location in meters above the WGS84 reference ellipsoid.
-    * - See [[ellipsoidal_altitude]]
-    *
-    */
-    altitude?: number;
-    /**
-    * The altitude of this location in meters above the WGS84 reference ellipsoid.
-    */
-    ellipsoidal_altitude?: number;
-    /**
-    * Altitude accuracy in meters.
-    *
-    * If this location does not have `altitude_accuracy`, then `-1` is returned.
-    *
-    * ## iOS
-    *
-    * When this property contains 0 or a positive number, the value in the altitude property is plus or minus the specified number of meters. When this property contains a negative number, the value in the altitude property is invalid.
-    *
-    * Determining the [altitudeAccuracy] requires a device with GPS capabilities. Thus, on some devices, this property always contains a negative value.
-    *
-    * ## Android
-    *
-    * Android defines vertical accuracy at 68% confidence. Specifically, as 1-side of the 2-sided range above and below the estimated altitude reported by [altitude], within which there is a 68% probability of finding the true altitude.
-    *
-    * In the case where the underlying distribution is assumed Gaussian normal, this would be considered 1 standard deviation.
-    *
-    * For example, if [altitude] returns `150`, and [verticalAccuracy] returns `20` then there is a 68% probability of the true altitude being between `130` and `170` meters.
-    *
-    */
-    altitude_accuracy?: number;
-    /**
-    * Heading in degrees.
-    * ⚠️ Note:  Only present when location came from GPS.  `-1` otherwise.
-    */
-    heading?: number;
-    /**
-    * Heading accuracy in degrees.
-    * ⚠️ Note:  Only present when location came from GPS.  `-1` otherwise.
-    */
-    heading_accuracy?: number;
-    /**
-    * Speed in meters / second.
-    * ⚠️ Note:  Only present when location came from GPS.  `-1` otherwise.
-    */
-    speed?: number;
-    /**
-    * Speed accuracy in meters / second.
-    * ⚠️ Note:  Only present when location came from GPS.  `-1` otherwise.
-    */
-    speed_accuracy?: number;
-  }
-
-  /**
-  * This object is attached to instances of [[Location.battery]].
-  */
-  interface Battery {
-    /**
-    * `true` when device is plugged in to power.
-    */
-    is_charging: boolean;
-    /**
-    * Battery level.  `0.0` = empty; `1.0` = full charge.
-    */
-    level: number;
-  }
-
-  /**
-   * ## Javascript Callback Schema
-   * @example
-   * ```
-   * {
-   *    "timestamp":     [Date],     // <-- Javascript Date instance
-   *    "event":         [String],    // <-- motionchange|geofence|heartbeat
-   *    "is_moving":     [Boolean],  // <-- The motion-state when location was recorded.
-   *    "uuid":          [String],   // <-- Universally unique identifier
-   *    "coords": {
-   *        "latitude":  [Double],
-   *        "longitude": [Double],
-   *        "accuracy":  [Double],
-   *        "speed":     [Double],
-   *        "heading":   [Double],
-   *        "altitude":  [Double]
-   *        "ellipsoidal_altitude":  [Double]
-   *    },
-   *    "activity": {
-   *        "type": [still|on_foot|walking|running|in_vehicle|on_bicycle],
-   *        "confidence": [0-100%]
-   *    },
-   *    "battery": {
-   *        "level": [Double],
-   *        "is_charging": [Boolean]
-   *    },
-   *    "odometer": [Double/meters]
-   * }
-   * ```
-
-  ## HTTP POST Schema
-
-  The location-data schema POSTed to your server takes the following form:
-   * @example
-   * ```
-   * {
-   *     "location": {
-   *         "coords": {
-   *             "latitude":   [Double],
-   *             "longitude":  [Double],
-   *             "accuracy":   [Double],
-   *             "speed":      [Double],
-   *             "heading":    [Double],
-   *             "altitude":   [Double],
-   *             "ellipsoidal_altitude": [Double]
-   *         },
-   *         "extras": {   // <-- optional meta-data
-   *             "foo": "bar"
-   *         },
-   *         "activity": {
-   *             "type": [still|on_foot|walking|running|in_vehicle|on_bicycle|unknown],
-   *             "confidence": [0-100%]
-   *         },
-   *         "geofence": {  // <-- Present only if a geofence was triggered at this location
-   *             "identifier": [String],
-   *             "action": [String ENTER|EXIT]
-   *         },
-   *         "battery": {
-   *             "level": [Double],
-   *             "is_charging": [Boolean]
-   *         },
-   *         "timestamp": [ISO-8601 UTC], // eg:  "2015-05-05T04:31:54.123Z"
-   *         "uuid":      [String],       // <-- Universally unique identifier
-   *         "event"      [String],       // <-- motionchange|geofence|heartbeat
-   *         "is_moving": [Boolean],      // <-- The motion-state when recorded.
-   *         "odometer": [Double/meters]
-   *     }
-   *  }
-   * ```
-   *
-   */
-  export interface Location {
-    /**
-    * `ISO-8601 UTC` timestamp provided by the native location API.
-    */
-    timestamp: string;
-    /**
-    * Distance-traveled in meters.
-    * ℹ️
-    * - [[BackgroundGeolocation.resetOdometer]]
-    * - [[BackgroundGeolocation.getOdometer]]
-    */
-    odometer: number;
-    /**
-    * `true` if location was recorded while plugin is in the *moving* state.
-    */
-    is_moving: boolean;
-    /**
-    * Universally Unique Identifier.  You can use this to match locations recorded at your server with those in the logs.
-    * It can also be used to ensure if the plugin has ever posted the same location *twice*.
-    */
-    uuid: string;
-    /**
-    * Event responsible for generating this location (`motionchange`, `providerchange`, `geofence`, `heartbeat`).
-    */
-    event?: string;
-    /**
-    * Present (and `true`) if the location was generated by a "Fake Location" application or simulator.
-    */
-    mock?: boolean;
-    /**
-    * `true` if the plugin is currently waiting for the best possible location to arrive.  Samples are recorded when the plugin is transitioning between motion-states (*moving* vs *stationary*) or [[BackgroundGeolocation.getCurrentPosition]].
-    * If you're manually posting location to your server, you should not persist these "samples".
-    */
-    sample?: boolean;
-    /**
-    * `latitude`, `longitude`, `speed`, `heading`, etc.
-    */
-    coords: Coords;
-    /**
-    * Device battery level when the location was recorded.
-    */
-    battery: Battery;
-    /**
-    * Optional arbitrary meta-data attached to this location.
-    */
-    extras?: Extras;
-    /**
-    * If this location was recorded due to a geofence transition, the corresponding geofence-event.
-    */
-    geofence?: GeofenceEvent;
-    /**
-    * Device motion-activity when this location was recorded (eg: `still`, `on_foot`, `in_vehicle`).
-    */
-    activity: MotionActivityEvent;
-    /**
-    * If this location was recorded due to [[ProviderChangeEvent]], this is a reference to the location-provider state.
-    */
-    provider?: ProviderChangeEvent;
-  }
-}

package/dist/declarations/LocationAuthorizationAlert.d.ts

@@ -1,41 +0,0 @@
-declare module "@transistorsoft/capacitor-background-geolocation" {
-	/**
-	* __`[iOS only]`__ Controls the text-elements of the plugin's location-authorization dialog.
-  *
-  * When you configure the plugin [[locationAuthorizationRequest]] __`Always`__ or __`WhenInUse`__ and the user *changes* the mode in the app's location-services settings or disabled location-services, the plugin will display an Alert dialog directing the user to the **Settings** screen.  **`locationAuthorizationAlert`** allows you to configure all the Strings for that Alert popup and accepts an `{}` containing the following keys:
-	*
-	* ![](https://dl.dropboxusercontent.com/s/wyoaf16buwsw7ed/docs-locationAuthorizationAlert.jpg?dl=1)
-	*/
-  interface LocationAuthorizationAlert {
-  	/**
-  	* The title of the alert if user changes, for example, the location-request to `WhenInUse` when you requested `Always`.
-  	*
-  	* Defaults to `Location services are off`.
-		*/
-    titleWhenOff: string;
-    /**
-    * The title of the alert when user disables location-services or changes the authorization request to `Never`.
-    *
-    * Defaults to `Background location is not enabled`.
-    */
-    titleWhenNotEnabled: string;
-    /**
-    * The body text of the alert.
-    *
-    * Defaults to: `To use background location, you must enable {locationAuthorizationRequest} in the Location Services settings`.
-    */
-    instructions: string;
-    /**
-    * Cancel button label.
-    *
-    * Defaults to `Cancel`.
-    */
-    cancelButton: string;
-    /**
-    * Settings button label.
-    *
-    * Defaults to `Settings`.
-    */
-    settingsButton: string;
-  }
-}