@opentripplanner/core-utils 4.11.4 → 5.0.0

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

@@ -1,3 +1,4 @@
+import { Leg, Route, TransitOperator } from "@opentripplanner/types";
 /**
  * Returns the transit operator (if an exact match is found) from the transit
  * operators config value. It is critical to use both the feedId and agencyId in
@@ -11,10 +12,10 @@
  *    was found
  */
 export function getTransitOperatorFromFeedIdAndAgencyId(
-  feedId,
-  agencyId,
-  transitOperators
-) {
+  feedId: string,
+  agencyId: string | number,
+  transitOperators: TransitOperator[]
+): TransitOperator {
   return (
     transitOperators.find(
       transitOperator =>
@@ -32,7 +33,10 @@ export function getTransitOperatorFromFeedIdAndAgencyId(
  * @param  {object} transitOperators transitOperators from config.
  * @return {object} the operator if one was found or null if no match was found
  */
-export function getTransitOperatorFromLeg(leg, transitOperators) {
+export function getTransitOperatorFromLeg(
+  leg: Leg,
+  transitOperators: TransitOperator[]
+): TransitOperator {
   if (!leg.routeId || !leg.agencyId) return null;
   const feedId = leg.routeId.split(":")[0];
   return getTransitOperatorFromFeedIdAndAgencyId(
@@ -52,10 +56,13 @@ export function getTransitOperatorFromLeg(leg, transitOperators) {
  * @param  {array} transitOperators transitOperators from config
  * @return {object} the operator if one was found or null if no match was found
  */
-export function getTransitOperatorFromOtpRoute(route, transitOperators) {
+export function getTransitOperatorFromOtpRoute(
+  route: Route,
+  transitOperators: TransitOperator[]
+): TransitOperator {
   if (!route.id) return null;
   const feedId = route.id.split(":")[0];
-  let agencyId;
+  let agencyId: string | number;
   if (route.agency) {
     // This is returned in the OTP Route model
     agencyId = route.agency.id;
@@ -97,7 +104,10 @@ const END_OF_LIST_COMPARATOR_VALUE = 999999999999;
  *   the transitOperators value is not defined. Otherwise an integer will be
  *   returned.
  */
-function getTransitOperatorComparatorValue(route, transitOperators) {
+function getTransitOperatorComparatorValue(
+  route: Route,
+  transitOperators: TransitOperator[]
+): number | string {
   // if the transitOperators is undefined or has zero length, use the route's
   // agency name as the comparator value
   if (!transitOperators || transitOperators.length === 0) {
@@ -129,8 +139,8 @@ function getTransitOperatorComparatorValue(route, transitOperators) {
  * Calculates the sort comparator value given two routes based off of the
  * route's agency and provided transitOperators config data.
  */
-function makeTransitOperatorComparator(transitOperators) {
-  return (a, b) => {
+function makeTransitOperatorComparator(transitOperators: TransitOperator[]) {
+  return (a: Route, b: Route) => {
     const aVal = getTransitOperatorComparatorValue(a, transitOperators);
     const bVal = getTransitOperatorComparatorValue(b, transitOperators);
     if (typeof aVal === "string") {
@@ -140,8 +150,7 @@ function makeTransitOperatorComparator(transitOperators) {
       if (aVal > bVal) return 1;
       return 0;
     }
-
-    // transitOperators are defined and therefore a numeric value is guaranteed
+    // @ts-expect-error transitOperators are defined and therefore a numeric value is guaranteed
     // to be returned
     return aVal - bVal;
   };
@@ -151,9 +160,13 @@ function makeTransitOperatorComparator(transitOperators) {
  * Gets the desired sort values according to an optional getter function. If the
  * getter function is not defined, the original sort values are returned.
  */
-function getSortValues(getterFn, a, b) {
-  let aVal;
-  let bVal;
+function getSortValues(
+  getterFn: (item: unknown) => unknown,
+  a: unknown,
+  b: unknown
+) {
+  let aVal: unknown;
+  let bVal: unknown;
   if (typeof getterFn === "function") {
     aVal = getterFn(a);
     bVal = getterFn(b);
@@ -199,11 +212,11 @@ const routeTypeComparatorValue = {
 // Gets a comparator value for a given route's type (OTP mode).
 // Note: JSDoc format not used to avoid bug in documentationjs.
 // ttps://github.com/documentationjs/documentation/issues/372
-function getRouteTypeComparatorValue(route) {
+function getRouteTypeComparatorValue(route: Route): number {
   // For some strange reason, the short route response in OTP returns the
   // string-based modes, but the long route response returns the
   // integer route type. This attempts to account for both of those cases.
-  if (!route) throw new Error("Route is undefined.", route);
+  if (!route) throw new Error(`Route is undefined. ${route}`);
   if (typeof modeComparatorValue[route.mode] !== "undefined") {
     return modeComparatorValue[route.mode];
   }
@@ -212,6 +225,7 @@ function getRouteTypeComparatorValue(route) {
   }
   // Default the comparator value to a large number (placing the route at the
   // end of the list).
+  // eslint-disable-next-line no-console
   console.warn("no mode/route type found for route", route);
   return END_OF_LIST_COMPARATOR_VALUE;
 }
@@ -220,7 +234,7 @@ function getRouteTypeComparatorValue(route) {
  * Calculates the sort comparator value given two routes based off of route type
  * (OTP mode).
  */
-function routeTypeComparator(a, b) {
+function routeTypeComparator(a: Route, b: Route): number {
   return getRouteTypeComparatorValue(a) - getRouteTypeComparatorValue(b);
 }
 
@@ -228,7 +242,7 @@ function routeTypeComparator(a, b) {
  * Determines whether a value is a string that starts with an alphabetic
  * ascii character.
  */
-function startsWithAlphabeticCharacter(val) {
+function startsWithAlphabeticCharacter(val: unknown): boolean {
   if (typeof val === "string" && val.length > 0) {
     const firstCharCode = val.charCodeAt(0);
     return (
@@ -244,7 +258,7 @@ function startsWithAlphabeticCharacter(val) {
  * character. Routes with shortn that do start with an alphabetic character will
  * be prioritized over those that don't.
  */
-function alphabeticShortNameComparator(a, b) {
+function alphabeticShortNameComparator(a: Route, b: Route): number {
   const aStartsWithAlphabeticCharacter = startsWithAlphabeticCharacter(
     a.shortName
   );
@@ -284,11 +298,15 @@ function alphabeticShortNameComparator(a, b) {
  * @param  {function} [objGetterFn] An optional function to obtain the
  *  comparison value from the comparator function arguments
  */
-export function makeNumericValueComparator(objGetterFn) {
+export function makeNumericValueComparator(
+  objGetterFn?: (item: Route) => number
+) {
   /* Note: Using the global version of isNaN (the Number version behaves differently. */
   /* eslint-disable no-restricted-globals */
-  return (a, b) => {
+  return (a: number, b: number): number => {
     const { aVal, bVal } = getSortValues(objGetterFn, a, b);
+    if (typeof aVal !== "number" || typeof bVal !== "number") return 0;
+
     // if both values aren't valid numbers, use the next sort criteria
     if (isNaN(aVal) && isNaN(bVal)) return 0;
     // b is a valid number, b gets priority
@@ -310,8 +328,10 @@ export function makeNumericValueComparator(objGetterFn) {
  * @param  {function} [objGetterFn] An optional function to obtain the
  *  comparison value from the comparator function arguments
  */
-export function makeStringValueComparator(objGetterFn) {
-  return (a, b) => {
+export function makeStringValueComparator(
+  objGetterFn?: (item: Route) => string
+) {
+  return (a: string, b: string): number => {
     const { aVal, bVal } = getSortValues(objGetterFn, a, b);
     // both a and b are uncomparable strings, return equivalent value
     if (!aVal && !bVal) return 0;
@@ -334,7 +354,7 @@ export function makeStringValueComparator(objGetterFn) {
  * See https://github.com/opentripplanner/OpenTripPlanner/issues/2938
  * Also see https://github.com/opentripplanner/otp-react-redux/issues/122
  */
-function getRouteSortOrderValue(val) {
+function getRouteSortOrderValue(val: number): number {
   return val === -999 ? undefined : val;
 }
 
@@ -345,8 +365,10 @@ function getRouteSortOrderValue(val) {
  * returned. If all comparison functions return equivalence, then the values
  * are assumed to be equivalent.
  */
-function makeMultiCriteriaSort(...criteria) {
-  return (a, b) => {
+function makeMultiCriteriaSort(
+  ...criteria: ((a: unknown, b: unknown) => number)[]
+) {
+  return (a: number, b: number): number => {
     for (let i = 0; i < criteria.length; i++) {
       const curCriteriaComparatorValue = criteria[i](a, b);
       // if the comparison objects are not equivalent, return the value obtained
@@ -390,7 +412,9 @@ function makeMultiCriteriaSort(...criteria) {
  *    those with shortNames.
  *  7. longName as string.
  */
-export function makeRouteComparator(transitOperators) {
+export function makeRouteComparator(
+  transitOperators: TransitOperator[]
+): (a: number, b: number) => number {
   return makeMultiCriteriaSort(
     makeTransitOperatorComparator(transitOperators),
     makeNumericValueComparator(obj => getRouteSortOrderValue(obj.sortOrder)),

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"
+    }
+  ]
+}