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

package/lib/hooks/useReadOnly.js

@@ -0,0 +1,47 @@
+/*
+ * 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 useRenderingExtensions from './useRenderingExtensions';
+import { useRendererStylingStore } from '../stores/rendererStylingStore';
+import { isHiddenByEnableWhen } from '../utils/qItem';
+import { useQuestionnaireStore } from '../stores';
+function useReadOnly(qItem, parentIsReadOnly, parentRepeatGroupIndex) {
+    let { readOnly } = useRenderingExtensions(qItem);
+    const enableWhenIsActivated = useQuestionnaireStore.use.enableWhenIsActivated();
+    const enableWhenItems = useQuestionnaireStore.use.enableWhenItems();
+    const enableWhenExpressions = useQuestionnaireStore.use.enableWhenExpressions();
+    const enableWhenAsReadOnly = useRendererStylingStore.use.enableWhenAsReadOnly();
+    // If enableWhenAsReadOnly is true, then items hidden by enableWhen should be displayed, but set as readOnly
+    // If enableWhenAsReadOnly is a Set, all item types in the set should be displayed, but set as readOnly
+    if (!readOnly) {
+        if (enableWhenAsReadOnly === true ||
+            (enableWhenAsReadOnly instanceof Set && enableWhenAsReadOnly.has(qItem.type))) {
+            readOnly = isHiddenByEnableWhen({
+                linkId: qItem.linkId,
+                enableWhenIsActivated,
+                enableWhenItems,
+                enableWhenExpressions,
+                parentRepeatGroupIndex
+            });
+        }
+    }
+    if (typeof parentIsReadOnly === 'boolean' && parentIsReadOnly) {
+        readOnly = parentIsReadOnly;
+    }
+    return readOnly;
+}
+export default useReadOnly;
+//# sourceMappingURL=useReadOnly.js.map

package/lib/hooks/useReadOnly.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useReadOnly.js","sourceRoot":"","sources":["../../src/hooks/useReadOnly.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,sBAAsB,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAElD,SAAS,WAAW,CAClB,KAAwB,EACxB,gBAAqC,EACrC,sBAA+B;IAE/B,IAAI,EAAE,QAAQ,EAAE,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAEjD,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC;IAChF,MAAM,eAAe,GAAG,qBAAqB,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;IACpE,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC;IAEhF,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;IAEhF,4GAA4G;IAC5G,uGAAuG;IACvG,IAAI,CAAC,QAAQ,EAAE;QACb,IACE,oBAAoB,KAAK,IAAI;YAC7B,CAAC,oBAAoB,YAAY,GAAG,IAAI,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAC7E;YACA,QAAQ,GAAG,oBAAoB,CAAC;gBAC9B,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,qBAAqB;gBACrB,eAAe;gBACf,qBAAqB;gBACrB,sBAAsB;aACvB,CAAC,CAAC;SACJ;KACF;IAED,IAAI,OAAO,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,EAAE;QAC7D,QAAQ,GAAG,gBAAgB,CAAC;KAC7B;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,eAAe,WAAW,CAAC"}

package/lib/hooks/useRendererQueryClient.d.ts

@@ -0,0 +1,10 @@
+import { QueryClient } from '@tanstack/react-query';
+/**
+ * Default QueryClient used by the renderer.
+ * You can customise your own QueryClient with your own options, use v4 of @tanstack/react-query.
+ * @see {@link https://tanstack.com/query/v4/docs/reference/QueryClient}
+ *
+ * @author Sean Fong
+ */
+declare function useRendererQueryClient(): QueryClient;
+export default useRendererQueryClient;

package/lib/hooks/useRendererQueryClient.js

