import React, { useEffect, useMemo, useRef, useState } from 'react'; import classNames from 'classnames'; import { Form, Formik } from 'formik'; import { Button, ButtonSet, InlineLoading } from '@carbon/react'; import { I18nextProvider, useTranslation } from 'react-i18next'; import * as Yup from 'yup'; import { showSnackbar, useSession, type Visit } from '@openmrs/esm-framework'; import { init, teardown } from './lifecycle'; import type { FormField, FormPage as FormPageProps, FormSchema, SessionMode, ValidationResult } from './types'; import { extractErrorMessagesFromResponse, reportError } from './utils/error-utils'; import { useFormJson } from './hooks/useFormJson'; import { usePostSubmissionAction } from './hooks/usePostSubmissionAction'; import { useWorkspaceLayout } from './hooks/useWorkspaceLayout'; import { usePatientData } from './hooks/usePatientData'; import { evaluatePostSubmissionExpression } from './utils/post-submission-action-helper'; import { moduleName } from './globals'; import { useFormCollapse } from './hooks/useFormCollapse'; import EncounterForm from './components/encounter/encounter-form.component'; import Loader from './components/loaders/loader.component'; import MarkdownWrapper from './components/inputs/markdown/markdown-wrapper.component'; import PatientBanner from './components/patient-banner/patient-banner.component'; import Sidebar from './components/sidebar/sidebar.component'; import { ExternalFunctionContext } from './external-function-context'; import styles from './form-engine.scss'; import ErrorModal from './components/errors/error-modal.component'; interface FormProps { patientUUID: string; formUUID?: string; formJson?: FormSchema; encounterUUID?: string; visit?: Visit; formSessionIntent?: string; onSubmit?: () => void; onCancel?: () => void; handleClose?: () => void; handleConfirmQuestionDeletion?: (question: Readonly) => Promise; mode?: SessionMode; meta?: { /** * The microfrontend that will be used to serve configs and load extensions. */ moduleName: string; /** * Tells the engine where to pickup forms specific config from the ESM's configuration * * *Assuming an esm defines a config of similar structure:* * ```json * { * forms: { * FormEngineConfig: {}, * }, * otherConfigs: {} * } * ``` * The path to the `FormEngineConfig` would be: `"forms.FormEngineConfig"` */ configPath?: string; }; /** * @deprecated * * Renamed to `encounterUUID`. To be removed in future iterations. */ encounterUuid?: string; markFormAsDirty?: (isDirty: boolean) => void; } export interface FormSubmissionHandler { submit: (values) => Promise; validate: (values) => boolean; } const FormEngine: React.FC = ({ formJson, formUUID, patientUUID, encounterUUID, visit, mode, onSubmit, onCancel, handleClose, handleConfirmQuestionDeletion, formSessionIntent, meta, encounterUuid, markFormAsDirty, }) => { const session = useSession(); const currentProvider = session?.currentProvider?.uuid ? session.currentProvider.uuid : null; const location = session && !(encounterUUID || encounterUuid) ? session?.sessionLocation : null; const { patient, isLoadingPatient: isLoadingPatient, patientError: patientError } = usePatientData(patientUUID); const { formJson: refinedFormJson, isLoading: isLoadingFormJson, formError, } = useFormJson(formUUID, formJson, encounterUUID || encounterUuid, formSessionIntent); const { t } = useTranslation(); const formSessionDate = useMemo(() => new Date(), []); const handlers = new Map(); const ref = useRef(null); const workspaceLayout = useWorkspaceLayout(ref); const [initialValues, setInitialValues] = useState({}); const [scrollablePages, setScrollablePages] = useState(new Set()); const [selectedPage, setSelectedPage] = useState(''); const [isLoadingFormDependencies, setIsLoadingFormDependencies] = useState(true); const [isFormDirty, setIsFormDirty] = useState(false); const [isSubmitting, setIsSubmitting] = useState(false); const [pagesWithErrors, setPagesWithErrors] = useState([]); const postSubmissionHandlers = usePostSubmissionAction(refinedFormJson?.postSubmissionActions); const [fieldErrors, setFieldErrors] = useState([]); const sessionMode = mode ? mode : encounterUUID || encounterUuid ? 'edit' : 'enter'; const { isFormExpanded, hideFormCollapseToggle } = useFormCollapse(sessionMode); const showSidebar = useMemo(() => { return workspaceLayout !== 'minimized' && scrollablePages.size > 1 && sessionMode !== 'embedded-view'; }, [workspaceLayout, scrollablePages.size, sessionMode]); const showPatientBanner = useMemo(() => { return workspaceLayout != 'minimized' && patient?.id && sessionMode != 'embedded-view'; }, [patient?.id, sessionMode, workspaceLayout]); const showButtonSet = useMemo(() => { if (sessionMode === 'embedded-view') { return false; } return workspaceLayout === 'minimized' || (workspaceLayout === 'maximized' && scrollablePages.size <= 1); }, [sessionMode, workspaceLayout, scrollablePages]); useEffect(() => { //////////// // This hooks into the React lifecycle of the forms engine. //////////// init(); return () => { teardown(); }; }, []); useEffect(() => { reportError(formError, t); }, [formError, t]); useEffect(() => { reportError(patientError, t); }, [patientError, t]); useEffect(() => { markFormAsDirty?.(isFormDirty); }, [isFormDirty]); const handleFormSubmit = (values: Record) => { // validate the form and its subforms (when present) let isSubmittable = true; handlers.forEach((handler) => { const result = handler?.validate?.(values); if (!result) { isSubmittable = false; } }); // do submit if (isSubmittable) { setIsSubmitting(true); const submissions = [...handlers].map(([key, handler]) => { return handler?.submit?.(values); }); Promise.all(submissions) .then(async (results) => { if (sessionMode === 'edit') { showSnackbar({ title: t('updatedRecord', 'Record updated'), subtitle: t('updatedRecordDescription', 'The patient encounter was updated'), kind: 'success', isLowContrast: true, }); } else { showSnackbar({ title: t('createdRecord', 'Record created'), subtitle: t('createdRecordDescription', 'A new encounter was created'), kind: 'success', isLowContrast: true, }); } // Post Submission Actions if (postSubmissionHandlers) { await Promise.all( postSubmissionHandlers.map(async ({ postAction, config, actionId, enabled }) => { try { const encounterData = []; if (results) { results.forEach((result) => { if (result?.data) { encounterData.push(result.data); } if (result?.uuid) { encounterData.push(result); } }); if (encounterData.length) { const isActionEnabled = enabled ? evaluatePostSubmissionExpression(enabled, encounterData) : true; if (isActionEnabled) { await postAction.applyAction( { patient, sessionMode, encounters: encounterData, }, config, ); } } else { throw new Error('No encounter data to process post submission action'); } } else { throw new Error('No handlers available to process post submission action'); } } catch (error) { const errorMessages = extractErrorMessagesFromResponse(error); showSnackbar({ title: t( 'errorDescriptionTitle', actionId ? actionId.replace(/([a-z])([A-Z])/g, '$1 $2') : 'Post Submission Error', ), subtitle: t('errorDescription', '{{errors}}', { errors: errorMessages.join(', ') }), kind: 'error', isLowContrast: false, }); } }), ); } onSubmit?.(); hideFormCollapseToggle(); }) .catch((error) => { setIsSubmitting(false); showSnackbar(error); }) .finally(() => { setIsSubmitting(false); }); } }; return ( { handleFormSubmit(values); setSubmitting(false); }}> {(props) => { setIsFormDirty(props.dirty); return (
{isLoadingPatient || isLoadingFormJson ? ( ) : (
{isLoadingFormDependencies && (
)}
{showSidebar && ( )}
{showPatientBanner && } {refinedFormJson.markdown && (
)}
{fieldErrors.length > 0 ? : null}
{' '}
{showButtonSet && ( )}
)}
); }}
); }; function I18FormEngine(props: FormProps) { return ( ); } export default I18FormEngine;