Merge pull request #178 from radarlabs/start-tracking-verified

Add startTrackingVerified(), getVerifiedLocationToken(), and onTokenUpdated()
radarlabs · Aug 14, 2024 · 33a68b4 · 33a68b4
2 parents 481dabf + 56b5769
commit 33a68b4
Show file tree

Hide file tree

Showing 8 changed files with 131 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ Radar.initialize('prj_test_pk_...', { /* options */ });
 
 Add the following script in your `html` file
 ```html
-<script src="https://js.radar.com/v4.3.5-beta.0/radar.min.js"></script>
+<script src="https://js.radar.com/v4.3.5/radar.min.js"></script>
 ```
 
 Then initialize the Radar SDK
@@ -73,8 +73,8 @@ To create a map, first initialize the Radar SDK with your publishable key. Then
 ```html
 <html>
   <head>
-    <link href="https://js.radar.com/v4.3.5-beta.0/radar.css" rel="stylesheet">
-    <script src="https://js.radar.com/v4.3.5-beta.0/radar.min.js"></script>
+    <link href="https://js.radar.com/v4.3.5/radar.css" rel="stylesheet">
+    <script src="https://js.radar.com/v4.3.5/radar.min.js"></script>
   </head>
 
   <body>
@@ -98,8 +98,8 @@ To create an autocomplete input, first initialize the Radar SDK with your publis
 ```html
 <html>
   <head>
-    <link href="https://js.radar.com/v4.3.5-beta.0/radar.css" rel="stylesheet">
-    <script src="https://js.radar.com/v4.3.5-beta.0/radar.min.js"></script>
+    <link href="https://js.radar.com/v4.3.5/radar.css" rel="stylesheet">
+    <script src="https://js.radar.com/v4.3.5/radar.min.js"></script>
   </head>
 
   <body>
