react-native-background-geolocation 4.3.0

package/src/declarations/interfaces/PermissionRationale.d.ts

@@ -0,0 +1,31 @@
+/// <reference path="../types.d.ts" />
+///
+declare module "react-native-background-geolocation" {
+
+  /**
+  * __[Android only]__ Configuration for showing an android dialog prior to forwarding the user to a permission settings-screen.
+  *
+  */
+  interface PermissionRationale {
+    /**
+    * The title of the dialog window.
+    */
+    title?: string;
+
+    /**
+    * The body text of the dialog.
+    * Provide an explanation of why you need this permission, similar in purpose to iOS' __`NSLocationAlwaysAndWhenInUseUsageDescription`__.
+    */
+    message?: string;
+
+    /**
+    * The text to display on the *positive action* button.
+    */
+    positiveAction?: string;
+
+    /**
+    * The text to display on the *negative action* button (eg: *Cancel*)
+    */
+    negativeAction?: string;
+  }
+}

package/src/declarations/interfaces/ProviderChangeEvent.d.ts

@@ -0,0 +1,74 @@
+/// <reference path="../types.d.ts" />
+
+declare module "react-native-background-geolocation" {
+  /**
+  * The event-object provided to [[BackgroundGeolocation.onProviderChange]]
+  *
+  * @example
+  * ```typescript
+  * BackgroundGeolocation.onProviderChange(providerChangeEvent => {
+  *   console.log("[providerchange] ", provider.enabled, provider.status, provider.network, provider.gps);
+  * });
+  * ```
+  */
+  interface ProviderChangeEvent {
+    /**
+    * `true` When device location-services are enabled.
+    */
+    enabled: boolean;
+    /**
+    * Authorization status of location-services.  For iOS, this will tell you if the user has enabled "Always" or "When in Use" authorization.
+    *
+    * | Name                                    | Platform      |
+    * |-----------------------------------------|---------------|
+    * | [[AUTHORIZATION_STATUS_NOT_DETERMINED]] | iOS only      |
+    * | [[AUTHORIZATION_STATUS_RESTRICTED]]     | iOS only      |
+    * | [[AUTHORIZATION_STATUS_DENIED]]         | iOS & Android |
+    * | [[AUTHORIZATION_STATUS_ALWAYS]]         | iOS & Android |
+    * | [[AUTHORIZATION_STATUS_WHEN_IN_USE]]    | iOS only      |
+    *
+    * ### ℹ️ Note:
+    * - When Android location permission is **granted**, `status` == [[AUTHORIZATION_STATUS_ALWAYS]], otherwise [[AUTHORIZATION_STATUS_DENIED]].
+    */
+    status: AuthorizationStatus;
+    /**
+    * `true` if network geolocation provider is available.
+    */
+    network: boolean;
+    /**
+    * `true` if GPS geolocation provider is available.
+    */
+    gps: boolean;
+    /**
+    * __`[iOS 14+]`__ iOS 14 has introduced a new __`[Precise: On]`__ switch on the location authorization dialog allowing users to disable high-accuracy location.
+    *
+    * This attribute shows the state of that switch:
+    * - Enabled:  [[BackgroundGeolocation.ACCURACY_AUTHORIZATION_FULL]].
+    * - Disabled, [[BackgroundGeolocation.ACCURACY_AUTHORIZATION_REDUCED]].
+    *
+    * ![](https://dl.dropbox.com/s/dj93xpg51vspqk0/ios-14-precise-on.png?dl=1)
+    *
+    * @example
+    *
+    * ```javascript
+    * BackgroundGeolocation.onProviderChange((event) => {
+    *   let authorizationStatus = event.authorizationStatus;
+    *   if (authorizationStatus == BackgroundGeolocation.ACCURACY_AUTHORIZATION_REDUCED) {
+    *     // Supply "Purpose" key from Info.plist as 1st argument.
+    *     BackgroundGeolocaiton.requestTemporaryFullAccuracy("Delivery").then((accuracyAuthorization) => {
+    *       console.log("[requestTemporaryFullAccuracy]: ", accuracyAuthorization);
+    *     }).catch((error) => {
+    *       console.warn("[requestTemporaryFullAccuracy] ERROR:", error);
+    *     });
+    *   }
+    * });
+    * ```
+    *
+    * __See also:__
+    * - [[BackgroundGeolocation.requestTemporaryFullAccuracy]]
+    * - [What's new in iOS 14 `CoreLocation`](https://levelup.gitconnected.com/whats-new-with-corelocation-in-ios-14-bd28421c95c4)
+    *
+    */
+    accuracyAuthorization: AccuracyAuthorization;
+  }
+}

