@planning-inspectorate/data-model 2.22.0 → 2.23.0

package/package.json

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

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

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/appeal-planning-obligation.submission.schema.json",
+  "title": "Planning obligation specific properties",
+  "description": "Schema defining any properties for planning obligation",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["planningObligation", "statusPlanningObligation"],
+  "properties": {
+    "planningObligation": {
+      "type": ["boolean", "null"],
+      "description": "Indicates the existence of a planning obligation"
+    },
+    "statusPlanningObligation": {
+      "type": ["string", "null"],
+      "enum": ["finalised", "not_started", null],
+      "description": "The planning obligation information, if available"
+    }
+  }
+}

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

@@ -14,8 +14,6 @@
     "appellantProcedurePreferenceDetails",
     "appellantProcedurePreferenceDuration",
     "appellantProcedurePreferenceWitnessCount",
-    "planningObligation",
-    "statusPlanningObligation",
     "developmentType"
   ],
   "allOf": [
@@ -54,14 +52,6 @@
           "type": ["number", "null"],
           "description": "The number of witnesses in inquiries"
         },
-        "planningObligation": {
-          "type": ["boolean", "null"],
-          "description": "Indicates the existence of a planning obligation"
-        },
-        "statusPlanningObligation": {
-          "type": ["string", "null"],
-          "description": "The planning obligation information, if available"
-        },
         "developmentType": {
           "type": ["string", "null"],
           "enum": [

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

@@ -32,6 +32,7 @@
             { "$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/appeal-planning-obligation.submission.schema.json" },
             { "$ref": "appeals-components/appellant-procedure-preference.schema.json" }
           ]
         },
@@ -72,6 +73,7 @@
             { "$ref": "appeals-components/appeal-common-submission.schema.json" },
             { "$ref": "appeals-components/appeal-common-planning.schema.json" },
             { "$ref": "appeals-components/appellant-procedure-preference.schema.json" },
+            { "$ref": "appeals-components/appeal-planning-obligation.submission.schema.json" },
             { "$ref": "appeals-components/appeal-ldc.submission.schema.json" }
           ]
         },

package/src/schemas.d.ts

@@ -3706,14 +3706,6 @@ export type AppellantS78SubmissionProperties = {
    * The number of witnesses in inquiries
    */
   appellantProcedurePreferenceWitnessCount?: number | null;
-  /**
-   * Indicates the existence of a planning obligation
-   */
-  planningObligation?: boolean | null;
-  /**
-   * The planning obligation information, if available
-   */
-  statusPlanningObligation?: string | null;
   developmentType?:
     | 'householder'
     | 'change-of-use'
@@ -3772,6 +3764,7 @@ export interface AppellantSubmissionCommand {
         SiteAreaProperties &
         AppealLandOwnershipProperties &
         AppellantS78SubmissionProperties &
+        PlanningObligationSpecificProperties &
         AppellantProcedurePreferenceProperties)
     | ({
         caseType?: 'ZA';
@@ -3796,6 +3789,7 @@ export interface AppellantSubmissionCommand {
       } & AppellantCommonSubmissionProperties &
         AppellantCommonPlanningProperties &
         AppellantProcedurePreferenceProperties &
+        PlanningObligationSpecificProperties &
         LDCSpecificProperties)
     | ({
         caseType?: 'F';
@@ -3987,6 +3981,20 @@ export interface SiteAreaProperties {
   floorSpaceSquareMetres: number | null;
   [k: string]: unknown;
 }
+/**
+ * Schema defining any properties for planning obligation
+ */
+export interface PlanningObligationSpecificProperties {
+  /**
+   * Indicates the existence of a planning obligation
+   */
+  planningObligation: boolean | null;
+  /**
+   * The planning obligation information, if available
+   */
+  statusPlanningObligation: 'finalised' | 'not_started' | null;
+  [k: string]: unknown;
+}
 /**
  * Schema defining any properties for advertisement appeals
  */

package/tests/appeals/commands/ldc-submission.test.js

@@ -63,6 +63,8 @@ const exampleLDCSubmissionSchema = {
 		appellantProcedurePreferenceDetails: 'eiusmod ex exercitation',
 		appellantProcedurePreferenceDuration: 10816414.941069126,
 		appellantProcedurePreferenceWitnessCount: -91300569.36444478,
+		planningObligation: true,
+		statusPlanningObligation: 'finalised',
 		siteUseAtTimeOfApplication: 'residential',
 		applicationMadeUnderActSection: 'existing-development'
 	},

package/tests/appeals/commands/s78-submission.test.js

@@ -71,8 +71,8 @@ const exampleS78SubmissionSchema = {
 		appellantProcedurePreferenceDetails: 'eiusmod ex exercitation',
 		appellantProcedurePreferenceDuration: 10816414.941069126,
 		appellantProcedurePreferenceWitnessCount: -91300569.36444478,
-		planningObligation: false,
-		statusPlanningObligation: 'proident aute',
+		planningObligation: true,
+		statusPlanningObligation: 'finalised',
 		developmentType: 'change-of-use'
 	},
 	documents: [document],