@opentripplanner/core-utils 14.0.0-alpha.1 → 14.0.0

package/src/__tests__/query.js

@@ -13,7 +13,7 @@ import {
   planParamsToQuery
 } from "../query";
 
-const config = require("./__mocks__/config.json");
+import config from "./__mocks__/config.json";
 
 describe("query", () => {
   afterEach(restoreDateNowBehavior);

package/src/__tests__/route.js

@@ -5,7 +5,7 @@ import {
   makeRouteComparator
 } from "../route";
 
-const { otp1Routes, otp2Routes } = require("./__mocks__/routes.json");
+import { otp1Routes, otp2Routes } from "./__mocks__/routes.json";
 
 function sortRoutes(...routes) {
   routes.sort(makeRouteComparator());

package/src/core-utils.story.tsx

@@ -1,3 +1,4 @@
+/* eslint-disable react/display-name */
 import React, { useState } from "react";
 import styled from "styled-components";
 import {
@@ -42,29 +43,39 @@ const ColorPair = ({ fg, bg }: { fg: string; bg: string }) => {
   );
 };
 
-export const RouteColorTester = (): JSX.Element => {
-  const [fg, setFg] = useState("#333333");
-  const [bg, setBg] = useState("#cbeb55");
-  return (
-    <>
-      <ColorPair bg={bg} fg={fg}></ColorPair>
-      {/* eslint-disable-next-line jsx-a11y/label-has-associated-control */}
-      <label>
-        Foreground Color
-        <input onChange={e => setFg(e.target.value)} type="color" value={fg} />
-      </label>
-      {/* eslint-disable-next-line jsx-a11y/label-has-associated-control */}
-      <label>
-        Background Color
-        <input onChange={e => setBg(e.target.value)} type="color" value={bg} />
-      </label>
-    </>
-  );
-};
-// Disable color contrast checking for the uncorrected color pairs.
-RouteColorTester.parameters = {
-  a11y: { config: { rules: [{ id: "color-contrast", reviewOnFail: true }] } },
-  storyshots: { disable: true }
+export const RouteColorTester = {
+  render: (): JSX.Element => {
+    const [fg, setFg] = useState("#333333");
+    const [bg, setBg] = useState("#cbeb55");
+    return (
+      <>
+        <ColorPair bg={bg} fg={fg}></ColorPair>
+        {/* eslint-disable-next-line jsx-a11y/label-has-associated-control */}
+        <label>
+          Foreground Color
+          <input
+            onChange={e => setFg(e.target.value)}
+            type="color"
+            value={fg}
+          />
+        </label>
+        {/* eslint-disable-next-line jsx-a11y/label-has-associated-control */}
+        <label>
+          Background Color
+          <input
+            onChange={e => setBg(e.target.value)}
+            type="color"
+            value={bg}
+          />
+        </label>
+      </>
+    );
+  },
+  // Disable color contrast checking for the uncorrected color pairs
+  parameters: {
+    a11y: { config: { rules: [{ id: "color-contrast", reviewOnFail: true }] } },
+    storyshots: { disable: true }
+  }
 };
 
 // Route sort logic story:

package/src/itinerary.ts

@@ -1,7 +1,9 @@
 import polyline from "@mapbox/polyline";
 import {
+  AppliedFareProduct,
   Company,
   Config,
+  Currency,
   ElevationProfile,
   ElevationProfileComponent,
   FlexBookingInfo,
@@ -104,8 +106,6 @@ export function isFlex(leg: Leg): boolean {
     legContainsGeometry(leg)
   );
 }
-
-// alpha-only comment
 export function isRideshareLeg(leg: Leg): boolean {
   return !!leg.rideHailingEstimate?.provider?.id;
 }
@@ -246,6 +246,9 @@ export function getCompanyFromLeg(leg: Leg): string {
   if (from.rentalVehicle) {
     return from.rentalVehicle.network;
   }
+  if (from.vehicleRentalStation?.rentalNetwork) {
+    return from.vehicleRentalStation.rentalNetwork.networkId;
+  }
   if (
     (mode === "MICROMOBILITY" || mode === "SCOOTER") &&
     rentedVehicle &&
@@ -606,45 +609,91 @@ export function getDisplayedStopId(placeOrStop: Place | Stop): string {
   return stopCode || stopId?.split(":")[1] || stopId;
 }
 
+/**
+ * Removes the first part of the OTP standard scope (":"), if it is present
+ * @param item String that is potentially scoped with `:` character
+ * @returns    descoped string
+ */
+export const descope = (item: string): string => item?.split(":")?.[1];
+
+export type ExtendedMoney = Money & { originalAmount?: number };
+
+export const zeroDollars = (currency: Currency): Money => ({
+  amount: 0,
+  currency
+});
+
 /**
  * Extracts useful data from the fare products on a leg, such as the leg cost and transfer info.
- * @param leg Leg with fare products (must have used getLegsWithFares)
- * @param category Rider category
- * @param container Fare container (cash, electronic)
- * @returns Object containing price as well as the transfer discount amount, if a transfer was used.
+ * @param leg                Leg with Fares v2 information
+ * @param mediumId           Desired medium ID to calculate fare for
+ * @param riderCategoryId    Desire rider category to calculate fare for
+ * @param seenFareIds        Fare IDs used on previous legs. Used to detect transfer discounts.
+ * @returns                  Object containing price as well as transfer/dependent
+ *                           fare information. `AppliedFareProduct` should contain
+ *                           all the information needed, but the other fields are kept to
+ *                           make the transition to Fares V2 less jarring.
  */
 export function getLegCost(
   leg: Leg,
   mediumId: string | null,
-  riderCategoryId: string | null
+  riderCategoryId: string | null,
+  seenFareIds?: string[]
 ): {
+  alternateFareProducts?: AppliedFareProduct[];
+  appliedFareProduct?: AppliedFareProduct;
+  isDependent?: boolean;
   price?: Money;
-  transferAmount?: Money | undefined;
   productUseId?: string;
 } {
   if (!leg.fareProducts) return { price: undefined };
-  const relevantFareProducts = leg.fareProducts.filter(({ product }) => {
-    // riderCategory and medium can be specifically defined as null to handle
-    // generic GTFS based fares from OTP when there is no fare model
-    return (
-      (product.riderCategory === null ? null : product.riderCategory.id) ===
-        riderCategoryId &&
-      (product.medium === null ? null : product.medium.id) === mediumId
-    );
-  });
-
-  // Custom fare models return "rideCost", generic GTFS fares return "regular"
-  const totalCostProduct = relevantFareProducts.find(
-    fp => fp.product.name === "rideCost" || fp.product.name === "regular"
-  );
-  const transferFareProduct = relevantFareProducts.find(
-    fp => fp.product.name === "transfer"
-  );
-
+  const relevantFareProducts = leg.fareProducts
+    .filter(({ product }) => {
+      // riderCategory and medium can be specifically defined as null to handle
+      // generic GTFS based fares from OTP when there is no fare model
+
+      // Remove (optional) agency scoping
+      const productRiderCategoryId =
+        descope(product?.riderCategory?.id) ||
+        product?.riderCategory?.id ||
+        null;
+
+      const productMediaId =
+        descope(product?.medium?.id) || product?.medium?.id || null;
+      return (
+        productRiderCategoryId === riderCategoryId &&
+        productMediaId === mediumId &&
+        // Make sure there's a price
+        // Some fare products don't have a price at all.
+        product?.price
+      );
+    })
+    .map(fare => {
+      const alreadySeen = seenFareIds?.indexOf(fare.id) > -1;
+      const { currency } = fare.product.price;
+      return {
+        id: fare.id,
+        product: {
+          ...fare.product,
+          legPrice: alreadySeen ? zeroDollars(currency) : fare.product.price
+        } as AppliedFareProduct
+      };
+    })
+    .sort((a, b) => a.product?.legPrice?.amount - b.product?.legPrice?.amount);
+
+  // Return the cheapest, but include other matches as well
+  const cheapestRelevantFareProduct = relevantFareProducts[0];
+
+  // TODO: return one object here instead of dumbing it down?
   return {
-    price: totalCostProduct?.product.price,
-    transferAmount: transferFareProduct?.product.price,
-    productUseId: totalCostProduct?.id
+    alternateFareProducts: relevantFareProducts.splice(1).map(fp => fp.product),
+    appliedFareProduct: cheapestRelevantFareProduct?.product,
+    isDependent:
+      // eslint-disable-next-line no-underscore-dangle
+      cheapestRelevantFareProduct?.product.__typename ===
+      "DependentFareProduct",
+    price: cheapestRelevantFareProduct?.product.legPrice,
+    productUseId: cheapestRelevantFareProduct?.id
   };
 }
 
@@ -653,6 +702,7 @@ export function getLegCost(
  * @param legs Itinerary legs with fare products (must have used getLegsWithFares)
  * @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.
  * @returns Money object for the total itinerary cost.
  */
 export function getItineraryCost(
@@ -660,22 +710,23 @@ export function getItineraryCost(
   mediumId: string | null,
   riderCategoryId: string | null
 ): Money | undefined {
-  const legCosts = legs
+  const legCostsObj = legs
     // Only legs with fares (no walking legs)
     .filter(leg => leg.fareProducts?.length > 0)
     // Get the leg cost object of each leg
     .map(leg => getLegCost(leg, mediumId, riderCategoryId))
-    .filter(cost => cost.price !== undefined)
+    .filter(cost => cost.appliedFareProduct?.legPrice !== undefined)
     // Filter out duplicate use IDs
     // One fare product can be used on multiple legs,
     // and we don't want to count it more than once.
-    .reduce<{ productUseId: string; price: Money }[]>((prev, cur) => {
-      if (!prev.some(p => p.productUseId === cur.productUseId)) {
-        prev.push({ productUseId: cur.productUseId, price: cur.price });
+    // Use an object keyed by productUseId to deduplicate, then extract prices
+    .reduce<{ [productUseId: string]: Money }>((acc, cur) => {
+      if (cur.productUseId && acc[cur.productUseId] === undefined) {
+        acc[cur.productUseId] = cur.appliedFareProduct?.legPrice;
       }
-      return prev;
-    }, [])
-    .map(productUse => productUse.price);
+      return acc;
+    }, {});
+  const legCosts = Object.values(legCostsObj);
 
   if (legCosts.length === 0) return undefined;
   // Calculate the total