feat: Minor Planning Permission example payload (#193)

theopensystemslab · Jul 3, 2024 · fa321b6 · fa321b6
1 parent f635944
commit fa321b6
Show file tree

Hide file tree

Showing 9 changed files with 3,487 additions and 126 deletions.
diff --git a/examples/data/planningPermission/minor.ts b/examples/data/planningPermission/minor.ts
diff --git a/examples/planningPermission/minor.json b/examples/planningPermission/minor.json
diff --git a/schema/schema.json b/schema/schema.json
@@ -2240,40 +2240,7 @@
           "type": "array"
         },
         "units": {
-          "additionalProperties": false,
-          "properties": {
-            "residential": {
-              "items": {
-                "additionalProperties": false,
-                "properties": {
-                  "bedrooms": {
-                    "type": "number"
-                  },
-                  "development": {
-                    "$ref": "#/definitions/DevelopmentType"
-                  },
-                  "identicalUnits": {
-                    "type": "number"
-                  },
-                  "type": {
-                    "$ref": "#/definitions/UKResidentialUnitType"
-                  }
-                },
-                "required": [
-                  "development",
-                  "type",
-                  "bedrooms",
-                  "identicalUnits"
-                ],
-                "type": "object"
-              },
-              "type": "array"
-            }
-          },
-          "required": [
-            "residential"
-          ],
-          "type": "object"
+          "$ref": "#/definitions/ResidentialUnits"
         },
         "use": {
           "additionalProperties": false,
@@ -3845,6 +3812,24 @@
           ],
           "type": "object"
         },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "description": {
+              "const": "Information the authority considers necessary for the application",
+              "type": "string"
+            },
+            "value": {
+              "const": "necessaryInformation",
+              "type": "string"
+            }
+          },
+          "required": [
+            "value",
+            "description"
+          ],
+          "type": "object"
+        },
         {
           "additionalProperties": false,
           "properties": {
@@ -5945,40 +5930,7 @@
           "$ref": "#/definitions/PropertyType"
         },
         "units": {
-          "additionalProperties": false,
-          "properties": {
-            "residential": {
-              "items": {
-                "additionalProperties": false,
-                "properties": {
-                  "bedrooms": {
-                    "type": "number"
-                  },
-                  "identicalUnits": {
-                    "type": "number"
-                  },
-                  "tenure": {
-                    "$ref": "#/definitions/UKTenureType"
-                  },
-                  "type": {
-                    "$ref": "#/definitions/UKResidentialUnitType"
-                  }
-                },
-                "required": [
-                  "tenure",
-                  "type",
-                  "bedrooms",
-                  "identicalUnits"
-                ],
-                "type": "object"
-              },
-              "type": "array"
-            }
-          },
-          "required": [
-            "residential"
-          ],
-          "type": "object"
+          "$ref": "#/definitions/ResidentialUnits"
         },
         "use": {
           "additionalProperties": false,
@@ -23756,6 +23708,42 @@
       ],
       "type": "object"
     },
