@opentripplanner/core-utils 13.0.0-alpha.1 → 13.0.0-alpha.3

package/esm/query.js

@@ -1,12 +1,8 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _typeof from "@babel/runtime/helpers/typeof";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-
-function ownKeys(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 _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { format, isMatch, parse } from "date-fns";
 import getGeocoder from "@opentripplanner/geocoder/lib";
 import qs from "qs";
@@ -14,14 +10,16 @@ import { getTransitModes, hasCar, isAccessMode } from "./itinerary";
 import { coordsToString, stringToCoords } from "./map";
 import queryParams from "./query-params";
 import { getCurrentTime, getCurrentDate, OTP_API_DATE_FORMAT, OTP_API_TIME_FORMAT } from "./time";
+
 /* The list of default parameters considered in the settings panel */
 
 export var defaultParams = ["wheelchair", "maxWalkDistance", "walkReluctance", "maxWalkTime", "maxBikeDistance", "maxBikeTime", "bikeSpeed", "optimize", "optimizeBike", "maxEScooterDistance", "watts"];
+
 /**
  * List of time formats to parse when reading query params.
  */
-
 var TIME_FORMATS = ["HH:mm:ss", "HH:mm", "H:mm", "h:mm:ss a", "h:mm:ssa", "h:mm a", "h:mma", "h:mm", "HHmm", "hmm", "ha"];
+
 /* A function to retrieve a property value from an entry in the query-params
  * table, checking for either a static value or a function */
 
@@ -32,26 +30,27 @@ export function ensureSingleAccessMode(queryModes) {
   // Count the number of access modes
   var accessCount = queryModes.filter(function (m) {
     return isAccessMode(m);
-  }).length; // If multiple access modes are specified, keep only the first one
+  }).length;
 
+  // If multiple access modes are specified, keep only the first one
   if (accessCount > 1) {
     var firstAccess = queryModes.find(function (m) {
       return isAccessMode(m);
     });
     queryModes = queryModes.filter(function (m) {
       return !isAccessMode(m) || m === firstAccess;
-    }); // If no access modes are specified, add 'WALK' as the default
+    });
+
+    // If no access modes are specified, add 'WALK' as the default
   } else if (accessCount === 0) {
     queryModes.push("WALK");
   }
