@planning-inspectorate/data-model 2.47.0 → 2.48.1

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.47.0",
+  "version": "2.48.1",
   "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/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/src/enums.cjs

@@ -43,6 +43,12 @@ const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   RESERVED_MATTERS: 'reserved-matters',
 });
 
+const APPEAL_UNDER_ACT_SECTION = Object.freeze({
+  EXISTING_DEVELOPMENT: 'existing-development',
+  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
+  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
+});
+
 const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   A: 'A',
   B: 'B',
@@ -54,12 +60,6 @@ const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   H: 'H',
 });
 
-const APPEAL_APPEAL_UNDER_ACT_SECTION = Object.freeze({
-  EXISTING_DEVELOPMENT: 'existing-development',
-  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
-  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
-});
-
 const APPEAL_APPELLANT_PROCEDURE_PREFERENCE = Object.freeze({
   HEARING: 'hearing',
   INQUIRY: 'inquiry',
@@ -223,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',
@@ -235,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',
@@ -827,6 +831,9 @@ const STATUS = Object.freeze({
   UNCHECKED: 'unchecked',
 });
 
+/** @deprecated use APPEAL_UNDER_ACT_SECTION **/
+const APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;
+
 exports.APPEAL_ALLOCATION_LEVEL = APPEAL_ALLOCATION_LEVEL;
 exports.APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_APPEAL_UNDER_ACT_SECTION;
 exports.APPEAL_APPELLANT_PROCEDURE_PREFERENCE = APPEAL_APPELLANT_PROCEDURE_PREFERENCE;
@@ -864,6 +871,7 @@ exports.APPEAL_REPRESENTATION_TYPE = APPEAL_REPRESENTATION_TYPE;
 exports.APPEAL_SOURCE = APPEAL_SOURCE;
 exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
 exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
+exports.APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;
 exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
 exports.APPLICATION_UPDATE_STATUS = APPLICATION_UPDATE_STATUS;
 exports.CASE_STAGE = CASE_STAGE;

package/src/enums.d.ts

@@ -41,6 +41,12 @@ export const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = {
   RESERVED_MATTERS: 'reserved-matters',
 } as const;
 
+export const APPEAL_UNDER_ACT_SECTION = {
+  EXISTING_DEVELOPMENT: 'existing-development',
+  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
+  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
+} as const;
+
 export const APPEAL_ALLOCATION_LEVEL = {
   A: 'A',
   B: 'B',
@@ -52,12 +58,6 @@ export const APPEAL_ALLOCATION_LEVEL = {
   H: 'H',
 } as const;
 
-export const APPEAL_APPEAL_UNDER_ACT_SECTION = {
-  EXISTING_DEVELOPMENT: 'existing-development',
-  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
-  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
-} as const;
-
 export const APPEAL_APPELLANT_PROCEDURE_PREFERENCE = {
   HEARING: 'hearing',
   INQUIRY: 'inquiry',
@@ -221,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',
@@ -233,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',
@@ -825,3 +829,5 @@ export const STATUS = {
   UNCHECKED: 'unchecked',
 } as const;
 
+/** @deprecated use APPEAL_UNDER_ACT_SECTION **/
+export const APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;

package/src/enums.js

@@ -41,6 +41,12 @@ export const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   RESERVED_MATTERS: 'reserved-matters',
 });
 
+export const APPEAL_UNDER_ACT_SECTION = Object.freeze({
+  EXISTING_DEVELOPMENT: 'existing-development',
+  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
+  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
+});
+
 export const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   A: 'A',
   B: 'B',
@@ -52,12 +58,6 @@ export const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   H: 'H',
 });
 
