Add build files for v0.1.0

v0.1.0/types/Schema.ts

@@ -0,0 +1,27 @@
+import {Result} from './schema/Result';
+import {Metadata} from './schema/Metadata';
+import {Responses} from './schema/Responses';
+import {Applicant} from './schema/data/Applicant';
+import {Application} from './schema/data/Application';
+import {Property} from './schema/data/Property';
+import {Proposal} from './schema/data/Proposal';
+import {User} from './schema/data/User';
+import {File} from './schema/File';
+
+/**
+ * @title Digital Planning Application
+ * @description The root schema for an application generated by a digital planning service
+ */
+export interface Schema {
+  data: {
+    application: Application;
+    user: User;
+    applicant: Applicant;
+    property: Property;
+    proposal: Proposal;
+  };
+  result: Result;
+  metadata: Metadata;
+  responses: Responses;
+  files: File[];
+}

v0.1.0/types/enums/ApplicationTypes.ts

@@ -0,0 +1,53 @@
+/**
+ * Values of `data.application.type`
+ */
+export const ApplicationTypes = {
+  ldc: 'Lawful Development Certificate',
+  'ldc.proposed': 'Lawful Development Certificate - Proposed',
+  'ldc.existing': 'Lawful Development Certificate - Existing',
+  pa: 'Prior Approval',
+  'pa.part1.classA': 'Prior Approval - Larger extension to a house',
+  'pa.part1.classAA': 'Prior Approval - Adding storeys to a house',
+  'pa.part3.classG':
+    'Prior Approval - Convert a commercial building to mixed use',
+  'pa.part3.classM':
+    'Prior Approval - Convert a mixed use building into a home',
+  'pa.part3.classMA':
+    'Prior Approval - Convert a commercial building into a home or homes',
+  'pa.part3.classN':
+    'Prior Approval - Convert a casino or amusement arcade into a home or homes',
+  'pa.part3.classQ':
+    'Prior Approval - Convert an agricultural building into a home',
+  'pa.part3.classR':
+    'Prior Approval - Convert an agricultural building to a commercial use',
+  'pa.part3.classS':
+    'Prior Approval - Convert an agricultural building to a school',
+  'pa.part3.classT':
+    'Prior Approval - Convert a commercial building to a school',
+  'pa.part4.classBB': 'Prior Approval - Put up a temporary structure',
+  'pa.part4.classE': 'Prior Approval - Use a building or land to shoot a film',
+  'pa.part6.classA':
+    'Prior Approval - Build new agricultural buildings on a unit of 5 hectares or more',
+  'pa.part6.classB':
+    'Prior Approval - Build new agricultural buildings on a unit of less than 5 hectares',
+  'pa.part6.classE': 'Prior Approval - Build new forestry buildings',
+  'pa.part7.classC': 'Prior Approval - Install click and collect facilities',
+  'pa.part7.classM':
+    'Prior Approval - Extend a school, college, university, prison or hospital',
+  'pa.part11.classB': 'Prior Approval - Demolish a building',
+  'pa.part14.classJ': 'Prior Approval - Install or change solar panels',
+  'pa.part16.classA': 'Prior Approval - Install telecommunications equipment',
+  'pa.part20.classA':
+    'Prior Approval - Build homes on a detached blocks of flats',
+  'pa.part20.classAA':
+    'Prior Approval - Build homes on a detached commercial building',
+  'pa.part20.classAB':
+    'Prior Approval - Build homes on an adjoining commercial or mixed use building',
+  'pa.part20.classAC': 'Prior Approval - Build homes on adjoining houses',
+  'pa.part20.classAD': 'Prior Approval - Build homes on detached houses',
+  'pa.part20.classZA':
+    'Prior Approval - Demolish buildings and build homes in their place',
+  pp: 'Planning Permission',
+  'pp.full.householder': 'Planning Permission',
+  'pp.full.householder.retro': 'Planning Permission - Retrospective',
+};

v0.1.0/types/enums/FileTypes.ts

