@aehrc/smart-forms-renderer 1.0.0-alpha.42.dev6 → 1.0.0-alpha.42.dev8

package/lib/interfaces/variables.interface.js

@@ -0,0 +1,18 @@
+/*
+ * 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.
+ */
+export {};
+//# sourceMappingURL=variables.interface.js.map

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

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

package/lib/stores/index.d.ts

@@ -0,0 +1,10 @@
+export type { QuestionnaireStoreType } from './questionnaireStore';
+export { questionnaireStore, useQuestionnaireStore } from './questionnaireStore';
+export type { QuestionnaireResponseStoreType } from './questionnaireResponseStore';
+export { questionnaireResponseStore, useQuestionnaireResponseStore } from './questionnaireResponseStore';
+export type { SmartConfigStoreType } from './smartConfigStore';
+export { smartConfigStore, useSmartConfigStore } from './smartConfigStore';
+export type { TerminologyServerStoreType } from './terminologyServerStore';
+export { terminologyServerStore, useTerminologyServerStore } from './terminologyServerStore';
+export type { RendererStyling, RendererStylingStoreType } from './rendererStylingStore';
+export { rendererStylingStore, useRendererStylingStore } from './rendererStylingStore';

package/lib/stores/index.js

@@ -0,0 +1,6 @@
+export { questionnaireStore, useQuestionnaireStore } from './questionnaireStore';
+export { questionnaireResponseStore, useQuestionnaireResponseStore } from './questionnaireResponseStore';
+export { smartConfigStore, useSmartConfigStore } from './smartConfigStore';
+export { terminologyServerStore, useTerminologyServerStore } from './terminologyServerStore';
+export { rendererStylingStore, useRendererStylingStore } from './rendererStylingStore';
+//# sourceMappingURL=index.js.map

package/lib/stores/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/stores/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAGjF,OAAO,EACL,0BAA0B,EAC1B,6BAA6B,EAC9B,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAG3E,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAG7F,OAAO,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC"}

package/lib/stores/questionnaireResponseStore.d.ts