+    "ResidentialUnits": {
+      "additionalProperties": false,
+      "properties": {
+        "residential": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "bedrooms": {
+                "type": "number"
+              },
+              "identicalUnits": {
+                "type": "number"
+              },
+              "tenure": {
+                "$ref": "#/definitions/UKTenureType"
+              },
+              "type": {
+                "$ref": "#/definitions/UKResidentialUnitType"
+              }
+            },
+            "required": [
+              "type",
+              "tenure",
+              "bedrooms",
+              "identicalUnits"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "residential"
+      ],
+      "type": "object"
+    },
     "Response": {
       "additionalProperties": false,
       "properties": {
@@ -24500,40 +24488,7 @@
           "$ref": "#/definitions/PropertyType"
         },
         "units": {
-          "additionalProperties": false,
-          "properties": {
-            "residential": {
-              "items": {
-                "additionalProperties": false,
-                "properties": {
-                  "bedrooms": {
-                    "type": "number"
-                  },
-                  "identicalUnits": {
-                    "type": "number"
-                  },
-                  "tenure": {
-                    "$ref": "#/definitions/UKTenureType"
-                  },
-                  "type": {
-                    "$ref": "#/definitions/UKResidentialUnitType"
-                  }
-                },
-                "required": [
-                  "tenure",
-                  "type",
-                  "bedrooms",
-                  "identicalUnits"
-                ],
-                "type": "object"
-              },
-              "type": "array"
-            }
-          },
-          "required": [
-            "residential"
-          ],
-          "type": "object"
+          "$ref": "#/definitions/ResidentialUnits"
         },
         "use": {
           "additionalProperties": false,

diff --git a/scripts/build-json-examples.ts b/scripts/build-json-examples.ts
@@ -10,6 +10,7 @@ import {priorApprovalConvertCommercialToHome} from '../examples/data/priorApprov
 import {priorApprovalExtendUniversity} from '../examples/data/priorApproval/extendUniversity';
 import {priorApprovalSolarPanels} from '../examples/data/priorApproval/solarPanels';
 import {Schema} from '../types/Schema';
+import {planningPermissionMinor} from '../examples/data/planningPermission/minor';
 
 interface Example {
   filename: string;
@@ -45,6 +46,10 @@ const examplesToConvert: Example[] = [
     filename: 'planningPermission/fullHouseholder',
     data: planningPermissionFullHouseholder,
   },
+  {
+    filename: 'planningPermission/minor',
+    data: planningPermissionMinor,
+  },
   {
     filename: 'listedBuildingConsent',
     data: listedBuildingConsent,

diff --git a/tests/usage.test.ts b/tests/usage.test.ts
@@ -7,6 +7,7 @@ import {lawfulDevelopmentCertificateExisting} from '../examples/data/lawfulDevel
 import {lawfulDevelopmentCertificateProposed} from '../examples/data/lawfulDevelopmentCertificate/proposed';
 import {listedBuildingConsent} from '../examples/data/listedBuildingConsent';
 import {planningPermissionFullHouseholder} from '../examples/data/planningPermission/fullHouseholder';
+import {planningPermissionMinor} from '../examples/data/planningPermission/minor';
 import {priorApprovalBuildHomes} from '../examples/data/priorApproval/buildHomes';
 import {priorApprovalConvertCommercialToHome} from '../examples/data/priorApproval/convertCommercialToHome';
 import {priorApprovalExtendUniversity} from '../examples/data/priorApproval/extendUniversity';
@@ -18,6 +19,7 @@ const examplesToTest = [
   lawfulDevelopmentCertificateProposed,
   listedBuildingConsent,
   planningPermissionFullHouseholder,
+  planningPermissionMinor,
   priorApprovalExtendUniversity,
   priorApprovalSolarPanels,
   priorApprovalBuildHomes,

diff --git a/types/enums/FileTypes.ts b/types/enums/FileTypes.ts
@@ -54,6 +54,8 @@ export const FileTypes = {
     'Details of litter, vermin and bird control',
   locationPlan: 'Location plan',
   mineralsAndWasteAssessment: 'Minerals and waste assessment',
+  necessaryInformation:
+    'Information the authority considers necessary for the application',
   newDwellingsSchedule: 'New dwellings schedule',
   noiseAssessment: 'Noise assessment',
   openSpaceAssessment: 'Open space assessment',

diff --git a/types/schema/data/Property.ts b/types/schema/data/Property.ts
@@ -1,9 +1,7 @@
 import {PlanningDesignation} from '../../enums/PlanningConstraints';
 import {PropertyType} from '../../enums/PropertyTypes';
-import {UKResidentialUnitType} from '../../enums/ResidentialUnitTypes';
-import {UKTenureType} from '../../enums/TenureTypes';
 import {Date, URL} from '../../utils';
-import {Entity, GeoBoundary, Materials} from './shared';
+import {Entity, GeoBoundary, Materials, ResidentialUnits} from './shared';
 
 /**
  * @id #Property
@@ -71,14 +69,7 @@ export interface UKProperty {
       lastUseEndDate: Date;
     };
   };
-  units?: {
-    residential: {
-      tenure: UKTenureType;
-      type: UKResidentialUnitType;
-      bedrooms: number;
-      identicalUnits: number;
-    }[];
-  };
+  units?: ResidentialUnits;
 }
 
 /**

diff --git a/types/schema/data/Proposal.ts b/types/schema/data/Proposal.ts
@@ -4,13 +4,10 @@ import {GLAHousingProvider} from '../../enums/HousingProviders';
 import {OpenSpaceDesignation, OpenSpaceType} from '../../enums/OpenSpaces';
 import {ProjectType} from '../../enums/ProjectTypes';
 import {ProtectedSpaceDesignation} from '../../enums/ProtectedSpaces';
-import {
-  GLAResidentialUnitType,
-  UKResidentialUnitType,
-} from '../../enums/ResidentialUnitTypes';
+import {GLAResidentialUnitType} from '../../enums/ResidentialUnitTypes';
 import {GLATenureType} from '../../enums/TenureTypes';
 import {Area, Date} from '../../utils';
-import {GeoBoundary, Materials} from './shared';
+import {GeoBoundary, Materials, ResidentialUnits} from './shared';
 
 /**
  * @id #Proposal
@@ -109,14 +106,7 @@ export interface BaseProposal {
   newDwellings?: {
     newBuild?: {count: number};
   };
-  units?: {
-    residential: {
-      development: DevelopmentType;
-      type: UKResidentialUnitType;
-      bedrooms: number;
-      identicalUnits: number;
-    }[];
-  };
+  units?: ResidentialUnits;
 }
 
 /**

diff --git a/types/schema/data/shared.ts b/types/schema/data/shared.ts
@@ -1,4 +1,6 @@
 import {GeoJSON} from 'geojson';
+import {UKResidentialUnitType} from '../../enums/ResidentialUnitTypes';
+import {UKTenureType} from '../../enums/TenureTypes';
 import {Area, URL} from '../../utils';
 
 export type Materials = {
@@ -31,3 +33,12 @@ type PlanningDataSource = {
 type OSRoadsSource = {
   text: 'Ordnance Survey MasterMap Highways';
 };
+
+export type ResidentialUnits = {
+  residential: {
+    type: UKResidentialUnitType;
+    tenure: UKTenureType;
+    bedrooms: number;
+    identicalUnits: number;
+  }[];
+};