-
   return queryModes;
 }
 export function getUrlParams() {
   if (window) {
     return qs.parse(window.location.href.split("?")[1]);
   }
-
   return undefined;
 }
 export function getOtpUrlParams() {
@@ -61,34 +60,29 @@ export function getOtpUrlParams() {
 }
 export function getTripOptionsFromQuery(query) {
   var keepPlace = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-
-  var options = _objectSpread({}, query); // Delete time/date options and from/to
-
-
+  var options = _objectSpread({}, query);
+  // Delete time/date options and from/to
   delete options.time;
   delete options.departArrive;
   delete options.date;
-
   if (!keepPlace) {
     delete options.from;
     delete options.to;
   }
-
   return options;
 }
+
 /**
  * Gets the query param's default value that is either a constant or by
  * executing the default value function.
  */
-
 function getDefaultQueryParamValue(param) {
   return typeof param["default"] === "function" ? param["default"]() : param["default"];
 }
+
 /**
  * Get the default query to OTP based on the given config.
  */
-
-
 export function getDefaultQuery() {
   var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
   var defaultQuery = {
@@ -99,21 +93,19 @@ export function getDefaultQuery() {
   }).forEach(function (qp) {
     defaultQuery[qp.name] = getDefaultQueryParamValue(qp);
   });
-
   if (config) {
     if (config.routingTypes && config.routingTypes.length > 0) {
       defaultQuery.routingType = config.routingTypes[0].key;
     }
-
     if (config.defaultQueryParams) {
       Object.keys(config.defaultQueryParams).forEach(function (key) {
         defaultQuery[key] = config.defaultQueryParams[key];
       });
     }
   }
-
   return defaultQuery;
 }
+
 /**
  * Determine if the specified query param applies to the given query (based on
  * routing type and the param's own applicable function).
@@ -122,47 +114,43 @@ export function getDefaultQuery() {
  * @param  config    OTP config
  * @return {Boolean}
  */
-
 function isParamApplicable(paramInfo, query, config) {
   var applicable = paramInfo.applicable,
-      routingTypes = paramInfo.routingTypes;
+    routingTypes = paramInfo.routingTypes;
   if (!routingTypes.includes(query.routingType)) return false;
-
   if (typeof applicable === "function" && !applicable(query, config)) {
     return false;
   }
-
   return true;
 }
+
 /**
  * Helper method which replaces OTP flex modes with single FLEX mode that's
  * more useful and easier to work with.
  */
-
-
 export function reduceOtpFlexModes(modes) {
   var enabled = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
   if (!enabled) return modes;
   return modes.reduce(function (prev, cur) {
-    var newModes = prev; // Add the current mode if it is not a flex mode
-
+    var newModes = prev;
+    // Add the current mode if it is not a flex mode
     if (!cur.includes("FLEX")) {
-      newModes.push(cur); // If it is a flex mode, do not add it but rather add the custom flex mode
+      newModes.push(cur);
+      // If it is a flex mode, do not add it but rather add the custom flex mode
       // if not already present
     } else if (!newModes.includes("FLEX")) {
       newModes.push("FLEX");
     }
-
     return newModes;
   }, []);
 }
+
 /**
  * Helper method to process a mode string, replacing all instances of FLEX
  * with the full set of FLEX modes used by otp-2
  * @param {*} mode a mode String, not an array
  * @returns a mode String, not an array (with flex modes expanded)
  */
-
 export function expandOtpFlexMode(mode) {
   var modes = reduceOtpFlexModes(mode.split(","));
   return modes.map(function (m) {
@@ -170,25 +158,21 @@ export function expandOtpFlexMode(mode) {
     if (m === "FLEX_EGRESS" || m === "FLEX_ACCESS" || m === "FLEX_DIRECT") {
       if (mode.includes("FLEX")) return "";
     }
-
     if (m === "FLEX") {
       return "FLEX_EGRESS,FLEX_ACCESS,FLEX_DIRECT";
     }
-
     return m;
   }).join(",");
 }
+
 /**
  * Determines whether the specified query differs from the default query, i.e.,
  * whether the user has modified any trip options (including mode) from their
  * default values.
  */
-
 export function isNotDefaultQuery(query, config) {
   var _config$modes;
-
   var activeModes = reduceOtpFlexModes(query.mode.split(",").sort(), (_config$modes = config.modes) === null || _config$modes === void 0 ? void 0 : _config$modes.mergeFlex);
-
   if (activeModes.length !== 2 || activeModes[0] !== "TRANSIT" || activeModes[1] !== "WALK") {
     // Default mode is TRANSIT,WALK. If general TRANSIT is not used, check
     // against available transit modes in config.
@@ -197,33 +181,30 @@ export function isNotDefaultQuery(query, config) {
       return value === defaultModes[index];
     });
     if (!modesEqual) return true;
-  } // If modes are equal, check the remaining params.
-
-
+  }
+  // If modes are equal, check the remaining params.
   var defaultQuery = getDefaultQuery(config);
-
-  var _loop = function _loop(i) {
-    var param = defaultParams[i];
-    var paramInfo = queryParams.find(function (qp) {
-      return qp.name === param;
-    }); // If the parameter applies to the query and does not match the default
-    // value, the query is not default.
-
-    if (isParamApplicable(paramInfo, query, config) && query[param] !== defaultQuery[param]) {
-      return {
-        v: true
-      };
-    }
-  };
-
+  var _loop = function _loop() {
+      var param = defaultParams[i];
+      var paramInfo = queryParams.find(function (qp) {
+        return qp.name === param;
+      });
+      // If the parameter applies to the query and does not match the default
+      // value, the query is not default.
+      if (isParamApplicable(paramInfo, query, config) && query[param] !== defaultQuery[param]) {
+        return {
+          v: true
+        };
+      }
+    },
+    _ret;
   for (var i = 0; i < defaultParams.length; i++) {
-    var _ret = _loop(i);
-
-    if (_typeof(_ret) === "object") return _ret.v;
+    _ret = _loop();
+    if (_ret) return _ret.v;
   }
-
   return false;
 }
+
 /**
  * Geocode utility for returning the first result for the provided place name text.
  * @param  {string} text - text to search
@@ -231,7 +212,6 @@ export function isNotDefaultQuery(query, config) {
  * @param  {string} geocoderMethod - an alternate geocoder api method to use. Defaults to `search`
  * @return {Location}
  */
