Filament Breezy

https://github.com/jacobtims/filament-breezy
Admin
Filament Breezy provides enhanced security features for Filament v4+ Panels, including a...
Tokens:51,934
Snippets:419
Trust Score:8.1
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Filament Breezy via Composer

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Install the package via Composer and run the installer command.

```bash
composer require jeffgreco13/filament-breezy
php artisan breezy:install
```

--------------------------------

### Install command signature and description

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/service-provider-command-events.md

Defines the command's signature and description properties. The signature is 'breezy:install' and the description is 'Install script for Breezy.'.

```php
protected $signature = 'breezy:install';
protected $description = 'Install script for Breezy.';
```

--------------------------------

### Enable Browser Sessions usage example

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-browser-sessions.md

Example from README showing how to enable browser sessions with a named argument.

```php
BreezyCore::make()
    ->enableBrowserSessions(condition: true);
```

--------------------------------

### setUp

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/actions.md

Protected method that sets up the action's confirmation behavior based on the password session validity.

```APIDOC
## setUp

### Description
Configures the action to require password confirmation when the password session is not valid. Adds a `current_password` field with the `current_password` validation rule and sets modal heading and description.

### Method
protected

### Signature
`protected function setUp(): void`

### Behavior
- If the password session is **not** valid:
  - Calls `requiresConfirmation()`
  - Sets `modalHeading` to `filament-breezy::default.password_confirm.heading` ("Confirm password")
  - Sets `modalDescription` to `filament-breezy::default.password_confirm.description` ("Please confirm your password to complete this action.")
  - Adds a `current_password` TextInput (password, `rule('current_password')`, required)
- If the session **is** valid, no confirmation modal is added.

### Source
`src/Actions/PasswordButtonAction.php:15` (identical in `AuthenticatePasskeyAction.php:15`)
```

--------------------------------

### Enable passkeys with BreezyCore

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-passkeys.md

Example from the README showing how to enable passkeys with named arguments for relying-party name, ID, icon, and panel scoping.

```php
BreezyCore::make()
    ->enablePasskeys(
        relyingPartyName: 'My App',
        relyingPartyId: 'https://my-app.com',
        relyingPartyIcon: '/logo.png',
        scopeToPanel: true,
    );
```

--------------------------------

### Install command handle method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/service-provider-command-events.md

Declares the handle method for the install command. This method is called when the command is executed.

```php
public function handle(): int
```

--------------------------------

### Usage Example with Agent and BrowserSessions

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/agent.md

Shows how to instantiate Agent, set the user agent from a session, and call browser(), platform(), and isDesktop(). This is internally used by getSessions().

```php
use Jeffgreco13\FilamentBreezy\Agent;
use Jeffgreco13\FilamentBreezy\Livewire\BrowserSessions;

// Internally used by getSessions():
$agent = tap(new Agent, fn ($agent) => $agent->setUserAgent($session->user_agent));

$browser = $agent->browser();   // ?string
$platform = $agent->platform(); // ?string
$isDesktop = $agent->isDesktop(); // bool
```

--------------------------------

### configurePackage method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/service-provider-command-events.md

Configures the package with routes, views, translations, migrations, and the install command.

```php
public function configurePackage(Package $package): void

```

--------------------------------

### Example usage of myProfile

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Shows how to call myProfile on a BreezyCore instance with named arguments to configure the My Profile page.

```php
BreezyCore::make()
    ->myProfile(
        shouldRegisterUserMenu: true,
        userMenuLabel: 'My Profile',
        shouldRegisterNavigation: false,
        navigationGroup: 'Settings',
        hasAvatars: false,
        slug: 'my-profile',
    );
```

--------------------------------

### Example usage of enableTwoFactorAuthentication

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-two-factor-authentication.md

Example of enabling two-factor authentication with custom action and middleware, scoped to the current panel.

```php
BreezyCore::make()
    ->enableTwoFactorAuthentication(
        force: false,
        action: CustomTwoFactorPage::class,
        authMiddleware: MustTwoFactor::class,
        scopeToPanel: true,
    );
```

--------------------------------

### Usage example for listing and logging out sessions

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-browser-sessions.md

Shows how to enable browser sessions and then programmatically list and log out other sessions. Includes error handling note: incorrect password dispatches a danger notification and aborts.

```php
BreezyCore::make()
    ->myProfile()
    ->enableBrowserSessions();

// In your own code, list and log out sessions programmatically:
use Jeffgreco13\FilamentBreezy\Livewire\BrowserSessions;

$sessions = BrowserSessions::getSessions(); // array of session-info objects
BrowserSessions::logoutOtherBrowserSessions($currentPassword);
```

--------------------------------

### Usage Examples

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/actions.md

Examples of using the PasswordButtonAction class in Filament, including basic and customized usage, along with error handling notes.

```APIDOC
## Usage Examples

### Basic Usage

```php
use Jeffgreco13\FilamentBreezy\Actions\PasswordButtonAction;
use Filament\Support\Icons\Heroicon;

PasswordButtonAction::make('secure_action')->action('doSecureAction');
```

### Customized Usage

```php
use Jeffgreco13\FilamentBreezy\Actions\PasswordButtonAction;
use Filament\Support\Icons\Heroicon;

