@planning-inspectorate/dynamic-forms 3.8.1 → 3.8.3

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.1",
+  "version": "3.8.3",
   "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/controller.js

@@ -53,7 +53,7 @@ function buildSectionViewModel(name, status = '') {
  * build a view model for a row in the journey overview
  * @param {string} key
  * @param {string} value
- * @param {ActionView|ActionView[]} action
+ * @param {ActionView|ActionView[]} [action]
  * @returns {RowView} a representation of a row
  */
 function buildSectionRowViewModel(key, value, action) {
@@ -64,9 +64,7 @@ function buildSectionRowViewModel(key, value, action) {
 		value: {
 			html: value
 		},
-		actions: {
-			items: toArray(action)
-		}
+		actions: action ? { items: toArray(action) } : undefined
 	};
 }
 

package/src/controller.test.js

@@ -299,6 +299,56 @@ describe('dynamic-form/controller', () => {
 			assert.strictEqual(args[0], mockJourney.sections[0].segment);
 			assert.strictEqual(args[2], expectedAnswer.value);
 		});
+		it('should format an undefined action as undefined', async () => {
+			const mockFn = res.render.mock;
+			mockFn.resetCalls();
+			mockJourney.sections[0].questions[0].formatAnswerForSummary.mock.mockImplementation(() => [
+				{
+					key: 'Title 1a',
+					value: mockAnswer,
+					action: undefined
+				}
+			]);
+			res.locals.journeyResponse.referenceId = mockRef;
+			const appeal = { a: 1, caseReference: 2 };
+
+			const pageCaption = `Appeal ${appeal.caseReference}`;
+			await list(req, res, pageCaption, { appeal });
+
+			const renderCall = mockFn.calls[0].arguments[1];
+			const firstRowActions = renderCall.summaryListData.sections[0].list.rows[0].actions;
+			assert.strictEqual(firstRowActions, undefined);
+		});
+
+		it('should format a single action object as an array in the actions property', async () => {
+			const mockFn = res.render.mock;
+			mockFn.resetCalls();
+			mockJourney.sections[0].questions[0].formatAnswerForSummary.mock.mockImplementation(() => [
+				{
+					key: 'Title 1a',
+					value: mockAnswer,
+					action: {
+						href: '/manage-appeals/questionnaire/123456/segment-1/title-1a',
+						text: 'Answer',
+						visuallyHiddenText: 'Answer'
+					}
+				}
+			]);
+			res.locals.journeyResponse.referenceId = mockRef;
+
+			await list(req, res);
+
+			const renderCall = mockFn.calls[0].arguments[1];
+			const rowActions = renderCall.summaryListData.sections[0].list.rows[0].actions;
+			assert.ok(rowActions);
+			assert.ok(Array.isArray(rowActions.items));
+			assert.strictEqual(rowActions.items.length, 1);
+			assert.deepStrictEqual(rowActions.items[0], {
+				href: '/manage-appeals/questionnaire/123456/segment-1/title-1a',
+				text: 'Answer',
+				visuallyHiddenText: 'Answer'
+			});
+		});
 	});
 
 	describe('question', () => {

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'

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/src/validator/address-validator.js

@@ -31,9 +31,8 @@ export const postcodeMinLength = 5;
 export default class AddressValidator extends BaseValidator {
 	/**
 	 * creates an instance of an AddressValidator
-	 * @param {Object} opts
-	 * @param {boolean} [opts.required]
-	 * @param {{[key: string]: boolean}} [opts.requiredFields]
+	 * @param {Object} [opts]
+	 * @param {{addressLine1: boolean, addressLine2: boolean, townCity: boolean, county: boolean, postcode: boolean}} [opts.requiredFields]
 	 */
 	constructor(opts) {
 		super();

package/src/validator/string-validator.js

@@ -4,19 +4,19 @@ import BaseValidator from './base-validator.js';
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} minLengthMessage
+ * @property {String} [minLengthMessage]
  */
 
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} maxLengthMessage
+ * @property {String} [maxLengthMessage]
  */
 
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} regexMessage
+ * @property {String} [regexMessage]
  */
 
 export default class StringValidator extends BaseValidator {

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/address/question.d.ts

@@ -4,7 +4,11 @@ export default class AddressQuestion extends Question {
      */
     constructor(params: import("#question-types").QuestionParameters);
     requiredFields: {
-        [key: string]: boolean;
+        addressLine1: boolean;
+        addressLine2: boolean;
+        townCity: boolean;
+        county: boolean;
+        postcode: boolean;
     } | undefined;
     addressLabels: {
         addressLine1: string;

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

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/address/question.js"],"names":[],"mappings":"AAOA;IACC;;OAEG;IACH,oBAFW,OAAO,iBAAiB,EAAE,kBAAkB,EAqBtD;IAXE;;kBAA8C;IAIhD;;;;;;MAMC;IAGF;;;OAGG;IACH,4BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,GAAC,GAAC,MAAM,CAqBpB;IAqCD;;;OAGG;IACH;;eAUC;IAuBD,kEAMC;CACD;yBAxIwB,WAAW"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/address/question.js"],"names":[],"mappings":"AAOA;IACC;;OAEG;IACH,oBAFW,OAAO,iBAAiB,EAAE,kBAAkB,EAqBtD;IAXE;;;;;;kBAA8C;IAIhD;;;;;;MAMC;IAGF;;;OAGG;IACH,4BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,GAAC,GAAC,MAAM,CAqBpB;IAqCD;;;OAGG;IACH;;eAUC;IAuBD,kEAMC;CACD;yBAxIwB,WAAW"}

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/controller.js"],"names":[],"mappings":"AAsEA;;;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;sBApSY,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;;;;;;eAwKN,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}

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,173 @@
-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[];
 };
