@planning-inspectorate/data-model 2.25.0 → 2.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/package.json +1 -1
  2. package/pins_data_model/models/model_appeal_document.py +1 -1
  3. package/pins_data_model/models/model_appeal_event.py +1 -1
  4. package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
  5. package/pins_data_model/models/model_appeal_has.py +1 -1
  6. package/pins_data_model/models/model_appeal_representation.py +1 -1
  7. package/pins_data_model/models/model_appeal_s78.py +1 -1
  8. package/pins_data_model/models/model_dart_response.py +1 -1
  9. package/pins_data_model/models/model_entraid.py +1 -1
  10. package/pins_data_model/models/model_folder.py +1 -1
  11. package/pins_data_model/models/model_gettimesheets_response.py +1 -1
  12. package/pins_data_model/models/model_listed_building.py +1 -1
  13. package/pins_data_model/models/model_listed_buildings.py +1 -1
  14. package/pins_data_model/models/model_nsip_document.py +1 -1
  15. package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
  16. package/pins_data_model/models/model_nsip_invoice.py +1 -1
  17. package/pins_data_model/models/model_nsip_meeting.py +1 -1
  18. package/pins_data_model/models/model_nsip_project.py +1 -1
  19. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  20. package/pins_data_model/models/model_nsip_representation.py +1 -1
  21. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  22. package/pins_data_model/models/model_pins_inspector.py +1 -1
  23. package/pins_data_model/models/model_pins_lpa.py +1 -1
  24. package/pins_data_model/models/model_s51_advice.py +1 -1
  25. package/pins_data_model/models/model_service_user.py +1 -1
  26. package/schemas/commands/appeals-components/lpa-questionnaire-enforcement-common.schema.json +1 -13
  27. package/schemas/commands/appeals-components/lpa-questionnaire-enforcement.schema.json +17 -1
  28. package/src/schemas.d.ts +8 -8
  29. package/tests/appeals/commands/enforcement-listed-questionnaire.test.js +2 -5
  30. package/tests/appeals/commands/enforcement-questionnaire.test.js +2 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.25.0",
3
+ "version": "2.26.0",
4
4
  "description": "JSON Schemas for the Planning Inspectorate's Data Model",
5
5
  "main": "src/index.js",
6
6
  "type": "module",
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-document.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-event.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-event-estimate.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-has.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-representation.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-s78.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: dart-response.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: entraid.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: folder.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: gettimesheets-response.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: listed-building.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: listed-buildings.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-document.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-exam-timetable.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-invoice.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-meeting.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-project.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-project-update.schema.json
3
- # timestamp: 2026-02-19T12:13:40+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-representation.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:33+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-subscription.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: pins-inspector.schema.json
3
- # timestamp: 2026-02-19T12:13:40+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: pins-lpa.schema.json
3
- # timestamp: 2026-02-19T12:13:40+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: s51-advice.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: service-user.schema.json
3
- # timestamp: 2026-02-19T12:13:41+00:00
3
+ # timestamp: 2026-02-20T13:48:32+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,16 +1,13 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
3
  "$id": "commands/appeals-components/lpa-questionnaire-enforcement-common.schema.json",
4
- "title": "LPAQ Enforcement submission properties",
4
+ "title": "LPAQ Enforcement common submission properties",
5
5
  "description": "Schema defining any common enforcement specific properties for LPAQ submissions",
6
6
  "type": "object",
7
7
  "additionalProperties": true,
8
8
  "required": [
9
9
  "noticeRelatesToBuildingEngineeringMiningOther",
10
10
  "siteAreaSquareMetres",
11
- "changeOfUseRefuseOrWaste",
12
- "changeOfUseMineralExtraction",
13
- "changeOfUseMineralStorage",
14
11
  "relatesToErectionOfBuildingOrBuildings",
15
12
  "relatesToBuildingWithAgriculturalPurpose",
16
13
  "relatesToBuildingSingleDwellingHouse"
@@ -36,15 +33,6 @@
36
33
  "examples": [45.7],
37
34
  "description": "Floor space created by the breach, in square meters"
38
35
  },
39
- "changeOfUseRefuseOrWaste": {
40
- "type": ["boolean", "null"]
41
- },
42
- "changeOfUseMineralExtraction": {
43
- "type": ["boolean", "null"]
44
- },
45
- "changeOfUseMineralStorage": {
46
- "type": ["boolean", "null"]
47
- },
48
36
  "relatesToErectionOfBuildingOrBuildings": {
49
37
  "type": ["boolean", "null"]
50
38
  },
@@ -5,7 +5,14 @@
5
5
  "description": "Schema defining any enforcement specific properties for LPAQ submissions",
6
6
  "type": "object",
7
7
  "additionalProperties": true,
