@opentripplanner/core-utils 4.11.4 → 5.0.0

package/src/deprecated-with-types.ts

@@ -0,0 +1,62 @@
+/* eslint-disable import/no-cycle */
+import { TimeOptions } from "@opentripplanner/types";
+import { format } from "date-fns";
+
+import { logDeprecationWarning } from "./deprecated";
+import {
+  formatDurationLikeMoment,
+  offsetTime,
+  OTP_API_TIME_FORMAT
+} from "./time";
+
+// time.ts
+
+/**
+ * Formats a time value for display in narrative
+ * TODO: internationalization/timezone
+ * @param {number} ms epoch time value in milliseconds
+ * @returns {string} formatted text representation
+ */
+export function formatTime(ms: number, options: TimeOptions): string {
+  logDeprecationWarning("formatTime", "formatjs");
+
+  return format(
+    offsetTime(ms, options),
+    options?.format || OTP_API_TIME_FORMAT
+  );
+}
+
+/**
+ * Formats an elapsed time duration for display in narrative.
+ * TODO: internationalization
+ * @param {number} seconds duration in seconds
+ * @returns {string} formatted text representation
+ */
+// TS TODO: region as type?
+export function formatDuration(seconds: number, region: string): string {
+  logDeprecationWarning("formatDuration", "formatjs");
+
+  return formatDurationLikeMoment(seconds, false, {
+    enabled: true,
+    code: region
+  });
+}
+
+/**
+ * Formats an elapsed time in seconds, minutes, hours duration for display in narrative
+ * @param {number} seconds duration in seconds
+ * @param {object} region  an object that allows internationalization of the time
+ * @returns {string}       formatted text representation
+ */
+// TS TODO: region as type?
+export function formatDurationWithSeconds(
+  seconds: number,
+  region: string
+): string {
+  logDeprecationWarning("formatDurationWithSeconds", "formatjs");
+
+  return formatDurationLikeMoment(seconds, true, {
+    enabled: true,
+    code: region
+  });
+}

package/src/deprecated.js

@@ -316,3 +316,19 @@ export function summarizeQuery(query, locations = []) {
     : require("./itinerary").toSentenceCase(query.mode);
   return `${mode} from ${from} to ${to}`;
 }
+
+export function getTimeZoneOffset(itinerary) {
+  logDeprecationWarning("getTimeZoneOffset");
+
+  if (!itinerary.legs || !itinerary.legs.length) return 0;
+
+  // Determine if there is a DST offset between now and the itinerary start date
+  const dstOffset =
+    new Date(itinerary.startTime).getTimezoneOffset() -
+    new Date().getTimezoneOffset();
+
+  return (
+    itinerary.legs[0].agencyTimeZoneOffset +
+    (new Date().getTimezoneOffset() + dstOffset) * 60000
+  );
+}

package/src/{index.js → index.ts}

@@ -1,26 +1,22 @@
 import * as itinerary from "./itinerary";
 import * as map from "./map";
-import * as messages from "./messages";
 import * as profile from "./profile";
 import * as query from "./query";
 import * as queryParams from "./query-params";
 import * as route from "./route";
 import * as storage from "./storage";
 import * as time from "./time";
-import * as types from "./types";
 import * as ui from "./ui";
 
 const core = {
   itinerary,
   map,
-  messages,
   profile,
   query,
   queryParams,
   route,
   storage,
   time,
-  types,
   ui
 };
 

package/src/{itinerary.js → itinerary.ts}

@@ -1,4 +1,14 @@
 import polyline from "@mapbox/polyline";
