@openmrs/esm-api 3.2.1-pre.1094 → 3.2.1-pre.1102

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-api",
-  "version": "3.2.1-pre.1094",
+  "version": "3.2.1-pre.1102",
   "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.1094",
-    "@openmrs/esm-error-handling": "^3.2.1-pre.1094",
-    "@openmrs/esm-state": "^3.2.1-pre.1094",
+    "@openmrs/esm-config": "^3.2.1-pre.1102",
+    "@openmrs/esm-error-handling": "^3.2.1-pre.1102",
+    "@openmrs/esm-state": "^3.2.1-pre.1102",
     "@types/fhir": "0.0.31",
     "rxjs": "^6.5.3"
   },
-  "gitHead": "098d850b2490bbfc115d844bd1b5ffabf876e98a"
+  "gitHead": "6780e8f11ac37b73336935de1f56ed5b82eb51c0"
 }

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,8 +1,4 @@
-/**
- * @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";

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";