@aehrc/smart-forms-renderer 0.28.0 → 0.30.0

package/src/hooks/useRepeatAnswers.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 type { Dispatch, SetStateAction } from 'react';
+import { useEffect, useState } from 'react';
+import type { RepeatAnswer } from '../interfaces/repeatItem.interface';
+import _isEqual from 'lodash/isEqual';
+
+function useRepeatAnswers(
+  valueFromProps: RepeatAnswer[]
+): [RepeatAnswer[], Dispatch<SetStateAction<RepeatAnswer[]>>] {
+  const [repeatAnswers, setRepeatAnswers] = useState(valueFromProps);
+
+  useEffect(
+    () => {
+      const valueFromPropsQRItemAnswers = valueFromProps.map((answer) => answer.answer);
+      const repeatAnswersQRItemAnswers = repeatAnswers.map((answer) => answer.answer);
+
+      if (!_isEqual(valueFromPropsQRItemAnswers, repeatAnswersQRItemAnswers)) {
+        setRepeatAnswers(valueFromProps);
+      }
+    },
+    // Only trigger this effect if prop value changes
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [valueFromProps]
+  );
+
+  return [repeatAnswers, setRepeatAnswers];
+}
+
+export default useRepeatAnswers;

package/src/hooks/useRepeatGroups.ts

@@ -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 type { Dispatch, SetStateAction } from 'react';
+import { useEffect, useState } from 'react';
+import type { RepeatGroupSingle } from '../interfaces/repeatGroup.interface';
+import _isEqual from 'lodash/isEqual';
+
+function useRepeatGroups(
+  valueFromProps: RepeatGroupSingle[]
+): [RepeatGroupSingle[], Dispatch<SetStateAction<RepeatGroupSingle[]>>] {
+  const [repeatGroups, setRepeatGroups] = useState(valueFromProps);
+
+  useEffect(
+    () => {
+      const valueFromPropsQRItems = valueFromProps.map(
+        (repeatGroupSingle) => repeatGroupSingle.qrItem
+      );
+      const repeatGroupsQRItems = repeatGroups.map((repeatGroupSingle) => repeatGroupSingle.qrItem);
+
+      if (!_isEqual(valueFromPropsQRItems, repeatGroupsQRItems)) {
+        setRepeatGroups(valueFromProps);
+      }
+    },
+    // Only trigger this effect if prop value changes
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [valueFromProps]
+  );
+
+  return [repeatGroups, setRepeatGroups];
+}
+
+export default useRepeatGroups;

package/src/stories/BuildFormButtonForStorybook.tsx

@@ -0,0 +1,41 @@
+/*
+ * 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.
+ */
+
+// @ts-ignore
+import React from 'react';
+import { Box, IconButton, Tooltip } from '@mui/material';
+import Iconify from '../components/Iconify/Iconify';
+
+interface BuildFormButtonProps {
+  onBuild: () => void;
+}
+
+function BuildFormButtonForStorybook(props: BuildFormButtonProps) {
+  const { onBuild } = props;
+
+  return (
+    <Box display="flex" mb={0.5} alignItems="center" columnGap={3}>
+      <Tooltip title="Build form" placement="right">
+        <IconButton onClick={onBuild} size="small" color="primary">
+          <Iconify icon="ph:hammer" sx={{ mb: 0.5 }} />
+        </IconButton>
+      </Tooltip>
+    </Box>
+  );
+}
+
+export default BuildFormButtonForStorybook;

package/src/stories/BuildFormButtonTesterWrapper.tsx