PasswordButtonAction::make('secure_action')
    ->label('Delete')
    ->icon(Heroicon::ShieldCheck)
    ->modalHeading('Confirmation')
    ->action(fn() => $this->doAction());
```

### Error Handling
Validation failures surface as standard Filament modal validation on the `current_password` field via the `current_password` rule; no exceptions are thrown by the action itself. The `password_timeout` behavior is controlled entirely by `config('auth.php')` → `'password_timeout'` (default 10800 seconds).
```

--------------------------------

### Custom MyProfileComponent example

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/livewire-my-profile.md

Shows how to create a custom component by extending MyProfileComponent. Includes mount, form, and submit methods for updating a custom field on the user model.

```php
use Jeffgreco13\FilamentBreezy\Livewire\MyProfileComponent;
use Filament\Forms\Components\TextInput;
use Filament\Schemas\Schema;

class MyCustomComponent extends MyProfileComponent
{
    protected string $view = "livewire.my-custom-component";
    public array $only = ['my_custom_field'];
    public array $data;
    public $user;
    public $userClass;

    public function mount()
    {
        $this->user = Filament::getCurrentPanel()->auth()->user();
        $this->userClass = get_class($this->user);
        $this->form->fill($this->user->only($this->only));
    }

    public function form(Schema $schema): Schema
    {
        return $schema
            ->components([TextInput::make('my_custom_field')->required()])
            ->statePath('data');
    }

    public function submit(): void
    {
        $data = collect($this->form->getState())->only($this->only)->all();
        $this->user->update($data);
        Notification::make()->success()->title('Custom component updated successfully')->send();
    }
}
```

--------------------------------

### storePasskey method signature and example call

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-passkeys.md

Method signature and example call for storing a passkey. The method validates the public key credential and creates a Passkey record with authenticatable_id, authenticatable_type, and data. It throws exceptions for invalid or unvalidated credentials. The example shows a typical wire call from Passkeys::storePasskey.

```php
public function storePasskey(Authenticatable $authenticatable, string $passkeyJson, string $passkeyOptionsJson, string $hostName, array $additionalProperties = []): Passkey
```

```php
filament('filament-breezy')->storePasskey(
    $this->user,
    $passkey,
    $this->previouslyGeneratedPasskeyOptions(),
    request()->getHost(),
    ['name' => $this->name],
);
```

--------------------------------

### setUp method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/actions.md

When the password session is not valid, the action automatically requires confirmation, sets modal heading and description, and adds a current_password TextInput with the current_password rule. When valid, no confirmation modal is added.

```php
protected function setUp(): void
```

--------------------------------

### customMyProfilePage usage example

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Example usage of customMyProfilePage to replace the default MyProfile page with AccountSettingsPage.

```php
BreezyCore::make()
    ->myProfile()
    ->customMyProfilePage(AccountSettingsPage::class);
```

--------------------------------

### passwordUpdateRules usage example

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Example usage of passwordUpdateRules with a Password rule instance and requiresCurrentPassword set to true.

```php
use Illuminate\Validation\Rules\Password;

BreezyCore::make()
    ->passwordUpdateRules(
        rules: [Password::default()->mixedCase()->uncompromised(3)],
        requiresCurrentPassword: true,
    );
```

--------------------------------

### Override existing components with myProfileComponents

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Example of overriding existing components by key using myProfileComponents(). The new components are spread first, so user-provided overrides win over defaults.

```php
BreezyCore::make()
    ->myProfileComponents([
        'update_password' => MyCustomComponent::class,
        'browser_sessions' => \App\Livewire\CustomBrowserSessions::class,
    ]);
```

--------------------------------

### Append custom component with myProfileComponents

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Example of appending a custom component to the my profile page using myProfileComponents().

```php
use App\Livewire\MyCustomComponent;

BreezyCore::make()
    ->myProfileComponents([MyCustomComponent::class]);
```

--------------------------------

### Enable Sanctum tokens with custom permissions

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-sanctum-tokens.md

Example usage from the README showing how to enable Sanctum tokens with custom permissions. The permissions array overrides the default abilities shown in the token creation form.

```php
BreezyCore::make()
    ->enableSanctumTokens(
        permissions: ['my', 'custom', 'permissions']
    );
```

--------------------------------

### CustomPersonalInfo customization example

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/livewire-my-profile.md

Shows how to extend PersonalInfo to customize 'only' fields, add custom components, and override getNameComponent and sendNotification. Note the need to keep getCurrentPasswordComponent for security.

```php
class CustomPersonalInfo extends PersonalInfo
{
    public ?array $only = ['custom_name_field', 'custom_email_field'];

    protected function getProfileFormComponents(): array
    {
        return [
            $this->getNameComponent(),
            $this->getEmailComponent(),
            $this->getCurrentPasswordComponent(),
            $this->getCustomComponent(),
        ];
    }

    protected function getNameComponent(): Forms\Components\TextInput
    {
        return Forms\Components\TextInput::make('custom_name_field')->required();
    }

    protected function sendNotification(): void
    {
        Notification::make()->success()->title('Saved Data!')->send();
    }
}
```

--------------------------------

### Implement HasAvatar for User Model

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Example implementation of the HasAvatar contract to provide a custom avatar URL using the avatar_url column.

