feat: add type for CommunityInfrastructureLevy (#135)

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

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/schema/schema.json b/schema/schema.json
@@ -238,6 +238,9 @@
       "additionalProperties": false,
       "description": "Information about this planning application",
       "properties": {
+        "CIL": {
+          "$ref": "#/definitions/CommunityInfrastructureLevy"
+        },
         "declaration": {
           "$ref": "#/definitions/ApplicationDeclaration"
         },
@@ -1634,6 +1637,28 @@
       },
       "type": "object"
     },
+    "CommunityInfrastructureLevy": {
+      "$id": "#CommunityInfrastructureLevy",
+      "additionalProperties": false,
+      "description": "Details about the Community Infrastructure Levy planning charge, if applicable",
+      "properties": {
+        "result": {
+          "enum": [
+            "exempt.annexe",
+            "exempt.extension",
+            "exempt.selfBuild",
+            "liable",
+            "relief.charity",
+            "relief.socialHousing"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "result"
+      ],
+      "type": "object"
+    },
     "Date": {
       "format": "date",
       "type": "string"

diff --git a/types/schema/data/Application.ts b/types/schema/data/Application.ts
@@ -10,6 +10,7 @@ export interface Application {
   fee: ApplicationFee;
   declaration: ApplicationDeclaration;
   preApp?: PreApplication;
+  CIL?: CommunityInfrastructureLevy;
 }
 
 /**
@@ -64,6 +65,20 @@ export interface PreApplication {
   summary: string;
 }
 
+/**
+ * @id #CommunityInfrastructureLevy
+ * @description Details about the Community Infrastructure Levy planning charge, if applicable
+ */
+export interface CommunityInfrastructureLevy {
+  result:
+    | 'exempt.annexe'
+    | 'exempt.extension'
+    | 'exempt.selfBuild'
+    | 'liable'
+    | 'relief.charity'
+    | 'relief.socialHousing';
+}
+
 type ApplicationTypeKeys = keyof typeof ApplicationTypes;
 
 type GenericApplicationType<TKey extends ApplicationTypeKeys> = {