@opentripplanner/core-utils 4.9.0 → 4.10.0

package/esm/time.js

@@ -52,12 +52,27 @@ function formatDurationLikeMoment(seconds, showSeconds) {
     locale: locale
   });
 }
+/**
+ * Breaks up a duration in seconds into hours, minutes, and seconds.
+ * @param {number} seconds The number of seconds to break up
+ * @returns an object with fields with the corresponding, hours, minutes, seconds.
+ */
+
+
+export function toHoursMinutesSeconds(seconds) {
+  var hours = Math.floor(seconds / 3600);
+  var minutes = Math.floor((seconds - hours * 3600) / 60);
+  return {
+    hours: hours,
+    minutes: minutes,
+    seconds: seconds - hours * 3600 - minutes * 60
+  };
+}
 /**
  * @param  {[type]} config the OTP config object found in store
  * @return {string}        the config-defined time formatter or HH:mm (24-hr time)
  */
 
-
 export function getTimeFormat(config) {
   var _config$dateTime;
 
@@ -96,6 +111,14 @@ export function formatDurationWithSeconds(seconds, region) {
     code: region
   });
 }
+/**
+ * Offsets a time according to the provided time options
+ * and returns the result.
+ */
+
+export function offsetTime(ms, options) {
+  return ms + ((options === null || options === void 0 ? void 0 : options.offset) || 0);
+}
 /**
  * Formats a time value for display in narrative
  * TODO: internationalization/timezone
@@ -104,7 +127,7 @@ export function formatDurationWithSeconds(seconds, region) {
  */
 
 export function formatTime(ms, options) {
-  return format(ms + ((options === null || options === void 0 ? void 0 : options.offset) || 0), (options === null || options === void 0 ? void 0 : options.format) || OTP_API_TIME_FORMAT);
+  return format(offsetTime(ms, options), (options === null || options === void 0 ? void 0 : options.format) || OTP_API_TIME_FORMAT);
 }
 /**
  * Formats a seconds after midnight value for display in narrative

package/esm/time.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/time.js"],"names":["startOfDay","add","format","formatDuration","dateFnsFormatDuration","utcToZonedTime","OTP_API_DATE_FORMAT","OTP_API_DATE_FORMAT_DATE_FNS","OTP_API_TIME_FORMAT","formatDurationLikeMoment","seconds","showSeconds","localize","enabled","code","hours","Math","floor","minutes","secondsLeftOver","specLookup","xHours","xMinutes","xSeconds","locale","formatDistance","spec","val","undefined","getTimeFormat","config","dateTime","timeFormat","getDateFormat","dateFormat","getLongDateFormat","longDateFormat","formatDurationWithSeconds","region","formatTime","ms","options","offset","formatSecondsAfterMidnight","time","Date","getUserTimezone","fallbackTimezone","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"mappings":"AAAA,SACEA,UADF,EAEEC,GAFF,EAGEC,MAHF,EAIEC,cAAc,IAAIC,qBAJpB,QAKO,UALP;AAMA,SAASC,cAAT,QAA+B,aAA/B,C,CAEA;AACA;;AACA,OAAO,IAAMC,mBAAmB,GAAG,YAA5B,C,CACP;AACA;;AACA,OAAO,IAAMC,4BAA4B,GAAG,YAArC;AACP,OAAO,IAAMC,mBAAmB,GAAG,OAA5B;AAEP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,SAASC,wBAAT,CACEC,OADF,EAEEC,WAFF,EAIE;AAAA,MADAC,QACA,uEADW;AAAEC,IAAAA,OAAO,EAAE,IAAX;AAAiBC,IAAAA,IAAI,EAAE;AAAvB,GACX;;AACA;AACA,MAAK,CAACH,WAAD,IAAgBD,OAAO,GAAG,EAA3B,IAAkCA,OAAO,KAAK,CAAlD,EAAqD;AACnD,WAAO,OAAP;AACD;;AAED,MAAMK,KAAK,GAAGC,IAAI,CAACC,KAAL,CAAWP,OAAO,GAAG,IAArB,CAAd;AACA,MAAMQ,OAAO,GAAGF,IAAI,CAACC,KAAL,CAAW,CAACP,OAAO,GAAGK,KAAK,GAAG,IAAnB,IAA2B,EAAtC,CAAhB;AACA,MAAMI,eAAe,GAAGR,WAAW,GAC/BD,OAAO,GAAGK,KAAK,GAAG,IAAlB,GAAyBG,OAAO,GAAG,EADJ,GAE/B,CAFJ;AAGA,MAAME,UAAU,GAAG;AACjBC,IAAAA,MAAM,EAAE,IADS;AAEjBC,IAAAA,QAAQ,EAAE,KAFO;AAGjBC,IAAAA,QAAQ,EAAE;AAHO,GAAnB;AAKA,MAAMC,MAAM,GAAGZ,QAAQ,GACnB;AACE;AACAE,IAAAA,IAAI,EAAE,CAAAF,QAAQ,SAAR,IAAAA,QAAQ,WAAR,YAAAA,QAAQ,CAAEE,IAAV,KAAkB,OAF1B;AAGEW,IAAAA,cAAc,EAAE,wBAACC,IAAD,EAAOC,GAAP,EAAe;AAC7B,uBAAUA,GAAV,cAAiBP,UAAU,CAACM,IAAD,CAA3B;AACD;AALH,GADmB,GAQnBE,SARJ;AAUA,SAAOxB,qBAAqB,CAC1B;AACEW,IAAAA,KAAK,EAALA,KADF;AAEEG,IAAAA,OAAO,EAAPA,OAFF;AAGER,IAAAA,OAAO,EAAES;AAHX,GAD0B,EAM1B;AACEjB,IAAAA,MAAM,EAAE,CAAC,OAAD,EAAU,SAAV,EAAqB,SAArB,CADV;AAEEsB,IAAAA,MAAM,EAANA;AAFF,GAN0B,CAA5B;AAWD;AACD;AACA;AACA;AACA;;;AACA,OAAO,SAASK,aAAT,CAAuBC,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,gCAAAA,MAAM,CAAEC,QAAR,sEAAkBC,UAAlB,KAAgCxB,mBAAvC;AACD;AAED,OAAO,SAASyB,aAAT,CAAuBH,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBG,UAAlB,KAAgC5B,mBAAvC;AACD;AAED,OAAO,SAAS6B,iBAAT,CAA2BL,MAA3B,EAAmC;AAAA;;AACxC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBK,cAAlB,KAAoC,aAA3C;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASjC,cAAT,CAAwBO,OAAxB,EAAiC;AACtC,SAAOD,wBAAwB,CAACC,OAAD,EAAU,KAAV,CAA/B;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAAS2B,yBAAT,CAAmC3B,OAAnC,EAA4C4B,MAA5C,EAAoD;AACzD,SAAO7B,wBAAwB,CAACC,OAAD,EAAU;AAAEG,IAAAA,OAAO,EAAE,IAAX;AAAiBC,IAAAA,IAAI,EAAEwB;AAAvB,GAAV,CAA/B;AACD;AACD;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,UAAT,CAAoBC,EAApB,EAAwBC,OAAxB,EAAiC;AACtC,SAAOvC,MAAM,CACXsC,EAAE,IAAI,CAAAC,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEC,MAAT,KAAmB,CAAvB,CADS,EAEX,CAAAD,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEvC,MAAT,KAAmBM,mBAFR,CAAb;AAID;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASmC,0BAAT,CAAoCjC,OAApC,EAA6CsB,UAA7C,EAAyD;AAC9D,MAAMY,IAAI,GAAG3C,GAAG,CAACD,UAAU,CAAC,IAAI6C,IAAJ,EAAD,CAAX,EAAyB;AAAEnC,IAAAA,OAAO,EAAPA;AAAF,GAAzB,CAAhB;AACA,SAAOR,MAAM,CAAC0C,IAAD,EAAOZ,UAAP,CAAb;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASc,eAAT,GAA6D;AAAA;;AAAA,MAApCC,gBAAoC,uEAAjB,eAAiB;AAClE,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;;AACA,OAAO,SAASS,cAAT,GAAsD;AAAA,MAA9BC,QAA8B,uEAAnBX,eAAe,EAAI;AAC3D,SAAO5C,MAAM,CAACG,cAAc,CAACwC,IAAI,CAACa,GAAL,EAAD,EAAaD,QAAb,CAAf,EAAuCjD,mBAAvC,CAAb;AACD;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASmD,cAAT,GAAsD;AAAA,MAA9BF,QAA8B,uEAAnBX,eAAe,EAAI;AAC3D,SAAO5C,MAAM,CACXG,cAAc,CAACwC,IAAI,CAACa,GAAL,EAAD,EAAaD,QAAb,CADH,EAEXlD,4BAFW,CAAb;AAID","sourcesContent":["import {\n  startOfDay,\n  add,\n  format,\n  formatDuration as dateFnsFormatDuration\n} 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 * To ease the transition away from moment.js, this method uses date-fns to format durations\n * the way moment.js did.\n * @param {number}  seconds     The number of seconds to format\n * @param {boolean} showSeconds Whether to render seconds or not\n * @param {boolean} localize    If true, will create output like moment.js using date-fns locale.\n * Otherwise, uses date-fns default\n * @returns                   Formatted duration\n */\nfunction formatDurationLikeMoment(\n  seconds,\n  showSeconds,\n  localize = { enabled: true, code: \"en-US\" }\n) {\n  // date-fns doesn't do this automatically\n  if ((!showSeconds && seconds < 60) || seconds === 0) {\n    return \"0 min\";\n  }\n\n  const hours = Math.floor(seconds / 3600);\n  const minutes = Math.floor((seconds - hours * 3600) / 60);\n  const secondsLeftOver = showSeconds\n    ? seconds - hours * 3600 - minutes * 60\n    : 0;\n  const specLookup = {\n    xHours: \"hr\",\n    xMinutes: \"min\",\n    xSeconds: \"sec\"\n  };\n  const locale = localize\n    ? {\n        // Maintain backwards compatibility when called with localize=true\n        code: localize?.code || \"en-US\",\n        formatDistance: (spec, val) => {\n          return `${val} ${specLookup[spec]}`;\n        }\n      }\n    : undefined;\n\n  return dateFnsFormatDuration(\n    {\n      hours,\n      minutes,\n      seconds: secondsLeftOver\n    },\n    {\n      format: [\"hours\", \"minutes\", \"seconds\"],\n      locale\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) {\n  return config?.dateTime?.timeFormat || OTP_API_TIME_FORMAT;\n}\n\nexport function getDateFormat(config) {\n  return config?.dateTime?.dateFormat || OTP_API_DATE_FORMAT;\n}\n\nexport function getLongDateFormat(config) {\n  return config?.dateTime?.longDateFormat || \"D MMMM YYYY\";\n}\n\n/**\n * Formats an elapsed time duration for display in narrative.\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDuration(seconds) {\n  return formatDurationLikeMoment(seconds, false);\n}\n\n/**\n * Formats an elapsed time in seconds, minutes, hours duration for display in narrative\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDurationWithSeconds(seconds, region) {\n  return formatDurationLikeMoment(seconds, { enabled: true, code: region });\n}\n/**\n * Formats a time value for display in narrative\n * TODO: internationalization/timezone\n * @param {number} ms epoch time value in milliseconds\n * @returns {string} formatted text representation\n */\nexport function formatTime(ms, options) {\n  return format(\n    ms + (options?.offset || 0),\n    options?.format || OTP_API_TIME_FORMAT\n  );\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(seconds, timeFormat) {\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\") {\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()) {\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()) {\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.js"],"names":["startOfDay","add","format","formatDuration","dateFnsFormatDuration","utcToZonedTime","OTP_API_DATE_FORMAT","OTP_API_DATE_FORMAT_DATE_FNS","OTP_API_TIME_FORMAT","formatDurationLikeMoment","seconds","showSeconds","localize","enabled","code","hours","Math","floor","minutes","secondsLeftOver","specLookup","xHours","xMinutes","xSeconds","locale","formatDistance","spec","val","undefined","toHoursMinutesSeconds","getTimeFormat","config","dateTime","timeFormat","getDateFormat","dateFormat","getLongDateFormat","longDateFormat","formatDurationWithSeconds","region","offsetTime","ms","options","offset","formatTime","formatSecondsAfterMidnight","time","Date","getUserTimezone","fallbackTimezone","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"mappings":"AAAA,SACEA,UADF,EAEEC,GAFF,EAGEC,MAHF,EAIEC,cAAc,IAAIC,qBAJpB,QAKO,UALP;AAMA,SAASC,cAAT,QAA+B,aAA/B,C,CAEA;AACA;;AACA,OAAO,IAAMC,mBAAmB,GAAG,YAA5B,C,CACP;AACA;;AACA,OAAO,IAAMC,4BAA4B,GAAG,YAArC;AACP,OAAO,IAAMC,mBAAmB,GAAG,OAA5B;AAEP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,SAASC,wBAAT,CACEC,OADF,EAEEC,WAFF,EAIE;AAAA,MADAC,QACA,uEADW;AAAEC,IAAAA,OAAO,EAAE,IAAX;AAAiBC,IAAAA,IAAI,EAAE;AAAvB,GACX;;AACA;AACA,MAAK,CAACH,WAAD,IAAgBD,OAAO,GAAG,EAA3B,IAAkCA,OAAO,KAAK,CAAlD,EAAqD;AACnD,WAAO,OAAP;AACD;;AAED,MAAMK,KAAK,GAAGC,IAAI,CAACC,KAAL,CAAWP,OAAO,GAAG,IAArB,CAAd;AACA,MAAMQ,OAAO,GAAGF,IAAI,CAACC,KAAL,CAAW,CAACP,OAAO,GAAGK,KAAK,GAAG,IAAnB,IAA2B,EAAtC,CAAhB;AACA,MAAMI,eAAe,GAAGR,WAAW,GAC/BD,OAAO,GAAGK,KAAK,GAAG,IAAlB,GAAyBG,OAAO,GAAG,EADJ,GAE/B,CAFJ;AAGA,MAAME,UAAU,GAAG;AACjBC,IAAAA,MAAM,EAAE,IADS;AAEjBC,IAAAA,QAAQ,EAAE,KAFO;AAGjBC,IAAAA,QAAQ,EAAE;AAHO,GAAnB;AAKA,MAAMC,MAAM,GAAGZ,QAAQ,GACnB;AACE;AACAE,IAAAA,IAAI,EAAE,CAAAF,QAAQ,SAAR,IAAAA,QAAQ,WAAR,YAAAA,QAAQ,CAAEE,IAAV,KAAkB,OAF1B;AAGEW,IAAAA,cAAc,EAAE,wBAACC,IAAD,EAAOC,GAAP,EAAe;AAC7B,uBAAUA,GAAV,cAAiBP,UAAU,CAACM,IAAD,CAA3B;AACD;AALH,GADmB,GAQnBE,SARJ;AAUA,SAAOxB,qBAAqB,CAC1B;AACEW,IAAAA,KAAK,EAALA,KADF;AAEEG,IAAAA,OAAO,EAAPA,OAFF;AAGER,IAAAA,OAAO,EAAES;AAHX,GAD0B,EAM1B;AACEjB,IAAAA,MAAM,EAAE,CAAC,OAAD,EAAU,SAAV,EAAqB,SAArB,CADV;AAEEsB,IAAAA,MAAM,EAANA;AAFF,GAN0B,CAA5B;AAWD;AAED;AACA;AACA;AACA;AACA;;;AACA,OAAO,SAASK,qBAAT,CAA+BnB,OAA/B,EAAwC;AAC7C,MAAMK,KAAK,GAAGC,IAAI,CAACC,KAAL,CAAWP,OAAO,GAAG,IAArB,CAAd;AACA,MAAMQ,OAAO,GAAGF,IAAI,CAACC,KAAL,CAAW,CAACP,OAAO,GAAGK,KAAK,GAAG,IAAnB,IAA2B,EAAtC,CAAhB;AACA,SAAO;AACLA,IAAAA,KAAK,EAALA,KADK;AAELG,IAAAA,OAAO,EAAPA,OAFK;AAGLR,IAAAA,OAAO,EAAEA,OAAO,GAAGK,KAAK,GAAG,IAAlB,GAAyBG,OAAO,GAAG;AAHvC,GAAP;AAKD;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASY,aAAT,CAAuBC,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,gCAAAA,MAAM,CAAEC,QAAR,sEAAkBC,UAAlB,KAAgCzB,mBAAvC;AACD;AAED,OAAO,SAAS0B,aAAT,CAAuBH,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBG,UAAlB,KAAgC7B,mBAAvC;AACD;AAED,OAAO,SAAS8B,iBAAT,CAA2BL,MAA3B,EAAmC;AAAA;;AACxC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBK,cAAlB,KAAoC,aAA3C;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASlC,cAAT,CAAwBO,OAAxB,EAAiC;AACtC,SAAOD,wBAAwB,CAACC,OAAD,EAAU,KAAV,CAA/B;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAAS4B,yBAAT,CAAmC5B,OAAnC,EAA4C6B,MAA5C,EAAoD;AACzD,SAAO9B,wBAAwB,CAACC,OAAD,EAAU;AAAEG,IAAAA,OAAO,EAAE,IAAX;AAAiBC,IAAAA,IAAI,EAAEyB;AAAvB,GAAV,CAA/B;AACD;AAED;AACA;AACA;AACA;;AACA,OAAO,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;;AACA,OAAO,SAASC,UAAT,CAAoBH,EAApB,EAAwBC,OAAxB,EAAiC;AACtC,SAAOxC,MAAM,CACXsC,UAAU,CAACC,EAAD,EAAKC,OAAL,CADC,EAEX,CAAAA,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAExC,MAAT,KAAmBM,mBAFR,CAAb;AAID;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASqC,0BAAT,CAAoCnC,OAApC,EAA6CuB,UAA7C,EAAyD;AAC9D,MAAMa,IAAI,GAAG7C,GAAG,CAACD,UAAU,CAAC,IAAI+C,IAAJ,EAAD,CAAX,EAAyB;AAAErC,IAAAA,OAAO,EAAPA;AAAF,GAAzB,CAAhB;AACA,SAAOR,MAAM,CAAC4C,IAAD,EAAOb,UAAP,CAAb;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASe,eAAT,GAA6D;AAAA;;AAAA,MAApCC,gBAAoC,uEAAjB,eAAiB;AAClE,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;;AACA,OAAO,SAASS,cAAT,GAAsD;AAAA,MAA9BC,QAA8B,uEAAnBX,eAAe,EAAI;AAC3D,SAAO9C,MAAM,CAACG,cAAc,CAAC0C,IAAI,CAACa,GAAL,EAAD,EAAaD,QAAb,CAAf,EAAuCnD,mBAAvC,CAAb;AACD;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASqD,cAAT,GAAsD;AAAA,MAA9BF,QAA8B,uEAAnBX,eAAe,EAAI;AAC3D,SAAO9C,MAAM,CACXG,cAAc,CAAC0C,IAAI,CAACa,GAAL,EAAD,EAAaD,QAAb,CADH,EAEXpD,4BAFW,CAAb;AAID","sourcesContent":["import {\n  startOfDay,\n  add,\n  format,\n  formatDuration as dateFnsFormatDuration\n} 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 * To ease the transition away from moment.js, this method uses date-fns to format durations\n * the way moment.js did.\n * @param {number}  seconds     The number of seconds to format\n * @param {boolean} showSeconds Whether to render seconds or not\n * @param {boolean} localize    If true, will create output like moment.js using date-fns locale.\n * Otherwise, uses date-fns default\n * @returns                   Formatted duration\n */\nfunction formatDurationLikeMoment(\n  seconds,\n  showSeconds,\n  localize = { enabled: true, code: \"en-US\" }\n) {\n  // date-fns doesn't do this automatically\n  if ((!showSeconds && seconds < 60) || seconds === 0) {\n    return \"0 min\";\n  }\n\n  const hours = Math.floor(seconds / 3600);\n  const minutes = Math.floor((seconds - hours * 3600) / 60);\n  const secondsLeftOver = showSeconds\n    ? seconds - hours * 3600 - minutes * 60\n    : 0;\n  const specLookup = {\n    xHours: \"hr\",\n    xMinutes: \"min\",\n    xSeconds: \"sec\"\n  };\n  const locale = localize\n    ? {\n        // Maintain backwards compatibility when called with localize=true\n        code: localize?.code || \"en-US\",\n        formatDistance: (spec, val) => {\n          return `${val} ${specLookup[spec]}`;\n        }\n      }\n    : undefined;\n\n  return dateFnsFormatDuration(\n    {\n      hours,\n      minutes,\n      seconds: secondsLeftOver\n    },\n    {\n      format: [\"hours\", \"minutes\", \"seconds\"],\n      locale\n    }\n  );\n}\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(seconds) {\n  const hours = Math.floor(seconds / 3600);\n  const minutes = Math.floor((seconds - hours * 3600) / 60);\n  return {\n    hours,\n    minutes,\n    seconds: seconds - hours * 3600 - minutes * 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) {\n  return config?.dateTime?.timeFormat || OTP_API_TIME_FORMAT;\n}\n\nexport function getDateFormat(config) {\n  return config?.dateTime?.dateFormat || OTP_API_DATE_FORMAT;\n}\n\nexport function getLongDateFormat(config) {\n  return config?.dateTime?.longDateFormat || \"D MMMM YYYY\";\n}\n\n/**\n * Formats an elapsed time duration for display in narrative.\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDuration(seconds) {\n  return formatDurationLikeMoment(seconds, false);\n}\n\n/**\n * Formats an elapsed time in seconds, minutes, hours duration for display in narrative\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDurationWithSeconds(seconds, region) {\n  return formatDurationLikeMoment(seconds, { enabled: true, code: region });\n}\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 time value for display in narrative\n * TODO: internationalization/timezone\n * @param {number} ms epoch time value in milliseconds\n * @returns {string} formatted text representation\n */\nexport function formatTime(ms, options) {\n  return format(\n    offsetTime(ms, options),\n    options?.format || OTP_API_TIME_FORMAT\n  );\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(seconds, timeFormat) {\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\") {\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()) {\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()) {\n  return format(\n    utcToZonedTime(Date.now(), timezone),\n    OTP_API_DATE_FORMAT_DATE_FNS\n  );\n}\n"],"file":"time.js"}

package/lib/time.js

@@ -3,11 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.toHoursMinutesSeconds = toHoursMinutesSeconds;
 exports.getTimeFormat = getTimeFormat;
 exports.getDateFormat = getDateFormat;
 exports.getLongDateFormat = getLongDateFormat;
 exports.formatDuration = formatDuration;
 exports.formatDurationWithSeconds = formatDurationWithSeconds;
+exports.offsetTime = offsetTime;
 exports.formatTime = formatTime;
 exports.formatSecondsAfterMidnight = formatSecondsAfterMidnight;
 exports.getUserTimezone = getUserTimezone;
@@ -73,6 +75,22 @@ function formatDurationLikeMoment(seconds, showSeconds, localize = {
     locale
   });
 }
+/**
+ * Breaks up a duration in seconds into hours, minutes, and seconds.
+ * @param {number} seconds The number of seconds to break up
+ * @returns an object with fields with the corresponding, hours, minutes, seconds.
+ */
+
+
+function toHoursMinutesSeconds(seconds) {
+  const hours = Math.floor(seconds / 3600);
+  const minutes = Math.floor((seconds - hours * 3600) / 60);
+  return {
+    hours,
+    minutes,
+    seconds: seconds - hours * 3600 - minutes * 60
+  };
+}
 /**
  * @param  {[type]} config the OTP config object found in store
  * @return {string}        the config-defined time formatter or HH:mm (24-hr time)
@@ -121,6 +139,15 @@ function formatDurationWithSeconds(seconds, region) {
     code: region
   });
 }
+/**
+ * Offsets a time according to the provided time options
+ * and returns the result.
+ */
+
+
+function offsetTime(ms, options) {
+  return ms + ((options === null || options === void 0 ? void 0 : options.offset) || 0);
+}
 /**
  * Formats a time value for display in narrative
  * TODO: internationalization/timezone
@@ -130,7 +157,7 @@ function formatDurationWithSeconds(seconds, region) {
 
 
 function formatTime(ms, options) {
-  return (0, _dateFns.format)(ms + ((options === null || options === void 0 ? void 0 : options.offset) || 0), (options === null || options === void 0 ? void 0 : options.format) || OTP_API_TIME_FORMAT);
+  return (0, _dateFns.format)(offsetTime(ms, options), (options === null || options === void 0 ? void 0 : options.format) || OTP_API_TIME_FORMAT);
 }
 /**
  * Formats a seconds after midnight value for display in narrative

package/lib/time.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/time.js"],"names":["OTP_API_DATE_FORMAT","OTP_API_DATE_FORMAT_DATE_FNS","OTP_API_TIME_FORMAT","formatDurationLikeMoment","seconds","showSeconds","localize","enabled","code","hours","Math","floor","minutes","secondsLeftOver","specLookup","xHours","xMinutes","xSeconds","locale","formatDistance","spec","val","undefined","format","getTimeFormat","config","dateTime","timeFormat","getDateFormat","dateFormat","getLongDateFormat","longDateFormat","formatDuration","formatDurationWithSeconds","region","formatTime","ms","options","offset","formatSecondsAfterMidnight","time","Date","getUserTimezone","fallbackTimezone","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"mappings":";;;;;;;;;;;;;;;;;AAAA;;AAMA;;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;AACA;AACA;AACA;AACA;;;;AACA,SAASC,wBAAT,CACEC,OADF,EAEEC,WAFF,EAGEC,QAAQ,GAAG;AAAEC,EAAAA,OAAO,EAAE,IAAX;AAAiBC,EAAAA,IAAI,EAAE;AAAvB,CAHb,EAIE;AACA;AACA,MAAK,CAACH,WAAD,IAAgBD,OAAO,GAAG,EAA3B,IAAkCA,OAAO,KAAK,CAAlD,EAAqD;AACnD,WAAO,OAAP;AACD;;AAED,QAAMK,KAAK,GAAGC,IAAI,CAACC,KAAL,CAAWP,OAAO,GAAG,IAArB,CAAd;AACA,QAAMQ,OAAO,GAAGF,IAAI,CAACC,KAAL,CAAW,CAACP,OAAO,GAAGK,KAAK,GAAG,IAAnB,IAA2B,EAAtC,CAAhB;AACA,QAAMI,eAAe,GAAGR,WAAW,GAC/BD,OAAO,GAAGK,KAAK,GAAG,IAAlB,GAAyBG,OAAO,GAAG,EADJ,GAE/B,CAFJ;AAGA,QAAME,UAAU,GAAG;AACjBC,IAAAA,MAAM,EAAE,IADS;AAEjBC,IAAAA,QAAQ,EAAE,KAFO;AAGjBC,IAAAA,QAAQ,EAAE;AAHO,GAAnB;AAKA,QAAMC,MAAM,GAAGZ,QAAQ,GACnB;AACE;AACAE,IAAAA,IAAI,EAAE,CAAAF,QAAQ,SAAR,IAAAA,QAAQ,WAAR,YAAAA,QAAQ,CAAEE,IAAV,KAAkB,OAF1B;AAGEW,IAAAA,cAAc,EAAE,CAACC,IAAD,EAAOC,GAAP,KAAe;AAC7B,aAAQ,GAAEA,GAAI,IAAGP,UAAU,CAACM,IAAD,CAAO,EAAlC;AACD;AALH,GADmB,GAQnBE,SARJ;AAUA,SAAO,6BACL;AACEb,IAAAA,KADF;AAEEG,IAAAA,OAFF;AAGER,IAAAA,OAAO,EAAES;AAHX,GADK,EAML;AACEU,IAAAA,MAAM,EAAE,CAAC,OAAD,EAAU,SAAV,EAAqB,SAArB,CADV;AAEEL,IAAAA;AAFF,GANK,CAAP;AAWD;AACD;AACA;AACA;AACA;;;AACO,SAASM,aAAT,CAAuBC,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,gCAAAA,MAAM,CAAEC,QAAR,sEAAkBC,UAAlB,KAAgCzB,mBAAvC;AACD;;AAEM,SAAS0B,aAAT,CAAuBH,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBG,UAAlB,KAAgC7B,mBAAvC;AACD;;AAEM,SAAS8B,iBAAT,CAA2BL,MAA3B,EAAmC;AAAA;;AACxC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBK,cAAlB,KAAoC,aAA3C;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASC,cAAT,CAAwB5B,OAAxB,EAAiC;AACtC,SAAOD,wBAAwB,CAACC,OAAD,EAAU,KAAV,CAA/B;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAAS6B,yBAAT,CAAmC7B,OAAnC,EAA4C8B,MAA5C,EAAoD;AACzD,SAAO/B,wBAAwB,CAACC,OAAD,EAAU;AAAEG,IAAAA,OAAO,EAAE,IAAX;AAAiBC,IAAAA,IAAI,EAAE0B;AAAvB,GAAV,CAA/B;AACD;AACD;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASC,UAAT,CAAoBC,EAApB,EAAwBC,OAAxB,EAAiC;AACtC,SAAO,qBACLD,EAAE,IAAI,CAAAC,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEC,MAAT,KAAmB,CAAvB,CADG,EAEL,CAAAD,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEd,MAAT,KAAmBrB,mBAFd,CAAP;AAID;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASqC,0BAAT,CAAoCnC,OAApC,EAA6CuB,UAA7C,EAAyD;AAC9D,QAAMa,IAAI,GAAG,kBAAI,yBAAW,IAAIC,IAAJ,EAAX,CAAJ,EAA4B;AAAErC,IAAAA;AAAF,GAA5B,CAAb;AACA,SAAO,qBAAOoC,IAAP,EAAab,UAAb,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASe,eAAT,CAAyBC,gBAAgB,GAAG,eAA5C,EAA6D;AAAA;;AAClE,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,EAAsD;AAC3D,SAAO,qBAAO,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CAAP,EAA6CnD,mBAA7C,CAAP;AACD;AAED;AACA;AACA;AACA;;;AACO,SAASqD,cAAT,CAAwBF,QAAQ,GAAGX,eAAe,EAAlD,EAAsD;AAC3D,SAAO,qBACL,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CADK,EAELpD,4BAFK,CAAP;AAID","sourcesContent":["import {\n  startOfDay,\n  add,\n  format,\n  formatDuration as dateFnsFormatDuration\n} 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 * To ease the transition away from moment.js, this method uses date-fns to format durations\n * the way moment.js did.\n * @param {number}  seconds     The number of seconds to format\n * @param {boolean} showSeconds Whether to render seconds or not\n * @param {boolean} localize    If true, will create output like moment.js using date-fns locale.\n * Otherwise, uses date-fns default\n * @returns                   Formatted duration\n */\nfunction formatDurationLikeMoment(\n  seconds,\n  showSeconds,\n  localize = { enabled: true, code: \"en-US\" }\n) {\n  // date-fns doesn't do this automatically\n  if ((!showSeconds && seconds < 60) || seconds === 0) {\n    return \"0 min\";\n  }\n\n  const hours = Math.floor(seconds / 3600);\n  const minutes = Math.floor((seconds - hours * 3600) / 60);\n  const secondsLeftOver = showSeconds\n    ? seconds - hours * 3600 - minutes * 60\n    : 0;\n  const specLookup = {\n    xHours: \"hr\",\n    xMinutes: \"min\",\n    xSeconds: \"sec\"\n  };\n  const locale = localize\n    ? {\n        // Maintain backwards compatibility when called with localize=true\n        code: localize?.code || \"en-US\",\n        formatDistance: (spec, val) => {\n          return `${val} ${specLookup[spec]}`;\n        }\n      }\n    : undefined;\n\n  return dateFnsFormatDuration(\n    {\n      hours,\n      minutes,\n      seconds: secondsLeftOver\n    },\n    {\n      format: [\"hours\", \"minutes\", \"seconds\"],\n      locale\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) {\n  return config?.dateTime?.timeFormat || OTP_API_TIME_FORMAT;\n}\n\nexport function getDateFormat(config) {\n  return config?.dateTime?.dateFormat || OTP_API_DATE_FORMAT;\n}\n\nexport function getLongDateFormat(config) {\n  return config?.dateTime?.longDateFormat || \"D MMMM YYYY\";\n}\n\n/**\n * Formats an elapsed time duration for display in narrative.\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDuration(seconds) {\n  return formatDurationLikeMoment(seconds, false);\n}\n\n/**\n * Formats an elapsed time in seconds, minutes, hours duration for display in narrative\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDurationWithSeconds(seconds, region) {\n  return formatDurationLikeMoment(seconds, { enabled: true, code: region });\n}\n/**\n * Formats a time value for display in narrative\n * TODO: internationalization/timezone\n * @param {number} ms epoch time value in milliseconds\n * @returns {string} formatted text representation\n */\nexport function formatTime(ms, options) {\n  return format(\n    ms + (options?.offset || 0),\n    options?.format || OTP_API_TIME_FORMAT\n  );\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(seconds, timeFormat) {\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\") {\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()) {\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()) {\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.js"],"names":["OTP_API_DATE_FORMAT","OTP_API_DATE_FORMAT_DATE_FNS","OTP_API_TIME_FORMAT","formatDurationLikeMoment","seconds","showSeconds","localize","enabled","code","hours","Math","floor","minutes","secondsLeftOver","specLookup","xHours","xMinutes","xSeconds","locale","formatDistance","spec","val","undefined","format","toHoursMinutesSeconds","getTimeFormat","config","dateTime","timeFormat","getDateFormat","dateFormat","getLongDateFormat","longDateFormat","formatDuration","formatDurationWithSeconds","region","offsetTime","ms","options","offset","formatTime","formatSecondsAfterMidnight","time","Date","getUserTimezone","fallbackTimezone","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;;AAMA;;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;AACA;AACA;AACA;AACA;;;;AACA,SAASC,wBAAT,CACEC,OADF,EAEEC,WAFF,EAGEC,QAAQ,GAAG;AAAEC,EAAAA,OAAO,EAAE,IAAX;AAAiBC,EAAAA,IAAI,EAAE;AAAvB,CAHb,EAIE;AACA;AACA,MAAK,CAACH,WAAD,IAAgBD,OAAO,GAAG,EAA3B,IAAkCA,OAAO,KAAK,CAAlD,EAAqD;AACnD,WAAO,OAAP;AACD;;AAED,QAAMK,KAAK,GAAGC,IAAI,CAACC,KAAL,CAAWP,OAAO,GAAG,IAArB,CAAd;AACA,QAAMQ,OAAO,GAAGF,IAAI,CAACC,KAAL,CAAW,CAACP,OAAO,GAAGK,KAAK,GAAG,IAAnB,IAA2B,EAAtC,CAAhB;AACA,QAAMI,eAAe,GAAGR,WAAW,GAC/BD,OAAO,GAAGK,KAAK,GAAG,IAAlB,GAAyBG,OAAO,GAAG,EADJ,GAE/B,CAFJ;AAGA,QAAME,UAAU,GAAG;AACjBC,IAAAA,MAAM,EAAE,IADS;AAEjBC,IAAAA,QAAQ,EAAE,KAFO;AAGjBC,IAAAA,QAAQ,EAAE;AAHO,GAAnB;AAKA,QAAMC,MAAM,GAAGZ,QAAQ,GACnB;AACE;AACAE,IAAAA,IAAI,EAAE,CAAAF,QAAQ,SAAR,IAAAA,QAAQ,WAAR,YAAAA,QAAQ,CAAEE,IAAV,KAAkB,OAF1B;AAGEW,IAAAA,cAAc,EAAE,CAACC,IAAD,EAAOC,GAAP,KAAe;AAC7B,aAAQ,GAAEA,GAAI,IAAGP,UAAU,CAACM,IAAD,CAAO,EAAlC;AACD;AALH,GADmB,GAQnBE,SARJ;AAUA,SAAO,6BACL;AACEb,IAAAA,KADF;AAEEG,IAAAA,OAFF;AAGER,IAAAA,OAAO,EAAES;AAHX,GADK,EAML;AACEU,IAAAA,MAAM,EAAE,CAAC,OAAD,EAAU,SAAV,EAAqB,SAArB,CADV;AAEEL,IAAAA;AAFF,GANK,CAAP;AAWD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASM,qBAAT,CAA+BpB,OAA/B,EAAwC;AAC7C,QAAMK,KAAK,GAAGC,IAAI,CAACC,KAAL,CAAWP,OAAO,GAAG,IAArB,CAAd;AACA,QAAMQ,OAAO,GAAGF,IAAI,CAACC,KAAL,CAAW,CAACP,OAAO,GAAGK,KAAK,GAAG,IAAnB,IAA2B,EAAtC,CAAhB;AACA,SAAO;AACLA,IAAAA,KADK;AAELG,IAAAA,OAFK;AAGLR,IAAAA,OAAO,EAAEA,OAAO,GAAGK,KAAK,GAAG,IAAlB,GAAyBG,OAAO,GAAG;AAHvC,GAAP;AAKD;AAED;AACA;AACA;AACA;;;AACO,SAASa,aAAT,CAAuBC,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,gCAAAA,MAAM,CAAEC,QAAR,sEAAkBC,UAAlB,KAAgC1B,mBAAvC;AACD;;AAEM,SAAS2B,aAAT,CAAuBH,MAAvB,EAA+B;AAAA;;AACpC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBG,UAAlB,KAAgC9B,mBAAvC;AACD;;AAEM,SAAS+B,iBAAT,CAA2BL,MAA3B,EAAmC;AAAA;;AACxC,SAAO,CAAAA,MAAM,SAAN,IAAAA,MAAM,WAAN,iCAAAA,MAAM,CAAEC,QAAR,wEAAkBK,cAAlB,KAAoC,aAA3C;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASC,cAAT,CAAwB7B,OAAxB,EAAiC;AACtC,SAAOD,wBAAwB,CAACC,OAAD,EAAU,KAAV,CAA/B;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAAS8B,yBAAT,CAAmC9B,OAAnC,EAA4C+B,MAA5C,EAAoD;AACzD,SAAOhC,wBAAwB,CAACC,OAAD,EAAU;AAAEG,IAAAA,OAAO,EAAE,IAAX;AAAiBC,IAAAA,IAAI,EAAE2B;AAAvB,GAAV,CAA/B;AACD;AAED;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,UAAT,CAAoBH,EAApB,EAAwBC,OAAxB,EAAiC;AACtC,SAAO,qBACLF,UAAU,CAACC,EAAD,EAAKC,OAAL,CADL,EAEL,CAAAA,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEf,MAAT,KAAmBrB,mBAFd,CAAP;AAID;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASuC,0BAAT,CAAoCrC,OAApC,EAA6CwB,UAA7C,EAAyD;AAC9D,QAAMc,IAAI,GAAG,kBAAI,yBAAW,IAAIC,IAAJ,EAAX,CAAJ,EAA4B;AAAEvC,IAAAA;AAAF,GAA5B,CAAb;AACA,SAAO,qBAAOsC,IAAP,EAAad,UAAb,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASgB,eAAT,CAAyBC,gBAAgB,GAAG,eAA5C,EAA6D;AAAA;;AAClE,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,EAAsD;AAC3D,SAAO,qBAAO,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CAAP,EAA6CrD,mBAA7C,CAAP;AACD;AAED;AACA;AACA;AACA;;;AACO,SAASuD,cAAT,CAAwBF,QAAQ,GAAGX,eAAe,EAAlD,EAAsD;AAC3D,SAAO,qBACL,+BAAeD,IAAI,CAACa,GAAL,EAAf,EAA2BD,QAA3B,CADK,EAELtD,4BAFK,CAAP;AAID","sourcesContent":["import {\n  startOfDay,\n  add,\n  format,\n  formatDuration as dateFnsFormatDuration\n} 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 * To ease the transition away from moment.js, this method uses date-fns to format durations\n * the way moment.js did.\n * @param {number}  seconds     The number of seconds to format\n * @param {boolean} showSeconds Whether to render seconds or not\n * @param {boolean} localize    If true, will create output like moment.js using date-fns locale.\n * Otherwise, uses date-fns default\n * @returns                   Formatted duration\n */\nfunction formatDurationLikeMoment(\n  seconds,\n  showSeconds,\n  localize = { enabled: true, code: \"en-US\" }\n) {\n  // date-fns doesn't do this automatically\n  if ((!showSeconds && seconds < 60) || seconds === 0) {\n    return \"0 min\";\n  }\n\n  const hours = Math.floor(seconds / 3600);\n  const minutes = Math.floor((seconds - hours * 3600) / 60);\n  const secondsLeftOver = showSeconds\n    ? seconds - hours * 3600 - minutes * 60\n    : 0;\n  const specLookup = {\n    xHours: \"hr\",\n    xMinutes: \"min\",\n    xSeconds: \"sec\"\n  };\n  const locale = localize\n    ? {\n        // Maintain backwards compatibility when called with localize=true\n        code: localize?.code || \"en-US\",\n        formatDistance: (spec, val) => {\n          return `${val} ${specLookup[spec]}`;\n        }\n      }\n    : undefined;\n\n  return dateFnsFormatDuration(\n    {\n      hours,\n      minutes,\n      seconds: secondsLeftOver\n    },\n    {\n      format: [\"hours\", \"minutes\", \"seconds\"],\n      locale\n    }\n  );\n}\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(seconds) {\n  const hours = Math.floor(seconds / 3600);\n  const minutes = Math.floor((seconds - hours * 3600) / 60);\n  return {\n    hours,\n    minutes,\n    seconds: seconds - hours * 3600 - minutes * 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) {\n  return config?.dateTime?.timeFormat || OTP_API_TIME_FORMAT;\n}\n\nexport function getDateFormat(config) {\n  return config?.dateTime?.dateFormat || OTP_API_DATE_FORMAT;\n}\n\nexport function getLongDateFormat(config) {\n  return config?.dateTime?.longDateFormat || \"D MMMM YYYY\";\n}\n\n/**\n * Formats an elapsed time duration for display in narrative.\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDuration(seconds) {\n  return formatDurationLikeMoment(seconds, false);\n}\n\n/**\n * Formats an elapsed time in seconds, minutes, hours duration for display in narrative\n * TODO: internationalization\n * @param {number} seconds duration in seconds\n * @returns {string} formatted text representation\n */\nexport function formatDurationWithSeconds(seconds, region) {\n  return formatDurationLikeMoment(seconds, { enabled: true, code: region });\n}\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 time value for display in narrative\n * TODO: internationalization/timezone\n * @param {number} ms epoch time value in milliseconds\n * @returns {string} formatted text representation\n */\nexport function formatTime(ms, options) {\n  return format(\n    offsetTime(ms, options),\n    options?.format || OTP_API_TIME_FORMAT\n  );\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(seconds, timeFormat) {\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\") {\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()) {\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()) {\n  return format(\n    utcToZonedTime(Date.now(), timezone),\n    OTP_API_DATE_FORMAT_DATE_FNS\n  );\n}\n"],"file":"time.js"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentripplanner/core-utils",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "description": "Core functionality that is shared among numerous UI components",
   "engines": {
     "node": ">=13"

package/src/time.js

@@ -65,6 +65,22 @@ function formatDurationLikeMoment(
     }
   );
 }
+
+/**
+ * Breaks up a duration in seconds into hours, minutes, and seconds.
+ * @param {number} seconds The number of seconds to break up
+ * @returns an object with fields with the corresponding, hours, minutes, seconds.
+ */
+export function toHoursMinutesSeconds(seconds) {
+  const hours = Math.floor(seconds / 3600);
+  const minutes = Math.floor((seconds - hours * 3600) / 60);
+  return {
+    hours,
+    minutes,
+    seconds: seconds - hours * 3600 - minutes * 60
+  };
+}
+
 /**
  * @param  {[type]} config the OTP config object found in store
  * @return {string}        the config-defined time formatter or HH:mm (24-hr time)
@@ -100,6 +116,15 @@ export function formatDuration(seconds) {
 export function formatDurationWithSeconds(seconds, region) {
   return formatDurationLikeMoment(seconds, { enabled: true, code: region });
 }
+
+/**
+ * Offsets a time according to the provided time options
+ * and returns the result.
+ */
+export function offsetTime(ms, options) {
+  return ms + (options?.offset || 0);
+}
+
 /**
  * Formats a time value for display in narrative
  * TODO: internationalization/timezone
@@ -108,7 +133,7 @@ export function formatDurationWithSeconds(seconds, region) {
  */
 export function formatTime(ms, options) {
   return format(
-    ms + (options?.offset || 0),
+    offsetTime(ms, options),
     options?.format || OTP_API_TIME_FORMAT
   );
 }