```php
use Illuminate\Support\Facades\Storage;
use Filament\Models\Contracts\HasAvatar;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements FilamentUser, HasAvatar
{
    // ...

    public function getFilamentAvatarUrl(): ?string
    {
        return $this->avatar_url ? Storage::url($this->avatar_url) : null;
    }
}
```

--------------------------------

### verify usage in TwoFactorPage authenticate flow

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-two-factor-authentication.md

Example of verifying a code in the TwoFactorPage authenticate flow, setting the two-factor session on success.

```php
// In the TwoFactorPage authenticate flow
if (filament('filament-breezy')->verify(code: $this->code)) {
    Filament::auth()->user()->setTwoFactorSession();
}
```

--------------------------------

### Register passkeys authentication-options route

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/endpoints.md

Defines a GET route for passkey authentication options. It returns an empty JSON array as a stub, with the real flow handled by the Livewire PasskeyAction component. The route is registered at routes/web.php:28 and has no authentication requirement beyond the panel middleware.

```php
Route::get('/passkeys/authentication-options', function () {
    return [];
})->name('passkeys.authentication_options');
```

--------------------------------

### bootingPackage method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/service-provider-command-events.md

Registers the bundled JS asset, event listener, and Livewire components. Called during package booting.

```php
public function bootingPackage(): void

```

--------------------------------

### BreezyCore::boot

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Registers components, render hooks, and user menu items after plugin registration.

```APIDOC
## BreezyCore::boot

### Description
Plugin lifecycle hook called after all plugins are registered. Registers components, render hooks, and user menu items.

### Method
boot

### Signature
public function boot(Panel $panel): void

### Parameters
- **$panel** (Panel) - Required - The Filament panel instance.

### Behavior
- If `myProfile` is enabled, registers optional components by key: `sanctum_tokens`, `two_factor_authentication`, `browser_sessions`, `passkeys`.
- When passkeys are enabled, registers a render hook on `PanelsRenderHook::AUTH_LOGIN_FORM_AFTER`.
- Always registers `personal_info` and `update_password` components.
- If `shouldRegisterUserMenu` is true, registers a 'profile' user menu item.
```

--------------------------------

### avatarUploadComponent usage example

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Example usage of avatarUploadComponent to customize the avatar upload component. Shows two options: disabling the label or replacing with a custom FileUpload component.

```php
use Filament\Forms\Components\FileUpload;

BreezyCore::make()
    ->avatarUploadComponent(fn ($fileUpload) => $fileUpload->disableLabel())
    // OR, replace with your own component
    ->avatarUploadComponent(fn () => FileUpload::make('avatar_url')->disk('profile-photos'));
```

--------------------------------

### GET /two-factor-authentication route definition

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/endpoints.md

Registers the GET route for the two-factor authentication page. The route is named 'auth.two-factor' and is handled by the plugin's two-factor route action, which defaults to the TwoFactorPage Livewire component. This route is only registered when the panel has the Breezy plugin enabled.

```php
Route::get('/two-factor-authentication', $plugin->getTwoFactorRouteAction())->name('auth.two-factor');
```

--------------------------------

### BreezySession booted method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/models.md

The booted method adds a creating hook and a PanelScope global scope when the configuration option is enabled.

```php
protected static function booted(): void
```

--------------------------------

### BreezyCore::register

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Registers plugin pages and middleware during panel boot.

```APIDOC
## BreezyCore::register

### Description
Plugin lifecycle hook called by Filament when the panel boots. Registers pages and middleware.

### Method
register

### Signature
public function register(Panel $panel): void

### Parameters
- **$panel** (Panel) - Required - The Filament panel instance.

### Behavior
- Registers prepared pages (e.g., My Profile page) via `$panel->pages(...)`.
- If 2FA is enabled and `twoFactorAuthenticationMiddleware` is not `false`, appends middleware to the panel's authMiddleware list.
```

--------------------------------

### Configure My Profile Page

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Enable the My Profile page with configuration options. Each parameter has a default value as noted in the comments.

```php
BreezyCore::make()
    ->myProfile(
        shouldRegisterUserMenu: true, // Sets the 'account' link in the panel User Menu (default = true)
        userMenuLabel: 'My Profile', // Customizes the 'account' link label in the panel User Menu (default = null)
        shouldRegisterNavigation: false, // Adds a main navigation item for the My Profile page (default = false)
        navigationGroup: 'Settings', // Sets the navigation group for the My Profile page (default = null)
        hasAvatars: false, // Enables the avatar upload form component (default = false)
        slug: 'my-profile' // Sets the slug for the profile page (default = 'my-profile')
    )
```

--------------------------------

### BreezyCore::make

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Factory method to create a BreezyCore plugin instance.

```APIDOC
## BreezyCore::make

### Description
Creates a new BreezyCore plugin instance, resolving dependencies from the Laravel container.

### Method
make

### Signature
public static function make(): static

### Parameters
None

### Returns
- **static** - A BreezyCore instance with Google2FA engine and optional cache injected.

### Usage Example
```php
use Jeffgreco13\FilamentBreezy\BreezyCore;