+
 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":""}

package/types/src/validator/address-validator.d.ts

@@ -16,18 +16,24 @@ export const postcodeMinLength: 5;
 export default class AddressValidator extends BaseValidator {
     /**
      * creates an instance of an AddressValidator
-     * @param {Object} opts
-     * @param {boolean} [opts.required]
-     * @param {{[key: string]: boolean}} [opts.requiredFields]
+     * @param {Object} [opts]
+     * @param {{addressLine1: boolean, addressLine2: boolean, townCity: boolean, county: boolean, postcode: boolean}} [opts.requiredFields]
      */
-    constructor(opts: {
-        required?: boolean | undefined;
+    constructor(opts?: {
         requiredFields?: {
-            [key: string]: boolean;
+            addressLine1: boolean;
+            addressLine2: boolean;
+            townCity: boolean;
+            county: boolean;
+            postcode: boolean;
         } | undefined;
     });
     requiredFields: {
-        [key: string]: boolean;
+        addressLine1: boolean;
+        addressLine2: boolean;
+        townCity: boolean;
+        county: boolean;
+        postcode: boolean;
     } | undefined;
     /**
      * validates response body using questionObj fieldname

package/types/src/validator/address-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"address-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/address-validator.js"],"names":[],"mappings":"AAIO,4EAQN;AAGD,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,gCAAiC,GAAG,CAAC;AACrC,gCAAiC,CAAC,CAAC;AACnC,8BAA+B,GAAG,CAAC;AACnC,8BAA+B,CAAC,CAAC;AACjC,gCAAiC,CAAC,CAAC;AACnC,gCAAiC,CAAC,CAAC;AAEnC;;;GAGG;AACH;IACC;;;;;OAKG;IACH,kBAHG;QAAuB,QAAQ;QACS,cAAc;;;KAAC,EAKzD;IADA;;kBAA0C;IAG3C;;;OAGG;IACH,sBAFW,QAAQ,iDAYlB;IA+FD,sBAKC;;CACD;0BA3JyB,qBAAqB"}
+{"version":3,"file":"address-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/address-validator.js"],"names":[],"mappings":"AAIO,4EAQN;AAGD,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,gCAAiC,GAAG,CAAC;AACrC,gCAAiC,CAAC,CAAC;AACnC,8BAA+B,GAAG,CAAC;AACnC,8BAA+B,CAAC,CAAC;AACjC,gCAAiC,CAAC,CAAC;AACnC,gCAAiC,CAAC,CAAC;AAEnC;;;GAGG;AACH;IACC;;;;OAIG;IACH,mBAFG;QAAqH,cAAc;0BAA5G,OAAO;0BAAgB,OAAO;sBAAY,OAAO;oBAAU,OAAO;sBAAY,OAAO;;KAAwB,EAKtI;IADA;sBAJyB,OAAO;sBAAgB,OAAO;kBAAY,OAAO;gBAAU,OAAO;kBAAY,OAAO;kBAIpE;IAG3C;;;OAGG;IACH,sBAFW,QAAQ,iDAYlB;IA+FD,sBAKC;;CACD;0BA1JyB,qBAAqB"}

package/types/src/validator/string-validator.d.ts

@@ -1,17 +1,17 @@
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} minLengthMessage
+ * @property {String} [minLengthMessage]
  */
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} maxLengthMessage
+ * @property {String} [maxLengthMessage]
  */
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} regexMessage
+ * @property {String} [regexMessage]
  */
 export default class StringValidator extends BaseValidator {
     /**
@@ -44,15 +44,15 @@ export default class StringValidator extends BaseValidator {
 }
 export type MinLength = {
     minLength: number;
-    minLengthMessage: string;
+    minLengthMessage?: string | undefined;
 };
 export type MaxLength = {
     maxLength: number;
-    maxLengthMessage: string;
+    maxLengthMessage?: string | undefined;
 };
 export type Regex = {
     regex: string | RegExp;
-    regexMessage: string;
+    regexMessage?: string | undefined;
 };
 import BaseValidator from './base-validator.js';
 //# sourceMappingURL=string-validator.d.ts.map