README

Description

IO provides Enso process-monitoring events, websocket channels, and status enums for long-running operations.

The package registers broadcast channels for per-user and superior-level operation streams, maps websocket topics for the frontend, and ships observers, events, contracts, and enums around IO operation tracking.

It is an infrastructure package for operational feedback rather than a CRUD module.

Installation

Install the package:

composer require laravel-enso/io

Features

• Broadcast channels for operations and operations.{userId}.
• Websocket topic registration for IO updates.
• IO operation event and observer classes.
• Status and type enums for monitored operations.

Usage

The package is intended to be consumed by other Enso modules that implement the IOOperation contract and broadcast progress updates over the registered websocket channels.

Superior users receive the shared operations channel, while regular users receive their own operations.{userId} channel.

API

There is no HTTP API.

Operational surface:

• broadcast channels operations and operations.{userId}
• websocket topic io
• LaravelEnso\\IO\\Contracts\\IOOperation

Depends On

Required Enso packages:

• laravel-enso/core ↗
• laravel-enso/enums ↗
• laravel-enso/helpers ↗
• laravel-enso/users ↗

Companion frontend package:

• @enso-ui/io ↗

Contributions

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

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