@transistorsoft/background-geolocation-types 5.0.0-beta.3 → 5.0.0-beta.5

package/dist/core/data/Location.d.ts

@@ -1,253 +1,40 @@
 import { ProviderChangeEvent } from '../events/ProviderChangeEvent';
 import { MotionActivityType } from '../../enums/MotionActivityType';
 import { GeofenceEvent } from '../events/GeofenceEvent';
-/**
- * This object is attached to instances of {@link Location.coords}.
- *
- * @category Data
-*/
 export 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 {@link 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 {@link Location.battery}.
-*
-* @category Data
-*/
 export interface Battery {
-    /**
-    * `true` when device is plugged in to power.
-    */
     is_charging: boolean;
-    /**
-    * Battery level.  `0.0` = empty; `1.0` = full charge.
-    */
     level: number;
 }
-/**
- * The last known motion-activity when this location was recorded.
- *
- * @category Data
- */
 export interface MotionActivity {
-    /**
-    * The reported device {@link MotionActivityType motion activity} (eg: `still`, `on_foot`, `in_vehicle`).
-    */
     type: MotionActivityType;
-    /**
-     * Confidence of the reported device motion activity in %.
-     */
     confidence: number;
 }
-/**
- * A `Location` object represents a geographic location captured by the device's native location API.
- *
- * - `CLLocationManager` delivers instance of `CLLocation` on iOS
- * - `FusedLocationProviderClient` deliver instance of `android.location.Location` on Android
- *
- * __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
- *    "age":           [Integer],  // <-- Age of the location in milliseconds
- *    "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"
- *         "age":       [Integer],      // <-- Age of the location in milliseconds
- *         "uuid":      [String],       // <-- Universally unique identifier
- *         "event"      [String],       // <-- motionchange|geofence|heartbeat
- *         "is_moving": [Boolean],      // <-- The motion-state when recorded.
- *         "odometer": [Double/meters]
- *     }
- *  }
- * ```
- *
- * @category Data
- */
 export interface Location {
-    /**
-    * `ISO-8601 UTC` timestamp provided by the native location API.
-    */
     timestamp: string;
-    /**
-     * The age of the location in milliseconds, relative to the Device system-time when the location was received.
-     * For example, if the reported `age` is `10000`, that location was recorded 10s ago, relative to the system-time.
-     * `location.timestamp` + `location.age` = Device system-time when location was recorded.
-    */
     age: number;
-    /**
-    * Distance-traveled in meters.
-    * ℹ️
-    * - {@link BackgroundGeolocation.resetOdometer}
-    * - {@link 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?: Record<string, any>;
-    /**
-    * 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: MotionActivity;
-    /**
-    * If this location was recorded due to {@link ProviderChangeEvent}, this is a reference to the location-provider state.
-    */
     provider?: ProviderChangeEvent;
 }

package/dist/core/data/Sensors.d.ts

@@ -1,30 +1,8 @@
-/**
-* Detected device sensors related to motion-detection.
-* @category Data
-*/
 export 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/dist/core/events/AuthorizationEvent.d.ts

@@ -1,15 +1,6 @@
-/**
- * Emitted by {@link BackgroundGeolocation.onAuthorization}.
- *
- * @category Events
- */
 export interface AuthorizationEvent {
-    /** HTTP status returned from your Authorization.refreshUrl (or 0 if failed). */
     status: number;
-    /** True when the authorization request succeeded. */
     success: boolean;
-    /** Error message when success is false; otherwise null. */
     error: string | null;
-    /** Decoded JSON response when success is true; otherwise null. */
     response: any;
 }

package/dist/core/events/ConnectivityChangeEvent.d.ts

@@ -1,9 +1,3 @@
-/**
- * Emitted by {@link BackgroundGeolocation.onConnectivityChange}.
- *
- * @category Events
- */
 export interface ConnectivityChangeEvent {
-    /** True when the device has network connectivity. */
     connected: boolean;
 }

package/dist/core/events/GeofenceEvent.d.ts

@@ -1,19 +1,9 @@
 import type { Location } from '../data/Location';
 import type { GeofenceAction } from '../../enums/GeofenceAction';
-/**
- * Emitted by {@link BackgroundGeolocation.onGeofence}.
- *
- * @category Events
- */
 export interface GeofenceEvent {
-    /** Device system time when the OS received the geofence event. */
     timestamp: string;
-    /** Identifier of the geofence which fired. */
     identifier: string;
-    /** Transition type: 'ENTER' | 'EXIT' | 'DWELL'. */
     action: GeofenceAction;
-    /** Location where the geofence transition occurred. */
     location: Location;
-    /** Optional extras originally configured on the Geofence. */
     extras?: Record<string, any>;
 }

package/dist/core/events/GeofencesChangeEvent.d.ts

@@ -1,12 +1,5 @@
 import type { Geofence } from '../data/Geofence';
-/**
- * Emitted by {@link BackgroundGeolocation.onGeofencesChange}.
- *
- * @category Events
- */
 export interface GeofencesChangeEvent {
-    /** Geofences that have just been activated. */
     on: Geofence[];
-    /** Identifiers of geofences that have just been de-activated (or removed). */
     off: string[];
 }

package/dist/core/events/HeadlessEvent.d.ts

@@ -1,12 +1,5 @@
 import type { Event } from '../../enums/Event';
-/**
- * Event for Android headless tasks registered via {@link BackgroundGeolocation.registerHeadlessTask}
- *
- * @category Events
- */
 export interface HeadlessEvent {
-    /** BackgroundGeolocation event name (e.g., 'location', 'http', 'terminate'). */
     name: Event;
-    /** General event params according to the event context. */
     params: Record<string, any>;
 }

package/dist/core/events/HeartbeatEvent.d.ts

@@ -1,14 +1,4 @@
 import type { Location } from '../data/Location';
-/**
- * Emitted by {@link BackgroundGeolocation.onHeartbeat}.
- *
- * @category Events
- */
 export interface HeartbeatEvent {
-    /**
-     * The last-known location.
-     * Note: Heartbeat does not actively engage location-services.
-     * Use getCurrentPosition for a fresh fix.
-     */
     location: Location;
 }

package/dist/core/events/HttpEvent.d.ts

@@ -1,13 +1,5 @@
-/**
- * Emitted by {@link BackgroundGeolocation.onHttp}.
- *
- * @category Events
- */
 export interface HttpEvent {
-    /** True if HTTP request succeeded (e.g., 200, 201, 204). */
     success: boolean;
-    /** HTTP status code (e.g., 200, 500, 404). */
     status: number;
-    /** HTTP response text provided by the server. */
     responseText: string;
 }

package/dist/core/events/MotionActivityEvent.d.ts

@@ -1,12 +1,5 @@
 import type { MotionActivityType } from '../../enums/MotionActivityType';
-/**
- * Emitted by {@link BackgroundGeolocation.onActivityChange}.
- *
- * @category Events
- */
 export interface MotionActivityEvent {
-    /** Reported device motion activity. */
     activity: MotionActivityType;
-    /** Confidence of the reported activity in percent. */
     confidence: number;
 }

package/dist/core/events/MotionChangeEvent.d.ts

@@ -1,12 +1,5 @@
 import type { Location } from '../data/Location';
-/**
- * Emitted by {@link BackgroundGeolocation.onMotionChange}.
- *
- * @category Events
- */
 export interface MotionChangeEvent {
-    /** True when moving; false when stationary. */
     isMoving: boolean;
-    /** Location associated with the motionchange. */
     location: Location;
 }

package/dist/core/events/ProviderChangeEvent.d.ts

@@ -1,17 +1,7 @@
-/**
- * Emitted by {@link BackgroundGeolocation.onProviderChange}.
- *
- * @category Events
- */
 export interface ProviderChangeEvent {
-    /** True when device location-services are enabled. */
     enabled: boolean;
-    /** Authorization status for location-services (platform numeric). */
     status: number;
-    /** True if network geolocation provider is available. */
     network: boolean;
-    /** True if GPS geolocation provider is available. */
     gps: boolean;
-    /** iOS 14+ "Precise" authorization (platform numeric FULL/REDUCED). */
     accuracyAuthorization: number;
 }

package/dist/core/events/Subscription.d.ts

@@ -1,86 +1,3 @@
-/**
-  * Object returned by BackgroundGeolocation event-listeners.
-  *
-  * `Subscription` contains just a single method {@link remove}, used for removing an event-listener.
-  *
-  * - {@link BackgroundGeolocation.onLocation}
-  * - {@link BackgroundGeolocation.onMotionChange}
-  * - {@link BackgroundGeolocation.onHttp}
-  * - {@link BackgroundGeolocation.onHeartbeat}
-  * - {@link BackgroundGeolocation.onProviderChange}
-  * - {@link BackgroundGeolocation.onActivityChange}
-  * - {@link BackgroundGeolocation.onGeofence}
-  * - {@link BackgroundGeolocation.onGeofencesChange}
-  * - {@link BackgroundGeolocation.onEnabledChange}
-  * - {@link BackgroundGeolocation.onConnectivityChange}
-  * - {@link BackgroundGeolocation.onSchedule}
-  * - {@link BackgroundGeolocation.onPowerSaveChange}
-  * - {@link BackgroundGeolocation.onNotificationAction}
-  * - {@link BackgroundGeolocation.onAuthorization}
-  *
-  * __Removing an event-listener__:
-  *
-  * @example
-  * ```typescript
-  * // Event-listeners return a Subscription instance, containing a .remove() method.
-  * const subscription = BackgroundGeolocation.onLocation(location => {
-  *   console.log("[onLocation] ", location);
-  * });
-  * .
-  * .
-  * .
-  * // Later, to remove the event-listener:
-  * subscription.remove();
-  * ```
-  *
-  * One might typically manage a collection of `Subscription` instances
-  *
-  * @example
-  * ```typescript
-  * import BackgroundGeolocation, {
-  *   Location,
-  *   Subscription
-  * } from ...
-  *
-  * // Your custom Collection of Subscription instances.
-  * const SUBSCRIPTIONS = [];
-  *
-  * // Your custom method to push a Subscription instance.
-  * const subscribe = (subscription:Subscription) => {
-  *   SUBSCRIPTIONS.push(subscription);
-  * }
-  *
-  * // Your custom method to interate your SUBSCRIPTIONS and .remove each.
-  * const unsubscribe = () => {
-  *   SUBSCRIPTIONS.forEach((subscription:Subscription) => subscription.remove());
-  * }
-  *
-  * const initBackgroundGeolocation = () {
-  *   // Create event-listeners as usual, feeding the returned Subscription into
-  *   // your custom  subscribe() method.
-  *   subscribe(BackgroundGeolocation.onLocation((location:Location) => {
-  *     console.log('[onLocation]', location);
-  *   });
-  *
-  *   subscribe(BackgroundGeolocation.onMotionChange((location:Location) => {
-  *     console.log('[onMotionChange]', location);
-  *   });
-  *
-  *   subscribe(BackgroundGeolocation.onEnabledChange((enabled:boolean) => {
-  *     console.log('[onEnabledChange]', enabled);
-  *   });
-  * }
-  *
-  * const onDestroyView = () => {
-  *   // Call your custom unsubscribe method
-  *   unsubscribe();
-  * }
-  *
-  * ```
-  *
-  * @category Events
-  */
 export interface Subscription {
-    /** Remove the event-listener. */
     remove(): void;
 }

package/dist/docs-entry.js

@@ -1,7 +1,4 @@
 "use strict";
-// Docs-only barrel so TypeDoc can include deprecated LegacyConfig
-// without exporting it from the package root.
-// Consumers import from package root, which intentionally hides LegacyConfig.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/dist/enums/AccuracyAuthorization.d.ts

@@ -1,21 +1,5 @@
-/**
- * Accuracy authorization granted by the user.
- *
- * | Name                | Value | Description                |
- * |---------------------|:-----:|-----------------------------|
- * | Full                |  0    | Full accuracy authorized.  |
- * | Reduced             |  1    | Reduced accuracy granted.  |
- *
- * Mirrors iOS `CLAccuracyAuthorization` and Android location accuracy permission levels.
- *
- * @category Events
- */
 export declare const AccuracyAuthorization: {
     readonly Full: 0;
     readonly Reduced: 1;
 };
-/**
- * Type union of the AccuracyAuthorization values.
- * @internal @hidden
- */
 export type AccuracyAuthorization = (typeof AccuracyAuthorization)[keyof typeof AccuracyAuthorization];

package/dist/enums/AccuracyAuthorization.js

@@ -1,18 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccuracyAuthorization = void 0;
-/**
- * Accuracy authorization granted by the user.
- *
- * | Name                | Value | Description                |
- * |---------------------|:-----:|-----------------------------|
- * | Full                |  0    | Full accuracy authorized.  |
- * | Reduced             |  1    | Reduced accuracy granted.  |
- *
- * Mirrors iOS `CLAccuracyAuthorization` and Android location accuracy permission levels.
- *
- * @category Events
- */
 exports.AccuracyAuthorization = {
     Full: 0,
     Reduced: 1,

package/dist/enums/ActivityType.d.ts

@@ -1,33 +1,8 @@
-/**
- * iOS Activity Type used with {@link GeoConfig.activityType}.
- *
- * Corresponds to Apple's `CLActivityType` enum:
- * https://developer.apple.com/documentation/corelocation/clactivitytype
- *
- * | Name                   | Value | Description                           |
- * |------------------------|:-----:|---------------------------------------|
- * | Other                  |   1   | Default/unspecified activity.         |
- * | AutomotiveNavigation   |   2   | Automotive navigation mode.           |
- * | Fitness                |   3   | Fitness-related activity.             |
- * | OtherNavigation        |   4   | Non-automotive navigation mode.       |
- * | Airborne               |   5   | Airborne activity (iOS 15+).          |
- *
- * @category Config
- */
 export declare const ActivityType: {
-    /** Default/unspecified activity. */
     readonly Other: 1;
-    /** Automotive navigation activity. */
     readonly AutomotiveNavigation: 2;
-    /** Fitness (walking, running, etc). */
     readonly Fitness: 3;
-    /** Other navigation (non-automotive). */
     readonly OtherNavigation: 4;
-    /** Airborne activity (iOS 15+). */
     readonly Airborne: 5;
 };
-/**
- * Type union of the ActivityType values.
- * @internal @hidden
- */
 export type ActivityType = (typeof ActivityType)[keyof typeof ActivityType];

package/dist/enums/ActivityType.js

@@ -1,31 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActivityType = void 0;
-/**
- * iOS Activity Type used with {@link GeoConfig.activityType}.
- *
- * Corresponds to Apple's `CLActivityType` enum:
- * https://developer.apple.com/documentation/corelocation/clactivitytype
- *
- * | Name                   | Value | Description                           |
- * |------------------------|:-----:|---------------------------------------|
- * | Other                  |   1   | Default/unspecified activity.         |
- * | AutomotiveNavigation   |   2   | Automotive navigation mode.           |
- * | Fitness                |   3   | Fitness-related activity.             |
- * | OtherNavigation        |   4   | Non-automotive navigation mode.       |
- * | Airborne               |   5   | Airborne activity (iOS 15+).          |
- *
- * @category Config
- */
 exports.ActivityType = {
-    /** Default/unspecified activity. */
     Other: 1,
-    /** Automotive navigation activity. */
     AutomotiveNavigation: 2,
-    /** Fitness (walking, running, etc). */
     Fitness: 3,
-    /** Other navigation (non-automotive). */
     OtherNavigation: 4,
-    /** Airborne activity (iOS 15+). */
     Airborne: 5,
 };

package/dist/enums/AuthorizationStatus.d.ts

@@ -1,16 +1,3 @@
-/**
- * iOS/Android location authorization status.
- *
- * | Name                | Value | Platform                |
- * |---------------------|:-----:|-------------------------|
- * | NotDetermined       |  0    | iOS only                |
- * | Restricted          |  1    | iOS only                |
- * | Denied              |  2    | iOS & Android           |
- * | Always              |  3    | iOS & Android           |
- * | WhenInUse           |  4    | iOS & Android 10+       |
- *
- * @category Events
- */
 export declare const AuthorizationStatus: {
     readonly NotDetermined: 0;
     readonly Restricted: 1;
@@ -18,7 +5,4 @@ export declare const AuthorizationStatus: {
     readonly Always: 3;
     readonly WhenInUse: 4;
 };
-/**
- * @hidden @internal
- */
 export type AuthorizationStatus = (typeof AuthorizationStatus)[keyof typeof AuthorizationStatus];