How tpximpact/digital-planning-register-tools works
DPR publishes public planning-application data through an API and web interface, sourcing it from local-authority ODP APIs. The clearest runtime path shown is API request routing to BOPS handlers, with legacy BOPS payload conversion into the published-application format; a separate local handler serves example datasets. The tree and README also identify an admin client-configuration interface, shared schemas, and a data-pipeline playground. Pipeline internals and the public web frontend are not shown in the excerpts, so their links are limited to documented capabilities.
Main entry points: app.ts API Router · applications.ts BOPS Application Handler · application.ts Application Converter · actions.ts Client Actions
Components 17
Public API
- API Router
apps/api/src/app.ts - Request Dispatch
apps/api/src/libs/handle-requests/handle-requests.ts - API Schemas
apps/api/src/schema.ts
Data Sources
- Example API Routes
handlers/local/src/modules/applications/applications.ts - Example Data Queries
handlers/local/src/libs/applications/applications.ts - BOPS Application Handler
handlers/bops/src/modules/applications/applications.ts - BOPS Data Handlers
handlers/bops/src/modules - Data Pipeline
playground/data-pipeline/src/dpr_pipeline
BOPS Conversion
- Application Converter
converters/bops/src/converters/applications/application.ts - Document Converter
converters/bops/src/converters/documents/convertBopsFileToPostSubmissionFileRedacted.ts
Client Administration
- Admin Client UI
apps/admin/src/app/clients - Client Actions
apps/admin/src/app/clients/actions.ts - Internal Client API
apps/admin/src/app/api/internal/clients/[slug]/route.ts - Client Database
apps/admin/src/db/clients.ts
Shared Data
- Published Data Schemas
packages/odp-schemas/src/types/schemas/postSubmissionApplication
Other components
- API Consumer
- Authority ODP APIs
Connections 16
- API Consumer → API Router: requests data
- API Router → Request Dispatch: dispatches requests
apps/api/src/app.ts - API Router → BOPS Application Handler: calls BOPS handlers
apps/api/src/app.ts - API Router → API Schemas: uses route schemas
apps/api/src/app.ts - API Router → Example API Routes: serves example routes
- Example API Routes → Example Data Queries: queries applications
handlers/local/src/modules/applications/applications.ts - BOPS Application Handler → Authority ODP APIs: fetches applications
- BOPS Application Handler → Application Converter: converts legacy payloads
handlers/bops/src/modules/applications/applications.ts - Application Converter → Document Converter: converts attached files
converters/bops/src/converters/applications/application.ts - Application Converter → Published Data Schemas: produces published format
- Example Data Queries → Published Data Schemas: queries schema-shaped data
- Admin Client UI → Client Actions: manages clients
- Internal Client API → Client Actions: looks up client
apps/admin/src/app/api/internal/clients/[slug]/route.ts - Client Actions → Client Database: reads client records
- Authority ODP APIs → Data Pipeline: supplies source data
- Data Pipeline → API Consumer: indexes for publication