rn-linkrunner 0.5.1 → 0.5.2

package/README.md

@@ -39,19 +39,43 @@ import linkrunner from 'rn-linkrunner';
 
 // Inside your react component
 useEffect(() => {
-  linkrunner.init('PROJECT_TOKEN');
+  init();
 }, []);
+
+const init = async () => {
+  const initData = await linkrunner.init('PROJECT_TOKEN');
+};
+```
+
+#### Response type for `linkrunner.init`
+
+```
+{
+  ip_location_data: {
+    ip: string;
+    city: string;
+    countryLong: string;
+    countryShort: string;
+    latitude: number;
+    longitude: number;
+    region: string;
+    timeZone: string;
+    zipCode: string;
+  };
+  deeplink: string;
+  root_domain: boolean;
+}
 ```
 
 ### Trigger
 
-Call this function once your onboarding is completed and the navigation stack can be accessed by a deep link:
+Call this function once your onboarding is completed and the navigation stack can be accessed by a deeplink:
 
 ```jsx
 import linkrunner from 'rn-linkrunner';
 
-const onTrigger = () => {
-  linkrunner.trigger({
+const onTrigger = async () => {
+  const trigger = await linkrunner.trigger({
     user_data: {
       id: '1',
       name: 'John Doe', // optional
@@ -63,7 +87,28 @@ const onTrigger = () => {
 };
 ```
 
-Both attributes in the `trigger` method are optional, although recommended.
+#### Response type for `linkrunner.trigger`
+
+```
+{
+  ip_location_data: {
+    ip: string;
+    city: string;
+    countryLong: string;
+    countryShort: string;
+    latitude: number;
+    longitude: number;
+    region: string;
+    timeZone: string;
+    zipCode: string;
+  };
+  deeplink: string;
+  root_domain: boolean;
+  trigger: boolean // Deeplink won't be triggered if false
+}
+```
+
+Note: Value of `trigger` will be only true for the first time the function is triggered by the user in order to prevent unnecessary redirects
 
 ### Facing issues during integration?
 

package/lib/commonjs/index.js

@@ -8,7 +8,7 @@ var _reactNative = require("react-native");
 var _reactNativeDeviceInfo = _interopRequireWildcard(require("react-native-device-info"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-const package_version = '0.5.1';
+const package_version = '0.5.2';
 const app_version = _reactNativeDeviceInfo.default.getVersion();
 const device_data = {
   android_id: _reactNativeDeviceInfo.default.getAndroidId(),

package/lib/module/index.js

@@ -1,6 +1,6 @@
 import { Linking } from 'react-native';
 import DeviceInfo, { getManufacturer, getSystemVersion } from 'react-native-device-info';
-const package_version = '0.5.1';
+const package_version = '0.5.2';
 const app_version = DeviceInfo.getVersion();
 const device_data = {
   android_id: DeviceInfo.getAndroidId(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rn-linkrunner",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "React Native Package for linkrunner",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/index.ts

@@ -4,7 +4,7 @@ import DeviceInfo, {
   getSystemVersion,
 } from 'react-native-device-info';
 
-const package_version = '0.5.1';
+const package_version = '0.5.2';
 const app_version: string = DeviceInfo.getVersion();
 
 const device_data = {