react-native-background-geolocation 4.3.0 → 4.4.3

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # Change Log
 
+## 4.4.3 — 2021-11-10
+* [Fixed][iOS] Backwards compatibility issue:  react-native@0.66 does have this method.  `No visible @interface for 'RCTEventEmitter' declares the selector 'invalidate' in RNBackgroundGeolocation.m`.  
+
+## 4.4.2 — 2021-10-29
+* [Fixed][Android] Android 12 behaviour changes mean that foreground-services remain running.  When an Android app is terminated, the app process does not terminate (since the foreground-service is active) and `RNBackgroundGeolocationModule` remains in memory.  Given that, the plugin cannot rely on registering its event-listeners in the `RNBackgroundGeolocationModule` constructor, but must perform that task when `.ready()` is called.  This also requires resetting `mReady = false` when the `MainActivity` is destroyed, so that the next time `.ready()` is called, the event-listeners are re-registered.
+* [Fixed][Android] When `.ready()` is called __`reset: false`__, the `success` callback was not invoked with the current `State`.  This bug was introduced in previous `v4.4.1`.
+
+## 4.4.1 — 2021-10-29
+* [Added] Added a `Subscription` interface to Typescript API.  Added helpful docs to Subscription for new event-handler subscriptions.
+
+```typescript
+import BackgroundGeolocation, {
+  Subscription
+} from "...";
+.
+.
+.
+const subscription:Subscription = BacckgroundGeolocation.onLocation(myHandler);
+```
+
+## 4.4.0 — 2021-10-25
+* [Added] New `Authorization.strategy "SAS"` (alternative to default `JWT`).
+* [Fixed] Fixed __`RCTEventEmitter`__ warning "addListener", "removeListeners".  A corresponding fix has also been released for [react-native-background-fetch](https://github.com/transistorsoft/react-native-background-fetch/blob/master/CHANGELOG.md#404--2021-10-22) so be sure to update to `background-fetch >= 4.0.4`.
+* [Changed] **Deprecated** `BackgroundGeolocation.removeListener`.  All event-handlers now return a `react-native` `Subscription` instance containing a `.remove()` method.  You will keep track of your own `subscription` instances and call `.remove()` upon them when you wish to remove an event listener.  Eg:
+
+```javascript
+/// OLD
+const onLocation = (location) => {
+    console.log('[onLocation');
+}
+BackgroundGeolocation.onLocation(onLocation);
+...
+// deprecated: removeListener
+BackgroundGeolocation.removeListener('location', onLocation);
+
+/// NEW:  capture returned subscription instance.
+const onLocationSubscription = BackgroundGeolocation.onLocation(onLocation);
+...
+// Removing an event-listener.
+onLocationSubscription.remove();
+```
+
 ## 4.3.0 — 2021-09-14
 
 * [Added][Android] Implement new Android 12 "reduced accuracy" mechanism `requestTemporaryFullAccuracy`.

package/README.md

@@ -29,6 +29,7 @@ The **[Android module](http://www.transistorsoft.com/shop/products/react-native-
 ![Settings](https://dl.dropboxusercontent.com/s/8oad228siog49kt/settings-framed-350.png?dl=1)
 
 # Contents
+- ### 😫 [Help!](../../wiki/Help)
 - ### :books: [API Documentation](https://transistorsoft.github.io/react-native-background-geolocation)
 - ### [Installing the Plugin](#large_blue_diamond-installing-the-plugin)
 - ### [Setup Guides](#large_blue_diamond-setup-guides)
@@ -136,40 +137,77 @@ For more information, see [this blog post](https://medium.com/@transistorsoft/ne
 
 There are three main steps to using `BackgroundGeolocation`
 1. Wire up event-listeners.
-2. `#ready` the plugin.
-3. `#start` the plugin.
+2. `.ready(config)` the plugin.
+3. `.start()` the plugin.
+
+:warning: Do not execute *any* API method which will require accessing location-services until the **`.ready(config)`** method resolves (eg: `#getCurrentPosition`, `#watchPosition`, `#start`).
 
 ```javascript
-// Import BackgroundGeolocation + any optional interfaces
-import BackgroundGeolocation from "react-native-background-geolocation";
+// NO!  .ready() has not resolved.
+BackgroundGeolocation.getCurrentPosition(options);
+BackgroundGeolocation.start();
+
+BackgroundGeolocation.ready(config).then((state) => {
+  // YES -- .ready() has now resolved.
+  BackgroundGeolocation.getCurrentPosition(options);
+  BackgroundGeolocation.start();  
+});
+
+// NO!  .ready() has not resolved.
+BackgroundGeolocation.getCurrentPosition(options);
+BackgroundGeolocation.start();
+```
 
-export default class App extends Component {
-  componentWillMount() {
-    ////
-    // 1.  Wire up event-listeners
-    //
 
-    // This handler fires whenever bgGeo receives a location update.
-    BackgroundGeolocation.onLocation(this.onLocation, this.onError);
+### Example 1. — React *Functional Component*
 
-    // This handler fires when movement states changes (stationary->moving; moving->stationary)
-    BackgroundGeolocation.onMotionChange(this.onMotionChange);
+<details>
+  <summary>Show Source</summary>
 
-    // This event fires when a change in motion activity is detected
-    BackgroundGeolocation.onActivityChange(this.onActivityChange);
+```javascript
+
+import React from 'react';
+import {
+  Switch,
+  Text,
+  View,
+} from 'react-native';
 
-    // This event fires when the user toggles location-services authorization
-    BackgroundGeolocation.onProviderChange(this.onProviderChange);
+import BackgroundGeolocation, {
+  Location,
+  Subscription
+} from "react-native-background-geolocation";
 
-    ////
-    // 2.  Execute #ready method (required)
-    //
+const HelloWorld = () => {
+  const [enabled, setEnabled] = React.useState(false);
+  const [location, setLocation] = React.useState('');
+
+  React.useEffect(() => {
+    /// 1.  Subscribe to events.
+    const onLocation:Subscription = BackgroundGeolocation.onLocation((location) => {
+      console.log('[onLocation]', location);
+      setLocation(JSON.stringify(location, null, 2));
+    })
+
+    const onMotionChange:Subscription = BackgroundGeolocation.onMotionChange((event) => {
+      console.log('[onMotionChange]', event);
+    });
+
+    const onActivityChange:Subscription = BackgroundGeolocation.onActivityChange((event) => {
+      console.log('[onMotionChange]', event);
+    })
+
+    const onProviderChange:Subscription = BackgroundGeolocation.onProviderChange((event) => {
+      console.log('[onProviderChange]', event);
+    })
+
+    /// 2. ready the plugin.
     BackgroundGeolocation.ready({
       // Geolocation Config
       desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
       distanceFilter: 10,
       // Activity Recognition
-      stopTimeout: 1,
+      stopTimeout: 5,
       // Application config
       debug: true, // <-- enable this hear sounds for background-geolocation life-cycle.
       logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE,
@@ -185,68 +223,178 @@ export default class App extends Component {
       params: {               // <-- Optional HTTP params
         "auth_token": "maybe_your_server_authenticates_via_token_YES?"
       }
-    }, (state) => {
+    }).then((state) => {
+      setEnabled(state.enabled)
       console.log("- BackgroundGeolocation is configured and ready: ", state.enabled);
+    });
+
+    return () => {
+      // Remove BackgroundGeolocation event-subscribers when the View is removed or refreshed
+      // during development live-reload.  Without this, event-listeners will accumulate with
+      // each refresh during live-reload.
+      onLocation.remove();
+      onMotionChange.remove();
+      onActivityChange.remove();
+      onProviderChange.remove();
+    }
+  }, []);
+
+  /// 3. start / stop BackgroundGeolocation
+  React.useEffect(() => {
+    if (enabled) {
+      BackgroundGeolocation.start();
+    } else {
+      BackgroundGeolocation.stop();
+      setLocation('');
+    }
+  }, [enabled]);
+
+  return (
+    <View style={{alignItems:'center'}}>
+      <Text>Click to enable BackgroundGeolocation</Text>
+      <Switch value={enabled} onValueChange={setEnabled} />
+      <Text style={{fontFamily:'monospace', fontSize:12}}>{location}</Text>
+    </View>
+  )
+}
 
-      if (!state.enabled) {
-        ////
-        // 3. Start tracking!
-        //
-        BackgroundGeolocation.start(function() {
-          console.log("- Start success");
-        });
+export default HelloWorld;
+```
+
+</details>
+
+### Example 2. &mdash; React *Class Component*
+
+<details>
+  <summary>Show Source</summary>
+
+```javascript
+import React from 'react';
+import {
+  Switch,
+  Text,
+  View,
+} from 'react-native';
+
+import BackgroundGeolocation, {
+  Location,
+  Subscription
+} from "react-native-background-geolocation";
+
+export default class HelloWorld extends React.Component {
+  subscriptions:Subscription[] = [];
+  state:any = {};
+  constructor(props:any) {
+    super(props);
+    this.state = {
+      enabled: false,
+      location: ''
+    }
+  }
+
+  componentDidMount() {
+    /// 1.  Subscribe to BackgroundGeolocation events.
+    this.subscriptions.push(BackgroundGeolocation.onLocation((location) => {
+      console.log('[onLocation]', location);
+      this.setState({location: JSON.stringify(location, null, 2)})
+    }, (error) => {
+      console.log('[onLocation] ERROR:', error);
+    }))
+
+    this.subscriptions.push(BackgroundGeolocation.onMotionChange((event) => {
+      console.log('[onMotionChange]', event);
+    }))
+
+    this.subscriptions.push(BackgroundGeolocation.onActivityChange((event) => {
+      console.log('[onActivityChange]', event);
+    }))
+
+    this.subscriptions.push(BackgroundGeolocation.onProviderChange((event) => {
+      console.log('[onProviderChange]', event);
+    }))
+
+    /// 2. ready the plugin.
+    BackgroundGeolocation.ready({
+      // Geolocation Config
+      desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
+      distanceFilter: 10,
+      // Activity Recognition
+      stopTimeout: 5,
+      // Application config
+      debug: true, // <-- enable this hear sounds for background-geolocation life-cycle.
+      logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE,
+      stopOnTerminate: false,   // <-- Allow the background-service to continue tracking when user closes the app.
+      startOnBoot: true,        // <-- Auto start tracking when device is powered-up.
+      // HTTP / SQLite config
+      url: 'http://yourserver.com/locations',
+      batchSync: false,       // <-- [Default: false] Set true to sync locations to server in a single HTTP request.
+      autoSync: true,         // <-- [Default: true] Set true to sync each location to server as it arrives.
+      headers: {              // <-- Optional HTTP headers
+        "X-FOO": "bar"
+      },
+      params: {               // <-- Optional HTTP params
+        "auth_token": "maybe_your_server_authenticates_via_token_YES?"
       }
-    });
+    }).then((state) => {
+      this.setState({enabled: state.enabled});
+      console.log("- BackgroundGeolocation is configured and ready: ", state.enabled);
+    })
   }
 
-  // You must remove listeners when your component unmounts
+  /// When view is destroyed (or refreshed during development live-reload),
+  /// remove BackgroundGeolocation event subscriptions.
   componentWillUnmount() {
-    BackgroundGeolocation.removeListeners();
-  }
-  onLocation(location) {
-    console.log('[location] -', location);
-  }
-  onError(error) {
-    console.warn('[location] ERROR -', error);
-  }
-  onActivityChange(event) {
-    console.log('[activitychange] -', event);  // eg: 'on_foot', 'still', 'in_vehicle'
+    this.subscriptions.forEach((subscription) => subscription.remove());
   }
-  onProviderChange(provider) {
-    console.log('[providerchange] -', provider.enabled, provider.status);
+
+  onToggleEnabled(value:boolean) {
+    console.log('[onToggleEnabled]', value);
+    this.setState({enabled: value})
+    if (value) {
+      BackgroundGeolocation.start();
+    } else {
+      this.setState({location: ''});
+      BackgroundGeolocation.stop();
+    }
   }
-  onMotionChange(event) {
-    console.log('[motionchange] -', event.isMoving, event.location);
+
+  render() {
+    return (
+      <View style={{alignItems:'center'}}>
+        <Text>Click to enable BackgroundGeolocation</Text>
+        <Switch value={this.state.enabled} onValueChange={this.onToggleEnabled.bind(this)} />
+        <Text style={{fontFamily:'monospace', fontSize:12}}>{this.state.location}</Text>
+      </View>
+    )
   }
 }
-
-```
-
-```javascript
-BackgroundGeolocation.ready({
-  reset: true,  // <-- true to always apply the supplied config
-  distanceFilter: 10
-}, (state) => {
-  console.log('- BackgroundGeolocation is ready: ', state);
-});
 ```
-
-:warning: Do not execute *any* API method which will require accessing location-services until the callback to **`#ready`** executes (eg: `#getCurrentPosition`, `#watchPosition`, `#start`).
+</details>
 
 ### Promise API
 
-The `BackgroundGeolocation` Javascript API supports [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) for *nearly* every method (the exceptions are **`#watchPosition`** and adding event-listeners via **`#on`** method.  For more information, see the [API Documentation](https://transistorsoft.github.io/react-native-background-geolocation)
+The `BackgroundGeolocation` Javascript API supports [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) for *nearly* every method (the exceptions are **`#watchPosition`** and adding event-listeners via **`#onXXX`** method (eg: `onLocation`).  For more information, see the [API Documentation](https://transistorsoft.github.io/react-native-background-geolocation-android)
 
 ```javascript
-// Traditional API still works:
 BackgroundGeolocation.ready({
-  desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
+  desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH, 
   distanceFilter: 50
 }).then(state => {
   console.log('- BackgroundGeolocation is ready: ', state);
 }).catch(error => {
-  console.log('- BackgroundGeolocation error: ', error);
+  console.warn('- BackgroundGeolocation error: ', error);
 });
+
+// Or use await in an async function
+try {
+  const state = await BackgroundGeolocation.ready({
+    desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH, 
+    distanceFilter: 50
+  })
+  console.log('- BackgroundGeolocation is ready: ', state);
+} catch (error) {
+  console.warn('- BackgroundGeolocation error: ', error);
+}
 ```
 
 ## :large_blue_diamond: [Demo Application](https://github.com/transistorsoft/rn-background-geolocation-demo)

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

@@ -0,0 +1 @@
+3a9143ce4479579c135bbf7f1ca80e9c

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

@@ -0,0 +1 @@
+c16850b24271032c3ccb10349ba0774069a67819

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

@@ -0,0 +1 @@
+e18fc8dd9d37cd2ee00c64e8e1a78ebc0839cf8515cf52463cfdd0761aa580f9

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

@@ -0,0 +1 @@
+566d4327d7b1b9ab3b271dc61d6d661ac1f4c8c89557de1d11c52928a4af5682c702a315e76f2cf46dc882d405fe3c4d6a958c7f0a885a228b3d0b2a735d8305

package/android/libs/com/transistorsoft/tslocationmanager/{3.1.33/tslocationmanager-3.1.33.pom → 3.1.35/tslocationmanager-3.1.35.pom}

@@ -4,6 +4,6 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager</artifactId>
-  <version>3.1.33</version>
+  <version>3.1.35</version>
   <packaging>aar</packaging>
 </project>

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

@@ -0,0 +1 @@
+007e6f97f3eef0a29312b614881094d5

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

@@ -0,0 +1 @@
+a558cd1eb103134e207932ea7af8c6cf48cc97d7

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

@@ -0,0 +1 @@
+f11bf76c75d7d586ceef2978d3bb789deceee30b6c06032edf57647333f98efe

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

@@ -0,0 +1 @@
+d7d2120c48292dc74e273daacad40b19ebfa0617aed7f8fa3b9a8eeb4a10b0ab85e2cc702394f9d1aaf0619b3fdcef728db223c76ffca66288033eb867787acb

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

@@ -3,12 +3,11 @@
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager</artifactId>
   <versioning>
-    <latest>3.1.33</latest>
-    <release>3.1.33</release>
+    <latest>3.1.35</latest>
+    <release>3.1.35</release>
     <versions>
-      <version>3.1.32</version>
-      <version>3.1.33</version>
+      <version>3.1.35</version>
     </versions>
-    <lastUpdated>20210914133755</lastUpdated>
+    <lastUpdated>20211110133724</lastUpdated>
   </versioning>
 </metadata>

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.md5

@@ -0,0 +1 @@
+2f0a4b4aca18ec71d130eb7042ba8334

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.sha1

@@ -0,0 +1 @@
+e7828269f47ca87dd74c5a6952ed1fc464ec074e

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.sha256

@@ -0,0 +1 @@
+1230b611eb4b11c8a65f878e8253cea9f510fac5979f250014c37dc800645054

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.sha512

@@ -0,0 +1 @@
+650b7213bc570d2a8697550f5a03ca42657c190a37c490a82fc762d88d6fe5f1170cba23f68530d90180c19ac795c69142b9d39290495a119314163d1ff9577f

package/android/libs/com/transistorsoft/tslocationmanager-reverse/{3.1.33/tslocationmanager-reverse-3.1.33.pom → 3.1.35/tslocationmanager-reverse-3.1.35.pom}

@@ -4,6 +4,6 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager-reverse</artifactId>
-  <version>3.1.33</version>
+  <version>3.1.35</version>
   <packaging>aar</packaging>
 </project>

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.md5

@@ -0,0 +1 @@
+00b43ef20d3f14d733a05d82c4435aaf

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.sha1

@@ -0,0 +1 @@
+28d26ba8a4044945fd457d033dbdd457dde4144d

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.sha256

@@ -0,0 +1 @@
+5ee1b9a1bf97d7ea8e005f108f18ec78e2410dfdc45a6e29755a28e5df15daf1

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.sha512

@@ -0,0 +1 @@
+db1bf3fe2779d75145bcf1929692b5a87e24f9d4046d783a40d903eb7ef0a780f26062c03be017b2a9bb759778b9969eebda9b952abde90ac9e0dd37912d728f

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

@@ -3,12 +3,11 @@
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager-reverse</artifactId>
   <versioning>
-    <latest>3.1.33</latest>
-    <release>3.1.33</release>
+    <latest>3.1.35</latest>
+    <release>3.1.35</release>
     <versions>
-      <version>3.1.32</version>
-      <version>3.1.33</version>
+      <version>3.1.35</version>
     </versions>
-    <lastUpdated>20210914133755</lastUpdated>
+    <lastUpdated>20211110133724</lastUpdated>
   </versioning>
 </metadata>