@aehrc/smart-forms-renderer 1.0.0-alpha.98 → 1.0.0

package/src/hooks/useDecimalCalculatedExpression.ts

@@ -1,103 +0,0 @@
-/*
- * Copyright 2025 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 { useEffect, useState } from 'react';
-import type { QuestionnaireItem } from 'fhir/r4';
-import { useQuestionnaireStore } from '../stores';
-
-interface UseDecimalCalculatedExpression {
-  calcExpUpdated: boolean;
-}
-
-interface UseDecimalCalculatedExpressionProps {
-  qItem: QuestionnaireItem;
-  inputValue: string;
-  precision: number | null;
-  onChangeByCalcExpressionDecimal: (calcExpressionValue: number) => void;
-  onChangeByCalcExpressionNull: () => void;
-}
-
-function useDecimalCalculatedExpression(
-  props: UseDecimalCalculatedExpressionProps
-): UseDecimalCalculatedExpression {
-  const {
-    qItem,
-    inputValue,
-    precision,
-    onChangeByCalcExpressionDecimal,
-    onChangeByCalcExpressionNull
-  } = props;
-
-  const calculatedExpressions = useQuestionnaireStore.use.calculatedExpressions();
-
-  const [calcExpUpdated, setCalcExpUpdated] = useState(false);
-
-  useEffect(
-    () => {
-      const calcExpression = calculatedExpressions[qItem.linkId]?.find(
-        (exp) => exp.from === 'item'
-      );
-
-      if (!calcExpression) {
-        return;
-      }
-
-      // If both input and calculated value are falsy, there is nothing to update
-      const inputAndCalcValueAreBothFalsy = inputValue === '' && !calcExpression.value;
-      if (inputAndCalcValueAreBothFalsy) {
-        return;
-      }
-
-      // only update if calculated value is different from current value
-      if (
-        calcExpression.value !== inputValue &&
-        (typeof calcExpression.value === 'number' || calcExpression.value === null)
-      ) {
-        const calcExpressionValue =
-          typeof calcExpression.value === 'number' && typeof precision === 'number'
-            ? parseFloat(calcExpression.value.toFixed(precision))
-            : calcExpression.value;
-
-        // only update if calculated value is different from current value
-        if (calcExpressionValue !== parseFloat(inputValue)) {
-          // update ui to show calculated value changes
-          setCalcExpUpdated(true);
-          const timeoutId = setTimeout(() => {
-            setCalcExpUpdated(false);
-          }, 500);
-
-          // calculatedExpression value is null
-          if (calcExpressionValue === null) {
-            onChangeByCalcExpressionNull();
-            return () => clearTimeout(timeoutId);
-          }
-
-          // calculatedExpression value is a number
-          onChangeByCalcExpressionDecimal(calcExpressionValue);
-          return () => clearTimeout(timeoutId);
-        }
-      }
-    },
-    // Only trigger this effect if calculatedExpression of item changes
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [calculatedExpressions]
-  );
-
-  return { calcExpUpdated: calcExpUpdated };
-}
-
-export default useDecimalCalculatedExpression;

package/src/hooks/useIntegerCalculatedExpression.ts

@@ -1,93 +0,0 @@
-/*
- * Copyright 2025 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 { useEffect, useState } from 'react';
-import type { QuestionnaireItem } from 'fhir/r4';
-import { useQuestionnaireStore } from '../stores';
-
-interface UseIntegerCalculatedExpression {
-  calcExpUpdated: boolean;
-}
-
-interface useIntegerCalculatedExpressionProps {
-  qItem: QuestionnaireItem;
-  inputValue: string;
-  onChangeByCalcExpressionInteger: (calcExpressionValue: number) => void;
-  onChangeByCalcExpressionNull: () => void;
-}
-
-function useIntegerCalculatedExpression(
-  props: useIntegerCalculatedExpressionProps
-): UseIntegerCalculatedExpression {
-  const { qItem, inputValue, onChangeByCalcExpressionInteger, onChangeByCalcExpressionNull } =
-    props;
-
-  const calculatedExpressions = useQuestionnaireStore.use.calculatedExpressions();
-
-  const [calcExpUpdated, setCalcExpUpdated] = useState(false);
-
-  useEffect(
-    () => {
-      const calcExpression = calculatedExpressions[qItem.linkId]?.find(
-        (exp) => exp.from === 'item'
-      );
-
-      if (!calcExpression) {
-        return;
-      }
-
-      // If both input and calculated value are falsy, there is nothing to update
-      const inputAndCalcValueAreBothFalsy = inputValue === '' && !calcExpression.value;
-      if (inputAndCalcValueAreBothFalsy) {
-        return;
-      }
-
-      // only update if calculated value is different from current value
-      if (
-        calcExpression.value !== inputValue &&
-        (typeof calcExpression.value === 'number' || calcExpression.value === null)
-      ) {
-        const calcExpressionValue = calcExpression.value;
-
-        if (calcExpressionValue !== parseInt(inputValue)) {
-          // update ui to show calculated value changes
-          setCalcExpUpdated(true);
-          const timeoutId = setTimeout(() => {
-            setCalcExpUpdated(false);
-          }, 500);
-
-          // calculatedExpression value is null
-          if (calcExpressionValue === null) {
-            onChangeByCalcExpressionNull();
-            return () => clearTimeout(timeoutId);
-          }
-
-          // calculatedExpression value is a number
-          onChangeByCalcExpressionInteger(calcExpressionValue);
-          return () => clearTimeout(timeoutId);
-        }
-      }
-    },
-    // Only trigger this effect if calculatedExpression of item changes
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [calculatedExpressions]
-  );
-
-  return { calcExpUpdated: calcExpUpdated };
-}
-
-export default useIntegerCalculatedExpression;

package/src/hooks/useQuantityCalculatedExpression.ts

@@ -1,196 +0,0 @@
-/*
- * Copyright 2025 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 { useEffect, useState } from 'react';
-import type { QuestionnaireItem } from 'fhir/r4';
-import { useQuestionnaireStore, useTerminologyServerStore } from '../stores';
-import { validateCodePromise } from '../utils/valueSet';
-import type {
-  CodeParameter,
-  DisplayParameter,
-  SystemParameter
-} from '../interfaces/valueSet.interface';
-import { getItemTerminologyServerToUse } from '../utils/preferredTerminologyServer';
-
-interface UseQuantityCalculatedExpression {
-  calcExpUpdated: boolean;
-}
-
-interface UseQuantityCalculatedExpressionProps {
-  qItem: QuestionnaireItem;
-  inputValue: string;
-  precision: number | null;
-  onChangeByCalcExpressionDecimal: (newValue: number) => void;
-  onChangeByCalcExpressionQuantity: (
-    newValue: number,
-    newUnitSystem: string,
-    newUnitCode: string,
-    newUnitDisplay: string
-  ) => void;
-  onChangeByCalcExpressionNull: () => void;
-}
-
-function useQuantityCalculatedExpression(
-  props: UseQuantityCalculatedExpressionProps
-): UseQuantityCalculatedExpression {
-  const {
-    qItem,
-    inputValue,
-    precision,
-    onChangeByCalcExpressionDecimal,
-    onChangeByCalcExpressionQuantity,
-    onChangeByCalcExpressionNull
-  } = props;
-
-  const calculatedExpressions = useQuestionnaireStore.use.calculatedExpressions();
-
-  const itemPreferredTerminologyServers =
-    useQuestionnaireStore.use.itemPreferredTerminologyServers();
-  const defaultTerminologyServerUrl = useTerminologyServerStore.use.url();
-
-  const [calcExpUpdated, setCalcExpUpdated] = useState(false);
-
-  useEffect(
-    () => {
-      const calcExpression = calculatedExpressions[qItem.linkId]?.find(
-        (exp) => exp.from === 'item'
-      );
-
-      if (!calcExpression) {
-        return;
-      }
-
-      // If both input and calculated value are falsy, there is nothing to update
-      const inputAndCalcValueAreBothFalsy = inputValue === '' && !calcExpression.value;
-      if (inputAndCalcValueAreBothFalsy) {
-        return;
-      }
-
-      // only update if calculated value is different from current value
-      if (
-        calcExpression.value !== inputValue &&
-        (typeof calcExpression.value === 'number' ||
-          typeof calcExpression.value === 'string' ||
-          calcExpression.value === null)
-      ) {
-        // Null path
-        if (calcExpression.value === null) {
-          onChangeByCalcExpressionNull();
-          return;
-        }
-
-        // Number path
-        if (typeof calcExpression.value === 'number') {
-          const calcExpressionValue =
-            typeof precision === 'number'
-              ? parseFloat(calcExpression.value.toFixed(precision))
-              : calcExpression.value;
-
-          // only update if calculated value is different from current value
-          if (calcExpressionValue !== parseFloat(inputValue)) {
-            // update ui to show calculated value changes
-            setCalcExpUpdated(true);
-            const timeoutId = setTimeout(() => {
-              setCalcExpUpdated(false);
-            }, 500);
-
-            // calculatedExpression value is null
-            if (calcExpressionValue === null) {
-              onChangeByCalcExpressionNull();
-              return () => clearTimeout(timeoutId);
-            }
-
-            // calculatedExpression value is a number
-            onChangeByCalcExpressionDecimal(calcExpressionValue);
-            return () => clearTimeout(timeoutId);
-          }
-        }
-
-        // String path (quantity)
-        if (typeof calcExpression.value === 'string') {
-          try {
-            const [value, unitCode] = calcExpression.value.split(' ');
-            const unitCodeFormatted = unitCode.replace(/'/g, '');
-
-            const ucumValueSet = 'http://hl7.org/fhir/ValueSet/ucum-units';
-            const ucumSystem = 'http://unitsofmeasure.org';
-
-            const terminologyServerUrl = getItemTerminologyServerToUse(
-              qItem,
-              itemPreferredTerminologyServers,
-              defaultTerminologyServerUrl
-            );
-
-            validateCodePromise(
-              ucumValueSet,
-              ucumSystem,
-              unitCodeFormatted,
-              terminologyServerUrl
-            ).then((validateCodeResponse) => {
-              // Return early if validate-code request fails
-              if (!validateCodeResponse) {
-                onChangeByCalcExpressionNull();
-                return;
-              }
-
-              if (validateCodeResponse.parameter) {
-                const systemParameter = validateCodeResponse.parameter.find(
-                  (p) => p.name === 'system'
-                ) as SystemParameter;
-                const codeParameter = validateCodeResponse.parameter.find(
-                  (p) => p.name === 'code'
-                ) as CodeParameter;
-                const displayParameter = validateCodeResponse.parameter.find(
-                  (p) => p.name === 'display'
-                ) as DisplayParameter;
-                if (
-                  systemParameter.valueUri &&
-                  codeParameter.valueCode &&
-                  displayParameter.valueString
-                ) {
-                  // update ui to show calculated value changes
-                  setCalcExpUpdated(true);
-                  const timeoutId = setTimeout(() => {
-                    setCalcExpUpdated(false);
-                  }, 500);
-
-                  onChangeByCalcExpressionQuantity(
-                    parseFloat(value),
-                    systemParameter.valueUri,
-                    codeParameter.valueCode,
-                    displayParameter.valueString
-                  );
-                  return () => clearTimeout(timeoutId);
-                }
-              }
-            });
-          } catch (e) {
-            console.error(e);
-            onChangeByCalcExpressionNull();
-          }
-        }
-      }
-    },
-    // Only trigger this effect if calculatedExpression of item changes
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [calculatedExpressions]
-  );
-
-  return { calcExpUpdated: calcExpUpdated };
-}
-
-export default useQuantityCalculatedExpression;

package/src/hooks/useShowFeedback.ts

@@ -1,36 +0,0 @@
-/*
- * Copyright 2025 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 { useState } from 'react';
-
-/**
- * Custom React hook to manage validation feedback visibility based on user interaction with a form field (e.g., input or blur events).
- * Shows feedback after the field has been blurred at least once.
- */
-function useShowFeedback() {
-  const [showFeedback, setShowFeedback] = useState(true);
-  const [hasBlurred, setHasBlurred] = useState(false);
-
-  return {
-    showFeedback,
-    setShowFeedback,
-    hasBlurred,
-    setHasBlurred
-  };
-}
-
-export default useShowFeedback;

