@planning-inspectorate/data-model 2.10.2 → 2.10.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.10.2",
+  "version": "2.10.3",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",

package/schemas/commands/appeals-components/appeal-common-planning.schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/appeal-common-planning.schema.json",
+  "title": "Appellant common planning properties",
+  "description": "Schema defining any properties common across all planning appeal types for appeal submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "applicationReference",
+    "applicationDate",
+    "applicationDecision",
+    "applicationDecisionDate",
+    "isGreenBelt",
+    "originalDevelopmentDescription",
+    "changedDevelopmentDescription"
+  ],
+  "properties": {
+    "applicationReference": {
+      "type": "string",
+      "examples": ["43010/APP/1/290572"],
+      "description": "The unique identifier of the LPA application"
+    },
+    "applicationDate": {
+      "type": "string",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The date of the original LPA application"
+    },
+    "applicationDecision": {
+      "type": "string",
+      "enum": ["granted", "refused", "not_received"],
+      "description": "The outcome of the original LPA decision"
+    },
+    "applicationDecisionDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The date of the original LPA decision"
+    },
+    "isGreenBelt": {
+      "type": ["boolean", "null"],
+      "description": "Indicates if the site is in a green belt"
+    },
+    "originalDevelopmentDescription": {
+      "type": ["string", "null"],
+      "examples": ["Replacement of an existing gate to access the property"],
+      "description": "The original description of the development, as provided by the appellant"
+    },
+    "changedDevelopmentDescription": {
+      "type": ["boolean", "null"],
+      "description": "Indicates that the LPA has changed the development description"
+    }
+  }
+}

package/schemas/commands/appeals-components/appeal-common-submission.schema.json

@@ -11,15 +11,11 @@
     "lpaCode",
     "caseSubmittedDate",
     "enforcementNotice",
-    "applicationReference",
-    "applicationDate",
-    "applicationDecision",
-    "applicationDecisionDate",
     "caseSubmissionDueDate",
     "siteAccessDetails",
     "siteSafetyDetails",
-    "neighbouringSiteAddresses",
-    "nearbyCaseReferences"
+    "nearbyCaseReferences",
+    "appellantCostsAppliedFor"
   ],
   "anyOf": [
     {
@@ -66,28 +62,6 @@
       "type": ["boolean", "null"],
       "description": "Indicates if an enforcement notice is the reason for the appeal"
     },
-    "applicationReference": {
-      "type": "string",
-      "examples": ["43010/APP/1/290572"],
-      "description": "The unique identifier of the LPA application"
-    },
-    "applicationDate": {
-      "type": "string",
-      "format": "date-time",
-      "examples": ["2023-07-27T20:30:00.000Z"],
-      "description": "The date of the original LPA application"
-    },
-    "applicationDecision": {
-      "type": "string",
-      "enum": ["granted", "refused", "not_received"],
-      "description": "The outcome of the original LPA decision"
-    },
-    "applicationDecisionDate": {
-      "type": ["string", "null"],
-      "format": "date-time",
-      "examples": ["2023-07-27T20:30:00.000Z"],
-      "description": "The date of the original LPA decision"
-    },
     "caseSubmissionDueDate": {
       "type": ["string", "null"],
       "format": "date-time",
@@ -145,59 +119,6 @@
       },
       "description": "Provided information on site health and safety"
     },
-    "neighbouringSiteAddresses": {
-      "type": ["array", "null"],
-      "items": {
-        "type": "object",
-        "additionalProperties": true,
-        "properties": {
-          "neighbouringSiteAddressLine1": {
-            "type": "string",
-            "examples": ["96 The Avenue"],
-            "description": "First line of address of the site"
-          },
-          "neighbouringSiteAddressLine2": {
-            "type": ["string", "null"],
-            "description": "Second line of address of the site"
-          },
-          "neighbouringSiteAddressTown": {
-            "type": "string",
-            "examples": ["Maidstone"],
-            "description": "Town / City of the site address"
-          },
-          "neighbouringSiteAddressCounty": {
-            "type": ["string", "null"],
-            "examples": ["Kent"],
-            "description": "County of the site address"
-          },
-          "neighbouringSiteAddressPostcode": {
-            "type": "string",
-            "examples": ["MD21 5XY"],
-            "description": "Postal code of the site address"
-          },
-          "neighbouringSiteAccessDetails": {
-            "type": ["string", "null"],
-            "examples": ["Ongoing road works at this address"],
-            "description": "Provided information on site accessibility on this address"
-          },
-          "neighbouringSiteSafetyDetails": {
-            "type": ["string", "null"],
-            "examples": ["Ongoing road works at this address"],
-            "description": "Provided information on site health and safety on this address"
-          }
-        },
-        "required": [
-          "neighbouringSiteAddressLine1",
-          "neighbouringSiteAddressLine2",
-          "neighbouringSiteAddressTown",
-          "neighbouringSiteAddressCounty",
-          "neighbouringSiteAddressPostcode",
-          "neighbouringSiteAccessDetails",
-          "neighbouringSiteSafetyDetails"
-        ]
-      },
-      "description": "A list of neighbouring site addresses"
-    },
     "nearbyCaseReferences": {
       "type": ["array", "null"],
       "items": {
@@ -220,6 +141,10 @@
         "advertisement",
         null
       ]
+    },
+    "appellantCostsAppliedFor": {
+      "type": ["boolean", "null"],
+      "description": "Indicates if the appellant has applied for costs"
     }
   }
 }

