@transistorsoft/background-geolocation-types 5.0.0-beta.1

package/dist/enums/ActivityType.js

@@ -0,0 +1,31 @@
+"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

@@ -0,0 +1,20 @@
+/**
+ * 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;
+    readonly Denied: 2;
+    readonly Always: 3;
+    readonly WhenInUse: 4;
+};

package/dist/enums/AuthorizationStatus.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthorizationStatus = void 0;
+/**
+ * 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
+ */
+exports.AuthorizationStatus = {
+    NotDetermined: 0,
+    Restricted: 1,
+    Denied: 2,
+    Always: 3,
+    WhenInUse: 4,
+};

package/dist/enums/AuthorizationStrategy.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Supported authorization strategies.
+ * Mirrors Flutter's Authorization.strategy values.
+ *
+ * @category Config
+ */
+export declare const AuthorizationStrategy: {
+    readonly Jwt: "jwt";
+    readonly Sas: "sas";
+};

package/dist/enums/AuthorizationStrategy.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthorizationStrategy = void 0;
+/**
+ * Supported authorization strategies.
+ * Mirrors Flutter's Authorization.strategy values.
+ *
+ * @category Config
+ */
+exports.AuthorizationStrategy = {
+    Jwt: 'jwt',
+    Sas: 'sas'
+};

package/dist/enums/DesiredAccuracy.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Desired accuracy presets (meters / platform-tuned).
+ *
+ * @category Config
+ */
+export declare const DesiredAccuracy: {
+    readonly Navigation: -2;
+    readonly High: -1;
+    readonly Medium: 10;
+    readonly Low: 100;
+    readonly VeryLow: 1000;
+    readonly Lowest: 3000;
+};

package/dist/enums/DesiredAccuracy.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DesiredAccuracy = void 0;
+/**
+ * Desired accuracy presets (meters / platform-tuned).
+ *
+ * @category Config
+ */
+exports.DesiredAccuracy = {
+    Navigation: -2,
+    High: -1,
+    Medium: 10,
+    Low: 100,
+    VeryLow: 1000,
+    Lowest: 3000
+};

package/dist/enums/Event.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Supported event names emitted by the SDK.
+ *
+ * @category Events
+ */
+export declare const Event: {
+    readonly Location: "location";
+    readonly MotionChange: "motionchange";
+    readonly ActivityChange: "activitychange";
+    readonly Geofence: "geofence";
+    readonly GeofencesChange: "geofenceschange";
+    readonly Http: "http";
+    readonly Heartbeat: "heartbeat";
+    readonly ProviderChange: "providerchange";
+    readonly Authorization: "authorization";
+    readonly ConnectivityChange: "connectivitychange";
+    readonly EnabledChange: "enabledchange";
+    readonly PowerSaveChange: "powersavechange";
+    readonly Schedule: "schedule";
+    readonly Notification: "notification";
+};

package/dist/enums/Event.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Event = void 0;
+/**
+ * Supported event names emitted by the SDK.
+ *
+ * @category Events
+ */
+exports.Event = {
+    Location: 'location',
+    MotionChange: 'motionchange',
+    ActivityChange: 'activitychange',
+    Geofence: 'geofence',
+    GeofencesChange: 'geofenceschange',
+    Http: 'http',
+    Heartbeat: 'heartbeat',
+    ProviderChange: 'providerchange',
+    Authorization: 'authorization',
+    ConnectivityChange: 'connectivitychange',
+    EnabledChange: 'enabledchange',
+    PowerSaveChange: 'powersavechange',
+    Schedule: 'schedule',
+    Notification: 'notification'
+};

package/dist/enums/GeofenceAction.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Geofence transition actions emitted by the SDK
+ *
+ * Used with {@link GeofenceEvent} from {@link BackgroundGeolocation.onGeofence}.
+ *
+ * | Action | Meaning                      |
+ * |--------|------------------------------|
+ * | ENTER  | Device entered the geofence  |
+ * | EXIT   | Device exited the geofence   |
+ * | DWELL  | Device dwelled inside        |
+ *
+ * @category Events
+ */
+export declare const GeofenceAction: {
+    readonly Enter: "ENTER";
+    readonly Exit: "EXIT";
+    readonly Dwell: "DWELL";
+};

