react-native-background-geolocation 4.13.2 → 4.14.0

package/ios/RNBackgroundGeolocation/TSLocationManager.xcframework/ios-arm64_x86_64-simulator/TSLocationManager.framework/_CodeSignature/CodeResources

@@ -74,7 +74,7 @@
 		</data>
 		<key>Headers/TSGeofence.h</key>
 		<data>
-		c2OfnwwpLLYt+ehbrddV1bUTQeU=
+		g9BTaWyQizmOylAWApRCoOvizt4=
 		</data>
 		<key>Headers/TSGeofenceEvent.h</key>
 		<data>
@@ -82,7 +82,7 @@
 		</data>
 		<key>Headers/TSGeofenceManager.h</key>
 		<data>
-		4Qvy/tgridoR+/ugedbBRf0DRbw=
+		L0Sw7IQVlaKNK+gs0njVL6hN02s=
 		</data>
 		<key>Headers/TSGeofencesChangeEvent.h</key>
 		<data>
@@ -106,7 +106,7 @@
 		</data>
 		<key>Headers/TSLocationManager.h</key>
 		<data>
-		cPHmrOfvqB/M36VfwCHaSVCWF4o=
+		X2+HcvWlzuI9RHOY/vflS6WjcVg=
 		</data>
 		<key>Headers/TSPowerSaveChangeEvent.h</key>
 		<data>
@@ -138,7 +138,11 @@
 		</data>
 		<key>Info.plist</key>
 		<data>
-		sw/gk7WGqXHgIb/YwIunFEb1Ibo=
+		kkcXy4iuym+vM6Im3Ze1uwJVBBM=
+		</data>
+		<key>Miniball/Miniball.hpp</key>
+		<data>
+		TR41GDyxS/iof60Pri6rj846vkU=
 		</data>
 		<key>Modules/module.modulemap</key>
 		<data>
@@ -338,11 +342,11 @@
 		<dict>
 			<key>hash</key>
 			<data>
-			c2OfnwwpLLYt+ehbrddV1bUTQeU=
+			g9BTaWyQizmOylAWApRCoOvizt4=
 			</data>
 			<key>hash2</key>
 			<data>
-			WGlbGY86mPGw/I6cYYgdh1zpLCrHINfwQj+Z4COFuXw=
+			sCKypPAP5rEoTvON82aLGHAKIIMX8yZPW/ey3JAhaz0=
 			</data>
 		</dict>
 		<key>Headers/TSGeofenceEvent.h</key>
@@ -360,11 +364,11 @@
 		<dict>
 			<key>hash</key>
 			<data>
-			4Qvy/tgridoR+/ugedbBRf0DRbw=
+			L0Sw7IQVlaKNK+gs0njVL6hN02s=
 			</data>
 			<key>hash2</key>
 			<data>
-			FLREH95bTwvsPByCMwXpYpAL/g59PSi1Qds4PrDvspI=
+			EJZnCC5PZkw2GaxqPVLZV2eLpW/G2GgEJM7nFYby1II=
 			</data>
 		</dict>
 		<key>Headers/TSGeofencesChangeEvent.h</key>
@@ -426,11 +430,11 @@
 		<dict>
 			<key>hash</key>
 			<data>
-			cPHmrOfvqB/M36VfwCHaSVCWF4o=
+			X2+HcvWlzuI9RHOY/vflS6WjcVg=
 			</data>
 			<key>hash2</key>
 			<data>
-			STmO4xW4Jg5fkyfyWuzarxmztax42bgQ/8MFqHz0ZNc=
+			TrpWKCiP4P2pNAUvdax23S6/7NBBVDzbhT2IkAhBd7U=
 			</data>
 		</dict>
 		<key>Headers/TSPowerSaveChangeEvent.h</key>
@@ -510,6 +514,17 @@
 			UhY362SyloF998ML4MZxDcYLlsTYdyVCxIXu5XdvILo=
 			</data>
 		</dict>
+		<key>Miniball/Miniball.hpp</key>
+		<dict>
+			<key>hash</key>
+			<data>
+			TR41GDyxS/iof60Pri6rj846vkU=
+			</data>
+			<key>hash2</key>
+			<data>
+			RckEagFQ5wiSUIJvNw+CRzJdlX2S/XbRVQxFqSzIZVM=
+			</data>
+		</dict>
 		<key>Modules/module.modulemap</key>
 		<dict>
 			<key>hash</key>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-background-geolocation",
