Notification types

// config/notifications.php
'types' => [
    App\Notifications\Types\RequestAwaitingApproval::class,
    App\Notifications\Types\ContractExpiring::class,
    App\Notifications\Types\SecurityAlert::class,
],

use Illuminate\Database\Eloquent\Model;
use RoundlyConsulting\Notifications\Enums\Priority;
use RoundlyConsulting\Notifications\NotificationPayload;
use RoundlyConsulting\Notifications\NotificationType;

final class SecurityAlert extends NotificationType
{
    public function key(): string { return 'security.alert'; }
    public function category(): string { return 'security'; }
    public function mandatory(): bool { return true; }                 // nobody can mute it
    public function priority(): Priority { return Priority::Urgent; }  // never held by quiet hours
    public function sensitive(?Model $subject): bool { return true; }  // a title + link mail only

    public function title(NotificationPayload $p): string
    {
        return __('app.security_alert', ['what' => $p->data['what'] ?? 'activity']);
    }

    public function url(NotificationPayload $p): ?string { return route('account.security'); }
}

public function title(NotificationPayload $p): string
{
    $p->type;         // 'request.awaiting_approval'
    $p->recipient;    // the recipient model
    $p->subject;      // the fresh subject — null when it is gone
    $p->subjectKey;   // survives the subject's deletion
    $p->actor;        // the latest actor
    $p->context;      // ?ContextReference: key, label, type, id
    $p->data;         // the latest event's data
    $p->count;        // events collapsed into this item or mail
    $p->firstAt;      // CarbonImmutable, UTC
    $p->lastAt;
    $p->channel;      // Channel::Inbox or Channel::Mail
    $p->escalated;    // true on an escalation send
    $p->reminder;     // ?ReminderReference: id, rule, offset ('-P30D'), dueAt, level

    return trans_choice('app.awaiting', $p->count, ['ref' => $p->data['reference'], 'count' => $p->count]);
}

use RoundlyConsulting\Notifications\Enums\Priority;
use RoundlyConsulting\Notifications\Facades\Notifications;
use RoundlyConsulting\Notifications\NotificationPayload;

// AppServiceProvider::boot()
Notifications::define('comment.posted')
    ->category('comments')
    ->priority(Priority::Low)
    ->digestible()
    ->window('PT10M')
    ->subject(Post::class)
    ->title(fn (NotificationPayload $p): string => trans_choice('app.comment', $p->count, ['count' => $p->count]))
    ->url(fn (NotificationPayload $p): ?string => route('posts.show', $p->subjectKey))
    ->register();

use RoundlyConsulting\Notifications\Enums\Channel;
use RoundlyConsulting\Notifications\Enums\MailStrategy;

Notifications::define('report.ready')
    ->label('Report ready', 'When an export you requested has finished.')
    ->channels(Channel::Inbox, Channel::Mail)
    ->optIn(Channel::Mail)                                   // mail off until the user switches it on
    ->mailStrategy(MailStrategy::Trailing)
    ->window('PT15M')
    ->subject(Report::class, allowsTrashed: true)
    ->access(fn (User $recipient, ?Report $report): bool => $report?->owner_id === $recipient->id)
    ->context(fn (?Report $report) => $report?->workspace)
    ->sensitive(fn (?Report $report): bool => $report?->confidential === true)
    ->body(fn (NotificationPayload $p): ?string => __('app.report_ready_body'))
    ->mail(fn (MailMessage $message, NotificationPayload $p): MailMessage => $message->line(__('app.report_expiry')))
    ->register();

Notifications::register(RequestAwaitingApproval::class, SecurityAlert::class);   // class-strings
Notifications::registerType(app(RequestAwaitingApproval::class));                  // an instance

$type = Notifications::define('digest.preview')->title(fn () => 'Preview')->make(); // a DefinedType, not registered
Notifications::registerType($type);

// Anywhere a type key is accepted, a type class-string works too
Notifications::type(RequestAwaitingApproval::class)->about($request)->to($approvers)->send();

Notifications::types()->all();          // list<TypeDefinition>: key, category, label, description, channels,
                                        //   defaultChannels, mandatory, priority, digestible
Notifications::types()->categories();   // list<CategoryDefinition>: key + label
Notifications::types()->find($key);     // TypeDefinition
Notifications::types()->has($key);      // bool
Notifications::types()->get($key);      // the NotificationType itself

php artisan notifications:types   # Key, Category, Channels, Priority, Flags, Window, Reminder rules