@aehrc/smart-forms-renderer 0.3.0 → 0.5.0

package/src/components/FormComponents/Tables/Table.styles.tsx

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2023 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 { styled, TableCell } from '@mui/material';
+
+export const HeaderTableCell = styled(TableCell)(() => ({
+  fontSize: 13,
+  lineHeight: 'normal'
+}));
+
+export const StandardTableCell = styled(TableCell, {
+  shouldForwardProp: (prop) => prop !== 'numOfColumns' && prop !== 'isFirst'
+})<{ numOfColumns: number; isFirst: boolean }>(({ numOfColumns, isFirst }) => ({
+  width: `${100 / numOfColumns}%`,
+  paddingLeft: isFirst ? 8 : 4,
+  paddingRight: 4
+}));
+
+export const DeleteButtonTableCell = styled(TableCell)(() => ({
+  paddingLeft: 0,
+  paddingRight: 4
+}));
+
+export const GridTextTableCell = styled(TableCell)(({ theme }) => ({
+  width: '20%',
+  paddingLeft: '18px',
+  paddingRight: '18px',
+  color: theme.palette.text.secondary
+}));
+
+export const GridAnswerTableCell = styled(TableCell, {
+  shouldForwardProp: (prop) => prop !== 'numOfColumns'
+})<{ numOfColumns: number }>(({ numOfColumns }) => ({
+  width: `${80 / numOfColumns}%`,
+  paddingLeft: 5,
+  paddingRight: 5
+}));

package/src/components/FormComponents/TextItem/TextField.tsx

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2023 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 React from 'react';
+import { InputAdornment, TextField as MuiTextField } from '@mui/material';
+import FadingCheckIcon from '../ItemParts/FadingCheckIcon';
+
+interface TextFieldProps {
+  linkId: string;
+  input: string;
+  feedback: string;
+  displayPrompt: string;
+  displayUnit: string;
+  entryFormat: string;
+  readOnly: boolean;
+  calcExpUpdated: boolean;
+  onInputChange: (value: string) => void;
+}
+
+function TextField(props: TextFieldProps) {
+  const {
+    linkId,
+    input,
+    feedback,
+    displayPrompt,
+    displayUnit,
+    entryFormat,
+    readOnly,
+    calcExpUpdated,
+    onInputChange
+  } = props;
+
+  return (
+    <MuiTextField
+      id={linkId}
+      value={input}
+      error={!!feedback}
+      onChange={(event) => onInputChange(event.target.value)}
+      disabled={readOnly}
+      label={displayPrompt}
+      placeholder={entryFormat}
+      fullWidth
+      multiline
+      size="small"
+      minRows={3}
+      InputProps={{
+        endAdornment: (
+          <InputAdornment position={'end'}>
+            <FadingCheckIcon fadeIn={calcExpUpdated} />
+            {displayUnit}
+          </InputAdornment>
+        )
+      }}
+      helperText={feedback}
+      data-test="q-item-text-field"
+    />
+  );
+}
+
+export default TextField;

package/src/components/FormComponents/TextItem/TextItem.tsx

