feat(util): formatLocalToZonedDate helper

paulrobertlloyd · paulrobertlloyd · commit 361fe135160d · 2024-12-26T16:33:46.000Z
rename corresponding helper to formatZonedToLocalDate
diff --git a/packages/frontend/lib/filters/index.js b/packages/frontend/lib/filters/index.js
@@ -1,7 +1,7 @@
 export {
   excerpt,
   formatDate as date,
-  formatDateToLocal as localDate,
+  formatZonedToLocalDate as localDate,
   getCanonicalUrl as url,
   slugify,
 } from "@indiekit/util";
diff --git a/packages/util/index.js b/packages/util/index.js
@@ -2,7 +2,8 @@ export { getCursor, getObjectId } from "./lib/collection.js";
 export {
   dateTokens,
   formatDate,
-  formatDateToLocal,
+  formatZonedToLocalDate,
+  formatLocalToZonedDate,
   getDate,
   getTimeZoneDesignator,
   getTimeZoneOffset,
diff --git a/packages/util/lib/date.js b/packages/util/lib/date.js
@@ -53,20 +53,34 @@ export const formatDate = (string, tokens, options = {}) => {
 };
 
 /**
- * Format a date as local date
+ * Formats zoned date as local date
  * Used to convert date to value consumable by input[type="datetime-local"]
  * @param {Date|string|number} string - Zoned date, i.e. 2023-08-28T12:30+01:00
  * @param {string} timeZone - Time zone
  * @returns {string} Formatted local date, i.e. 2023-08-28T12:30
  */
-export const formatDateToLocal = (string, timeZone) => {
+export const formatZonedToLocalDate = (string, timeZone) => {
   const dateTime = format(string, "yyyy-MM-dd'T'HH:mm", {
     in: tz(timeZone),
   });
 
   return dateTime;
 };
 
+/**
+ * Format local date to zoned date
+ * @param {Date|string|number} string - Local date, i.e. 2023-08-28T12:30
+ * @param {string} timeZone - Time zone
+ * @returns {string} Zoned date, i.e. 2023-08-28T12:30+01:00
+ */
+export const formatLocalToZonedDate = (string, timeZone) => {
+  const formattedDateTime = format(string, "XXX", {
+    in: tz(timeZone),
+  });
+
+  return `${string}${formattedDateTime}`;
+};
+
 /**
  * Converts date to use configured time zone
  * @param {string} setting - Time zone setting
diff --git a/packages/util/test/unit/date.js b/packages/util/test/unit/date.js
@@ -5,7 +5,8 @@ import { isValid, parseISO } from "date-fns";
 
 import {
   formatDate,
-  formatDateToLocal,
+  formatZonedToLocalDate,
+  formatLocalToZonedDate,
   getDate,
   getTimeZoneDesignator,
   getTimeZoneOffset,
@@ -36,19 +37,32 @@ describe("util/lib/date", () => {
     assert.equal(result, now);
   });
 
-  it("Formats a date as local date", () => {
-    const tz1 = formatDateToLocal("2019-11-30T12:30:00+01:00", "Asia/Taipei");
-    const tz2 = formatDateToLocal(
+  it("Formats zoned date as local date", () => {
+    const tz1 = formatZonedToLocalDate(
+      "2019-11-30T12:30:00+01:00",
+      "Asia/Taipei",
+    );
+    const tz2 = formatZonedToLocalDate(
       "2019-11-30T12:30:00+01:00",
       "America/Panama",
     );
-    const utc = formatDateToLocal("2019-11-30T12:30:00+01:00", "UTC");
+    const utc = formatZonedToLocalDate("2019-11-30T12:30:00+01:00", "UTC");
 
     assert.equal(tz1, "2019-11-30T19:30");
     assert.equal(tz2, "2019-11-30T06:30");
     assert.equal(utc, "2019-11-30T11:30");
   });
 
+  it("Formats local date to zoned date", () => {
+    const tz1 = formatLocalToZonedDate("2019-11-30T12:30:00", "Asia/Taipei");
+    const tz2 = formatLocalToZonedDate("2019-11-30T12:30:00", "America/Panama");
+    const utc = formatLocalToZonedDate("2019-11-30T12:30:00", "UTC");
+
+    assert.equal(tz1, "2019-11-30T12:30:00+08:00");
+    assert.equal(tz2, "2019-11-30T12:30:00-05:00");
+    assert.equal(utc, "2019-11-30T12:30:00Z");
+  });
+
   it("Creates UTC datetime from `client`", () => {
     const result = getDate("client");
 
