@openmrs/esm-form-engine-lib 4.2.2-pre.2543 → 4.2.2-pre.2550

package/src/processors/encounter/encounter-form-processor.ts

@@ -24,7 +24,7 @@ import {
 import { evaluateAsyncExpression, type FormNode } from '../../utils/expression-runner';
 import { extractErrorMessagesFromResponse } from '../../utils/error-utils';
 import { extractObsValueAndDisplay } from '../../utils/form-helper';
-import { FormProcessor } from '../form-processor';
+import { FormProcessor, type FormProcessorContextSetters } from '../form-processor';
 import { getPreviousEncounter, saveEncounter } from '../../api';
 import { hasRendering } from '../../utils/common-utils';
 import { isEmpty } from '../../validators/form-validator';
@@ -50,19 +50,14 @@ function useCustomHooks(context: Partial<FormProcessorContextProps>) {
     data: { encounter, patientPrograms, encounterRole },
     isLoading,
     error: null,
-    updateContext: (setContext: React.Dispatch<React.SetStateAction<FormProcessorContextProps>>) => {
-      setContext((context) => {
-        context.processor.domainObjectValue = encounter as OpenmrsResource;
-        return {
-          ...context,
-          domainObjectValue: encounter as OpenmrsResource,
-          customDependencies: {
-            ...context.customDependencies,
-            patientPrograms: patientPrograms,
-            defaultEncounterRole: encounterRole,
-          },
-        };
-      });
+    updateContext: (_setContext, { setDomainObjectValue, setCustomDependencies }) => {
+      context.processor.domainObjectValue = encounter as OpenmrsResource;
+      setDomainObjectValue(encounter as OpenmrsResource);
+      setCustomDependencies((previous) => ({
+        ...previous,
+        patientPrograms: patientPrograms,
+        defaultEncounterRole: encounterRole,
+      }));
     },
   };
 }
@@ -344,16 +339,12 @@ export class EncounterFormProcessor extends FormProcessor {
 
   async loadDependencies(
     context: FormContextProps,
-    setContext: React.Dispatch<React.SetStateAction<FormProcessorContextProps>>,
+    _setContext: React.Dispatch<React.SetStateAction<FormProcessorContextProps>>,
+    { setPreviousDomainObjectValue }: FormProcessorContextSetters,
   ) {
     const { patient, formJson } = context;
     const encounter = await getPreviousEncounter(patient?.id, formJson.encounterType);
-    setContext((context) => {
-      return {
-        ...context,
-        previousDomainObjectValue: encounter,
-      };
-    });
+    setPreviousDomainObjectValue(encounter);
     return context;
   }
 

package/src/processors/form-processor.ts

@@ -4,12 +4,33 @@ import { type ValueAndDisplay, type FormField, type FormSchema, type FormProcess
 
 export type FormProcessorConstructor = new (...args: ConstructorParameters<typeof FormProcessor>) => FormProcessor;
 
+/**
+ * The setters a processor uses to feed its results back into the processor context. These are the
+ * only three properties it can change; the rest of {@link FormProcessorContextProps} is derived by
+ * the FormProcessorFactory. They supersede the `setContext` passed alongside them, which is shaped
+ * like a `setState` over the whole context but silently discards everything else.
+ */
+export interface FormProcessorContextSetters {
+  setDomainObjectValue: (value: OpenmrsResource) => void;
+  setPreviousDomainObjectValue: (value: OpenmrsResource) => void;
+  setCustomDependencies: (
+    dependencies: Record<string, any> | ((previous: Record<string, any>) => Record<string, any>),
+  ) => void;
+}
+
 export type GetCustomHooksResponse = {
   useCustomHooks: (context: Partial<FormProcessorContextProps>) => {
     data: any;
     isLoading: boolean;
     error: any;
-    updateContext: (setContext: React.Dispatch<React.SetStateAction<FormProcessorContextProps>>) => void;
+    /**
+     * Called once the hook has finished loading, to merge its results into the processor context.
+     * `setContext` is deprecated; use `setters`.
+     */
+    updateContext: (
+      setContext: React.Dispatch<React.SetStateAction<FormProcessorContextProps>>,
+      setters: FormProcessorContextSetters,
+    ) => void;
   };
 };
 
@@ -25,9 +46,14 @@ export abstract class FormProcessor {
     return this.domainObjectValue;
   }
 
+  /**
+   * Loads whatever the processor needs before the form can render, merging the results into the
+   * processor context. `setContext` is deprecated; use `setters`.
+   */
   async loadDependencies(
     context: Partial<FormProcessorContextProps>,
     setContext: React.Dispatch<React.SetStateAction<FormProcessorContextProps>>,
+    setters: FormProcessorContextSetters,
   ): Promise<Record<string, any>> {
     return Promise.resolve({});
   }