react-native-background-geolocation 4.19.2 → 5.0.0-beta.2

package/jest.config.js

@@ -0,0 +1,14 @@
+/** @type {import('jest').Config} */
+
+module.exports = {
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src', '<rootDir>/tests'],
+  transform: {
+    '^.+\\.[jt]sx?$': 'babel-jest'
+  },
+  moduleNameMapper: {
+    '^react-native$': '<rootDir>/mocks/react-native'
+  },
+  testPathIgnorePatterns: ['/node_modules/', '/dist/'],
+  transformIgnorePatterns: ['/node_modules/']
+};

package/mocks/react-native.js

@@ -0,0 +1,52 @@
+const listeners = new Set();
+
+class NativeEventEmitter {
+  addListener(event, cb) {
+    const sub = { remove: () => listeners.delete(sub) };
+    listeners.add(sub);
+    return sub;
+  }
+  removeAllListeners() { listeners.clear(); }
+}
+
+const RNBackgroundGeolocation = {
+  // Minimal surface your JS calls in tests:
+  ready: (cfg, ok) => ok?.({ enabled: false }),
+  configure: (cfg, ok) => ok?.({}),
+  setConfig: (cfg, ok) => ok?.({}),
+  reset: (cfg, ok) => ok?.({ enabled: false }),
+  getState: (ok) => ok?.({ enabled: false }),
+  beginBackgroundTask: (ok) => ok?.(1),
+  finish: (id, ok) => ok?.(id),
+  addGeofence: (_cfg, ok) => ok?.(),
+  addGeofences: (_list, ok) => ok?.(),
+  removeGeofence: (_id, ok) => ok?.(),
+  removeGeofences: (ok) => ok?.(),
+  getGeofences: (ok) => ok?.([]),
+  getGeofence: (_id, ok) => ok?.(null),
+  geofenceExists: (_id, cb) => cb(false),
+  changePace: (_b, ok) => ok?.(),
+  getLog: (ok) => ok?.(''),
+  destroyLog: (ok) => ok?.(),
+  emailLog: (_email, ok) => ok?.(),
+  getOdometer: (ok) => ok?.(0),
+  setOdometer: (_v, ok) => ok?.({}),
+  getLocations: (ok) => ok?.([]),
+  getCount: (ok) => ok?.(0),
+  destroyLocations: (ok) => ok?.(),
+  insertLocation: (_p, ok) => ok?.({}),
+  sync: (ok) => ok?.({ success: true }),
+  getProviderState: (ok) => ok?.({ enabled: true }),
+  requestPermission: (ok) => ok?.(1),
+  requestTemporaryFullAccuracy: (_p, ok) => ok?.(1),
+  log: () => {},
+  getDeviceInfo: (ok) => ok?.({ model: 'mock' }),
+  playSound: () => {},
+};
+
+module.exports = {
+  NativeModules: { RNBackgroundGeolocation },
+  NativeEventEmitter,
+  Platform: { OS: 'ios' },
+  AppRegistry: { registerHeadlessTask: () => {} },
+};

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "react-native-background-geolocation",
-  "version": "4.19.2",
+  "version": "5.0.0-beta.2",
   "description": "The most sophisticated cross-platform background location-tracking & geofencing module with battery-conscious motion-detection intelligence",
-  "scripts": {
-    "build": "yarn run build:expo",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build:expo": "rimraf expo/plugin/build && tsc --build ./expo/plugin",
-    "prepublishOnly": "npm run build"
+  "codegenConfig": {
+    "name": "RNBackgroundGeolocation",
+    "type": "modules",
+    "jsSrcsDir": "./src/specs",
+    "android": {
+      "javaPackageName": "com.transistorsoft.rnbackgroundgeolocation"
+    },
+    "ios": {
+      "swiftModuleName": "RNBackgroundGeolocation",
+      "packageName": "RNBackgroundGeolocation"
+    }
   },
   "main": "src/index.js",
   "repository": {
@@ -24,23 +30,32 @@
     "geofence",
     "geofencing"
   ],
+  "dependencies": {
+    "@babel/runtime": "^7.26.0",
+    "@transistorsoft/background-geolocation-types": "^5.0.1",
+    "tslib": "^2.6.3"
+  },
   "author": "Chris Scott <chris@transistorsoft.com>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/transistorsoft/react-native-background-geolocation/issues"
   },
   "homepage": "https://www.transistorsoft.com/shop/products/react-native-background-geolocation",
-  "dependencies": {
-    "react-native-background-fetch": "~4.2.6"
-  },
   "devDependencies": {
     "@expo/config-plugins": "^4.1.0",
-    "@transistorsoft/typedoc-theme": "^2.0.9",
     "@types/node": "^18.11.5",
     "chalk": "^4.1.0",
     "fs-extra": "^9.1.0",
     "path": "^0.12.7",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.6.2"
+    "rimraf": "^5.0.0",
+    "typedoc": "^0.28.14",
+    "typescript": "^5.6.0"
+  },
+  "scripts": {
+    "build": "yarn run build:expo",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build:expo": "rimraf expo/plugin/build && tsc --build ./expo/plugin",
+    "docs": "node ./scripts/generate-docs.mjs",
+    "docs:publish": "./scripts/publish-docs.sh"
   }
-}
+}

package/src/DeviceSettings.js

