@planning-inspectorate/data-model 1.21.0 → 2.0.0

package/schemas/commands/{appeal-s78-submission.schema.json → appeals-components/appeal-s78-submission.schema.json}

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/appeal-s78-submission.schema.json",
+  "$id": "commands/appeals-components/appeal-s78-submission.schema.json",
   "title": "Appellant s78 submission properties",
-  "description": "Schema defining any S78 specific properties for questionnaire submissions",
+  "description": "Schema defining any S78 specific properties for appeal submissions",
   "type": "object",
   "additionalProperties": true,
   "required": [

package/schemas/commands/appeals-components/appellant-procedure-preference.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/appellant-procedure-preference.schema.json",
+  "title": "Appellant procedure preference properties",
+  "description": "Schema defining appellant procedure preference properties",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "appellantProcedurePreference",
+    "appellantProcedurePreferenceDetails",
+    "appellantProcedurePreferenceDuration",
+    "appellantProcedurePreferenceWitnessCount"
+  ],
+  "allOf": [
+    {
+      "properties": {
+        "appellantProcedurePreference": {
+          "type": ["string", "null"],
+          "enum": ["written", "hearing", "inquiry", null],
+          "description": "The procedure preference indicated by the appellant"
+        },
+        "appellantProcedurePreferenceDetails": {
+          "type": ["string", "null"],
+          "description": "The procedure details preference indicated by the appellant"
+        },
+        "appellantProcedurePreferenceDuration": {
+          "type": ["number", "null"],
+          "description": "The duration of the procedure indicated by the appellant"
+        },
+        "appellantProcedurePreferenceWitnessCount": {
+          "type": ["number", "null"],
+          "description": "The number of witnesses in inquiries"
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/appeals-components/changed-listed-building-number.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/changed-listed-building-number.schema.json",
+  "title": "changed-listed-building-numbers properties",
+  "description": "Schema defining changed-listed-building-numbers",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["changedListedBuildingNumbers"],
+  "allOf": [
+    {
+      "properties": {
+        "changedListedBuildingNumbers": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string",
+            "examples": ["10023", "17824"]
+          },
+          "description": "A list of changed listed building IDs from Historic England"
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/appeals-components/lpa-procedure-preference.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeals-components/lpa-procedure-preference.schema.json",
+  "title": "LPA procedure preference properties",
+  "description": "Schema defining LPA procedure preference properties",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["lpaProcedurePreference", "lpaProcedurePreferenceDetails", "lpaProcedurePreferenceDuration"],
+  "allOf": [
+    {
+      "properties": {
+        "lpaProcedurePreference": {
+          "type": ["string", "null"],
+          "enum": ["written", "hearing", "inquiry", null],
+          "description": "The procedure preference indicated by the LPA"
+        },
+        "lpaProcedurePreferenceDetails": {
+          "type": ["string", "null"],
+          "description": "The procedure details preference indicated by the LPA"
+        },
+        "lpaProcedurePreferenceDuration": {
+          "type": ["number", "null"],
+          "description": "The duration of enquiry indicated by the LPA"
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/{lpa-questionnaire-cas-advert.schema.json → appeals-components/lpa-questionnaire-advert.schema.json}

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/lpa-questionnaire-cas-advert.schema.json",
+  "$id": "commands/appeals-components/lpa-questionnaire-advert.schema.json",
   "title": "LPAQ cas advert submission properties",
-  "description": "Schema defining any cas advert specific properties for LPAQ submissions",
+  "description": "Schema defining any advert specific properties for LPAQ submissions",
   "type": "object",
   "additionalProperties": true,
   "required": [
@@ -13,9 +13,6 @@
     "hasStatutoryConsultees",
     "consultedBodiesDetails",
     "hasEmergingPlan",
-    "lpaProcedurePreference",
-    "lpaProcedurePreferenceDetails",
-    "lpaProcedurePreferenceDuration",
     "isSiteInAreaOfSpecialControlAdverts",
     "wasApplicationRefusedDueToHighwayOrTraffic",
     "didAppellantSubmitCompletePhotosAndPlans"
@@ -25,18 +22,15 @@
       "properties": {
         "affectsScheduledMonument": {
           "type": ["boolean", "null"],
-          "description": "Indicates that a scheduled monument is affected",
-          "$comment": "Only available in S78 cases"
+          "description": "Indicates that a scheduled monument is affected"
         },
         "hasProtectedSpecies": {
           "type": ["boolean", "null"],
-          "description": "Indicates the existence of protected species",
-          "$comment": "Only available in S78 cases"
+          "description": "Indicates the existence of protected species"
         },
         "isAonbNationalLandscape": {
           "type": ["boolean", "null"],
-          "description": "Indicates an area of outstanding beauty (National Landscape)",
-          "$comment": "Only available in S78 cases"
+          "description": "Indicates an area of outstanding beauty (National Landscape)"
         },
         "designatedSitesNames": {
           "type": ["array", "null"],
@@ -44,13 +38,11 @@
             "type": "string",
             "examples": ["SSSI", "cSAC", "SAC", "pSPA", "SPA", "user entered value"]
           },
-          "description": "The designated site names",
-          "$comment": "Only available in S78 cases"
+          "description": "The designated site names"
         },
         "hasStatutoryConsultees": {
           "type": ["boolean", "null"],
-          "description": "Indicates statutory consultees",
-          "$comment": "Only available in S78 cases"
+          "description": "Indicates statutory consultees"
         },
         "consultedBodiesDetails": {
           "type": ["string", "null"],
@@ -58,24 +50,7 @@
         },
         "hasEmergingPlan": {
           "type": ["boolean", "null"],
-          "description": "Indicates emerging plans",
-          "$comment": "Only available in S78 cases"
-        },
-        "lpaProcedurePreference": {
-          "type": ["string", "null"],
-          "enum": ["written", "hearing", "inquiry", null],
-          "description": "The procedure preference indicated by the LPA",
-          "$comment": "Only available in S78 cases"
-        },
-        "lpaProcedurePreferenceDetails": {
-          "type": ["string", "null"],
-          "description": "The procedure details preference indicated by the LPA",
-          "$comment": "Only available in S78 cases"
-        },
-        "lpaProcedurePreferenceDuration": {
-          "type": ["number", "null"],
-          "description": "The duration of enquiry indicated by the LPA",
-          "$comment": "Only available in S78 cases"
+          "description": "Indicates emerging plans"
         },
         "isSiteInAreaOfSpecialControlAdverts": {
           "type": ["boolean", "null"],

package/schemas/commands/{lpa-questionnaire-common.schema.json → appeals-components/lpa-questionnaire-common.schema.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/lpa-questionnaire-common.schema.json",
+  "$id": "commands/appeals-components/lpa-questionnaire-common.schema.json",
   "title": "LPAQ common submission properties",
   "description": "Schema defining any properties common across all appeal types for LPAQ submissions",
   "type": "object",

package/schemas/commands/{lpa-questionnaire-has.schema.json → appeals-components/lpa-questionnaire-has.schema.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/lpa-questionnaire-has.schema.json",
+  "$id": "commands/appeals-components/lpa-questionnaire-has.schema.json",
   "title": "LPAQ HAS submission properties",
   "description": "Schema defining any HAS specific properties for LPAQ submissions",
   "type": "object",

package/schemas/commands/{lpa-questionnaire-s78.schema.json → appeals-components/lpa-questionnaire-s78.schema.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "commands/lpa-questionnaire-s78.schema.json",
+  "$id": "commands/appeals-components/lpa-questionnaire-s78.schema.json",
   "title": "LPAQ S78 submission properties",
   "description": "Schema defining any S78 specific properties for LPAQ submissions",
   "type": "object",
@@ -29,10 +29,7 @@
     "hasInfrastructureLevy",
     "isInfrastructureLevyFormallyAdopted",
     "infrastructureLevyAdoptedDate",
-    "infrastructureLevyExpectedDate",
-    "lpaProcedurePreference",
-    "lpaProcedurePreferenceDetails",
-    "lpaProcedurePreferenceDuration"
+    "infrastructureLevyExpectedDate"
   ],
   "allOf": [
     {
@@ -194,22 +191,6 @@
           "examples": ["2023-07-27T20:30:00.000Z"],
           "description": "The expected date of the infrastructure levy",
           "$comment": "Only available in S78 cases"
-        },
-        "lpaProcedurePreference": {
-          "type": ["string", "null"],
-          "enum": ["written", "hearing", "inquiry", null],
-          "description": "The procedure preference indicated by the LPA",
-          "$comment": "Only available in S78 cases"
-        },
-        "lpaProcedurePreferenceDetails": {
-          "type": ["string", "null"],
-          "description": "The procedure details preference indicated by the LPA",
-          "$comment": "Only available in S78 cases"
-        },
-        "lpaProcedurePreferenceDuration": {
-          "type": ["number", "null"],
-          "description": "The duration of enquiry indicated by the LPA",
-          "$comment": "Only available in S78 cases"
         }
       }
     }

package/schemas/commands/appellant-submission.schema.json

@@ -17,26 +17,37 @@
           "$comment": "Householder + CAS Planning",
           "allOf": [
             { "properties": { "caseType": { "enum": ["D", "ZP"] } } },
-            { "$ref": "appeal-common-submission.schema.json" },
-            { "$ref": "appeal-has-submission.schema.json" }
+            { "$ref": "appeals-components/appeal-common-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-has-submission.schema.json" }
           ]
         },
         {
           "$comment": "S78 + S20",
           "allOf": [
             { "properties": { "caseType": { "enum": ["W", "Y"] } } },
-            { "$ref": "appeal-common-submission.schema.json" },
-            { "$ref": "appeal-has-submission.schema.json" },
-            { "$ref": "appeal-s78-submission.schema.json" }
+            { "$ref": "appeals-components/appeal-common-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-has-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-s78-submission.schema.json" },
+            { "$ref": "appeals-components/appellant-procedure-preference.schema.json" }
           ]
         },
         {
-          "$comment": "Adverts + CAS Adverts",
+          "$comment": "CAS Adverts",
           "allOf": [
-            { "properties": { "caseType": { "enum": ["H", "ZA"] } } },
-            { "$ref": "appeal-common-submission.schema.json" },
-            { "$ref": "appeal-has-submission.schema.json" },
-            { "$ref": "appeal-advert.submission.schema.json" }
+            { "properties": { "caseType": { "enum": ["ZA"] } } },
+            { "$ref": "appeals-components/appeal-common-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-has-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-advert.submission.schema.json" }
+          ]
+        },
+        {
+          "$comment": "Adverts",
+          "allOf": [
+            { "properties": { "caseType": { "enum": ["H"] } } },
+            { "$ref": "appeals-components/appeal-common-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-has-submission.schema.json" },
+            { "$ref": "appeals-components/appeal-advert.submission.schema.json" },
+            { "$ref": "appeals-components/appellant-procedure-preference.schema.json" }
           ]
         }
       ]

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

@@ -16,26 +16,40 @@
           "$comment": "Householder + CAS Planning",
           "allOf": [
             { "properties": { "caseType": { "enum": ["D", "ZP"] } } },
-            { "$ref": "lpa-questionnaire-common.schema.json" },
-            { "$ref": "lpa-questionnaire-has.schema.json" }
+            { "$ref": "appeals-components/lpa-questionnaire-common.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-has.schema.json" }
           ]
         },
         {
           "$comment": "S78 + S20",
           "allOf": [
             { "properties": { "caseType": { "enum": ["W", "Y"] } } },
-            { "$ref": "lpa-questionnaire-common.schema.json" },
-            { "$ref": "lpa-questionnaire-has.schema.json" },
-            { "$ref": "lpa-questionnaire-s78.schema.json" }
+            { "$ref": "appeals-components/lpa-questionnaire-common.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-has.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-s78.schema.json" },
+            { "$ref": "appeals-components/lpa-procedure-preference.schema.json" },
+            { "$ref": "appeals-components/changed-listed-building-number.schema.json" }
           ]
         },
         {
-          "$comment": "Adverts + CAS Adverts - TBD - may need separate schemas",
+          "$comment": "CAS Adverts",
           "allOf": [
-            { "properties": { "caseType": { "enum": ["H", "ZA"] } } },
-            { "$ref": "lpa-questionnaire-common.schema.json" },
-            { "$ref": "lpa-questionnaire-has.schema.json" },
-            { "$ref": "lpa-questionnaire-cas-advert.schema.json" }
+            { "properties": { "caseType": { "enum": ["ZA"] } } },
+            { "$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/lpa-questionnaire-advert.schema.json" }
+          ]
+        },
+        {
+          "$comment": "Adverts",
+          "allOf": [
+            { "properties": { "caseType": { "enum": ["H"] } } },
+            { "$ref": "appeals-components/lpa-questionnaire-common.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-has.schema.json" },
+            { "$ref": "appeals-components/lpa-questionnaire-advert.schema.json" },
+            { "$ref": "appeals-components/lpa-procedure-preference.schema.json" },
+            { "$ref": "appeals-components/changed-listed-building-number.schema.json" }
           ]
         }
       ]

package/src/index.cjs

@@ -753,6 +753,7 @@ const __dirname$1 = path.dirname(url.fileURLToPath((typeof document === 'undefin
 
 const schemasPath = path.join(__dirname$1, '..', 'schemas');
 const commandsPath = path.join(schemasPath, 'commands');
+const appealsCommandsComponentsPath = path.join(commandsPath, 'appeals-components');
 
 /**
  * Load all schemas from schemas and commands folders
@@ -762,7 +763,8 @@ const commandsPath = path.join(schemasPath, 'commands');
 async function loadAllSchemas() {
 	return {
 		schemas: await loadSchemas(schemasPath),
-		commands: await loadSchemas(commandsPath)
+		commands: await loadSchemas(commandsPath),
+		appealsComponents: await loadSchemas(appealsCommandsComponentsPath)
 	};
 }
 
@@ -774,7 +776,8 @@ async function loadAllSchemas() {
 function loadAllSchemasSync() {
 	return {
 		schemas: loadSchemasSync(schemasPath),
-		commands: loadSchemasSync(commandsPath)
+		commands: loadSchemasSync(commandsPath),
+		appealsComponents: loadSchemasSync(appealsCommandsComponentsPath)
 	};
 }
 
@@ -848,6 +851,7 @@ exports.NSIP_VIRUS_CHECK_STATUS = NSIP_VIRUS_CHECK_STATUS;
 exports.REDACTION_STATUS = REDACTION_STATUS;
 exports.SERVICE_USER_TYPE = SERVICE_USER_TYPE;
 exports.STATUS = STATUS;
+exports.appealsCommandsComponentsPath = appealsCommandsComponentsPath;
 exports.commandsPath = commandsPath;
 exports.loadAllSchemas = loadAllSchemas;
 exports.loadAllSchemasSync = loadAllSchemasSync;

package/src/index.d.ts

@@ -8,10 +8,14 @@ export interface LoadedSchemas {
 	commands: {
 		[name: string]: any;
 	};
+	appealsComponents: {
+		[name: string]: any;
+	};
 }
 
 export const schemasPath: string;
 export const commandsPath: string;
+export const appealsComponentsPath: string;
 export function loadAllSchemas(): Promise<LoadedSchemas>;
 export function loadAllSchemasSync(): LoadedSchemas;
 

package/src/index.js

@@ -8,6 +8,7 @@ export * from './enums.js';
 
 export const schemasPath = path.join(__dirname, '..', 'schemas');
 export const commandsPath = path.join(schemasPath, 'commands');
+export const appealsCommandsComponentsPath = path.join(commandsPath, 'appeals-components');
 
 /**
  * Load all schemas from schemas and commands folders
@@ -17,7 +18,8 @@ export const commandsPath = path.join(schemasPath, 'commands');
 export async function loadAllSchemas() {
 	return {
 		schemas: await loadSchemas(schemasPath),
-		commands: await loadSchemas(commandsPath)
+		commands: await loadSchemas(commandsPath),
+		appealsComponents: await loadSchemas(appealsCommandsComponentsPath)
 	};
 }
 
@@ -29,6 +31,7 @@ export async function loadAllSchemas() {
 export function loadAllSchemasSync() {
 	return {
 		schemas: loadSchemasSync(schemasPath),
-		commands: loadSchemasSync(commandsPath)
+		commands: loadSchemasSync(commandsPath),
+		appealsComponents: loadSchemasSync(appealsCommandsComponentsPath)
 	};
 }