@woosmap/react-native-plugin-geofencing 0.1.3 → 0.1.6

package/README.md

@@ -46,8 +46,6 @@ if you are using **M1 Mac** Update pod post installation like
   end
 ```
 
-For Android
-- ToDo: Please update for Android
 
 ### Supported Platforms ###
 ---
@@ -94,9 +92,10 @@ WoosmapGeofencing.getPermissionsStatus()
 ```
 
 Parameter status will be a string, one of:
-* `GRANTED_BACKGROUND` : User has granted location access even when app is not running in the foreground
-* `GRANTED_FOREGROUND` : Location access is granted only while user is using the app
-* `DENIED`: Location access is denied
+* `GRANTED_BACKGROUND` : User has granted location access even when app is not running in the foreground.
+* `GRANTED_FOREGROUND` : Location access is granted only while user is using the app.
+* `DENIED`: Location access is denied.
+* `UNKNOWN`: Without providing or denying any permission then it will return unknown.
 
 **_Please note_**: Plugin will not work as expected if location access is denied.
 

package/android/src/main/java/com/reactnativeplugingeofencing/PluginGeofencingModule.java

@@ -30,6 +30,9 @@ import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
 
+/**
+ * This is a React native plugin exposing Woosmap Geofencing SDK methods.
+ */
 @ReactModule(name = PluginGeofencingModule.NAME)
 public class PluginGeofencingModule extends ReactContextBaseJavaModule implements PermissionListener, LifecycleEventListener {
   public static final String NAME = "PluginGeofencing";
@@ -47,6 +50,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     this.reactContext.addLifecycleEventListener(this);
   }
 
+  /***
+   * Return plugin name.
+   * @return woosmap native plugin name.which is constant for android and ios.
+   */
   @Override
   @NonNull
   public String getName() {
@@ -62,6 +69,12 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
   }
 
 
