@planning-inspectorate/data-model 2.21.1 → 2.22.0

package/schemas/commands/appeals-components/{appeal-enforcement-submission.schema.json → appeal-enforcement-notice-submission.schema.json}

@@ -1,32 +1,23 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/appeals-components/appeal-enforcement-submission.schema.json",
-  "title": "Appellant enforcement submission properties",
-  "description": "Schema defining any properties for enforcement appeals",
+  "$id": "commands/appeals-components/appeal-enforcement-notice-submission.schema.json",
+  "title": "Appellant enforcement notice specific submission properties",
+  "description": "Schema defining properties specific to enforcement notice appeals",
   "type": "object",
   "additionalProperties": true,
   "required": [],
-  "anyOf": [
-    {
-      "required": ["siteGridReferenceEasting", "siteGridReferenceNorthing"],
-      "properties": {
-        "siteGridReferenceEasting": { "type": "string" },
-        "siteGridReferenceNorthing": { "type": "string" }
-      }
-    },
-    {
-      "required": ["siteAddressLine1", "siteAddressTown", "siteAddressPostcode"],
-      "properties": {
-        "siteAddressLine1": { "type": "string" },
-        "siteAddressTown": { "type": "string" },
-        "siteAddressPostcode": { "type": "string" }
-      }
-    }
-  ],
   "properties": {
     "applicationMadeAndFeePaid": {
       "type": ["boolean", "null"],
-      "description": "Whether a planning application was made"
+      "description": "Whether a planning application was made - historic question"
+    },
+    "retrospectiveApplication": {
+      "type": ["boolean", "null"],
+      "description": "Whether a retrospective planning application was made"
+    },
+    "groundAFeePaid": {
+      "type": ["boolean", "null"],
+      "description": "Whether a ground (a) fee has been paid"
     },
     "applicationDevelopmentAllOrPart": {
       "type": ["string", "null"],
@@ -73,81 +64,13 @@
       "examples": ["2023-07-27T20:30:00.000Z"],
       "description": "The date of the appeal against the original LPA decision"
     },
-    "siteAddressLine1": {
-      "type": ["string", "null"],
-      "examples": ["96 The Avenue"],
-      "description": "First line of address for the appeal site"
-    },
-    "siteAddressLine2": {
-      "type": ["string", "null"],
-      "description": "Second line of address for the appeal site"
-    },
-    "siteAddressTown": {
-      "type": ["string", "null"],
-      "examples": ["Maidstone"],
-      "description": "Town / City of the site address"
-    },
-    "siteAddressCounty": {
-      "type": ["string", "null"],
-      "examples": ["Kent"],
-      "description": "County of the site address"
-    },
-    "siteAddressPostcode": {
-      "type": ["string", "null"],
-      "examples": ["MD21 5XY"],
-      "description": "Postal code of the site address"
-    },
-    "contactAddressLine1": {
-      "type": ["string", "null"],
-      "examples": ["96 The Avenue"],
-      "description": "First line of address for the appeal site"
-    },
-    "contactAddressLine2": {
-      "type": ["string", "null"],
-      "description": "Second line of address for the appeal site"
-    },
-    "contactAddressTown": {
-      "type": ["string", "null"],
-      "examples": ["Maidstone"],
-      "description": "Town / City of the site address"
-    },
-    "contactAddressCounty": {
-      "type": ["string", "null"],
-      "examples": ["Kent"],
-      "description": "County of the site address"
-    },
-    "contactAddressPostcode": {
-      "type": ["string", "null"],
-      "examples": ["MD21 5XY"],
-      "description": "Postal code of the site address"
-    },
-    "siteGridReferenceEasting": {
-      "type": ["string", "null"],
-      "pattern": "^\\d{6,7}$",
-      "examples": ["357144"]
-    },
-    "siteGridReferenceNorthing": {
-      "type": ["string", "null"],
-      "pattern": "^\\d{6,7}$",
-      "examples": ["400534"]
-    },
-    "retrospectiveApplication": {
+    "planningObligation": {
       "type": ["boolean", "null"],
-      "description": "Whether a retrospective planning application was made"
-    },
-    "contactGridReferenceEasting": {
-      "type": ["string", "null"],
-      "pattern": "^\\d{6,7}$",
-      "examples": ["357144"]
+      "description": "Indicates the existence of a planning obligation"
     },
-    "contactGridReferenceNorthing": {
+    "statusPlanningObligation": {
       "type": ["string", "null"],
-      "pattern": "^\\d{6,7}$",
-      "examples": ["400534"]
-    },
-    "groundAFeePaid": {
-      "type": ["boolean", "null"],
-      "description": "Whether a ground (a) fee has been paid"
+      "description": "The planning obligation information, if available"
     },
     "writtenOrVerbalPermission": {
       "type": ["string", "null"],

package/schemas/commands/appeals-components/lpa-questionnaire-enforcement.schema.json

@@ -8,8 +8,6 @@
   "required": [
     "noticeRelatesToBuildingEngineeringMiningOther",
     "siteAreaSquareMetres",
-    "hasAllegedBreachArea",
-    "doesAllegedBreachCreateFloorSpace",
     "changeOfUseRefuseOrWaste",
     "changeOfUseMineralExtraction",
     "changeOfUseMineralStorage",

package/schemas/commands/appellant-submission.schema.json

@@ -60,8 +60,8 @@
           "$comment": "Enforcement notice",
           "allOf": [
             { "properties": { "caseType": { "enum": ["C"] } } },
-            { "$ref": "appeals-components/appeal-enforcement-submission.schema.json" },
             { "$ref": "appeals-components/appeal-enforcement-common-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-enforcement-notice-submission.schema.json" },
             { "$ref": "appeals-components/appellant-procedure-preference.schema.json" }
           ]
         },

package/src/lib/gen-docs.js

@@ -23,7 +23,7 @@ async function genDocs() {
 		includeReadme: true
 	});
 	// remove all irrelevant docs
-	const removePatterns = ['-properties-', '-properties.', '-anyof-'];
+	const removePatterns = ['-properties-', '-properties.'];
 	for (const md of out.markdown) {
 		const shouldRemove = removePatterns.some((pattern) => md.fileName.includes(pattern));
 		if (shouldRemove) {

package/src/schemas.d.ts

@@ -332,17 +332,7 @@ export interface AppealEvent {
 /**
  * Group A - Schema defining the metadata for an appeal
  */
-export type AppealHASCase = (
-  | {
-      siteGridReferenceEasting: string;
-      siteGridReferenceNorthing: string;
-    }
-  | {
-      siteAddressLine1: string;
-      siteAddressTown: string;
-      siteAddressPostcode: string;
-    }
-) & {
+export type AppealHASCase = (GridReference | SiteAddress) & {
   /**
    * Internal case identifier
    */
@@ -836,6 +826,16 @@ export type AppealHASCase = (
   [k: string]: unknown;
 };
 
+export interface GridReference {
+  siteGridReferenceEasting: string;
+  siteGridReferenceNorthing: string;
+}
+export interface SiteAddress {
+  siteAddressLine1: string;
+  siteAddressTown: string;
+  siteAddressPostcode: string;
+}
+
 /**
  * Schema defining the metadata for appeal representations, such as statements, third-party comments and final comments
  */
@@ -925,17 +925,7 @@ export interface AppealRepresentation {
 /**
  * Group B - Schema defining the metadata for an appeal
  */
-export type AppealS78Case = (
-  | {
-      siteGridReferenceEasting: string;
-      siteGridReferenceNorthing: string;
-    }
-  | {
-      siteAddressLine1: string;
-      siteAddressTown: string;
-      siteAddressPostcode: string;
-    }
-) & {
+export type AppealS78Case = (GridReference | SiteAddress) & {
   /**
    * Internal case identifier
    */
@@ -1690,6 +1680,16 @@ export type AppealS78Case = (
   [k: string]: unknown;
 };
 
+export interface GridReference {
+  siteGridReferenceEasting: string;
+  siteGridReferenceNorthing: string;
+}
+export interface SiteAddress {
+  siteAddressLine1: string;
+  siteAddressTown: string;
+  siteAddressPostcode: string;
+}
+
 /**
  * Schema defining the data returned by the DaRT API
  */
@@ -3753,158 +3753,6 @@ export type AppellantProcedurePreferenceProperties = {
    */
   appellantProcedurePreferenceWitnessCount?: number | null;
 };
-/**
- * Schema defining any properties for enforcement appeals
- */
-export type AppellantEnforcementSubmissionProperties = (
-  | {
-      siteGridReferenceEasting: string;
-      siteGridReferenceNorthing: string;
-    }
-  | {
-      siteAddressLine1: string;
-      siteAddressTown: string;
-      siteAddressPostcode: string;
-    }
-) & {
-  /**
-   * Whether a planning application was made
-   */
-  applicationMadeAndFeePaid?: boolean | null;
-  /**
-   * Did the application relate to all or part of the development
-   */
-  applicationDevelopmentAllOrPart?: 'all-of-the-development' | 'part-of-the-development' | null;
-  /**
-   * A description of the proposed development
-   */
-  originalDevelopmentDescription?: string | null;
-  /**
-   * An updated description of the proposed development
-   */
-  changedDevelopmentDescription?: boolean | null;
-  /**
-   * The unique identifier of the LPA application
-   */
-  applicationReference?: string | null;
-  /**
-   * The date of the original LPA application
-   */
-  applicationDate?: string | null;
-  /**
-   * The outcome of the original LPA decision
-   */
-  applicationDecision?: 'granted' | 'refused' | 'not_received' | null;
-  /**
-   * The date of the original LPA decision
-   */
-  applicationDecisionDate?: string | null;
-  /**
-   * Whether an appeal was made against the original LPA decision
-   */
-  applicationDecisionAppealed?: boolean | null;
-  /**
-   * The date of the appeal against the original LPA decision
-   */
-  appealDecisionDate?: string | 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;
-  siteGridReferenceEasting?: string | null;
-  siteGridReferenceNorthing?: string | null;
-  /**
-   * Whether a retrospective planning application was made
-   */
-  retrospectiveApplication?: boolean | null;
-  contactGridReferenceEasting?: string | null;
-  contactGridReferenceNorthing?: string | null;
-  /**
-   * Whether a ground (a) fee has been paid
-   */
-  groundAFeePaid?: boolean | null;
-  /**
-   * If required, whether the individual has permission to use the appeal land
-   */
-  writtenOrVerbalPermission?: string | null;
-  /**
-   * 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;
-        /**
-         * If required, whether the individual has permission to use the appeal land
-         */
-        writtenOrVerbalPermission: string | null;
-        [k: string]: unknown;
-      }[]
-    | null;
-  /**
-   * A list of appeal grounds being pleaded
-   */
-  appealGrounds?:
-    | {
-        /**
-         * Name of the appeal ground
-         */
-        groundRef: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g';
-        /**
-         * Facts supporting the appeal ground
-         */
-        factsForGround: string;
-        [k: string]: unknown;
-      }[]
-    | null;
-  [k: string]: unknown;
-};
 
 /**
  * Schema defining the data produced by the Front-Office when an appeal is requested
@@ -3940,8 +3788,8 @@ export interface AppellantSubmissionCommand {
         AppellantProcedurePreferenceProperties)
     | ({
         caseType?: 'C';
-      } & AppellantEnforcementSubmissionProperties &
-        AppellantEnforcementCommonSubmissionProperties &
+      } & AppellantEnforcementCommonSubmissionProperties &
+        AppellantEnforcementNoticeSpecificSubmissionProperties &
         AppellantProcedurePreferenceProperties)
     | ({
         caseType?: 'X';
@@ -4232,6 +4080,46 @@ export interface AppellantEnforcementCommonSubmissionProperties {
    * The statutory deadline for submitting an appeal from the original LPA decision date
    */
   caseSubmissionDueDate: string | 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;
   /**
    * Provided information on site accessibility
    */
@@ -4260,14 +4148,116 @@ export interface AppellantEnforcementCommonSubmissionProperties {
    * The number of witnesses appellant has suggested for inquiries preference
    */
   appellantProcedurePreferenceWitnessCount?: number | null;
+  /**
+   * A list of related case references known to the appellant and the LPA
+   */
+  nearbyCaseReferences?: string[] | null;
+  [k: string]: unknown;
+}
+/**
+ * Schema defining properties specific to enforcement notice appeals
+ */
+export interface AppellantEnforcementNoticeSpecificSubmissionProperties {
+  /**
+   * Whether a planning application was made - historic question
+   */
+  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
+   */
+  applicationDevelopmentAllOrPart?: 'all-of-the-development' | 'part-of-the-development' | null;
+  /**
+   * A description of the proposed development
+   */
+  originalDevelopmentDescription?: string | null;
+  /**
+   * An updated description of the proposed development
+   */
+  changedDevelopmentDescription?: boolean | null;
+  /**
+   * The unique identifier of the LPA application
+   */
+  applicationReference?: string | null;
+  /**
+   * The date of the original LPA application
+   */
+  applicationDate?: string | null;
+  /**
+   * The outcome of the original LPA decision
+   */
+  applicationDecision?: 'granted' | 'refused' | 'not_received' | null;
+  /**
+   * The date of the original LPA decision
+   */
+  applicationDecisionDate?: string | null;
+  /**
+   * Whether an appeal was made against the original LPA decision
+   */
+  applicationDecisionAppealed?: boolean | null;
+  /**
+   * The date of the appeal against the original LPA decision
+   */
+  appealDecisionDate?: string | null;
+  /**
+   * Indicates the existence of a planning obligation
+   */
+  planningObligation?: boolean | null;
   /**
    * The planning obligation information, if available
    */
   statusPlanningObligation?: string | 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
+   */
+  namedIndividuals?:
+    | {
+        /**
+         * First name of the individual
+         */
+        firstName: string;
+        /**
+         * Last name of the individual
+         */
+        lastName: string;
+        /**
+         * Individual's interest in the appeal land
+         */
+        interestInLand: string;
+        /**
+         * If required, whether the individual has permission to use the appeal land
+         */
+        writtenOrVerbalPermission: string | null;
+        [k: string]: unknown;
+      }[]
+    | null;
+  /**
+   * A list of appeal grounds being pleaded
+   */
+  appealGrounds?:
+    | {
+        /**
+         * Name of the appeal ground
+         */
+        groundRef: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g';
+        /**
+         * Facts supporting the appeal ground
+         */
+        factsForGround: string;
+        [k: string]: unknown;
+      }[]
+    | null;
   [k: string]: unknown;
 }
 /**
@@ -4286,7 +4276,7 @@ export interface LDCSpecificProperties {
   [k: string]: unknown;
 }
 /**
- * Schema defining any properties for enforcement listed building appeals
+ * Schema defining any properties specific to enforcement listed building appeals
  */
 export interface AppellantEnforcementListedBuildingSubmissionProperties {
   /**
@@ -4309,46 +4299,6 @@ export interface AppellantEnforcementListedBuildingSubmissionProperties {
         [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
    */

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

@@ -46,8 +46,6 @@ const exampleEnforcementListedSubmissionSchema = {
 		siteAddressTown: 'et',
 		siteAddressCounty: 'velit',
 		siteAddressPostcode: 'nisi minim laboris sed',
-		siteGridReferenceEasting: '357144',
-		siteGridReferenceNorthing: '400534',
 		contactAddressLine1: null,
 		contactAddressLine2: null,
 		contactAddressTown: null,
@@ -60,7 +58,6 @@ const exampleEnforcementListedSubmissionSchema = {
 		appellantProcedurePreferenceDetails: 'eiusmod ex exercitation',
 		appellantProcedurePreferenceDuration: 10816414.941069126,
 		appellantProcedurePreferenceWitnessCount: -91300569.36444478,
-		statusPlanningObligation: 'proident aute',
 		nearbyCaseReferences: ['incididunt'],
 		namedIndividuals: [
 			{