package/dist/enums/GeofenceAction.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeofenceAction = void 0;
+/**
+ * Geofence transition actions emitted by the SDK
+ *
+ * Used with {@link GeofenceEvent} from {@link BackgroundGeolocation.onGeofence}.
+ *
+ * | Action | Meaning                      |
+ * |--------|------------------------------|
+ * | ENTER  | Device entered the geofence  |
+ * | EXIT   | Device exited the geofence   |
+ * | DWELL  | Device dwelled inside        |
+ *
+ * @category Events
+ */
+exports.GeofenceAction = {
+    Enter: 'ENTER',
+    Exit: 'EXIT',
+    Dwell: 'DWELL'
+};

package/dist/enums/HttpMethod.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Allowed HTTP methods for uploading data.
+ * Mirrors Flutter's HttpConfig.method and native support.
+ *
+ * @category Config
+ */
+export declare const HttpMethod: {
+    readonly Post: "POST";
+    readonly Put: "PUT";
+    readonly Patch: "PATCH";
+};

package/dist/enums/HttpMethod.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpMethod = void 0;
+/**
+ * Allowed HTTP methods for uploading data.
+ * Mirrors Flutter's HttpConfig.method and native support.
+ *
+ * @category Config
+ */
+exports.HttpMethod = {
+    Post: 'POST',
+    Put: 'PUT',
+    Patch: 'PATCH'
+};

package/dist/enums/KalmanProfile.d.ts

@@ -0,0 +1,30 @@
+/**
+   * Specifies the preset tuning profile for the Kalman filter used in location
+   * denoising.
+   *
+   * Each profile adjusts the Kalman filter’s process and measurement noise
+   * parameters, trading off between responsiveness and smoothness:
+   *
+   * | Profile              | Behavior                                                            |
+   * |----------------------|---------------------------------------------------------------------|
+   * | `defaultProfile`     | **Balanced** — General-purpose; suitable for most movement types.   |
+   * | `aggressive`         | **Aggressive** — Fast response; minimal smoothing.                   |
+   * | `conservative`       | **Conservative** — Maximum smoothing; slowest response to changes.  |
+   *
+   * - If no profile is provided, `defaultProfile` is applied.
+   * - Use `aggressive` for fast-changing activities requiring rapid updates.
+   * - Use `conservative` when stability and track smoothness are more important
+   *   than immediate responsiveness.
+   *
+   * This maps directly to native Kalman tuning implementations on both Android and iOS.
+   *
+   * @category Config
+   */
+export declare const KalmanProfile: {
+    /** Balanced for general-purpose movement (default). */
+    readonly Default: 0;
+    /** Aggressive — responds faster to motion with less smoothing. */
+    readonly Aggressive: 1;
+    /** Conservative — maximum smoothing, slower reaction to change. */
+    readonly Conservative: 2;
+};

package/dist/enums/KalmanProfile.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KalmanProfile = void 0;
+/**
+   * Specifies the preset tuning profile for the Kalman filter used in location
+   * denoising.
+   *
+   * Each profile adjusts the Kalman filter’s process and measurement noise
+   * parameters, trading off between responsiveness and smoothness:
+   *
+   * | Profile              | Behavior                                                            |
+   * |----------------------|---------------------------------------------------------------------|
+   * | `defaultProfile`     | **Balanced** — General-purpose; suitable for most movement types.   |
+   * | `aggressive`         | **Aggressive** — Fast response; minimal smoothing.                   |
+   * | `conservative`       | **Conservative** — Maximum smoothing; slowest response to changes.  |
+   *
+   * - If no profile is provided, `defaultProfile` is applied.
+   * - Use `aggressive` for fast-changing activities requiring rapid updates.
+   * - Use `conservative` when stability and track smoothness are more important
+   *   than immediate responsiveness.
+   *
+   * This maps directly to native Kalman tuning implementations on both Android and iOS.
+   *
+   * @category Config
+   */
+exports.KalmanProfile = {
+    /** Balanced for general-purpose movement (default). */
+    Default: 0,
+    /** Aggressive — responds faster to motion with less smoothing. */
+    Aggressive: 1,
+    /** Conservative — maximum smoothing, slower reaction to change. */
+    Conservative: 2
+};

