@transistorsoft/background-geolocation-types 5.0.0 → 5.1.0

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

@@ -1,6 +1,7 @@
 import type { Logger } from './Logger';
 import type { DeviceSettings } from './DeviceSettings';
 import type { CurrentPositionRequest } from './CurrentPositionRequest';
+import type { WatchPositionRequest } from './WatchPositionRequest';
 import type { Config } from '../config/Config';
 import type { State } from './State';
 import type { Location } from '../data/Location';
@@ -81,8 +82,8 @@ export interface BackgroundGeolocationAPI extends BackgroundGeolocationEvents {
     getState(): Promise<State>;
     setConfig(config: Partial<Config>): Promise<State>;
     getCurrentPosition(options?: CurrentPositionRequest): Promise<Location>;
-    watchPosition(cb: (location: Location) => void, options?: CurrentPositionRequest): Subscription;
-    stopWatchPosition?(sub?: Subscription): void;
+    watchPosition(options: WatchPositionRequest, locationCallback: (location: Location) => void, errorCallback?: (errorCode: number) => void): Subscription;
+    stopWatchPosition?(watchId?: number): void;
     resetOdometer(): Promise<number>;
     setOdometer(value: number): Promise<number>;
     getOdometer(): Promise<number>;
@@ -114,6 +115,7 @@ export interface BackgroundGeolocationAPI extends BackgroundGeolocationEvents {
     finishHeadlessTask(taskId: string): Promise<number>;
     findOrCreateTransistorAuthorizationToken(orgname: string, username: string, url?: string): Promise<TransistorAuthorizationToken>;
     destroyTransistorAuthorizationToken(url: string): Promise<void>;
+    playSound(soundId: number | string): void;
 }
 export interface BackgroundGeolocation extends BackgroundGeolocationAPI {
     LogLevel: typeof import('../../enums/LogLevel').LogLevel;

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

@@ -0,0 +1,8 @@
+import type { DesiredAccuracy } from '../../enums/DesiredAccuracy';
+export interface WatchPositionRequest {
+    interval?: number;
+    desiredAccuracy?: DesiredAccuracy;
+    persist?: boolean;
+    extras?: Record<string, any>;
+    timeout?: number;
+}

package/dist/core/api/WatchPositionRequest.js

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

package/dist/core/config/PersistenceConfig.d.ts

@@ -8,4 +8,5 @@ export interface PersistenceConfig {
     persistMode?: PersistMode;
     extras?: Record<string, any>;
     disableProviderChangeRecord?: boolean;
+    timestampFormat?: 'iso' | 'epoch';
 }

package/dist/enums/Event.d.ts

@@ -9,11 +9,11 @@ export declare const Event: {
     readonly Http: "http";
     readonly Heartbeat: "heartbeat";
     readonly ProviderChange: "providerchange";
+    readonly Schedule: "schedule";
+    readonly Notification: "notification";
     readonly Authorization: "authorization";
     readonly ConnectivityChange: "connectivitychange";
     readonly EnabledChange: "enabledchange";
     readonly PowerSaveChange: "powersavechange";
-    readonly Schedule: "schedule";
-    readonly Notification: "notification";
 };
 export type Event = (typeof Event)[keyof typeof Event];

package/dist/enums/Event.js

@@ -12,10 +12,10 @@ exports.Event = {
     Http: 'http',
     Heartbeat: 'heartbeat',
     ProviderChange: 'providerchange',
+    Schedule: 'schedule',
+    Notification: 'notification',
     Authorization: 'authorization',
     ConnectivityChange: 'connectivitychange',
     EnabledChange: 'enabledchange',
-    PowerSaveChange: 'powersavechange',
-    Schedule: 'schedule',
-    Notification: 'notification'
+    PowerSaveChange: 'powersavechange'
 };

package/dist/index.d.ts

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

package/dist/index.js

@@ -64,4 +64,5 @@ __exportStar(require("./core/api/State"), exports);
 __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/TransistorAuthorizationService"), exports);

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@transistorsoft/background-geolocation-types",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "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",
+  "license": "MIT",
   "homepage": "https://github.com/transistorsoft/background-geolocation",
   "repository": {
     "type": "git",
@@ -35,17 +35,19 @@
     }
   },
   "sideEffects": false,
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsc -p tsconfig.json",
+    "watch": "tsc -p tsconfig.json -w",
+    "prepare": "pnpm run build",
+    "docs": "typedoc --options typedoc.json",
+    "prepublishOnly": "pnpm run build"
+  },
   "devDependencies": {
     "@types/node": "^24.10.0",
     "rimraf": "^5.0.0",
     "typedoc": "^0.28.14",
     "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.6.0"
-  },
-  "scripts": {
-    "clean": "rimraf dist",
-    "build": "tsc -p tsconfig.json",
-    "watch": "tsc -p tsconfig.json -w",
-    "docs": "typedoc --options typedoc.json"
   }
-}
+}

package/typedoc.json

@@ -6,7 +6,7 @@
   "githubUser": "transistorsoft",
   "out": "docs",
   "readme": "none",
-  "highlightLanguages": ["ts", "js", "json", "xml", "bash", "console", "erb", "java"],
+  "highlightLanguages": ["ts", "js", "json", "xml", "bash", "console", "erb", "java", "objc"],
   "disableSources": true,	
   "includeVersion": true,
   "sort": ["source-order"],
@@ -24,5 +24,15 @@
     "./tools/typedoc-plugin-gitlink/index.cjs",
     "./tools/typedoc-plugin-mediaplayer/index.cjs",
     "./tools/typedoc-plugin-site/index.cjs"
-  ]
+  ],
+  "customCss": "./assets/css/theme.css",
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": true,
+    "includeFolders": false,
+    "compactFolders": true,
+    "excludeReferences": true
+  },
+  "categorizeByGroup": true
+
 }