@aehrc/smart-forms-renderer 0.44.3 → 0.45.0

package/lib/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.d.ts

@@ -0,0 +1,31 @@
+import React from 'react';
+import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
+import type Client from 'fhirclient/lib/Client';
+export interface InitialiseFormWrapperProps {
+    questionnaire: Questionnaire;
+    questionnaireResponse?: QuestionnaireResponse;
+    readOnly?: boolean;
+    terminologyServerUrl?: string;
+    additionalVariables?: Record<string, object>;
+    fhirClient?: Client;
+}
+/**
+ * This is a one-to-one replacement for the SmartFormsRenderer for demo purposes.
+ * Instead of using this React component, define your own wrapper component that uses the BaseRenderer directly.
+ * Things to note:
+ * - It is required to wrap the BaseRenderer with the QueryClientProvider to make requests.
+ * - You can wrap the BaseRenderer with the RendererThemeProvider to apply the default renderer theme used in Smart Forms. Optionally, you can define your own ThemeProvider https://mui.com/material-ui/customization/theming/.
+ * - Make your buildForm() call in a button click or other event handler. Alternatively, you can use the useInitialiseForm hook to initialise the form.
+ * - Make your own initialiseFhirClient() call in a button click or other event handler. Alternatively, you can use the useInitialiseForm hook to initialise the form.
+ * - The initialised FHIRClient is only used for further FHIR calls. It does not provide pre-population capabilities.
+ *
+ * For button click usage examples of buildForm(), see:
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopButtonForStorybook.tsx
+ *
+ * @author Sean Fong
+ */
+declare function InitialiseFormWrapperForStorybook(props: InitialiseFormWrapperProps): React.JSX.Element;
+export default InitialiseFormWrapperForStorybook;

package/lib/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.js

@@ -0,0 +1,67 @@
+/*
+ * 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 { BaseRenderer } from '../../components';
+import { QueryClientProvider } from '@tanstack/react-query';
+import RendererThemeProvider from '../../theme/Theme';
+import useRendererQueryClient from '../../hooks/useRendererQueryClient';
+import useInitialiseForm from '../../hooks/useInitialiseForm';
+import Box from '@mui/material/Box';
+import CircularProgress from '@mui/material/CircularProgress';
+import Typography from '@mui/material/Typography';
+/**
+ * This is a one-to-one replacement for the SmartFormsRenderer for demo purposes.
+ * Instead of using this React component, define your own wrapper component that uses the BaseRenderer directly.
+ * Things to note:
+ * - It is required to wrap the BaseRenderer with the QueryClientProvider to make requests.
+ * - You can wrap the BaseRenderer with the RendererThemeProvider to apply the default renderer theme used in Smart Forms. Optionally, you can define your own ThemeProvider https://mui.com/material-ui/customization/theming/.
+ * - Make your buildForm() call in a button click or other event handler. Alternatively, you can use the useInitialiseForm hook to initialise the form.
+ * - Make your own initialiseFhirClient() call in a button click or other event handler. Alternatively, you can use the useInitialiseForm hook to initialise the form.
+ * - The initialised FHIRClient is only used for further FHIR calls. It does not provide pre-population capabilities.
+ *
+ * For button click usage examples of buildForm(), see:
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopButtonForStorybook.tsx
+ *
+ * @author Sean Fong
+ */
+function InitialiseFormWrapperForStorybook(props) {
+    const { questionnaire, questionnaireResponse, readOnly, terminologyServerUrl, additionalVariables, fhirClient } = props;
+    // The renderer requires a @tanstack/react-query QueryClientProvider to make requests
+    const queryClient = useRendererQueryClient();
+    /**
+     * The useInitialiseForm hook provides initialisation logic for the form
+     * Alternatively (and recommended to do so), you can initialise your form via a button click or other event handler.
+     *
+     * @see {@link https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/BuildFormButtonForStorybook.tsx} for button click usage examples.
+     */
+    const isInitialising = useInitialiseForm(questionnaire, questionnaireResponse, readOnly, terminologyServerUrl, additionalVariables, fhirClient);
+    // Free feel to customise your loading animation here
+    if (isInitialising) {
+        return (React.createElement(Box, { display: "flex", alignItems: "center", columnGap: 2 },
+            React.createElement(CircularProgress, null),
+            React.createElement(Typography, null, "Loading questionnaire...")));
+    }
+    return (React.createElement(RendererThemeProvider, null,
+        React.createElement(QueryClientProvider, { client: queryClient },
+            React.createElement(BaseRenderer, null))));
+}
+export default InitialiseFormWrapperForStorybook;
+//# sourceMappingURL=InitialiseFormWrapperForStorybook.js.map

package/lib/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InitialiseFormWrapperForStorybook.js","sourceRoot":"","sources":["../../../../src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,aAAa;AACb,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,qBAAqB,MAAM,mBAAmB,CAAC;AACtD,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AAExE,OAAO,iBAAiB,MAAM,+BAA+B,CAAC;AAC9D,OAAO,GAAG,MAAM,mBAAmB,CAAC;AACpC,OAAO,gBAAgB,MAAM,gCAAgC,CAAC;AAC9D,OAAO,UAAU,MAAM,0BAA0B,CAAC;AAWlD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAS,iCAAiC,CAAC,KAAiC;IAC1E,MAAM,EACJ,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACnB,UAAU,EACX,GAAG,KAAK,CAAC;IAEV,qFAAqF;IACrF,MAAM,WAAW,GAAG,sBAAsB,EAAE,CAAC;IAE7C;;;;;OAKG;IACH,MAAM,cAAc,GAAG,iBAAiB,CACtC,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACnB,UAAU,CACX,CAAC;IAEF,qDAAqD;IACrD,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,CACL,oBAAC,GAAG,IAAC,OAAO,EAAC,MAAM,EAAC,UAAU,EAAC,QAAQ,EAAC,SAAS,EAAE,CAAC;YAClD,oBAAC,gBAAgB,OAAG;YACpB,oBAAC,UAAU,mCAAsC,CAC7C,CACP,CAAC;IACJ,CAAC;IAED,OAAO,CACL,oBAAC,qBAAqB;QACpB,oBAAC,mBAAmB,IAAC,MAAM,EAAE,WAAW;YACtC,oBAAC,YAAY,OAAG,CACI,CACA,CACzB,CAAC;AACJ,CAAC;AAED,eAAe,iCAAiC,CAAC"}

package/lib/src/stories/storybookWrappers/index.d.ts

@@ -0,0 +1,2 @@
+export type { InitialiseFormWrapperProps } from './InitialiseFormWrapperForStorybook';
+export { default as InitialiseFormWrapperForStorybook } from './InitialiseFormWrapperForStorybook';

package/lib/src/stories/storybookWrappers/index.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 { default as InitialiseFormWrapperForStorybook } from './InitialiseFormWrapperForStorybook';
+//# sourceMappingURL=index.js.map

package/lib/src/stories/storybookWrappers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/stories/storybookWrappers/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,OAAO,IAAI,iCAAiC,EAAE,MAAM,qCAAqC,CAAC"}

package/lib/src/tests/test-data/initialValueSample.d.ts

@@ -0,0 +1,2 @@
+import type { Questionnaire } from 'fhir/r4';
+export declare const qInitialValueSample: Questionnaire;