package/src/hooks/useStringCalculatedExpression.ts

@@ -1,95 +0,0 @@
-/*
- * Copyright 2025 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 { useEffect, useState } from 'react';
-import type { QuestionnaireItem } from 'fhir/r4';
-import { useQuestionnaireStore } from '../stores';
-
-interface UseStringCalculatedExpression {
-  calcExpUpdated: boolean;
-}
-
-interface useStringCalculatedExpressionProps {
-  qItem: QuestionnaireItem;
-  inputValue: string;
-  onChangeByCalcExpressionString: (newValueString: string) => void;
-  onChangeByCalcExpressionNull: () => void;
-}
-
-function useStringCalculatedExpression(
-  props: useStringCalculatedExpressionProps
-): UseStringCalculatedExpression {
-  const { qItem, inputValue, onChangeByCalcExpressionString, onChangeByCalcExpressionNull } = props;
-
-  const calculatedExpressions = useQuestionnaireStore.use.calculatedExpressions();
-
-  const [calcExpUpdated, setCalcExpUpdated] = useState(false);
-
-  useEffect(
-    () => {
-      const calcExpression = calculatedExpressions[qItem.linkId]?.find(
-        (exp) => exp.from === 'item'
-      );
-
-      if (!calcExpression) {
-        return;
-      }
-
-      // If both input and calculated value are falsy, there is nothing to update
-      const inputAndCalcValueAreBothFalsy = inputValue === '' && !calcExpression.value;
-      if (inputAndCalcValueAreBothFalsy) {
-        return;
-      }
-
-      // only update if calculated value is different from current value
-      if (
-        calcExpression.value !== inputValue &&
-        (typeof calcExpression.value === 'string' ||
-          typeof calcExpression.value === 'number' ||
-          calcExpression.value === null)
-      ) {
-        // update ui to show calculated value changes
-        setCalcExpUpdated(true);
-        const timeoutId = setTimeout(() => {
-          setCalcExpUpdated(false);
-        }, 500);
-
-        // calculatedExpression value is null
-        if (calcExpression.value === null) {
-          onChangeByCalcExpressionNull();
-          return () => clearTimeout(timeoutId);
-        }
-
-        // calculatedExpression value is a string or number
-        const newInputValue =
-          typeof calcExpression.value === 'string'
-            ? calcExpression.value
-            : calcExpression.value.toString();
-
-        onChangeByCalcExpressionString(newInputValue);
-        return () => clearTimeout(timeoutId);
-      }
-    },
-    // Only trigger this effect if calculatedExpression of item changes
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [calculatedExpressions]
-  );
-
-  return { calcExpUpdated: calcExpUpdated };
-}
-
-export default useStringCalculatedExpression;

package/src/interfaces/itemPath.interface.ts

@@ -1,33 +0,0 @@
-/**
- * Represents a single step in the path to an item within a nested QuestionnaireResponse.
- * Each step is identified by its `linkId`, and optionally a `repeatIndex` if the item
- * occurs within a repeating group.
- */
-export interface ItemPathSegment {
-  /** The `linkId` of the QuestionnaireResponseItem at this path segment. */
-  linkId: string;
-
-  /**
-   * The index of the repeated item if this segment occurs within a repeating group.
-   * Omitted if the item is not part of a repeating group.
-   */
-  repeatIndex?: number;
-}
-
-/**
- * Represents a full path from the root of a QuestionnaireResponse to a deeply nested item.
- * Each segment corresponds to one level of the item hierarchy.
- *
- * Example:
- * [
- *   { linkId: 'sectionA' },
- *   { linkId: 'groupB', repeatIndex: 1 },
- *   { linkId: 'questionC' }
- * ]
- *
- * This path navigates through `sectionA`, into the second instance of `groupB`,
- * and finally to `questionC`.
- *
- * @author Sean Fong
- */
-export type ItemPath = ItemPathSegment[];