+  /***
+   * Initializes Woosmap object with given parameters.
+   * @param map     ReadableMap may contain privateKeyWoosmapAPI with Woosmap API key,
+   *                trackingProfile with tracking profile info.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void initialize(ReadableMap map, Promise promise) {
     String trackingProfile = "";
@@ -106,6 +119,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
 
   }
 
+  /***
+   * Checks if Woosmap object is instantiated.
+   * @return true if woosmap sdk is initialized else false.
+   */
   private boolean isWoosmapInitialized() {
     if (woosmap == null) {
       return false;
@@ -113,6 +130,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     return true;
   }
 
+  /***
+   * Requests permissions. If the background permission is required then ACCESS_BACKGROUND_LOCATION is requested for devices above Android 9.
+   * @param data Readable Array containing a boolean parameter to check if the background permission is required.
+   */
   @ReactMethod
   private void requestPermissions(ReadableArray data, Promise promise) {
     try {
@@ -146,6 +167,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     return true;
   }
 
+  /***
+   * Provide status of foreground and background location permission.
+   * @param promise React native callback context.
+   */
   private void providePermissionStatus(final Promise promise) {
     try {
       if (promise == null) {
@@ -179,11 +204,23 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Checks if the required location permissions are granted or not.
+   * Returns DENIED if no permissions are granted.
+   * Returns GRANTED_FOREGROUND if foreground location permission is granted.
+   * Returns GRANTED_BACKGROUND if background location permission is granted.
+   * Returns UNKNOWN if plugin is unable to determine or asking for permission without providing any permission.
+   */
   @ReactMethod
   public void getPermissionsStatus(final Promise promise) {
     providePermissionStatus(promise);
   }
 
+  /***
+   * Check if the user has given location permission.
+   * @param isBackground Pass true if the background permission needs to be checked.
+   * @return boolean
+   */
   private boolean hasPermission(boolean isBackground) {
     try {
       Activity activity = getCurrentActivity();
@@ -225,6 +262,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Sets the Woosmap private API key for calling Woosmap APIs.
+   * @param data accepts Woosmap API key in a Readable array.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void setWoosmapApiKey(ReadableArray data, Promise promise) {
     try {
@@ -248,6 +290,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Starts Woosmap Geofencing tracking.
+   * @param data Accepts tracking profile. Value can be either liveTracking, passiveTracking or stopsTracking.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void startTracking(ReadableArray data, Promise promise) {
     try {
@@ -273,6 +320,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Stops tracking
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void stopTracking(Promise promise) {
     try {
@@ -288,6 +339,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Add watch to woosmap location data.
+   * @param watchID Unique String value for location listener.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void watchLocation(String watchID, Promise promise) {
     try {
@@ -307,6 +363,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Clear woosmap location watch.
+   * @param watchID Unique String value for location listener.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void clearLocationWatch(String watchID, Promise promise) {
     try {
@@ -322,6 +383,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Sets Sales Force Marketing Cloud credentials.
+   * @param map accepts Sales Force Marketing Cloud credentials key in a ReadableMap.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   private void setSFMCCredentials(ReadableMap map, Promise promise) {
     try {
@@ -365,6 +431,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Add watch to woosmap region data.
+   * @param watchID Unique String value for region listener.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void watchRegions(String watchID, Promise promise) {
     try {
@@ -385,6 +456,12 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Clear woosmap region watch.
+   * @param watchID Unique String value for region listener.Which is getting
+   * @param promise React native callback context.
+   */
+
   @ReactMethod
   public void clearRegionsWatch(String watchID, Promise promise) {
     try {
@@ -401,35 +478,39 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Set radius of POI
+   * @param radius  A string containing POI radius value in number,string,double format.
+   * @param promise React native callback context.
+   */
   @ReactMethod
-  public void setPoiRadius(String radius,Promise promise){
-    try{
-      if (isWoosmapInitialized()){
-        if (radius.isEmpty()){
+  public void setPoiRadius(String radius, Promise promise) {
+    try {
+      if (isWoosmapInitialized()) {
+        if (radius.isEmpty()) {
           throw new Exception(WoosmapMessageAndKey.radiusEmptyMessage);
         }
-        if(onlyContainsNumbers(radius)){
-          WoosmapSettings.poiRadius=Integer.parseInt(radius);
+        if (onlyContainsNumbers(radius)) {
+          WoosmapSettings.poiRadius = Integer.parseInt(radius);
           promise.resolve(WoosmapMessageAndKey.successMessage);
-        }else if(onlyContainsDouble(radius)){
-          double d=Double.parseDouble(radius);
-          WoosmapSettings.poiRadius=(int) Math.round(d);
+        } else if (onlyContainsDouble(radius)) {
+          double d = Double.parseDouble(radius);
+          WoosmapSettings.poiRadius = (int) Math.round(d);
           promise.resolve(WoosmapMessageAndKey.successMessage);
-        }else {
-          WoosmapSettings.poiRadiusNameFromResponse=radius;
+        } else {
+          WoosmapSettings.poiRadiusNameFromResponse = radius;
           promise.resolve(WoosmapMessageAndKey.successMessage);
         }
-      }else {
+      } else {
         promise.reject(WoosmapMessageAndKey.errorCode, WoosmapMessageAndKey.woosmapNotInitialized);
       }
-    }
-    catch (Exception ex){
-      promise.reject(WoosmapMessageAndKey.errorCode,ex.getMessage());
+    } catch (Exception ex) {
+      promise.reject(WoosmapMessageAndKey.errorCode, ex.getMessage());
     }
   }
 
-  /**
-   *
+  /***
+   * Its check string is integer or not.
    * @param text string for checking if it contains only number or not.
    * @return true boolean value if string is only number else false.
    */
@@ -442,6 +523,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Its check string is double or not.
+   * @param text String for checking if it contain double or not.
+   * @return true boolean value if string is double else false.
+   */
   private boolean onlyContainsDouble(String text) {
     try {
       Double.parseDouble(text);
@@ -450,6 +536,6 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
       return false;
     }
   }
-  
+
 
 }

package/android/src/main/java/com/reactnativeplugingeofencing/WoosLocationReadyListener.java

@@ -10,6 +10,9 @@ import com.facebook.react.bridge.ReactContext;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 import com.webgeoservices.woosmapgeofencing.Woosmap;
 
+/***
+ * Implements Woosmap Location Ready callbacks
+ */
 public class WoosLocationReadyListener implements Woosmap.LocationReadyListener {
   private ReactNativeHost reactNativeHost;
   private Context context;

package/android/src/main/java/com/reactnativeplugingeofencing/WoosRegionReadyListener.java

@@ -11,6 +11,9 @@ import com.webgeoservices.woosmapgeofencing.Woosmap;
 import com.webgeoservices.woosmapgeofencing.database.Region;
 import com.webgeoservices.woosmapgeofencing.database.RegionLog;
 
+/***
+ * Implements Woosmap Region callbacks
+ */
 public class WoosRegionReadyListener implements Woosmap.RegionReadyListener,Woosmap.RegionLogReadyListener {
 
   private ReactNativeHost reactNativeHost;

package/android/src/main/java/com/reactnativeplugingeofencing/WoosmapMessageAndKey.java

@@ -1,5 +1,6 @@
 package com.reactnativeplugingeofencing;
 
+
 public class WoosmapMessageAndKey {
   protected static String errorCode = "1001";
   protected static String successMessage="OK";
@@ -9,9 +10,9 @@ public class WoosmapMessageAndKey {
   protected static String permissionNotGrantedMessage="Required permissions not granted";
   protected static String permissionValueNotProvided="Permission value not provided";
   protected static String unknownMessage="UNKNOWN";
-  protected static String deniedPermissionMessage="PERMISSION_STATUS_DENIED";
-  protected static String foregroundPermissionGrantedMessage="PERMISSION_STATUS_GRANTED_FOREGROUND";
-  protected static String backgroundPermissionGrantedMessage="PERMISSION_STATUS_GRANTED_BACKGROUND";
+  protected static String deniedPermissionMessage="DENIED";
+  protected static String foregroundPermissionGrantedMessage="GRANTED_FOREGROUND";
+  protected static String backgroundPermissionGrantedMessage="GRANTED_BACKGROUND";
   protected static String woosmapKeyNotProvide="Woosmap API Key not provided";
   protected static String woosmapNotInitialized="Woosmap not initialized";
   protected static String trackingProfileNotProvided="Tracking profile is missing";

package/android/src/main/java/com/reactnativeplugingeofencing/WoosmapUtil.java

@@ -16,6 +16,9 @@ import org.json.JSONObject;
 
 import java.util.Iterator;
 
+/***
+ * Contains misc. utility functions.
+ */
 public class WoosmapUtil {
   private static final String TAG="WoosmapUtil";
 

package/ios/DataDistance.swift

@@ -7,29 +7,22 @@
 import Foundation
 import CoreLocation
 import WoosmapGeofencing
+import SwiftUI
 
 public class DataDistance: DistanceAPIDelegate {
-    public func distanceAPIResponse(distance: [Distance]) {
-        
-    }
     
     public init() {}
 
-    public func distanceAPIResponseData(distanceAPIData: DistanceAPIData, locationId: String) {
-        if distanceAPIData.status == "OK" {
-            if distanceAPIData.rows?.first?.elements?.first?.status == "OK" {
-                let distance = distanceAPIData.rows?.first?.elements?.first?.distance
-                let duration = distanceAPIData.rows?.first?.elements?.first?.duration
-                if distance != nil && duration != nil {
-                    // TODO: Implementation missing
-                    //let result: DistanceResponseResult = DistanceResponseResult.init(locationId: locationId, distance: distance!, duration: duration!)
-                    //NotificationCenter.default.post(name: .distanceCalculated, object: self, userInfo: ["Distance": result])
-                }
-            }
-        } else {
-            let result: DistanceResponseError = DistanceResponseError.init(locationId: locationId, error: distanceAPIData.status ?? "-")
-            NotificationCenter.default.post(name: .distanceCalculated, object: self, userInfo: ["Distance": result])
-        }
+    public func distanceAPIResponse(distance: [Distance]) {
+
+        distance.forEach({ distanceElement in
+            let distance = distanceElement.distance
+            let duration = distanceElement.duration
+                let result: DistanceResponseResult = DistanceResponseResult.init(distance: distance, duration: duration)
+                    NotificationCenter.default.post(name: .distanceCalculated, object: self, userInfo: ["Distance": result])
+                    // print(distance?.value ?? 0)
+                    // print(duration?.text ?? 0)
+        })
     }
 
     public func distanceAPIError(error: String) {
@@ -42,11 +35,9 @@ extension Notification.Name {
 }
 
 class DistanceResponseResult {
-    var locationId: String = ""
-    var distance: Distance
-    var duration: Distance
-    required init(locationId: String, distance: Distance, duration: Distance) {
-        self.locationId = locationId
+    var distance: Int
+    var duration: Int
+    required init(distance: Int, duration: Int) {
         self.distance = distance
         self.duration = duration
     }

package/ios/DataLocation.swift

@@ -15,6 +15,18 @@ public class DataLocation: LocationServiceDelegate {
 
     public func tracingLocation(location: Location) {
         NotificationCenter.default.post(name: .newLocationSaved, object: self, userInfo: ["Location": location])
+
+//        let content = UNMutableNotificationContent()
+//        content.title = "Location update"
+//        content.body = "Location = " + "Lat = " + String(format: "%f", location.latitude) + " Lng = " + String(format: "%f", location.longitude)
+//        // Create the request
+//        let uuidString = UUID().uuidString
+//        let request = UNNotificationRequest(identifier: uuidString,
+//                    content: content, trigger: nil)
+//
+//        // Schedule the request with the system.
+//        let notificationCenter = UNUserNotificationCenter.current()
+//        notificationCenter.add(request)
     }
 
     public func tracingLocationDidFailWithError(error: Error) {

package/ios/DataRegion.swift

@@ -20,12 +20,10 @@ public class DataRegion: RegionsServiceDelegate {
 
     public func didEnterPOIRegion(POIregion: Region) {
         NotificationCenter.default.post(name: .didEventPOIRegion, object: self, userInfo: ["Region": POIregion])
-        sendNotification(POIregion: POIregion, didEnter: true)
     }
 
     public func didExitPOIRegion(POIregion: Region) {
         NotificationCenter.default.post(name: .didEventPOIRegion, object: self, userInfo: ["Region": POIregion])
-        sendNotification(POIregion: POIregion, didEnter: false)
     }
 
     public func workZOIEnter(classifiedRegion: Region) {
@@ -44,31 +42,6 @@ public class DataRegion: RegionsServiceDelegate {
         Regions.deleteAll()
     }
 
-    public func sendNotification(POIregion: Region, didEnter: Bool) {
-        let content = UNMutableNotificationContent()
-        if didEnter {
-            content.title = "Region enter"
-        } else {
-            content.title = "Region exit"
-        }
-        content.body = "Region = " + POIregion.identifier
-        content.body += "Lat = " + String(format: "%f", POIregion.latitude) + " Lng = " + String(format: "%f", POIregion.longitude)
-        content.body += "\n FromPositionDetection = " + String(POIregion.fromPositionDetection)
-        // Create the request
-        let uuidString = UUID().uuidString
-        let request = UNNotificationRequest(identifier: uuidString,
-                                            content: content, trigger: nil)
-
-        let center = UNUserNotificationCenter.current()
-        center.getNotificationSettings { settings in
-            if settings.authorizationStatus == .authorized {
-                // Schedule the request with the system.
-                let notificationCenter = UNUserNotificationCenter.current()
-                notificationCenter.add(request)
-            }
-        }
-
-    }
 }
 
 extension Notification.Name {

package/ios/MarketingCloudEvents.swift

@@ -22,42 +22,42 @@ public class MarketingCloudEvents: MarketingCloudEventsDelegate {
 
     public func regionEnterEvent(regionEvent: [String: Any], eventName: String) {
         // here you can modify your event name and add your data in the dictonnary
-        print("MarketingCloudEvents regionEnterEvent")
+        //print("MarketingCloudEvents regionEnterEvent")
         let result: MarketingData = MarketingData.init(eventname: eventName, properties: regionEvent)
         NotificationCenter.default.post(name: .marketingEvent, object: self, userInfo: ["Marketing": result])
     }
 
     public func regionExitEvent(regionEvent: [String: Any], eventName: String) {
         // here you can modify your event name and add your data in the dictonnary
-        print("MarketingCloudEvents regionExitEvent")
+        //print("MarketingCloudEvents regionExitEvent")
         let result: MarketingData = MarketingData.init(eventname: eventName, properties: regionEvent)
         NotificationCenter.default.post(name: .marketingEvent, object: self, userInfo: ["Marketing": result])
     }
 
     public func visitEvent(visitEvent: [String: Any], eventName: String) {
         // here you can modify your event name and add your data in the dictonnary
-        print("MarketingCloudEvents visitEvent")
+        //print("MarketingCloudEvents visitEvent")
         let result: MarketingData = MarketingData.init(eventname: eventName, properties: visitEvent)
         NotificationCenter.default.post(name: .marketingEvent, object: self, userInfo: ["Marketing": result])
     }
 
     public func poiEvent(POIEvent: [String: Any], eventName: String) {
         // here you can modify your event name and add your data in the dictonnary
-        print("MarketingCloudEvents poiEvent")
+        //print("MarketingCloudEvents poiEvent")
         let result: MarketingData = MarketingData.init(eventname: eventName, properties: POIEvent)
         NotificationCenter.default.post(name: .marketingEvent, object: self, userInfo: ["Marketing": result])
     }
 
     public func ZOIclassifiedEnter(regionEvent: [String: Any], eventName: String) {
         // here you can modify your event name and add your data in the dictonnary
-        print("MarketingCloudEvents ZOIclassifiedEnter")
+        //print("MarketingCloudEvents ZOIclassifiedEnter")
         let result: MarketingData = MarketingData.init(eventname: eventName, properties: regionEvent)
         NotificationCenter.default.post(name: .marketingEvent, object: self, userInfo: ["Marketing": result])
     }
 
     public func ZOIclassifiedExit(regionEvent: [String: Any], eventName: String) {
         // here you can modify your event name and add your data in the dictonnary
-        print("MarketingCloudEvents ZOIclassifiedExit")
+        //print("MarketingCloudEvents ZOIclassifiedExit")
         let result: MarketingData = MarketingData.init(eventname: eventName, properties: regionEvent)
         NotificationCenter.default.post(name: .marketingEvent, object: self, userInfo: ["Marketing": result])
     }

package/ios/PluginGeofencing.swift

@@ -613,10 +613,9 @@ class PluginGeofencing: RCTEventEmitter {
     
     private func formatDistanceData(woosdata: DistanceResponseResult) -> [AnyHashable: Any] {
         var result: [AnyHashable: Any] = [:]
-        result["locationid"] = woosdata.locationId
-        //TODO: format it
-        result["distance"] = "" //woosdata.distance.text
-        result["duration"] = "" //woosdata.duration.text
+        result["locationid"] = ""//woosdata.locationId
+        result["distance"] = String(woosdata.distance)
+        result["duration"] = String(woosdata.duration)
         return result
     }
     

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@woosmap/react-native-plugin-geofencing",
-  "version": "0.1.3",
+  "version": "0.1.6",
   "description": "This react-native plugin extends the functionality offered by the Woosmap Geofencing Mobile SDKs. Find more about the Woosmap Geofencing SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",