@planning-inspectorate/data-model 2.48.0 → 2.48.1

package/package.json

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

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',
@@ -831,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;
@@ -868,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',
@@ -829,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',
@@ -829,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',
@@ -912,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');
@@ -981,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/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
 		];