@planning-inspectorate/dynamic-forms 3.4.0 → 3.5.0

package/package.json

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

package/src/validator/document-upload-validator.js

@@ -4,10 +4,12 @@ import { body } from 'express-validator';
 export default class DocumentUploadValidator extends BaseValidator {
 	/**
 	 * @param {string} fieldName
+	 * @param {string} errorMessage
 	 */
-	constructor(fieldName) {
+	constructor(fieldName, errorMessage = 'Upload an attachment') {
 		super();
 		this.fieldName = fieldName;
+		this.errorMessage = errorMessage;
 	}
 
 	validate() {
@@ -17,7 +19,7 @@ export default class DocumentUploadValidator extends BaseValidator {
 				const parsed = JSON.parse(decodedJson);
 
 				if (parsed.length === 0) {
-					throw new Error('Upload an attachment');
+					throw new Error(this.errorMessage);
 				}
 				return true;
 			})

package/src/validator/document-upload-validator.test.js

@@ -20,7 +20,7 @@ describe('./src/dynamic-forms/validator/document-upload-validator.js', () => {
 		assert.strictEqual(Object.keys(errors).length, 0);
 	});
 
-	it('should return an error message if documents have not been uploaded', async () => {
+	it('should return default error message if documents have not been uploaded', async () => {
 		const req = {
 			body: {
 				myselfAttachments: 'W10='
@@ -33,6 +33,20 @@ describe('./src/dynamic-forms/validator/document-upload-validator.js', () => {
 		assert.strictEqual(Object.keys(errors).length, 1);
 		assert.strictEqual(errors[FIELD_NAME].msg, 'Upload an attachment');
 	});
+
+	it('should return custom error message if documents have not been uploaded', async () => {
+		const req = {
+			body: {
+				myselfAttachments: 'W10='
+			}
+		};
+		const documentUploadValidator = new DocumentUploadValidator(FIELD_NAME, 'Please ensure you upload your documents');
+
+		const errors = await _validationMappedErrors(req, documentUploadValidator);
+
+		assert.strictEqual(Object.keys(errors).length, 1);
+		assert.strictEqual(errors[FIELD_NAME].msg, 'Please ensure you upload your documents');
+	});
 });
 
 const _validationMappedErrors = async (req, validator) => {

package/types/src/validator/document-upload-validator.d.ts

@@ -1,8 +1,9 @@
 export default class DocumentUploadValidator extends BaseValidator {
     /**
      * @param {string} fieldName
+     * @param {string} errorMessage
      */
-    constructor(fieldName: string);
+    constructor(fieldName: string, errorMessage?: string);
     fieldName: string;
     validate(): import("express-validator").ValidationChain[];
 }

package/types/src/validator/document-upload-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document-upload-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/document-upload-validator.js"],"names":[],"mappings":"AAGA;IACC;;OAEG;IACH,uBAFW,MAAM,EAKhB;IADA,kBAA0B;IAG3B,0DAYC;CACD;0BAzByB,qBAAqB"}
+{"version":3,"file":"document-upload-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/document-upload-validator.js"],"names":[],"mappings":"AAGA;IACC;;;OAGG;IACH,uBAHW,MAAM,iBACN,MAAM,EAMhB;IAFA,kBAA0B;IAI3B,0DAYC;CACD;0BA3ByB,qBAAqB"}