@@ -0,0 +1,80 @@
+import type { OperationOutcome, Questionnaire, QuestionnaireResponse, QuestionnaireResponseItem } from 'fhir/r4';
+import type { Diff } from 'deep-diff';
+/**
+ * QuestionnaireResponseStore properties and methods
+ * Properties can be accessed for fine-grain details.
+ * Methods are usually used internally, but it is possible to use them externally to hook into the renderer for more fine-grain control.
+ *
+ * @property key - The React key of the questionnaireResponse, used internally for refreshing the BaseRenderer
+ * @property sourceResponse - The original response created when the form is first initialised i.e. empty, pre-populated, opened saved draft
+ * @property updatableResponse - The current state of the response that is being updated via form fields
+ * @property updatableResponseItems - Key-value pair of updatableResponse items `Record<linkId, QR.item(s)>`
+ * @property formChangesHistory - Array of form changes history in the form of deep-diff objects
+ * @property invalidItems - Key-value pair of invalid items based on defined value constraints in the questionnaire `Record<linkId, OperationOutcome>`
+ * @property requiredItemsIsHighlighted - Required items are not highlighted by default (to provide a less-jarring UX), but can be manually toggled to be highlighted
+ * @property responseIsValid - Whether there are any invalid items in the response
+ * @property validateQuestionnaireResponse - Used to validate the questionnaire response based on the questionnaire
+ * @property buildSourceResponse - Used to build the source response when the form is first initialised
+ * @property setUpdatableResponseAsPopulated - Used to set a pre-populated response as the current response
+ * @property updateResponse - Used to update the current response
+ * @property setUpdatableResponseAsSaved - Used to set a saved response as the current response
+ * @property setUpdatableResponseAsEmpty - Used to set an empty response as the current response
+ * @property destroySourceResponse - Used to destroy the source response  and reset all properties
+ * @property highlightRequiredItems - Used to highlight invalid items and show error feedback in the UI
+ *
+ * @author Sean Fong
+ */
+export interface QuestionnaireResponseStoreType {
+    key: string;
+    sourceResponse: QuestionnaireResponse;
+    updatableResponse: QuestionnaireResponse;
+    updatableResponseItems: Record<string, QuestionnaireResponseItem[]>;
+    formChangesHistory: (Diff<QuestionnaireResponse, QuestionnaireResponse>[] | null)[];
+    invalidItems: Record<string, OperationOutcome>;
+    requiredItemsIsHighlighted: boolean;
+    responseIsValid: boolean;
+    validateQuestionnaire: (questionnaire: Questionnaire, updatedResponse: QuestionnaireResponse) => void;
+    buildSourceResponse: (response: QuestionnaireResponse) => void;
+    setUpdatableResponseAsPopulated: (populatedResponse: QuestionnaireResponse) => void;
+    updateResponse: (updatedResponse: QuestionnaireResponse) => void;
+    setUpdatableResponseAsSaved: (savedResponse: QuestionnaireResponse) => void;
+    setUpdatableResponseAsEmpty: (clearedResponse: QuestionnaireResponse) => void;
+    destroySourceResponse: () => void;
+    highlightRequiredItems: () => void;
+}
+/**
+ * QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaireResponse.
+ * This is the vanilla version of the store which can be used in non-React environments.
+ * @see QuestionnaireResponseStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+export declare const questionnaireResponseStore: import("zustand/vanilla").StoreApi<QuestionnaireResponseStoreType>;
+/**
+ * QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaire.
+ * This is the React version of the store which can be used as React hooks in React functional components.
+ * @see QuestionnaireResponseStoreType for available properties and methods.
+ * @see questionnaireResponseStore for the vanilla store.
+ *
+ * @author Sean Fong
+ */
+export declare const useQuestionnaireResponseStore: import("zustand/vanilla").StoreApi<QuestionnaireResponseStoreType> & {
+    use: {
+        key: () => string;
+        sourceResponse: () => QuestionnaireResponse;
+        updatableResponse: () => QuestionnaireResponse;
+        updatableResponseItems: () => Record<string, QuestionnaireResponseItem[]>;
+        formChangesHistory: () => (Diff<QuestionnaireResponse, QuestionnaireResponse>[] | null)[];
+        invalidItems: () => Record<string, OperationOutcome>;
+        requiredItemsIsHighlighted: () => boolean;
+        responseIsValid: () => boolean;
+        validateQuestionnaire: () => (questionnaire: Questionnaire, updatedResponse: QuestionnaireResponse) => void;
+        buildSourceResponse: () => (response: QuestionnaireResponse) => void;
+        setUpdatableResponseAsPopulated: () => (populatedResponse: QuestionnaireResponse) => void;
+        updateResponse: () => (updatedResponse: QuestionnaireResponse) => void;
+        setUpdatableResponseAsSaved: () => (savedResponse: QuestionnaireResponse) => void;
+        setUpdatableResponseAsEmpty: () => (clearedResponse: QuestionnaireResponse) => void;
+        destroySourceResponse: () => () => void;
+        highlightRequiredItems: () => () => void;
+    };
+};

package/lib/stores/questionnaireResponseStore.js