-
 function getFirstGeocodeResult(_x, _x2) {
   return _getFirstGeocodeResult.apply(this, arguments);
 }
@@ -242,43 +222,34 @@ function getFirstGeocodeResult(_x, _x2) {
  * @return {Location} - location or null if the value is falsey or the parsed
  *                      coordinates do not result in both a lat and lon
  */
-
-
 function _getFirstGeocodeResult() {
-  _getFirstGeocodeResult = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(text, geocoderConfig) {
+  _getFirstGeocodeResult = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(text, geocoderConfig) {
     var geocoderMethod,
-        geocoder,
-        _args = arguments;
+      geocoder,
+      _args = arguments;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            geocoderMethod = _args.length > 2 && _args[2] !== undefined ? _args[2] : "search";
-            geocoder = getGeocoder(geocoderConfig); // Attempt to geocode search text and return first result if found.
-            // TODO: Import geocoder from @opentripplanner
-
-            return _context.abrupt("return", geocoder[geocoderMethod]({
-              text: text
-            }).then(function (result) {
-              var firstResult = result.features && result.features[0];
-
-              if (firstResult) {
-                return geocoder.getLocationFromGeocodedFeature(firstResult);
-              }
-
-              return null;
-            }));
-
-          case 3:
-          case "end":
-            return _context.stop();
-        }
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          geocoderMethod = _args.length > 2 && _args[2] !== undefined ? _args[2] : "search";
+          geocoder = getGeocoder(geocoderConfig); // Attempt to geocode search text and return first result if found.
+          // TODO: Import geocoder from @opentripplanner
+          return _context.abrupt("return", geocoder[geocoderMethod]({
+            text: text
+          }).then(function (result) {
+            var firstResult = result.features && result.features[0];
+            if (firstResult) {
+              return geocoder.getLocationFromGeocodedFeature(firstResult);
+            }
+            return null;
+          }));
+        case 3:
+        case "end":
+          return _context.stop();
       }
     }, _callee);
   }));
   return _getFirstGeocodeResult.apply(this, arguments);
 }
-
 export function parseLocationString(value) {
   if (!value) return null;
   var parts = value.split("::");
@@ -290,6 +261,7 @@ export function parseLocationString(value) {
     lon: coordinates[1] || null
   } : null;
 }
+
 /**
  * Convert a string query param for a from or to place into a location. If
  * coordinates not provided and geocoder config is present, use the first
@@ -298,7 +270,6 @@ export function parseLocationString(value) {
  * @param  {Object} [geocoderConfig=null]
  * @return {Location}
  */
-
 function queryParamToLocation(_x3, _x4) {
   return _queryParamToLocation.apply(this, arguments);
 }
@@ -308,41 +279,31 @@ function queryParamToLocation(_x3, _x4) {
  * @param  {Object} params An object representing the parsed querystring of url
  *    params.
  */
-
-
 function _queryParamToLocation() {
-  _queryParamToLocation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(value, geocoderConfig) {
+  _queryParamToLocation = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee2(value, geocoderConfig) {
     var location;
     return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-      while (1) {
-        switch (_context2.prev = _context2.next) {
-          case 0:
-            location = parseLocationString(value);
-
-            if (!(!location && value && geocoderConfig)) {
-              _context2.next = 5;
-              break;
-            }
-
-            _context2.next = 4;
-            return getFirstGeocodeResult(value, geocoderConfig, geocoderConfig.autoMethod);
-
-          case 4:
-            location = _context2.sent;
-
-          case 5:
-            return _context2.abrupt("return", location);
-
-          case 6:
-          case "end":
-            return _context2.stop();
-        }
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          location = parseLocationString(value);
+          if (!(!location && value && geocoderConfig)) {
+            _context2.next = 5;
+            break;
+          }
+          _context2.next = 4;
+          return getFirstGeocodeResult(value, geocoderConfig, geocoderConfig.autoMethod);
+        case 4:
+          location = _context2.sent;
+        case 5:
+          return _context2.abrupt("return", location);
+        case 6:
+        case "end":
+          return _context2.stop();
       }
     }, _callee2);
   }));
   return _queryParamToLocation.apply(this, arguments);
 }
