radar-sdk-js 3.0.1 → 3.1.0-beta.10

package/README.md

@@ -12,6 +12,13 @@ See the Radar overview documentation [here](https://radar.io/documentation).
 
 Then, see the Radar web SDK documentation [here](https://radar.io/documentation/sdk/web).
 
+## Running locally
+
+1. Clone the repo
+2. `npm install`
+3. To run the SDK in a browser, run `npm run build && node demo/server.js`, which should open a tab in your browser of choice. Modify the `/src/index.html` file as needed
+4. To run tests, run `npm run test`
+
 ## Support
 
 Have questions? We're here to help! Email us at [support@radar.io](mailto:support@radar.io).

package/dist/index.js

@@ -520,6 +520,28 @@ var _export = function (options, source) {
   }
 };
 
+// `ToObject` abstract operation
+// https://tc39.github.io/ecma262/#sec-toobject
+var toObject = function (argument) {
+  return Object(requireObjectCoercible(argument));
+};
+
+// `Object.keys` method
+// https://tc39.github.io/ecma262/#sec-object.keys
+var objectKeys = Object.keys || function keys(O) {
+  return objectKeysInternal(O, enumBugKeys);
+};
+
+var FAILS_ON_PRIMITIVES = fails(function () { objectKeys(1); });
+
+// `Object.keys` method
+// https://tc39.github.io/ecma262/#sec-object.keys
+_export({ target: 'Object', stat: true, forced: FAILS_ON_PRIMITIVES }, {
+  keys: function keys(it) {
+    return objectKeys(toObject(it));
+  }
+});
+
 // a string of all valid unicode whitespaces
 // eslint-disable-next-line max-len
 var whitespaces = '\u0009\u000A\u000B\u000C\u000D\u0020\u00A0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200A\u202F\u205F\u3000\u2028\u2029\uFEFF';
@@ -645,18 +667,61 @@ function _createClass(Constructor, protoProps, staticProps) {
   return Constructor;
 }
 
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+
+  return obj;
+}
+
+function ownKeys$1(object, enumerableOnly) {
+  var keys = Object.keys(object);
+
+  if (Object.getOwnPropertySymbols) {
+    var symbols = Object.getOwnPropertySymbols(object);
+    if (enumerableOnly) symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    });
+    keys.push.apply(keys, symbols);
+  }
+
+  return keys;
+}
+
+function _objectSpread2(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = arguments[i] != null ? arguments[i] : {};
+
+    if (i % 2) {
+      ownKeys$1(Object(source), true).forEach(function (key) {
+        _defineProperty(target, key, source[key]);
+      });
+    } else if (Object.getOwnPropertyDescriptors) {
+      Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+      ownKeys$1(Object(source)).forEach(function (key) {
+        Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+      });
+    }
+  }
+
+  return target;
+}
+
 // `IsArray` abstract operation
 // https://tc39.github.io/ecma262/#sec-isarray
 var isArray = Array.isArray || function isArray(arg) {
   return classofRaw(arg) == 'Array';
 };
 