public function panel(Panel $panel): Panel
{
    return $panel
        ->authGuard('customers')
        ->plugins([
            BreezyCore::make()
                ->myProfile()
                ->enableTwoFactorAuthentication(),
        ]);
}
```
```

--------------------------------

### Accessing the Breezy plugin instance

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/service-provider-command-events.md

Shows how to access the BreezyCore instance via the filament helper. The commented alternative demonstrates calling the verify method.

```php
filament('filament-breezy')     // -> BreezyCore instance
// or: filament('filament-breezy')->verify(...)
```

--------------------------------

### Create and register a custom My Profile component

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Steps to create a custom Livewire component for the My Profile page. First generate the component with artisan, then extend MyProfileComponent, create the view using Filament's Blade components, and finally register it with Breezy using myProfileComponents.

```bash
php artisan make:livewire MyCustomComponent

```

```php
use Jeffgreco13\FilamentBreezy\Livewire\MyProfileComponent;
use Filament\Forms\Components\TextInput;
use Filament\Schemas\Schema;

class MyCustomComponent extends MyProfileComponent
{
    protected string $view = "livewire.my-custom-component";
    public array $only = ['my_custom_field'];
    public array $data;
    public $user;
    public $userClass;

    // this example shows an additional field we want to capture and save on the user
    public function mount()
    {
        $this->user = Filament::getCurrentPanel()->auth()->user();
        $this->userClass = get_class($this->user);

        $this->form->fill($this->user->only($this->only));
    }

    public function form(Schema $schema): Schema
    {
        return $schema
            ->components([
                TextInput::make('my_custom_field')
                    ->required()
            ])
            ->statePath('data');
    }

    // only capture the custome component field
    public function submit(): void
    {
        $data = collect($this->form->getState())->only($this->only)->all();
        $this->user->update($data);
        Notification::make()
            ->success()
            ->title(__('Custom component updated successfully'))
            ->send();
    }
}

```

```bladehtml
<x-filament::section :aside="true" heading="Your title" description="This is the description">
    <form wire:submit.prevent="submit" class="space-y-6">

        {{ $this->form }}

        <div class="text-right">
            <x-filament::button type="submit" form="submit" class="align-right">
                Submit!
            </x-filament::button>
        </div>
    </form>
</x-filament::section>

```

```php
use App\Livewire\MyCustomComponent;

BreezyCore::make()
    ->myProfileComponents([MyCustomComponent::class])

```

--------------------------------

### myProfile

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Configures the My Profile page registration, including user menu link, navigation, avatars, slug, and other options. Returns the BreezyCore instance for chaining.

```APIDOC
## myProfile

### Description
Configures the My Profile page registration, including user menu link, navigation, avatars, slug, and other options. Returns the BreezyCore instance for chaining.

### Method
myProfile

### Signature
```php
public function myProfile(bool $condition = true, bool $shouldRegisterUserMenu = true, bool $shouldRegisterNavigation = false, bool $hasAvatars = false, string $slug = 'my-profile', ?string $navigationGroup = null, ?string $userMenuLabel = null, string|BackedEnum|null $navigationIcon = Heroicon::OutlinedUserCircle): static
```

### Parameters
- **$condition** (bool) - Optional - Default: `true` - Whether the My Profile page is registered on the panel
- **$shouldRegisterUserMenu** (bool) - Optional - Default: `true` - Adds an "account"/profile link in the panel's User Menu
- **$shouldRegisterNavigation** (bool) - Optional - Default: `false` - Adds a main navigation item for the page
- **$hasAvatars** (bool) - Optional - Default: `false` - Enables the avatar upload form component (requires an `avatar_url` column on the user model and the `Filament\Models\Contracts\HasAvatar` contract)
- **$slug** (string) - Optional - Default: `'my-profile'` - URL slug of the profile page
- **$navigationGroup** (?string) - Optional - Default: `null` - Navigation group for the page
- **$userMenuLabel** (?string) - Optional - Default: `null` - Custom label for the user menu link; falls back to the user's name
- **$navigationIcon** (string|BackedEnum|null) - Optional - Default: `Heroicon::OutlinedUserCircle` - Navigation icon

### Return Value
- **static** - Returns the BreezyCore instance for method chaining.

### Example
```php
BreezyCore::make()
    ->myProfile(
        shouldRegisterUserMenu: true,
        userMenuLabel: 'My Profile',
        shouldRegisterNavigation: false,
        navigationGroup: 'Settings',
        hasAvatars: false,
        slug: 'my-profile',
    );
```
```

--------------------------------

### platform() Method Signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/agent.md

Returns the platform name by matching the User-Agent against MobileDetect's operating systems merged with additional patterns. Results are cached under 'breezy.platform'.

```php
public function platform(): ?string
```

--------------------------------

### Publish Breezy Views

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Optionally publish Breezy's views for customization.

```bash
php artisan vendor:publish --tag="filament-breezy-views"
```

--------------------------------

### BreezyCore::register() lifecycle hook

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Plugin lifecycle hook called by Filament when the panel boots. Registers prepared pages (currently the My Profile page when myProfile() is enabled) and appends twoFactorAuthenticationMiddleware to the panel's authMiddleware list if 2FA is enabled and the middleware is not false.

```php
public function register(Panel $panel): void
```

--------------------------------