package/dist/enums/LocationError.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Error codes returned when the native location API fails to fetch a location.
+ *
+ *
+ * | Code | Error |
+ * |------|--------|
+ * | `0`   | Location unknown |
+ * | `1`   | Location permission denied |
+ * | `2`   | Network error |
+ * | `3`   | Attempt to initiate location-services in background with WhenInUse authorization |
+ * | `408` | Location timeout |
+ * | `499` | Location request cancelled |
+ *
+ * @category Events
+ */
+export declare const LocationError: {
+    readonly LocationUnknown: 0;
+    readonly PermissionDenied: 1;
+    readonly NetworkError: 2;
+    readonly BackgroundWhenInUse: 3;
+    readonly Timeout: 408;
+    readonly Cancelled: 499;
+};

package/dist/enums/LocationError.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocationError = void 0;
+/**
+ * Error codes returned when the native location API fails to fetch a location.
+ *
+ *
+ * | Code | Error |
+ * |------|--------|
+ * | `0`   | Location unknown |
+ * | `1`   | Location permission denied |
+ * | `2`   | Network error |
+ * | `3`   | Attempt to initiate location-services in background with WhenInUse authorization |
+ * | `408` | Location timeout |
+ * | `499` | Location request cancelled |
+ *
+ * @category Events
+ */
+exports.LocationError = {
+    LocationUnknown: 0,
+    PermissionDenied: 1,
+    NetworkError: 2,
+    BackgroundWhenInUse: 3,
+    Timeout: 408,
+    Cancelled: 499,
+};

package/dist/enums/LocationFilterPolicy.d.ts

@@ -0,0 +1,108 @@
+/**
+   * Defines the filtering policy applied to incoming raw GPS samples before they
+   * are accepted, averaged, or rejected by the {@link LocationFilter}.
+   *
+   * The filtering policy determines how aggressively the plugin removes noisy,
+   * inaccurate, or redundant location updates. It represents the *first stage*
+   * in the SDK’s data-quality pipeline — before Kalman smoothing, burst averaging,
+   * or other denoising steps are applied.
+   *
+   * Choosing the correct policy depends on your app’s tolerance for jitter versus
+   * responsiveness:
+   *
+   * - Fitness or vehicle-tracking apps often prefer stronger filtering.
+   * - Survey or scientific apps may prefer capturing unmodified raw samples.
+   *
+   * **Profiles**
+   *
+   * | Policy | Description | Use Case |
+   * |--------|-------------|----------|
+   * | {@link LocationFilterPolicy.PassThrough} | **No filtering.** Every received sample is recorded, even if noisy or identical to the previous one. | Debugging, diagnostics, scenarios requiring raw data. |
+   * | {@link LocationFilterPolicy.Adjust} | **Balanced filtering.** Smooths and rejects only clearly invalid samples. *(Default)* | Most use cases — walking, cycling, automotive tracking. |
+   * | {@link LocationFilterPolicy.Conservative} | **Strict filtering.** Strongly smooths data and rejects high-variance samples, prioritizing stability over responsiveness. | Analytics, long-term background logging, noise-sensitive applications. |
+   *
+   * **Notes**
+   *
+   * - This policy affects only the SDK’s *internal* filtering pipeline.
+   *   It does **not** modify the raw values returned to {@link BackgroundGeolocation.onLocation}.
+   * - For more granular tuning, see {@link LocationFilter.trackingAccuracyThreshold},
+   *   {@link LocationFilter.maxImpliedSpeed}, and other {@link LocationFilter} fields.
+   *
+   * **Examples**
+   *
+   * Balanced default filtering:
+   *
+   * ```ts
+   * BackgroundGeolocation.ready({
+   *   geolocation: {
+   *     filter: {
+   *       policy: LocationFilterPolicy.Adjust
+   *     }
+   *   }
+   * });
+   * ```
+   *
+   * No filtering — capture all raw locations:
+   *
+   * ```ts
+   * BackgroundGeolocation.ready({
+   *   geolocation: {
+   *     filter: {
+   *       policy: LocationFilterPolicy.PassThrough
+   *     }
+   *   }
+   * });
+   * ```
+   *
+   * Maximum smoothing for analytics:
+   *
+   * ```ts
+   * BackgroundGeolocation.ready({
+   *   geolocation: {
+   *     filter: {
+   *       policy: LocationFilterPolicy.Conservative
+   *     }
+   *   }
+   * });
+   * ```
+   *
+   * **See also**
+   * - {@link GeoConfig.filter}
+   * - {@link LocationFilter}
+   * - {@link KalmanProfile}
+   *
+   * @category Config
+   */
+export declare const LocationFilterPolicy: {
+    /** No filtering — accept all samples. Useful for debugging. */
+    readonly PassThrough: 0;
+    /**
+     * Balanced (default) — applies moderate filtering to reject noisy samples.
+     *
+     * Dynamically adjusts acceptance thresholds for incoming samples, but **never**
+     * alters the raw latitude/longitude coordinates.
+     *
+     * When using {@link LocationFilterPolicy.Adjust} (the default), the SDK computes
+     * motion metrics such as:
+     *
+     * - distance deltas
+     * - implied speed
+     * - accuracy variance
+     * - heading stability
+     *
+     * It then applies adaptive gating rules to decide whether each sample should be:
+     *
+     * - accepted
+     * - ignored
+     * - rejected as noise
+     *
+     * **Coordinates are never modified.** This policy adjusts *which* samples are
+     * included, not *how* they are positioned.
+     *
+     * If {@link LocationFilter.useKalman} is enabled, additional smoothing may occur,
+     * but the physical coordinates of each accepted sample remain untouched.
+     */
+    readonly Adjust: 1;
+    /** Aggressive — filters heavily, preferring stability over responsiveness. */
+    readonly Conservative: 2;
+};

