Skip to content

Commit 58cee07

Browse files
DafyddLlyrDafyddLlyr
committed
Add build files for v0.7.0
1 parent 7ceabe2 commit 58cee07

40 files changed

+48207
-0
lines changed

Diff for: ‎v0.7.0/examples/landDrainageConsent.json

+1,143
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/lawfulDevelopmentCertificate/existing.json

+1,926
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/lawfulDevelopmentCertificate/proposed.json

+1,278
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/listedBuildingConsent.json

+1,226
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/planningPermission/fullHouseholder.json

+1,728
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/planningPermission/major.json

+2,438
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/planningPermission/minor.json

+1,698
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/priorApproval/buildHomes.json

+1,910
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/priorApproval/convertCommercialToHome.json

+1,686
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/priorApproval/extendUniversity.json

+1,819
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/priorApproval/largerExtension.json

+1,572
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/examples/priorApproval/solarPanels.json

+1,528
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/schema.json

+25,375
Large diffs are not rendered by default.

Diff for: ‎v0.7.0/types/Schema.ts

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import {File} from './schema/File';
2+
import {Metadata} from './schema/Metadata';
3+
import {PreAssessment} from './schema/PreAssessment';
4+
import {Responses} from './schema/Responses';
5+
import {Applicant} from './schema/data/Applicant';
6+
import {Application} from './schema/data/Application';
7+
import {FilesAsData} from './schema/data/Files';
8+
import {Property} from './schema/data/Property';
9+
import {Proposal} from './schema/data/Proposal';
10+
import {User} from './schema/data/User';
11+
12+
/**
13+
* @title Digital Planning Application
14+
* @description The root specification for a planning application in England generated by a digital planning service
15+
*/
16+
export interface Schema {
17+
data: {
18+
application: Application;
19+
user: User;
20+
applicant: Applicant;
21+
property: Property;
22+
proposal: Proposal;
23+
files?: FilesAsData;
24+
};
25+
preAssessment?: PreAssessment;
26+
responses: Responses;
27+
files: File[];
28+
metadata: Metadata;
29+
}

Diff for: ‎v0.7.0/types/enums/ApplicationTypes.ts