package/schemas/commands/appeals-components/appeal-land-ownership.schema.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/appeal-land-ownership.schema.json",
+  "title": "Appeal land ownership properties",
+  "description": "Schema defining properties relating to land ownership",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "ownsAllLand",
+    "ownsSomeLand",
+    "knowsOtherOwners",
+    "knowsAllOwners",
+    "advertisedAppeal",
+    "ownersInformed"
+  ],
+  "allOf": [
+    {
+      "properties": {
+        "ownsAllLand": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has complete ownership of the site"
+        },
+        "ownsSomeLand": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has partial ownership of the site"
+        },
+        "knowsOtherOwners": {
+          "type": ["string", "null"],
+          "enum": ["Yes", "No", "Some", null],
+          "description": "Indicates if the appellant knows other owners of the site"
+        },
+        "knowsAllOwners": {
+          "type": ["string", "null"],
+          "enum": ["Yes", "No", "Some", null],
+          "description": "Indicates if the appellant knows all owners of the site"
+        },
+        "advertisedAppeal": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has advertised the appeal to the LPA decision"
+        },
+        "ownersInformed": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has informed other owners of the site"
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/appeals-components/appeal-site-area.schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/appeal-site-area.schema.json",
+  "title": "Site area properties",
+  "description": "Schema defining any properties for site area for an appeal",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["siteAreaSquareMetres", "floorSpaceSquareMetres"],
+  "properties": {
+    "siteAreaSquareMetres": {
+      "type": ["number", "null"],
+      "examples": [45.7],
+      "description": "The site area, in square meters"
+    },
+    "floorSpaceSquareMetres": {
+      "type": ["number", "null"],
+      "examples": [3.5],
+      "description": "The floor space, in square meters"
+    }
+  }
+}

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

@@ -18,7 +18,9 @@
           "allOf": [
             { "properties": { "caseType": { "enum": ["D", "ZP"] } } },
             { "$ref": "appeals-components/appeal-common-submission.schema.json" },
-            { "$ref": "appeals-components/appeal-has-submission.schema.json" }
+            { "$ref": "appeals-components/appeal-common-planning.schema.json" },
+            { "$ref": "appeals-components/appeal-site-area.schema.json" },
+            { "$ref": "appeals-components/appeal-land-ownership.schema.json" }
           ]
         },
         {
@@ -26,7 +28,9 @@
           "allOf": [
             { "properties": { "caseType": { "enum": ["W", "Y"] } } },
             { "$ref": "appeals-components/appeal-common-submission.schema.json" },
-            { "$ref": "appeals-components/appeal-has-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-common-planning.schema.json" },
+            { "$ref": "appeals-components/appeal-site-area.schema.json" },
+            { "$ref": "appeals-components/appeal-land-ownership.schema.json" },
             { "$ref": "appeals-components/appeal-s78-submission.schema.json" },
             { "$ref": "appeals-components/appellant-procedure-preference.schema.json" }
           ]
@@ -36,7 +40,8 @@
           "allOf": [
             { "properties": { "caseType": { "enum": ["ZA"] } } },
             { "$ref": "appeals-components/appeal-common-submission.schema.json" },
-            { "$ref": "appeals-components/appeal-has-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-common-planning.schema.json" },
+            { "$ref": "appeals-components/appeal-land-ownership.schema.json" },
             { "$ref": "appeals-components/appeal-advert.submission.schema.json" }
           ]
         },