package/dist/enums/LocationFilterPolicy.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocationFilterPolicy = void 0;
+/**
+   * Defines the filtering policy applied to incoming raw GPS samples before they
+   * are accepted, averaged, or rejected by the {@link LocationFilter}.
+   *
+   * The filtering policy determines how aggressively the plugin removes noisy,
+   * inaccurate, or redundant location updates. It represents the *first stage*
+   * in the SDK’s data-quality pipeline — before Kalman smoothing, burst averaging,
+   * or other denoising steps are applied.
+   *
+   * Choosing the correct policy depends on your app’s tolerance for jitter versus
+   * responsiveness:
+   *
+   * - Fitness or vehicle-tracking apps often prefer stronger filtering.
+   * - Survey or scientific apps may prefer capturing unmodified raw samples.
+   *
+   * **Profiles**
+   *
+   * | Policy | Description | Use Case |
+   * |--------|-------------|----------|
+   * | {@link LocationFilterPolicy.PassThrough} | **No filtering.** Every received sample is recorded, even if noisy or identical to the previous one. | Debugging, diagnostics, scenarios requiring raw data. |
+   * | {@link LocationFilterPolicy.Adjust} | **Balanced filtering.** Smooths and rejects only clearly invalid samples. *(Default)* | Most use cases — walking, cycling, automotive tracking. |
+   * | {@link LocationFilterPolicy.Conservative} | **Strict filtering.** Strongly smooths data and rejects high-variance samples, prioritizing stability over responsiveness. | Analytics, long-term background logging, noise-sensitive applications. |
+   *
+   * **Notes**
+   *
+   * - This policy affects only the SDK’s *internal* filtering pipeline.
+   *   It does **not** modify the raw values returned to {@link BackgroundGeolocation.onLocation}.
+   * - For more granular tuning, see {@link LocationFilter.trackingAccuracyThreshold},
+   *   {@link LocationFilter.maxImpliedSpeed}, and other {@link LocationFilter} fields.
+   *
+   * **Examples**
+   *
+   * Balanced default filtering:
+   *
+   * ```ts
+   * BackgroundGeolocation.ready({
+   *   geolocation: {
+   *     filter: {
+   *       policy: LocationFilterPolicy.Adjust
+   *     }
+   *   }
+   * });
+   * ```
+   *
+   * No filtering — capture all raw locations:
+   *
+   * ```ts
+   * BackgroundGeolocation.ready({
+   *   geolocation: {
+   *     filter: {
+   *       policy: LocationFilterPolicy.PassThrough
+   *     }
+   *   }
+   * });
+   * ```
+   *
+   * Maximum smoothing for analytics:
+   *
+   * ```ts
+   * BackgroundGeolocation.ready({
+   *   geolocation: {
+   *     filter: {
+   *       policy: LocationFilterPolicy.Conservative
+   *     }
+   *   }
+   * });
+   * ```
+   *
+   * **See also**
+   * - {@link GeoConfig.filter}
+   * - {@link LocationFilter}
+   * - {@link KalmanProfile}
+   *
+   * @category Config
+   */
+exports.LocationFilterPolicy = {
+    /** No filtering — accept all samples. Useful for debugging. */
+    PassThrough: 0,
+    /**
+     * Balanced (default) — applies moderate filtering to reject noisy samples.
+     *
+     * Dynamically adjusts acceptance thresholds for incoming samples, but **never**
+     * alters the raw latitude/longitude coordinates.
+     *
+     * When using {@link LocationFilterPolicy.Adjust} (the default), the SDK computes
+     * motion metrics such as:
+     *
+     * - distance deltas
+     * - implied speed
+     * - accuracy variance
+     * - heading stability
+     *
+     * It then applies adaptive gating rules to decide whether each sample should be:
+     *
+     * - accepted
+     * - ignored
+     * - rejected as noise
+     *
+     * **Coordinates are never modified.** This policy adjusts *which* samples are
+     * included, not *how* they are positioned.
+     *
+     * If {@link LocationFilter.useKalman} is enabled, additional smoothing may occur,
+     * but the physical coordinates of each accepted sample remain untouched.
+     */
+    Adjust: 1,
+    /** Aggressive — filters heavily, preferring stability over responsiveness. */
+    Conservative: 2
+};