@@ -0,0 +1,61 @@
+/*
+ * 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.
+ */
+
+// @ts-ignore
+import React from 'react';
+import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
+import { BaseRenderer } from '../components';
+import { QueryClientProvider } from '@tanstack/react-query';
+import ThemeProvider from '../theme/Theme';
+import useQueryClient from '../hooks/useQueryClient';
+import useBuildFormForStorybook from './useBuildFormForStorybook';
+import { buildForm } from '../utils';
+import BuildFormButtonForStorybook from './BuildFormButtonForStorybook';
+
+interface BuildFormButtonTesterWrapperProps {
+  questionnaire: Questionnaire;
+  questionnaireResponse?: QuestionnaireResponse;
+}
+
+function BuildFormButtonTesterWrapper(props: BuildFormButtonTesterWrapperProps) {
+  const { questionnaire, questionnaireResponse } = props;
+
+  const queryClient = useQueryClient();
+
+  const isBuilding = useBuildFormForStorybook(questionnaire);
+
+  async function handleBuildForm() {
+    await buildForm(questionnaire, questionnaireResponse);
+  }
+
+  if (isBuilding) {
+    return <div>Loading...</div>;
+  }
+
+  return (
+    <ThemeProvider>
+      <QueryClientProvider client={queryClient}>
+        <div>
+          <BuildFormButtonForStorybook onBuild={handleBuildForm} />
+          <BaseRenderer />
+        </div>
+      </QueryClientProvider>
+    </ThemeProvider>
+  );
+}
+
+export default BuildFormButtonTesterWrapper;

package/src/stories/BuildFormWrapper.tsx

@@ -15,13 +15,14 @@
  * limitations under the License.
  */
 
-import React, { useLayoutEffect, useState } from 'react';
+// @ts-ignore
+import React from 'react';
 import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
 import { BaseRenderer } from '../components';
 import { QueryClientProvider } from '@tanstack/react-query';
 import ThemeProvider from '../theme/Theme';
 import useQueryClient from '../hooks/useQueryClient';
