@planning-inspectorate/data-model 1.18.1 → 1.19.0

package/.github/dependabot.yml

@@ -9,3 +9,8 @@ updates:
     directory: '/' # Location of package manifests
     schedule:
       interval: 'weekly'
+    groups:
+      devDeps: # group all dev dependencies
+        patterns:
+          - '*'
+        dependency-type: 'development'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "1.18.1",
+  "version": "1.19.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -30,8 +30,8 @@
   },
   "devDependencies": {
     "@adobe/jsonschema2md": "^8.0.3",
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "eslint": "^9.31.0",

package/schemas/commands/lpa-questionnaire-cas-advert.schema.json

@@ -0,0 +1,95 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/lpa-questionnaire-cas-advert.schema.json",
+  "title": "LPAQ cas advert submission properties",
+  "description": "Schema defining any cas advert specific properties for LPAQ submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "affectsScheduledMonument",
+    "hasProtectedSpecies",
+    "isAonbNationalLandscape",
+    "designatedSitesNames",
+    "hasStatutoryConsultees",
+    "consultedBodiesDetails",
+    "hasEmergingPlan",
+    "lpaProcedurePreference",
+    "lpaProcedurePreferenceDetails",
+    "lpaProcedurePreferenceDuration",
+    "isSiteInAreaOfSpecialControlAdverts",
+    "wasApplicationRefusedDueToHighwayOrTraffic",
+    "didAppellantSubmitCompletePhotosAndPlans"
+  ],
+  "allOf": [
+    {
+      "properties": {
+        "affectsScheduledMonument": {
+          "type": ["boolean", "null"],
+          "description": "Indicates that a scheduled monument is affected",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasProtectedSpecies": {
+          "type": ["boolean", "null"],
+          "description": "Indicates the existence of protected species",
+          "$comment": "Only available in S78 cases"
+        },
+        "isAonbNationalLandscape": {
+          "type": ["boolean", "null"],
+          "description": "Indicates an area of outstanding beauty (National Landscape)",
+          "$comment": "Only available in S78 cases"
+        },
+        "designatedSitesNames": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string",
+            "examples": ["SSSI", "cSAC", "SAC", "pSPA", "SPA", "user entered value"]
+          },
+          "description": "The designated site names",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasStatutoryConsultees": {
+          "type": ["boolean", "null"],
+          "description": "Indicates statutory consultees",
+          "$comment": "Only available in S78 cases"
+        },
+        "consultedBodiesDetails": {
+          "type": ["string", "null"],
+          "description": "The details of the bodies consulted"
+        },
+        "hasEmergingPlan": {
+          "type": ["boolean", "null"],
+          "description": "Indicates emerging plans",
+          "$comment": "Only available in S78 cases"
+        },
+        "lpaProcedurePreference": {
+          "type": ["string", "null"],
+          "enum": ["written", "hearing", "inquiry", null],
+          "description": "The procedure preference indicated by the LPA",
+          "$comment": "Only available in S78 cases"
+        },
+        "lpaProcedurePreferenceDetails": {
+          "type": ["string", "null"],
+          "description": "The procedure details preference indicated by the LPA",
+          "$comment": "Only available in S78 cases"
+        },
+        "lpaProcedurePreferenceDuration": {
+          "type": ["number", "null"],
+          "description": "The duration of enquiry indicated by the LPA",
+          "$comment": "Only available in S78 cases"
+        },
+        "isSiteInAreaOfSpecialControlAdverts": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the site is in an area of special control for adverts"
+        },
+        "wasApplicationRefusedDueToHighwayOrTraffic": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the application was refused because of highway or traffic public safety?"
+        },
+        "didAppellantSubmitCompletePhotosAndPlans": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant submitted complete and accurate photographs and plans"
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/lpa-questionnaire.schema.json

@@ -33,7 +33,9 @@
           "$comment": "Adverts + CAS Adverts - TBD - may need separate schemas",
           "allOf": [
             { "properties": { "caseType": { "enum": ["H", "ZA"] } } },
-            { "$ref": "lpa-questionnaire-common.schema.json" }
+            { "$ref": "lpa-questionnaire-common.schema.json" },
+            { "$ref": "lpa-questionnaire-has.schema.json" },
+            { "$ref": "lpa-questionnaire-cas-advert.schema.json" }
           ]
         }
       ]

package/src/schemas.d.ts

@@ -3597,6 +3597,64 @@ export interface Address {
   country?: string;
 }
 
