@woosmap/react-native-plugin-geofencing 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 WGS Indoor
+
+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,340 @@
+![woosmap](https://avatars.githubusercontent.com/u/1203240?s=200&v=4)
+
+# react-native-plugin-geofencing
+
+This react-native plugin extends the functionality offered by the Woosmap Geofencing Mobile SDKs. Find more about the Woosmap Geofencing SDK
+
+## Installation
+
+```sh
+npm install @woosmap/react-native-plugin-geofencing
+```
+
+**Adding the platform**
+
+For iOS
+
+- **info.plist**: Please check info.plist updated with following keys
+  - NSLocationAlwaysAndWhenInUseUsageDescription
+  - NSLocationAlwaysUsageDescription
+  - NSLocationWhenInUseUsageDescription
+  - UIBackgroundModes
+
+  ```
+  <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
+  <string>Used to test the library</string>
+  <key>NSLocationAlwaysUsageDescription</key>
+  <string>Used to test the library</string>
+  <key>NSLocationWhenInUseUsageDescription</key>
+  <string>Used to test the library</string>
+  <key>UIBackgroundModes</key>
+  <array>
+    <string>location</string>
+  </array>
+
+  ```
+- **Podfile**: configure to use ```use_frameworks!``` and ```platform :ios, '12.0'```
+if you are using **M1 Mac** Update pod post installation like
+```
+  post_install do |installer|
+	installer.pods_project.targets.each do |target|
+  		target.build_configurations.each do |config|
+          config.build_settings["ONLY_ACTIVE_ARCH"] = "NO"
+          config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '12.0'
+      end
+    end
+  end
+```
+
+For Android
+- ToDo: Please update for Android
+
+### Supported Platforms ###
+---
+- iOS
+- Android
+
+### Modules
+---
+* **WoosmapGeofencing**: Woosmap contains methods to monitor location, regions.
+
+### Objects(Read Only)
+---
+* **Location**: Represents the location object
+* **POI**: Represents Point of Interest
+* **Region**: Represents a geographical region/geofence
+* **Visit**: Represents a visit to a location/POI
+* **ZOI**: Represents Zone of Interest
+* **Airship**: Contains custom data related to Airship implementation
+* **MarketingCloud**: Contains custom data related to third party marketing cloud implementation
+
+## Usage
+
+``` javascript
+import WoosmapGeofencing from 'react-native-plugin-geofencing';
+
+// ...
+
+```
+
+### Check and request permissions
+---
+Before initializing the SDK it is required that you request for required location permissions.
+
+To check if the location permissions are granted by the user call `getPermissionsStatus` method.
+
+``` javascript
+WoosmapGeofencing.getPermissionsStatus()
+      .then((status: string) => {
+        console.log(status);
+      })
+      .catch((error: any) => {
+         alert('message: ' + error.message);
+      });
+```
+
+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
+
+**_Please note_**: Plugin will not work as expected if location access is denied.
+
+**Requesting location access**
+To request location access call `requestPermissions` method of the plugin. This will result in displaying location access permission dialog. This method accepts a boolean parameter `isBackground`. If this parameter is set to true, then plugin will ask for background location access. Code snippet below asks for background location access.
+
+``` javascript
+WoosmapGeofencing.requestPermissions(props.background)
+      .then((status: string) => {
+        console.log(status);
+      })
+      .catch((error: any) => {
+         alert('message: ' + error.message);
+      });
+
+```
+
+### Initializing the plugin
+---
+
+Plugin can be initialized by simply calling `initialize` method.
+
+``` javascript
+var woosmapSettings = {
+    privateKeyWoosmapAPI: "<<WOOSMAP_KEY>>",
+    trackingProfile: "liveTracking"
+};
+WoosmapGeofencing.initialize(woosmapSettings)
+      .then((value: string) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+Both configuration options `privateKeyWoosmapAPI` and `trackingProfile` are optional. You can also initialize the plugin by passing null configuration.
+
+```
+await WoosmapGeofencing.initialize();
+```
+
+You can also set the Woosmap API key later by calling `setWoosmapApiKey` method.
+
+``` javascript
+WoosmapGeofencing.setWoosmapApiKey(<privateKeyWoosmapAPI>)
+      .then((value: string) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+### Tracking
+---
+
+Once you have initialized the plugin and the user has authorized location permissions, you can start tracking the user’s location.
+
+To start tracking, call:
+``` javascript
+WoosmapGeofencing.startTracking('liveTracking')
+      .then((result: string) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+
+```
+
+To stop tracking, call:
+``` javascript
+WoosmapGeofencing.stopTracking()
+      .then((value: any) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+Method `startTracking` accepts only following tracking profiles
+
+* **liveTracking**
+* **passiveTracking**
+* **visitsTracking**
+
+### Tracking profile properties
+---
+
+| Property | liveTracking | passiveTracking | visitsTracking
+| ----------- | ----------- | ----------- | ----------- |
+| trackingEnable | true | true | true
+| foregroundLocationServiceEnable | true | false | false
+| modeHighFrequencyLocation | true | false | false
+| visitEnable | false | false | true
+| classificationEnable | false | false | true
+| minDurationVisitDisplay | null | null | 300
+| radiusDetectionClassifiedZOI | null | null | 50
+| distanceDetectionThresholdVisits | null | null | 25
+| currentLocationTimeFilter | 0 | 0 | 0
+| currentLocationDistanceFilter | 0 | 0 | 0
+| accuracyFilter | 100 | 100 | 100
+| searchAPIEnable | false | true | false
+| searchAPICreationRegionEnable | false | true | false
+| searchAPITimeFilter | 0 | 0 | 0
+| searchAPIDistanceFilter | 0 | 0 | 0
+| distanceAPIEnable | false | false | false
+| modeDistance | null | null | null
+| outOfTimeDelay | 300 | 300 | 300
+| DOUBLEOfDayDataDuration | 30 | 30 | 30
+
+### Listening to events
+---
+
+**Location**
+
+To listen to location, call `watchLocation` method. Method will invoke callback and pass a location object as a parameter. Method will return a watchId . This id can be used to remove a callback.
+
+``` javascript
+const callback = (value: Location) => {
+      alert('message: ' + JSON.stringify(value));
+  };
+
+WoosmapGeofencing.watchLocation(callback)
+     .then((watchRef: string) => {
+       //Keep watchRef, it requires when you wish to remove location watch.
+       console.log('Watch added');
+     })
+     .catch((error: any) => {
+       alert('message: ' + error.message);
+     });
+```
+
+To stop getting location updates:
+
+``` javascript
+WoosmapGeofencing.clearLocationWatch(watchID)
+      .then((watchRef: string) => {
+        console.log(watchRef);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+**Define the radius value**
+
+When you create a Geofence around a POI (previously imported from Woosmap), manually define the radius value:
+```javascript
+WoosmapGeofencing.setPoiRadius("100")
+      .then((value: string) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+or choose the user_properties subfield that corresponds to radius value of the Geofence:
+```javascript
+WoosmapGeofencing.setPoiRadius("radiusPOI")
+      .then((value: string) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+**Regions**
+
+Call `watchRegions` method to track Regions. Method will invoke a callback with Region object. Method will return a watch id which can be used later to remove the callback.
+
+``` javascript
+WoosmapGeofencing.watchRegions(callback)
+      .then((watchRef: string) => {
+        //Keep watchRef, it requires when you wish to remove region watch.
+        console.log('Watch added');
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+To remove watch:
+
+``` javascript
+WoosmapGeofencing.clearRegionsWatch(watchID)
+      .then((watchRef: string) => {
+        console.log(watchRef);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+### Initialize Salesforce MarketingCloud Connector
+---
+
+The SDK needs some input like credentials and object key to perform the API call to Salesforce Marketing Cloud API.
+
+**Input to initialize the SFMC connector**<br/>
+
+| Parameters                             | Description                                                                                               | Required |
+| -------------------------------------- | --------------------------------------------------------------------------------------------------------- | -------- |
+| authenticationBaseURI                  | Authentication Base URI                                                                                   | Required |
+| restBaseURI                            | REST Base URI                                                                                             | Required |
+| client\_id                             | client\_id (journey\_read and list\_and\_subscribers\_read rights are required)                           | Required |
+| client\_secret                         | client\_secret (journey\_read and list\_and\_subscribers\_read rights are required)                       | Required |
+| contactKey                             | The ID that uniquely identifies a subscriber/contact                                                      | Required |
+| regionEnteredEventDefinitionKey        | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_geofence_entered_event`       |          |
+| regionExitedEventDefinitionKey         | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_geofence_exited_event`        |          |
+| poiEventDefinitionKey                  | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_POI_event`                    |          |
+| zoiClassifiedEnteredEventDefinitionKey | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_zoi_classified_entered_event` |          |
+| zoiClassifiedExitedEventDefinitionKey  | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_zoi_classified_exited_event`  |          |
+| visitEventDefinitionKey                | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_Visit_event`                  |
+
+**Initialize the connector implementation**
+``` javascript
+    var sfmcCredentials = {
+        authenticationBaseURI: "https://xxxxxxxxxx.auth.marketingcloudapis.com",
+        restBaseURI: "https://xxxxxxxxxx.rest.marketingcloudapis.com",
+        client_id: "xxxxxxxxxxxxxxx",
+        client_secret: "xxxxxxxxxxxxxxx",
+        contactKey: "ID001",
+        regionEnteredEventDefinitionKey: "APIEvent-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+        regionExitedEventDefinitionKey: "APIEvent-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    };
+    WoosmapGeofencing.setSFMCCredentials(sfmcCredentials)
+      .then((value: any) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+
+## License
+
+MIT

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Sun Apr 10 13:29:32 IST 2022
+gradle.version=7.1.1

package/android/build.gradle

@@ -0,0 +1,60 @@
+buildscript {
+    if (project == rootProject) {
+        repositories {
+            google()
+            mavenCentral()
+            jcenter()
+        }
+
+        dependencies {
+            classpath 'com.android.tools.build:gradle:3.5.4'
+        }
+    }
+}
+
+apply plugin: 'com.android.library'
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+android {
+    compileSdkVersion safeExtGet('PluginGeofencing_compileSdkVersion', 29)
+    defaultConfig {
+        minSdkVersion safeExtGet('PluginGeofencing_minSdkVersion', 21)
+        targetSdkVersion safeExtGet('PluginGeofencing_targetSdkVersion', 29)
+        versionCode 1
+        versionName "1.0"
+
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
+    }
+    lintOptions {
+        disable 'GradleCompatible'
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+}
+
+repositories {
+    mavenLocal()
+    maven {
+        // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+        url("$rootDir/../node_modules/react-native/android")
+    }
+    google()
+    mavenCentral()
+    jcenter()
+}
+
+dependencies {
+    //noinspection GradleDynamicVersion
+    implementation "com.facebook.react:react-native:+"  // From node_modules
+    implementation("com.webgeoservices.woosmapgeofencing:woosmap-mobile-sdk:1.2.1")
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.reactnativeplugingeofencing">
+
+</manifest>