@transistorsoft/background-geolocation-types 5.2.0 → 5.2.2

package/dist/core/api/BackgroundGeolocation.d.ts

@@ -2,9 +2,10 @@ import type { Logger } from './Logger';
 import type { DeviceSettings } from './DeviceSettings';
 import type { CurrentPositionRequest } from './CurrentPositionRequest';
 import type { WatchPositionRequest } from './WatchPositionRequest';
+import type { LocationQuery } from './LocationQuery';
 import type { Config } from '../config/Config';
 import type { State } from './State';
-import type { Location } from '../data/Location';
+import type { Location, LocationInput } from '../data/Location';
 import type { LocationError } from '../../enums/LocationError';
 import type { Geofence } from '../data/Geofence';
 import type { DeviceInfo } from '../data/DeviceInfo';
@@ -109,8 +110,8 @@ export interface BackgroundGeolocationAPI extends BackgroundGeolocationEvents {
     isPowerSaveMode(): Promise<boolean>;
     destroyLocations(): Promise<void>;
     destroyLocation(uuid: string): Promise<void>;
-    insertLocation(location: Location): Promise<Location>;
-    getLocations(): Promise<Array<Object>>;
+    insertLocation(location: LocationInput): Promise<string>;
+    getLocations(query?: LocationQuery): Promise<Array<Object>>;
     getCount(): Promise<number>;
     sync(): Promise<Array<Object>>;
     startBackgroundTask(): Promise<number>;

package/dist/core/api/LocationQuery.d.ts

@@ -0,0 +1,7 @@
+import { SQLQueryOrder } from "../../enums/SQLQueryOrder";
+export interface LocationQuery {
+    limit?: number;
+    offset?: number;
+    page?: number;
+    order?: SQLQueryOrder;
+}

package/dist/core/api/LocationQuery.js

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

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

@@ -40,3 +40,9 @@ export interface Location {
     activity: MotionActivity;
     provider?: ProviderChangeEvent;
 }
+export interface LocationInput {
+    coords: Pick<Coords, "latitude" | "longitude"> & Partial<Coords>;
+    timestamp?: string | number;
+    uuid?: string;
+    [key: string]: any;
+}

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

@@ -1,8 +1,17 @@
 import type { Location } from '../data/Location';
 import type { LocationFilterReason } from '../../enums/LocationFilterReason';
+export interface GeofenceFilterInfo {
+    identifier: string;
+    action: string;
+    reason: string;
+    dist: number;
+    radius: number;
+    outsideBy: number;
+}
 export interface LocationFilterEvent {
     location: Location;
     reason: LocationFilterReason;
     accuracy: number;
     trackingAccuracyThreshold: number;
+    geofence?: GeofenceFilterInfo;
 }

package/dist/enums/LocationFilterReason.d.ts

@@ -2,5 +2,7 @@ export declare const LocationFilterReason: {
     readonly LowAccuracy: "low-accuracy";
     readonly ImpliedSpeed: "implied-speed";
     readonly OutlierCapped: "outlier-capped";
+    readonly GeofenceSpuriousExit: "geofence-spurious-exit";
+    readonly GeofenceDuplicateEnter: "geofence-duplicate-enter";
 };
 export type LocationFilterReason = (typeof LocationFilterReason)[keyof typeof LocationFilterReason];

package/dist/enums/LocationFilterReason.js

@@ -5,4 +5,6 @@ exports.LocationFilterReason = {
     LowAccuracy: 'low-accuracy',
     ImpliedSpeed: 'implied-speed',
     OutlierCapped: 'outlier-capped',
+    GeofenceSpuriousExit: 'geofence-spurious-exit',
+    GeofenceDuplicateEnter: 'geofence-duplicate-enter',
 };

package/dist/index.d.ts

@@ -51,4 +51,5 @@ export * from './core/api/Logger';
 export * from './core/api/DeviceSettings';
 export * from './core/api/CurrentPositionRequest';
 export * from './core/api/WatchPositionRequest';
+export * from './core/api/LocationQuery';
 export * from './core/api/TransistorAuthorizationService';

package/dist/index.js

@@ -67,4 +67,5 @@ __exportStar(require("./core/api/Logger"), exports);
 __exportStar(require("./core/api/DeviceSettings"), exports);
 __exportStar(require("./core/api/CurrentPositionRequest"), exports);
 __exportStar(require("./core/api/WatchPositionRequest"), exports);
+__exportStar(require("./core/api/LocationQuery"), exports);
 __exportStar(require("./core/api/TransistorAuthorizationService"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transistorsoft/background-geolocation-types",
-  "version": "5.2.0",
+  "version": "5.2.2",
   "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>",