@opentripplanner/core-utils 15.0.0 → 16.0.1

package/esm/index.js

@@ -1,7 +1,10 @@
 import * as itinerary from "./itinerary";
 import * as map from "./map";
+// @ts-expect-error not typed
 import * as profile from "./profile";
+// @ts-expect-error not typed
 import * as query from "./query";
+// @ts-expect-error not typed
 import * as queryParams from "./query-params";
 import * as route from "./route";
 import * as storage from "./storage";

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["itinerary","map","profile","query","queryParams","route","storage","time","ui","queryGen","SafeSuspense","core"],"sources":["../src/index.ts"],"sourcesContent":["import * as itinerary from \"./itinerary\";\nimport * as map from \"./map\";\nimport * as profile from \"./profile\";\nimport * as query from \"./query\";\nimport * as queryParams from \"./query-params\";\nimport * as route from \"./route\";\nimport * as storage from \"./storage\";\nimport * as time from \"./time\";\nimport * as ui from \"./ui\";\nimport * as queryGen from \"./query-gen\";\nimport SafeSuspense from \"./suspense\";\n\nconst core = {\n  itinerary,\n  map,\n  profile,\n  query,\n  queryGen,\n  queryParams,\n  route,\n  storage,\n  time,\n  ui\n};\n\nexport { SafeSuspense };\nexport default core;\n"],"mappings":"AAAA,OAAO,KAAKA,SAAS,MAAM,aAAa;AACxC,OAAO,KAAKC,GAAG,MAAM,OAAO;AAC5B,OAAO,KAAKC,OAAO,MAAM,WAAW;AACpC,OAAO,KAAKC,KAAK,MAAM,SAAS;AAChC,OAAO,KAAKC,WAAW,MAAM,gBAAgB;AAC7C,OAAO,KAAKC,KAAK,MAAM,SAAS;AAChC,OAAO,KAAKC,OAAO,MAAM,WAAW;AACpC,OAAO,KAAKC,IAAI,MAAM,QAAQ;AAC9B,OAAO,KAAKC,EAAE,MAAM,MAAM;AAC1B,OAAO,KAAKC,QAAQ,MAAM,aAAa;AACvC,OAAOC,YAAY,MAAM,YAAY;AAErC,IAAMC,IAAI,GAAG;EACXX,SAAS,EAATA,SAAS;EACTC,GAAG,EAAHA,GAAG;EACHC,OAAO,EAAPA,OAAO;EACPC,KAAK,EAALA,KAAK;EACLM,QAAQ,EAARA,QAAQ;EACRL,WAAW,EAAXA,WAAW;EACXC,KAAK,EAALA,KAAK;EACLC,OAAO,EAAPA,OAAO;EACPC,IAAI,EAAJA,IAAI;EACJC,EAAE,EAAFA;AACF,CAAC;AAED,SAASE,YAAY;AACrB,eAAeC,IAAI","ignoreList":[]}
+{"version":3,"file":"index.js","names":["itinerary","map","profile","query","queryParams","route","storage","time","ui","queryGen","SafeSuspense","core"],"sources":["../src/index.ts"],"sourcesContent":["import * as itinerary from \"./itinerary\";\nimport * as map from \"./map\";\n// @ts-expect-error not typed\nimport * as profile from \"./profile\";\n// @ts-expect-error not typed\nimport * as query from \"./query\";\n// @ts-expect-error not typed\nimport * as queryParams from \"./query-params\";\nimport * as route from \"./route\";\nimport * as storage from \"./storage\";\nimport * as time from \"./time\";\nimport * as ui from \"./ui\";\nimport * as queryGen from \"./query-gen\";\nimport SafeSuspense from \"./suspense\";\n\nconst core = {\n  itinerary,\n  map,\n  profile,\n  query,\n  queryGen,\n  queryParams,\n  route,\n  storage,\n  time,\n  ui\n};\n\nexport { SafeSuspense };\nexport default core;\n"],"mappings":"AAAA,OAAO,KAAKA,SAAS,MAAM,aAAa;AACxC,OAAO,KAAKC,GAAG,MAAM,OAAO;AAC5B;AACA,OAAO,KAAKC,OAAO,MAAM,WAAW;AACpC;AACA,OAAO,KAAKC,KAAK,MAAM,SAAS;AAChC;AACA,OAAO,KAAKC,WAAW,MAAM,gBAAgB;AAC7C,OAAO,KAAKC,KAAK,MAAM,SAAS;AAChC,OAAO,KAAKC,OAAO,MAAM,WAAW;AACpC,OAAO,KAAKC,IAAI,MAAM,QAAQ;AAC9B,OAAO,KAAKC,EAAE,MAAM,MAAM;AAC1B,OAAO,KAAKC,QAAQ,MAAM,aAAa;AACvC,OAAOC,YAAY,MAAM,YAAY;AAErC,IAAMC,IAAI,GAAG;EACXX,SAAS,EAATA,SAAS;EACTC,GAAG,EAAHA,GAAG;EACHC,OAAO,EAAPA,OAAO;EACPC,KAAK,EAALA,KAAK;EACLM,QAAQ,EAARA,QAAQ;EACRL,WAAW,EAAXA,WAAW;EACXC,KAAK,EAALA,KAAK;EACLC,OAAO,EAAPA,OAAO;EACPC,IAAI,EAAJA,IAAI;EACJC,EAAE,EAAFA;AACF,CAAC;AAED,SAASE,YAAY;AACrB,eAAeC,IAAI","ignoreList":[]}

