README

Notifications for Symfony: one notify() call, an in-app inbox with a real-time badge, per-person preferences by category and channel, quiet hours and digests, mail / push / Slack channels and GDPR export and erasure.

🚧 Status: S0 scaffold, no release yet. The package is built slice by slice from its design contract (docs/CONTRACT.md, 221-B). 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)

One entry point, NotifierInterface::notify(): type, recipients (by id), actor, context, target, local URL, params, urgency, involved people; validated, written after your commit, fanned out per recipient and channel.
In-app inbox: one row per recipient (never the actor, only when the recipient may open the target), coalescing of repeats, read / unread / mark all, unread count, visibility re-checked at read time, retention.
Header bell and inbox page on UiKit + FormKit, with a real-time badge (Mercure private updates, or a bounded poll).
Preferences matrix per person × category × channel (only deviations stored), all / involved scope, master switch, per-context switches and overrides; the bell row is always written by default (Q-O2).
Quiet hours and digests for mail, push and Slack (time zone, weekdays, urgent bypass; hourly / daily digests).
Channels: built-in in_app; bridges for mail (Symfony Mailer + MailKit branding), push (PwaBundle) and Slack (SlackKit); your own channels through ChannelInterface.
Personal data: UserKit eraser and export for every bundle table, actor unlinking.
Optional public API <prefix>/notifications/v1 (off by default), authenticated by ApiTokenBundle.

Installation

composer require nowo-tech/notify-kit-bundle

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

Configuration

# config/packages/nowo_notify_kit.yaml
nowo_notify_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:8222 (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 / notify-kit-bundle

Package info

Security

Fund package maintenance!

Statistics