@woosmap/react-native-plugin-geofencing 0.1.2

package/package.json

@@ -0,0 +1,150 @@
+{
+  "name": "@woosmap/react-native-plugin-geofencing",
+  "version": "0.1.2",
+  "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",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "react-native-plugin-geofencing.podspec",
+    "!lib/typescript/example",
+    "!android/build",
+    "!ios/build",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc --noEmit",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "prepare": "bob build",
+    "release": "release-it",
+    "example": "yarn --cwd example",
+    "pods": "cd example && pod-install --quiet",
+    "bootstrap": "yarn example && yarn && yarn pods"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": "https://github.com/Woosmap/woosmap-geofencing-react-native-plugin",
+  "author": "WGS Indoor <28100769+sameerdhulap@users.noreply.github.com> (https://github.com/sameerdhulap)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Woosmap/woosmap-geofencing-react-native-plugin/issues"
+  },
+  "homepage": "https://github.com/Woosmap/woosmap-geofencing-react-native-plugin#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^11.0.0",
+    "@react-native-community/eslint-config": "^2.0.0",
+    "@release-it/conventional-changelog": "^2.0.0",
+    "@types/jest": "^26.0.0",
+    "@types/react": "^16.9.19",
+    "@types/react-native": "0.62.13",
+    "commitlint": "^11.0.0",
+    "eslint": "^7.2.0",
+    "eslint-config-prettier": "^7.0.0",
+    "eslint-plugin-prettier": "^3.1.3",
+    "husky": "^6.0.0",
+    "jest": "^26.0.1",
+    "pod-install": "^0.1.0",
+    "prettier": "^2.0.5",
+    "react": "16.13.1",
+    "react-native": "^0.68.1",
+    "react-native-builder-bob": "^0.18.0",
+    "release-it": "^14.2.2",
+    "typescript": "^4.1.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native-community",
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "dependencies": {
+    "react-native-uuid": "^2.0.1"
+  }
+}

package/react-native-plugin-geofencing.podspec

