@openmrs/esm-api 5.3.3-pre.1237 → 5.3.3-pre.1247

package/src/shared-api-objects/current-patient.test.ts

@@ -1,59 +1,51 @@
-import { fhirBaseUrl, openmrsFetch } from "../openmrs-fetch";
-import { fetchCurrentPatient } from "./current-patient";
+import { fhirBaseUrl, openmrsFetch } from '../openmrs-fetch';
+import { fetchCurrentPatient } from './current-patient';
 
-jest.mock("../openmrs-fetch", () => ({
+jest.mock('../openmrs-fetch', () => ({
   openmrsFetch: jest.fn(),
 }));
 
-describe("current patient", () => {
+describe('current patient', () => {
   beforeEach(() => {
     (openmrsFetch as jest.MockedFunction<any>).mockReset();
   });
 
-  it("fetches the correct patient from a patient chart URL", () => {
+  it('fetches the correct patient from a patient chart URL', () => {
     (openmrsFetch as jest.MockedFunction<any>).mockReturnValueOnce(
       Promise.resolve({
         data: {},
-      })
+      }),
     );
 
-    return fetchCurrentPatient("12", undefined, false).then(() => {
-      expect(openmrsFetch as jest.MockedFunction<any>).toHaveBeenCalledWith(
-        `${fhirBaseUrl}/Patient/12`,
-        undefined
-      );
+    return fetchCurrentPatient('12', undefined, false).then(() => {
+      expect(openmrsFetch as jest.MockedFunction<any>).toHaveBeenCalledWith(`${fhirBaseUrl}/Patient/12`, undefined);
     });
   });
 
-  it("fetches the correct patient from the patient home URL", () => {
+  it('fetches the correct patient from the patient home URL', () => {
     (openmrsFetch as jest.MockedFunction<any>).mockReturnValueOnce(
       Promise.resolve({
         data: {},
-      })
+      }),
     );
 
-    return fetchCurrentPatient("34", undefined, false).then(() => {
-      expect(openmrsFetch as jest.MockedFunction<any>).toHaveBeenCalledWith(
-        `${fhirBaseUrl}/Patient/34`,
-        undefined
-      );
+    return fetchCurrentPatient('34', undefined, false).then(() => {
+      expect(openmrsFetch as jest.MockedFunction<any>).toHaveBeenCalledWith(`${fhirBaseUrl}/Patient/34`, undefined);
     });
   });
 
-  it("can handle dashes and alphanumeric characters in the patient uuid", () => {
+  it('can handle dashes and alphanumeric characters in the patient uuid', () => {
     (openmrsFetch as jest.MockedFunction<any>).mockReturnValueOnce(
       Promise.resolve({
         data: {},
-      })
+      }),
     );
 
-    return fetchCurrentPatient("34-asdsd-234243h342", undefined, false).then(
-      () => {
-        expect(openmrsFetch as jest.MockedFunction<any>).toHaveBeenCalledWith(
-          `${fhirBaseUrl}/Patient/34-asdsd-234243h342`,
-          undefined
-        );
-      }
-    );
+    return fetchCurrentPatient('34-asdsd-234243h342', undefined, false).then(() => {
+      expect(openmrsFetch as jest.MockedFunction<any>).toHaveBeenCalledWith(
+        `${fhirBaseUrl}/Patient/34-asdsd-234243h342`,
+        undefined,
+      );
+    });
   });
 });

package/src/shared-api-objects/current-patient.ts

@@ -1,7 +1,7 @@
 /** @module @category API */
-import { getSynchronizationItems } from "@openmrs/esm-offline";
-import { FetchConfig, fhirBaseUrl, openmrsFetch } from "../openmrs-fetch";
-import { FetchResponse } from "../types";
+import { getSynchronizationItems } from '@openmrs/esm-offline';
+import { FetchConfig, fhirBaseUrl, openmrsFetch } from '../openmrs-fetch';
+import { FetchResponse } from '../types';
 
 export type CurrentPatient = fhir.Patient | FetchResponse<fhir.Patient>;
 export interface CurrentPatientOptions {
@@ -21,18 +21,15 @@ export type PatientUuid = string | null;
 export async function fetchCurrentPatient(
   patientUuid: PatientUuid,
   fetchInit?: FetchConfig,
-  includeOfflinePatients: boolean = true
+  includeOfflinePatients: boolean = true,
 ): Promise<fhir.Patient | null> {
   if (patientUuid) {
     let err: Error | null = null;
     const [onlinePatient, offlinePatient] = await Promise.all([
-      openmrsFetch<fhir.Patient>(
-        `${fhirBaseUrl}/Patient/${patientUuid}`,
-        fetchInit
-      ).catch<FetchResponse<fhir.Patient>>((e) => (err = e)),
-      includeOfflinePatients
-        ? getOfflineRegisteredPatientAsFhirPatient(patientUuid)
-        : Promise.resolve(null),
+      openmrsFetch<fhir.Patient>(`${fhirBaseUrl}/Patient/${patientUuid}`, fetchInit).catch<FetchResponse<fhir.Patient>>(
+        (e) => (err = e),
+      ),
+      includeOfflinePatients ? getOfflineRegisteredPatientAsFhirPatient(patientUuid) : Promise.resolve(null),
     ]);
 
     if (onlinePatient.ok) {
@@ -51,15 +48,11 @@ export async function fetchCurrentPatient(
   return null;
 }
 
-async function getOfflineRegisteredPatientAsFhirPatient(
-  patientUuid: string
-): Promise<fhir.Patient | null> {
+async function getOfflineRegisteredPatientAsFhirPatient(patientUuid: string): Promise<fhir.Patient | null> {
   const patientRegistrationSyncItems = await getSynchronizationItems<{
     fhirPatient: fhir.Patient;
-  }>("patient-registration");
-  const patientSyncItem = patientRegistrationSyncItems.find(
-    (item) => item.fhirPatient.id === patientUuid
-  );
+  }>('patient-registration');
+  const patientSyncItem = patientRegistrationSyncItems.find((item) => item.fhirPatient.id === patientUuid);
 
   return patientSyncItem?.fhirPatient ?? null;
 }

package/src/shared-api-objects/current-user.ts

@@ -1,16 +1,10 @@
 /** @module @category API */
-import { reportError } from "@openmrs/esm-error-handling";
-import { createGlobalStore } from "@openmrs/esm-state";
-import isUndefined from "lodash-es/isUndefined";
-import { Observable } from "rxjs";
-import { openmrsFetch, sessionEndpoint } from "../openmrs-fetch";
-import type {
-  LoggedInUser,
-  SessionLocation,
-  Privilege,
-  Role,
-  Session,
-} from "../types";
+import { reportError } from '@openmrs/esm-error-handling';
+import { createGlobalStore } from '@openmrs/esm-state';
+import isUndefined from 'lodash-es/isUndefined';
+import { Observable } from 'rxjs';
+import { openmrsFetch, sessionEndpoint } from '../openmrs-fetch';
+import type { LoggedInUser, SessionLocation, Privilege, Role, Session } from '../types';
 
 export type SessionStore = LoadedSessionStore | UnloadedSessionStore;
 
@@ -24,7 +18,7 @@ export type UnloadedSessionStore = {
   session: null;
 };
 
-const sessionStore = createGlobalStore<SessionStore>("session", {
+const sessionStore = createGlobalStore<SessionStore>('session', {
   loaded: false,
   session: null,
 });
@@ -70,16 +64,9 @@ let lastFetchTimeMillis = 0;
  */
 function getCurrentUser(): Observable<Session>;
 function getCurrentUser(opts: { includeAuthStatus: true }): Observable<Session>;
-function getCurrentUser(opts: {
-  includeAuthStatus: false;
-}): Observable<LoggedInUser>;
-function getCurrentUser(
-  opts = { includeAuthStatus: true }
-): Observable<Session | LoggedInUser> {
-  if (
-    lastFetchTimeMillis < Date.now() - 1000 * 60 ||
-    !sessionStore.getState().loaded
-  ) {
+function getCurrentUser(opts: { includeAuthStatus: false }): Observable<LoggedInUser>;
+function getCurrentUser(opts = { includeAuthStatus: true }): Observable<Session | LoggedInUser> {
+  if (lastFetchTimeMillis < Date.now() - 1000 * 60 || !sessionStore.getState().loaded) {
     refetchCurrentUser();
   }
 
@@ -103,10 +90,7 @@ function getCurrentUser(
 export { getCurrentUser };
 
 export function getSessionStore() {
-  if (
-    lastFetchTimeMillis < Date.now() - 1000 * 60 ||
-    !sessionStore.getState().loaded
-  ) {
+  if (lastFetchTimeMillis < Date.now() - 1000 * 60 || !sessionStore.getState().loaded) {
     refetchCurrentUser();
   }
 
@@ -115,7 +99,7 @@ export function getSessionStore() {
 
 // NB locale is string only if this returns true
 function isValidLocale(locale: unknown): locale is string {
-  if (locale === undefined || typeof locale !== "string") {
+  if (locale === undefined || typeof locale !== 'string') {
     return false;
   }
 
@@ -130,25 +114,18 @@ function isValidLocale(locale: unknown): locale is string {
 
 export function setUserLanguage(data: Session) {
   const locale = data?.user?.userProperties?.defaultLocale ?? data.locale;
-  const htmlLang = document.documentElement.getAttribute("lang");
+  const htmlLang = document.documentElement.getAttribute('lang');
 
   if (isValidLocale(locale) && locale !== htmlLang) {
-    document.documentElement.setAttribute("lang", locale);
+    document.documentElement.setAttribute('lang', locale);
   }
 }
 
-function userHasPrivilege(
-  requiredPrivilege: string | string[] | undefined,
-  user: { privileges: Array<Privilege> }
-) {
-  if (typeof requiredPrivilege === "string") {
-    return !isUndefined(
-      user.privileges.find((p) => requiredPrivilege === p.display)
-    );
+function userHasPrivilege(requiredPrivilege: string | string[] | undefined, user: { privileges: Array<Privilege> }) {
+  if (typeof requiredPrivilege === 'string') {
+    return !isUndefined(user.privileges.find((p) => requiredPrivilege === p.display));
   } else if (Array.isArray(requiredPrivilege)) {
-    return requiredPrivilege.every(
-      (rp) => !isUndefined(user.privileges.find((p) => rp === p.display))
-    );
+    return requiredPrivilege.every((rp) => !isUndefined(user.privileges.find((p) => rp === p.display)));
   } else if (!isUndefined(requiredPrivilege)) {
     console.error(`Could not understand privileges "${requiredPrivilege}"`);
   }
@@ -157,9 +134,7 @@ function userHasPrivilege(
 }
 
 function isSuperUser(user: { roles: Array<Role> }) {
-  return !isUndefined(
-    user.roles.find((role) => role.display === "System Developer")
-  );
+  return !isUndefined(user.roles.find((role) => role.display === 'System Developer'));
 }
 
 /**
@@ -180,7 +155,7 @@ export function refetchCurrentUser() {
     lastFetchTimeMillis = Date.now();
     openmrsFetch(sessionEndpoint)
       .then((res) => {
-        if (typeof res?.data === "object") {
+        if (typeof res?.data === 'object') {
           setUserLanguage(res.data);
           resolve(res.data);
           sessionStore.setState({ loaded: true, session: res.data });
@@ -193,7 +168,7 @@ export function refetchCurrentUser() {
         reportError(`Failed to fetch new session information: ${err}`);
         reject(err);
         return {
-          sessionId: "",
+          sessionId: '',
           authenticated: false,
         };
       });
@@ -203,13 +178,13 @@ export function refetchCurrentUser() {
 export function clearCurrentUser() {
   sessionStore.setState({
     loaded: true,
-    session: { authenticated: false, sessionId: "" },
+    session: { authenticated: false, sessionId: '' },
   });
 }
 
 export function userHasAccess(
   requiredPrivilege: string | string[],
-  user: { privileges: Array<Privilege>; roles: Array<Role> }
+  user: { privileges: Array<Privilege>; roles: Array<Role> },
 ) {
   if (user === undefined) {
     // if the user hasn't been loaded, then return false iff there is a required privilege
@@ -251,15 +226,12 @@ export function getSessionLocation() {
   });
 }
 
-export async function setSessionLocation(
-  locationUuid: string,
-  abortController: AbortController
-): Promise<any> {
+export async function setSessionLocation(locationUuid: string, abortController: AbortController): Promise<any> {
   await openmrsFetch(sessionEndpoint, {
-    method: "POST",
+    method: 'POST',
     body: { sessionLocation: locationUuid },
     headers: {
-      "Content-Type": "application/json",
+      'Content-Type': 'application/json',
     },
     signal: abortController.signal,
   });
@@ -272,16 +244,16 @@ export async function setUserProperties(
   userProperties: {
     [x: string]: string;
   },
-  abortController?: AbortController
+  abortController?: AbortController,
 ): Promise<any> {
   if (!abortController) {
     abortController = new AbortController();
   }
   await openmrsFetch(`/ws/rest/v1/user/${userUuid}`, {
-    method: "POST",
+    method: 'POST',
     body: { userProperties },
     headers: {
-      "Content-Type": "application/json",
+      'Content-Type': 'application/json',
     },
     signal: abortController.signal,
   });

package/src/shared-api-objects/location.ts

@@ -1,8 +1,8 @@
 /** @module @category API */
-import { Observable } from "rxjs";
-import { map, take } from "rxjs/operators";
-import { openmrsObservableFetch } from "../openmrs-fetch";
-import { Location } from "../types";
+import { Observable } from 'rxjs';
+import { map, take } from 'rxjs/operators';
+import { openmrsObservableFetch } from '../openmrs-fetch';
+import { Location } from '../types';
 
 export function toLocationObject(openmrsRestForm: any): Location {
   return {
@@ -15,10 +15,9 @@ export function getLocations(): Observable<Array<Location>> {
   return openmrsObservableFetch<any>(`/ws/rest/v1/location`)
     .pipe(
       map((results) => {
-        const locations: Array<Location> =
-          results.data.results.map(toLocationObject);
+        const locations: Array<Location> = results.data.results.map(toLocationObject);
         return locations;
-      })
+      }),
     )
     .pipe(take(1));
 }

package/src/shared-api-objects/visit-type.ts

@@ -1,8 +1,8 @@
 /** @module @category API */
-import { Observable } from "rxjs";
-import { map, take } from "rxjs/operators";
-import { openmrsObservableFetch } from "../openmrs-fetch";
-import { VisitType } from "../types";
+import { Observable } from 'rxjs';
+import { map, take } from 'rxjs/operators';
+import { openmrsObservableFetch } from '../openmrs-fetch';
+import { VisitType } from '../types';
 
 export function toVisitTypeObject(openmrsRestForm: any): VisitType {
   return {
@@ -16,10 +16,9 @@ export function getVisitTypes(): Observable<Array<VisitType>> {
   return openmrsObservableFetch<any>(`/ws/rest/v1/visittype`)
     .pipe(
       map((results) => {
-        const visitTypes: Array<VisitType> =
-          results.data.results.map(toVisitTypeObject);
+        const visitTypes: Array<VisitType> = results.data.results.map(toVisitTypeObject);
         return visitTypes;
-      })
+      }),
     )
     .pipe(take(1));
 }

package/src/shared-api-objects/visit-utils.ts

@@ -1,23 +1,18 @@
 /** @module @category API */
-import { Observable, BehaviorSubject } from "rxjs";
-import { take, map } from "rxjs/operators";
-import { openmrsObservableFetch } from "../openmrs-fetch";
-import {
-  FetchResponse,
-  NewVisitPayload,
-  UpdateVisitPayload,
-  Visit,
-} from "../types";
-import { getGlobalStore } from "@openmrs/esm-state";
+import { Observable, BehaviorSubject } from 'rxjs';
+import { take, map } from 'rxjs/operators';
+import { openmrsObservableFetch } from '../openmrs-fetch';
+import { FetchResponse, NewVisitPayload, UpdateVisitPayload, Visit } from '../types';
+import { getGlobalStore } from '@openmrs/esm-state';
 
 export const defaultVisitCustomRepresentation =
-  "custom:(uuid,encounters:(uuid,encounterDatetime," +
-  "form:(uuid,name),location:ref," +
-  "encounterType:ref,encounterProviders:(uuid,display," +
-  "provider:(uuid,display))),patient:(uuid,uuid)," +
-  "visitType:(uuid,name,display)," +
-  "attributes:(uuid,display,attributeType:(name,datatypeClassname,uuid),value)," +
-  "location:(uuid,name,display),startDatetime,stopDatetime)";
+  'custom:(uuid,encounters:(uuid,encounterDatetime,' +
+  'form:(uuid,name),location:ref,' +
+  'encounterType:ref,encounterProviders:(uuid,display,' +
+  'provider:(uuid,display))),patient:(uuid,uuid),' +
+  'visitType:(uuid,name,display),' +
+  'attributes:(uuid,display,attributeType:(name,datatypeClassname,uuid),value),' +
+  'location:(uuid,name,display),startDatetime,stopDatetime)';
 
 export interface VisitStoreState {
   patientUuid: string | null;
@@ -29,7 +24,7 @@ const initialState = getVisitLocalStorage() || {
   manuallySetVisitUuid: null,
 };
 export function getVisitStore() {
-  return getGlobalStore<VisitStoreState>("visit", initialState);
+  return getGlobalStore<VisitStoreState>('visit', initialState);
 }
 
 export function setCurrentVisit(patientUuid: string, visitUuid: string) {
@@ -41,14 +36,12 @@ getVisitStore().subscribe((state) => {
 });
 
 function setVisitLocalStorage(value: VisitStoreState) {
-  localStorage.setItem("openmrs:visitStoreState", JSON.stringify(value));
+  localStorage.setItem('openmrs:visitStoreState', JSON.stringify(value));
 }
 
 function getVisitLocalStorage(): VisitStoreState | null {
   try {
-    return JSON.parse(
-      localStorage.getItem("openmrs:visitStoreState") || "null"
-    );
+    return JSON.parse(localStorage.getItem('openmrs:visitStoreState') || 'null');
   } catch (e) {
     return null;
   }
@@ -57,37 +50,31 @@ function getVisitLocalStorage(): VisitStoreState | null {
 export function getVisitsForPatient(
   patientUuid: string,
   abortController: AbortController,
-  v?: string
+  v?: string,
 ): Observable<FetchResponse<{ results: Array<Visit> }>> {
   const custom = v ?? defaultVisitCustomRepresentation;
 
-  return openmrsObservableFetch(
-    `/ws/rest/v1/visit?patient=${patientUuid}&v=${custom}`,
-    {
-      signal: abortController.signal,
-      method: "GET",
-      headers: {
-        "Content-type": "application/json",
-      },
-    }
-  )
+  return openmrsObservableFetch(`/ws/rest/v1/visit?patient=${patientUuid}&v=${custom}`, {
+    signal: abortController.signal,
+    method: 'GET',
+    headers: {
+      'Content-type': 'application/json',
+    },
+  })
     .pipe(take(1))
     .pipe(
       map((response: FetchResponse<{ results: Array<Visit> }>) => {
         return response;
-      })
+      }),
     );
 }
 
-export function saveVisit(
-  payload: NewVisitPayload,
-  abortController: AbortController
-): Observable<FetchResponse<any>> {
+export function saveVisit(payload: NewVisitPayload, abortController: AbortController): Observable<FetchResponse<any>> {
   return openmrsObservableFetch(`/ws/rest/v1/visit`, {
     signal: abortController.signal,
-    method: "POST",
+    method: 'POST',
     headers: {
-      "Content-type": "application/json",
+      'Content-type': 'application/json',
     },
     body: payload,
   });
@@ -96,13 +83,13 @@ export function saveVisit(
 export function updateVisit(
   uuid: string,
   payload: UpdateVisitPayload,
-  abortController: AbortController
+  abortController: AbortController,
 ): Observable<any> {
   return openmrsObservableFetch(`/ws/rest/v1/visit/${uuid}`, {
     signal: abortController.signal,
-    method: "POST",
+    method: 'POST',
     headers: {
-      "Content-type": "application/json",
+      'Content-type': 'application/json',
     },
     body: payload,
   });
@@ -119,12 +106,12 @@ export interface VisitItem {
 }
 
 export enum VisitMode {
-  NEWVISIT = "startVisit",
-  EDITVISIT = "editVisit",
-  LOADING = "loadingVisit",
+  NEWVISIT = 'startVisit',
+  EDITVISIT = 'editVisit',
+  LOADING = 'loadingVisit',
 }
 
 export enum VisitStatus {
-  NOTSTARTED = "notStarted",
-  ONGOING = "ongoing",
+  NOTSTARTED = 'notStarted',
+  ONGOING = 'ongoing',
 }

package/src/types/fetch.ts

@@ -1,4 +1,4 @@
-import { Session } from "./user-resource";
+import { Session } from './user-resource';
 
 export interface FetchResponse<T = any> extends Response {
   data: T;