@openmrs/esm-utils 6.3.1-pre.3158 → 6.3.1-pre.3182

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 12 files with swc (182.65ms)
+[0] Successfully compiled: 12 files with swc (184.01ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/dates/date-util.d.ts

@@ -3,6 +3,7 @@
  * @category Date and Time
  */
 import { type CalendarDate, type CalendarDateTime, type CalendarIdentifier, type ZonedDateTime } from '@internationalized/date';
+import type { DurationFormatOptions, DurationInput } from '@formatjs/intl-durationformat/src/types';
 export type DateInput = string | number | Date;
 /**
  * This function checks whether a date string is the OpenMRS ISO format.
@@ -142,3 +143,11 @@ export declare function formatDatetime(date: Date, options?: Partial<Omit<Format
  * @returns CalendarDate
  */
 export declare function convertToLocaleCalendar(date: CalendarDate | CalendarDateTime | ZonedDateTime, locale: string | Intl.Locale): CalendarDate | CalendarDateTime | ZonedDateTime;
+/**
+ * Formats the input duration according to the current locale.
+ *
+ * @param duration The duration to format (DurationInput object).
+ * @param options Optional options for formatting.
+ * @returns The formatted duration string.
+ */
+export declare function formatDuration(duration: DurationInput, options?: DurationFormatOptions): string;

package/dist/dates/date-util.js

@@ -27,6 +27,7 @@ function _class_private_field_init(obj, privateMap, value) {
     privateMap.set(obj, value);
 }
 import { createCalendar, toCalendar } from "@internationalized/date";
+import { DurationFormat } from "@formatjs/intl-durationformat";
 import { attempt } from "any-date-parser";
 import dayjs from "dayjs";
 import isToday from "dayjs/plugin/isToday.js";
@@ -333,3 +334,13 @@ const formatParts = (separator)=>{
     const localCalendarName = getDefaultCalendar(locale_);
     return localCalendarName ? toCalendar(date, createCalendar(localCalendarName)) : date;
 }
+/**
+ * Formats the input duration according to the current locale.
+ *
+ * @param duration The duration to format (DurationInput object).
+ * @param options Optional options for formatting.
+ * @returns The formatted duration string.
+ */ export function formatDuration(duration, options) {
+    const formatter = new DurationFormat(getLocale(), options);
+    return formatter.format(duration);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-utils",
-  "version": "6.3.1-pre.3158",
+  "version": "6.3.1-pre.3182",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "type": "module",
@@ -58,7 +58,7 @@
     "rxjs": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-globals": "6.3.1-pre.3158",
+    "@openmrs/esm-globals": "6.3.1-pre.3182",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "@types/lodash-es": "^4.17.12",

package/src/dates/date-util.test.ts

@@ -11,6 +11,7 @@ import {
   formatTime,
   registerDefaultCalendar,
   formatPartialDate,
+  formatDuration,
 } from './date-util';
 
 window.i18next = { language: 'en' } as i18n;
@@ -196,4 +197,16 @@ describe('Openmrs Dates', () => {
         .replace(/ /g, '-') + ', 03:22 PM';
     expect(formatDate(testDate, { noToday: true }).replaceAll(/[\u202F]/g, ' ')).toEqual(expected);
   });
+
+  it('formats duration with respect to the locale', () => {
+    window.i18next.language = 'en';
+    const duration = { hours: 1, minutes: 1, seconds: 1, days: 1, months: 1, years: 1 };
+    expect(formatDuration(duration, { style: 'narrow' })).toMatch(/1y.*1m.*1d.*1h.*1m.*1s/);
+    expect(formatDuration(duration, { style: 'short' })).toMatch(
+      /1\s+yr,.*1\s+mth,.*1\s+day,.*1\s+hr,.*1\s+min,.*1\s+sec/,
+    );
+    expect(formatDuration(duration, { style: 'long' })).toMatch(
+      /1\s+year,.*1\s+month,.*1\s+day,.*1\s+hour,.*1\s+minute,.*1\s+second/,
+    );
+  });
 });

package/src/dates/date-util.ts

@@ -10,6 +10,7 @@ import {
   createCalendar,
   toCalendar,
 } from '@internationalized/date';
+import { DurationFormat } from '@formatjs/intl-durationformat';
 import { attempt } from 'any-date-parser';
 import dayjs from 'dayjs';
 import isToday from 'dayjs/plugin/isToday.js';
@@ -17,6 +18,7 @@ import objectSupport from 'dayjs/plugin/objectSupport.js';
 import utc from 'dayjs/plugin/utc.js';
 import { isNil, omit } from 'lodash-es';
 import { getLocale } from '../';
+import type { DurationFormatOptions, DurationInput } from '@formatjs/intl-durationformat/src/types';
 
 dayjs.extend(isToday);
 dayjs.extend(utc);
@@ -413,3 +415,15 @@ export function convertToLocaleCalendar(
 
   return localCalendarName ? toCalendar(date, createCalendar(localCalendarName)) : date;
 }
+
+/**
+ * Formats the input duration according to the current locale.
+ *
+ * @param duration The duration to format (DurationInput object).
+ * @param options Optional options for formatting.
+ * @returns The formatted duration string.
+ */
+export function formatDuration(duration: DurationInput, options?: DurationFormatOptions) {
+  const formatter = new DurationFormat(getLocale(), options);
+  return formatter.format(duration);
+}