package/src/utils/itemPath.ts

@@ -1,79 +0,0 @@
-import type { ItemPath } from '../interfaces/itemPath.interface';
-
-/**
- * Creates an `ItemPath` containing a single segment for the given `linkId`.
- * This is useful when you want to construct a path to a specific item without referencing its ancestry,
- * such as when working with top-level items or when only the item's identity is relevant.
- *
- * @param linkId - The `linkId` of the item.
- * @param repeatIndex - (Optional) If the item is part of a repeating group, specify its index.
- * @returns An `ItemPath` containing one segment.
- *
- * @example
- * ```ts
- * const path = createSingleItemPath('question-1');
- * // Output: [{ linkId: 'question-1' }]
- *
- * const pathWithRepeat = createSingleItemPath('question-1', 2);
- * // Output: [{ linkId: 'question-1', repeatIndex: 2 }]
- * ```
- */
-export function createSingleItemPath(linkId: string, repeatIndex?: number): ItemPath {
-  return repeatIndex !== undefined ? [{ linkId, repeatIndex }] : [{ linkId }];
-}
-
-/**
- * Creates a new `ItemPath` by extending the given path with a new segment for the provided `linkId`.
- * This version does NOT include a `repeatIndex`. If repeat handling is needed,
- * use `appendRepeatIndexToLastSegment` after extending.
- *
- * @param currentPath - The existing item path.
- * @param linkId - The `linkId` to use in the new path segment.
- * @returns A new `ItemPath` with the added segment.
- */
-export function extendItemPath(currentPath: ItemPath, linkId: string): ItemPath {
-  return [...currentPath, { linkId }];
-}
-
-/**
- * Returns a new `ItemPath` with a `repeatIndex` applied to the last segment.
- * Useful for denoting which repetition of a group is being accessed.
- *
- * @param path - The item path to modify.
- * @param repeatIndex - The index to assign to the final segment.
- * @returns A new `ItemPath` with the last segment modified to include `repeatIndex`.
- *
- * @example
- * const basePath = [{ linkId: 'groupA' }, { linkId: 'groupB' }];
- * appendRepeatIndexToLastSegment(basePath, 2);
- * // → [{ linkId: 'groupA' }, { linkId: 'groupB', repeatIndex: 2 }]
- */
-export function appendRepeatIndexToLastSegment(path: ItemPath, repeatIndex: number): ItemPath {
-  if (path.length === 0) return [];
-
-  const newPath = [...path];
-  newPath[path.length - 1] = { ...newPath[path.length - 1], repeatIndex };
-  return newPath;
-}
-
-/**
- * Converts an `ItemPath` to a FHIRPath-compatible string.
- *
- * For example, the path:
- * [
- *   { linkId: 'groupA' },
- *   { linkId: 'repeatingGroup', repeatIndex: 1 },
- *   { linkId: 'questionB' }
- * ]
- *
- * Returns: "item.where(linkId='groupA').item.where(linkId='repeatingGroup')[1].item.where(linkId='questionB')"
- */
-export function itemPathToFhirPathString(path: ItemPath): string {
-  return path
-    .map((segment, index) => {
-      const base = `where(linkId='${segment.linkId}')`;
-      const repeat = segment.repeatIndex !== undefined ? `[${segment.repeatIndex}]` : '';
-      return (index === 0 ? 'item.' : '') + base + repeat;
-    })
-    .join('.item.');
-}