@@ -0,0 +1,140 @@
+/*
+ * 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 { createStore } from 'zustand/vanilla';
+import { emptyResponse } from '../utils/emptyResource';
+import { diff } from 'deep-diff';
+import { createSelectors } from './selector';
+import { validateForm } from '../utils/validate';
+import { questionnaireStore } from './questionnaireStore';
+import { createQuestionnaireResponseItemMap } from '../utils/questionnaireResponseStoreUtils/updatableResponseItems';
+import { generateUniqueId } from '../utils/extractObservation';
+/**
+ * QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaireResponse.
+ * This is the vanilla version of the store which can be used in non-React environments.
+ * @see QuestionnaireResponseStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+export const questionnaireResponseStore = createStore()((set, get) => ({
+    key: 'QR-initial-key',
+    sourceResponse: structuredClone(emptyResponse),
+    updatableResponse: structuredClone(emptyResponse),
+    updatableResponseItems: {},
+    formChangesHistory: [],
+    invalidItems: {},
+    requiredItemsIsHighlighted: false,
+    responseIsValid: true,
+    validateQuestionnaire: (questionnaire, updatedResponse) => {
+        const updatedInvalidItems = validateForm(questionnaire, updatedResponse);
+        set(() => ({
+            invalidItems: updatedInvalidItems,
+            responseIsValid: Object.keys(updatedInvalidItems).length === 0
+        }));
+    },
+    buildSourceResponse: (questionnaireResponse) => {
+        const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
+        const initialInvalidItems = validateForm(sourceQuestionnaire, questionnaireResponse);
+        set(() => ({
+            key: generateUniqueId('QR'),
+            sourceResponse: questionnaireResponse,
+            updatableResponse: questionnaireResponse,
+            updatableResponseItems: createQuestionnaireResponseItemMap(sourceQuestionnaire, questionnaireResponse),
+            invalidItems: initialInvalidItems,
+            requiredItemsIsHighlighted: false,
+            responseIsValid: Object.keys(initialInvalidItems).length === 0
+        }));
+    },
+    setUpdatableResponseAsPopulated: (populatedResponse) => {
+        var _a;
+        const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
+        const formChanges = (_a = diff(get().updatableResponse, populatedResponse)) !== null && _a !== void 0 ? _a : null;
+        const updatedInvalidItems = validateForm(sourceQuestionnaire, populatedResponse);
+        set(() => ({
+            sourceResponse: populatedResponse,
+            updatableResponse: populatedResponse,
+            updatableResponseItems: createQuestionnaireResponseItemMap(sourceQuestionnaire, populatedResponse),
+            formChangesHistory: [...get().formChangesHistory, formChanges],
+            invalidItems: updatedInvalidItems,
+            requiredItemsIsHighlighted: false,
+            responseIsValid: Object.keys(updatedInvalidItems).length === 0
+        }));
+    },
+    updateResponse: (updatedResponse) => {
+        var _a;
+        const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
+        const formChanges = (_a = diff(get().updatableResponse, updatedResponse)) !== null && _a !== void 0 ? _a : null;
+        const updatedInvalidItems = validateForm(sourceQuestionnaire, updatedResponse);
+        set(() => ({
+            updatableResponse: updatedResponse,
+            updatableResponseItems: createQuestionnaireResponseItemMap(sourceQuestionnaire, updatedResponse),
+            formChangesHistory: [...get().formChangesHistory, formChanges],
+            invalidItems: updatedInvalidItems,
+            responseIsValid: Object.keys(updatedInvalidItems).length === 0
+        }));
+    },
+    setUpdatableResponseAsSaved: (savedResponse) => {
+        const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
+        const updatedInvalidItems = validateForm(sourceQuestionnaire, savedResponse);
+        set(() => ({
+            key: generateUniqueId('QR'),
+            sourceResponse: savedResponse,
+            updatableResponse: savedResponse,
+            updatableResponseItems: createQuestionnaireResponseItemMap(sourceQuestionnaire, savedResponse),
+            formChangesHistory: [],
+            invalidItems: updatedInvalidItems,
+            responseIsValid: Object.keys(updatedInvalidItems).length === 0
+        }));
+    },
+    setUpdatableResponseAsEmpty: (clearedResponse) => {
+        const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
+        const updatedInvalidItems = validateForm(sourceQuestionnaire, clearedResponse);
+        set(() => ({
+            updatableResponse: clearedResponse,
+            updatableResponseItems: createQuestionnaireResponseItemMap(sourceQuestionnaire, clearedResponse),
+            formChangesHistory: [],
+            invalidItems: updatedInvalidItems,
+            requiredItemsIsHighlighted: false,
+            responseIsValid: Object.keys(updatedInvalidItems).length === 0
+        }));
+    },
+    destroySourceResponse: () => {
+        const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
+        set(() => ({
+            key: generateUniqueId('QR'),
+            sourceResponse: structuredClone(emptyResponse),
+            updatableResponse: structuredClone(emptyResponse),
+            updatableResponseItems: createQuestionnaireResponseItemMap(sourceQuestionnaire, structuredClone(emptyResponse)),
+            formChangesHistory: [],
+            invalidItems: {},
+            requiredItemsIsHighlighted: false,
+            responseIsValid: true
+        }));
+    },
+    highlightRequiredItems: () => set(() => ({
+        requiredItemsIsHighlighted: true
+    }))
+}));
+/**
+ * QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaire.
+ * This is the React version of the store which can be used as React hooks in React functional components.
+ * @see QuestionnaireResponseStoreType for available properties and methods.
+ * @see questionnaireResponseStore for the vanilla store.
+ *
+ * @author Sean Fong
+ */
+export const useQuestionnaireResponseStore = createSelectors(questionnaireResponseStore);
+//# sourceMappingURL=questionnaireResponseStore.js.map

