@opentripplanner/core-utils 13.0.0-alpha.4 → 14.0.0-alpha.1

package/esm/time.js.map

@@ -1 +1 @@
-{"version":3,"file":"time.js","names":["startOfDay","add","format","utcToZonedTime","OTP_API_DATE_FORMAT","OTP_API_TIME_FORMAT","toHoursMinutesSeconds","seconds","hours","Math","floor","minutes","getTimeFormat","config","_config$dateTime","dateTime","timeFormat","getDateFormat","_config$dateTime2","dateFormat","getLongDateFormat","_config$dateTime3","longDateFormat","offsetTime","ms","options","offset","formatSecondsAfterMidnight","time","Date","getUserTimezone","_Intl","fallbackTimezone","arguments","length","undefined","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"sources":["../src/time.ts"],"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\n/** @deprecated */\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"],"mappings":"AACA,SAASA,UAAU,EAAEC,GAAG,EAAEC,MAAM,QAAQ,UAAU;AAClD,SAASC,cAAc,QAAQ,aAAa;;AAE5C;AACA;AACA,OAAO,IAAMC,mBAAmB,GAAG,YAAY;AAC/C,OAAO,IAAMC,mBAAmB,GAAG,OAAO;;AAE1C;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,qBAAqBA,CACnCC,OAAe,EAKf;EACA,OAAO;IACLC,KAAK,EAAEC,IAAI,CAACC,KAAK,CAACH,OAAO,GAAG,IAAI,CAAC;IACjCI,OAAO,EAAEF,IAAI,CAACC,KAAK,CAACH,OAAO,GAAG,EAAE,CAAC,GAAG,EAAE;IACtCA,OAAO,EAAEA,OAAO,GAAG;EACrB,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASK,aAAaA,CAACC,MAAc,EAAU;EAAA,IAAAC,gBAAA;EACpD,OAAO,CAAAD,MAAM,aAANA,MAAM,gBAAAC,gBAAA,GAAND,MAAM,CAAEE,QAAQ,cAAAD,gBAAA,uBAAhBA,gBAAA,CAAkBE,UAAU,KAAIX,mBAAmB;AAC5D;AAEA,OAAO,SAASY,aAAaA,CAACJ,MAAc,EAAU;EAAA,IAAAK,iBAAA;EACpD,OAAO,CAAAL,MAAM,aAANA,MAAM,gBAAAK,iBAAA,GAANL,MAAM,CAAEE,QAAQ,cAAAG,iBAAA,uBAAhBA,iBAAA,CAAkBC,UAAU,KAAIf,mBAAmB;AAC5D;;AAEA;AACA,OAAO,SAASgB,iBAAiBA,CAACP,MAAc,EAAU;EAAA,IAAAQ,iBAAA;EACxD,OAAO,CAAAR,MAAM,aAANA,MAAM,gBAAAQ,iBAAA,GAANR,MAAM,CAAEE,QAAQ,cAAAM,iBAAA,uBAAhBA,iBAAA,CAAkBC,cAAc,KAAI,aAAa;AAC1D;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACC,EAAE,EAAEC,OAAO,EAAE;EACtC,OAAOD,EAAE,IAAI,CAAAC,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEC,MAAM,KAAI,CAAC,CAAC;AACpC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,0BAA0BA,CACxCpB,OAAe,EACfS,UAAkB,EACV;EACR,IAAMY,IAAI,GAAG3B,GAAG,CAACD,UAAU,CAAC,IAAI6B,IAAI,CAAC,CAAC,CAAC,EAAE;IAAEtB,OAAO,EAAPA;EAAQ,CAAC,CAAC;EACrD,OAAOL,MAAM,CAAC0B,IAAI,EAAEZ,UAAU,CAAC;AACjC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASc,eAAeA,CAAA,EAA6C;EAAA,IAAAC,KAAA;EAAA,IAA5CC,gBAAgB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,eAAe;EAChE,IAAIG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,MAAM,EAAE,OAAOF,OAAO,CAACC,GAAG,CAACE,EAAE;EAC1D,OAAO,EAAAR,KAAA,GAAAS,IAAI,cAAAT,KAAA,uBAAJA,KAAA,CAAMU,cAAc,CAAC,CAAC,CAACC,eAAe,CAAC,CAAC,CAACC,QAAQ,KAAIX,gBAAgB;AAC9E;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASY,cAAcA,CAAA,EAAuC;EAAA,IAAtCC,QAAQ,GAAAZ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGH,eAAe,CAAC,CAAC;EACzD,OAAO5B,MAAM,CAACC,cAAc,CAAC0B,IAAI,CAACiB,GAAG,CAAC,CAAC,EAAED,QAAQ,CAAC,EAAExC,mBAAmB,CAAC;AAC1E;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAAS0C,cAAcA,CAAA,EAAuC;EAAA,IAAtCF,QAAQ,GAAAZ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGH,eAAe,CAAC,CAAC;EACzD,OAAO5B,MAAM,CAACC,cAAc,CAAC0B,IAAI,CAACiB,GAAG,CAAC,CAAC,EAAED,QAAQ,CAAC,EAAEzC,mBAAmB,CAAC;AAC1E","ignoreList":[]}
+{"version":3,"file":"time.js","names":["startOfDay","add","format","utcToZonedTime","OTP_API_DATE_FORMAT","OTP_API_TIME_FORMAT","toHoursMinutesSeconds","seconds","hours","Math","floor","minutes","ensureAtLeastOneMinute","duration","getTimeFormat","config","_config$dateTime","dateTime","timeFormat","getDateFormat","_config$dateTime2","dateFormat","getLongDateFormat","_config$dateTime3","longDateFormat","offsetTime","ms","options","offset","formatSecondsAfterMidnight","time","Date","getUserTimezone","_Intl","fallbackTimezone","arguments","length","undefined","process","env","NODE_ENV","TZ","Intl","DateTimeFormat","resolvedOptions","timeZone","getCurrentTime","timezone","now","getCurrentDate"],"sources":["../src/time.ts"],"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 * If a duration is less than 60 seconds, round it to one minute, to avoid a duration\n * of 0 minutes on a leg.\n * @param {number} duration The leg or trip duration in seconds\n * @returns a duration in seconds of at least 60 seconds.\n */\nexport const ensureAtLeastOneMinute = (duration: number): number =>\n  duration < 60 ? 60 : duration;\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\n/** @deprecated */\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"],"mappings":"AACA,SAASA,UAAU,EAAEC,GAAG,EAAEC,MAAM,QAAQ,UAAU;AAClD,SAASC,cAAc,QAAQ,aAAa;;AAE5C;AACA;AACA,OAAO,IAAMC,mBAAmB,GAAG,YAAY;AAC/C,OAAO,IAAMC,mBAAmB,GAAG,OAAO;;AAE1C;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,qBAAqBA,CACnCC,OAAe,EAKf;EACA,OAAO;IACLC,KAAK,EAAEC,IAAI,CAACC,KAAK,CAACH,OAAO,GAAG,IAAI,CAAC;IACjCI,OAAO,EAAEF,IAAI,CAACC,KAAK,CAACH,OAAO,GAAG,EAAE,CAAC,GAAG,EAAE;IACtCA,OAAO,EAAEA,OAAO,GAAG;EACrB,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMK,sBAAsB,GAAG,SAAzBA,sBAAsBA,CAAIC,QAAgB;EAAA,OACrDA,QAAQ,GAAG,EAAE,GAAG,EAAE,GAAGA,QAAQ;AAAA;;AAE/B;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACC,MAAc,EAAU;EAAA,IAAAC,gBAAA;EACpD,OAAO,CAAAD,MAAM,aAANA,MAAM,gBAAAC,gBAAA,GAAND,MAAM,CAAEE,QAAQ,cAAAD,gBAAA,uBAAhBA,gBAAA,CAAkBE,UAAU,KAAIb,mBAAmB;AAC5D;AAEA,OAAO,SAASc,aAAaA,CAACJ,MAAc,EAAU;EAAA,IAAAK,iBAAA;EACpD,OAAO,CAAAL,MAAM,aAANA,MAAM,gBAAAK,iBAAA,GAANL,MAAM,CAAEE,QAAQ,cAAAG,iBAAA,uBAAhBA,iBAAA,CAAkBC,UAAU,KAAIjB,mBAAmB;AAC5D;;AAEA;AACA,OAAO,SAASkB,iBAAiBA,CAACP,MAAc,EAAU;EAAA,IAAAQ,iBAAA;EACxD,OAAO,CAAAR,MAAM,aAANA,MAAM,gBAAAQ,iBAAA,GAANR,MAAM,CAAEE,QAAQ,cAAAM,iBAAA,uBAAhBA,iBAAA,CAAkBC,cAAc,KAAI,aAAa;AAC1D;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACC,EAAE,EAAEC,OAAO,EAAE;EACtC,OAAOD,EAAE,IAAI,CAAAC,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEC,MAAM,KAAI,CAAC,CAAC;AACpC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,0BAA0BA,CACxCtB,OAAe,EACfW,UAAkB,EACV;EACR,IAAMY,IAAI,GAAG7B,GAAG,CAACD,UAAU,CAAC,IAAI+B,IAAI,CAAC,CAAC,CAAC,EAAE;IAAExB,OAAO,EAAPA;EAAQ,CAAC,CAAC;EACrD,OAAOL,MAAM,CAAC4B,IAAI,EAAEZ,UAAU,CAAC;AACjC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASc,eAAeA,CAAA,EAA6C;EAAA,IAAAC,KAAA;EAAA,IAA5CC,gBAAgB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,eAAe;EAChE,IAAIG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,MAAM,EAAE,OAAOF,OAAO,CAACC,GAAG,CAACE,EAAE;EAC1D,OAAO,EAAAR,KAAA,GAAAS,IAAI,cAAAT,KAAA,uBAAJA,KAAA,CAAMU,cAAc,CAAC,CAAC,CAACC,eAAe,CAAC,CAAC,CAACC,QAAQ,KAAIX,gBAAgB;AAC9E;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASY,cAAcA,CAAA,EAAuC;EAAA,IAAtCC,QAAQ,GAAAZ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGH,eAAe,CAAC,CAAC;EACzD,OAAO9B,MAAM,CAACC,cAAc,CAAC4B,IAAI,CAACiB,GAAG,CAAC,CAAC,EAAED,QAAQ,CAAC,EAAE1C,mBAAmB,CAAC;AAC1E;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAAS4C,cAAcA,CAAA,EAAuC;EAAA,IAAtCF,QAAQ,GAAAZ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGH,eAAe,CAAC,CAAC;EACzD,OAAO9B,MAAM,CAACC,cAAc,CAAC4B,IAAI,CAACiB,GAAG,CAAC,CAAC,EAAED,QAAQ,CAAC,EAAE3C,mBAAmB,CAAC;AAC1E","ignoreList":[]}