### PasswordButtonAction for sensitive actions

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Use PasswordButtonAction to prompt the user for their password before performing sensitive actions. It uses the same 'password_timeout' seconds from config/auth.php. The second example shows customization of label, icon, modal heading, and action.

```php
use Jeffgreco13\FilamentBreezy\Actions\PasswordButtonAction;
use Filament\Support\Icons\Heroicon;

PasswordButtonAction::make('secure_action')->action('doSecureAction')

// Customize the icon, action, modalHeading and anything else.
PasswordButtonAction::make('secure_action')->label('Delete')->icon(Heroicon::ShieldCheck)->modalHeading('Confirmation')->action(fn() => $this->doAction())
```

--------------------------------

### BreezyCore::boot() lifecycle hook

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Plugin lifecycle hook called after all plugins are registered. Registers optional My Profile components (sanctum_tokens, two_factor_authentication, browser_sessions, passkeys) when enabled, always registers personal_info and update_password, and registers a 'profile' user menu item if shouldRegisterUserMenu is true.

```php
public function boot(Panel $panel): void
```

--------------------------------

### GET /{panelPath}/two-factor-authentication

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/endpoints.md

Displays the two-factor authentication challenge page and handles the authentication form submission. Unauthenticated users are redirected to the login page, while users with a valid 2FA session are redirected to the home page.

```APIDOC
## GET /{panelPath}/two-factor-authentication

### Description
Displays the two-factor authentication challenge page and handles the authentication form submission. Unauthenticated users are redirected to the login page, while users with a valid 2FA session are redirected to the home page.

### Method
GET

### Endpoint
/{panelPath}/two-factor-authentication

With tenancy: /{panelPath}/{tenant}/two-factor-authentication

### Parameters
#### Path Parameters
- **panelPath** (string) - Required - The panel's path prefix.
- **tenant** (string) - Required (when tenancy is enabled) - The tenant identifier.

#### Query Parameters
- **next** (?string) - Optional - The redirect target after successful authentication. Bound to `TwoFactorPage::$next`.

#### Request Body
None (GET form page). The Livewire form posts the page's form state internally (`data.code`).

### Request Example
No request body for GET requests.

### Response
#### Success Response (200)
- **HTML** - The Two-Factor Challenge page.

On `authenticate` submit (Livewire action):
- **Success** → `RedirectResponse` to `next` (or the panel home URL).
- **Invalid code** → validation error on `data.code`.
- **Rate limited** (>5 attempts) → error on `data.code` with throttled message.

#### Response Example
No response body example provided.

### Errors / Status Codes
- **302** - Redirect to login URL (unauthenticated), home URL (valid session), or after success.
- **Rate limit exceeded** - More than 5 `authenticate` attempts within the rate-limit window. The `TooManyRequestsException` is caught and rendered as a `data.code` field error; the request completes normally with the error visible.
```

--------------------------------

### myProfileComponents method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Method signature for registering my profile components. Accepts a map of component key to Livewire component class, or a numeric-keyed array of component classes. Components are merged with previously registered ones, with new components spread first so user overrides win.

```php
public function myProfileComponents(array $components): static
```

--------------------------------

### Install TwoFactorAuthenticatable trait on User model

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/two-factor-authenticatable.md

Adds the TwoFactorAuthenticatable trait to the User model to enable 2FA capabilities. The trait morphs to BreezySession records that store the encrypted TOTP secret, recovery codes, and confirmation timestamp.

```php
use Jeffgreco13\FilamentBreezy\Traits\TwoFactorAuthenticatable;

class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable, TwoFactorAuthenticatable;
    // ...
}
```

--------------------------------

### getEngine method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-two-factor-authentication.md

Returns the injected `PragmaRX\Google2FA\Google2FA` engine.

```php
public function getEngine(): Google2FA
```

--------------------------------

### Enable Sanctum tokens with enableSanctumTokens()

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Enable the Sanctum token management component. The permissions parameter is optional and defaults to ["create", "view", "update", "delete"]. Note that since Laravel 11.x Sanctum is not included by default and must be installed separately.

```php
BreezyCore::make()
    ->enableSanctumTokens(
        permissions: ['my','custom','permissions'] // optional, customize the permissions (default = ["create", "view", "update", "delete"])
    )
```

--------------------------------

### getEngine

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-two-factor-authentication.md

Returns the injected `PragmaRX\Google2FA\Google2FA` engine.

```APIDOC
## getEngine

### Description
Returns the injected `PragmaRX\Google2FA\Google2FA` engine.

### Method
`public function getEngine(): Google2FA`

### Returns
- **Google2FA** - The injected Google2FA engine instance.

### Source
`src/Concerns/Plugin/HasTwoFactorAuthentication.php:55`
```

--------------------------------

### Resolve BreezyCore at runtime and verify OTP

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Resolves the BreezyCore instance from the current panel at runtime and calls the verify() method with a named argument for the OTP code.

```php
// Resolve the configured instance at runtime
$breezy = filament('filament-breezy');

$breezy->verify(code: $otpCode);
```

--------------------------------

### enablePasskeys for passwordless authentication

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Enable passkey authentication with optional configuration for relying party name, ID, icon, and panel scoping. Defaults are APP_NAME, APP_URL, and true for scopeToPanel.

