@aehrc/smart-forms-renderer 0.27.2 → 0.27.4

package/src/stories/sdc/BehaviorCalculations.stories.tsx

@@ -0,0 +1,69 @@
+/*
+ * 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 { Meta, StoryObj } from '@storybook/react';
+import BuildFormWrapper from '../BuildFormWrapper';
+import {
+  qCalculatedExpressionBMICalculator,
+  qCalculatedExpressionCvdRiskCalculator,
+  qInitialExpression,
+  qLaunchContext,
+  qVariable
+} from '../assets/questionnaires';
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+const meta = {
+  title: 'Component/SDC/9.1.3 Form Behavior Calculations',
+  component: BuildFormWrapper,
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
+  tags: []
+} satisfies Meta<typeof BuildFormWrapper>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const LaunchContext: Story = {
+  args: {
+    questionnaire: qLaunchContext
+  }
+};
+
+export const Variable: Story = {
+  args: {
+    questionnaire: qVariable
+  }
+};
+
+export const InitialExpression: Story = {
+  args: {
+    questionnaire: qInitialExpression
+  }
+};
+
+export const CalculatedExpressionBMICalculator: Story = {
+  args: {
+    questionnaire: qCalculatedExpressionBMICalculator
+  }
+};
+
+export const CalculatedExpressionCvdRiskCalculator: Story = {
+  args: {
+    questionnaire: qCalculatedExpressionCvdRiskCalculator
+  }
+};

package/src/stories/sdc/BehaviorChoiceRestriction.stories.tsx

@@ -0,0 +1,76 @@
+/*
+ * 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 { Meta, StoryObj } from '@storybook/react';
+import BuildFormWrapper from '../BuildFormWrapper';
+import {
+  qAnswerExpression,
+  qAnswerOption,
+  qAnswerValueSet,
+  qReadOnlyDuplicate,
+  qRepeatsDuplicate,
+  qRequiredDuplicate
+} from '../assets/questionnaires';
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+const meta = {
+  title: 'Component/SDC/9.1.2 Form Behavior Choice Restriction',
+  component: BuildFormWrapper,
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
+  tags: ['autodocs']
+} satisfies Meta<typeof BuildFormWrapper>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const AnswerOption: Story = {
+  args: {
+    questionnaire: qAnswerOption
+  }
+};
+
+export const AnswerValueSet: Story = {
+  args: {
+    questionnaire: qAnswerValueSet
+  }
+};
+
+export const AnswerExpression: Story = {
+  args: {
+    questionnaire: qAnswerExpression
+  }
+};
+
+export const Required: Story = {
+  args: {
+    questionnaire: qRequiredDuplicate
+  }
+};
+
+export const Repeats: Story = {
+  args: {
+    questionnaire: qRepeatsDuplicate
+  }
+};
+
+export const ReadOnly: Story = {
+  args: {
+    questionnaire: qReadOnlyDuplicate
+  }
+};

package/src/stories/sdc/BehaviorOther.stories.tsx

@@ -0,0 +1,90 @@
+/*
+ * 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 { Meta, StoryObj } from '@storybook/react';
+import BuildFormWrapper from '../BuildFormWrapper';
+import {
+  qEnableBehaviorAll,
+  qEnableBehaviorAny,
+  qEnableWhen,
+  qEnableWhenExpressionSimple,
+  qEnableWhenExpressionTabs,
+  qInitialRepeats,
+  qInitialSingle,
+  qText
+} from '../assets/questionnaires'; // More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+const meta = {
+  title: 'Component/SDC/9.1.4 Form Behavior Other Control',
+  component: BuildFormWrapper,
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
+  tags: []
+} satisfies Meta<typeof BuildFormWrapper>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const InitialSingle: Story = {
+  args: {
+    questionnaire: qInitialSingle
+  }
+};
+
+export const InitialRepeats: Story = {
+  args: {
+    questionnaire: qInitialRepeats
+  }
+};
+
+export const EnableWhen: Story = {
+  args: {
+    questionnaire: qEnableWhen
+  }
+};
+
+export const EnableBehaviorAll: Story = {
+  args: {
+    questionnaire: qEnableBehaviorAll
+  }
+};
+
+export const EnableBehaviorAny: Story = {
+  args: {
+    questionnaire: qEnableBehaviorAny
+  }
+};
+
+export const EnableWhenExpressionSimple: Story = {
+  args: {
+    questionnaire: qEnableWhenExpressionSimple
+  }
+};
+
+export const EnableWhenExpressionTabs: Story = {
+  args: {
+    questionnaire: qEnableWhenExpressionTabs
+  }
+};
+
+export const Text: Story = {
+  args: {
+    questionnaire: qText
+  }
+};

package/src/stories/sdc/BehaviorValueConstraints.stories.tsx

@@ -0,0 +1,88 @@
+/*
+ * 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 { Meta, StoryObj } from '@storybook/react';
+import BuildFormWrapper from '../BuildFormWrapper';
+import {
+  qMaxDecimalPlaces,
+  qMaxLength,
+  qMaxValue,
+  qMinLength,
+  qMinValue,
+  qRegex,
+  qrMaxDecimalPlaces,
+  qrMaxLength,
+  qrMaxValue,
+  qrMinLength,
+  qrMinValue,
+  qrRegex
+} from '../assets/questionnaires'; // More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+const meta = {
+  title: 'Component/SDC/9.1.1 Form Behavior Value Constraints',
+  component: BuildFormWrapper,
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
+  tags: []
+} satisfies Meta<typeof BuildFormWrapper>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const MaxLength: Story = {
+  args: {
+    questionnaire: qMaxLength,
+    questionnaireResponse: qrMaxLength
+  }
+};
+
+export const MinLength: Story = {
+  args: {
+    questionnaire: qMinLength,
+    questionnaireResponse: qrMinLength
+  }
+};
+
+export const Regex: Story = {
+  args: {
+    questionnaire: qRegex,
+    questionnaireResponse: qrRegex
+  }
+};
+
+export const MinValue: Story = {
+  args: {
+    questionnaire: qMinValue,
+    questionnaireResponse: qrMinValue
+  }
+};
+
+export const MaxValue: Story = {
+  args: {
+    questionnaire: qMaxValue,
+    questionnaireResponse: qrMaxValue
+  }
+};
+
+export const MaxDecimalPlaces: Story = {
+  args: {
+    questionnaire: qMaxDecimalPlaces,
+    questionnaireResponse: qrMaxDecimalPlaces
+  }
+};

package/src/stories/sdc/ItemControlDisplay.stories.tsx

@@ -0,0 +1,39 @@
+/*
+ * 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 { Meta, StoryObj } from '@storybook/react';
+import BuildFormWrapper from '../BuildFormWrapper';
+import { qItemControlDisplayLowerAndUpper } from '../assets/questionnaires'; // More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+const meta = {
+  title: 'Component/SDC/8.1.2 Advanced Control Appearance - Item Control Display',
+  component: BuildFormWrapper,
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
+  tags: []
+} satisfies Meta<typeof BuildFormWrapper>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const LowerAndUpper: Story = {
+  args: {
+    questionnaire: qItemControlDisplayLowerAndUpper
+  }
+};

package/src/stories/sdc/ItemControlGroup.stories.tsx

@@ -0,0 +1,55 @@
+/*
+ * 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 { Meta, StoryObj } from '@storybook/react';
+import BuildFormWrapper from '../BuildFormWrapper';
+import {
+  qItemControlDisplayTabContainer,
+  qItemControlGroupGrid,
+  qItemControlGroupGTable
+} from '../assets/questionnaires';
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+const meta = {
+  title: 'Component/SDC/8.1.2 Advanced Control Appearance - Item Control Group',
+  component: BuildFormWrapper,
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
+  tags: []
+} satisfies Meta<typeof BuildFormWrapper>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const Gtable: Story = {
+  args: {
+    questionnaire: qItemControlGroupGTable
+  }
+};
+
+export const Grid: Story = {
+  args: {
+    questionnaire: qItemControlGroupGrid
+  }
+};
+
+export const TabContainer: Story = {
+  args: {
+    questionnaire: qItemControlDisplayTabContainer
+  }
+};

package/src/stories/sdc/ItemControlQuestion.stories.tsx

@@ -0,0 +1,118 @@
+/*
+ * 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 { Meta, StoryObj } from '@storybook/react';
+import BuildFormWrapper from '../BuildFormWrapper';
+import {
+  qChoiceCheckboxAnswerOption,
+  qChoiceCheckboxAnswerValueSet,
+  qChoiceDropDownAnswerOption,
+  qChoiceDropDownAnswerValueSet,
+  qChoiceRadioAnswerOption,
+  qChoiceRadioAnswerValueSet,
+  qOpenChoiceAutocomplete,
+  qOpenChoiceCheckboxAnswerOption,
+  qOpenChoiceCheckboxAnswerValueSet,
+  qOpenChoiceRadioAnswerOption,
+  qOpenChoiceRadioAnswerValueSet,
+  qSliderStepValue
+} from '../assets/questionnaires';
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+const meta = {
+  title: 'Component/SDC/8.1.2 Advanced Control Appearance - Item Control Question',
+  component: BuildFormWrapper,
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
+  tags: []
+} satisfies Meta<typeof BuildFormWrapper>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const AutocompleteOpenChoice: Story = {
+  args: {
+    questionnaire: qOpenChoiceAutocomplete
+  }
+};
+
+export const DropDownChoiceAnswerOption: Story = {
+  args: {
+    questionnaire: qChoiceDropDownAnswerOption
+  }
+};
+
+export const DropDownChoiceAnswerValueSet: Story = {
+  args: {
+    questionnaire: qChoiceDropDownAnswerValueSet
+  }
+};
+
+export const CheckboxChoiceAnswerOption: Story = {
+  args: {
+    questionnaire: qChoiceCheckboxAnswerOption
+  }
+};
+
+export const CheckboxChoiceAnswerValueSet: Story = {
+  args: {
+    questionnaire: qChoiceCheckboxAnswerValueSet
+  }
+};
+
+export const CheckboxOpenChoiceAnswerOption: Story = {
+  args: {
+    questionnaire: qOpenChoiceCheckboxAnswerOption
+  }
+};
+
+export const CheckboxOpenChoiceAnswerValueSet: Story = {
+  args: {
+    questionnaire: qOpenChoiceCheckboxAnswerValueSet
+  }
+};
+
+export const RadioChoiceAnswerOption: Story = {
+  args: {
+    questionnaire: qChoiceRadioAnswerOption
+  }
+};
+
+export const RadioChoiceAnswerValueSet: Story = {
+  args: {
+    questionnaire: qChoiceRadioAnswerValueSet
+  }
+};
+
+export const RadioOpenChoiceAnswerOption: Story = {
+  args: {
+    questionnaire: qOpenChoiceRadioAnswerOption
+  }
+};
+
+export const RadioOpenChoiceAnswerValueSet: Story = {
+  args: {
+    questionnaire: qOpenChoiceRadioAnswerValueSet
+  }
+};
+
+export const SliderInteger: Story = {
+  args: {
+    questionnaire: qSliderStepValue
+  }
+};

package/src/utils/buildForm.ts

@@ -0,0 +1,23 @@
+import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
+import { questionnaireResponseStore, questionnaireStore } from '../stores';
+import { initialiseQuestionnaireResponse } from './initialise';
+
+/**
+ * Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
+ * If a QuestionnaireResponse is not provided, an empty QuestionnaireResponse is set as the initial QuestionnaireResponse.
+ *
+ * @author Sean Fong
+ */
+export async function buildForm(
+  questionnaire: Questionnaire,
+  questionnaireResponse?: QuestionnaireResponse
+): Promise<void> {
+  await questionnaireStore.getState().buildSourceQuestionnaire(questionnaire);
+
+  const initialisedQuestionnaireResponse = initialiseQuestionnaireResponse(
+    questionnaire,
+    questionnaireResponse
+  );
+  questionnaireResponseStore.getState().buildSourceResponse(initialisedQuestionnaireResponse);
+  questionnaireStore.getState().updatePopulatedProperties(initialisedQuestionnaireResponse);
+}

