@planning-inspectorate/data-model 2.7.0 → 2.9.0

package/src/schemas.d.ts

@@ -145,6 +145,14 @@ export interface AppealDocument {
     | 'environmentalAssessment'
     | 'appealNotification'
     | 'historicEnglandConsultation'
+    | 'stopNotice'
+    | 'article4Direction'
+    | 'enforcementList'
+    | 'localDevelopmentOrder'
+    | 'planningPermission'
+    | 'lpaEnforcementNotice'
+    | 'lpaEnforcementNoticePlan'
+    | 'planningContraventionNotice'
     | null;
   /**
    * The system mastering the metadata for the current document
@@ -4235,45 +4243,89 @@ export type LPAQHASSubmissionProperties = {
  */
 export type LPAQS78SubmissionProperties = {
   /**
-   * A list of changed listed building IDs from Historic England
+   * Indicates that a scheduled monument is affected
    */
-  changedListedBuildingNumbers?: string[] | null;
+  affectsScheduledMonument?: boolean | null;
   /**
-   * A grant or loan has been made to preserve the listed building
+   * Indicates a TPO (tree preservation order)
    */
-  preserveGrantLoan?: boolean | null;
+  hasTreePreservationOrder?: boolean | null;
   /**
-   * Are Historic England to be consulted?
+   * Indicates a PROW (public right of way)
    */
-  consultHistoricEngland?: boolean | null;
+  isPublicRightOfWay?: boolean | null;
   /**
-   * Indicates that a scheduled monument is affected
+   * Indicates statutory consultees
    */
-  affectsScheduledMonument?: boolean | null;
+  hasStatutoryConsultees?: boolean | null;
   /**
-   * Indicates the existence of protected species
+   * The details of the bodies consulted
    */
-  hasProtectedSpecies?: boolean | null;
+  consultedBodiesDetails?: string | null;
   /**
-   * Indicates an area of outstanding beauty (National Landscape)
+   * Indicates consultation responses
    */
-  isAonbNationalLandscape?: boolean | null;
+  hasConsultationResponses?: boolean | null;
   /**
-   * The designated site names
+   * Indicates emerging plans
    */
-  designatedSitesNames?: string[] | null;
+  hasEmergingPlan?: boolean | null;
   /**
-   * Indicates a TPO (tree preservation order)
+   * Indicates supplementary planning documents
    */
-  hasTreePreservationOrder?: boolean | null;
+  hasSupplementaryPlanningDocs?: boolean | null;
+};
+/**
+ * Schema defining LPA procedure preference properties
+ */
+export type LPAProcedurePreferenceProperties = {
   /**
-   * Indicates a traveller site
+   * The procedure preference indicated by the LPA
    */
-  isGypsyOrTravellerSite?: boolean | null;
+  lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
   /**
-   * Indicates a PROW (public right of way)
+   * The procedure details preference indicated by the LPA
    */
-  isPublicRightOfWay?: boolean | null;
+  lpaProcedurePreferenceDetails?: string | null;
+  /**
+   * The duration of enquiry indicated by the LPA
+   */
+  lpaProcedurePreferenceDuration?: number | null;
+};
+/**
+ * Schema defining changed-listed-building-numbers
+ */
+export type ChangedListedBuildingNumbersProperties = {
+  /**
+   * A list of changed listed building IDs from Historic England
+   */
+  changedListedBuildingNumbers?: string[] | null;
+};
+/**
+ * Schema defining infrastructure levy properties
+ */
+export type InfrastructureLevyProperties = {
+  /**
+   * 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;
+};
+/**
+ * Schema defining environmental impact assessment properties
+ */
+export type EnvironmentalImpactAssessmentProperties = {
   /**
    * The impact schedule from EIA
    */
@@ -4316,68 +4368,31 @@ export type LPAQS78SubmissionProperties = {
    * EIA completed environmental statement required
    */
   eiaCompletedEnvironmentalStatement?: boolean | null;
-  /**
-   * Indicates statutory consultees
-   */
-  hasStatutoryConsultees?: boolean | null;
-  /**
-   * The details of the bodies consulted
-   */
-  consultedBodiesDetails?: string | null;
-  /**
-   * Indicates consultation responses
-   */
-  hasConsultationResponses?: boolean | null;
-  /**
-   * Indicates emerging plans
-   */
-  hasEmergingPlan?: boolean | null;
-  /**
-   * Indicates supplementary planning documents
-   */
-  hasSupplementaryPlanningDocs?: boolean | 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;
 };
 /**
- * Schema defining LPA procedure preference properties
+ * Schema defining site designations and protection specific properties
  */
-export type LPAProcedurePreferenceProperties = {
+export type SiteDesignationsAndProtectionSpecificProperties = {
   /**
-   * The procedure preference indicated by the LPA
+   * Indicates that a scheduled monument is affected
    */
-  lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
+  affectsScheduledMonument?: boolean | null;
   /**
-   * The procedure details preference indicated by the LPA
+   * Indicates the existence of protected species
    */
-  lpaProcedurePreferenceDetails?: string | null;
+  hasProtectedSpecies?: boolean | null;
   /**
-   * The duration of enquiry indicated by the LPA
+   * Indicates an area of outstanding beauty (National Landscape)
    */
-  lpaProcedurePreferenceDuration?: number | null;
-};
-/**
- * Schema defining changed-listed-building-numbers
- */
-export type ChangedListedBuildingNumbersProperties = {
+  isAonbNationalLandscape?: boolean | null;
   /**
-   * A list of changed listed building IDs from Historic England
+   * The designated site names
    */
-  changedListedBuildingNumbers?: string[] | null;
+  designatedSitesNames?: string[] | null;
+  /**
+   * Indicates a traveller site
+   */
+  isGypsyOrTravellerSite?: boolean | null;
 };
 /**
  * Schema defining any advert specific properties for LPAQ submissions
@@ -4424,6 +4439,33 @@ export type LPAQCasAdvertSubmissionProperties = {
    */
   didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
 };
+/**
+ * Schema defining any enfrocement specific properties for LPAQ submissions
+ */
+export type LPAQEnforcementSubmissionProperties = {
+  noticeRelatesToBuildingEngineeringMiningOther?: boolean | null;
+  /**
+   * The site area, in square meters
+   */
+  siteAreaSquareMetres?: number | null;
+  hasAllegedBreachArea?: boolean | null;
+  doesAllegedBreachCreateFloorSpace?: boolean | null;
+  changeOfUseRefuseOrWaste?: boolean | null;
+  changeOfUseMineralExtraction?: boolean | null;
+  changeOfUseMineralStorage?: boolean | null;
+  relatesToErectionOfBuildingOrBuildings?: boolean | null;
+  relatesToBuildingWithAgriculturalPurpose?: boolean | null;
+  relatesToBuildingSingleDwellingHouse?: boolean | null;
+  /**
+   * Name of trunk road within 67M of site
+   */
+  affectedTrunkRoadName?: string | null;
+  isSiteOnCrownLand?: boolean | null;
+  /**
+   * What permitted develpoment rights are affected by the Article 4 Direction
+   */
+  article4AffectedDevelopmentRights?: string | null;
+};
 
 /**
  * Schema defining the data produced by the Front-Office when an LPA Questionnaire is submitted
@@ -4440,7 +4482,10 @@ export interface LPAQuestionnaireCommand {
         LPAQHASSubmissionProperties &
         LPAQS78SubmissionProperties &
         LPAProcedurePreferenceProperties &
-        ChangedListedBuildingNumbersProperties)
+        ChangedListedBuildingNumbersProperties &
+        InfrastructureLevyProperties &
+        EnvironmentalImpactAssessmentProperties &
+        SiteDesignationsAndProtectionSpecificProperties)
     | ({
         caseType?: 'ZA';
       } & LPAQCommonSubmissionProperties &
@@ -4453,7 +4498,17 @@ export interface LPAQuestionnaireCommand {
         LPAQHASSubmissionProperties &
         LPAQCasAdvertSubmissionProperties &
         LPAProcedurePreferenceProperties &
-        ChangedListedBuildingNumbersProperties);
+        ChangedListedBuildingNumbersProperties)
+    | ({
+        caseType?: 'C';
+      } & LPAQCommonSubmissionProperties &
+        LPAQHASSubmissionProperties &
+        LPAProcedurePreferenceProperties &
+        ChangedListedBuildingNumbersProperties &
+        InfrastructureLevyProperties &
+        EnvironmentalImpactAssessmentProperties &
+        SiteDesignationsAndProtectionSpecificProperties &
+        LPAQEnforcementSubmissionProperties);
   documents: {
     /**
      * The unique identifier for the document
@@ -4513,7 +4568,15 @@ export interface LPAQuestionnaireCommand {
       | 'eiaScopingOpinion'
       | 'communityInfrastructureLevy'
       | 'definitiveMapStatement'
-      | 'historicEnglandConsultation';
+      | 'historicEnglandConsultation'
+      | 'stopNotice'
+      | 'article4Direction'
+      | 'enforcementList'
+      | 'localDevelopmentOrder'
+      | 'planningPermission'
+      | 'enforcementNotice'
+      | 'enforcementNoticePlan'
+      | 'planningContraventionNotice';
     [k: string]: unknown;
   }[];
   [k: string]: unknown;

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

@@ -0,0 +1,109 @@
+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 exampleEnforcementQuestionnaireSchema = {
+	casedata: {
+		caseType: 'C',
+		caseReference: 'est ea elit in nulla',
+		lpaQuestionnaireSubmittedDate: null,
+		siteAccessDetails: ['velit adipisicing fugiat dolor ullamco'],
+		siteSafetyDetails: ['ut', 'dolore ut sint Duis', 'magna consequat quis laboris officia'],
+		nearbyCaseReferences: ['nulla', 'incididunt eu nostrud eiusmod', 'exercitation', 'Ut nostrud', 'eiusmod cillum eu'],
+		neighbouringSiteAddresses: null,
+		isCorrectAppealType: true,
+		affectedListedBuildingNumbers: null,
+		isGreenBelt: null,
+		inConservationArea: null,
+		newConditionDetails: null,
+		notificationMethod: ['irure', 'cillum tempor incididunt labore in'],
+		lpaCostsAppliedFor: true,
+		lpaStatement: 'ex laborum cupidatat',
+		changedListedBuildingNumbers: null,
+		affectsScheduledMonument: true,
+		hasProtectedSpecies: false,
+		isAonbNationalLandscape: true,
+		designatedSitesNames: ['quis nulla eu officia exercitation'],
+		hasTreePreservationOrder: null,
+		isGypsyOrTravellerSite: true,
+		isPublicRightOfWay: null,
+		eiaEnvironmentalImpactSchedule: 'schedule-2',
+		eiaDevelopmentDescription: 'production-processing-of-metals',
+		eiaSensitiveAreaDetails: null,
+		eiaColumnTwoThreshold: false,
+		eiaScreeningOpinion: false,
+		eiaRequiresEnvironmentalStatement: null,
+		eiaCompletedEnvironmentalStatement: true,
+		hasStatutoryConsultees: true,
+		consultedBodiesDetails: 'in in labore irure nostrud',
+		hasConsultationResponses: null,
+		hasEmergingPlan: null,
+		hasSupplementaryPlanningDocs: null,
+		hasInfrastructureLevy: true,
+		isInfrastructureLevyFormallyAdopted: false,
+		infrastructureLevyAdoptedDate: '1913-06-14T10:40:33.0Z',
+		infrastructureLevyExpectedDate: '1912-06-14T10:40:33.0Z',
+		lpaProcedurePreference: null,
+		lpaProcedurePreferenceDetails: 'in reprehenderit',
+		lpaProcedurePreferenceDuration: -34480053.16630782,
+		noticeRelatesToBuildingEngineeringMiningOther: null,
+		siteAreaSquareMetres: null,
+		hasAllegedBreachArea: null,
+		doesAllegedBreachCreateFloorSpace: null,
+		changeOfUseRefuseOrWaste: null,
+		changeOfUseMineralExtraction: null,
+		changeOfUseMineralStorage: null,
+		relatesToErectionOfBuildingOrBuildings: null,
+		relatesToBuildingWithAgriculturalPurpose: null,
+		relatesToBuildingSingleDwellingHouse: null,
+		affectedTrunkRoadName: null,
+		isSiteOnCrownLand: null,
+		article4AffectedDevelopmentRights: null
+	},
+	documents: [document]
+};
+
+describe('Enforcement 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 Enforcement', () => {
+		const validationResult = ajv.validate(schema, exampleEnforcementQuestionnaireSchema);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should reject missing caseReference', () => {
+		const test = structuredClone(exampleEnforcementQuestionnaireSchema);
+		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(exampleEnforcementQuestionnaireSchema);
+		test.test = 1;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});