package/lib/stores/questionnaireResponseStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"questionnaireResponseStore.js","sourceRoot":"","sources":["../../src/stores/questionnaireResponseStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAO9C,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,kCAAkC,EAAE,MAAM,iEAAiE,CAAC;AACrH,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAgD/D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,WAAW,EAAkC,CACrF,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACb,GAAG,EAAE,gBAAgB;IACrB,cAAc,EAAE,eAAe,CAAC,aAAa,CAAC;IAC9C,iBAAiB,EAAE,eAAe,CAAC,aAAa,CAAC;IACjD,sBAAsB,EAAE,EAAE;IAC1B,kBAAkB,EAAE,EAAE;IACtB,YAAY,EAAE,EAAE;IAChB,0BAA0B,EAAE,KAAK;IACjC,eAAe,EAAE,IAAI;IACrB,qBAAqB,EAAE,CACrB,aAA4B,EAC5B,eAAsC,EACtC,EAAE;QACF,MAAM,mBAAmB,GAAG,YAAY,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QAEzE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACT,YAAY,EAAE,mBAAmB;YACjC,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC;SAC/D,CAAC,CAAC,CAAC;IACN,CAAC;IACD,mBAAmB,EAAE,CAAC,qBAA4C,EAAE,EAAE;QACpE,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QAC9E,MAAM,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;QAErF,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACT,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC;YAC3B,cAAc,EAAE,qBAAqB;YACrC,iBAAiB,EAAE,qBAAqB;YACxC,sBAAsB,EAAE,kCAAkC,CACxD,mBAAmB,EACnB,qBAAqB,CACtB;YACD,YAAY,EAAE,mBAAmB;YACjC,0BAA0B,EAAE,KAAK;YACjC,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC;SAC/D,CAAC,CAAC,CAAC;IACN,CAAC;IACD,+BAA+B,EAAE,CAAC,iBAAwC,EAAE,EAAE;;QAC5E,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QAC9E,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,mCAAI,IAAI,CAAC;QAE7E,MAAM,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;QAEjF,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACT,cAAc,EAAE,iBAAiB;YACjC,iBAAiB,EAAE,iBAAiB;YACpC,sBAAsB,EAAE,kCAAkC,CACxD,mBAAmB,EACnB,iBAAiB,CAClB;YACD,kBAAkB,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,kBAAkB,EAAE,WAAW,CAAC;YAC9D,YAAY,EAAE,mBAAmB;YACjC,0BAA0B,EAAE,KAAK;YACjC,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC;SAC/D,CAAC,CAAC,CAAC;IACN,CAAC;IACD,cAAc,EAAE,CAAC,eAAsC,EAAE,EAAE;;QACzD,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QAC9E,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,EAAE,eAAe,CAAC,mCAAI,IAAI,CAAC;QAC3E,MAAM,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;QAE/E,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACT,iBAAiB,EAAE,eAAe;YAClC,sBAAsB,EAAE,kCAAkC,CACxD,mBAAmB,EACnB,eAAe,CAChB;YACD,kBAAkB,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,kBAAkB,EAAE,WAAW,CAAC;YAC9D,YAAY,EAAE,mBAAmB;YACjC,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC;SAC/D,CAAC,CAAC,CAAC;IACN,CAAC;IACD,2BAA2B,EAAE,CAAC,aAAoC,EAAE,EAAE;QACpE,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QAC9E,MAAM,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;QAE7E,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACT,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC;YAC3B,cAAc,EAAE,aAAa;YAC7B,iBAAiB,EAAE,aAAa;YAChC,sBAAsB,EAAE,kCAAkC,CACxD,mBAAmB,EACnB,aAAa,CACd;YACD,kBAAkB,EAAE,EAAE;YACtB,YAAY,EAAE,mBAAmB;YACjC,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC;SAC/D,CAAC,CAAC,CAAC;IACN,CAAC;IACD,2BAA2B,EAAE,CAAC,eAAsC,EAAE,EAAE;QACtE,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QAC9E,MAAM,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;QAE/E,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACT,iBAAiB,EAAE,eAAe;YAClC,sBAAsB,EAAE,kCAAkC,CACxD,mBAAmB,EACnB,eAAe,CAChB;YACD,kBAAkB,EAAE,EAAE;YACtB,YAAY,EAAE,mBAAmB;YACjC,0BAA0B,EAAE,KAAK;YACjC,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC;SAC/D,CAAC,CAAC,CAAC;IACN,CAAC;IACD,qBAAqB,EAAE,GAAG,EAAE;QAC1B,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QAC9E,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACT,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC;YAC3B,cAAc,EAAE,eAAe,CAAC,aAAa,CAAC;YAC9C,iBAAiB,EAAE,eAAe,CAAC,aAAa,CAAC;YACjD,sBAAsB,EAAE,kCAAkC,CACxD,mBAAmB,EACnB,eAAe,CAAC,aAAa,CAAC,CAC/B;YACD,kBAAkB,EAAE,EAAE;YACtB,YAAY,EAAE,EAAE;YAChB,0BAA0B,EAAE,KAAK;YACjC,eAAe,EAAE,IAAI;SACtB,CAAC,CAAC,CAAC;IACN,CAAC;IACD,sBAAsB,EAAE,GAAG,EAAE,CAC3B,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;QACT,0BAA0B,EAAE,IAAI;KACjC,CAAC,CAAC;CACN,CAAC,CACH,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,eAAe,CAAC,0BAA0B,CAAC,CAAC"}