@@ -130,8 +130,8 @@ To power [geofencing](https://radar.com/documentation/geofencing/overview) exper
 ```html
 <html>
   <head>
-    <link href="https://js.radar.com/v4.3.5-beta.0/radar.css" rel="stylesheet">
-    <script src="https://js.radar.com/v4.3.5-beta.0/radar.min.js"></script>
+    <link href="https://js.radar.com/v4.3.5/radar.css" rel="stylesheet">
+    <script src="https://js.radar.com/v4.3.5/radar.min.js"></script>
   </head>
 
   <body>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "radar-sdk-js",
-  "version": "4.3.5-beta.0",
+  "version": "4.3.5",
   "description": "Web Javascript SDK for Radar, location infrastructure for mobile and web apps.",
   "homepage": "https://radar.com",
   "type": "module",

diff --git a/src/api/track.ts b/src/api/track.ts
@@ -162,14 +162,10 @@ class TrackAPI {
         };
       }
 
-      let { user, events, token, expiresAt } = response;
+      let { user, events, token, expiresAt, expiresIn, passed, failureReasons, _id } = response;
       const location = { latitude, longitude, accuracy };
-      let passed;
-      let expiresIn;
       if (expiresAt) {
         expiresAt = new Date(expiresAt);
-        passed = user?.fraud?.passed && user?.country?.passed && user?.state?.passed;
-        expiresIn = (expiresAt.getTime() - Date.now()) / 1000;
       }
 
       const trackRes = {
@@ -180,6 +176,8 @@ class TrackAPI {
         expiresAt,
         expiresIn,
         passed,
+        failureReasons,
+        _id,
       } as RadarTrackVerifiedResponse;
 
       if (options.debug) {

diff --git a/src/api/verify.ts b/src/api/verify.ts
@@ -6,7 +6,14 @@ import Logger from '../logger';
 import Session from '../session';
 import Storage from '../storage';
 
-import type { RadarTrackParams, RadarTrackVerifiedResponse } from '../types';
+import type { RadarStartTrackingVerifiedParams, RadarTrackParams, RadarTrackVerifiedResponse } from '../types';
+
+let tokenTimeoutId: any | null = null;
+let tokenCallback: ((token: RadarTrackVerifiedResponse) => void) | null = null;
+let lastToken: RadarTrackVerifiedResponse | null = null;
+let lastTokenNow: number = 0;
+let expectedCountryCode: string | null = null;
+let expectedStateCode: string | null = null;
 
 class VerifyAPI {
   static async trackVerified(params: RadarTrackParams, encrypted: Boolean = false) {
@@ -41,6 +48,8 @@ class VerifyAPI {
       stopped: true,
       userId,
       encrypted,
+      expectedCountryCode,
+      expectedStateCode,
     };
 
     let userAgent = navigator.userAgent;
@@ -53,7 +62,7 @@ class VerifyAPI {
       host: apple ? 'https://radar-verify.com:52516' : 'http://localhost:52516',
     });
 
-    let { user, events, token, expiresAt } = response;
+    let { user, events, token, expiresAt, expiresIn, passed, failureReasons, _id } = response;
     let location;
     if (user && user.location && user.location.coordinates && user.locationAccuracy) {
       location = {
@@ -62,12 +71,8 @@ class VerifyAPI {
         accuracy: user.locationAccuracy,
       };
     }
-    let passed;
-    let expiresIn;
     if (expiresAt) {
       expiresAt = new Date(expiresAt);
-      passed = user?.fraud?.passed && user?.country?.passed && user?.state?.passed;
-      expiresIn = (expiresAt.getTime() - Date.now()) / 1000;
     }
 
     const trackRes = {
@@ -78,14 +83,86 @@ class VerifyAPI {
       expiresAt,
       expiresIn,
       passed,
+      failureReasons,
+      _id,
     } as RadarTrackVerifiedResponse;
 
     if (options.debug) {
       trackRes.response = response;
     }
 
+    lastToken = trackRes;
+    lastTokenNow = performance.now();
+
+    if (tokenCallback) {
+      tokenCallback(trackRes);
+    }
+
     return trackRes;
   }
+
+  static async startTrackingVerified(params: RadarStartTrackingVerifiedParams) {
+    const doTrackVerified = async () => {
+      const trackRes = await this.trackVerified({});
+
+      const { interval } = params;
+
+      let expiresIn = 0;
+      let minInterval = interval;
+
+      if (trackRes) {
+        expiresIn = (trackRes.expiresIn || expiresIn);
+
+        // if expiresIn is shorter than interval, override interval
+        minInterval = Math.min(expiresIn, interval);
+      }
+
+      // re-request early to maximize the likelihood that a cached token is available
+      if (minInterval > 20) {
+        minInterval = minInterval - 10;
+      }
+
+      // min interval is 10 seconds
+      if (minInterval < 10) {
+        minInterval = 10;
+      }
+
+      if (tokenTimeoutId) {
+        clearTimeout(tokenTimeoutId);
+      }
+
+      tokenTimeoutId = setTimeout(doTrackVerified, minInterval * 1000);
+    };
+
+    doTrackVerified();
+  }
+
+  static stopTrackingVerified() {
+    if (tokenTimeoutId) {
+      clearTimeout(tokenTimeoutId);
+    }
+  }
+
+  static async getVerifiedLocationToken() {
+    const lastTokenElapsed = (performance.now() - lastTokenNow) / 1000;
+
+    if (lastToken) {
+      if (lastTokenElapsed < (lastToken.expiresIn || 0)) {
+        return lastToken;
+      }
+    }
+
+    return this.trackVerified({});
+  }
+
+  static setExpectedJurisdiction(countryCode?: string, stateCode?: string) {
+    expectedCountryCode = countryCode || null;
+    expectedStateCode = stateCode || null;
+  }
+
+  static onTokenUpdated(callback: (token: RadarTrackVerifiedResponse) => void) {
+    tokenCallback = callback;
+  }
 }
 
 export default VerifyAPI;
diff --git a/src/index.ts b/src/index.ts
@@ -32,7 +32,9 @@ import type {
   RadarReverseGeocodeParams,
   RadarSearchGeofencesParams,
   RadarSearchPlacesParams,
+  RadarStartTrackingVerifiedParams,
   RadarTrackParams,
+  RadarTrackVerifiedResponse,
   RadarTripOptions,
   RadarValidateAddressParams,
 } from './types';
@@ -105,7 +107,7 @@ class Radar {
   }
 
   ///////////////////////
-  // geofencing platform
+  // Geofencing Platform
   ///////////////////////
 
   public static setUserId(userId?: string) {
@@ -148,6 +150,22 @@ class Radar {
     return VerifyAPI.trackVerified(params);
   }
 
+  public static startTrackingVerified(params: RadarStartTrackingVerifiedParams) {
+    return VerifyAPI.startTrackingVerified(params);
+  }
+
+  public static stopTrackingVerified() {
+    return VerifyAPI.stopTrackingVerified();
+  }
+
+  public static getVerifiedLocationToken() {
+    return VerifyAPI.getVerifiedLocationToken();
+  }
+
+  public static setExpectedJurisdiction(countryCode?: string, stateCode?: string) {
+    VerifyAPI.setExpectedJurisdiction(countryCode, stateCode);
+  }
+
   public static getContext(params: Location) {
     return ContextAPI.getContext(params);
   }
@@ -184,10 +202,16 @@ class Radar {
     return ConversionsAPI.logConversion(params);
   }
 
+  ///////////////////////
+  // listeners
+  ///////////////////////
+  public static onTokenUpdated(callback: (token: RadarTrackVerifiedResponse) => void) {
+    VerifyAPI.onTokenUpdated(callback);
+  }
 
-  /////////////////
-  // maps platform
-  /////////////////
+  ///////////////////////
+  // Maps Platform
+  ///////////////////////
 
   public static forwardGeocode(params: RadarForwardGeocodeParams) {
     return GeocodingAPI.forwardGeocode(params);

diff --git a/src/types.ts b/src/types.ts
@@ -76,6 +76,10 @@ export interface RadarTrackParams {
   fraud?: boolean;
 }
 
+export interface RadarStartTrackingVerifiedParams {
+  interval: number;
+}
+
 export enum RadarEventConfidence {
   none = 0,
   low = 1,
@@ -218,9 +222,11 @@ export interface RadarTrackVerifiedResponse extends RadarTrackResponse {
   expiresAt?: Date;
   expiresIn?: number;
   passed?: boolean;
+  failureReasons?: string[];
+  _id?: string;
 }
 
-export interface RadarContextResponse  extends RadarResponse {
+export interface RadarContextResponse extends RadarResponse {
   location?: Location;
   geofences?: RadarGeofence[];
   place?: RadarPlace;

diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export default '4.3.5-beta.0';
+export default '4.3.5';