+/**
+ * Schema defining any cas advert specific properties for LPAQ submissions
+ */
+export type LPAQCasAdvertSubmissionProperties = {
+  /**
+   * Indicates that a scheduled monument is affected
+   */
+  affectsScheduledMonument?: boolean | null;
+  /**
+   * Indicates the existence of protected species
+   */
+  hasProtectedSpecies?: boolean | null;
+  /**
+   * Indicates an area of outstanding beauty (National Landscape)
+   */
+  isAonbNationalLandscape?: boolean | null;
+  /**
+   * The designated site names
+   */
+  designatedSitesNames?: string[] | null;
+  /**
+   * Indicates statutory consultees
+   */
+  hasStatutoryConsultees?: boolean | null;
+  /**
+   * The details of the bodies consulted
+   */
+  consultedBodiesDetails?: string | null;
+  /**
+   * Indicates emerging plans
+   */
+  hasEmergingPlan?: boolean | 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;
+  /**
+   * 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;
+};
+
 /**
  * Schema defining any properties common across all appeal types for LPAQ submissions
  */
@@ -4010,6 +4068,63 @@ export type LPAQS78SubmissionProperties = {
    */
   lpaProcedurePreferenceDuration?: number | null;
 };
+/**
+ * Schema defining any cas advert specific properties for LPAQ submissions
+ */
+export type LPAQCasAdvertSubmissionProperties = {
+  /**
+   * Indicates that a scheduled monument is affected
+   */
+  affectsScheduledMonument?: boolean | null;
+  /**
+   * Indicates the existence of protected species
+   */
+  hasProtectedSpecies?: boolean | null;
+  /**
+   * Indicates an area of outstanding beauty (National Landscape)
+   */
+  isAonbNationalLandscape?: boolean | null;
+  /**
+   * The designated site names
+   */
+  designatedSitesNames?: string[] | null;
+  /**
+   * Indicates statutory consultees
+   */
+  hasStatutoryConsultees?: boolean | null;
+  /**
+   * The details of the bodies consulted
+   */
+  consultedBodiesDetails?: string | null;
+  /**
+   * Indicates emerging plans
+   */
+  hasEmergingPlan?: boolean | 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;
+  /**
+   * 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;
+};
 
 /**
  * Schema defining the data produced by the Front-Office when an LPA Questionnaire is submitted
@@ -4027,7 +4142,9 @@ export interface LPAQuestionnaireCommand {
         LPAQS78SubmissionProperties)
     | ({
         caseType?: 'H' | 'ZA';
-      } & LPAQCommonSubmissionProperties);
+      } & LPAQCommonSubmissionProperties &
+        LPAQHASSubmissionProperties &
+        LPAQCasAdvertSubmissionProperties);
   documents: {
     /**
      * The unique identifier for the document

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

@@ -49,12 +49,25 @@ const exampleAdvertQuestionnaireSchema = {
 			'ullamco quis',
 			'voluptate quis'
 		],
-		lpaCostsAppliedFor: null
+		lpaCostsAppliedFor: null,
+		affectsScheduledMonument: null,
+		hasProtectedSpecies: null,
+		isAonbNationalLandscape: null,
+		designatedSitesNames: null,
+		hasStatutoryConsultees: null,
+		consultedBodiesDetails: null,
+		hasEmergingPlan: null,
+		lpaProcedurePreference: null,
+		lpaProcedurePreferenceDetails: null,
+		lpaProcedurePreferenceDuration: null,
+		isSiteInAreaOfSpecialControlAdverts: null,
+		wasApplicationRefusedDueToHighwayOrTraffic: null,
+		didAppellantSubmitCompletePhotosAndPlans: null
 	},
 	documents: [document]
 };
 
-describe('HAS questionnaire command schema', () => {
+describe('Adverts questionnaire command schema', () => {
 	const schemas = loadAllSchemasSync();
 	const flatSchemas = Object.values(schemas).reduce((a, c) => ({ ...a, ...c }), {});
 	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
@@ -65,13 +78,6 @@ describe('HAS questionnaire command schema', () => {
 		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;

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

@@ -0,0 +1,98 @@
+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 exampleCasAdvertQuestionnaireSchema = {
+	casedata: {
+		caseType: 'ZA',
+		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,
+		affectsScheduledMonument: null,
+		hasProtectedSpecies: null,
+		isAonbNationalLandscape: null,
+		designatedSitesNames: null,
+		hasStatutoryConsultees: null,
+		consultedBodiesDetails: null,
+		hasEmergingPlan: null,
+		lpaProcedurePreference: null,
+		lpaProcedurePreferenceDetails: null,
+		lpaProcedurePreferenceDuration: null,
+		isSiteInAreaOfSpecialControlAdverts: null,
+		wasApplicationRefusedDueToHighwayOrTraffic: null,
+		didAppellantSubmitCompletePhotosAndPlans: null
+	},
+	documents: [document]
+};
+
+describe('CAS Advert 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 CAS Advert', () => {
+		const validationResult = ajv.validate(schema, exampleCasAdvertQuestionnaireSchema);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should reject missing caseReference', () => {
+		const test = structuredClone(exampleCasAdvertQuestionnaireSchema);
+		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(exampleCasAdvertQuestionnaireSchema);
+		test.test = 1;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});