@woosmap/react-native-plugin-geofencing 0.1.4 → 0.1.7

package/src/index.tsx

@@ -1,46 +1,19 @@
-import { NativeModules, NativeEventEmitter } from 'react-native';
+import { NativeEventEmitter } from 'react-native';
 import uuid from 'react-native-uuid';
-import Location from './Location';
-import Region from './Region';
-
-// const LINKING_ERROR =
-//   `The package 'react-native-plugin-geofencing' doesn't seem to be linked. Make sure: \n\n` +
-//   Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-//   '- You rebuilt the app after installing the package\n' +
-//   '- You are not using Expo managed workflow\n';
-
-// const PluginGeofencing = NativeModules.PluginGeofencing
-//   ? NativeModules.PluginGeofencing
-//   : new Proxy(
-//       {},
-//       {
-//         get() {
-//           throw new Error(LINKING_ERROR);
-//         },
-//       }
-//     );
-
-if (!NativeModules.PluginGeofencing) {
-  throw new Error('NativeModules.PluginGeofencing is undefined');
-}
-const PluginGeofencing = NativeModules.PluginGeofencing;
-// ? NativeModules.PluginGeofencing
-// : new Proxy(
-//     {},
-//     {
-//       get() {
-//         throw new Error(LINKING_ERROR);
-//       },
-//     }
-//   );
+import PluginGeofencing from './internal/nativeInterface';
+import Location from './internal/Location';
+import Region from './internal/Region';
+import Poi from './internal/Poi';
+import type {
+  GeofenceRegion,
+  RegionType,
+  ProfileSource,
+} from './internal/types';
+
 const eventEmitter = new NativeEventEmitter(PluginGeofencing);
 
 let subscriptionsLocation: any = {};
 let subscriptionsRegion: any = {};
