@planning-inspectorate/data-model 2.23.0 → 2.25.0

package/schemas/commands/lpa-questionnaire.schema.json

@@ -71,9 +71,9 @@
           ]
         },
         {
-          "$comment": "Enforcement + Enforcement listed building",
+          "$comment": "Enforcement",
           "allOf": [
-            { "properties": { "caseType": { "enum": ["C", "F"] } } },
+            { "properties": { "caseType": { "enum": ["C"] } } },
             { "$ref": "appeals-components/lpa-questionnaire-common.schema.json" },
             { "$ref": "appeals-components/lpa-questionnaire-has.schema.json" },
             { "$ref": "appeals-components/lpa-procedure-preference.schema.json" },
@@ -81,6 +81,7 @@
             { "$ref": "appeals-components/infrastructure-levy.schema.json" },
             { "$ref": "appeals-components/environmental-impact-assessment.schema.json" },
             { "$ref": "appeals-components/site-designations-protection.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-enforcement-common.schema.json" },
             { "$ref": "appeals-components/lpa-questionnaire-enforcement.schema.json" }
           ]
         },
@@ -93,6 +94,21 @@
             { "$ref": "appeals-components/infrastructure-levy.schema.json" },
             { "$ref": "appeals-components/lpa-questionnaire-ldc.schema.json" }
           ]
+        },
+        {
+          "$comment": "Enforcement listed building",
+          "allOf": [
+            { "properties": { "caseType": { "enum": ["F"] } } },
+            { "$ref": "appeals-components/lpa-questionnaire-common.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-has.schema.json" },
+            { "$ref": "appeals-components/lpa-procedure-preference.schema.json" },
+            { "$ref": "appeals-components/changed-listed-building-number.schema.json" },
+            { "$ref": "appeals-components/infrastructure-levy.schema.json" },
+            { "$ref": "appeals-components/environmental-impact-assessment.schema.json" },
+            { "$ref": "appeals-components/site-designations-protection.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-enforcement-common.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-listed-building.schema.json" }
+          ]
         }
       ]
     },

package/src/enums.cjs

@@ -1,5 +1,34 @@
 'use strict';
 
+const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
+  ALLOWED: 'allowed',
+  DISMISSED: 'dismissed',
+  INVALID: 'invalid',
+  SPLIT_DECISION: 'split_decision',
+});
+
+const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
+  HEARING: 'hearing',
+  INQUIRY: 'inquiry',
+  WRITTEN: 'written',
+});
+
+const APPEAL_HAS_CASE_STATUS = Object.freeze({
+  ASSIGN_CASE_OFFICER: 'assign_case_officer',
+  AWAITING_EVENT: 'awaiting_event',
+  AWAITING_TRANSFER: 'awaiting_transfer',
+  CLOSED: 'closed',
+  COMPLETE: 'complete',
+  EVENT: 'event',
+  INVALID: 'invalid',
+  ISSUE_DETERMINATION: 'issue_determination',
+  LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  READY_TO_START: 'ready_to_start',
+  TRANSFERRED: 'transferred',
+  VALIDATION: 'validation',
+  WITHDRAWN: 'withdrawn',
+});
+
 const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   A: 'A',
   B: 'B',
