@opentripplanner/core-utils 4.8.1-alpha → 4.10.0

package/src/profile.js

@@ -27,8 +27,8 @@ export function filterProfileOptions(response) {
   return response;
 }
 
-function locationString(str, defaultStr) {
-  return str ? str.split(",")[0] : defaultStr;
+function locationString(str) {
+  return str ? str.split(",")[0] : null;
 }
 
 function accessToLeg(access, origin, destination) {
@@ -37,10 +37,10 @@ function accessToLeg(access, origin, destination) {
     duration: access.time,
     transitLeg: false,
     from: {
-      name: locationString(origin, "Origin")
+      name: locationString(origin)
     },
     to: {
-      name: locationString(destination, "Destination")
+      name: locationString(destination)
     }
   };
 }
@@ -98,7 +98,7 @@ function optionToItinerary(option, query) {
         duration: walkOnTime,
         transitLeg: false,
         from: {
-          name: locationString(query && query.from.name, "Destination")
+          name: locationString(query && query.from.name)
         },
         to: {
           name: onStationName
@@ -127,7 +127,7 @@ function optionToItinerary(option, query) {
           name: offStationName
         },
         to: {
-          name: locationString(query && query.to.name, "Destination")
+          name: locationString(query && query.to.name)
         }
       });
     } else {
@@ -177,16 +177,6 @@ function optionToItinerary(option, query) {
       itin.walkTime += option.egress[0].time;
   }
 
-  // construct summary
-  if (option.transit) {
-    itin.summary = "Transit";
-  } else if (option.modes.length === 1 && option.modes[0] === "bicycle")
-    itin.summary = "Bicycle";
-  else if (option.modes.length === 1 && option.modes[0] === "walk")
-    itin.summary = "Walk";
-  else if (option.modes.indexOf("bicycle_rent") !== -1)
-    itin.summary = "Bikeshare";
-
   return itin;
 }
 

package/src/query-params.js

@@ -1,3 +1,7 @@
+// TODO: Remove this entire file, as it is deprecated in favor of i18n-queryParams within
+// the SettingsSelector package
+
+// This is only used within stories
 import cloneDeep from "lodash.clonedeep";
 import React from "react";
 import { Wheelchair } from "@styled-icons/foundation/Wheelchair";
@@ -54,10 +58,14 @@ import { getCurrentDate, getCurrentTime } from "./time";
 /**
  * Format location object as string for use in fromPlace or toPlace query param.
  */
