@transistorsoft/background-geolocation-types 5.1.2 → 5.2.1

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

@@ -2,6 +2,7 @@ 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';
@@ -18,6 +19,7 @@ import type { HeartbeatEvent } from '../events/HeartbeatEvent';
 import type { GeofencesChangeEvent } from '../events/GeofencesChangeEvent';
 import type { ConnectivityChangeEvent } from '../events/ConnectivityChangeEvent';
 import type { MotionChangeEvent } from '../events/MotionChangeEvent';
+import type { LocationFilterEvent } from '../events/LocationFilterEvent';
 import type { ProviderChangeEvent } from '../events/ProviderChangeEvent';
 import type { HttpEvent } from '../events/HttpEvent';
 import type { AuthorizationStatus } from '../../enums/AuthorizationStatus';
@@ -29,6 +31,7 @@ export interface EventPayloads {
     location: Location;
     motionchange: MotionChangeEvent;
     activitychange: MotionActivityEvent;
+    locationfilter: LocationFilterEvent;
     geofence: GeofenceEvent;
     geofenceschange: GeofencesChangeEvent;
     http: HttpEvent;
@@ -53,6 +56,7 @@ export interface EventPayloads {
 export interface BackgroundGeolocationEvents {
     onLocation(cb: (location: Location) => void, onError?: (err: LocationError) => void): Subscription;
     onMotionChange(cb: (event: MotionChangeEvent) => void): Subscription;
+    onLocationFilter(cb: (event: LocationFilterEvent) => void): Subscription;
     onGeofence(cb: (event: GeofenceEvent) => void): Subscription;
     onGeofencesChange(cb: (event: GeofencesChangeEvent) => void): Subscription;
     onActivityChange(cb: (event: MotionActivityEvent) => void): Subscription;
@@ -107,7 +111,7 @@ export interface BackgroundGeolocationAPI extends BackgroundGeolocationEvents {
     destroyLocations(): Promise<void>;
     destroyLocation(uuid: string): Promise<void>;
     insertLocation(location: Location): Promise<Location>;
-    getLocations(): Promise<Array<Object>>;
+    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/events/LocationFilterEvent.d.ts

@@ -0,0 +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/core/events/LocationFilterEvent.js

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

package/dist/enums/Event.d.ts

@@ -4,6 +4,7 @@ export declare const Event: {
     readonly Location: "location";
     readonly MotionChange: "motionchange";
     readonly ActivityChange: "activitychange";
+    readonly LocationFilter: "locationfilter";
     readonly Geofence: "geofence";
     readonly GeofencesChange: "geofenceschange";
     readonly Http: "http";

package/dist/enums/Event.js

@@ -7,6 +7,7 @@ exports.Event = {
     Location: 'location',
     MotionChange: 'motionchange',
     ActivityChange: 'activitychange',
+    LocationFilter: 'locationfilter',
     Geofence: 'geofence',
     GeofencesChange: 'geofenceschange',
     Http: 'http',

package/dist/enums/LocationFilterReason.d.ts

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocationFilterReason = void 0;
+exports.LocationFilterReason = {
+    LowAccuracy: 'low-accuracy',
+    ImpliedSpeed: 'implied-speed',
+    OutlierCapped: 'outlier-capped',
+    GeofenceSpuriousExit: 'geofence-spurious-exit',
+    GeofenceDuplicateEnter: 'geofence-duplicate-enter',
+};

package/dist/index.d.ts

@@ -17,6 +17,7 @@ export * from './enums/GeofenceAction';
 export * from './enums/Event';
 export * from './enums/ActivityType';
 export * from './enums/LocationError';
+export * from './enums/LocationFilterReason';
 export * from './enums/SQLQueryOrder';
 export * from "./core/data/Location";
 export * from './core/data/Geofence';
@@ -31,6 +32,7 @@ export * from "./core/events/HeartbeatEvent";
 export * from "./core/events/GeofencesChangeEvent";
 export * from "./core/events/ConnectivityChangeEvent";
 export * from "./core/events/MotionChangeEvent";
+export * from "./core/events/LocationFilterEvent";
 export * from "./core/events/ProviderChangeEvent";
 export * from "./core/events/HttpEvent";
 export * from './core/config/Config';
@@ -49,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

@@ -33,6 +33,7 @@ __exportStar(require("./enums/GeofenceAction"), exports);
 __exportStar(require("./enums/Event"), exports);
 __exportStar(require("./enums/ActivityType"), exports);
 __exportStar(require("./enums/LocationError"), exports);
+__exportStar(require("./enums/LocationFilterReason"), exports);
 __exportStar(require("./enums/SQLQueryOrder"), exports);
 __exportStar(require("./core/data/Location"), exports);
 __exportStar(require("./core/data/Geofence"), exports);
@@ -47,6 +48,7 @@ __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/LocationFilterEvent"), exports);
 __exportStar(require("./core/events/ProviderChangeEvent"), exports);
 __exportStar(require("./core/events/HttpEvent"), exports);
 __exportStar(require("./core/config/Config"), exports);
@@ -65,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.1.2",
+  "version": "5.2.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>",