@planning-inspectorate/dynamic-forms 3.13.0 → 3.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",

package/src/questions/question.js

@@ -1,7 +1,5 @@
 import escape from 'escape-html';
-import RequiredValidator from '../validator/required-validator.js';
 import { capitalize, nl2br, trimTrailingSlash } from '../lib/utils.js';
-import AddressValidator from '../validator/address-validator.js';
 import MultiFieldInputValidator from '../validator/multi-field-input-validator.js';
 import { answerObjectForManageList } from '#src/components/manage-list/utils.js';
 
@@ -454,12 +452,7 @@ export class Question {
 	 * @returns {boolean}
 	 */
 	isRequired() {
-		return this.validators?.some(
-			(item) =>
-				item instanceof RequiredValidator ||
-				(item instanceof AddressValidator && item.isRequired()) ||
-				(item instanceof MultiFieldInputValidator && item.isRequired())
-		);
+		return this.validators?.some((validator) => validator.isRequired());
 	}
 	/**
 	 * @param {string} inputField

package/src/questions/question.test.js

@@ -437,4 +437,17 @@ describe('./src/dynamic-forms/question.js', () => {
 			});
 		});
 	});
+
+	describe('isRequired', () => {
+		it('should not be required if no validators', () => {
+			const q = getTestQuestion({ validators: [] });
+			assert.strictEqual(q.isRequired(), false);
+		});
+		it('should be required if any validator is required', () => {
+			const q = getTestQuestion({
+				validators: [{ isRequired: () => false }, { isRequired: () => true }]
+			});
+			assert.strictEqual(q.isRequired(), true);
+		});
+	});
 });

package/src/validator/base-validator.js

@@ -26,6 +26,16 @@ export class BaseValidator {
 	validate(questionObj, journeyResponse) {
 		throw new Error('validate method must be implemented by subclass');
 	}
+
+	/**
+	 * Should the question that this validator is configured with be treated as a required question?
+	 *
+	 * Validators should override this method as appropriate, implementing any custom required logic.
+	 * For example, the AddressValidator is configurable and is required if any one field is required.
+	 */
+	isRequired() {
+		return false;
+	}
 }
 
 export default BaseValidator;

package/src/validator/date-validator.js

@@ -1,5 +1,4 @@
 import { body } from 'express-validator';
-
 import { isAfter, isBefore, isValid, parse } from 'date-fns';
 import { enGB } from 'date-fns/locale';
 
