From 7bc00b42e17230db523ee322efcbc4c29aa01c08 Mon Sep 17 00:00:00 2001 From: Jessica McInchak Date: Wed, 18 Sep 2024 13:13:49 +0200 Subject: [PATCH] correct metadata file requirement enums --- .../data/landDrainageConsent.ts | 16 +- .../lawfulDevelopmentCertificate/existing.ts | 35 +- .../lawfulDevelopmentCertificate/proposed.ts | 40 +- .../data/listedBuildingConsent.ts | 65 +- .../planningPermission/fullHouseholder.ts | 41 +- .../fullHouseholderInConservationArea.ts | 57 +- .../data/planningPermission/major.ts | 16 +- .../data/planningPermission/minor.ts | 16 +- .../data/priorApproval/buildHomes.ts | 67 +- .../priorApproval/convertCommercialToHome.ts | 47 +- .../data/priorApproval/extendUniversity.ts | 35 +- .../data/priorApproval/largerExtension.ts | 40 +- .../data/priorApproval/solarPanels.ts | 33 +- .../landDrainageConsent.json | 10 +- .../existing.json | 34 +- .../proposed.json | 40 +- .../listedBuildingConsent.json | 63 +- .../planningPermission/fullHouseholder.json | 40 +- .../fullHouseholderInConservationArea.json | 57 +- .../planningPermission/major.json | 10 +- .../planningPermission/minor.json | 10 +- .../priorApproval/buildHomes.json | 67 +- .../convertCommercialToHome.json | 45 +- .../priorApproval/extendUniversity.json | 35 +- .../priorApproval/largerExtension.json | 37 +- .../priorApproval/solarPanels.json | 32 +- schemas/prototypeApplication.json | 2159 ++--------------- types/schemas/prototypeApplication/index.ts | 31 +- 28 files changed, 375 insertions(+), 2803 deletions(-) diff --git a/examples/prototypeApplication/data/landDrainageConsent.ts b/examples/prototypeApplication/data/landDrainageConsent.ts index 62255aa4..00f99f02 100644 --- a/examples/prototypeApplication/data/landDrainageConsent.ts +++ b/examples/prototypeApplication/data/landDrainageConsent.ts @@ -646,20 +646,8 @@ export const landDrainageConsentPrototype: PrototypeApplication = { flowId: '5aab3466-8fb0-4e73-b51d-347d61ad5547', url: 'https://editor.planx.dev/medway/apply-for-land-drainage-consent-copy/published', files: { - required: [ - { - value: 'necessaryInformation', - description: - 'Information the authority considers necessary for the application', - }, - ], - recommended: [ - { - value: 'relevantInformation', - description: - 'Information the applicant considers relevant to the application', - }, - ], + required: ['necessaryInformation'], + recommended: ['relevantInformation'], optional: [], }, fee: { diff --git a/examples/prototypeApplication/data/lawfulDevelopmentCertificate/existing.ts b/examples/prototypeApplication/data/lawfulDevelopmentCertificate/existing.ts index 8451e98a..326846c8 100644 --- a/examples/prototypeApplication/data/lawfulDevelopmentCertificate/existing.ts +++ b/examples/prototypeApplication/data/lawfulDevelopmentCertificate/existing.ts @@ -1182,37 +1182,12 @@ export const lawfulDevelopmentCertificateExistingPrototype: PrototypeApplication 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', - }, + 'photographs.proposed', + 'sitePlan.proposed', + 'elevations.proposed', + 'floorPlan.proposed', ], + recommended: ['otherEvidence', 'constructionInvoice'], optional: [], }, fee: { diff --git a/examples/prototypeApplication/data/lawfulDevelopmentCertificate/proposed.ts b/examples/prototypeApplication/data/lawfulDevelopmentCertificate/proposed.ts index 6e8ee82c..7fb03fac 100644 --- a/examples/prototypeApplication/data/lawfulDevelopmentCertificate/proposed.ts +++ b/examples/prototypeApplication/data/lawfulDevelopmentCertificate/proposed.ts @@ -756,38 +756,14 @@ export const lawfulDevelopmentCertificateProposedPrototype: PrototypeApplication 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', - }, + 'roofPlan.existing', + 'sitePlan.existing', + 'roofPlan.proposed', + 'sitePlan.proposed', + 'elevations.existing', + 'floorPlan.existing', + 'elevations.proposed', + 'floorPlan.proposed', ], recommended: [], optional: [], diff --git a/examples/prototypeApplication/data/listedBuildingConsent.ts b/examples/prototypeApplication/data/listedBuildingConsent.ts index acbbc5fd..5a687f74 100644 --- a/examples/prototypeApplication/data/listedBuildingConsent.ts +++ b/examples/prototypeApplication/data/listedBuildingConsent.ts @@ -1050,61 +1050,24 @@ export const listedBuildingConsentPrototype: PrototypeApplication = { source: 'PlanX', service: { flowId: '2677568c-00d2-4391-98ea-f34a4e743437', - url: 'https://www.editor.planx.uk/camden/apply-for-listed-building-consent/published', + url: 'https://www.editor.planx.dev/camden/apply-for-listed-building-consent/published', files: { required: [ - { - 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', - }, - { - value: 'floorPlan.existing', - description: 'Floor plan - existing', - }, - { - value: 'floorPlan.proposed', - description: 'Floor plan - proposed', - }, - { - value: 'joinerySections', - description: 'Joinery section report', - }, - ], - recommended: [ - { - value: 'heritageStatement', - description: 'Heritage Statement', - }, + 'sitePlan.existing', + 'sitePlan.proposed', + 'elevations.existing', + 'elevations.proposed', + 'floorPlan.existing', + 'floorPlan.proposed', + 'joinerySections', ], + recommended: ['heritageStatement'], optional: [ - { - value: 'photographs.existing', - description: 'Photographs - existing', - }, - { - value: 'otherDrawing', - description: 'Other - drawing', - }, - { - value: 'otherDocument', - description: 'Other - document', - }, - { - value: 'visualisations', - description: 'Visualisations', - }, + 'photographs.existing', + 'photographs.proposed', + 'otherDrawing', + 'otherDocument', + 'visualisations', ], }, fee: { diff --git a/examples/prototypeApplication/data/planningPermission/fullHouseholder.ts b/examples/prototypeApplication/data/planningPermission/fullHouseholder.ts index bba434a3..35d83b19 100644 --- a/examples/prototypeApplication/data/planningPermission/fullHouseholder.ts +++ b/examples/prototypeApplication/data/planningPermission/fullHouseholder.ts @@ -1076,41 +1076,14 @@ export const planningPermissionFullHouseholderPrototype: PrototypeApplication = 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', - }, + 'roofPlan.existing', + 'roofPlan.proposed', + 'sitePlan.existing', + 'sitePlan.proposed', + 'elevations.existing', + 'elevations.proposed', ], + recommended: ['floorPlan.existing', 'floorPlan.proposed'], optional: [], }, fee: { diff --git a/examples/prototypeApplication/data/planningPermission/fullHouseholderInConservationArea.ts b/examples/prototypeApplication/data/planningPermission/fullHouseholderInConservationArea.ts index d99b1f8d..5b5f9f1b 100644 --- a/examples/prototypeApplication/data/planningPermission/fullHouseholderInConservationArea.ts +++ b/examples/prototypeApplication/data/planningPermission/fullHouseholderInConservationArea.ts @@ -1149,56 +1149,23 @@ export const planningPermissionFullHouseholderInConservationAreaPrototype: Proto source: 'PlanX', service: { flowId: 'bba306e7-15c8-438f-a71e-a1e5d3a99caf', - url: 'https://editor.planx.uk/southwark/apply-for-planning-permission/published', + url: 'https://editor.planx.dev/southwark/apply-for-planning-permission/published', files: { required: [ - { - 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', - }, - { - value: 'floorPlan.existing', - description: 'Floor plan - existing', - }, - { - value: 'floorPlan.proposed', - description: 'Floor plan - proposed', - }, - { - value: 'heritageStatement', - description: 'Heritage Statement', - }, + 'sitePlan.existing', + 'sitePlan.proposed', + 'elevations.existing', + 'elevations.proposed', + 'floorPlan.existing', + 'floorPlan.proposed', + 'heritageStatement', ], recommended: [], optional: [ - { - value: 'photographs.existing', - description: 'Photographs - existing', - }, - { - value: 'otherDrawing', - description: 'Other - drawing', - }, - { - value: 'otherDocument', - description: 'Other - document', - }, - { - value: 'visualisations', - description: 'Visualisations', - }, + 'photographs.existing', + 'otherDocument', + 'otherDrawing', + 'visualisations', ], }, fee: { diff --git a/examples/prototypeApplication/data/planningPermission/major.ts b/examples/prototypeApplication/data/planningPermission/major.ts index 089b4fcf..05863d7f 100644 --- a/examples/prototypeApplication/data/planningPermission/major.ts +++ b/examples/prototypeApplication/data/planningPermission/major.ts @@ -2095,20 +2095,8 @@ export const planningPermissionMajorPrototype: PrototypeApplication = { flowId: '28e258a7-812f-4390-b520-7c00e7f5cd77', url: 'https://editor.planx.dev/buckinghamshire/apply-for-planning-permission/published', files: { - required: [ - { - value: 'necessaryInformation', - description: - 'Information the authority considers necessary for the application', - }, - ], - recommended: [ - { - value: 'relevantInformation', - description: - 'Information the applicant considers relevant to the application', - }, - ], + required: ['necessaryInformation'], + recommended: ['relevantInformation'], optional: [], }, fee: { diff --git a/examples/prototypeApplication/data/planningPermission/minor.ts b/examples/prototypeApplication/data/planningPermission/minor.ts index 003c1a29..3e876543 100644 --- a/examples/prototypeApplication/data/planningPermission/minor.ts +++ b/examples/prototypeApplication/data/planningPermission/minor.ts @@ -1591,20 +1591,8 @@ export const planningPermissionMinorPrototype: PrototypeApplication = { flowId: '28e258a7-812f-4390-b520-7c00e7f5cd77', url: 'https://editor.planx.dev/buckinghamshire/apply-for-planning-permission/published', files: { - required: [ - { - value: 'necessaryInformation', - description: - 'Information the authority considers necessary for the application', - }, - ], - recommended: [ - { - value: 'relevantInformation', - description: - 'Information the applicant considers relevant to the application', - }, - ], + required: ['necessaryInformation'], + recommended: ['relevantInformation'], optional: [], }, fee: { diff --git a/examples/prototypeApplication/data/priorApproval/buildHomes.ts b/examples/prototypeApplication/data/priorApproval/buildHomes.ts index 33fbc461..d53fd30d 100644 --- a/examples/prototypeApplication/data/priorApproval/buildHomes.ts +++ b/examples/prototypeApplication/data/priorApproval/buildHomes.ts @@ -1666,64 +1666,25 @@ export const priorApprovalBuildHomesPrototype: PrototypeApplication = { source: 'PlanX', service: { flowId: '6f76e837-7a42-40f3-80e9-a9482dce5982', - url: 'https://editor.planx.uk/buckinghamshire/apply-for-prior-approval/published', + url: 'https://editor.planx.dev/buckinghamshire/apply-for-prior-approval/published', files: { required: [ - { - value: 'sitePlan.proposed', - description: 'Site plan - proposed', - }, - { - value: 'elevations.existing', - description: 'Elevations - existing', - }, - { - value: 'elevations.proposed', - description: 'Elevations - proposed', - }, - { - value: 'floorPlan.existing', - description: 'Floor plan - existing', - }, - { - value: 'floorPlan.proposed', - description: 'Floor plan - proposed', - }, - { - value: 'roofPlan.proposed', - description: 'Roof plan - proposed', - }, - { - value: 'sections.existing', - description: 'Sections - existing', - }, - { - value: 'sections.proposed', - description: 'Sections - proposed', - }, - { - value: 'noiseAssessment', - description: 'Noise assessment', - }, + 'sitePlan.proposed', + 'elevations.existing', + 'elevations.proposed', + 'floorPlan.existing', + 'floorPlan.proposed', + 'roofPlan.proposed', + 'sections.existing', + 'sections.proposed', + 'noiseAssessment', ], recommended: [], optional: [ - { - value: 'photographs.existing', - description: 'Photographs - existing', - }, - { - value: 'otherDrawing', - description: 'Other - drawing', - }, - { - value: 'otherDocument', - description: 'Other - document', - }, - { - value: 'visualisations', - description: 'Visualisations', - }, + 'photographs.existing', + 'otherDrawing', + 'otherDocument', + 'visualisations', ], }, fee: { diff --git a/examples/prototypeApplication/data/priorApproval/convertCommercialToHome.ts b/examples/prototypeApplication/data/priorApproval/convertCommercialToHome.ts index eab68744..4755c489 100644 --- a/examples/prototypeApplication/data/priorApproval/convertCommercialToHome.ts +++ b/examples/prototypeApplication/data/priorApproval/convertCommercialToHome.ts @@ -1465,46 +1465,17 @@ export const priorApprovalConvertCommercialToHomePrototype: PrototypeApplication url: 'https://editor.planx.dev/lambeth/apply-for-prior-approval/published', files: { required: [ - { - value: 'sitePlan.proposed', - description: 'Site plan - proposed', - }, - { - value: 'usePlan.proposed', - description: 'Use plan - proposed', - }, - { - value: 'noiseAssessment', - description: 'Noise assessment', - }, - { - value: 'sunlightAndDaylightReport', - description: 'Sunlight and daylight report', - }, - ], - recommended: [ - { - value: 'sitePlan.existing', - description: 'Site plan - existing', - }, + 'sitePlan.proposed', + 'usePlan.proposed', + 'noiseAssessment', + 'sunlightAndDaylightReport', ], + recommended: ['sitePlan.existing'], optional: [ - { - value: 'photographs.existing', - description: 'Photographs - existing', - }, - { - value: 'otherDrawing', - description: 'Other - drawing', - }, - { - value: 'otherDocument', - description: 'Other - document', - }, - { - value: 'visualisations', - description: 'Visualisations', - }, + 'photographs.existing', + 'otherDrawing', + 'otherDocument', + 'visualisations', ], }, fee: { diff --git a/examples/prototypeApplication/data/priorApproval/extendUniversity.ts b/examples/prototypeApplication/data/priorApproval/extendUniversity.ts index 50efe195..a332ee26 100644 --- a/examples/prototypeApplication/data/priorApproval/extendUniversity.ts +++ b/examples/prototypeApplication/data/priorApproval/extendUniversity.ts @@ -1674,37 +1674,16 @@ export const priorApprovalExtendUniversityPrototype: PrototypeApplication = { url: 'https://editor.planx.dev/camden/apply-for-prior-approval/published', files: { required: [ - { - value: 'sitePlan.proposed', - description: 'Site plan - proposed', - }, - { - value: 'elevations.existing', - description: 'Elevations - existing', - }, - { - value: 'elevations.proposed', - description: 'Elevations - proposed', - }, + 'sitePlan.proposed', + 'elevations.existing', + 'elevations.proposed', ], recommended: [], optional: [ - { - value: 'photographs.existing', - description: 'Photographs - existing', - }, - { - value: 'otherDrawing', - description: 'Other - drawing', - }, - { - value: 'otherDocument', - description: 'Other - document', - }, - { - value: 'visualisations', - description: 'Visualisations', - }, + 'photographs.existing', + 'otherDrawing', + 'otherDocument', + 'visualisations', ], }, fee: { diff --git a/examples/prototypeApplication/data/priorApproval/largerExtension.ts b/examples/prototypeApplication/data/priorApproval/largerExtension.ts index 59d4cacf..f16cb501 100644 --- a/examples/prototypeApplication/data/priorApproval/largerExtension.ts +++ b/examples/prototypeApplication/data/priorApproval/largerExtension.ts @@ -1429,41 +1429,15 @@ export const priorApprovalLargerExtensionPrototype: PrototypeApplication = { source: 'PlanX', service: { flowId: 'c6628103-c648-4663-81e1-bfa0a1a18340', - url: 'https://editor.planx.uk/southwark/apply-for-prior-approval/published', + url: 'https://editor.planx.dev/southwark/apply-for-prior-approval/published', files: { - required: [ - { - value: 'sitePlan.proposed', - description: 'Site plan - proposed', - }, - ], - recommended: [ - { - value: 'elevations.existing', - description: 'Elevations - existing', - }, - { - value: 'elevations.proposed', - description: 'Elevations - proposed', - }, - ], + required: ['sitePlan.proposed'], + recommended: ['elevations.existing', 'elevations.proposed'], optional: [ - { - value: 'photographs.existing', - description: 'Photographs - existing', - }, - { - value: 'otherDrawing', - description: 'Other - drawing', - }, - { - value: 'otherDocument', - description: 'Other - document', - }, - { - value: 'visualisations', - description: 'Visualisations', - }, + 'photographs.existing', + 'otherDrawing', + 'otherDocument', + 'visualisations', ], }, fee: { diff --git a/examples/prototypeApplication/data/priorApproval/solarPanels.ts b/examples/prototypeApplication/data/priorApproval/solarPanels.ts index 2cd4f15e..a2ce339c 100644 --- a/examples/prototypeApplication/data/priorApproval/solarPanels.ts +++ b/examples/prototypeApplication/data/priorApproval/solarPanels.ts @@ -1250,36 +1250,15 @@ export const priorApprovalSolarPanelsPrototype: PrototypeApplication = { source: 'PlanX', service: { flowId: 'c6628103-c648-4663-81e1-bfa0a1a18340', - url: 'https://editor.planx.uk/southwark/apply-for-prior-approval/published', + url: 'https://editor.planx.dev/southwark/apply-for-prior-approval/published', files: { - required: [ - { - value: 'sitePlan.proposed', - description: 'Site plan - proposed', - }, - { - value: 'sections.proposed', - description: 'Sections - proposed', - }, - ], + required: ['sitePlan.proposed', 'sections.proposed'], recommended: [], optional: [ - { - value: 'photographs.existing', - description: 'Photographs - existing', - }, - { - value: 'otherDrawing', - description: 'Other - drawing', - }, - { - value: 'otherDocument', - description: 'Other - document', - }, - { - value: 'visualisations', - description: 'Visualisations', - }, + 'photographs.existing', + 'otherDrawing', + 'otherDocument', + 'visualisations', ], }, fee: { diff --git a/examples/prototypeApplication/landDrainageConsent.json b/examples/prototypeApplication/landDrainageConsent.json index c75b2253..eb265ef6 100644 --- a/examples/prototypeApplication/landDrainageConsent.json +++ b/examples/prototypeApplication/landDrainageConsent.json @@ -1040,16 +1040,10 @@ "url": "https://editor.planx.dev/medway/apply-for-land-drainage-consent-copy/published", "files": { "required": [ - { - "value": "necessaryInformation", - "description": "Information the authority considers necessary for the application" - } + "necessaryInformation" ], "recommended": [ - { - "value": "relevantInformation", - "description": "Information the applicant considers relevant to the application" - } + "relevantInformation" ], "optional": [] }, diff --git a/examples/prototypeApplication/lawfulDevelopmentCertificate/existing.json b/examples/prototypeApplication/lawfulDevelopmentCertificate/existing.json index 54129ed1..9c6efb82 100644 --- a/examples/prototypeApplication/lawfulDevelopmentCertificate/existing.json +++ b/examples/prototypeApplication/lawfulDevelopmentCertificate/existing.json @@ -1803,36 +1803,14 @@ "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" - } + "photographs.proposed", + "sitePlan.proposed", + "elevations.proposed", + "floorPlan.proposed" ], "recommended": [ - { - "value": "otherEvidence", - "description": "Other - evidence or correspondence" - }, - { - "value": "constructionInvoice", - "description": "Construction invoice" - } + "otherEvidence", + "constructionInvoice" ], "optional": [] }, diff --git a/examples/prototypeApplication/lawfulDevelopmentCertificate/proposed.json b/examples/prototypeApplication/lawfulDevelopmentCertificate/proposed.json index b178ecbb..b90757bf 100644 --- a/examples/prototypeApplication/lawfulDevelopmentCertificate/proposed.json +++ b/examples/prototypeApplication/lawfulDevelopmentCertificate/proposed.json @@ -1137,38 +1137,14 @@ "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" - } + "roofPlan.existing", + "sitePlan.existing", + "roofPlan.proposed", + "sitePlan.proposed", + "elevations.existing", + "floorPlan.existing", + "elevations.proposed", + "floorPlan.proposed" ], "recommended": [], "optional": [] diff --git a/examples/prototypeApplication/listedBuildingConsent.json b/examples/prototypeApplication/listedBuildingConsent.json index 8d4a4920..b8d348d6 100644 --- a/examples/prototypeApplication/listedBuildingConsent.json +++ b/examples/prototypeApplication/listedBuildingConsent.json @@ -1060,61 +1060,26 @@ "source": "PlanX", "service": { "flowId": "2677568c-00d2-4391-98ea-f34a4e743437", - "url": "https://www.editor.planx.uk/camden/apply-for-listed-building-consent/published", + "url": "https://www.editor.planx.dev/camden/apply-for-listed-building-consent/published", "files": { "required": [ - { - "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" - }, - { - "value": "floorPlan.existing", - "description": "Floor plan - existing" - }, - { - "value": "floorPlan.proposed", - "description": "Floor plan - proposed" - }, - { - "value": "joinerySections", - "description": "Joinery section report" - } + "sitePlan.existing", + "sitePlan.proposed", + "elevations.existing", + "elevations.proposed", + "floorPlan.existing", + "floorPlan.proposed", + "joinerySections" ], "recommended": [ - { - "value": "heritageStatement", - "description": "Heritage Statement" - } + "heritageStatement" ], "optional": [ - { - "value": "photographs.existing", - "description": "Photographs - existing" - }, - { - "value": "otherDrawing", - "description": "Other - drawing" - }, - { - "value": "otherDocument", - "description": "Other - document" - }, - { - "value": "visualisations", - "description": "Visualisations" - } + "photographs.existing", + "photographs.proposed", + "otherDrawing", + "otherDocument", + "visualisations" ] }, "fee": { diff --git a/examples/prototypeApplication/planningPermission/fullHouseholder.json b/examples/prototypeApplication/planningPermission/fullHouseholder.json index 86b7c832..43986742 100644 --- a/examples/prototypeApplication/planningPermission/fullHouseholder.json +++ b/examples/prototypeApplication/planningPermission/fullHouseholder.json @@ -1595,40 +1595,16 @@ "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" - } + "roofPlan.existing", + "roofPlan.proposed", + "sitePlan.existing", + "sitePlan.proposed", + "elevations.existing", + "elevations.proposed" ], "recommended": [ - { - "value": "floorPlan.existing", - "description": "Floor plan - existing" - }, - { - "value": "floorPlan.proposed", - "description": "Floor plan - proposed" - } + "floorPlan.existing", + "floorPlan.proposed" ], "optional": [] }, diff --git a/examples/prototypeApplication/planningPermission/fullHouseholderInConservationArea.json b/examples/prototypeApplication/planningPermission/fullHouseholderInConservationArea.json index be6d9eb2..23aa16ee 100644 --- a/examples/prototypeApplication/planningPermission/fullHouseholderInConservationArea.json +++ b/examples/prototypeApplication/planningPermission/fullHouseholderInConservationArea.json @@ -1716,56 +1716,23 @@ "source": "PlanX", "service": { "flowId": "bba306e7-15c8-438f-a71e-a1e5d3a99caf", - "url": "https://editor.planx.uk/southwark/apply-for-planning-permission/published", + "url": "https://editor.planx.dev/southwark/apply-for-planning-permission/published", "files": { "required": [ - { - "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" - }, - { - "value": "floorPlan.existing", - "description": "Floor plan - existing" - }, - { - "value": "floorPlan.proposed", - "description": "Floor plan - proposed" - }, - { - "value": "heritageStatement", - "description": "Heritage Statement" - } + "sitePlan.existing", + "sitePlan.proposed", + "elevations.existing", + "elevations.proposed", + "floorPlan.existing", + "floorPlan.proposed", + "heritageStatement" ], "recommended": [], "optional": [ - { - "value": "photographs.existing", - "description": "Photographs - existing" - }, - { - "value": "otherDrawing", - "description": "Other - drawing" - }, - { - "value": "otherDocument", - "description": "Other - document" - }, - { - "value": "visualisations", - "description": "Visualisations" - } + "photographs.existing", + "otherDocument", + "otherDrawing", + "visualisations" ] }, "fee": { diff --git a/examples/prototypeApplication/planningPermission/major.json b/examples/prototypeApplication/planningPermission/major.json index dca1d668..e9209002 100644 --- a/examples/prototypeApplication/planningPermission/major.json +++ b/examples/prototypeApplication/planningPermission/major.json @@ -2312,16 +2312,10 @@ "url": "https://editor.planx.dev/buckinghamshire/apply-for-planning-permission/published", "files": { "required": [ - { - "value": "necessaryInformation", - "description": "Information the authority considers necessary for the application" - } + "necessaryInformation" ], "recommended": [ - { - "value": "relevantInformation", - "description": "Information the applicant considers relevant to the application" - } + "relevantInformation" ], "optional": [] }, diff --git a/examples/prototypeApplication/planningPermission/minor.json b/examples/prototypeApplication/planningPermission/minor.json index be2480f5..8b6f92e5 100644 --- a/examples/prototypeApplication/planningPermission/minor.json +++ b/examples/prototypeApplication/planningPermission/minor.json @@ -1585,16 +1585,10 @@ "url": "https://editor.planx.dev/buckinghamshire/apply-for-planning-permission/published", "files": { "required": [ - { - "value": "necessaryInformation", - "description": "Information the authority considers necessary for the application" - } + "necessaryInformation" ], "recommended": [ - { - "value": "relevantInformation", - "description": "Information the applicant considers relevant to the application" - } + "relevantInformation" ], "optional": [] }, diff --git a/examples/prototypeApplication/priorApproval/buildHomes.json b/examples/prototypeApplication/priorApproval/buildHomes.json index 440d180d..e71e4442 100644 --- a/examples/prototypeApplication/priorApproval/buildHomes.json +++ b/examples/prototypeApplication/priorApproval/buildHomes.json @@ -1742,64 +1742,25 @@ "source": "PlanX", "service": { "flowId": "6f76e837-7a42-40f3-80e9-a9482dce5982", - "url": "https://editor.planx.uk/buckinghamshire/apply-for-prior-approval/published", + "url": "https://editor.planx.dev/buckinghamshire/apply-for-prior-approval/published", "files": { "required": [ - { - "value": "sitePlan.proposed", - "description": "Site plan - proposed" - }, - { - "value": "elevations.existing", - "description": "Elevations - existing" - }, - { - "value": "elevations.proposed", - "description": "Elevations - proposed" - }, - { - "value": "floorPlan.existing", - "description": "Floor plan - existing" - }, - { - "value": "floorPlan.proposed", - "description": "Floor plan - proposed" - }, - { - "value": "roofPlan.proposed", - "description": "Roof plan - proposed" - }, - { - "value": "sections.existing", - "description": "Sections - existing" - }, - { - "value": "sections.proposed", - "description": "Sections - proposed" - }, - { - "value": "noiseAssessment", - "description": "Noise assessment" - } + "sitePlan.proposed", + "elevations.existing", + "elevations.proposed", + "floorPlan.existing", + "floorPlan.proposed", + "roofPlan.proposed", + "sections.existing", + "sections.proposed", + "noiseAssessment" ], "recommended": [], "optional": [ - { - "value": "photographs.existing", - "description": "Photographs - existing" - }, - { - "value": "otherDrawing", - "description": "Other - drawing" - }, - { - "value": "otherDocument", - "description": "Other - document" - }, - { - "value": "visualisations", - "description": "Visualisations" - } + "photographs.existing", + "otherDrawing", + "otherDocument", + "visualisations" ] }, "fee": { diff --git a/examples/prototypeApplication/priorApproval/convertCommercialToHome.json b/examples/prototypeApplication/priorApproval/convertCommercialToHome.json index c7157d82..52e8408e 100644 --- a/examples/prototypeApplication/priorApproval/convertCommercialToHome.json +++ b/examples/prototypeApplication/priorApproval/convertCommercialToHome.json @@ -1529,46 +1529,19 @@ "url": "https://editor.planx.dev/lambeth/apply-for-prior-approval/published", "files": { "required": [ - { - "value": "sitePlan.proposed", - "description": "Site plan - proposed" - }, - { - "value": "usePlan.proposed", - "description": "Use plan - proposed" - }, - { - "value": "noiseAssessment", - "description": "Noise assessment" - }, - { - "value": "sunlightAndDaylightReport", - "description": "Sunlight and daylight report" - } + "sitePlan.proposed", + "usePlan.proposed", + "noiseAssessment", + "sunlightAndDaylightReport" ], "recommended": [ - { - "value": "sitePlan.existing", - "description": "Site plan - existing" - } + "sitePlan.existing" ], "optional": [ - { - "value": "photographs.existing", - "description": "Photographs - existing" - }, - { - "value": "otherDrawing", - "description": "Other - drawing" - }, - { - "value": "otherDocument", - "description": "Other - document" - }, - { - "value": "visualisations", - "description": "Visualisations" - } + "photographs.existing", + "otherDrawing", + "otherDocument", + "visualisations" ] }, "fee": { diff --git a/examples/prototypeApplication/priorApproval/extendUniversity.json b/examples/prototypeApplication/priorApproval/extendUniversity.json index ff29152d..42cc0e65 100644 --- a/examples/prototypeApplication/priorApproval/extendUniversity.json +++ b/examples/prototypeApplication/priorApproval/extendUniversity.json @@ -1701,37 +1701,16 @@ "url": "https://editor.planx.dev/camden/apply-for-prior-approval/published", "files": { "required": [ - { - "value": "sitePlan.proposed", - "description": "Site plan - proposed" - }, - { - "value": "elevations.existing", - "description": "Elevations - existing" - }, - { - "value": "elevations.proposed", - "description": "Elevations - proposed" - } + "sitePlan.proposed", + "elevations.existing", + "elevations.proposed" ], "recommended": [], "optional": [ - { - "value": "photographs.existing", - "description": "Photographs - existing" - }, - { - "value": "otherDrawing", - "description": "Other - drawing" - }, - { - "value": "otherDocument", - "description": "Other - document" - }, - { - "value": "visualisations", - "description": "Visualisations" - } + "photographs.existing", + "otherDrawing", + "otherDocument", + "visualisations" ] }, "fee": { diff --git a/examples/prototypeApplication/priorApproval/largerExtension.json b/examples/prototypeApplication/priorApproval/largerExtension.json index 80de0e26..3cc953d4 100644 --- a/examples/prototypeApplication/priorApproval/largerExtension.json +++ b/examples/prototypeApplication/priorApproval/largerExtension.json @@ -1464,41 +1464,20 @@ "source": "PlanX", "service": { "flowId": "c6628103-c648-4663-81e1-bfa0a1a18340", - "url": "https://editor.planx.uk/southwark/apply-for-prior-approval/published", + "url": "https://editor.planx.dev/southwark/apply-for-prior-approval/published", "files": { "required": [ - { - "value": "sitePlan.proposed", - "description": "Site plan - proposed" - } + "sitePlan.proposed" ], "recommended": [ - { - "value": "elevations.existing", - "description": "Elevations - existing" - }, - { - "value": "elevations.proposed", - "description": "Elevations - proposed" - } + "elevations.existing", + "elevations.proposed" ], "optional": [ - { - "value": "photographs.existing", - "description": "Photographs - existing" - }, - { - "value": "otherDrawing", - "description": "Other - drawing" - }, - { - "value": "otherDocument", - "description": "Other - document" - }, - { - "value": "visualisations", - "description": "Visualisations" - } + "photographs.existing", + "otherDrawing", + "otherDocument", + "visualisations" ] }, "fee": { diff --git a/examples/prototypeApplication/priorApproval/solarPanels.json b/examples/prototypeApplication/priorApproval/solarPanels.json index 54e68fae..db1c3bef 100644 --- a/examples/prototypeApplication/priorApproval/solarPanels.json +++ b/examples/prototypeApplication/priorApproval/solarPanels.json @@ -1437,36 +1437,18 @@ "source": "PlanX", "service": { "flowId": "c6628103-c648-4663-81e1-bfa0a1a18340", - "url": "https://editor.planx.uk/southwark/apply-for-prior-approval/published", + "url": "https://editor.planx.dev/southwark/apply-for-prior-approval/published", "files": { "required": [ - { - "value": "sitePlan.proposed", - "description": "Site plan - proposed" - }, - { - "value": "sections.proposed", - "description": "Sections - proposed" - } + "sitePlan.proposed", + "sections.proposed" ], "recommended": [], "optional": [ - { - "value": "photographs.existing", - "description": "Photographs - existing" - }, - { - "value": "otherDrawing", - "description": "Other - drawing" - }, - { - "value": "otherDocument", - "description": "Other - document" - }, - { - "value": "visualisations", - "description": "Visualisations" - } + "photographs.existing", + "otherDrawing", + "otherDocument", + "visualisations" ] }, "fee": { diff --git a/schemas/prototypeApplication.json b/schemas/prototypeApplication.json index c7531bd2..7d962eec 100644 --- a/schemas/prototypeApplication.json +++ b/schemas/prototypeApplication.json @@ -160,40 +160,6 @@ ], "type": "object" }, - "AnyProviderMetadata": { - "$id": "#AnyProviderMetadata", - "additionalProperties": false, - "description": "Base metadata associated with applications submitted via any provider", - "properties": { - "id": { - "$ref": "#/definitions/UUID", - "description": "Unique identifier for this application" - }, - "organisation": { - "description": "The reference code for the organisation responsible for processing this planning application, sourced from planning.data.gov.uk/dataset/local-authority", - "maxLength": 4, - "type": "string" - }, - "schema": { - "$ref": "#/definitions/URL" - }, - "source": { - "const": "Any", - "type": "string" - }, - "submittedAt": { - "$ref": "#/definitions/DateTime" - } - }, - "required": [ - "id", - "organisation", - "schema", - "source", - "submittedAt" - ], - "type": "object" - }, "ApplicantAddress": { "anyOf": [ { @@ -1071,1872 +1037,66 @@ }, "type": "object" }, - "two": { - "items": { - "$ref": "#/definitions/CalculateMetadata" - }, - "type": "array" - } - }, - "type": "object" - }, - "payable": { - "items": { - "$ref": "#/definitions/CalculateMetadata" - }, - "type": "array" - } - }, - "required": [ - "calculated", - "payable" - ], - "type": "object" - }, - "FeeExplanationNotApplicable": { - "$id": "#FeeExplanationNotApplicable", - "additionalProperties": false, - "description": "An indicator that an application fee does not apply to this application type or journey, therefore there is not an explanation of how it was calculated", - "properties": { - "notApplicable": { - "const": true, - "type": "boolean" - } - }, - "required": [ - "notApplicable" - ], - "type": "object" - }, - "File": { - "$id": "#File", - "additionalProperties": false, - "description": "File uploaded and labeled by the user to support the application", - "properties": { - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "items": { - "$ref": "#/definitions/PrototypeFileType" - }, - "type": "array" - } - }, - "required": [ - "name", - "type" - ], - "type": "object" - }, - "FileType": { - "$id": "#FileType", - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Details of impact on access, roads, and rights of way", - "type": "string" - }, - "value": { - "const": "accessRoadsRightsOfWayDetails", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Affordable housing statement", - "type": "string" - }, - "value": { - "const": "affordableHousingStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Arboriculturist report", - "type": "string" - }, - "value": { - "const": "arboriculturistReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Bank statement", - "type": "string" - }, - "value": { - "const": "bankStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Basement impact statement", - "type": "string" - }, - "value": { - "const": "basementImpactStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Bio-aerosol assessment", - "type": "string" - }, - "value": { - "const": "bioaerosolAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Birdstrike risk management plan", - "type": "string" - }, - "value": { - "const": "birdstrikeRiskManagementPlan", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Borehole or trial pit analysis", - "type": "string" - }, - "value": { - "const": "boreholeOrTrialPitAnalysis", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Building control certificate", - "type": "string" - }, - "value": { - "const": "buildingControlCertificate", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Structural or building condition survey", - "type": "string" - }, - "value": { - "const": "conditionSurvey", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Construction invoice", - "type": "string" - }, - "value": { - "const": "constructionInvoice", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Contamination report", - "type": "string" - }, - "value": { - "const": "contaminationReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Council tax bill", - "type": "string" - }, - "value": { - "const": "councilTaxBill", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Crime prevention strategy", - "type": "string" - }, - "value": { - "const": "crimePreventionStrategy", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Design and Access Statement", - "type": "string" - }, - "value": { - "const": "designAndAccessStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Evidence for application fee exemption - disability", - "type": "string" - }, - "value": { - "const": "disabilityExemptionEvidence", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Ecology report", - "type": "string" - }, - "value": { - "const": "ecologyReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Elevations - existing", - "type": "string" - }, - "value": { - "const": "elevations.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Elevations - proposed", - "type": "string" - }, - "value": { - "const": "elevations.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Scheme for mitigation and monitoring of emissions (dust, odour and vibrations)", - "type": "string" - }, - "value": { - "const": "emissionsMitigationAndMonitoringScheme", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Energy statement", - "type": "string" - }, - "value": { - "const": "energyStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Environmental Impact Assessment (EIA)", - "type": "string" - }, - "value": { - "const": "environmentalImpactAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "External materials details", - "type": "string" - }, - "value": { - "const": "externalMaterialsDetails", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Fire safety report", - "type": "string" - }, - "value": { - "const": "fireSafetyReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Flood risk assessment (FRA)", - "type": "string" - }, - "value": { - "const": "floodRiskAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Floor plan - existing", - "type": "string" - }, - "value": { - "const": "floorPlan.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Floor plan - proposed", - "type": "string" - }, - "value": { - "const": "floorPlan.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Foul drainage assessment", - "type": "string" - }, - "value": { - "const": "foulDrainageAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Geodiversity assessment", - "type": "string" - }, - "value": { - "const": "geodiversityAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Plans showing the stretches of hedgerows to be removed", - "type": "string" - }, - "value": { - "const": "hedgerowsInformation", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Evidence of the date of planting of the removed hedgerows", - "type": "string" - }, - "value": { - "const": "hedgerowsInformation.plantingDate", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Heritage Statement", - "type": "string" - }, - "value": { - "const": "heritageStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Hydrological and hydrogeological assessment", - "type": "string" - }, - "value": { - "const": "hydrologicalAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Hydrology report", - "type": "string" - }, - "value": { - "const": "hydrologyReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Internal elevations", - "type": "string" - }, - "value": { - "const": "internalElevations", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Internal sections", - "type": "string" - }, - "value": { - "const": "internalSections", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "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": { - "description": { - "const": "Land contamination assessment", - "type": "string" - }, - "value": { - "const": "landContaminationAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Landscape and visual impact assessment (LVIA)", - "type": "string" - }, - "value": { - "const": "landscapeAndVisualImpactAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Landscape strategy or landscape plan", - "type": "string" - }, - "value": { - "const": "landscapeStrategy", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Lighting assessment", - "type": "string" - }, - "value": { - "const": "lightingAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Details of litter, vermin and bird control", - "type": "string" - }, - "value": { - "const": "litterVerminAndBirdControlDetails", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Location plan", - "type": "string" - }, - "value": { - "const": "locationPlan", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Method statement", - "type": "string" - }, - "value": { - "const": "methodStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Minerals and waste assessment", - "type": "string" - }, - "value": { - "const": "mineralsAndWasteAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Information the authority considers necessary for the application", - "type": "string" - }, - "value": { - "const": "necessaryInformation", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "New dwellings schedule", - "type": "string" - }, - "value": { - "const": "newDwellingsSchedule", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Noise assessment", - "type": "string" - }, - "value": { - "const": "noiseAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Open space assessment", - "type": "string" - }, - "value": { - "const": "openSpaceAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Other - document", - "type": "string" - }, - "value": { - "const": "otherDocument", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Other - drawing", - "type": "string" - }, - "value": { - "const": "otherDrawing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Other - evidence or correspondence", - "type": "string" - }, - "value": { - "const": "otherEvidence", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Parking plan", - "type": "string" - }, - "value": { - "const": "parkingPlan", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Photographs - existing", - "type": "string" - }, - "value": { - "const": "photographs.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Photographs - proposed", - "type": "string" - }, - "value": { - "const": "photographs.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Planning statement", - "type": "string" - }, - "value": { - "const": "planningStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Recyclable waste storage details", - "type": "string" - }, - "value": { - "const": "recycleWasteStorageDetails", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Information the applicant considers relevant to the application", - "type": "string" - }, - "value": { - "const": "relevantInformation", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Residential units details", - "type": "string" - }, - "value": { - "const": "residentialUnitsDetails", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Roof plan - existing", - "type": "string" - }, - "value": { - "const": "roofPlan.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Roof plan - proposed", - "type": "string" - }, - "value": { - "const": "roofPlan.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Sections - existing", - "type": "string" - }, - "value": { - "const": "sections.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Sections - proposed", - "type": "string" - }, - "value": { - "const": "sections.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Site plan - existing", - "type": "string" - }, - "value": { - "const": "sitePlan.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Site plan - proposed", - "type": "string" - }, - "value": { - "const": "sitePlan.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Sketch plan", - "type": "string" - }, - "value": { - "const": "sketchPlan", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Statement of community involvement", - "type": "string" - }, - "value": { - "const": "statementOfCommunityInvolvement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Statutory declaration", - "type": "string" - }, - "value": { - "const": "statutoryDeclaration", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Details of storage treatment or disposal of waste", - "type": "string" - }, - "value": { - "const": "storageTreatmentAndWasteDisposalDetails", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Street scene drawing", - "type": "string" - }, - "value": { - "const": "streetScene", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Subsidence report", - "type": "string" - }, - "value": { - "const": "subsidenceReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Sunlight and daylight report", - "type": "string" - }, - "value": { - "const": "sunlightAndDaylightReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Sustainability statement", - "type": "string" - }, - "value": { - "const": "sustainabilityStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Technical evidence", - "type": "string" - }, - "value": { - "const": "technicalEvidence", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Technical specification", - "type": "string" - }, - "value": { - "const": "technicalSpecification", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Tenancy agreement", - "type": "string" - }, - "value": { - "const": "tenancyAgreement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Tenancy invoice", - "type": "string" - }, - "value": { - "const": "tenancyInvoice", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Town centre uses - Impact assessment", - "type": "string" - }, - "value": { - "const": "townCentreImpactAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Town centre uses - Sequential assessment", - "type": "string" - }, - "value": { - "const": "townCentreSequentialAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Transport assessment", - "type": "string" - }, - "value": { - "const": "transportAssessment", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Travel plan", - "type": "string" - }, - "value": { - "const": "travelPlan", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Location of trees and hedges", - "type": "string" - }, - "value": { - "const": "treeAndHedgeLocation", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Removed or pruned trees and hedges", - "type": "string" - }, - "value": { - "const": "treeAndHedgeRemovedOrPruned", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Tree canopy calculator", - "type": "string" - }, - "value": { - "const": "treeCanopyCalculator", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Tree condition report", - "type": "string" - }, - "value": { - "const": "treeConditionReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Tree plan", - "type": "string" - }, - "value": { - "const": "treePlan", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Trees report", - "type": "string" - }, - "value": { - "const": "treesReport", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Unit plan - existing", - "type": "string" - }, - "value": { - "const": "unitPlan.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Unit plan - proposed", - "type": "string" - }, - "value": { - "const": "unitPlan.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Use plan - existing", - "type": "string" - }, - "value": { - "const": "usePlan.existing", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Use plan - proposed", - "type": "string" - }, - "value": { - "const": "usePlan.proposed", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Utility bill", - "type": "string" - }, - "value": { - "const": "utilityBill", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Utilities statement", - "type": "string" - }, - "value": { - "const": "utilitiesStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Ventilation or extraction statement", - "type": "string" - }, - "value": { - "const": "ventilationStatement", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Viability Appraisal", - "type": "string" - }, - "value": { - "const": "viabilityAppraisal", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Visualisations", - "type": "string" - }, - "value": { - "const": "visualisations", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Waste and recycling strategy", - "type": "string" - }, - "value": { - "const": "wasteAndRecyclingStrategy", - "type": "string" - } - }, - "required": [ - "value", - "description" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Waste storage details", - "type": "string" - }, - "value": { - "const": "wasteStorageDetails", - "type": "string" + "two": { + "items": { + "$ref": "#/definitions/CalculateMetadata" + }, + "type": "array" } }, - "required": [ - "value", - "description" - ], "type": "object" }, - { - "additionalProperties": false, - "properties": { - "description": { - "const": "Water environment assessment", - "type": "string" - }, - "value": { - "const": "waterEnvironmentAssessment", - "type": "string" - } + "payable": { + "items": { + "$ref": "#/definitions/CalculateMetadata" }, - "required": [ - "value", - "description" - ], - "type": "object" + "type": "array" } + }, + "required": [ + "calculated", + "payable" ], - "description": "Types of planning documents and drawings" + "type": "object" + }, + "FeeExplanationNotApplicable": { + "$id": "#FeeExplanationNotApplicable", + "additionalProperties": false, + "description": "An indicator that an application fee does not apply to this application type or journey, therefore there is not an explanation of how it was calculated", + "properties": { + "notApplicable": { + "const": true, + "type": "boolean" + } + }, + "required": [ + "notApplicable" + ], + "type": "object" + }, + "File": { + "$id": "#File", + "additionalProperties": false, + "description": "File uploaded and labeled by the user to support the application", + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "items": { + "$ref": "#/definitions/PrototypeFileType" + }, + "type": "array" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" }, "GLAHousingProvider": { "$id": "#GLAHousingProvider", @@ -3269,7 +1429,7 @@ "type": "array" }, "metadata": { - "$ref": "#/definitions/Metadata" + "$ref": "#/definitions/PrototypePlanXMetadata" }, "preAssessment": { "$ref": "#/definitions/PreAssessment" @@ -3670,7 +1830,7 @@ "type": "array" }, "metadata": { - "$ref": "#/definitions/Metadata" + "$ref": "#/definitions/PrototypePlanXMetadata" }, "preAssessment": { "$ref": "#/definitions/PreAssessment" @@ -3793,7 +1953,7 @@ "type": "array" }, "metadata": { - "$ref": "#/definitions/Metadata" + "$ref": "#/definitions/PrototypePlanXMetadata" }, "preAssessment": { "$ref": "#/definitions/PreAssessment" @@ -5224,18 +3384,6 @@ }, "type": "object" }, - "Metadata": { - "$id": "#DigitalPlanningMetadata", - "anyOf": [ - { - "$ref": "#/definitions/AnyProviderMetadata" - }, - { - "$ref": "#/definitions/PlanXMetadata" - } - ], - "description": "Details of the digital planning service which sent this application" - }, "MultiLineString": { "additionalProperties": false, "description": "MultiLineString geometry object. https://tools.ietf.org/html/rfc7946#section-3.1.5", @@ -5740,7 +3888,7 @@ "type": "array" }, "metadata": { - "$ref": "#/definitions/Metadata" + "$ref": "#/definitions/PrototypePlanXMetadata" }, "preAssessment": { "$ref": "#/definitions/PreAssessment" @@ -6013,7 +4161,7 @@ "type": "array" }, "metadata": { - "$ref": "#/definitions/Metadata" + "$ref": "#/definitions/PrototypePlanXMetadata" }, "preAssessment": { "$ref": "#/definitions/PreAssessment" @@ -6659,72 +4807,6 @@ } ] }, - "PlanXMetadata": { - "$id": "#PlanXMetadata", - "additionalProperties": false, - "description": "Additional metadata associated with applications submitted via PlanX", - "properties": { - "id": { - "$ref": "#/definitions/UUID", - "description": "Unique identifier for this application" - }, - "organisation": { - "description": "The reference code for the organisation responsible for processing this planning application, sourced from planning.data.gov.uk/dataset/local-authority", - "maxLength": 4, - "type": "string" - }, - "schema": { - "$ref": "#/definitions/URL" - }, - "service": { - "additionalProperties": false, - "properties": { - "fee": { - "anyOf": [ - { - "$ref": "#/definitions/FeeExplanation" - }, - { - "$ref": "#/definitions/FeeExplanationNotApplicable" - } - ] - }, - "files": { - "$ref": "#/definitions/RequestedFiles" - }, - "flowId": { - "$ref": "#/definitions/UUID" - }, - "url": { - "$ref": "#/definitions/URL" - } - }, - "required": [ - "flowId", - "url", - "files", - "fee" - ], - "type": "object" - }, - "source": { - "const": "PlanX", - "type": "string" - }, - "submittedAt": { - "$ref": "#/definitions/DateTime" - } - }, - "required": [ - "id", - "organisation", - "schema", - "service", - "source", - "submittedAt" - ], - "type": "object" - }, "PlanningApplication": { "additionalProperties": false, "description": "Details of the planning application linked to this application, if applicable", @@ -11666,6 +9748,100 @@ ], "description": "Types of planning documents and drawings" }, + "PrototypePlanXMetadata": { + "additionalProperties": false, + "properties": { + "id": { + "$ref": "#/definitions/UUID", + "description": "Unique identifier for this application" + }, + "organisation": { + "description": "The reference code for the organisation responsible for processing this planning application, sourced from planning.data.gov.uk/dataset/local-authority", + "maxLength": 4, + "type": "string" + }, + "schema": { + "$ref": "#/definitions/URL" + }, + "service": { + "additionalProperties": false, + "properties": { + "fee": { + "anyOf": [ + { + "$ref": "#/definitions/FeeExplanation" + }, + { + "$ref": "#/definitions/FeeExplanationNotApplicable" + } + ] + }, + "files": { + "$ref": "#/definitions/PrototypeRequestedFiles" + }, + "flowId": { + "$ref": "#/definitions/UUID" + }, + "url": { + "$ref": "#/definitions/URL" + } + }, + "required": [ + "flowId", + "url", + "files", + "fee" + ], + "type": "object" + }, + "source": { + "const": "PlanX", + "type": "string" + }, + "submittedAt": { + "$ref": "#/definitions/DateTime" + } + }, + "required": [ + "id", + "organisation", + "schema", + "service", + "source", + "submittedAt" + ], + "type": "object" + }, + "PrototypeRequestedFiles": { + "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/PrototypeFileType" + }, + "type": "array" + }, + "recommended": { + "items": { + "$ref": "#/definitions/PrototypeFileType" + }, + "type": "array" + }, + "required": { + "items": { + "$ref": "#/definitions/PrototypeFileType" + }, + "type": "array" + } + }, + "required": [ + "required", + "recommended", + "optional" + ], + "type": "object" + }, "QuestionAndResponses": { "additionalProperties": false, "properties": { @@ -11725,37 +9901,6 @@ }, "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" - }, "ResidentialUnits": { "additionalProperties": false, "properties": { diff --git a/types/schemas/prototypeApplication/index.ts b/types/schemas/prototypeApplication/index.ts index 1df334fd..76b2b011 100644 --- a/types/schemas/prototypeApplication/index.ts +++ b/types/schemas/prototypeApplication/index.ts @@ -1,5 +1,12 @@ -import {Metadata} from '../../shared/Metadata'; +import { + BaseMetadata, + FeeExplanation, + FeeExplanationNotApplicable, + Metadata, + PlanXMetadata, +} from '../../shared/Metadata'; import {Responses} from '../../shared/Responses'; +import {UUID, URL} from '../../shared/utils'; import {Applicant} from './data/Applicant'; import {ApplicationData} from './data/ApplicationData'; import {PropertyBase} from './data/Property'; @@ -14,9 +21,29 @@ import { PPApplicationType, PrimaryApplicationType, } from './enums/ApplicationType'; +import {PrototypeFileType} from './enums/FileType'; import {File} from './File'; import {PreAssessment} from './PreAssessment'; +/** + * @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 PrototypeRequestedFiles { + required: PrototypeFileType[]; + recommended: PrototypeFileType[]; + optional: PrototypeFileType[]; +} + +export interface PrototypePlanXMetadata extends BaseMetadata { + source: 'PlanX'; + service: { + flowId: UUID; + url: URL; + files: PrototypeRequestedFiles; + fee: FeeExplanation | FeeExplanationNotApplicable; + }; +} + /** * @internal * The generic base type for all applications @@ -38,7 +65,7 @@ interface ApplicationSpecification< preAssessment?: PreAssessment; responses: Responses; files: File[]; - metadata: Metadata; + metadata: PrototypePlanXMetadata; } export type LDC = ApplicationSpecification<'ldc', LDCApplicationType>;