-
 export function planParamsToQuery(params) {
   var query = {};
   Object.keys(params).forEach(function (key) {
@@ -350,19 +311,15 @@ export function planParamsToQuery(params) {
       case "fromPlace":
         query.from = parseLocationString(params.fromPlace);
         break;
-
       case "toPlace":
         query.to = parseLocationString(params.toPlace);
         break;
-
       case "arriveBy":
         query.departArrive = params.arriveBy === "true" ? "ARRIVE" : params.arriveBy === "false" ? "DEPART" : "NOW";
         break;
-
       case "date":
         query.date = params.date || getCurrentDate();
         break;
-
       case "time":
         {
           // Match one of the supported time formats
@@ -372,19 +329,17 @@ export function planParamsToQuery(params) {
           query.time = matchedTimeFormat ? format(parse(params.time, matchedTimeFormat, new Date()), OTP_API_TIME_FORMAT) : getCurrentTime();
         }
         break;
-
       case "intermediatePlaces":
         // If query has intermediate places, ensure that they are parsed
         // as locations.
         query.intermediatePlaces = params.intermediatePlaces ? params.intermediatePlaces.map(parseLocationString) : [];
         break;
-
       default:
         {
-          var maybeNumber = Number(params[key]); // If the param value is an empty string literal and is not a number,
+          var maybeNumber = Number(params[key]);
+          // If the param value is an empty string literal and is not a number,
           // use string value. Else, use parsed number value.
           // See https://github.com/opentripplanner/otp-ui/issues/50
-
           query[key] = params[key] === "" || Number.isNaN(maybeNumber) ? params[key] : maybeNumber;
           break;
         }
@@ -392,6 +347,7 @@ export function planParamsToQuery(params) {
   });
   return query;
 }
+
 /**
  * Async method to create a otp query based on a the url params. This provides
  * the same functionality as planParamsToQuery, except that it will also attempt
@@ -401,10 +357,10 @@ export function planParamsToQuery(params) {
  *    params.
  * @param config the config in the otp-rr store.
  */
-
 export function planParamsToQueryAsync(_x5) {
   return _planParamsToQueryAsync.apply(this, arguments);
 }
+
 /**
  * Create an object that can be used as a querystring in making an OTP
  * PlannerResource request.
@@ -418,64 +374,52 @@ export function planParamsToQueryAsync(_x5) {
  * @param  {boolean} ignoreRealtimeUpdates  If true, will create a request that
  *   does not use realtime data.
  */
-
 function _planParamsToQueryAsync() {
-  _planParamsToQueryAsync = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(params) {
+  _planParamsToQueryAsync = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee3(params) {
     var config,
-        query,
-        _args3 = arguments;
+      query,
+      _args3 = arguments;
     return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-      while (1) {
-        switch (_context3.prev = _context3.next) {
-          case 0:
-            config = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
-            // Construct query from plan params.
-            query = planParamsToQuery(params); // Attempt to geocode from and to params if the string parsing does not return
-            // valid locations.
-
-            if (query.from) {
-              _context3.next = 6;
-              break;
-            }
-
-            _context3.next = 5;
-            return queryParamToLocation(params.fromPlace, config.geocoder);
-
-          case 5:
-            query.from = _context3.sent;
-
-          case 6:
-            if (query.to) {
-              _context3.next = 10;
-              break;
-            }
-
-            _context3.next = 9;
-            return queryParamToLocation(params.toPlace, config.geocoder);
-
-          case 9:
-            query.to = _context3.sent;
-
-          case 10:
-            return _context3.abrupt("return", query);
-
-          case 11:
-          case "end":
-            return _context3.stop();
-        }
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          config = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
+          // Construct query from plan params.
+          query = planParamsToQuery(params); // Attempt to geocode from and to params if the string parsing does not return
+          // valid locations.
+          if (query.from) {
+            _context3.next = 6;
+            break;
+          }
+          _context3.next = 5;
+          return queryParamToLocation(params.fromPlace, config.geocoder);
+        case 5:
+          query.from = _context3.sent;
+        case 6:
+          if (query.to) {
+            _context3.next = 10;
+            break;
+          }
+          _context3.next = 9;
+          return queryParamToLocation(params.toPlace, config.geocoder);
+        case 9:
+          query.to = _context3.sent;
+        case 10:
+          return _context3.abrupt("return", query);
+        case 11:
+        case "end":
+          return _context3.stop();
       }
     }, _callee3);
   }));
   return _planParamsToQueryAsync.apply(this, arguments);
 }
