@openmrs/esm-fast-data-entry-app 1.0.1-pre.93 → 1.1.0

package/src/group-form-entry-workflow/SessionDetailsForm.tsx

@@ -1,20 +1,25 @@
-import {
-  Layer,
-  Tile,
-  TextInput,
-  TextArea,
-  DatePicker,
-  DatePickerInput,
-} from "@carbon/react";
-import React, { useContext } from "react";
-import styles from "./styles.scss";
-import { useTranslation } from "react-i18next";
-import { Controller, useFormContext } from "react-hook-form";
-import { AttendanceTable } from "./attendance-table";
-import GroupFormWorkflowContext from "../context/GroupFormWorkflowContext";
-import useGetPatients from "../hooks/useGetPatients";
+import { Layer, Tile, TextInput, TextArea, DatePicker, DatePickerInput } from '@carbon/react';
+import React, { useContext } from 'react';
+import { useConfig } from '@openmrs/esm-framework';
+import { useParams } from 'react-router-dom';
+import styles from './styles.scss';
+import { useTranslation } from 'react-i18next';
+import { Controller, useFormContext } from 'react-hook-form';
+import { AttendanceTable } from './attendance-table';
+import GroupFormWorkflowContext from '../context/GroupFormWorkflowContext';
+import useGetPatients from '../hooks/useGetPatients';
+import ConfigurableQuestionsSection from './configurable-questions/ConfigurableQuestionsSection';
+import useSpecificQuestions from '../hooks/useSpecificQuestions';
+
+interface ParamTypes {
+  formUuid?: string;
+}
 
 const SessionDetailsForm = () => {
+  const { specificQuestions } = useConfig();
+  const { formUuid } = useParams() as ParamTypes;
+  const { questions } = useSpecificQuestions(formUuid, specificQuestions);
+
   const { t } = useTranslation();
   const {
     register,
@@ -22,66 +27,56 @@ const SessionDetailsForm = () => {
     control,
   } = useFormContext();
 
-  const { patientUuids } = useContext(GroupFormWorkflowContext);
-  const { patients, isLoading } = useGetPatients(patientUuids);
+  const { activeGroupMembers } = useContext(GroupFormWorkflowContext);
+  const { patients, isLoading } = useGetPatients(activeGroupMembers);
 
   return (
     <div>
       {!isLoading && (
         <div className={styles.formSection}>
-          <h4>{t("sessionDetails", "1. Session details")}</h4>
+          <h4>{t('sessionDetails', '1. Session details')}</h4>
           <div>
-            <p>
-              {t(
-                "allFieldsRequired",
-                "All fields are required unless marked optional"
-              )}
-            </p>
+            <p>{t('allFieldsRequired', 'All fields are required unless marked optional')}</p>
           </div>
           <Layer>
             <Tile className={styles.formSectionTile}>
               <Layer>
                 <div
                   style={{
-                    display: "flex",
-                    flexDirection: "column",
-                    rowGap: "1.5rem",
+                    display: 'flex',
+                    flexDirection: 'column',
+                    rowGap: '1.5rem',
                   }}
                 >
                   <TextInput
                     id="text"
                     type="text"
-                    labelText={t("sessionName", "Session Name")}
-                    {...register("sessionName", { required: true })}
+                    labelText={t('sessionName', 'Session Name')}
+                    {...register('sessionName', { required: true })}
                     invalid={errors.sessionName}
-                    invalidText={"This field is required"}
+                    invalidText={t('requiredField', 'This field is required')}
                   />
                   <TextInput
                     id="text"
                     type="text"
-                    labelText={t("practitionerName", "Practitioner Name")}
-                    {...register("practitionerName", { required: true })}
+                    labelText={t('practitionerName', 'Practitioner Name')}
+                    {...register('practitionerName', { required: true })}
                     invalid={errors.practitionerName}
-                    invalidText={"This field is required"}
+                    invalidText={t('requiredField', 'This field is required')}
                   />
                   <Controller
                     name="sessionDate"
                     control={control}
                     rules={{ required: true }}
                     render={({ field }) => (
-                      <DatePicker
-                        datePickerType="single"
-                        size="md"
-                        maxDate={new Date()}
-                        {...field}
-                      >
+                      <DatePicker datePickerType="single" size="md" maxDate={new Date()} {...field}>
                         <DatePickerInput
                           id="session-date"
-                          labelText={t("sessionDate", "Session Date")}
+                          labelText={t('sessionDate', 'Session Date')}
                           placeholder="mm/dd/yyyy"
                           size="md"
                           invalid={errors.sessionDate}
-                          invalidText={"This field is required"}
+                          invalidText={t('requiredField', 'This field is required')}
                         />
                       </DatePicker>
                     )}
@@ -89,21 +84,21 @@ const SessionDetailsForm = () => {
                   <TextArea
                     id="text"
                     type="text"
-                    labelText={t("sessionNotes", "Session Notes")}
-                    {...register("sessionNotes", { required: true })}
+                    labelText={t('sessionNotes', 'Session Notes')}
+                    {...register('sessionNotes', { required: true })}
                     invalid={errors.sessionNotes}
-                    invalidText={"This field is required"}
+                    invalidText={t('requiredField', 'This field is required')}
                   />
                 </div>
               </Layer>
             </Tile>
           </Layer>
-          <h4>{t("sessionParticipants", "2. Session participants")}</h4>
+          <h4>{t('sessionParticipants', '2. Session participants')}</h4>
           <div>
             <p>
               {t(
-                "markAbsentPatients",
-                "The patients in this group. Patients that are not present in the session should be marked as absent."
+                'markAbsentPatients',
+                'The patients in this group. Patients that are not present in the session should be marked as absent.',
               )}
             </p>
           </div>
@@ -112,9 +107,9 @@ const SessionDetailsForm = () => {
               <Layer>
                 <div
                   style={{
-                    display: "flex",
-                    flexDirection: "column",
-                    rowGap: "1.5rem",
+                    display: 'flex',
+                    flexDirection: 'column',
+                    rowGap: '1.5rem',
                   }}
                 >
                   <AttendanceTable patients={patients} />
@@ -122,6 +117,34 @@ const SessionDetailsForm = () => {
               </Layer>
             </Tile>
           </Layer>
+          {questions?.length > 0 ? (
+            <>
+              <h4>{t('sessionSpecificDetails', '3. Specific details')}</h4>
+              <div>
+                <p>
+                  {t(
+                    'sessionSpecificDetailsDescription',
+                    'They will be mapped to form responses for all patients as pre-filled data.',
+                  )}
+                </p>
+              </div>
+              <Layer>
+                <Tile className={styles.formSectionTile}>
+                  <Layer>
+                    <div
+                      style={{
+                        display: 'flex',
+                        flexDirection: 'column',
+                        rowGap: '1.5rem',
+                      }}
+                    >
+                      <ConfigurableQuestionsSection register={register} specificQuestions={questions} />
+                    </div>
+                  </Layer>
+                </Tile>
+              </Layer>
+            </>
+          ) : null}
         </div>
       )}
     </div>

package/src/group-form-entry-workflow/SessionMetaWorkspace.tsx

@@ -1,24 +1,24 @@
-import { Button } from "@carbon/react";
-import React, { useContext, useEffect, useState } from "react";
-import styles from "./styles.scss";
-import { useTranslation } from "react-i18next";
-import GroupFormWorkflowContext from "../context/GroupFormWorkflowContext";
-import { FormProvider, useForm, useFormContext } from "react-hook-form";
-import CancelModal from "../CancelModal";
-import SessionDetailsForm from "./SessionDetailsForm";
+import { Button } from '@carbon/react';
+import React, { useContext, useEffect, useState } from 'react';
+import styles from './styles.scss';
+import { useTranslation } from 'react-i18next';
+import GroupFormWorkflowContext from '../context/GroupFormWorkflowContext';
+import { FormProvider, useForm, useFormContext } from 'react-hook-form';
+import CancelModal from '../CancelModal';
+import SessionDetailsForm from './SessionDetailsForm';
 
 const NewGroupWorkflowButtons = () => {
   const { t } = useTranslation();
   const context = useContext(GroupFormWorkflowContext);
   const { workflowState, patientUuids } = context;
   const [cancelModalOpen, setCancelModalOpen] = useState(false);
-  if (workflowState !== "NEW_GROUP_SESSION") return null;
+  if (workflowState !== 'NEW_GROUP_SESSION') return null;
 
   return (
     <>
       <div className={styles.rightPanelActionButtons}>
         <Button kind="secondary" type="submit" disabled={!patientUuids.length}>
-          {t("createNewSession", "Create New Session")}
+          {t('createNewSession', 'Create New Session')}
         </Button>
         <Button
           kind="tertiary"
@@ -26,14 +26,10 @@ const NewGroupWorkflowButtons = () => {
             setCancelModalOpen(true);
           }}
         >
-          {t("cancel", "Cancel")}
+          {t('cancel', 'Cancel')}
         </Button>
       </div>
-      <CancelModal
-        open={cancelModalOpen}
-        setOpen={setCancelModalOpen}
-        context={context}
-      />
+      <CancelModal open={cancelModalOpen} setOpen={setCancelModalOpen} context={context} />
     </>
   );
 };
@@ -48,22 +44,20 @@ const GroupIdField = () => {
   const { activeGroupUuid } = useContext(GroupFormWorkflowContext);
 
   useEffect(() => {
-    if (activeGroupUuid) setValue("groupUuid", activeGroupUuid);
+    if (activeGroupUuid) setValue('groupUuid', activeGroupUuid);
   }, [activeGroupUuid, setValue]);
 
   return (
     <>
       <input
         hidden
-        {...register("groupUuid", {
+        {...register('groupUuid', {
           value: activeGroupUuid,
-          required: t("chooseGroupError", "Please choose a group."),
+          required: t('chooseGroupError', 'Please choose a group.'),
         })}
       />
       {errors.groupUuid && !activeGroupUuid && (
-        <div className={styles.formError}>
-          {errors.groupUuid.message as string}
-        </div>
+        <div className={styles.formError}>{errors.groupUuid.message as string}</div>
       )}
     </>
   );
@@ -71,9 +65,7 @@ const GroupIdField = () => {
 
 const SessionMetaWorkspace = () => {
   const { t } = useTranslation();
-  const { setSessionMeta, workflowState } = useContext(
-    GroupFormWorkflowContext
-  );
+  const { setSessionMeta, workflowState } = useContext(GroupFormWorkflowContext);
   const methods = useForm();
 
   const onSubmit = (data) => {
@@ -81,7 +73,7 @@ const SessionMetaWorkspace = () => {
     setSessionMeta({ ...rest, sessionDate: sessionDate[0] });
   };
 
-  if (workflowState !== "NEW_GROUP_SESSION") return null;
+  if (workflowState !== 'NEW_GROUP_SESSION') return null;
 
   return (
     <FormProvider {...methods}>
@@ -92,9 +84,9 @@ const SessionMetaWorkspace = () => {
               <SessionDetailsForm />
             </div>
             <div className={styles.rightPanel}>
-              <h4>{t("newGroupSession", "New Group Session")}</h4>
+              <h4>{t('newGroupSession', 'New Group Session')}</h4>
               <GroupIdField />
-              <hr style={{ width: "100%" }} />
+              <hr style={{ width: '100%' }} />
               <NewGroupWorkflowButtons />
             </div>
           </div>

package/src/group-form-entry-workflow/attendance-table/AttendanceTable.tsx

@@ -1,5 +1,5 @@
-import React, { useCallback, useContext, useMemo, useState } from "react";
-import { Edit } from "@carbon/react/icons";
+import React, { useCallback, useContext, useMemo, useState } from 'react';
+import { Edit } from '@carbon/react/icons';
 
 import {
   Checkbox,
@@ -11,15 +11,13 @@ import {
   TableBody,
   TableCell,
   Button,
-} from "@carbon/react";
-import { useTranslation } from "react-i18next";
-import GroupFormWorkflowContext from "../../context/GroupFormWorkflowContext";
-import AddGroupModal from "../../add-group-modal/AddGroupModal";
+} from '@carbon/react';
+import { useTranslation } from 'react-i18next';
+import GroupFormWorkflowContext from '../../context/GroupFormWorkflowContext';
+import AddGroupModal from '../../add-group-modal/AddGroupModal';
 
 const PatientRow = ({ patient }) => {
-  const { patientUuids, addPatientUuid, removePatientUuid } = useContext(
-    GroupFormWorkflowContext
-  );
+  const { patientUuids, addPatientUuid, removePatientUuid } = useContext(GroupFormWorkflowContext);
   const givenName = patient?.name?.[0]?.given?.[0];
   const familyName = patient?.name?.[0]?.family;
   const identifier = patient?.identifier?.[0]?.value;
@@ -50,11 +48,7 @@ const PatientRow = ({ patient }) => {
 
   return (
     <TableRow>
-      <TableCell>
-        {patient.display ||
-          patient.displayName ||
-          [givenName, familyName].join(" ")}
-      </TableCell>
+      <TableCell>{patient.display || patient.displayName || [givenName, familyName].join(' ')}</TableCell>
       <TableCell>{identifier}</TableCell>
       <TableCell>
         <Checkbox
@@ -71,19 +65,13 @@ const PatientRow = ({ patient }) => {
 
 const AttendanceTable = ({ patients }) => {
   const { t } = useTranslation();
-  const { activeGroupUuid, activeGroupName, activeGroupMembers } = useContext(
-    GroupFormWorkflowContext
-  );
+  const { activeGroupUuid, activeGroupName, activeGroupMembers } = useContext(GroupFormWorkflowContext);
 
   const [isOpen, setOpen] = useState(false);
 
-  const headers = [
-    t("name", "Name"),
-    t("identifier", "Patient ID"),
-    t("patientIsPresent", "Patient is present"),
-  ];
+  const headers = [t('name', 'Name'), t('identifier', 'Patient ID'), t('patientIsPresent', 'Patient is present')];
 
-  const handleCancel = useCallback(() => {
+  const onPostCancel = useCallback(() => {
     setOpen(false);
   }, []);
 
@@ -99,14 +87,14 @@ const AttendanceTable = ({ patients }) => {
   }, [activeGroupMembers, patients]);
 
   if (!activeGroupUuid) {
-    return <div>{t("selectGroupFirst", "Please select a group first")}</div>;
+    return <div>{t('selectGroupFirst', 'Please select a group first')}</div>;
   }
 
   return (
     <div>
       <span style={{ flexGrow: 1 }} />
       <Button kind="ghost" onClick={() => setOpen(true)}>
-        {t("editGroup", "Edit Group")}&nbsp;
+        {t('editGroup', 'Edit Group')}&nbsp;
         <Edit size={20} />
       </Button>
       <AddGroupModal
@@ -116,7 +104,7 @@ const AttendanceTable = ({ patients }) => {
           isCreate: false,
           groupName: activeGroupName,
           isOpen: isOpen,
-          handleCancel: handleCancel,
+          onPostCancel: onPostCancel,
           onPostSubmit: onPostSubmit,
         }}
       />
@@ -130,9 +118,7 @@ const AttendanceTable = ({ patients }) => {
         </TableHead>
         <TableBody>
           {activeGroupMembers.map((patientUuid, index) => {
-            const patient = patients.find(
-              (patient) => patient.id === patientUuid
-            );
+            const patient = patients.find((patient) => patient.id === patientUuid);
             return <PatientRow patient={patient} key={index} />;
           })}
         </TableBody>

package/src/group-form-entry-workflow/attendance-table/index.ts

@@ -1 +1 @@
-export { default as AttendanceTable } from "./AttendanceTable";
+export { default as AttendanceTable } from './AttendanceTable';

package/src/group-form-entry-workflow/configurable-questions/ConfigurableQuestionsSection.tsx

@@ -0,0 +1,45 @@
+import React from 'react';
+import { TextInput, Select, SelectItem } from '@carbon/react';
+import { type FieldValues, type UseFormRegister } from 'react-hook-form';
+import { type SpecificQuestion } from '../../types';
+
+interface ConfigurableQuestionsSectionProps {
+  specificQuestions: Array<SpecificQuestion>;
+  register?: UseFormRegister<FieldValues>;
+}
+
+const ConfigurableQuestionsSection: React.FC<ConfigurableQuestionsSectionProps> = ({ register, specificQuestions }) => {
+  return (
+    <>
+      {specificQuestions?.map((specificQuestion) => (
+        <div key={specificQuestion.question.id}>
+          {specificQuestion?.answers?.length > 0 ? (
+            <Select
+              {...register(specificQuestion.question.id, { required: false })}
+              id={specificQuestion.question.id}
+              labelText={specificQuestion.question.display}
+              readOnly={!!specificQuestion.question.disabled}
+              defaultValue={specificQuestion.question.defaultAnswer}
+            >
+              <SelectItem value="" text="" />
+              {specificQuestion.answers.map((answer) => (
+                <SelectItem key={answer.value} value={answer.value} text={answer.display} />
+              ))}
+            </Select>
+          ) : (
+            <TextInput
+              id={specificQuestion.question.id}
+              {...register(specificQuestion.question.id, { required: false })}
+              type="text"
+              labelText={specificQuestion.question.display}
+              readOnly={!!specificQuestion.question.disabled}
+              defaultValue={specificQuestion.question.defaultAnswer}
+            />
+          )}
+        </div>
+      ))}
+    </>
+  );
+};
+
+export default ConfigurableQuestionsSection;

package/src/group-form-entry-workflow/group-display-header/GroupDisplayHeader.test.tsx

@@ -1,9 +1,9 @@
-import React from "react";
-import { render } from "@testing-library/react";
-import GroupDisplayHeader from "./GroupDisplayHeader";
+import React from 'react';
+import { render } from '@testing-library/react';
+import GroupDisplayHeader from './GroupDisplayHeader';
 
-describe("PatientBanner", () => {
-  it("renders placeholder information when no data is present", () => {
+describe('PatientBanner', () => {
+  it('renders placeholder information when no data is present', () => {
     render(<GroupDisplayHeader />);
   });
 });

package/src/group-form-entry-workflow/group-display-header/GroupDisplayHeader.tsx

@@ -1,19 +1,13 @@
-import React, { useContext } from "react";
-import { Button } from "@carbon/react";
-import { Events, Close } from "@carbon/react/icons";
-import styles from "./styles.scss";
-import { useTranslation } from "react-i18next";
-import GroupFormWorkflowContext from "../../context/GroupFormWorkflowContext";
+import React, { useContext } from 'react';
+import { Button } from '@carbon/react';
+import { Events, Close } from '@carbon/react/icons';
+import styles from './styles.scss';
+import { useTranslation } from 'react-i18next';
+import GroupFormWorkflowContext from '../../context/GroupFormWorkflowContext';
 
 const GroupDisplayHeader = () => {
-  const {
-    activeGroupName,
-    activeGroupUuid,
-    patientUuids,
-    activeSessionMeta,
-    unsetGroup,
-    destroySession,
-  } = useContext(GroupFormWorkflowContext);
+  const { activeGroupName, activeGroupUuid, patientUuids, activeSessionMeta, unsetGroup, destroySession } =
+    useContext(GroupFormWorkflowContext);
   const { t } = useTranslation();
 
   if (!activeGroupUuid) {
@@ -31,29 +25,27 @@ const GroupDisplayHeader = () => {
         </div>
         <div className={styles.groupInfoRow}>
           <span>
-            {patientUuids.length} {t("members", "members")}
+            {patientUuids.length} {t('members', 'members')}
           </span>
         </div>
       </div>
       {activeSessionMeta?.sessionNotes && (
         <div className={styles.groupMeataContent}>
           <div className={`${styles.groupInfoRow} ${styles.sessionNotesLabel}`}>
-            {t("sessionNotes", "Session Notes")}
-          </div>
-          <div className={styles.groupInfoRow}>
-            {activeSessionMeta.sessionNotes}
+            {t('sessionNotes', 'Session Notes')}
           </div>
+          <div className={styles.groupInfoRow}>{activeSessionMeta.sessionNotes}</div>
         </div>
       )}
       <span style={{ flexGrow: 1 }} />
       <span>
         <Button kind="ghost" onClick={() => unsetGroup()}>
-          {t("changeGroup", "Choose a different group")} <Close size={20} />
+          {t('changeGroup', 'Choose a different group')} <Close size={20} />
         </Button>
       </span>
       <span>
         <Button kind="ghost" onClick={() => destroySession()}>
-          {t("cancel", "Cancel")} <Close size={20} />
+          {t('cancel', 'Cancel')} <Close size={20} />
         </Button>
       </span>
     </div>

package/src/group-form-entry-workflow/group-display-header/index.ts

@@ -1,3 +1,3 @@
-import GroupDisplayHeader from "./GroupDisplayHeader";
+import GroupDisplayHeader from './GroupDisplayHeader';
 
 export default GroupDisplayHeader;

package/src/group-form-entry-workflow/group-display-header/styles.scss

@@ -1,26 +1,26 @@
-@use '@carbon/styles/scss/spacing';
-@use '@carbon/styles/scss/type';
-@import '~@openmrs/esm-styleguide/src/vars';
+@use '@carbon/colors';
+@use '@carbon/layout';
+@use '@carbon/type';
 
 .container {
-  height: spacing.$spacing-11;
+  height: layout.$spacing-11;
   display: flex;
   align-items: center;
-  background-color: $ui-02;
-  border-top: 0.0125rem solid $ui-03;
-  border-bottom: 0.0125rem solid $ui-03;
-  padding: 0 spacing.$spacing-05;
+  background-color: colors.$white-0;
+  border-top: 0.0125rem solid colors.$gray-20;
+  border-bottom: 0.0125rem solid colors.$gray-20;
+  padding: 0 layout.$spacing-05;
 }
 
 .photoPlaceholder {
-  height: spacing.$spacing-09;
-  width: spacing.$spacing-09;
+  height: layout.$spacing-09;
+  width: layout.$spacing-09;
 }
 
 .groupAvatar {
-  width: spacing.$spacing-09;
-  height: spacing.$spacing-09;
-  margin: spacing.$spacing-03 spacing.$spacing-05 spacing.$spacing-03 0;
+  width: layout.$spacing-09;
+  height: layout.$spacing-09;
+  margin: layout.$spacing-03 layout.$spacing-05 layout.$spacing-03 0;
   border-radius: 1px;
 }
 
@@ -30,29 +30,29 @@
 }
 
 .groupInfoContent {
-  margin-left: spacing.$spacing-05;
-  margin-right: spacing.$spacing-10;
+  margin-left: layout.$spacing-05;
+  margin-right: layout.$spacing-10;
 }
 
 .groupInfoRow {
   display: flex;
   align-items: center;
   & > button {
-    min-height: spacing.$spacing-07;
+    min-height: layout.$spacing-07;
   }
   @include type.type-style('body-compact-02');
-  color: $text-02;
+  color: colors.$gray-70;
   column-gap: 0.8rem;
 
 }
 .sessionNotesLabel {
   @include type.type-style('label-01');
-  margin-bottom: spacing.$spacing-01
+  margin-bottom: layout.$spacing-01
 }
 
 .groupEditBtn {
-  color: $ui-05;
-  margin: spacing.$spacing-03;
+  color: colors.$gray-100;
+  margin: layout.$spacing-03;
 }
 
 .groupMetaContent {