@openmrs/esm-api 3.2.1-pre.972 → 3.3.1-pre.1173

package/jest.config.js

@@ -1,6 +1,6 @@
 module.exports = {
   transform: {
-    "^.+\\.tsx?$": "babel-jest",
+    "^.+\\.tsx?$": ["@swc/jest"],
   },
   moduleNameMapper: {
     "lodash-es": "lodash",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-api",
-  "version": "3.2.1-pre.972",
+  "version": "3.3.1-pre.1173",
   "license": "MPL-2.0",
   "description": "The javascript module for interacting with the OpenMRS API",
   "browser": "dist/openmrs-esm-api.js",
@@ -44,11 +44,11 @@
     "@openmrs/esm-error-handling": "3.x"
   },
   "devDependencies": {
-    "@openmrs/esm-config": "^3.2.1-pre.972",
-    "@openmrs/esm-error-handling": "^3.2.1-pre.972",
-    "@openmrs/esm-state": "^3.2.1-pre.972",
+    "@openmrs/esm-config": "^3.3.1-pre.1173",
+    "@openmrs/esm-error-handling": "^3.3.1-pre.1173",
+    "@openmrs/esm-state": "^3.3.1-pre.1173",
     "@types/fhir": "0.0.31",
     "rxjs": "^6.5.3"
   },
-  "gitHead": "40fa43724f730fc56bbde679fe128a9315ef931f"
+  "gitHead": "957c0c36b8f754808127269f6e50b90992a60559"
 }

package/src/fhir.ts

@@ -1,7 +1,4 @@
-/**
- * @module
- * @category API
- */
+/** @module @category API */
 import { openmrsFetch, FetchHeaders, OpenmrsFetchError } from "./openmrs-fetch";
 import type { FhirClient } from "./types/fhir";
 

package/src/openmrs-fetch.ts

@@ -1,8 +1,4 @@
-/**
- * @module
- * @category API
- */
-
+/** @module @category API */
 import { Observable } from "rxjs";
 import isPlainObject from "lodash-es/isPlainObject";
 import { getConfig, navigate } from "@openmrs/esm-config";
@@ -10,6 +6,16 @@ import { FetchResponse } from "./types";
 
 export const sessionEndpoint = "/ws/rest/v1/session";
 
+/**
+ * Append `path` to the OpenMRS SPA base.
+ *
+ * #### Example
+ *
+ * ```ts
+ * makeUrl('/foo/bar');
+ * // => '/openmrs/foo/bar'
+ * ```
+ */
 export function makeUrl(path: string) {
   return window.openmrsBase + path;
 }

package/src/public.ts

@@ -0,0 +1,11 @@
+export * from "./types";
+export * from "./openmrs-fetch";
+export * from "./fhir";
+
+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";

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

@@ -1,8 +1,4 @@
-/**
- * @module
- * @category API
- */
-
+/** @module @category API */
 import { fhir } from "../fhir";
 import { FetchResponse } from "../types";
 

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

@@ -1,22 +1,19 @@
-/**
- * @module
- * @category API
- */
-
+/** @module @category API */
 import { Observable, ReplaySubject } from "rxjs";
 import { filter, map, tap, mergeAll } from "rxjs/operators";
 import { openmrsFetch, sessionEndpoint } from "../openmrs-fetch";
