@openmrs/esm-framework 3.1.15-pre.742 → 3.1.15-pre.751

package/docs/API.md

@@ -113,6 +113,7 @@
 - [DateInput](API.md#dateinput)
 - [ExtensionSlotProps](API.md#extensionslotprops)
 - [FormatDateMode](API.md#formatdatemode)
+- [FormatDateOptions](API.md#formatdateoptions)
 - [KnownOmrsServiceWorkerEvents](API.md#knownomrsserviceworkerevents)
 - [KnownOmrsServiceWorkerMessages](API.md#knownomrsserviceworkermessages)
 - [LayoutType](API.md#layouttype)
@@ -402,6 +403,22 @@ ___
 
 ___
 
+### FormatDateOptions
+
+Ƭ **FormatDateOptions**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `time` | `boolean` \| ``"for today"`` | Whether the time should be included in the output always (`true`), never (`false`), or only when the input date is today (`for today`). |
+
+#### Defined in
+
+[packages/framework/esm-utils/src/omrs-dates.ts:156](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L156)
+
+___
+
 ### KnownOmrsServiceWorkerEvents
 
 Ƭ **KnownOmrsServiceWorkerEvents**: [`NetworkRequestFailedEvent`](interfaces/NetworkRequestFailedEvent.md)
@@ -1706,15 +1723,23 @@ ___
 
 ### formatDate
 
-▸ **formatDate**(`date`, `mode?`): `string`
+▸ **formatDate**(`date`, `mode?`, `options?`): `string`
 
 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.
 
 #### Parameters
 
@@ -1722,6 +1747,7 @@ given format mode.
 | :------ | :------ | :------ |
 | `date` | `Date` | `undefined` |
 | `mode` | [`FormatDateMode`](API.md#formatdatemode) | `"standard"` |
+| `options` | [`FormatDateOptions`](API.md#formatdateoptions) | `undefined` |
 
 #### Returns
 
@@ -1729,7 +1755,7 @@ given format mode.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:165](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L165)
+[packages/framework/esm-utils/src/omrs-dates.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L184)
 
 ___
 
@@ -1758,7 +1784,7 @@ output of `Date.prototype.toLocaleString` for *most* locales.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:227](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L227)
+[packages/framework/esm-utils/src/omrs-dates.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L254)
 
 ___
 
@@ -1781,7 +1807,7 @@ Formats the input as a time, according to the current locale.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:211](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L211)
+[packages/framework/esm-utils/src/omrs-dates.ts:238](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L238)
 
 ___
 

package/mock.tsx

@@ -2,6 +2,7 @@ import React from "react";
 import type {} from "@openmrs/esm-globals";
 import createStore, { Store } from "unistore";
 import { never, of } from "rxjs";
+import dayjs from "dayjs";
 
 interface StoreEntity {
   value: Store<any>;
@@ -259,3 +260,28 @@ export const usePagination = jest.fn().mockImplementation(() => ({
 }));
 
 export const useVisitTypes = jest.fn(() => []);
+
+export const formatDate = jest.fn((date: Date, mode) => {
+  if (!mode || mode == "standard") {
+    return dayjs(date).format("DD-MMM-YYYY");
+  }
+  if (mode == "wide") {
+    return dayjs(date).format("DD - MMM - YYYY");
+  }
+  if (mode == "no day") {
+    return dayjs(date).format("MMM YYYY");
+  }
+  if (mode == "no year") {
+    return dayjs(date).format("DD MMM");
+  }
+  console.warn("Unknown formatDate mode: ", mode);
+  return dayjs(date).format("DD-MMM-YYYY");
+});
+
+export const formatTime = jest.fn((date: Date) => {
+  return dayjs(date).format("HH:mm");
+});
+
+export const formatDatetime = jest.fn((date: Date, mode) => {
+  return formatDate(date, mode) + " " + formatTime(date);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.1.15-pre.742",
+  "version": "3.1.15-pre.751",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -35,17 +35,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^3.1.15-pre.742",
-    "@openmrs/esm-breadcrumbs": "^3.1.15-pre.742",
-    "@openmrs/esm-config": "^3.1.15-pre.742",
-    "@openmrs/esm-error-handling": "^3.1.15-pre.742",
-    "@openmrs/esm-extensions": "^3.1.15-pre.742",
-    "@openmrs/esm-globals": "^3.1.15-pre.742",
-    "@openmrs/esm-offline": "^3.1.15-pre.742",
-    "@openmrs/esm-react-utils": "^3.1.15-pre.742",
-    "@openmrs/esm-state": "^3.1.15-pre.742",
-    "@openmrs/esm-styleguide": "^3.1.15-pre.742",
-    "@openmrs/esm-utils": "^3.1.15-pre.742"
+    "@openmrs/esm-api": "^3.1.15-pre.751",
+    "@openmrs/esm-breadcrumbs": "^3.1.15-pre.751",
+    "@openmrs/esm-config": "^3.1.15-pre.751",
+    "@openmrs/esm-error-handling": "^3.1.15-pre.751",
+    "@openmrs/esm-extensions": "^3.1.15-pre.751",
+    "@openmrs/esm-globals": "^3.1.15-pre.751",
+    "@openmrs/esm-offline": "^3.1.15-pre.751",
+    "@openmrs/esm-react-utils": "^3.1.15-pre.751",
+    "@openmrs/esm-state": "^3.1.15-pre.751",
+    "@openmrs/esm-styleguide": "^3.1.15-pre.751",
+    "@openmrs/esm-utils": "^3.1.15-pre.751",
+    "dayjs": "^1.10.7"
   },
-  "gitHead": "46137ce3d7fa9063058317a118324168e12cee11"
+  "gitHead": "de47ee691eaa1863dcd18a5b696ba785f502223e"
 }