README

Reports and scheduled exports for Symfony: report types with parameter schemas, PDF / XLSX / CSV / JSON renderers, server-side SVG charts, on-screen report pages and per-owner scheduled e-mail subscriptions.

🚧 Status: S0 scaffold, no release yet. The package is built slice by slice from its design contract (docs/CONTRACT.md, 221-C). S0 ships the bundle class, the strict configuration tree and every quality gate; the features below land with the slices in docs/ROADMAP.md.

📋 Compatible with Symfony 7.4, 8.0 and 8.1 · PHP 8.2+ (Symfony 8.x requires PHP 8.4+)

This bundle is built for FrankenPHP worker mode with the kernel kept alive and not reset between requests: no request state in services, a worker test (one kernel, 2,000 requests) from the first slice.

Standard Symfony by default, DDD / hexagonal opt-in: zero configuration in a standard project; public ports are interfaces and value objects, bundle-owned tables are mapped in XML and referenced by id, the bundle never flushes your EntityManager.

Features (planned, see the roadmap)

Report model: Report and ReportSection (key values with delta, tone and sparkline; tables with optional chart kind and presentation style; truncation note), badges, glance line, link.
Report type registry (tagged ReportTypeInterface) with a parameter schema (periods, context, typed extras), availability per viewer and a configurable menu order.
Renderers: PDF (closed Dompdf: no remote, no JavaScript, no PHP, private chroot), XLSX (OpenSpout streaming), CSV (UTF-8 BOM, formula-injection guard), JSON, and server-side SVG charts with light / dark variants. Dompdf and OpenSpout are suggested: a format is on only when its engine is installed (Q-O3).
Generic PDF runner PdfDocumentRendererInterface for any template (invoices, receipts, mandates).
Pages on UiKit + FormKit: report list, report page (filter form, Export menu, Schedule by e-mail dialog).
Scheduled subscriptions: daily / weekly / monthly at an hour in the owner's time zone, atomic claim, idempotent run per slot, built as the owner with an access re-check, branded mail to the owner only, auto-pause with a reason.
Operator page, UserKit eraser and export, bridges for brand-contracts, MailKit, NotifyKit, AuditKit and ApiTokenBundle; optional public API <prefix>/reports/v1 (off by default).

Installation

composer require nowo-tech/report-kit-bundle

See docs/INSTALLATION.md. Nothing is registered while nowo_report_kit.enabled is false.

Configuration

# config/packages/nowo_report_kit.yaml
nowo_report_kit:
    enabled: false

Every key of the contract is already accepted (strict tree): docs/CONFIGURATION.md.

Documentation

Installation
Configuration
Usage (incl. using it from a DDD / hexagonal application)
Roadmap (slices and open questions)
Contract
Security
FrankenPHP worker audit
Demo with FrankenPHP
Upgrading · Changelog · Release
Architecture · PSR · Spec-driven development · Spec Kit
Contributing · GitHub CI · Engram

Requirements

PHP >= 8.2, < 8.6
Symfony 7.4, 8.0 or 8.1

Demo

demo/symfony8: Symfony 8.1, FrankenPHP worker mode, MySQL, on http://localhost:8223 (make -C demo up).

Tests and coverage

make test               # PHPUnit in Docker
make test-coverage-100  # fails below 100 % of src/
make release-check      # every gate, demo included

PHP: 100 % of src/ (gate in CI).

License

MIT. See LICENSE.

Author

Created by Héctor Franco Aceituno at Nowo.tech.

nowo-tech / report-kit-bundle

Package info

Security

Fund package maintenance!

Statistics