@@ -0,0 +1,35 @@
+/*
+ * 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 { QueryClient } from '@tanstack/react-query';
+/**
+ * Default QueryClient used by the renderer.
+ * You can customise your own QueryClient with your own options, use v4 of @tanstack/react-query.
+ * @see {@link https://tanstack.com/query/v4/docs/reference/QueryClient}
+ *
+ * @author Sean Fong
+ */
+function useRendererQueryClient() {
+    return new QueryClient({
+        defaultOptions: {
+            queries: {
+                refetchOnWindowFocus: false
+            }
+        }
+    });
+}
+export default useRendererQueryClient;
+//# sourceMappingURL=useRendererQueryClient.js.map

package/lib/hooks/useRendererQueryClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRendererQueryClient.js","sourceRoot":"","sources":["../../src/hooks/useRendererQueryClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD;;;;;;GAMG;AACH,SAAS,sBAAsB;IAC7B,OAAO,IAAI,WAAW,CAAC;QACrB,cAAc,EAAE;YACd,OAAO,EAAE;gBACP,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED,eAAe,sBAAsB,CAAC"}

package/lib/hooks/useRenderingExtensions.d.ts

@@ -0,0 +1,14 @@
+import type { QuestionnaireItem, QuestionnaireItemAnswerOption } from 'fhir/r4';
+import type { JSX } from 'react';
+export interface RenderingExtensions {
+    displayUnit: string;
+    displayPrompt: string;
+    displayInstructions: string;
+    displayFlyover: string | JSX.Element | JSX.Element[];
+    readOnly: boolean;
+    entryFormat: string;
+    required: boolean;
+    quantityUnit: QuestionnaireItemAnswerOption | null;
+}
+declare function useRenderingExtensions(qItem: QuestionnaireItem): RenderingExtensions;
+export default useRenderingExtensions;

package/lib/hooks/useRenderingExtensions.js

