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

package/dist/enums/AuthorizationStatus.js

@@ -1,19 +1,6 @@
 "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,

package/dist/enums/AuthorizationStrategy.d.ts

@@ -1,14 +1,5 @@
-/**
- * Supported authorization strategies.
- * Mirrors Flutter's Authorization.strategy values.
- *
- * @category Config
- */
 export declare const AuthorizationStrategy: {
     readonly Jwt: "jwt";
     readonly Sas: "sas";
 };
-/**
- * @internal @hidden
- */
 export type AuthorizationStrategy = (typeof AuthorizationStrategy)[keyof typeof AuthorizationStrategy];

package/dist/enums/AuthorizationStrategy.js

@@ -1,12 +1,6 @@
 "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

@@ -1,8 +1,3 @@
-/**
- * Desired accuracy presets (meters / platform-tuned).
- *
- * @category Config
- */
 export declare const DesiredAccuracy: {
     readonly Navigation: -2;
     readonly High: -1;
@@ -11,5 +6,4 @@ export declare const DesiredAccuracy: {
     readonly VeryLow: 1000;
     readonly Lowest: 3000;
 };
-/** @internal @hidden */
 export type DesiredAccuracy = typeof DesiredAccuracy[keyof typeof DesiredAccuracy];

package/dist/enums/DesiredAccuracy.js

@@ -1,11 +1,6 @@
 "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,

package/dist/enums/Event.d.ts

@@ -1,8 +1,3 @@
-/**
- * Supported event names emitted by the SDK.
- *
- * @category Events
- */
 export declare const Event: {
     readonly Boot: "boot";
     readonly Terminate: "terminate";
@@ -21,8 +16,4 @@ export declare const Event: {
     readonly Schedule: "schedule";
     readonly Notification: "notification";
 };
-/**
- * Event names emitted by the SDK.
- * @hidden @internal
- */
 export type Event = (typeof Event)[keyof typeof Event];

package/dist/enums/Event.js

@@ -1,11 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Event = void 0;
-/**
- * Supported event names emitted by the SDK.
- *
- * @category Events
- */
 exports.Event = {
     Boot: 'boot',
     Terminate: 'terminate',

package/dist/enums/GeofenceAction.d.ts

@@ -1,23 +1,6 @@
-/**
- * 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";
 };
-/**
- * Union of geofence transition strings.
- * @internal @hidden
- */
 export type GeofenceAction = (typeof GeofenceAction)[keyof typeof GeofenceAction];

package/dist/enums/GeofenceAction.js

@@ -1,19 +1,6 @@
 "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',

package/dist/enums/HttpMethod.d.ts

@@ -1,13 +1,6 @@
-/**
- * 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";
 };
-/** @internal @hidden */
 export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];

package/dist/enums/HttpMethod.js

@@ -1,12 +1,6 @@
 "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',

package/dist/enums/KalmanProfile.d.ts

@@ -1,32 +1,6 @@
-/**
-   * 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;
 };
-/** @internal @hidden */
 export type KalmanProfile = (typeof KalmanProfile)[keyof typeof KalmanProfile];

package/dist/enums/KalmanProfile.js

@@ -1,33 +1,8 @@
 "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

@@ -1,18 +1,3 @@
-/**
- * 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;
@@ -21,8 +6,4 @@ export declare const LocationError: {
     readonly Timeout: 408;
     readonly Cancelled: 499;
 };
-/**
- * Union type of possible location error codes.
- * @internal @hidden
- */
 export type LocationError = (typeof LocationError)[keyof typeof LocationError];

package/dist/enums/LocationError.js

@@ -1,21 +1,6 @@
 "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,

package/dist/enums/LocationFilterPolicy.d.ts

@@ -1,110 +1,6 @@
-/**
-   * 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;
 };
-/** @internal @hidden */
 export type LocationFilterPolicy = (typeof LocationFilterPolicy)[keyof typeof LocationFilterPolicy];

package/dist/enums/LocationFilterPolicy.js

@@ -1,111 +1,8 @@
 "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/LocationRequest.d.ts

@@ -1,25 +1,6 @@
-/**
- * Indicates what level of location authorization the SDK should request.
- *
- * | Name       | Value        | Description                                              |
- * |------------|--------------|----------------------------------------------------------|
- * | Always     | `"Always"`   | Request full background + foreground authorization.      |
- * | WhenInUse  | `"WhenInUse"`| Request foreground-only authorization.                   |
- * | Any        | `"Any"`      | Accept *either* Always or WhenInUse (no specific request). |
- *
- * Mirrors native iOS authorization request options and existing RN adapter keys.
- *
- * See {@link GeoConfig.locationAuthorizationRequest}
- *
- * @category Config
- */
 export declare const LocationRequest: {
     readonly Always: "Always";
     readonly WhenInUse: "WhenInUse";
     readonly Any: "Any";
 };
-/**
- * Type union of all LocationRequest values.
- * @internal @hidden
- */
 export type LocationRequest = (typeof LocationRequest)[keyof typeof LocationRequest];

package/dist/enums/LocationRequest.js

@@ -1,21 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocationRequest = void 0;
-/**
- * Indicates what level of location authorization the SDK should request.
- *
- * | Name       | Value        | Description                                              |
- * |------------|--------------|----------------------------------------------------------|
- * | Always     | `"Always"`   | Request full background + foreground authorization.      |
- * | WhenInUse  | `"WhenInUse"`| Request foreground-only authorization.                   |
- * | Any        | `"Any"`      | Accept *either* Always or WhenInUse (no specific request). |
- *
- * Mirrors native iOS authorization request options and existing RN adapter keys.
- *
- * See {@link GeoConfig.locationAuthorizationRequest}
- *
- * @category Config
- */
 exports.LocationRequest = {
     Always: 'Always',
     WhenInUse: 'WhenInUse',

package/dist/enums/LogLevel.d.ts

@@ -1,19 +1,3 @@
-/**
- * Controls the verbosity of plugin logging.
- *
- * | Level   | Value | Description                     |
- * |---------|:-----:|---------------------------------|
- * | Off     |   0   | Disable all logging.            |
- * | Error   |   1   | Log only critical failures.     |
- * | Warning |   2   | Log warnings + errors.          |
- * | Info    |   3   | Operational information.        |
- * | Debug   |   4   | Developer-level debug output.   |
- * | Verbose |   5   | Maximum detail.                 |
- *
- * Mirrors native logging constants on iOS & Android.
- *
- * @category Config
- */
 export declare const LogLevel: {
     readonly Off: 0;
     readonly Error: 1;
@@ -22,8 +6,4 @@ export declare const LogLevel: {
     readonly Debug: 4;
     readonly Verbose: 5;
 };
-/**
- * Type union of all LogLevel values.
- * @internal @hidden
- */
 export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];

package/dist/enums/LogLevel.js

@@ -1,22 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogLevel = void 0;
-/**
- * Controls the verbosity of plugin logging.
- *
- * | Level   | Value | Description                     |
- * |---------|:-----:|---------------------------------|
- * | Off     |   0   | Disable all logging.            |
- * | Error   |   1   | Log only critical failures.     |
- * | Warning |   2   | Log warnings + errors.          |
- * | Info    |   3   | Operational information.        |
- * | Debug   |   4   | Developer-level debug output.   |
- * | Verbose |   5   | Maximum detail.                 |
- *
- * Mirrors native logging constants on iOS & Android.
- *
- * @category Config
- */
 exports.LogLevel = {
     Off: 0,
     Error: 1,

package/dist/enums/LogLevelName.d.ts

@@ -1,8 +1,3 @@
-/**
- * Log severity level used by {@link Logger.debug} {@link Logger.info}, etc.
- * @hidden
- * @internal
- */
 export declare const LogLevelName: {
     readonly Debug: "debug";
     readonly Notice: "notice";
@@ -10,5 +5,4 @@ export declare const LogLevelName: {
     readonly Warn: "warn";
     readonly Error: "error";
 };
-/** @internal @hidden */
 export type LogLevelName = typeof LogLevelName[keyof typeof LogLevelName];

package/dist/enums/LogLevelName.js

@@ -1,11 +1,6 @@
 "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",

package/dist/enums/MotionActivityType.d.ts

@@ -1,8 +1,3 @@
-/**
- * Reported device motion activity names (legacy RN + native).
- *
- * @category Events
- */
 export declare const MotionActivityType: {
     readonly Still: "still";
     readonly Walking: "walking";
@@ -12,5 +7,4 @@ export declare const MotionActivityType: {
     readonly InVehicle: "in_vehicle";
     readonly Unknown: "unknown";
 };
-/** @internal @hidden */
 export type MotionActivityType = typeof MotionActivityType[keyof typeof MotionActivityType];