@@ -12,8 +11,9 @@ import { endOfDay, parseDateInput, startOfDay } from '../lib/date-utils.js';
 
 /**
  * @typedef {Object} DateValidationSettings
- * @property {Boolean} ensureFuture
- * @property {Boolean} ensurePast
+ * @property {Boolean} [ensureFuture]
+ * @property {Boolean} [ensurePast]
+ * @property {Boolean} [optional]
  */
 
 /**
@@ -34,7 +34,8 @@ export class DateValidator extends BaseValidator {
 		inputLabel,
 		dateValidationSettings = {
 			ensureFuture: false,
-			ensurePast: false
+			ensurePast: false,
+			optional: false
 		},
 		errorMessages
 	) {
@@ -62,6 +63,10 @@ export class DateValidator extends BaseValidator {
 		this.dateValidationSettings = dateValidationSettings;
 	}
 
+	isRequired() {
+		return !this.dateValidationSettings.optional;
+	}
+
 	/**
 	 * validates the response body, checking the values sent for the date are valid
 	 * @param {DateQuestion} questionObj
@@ -72,9 +77,21 @@ export class DateValidator extends BaseValidator {
 		const monthInput = `${fieldName}_month`;
 		const yearInput = `${fieldName}_year`;
 
+		/**
+		 * Run before every check, if the correct param set then skip the validation
+		 * when there is no data entered.
+		 */
+		const shouldValidate = (value, { req }) => {
+			if (this.dateValidationSettings.optional === true) {
+				return !!(req.body[dayInput] || req.body[monthInput] || req.body[yearInput]);
+			}
+			return true;
+		};
+
 		const rules = [
 			// check all or some date inputs are not empty
 			body(dayInput)
+				.if(shouldValidate)
 				.notEmpty()
 				.withMessage((_, { req }) => {
 					if (!req.body[monthInput] && !req.body[yearInput]) {
@@ -92,6 +109,7 @@ export class DateValidator extends BaseValidator {
 					return this.noDayErrorMessage;
 				}),
 			body(monthInput)
+				.if(shouldValidate)
 				.notEmpty()
 				.withMessage((_, { req }) => {
 					if (req.body[dayInput] && !req.body[yearInput]) {
@@ -104,6 +122,7 @@ export class DateValidator extends BaseValidator {
 					// empty error message returned
 				}),
 			body(yearInput)
+				.if(shouldValidate)
 				.notEmpty()
 				.withMessage((_, { req }) => {
 					if (req.body[dayInput] && req.body[monthInput]) return this.noYearErrorMessage;
@@ -113,6 +132,7 @@ export class DateValidator extends BaseValidator {
 
 			// check date values entered are within valid ranges
 			body(dayInput)
+				.if(shouldValidate)
 				.isInt({ min: 1, max: 31 })
 				.withMessage(this.invalidDateErrorMessage)
 				.bail()
@@ -131,38 +151,42 @@ export class DateValidator extends BaseValidator {
 
 					return true;
 				}),
-			body(monthInput).isInt({ min: 1, max: 12 }).withMessage(this.invalidMonthErrorMessage),
-			body(yearInput).isInt({ min: 1000, max: 9999 }).withMessage(this.invalidYearErrorMessage)
+			body(monthInput).if(shouldValidate).isInt({ min: 1, max: 12 }).withMessage(this.invalidMonthErrorMessage),
+			body(yearInput).if(shouldValidate).isInt({ min: 1000, max: 9999 }).withMessage(this.invalidYearErrorMessage)
 		];
 
 		if (this.dateValidationSettings.ensurePast === true) {
 			rules.push(
-				body(dayInput).custom((value, { req }) => {
-					const inputDate = parseDateInput({ day: value, month: req.body[monthInput], year: req.body[yearInput] });
+				body(dayInput)
+					.if(shouldValidate)
+					.custom((value, { req }) => {
+						const inputDate = parseDateInput({ day: value, month: req.body[monthInput], year: req.body[yearInput] });
 
-					const today = endOfDay();
+						const today = endOfDay();
 
-					if (isAfter(inputDate, today)) {
-						throw new Error(this.futureDateErrorMessage);
-					}
+						if (isAfter(inputDate, today)) {
+							throw new Error(this.futureDateErrorMessage);
+						}
 
-					return true;
-				})
+						return true;
+					})
 			);
 		}
 
 		if (this.dateValidationSettings.ensureFuture === true) {
 			rules.push(
-				body(dayInput).custom((value, { req }) => {
-					const inputDate = parseDateInput({ day: value, month: req.body[monthInput], year: req.body[yearInput] });
-					const today = startOfDay();
-
-					if (isBefore(inputDate, today)) {
-						throw new Error(this.pastDateErrorMessage);
-					}
-
-					return true;
-				})
+				body(dayInput)
+					.if(shouldValidate)
+					.custom((value, { req }) => {
+						const inputDate = parseDateInput({ day: value, month: req.body[monthInput], year: req.body[yearInput] });
+						const today = startOfDay();
+
+						if (isBefore(inputDate, today)) {
+							throw new Error(this.pastDateErrorMessage);
+						}
+
+						return true;
+					})
 			);
 		}
 

package/src/validator/date-validator.test.js

@@ -389,6 +389,109 @@ describe('./src/dynamic-forms/validator/date-validator.js', () => {
 			assert.strictEqual(errors[`${question.fieldName}_month`].msg, errorMessages.invalidMonthErrorMessage);
 			assert.strictEqual(errors[`${question.fieldName}_year`].msg, errorMessages.invalidYearErrorMessage);
 		});
+
+		it('passes validation if optional is true and no fields are provided (undefined)', async () => {
+			const req = {
+				body: {
+					['date-question_day']: undefined,
+					['date-question_month']: undefined,
+					['date-question_year']: undefined
+				}
+			};
+
+			const question = {
+				fieldName: 'date-question'
+			};
+
+			const errors = await _validationMappedErrors(req, question, 'the required date', undefined, {
+				optional: true
+			});
+
+			assert.strictEqual(Object.keys(errors).length, 0);
+		});
+
+		it('passes validation if optional is true and fields are empty strings', async () => {
+			const req = {
+				body: {
+					['date-question_day']: '',
+					['date-question_month']: '',
+					['date-question_year']: ''
+				}
+			};
+
+			const question = {
+				fieldName: 'date-question'
+			};
+
+			const errors = await _validationMappedErrors(req, question, 'the required date', undefined, {
+				optional: true
+			});
+
+			assert.strictEqual(Object.keys(errors).length, 0);
+		});
+
+		it('throws error if optional is true but date is partially filled (missing day)', async () => {
+			const req = {
+				body: {
+					['date-question_day']: '',
+					['date-question_month']: '10',
+					['date-question_year']: '2023'
+				}
+			};
+
+			const question = {
+				fieldName: 'date-question'
+			};
+
+			const errors = await _validationMappedErrors(req, question, 'the required date', undefined, {
+				optional: true
+			});
+
+			assert.strictEqual(Object.keys(errors).length, 1);
+			assert.strictEqual(errors[`${question.fieldName}_day`].msg, 'The required date must include a day');
+		});
+
+		it('throws error if optional is true but invalid values are provided', async () => {
+			const req = {
+				body: {
+					['date-question_day']: '35',
+					['date-question_month']: '10',
+					['date-question_year']: '2023'
+				}
+			};
+
+			const question = {
+				fieldName: 'date-question'
+			};
+
+			const errors = await _validationMappedErrors(req, question, 'the required date', undefined, {
+				optional: true
+			});
+
+			assert.strictEqual(Object.keys(errors).length, 1);
+			assert.strictEqual(errors[`${question.fieldName}_day`].msg, 'The required date day must be a real day');
+		});
+
+		it('throws error if an object is passed without the optional key (undefined) and nothing is entered', async () => {
+			const req = {
+				body: {
+					['date-question_day']: undefined,
+					['date-question_month']: undefined,
+					['date-question_year']: undefined
+				}
+			};
+
+			const question = {
+				fieldName: 'date-question'
+			};
+
+			const errors = await _validationMappedErrors(req, question, 'the required date', undefined, {
+				randomKey: true
+			});
+
+			assert.strictEqual(Object.keys(errors).length, 3);
+			assert.strictEqual(errors[`${question.fieldName}_day`].msg, 'Enter the required date');
+		});
 	});
 });
 

package/src/validator/required-validator.js

@@ -35,6 +35,10 @@ export class RequiredValidator extends BaseValidator {
 	validate(questionObj) {
 		return body(questionObj.fieldName).notEmpty().withMessage(this.errorMessage);
 	}
+
+	isRequired() {
+		return true;
+	}
 }
 
 export default RequiredValidator;

package/test/is-required.test.js

@@ -0,0 +1,130 @@
+import { describe, it } from 'node:test';
+import { COMPONENT_TYPES } from '#src/components/utils/component-types.js';
+import { createQuestions } from '#src/questions/create-questions.js';
+import { questionClasses } from '#src/questions/questions.js';
+import { Section, SECTION_STATUS } from '#section';
+import assert from 'node:assert';
+import { JourneyResponse } from '#journey-response';
+import RequiredValidator from '#src/validator/required-validator.js';
+import DateValidator from '#src/validator/date-validator.js';
+import AddressValidator from '#src/validator/address-validator.js';
+
+/**
+ * @typedef {import('../src/questions/question-props.js').QuestionProps} Props
+ */
+
+/**
+ * Check logic related to the question.isRequired method, which in turn drives the section status logic
+ */
+describe('is-required', () => {
+	/** @type {() => Record<string, Props>} */
+	const getQuestionProps = () => ({
+		holidayActivities: {
+			type: COMPONENT_TYPES.CHECKBOX,
+			title: 'Holiday Activities',
+			question: 'Which activities do you want to do on holiday?',
+			fieldName: 'holidayActivities',
+			url: 'holiday-activities',
+			label: 'Select all that apply',
+			options: [
+				{ value: 'swimming', text: 'Swimming' },
+				{ value: 'hiking', text: 'Hiking' },
+				{ value: 'sightseeing', text: 'Sightseeing' }
+			]
+		},
+		addInsurance: {
+			type: COMPONENT_TYPES.BOOLEAN,
+			title: 'Travel Insurance',
+			question: 'Do you want to add travel insurance to your holiday?',
+			fieldName: 'addInsurance',
+			url: 'add-insurance',
+			label: 'Add insurance?'
+		},
+		travelInsuranceType: {
+			type: COMPONENT_TYPES.RADIO,
+			title: 'Travel Insurance Type',
+			question: 'Which type of travel insurance would you like?',
+			fieldName: 'travelInsuranceType',
+			url: 'travel-insurance-type',
+			label: 'Select an insurance type',
+			options: [
+				{ value: 'basic', text: 'Basic' },
+				{ value: 'comprehensive', text: 'Comprehensive' },
+				{ value: 'premium', text: 'Premium' }
+			]
+		},
+		holidayArrival: {
+			type: COMPONENT_TYPES.DATE_TIME,
+			title: 'Holiday Arrival',
+			question: 'When would you like to arrive at your destination?',
+			fieldName: 'holidayArrival',
+			url: 'holiday-arrival',
+			label: 'Enter your arrival time'
+		},
+		hotelAddress: {
+			type: COMPONENT_TYPES.ADDRESS,
+			title: 'Hotel Address',
+			question: 'What is the address of your hotel?',
+			fieldName: 'hotelAddress',
+			url: 'hotel-address',
+			label: 'Hotel address'
+		}
+	});
+
+	const newSection = (questionProps) => {
+		const questions = createQuestions(questionProps, questionClasses, {});
+
+		return new Section('test', 'test')
+			.addQuestion(questions.holidayActivities)
+			.addQuestion(questions.addInsurance)
+			.addQuestion(questions.travelInsuranceType)
+			.addQuestion(questions.holidayArrival)
+			.addQuestion(questions.hotelAddress);
+	};
+	const sectionStatus = (questionProps, answers = {}) => {
+		const section = newSection(questionProps);
+
+		const jr = new JourneyResponse('id-1', '', answers);
+		return section.getStatus(jr);
+	};
+
+	it('should be section=complete if no questions are required', () => {
+		const props = getQuestionProps();
+		assert.strictEqual(sectionStatus(props), SECTION_STATUS.COMPLETE);
+	});
+	it('should be section=not started if any question is required', () => {
+		const props = getQuestionProps();
+
+		// for each question, mark each one required one at a time
+		for (const key of Object.keys(props)) {
+			const copy = getQuestionProps();
+			copy[key].validators = [new RequiredValidator()];
+			assert.strictEqual(sectionStatus(copy), SECTION_STATUS.NOT_STARTED);
+		}
+	});
+	it('should treat date validator as required', () => {
+		const props = getQuestionProps();
+		props.holidayArrival.validators = [new DateValidator('My Date')];
+		assert.strictEqual(sectionStatus(props, {}), SECTION_STATUS.NOT_STARTED);
+	});
+	it('should treat address validator as required if there are required fields', () => {
+		const props = getQuestionProps();
+		props.hotelAddress.validators = [
+			new AddressValidator({
+				requiredFields: {
+					addressLine1: true,
+					addressLine2: false,
+					county: false,
+					townCity: false,
+					postcode: true
+				}
+			})
+		];
+		assert.strictEqual(sectionStatus(props, {}), SECTION_STATUS.NOT_STARTED);
+	});
+	it('should not treat address validator as required if there are no required fields', () => {
+		const props = getQuestionProps();
+		props.hotelAddress.validators = [new AddressValidator()];
+		assert.strictEqual(sectionStatus(props, {}), SECTION_STATUS.COMPLETE);
+	});
+});

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;;;;GAIG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IA4DC;;;OAGG;IACH,yLAHW,OAAO,qBAAqB,EAAE,kBAAkB,oBAChD,MAAM,CAAC,MAAM,WAAW,EAsDlC;IAnHD,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,aAAa,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;IACF;;;;;;OAMG;IACH,wBAFU,OAAO,CAEc;IAyC9B,iCAAgC;IAChC,kBAAwB;IAExB;;;;MAAwB;IAgBzB;;;;;;OAMG;IACH,4BAFa,OAAO,CAInB;IAWD,iCANa,OAAO,EAWnB;IAdD;;;;OAIG;IACH,6BAFa,OAAO,CAInB;IASD;;;;;;;;;;;;;;OAcG;IACH,uFARG;QAAmE,MAAM,EAAjE,OAAO,6BAA6B,EAAE,WAAW;QACS,kBAAkB;QACnC,OAAO,EAAhD,OAAO,eAAe,EAAE,OAAO;QACkB,OAAO,EAAxD,OAAO,uBAAuB,EAAE,OAAO;QACL,cAAc;QAC9B,OAAO,GAAzB,OAAO;KACf,GAAU,iBAAiB,CAS7B;IAED;;;;;;;;;OASG;IACH,kCAPW,OAAO,eAAe,EAAE,OAAO,WAC/B,OAAO,uBAAuB,EAAE,OAAO,mBACvC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,OAAO,YACP,OAAO,qBAAqB,EAAE,+BAA+B,GAC3D,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,OAAO,gCAAgC,EAAE,eAAe,mCACxD,OAAO,qBAAqB,EAAE,+BAA+B,GAC3D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAc/B;IAED;;;;;OAKG;IACH,kBAJW,OAAO,SAAS,EAAE,QAAQ,aAC1B,iBAAiB,GACf,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,8BANW,OAAO,SAAS,EAAE,OAAO,WAEzB,OAAO,eAAe,EAAE,OAAO,WAD/B,OAAO,uBAAuB,EAAE,OAAO,gFAGrC,iBAAiB,GAAC,SAAS,CAmBvC;IAED;;;;;;OAMG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAczD;IAED;;;;;;OAMG,CACH,0BALW,OAAO,SAAS,EAAE,OAAO,cAEzB,OAAO,eAAe,EAAE,OAAO,WAD/B,OAAO,uBAAuB,EAAE,OAAO,GAErC,iBAAiB,GAAG,SAAS,CAIzC;IAED;;;;;;;;;OASG;IACH,wBAPW,OAAO,SAAS,EAAE,QAAQ,WAC1B,OAAO,uBAAuB,EAAE,OAAO,kBACvC,MAAM,mBACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;;;;;OAUG;IACH,wDARW,OAAO,uBAAuB,EAAE,OAAO,UACvC,OAAO,uBACL,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;KACpC,CAAC,CAaJ;IAED;;;;;;OAMG;IACH,2CAJW,OAAO,uBAAuB,EAAE,OAAO,UADvC,OAAO,GAGL,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,OAAO,gCAAgC,EAAE,eAAe,cACxD,MAAM,GACJ,OAAO,CAInB;CACD;;WAlda,MAAM;cACN,MAAM;eACN,MAAM;eACN,MAAM;;;;gCAMP,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;mCAhBA,iBAAiB;gCAEpB,qBAAqB;gCADrB,kBAAkB"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../src/questions/question.js"],"names":[],"mappings":"AAKA;;;;GAIG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IA4DC;;;OAGG;IACH,yLAHW,OAAO,qBAAqB,EAAE,kBAAkB,oBAChD,MAAM,CAAC,MAAM,WAAW,EAsDlC;IAnHD,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,aAAa,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;IACF;;;;;;OAMG;IACH,wBAFU,OAAO,CAEc;IAyC9B,iCAAgC;IAChC,kBAAwB;IAExB;;;;MAAwB;IAgBzB;;;;;;OAMG;IACH,4BAFa,OAAO,CAInB;IAWD,iCANa,OAAO,EAWnB;IAdD;;;;OAIG;IACH,6BAFa,OAAO,CAInB;IASD;;;;;;;;;;;;;;OAcG;IACH,uFARG;QAAmE,MAAM,EAAjE,OAAO,6BAA6B,EAAE,WAAW;QACS,kBAAkB;QACnC,OAAO,EAAhD,OAAO,eAAe,EAAE,OAAO;QACkB,OAAO,EAAxD,OAAO,uBAAuB,EAAE,OAAO;QACL,cAAc;QAC9B,OAAO,GAAzB,OAAO;KACf,GAAU,iBAAiB,CAS7B;IAED;;;;;;;;;OASG;IACH,kCAPW,OAAO,eAAe,EAAE,OAAO,WAC/B,OAAO,uBAAuB,EAAE,OAAO,mBACvC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,OAAO,YACP,OAAO,qBAAqB,EAAE,+BAA+B,GAC3D,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,OAAO,gCAAgC,EAAE,eAAe,mCACxD,OAAO,qBAAqB,EAAE,+BAA+B,GAC3D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAc/B;IAED;;;;;OAKG;IACH,kBAJW,OAAO,SAAS,EAAE,QAAQ,aAC1B,iBAAiB,GACf,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,8BANW,OAAO,SAAS,EAAE,OAAO,WAEzB,OAAO,eAAe,EAAE,OAAO,WAD/B,OAAO,uBAAuB,EAAE,OAAO,gFAGrC,iBAAiB,GAAC,SAAS,CAmBvC;IAED;;;;;;OAMG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAczD;IAED;;;;;;OAMG,CACH,0BALW,OAAO,SAAS,EAAE,OAAO,cAEzB,OAAO,eAAe,EAAE,OAAO,WAD/B,OAAO,uBAAuB,EAAE,OAAO,GAErC,iBAAiB,GAAG,SAAS,CAIzC;IAED;;;;;;;;;OASG;IACH,wBAPW,OAAO,SAAS,EAAE,QAAQ,WAC1B,OAAO,uBAAuB,EAAE,OAAO,kBACvC,MAAM,mBACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;;;;;OAUG;IACH,wDARW,OAAO,uBAAuB,EAAE,OAAO,UACvC,OAAO,uBACL,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;KACpC,CAAC,CAaJ;IAED;;;;;;OAMG;IACH,2CAJW,OAAO,uBAAuB,EAAE,OAAO,UADvC,OAAO,GAGL,UAAU,GAAC,UAAU,EAAE,GAAC,SAAS,CAqB7C;IAED;;;OAGG;IACH,eAHW,OAAO,GACL,OAAO,CAInB;IAED;;OAEG;IACH,cAFa,OAAO,CAInB;IACD;;;OAGG;IACH,4BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,4BAJW,OAAO,gCAAgC,EAAE,eAAe,cACxD,MAAM,GACJ,OAAO,CAInB;CACD;;WA7ca,MAAM;cACN,MAAM;eACN,MAAM;eACN,MAAM;;;;gCAMP,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;mCAhBA,iBAAiB;gCAEpB,qBAAqB;gCADrB,kBAAkB"}

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