```php
BreezyCore::make()
    ->enablePasskeys( 
        relyingPartyName: 'My App', // optionally, change the passkey's party name (default = APP_NAME)
        relyingPartyId: 'https://my-app.com', // optionally, change the passkey's party id (default = APP_URL)
        relyingPartyIcon: '/logo.png', // optionally, change the passkey's party icon 
        scopeToPanel: true, // scope the passkeys only to the current panel (default = true)
    )
```

--------------------------------

### isDesktop() Method Signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/agent.md

Returns true when the User-Agent is Amazon CloudFront with header HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER === 'true', or when the device is neither mobile nor tablet. Results are cached under 'breezy.desktop'.

```php
public function isDesktop(): bool
```

--------------------------------

### enablePasskeys method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-passkeys.md

Method signature for enabling passkeys on a BreezyCore instance. Parameters control whether passkeys are enabled, relying-party details, panel scoping, and auto-prompting on the login page.

```php
public function enablePasskeys(bool $condition = true, ?string $relyingPartyName = null, ?string $relyingPartyId = null, ?string $relyingPartyIcon = null, bool $scopeToPanel = true, bool $autoPrompt = false): static
```

--------------------------------

### getQrCodeUrl method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-two-factor-authentication.md

Returns the otpauth://totp/... provisioning URL via $this->engine->getQRCodeUrl(...).

```php
public function getQrCodeUrl($companyName, $companyEmail, $secret): string
```

--------------------------------

### getQrCodeUrl

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-two-factor-authentication.md

Generates the otpauth://totp/... provisioning URL for a given company name, email, and TOTP secret.

```APIDOC
## getQrCodeUrl

### Description
Generates the otpauth://totp/... provisioning URL for a given company name, email, and TOTP secret.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
- `$companyName` (mixed) - Required - App/company name (e.g. `config('app.name')`)
- `$companyEmail` (mixed) - Required - User email address
- `$secret` (mixed) - Required - The TOTP secret

### Returns
- `string` - The provisioning URL (`$this->engine->getQRCodeUrl(...)`)

### Source
`src/Concerns/Plugin/HasTwoFactorAuthentication.php:77`
```

--------------------------------

### BreezySession confirm method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/models.md

Fires a LoginSuccess event and sets two_factor_confirmed_at to the current time.

```php
public function confirm(): void
```

--------------------------------

### Configure Filament Breezy in Panel

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/configuration.md

Use the BreezyCore plugin within the panel configuration to customize profile settings, security features, and component registration.

```php
use Jeffgreco13\\\FilamentBreezy\\\BreezyCore;
use Illuminate\\\Validation\\\Rules\\\Password;

public function panel(Panel $panel): Panel
{
    return $panel
        ->authGuard('web')
        ->plugins([
            BreezyCore::make()
                ->myProfile(
                    shouldRegisterUserMenu: true,
                    userMenuLabel: 'My Profile',
                    shouldRegisterNavigation: false,
                    navigationGroup: 'Settings',
                    hasAvatars: true,
                    slug: 'my-profile',
                )
                ->avatarUploadComponent(fn ($fileUpload) => $fileUpload->disableLabel())
                ->passwordUpdateRules(
                    rules: [Password::default()->mixedCase()->uncompromised(3)],
                    requiresCurrentPassword: true,
                )
                ->enableTwoFactorAuthentication(
                    force: false,
                    action: TwoFactorPage::class,
                    authMiddleware: MustTwoFactor::class,
                    scopeToPanel: true,
                )
                ->enableSanctumTokens(
                    permissions: ['create', 'view', 'update', 'delete'],
                )
                ->enableBrowserSessions(condition: true)
                ->enablePasskeys(
                    relyingPartyName: 'My App',
                    relyingPartyId: 'https://my-app.com',
                    relyingPartyIcon: '/logo.png',
                    scopeToPanel: true,
                )
                ->withoutMyProfileComponents(['update_password']),
        ]);
}
```

--------------------------------

### enablePasskeys

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-passkeys.md

Documentation for the enablePasskeys method of the HasPasskeys trait.

```APIDOC
## enablePasskeys

### Description
Enables WebAuthn passkey registration and authentication for the plugin. Configures the relying party details and optional automatic prompting on the login page.

### Method
N/A (PHP method)

### Endpoint
N/A (PHP method)

### Parameters
- `$condition` (bool) - Optional - Default: `true` - Whether passkeys are enabled.
- `$relyingPartyName` (?string) - Optional - Default: `config('app.name')` - Relying-party display name.
- `$relyingPartyId` (?string) - Optional - Default: `request()->getHost()` - Relying-party ID (WebAuthn RP ID, e.g. `my-app.com`).
- `$relyingPartyIcon` (?string) - Optional - Default: `null` - Relying-party icon URL/path.
- `$scopeToPanel` (bool) - Optional - Default: `true` - Scope passkeys to the current panel (adds `PanelScope`).
- `$autoPrompt` (bool) - Optional - Default: `false` - Automatically prompt for a passkey on the login page.

### Request Example
```php
BreezyCore::make()
    ->enablePasskeys(
        relyingPartyName: 'My App',
        relyingPartyId: 'https://my-app.com',
        relyingPartyIcon: '/logo.png',
        scopeToPanel: true,
    );