package/esm/itinerary.js

@@ -1,5 +1,6 @@
 import _typeof from "@babel/runtime/helpers/typeof";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 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; }
@@ -58,10 +59,11 @@ export function legContainsGeometry(leg) {
 }
 export function isAdvanceBookingRequired(info) {
   var _info$latestBookingTi;
-  return (info === null || info === void 0 || (_info$latestBookingTi = info.latestBookingTime) === null || _info$latestBookingTi === void 0 ? void 0 : _info$latestBookingTi.daysPrior) > 0;
+  var daysPrior = info === null || info === void 0 || (_info$latestBookingTi = info.latestBookingTime) === null || _info$latestBookingTi === void 0 ? void 0 : _info$latestBookingTi.daysPrior;
+  return typeof daysPrior === "number" && daysPrior > 0;
 }
 export function legDropoffRequiresAdvanceBooking(leg) {
-  return isAdvanceBookingRequired(leg === null || leg === void 0 ? void 0 : leg.dropOffBookingInfo);
+  return isAdvanceBookingRequired(leg.dropOffBookingInfo);
 }
 
 /**
@@ -166,6 +168,7 @@ export function hasRental(modesStr) {
   });
 }
 export function getMapColor(mode) {
+  // @ts-expect-error this is not typed
   mode = mode || this.get("mode");
   if (mode === "WALK") return "#444";
   if (mode === "BICYCLE") return "#0073e5";
@@ -199,14 +202,15 @@ export function getCompanyFromLeg(leg) {
     rentedCar = leg.rentedCar,
     rentedVehicle = leg.rentedVehicle,
     rideHailingEstimate = leg.rideHailingEstimate;
+  var firstNetwork = Array.isArray(from.networks) && from.networks.length > 0 ? from.networks[0] : null;
   if (mode === "CAR" && rentedCar) {
-    return from.networks[0];
+    return firstNetwork;
   }
   if (mode === "CAR" && rideHailingEstimate) {
     return rideHailingEstimate.provider.id;
   }
-  if (mode === "BICYCLE" && rentedBike && from.networks) {
-    return from.networks[0];
+  if (mode === "BICYCLE" && rentedBike) {
+    return firstNetwork;
   }
   if (from.rentalVehicle) {
     return from.rentalVehicle.network;
@@ -214,8 +218,8 @@ export function getCompanyFromLeg(leg) {
   if ((_from$vehicleRentalSt = from.vehicleRentalStation) !== null && _from$vehicleRentalSt !== void 0 && _from$vehicleRentalSt.rentalNetwork) {
     return from.vehicleRentalStation.rentalNetwork.networkId;
   }
-  if ((mode === "MICROMOBILITY" || mode === "SCOOTER") && rentedVehicle && from.networks) {
-    return from.networks[0];
+  if ((mode === "MICROMOBILITY" || mode === "SCOOTER") && rentedVehicle) {
+    return firstNetwork;
   }
   return null;
 }
@@ -225,7 +229,7 @@ export function getItineraryBounds(itinerary) {
     var legCoords = polyline.toGeoJSON(leg.legGeometry.points).coordinates.map(function (c) {
       return [c[1], c[0]];
     });
-    coords = [].concat(_toConsumableArray(coords), _toConsumableArray(legCoords));
+    coords.push.apply(coords, _toConsumableArray(legCoords));
   });
   return coords;
 }
@@ -248,51 +252,50 @@ export function getLegBounds(leg) {
 }
 
 /* Returns an interpolated lat-lon at a specified distance along a leg */
