@openmrs/esm-utils 6.2.1-pre.2799 → 6.2.1-pre.2805

package/jest.config.js

@@ -3,6 +3,9 @@ module.exports = {
   transform: {
     '^.+\\.tsx?$': ['@swc/jest'],
   },
+  moduleNameMapper: {
+    'lodash-es': 'lodash',
+  },
   testEnvironment: 'jsdom',
   testEnvironmentOptions: {
     url: 'http://localhost/',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-utils",
-  "version": "6.2.1-pre.2799",
+  "version": "6.2.1-pre.2805",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "browser": "dist/openmrs-esm-utils.js",
@@ -39,9 +39,11 @@
     "access": "public"
   },
   "devDependencies": {
-    "@openmrs/esm-globals": "6.2.1-pre.2799",
+    "@openmrs/esm-globals": "6.2.1-pre.2805",
+    "@types/lodash-es": "^4.17.12",
     "@types/semver": "^7.3.4",
     "dayjs": "^1.10.4",
+    "jest": "^29.7.0",
     "rxjs": "^6.5.3"
   },
   "peerDependencies": {
@@ -51,8 +53,10 @@
     "rxjs": "6.x"
   },
   "dependencies": {
-    "@formatjs/intl-durationformat": "^0.2.4",
-    "@internationalized/date": "^3.7.0",
+    "@formatjs/intl-durationformat": "^0.7.3",
+    "@internationalized/date": "^3.5.5",
+    "any-date-parser": "^2.0.3",
+    "lodash-es": "^4.17.21",
     "semver": "7.3.2"
   },
   "stableVersion": "6.2.0"

package/src/age-helpers.test.ts

@@ -8,32 +8,95 @@ describe('Age Helper', () => {
   // test cases mostly taken from
   // https://webarchive.nationalarchives.gov.uk/ukgwa/20160921162509mp_/http://systems.digital.nhs.uk/data/cui/uig/patben.pdf
   // (Table 8)
-  const now = dayjs('2024-07-30');
-  const test0 = now;
-  const test1 = now.subtract(1, 'hour').subtract(30, 'minutes');
-  const test2 = now.subtract(1, 'day').subtract(2, 'hours').subtract(5, 'minutes');
-  const test3 = now.subtract(3, 'days').subtract(17, 'hours').subtract(30, 'minutes');
-  const test4 = now.subtract(27, 'days').subtract(5, 'hours').subtract(2, 'minutes');
-  const test5 = now.subtract(28, 'days').subtract(5, 'hours').subtract(2, 'minutes');
-  const test6 = now.subtract(29, 'days').subtract(5, 'hours').subtract(2, 'minutes');
-  const test7 = now.subtract(1, 'year').subtract(1, 'day').subtract(5, 'hours');
-  const test8 = now.subtract(1, 'year').subtract(8, 'day').subtract(5, 'hours');
-  const test9 = now.subtract(1, 'year').subtract(39, 'day').subtract(5, 'hours');
-  const test10 = now.subtract(4, 'year').subtract(39, 'day');
-  const test11 = now.subtract(18, 'year').subtract(39, 'day');
+  const now = dayjs('2024-07-30T08:30:55Z');
 
-  it('should render durations correctly', () => {
-    expect(age(test0, now)).toBe('0 min');
-    expect(age(test1, now)).toBe('90 min');
-    expect(age(test2, now)).toBe('26 hr');
-    expect(age(test3, now)).toBe('3 days');
-    expect(age(test4, now)).toBe('27 days');
-    expect(age(test5, now)).toBe('4 wks');
-    expect(age(test6, now)).toBe('4 wks, 1 day');
-    expect(age(test7, now)).toBe('12 mths, 1 day');
-    expect(age(test8, now)).toBe('12 mths, 8 days');
-    expect(age(test9, now)).toBe('13 mths, 9 days');
-    expect(age(test10, now)).toBe('4 yrs, 1 mth');
-    expect(age(test11, now)).toBe('18 yrs');
+  it.each([
+    {
+      label: 'just born',
+      birthDate: now,
+      expectedOutput: '0 min',
+    },
+    {
+      label: 'aged 1 hour 30 minutes',
+      birthDate: now.subtract(1, 'hour').subtract(30, 'minutes'),
+      expectedOutput: '90 min',
+    },
+    {
+      label: 'aged 1 day 2 hours 5 minutes',
+      birthDate: now.subtract(1, 'day').subtract(2, 'hours').subtract(5, 'minutes'),
+      expectedOutput: '26 hr',
+    },
+    {
+      label: 'aged 3 days 17 hours 7 minutes',
+      birthDate: now.subtract(3, 'days').subtract(17, 'hours').subtract(30, 'minutes'),
+      expectedOutput: '3 days',
+    },
+    {
+      label: 'aged 27 days 5 hours 2 minutes',
+      birthDate: now.subtract(27, 'days').subtract(5, 'hours').subtract(2, 'minutes'),
+      expectedOutput: '27 days',
+    },
+    {
+      label: 'aged 28 days 5 hours 2 minutes',
+      birthDate: now.subtract(28, 'days').subtract(5, 'hours').subtract(2, 'minutes'),
+      expectedOutput: '4 wks',
+    },
+    {
+      label: 'aged 29 days 5 hours 2 minutes',
+      birthDate: now.subtract(29, 'days').subtract(5, 'hours').subtract(2, 'minutes'),
+      expectedOutput: '4 wks, 1 day',
+    },
+    {
+      label: 'aged 1 year 1 day 5 hours',
+      birthDate: now.subtract(1, 'year').subtract(1, 'day').subtract(5, 'hours'),
+      expectedOutput: '12 mths, 1 day',
+    },
+    {
+      label: 'aged 1 year 8 days 5 hours',
+      birthDate: now.subtract(1, 'year').subtract(8, 'days').subtract(5, 'hours'),
+      expectedOutput: '12 mths, 8 days',
+    },
+    {
+      label: 'aged 1 year 38 days 5 hours',
+      birthDate: now.subtract(1, 'year').subtract(38, 'days').subtract(5, 'hours'),
+      expectedOutput: '13 mths, 8 days',
+    },
+    {
+      label: 'aged 4 years 38 days',
+      birthDate: now.subtract(4, 'years').subtract(38, 'days').subtract(5, 'hours'),
+      expectedOutput: '4 yrs, 1 mth',
+    },
+    {
+      label: 'aged 18 years 38 days',
+      birthDate: now.subtract(18, 'years').subtract(38, 'days'),
+      expectedOutput: '18 yrs',
+    },
+    {
+      label: 'born in 2000',
+      birthDate: '2000',
+      expectedOutput: '24 yrs',
+    },
+    {
+      label: 'born 10 years, 10 months ago estimated',
+      birthDate: '2014',
+      expectedOutput: '10 yrs',
+    },
+    {
+      label: 'born in June 2020',
+      birthDate: '2020-06',
+      expectedOutput: '4 yrs, 1 mth',
+    },
+    {
+      label: 'born Feb 29th 2020',
+      birthDate: '2020-02-29',
+      expectedOutput: '4 yrs, 5 mths',
+    },
+    {
+      label: 'born January 1st 2020',
+      birthDate: '2020-01-01',
+      expectedOutput: '4 yrs, 6 mths',
+    },
+  ])("should produce '$expectedOutput' for person $label", ({ birthDate, expectedOutput }) => {
+    expect(age(birthDate, now)).toBe(expectedOutput);
   });
 });

package/src/age-helpers.ts

@@ -1,8 +1,14 @@
 /** @module @category Utility */
-import dayjs from 'dayjs';
 import { DurationFormat } from '@formatjs/intl-durationformat';
 import { type DurationFormatOptions, type DurationInput } from '@formatjs/intl-durationformat/src/types';
+import { attempt } from 'any-date-parser';
+import dayjs from 'dayjs';
+import objectSupport from 'dayjs/plugin/objectSupport';
+import { omit } from 'lodash-es';
 import { getLocale } from './get-locale';
+
+dayjs.extend(objectSupport);
+
 /**
  * Gets a human readable and locale supported representation of a person's age, given their birthDate,
  * The representation logic follows the guideline here:
@@ -18,8 +24,37 @@ export function age(birthDate: dayjs.ConfigType, currentDate: dayjs.ConfigType =
     return null;
   }
 
+  const locale = getLocale();
+
   const to = dayjs(currentDate);
-  const from = dayjs(birthDate);
+  let from: dayjs.Dayjs;
+
+  if (typeof birthDate === 'string') {
+    let parsedDate = attempt(birthDate, locale);
+    if (parsedDate.invalid) {
+      console.warn(`Could not interpret '${birthDate}' as a date`);
+      return null;
+    }
+
+    // hack here but any date interprets 2000-01, etc. as yyyy-dd rather than yyyy-mm
+    if (parsedDate.day && !parsedDate.month) {
+      parsedDate = Object.assign({}, omit(parsedDate, 'day'), { month: parsedDate.day });
+    }
+
+    // dayjs' object support uses 0-based months, whereas any-date-parser uses 1-based months
+    if (parsedDate.month) {
+      parsedDate.month -= 1;
+    }
+
+    // in dayjs day is day of week; in any-date-parser, its day of month, so we need to convert them
+    if (parsedDate.day) {
+      parsedDate = Object.assign({}, omit(parsedDate, 'day'), { date: parsedDate.day });
+    }
+
+    from = dayjs(to).set(parsedDate);
+  } else {
+    from = dayjs(birthDate);
+  }
 
   const hourDiff = to.diff(from, 'hours');
   const dayDiff = to.diff(from, 'days');
@@ -28,15 +63,12 @@ export function age(birthDate: dayjs.ConfigType, currentDate: dayjs.ConfigType =
   const yearDiff = to.diff(from, 'years');
 
   const duration: DurationInput = {};
-
-  const locale = getLocale();
-
   const options: DurationFormatOptions = { style: 'short', localeMatcher: 'lookup' };
 
   if (hourDiff < 2) {
     const minuteDiff = to.diff(from, 'minutes');
     duration['minutes'] = minuteDiff;
-    if (minuteDiff == 0) {
+    if (minuteDiff === 0) {
       options.minutesDisplay = 'always';
     }
   } else if (dayDiff < 2) {

package/src/dates/date-util.ts

@@ -2,7 +2,6 @@
  * @module
  * @category Date and Time
  */
-import type { i18n } from 'i18next';
 import {
   type CalendarDateTime,
   type ZonedDateTime,
@@ -10,19 +9,18 @@ import {
   toCalendar,
   type CalendarDate,
 } from '@internationalized/date';
+import { getLocale } from '@openmrs/esm-utils';
+import { attempt } from 'any-date-parser';
 import dayjs from 'dayjs';
-import utc from 'dayjs/plugin/utc';
 import isToday from 'dayjs/plugin/isToday';
-import { getLocale } from '@openmrs/esm-utils';
+import objectSupport from 'dayjs/plugin/objectSupport';
+import utc from 'dayjs/plugin/utc';
+import type { i18n } from 'i18next';
+import { omit } from 'lodash-es';
 
-dayjs.extend(utc);
 dayjs.extend(isToday);
-
-declare global {
-  interface Window {
-    i18next: i18n;
-  }
-}
+dayjs.extend(utc);
+dayjs.extend(objectSupport);
 
 export type DateInput = string | number | Date;
 
@@ -98,53 +96,6 @@ export function parseDate(dateString: string) {
   return dayjs(dateString).toDate();
 }
 
-export type FormatDateMode = 'standard' | 'wide';
-
-export type FormatDateOptions = {
-  /**
-   * The calendar to use when formatting this date.
-   */
-  calendar?: string;
-  /**
-   * The locale to use when formatting this date
-   */
-  locale?: string;
-  /**
-   * - `standard`: "03 Feb 2022"
-   * - `wide`:     "03 — Feb — 2022"
-   */
-  mode: FormatDateMode;
-  /**
-   * 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';
-  /** Whether to include the day number */
-  day: boolean;
-  /** Whether to include the month number */
-  month: boolean;
-  /** Whether to include the year */
-  year: boolean;
-  /** The unicode numbering system to use */
-  numberingSystem?: string;
-  /**
-   * Disables the special handling of dates that are today. If false
-   * (the default), then dates that are today will be formatted as "Today"
-   * in the locale language. If true, then dates that are today will be
-   * formatted the same as all other dates.
-   */
-  noToday: boolean;
-};
-
-const defaultOptions: FormatDateOptions = {
-  mode: 'standard',
-  time: 'for today',
-  day: true,
-  month: true,
-  year: true,
-  noToday: false,
-};
-
 /**
  * Internal cache for per-locale calendars
  */
@@ -214,6 +165,114 @@ export function getDefaultCalendar(locale: Intl.Locale | string | undefined) {
   return registeredLocaleCalendars.getCalendar(locale_ instanceof Intl.Locale ? locale_ : new Intl.Locale(locale_));
 }
 
+export type FormatDateMode = 'standard' | 'wide';
+
+export type FormatDateOptions = {
+  /**
+   * The calendar to use when formatting this date.
+   */
+  calendar?: string;
+  /**
+   * The locale to use when formatting this date
+   */
+  locale?: string;
+  /**
+   * - `standard`: "03 Feb 2022"
+   * - `wide`:     "03 — Feb — 2022"
+   */
+  mode: FormatDateMode;
+  /**
+   * 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';
+  /** Whether to include the day number */
+  day: boolean;
+  /** Whether to include the month number */
+  month: boolean;
+  /** Whether to include the year */
+  year: boolean;
+  /** The unicode numbering system to use */
+  numberingSystem?: string;
+  /**
+   * Disables the special handling of dates that are today. If false
+   * (the default), then dates that are today will be formatted as "Today"
+   * in the locale language. If true, then dates that are today will be
+   * formatted the same as all other dates.
+   */
+  noToday: boolean;
+};
+
+const defaultOptions: FormatDateOptions = {
+  mode: 'standard',
+  time: 'for today',
+  day: true,
+  month: true,
+  year: true,
+  noToday: false,
+};
+
+/**
+ * Formats the string representing a date, including partial representations of dates, according to the current
+ * locale and the given options.
+ *
+ * Default options:
+ *  - mode: "standard",
+ *  - time: "for today",
+ *  - day: true,
+ *  - month: true,
+ *  - year: true
+ *  - noToday: false
+ *
+ * If the date is today then "Today" is produced (in the locale language).
+ * This behavior can be disabled with `noToday: true`.
+ *
+ * When time is included, it is appended with a comma and a space. This
+ * agrees with the output of `Date.prototype.toLocaleString` for *most*
+ * locales.
+ */
+// TODO: Shouldn't throw on null input
+export function formatPartialDate(dateString: string, options: Partial<FormatDateOptions> = {}) {
+  const locale = getLocale();
+  let parsed: ReturnType<typeof attempt> & { date?: number } = attempt(dateString, locale);
+
+  if (parsed.invalid) {
+    console.warn(`Could not parse invalid date '${dateString}'`);
+    return null;
+  }
+
+  // hack here but any date interprets 2000-01, etc. as yyyy-dd rather than yyyy-mm
+  if (parsed.day && !parsed.month) {
+    parsed = Object.assign({}, omit(parsed, 'day'), { month: parsed.day });
+  }
+
+  // dayjs' object support uses 0-based months, whereas any-date-parser uses 1-based months
+  if (parsed.month) {
+    parsed.month -= 1;
+  }
+
+  // in dayjs day is day of week; in any-date-parser, its day of month, so we need to convert them
+  if (parsed.day) {
+    parsed = Object.assign({}, omit(parsed, 'day'), { date: parsed.day });
+  }
+
+  const date = dayjs().set(parsed).toDate();
+
+  if (!parsed.year) {
+    options.year = false;
+  }
+
+  if (!parsed.month) {
+    options.month = false;
+  }
+
+  if (!parsed.date) {
+    options.day = false;
+  }
+
+  return formatDate(date, options);
+}
+
 /**
  * Formats the input date according to the current locale and the
  * given options.