@planning-inspectorate/dynamic-forms 3.13.1 → 3.14.1

package/package.json

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

package/src/validator/address-validator.js

@@ -41,7 +41,7 @@ export class AddressValidator extends BaseValidator {
 
 	/**
 	 * validates response body using questionObj fieldname
-	 * @param {Question} questionObj
+	 * @param {import('../questions/question.js').Question} questionObj
 	 */
 	validate(questionObj) {
 		const fieldName = questionObj.fieldName;

package/src/validator/base-validator.js

@@ -18,7 +18,7 @@ export class BaseValidator {
 	 * Validates response body against field validators.
 	 * Subclasses must override this method.
 	 * @abstract
-	 * @param {import('../questions/question-props.js').QuestionProps} questionObj - The question object containing the fieldName to validate.
+	 * @param {{fieldName: string}} questionObj - The question object containing the fieldName to validate.
 	 * @param {import('../journey/journey-response.js').JourneyResponse} [journeyResponse] - The current journey response (optional).
 	 * @returns {import('express-validator').ValidationChain | import('express-validator').ValidationChain[]}
 	 */

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

@@ -31,7 +31,7 @@ export class ConditionalRequiredValidator extends BaseValidator {
 
 	/**
 	 * validates the response body, checking the questionObj's fieldname
-	 * @param {Question} questionObj
+	 * @param {import('../questions/options-question.js').OptionsQuestion} questionObj
 	 */
 	validate(questionObj) {
 		return questionObj.options.reduce((schema, option) => {

package/src/validator/cross-question-validator.js

@@ -37,7 +37,7 @@ export class CrossQuestionValidator extends BaseValidator {
 
 	/**
 	 * Validates response body against individual field validators.
-	 * @param {import('../questions/question-props.js').QuestionProps} questionObj - The question object containing the fieldName to validate.
+	 * @param {import('../questions/question.js').Question} questionObj - The question object containing the fieldName to validate.
 	 * @param {import('../journey/journey-response.js').JourneyResponse} [journeyResponse={}] - The current journey response, used to access saved answers for validation.
 	 * @returns {import('express-validator').ValidationChain[]}
 	 */

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

@@ -6,10 +6,6 @@ import { enGB } from 'date-fns/locale';
 import BaseValidator from './base-validator.js';
 import { parseDateInput, startOfDay } from '../lib/date-utils.js';
 
-/**
- * @typedef {import('../components/date/question.js')} DateQuestion
- */
-
 /**
  * @typedef {Object} DateValidationSettings
  * @property {Boolean} ensureFuture
@@ -64,7 +60,7 @@ export class DatePeriodValidator extends BaseValidator {
 
 	/**
 	 * validates the response body, checking the values sent for the date are valid
-	 * @param {DateQuestion} questionObj
+	 * @param {import('../components/date/question.js').DateQuestion} questionObj
 	 */
 	validate(questionObj) {
 		const fieldName = questionObj.fieldName;

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

@@ -1,10 +1,6 @@
 import { body } from 'express-validator';
 import DateValidator from './date-validator.js';
 
-/**
- * @typedef {import('./question.js')} DateTimeQuestion
- */
-
 /**
  * enforces a user has entered a valid date
  * @class
@@ -32,7 +28,7 @@ export class DateTimeValidator extends DateValidator {
 
 	/**
 	 * validates the response body, checking the values sent for the date are valid
-	 * @param {DateTimeQuestion} questionObj
+	 * @param {import('../components/date-time/question.js').DateTimeQuestion} questionObj
 	 */
 	validate(questionObj) {
 		const fieldName = questionObj.fieldName;

package/src/validator/date-validator.js

@@ -1,19 +1,15 @@
 import { body } from 'express-validator';
-
 import { isAfter, isBefore, isValid, parse } from 'date-fns';
 import { enGB } from 'date-fns/locale';
 
 import BaseValidator from './base-validator.js';
 import { endOfDay, parseDateInput, startOfDay } from '../lib/date-utils.js';
 
-/**
- * @typedef {import('../components/date/question.js')} DateQuestion
- */
-
 /**
  * @typedef {Object} DateValidationSettings
- * @property {Boolean} ensureFuture
- * @property {Boolean} ensurePast
+ * @property {Boolean} [ensureFuture]
+ * @property {Boolean} [ensurePast]
+ * @property {Boolean} [optional]
  */
 
 /**
@@ -34,7 +30,8 @@ export class DateValidator extends BaseValidator {
 		inputLabel,
 		dateValidationSettings = {
 			ensureFuture: false,
-			ensurePast: false
+			ensurePast: false,
+			optional: false
 		},
 		errorMessages
 	) {
@@ -63,12 +60,12 @@ export class DateValidator extends BaseValidator {
 	}
 
 	isRequired() {
-		return true;
+		return !this.dateValidationSettings.optional;
 	}
 
 	/**
 	 * validates the response body, checking the values sent for the date are valid
-	 * @param {DateQuestion} questionObj
+	 * @param {import('../components/date/question.js').DateQuestion} questionObj
 	 */
 	validate(questionObj) {
 		const fieldName = questionObj.fieldName;
@@ -76,9 +73,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]) {
@@ -96,6 +105,7 @@ export class DateValidator extends BaseValidator {
 					return this.noDayErrorMessage;
 				}),
 			body(monthInput)
+				.if(shouldValidate)
 				.notEmpty()
 				.withMessage((_, { req }) => {
 					if (req.body[dayInput] && !req.body[yearInput]) {
@@ -108,6 +118,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;
@@ -117,6 +128,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()
@@ -135,38 +147,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

@@ -2,10 +2,6 @@ import { body } from 'express-validator';
 
 import BaseValidator from './base-validator.js';
 
-/**
- * @typedef {import('../questions/question.js')} Question
- */
-
 /**
  * enforces a field is not empty
  * @class
@@ -30,7 +26,7 @@ export class RequiredValidator extends BaseValidator {
 
 	/**
 	 * validates the response body, checking the questionObj's fieldname
-	 * @param {Question} questionObj
+	 * @param {import('../questions/question.js').Question} questionObj
 	 */
 	validate(questionObj) {
 		return body(questionObj.fieldName).notEmpty().withMessage(this.errorMessage);

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

@@ -3,10 +3,6 @@ import { body } from 'express-validator';
 import BaseValidator from './base-validator.js';
 import { toArray } from '#src/lib/utils.js';
 
-/**
- * @typedef {import('../questions/question.js')} Question
- */
-
 /**
  * enforces a field is not empty when condition is satisfied
  * @class
@@ -34,7 +30,7 @@ export class UnitOptionEntryValidator extends BaseValidator {
 
 	/**
 	 * validates the response body, checking the questionObj's fieldname
-	 * @param {Question} questionObj
+	 * @param {import('../components/unit-option-entry/question.js').UnitOptionEntryQuestion} questionObj
 	 */
 	validate(questionObj) {
 		return questionObj.options.reduce((schema, option) => {

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

@@ -37,9 +37,9 @@ export class AddressValidator extends BaseValidator {
     } | undefined;
     /**
      * validates response body using questionObj fieldname
-     * @param {Question} questionObj
+     * @param {import('../questions/question.js').Question} questionObj
      */
-    validate(questionObj: Question): import("express-validator").ValidationChain[];
+    validate(questionObj: import("../questions/question.js").Question): import("express-validator").ValidationChain[];
     #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;;CAqGD;;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,OAAO,0BAA0B,EAAE,QAAQ,iDAYrD;;CAqGD;;0BA1JyB,qBAAqB"}

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

@@ -11,11 +11,13 @@ export class BaseValidator {
      * Validates response body against field validators.
      * Subclasses must override this method.
      * @abstract
-     * @param {import('../questions/question-props.js').QuestionProps} questionObj - The question object containing the fieldName to validate.
+     * @param {{fieldName: string}} questionObj - The question object containing the fieldName to validate.
      * @param {import('../journey/journey-response.js').JourneyResponse} [journeyResponse] - The current journey response (optional).
      * @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[];
+    validate(questionObj: {
+        fieldName: string;
+    }, 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?
      *

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;IAED;;;;;OAKG;IACH,sBAEC;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;QAAC,SAAS,EAAE,MAAM,CAAA;KAAC,oBACnB,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/conditional-required-validator.d.ts

@@ -13,9 +13,9 @@ export class ConditionalRequiredValidator extends BaseValidator {
     constructor(errorMessage?: string);
     /**
      * validates the response body, checking the questionObj's fieldname
-     * @param {Question} questionObj
+     * @param {import('../questions/options-question.js').OptionsQuestion} questionObj
      */
-    validate(questionObj: Question): any;
+    validate(questionObj: import("../questions/options-question.js").OptionsQuestion): never[];
     getConditionalFieldName(questionObj: any, option: any): string;
     isValueIncluded(questionObj: any, value: any): import("express-validator").ValidationChain;
 }

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":"AAKA;;GAEG;AAEH;;;GAGG;AACH;IAMC;;;OAGG;IACH,2BAFW,MAAM,EAQhB;IAED;;;OAGG;IACH,sBAFW,QAAQ,OAclB;IAED,+DAEC;IAED,2FAKC;CACD;;;0BAzDyB,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,OAAO,kCAAkC,EAAE,eAAe,WAcpE;IAED,+DAEC;IAED,2FAKC;CACD;;;0BAzDyB,qBAAqB"}

package/types/src/validator/cross-question-validator.d.ts

@@ -23,11 +23,11 @@ export class CrossQuestionValidator extends BaseValidator {
     useBodyValues: boolean;
     /**
      * Validates response body against individual field validators.
-     * @param {import('../questions/question-props.js').QuestionProps} questionObj - The question object containing the fieldName to validate.
+     * @param {import('../questions/question.js').Question} questionObj - The question object containing the fieldName to validate.
      * @param {import('../journey/journey-response.js').JourneyResponse} [journeyResponse={}] - The current journey response, used to access saved answers for validation.
      * @returns {import('express-validator').ValidationChain[]}
      */
-    validate(questionObj: import("../questions/question-props.js").QuestionProps, journeyResponse?: import("../journey/journey-response.js").JourneyResponse): import("express-validator").ValidationChain[];
+    validate(questionObj: import("../questions/question.js").Question, journeyResponse?: import("../journey/journey-response.js").JourneyResponse): import("express-validator").ValidationChain[];
 }
 export default CrossQuestionValidator;
 import BaseValidator from './base-validator.js';

package/types/src/validator/cross-question-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cross-question-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/cross-question-validator.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IAQC;;;;;;;OAOG;IACH,yEANG;QAAuB,mBAAmB,EAAlC,MAAM;QACyE,kBAAkB,EAAjG,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,GAAE,IAAI;QACrD,aAAa;KACtC,EAgBF;IA5BD,qBAAqB;IACrB,qBADW,MAAM,CACG;IACpB,+EAA+E;IAC/E,oBADW,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,CACxD;IACnB,sBAAsB;IACtB,eADW,OAAO,CACJ;IAyBd;;;;;OAKG;IACH,sBAJW,OAAO,gCAAgC,EAAE,aAAa,oBACtD,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,mBAAmB,EAAE,eAAe,EAAE,CAqBzD;CACD;;0BA/DyB,qBAAqB"}
+{"version":3,"file":"cross-question-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/cross-question-validator.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IAQC;;;;;;;OAOG;IACH,yEANG;QAAuB,mBAAmB,EAAlC,MAAM;QACyE,kBAAkB,EAAjG,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,GAAE,IAAI;QACrD,aAAa;KACtC,EAgBF;IA5BD,qBAAqB;IACrB,qBADW,MAAM,CACG;IACpB,+EAA+E;IAC/E,oBADW,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,CACxD;IACnB,sBAAsB;IACtB,eADW,OAAO,CACJ;IAyBd;;;;;OAKG;IACH,sBAJW,OAAO,0BAA0B,EAAE,QAAQ,oBAC3C,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,mBAAmB,EAAE,eAAe,EAAE,CAqBzD;CACD;;0BA/DyB,qBAAqB"}

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

@@ -1,6 +1,3 @@
-/**
- * @typedef {import('../components/date/question.js')} DateQuestion
- */
 /**
  * @typedef {Object} DateValidationSettings
  * @property {Boolean} ensureFuture
@@ -34,9 +31,9 @@ export class DatePeriodValidator extends BaseValidator {
     pastDateErrorMessage: any;
     /**
      * validates the response body, checking the values sent for the date are valid
-     * @param {DateQuestion} questionObj
+     * @param {import('../components/date/question.js').DateQuestion} questionObj
      */
-    validate(questionObj: DateQuestion): import("express-validator").ValidationChain[];
+    validate(questionObj: import("../components/date/question.js").DateQuestion): import("express-validator").ValidationChain[];
     rulesForNotEmptyInput({ dayInput, monthInput, yearInput }: {
         dayInput: any;
         monthInput: any;
@@ -55,7 +52,6 @@ export class DatePeriodValidator extends BaseValidator {
     #private;
 }
 export default DatePeriodValidator;
-export type DateQuestion = typeof import("../components/date/question.js");
 export type DateValidationSettings = {
     ensureFuture: boolean;
     ensurePast: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"date-period-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/date-period-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,iDAsBtB;IAED;;;;sDAuCC;IAED;;;;sDAwBC;IAED;;;;sDAuBC;;CA6BD;;;;;;;0BA5MyB,qBAAqB"}
+{"version":3,"file":"date-period-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/date-period-validator.js"],"names":[],"mappings":"AAQA;;;;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,OAAO,gCAAgC,EAAE,YAAY,iDAsB/D;IAED;;;;sDAuCC;IAED;;;;sDAwBC;IAED;;;;sDAuBC;;CA6BD;;;;;;0BAxMyB,qBAAqB"}

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

@@ -1,6 +1,3 @@
-/**
- * @typedef {import('./question.js')} DateTimeQuestion
- */
 /**
  * enforces a user has entered a valid date
  * @class
@@ -17,11 +14,10 @@ export class DateTimeValidator extends DateValidator {
     timeInputLabel: string;
     /**
      * validates the response body, checking the values sent for the date are valid
-     * @param {DateTimeQuestion} questionObj
+     * @param {import('../components/date-time/question.js').DateTimeQuestion} questionObj
      */
-    validate(questionObj: DateTimeQuestion): import("express-validator").ValidationChain[];
+    validate(questionObj: import("../components/date-time/question.js").DateTimeQuestion): import("express-validator").ValidationChain[];
 }
 export default DateTimeValidator;
-export type DateTimeQuestion = any;
 import DateValidator from './date-validator.js';
 //# sourceMappingURL=date-time-validator.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"date-time-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/date-time-validator.js"],"names":[],"mappings":"AAGA;;GAEG;AAEH;;;GAGG;AACH;IACC;;;;;;OAMG;IACH,4BALW,MAAM,mBACN,MAAM,2BACN,sBAAsB,sBACtB,MAAM,EAahB;IADA,uBAAoC;IAGrC;;;OAGG;IACH,sBAFW,gBAAgB,iDAsC1B;CACD;;;0BAxEyB,qBAAqB"}
+{"version":3,"file":"date-time-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/date-time-validator.js"],"names":[],"mappings":"AAGA;;;GAGG;AACH;IACC;;;;;;OAMG;IACH,4BALW,MAAM,mBACN,MAAM,2BACN,sBAAsB,sBACtB,MAAM,EAahB;IADA,uBAAoC;IAGrC;;;OAGG;IACH,sBAFW,OAAO,qCAAqC,EAAE,gBAAgB,iDAsCxE;CACD;;0BApEyB,qBAAqB"}

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

@@ -1,10 +1,8 @@
-/**
- * @typedef {import('../components/date/question.js')} DateQuestion
- */
 /**
  * @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
@@ -34,16 +32,16 @@ export class DateValidator extends BaseValidator {
     pastDateErrorMessage: any;
     /**
      * validates the response body, checking the values sent for the date are valid
-     * @param {DateQuestion} questionObj
+     * @param {import('../components/date/question.js').DateQuestion} questionObj
      */
-    validate(questionObj: DateQuestion): import("express-validator").ValidationChain[];
+    validate(questionObj: import("../components/date/question.js").DateQuestion): import("express-validator").ValidationChain[];
     #private;
 }
 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;IAS7G;;;OAGG;IACH,sBAFW,YAAY,iDAuGtB;;CA6BD;;;;;;;0BArMyB,qBAAqB"}
+{"version":3,"file":"date-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/date-validator.js"],"names":[],"mappings":"AAOA;;;;;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,OAAO,gCAAgC,EAAE,YAAY,iDA0H/D;;CA6BD;;;;;;;0BAtNyB,qBAAqB"}

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

@@ -1,6 +1,3 @@
-/**
- * @typedef {import('../questions/question.js')} Question
- */
 /**
  * enforces a field is not empty
  * @class
@@ -13,11 +10,10 @@ export class RequiredValidator extends BaseValidator {
     constructor(errorMessage?: string);
     /**
      * validates the response body, checking the questionObj's fieldname
-     * @param {Question} questionObj
+     * @param {import('../questions/question.js').Question} questionObj
      */
-    validate(questionObj: Question): import("express-validator").ValidationChain;
+    validate(questionObj: import("../questions/question.js").Question): import("express-validator").ValidationChain;
 }
 export default RequiredValidator;
-export type Question = typeof import("../questions/question.js");
 import BaseValidator from './base-validator.js';
 //# sourceMappingURL=required-validator.d.ts.map

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;CAKD;;;0BAvCyB,qBAAqB"}
+{"version":3,"file":"required-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/required-validator.js"],"names":[],"mappings":"AAIA;;;GAGG;AACH;IAMC;;;OAGG;IACH,2BAFW,MAAM,EAQhB;IAED;;;OAGG;IACH,sBAFW,OAAO,0BAA0B,EAAE,QAAQ,+CAIrD;CAKD;;0BAnCyB,qBAAqB"}

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

@@ -1,6 +1,3 @@
-/**
- * @typedef {import('../questions/question.js')} Question
- */
 /**
  * enforces a field is not empty when condition is satisfied
  * @class
@@ -30,12 +27,11 @@ export class UnitOptionEntryValidator extends BaseValidator {
     regexMessage: string;
     /**
      * validates the response body, checking the questionObj's fieldname
-     * @param {Question} questionObj
+     * @param {import('../components/unit-option-entry/question.js').UnitOptionEntryQuestion} questionObj
      */
-    validate(questionObj: Question): any;
+    validate(questionObj: import("../components/unit-option-entry/question.js").UnitOptionEntryQuestion): never[];
     isValueIncluded(questionObj: any, value: any): import("express-validator").ValidationChain;
 }
 export default UnitOptionEntryValidator;
-export type Question = typeof import("../questions/question.js");
 import BaseValidator from './base-validator.js';
 //# sourceMappingURL=unit-option-entry-validator.d.ts.map

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":"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"}
+{"version":3,"file":"unit-option-entry-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/unit-option-entry-validator.js"],"names":[],"mappings":"AAKA;;;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,OAAO,6CAA6C,EAAE,uBAAuB,WA4CvF;IAED,2FAKC;CACD;;0BAlFyB,qBAAqB"}