-
-function multiply(a: number, b: number): Promise<number> {
-  return PluginGeofencing.multiply(a, b);
-}
 /**
  * Initializes the Woosmap object
  * @param arg0 A JSON object with Woosmap Key (optional) and tracking profile (`liveTracking`,`passiveTracking`,`visitsTracking`).
@@ -221,9 +194,162 @@ function setSFMCCredentials(arg0: Object): Promise<string> {
 function setPoiRadius(radius: string): Promise<string> {
   return PluginGeofencing.setPoiRadius(radius);
 }
+/**
+ * Adds a custom region that you want to monitor.
+ * @param region A GeofenceRegion object with latitude, longitude, radius and type.
+ * @returns promise with A callback that will be called on success or error.
+ */
+
+function addRegion(region: GeofenceRegion): Promise<string> {
+  return PluginGeofencing.addRegion(region);
+}
+/**
+ * Retrieve saved region info
+ * @param regionID If it pass return info for given region or return all region info
+ * @returns promise with A callback that will be called on success or error.
+ */
+function getRegions(regionID?: string): Promise<Region[]> {
+  if (regionID == null) {
+    return PluginGeofencing.getAllRegions()
+      .then((result: any[]) => {
+        var formatted: Region[] = [];
+        result.forEach((item) => {
+          formatted.push(Region.jsonToObj(item));
+        });
+        return Promise.resolve(formatted);
+      })
+      .catch((e: any) => {
+        return Promise.reject(e);
+      });
+  } else {
+    return PluginGeofencing.getRegions(regionID)
+      .then((result: any) => {
+        var formatted: Region[] = [];
+        formatted.push(Region.jsonToObj(result));
+        return Promise.resolve(formatted);
+      })
+      .catch((e: any) => {
+        return Promise.reject(e);
+      });
+  }
+}
+
+/**
+ * Retrieve saved location info
+ * @param locationID - Optional in case of location id pass it return only that location info
+ * @returns promise with A callback that will be called on success or error.
+ */
+function getLocations(locationID?: string): Promise<Location[]> {
+  if (locationID == null) {
+    return PluginGeofencing.getAllLocations()
+      .then((result: any[]) => {
+        var formatted: Location[] = [];
+        result.forEach((item) => {
+          formatted.push(Location.jsonToObj(item));
+        });
+        return Promise.resolve(formatted);
+      })
+      .catch((e: any) => {
+        return Promise.reject(e);
+      });
+  } else {
+    return PluginGeofencing.getLocation(locationID)
+      .then((result: any) => {
+        var formatted: Location[] = [];
+        formatted.push(Location.jsonToObj(result));
+        return Promise.resolve(formatted);
+      })
+      .catch((e: any) => {
+        return Promise.reject(e);
+      });
+  }
+}
+
+/**
+ * Retrieve saved POI info
+ * @param poiID - Optional in case of poi id (LocationID or StoreID) pass it return only that POI info
+ * @returns promise with A callback that will be called on success or error.
+ */
+function getPois(poiID?: string): Promise<Poi[]> {
+  if (poiID == null) {
+    return PluginGeofencing.getAllPois()
+      .then((result: any[]) => {
+        var formatted: Poi[] = [];
+        result.forEach((item) => {
+          formatted.push(Poi.jsonToObj(item));
+        });
+        return Promise.resolve(formatted);
+      })
+      .catch((e: any) => {
+        return Promise.reject(e);
+      });
+  } else {
+    return PluginGeofencing.getPoi(poiID)
+      .then((result: any) => {
+        var formatted: Poi[] = [];
+        formatted.push(Poi.jsonToObj(result));
+        return Promise.resolve(formatted);
+      })
+      .catch((e: any) => {
+        return Promise.reject(e);
+      });
+  }
+}
+
+/**
+ * Remove saved region info
+ * @param regionID If it pass remove info for given region or removes all region info
+ * @returns promise with A callback that will be called on success or error.
+ */
+function removeRegions(regionID?: string): Promise<string> {
+  if (regionID == null) {
+    return PluginGeofencing.removeAllRegions();
+  } else {
+    return PluginGeofencing.removeRegion(regionID);
+  }
+}
+
+/**
+ * Remove saved location info
+ * @returns promise with A callback that will be called on success or error.
+ */
+function removeLocations(): Promise<string> {
+  return PluginGeofencing.removeAllLocations();
+}
+
+/**
+ * Remove saved POI info
+ * @returns promise with A callback that will be called on success or error.
+ */
+function removePois(): Promise<string> {
+  return PluginGeofencing.removeAllPois();
+}
+/**
+ * if preset tracking profiles don’t fit with your use cases, you can build your own profile and uses the startCustomTracking() method. 
+ * There are two way to host the json file:
+ * - included in the client application (local)
+ * - hosted externally in a file folder in your information system (external)
+ * @param sourceType local/external
+ * @param source location of profile to be fetch
+ * @returns promise with A callback that will be called on success or error.
+ */
+function startCustomTracking(
+  sourceType: ProfileSource,
+  source: string
+): Promise<string> {
+  return PluginGeofencing.startCustomTracking(sourceType, source);
+}
+
+export type {
+  RegionType,
+  GeofenceRegion,
+  Region,
+  Location,
+  Poi,
+  ProfileSource,
+};
 
 const WoosmapGeofencing = {
-  multiply,
   initialize,
   setWoosmapApiKey,
   startTracking,
@@ -236,20 +362,14 @@ const WoosmapGeofencing = {
   clearRegionsWatch,
   setSFMCCredentials,
   setPoiRadius,
+  addRegion,
+  getRegions,
+  removeRegions,
+  getLocations,
+  removeLocations,
+  getPois,
+  removePois,
+  startCustomTracking,
 };
 
-/* We export the native interface in this way to give easy shared access to it between the
- * JavaScript code and the tests
- */
-//let nativeEventEmitter: NativeEventEmitter | null = null;
-
 export default WoosmapGeofencing;
-// module.exports = {
-//   WoosmapGeofencing,
-//   get GeolocationEventEmitter() {
-//     if (!nativeEventEmitter) {
-//       nativeEventEmitter = new NativeEventEmitter(PluginGeofencing);
-//     }
-//     return nativeEventEmitter;
-//   },
-// };

package/src/{Poi.tsx → internal/Poi.tsx}

@@ -10,6 +10,7 @@
  * @param {number} distance The distance between the POI and the user's location.
  * @param {number} duration The duration to travel to the POI from the user's location.
  * @param {number} latitude The latitude of the POI.
+ * @param {string} locationid Location id of the POI.
  * @param {number} longitude The longitude of the POI.
  * @param {string} zipcode The zip code of the POI.
  * @param {number} radius The radius of the POI.
@@ -28,7 +29,7 @@ class Poi {
   Distance: number;
   Duration: number;
   Latitude: number;
-  Locationid: number;
+  Locationid: string;
   Longitude: number;
   Zipcode: string;
   Radius: number;
@@ -46,7 +47,7 @@ class Poi {
     distance: number,
     duration: number,
     latitude: number,
-    locationid: number,
+    locationid: string,
     longitude: number,
     zipcode: string,
     radius: number,
@@ -103,4 +104,4 @@ class Poi {
     );
   }
 }
-module.exports = Poi;
+export default Poi;

package/src/internal/nativeInterface.tsx

@@ -0,0 +1,8 @@
+import { NativeModules } from 'react-native';
+let PluginGeofencing = NativeModules.PluginGeofencing;
+
+if (!PluginGeofencing) {
+  throw new Error('NativeModules.PluginGeofencing is undefined');
+}
+
+export default PluginGeofencing;

package/src/internal/types.tsx

@@ -0,0 +1,20 @@
+/**
+ * Geofence region types
+ */
+export type RegionType = 'circle' | 'isochrone';
+
+/**
+ * Location of custom profile to fetch
+ */
+export type ProfileSource = 'local' | 'external';
+
+/**
+ * GeofenceRegion structure
+ */
+export interface GeofenceRegion {
+  regionId: string;
+  lat: number;
+  lng: number;
+  radius: number;
+  type: RegionType;
+}

package/lib/commonjs/Poi.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["Poi.tsx"],"names":["Poi","constructor","jsondata","city","idstore","name","date","distance","duration","latitude","locationid","longitude","zipcode","radius","address","countrycode","tags","types","contact","Jsondata","City","Idstore","Name","Date","Distance","Duration","Latitude","Locationid","Longitude","Zipcode","Radius","Countrycode","Tags","Types","Contact","Address","jsonToObj","json","module","exports"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,GAAN,CAAU;AAkBRC,EAAAA,WAAW,CACTC,QADS,EAETC,IAFS,EAGTC,OAHS,EAITC,IAJS,EAKTC,IALS,EAMTC,QANS,EAOTC,QAPS,EAQTC,QARS,EASTC,UATS,EAUTC,SAVS,EAWTC,OAXS,EAYTC,MAZS,EAaTC,OAbS,EAcTC,WAdS,EAeTC,IAfS,EAgBTC,KAhBS,EAiBTC,OAjBS,EAkBT;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AACA,SAAKC,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,IAAL,GAAYjB,IAAZ;AACA,SAAKkB,OAAL,GAAejB,OAAf;AACA,SAAKkB,IAAL,GAAYjB,IAAZ;AACA,SAAKkB,IAAL,GAAYjB,IAAZ;AACA,SAAKkB,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,UAAL,GAAkBjB,UAAlB;AACA,SAAKkB,SAAL,GAAiBjB,SAAjB;AACA,SAAKkB,OAAL,GAAejB,OAAf;AACA,SAAKkB,MAAL,GAAcjB,MAAd;AACA,SAAKQ,OAAL,GAAejB,OAAf;AACA,SAAK2B,WAAL,GAAmBhB,WAAnB;AACA,SAAKiB,IAAL,GAAYhB,IAAZ;AACA,SAAKiB,KAAL,GAAahB,KAAb;AACA,SAAKiB,OAAL,GAAehB,OAAf;AACA,SAAKiB,OAAL,GAAerB,OAAf;AACD;AACD;AACF;AACA;AACA;AACA;AACA;;;AACkB,SAATsB,SAAS,CAACC,IAAD,EAAY;AAC1B,WAAO,IAAIrC,GAAJ,CACLqC,IAAI,CAACnC,QADA,EAELmC,IAAI,CAAClC,IAFA,EAGLkC,IAAI,CAACjC,OAHA,EAILiC,IAAI,CAAChC,IAJA,EAKLgC,IAAI,CAAC/B,IALA,EAML+B,IAAI,CAAC9B,QANA,EAOL8B,IAAI,CAAC7B,QAPA,EAQL6B,IAAI,CAAC5B,QARA,EASL4B,IAAI,CAAC3B,UATA,EAUL2B,IAAI,CAAC1B,SAVA,EAWL0B,IAAI,CAACzB,OAXA,EAYLyB,IAAI,CAACxB,MAZA,EAaLwB,IAAI,CAACvB,OAbA,EAcLuB,IAAI,CAACtB,WAdA,EAeLsB,IAAI,CAACrB,IAfA,EAgBLqB,IAAI,CAACpB,KAhBA,EAiBLoB,IAAI,CAACnB,OAjBA,CAAP;AAmBD;;AAlFO;;AAoFVoB,MAAM,CAACC,OAAP,GAAiBvC,GAAjB","sourcesContent":["/**\n * A class that represents the POI object.\n * @classdesc A class that represents the POI object.\n * @constructs Poi\n * @param {Object} jsonData A json object representing the POI.\n * @param {string} city The name of the city the POI belongs to.\n * @param {string} idstore A unique identifier for the POI.\n * @param {name} name The name of the POI.\n * @param {number} date The datetime stamp.\n * @param {number} distance The distance between the POI and the user's location.\n * @param {number} duration The duration to travel to the POI from the user's location.\n * @param {number} latitude The latitude of the POI.\n * @param {number} longitude The longitude of the POI.\n * @param {string} zipcode The zip code of the POI.\n * @param {number} radius The radius of the POI.\n * @param {string} address The address of the POI.\n * @param {string} countrycode The countrycode of the POI.\n * @param {string} tags The tags for the POI.\n * @param {string} types The types of the POI.\n * @param {string} contact The contact for the POI.\n */\nclass Poi {\n  Jsondata: object;\n  City: string;\n  Idstore: string;\n  Name: string;\n  Date: number;\n  Distance: number;\n  Duration: number;\n  Latitude: number;\n  Locationid: number;\n  Longitude: number;\n  Zipcode: string;\n  Radius: number;\n  Countrycode: string;\n  Tags: string;\n  Types: string;\n  Contact: string;\n  Address: string;\n  constructor(\n    jsondata: object,\n    city: string,\n    idstore: string,\n    name: string,\n    date: number,\n    distance: number,\n    duration: number,\n    latitude: number,\n    locationid: number,\n    longitude: number,\n    zipcode: string,\n    radius: number,\n    address: string,\n    countrycode: string,\n    tags: string,\n    types: string,\n    contact: string\n  ) {\n    this.Jsondata = jsondata;\n    this.City = city;\n    this.Idstore = idstore;\n    this.Name = name;\n    this.Date = date;\n    this.Distance = distance;\n    this.Duration = duration;\n    this.Latitude = latitude;\n    this.Locationid = locationid;\n    this.Longitude = longitude;\n    this.Zipcode = zipcode;\n    this.Radius = radius;\n    this.Idstore = idstore;\n    this.Countrycode = countrycode;\n    this.Tags = tags;\n    this.Types = types;\n    this.Contact = contact;\n    this.Address = address;\n  }\n  /**\n   * Converts json object to an object of type Poi.\n   * @param {Object} json The json representation of the Poi.\n   * @returns Object\n   * @memberof Poi\n   */\n  static jsonToObj(json: any) {\n    return new Poi(\n      json.jsondata,\n      json.city,\n      json.idstore,\n      json.name,\n      json.date,\n      json.distance,\n      json.duration,\n      json.latitude,\n      json.locationid,\n      json.longitude,\n      json.zipcode,\n      json.radius,\n      json.address,\n      json.countrycode,\n      json.tags,\n      json.types,\n      json.contact\n    );\n  }\n}\nmodule.exports = Poi;\n"]}

package/lib/module/Poi.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["Poi.tsx"],"names":["Poi","constructor","jsondata","city","idstore","name","date","distance","duration","latitude","locationid","longitude","zipcode","radius","address","countrycode","tags","types","contact","Jsondata","City","Idstore","Name","Date","Distance","Duration","Latitude","Locationid","Longitude","Zipcode","Radius","Countrycode","Tags","Types","Contact","Address","jsonToObj","json","module","exports"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,GAAN,CAAU;AAkBRC,EAAAA,WAAW,CACTC,QADS,EAETC,IAFS,EAGTC,OAHS,EAITC,IAJS,EAKTC,IALS,EAMTC,QANS,EAOTC,QAPS,EAQTC,QARS,EASTC,UATS,EAUTC,SAVS,EAWTC,OAXS,EAYTC,MAZS,EAaTC,OAbS,EAcTC,WAdS,EAeTC,IAfS,EAgBTC,KAhBS,EAiBTC,OAjBS,EAkBT;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AACA,SAAKC,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,IAAL,GAAYjB,IAAZ;AACA,SAAKkB,OAAL,GAAejB,OAAf;AACA,SAAKkB,IAAL,GAAYjB,IAAZ;AACA,SAAKkB,IAAL,GAAYjB,IAAZ;AACA,SAAKkB,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,QAAL,GAAgBjB,QAAhB;AACA,SAAKkB,UAAL,GAAkBjB,UAAlB;AACA,SAAKkB,SAAL,GAAiBjB,SAAjB;AACA,SAAKkB,OAAL,GAAejB,OAAf;AACA,SAAKkB,MAAL,GAAcjB,MAAd;AACA,SAAKQ,OAAL,GAAejB,OAAf;AACA,SAAK2B,WAAL,GAAmBhB,WAAnB;AACA,SAAKiB,IAAL,GAAYhB,IAAZ;AACA,SAAKiB,KAAL,GAAahB,KAAb;AACA,SAAKiB,OAAL,GAAehB,OAAf;AACA,SAAKiB,OAAL,GAAerB,OAAf;AACD;AACD;AACF;AACA;AACA;AACA;AACA;;;AACkB,SAATsB,SAAS,CAACC,IAAD,EAAY;AAC1B,WAAO,IAAIrC,GAAJ,CACLqC,IAAI,CAACnC,QADA,EAELmC,IAAI,CAAClC,IAFA,EAGLkC,IAAI,CAACjC,OAHA,EAILiC,IAAI,CAAChC,IAJA,EAKLgC,IAAI,CAAC/B,IALA,EAML+B,IAAI,CAAC9B,QANA,EAOL8B,IAAI,CAAC7B,QAPA,EAQL6B,IAAI,CAAC5B,QARA,EASL4B,IAAI,CAAC3B,UATA,EAUL2B,IAAI,CAAC1B,SAVA,EAWL0B,IAAI,CAACzB,OAXA,EAYLyB,IAAI,CAACxB,MAZA,EAaLwB,IAAI,CAACvB,OAbA,EAcLuB,IAAI,CAACtB,WAdA,EAeLsB,IAAI,CAACrB,IAfA,EAgBLqB,IAAI,CAACpB,KAhBA,EAiBLoB,IAAI,CAACnB,OAjBA,CAAP;AAmBD;;AAlFO;;AAoFVoB,MAAM,CAACC,OAAP,GAAiBvC,GAAjB","sourcesContent":["/**\n * A class that represents the POI object.\n * @classdesc A class that represents the POI object.\n * @constructs Poi\n * @param {Object} jsonData A json object representing the POI.\n * @param {string} city The name of the city the POI belongs to.\n * @param {string} idstore A unique identifier for the POI.\n * @param {name} name The name of the POI.\n * @param {number} date The datetime stamp.\n * @param {number} distance The distance between the POI and the user's location.\n * @param {number} duration The duration to travel to the POI from the user's location.\n * @param {number} latitude The latitude of the POI.\n * @param {number} longitude The longitude of the POI.\n * @param {string} zipcode The zip code of the POI.\n * @param {number} radius The radius of the POI.\n * @param {string} address The address of the POI.\n * @param {string} countrycode The countrycode of the POI.\n * @param {string} tags The tags for the POI.\n * @param {string} types The types of the POI.\n * @param {string} contact The contact for the POI.\n */\nclass Poi {\n  Jsondata: object;\n  City: string;\n  Idstore: string;\n  Name: string;\n  Date: number;\n  Distance: number;\n  Duration: number;\n  Latitude: number;\n  Locationid: number;\n  Longitude: number;\n  Zipcode: string;\n  Radius: number;\n  Countrycode: string;\n  Tags: string;\n  Types: string;\n  Contact: string;\n  Address: string;\n  constructor(\n    jsondata: object,\n    city: string,\n    idstore: string,\n    name: string,\n    date: number,\n    distance: number,\n    duration: number,\n    latitude: number,\n    locationid: number,\n    longitude: number,\n    zipcode: string,\n    radius: number,\n    address: string,\n    countrycode: string,\n    tags: string,\n    types: string,\n    contact: string\n  ) {\n    this.Jsondata = jsondata;\n    this.City = city;\n    this.Idstore = idstore;\n    this.Name = name;\n    this.Date = date;\n    this.Distance = distance;\n    this.Duration = duration;\n    this.Latitude = latitude;\n    this.Locationid = locationid;\n    this.Longitude = longitude;\n    this.Zipcode = zipcode;\n    this.Radius = radius;\n    this.Idstore = idstore;\n    this.Countrycode = countrycode;\n    this.Tags = tags;\n    this.Types = types;\n    this.Contact = contact;\n    this.Address = address;\n  }\n  /**\n   * Converts json object to an object of type Poi.\n   * @param {Object} json The json representation of the Poi.\n   * @returns Object\n   * @memberof Poi\n   */\n  static jsonToObj(json: any) {\n    return new Poi(\n      json.jsondata,\n      json.city,\n      json.idstore,\n      json.name,\n      json.date,\n      json.distance,\n      json.duration,\n      json.latitude,\n      json.locationid,\n      json.longitude,\n      json.zipcode,\n      json.radius,\n      json.address,\n      json.countrycode,\n      json.tags,\n      json.types,\n      json.contact\n    );\n  }\n}\nmodule.exports = Poi;\n"]}