@aehrc/smart-forms-renderer 1.2.10 → 1.2.12

package/src/stores/questionnaireStore.ts

@@ -39,6 +39,7 @@ import type { Variables } from '../interfaces/variables.interface';
 import { processCalculatedExpressions } from '../utils/calculatedExpression';
 import { applyComputedUpdates } from '../utils/computedUpdates';
 import {
+  assignPopulatedAnswersToEnableWhen,
   mutateRepeatEnableWhenItemInstances,
   updateEnableWhenItemAnswer
 } from '../utils/enableWhen';
@@ -441,6 +442,7 @@ export const questionnaireStore = createStore<QuestionnaireStoreType>()((set, ge
 
     4. Re-run calculatedExpressions as a final step to ensure all calculations are up-to-date, incorporating any toggled options or dynamic value set changes.
     5. Update store state based on the expressions that changed
+    6. (If initial update) Initialise enableWhen items
     */
 
     const {
@@ -450,6 +452,7 @@ export const questionnaireStore = createStore<QuestionnaireStoreType>()((set, ge
       variables,
       targetConstraints,
       answerOptionsToggleExpressions,
+      enableWhenItems,
       enableWhenExpressions,
       processedValueSets,
       calculatedExpressions,
@@ -471,6 +474,8 @@ export const questionnaireStore = createStore<QuestionnaireStoreType>()((set, ge
         enableWhenExpressions?: EnableWhenExpressions;
         answerOptionsToggleExpressions?: Record<string, AnswerOptionsToggleExpression[]>;
         processedValueSets?: Record<string, ProcessedValueSet>;
+        enableWhenItems?: EnableWhenItems;
+        enableWhenLinkedQuestions?: Record<string, string[]>;
       }
     ) {
       // Update QuestionnaireStore state
@@ -489,6 +494,12 @@ export const questionnaireStore = createStore<QuestionnaireStoreType>()((set, ge
         }),
         ...(otherExpressions?.processedValueSets && {
           processedValueSets: otherExpressions.processedValueSets
+        }),
+        ...(otherExpressions?.enableWhenItems && {
+          enableWhenItems: otherExpressions.enableWhenItems
+        }),
+        ...(otherExpressions?.enableWhenLinkedQuestions && {
+          enableWhenLinkedQuestions: otherExpressions.enableWhenLinkedQuestions
         })
       }));
 
@@ -573,6 +584,8 @@ export const questionnaireStore = createStore<QuestionnaireStoreType>()((set, ge
       enableWhenExpressions: EnableWhenExpressions;
       answerOptionsToggleExpressions: Record<string, AnswerOptionsToggleExpression[]>;
       processedValueSets: Record<string, ProcessedValueSet>;
+      enableWhenItems: EnableWhenItems;
+      enableWhenLinkedQuestions: Record<string, string[]>;
     }> = {};
     if (targetConstraintsUpdate.isUpdated) {
       otherExpressionsToUpdate.targetConstraints = targetConstraintsUpdate.value;
@@ -588,6 +601,16 @@ export const questionnaireStore = createStore<QuestionnaireStoreType>()((set, ge
       otherExpressionsToUpdate.processedValueSets = processedValueSetsUpdate.value;
     }
 
+    // Step 6: Evaluate enableWhen on the first update
+    if (isInitialUpdate) {
+      const {
+        initialisedItems: initialisedEnableWhenItems,
+        linkedQuestions: initialisedEnableWhenLinkedQuestions
+      } = assignPopulatedAnswersToEnableWhen(enableWhenItems, lastUpdatedResponse);
+      otherExpressionsToUpdate.enableWhenItems = initialisedEnableWhenItems;
+      otherExpressionsToUpdate.enableWhenLinkedQuestions = initialisedEnableWhenLinkedQuestions;
+    }
+
     updateStoreState(
       lastUpdatedResponse,
       updatedCalculatedExpressions,

package/src/utils/extensions.ts

@@ -15,7 +15,13 @@
  * limitations under the License.
  */
 
-import type { Coding, Extension, QuestionnaireItem, QuestionnaireItemAnswerOption } from 'fhir/r4';
+import type {
+  Coding,
+  Element,
+  Extension,
+  QuestionnaireItem,
+  QuestionnaireItemAnswerOption
+} from 'fhir/r4';
 import type { RegexValidation } from '../interfaces/regex.interface';
 import { structuredDataCapture } from 'fhir-sdc-helpers';
 import { default as htmlParse } from 'html-react-parser';
@@ -160,8 +166,8 @@ export function getXHtmlString(qItem: QuestionnaireItem): string | null {
  *
  * @author Sean Fong
  */
-export function getMarkdownString(qItem: QuestionnaireItem): string | null {
-  const extension = qItem._text?.extension?.find(
+export function getMarkdownString(element: Element | undefined): string | null {
+  const extension = element?.extension?.find(
     (extension: Extension) =>
       extension.url === 'http://hl7.org/fhir/StructureDefinition/rendering-markdown'
   );

package/src/utils/manageForm.ts

@@ -117,6 +117,7 @@ export async function buildForm(params: BuildFormParams): Promise<void> {
   }
 
   // QR is set to undefined here to prevent it from being initialised twice. This is defined like that for backward compatibility purposes.
+  // Warning: setting the QR here breaks pre-pop. For initialisation logic, do it in questionnaireStore.getState().updateExpressions() with isInitialUpdate=true.
   await questionnaireStore
     .getState()
     .buildSourceQuestionnaire(

package/src/utils/qrItem.ts

@@ -312,3 +312,15 @@ export function updateQrNestedItems(
     return;
   }
 }
+
+/**
+ * Gets the Id of the QR Item, if it has a Calculated Expression, then it returns a new Id, else it returns the passed Id.
+ *
+ * @author Janardhan Vignarajan
+ */
+export function getQRItemId(answerKey: string | undefined) {
+  // If the answerKey is through CalculatedExpression, then we assign a new random ID so that it does not fire again when user changes the value
+  return answerKey && answerKey.includes('calculatedExpression')
+    ? Math.random().toString(36).slice(2)
+    : answerKey;
+}

package/lib/components/FormComponents/ItemParts/AccessibleFeedback.d.ts

@@ -1,7 +0,0 @@
-import { type ReactNode } from 'react';
-interface AccessibleFeedbackProps {
-    children: ReactNode;
-    id?: string;
-}
-declare function AccessibleFeedback(props: AccessibleFeedbackProps): import("react/jsx-runtime").JSX.Element;
-export default AccessibleFeedback;

package/lib/components/FormComponents/ItemParts/AccessibleFeedback.js

@@ -1,7 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-function AccessibleFeedback(props) {
-    const { children, id } = props;
-    return (_jsx("span", { id: id, role: "alert", "aria-live": "assertive", children: children }));
-}
-export default AccessibleFeedback;
-//# sourceMappingURL=AccessibleFeedback.js.map

package/lib/components/FormComponents/ItemParts/AccessibleFeedback.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AccessibleFeedback.js","sourceRoot":"","sources":["../../../../src/components/FormComponents/ItemParts/AccessibleFeedback.tsx"],"names":[],"mappings":";AAwBA,SAAS,kBAAkB,CAAC,KAA8B;IACxD,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC;IAE/B,OAAO,CACL,eAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAC,OAAO,eAAW,WAAW,YAC7C,QAAQ,GACJ,CACR,CAAC;AACJ,CAAC;AAED,eAAe,kBAAkB,CAAC"}

package/lib/interfaces/itemPath.interface.d.ts

@@ -1,31 +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/lib/interfaces/itemPath.interface.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=itemPath.interface.js.map

package/lib/interfaces/itemPath.interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"itemPath.interface.js","sourceRoot":"","sources":["../../src/interfaces/itemPath.interface.ts"],"names":[],"mappings":""}

package/lib/utils/itemPath.d.ts

@@ -1,57 +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 declare function createSingleItemPath(linkId: string, repeatIndex?: number): ItemPath;
-/**
- * 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 declare function extendItemPath(currentPath:    linkId: string): ItemPath;
-/**
- * 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 declare function appendRepeatIndexToLastSegment(path:    repeatIndex: number): ItemPath;
-/**
- * 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 declare function itemPathToFhirPathString(path: ItemPath): string;

package/lib/utils/itemPath.js

@@ -1,75 +0,0 @@
-/**
- * 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, repeatIndex) {
-    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, linkId) {
-    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, repeatIndex) {
-    if (path.length === 0)
-        return [];
-    const newPath = [...path];
-    newPath[path.length - 1] = Object.assign(Object.assign({}, 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) {
-    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.');
-}
-//# sourceMappingURL=itemPath.js.map

package/lib/utils/itemPath.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"itemPath.js","sourceRoot":"","sources":["../../src/utils/itemPath.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAc,EAAE,WAAoB;IACvE,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,WAAqB,EAAE,MAAc;IAClE,OAAO,CAAC,GAAG,WAAW,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,8BAA8B,CAAC,IAAc,EAAE,WAAmB;IAChF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEjC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,mCAAQ,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAE,WAAW,GAAE,CAAC;IACxE,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAc;IACrD,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;QACtB,MAAM,IAAI,GAAG,iBAAiB,OAAO,CAAC,MAAM,IAAI,CAAC;QACjD,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC;IACtD,CAAC,CAAC;SACD,IAAI,CAAC,QAAQ,CAAC,CAAC;AACpB,CAAC"}