@@ -0,0 +1,20 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-plugin-geofencing"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "12.0" }
+  s.source       = { :git => "https://github.com/Woosmap/woosmap-geofencing-react-native-plugin.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+
+  s.dependency "React-Core"
+  s.dependency "WoosmapGeofencing"
+end

package/src/Airship.tsx

@@ -0,0 +1,24 @@
+/**
+ * @classdesc A class that represents the Airship object.
+ * @constructs Airship
+ * @param {string} name The name of the custom event.
+ * @param {string} properties The attributes of the POI such as `name`, `address`, `zipCode` etc.
+ */
+class Airship {
+  Name: String;
+  Properties: String;
+  constructor(name: String, properties: String) {
+    this.Name = name;
+    this.Properties = properties;
+  }
+  /**
+   * Converts json object to an object of type Airship.
+   * @param {Object} json The json representation of Airship.
+   * @returns Object
+   * @memberof Airship
+   */
+  static jsonToObj(json: any) {
+    return new Airship(json.name, json.properties);
+  }
+}
+module.exports = Airship;

package/src/Location.tsx

@@ -0,0 +1,46 @@
+/**
+ * @classdesc A class that represents the location object.
+ * @constructs Location
+ * @param {number} date The datetime stamp.
+ * @param {number} latitude The latitude of the location.
+
+ * @param {string} Locationdescription The description of the location. 
+ * @param {string} Locationid A unique identifier for the location.
+ * @param {number} longitude The longitude of the location.
+ */
+class Location {
+  Date: number;
+  Latitude: number;
+  Locationdescription: string;
+  Locationid: string;
+  Longitude: number;
+  constructor(
+    date: number,
+    latitude: number,
+    locationdescription: string,
+    locationid: string,
+    longitude: number
+  ) {
+    this.Date = date;
+    this.Latitude = latitude;
+    this.Locationdescription = locationdescription;
+    this.Locationid = locationid;
+    this.Longitude = longitude;
+  }
+  /**
+   * Converts json object to an object of type Location.
+   * @param {Object} json The json representation of the Location.
+   * @returns Object
+   * @memberof Location
+   */
+  static jsonToObj(json: any) {
+    return new Location(
+      json.date,
+      json.latitude,
+      json.locationdescription,
+      json.locationid,
+      json.longitude
+    );
+  }
+}
+export default Location;

package/src/MarketingCloud.tsx

@@ -0,0 +1,24 @@
+/**
+ * @classdesc A class that represents the Marketing Cloud object.
+ * @constructs MarketingCloud
+ * @param {string} name The name of the custom event.
+ * @param {string} properties The attributes of the POI such as `name`, `address`, `zipCode` etc.
+ */
+class MarketingCloud {
+  Name: string;
+  Properties: string;
+  constructor(name: string, properties: string) {
+    this.Name = name;
+    this.Properties = properties;
+  }
+  /**
+   * Converts json object to an object of type MarketingCloud.
+   * @param {Object} json The json representation of MarketingCloud.
+   * @returns Object
+   * @memberof MarketingCloud
+   */
+  static jsonToObj(json: any) {
+    return new MarketingCloud(json.name, json.properties);
+  }
+}
+module.exports = MarketingCloud;

package/src/Poi.tsx

@@ -0,0 +1,106 @@
+/**
+ * A class that represents the POI object.
+ * @classdesc A class that represents the POI object.
+ * @constructs Poi
+ * @param {Object} jsonData A json object representing the POI.
+ * @param {string} city The name of the city the POI belongs to.
+ * @param {string} idstore A unique identifier for the POI.
+ * @param {name} name The name of the POI.
+ * @param {number} date The datetime stamp.
+ * @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 {number} longitude The longitude of the POI.
+ * @param {string} zipcode The zip code of the POI.
+ * @param {number} radius The radius of the POI.
+ * @param {string} address The address of the POI.
+ * @param {string} countrycode The countrycode of the POI.
+ * @param {string} tags The tags for the POI.
+ * @param {string} types The types of the POI.
+ * @param {string} contact The contact for the POI.
+ */
+class Poi {
+  Jsondata: object;
+  City: string;
+  Idstore: string;
+  Name: string;
+  Date: number;
+  Distance: number;
+  Duration: number;
+  Latitude: number;
+  Locationid: number;
+  Longitude: number;
+  Zipcode: string;
+  Radius: number;
+  Countrycode: string;
+  Tags: string;
+  Types: string;
+  Contact: string;
+  Address: string;
+  constructor(
+    jsondata: object,
+    city: string,
+    idstore: string,
+    name: string,
+    date: number,
+    distance: number,
+    duration: number,
+    latitude: number,
+    locationid: number,
+    longitude: number,
+    zipcode: string,
+    radius: number,
+    address: string,
+    countrycode: string,
+    tags: string,
+    types: string,
+    contact: string
+  ) {
+    this.Jsondata = jsondata;
+    this.City = city;
+    this.Idstore = idstore;
+    this.Name = name;
+    this.Date = date;
+    this.Distance = distance;
+    this.Duration = duration;
+    this.Latitude = latitude;
+    this.Locationid = locationid;
+    this.Longitude = longitude;
+    this.Zipcode = zipcode;
+    this.Radius = radius;
+    this.Idstore = idstore;
+    this.Countrycode = countrycode;
+    this.Tags = tags;
+    this.Types = types;
+    this.Contact = contact;
+    this.Address = address;
+  }
+  /**
+   * Converts json object to an object of type Poi.
+   * @param {Object} json The json representation of the Poi.
+   * @returns Object
+   * @memberof Poi
+   */
+  static jsonToObj(json: any) {
+    return new Poi(
+      json.jsondata,
+      json.city,
+      json.idstore,
+      json.name,
+      json.date,
+      json.distance,
+      json.duration,
+      json.latitude,
+      json.locationid,
+      json.longitude,
+      json.zipcode,
+      json.radius,
+      json.address,
+      json.countrycode,
+      json.tags,
+      json.types,
+      json.contact
+    );
+  }
+}
+module.exports = Poi;

package/src/Region.tsx

@@ -0,0 +1,56 @@
+/**
+ * A class that represents the Region object.
+ * @classdesc A class that represents the Region object.
+ * @constructs Region
+ * @param {number} date The datetime stamp.
+ * @param {boolean} didEnter A boolean value indicating whether the region was entered.
+ * @param {string} identifier An alphanumeric unique identifier for the region.
+ * @param {number} latitude The latitude of the region.
+ * @param {number} longitude The longitude of the region.
+ * @param {number} radius The radius of the region in meters.
+ * @param {boolean} frompositiondetection Determines whether the user's cuurent position is inside the region.
+ */
+class Region {
+  Date: number;
+  Didenter: boolean;
+  Identifier: string;
+  Latitude: number;
+  Longitude: number;
+  Radius: number;
+  Frompositiondetection: boolean;
+  constructor(
+    date: number,
+    didenter: boolean,
+    identifier: string,
+    latitude: number,
+    longitude: number,
+    radius: number,
+    frompositiondetection: boolean
+  ) {
+    this.Date = date;
+    this.Didenter = didenter;
+    this.Identifier = identifier;
+    this.Latitude = latitude;
+    this.Longitude = longitude;
+    this.Radius = radius;
+    this.Frompositiondetection = frompositiondetection;
+  }
+  /**
+   * Converts json object to an object of type Region.
+   * @param {Object} json The json representation of the region.
+   * @returns Object
+   * @memberof Region
+   */
+  static jsonToObj(json: any) {
+    return new Region(
+      json.date,
+      json.didenter,
+      json.identifier,
+      json.latitude,
+      json.longitude,
+      json.radius,
+      json.frompositiondetection
+    );
+  }
+}
+export default Region;

package/src/Visit.tsx

@@ -0,0 +1,49 @@
+/**
+ * @classdesc A class that represents the visits object.
+ * @constructs Visit
+ * @param {number} accuracy The accuracy in meters.
+ * @param {number} arrivalDate The datetime stamp for the arrival at the place of visit.
+ * @param {number} date Current datetime stamp.
+ * @param {number} latitude The latitude of the place of visit.
+ * @param {number} longitude The longitude of the plaee of visit.
+ */
+class Visit {
+  Accuracy: number;
+  Arrivaldate: number;
+  Date: number;
+  Departuredate: number;
+  Latitude: number;
+  Longitude: number;
+  constructor(
+    accuracy: number,
+    arrivaldate: number,
+    date: number,
+    departuredate: number,
+    latitude: number,
+    longitude: number
+  ) {
+    this.Accuracy = accuracy;
+    this.Arrivaldate = arrivaldate;
+    this.Date = date;
+    this.Departuredate = departuredate;
+    this.Latitude = latitude;
+    this.Longitude = longitude;
+  }
+  /**
+   * Converts json object to an object of type Visits.
+   * @param {Object} json The json representation of the Visits.
+   * @returns Visit
+   * @memberof Visit
+   */
+  static jsonToObj(json: any): Visit {
+    return new Visit(
+      json.accuracy,
+      json.arrivaldate,
+      json.date,
+      json.departuredate,
+      json.latitude,
+      json.longitude
+    );
+  }
+}
+module.exports = Visit;

package/src/Zoi.tsx

@@ -0,0 +1,107 @@
+/**
+ * @classdesc A class that represents the Zones of Interest (ZOI) object.
+ * @constructs Zoi
+ * @param {number} accumulator Represents the number of visits used to build the ZOI (only for calculation of ZOI)
+ * @param {number} age Age is used to determine if a ZOI should be deleted by the algorithm (only for calculation of ZOI)
+ * @param {number} covariance_det The covariance determinant (only for calculation of ZOI)
+ * @param {number} duration The duration of all the accumulated visits of the ZOI
+ * @param {number} endtime The exit date of the last ZOI visit
+ * @param {string[]} idvisits The list of id visits included in this ZOI
+ * @param {number} latmean The latitude of the center of the ZOI
+ * @param {number} lngmean The longitude of the center of the ZOI
+ * @param {string} period The classification of the period (HOME, WORK, OTHER or NO QUALIFIER)
+ * @param {number} prior_probability Estimation of probability (only for calculation of ZOI)
+ * @param {number} starttime The entry date for the first ZOI visit
+ * @param {number} weekly_density The weekly density of the ZOI visit (only for classification of ZOI)
+ * @param {string} wktpolygon This is the Well-known text representation of geometry of the ZOI polygon.
+ * @param {number} x00covariance_matrix_inverse The covariance of a cluster (only for calculation of ZOI)
+ * @param {number} x01covariance_matrix_inverse The covariance of a cluster (only for calculation of ZOI)
+ * @param {number} x10covariance_matrix_inverse The covariance of a cluster (only for calculation of ZOI)
+ * @param {number} x11covariance_matrix_inverse The covariance of a cluster (only for calculation of ZOI)
+
+ */
+class Zoi {
+  Accumulator: number;
+  Age: number;
+  Covariance_Det: number;
+  Duration: number;
+  Endtime: number;
+  Idvisits: string[];
+  Latmean: number;
+  Lngmean: number;
+  Period: string;
+  Prior_Probability: number;
+  Starttime: number;
+  Weekly_Density: number;
+  X00Covariance_Matrix_Inverse: number;
+  X01Covariance_Matrix_Inverse: number;
+  X10Covariance_Matrix_Inverse: number;
+  X11Covariance_Matrix_Inverse: number;
+  Wktpolygon: string;
+  constructor(
+    accumulator: number,
+    age: number,
+    covariance_det: number,
+    duration: number,
+    endtime: number,
+    idvisits: string[],
+    latmean: number,
+    lngmean: number,
+    period: string,
+    prior_probability: number,
+    starttime: number,
+    weekly_density: number,
+    wktpolygon: string,
+    x00covariance_matrix_inverse: number,
+    x01covariance_matrix_inverse: number,
+    x10covariance_matrix_inverse: number,
+    x11covariance_matrix_inverse: number
+  ) {
+    this.Accumulator = accumulator;
+    this.Age = age;
+    this.Covariance_Det = covariance_det;
+    this.Duration = duration;
+    this.Endtime = endtime;
+    this.Idvisits = idvisits;
+    this.Latmean = latmean;
+    this.Lngmean = lngmean;
+    this.Period = period;
+    this.Prior_Probability = prior_probability;
+    this.Starttime = starttime;
+    this.Weekly_Density = weekly_density;
+    this.Covariance_Det = covariance_det;
+    this.Wktpolygon = wktpolygon;
+    this.X00Covariance_Matrix_Inverse = x00covariance_matrix_inverse;
+    this.X01Covariance_Matrix_Inverse = x01covariance_matrix_inverse;
+    this.X10Covariance_Matrix_Inverse = x10covariance_matrix_inverse;
+    this.X11Covariance_Matrix_Inverse = x11covariance_matrix_inverse;
+  }
+  /**
+   * Converts json object to an object of type Zoi.
+   * @param {Object} json The json representation of the Zoi.
+   * @returns Object
+   * @memberof Zoi
+   */
+  static jsonToObj(json: any) {
+    return new Zoi(
+      json.accumulator,
+      json.age,
+      json.covariance_det,
+      json.duration,
+      json.endtime,
+      json.idvisits,
+      json.latmean,
+      json.lngmean,
+      json.period,
+      json.prior_probability,
+      json.starttime,
+      json.weekly_density,
+      json.wktpolygon,
+      json.x00covariance_matrix_inverse,
+      json.x01covariance_matrix_inverse,
+      json.x10covariance_matrix_inverse,
+      json.x11covariance_matrix_inverse
+    );
+  }
+}
+module.exports = Zoi;