@planning-inspectorate/data-model 2.23.0 → 2.25.0

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

@@ -0,0 +1,183 @@
+import { describe, it } from 'node:test';
+import { collectEnumProps, generateConstants, generateEnumMap } from './gen-enum-impl.js';
+import assert from 'node:assert';
+
+describe('gen-enum-impl', () => {
+	describe('generateConstants', () => {
+		it('should generate constant definitions', () => {
+			const output = generateConstants('some_EnumValue', ['value-1', 'other-value', 'a-third-value']);
+			assert.strictEqual(
+				output,
+				`export const SOME_ENUM_VALUE = Object.freeze({\n  A_THIRD_VALUE: 'a-third-value',\n  OTHER_VALUE: 'other-value',\n  VALUE_1: 'value-1',\n});`
+			);
+		});
+		it('should generate constant definitions as typescript', () => {
+			const output = generateConstants('some_EnumValue', ['value-1', 'other-value', 'a-third-value'], { ts: true });
+			assert.strictEqual(
+				output,
+				`export const SOME_ENUM_VALUE = {\n  A_THIRD_VALUE: 'a-third-value',\n  OTHER_VALUE: 'other-value',\n  VALUE_1: 'value-1',\n} as const;`
+			);
+		});
+	});
+
+	describe('generateEnumMap', () => {
+		it('should add all enums to a map by key with prefix', () => {
+			const enums = [
+				{
+					schemaName: 'schema-1',
+					key: 'key3',
+					values: ['enum-1', 'enum-2']
+				},
+				{
+					schemaName: 'appeal-1.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5']
+				},
+				{
+					schemaName: 'nsip-1.schema.json',
+					key: 'key5',
+					values: ['enum-6', 'enum-7']
+				}
+			];
+			const map = generateEnumMap(enums);
+			assert.deepStrictEqual(map, {
+				appeal_key5: ['enum-4', 'enum-5'],
+				nsip_key5: ['enum-6', 'enum-7'],
+				key3: ['enum-1', 'enum-2']
+			});
+		});
+		it('should ignore duplicates if the enums match', () => {
+			const enums = [
+				{
+					schemaName: 'schema-1',
+					key: 'key3',
+					values: ['enum-1', 'enum-2']
+				},
+				{
+					schemaName: 'appeal-1.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5']
+				},
+				{
+					schemaName: 'appeal-2.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5']
+				}
+			];
+			const map = generateEnumMap(enums);
+			assert.deepStrictEqual(map, {
+				appeal_key5: ['enum-4', 'enum-5'],
+				key3: ['enum-1', 'enum-2']
+			});
+		});
+		it('should add a more specific prefix if there is a duplicate key', () => {
+			const enums = [
+				{
+					schemaName: 'schema-1',
+					key: 'key3',
+					values: ['enum-1', 'enum-2']
+				},
+				{
+					schemaName: 'appeal-1.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5']
+				},
+				{
+					schemaName: 'appeal-2.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5', 'enum-6']
+				}
+			];
+			const map = generateEnumMap(enums);
+			assert.deepStrictEqual(map, {
+				appeal_key5: ['enum-4', 'enum-5', 'enum-6'],
+				'appeal-1_key5': ['enum-4', 'enum-5'],
+				key3: ['enum-1', 'enum-2']
+			});
+		});
+		it('should error if duplicate key enums are not a superset', () => {
+			const enums = [
+				{
+					schemaName: 'schema-1',
+					key: 'key3',
+					values: ['enum-1', 'enum-2']
+				},
+				{
+					schemaName: 'appeal-1.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5']
+				},
+				{
+					schemaName: 'appeal-2.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-6']
+				}
+			];
+			assert.throws(() => generateEnumMap(enums), { message: /not a superset of the other/ });
+		});
+		it('should error if duplicate keys are present more than twice', () => {
+			const enums = [
+				{
+					schemaName: 'schema-1',
+					key: 'key3',
+					values: ['enum-1', 'enum-2']
+				},
+				{
+					schemaName: 'appeal-1.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5']
+				},
+				{
+					schemaName: 'appeal-2.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5', 'enum-6']
+				},
+				{
+					schemaName: 'appeal-2.schema.json',
+					key: 'key5',
+					values: ['enum-4', 'enum-5', 'enum-6', 'enum-7']
+				}
+			];
+			assert.throws(() => generateEnumMap(enums), { message: /used by multiple schemas/ });
+		});
+	});
+
+	describe('collectEnumProps', () => {
+		it('should collect all enums', () => {
+			const enums = [];
+			collectEnumProps(
+				enums,
+				{
+					key1: 'value-1',
+					key2: 'other-value',
+					key3: {
+						type: 'string',
+						enum: ['enum-1', 'enum-2']
+					}
+				},
+				'schema-1'
+			);
+			collectEnumProps(
+				enums,
+				{
+					key5: {
+						type: 'string',
+						enum: ['enum-4', 'enum-5']
+					}
+				},
+				'appeal-1.schema.json'
+			);
+			assert.strictEqual(enums.length, 2);
+			assert.deepStrictEqual(enums[0], {
+				schemaName: 'schema-1',
+				key: 'key3',
+				values: ['enum-1', 'enum-2']
+			});
+			assert.deepStrictEqual(enums[1], {
+				schemaName: 'appeal-1.schema.json',
+				key: 'key5',
+				values: ['enum-4', 'enum-5']
+			});
+		});
+	});
+});