package/lib/stores/questionnaireStore.d.ts

@@ -0,0 +1,169 @@
+import type { Coding, Questionnaire, QuestionnaireResponse, QuestionnaireResponseItemAnswer } from 'fhir/r4';
+import type { Variables } from '../interfaces/variables.interface';
+import type { LaunchContext } from '../interfaces/populate.interface';
+import type { CalculatedExpression } from '../interfaces/calculatedExpression.interface';
+import type { EnableWhenExpressions, EnableWhenItems } from '../interfaces/enableWhen.interface';
+import type { AnswerExpression } from '../interfaces/answerExpression.interface';
+import type { Tabs } from '../interfaces/tab.interface';
+import type { Pages } from '../interfaces/page.interface';
+import type { InitialExpression } from '../interfaces/initialExpression.interface';
+import type { QItemOverrideComponentProps, SdcUiOverrideComponentProps } from '../interfaces';
+import type { ComponentType } from 'react';
+import type { TargetConstraint } from '../interfaces/targetConstraint.interface';
+import type { ProcessedValueSet } from '../interfaces/valueSet.interface';
+import type { ComputedQRItemUpdates } from '../interfaces/computedUpdates.interface';
+/**
+ * QuestionnaireStore properties and methods
+ * Properties can be accessed for fine-grain details.
+ * Methods are usually used internally, using them from an external source is not recommended.
+ *
+ * @property sourceQuestionnaire - FHIR R4 Questionnaire to render
+ * @property itemTypes - Key-value pair of item types `Record<linkId, item.type>`
+ * @property itemPreferredTerminologyServers - Key-value pair of item types `Record<linkId, preferred terminology servers>`
+ * @property tabs - Key-value pair of tabs `Record<linkId, Tab>`
+ * @property currentTabIndex - Index of the current tab
+ * @property pages - Key-value pair of pages `Record<linkId, Page>`
+ * @property currentPageIndex - Index of the current page
+ * @property variables - Questionnaire variables object containing FHIRPath and x-fhir-query variables
+ * @property launchContexts - Key-value pair of launch contexts `Record<launch context name, launch context properties>`
+ * @property targetConstraints - Key-value pair of target constraints `Record<target constraint key, target constraint properties>`
+ * @property targetConstraintLinkIds - Key-value pair of linkIds against target constraint key(s) `Record<linkId, target constraint keys>`
+ * @property enableWhenItems - EnableWhenItems object containing enableWhen items and their linked questions
+ * @property enableWhenLinkedQuestions - Key-value pair of linked questions to enableWhen items `Record<linkId, linkIds of linked questions>`
+ * @property enableWhenIsActivated - Flag to turn enableWhen checks on/off
+ * @property enableWhenExpressions - EnableWhenExpressions object containing enableWhen expressions
+ * @property calculatedExpressions - Key-value pair of calculated expressions `Record<linkId, array of calculated expression properties>`
+ * @property answerExpressions - Key-value pair of answer expressions `Record<linkId, answer expression properties>`
+ * @property processedValueSets - Key-value pair of (pre-)processed value set codings `Record<valueSetUrl, ProcessedValueSet>`
+ * @property cachedValueSetCodings - Key-value pair of cached value set codings `Record<valueSetUrl, codings>`
+ * @property fhirPathContext - Key-value pair of evaluated FHIRPath values `Record<variable name, evaluated value(s)>`
+ * @property fhirPathTerminologyCache - Key-value pair of cached FHIRPath Terminology results `Record<cacheKey, cached terminology result>`
+ * @property populatedContext - Key-value pair of one-off pre-populated FHIRPath values `Record<variable/launchContext/sourceQueries batch name, evaluated value(s)>`
+ * @property qItemOverrideComponents - Key-value pair of React component overrides for Questionnaire Items via linkId `Record<linkId, React component>`
+ * @property sdcUiOverrideComponents - Key-value pair of React component overrides for SDC UI Controls https://hl7.org/fhir/extensions/ValueSet-questionnaire-item-control.html `Record<SDC UI code, React component>`
+ * @property focusedLinkId - LinkId of the currently focused item
+ * @property readOnly - Flag to set the form to read-only mode
+ * @property buildSourceQuestionnaire - Used to build the source questionnaire with the provided questionnaire and optionally questionnaire response, additional variables, terminology server url and readyOnly flag
+ * @property destroySourceQuestionnaire - Used to destroy the source questionnaire and reset all properties
+ * @property switchTab - Used to switch the current tab index
+ * @property switchPage - Used to switch the current page index
+ * @property markTabAsComplete - Used to mark a tab index as complete
+ * @property markPageAsComplete - Used to mark a page index as complete
+ * @property updateEnableWhenItem - Used to update linked enableWhen items by updating a question with a new answer
+ * @property mutateRepeatEnableWhenItems - Used to add or remove instances of repeating enableWhen items
+ * @property toggleEnableWhenActivation - Used to toggle enableWhen checks on/off
+ * @property updateExpressions - Used to update all SDC expressions based on the updated questionnaire response
+ * @property addCodingToCache - Used to add a coding to the cached value set codings
+ * @property updatePopulatedProperties - Used to update all SDC expressions based on a pre-populated questionnaire response
+ * @property onFocusLinkId - Used to set the focused linkId
+ * @property setPopulatedContext - Used to set the populated contexts (launchContext, sourceQueries, x-fhir-query vars) for debugging purposes, and optionally add to the FHIRPath context
+ * @property setFormAsReadOnly - Used to set the form as read-only
+ *
+ * @author Sean Fong
+ */
+export interface QuestionnaireStoreType {
+    sourceQuestionnaire: Questionnaire;
+    itemTypes: Record<string, string>;
+    itemPreferredTerminologyServers: Record<string, string>;
+    tabs: Tabs;
+    currentTabIndex: number;
+    pages: Pages;
+    currentPageIndex: number;
+    variables: Variables;
+    launchContexts: Record<string, LaunchContext>;
+    targetConstraints: Record<string, TargetConstraint>;
+    targetConstraintLinkIds: Record<string, string[]>;
+    enableWhenItems: EnableWhenItems;
+    enableWhenLinkedQuestions: Record<string, string[]>;
+    enableWhenIsActivated: boolean;
+    enableWhenExpressions: EnableWhenExpressions;
+    calculatedExpressions: Record<string, CalculatedExpression[]>;
+    initialExpressions: Record<string, InitialExpression>;
+    answerExpressions: Record<string, AnswerExpression>;
+    processedValueSets: Record<string, ProcessedValueSet>;
+    cachedValueSetCodings: Record<string, Coding[]>;
+    fhirPathContext: Record<string, any>;
+    fhirPathTerminologyCache: Record<string, any>;
+    populatedContext: Record<string, any>;
+    qItemOverrideComponents: Record<string, ComponentType<QItemOverrideComponentProps>>;
+    sdcUiOverrideComponents: Record<string, ComponentType<SdcUiOverrideComponentProps>>;
+    focusedLinkId: string;
+    readOnly: boolean;
+    buildSourceQuestionnaire: (questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse, additionalVariables?: Record<string, object>, terminologyServerUrl?: string, readOnly?: boolean, qItemOverrideComponents?: Record<string, ComponentType<QItemOverrideComponentProps>>, sdcUiOverrideComponents?: Record<string, ComponentType<SdcUiOverrideComponentProps>>) => Promise<void>;
+    destroySourceQuestionnaire: () => void;
+    switchTab: (newTabIndex: number) => void;
+    switchPage: (newPageIndex: number) => void;
+    markTabAsComplete: (tabLinkId: string) => void;
+    markPageAsComplete: (pageLinkId: string) => void;
+    updateEnableWhenItem: (linkId: string, newAnswer: QuestionnaireResponseItemAnswer[] | undefined, parentRepeatGroupIndex: number | null) => void;
+    mutateRepeatEnableWhenItems: (parentRepeatGroupLinkId: string, parentRepeatGroupIndex: number, actionType: 'add' | 'remove') => void;
+    toggleEnableWhenActivation: (isActivated: boolean) => void;
+    updateExpressions: (updatedResponse: QuestionnaireResponse) => Promise<ComputedQRItemUpdates>;
+    addCodingToCache: (valueSetUrl: string, codings: Coding[]) => void;
+    updatePopulatedProperties: (populatedResponse: QuestionnaireResponse, populatedContext?: Record<string, any>, persistTabIndex?: boolean) => Promise<QuestionnaireResponse>;
+    onFocusLinkId: (linkId: string) => void;
+    setPopulatedContext: (newPopulatedContext: Record<string, any>, addToFhirPathContext?: boolean) => void;
+    setFormAsReadOnly: (readOnly: boolean) => void;
+}
+/**
+ * Questionnaire state management store which contains all properties and methods to manage the state of the questionnaire.
+ * This is the vanilla version of the store which can be used in non-React environments.
+ * @see QuestionnaireStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+export declare const questionnaireStore: import("zustand/vanilla").StoreApi<QuestionnaireStoreType>;
+/**
+ * Questionnaire state management store which contains all properties and methods to manage the state of the questionnaire.
+ * This is the React version of the store which can be used as React hooks in React functional components.
+ * @see QuestionnaireStoreType for available properties and methods.
+ * @see questionnaireStore for the vanilla store.
+ *
+ * @author Sean Fong
+ */
+export declare const useQuestionnaireStore: import("zustand/vanilla").StoreApi<QuestionnaireStoreType> & {
+    use: {
+        sourceQuestionnaire: () => Questionnaire;
+        itemTypes: () => Record<string, string>;
+        itemPreferredTerminologyServers: () => Record<string, string>;
+        tabs: () => Tabs;
+        currentTabIndex: () => number;
+        pages: () => Pages;
+        currentPageIndex: () => number;
+        variables: () => Variables;
+        launchContexts: () => Record<string, LaunchContext>;
+        targetConstraints: () => Record<string, TargetConstraint>;
+        targetConstraintLinkIds: () => Record<string, string[]>;
+        enableWhenItems: () => EnableWhenItems;
+        enableWhenLinkedQuestions: () => Record<string, string[]>;
+        enableWhenIsActivated: () => boolean;
+        enableWhenExpressions: () => EnableWhenExpressions;
+        calculatedExpressions: () => Record<string, CalculatedExpression[]>;
+        initialExpressions: () => Record<string, InitialExpression>;
+        answerExpressions: () => Record<string, AnswerExpression>;
+        processedValueSets: () => Record<string, ProcessedValueSet>;
+        cachedValueSetCodings: () => Record<string, Coding[]>;
+        fhirPathContext: () => Record<string, any>;
+        fhirPathTerminologyCache: () => Record<string, any>;
+        populatedContext: () => Record<string, any>;
+        qItemOverrideComponents: () => Record<string, ComponentType<QItemOverrideComponentProps>>;
+        sdcUiOverrideComponents: () => Record<string, ComponentType<SdcUiOverrideComponentProps>>;
+        focusedLinkId: () => string;
+        readOnly: () => boolean;
+        buildSourceQuestionnaire: () => (questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse, additionalVariables?: Record<string, object>, terminologyServerUrl?: string, readOnly?: boolean, qItemOverrideComponents?: Record<string, ComponentType<QItemOverrideComponentProps>>, sdcUiOverrideComponents?: Record<string, ComponentType<SdcUiOverrideComponentProps>>) => Promise<void>;
+        destroySourceQuestionnaire: () => () => void;
+        switchTab: () => (newTabIndex: number) => void;
+        switchPage: () => (newPageIndex: number) => void;
+        markTabAsComplete: () => (tabLinkId: string) => void;
+        markPageAsComplete: () => (pageLinkId: string) => void;
+        updateEnableWhenItem: () => (linkId: string, newAnswer: QuestionnaireResponseItemAnswer[] | undefined, parentRepeatGroupIndex: number | null) => void;
+        mutateRepeatEnableWhenItems: () => (parentRepeatGroupLinkId: string, parentRepeatGroupIndex: number, actionType: 'add' | 'remove') => void;
+        toggleEnableWhenActivation: () => (isActivated: boolean) => void;
+        updateExpressions: () => (updatedResponse: QuestionnaireResponse) => Promise<ComputedQRItemUpdates>;
+        addCodingToCache: () => (valueSetUrl: string, codings: Coding[]) => void;
+        updatePopulatedProperties: () => (populatedResponse: QuestionnaireResponse, populatedContext?: Record<string, any>, persistTabIndex?: boolean) => Promise<QuestionnaireResponse>;
+        onFocusLinkId: () => (linkId: string) => void;
+        setPopulatedContext: () => (newPopulatedContext: Record<string, any>, addToFhirPathContext?: boolean) => void;
+        setFormAsReadOnly: () => (readOnly: boolean) => void;
+    };
+};