+import {
+  Company,
+  Config,
+  ElevationProfile,
+  FlexBookingInfo,
+  Itinerary,
+  LatLngArray,
+  Leg,
+  Step
+} from "@opentripplanner/types";
 import turfAlong from "@turf/along";
 
 import {
@@ -9,6 +19,7 @@ import {
   getStepDirection,
   getStepInstructions,
   getStepStreetName,
+  getTimeZoneOffset,
   getTransitFare
 } from "./deprecated";
 
@@ -20,6 +31,7 @@ export {
   getStepDirection,
   getStepInstructions,
   getStepStreetName,
+  getTimeZoneOffset,
   getTransitFare
 };
 
@@ -38,13 +50,16 @@ export const transitModes = [
  * @return {Array}  List of all transit modes defined in config; otherwise default mode list
  */
 
-export function getTransitModes(config) {
+export function getTransitModes(config: Config): string[] {
   if (!config || !config.modes || !config.modes.transitModes)
     return transitModes;
-  return config.modes.transitModes.map(tm => tm.mode);
+
+  return config.modes.transitModes.map(tm =>
+    typeof tm !== "string" ? tm.mode : tm
+  );
 }
 
-export function isTransit(mode) {
+export function isTransit(mode: string): boolean {
   return transitModes.includes(mode) || mode === "TRANSIT";
 }
 
@@ -53,7 +68,7 @@ export function isTransit(mode) {
  * calling ahead for the service to run. "mustPhone" is the only
  * property of boardRule which encodes this info.
  */
-export function isReservationRequired(leg) {
+export function isReservationRequired(leg: Leg): boolean {
   return leg.boardRule === "mustPhone";
 }
 /**
@@ -61,53 +76,53 @@ export function isReservationRequired(leg) {
  * asking the driver to let the user off. "coordinateWithDriver" is the only
  * property of alightRule which encodes this info.
  */
-export function isContinuousDropoff(leg) {
+export function isContinuousDropoff(leg: Leg): boolean {
   return leg.alightRule === "coordinateWithDriver";
 }
 /**
  * The two rules checked by the above two functions are the only values
  * returned by OTP when a leg is a flex leg.
  */
-export function isFlex(leg) {
+export function isFlex(leg: Leg): boolean {
   return isReservationRequired(leg) || isContinuousDropoff(leg);
 }
 
-export function isAdvanceBookingRequired(info) {
+export function isAdvanceBookingRequired(info: FlexBookingInfo): boolean {
   return info?.latestBookingTime?.daysPrior > 0;
 }
-export function legDropoffRequiresAdvanceBooking(leg) {
+export function legDropoffRequiresAdvanceBooking(leg: Leg): boolean {
   return isAdvanceBookingRequired(leg.dropOffBookingInfo);
 }
 
-export function isWalk(mode) {
+export function isWalk(mode: string): boolean {
   if (!mode) return false;
 
   return mode === "WALK";
 }
 
-export function isBicycle(mode) {
+export function isBicycle(mode: string): boolean {
   if (!mode) return false;
 
   return mode === "BICYCLE";
 }
 
-export function isBicycleRent(mode) {
+export function isBicycleRent(mode: string): boolean {
   if (!mode) return false;
 
   return mode === "BICYCLE_RENT";
 }
 
-export function isCar(mode) {
+export function isCar(mode: string): boolean {
   if (!mode) return false;
   return mode.startsWith("CAR");
 }
 
-export function isMicromobility(mode) {
+export function isMicromobility(mode: string): boolean {
   if (!mode) return false;
   return mode.startsWith("MICROMOBILITY") || mode.startsWith("SCOOTER");
 }
 
-export function isAccessMode(mode) {
+export function isAccessMode(mode: string): boolean {
   return (
     isWalk(mode) ||
     isBicycle(mode) ||
@@ -121,7 +136,7 @@ export function isAccessMode(mode) {
  * @param  {string}  modesStr a comma-separated list of OTP modes
  * @return {boolean} whether any of the modes are transit modes
  */
-export function hasTransit(modesStr) {
+export function hasTransit(modesStr: string): boolean {
   return modesStr.split(",").some(mode => isTransit(mode));
 }
 
@@ -129,7 +144,7 @@ export function hasTransit(modesStr) {
  * @param  {string}  modesStr a comma-separated list of OTP modes
  * @return {boolean} whether any of the modes are car-based modes
  */
-export function hasCar(modesStr) {
+export function hasCar(modesStr: string): boolean {
   return modesStr.split(",").some(mode => isCar(mode));
 }
 
@@ -137,7 +152,7 @@ export function hasCar(modesStr) {
  * @param  {string}  modesStr a comma-separated list of OTP modes
  * @return {boolean} whether any of the modes are bicycle-based modes
  */
-export function hasBike(modesStr) {
+export function hasBike(modesStr: string): boolean {
   return modesStr
     .split(",")
     .some(mode => isBicycle(mode) || isBicycleRent(mode));
@@ -147,7 +162,7 @@ export function hasBike(modesStr) {
  * @param  {string}  modesStr a comma-separated list of OTP modes
  * @return {boolean} whether any of the modes are micromobility-based modes
  */
-export function hasMicromobility(modesStr) {
+export function hasMicromobility(modesStr: string): boolean {
   return modesStr.split(",").some(mode => isMicromobility(mode));
 }
 
@@ -155,7 +170,7 @@ export function hasMicromobility(modesStr) {
  * @param  {string}  modesStr a comma-separated list of OTP modes
  * @return {boolean} whether any of the modes is a hailing mode
  */
-export function hasHail(modesStr) {
+export function hasHail(modesStr: string): boolean {
   return modesStr.split(",").some(mode => mode.indexOf("_HAIL") > -1);
 }
 
@@ -163,11 +178,11 @@ export function hasHail(modesStr) {
  * @param  {string}  modesStr a comma-separated list of OTP modes
  * @return {boolean} whether any of the modes is a rental mode
  */
-export function hasRental(modesStr) {
+export function hasRental(modesStr: string): boolean {
   return modesStr.split(",").some(mode => mode.indexOf("_RENT") > -1);
 }
 
-export function getMapColor(mode) {
+export function getMapColor(mode: string): string {
   mode = mode || this.get("mode");
   if (mode === "WALK") return "#444";
   if (mode === "BICYCLE") return "#0073e5";
@@ -181,7 +196,7 @@ export function getMapColor(mode) {
   return "#aaa";
 }
 
-export function toSentenceCase(str) {
+export function toSentenceCase(str: string): string {
   if (str == null) {
     return "";
   }
@@ -192,7 +207,7 @@ export function toSentenceCase(str) {
 /**
  * Derive the company string based on mode and network associated with leg.
  */
-export function getCompanyFromLeg(leg) {
+export function getCompanyFromLeg(leg: Leg): string {
   if (!leg) return null;
   const { from, mode, rentedBike, rentedCar, rentedVehicle, tncData } = leg;
   if (mode === "CAR" && rentedCar) {
@@ -214,12 +229,12 @@ export function getCompanyFromLeg(leg) {
   return null;
 }
 
-export function getItineraryBounds(itinerary) {
+export function getItineraryBounds(itinerary: Itinerary): LatLngArray[] {
   let coords = [];
   itinerary.legs.forEach(leg => {
     const legCoords = polyline
       .toGeoJSON(leg.legGeometry.points)
-      .coordinates.map(c => [c[1], c[0]]);
+      .coordinates.map((c: number[]) => [c[1], c[0]]);
     coords = [...coords, ...legCoords];
   });
   return coords;
@@ -228,7 +243,7 @@ export function getItineraryBounds(itinerary) {
 /**
  * Return a coords object that encloses the given leg's geometry.
  */
-export function getLegBounds(leg) {
+export function getLegBounds(leg: Leg): number[] {
   const coords = polyline
     .toGeoJSON(leg.legGeometry.points)
     .coordinates.map(c => [c[1], c[0]]);
@@ -244,7 +259,7 @@ export function getLegBounds(leg) {
 
 /* Returns an interpolated lat-lon at a specified distance along a leg */
 
-export function legLocationAtDistance(leg, distance) {
+export function legLocationAtDistance(leg: Leg, distance: number): number[] {
   if (!leg.legGeometry) return null;
 
   try {
@@ -262,7 +277,10 @@ export function legLocationAtDistance(leg, distance) {
 
 /* Returns an interpolated elevation at a specified distance along a leg */
 
-export function legElevationAtDistance(points, distance) {
+export function legElevationAtDistance(
+  points: number[][],
+  distance: number
+): number {
   // Iterate through the combined elevation profile
   let traversed = 0;
   // If first point distance is not zero, insert starting point at zero with
@@ -300,7 +318,10 @@ export function legElevationAtDistance(points, distance) {
 
 // Iterate through the steps, building the array of elevation points and
 // keeping track of the minimum and maximum elevations reached
-export function getElevationProfile(steps, unitConversion = 1) {
+export function getElevationProfile(
+  steps: Step[],
+  unitConversion = 1
+): ElevationProfile {
   let minElev = 100000;
   let maxElev = -100000;
   let traversed = 0;
@@ -347,11 +368,14 @@ export function getElevationProfile(steps, unitConversion = 1) {
  *
  * @see https://stackoverflow.com/questions/118241/calculate-text-width-with-javascript/21015393#21015393
  */
-export function getTextWidth(text, font = "22px Arial") {
+export function getTextWidth(text: string, font = "22px Arial"): number {
+  // Create custom type for function including re-used canvas object
+  type GetTextWidth = typeof getTextWidth & { canvas: HTMLCanvasElement };
+
   // re-use canvas object for better performance
   const canvas =
-    getTextWidth.canvas ||
-    (getTextWidth.canvas = document.createElement("canvas"));
+    (getTextWidth as GetTextWidth).canvas ||
+    ((getTextWidth as GetTextWidth).canvas = document.createElement("canvas"));
   const context = canvas.getContext("2d");
   context.font = font;
   const metrics = context.measureText(text);
@@ -362,7 +386,10 @@ export function getTextWidth(text, font = "22px Arial") {
  * Get the configured company object for the given network string if the company
  * has been defined in the provided companies array config.
  */
-export function getCompanyForNetwork(networkString, companies = []) {
+export function getCompanyForNetwork(
+  networkString: string,
+  companies: Company[] = []
+): Company {
   const company = companies.find(co => co.id === networkString);
   if (!company) {
     console.warn(
@@ -380,7 +407,10 @@ export function getCompanyForNetwork(networkString, companies = []) {
  * @param  {Array<object>}  [companies=[]] An optional list of the companies config.
  * @return {string}  A label for use in presentation on a website.
  */
-export function getCompaniesLabelFromNetworks(networks, companies = []) {
+export function getCompaniesLabelFromNetworks(
+  networks: string[],
+  companies: Company[] = []
+): string {
   return networks
     .map(network => getCompanyForNetwork(network, companies))
     .filter(co => !!co)
@@ -388,12 +418,18 @@ export function getCompaniesLabelFromNetworks(networks, companies = []) {
     .join("/");
 }
 
-export function getTNCLocation(leg, type) {
+export function getTNCLocation(leg: Leg, type: string): string {
   const location = leg[type];
   return `${location.lat.toFixed(5)},${location.lon.toFixed(5)}`;
 }
 
-export function calculatePhysicalActivity(itinerary) {
+export function calculatePhysicalActivity(
+  itinerary: Itinerary
+): {
+  bikeDuration: number;
+  caloriesBurned: number;
+  walkDuration: number;
+} {
   let walkDuration = 0;
   let bikeDuration = 0;
   itinerary.legs.forEach(leg => {
@@ -409,20 +445,6 @@ export function calculatePhysicalActivity(itinerary) {
   };
 }
 
-export function getTimeZoneOffset(itinerary) {
-  if (!itinerary.legs || !itinerary.legs.length) return 0;
-
-  // Determine if there is a DST offset between now and the itinerary start date
-  const dstOffset =
-    new Date(itinerary.startTime).getTimezoneOffset() -
-    new Date().getTimezoneOffset();
-
-  return (
-    itinerary.legs[0].agencyTimeZoneOffset +
-    (new Date().getTimezoneOffset() + dstOffset) * 60000
-  );
-}
-
 export function calculateTncFares(itinerary) {
   // TODO: don't rely on deprecated methods!
   // At the moment this is safe as none of these exported variables contain strings

package/src/{map.js → map.ts}

@@ -1,9 +1,18 @@
+import {
+  Company,
+  Itinerary,
+  LatLngArray,
+  Leg,
+  Location,
+  TransitiveData,
+  UserPosition
+} from "@opentripplanner/types";
 import {
   getPlaceName,
-  isTransit,
+  isAccessMode,
   isFlex,
-  toSentenceCase,
-  isAccessMode
+  isTransit,
+  toSentenceCase
 } from "./itinerary";
 
 import {
@@ -15,7 +24,9 @@ import {
 
 export { coordsToString, getDetailText, latlngToString };
 
-export function currentPositionToLocation(currentPosition) {
+export function currentPositionToLocation(
+  currentPosition: UserPosition
+): Location {
   if (currentPosition.error || !currentPosition.coords) {
     console.warn(
       "Cannot construct location from current position due to geolocation error or missing coordinates."
@@ -29,18 +40,24 @@ export function currentPositionToLocation(currentPosition) {
   };
 }
 
-export function stringToCoords(str) {
+export function stringToCoords(str: string): number[] {
   return (str && str.split(",").map(c => +c)) || [];
 }
 
-export function constructLocation(latlng) {
+export function constructLocation(latlng: {
+  lat: number;
+  lng: number;
+}): Location {
   return {
     lat: latlng.lat,
     lon: latlng.lng
   };
 }
 
-export function formatStoredPlaceName(location, withDetails = true) {
+export function formatStoredPlaceName(
+  location: Location,
+  withDetails = true
+): string {
   if (withDetails) {
     logDeprecationWarning("the formatStoredPlaceName withDetails parameter");
   }
@@ -56,7 +73,7 @@ export function formatStoredPlaceName(location, withDetails = true) {
   return displayName;
 }
 
-export function matchLatLon(location1, location2) {
+export function matchLatLon(location1: Location, location2: Location): boolean {
   if (!location1 || !location2) return location1 === location2;
   return location1.lat === location2.lat && location1.lon === location2.lon;
 }
@@ -70,11 +87,11 @@ export function matchLatLon(location1, location2) {
  * @returns An itinerary in the transitive.js format.
  */
 export function itineraryToTransitive(
-  itin,
-  companies,
-  getRouteLabel,
-  disableFlexArc
-) {
+  itin: Itinerary,
+  companies: Company[],
+  getRouteLabel: (leg: Leg) => string,
+  disableFlexArc: boolean
+): TransitiveData {
   const tdata = {
     journeys: [],
     streetEdges: [],
@@ -109,7 +126,7 @@ export function itineraryToTransitive(
 
   itin.legs.forEach((leg, idx) => {
     if (isAccessMode(leg.mode)) {
-      let fromPlaceId;
+      let fromPlaceId: string;
       if (leg.from.bikeShareId) {
         fromPlaceId = `bicycle_rent_station_${leg.from.bikeShareId}`;
         // TODO: does this need to change to be OTP2 compatible?
@@ -143,6 +160,7 @@ export function itineraryToTransitive(
       }
 
       const segment = {
+        arc: false,
         type: leg.mode,
         streetEdges: [streetEdgeId],
         from: { type: "PLACE", place_id: fromPlaceId },
@@ -298,27 +316,30 @@ export function itineraryToTransitive(
   return tdata;
 }
 
-export function isBikeshareStation(place) {
+type TransitivePlaceRaw = {
+  place_id: string;
+};
+export function isBikeshareStation(place: TransitivePlaceRaw): boolean {
   return place.place_id.lastIndexOf("bicycle_rent_station") !== -1;
 }
 
-export function isEScooterStation(place) {
+export function isEScooterStation(place: TransitivePlaceRaw): boolean {
   return place.place_id.lastIndexOf("escooter_rent_station") !== -1;
 }
 
-export function isCarWalkTransition(place) {
+export function isCarWalkTransition(place: TransitivePlaceRaw): boolean {
   return place.place_id.lastIndexOf("itin_car_") !== -1;
 }
 
-export function isValidLat(lat) {
+export function isValidLat(lat: number): boolean {
   return Number.isFinite(lat) && lat >= -90 && lat <= 90;
 }
 
-export function isValidLng(lng) {
+export function isValidLng(lng: number): boolean {
   return Number.isFinite(lng) && lng >= -180 && lng <= 180;
 }
 
-export function isValidLatLng(arr) {
+export function isValidLatLng(arr: LatLngArray): boolean {
   return (
     Array.isArray(arr) &&
     arr.length === 2 &&

package/src/query-params.js

@@ -278,8 +278,8 @@ const queryParams = [
   {
     /* optimize -- how to optimize a trip (non-bike, non-micromobility trips) */
     name: "optimize",
-    applicable: query =>
-      !query.otp2 && hasTransit(query.mode) && !hasBike(query.mode),
+    // This parameter doesn't seem to do anything
+    applicable: () => false,
     routingTypes: ["ITINERARY"],
     default: "QUICK",
     selector: "DROPDOWN",
@@ -304,7 +304,7 @@ const queryParams = [
     default: "SAFE",
     selector: "DROPDOWN",
     label: "Optimize for",
-    options: query => {
+    options: () => {
       const opts = [
         {
           text: "Speed",
@@ -320,14 +320,6 @@ const queryParams = [
         }
       ];
 
-      // Include transit-specific option, if applicable
-      if (hasTransit(query.mode)) {
-        opts.splice(1, 0, {
-          text: "Fewest Transfers",
-          value: "TRANSFERS"
-        });
-      }
-
       return opts;
     },
     itineraryRewrite: value => ({ optimize: value })