@planning-inspectorate/data-model 2.46.0 → 2.48.0

package/docs/appeal-document.md

@@ -632,6 +632,10 @@ The type of document, used for exchange, migrations and consumption from the app
 | `"designAccessStatementLPA"`           |             |
 | `"plansDrawingsLPA"`                   |             |
 | `"additionalDocumentsLPA"`             |             |
+| `"generalSupporting"`                  |             |
+| `"hearingProcess"`                     |             |
+| `"inquiryCore"`                        |             |
+| `"inquiryPostEvent"`                   |             |
 | `null`                                 |             |
 
 ## sourceSystem

package/docs/appeal-has.md

@@ -2514,6 +2514,7 @@ Indicates if the appellant has applied for costs
 | `"minor-commercial-development"`       |             |
 | `"advertisement"`                      |             |
 | `"lawful-development-certificate"`     |             |
+| `"permission-in-principle"`            |             |
 | `null`                                 |             |
 
 ## siteGridReferenceEasting

package/docs/appeal-s78.md

@@ -3692,6 +3692,7 @@ The net gain in residences of the proposed development
 | `"advertisement"`                      |             |
 | `"lawful-development-certificate"`     |             |
 | `"discontinuance-notice"`              |             |
+| `"permission-in-principle"`            |             |
 | `null`                                 |             |
 
 ## developmentType

package/package.json

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

package/pins_data_model/models/model_appeal_document.py

@@ -153,6 +153,10 @@ class DocumentType(Enum):
     designAccessStatementLPA = "designAccessStatementLPA"
     plansDrawingsLPA = "plansDrawingsLPA"
     additionalDocumentsLPA = "additionalDocumentsLPA"
+    generalSupporting = "generalSupporting"
+    hearingProcess = "hearingProcess"
+    inquiryCore = "inquiryCore"
+    inquiryPostEvent = "inquiryPostEvent"
     NoneType_None = None
 
 

package/pins_data_model/models/model_appeal_has.py

@@ -230,6 +230,7 @@ class TypeOfPlanningApplication(Enum):
     minor_commercial_development = "minor-commercial-development"
     advertisement = "advertisement"
     lawful_development_certificate = "lawful-development-certificate"
+    permission_in_principle = "permission-in-principle"
     NoneType_None = None
 
 

package/pins_data_model/models/model_appeal_s78.py

@@ -285,6 +285,7 @@ class TypeOfPlanningApplication(Enum):
     advertisement = "advertisement"
     lawful_development_certificate = "lawful-development-certificate"
     discontinuance_notice = "discontinuance-notice"
+    permission_in_principle = "permission-in-principle"
     NoneType_None = None
 
 

package/schemas/appeal-document.schema.json

@@ -232,6 +232,10 @@
         "designAccessStatementLPA",
         "plansDrawingsLPA",
         "additionalDocumentsLPA",
+        "generalSupporting",
+        "hearingProcess",
+        "inquiryCore",
+        "inquiryPostEvent",
         null
       ],
       "description": "The type of document, used for exchange, migrations and consumption from the appeal back-office system"

package/schemas/appeal-has.schema.json

@@ -709,6 +709,7 @@
         "minor-commercial-development",
         "advertisement",
         "lawful-development-certificate",
+        "permission-in-principle",
         null
       ]
     },

package/schemas/appeal-s78.schema.json

@@ -1046,6 +1046,7 @@
         "advertisement",
         "lawful-development-certificate",
         "discontinuance-notice",
+        "permission-in-principle",
         null
       ]
     },

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

@@ -140,6 +140,7 @@
         "minor-commercial-development",
         "advertisement",
         "lawful-development-certificate",
+        "permission-in-principle",
         null
       ]
     },

package/src/enums.cjs

@@ -37,6 +37,7 @@ const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',
@@ -222,6 +223,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
   ENFORCEMENT_NOTICE: 'enforcementNotice',
   ENFORCEMENT_NOTICE_PLAN: 'enforcementNoticePlan',
   ENVIRONMENTAL_ASSESSMENT: 'environmentalAssessment',
+  GENERAL_SUPPORTING: 'generalSupporting',
   GROUND_A_FEE_RECEIPT: 'groundAFeeReceipt',
   GROUND_A_SUPPORTING: 'groundASupporting',
   GROUND_B_SUPPORTING: 'groundBSupporting',