-
 export function legLocationAtDistance(leg, distance) {
-  if (!leg.legGeometry) return null;
+  if (!leg.legGeometry) return undefined;
   try {
+    var _pt$geometry;
     var line = polyline.toGeoJSON(leg.legGeometry.points);
     var pt = turfAlong(line, distance, {
       units: "meters"
     });
-    if (pt && pt.geometry && pt.geometry.coordinates) {
-      return [pt.geometry.coordinates[1], pt.geometry.coordinates[0]];
-    }
-  } catch (e) {
-    // FIXME handle error!
+    var coords = pt === null || pt === void 0 || (_pt$geometry = pt.geometry) === null || _pt$geometry === void 0 ? void 0 : _pt$geometry.coordinates;
+    return [coords[1], coords[0]];
+  } catch (_unused) {
+    // This is designed to catch the toGeoJSON from throwing if the geometry is not in the correct format
   }
   return null;
 }
 
-/* Returns an interpolated elevation at a specified distance along a leg */
+/**
+ * Returns an interpolated elevation at a specified distance along a leg
+ * @param points - The points of the elevation profile. Each point is a tuple of [distance, elevation].
+ * @param distance - The distance along the leg to interpolate the elevation at
+ * @returns The interpolated elevation at the specified distance
+ */
 
 export function legElevationAtDistance(points, distance) {
-  // Iterate through the combined elevation profile
-  var traversed = 0;
-  // If first point distance is not zero, insert starting point at zero with
-  // null elevation. Encountering this value should trigger the warning below.
-  if (points[0][0] > 0) {
-    points.unshift([0, null]);
-  }
-  for (var i = 1; i < points.length; i++) {
-    var start = points[i - 1];
-    var elevDistanceSpan = points[i][0] - start[0];
-    if (distance >= traversed && distance <= traversed + elevDistanceSpan) {
-      // Distance falls within this point and the previous one;
-      // compute & return interpolated elevation value
-      if (start[1] === null) {
-        console.warn("Elevation value does not exist for distance.", distance, traversed);
-        return null;
-      }
-      var pct = (distance - traversed) / elevDistanceSpan;
-      var elevSpan = points[i][1] - start[1];
-      return start[1] + elevSpan * pct;
+  var elevation = points.reduce(function (acc, point, index) {
+    var prevPoint = points[index - 1];
+    // at the first index there is no previous point
+    if (!prevPoint) return acc;
+    var _point = _slicedToArray(point, 2),
+      pointDistance = _point[0],
+      pointElevation = _point[1];
+    var _prevPoint = _slicedToArray(prevPoint, 2),
+      prevPointDistance = _prevPoint[0],
+      prevPointElevation = _prevPoint[1];
+    if (distance >= prevPointDistance && distance <= pointDistance) {
+      return prevPointElevation + (pointElevation - prevPointElevation) * (distance - prevPointDistance) / (pointDistance - prevPointDistance);
     }
-    traversed += elevDistanceSpan;
+    return acc;
+  }, undefined);
+  if (elevation === undefined) {
+    console.warn("Elevation value does not exist for distance.", distance);
+    return undefined;
   }
-  console.warn("Elevation value does not exist for distance.", distance, traversed);
-  return null;
+  return elevation;
 }
 export function mapOldElevationComponentToNew(oldElev) {
   return {
@@ -365,6 +368,7 @@ export function getTextWidth(text) {
   // reuse canvas object for better performance
   var canvas = getTextWidth.canvas || (getTextWidth.canvas = document.createElement("canvas"));
   var context = canvas.getContext("2d");
+  if (!context) return 0;
   context.font = font;
   var metrics = context.measureText(text);
   return metrics.width;
@@ -430,18 +434,16 @@ export function calculatePhysicalActivity(itinerary) {
  */
 export function calculateTncFares(itinerary) {
   return itinerary.legs.filter(function (leg) {
-    return leg.mode === "CAR" && leg.rideHailingEstimate;
-  }).reduce(function (_ref, _ref2) {
-    var maxTNCFare = _ref.maxTNCFare,
-      minTNCFare = _ref.minTNCFare;
-    var rideHailingEstimate = _ref2.rideHailingEstimate;
-    var minPrice = rideHailingEstimate.minPrice,
-      maxPrice = rideHailingEstimate.maxPrice;
+    return leg.mode === "CAR" && leg.rideHailingEstimate !== undefined;
+  }).reduce(function (acc, leg) {
+    var _leg$rideHailingEstim2 = leg.rideHailingEstimate,
+      minPrice = _leg$rideHailingEstim2.minPrice,
+      maxPrice = _leg$rideHailingEstim2.maxPrice;
     return {
       // Assumes a single currency for entire itinerary.
       currencyCode: minPrice.currency.code,
-      maxTNCFare: maxTNCFare + maxPrice.amount,
-      minTNCFare: minTNCFare + minPrice.amount
+      maxTNCFare: acc.maxTNCFare + maxPrice.amount,
+      minTNCFare: acc.minTNCFare + minPrice.amount
     };
   }, {
     currencyCode: null,
@@ -539,7 +541,6 @@ export var zeroDollars = function zeroDollars(currency) {
     currency: currency
   };
 };
-
 /**
  * Extracts useful data from the fare products on a leg, such as the leg cost and transfer info.
  * @param leg                Leg with Fares v2 information
@@ -555,9 +556,9 @@ export function getLegCost(leg, mediumId, riderCategoryId, seenFareIds) {
   if (!leg.fareProducts) return {
     price: undefined
   };
-  var relevantFareProducts = leg.fareProducts.filter(function (_ref3) {
+  var relevantFareProducts = leg.fareProducts.filter(function (_ref) {
     var _product$riderCategor, _product$riderCategor2, _product$medium, _product$medium2;
-    var product = _ref3.product;
+    var product = _ref.product;
     // riderCategory and medium can be specifically defined as null to handle
     // generic GTFS based fares from OTP when there is no fare model
 
@@ -567,13 +568,18 @@ export function getLegCost(leg, mediumId, riderCategoryId, seenFareIds) {
     return productRiderCategoryId === riderCategoryId && productMediaId === mediumId && (// Make sure there's a price
     // Some fare products don't have a price at all.
     product === null || product === void 0 ? void 0 : product.price);
+  })
+  // Make sure there's a price
+  // Some fare products don't have a price at all.
+  .filter(function (fare) {
+    var _fare$product;
+    return ((_fare$product = fare.product) === null || _fare$product === void 0 ? void 0 : _fare$product.price) !== undefined;
   }).map(function (fare) {
-    var alreadySeen = (seenFareIds === null || seenFareIds === void 0 ? void 0 : seenFareIds.indexOf(fare.id)) > -1;
-    var currency = fare.product.price.currency;
+    var alreadySeen = !!seenFareIds && (seenFareIds === null || seenFareIds === void 0 ? void 0 : seenFareIds.indexOf(fare.id)) > -1;
     return {
       id: fare.id,
       product: _objectSpread(_objectSpread({}, fare.product), {}, {
-        legPrice: alreadySeen ? zeroDollars(currency) : fare.product.price
+        legPrice: alreadySeen && fare.product.price ? zeroDollars(fare.product.price.currency) : fare.product.price
       })
     };
   }).sort(function (a, b) {
@@ -604,37 +610,47 @@ export function getLegCost(leg, mediumId, riderCategoryId, seenFareIds) {
  * @param category Rider category (youth, regular, senior)
  * @param container Fare container (cash, electronic)
  * @param seenFareIds List of fare product IDs that have already been seen on prev legs.
+ * @param nulledTotalFareOnAnyMissingFare If this is set to true, the total fare
+ * will be null if *any* fare is missing. If false, the total will be the total
+ * fare with the missing fares ignored.
  * @returns Money object for the total itinerary cost.
  */
 export function getItineraryCost(legs, mediumId, riderCategoryId) {
-  // TODO: Better input type handling
+  var nulledTotalFareOnAnyMissingFare = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
   if (Array.isArray(mediumId) || Array.isArray(riderCategoryId)) {
-    if ((mediumId === null || mediumId === void 0 ? void 0 : mediumId.length) !== riderCategoryId.length) {
-      console.warn("Invalid input types, only using first item. medium id list and rider category list must have same number of items");
-      return getItineraryCost(legs, mediumId[0], riderCategoryId[0]);
-    }
-    var total = {
-      amount: 0,
-      currency: null
-    };
-    for (var i = 0; i < mediumId.length; i++) {
-      var newCost = getItineraryCost(legs, mediumId[i], riderCategoryId[i]);
-      if (newCost) {
-        var _total, _total$currency;
-        total = {
-          amount: ((_total = total) === null || _total === void 0 ? void 0 : _total.amount) + ((newCost === null || newCost === void 0 ? void 0 : newCost.amount) || 0),
-          currency: (_total$currency = total.currency) !== null && _total$currency !== void 0 ? _total$currency : newCost === null || newCost === void 0 ? void 0 : newCost.currency
-        };
+    // TODO: Better input type handling
+    if (Array.isArray(mediumId) && Array.isArray(riderCategoryId)) {
+      var _total$currency;
+      if (mediumId.length !== riderCategoryId.length) {
+        console.warn("Invalid input types, only using first item. medium id list and rider category list must have same number of items");
+        return getItineraryCost(legs, mediumId[0], riderCategoryId[0]);
       }
+      var total = mediumId.reduce(function (acc, currentMediumId, index) {
+        var _newCost$currency;
+        var newCost = getItineraryCost(legs, currentMediumId, riderCategoryId[index]);
+        if (!newCost) return acc;
+        return {
+          amount: acc.amount + (newCost.amount || 0),
+          currency: acc.currency.code !== "" ? acc.currency : (_newCost$currency = newCost.currency) !== null && _newCost$currency !== void 0 ? _newCost$currency : acc.currency
+        };
+      }, {
+        amount: 0,
+        currency: {
+          code: "",
+          digits: 0
+        }
+      });
+      if (!((_total$currency = total.currency) !== null && _total$currency !== void 0 && _total$currency.code)) return undefined;
+      return total;
     }
-    if (total.currency === null) return undefined;
-    return total;
+    console.warn("Invalid input types, only using first item. medium id list and rider category list must have same number of items");
+    return undefined;
   }
   var legCosts = legs
   // Only legs with fares (no walking legs)
   .filter(function (leg) {
     var _leg$fareProducts;
-    return ((_leg$fareProducts = leg.fareProducts) === null || _leg$fareProducts === void 0 ? void 0 : _leg$fareProducts.length) > 0;
+    return ((_leg$fareProducts = leg.fareProducts) === null || _leg$fareProducts === void 0 ? void 0 : _leg$fareProducts.length) && leg.fareProducts.length > 0;
   })
   // Get the leg cost object of each leg
   .reduce(function (acc, leg) {
@@ -646,6 +662,7 @@ export function getItineraryCost(legs, mediumId, riderCategoryId) {
       appliedFareProduct = _getLegCost.appliedFareProduct,
       productUseId = _getLegCost.productUseId;
     if (!appliedFareProduct) return acc;
+    if (!productUseId) return acc;
     return {
       legCosts: [].concat(_toConsumableArray(acc.legCosts), [appliedFareProduct]),
       seenIds: [].concat(_toConsumableArray(acc.seenIds), [productUseId])
@@ -656,17 +673,26 @@ export function getItineraryCost(legs, mediumId, riderCategoryId) {
   }).legCosts.map(function (lc) {
     return lc.legPrice;
   });
+  if (nulledTotalFareOnAnyMissingFare && legs.filter(function (l) {
+    return l.transitLeg;
+  }).length !== legCosts.length) {
+    return undefined;
+  }
   if (legCosts.length === 0) return undefined;
   // Calculate the total
   return legCosts.reduce(function (prev, cur) {
-    var _prev$currency;
     return {
       amount: prev.amount + (cur === null || cur === void 0 ? void 0 : cur.amount) || 0,
-      currency: (_prev$currency = prev.currency) !== null && _prev$currency !== void 0 ? _prev$currency : cur === null || cur === void 0 ? void 0 : cur.currency
+      currency: prev.currency.code !== "" ? prev.currency : cur.currency
     };
-  }, {
+  },
+  // eslint-disable-next-line prettier/prettier -- old eslint doesn't know satisfies
+  {
     amount: 0,
-    currency: null
+    currency: {
+      code: "",
+      digits: 0
+    }
   });
 }
 var pickupDropoffTypeToOtp1 = function pickupDropoffTypeToOtp1(otp2Type) {