README

Description

Notifications provides Enso API endpoints and broadcast channels for user notifications.

The package exposes listing, counting, read, read-all, delete, and delete-all endpoints on top of Laravel's database notifications, and registers a per-user broadcast channel based on the configured auth model.

It is intended to back the Enso notification dropdown and related realtime UI flows.

Installation

Install the package:

composer require laravel-enso/notifications

Run the package migrations:

php artisan migrate

Features

• Notification list and unread-count endpoints.
• Mark-one and mark-all-as-read endpoints.
• Delete-one and delete-all endpoints.
• Broadcast channel registration for user-specific notification streams.

Usage

Main route group:

• core.notifications.*

The broadcast channel is derived from the configured auth model namespace and ends with .{id}.

API

HTTP routes

• GET api/core/notifications
• DELETE api/core/notifications/destroyAll
• DELETE api/core/notifications/{notification}
• GET api/core/notifications/count
• PATCH api/core/notifications/read/{notification}
• POST api/core/notifications/readAll

Broadcast

• per-user notification channel for the configured auth provider model

Depends On

Required packages:

• laravel-enso/core ↗
• laravel-enso/migrator ↗
• pusher/pusher-php-server

Companion frontend package:

• @enso-ui/notifications ↗

Contributions

are welcome. Pull requests are great, but issues are good too.

Thank you to all the people who already contributed to Enso!