package/src/lib/gen-enums.js

@@ -1,16 +1,14 @@
 import fs from 'fs/promises';
 import path from 'path';
-import url from 'url';
 import { loadAllSchemas } from '../index.js';
-import snakeCase from 'lodash.snakecase';
 import { loadSchema } from './load.js';
+import { collectEnumProps, generateConstants, generateEnumMap } from './gen-enum-impl.js';
 
-const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+const __dirname = import.meta.dirname;
 
 export const constPath = path.join(__dirname, '..', 'enums.js');
 export const constTsPath = path.join(__dirname, '..', 'enums.d.ts');
 
-const SPACING = '  ';
 const NEW_LINE = '\n';
 
 /**
@@ -19,16 +17,17 @@ const NEW_LINE = '\n';
 async function run() {
 	const s = await loadAllSchemas();
 
-	/** @type {Object<string, string[]>} */
-	const enumProps = {};
+	const allEnums = [];
 
 	for (const schemaName of Object.keys(s.schemas).sort()) {
 		const schema = s.schemas[schemaName];
-		collectEnumProps(enumProps, schema.properties, schemaPrefix(schemaName));
+		collectEnumProps(allEnums, schema.properties, schemaName);
 	}
 
 	const staticEnums = await loadSchema(path.join(__dirname, 'enums-static.schema.json'));
-	collectEnumProps(enumProps, staticEnums.properties, 'message');
+	collectEnumProps(allEnums, staticEnums.properties, 'message');
+
+	const enumProps = generateEnumMap(allEnums);
 
 	let output = '';
 	let tsOutput = '';
@@ -42,82 +41,7 @@ async function run() {
 	await fs.writeFile(constTsPath, tsOutput);
 }
 
