@planning-inspectorate/data-model 2.24.0 → 2.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.24.0",
+  "version": "2.25.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

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-document.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event_estimate.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event-estimate.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_has.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-has.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-representation.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_s78.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-s78.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_entraid.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  entraid.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_folder.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  folder.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_gettimesheets_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  gettimesheets-response.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_building.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-building.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_buildings.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-buildings.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-document.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_exam_timetable.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-exam-timetable.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_invoice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-invoice.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_meeting.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-meeting.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project_update.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project-update.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:40+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-representation.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_subscription.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-subscription.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_inspector.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-inspector.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:40+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_lpa.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-lpa.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:40+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_s51_advice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  s51-advice.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_service_user.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  service-user.schema.json
-#   timestamp: 2026-02-17T11:07:50+00:00
+#   timestamp: 2026-02-19T12:13:41+00:00
 
 from __future__ import annotations
 

package/schemas/commands/appeals-components/lpa-questionnaire-enforcement-common.schema.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/lpa-questionnaire-enforcement-common.schema.json",
+  "title": "LPAQ Enforcement submission properties",
+  "description": "Schema defining any common enforcement specific properties for LPAQ submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "noticeRelatesToBuildingEngineeringMiningOther",
+    "siteAreaSquareMetres",
+    "changeOfUseRefuseOrWaste",
+    "changeOfUseMineralExtraction",
+    "changeOfUseMineralStorage",
+    "relatesToErectionOfBuildingOrBuildings",
+    "relatesToBuildingWithAgriculturalPurpose",
+    "relatesToBuildingSingleDwellingHouse"
+  ],
+  "allOf": [
+    {
+      "properties": {
+        "noticeRelatesToBuildingEngineeringMiningOther": {
+          "type": ["boolean", "null"]
+        },
+        "siteAreaSquareMetres": {
+          "type": ["number", "null"],
+          "examples": [45.7],
+          "description": "The site area, in square meters"
+        },
+        "areaOfAllegedBreachInSquareMetres": {
+          "type": ["number", "null"],
+          "examples": [45.7],
+          "description": "Area of the alleged breach, in square meters"
+        },
+        "floorSpaceCreatedByBreachInSquareMetres": {
+          "type": ["number", "null"],
+          "examples": [45.7],
+          "description": "Floor space created by the breach, in square meters"
+        },
+        "changeOfUseRefuseOrWaste": {
+          "type": ["boolean", "null"]
+        },
+        "changeOfUseMineralExtraction": {
+          "type": ["boolean", "null"]
+        },
+        "changeOfUseMineralStorage": {
+          "type": ["boolean", "null"]
+        },
+        "relatesToErectionOfBuildingOrBuildings": {
+          "type": ["boolean", "null"]
+        },
+        "relatesToBuildingWithAgriculturalPurpose": {
+          "type": ["boolean", "null"]
+        },
+        "relatesToBuildingSingleDwellingHouse": {
+          "type": ["boolean", "null"]
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/appeals-components/lpa-questionnaire-enforcement.schema.json

@@ -2,61 +2,13 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "commands/appeals-components/lpa-questionnaire-enforcement.schema.json",
   "title": "LPAQ Enforcement submission properties",
-  "description": "Schema defining any enfrocement specific properties for LPAQ submissions",
+  "description": "Schema defining any enforcement specific properties for LPAQ submissions",
   "type": "object",
   "additionalProperties": true,
-  "required": [
-    "noticeRelatesToBuildingEngineeringMiningOther",
-    "siteAreaSquareMetres",
-    "changeOfUseRefuseOrWaste",
-    "changeOfUseMineralExtraction",
-    "changeOfUseMineralStorage",
-    "relatesToErectionOfBuildingOrBuildings",
-    "relatesToBuildingWithAgriculturalPurpose",
-    "relatesToBuildingSingleDwellingHouse",
-    "affectedTrunkRoadName",
-    "isSiteOnCrownLand",
-    "article4AffectedDevelopmentRights"
-  ],
+  "required": ["affectedTrunkRoadName", "isSiteOnCrownLand", "article4AffectedDevelopmentRights"],
   "allOf": [
     {
       "properties": {
-        "noticeRelatesToBuildingEngineeringMiningOther": {
-          "type": ["boolean", "null"]
-        },
-        "siteAreaSquareMetres": {
-          "type": ["number", "null"],
-          "examples": [45.7],
-          "description": "The site area, in square meters"
-        },
-        "areaOfAllegedBreachInSquareMetres": {
-          "type": ["number", "null"],
-          "examples": [45.7],
-          "description": "Area of the alleged breach, in square meters"
-        },
-        "floorSpaceCreatedByBreachInSquareMetres": {
-          "type": ["number", "null"],
-          "examples": [45.7],
-          "description": "Floor space created by the breach, in square meters"
-        },
-        "changeOfUseRefuseOrWaste": {
-          "type": ["boolean", "null"]
-        },
-        "changeOfUseMineralExtraction": {
-          "type": ["boolean", "null"]
-        },
-        "changeOfUseMineralStorage": {
-          "type": ["boolean", "null"]
-        },
-        "relatesToErectionOfBuildingOrBuildings": {
-          "type": ["boolean", "null"]
-        },
-        "relatesToBuildingWithAgriculturalPurpose": {
-          "type": ["boolean", "null"]
-        },
-        "relatesToBuildingSingleDwellingHouse": {
-          "type": ["boolean", "null"]
-        },
         "affectedTrunkRoadName": {
           "type": ["string", "null"],
           "examples": ["Buckingham palace road"],

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',
@@ -410,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',
@@ -655,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({
@@ -762,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;
@@ -797,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',
@@ -408,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',
@@ -653,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',
@@ -408,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',
@@ -653,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',
@@ -491,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',
@@ -736,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({
@@ -875,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;
@@ -910,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';
+	}
+}

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

@@ -4613,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;
@@ -4635,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
    */
@@ -4705,7 +4710,7 @@ export interface LPAQuestionnaireCommand {
         LPAProcedurePreferenceProperties &
         ChangedListedBuildingNumbersProperties)
     | ({
-        caseType?: 'C' | 'F';
+        caseType?: 'C';
       } & LPAQCommonSubmissionProperties &
         LPAQHASSubmissionProperties &
         LPAProcedurePreferenceProperties &
@@ -4713,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/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]
 };