Dashboard Reports
Package docs status
Section titled “Package docs status”This page is generated from public package documentation in capell-4/packages and the package manifest checked into the source repository.
| Field | Value |
|---|---|
| Composer package | capell-app/dashboard-reports |
| Package slug | dashboard-reports |
| Product group | Capell Operations |
| Tier | premium |
| Bundle | operations |
| Runtime contexts | admin |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/dashboard-reports |
| Docs source | packages/dashboard-reports/docs |
| Manifest | capell.json |
Generic CMS reporting widgets for Capell dashboards.
At A Glance
Section titled “At A Glance”- Package:
capell-app/dashboard-reports - Namespace:
Capell\DashboardReports\ - Surfaces: Filament admin
- Service providers:
packages/dashboard-reports/src/Providers/AdminServiceProvider.php,packages/dashboard-reports/src/Providers/DashboardReportsServiceProvider.php - Capell dependencies:
capell-app/admin,capell-app/core - Third-party dependencies:
lorisleiva/laravel-actions,spatie/laravel-data,spatie/laravel-package-tools
Why It Helps Your Capell Workflow
Section titled “Why It Helps Your Capell Workflow”- Turns common CMS health and content signals into dashboard widgets that operators can scan quickly.
- Helps owners understand content health and publishing trends without opening several admin resources.
- Gives developers small reporting Actions that can be tested independently from Filament widget rendering.
Best Used With
Section titled “Best Used With”What It Adds
Section titled “What It Adds”Generic CMS reporting widgets for Capell dashboards.
- Shared dashboard reporting widgets for Capell admin screens.
- Service providers for package and admin registration.
- A reporting foundation that other operations packages can build on.
Why It Matters
Section titled “Why It Matters”For developers: Keeps Dashboard Reports package responsibilities isolated behind providers, actions, data objects, and package-owned resources where the package needs them.
For teams: Makes the Capell Operations capability easier to explain, install, and verify during package selection.
Built With
Section titled “Built With”This package makes its Composer dependencies visible because they are part of the value proposition, not just plumbing. When an upstream package has a public repository, its linked preview card points readers back to the maintainers so their work gets proper credit.
Capell packages used here
Open-source packages used here
- Laravel Actions - single-purpose action classes that keep package workflows out of controllers and Filament resources.
- Spatie Laravel Data - typed data objects for package boundaries, form state, settings, and structured results.
- Spatie Laravel Package Tools - Laravel package bootstrapping for config, migrations, commands, translations, and service provider setup.
Linked package previews
Code Map
Section titled “Code Map”| Area | Path | Purpose |
|---|---|---|
| Actions | packages/dashboard-reports/src/Actions | Domain operations. Test these directly where possible. |
| Data | packages/dashboard-reports/src/Data | Structured payloads, form state, view models, and integration data. |
| Filament | packages/dashboard-reports/src/Filament | Admin resources, pages, widgets, and settings UI. |
| Providers | packages/dashboard-reports/src/Providers | Registration, extension hooks, routes, migrations, and resources. |
| Resources | packages/dashboard-reports/resources | Views, translations, assets, and package resources. |
| Tests | packages/dashboard-reports/tests | Package-level Pest coverage. |
Admin Surface
Section titled “Admin Surface”- Widgets:
ContentHealthWidget,PublishingTrendChartWidget.
Data And Persistence
Section titled “Data And Persistence”- Data objects live in
src/Data/; use them for payloads, form state, and view models.
Extension Points
Section titled “Extension Points”- Register Capell extension points, routes, migrations, settings, render hooks, and resources from service providers.
Install And Setup
Section titled “Install And Setup”- Install with
composer require capell-app/dashboard-reportsin the host Capell application. - In this repository, verify package changes with
vendor/bin/pest; do not usephp artisan.
Testing
Section titled “Testing”Run package tests from the repository root:
vendor/bin/pest packages/dashboard-reports/tests --configuration=phpunit.xmlMaintenance Notes
Section titled “Maintenance Notes”- Put behaviour changes in
src/Actions/; UI classes, commands, and controllers should call actions instead of owning domain logic. - Use package
Dataclasses at boundaries instead of passing anonymous arrays between layers.