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

package/jest.config.js

@@ -1,17 +1,16 @@
 module.exports = {
   transform: {
-    "^.+\\.tsx?$": ["@swc/jest"],
+    '^.+\\.tsx?$': ['@swc/jest'],
   },
   moduleNameMapper: {
-    "lodash-es": "lodash",
-    "@openmrs/esm-error-handling":
-      "<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"),
+    'lodash-es': 'lodash',
+    '@openmrs/esm-error-handling': '<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",
+  testEnvironment: 'jsdom',
   testEnvironmentOptions: {
-    url: "http://localhost/",
+    url: 'http://localhost/',
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-api",
-  "version": "5.3.3-pre.1237",
+  "version": "5.3.3-pre.1247",
   "license": "MPL-2.0",
   "description": "The javascript module for interacting with the OpenMRS API",
   "browser": "dist/openmrs-esm-api.js",
@@ -47,9 +47,9 @@
     "@openmrs/esm-offline": "5.x"
   },
   "devDependencies": {
-    "@openmrs/esm-config": "5.3.3-pre.1237",
-    "@openmrs/esm-error-handling": "5.3.3-pre.1237",
-    "@openmrs/esm-state": "5.3.3-pre.1237",
+    "@openmrs/esm-config": "5.3.3-pre.1247",
+    "@openmrs/esm-error-handling": "5.3.3-pre.1247",
+    "@openmrs/esm-state": "5.3.3-pre.1247",
     "rxjs": "^6.5.3",
     "webpack": "^5.88.0"
   },

package/src/environment.ts

@@ -1,6 +1,3 @@
 export function isDevEnabled() {
-  return (
-    window.spaEnv === "development" ||
-    localStorage.getItem("openmrs:devtools") === "true"
-  );
+  return window.spaEnv === 'development' || localStorage.getItem('openmrs:devtools') === 'true';
 }

package/src/index.ts

@@ -1,11 +1,11 @@
-export * from "./types";
-export * from "./openmrs-fetch";
-export * from "./setup";
+export * from './types';
+export * from './openmrs-fetch';
+export * from './setup';
 
-export * from "./shared-api-objects/current-user";
-export * from "./shared-api-objects/current-patient";
-export * from "./shared-api-objects/visit-utils";
-export * from "./shared-api-objects/visit-type";
-export * from "./shared-api-objects/location";
+export * from './shared-api-objects/current-user';
+export * from './shared-api-objects/current-patient';
+export * from './shared-api-objects/visit-utils';
+export * from './shared-api-objects/visit-type';
+export * from './shared-api-objects/location';
 
-export * from "./openmrs-backend-dependencies";
+export * from './openmrs-backend-dependencies';

package/src/openmrs-backend-dependencies.ts

@@ -1,4 +1,4 @@
 export const backendDependencies = {
-  "webservices.rest": "2.24.0",
-  fhir2: "1.0.0-SNAPSHOT",
+  'webservices.rest': '2.24.0',
+  fhir2: '1.0.0-SNAPSHOT',
 };

package/src/openmrs-fetch.test.ts

@@ -1,19 +1,16 @@
-import { openmrsFetch, openmrsObservableFetch } from "./openmrs-fetch";
-import { isObservable } from "rxjs";
+import { openmrsFetch, openmrsObservableFetch } from './openmrs-fetch';
+import { isObservable } from 'rxjs';
 
-import {
-  getConfig as mockGetConfig,
-  navigate as mockNavigate,
-} from "@openmrs/esm-config";
+import { getConfig as mockGetConfig, navigate as mockNavigate } from '@openmrs/esm-config';
 
-describe("openmrsFetch", () => {
+describe('openmrsFetch', () => {
   beforeEach(() => {
     // @ts-ignore
-    window.openmrsBase = "/openmrs";
+    window.openmrsBase = '/openmrs';
     // @ts-ignore
-    window.getOpenmrsSpaBase = () => "/openmrs/spa/";
+    window.getOpenmrsSpaBase = () => '/openmrs/spa/';
     window.fetch = jest.fn();
-    Object.defineProperty(window, "location", {
+    Object.defineProperty(window, 'location', {
       writable: true,
       value: { assign: jest.fn() },
     });
@@ -35,29 +32,27 @@ describe("openmrsFetch", () => {
 
   it(`throws an error if you pass in an invalid fetchInit object`, () => {
     // @ts-ignore
-    expect(() => openmrsFetch("/session", "invalid second arg")).toThrowError(
-      /second argument/
-    );
+    expect(() => openmrsFetch('/session', 'invalid second arg')).toThrowError(/second argument/);
 
     // @ts-ignore
-    expect(() => openmrsFetch("/session", 123)).toThrowError(/second argument/);
+    expect(() => openmrsFetch('/session', 123)).toThrowError(/second argument/);
   });
 
   it(`throws an Error if there is no openmrsBase`, () => {
     // @ts-ignore
     delete window.openmrsBase;
 
-    expect(() => openmrsFetch("/session")).toThrowError(/openmrsBase/);
+    expect(() => openmrsFetch('/session')).toThrowError(/openmrsBase/);
   });
 
   it(`calls window.fetch with the correct arguments for a basic GET request`, () => {
     // @ts-ignore
     window.fetch.mockReturnValue(new Promise(() => {}));
-    openmrsFetch("/ws/rest/v1/session");
-    expect(window.fetch).toHaveBeenCalledWith("/openmrs/ws/rest/v1/session", {
+    openmrsFetch('/ws/rest/v1/session');
+    expect(window.fetch).toHaveBeenCalledWith('/openmrs/ws/rest/v1/session', {
       headers: {
-        Accept: "application/json",
-        "Disable-WWW-Authenticate": "true",
+        Accept: 'application/json',
+        'Disable-WWW-Authenticate': 'true',
       },
     });
   });
@@ -65,34 +60,34 @@ describe("openmrsFetch", () => {
   it(`calls window.fetch correctly for requests that have a request body`, () => {
     // @ts-ignore
     window.fetch.mockReturnValue(new Promise(() => {}));
-    const requestBody = { some: "json" };
-    openmrsFetch("/ws/rest/v1/session", {
-      method: "POST",
+    const requestBody = { some: 'json' };
+    openmrsFetch('/ws/rest/v1/session', {
+      method: 'POST',
       body: requestBody,
     });
-    expect(window.fetch).toHaveBeenCalledWith("/openmrs/ws/rest/v1/session", {
+    expect(window.fetch).toHaveBeenCalledWith('/openmrs/ws/rest/v1/session', {
       headers: {
-        Accept: "application/json",
-        "Disable-WWW-Authenticate": "true",
+        Accept: 'application/json',
+        'Disable-WWW-Authenticate': 'true',
       },
       body: JSON.stringify(requestBody),
-      method: "POST",
+      method: 'POST',
     });
   });
 
   it(`allows you to specify your own Accept request header`, () => {
     // @ts-ignore
     window.fetch.mockReturnValue(new Promise(() => {}));
-    const requestBody = { some: "json" };
-    openmrsFetch("/ws/rest/v1/session", {
+    const requestBody = { some: 'json' };
+    openmrsFetch('/ws/rest/v1/session', {
       headers: {
-        Accept: "application/xml",
+        Accept: 'application/xml',
       },
     });
-    expect(window.fetch).toHaveBeenCalledWith("/openmrs/ws/rest/v1/session", {
+    expect(window.fetch).toHaveBeenCalledWith('/openmrs/ws/rest/v1/session', {
       headers: {
-        Accept: "application/xml",
-        "Disable-WWW-Authenticate": "true",
+        Accept: 'application/xml',
+        'Disable-WWW-Authenticate': 'true',
       },
     });
   });
@@ -100,15 +95,15 @@ describe("openmrsFetch", () => {
   it(`allows you to specify no Accept request header to be sent`, () => {
     // @ts-ignore
     window.fetch.mockReturnValue(new Promise(() => {}));
-    openmrsFetch("/ws/rest/v1/session", {
+    openmrsFetch('/ws/rest/v1/session', {
       headers: {
         // specifically null on purpose
         Accept: null,
       },
     });
-    expect(window.fetch).toHaveBeenCalledWith("/openmrs/ws/rest/v1/session", {
+    expect(window.fetch).toHaveBeenCalledWith('/openmrs/ws/rest/v1/session', {
       headers: {
-        "Disable-WWW-Authenticate": "true",
+        'Disable-WWW-Authenticate': 'true',
       },
     });
   });
@@ -122,12 +117,12 @@ describe("openmrsFetch", () => {
         clone: () => ({
           text: () => Promise.resolve('{ "value": "hi" }'),
         }),
-      })
+      }),
     );
 
-    return openmrsFetch("/ws/rest/v1/session").then((response) => {
+    return openmrsFetch('/ws/rest/v1/session').then((response) => {
       expect(response.status).toBe(200);
-      expect(response.data).toEqual({ value: "hi" });
+      expect(response.data).toEqual({ value: 'hi' });
     });
   });
 
@@ -138,10 +133,10 @@ describe("openmrsFetch", () => {
         ok: true,
         status: 204,
         json: () => Promise.reject(Error("No json for HTTP 204's!!")),
-      })
+      }),
     );
 
-    return openmrsFetch("/ws/rest/v1/session").then((response) => {
+    return openmrsFetch('/ws/rest/v1/session').then((response) => {
       expect(response.status).toBe(204);
       expect(response.data).toEqual(null);
     });
@@ -153,28 +148,26 @@ describe("openmrsFetch", () => {
       Promise.resolve({
         ok: false,
         status: 500,
-        statusText: "Internal Server Error",
+        statusText: 'Internal Server Error',
         clone: () => ({
           text: () =>
             Promise.resolve(
               JSON.stringify({
-                error: "The server is dead",
-              })
+                error: 'The server is dead',
+              }),
             ),
         }),
-      })
+      }),
     );
 
-    return openmrsFetch("/ws/rest/v1/session")
+    return openmrsFetch('/ws/rest/v1/session')
       .then((data) => {
         fail("Promise shouldn't resolve when server responds with 500");
       })
       .catch((err) => {
-        expect(err.message).toMatch(
-          /Server responded with 500 \(Internal Server Error\)/
-        );
+        expect(err.message).toMatch(/Server responded with 500 \(Internal Server Error\)/);
         expect(err.message).toMatch(/\/ws\/rest\/v1\/session/);
-        expect(err.responseBody).toEqual({ error: "The server is dead" });
+        expect(err.responseBody).toEqual({ error: 'The server is dead' });
         expect(err.response.status).toBe(500);
       });
   });
@@ -185,23 +178,21 @@ describe("openmrsFetch", () => {
       Promise.resolve({
         ok: false,
         status: 400,
-        statusText: "You goofed up",
+        statusText: 'You goofed up',
         clone: () => ({
-          text: () => Promise.resolve("a string response body"),
+          text: () => Promise.resolve('a string response body'),
         }),
-      })
+      }),
     );
 
-    return openmrsFetch("/ws/rest/v1/session")
+    return openmrsFetch('/ws/rest/v1/session')
       .then((data) => {
         fail("Promise shouldn't resolve when server responds with 400");
       })
       .catch((err) => {
-        expect(err.message).toMatch(
-          /Server responded with 400 \(You goofed up\)/
-        );
+        expect(err.message).toMatch(/Server responded with 400 \(You goofed up\)/);
         expect(err.message).toMatch(/\/ws\/rest\/v1\/session/);
-        expect(err.responseBody).toEqual("a string response body");
+        expect(err.responseBody).toEqual('a string response body');
         expect(err.response.status).toBe(400);
       });
   });
@@ -210,7 +201,7 @@ describe("openmrsFetch", () => {
     (mockGetConfig as any).mockResolvedValueOnce({
       redirectAuthFailure: {
         enabled: true,
-        url: "/openmrs/spa/login",
+        url: '/openmrs/spa/login',
         errors: [401],
         resolvePromise: true,
       },
@@ -221,24 +212,24 @@ describe("openmrsFetch", () => {
       Promise.resolve({
         ok: false,
         status: 401,
-        statusText: "You are not authorized",
-        text: () => Promise.resolve("a string response body"),
-      })
+        statusText: 'You are not authorized',
+        text: () => Promise.resolve('a string response body'),
+      }),
     );
 
-    return openmrsFetch("/ws/rest/v1/session").then((data) => {
+    return openmrsFetch('/ws/rest/v1/session').then((data) => {
       //@ts-ignore
       expect(mockNavigate.mock.calls[0][0]).toStrictEqual({
-        to: "/openmrs/spa/login",
+        to: '/openmrs/spa/login',
       });
     });
   });
 });
 
-describe("openmrsObservableFetch", () => {
+describe('openmrsObservableFetch', () => {
   beforeEach(() => {
     // @ts-ignore
-    window.openmrsBase = "/openmrs";
+    window.openmrsBase = '/openmrs';
     window.fetch = jest.fn();
   });
 
@@ -251,40 +242,34 @@ describe("openmrsObservableFetch", () => {
         clone: () => ({
           text: () => Promise.resolve('{"value": "hi"}'),
         }),
-      })
+      }),
     );
 
-    const observable = openmrsObservableFetch("/ws/rest/v1/session");
+    const observable = openmrsObservableFetch('/ws/rest/v1/session');
     expect(isObservable(observable)).toBe(true);
 
     observable.subscribe(
       (response) => {
-        expect(response.data).toEqual({ value: "hi" });
+        expect(response.data).toEqual({ value: 'hi' });
         done();
       },
       (err) => {
         done.fail(err);
-      }
+      },
     );
 
     expect(window.fetch).toHaveBeenCalled();
     // @ts-ignore
-    expect(window.fetch.mock.calls[0][0]).toEqual(
-      "/openmrs/ws/rest/v1/session"
-    );
+    expect(window.fetch.mock.calls[0][0]).toEqual('/openmrs/ws/rest/v1/session');
     // @ts-ignore
-    expect(window.fetch.mock.calls[0][1].headers.Accept).toEqual(
-      "application/json"
-    );
+    expect(window.fetch.mock.calls[0][1].headers.Accept).toEqual('application/json');
   });
 
   it(`aborts the fetch request when subscription is unsubscribed`, () => {
     // @ts-ignore
     window.fetch.mockReturnValue(new Promise(() => {}));
 
-    const subscription = openmrsObservableFetch(
-      "/ws/rest/v1/session"
-    ).subscribe();
+    const subscription = openmrsObservableFetch('/ws/rest/v1/session').subscribe();
     // @ts-ignore
     const abortSignal: AbortSignal = window.fetch.mock.calls[0][1].signal;
     expect(abortSignal.aborted).toBe(false);

package/src/openmrs-fetch.ts

@@ -1,12 +1,12 @@
 /** @module @category API */
-import { Observable } from "rxjs";
-import isPlainObject from "lodash-es/isPlainObject";
-import { getConfig, navigate } from "@openmrs/esm-config";
-import { FetchResponse } from "./types";
+import { Observable } from 'rxjs';
+import isPlainObject from 'lodash-es/isPlainObject';
+import { getConfig, navigate } from '@openmrs/esm-config';
+import { FetchResponse } from './types';
 
-export const restBaseUrl = "/ws/rest/v1/";
+export const restBaseUrl = '/ws/rest/v1/';
 
-export const fhirBaseUrl = "/ws/fhir2/R4";
+export const fhirBaseUrl = '/ws/fhir2/R4';
 
 export const sessionEndpoint = `${restBaseUrl}session`;
 
@@ -21,11 +21,11 @@ export const sessionEndpoint = `${restBaseUrl}session`;
  * ```
  */
 export function makeUrl(path: string) {
-  if (path && path.startsWith("http")) {
+  if (path && path.startsWith('http')) {
     return path;
-  } else if (path[0] !== "/") {
+  } else if (path[0] !== '/') {
     // ensure path starts with /
-    path = "/" + path;
+    path = '/' + path;
   }
 
   return window.openmrsBase + path;
@@ -80,26 +80,19 @@ export function makeUrl(path: string) {
  *
  * @category API
  */
-export function openmrsFetch<T = any>(
-  path: string,
-  fetchInit: FetchConfig = {}
-): Promise<FetchResponse<T>> {
-  if (typeof path !== "string") {
-    throw Error(
-      "The first argument to @openmrs/api's openmrsFetch function must be a url string"
-    );
+export function openmrsFetch<T = any>(path: string, fetchInit: FetchConfig = {}): Promise<FetchResponse<T>> {
+  if (typeof path !== 'string') {
+    throw Error("The first argument to @openmrs/api's openmrsFetch function must be a url string");
   }
 
-  if (typeof fetchInit !== "object") {
-    throw Error(
-      "The second argument to @openmrs/api's openmrsFetch function must be a plain object."
-    );
+  if (typeof fetchInit !== 'object') {
+    throw Error("The second argument to @openmrs/api's openmrsFetch function must be a plain object.");
   }
 
   // @ts-ignore
   if (!window.openmrsBase) {
     throw Error(
-      "@openmrs/api is running in a browser that doesn't have window.openmrsBase, which is provided by openmrs-module-spa's HTML file."
+      "@openmrs/api is running in a browser that doesn't have window.openmrsBase, which is provided by openmrs-module-spa's HTML file.",
     );
   }
 
@@ -124,8 +117,8 @@ export function openmrsFetch<T = any>(
    * If a different Accept header is preferred, pass it into the fetchInit.
    * If no Accept header is desired, pass it in explicitly as null.
    */
-  if (typeof fetchInit.headers.Accept === "undefined") {
-    fetchInit.headers.Accept = "application/json";
+  if (typeof fetchInit.headers.Accept === 'undefined') {
+    fetchInit.headers.Accept = 'application/json';
   }
 
   if (fetchInit.headers.Accept === null) {
@@ -136,17 +129,14 @@ export function openmrsFetch<T = any>(
    * header. Returning that header is useful when using the API, but
    * not from a UI.
    */
-  if (
-    path.startsWith(restBaseUrl) &&
-    typeof fetchInit.headers["Disable-WWW-Authenticate"] === "undefined"
-  ) {
-    fetchInit.headers["Disable-WWW-Authenticate"] = "true";
+  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");
+    if (!urlUrl.searchParams.has('_summary')) {
+      urlUrl.searchParams.set('_summary', 'data');
       url = urlUrl.toString();
     }
   }
@@ -194,12 +184,11 @@ export function openmrsFetch<T = any>(
       /*
        *Redirect to given url when redirect on auth failure is enabled
        */
-      const { redirectAuthFailure } = await getConfig("@openmrs/esm-api");
+      const { redirectAuthFailure } = await getConfig('@openmrs/esm-api');
 
       if (
         (url === makeUrl(sessionEndpoint) && response.status === 403) ||
-        (redirectAuthFailure.enabled &&
-          redirectAuthFailure.errors.includes(response.status))
+        (redirectAuthFailure.enabled && redirectAuthFailure.errors.includes(response.status))
       ) {
         navigate({ to: redirectAuthFailure.url });
 
@@ -227,24 +216,14 @@ export function openmrsFetch<T = any>(
               /* Make the fetch promise go into "rejected" status, with the best
                * possible stacktrace and error message.
                */
-              throw new OpenmrsFetchError(
-                url,
-                response,
-                responseBody,
-                requestStacktrace
-              );
+              throw new OpenmrsFetchError(url, response, responseBody, requestStacktrace);
             },
             (err) => {
               /* We weren't able to download a response body for this error.
                * Time to just give the best possible stacktrace and error message.
                */
-              throw new OpenmrsFetchError(
-                url,
-                response,
-                null,
-                requestStacktrace
-              );
-            }
+              throw new OpenmrsFetchError(url, response, null, requestStacktrace);
+            },
           );
       }
     }
@@ -280,14 +259,9 @@ export function openmrsFetch<T = any>(
  *
  * @category API
  */
-export function openmrsObservableFetch<T>(
-  url: string,
-  fetchInit: FetchConfig = {}
-) {
-  if (typeof fetchInit !== "object") {
-    throw Error(
-      "The second argument to openmrsObservableFetch must be either omitted or an object"
-    );
+export function openmrsObservableFetch<T>(url: string, fetchInit: FetchConfig = {}) {
+  if (typeof fetchInit !== 'object') {
+    throw Error('The second argument to openmrsObservableFetch must be either omitted or an object');
   }
 
   const abortController = new AbortController();
@@ -306,7 +280,7 @@ export function openmrsObservableFetch<T>(
       (err) => {
         hasResponse = true;
         observer.error(err);
-      }
+      },
     );
 
     return () => {
@@ -318,12 +292,7 @@ export function openmrsObservableFetch<T>(
 }
 
 export class OpenmrsFetchError extends Error {
-  constructor(
-    url: string,
-    response: Response,
-    responseBody: ResponseBody | null,
-    requestStacktrace: Error
-  ) {
+  constructor(url: string, response: Response, responseBody: ResponseBody | null, requestStacktrace: Error) {
     super();
     this.message = `Server responded with ${response.status} (${response.statusText}) for url ${url}. Check err.responseBody or network tab in dev tools for more info`;
     requestStacktrace.message = this.message;
@@ -335,7 +304,7 @@ export class OpenmrsFetchError extends Error {
   responseBody: string | FetchResponseJson | null;
 }
 
-export interface FetchConfig extends Omit<RequestInit, "body" | "headers"> {
+export interface FetchConfig extends Omit<RequestInit, 'body' | 'headers'> {
   headers?: FetchHeaders;
   body?: FetchBody | string;
 }

package/src/public.ts

@@ -1,10 +1,10 @@
-export * from "./types";
-export * from "./openmrs-fetch";
+export * from './types';
+export * from './openmrs-fetch';
 
-export * from "./shared-api-objects/current-user";
-export * from "./shared-api-objects/current-patient";
-export * from "./shared-api-objects/visit-utils";
-export * from "./shared-api-objects/visit-type";
-export * from "./shared-api-objects/location";
+export * from './shared-api-objects/current-user';
+export * from './shared-api-objects/current-patient';
+export * from './shared-api-objects/visit-utils';
+export * from './shared-api-objects/visit-type';
+export * from './shared-api-objects/location';
 
-export * from "./openmrs-backend-dependencies";
+export * from './openmrs-backend-dependencies';

package/src/setup.ts

@@ -1,21 +1,20 @@
-import { defineConfigSchema, Type, validators } from "@openmrs/esm-config";
-import { refetchCurrentUser } from "./shared-api-objects/current-user";
+import { defineConfigSchema, Type, validators } from '@openmrs/esm-config';
+import { refetchCurrentUser } from './shared-api-objects/current-user';
 
 /**
  * @internal
  */
 export function setupApiModule() {
-  defineConfigSchema("@openmrs/esm-api", {
+  defineConfigSchema('@openmrs/esm-api', {
     redirectAuthFailure: {
       enabled: {
         _type: Type.Boolean,
         _default: true,
-        _description:
-          "Whether to redirect logged-out users to `redirectAuthFailure.url`",
+        _description: 'Whether to redirect logged-out users to `redirectAuthFailure.url`',
       },
       url: {
         _type: Type.String,
-        _default: "${openmrsSpaBase}/login",
+        _default: '${openmrsSpaBase}/login',
         _validators: [validators.isUrl],
       },
       errors: {
@@ -25,7 +24,7 @@ export function setupApiModule() {
           _type: Type.Number,
           _validators: [validators.inRange(100, 600)],
         },
-        _description: "The HTTP error codes for which users will be redirected",
+        _description: 'The HTTP error codes for which users will be redirected',
       },
       resolvePromise: {
         _type: Type.Boolean,