-export const APPEAL_APPEAL_UNDER_ACT_SECTION = Object.freeze({
-  EXISTING_DEVELOPMENT: 'existing-development',
-  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
-  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
-});
-
 export const APPEAL_APPELLANT_PROCEDURE_PREFERENCE = Object.freeze({
   HEARING: 'hearing',
   INQUIRY: 'inquiry',
@@ -221,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',
@@ -233,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',
@@ -825,3 +829,5 @@ export const STATUS = Object.freeze({
   UNCHECKED: 'unchecked',
 });
 
+/** @deprecated use APPEAL_UNDER_ACT_SECTION **/
+export const APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;

package/src/index.cjs

@@ -124,6 +124,12 @@ const APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   RESERVED_MATTERS: 'reserved-matters',
 });
 
+const APPEAL_UNDER_ACT_SECTION = Object.freeze({
+  EXISTING_DEVELOPMENT: 'existing-development',
+  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
+  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
+});
+
 const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   A: 'A',
   B: 'B',
@@ -135,12 +141,6 @@ const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   H: 'H',
 });
 
-const APPEAL_APPEAL_UNDER_ACT_SECTION = Object.freeze({
-  EXISTING_DEVELOPMENT: 'existing-development',
-  PROPOSED_CHANGES_TO_A_LISTED_BUILDING: 'proposed-changes-to-a-listed-building',
-  PROPOSED_USE_OF_A_DEVELOPMENT: 'proposed-use-of-a-development',
-});
-
 const APPEAL_APPELLANT_PROCEDURE_PREFERENCE = Object.freeze({
   HEARING: 'hearing',
   INQUIRY: 'inquiry',
@@ -304,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',
@@ -316,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',
@@ -908,6 +912,9 @@ const STATUS = Object.freeze({
   UNCHECKED: 'unchecked',
 });
 
+/** @deprecated use APPEAL_UNDER_ACT_SECTION **/
+const APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;
+
 const __dirname$1 = path.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
 
 const schemasPath = path.join(__dirname$1, '..', 'schemas');
@@ -977,6 +984,7 @@ exports.APPEAL_REPRESENTATION_TYPE = APPEAL_REPRESENTATION_TYPE;
 exports.APPEAL_SOURCE = APPEAL_SOURCE;
 exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
 exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
+exports.APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;
 exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
 exports.APPLICATION_UPDATE_STATUS = APPLICATION_UPDATE_STATUS;
 exports.CASE_STAGE = CASE_STAGE;

package/src/lib/gen-enum-impl.js

@@ -57,7 +57,10 @@ export function generateEnumMap(enums) {
 
 	for (const e of enums) {
 		const prefix = schemaPrefix(e.schemaName);
-		const key = prefix ? prefix + '_' + e.key : e.key;
+		let key = e.key;
+		if (prefix && !key.startsWith(prefix)) {
+			key = prefix + '_' + key;
+		}
 
 		const existingEnum = enumProps[key];
 		const thisEnum = e.values;
@@ -187,6 +190,9 @@ export function schemaPrefix(schemaName) {
 	if (schemaName === 'message') {
 		return 'message';
 	}
+	if (schemaName.toLowerCase().includes('applications')) {
+		return 'application';
+	}
 	if (schemaName.toLowerCase().includes('appeal')) {
 		return 'appeal';
 	}

package/src/lib/gen-enums.js

@@ -37,6 +37,11 @@ async function run() {
 		tsOutput += generateConstants(name, enumProps[name], { ts: true }) + NEW_LINE.repeat(2);
 	}
 
+	// for backwards compatibility, to remove once APPEAL_APPEAL_UNDER_ACT_SECTION isn't referenced
+	const forCompatibility = `/** @deprecated use APPEAL_UNDER_ACT_SECTION **/${NEW_LINE}export const APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;`;
+	output += forCompatibility;
+	tsOutput += forCompatibility;
+
 	await fs.writeFile(constPath, output);
 	await fs.writeFile(constTsPath, tsOutput);
 }

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

package/tests/schemas.test.js

@@ -72,6 +72,7 @@ describe('schemas', () => {
 	it('should use the singular form for $id', () => {
 		// very crude test to ensure schemas don't end in 's'...
 		const suffixExceptions = [
+			'address',
 			'has', // allow has suffix for appeals
 			'listed-buildings' // allow this temporary schema, to remove when this schema copy is removed
 		];