+179
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
/**
2+
* Values of `data.application.type`
3+
*/
4+
export const ApplicationTypes = {
5+
advertConsent: 'Consent to display an advertisement',
6+
amendment:
7+
'Consent to make small changes to a project with Planning Permission',
8+
'amendment.minorMaterial':
9+
'Consent to make small (minor material) changes to a project with Planning Permission',
10+
'amendment.nonMaterial':
11+
'Consent to make small (non-material) changes to a project with Planning Permission',
12+
approval: 'Planning approval',
13+
'approval.reservedMatters': 'Approval of reserved matters',
14+
complianceConfirmation:
15+
'Written confirmation of compliance with a planning condition',
16+
environmnentalImpact: 'Environmental Impact Decision',
17+
'environmentalImpact.scoping': 'Environmental Impact Decision - Scoping',
18+
'environmentalImpact.screening': 'Environmental Impact Decision - Screening',
19+
hazardousSubstanceConsent:
20+
'Consent to move and dispose of hazardous substances',
21+
hedgerowRemovalNotice: 'Notice to remove a hedge',
22+
landDrainageConsent:
23+
'Consent to do works affecting ordinary watercourses or land drainage',
24+
ldc: 'Lawful Development Certificate',
25+
'ldc.proposed': 'Lawful Development Certificate - Proposed use',
26+
'ldc.existing': 'Lawful Development Certificate - Existing use',
27+
'ldc.existing.regularise':
28+
'Lawful Development Certificate - Continue an existing use',
29+
'ldc.condition':
30+
'Lawful Development Certificate - Lawful not to comply with a condition or limitation',
31+
listed: 'Consent to do works to a Listed Building',
32+
notifyCompletion: 'Notification of completion',
33+
obligation: 'Planning obligation',
34+
'obligation.discharge': 'Discharge a planning obligation',
35+
'obligation.modify': 'Modify a planning obligation',
36+
pa: 'Prior Approval',
37+
'pa.part1.classA': 'Prior Approval - Larger extension to a house',
38+
'pa.part1.classAA': 'Prior Approval - Adding storeys to a house',
39+
'pa.part3.classG':
40+
'Prior Approval - Convert a commercial building to mixed use',
41+
'pa.part3.classM':
42+
'Prior Approval - Convert a mixed use building into a home',
43+
'pa.part3.classMA':
44+
'Prior Approval - Convert a commercial building into a home or homes',
45+
'pa.part3.classN':
46+
'Prior Approval - Convert a casino or amusement arcade into a home or homes',
47+
'pa.part3.classQ':
48+
'Prior Approval - Convert an agricultural building into a home',
49+
'pa.part3.classR':
50+
'Prior Approval - Convert an agricultural building to a commercial use',
51+
'pa.part3.classS':
52+
'Prior Approval - Convert an agricultural building to a school',
53+
'pa.part3.classT':
54+
'Prior Approval - Convert a commercial building to a school',
55+
'pa.part3.classV':
56+
'Prior Approval - Changes of use permitted under a permission granted on an application',
57+
'pa.part4.classBB': 'Prior Approval - Put up a temporary structure',
58+
'pa.part4.classBC': 'Prior Approval - Develop a temporary campsite',
59+
'pa.part4.classCA':
60+
'Prior Approval - Put temporary school buildings on vacant commercial land',
61+
'pa.part4.classE': 'Prior Approval - Use a building or land to shoot a film',
62+
'pa.part6':
63+
'Prior Approval - Alter or add new buildings to agricultural or forestry sites',
64+
'pa.part6.classA':
65+
'Prior Approval - Build new agricultural buildings on a unit of 5 hectares or more',
66+
'pa.part6.classB':
67+
'Prior Approval - Build new agricultural buildings on a unit of less than 5 hectares',
68+
'pa.part6.classE': 'Prior Approval - Build new forestry buildings',
69+
'pa.part7.classC': 'Prior Approval - Install click and collect facilities',
70+
'pa.part7.classM':
71+
'Prior Approval - Extend a school, college, university, prison or hospital',
72+
'pa.part9.classD': 'Prior Approval - Development of toll facilities',
73+
'pa.part11.classB': 'Prior Approval - Demolish a building',
74+
'pa.part14.classA':
75+
'Prior Approval - Install or change solar equipment on domestic premises',
76+
'pa.part14.classB':
77+
'Prior Approval - Install or change stand-alone solar equipment on domestic premises',
78+
'pa.part14.classJ': 'Prior Approval - Install or change solar panels',
79+
'pa.part14.classK':
80+
'Prior Approval - Install or change stand-alone solar equipment on non-domestic premises',
81+
'pa.part14.classOA':
82+
'Prior Approval - Installation of a solar canopy on non-domestic, off-street parking',
83+
'pa.part16.classA': 'Prior Approval - Install telecommunications equipment',
84+
'pa.part17': 'Prior Approval - Coal mining',
85+
'pa.part17.classB':
86+
'Prior Approval - Other developments ancillary to mining operations',
87+
'pa.part17.classC': 'Prior Approval - Developments for maintenance or safety',
88+
'pa.part17.classG':
89+
'Prior Approval - Coal mining development by the Coal Authority for maintence or safety',
90+
'pa.part18.classA':
91+
'Prior Approval - Development under private acts or orders',
92+
'pa.part19.classTA': 'Prior Approval - Development on a closed defence site',
93+
'pa.part20.classA':
94+
'Prior Approval - Build homes on a detached blocks of flats',
95+
'pa.part20.classAA':
96+
'Prior Approval - Build homes on a detached commercial building',
97+
'pa.part20.classAB':
98+
'Prior Approval - Build homes on an adjoining commercial or mixed use building',
99+
'pa.part20.classAC': 'Prior Approval - Build homes on adjoining houses',
100+
'pa.part20.classAD': 'Prior Approval - Build homes on detached houses',
101+
'pa.part20.classZA':
102+
'Prior Approval - Demolish buildings and build homes in their place',
103+
pp: 'Planning Permission',
104+
'pp.full':
105+
'Planning Permission for development, including all householder, minor, and major applications',
106+
'pp.full.advertConsent':
107+
'Full Planning Permission and consent to display an advert',
108+
'pp.full.demolition':
109+
'Full Planning Permission including demolition in a Conservation Area',
110+
'pp.full.fastTrack.affordable':
111+
'Full Planning Permission - Fast track for the purposes of Affordable Housing',
112+
'pp.full.householder': 'Planning Permission - Full householder',
113+
'pp.full.householder.listed':
114+
'Planning Permission - Full householder with consent to do works to a Listed Building',
115+
'pp.full.householder.retro':
116+
'Planning Permission - Full householder retrospective',
117+
'pp.full.major': 'Planning Permission - Major application',
118+
'pp.full.major.technicalDetails':
119+
'Planning Permission - Technical details consent for major development',
120+
'pp.full.major.technicalDetails.waste':
121+
'Planning Permission - Technical details consent for waste development',
122+
'pp.full.major.waste':
123+
'Planning Permission - Full planning permission for waste development',
124+
'pp.full.minor': 'Planning Permission - Minor application',
125+
'pp.full.minor.listed':
126+
'Planning Permission - Minor application and consent to do works to a Listed Building',
127+
'pp.full.minor.technicalDetails':
128+
'Planning Permission - Technical details consent for minor development',
129+
'pp.mineralExtraction':
130+
'Planning Permission - Consent to extract minerals and related development, such as temporary buildings and roads',
131+
'pp.onshoreExtractionOilAndGas':
132+
'Planning Permission - Consent to extract oil and gas',
133+
'pp.outline': 'Planning permission - Outline for proposed development',
134+
'pp.outline.all':
135+
'Outline Planning Permission - Consent for the principle of a project witholding all details',
136+
'pp.outline.some':
137+
'Outline Planning Permission - Consent for the principle of a project specifying some details',
138+
'pp.outline.minor':
139+
'Planning permission - Outline for proposed development (minor)',
140+
'pp.outline.minor.all':
141+
'Outline Planning Permission - Consent for the principle of a project witholding all details (minor)',
142+
'pp.outline.minor.some':
143+
'Outline Planning Permission - Consent for the principle of a project specifying some details (minor)',
144+
'pp.outline.major':
145+
'Planning permission - Outline for proposed development (major)',
146+
'pp.outline.major.all':
147+
'Outline Planning Permission - Consent for the principle of a project witholding all details (major)',
148+
'pp.outline.major.all.waste':
149+
'Outline Planning Permission - Consent for the principle of waste development witholding all details',
150+
'pp.outline.major.some':
151+
'Outline Planning Permission - Consent for the principle of a project specifying some details (major)',
152+
'pp.outline.major.some.waste':
153+
'Outline Planning Permission - Consent for the principle of waste development witholding all details',
154+
'pp.pip':
155+
'Planning Permission in Principle - Consent for the principle of a project with less than 1,000 square metres floor area on a site of less than 1 hectare',
156+
rightsOfWayOrder: 'Rights of Way Order - Apply to move or close a path',
157+
wtt: 'Works to trees',
158+
'wtt.consent':
159+
'Works to trees - Consent to carry out works to a tree with a Tree Preservation Order',
160+
'wtt.notice':
161+
'Works to trees - Notification of proposed works to a tree in a Conservation Area',
162+
};
163+
164+
type ApplicationTypeKeys = keyof typeof ApplicationTypes;
165+
166+
type GenericApplicationType<TKey extends ApplicationTypeKeys> = {
167+
value: TKey;
168+
description: (typeof ApplicationTypes)[TKey];
169+
};
170+
171+
type ApplicationTypeMap = {
172+
[K in ApplicationTypeKeys]: GenericApplicationType<K>;
173+
};
174+
175+
/**
176+
* @id #ApplicationType
177+
* @description Planning application types
178+
*/
179+
export type ApplicationType = ApplicationTypeMap[keyof ApplicationTypeMap];

