feat: add types for existing & proposed Materials (#134)

theopensystemslab · Mar 13, 2024 · 7b8fd03 · 7b8fd03
1 parent 2f7315a
commit 7b8fd03
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 0 deletions.
diff --git a/schema/schema.json b/schema/schema.json
@@ -1578,6 +1578,9 @@
           ],
           "type": "object"
         },
+        "materials": {
+          "$ref": "#/definitions/Materials"
+        },
         "new": {
           "additionalProperties": false,
           "properties": {
@@ -3510,6 +3513,9 @@
           ],
           "type": "object"
         },
+        "materials": {
+          "$ref": "#/definitions/Materials"
+        },
         "new": {
           "additionalProperties": false,
           "properties": {
@@ -4187,6 +4193,9 @@
           ],
           "type": "object"
         },
+        "details": {
+          "$ref": "#/definitions/PropertyDetails"
+        },
         "localAuthorityDistrict": {
           "description": "Current and historic UK Local Authority Districts that contain this address sourced from planning.data.gov.uk/dataset/local-authority-district",
           "items": {
@@ -4288,6 +4297,36 @@
       ],
       "type": "object"
     },
+    "Materials": {
+      "additionalProperties": false,
+      "properties": {
+        "boundary": {
+          "type": "string"
+        },
+        "door": {
+          "type": "string"
+        },
+        "lighting": {
+          "type": "string"
+        },
+        "other": {
+          "type": "string"
+        },
+        "roof": {
+          "type": "string"
+        },
+        "surface": {
+          "type": "string"
+        },
+        "wall": {
+          "type": "string"
+        },
+        "window": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "Metadata": {
       "$id": "#DigitalPlanningMetadata",
       "anyOf": [
@@ -12691,6 +12730,17 @@
       ],
       "description": "Information about the site where the works will happen"
     },
+    "PropertyDetails": {
+      "$id": "#PropertyDetails",
+      "additionalProperties": false,
+      "description": "Details about the property as it currently exists",
+      "properties": {
+        "materials": {
+          "$ref": "#/definitions/Materials"
+        }
+      },
+      "type": "object"
+    },
     "PropertyType": {
       "$id": "#PropertyType",
       "anyOf": [
@@ -21930,6 +21980,9 @@
           ],
           "type": "object"
         },
+        "details": {
+          "$ref": "#/definitions/PropertyDetails"
+        },
         "localAuthorityDistrict": {
           "description": "Current and historic UK Local Authority Districts that contain this address sourced from planning.data.gov.uk/dataset/local-authority-district",
           "items": {

diff --git a/types/schema/data/Property.ts b/types/schema/data/Property.ts
@@ -2,6 +2,7 @@ import {GeoJSON} from 'geojson';
 import {PlanningDesignations} from '../../enums/PlanningConstraints';
 import {PropertyTypes} from '../../enums/PropertyTypes';
 import {Area, URL} from '../../utils';
+import {Materials} from './shared';
 
 /**
  * @id #Property
@@ -59,8 +60,17 @@ export interface UKProperty {
       neighbourhood: PlanningConstraint[];
     };
   };
+  details?: PropertyDetails;
 }
 
+/**
+ * @id #PropertyDetails
+ * @description Details about the property as it currently exists
+ */
+export type PropertyDetails = {
+  materials?: Materials;
+};
+
 /**
  * @id #LondonProperty
  * @description Property details for sites within the Greater London Authority (GLA) area

diff --git a/types/schema/data/Proposal.ts b/types/schema/data/Proposal.ts
@@ -2,6 +2,7 @@ import {GeoJSON} from 'geojson';
 import {ProjectTypes} from '../../enums/ProjectTypes';
 import {VehicleParking} from '../../enums/VehicleParking';
 import {Area, Date} from '../../utils';
+import {Materials} from './shared';
 
 /**
  * @id #Proposal
@@ -48,6 +49,7 @@ export interface BaseDetails {
       dwellings?: number;
     };
   };
+  materials?: Materials;
 }
 
 /**

diff --git a/types/schema/data/shared.ts b/types/schema/data/shared.ts
@@ -0,0 +1,10 @@
+export type Materials = {
+  boundary?: string;
+  door?: string;
+  lighting?: string;
+  roof?: string;
+  surface?: string;
+  wall?: string;
+  window?: string;
+  other?: string;
+};