@@ -40,7 +40,6 @@ export class AddressValidator extends BaseValidator {
      * @param {Question} questionObj
      */
     validate(questionObj: Question): import("express-validator").ValidationChain[];
-    isRequired(): boolean;
     #private;
 }
 export default AddressValidator;

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;;;;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"}
+{"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;;CAqGD;;0BA1JyB,qBAAqB"}

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

@@ -16,6 +16,13 @@ export class BaseValidator {
      * @returns {import('express-validator').ValidationChain | import('express-validator').ValidationChain[]}
      */
     validate(questionObj: import("../questions/question-props.js").QuestionProps, journeyResponse?: import("../journey/journey-response.js").JourneyResponse): import("express-validator").ValidationChain | import("express-validator").ValidationChain[];
+    /**
+     * Should the question that this validator is configured with be treated as a required question?
+     *
+     * Validators should override this method as appropriate, implementing any custom required logic.
+     * For example, the AddressValidator is configurable and is required if any one field is required.
+     */
+    isRequired(): boolean;
 }
 export default BaseValidator;
 //# sourceMappingURL=base-validator.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"base-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/base-validator.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH;IACC;;OAEG;IACH,cAFU,MAAM,CAEH;IAQb;;;;;;;OAOG;IAEH,sBALW,OAAO,gCAAgC,EAAE,aAAa,oBACtD,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,mBAAmB,EAAE,eAAe,GAAG,OAAO,mBAAmB,EAAE,eAAe,EAAE,CAKvG;CACD"}