@@ -0,0 +1,41 @@
+/**
+ * Values of `file.type`
+ */
+export const FileTypes = {
+  'property.drawing.elevation': 'Elevation plan - existing',
+  'property.drawing.floorPlan': 'Floor plan - existing',
+  'property.drawing.roofPlan': 'Roof plan - existing',
+  'property.drawing.section': 'Section - existing',
+  'property.drawing.sitePlan': 'Site plan - existing',
+  'property.drawing.usePlan': 'Use plan - existing',
+  'property.photograph': 'Photographs',
+  'property.site.locationPlan': 'Location plan',
+  'proposal.drawing.elevation': 'Elevation plan - proposed',
+  'proposal.drawing.floorPlan': 'Floor plan - proposed',
+  'proposal.drawing.other': 'Other - drawing',
+  'proposal.drawing.roofPlan': 'Roof plan - proposed',
+  'proposal.drawing.section': 'Section - proposed',
+  'proposal.drawing.sitePlan': 'Site plan - proposed',
+  'proposal.drawing.unitPlan': 'Unit plan - proposed',
+  'proposal.drawing.usePlan': 'Use plan - proposed',
+  'proposal.document.bankStatement': 'Bank statement',
+  'proposal.document.buildingControl.certificate':
+    'Building control certificate',
+  'proposal.document.construction.invoice': 'Construction invoice',
+  'proposal.document.contamination': 'Contamination report',
+  'proposal.document.councilTaxBill': 'Council tax bill',
+  'proposal.document.declaration': 'Statuatory declaration',
+  'proposal.document.designAndAccess': 'Design and Access Statement',
+  'proposal.document.floodRisk': 'Flood risk assessment',
+  'proposal.document.heritageStatement': 'Heritage Statement',
+  'proposal.document.noise': 'Noise assessment',
+  'proposal.document.other': 'Other - document',
+  'proposal.document.other.evidence': 'Other - correspondence',
+  'proposal.document.sunAndDaylight': 'Sunlight and daylight report',
+  'proposal.document.tenancyAgreement': 'Tenancy agreement',
+  'proposal.document.tenancyInvoice': 'Tenancy invoice',
+  'proposal.document.transport': 'Transport assessment',
+  'proposal.document.utility.bill': 'Utility bill',
+  'proposal.photograph': 'Photographs',
+  'proposal.visualisation': 'Visualisations',
+};

v0.1.0/types/enums/Flags.ts

@@ -0,0 +1,42 @@
+/**
+ * Flags and their flagset that make up a result
+ */
+export const Flags = {
+  'Planning permission / Immune':
+    'It looks like the changes may now be beyond the time limit for enforcement action. This does not apply if the changes have been deliberately concealed.',
+  'Planning permission / Missing information':
+    'There is some key information missing that will be needed to assess this application.',
+  'Planning permission / Permission needed':
+    'It looks like the proposed changes may require planning permission.',
+  'Planning permission / Prior approval':
+    'It looks like the proposed changes do not require planning permission, however the applicant must apply for Prior Approval before proceeding.',
+  'Planning permission / Notice':
+    'It looks like the proposed changes may not require planning permission, however the applicant must provide notice to the planning authority before proceeding.',
+  'Planning permission / Permitted development':
+    'It looks like the proposed changes may fall within the rules for Permitted Development and therefore would not need planning permission.',
+  'Planning permission / Not development':
+    "It looks like the proposed changes may not fall within the legal definition of 'development', and therefore would not require planning permission.",
+  'Listed building consent / Missing information': '',
+  'Listed building consent / Required': '',
+  'Listed building consent / De minimis': '',
+  'Listed building consent / Not required': '',
+  'Works to trees & hedges / Missing information': '',
+  'Works to trees & hedges / Required': '',
+  'Works to trees & hedges / De minimis': '',
+  'Works to trees & hedges / Not required': '',
+  'Demolition in a conservation area / Missing information': '',
+  'Demolition in a conservation area / Required': '',
+  'Demolition in a conservation area / De minimis': '',
+  'Demolition in a conservation area / Not required': '',
+  'Planning policy / Missing information': '',
+  'Planning policy / Fails to meet policy': '',
+  'Planning policy / Edge case': '',
+  'Planning policy / Meets policy': '',
+  'Community infrastructure levy / Missing information': '',
+  'Community infrastructure levy / Exemption void': '',
+  'Community infrastructure levy / Exempt': '',
+  'Community infrastructure levy / Relief void': '',
+  'Community infrastructure levy / Relief': '',
+  'Community infrastructure levy / Liable': '',
+  'Community infrastructure levy / Not liable': '',
+};

v0.1.0/types/enums/PlanningConstraints.ts

