react-native-background-geolocation 4.19.1 → 5.0.0-beta.1

package/src/native/specs/NativeBackgroundGeolocation.ts

@@ -0,0 +1,49 @@
+import type {TurboModule} from 'react-native';
+import {TurboModuleRegistry} from 'react-native';
+
+export interface Spec extends TurboModule {
+  // Core lifecycle
+  ready(config: Object): Promise<Object>;
+  setConfig(config: Object): Promise<Object>;
+  reset(config: Object | null): Promise<Object>;
+  getState(): Promise<Object>;
+
+  start(): Promise<Object>;
+  stop(): Promise<Object>;
+  startGeofences(): Promise<Object>;
+  startSchedule(): Promise<Object>;
+  stopSchedule(): Promise<Object>;
+
+  // Geolocation
+  getCurrentPosition(options: Object): Promise<Object>;
+  changePace(isMoving: boolean): Promise<void>;
+  getOdometer(): Promise<number>;
+  setOdometer(value: number): Promise<Object>;
+
+  // HTTP & DB
+  getLocations(): Promise<Array<Object>>;
+  getCount(): Promise<number>;
+  destroyLocations(): Promise<void>;
+  sync(): Promise<Array<Object>>;
+
+  // Device / settings
+  getProviderState(): Promise<Object>;
+  getDeviceInfo(): Promise<Object>;
+  isPowerSaveMode(): Promise<boolean>;
+  isIgnoringBatteryOptimizations(): Promise<boolean>;
+  requestPermission(): Promise<number>;
+  requestTemporaryFullAccuracy(purpose: string): Promise<number>;
+
+  // Transistor token helpers
+  getTransistorToken(
+    orgname: string,
+    username: string,
+    url: string,
+  ): Promise<Object>;
+  destroyTransistorToken(url: string): Promise<void>;
+
+  // Logging
+  log(level: string, message: string): Promise<void>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('RNBackgroundGeolocation');

package/tests/enums-bridge-test.js

@@ -0,0 +1,16 @@
+const BG = require('../src/index.js').default;
+const Shared = require('@transistorsoft/background-geolocation-types');
+
+test('RN enum namespaces mirror shared enum values', () => {
+  // Spot-check full object equality for safety
+  expect(BG.LogLevel).toEqual(Shared.LogLevel);
+  expect(BG.DesiredAccuracy).toEqual(Shared.DesiredAccuracy);
+  expect(BG.PersistMode).toEqual(Shared.PersistMode);
+  expect(BG.AuthorizationStrategy).toEqual(Shared.AuthorizationStrategy);
+  expect(BG.LocationFilterPolicy).toEqual(Shared.LocationFilterPolicy);
+  expect(BG.KalmanProfile).toEqual(Shared.KalmanProfile);
+  expect(BG.NotificationPriority).toEqual(Shared.NotificationPriority);
+  expect(BG.HttpMethod).toEqual(Shared.HttpMethod);
+  expect(BG.TriggerActivity).toEqual(Shared.TriggerActivity);
+  expect(BG.ActivityType).toEqual(Shared.ActivityType);
+});

package/tests/enums.test.js

@@ -0,0 +1,23 @@
+const BG = require('../src/index.js').default;
+
+test('exposes attached enum namespaces', () => {
+  const BG = require('../src/index.js').default;
+
+  // Core enums
+  expect(BG.LogLevel.Verbose).toBeDefined();
+  expect(BG.DesiredAccuracy.High).toBeDefined();
+  expect(BG.PersistMode.All).toBeDefined();
+  expect(BG.AuthorizationStrategy.Jwt).toBe('jwt');
+  expect(BG.LocationFilterPolicy.Adjust).toBeDefined();
+  expect(BG.KalmanProfile.Default).toBeDefined();
+
+  // Notification priority & activity
+  expect(BG.NotificationPriority.Default).toBeDefined();
+  expect(BG.NotificationPriority.Min).toBeDefined();
+  expect(BG.ActivityType.Other).toBeDefined();
+  expect(BG.ActivityType.AutomotiveNavigation).toBeDefined();
+
+  // HTTP + trigger activity
+  expect(BG.HttpMethod.Post).toBeDefined();
+  expect(BG.TriggerActivity.Walking).toBeDefined();
+});

package/tests/ready-compound.test.js

@@ -0,0 +1,28 @@
+jest.mock('../src/NativeModule', () => ({
+  ready: jest.fn().mockResolvedValue({ enabled: false })
+}));
+
+const NativeModule = require('../src/NativeModule');
+const BG = require('../src/index.js').default;
+
+test('ready forwards compound config to native', async () => {
+  const cfg = {
+    logger: { logLevel: BG.LogLevel.Verbose },
+    geolocation: {
+      desiredAccuracy: BG.DesiredAccuracy.High,
+      distanceFilter: 10,
+    },
+    http: {
+      url: 'https://example.com',
+      autoSync: true,
+    },
+  };
+
+  await BG.ready(cfg);
+
+  expect(NativeModule.ready).toHaveBeenCalledTimes(1);
+  const [arg] = NativeModule.ready.mock.calls[0];
+
+  // Same object shape (or deep-equal)
+  expect(arg).toMatchObject(cfg);
+});

package/tests/ready.test.js

@@ -0,0 +1,6 @@
+const BG = require('../src/index.js').default;
+
+test('ready resolves and returns state', async () => {
+  const state = await BG.ready({ logger: { logLevel: BG.LogLevel.Verbose } });
+  expect(state.enabled).toBe(false);
+});

package/tests-types/config-surface.ts

@@ -0,0 +1,38 @@
+import BackgroundGeolocation, {
+  type Config as RNConfig,
+  type State
+} from 'react-native-background-geolocation';
+
+const config: RNConfig = {
+  logger: {
+    logLevel: BackgroundGeolocation.LogLevel.Verbose,
+  },
+  geolocation: {
+    desiredAccuracy: BackgroundGeolocation.DesiredAccuracy.High,
+    distanceFilter: 10,
+  },
+  http: {
+    url: 'https://example.com',
+    autoSync: true,
+  },
+  persistence: {
+    persistMode: BackgroundGeolocation.PersistMode.All,
+    maxDaysToPersist: 7,
+  },
+  app: {
+    stopOnTerminate: false,
+    startOnBoot: true,
+  },
+  activity: {
+    disableStopDetection: false,
+  },
+};
+
+// Ensure `ready` accepts RNConfig and returns a Promise-like thing
+BackgroundGeolocation.ready(config).then((state: State) => {
+  const enabled: boolean = state.enabled;
+  void enabled;
+});
+
+// no runtime; compile-only
+export {};

package/tests-types/enums-smoke-test.ts

@@ -0,0 +1,35 @@
+// Type-only smoke test to ensure static enum members on BackgroundGeolocation
+// align with the shared @transistorsoft/background-geolocation-types definitions.
+// This test runs via `pnpm run test:types` using tsc --noEmit.
+
+import BackgroundGeolocation from 'react-native-background-geolocation';
+
+// Accessors — ensure all enum namespaces exist and have valid members.
+const logLevelVerbose = BackgroundGeolocation.LogLevel.Verbose;
+const desiredAccuracyHigh = BackgroundGeolocation.DesiredAccuracy.High;
+const persistModeAll = BackgroundGeolocation.PersistMode.All;
+const authJwt = BackgroundGeolocation.AuthorizationStrategy.Jwt;
+const policyAdjust = BackgroundGeolocation.LocationFilterPolicy.Adjust;
+const kalmanDefault = BackgroundGeolocation.KalmanProfile.Default;
+const httpPost = BackgroundGeolocation.HttpMethod.Post;
+const triggerWalking = BackgroundGeolocation.TriggerActivity.Walking;
+const notificationDefault = BackgroundGeolocation.NotificationPriority.Default;
+const activityOther = BackgroundGeolocation.ActivityType.Other;
+
+// Assignments to typed constants to ensure they match the exported type shapes.
+let testLogLevel: typeof BackgroundGeolocation.LogLevel = BackgroundGeolocation.LogLevel;
+let testDesiredAccuracy: typeof BackgroundGeolocation.DesiredAccuracy = BackgroundGeolocation.DesiredAccuracy;
+let testPersistMode: typeof BackgroundGeolocation.PersistMode = BackgroundGeolocation.PersistMode;
+let testAuthorizationStrategy: typeof BackgroundGeolocation.AuthorizationStrategy = BackgroundGeolocation.AuthorizationStrategy;
+let testLocationFilterPolicy: typeof BackgroundGeolocation.LocationFilterPolicy = BackgroundGeolocation.LocationFilterPolicy;
+let testKalmanProfile: typeof BackgroundGeolocation.KalmanProfile = BackgroundGeolocation.KalmanProfile;
+let testHttpMethod: typeof BackgroundGeolocation.HttpMethod = BackgroundGeolocation.HttpMethod;
+let testTriggerActivity: typeof BackgroundGeolocation.TriggerActivity = BackgroundGeolocation.TriggerActivity;
+
+let testNotificationPriority: typeof BackgroundGeolocation.NotificationPriority =
+  BackgroundGeolocation.NotificationPriority;
+let testActivityType: typeof BackgroundGeolocation.ActivityType =
+  BackgroundGeolocation.ActivityType;
+  
+// No runtime code — this is a static type check only.
+export {};

package/tests-types/events-typing.ts

@@ -0,0 +1,23 @@
+import BackgroundGeolocation, {
+  type Location,
+  type GeofenceEvent
+} from 'react-native-background-geolocation';
+
+
+// callbacks should see the bridged types
+BackgroundGeolocation.onLocation((location: Location) => {
+  const loc: Location = location;
+  console.log(loc.coords.latitude, loc.is_moving);
+});
+
+BackgroundGeolocation.onGeofence((event: GeofenceEvent) => {
+  const gfEvent: GeofenceEvent = event;
+  console.log(gfEvent.identifier, gfEvent.location.coords.longitude);
+});
+
+// Ensure that invalid usage fails if uncommented:
+// BackgroundGeolocation.onLocation((location) => {
+//   const bad: string = location; // should be type error
+// });
+
+export {};

package/tests-types/ok.ts

@@ -0,0 +1,20 @@
+import BackgroundGeolocation, { type Geofence } from 'react-native-background-geolocation';
+import type { Config as SharedConfig } from '@transistorsoft/background-geolocation-types';
+
+const gf: Geofence = {
+  identifier: 'home',
+  latitude: 1,
+  longitude: 2,
+  radius: 150,
+  notifyOnEntry: true,
+};
+
+const compoundConfig: SharedConfig = {
+  logger: { logLevel: BackgroundGeolocation.LogLevel.Verbose },
+  geolocation: {
+    desiredAccuracy: BackgroundGeolocation.DesiredAccuracy.High,
+    distanceFilter: 10,
+  },
+};
+
+BackgroundGeolocation.ready(compoundConfig);

package/tests-types/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "skipLibCheck": true,
+    "baseUrl": "..",
+    "paths": {
+      "react-native-background-geolocation": ["src/index.d.ts"]
+    }
+  },
+  "include": ["./**/*.ts"]
+}

