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

package/lib/time.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/time.ts"],"names":["OTP_API_DATE_FORMAT","OTP_API_DATE_FORMAT_DATE_FNS","OTP_API_TIME_FORMAT","toHoursMinutesSeconds","seconds","hours","Math","floor","minutes","getTimeFormat","config","dateTime","timeFormat","getDateFormat","dateFormat","getLongDateFormat","longDateFormat","offsetTime","ms","options","offset","formatSecondsAfterMidnight","time","Date","getUserTimezone","fallbackTimezone","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"mappings":";;;;;;;;;;;;;;;;AACA;;AACA;;AAEA;AACA;AACO,MAAMA,mBAAmB,GAAG,YAA5B,C,CACP;AACA;;;AACO,MAAMC,4BAA4B,GAAG,YAArC;;AACA,MAAMC,mBAAmB,GAAG,OAA5B;AAEP;AACA;AACA;AACA;AACA;;;;AACO,SAASC,qBAAT,CACLC,OADK,EAML;AACA,SAAO;AACLC,IAAAA,KAAK,EAAEC,IAAI,CAACC,KAAL,CAAWH,OAAO,GAAG,IAArB,CADF;AAELI,IAAAA,OAAO,EAAEF,IAAI,CAACC,KAAL,CAAWH,OAAO,GAAG,EAArB,IAA2B,EAF/B;AAGLA,IAAAA,OAAO,EAAEA,OAAO,GAAG;AAHd,GAAP;AAKD;AAED;AACA;AACA;AACA;;;AACO,SAASK,aAAT,CAAuBC,MAAvB,EAA+C;AAAA;;AACpD,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,gCAAAA,MAAM,CAAEC,QAAR,sEAAkBC,UAAlB,KAAgCV,mBAAvC;AACD;;AAEM,SAASW,aAAT,CAAuBH,MAAvB,EAA+C;AAAA;;AACpD,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBG,UAAlB,KAAgCd,mBAAvC;AACD;;AAEM,SAASe,iBAAT,CAA2BL,MAA3B,EAAmD;AAAA;;AACxD,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBK,cAAlB,KAAoC,aAA3C;AACD;AACD;AACA;AACA;AACA;;;AACO,SAASC,UAAT,CAAoBC,EAApB,EAAwBC,OAAxB,EAAiC;AACtC,SAAOD,EAAE,IAAI,CAAAC,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEC,MAAT,KAAmB,CAAvB,CAAT;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASC,0BAAT,CACLjB,OADK,EAELQ,UAFK,EAGG;AACR,QAAMU,IAAI,GAAG,kBAAI,yBAAW,IAAIC,IAAJ,EAAX,CAAJ,EAA4B;AAAEnB,IAAAA;AAAF,GAA5B,CAAb;AACA,SAAO,qBAAOkB,IAAP,EAAaV,UAAb,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASY,eAAT,CAAyBC,gBAAgB,GAAG,eAA5C,EAAqE;AAAA;;AAC1E,MAAIC,OAAO,CAACC,GAAR,CAAYC,QAAZ,KAAyB,MAA7B,EAAqC,OAAOF,OAAO,CAACC,GAAR,CAAYE,EAAnB;AACrC,SAAO,UAAAC,IAAI,UAAJ,sCAAMC,cAAN,GAAuBC,eAAvB,GAAyCC,QAAzC,KAAqDR,gBAA5D;AACD;AAED;AACA;AACA;AACA;;;AACO,SAASS,cAAT,CAAwBC,QAAQ,GAAGX,eAAe,EAAlD,EAA8D;AACnE,SAAO,qBAAO,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CAAP,EAA6CjC,mBAA7C,CAAP;AACD;AAED;AACA;AACA;AACA;;;AACO,SAASmC,cAAT,CAAwBF,QAAQ,GAAGX,eAAe,EAAlD,EAA8D;AACnE,SAAO,qBACL,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CADK,EAELlC,4BAFK,CAAP;AAID","sourcesContent":["import { Config } from \"@opentripplanner/types\";\nimport { startOfDay, add, format } from \"date-fns\";\nimport { utcToZonedTime } from \"date-fns-tz\";\n\n// special constants for making sure the following date format is always sent to\n// OTP regardless of whatever the user has configured as the display format\nexport const OTP_API_DATE_FORMAT = \"YYYY-MM-DD\";\n// Date-Fns uses a different string format than moment.js\n// see https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md\nexport const OTP_API_DATE_FORMAT_DATE_FNS = \"yyyy-MM-dd\";\nexport const OTP_API_TIME_FORMAT = \"HH:mm\";\n\n/**\n * Breaks up a duration in seconds into hours, minutes, and seconds.\n * @param {number} seconds The number of seconds to break up\n * @returns an object with fields with the corresponding, hours, minutes, seconds.\n */\nexport function toHoursMinutesSeconds(\n  seconds: number\n): {\n  hours: number;\n  minutes: number;\n  seconds: number;\n} {\n  return {\n    hours: Math.floor(seconds / 3600),\n    minutes: Math.floor(seconds / 60) % 60,\n    seconds: seconds % 60\n  };\n}\n\n/**\n * @param  {[type]} config the OTP config object found in store\n * @return {string}        the config-defined time formatter or HH:mm (24-hr time)\n */\nexport function getTimeFormat(config: Config): string {\n  return config?.dateTime?.timeFormat || OTP_API_TIME_FORMAT;\n}\n\nexport function getDateFormat(config: Config): string {\n  return config?.dateTime?.dateFormat || OTP_API_DATE_FORMAT;\n}\n\nexport function getLongDateFormat(config: Config): string {\n  return config?.dateTime?.longDateFormat || \"D MMMM YYYY\";\n}\n/**\n * Offsets a time according to the provided time options\n * and returns the result.\n */\nexport function offsetTime(ms, options) {\n  return ms + (options?.offset || 0);\n}\n\n/**\n * Formats a seconds after midnight value for display in narrative\n * @param  {number} seconds  time since midnight in seconds\n * @param  {string} timeFormat  A valid date-fns time format\n * @return {string}                   formatted text representation\n */\nexport function formatSecondsAfterMidnight(\n  seconds: number,\n  timeFormat: string\n): string {\n  const time = add(startOfDay(new Date()), { seconds });\n  return format(time, timeFormat);\n}\n\n/**\n * Uses Intl.DateTimeFormat() api to get the user's time zone. In a test\n * environment, pulls timezone information from an env variable. Default to\n * GMT+0 if the Intl API is unavailable.\n */\nexport function getUserTimezone(fallbackTimezone = \"Etc/Greenwich\"): string {\n  if (process.env.NODE_ENV === \"test\") return process.env.TZ;\n  return Intl?.DateTimeFormat().resolvedOptions().timeZone || fallbackTimezone;\n}\n\n/**\n * Formats current time for use in OTP query\n * The conversion to the user's timezone is needed for testing purposes.\n */\nexport function getCurrentTime(timezone = getUserTimezone()): string {\n  return format(utcToZonedTime(Date.now(), timezone), OTP_API_TIME_FORMAT);\n}\n\n/**\n * Formats current date for use in OTP query\n * The conversion to the user's timezone is needed for testing purposes.\n */\nexport function getCurrentDate(timezone = getUserTimezone()): string {\n  return format(\n    utcToZonedTime(Date.now(), timezone),\n    OTP_API_DATE_FORMAT_DATE_FNS\n  );\n}\n"],"file":"time.js"}
+{"version":3,"sources":["../src/time.ts"],"names":["OTP_API_DATE_FORMAT","OTP_API_TIME_FORMAT","toHoursMinutesSeconds","seconds","hours","Math","floor","minutes","getTimeFormat","config","dateTime","timeFormat","getDateFormat","dateFormat","getLongDateFormat","longDateFormat","offsetTime","ms","options","offset","formatSecondsAfterMidnight","time","Date","getUserTimezone","fallbackTimezone","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"mappings":";;;;;;;;;;;;;;;;AACA;;AACA;;AAEA;AACA;AACO,MAAMA,mBAAmB,GAAG,YAA5B;;AACA,MAAMC,mBAAmB,GAAG,OAA5B;AAEP;AACA;AACA;AACA;AACA;;;;AACO,SAASC,qBAAT,CACLC,OADK,EAML;AACA,SAAO;AACLC,IAAAA,KAAK,EAAEC,IAAI,CAACC,KAAL,CAAWH,OAAO,GAAG,IAArB,CADF;AAELI,IAAAA,OAAO,EAAEF,IAAI,CAACC,KAAL,CAAWH,OAAO,GAAG,EAArB,IAA2B,EAF/B;AAGLA,IAAAA,OAAO,EAAEA,OAAO,GAAG;AAHd,GAAP;AAKD;AAED;AACA;AACA;AACA;;;AACO,SAASK,aAAT,CAAuBC,MAAvB,EAA+C;AAAA;;AACpD,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,gCAAAA,MAAM,CAAEC,QAAR,sEAAkBC,UAAlB,KAAgCV,mBAAvC;AACD;;AAEM,SAASW,aAAT,CAAuBH,MAAvB,EAA+C;AAAA;;AACpD,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBG,UAAlB,KAAgCb,mBAAvC;AACD;;AAEM,SAASc,iBAAT,CAA2BL,MAA3B,EAAmD;AAAA;;AACxD,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBK,cAAlB,KAAoC,aAA3C;AACD;AACD;AACA;AACA;AACA;;;AACO,SAASC,UAAT,CAAoBC,EAApB,EAAwBC,OAAxB,EAAiC;AACtC,SAAOD,EAAE,IAAI,CAAAC,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEC,MAAT,KAAmB,CAAvB,CAAT;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASC,0BAAT,CACLjB,OADK,EAELQ,UAFK,EAGG;AACR,QAAMU,IAAI,GAAG,kBAAI,yBAAW,IAAIC,IAAJ,EAAX,CAAJ,EAA4B;AAAEnB,IAAAA;AAAF,GAA5B,CAAb;AACA,SAAO,qBAAOkB,IAAP,EAAaV,UAAb,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASY,eAAT,CAAyBC,gBAAgB,GAAG,eAA5C,EAAqE;AAAA;;AAC1E,MAAIC,OAAO,CAACC,GAAR,CAAYC,QAAZ,KAAyB,MAA7B,EAAqC,OAAOF,OAAO,CAACC,GAAR,CAAYE,EAAnB;AACrC,SAAO,UAAAC,IAAI,UAAJ,sCAAMC,cAAN,GAAuBC,eAAvB,GAAyCC,QAAzC,KAAqDR,gBAA5D;AACD;AAED;AACA;AACA;AACA;;;AACO,SAASS,cAAT,CAAwBC,QAAQ,GAAGX,eAAe,EAAlD,EAA8D;AACnE,SAAO,qBAAO,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CAAP,EAA6CjC,mBAA7C,CAAP;AACD;AAED;AACA;AACA;AACA;;;AACO,SAASmC,cAAT,CAAwBF,QAAQ,GAAGX,eAAe,EAAlD,EAA8D;AACnE,SAAO,qBAAO,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CAAP,EAA6ClC,mBAA7C,CAAP;AACD","sourcesContent":["import { Config } from \"@opentripplanner/types\";\nimport { startOfDay, add, format } from \"date-fns\";\nimport { utcToZonedTime } from \"date-fns-tz\";\n\n// Date/time formats (per date-fns) when sending/receiving date from OTP\n// regardless of whatever the user has configured as the display format.\nexport const OTP_API_DATE_FORMAT = \"yyyy-MM-dd\";\nexport const OTP_API_TIME_FORMAT = \"HH:mm\";\n\n/**\n * Breaks up a duration in seconds into hours, minutes, and seconds.\n * @param {number} seconds The number of seconds to break up\n * @returns an object with fields with the corresponding, hours, minutes, seconds.\n */\nexport function toHoursMinutesSeconds(\n  seconds: number\n): {\n  hours: number;\n  minutes: number;\n  seconds: number;\n} {\n  return {\n    hours: Math.floor(seconds / 3600),\n    minutes: Math.floor(seconds / 60) % 60,\n    seconds: seconds % 60\n  };\n}\n\n/**\n * @param  {[type]} config the OTP config object found in store\n * @return {string}        the config-defined time formatter or HH:mm (24-hr time)\n */\nexport function getTimeFormat(config: Config): string {\n  return config?.dateTime?.timeFormat || OTP_API_TIME_FORMAT;\n}\n\nexport function getDateFormat(config: Config): string {\n  return config?.dateTime?.dateFormat || OTP_API_DATE_FORMAT;\n}\n\nexport function getLongDateFormat(config: Config): string {\n  return config?.dateTime?.longDateFormat || \"D MMMM YYYY\";\n}\n/**\n * Offsets a time according to the provided time options\n * and returns the result.\n */\nexport function offsetTime(ms, options) {\n  return ms + (options?.offset || 0);\n}\n\n/**\n * Formats a seconds after midnight value for display in narrative\n * @param  {number} seconds  time since midnight in seconds\n * @param  {string} timeFormat  A valid date-fns time format\n * @return {string}                   formatted text representation\n */\nexport function formatSecondsAfterMidnight(\n  seconds: number,\n  timeFormat: string\n): string {\n  const time = add(startOfDay(new Date()), { seconds });\n  return format(time, timeFormat);\n}\n\n/**\n * Uses Intl.DateTimeFormat() api to get the user's time zone. In a test\n * environment, pulls timezone information from an env variable. Default to\n * GMT+0 if the Intl API is unavailable.\n */\nexport function getUserTimezone(fallbackTimezone = \"Etc/Greenwich\"): string {\n  if (process.env.NODE_ENV === \"test\") return process.env.TZ;\n  return Intl?.DateTimeFormat().resolvedOptions().timeZone || fallbackTimezone;\n}\n\n/**\n * Formats current time for use in OTP query\n * The conversion to the user's timezone is needed for testing purposes.\n */\nexport function getCurrentTime(timezone = getUserTimezone()): string {\n  return format(utcToZonedTime(Date.now(), timezone), OTP_API_TIME_FORMAT);\n}\n\n/**\n * Formats current date for use in OTP query\n * The conversion to the user's timezone is needed for testing purposes.\n */\nexport function getCurrentDate(timezone = getUserTimezone()): string {\n  return format(utcToZonedTime(Date.now(), timezone), OTP_API_DATE_FORMAT);\n}\n"],"file":"time.js"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentripplanner/core-utils",
-  "version": "7.0.0-alpha.4",
+  "version": "7.0.2",
   "description": "Core functionality that is shared among numerous UI components",
   "engines": {
     "node": ">=13"
@@ -13,7 +13,7 @@
   "private": false,
   "dependencies": {
     "@mapbox/polyline": "^1.1.0",
-    "@opentripplanner/geocoder": "^1.2.2",
+    "@opentripplanner/geocoder": "^1.3.0",
     "@styled-icons/foundation": "^10.34.0",
     "@turf/along": "^6.0.1",
     "bowser": "^2.7.0",
@@ -28,6 +28,6 @@
     "tsc": "tsc"
   },
   "devDependencies": {
-    "@opentripplanner/types": "3.0.0-alpha.4"
+    "@opentripplanner/types": "^4.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 = [
@@ -148,7 +144,9 @@ function isParamApplicable(paramInfo, query, config) {
  * Helper method which replaces OTP flex modes with single FLEX mode that's
  * more useful and easier to work with.
  */
-export function reduceOtpFlexModes(modes) {
+export function reduceOtpFlexModes(modes, enabled = true) {
+  if (!enabled) return modes;
+
   return modes.reduce((prev, cur) => {
     const newModes = prev;
     // Add the current mode if it is not a flex mode
@@ -191,7 +189,10 @@ export function expandOtpFlexMode(mode) {
  * default values.
  */
 export function isNotDefaultQuery(query, config) {
-  const activeModes = reduceOtpFlexModes(query.mode.split(",").sort());
+  const activeModes = reduceOtpFlexModes(
+    query.mode.split(",").sort(),
+    config.modes?.mergeFlex
+  );
   if (
     activeModes.length !== 2 ||
     activeModes[0] !== "TRANSIT" ||
@@ -427,7 +428,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) {
@@ -470,7 +471,8 @@ export function getRoutingParams(config, currentQuery, ignoreRealtimeUpdates) {
   }
 
   // Replace FLEX placeholder with OTP flex modes
-  if (params.mode) {
+  // Explicit false check allows avoiding a breaking change -- undefined is true
+  if (params.mode && config.modes?.mergeFlex !== false) {
     // Ensure query is in reduced format to avoid replacing twice
     const reducedMode = reduceOtpFlexModes(params.mode.split(",")).join(",");
     params.mode = expandOtpFlexMode(reducedMode);

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/**/*"]
 }