```

### Response
Returns `static` (the `BreezyCore` instance) for chaining.

### Source
`src/Concerns/Plugin/HasPasskeys.php:37`
```

--------------------------------

### Override MyProfile components with myProfileComponents()

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Override existing MyProfile components by passing an associative array to myProfileComponents(). The keys are the component names (e.g., 'update_password') and the values are the replacement Livewire component classes. Commented-out keys show the available components that can be overridden.

```php
use App\Livewire\MyCustomComponent;

BreezyCore::make()
    ->myProfileComponents([
        // 'personal_info' => ,
        'update_password' => MyCustomComponent::class, // replaces UpdatePassword component with your own.
        // 'two_factor_authentication' => ,
        // 'sanctum_tokens' =>
        // 'browser_sessions' =>
    ])
```

--------------------------------

### Complete 2FA enforcement flow with BreezyCore

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/two-factor-authenticatable.md

Shows a complete 2FA enforcement flow: registering the Breezy panel with `force: true` to require two-factor authentication for all users, and guarding a sensitive operation by checking `hasConfirmedTwoFactor()` and redirecting to the Filament URL if not confirmed.

```php
use Jeffgreco13\FilamentBreezy\BreezyCore;

// Panel registration forces 2FA for all users
BreezyCore::make()->enableTwoFactorAuthentication(force: true);

// In your own controller/action, guard a sensitive operation
if (! auth()->user()->hasConfirmedTwoFactor()) {
    abort(redirect()->to(\Filament\Facades\Filament::getUrl()));
}
```

--------------------------------

### mount method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/livewire-my-profile.md

Method signature for mount(). Sets user, userClass, hasAvatars, appends avatar upload state path to $this->only if avatars are enabled, and fills the form with user's only fields.

```php
public function mount(): void
```

--------------------------------

### BreezyCore::make() static factory

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Static factory method that returns a BreezyCore instance resolved from the Laravel container, injecting the Google2FA engine and optional cache automatically.

```php
public static function make(): static
```

--------------------------------

### BreezyCore::getCurrentPanel() returns current panel

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Returns Filament::getCurrentOrDefaultPanel().

```php
public function getCurrentPanel()
```

--------------------------------

### confirmTwoFactorAuthentication method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/two-factor-authenticatable.md

Calls $this->breezySession?->confirm() which fires the LoginSuccess event and sets two_factor_confirmed_at, then calls setTwoFactorSession().

```php
public function confirmTwoFactorAuthentication(): void
```

--------------------------------

### Additional Operating Systems and Browsers Pattern Tables

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/agent.md

Defines the $additionalOperatingSystems and $additionalBrowsers arrays used by the Agent class to extend MobileDetect's detection rules.

```php
protected static array $additionalOperatingSystems = [
    'Windows' => 'Windows',
    'Windows NT' => 'Windows NT',
    'OS X' => 'Mac OS X',
    'Debian' => 'Debian',
    'Ubuntu' => 'Ubuntu',
    'Macintosh' => 'PPC',
    'OpenBSD' => 'OpenBSD',
    'Linux' => 'Linux',
    'ChromeOS' => 'CrOS',
];
```

```php
protected static array $additionalBrowsers = [
    'Opera Mini' => 'Opera Mini',
    'Opera' => 'Opera|OPR',
    'Edge' => 'Edge|Edg',
    'Coc Coc' => 'coc_coc_browser',
    'UCBrowser' => 'UCBrowser',
    'Vivaldi' => 'Vivaldi',
    'Chrome' => 'Chrome',
    'Firefox' => 'Firefox',
    'Safari' => 'Safari',
    'IE' => 'MSIE|IEMobile|MSIEMobile|Trident/[.0-9]+',
    'Netscape' => 'Netscape',
    'Mozilla' => 'Mozilla',
    'WeChat' => 'MicroMessenger',
];
```

--------------------------------

### bootTwoFactorAuthenticatable method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/two-factor-authenticatable.md

Model-event boot method that registers a 'deleting' listener to delete all of the model's BreezySession records when the model is deleted.

```php
public static function bootTwoFactorAuthenticatable(): void
```

--------------------------------

### enableBrowserSessions

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-browser-sessions.md

Enables the Browser Sessions component on the BreezyCore plugin.

```APIDOC
## enableBrowserSessions

### Description
Enables the Browser Sessions component on the BreezyCore plugin.

### Method
enableBrowserSessions

### Signature
`public function enableBrowserSessions(bool $condition = true): static`

### Parameters
- **$condition** (bool) - Optional - Default: `true` - Whether the Browser Sessions component is registered.

### Example
```php
BreezyCore::make()
    ->enableBrowserSessions(condition: true);
```
```

--------------------------------

### Add Breezy to Filament Panel

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Add Breezy to a Filament panel by including BreezyCore::make() in the plugins array.

```php
use Jeffgreco13\FilamentBreezy\BreezyCore;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            BreezyCore::make()
        ])
}
```

--------------------------------

### Register custom component with BreezyCore

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/livewire-my-profile.md

Registers the custom component with BreezyCore's myProfileComponents method.

```php
BreezyCore::make()
    ->myProfileComponents([MyCustomComponent::class]);
```

--------------------------------