package/typedoc.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": [
+    "../../background-geolocation-types/src/docs-entry.ts"
+  ],
+  "tsconfig": "../../background-geolocation-types/tsconfig.json",
+
+  "name": "react-native-background-geolocation",
+  "favicon": "../../background-geolocation-types/assets/images/favicon.ico",
+  "includeVersion": false,
+  "out": "docs",
+  "readme": "none",
+  "disableSources": true,
+
+  "sort": ["source-order"],
+  "highlightLanguages": [
+    "ts",
+    "js",
+    "json",
+    "xml",
+    "bash",
+    "console",
+    "erb",
+    "java"
+  ],
+
+  "categoryOrder": [
+    "Primary API",
+    "Config",
+    "Events",
+    "Data",
+    "Logger",
+    "Device",
+    "*"
+  ],
+  "categorizeByGroup": false,
+  "useFirstParagraphOfCommentAsSummary": true,
+  "excludeInternal": true,
+  "excludePrivate": true,
+  "excludeProtected": true,
+
+  "gitRevision": "main",
+
+  "plugin": [
+    "../../background-geolocation-types/tools/typedoc-plugin-gitlink/index.cjs",
+    "../../background-geolocation-types/tools/typedoc-plugin-mediaplayer/index.cjs",
+    "../../background-geolocation-types/tools/typedoc-plugin-site/index.cjs"
+  ]
+}

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.aar.md5

