@openmrs/esm-utils 3.1.15-pre.749 → 3.1.15-pre.751

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-utils",
-  "version": "3.1.15-pre.749",
+  "version": "3.1.15-pre.751",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "browser": "dist/openmrs-esm-utils.js",
@@ -49,5 +49,5 @@
   "dependencies": {
     "semver": "^7.3.2"
   },
-  "gitHead": "110be85fd4162b3c89f51898a8f5913bec0b15ba"
+  "gitHead": "de47ee691eaa1863dcd18a5b696ba785f502223e"
 }

package/src/omrs-dates.test.ts

@@ -49,20 +49,22 @@ describe("Openmrs Dates", () => {
 
   it("formats 'Today' with respect to the locale", () => {
     const testDate = new Date();
+    testDate.setHours(15);
+    testDate.setMinutes(22);
     window.i18next.language = "en";
-    expect(formatDate(testDate)).toEqual("Today");
-    expect(formatDate(testDate, "no day")).toEqual("Today");
-    expect(formatDate(testDate, "no year")).toEqual("Today");
-    expect(formatDate(testDate, "wide")).toEqual("Today");
+    expect(formatDate(testDate)).toEqual("Today, 03:22 PM");
+    expect(formatDate(testDate, "no day")).toEqual("Today, 03:22 PM");
+    expect(formatDate(testDate, "no year")).toEqual("Today, 03:22 PM");
+    expect(formatDate(testDate, "wide")).toEqual("Today, 03:22 PM");
     window.i18next.language = "sw";
-    expect(formatDate(testDate)).toEqual("Leo");
+    expect(formatDate(testDate)).toEqual("Leo, 15:22");
     window.i18next.language = "ru";
-    expect(formatDate(testDate)).toEqual("Сегодня");
+    expect(formatDate(testDate)).toEqual("Сегодня, 15:22");
   });
 
   it("formats dates with respect to the locale", () => {
     timezoneMock.register("UTC");
-    const testDate = new Date("2021-12-09");
+    const testDate = new Date("2021-12-09T13:15:33");
     window.i18next.language = "en";
     expect(formatDate(testDate)).toEqual("09-Dec-2021");
     expect(formatDate(testDate, "no day")).toEqual("Dec 2021");
@@ -79,6 +81,32 @@ describe("Openmrs Dates", () => {
     expect(formatDate(testDate, "wide")).toEqual("09 — дек. — 2021 г.");
   });
 
+  it("respects the `time` option", () => {
+    timezoneMock.register("UTC");
+    const testDate = new Date("2021-12-09T13:15:33");
+    const today = new Date();
+    today.setHours(15);
+    today.setMinutes(22);
+    window.i18next.language = "en";
+    expect(formatDate(testDate)).toEqual("09-Dec-2021");
+    expect(formatDate(testDate, "standard", { time: true })).toEqual(
+      "09-Dec-2021, 01:15 PM"
+    );
+    expect(formatDate(testDate, "standard", { time: false })).toEqual(
+      "09-Dec-2021"
+    );
+    expect(formatDate(testDate, "standard", { time: "for today" })).toEqual(
+      "09-Dec-2021"
+    );
+    expect(formatDate(today, "standard", { time: true })).toEqual(
+      "Today, 03:22 PM"
+    );
+    expect(formatDate(today, "standard", { time: false })).toEqual("Today");
+    expect(formatDate(today, "standard", { time: "for today" })).toEqual(
+      "Today, 03:22 PM"
+    );
+  });
+
   it("formats times with respect to the locale", () => {
     timezoneMock.register("Australia/Adelaide");
     const testDate = new Date("2021-12-09T13:15:33");

package/src/omrs-dates.ts

@@ -153,17 +153,40 @@ const DATE_FORMAT_MMM_DD = {
 
 export type FormatDateMode = "standard" | "no year" | "no day" | "wide";
 
+export type FormatDateOptions = {
+  /**
+   * Whether the time should be included in the output always (`true`),
+   * never (`false`), or only when the input date is today (`for today`).
+   */
+  time: true | false | "for today";
+};
+const defaultOptions: FormatDateOptions = {
+  time: "for today",
+};
+
 /**
  * Formats the input date according to the current locale and the
  * given format mode.
  *
- * `standard`: "13 Dec 2021"
- * `no year`:  "13 Dec"
- * `no day`:   "Dec 2021"
- * `wide`:     "13 — Dec — 2021"
+ * - `standard`: "13 Dec 2021"
+ * - `no year`:  "13 Dec"
+ * - `no day`:   "Dec 2021"
+ * - `wide`:     "13 — Dec — 2021"
+ *
+ * Regardless of the mode, if the date is today, then "Today" is produced
+ * (in the locale language).
+ *
+ * Can be used to format a date with time, also, by providing `options`.
+ * By default, the time is included only when the input date is today.
+ * The time is appended with a comma and a space. This agrees with the
+ * output of `Date.prototype.toLocaleString` for *most* locales.
  */
-export function formatDate(date: Date, mode: FormatDateMode = "standard") {
-  const options = (
+export function formatDate(
+  date: Date,
+  mode: FormatDateMode = "standard",
+  options: FormatDateOptions = defaultOptions
+) {
+  const formatterOptions = (
     {
       standard: DATE_FORMAT_YYYY_MMM_DD,
       wide: DATE_FORMAT_YYYY_MMM_DD,
@@ -172,20 +195,21 @@ export function formatDate(date: Date, mode: FormatDateMode = "standard") {
     } as Record<string, Intl.DateTimeFormatOptions>
   )[mode];
   let locale = getLocale();
-  if (dayjs(date).isToday()) {
+  let localeString: string;
+  const isToday = dayjs(date).isToday();
+  if (isToday) {
     // This produces the word "Today" in the language of `locale`
     const rtf = new Intl.RelativeTimeFormat(locale, { numeric: "auto" });
-    let localeString = rtf.format(0, "day");
+    localeString = rtf.format(0, "day");
     localeString =
       localeString[0].toLocaleUpperCase(locale) + localeString.slice(1);
-    return localeString;
   } else {
     if (locale == "en") {
       // This locale override is here rather than in `getLocale`
       // because Americans should see AM/PM for times.
       locale = "en-GB";
     }
-    let localeString = date.toLocaleDateString(locale, options);
+    localeString = date.toLocaleDateString(locale, formatterOptions);
     if (locale == "en-GB" && mode == "standard") {
       // Custom formatting for English. Use hyphens instead of spaces.
       localeString = localeString.replace(/ /g, "-");
@@ -200,8 +224,11 @@ export function formatDate(date: Date, mode: FormatDateMode = "standard") {
           localeString.slice(len - 5).replace(" — ", " ");
       }
     }
-    return localeString;
   }
+  if (options.time === true || (isToday && options.time === "for today")) {
+    localeString += `, ${formatTime(date)}`;
+  }
+  return localeString;
 }
 
 /**
@@ -225,9 +252,7 @@ export function formatTime(date: Date) {
  * output of `Date.prototype.toLocaleString` for *most* locales.
  */
 export function formatDatetime(date: Date, mode: FormatDateMode = "standard") {
-  const dateString = formatDate(date, mode);
-  const timeString = formatTime(date);
-  return `${dateString}, ${timeString}`;
+  return formatDate(date, mode, { time: true });
 }
 
 function getLocale() {