-
 export function getRoutingParams(config, currentQuery, ignoreRealtimeUpdates) {
   var _config$modes2;
-
   var routingType = currentQuery.routingType;
   var isItinerary = routingType === "ITINERARY";
-  var params = {}; // Start with the universe of OTP parameters defined in query-params.js:
+  var params = {};
 
+  // Start with the universe of OTP parameters defined in query-params.js:
   queryParams.filter(function (qp) {
     // A given parameter is included in the request if all of the following:
     // 1. Must apply to the active routing type (ITINERARY or PROFILE)
@@ -487,60 +431,60 @@ export function getRoutingParams(config, currentQuery, ignoreRealtimeUpdates) {
     // functions (if provided)
     var rewriteFunction = isItinerary ? qp.itineraryRewrite : qp.profileRewrite;
     params = Object.assign(params, rewriteFunction ? rewriteFunction(currentQuery[qp.name]) : _defineProperty({}, qp.name, currentQuery[qp.name]));
-  }); // Additional processing specific to ITINERARY mode
+  });
 
+  // Additional processing specific to ITINERARY mode
   if (isItinerary) {
     // override ignoreRealtimeUpdates if provided
     if (typeof ignoreRealtimeUpdates === "boolean") {
       params.ignoreRealtimeUpdates = ignoreRealtimeUpdates;
-    } // check date/time validity; ignore both if either is invalid
-
+    }
 
+    // check date/time validity; ignore both if either is invalid
     var dateValid = isMatch(params.date, OTP_API_DATE_FORMAT);
     var timeValid = isMatch(params.time, OTP_API_TIME_FORMAT);
-
     if (!dateValid || !timeValid) {
       delete params.time;
       delete params.date;
-    } // temp: set additional parameters for CAR_HAIL or CAR_RENT trips
-
+    }
 
+    // temp: set additional parameters for CAR_HAIL or CAR_RENT trips
     if (params.mode && (params.mode.includes("CAR_HAIL") || params.mode.includes("CAR_RENT"))) {
-      params.minTransitDistance = "50%"; // increase search timeout because these queries can take a while
-
+      params.minTransitDistance = "50%";
+      // increase search timeout because these queries can take a while
       params.searchTimeout = 10000;
-    } // set onlyTransitTrips for car rental searches
-
+    }
 
+    // set onlyTransitTrips for car rental searches
     if (params.mode && params.mode.includes("CAR_RENT")) {
       params.onlyTransitTrips = true;
-    } // Additional processing specific to PROFILE mode
+    }
 
+    // Additional processing specific to PROFILE mode
   } else {
     // check start and end time validity; ignore both if either is invalid
     var startTimeValid = isMatch(params.startTime, OTP_API_TIME_FORMAT);
     var endTimeValid = isMatch(params.endTime, OTP_API_TIME_FORMAT);
-
     if (!startTimeValid || !endTimeValid) {
       delete params.startTimeValid;
       delete params.endTimeValid;
     }
-  } // TODO: check that valid from/to locations are provided
-  // hack to add walking to driving/TNC trips
+  }
 
+  // TODO: check that valid from/to locations are provided
 
+  // hack to add walking to driving/TNC trips
   if (hasCar(params.mode)) {
     params.mode += ",WALK";
-  } // Replace FLEX placeholder with OTP flex modes
-  // Explicit false check allows avoiding a breaking change -- undefined is true
-
+  }
 
+  // Replace FLEX placeholder with OTP flex modes
+  // Explicit false check allows avoiding a breaking change -- undefined is true
   if (params.mode && ((_config$modes2 = config.modes) === null || _config$modes2 === void 0 ? void 0 : _config$modes2.mergeFlex) !== false) {
     // Ensure query is in reduced format to avoid replacing twice
     var reducedMode = reduceOtpFlexModes(params.mode.split(",")).join(",");
     params.mode = expandOtpFlexMode(reducedMode);
   }
-
   return params;
 }
 //# sourceMappingURL=query.js.map