@aehrc/smart-forms-renderer 0.6.4 → 0.6.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -7
- package/lib/interfaces/questionnaireStore.interface.d.ts +1 -1
- package/lib/utils/removeHidden.d.ts +1 -1
- package/lib/utils/removeHidden.js.map +1 -1
- package/package.json +1 -1
- package/src/interfaces/questionnaireStore.interface.ts +1 -1
- package/src/utils/removeHidden.ts +1 -4
package/README.md
CHANGED
|
@@ -57,32 +57,48 @@ function getResponse() {}
|
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
## Advanced Usage (If basic usage does not suffice)
|
|
60
|
+
|
|
60
61
|
```typescript
|
|
61
62
|
/* Components */
|
|
62
63
|
// A self-initialising wrapper around the rendering engine. This is sufficient for most use cases.
|
|
64
|
+
|
|
63
65
|
function SmartFormsRenderer(props: {
|
|
64
66
|
questionnaire: Questionnaire,
|
|
65
67
|
questionnaireResponse?: QuestionnaireResponse,
|
|
66
68
|
additionalVariables?: Record<string, Extension>
|
|
67
|
-
}) {}
|
|
69
|
+
}): JSX.Element {}
|
|
68
70
|
|
|
69
71
|
// BaseRenderer underneath the SmartFormsRenderer wrapper. Requires buildForm() to initialise form.
|
|
70
|
-
function BaseRenderer() {}
|
|
72
|
+
function BaseRenderer(): JSX.Element {}
|
|
71
73
|
|
|
72
74
|
/* Functions */
|
|
73
75
|
// Get the filled QuestionnaireResponse at its current state.
|
|
74
76
|
// If no changes have been made to the form, the initial QuestionnaireResponse is returned.
|
|
75
|
-
function getResponse() {}
|
|
77
|
+
function getResponse(): QuestionnaireResponse {}
|
|
76
78
|
|
|
77
79
|
// Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
|
|
78
80
|
// If a QuestionnaireResponse is not provided, an empty QuestionnaireResponse is set as the initial QuestionnaireResponse.
|
|
79
|
-
function buildForm(
|
|
81
|
+
async function buildForm(
|
|
82
|
+
questionnaire: Questionnaire,
|
|
83
|
+
questionnaireResponse?: QuestionnaireResponse
|
|
84
|
+
): Promise<void> {}
|
|
80
85
|
|
|
81
86
|
// Destroy the form to clean up the questionnaire and questionnaireResponse stores.
|
|
82
|
-
function destroyForm() {}
|
|
83
|
-
|
|
87
|
+
function destroyForm(): void {}
|
|
84
88
|
|
|
85
89
|
// Remove all hidden answers from the filled QuestionnaireResponse.
|
|
86
90
|
// This takes into account the questionnaire-hidden extension, enableWhens and enableWhenExpressions.
|
|
87
|
-
function removeHiddenAnswersFromResponse(
|
|
91
|
+
function removeHiddenAnswersFromResponse(
|
|
92
|
+
questionnaire: Questionnaire,
|
|
93
|
+
questionnaireResponse: QuestionnaireResponse
|
|
94
|
+
): QuestionnaireResponse {}
|
|
88
95
|
```
|
|
96
|
+
|
|
97
|
+
The Smart Forms app uses a even finer-grained control which directly interacts with the state management stores.
|
|
98
|
+
|
|
99
|
+
At the moment there are no plans to document it, but I am happy to do so if there is demand for it.
|
|
100
|
+
Raise a request in https://github.com/aehrc/smart-forms/issues if you want to see it happen!
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
Copyright © 2022, Commonwealth Scientific and Industrial Research Organisation (CSIRO) ABN 41 687 119 230. All rights reserved.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Tabs } from '
|
|
1
|
+
import type { Tabs } from './tab.interface';
|
|
2
2
|
import type { Variables } from './variables.interface';
|
|
3
3
|
import type { LaunchContext } from './populate.interface';
|
|
4
4
|
import type { EnableWhenExpression, EnableWhenItemProperties } from './enableWhen.interface';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
|
|
2
|
-
import type { EnableWhenExpression, EnableWhenItems } from '
|
|
2
|
+
import type { EnableWhenExpression, EnableWhenItems } from '../interfaces/enableWhen.interface';
|
|
3
3
|
interface removeHiddenAnswersParams {
|
|
4
4
|
questionnaire: Questionnaire;
|
|
5
5
|
questionnaireResponse: QuestionnaireResponse;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"removeHidden.js","sourceRoot":"","sources":["../../src/utils/removeHidden.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;
|
|
1
|
+
{"version":3,"file":"removeHidden.js","sourceRoot":"","sources":["../../src/utils/removeHidden.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AASH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAUnC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAiC;IACnE,MAAM,EACJ,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACtB,GAAG,MAAM,CAAC;IAEX,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC;IAC1C,MAAM,eAAe,GAAG,qBAAqB,CAAC,IAAI,CAAC;IACnD,IACE,CAAC,cAAc;QACf,cAAc,CAAC,MAAM,KAAK,CAAC;QAC3B,CAAC,eAAe;QAChB,eAAe,CAAC,MAAM,KAAK,CAAC,EAC5B;QACA,OAAO,qBAAqB,CAAC;KAC9B;IAED,eAAe,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,iBAAiB,GAAG,sCAAsC,CAAC;YAC/D,KAAK;YACL,MAAM;YACN,qBAAqB;YACrB,eAAe;YACf,qBAAqB;SACtB,CAAC,CAAC;QACH,IAAI,iBAAiB,IAAI,qBAAqB,CAAC,IAAI,EAAE;YACnD,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAQ,iBAAiB,CAAE,CAAC;SAC1D;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAUD,SAAS,sCAAsC,CAC7C,MAAoD;IAEpD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,eAAe,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;IAEhG,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC;IAC1B,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC;IAE5B,sBAAsB;IACtB,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/B,kDAAkD;QAClD,IACE,QAAQ,CAAC;YACP,iBAAiB,EAAE,KAAK;YACxB,qBAAqB;YACrB,eAAe;YACf,qBAAqB;SACtB,CAAC;YAEF,OAAO,IAAI,CAAC;QAEd,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,UAAU,GAAgC,EAAE,CAAC;YAEnD,kFAAkF;YAClF,2EAA2E;YAC3E,KACE,IAAI,UAAU,GAAG,CAAC,EAAE,WAAW,GAAG,CAAC,EACnC,UAAU,GAAG,MAAM,CAAC,MAAM,IAAI,WAAW,GAAG,OAAO,CAAC,MAAM,EAC1D,UAAU,EAAE,EACZ;gBACA,kEAAkE;gBAClE,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE;oBACrF,MAAM,SAAS,GAAG,sCAAsC,CAAC;wBACvD,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC;wBACzB,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC;wBAC5B,qBAAqB;wBACrB,eAAe;wBACf,qBAAqB;qBACtB,CAAC,CAAC;oBAEH,IAAI,SAAS,EAAE;wBACb,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;qBAC5B;oBAED,2EAA2E;oBAC3E,+FAA+F;oBAC/F,IACE,OAAO,CAAC,MAAM,KAAK,WAAW,GAAG,CAAC;wBAClC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,MAAM,EAC/D;wBACA,UAAU,EAAE,CAAC;qBACd;oBAED,mGAAmG;oBACnG,WAAW,EAAE,CAAC;iBACf;aACF;YACD,uCAAY,MAAM,KAAE,IAAI,EAAE,UAAU,IAAG;SACxC;QAED,yCAAyC;QACzC,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;KACzC;IAED,0BAA0B;IAC1B,OAAO,QAAQ,CAAC;QACd,iBAAiB,EAAE,KAAK;QACxB,qBAAqB;QACrB,eAAe;QACf,qBAAqB;KACtB,CAAC;QACA,CAAC,CAAC,IAAI;QACN,CAAC,mBAAM,MAAM,CAAE,CAAC;AACpB,CAAC"}
|
package/package.json
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
17
|
|
|
18
|
-
import type { Tabs } from '
|
|
18
|
+
import type { Tabs } from './tab.interface';
|
|
19
19
|
import type { Variables } from './variables.interface';
|
|
20
20
|
import type { LaunchContext } from './populate.interface';
|
|
21
21
|
import type { EnableWhenExpression, EnableWhenItemProperties } from './enableWhen.interface';
|
|
@@ -21,10 +21,7 @@ import type {
|
|
|
21
21
|
QuestionnaireResponse,
|
|
22
22
|
QuestionnaireResponseItem
|
|
23
23
|
} from 'fhir/r4';
|
|
24
|
-
import type {
|
|
25
|
-
EnableWhenExpression,
|
|
26
|
-
EnableWhenItems
|
|
27
|
-
} from 'smart-forms-app/src/types/enableWhen.interface';
|
|
24
|
+
import type { EnableWhenExpression, EnableWhenItems } from '../interfaces/enableWhen.interface';
|
|
28
25
|
import { isHidden } from './qItem';
|
|
29
26
|
|
|
30
27
|
interface removeHiddenAnswersParams {
|