package/src/declarations/interfaces/SQLQuery.d.ts

@@ -0,0 +1,60 @@
+declare module "react-native-background-geolocation" {
+  /**
+  * Used for selecting a range of records from the SDK"s database.
+  * Used with the methods:
+  * - [[Logger.getLog]]
+  * - [[Logger.emailLog]]
+  * - [[Logger.uploadLog]]
+  *
+  * ```typescript
+  * // Constrain results between optionl start/end dates using a SQLQuery
+  * let log = await BackgroundGeolocation.logger.getLog({
+  *   start: Date.parse("2019-10-21 13:00"),  // <-- optional HH:mm:ss
+  *   end: Date.parse("2019-10-22")
+  * });
+  *
+  * // Or just a start date
+  * let log = await BackgroundGeolocation.logger.getLog({
+  *   start: Date.parse("2019-10-21 13:00")
+  * });
+  *
+  * // Or just an end date
+  * BackgroundGeolocation.logger.uploadLog("http://my.server.com/users/123/logs", {
+  *   end: Date.parse("2019-10-21")
+  * ));
+  *
+  * // Select first 100 records from log
+  * let Logger = BackgroundGeolocation.logger;
+  * Logger.emailLog("foo@bar.com", {
+  *   order: Logger.ORDER_ASC,
+  *   limit: 100
+  * ));
+  *
+  * // Select most recent 100 records from log
+  * let Logger = BackgroundGeolocation.logger;
+  * Logger.emailLog("foo@bar.com", {
+  *   order: Logger.ORDER_DESC,
+  *   limit: 100
+  * ));
+  * ```
+  */
+  interface SQLQuery {
+  	/**
+  	* Start date of logs to select (unix timestamp)
+  	*/
+    start?:number;
+    /**
+    * End date of logs to select (unix timestamp)
+    */
+    end?:number;
+    /**
+    * Limit number of records returned.
+    */
+    limit?:number;
+    /**
+    * Order of results [[Logger.ORDER_ASC]] or [[Logger.ORDER_DESC]].
+    * `1` = `ASC`; `-1` = `DESC`.
+    */
+    order?:SQLQueryOrder;
+  }
+}

package/src/declarations/interfaces/Sensors.d.ts

@@ -0,0 +1,31 @@
+declare module "react-native-background-geolocation" {
+	/**
+	* Detected device sensors related to motion-detection.
+	*/
+	interface Sensors {
+  	/**
+  	* `ios` | `android`
+  	*/
+    platform: string;
+    /**
+    * `true` when the device has an accelerometer.
+    */
+    accelerometer: boolean;
+    /**
+    * `true` when the device has a magnetometer (compass).
+    */
+    magnetometer: boolean;
+    /**
+    * `true` when the device has a gyroscope.
+    */
+    gyroscope: boolean;
+    /**
+    * __[Android only]__ `true` when the Android device has significant motion hardware.
+    */
+    significant_motion?: boolean;
+    /**
+    * __[iOS only]__ `true` when the device has an __M7__ motion co-processor (iPhone 5S and up).
+    */
+    motion_hardware?: boolean;
+  }
+}

package/src/declarations/interfaces/State.d.ts

@@ -0,0 +1,51 @@
+/// <reference path="./Config.d.ts" />
+
+declare module "react-native-background-geolocation" {
+	/**
+	* This `State` object contains all the provided [[Config]] options in addition to:
+	* - [[enabled]].
+	* - [[schedulerEnabled]].
+	* - [[trackingMode]].
+	* - [[odometer]].
+  * - [[didLaunchInBackground]].
+  * - [[didDeviceReboot]]
+	*/
+  interface State extends Config {
+  	/**
+  	* `true` when the SDK has been enabled via methods [[start]] or [[startGeofences]].  When `false`, the
+  	* SDK is completely __OFF__.  No tracking of any kind will occur.  The SDK will consume no energy.
+  	*/
+    enabled: boolean;
+    /**
+    * `true` when the SDK is currently configured with a [[schedule]] and [[startSchedule]] has been executed.
+    * [[stopSchedule]] will set this to `false`.
+    */
+    schedulerEnabled: boolean;
+    /**
+    | Value      | Description                       |
+  	|------------|-----------------------------------|
+  	| __`0`__    | Monitoring geofences only         |
+  	| __`1`__    | Monitoring location + geofences   |
+    */
+    trackingMode: TrackingMode;
+    /**
+    * The current distance-traveled.
+    * ### ℹ️ See also:
+    * - [[resetOdometer]], [[setOdometer]]
+    * - [[getOdometer]]
+    */
+    odometer: number;
+    /**
+    * `true` when the iOS app was launched in the background.  Always `false` for Android.
+    * iOS apps can be launched in the background due to a background-fetch event, geofence events or exiting the [[Config.stationaryRadius]].
+    *
+    * One might use this flag to choose to load only minimal resources until the iOS app is determined to have launched into the foreground.
+    *
+    */
+    didLaunchInBackground: boolean;
+    /**
+    * Indicates if the app was launched after the device was rebooted.
+    */
+    didDeviceReboot: boolean;
+  }
+}