@@ -1 +0,0 @@
-7fec5a5493a79ec6e2e79300c0a56d75

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.aar.sha1

@@ -1 +0,0 @@
-a1a49179a6443f66b1a3ea19eb609edb90eec548

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.aar.sha256

@@ -1 +0,0 @@
-6c4448dcb9a3ab153dbe41aa6096588e116ac1fee3f5024b78a5a0dd90aba1ee

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.aar.sha512

@@ -1 +0,0 @@
-72d0ba3f31bdeaade970dbdcd4b28c73ba60bde3d9f0b90b3bf949dc6dfef153302d89af73b6c51fb5d8a31b5af138515aba08246d0b0d967cce45cebb1130aa

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.pom

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-  <modelVersion>4.0.0</modelVersion>
-  <groupId>com.transistorsoft</groupId>
-  <artifactId>tslocationmanager</artifactId>
-  <version>3.7.0</version>
-  <packaging>aar</packaging>
-</project>

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.pom.md5

@@ -1 +0,0 @@
-82ad6df0aee643ef3ebf790de03acef7

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.pom.sha1

@@ -1 +0,0 @@
-9684ad3cb8b79f7922b9f963f7d2d40b1aba72be

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.pom.sha256

@@ -1 +0,0 @@
-597cbdeaa2b91687d89023f0e1eeb76ebd49b0e1aa0e21e85c69762d62849ff3

package/android/libs/com/transistorsoft/tslocationmanager/3.7.0/tslocationmanager-3.7.0.pom.sha512

