@planning-inspectorate/data-model 2.10.2 → 2.11.0

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

@@ -161,7 +161,12 @@ const appealS78 = {
 			advertType: 'Other'
 		}
 	],
-	padsSapId: null
+	padsSapId: null,
+	applicationMadeUnderActSection: 'existing-development',
+	siteUseAtTimeOfApplication: 'Site use at time of application',
+	appealUnderActSection: 'proposed-use-of-a-development',
+	lpaConsiderAppealInvalid: true,
+	lpaAppealInvalidReasons: 'Reason(s) why LPA consider the appeal invalid'
 };
 
 describe(schema, () => {
@@ -239,4 +244,14 @@ describe(schema, () => {
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, false);
 	});
+
+	const groupBAppealTypes = ['C', 'F', 'H', 'W', 'X', 'Y', 'Z'];
+	groupBAppealTypes.forEach((appealType) => {
+		it(`should support group B appeal type ${appealType}`, () => {
+			const test = structuredClone(appealS78);
+			test.caseType = appealType;
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, true);
+		});
+	});
 });

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

@@ -0,0 +1,83 @@
+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 exampleHasQuestionnaireSchema = {
+	casedata: {
+		caseType: 'X',
+		caseReference: 'nisi incididunt cillum',
+		lpaQuestionnaireSubmittedDate: '2026-04-03T03:24:38.0Z',
+		siteAccessDetails: ['test'],
+		siteSafetyDetails: ['test 2'],
+		isCorrectAppealType: true,
+		nearbyCaseReferences: ['1234567', '7654321'],
+		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
+			}
+		],
+		reasonForNeighbourVisits: 'adipisicing in voluptate',
+		hasInfrastructureLevy: true,
+		isInfrastructureLevyFormallyAdopted: true,
+		infrastructureLevyAdoptedDate: '1913-06-14T10:40:33.0Z',
+		infrastructureLevyExpectedDate: '1912-06-14T10:40:33.0Z',
+		lpaProcedurePreference: 'inquiry',
+		lpaProcedurePreferenceDetails: 'in reprehenderit',
+		lpaProcedurePreferenceDuration: -34480053.16630782,
+		appealUnderActSection: 'proposed-use-of-a-development',
+		lpaConsiderAppealInvalid: true,
+		lpaAppealInvalidReasons: 'Reason(s) why LPA consider the appeal invalid'
+	},
+	documents: [document]
+};
+
+describe('LDC 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 LDC', () => {
+		const validationResult = ajv.validate(schema, exampleHasQuestionnaireSchema);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should reject missing caseReference', () => {
+		const test = structuredClone(exampleHasQuestionnaireSchema);
+		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(exampleHasQuestionnaireSchema);
+		test.test = 1;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});

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

@@ -0,0 +1,172 @@
+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 exampleLDCSubmissionSchema = {
+	casedata: {
+		submissionId: '072a9b08-0266-a291-ecd0-bb0ded9d7350',
+		caseType: 'X',
+		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,
+		originalDevelopmentDescription: null,
+		changedDevelopmentDescription: false,
+		nearbyCaseReferences: [
+			'enim consectetur irure ad',
+			'irure ut',
+			'irure eiusmod minim Excepteur id',
+			'aliqua pariatur consectetur eiusmod'
+		],
+		appellantCostsAppliedFor: true,
+		appellantProcedurePreference: 'hearing',
+		appellantProcedurePreferenceDetails: 'eiusmod ex exercitation',
+		appellantProcedurePreferenceDuration: 10816414.941069126,
+		appellantProcedurePreferenceWitnessCount: -91300569.36444478,
+		siteUseAtTimeOfApplication: 'residential',
+		applicationMadeUnderActSection: 'existing-development'
+	},
+	documents: [document],
+	users: [user]
+};
+
+describe('LDC 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 LDC', () => {
+		const validationResult = ajv.validate(schema, exampleLDCSubmissionSchema);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should enforce LDC specific props', () => {
+		const test = structuredClone(exampleLDCSubmissionSchema);
+		delete test.casedata.siteUseAtTimeOfApplication;
+		delete test.casedata.applicationMadeUnderActSection;
+
+		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(exampleLDCSubmissionSchema);
+			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(exampleLDCSubmissionSchema);
+		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(exampleLDCSubmissionSchema);
+		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(exampleLDCSubmissionSchema);
+		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(exampleLDCSubmissionSchema);
+		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(exampleLDCSubmissionSchema);
+		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(exampleLDCSubmissionSchema);
+		test.test = 1;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});

package/schemas/commands/appeals-components/appeal-has-submission.schema.json

@@ -1,81 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/appeals-components/appeal-has-submission.schema.json",
-  "title": "Appellant HAS submission properties",
-  "description": "Schema defining any HAS specific properties for appeal submissions",
-  "type": "object",
-  "additionalProperties": true,
-  "required": [
-    "isGreenBelt",
-    "siteAreaSquareMetres",
-    "floorSpaceSquareMetres",
-    "ownsAllLand",
-    "ownsSomeLand",
-    "knowsOtherOwners",
-    "knowsAllOwners",
-    "advertisedAppeal",
-    "ownersInformed",
-    "originalDevelopmentDescription",
-    "changedDevelopmentDescription",
-    "appellantCostsAppliedFor"
-  ],
-  "allOf": [
-    {
-      "properties": {
-        "isGreenBelt": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the site is in a green belt"
-        },
-        "siteAreaSquareMetres": {
-          "type": ["number", "null"],
-          "examples": [45.7],
-          "description": "The site area, in square meters"
-        },
-        "floorSpaceSquareMetres": {
-          "type": ["number", "null"],
-          "examples": [3.5],
-          "description": "The floor space, in square meters"
-        },
-        "ownsAllLand": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has complete ownership of the site"
-        },
-        "ownsSomeLand": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has partial ownership of the site"
-        },
-        "knowsOtherOwners": {
-          "type": ["string", "null"],
-          "enum": ["Yes", "No", "Some", null],
-          "description": "Indicates if the appellant knows other owners of the site"
-        },
-        "knowsAllOwners": {
-          "type": ["string", "null"],
-          "enum": ["Yes", "No", "Some", null],
-          "description": "Indicates if the appellant knows all owners of the site"
-        },
-        "advertisedAppeal": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has advertised the appeal to the LPA decision"
-        },
-        "ownersInformed": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has informed other owners of the site"
-        },
-        "originalDevelopmentDescription": {
-          "type": ["string", "null"],
-          "examples": ["Replacement of an existing gate to access the property"],
-          "description": "The original description of the development, as provided by the appellant"
-        },
-        "changedDevelopmentDescription": {
-          "type": ["boolean", "null"],
-          "description": "Indicates that the LPA has changed the development description"
-        },
-        "appellantCostsAppliedFor": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has applied for costs"
-        }
-      }
-    }
-  ]
-}