-/**
- * Generate JS code to define exported constants for the given enum values
- *
- * @param {string} name
- * @param {string[]} values
- * @param {Object} opts
- * @param {boolean} [opts.ts] - whether to generate the TS type or JS code
- * @returns {string}
- */
-function generateConstants(name, values, { ts = false } = {}) {
-	const freezeStart = ts ? '' : 'Object.freeze(';
-	const freezeEnd = ts ? ' as const' : ')';
-	const exportPrefix = 'export ';
-	const lines = [`${exportPrefix}const ${formatName(name)} = ${freezeStart}{`];
-	/**
-	 * @param {string} line
-	 * @param {number} spacing
-	 */
-	const addWithSpace = (line, spacing = 0) => lines.push(SPACING.repeat(spacing) + line);
-
-	for (const value of values.sort()) {
-		addWithSpace(`${formatName(value)}: '${value}',`, 1);
-	}
-
-	lines.push(`}${freezeEnd};`);
-
-	return lines.join(NEW_LINE);
-}
-
-/**
- * Format a name for use as a constant value: UPPER_SNAKE_CASE
- *
- * @param {string} name
- * @returns {string}
- */
-function formatName(name) {
-	return snakeCase(name).toUpperCase();
-}
-
-/**
- *
- * @param {Object<string, string[]>} map
- * @param {Object<string, {type?: string|string[], enum?: string[]}>} properties
- * @param {string} [prefix]
- */
-function collectEnumProps(map, properties = {}, prefix) {
-	for (const [key, prop] of Object.entries(properties)) {
-		const name = prefix ? prefix + '_' + key : key;
-
-		const hasStringEnum = (p) =>
-			p && p.enum && Array.isArray(p.enum) && p.type && (p.type === 'string' || p.type.includes('string'));
-		const getEnumValues = (p) => p.filter((e) => e !== null);
-		const collectEnumFromProp = (p) => {
-			if (hasStringEnum(p)) {
-				map[name] = getEnumValues(p.enum);
-			}
-		};
-
-		collectEnumFromProp(prop);
-		collectEnumFromProp(prop.items);
-	}
-}
-
-/**
- * Generate a prefix based on the schema name
- *
- * @param {string} schemaName
- * @returns {string|undefined}
- */
-function schemaPrefix(schemaName) {
-	if (schemaName.toLowerCase().includes('appeal')) {
-		return 'appeal';
-	}
-	if (schemaName.toLowerCase().includes('nsip')) {
-		return 'nsip';
-	}
-}
-
-run().catch(console.error);
+run().catch((err) => {
+	console.error(err);
+	process.exit(1);
+});

package/src/schemas.d.ts

@@ -526,6 +526,10 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
    * The date of the original LPA decision
    */
   applicationDecisionDate: string | null;
+  /**
+   * The date that an application decision is due
+   */
+  applicationDecisionDueDate?: string | null;
   /**
    * The statutory deadline for submitting an appeal from the original LPA decision date
    */
@@ -685,7 +689,7 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
   /**
    * The methods used to notify relevant parties
    */
-  notificationMethod: ('notice' | 'letter' | 'advert')[] | null;
+  notificationMethod: ('notice' | 'letter' | 'advert' | 'not_notified')[] | null;
   /**
    * Indicates if the appellant has informed other owners of the site
    */
@@ -1132,6 +1136,10 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
    * The date of the original LPA decision
    */
   applicationDecisionDate: string | null;
+  /**
+   * The date that an application decision is due
+   */
+  applicationDecisionDueDate?: string | null;
   /**
    * The statutory deadline for submitting an appeal from the original LPA decision date
    */
@@ -1207,7 +1215,7 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
   /**
    * The methods used to notify relevant parties
    */
-  notificationMethod: ('notice' | 'letter' | 'advert')[] | null;
+  notificationMethod: ('notice' | 'letter' | 'advert' | 'not_notified')[] | null;
   /**
    * Indicates if the appellant has informed other owners of the site
    */
@@ -1458,6 +1466,10 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
   proofsOfEvidenceDueDate: string | null;
   siteNoticesSentDate: string | null;
   statementDueDate: string | null;
+  /**
+   * The date of the Case Management Conference (CMC)
+   */
+  caseManagementConferenceDate?: string | null;
   /**
    * The net gain in residences of the proposed development
    */