@@ -1 +0,0 @@
-5b82413e26b2cc5b0f7e04caeaa7b2f9218a0bd1bb168cf04da59dbb84d2758d90e5d2063a97506c9933ca89870b072558e8fcb51f6a73d9ada44f850d8307f7

package/android/libs/com/transistorsoft/tslocationmanager/maven-metadata.xml

@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
-  <groupId>com.transistorsoft</groupId>
-  <artifactId>tslocationmanager</artifactId>
-  <versioning>
-    <latest>3.7.0</latest>
-    <release>3.7.0</release>
-    <versions>
-      <version>3.7.0</version>
-    </versions>
-    <lastUpdated>20250908142827</lastUpdated>
-  </versioning>
-</metadata>

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.aar.md5

@@ -1 +0,0 @@
-49649b23bd8c15c6149671a4df5186b4

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.aar.sha1

@@ -1 +0,0 @@
-f8d8e6d49d967640dfb5e0b74a173593d6ccb42b

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.aar.sha256

@@ -1 +0,0 @@
-053f111d5992989349e51e5ce530681bf6c16a485e28ef23f693fc5fec0b56c0

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.aar.sha512

@@ -1 +0,0 @@
-e6780bbadbb73d7aac393ceef15fcb86ea534d1e6e4d26452b01f8d53bb370e159ace4ab9b3f8df7f873180ce5b427ee99e044ffee43c25520e701ccb30cae5f

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.pom

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-  <modelVersion>4.0.0</modelVersion>
-  <groupId>com.transistorsoft</groupId>
-  <artifactId>tslocationmanager-v21</artifactId>
-  <version>3.7.0</version>
-  <packaging>aar</packaging>
-</project>

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.pom.md5

@@ -1 +0,0 @@
-6924c39f06c0c0019ce10d0ee0bbbcc7

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.pom.sha1

@@ -1 +0,0 @@
-7d47ac4346f70550c2b4c13347f96bfd09684f6d

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.pom.sha256

@@ -1 +0,0 @@
-28f5c6a73ca1a554fc2e9d69d694e4b82b6f198926af54b6a57bc82b2678851d

package/android/libs/com/transistorsoft/tslocationmanager-v21/3.7.0/tslocationmanager-v21-3.7.0.pom.sha512

@@ -1 +0,0 @@
-993cc9aa111774592cd3256263b3019c6f135afbeccd5e169cb1681fbbd875fc3a3a5a5fbfd883299c5ccdddfe37bf095a82f1a85d1862d0a2334a069fc2f37c

package/android/libs/com/transistorsoft/tslocationmanager-v21/maven-metadata.xml

@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
-  <groupId>com.transistorsoft</groupId>
-  <artifactId>tslocationmanager-v21</artifactId>
-  <versioning>
-    <latest>3.7.0</latest>
-    <release>3.7.0</release>
-    <versions>
-      <version>3.7.0</version>
-    </versions>
-    <lastUpdated>20250908142827</lastUpdated>
-  </versioning>
-</metadata>

package/ios/RNBackgroundGeolocation/TSLocationManager.xcframework/Info.plist

@@ -1,61 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>AvailableLibraries</key>
-	<array>
-		<dict>
-			<key>BinaryPath</key>
-			<string>TSLocationManager.framework/TSLocationManager</string>
-			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
-			<key>LibraryPath</key>
-			<string>TSLocationManager.framework</string>
-			<key>SupportedArchitectures</key>
-			<array>
-				<string>arm64</string>
-			</array>
-			<key>SupportedPlatform</key>
-			<string>ios</string>
-		</dict>
-		<dict>
-			<key>BinaryPath</key>
-			<string>TSLocationManager.framework/Versions/A/TSLocationManager</string>
-			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-maccatalyst</string>
-			<key>LibraryPath</key>
-			<string>TSLocationManager.framework</string>
-			<key>SupportedArchitectures</key>
-			<array>
-				<string>arm64</string>
-				<string>x86_64</string>
-			</array>
-			<key>SupportedPlatform</key>
-			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>maccatalyst</string>
-		</dict>
-		<dict>
-			<key>BinaryPath</key>
-			<string>TSLocationManager.framework/TSLocationManager</string>
-			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
-			<key>LibraryPath</key>
-			<string>TSLocationManager.framework</string>
-			<key>SupportedArchitectures</key>
-			<array>
-				<string>arm64</string>
-				<string>x86_64</string>
-			</array>
-			<key>SupportedPlatform</key>
-			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
-		</dict>
-	</array>
-	<key>CFBundlePackageType</key>
-	<string>XFWK</string>
-	<key>XCFrameworkFormatVersion</key>
-	<string>1.0</string>
-</dict>
-</plist>