jeffersongoncalves / filament-ccpa
Filament plugin for laravel-ccpa: your personal information inventory in the panel, with each column's CCPA category, sensitive flag, whether it is sold or shared, retention and deidentification.
Package info
github.com/jeffersongoncalves/filament-ccpa
pkg:composer/jeffersongoncalves/filament-ccpa
Requires
- php: ^8.2
- filament/filament: ^5.3
- jeffersongoncalves/filament-plugin-core: ^3.0
- jeffersongoncalves/laravel-ccpa: ^1.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- larastan/larastan: ^3.0
- laravel/pint: ^1.0
- orchestra/testbench: ^10.0|^11.0
- pestphp/pest: ^3.0|^4.0
- pestphp/pest-plugin-laravel: ^3.0|^4.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Filament CCPA
A personal data inventory page for your Filament panel, built on laravel-ccpa. It lists every column you declared with #[PersonalData], grouped by model, with its category, purpose, legal basis, retention and anonymization strategy. It is what your CCPA notices disclose: the categories you collect, the sensitive ones, and what you sell or share.
Features
- One card per model in
ccpa.models, one row per declared column. - Sensitive personal information highlighted, and columns you sell or share flagged.
- Columns without a CCPA category (Cal. Civ. Code §1798.140(v)) flagged as "Not declared".
- 19 languages.
Compatibility
| Plugin Version | Filament |
|---|---|
| 1.x | 3.x |
| 2.x | 4.x |
| 3.x | 5.x |
Installation
You can install the package via composer:
composer require jeffersongoncalves/filament-ccpa:"^3.0"
Declare your personal data and register the models as described in laravel-ccpa.
Usage
use JeffersonGoncalves\Filament\Ccpa\CcpaPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ CcpaPlugin::make() ->navigationGroup('CCPA') // default: no group ->navigationSort(1) ->navigationIcon('heroicon-o-finger-print') ->slug('personal-data-inventory'), ]); }
All fluent methods are optional. The page is read-only: the inventory lives in your code, next to the models.
The page has no authorization of its own: register it only on panels whose users may see it, or override
canAccess()in a subclass.
Related plugins
- filament-ccpa-requests: consumer requests to know, delete and correct.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
