update region enum

theopensystemslab · Oct 25, 2023 · efd0cbb · efd0cbb
1 parent e492828
commit efd0cbb
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 3 deletions.
diff --git a/schema/schema.json b/schema/schema.json
@@ -18008,7 +18008,7 @@
           "type": "array"
         },
         "region": {
-          "type": "string"
+          "$ref": "#/definitions/UKRegion"
         },
         "type": {
           "$ref": "#/definitions/PropertyType"
@@ -18022,6 +18022,22 @@
       ],
       "type": "object"
     },
+    "UKRegion": {
+      "$id": "#UKRegion",
+      "description": "UK regions sourced from planning.data.gov.uk/dataset/region, where \"London\" is a proxy for the Greater London Authority (GLA) area",
+      "enum": [
+        "North East",
+        "North West",
+        "Yorkshire and The Humber",
+        "East Midlands",
+        "West Midlands",
+        "East of England",
+        "London",
+        "South East",
+        "South West"
+      ],
+      "type": "string"
+    },
     "URL": {
       "format": "uri",
       "pattern": "^https?://",

diff --git a/types/schema/data/Property.ts b/types/schema/data/Property.ts
@@ -9,13 +9,28 @@ import {Area, URL} from '../../utils';
  */
 export type Property = UKProperty | LondonProperty;
 
+/**
+ * @id #UKRegion
+ * @description UK regions sourced from planning.data.gov.uk/dataset/region, where "London" is a proxy for the Greater London Authority (GLA) area
+ */
+export type UKRegion =
+  | 'North East'
+  | 'North West'
+  | 'Yorkshire and The Humber'
+  | 'East Midlands'
+  | 'West Midlands'
+  | 'East of England'
+  | 'London'
+  | 'South East'
+  | 'South West';
+
 /**
  * @id #UKProperty
  * @description Property details for sites anywhere in the UK
  */
 export interface UKProperty {
   address: ProposedAddress | OSAddress;
-  region: string;
+  region: UKRegion;
   localAuthorityDistrict: string[];
   type: PropertyType;
   boundary?: {
@@ -32,7 +47,7 @@ export interface UKProperty {
  * @description Property details for sites within the Greater London Authority (GLA) area
  */
 export interface LondonProperty extends UKProperty {
-  region: 'London';
+  region: Extract<UKRegion, 'London'>;
   titleNumber: {
     known: 'Yes' | 'No';
     number?: string;