package/src/utils/choice.ts

@@ -149,17 +149,20 @@ export function getQrChoiceValue(
  *
  * @author Sean Fong
  */
-export function updateQrCheckboxAnswers(
+export function updateChoiceCheckboxAnswers(
   changedValue: string,
   answers: QuestionnaireResponseItemAnswer[],
-  answerOptions: QuestionnaireItemAnswerOption[],
-  qrChoiceCheckbox: QuestionnaireResponseItem,
+  options: QuestionnaireItemAnswerOption[],
+  oldQrItem: QuestionnaireResponseItem,
   isMultiSelection: boolean
 ): QuestionnaireResponseItem | null {
   // search for answer item of changedValue from list of answer options
-  const newAnswer = findInAnswerOptions(answerOptions, changedValue);
-  if (!newAnswer) return null;
+  const newAnswer = findInAnswerOptions(options, changedValue);
+  if (!newAnswer) {
+    return null;
+  }
 
+  // Process multi-selection
   if (isMultiSelection && answers.length > 0) {
     // check and filter if new answer exists in existing qrAnswers
     const updatedAnswers = answers.filter(
@@ -171,12 +174,15 @@ export function updateQrCheckboxAnswers(
       updatedAnswers.push(newAnswer);
     }
 
-    return { ...qrChoiceCheckbox, answer: updatedAnswers };
-  } else {
-    return answers.some((answer) => JSON.stringify(answer) === JSON.stringify(newAnswer))
-      ? { ...qrChoiceCheckbox, answer: [] }
-      : { ...qrChoiceCheckbox, answer: [newAnswer] };
+    return { ...oldQrItem, answer: updatedAnswers };
   }
+
+  // Process single selection
+  // If answer already exists, remove it from the array. Otherwise, add it to the array
+  const answerExists = answers.some(
+    (answer) => JSON.stringify(answer) === JSON.stringify(newAnswer)
+  );
+  return answerExists ? { ...oldQrItem, answer: [] } : { ...oldQrItem, answer: [newAnswer] };
 }
 
 /**
@@ -203,16 +209,3 @@ export function getChoiceOrientation(qItem: QuestionnaireItem): ChoiceItemOrient
 
   return null;
 }
-
-/**
- * Converts an array of codings to an array of valueCodings which can use the QuestionnaireItemAnswerOption type
- *
- * @author Sean Fong
- */
-export function mapCodingsToOptions(codings: Coding[]): QuestionnaireItemAnswerOption[] {
-  return codings.map((coding) => {
-    return {
-      valueCoding: coding
-    };
-  });
-}

package/src/utils/enableWhen.ts

@@ -349,18 +349,16 @@ export function checkItemIsEnabledSingle(
         );
 
         // In a repeat item, if at least one answer satisfies the condition, the item is enabled
-        if (isEnabledForThisLinkedItem) {
-          checkedIsEnabledItems.push(isEnabledAnswerTypeSwitcher(linkedItem.enableWhen, answer));
-          break;
-        }
+        // FIXME need to look further at this
+        checkedIsEnabledItems.push(isEnabledForThisLinkedItem);
+        break;
       }
       continue;
     }
 
     // Linked item doesn't have any answers, but we still have to check for unanswered booleans
-    if (evaluateNonExistentAnswers(linkedItem.enableWhen)) {
-      checkedIsEnabledItems.push(true);
-    }
+    const checkedNonExistentAnswer = evaluateNonExistentAnswers(linkedItem.enableWhen);
+    checkedIsEnabledItems.push(checkedNonExistentAnswer);
   }
 
   if (checkedIsEnabledItems.length === 0) {

package/src/utils/index.ts

@@ -23,3 +23,4 @@ export {
   setInitialAnswers
 } from './enableWhen';
 export { initialiseQuestionnaireResponse } from './initialise';
+export { buildForm } from './buildForm';