@planning-inspectorate/dynamic-forms 3.7.0 → 3.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",
@@ -9,6 +9,9 @@
     "type": "git",
     "url": "git+https://github.com/Planning-Inspectorate/dynamic-forms.git"
   },
+  "engines": {
+    "node": ">=22.18.0"
+  },
   "scripts": {
     "commitlint": "commitlint --from=$(git rev-parse $(git cherry origin/main | head -n 1 | cut -c 3-)^1)",
     "lint": "npx eslint .",
@@ -27,7 +30,7 @@
     "nunjucks": "^3.2.4"
   },
   "imports": {
-    "#question-types": "./src/questions/question-types.d.ts",
+    "#question-types": "./src/questions/question-types.ts",
     "#test/*": "./test/*",
     "#base-validator": "./src/validator/base-validator.js",
     "#journey": "./src/journey/journey.js",

package/src/components/date-time/question.js

@@ -9,7 +9,7 @@ export default class DateTimeQuestion extends Question {
 	static PM = 'pm';
 
 	/**
-	 * @param {import('@planning-inspectorate/dynamic-forms/src/questions/question-types.js').QuestionParameters} params
+	 * @param {import('#question-types').QuestionParameters} params
 	 * @param {string} [params.dateFormat]
 	 * @param {string} [params.timeFormat]
 	 */

package/src/components/radio/question.js

@@ -18,7 +18,7 @@ export default class RadioQuestion extends OptionsQuestion {
 	 * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
 	 * @param {boolean} [params.editable]
 	 * @param {Object<string, any>} [params.viewData]
-	 * @param {import('../../questions/question-types.js').ActionLink} [params.actionLink]
+	 * @param {import('#question-types').ActionLink} [params.actionLink]
 	 */
 	constructor({
 		title,

package/src/components/unit-option-entry/question.js

@@ -1,6 +1,7 @@
 import nunjucks from 'nunjucks';
 import { Question } from '../../questions/question.js';
 import { conditionalIsJustHTML } from '../utils/question-utils.js';
+import { toArray } from '#src/lib/utils.js';
 
 const defaultOptionJoinString = ',';
 
@@ -64,7 +65,7 @@ export default class UnitOptionEntryQuestion extends Question {
 	 * @param {import('#journey').Journey} journey - the journey we are in
 	 * @param {Record<string, unknown>} [customViewData] additional data to send to view
 	 * @param {Record<string, unknown>} [payload]
-	 * @param {import('#src/questions/question-types.d.ts').PrepQuestionForRenderingOptions} options
+	 * @param {import('#question-types').PrepQuestionForRenderingOptions} options
 	 * @returns {import('#question').QuestionViewModel & {
 	 *   question: import('#question').QuestionViewModel['question'] & {
 	 *     options:UnitOption[]
@@ -132,7 +133,7 @@ export default class UnitOptionEntryQuestion extends Question {
 		const answers = {};
 
 		/** @type {string[]} */
-		const fields = Array.isArray(req.body[this.fieldName]) ? req.body[this.fieldName] : [req.body[this.fieldName]];
+		const fields = toArray(req.body[this.fieldName]);
 		const fieldValues = fields.map((x) => x.trim());
 
 		const selectedOptions = this.options.filter(({ value }) => {

package/src/controller.js

@@ -3,6 +3,7 @@ import questionUtils from './components/utils/question-utils.js';
 import { answerObjectForManageListSaving } from '#src/components/manage-list/utils.js';
 import { booleanToYesNoValue } from '#src/components/boolean/question.js';
 import { MANAGE_LIST_ACTIONS } from '#src/components/manage-list/manage-list-actions.js';
+import { toArray } from '#src/lib/utils.js';
 
 /**
  * @typedef {import('./journey/journey.js').Journey} Journey
@@ -64,7 +65,7 @@ function buildSectionRowViewModel(key, value, action) {
 			html: value
 		},
 		actions: {
-			items: Array.isArray(action) ? action : [action]
+			items: toArray(action)
 		}
 	};
 }

package/src/index.js

@@ -46,6 +46,9 @@ 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';
+
 // Section
 export { Section } from './section.js';
 

package/src/lib/utils.js

@@ -28,3 +28,13 @@ export function trimTrailingSlash(str) {
 	if (typeof str !== 'string') return str;
 	return str.replace(/\/$/, '');
 }
+
+/**
+ * Convert a value to an array, unless it is already
+ *
+ * @param {T|T[]} value
+ * @template T
+ */
+export function toArray(value) {
+	return Array.isArray(value) ? value : [value];
+}

package/src/lib/utils.test.js

@@ -1,6 +1,6 @@
 import { describe, it } from 'node:test';
 import assert from 'node:assert';
-import { trimTrailingSlash } from '#src/lib/utils.js';
+import { toArray, trimTrailingSlash } from '#src/lib/utils.js';
 
 describe('utils', () => {
 	describe('trimTrailingSlash', () => {
@@ -16,4 +16,20 @@ describe('utils', () => {
 			assert.strictEqual(trimTrailingSlash(5), 5);
 		});
 	});
+	describe('toArray', () => {
+		it('should create an array if a value is provided', () => {
+			const values = [true, false, 'string', 123, null, { hello: 'world' }];
+			for (const value of values) {
+				const asArray = toArray(value);
+				assert.ok(Array.isArray(asArray));
+				assert.strictEqual(asArray.length, 1);
+				assert.strictEqual(asArray[0], value);
+			}
+		});
+		it('should leave an array as-is', () => {
+			const array = [1, 'string', 2];
+			const asArray = toArray(array);
+			assert.strictEqual(array, asArray);
+		});
+	});
 });

package/src/questions/options-question.js

@@ -2,6 +2,7 @@ import nunjucks from 'nunjucks';
 import { Question } from './question.js';
 import ValidOptionValidator from '../validator/valid-option-validator.js';
 import { getConditionalFieldName } from '../components/utils/question-utils.js';
+import { toArray } from '#src/lib/utils.js';
 
 const defaultOptionJoinString = ',';
 
@@ -62,7 +63,7 @@ export default class OptionsQuestion extends Question {
 	 * @param {import('#journey').Journey} journey - the journey we are in
 	 * @param {Record<string, unknown>} [customViewData] additional data to send to view
 	 * @param {Record<string, unknown>} [payload]
-	 * @param {import('#src/questions/question-types.d.ts').PrepQuestionForRenderingOptions} options
+	 * @param {import('#question-types').PrepQuestionForRenderingOptions} options
 	 * @returns {import('./question').QuestionViewModel} QuestionViewModel
 	 */
 	prepQuestionForRendering(section, journey, customViewData, payload, options) {
@@ -124,14 +125,14 @@ export default class OptionsQuestion extends Question {
 	async getDataToSave(req, journeyResponse) {
 		const answers = {};
 
-		const fields = Array.isArray(req.body[this.fieldName]) ? req.body[this.fieldName] : [req.body[this.fieldName]];
+		const fields = req.body[this.fieldName] !== undefined ? toArray(req.body[this.fieldName]) : [];
 		const fieldValues = fields.map((x) => x.trim());
 
 		const selectedOptions = this.options.filter(({ value }) => {
 			return fieldValues.includes(value);
 		});
 
-		if (!selectedOptions.length)
+		if (selectedOptions.length !== fieldValues.length)
 			throw new Error(`User submitted option(s) did not correlate with valid answers to ${this.fieldName} question`);
 
 		answers[this.fieldName] = fieldValues.join(this.optionJoinString);

package/src/questions/options-question.test.js

@@ -220,4 +220,87 @@ describe('./src/dynamic-forms/question.js', () => {
 			assert.strictEqual(result.hello, 'hi');
 		});
 	});
+	describe('getDataToSave', () => {
+		it('should return selected options in object format', async () => {
+			const mockReq = {
+				body: {
+					[FIELDNAME]: 'blue'
+				}
+			};
+			const options = [
+				{
+					text: 'Blue',
+					value: 'blue'
+				},
+				{
+					text: 'Red',
+					value: 'red'
+				}
+			];
+			const expectedAnswer = {
+				answers: {
+					[FIELDNAME]: 'blue'
+				}
+			};
+
+			const question = getTestQuestion({ options });
+			const result = await question.getDataToSave(mockReq, {});
+			assert.deepStrictEqual(result, expectedAnswer);
+		});
+		it('if req.body field name is undefined then pass through with an empty answer', async () => {
+			const mockReq = {
+				body: {
+					[FIELDNAME]: undefined
+				}
+			};
+			const options = [
+				{
+					text: 'Blue',
+					value: 'blue'
+				},
+				{
+					text: 'Red',
+					value: 'red'
+				}
+			];
+			const expectedAnswer = {
+				answers: {
+					[FIELDNAME]: ''
+				}
+			};
+
+			const question = getTestQuestion({ options });
+			const result = await question.getDataToSave(mockReq, {});
+			assert.deepStrictEqual(result, expectedAnswer);
+		});
+		it('if submitted options contains invalid answers then throw error', async () => {
+			const mockReq = {
+				body: {
+					[FIELDNAME]: ['blue', 'green']
+				}
+			};
+			const options = [
+				{
+					text: 'Blue',
+					value: 'blue'
+				},
+				{
+					text: 'Red',
+					value: 'red'
+				}
+			];
+
+			const question = getTestQuestion({ options });
+			assert.rejects(
+				async () => question.getDataToSave(mockReq, {}),
+				(thrown) => {
+					assert.strictEqual(
+						thrown.message,
+						`User submitted option(s) did not correlate with valid answers to ${FIELDNAME} question`
+					);
+					return true;
+				}
+			);
+		});
+	});
 });

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

@@ -1,5 +1,4 @@
-import { DocType } from '@pins/common/src/document-types';
-import { QuestionParameters } from '#question-types';
+import type { QuestionParameters } from '#question-types';
 
 type QuestionTypes =
 	| 'boolean'
@@ -19,7 +18,7 @@ type QuestionTypes =
 	| 'text-entry-redact'
 	| 'unit-option';
 
-type CommonQuestionProps = QuestionParameters & {
+type CommonQuestionProps = Omit<QuestionParameters, 'viewFolder'> & {
 	type: QuestionTypes;
 };
 
@@ -117,11 +116,6 @@ type MultiFieldInputQuestionProps = CommonQuestionProps & {
 	formatType?: 'contactDetails' | 'standard';
 };
 
-type MultiFileUploadQuestionProps = CommonQuestionProps & {
-	type: 'multi-file-upload';
-	documentType: DocType;
-};
-
 type NumberEntryQuestionProps = CommonQuestionProps & {
 	type: 'number';
 	suffix?: string;

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

@@ -1,7 +1,7 @@
-import { RouteParams } from '#src/journey/journey-types.d.ts';
-import ManageListQuestion from '#src/components/manage-list/question.js';
-import BaseValidator from '../validator/base-validator.js';
-import { JourneyResponse } from '../journey/journey-response.js';
+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;

package/src/questions/question.js

@@ -210,7 +210,7 @@ export class Question {
 	 * @param {Journey} journey - the journey we are in
 	 * @param {Record<string, unknown>} [customViewData] additional data to send to view
 	 * @param {unknown} [payload]
-	 * @param {import('./question-types.d.ts').PrepQuestionForRenderingOptions} [options] - required to support manage list question
+	 * @param {import('#question-types').PrepQuestionForRenderingOptions} [options] - required to support manage list question
 	 * @returns {QuestionViewModel}
 	 */
 	prepQuestionForRendering(section, journey, customViewData, payload, options) {
@@ -278,7 +278,7 @@ export class Question {
 	 * Get the answers object from the journey response, which may be nested in an array for manage list questions
 	 *
 	 * @param {JourneyResponse} response
-	 * @param {import('./question-types.d.ts').PrepQuestionForRenderingOptions} [options]
+	 * @param {import('#question-types').PrepQuestionForRenderingOptions} [options]
 	 * @returns {Record<string, any>}
 	 */
 	answerObjectFromJourneyResponse(response, { params, manageListQuestion } = {}) {

package/src/validator/conditional-required-validator.js

@@ -1,6 +1,7 @@
 import { body } from 'express-validator';
 
 import BaseValidator from './base-validator.js';
+import { toArray } from '#src/lib/utils.js';
 
 /**
  * @typedef {import('../questions/question.js')} Question
@@ -52,7 +53,7 @@ export default class ConditionalRequiredValidator extends BaseValidator {
 
 	isValueIncluded(questionObj, value) {
 		return body(questionObj.fieldName).custom((existingValues) => {
-			existingValues = Array.isArray(existingValues) ? existingValues : [existingValues];
+			existingValues = toArray(existingValues);
 			return existingValues.includes(value);
 		});
 	}

package/src/validator/unit-option-entry-validator.js

@@ -1,6 +1,7 @@
 import { body } from 'express-validator';
 
 import BaseValidator from './base-validator.js';
+import { toArray } from '#src/lib/utils.js';
 
 /**
  * @typedef {import('../questions/question.js')} Question
@@ -81,7 +82,7 @@ export default class UnitOptionEntryValidator extends BaseValidator {
 
 	isValueIncluded(questionObj, value) {
 		return body(questionObj.fieldName).custom((existingValues) => {
-			existingValues = Array.isArray(existingValues) ? existingValues : [existingValues];
+			existingValues = toArray(existingValues);
 			return existingValues.includes(value);
 		});
 	}

package/src/validator/valid-option-validator.js

@@ -1,6 +1,7 @@
 import { body } from 'express-validator';
 
 import BaseValidator from './base-validator.js';
+import { toArray } from '#src/lib/utils.js';
 
 /**
  * @typedef {import('../questions/options-question.js')} OptionsQuestion
@@ -33,7 +34,7 @@ export default class ValidOptionValidator extends BaseValidator {
 		return body(questionObj.fieldName)
 			.custom((value) => {
 				if (!value) return true;
-				value = Array.isArray(value) ? value : [value];
+				value = toArray(value);
 				return value.every((element) => questionObj.options.map((option) => option.value).includes(element));
 			})
 			.withMessage(this.errorMessage);

package/tsconfig.json

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

package/types/src/components/date-time/question.d.ts

@@ -2,11 +2,11 @@ export default class DateTimeQuestion extends Question {
     static AM: string;
     static PM: string;
     /**
-     * @param {import('@planning-inspectorate/dynamic-forms/src/questions/question-types.js').QuestionParameters} params
+     * @param {import('#question-types').QuestionParameters} params
      * @param {string} [params.dateFormat]
      * @param {string} [params.timeFormat]
      */
-    constructor({ dateFormat, timeFormat, ...params }: any);
+    constructor({ dateFormat, timeFormat, ...params }: import("#question-types").QuestionParameters);
     dateFormat: any;
     timeFormat: any;
     /**

package/types/src/components/date-time/question.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/date-time/question.js"],"names":[],"mappings":"AAMA;IACC,kBAAiB;IACjB,kBAAiB;IAEjB;;;;OAIG;IACH,wDAOC;IAFA,gBAA4B;IAC5B,gBAA4B;IAG7B;;;;;OAKG,CACH,yCAHW,eAAe,GACb,OAAO,CAAE,MAAM,CAAC,CAqB5B;IAED;;MAqCC;;CAoCD;yBA5HwB,6BAA6B"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/date-time/question.js"],"names":[],"mappings":"AAMA;IACC,kBAAiB;IACjB,kBAAiB;IAEjB;;;;OAIG;IACH,mDAJW,OAAO,iBAAiB,EAAE,kBAAkB,EAWtD;IAFA,gBAA4B;IAC5B,gBAA4B;IAG7B;;;;;OAKG,CACH,yCAHW,eAAe,GACb,OAAO,CAAE,MAAM,CAAC,CAqB5B;IAED;;MAqCC;;CAoCD;yBA5HwB,6BAA6B"}

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

@@ -16,7 +16,7 @@ export default class RadioQuestion extends OptionsQuestion {
      * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
      * @param {boolean} [params.editable]
      * @param {Object<string, any>} [params.viewData]
-     * @param {import('../../questions/question-types.js').ActionLink} [params.actionLink]
+     * @param {import('#question-types').ActionLink} [params.actionLink]
      */
     constructor({ title, question, fieldName, viewFolder, url, hint, pageTitle, description, label, html, legend, options, validators, actionLink, editable, viewData }: {
         title: string;
@@ -36,7 +36,7 @@ export default class RadioQuestion extends OptionsQuestion {
         viewData?: {
             [x: string]: any;
         } | undefined;
-        actionLink?: import("../../questions/question-types.js").ActionLink | undefined;
+        actionLink?: import("#question-types").ActionLink | undefined;
     });
     label: string | undefined;
     legend: string | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/radio/question.js"],"names":[],"mappings":"AAEA;IACC;;;;;;;;;;;;;;;;;;OAkBG;IACH,qKAjBG;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;QACH,UAAU;QAClD,QAAQ;QACI,QAAQ;;;QAC2B,UAAU;KAAC,EAuCrF;IAFA,0BAAkB;IAClB,2BAAoB;IAWrB;;;;;;OAMG;IACH,wDAJW,OAAO,UADP,MAAM,GAGJ,KAAK,CAAE,MAAM,CAAC,CAgB1B;CACD;4BA3F2B,qCAAqC"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/radio/question.js"],"names":[],"mappings":"AAEA;IACC;;;;;;;;;;;;;;;;;;OAkBG;IACH,qKAjBG;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;QACH,UAAU;QAClD,QAAQ;QACI,QAAQ;;;QACS,UAAU;KAAC,EAuCnE;IAFA,0BAAkB;IAClB,2BAAoB;IAWrB;;;;;;OAMG;IACH,wDAJW,OAAO,UADP,MAAM,GAGJ,KAAK,CAAE,MAAM,CAAC,CAgB1B;CACD;4BA3F2B,qCAAqC"}

package/types/src/components/unit-option-entry/question.d.ts

@@ -34,14 +34,14 @@ export default class UnitOptionEntryQuestion extends Question {
      * @param {import('#journey').Journey} journey - the journey we are in
      * @param {Record<string, unknown>} [customViewData] additional data to send to view
      * @param {Record<string, unknown>} [payload]
-     * @param {import('#src/questions/question-types.d.ts').PrepQuestionForRenderingOptions} options
+     * @param {import('#question-types').PrepQuestionForRenderingOptions} options
      * @returns {import('#question').QuestionViewModel & {
      *   question: import('#question').QuestionViewModel['question'] & {
      *     options:UnitOption[]
      *   }
      * }}
      */
-    prepQuestionForRendering(section: any, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#src/questions/question-types.d.ts").PrepQuestionForRenderingOptions): import("#question").QuestionViewModel & {
+    prepQuestionForRendering(section: any, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#question-types").PrepQuestionForRenderingOptions): import("#question").QuestionViewModel & {
         question: import("#question").QuestionViewModel["question"] & {
             options: UnitOption[];
         };

package/types/src/components/unit-option-entry/question.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/unit-option-entry/question.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;IACC,gCAAgC;IAChC,SADW,KAAK,CAAC,UAAU,CAAC,CACpB;IAqBP,0BAAgD;IAEhD,WAAkB;IAClB,yBAA+C;IAGhD;;;;;;;;;;;;OAYG;IACH,gDAVW,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,oCAAoC,EAAE,+BAA+B,GAC1E,OAAO,WAAW,EAAE,iBAAiB,GAAG;QAChD,QAAQ,EAAE,OAAO,WAAW,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG;YAC5D,OAAO,EAAC,UAAU,EAAE,CAAA;SACrB,CAAA;KACF,CAmDH;IAED;;;;;OAKG,CACH,yCAHW,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAgCzD;CAoBD;;;;;;;;;yBAvKY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,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;QACX,SAAS,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAA;CACH;yBA3BsB,6BAA6B"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/unit-option-entry/question.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;IACC,gCAAgC;IAChC,SADW,KAAK,CAAC,UAAU,CAAC,CACpB;IAqBP,0BAAgD;IAEhD,WAAkB;IAClB,yBAA+C;IAGhD;;;;;;;;;;;;OAYG;IACH,gDAVW,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,iBAAiB,EAAE,+BAA+B,GACvD,OAAO,WAAW,EAAE,iBAAiB,GAAG;QAChD,QAAQ,EAAE,OAAO,WAAW,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG;YAC5D,OAAO,EAAC,UAAU,EAAE,CAAA;SACrB,CAAA;KACF,CAmDH;IAED;;;;;OAKG,CACH,yCAHW,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAgCzD;CAoBD;;;;;;;;;yBAvKY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,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;QACX,SAAS,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAA;CACH;yBA5BsB,6BAA6B"}

package/types/src/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/controller.js"],"names":[],"mappings":"AAuEA;;;GAGG;AACH,qCAHW,MAAM,OAKhB;AAED;;;;;GAKG;AACH,sDAHW,MAAM,YACN,MAAM,gBA8DhB;AAED;;;;GAIG;AACH,2DA0CC;AAED;;;;;;;;;;GAUG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,OAuFjB;sBAtSY,OAAO,sBAAsB,EAAE,OAAO;uBACtC,OAAO,yBAAyB,EAAE,QAAQ;;;aAMzC,MAAM;YACN,MAAM;UAEjB;QAAiC,IAAI,EAA1B,KAAK,CAAE,OAAO,CAAC;KAC5B;;;SAIa;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;WAChB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;eAC1B,UAAU,EAAE;;;;UAKrB,MAAM;UACN,MAAM;;;;;;eA0KN,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/controller.js"],"names":[],"mappings":"AAwEA;;;GAGG;AACH,qCAHW,MAAM,OAKhB;AAED;;;;;GAKG;AACH,sDAHW,MAAM,YACN,MAAM,gBA8DhB;AAED;;;;GAIG;AACH,2DA0CC;AAED;;;;;;;;;;GAUG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,OAuFjB;sBAtSY,OAAO,sBAAsB,EAAE,OAAO;uBACtC,OAAO,yBAAyB,EAAE,QAAQ;;;aAMzC,MAAM;YACN,MAAM;UAEjB;QAAiC,IAAI,EAA1B,KAAK,CAAE,OAAO,CAAC;KAC5B;;;SAIa;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;WAChB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;eAC1B,UAAU,EAAE;;;;UAKrB,MAAM;UACN,MAAM;;;;;;eA0KN,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}

package/types/src/index.d.ts

@@ -23,6 +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 "./validator/address-validator.js";
 export * from "./validator/base-validator.js";
 export * from "./validator/conditional-required-validator.js";

package/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAC4B,kCAAkC;0BACpC,+BAA+B;2BAC9B,gCAAgC;4BAC/B,iCAAiC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAC4B,kCAAkC;0BACpC,+BAA+B;2BAC9B,gCAAgC;4BAC/B,iCAAiC"}

package/types/src/lib/utils.d.ts

@@ -16,4 +16,11 @@ export function capitalize(str: string | any): string;
  * @returns {string}
  */
 export function trimTrailingSlash(str?: string): string;
+/**
+ * Convert a value to an array, unless it is already
+ *
+ * @param {T|T[]} value
+ * @template T
+ */
+export function toArray<T>(value: T | T[]): T[];
 //# sourceMappingURL=utils.d.ts.map

package/types/src/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,8BAHW,MAAM,GACJ,MAAM,CAMlB;AAED;;;GAGG;AACH,gCAHW,MAAM,GAAC,GAAG,GACR,MAAM,CAKlB;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,MAAM,CAKlB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,8BAHW,MAAM,GACJ,MAAM,CAMlB;AAED;;;GAGG;AACH,gCAHW,MAAM,GAAC,GAAG,GACR,MAAM,CAKlB;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;GAKG;AACH,wBAFa,CAAC,SADH,CAAC,GAAC,CAAC,EAAE,OAKf"}

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

@@ -39,10 +39,10 @@ export default class OptionsQuestion extends Question {
      * @param {import('#journey').Journey} journey - the journey we are in
      * @param {Record<string, unknown>} [customViewData] additional data to send to view
      * @param {Record<string, unknown>} [payload]
-     * @param {import('#src/questions/question-types.d.ts').PrepQuestionForRenderingOptions} options
+     * @param {import('#question-types').PrepQuestionForRenderingOptions} options
      * @returns {import('./question').QuestionViewModel} QuestionViewModel
      */
-    prepQuestionForRendering(section: import("#section").Section, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#src/questions/question-types.d.ts").PrepQuestionForRenderingOptions): any;
+    prepQuestionForRendering(section: import("#section").Section, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#question-types").PrepQuestionForRenderingOptions): any;
 }
 export type Option = {
     text: string;

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

@@ -1 +1 @@
-{"version":3,"file":"options-question.d.ts","sourceRoot":"","sources":["../../../src/questions/options-question.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;GAEG;AAEH;IAIC;;;OAGG;IACH,oBAHW,OAAO,iBAAiB,EAAE,kBAAkB,EAgBtD;IApBD,4BAA4B;IAC5B,SADW,KAAK,CAAC,MAAM,CAAC,CAChB;IAkBP,yBAA+C;IAGhD;;;;;;;;OAQG;IACH,kCAPW,OAAO,UAAU,EAAE,OAAO,WAC1B,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,oCAAoC,EAAE,+BAA+B,OAmDtF;CAmCD;qBA9IY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,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;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;KAClB,CAAC;IACA,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAA;CACH;+BAIU,GAAsC,GAAG;IAAE,QAAQ,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAAE;yBA/BhE,eAAe"}
+{"version":3,"file":"options-question.d.ts","sourceRoot":"","sources":["../../../src/questions/options-question.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;GAEG;AAEH;IAIC;;;OAGG;IACH,oBAHW,OAAO,iBAAiB,EAAE,kBAAkB,EAgBtD;IApBD,4BAA4B;IAC5B,SADW,KAAK,CAAC,MAAM,CAAC,CAChB;IAkBP,yBAA+C;IAGhD;;;;;;;;OAQG;IACH,kCAPW,OAAO,UAAU,EAAE,OAAO,WAC1B,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,iBAAiB,EAAE,+BAA+B,OAmDnE;CAmCD;qBA9IY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,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;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;KAClB,CAAC;IACA,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAA;CACH;+BAIU,GAAsC,GAAG;IAAE,QAAQ,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAAE;yBAhChE,eAAe"}

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

@@ -0,0 +1,113 @@
+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';
+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;
+};
+interface InputField {
+    fieldName: string;
+    label: string;
+    formatJoinString?: string;
+    hint?: string;
+}
+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;
+    };
+}
+type BooleanQuestionProps = CommonQuestionProps & {
+    type: 'boolean';
+    options?: Option[];
+    interfaceType?: 'checkbox' | 'radio';
+};
+type CheckboxQuestionProps = CommonQuestionProps & {
+    type: 'checkbox';
+    options: Option[];
+};
+type DateQuestionProps = CommonQuestionProps & {
+    type: 'date';
+};
+type DatePeriodQuestionProps = CommonQuestionProps & {
+    type: 'date-period';
+};
+type DateTimeQuestionProps = CommonQuestionProps & {
+    type: 'date-time';
+};
+type ManageListQuestionProps = CommonQuestionProps & {
+    type: 'manage-list';
+};
+type EmailQuestionProps = CommonQuestionProps & {
+    type: 'email';
+};
+type MultiFieldInputQuestionProps = CommonQuestionProps & {
+    type: 'multi-field-input';
+    inputAttributes?: Record<string, string>;
+    inputFields: InputField[];
+    formatType?: 'contactDetails' | 'standard';
+};
+type NumberEntryQuestionProps = CommonQuestionProps & {
+    type: 'number';
+    suffix?: string;
+};
+type RadioQuestionProps = CommonQuestionProps & {
+    type: 'radio';
+    options: Option[];
+};
+type SelectQuestionProps = CommonQuestionProps & {
+    type: 'select';
+    options: Option[];
+};
+type SingleLineInputQuestionProps = CommonQuestionProps & {
+    type: 'single-line-input';
+    inputAttributes?: Record<string, string>;
+};
+type SiteAddressQuestionProps = CommonQuestionProps & {
+    type: 'site-address';
+};
+type TextEntryQuestionProps = CommonQuestionProps & {
+    type: 'text-entry';
+};
+type TextEntryRedactQuestionProps = CommonQuestionProps & {
+    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

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

@@ -0,0 +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"}

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

@@ -0,0 +1,49 @@
+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>;
+}
+export interface ActionLink {
+    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;
+}
+export interface PrepQuestionForRenderingOptions {
+    params: RouteParams;
+    manageListQuestion?: ManageListQuestion;
+}
+//# sourceMappingURL=question-types.d.ts.map

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

@@ -0,0 +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"}

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

@@ -132,10 +132,10 @@ export class Question {
      * @param {Journey} journey - the journey we are in
      * @param {Record<string, unknown>} [customViewData] additional data to send to view
      * @param {unknown} [payload]
-     * @param {import('./question-types.d.ts').PrepQuestionForRenderingOptions} [options] - required to support manage list question
+     * @param {import('#question-types').PrepQuestionForRenderingOptions} [options] - required to support manage list question
      * @returns {QuestionViewModel}
      */
-    prepQuestionForRendering(section: Section, journey: Journey, customViewData?: Record<string, unknown>, payload?: unknown, options?: import("./question-types.d.ts").PrepQuestionForRenderingOptions): QuestionViewModel;
+    prepQuestionForRendering(section: Section, journey: Journey, customViewData?: Record<string, unknown>, payload?: unknown, options?: import("#question-types").PrepQuestionForRenderingOptions): QuestionViewModel;
     /**
      * The answer to this question for use in the viewModel
      *
@@ -156,10 +156,10 @@ export class Question {
      * Get the answers object from the journey response, which may be nested in an array for manage list questions
      *
      * @param {JourneyResponse} response
-     * @param {import('./question-types.d.ts').PrepQuestionForRenderingOptions} [options]
+     * @param {import('#question-types').PrepQuestionForRenderingOptions} [options]
      * @returns {Record<string, any>}
      */
-    answerObjectFromJourneyResponse(response: JourneyResponse, { params, manageListQuestion }?: import("./question-types.d.ts").PrepQuestionForRenderingOptions): Record<string, any>;
+    answerObjectFromJourneyResponse(response: JourneyResponse, { params, manageListQuestion }?: import("#question-types").PrepQuestionForRenderingOptions): Record<string, any>;
     /**
      * renders the question
      * @param {import('express').Response} res - the express response

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

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../src/questions/question.js"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IAqDC;;;OAGG;IACH,yLAHW,OAAO,iBAAiB,EAAE,kBAAkB,oBAC5C,MAAM,CAAC,MAAM,WAAW,EAsDlC;IA5GD,6EAA6E;IAC7E,WADW,MAAM,CACP;IACV,sDAAsD;IACtD,OADW,MAAM,CACX;IACN,+DAA+D;IAC/D,UADW,MAAM,CACR;IACT,mFAAmF;IACnF,aADW,MAAM,GAAC,SAAS,CACf;IACZ,iDAAiD;IACjD,YADW,MAAM,CACN;IACX,qHAAqH;IACrH,WADW,MAAM,CACP;IACV,6FAA6F;IAC7F,UADW,OAAO,CACF;IAChB,iGAAiG;IACjG,YADW,KAAK,CAAE,MAAa,CAAC,CAChB;IAChB,2DAA2D;IAC3D,MADW,MAAM,GAAC,SAAS,CACtB;IACL,sEAAsE;IACtE,oBADW,OAAO,CACQ;IAC1B,oDAAoD;IACpD,KADW,MAAM,GAAC,SAAS,CACvB;IACJ,qDAAqD;IACrD,MADW,MAAM,GAAC,SAAS,CACtB;IACL,sDAAsD;IACtD,eADW,MAAM,GAAC,SAAS,CACb;IACd,wDAAwD;IACxD,YADW,UAAU,GAAC,SAAS,CACpB;IAEX,iFAAiF;IACjF,gBADW,MAAM,CACc;IAC/B,4CAA4C;IAC5C,oBADW,MAAM,CACe;IAChC,uDAAuD;IACvD,kBADW,MAAM,CACW;IAC5B,uDAAuD;IACvD,kBADW,MAAM,CACW;IAC5B,oDAAoD;IACpD,eADW,MAAM,CACK;IAEtB;;;OAGG;IACH,qBAFa,OAAO,CAEO;IAE3B;;;MAGE;IA0CD,iCAAgC;IAChC,kBAAwB;IAExB,8BAAwB;IAgBzB;;;;;;OAMG;IACH,4BAFa,OAAO,CAInB;IAWD,iCANa,OAAO,EAWnB;IAdD;;;;OAIG;IACH,6BAFa,OAAO,CAInB;IASD;;;;;;;;;;;;;;OAcG;IACH,uFARG;QAAuE,MAAM,EAArE,OAAO,iCAAiC,EAAE,WAAW;QACO,kBAAkB;QAC7D,OAAO,EAAxB,OAAO;QACU,OAAO,EAAxB,OAAO;QAC2B,cAAc;QAC9B,OAAO,GAAzB,OAAO;KACf,GAAU,iBAAiB,CAS7B;IAED;;;;;;;;;OASG;IACH,kCAPW,OAAO,WACP,OAAO,mBACP,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,OAAO,YACP,OAAO,uBAAuB,EAAE,+BAA+B,GAC7D,iBAAiB,CAuC7B;IAED;;;;;;;;OAQG,CACH,4BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,uBAEjB,GAAC,GAAC,MAAM,CAIpB;IAED;;;;;;OAMG,CACH,oCAFW,iBAAiB,QAEU;IAEtC;;;;;;OAMG;IACH,0CAJW,eAAe,mCACf,OAAO,uBAAuB,EAAE,+BAA+B,GAC7D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAc/B;IAED;;;;;OAKG;IACH,kCAHW,iBAAiB,GACf,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,4CAJW,OAAO,WADP,OAAO,kFAGL,iBAAiB,GAAC,SAAS,CAmBvC;IAED;;;;;;OAMG,CACH,yCAHW,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAczD;IAED;;;;;;OAMG,CACH,2CAHW,OAAO,WADP,OAAO,GAEL,iBAAiB,GAAG,SAAS,CAIzC;IAED;;;;;;;;;OASG;IACH,sCANW,OAAO,kBACP,MAAM,mBACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;;;;;;;;;OAcG;IACH,wDAZW,OAAO,UACP,MAAM,uBACJ,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,kBAAkB,EAAE,MAAM,CAAC;SAC5B,CAAC;KACH,CAAC,CAaJ;IAED;;;;;;OAMG;IACH,2CAJW,OAAO,UADP,MAAM,GAGJ,UAAU,GAAC,UAAU,EAAE,GAAC,SAAS,CAqB7C;IAED;;;OAGG;IACH,eAHW,OAAO,GACL,OAAO,CAInB;IAED;;OAEG;IACH,cAFa,OAAO,CASnB;IACD;;;OAGG;IACH,4BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,4BAJW,eAAe,cACf,MAAM,GACJ,OAAO,CAInB;;CACD;;WA/ca,MAAM;cACN,MAAM;eACN,MAAM;eACN,MAAM;;;;gCAMP,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;gCAdH,qBAAqB;6BAFxB,UAAU;6BAFV,UAAU;qCACF,mBAAmB;gCAExB,kBAAkB"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../src/questions/question.js"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IAqDC;;;OAGG;IACH,yLAHW,OAAO,iBAAiB,EAAE,kBAAkB,oBAC5C,MAAM,CAAC,MAAM,WAAW,EAsDlC;IA5GD,6EAA6E;IAC7E,WADW,MAAM,CACP;IACV,sDAAsD;IACtD,OADW,MAAM,CACX;IACN,+DAA+D;IAC/D,UADW,MAAM,CACR;IACT,mFAAmF;IACnF,aADW,MAAM,GAAC,SAAS,CACf;IACZ,iDAAiD;IACjD,YADW,MAAM,CACN;IACX,qHAAqH;IACrH,WADW,MAAM,CACP;IACV,6FAA6F;IAC7F,UADW,OAAO,CACF;IAChB,iGAAiG;IACjG,YADW,KAAK,CAAE,MAAa,CAAC,CAChB;IAChB,2DAA2D;IAC3D,MADW,MAAM,GAAC,SAAS,CACtB;IACL,sEAAsE;IACtE,oBADW,OAAO,CACQ;IAC1B,oDAAoD;IACpD,KADW,MAAM,GAAC,SAAS,CACvB;IACJ,qDAAqD;IACrD,MADW,MAAM,GAAC,SAAS,CACtB;IACL,sDAAsD;IACtD,eADW,MAAM,GAAC,SAAS,CACb;IACd,wDAAwD;IACxD,YADW,UAAU,GAAC,SAAS,CACpB;IAEX,iFAAiF;IACjF,gBADW,MAAM,CACc;IAC/B,4CAA4C;IAC5C,oBADW,MAAM,CACe;IAChC,uDAAuD;IACvD,kBADW,MAAM,CACW;IAC5B,uDAAuD;IACvD,kBADW,MAAM,CACW;IAC5B,oDAAoD;IACpD,eADW,MAAM,CACK;IAEtB;;;OAGG;IACH,qBAFa,OAAO,CAEO;IAE3B;;;MAGE;IA0CD,iCAAgC;IAChC,kBAAwB;IAExB,8BAAwB;IAgBzB;;;;;;OAMG;IACH,4BAFa,OAAO,CAInB;IAWD,iCANa,OAAO,EAWnB;IAdD;;;;OAIG;IACH,6BAFa,OAAO,CAInB;IASD;;;;;;;;;;;;;;OAcG;IACH,uFARG;QAAuE,MAAM,EAArE,OAAO,iCAAiC,EAAE,WAAW;QACO,kBAAkB;QAC7D,OAAO,EAAxB,OAAO;QACU,OAAO,EAAxB,OAAO;QAC2B,cAAc;QAC9B,OAAO,GAAzB,OAAO;KACf,GAAU,iBAAiB,CAS7B;IAED;;;;;;;;;OASG;IACH,kCAPW,OAAO,WACP,OAAO,mBACP,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,OAAO,YACP,OAAO,iBAAiB,EAAE,+BAA+B,GACvD,iBAAiB,CAuC7B;IAED;;;;;;;;OAQG,CACH,4BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,uBAEjB,GAAC,GAAC,MAAM,CAIpB;IAED;;;;;;OAMG,CACH,oCAFW,iBAAiB,QAEU;IAEtC;;;;;;OAMG;IACH,0CAJW,eAAe,mCACf,OAAO,iBAAiB,EAAE,+BAA+B,GACvD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAc/B;IAED;;;;;OAKG;IACH,kCAHW,iBAAiB,GACf,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,4CAJW,OAAO,WADP,OAAO,kFAGL,iBAAiB,GAAC,SAAS,CAmBvC;IAED;;;;;;OAMG,CACH,yCAHW,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAczD;IAED;;;;;;OAMG,CACH,2CAHW,OAAO,WADP,OAAO,GAEL,iBAAiB,GAAG,SAAS,CAIzC;IAED;;;;;;;;;OASG;IACH,sCANW,OAAO,kBACP,MAAM,mBACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;;;;;;;;;OAcG;IACH,wDAZW,OAAO,UACP,MAAM,uBACJ,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,kBAAkB,EAAE,MAAM,CAAC;SAC5B,CAAC;KACH,CAAC,CAaJ;IAED;;;;;;OAMG;IACH,2CAJW,OAAO,UADP,MAAM,GAGJ,UAAU,GAAC,UAAU,EAAE,GAAC,SAAS,CAqB7C;IAED;;;OAGG;IACH,eAHW,OAAO,GACL,OAAO,CAInB;IAED;;OAEG;IACH,cAFa,OAAO,CASnB;IACD;;;OAGG;IACH,4BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,4BAJW,eAAe,cACf,MAAM,GACJ,OAAO,CAInB;;CACD;;WA/ca,MAAM;cACN,MAAM;eACN,MAAM;eACN,MAAM;;;;gCAMP,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;gCAdH,qBAAqB;6BAFxB,UAAU;6BAFV,UAAU;qCACF,mBAAmB;gCAExB,kBAAkB"}

package/types/src/validator/conditional-required-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"conditional-required-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/conditional-required-validator.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH;IAMC;;;OAGG;IACH,2BAFW,MAAM,EAQhB;IAED;;;OAGG;IACH,sBAFW,QAAQ,OAclB;IAED,+DAEC;IAED,2FAKC;CACD;;0BAxDyB,qBAAqB"}
+{"version":3,"file":"conditional-required-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/conditional-required-validator.js"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;GAGG;AACH;IAMC;;;OAGG;IACH,2BAFW,MAAM,EAQhB;IAED;;;OAGG;IACH,sBAFW,QAAQ,OAclB;IAED,+DAEC;IAED,2FAKC;CACD;;0BAzDyB,qBAAqB"}

package/types/src/validator/unit-option-entry-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unit-option-entry-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/unit-option-entry-validator.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH;IACC;;;;;;;;OAQG;IAEH,oEARG;QAAwB,YAAY;QACZ,IAAI;QACJ,GAAG;QACH,GAAG;QACJ,KAAK;QACJ,YAAY;KAAC,EAWvC;IALA,aAA2B;IAC3B,wBAAc;IACd,wBAAc;IACd,WAAkB;IAClB,qBAA0D;IAG3D;;;OAGG;IACH,sBAFW,QAAQ,OA4ClB;IAED,2FAKC;CACD;;0BArFyB,qBAAqB"}
+{"version":3,"file":"unit-option-entry-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/unit-option-entry-validator.js"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;GAGG;AACH;IACC;;;;;;;;OAQG;IAEH,oEARG;QAAwB,YAAY;QACZ,IAAI;QACJ,GAAG;QACH,GAAG;QACJ,KAAK;QACJ,YAAY;KAAC,EAWvC;IALA,aAA2B;IAC3B,wBAAc;IACd,wBAAc;IACd,WAAkB;IAClB,qBAA0D;IAG3D;;;OAGG;IACH,sBAFW,QAAQ,OA4ClB;IAED,2FAKC;CACD;;0BAtFyB,qBAAqB"}

package/types/src/validator/valid-option-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"valid-option-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/valid-option-validator.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH;IACC;;;OAGG;IACH,2BAFW,MAAM,EAUhB;IAED;;;OAGG;IACH,sBAFW,eAAe,+CAUzB;CACD;;0BAtCyB,qBAAqB"}
+{"version":3,"file":"valid-option-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/valid-option-validator.js"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;GAGG;AACH;IACC;;;OAGG;IACH,2BAFW,MAAM,EAUhB;IAED;;;OAGG;IACH,sBAFW,eAAe,+CAUzB;CACD;;0BAvCyB,qBAAqB"}