@transistorsoft/capacitor-background-geolocation 9.0.2 → 9.1.0

package/Package.swift

@@ -12,8 +12,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0"),
-        .package(url: "https://github.com/CocoaLumberjack/CocoaLumberjack.git", from: "3.8.5"),
-        .package(url: "https://github.com/transistorsoft/native-background-geolocation.git", from: "4.0.10"),
+        .package(url: "https://github.com/transistorsoft/native-background-geolocation.git", from: "4.1.0"),
         .package(url: "https://github.com/transistorsoft/transistor-background-fetch.git", from: "4.0.5")
     ],
     targets: [
@@ -23,8 +22,7 @@ let package = Package(
                 .product(name: "Capacitor", package: "capacitor-swift-pm"),
                 .product(name: "Cordova", package: "capacitor-swift-pm"),
                 .product(name: "BackgroundGeolocation", package: "native-background-geolocation"),
-                .product(name: "TSBackgroundFetch", package: "transistor-background-fetch"),
-                .product(name: "CocoaLumberjackSwift", package: "CocoaLumberjack")
+                .product(name: "TSBackgroundFetch", package: "transistor-background-fetch")
             ],
             path: "ios/Sources/BackgroundGeolocationPlugin",
             resources: [

package/README.md

@@ -1,286 +1,43 @@
-Background Geolocation for Capacitor · [![npm](https://img.shields.io/npm/dm/@transistorsoft/capacitor-background-geolocation.svg)]() [![npm](https://img.shields.io/npm/v/@transistorsoft/capacitor-background-geolocation.svg)]()
-============================================================================
+<p align="center">
+  <img src="https://raw.githubusercontent.com/transistorsoft/assets/master/images/logos/transistor/transistor-logo-panel-ts.svg" alt="Background Geolocation for Capacitor" width="635">
+</p>
 
-[![](https://dl.dropboxusercontent.com/s/nm4s5ltlug63vv8/logo-150-print.png?dl=1)](https://www.transistorsoft.com)
+# Background Geolocation for Capacitor
 
--------------------------------------------------------------------------------
+[![npm](https://img.shields.io/npm/dm/@transistorsoft/capacitor-background-geolocation.svg)]() [![npm](https://img.shields.io/npm/v/@transistorsoft/capacitor-background-geolocation.svg)]()
 
-The *most* sophisticated background **location-tracking & geofencing** module with battery-conscious motion-detection intelligence for **iOS** and **Android**.
+The most sophisticated background **location-tracking & geofencing** SDK with battery-conscious motion-detection intelligence for **iOS** and **Android**.
 
-The plugin's [Philosophy of Operation](../../wiki/Philosophy-of-Operation) is to use **motion-detection** APIs (accelerometer, gyroscope and magnetometer) to detect when the device is *moving* and *stationary*.
+The SDK uses **motion-detection** APIs (accelerometer, gyroscope, magnetometer) to detect when the device is *moving* or *stationary*:
 
-- When the device is detected to be **moving**, the plugin automatically starts recording locations according to the configured `distanceFilter` (metres).
-
-- When the device is detected to be **stationary**, the plugin automatically turns off location-services to conserve energy.
-
-Also available for [Flutter](https://github.com/transistorsoft/flutter_background_geolocation), [Cordova](https://github.com/transistorsoft/cordova-background-geolocation-lt), and [React Native](https://github.com/transistorsoft/react-native-background-geolocation).
-
-----------------------------------------------------------------------------
-
-The **[Android module](http://www.transistorsoft.com/shop/products/capacitor-background-geolocation)** requires [purchasing a license](http://www.transistorsoft.com/shop/products/capacitor-background-geolocation). However, it *will* work for **DEBUG** builds — try before you buy.
-
-----------------------------------------------------------------------------
-
-[![Google Play](https://dl.dropboxusercontent.com/s/80rf906x0fheb26/google-play-icon.png?dl=1)](https://play.google.com/store/apps/details?id=com.transistorsoft.backgroundgeolocation.react)
-
-![Home](https://dl.dropboxusercontent.com/s/wa43w1n3xhkjn0i/home-framed-350.png?dl=1)
-![Settings](https://dl.dropboxusercontent.com/s/8oad228siog49kt/settings-framed-350.png?dl=1)
+- **Moving** — location recording starts automatically at the configured `distanceFilter` (metres)
+- **Stationary** — location services turn off automatically to conserve battery
 
 > [!IMPORTANT]
-> This plugin requires **Capacitor 5** or higher. For Capacitor 4, use the `4.x` version of the plugin.
-
-# Contents
-- ### 😫 [Help!](../../wiki/Help)
-- ### :books: [API Documentation](https://transistorsoft.github.io/capacitor-background-geolocation/latest)
-- ### [Installing the Plugin](#large_blue_diamond-installing-the-plugin)
-- ### [Setup Guides](#large_blue_diamond-setup-guides)
-- ### [Configure your License](#large_blue_diamond-configure-your-license)
-- ### [Using the Plugin](#large_blue_diamond-using-the-plugin)
-- ### [Example](#large_blue_diamond-example)
-- ### [Debugging](../../wiki/Debugging)
-- ### [Example Apps](#large_blue_diamond-example-apps)
-- ### [Testing Server](#large_blue_diamond-simple-testing-server)
-- ### [Privacy Policy](help/PRIVACY_POLICY.md)
-
----
-
-## :large_blue_diamond: Installing the Plugin
-
-> [!CAUTION]
-> This is the new v9 version.  For previous version, see [`v8.x`](https://github.com/transistorsoft/capacitor-background-geolocation/tree/8.0.1).  __`v8.x`__ license keys do not work with __`v9`__.  Login to the customer dashboard to generate a __`v9`__ key.  See the [Migration Guide](help/MIGRATION-GUIDE-9.0.0.md) for details.
-
-### With `yarn`
-
-```bash
-yarn add @transistorsoft/capacitor-background-geolocation
-npx cap sync
-```
-
-### With `npm`
-
-```bash
-npm install @transistorsoft/capacitor-background-geolocation --save
-npx cap sync
-```
-
-### Optional: Background Fetch
-
-[`@transistorsoft/capacitor-background-fetch`](https://github.com/transistorsoft/capacitor-background-fetch) is a companion plugin that provides a periodic background callback — up to once every 15 minutes — even while your app is suspended. It is not required by the geolocation plugin but is a useful add-on for keeping data in sync.
-
-```bash
-yarn add @transistorsoft/capacitor-background-fetch
-npx cap sync
-```
-
----
-
-## :large_blue_diamond: Setup Guides
-
-### iOS
-- [Required iOS Setup](help/INSTALL-IOS.md)
-
-### Android
-- [Required Android Setup](help/INSTALL-ANDROID.md)
-
----
-
-## :large_blue_diamond: Configure your License
-
-> [!NOTE]
-> If you have **not** [purchased a license](https://www.transistorsoft.com/shop/products/capacitor-background-geolocation#plans), **skip this step** — the plugin is fully functional in *DEBUG* builds so you can evaluate it first.
-
-Your license is a **JWT** issued by the [Customer Dashboard](https://www.transistorsoft.com/shop/customers). It encodes all the features (*entitlements*) your subscription includes — there is only **one key** regardless of which add-ons you have.
-
-Add your license key to **`android/app/src/main/AndroidManifest.xml`**:
-
-```diff
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
-  <application
-    android:name=".MainApplication"
-    android:label="@string/app_name"
-    android:icon="@mipmap/ic_launcher"
-    android:theme="@style/AppTheme">
-
-    <!-- capacitor-background-geolocation licence -->
-+   <meta-data android:name="com.transistorsoft.locationmanager.license" android:value="YOUR_LICENSE_KEY_HERE" />
-    .
-    .
-    .
-  </application>
-</manifest>
-```
+> This is **`v9`**. For the previous version see [`v8.x`](https://github.com/transistorsoft/capacitor-background-geolocation/tree/8.0.1). **`v8.x`** license keys do **not** work with **`v9`** — log in to the [Customer Dashboard](https://transistorsoft.com) to generate a **`v9`** key. See the [Migration Guide](help/MIGRATION-GUIDE-9.0.0.md) for details.
 
 ---
 
-## :large_blue_diamond: Using the Plugin
+## :books: Documentation
 
-```javascript
-import BackgroundGeolocation from "@transistorsoft/capacitor-background-geolocation";
-```
+### <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/capacitor.svg" width="20" height="20"> Capacitor
+- [Setup](https://docs.transistorsoft.com/typescript/setup/?tab=capacitor)
+- [API Reference](https://docs.transistorsoft.com/typescript/BackgroundGeolocation/)
+- [Example](https://docs.transistorsoft.com/typescript/examples/?tab=capacitor)
 
 ---
 
-## :large_blue_diamond: Example
-
-There are three main steps to using `BackgroundGeolocation`:
-1. Wire up event-listeners.
-2. `#ready` the plugin.
-3. `#start` the plugin.
-
-> [!WARNING]
-> Do not call any API method that requires location-services (e.g. `#getCurrentPosition`, `#watchPosition`, `#start`) until the `#ready` promise resolves.
-
-```javascript
-// NO! .ready() has not yet resolved.
-BackgroundGeolocation.getCurrentPosition(options);
-BackgroundGeolocation.start();
-
-BackgroundGeolocation.ready(config).then((state) => {
-  // YES — .ready() has resolved.
-  BackgroundGeolocation.getCurrentPosition(options);
-  BackgroundGeolocation.start();
-});
-
-// NO! .ready() has not yet resolved.
-BackgroundGeolocation.getCurrentPosition(options);
-BackgroundGeolocation.start();
-```
-
----------------------------------------------------------------------------------------------
-
-### Example — *React*
-
-<img alt="React" width="50px" src="https://hackr.io/tutorials/react/logo-react.svg?ver=1610114789" />
-
-<details>
-  <summary>View Source</summary>
-
-```typescript
-import {
-  IonContent,
-  IonHeader,
-  IonPage,
-  IonTitle,
-  IonToolbar,
-  IonButtons,
-  IonToggle,
-  IonItemDivider,
-  IonLabel
-} from '@ionic/react';
-
-import React from "react";
-
-import BackgroundGeolocation, {
-  Subscription
-} from "@transistorsoft/capacitor-background-geolocation";
-
-const HelloWorld: React.FC = () => {
-  const [ready, setReady] = React.useState(false);
-  const [enabled, setEnabled] = React.useState(false);
-  const [events, setEvents] = React.useState<any[]>([]);
+## :key: Licensing
 
-  const addEvent = (name: string, event: any) => {
-    setEvents(previous => [...previous, {
-      name: name,
-      json: JSON.stringify(event, null, 2)
-    }]);
-  }
+> [!TIP]
+> The SDK is **fully functional in `DEBUG` builds** — no license required. Try before you buy.
 
-  React.useEffect(() => {
-    /// 1. Subscribe to events.
-    const onLocation: Subscription = BackgroundGeolocation.onLocation((location) => {
-      addEvent('onLocation', location);
-    });
-
-    const onMotionChange: Subscription = BackgroundGeolocation.onMotionChange((event) => {
-      addEvent('onMotionChange', event);
-    });
-
-    const onActivityChange: Subscription = BackgroundGeolocation.onActivityChange((event) => {
-      addEvent('onActivityChange', event);
-    });
-
-    const onProviderChange: Subscription = BackgroundGeolocation.onProviderChange((event) => {
-      addEvent('onProviderChange', event);
-    });
-
-    /// 2. Ready the plugin.
-    BackgroundGeolocation.ready({
-      // Geolocation
-      desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
-      distanceFilter: 10,
-      // Activity Recognition
-      stopTimeout: 5,
-      // Application
-      debug: true,              // <-- enable to hear life-cycle sounds
-      logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE,
-      stopOnTerminate: false,   // <-- continue tracking after the app is closed
-      startOnBoot: true,        // <-- start tracking when the device boots
-    }).then((state) => {
-      setReady(true);
-      setEnabled(state.enabled);
-      addEvent('State', state);
-    });
-
-    return () => {
-      // Remove subscriptions when the component unmounts (important during
-      // live-reload in development to prevent listener accumulation).
-      onLocation.remove();
-      onMotionChange.remove();
-      onActivityChange.remove();
-      onProviderChange.remove();
-    };
-  }, []);
-
-  /// 3. Start / stop BackgroundGeolocation.
-  React.useEffect(() => {
-    if (!ready) { return; }
-
-    if (enabled) {
-      BackgroundGeolocation.start();
-    } else {
-      BackgroundGeolocation.stop();
-      setEvents([]);
-    }
-  }, [enabled]);
-
-  return (
-    <IonPage>
-      <IonHeader>
-        <IonToolbar>
-          <IonButtons slot="end">
-            <IonLabel>Toggle to <code>{enabled ? 'stop()' : 'start()'}</code> &mdash;&gt;</IonLabel>
-            <IonToggle checked={enabled} onIonChange={e => setEnabled(e.detail.checked)} />
-          </IonButtons>
-        </IonToolbar>
-      </IonHeader>
-      <IonContent fullscreen>
-        <div style={{ padding: 10 }}>
-          {events.slice().reverse().map((event, i) => (
-            <div key={i}>
-              <p><strong>{event.name}</strong></p>
-              <small><pre><code>{event.json}</code></pre></small>
-              <IonItemDivider />
-            </div>
-          ))}
-        </div>
-      </IonContent>
-    </IonPage>
-  );
-}
-```
-
-</details>
-
----------------------------------------------------------------------------------------------
-
-### Promise API
-
-The `BackgroundGeolocation` 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 the event-listener methods (`onLocation`, `onProviderChange`, etc.). See the [API Documentation](https://transistorsoft.github.io/capacitor-background-geolocation/latest) for full details.
+A license is required only for **`RELEASE` builds** on Android.
+[Purchase a license](https://shop.transistorsoft.com/products/capacitor-background-geolocation)
 
 ---
 
-## :large_blue_diamond: Example Apps
+## :open_file_folder: Example Apps
 
 Two example apps are included in the [`example/`](./example) directory:
 
@@ -291,15 +48,22 @@ Two example apps are included in the [`example/`](./example) directory:
 
 See the [example README](./example/README.md) for setup instructions.
 
-![Home](https://dl.dropboxusercontent.com/s/wa43w1n3xhkjn0i/home-framed-350.png?dl=1)
-![Settings](https://dl.dropboxusercontent.com/s/8oad228siog49kt/settings-framed-350.png?dl=1)
-
 ---
 
-## :large_blue_diamond: [Simple Testing Server](https://github.com/transistorsoft/background-geolocation-console)
+## 📦 SDK availability
+
+<img src="https://raw.githubusercontent.com/transistorsoft/assets/master/images/logos/transistor/transistor-logo-panel-all.svg" width="300">
 
-A simple Node-based [web application](https://github.com/transistorsoft/background-geolocation-console) with a SQLite database is available for field-testing and performance analysis. If you're familiar with Node you can have it running in about **one minute**.
+| Platform | Package |
+|---|---|
+| <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/capacitor.svg" width="16" height="16"> Capacitor | **This repo** |
+| <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/react-native.svg" width="16" height="16"> [React Native](https://github.com/transistorsoft/react-native-background-geolocation) | `react-native-background-geolocation` |
+| <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/expo.svg" width="16" height="16"> [Expo](https://github.com/transistorsoft/react-native-background-geolocation) | `react-native-background-geolocation` |
+| <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/flutter.svg" width="16" height="16"> [Flutter](https://github.com/transistorsoft/flutter_background_geolocation) | `flutter_background_geolocation` |
+| <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/cordova.svg" width="16" height="16"> [Cordova](https://github.com/transistorsoft/cordova-background-geolocation-lt) | `cordova-background-geolocation-lt` |
+| <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/swift.svg" width="16" height="16"> [Swift / iOS](https://github.com/transistorsoft/background-geolocation) | `background-geolocation` |
+| <img src="https://raw.githubusercontent.com/transistorsoft/react-native-background-geolocation/master/assets/images/platforms/kotlin.svg" width="16" height="16"> [Kotlin / Android](https://github.com/transistorsoft/background-geolocation) | `background-geolocation` |
 
-![](https://dl.dropboxusercontent.com/s/px5rzz7wybkv8fs/background-geolocation-console-map.png?dl=1)
+---
 
-![](https://dl.dropboxusercontent.com/s/tiy5b2oivt0np2y/background-geolocation-console-grid.png?dl=1)
+MIT © [Transistor Software](https://www.transistorsoft.com)

package/TransistorsoftCapacitorBackgroundGeolocation.podspec

@@ -13,8 +13,7 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Sources/BackgroundGeolocationPlugin/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target  = '13.0'
   s.dependency 'Capacitor'
-  s.dependency 'CocoaLumberjack', '~> 3.8.5'
-  s.dependency 'TSLocationManager', '~> 4.0.10'
+  s.dependency 'TSLocationManager', '~> 4.1.0'
   s.libraries = 'sqlite3', 'z', 'stdc++'
   s.resource_bundles = {
     'TSLocationManagerPrivacy' => ['ios/Sources/BackgroundGeolocationPlugin/PrivacyInfo.xcprivacy']

package/android/build.gradle

@@ -31,7 +31,7 @@ def DEFAULT_TARGET_SDK_VERSION                      = 35
 
 // Plugin dependencies
 def DEFAULT_PLAY_SERVICES_LOCATION_VERSION          = "21.3.0"
-def DEFAULT_TSLOCATIONMANAGER_VERSION               = "4.0.+"
+def DEFAULT_TSLOCATIONMANAGER_VERSION               = "4.1.+"
 def DEFAULT_EVENTBUS_VERSION                        = "3.3.1"
 
 def safeExtGet(prop, fallback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transistorsoft/capacitor-background-geolocation",
-  "version": "9.0.2",
+  "version": "9.1.0",
   "description": "The most sophisticated cross platform Capacitor background location tracking & geofencing module with battery-conscious motion-detection intelligence",
   "main": "dist/plugin.cjs.js",
   "module": "dist/index.js",
@@ -15,7 +15,6 @@
     "dist/",
     "src/index.d.ts",
     "ios/Sources/",
-    "ios/Frameworks/TSLocationManager.xcframework/",
     "TransistorsoftCapacitorBackgroundGeolocation.podspec",
     "Package.swift"
   ],

package/ios/Frameworks/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/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>
-		<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>
-	</array>
-	<key>CFBundlePackageType</key>
-	<string>XFWK</string>
-	<key>XCFrameworkFormatVersion</key>
-	<string>1.0</string>
-</dict>
-</plist>