-// `ToObject` abstract operation
-// https://tc39.github.io/ecma262/#sec-toobject
-var toObject = function (argument) {
-  return Object(requireObjectCoercible(argument));
-};
-
 var createProperty = function (object, key, value) {
   var propertyKey = toPrimitive(key);
   if (propertyKey in object) objectDefineProperty.f(object, propertyKey, createPropertyDescriptor(0, value));
@@ -876,12 +941,6 @@ var arrayIteration = {
   findIndex: createMethod$2(6)
 };
 
-// `Object.keys` method
-// https://tc39.github.io/ecma262/#sec-object.keys
-var objectKeys = Object.keys || function keys(O) {
-  return objectKeysInternal(O, enumBugKeys);
-};
-
 // `Object.defineProperties` method
 // https://tc39.github.io/ecma262/#sec-object.defineproperties
 var objectDefineProperties = descriptors ? Object.defineProperties : function defineProperties(O, Properties) {
@@ -1537,7 +1596,8 @@ var Cookie = /*#__PURE__*/function () {
       var date = new Date();
       date.setFullYear(date.getFullYear() + 10);
       var expires = "expires=".concat(date.toGMTString());
-      document.cookie = "".concat(key, "=").concat(value, ";path=/;").concat(expires);
+      var sameSite = 'samesite=strict';
+      document.cookie = "".concat(key, "=").concat(value, ";path=/;").concat(sameSite, ";").concat(expires);
     } // delete cookie with {key}
 
   }, {
@@ -1560,6 +1620,11 @@ var Cookie = /*#__PURE__*/function () {
     get: function get() {
       return 'radar-deviceId';
     }
+  }, {
+    key: "DEVICE_TYPE",
+    get: function get() {
+      return 'radar-deviceType';
+    }
   }, {
     key: "METADATA",
     get: function get() {
@@ -1580,6 +1645,26 @@ var Cookie = /*#__PURE__*/function () {
     get: function get() {
       return 'radar-userId';
     }
+  }, {
+    key: "INSTALL_ID",
+    get: function get() {
+      return 'radar-installId';
+    }
+  }, {
+    key: "TRIP_OPTIONS",
+    get: function get() {
+      return 'radar-trip-options';
+    }
+  }, {
+    key: "CUSTOM_HEADERS",
+    get: function get() {
+      return 'radar-custom-headers';
+    }
+  }, {
+    key: "BASE_API_PATH",
+    get: function get() {
+      return 'radar-base-api-path';
+    }
   }]);
 
   return Cookie;
@@ -3189,16 +3274,6 @@ _export({ target: 'Array', proto: true, forced: !HAS_SPECIES_SUPPORT || !USES_TO
   }
 });
 
-var FAILS_ON_PRIMITIVES = fails(function () { objectKeys(1); });
-
-// `Object.keys` method
-// https://tc39.github.io/ecma262/#sec-object.keys
-_export({ target: 'Object', stat: true, forced: FAILS_ON_PRIMITIVES }, {
-  keys: function keys(it) {
-    return objectKeys(toObject(it));
-  }
-});
-
 // iterable DOM collections
 // flag - `iterable` interface - 'entries', 'keys', 'values', 'forEach' methods
 var domIterables = {
@@ -3263,7 +3338,7 @@ var API_HOST = /*#__PURE__*/function () {
   return API_HOST;
 }();
 
-var SDK_VERSION = '3.0.1';
+var SDK_VERSION = '3.1.0-beta.10';
 
 var Http = /*#__PURE__*/function () {
   function Http() {
@@ -3305,12 +3380,22 @@ var Http = /*#__PURE__*/function () {
         if (!publishableKey) {
           reject(STATUS.ERROR_PUBLISHABLE_KEY);
           return;
-        }
+        } // set headers
+
 
         xhr.setRequestHeader('Authorization', publishableKey);
         xhr.setRequestHeader('Content-Type', 'application/json');
         xhr.setRequestHeader('X-Radar-Device-Type', 'Web');
-        xhr.setRequestHeader('X-Radar-SDK-Version', SDK_VERSION);
+        xhr.setRequestHeader('X-Radar-SDK-Version', SDK_VERSION); // set custom headers if present
+
+        var customHeaders = Cookie.getCookie(Cookie.CUSTOM_HEADERS);
+
+        if (customHeaders) {
+          var headers = JSON.parse(customHeaders);
+          Object.keys(headers).forEach(function (header) {
+            xhr.setRequestHeader(header, headers[header]);
+          });
+        }
 
         xhr.onload = function () {
           var response;
@@ -3654,6 +3739,86 @@ var Routing = /*#__PURE__*/function () {
   return Routing;
 }();
 
+var Matrix = /*#__PURE__*/function () {
+  function Matrix() {
+    _classCallCheck(this, Matrix);
+  }
+
+  _createClass(Matrix, null, [{
+    key: "getMatrixDistances",
+    value: function () {
+      var _getMatrixDistances = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+        var routingOptions,
+            _yield$Navigator$getC,
+            latitude,
+            longitude,
+            origins,
+            destinations,
+            mode,
+            units,
+            params,
+            _args = arguments;
+
+        return regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                routingOptions = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+
+                if (routingOptions.origins) {
+                  _context.next = 8;
+                  break;
+                }
+
+                _context.next = 4;
+                return Navigator.getCurrentPosition();
+
+              case 4:
+                _yield$Navigator$getC = _context.sent;
+                latitude = _yield$Navigator$getC.latitude;
+                longitude = _yield$Navigator$getC.longitude;
+                routingOptions.origins = [{
+                  latitude: latitude,
+                  longitude: longitude
+                }];
+
+              case 8:
+                origins = routingOptions.origins, destinations = routingOptions.destinations, mode = routingOptions.mode, units = routingOptions.units;
+                origins = origins || [];
+                origins = origins.map(function (origin) {
+                  return "".concat(origin.latitude, ", ").concat(origin.longitude);
+                }).join('|');
+                destinations = destinations || [];
+                destinations.map(function (destination) {
+                  return "".concat(destination.latitude, ", ").concat(destination.longitude);
+                }).join('|');
+                params = {
+                  origins: origins,
+                  destinations: destinations,
+                  mode: mode,
+                  units: units
+                };
+                return _context.abrupt("return", Http.request('GET', 'v1/route/matrix', params));
+
+              case 15:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee);
+      }));
+
+      function getMatrixDistances() {
+        return _getMatrixDistances.apply(this, arguments);
+      }
+
+      return getMatrixDistances;
+    }()
+  }]);
+
+  return Matrix;
+}();
+
 var Search = /*#__PURE__*/function () {
   function Search() {
     _classCallCheck(this, Search);
@@ -4058,40 +4223,49 @@ var Track = /*#__PURE__*/function () {
     key: "trackOnce",
     value: function () {
       var _trackOnce = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
-        var location,
-            _location,
+        var params,
             latitude,
             longitude,
             accuracy,
+            deviceLocation,
             deviceId,
             userId,
+            installId,
+            deviceType,
             description,
             metadata,
+            tripOptions,
             body,
+            basePath,
+            trackEndpoint,
             response,
             _args = arguments;
-
         return regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
-                location = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+                params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+                latitude = params.latitude, longitude = params.longitude, accuracy = params.accuracy;
 
-                if (!(!location.latitude || !location.longitude)) {
-                  _context.next = 5;
+                if (!(!latitude || !longitude)) {
+                  _context.next = 9;
                   break;
                 }
 
-                _context.next = 4;
+                _context.next = 5;
                 return Navigator.getCurrentPosition();
 
-              case 4:
-                location = _context.sent;
-
               case 5:
-                _location = location, latitude = _location.latitude, longitude = _location.longitude, accuracy = _location.accuracy;
+                deviceLocation = _context.sent;
+                latitude = deviceLocation.latitude;
+                longitude = deviceLocation.longitude;
+                accuracy = deviceLocation.accuracy;
+
+              case 9:
                 deviceId = Device.getId();
                 userId = Cookie.getCookie(Cookie.USER_ID);
+                installId = Cookie.getCookie(Cookie.INSTALL_ID) || deviceId;
+                deviceType = Cookie.getCookie(Cookie.DEVICE_TYPE) || 'Web';
                 description = Cookie.getCookie(Cookie.DESCRIPTION);
                 metadata = Cookie.getCookie(Cookie.METADATA);
 
@@ -4099,29 +4273,42 @@ var Track = /*#__PURE__*/function () {
                   metadata = JSON.parse(metadata);
                 }
 
-                body = {
+                tripOptions = Cookie.getCookie(Cookie.TRIP_OPTIONS);
+
+                if (tripOptions) {
+                  tripOptions = JSON.parse(tripOptions);
+                }
+
+                body = _objectSpread2({}, params, {
                   accuracy: accuracy,
                   description: description,
                   deviceId: deviceId,
-                  deviceType: 'Web',
+                  deviceType: deviceType,
                   foreground: true,
-                  installId: deviceId,
+                  installId: installId,
                   latitude: latitude,
                   longitude: longitude,
                   metadata: metadata,
                   sdkVersion: SDK_VERSION,
                   stopped: true,
-                  userId: userId
-                };
-                _context.next = 14;
-                return Http.request('POST', "v1/track", body);
-
-              case 14:
+                  userId: userId,
+                  tripOptions: tripOptions
+                });
+                basePath = Cookie.getCookie(Cookie.BASE_API_PATH) || 'v1';
+                trackEndpoint = "".concat(basePath, "/track");
+                _context.next = 23;
+                return Http.request('POST', trackEndpoint, body);
+
+              case 23:
                 response = _context.sent;
-                response.location = location;
+                response.location = {
+                  latitude: latitude,
+                  longitude: longitude,
+                  accuracy: accuracy
+                };
                 return _context.abrupt("return", response);
 
-              case 17:
+              case 26:
               case "end":
                 return _context.stop();
             }
@@ -4140,6 +4327,72 @@ var Track = /*#__PURE__*/function () {
   return Track;
 }();
 
+var Trips = /*#__PURE__*/function () {
+  function Trips() {
+    _classCallCheck(this, Trips);
+  }
+
+  _createClass(Trips, null, [{
+    key: "updateTrip",
+    value: function () {
+      var _updateTrip = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+        var tripOptions,
+            status,
+            externalId,
+            destinationGeofenceTag,
+            destinationGeofenceExternalId,
+            mode,
+            metadata,
+            params,
+            basePath,
+            _args = arguments;
+        return regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                tripOptions = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+                status = _args.length > 1 ? _args[1] : undefined;
+                externalId = tripOptions.externalId, destinationGeofenceTag = tripOptions.destinationGeofenceTag, destinationGeofenceExternalId = tripOptions.destinationGeofenceExternalId, mode = tripOptions.mode, metadata = tripOptions.metadata;
+                params = {
+                  externalId: externalId,
+                  status: status,
+                  destinationGeofenceTag: destinationGeofenceTag,
+                  destinationGeofenceExternalId: destinationGeofenceExternalId,
+                  mode: mode,
+                  metadata: metadata
+                };
+                basePath = Cookie.getCookie(Cookie.BASE_API_PATH) || 'v1';
+                return _context.abrupt("return", Http.request('PATCH', "".concat(basePath, "/trips/").concat(externalId), params));
+
+              case 6:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee);
+      }));
+
+      function updateTrip() {
+        return _updateTrip.apply(this, arguments);
+      }
+
+      return updateTrip;
+    }()
+  }]);
+
+  return Trips;
+}();
+
+var TRIP_STATUS = {
+  STARTED: "started",
+  APPROACHING: "approaching",
+  ARRIVED: "arrived",
+  COMPLETED: "completed",
+  EXPIRED: "expired",
+  CANCELED: "canceled",
+  UNKNOWN: undefined
+};
+
 var defaultCallback = function defaultCallback() {};
 
 var handleError = function handleError(callback) {
@@ -4177,8 +4430,9 @@ var Radar = /*#__PURE__*/function () {
     }
   }, {
     key: "setHost",
-    value: function setHost(host) {
+    value: function setHost(host, baseApiPath) {
       Cookie.setCookie(Cookie.HOST, host, true);
+      Cookie.setCookie(Cookie.BASE_API_PATH, baseApiPath);
     }
   }, {
     key: "setUserId",
@@ -4190,6 +4444,21 @@ var Radar = /*#__PURE__*/function () {
 
       Cookie.setCookie(Cookie.USER_ID, String(userId).trim());
     }
+  }, {
+    key: "setDeviceId",
+    value: function setDeviceId(deviceId, installId) {
+      if (deviceId) {
+        Cookie.setCookie(Cookie.DEVICE_ID, String(deviceId).trim());
+      } else {
+        Cookie.deleteCookie(Cookie.DEVICE_ID);
+      }
+
+      if (installId) {
+        Cookie.setCookie(Cookie.INSTALL_ID, String(installId).trim());
+      } else {
+        Cookie.deleteCookie(Cookie.INSTALL_ID);
+      }
+    }
   }, {
     key: "setDescription",
     value: function setDescription(description) {
@@ -4210,6 +4479,18 @@ var Radar = /*#__PURE__*/function () {
 
       Cookie.setCookie(Cookie.METADATA, JSON.stringify(metadata));
     }
+  }, {
+    key: "setRequestHeaders",
+    value: function setRequestHeaders() {
+      var headers = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+
+      if (!Object.keys(headers).length) {
+        Cookie.deleteCookie(Cookie.CUSTOM_HEADERS);
+        return;
+      }
+
+      Cookie.setCookie(Cookie.CUSTOM_HEADERS, JSON.stringify(headers));
+    }
   }, {
     key: "getLocation",
     value: function getLocation() {
@@ -4265,6 +4546,74 @@ var Radar = /*#__PURE__*/function () {
         }, response);
       }).catch(handleError(callback));
     }
+  }, {
+    key: "startTrip",
+    value: function startTrip(tripOptions) {
+      var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultCallback;
+      Trips.updateTrip(tripOptions, TRIP_STATUS.STARTED).then(function (response) {
+        Cookie.setCookie(Cookie.TRIP_OPTIONS, JSON.stringify(tripOptions));
+        callback(null, {
+          trip: response.trip,
+          events: response.events,
+          status: STATUS.SUCCESS
+        }, response);
+      }).catch(handleError(callback));
+    }
+  }, {
+    key: "updateTrip",
+    value: function updateTrip(tripOptions, status) {
+      var callback = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : defaultCallback;
+      Trips.updateTrip(tripOptions, status).then(function (response) {
+        // set cookie
+        Cookie.setCookie(Cookie.TRIP_OPTIONS, JSON.stringify(tripOptions));
+        callback(null, {
+          trip: response.trip,
+          events: response.events,
+          status: STATUS.SUCCESS
+        }, response);
+      }).catch(handleError(callback));
+    }
+  }, {
+    key: "completeTrip",
+    value: function completeTrip() {
+      var callback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultCallback;
+      var tripOptions = Radar.getTripOptions();
+      Trips.updateTrip(tripOptions, TRIP_STATUS.COMPLETED).then(function (response) {
+        // clear tripOptions
+        Cookie.deleteCookie(Cookie.TRIP_OPTIONS);
+        callback(null, {
+          trip: response.trip,
+          events: response.events,
+          status: STATUS.SUCCESS
+        }, response);
+      }).catch(handleError(callback));
+    }
+  }, {
+    key: "cancelTrip",
+    value: function cancelTrip() {
+      var callback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultCallback;
+      var tripOptions = Radar.getTripOptions();
+      Trips.updateTrip(tripOptions, TRIP_STATUS.CANCELED).then(function (response) {
+        // clear tripOptions
+        Cookie.deleteCookie(Cookie.TRIP_OPTIONS);
+        callback(null, {
+          trip: response.trip,
+          events: response.events,
+          status: STATUS.SUCCESS
+        }, response);
+      }).catch(handleError(callback));
+    }
+  }, {
+    key: "getTripOptions",
+    value: function getTripOptions() {
+      var tripOptions = Cookie.getCookie(Cookie.TRIP_OPTIONS);
+
+      if (tripOptions) {
+        tripOptions = JSON.parse(tripOptions);
+      }
+
+      return tripOptions;
+    }
   }, {
     key: "searchPlaces",
     value: function searchPlaces(searchOptions) {
@@ -4362,6 +4711,17 @@ var Radar = /*#__PURE__*/function () {
         }, response);
       }).catch(handleError(callback));
     }
+  }, {
+    key: "getMatrix",
+    value: function getMatrix(routingOptions) {
+      var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultCallback;
+      Matrix.getMatrixDistances(routingOptions).then(function (response) {
+        callback(null, {
+          routes: response.routes,
+          status: STATUS.SUCCESS
+        }, response);
+      }).catch(handleError(callback));
+    }
   }, {
     key: "VERSION",
     get: function get() {