@@ -45,7 +50,8 @@
           "allOf": [
             { "properties": { "caseType": { "enum": ["H"] } } },
             { "$ref": "appeals-components/appeal-common-submission.schema.json" },
-            { "$ref": "appeals-components/appeal-has-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-common-planning.schema.json" },
+            { "$ref": "appeals-components/appeal-land-ownership.schema.json" },
             { "$ref": "appeals-components/appeal-advert.submission.schema.json" },
             { "$ref": "appeals-components/appellant-procedure-preference.schema.json" }
           ]

package/src/schemas.d.ts

@@ -3524,22 +3524,6 @@ export type AppellantCommonSubmissionProperties = (
    * Indicates if an enforcement notice is the reason for the appeal
    */
   enforcementNotice: boolean | null;
-  /**
-   * The unique identifier of the LPA application
-   */
-  applicationReference: string;
-  /**
-   * The date of the original LPA application
-   */
-  applicationDate: string;
-  /**
-   * The outcome of the original LPA decision
-   */
-  applicationDecision: 'granted' | 'refused' | 'not_received';
-  /**
-   * The date of the original LPA decision
-   */
-  applicationDecisionDate: string | null;
   /**
    * The statutory deadline for submitting an appeal from the original LPA decision date
    */
@@ -3574,42 +3558,6 @@ export type AppellantCommonSubmissionProperties = (
    * Provided information on site health and safety
    */
   siteSafetyDetails: string[] | null;
-  /**
-   * A list of neighbouring site addresses
-   */
-  neighbouringSiteAddresses:
-    | {
-        /**
-         * First line of address of the site
-         */
-        neighbouringSiteAddressLine1: string;
-        /**
-         * Second line of address of the site
-         */
-        neighbouringSiteAddressLine2: string | null;
-        /**
-         * Town / City of the site address
-         */
-        neighbouringSiteAddressTown: string;
-        /**
-         * County of the site address
-         */
-        neighbouringSiteAddressCounty: string | null;
-        /**
-         * Postal code of the site address
-         */
-        neighbouringSiteAddressPostcode: string;
-        /**
-         * Provided information on site accessibility on this address
-         */
-        neighbouringSiteAccessDetails: string | null;
-        /**
-         * Provided information on site health and safety on this address
-         */
-        neighbouringSiteSafetyDetails: string | null;
-        [k: string]: unknown;
-      }[]
-    | null;
   /**
    * A list of related case references known to the appellant and the LPA
    */
@@ -3625,24 +3573,16 @@ export type AppellantCommonSubmissionProperties = (
     | 'minor-commercial-development'
     | 'advertisement'
     | null;
+  /**
+   * Indicates if the appellant has applied for costs
+   */
+  appellantCostsAppliedFor: boolean | null;
   [k: string]: unknown;
 };
 /**
- * Schema defining any HAS specific properties for appeal submissions
+ * Schema defining properties relating to land ownership
  */
-export type AppellantHASSubmissionProperties = {
-  /**
-   * Indicates if the site is in a green belt
-   */
-  isGreenBelt?: boolean | null;
-  /**
-   * The site area, in square meters
-   */
-  siteAreaSquareMetres?: number | null;
-  /**
-   * The floor space, in square meters
-   */
-  floorSpaceSquareMetres?: number | null;
+export type AppealLandOwnershipProperties = {
   /**
    * Indicates if the appellant has complete ownership of the site
    */
@@ -3667,18 +3607,6 @@ export type AppellantHASSubmissionProperties = {
    * Indicates if the appellant has informed other owners of the site
    */
   ownersInformed?: boolean | null;
-  /**
-   * The original description of the development, as provided by the appellant
-   */
-  originalDevelopmentDescription?: string | null;
-  /**
-   * Indicates that the LPA has changed the development description
-   */
-  changedDevelopmentDescription?: boolean | null;
-  /**
-   * Indicates if the appellant has applied for costs
-   */
-  appellantCostsAppliedFor?: boolean | null;
 };
 /**
  * Schema defining any S78 specific properties for appeal submissions
@@ -4000,22 +3928,28 @@ export interface AppellantSubmissionCommand {
     | ({
         caseType?: 'D' | 'ZP';
       } & AppellantCommonSubmissionProperties &
-        AppellantHASSubmissionProperties)
+        AppellantCommonPlanningProperties &
+        SiteAreaProperties &
+        AppealLandOwnershipProperties)
     | ({
         caseType?: 'W' | 'Y';
       } & AppellantCommonSubmissionProperties &
-        AppellantHASSubmissionProperties &
+        AppellantCommonPlanningProperties &
+        SiteAreaProperties &
+        AppealLandOwnershipProperties &
         AppellantS78SubmissionProperties &
         AppellantProcedurePreferenceProperties)
     | ({
         caseType?: 'ZA';
       } & AppellantCommonSubmissionProperties &
-        AppellantHASSubmissionProperties &
+        AppellantCommonPlanningProperties &
+        AppealLandOwnershipProperties &
         AdvertSpecificProperties)
     | ({
         caseType?: 'H';
       } & AppellantCommonSubmissionProperties &
-        AppellantHASSubmissionProperties &
+        AppellantCommonPlanningProperties &
+        AppealLandOwnershipProperties &
         AdvertSpecificProperties &
         AppellantProcedurePreferenceProperties)
     | ({
@@ -4159,6 +4093,54 @@ export interface AppellantSubmissionCommand {
   ];
   [k: string]: unknown;
 }
+/**
+ * Schema defining any properties common across all planning appeal types for appeal submissions
+ */
+export interface AppellantCommonPlanningProperties {
+  /**
+   * The unique identifier of the LPA application
+   */
+  applicationReference: string;
+  /**
+   * The date of the original LPA application
+   */
+  applicationDate: string;
+  /**
+   * The outcome of the original LPA decision
+   */
+  applicationDecision: 'granted' | 'refused' | 'not_received';
+  /**
+   * The date of the original LPA decision
+   */
+  applicationDecisionDate: string | null;
+  /**
+   * Indicates if the site is in a green belt
+   */
+  isGreenBelt: boolean | null;
+  /**
+   * The original description of the development, as provided by the appellant
+   */
+  originalDevelopmentDescription: string | null;
+  /**
+   * Indicates that the LPA has changed the development description
+   */
+  changedDevelopmentDescription: boolean | null;
+  [k: string]: unknown;
+}
+/**
+ * Schema defining any properties for site area for an appeal
+ */
+export interface SiteAreaProperties {
+  /**
+   * The site area, in square meters
+   */
+  siteAreaSquareMetres: number | null;
+  /**
+   * The floor space, in square meters
+   */
+  floorSpaceSquareMetres: number | null;
+  [k: string]: unknown;
+}
 /**
  * Schema defining any properties for advertisement appeals
  */

package/schemas/commands/appeals-components/appeal-has-submission.schema.json

@@ -1,81 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/appeals-components/appeal-has-submission.schema.json",
-  "title": "Appellant HAS submission properties",
-  "description": "Schema defining any HAS specific properties for appeal submissions",
-  "type": "object",
-  "additionalProperties": true,
-  "required": [
-    "isGreenBelt",
-    "siteAreaSquareMetres",
-    "floorSpaceSquareMetres",
-    "ownsAllLand",
-    "ownsSomeLand",
-    "knowsOtherOwners",
-    "knowsAllOwners",
-    "advertisedAppeal",
-    "ownersInformed",
-    "originalDevelopmentDescription",
-    "changedDevelopmentDescription",
-    "appellantCostsAppliedFor"
-  ],
-  "allOf": [
-    {
-      "properties": {
-        "isGreenBelt": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the site is in a green belt"
-        },
-        "siteAreaSquareMetres": {
-          "type": ["number", "null"],
-          "examples": [45.7],
-          "description": "The site area, in square meters"
-        },
-        "floorSpaceSquareMetres": {
-          "type": ["number", "null"],
-          "examples": [3.5],
-          "description": "The floor space, in square meters"
-        },
-        "ownsAllLand": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has complete ownership of the site"
-        },
-        "ownsSomeLand": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has partial ownership of the site"
-        },
-        "knowsOtherOwners": {
-          "type": ["string", "null"],
-          "enum": ["Yes", "No", "Some", null],
-          "description": "Indicates if the appellant knows other owners of the site"
-        },
-        "knowsAllOwners": {
-          "type": ["string", "null"],
-          "enum": ["Yes", "No", "Some", null],
-          "description": "Indicates if the appellant knows all owners of the site"
-        },
-        "advertisedAppeal": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has advertised the appeal to the LPA decision"
-        },
-        "ownersInformed": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has informed other owners of the site"
-        },
-        "originalDevelopmentDescription": {
-          "type": ["string", "null"],
-          "examples": ["Replacement of an existing gate to access the property"],
-          "description": "The original description of the development, as provided by the appellant"
-        },
-        "changedDevelopmentDescription": {
-          "type": ["boolean", "null"],
-          "description": "Indicates that the LPA has changed the development description"
-        },
-        "appellantCostsAppliedFor": {
-          "type": ["boolean", "null"],
-          "description": "Indicates if the appellant has applied for costs"
-        }
-      }
-    }
-  ]
-}