@openmrs/esm-framework 5.7.3-pre.2136 → 5.7.3-pre.2139

package/docs/API.md

@@ -227,13 +227,11 @@
 
 - [age](API.md#age)
 - [canAccessStorage](API.md#canaccessstorage)
-- [daysIntoYear](API.md#daysintoyear)
 - [displayName](API.md#displayname)
 - [formatPatientName](API.md#formatpatientname)
 - [formattedName](API.md#formattedname)
 - [getDefaultsFromConfigSchema](API.md#getdefaultsfromconfigschema)
 - [getPatientName](API.md#getpatientname)
-- [isSameDay](API.md#issameday)
 - [isVersionSatisfied](API.md#isversionsatisfied)
 - [retry](API.md#retry)
 - [selectPreferredName](API.md#selectpreferredname)
@@ -6519,15 +6517,19 @@ ___
 
 ### age
 
-▸ **age**(`dateString`): `string`
+▸ **age**(`birthDate`, `currentDate?`): `string`
 
-Gets a human readable and locale supported age represention of the provided date string.
+Gets a human readable and locale supported representation of a person's age, given their birthDate,
+The representation logic follows the guideline here:
+https://webarchive.nationalarchives.gov.uk/ukgwa/20160921162509mp_/http://systems.digital.nhs.uk/data/cui/uig/patben.pdf
+(See Tables 7 and 8)
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `dateString` | `string` | The stringified date. |
+| `birthDate` | `undefined` \| ``null`` \| `string` \| `number` \| `Date` \| `Dayjs` | The birthDate. |
+| `currentDate` | `undefined` \| ``null`` \| `string` \| `number` \| `Date` \| `Dayjs` | Optional. If provided, calculates the age of the person at the provided currentDate (instead of now). |
 
 #### Returns
 
@@ -6537,7 +6539,7 @@ A human-readable string version of the age.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/age-helpers.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.ts#L36)
+[packages/framework/esm-utils/src/age-helpers.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.ts#L17)
 
 ___
 
@@ -6567,30 +6569,6 @@ True if the WebStorage API object is able to be accessed, false otherwise
 
 ___
 
-### daysIntoYear
-
-▸ **daysIntoYear**(`date`): `number`
-
-Gets the number of days in the year of the given date.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `date` | `Date` | The date to compute the days within the year. |
-
-#### Returns
-
-`number`
-
-The number of days.
-
-#### Defined in
-
-[packages/framework/esm-utils/src/age-helpers.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.ts#L9)
-
-___
-
 ### displayName
 
 ▸ **displayName**(`patient`): `string`
@@ -6721,31 +6699,6 @@ The patient's display name or an empty string if name is not present.
 
 ___
 
-### isSameDay
-
-▸ **isSameDay**(`firstDate`, `secondDate`): `boolean`
-
-Checks if two dates are representing the same day.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `firstDate` | `Date` | The first date. |
-| `secondDate` | `Date` | The second date. |
-
-#### Returns
-
-`boolean`
-
-True if both are located on the same day.
-
-#### Defined in
-
-[packages/framework/esm-utils/src/age-helpers.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.ts#L25)
-
-___
-
 ### isVersionSatisfied
 
 ▸ **isVersionSatisfied**(`requiredVersion`, `installedVersion`): `boolean`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "5.7.3-pre.2136",
+  "version": "5.7.3-pre.2139",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -37,22 +37,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "5.7.3-pre.2136",
-    "@openmrs/esm-config": "5.7.3-pre.2136",
-    "@openmrs/esm-context": "5.7.3-pre.2136",
-    "@openmrs/esm-dynamic-loading": "5.7.3-pre.2136",
-    "@openmrs/esm-error-handling": "5.7.3-pre.2136",
-    "@openmrs/esm-extensions": "5.7.3-pre.2136",
-    "@openmrs/esm-feature-flags": "5.7.3-pre.2136",
-    "@openmrs/esm-globals": "5.7.3-pre.2136",
-    "@openmrs/esm-navigation": "5.7.3-pre.2136",
-    "@openmrs/esm-offline": "5.7.3-pre.2136",
-    "@openmrs/esm-react-utils": "5.7.3-pre.2136",
-    "@openmrs/esm-routes": "5.7.3-pre.2136",
-    "@openmrs/esm-state": "5.7.3-pre.2136",
-    "@openmrs/esm-styleguide": "5.7.3-pre.2136",
-    "@openmrs/esm-translations": "5.7.3-pre.2136",
-    "@openmrs/esm-utils": "5.7.3-pre.2136",
+    "@openmrs/esm-api": "5.7.3-pre.2139",
+    "@openmrs/esm-config": "5.7.3-pre.2139",
+    "@openmrs/esm-context": "5.7.3-pre.2139",
+    "@openmrs/esm-dynamic-loading": "5.7.3-pre.2139",
+    "@openmrs/esm-error-handling": "5.7.3-pre.2139",
+    "@openmrs/esm-extensions": "5.7.3-pre.2139",
+    "@openmrs/esm-feature-flags": "5.7.3-pre.2139",
+    "@openmrs/esm-globals": "5.7.3-pre.2139",
+    "@openmrs/esm-navigation": "5.7.3-pre.2139",
+    "@openmrs/esm-offline": "5.7.3-pre.2139",
+    "@openmrs/esm-react-utils": "5.7.3-pre.2139",
+    "@openmrs/esm-routes": "5.7.3-pre.2139",
+    "@openmrs/esm-state": "5.7.3-pre.2139",
+    "@openmrs/esm-styleguide": "5.7.3-pre.2139",
+    "@openmrs/esm-translations": "5.7.3-pre.2139",
+    "@openmrs/esm-utils": "5.7.3-pre.2139",
     "dayjs": "^1.10.7"
   },
   "peerDependencies": {