@opentripplanner/core-utils 9.0.0-alpha.3 → 9.0.0-alpha.30

package/src/__tests__/{query-params.js → query-params.ts}

@@ -1,6 +1,8 @@
+import { ModeSetting, TransportMode } from "@opentripplanner/types";
+
 import { reduceOtpFlexModes } from "../query";
 import queryParams, { getCustomQueryParams } from "../query-params";
-import { generateCombinations } from "../query-gen";
+import { extractAdditionalModes, generateCombinations } from "../query-gen";
 
 const customWalkDistanceOptions = [
   {
@@ -13,7 +15,7 @@ const customWalkDistanceOptions = [
   }
 ];
 
-function modeStrToTransportMode(m) {
+function modeStrToTransportMode(m): TransportMode {
   const splitVals = m.split("_");
   return {
     mode: splitVals[0],
@@ -26,18 +28,18 @@ const mockLatLon = {
   lon: 2
 };
 
-function expectModes(modes, expectedModes) {
+function expectModes(modes: string[], expectedModes: string[][]) {
   const generatedModesList = generateCombinations({
-    modes: modes.map(modeStrToTransportMode),
-    to: mockLatLon,
     from: mockLatLon,
-    modeSettings: []
+    modes: modes.map(modeStrToTransportMode),
+    modeSettings: [],
+    to: mockLatLon
   });
   const expandedExpectedModesList = expectedModes.map(em => ({
-    modes: em.map(modeStrToTransportMode),
-    to: mockLatLon,
     from: mockLatLon,
-    modeSettings: []
+    modes: em.map(modeStrToTransportMode),
+    modeSettings: [],
+    to: mockLatLon
   }));
   return it(
     modes.join(" "),
@@ -49,6 +51,59 @@ function expectModes(modes, expectedModes) {
   );
 }
 
+describe("extract-modes", () => {
+  const mode = {
+    mode: "UNICYCLE"
+  };
+
+  const testTransportMode: TransportMode = {
+    mode: "testMode"
+  };
+
+  const checkboxModeSetting: ModeSetting = {
+    addTransportMode: mode,
+    applicableMode: testTransportMode.mode,
+    icon: null,
+    key: "test",
+    label: "test",
+    type: "CHECKBOX",
+    value: true
+  };
+
+  const dropdownModeSetting: ModeSetting = {
+    applicableMode: testTransportMode.mode,
+    key: "test",
+    label: "test",
+    options: [{ text: "testOption", value: "1", addTransportMode: mode }],
+    type: "DROPDOWN",
+    value: "1"
+  };
+
+  it("determines whether a checkbox setting is extracted correctly", () => {
+    expect(
+      extractAdditionalModes([checkboxModeSetting], [testTransportMode])
+    ).toEqual([mode]);
+  });
+  it("determines whether a dropdown setting is extracted correctly", () => {
+    expect(
+      extractAdditionalModes([dropdownModeSetting], [testTransportMode])
+    ).toEqual([mode]);
+  });
+  it("determines whether a checkbox setting set to false is ignored", () => {
+    expect(
+      extractAdditionalModes(
+        [{ ...checkboxModeSetting, value: false }],
+        [testTransportMode]
+      )
+    ).toEqual([]);
+  });
+  it("determines whether a checkbox setting with no modes is ignored", () => {
+    expect(extractAdditionalModes([{ ...checkboxModeSetting }], [])).toEqual(
+      []
+    );
+  });
+});
+
 describe("query-gen", () => {
   describe("generateCombinations", () => {
     expectModes(["WALK"], [["WALK"]]);
@@ -93,6 +148,10 @@ describe("query-gen", () => {
         ["WALK"]
       ]
     );
+    expectModes(
+      ["BICYCLE_RENT", "BICYCLE", "WALK"],
+      [["BICYCLE_RENT", "WALK"], ["BICYCLE"], ["WALK"]]
+    );
     expectModes(
       ["SCOOTER_RENT", "BICYCLE_RENT", "TRANSIT", "WALK"],
       [
@@ -104,6 +163,26 @@ describe("query-gen", () => {
         ["WALK"]
       ]
     );
+
+    expectModes(
+      ["CAR_HAIL", "TRANSIT"],
+      [["TRANSIT"], ["CAR_HAIL", "TRANSIT"]]
+    );
+    expectModes(
+      ["CAR_HAIL", "BICYCLE_RENT", "TRANSIT"],
+      [["TRANSIT"], ["CAR_HAIL", "TRANSIT"], ["BICYCLE_RENT", "TRANSIT"]]
+    );
+    expectModes(
+      ["CAR_HAIL", "BICYCLE_RENT", "TRANSIT", "WALK"],
+      [
+        ["TRANSIT"],
+        ["CAR_HAIL", "TRANSIT"],
+        ["CAR_HAIL", "WALK"],
+        ["BICYCLE_RENT", "TRANSIT"],
+        ["BICYCLE_RENT", "WALK"],
+        ["WALK"]
+      ]
+    );
     expectModes(
       ["FLEX", "TRANSIT", "WALK"],
       [["TRANSIT"], ["FLEX", "TRANSIT"], ["FLEX", "WALK"], ["WALK"]]
@@ -131,9 +210,15 @@ describe("query-gen", () => {
       ]
     );
     expectModes(
-      ["BUS", "RAIL", "GONDOLA", "TRAM"],
+      // Transit is required to enable other transit submodes
+      ["BUS", "RAIL", "GONDOLA", "TRAM", "TRANSIT"],
       [["BUS", "RAIL", "GONDOLA", "TRAM"]]
     );
+    expectModes(
+      // Transit is required to enable other transit submodes
+      ["TRANSIT"],
+      [["TRANSIT"]]
+    );
   });
 });
 

package/src/core-utils.story.tsx

@@ -50,7 +50,7 @@ export const RouteColorTester = (): JSX.Element => {
     </>
   );
 };
-// Disable color contrast checking for the uncorrected color pairs
+// Disable color contrast checking for the uncorrected color pairs.
 RouteColorTester.parameters = {
   a11y: { config: { rules: [{ id: "color-contrast", reviewOnFail: true }] } },
   storyshots: { disable: true }

package/src/itinerary.ts

@@ -4,9 +4,10 @@ import {
   Config,
   ElevationProfile,
   FlexBookingInfo,
-  Itinerary,
+  ItineraryOnlyLegsRequired,
   LatLngArray,
   Leg,
+  MassUnitOption,
   Money,
   Place,
   Step,
@@ -77,6 +78,11 @@ export function legDropoffRequiresAdvanceBooking(leg: Leg): boolean {
   return isAdvanceBookingRequired(leg.dropOffBookingInfo);
 }
 
+// alpha-only comment
+export function isRideshareLeg(leg: Leg): boolean {
+  return !!leg.rideHailingEstimate?.provider?.id;
+}
+
 export function isWalk(mode: string): boolean {
   if (!mode) return false;
 
@@ -192,16 +198,26 @@ export function toSentenceCase(str: string): string {
  */
 export function getCompanyFromLeg(leg: Leg): string {
   if (!leg) return null;
-  const { from, mode, rentedBike, rentedCar, rentedVehicle, tncData } = leg;
+  const {
+    from,
+    mode,
+    rentedBike,
+    rentedCar,
+    rentedVehicle,
+    rideHailingEstimate
+  } = leg;
   if (mode === "CAR" && rentedCar) {
     return from.networks[0];
   }
-  if (mode === "CAR" && tncData) {
-    return tncData.company;
+  if (mode === "CAR" && rideHailingEstimate) {
+    return rideHailingEstimate.provider.id;
   }
   if (mode === "BICYCLE" && rentedBike && from.networks) {
     return from.networks[0];
   }
+  if (from.rentalVehicle) {
+    return from.rentalVehicle.network;
+  }
   if (
     (mode === "MICROMOBILITY" || mode === "SCOOTER") &&
     rentedVehicle &&
@@ -212,7 +228,9 @@ export function getCompanyFromLeg(leg: Leg): string {
   return null;
 }
 
-export function getItineraryBounds(itinerary: Itinerary): LatLngArray[] {
+export function getItineraryBounds(
+  itinerary: ItineraryOnlyLegsRequired
+): LatLngArray[] {
   let coords = [];
   itinerary.legs.forEach(leg => {
     const legCoords = polyline
@@ -391,10 +409,13 @@ export function getCompanyForNetwork(
  * @return {string}  A label for use in presentation on a website.
  */
 export function getCompaniesLabelFromNetworks(
-  networks: string[],
+  networks: string | string[],
   companies: Company[] = []
 ): string {
-  return networks
+  let networksArray = networks;
+  if (typeof networks === "string") networksArray = [networks];
+
+  return (networksArray as string[])
     .map(network => getCompanyForNetwork(network, companies))
     .filter(co => !!co)
     .map(co => co.label)
@@ -407,7 +428,7 @@ export function getTNCLocation(leg: Leg, type: string): string {
 }
 
 export function calculatePhysicalActivity(
-  itinerary: Itinerary
+  itinerary: ItineraryOnlyLegsRequired
 ): {
   bikeDuration: number;
   caloriesBurned: number;
@@ -433,17 +454,19 @@ export function calculatePhysicalActivity(
  * these values and currency info.
  * It is assumed that the same currency is used for all TNC legs.
  */
-export function calculateTncFares(itinerary: Itinerary): TncFare {
+export function calculateTncFares(
+  itinerary: ItineraryOnlyLegsRequired
+): TncFare {
   return itinerary.legs
-    .filter(leg => leg.mode === "CAR" && leg.hailedCar && leg.tncData)
+    .filter(leg => leg.mode === "CAR" && leg.rideHailingEstimate)
     .reduce(
-      ({ maxTNCFare, minTNCFare }, { tncData }) => {
-        const { currency, maxCost, minCost } = tncData;
+      ({ maxTNCFare, minTNCFare }, { rideHailingEstimate }) => {
+        const { minPrice, maxPrice } = rideHailingEstimate;
         return {
           // Assumes a single currency for entire itinerary.
-          currencyCode: currency,
-          maxTNCFare: maxTNCFare + maxCost,
-          minTNCFare: minTNCFare + minCost
+          currencyCode: minPrice.currency.code,
+          maxTNCFare: maxTNCFare + maxPrice.amount,
+          minTNCFare: minTNCFare + minPrice.amount
         };
       },
       {
@@ -454,27 +477,6 @@ export function calculateTncFares(itinerary: Itinerary): TncFare {
     );
 }
 
-/**
- * For a given fare component (either total fare or component parts), returns
- * an object with the fare value (in cents).
- */
-export function getTransitFare(
-  fareComponent: Money
-): {
-  currencyCode: string;
-  transitFare: number;
-} {
-  return fareComponent
-    ? {
-        currencyCode: fareComponent.currency.currencyCode,
-        transitFare: fareComponent.cents
-      }
-    : {
-        currencyCode: "USD",
-        transitFare: 0
-      };
-}
-
 /**
  * Sources:
  * - https://www.itf-oecd.org/sites/default/files/docs/environmental-performance-new-mobility.pdf
@@ -501,15 +503,16 @@ const CARBON_INTENSITY_DEFAULTS = {
 };
 
 /**
- * @param  {itinerary} itinerary OTP trip itinierary
- * @param  {carbonIntensity} carbonIntensity carbon intensity by mode in grams/meter
+ * @param {itinerary} itinerary OTP trip itinierary, only legs is required.
+ * @param {carbonIntensity} carbonIntensity carbon intensity by mode in grams/meter
  * @param {units} units units to be used in return value
  * @return Amount of carbon in chosen unit
  */
 export function calculateEmissions(
-  itinerary: Itinerary,
+  // This type makes all the properties from Itinerary optional except legs.
+  itinerary: ItineraryOnlyLegsRequired,
   carbonIntensity: Record<string, number> = {},
-  units?: string
+  units?: MassUnitOption
 ): number {
   // Apply defaults for any values that we don't have.
   const carbonIntensityWithDefaults = {
@@ -555,3 +558,59 @@ export function getDisplayedStopId(placeOrStop: Place | Stop): string {
   }
   return stopCode || stopId?.split(":")[1] || stopId;
 }
+
+/**
+ * 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.
+ */
+export function getLegCost(
+  leg: Leg,
+  mediumId: string,
+  riderCategoryId: string
+): { price: Money; transferAmount?: Money | undefined } {
+  if (!leg.fareProducts) return { price: undefined };
+  const relevantFareProducts = leg.fareProducts.filter(({ product }) => {
+    return (
+      product.riderCategory.id === riderCategoryId &&
+      product.medium.id === mediumId
+    );
+  });
+  const totalCost = relevantFareProducts.find(
+    fp => fp.product.name === "rideCost"
+  )?.product?.price;
+  const transferFareProduct = relevantFareProducts.find(
+    fp => fp.product.name === "transfer"
+  );
+
+  return {
+    price: totalCost,
+    transferAmount: transferFareProduct?.product.price
+  };
+}
+
+/**
+ * Returns the total itinerary cost for a given set of legs.
+ * @param legs Itinerary legs with fare products (must have used getLegsWithFares)
+ * @param category Rider category (youth, regular, senior)
+ * @param container Fare container (cash, electronic)
+ * @returns Money object for the total itinerary cost.
+ */
+export function getItineraryCost(
+  legs: Leg[],
+  category: string,
+  container: string
+): Money {
+  return legs
+    .filter(leg => !!leg.fareProducts)
+    .map(leg => getLegCost(leg, category, container).price)
+    .reduce<Money>(
+      (prev, cur) => ({
+        amount: prev.amount + cur?.amount || 0,
+        currency: prev.currency ?? cur?.currency
+      }),
+      { amount: 0, currency: null }
+    );
+}