Skip to content

Commit

Permalink
Merge branch 'main' of github.com:theopensystemslab/digital-planning-…
Browse files Browse the repository at this point in the history
…data-schemas into v0.3.0
  • Loading branch information
jessicamcinchak committed Feb 8, 2024
2 parents da653ef + 2510a94 commit cdc8109
Show file tree
Hide file tree
Showing 7 changed files with 215 additions and 3 deletions.
35 changes: 35 additions & 0 deletions examples/data/ldcE.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1233,6 +1233,41 @@ export const validLDCE: Schema = {
service: {
flowId: '824628b2-deeb-48b0-92b1-2ca7f3b17163',
url: 'https://www.editor.planx.dev/buckinghamshire/apply-for-a-lawful-development-certificate/preview',
files: {
required: [
{
value: 'photographs.proposed',
description: 'Photographs - proposed',
},
{
value: 'sitePlan.proposed',
description: 'Site plan - proposed',
},
{
value: 'elevations.proposed',
description: 'Elevations - proposed',
},
{
value: 'floorPlan.proposed',
description: 'Floor plan - proposed',
},
{
value: 'floorPlan.proposed',
description: 'Floor plan - proposed',
},
],
recommended: [
{
value: 'otherEvidence',
description: 'Other - evidence or correspondence',
},
{
value: 'constructionInvoice',
description: 'Construction invoice',
},
],
optional: [],
},
},
submittedAt: '2023-10-02t00:00:00z',
schema:
Expand Down
38 changes: 38 additions & 0 deletions examples/data/ldcP.ts
Original file line number Diff line number Diff line change
Expand Up @@ -837,6 +837,44 @@ export const validLDCP: Schema = {
service: {
flowId: '824628b2-deeb-48b0-92b1-2ca7f3b17163',
url: 'https://www.editor.planx.dev/buckinghamshire/apply-for-a-lawful-development-certificate/preview',
files: {
required: [
{
value: 'roofPlan.existing',
description: 'Roof plan - existing',
},
{
value: 'sitePlan.existing',
description: 'Site plan - existing',
},
{
value: 'roofPlan.proposed',
description: 'Roof plan - proposed',
},
{
value: 'sitePlan.proposed',
description: 'Site plan - proposed',
},
{
value: 'elevations.existing',
description: 'Elevations - existing',
},
{
value: 'floorPlan.existing',
description: 'Floor plan - existing',
},
{
value: 'elevations.proposed',
description: 'Elevations - proposed',
},
{
value: 'floorPlan.proposed',
description: 'Floor plan - proposed',
},
],
recommended: [],
optional: [],
},
},
submittedAt: '2023-10-02T00:00:00+01:00',
schema:
Expand Down
39 changes: 39 additions & 0 deletions examples/data/planningPermission.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1255,6 +1255,45 @@ export const validPlanningPermission: Schema = {
service: {
flowId: '01e38c5d-e701-4e44-acdc-4d6b5cc3b854',
url: 'https://www.editor.planx.dev/lambeth/apply-for-planning-permission/preview',
files: {
required: [
{
value: 'roofPlan.existing',
description: 'Roof plan - existing',
},
{
value: 'roofPlan.proposed',
description: 'Roof plan - proposed',
},
{
value: 'sitePlan.existing',
description: 'Site plan - existing',
},
{
value: 'sitePlan.proposed',
description: 'Site plan - proposed',
},
{
value: 'elevations.existing',
description: 'Elevations - existing',
},
{
value: 'elevations.proposed',
description: 'Elevations - proposed',
},
],
recommended: [
{
value: 'floorPlan.existing',
description: 'Floor plan - existing',
},
{
value: 'floorPlan.proposed',
description: 'Floor plan - proposed',
},
],
optional: [],
},
},
submittedAt: '2023-10-02T00:00:00.00Z',
schema:
Expand Down
15 changes: 15 additions & 0 deletions examples/data/priorApproval.ts
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,21 @@ export const validPriorApproval: Schema = {
service: {
flowId: 'c6628103-c648-4663-81e1-bfa0a1a18340',
url: 'https://www.editor.planx.dev/southwark/apply-for-prior-approval/preview',
files: {
required: [
{
value: 'otherDrawing',
description: 'Other - drawing',
},
],
recommended: [
{
value: 'sitePlan.proposed',
description: 'Site plan - proposed',
},
],
optional: [],
},
},
submittedAt: '2023-10-02T00:00:00Z',
schema:
Expand Down
75 changes: 73 additions & 2 deletions schema/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2315,6 +2315,42 @@
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"description": {
"const": "Joiner's report",
"type": "string"
},
"value": {
"const": "joinersReport",
"type": "string"
}
},
"required": [
"value",
"description"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"description": {
"const": "Joinery section report",
"type": "string"
},
"value": {
"const": "joinerySections",
"type": "string"
}
},
"required": [
"value",
"description"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
Expand Down Expand Up @@ -3133,7 +3169,7 @@
"type": "string"
},
"value": {
"const": "utilitiesBill",
"const": "utilityBill",
"type": "string"
}
},
Expand Down Expand Up @@ -4381,6 +4417,9 @@
"service": {
"additionalProperties": false,
"properties": {
"files": {
"$ref": "#/definitions/RequestedFiles"
},
"flowId": {
"$ref": "#/definitions/UUID"
},
Expand All @@ -4390,7 +4429,8 @@
},
"required": [
"flowId",
"url"
"url",
"files"
],
"type": "object"
},
Expand Down Expand Up @@ -20504,6 +20544,37 @@
},
"type": "object"
},
"RequestedFiles": {
"$id": "#RequestedFiles",
"additionalProperties": false,
"description": "File types requested by this service. Schema[\"files\"] will be a subset of this list based on the user's journey through the service.",
"properties": {
"optional": {
"items": {
"$ref": "#/definitions/FileType"
},
"type": "array"
},
"recommended": {
"items": {
"$ref": "#/definitions/FileType"
},
"type": "array"
},
"required": {
"items": {
"$ref": "#/definitions/FileType"
},
"type": "array"
}
},
"required": [
"required",
"recommended",
"optional"
],
"type": "object"
},
"Response": {
"additionalProperties": false,
"properties": {
Expand Down
4 changes: 3 additions & 1 deletion types/enums/FileTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ export const FileTypes = {
hydrologyReport: 'Hydrology report',
internalElevations: 'Internal elevations',
internalSections: 'Internal sections',
joinersReport: "Joiner's report",
joinerySections: 'Joinery section report',
landContaminationAssessment: 'Land contamination assessment',
landscapeAndVisualImpactAssessment:
'Landscape and visual impact assessment (LVIA)',
Expand Down Expand Up @@ -84,7 +86,7 @@ export const FileTypes = {
'unitPlan.proposed': 'Unit plan - proposed',
'usePlan.existing': 'Use plan - existing',
'usePlan.proposed': 'Use plan - proposed',
utilitiesBill: 'Utility bill',
utilityBill: 'Utility bill',
utilitiesStatement: 'Utilities statement',
ventilationStatement: 'Ventilation or extraction statement',
visualisations: 'Visualisations',
Expand Down
12 changes: 12 additions & 0 deletions types/schema/Metadata.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import {DateTime, URL, UUID} from './../utils';
import {FileType} from './File';

/**
* @id #DigitalPlanningMetadata
Expand All @@ -24,6 +25,16 @@ export interface BaseMetadata {
schema: URL;
}

/**
* @id #RequestedFiles
* @description File types requested by this service. Schema["files"] will be a subset of this list based on the user's journey through the service.
*/
export interface RequestedFiles {
required: FileType[];
recommended: FileType[];
optional: FileType[];
}

/**
* @id #PlanXMetadata
* @description Additional metadata associated with applications submitted via PlanX
Expand All @@ -33,5 +44,6 @@ export interface PlanXMetadata extends BaseMetadata {
service: {
flowId: UUID;
url: URL;
files: RequestedFiles;
};
}

0 comments on commit cdc8109

Please sign in to comment.