Merge pull request #367 from opentripplanner/typescript-core-utils

Add Typescript to `core-utils`

Author: miles-grant-ibigroup

Diff for: __snapshots__/storybook.test.ts.snap

@@ -9,7 +9,6 @@
   "module": "esm/index.js",
   "private": false,
   "dependencies": {
-    "@opentripplanner/core-utils": "^4.5.0",
     "prop-types": "^15.7.2"
   },
   "peerDependencies": {

Diff for: packages/base-map/package.json

@@ -1,7 +1,6 @@
 import React, { Component } from "react";
 import PropTypes from "prop-types";
 import { LayersControl, Map, Popup, TileLayer } from "react-leaflet";
-import utils from "@opentripplanner/core-utils";
 import L from "leaflet";
 
 import * as Styled from "./styled";
@@ -332,7 +331,10 @@ BaseMap.propTypes = {
   /**
    * The center of the map, as a [lat, lng] array.
    */
-  center: utils.types.latlngType.isRequired,
+  // center: utils.types.latlngType.isRequired,
+  // Typescript TODO: restore correct type
+  // eslint-disable-next-line react/forbid-prop-types
+  center: PropTypes.array.isRequired,
   /**
    * The maximum zoom level allowed on the map.
    */
@@ -379,7 +381,10 @@ BaseMap.propTypes = {
    */
   popup: PropTypes.shape({
     contents: PropTypes.node.isRequired,
-    location: utils.types.latlngType.isRequired
+    // Typescript TODO: restore correct type
+    // eslint-disable-next-line react/forbid-prop-types
+    location: PropTypes.object.isRequired
+    // location: utils.types.latlngType.isRequired
   }),
   /**
    * The zoom level of the map.

Diff for: packages/base-map/src/index.js

@@ -26,5 +26,8 @@
     "qs": "^6.9.1"
   },
   "gitHead": "0af1b7cda60bd4252b219dcf893e01c2acb2ed5d",
+  "scripts": {
+    "tsc": "tsc"
+  },
   "devDependencies": {}
 }

Diff for: packages/core-utils/package.json

@@ -35,18 +35,18 @@ Array [
 
 exports[`util > route routeComparator should prioritize routes with valid sortOrder 1`] = `
 Array [
-  Object {
-    "longName": "Around town",
-    "mode": "BUS",
-    "shortName": "20",
-    "sortOrder": 2,
-  },
   Object {
     "longName": "Around another town",
     "shortName": "3",
     "sortOrder": -999,
     "type": 3,
   },
+  Object {
+    "longName": "Around town",
+    "mode": "BUS",
+    "shortName": "20",
+    "sortOrder": 2,
+  },
 ]
 `;
 
@@ -191,6 +191,30 @@ Array [
     "shortName": "IC",
     "sortOrder": 2,
   },
+  Object {
+    "longName": "A-line",
+    "mode": "BUS",
+    "shortName": "A",
+    "sortOrder": -999,
+  },
+  Object {
+    "longName": "B-line",
+    "mode": "BUS",
+    "shortName": "B",
+    "sortOrder": -999,
+  },
+  Object {
+    "longName": "Loop route",
+    "mode": "BUS",
+    "shortName": "2",
+    "sortOrder": -999,
+  },
+  Object {
+    "longName": "Around another town",
+    "shortName": "3",
+    "sortOrder": -999,
+    "type": 3,
+  },
   Object {
     "longName": "Local route",
     "mode": "BUS",
@@ -239,30 +263,6 @@ Array [
     "shortName": "10",
     "sortOrder": 10,
   },
-  Object {
-    "longName": "A-line",
-    "mode": "BUS",
-    "shortName": "A",
-    "sortOrder": -999,
-  },
-  Object {
-    "longName": "B-line",
-    "mode": "BUS",
-    "shortName": "B",
-    "sortOrder": -999,
-  },
-  Object {
-    "longName": "Loop route",
-    "mode": "BUS",
-    "shortName": "2",
-    "sortOrder": -999,
-  },
-  Object {
-    "longName": "Around another town",
-    "shortName": "3",
-    "sortOrder": -999,
-    "type": 3,
-  },
   Object {
     "longName": "A meandering route",
     "mode": "BUS",

Diff for: packages/core-utils/src/__tests__/__snapshots__/route.js.snap

@@ -0,0 +1,62 @@
+/* eslint-disable import/no-cycle */
+import { TimeOptions } from "@opentripplanner/types";
+import { format } from "date-fns";
+
+import { logDeprecationWarning } from "./deprecated";
+import {
+  formatDurationLikeMoment,
+  offsetTime,
+  OTP_API_TIME_FORMAT
+} from "./time";
+
+// time.ts
+
+/**
+ * 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: number, options: TimeOptions): string {
+  logDeprecationWarning("formatTime", "formatjs");
+
+  return format(
+    offsetTime(ms, options),
+    options?.format || OTP_API_TIME_FORMAT
+  );
+}
+
+/**
+ * Formats an elapsed time duration for display in narrative.
+ * TODO: internationalization
+ * @param {number} seconds duration in seconds
+ * @returns {string} formatted text representation
+ */
+// TS TODO: region as type?
+export function formatDuration(seconds: number, region: string): string {
+  logDeprecationWarning("formatDuration", "formatjs");
+
+  return formatDurationLikeMoment(seconds, false, {
+    enabled: true,
+    code: region
+  });
+}
+
+/**
+ * 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
+ */
+// TS TODO: region as type?
+export function formatDurationWithSeconds(
+  seconds: number,
+  region: string
+): string {
+  logDeprecationWarning("formatDurationWithSeconds", "formatjs");
+
+  return formatDurationLikeMoment(seconds, true, {
+    enabled: true,
+    code: region
+  });
+}

Diff for: packages/core-utils/src/deprecated-with-types.ts

@@ -1,26 +1,22 @@
 import * as itinerary from "./itinerary";
 import * as map from "./map";
-import * as messages from "./messages";
 import * as profile from "./profile";
 import * as query from "./query";
 import * as queryParams from "./query-params";
 import * as route from "./route";
 import * as storage from "./storage";
 import * as time from "./time";
-import * as types from "./types";
 import * as ui from "./ui";
 
 const core = {
   itinerary,
   map,
-  messages,
   profile,
   query,
   queryParams,
   route,
   storage,
   time,
-  types,
   ui
 };