@planning-inspectorate/data-model 1.16.0 → 1.17.0

package/src/schemas.d.ts

@@ -301,9 +301,29 @@ export interface AppealEvent {
 }
 
 /**
- * Schema defining the metadata for an appeal
+ * Group A - Schema defining the metadata for an appeal
  */
-export interface AppealHASCase {
+export type AppealHASCase = (
+  | {
+      siteGridReferenceEasting: {
+        [k: string]: unknown;
+      };
+      siteGridReferenceNorthing: {
+        [k: string]: unknown;
+      };
+    }
+  | {
+      siteAddressLine1: {
+        [k: string]: unknown;
+      };
+      siteAddressTown: {
+        [k: string]: unknown;
+      };
+      siteAddressPostcode: {
+        [k: string]: unknown;
+      };
+    }
+) & {
   /**
    * Internal case identifier
    */
@@ -504,23 +524,23 @@ export interface AppealHASCase {
   /**
    * First line of address for the appeal site
    */
-  siteAddressLine1: string;
+  siteAddressLine1?: string | null;
   /**
    * Second line of address for the appeal site
    */
-  siteAddressLine2: string | null;
+  siteAddressLine2?: string | null;
   /**
    * Town / City of the site address
    */
-  siteAddressTown: string;
+  siteAddressTown?: string | null;
   /**
    * County of the site address
    */
-  siteAddressCounty: string | null;
+  siteAddressCounty?: string | null;
   /**
    * Postal code of the site address
    */
-  siteAddressPostcode: string;
+  siteAddressPostcode?: string | null;
   /**
    * Provided information on site accessibility
    */
@@ -549,6 +569,90 @@ export interface AppealHASCase {
    * Indicates if the site is in a conservation area
    */
   inConservationArea: boolean | null;
+  /**
+   * Indicates if the development affects a scheduled monument
+   */
+  affectsScheduledMonument?: boolean | null;
+  /**
+   * Indicates if the site hosts protected species
+   */
+  hasProtectedSpecies?: boolean | null;
+  /**
+   * Indicates an area of outstanding beauty (National Landscape)
+   */
+  isAonbNationalLandscape?: boolean | null;
+  /**
+   * Indicates if site is on highway land
+   */
+  isSiteOnHighwayLand?: boolean | null;
+  /**
+   * The designated site names
+   */
+  designatedSitesNames?: string[] | null;
+  /**
+   * Indicates the existence of an infrastructure levy
+   */
+  hasInfrastructureLevy?: boolean | null;
+  /**
+   * Indicates if the infrastructure levy is formally adopted
+   */
+  isInfrastructureLevyFormallyAdopted?: boolean | null;
+  /**
+   * The date of the infrastructure levy adoption
+   */
+  infrastructureLevyAdoptedDate?: string | null;
+  /**
+   * The expected date of the infrastructure levy
+   */
+  infrastructureLevyExpectedDate?: string | null;
+  /**
+   * The procedure preference indicated by the LPA
+   */
+  lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
+  /**
+   * The procedure details preference indicated by the LPA
+   */
+  lpaProcedurePreferenceDetails?: string | null;
+  /**
+   * The duration of enquiry indicated by the LPA
+   */
+  lpaProcedurePreferenceDuration?: number | null;
+  /**
+   * TBC
+   */
+  caseworkReason?: string | null;
+  /**
+   * Information relevant to case...
+   */
+  importantInformation?: string | null;
+  /**
+   * Under whose jurisdiction the decision falls
+   */
+  jurisdiction?: string | null;
+  /**
+   * Has the case been selected for redetermination
+   */
+  redeterminedIndicator?: boolean | null;
+  /**
+   * The date that the costs report was sent
+   */
+  dateCostsReportDespatched?: string | null;
+  /**
+   * The date that is TBC
+   */
+  dateNotRecoveredOrDerecovered?: string | null;
+  /**
+   * The date that case was recovered
+   */
+  dateRecovered?: string | null;
+  /**
+   * The original case decision date
+   */
+  originalCaseDecisionDate?: string | null;
+  /**
+   * The target date for case completion
+   */
+  targetDate?: string | null;
   /**
    * Indicates if the appellant has complete ownership of the site
    */
@@ -656,8 +760,31 @@ export interface AppealHASCase {
     | 'minor-commercial-development'
     | 'advertisement'
     | null;
+  siteGridReferenceEasting?: string | null;
+  siteGridReferenceNorthing?: string | null;
+  /**
+   * Indicates if the appellant has land owners permission
+   */
+  hasLandownersPermission?: boolean | null;
+  /**
+   * Indicates if the advert is already in position
+   */
+  isAdvertInPosition?: boolean | null;
+  /**
+   * Indicates if the site is in an area of special control for adverts
+   */
+  isSiteInAreaOfSpecialControlAdverts?: boolean | null;
+  /**
+   * Indicates if the application was refused because of highway or traffic public safety?
+   */
+  wasApplicationRefusedDueToHighwayOrTraffic?: boolean | null;
+  /**
+   * Indicates if the appellant submitted complete and accurate photographs and plans
+   */
+  didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
+  advertType?: string | null;
   [k: string]: unknown;
-}
+};
 
 /**
  * Schema defining the metadata for appeal representations, such as statements, third-party comments and final comments
@@ -746,9 +873,29 @@ export interface AppealRepresentation {
 }
 
 /**
- * Schema defining the metadata for an appeal (S78)
+ * Group B - Schema defining the metadata for an appeal
  */
-export interface AppealS78Case {
+export type AppealS78Case = (
+  | {
+      siteGridReferenceEasting: {
+        [k: string]: unknown;
+      };
+      siteGridReferenceNorthing: {
+        [k: string]: unknown;
+      };
+    }
+  | {
+      siteAddressLine1: {
+        [k: string]: unknown;
+      };
+      siteAddressTown: {
+        [k: string]: unknown;
+      };
+      siteAddressPostcode: {
+        [k: string]: unknown;
+      };
+    }
+) & {
   /**
    * Internal case identifier
    */
@@ -953,23 +1100,23 @@ export interface AppealS78Case {
   /**
    * First line of address for the appeal site
    */
-  siteAddressLine1: string;
+  siteAddressLine1?: string | null;
   /**
    * Second line of address for the appeal site
    */
-  siteAddressLine2: string | null;
+  siteAddressLine2?: string | null;
   /**
    * Town / City of the site address
    */
-  siteAddressTown: string;
+  siteAddressTown?: string | null;
   /**
    * County of the site address
    */
-  siteAddressCounty: string | null;
+  siteAddressCounty?: string | null;
   /**
    * Postal code of the site address
    */
-  siteAddressPostcode: string;
+  siteAddressPostcode?: string | null;
   /**
    * Provided information on site accessibility
    */
@@ -1271,8 +1418,8 @@ export interface AppealS78Case {
    * The net gain in residences of the proposed development
    */
   numberOfResidencesNetChange: number | null;
-  siteGridReferenceEasting: string | null;
-  siteGridReferenceNorthing: string | null;
+  siteGridReferenceEasting?: string | null;
+  siteGridReferenceNorthing?: string | null;
   siteViewableFromRoad: boolean | null;
   siteWithinSSSI: boolean | null;
   typeOfPlanningApplication:
@@ -1306,7 +1453,7 @@ export interface AppealS78Case {
   statementOfCommonGroundDueDate?: string | null;
   planningObligationDueDate?: string | null;
   [k: string]: unknown;
-}
+};
 
 /**
  * Schema defining the data returned by the DaRT API

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

@@ -0,0 +1,243 @@
+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 = 'appeal-has.schema.json';
+
+const appealHas = {
+	caseId: null,
+	caseReference: 'mollit dolore dolor non culpa',
+	submissionId: null,
+	caseStatus: 'ready_to_start',
+	caseType: 'ZP',
+	caseProcedure: 'inquiry',
+	lpaCode: 'nulla',
+	caseOfficerId: null,
+	inspectorId: 'mollit in ullamco Excepteur commodo',
+	allocationLevel: 'D',
+	allocationBand: 1,
+	caseSpecialisms: ['et culpa elit labore', 'minim Lorem'],
+	caseSubmittedDate: '1954-03-03T08:10:46.0Z',
+	caseCreatedDate: '1945-04-11T07:49:09.0Z',
+	caseUpdatedDate: '1943-02-10T21:16:10.0Z',
+	caseValidDate: '1902-04-09T20:34:25.0Z',
+	caseValidationDate: null,
+	caseValidationOutcome: 'invalid',
+	caseValidationInvalidDetails: null,
+	caseValidationIncompleteDetails: [
+		'occaecat dolor labore ut ipsum',
+		'eiusmod ullamco pariatur aliqua esse',
+		'eiusmod Ut officia',
+		'aute',
+		'do minim sint labore aliquip'
+	],
+	caseExtensionDate: null,
+	caseStartedDate: null,
+	casePublishedDate: null,
+	linkedCaseStatus: null,
+	leadCaseReference: null,
+	lpaQuestionnaireDueDate: null,
+	lpaQuestionnaireSubmittedDate: null,
+	lpaQuestionnaireCreatedDate: '1916-11-15T14:22:37.0Z',
+	lpaQuestionnairePublishedDate: '1895-10-01T01:14:29.0Z',
+	lpaQuestionnaireValidationOutcome: 'incomplete',
+	lpaQuestionnaireValidationOutcomeDate: '1927-05-30T20:34:18.0Z',
+	lpaQuestionnaireValidationDetails: ['dolore cillum in anim adipisicing'],
+	lpaStatement: 'Ut ipsum et',
+	caseWithdrawnDate: '1926-02-11T13:40:53.0Z',
+	caseTransferredDate: '1923-01-28T02:09:32.0Z',
+	transferredCaseClosedDate: '1893-02-13T14:37:27.0Z',
+	caseDecisionOutcomeDate: '1920-07-08T09:20:22.0Z',
+	caseDecisionPublishedDate: null,
+	caseDecisionOutcome: 'dismissed',
+	caseCompletedDate: '1895-12-07T15:44:32.0Z',
+	enforcementNotice: null,
+	applicationReference: 'eu',
+	applicationDate: '1949-08-25T15:11:02.0Z',
+	applicationDecision: 'refused',
+	applicationDecisionDate: '1952-08-09T01:03:51.0Z',
+	caseSubmissionDueDate: '1942-02-09T21:03:07.0Z',
+	siteAddressLine1: 'ullamco',
+	siteAddressLine2: null,
+	siteAddressTown: 'dolor reprehenderit ut',
+	siteAddressCounty: 'dolore eu exercitation enim',
+	siteAddressPostcode: 'est',
+	siteAccessDetails: [
+		'Ut',
+		'eiusmod magna aliqua ipsum',
+		'sit non ut amet aliqua',
+		'id consectetur cupidatat',
+		'incididunt ut Lorem eu'
+	],
+	siteSafetyDetails: null,
+	siteAreaSquareMetres: 74995933.47978675,
+	floorSpaceSquareMetres: null,
+	isCorrectAppealType: null,
+	isGreenBelt: true,
+	inConservationArea: null,
+	affectsScheduledMonument: true,
+	hasProtectedSpecies: true,
+	isAonbNationalLandscape: null,
+	isSiteOnHighwayLand: null,
+	designatedSitesNames: null,
+	hasInfrastructureLevy: false,
+	isInfrastructureLevyFormallyAdopted: false,
+	infrastructureLevyAdoptedDate: null,
+	infrastructureLevyExpectedDate: null,
+	lpaProcedurePreference: null,
+	lpaProcedurePreferenceDetails: null,
+	lpaProcedurePreferenceDuration: -42778389.82228377,
+	caseworkReason: 'elit reprehenderit',
+	importantInformation: null,
+	jurisdiction: null,
+	redeterminedIndicator: null,
+	dateCostsReportDespatched: '1918-01-30T08:43:51.0Z',
+	dateNotRecoveredOrDerecovered: '1950-02-18T19:15:57.0Z',
+	dateRecovered: '1962-01-16T13:45:38.0Z',
+	originalCaseDecisionDate: null,
+	targetDate: null,
+	ownsAllLand: true,
+	ownsSomeLand: null,
+	knowsOtherOwners: 'Some',
+	knowsAllOwners: null,
+	advertisedAppeal: null,
+	notificationMethod: null,
+	ownersInformed: null,
+	originalDevelopmentDescription: null,
+	changedDevelopmentDescription: null,
+	newConditionDetails: 'tempor anim adipisicing',
+	nearbyCaseReferences: null,
+	neighbouringSiteAddresses: [
+		{
+			neighbouringSiteAddressLine1: 'eu veniam',
+			neighbouringSiteAddressLine2: null,
+			neighbouringSiteAddressTown: 'pariatur dolore',
+			neighbouringSiteAddressCounty: 'fugiat minim anim aliqua aliquip',
+			neighbouringSiteAddressPostcode: 'ex anim',
+			neighbouringSiteAccessDetails: null,
+			neighbouringSiteSafetyDetails: 'veniam in sunt'
+		},
+		{
+			neighbouringSiteAddressLine1: 'et adipisicing dolore',
+			neighbouringSiteAddressLine2: null,
+			neighbouringSiteAddressTown: 'cupidatat dolore',
+			neighbouringSiteAddressCounty: null,
+			neighbouringSiteAddressPostcode: 'cupidatat voluptate esse ad amet',
+			neighbouringSiteAccessDetails: 'labore',
+			neighbouringSiteSafetyDetails: 'deserunt fugiat'
+		},
+		{
+			neighbouringSiteAddressLine1: 'esse in pariatur mollit',
+			neighbouringSiteAddressLine2: 'ad aliquip in',
+			neighbouringSiteAddressTown: 'ullamco',
+			neighbouringSiteAddressCounty: 'ut aute',
+			neighbouringSiteAddressPostcode: 'Lorem nostrud ipsum aliquip',
+			neighbouringSiteAccessDetails: 'dolore irure nisi',
+			neighbouringSiteSafetyDetails: 'ex'
+		},
+		{
+			neighbouringSiteAddressLine1: 'est pariatur Lorem minim in',
+			neighbouringSiteAddressLine2: 'Ut',
+			neighbouringSiteAddressTown: 'eiusmod minim nostrud Excepteur nulla',
+			neighbouringSiteAddressCounty: 'officia',
+			neighbouringSiteAddressPostcode: 'non deserunt',
+			neighbouringSiteAccessDetails: null,
+			neighbouringSiteSafetyDetails: 'culpa occaecat'
+		},
+		{
+			neighbouringSiteAddressLine1: 'minim cillum eu tempor et',
+			neighbouringSiteAddressLine2: 'non adipisicing nisi in dolore',
+			neighbouringSiteAddressTown: 'irure in',
+			neighbouringSiteAddressCounty: null,
+			neighbouringSiteAddressPostcode: 'commodo in et Excepteur',
+			neighbouringSiteAccessDetails: null,
+			neighbouringSiteSafetyDetails: 'ex pariatur enim ipsum voluptate'
+		}
+	],
+	reasonForNeighbourVisits: null,
+	affectedListedBuildingNumbers: ['Excepteur', 'in consequat sit', 'esse sunt velit culpa', 'voluptate esse'],
+	appellantCostsAppliedFor: null,
+	lpaCostsAppliedFor: null,
+	typeOfPlanningApplication: 'householder-planning',
+	siteGridReferenceEasting: '357144',
+	siteGridReferenceNorthing: '400534',
+	hasLandownersPermission: null,
+	isAdvertInPosition: false,
+	isSiteInAreaOfSpecialControlAdverts: false,
+	wasApplicationRefusedDueToHighwayOrTraffic: null,
+	didAppellantSubmitCompletePhotosAndPlans: null,
+	advertType: null
+};
+
+describe(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', () => {
+		const test = structuredClone(appealHas);
+
+		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(appealHas);
+			test.siteGridReferenceEasting = pattern.easting;
+			test.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(appealHas);
+		test.siteAddressPostcode = undefined;
+		test.siteAddressLine1 = null;
+		test.siteAddressTown = null;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should allow only site address', () => {
+		const test = structuredClone(appealHas);
+		test.siteGridReferenceEasting = undefined;
+		test.siteGridReferenceNorthing = null;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should enforce either site address or easting-northing', () => {
+		const test = structuredClone(appealHas);
+		test.siteAddressPostcode = undefined;
+		test.siteAddressLine1 = null;
+		test.siteAddressTown = null;
+		test.siteGridReferenceEasting = undefined;
+		test.siteGridReferenceNorthing = null;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
+
+	it('should allow additional props', () => {
+		const test = structuredClone(appealHas);
+		test.test = 1; // additional unknown prop allowed
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});