@opentripplanner/core-utils 4.11.6-alpha.1 → 5.0.1

package/src/{storage.js → storage.ts}

@@ -1,10 +1,11 @@
+/* eslint-disable no-console */
 // Prefix to use with local storage keys.
 const STORAGE_PREFIX = "otp";
 
 /**
  * Store a javascript object at the specified key.
  */
-export function storeItem(key, object) {
+export function storeItem(key: string, object: unknown): void {
   window.localStorage.setItem(
     `${STORAGE_PREFIX}.${key}`,
     JSON.stringify(object)
@@ -15,8 +16,8 @@ export function storeItem(key, object) {
  * Retrieve a javascript object at the specified key. If not found, defaults to
  * null or, the optionally provided notFoundValue.
  */
-export function getItem(key, notFoundValue = null) {
-  let itemAsString;
+export function getItem(key: string, notFoundValue: unknown = null): unknown {
+  let itemAsString: string;
   try {
     itemAsString = window.localStorage.getItem(`${STORAGE_PREFIX}.${key}`);
     const json = JSON.parse(itemAsString);
@@ -32,7 +33,7 @@ export function getItem(key, notFoundValue = null) {
 /**
  * Remove item at specified key.
  */
-export function removeItem(key) {
+export function removeItem(key: string): void {
   window.localStorage.removeItem(`${STORAGE_PREFIX}.${key}`);
 }
 
@@ -40,7 +41,7 @@ export function removeItem(key) {
  * Generate a random ID. This might not quite be a UUID, but it serves our
  * purposes for now.
  */
-export function randId() {
+export function randId(): string {
   return Math.random()
     .toString(36)
     .substr(2, 9);

package/src/{time.js → time.ts}

@@ -1,3 +1,4 @@
+import { Config } from "@opentripplanner/types";
 import {
   startOfDay,
   add,
@@ -6,6 +7,15 @@ import {
 } from "date-fns";
 import { utcToZonedTime } from "date-fns-tz";
 
+/* eslint-disable import/no-cycle */
+import {
+  formatTime,
+  formatDurationWithSeconds,
+  formatDuration
+} from "./deprecated-with-types";
+
+export { formatTime, formatDuration, formatDurationWithSeconds };
+
 // 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";
@@ -23,11 +33,14 @@ export const OTP_API_TIME_FORMAT = "HH:mm";
  * Otherwise, uses date-fns default
  * @returns                   Formatted duration
  */
-function formatDurationLikeMoment(
-  seconds,
-  showSeconds,
-  localize = { enabled: true, code: "en-US" }
-) {
+export function formatDurationLikeMoment(
+  seconds: number,
+  showSeconds: boolean,
+  localize: { enabled: boolean; code: string } = {
+    enabled: true,
+    code: "en-US"
+  }
+): string {
   // date-fns doesn't do this automatically
   if ((!showSeconds && seconds < 60) || seconds === 0) {
     return "0 min";
@@ -85,38 +98,17 @@ export function toHoursMinutesSeconds(seconds) {
  * @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) {
+export function getTimeFormat(config: Config): string {
   return config?.dateTime?.timeFormat || OTP_API_TIME_FORMAT;
 }
 
-export function getDateFormat(config) {
+export function getDateFormat(config: Config): string {
   return config?.dateTime?.dateFormat || OTP_API_DATE_FORMAT;
 }
 
-export function getLongDateFormat(config) {
+export function getLongDateFormat(config: Config): string {
   return config?.dateTime?.longDateFormat || "D MMMM YYYY";
 }
-
-/**
- * Formats an elapsed time duration for display in narrative.
- * TODO: internationalization
- * @param {number} seconds duration in seconds
- * @returns {string} formatted text representation
- */
-export function formatDuration(seconds) {
-  return formatDurationLikeMoment(seconds, false);
-}
-
-/**
- * Formats an elapsed time in seconds, minutes, hours duration for display in narrative
- * @param {number} seconds duration in seconds
- * @param {object} region  an object that allows internationalization of the time
- * @returns {string}       formatted text representation
- */
-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.
@@ -125,26 +117,16 @@ export function offsetTime(ms, options) {
   return ms + (options?.offset || 0);
 }
 
-/**
- * Formats a time value for display in narrative
- * TODO: internationalization/timezone
- * @param {number} ms epoch time value in milliseconds
- * @returns {string} formatted text representation
- */
-export function formatTime(ms, options) {
-  return format(
-    offsetTime(ms, options),
-    options?.format || OTP_API_TIME_FORMAT
-  );
-}
-
 /**
  * Formats a seconds after midnight value for display in narrative
  * @param  {number} seconds  time since midnight in seconds
  * @param  {string} timeFormat  A valid date-fns time format
  * @return {string}                   formatted text representation
  */
-export function formatSecondsAfterMidnight(seconds, timeFormat) {
+export function formatSecondsAfterMidnight(
+  seconds: number,
+  timeFormat: string
+): string {
   const time = add(startOfDay(new Date()), { seconds });
   return format(time, timeFormat);
 }
@@ -154,7 +136,7 @@ export function formatSecondsAfterMidnight(seconds, timeFormat) {
  * environment, pulls timezone information from an env variable. Default to
  * GMT+0 if the Intl API is unavailable.
  */
-export function getUserTimezone(fallbackTimezone = "Etc/Greenwich") {
+export function getUserTimezone(fallbackTimezone = "Etc/Greenwich"): string {
   if (process.env.NODE_ENV === "test") return process.env.TZ;
   return Intl?.DateTimeFormat().resolvedOptions().timeZone || fallbackTimezone;
 }
@@ -163,7 +145,7 @@ export function getUserTimezone(fallbackTimezone = "Etc/Greenwich") {
  * Formats current time for use in OTP query
  * The conversion to the user's timezone is needed for testing purposes.
  */
-export function getCurrentTime(timezone = getUserTimezone()) {
+export function getCurrentTime(timezone = getUserTimezone()): string {
   return format(utcToZonedTime(Date.now(), timezone), OTP_API_TIME_FORMAT);
 }
 
@@ -171,7 +153,7 @@ export function getCurrentTime(timezone = getUserTimezone()) {
  * Formats current date for use in OTP query
  * The conversion to the user's timezone is needed for testing purposes.
  */
-export function getCurrentDate(timezone = getUserTimezone()) {
+export function getCurrentDate(timezone = getUserTimezone()): string {
   return format(
     utcToZonedTime(Date.now(), timezone),
     OTP_API_DATE_FORMAT_DATE_FNS

package/src/{ui.js → ui.ts}

@@ -1,6 +1,6 @@
 import bowser from "bowser";
 
-export function isMobile() {
+export function isMobile(): boolean {
   // TODO: consider using 3rd-party library?
   return /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(
     navigator.userAgent
@@ -10,8 +10,8 @@ export function isMobile() {
 /**
  * Returns true if the user is using a [redacted] browser
  */
-export function isIE() {
-  return bowser.name === "Internet Explorer";
+export function isIE(): boolean {
+  return bowser.parse(navigator.userAgent).browser === "Internet Explorer";
 }
 
 /**
@@ -20,16 +20,16 @@ export function isIE() {
  * and intended to fix issues with iOS elastic scrolling, e.g.,
  * https://github.com/conveyal/trimet-mod-otp/issues/92.
  */
-export function enableScrollForSelector(selector) {
+export function enableScrollForSelector(selector: string): void {
   const overlay = document.querySelector(selector);
   let clientY = null; // remember Y position on touch start
 
-  function isOverlayTotallyScrolled() {
+  function isOverlayTotallyScrolled(): boolean {
     // https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollHeight#Problems_and_solutions
     return overlay.scrollHeight - overlay.scrollTop <= overlay.clientHeight;
   }
 
-  function disableRubberBand(event) {
+  function disableRubberBand(event: TouchEvent) {
     const clientYDelta = event.targetTouches[0].clientY - clientY;
 
     if (overlay.scrollTop === 0 && clientYDelta > 0) {
@@ -45,7 +45,7 @@ export function enableScrollForSelector(selector) {
 
   overlay.addEventListener(
     "touchstart",
-    function(event) {
+    function(event: TouchEvent) {
       if (event.targetTouches.length === 1) {
         // detect single touch
         clientY = event.targetTouches[0].clientY;
@@ -56,7 +56,7 @@ export function enableScrollForSelector(selector) {
 
   overlay.addEventListener(
     "touchmove",
-    function(event) {
+    function(event: TouchEvent) {
       if (event.targetTouches.length === 1) {
         // detect single touch
         disableRubberBand(event);

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "references": [
+    {
+      "path": "../types"
+    }
+  ]
+}