@@ -234,7 +236,10 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
   GROUND_I_SUPPORTING: 'groundISupporting',
   GROUND_J_SUPPORTING: 'groundJSupporting',
   GROUND_K_SUPPORTING: 'groundKSupporting',
+  HEARING_PROCESS: 'hearingProcess',
   HISTORIC_ENGLAND_CONSULTATION: 'historicEnglandConsultation',
+  INQUIRY_CORE: 'inquiryCore',
+  INQUIRY_POST_EVENT: 'inquiryPostEvent',
   INSPECTOR_CORRESPONDENCE: 'inspectorCorrespondence',
   INTERESTED_PARTY_COMMENT: 'interestedPartyComment',
   LOCAL_DEVELOPMENT_ORDER: 'localDevelopmentOrder',
@@ -426,6 +431,7 @@ const APPEAL_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',

package/src/enums.d.ts

@@ -35,6 +35,7 @@ export const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = {
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',
@@ -220,6 +221,7 @@ export const APPEAL_DOCUMENT_TYPE = {
   ENFORCEMENT_NOTICE: 'enforcementNotice',
   ENFORCEMENT_NOTICE_PLAN: 'enforcementNoticePlan',
   ENVIRONMENTAL_ASSESSMENT: 'environmentalAssessment',
+  GENERAL_SUPPORTING: 'generalSupporting',
   GROUND_A_FEE_RECEIPT: 'groundAFeeReceipt',
   GROUND_A_SUPPORTING: 'groundASupporting',
   GROUND_B_SUPPORTING: 'groundBSupporting',
@@ -232,7 +234,10 @@ export const APPEAL_DOCUMENT_TYPE = {
   GROUND_I_SUPPORTING: 'groundISupporting',
   GROUND_J_SUPPORTING: 'groundJSupporting',
   GROUND_K_SUPPORTING: 'groundKSupporting',
+  HEARING_PROCESS: 'hearingProcess',
   HISTORIC_ENGLAND_CONSULTATION: 'historicEnglandConsultation',
+  INQUIRY_CORE: 'inquiryCore',
+  INQUIRY_POST_EVENT: 'inquiryPostEvent',
   INSPECTOR_CORRESPONDENCE: 'inspectorCorrespondence',
   INTERESTED_PARTY_COMMENT: 'interestedPartyComment',
   LOCAL_DEVELOPMENT_ORDER: 'localDevelopmentOrder',
@@ -424,6 +429,7 @@ export const APPEAL_TYPE_OF_PLANNING_APPLICATION = {
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',

package/src/enums.js

@@ -35,6 +35,7 @@ export const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',
@@ -220,6 +221,7 @@ export const APPEAL_DOCUMENT_TYPE = Object.freeze({
   ENFORCEMENT_NOTICE: 'enforcementNotice',
   ENFORCEMENT_NOTICE_PLAN: 'enforcementNoticePlan',
   ENVIRONMENTAL_ASSESSMENT: 'environmentalAssessment',
+  GENERAL_SUPPORTING: 'generalSupporting',
   GROUND_A_FEE_RECEIPT: 'groundAFeeReceipt',
   GROUND_A_SUPPORTING: 'groundASupporting',
   GROUND_B_SUPPORTING: 'groundBSupporting',
@@ -232,7 +234,10 @@ export const APPEAL_DOCUMENT_TYPE = Object.freeze({
   GROUND_I_SUPPORTING: 'groundISupporting',
   GROUND_J_SUPPORTING: 'groundJSupporting',
   GROUND_K_SUPPORTING: 'groundKSupporting',
+  HEARING_PROCESS: 'hearingProcess',
   HISTORIC_ENGLAND_CONSULTATION: 'historicEnglandConsultation',
+  INQUIRY_CORE: 'inquiryCore',
+  INQUIRY_POST_EVENT: 'inquiryPostEvent',
   INSPECTOR_CORRESPONDENCE: 'inspectorCorrespondence',
   INTERESTED_PARTY_COMMENT: 'interestedPartyComment',
   LOCAL_DEVELOPMENT_ORDER: 'localDevelopmentOrder',
@@ -424,6 +429,7 @@ export const APPEAL_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',

package/src/index.cjs

@@ -118,6 +118,7 @@ const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',
@@ -303,6 +304,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
   ENFORCEMENT_NOTICE: 'enforcementNotice',
   ENFORCEMENT_NOTICE_PLAN: 'enforcementNoticePlan',
   ENVIRONMENTAL_ASSESSMENT: 'environmentalAssessment',
+  GENERAL_SUPPORTING: 'generalSupporting',
   GROUND_A_FEE_RECEIPT: 'groundAFeeReceipt',
   GROUND_A_SUPPORTING: 'groundASupporting',
   GROUND_B_SUPPORTING: 'groundBSupporting',
@@ -315,7 +317,10 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
   GROUND_I_SUPPORTING: 'groundISupporting',
   GROUND_J_SUPPORTING: 'groundJSupporting',
   GROUND_K_SUPPORTING: 'groundKSupporting',
+  HEARING_PROCESS: 'hearingProcess',
   HISTORIC_ENGLAND_CONSULTATION: 'historicEnglandConsultation',
+  INQUIRY_CORE: 'inquiryCore',
+  INQUIRY_POST_EVENT: 'inquiryPostEvent',
   INSPECTOR_CORRESPONDENCE: 'inspectorCorrespondence',
   INTERESTED_PARTY_COMMENT: 'interestedPartyComment',
   LOCAL_DEVELOPMENT_ORDER: 'localDevelopmentOrder',
@@ -507,6 +512,7 @@ const APPEAL_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
+  PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',

package/src/schemas.d.ts

@@ -180,6 +180,10 @@ export interface AppealDocument {
     | 'designAccessStatementLPA'
     | 'plansDrawingsLPA'
     | 'additionalDocumentsLPA'
+    | 'generalSupporting'
+    | 'hearingProcess'
+    | 'inquiryCore'
+    | 'inquiryPostEvent'
     | null;
   /**
    * The system mastering the metadata for the current document
@@ -785,6 +789,7 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
     | 'minor-commercial-development'
     | 'advertisement'
     | 'lawful-development-certificate'
+    | 'permission-in-principle'
     | null;
   siteGridReferenceEasting?: string | null;
   siteGridReferenceNorthing?: string | null;
@@ -1528,6 +1533,7 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
     | 'advertisement'
     | 'lawful-development-certificate'
     | 'discontinuance-notice'
+    | 'permission-in-principle'
     | null;
   developmentType:
     | 'householder'
@@ -3733,6 +3739,7 @@ export type AppellantCommonSubmissionProperties = (
     | 'minor-commercial-development'
     | 'advertisement'
     | 'lawful-development-certificate'
+    | 'permission-in-principle'
     | null;
   /**
    * Indicates if the appellant has applied for costs

package/tests/appeals/appeal-has.test.js

@@ -322,4 +322,11 @@ describe(schema, () => {
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, true);
 	});
+
+	it('should allow permission-in-principle for typeOfPlanningApplication', () => {
+		const test = structuredClone(appealHas);
+		test.typeOfPlanningApplication = 'permission-in-principle';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
 });

package/tests/appeals/appeal-s78.test.js

@@ -276,4 +276,11 @@ describe(schema, () => {
 			assert.strictEqual(validationResult, true);
 		});
 	});
+
+	it('should allow permission-in-principle for typeOfPlanningApplication', () => {
+		const test = structuredClone(appealS78);
+		test.typeOfPlanningApplication = 'permission-in-principle';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
 });

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

@@ -93,6 +93,15 @@ describe('HAS submission command schema', () => {
 		assert.strictEqual(validationResult, true);
 	});
 
+	it('should allow permission-in-principle for typeOfPlanningApplication', () => {
+		const test = structuredClone(exampleHasSubmissionSchema);
+		test.casedata.typeOfPlanningApplication = 'permission-in-principle';
+
+		const validationResult = ajv.validate(schema, test);
+
+		assert.strictEqual(validationResult, true);
+	});
+
 	it('should enforce eastings-northings pattern', () => {
 		const invalidPatterns = [
 			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },

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

@@ -97,6 +97,13 @@ describe('S78 submission command schema', () => {
 		assert.strictEqual(validationResult, true);
 	});
 
+	it('should allow permission-in-principle for typeOfPlanningApplication', () => {
+		const test = structuredClone(exampleS78SubmissionSchema);
+		test.casedata.typeOfPlanningApplication = 'permission-in-principle';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
 	it('should enforce eastings-northings pattern', () => {
 		const invalidPatterns = [
 			{ easting: 'abc123', northing: '400534', description: 'easting with letters' },