@capgo/background-geolocation 7.0.5

package/CapgoBackgroundGeolocation.podspec

@@ -0,0 +1,13 @@
+
+  Pod::Spec.new do |s|
+    s.name = 'CapgoBackgroundGeolocation'
+    s.version = '0.0.1'
+    s.summary = 'Capacitor plugin which lets you receive geolocation updates even while the app is backgrounded.'
+    s.license = 'MIT'
+    s.homepage = 'https://github.com/Cap-go/background-geolocation'
+    s.author = 'Cap-go'
+    s.source = { :git => 'https://github.com/Cap-go/background-geolocation', :tag => s.version.to_s }
+    s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+    s.ios.deployment_target  = '14.0'
+    s.dependency 'Capacitor'
+  end

package/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2021 James Diacono
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,221 @@
+# Background Geolocation
+ <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+
+<div align="center">
+  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+</div>
+
+A Capacitor plugin that lets you receive geolocation updates even while the app is backgrounded. Only iOS and Android platforms are supported.
+
+## Usage
+
+```javascript
+import { BackgroundGeolocation } from "@capgo/background-geolocation";
+
+// To start listening for changes in the device's location, add a new watcher.
+// You do this by calling 'addWatcher' with an options object and a callback. A
+// Promise is returned, which resolves to the callback ID used to remove the
+// watcher in the future. The callback will be called every time a new location
+// is available. Watchers can not be paused, only removed. Multiple watchers may
+// exist simultaneously.
+BackgroundGeolocation.addWatcher(
+    {
+        // If the "backgroundMessage" option is defined, the watcher will
+        // provide location updates whether the app is in the background or the
+        // foreground. If it is not defined, location updates are only
+        // guaranteed in the foreground. This is true on both platforms.
+
+        // On Android, a notification must be shown to continue receiving
+        // location updates in the background. This option specifies the text of
+        // that notification.
+        backgroundMessage: "Cancel to prevent battery drain.",
+
+        // The title of the notification mentioned above. Defaults to "Using
+        // your location".
+        backgroundTitle: "Tracking You.",
+        
+        // Whether permissions should be requested from the user automatically,
+        // if they are not already granted. Defaults to "true".
+        requestPermissions: true,
+
+        // If "true", stale locations may be delivered while the device
+        // obtains a GPS fix. You are responsible for checking the "time"
+        // property. If "false", locations are guaranteed to be up to date.
+        // Defaults to "false".
+        stale: false,
+
+        // The minimum number of metres between subsequent locations. Defaults
+        // to 0.
+        distanceFilter: 50
+    },
+    function callback(location, error) {
+        if (error) {
+            if (error.code === "NOT_AUTHORIZED") {
+                if (window.confirm(
+                    "This app needs your location, " +
+                    "but does not have permission.\n\n" +
+                    "Open settings now?"
+                )) {
+                    // It can be useful to direct the user to their device's
+                    // settings when location permissions have been denied. The
+                    // plugin provides the 'openSettings' method to do exactly
+                    // this.
+                    BackgroundGeolocation.openSettings();
+                }
+            }
+            return console.error(error);
+        }
+
+        return console.log(location);
+    }
+).then(function after_the_watcher_has_been_added(watcher_id) {
+    // When a watcher is no longer needed, it should be removed by calling
+    // 'removeWatcher' with an object containing its ID.
+    BackgroundGeolocation.removeWatcher({
+        id: watcher_id
+    });
+});
+
+// The location object.
+{
+    // Longitude in degrees.
+    longitude: 131.723423719132,
+    // Latitude in degrees.
+    latitude: -22.40106297456,
+    // Radius of horizontal uncertainty in metres, with 68% confidence.
+    accuracy: 11,
+    // Metres above sea level (or null).
+    altitude: 65,
+    // Vertical uncertainty in metres, with 68% confidence (or null).
+    altitudeAccuracy: 4,
+    // Deviation from true north in degrees (or null).
+    bearing: 159.60000610351562,
+    // True if the location was simulated by software, rather than GPS.
+    simulated: false,
+    // Speed in metres per second (or null).
+    speed: 23.51068878173828,
+    // Time the location was produced, in milliseconds since the unix epoch.
+    time: 1562731602000
+}
+
+// If you just want the current location, try something like this. The longer
+// the timeout, the more accurate the guess will be. I wouldn't go below about
+// 100ms.
+function guess_location(callback, timeout) {
+    let last_location;
+    BackgroundGeolocation.addWatcher(
+        {
+            requestPermissions: false,
+            stale: true
+        },
+        function (location) {
+            last_location = location || undefined;
+        }
+    ).then(function (id) {
+        setTimeout(function () {
+            callback(last_location);
+            BackgroundGeolocation.removeWatcher({id});
+        }, timeout);
+    });
+}
+```
+
+### Typescript support
+
+```typescript
+import { BackgroundGeolocation } from "@capgo/background-geolocation";
+```
+
+## Installation
+
+This plugin supports Capacitor v7:
+
+| Capacitor  | Plugin |
+|------------|--------|
+| v7         | v1     |
+
+```sh
+npm install @capgo/background-geolocation
+npx cap update
+```
+
+### iOS
+Add the following keys to `Info.plist.`:
+
+```xml
+<dict>
+  ...
+  <key>NSLocationWhenInUseUsageDescription</key>
+  <string>We need to track your location</string>
+  <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
+  <string>We need to track your location while your device is locked.</string>
+  <key>UIBackgroundModes</key>
+  <array>
+    <string>location</string>
+  </array>
+  ...
+</dict>
+```
+
+### Android
+
+Set the the `android.useLegacyBridge` option to `true` in your Capacitor configuration. This prevents location updates halting after 5 minutes in the background. See https://capacitorjs.com/docs/config and https://github.com/capacitor-community/background-geolocation/issues/89.
+
+On Android 13+, the app needs the `POST_NOTIFICATIONS` runtime permission to show the persistent notification informing the user that their location is being used in the background. You may need to [request this permission](https://developer.android.com/develop/ui/views/notifications/notification-permission) from the user, this can be accomplished [using the `@capacitor/local-notifications` plugin](https://capacitorjs.com/docs/apis/local-notifications#checkpermissions).
+
+If your app forwards location updates to a server in real time, be aware that after 5 minutes in the background Android will throttle HTTP requests initiated from the WebView. The solution is to use a native HTTP plugin such as [CapacitorHttp](https://capacitorjs.com/docs/apis/http). See https://github.com/capacitor-community/background-geolocation/issues/14.
+
+Configration specific to Android can be made in `strings.xml`:
+```xml
+<resources>
+    <!--
+        The channel name for the background notification. This will be visible
+        when the user presses & holds the notification. It defaults to
+        "Background Tracking".
+    -->
+    <string name="capacitor_background_geolocation_notification_channel_name">
+        Background Tracking
+    </string>
+
+    <!--
+        The icon to use for the background notification. Note the absence of a
+        leading "@". It defaults to "mipmap/ic_launcher", the app's launch icon.
+
+        If a raster image is used to generate the icon (as opposed to a vector
+        image), it must have a transparent background. To make sure your image
+        is compatible, select "Notification Icons" as the Icon Type when
+        creating the image asset in Android Studio.
+
+        An incompatible image asset will cause the notification to misbehave in
+        a few telling ways, even if the icon appears correctly:
+
+          - The notification may be dismissable by the user when it should not
+            be.
+          - Tapping the notification may open the settings, not the app.
+          - The notification text may be incorrect.
+    -->
+    <string name="capacitor_background_geolocation_notification_icon">
+        drawable/ic_tracking
+    </string>
+
+    <!--
+        The color of the notification as a string parseable by
+        android.graphics.Color.parseColor. Optional.
+    -->
+    <string name="capacitor_background_geolocation_notification_color">
+        yellow
+    </string>
+</resources>
+
+```
+
+
+<docgen-index>
+
+* [`addWatcher(...)`](#addwatcher)
+* [`removeWatcher(...)`](#removewatcher)
+* [`openSettings()`](#opensettings)
+* [Interfaces](#interfaces)
+
+</docgen-index>

package/android/build.gradle

@@ -0,0 +1,62 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+    androidxLocalbroadcastmanagerVersion = project.hasProperty('androidxLocalbroadcastmanagerVersion') ? rootProject.ext.androidxLocalbroadcastmanagerVersion : '1.0.0'
+    playServicesLocationVersion = project.hasProperty('playServicesLocationVersion') ? rootProject.ext.playServicesLocationVersion : '21.0.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.3'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.capgo.capacitor_background_geolocation"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "androidx.localbroadcastmanager:localbroadcastmanager:$androidxLocalbroadcastmanagerVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+    implementation "com.google.android.gms:play-services-location:$playServicesLocationVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,21 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application>
+        <service
+            android:name="com.capgo.capacitor_background_geolocation.BackgroundGeolocationService"
+            android:enabled="true"
+            android:exported="true"
+            android:foregroundServiceType="location" />
+    </application>
+
+    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+    <!-- Android SDK 34+ additionally requires the FOREGROUND_SERVICE_LOCATION
+    runtime permission to start a foreground service of type "location". -->
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_LOCATION" />
+    <!-- Android SDK 33+ requires the POST_NOTIFICATIONS runtime permission to
+    display the foreground service notification. -->
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+    <uses-feature android:name="android.hardware.location.gps" />
+</manifest>
+