@@ -0,0 +1,24 @@
+/**
+ * Minimum set of values for `data.property.constraints.planning`
+ *   actual values will also include council-specific variables like `article4.{councilName}.hmo`
+ */
+export const PlanningConstraints = {
+  article4: 'Article 4 Direction area',
+  'article4.caz': 'Central Activities Zone (CAZ)',
+  designated: 'Designated land',
+  'designated.AONB': 'Area of Outstanding Natural Beauty (AONB)',
+  'designated.conservationArea': 'Conservation Area',
+  'designated.nationalPark': 'National Park',
+  'designated.nationalPark.broads': 'National Park - Broads',
+  'designated.SPA': 'Special Protection Area (SPA)',
+  'designated.WHS': 'UNESCO World Heritage Site or buffer zone',
+  listed: 'Listed Building',
+  locallyListed: 'Locally Listed Building',
+  monument: 'Site of a Scheduled Monument',
+  'nature.ASNW': 'Ancient Semi-Natural Woodland (ASNW)',
+  'nature.SAC': 'Special Area of Conservation (SAC)',
+  'nature.SSSI': 'Site of Special Scientific Interest (SSSI)',
+  registeredPark: 'Historic Park or Garden',
+  'road.classified': 'Classified Road',
+  tpo: 'Tree Preservation Order (TPO) or zone',
+};

v0.1.0/types/enums/ProjectTypes.ts

