@openmrs/esm-utils 5.6.1-pre.1889 → 5.6.1-pre.1891

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-utils",
-  "version": "5.6.1-pre.1889",
+  "version": "5.6.1-pre.1891",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "browser": "dist/openmrs-esm-utils.js",
@@ -39,7 +39,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "@openmrs/esm-globals": "5.6.1-pre.1889",
+    "@openmrs/esm-globals": "5.6.1-pre.1891",
     "@types/semver": "^7.3.4",
     "dayjs": "^1.10.4",
     "rxjs": "^6.5.3"

package/src/patient-helpers.test.ts

@@ -1,4 +1,4 @@
-import { displayName, formattedName, selectPreferredName } from './patient-helpers';
+import { formatPatientName, getPatientName, selectPreferredName } from './patient-helpers';
 import {
   mockPatientWithNoName,
   mockPatientWithOfficialName,
@@ -19,7 +19,7 @@ describe('Formatted display name', () => {
     [givenNameOnly, 'given'],
     [mockPatientWithNoName, ''],
   ])('Is formatted name text if present else default name format', (name, expected) => {
-    const result = formattedName(name);
+    const result = formatPatientName(name);
     expect(result).toBe(expected);
   });
 });
@@ -30,7 +30,7 @@ describe('Patient display name', () => {
     [mockPatientWithOfficialName, 'my actual name'],
     [mockPatientWithNickAndOfficialName, 'my official name'],
   ])('Is selected from usual name or official name', (patient, expected) => {
-    const result = displayName(patient);
+    const result = getPatientName(patient);
     expect(result).toBe(expected);
   });
 });

package/src/patient-helpers.ts

@@ -11,9 +11,14 @@ import { type NameUse } from '@openmrs/esm-globals';
  * @param patient The patient details in FHIR format.
  * @returns The patient's display name or an empty string if name is not present.
  */
-export function displayName(patient: fhir.Patient): string {
+export function getPatientName(patient: fhir.Patient): string {
   const name = selectPreferredName(patient, 'usual', 'official');
-  return formattedName(name);
+  return formatPatientName(name);
+}
+
+/** @deprecated Use `getPatientName` */
+export function displayName(patient: fhir.Patient): string {
+  return getPatientName(patient);
 }
 
 /**
@@ -21,11 +26,16 @@ export function displayName(patient: fhir.Patient): string {
  * @param name The name to be formatted.
  * @returns The formatted display name or an empty string if name is undefined.
  */
-export function formattedName(name: fhir.HumanName | undefined): string {
+export function formatPatientName(name: fhir.HumanName | undefined): string {
   if (name) return name.text ?? defaultFormat(name);
   return '';
 }
 
+/** @deprecated Use `formatPatientName` */
+export function formattedName(name: fhir.HumanName | undefined): string {
+  return formatPatientName(name);
+}
+
 /**
  * Select the preferred name from the collection of names associated with a patient.
  *