@@ -0,0 +1,36 @@
+/*
+ * 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 { getQuantityUnit, getTextDisplayFlyover, getTextDisplayInstructions, getTextDisplayPrompt, getTextDisplayUnit } from '../utils/itemControl';
+import { structuredDataCapture } from 'fhir-sdc-helpers';
+import { useMemo } from 'react';
+function useRenderingExtensions(qItem) {
+    return useMemo(() => {
+        var _a, _b;
+        return ({
+            displayUnit: getTextDisplayUnit(qItem),
+            displayPrompt: getTextDisplayPrompt(qItem),
+            displayInstructions: getTextDisplayInstructions(qItem),
+            displayFlyover: getTextDisplayFlyover(qItem),
+            readOnly: !!qItem.readOnly,
+            entryFormat: (_a = structuredDataCapture.getEntryFormat(qItem)) !== null && _a !== void 0 ? _a : '',
+            required: (_b = qItem.required) !== null && _b !== void 0 ? _b : false,
+            quantityUnit: getQuantityUnit(qItem)
+        });
+    }, [qItem]);
+}
+export default useRenderingExtensions;
+//# sourceMappingURL=useRenderingExtensions.js.map

package/lib/hooks/useRenderingExtensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRenderingExtensions.js","sourceRoot":"","sources":["../../src/hooks/useRenderingExtensions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,0BAA0B,EAC1B,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAahC,SAAS,sBAAsB,CAAC,KAAwB;IACtD,OAAO,OAAO,CACZ,GAAG,EAAE;;QAAC,OAAA,CAAC;YACL,WAAW,EAAE,kBAAkB,CAAC,KAAK,CAAC;YACtC,aAAa,EAAE,oBAAoB,CAAC,KAAK,CAAC;YAC1C,mBAAmB,EAAE,0BAA0B,CAAC,KAAK,CAAC;YACtD,cAAc,EAAE,qBAAqB,CAAC,KAAK,CAAC;YAC5C,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ;YAC1B,WAAW,EAAE,MAAA,qBAAqB,CAAC,cAAc,CAAC,KAAK,CAAC,mCAAI,EAAE;YAC9D,QAAQ,EAAE,MAAA,KAAK,CAAC,QAAQ,mCAAI,KAAK;YACjC,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC;SACrC,CAAC,CAAA;KAAA,EACF,CAAC,KAAK,CAAC,CACR,CAAC;AACJ,CAAC;AAED,eAAe,sBAAsB,CAAC"}

package/lib/hooks/useResponsive.d.ts

@@ -0,0 +1,50 @@
+import type { Breakpoint } from '@mui/material/styles';
+/**
+ * Props for the useResponsive() hook -  used to determine if the screen size matches a given breakpoint query.
+ *
+ * @param {'up' | 'down' | 'between' | 'only'} query - The type of query:
+ *   - `'up'`: Matches screen sizes above and including `start`.
+ *   - `'down'`: Matches screen sizes below and including `start`.
+ *   - `'between'`: Matches screen sizes between `start` and `end` (inclusive).
+ *   - `'only'`: Matches exactly the `start` size.
+ * @param {'xs' | 'sm' | 'md' | 'lg' | 'xl'} start - The starting breakpoint - can be extended via MUI BreakpointOverrides.
+ * @param {'xs' | 'sm' | 'md' | 'lg' | 'xl'} end - The ending breakpoint (required if `query` is `'between'`) - can be extended via MUI BreakpointOverrides.
+ *
+ * @example
+ * // Check if the screen size is at least 'md' (medium)
+ * const isMdUp = useResponsive({ query: 'up', start: 'md' });
+ *
+ * @example
+ * // Check if the screen size is exactly 'lg' (large)
+ * const isLgOnly = useResponsive({ query: 'only', start: 'lg' });
+ *
+ * @example
+ * // Check if the screen size is at least 'tablet' - this is a custom breakpoint https://mui.com/material-ui/customization/breakpoints/#custom-breakpoints
+ * const isTabletUp = useResponsive({ query: 'up', start: 'tablet' });
+ **/
+export interface UseResponsiveProps {
+    query: 'up' | 'down' | 'between' | 'only';
+    start: Breakpoint;
+    end?: Breakpoint;
+}
+/**
+ * A hook to determine if the screen size matches a given breakpoint query.
+ *
+ * @param props - The responsive query options.
+ *
+ * @returns {boolean} `true` if the current screen size matches the query, otherwise `false`.
+ *
+ * @example
+ * // Check if the screen size is at least 'md' (medium)
+ * const isMdUp = useResponsive({ query: 'up', start: 'md' });
+ *
+ * @example
+ * // Check if the screen size is exactly 'lg' (large)
+ * const isLgOnly = useResponsive({ query: 'only', start: 'lg' });
+ *
+ * @example
+ * // Check if the screen size is at least 'tablet' - this is a custom breakpoint https://mui.com/material-ui/customization/breakpoints/#custom-breakpoints
+ * const isTabletUp = useResponsive({ query: 'up', start: 'tablet' });
+ */
+declare function useResponsive(props: UseResponsiveProps): boolean;
+export default useResponsive;

package/lib/hooks/useResponsive.js

@@ -0,0 +1,57 @@
+/*
+ * 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 { useTheme } from '@mui/material/styles';
+import useMediaQuery from '@mui/material/useMediaQuery';
+/**
+ * A hook to determine if the screen size matches a given breakpoint query.
+ *
+ * @param props - The responsive query options.
+ *
+ * @returns {boolean} `true` if the current screen size matches the query, otherwise `false`.
+ *
+ * @example
+ * // Check if the screen size is at least 'md' (medium)
+ * const isMdUp = useResponsive({ query: 'up', start: 'md' });
+ *
+ * @example
+ * // Check if the screen size is exactly 'lg' (large)
+ * const isLgOnly = useResponsive({ query: 'only', start: 'lg' });
+ *
+ * @example
+ * // Check if the screen size is at least 'tablet' - this is a custom breakpoint https://mui.com/material-ui/customization/breakpoints/#custom-breakpoints
+ * const isTabletUp = useResponsive({ query: 'up', start: 'tablet' });
+ */
+function useResponsive(props) {
+    const { query, start, end = 'xl' } = props;
+    const theme = useTheme();
+    const mediaUp = useMediaQuery(theme.breakpoints.up(start));
+    const mediaDown = useMediaQuery(theme.breakpoints.down(start));
+    const mediaBetween = useMediaQuery(theme.breakpoints.between(start, end));
+    const mediaOnly = useMediaQuery(theme.breakpoints.only(start));
+    if (query === 'up') {
+        return mediaUp;
+    }
+    if (query === 'down') {
+        return mediaDown;
+    }
+    if (query === 'between') {
+        return mediaBetween;
+    }
+    return mediaOnly;
+}
+export default useResponsive;
+//# sourceMappingURL=useResponsive.js.map

