@openmrs/esm-api 4.3.2-pre.660 → 4.3.2-pre.662

package/jest.config.js

@@ -8,6 +8,7 @@ module.exports = {
       "<rootDir>/__mocks__/openmrs-esm-error-handling.mock.ts",
     "@openmrs/esm-config": "<rootDir>/__mocks__/openmrs-esm-config.mock.ts",
     "single-spa": "<rootDir>/__mocks__/single-spa.mock.ts",
+    dexie: require.resolve("dexie"),
   },
   testEnvironment: "jsdom",
   testEnvironmentOptions: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-api",
-  "version": "4.3.2-pre.660",
+  "version": "4.3.2-pre.662",
   "license": "MPL-2.0",
   "description": "The javascript module for interacting with the OpenMRS API",
   "browser": "dist/openmrs-esm-api.js",
@@ -41,13 +41,14 @@
   },
   "peerDependencies": {
     "@openmrs/esm-config": "4.x",
-    "@openmrs/esm-error-handling": "4.x"
+    "@openmrs/esm-error-handling": "4.x",
+    "@openmrs/esm-offline": "4.x"
   },
   "devDependencies": {
-    "@openmrs/esm-config": "^4.3.2-pre.660",
-    "@openmrs/esm-error-handling": "^4.3.2-pre.660",
-    "@openmrs/esm-state": "^4.3.2-pre.660",
+    "@openmrs/esm-config": "^4.3.2-pre.662",
+    "@openmrs/esm-error-handling": "^4.3.2-pre.662",
+    "@openmrs/esm-state": "^4.3.2-pre.662",
     "rxjs": "^6.5.3"
   },
-  "gitHead": "7b4eed59da0624b69ea0b86baada3dc111f6407a"
+  "gitHead": "1e1ab6761ff3726c7e0eee55373b1bf4a0d97b99"
 }

package/src/index.ts

@@ -1,6 +1,5 @@
 export * from "./types";
 export * from "./openmrs-fetch";
-export * from "./fhir";
 export * from "./setup";
 
 export * from "./shared-api-objects/current-user";

package/src/openmrs-fetch.ts

@@ -4,7 +4,11 @@ import isPlainObject from "lodash-es/isPlainObject";
 import { getConfig, navigate } from "@openmrs/esm-config";
 import { FetchResponse } from "./types";
 
-export const sessionEndpoint = "/ws/rest/v1/session";
+export const restBaseUrl = "/ws/rest/v1/";
+
+export const fhirBaseUrl = "/ws/fhir2/R4";
+
+export const sessionEndpoint = `${restBaseUrl}session`;
 
 /**
  * Append `path` to the OpenMRS SPA base.
@@ -92,9 +96,13 @@ export function openmrsFetch<T = any>(
     );
   }
 
+  // ensure path starts with /
+  if (path[0] !== "/") {
+    path = "/" + path;
+  }
+
   // Prefix the url with the openmrs spa base
-  // @ts-ignore
-  const url = makeUrl(path);
+  let url: string = makeUrl(path);
 
   // We're going to need some headers
   if (!fetchInit.headers) {
@@ -126,10 +134,21 @@ export function openmrsFetch<T = any>(
    * header. Returning that header is useful when using the API, but
    * not from a UI.
    */
