@planning-inspectorate/dynamic-forms 2.0.2 → 2.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/Planning-Inspectorate/dynamic-forms.git"
   },
   "scripts": {
-    "commitlint": "commitlint --from=$(git cherry origin/main | head -n 1 | cut -c 3-)",
+    "commitlint": "commitlint --from=$(git rev-parse $(git cherry origin/main | head -n 1 | cut -c 3-)^1)",
     "lint": "npx eslint .",
     "format": "prettier --write .",
     "format-check": "prettier --check .",

package/src/validator/address-validator.js

@@ -21,8 +21,8 @@ export const townCityMaxLength = 250;
 export const townCityMinLength = 0;
 export const countyMaxLength = 250;
 export const countyMinLength = 0;
-export const postcodeMaxLength = 10;
-export const postcodeMinLength = 1;
+export const postcodeMaxLength = 8;
+export const postcodeMinLength = 5;
 
 /**
  * enforces address fields are within allowed parameters
@@ -143,7 +143,7 @@ export default class AddressValidator extends BaseValidator {
 		return validator
 			.isLength({ min: postcodeMinLength, max: postcodeMaxLength })
 			.bail()
-			.withMessage(`Postcode must be less than ${postcodeMaxLength} characters`)
+			.withMessage(`Postcode must be between ${postcodeMinLength} and ${postcodeMaxLength} characters`)
 			.custom((postcode) => {
 				return validatePostcode(postcode);
 			});

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

@@ -6,6 +6,7 @@ import AddressValidator, {
 	addressLine1MaxLength,
 	addressLine2MaxLength,
 	postcodeMaxLength,
+	postcodeMinLength,
 	townCityMaxLength
 } from './address-validator.js';
 
@@ -107,7 +108,90 @@ describe('AddressValidator', () => {
 			`Address line 2 must be ${addressLine2MaxLength} characters or less`
 		);
 		assert.strictEqual(errors.testField_townCity.msg, `Town or city must be ${townCityMaxLength} characters or less`);
-		assert.strictEqual(errors.testField_postcode.msg, `Postcode must be less than ${postcodeMaxLength} characters`);
+		assert.strictEqual(
+			errors.testField_postcode.msg,
+			`Postcode must be between ${postcodeMinLength} and ${postcodeMaxLength} characters`
+		);
+	});
+	it('should validate a valid 8-character postcode without errors', async () => {
+		const question = {
+			fieldName: 'testField'
+		};
+
+		const req = {
+			body: {
+				testField_addressLine1: 'A Building',
+				testField_addressLine2: 'A Street',
+				testField_townCity: 'Test town',
+				testField_postcode: 'DN55 1PT'
+			}
+		};
+
+		const errors = await _validationMappedErrors(req, question);
+
+		assert.deepStrictEqual(errors, {});
+	});
+	// New postcode tests
+	it('should validate a valid 5-character postcode without a space', async () => {
+		const question = { fieldName: 'testField' };
+		const req = {
+			body: {
+				testField_addressLine1: 'A Building',
+				testField_addressLine2: 'A Street',
+				testField_townCity: 'Test town',
+				testField_postcode: 'M11AA'
+			}
+		};
+		const errors = await _validationMappedErrors(req, question);
+		assert.deepStrictEqual(errors, {});
+	});
+
+	it('should reject a postcode with multiple spaces', async () => {
+		const question = { fieldName: 'testField' };
+		const req = {
+			body: {
+				testField_addressLine1: 'A Building',
+				testField_addressLine2: 'A Street',
+				testField_townCity: 'Test town',
+				testField_postcode: 'AB1  2CD'
+			}
+		};
+		const errors = await _validationMappedErrors(req, question);
+		assert.strictEqual(errors.testField_postcode.msg, 'Enter a valid postcode');
+	});
+
+	it('should reject a postcode shorter than 5 characters', async () => {
+		const question = { fieldName: 'testField' };
+		const req = {
+			body: {
+				testField_addressLine1: 'A Building',
+				testField_addressLine2: 'A Street',
+				testField_townCity: 'Test town',
+				testField_postcode: 'A1 1'
+			}
+		};
+		const errors = await _validationMappedErrors(req, question);
+		assert.strictEqual(
+			errors.testField_postcode.msg,
+			`Postcode must be between ${postcodeMinLength} and ${postcodeMaxLength} characters`
+		);
+	});
+
+	it('should reject a postcode longer than 8 characters', async () => {
+		const question = { fieldName: 'testField' };
+		const req = {
+			body: {
+				testField_addressLine1: 'A Building',
+				testField_addressLine2: 'A Street',
+				testField_townCity: 'Test town',
+				testField_postcode: 'DN55 1PTA'
+			}
+		};
+		const errors = await _validationMappedErrors(req, question);
+		assert.strictEqual(
+			errors.testField_postcode.msg,
+			`Postcode must be between ${postcodeMinLength} and ${postcodeMaxLength} characters`
+		);
 	});
 });