@@ -0,0 +1,137 @@
+/**
+ * Values of `data.proposal.projectType`
+ */
+export const ProjectTypes = {
+  'alter.balcony': 'Add or alter a balcony',
+  'alter.bayWindow': 'Add or remove a bay window',
+  'alter.bayWindow.add': 'Add a bay window',
+  'alter.bayWindow.remove': 'Remove a bay window',
+  'alter.boundary': 'Changes to a fence, wall or gate',
+  'alter.cables': 'Install underground cables',
+  'alter.chimneys': 'Change chimneys',
+  'alter.chimneys.add': 'Add a chimney',
+  'alter.chimneys.replace': 'Replace a chimney',
+  'alter.deck': 'Add a verandah or deck',
+  'alter.drains': 'Work on drains',
+  'alter.equipment.airConditioning': 'Install an air conditioning unit',
+  'alter.equipment.alarm': 'Install a security alarm',
+  'alter.equipment.antennae': 'Install a satellite dish or aerial',
+  'alter.equipment.biomass': 'Install a flue with a biomass burner',
+  'alter.equipment.cctv': 'Install CCTV cameras',
+  'alter.equipment.charging': 'Install a car charging point',
+  'alter.equipment.heatPump': 'Install a heat pump',
+  'alter.equipment.lighting': 'Install outdoor lights',
+  'alter.equipment.solar': 'Install solar panels',
+  'alter.equipment.solar.pv': 'Install solar photovoltaics (PV)',
+  'alter.equipment.solar.thermal': 'Install solar thermal equipment',
+  'alter.equipment.tank': 'Install an outdoor tank (for example a water tank)',
+  'alter.equipment.wind': 'Install a wind turbine',
+  'alter.facades': 'Change the material or colour of the external walls',
+  'alter.highways':
+    'Changes to a public road, pavement or path (including drop kerb)',
+  'alter.landscape': 'Landscaping works',
+  'alter.landscape.ponds': 'Add or remove a pond',
+  'alter.openings.add.door': 'Add one or more new doorways',
+  'alter.openings.add.window': 'Add one or more new windows',
+  'alter.openings.add.windows.high':
+    'Add doorways or new windows - 1.7m or higher',
+  'alter.openings.alter': 'Change the size of doorways or windows',
+  'alter.openings.alter.convert.doorToWindow':
+    'Convert a doorway into a window',
+  'alter.openings.alter.convert.windowToDoor':
+    'Convert a window into a doorway',
+  'alter.openings.alter.enlarge.door': 'Enlarge a door opening',
+  'alter.openings.alter.enlarge.window': 'Enlarge a window opening',
+  'alter.openings.alter.reduce.door': 'Reduce the size of a door opening',
+  'alter.openings.alter.reduce.window': 'Reduce the size of a window opening',
+  'alter.openings.remove': 'Block up doorways or windows',
+  'alter.remove': 'Remove part of a building (such as a decorative feature)',
+  'alter.remove.chimney': 'Remove a chimney',
+  'alter.remove.equipment': 'Remove energy equipment',
+  'alter.repair': 'Repair windows or doors',
+  'alter.replace': 'Replace windows or doors',
+  'alter.replace.doorsToDoors': 'Replace door with door',
+  'alter.replace.doorsToWindows': 'Replace door with window',
+  'alter.replace.windowsToDoors': 'Replace window with door',
+  'alter.replace.windowsToWindows': 'Replace window with window',
+  'alter.roof.materials': 'Replace or change the roof materials',
+  'alter.roof.roofTerrace': 'Add a roof terrace',
+  'alter.roof.shape': 'Change the shape of a roof',
+  'alter.rooflight': 'Add skylights to an existing roof',
+  'alter.secondaryGlazing': 'Add secondary glazing to a window',
+  'alter.shopfronts': 'Add or alter shop fronts',
+  'alter.shutters': 'Add or alter shutters',
+  'alter.soilPipes': 'Add or replace a soil pipe',
+  'alter.staircase': 'Add or change an external staircase',
+  'alter.surfaces': 'Add a decked area or patio',
+  'alter.surfaces.parking': 'Add a driveway or parking area',
+  'alter.swimmingPool': 'Install a swimming pool',
+  'alter.trees': 'Changes to trees or hedges',
+  changeOfUse: 'Convert a building to a different use',
+  'changeofUse.annexe':
+    'Convert part of the property into a  granny flat (residential annexe)',
+  'changeOfUse.caravans': 'Use a caravan or mobile home on the property',
+  'changeOfUse.garage': 'Convert a garage',
+  'changeOfUse.let.part': 'Let a part of the property',
+  'changeOfUse.let.whole': 'Let the property',
+  'changeOfUse.outbuilding':
+    'Convert or change the use of an outbuilding (such as a shed, garage or barn)',
+  'changeOfUse.part': 'Convert or change the use of part of a building',
+  'changeOfUse.whole.homeToHMO': 'Convert a home to bedsits or a shared home',
+  'changeOfUse.whole': 'Change the use of a property',
+  'changeOfUse.workFromHome': 'Work from home',
+  demolish: 'Demolish a building',
+  'demolish.boundary': 'Demolish a fence, gate or boundary wall',
+  'demolish.full': 'Demolish a building',
+  'demolish.outbuildings': 'Demolish an outbuilding (such as a garage or barn)',
+  'demolish.part': 'Demolish part of a building (such as an extension)',
+  'demolish.replace': 'Demolish a building and build homes in its place',
+  'extend.basement': 'Add a basement extension',
+  'extend.front': 'Add a front extension',
+  'extend.outbuildings':
+    'Add an outbuilding (such as a shed, garage or garden office)',
+  'extend.outbuildings.animals':
+    'Add an outbuilding - animal enclosure, aviary or beehive',
+  'extend.outbuildings.annexe':
+    'Add an outbuilding - residential (or "granny") annexe',
+  'extend.outbuildings.bedroom': 'Add an outbuilding - bedroom or guest room',
+  'extend.outbuildings.games': 'Add an outbuilding - games room',
+  'extend.outbuildings.garage': 'Add an outbuilding - garage',
+  'extend.outbuildings.greenhouse': 'Add an outbuilding - greenhouse',
+  'extend.outbuildings.gym': 'Add an outbuilding - gym',
+  'extend.outbuildings.office': 'Add an outbuilding - office',
+  'extend.outbuildings.other': 'Add an outbuilding - something else',
+  'extend.outbuildings.sauna': 'Add an outbuilding - sauna',
+  'extend.outbuildings.shed': 'Add an outbuilding - shed',
+  'extend.outbuildings.shelter':
+    'Add an outbuilding - car parking or smoking shelter',
+  'extend.outbuildings.store': 'Add an outbuilding - storage',
+  'extend.outbuildings.studio': 'Add an outbuilding - studio',
+  'extend.outbuildings.summerHouse': 'Add an outbuilding - summer house',
+  'extend.outbuildings.swimmingPool': 'Add an outbuilding - swimming pool',
+  'extend.outbuildings.tank': 'Add an outbuilding - tank',
+  'extend.outbuildings.workshop': 'Add an outbuilding - workshop',
+  'extend.porch': 'Add a porch',
+  'extend.rear': 'Add a rear or side extension (or conservatory)',
+  'extend.roof': 'Add a roof extension',
+  'extend.roof.dormer': 'Add roof dormers',
+  internal: 'Internal building works, such as change the internal layout',
+  'internal.loft': 'Convert a loft',
+  'internal.mezzanine': 'Add a mezzanine floor',
+  new: 'Another type of building',
+  'new.agriculture': 'Agricultural buildings',
+  'new.clickCollect': 'Install click and collect facilities',
+  'new.dwelling': 'New, self-contained dwelling',
+  'new.forestry': 'Build new forestry buildings',
+  'new.industrial': 'Industrial premises',
+  'new.leisure': 'Leisure premises',
+  'new.office': 'Offices',
+  'new.residential.dwelling': 'Build new homes on a roof',
+  'new.retail': 'Retail premises',
+  'new.telecoms': 'Install telecommunications equipment',
+  'new.temporaryStructure':
+    'Erect a temporary structure for historic visitor attractions and listed buildings',
+  'new.warehouse': 'Storage or distribution premises',
+  'unit.merge': 'Convert two or more properties into one',
+  'unit.subdivide': 'Convert a home or part of a home into flats',
+};