+{"version":3,"file":"base-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/base-validator.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH;IACC;;OAEG;IACH,cAFU,MAAM,CAEH;IAQb;;;;;;;OAOG;IAEH,sBALW,OAAO,gCAAgC,EAAE,aAAa,oBACtD,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,mBAAmB,EAAE,eAAe,GAAG,OAAO,mBAAmB,EAAE,eAAe,EAAE,CAKvG;IAED;;;;;OAKG;IACH,sBAEC;CACD"}

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

@@ -3,8 +3,9 @@
  */
 /**
  * @typedef {Object} DateValidationSettings
- * @property {Boolean} ensureFuture
- * @property {Boolean} ensurePast
+ * @property {Boolean} [ensureFuture]
+ * @property {Boolean} [ensurePast]
+ * @property {Boolean} [optional]
  */
 /**
  * enforces a user has entered a valid date
@@ -42,8 +43,9 @@ export class DateValidator extends BaseValidator {
 export default DateValidator;
 export type DateQuestion = typeof import("../components/date/question.js");
 export type DateValidationSettings = {
-    ensureFuture: boolean;
-    ensurePast: boolean;
+    ensureFuture?: boolean | undefined;
+    ensurePast?: boolean | undefined;
+    optional?: boolean | undefined;
 };
 import BaseValidator from './base-validator.js';
 //# sourceMappingURL=date-validator.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"date-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/date-validator.js"],"names":[],"mappings":"AAQA;;GAEG;AAEH;;;;GAIG;AAEH;;;GAGG;AACH;IAIC;;;;;OAKG;IACH,wBAJW,MAAM,2BACN,sBAAsB,kBACtB,MAAM,EAgChB;IAvCD,qCAAqC;IACrC,wBADW,sBAAsB,CACV;IAoBtB,uBAAmG;IACnG,uBAAmG;IACnG,yBAAyG;IACzG,wBAAsG;IACtG,4BAAkH;IAClH,2BAA+G;IAC/G,6BACuF;IACvF,6BACuF;IACvF,8BACyF;IACzF,6BACuF;IACvF,4BAAkH;IAClH,0BAA4G;IAK7G;;;OAGG;IACH,sBAFW,YAAY,iDAuGtB;;CA6BD;;;;;;;0BAjMyB,qBAAqB"}
+{"version":3,"file":"date-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/date-validator.js"],"names":[],"mappings":"AAOA;;GAEG;AAEH;;;;;GAKG;AAEH;;;GAGG;AACH;IAIC;;;;;OAKG;IACH,wBAJW,MAAM,2BACN,sBAAsB,kBACtB,MAAM,EAiChB;IAxCD,qCAAqC;IACrC,wBADW,sBAAsB,CACV;IAqBtB,uBAAmG;IACnG,uBAAmG;IACnG,yBAAyG;IACzG,wBAAsG;IACtG,4BAAkH;IAClH,2BAA+G;IAC/G,6BACuF;IACvF,6BACuF;IACvF,8BACyF;IACzF,6BACuF;IACvF,4BAAkH;IAClH,0BAA4G;IAS7G;;;OAGG;IACH,sBAFW,YAAY,iDA0HtB;;CA6BD;;;;;;;;0BA1NyB,qBAAqB"}

package/types/src/validator/multi-field-input-validator.d.ts

@@ -51,7 +51,6 @@ export class MultiFieldInputValidator extends BaseValidator {
      * validates response body against question's required fields
      */
     validate(): import("express-validator").ValidationChain[];
