@openmrs/esm-react-utils 5.1.1-pre.915 → 5.1.1-pre.918

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-react-utils",
-  "version": "5.1.1-pre.915",
+  "version": "5.1.1-pre.918",
   "license": "MPL-2.0",
   "description": "React utilities for OpenMRS.",
   "browser": "dist/openmrs-esm-react-utils.js",
@@ -56,12 +56,12 @@
     "react-i18next": "11.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "^5.1.1-pre.915",
-    "@openmrs/esm-config": "^5.1.1-pre.915",
-    "@openmrs/esm-error-handling": "^5.1.1-pre.915",
-    "@openmrs/esm-extensions": "^5.1.1-pre.915",
-    "@openmrs/esm-feature-flags": "^5.1.1-pre.915",
-    "@openmrs/esm-globals": "^5.1.1-pre.915",
+    "@openmrs/esm-api": "^5.1.1-pre.918",
+    "@openmrs/esm-config": "^5.1.1-pre.918",
+    "@openmrs/esm-error-handling": "^5.1.1-pre.918",
+    "@openmrs/esm-extensions": "^5.1.1-pre.918",
+    "@openmrs/esm-feature-flags": "^5.1.1-pre.918",
+    "@openmrs/esm-globals": "^5.1.1-pre.918",
     "dayjs": "^1.10.8",
     "i18next": "^19.6.0",
     "react": "^18.1.0",
@@ -70,5 +70,5 @@
     "rxjs": "^6.5.3",
     "webpack": "^5.88.0"
   },
-  "gitHead": "6c2671a1ab45e4543acda991cdc7299c2323dd95"
+  "gitHead": "7172c914a4700a8d2984754ef6f67600b6bad1ae"
 }

package/src/useVisit.ts

@@ -17,17 +17,30 @@ export interface VisitReturnType {
   error: Error;
   mutate: () => void;
   isValidating: boolean;
+  activeVisit: Visit | null;
   currentVisit: Visit | null;
-  isRetrospective: boolean;
+  currentVisitIsRetrospective: boolean;
   isLoading: boolean;
 }
 
 /**
- * This React hook returns a visit object. If the `patientUuid` is provided
- * as a parameter, then the currentVisit, error and mutate function
- * for that patient visit is returned.
+ * This React hook returns visit information if the patient UUID is not null. There are
+ * potentially two relevant visits at a time: "active" and "current".
+ *
+ * The active visit is the most recent visit without an end date. The presence of an active
+ * visit generally means that the patient is in the facility.
+ *
+ * The current visit is the active visit, unless a retrospective visit has been selected.
+ * If there is no active visit and no selected retrospective visit, then there is no
+ * current visit. If there is no active visit but there is a retrospective visit, then
+ * the retrospective visit is the current visit. `currentVisitIsRetrospective` tells you
+ * whether the current visit is a retrospective visit.
+ *
+ * The active visit and current visit require two separate API calls. `error` contains
+ * the error from either one, if there is an error. `isValidating` is true if either
+ * API call is in progress. `mutate` refreshes the data from both API calls.
+ *
  * @param patientUuid Unique patient identifier `string`
- * @returns Object {`error` `isValidating`, `currentVisit`, `mutate`}
  */
 export function useVisit(patientUuid: string): VisitReturnType {
   const { patientUuid: visitStorePatientUuid, manuallySetVisitUuid } = useStore(
@@ -38,31 +51,60 @@ export function useVisit(patientUuid: string): VisitReturnType {
     patientUuid && visitStorePatientUuid == patientUuid
       ? manuallySetVisitUuid
       : null;
-  const visitGetUrlSuffix = retrospectiveVisitUuid
-    ? `/${retrospectiveVisitUuid}`
-    : `?patient=${patientUuid}&v=${defaultVisitCustomRepresentation}&includeInactive=false`;
-  const { data, error, mutate, isValidating } = useSWR<{
+  const activeVisitUrlSuffix = `?patient=${patientUuid}&v=${defaultVisitCustomRepresentation}&includeInactive=false`;
+  const retrospectiveVisitUrlSuffix = `/${retrospectiveVisitUuid}`;
+
+  const {
+    data: activeData,
+    error: activeError,
+    mutate: activeMutate,
+    isValidating: activeIsValidating,
+  } = useSWR<{
     data: Visit | { results: Array<Visit> };
   }>(
-    patientUuid ? `/ws/rest/v1/visit${visitGetUrlSuffix}` : null,
+    patientUuid ? `/ws/rest/v1/visit${activeVisitUrlSuffix}` : null,
     openmrsFetch
   );
 
-  const currentVisit = useMemo(
+  const {
+    data: retroData,
+    error: retroError,
+    mutate: retroMutate,
+    isValidating: retroIsValidating,
+  } = useSWR<{
+    data: Visit | { results: Array<Visit> };
+  }>(
+    patientUuid && retrospectiveVisitUuid
+      ? `/ws/rest/v1/visit${retrospectiveVisitUrlSuffix}`
+      : null,
+    openmrsFetch
+  );
+
+  const activeVisit = useMemo(
     () =>
-      retrospectiveVisitUuid
-        ? data?.data
-        : data?.data.results.find((visit) => visit.stopDatetime === null) ??
-          null,
-    [data]
+      activeData?.data.results.find((visit) => visit.stopDatetime === null) ??
+      null,
+    [activeData]
+  );
+
+  const currentVisit = useMemo(
+    () => (retrospectiveVisitUuid ? retroData?.data : activeVisit ?? null),
+    [retroData, activeVisit, retrospectiveVisitUuid]
   );
 
   return {
-    error,
-    mutate,
-    isValidating,
+    error: activeError || retroError,
+    mutate: () => {
+      activeMutate();
+      retroMutate();
+    },
+    isValidating: activeIsValidating || retroIsValidating,
+    activeVisit,
     currentVisit,
-    isRetrospective: Boolean(retrospectiveVisitUuid),
-    isLoading: !data && !error,
+    currentVisitIsRetrospective: Boolean(retrospectiveVisitUuid),
+    isLoading: Boolean(
+      (!activeData || (retrospectiveVisitUuid && !retroData)) &&
+        (!activeError || !retroError)
+    ),
   };
 }