add proposed residential unit

theopensystemslab · Jul 3, 2024 · 0d80aa7 · 0d80aa7
1 parent 5e59d8e
commit 0d80aa7
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 126 deletions.
diff --git a/examples/data/planningPermission/minor.ts b/examples/data/planningPermission/minor.ts
@@ -1,4 +1,5 @@
 import {Schema} from '../../../types/Schema';
+import {BaseProposal} from '../../../types/schema/data/Proposal';
 
 const version = process.env['VERSION'] || '@next';
 
@@ -267,6 +268,19 @@ export const planningPermissionMinor: Schema = {
       materials: {
         boundary: 'white painted timber',
       },
+      units: {
+        residential: [
+          {
+            type: {value: 'house', description: 'House'},
+            tenure: {
+              value: 'selfCustomBuild',
+              description: 'Self-build and custom build',
+            },
+            bedrooms: 4,
+            identicalUnits: 1,
+          },
+        ],
+      } as BaseProposal['units'],
     },
   },
   responses: [

diff --git a/examples/planningPermission/minor.json b/examples/planningPermission/minor.json
@@ -284,6 +284,22 @@
       },
       "materials": {
         "boundary": "white painted timber"
+      },
+      "units": {
+        "residential": [
+          {
+            "type": {
+              "value": "house",
+              "description": "House"
+            },
+            "tenure": {
+              "value": "selfCustomBuild",
+              "description": "Self-build and custom build"
+            },
+            "bedrooms": 4,
+            "identicalUnits": 1
+          }
+        ]
       }
     }
   },

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,
@@ -5963,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,
@@ -23774,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": {
@@ -24518,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/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;
+  }[];
+};