package/lib/hooks/useResponsive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useResponsive.js","sourceRoot":"","sources":["../../src/hooks/useResponsive.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,aAAa,MAAM,6BAA6B,CAAC;AA+BxD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAS,aAAa,CAAC,KAAyB;IAC9C,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IAE3C,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;IAEzB,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAE3D,MAAM,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAE/D,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IAE1E,MAAM,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAE/D,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,OAAO,OAAO,CAAC;KAChB;IAED,IAAI,KAAK,KAAK,MAAM,EAAE;QACpB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,eAAe,aAAa,CAAC"}

package/lib/hooks/useSliderExtensions.d.ts

@@ -0,0 +1,10 @@
+import type { QuestionnaireItem } from 'fhir/r4';
+interface SliderExtensions {
+    minValue: number;
+    minLabel: string;
+    maxValue: number;
+    maxLabel: string;
+    stepValue: number;
+}
+declare function useSliderExtensions(qItem: QuestionnaireItem): SliderExtensions;
+export default useSliderExtensions;

package/lib/hooks/useSliderExtensions.js

@@ -0,0 +1,37 @@
+/*
+ * 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 { getTextDisplayLower, getTextDisplayUpper } from '../utils/itemControl';
+import { getMaxValue, getMinValue, getSliderStepValue } from '../utils/slider';
+const defaultMinValue = 0;
+const defaultMinLabel = '0';
+const defaultMaxValue = 100;
+const defaultMaxLabel = '100';
+const defaultStepValue = 1;
+function useSliderExtensions(qItem) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const minValue = (_a = getMinValue(qItem)) !== null && _a !== void 0 ? _a : defaultMinValue;
+    const maxValue = (_b = getMaxValue(qItem)) !== null && _b !== void 0 ? _b : defaultMaxValue;
+    return {
+        minValue: minValue,
+        minLabel: (_d = (_c = getTextDisplayLower(qItem)) !== null && _c !== void 0 ? _c : minValue.toString()) !== null && _d !== void 0 ? _d : defaultMinLabel,
+        maxValue: maxValue,
+        maxLabel: (_f = (_e = getTextDisplayUpper(qItem)) !== null && _e !== void 0 ? _e : maxValue.toString()) !== null && _f !== void 0 ? _f : defaultMaxLabel,
+        stepValue: (_g = getSliderStepValue(qItem)) !== null && _g !== void 0 ? _g : defaultStepValue
+    };
+}
+export default useSliderExtensions;
+//# sourceMappingURL=useSliderExtensions.js.map

package/lib/hooks/useSliderExtensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSliderExtensions.js","sourceRoot":"","sources":["../../src/hooks/useSliderExtensions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE/E,MAAM,eAAe,GAAG,CAAC,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,MAAM,eAAe,GAAG,GAAG,CAAC;AAC5B,MAAM,eAAe,GAAG,KAAK,CAAC;AAE9B,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAU3B,SAAS,mBAAmB,CAAC,KAAwB;;IACnD,MAAM,QAAQ,GAAG,MAAA,WAAW,CAAC,KAAK,CAAC,mCAAI,eAAe,CAAC;IACvD,MAAM,QAAQ,GAAG,MAAA,WAAW,CAAC,KAAK,CAAC,mCAAI,eAAe,CAAC;IACvD,OAAO;QACL,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,MAAA,MAAA,mBAAmB,CAAC,KAAK,CAAC,mCAAI,QAAQ,CAAC,QAAQ,EAAE,mCAAI,eAAe;QAC9E,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,MAAA,MAAA,mBAAmB,CAAC,KAAK,CAAC,mCAAI,QAAQ,CAAC,QAAQ,EAAE,mCAAI,eAAe;QAC9E,SAAS,EAAE,MAAA,kBAAkB,CAAC,KAAK,CAAC,mCAAI,gBAAgB;KACzD,CAAC;AACJ,CAAC;AAED,eAAe,mBAAmB,CAAC"}

package/lib/hooks/useStringCalculatedExpression.d.ts

@@ -0,0 +1,12 @@
+import type { QuestionnaireItem } from 'fhir/r4';
+interface UseStringCalculatedExpression {
+    calcExpUpdated: boolean;
+}
+interface useStringCalculatedExpressionProps {
+    qItem: QuestionnaireItem;
+    inputValue: string;
+    onChangeByCalcExpressionString: (newValueString: string) => void;
+    onChangeByCalcExpressionNull: () => void;
+}
+declare function useStringCalculatedExpression(props: useStringCalculatedExpressionProps): UseStringCalculatedExpression;
+export default useStringCalculatedExpression;

package/lib/hooks/useStringCalculatedExpression.js

@@ -0,0 +1,63 @@
+/*
+ * 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 { useEffect, useState } from 'react';
+import { useQuestionnaireStore } from '../stores';
+function useStringCalculatedExpression(props) {
+    const { qItem, inputValue, onChangeByCalcExpressionString, onChangeByCalcExpressionNull } = props;
+    const calculatedExpressions = useQuestionnaireStore.use.calculatedExpressions();
+    const [calcExpUpdated, setCalcExpUpdated] = useState(false);
+    useEffect(() => {
+        var _a;
+        const calcExpression = (_a = calculatedExpressions[qItem.linkId]) === null || _a === void 0 ? void 0 : _a.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;
+//# sourceMappingURL=useStringCalculatedExpression.js.map

package/lib/hooks/useStringCalculatedExpression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useStringCalculatedExpression.js","sourceRoot":"","sources":["../../src/hooks/useStringCalculatedExpression.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAalD,SAAS,6BAA6B,CACpC,KAAyC;IAEzC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,8BAA8B,EAAE,4BAA4B,EAAE,GAAG,KAAK,CAAC;IAElG,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC;IAEhF,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE5D,SAAS,CACP,GAAG,EAAE;;QACH,MAAM,cAAc,GAAG,MAAA,qBAAqB,CAAC,KAAK,CAAC,MAAM,CAAC,0CAAE,IAAI,CAC9D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAC7B,CAAC;QAEF,IAAI,CAAC,cAAc,EAAE;YACnB,OAAO;SACR;QAED,2EAA2E;QAC3E,MAAM,6BAA6B,GAAG,UAAU,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;QACjF,IAAI,6BAA6B,EAAE;YACjC,OAAO;SACR;QAED,kEAAkE;QAClE,IACE,cAAc,CAAC,KAAK,KAAK,UAAU;YACnC,CAAC,OAAO,cAAc,CAAC,KAAK,KAAK,QAAQ;gBACvC,OAAO,cAAc,CAAC,KAAK,KAAK,QAAQ;gBACxC,cAAc,CAAC,KAAK,KAAK,IAAI,CAAC,EAChC;YACA,6CAA6C;YAC7C,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBAChC,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC,EAAE,GAAG,CAAC,CAAC;YAER,qCAAqC;YACrC,IAAI,cAAc,CAAC,KAAK,KAAK,IAAI,EAAE;gBACjC,4BAA4B,EAAE,CAAC;gBAC/B,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;aACtC;YAED,mDAAmD;YACnD,MAAM,aAAa,GACjB,OAAO,cAAc,CAAC,KAAK,KAAK,QAAQ;gBACtC,CAAC,CAAC,cAAc,CAAC,KAAK;gBACtB,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YAEtC,8BAA8B,CAAC,aAAa,CAAC,CAAC;YAC9C,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;SACtC;IACH,CAAC;IACD,mEAAmE;IACnE,uDAAuD;IACvD,CAAC,qBAAqB,CAAC,CACxB,CAAC;IAEF,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC;AAC5C,CAAC;AAED,eAAe,6BAA6B,CAAC"}

package/lib/hooks/useTerminologyServerQuery.d.ts

@@ -0,0 +1,11 @@
+import type { Coding, QuestionnaireItem } from 'fhir/r4';
+import type { AlertColor } from '@mui/material/Alert';
+declare function useTerminologyServerQuery(qItem: QuestionnaireItem, maxList: number, input: string, searchTerm: string): {
+    options: Coding[];
+    loading: boolean;
+    feedback?: {
+        message: string;
+        color: AlertColor;
+    };
+};
+export default useTerminologyServerQuery;

package/lib/hooks/useTerminologyServerQuery.js

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2024 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { getTerminologyServerUrl, getValueSetCodings, getValueSetPromise } from '../utils/valueSet';
+import { useQuestionnaireStore, useTerminologyServerStore } from '../stores';
+import { useQuery } from '@tanstack/react-query';
+function useTerminologyServerQuery(qItem, maxList, input, searchTerm) {
+    var _a, _b, _c, _d;
+    const processedValueSets = useQuestionnaireStore.use.processedValueSets();
+    const itemPreferredTerminologyServers = useQuestionnaireStore.use.itemPreferredTerminologyServers();
+    const defaultTerminologyServerUrl = useTerminologyServerStore.use.url();
+    let fullUrl = '';
+    let options = [];
+    let feedback;
+    if (input.length === 0) {
+        feedback = undefined;
+    }
+    if (searchTerm.length < 1 && searchTerm.length > 0) {
+        feedback = { message: 'Enter at least 2 characters to search for results.', color: 'info' };
+    }
+    // Restructure url to include filter and count parameters
+    let answerValueSetUrl = qItem.answerValueSet;
+    if (answerValueSetUrl) {
+        if (answerValueSetUrl.startsWith('#')) {
+            answerValueSetUrl = answerValueSetUrl.slice(1);
+        }
+        // attempt to get url from contained value sets when loading questionnaire
+        if ((_a = processedValueSets[answerValueSetUrl]) === null || _a === void 0 ? void 0 : _a.updatableValueSetUrl) {
+            answerValueSetUrl = processedValueSets[answerValueSetUrl].updatableValueSetUrl;
+        }
+        const urlWithTrailingAmpersand = answerValueSetUrl + (answerValueSetUrl[answerValueSetUrl.length - 1] !== '&' ? '&' : '');
+        fullUrl = urlWithTrailingAmpersand + 'filter=' + searchTerm + '&count=' + maxList;
+    }
+    // Perform query
+    const preferredTerminologyServerUrl = itemPreferredTerminologyServers[qItem.linkId];
+    const terminologyServerUrl = (_c = (_b = getTerminologyServerUrl(qItem)) !== null && _b !== void 0 ? _b : preferredTerminologyServerUrl) !== null && _c !== void 0 ? _c : defaultTerminologyServerUrl;
+    const { isFetching, error, data } = useQuery({
+        queryKey: ['expandValueSet', fullUrl],
+        queryFn: () => getValueSetPromise(fullUrl, terminologyServerUrl),
+        enabled: searchTerm.length >= 2 && answerValueSetUrl !== undefined
+    });
+    if (error) {
+        console.warn('Ontoserver query failed. Details below: \n' + error);
+        feedback = {
+            message: 'An error occurred. Try again later or try searching for a different term.',
+            color: 'error'
+        };
+    }
+    if (data) {
+        if (((_d = data.expansion) === null || _d === void 0 ? void 0 : _d.total) !== 0) {
+            options = getValueSetCodings(data);
+        }
+        else {
+            feedback = {
+                message: "We couldn't seem to find anything. Try searching for a different term.",
+                color: 'warning'
+            };
+        }
+    }
+    return { options, loading: isFetching, feedback };
+}
+export default useTerminologyServerQuery;
+//# sourceMappingURL=useTerminologyServerQuery.js.map

package/lib/hooks/useTerminologyServerQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTerminologyServerQuery.js","sourceRoot":"","sources":["../../src/hooks/useTerminologyServerQuery.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAGpG,OAAO,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,SAAS,yBAAyB,CAChC,KAAwB,EACxB,OAAe,EACf,KAAa,EACb,UAAkB;;IAElB,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;IAC1E,MAAM,+BAA+B,GACnC,qBAAqB,CAAC,GAAG,CAAC,+BAA+B,EAAE,CAAC;IAC9D,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;IAExE,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,OAAO,GAAa,EAAE,CAAC;IAC3B,IAAI,QAA4D,CAAC;IAEjE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,QAAQ,GAAG,SAAS,CAAC;KACtB;IAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;QAClD,QAAQ,GAAG,EAAE,OAAO,EAAE,oDAAoD,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;KAC7F;IAED,yDAAyD;IACzD,IAAI,iBAAiB,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,IAAI,iBAAiB,EAAE;QACrB,IAAI,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACrC,iBAAiB,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAChD;QAED,0EAA0E;QAC1E,IAAI,MAAA,kBAAkB,CAAC,iBAAiB,CAAC,0CAAE,oBAAoB,EAAE;YAC/D,iBAAiB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,oBAAoB,CAAC;SAChF;QAED,MAAM,wBAAwB,GAC5B,iBAAiB,GAAG,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC3F,OAAO,GAAG,wBAAwB,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;KACnF;IAED,gBAAgB;IAChB,MAAM,6BAA6B,GAAG,+BAA+B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACpF,MAAM,oBAAoB,GACxB,MAAA,MAAA,uBAAuB,CAAC,KAAK,CAAC,mCAAI,6BAA6B,mCAAI,2BAA2B,CAAC;IAEjG,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAW;QACrD,QAAQ,EAAE,CAAC,gBAAgB,EAAE,OAAO,CAAC;QACrC,OAAO,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE,oBAAoB,CAAC;QAChE,OAAO,EAAE,UAAU,CAAC,MAAM,IAAI,CAAC,IAAI,iBAAiB,KAAK,SAAS;KACnE,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE;QACT,OAAO,CAAC,IAAI,CAAC,4CAA4C,GAAG,KAAK,CAAC,CAAC;QACnE,QAAQ,GAAG;YACT,OAAO,EAAE,2EAA2E;YACpF,KAAK,EAAE,OAAO;SACf,CAAC;KACH;IAED,IAAI,IAAI,EAAE;QACR,IAAI,CAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,KAAK,MAAK,CAAC,EAAE;YAC/B,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;SACpC;aAAM;YACL,QAAQ,GAAG;gBACT,OAAO,EAAE,wEAAwE;gBACjF,KAAK,EAAE,SAAS;aACjB,CAAC;SACH;KACF;IAED,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;AACpD,CAAC;AACD,eAAe,yBAAyB,CAAC"}

package/lib/hooks/useTimeValidation.d.ts

@@ -0,0 +1,5 @@
+declare function useTimeValidation(timeInput: string, periodInput: string, parseFail?: boolean): {
+    timeFeedback: string | null;
+    is24HourNotation: boolean;
+};
+export default useTimeValidation;

package/lib/hooks/useTimeValidation.js

@@ -0,0 +1,54 @@
+/*
+ * 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 { getNumOfSeparators } from '../components/FormComponents/DateTimeItems/utils/parseDate';
+import dayjs from 'dayjs';
+import { validateTimeInput } from '../components/FormComponents/DateTimeItems/utils/parseTime';
+function useTimeValidation(timeInput, periodInput, parseFail = false) {
+    if (timeInput === '') {
+        return { timeFeedback: null, is24HourNotation: false };
+    }
+    if (timeInput.includes('.')) {
+        return {
+            timeFeedback: 'Input does not match the required format with ":" as the separator.',
+            is24HourNotation: false
+        };
+    }
+    if (timeInput.length !== 5 || !timeInput.includes(':')) {
+        return { timeFeedback: 'Input does not match the format HH:MM.', is24HourNotation: false };
+    }
+    const numOfSeparators = getNumOfSeparators(timeInput, ':');
+    if (numOfSeparators === 1) {
+        const timeDayJs = dayjs(timeInput, `hh:mm`);
+        if (!timeDayJs.isValid()) {
+            return { timeFeedback: 'Input does not match the format hh:mm.', is24HourNotation: false };
+        }
+        const { timeIsValid, is24HourNotation } = validateTimeInput(timeInput, periodInput);
+        if (periodInput === '' && !is24HourNotation) {
+            return { timeFeedback: 'Specify the period as AM or PM.', is24HourNotation: false };
+        }
+        if (!timeIsValid) {
+            return { timeFeedback: 'Input is an invalid time.', is24HourNotation: false };
+        }
+        return { timeFeedback: null, is24HourNotation };
+    }
+    if (parseFail) {
+        return { timeFeedback: 'Input is an invalid time.', is24HourNotation: false };
+    }
+    return { timeFeedback: 'Input is an invalid time.', is24HourNotation: false };
+}
+export default useTimeValidation;
+//# sourceMappingURL=useTimeValidation.js.map

package/lib/hooks/useTimeValidation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTimeValidation.js","sourceRoot":"","sources":["../../src/hooks/useTimeValidation.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,4DAA4D,CAAC;AAChG,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,4DAA4D,CAAC;AAE/F,SAAS,iBAAiB,CACxB,SAAiB,EACjB,WAAmB,EACnB,YAAqB,KAAK;IAE1B,IAAI,SAAS,KAAK,EAAE,EAAE;QACpB,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;KACxD;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAC3B,OAAO;YACL,YAAY,EAAE,qEAAqE;YACnF,gBAAgB,EAAE,KAAK;SACxB,CAAC;KACH;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACtD,OAAO,EAAE,YAAY,EAAE,wCAAwC,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;KAC5F;IAED,MAAM,eAAe,GAAG,kBAAkB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAE3D,IAAI,eAAe,KAAK,CAAC,EAAE;QACzB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE;YACxB,OAAO,EAAE,YAAY,EAAE,wCAAwC,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;SAC5F;QAED,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,iBAAiB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAEpF,IAAI,WAAW,KAAK,EAAE,IAAI,CAAC,gBAAgB,EAAE;YAC3C,OAAO,EAAE,YAAY,EAAE,iCAAiC,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;SACrF;QAED,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;SAC/E;QAED,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;KACjD;IAED,IAAI,SAAS,EAAE;QACb,OAAO,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;KAC/E;IAED,OAAO,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;AAChF,CAAC;AAED,eAAe,iBAAiB,CAAC"}

package/lib/hooks/useValidationFeedback.d.ts

@@ -0,0 +1,3 @@
+import type { QuestionnaireItem } from 'fhir/r4';
+declare function useValidationFeedback(qItem: QuestionnaireItem, feedbackFromParent: string | undefined, input: string): string;
+export default useValidationFeedback;