feat: support files submitted as "data" (#180)

types/Schema.ts

@@ -4,6 +4,7 @@ import {PreAssessment} from './schema/PreAssessment';
 import {Responses} from './schema/Responses';
 import {Applicant} from './schema/data/Applicant';
 import {Application} from './schema/data/Application';
+import {FilesAsData} from './schema/data/Files';
 import {Property} from './schema/data/Property';
 import {Proposal} from './schema/data/Proposal';
 import {User} from './schema/data/User';
@@ -19,6 +20,7 @@ export interface Schema {
     applicant: Applicant;
     property: Property;
     proposal: Proposal;
+    files?: FilesAsData;
   };
   preAssessment?: PreAssessment;
   responses: Responses;

types/enums/ApplicationTypes.ts

@@ -3,8 +3,10 @@
  */
 export const ApplicationTypes = {
   advertConsent: 'Consent to display an advertisement',
-  'amendment.minorMaterial':'Consent to make small (minor material) changes to a project with planning permission',
-  'amendment.nonMaterial': 'Consent to make small (non-material) changes to a project with planning permission',
+  'amendment.minorMaterial':
+    'Consent to make small (minor material) changes to a project with planning permission',
+  'amendment.nonMaterial':
+    'Consent to make small (non-material) changes to a project with planning permission',
   hazardousSubstanceConsent:
     'Consent to move and dispose of hazardous substances',
   hedgerowRemovalNotice: 'Notice to remove a hedge',

types/enums/FileTypes.ts

@@ -34,8 +34,10 @@ export const FileTypes = {
   'floorPlan.proposed': 'Floor plan - proposed',
   foulDrainageAssessment: 'Foul drainage assessment',
   geodiversityAssessment: 'Geodiversity assessment',
-  hedgerowsInformation: 'Plans showing the stretches of hedgerows to be removed',
-  'hedgerowsInformation.plantingDate': 'Evidence of the date of planting of the removed hedgerows',
+  hedgerowsInformation:
+    'Plans showing the stretches of hedgerows to be removed',
+  'hedgerowsInformation.plantingDate':
+    'Evidence of the date of planting of the removed hedgerows',
   heritageStatement: 'Heritage Statement',
   hydrologicalAssessment: 'Hydrological and hydrogeological assessment',
   hydrologyReport: 'Hydrology report',
@@ -62,7 +64,8 @@ export const FileTypes = {
   'photographs.existing': 'Photographs - existing',
   'photographs.proposed': 'Photographs - proposed',
   planningStatement: 'Planning statement',
-  relevantInformation: 'Information the applicant considers relevant to the application',
+  relevantInformation:
+    'Information the applicant considers relevant to the application',
   'roofPlan.existing': 'Roof plan - existing',
   'roofPlan.proposed': 'Roof plan - proposed',
   'sections.existing': 'Sections - existing',

types/schema/data/Files.ts

@@ -0,0 +1,33 @@
+import {GeoBoundary} from './shared';
+
+/**
+ * @id #FilesAsData
+ * @description File types that can optionally be provided by answering structured questions, rather than via document upload (see root `files` for uploads)
+ */
+export type FilesAsData = {
+  designAndAccessStatement?: DesignAndAccessStatement;
+  heritageStatement?: HeritageStatement;
+  locationPlan?: GeoBoundary;
+};
+
+export interface DesignAndAccessStatement {
+  propertyDescription: string;
+  projectDescription: string;
+  accessAndLayout: string;
+  landscapingChanges: string;
+}
+
+export type HeritageStatementBase = {
+  designationDescription: string;
+  propertyDescription: string;
+  projectDescpription: string;
+  managedImpact: string;
+  improvements: string;
+};
+
+export interface HeritageStatement {
+  'designated.conservationArea'?: HeritageStatementBase;
+  listed?: HeritageStatementBase;
+  monument?: HeritageStatementBase;
+  'designated.WHS'?: HeritageStatementBase;
+}

types/schema/data/Property.ts

@@ -1,8 +1,7 @@
-import {GeoJSON} from 'geojson';
 import {PlanningDesignations} from '../../enums/PlanningConstraints';
 import {PropertyTypes} from '../../enums/PropertyTypes';
-import {Area, URL} from '../../utils';
-import {Materials} from './shared';
+import {URL} from '../../utils';
+import {GeoBoundary, Materials} from './shared';
 
 /**
  * @id #Property
@@ -40,10 +39,7 @@ export interface UKProperty {
   /**
    * @description HM Land Registry Index polygon for this property, commonly referred to as the blue line boundary, sourced from planning.data.gov.uk/dataset/title-boundary
    */
-  boundary?: {
-    site: GeoJSON;
-    area: Area;
-  };
+  boundary?: GeoBoundary;
   /**
    * @description Planning constraints and policies that intersect with this site and may impact or restrict development
    */

types/schema/data/Proposal.ts

@@ -1,12 +1,11 @@
-import {GeoJSON} from 'geojson';
 import {
   OpenSpaceTypes,
   OpenSpaceDesignations,
   ProtectedSpaceDesignations,
 } from '../../enums/Nature';
 import {ProjectTypes} from '../../enums/ProjectTypes';
 import {Area, Date} from '../../utils';
-import {Materials} from './shared';
+import {GeoBoundary, Materials} from './shared';
 
 /**
  * @id #Proposal
@@ -20,10 +19,7 @@ export interface BaseProposal {
   /**
    * @description Location plan boundary proposed by the user, commonly referred to as the red line boundary
    */
-  boundary?: {
-    site: GeoJSON;
-    area: Area;
-  };
+  boundary?: GeoBoundary;
   date?: ProposalDates;
   /**
    * @description Proposed materials, if applicable to projectType

types/schema/data/shared.ts

@@ -1,3 +1,6 @@
+import {GeoJSON} from 'geojson';
+import {Area} from '../../utils';
+
 export type Materials = {
   boundary?: string;
   door?: string;
@@ -8,3 +11,8 @@ export type Materials = {
   window?: string;
   other?: string;
 };
+
+export type GeoBoundary = {
+  site: GeoJSON;
+  area: Area;
+};