-import { buildForm } from '../utils';
+import useBuildFormForStorybook from './useBuildFormForStorybook';
 
 interface BuildFormWrapperProps {
   questionnaire: Questionnaire;
@@ -31,17 +32,11 @@ interface BuildFormWrapperProps {
 function BuildFormWrapper(props: BuildFormWrapperProps) {
   const { questionnaire, questionnaireResponse } = props;
 
-  const [isLoading, setIsLoading] = useState(true);
-
-  useLayoutEffect(() => {
-    buildForm(questionnaire, questionnaireResponse).then(() => {
-      setIsLoading(false);
-    });
-  }, [questionnaire, questionnaireResponse]);
-
   const queryClient = useQueryClient();
 
-  if (isLoading) {
+  const isBuilding = useBuildFormForStorybook(questionnaire, questionnaireResponse);
+
+  if (isBuilding) {
     return <div>Loading...</div>;
   }
 

package/src/stories/PrePopButtonForStorybook.tsx

@@ -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.
+ */
+
+// @ts-ignore
+import React from 'react';
+import { Box, CircularProgress, Fade, IconButton, Tooltip } from '@mui/material';
+import PlayCircleIcon from '@mui/icons-material/PlayCircle';
+import Typography from '@mui/material/Typography';
+
+interface PrePopButtonProps {
+  isPopulating: boolean;
+  onPopulate: () => void;
+}
+
+function PrePopButtonForStorybook(props: PrePopButtonProps) {
+  const { isPopulating, onPopulate } = props;
+
+  return (
+    <Box display="flex" mb={0.5} alignItems="center" columnGap={3}>
+      <Tooltip title="Pre-populate form" placement="right">
+        <IconButton disabled={isPopulating} onClick={onPopulate} size="small" color="primary">
+          {isPopulating ? (
+            <CircularProgress size={20} color="inherit" sx={{ mb: 0.5 }} />
+          ) : (
+            <PlayCircleIcon />
+          )}
+        </IconButton>
+      </Tooltip>
+      {isPopulating ? (
+        <Fade in={true} timeout={100}>
+          <Typography variant="body2" color="text.secondary">
+            Pre-populating form...
+          </Typography>
+        </Fade>
+      ) : null}
+    </Box>
+  );
+}
+
+export default PrePopButtonForStorybook;

package/src/stories/PrePopWrapper.tsx

@@ -0,0 +1,92 @@
+/*
+ * 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.
+ */
+
+// @ts-ignore
+import React, { useState } from 'react';
+import type { Patient, Practitioner, Questionnaire } from 'fhir/r4';
+import { BaseRenderer } from '../components';
+import { QueryClientProvider } from '@tanstack/react-query';
+import ThemeProvider from '../theme/Theme';
+import useQueryClient from '../hooks/useQueryClient';
+import type Client from 'fhirclient/lib/Client';
+import useBuildFormForStorybook from './useBuildFormForStorybook';
+import { buildForm } from '../utils';
+import PrePopButtonForStorybook from './PrePopButtonForStorybook';
+import { populateQuestionnaire } from '@aehrc/sdc-populate';
+import { fetchResourceCallback } from './populateCallbackForStorybook';
+
+interface PrePopWrapperProps {
+  questionnaire: Questionnaire;
+  fhirClient: Client;
+  patient: Patient;
+  user: Practitioner;
+}
+
+function PrePopWrapper(props: PrePopWrapperProps) {
+  const { questionnaire, fhirClient, patient, user } = props;
+
+  const [isPopulating, setIsPopulating] = useState(false);
+
+  const isBuilding = useBuildFormForStorybook(questionnaire);
+
+  const queryClient = useQueryClient();
+
+  function handlePrepopulate() {
+    setIsPopulating(true);
+
+    populateQuestionnaire({
+      questionnaire: questionnaire,
+      fetchResourceCallback: fetchResourceCallback,
+      requestConfig: {
+        clientEndpoint: fhirClient.state.serverUrl,
+        authToken: null
+      },
+      patient: patient,
+      user: user
+    }).then(async ({ populateSuccess, populateResult }) => {
+      if (!populateSuccess || !populateResult) {
+        setIsPopulating(false);
+        return;
+      }
+
+      const { populatedResponse } = populateResult;
+
+      // buildForm is used here because there is a really bizarre bug - using the store hooks directly doesn't update the baseRenderer
+      // could be the fact that it doesn't play well with storybook
+      await buildForm(questionnaire, populatedResponse);
+
+      setIsPopulating(false);
+    });
+  }
+
+  if (isBuilding) {
+    return <div>Loading...</div>;
+  }
+
+  return (
+    <ThemeProvider>
+      <QueryClientProvider client={queryClient}>
+        <div>
+          <PrePopButtonForStorybook isPopulating={isPopulating} onPopulate={handlePrepopulate} />
+          {isPopulating ? null : <BaseRenderer />}
+        </div>
+      </QueryClientProvider>
+    </ThemeProvider>
+  );
+}
+
+export default PrePopWrapper;

package/src/stories/assets/fhirClient/mockFhirClient.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 type Client from 'fhirclient/lib/Client';
+
+const iss = 'https://proxy.smartforms.io/v/r4/fhir';
+
+const clientId = 'smart-forms-storybook';
+
+const scope =
+  'fhirUser online_access openid profile patient/Condition.rs patient/Observation.rs launch patient/Encounter.rs patient/Patient.rs';
+
+// This must be a patient ID that exists in the EHR
+const patientId = 'pat-sf';
+
+// This must be a practitioner ID that exists in the EHR
+const userId = 'primary-peter';
+
+export const mockFhirClient = {
+  state: {
+    clientId: clientId,
+    scope: scope,
+    serverUrl: iss,
+    tokenResponse: {
+      access_token: 'mock_access_token'
+    }
+  },
+  patient: {
+    id: patientId
+  },
+  encounter: { id: null },
+
+  user: {
+    id: userId,
+    fhirUser: `Practitioner/${userId}`,
+    resourceType: 'Practitioner'
+  }
+} as unknown as Client;