package/src/utils/questionnaireStoreUtils/addAdditionalVariables.ts

@@ -1,52 +0,0 @@
-/*
- * Copyright 2025 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 { Extension } from 'fhir/r4';
-import type { Variables } from '../../interfaces/variables.interface';
-
-export function addAdditionalVariables(
-  existingVariables: Variables,
-  additionalVariables: Record<string, object>
-) {
-  for (const key in additionalVariables) {
-    const variable = additionalVariables[key];
-
-    if (variable && isVariable(variable)) {
-      const expression = variable.valueExpression;
-      if (expression && expression.language && expression.name) {
-        if (expression.language === 'text/fhirpath') {
-          existingVariables.fhirPathVariables['QuestionnaireLevel'].push(expression);
-        } else if (expression.language === 'application/x-fhir-query') {
-          existingVariables.xFhirQueryVariables[expression.name] = {
-            valueExpression: expression
-          };
-        }
-      }
-    }
-  }
-
-  return existingVariables;
-}
-
-function isVariable(variable: object): variable is Extension {
-  const v = variable as Extension;
-  return (
-    (v.url === 'http://hl7.org/fhir/StructureDefinition/variable' &&
-      v.valueExpression?.language === 'text/fhirpath') ||
-    v.valueExpression?.language === 'application/x-fhir-query'
-  );
-}