@aehrc/smart-forms-renderer 0.40.1 → 0.40.3

package/src/stories/storybookWrappers/IdRemoverButtonForStorybook.tsx

@@ -17,27 +17,24 @@
 
 // @ts-ignore
 import React from 'react';
-import type { QuestionnaireResponse } from 'fhir/r4';
+import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
 import { Box, IconButton, Tooltip } from '@mui/material';
 import ContentCutIcon from '@mui/icons-material/ContentCut';
+import { useQuestionnaireResponseStore } from '../../stores';
+import { removeInternalIdsFromResponse } from '../../utils/manageForm';
 
 interface IdRemoverButtonProps {
+  questionnaire: Questionnaire;
   questionnaireResponse: QuestionnaireResponse;
 }
 
 function IdRemoverButtonForStorybook(props: IdRemoverButtonProps) {
-  const { questionnaireResponse } = props;
+  const { questionnaire, questionnaireResponse } = props;
 
-  async function handleRemoveIds() {
-    console.log('handle remove IDs');
+  const updateResponse = useQuestionnaireResponseStore.use.updateResponse();
 
-    // return buildForm()
-    // updateQuestionnaireResponse(
-    //   questionnaire,
-    //   populatedResponse,
-    //   initialiseItemCalculatedExpressionValueRecursive,
-    //   calculatedExpressionsWithValues
-    // );
+  async function handleRemoveIds() {
+    updateResponse(removeInternalIdsFromResponse(questionnaire, questionnaireResponse));
   }
 
   return (

package/src/stories/storybookWrappers/IdRemoverDebuggerWrapperForStorybook.tsx

@@ -48,7 +48,7 @@ function IdRemoverDebuggerWrapperForStorybook(props: IdRemoverDebuggerWrapperFor
 
   const isBuilding = useBuildForm(
     questionnaire,
-    undefined,
+    questionnaireResponse,
     undefined,
     STORYBOOK_TERMINOLOGY_SERVER_URL
   );
@@ -63,7 +63,10 @@ function IdRemoverDebuggerWrapperForStorybook(props: IdRemoverDebuggerWrapperFor
         <div>
           <Grid container>
             <Grid item xs={6}>
-              <IdRemoverButtonForStorybook questionnaireResponse={questionnaireResponse} />
+              <IdRemoverButtonForStorybook
+                questionnaire={questionnaire}
+                questionnaireResponse={updatableResponse}
+              />
               <BaseRenderer />
             </Grid>
             <Grid item xs={6}>

package/src/theme/palette.ts

@@ -77,10 +77,6 @@ const palette: PaletteOptions = {
     secondary: grey['600'],
     disabled: grey['500']
   },
-  background: {
-    paper: '#fff',
-    default: grey['50']
-  },
   customBackground: {
     neutral: '#F4F6F8'
   },

package/src/utils/groupTable.ts

@@ -32,6 +32,6 @@ export function reorderRows(
 
 export function getGroupTableItemsToUpdate(tableRows: GroupTableRowModel[], selectedIds: string[]) {
   return tableRows
-    .filter((row) => selectedIds.includes(row.nanoId))
+    .filter((row) => selectedIds.includes(row.id))
     .flatMap((singleRow) => (singleRow.qrItem ? [cloneDeep(singleRow.qrItem)] : []));
 }

package/src/utils/index.ts

@@ -15,7 +15,13 @@
  * limitations under the License.
  */
 
-export { buildForm, destroyForm, getResponse, removeEmptyAnswersFromResponse } from './manageForm';
+export {
+  buildForm,
+  destroyForm,
+  getResponse,
+  removeEmptyAnswersFromResponse,
+  removeInternalIdsFromResponse
+} from './manageForm';
 export { initialiseQuestionnaireResponse } from './initialise';
 export { isSpecificItemControl } from './itemControl';
 export { isRepeatItemAndNotCheckbox } from './qItem';

package/src/utils/initialise.ts

@@ -58,6 +58,10 @@ export function initialiseQuestionnaireResponse(
     questionnaireResponse.status = 'in-progress';
   }
 
+  // if (!questionnaireResponse.id) {
+  //   questionnaireResponse.id = 'in-progress';
+  // }
+
   const firstTopLevelItem = questionnaire?.item?.[0];
   if (firstTopLevelItem && !questionnaireResponse.item) {
     const initialItems = readQuestionnaireResponse(

package/src/utils/manageForm.ts

@@ -10,6 +10,8 @@ import { removeEmptyAnswers } from './removeEmptyAnswers';
 import { readEncounter, readPatient, readUser } from '../api/smartClient';
 import type Client from 'fhirclient/lib/Client';
 import cloneDeep from 'lodash.clonedeep';
+import { updateQuestionnaireResponse } from './genericRecursive';
+import { removeInternalRepeatIdsRecursive } from './removeRepeatId';
 
 /**
  * Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
@@ -96,7 +98,11 @@ export async function initialiseFhirClient(fhirClient: Client): Promise<void> {
  * @author Sean Fong
  */
 export function getResponse(): QuestionnaireResponse {
-  return cloneDeep(questionnaireResponseStore.getState().updatableResponse);
+  const cleanResponse = removeInternalIdsFromResponse(
+    questionnaireStore.getState().sourceQuestionnaire,
+    questionnaireResponseStore.getState().updatableResponse
+  );
+  return cloneDeep(cleanResponse);
 }
 
 /**
@@ -123,6 +129,26 @@ export function removeEmptyAnswersFromResponse(
   });
 }
 
+/**
+ * Remove all instances of item.answer.id from the filled QuestionnaireResponse.
+ * These IDs are used internally for rendering repeating items, and can be safely left out of the final response.
+ *
+ * @author Sean Fong
+ */
+export function removeInternalIdsFromResponse(
+  questionnaire: Questionnaire,
+  questionnaireResponse: QuestionnaireResponse
+): QuestionnaireResponse {
+  const questionnaireResponseToUpdate = cloneDeep(questionnaireResponse);
+
+  return updateQuestionnaireResponse(
+    questionnaire,
+    questionnaireResponseToUpdate,
+    removeInternalRepeatIdsRecursive,
+    undefined
+  );
+}
+
 /**
  * Check if a QuestionnaireResponseItem has either an item or an answer property.
  *

package/src/utils/removeRepeatId.ts

@@ -0,0 +1,113 @@
+/*
+ * Copyright 2024 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type {
+  QuestionnaireItem,
+  QuestionnaireResponseItem,
+  QuestionnaireResponseItemAnswer
+} from 'fhir/r4';
+import { getQrItemsIndex, mapQItemsIndex } from './mapItem';
+
+export function removeInternalRepeatIdsRecursive(
+  qItem: QuestionnaireItem,
+  qrItemOrItems: QuestionnaireResponseItem | QuestionnaireResponseItem[] | null
+): QuestionnaireResponseItem | QuestionnaireResponseItem[] | null {
+  // Process repeating group items separately
+  const hasMultipleAnswers = Array.isArray(qrItemOrItems);
+  if (hasMultipleAnswers) {
+    return removeInternalRepeatIdsFromRepeatGroup(qItem, qrItemOrItems);
+  }
+
+  // At this point qrItemOrItems is a single QuestionnaireResponseItem
+  const qrItem = qrItemOrItems;
+
+  // Process items with child items
+  const childQItems = qItem.item ?? [];
+  const childQrItems = qrItem?.item ?? [];
+  const updatedChildQrItems: QuestionnaireResponseItem[] = [];
+  if (childQItems.length > 0) {
+    const indexMap = mapQItemsIndex(qItem);
+    const qrItemsByIndex = getQrItemsIndex(childQItems, childQrItems, indexMap);
+
+    // Iterate child items
+    for (const [index, childQItem] of childQItems.entries()) {
+      const childQRItemOrItems = qrItemsByIndex[index];
+
+      const updatedChildQRItemOrItems = removeInternalRepeatIdsRecursive(
+        childQItem,
+        childQRItemOrItems ?? null
+      );
+
+      if (Array.isArray(updatedChildQRItemOrItems)) {
+        if (updatedChildQRItemOrItems.length > 0) {
+          updatedChildQrItems.push(...updatedChildQRItemOrItems);
+        }
+        continue;
+      }
+
+      if (updatedChildQRItemOrItems) {
+        updatedChildQrItems.push(updatedChildQRItemOrItems);
+      }
+    }
+  }
+
+  // Construct updated qrItem
+  return removeInternalRepeatIdsFromItem(qItem, qrItem, updatedChildQrItems);
+}
+
+function removeInternalRepeatIdsFromRepeatGroup(
+  qItem: QuestionnaireItem,
+  qrItems: QuestionnaireResponseItem[]
+) {
+  if (!qItem.item) {
+    return [];
+  }
+
+  return qrItems
+    .flatMap((childQrItem) => removeInternalRepeatIdsRecursive(qItem, childQrItem))
+    .filter((childQRItem): childQRItem is QuestionnaireResponseItem => !!childQRItem);
+}
+
+function removeInternalRepeatIdsFromItem(
+  qItem: QuestionnaireItem,
+  qrItem: QuestionnaireResponseItem | null,
+  childQrItems: QuestionnaireResponseItem[]
+): QuestionnaireResponseItem | null {
+  if (!qrItem) {
+    return null;
+  }
+
+  // Remove internal repeatId from all answers
+  const updatedAnswers: QuestionnaireResponseItemAnswer[] =
+    qrItem.answer
+      ?.map(
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        ({ id, ...rest }) => {
+          return {
+            ...rest
+          };
+        }
+      )
+      .filter((answer) => !!answer && Object.keys(answer).length > 0) ?? [];
+
+  return {
+    linkId: qItem.linkId,
+    ...(qItem.text && { text: qItem.text }),
+    ...(childQrItems.length > 0 && { item: childQrItems }),
+    ...(updatedAnswers.length > 0 && { answer: updatedAnswers })
+  };
+}

package/src/utils/repeatId.ts

@@ -18,10 +18,10 @@
 import { nanoid } from 'nanoid';
 
 export function generateNewRepeatId(linkId: string): string {
-  return `${linkId}-${nanoid()}`;
+  return `${linkId}-repeat-${nanoid()}`;
 }
 
 export function generateExistingRepeatId(linkId: string, index: number): string {
   const paddedIndex = index.toString().padStart(6, '0');
-  return `${linkId}-${paddedIndex}`;
+  return `${linkId}-repeat-${paddedIndex}`;
 }