-export function formatPlace(location, alternateName = "Place") {
+export function formatPlace(location, alternateName) {
   if (!location) return null;
   const name =
-    location.name || `${alternateName} (${location.lat},${location.lon})`;
+    location.name ||
+    `${alternateName ? `${alternateName} ` : ""}(${location.lat},${
+      location.lon
+    })`;
+  // This string is not language-specific
   return `${name}::${location.lat},${location.lon}`;
 }
 
@@ -70,7 +78,7 @@ const queryParams = [
     name: "from",
     routingTypes: ["ITINERARY", "PROFILE"],
     default: null,
-    itineraryRewrite: value => ({ fromPlace: formatPlace(value, "Origin") }),
+    itineraryRewrite: value => ({ fromPlace: formatPlace(value) }),
     profileRewrite: value => ({ from: { lat: value.lat, lon: value.lon } })
     // FIXME: Use for parsing URL values?
     // fromURL: stringToLocation
@@ -81,7 +89,7 @@ const queryParams = [
     name: "to",
     routingTypes: ["ITINERARY", "PROFILE"],
     default: null,
-    itineraryRewrite: value => ({ toPlace: formatPlace(value, "Destination") }),
+    itineraryRewrite: value => ({ toPlace: formatPlace(value) }),
     profileRewrite: value => ({ to: { lat: value.lat, lon: value.lon } })
     // FIXME: Use for parsing URL values?
     // fromURL: stringToLocation
@@ -161,7 +169,7 @@ const queryParams = [
     routingTypes: ["ITINERARY"],
     applicable: query =>
       query.mode && hasTransit(query.mode) && query.mode.indexOf("WALK") !== -1,
-    default: 1609, // default is 1 mile walk
+    default: 1207, // 3/4 mi.
     selector: "DROPDOWN",
     label: "Maximum Walk",
     options: [

package/src/query.js

@@ -2,14 +2,8 @@ import moment from "moment";
 import getGeocoder from "@opentripplanner/geocoder/lib";
 import qs from "qs";
 
-import {
-  getTransitModes,
-  hasCar,
-  hasTransit,
-  isAccessMode,
-  toSentenceCase
-} from "./itinerary";
-import { coordsToString, matchLatLon, stringToCoords } from "./map";
+import { getTransitModes, hasCar, isAccessMode } from "./itinerary";
+import { stringToCoords } from "./map";
 import queryParams from "./query-params";
 import {
   getCurrentTime,
@@ -18,6 +12,10 @@ import {
   OTP_API_TIME_FORMAT
 } from "./time";
 
+import { coordsToString, summarizeQuery } from "./deprecated";
+
+export { summarizeQuery };
+
 /* The list of default parameters considered in the settings panel */
 
 export const defaultParams = [
@@ -84,24 +82,6 @@ export function getOtpUrlParams() {
   return Object.keys(getUrlParams()).filter(key => !key.startsWith("ui_"));
 }
 
-function findLocationType(
-  location,
-  locations = [],
-  types = ["home", "work", "suggested"]
-) {
-  const match = locations.find(l => matchLatLon(l, location));
-  return match && types.indexOf(match.type) !== -1 ? match.type : null;
-}
-
-export function summarizeQuery(query, locations = []) {
-  const from =
-    findLocationType(query.from, locations) || query.from.name.split(",")[0];
-  const to =
-    findLocationType(query.to, locations) || query.to.name.split(",")[0];
-  const mode = hasTransit(query.mode) ? "Transit" : toSentenceCase(query.mode);
-  return `${mode} from ${from} to ${to}`;
-}
-
 export function getTripOptionsFromQuery(query, keepPlace = false) {
   const options = { ...query };
   // Delete time/date options and from/to

package/src/time.js

@@ -23,7 +23,11 @@ export const OTP_API_TIME_FORMAT = "HH:mm";
  * Otherwise, uses date-fns default
  * @returns                   Formatted duration
  */
-function formatDurationLikeMoment(seconds, showSeconds, localize = true) {
+function formatDurationLikeMoment(
+  seconds,
+  showSeconds,
+  localize = { enabled: true, code: "en-US" }
+) {
   // date-fns doesn't do this automatically
   if ((!showSeconds && seconds < 60) || seconds === 0) {
     return "0 min";
@@ -41,7 +45,8 @@ function formatDurationLikeMoment(seconds, showSeconds, localize = true) {
   };
   const locale = localize
     ? {
-        code: "en-US",
+        // Maintain backwards compatibility when called with localize=true
+        code: localize?.code || "en-US",
         formatDistance: (spec, val) => {
           return `${val} ${specLookup[spec]}`;
         }
@@ -60,6 +65,22 @@ function formatDurationLikeMoment(seconds, showSeconds, localize = true) {
     }
   );
 }
+
+/**
+ * Breaks up a duration in seconds into hours, minutes, and seconds.
+ * @param {number} seconds The number of seconds to break up
+ * @returns an object with fields with the corresponding, hours, minutes, seconds.
+ */
+export function toHoursMinutesSeconds(seconds) {
+  const hours = Math.floor(seconds / 3600);
+  const minutes = Math.floor((seconds - hours * 3600) / 60);
+  return {
+    hours,
+    minutes,
+    seconds: seconds - hours * 3600 - minutes * 60
+  };
+}
+
 /**
  * @param  {[type]} config the OTP config object found in store
  * @return {string}        the config-defined time formatter or HH:mm (24-hr time)
@@ -92,9 +113,18 @@ export function formatDuration(seconds) {
  * @param {number} seconds duration in seconds
  * @returns {string} formatted text representation
  */
-export function formatDurationWithSeconds(seconds) {
-  return formatDurationLikeMoment(seconds, true);
+export function formatDurationWithSeconds(seconds, region) {
+  return formatDurationLikeMoment(seconds, { enabled: true, code: region });
+}
+
+/**
+ * Offsets a time according to the provided time options
+ * and returns the result.
+ */
+export function offsetTime(ms, options) {
+  return ms + (options?.offset || 0);
 }
+
 /**
  * Formats a time value for display in narrative
  * TODO: internationalization/timezone
@@ -103,7 +133,7 @@ export function formatDurationWithSeconds(seconds) {
  */
 export function formatTime(ms, options) {
   return format(
-    ms + (options?.offset || 0),
+    offsetTime(ms, options),
     options?.format || OTP_API_TIME_FORMAT
   );
 }