@@ -312,6 +341,7 @@ const APPEAL_LPA_QUESTIONNAIRE_VALIDATION_OUTCOME = Object.freeze({
 const APPEAL_NOTIFICATION_METHOD = Object.freeze({
   ADVERT: 'advert',
   LETTER: 'letter',
+  NOT_NOTIFIED: 'not_notified',
   NOTICE: 'notice',
 });
 
@@ -409,6 +439,11 @@ const METHOD = Object.freeze({
   POST: 'post',
 });
 
+const NSIP_PROJECT_SOURCE_SYSTEM = Object.freeze({
+  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
+  HORIZON: 'horizon',
+});
+
 const NSIP_CA_AND_TP_EVIDENCE = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -654,8 +689,11 @@ const NSIP_SECURITY_CLASSIFICATION = Object.freeze({
 });
 
 const NSIP_SOURCE_SYSTEM = Object.freeze({
+  BACK_OFFICE_APPEALS: 'back-office-appeals',
   BACK_OFFICE_APPLICATIONS: 'back-office-applications',
   HORIZON: 'horizon',
+  NI_FILE: 'ni_file',
+  SHAREPOINT: 'sharepoint',
 });
 
 const NSIP_STAGE = Object.freeze({
@@ -761,6 +799,9 @@ exports.APPEAL_EIA_DEVELOPMENT_DESCRIPTION = APPEAL_EIA_DEVELOPMENT_DESCRIPTION;
 exports.APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE = APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE;
 exports.APPEAL_EVENT_STATUS = APPEAL_EVENT_STATUS;
 exports.APPEAL_EVENT_TYPE = APPEAL_EVENT_TYPE;
+exports.APPEAL_HAS_CASE_DECISION_OUTCOME = APPEAL_HAS_CASE_DECISION_OUTCOME;
+exports.APPEAL_HAS_CASE_PROCEDURE = APPEAL_HAS_CASE_PROCEDURE;
+exports.APPEAL_HAS_CASE_STATUS = APPEAL_HAS_CASE_STATUS;
 exports.APPEAL_INVALID_OR_INCOMPLETE_DETAILS = APPEAL_INVALID_OR_INCOMPLETE_DETAILS;
 exports.APPEAL_KNOWS_ALL_OWNERS = APPEAL_KNOWS_ALL_OWNERS;
 exports.APPEAL_KNOWS_OTHER_OWNERS = APPEAL_KNOWS_OTHER_OWNERS;
@@ -796,6 +837,7 @@ exports.NSIP_ORIGIN = NSIP_ORIGIN;
 exports.NSIP_PLANNING_INSPECTORATE_ROLE = NSIP_PLANNING_INSPECTORATE_ROLE;
 exports.NSIP_POLICY_COMPLIANCE_DOCUMENT = NSIP_POLICY_COMPLIANCE_DOCUMENT;
 exports.NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT = NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT;
+exports.NSIP_PROJECT_SOURCE_SYSTEM = NSIP_PROJECT_SOURCE_SYSTEM;
 exports.NSIP_PROJECT_TYPE = NSIP_PROJECT_TYPE;
 exports.NSIP_PUBLIC_SECTOR_EQUALITY_DUTY = NSIP_PUBLIC_SECTOR_EQUALITY_DUTY;
 exports.NSIP_PUBLISHED_STATUS = NSIP_PUBLISHED_STATUS;

package/src/enums.d.ts

@@ -1,3 +1,32 @@
+export const APPEAL_HAS_CASE_DECISION_OUTCOME = {
+  ALLOWED: 'allowed',
+  DISMISSED: 'dismissed',
+  INVALID: 'invalid',
+  SPLIT_DECISION: 'split_decision',
+} as const;
+
+export const APPEAL_HAS_CASE_PROCEDURE = {
+  HEARING: 'hearing',
+  INQUIRY: 'inquiry',
+  WRITTEN: 'written',
+} as const;
+
+export const APPEAL_HAS_CASE_STATUS = {
+  ASSIGN_CASE_OFFICER: 'assign_case_officer',
+  AWAITING_EVENT: 'awaiting_event',
+  AWAITING_TRANSFER: 'awaiting_transfer',
+  CLOSED: 'closed',
+  COMPLETE: 'complete',
+  EVENT: 'event',
+  INVALID: 'invalid',
+  ISSUE_DETERMINATION: 'issue_determination',
+  LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  READY_TO_START: 'ready_to_start',
+  TRANSFERRED: 'transferred',
+  VALIDATION: 'validation',
+  WITHDRAWN: 'withdrawn',
+} as const;
+
 export const APPEAL_ALLOCATION_LEVEL = {
   A: 'A',
   B: 'B',
@@ -310,6 +339,7 @@ export const APPEAL_LPA_QUESTIONNAIRE_VALIDATION_OUTCOME = {
 export const APPEAL_NOTIFICATION_METHOD = {
   ADVERT: 'advert',
   LETTER: 'letter',
+  NOT_NOTIFIED: 'not_notified',
   NOTICE: 'notice',
 } as const;
 
@@ -407,6 +437,11 @@ export const METHOD = {
   POST: 'post',
 } as const;
 
+export const NSIP_PROJECT_SOURCE_SYSTEM = {
+  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
+  HORIZON: 'horizon',
+} as const;
+
 export const NSIP_CA_AND_TP_EVIDENCE = {
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -652,8 +687,11 @@ export const NSIP_SECURITY_CLASSIFICATION = {
 } as const;
 
 export const NSIP_SOURCE_SYSTEM = {
+  BACK_OFFICE_APPEALS: 'back-office-appeals',
   BACK_OFFICE_APPLICATIONS: 'back-office-applications',
   HORIZON: 'horizon',
+  NI_FILE: 'ni_file',
+  SHAREPOINT: 'sharepoint',
 } as const;
 
 export const NSIP_STAGE = {

package/src/enums.js

@@ -1,3 +1,32 @@
+export const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
+  ALLOWED: 'allowed',
+  DISMISSED: 'dismissed',
+  INVALID: 'invalid',
+  SPLIT_DECISION: 'split_decision',
+});
+
+export const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
+  HEARING: 'hearing',
+  INQUIRY: 'inquiry',
+  WRITTEN: 'written',
+});
+
+export const APPEAL_HAS_CASE_STATUS = Object.freeze({
+  ASSIGN_CASE_OFFICER: 'assign_case_officer',
+  AWAITING_EVENT: 'awaiting_event',
+  AWAITING_TRANSFER: 'awaiting_transfer',
+  CLOSED: 'closed',
+  COMPLETE: 'complete',
+  EVENT: 'event',
+  INVALID: 'invalid',
+  ISSUE_DETERMINATION: 'issue_determination',
+  LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  READY_TO_START: 'ready_to_start',
+  TRANSFERRED: 'transferred',
+  VALIDATION: 'validation',
+  WITHDRAWN: 'withdrawn',
+});
+
 export const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   A: 'A',
   B: 'B',
@@ -310,6 +339,7 @@ export const APPEAL_LPA_QUESTIONNAIRE_VALIDATION_OUTCOME = Object.freeze({
 export const APPEAL_NOTIFICATION_METHOD = Object.freeze({
   ADVERT: 'advert',
   LETTER: 'letter',
+  NOT_NOTIFIED: 'not_notified',
   NOTICE: 'notice',
 });
 
@@ -407,6 +437,11 @@ export const METHOD = Object.freeze({
   POST: 'post',
 });
 
+export const NSIP_PROJECT_SOURCE_SYSTEM = Object.freeze({
+  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
+  HORIZON: 'horizon',
+});
+
 export const NSIP_CA_AND_TP_EVIDENCE = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -652,8 +687,11 @@ export const NSIP_SECURITY_CLASSIFICATION = Object.freeze({
 });
 
 export const NSIP_SOURCE_SYSTEM = Object.freeze({
+  BACK_OFFICE_APPEALS: 'back-office-appeals',
   BACK_OFFICE_APPLICATIONS: 'back-office-applications',
   HORIZON: 'horizon',
+  NI_FILE: 'ni_file',
+  SHAREPOINT: 'sharepoint',
 });
 
 export const NSIP_STAGE = Object.freeze({

package/src/index.cjs

@@ -81,6 +81,35 @@ function loadSchemaSync(filePath) {
 	return jsoncParser.parse(content.toString());
 }
 
+const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
+  ALLOWED: 'allowed',
+  DISMISSED: 'dismissed',
+  INVALID: 'invalid',
+  SPLIT_DECISION: 'split_decision',
+});
+
+const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
+  HEARING: 'hearing',
+  INQUIRY: 'inquiry',
+  WRITTEN: 'written',
+});
+
+const APPEAL_HAS_CASE_STATUS = Object.freeze({
+  ASSIGN_CASE_OFFICER: 'assign_case_officer',
+  AWAITING_EVENT: 'awaiting_event',
+  AWAITING_TRANSFER: 'awaiting_transfer',
+  CLOSED: 'closed',
+  COMPLETE: 'complete',
+  EVENT: 'event',
+  INVALID: 'invalid',
+  ISSUE_DETERMINATION: 'issue_determination',
+  LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  READY_TO_START: 'ready_to_start',
+  TRANSFERRED: 'transferred',
+  VALIDATION: 'validation',
+  WITHDRAWN: 'withdrawn',
+});
+
 const APPEAL_ALLOCATION_LEVEL = Object.freeze({
   A: 'A',
   B: 'B',
@@ -393,6 +422,7 @@ const APPEAL_LPA_QUESTIONNAIRE_VALIDATION_OUTCOME = Object.freeze({
 const APPEAL_NOTIFICATION_METHOD = Object.freeze({
   ADVERT: 'advert',
   LETTER: 'letter',
+  NOT_NOTIFIED: 'not_notified',
   NOTICE: 'notice',
 });
 
@@ -490,6 +520,11 @@ const METHOD = Object.freeze({
   POST: 'post',
 });
 
+const NSIP_PROJECT_SOURCE_SYSTEM = Object.freeze({
+  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
+  HORIZON: 'horizon',
+});
+
 const NSIP_CA_AND_TP_EVIDENCE = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -735,8 +770,11 @@ const NSIP_SECURITY_CLASSIFICATION = Object.freeze({
 });
 
 const NSIP_SOURCE_SYSTEM = Object.freeze({
+  BACK_OFFICE_APPEALS: 'back-office-appeals',
   BACK_OFFICE_APPLICATIONS: 'back-office-applications',
   HORIZON: 'horizon',
+  NI_FILE: 'ni_file',
+  SHAREPOINT: 'sharepoint',
 });
 
 const NSIP_STAGE = Object.freeze({
@@ -874,6 +912,9 @@ exports.APPEAL_EIA_DEVELOPMENT_DESCRIPTION = APPEAL_EIA_DEVELOPMENT_DESCRIPTION;
 exports.APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE = APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE;
 exports.APPEAL_EVENT_STATUS = APPEAL_EVENT_STATUS;
 exports.APPEAL_EVENT_TYPE = APPEAL_EVENT_TYPE;
+exports.APPEAL_HAS_CASE_DECISION_OUTCOME = APPEAL_HAS_CASE_DECISION_OUTCOME;
+exports.APPEAL_HAS_CASE_PROCEDURE = APPEAL_HAS_CASE_PROCEDURE;
+exports.APPEAL_HAS_CASE_STATUS = APPEAL_HAS_CASE_STATUS;
 exports.APPEAL_INVALID_OR_INCOMPLETE_DETAILS = APPEAL_INVALID_OR_INCOMPLETE_DETAILS;
 exports.APPEAL_KNOWS_ALL_OWNERS = APPEAL_KNOWS_ALL_OWNERS;
 exports.APPEAL_KNOWS_OTHER_OWNERS = APPEAL_KNOWS_OTHER_OWNERS;
@@ -909,6 +950,7 @@ exports.NSIP_ORIGIN = NSIP_ORIGIN;
 exports.NSIP_PLANNING_INSPECTORATE_ROLE = NSIP_PLANNING_INSPECTORATE_ROLE;
 exports.NSIP_POLICY_COMPLIANCE_DOCUMENT = NSIP_POLICY_COMPLIANCE_DOCUMENT;
 exports.NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT = NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT;
+exports.NSIP_PROJECT_SOURCE_SYSTEM = NSIP_PROJECT_SOURCE_SYSTEM;
 exports.NSIP_PROJECT_TYPE = NSIP_PROJECT_TYPE;
 exports.NSIP_PUBLIC_SECTOR_EQUALITY_DUTY = NSIP_PUBLIC_SECTOR_EQUALITY_DUTY;
 exports.NSIP_PUBLISHED_STATUS = NSIP_PUBLISHED_STATUS;

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

@@ -0,0 +1,196 @@
+import snakeCase from 'lodash.snakecase';
+
+const SPACING = '  ';
+const NEW_LINE = '\n';
+
+/**
+ * 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}
+ */
+export 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 {{schemaName: string, key: string, values: string[]}[]} enums
+ * @returns {Record<string, string[]>} map of enum name to values
+ */
+export function generateEnumMap(enums) {
+	/** @type {Object<string, string[]>} */
+	const enumProps = {};
+
+	// only allow one duplicate - else the superset logic gets complex
+	const duplicateKeys = new Set();
+	const warnings = [];
+	const infos = [];
+
+	for (const e of enums) {
+		const prefix = schemaPrefix(e.schemaName);
+		const key = prefix ? prefix + '_' + e.key : e.key;
+
+		const existingEnum = enumProps[key];
+		const thisEnum = e.values;
+		if (!existingEnum) {
+			enumProps[key] = e.values;
+		} else if (!enumsMatch(existingEnum, thisEnum)) {
+			const existingEnumProps = enums.find((e) => e.values === existingEnum);
+			const setIndex = indexOfSuperset(existingEnum, thisEnum);
+			// handle duplicate enums - but one must be a superset of the other
+			if (setIndex === -1) {
+				throw new Error(
+					`Enums ${existingEnumProps.key} from ${existingEnumProps.schemaName} and ${e.key} from ${e.schemaName} have the same name but one is not a superset of the other`
+				);
+			}
+			// and only allow one duplicate
+			if (duplicateKeys.has(key)) {
+				throw new Error(
+					`enum ${e.key} is used by multiple schemas, including ${existingEnumProps.schemaName} and ${e.schemaName}`
+				);
+			}
+			duplicateKeys.add(key);
+			warnings.push([
+				'⚠️ enum key',
+				key,
+				'is used with different values in',
+				existingEnumProps.schemaName,
+				'and',
+				e.schemaName
+			]);
+
+			if (setIndex === 1) {
+				// existing enum is the superset
+				// so this enum goes with a specific name
+				enumProps[e.schemaName.replace('.schema.json', '') + '_' + e.key] = e.values;
+			} else if (setIndex === 2) {
+				// this enum is the superset
+				// so 'swap in' this enum
+				enumProps[key] = e.values;
+				enumProps[existingEnumProps.schemaName.replace('.schema.json', '') + '_' + existingEnumProps.key] =
+					existingEnumProps.values;
+			}
+		} else {
+			// if the enums do match, nothing to change
+			infos.push(['ℹ️ enum key', key, 'is used multiple times but uses the same values']);
+		}
+	}
+	for (const info of infos) {
+		console.log(...info);
+	}
+	for (const warning of warnings) {
+		console.log(...warning);
+	}
+	return enumProps;
+}
+
+/**
+ * Do list1 and list2 match?
+ *
+ * @param {string[]} list1
+ * @param {string[]} list2
+ */
+export function enumsMatch(list1, list2) {
+	const set1 = new Set(list1);
+	const set2 = new Set(list2);
+	// get all elements that are in set1 or set2 but not in both
+	// if there are none, they match
+	return set1.symmetricDifference(set2).size === 0;
+}
+
+/**
+ * Is list1 a superset of list2, or vice versa?
+ *
+ * @param {string[]} list1
+ * @param {string[]} list2
+ * @returns {1 | 2 | -1} -1 if neither list is a superset of the other
+ */
+export function indexOfSuperset(list1, list2) {
+	const set1 = new Set(list1);
+	const set2 = new Set(list2);
+	if (set1.isSupersetOf(set2)) {
+		return 1;
+	}
+	if (set2.isSupersetOf(set1)) {
+		return 2;
+	}
+	return -1;
+}
+
+/**
+ *
+ * @param {{schemaName: string, key: string, values: string[]}[]} enums
+ * @param {Object<string, {type?: string|string[], enum?: string[]}>} properties
+ * @param {string} schemaName
+ */
+export function collectEnumProps(enums, properties = {}, schemaName) {
+	for (const [key, prop] of Object.entries(properties)) {
+		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)) {
+				const values = getEnumValues(p.enum);
+				const asSet = new Set(values);
+				if (values.length > asSet.size) {
+					throw new Error(`enum ${key} from ${schemaName} has duplicate elements`);
+				}
+				enums.push({
+					schemaName,
+					key,
+					values: values
+				});
+			}
+		};
+
+		collectEnumFromProp(prop);
+		collectEnumFromProp(prop.items);
+	}
+}
+
+/**
+ * Generate a prefix based on the schema name
+ *
+ * @param {string} schemaName
+ * @returns {string|undefined}
+ */
+export function schemaPrefix(schemaName) {
+	if (schemaName === 'message') {
+		return 'message';
+	}
+	if (schemaName.toLowerCase().includes('appeal')) {
+		return 'appeal';
+	}
+	if (schemaName.toLowerCase().includes('nsip')) {
+		return 'nsip';
+	}
+}