Diff for: ‎v0.7.0/types/enums/BuildingRegulations.ts

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/**
2+
* Values of `data.proposal.units.residential`
3+
*/
4+
export const BuildingRegulations = {
5+
m42: 'Part M4(2) of the Building Regulations 2010',
6+
m432a: 'Part M4(3)(2a) of the Building Regulations 2010',
7+
m432b: 'Part M4(3)(2b) of the Building Regulations 2010',
8+
none: 'None of these',
9+
};
10+
11+
type BuildingRegulationKeys = keyof typeof BuildingRegulations;
12+
13+
type GenericBuildingRegulation<TKey extends BuildingRegulationKeys> = {
14+
value: TKey;
15+
description: (typeof BuildingRegulations)[TKey];
16+
};
17+
18+
type BuildingRegulationMap = {
19+
[K in BuildingRegulationKeys]: GenericBuildingRegulation<K>;
20+
};
21+
22+
/**
23+
* @id #BuildingRegulation
24+
* @description Building regulations
25+
*/
26+
export type BuildingRegulation =
27+
BuildingRegulationMap[keyof BuildingRegulationMap];

Diff for: ‎v0.7.0/types/enums/DevelopmentTypes.ts

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
export const DevelopmentTypes = {
2+
changeOfUse: 'Change of use',
3+
changeOfUseFrom: 'Change of use of an existing single home',
4+
changeOfUseTo: 'Change of use to a home',
5+
conversion: 'Conversion',
6+
extension: 'Extension',
7+
newBuild: 'New build',
8+
notKnown: 'Not known',
9+
};
10+
11+
type DevelopmentTypeKeys = keyof typeof DevelopmentTypes;
12+
13+
type GenericDevelopmentType<TKey extends DevelopmentTypeKeys> = {
14+
value: TKey;
15+
description: (typeof DevelopmentTypes)[TKey];
16+
};
17+
18+
type DevelopmentTypeMap = {
19+
[K in DevelopmentTypeKeys]: GenericDevelopmentType<K>;
20+
};
21+
22+
/**
23+
* @id #DevelopmentType
24+
* @description Development types
25+
*/
26+
export type DevelopmentType = DevelopmentTypeMap[keyof DevelopmentTypeMap];