-  if (typeof fetchInit.headers["Disable-WWW-Authenticate"] === "undefined") {
+  if (
+    path.startsWith(restBaseUrl) &&
+    typeof fetchInit.headers["Disable-WWW-Authenticate"] === "undefined"
+  ) {
     fetchInit.headers["Disable-WWW-Authenticate"] = "true";
   }
 
+  if (path.startsWith(fhirBaseUrl)) {
+    const urlUrl = new URL(url, window.location.toString());
+    if (!urlUrl.searchParams.has("_summary")) {
+      urlUrl.searchParams.set("_summary", "data");
+      url = urlUrl.toString();
+    }
+  }
+
   /* We capture the stacktrace before making the request, so that if an error occurs we can
    * log a full stacktrace that includes the code that made the request and handled the response
    * Otherwise, we could run into situations where the stacktrace doesn't even show which code
@@ -303,7 +322,7 @@ export class OpenmrsFetchError extends Error {
   responseBody: string | FetchResponseJson | null;
 }
 
-interface FetchConfig extends Omit<Omit<RequestInit, "body">, "headers"> {
+export interface FetchConfig extends Omit<RequestInit, "body" | "headers"> {
   headers?: FetchHeaders;
   body?: FetchBody | string;
 }

package/src/public.ts

@@ -1,6 +1,5 @@
 export * from "./types";
 export * from "./openmrs-fetch";
-export * from "./fhir";
 
 export * from "./shared-api-objects/current-user";
 export * from "./shared-api-objects/current-patient";

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

@@ -1,59 +1,59 @@
+import { fhirBaseUrl, openmrsFetch } from "../openmrs-fetch";
 import { fetchCurrentPatient } from "./current-patient";
-import { fhir } from "../fhir";
 
-jest.mock("../fhir", () => ({
-  fhir: {
-    read: jest.fn(),
-  },
+jest.mock("../openmrs-fetch", () => ({
+  openmrsFetch: jest.fn(),
 }));
 
 describe("current patient", () => {
   beforeEach(() => {
-    (fhir.read as jest.MockedFunction<any>).mockReset();
+    (openmrsFetch as jest.MockedFunction<any>).mockReset();
   });
 
   it("fetches the correct patient from a patient chart URL", () => {
-    (fhir.read as jest.MockedFunction<any>).mockReturnValueOnce(
+    (openmrsFetch as jest.MockedFunction<any>).mockReturnValueOnce(
       Promise.resolve({
         data: {},
       })
     );
 
-    return fetchCurrentPatient("12").then(() => {
-      expect(fhir.read as jest.MockedFunction<any>).toHaveBeenCalledWith({
-        type: "Patient",
-        patient: "12",
-      });
+    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", () => {
-    (fhir.read as jest.MockedFunction<any>).mockReturnValueOnce(
+    (openmrsFetch as jest.MockedFunction<any>).mockReturnValueOnce(
       Promise.resolve({
         data: {},
       })
     );
 
-    return fetchCurrentPatient("34").then(() => {
-      expect(fhir.read as jest.MockedFunction<any>).toHaveBeenCalledWith({
-        type: "Patient",
-        patient: "34",
-      });
+    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", () => {
-    (fhir.read as jest.MockedFunction<any>).mockReturnValueOnce(
+    (openmrsFetch as jest.MockedFunction<any>).mockReturnValueOnce(
       Promise.resolve({
         data: {},
       })
     );
 
-    return fetchCurrentPatient("34-asdsd-234243h342").then(() => {
-      expect(fhir.read as jest.MockedFunction<any>).toHaveBeenCalledWith({
-        type: "Patient",
-        patient: "34-asdsd-234243h342",
-      });
-    });
+    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,9 +1,9 @@
 /** @module @category API */
-import { fhir } from "../fhir";
+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 {
   includeConfig?: boolean;
 }
@@ -18,17 +18,48 @@ export interface OnlyThePatient extends CurrentPatientOptions {
 
 export type PatientUuid = string | null;
 
-export function fetchCurrentPatient(
+export async function fetchCurrentPatient(
   patientUuid: PatientUuid,
-  contentOverrides?: Partial<Parameters<typeof fhir.read>[0]>
-) {
+  fetchInit?: FetchConfig,
+  includeOfflinePatients: boolean = true
+): Promise<fhir.Patient | null> {
   if (patientUuid) {
-    return fhir.read<fhir.Patient>({
-      type: "Patient",
-      patient: patientUuid,
-      ...contentOverrides,
-    });
+    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),
+    ]);
+
+    if (onlinePatient.ok) {
+      return onlinePatient.data;
+    }
+
+    if (offlinePatient) {
+      return offlinePatient;
+    }
+
+    if (err) {
+      throw err;
+    }
   }
 
-  return Promise.resolve(null);
+  return 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
+  );
+
+  return patientSyncItem?.fhirPatient ?? null;
 }

package/src/types/fhir.ts

@@ -1,12 +1,9 @@
-import { FetchHeaders } from "../openmrs-fetch";
-
 /*
 Originally taken from https://github.com/FHIR/fhir.js/blob/ec82ccfc125e05dbb645f47c100fe60f2c34bb73/src/fhir.d.ts
 Has been adapted to be even better - if we can get fhir.js to publish a good version to npm with better typedefs,
 we can remove this file in favor of the one they maintain
 */
 
-type ClientFn = (...args: any[]) => Promise<{ data: any }>;
 export type ResourceName =
   | "DomainResource"
   | "Organization"
