Report Builder Docs

Appearance

Report Builder Engine ​

Build secure reporting in Laravel with a headless engine designed for trust, clarity, and scale.

Report Builder Engine gives teams a strict core for definition, validation, preview, and export while keeping UI and delivery fully in application control.

Executive summary ​

Teams need flexible reporting, but cannot allow unrestricted query behavior.

This package enforces explicit source and field definitions, validates intent through a constrained contract, and executes only trusted query paths.

The result is safer reporting and predictable behavior across products.

Purpose ​

Help teams ship production-grade reporting without unsafe query surfaces or ad hoc SQL coupling.

Mission ​

Deliver a developer-controlled report engine where intent is validated, compiled, and executed through explicit allowlists.

Vision ​

Become the standard reporting engine layer for Laravel ecosystems: secure by design, predictable at scale, and straightforward to integrate.

Why teams adopt it ​

  • Security first: no raw SQL input, no arbitrary column execution, no hidden query leakage
  • Consistent contract: one definition model for preview and export
  • Operational clarity: deterministic validation errors and predictable output shapes
  • Integration freedom: use with your own controllers, jobs, CLI commands, or UI package

Architecture ​

Parse error on line 1:
flowchart LR    A[D
^
Expecting 'NEWLINE', 'SPACE', 'GRAPH', got 'ALPHA'

Operating model ​

  1. Developers define trusted sources and allowlisted fields.
  2. Application/UI layers submit report intent through the report definition contract.
  3. The engine validates definitions and rejects unsafe or invalid combinations.
  4. The compiler executes trusted queries for preview and export output.

What this package includes ​

  • Trusted source registration and field modeling
  • Report definition validation and safe query compilation
  • Preview execution with normalized payloads
  • CSV and XLSX export execution
  • Saved report and schedule discovery primitives

What this package does not include ​

  • Bundled frontend UI components
  • Built-in report delivery pipeline (email/webhook/storage orchestration)
  • Raw SQL execution from user input
  • Unrestricted schema introspection

Who this is for ​

  • Laravel teams building internal analytics, ops reporting, finance exports, or tenant-safe customer reports
  • Platforms that need one reusable reporting core across products
  • Engineering organizations that require strict trust boundaries in data workflows

Choose your path ​

Current feature status ​

  • Implemented: source registration, field definitions, report definition validation, preview runner, CSV/XLSX export, saved report persistence, due schedule discovery
  • Planned: dashboard widgets, delivery pipeline orchestration, packaged UI integration helpers