package/src/declarations/interfaces/TransistorAuthorizationToken.d.ts

@@ -0,0 +1,63 @@
+declare module "react-native-background-geolocation" {
+  /**
+  * Response object returned by [[BackgroundGeolocation.findOrCreateTransistorAuthorizationToken]] for configuring the SDK's [[Authorization]] with Transistor Software's Demo Server at [http://tracker.transistorsoft.com](http://tracker.transistorsoft.com).
+  *
+  * You may also run your own instance of Demo Server locally.  See [background-geolocation-console](https://github.com/transistorsoft/background-geolocation-console)
+  *
+  * The test server is a great way to debug location problems or evalute the SDK's behaviour, since the results can easily be shared with *Transistor Software* when requesting support.
+  *
+  * ![](https://dl.dropboxusercontent.com/s/3abuyyhioyypk8c/screenshot-tracker-transistorsoft.png?dl=1)
+  *
+  *
+  * @example
+  * ```typescript
+  * // Url to demo server.
+  * let url = "http://tracker.transistorsoft.com";
+  * let orgname = "my-company-name";
+  * let username = "my-username";
+  *
+  * // Fetch an authoriztion token from server.  The SDK will cache the received token.
+  * let token = await
+  *   BackgroundGeolocation.findOrCreateTransistorAuthorizationToken(orgname, username, url);
+  *
+  * BackgroundGeolocation.ready({
+  *   transistorAuthorizationToken: token
+  * })
+  * ```
+  *
+  * ## Viewing Your Tracking Results
+  *
+  * To *view* your tracking results in the browser, use your configured "Organization Name" and visit:
+  *
+  * http://tracker.transistorsoft.com/my-organization-name
+  *
+  */
+  interface TransistorAuthorizationToken {
+  	/**
+  	* The authorization token to provide to [[Authorization.accessToken]]
+    *
+    * @example
+    * ```typescript
+    * BackgroundGeolocation.ready({
+    *  authorization: {
+    *    accessToken:
+    *  }
+    * });
+    * ```
+  	*/
+  	accessToken:string;
+  	/**
+  	* The token used to request to provide to [[Authorization.refreshToken]]
+  	*/
+  	refreshToken:string;
+  	/**
+  	* The expiry time of the [[Authorization.accessToken]]
+  	*/
+  	expires:number;
+    /**
+    * The url to the Transistor Demo server where this token came from.
+    * __Read only__
+    */
+    url?: string;
+  }
+}

package/src/declarations/interfaces/WatchPositionRequest.d.ts

@@ -0,0 +1,45 @@
+declare module "react-native-background-geolocation" {
+	/**
+  * Options provided to [[BackgroundGeolocation.watchPosition]].
+  *
+  * @example
+  * ```typescript
+  * BackgroundGeolocation.watchPosition((location) => {
+	*   console.log("[watchPosition] -", location);
+  * }, (errorCode) => {
+	*   console.log("[watchPosition] ERROR -", errorCode);
+  * }, {
+	*   interval: 1000,
+	*   desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
+	*   persist: true,
+	*   extras: {foo: "bar"},
+	*   timeout: 60000
+  * });
+  * ```
+  */
+	interface WatchPositionRequest {
+		/**
+		* Location update interval in `milliseconds`.  Defaults to `1000`.
+		*/
+    interval?: number;
+    /**
+    * Specifies the accuracy required.  See [[Config.desiredAccuracy]].  Only [[BackgroundGeolocation.DESIRED_ACCURACY_HIGH]] uses GPS.
+    * Defaults to [[DESIRED_ACCURACY_HIGH]].
+    */
+    desiredAccuracy?: LocationAccuracy;
+    /**
+    * Set `true` to persist each recorded location to the plugin's database.
+    * Defaults to `true` when [[State.enabled]], `false` otherwise.
+    */
+    persist?: boolean;
+    /**
+    * Arbitrary key/values to append to each recorded location.
+    */
+    extras?: Extras;
+    /**
+    * Time in `milliseconds` to wait before firing error callback when location fails to arrive.
+    * Defaults to `60000`.
+    */
+    timeout?: number;
+  }
+}

