@josuelmm/cordova-background-geolocation 3.0.2 → 3.1.0

package/ios/common/BackgroundGeolocation/MAURConfigurationContract.h

@@ -33,6 +33,7 @@
 #define CC_COLUMN_NAME_URL                    "url"
 #define CC_COLUMN_NAME_SYNC_URL               "sync_url"
 #define CC_COLUMN_NAME_SYNC_THRESHOLD         "sync_threshold"
+#define CC_COLUMN_NAME_SYNC_ENABLED           "sync_enabled"
 #define CC_COLUMN_NAME_HEADERS                "http_headers"
 #define CC_COLUMN_NAME_SAVE_BATTERY           "save_battery"
 #define CC_COLUMN_NAME_MAX_LOCATIONS          "max_locations"

package/ios/common/BackgroundGeolocation/MAURConfigurationContract.m

@@ -37,6 +37,7 @@
         @{ @"name": @CC_COLUMN_NAME_URL, @"type": [SQLColumnType sqlColumnWithType: kText]},
         @{ @"name": @CC_COLUMN_NAME_SYNC_URL, @"type": [SQLColumnType sqlColumnWithType: kText]},
         @{ @"name": @CC_COLUMN_NAME_SYNC_THRESHOLD, @"type": [SQLColumnType sqlColumnWithType: kInteger]},
+        @{ @"name": @CC_COLUMN_NAME_SYNC_ENABLED, @"type": [SQLColumnType sqlColumnWithType: kInteger]},
         @{ @"name": @CC_COLUMN_NAME_HEADERS, @"type": [SQLColumnType sqlColumnWithType: kText]},
         @{ @"name": @CC_COLUMN_NAME_SAVE_BATTERY, @"type": [SQLColumnType sqlColumnWithType: kInteger]},
         @{ @"name": @CC_COLUMN_NAME_MAX_LOCATIONS, @"type": [SQLColumnType sqlColumnWithType: kInteger]},

package/ios/common/BackgroundGeolocation/MAURGeolocationOpenHelper.m

@@ -14,7 +14,7 @@
 @implementation MAURGeolocationOpenHelper
 
 static NSString *const kDatabaseName = @"cordova_bg_geolocation.db";
-static NSInteger const kDatabaseVersion = 3;
+static NSInteger const kDatabaseVersion = 4;
 
 - (instancetype)init
 {
@@ -81,6 +81,10 @@ static NSInteger const kDatabaseVersion = 3;
             [sql addObjectsFromArray: @[
                 [MAURConfigurationContract createTableSQL]
             ]];
+        case 3:
+            [sql addObjectsFromArray: @[
+                [NSString stringWithFormat:@"ALTER TABLE %s ADD COLUMN %s INTEGER", CC_TABLE_NAME, CC_COLUMN_NAME_SYNC_ENABLED]
+            ]];
             break; // break only for previous db version (cascade statements)
         default:
             return;

package/ios/common/BackgroundGeolocation/MAURPostLocationTask.m

@@ -101,7 +101,7 @@ static MAURLocationTransform s_locationTransform = nil;
             }
         }
 