package/dist/enums/LogLevel.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Controls the verbosity of plugin logging.
+ *
+ * @category Config
+ */
+export declare const LogLevel: {
+    readonly Off: 0;
+    readonly Error: 1;
+    readonly Warning: 2;
+    readonly Info: 3;
+    readonly Debug: 4;
+    readonly Verbose: 5;
+};

package/dist/enums/LogLevel.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+/**
+ * Controls the verbosity of plugin logging.
+ *
+ * @category Config
+ */
+exports.LogLevel = {
+    Off: 0,
+    Error: 1,
+    Warning: 2,
+    Info: 3,
+    Debug: 4,
+    Verbose: 5
+};

package/dist/enums/LogLevelName.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/enums/LogLevelName.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevelName = void 0;
+/**
+ * Log severity level used by {@link Logger.debug} {@link Logger.info}, etc.
+ * @hidden
+ * @internal
+ */
+exports.LogLevelName = {
+    Debug: "debug",
+    Notice: "notice",
+    Info: "info",
+    Warn: "warn",
+    Error: "error"
+};

package/dist/enums/MotionActivityType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Reported device motion activity names (legacy RN + native).
+ *
+ * @category Events
+ */
+export declare const MotionActivityType: {
+    readonly Still: "still";
+    readonly Walking: "walking";
+    readonly OnFoot: "on_foot";
+    readonly Running: "running";
+    readonly OnBicycle: "on_bicycle";
+    readonly InVehicle: "in_vehicle";
+    readonly Unknown: "unknown";
+};

package/dist/enums/MotionActivityType.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MotionActivityType = void 0;
+/**
+ * Reported device motion activity names (legacy RN + native).
+ *
+ * @category Events
+ */
+exports.MotionActivityType = {
+    Still: 'still',
+    Walking: 'walking',
+    OnFoot: 'on_foot',
+    Running: 'running',
+    OnBicycle: 'on_bicycle',
+    InVehicle: 'in_vehicle',
+    Unknown: 'unknown'
+};