DEVELOPER GUIDE

Compose a panel
from approved parts.

Panel definitions describe branding, routes, required permissions, registered widget types, and integration identifiers. They do not contain executable code.

Configuration contract

Panel configuration is validated with a strict Zod schema at startup. Navigation paths must match registered panel paths. Widget types are a discriminated union, and data sources are selected from an approved set.

Permission checks

Use permissions to hide unavailable navigation in the UI, then enforce the same permission on every server endpoint and resource query. UI visibility is not an authorization boundary.

Data sources

Widgets receive server-validated responses from panel APIs. Avoid embedding credentials, arbitrary URLs, query fragments, or user-supplied executable templates in configuration.

Adding a panel type

Add and test the schema, provide registered server routes with role checks, build the view from approved components, and document its operational and recovery requirements.

The current configuration powers the Project Util admin enquiry panel only. Customer, product-management, and operational panels require verified data models and permissions before they can be enabled.