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

package/dist/enums/NotificationPriority.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Defines the priority / visibility of the Android foreground-service notification.
+ *
+ * This affects how the notification appears in the status bar and how strongly
+ * the OS ranks it among other notifications.
+ *
+ * Mirrors Flutter’s `NotificationPriority` enum.
+ *
+ * @category Config
+ */
+export declare const NotificationPriority: {
+    /** Default notification priority (normal weighting). */
+    readonly Default: 0;
+    /** Notification strongly weighted to top of list; icon strongly weighted to the left. */
+    readonly High: 1;
+    /** Notification weighted to bottom of list; icon weighted to the right. */
+    readonly Low: -1;
+    /** Same as {@link NotificationPriority.High}. */
+    readonly Max: 2;
+    /** Notification strongly weighted to bottom of list; icon hidden. */
+    readonly Min: -2;
+};

package/dist/enums/NotificationPriority.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationPriority = void 0;
+/**
+ * Defines the priority / visibility of the Android foreground-service notification.
+ *
+ * This affects how the notification appears in the status bar and how strongly
+ * the OS ranks it among other notifications.
+ *
+ * Mirrors Flutter’s `NotificationPriority` enum.
+ *
+ * @category Config
+ */
+exports.NotificationPriority = {
+    /** Default notification priority (normal weighting). */
+    Default: 0,
+    /** Notification strongly weighted to top of list; icon strongly weighted to the left. */
+    High: 1,
+    /** Notification weighted to bottom of list; icon weighted to the right. */
+    Low: -1,
+    /** Same as {@link NotificationPriority.High}. */
+    Max: 2,
+    /** Notification strongly weighted to bottom of list; icon hidden. */
+    Min: -2,
+};

package/dist/enums/PersistMode.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Persistence modes for BackgroundGeolocation SDK.
+ * Mirrors Flutter's `PersistMode` enum.
+ *
+ * @category Config
+ */
+export declare const PersistMode: {
+    readonly All: 2;
+    readonly Location: 1;
+    readonly Geofence: -1;
+    readonly None: 0;
+};

package/dist/enums/PersistMode.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersistMode = void 0;
+/**
+ * Persistence modes for BackgroundGeolocation SDK.
+ * Mirrors Flutter's `PersistMode` enum.
+ *
+ * @category Config
+ */
+exports.PersistMode = {
+    All: 2,
+    Location: 1,
+    Geofence: -1,
+    None: 0
+};

package/dist/enums/SQLQueryOrder.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Sort order for [[SQLQuery.order]].
+ *
+ * | Name          | Value |
+ * |---------------|-------|
+ * | Asc           | `1`   |
+ * | Desc          | `-1`  |
+ *
+ * @category Logger
+ */
+export declare const SQLQueryOrder: {
+    readonly Asc: 1;
+    readonly Desc: -1;
+};
+/** @hidden */
+export type SQLQueryOrder = (typeof SQLQueryOrder)[keyof typeof SQLQueryOrder];

package/dist/enums/SQLQueryOrder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQLQueryOrder = void 0;
+/**
+ * Sort order for [[SQLQuery.order]].
+ *
+ * | Name          | Value |
+ * |---------------|-------|
+ * | Asc           | `1`   |
+ * | Desc          | `-1`  |
+ *
+ * @category Logger
+ */
+exports.SQLQueryOrder = {
+    Asc: 1,
+    Desc: -1,
+};

package/dist/enums/TrackingMode.d.ts

@@ -0,0 +1,14 @@
+/**
+ * SDK tracking mode (legacy RN values preserved).
+ *
+ * | Value | Name       | Description                   |
+ * |------:|------------|-------------------------------|
+ * | 0     | Geofences  | Monitor geofences only.       |
+ * | 1     | Location   | Monitor location + geofences. |
+ *
+ * @category Config
+ */
+export declare const TrackingMode: {
+    readonly Geofences: 0;
+    readonly Location: 1;
+};

package/dist/enums/TrackingMode.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackingMode = void 0;
+/**
+ * SDK tracking mode (legacy RN values preserved).
+ *
+ * | Value | Name       | Description                   |
+ * |------:|------------|-------------------------------|
+ * | 0     | Geofences  | Monitor geofences only.       |
+ * | 1     | Location   | Monitor location + geofences. |
+ *
+ * @category Config
+ */
+exports.TrackingMode = {
+    Geofences: 0,
+    Location: 1
+};

