@openmrs/esm-form-engine-lib 3.3.1-pre.2179 → 3.3.1-pre.2185

package/__mocks__/forms/rfe-forms/expression-visit-object-test.json

@@ -0,0 +1,29 @@
+{
+  "name": "Visit Form",
+  "pages": [
+    {
+      "label": "Page 1",
+      "sections": [
+        {
+          "label": "Section 1",
+          "isExpanded": "true",
+          "questions": [
+            {
+              "label": "Encounter Date",
+              "type": "encounterDatetime",
+              "id": "encounterDate",
+              "questionOptions": {
+                "rendering": "date",
+                "calculate": {
+                  "calculateExpression": "visit && visit?.startDatetime ? new Date(visit?.startDatetime) : null"
+                }
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "uuid": "form-visit-test",
+  "encounterType": "b9c1f50f-f77d-42e2-ad2a-d29304dde2fv"
+}

package/__mocks__/forms/rfe-forms/index.ts

@@ -40,6 +40,7 @@ export { default as uiSelectExtForm } from './sample-ui-select-ext.json';
 export { default as unspecifiedForm } from './sample-unspecified-form.json';
 export { default as viralLoadStatusForm } from './viral-load-status-form.json';
 export { default as weightForHeightZscoreTestSchema } from './zscore-weight-height-form.json';
+export { default as expressionVisitObjectTestSchema } from './expression-visit-object-test.json';
 
 export { obsList } from './obs-list-data';
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-form-engine-lib",
-  "version": "3.3.1-pre.2179",
+  "version": "3.3.1-pre.2185",
   "description": "React Form Engine for O3",
   "browser": "dist/openmrs-esm-form-engine-lib.js",
   "main": "src/index.ts",

package/src/components/renderer/field/fieldLogic.ts

@@ -19,7 +19,7 @@ export function handleFieldLogic(field: FormField, context: FormContextProps) {
 }
 
 function evaluateFieldAnswerDisabled(field: FormField, values: Record<string, any>, context: FormContextProps) {
-  const { sessionMode, formFields, patient } = context;
+  const { sessionMode, formFields, patient, visit } = context;
   field.questionOptions.answers.forEach((answer) => {
     const disableExpression = answer.disable?.disableWhenExpression;
     if (disableExpression && disableExpression.includes('myValue')) {
@@ -31,6 +31,7 @@ function evaluateFieldAnswerDisabled(field: FormField, values: Record<string, an
         {
           mode: sessionMode,
           patient,
+          visit,
         },
       );
     }
@@ -47,6 +48,7 @@ function evaluateFieldDependents(field: FormField, values: any, context: FormCon
     methods: { setValue },
     updateFormField,
     setForm,
+    visit,
   } = context;
 
   let shouldUpdateForm = false;
@@ -64,6 +66,7 @@ function evaluateFieldDependents(field: FormField, values: any, context: FormCon
           {
             mode: sessionMode,
             patient,
+            visit,
           },
         )
           .then((result) => {
@@ -169,6 +172,7 @@ function evaluateFieldDependents(field: FormField, values: any, context: FormCon
             {
               mode: sessionMode,
               patient,
+              visit,
             },
           );
         });
@@ -184,6 +188,7 @@ function evaluateFieldDependents(field: FormField, values: any, context: FormCon
             {
               mode: sessionMode,
               patient,
+              visit,
             },
           );
         });
@@ -197,6 +202,7 @@ function evaluateFieldDependents(field: FormField, values: any, context: FormCon
           {
             mode: sessionMode,
             patient,
+            visit,
           },
         );
       }
@@ -210,6 +216,7 @@ function evaluateFieldDependents(field: FormField, values: any, context: FormCon
           {
             mode: sessionMode,
             patient,
+            visit,
           },
         );
       }

package/src/components/repeat/repeat.component.tsx

@@ -35,6 +35,7 @@ const Repeat: React.FC<FormFieldInputProps> = ({ field }) => {
     removeFormField,
     deletedFields,
     setDeletedFields,
+    visit,
   } = context;
 
   useEffect(() => {
@@ -61,6 +62,7 @@ const Repeat: React.FC<FormFieldInputProps> = ({ field }) => {
             {
               mode: sessionMode,
               patient: patient,
+              visit,
             },
           );
         }
@@ -73,6 +75,7 @@ const Repeat: React.FC<FormFieldInputProps> = ({ field }) => {
             {
               mode: sessionMode,
               patient: patient,
+              visit,
             },
           ).then((result) => {
             if (!isEmpty(result)) {

package/src/form-engine.test.tsx

@@ -45,6 +45,7 @@ import {
   sampleFieldsForm,
   testEnrolmentForm,
   viralLoadStatusForm,
+  expressionVisitObjectTestSchema,
 } from '__mocks__/forms';
 import { type FormSchema, type OpenmrsEncounter, type SessionMode } from './types';
 import { useEncounter } from './hooks/useEncounter';
@@ -1260,6 +1261,20 @@ describe('Form engine component', () => {
       });
     });
   });
+  describe('Form calculate expression integration', () => {
+    it('should calculate encounter date from visit startDatetime', async () => {
+      await act(async () => {
+        return renderForm(null, expressionVisitObjectTestSchema, 'enter', 'enter', null);
+      });
+
+      await waitFor(() => {
+        const dateInput = screen.getByLabelText('Encounter Date') as HTMLInputElement;
+        expect(dateInput).toBeInTheDocument();
+
+        expect(dateInput.value).toContain('28/07/2020');
+      });
+    });
+  });
 
   function renderForm(formUUID, formJson, intent?: string, mode?: SessionMode, encounterUUID?: string) {
     render(

package/src/hooks/useEvaluateFormFieldExpressions.ts

@@ -11,7 +11,7 @@ export const useEvaluateFormFieldExpressions = (
   formValues: Record<string, any>,
   factoryContext: FormProcessorContextProps,
 ) => {
-  const { formFields, patient, sessionMode } = factoryContext;
+  const { formFields, patient, sessionMode, visit } = factoryContext;
   const [evaluatedFormJson, setEvaluatedFormJson] = useState(factoryContext.formJson);
   const [evaluatedPagesVisibility, setEvaluatedPagesVisibility] = useState(false);
 
@@ -21,6 +21,7 @@ export const useEvaluateFormFieldExpressions = (
       const runnerContext = {
         patient,
         mode: sessionMode,
+        visit,
       };
       // evaluate hide
       if (field.hide?.hideWhenExpression) {

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

@@ -330,6 +330,7 @@ export class EncounterFormProcessor extends FormProcessor {
       methods: { getValues },
       formFieldAdapters,
       previousDomainObjectValue,
+      visit,
     } = context;
     const node: FormNode = { value: field, type: 'field' };
     const adapter = formFieldAdapters[field.type];
@@ -338,6 +339,7 @@ export class EncounterFormProcessor extends FormProcessor {
         mode: sessionMode,
         patient: patient,
         previousEncounter: previousDomainObjectValue,
+        visit,
       });
       return value ? extractObsValueAndDisplay(field, value) : null;
     }
@@ -353,12 +355,13 @@ async function evaluateCalculateExpression(
   values: Record<string, any>,
   formContext: FormProcessorContextProps,
 ) {
-  const { formFields, sessionMode, patient } = formContext;
+  const { formFields, sessionMode, patient, visit } = formContext;
   const expression = field.questionOptions.calculate.calculateExpression;
   const node: FormNode = { value: field, type: 'field' };
   const context = {
     mode: sessionMode,
     patient: patient,
+    visit,
   };
   const value = await evaluateAsyncExpression(expression, node, formFields, values, context);
   if (!isEmpty(value)) {

package/src/provider/form-factory-provider.tsx

@@ -8,6 +8,7 @@ import {
   showSnackbar,
   showToast,
   type ToastDescriptor,
+  Visit,
 } from '@openmrs/esm-framework';
 import { type FormProcessorConstructor } from '../processors/form-processor';
 import { type FormContextProps } from './form-provider';
@@ -24,7 +25,7 @@ interface FormFactoryProviderContextProps {
   formProcessors: Record<string, FormProcessorConstructor>;
   layoutType: LayoutType;
   workspaceLayout: 'minimized' | 'maximized';
-  visit: OpenmrsResource;
+  visit: Visit;
   location: OpenmrsResource;
   provider: OpenmrsResource;
   isFormExpanded: boolean;
@@ -42,7 +43,7 @@ interface FormFactoryProviderProps {
   workspaceLayout: 'minimized' | 'maximized';
   location: OpenmrsResource;
   provider: OpenmrsResource;
-  visit: OpenmrsResource;
+  visit: Visit;
   isFormExpanded: boolean;
   children: React.ReactNode;
   formSubmissionProps: {

package/src/types/index.ts

@@ -1,4 +1,4 @@
-import { type LayoutType, type OpenmrsResource } from '@openmrs/esm-framework';
+import { type Visit, type LayoutType, type OpenmrsResource } from '@openmrs/esm-framework';
 import { type FormProcessor } from '../processors/form-processor';
 import { type FormContextProps } from '../provider/form-provider';
 import { type FormField, type FormSchema } from './schema';
@@ -9,7 +9,7 @@ export type SessionMode = 'edit' | 'enter' | 'view' | 'embedded-view';
 export interface FormProcessorContextProps {
   patient: fhir.Patient;
   formJson: FormSchema;
-  visit: OpenmrsResource;
+  visit: Visit;
   sessionMode: SessionMode;
   sessionDate: Date;
   location: OpenmrsResource;

package/src/utils/expression-runner.ts

@@ -55,7 +55,6 @@ export function evaluateExpression(
   const compiledExpression = getExpressionAst(expression);
   // track dependencies
   trackFieldDependencies(compiledExpression, node, fields);
-
   try {
     return evaluateAsType(compiledExpression, getEvaluationContext(node, fields, fieldValues, context), typePredicate);
   } catch (error) {
@@ -74,6 +73,7 @@ export async function evaluateAsyncExpression(
   if (!expression?.trim()) {
     return null;
   }
+
   const compiledExpression = getExpressionAst(expression);
   // track dependencies
   trackFieldDependencies(compiledExpression, node, fields);
@@ -110,7 +110,8 @@ function getEvaluationContext(
     },
   });
 
-  const visitType = context.visit?.visitType || { uuid: '' };
+  const visit: Visit = context?.visit ?? ({} as Visit);
+  const visitType = visit?.visitType || { uuid: '' };
   const visitTypeUuid = visitType.uuid ?? '';
 
   const _ = {
@@ -127,6 +128,7 @@ function getEvaluationContext(
     sex,
     age,
     HD,
+    visit,
     visitType,
     visitTypeUuid,
     _,
@@ -160,6 +162,7 @@ export function trackFieldDependencies(
   allFields: FormField[],
 ) {
   const variables = extractVariableNames(expression);
+
   for (const variable of variables) {
     const field = allFields.find((field) => field.id === variable);
     if (field) {