@aehrc/smart-forms-renderer 0.6.3 → 0.6.5

package/README.md

@@ -6,9 +6,9 @@ This React-based package acts as the rendering engine for the [Smart Forms app](
 npm install @aehrc/smart-forms-renderer
 ```
 
-## Usage
+## Basic Usage
 
-```javascript
+```typescript jsx
 import React from 'react';
 import { SmartFormsRenderer, getResponse } from 'aehrc/smart-forms-renderer';
 
@@ -43,7 +43,7 @@ The below props are not supported at the moment, but will be in the future.
 | fhirClient           | [Client](https://github.com/smart-on-fhir/client-js) | FhirClient to perform further FHIR calls    |
 | terminologyServerUrl | string                                               | Terminology server url to fetch terminology |
 
-### Methods
+### Functions
 
 ```javascript
 /**
@@ -56,4 +56,49 @@ function getResponse() {}
 ```
 
 
-### Advanced Usage (If the above does not suffice)
+## Advanced Usage (If basic usage does not suffice)
+
+```typescript
+/* Components */
+// A self-initialising wrapper around the rendering engine. This is sufficient for most use cases.
+
+function SmartFormsRenderer(props: {
+  questionnaire: Questionnaire,
+  questionnaireResponse?: QuestionnaireResponse,
+  additionalVariables?: Record<string, Extension>
+}): JSX.Element {}
+
+// BaseRenderer underneath the SmartFormsRenderer wrapper. Requires buildForm() to initialise form.
+function BaseRenderer(): JSX.Element {}
+
+/* Functions */
+// Get the filled QuestionnaireResponse at its current state.
+// If no changes have been made to the form, the initial QuestionnaireResponse is returned.
+function getResponse(): QuestionnaireResponse {}
+
+// Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
+// If a QuestionnaireResponse is not provided, an empty QuestionnaireResponse is set as the initial QuestionnaireResponse.
+async function buildForm(
+  questionnaire: Questionnaire,
+  questionnaireResponse?: QuestionnaireResponse
+): Promise<void> {}
+
+// Destroy the form to clean up the questionnaire and questionnaireResponse stores.
+function destroyForm(): void {}
+
+// Remove all hidden answers from the filled QuestionnaireResponse.
+// This takes into account the questionnaire-hidden extension, enableWhens and enableWhenExpressions.
+function removeHiddenAnswersFromResponse(
+  questionnaire: Questionnaire,
+  questionnaireResponse: QuestionnaireResponse
+): QuestionnaireResponse {}
+```
+
+The Smart Forms app uses a even finer-grained control which directly interacts with the state management stores.
+
+At the moment there are no plans to document it, but I am happy to do so if there is demand for it.
+Raise a request in https://github.com/aehrc/smart-forms/issues if you want to see it happen!
+
+---
+
+Copyright © 2022, Commonwealth Scientific and Industrial Research Organisation (CSIRO) ABN 41 687 119 230. All rights reserved.

package/lib/index.d.ts

@@ -1,6 +1,5 @@
 import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
 export * from './components';
-export * from './hooks';
 export * from './stores';
 /**
  * Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.

package/lib/index.js

@@ -12,7 +12,6 @@ import { createQuestionnaireResponse } from './utils/qrItem';
 import useQuestionnaireResponseStore from './stores/useQuestionnaireResponseStore';
 import { removeHiddenAnswers } from './utils/removeHidden';
 export * from './components';
-export * from './hooks';
 export * from './stores';
 /**
  * Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,qBAAqB,MAAM,gCAAgC,CAAC;AAEnE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,6BAA6B,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3D,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AAEzB;;;;;GAKG;AACH,MAAM,UAAgB,SAAS,CAC7B,aAA4B,EAC5B,qBAA6C;;QAE7C,MAAM,qBAAqB,CAAC,QAAQ,EAAE,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;QAE/E,IAAI,CAAC,qBAAqB,EAAE;YAC1B,6BAA6B;iBAC1B,QAAQ,EAAE;iBACV,mBAAmB,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC,CAAC;YACnE,OAAO;SACR;QAED,6BAA6B,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;QACpF,qBAAqB,CAAC,QAAQ,EAAE,CAAC,yBAAyB,CAAC,qBAAqB,CAAC,CAAC;IACpF,CAAC;CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,qBAAqB,CAAC,QAAQ,EAAE,CAAC,0BAA0B,EAAE,CAAC;IAC9D,6BAA6B,CAAC,QAAQ,EAAE,CAAC,qBAAqB,EAAE,CAAC;AACnE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,6BAA6B,CAAC,QAAQ,EAAE,CAAC,iBAAiB,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAC7C,aAA4B,EAC5B,qBAA4C;IAE5C,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IACrF,MAAM,eAAe,GAAG,qBAAqB,CAAC,QAAQ,EAAE,CAAC,eAAe,CAAC;IACzE,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IAErF,OAAO,mBAAmB,CAAC;QACzB,aAAa;QACb,qBAAqB;QACrB,qBAAqB;QACrB,eAAe;QACf,qBAAqB;KACtB,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,qBAAqB,MAAM,gCAAgC,CAAC;AAEnE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,6BAA6B,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3D,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AAEzB;;;;;GAKG;AACH,MAAM,UAAgB,SAAS,CAC7B,aAA4B,EAC5B,qBAA6C;;QAE7C,MAAM,qBAAqB,CAAC,QAAQ,EAAE,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;QAE/E,IAAI,CAAC,qBAAqB,EAAE;YAC1B,6BAA6B;iBAC1B,QAAQ,EAAE;iBACV,mBAAmB,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC,CAAC;YACnE,OAAO;SACR;QAED,6BAA6B,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;QACpF,qBAAqB,CAAC,QAAQ,EAAE,CAAC,yBAAyB,CAAC,qBAAqB,CAAC,CAAC;IACpF,CAAC;CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,qBAAqB,CAAC,QAAQ,EAAE,CAAC,0BAA0B,EAAE,CAAC;IAC9D,6BAA6B,CAAC,QAAQ,EAAE,CAAC,qBAAqB,EAAE,CAAC;AACnE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,6BAA6B,CAAC,QAAQ,EAAE,CAAC,iBAAiB,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAC7C,aAA4B,EAC5B,qBAA4C;IAE5C,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IACrF,MAAM,eAAe,GAAG,qBAAqB,CAAC,QAAQ,EAAE,CAAC,eAAe,CAAC;IACzE,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IAErF,OAAO,mBAAmB,CAAC;QACzB,aAAa;QACb,qBAAqB;QACrB,qBAAqB;QACrB,eAAe;QACf,qBAAqB;KACtB,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aehrc/smart-forms-renderer",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "FHIR Structured Data Captured (SDC) rendering engine for Smart Forms",
   "main": "lib/index.js",
   "scripts": {

package/src/index.ts

@@ -5,7 +5,6 @@ import useQuestionnaireResponseStore from './stores/useQuestionnaireResponseStor
 import { removeHiddenAnswers } from './utils/removeHidden';
 
 export * from './components';
-export * from './hooks';
 export * from './stores';
 
 /**

package/src/hooks/index.ts

@@ -1 +0,0 @@
-export { default as useHidden } from './useHidden';