-        if ([self.config hasValidSyncUrl]) {
+        if ([self.config hasValidSyncUrl] && [self.config syncEnabled]) {
             NSNumber *locationsCount = [locationDAO getLocationsForSyncCount];
             NSInteger threshold = self.config.syncThreshold != nil ? self.config.syncThreshold.integerValue : 100;
             if (locationsCount && [locationsCount integerValue] >= threshold) {
@@ -212,9 +212,10 @@ static MAURLocationTransform s_locationTransform = nil;
 
 - (void) sync
 {
-    if ([self.config hasValidSyncUrl]) {
-        [uploader sync:self.config.syncUrl withTemplate:self.config._template withHttpHeaders:self.config.httpHeaders];
+    if (![self.config syncEnabled] || ![self.config hasValidSyncUrl]) {
+        return;
     }
+    [uploader sync:self.config.syncUrl withTemplate:self.config._template withHttpHeaders:self.config.httpHeaders];
 }
 
 #pragma mark - Location transform

package/ios/common/BackgroundGeolocation/MAURSQLiteConfigurationDAO.m

@@ -81,13 +81,14 @@
         @COMMA_SEP @CC_COLUMN_NAME_URL
         @COMMA_SEP @CC_COLUMN_NAME_SYNC_URL
         @COMMA_SEP @CC_COLUMN_NAME_SYNC_THRESHOLD
+        @COMMA_SEP @CC_COLUMN_NAME_SYNC_ENABLED
         @COMMA_SEP @CC_COLUMN_NAME_HEADERS
         @COMMA_SEP @CC_COLUMN_NAME_SAVE_BATTERY
         @COMMA_SEP @CC_COLUMN_NAME_MAX_LOCATIONS
         @COMMA_SEP @CC_COLUMN_NAME_PAUSE_LOCATION_UPDATES
         @COMMA_SEP @CC_COLUMN_NAME_TEMPLATE
         @COMMA_SEP @CC_COLUMN_NAME_LAST_UPDATED_AT
-        @") VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,DateTime('now'))";
+        @") VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,DateTime('now'))";
 
     [queue inDatabase:^(FMDatabase *database) {
         success = [database executeUpdate:sql,
@@ -113,6 +114,7 @@
                     [config hasUrl] ? config.url : @CC_COLUMN_NAME_NULLABLE,
                     [config hasSyncUrl] ? config.syncUrl : @CC_COLUMN_NAME_NULLABLE,
                     [config hasSyncThreshold] ? config.syncThreshold : @CC_COLUMN_NAME_NULLABLE,
+                    [config hasSyncEnabled] ? [NSNumber numberWithBool:[config syncEnabled]] : @CC_COLUMN_NAME_NULLABLE,
                     (httpHeadersString != nil) ? httpHeadersString : @CC_COLUMN_NAME_NULLABLE,
                     [config hasSaveBatteryOnBackground] ? config._saveBatteryOnBackground : @CC_COLUMN_NAME_NULLABLE,
                     [config hasMaxLocations] ? config.maxLocations : @CC_COLUMN_NAME_NULLABLE,
@@ -157,6 +159,7 @@
     @COMMA_SEP @CC_COLUMN_NAME_URL
     @COMMA_SEP @CC_COLUMN_NAME_SYNC_URL
     @COMMA_SEP @CC_COLUMN_NAME_SYNC_THRESHOLD
+    @COMMA_SEP @CC_COLUMN_NAME_SYNC_ENABLED
     @COMMA_SEP @CC_COLUMN_NAME_HEADERS
     @COMMA_SEP @CC_COLUMN_NAME_SAVE_BATTERY
     @COMMA_SEP @CC_COLUMN_NAME_MAX_LOCATIONS
@@ -201,24 +204,28 @@
             if ([self isNonNull:rs columnIndex:21]) {
                 config.syncThreshold = [NSNumber numberWithInt:[rs intForColumnIndex:21]];
             }
-            if ([self isNonNull:rs columnIndex:22]) {
-                NSString *httpHeadersString = [rs stringForColumnIndex:22];
+            id syncEnabledVal = [rs objectForColumnIndex:22];
+            if (syncEnabledVal != nil && syncEnabledVal != [NSNull null]) {
+                config.syncEnabled = [NSNumber numberWithBool:[rs intForColumnIndex:22] == 1 ? YES : NO];
+            }
+            if ([self isNonNull:rs columnIndex:23]) {
+                NSString *httpHeadersString = [rs stringForColumnIndex:23];
                 if (httpHeadersString != nil) {
                     NSData *jsonHttpHeaders = [httpHeadersString dataUsingEncoding:NSUTF8StringEncoding];
                     config.httpHeaders = [NSJSONSerialization JSONObjectWithData:jsonHttpHeaders options:0 error:nil];
                 }
             }
-            if ([self isNonNull:rs columnIndex:23]) {
-                config._saveBatteryOnBackground = [NSNumber numberWithBool:[rs intForColumnIndex:23] == 1 ? YES : NO];
-            }
             if ([self isNonNull:rs columnIndex:24]) {
-                config.maxLocations = [NSNumber numberWithInt:[rs intForColumnIndex:24]];
+                config._saveBatteryOnBackground = [NSNumber numberWithBool:[rs intForColumnIndex:24] == 1 ? YES : NO];
             }
             if ([self isNonNull:rs columnIndex:25]) {
-                config._pauseLocationUpdates = [NSNumber numberWithBool:[rs intForColumnIndex:25] == 1 ? YES : NO];
+                config.maxLocations = [NSNumber numberWithInt:[rs intForColumnIndex:25]];
             }
             if ([self isNonNull:rs columnIndex:26]) {
-                NSString *templateAsString = [rs stringForColumnIndex:26];
+                config._pauseLocationUpdates = [NSNumber numberWithBool:[rs intForColumnIndex:26] == 1 ? YES : NO];
+            }
+            if ([self isNonNull:rs columnIndex:27]) {
+                NSString *templateAsString = [rs stringForColumnIndex:27];
                 if (templateAsString != nil) {
                     NSData *jsonTemplate = [templateAsString dataUsingEncoding:NSUTF8StringEncoding];
                     config._template = [NSJSONSerialization JSONObjectWithData:jsonTemplate options:0 error:nil];

package/ios/common/BackgroundGeolocation/MAURSQLiteLocationDAO.h

@@ -26,6 +26,8 @@
 - (NSNumber*) persistLocation:(MAURLocation*)location limitRows:(NSInteger)maxRows;
 - (BOOL) deleteLocation:(NSNumber*)locationId error:(NSError * __autoreleasing *)outError;
 - (BOOL) deleteAllLocations:(NSError * __autoreleasing *)outError;
+/** Mark all locations pending sync (PostPending) as deleted. Clears the sync queue without sending. */
+- (BOOL) deletePendingSyncLocations:(NSError * __autoreleasing *)outError;
 - (BOOL) clearDatabase;
 - (NSString*) getDatabaseName;
 - (NSString*) getDatabasePath;

package/ios/common/BackgroundGeolocation/MAURSQLiteLocationDAO.m

@@ -304,6 +304,26 @@
     return success;
 }
 
+- (BOOL) deletePendingSyncLocations:(NSError * __autoreleasing *)outError
+{
+    __block BOOL success = YES;
+    NSString *sql = @"UPDATE " @LC_TABLE_NAME @" SET " @LC_COLUMN_NAME_STATUS @" = ? WHERE " @LC_COLUMN_NAME_STATUS @" = ?";
+
+    [queue inDatabase:^(FMDatabase *database) {
+        if (![database executeUpdate:sql, [NSString stringWithFormat:@"%ld", MAURLocationDeleted], [NSString stringWithFormat:@"%ld", MAURLocationPostPending]]) {
+            int errorCode = [database lastErrorCode];
+            NSString *errorMessage = [database lastErrorMessage];
+            NSLog(@"deletePendingSyncLocations failed code: %d: message: %@", errorCode, errorMessage);
+            if (outError != NULL) {
+                *outError = [NSError errorWithDomain:Domain code:errorCode userInfo:@{ NSLocalizedDescriptionKey: errorMessage ?: @"" }];
+            }
+            success = NO;
+        }
+    }];
+
+    return success;
+}
+
 - (BOOL) clearDatabase
 {
     __block BOOL success;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@josuelmm/cordova-background-geolocation",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Cordova Background Geolocation (fork actualizado)",
   "main": "./www/BackgroundGeolocation.js",
   "types": "./www/BackgroundGeolocation.d.ts",
@@ -29,7 +29,8 @@
   "scripts": {
     "build:angular": "npx ng-packagr -p angular/ng-package.json",
     "prepack": "npm run build:angular",
-    "prepublishOnly": "npm run build:angular"
+    "pack": "npm pack",
+    "build-package": "npm run build:angular && npm pack"
   },
   "cordova": {
     "id": "cordova-background-geolocation",

package/plugin.xml

@@ -2,7 +2,7 @@
 <plugin xmlns="http://www.phonegap.com/ns/plugins/1.0"
     xmlns:android="http://schemas.android.com/apk/res/android"
     id="cordova-background-geolocation"
-    version="3.0.2">
+    version="3.1.0">
     <name>cordova-background-geolocation</name>
     <description>Cordova Background Geolocation Plugin</description>
     <license>Apache-2.0</license>

package/www/BackgroundGeolocation.d.ts

@@ -214,6 +214,33 @@ export interface ConfigureOptions {
    */
   notificationText?: string;
 
+  /**
+   * Title shown in the notification while locations are syncing to the server.
+   * Use this (and notificationSyncText, etc.) to localize sync notifications.
+   *
+   * Platform: Android
+   * @default "Syncing locations"
+   */
+  notificationSyncTitle?: string;
+
+  /**
+   * Text shown in the sync notification while upload is in progress.
+   * @default "Sync in progress"
+   */
+  notificationSyncText?: string;
+
+  /**
+   * Text shown when sync completes successfully.
+   * @default "Sync completed"
+   */
+  notificationSyncCompletedText?: string;
+
+  /**
+   * Text shown when sync fails (prefix before " (HTTP …)" or ": error").
+   * @default "Sync failed"
+   */
+  notificationSyncFailedText?: string;
+
   /**
    * The accent color (hex triplet) to use for notification.
    * Eg. <code>#4CAF50</code>.
@@ -301,6 +328,15 @@ export interface ConfigureOptions {
    */
   syncThreshold?: number;
 
+  /**
+   * Whether synchronization to syncUrl is enabled (automatic and forceSync).
+   * When false, no sync runs; locations are still stored and can be synced later by setting sync: true.
+   *
+   * Platform: Android, iOS
+   * @default true
+   */
+  sync?: boolean;
+
   /**
    * Optional HTTP headers sent along in HTTP request.
    *
@@ -710,6 +746,7 @@ export interface BackgroundGeolocationPlugin {
   /**
    * Force sync of pending locations.
    * Option <code>syncThreshold</code> will be ignored and all pending locations will be immediately posted to <code>syncUrl</code> in single batch.
+   * No-op if <code>sync</code> is false in config.
    *
    * Platform: Android, iOS
    *
@@ -721,6 +758,34 @@ export interface BackgroundGeolocationPlugin {
     fail?: (error: BackgroundGeolocationError) => void
   ): Promise<void>;
 
+  /**
+   * Clear the pending sync queue: discard all locations waiting to be sent to syncUrl.
+   * They will not be synced. Use when the user wants to discard pending locations.
+   *
+   * Platform: Android, iOS
+   *
+   * @param success
+   * @param fail
+   */
+  clearSync(
+    success?: () => void,
+    fail?: (error: BackgroundGeolocationError) => void
+  ): Promise<void>;
+
+  /**
+   * Get the number of locations pending to be synced (not yet sent to syncUrl).
+   * Use with forceSync() to sync on demand.
+   *
+   * Platform: Android, iOS
+   *
+   * @param success Called with the pending count (number).
+   * @param fail
+   */
+  getPendingSyncCount(
+    success?: (count: number) => void,
+    fail?: (error: BackgroundGeolocationError) => void
+  ): Promise<number>;
+
   /**
    * Get stored configuration options.
    *

package/www/BackgroundGeolocation.js

@@ -221,6 +221,18 @@ var BackgroundGeolocation = {
       'forceSync');
   },
 
+  clearSync: function (success, failure) {
+    return execWithPromise(success,
+      failure,
+      'clearSync');
+  },
+
+  getPendingSyncCount: function (success, failure) {
+    return execWithPromise(success,
+      failure,
+      'getPendingSyncCount');
+  },
+
   on: function (event, callbackFn) {
     assert(this.events.indexOf(event) > -1, [TAG, '#on unknown event "' + event + '"']);
     if (!callbackFn) {