-import {
-  LoggedInUserData,
+import type {
   LoggedInUser,
   CurrentUserWithResponseOption,
-  UnauthenticatedUser,
   CurrentUserWithoutResponseOption,
   CurrentUserOptions,
   SessionLocation,
+  Privilege,
+  Role,
+  Session,
 } from "../types";
 
-const userSubject = new ReplaySubject<Promise<LoggedInUserData>>(1);
+const userSubject = new ReplaySubject<Promise<Session>>(1);
 let lastFetchTimeMillis = 0;
 
 /**
@@ -60,13 +57,13 @@ let lastFetchTimeMillis = 0;
 function getCurrentUser(): Observable<LoggedInUser>;
 function getCurrentUser(
   opts: CurrentUserWithResponseOption
-): Observable<UnauthenticatedUser>;
+): Observable<Session>;
 function getCurrentUser(
   opts: CurrentUserWithoutResponseOption
 ): Observable<LoggedInUser>;
 function getCurrentUser(
   opts: CurrentUserOptions = { includeAuthStatus: false }
-): Observable<LoggedInUser | UnauthenticatedUser> {
+): Observable<LoggedInUser | Session> {
   if (lastFetchTimeMillis < Date.now() - 1000 * 60) {
     refetchCurrentUser();
   }
@@ -76,31 +73,32 @@ function getCurrentUser(
     tap(setUserLanguage),
     map((r) => (opts.includeAuthStatus ? r : r.user)),
     filter(Boolean)
-  ) as Observable<LoggedInUser | UnauthenticatedUser>;
+  ) as Observable<LoggedInUser | Session>;
 }
 
-function setUserLanguage(data: LoggedInUserData) {
-  if (data?.user?.userProperties?.defaultLocale) {
-    const locale = data.user.userProperties.defaultLocale;
-    const htmlLang = document.documentElement.getAttribute("lang");
+export { getCurrentUser };
+
+function setUserLanguage(data: Session) {
+  const locale = data?.user?.userProperties?.defaultLocale ?? data.locale;
+  const htmlLang = document.documentElement.getAttribute("lang");
 
-    if (locale !== htmlLang) {
-      document.documentElement.setAttribute("lang", locale);
-    }
+  if (locale !== htmlLang) {
+    document.documentElement.setAttribute("lang", locale);
   }
 }
 
-function userHasPrivilege(requiredPrivilege: string, user: LoggedInUser) {
+function userHasPrivilege(
+  requiredPrivilege: string,
+  user: { privileges: Array<Privilege> }
+) {
   return user.privileges.find((p) => requiredPrivilege === p.display);
 }
 
-function isSuperUser(user: LoggedInUser) {
+function isSuperUser(user: { roles: Array<Role> }) {
   const superUserRole = "System Developer";
   return user.roles.find((role) => role.display === superUserRole);
 }
 
-export { getCurrentUser };
-
 /**
  * The `refetchCurrentUser` function causes a network request to redownload
  * the user. All subscribers to the current user will be notified of the
@@ -128,7 +126,10 @@ export function refetchCurrentUser() {
   );
 }
 
-export function userHasAccess(requiredPrivilege: string, user: LoggedInUser) {
+export function userHasAccess(
+  requiredPrivilege: string,
+  user: { privileges: Array<Privilege>; roles: Array<Role> }
+) {
   return userHasPrivilege(requiredPrivilege, user) || isSuperUser(user);
 }
 
@@ -144,8 +145,8 @@ export function getLoggedInUser() {
 export function getSessionLocation() {
   return new Promise<SessionLocation | undefined>((res, rej) => {
     const sub = getCurrentUser({ includeAuthStatus: true }).subscribe(
-      (user) => {
-        res(user.sessionLocation);
+      (session) => {
+        res(session.sessionLocation);
         sub.unsubscribe();
       },
       rej
@@ -165,5 +166,6 @@ export async function setSessionLocation(
     },
     signal: abortController.signal,
   });
+
   refetchCurrentUser();
 }

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

@@ -1,8 +1,4 @@
-/**
- * @module
- * @category API
- */
-
+/** @module @category API */
 import { Observable } from "rxjs";
 import { map, take } from "rxjs/operators";
 import { openmrsObservableFetch } from "../openmrs-fetch";

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

@@ -1,8 +1,4 @@
-/**
- * @module
- * @category API
- */
-
+/** @module @category API */
 import { Observable } from "rxjs";
 import { map, take } from "rxjs/operators";
 import { openmrsObservableFetch } from "../openmrs-fetch";

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

@@ -1,8 +1,4 @@
-/**
- * @module
- * @category API
- */
-
+/** @module @category API */
 import { Observable, BehaviorSubject } from "rxjs";
 import { take, map } from "rxjs/operators";
 import { openmrsObservableFetch } from "../openmrs-fetch";
@@ -13,19 +9,20 @@ import {
   Visit,
 } from "../types";
 
+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,value),location:(uuid,name,display),startDatetime," +
+  "stopDatetime)";
+
 export function getVisitsForPatient(
   patientUuid: string,
   abortController: AbortController,
   v?: string
 ): Observable<FetchResponse<{ results: Array<Visit> }>> {
-  const custom =
-    v ||
-    "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,value),location:(uuid,name,display),startDatetime," +
-      "stopDatetime)";
+  const custom = v ?? defaultVisitCustomRepresentation;
 
   return openmrsObservableFetch(
     `/ws/rest/v1/visit?patient=${patientUuid}&v=${custom}`,

package/src/types/fetch.ts

@@ -1,13 +1,9 @@
-import { LoggedInUser, UnauthenticatedUser } from "./user-resource";
+import { Session } from "./user-resource";
 
 export interface FetchResponse<T = any> extends Response {
   data: T;
 }
 
-export type LoggedInUserData = UnauthenticatedUser & {
-  user?: LoggedInUser;
-};
-
 export interface LoggedInUserFetchResponse extends FetchResponse {
-  data: LoggedInUserData;
+  data: Session;
 }

package/src/types/openmrs-resource.ts

@@ -3,25 +3,3 @@ export interface OpenmrsResource {
   display?: string;
   [anythingElse: string]: any;
 }
-
-export interface SessionUser {
-  allowedLocales: Array<string>;
-  authenticated: boolean;
-  locale: string;
-  sessionId: string;
-  user: User;
-  currentProvider: { uuid: string; identifier: string };
-  sessionLocation: any | null;
-}
-
-export interface User {
-  display: string;
-  link: Array<string>;
-  person: any;
-  priviliges: any;
-  resourceVersion: any;
-  roles: Array<any>;
-  userProperties: any;
-  username: string;
-  uuid: string;
-}

package/src/types/user-resource.ts

@@ -10,12 +10,22 @@ export interface CurrentUserWithoutResponseOption extends CurrentUserOptions {
   includeAuthStatus: false;
 }
 
+export interface Session {
+  allowedLocales?: Array<string>;
+  authenticated: boolean;
+  locale?: string;
+  sessionId: string;
+  user?: LoggedInUser;
+  currentProvider?: { uuid: string; identifier: string };
+  sessionLocation?: SessionLocation;
+}
+
 export interface LoggedInUser {
   uuid: string;
   display: string;
   username: string;
   systemId: string;
-  userProperties: any;
+  userProperties: { [key: string]: any } | null;
   person: Person;
   privileges: Array<Privilege>;
   roles: Array<Role>;
@@ -25,13 +35,6 @@ export interface LoggedInUser {
   [anythingElse: string]: any;
 }
 
-export interface UnauthenticatedUser {
-  sessionId: string;
-  authenticated: boolean;
-  user?: LoggedInUser;
-  sessionLocation?: SessionLocation;
-}
-
 export interface SessionLocation {
   uuid: string;
   display: string;
@@ -47,7 +50,7 @@ export interface Person {
 export interface Privilege {
   uuid: string;
   display: string;
-  links: Array<any>;
+  links?: Array<any>;
 }
 
 export interface Role {

package/webpack.config.js

@@ -19,7 +19,7 @@ module.exports = (env) => ({
       {
         test: /\.m?(js|ts|tsx)$/,
         exclude: /(node_modules|bower_components)/,
-        use: "babel-loader",
+        use: "swc-loader",
       },
     ],
   },

package/.babelrc

@@ -1,7 +0,0 @@
-{
-  "presets": [
-    "@babel/preset-env",
-    "@babel/preset-typescript",
-    "@babel/preset-react"
-  ]
-}

package/dist/openmrs-esm-api.js.LICENSE.txt

@@ -1,14 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */