@planning-inspectorate/dynamic-forms 3.8.2 → 3.9.0

package/move-types.js

@@ -0,0 +1,14 @@
+import { copyFile } from 'node:fs/promises';
+import path from 'path';
+
+async function copyAndOverwrite(src, dest) {
+	await copyFile(src, dest);
+	console.log(`Copied ${src} to ${dest}`);
+}
+
+const srcDir = path.join(import.meta.dirname, 'src', 'questions');
+const typesDir = path.join(import.meta.dirname, 'types', 'src', 'questions');
+
+// copy some of the type definition files to the types output that are not automatically included
+copyAndOverwrite(path.join(srcDir, 'question-props.d.ts'), path.join(typesDir, 'question-props.d.ts'));
+copyAndOverwrite(path.join(srcDir, 'question-types.d.ts'), path.join(typesDir, 'question-types.d.ts'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.8.2",
+  "version": "3.9.0",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",
@@ -17,7 +17,7 @@
     "lint": "npx eslint .",
     "format": "prettier --write .",
     "format-check": "prettier --check .",
-    "generate-types": "npx tsc --project tsconfig.json",
+    "generate-types": "npx tsc --project tsconfig.json && node move-types.js",
     "prepare": "node .husky/install.mjs",
     "test": "node --test",
     "test-coverage": "node --test --experimental-test-coverage"
@@ -30,7 +30,7 @@
     "nunjucks": "^3.2.4"
   },
   "imports": {
-    "#question-types": "./src/questions/question-types.ts",
+    "#question-types": "./src/questions/question-types.d.ts",
     "#test/*": "./test/*",
     "#base-validator": "./src/validator/base-validator.js",
     "#journey": "./src/journey/journey.js",

package/src/components/select/index.njk

@@ -4,7 +4,9 @@
 {% from "govuk/components/button/macro.njk" import govukButton %}
 
 {% block head %}
-    <link rel="stylesheet" href="/assets/css/accessible-autocomplete.min.css"/>
+    {% if not question.disableAccessibleAutocomplete %}
+        <link rel="stylesheet" href="/assets/css/accessible-autocomplete.min.css"/>
+    {% endif %}
 
     {{ super() }}
 {% endblock %}
@@ -61,22 +63,24 @@
             </form>
         </div>
     </div>
-    <script src="/assets/js/accessible-autocomplete.min.js"></script>
-    <script {% if cspNonce %}nonce={{ cspNonce }}{% endif %}>
-        if (window.accessibleAutocomplete) {
-            accessibleAutocomplete.enhanceSelectElement({
-                selectElement: document.querySelector('#{{ question.fieldName }}'),
-                onConfirm: () => {
-                    let input = document.querySelector('#{{ question.fieldName }}');
-                    let select = document.querySelector('#{{ question.fieldName }}-select');
-                    let options = Array.from(select.options);
-                    if (!input.value || !options.some(option => option.innerText === input.value)) {
-                        select.options.selectedIndex = -1;
-                    } else {
-                        select.options.selectedIndex = options.findIndex(option => option.innerText === input.value);
+    {% if not question.disableAccessibleAutocomplete %}
+        <script src="/assets/js/accessible-autocomplete.min.js"></script>
+        <script {% if cspNonce %}nonce={{ cspNonce }}{% endif %}>
+            if (window.accessibleAutocomplete) {
+                accessibleAutocomplete.enhanceSelectElement({
+                    selectElement: document.querySelector('#{{ question.fieldName }}'),
+                    onConfirm: () => {
+                        let input = document.querySelector('#{{ question.fieldName }}');
+                        let select = document.querySelector('#{{ question.fieldName }}-select');
+                        let options = Array.from(select.options);
+                        if (!input.value || !options.some(option => option.innerText === input.value)) {
+                            select.options.selectedIndex = -1;
+                        } else {
+                            select.options.selectedIndex = options.findIndex(option => option.innerText === input.value);
+                        }
                     }
-                }
-            })
-        }
-    </script>
+                })
+            }
+        </script>
+    {% endif %}
 {% endblock %}

package/src/components/select/question.js

@@ -1,6 +1,7 @@
 import OptionsQuestion from '../../questions/options-question.js';
 
 export default class SelectQuestion extends OptionsQuestion {
+	#disableAccessibleAutocomplete;
 	/**
 	 * @param {Object} params
 	 * @param {string} params.title
@@ -14,6 +15,7 @@ export default class SelectQuestion extends OptionsQuestion {
 	 * @param {string} [params.label]
 	 * @param {string} [params.html]
 	 * @param {string} [params.legend] - optional legend, used instead of h1
+	 * @param {string} [params.disableAccessibleAutocomplete]
 	 * @param {Array.<import('../../questions/options-question.js').Option>} params.options
 	 * @param {Object<string, any>} [params.viewData]
 	 * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
@@ -30,6 +32,7 @@ export default class SelectQuestion extends OptionsQuestion {
 		label,
 		html,
 		legend,
+		disableAccessibleAutocomplete,
 		options,
 		validators,
 		viewData
@@ -51,6 +54,7 @@ export default class SelectQuestion extends OptionsQuestion {
 		this.html = html;
 		this.label = label;
 		this.legend = legend;
+		this.#disableAccessibleAutocomplete = disableAccessibleAutocomplete;
 	}
 
 	/**
@@ -59,6 +63,7 @@ export default class SelectQuestion extends OptionsQuestion {
 	addCustomDataToViewModel(viewModel) {
 		viewModel.question.label = this.label;
 		viewModel.question.legend = this.legend;
+		viewModel.question.disableAccessibleAutocomplete = this.#disableAccessibleAutocomplete;
 	}
 
 	/**

package/src/components/select/question.test.js

@@ -1,8 +1,9 @@
-import { describe, it } from 'node:test';
+import { describe, it, mock } from 'node:test';
 import assert from 'node:assert';
 import ValidOptionValidator from '../../validator/valid-option-validator.js';
 import SelectQuestion from './question.js';
 import nunjucks from 'nunjucks';
+import { configureNunjucksTestEnv } from '#test/utils/nunjucks.js';
 
 const TITLE = 'Select question';
 const QUESTION = 'A select question';
@@ -94,6 +95,81 @@ describe('./src/dynamic-forms/components/select/question.js', () => {
 		assert.strictEqual(preppedQuestion.question.label, LABEL);
 	});
 
+	it('should pass in disableAccessibleAutocomplete property to view', (ctx) => {
+		nunjucks.render = ctx.mock.fn();
+		nunjucks.render.mock.mockImplementation(() => {});
+
+		const selectQuestion = new SelectQuestion({
+			title: TITLE,
+			question: QUESTION,
+			description: DESCRIPTION,
+			fieldName: FIELDNAME,
+			html: HTML,
+			label: LABEL,
+			options: OPTIONS,
+			disableAccessibleAutocomplete: true
+		});
+
+		const customViewData = { hello: 'hi' };
+
+		const preppedQuestion = selectQuestion.prepQuestionForRendering(SECTION, JOURNEY, customViewData);
+
+		assert.strictEqual(preppedQuestion.question.disableAccessibleAutocomplete, true);
+	});
+
+	it('should include accessible autocomplete by default', async () => {
+		const selectQuestion = new SelectQuestion({
+			title: TITLE,
+			question: QUESTION,
+			description: DESCRIPTION,
+			fieldName: FIELDNAME,
+			html: HTML,
+			label: LABEL,
+			options: OPTIONS
+		});
+		const viewModel = selectQuestion.prepQuestionForRendering(SECTION, JOURNEY, {
+			layoutTemplate: 'views/layout-journey.njk'
+		});
+
+		const nunjucks = configureNunjucksTestEnv();
+		const mockRes = {
+			render: mock.fn((view, data) => nunjucks.render(view + '.njk', data))
+		};
+		selectQuestion.renderAction(mockRes, viewModel);
+
+		assert.strictEqual(mockRes.render.mock.callCount(), 1);
+		const view = mockRes.render.mock.calls[0].result;
+		assert.ok(view);
+		assert.match(view, /accessible-autocomplete\.min\.js/);
+	});
+
+	it('should not include accessible autocomplete if configured', async () => {
+		const selectQuestion = new SelectQuestion({
+			title: TITLE,
+			question: QUESTION,
+			description: DESCRIPTION,
+			fieldName: FIELDNAME,
+			html: HTML,
+			label: LABEL,
+			options: OPTIONS,
+			disableAccessibleAutocomplete: true
+		});
+		const viewModel = selectQuestion.prepQuestionForRendering(SECTION, JOURNEY, {
+			layoutTemplate: 'views/layout-journey.njk'
+		});
+
+		const nunjucks = configureNunjucksTestEnv();
+		const mockRes = {
+			render: mock.fn((view, data) => nunjucks.render(view + '.njk', data))
+		};
+		selectQuestion.renderAction(mockRes, viewModel);
+
+		assert.strictEqual(mockRes.render.mock.callCount(), 1);
+		const view = mockRes.render.mock.calls[0].result;
+		assert.ok(view);
+		assert.doesNotMatch(view, /accessible-autocomplete\.min\.js/);
+	});
+
 	it('should add selected attribute to chosen option', (ctx) => {
 		nunjucks.render = ctx.mock.fn();
 		nunjucks.render.mock.mockImplementation(() => {});

package/src/index.js

@@ -46,8 +46,8 @@ export { createQuestions } from './questions/create-questions.js';
 export * from './questions/options-question.js';
 export { questionClasses } from './questions/questions.js';
 
-export * from './questions/question-props.ts';
-export * from './questions/question-types.ts';
+export * from './questions/question-props.js';
+export * from './questions/question-types.js';
 
 // Section
 export { Section } from './section.js';

package/src/questions/{question-props.ts → question-props.d.ts}

@@ -1,4 +1,4 @@
-import type { QuestionParameters } from '#question-types';
+import type { QuestionParameters } from '#src/questions/question-types.d.ts';
 
 type QuestionTypes =
 	| 'boolean'
@@ -129,6 +129,7 @@ type RadioQuestionProps = CommonQuestionProps & {
 type SelectQuestionProps = CommonQuestionProps & {
 	type: 'select';
 	options: Option[];
+	disableAccessibleAutocomplete?: boolean;
 };
 
 type SingleLineInputQuestionProps = CommonQuestionProps & {

package/src/questions/question-props.js

@@ -0,0 +1 @@
+// empty source file to go with .d.ts file

package/src/questions/question-types.js

@@ -0,0 +1 @@
+// empty source file to go with .d.ts file

package/test/snapshots/travel-class.html

@@ -26,21 +26,21 @@
             </form>
         </div>
     </div>
-    <script src="/assets/js/accessible-autocomplete.min.js"></script>
-    <script >
-        if (window.accessibleAutocomplete) {
-            accessibleAutocomplete.enhanceSelectElement({
-                selectElement: document.querySelector('#travelClass'),
-                onConfirm: () => {
-                    let input = document.querySelector('#travelClass');
-                    let select = document.querySelector('#travelClass-select');
-                    let options = Array.from(select.options);
-                    if (!input.value || !options.some(option => option.innerText === input.value)) {
-                        select.options.selectedIndex = -1;
-                    } else {
-                        select.options.selectedIndex = options.findIndex(option => option.innerText === input.value);
+        <script src="/assets/js/accessible-autocomplete.min.js"></script>
+        <script >
+            if (window.accessibleAutocomplete) {
+                accessibleAutocomplete.enhanceSelectElement({
+                    selectElement: document.querySelector('#travelClass'),
+                    onConfirm: () => {
+                        let input = document.querySelector('#travelClass');
+                        let select = document.querySelector('#travelClass-select');
+                        let options = Array.from(select.options);
+                        if (!input.value || !options.some(option => option.innerText === input.value)) {
+                            select.options.selectedIndex = -1;
+                        } else {
+                            select.options.selectedIndex = options.findIndex(option => option.innerText === input.value);
+                        }
                     }
-                }
-            })
-        }
-    </script>
+                })
+            }
+        </script>

package/tsconfig.json

@@ -20,7 +20,7 @@
 		"target": "esnext",
 		"skipLibCheck": true,
 		"paths": {
-			"#question-types": ["./src/questions/question-types.ts"],
+			"#question-types": ["./src/questions/question-types.d.ts"],
 			"#src/*": ["./src/*"],
 			"#test/*": ["./test/*"],
 			"#question": ["./src/questions/question.js"],

package/types/move-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=move-types.d.ts.map

package/types/move-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"move-types.d.ts","sourceRoot":"","sources":["../move-types.js"],"names":[],"mappings":""}

package/types/src/components/select/question.d.ts

@@ -12,11 +12,12 @@ export default class SelectQuestion extends OptionsQuestion {
      * @param {string} [params.label]
      * @param {string} [params.html]
      * @param {string} [params.legend] - optional legend, used instead of h1
+     * @param {string} [params.disableAccessibleAutocomplete]
      * @param {Array.<import('../../questions/options-question.js').Option>} params.options
      * @param {Object<string, any>} [params.viewData]
      * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
      */
-    constructor({ title, question, fieldName, viewFolder, url, hint, pageTitle, description, label, html, legend, options, validators, viewData }: {
+    constructor({ title, question, fieldName, viewFolder, url, hint, pageTitle, description, label, html, legend, disableAccessibleAutocomplete, options, validators, viewData }: {
         title: string;
         question: string;
         fieldName: string;
@@ -28,6 +29,7 @@ export default class SelectQuestion extends OptionsQuestion {
         label?: string | undefined;
         html?: string | undefined;
         legend?: string | undefined;
+        disableAccessibleAutocomplete?: string | undefined;
         options: Array<import("../../questions/options-question.js").Option>;
         viewData?: {
             [x: string]: any;
@@ -46,6 +48,7 @@ export default class SelectQuestion extends OptionsQuestion {
      * @returns {Array.<Object>}
      */
     formatAnswerForSummary(sectionSegment: string, journey: Journey, answer: Object): Array<Object>;
+    #private;
 }
 import OptionsQuestion from '../../questions/options-question.js';
 //# sourceMappingURL=question.d.ts.map

package/types/src/components/select/question.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/select/question.js"],"names":[],"mappings":"AAEA;IACC;;;;;;;;;;;;;;;;OAgBG;IACH,+IAfG;QAAuB,KAAK,EAApB,MAAM;QACS,QAAQ,EAAvB,MAAM;QACS,SAAS,EAAxB,MAAM;QACU,UAAU;QACV,GAAG;QACH,IAAI;QACJ,SAAS;QACT,WAAW;QACX,KAAK;QACL,IAAI;QACJ,MAAM;QAC+C,OAAO,EAA5E,KAAK,CAAE,OAAO,qCAAqC,EAAE,MAAM,CAAC;QAC/B,QAAQ;;;QACoB,UAAU;KAAC,EAmC9E;IAFA,0BAAkB;IAClB,2BAAoB;IAWrB;;;;;;;;OAQG;IACH,wDAJW,OAAO,UADP,MAAM,GAGJ,KAAK,CAAE,MAAM,CAAC,CAS1B;CACD;4BAhF2B,qCAAqC"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/select/question.js"],"names":[],"mappings":"AAEA;IAEC;;;;;;;;;;;;;;;;;OAiBG;IACH,8KAhBG;QAAuB,KAAK,EAApB,MAAM;QACS,QAAQ,EAAvB,MAAM;QACS,SAAS,EAAxB,MAAM;QACU,UAAU;QACV,GAAG;QACH,IAAI;QACJ,SAAS;QACT,WAAW;QACX,KAAK;QACL,IAAI;QACJ,MAAM;QACN,6BAA6B;QACwB,OAAO,EAA5E,KAAK,CAAE,OAAO,qCAAqC,EAAE,MAAM,CAAC;QAC/B,QAAQ;;;QACoB,UAAU;KAAC,EAqC9E;IAHA,0BAAkB;IAClB,2BAAoB;IAarB;;;;;;;;OAQG;IACH,wDAJW,OAAO,UADP,MAAM,GAGJ,KAAK,CAAE,MAAM,CAAC,CAS1B;;CACD;4BArF2B,qCAAqC"}

package/types/src/index.d.ts

@@ -23,8 +23,8 @@ export * from "./lib/utils.js";
 export * from "./middleware/build-get-journey.js";
 export * from "./middleware/redirect-to-unanswered-question.js";
 export * from "./questions/options-question.js";
-export * from "./questions/question-props.ts";
-export * from "./questions/question-types.ts";
+export * from "./questions/question-props.js";
+export * from "./questions/question-types.js";
 export * from "./validator/address-validator.js";
 export * from "./validator/base-validator.js";
 export * from "./validator/conditional-required-validator.js";

package/types/src/questions/question-props.d.ts

@@ -1,113 +1,174 @@
-import type { QuestionParameters } from '#question-types';
-type QuestionTypes = 'boolean' | 'checkbox' | 'date' | 'date-period' | 'date-time' | 'email' | 'manage-list' | 'multi-field-input' | 'number' | 'radio' | 'select' | 'single-line-input' | 'site-address' | 'text-entry' | 'text-entry-redact' | 'unit-option';
+import type { QuestionParameters } from '#src/questions/question-types.d.ts';
+
+type QuestionTypes =
+	| 'boolean'
+	| 'checkbox'
+	| 'date'
+	| 'date-period'
+	| 'date-time'
+	| 'email'
+	| 'manage-list'
+	| 'multi-field-input'
+	| 'number'
+	| 'radio'
+	| 'select'
+	| 'single-line-input'
+	| 'site-address'
+	| 'text-entry'
+	| 'text-entry-redact'
+	| 'unit-option';
+
 type CommonQuestionProps = Omit<QuestionParameters, 'viewFolder'> & {
-    type: QuestionTypes;
-};
-type Option = {
-    text: string;
-    value: string;
-    hint?: object;
-    checked?: boolean | undefined;
-    attributes?: Record<string, string>;
-    behaviour?: 'exclusive';
-    conditional?: {
-        question: string;
-        type: string;
-        fieldName: string;
-        inputClasses?: string;
-        html?: string;
-        value?: unknown;
-        label?: string;
-        hint?: string;
-    };
-    conditionalText?: {
-        html: string;
-    };
-} | {
-    divider?: string;
-};
+	type: QuestionTypes;
+};
+
+type Option =
+	| {
+			text: string;
+			value: string;
+			hint?: object;
+			checked?: boolean | undefined;
+			attributes?: Record<string, string>;
+			behaviour?: 'exclusive';
+			conditional?: {
+				question: string;
+				type: string;
+				fieldName: string;
+				inputClasses?: string;
+				html?: string;
+				value?: unknown;
+				label?: string;
+				hint?: string;
+			};
+			conditionalText?: {
+				html: string;
+			};
+	  }
+	| { divider?: string };
+
 interface InputField {
-    fieldName: string;
-    label: string;
-    formatJoinString?: string;
-    hint?: string;
+	fieldName: string;
+	label: string;
+	formatJoinString?: string; // optional property, used by formatAnswerForSummary (eg task list display), effective default to line break
+	hint?: string;
 }
+
+/*
+ * UnitOptions are the options displayed in the radio format - in this case the value
+ * represents the unit.
+ * Conditionals must be used to capture the relevant quantity.
+ * Each conditional must have a fieldName which uses the conditionalFieldName from the
+ * UnitOptionEntryQuestion object as a base, followed by an underscore and unit reference
+ * eg 'siteAreaSquareMetres_hectares' - this is required for validation and saving to the DB
+ */
 interface UnitOption {
-    text: string;
-    value: string;
-    hint?: object;
-    checked?: boolean | undefined;
-    attributes?: Record<string, string>;
-    behaviour?: 'exclusive';
-    conditional: {
-        fieldName: string;
-        suffix: string;
-        value?: unknown;
-        label?: string;
-        hint?: string;
-        conversionFactor?: number;
-    };
+	text: string;
+	value: string;
+	hint?: object;
+	checked?: boolean | undefined;
+	attributes?: Record<string, string>;
+	behaviour?: 'exclusive';
+	conditional: {
+		fieldName: string;
+		suffix: string;
+		value?: unknown;
+		label?: string;
+		hint?: string;
+		conversionFactor?: number;
+	};
 }
+
 type BooleanQuestionProps = CommonQuestionProps & {
-    type: 'boolean';
-    options?: Option[];
-    interfaceType?: 'checkbox' | 'radio';
+	type: 'boolean';
+	options?: Option[];
+	interfaceType?: 'checkbox' | 'radio';
 };
+
 type CheckboxQuestionProps = CommonQuestionProps & {
-    type: 'checkbox';
-    options: Option[];
+	type: 'checkbox';
+	options: Option[];
 };
+
 type DateQuestionProps = CommonQuestionProps & {
-    type: 'date';
+	type: 'date';
 };
+
 type DatePeriodQuestionProps = CommonQuestionProps & {
-    type: 'date-period';
+	type: 'date-period';
 };
+
 type DateTimeQuestionProps = CommonQuestionProps & {
-    type: 'date-time';
+	type: 'date-time';
 };
+
 type ManageListQuestionProps = CommonQuestionProps & {
-    type: 'manage-list';
+	type: 'manage-list';
 };
+
 type EmailQuestionProps = CommonQuestionProps & {
-    type: 'email';
+	type: 'email';
 };
+
 type MultiFieldInputQuestionProps = CommonQuestionProps & {
-    type: 'multi-field-input';
-    inputAttributes?: Record<string, string>;
-    inputFields: InputField[];
-    formatType?: 'contactDetails' | 'standard';
+	type: 'multi-field-input';
+	inputAttributes?: Record<string, string>;
+	inputFields: InputField[];
+	formatType?: 'contactDetails' | 'standard';
 };
+
 type NumberEntryQuestionProps = CommonQuestionProps & {
-    type: 'number';
-    suffix?: string;
+	type: 'number';
+	suffix?: string;
 };
+
 type RadioQuestionProps = CommonQuestionProps & {
-    type: 'radio';
-    options: Option[];
+	type: 'radio';
+	options: Option[];
 };
+
 type SelectQuestionProps = CommonQuestionProps & {
-    type: 'select';
-    options: Option[];
+	type: 'select';
+	options: Option[];
+	disableAccessibleAutocomplete?: boolean;
 };
+
 type SingleLineInputQuestionProps = CommonQuestionProps & {
-    type: 'single-line-input';
-    inputAttributes?: Record<string, string>;
+	type: 'single-line-input';
+	inputAttributes?: Record<string, string>;
 };
+
 type SiteAddressQuestionProps = CommonQuestionProps & {
-    type: 'site-address';
+	type: 'site-address';
 };
+
 type TextEntryQuestionProps = CommonQuestionProps & {
-    type: 'text-entry';
+	type: 'text-entry';
 };
+
 type TextEntryRedactQuestionProps = CommonQuestionProps & {
-    type: 'text-entry-redact';
+	type: 'text-entry-redact';
 };
+
 type UnitOptionEntryQuestionProps = CommonQuestionProps & {
-    type: 'unit-option';
-    conditionalFieldName: string;
-    options: UnitOption[];
-};
-export type QuestionProps = BooleanQuestionProps | CheckboxQuestionProps | DateQuestionProps | DatePeriodQuestionProps | DateTimeQuestionProps | ManageListQuestionProps | EmailQuestionProps | MultiFieldInputQuestionProps | NumberEntryQuestionProps | RadioQuestionProps | SelectQuestionProps | SingleLineInputQuestionProps | SiteAddressQuestionProps | TextEntryQuestionProps | TextEntryRedactQuestionProps | UnitOptionEntryQuestionProps;
-export {};
-//# sourceMappingURL=question-props.d.ts.map
+	type: 'unit-option';
+	conditionalFieldName: string;
+	options: UnitOption[];
+};
+
+export type QuestionProps =
+	| BooleanQuestionProps
+	| CheckboxQuestionProps
+	| DateQuestionProps
+	| DatePeriodQuestionProps
+	| DateTimeQuestionProps
+	| ManageListQuestionProps
+	| EmailQuestionProps
+	| MultiFieldInputQuestionProps
+	| NumberEntryQuestionProps
+	| RadioQuestionProps
+	| SelectQuestionProps
+	| SingleLineInputQuestionProps
+	| SiteAddressQuestionProps
+	| TextEntryQuestionProps
+	| TextEntryRedactQuestionProps
+	| UnitOptionEntryQuestionProps;

package/types/src/questions/question-props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question-props.d.ts","sourceRoot":"","sources":["../../../src/questions/question-props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1D,KAAK,aAAa,GACf,SAAS,GACT,UAAU,GACV,MAAM,GACN,aAAa,GACb,WAAW,GACX,OAAO,GACP,aAAa,GACb,mBAAmB,GACnB,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,mBAAmB,GACnB,cAAc,GACd,YAAY,GACZ,mBAAmB,GACnB,aAAa,CAAC;AAEjB,KAAK,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,GAAG;IACnE,IAAI,EAAE,aAAa,CAAC;CACpB,CAAC;AAEF,KAAK,MAAM,GACR;IACA,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,WAAW,CAAC,EAAE;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,eAAe,CAAC,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;KACb,CAAC;CACD,GACD;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExB,UAAU,UAAU;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAUD,UAAU,UAAU;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,WAAW,EAAE;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACF;AAED,KAAK,oBAAoB,GAAG,mBAAmB,GAAG;IACjD,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC;CACrC,CAAC;AAEF,KAAK,qBAAqB,GAAG,mBAAmB,GAAG;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,KAAK,iBAAiB,GAAG,mBAAmB,GAAG;IAC9C,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,KAAK,uBAAuB,GAAG,mBAAmB,GAAG;IACpD,IAAI,EAAE,aAAa,CAAC;CACpB,CAAC;AAEF,KAAK,qBAAqB,GAAG,mBAAmB,GAAG;IAClD,IAAI,EAAE,WAAW,CAAC;CAClB,CAAC;AAEF,KAAK,uBAAuB,GAAG,mBAAmB,GAAG;IACpD,IAAI,EAAE,aAAa,CAAC;CACpB,CAAC;AAEF,KAAK,kBAAkB,GAAG,mBAAmB,GAAG;IAC/C,IAAI,EAAE,OAAO,CAAC;CACd,CAAC;AAEF,KAAK,4BAA4B,GAAG,mBAAmB,GAAG;IACzD,IAAI,EAAE,mBAAmB,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,UAAU,CAAC,EAAE,gBAAgB,GAAG,UAAU,CAAC;CAC3C,CAAC;AAEF,KAAK,wBAAwB,GAAG,mBAAmB,GAAG;IACrD,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,kBAAkB,GAAG,mBAAmB,GAAG;IAC/C,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,KAAK,mBAAmB,GAAG,mBAAmB,GAAG;IAChD,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,KAAK,4BAA4B,GAAG,mBAAmB,GAAG;IACzD,IAAI,EAAE,mBAAmB,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC,CAAC;AAEF,KAAK,wBAAwB,GAAG,mBAAmB,GAAG;IACrD,IAAI,EAAE,cAAc,CAAC;CACrB,CAAC;AAEF,KAAK,sBAAsB,GAAG,mBAAmB,GAAG;IACnD,IAAI,EAAE,YAAY,CAAC;CACnB,CAAC;AAEF,KAAK,4BAA4B,GAAG,mBAAmB,GAAG;IACzD,IAAI,EAAE,mBAAmB,CAAC;CAC1B,CAAC;AAEF,KAAK,4BAA4B,GAAG,mBAAmB,GAAG;IACzD,IAAI,EAAE,aAAa,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,UAAU,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,aAAa,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,uBAAuB,GACvB,kBAAkB,GAClB,4BAA4B,GAC5B,wBAAwB,GACxB,kBAAkB,GAClB,mBAAmB,GACnB,4BAA4B,GAC5B,wBAAwB,GACxB,sBAAsB,GACtB,4BAA4B,GAC5B,4BAA4B,CAAC"}
+{"version":3,"file":"question-props.d.ts","sourceRoot":"","sources":["../../../src/questions/question-props.js"],"names":[],"mappings":""}

package/types/src/questions/question-types.d.ts

@@ -2,48 +2,54 @@ import type { RouteParams } from '#src/journey/journey-types.d.ts';
 import type ManageListQuestion from '#src/components/manage-list/question.js';
 import type BaseValidator from '../validator/base-validator.js';
 import type { JourneyResponse } from '../journey/journey-response.js';
+
 export interface QuestionParameters {
-    title: string;
-    question: string;
-    viewFolder: string;
-    fieldName: string;
-    url?: string;
-    pageTitle?: string;
-    description?: string;
-    validators?: BaseValidator[];
-    html?: string;
-    hint?: string;
-    interfaceType?: string;
-    shouldDisplay?: (response: JourneyResponse) => boolean;
-    autocomplete?: string;
-    editable?: boolean;
-    actionLink?: ActionLink;
-    viewData?: Record<string, any>;
+	title: string;
+	question: string;
+	viewFolder: string;
+	fieldName: string;
+	url?: string;
+	pageTitle?: string;
+	description?: string;
+	validators?: BaseValidator[];
+	html?: string;
+	hint?: string;
+	interfaceType?: string;
+	shouldDisplay?: (response: JourneyResponse) => boolean;
+	autocomplete?: string;
+	// is this question editable? defaults to true
+	editable?: boolean;
+	// override the action link for this question
+	actionLink?: ActionLink;
+	// static view data for this question
+	viewData?: Record<string, any>;
 }
+
 export interface ActionLink {
-    text: string;
-    href: string;
+	text: string;
+	href: string;
 }
+
 export interface QuestionViewModel {
-    question: {
-        value: string | number | Record<string, any>;
-        question: string;
-        fieldName: string;
-        pageTitle: string;
-        description?: string;
-        html?: string;
-    };
-    layoutTemplate: string;
-    pageCaption: string;
-    continueButtonText: string;
-    backLink: string;
-    showBackToListLink: string;
-    listLink: string;
-    journeyTitle: string;
-    [k: string]: any;
+	question: {
+		value: string | number | Record<string, any>;
+		question: string;
+		fieldName: string;
+		pageTitle: string;
+		description?: string;
+		html?: string;
+	};
+	layoutTemplate: string;
+	pageCaption: string;
+	continueButtonText: string;
+	backLink: string;
+	showBackToListLink: string;
+	listLink: string;
+	journeyTitle: string;
+	[k: string]: any;
 }
+
 export interface PrepQuestionForRenderingOptions {
-    params: RouteParams;
-    manageListQuestion?: ManageListQuestion;
+	params: RouteParams;
+	manageListQuestion?: ManageListQuestion;
 }
-//# sourceMappingURL=question-types.d.ts.map

package/types/src/questions/question-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question-types.d.ts","sourceRoot":"","sources":["../../../src/questions/question-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,kBAAkB,MAAM,yCAAyC,CAAC;AAC9E,OAAO,KAAK,aAAa,MAAM,gCAAgC,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEtE,MAAM,WAAW,kBAAkB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,OAAO,CAAC;IACvD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iBAAiB;IACjC,QAAQ,EAAE;QACT,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7C,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACjB;AAED,MAAM,WAAW,+BAA+B;IAC/C,MAAM,EAAE,WAAW,CAAC;IACpB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACxC"}
+{"version":3,"file":"question-types.d.ts","sourceRoot":"","sources":["../../../src/questions/question-types.js"],"names":[],"mappings":""}