README

Admin-managed backend notifications for Neos CMS editors.

Features

• Admin module at /neos/management/notifications for creating and managing notifications
• Markdown editor with toolbar (bold, italic, lists, links, images) and live preview
• Image uploads stored as Flow persistent resources
• Scheduling with optional show-from and show-until date/time windows
• Lifecycle management — draft → published → archived, with publish/unpublish/archive actions
• Per-user read state — tracks seen, dismissed, and removed state per editor
• Content module plugin — bell icon badge with unread count, slide-out notification panel with accordion layout
• Mark all read — editors can mark all notifications as read at once
• Security — role-based access: admins manage notifications and upload images, editors can only read/dismiss
• i18n — Dutch and English translations

Requirements

• Neos CMS 8.x or 9.x
• PHP 8.1+
• league/commonmark ^2.0 (installed via Composer)

Installation

composer require upassist/neos-editornotifications
./flow doctrine:migrate

Configuration

The package registers itself automatically via Settings.yaml. No additional configuration needed.

• Backend module: appears under Management → Notifications
• Content module plugin: bell icon loads automatically for all editors
• Policies: Administrators get full access; Editors can view, mark as read, and dismiss

Architecture

Classes/
├── Api/Controller/NotificationApiController.php     # JSON API (active, unreadCount, markSeen, markAllSeen, markUnseen, dismiss, removeForCurrentUser, uploadImage)
├── Controller/Backend/Module/
│   └── NotificationModuleController.php             # Admin CRUD + publish/unpublish/archive
├── Domain/
│   ├── Model/Notification.php                       # Title, contentMarkdown, content (HTML), scheduling, lifecycle
│   ├── Model/NotificationReadState.php              # Per-user seen/dismissed/removed tracking
│   └── Repository/                                  # Query builders with filter and pagination support
└── Service/NotificationService.php                  # Business logic, markdown rendering, read state

Resources/
├── Private/
│   ├── Fusion/Backend/                              # Index (list + filters + pagination) and Form (editor + preview)
│   └── Translations/                                # Dutch (nl) and English (en) XLIFF
└── Public/
    ├── JavaScript/Module/Module.js                  # Markdown editor with toolbar and image upload
    ├── JavaScript/NotificationPlugin/Plugin.js      # Content module badge and slide-out panel
    └── Styles/Module.css                            # Admin module dark theme styling

Notification lifecycle

Active notifications cannot be deleted directly — archive them first. Drafts, archived, expired, and scheduled notifications can be deleted.

API endpoints

All API routes are prefixed with /neos/notifications/api/.

Security

License

MIT