@planning-inspectorate/data-model 1.20.0 → 1.22.0

package/tests/appeals/appeal-has.test.js

@@ -80,7 +80,6 @@ const appealHas = {
 	affectsScheduledMonument: true,
 	hasProtectedSpecies: true,
 	isAonbNationalLandscape: null,
-	isSiteOnHighwayLand: null,
 	designatedSitesNames: null,
 	hasInfrastructureLevy: false,
 	isInfrastructureLevyFormallyAdopted: false,
@@ -164,11 +163,16 @@ const appealHas = {
 	siteGridReferenceEasting: '357144',
 	siteGridReferenceNorthing: '400534',
 	hasLandownersPermission: null,
-	isAdvertInPosition: false,
 	isSiteInAreaOfSpecialControlAdverts: false,
 	wasApplicationRefusedDueToHighwayOrTraffic: null,
 	didAppellantSubmitCompletePhotosAndPlans: null,
-	advertType: null
+	advertDetails: [
+		{
+			isAdvertInPosition: false,
+			isSiteOnHighwayLand: false,
+			advertType: 'Other'
+		}
+	]
 };
 
 describe(schema, () => {
@@ -187,10 +191,10 @@ describe(schema, () => {
 	it('should enforce eastings-northings pattern', () => {
 		const invalidPatterns = [
 			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },
-			{ easting: '1234567', northing: '400534', description: 'easting too long' },
+			{ easting: '12345678', northing: '400534', description: 'easting too long' },
 			{ easting: '12345', northing: '400534', description: 'easting too short' },
 			{ easting: '357144', northing: 'xyz123', description: 'northing with letters' },
-			{ easting: '357144', northing: '1234567', description: 'northing too long' },
+			{ easting: '357144', northing: '12345678', description: 'northing too long' },
 			{ easting: '357144', northing: '12345', description: 'northing too short' },
 			{ easting: '', northing: '400534', description: 'empty easting' },
 			{ easting: '357144', northing: '', description: 'empty northing' }
@@ -240,4 +244,25 @@ describe(schema, () => {
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, true);
 	});
+
+	it('should not allow custom advertType', () => {
+		const test = structuredClone(appealHas);
+		test.advertDetails[0].advertType = 'something';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
+
+	it('should not allow custom lpaProcedurePreference', () => {
+		const test = structuredClone(appealHas);
+		test.lpaProcedurePreference = 'something';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
+
+	it('should enforce required props', () => {
+		const test = structuredClone(appealHas);
+		delete test.lpaCostsAppliedFor;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
 });

package/tests/appeals/appeal-s78.test.js

@@ -153,7 +153,14 @@ const appealS78 = {
 	typeOfPlanningApplication: 'full-appeal',
 	developmentType: 'other-minor',
 	statementOfCommonGroundDueDate: '1919-10-16T12:35:55.0Z',
-	planningObligationDueDate: '1899-04-25T22:23:18.0Z'
+	planningObligationDueDate: '1899-04-25T22:23:18.0Z',
+	advertDetails: [
+		{
+			isAdvertInPosition: false,
+			isSiteOnHighwayLand: false,
+			advertType: 'Other'
+		}
+	]
 };
 
 describe(schema, () => {
@@ -171,10 +178,10 @@ describe(schema, () => {
 	it('should enforce eastings-northings pattern', () => {
 		const invalidPatterns = [
 			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },
-			{ easting: '1234567', northing: '400534', description: 'easting too long' },
+			{ easting: '12345678', northing: '400534', description: 'easting too long' },
 			{ easting: '12345', northing: '400534', description: 'easting too short' },
 			{ easting: '357144', northing: 'xyz123', description: 'northing with letters' },
-			{ easting: '357144', northing: '1234567', description: 'northing too long' },
+			{ easting: '357144', northing: '12345678', description: 'northing too long' },
 			{ easting: '357144', northing: '12345', description: 'northing too short' },
 			{ easting: '', northing: '400534', description: 'empty easting' },
 			{ easting: '357144', northing: '', description: 'empty northing' }
@@ -224,4 +231,11 @@ describe(schema, () => {
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, true);
 	});
+
+	it('should not allow custom advertType', () => {
+		const test = structuredClone(appealS78);
+		test.advertDetails[0].advertType = 'something';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
 });

package/tests/appeals/commands/adverts-questionnaire.test.js

@@ -49,6 +49,7 @@ const exampleAdvertQuestionnaireSchema = {
 			'ullamco quis',
 			'voluptate quis'
 		],
+		changedListedBuildingNumbers: ['occaecat id aliquip dolore'],
 		lpaCostsAppliedFor: null,
 		affectsScheduledMonument: null,
 		hasProtectedSpecies: null,

package/tests/appeals/commands/adverts-submission.test.js

@@ -69,8 +69,17 @@ const exampleAdvertSubmissionSchema = {
 		neighbouringSiteAddresses: null,
 		appellantCostsAppliedFor: true,
 		hasLandownersPermission: true,
-		isAdvertInPosition: true,
-		isSiteOnHighwayLand: true
+		advertDetails: [
+			{
+				isAdvertInPosition: false,
+				isSiteOnHighwayLand: false,
+				advertType: 'Other'
+			}
+		],
+		appellantProcedurePreference: 'hearing',
+		appellantProcedurePreferenceDetails: 'eiusmod ex exercitation',
+		appellantProcedurePreferenceDuration: 10816414.941069126,
+		appellantProcedurePreferenceWitnessCount: -91300569.36444478
 	},
 	documents: [document],
 	users: [user]
@@ -87,15 +96,6 @@ describe('Advert submission command schema', () => {
 		assert.strictEqual(validationResult, true);
 	});
 
-	it('should allow valid schema for CAS Advert', () => {
-		const test = structuredClone(exampleAdvertSubmissionSchema);
-		test.casedata.caseType = 'ZA';
-
-		const validationResult = ajv.validate(schema, test);
-
-		assert.strictEqual(validationResult, true);
-	});
-
 	it('should enforce advert specific props', () => {
 		const test = structuredClone(exampleAdvertSubmissionSchema);
 		delete test.casedata.hasLandownersPermission;
@@ -110,10 +110,10 @@ describe('Advert submission command schema', () => {
 	it('should enforce eastings-northings pattern', () => {
 		const invalidPatterns = [
 			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },
-			{ easting: '1234567', northing: '400534', description: 'easting too long' },
+			{ easting: '12345678', northing: '400534', description: 'easting too long' },
 			{ easting: '12345', northing: '400534', description: 'easting too short' },
 			{ easting: '357144', northing: 'xyz123', description: 'northing with letters' },
-			{ easting: '357144', northing: '1234567', description: 'northing too long' },
+			{ easting: '357144', northing: '12345678', description: 'northing too long' },
 			{ easting: '357144', northing: '12345', description: 'northing too short' },
 			{ easting: '', northing: '400534', description: 'empty easting' },
 			{ easting: '357144', northing: '', description: 'empty northing' }

package/tests/appeals/commands/cas-adverts-submission.test.js

@@ -0,0 +1,184 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert';
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
+import { loadAllSchemasSync } from '../../../src/index.js';
+
+const schema = 'appellant-submission.schema.json';
+
+const user = {
+	salutation: 'nisi aute tempor Ut',
+	firstName: null,
+	lastName: null,
+	emailAddress: null,
+	telephoneNumber: 'irure',
+	organisation: null,
+	serviceUserType: 'Appellant'
+};
+
+const document = {
+	documentId: 'Lorem',
+	filename: 'sunt',
+	originalFilename: 'dolore fugiat',
+	size: 663667,
+	mime: 'consequat veniam ipsum ullamco sint',
+	documentURI: 'reprehenderit',
+	dateCreated: '1904-04-10T14:53:32.0Z',
+	documentType: 'appellantCaseWithdrawalLetter'
+};
+
+const exampleAdvertSubmissionSchema = {
+	casedata: {
+		submissionId: '072a9b08-0266-a291-ecd0-bb0ded9d7350',
+		caseType: 'ZA',
+		caseProcedure: 'written',
+		lpaCode: 'in laborum pariatur cupidatat',
+		caseSubmittedDate: '1920-12-06T17:37:12.0Z',
+		enforcementNotice: false,
+		applicationReference: 'voluptate esse Excepteur veniam sunt',
+		applicationDate: '1921-01-26T02:05:56.0Z',
+		applicationDecision: 'not_received',
+		applicationDecisionDate: '1890-12-26T17:09:36.0Z',
+		caseSubmissionDueDate: null,
+		siteAddressLine1: 'exercitation incididunt laborum',
+		siteAddressLine2: 'in Ut voluptate ea',
+		siteAddressTown: 'Lorem amet consectetur',
+		siteAddressCounty: null,
+		siteAddressPostcode: 'sunt nulla aliquip labore',
+		siteGridReferenceEasting: '357144',
+		siteGridReferenceNorthing: '400534',
+		siteAccessDetails: null,
+		siteSafetyDetails: ['Duis laboris ex', 'sint Lorem cupidatat commodo'],
+		isGreenBelt: null,
+		siteAreaSquareMetres: -11383801.18983768,
+		floorSpaceSquareMetres: -69227017.16474937,
+		ownsAllLand: null,
+		ownsSomeLand: null,
+		knowsOtherOwners: null,
+		knowsAllOwners: null,
+		advertisedAppeal: true,
+		ownersInformed: null,
+		originalDevelopmentDescription: null,
+		changedDevelopmentDescription: false,
+		nearbyCaseReferences: [
+			'enim consectetur irure ad',
+			'irure ut',
+			'irure eiusmod minim Excepteur id',
+			'aliqua pariatur consectetur eiusmod'
+		],
+		neighbouringSiteAddresses: null,
+		appellantCostsAppliedFor: true,
+		hasLandownersPermission: true,
+		advertDetails: [
+			{
+				isAdvertInPosition: false,
+				isSiteOnHighwayLand: false,
+				advertType: 'Other'
+			}
+		]
+	},
+	documents: [document],
+	users: [user]
+};
+
+describe('Advert submission command schema', () => {
+	const schemas = loadAllSchemasSync();
+	const flatSchemas = Object.values(schemas).reduce((a, c) => ({ ...a, ...c }), {});
+	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
+	addFormats(ajv);
+
+	it('should allow valid schema for Advert', () => {
+		const validationResult = ajv.validate(schema, exampleAdvertSubmissionSchema);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should enforce advert specific props', () => {
+		const test = structuredClone(exampleAdvertSubmissionSchema);
+		delete test.casedata.hasLandownersPermission;
+		delete test.casedata.isAdvertInPosition;
+		delete test.casedata.isSiteOnHighwayLand;
+
+		const validationResult = ajv.validate(schema, test);
+
+		assert.strictEqual(validationResult, false);
+	});
+
+	it('should enforce eastings-northings pattern', () => {
+		const invalidPatterns = [
+			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },
+			{ easting: '12345678', northing: '400534', description: 'easting too long' },
+			{ easting: '12345', northing: '400534', description: 'easting too short' },
+			{ easting: '357144', northing: 'xyz123', description: 'northing with letters' },
+			{ easting: '357144', northing: '12345678', description: 'northing too long' },
+			{ easting: '357144', northing: '12345', description: 'northing too short' },
+			{ easting: '', northing: '400534', description: 'empty easting' },
+			{ easting: '357144', northing: '', description: 'empty northing' }
+		];
+
+		for (const pattern of invalidPatterns) {
+			const test = structuredClone(exampleAdvertSubmissionSchema);
+			test.casedata.siteGridReferenceEasting = pattern.easting;
+			test.casedata.siteGridReferenceNorthing = pattern.northing;
+
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, false, `Expected validation to fail for ${pattern.description}`);
+		}
+	});
+
+	it('should allow only eastings-northings', () => {
+		const test = structuredClone(exampleAdvertSubmissionSchema);
+		test.casedata.siteAddressPostcode = undefined;
+		test.casedata.siteAddressLine1 = null;
+		test.casedata.siteAddressTown = null;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should allow only site address', () => {
+		const test = structuredClone(exampleAdvertSubmissionSchema);
+		test.casedata.siteGridReferenceEasting = undefined;
+		test.casedata.siteGridReferenceNorthing = null;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should enforce either site address or easting-northing', () => {
+		const test = structuredClone(exampleAdvertSubmissionSchema);
+		test.casedata.siteAddressPostcode = undefined;
+		test.casedata.siteAddressLine1 = null;
+		test.casedata.siteAddressTown = null;
+		test.casedata.siteGridReferenceEasting = undefined;
+		test.casedata.siteGridReferenceNorthing = null;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
+
+	it('should reject missing root property', () => {
+		const test = structuredClone(exampleAdvertSubmissionSchema);
+		delete test.casedata.caseType;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+		assert.strictEqual(
+			ajv.errors.some((x) => x.message === "must have required property 'caseType'"),
+			true
+		);
+	});
+
+	it('should reject missing nested property', () => {
+		const test = structuredClone(exampleAdvertSubmissionSchema);
+		delete test.casedata.caseProcedure;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+		assert.strictEqual(
+			ajv.errors.some((x) => x.message === "must have required property 'caseProcedure'"),
+			true
+		);
+	});
+
+	it('should allow additional props', () => {
+		const test = structuredClone(exampleAdvertSubmissionSchema);
+		test.test = 1;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});

package/tests/appeals/commands/has-submission.test.js

@@ -96,10 +96,10 @@ describe('HAS submission command schema', () => {
 	it('should enforce eastings-northings pattern', () => {
 		const invalidPatterns = [
 			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },
-			{ easting: '1234567', northing: '400534', description: 'easting too long' },
+			{ easting: '12345678', northing: '400534', description: 'easting too long' },
 			{ easting: '12345', northing: '400534', description: 'easting too short' },
 			{ easting: '357144', northing: 'xyz123', description: 'northing with letters' },
-			{ easting: '357144', northing: '1234567', description: 'northing too long' },
+			{ easting: '357144', northing: '12345678', description: 'northing too long' },
 			{ easting: '357144', northing: '12345', description: 'northing too short' },
 			{ easting: '', northing: '400534', description: 'empty easting' },
 			{ easting: '357144', northing: '', description: 'empty northing' }

package/tests/appeals/commands/s78-submission.test.js

@@ -100,10 +100,10 @@ describe('S78 submission command schema', () => {
 	it('should enforce eastings-northings pattern', () => {
 		const invalidPatterns = [
 			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },
-			{ easting: '1234567', northing: '400534', description: 'easting too long' },
+			{ easting: '1234567*', northing: '400534', description: 'easting too long' },
 			{ easting: '12345', northing: '400534', description: 'easting too short' },
 			{ easting: '357144', northing: 'xyz123', description: 'northing with letters' },
-			{ easting: '357144', northing: '1234567', description: 'northing too long' },
+			{ easting: '357144', northing: '12345678', description: 'northing too long' },
 			{ easting: '357144', northing: '12345', description: 'northing too short' },
 			{ easting: '', northing: '400534', description: 'empty easting' },
 			{ easting: '357144', northing: '', description: 'empty northing' }

package/schemas/commands/appeal-advert.submission.schema.json

@@ -1,23 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/appeal-advert.submission.schema.json",
-  "title": "Advert specific properties",
-  "description": "Schema defining any properties for advertisement appeals",
-  "type": "object",
-  "additionalProperties": true,
-  "required": ["isSiteOnHighwayLand", "isAdvertInPosition", "hasLandownersPermission"],
-  "properties": {
-    "hasLandownersPermission": {
-      "type": ["boolean", "null"],
-      "description": "Indicates if the appellant has land owners permission"
-    },
-    "isAdvertInPosition": {
-      "type": ["boolean", "null"],
-      "description": "Indicates if the advert is already in position"
-    },
-    "isSiteOnHighwayLand": {
-      "type": ["boolean", "null"],
-      "description": "Indicates if site is on highway land"
-    }
-  }
-}