@@ -4601,7 +4613,7 @@ export type LPAQCasAdvertSubmissionProperties = {
   didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
 };
 /**
- * Schema defining any enfrocement specific properties for LPAQ submissions
+ * Schema defining any common enforcement specific properties for LPAQ submissions
  */
 export type LPAQEnforcementSubmissionProperties = {
   noticeRelatesToBuildingEngineeringMiningOther?: boolean | null;
@@ -4623,6 +4635,11 @@ export type LPAQEnforcementSubmissionProperties = {
   relatesToErectionOfBuildingOrBuildings?: boolean | null;
   relatesToBuildingWithAgriculturalPurpose?: boolean | null;
   relatesToBuildingSingleDwellingHouse?: boolean | null;
+};
+/**
+ * Schema defining any enforcement specific properties for LPAQ submissions
+ */
+export type LPAQEnforcementSubmissionProperties1 = {
   /**
    * Name of trunk road within 67M of site
    */
@@ -4693,7 +4710,7 @@ export interface LPAQuestionnaireCommand {
         LPAProcedurePreferenceProperties &
         ChangedListedBuildingNumbersProperties)
     | ({
-        caseType?: 'C' | 'F';
+        caseType?: 'C';
       } & LPAQCommonSubmissionProperties &
         LPAQHASSubmissionProperties &
         LPAProcedurePreferenceProperties &
@@ -4701,13 +4718,25 @@ export interface LPAQuestionnaireCommand {
         InfrastructureLevyProperties &
         EnvironmentalImpactAssessmentProperties &
         SiteDesignationsAndProtectionSpecificProperties &
-        LPAQEnforcementSubmissionProperties)
+        LPAQEnforcementSubmissionProperties &
+        LPAQEnforcementSubmissionProperties1)
     | ({
         caseType?: 'X';
       } & LPAQCommonSubmissionProperties &
         LPAProcedurePreferenceProperties &
         InfrastructureLevyProperties &
-        LPAQLDCSubmissionProperties);
+        LPAQLDCSubmissionProperties)
+    | ({
+        caseType?: 'F';
+      } & LPAQCommonSubmissionProperties &
+        LPAQHASSubmissionProperties &
+        LPAProcedurePreferenceProperties &
+        ChangedListedBuildingNumbersProperties &
+        InfrastructureLevyProperties &
+        EnvironmentalImpactAssessmentProperties &
+        SiteDesignationsAndProtectionSpecificProperties &
+        LPAQEnforcementSubmissionProperties &
+        LPAQListedBuildingSubmissionProperties);
   documents: {
     /**
      * The unique identifier for the document

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

@@ -58,6 +58,7 @@ const appealHas = {
 	applicationDate: '1949-08-25T15:11:02.0Z',
 	applicationDecision: 'refused',
 	applicationDecisionDate: '1952-08-09T01:03:51.0Z',
+	applicationDecisionDueDate: null,
 	caseSubmissionDueDate: '1942-02-09T21:03:07.0Z',
 	siteAddressLine1: 'ullamco',
 	siteAddressLine2: null,

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

@@ -52,6 +52,7 @@ const appealS78 = {
 	applicationDate: '1910-07-16T04:24:14.0Z',
 	applicationDecision: 'not_received',
 	applicationDecisionDate: null,
+	applicationDecisionDueDate: '1952-08-09T01:03:51.0Z',
 	caseSubmissionDueDate: null,
 	siteAddressLine1: 'dolore mollit',
 	siteAddressLine2: null,
@@ -145,6 +146,7 @@ const appealS78 = {
 	proofsOfEvidenceDueDate: '1945-06-24T01:14:05.0Z',
 	siteNoticesSentDate: '1904-03-09T08:52:39.0Z',
 	statementDueDate: null,
+	caseManagementConferenceDate: '1904-03-09T08:52:39.0Z',
 	numberOfResidencesNetChange: 59800248.893144846,
 	siteGridReferenceEasting: '357144',
 	siteGridReferenceNorthing: '400534',

package/tests/appeals/commands/enforcement-listed-questionnaire.test.js

@@ -71,9 +71,8 @@ const exampleEnforcementListedQuestionnaireSchema = {
 		relatesToErectionOfBuildingOrBuildings: null,
 		relatesToBuildingWithAgriculturalPurpose: null,
 		relatesToBuildingSingleDwellingHouse: null,
-		affectedTrunkRoadName: null,
-		isSiteOnCrownLand: null,
-		article4AffectedDevelopmentRights: null
+		preserveGrantLoan: null,
+		consultHistoricEngland: null
 	},
 	documents: [document]
 };