@@ -16,37 +16,20 @@ let resolveSettingsRequest = function(resolve, request) {
 
 export default class DeviceSettings {
   isIgnoringBatteryOptimizations() {
-    return new Promise((resolve, reject) => {
-      let success = (isIgnoring) => { resolve(isIgnoring) }
-      let failure = (error) => { reject(error) }
-      RNBackgroundGeolocation.isIgnoringBatteryOptimizations(success, failure);
-    });
+    return RNBackgroundGeolocation.isIgnoringBatteryOptimizations();
   }
 
-  showIgnoreBatteryOptimizations() {
-    return new Promise((resolve, reject) => {
-      let success = (request) => { resolveSettingsRequest(resolve, request) }
-      let failure = (error) => { reject(error) }
-      let args = {action: IGNORE_BATTERY_OPTIMIZATIONS};
-      RNBackgroundGeolocation.requestSettings(args, success, failure);
-    });
+  showIgnoreBatteryOptimizations() {    
+    const args = {action: IGNORE_BATTERY_OPTIMIZATIONS};
+    return RNBackgroundGeolocation.requestSettings(args);
   }
 
   showPowerManager() {
-    return new Promise((resolve, reject) => {
-      let success = (request) => { resolveSettingsRequest(resolve, request) }
-      let failure = (error) => { reject(error) }
-      let args = {action: POWER_MANAGER};
-      RNBackgroundGeolocation.requestSettings(args, success, failure);
-    });
+    const args = {action: POWER_MANAGER};
+    return RNBackgroundGeolocation.requestSettings(args);
   }
 
   show(request) {
-    return new Promise((resolve, reject) => {
-      let success = (success) => { resolve(success) }
-      let failure = (error) => { reject(error) }
-      let args = {action: request.action};
-      RNBackgroundGeolocation.showSettings(args, success, failure);
-    });
+    return RNBackgroundGeolocation.showSettings(args);
   }
 }

package/src/Logger.js

@@ -1,8 +1,9 @@
+// Logger.js
 'use strict';
 
-import { NativeModules } from "react-native"
+import NativeModule from "./NativeModule";
 
-const { RNBackgroundGeolocation } = NativeModules;
+const RNBackgroundGeolocation = NativeModule; // uses the same getNativeBGGeo() under the hood
 
 const LOG_LEVEL_DEBUG = "debug";
 const LOG_LEVEL_NOTICE = "notice";
@@ -14,12 +15,16 @@ const ORDER_ASC = 1;
 const ORDER_DESC = -1;
 
 function log(level, msg) {
+  // You can either:
+  // 1) call the native logger via NativeModule.logger
+  //    NativeModule.logger[level](msg);
+  // or
+  // 2) just use the native `log` directly if exposed:
   RNBackgroundGeolocation.log(level, msg);
 }
 
 function validateQuery(query) {
   if (typeof(query) !== 'object') return {};
-
   if (query.hasOwnProperty('start') && isNaN(query.start)) {
     throw new Error('Invalid SQLQuery.start.  Expected unix timestamp but received: ' + query.start);
   }
@@ -33,58 +38,25 @@ export default class Logger {
   static get ORDER_ASC() { return ORDER_ASC; }
   static get ORDER_DESC() { return ORDER_DESC; }
 
-  static debug(msg) {
-    log(LOG_LEVEL_DEBUG, msg);
-  }
-
-  static error(msg) {
-    log(LOG_LEVEL_ERROR, msg);
-  }
-
-  static warn(msg) {
-    log(LOG_LEVEL_WARN, msg);
-  }
-
-  static info(msg) {
-    log(LOG_LEVEL_INFO, msg);
-  }
-
-  static notice(msg) {
-    log(LOG_LEVEL_NOTICE, msg);
-  }
+  static debug(msg)  { log(LOG_LEVEL_DEBUG, msg);  }
+  static error(msg)  { log(LOG_LEVEL_ERROR, msg);  }
+  static warn(msg)   { log(LOG_LEVEL_WARN, msg);   }
+  static info(msg)   { log(LOG_LEVEL_INFO, msg);   }
+  static notice(msg) { log(LOG_LEVEL_NOTICE, msg); }
 
   static getLog(query) {
-    query = validateQuery(query);
-    return new Promise((resolve, reject) => {
-      let success = (log) => { resolve(log) }
-      let failure = (error) => { reject(error) }
-      RNBackgroundGeolocation.getLog(query, success, failure);
-    });
+    return RNBackgroundGeolocation.getLog(validateQuery(query));
   }
 
-  static emailLog(email, query) {
-    query = validateQuery(query);
-    return new Promise((resolve, reject) => {
-      let success = (success) => { resolve(success) }
-      let failure = (error) => { reject(error) }
-      RNBackgroundGeolocation.emailLog(email, query, success, failure);
-    });
+  static emailLog(email, query) {    
+    return RNBackgroundGeolocation.emailLog(email, validateQuery(query));
   }
 
   static uploadLog(url, query) {
-    query = validateQuery(query);
-    return new Promise((resolve, reject) => {
-      let success = (success) => { resolve(success) }
-      let failure = (error) => { reject(error) }
-      RNBackgroundGeolocation.uploadLog(url, query, success, failure);
-    });
+    return RNBackgroundGeolocation.uploadLog(url, validateQuery(query));
   }
 
   static destroyLog() {
-    return new Promise((resolve, reject) => {
-      let success = (success) => { resolve(success) }
-      let failure = (error)  => { reject(error) }
-      RNBackgroundGeolocation.destroyLog(success, failure);
-    });
+    return RNBackgroundGeolocation.destroyLog();
   }
 }