package/dist/enums/TriggerActivity.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Allowed motion activity names that can trigger motion detection.
+ * Mirrors Flutter's TriggerActivity set.
+ *
+ * @category Config
+ */
+export declare const TriggerActivity: {
+    readonly Walking: "walking";
+    readonly OnFoot: "on_foot";
+    readonly Running: "running";
+    readonly OnBicycle: "on_bicycle";
+    readonly InVehicle: "in_vehicle";
+};

package/dist/enums/TriggerActivity.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TriggerActivity = void 0;
+/**
+ * Allowed motion activity names that can trigger motion detection.
+ * Mirrors Flutter's TriggerActivity set.
+ *
+ * @category Config
+ */
+exports.TriggerActivity = {
+    Walking: 'walking',
+    OnFoot: 'on_foot',
+    Running: 'running',
+    OnBicycle: 'on_bicycle',
+    InVehicle: 'in_vehicle'
+};

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+export * from './enums/AuthorizationStatus';
+export * from './enums/LogLevel';
+export * from './enums/DesiredAccuracy';
+export * from './enums/PersistMode';
+export * from './enums/AuthorizationStrategy';
+export * from './enums/LocationFilterPolicy';
+export * from './enums/KalmanProfile';
+export * from './enums/HttpMethod';
+export * from './enums/TriggerActivity';
+export * from './enums/NotificationPriority';
+export * from './enums/MotionActivityType';
+export * from './enums/TrackingMode';
+export * from './enums/AccuracyAuthorization';
+export * from './enums/LogLevelName';
+export * from './enums/GeofenceAction';
+export * from './enums/Event';
+export * from './enums/ActivityType';
+export * from './enums/LocationError';
+export * from './enums/SQLQueryOrder';
+export * from "./core/data/Location";
+export * from './core/data/Geofence';
+export * from "./core/data/DeviceInfo";
+export * from './core/data/Sensors';
+export * from "./core/events/Subscription";
+export * from "./core/events/GeofenceEvent";
+export * from "./core/events/AuthorizationEvent";
+export * from "./core/events/MotionActivityEvent";
+export * from "./core/events/HeadlessEvent";
+export * from "./core/events/HeartbeatEvent";
+export * from "./core/events/GeofencesChangeEvent";
+export * from "./core/events/ConnectivityChangeEvent";
+export * from "./core/events/MotionChangeEvent";
+export * from "./core/events/ProviderChangeEvent";
+export * from "./core/events/HttpEvent";
+export * from './core/config/Config';
+export * from './core/config/GeoConfig';
+export * from './core/config/HttpConfig';
+export * from './core/config/PersistenceConfig';
+export * from './core/config/ActivityConfig';
+export * from './core/config/AppConfig';
+export * from './core/config/LoggerConfig';
+export * from './core/config/AuthorizationConfig';
+export * from './core/config/NotificationConfig';
+export * from './core/config/LocationFilter';
+export * from './core/api/BackgroundGeolocation';
+export * from './core/api/State';
+export * from './core/api/Logger';
+export * from './core/api/DeviceSettings';
+export * from './core/api/CurrentPositionRequest';

