@planning-inspectorate/dynamic-forms 3.8.2 → 3.8.3
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/move-types.js +14 -0
- package/package.json +3 -3
- package/src/index.js +2 -2
- package/src/questions/{question-props.ts → question-props.d.ts} +1 -1
- package/src/questions/question-props.js +1 -0
- package/src/questions/question-types.js +1 -0
- package/tsconfig.json +1 -1
- package/types/move-types.d.ts +2 -0
- package/types/move-types.d.ts.map +1 -0
- package/types/src/index.d.ts +2 -2
- package/types/src/questions/question-props.d.ts +137 -77
- package/types/src/questions/question-props.d.ts.map +1 -1
- package/types/src/questions/question-types.d.ts +43 -37
- package/types/src/questions/question-types.d.ts.map +1 -1
- /package/src/questions/{question-types.ts → question-types.d.ts} +0 -0
package/move-types.js
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { copyFile } from 'node:fs/promises';
|
|
2
|
+
import path from 'path';
|
|
3
|
+
|
|
4
|
+
async function copyAndOverwrite(src, dest) {
|
|
5
|
+
await copyFile(src, dest);
|
|
6
|
+
console.log(`Copied ${src} to ${dest}`);
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
const srcDir = path.join(import.meta.dirname, 'src', 'questions');
|
|
10
|
+
const typesDir = path.join(import.meta.dirname, 'types', 'src', 'questions');
|
|
11
|
+
|
|
12
|
+
// copy some of the type definition files to the types output that are not automatically included
|
|
13
|
+
copyAndOverwrite(path.join(srcDir, 'question-props.d.ts'), path.join(typesDir, 'question-props.d.ts'));
|
|
14
|
+
copyAndOverwrite(path.join(srcDir, 'question-types.d.ts'), path.join(typesDir, 'question-types.d.ts'));
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@planning-inspectorate/dynamic-forms",
|
|
3
|
-
"version": "3.8.
|
|
3
|
+
"version": "3.8.3",
|
|
4
4
|
"description": "This package is for building GDS forms using a configuration-based approach.",
|
|
5
5
|
"main": "./src/index.js",
|
|
6
6
|
"type": "module",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"lint": "npx eslint .",
|
|
18
18
|
"format": "prettier --write .",
|
|
19
19
|
"format-check": "prettier --check .",
|
|
20
|
-
"generate-types": "npx tsc --project tsconfig.json",
|
|
20
|
+
"generate-types": "npx tsc --project tsconfig.json && node move-types.js",
|
|
21
21
|
"prepare": "node .husky/install.mjs",
|
|
22
22
|
"test": "node --test",
|
|
23
23
|
"test-coverage": "node --test --experimental-test-coverage"
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"nunjucks": "^3.2.4"
|
|
31
31
|
},
|
|
32
32
|
"imports": {
|
|
33
|
-
"#question-types": "./src/questions/question-types.ts",
|
|
33
|
+
"#question-types": "./src/questions/question-types.d.ts",
|
|
34
34
|
"#test/*": "./test/*",
|
|
35
35
|
"#base-validator": "./src/validator/base-validator.js",
|
|
36
36
|
"#journey": "./src/journey/journey.js",
|
package/src/index.js
CHANGED
|
@@ -46,8 +46,8 @@ export { createQuestions } from './questions/create-questions.js';
|
|
|
46
46
|
export * from './questions/options-question.js';
|
|
47
47
|
export { questionClasses } from './questions/questions.js';
|
|
48
48
|
|
|
49
|
-
export * from './questions/question-props.
|
|
50
|
-
export * from './questions/question-types.
|
|
49
|
+
export * from './questions/question-props.js';
|
|
50
|
+
export * from './questions/question-types.js';
|
|
51
51
|
|
|
52
52
|
// Section
|
|
53
53
|
export { Section } from './section.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
// empty source file to go with .d.ts file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
// empty source file to go with .d.ts file
|
package/tsconfig.json
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"target": "esnext",
|
|
21
21
|
"skipLibCheck": true,
|
|
22
22
|
"paths": {
|
|
23
|
-
"#question-types": ["./src/questions/question-types.ts"],
|
|
23
|
+
"#question-types": ["./src/questions/question-types.d.ts"],
|
|
24
24
|
"#src/*": ["./src/*"],
|
|
25
25
|
"#test/*": ["./test/*"],
|
|
26
26
|
"#question": ["./src/questions/question.js"],
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"move-types.d.ts","sourceRoot":"","sources":["../move-types.js"],"names":[],"mappings":""}
|
package/types/src/index.d.ts
CHANGED
|
@@ -23,8 +23,8 @@ export * from "./lib/utils.js";
|
|
|
23
23
|
export * from "./middleware/build-get-journey.js";
|
|
24
24
|
export * from "./middleware/redirect-to-unanswered-question.js";
|
|
25
25
|
export * from "./questions/options-question.js";
|
|
26
|
-
export * from "./questions/question-props.
|
|
27
|
-
export * from "./questions/question-types.
|
|
26
|
+
export * from "./questions/question-props.js";
|
|
27
|
+
export * from "./questions/question-types.js";
|
|
28
28
|
export * from "./validator/address-validator.js";
|
|
29
29
|
export * from "./validator/base-validator.js";
|
|
30
30
|
export * from "./validator/conditional-required-validator.js";
|
|
@@ -1,113 +1,173 @@
|
|
|
1
|
-
import type { QuestionParameters } from '#question-types';
|
|
2
|
-
|
|
1
|
+
import type { QuestionParameters } from '#src/questions/question-types.d.ts';
|
|
2
|
+
|
|
3
|
+
type QuestionTypes =
|
|
4
|
+
| 'boolean'
|
|
5
|
+
| 'checkbox'
|
|
6
|
+
| 'date'
|
|
7
|
+
| 'date-period'
|
|
8
|
+
| 'date-time'
|
|
9
|
+
| 'email'
|
|
10
|
+
| 'manage-list'
|
|
11
|
+
| 'multi-field-input'
|
|
12
|
+
| 'number'
|
|
13
|
+
| 'radio'
|
|
14
|
+
| 'select'
|
|
15
|
+
| 'single-line-input'
|
|
16
|
+
| 'site-address'
|
|
17
|
+
| 'text-entry'
|
|
18
|
+
| 'text-entry-redact'
|
|
19
|
+
| 'unit-option';
|
|
20
|
+
|
|
3
21
|
type CommonQuestionProps = Omit<QuestionParameters, 'viewFolder'> & {
|
|
4
|
-
|
|
5
|
-
};
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
}
|
|
22
|
+
type: QuestionTypes;
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
type Option =
|
|
26
|
+
| {
|
|
27
|
+
text: string;
|
|
28
|
+
value: string;
|
|
29
|
+
hint?: object;
|
|
30
|
+
checked?: boolean | undefined;
|
|
31
|
+
attributes?: Record<string, string>;
|
|
32
|
+
behaviour?: 'exclusive';
|
|
33
|
+
conditional?: {
|
|
34
|
+
question: string;
|
|
35
|
+
type: string;
|
|
36
|
+
fieldName: string;
|
|
37
|
+
inputClasses?: string;
|
|
38
|
+
html?: string;
|
|
39
|
+
value?: unknown;
|
|
40
|
+
label?: string;
|
|
41
|
+
hint?: string;
|
|
42
|
+
};
|
|
43
|
+
conditionalText?: {
|
|
44
|
+
html: string;
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
| { divider?: string };
|
|
48
|
+
|
|
29
49
|
interface InputField {
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
50
|
+
fieldName: string;
|
|
51
|
+
label: string;
|
|
52
|
+
formatJoinString?: string; // optional property, used by formatAnswerForSummary (eg task list display), effective default to line break
|
|
53
|
+
hint?: string;
|
|
34
54
|
}
|
|
55
|
+
|
|
56
|
+
/*
|
|
57
|
+
* UnitOptions are the options displayed in the radio format - in this case the value
|
|
58
|
+
* represents the unit.
|
|
59
|
+
* Conditionals must be used to capture the relevant quantity.
|
|
60
|
+
* Each conditional must have a fieldName which uses the conditionalFieldName from the
|
|
61
|
+
* UnitOptionEntryQuestion object as a base, followed by an underscore and unit reference
|
|
62
|
+
* eg 'siteAreaSquareMetres_hectares' - this is required for validation and saving to the DB
|
|
63
|
+
*/
|
|
35
64
|
interface UnitOption {
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
65
|
+
text: string;
|
|
66
|
+
value: string;
|
|
67
|
+
hint?: object;
|
|
68
|
+
checked?: boolean | undefined;
|
|
69
|
+
attributes?: Record<string, string>;
|
|
70
|
+
behaviour?: 'exclusive';
|
|
71
|
+
conditional: {
|
|
72
|
+
fieldName: string;
|
|
73
|
+
suffix: string;
|
|
74
|
+
value?: unknown;
|
|
75
|
+
label?: string;
|
|
76
|
+
hint?: string;
|
|
77
|
+
conversionFactor?: number;
|
|
78
|
+
};
|
|
50
79
|
}
|
|
80
|
+
|
|
51
81
|
type BooleanQuestionProps = CommonQuestionProps & {
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
82
|
+
type: 'boolean';
|
|
83
|
+
options?: Option[];
|
|
84
|
+
interfaceType?: 'checkbox' | 'radio';
|
|
55
85
|
};
|
|
86
|
+
|
|
56
87
|
type CheckboxQuestionProps = CommonQuestionProps & {
|
|
57
|
-
|
|
58
|
-
|
|
88
|
+
type: 'checkbox';
|
|
89
|
+
options: Option[];
|
|
59
90
|
};
|
|
91
|
+
|
|
60
92
|
type DateQuestionProps = CommonQuestionProps & {
|
|
61
|
-
|
|
93
|
+
type: 'date';
|
|
62
94
|
};
|
|
95
|
+
|
|
63
96
|
type DatePeriodQuestionProps = CommonQuestionProps & {
|
|
64
|
-
|
|
97
|
+
type: 'date-period';
|
|
65
98
|
};
|
|
99
|
+
|
|
66
100
|
type DateTimeQuestionProps = CommonQuestionProps & {
|
|
67
|
-
|
|
101
|
+
type: 'date-time';
|
|
68
102
|
};
|
|
103
|
+
|
|
69
104
|
type ManageListQuestionProps = CommonQuestionProps & {
|
|
70
|
-
|
|
105
|
+
type: 'manage-list';
|
|
71
106
|
};
|
|
107
|
+
|
|
72
108
|
type EmailQuestionProps = CommonQuestionProps & {
|
|
73
|
-
|
|
109
|
+
type: 'email';
|
|
74
110
|
};
|
|
111
|
+
|
|
75
112
|
type MultiFieldInputQuestionProps = CommonQuestionProps & {
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
113
|
+
type: 'multi-field-input';
|
|
114
|
+
inputAttributes?: Record<string, string>;
|
|
115
|
+
inputFields: InputField[];
|
|
116
|
+
formatType?: 'contactDetails' | 'standard';
|
|
80
117
|
};
|
|
118
|
+
|
|
81
119
|
type NumberEntryQuestionProps = CommonQuestionProps & {
|
|
82
|
-
|
|
83
|
-
|
|
120
|
+
type: 'number';
|
|
121
|
+
suffix?: string;
|
|
84
122
|
};
|
|
123
|
+
|
|
85
124
|
type RadioQuestionProps = CommonQuestionProps & {
|
|
86
|
-
|
|
87
|
-
|
|
125
|
+
type: 'radio';
|
|
126
|
+
options: Option[];
|
|
88
127
|
};
|
|
128
|
+
|
|
89
129
|
type SelectQuestionProps = CommonQuestionProps & {
|
|
90
|
-
|
|
91
|
-
|
|
130
|
+
type: 'select';
|
|
131
|
+
options: Option[];
|
|
92
132
|
};
|
|
133
|
+
|
|
93
134
|
type SingleLineInputQuestionProps = CommonQuestionProps & {
|
|
94
|
-
|
|
95
|
-
|
|
135
|
+
type: 'single-line-input';
|
|
136
|
+
inputAttributes?: Record<string, string>;
|
|
96
137
|
};
|
|
138
|
+
|
|
97
139
|
type SiteAddressQuestionProps = CommonQuestionProps & {
|
|
98
|
-
|
|
140
|
+
type: 'site-address';
|
|
99
141
|
};
|
|
142
|
+
|
|
100
143
|
type TextEntryQuestionProps = CommonQuestionProps & {
|
|
101
|
-
|
|
144
|
+
type: 'text-entry';
|
|
102
145
|
};
|
|
146
|
+
|
|
103
147
|
type TextEntryRedactQuestionProps = CommonQuestionProps & {
|
|
104
|
-
|
|
148
|
+
type: 'text-entry-redact';
|
|
105
149
|
};
|
|
150
|
+
|
|
106
151
|
type UnitOptionEntryQuestionProps = CommonQuestionProps & {
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
};
|
|
111
|
-
|
|
112
|
-
export
|
|
113
|
-
|
|
152
|
+
type: 'unit-option';
|
|
153
|
+
conditionalFieldName: string;
|
|
154
|
+
options: UnitOption[];
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
export type QuestionProps =
|
|
158
|
+
| BooleanQuestionProps
|
|
159
|
+
| CheckboxQuestionProps
|
|
160
|
+
| DateQuestionProps
|
|
161
|
+
| DatePeriodQuestionProps
|
|
162
|
+
| DateTimeQuestionProps
|
|
163
|
+
| ManageListQuestionProps
|
|
164
|
+
| EmailQuestionProps
|
|
165
|
+
| MultiFieldInputQuestionProps
|
|
166
|
+
| NumberEntryQuestionProps
|
|
167
|
+
| RadioQuestionProps
|
|
168
|
+
| SelectQuestionProps
|
|
169
|
+
| SingleLineInputQuestionProps
|
|
170
|
+
| SiteAddressQuestionProps
|
|
171
|
+
| TextEntryQuestionProps
|
|
172
|
+
| TextEntryRedactQuestionProps
|
|
173
|
+
| UnitOptionEntryQuestionProps;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"question-props.d.ts","sourceRoot":"","sources":["../../../src/questions/question-props.
|
|
1
|
+
{"version":3,"file":"question-props.d.ts","sourceRoot":"","sources":["../../../src/questions/question-props.js"],"names":[],"mappings":""}
|
|
@@ -2,48 +2,54 @@ import type { RouteParams } from '#src/journey/journey-types.d.ts';
|
|
|
2
2
|
import type ManageListQuestion from '#src/components/manage-list/question.js';
|
|
3
3
|
import type BaseValidator from '../validator/base-validator.js';
|
|
4
4
|
import type { JourneyResponse } from '../journey/journey-response.js';
|
|
5
|
+
|
|
5
6
|
export interface QuestionParameters {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
7
|
+
title: string;
|
|
8
|
+
question: string;
|
|
9
|
+
viewFolder: string;
|
|
10
|
+
fieldName: string;
|
|
11
|
+
url?: string;
|
|
12
|
+
pageTitle?: string;
|
|
13
|
+
description?: string;
|
|
14
|
+
validators?: BaseValidator[];
|
|
15
|
+
html?: string;
|
|
16
|
+
hint?: string;
|
|
17
|
+
interfaceType?: string;
|
|
18
|
+
shouldDisplay?: (response: JourneyResponse) => boolean;
|
|
19
|
+
autocomplete?: string;
|
|
20
|
+
// is this question editable? defaults to true
|
|
21
|
+
editable?: boolean;
|
|
22
|
+
// override the action link for this question
|
|
23
|
+
actionLink?: ActionLink;
|
|
24
|
+
// static view data for this question
|
|
25
|
+
viewData?: Record<string, any>;
|
|
22
26
|
}
|
|
27
|
+
|
|
23
28
|
export interface ActionLink {
|
|
24
|
-
|
|
25
|
-
|
|
29
|
+
text: string;
|
|
30
|
+
href: string;
|
|
26
31
|
}
|
|
32
|
+
|
|
27
33
|
export interface QuestionViewModel {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
34
|
+
question: {
|
|
35
|
+
value: string | number | Record<string, any>;
|
|
36
|
+
question: string;
|
|
37
|
+
fieldName: string;
|
|
38
|
+
pageTitle: string;
|
|
39
|
+
description?: string;
|
|
40
|
+
html?: string;
|
|
41
|
+
};
|
|
42
|
+
layoutTemplate: string;
|
|
43
|
+
pageCaption: string;
|
|
44
|
+
continueButtonText: string;
|
|
45
|
+
backLink: string;
|
|
46
|
+
showBackToListLink: string;
|
|
47
|
+
listLink: string;
|
|
48
|
+
journeyTitle: string;
|
|
49
|
+
[k: string]: any;
|
|
44
50
|
}
|
|
51
|
+
|
|
45
52
|
export interface PrepQuestionForRenderingOptions {
|
|
46
|
-
|
|
47
|
-
|
|
53
|
+
params: RouteParams;
|
|
54
|
+
manageListQuestion?: ManageListQuestion;
|
|
48
55
|
}
|
|
49
|
-
//# sourceMappingURL=question-types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"question-types.d.ts","sourceRoot":"","sources":["../../../src/questions/question-types.
|
|
1
|
+
{"version":3,"file":"question-types.d.ts","sourceRoot":"","sources":["../../../src/questions/question-types.js"],"names":[],"mappings":""}
|
|
File without changes
|