-    isRequired(): boolean;
     /**
      * checks if a field is required
      * @param {string} fieldName

package/types/src/validator/multi-field-input-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"multi-field-input-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/multi-field-input-validator.js"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;GAEG;AAEH;IACC;;;;OAIG;IACH,0CAHG;QAAyB,MAAM;QACP,eAAe;KAAC,EAQ1C;IAFA,gBAAoB;IACpB,wBAAwE;IAGzE;;OAEG;IAEH,0DA8BC;IAED,sBAEC;IACD;;;;OAIG;IACH,gCAHW,MAAM,GACJ,OAAO,CAQnB;CACD;;;WA3Ga,SAAS,MAAM;;;;;;;;;;;;eAkBf,MAAM;;;;;4BAOP,SAAS,GAAG;IACpB,QAAQ,EAAE,IAAI,CAAC;IACf,YAAY,EAAE,MAAM,CAAA;CACrB;4BAIS,SAAS,GAAG;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;oBAIS,aAAa,GAAG,aAAa;0BA1ChB,qBAAqB"}
+{"version":3,"file":"multi-field-input-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/multi-field-input-validator.js"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;GAEG;AAEH;IACC;;;;OAIG;IACH,0CAHG;QAAyB,MAAM;QACP,eAAe;KAAC,EAQ1C;IAFA,gBAAoB;IACpB,wBAAwE;IAGzE;;OAEG;IAEH,0DA8BC;IAKD;;;;OAIG;IACH,gCAHW,MAAM,GACJ,OAAO,CAQnB;CACD;;;WA3Ga,SAAS,MAAM;;;;;;;;;;;;eAkBf,MAAM;;;;;4BAOP,SAAS,GAAG;IACpB,QAAQ,EAAE,IAAI,CAAC;IACf,YAAY,EAAE,MAAM,CAAA;CACrB;4BAIS,SAAS,GAAG;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;oBAIS,aAAa,GAAG,aAAa;0BA1ChB,qBAAqB"}

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

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