-  "version": "4.13.2",
+  "version": "4.14.0",
   "description": "The most sophisticated cross-platform background location-tracking & geofencing module with battery-conscious motion-detection intelligence",
   "scripts": {
     "build": "yarn run build:expo",

package/src/declarations/interfaces/Config.d.ts

@@ -1934,7 +1934,7 @@ declare module "react-native-background-geolocation" {
     *
     * Android can detect when the user has configured the device's *Settings->Location* in a manner that does not match your location request (eg: [[desiredAccuracy]].  For example, if the user configures *Settings->Location->Mode* with *Battery Saving* (ie: Wifi only) but you've specifically requested [[DESIRED_ACCURACY_HIGH]] (ie: GPS), Android will show a dialog asking the user to confirm the desired changes.  If the user clicks `[OK]`, the OS will automcatically modify the Device settings.
     *
-    * ![](https://www.dropbox.com/s/3kuw1gzzbnajhgf/android-location-resolution-dialog.png?dl=1)
+    * ![](https://dl.dropbox.com/scl/fi/t7bwdrmogr26rcmrbemkt/android-location-resolution-dialog.png?rlkey=won88t8xo5zcei7ktmurebb5t&dl=1)
     *
     * This automated Android dialog will be shown in the following cases:
     * - [[BackgroundGeolocation.onProviderChange]]

package/src/declarations/interfaces/Geofence.d.ts

@@ -1,11 +1,13 @@
 declare module "react-native-background-geolocation" {
+  type Vertices = number[][];
+
   /**
   * The Background Geolocation SDK implements the native iOS and Android Geofencing APIs.
   *
   * __ℹ️ Note:__
-  * - Native iOS & Android API support only *circular* geofences.
+  * - Native iOS & Android API support only *circular* geofences, however the plugin does implement a custom mechanism for handling *Polygon Geofences*; see [[vertices]].
   * - The minimum reliable [[radius]] is `200` meters.
-  * - Geofence monitoring *requires* the user authorize [[locationAuthorizationRequest]] **`Always`** — **`When in Use`** will **not** work.
+  * - The native geofencing API for both iOS and Android *require* the user authorize [[locationAuthorizationRequest]] **`Always`** — **`When in Use`** will **not** work.
   *
   * ## Adding Geofences
   *
@@ -32,7 +34,7 @@ declare module "react-native-background-geolocation" {
   * Adding multiple geofences with [[addGeofences]].
   * @example
   * ```typescript
-  * BackgroundGeolocation.addGeofences([{
+  * await BackgroundGeolocation.addGeofences([{
   *   identifier: "Home",
   *   radius: 200,
   *   latitude: 45.51921926,
@@ -44,11 +46,9 @@ declare module "react-native-background-geolocation" {
   *   latitude: 45.61921927,
   *   longitude: -73.71678582,
   *   notifyOnEntry: true
-  * }]).then((success) => {
-  *   console.log("[addGeofences] success");
-  * }).catch((error) => {
-  *   console.log("[addGeofences] FAILURE: ", error);
-  * });
+  * }]);
+  * console.log("[addGeofences] success");
+  * 
   * ```
   *
   * __ℹ️ Note:__ Adding a geofence having an [[identifier]] which already exists within the SDK geofence database will cause the previous record to be destroyed and the new one inserted.
@@ -68,6 +68,18 @@ declare module "react-native-background-geolocation" {
   * ```
   *
   * ---------------------------------------------------------------------------------------------------
+  * 
+  * ## Polygon Geofencing
+  *
+  * The Background Geolocation SDK supports *Polygon Geofences* (Geofences of any shape).  See API docs [[vertices]].
+  * * ℹ️ __*Polygon Geofencing*__ is [sold as a separate add-on](https://shop.transistorsoft.com/products/polygon-geofencing) (fully functional in *DEBUG* builds).
+  *  
+  *
+  * ![](https://dl.dropbox.com/scl/fi/sboshfvar0h41azmb4tyv/polygon-geofencing-parc-outremont-400.png?rlkey=d2s0n3zbzu72e7s2gch9kxd4a&dl=1)
+  * ![](https://dl.dropbox.com/scl/fi/xz48myvjnpp8ko0l2tufg/polygon-geofencing-parc-lafontaine-400.png?rlkey=sf20ns959uj0a0fq0atmj55bz&dl=1)
+  *  
+  * 
+  * ---------------------------------------------------------------------------------------------------
   *
   * ## Infinite Geofencing
   *
@@ -101,7 +113,7 @@ declare module "react-native-background-geolocation" {
   *   // Remove map circles
   *   off.forEach((identifier) => {
   *     removeGeofenceMarker(identifier);
-  *   }
+  *   });
   * });
   * ```
   * ### ⚠️ Note:
@@ -111,8 +123,8 @@ declare module "react-native-background-geolocation" {
   *
   * ## Removing Geofences
   *
-  * Once a geofence has been inserted into the SDK's database using [[addGeofence]] or [[addGeofences]], they will be monitored *forever*.  If you've configured [[stopOnTerminate]] __`false`__ and [[startOnBoot]] __`true`__, geofences will continue to be monitored even if the application is terminated or device rebooted.
-  * To cease monitoring a geofence or *geofences*, you must *remove* them from the SDK's database.
+  * Once a geofence has been inserted into the SDK's database using [[addGeofence]] or [[addGeofences]], they will be monitored *forever* (as long as the plugin remains `State.enabled == true`).  If you've configured [[stopOnTerminate]] __`false`__ and [[startOnBoot]] __`true`__, geofences will continue to be monitored even if the application is terminated or device rebooted.
+  * To cease monitoring a geofence or *geofences*, you must *remove* them from the SDK's database (or call [[BackgroundGeolocation.stop]]).
   *
   * - Removing a single geofence by [[identifier]] with [[removeGeofence]]:
   * @example
@@ -219,15 +231,15 @@ declare module "react-native-background-geolocation" {
     * ⚠️ The minimum reliable `radius` is __`200`__ meters.  Anything less will likely not cause a geofence to trigger.  This is documented by Apple [here](https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/LocationAwarenessPG/RegionMonitoring/RegionMonitoring.html):
     * > *"The specific threshold distances are determined by the hardware and the location technologies that are currently available. For example, if WiFi is disabled, region monitoring is significantly less accurate. However, for testing purposes, __you can assume that the minimum distance is approximately 200 meters__*".
     */
-    radius: number;
+    radius?: number;
     /**
     * Latitude of geofence center
     */
-    latitude: number;
+    latitude?: number;
     /**
     * Longitude of geofence center.
     */
-    longitude: number;
+    longitude?: number;
     /**
     * Set `true` to fire event when device *enters* this geofence.
     *
@@ -251,5 +263,57 @@ declare module "react-native-background-geolocation" {
     * Arbitrary key-values appended to the geofence event and posted to your configured [[Config.url]].
     */
     extras?: Extras;
+    /**
+     * Optional: a list of vertices (`[ [lat, lng],...]`) defining a Polygon geofence.  By default, geofences are circular.
+     * 
+     * ℹ️ __*Polygon Geofencing*__ is [sold as a separate add-on](https://shop.transistorsoft.com/products/polygon-geofencing) (fully functional in *DEBUG* builds).
+     *     
+     *
+     * When defining a polygon geofence, you do **not** provide [[latitude]], [[longitude]] or [[radius]] — those will be automatically calculated based upon the geometry of the polygon.
+     *
+     * The following image shows polygon geofences on a map:
+     *
+     * ![](https://dl.dropbox.com/scl/fi/xzf6yau5wcg1az8fy0lbm/geofencing-polygons-on-map.PNG?rlkey=e82h494msbgt8ngu4s2pjwemb&dl=1)
+     *
+     * The *blue polygons* represent the *actual* polygon geofences and the containing *green circles* are traditional circular geofences provided by the native *iOS/Android* Geofencing APIs.  The background-geolocation SDK automatically calculates the containing, native cirular geofence by solving the [*minimum enclosing circle*](https://en.wikipedia.org/wiki/Smallest-circle_problem) for the given [[vertices]].
+     * This is why you do not provide [[latitude]], [[longitude]] and [[radius]].
+     *
+     * - When the device *enters* the containing circular geofence, the SDK uses that as a signal that the device is approaching a polygon.  At this moment, the SDK begins aggressively monitoring the location to perform "hit-testing" upon the polygon using a fast algorithm implemented with C++ code.
+     * - When the device *exits* the containing circular geofence, that's the SDK's signal for it to *cease* monitoring that polygon.
+     *
+     * @example
+     * ```javascript
+     * BackgroundGeolocation.addGeofence({
+     *   identifier: 'Home',
+     *   notifyOnEntry: true,
+     *   notifyOnExit: true,
+     *   vertices: [
+     *     [45.518947279987714, -73.6049889209514],  // <-- [lat, lng]
+     *     [45.5182711292279, -73.60338649600598],
+     *     [45.517082240237634, -73.60432670908212],
+     *     [45.51774871402813, -73.60604928622278]
+     *   ]
+     * });
+     * ```     
+     *
+     * - #### Entering / exiting a *cross-shaped* polygon geofence:
+     * 
+     * ![](https://dl.dropbox.com/scl/fi/iorrnrm0zno91jtg0ctse/polygon-geofencing-cross.PNG?rlkey=p4kufqhxgw9jrmuz4vkqisprw&dl=1)
+     * 
+     * - #### Entering / exiting a park:
+     * 
+     * ![](https://dl.dropbox.com/scl/fi/qvg9n3s5iacje5szgcqfv/polygon-geofencing-parc-outremont.PNG?rlkey=c6iax7a19db2v6xdxf18k2a7k&dl=1)
+     * 
+     * - #### Entering / exiting a diamond-shaped polygon:
+     * 
+     * ![](https://dl.dropbox.com/scl/fi/29m3xwb7tm0532mthgjfy/polygon-geofencing-diamond.PNG?rlkey=9ucc5hs7460ig7226iutas4cw&dl=1)
+     * 
+     * - #### Designing a polygon geofence around a park using the demo app:
+     * 
+     * ![](https://dl.dropbox.com/scl/fi/806mxnz9cdfd4ely8uwfe/polygon-geofencing-parc-lafontaine.PNG?rlkey=yrlbfisx8o5itfz6h0d0inel1&dl=1)
+     * 
+     *     
+     */
+    vertices?: Vertices
   }
 }

package/src/declarations/types.d.ts

@@ -141,7 +141,7 @@ declare module "react-native-background-geolocation" {
     * | 408   | Location timeout            |
     * | 499   | Location request cancelled  |
 	*/
-	type LocationError = 0 | 1 | 2 | 408 | 499;
+	type LocationError = 0 | 1 | 2 | 3 | 408 | 499;
 
 	/**
 	* iOS Location authorization request.
@@ -156,7 +156,7 @@ declare module "react-native-background-geolocation" {
 
 	type PersistMode = -1 | 0 | 1 | 2;
 
-	type Extras = {[key: string]: string|null|number|boolean|Extras|string[]|number[]|boolean[]|Extras[]};
+	type Extras = {[key: string]: string|null|number|boolean|Extras|string[]|number[]|number[][]|boolean[]|Extras[]};
 
 	/**
 	* Controls ordering of [[SQLQuery.order]]

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

@@ -1 +0,0 @@
-4e89f0c39d8a0515a4f7e5bc684a6618

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

@@ -1 +0,0 @@
-d8e4bcb099553b932f6e30bcacd31255115e85e1

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

@@ -1 +0,0 @@
-fea5c7b408bb26ac1edf2415c57e351ff7b7cb6a99b25300664a1f5815e640ec

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

@@ -1 +0,0 @@
-1285c0ea29703a6384bc8bf0024b0ec5eb52092b307650e1a1713913d483008047dbe255959b7aa58755d8450dd853991772dacaec1f86114c2485353e799799

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

@@ -1 +0,0 @@
-0ce90014cca1700e6ec4d95fe16348dd

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

@@ -1 +0,0 @@
-6f11dfebb67289ce9a867b2321b9ff1555a4539c

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

@@ -1 +0,0 @@
-efe2faae055a230b749893a81163785c53d0df552ad51063799166f232d962da

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

@@ -1 +0,0 @@
-b66b60b6d53093f71841ba374cadccc615600fc406f94d6bdd98a2f872f60864b12620be24af52899574f6bd2a28f59074c6cdac98058de6459623a6e0233656

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

@@ -1 +0,0 @@
-e53f6c9241c54bc8da86deae822dd965

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

@@ -1 +0,0 @@
-58ce39d185fe751c4359de743ccb9afd0102a633

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

@@ -1 +0,0 @@
-b34d9ba24315e6afc80b770daffe4419475f5b693c056ccd8c2b048c98ab3642

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

@@ -1 +0,0 @@
-495aa3b80af740c5e463f4049524053603744fa044c33ba7322e4e2a0fddd257a5d38b9517e8b3d4a8bdf6fc52791b6aafaf4ddd1a69c2a6062ccf335775b98b

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

@@ -1 +0,0 @@
-9c833b7040ae46109b4ed3445d33f3e5

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

@@ -1 +0,0 @@
-3b45e93482f2aebe866bbe7767bc1d5a3b7585cd

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

@@ -1 +0,0 @@
-858308d408f1a124af0825ccb8fa3a55d6ed9cfccf432d649ad52b5e40921a6c

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

@@ -1 +0,0 @@
-32830cae413d315e06a459a44ffb9a5e4674e0197a5f55b54b7a96ec71a71edbcab8b2d71fc18a394e12292e8b7d8df9927ec12a5e5b47d555a7adf0790b27b4