Diff for: ‎v0.7.0/types/enums/FileTypes.ts

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
/**
2+
* Values of `file.type`
3+
*/
4+
export const FileTypes = {
5+
accessRoadsRightsOfWayDetails:
6+
'Details of impact on access, roads, and rights of way',
7+
affordableHousingStatement: 'Affordable housing statement',
8+
arboriculturistReport: 'Arboriculturist report',
9+
bankStatement: 'Bank statement',
10+
basementImpactStatement: 'Basement impact statement',
11+
bioaerosolAssessment: 'Bio-aerosol assessment',
12+
birdstrikeRiskManagementPlan: 'Birdstrike risk management plan',
13+
boreholeOrTrialPitAnalysis: 'Borehole or trial pit analysis',
14+
buildingControlCertificate: 'Building control certificate',
15+
conditionSurvey: 'Structural or building condition survey',
16+
constructionInvoice: 'Construction invoice',
17+
contaminationReport: 'Contamination report',
18+
councilTaxBill: 'Council tax bill',
19+
crimePreventionStrategy: 'Crime prevention strategy',
20+
designAndAccessStatement: 'Design and Access Statement',
21+
disabilityExemptionEvidence:
22+
'Evidence for application fee exemption - disability',
23+
ecologyReport: 'Ecology report',
24+
'elevations.existing': 'Elevations - existing',
25+
'elevations.proposed': 'Elevations - proposed',
26+
emissionsMitigationAndMonitoringScheme:
27+
'Scheme for mitigation and monitoring of emissions (dust, odour and vibrations)',
28+
energyStatement: 'Energy statement',
29+
environmentalImpactAssessment: 'Environmental Impact Assessment (EIA)',
30+
externalMaterialsDetails: 'External materials details',
31+
fireSafetyReport: 'Fire safety report',
32+
floodRiskAssessment: 'Flood risk assessment (FRA)',
33+
'floorPlan.existing': 'Floor plan - existing',
34+
'floorPlan.proposed': 'Floor plan - proposed',
35+
foulDrainageAssessment: 'Foul drainage assessment',
36+
geodiversityAssessment: 'Geodiversity assessment',
37+
hedgerowsInformation:
38+
'Plans showing the stretches of hedgerows to be removed',
39+
'hedgerowsInformation.plantingDate':
40+
'Evidence of the date of planting of the removed hedgerows',
41+
heritageStatement: 'Heritage Statement',
42+
hydrologicalAssessment: 'Hydrological and hydrogeological assessment',
43+
hydrologyReport: 'Hydrology report',
44+
internalElevations: 'Internal elevations',
45+
internalSections: 'Internal sections',
46+
joinersReport: "Joiner's report",
47+
joinerySections: 'Joinery section report',
48+
landContaminationAssessment: 'Land contamination assessment',
49+
landscapeAndVisualImpactAssessment:
50+
'Landscape and visual impact assessment (LVIA)',
51+
landscapeStrategy: 'Landscape strategy or landscape plan',
52+
lightingAssessment: 'Lighting assessment',
53+
litterVerminAndBirdControlDetails:
54+
'Details of litter, vermin and bird control',
55+
locationPlan: 'Location plan',
56+
methodStatement: 'Method statement',
57+
mineralsAndWasteAssessment: 'Minerals and waste assessment',
58+
necessaryInformation:
59+
'Information the authority considers necessary for the application',
60+
newDwellingsSchedule: 'New dwellings schedule',
61+
noiseAssessment: 'Noise assessment',
62+
openSpaceAssessment: 'Open space assessment',
63+
otherDocument: 'Other - document',
64+
otherDrawing: 'Other - drawing',
65+
otherEvidence: 'Other - evidence or correspondence',
66+
parkingPlan: 'Parking plan',
67+
'photographs.existing': 'Photographs - existing',
68+
'photographs.proposed': 'Photographs - proposed',
69+
planningStatement: 'Planning statement',
70+
recycleWasteStorageDetails: 'Recyclable waste storage details',
71+
relevantInformation:
72+
'Information the applicant considers relevant to the application',
73+
residentialUnitsDetails: 'Residential units details',
74+
'roofPlan.existing': 'Roof plan - existing',
75+
'roofPlan.proposed': 'Roof plan - proposed',
76+
'sections.existing': 'Sections - existing',
77+
'sections.proposed': 'Sections - proposed',
78+
'sitePlan.existing': 'Site plan - existing',
79+
'sitePlan.proposed': 'Site plan - proposed',
80+
sketchPlan: 'Sketch plan',
81+
statementOfCommunityInvolvement: 'Statement of community involvement',
82+
statutoryDeclaration: 'Statutory declaration',
83+
storageTreatmentAndWasteDisposalDetails:
84+
'Details of storage treatment or disposal of waste',
85+
streetScene: 'Street scene drawing',
86+
subsidenceReport: 'Subsidence report',
87+
sunlightAndDaylightReport: 'Sunlight and daylight report',
88+
sustainabilityStatement: 'Sustainability statement',
89+
technicalEvidence: 'Technical evidence',
90+
technicalSpecification: 'Technical specification',
91+
tenancyAgreement: 'Tenancy agreement',
92+
tenancyInvoice: 'Tenancy invoice',
93+
townCentreImpactAssessment: 'Town centre uses - Impact assessment',
94+
townCentreSequentialAssessment: 'Town centre uses - Sequential assessment',
95+
transportAssessment: 'Transport assessment',
96+
travelPlan: 'Travel plan',
97+
treeAndHedgeLocation: 'Location of trees and hedges',
98+
treeAndHedgeRemovedOrPruned: 'Removed or pruned trees and hedges',
99+
treeCanopyCalculator: 'Tree canopy calculator',
100+
treeConditionReport: 'Tree condition report',
101+
treePlan: 'Tree plan',
102+
treesReport: 'Trees report',
103+
'unitPlan.existing': 'Unit plan - existing',
104+
'unitPlan.proposed': 'Unit plan - proposed',
105+
'usePlan.existing': 'Use plan - existing',
106+
'usePlan.proposed': 'Use plan - proposed',
107+
utilityBill: 'Utility bill',
108+
utilitiesStatement: 'Utilities statement',
109+
ventilationStatement: 'Ventilation or extraction statement',
110+
viabilityAppraisal: 'Viability Appraisal',
111+
visualisations: 'Visualisations',
112+
wasteAndRecyclingStrategy: 'Waste and recycling strategy',
113+
wasteStorageDetails: 'Waste storage details',
114+
waterEnvironmentAssessment: 'Water environment assessment',
115+
};
116+
117+
type FileTypeKeys = keyof typeof FileTypes;
118+
119+
type GenericFileType<TKey extends FileTypeKeys> = {
120+
value: TKey;
121+
description: (typeof FileTypes)[TKey];
122+
};
123+
124+
type FileTypeMap = {
125+
[K in FileTypeKeys]: GenericFileType<K>;
126+
};
127+
128+
/**
129+
* @id #FileType
130+
* @description Types of planning documents and drawings
131+
*/
132+
export type FileType = FileTypeMap[keyof FileTypeMap];

0 commit comments

Comments
 (0)