@planning-inspectorate/dynamic-forms 3.12.0 → 3.13.0

package/package.json

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

package/src/validator/base-validator.js

@@ -13,6 +13,19 @@ export class BaseValidator {
 			throw new Error("Abstract classes can't be instantiated.");
 		}
 	}
+
+	/**
+	 * 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 {import('../journey/journey-response.js').JourneyResponse} [journeyResponse] - The current journey response (optional).
+	 * @returns {import('express-validator').ValidationChain | import('express-validator').ValidationChain[]}
+	 */
+	// eslint-disable-next-line no-unused-vars
+	validate(questionObj, journeyResponse) {
+		throw new Error('validate method must be implemented by subclass');
+	}
 }
 
 export default BaseValidator;

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

@@ -7,6 +7,15 @@ export class BaseValidator {
      * @type {string} error message to display to user
      */
     errorMessage: string;
+    /**
+     * 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 {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[];
 }
 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;CAOb"}
+{"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"}