### Enable Two Factor Authentication with enableTwoFactorAuthentication()

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Enable Two Factor Authentication on the Breezy plugin. The force parameter defaults to false, scopeToPanel defaults to true. The action parameter can be a custom 2FA page class, and authMiddleware can be customized or set to false to disable it.

```php
BreezyCore::make()
    ->enableTwoFactorAuthentication(
        force: false, // force the user to enable 2FA before they can use the application (default = false)
        action: CustomTwoFactorPage::class, // optionally, use a custom 2FA page
        authMiddleware: MustTwoFactor::class, // optionally, customize 2FA auth middleware or disable it to register manually by setting false
        scopeToPanel: true, // scope the 2FA only to the current panel (default = true)
    )
```

--------------------------------

### enableTwoFactorAuthentication method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/two-factor-authenticatable.md

Generates a secret and 8 recovery codes, deletes any existing BreezySession, creates a new one with the secret and recovery codes, and reloads relations. The created session is not confirmed until the user confirms with a valid OTP.

```php
public function enableTwoFactorAuthentication(): void
```

--------------------------------

### Basic usage of PasswordButtonAction

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/actions.md

Creates a PasswordButtonAction named 'secure_action' that triggers the 'doSecureAction' method. Requires importing the action class and the Heroicon icon class.

```php
use Jeffgreco13\FilamentBreezy\Actions\PasswordButtonAction;
use Filament\Support\Icons\Heroicon;

PasswordButtonAction::make('secure_action')->action('doSecureAction');
```

--------------------------------

### SkipTwoFactorAfterPasskeyAuthentication Listener Handle Method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/service-provider-command-events.md

Listener method that skips the two-factor authentication prompt when a passkey is used. Returns early if 2FA is disabled, otherwise confirms 2FA for the authenticatable user.

```php
public function handle(PasskeyUsedToAuthenticate $event): void
```

--------------------------------

### BreezyCore::auth() returns panel auth guard

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Returns Filament::getCurrentOrDefaultPanel()->auth(), the panel's auth guard instance used for ->user(), ->id(), and ->login().

```php
public function auth()
```

--------------------------------

### PanelScope apply method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/models.md

Global scope that adds a where clause to filter by the current panel id.

```php
public function apply(Builder $builder, Model $model)
{
    $builder->where('panel_id', Filament::getCurrentOrDefaultPanel()->getId());
}
```

--------------------------------

### form method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/livewire-my-profile.md

Method signature for form(). Builds a 3-column schema with or without avatar component depending on hasAvatars, using statePath('data').

```php
public function form(Schema $schema): Schema
```

--------------------------------

### BreezyCore::auth

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Returns the panel's auth guard instance.

```APIDOC
## BreezyCore::auth

### Description
Returns the panel's auth guard instance.

### Method
auth

### Signature
public function auth()

### Parameters
None

### Returns
- **mixed** - The auth guard instance from the current panel.

### Usage Example
```php
$breezy = filament('filament-breezy');
$user = $breezy->auth()->user();
```
```

--------------------------------

### BreezySession legacy decryption methods

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/models.md

Methods for backward-compatible decryption of legacy two-factor secrets and recovery codes.

```php
public function getTwoFactorSecretAttribute($value): ?string
```

```php
public function getTwoFactorRecoveryCodesAttribute($value): ?array
```

```php
protected function decryptLegacy($value): ?string
```

--------------------------------

### Register Custom My Profile Page

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/README.md

Use a custom My Profile page class by extending the default one and registering it with the plugin.

```php
BreezyCore::make()
    ->myProfile()
    ->customMyProfilePage(AccountSettingsPage::class),
```

--------------------------------

### BreezyCore::getCurrentPanel

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/breezy-core.md

Returns the current Filament panel instance.

```APIDOC
## BreezyCore::getCurrentPanel

### Description
Returns the current Filament panel instance.

### Method
getCurrentPanel

### Signature
public function getCurrentPanel()

### Parameters
None

### Returns
- **mixed** - The current panel instance.

### Usage Example
```php
$breezy = filament('filament-breezy');
$panel = $breezy->getCurrentPanel();
```
```

--------------------------------

### enableBrowserSessions method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-browser-sessions.md

Public method to enable the Browser Sessions component. Accepts an optional boolean condition (default true).

```php
public function enableBrowserSessions(bool $condition = true): static
```

--------------------------------

### myProfile method signature

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/has-my-profile.md

Defines the myProfile method with parameters for condition, user menu registration, navigation, avatars, slug, navigation group, user menu label, and navigation icon. The full argument list is stored as the $myProfile array property.

```php
public function myProfile(bool $condition = true, bool $shouldRegisterUserMenu = true, bool $shouldRegisterNavigation = false, bool $hasAvatars = false, string $slug = 'my-profile', ?string $navigationGroup = null, ?string $userMenuLabel = null, string|BackedEnum|null $navigationIcon = Heroicon::OutlinedUserCircle): static
```

--------------------------------

### BreezySession authenticatable method

Source: https://github.com/jacobtims/filament-breezy/blob/3.x/_autodocs/api-reference/models.md

Defines a polymorphic morphTo relation to the owning user model.

```php
public function authenticatable(): MorphTo
```
Tokens:
Raw