@openmrs/esm-api 3.2.0 → 3.2.1-pre.1010

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-api",
-  "version": "3.2.0",
+  "version": "3.2.1-pre.1010",
   "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.0",
-    "@openmrs/esm-error-handling": "^3.2.0",
-    "@openmrs/esm-state": "^3.2.0",
+    "@openmrs/esm-config": "^3.2.1-pre.1010",
+    "@openmrs/esm-error-handling": "^3.2.1-pre.1010",
+    "@openmrs/esm-state": "^3.2.1-pre.1010",
     "@types/fhir": "0.0.31",
     "rxjs": "^6.5.3"
   },
-  "gitHead": "9c4a04089e29ff99321d6fef72294f402deb0f7b"
+  "gitHead": "2d2457c75087b97cd8959d6a4dc854e3f6b8f6f5"
 }

package/src/fhir.ts

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

package/src/index.ts

@@ -10,4 +10,3 @@ export * from "./shared-api-objects/visit-type";
 export * from "./shared-api-objects/location";
 
 export * from "./openmrs-backend-dependencies";
-export * from "./workspace/workspace.resource";

package/src/openmrs-fetch.ts

@@ -1,3 +1,8 @@
+/**
+ * @module
+ * @category API
+ */
+
 import { Observable } from "rxjs";
 import isPlainObject from "lodash-es/isPlainObject";
 import { getConfig, navigate } from "@openmrs/esm-config";

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

@@ -1,3 +1,8 @@
+/**
+ * @module
+ * @category API
+ */
+
 import { fhir } from "../fhir";
 import { FetchResponse } from "../types";
 
@@ -17,9 +22,6 @@ export interface OnlyThePatient extends CurrentPatientOptions {
 
 export type PatientUuid = string | null;
 
-/**
- * @category API Object
- */
 export function fetchCurrentPatient(
   patientUuid: PatientUuid,
   contentOverrides?: Partial<Parameters<typeof fhir.read>[0]>

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

@@ -1,3 +1,8 @@
+/**
+ * @module
+ * @category API
+ */
+
 import { Observable, ReplaySubject } from "rxjs";
 import { filter, map, tap, mergeAll } from "rxjs/operators";
 import { openmrsFetch, sessionEndpoint } from "../openmrs-fetch";
@@ -51,8 +56,6 @@ let lastFetchTimeMillis = 0;
  * Otherwise your code will continue getting updates to the user object
  * even after the UI component is gone from the screen. This is a memory
  * leak and source of bugs.
- *
- * @category API Object
  */
 function getCurrentUser(): Observable<LoggedInUser>;
 function getCurrentUser(
@@ -110,8 +113,6 @@ export { getCurrentUser };
  * import { refetchCurrentUser } from '@openmrs/esm-api'
  * refetchCurrentUser()
  * ```
- *
- * @category API Object
  */
 export function refetchCurrentUser() {
   lastFetchTimeMillis = Date.now();

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

@@ -1,3 +1,8 @@
+/**
+ * @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,3 +1,8 @@
+/**
+ * @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,7 +1,11 @@
+/**
+ * @module
+ * @category API
+ */
+
 import { Observable, BehaviorSubject } from "rxjs";
 import { take, map } from "rxjs/operators";
 import { openmrsObservableFetch } from "../openmrs-fetch";
-import { newWorkspaceItem } from "../workspace/workspace.resource";
 import {
   FetchResponse,
   NewVisitPayload,
@@ -9,30 +13,20 @@ import {
   Visit,
 } from "../types";
 
-export function openVisitsNoteWorkspace(componentName: string, title: string) {
-  newWorkspaceItem({
-    component: componentName,
-    name: title,
-    props: {},
-    inProgress: false,
-    validations: (workspaceTabs: Array<any>) =>
-      workspaceTabs.findIndex((tab) => tab.component === componentName),
-  });
-}
+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/workspace/workspace.resource.tsx

@@ -1,30 +0,0 @@
-import { Subject, Observable } from "rxjs";
-
-const workspaceItem = new Subject<WorkspaceItem>();
-
-/**
- *
- * @param item
- * @category Workspace
- */
-export function newWorkspaceItem(item: WorkspaceItem) {
-  workspaceItem.next(item);
-}
-
-/**
- *
- * @returns
- * @category Workspace
- */
-export function getNewWorkspaceItem(): Observable<WorkspaceItem> {
-  return workspaceItem.asObservable();
-}
-
-export interface WorkspaceItem {
-  component: any;
-  name: string;
-  props: any;
-  validations?: Function;
-  inProgress: boolean;
-  componentClosed?: Function;
-}