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

package/src/__tests__/__snapshots__/route.js.snap

@@ -1,15 +1,15 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`util > route routeComparator should prioritize OTP1 routes with valid sortOrder 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "Around town",
     "mode": "BUS",
     "shortName": "20",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Around another town",
     "shortName": "3",
@@ -20,20 +20,20 @@ Array [
 `;
 
 exports[`util > route routeComparator should prioritize OTP2 routes with valid sortOrder 1`] = `
-Array [
-  Object {
+[
+  {
     "longName": "Loop route",
     "mode": "BUS",
     "shortName": "2",
     "sortOrder": -999,
   },
-  Object {
+  {
     "longName": "Across town",
     "mode": "BUS",
     "shortName": "10",
     "sortOrder": 10,
   },
-  Object {
+  {
     "longName": "Around another town",
     "shortName": "3",
     "sortOrder": null,
@@ -43,15 +43,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should prioritize routes with alphabetic shortNames over integer shortNames 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "A-line",
     "mode": "BUS",
     "shortName": "A",
     "sortOrder": -999,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Loop route",
     "mode": "BUS",
@@ -62,15 +62,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should prioritize routes with shortNames over those with just longNames 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "B-line",
     "mode": "BUS",
     "shortName": "B",
     "sortOrder": -999,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "A meandering route",
     "mode": "BUS",
@@ -80,8 +80,8 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort OTP1 routes on all of the criteria at once 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "abc",
     "agencyName": "Acclaimed agency 1",
     "longName": "Express route X",
@@ -90,7 +90,7 @@ Array [
     "shortName": "30X",
     "sortOrder": 10,
   },
-  Object {
+  {
     "agencyId": "abc",
     "agencyName": "Agency 1",
     "longName": "Intercity Train 2",
@@ -99,104 +99,104 @@ Array [
     "shortName": "IC",
     "sortOrder": 10,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Yellow line Subway",
     "mode": "SUBWAY",
     "shortName": "Yellow",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Intercity Train",
     "mode": "RAIL",
     "shortName": "IC",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Local route",
     "mode": "BUS",
     "shortName": "6",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Around town",
     "mode": "BUS",
     "shortName": "20",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Express route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Variation of express route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Zig-zagging route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Xpress route C",
     "mode": "BUS",
     "shortName": "30C",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Across town",
     "mode": "BUS",
     "shortName": "10",
     "sortOrder": 10,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "A-line",
     "mode": "BUS",
     "shortName": "A",
     "sortOrder": -999,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "B-line",
     "mode": "BUS",
     "shortName": "B",
     "sortOrder": -999,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Loop route",
     "mode": "BUS",
     "shortName": "2",
     "sortOrder": -999,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Around another town",
     "shortName": "3",
     "sortOrder": -999,
     "type": 3,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Express route X",
     "mode": "BUS",
     "shortName": "30X",
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "A meandering route",
     "mode": "BUS",
@@ -206,9 +206,9 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort OTP2 routes on all of the criteria at once 1`] = `
-Array [
-  Object {
-    "agency": Object {
+[
+  {
+    "agency": {
       "id": "abc",
       "name": "Acclaimed agency 1",
     },
@@ -218,8 +218,8 @@ Array [
     "shortName": "30X",
     "sortOrder": 2,
   },
-  Object {
-    "agency": Object {
+  {
+    "agency": {
       "id": "abc",
       "name": "Agency 1",
     },
@@ -229,90 +229,90 @@ Array [
     "shortName": "IC",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "A-line",
     "mode": "BUS",
     "shortName": "A",
     "sortOrder": -999,
   },
-  Object {
+  {
     "longName": "Loop route",
     "mode": "BUS",
     "shortName": "2",
     "sortOrder": -999,
   },
-  Object {
+  {
     "longName": "Yellow line Subway",
     "mode": "SUBWAY",
     "shortName": "Yellow",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Intercity Train",
     "mode": "RAIL",
     "shortName": "IC",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Local route",
     "mode": "BUS",
     "shortName": "6",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Around town",
     "mode": "BUS",
     "shortName": "20",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Express route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Variation of express route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Zig-zagging route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Xpress route C",
     "mode": "BUS",
     "shortName": "30C",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Express route X",
     "mode": "BUS",
     "shortName": "30X",
     "sortOrder": 2,
   },
-  Object {
+  {
     "longName": "Across town",
     "mode": "BUS",
     "shortName": "10",
     "sortOrder": 10,
   },
-  Object {
+  {
     "longName": "B-line",
     "mode": "BUS",
     "shortName": "B",
   },
-  Object {
+  {
     "longName": "Around another town",
     "shortName": "3",
     "sortOrder": null,
     "type": 3,
   },
-  Object {
+  {
     "longName": "A meandering route",
     "mode": "BUS",
   },
@@ -320,15 +320,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort based off of route type 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "Yellow line Subway",
     "mode": "SUBWAY",
     "shortName": "Yellow",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Intercity Train",
     "mode": "RAIL",
@@ -339,8 +339,8 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort routes based off of agencyName if no transitOperators are defined 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "abc",
     "agencyName": "Acclaimed agency 1",
     "longName": "Express route X",
@@ -349,7 +349,7 @@ Array [
     "shortName": "30X",
     "sortOrder": 10,
   },
-  Object {
+  {
     "agencyId": "abc",
     "agencyName": "Agency 1",
     "longName": "Intercity Train 2",
@@ -362,15 +362,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort routes based off of integer shortName 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "Loop route",
     "mode": "BUS",
     "shortName": "2",
     "sortOrder": -999,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Around another town",
     "shortName": "3",
@@ -381,15 +381,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort routes based off of longNames 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "Express route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Variation of express route",
     "mode": "BUS",
@@ -400,15 +400,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort routes based off of shortNames 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "A-line",
     "mode": "BUS",
     "shortName": "A",
     "sortOrder": -999,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "B-line",
     "mode": "BUS",
@@ -419,15 +419,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort routes based off of sortOrder 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "Around town",
     "mode": "BUS",
     "shortName": "20",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Across town",
     "mode": "BUS",
@@ -438,8 +438,8 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort routes based off of transitOperators sort value when a match is found 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "abc",
     "agencyName": "Agency 1",
     "longName": "Intercity Train 2",
@@ -448,7 +448,7 @@ Array [
     "shortName": "IC",
     "sortOrder": 10,
   },
-  Object {
+  {
     "agencyId": "abc",
     "agencyName": "Acclaimed agency 1",
     "longName": "Express route X",
@@ -461,15 +461,15 @@ Array [
 `;
 
 exports[`util > route routeComparator should sort routes with alphanumeric shortNames 1`] = `
-Array [
-  Object {
+[
+  {
     "agencyId": "bcd",
     "longName": "Xpress route C",
     "mode": "BUS",
     "shortName": "30C",
     "sortOrder": 2,
   },
-  Object {
+  {
     "agencyId": "bcd",
     "longName": "Express route X",
     "mode": "BUS",

package/src/__tests__/__snapshots__/time.js.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`time getCurrentDate should return current date at specified timezone 1`] = `"2019-08-04"`;
 
@@ -13,7 +13,7 @@ exports[`time getUserTimezone should get the correct timezone from the testing e
 exports[`time time format functions should correctly format 9401 seconds as a duration since midnight 1`] = `"02:36"`;
 
 exports[`time toHoursMinutesSeconds should correctly break down 9401 in hours, minutes, and seconds 1`] = `
-Object {
+{
   "hours": 2,
   "minutes": 36,
   "seconds": 41,

package/src/__tests__/itinerary.ts

@@ -14,10 +14,13 @@ import {
   mapOldElevationComponentToNew
 } from "../itinerary";
 
-const bikeRentalItinerary = require("./__mocks__/bike-rental-itinerary.json");
-const tncItinerary = require("./__mocks__/tnc-itinerary.json");
-const fareProductItinerary = require("./__mocks__/fare-products-itinerary.json");
-const flexItinerary = require("../../../itinerary-body/src/__mocks__/itineraries/flex-itinerary.json");
+import bikeRentalItinerary from "./__mocks__/bike-rental-itinerary.json";
+import tncItinerary from "./__mocks__/tnc-itinerary.json";
+import fareProductItinerary from "./__mocks__/fare-products-itinerary.json";
+import flexItinerary from "../../../itinerary-body/src/__mocks__/itineraries/flex-itinerary.json";
+import faresv2Itinerary from "../../../itinerary-body/src/__mocks__/itineraries/fares-v2-fare-components.json";
+
+global.structuredClone = val => JSON.parse(JSON.stringify(val));
 
 const basePlace = {
   lat: 0,
@@ -129,37 +132,100 @@ describe("util > itinerary", () => {
   });
 
   describe("getLegCost", () => {
+    const freeLeg = {
+      fareProducts: [
+        {
+          id: "testId",
+          product: {
+            medium: null,
+            name: "rideCost",
+            price: { amount: 0, currency: "USD" },
+            riderCategory: null
+          }
+        }
+      ]
+    };
     const leg = {
       fareProducts: [
         {
           id: "testId",
           product: {
-            medium: { id: "cash" },
+            medium: null,
             name: "rideCost",
             price: { amount: 200, currency: "USD" },
-            riderCategory: { id: "regular" }
+            riderCategory: null
           }
         },
         {
           id: "testId",
           product: {
-            medium: { id: "cash" },
-            name: "transfer",
+            medium: null,
+            name: "transfer-from-other-vehicle",
             price: { amount: 50, currency: "USD" },
-            riderCategory: { id: "regular" }
+            riderCategory: null
+          }
+        }
+      ]
+    };
+    const complicatedLeg = {
+      fareProducts: [
+        {
+          id: "testId",
+          product: {
+            medium: { id: "agency:cash" },
+            name: "transfer-from-other-vehicle",
+            price: { amount: 50, currency: "USD" },
+            riderCategory: { id: "agency:child" }
+          }
+        },
+        {
+          id: "testId",
+          product: {
+            medium: "cash",
+            name: "rideCost",
+            price: { amount: 200, currency: "USD" },
+            riderCategory: "adult"
+          }
+        }
+      ]
+    };
+    const halfLeg = {
+      fareProducts: [
+        {
+          id: "testId",
+          product: {
+            medium: { id: "agency:cash" },
+            name: "rideCost",
+            price: { amount: 30, currency: "USD" },
+            riderCategory: null
+          }
+        },
+        {
+          id: "testId2",
+          product: {
+            medium: { id: "agency:digital" },
+            name: "rideCost",
+            price: { amount: 20, currency: "USD" },
+            riderCategory: null
           }
         }
       ]
     };
     it("should return the total cost for a leg", () => {
-      const result = getLegCost(leg, "cash", "regular");
-      expect(result.price).toEqual({ amount: 200, currency: "USD" });
+      const result = getLegCost(leg, null, null);
+      expect(result.price).toEqual({ amount: 50, currency: "USD" });
     });
-
-    it("should return the transfer discount amount if a transfer was used", () => {
-      const result = getLegCost(leg, "cash", "regular");
-      expect(result.price).toEqual({ amount: 200, currency: "USD" });
-      expect(result.transferAmount).toEqual({ amount: 50, currency: "USD" });
+    it("should return the 0 cost for a free leg", () => {
+      const result = getLegCost(freeLeg, null, null);
+      expect(result.price).toEqual({ amount: 0, currency: "USD" });
+    });
+    it("should return the correct cost for a leg with multiple types of fares", () => {
+      const result = getLegCost(complicatedLeg, "cash", "child");
+      expect(result.price).toEqual({ amount: 50, currency: "USD" });
+    });
+    it("should return the correct cost for a leg with no rider category", () => {
+      const result = getLegCost(halfLeg, "cash", null);
+      expect(result.price).toEqual({ amount: 30, currency: "USD" });
     });
 
     it("should return undefined if no fare products exist on the leg", () => {
@@ -177,8 +243,8 @@ describe("util > itinerary", () => {
     it("should calculate the total cost of an itinerary", () => {
       const result = getItineraryCost(
         fareProductItinerary.legs,
-        "orca:cash",
-        "orca:regular"
+        "cash",
+        "regular"
       );
       expect(result.amount).toEqual(5.75);
       expect(result.currency).toEqual({
@@ -186,6 +252,29 @@ describe("util > itinerary", () => {
         digits: 2
       });
     });
+    it("should calculate the total cost of an itinerary using fares v2", () => {
+      const result = getItineraryCost(faresv2Itinerary.legs, "3", "ADULT");
+      expect(result.amount).toEqual(2.8);
+    });
+    it("should calculate the individual leg cost of a fares v2 legs", () => {
+      const firstLegResult = getLegCost(faresv2Itinerary.legs[1], "3", "ADULT");
+      expect(firstLegResult.price?.amount).toEqual(2);
+
+      const secondLegResult = getLegCost(
+        faresv2Itinerary.legs[3],
+        "3",
+        "ADULT"
+      );
+      expect(secondLegResult.price?.amount).toEqual(0.8);
+
+      // Check for alternate product
+      expect(firstLegResult.alternateFareProducts?.[0]?.price?.amount).toEqual(
+        undefined
+      );
+      expect(secondLegResult.alternateFareProducts?.[0]?.price?.amount).toEqual(
+        2.8
+      );
+    });
     it("should calculate the total cost of an itinerary will null ids", () => {
       const result = getItineraryCost(fareProductItinerary.legs, null, null);
       expect(result.amount).toEqual(2.75);
@@ -206,11 +295,7 @@ describe("util > itinerary", () => {
       const legsWithDuplicatedProducts = [...fareProductItinerary.legs];
       legsWithDuplicatedProducts[3].fareProducts =
         legsWithDuplicatedProducts[1].fareProducts;
-      const result = getItineraryCost(
-        fareProductItinerary.legs,
-        "orca:cash",
-        "orca:regular"
-      );
+      const result = getItineraryCost(fareProductItinerary.legs, null, null);
       expect(result.amount).toEqual(2.75);
       expect(result.currency).toEqual({
         code: "USD",