feat(util): enable date formatter to accept upstream timeZone option

paulrobertlloyd · paulrobertlloyd · commit 16af3b90aca7 · 2024-04-19T18:34:50.000+01:00
diff --git a/packages/util/lib/date.js b/packages/util/lib/date.js
@@ -36,16 +36,22 @@ export const dateTokens = [
  * Format a date
  * @param {string} string - ISO 8601 date
  * @param {string} tokens - Tokenised date format
- * @param {string} [locale] - Locale name
- * @param {import("date-fns-tz").OptionsWithTZ} [options] - Options
+ * @param {object} [options] - Options
+ * @param {string} [options.locale] - Locale
+ * @param {string} [options.timeZone] - Time zone
  * @returns {string} Formatted date
  */
-export const formatDate = (string, tokens, locale, options = {}) => {
-  locale = String(locale || "en").replace("-", "");
-  options.locale = locales[locale];
+export const formatDate = (string, tokens, options = {}) => {
+  const formattedLocale = String(options.locale || "en").replace("-", "");
+
+  // Convert options object to options expected for `FormatOptionsWithTZ`
+  const formatOptions = {
+    ...options,
+    ...(options.locale && { locale: locales[formattedLocale] }),
+  };
 
   const date = string === "now" ? new Date() : parseISO(string);
-  const dateTime = format(date, tokens, options);
+  const dateTime = format(date, tokens, formatOptions);
   return dateTime;
 };
 
diff --git a/packages/util/test/unit/date.js b/packages/util/test/unit/date.js
@@ -13,13 +13,16 @@ import {
 describe("util/lib/date", () => {
   it("Formats a date", () => {
     assert.equal(formatDate("2019-11-30", "dd MMMM yyyy"), "30 November 2019");
-    assert.equal(formatDate("2019-11-30", "PPP", "en-GB"), "30 November 2019");
     assert.equal(
-      formatDate("2019-11-30", "PPP", "en-US"),
+      formatDate("2019-11-30", "PPP", { locale: "en-GB" }),
+      "30 November 2019",
+    );
+    assert.equal(
+      formatDate("2019-11-30", "PPP", { locale: "en-US" }),
       "November 30th, 2019",
     );
     assert.equal(
-      formatDate("2019-11-30", "PPP", "pt-BR"),
+      formatDate("2019-11-30", "PPP", { locale: "pt-BR" }),
       "30 de novembro de 2019",
     );
   });