@@ -0,0 +1,128 @@
+/*
+ * Copyright 2023 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 React, { useCallback, useState } from 'react';
+import type {
+  PropsWithIsRepeatedAttribute,
+  PropsWithQrItemChangeHandler
+} from '../../../interfaces/renderProps.interface';
+import type { QuestionnaireItem, QuestionnaireResponseItem } from 'fhir/r4';
+import useRenderingExtensions from '../../../hooks/useRenderingExtensions';
+import useValidationError from '../../../hooks/useValidationError';
+import debounce from 'lodash.debounce';
+import { createEmptyQrItem } from '../../../utils/qrItem';
+import { DEBOUNCE_DURATION } from '../../../utils/debounce';
+import { FullWidthFormComponentBox } from '../../Box.styles';
+import TextField from './TextField';
+import useStringCalculatedExpression from '../../../hooks/useStringCalculatedExpression';
+import ItemFieldGrid from '../ItemParts/ItemFieldGrid';
+
+interface TextItemProps
+  extends PropsWithQrItemChangeHandler<QuestionnaireResponseItem>,
+    PropsWithIsRepeatedAttribute {
+  qItem: QuestionnaireItem;
+  qrItem: QuestionnaireResponseItem;
+}
+
+function TextItem(props: TextItemProps) {
+  const { qItem, qrItem, isRepeated, onQrItemChange } = props;
+
+  // Get additional rendering extensions
+  const {
+    displayUnit,
+    displayPrompt,
+    displayInstructions,
+    readOnly,
+    entryFormat,
+    regexValidation,
+    maxLength
+  } = useRenderingExtensions(qItem);
+
+  // Init input value
+  let valueText = '';
+  if (qrItem?.answer && qrItem?.answer[0].valueString) {
+    valueText = qrItem.answer[0].valueString;
+  }
+  const [input, setInput] = useState(valueText);
+
+  // Perform validation checks
+  const feedback = useValidationError(input, regexValidation, maxLength);
+
+  // Process calculated expressions
+  const { calcExpUpdated } = useStringCalculatedExpression({
+    qItem: qItem,
+    inputValue: input,
+    setInputValue: (value) => {
+      setInput(value);
+    },
+    onQrItemChange: onQrItemChange
+  });
+
+  // Event handlers
+  function handleInputChange(newInput: string) {
+    setInput(newInput);
+    updateQrItemWithDebounce(newInput);
+  }
+
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  const updateQrItemWithDebounce = useCallback(
+    debounce((input: string) => {
+      const emptyQrItem = createEmptyQrItem(qItem);
+      if (input !== '') {
+        onQrItemChange({ ...emptyQrItem, answer: [{ valueString: input.trim() }] });
+      } else {
+        onQrItemChange(emptyQrItem);
+      }
+    }, DEBOUNCE_DURATION),
+    [onQrItemChange, qItem]
+  ); // Dependencies are tested, debounce is causing eslint to not recognise dependencies
+
+  if (isRepeated) {
+    return (
+      <TextField
+        linkId={qItem.linkId}
+        input={input}
+        feedback={feedback}
+        displayPrompt={displayPrompt}
+        displayUnit={displayUnit}
+        entryFormat={entryFormat}
+        readOnly={readOnly}
+        calcExpUpdated={calcExpUpdated}
+        onInputChange={handleInputChange}
+      />
+    );
+  }
+  return (
+    <FullWidthFormComponentBox data-test="q-item-text-box">
+      <ItemFieldGrid qItem={qItem} displayInstructions={displayInstructions}>
+        <TextField
+          linkId={qItem.linkId}
+          input={input}
+          feedback={feedback}
+          displayPrompt={displayPrompt}
+          displayUnit={displayUnit}
+          entryFormat={entryFormat}
+          readOnly={readOnly}
+          calcExpUpdated={calcExpUpdated}
+          onInputChange={handleInputChange}
+        />
+      </ItemFieldGrid>
+    </FullWidthFormComponentBox>
+  );
+}
+
+export default TextItem;

package/src/components/FormComponents/Textfield.styles.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2023 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 { styled, TextField } from '@mui/material';
+
+// Always use this accompanied by the TextField prop fullWidth
+export const StandardTextField = styled(TextField, {
+  shouldForwardProp: (prop) => prop !== 'isTabled'
+})<{ isTabled: boolean }>(({ isTabled }) => ({
+  // Set 280 as the standard width for a field
+  // Set a theoretical infinite maxWidth if field is within a table to fill the table row
+  maxWidth: !isTabled ? 280 : 3000,
+  minWidth: 160
+}));

package/src/components/FormComponents/TimeItem/TimeField.tsx

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2023 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 React from 'react';
+import type { PropsWithIsTabledAttribute } from '../../../interfaces/renderProps.interface';
+import type { Dayjs } from 'dayjs';
+import { LocalizationProvider, TimePicker as MuiTimePicker } from '@mui/x-date-pickers';
+import { AdapterDayjs } from '@mui/x-date-pickers/AdapterDayjs';
+
+interface TimeFieldProps extends PropsWithIsTabledAttribute {
+  value: Dayjs | null;
+  displayPrompt: string;
+  entryFormat: string;
+  readOnly: boolean;
+  onTimeChange: (newValue: Dayjs | null) => unknown;
+}
+
+function TimeField(props: TimeFieldProps) {
+  const { value, displayPrompt, entryFormat, readOnly, isTabled, onTimeChange } = props;
+
+  return (
+    <LocalizationProvider dateAdapter={AdapterDayjs}>
+      <MuiTimePicker
+        format={entryFormat !== '' ? entryFormat : 'hh:mm a'}
+        value={value}
+        disabled={readOnly}
+        label={displayPrompt}
+        sx={{ maxWidth: !isTabled ? 280 : 3000, minWidth: 160 }}
+        slotProps={{
+          textField: {
+            fullWidth: true
+          }
+        }}
+        onChange={onTimeChange}
+      />
+    </LocalizationProvider>
+  );
+}
+
+export default TimeField;

package/src/components/FormComponents/TimeItem/TimeItem.tsx

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2023 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 React from 'react';
+import type {
+  PropsWithIsRepeatedAttribute,
+  PropsWithIsTabledAttribute,
+  PropsWithQrItemChangeHandler
+} from '../../../interfaces/renderProps.interface';
+import type { QuestionnaireItem, QuestionnaireResponseItem } from 'fhir/r4';
+import useRenderingExtensions from '../../../hooks/useRenderingExtensions';
+import { createEmptyQrItem } from '../../../utils/qrItem';
+import { FullWidthFormComponentBox } from '../../Box.styles';
+import TimeField from './TimeField';
+import type { Dayjs } from 'dayjs';
+import dayjs from 'dayjs';
+import ItemFieldGrid from '../ItemParts/ItemFieldGrid';
+
+interface TimeItemProps
+  extends PropsWithQrItemChangeHandler<QuestionnaireResponseItem>,
+    PropsWithIsRepeatedAttribute,
+    PropsWithIsTabledAttribute {
+  qItem: QuestionnaireItem;
+  qrItem: QuestionnaireResponseItem;
+}
+
+function TimeItem(props: TimeItemProps) {
+  const { qItem, qrItem, isRepeated, isTabled, onQrItemChange } = props;
+
+  // Get additional rendering extensions
+  const { displayPrompt, displayInstructions, readOnly, entryFormat } =
+    useRenderingExtensions(qItem);
+
+  // Init input value
+  let timeString: string | null = null;
+  if (qrItem?.answer && qrItem?.answer[0].valueTime) {
+    timeString = qrItem.answer[0].valueTime;
+  }
+  const timeDayJs = timeString ? dayjs(timeString) : null;
+
+  // Event handlers
+  function handleTimeChange(newValue: Dayjs | null) {
+    const emptyQrItem = createEmptyQrItem(qItem);
+    if (newValue) {
+      onQrItemChange({ ...emptyQrItem, answer: [{ valueTime: newValue.format() }] });
+    } else {
+      onQrItemChange(emptyQrItem);
+    }
+  }
+
+  if (isRepeated) {
+    return (
+      <TimeField
+        value={timeDayJs}
+        displayPrompt={displayPrompt}
+        entryFormat={entryFormat}
+        readOnly={readOnly}
+        onTimeChange={handleTimeChange}
+        isTabled={isTabled}
+      />
+    );
+  }
+
+  return (
+    <FullWidthFormComponentBox>
+      <ItemFieldGrid qItem={qItem} displayInstructions={displayInstructions}>
+        <TimeField
+          value={timeDayJs}
+          displayPrompt={displayPrompt}
+          entryFormat={entryFormat}
+          readOnly={readOnly}
+          onTimeChange={handleTimeChange}
+          isTabled={isTabled}
+        />
+      </ItemFieldGrid>
+    </FullWidthFormComponentBox>
+  );
+}
+
+export default TimeItem;

package/src/components/FormComponents/Typography.styles.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2023 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 { styled, Typography } from '@mui/material';
+
+export const QGroupHeadingTypography = styled(Typography, {
+  shouldForwardProp: (prop) => prop !== 'isTabHeading'
+})<{ isTabHeading?: boolean }>(({ isTabHeading }) => ({
+  fontSize: isTabHeading ? 16 : 15
+}));

package/src/components/FormComponents/UrlItem/UrlField.tsx

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023 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 React from 'react';
+import type { PropsWithIsTabledAttribute } from '../../../interfaces/renderProps.interface';
+import { InputAdornment } from '@mui/material';
+import { StandardTextField } from '../Textfield.styles';
+
+interface UrlFieldProps extends PropsWithIsTabledAttribute {
+  linkId: string;
+  input: string;
+  feedback: string;
+  displayPrompt: string;
+  displayUnit: string;
+  entryFormat: string;
+  readOnly: boolean;
+  onInputChange: (value: string) => void;
+}
+
+function UrlField(props: UrlFieldProps) {
+  const {
+    linkId,
+    input,
+    feedback,
+    displayPrompt,
+    displayUnit,
+    entryFormat,
+    readOnly,
+    isTabled,
+    onInputChange
+  } = props;
+
+  return (
+    <StandardTextField
+      fullWidth
+      isTabled={isTabled}
+      id={linkId}
+      value={input}
+      error={!!feedback}
+      onChange={(event) => onInputChange(event.target.value)}
+      label={displayPrompt}
+      placeholder={entryFormat}
+      disabled={readOnly}
+      size="small"
+      InputProps={{ endAdornment: <InputAdornment position={'end'}>{displayUnit}</InputAdornment> }}
+      helperText={feedback}
+      data-test="q-item-url-field"
+    />
+  );
+}
+
+export default UrlField;

package/src/components/FormComponents/UrlItem/UrlItem.tsx

@@ -0,0 +1,118 @@
+/*
+ * Copyright 2023 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 React, { useCallback, useState } from 'react';
+import type {
+  PropsWithIsRepeatedAttribute,
+  PropsWithIsTabledAttribute,
+  PropsWithQrItemChangeHandler
+} from '../../../interfaces/renderProps.interface';
+import type { QuestionnaireItem, QuestionnaireResponseItem } from 'fhir/r4';
+import useRenderingExtensions from '../../../hooks/useRenderingExtensions';
+import useValidationError from '../../../hooks/useValidationError';
+import debounce from 'lodash.debounce';
+import { createEmptyQrItem } from '../../../utils/qrItem';
+import { DEBOUNCE_DURATION } from '../../../utils/debounce';
+import { FullWidthFormComponentBox } from '../../Box.styles';
+import UrlField from './UrlField';
+import ItemFieldGrid from '../ItemParts/ItemFieldGrid';
+
+interface UrlItemProps
+  extends PropsWithQrItemChangeHandler<QuestionnaireResponseItem>,
+    PropsWithIsRepeatedAttribute,
+    PropsWithIsTabledAttribute {
+  qItem: QuestionnaireItem;
+  qrItem: QuestionnaireResponseItem;
+}
+function UrlItem(props: UrlItemProps) {
+  const { qItem, qrItem, isRepeated, isTabled, onQrItemChange } = props;
+
+  // Get additional rendering extensions
+  const {
+    displayUnit,
+    displayPrompt,
+    displayInstructions,
+    readOnly,
+    entryFormat,
+    regexValidation,
+    maxLength
+  } = useRenderingExtensions(qItem);
+
+  // Init input value
+  let valueUri = '';
+  if (qrItem?.answer && qrItem?.answer[0].valueUri) {
+    valueUri = qrItem.answer[0].valueUri;
+  }
+  const [input, setInput] = useState(valueUri);
+
+  // Perform validation checks
+  const feedback = useValidationError(input, regexValidation, maxLength);
+
+  // Event handlers
+  function handleChange(newInput: string) {
+    setInput(newInput);
+    updateQrItemWithDebounce(newInput);
+  }
+
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  const updateQrItemWithDebounce = useCallback(
+    debounce((input: string) => {
+      const emptyQrItem = createEmptyQrItem(qItem);
+      if (input !== '') {
+        onQrItemChange({ ...emptyQrItem, answer: [{ valueUri: input }] });
+      } else {
+        onQrItemChange(emptyQrItem);
+      }
+    }, DEBOUNCE_DURATION),
+    [onQrItemChange, qItem]
+  ); // Dependencies are tested, debounce is causing eslint to not recognise dependencies
+
+  if (isRepeated) {
+    return (
+      <UrlField
+        linkId={qItem.linkId}
+        input={input}
+        feedback={feedback}
+        displayPrompt={displayPrompt}
+        displayUnit={displayUnit}
+        entryFormat={entryFormat}
+        readOnly={readOnly}
+        onInputChange={handleChange}
+        isTabled={isTabled}
+      />
+    );
+  }
+  return (
+    <FullWidthFormComponentBox data-test="q-item-string-box">
+      <ItemFieldGrid qItem={qItem} displayInstructions={displayInstructions}>
+        <UrlField
+          linkId={qItem.linkId}
+          input={input}
+          feedback={feedback}
+          displayPrompt={displayPrompt}
+          displayUnit={displayUnit}
+          entryFormat={entryFormat}
+          readOnly={readOnly}
+          onInputChange={handleChange}
+          isTabled={isTabled}
+        />
+      </ItemFieldGrid>
+    </FullWidthFormComponentBox>
+  );
+}
+
+export default UrlItem;