@opentripplanner/core-utils 7.0.0-alpha.4 → 7.0.0

package/src/__tests__/itinerary.js

@@ -7,47 +7,57 @@ import {
 
 const bikeRentalItinerary = require("./__mocks__/bike-rental-itinerary.json");
 const tncItinerary = require("./__mocks__/tnc-itinerary.json");
-// const multiCurrencyItinerary = require("./__mocks__/multi-currency-itinerary.json");
 
 describe("util > itinerary", () => {
-  it("isTransit should work", () => {
-    expect(isTransit("CAR")).toBeFalsy();
+  describe("isTransit", () => {
+    it("should work", () => {
+      expect(isTransit("CAR")).toBeFalsy();
+      expect(isTransit("BUS")).toBeTruthy();
+    });
   });
 
-  it("getCompanyFromLeg should return company for bike rental leg", () => {
-    const company = getCompanyFromLeg(bikeRentalItinerary.legs[1]);
-    expect(company).toEqual("GBFS");
-  });
+  describe("getCompanyFromLeg", () => {
+    it("should return company for bike rental leg", () => {
+      const company = getCompanyFromLeg(bikeRentalItinerary.legs[1]);
+      expect(company).toEqual("GBFS");
+    });
 
-  it("getCompanyFromLeg should return company for TNC leg", () => {
-    const company = getCompanyFromLeg(tncItinerary.legs[0]);
-    expect(company).toEqual("UBER");
+    it("should return company for TNC leg", () => {
+      const company = getCompanyFromLeg(tncItinerary.legs[0]);
+      expect(company).toEqual("UBER");
+    });
   });
 
-  it("getTransitFare should return defaults with missing fare", () => {
-    const { transitFare } = getTransitFare(null);
-    // transit fare value should be zero
-    expect(transitFare).toMatchSnapshot();
-  });
+  describe("getTransitFare", () => {
+    it("should return defaults with missing fare", () => {
+      const { transitFare } = getTransitFare(null);
+      // transit fare value should be zero
+      expect(transitFare).toMatchSnapshot();
+    });
 
-  it("getTransitFare should work with valid fare component", () => {
-    const fareComponent = {
-      currency: {
-        currency: "USD",
-        defaultFractionDigits: 2,
-        currencyCode: "USD",
-        symbol: "$"
-      },
-      cents: 575
-    };
-    const { currencyCode, transitFare } = getTransitFare(fareComponent);
-    expect(currencyCode).toEqual(fareComponent.currency.currencyCode);
-    // Snapshot tests
-    expect(transitFare).toMatchSnapshot();
+    it("should work with valid fare component", () => {
+      const fareComponent = {
+        currency: {
+          currency: "USD",
+          defaultFractionDigits: 2,
+          currencyCode: "USD",
+          symbol: "$"
+        },
+        cents: 575
+      };
+      const { currencyCode, transitFare } = getTransitFare(fareComponent);
+      expect(currencyCode).toEqual(fareComponent.currency.currencyCode);
+      // Snapshot tests
+      expect(transitFare).toMatchSnapshot();
+    });
   });
 
-  it("calculateFare should return the correct currency code for TNC leg", () => {
-    const fareResult = calculateTncFares(tncItinerary, true);
-    expect(fareResult.currencyCode).toEqual("USD");
+  describe("calculateTncFares", () => {
+    it("should return the correct amounts and currency for an itinerary with TNC", () => {
+      const fareResult = calculateTncFares(tncItinerary, true);
+      expect(fareResult.currencyCode).toEqual("USD");
+      expect(fareResult.maxTNCFare).toEqual(19);
+      expect(fareResult.minTNCFare).toEqual(17);
+    });
   });
 });

package/src/itinerary.ts

@@ -13,32 +13,6 @@ import {
 } from "@opentripplanner/types";
 import turfAlong from "@turf/along";
 
-/*
-import {
-  // calculateFares,
-  // getLegModeLabel,
-  // getModeForPlace,
-  // getPlaceName,
-  // getStepDirection,
-  // getStepInstructions,
-  // getStepStreetName,
-  // getTimeZoneOffset,
-  // getTransitFare
-} from "./deprecated";
-
-export {
-  // calculateFares,
-  // getLegModeLabel,
-  // getModeForPlace,
-  // getPlaceName,
-  // getStepDirection,
-  // getStepInstructions,
-  // getStepStreetName,
-  // getTimeZoneOffset,
-  // getTransitFare
-};
-*/
-
 // All OTP transit modes
 export const transitModes = [
   "TRAM",
@@ -455,24 +429,24 @@ export function calculatePhysicalActivity(
  * It is assumed that the same currency is used for all TNC legs.
  */
 export function calculateTncFares(itinerary: Itinerary): TncFare {
-  let minTNCFare = 0;
-  let maxTNCFare = 0;
-  let currencyCode;
-  itinerary.legs.forEach(({ hailedCar, mode, tncData }) => {
-    if (mode === "CAR" && hailedCar && tncData) {
-      const { currency, maxCost, minCost } = tncData;
-      minTNCFare += minCost;
-      maxTNCFare += maxCost;
-      // Assumes a single currency for entire itinerary.
-      currencyCode = currency;
-    }
-  });
-
-  return {
-    currencyCode,
-    maxTNCFare,
-    minTNCFare
-  };
+  return itinerary.legs
+    .filter(leg => leg.mode === "CAR" && leg.hailedCar && leg.tncData)
+    .reduce(
+      ({ maxTNCFare, minTNCFare }, { tncData }) => {
+        const { currency, maxCost, minCost } = tncData;
+        return {
+          // Assumes a single currency for entire itinerary.
+          currencyCode: currency,
+          maxTNCFare: maxTNCFare + maxCost,
+          minTNCFare: minTNCFare + minCost
+        };
+      },
+      {
+        currencyCode: null,
+        maxTNCFare: 0,
+        minTNCFare: 0
+      }
+    );
 }
 
 /**
@@ -485,17 +459,77 @@ export function getTransitFare(
   currencyCode: string;
   transitFare: number;
 } {
-  // Default values (if fare component is not valid).
-  let transitFare = 0;
-  let currencyCode = "USD";
-  if (fareComponent) {
-    // Assign values without declaration.
-    // See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#assignment_without_declaration
-    ({ currencyCode } = fareComponent.currency);
-    transitFare = fareComponent.cents;
-  }
-  return {
-    currencyCode,
-    transitFare
+  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
+ * - https://www.thrustcarbon.com/insights/how-to-calculate-emissions-from-a-ferry-journey
+ * - https://www.itf-oecd.org/sites/default/files/life-cycle-assessment-calculations-2020.xlsx
+ * Other values extrapolated.
+ */
+const CARBON_INTENSITY_DEFAULTS = {
+  walk: 0.026,
+  bicycle: 0.017,
+  car: 0.162,
+  tram: 0.066,
+  subway: 0.066,
+  rail: 0.066,
+  bus: 0.09,
+  ferry: 0.082,
+  cable_car: 0.021,
+  gondola: 0.021,
+  funicular: 0.066,
+  transit: 0.066,
+  leg_switch: 0,
+  airplane: 0.382,
+  micromobility: 0.095
+};
+
+/**
+ * @param  {itinerary} itinerary OTP trip itinierary
+ * @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,
+  carbonIntensity: Record<string, number> = {},
+  units?: string
+): number {
+  // Apply defaults for any values that we don't have.
+  const carbonIntensityWithDefaults = {
+    ...CARBON_INTENSITY_DEFAULTS,
+    ...carbonIntensity
   };
+
+  // Distance is in meters, totalCarbon is in grams
+  const totalCarbon =
+    itinerary?.legs?.reduce((total, leg) => {
+      return (
+        (leg.distance * carbonIntensityWithDefaults[leg.mode.toLowerCase()] ||
+          0) + total
+      );
+    }, 0) || 0;
+
+  switch (units) {
+    case "ounce":
+      return totalCarbon / 28.35;
+    case "kilogram":
+      return totalCarbon / 1000;
+    case "pound":
+      return totalCarbon / 454;
+    case "gram":
+    default:
+      return totalCarbon;
+  }
 }

package/src/query.js

@@ -8,14 +8,10 @@ import queryParams from "./query-params";
 import {
   getCurrentTime,
   getCurrentDate,
-  OTP_API_TIME_FORMAT,
-  OTP_API_DATE_FORMAT_DATE_FNS
+  OTP_API_DATE_FORMAT,
+  OTP_API_TIME_FORMAT
 } from "./time";
 
-// import { coordsToString, summarizeQuery } from "./deprecated";
-
-// export { summarizeQuery };
-
 /* The list of default parameters considered in the settings panel */
 
 export const defaultParams = [
@@ -427,7 +423,7 @@ export function getRoutingParams(config, currentQuery, ignoreRealtimeUpdates) {
     }
 
     // check date/time validity; ignore both if either is invalid
-    const dateValid = isMatch(params.date, OTP_API_DATE_FORMAT_DATE_FNS);
+    const dateValid = isMatch(params.date, OTP_API_DATE_FORMAT);
     const timeValid = isMatch(params.time, OTP_API_TIME_FORMAT);
 
     if (!dateValid || !timeValid) {

package/src/time.ts

@@ -2,12 +2,9 @@ import { Config } from "@opentripplanner/types";
 import { startOfDay, add, format } from "date-fns";
 import { utcToZonedTime } from "date-fns-tz";
 
-// special constants for making sure the following date format is always sent to
-// OTP regardless of whatever the user has configured as the display format
-export const OTP_API_DATE_FORMAT = "YYYY-MM-DD";
-// Date-Fns uses a different string format than moment.js
-// see https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
-export const OTP_API_DATE_FORMAT_DATE_FNS = "yyyy-MM-dd";
+// Date/time formats (per date-fns) when sending/receiving date from OTP
+// regardless of whatever the user has configured as the display format.
+export const OTP_API_DATE_FORMAT = "yyyy-MM-dd";
 export const OTP_API_TIME_FORMAT = "HH:mm";
 
 /**
@@ -89,8 +86,5 @@ export function getCurrentTime(timezone = getUserTimezone()): string {
  * The conversion to the user's timezone is needed for testing purposes.
  */
 export function getCurrentDate(timezone = getUserTimezone()): string {
-  return format(
-    utcToZonedTime(Date.now(), timezone),
-    OTP_API_DATE_FORMAT_DATE_FNS
-  );
+  return format(utcToZonedTime(Date.now(), timezone), OTP_API_DATE_FORMAT);
 }

package/tsconfig.json

@@ -6,10 +6,5 @@
     "rootDir": "./src",
     "skipLibCheck": true
   },
-  "include": ["src/**/*"],
-  "references": [
-    {
-      "path": "../types"
-    }
-  ]
+  "include": ["src/**/*"]
 }