@planning-inspectorate/data-model 2.18.0 → 2.20.0

package/src/schemas.d.ts

@@ -170,6 +170,10 @@ export interface AppealDocument {
     | 'delegatedReport'
     | 'relatedApplications'
     | 'otherRelevantMatters'
+    | 'groundHSupporting'
+    | 'groundISupporting'
+    | 'groundJSupporting'
+    | 'groundKSupporting'
     | null;
   /**
    * The system mastering the metadata for the current document
@@ -1230,6 +1234,10 @@ export type AppealS78Case = (
    * New conditions details provided by the LPA
    */
   newConditionDetails: string | null;
+  /**
+   * extra conditions details provided by the LPA
+   */
+  extraConditionsDetails?: string | null;
   /**
    * A list of related case references known to the appellant and the LPA
    */
@@ -1584,6 +1592,20 @@ export type AppealS78Case = (
         [k: string]: unknown;
       }[]
     | null;
+  /**
+   * A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)
+   */
+  applicationElbAppealGroundsDetails?:
+    | {
+        appealGroundLetter?: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | null;
+        groundForAppealStartDate?: string | null;
+        /**
+         * Facts supporting the appeal ground
+         */
+        groundFacts?: string | null;
+        [k: string]: unknown;
+      }[]
+    | null;
   /**
    * Was an application made and paid for
    */
@@ -3745,66 +3767,10 @@ export type AppellantEnforcementSubmissionProperties = (
       siteAddressPostcode: string;
     }
 ) & {
-  /**
-   * Case submission id - link to draft submission created by appellant
-   */
-  submissionId: string;
-  /**
-   * The type of procedure for the appeal
-   */
-  caseProcedure: 'written' | 'hearing' | 'inquiry';
-  /**
-   * A unique identifier for the Local Planning Authority
-   */
-  lpaCode: string;
-  /**
-   * The date the appeal was submitted by the appellant
-   */
-  caseSubmittedDate: string;
-  /**
-   * Indicates if an enforcement notice is the reason for the appeal
-   */
-  enforcementNotice: boolean | null;
-  /**
-   * The unique identifier of the enforcement notice
-   */
-  enforcementReference: string;
-  /**
-   * The date the enforcement notice was issued
-   */
-  enforcementIssueDate: string;
-  /**
-   * The date the enforcement notice took effect
-   */
-  enforcementEffectiveDate: string;
-  /**
-   * The date the enforcement notice took effect
-   */
-  contactPlanningInspectorateDate?: string | null;
-  /**
-   * The individual's interest in the appeal land
-   */
-  interestInLand?: string | null;
-  /**
-   * If required, whether the individual has permission to use the appeal land
-   */
-  writtenOrVerbalPermission?: string | null;
-  /**
-   * A description of the alleged breach
-   */
-  descriptionOfAllegedBreach?: string | null;
   /**
    * Whether a planning application was made
    */
   applicationMadeAndFeePaid?: boolean | null;
-  /**
-   * Whether a retrospective planning application was made
-   */
-  retrospectiveApplication?: boolean | null;
-  /**
-   * Whether a ground (a) fee has been paid
-   */
-  groundAFeePaid?: boolean | null;
   /**
    * Did the application relate to all or part of the development
    */
@@ -3841,10 +3807,6 @@ export type AppellantEnforcementSubmissionProperties = (
    * The date of the appeal against the original LPA decision
    */
   appealDecisionDate?: string | null;
-  /**
-   * The statutory deadline for submitting an appeal from the original LPA decision date
-   */
-  caseSubmissionDueDate: string | null;
   /**
    * First line of address for the appeal site
    */
@@ -3865,8 +3827,6 @@ export type AppellantEnforcementSubmissionProperties = (
    * Postal code of the site address
    */
   siteAddressPostcode?: string | null;
-  siteGridReferenceEasting?: string | null;
-  siteGridReferenceNorthing?: string | null;
   /**
    * First line of address for the appeal site
    */
@@ -3887,44 +3847,22 @@ export type AppellantEnforcementSubmissionProperties = (
    * Postal code of the site address
    */
   contactAddressPostcode?: string | null;
-  contactGridReferenceEasting?: string | null;
-  contactGridReferenceNorthing?: string | null;
-  /**
-   * Provided information on site accessibility
-   */
-  siteAccessDetails?: string[] | null;
-  /**
-   * Provided information on site health and safety
-   */
-  siteSafetyDetails?: string[] | null;
-  /**
-   * Indicates if the appellant has applied for costs
-   */
-  appellantCostsAppliedFor?: boolean | null;
-  /**
-   * The procedure preference indicated by the appellant
-   */
-  appellantProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
-  /**
-   * The procedure details preference indicated by the appellant
-   */
-  appellantProcedurePreferenceDetails?: string | null;
-  /**
-   * The duration of the procedure indicated by the appellant
-   */
-  appellantProcedurePreferenceDuration?: number | null;
+  siteGridReferenceEasting?: string | null;
+  siteGridReferenceNorthing?: string | null;
   /**
-   * The number of witnesses appellant has suggested for inquiries preference
+   * Whether a retrospective planning application was made
    */
-  appellantProcedurePreferenceWitnessCount?: number | null;
+  retrospectiveApplication?: boolean | null;
+  contactGridReferenceEasting?: string | null;
+  contactGridReferenceNorthing?: string | null;
   /**
-   * The planning obligation information, if available
+   * Whether a ground (a) fee has been paid
    */
-  statusPlanningObligation?: string | null;
+  groundAFeePaid?: boolean | null;
   /**
-   * A list of related case references known to the appellant and the LPA
+   * If required, whether the individual has permission to use the appeal land
    */
-  nearbyCaseReferences?: string[] | null;
+  writtenOrVerbalPermission?: string | null;
   /**
    * A list of individuals named on the enforcement notice
    */
@@ -3943,7 +3881,7 @@ export type AppellantEnforcementSubmissionProperties = (
          */
         interestInLand: string;
         /**
-         * Whether the individual has permission to use the land
+         * If required, whether the individual has permission to use the appeal land
          */
         writtenOrVerbalPermission: string | null;
         [k: string]: unknown;
@@ -4003,6 +3941,7 @@ export interface AppellantSubmissionCommand {
     | ({
         caseType?: 'C';
       } & AppellantEnforcementSubmissionProperties &
+        AppellantEnforcementCommonSubmissionProperties &
         AppellantProcedurePreferenceProperties)
     | ({
         caseType?: 'X';
@@ -4012,7 +3951,8 @@ export interface AppellantSubmissionCommand {
         LDCSpecificProperties)
     | ({
         caseType?: 'F';
-      } & AppellantEnforcementSubmissionProperties &
+      } & AppellantEnforcementCommonSubmissionProperties &
+        AppellantEnforcementListedBuildingSubmissionProperties &
         AppellantProcedurePreferenceProperties);
   documents: {
     /**
@@ -4240,6 +4180,96 @@ export interface AdvertSpecificProperties {
     | null;
   [k: string]: unknown;
 }
+/**
+ * Schema defining any common properties for enforcement appeals
+ */
+export interface AppellantEnforcementCommonSubmissionProperties {
+  /**
+   * Case submission id - link to draft submission created by appellant
+   */
+  submissionId: string;
+  /**
+   * A description of the alleged breach
+   */
+  descriptionOfAllegedBreach?: string | null;
+  /**
+   * The type of procedure for the appeal
+   */
+  caseProcedure: 'written' | 'hearing' | 'inquiry';
+  /**
+   * A unique identifier for the Local Planning Authority
+   */
+  lpaCode: string;
+  /**
+   * The date the appeal was submitted by the appellant
+   */
+  caseSubmittedDate: string;
+  /**
+   * Indicates if an enforcement notice is the reason for the appeal
+   */
+  enforcementNotice: boolean | null;
+  /**
+   * The unique identifier of the enforcement notice
+   */
+  enforcementReference: string;
+  /**
+   * The date the enforcement notice was issued
+   */
+  enforcementIssueDate: string;
+  /**
+   * The date the enforcement notice took effect
+   */
+  enforcementEffectiveDate: string;
+  /**
+   * The date the enforcement notice took effect
+   */
+  contactPlanningInspectorateDate?: string | null;
+  /**
+   * The individual's interest in the appeal land
+   */
+  interestInLand?: string | null;
+  /**
+   * The statutory deadline for submitting an appeal from the original LPA decision date
+   */
+  caseSubmissionDueDate: string | null;
+  /**
+   * Provided information on site accessibility
+   */
+  siteAccessDetails?: string[] | null;
+  /**
+   * Provided information on site health and safety
+   */
+  siteSafetyDetails?: string[] | null;
+  /**
+   * Indicates if the appellant has applied for costs
+   */
+  appellantCostsAppliedFor?: boolean | null;
+  /**
+   * The procedure preference indicated by the appellant
+   */
+  appellantProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
+  /**
+   * The procedure details preference indicated by the appellant
+   */
+  appellantProcedurePreferenceDetails?: string | null;
+  /**
+   * The duration of the procedure indicated by the appellant
+   */
+  appellantProcedurePreferenceDuration?: number | null;
+  /**
+   * The number of witnesses appellant has suggested for inquiries preference
+   */
+  appellantProcedurePreferenceWitnessCount?: number | null;
+  /**
+   * The planning obligation information, if available
+   */
+  statusPlanningObligation?: string | null;
+  /**
+   * A list of related case references known to the appellant and the LPA
+   */
+  nearbyCaseReferences?: string[] | null;
+  [k: string]: unknown;
+}
 /**
  * Schema defining any properties for ldc appeals
  */
@@ -4255,6 +4285,88 @@ export interface LDCSpecificProperties {
     | null;
   [k: string]: unknown;
 }
+/**
+ * Schema defining any properties for enforcement listed building appeals
+ */
+export interface AppellantEnforcementListedBuildingSubmissionProperties {
+  /**
+   * A list of individuals named on the enforcement notice
+   */
+  namedIndividuals?:
+    | {
+        /**
+         * First name of the individual
+         */
+        firstName: string;
+        /**
+         * Last name of the individual
+         */
+        lastName: string;
+        /**
+         * Individual's interest in the appeal land
+         */
+        interestInLand: string;
+        [k: string]: unknown;
+      }[]
+    | null;
+  /**
+   * First line of address for the appeal site
+   */
+  siteAddressLine1?: string | null;
+  /**
+   * Second line of address for the appeal site
+   */
+  siteAddressLine2?: string | null;
+  /**
+   * Town / City of the site address
+   */
+  siteAddressTown?: string | null;
+  /**
+   * County of the site address
+   */
+  siteAddressCounty?: string | null;
+  /**
+   * Postal code of the site address
+   */
+  siteAddressPostcode?: string | null;
+  /**
+   * First line of address for the appeal site
+   */
+  contactAddressLine1?: string | null;
+  /**
+   * Second line of address for the appeal site
+   */
+  contactAddressLine2?: string | null;
+  /**
+   * Town / City of the site address
+   */
+  contactAddressTown?: string | null;
+  /**
+   * County of the site address
+   */
+  contactAddressCounty?: string | null;
+  /**
+   * Postal code of the site address
+   */
+  contactAddressPostcode?: string | null;
+  /**
+   * A list of appeal grounds being pleaded
+   */
+  appealGrounds?:
+    | {
+        /**
+         * Name of the appeal ground
+         */
+        groundRef: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k';
+        /**
+         * Facts supporting the appeal ground
+         */
+        factsForGround: string;
+        [k: string]: unknown;
+      }[]
+    | null;
+  [k: string]: unknown;
+}
 
 export type Name = string;
 

package/tests/appeals/commands/enforcement-listed-submission.test.js

@@ -40,18 +40,6 @@ const exampleEnforcementListedSubmissionSchema = {
 		enforcementEffectiveDate: '1890-12-28T22:49:47.0Z',
 		contactPlanningInspectorateDate: null,
 		interestInLand: 'owner',
-		writtenOrVerbalPermission: null,
-		descriptionOfAllegedBreach: 'a new chimney',
-		applicationMadeAndFeePaid: true,
-		applicationDevelopmentAllOrPart: 'all-of-the-development',
-		originalDevelopmentDescription: 'in amet',
-		changedDevelopmentDescription: true,
-		applicationReference: '43010/APP/1/290572',
-		applicationDate: '1890-12-28T22:49:47.0Z',
-		applicationDecision: 'granted',
-		applicationDecisionAppealed: false,
-		applicationDecisionDate: '1890-12-28T22:49:47.0Z',
-		appealDecisionDate: null,
 		caseSubmissionDueDate: null,
 		siteAddressLine1: 'occaecat aliquip non pariatur consequat',
 		siteAddressLine2: null,
@@ -65,8 +53,6 @@ const exampleEnforcementListedSubmissionSchema = {
 		contactAddressTown: null,
 		contactAddressCounty: null,
 		contactAddressPostcode: null,
-		contactGridReferenceEasting: null,
-		contactGridReferenceNorthing: null,
 		siteAccessDetails: ['laborum', 'aute velit quis', 'dolor'],
 		siteSafetyDetails: ['velit aliqua', 'qui', 'tempor Duis ut dolore', 'anim Ut in ea', 'eiusmod laborum'],
 		appellantCostsAppliedFor: false,
@@ -80,8 +66,7 @@ const exampleEnforcementListedSubmissionSchema = {
 			{
 				firstName: 'Bob',
 				lastName: 'Bobberson',
-				interestInLand: 'owner',
-				writtenOrVerbalPermission: 'yes'
+				interestInLand: 'owner'
 			}
 		],
 		appealGrounds: [
@@ -106,56 +91,12 @@ describe(' listed building submission command schema', () => {
 		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: '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(exampleEnforcementListedSubmissionSchema);
-			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(exampleEnforcementListedSubmissionSchema);
-		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(exampleEnforcementListedSubmissionSchema);
-		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(exampleEnforcementListedSubmissionSchema);
-		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(exampleEnforcementListedSubmissionSchema);
 		delete test.casedata.caseType;