package/src/declarations/types.d.ts

@@ -0,0 +1,170 @@
+declare module "react-native-background-geolocation" {
+	/**
+	* Recognized event names available as constants upon the [[BackgroundGeolocation]] class.
+	*
+	* ```javascript
+	* // eg
+	* BackgroundGeolocation.EVENT_LOCATION)
+	* > "location"
+	*
+	* BackgoundGeolocation.EVENT_MOTIONCHANGE;
+	* > "motionchange"
+	*
+	* ```
+	*
+	* | Name                                | Value     |
+	* |-------------------------------------|-----------|
+	* | [[EVENT_BOOT]] 						| `boot` |
+	* | [[EVENT_TERMINATE]] 				| `terminate` |
+	* | [[EVENT_LOCATION]] 					| `location` |
+	* | [[EVENT_MOTIONCHANGE]] 				| `motionchange` |
+	* | [[EVENT_HTTP]] 						| `http` |
+	* | [[EVENT_HEARTBEAT]] 				| `heartbeat` |
+	* | [[EVENT_PROVIDERCHANGE]] 			| `providerchange` |
+	* | [[EVENT_ACTIVITYCHANGE]] 			| `activitychange` |
+	* | [[EVENT_GEOFENCE]] 					| `geofence` |
+	* | [[EVENT_GEOFENCESCHANGE]] 			| `geofenceschange` |
+	* | [[EVENT_ENABLEDCHANGE]] 			| `enabledchange` |
+	* | [[EVENT_CONNECTIVITYCHANGE]] 		| `connectivitychange` |
+	* | [[EVENT_SCHEDULE]] 					| `schedule` |
+	* | [[EVENT_POWERSAVECHANGE]] 			| `powersavechange` |
+	* | [[EVENT_NOTIFICATIONACTION]] 		| `notificationaction` |
+	* | [[EVENT_AUTHORIZATION]] 			| `authorization` |
+	*/
+	export type Event = "boot"
+		| "terminate"
+		| "location"
+		| "motionchange"
+		| "http"
+		| "heartbeat"
+		| "providerchange"
+		| "activitychange"
+		| "geofence"
+		| "geofenceschange"
+		| "enabledchange"
+		| "connectvitychange"
+		| "schedule"
+		| "powersavechange"
+		| "notificationaction"
+		| "authorization";
+
+	/**
+	* Controls the volume of [[Config.logLevel]] log-entries recorded to database.
+	*
+	* | Label                      |
+	* |----------------------------|
+	* | [[LOG_LEVEL_OFF]]     |
+	* | [[LOG_LEVEL_ERROR]]   |
+	* | [[LOG_LEVEL_WARNING]] |
+	* | [[LOG_LEVEL_INFO]]    |
+	* | [[LOG_LEVEL_DEBUG]]   |
+	* | [[LOG_LEVEL_VERBOSE]] |
+	*/
+	export type LogLevel = 0 | 1 | 2 | 3 | 4 | 5;
+
+	/**
+	 * Used for [[Config.desiredAccuracy]].
+	 *
+	 * | Name                                 | Location Providers           | Description                             |
+	 * |--------------------------------------|------------------------------|-----------------------------------------|
+	 * | [[DESIRED_ACCURACY_NAVIGATION]]      | (**iOS only**) GPS + Wifi + Cellular | Highest power; highest accuracy.|
+	 * | [[DESIRED_ACCURACY_HIGH]]            | GPS + Wifi + Cellular | Highest power; highest accuracy.               |
+	 * | [[DESIRED_ACCURACY_MEDIUM]]          | Wifi + Cellular | Medium power; Medium accuracy;                       |
+	 * | [[DESIRED_ACCURACY_LOW]]             | Wifi (low power) + Cellular | Lower power; No GPS.                     |
+	 * | [[DESIRED_ACCURACY_VERY_LOW]]        | Cellular only | Lowest power; lowest accuracy.                         |
+	 * | [[DESIRED_ACCURACY_LOWEST]]          | (**iOS only**) | Lowest power; lowest accuracy.                        |
+	 */
+	type LocationAccuracy = -2 | -1 | 0 | 10 | 100 | 1000 | 3000;
+
+	/**
+	 * Used for [[Notification.priority]].
+	 *
+	 * | Value                             | Description                                                                                            |
+	 * |-----------------------------------|--------------------------------------------------------------------------------------------------------|
+	 * | [[NOTIFICATION_PRIORITY_DEFAULT]] | Notification weighted to top of list; notification-bar icon weighted left.                             |
+	 * | [[NOTIFICATION_PRIORITY_HIGH]]    | Notification **strongly** weighted to top of list; notification-bar icon **strongly** weighted to left.|
+	 * | [[NOTIFICATION_PRIORITY_LOW]]     | Notification weighted to bottom of list; notification-bar icon weighted right.                         |
+	 * | [[NOTIFICATION_PRIORITY_MAX]]     | Same as `NOTIFICATION_PRIORITY_HIGH`.                                                                  |
+	 * | [[NOTIFICATION_PRIORITY_MIN]]     | Notification **strongly** weighted to bottom of list; notification-bar icon **hidden**.                |
+	 */
+	type NotificationPriority = 0 | 1 | -1 | 2 | -2;
+
+	/**
+	 * Used for [[Config.activityType]].
+	 *
+	 * | Name                                     |
+	 * |------------------------------------------|
+	 * | [[ACTIVITY_TYPE_OTHER]]                  |
+	 * | [[ACTIVITY_TYPE_AUTOMOTIVE_NAVIGATION]]  |
+	 * | [[ACTIVITY_TYPE_FITNESS]]                |
+	 * | [[ACTIVITY_TYPE_OTHER_NAVIGATION]]       |
+	 *
+	 * ℹ️  For more information, see [Apple docs](https://developer.apple.com/reference/corelocation/cllocationmanager/1620567-activitytype?language=objc).
+	 */
+	type ActivityType = 1 | 2 | 3 | 4;
+	/**
+	* | Name                                    | Platform      |
+	* |-----------------------------------------|---------------|
+	* | [[AUTHORIZATION_STATUS_NOT_DETERMINED]] | iOS only      |
+	* | [[AUTHORIZATION_STATUS_RESTRICTED]]     | iOS only      |
+	* | [[AUTHORIZATION_STATUS_DENIED]]         | iOS & Android |
+	* | [[AUTHORIZATION_STATUS_ALWAYS]]         | iOS & Android |
+	* | [[AUTHORIZATION_STATUS_WHEN_IN_USE]]    | iOS only      |
+	*/
+	type AuthorizationStatus = 0 | 1 | 2 | 3 | 4;
+
+	/**
+	* | Name                                    | Value     |
+	* |-----------------------------------------|-----------|
+	* | [[ACCURACY_AUTHORIZATION_FULL]] 		| 0     	|
+	* | [[ACCURACY_AUTHORIZATION_REDUCED]]     	| 1         |
+	*/
+	type AccuracyAuthorization = 0 | 1;
+
+	/**
+	* | Value    | Description                                                           |
+	* |----------|-----------------------------------------------------------------------|
+	* | `0`      | Geofences-only monitoring ([[BackgroundGeolocation.startGeofences]]). |
+	* | `1`      | Both location & Geofence monitoring.                                  |
+	*/
+	type TrackingMode = 0 | 1;
+
+	/**
+	* When native location API fails to fetch a location, one of the following error-codes will be returned.
+	*
+	* | Code  | Error                       |
+    * |-------|-----------------------------|
+    * | 0     | Location unknown            |
+    * | 1     | Location permission denied  |
+    * | 2     | Network error               |
+    * | 408   | Location timeout            |
+    * | 499   | Location request cancelled  |
+	*/
+	type LocationError = 0 | 1 | 2 | 408 | 499;
+
+	/**
+	* iOS Location authorization request.
+	* This is used to express the location authorization you *expect* the user have enabled.
+	*/
+	type LocationAuthorizationRequest = "Always" | "WhenInUse" | "Any";
+
+	/**
+	* Desired HTTP method to use when uploading data to your configured [[Config.url]].
+	*/
+	type HttpMethod = "POST" | "PUT" | "OPTIONS";
+
+	type PersistMode = -1 | 0 | 1 | 2;
+
+	type Extras = {[key: string]: string|null|number|boolean|Extras|string[]|number[]|boolean[]|Extras[]};
+
+	/**
+	* Controls ordering of [[SQLQuery.order]]
+	*
+	* | Name                 | Value |
+	* |----------------------|-------|
+	* | [[Logger.ORDER_ASC]] | `1`   |
+	* | [[Logger.ORDER_DESC]]| `-1`  |
+	*/
+	type SQLQueryOrder = -1 | 1;
+
+}