package/dist/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// enums
+__exportStar(require("./enums/AuthorizationStatus"), exports);
+__exportStar(require("./enums/LogLevel"), exports);
+__exportStar(require("./enums/DesiredAccuracy"), exports);
+__exportStar(require("./enums/PersistMode"), exports);
+__exportStar(require("./enums/AuthorizationStrategy"), exports);
+__exportStar(require("./enums/LocationFilterPolicy"), exports);
+__exportStar(require("./enums/KalmanProfile"), exports);
+__exportStar(require("./enums/HttpMethod"), exports);
+__exportStar(require("./enums/TriggerActivity"), exports);
+__exportStar(require("./enums/NotificationPriority"), exports);
+__exportStar(require("./enums/MotionActivityType"), exports);
+__exportStar(require("./enums/TrackingMode"), exports);
+__exportStar(require("./enums/AccuracyAuthorization"), exports);
+__exportStar(require("./enums/LogLevelName"), exports);
+__exportStar(require("./enums/GeofenceAction"), exports);
+__exportStar(require("./enums/Event"), exports);
+__exportStar(require("./enums/ActivityType"), exports);
+__exportStar(require("./enums/LocationError"), exports);
+__exportStar(require("./enums/SQLQueryOrder"), exports);
+// events/data
+__exportStar(require("./core/data/Location"), exports);
+__exportStar(require("./core/data/Geofence"), exports);
+__exportStar(require("./core/data/DeviceInfo"), exports);
+__exportStar(require("./core/data/Sensors"), exports);
+__exportStar(require("./core/events/Subscription"), exports);
+__exportStar(require("./core/events/GeofenceEvent"), exports);
+__exportStar(require("./core/events/AuthorizationEvent"), exports);
+__exportStar(require("./core/events/MotionActivityEvent"), exports);
+__exportStar(require("./core/events/HeadlessEvent"), exports);
+__exportStar(require("./core/events/HeartbeatEvent"), exports);
+__exportStar(require("./core/events/GeofencesChangeEvent"), exports);
+__exportStar(require("./core/events/ConnectivityChangeEvent"), exports);
+__exportStar(require("./core/events/MotionChangeEvent"), exports);
+__exportStar(require("./core/events/ProviderChangeEvent"), exports);
+__exportStar(require("./core/events/HttpEvent"), exports);
+// config groups
+__exportStar(require("./core/config/Config"), exports);
+__exportStar(require("./core/config/GeoConfig"), exports);
+__exportStar(require("./core/config/HttpConfig"), exports);
+__exportStar(require("./core/config/PersistenceConfig"), exports);
+__exportStar(require("./core/config/ActivityConfig"), exports);
+__exportStar(require("./core/config/AppConfig"), exports);
+__exportStar(require("./core/config/LoggerConfig"), exports);
+__exportStar(require("./core/config/AuthorizationConfig"), exports);
+__exportStar(require("./core/config/NotificationConfig"), exports);
+__exportStar(require("./core/config/LocationFilter"), exports);
+// Primary API
+__exportStar(require("./core/api/BackgroundGeolocation"), exports);
+__exportStar(require("./core/api/State"), exports);
+__exportStar(require("./core/api/Logger"), exports);
+__exportStar(require("./core/api/DeviceSettings"), exports);
+__exportStar(require("./core/api/CurrentPositionRequest"), exports);

package/dist/legacy/LegacyConfig.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Historic, flat configuration surface.
+ *
+ * @deprecated Use {@link Config} groups instead:
+ * geolocation, http, persistence, activity, app, logger, authorization, notification.
+ *
+ * Full documentation intentionally preserved for hover/TypeDoc.
+ * @example
+ * ```ts
+ * import { LegacyConfig } from 'background-geolocation-types';
+ * const config: LegacyConfig = {
+ *   desiredAccuracy: 10,
+ *   distanceFilter: 50,
+ *   stopOnTerminate: false,
+ *   // ...etc
+ * };
+ * ```
+ * @category Config
+ */
+export interface LegacyConfig {
+    desiredAccuracy?: number;
+    distanceFilter?: number;
+    stopOnTerminate?: boolean;
+}

package/dist/legacy/LegacyConfig.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@transistorsoft/background-geolocation-types",
+  "version": "5.0.0-beta.1",
+  "type": "commonjs",
+  "description": "Shared TypeScript type definitions and documentation for Transistor Software's Background Geolocation SDKs (React Native, Capacitor, Cordova)",
+  "author": "Transistor Software <info@transistorsoft.com>",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://github.com/transistorsoft/background-geolocation",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/transistorsoft/background-geolocation.git",
+    "directory": "packages/background-geolocation-types"
+  },
+  "keywords": [
+    "typescript",
+    "types",
+    "background-geolocation",
+    "react-native",
+    "capacitor",
+    "cordova",
+    "geolocation",
+    "transistorsoft"
+  ],
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsc -p tsconfig.json",
+    "watch": "tsc -p tsconfig.json -w",
+    "prepare": "pnpm run build",
+    "docs": "typedoc --options typedoc.json"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.0",
+    "rimraf": "^5.0.0",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript": "^5.6.0"
+  }
+}