8
- "required": ["affectedTrunkRoadName", "isSiteOnCrownLand", "article4AffectedDevelopmentRights"],
8
+ "required": [
9
+ "affectedTrunkRoadName",
10
+ "isSiteOnCrownLand",
11
+ "article4AffectedDevelopmentRights",
12
+ "changeOfUseRefuseOrWaste",
13
+ "changeOfUseMineralExtraction",
14
+ "changeOfUseMineralStorage"
15
+ ],
9
16
  "allOf": [
10
17
  {
11
18
  "properties": {
@@ -20,6 +27,15 @@
20
27
  "article4AffectedDevelopmentRights": {
21
28
  "type": ["string", "null"],
22
29
  "description": "What permitted develpoment rights are affected by the Article 4 Direction"
30
+ },
31
+ "changeOfUseRefuseOrWaste": {
32
+ "type": ["boolean", "null"]
33
+ },
34
+ "changeOfUseMineralExtraction": {
35
+ "type": ["boolean", "null"]
36
+ },
37
+ "changeOfUseMineralStorage": {
38
+ "type": ["boolean", "null"]
23
39
  }
24
40
  }
25
41
  }
package/src/schemas.d.ts CHANGED
@@ -4615,7 +4615,7 @@ export type LPAQCasAdvertSubmissionProperties = {
4615
4615
  /**
4616
4616
  * Schema defining any common enforcement specific properties for LPAQ submissions
4617
4617
  */
4618
- export type LPAQEnforcementSubmissionProperties = {
4618
+ export type LPAQEnforcementCommonSubmissionProperties = {
4619
4619
  noticeRelatesToBuildingEngineeringMiningOther?: boolean | null;
4620
4620
  /**
4621
4621
  * The site area, in square meters
@@ -4629,9 +4629,6 @@ export type LPAQEnforcementSubmissionProperties = {
4629
4629
  * Floor space created by the breach, in square meters
4630
4630
  */
4631
4631
  floorSpaceCreatedByBreachInSquareMetres?: number | null;
4632
- changeOfUseRefuseOrWaste?: boolean | null;
4633
- changeOfUseMineralExtraction?: boolean | null;
4634
- changeOfUseMineralStorage?: boolean | null;
4635
4632
  relatesToErectionOfBuildingOrBuildings?: boolean | null;
4636
4633
  relatesToBuildingWithAgriculturalPurpose?: boolean | null;
4637
4634
  relatesToBuildingSingleDwellingHouse?: boolean | null;
@@ -4639,7 +4636,7 @@ export type LPAQEnforcementSubmissionProperties = {
4639
4636
  /**
4640
4637
  * Schema defining any enforcement specific properties for LPAQ submissions
4641
4638
  */
4642
- export type LPAQEnforcementSubmissionProperties1 = {
4639
+ export type LPAQEnforcementSubmissionProperties = {
4643
4640
  /**
4644
4641
  * Name of trunk road within 67M of site
4645
4642
  */
@@ -4649,6 +4646,9 @@ export type LPAQEnforcementSubmissionProperties1 = {
4649
4646
  * What permitted develpoment rights are affected by the Article 4 Direction
4650
4647
  */
4651
4648
  article4AffectedDevelopmentRights?: string | null;
4649
+ changeOfUseRefuseOrWaste?: boolean | null;
4650
+ changeOfUseMineralExtraction?: boolean | null;
4651
+ changeOfUseMineralStorage?: boolean | null;
4652
4652
  };
4653
4653
  /**
4654
4654
  * Schema defining any LDC specific properties for LPAQ submissions
@@ -4718,8 +4718,8 @@ export interface LPAQuestionnaireCommand {
4718
4718
  InfrastructureLevyProperties &
4719
4719
  EnvironmentalImpactAssessmentProperties &
4720
4720
  SiteDesignationsAndProtectionSpecificProperties &
4721
- LPAQEnforcementSubmissionProperties &
4722
- LPAQEnforcementSubmissionProperties1)
4721
+ LPAQEnforcementCommonSubmissionProperties &
4722
+ LPAQEnforcementSubmissionProperties)
4723
4723
  | ({
4724
4724
  caseType?: 'X';
4725
4725
  } & LPAQCommonSubmissionProperties &
@@ -4735,7 +4735,7 @@ export interface LPAQuestionnaireCommand {
4735
4735
  InfrastructureLevyProperties &
4736
4736
  EnvironmentalImpactAssessmentProperties &
4737
4737
  SiteDesignationsAndProtectionSpecificProperties &
4738
- LPAQEnforcementSubmissionProperties &
4738
+ LPAQEnforcementCommonSubmissionProperties &
4739
4739
  LPAQListedBuildingSubmissionProperties);
4740
4740
  documents: {
4741
4741
  /**
@@ -63,11 +63,8 @@ const exampleEnforcementListedQuestionnaireSchema = {
63
63
  lpaProcedurePreferenceDuration: -34480053.16630782,
64
64
  noticeRelatesToBuildingEngineeringMiningOther: null,
65
65
  siteAreaSquareMetres: null,
66
- hasAllegedBreachArea: null,
67
- doesAllegedBreachCreateFloorSpace: null,
68
- changeOfUseRefuseOrWaste: null,
69
- changeOfUseMineralExtraction: null,
70
- changeOfUseMineralStorage: null,
66
+ areaOfAllegedBreachInSquareMetres: null,
67
+ floorSpaceCreatedByBreachInSquareMetres: null,
71
68
  relatesToErectionOfBuildingOrBuildings: null,
72
69
  relatesToBuildingWithAgriculturalPurpose: null,
73
70
  relatesToBuildingSingleDwellingHouse: null,
@@ -63,8 +63,8 @@ const exampleEnforcementQuestionnaireSchema = {
63
63
  lpaProcedurePreferenceDuration: -34480053.16630782,
64
64
  noticeRelatesToBuildingEngineeringMiningOther: null,
65
65
  siteAreaSquareMetres: null,
66
- hasAllegedBreachArea: null,
67
- doesAllegedBreachCreateFloorSpace: null,
66
+ areaOfAllegedBreachInSquareMetres: null,
67
+ floorSpaceCreatedByBreachInSquareMetres: null,
68
68
  changeOfUseRefuseOrWaste: null,
69
69
  changeOfUseMineralExtraction: null,
70
70
  changeOfUseMineralStorage: null,