@@ -103,72 +100,3 @@ export type ResourceName =
   | "Binary"
   | "Bundle"
   | "Parameters";
-interface QueryOptions {
-  $include?: { [key: string]: string | string[] };
-  [key: string]: any;
-}
-
-declare function Create<T extends fhir.DomainResource>(content: {
-  resource: T;
-}): Promise<{ data: T }>;
-declare function Create(content: {
-  type: "Binary";
-  data: Buffer;
-}): Promise<{ data: fhir.Binary }>;
-declare function Create<T extends fhir.DomainResource>(content: {
-  type: ResourceName;
-  data: T;
-}): Promise<{ data: T }>;
-
-declare function Read<T extends fhir.DomainResource>(content: {
-  type: ResourceName;
-  id?: string;
-  patient?: string;
-  headers?: FetchHeaders;
-}): Promise<{ data: T }>;
-
-declare function Patch(content: {
-  type: ResourceName;
-  id: string;
-  data: Array<{
-    op: "replace" | "add" | "remove";
-    path: string;
-    value: string | object;
-  }>;
-}): Promise<{ data: fhir.OperationOutcome }>;
-
-declare function Update<T extends fhir.DomainResource>(content: {
-  resource: T;
-}): Promise<{ data: T }>;
-
-declare function Search(content: {
-  type: ResourceName;
-  count?: number;
-  query?: QueryOptions;
-}): Promise<{ data: fhir.Bundle }>;
-
-declare function NextPage(content: {
-  type: ResourceName;
-  bundle: fhir.Bundle;
-}): Promise<{ data: fhir.Bundle }>;
-
-export interface FhirClient {
-  conformance: ClientFn;
-  document: ClientFn;
-  profile: ClientFn;
-  transaction: ClientFn;
-  history: ClientFn;
-  typeHistory: ClientFn;
-  resourceHistory: ClientFn;
-  read: typeof Read;
-  vread: ClientFn;
-  delete: ClientFn;
-  create: typeof Create;
-  validate: ClientFn;
-  search: typeof Search;
-  update: typeof Update;
-  nextPage: typeof NextPage;
-  prevPage: ClientFn;
-  resolve: ClientFn;
-  patch: typeof Patch;
-}

package/src/fhir.ts

@@ -1,74 +0,0 @@
-/** @module @category API */
-import { openmrsFetch, FetchHeaders, OpenmrsFetchError } from "./openmrs-fetch";
-import type { ResourceName } from "./types/fhir";
-
-export const fhirBaseUrl = `/ws/fhir2/R4`;
-
-const openmrsFhirAdapter = {
-  http(requestObj: FHIRRequestObj) {
-    return openmrsFetch(requestObj.url, {
-      method: requestObj.method,
-      headers: requestObj.headers,
-    }).then(
-      (response) => {
-        return {
-          status: response.status,
-          headers: response.headers,
-          data: response.data,
-          config: requestObj,
-        };
-      },
-      (err: OpenmrsFetchError) => {
-        return {
-          status: err.response.status,
-          headers: err.response.headers,
-          data: err.responseBody as any,
-          config: requestObj,
-        };
-      }
-    );
-  },
-};
-
-/**
- * The `fhir` object is replicates the API from [fhir.js](https://github.com/FHIR/fhir.js)
- * that can be used to call FHIR-compliant OpenMRS APIs. See
- * [the docs for fhir.js](https://github.com/FHIR/fhir.js) for more info
- * and example usage.
- *
- * This object should be considered deprecated and may be removed from a future version
- * of the framework.
- *
- * @category API
- * @deprecated
- */
-export const fhir = {
-  read: <T>(
-    options: FHIRRequestOptions
-  ): Promise<{
-    status: number;
-    headers: Headers;
-    data: T;
-    config: FHIRRequestObj;
-  }> => {
-    return openmrsFhirAdapter.http({
-      url: `${fhirBaseUrl}/${options.type}/${options.patient}`,
-      method: "GET",
-      headers: options.headers ?? {},
-    });
-  },
-};
-
-/** @deprecated */
-export interface FHIRRequestOptions {
-  type: ResourceName;
-  patient: string;
-  headers?: FetchHeaders;
-}
-
-/** @deprecated */
-export interface FHIRRequestObj {
-  url: string;
-  method: string;
-  headers: FetchHeaders;
-}