@openmrs/esm-fast-data-entry-app 1.0.0-pre.59 → 1.0.0

package/src/context/FormWorkflowReducer.ts

@@ -1,14 +1,14 @@
-import { navigate } from "@openmrs/esm-framework";
-import { initialWorkflowState } from "./FormWorkflowContext";
+import { navigate } from '@openmrs/esm-framework';
+import { initialWorkflowState } from './FormWorkflowContext';
 
-export const fdeWorkflowStorageVersion = "1.0.12";
-export const fdeWorkflowStorageName = "openmrs:fastDataEntryWorkflowState";
+export const fdeWorkflowStorageVersion = '1.1.0';
+export const fdeWorkflowStorageName = 'openmrs:fastDataEntryWorkflowState';
 const persistData = (data) => {
-  localStorage.setItem(fdeWorkflowStorageName, JSON.stringify(data));
+  localStorage.setItem(fdeWorkflowStorageName + ':' + data.userUuid, JSON.stringify(data));
 };
 
 const initialFormState = {
-  workflowState: "NEW_PATIENT",
+  workflowState: 'NEW_PATIENT',
   activePatientUuid: null,
   activeEncounterUuid: null,
   patientUuids: [],
@@ -17,21 +17,18 @@ const initialFormState = {
 
 const reducer = (state, action) => {
   switch (action.type) {
-    case "INITIALIZE_WORKFLOW_STATE": {
-      const savedData = localStorage.getItem(fdeWorkflowStorageName);
+    case 'INITIALIZE_WORKFLOW_STATE': {
+      const savedData = localStorage.getItem(fdeWorkflowStorageName + ':' + action.userUuid);
       const savedDataObject = savedData ? JSON.parse(savedData) : {};
       let newState: { [key: string]: unknown } = {};
       const newPatient = action.newPatientUuid
         ? {
             activePatientUuid: action.newPatientUuid,
-            workflowState: "EDIT_FORM",
+            workflowState: 'EDIT_FORM',
           }
         : {};
 
-      if (
-        savedData &&
-        savedDataObject["_storageVersion"] === fdeWorkflowStorageVersion
-      ) {
+      if (savedData && savedDataObject['_storageVersion'] === fdeWorkflowStorageVersion) {
         // there is localStorage data and it is still valid
         newState = {
           ...savedDataObject,
@@ -44,21 +41,15 @@ const reducer = (state, action) => {
               ...savedDataObject.forms[action.activeFormUuid],
               // if we receive activePatientUuid from a query parameter use that one
               ...newPatient,
-              patientUuids:
-                savedDataObject.forms[action.activeFormUuid]?.patientUuids ||
-                initialFormState.patientUuids,
+              patientUuids: savedDataObject.forms[action.activeFormUuid]?.patientUuids || initialFormState.patientUuids,
             },
           },
         };
         if (
           action.newPatientUuid &&
-          !newState.forms[action.activeFormUuid].patientUuids.includes(
-            action.newPatientUuid
-          )
+          !newState.forms[action.activeFormUuid].patientUuids.includes(action.newPatientUuid)
         ) {
-          newState.forms[action.activeFormUuid].patientUuids.push(
-            action.newPatientUuid
-          );
+          newState.forms[action.activeFormUuid].patientUuids.push(action.newPatientUuid);
         }
       } else {
         // no localStorage data, or we should void it
@@ -69,32 +60,30 @@ const reducer = (state, action) => {
             [action.activeFormUuid]: initialFormState,
           },
           activeFormUuid: action.activeFormUuid,
+          userUuid: action.userUuid,
         };
       }
       persistData(newState);
       return { ...newState };
     }
-    case "ADD_PATIENT": {
+    case 'ADD_PATIENT': {
       const newState = {
         ...state,
         forms: {
           ...state.forms,
           [state.activeFormUuid]: {
             ...state.forms[state.activeFormUuid],
-            patientUuids: [
-              ...state.forms[state.activeFormUuid].patientUuids,
-              action.patientUuid,
-            ],
+            patientUuids: [...state.forms[state.activeFormUuid].patientUuids, action.patientUuid],
             activePatientUuid: action.patientUuid,
             activeEncounterUuid: null,
-            workflowState: "EDIT_FORM",
+            workflowState: 'EDIT_FORM',
           },
         },
       };
       persistData(newState);
       return newState;
     }
-    case "OPEN_PATIENT_SEARCH": {
+    case 'OPEN_PATIENT_SEARCH': {
       const newState = {
         ...state,
         forms: {
@@ -103,7 +92,7 @@ const reducer = (state, action) => {
             ...state.forms[state.activeFormUuid],
             activePatientUuid: null,
             activeEncounterUuid: null,
-            workflowState: "NEW_PATIENT",
+            workflowState: 'NEW_PATIENT',
           },
         },
       };
@@ -111,11 +100,8 @@ const reducer = (state, action) => {
       persistData(newState);
       return newState;
     }
-    case "SAVE_ENCOUNTER": {
-      if (
-        state.forms[state.activeFormUuid].workflowState ===
-        "SUBMIT_FOR_COMPLETE"
-      ) {
+    case 'SAVE_ENCOUNTER': {
+      if (state.forms[state.activeFormUuid].workflowState === 'SUBMIT_FOR_COMPLETE') {
         const { [state.activeFormUuid]: activeForm, ...formRest } = state.forms;
         const newState = {
           ...state,
@@ -124,7 +110,7 @@ const reducer = (state, action) => {
         };
         persistData(newState);
         // eslint-disable-next-line
-        navigate({ to: "${openmrsSpaBase}/forms" });
+        navigate({ to: '${openmrsSpaBase}/forms' });
         return newState;
       } else {
         const newState = {
@@ -135,18 +121,15 @@ const reducer = (state, action) => {
               ...state.forms[state.activeFormUuid],
               encounters: {
                 ...state.forms[state.activeFormUuid].encounters,
-                [state.forms[state.activeFormUuid].activePatientUuid]:
-                  action.encounterUuid,
+                [state.forms[state.activeFormUuid].activePatientUuid]: action.encounterUuid,
               },
               activePatientUuid: null,
               activeEncounterUuid: null,
               workflowState:
-                state.forms[state.activeFormUuid].workflowState ===
-                "SUBMIT_FOR_NEXT"
-                  ? "NEW_PATIENT"
-                  : state.forms[state.activeFormUuid].workflowState ===
-                    "SUBMIT_FOR_REVIEW"
-                  ? "REVIEW"
+                state.forms[state.activeFormUuid].workflowState === 'SUBMIT_FOR_NEXT'
+                  ? 'NEW_PATIENT'
+                  : state.forms[state.activeFormUuid].workflowState === 'SUBMIT_FOR_REVIEW'
+                  ? 'REVIEW'
                   : state.forms[state.activeFormUuid].workflowState,
             },
           },
@@ -155,33 +138,32 @@ const reducer = (state, action) => {
         return newState;
       }
     }
-    case "EDIT_ENCOUNTER": {
+    case 'EDIT_ENCOUNTER': {
       const newState = {
         ...state,
         forms: {
           ...state.forms,
           [state.activeFormUuid]: {
             ...state.forms[state.activeFormUuid],
-            activeEncounterUuid:
-              state.forms[state.activeFormUuid].encounters[action.patientUuid],
+            activeEncounterUuid: state.forms[state.activeFormUuid].encounters[action.patientUuid],
             activePatientUuid: action.patientUuid,
-            workflowState: "EDIT_FORM",
+            workflowState: 'EDIT_FORM',
           },
         },
       };
       persistData(newState);
       return newState;
     }
-    case "SUBMIT_FOR_NEXT":
+    case 'SUBMIT_FOR_NEXT':
       // this state should not be persisted
       window.dispatchEvent(
-        new CustomEvent("ampath-form-action", {
+        new CustomEvent('ampath-form-action', {
           detail: {
             formUuid: state.activeFormUuid,
             patientUuid: state.forms[state.activeFormUuid].activePatientUuid,
-            action: "onSubmit",
+            action: 'onSubmit',
           },
-        })
+        }),
       );
       return {
         ...state,
@@ -189,20 +171,20 @@ const reducer = (state, action) => {
           ...state.forms,
           [state.activeFormUuid]: {
             ...state.forms[state.activeFormUuid],
-            workflowState: "SUBMIT_FOR_NEXT",
+            workflowState: 'SUBMIT_FOR_NEXT',
           },
         },
       };
-    case "SUBMIT_FOR_REVIEW":
+    case 'SUBMIT_FOR_REVIEW':
       // this state should not be persisted
       window.dispatchEvent(
-        new CustomEvent("ampath-form-action", {
+        new CustomEvent('ampath-form-action', {
           detail: {
             formUuid: state.activeFormUuid,
             patientUuid: state.forms[state.activeFormUuid].activePatientUuid,
-            action: "onSubmit",
+            action: 'onSubmit',
           },
-        })
+        }),
       );
       return {
         ...state,
@@ -210,20 +192,20 @@ const reducer = (state, action) => {
           ...state.forms,
           [state.activeFormUuid]: {
             ...state.forms[state.activeFormUuid],
-            workflowState: "SUBMIT_FOR_REVIEW",
+            workflowState: 'SUBMIT_FOR_REVIEW',
           },
         },
       };
-    case "SUBMIT_FOR_COMPLETE":
+    case 'SUBMIT_FOR_COMPLETE':
       // this state should not be persisted
       window.dispatchEvent(
-        new CustomEvent("ampath-form-action", {
+        new CustomEvent('ampath-form-action', {
           detail: {
             formUuid: state.activeFormUuid,
             patientUuid: state.forms[state.activeFormUuid].activePatientUuid,
-            action: "onSubmit",
+            action: 'onSubmit',
           },
-        })
+        }),
       );
       return {
         ...state,
@@ -231,11 +213,11 @@ const reducer = (state, action) => {
           ...state.forms,
           [state.activeFormUuid]: {
             ...state.forms[state.activeFormUuid],
-            workflowState: "SUBMIT_FOR_COMPLETE",
+            workflowState: 'SUBMIT_FOR_COMPLETE',
           },
         },
       };
-    case "GO_TO_REVIEW": {
+    case 'GO_TO_REVIEW': {
       const newState = {
         ...state,
         forms: {
@@ -244,14 +226,14 @@ const reducer = (state, action) => {
             ...state.forms[state.activeFormUuid],
             activeEncounterUuid: null,
             activePatientUuid: null,
-            workflowState: "REVIEW",
+            workflowState: 'REVIEW',
           },
         },
       };
       persistData(newState);
       return newState;
     }
-    case "DESTROY_SESSION": {
+    case 'DESTROY_SESSION': {
       const { [state.activeFormUuid]: activeForm, ...formRest } = state.forms;
       const newState = {
         ...state,
@@ -259,14 +241,18 @@ const reducer = (state, action) => {
         activeFormUuid: null,
       };
       persistData(newState);
+      //eslint-disable-next-line
+      navigate({ to: '${openmrsSpaBase}/forms' });
       return newState;
     }
-    case "CLOSE_SESSION": {
+    case 'CLOSE_SESSION': {
       const newState = {
         ...state,
         activeFormUuid: null,
       };
       persistData(newState);
+      //eslint-disable-next-line
+      navigate({ to: '${openmrsSpaBase}/forms' });
       return newState;
     }
     default:

package/src/context/GroupFormWorkflowContext.tsx

@@ -0,0 +1,155 @@
+import React, { useEffect, useMemo, useReducer } from 'react';
+import reducer from './GroupFormWorkflowReducer';
+import { useParams } from 'react-router-dom';
+import { type Type, useSession } from '@openmrs/esm-framework';
+import useGetSystemSetting from '../hooks/useGetSystemSetting';
+interface ParamTypes {
+  formUuid?: string;
+}
+
+export interface GroupType {
+  id: string;
+  name: string;
+  members: Array<Type.Object>;
+}
+export interface MetaType {
+  sessionName: string;
+  sessionDate: string;
+  practitionerName: string;
+  sessionNotes: string;
+}
+
+const initialActions = {
+  setGroup: (group: GroupType) => undefined,
+  unsetGroup: () => undefined,
+  setSessionMeta: (meta: MetaType) => undefined,
+  openPatientSearch: () => undefined,
+  saveEncounter: (encounterUuid: string | number) => undefined,
+  editEncounter: (patientUuid: string | number) => undefined,
+  validateForNext: () => undefined,
+  validateForComplete: () => undefined,
+  updateVisitUuid: (visitUuid: string) => undefined,
+  submitForNext: (nextPatientUuid: string = null) => undefined,
+  submitForReview: () => undefined,
+  submitForComplete: () => undefined,
+  addPatientUuid: (patientUuid: string) => undefined,
+  removePatientUuid: (patientUuid: string) => undefined,
+  goToReview: () => undefined,
+  destroySession: () => undefined,
+  closeSession: () => undefined,
+};
+
+export const initialWorkflowState = {
+  // activeFormUuid and forms are the only two real values stored at state root level
+  activeFormUuid: null, // the corrently open form
+  forms: {}, // object containing all forms session data
+  // the following fields will be available in context but are not stored at the
+  //     state root level, but refer to nested values for the current
+  //     aciveFormUuid
+  workflowState: null, // pseudo field from state[activeFormUuid].workflowState
+  activePatientUuid: null, // pseudo field from state[activeFormUuid].activePatientUuid
+  activeEncounterUuid: null, // pseudo field from state[activeFormUuid].activeEncounterUuid
+  activeSessionUuid: null, // pseudo field from state[activeFormUuid].activeSessionUuid
+  activeVisitUuid: null, // pseudo field from state[activeFormUuid].activeVisitUuid
+  patientUuids: [], // pseudo field from state[activeFormUuid].patientUuids
+  encounters: {}, // pseudo field from state[activeFormUuid].encounters
+  visits: {}, // pseudo field from state[activeFormUuid].visits
+  activeGroupUuid: null, // pseudo field from state[activeFormUuid].groupUuid
+  activeGroupName: null, // pseudo field from state[activeFormUuid].groupName
+  activeGroupMembers: [], // pseudo field from state[activeFormUuid].groupMembers
+  activeSessionMeta: {
+    sessionName: null,
+    practitionerName: null,
+    sessionDate: null,
+    sessionNotes: null,
+  },
+  groupVisitTypeUuid: null,
+  userUuid: null, // UUID of the user to which this workflow state belongs to
+};
+
+const GroupFormWorkflowContext = React.createContext({
+  ...initialWorkflowState,
+  ...initialActions,
+});
+
+const GroupFormWorkflowProvider = ({ children }) => {
+  const { user } = useSession();
+  const { formUuid } = useParams() as ParamTypes;
+  const activeFormUuid = formUuid.split('&')[0];
+  const systemSetting = useGetSystemSetting('@openmrs/esm-fast-data-entry-app.groupSessionVisitTypeUuid');
+  const groupVisitTypeUuid = systemSetting?.result?.data?.results?.[0]?.value;
+  const [state, dispatch] = useReducer(reducer, {
+    ...initialWorkflowState,
+    ...initialActions,
+  });
+
+  const actions = useMemo(
+    () => ({
+      initializeWorkflowState: ({ activeFormUuid }) =>
+        dispatch({
+          type: 'INITIALIZE_WORKFLOW_STATE',
+          activeFormUuid,
+          userUuid: user.uuid,
+        }),
+      setGroup: (group) => dispatch({ type: 'SET_GROUP', group }),
+      unsetGroup: () => dispatch({ type: 'UNSET_GROUP' }),
+      setSessionMeta: (meta) => dispatch({ type: 'SET_SESSION_META', meta }),
+      addPatientUuid: (patientUuid) => dispatch({ type: 'ADD_PATIENT_UUID', patientUuid }),
+      removePatientUuid: (patientUuid) => dispatch({ type: 'REMOVE_PATIENT_UUID', patientUuid }),
+      openPatientSearch: () => dispatch({ type: 'OPEN_PATIENT_SEARCH' }),
+      saveEncounter: (encounterUuid) =>
+        dispatch({
+          type: 'SAVE_ENCOUNTER',
+          encounterUuid,
+        }),
+      validateForNext: () => dispatch({ type: 'VALIDATE_FOR_NEXT' }),
+      validateForComplete: () => dispatch({ type: 'VALIDATE_FOR_COMPLETE' }),
+      updateVisitUuid: (visitUuid) => dispatch({ type: 'UPDATE_VISIT_UUID', visitUuid }),
+      submitForNext: (nextPatientUuid) => dispatch({ type: 'SUBMIT_FOR_NEXT', nextPatientUuid }),
+      submitForComplete: () => dispatch({ type: 'SUBMIT_FOR_COMPLETE' }),
+      editEncounter: (patientUuid) => dispatch({ type: 'EDIT_ENCOUNTER', patientUuid }),
+      goToReview: () => dispatch({ type: 'GO_TO_REVIEW' }),
+      destroySession: () => dispatch({ type: 'DESTROY_SESSION' }),
+      closeSession: () => dispatch({ type: 'CLOSE_SESSION' }),
+    }),
+    [user],
+  );
+
+  // if formUuid isn't a part of state yet, grab it from the url params
+  // this is the entry into the workflow system
+  useEffect(() => {
+    if (state?.workflowState === null && activeFormUuid) {
+      actions.initializeWorkflowState({ activeFormUuid });
+    }
+  }, [activeFormUuid, state?.workflowState, actions]);
+
+  return (
+    <GroupFormWorkflowContext.Provider
+      value={{
+        groupVisitTypeUuid,
+        ...state,
+        ...actions,
+        workflowState: state.forms?.[state.activeFormUuid]?.workflowState ?? initialWorkflowState.workflowState,
+        activeSessionUuid:
+          state.forms?.[state.activeFormUuid]?.activeSessionUuid ?? initialWorkflowState.activeSessionUuid,
+        activePatientUuid:
+          state.forms?.[state.activeFormUuid]?.activePatientUuid ?? initialWorkflowState.activePatientUuid,
+        activeEncounterUuid:
+          state.forms?.[state.activeFormUuid]?.activeEncounterUuid ?? initialWorkflowState.activeEncounterUuid,
+        activeVisitUuid: state.forms?.[state.activeFormUuid]?.activeVisitUuid ?? initialWorkflowState.activeVisitUuid,
+        patientUuids: state.forms?.[state.activeFormUuid]?.patientUuids ?? initialWorkflowState.patientUuids,
+        encounters: state.forms?.[state.activeFormUuid]?.encounters ?? initialWorkflowState.encounters,
+        activeGroupUuid: state.forms?.[state.activeFormUuid]?.groupUuid ?? initialWorkflowState.activeGroupUuid,
+        activeGroupName: state.forms?.[state.activeFormUuid]?.groupName ?? initialWorkflowState.activeGroupName,
+        activeGroupMembers:
+          state.forms?.[state.activeFormUuid]?.groupMembers ?? initialWorkflowState.activeGroupMembers,
+        activeSessionMeta: state.forms?.[state.activeFormUuid]?.sessionMeta ?? initialWorkflowState.activeSessionMeta,
+      }}
+    >
+      {children}
+    </GroupFormWorkflowContext.Provider>
+  );
+};
+
+export default GroupFormWorkflowContext;
+export { GroupFormWorkflowProvider };