feat: Responses type (#29)

theopensystemslab · Sep 18, 2023 · 724d0d4 · 724d0d4
1 parent 9f82de2
commit 724d0d4
Show file tree

Hide file tree

Showing 8 changed files with 814 additions and 62 deletions.
diff --git a/examples/data/Responses.ts b/examples/data/Responses.ts
@@ -0,0 +1,32 @@
+import {Schema} from '../../types/Schema';
+
+export const validResponses: Schema['responses'] = [
+  {
+    metadata: {
+      sectionName: 'The property',
+      autoAnswered: true,
+    },
+    question: 'Is the property in London Borough of Southwark?',
+    responses: [
+      {
+        value: 'Yes',
+      },
+    ],
+  },
+  {
+    metadata: {
+      policyRefs: [
+        {
+          text: 'Town and Country Planning Act 1990, Part 7, Section 191 &amp; Section 192',
+        },
+      ],
+      sectionName: 'About the project',
+    },
+    question: 'What are you applying about?',
+    responses: [
+      {
+        value: 'Proposed changes I want to make in the future',
+      },
+    ],
+  },
+];
diff --git a/examples/index.ts b/examples/index.ts
@@ -3,6 +3,7 @@ import {validAgent, validApplicant} from './data/Applicant';
 import {validApplication} from './data/Application';
 import {validProperty} from './data/Property';
 import {validProposal} from './data/Proposal';
+import {validResponses} from './data/Responses';
 
 const validMetadata: Schema['metadata'] = {
   service: {
@@ -45,14 +46,15 @@ const validFiles: Schema['files'] = [
   },
 ];
 
-const validResult = [
+const validResult: Schema['result'] = [
   {
-    value: "Planning permission / Permitted development",
-    description: "It looks like the proposed changes may fall within the rules for Permitted Development and therefore would not need planning permission."
+    value: 'Planning permission / Permitted development',
+    description:
+      'It looks like the proposed changes may fall within the rules for Permitted Development and therefore would not need planning permission.',
   },
   {
-    value: "Listed building consent / Not required",
-    description: "",
+    value: 'Listed building consent / Not required',
+    description: '',
   },
 ];
 
@@ -68,9 +70,7 @@ export const validExampleApplicant: Schema = {
   },
   result: validResult,
   metadata: validMetadata,
-  responses: {
-    name: 'Test',
-  },
+  responses: validResponses,
   files: validFiles,
 };
 
@@ -86,8 +86,6 @@ export const validExampleAgent: Schema = {
   },
   result: validResult,
   metadata: validMetadata,
-  responses: {
-    name: 'Test',
-  },
+  responses: validResponses,
   files: validFiles,
 };
diff --git a/examples/validExampleAgent.json b/examples/validExampleAgent.json
@@ -134,9 +134,16 @@
       "description": "This is a test application"
     }
   },
-  "result": {
-    "name": "Test"
-  },
+  "result": [
+    {
+      "value": "Planning permission / Permitted development",
+      "description": "It looks like the proposed changes may fall within the rules for Permitted Development and therefore would not need planning permission."
+    },
+    {
+      "value": "Listed building consent / Not required",
+      "description": ""
+    }
+  ],
   "metadata": {
     "service": {
       "publishedFlowId": "b3320abe-f5bc-4185-b61f-40e9e65f07ad",
@@ -151,9 +158,36 @@
       "submittedAt": "2018-11-13T20:20:39+00:00"
     }
   },
-  "responses": {
-    "name": "Test"
-  },
+  "responses": [
+    {
+      "metadata": {
+        "sectionName": "The property",
+        "autoAnswered": true
+      },
+      "question": "Is the property in London Borough of Southwark?",
+      "responses": [
+        {
+          "value": "Yes"
+        }
+      ]
+    },
+    {
+      "metadata": {
+        "policyRefs": [
+          {
+            "text": "Town and Country Planning Act 1990, Part 7, Section 191 &amp; Section 192"
+          }
+        ],
+        "sectionName": "About the project"
+      },
+      "question": "What are you applying about?",
+      "responses": [
+        {
+          "value": "Proposed changes I want to make in the future"
+        }
+      ]
+    }
+  ],
   "files": [
     {
       "name": "https://api.editor.planx.uk/file/private/folderId/file1.pdf",

diff --git a/examples/validExampleApplicant.json b/examples/validExampleApplicant.json
@@ -107,9 +107,16 @@
       "description": "This is a test application"
     }
   },
-  "result": {
-    "name": "Test"
-  },
+  "result": [
+    {
+      "value": "Planning permission / Permitted development",
+      "description": "It looks like the proposed changes may fall within the rules for Permitted Development and therefore would not need planning permission."
+    },
+    {
+      "value": "Listed building consent / Not required",
+      "description": ""
+    }
+  ],
   "metadata": {
     "service": {
       "publishedFlowId": "b3320abe-f5bc-4185-b61f-40e9e65f07ad",
@@ -124,9 +131,36 @@
       "submittedAt": "2018-11-13T20:20:39+00:00"
     }
   },
-  "responses": {
-    "name": "Test"
-  },
+  "responses": [
+    {
+      "metadata": {
+        "sectionName": "The property",
+        "autoAnswered": true
+      },
+      "question": "Is the property in London Borough of Southwark?",
+      "responses": [
+        {
+          "value": "Yes"
+        }
+      ]
+    },
+    {
+      "metadata": {
+        "policyRefs": [
+          {
+            "text": "Town and Country Planning Act 1990, Part 7, Section 191 &amp; Section 192"
+          }
+        ],
+        "sectionName": "About the project"
+      },
+      "question": "What are you applying about?",
+      "responses": [
+        {
+          "value": "Proposed changes I want to make in the future"
+        }
+      ]
+    }
+  ],
   "files": [
     {
       "name": "https://api.editor.planx.uk/file/private/folderId/file1.pdf",