@planning-inspectorate/data-model 1.17.0 → 1.18.1

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

@@ -0,0 +1,92 @@
+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 = 'lpa-questionnaire.schema.json';
+
+const document = {
+	documentId: 'deserunt sint aliqua adipisicing dolore',
+	filename: 'ut dolore',
+	originalFilename: 'Lorem amet fugiat adipisicing Excepteur',
+	size: -90476934,
+	mime: 'magna labore exercitation ut',
+	documentURI: 'ut reprehenderit',
+	dateCreated: '1933-04-03T03:24:38.0Z',
+	documentType: 'plansDrawings'
+};
+
+const exampleAdvertQuestionnaireSchema = {
+	casedata: {
+		caseType: 'H',
+		caseReference: 'nisi incididunt cillum',
+		lpaQuestionnaireSubmittedDate: null,
+		lpaStatement: 'consequat ex',
+		siteAccessDetails: null,
+		siteSafetyDetails: null,
+		isCorrectAppealType: null,
+		isGreenBelt: null,
+		inConservationArea: null,
+		newConditionDetails: 'anim sint ut aute',
+		notificationMethod: null,
+		nearbyCaseReferences: null,
+		neighbouringSiteAddresses: [
+			{
+				neighbouringSiteAddressLine1: 'commodo dolore incididunt',
+				neighbouringSiteAddressLine2: 'est voluptate irure aliqua elit',
+				neighbouringSiteAddressTown: 'labore aliquip ex incididunt nulla',
+				neighbouringSiteAddressCounty: 'enim ut Duis ut ex',
+				neighbouringSiteAddressPostcode: 'pariatur',
+				neighbouringSiteAccessDetails: 'aliqua irure mollit consequat nisi',
+				neighbouringSiteSafetyDetails: null
+			}
+		],
+		affectedListedBuildingNumbers: [
+			'occaecat id aliquip dolore',
+			'magna',
+			'minim laboris fugiat id aliqua',
+			'ullamco quis',
+			'voluptate quis'
+		],
+		lpaCostsAppliedFor: null
+	},
+	documents: [document]
+};
+
+describe('HAS questionnaire 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, exampleAdvertQuestionnaireSchema);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should allow valid schema for CAS Advert', () => {
+		const test = structuredClone(exampleAdvertQuestionnaireSchema);
+		test.casedata.caseType = 'ZA';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should reject missing caseReference', () => {
+		const test = structuredClone(exampleAdvertQuestionnaireSchema);
+		delete test.casedata.caseReference;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+		assert.strictEqual(
+			ajv.errors.some((x) => x.message === "must have required property 'caseReference'"),
+			true
+		);
+	});
+
+	it('should allow additional props', () => {
+		const test = structuredClone(exampleAdvertQuestionnaireSchema);
+		test.test = 1;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});

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

@@ -0,0 +1,188 @@
+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: 'H',
+		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,
+		isAdvertInPosition: true,
+		isSiteOnHighwayLand: true
+	},
+	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 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;
+		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: '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: '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-questionnaire.test.js

@@ -60,14 +60,14 @@ describe('HAS questionnaire command schema', () => {
 	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
 	addFormats(ajv);
 
-	it('should allow valid HAS schema', () => {
+	it('should allow valid schema for HAS', () => {
 		const validationResult = ajv.validate(schema, exampleHasQuestionnaireSchema);
 		assert.strictEqual(validationResult, true);
 	});
 
-	it('should allow HAS case without caseType', () => {
+	it('should allow valid schema for CAS planning', () => {
 		const test = structuredClone(exampleHasQuestionnaireSchema);
-		delete test.casedata.caseType;
+		test.casedata.caseType = 'ZP';
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, true);
 	});

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

@@ -45,6 +45,8 @@ const exampleHasSubmissionSchema = {
 		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,
@@ -77,11 +79,70 @@ describe('HAS submission command schema', () => {
 	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
 	addFormats(ajv);
 
-	it('should allow valid HAS schema', () => {
+	it('should allow valid schema for HAS', () => {
 		const validationResult = ajv.validate(schema, exampleHasSubmissionSchema);
 		assert.strictEqual(validationResult, true);
 	});
 
+	it('should allow valid schema for CAS planning', () => {
+		const test = structuredClone(exampleHasSubmissionSchema);
+		test.casedata.caseType = 'ZP';
+
+		const validationResult = ajv.validate(schema, test);
+
+		assert.strictEqual(validationResult, true);
+	});
+
+	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: '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: '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(exampleHasSubmissionSchema);
+			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(exampleHasSubmissionSchema);
+		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(exampleHasSubmissionSchema);
+		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(exampleHasSubmissionSchema);
+		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(exampleHasSubmissionSchema);
 		delete test.casedata.caseType;

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

@@ -71,11 +71,18 @@ describe('S78 questionnaire command schema', () => {
 	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
 	addFormats(ajv);
 
-	it('should allow valid HAS schema', () => {
+	it('should allow valid schema for S78', () => {
 		const validationResult = ajv.validate(schema, exampleS78QuestionnaireSchema);
 		assert.strictEqual(validationResult, true);
 	});
 
+	it('should allow valid schema for S20', () => {
+		const test = structuredClone(exampleS78QuestionnaireSchema);
+		test.casedata.caseType = 'Y';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
 	it('should reject missing caseReference', () => {
 		const test = structuredClone(exampleS78QuestionnaireSchema);
 		delete test.casedata.caseReference;

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

@@ -45,6 +45,8 @@ const exampleS78SubmissionSchema = {
 		siteAddressTown: 'et',
 		siteAddressCounty: 'velit',
 		siteAddressPostcode: 'nisi minim laboris sed',
+		siteGridReferenceEasting: '357144',
+		siteGridReferenceNorthing: '400534',
 		siteAccessDetails: ['laborum', 'aute velit quis', 'dolor'],
 		siteSafetyDetails: ['velit aliqua', 'qui', 'tempor Duis ut dolore', 'anim Ut in ea', 'eiusmod laborum'],
 		neighbouringSiteAddresses: null,
@@ -83,11 +85,68 @@ describe('S78 submission command schema', () => {
 	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
 	addFormats(ajv);
 
-	it('should allow valid S78 schema', () => {
+	it('should allow valid schema for S78', () => {
 		const validationResult = ajv.validate(schema, exampleS78SubmissionSchema);
 		assert.strictEqual(validationResult, true);
 	});
 
+	it('should allow valid schema for S20', () => {
+		const test = structuredClone(exampleS78SubmissionSchema);
+		test.casedata.caseType = 'Y';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
+	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: '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: '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(exampleS78SubmissionSchema);
+			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(exampleS78SubmissionSchema);
+		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(exampleS78SubmissionSchema);
+		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(exampleS78SubmissionSchema);
+		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(exampleS78SubmissionSchema);
 		delete test.casedata.caseType;