Vorn.EntityManagement.SignalR.Server 4.6.0

Vorn.EntityManagement.SignalR.Server

Philosophy

The SignalR server package extends Vorn.EntityManagement into the real-time domain. Rather than duplicating CRUD logic for hub endpoints, the server hub delegates to your existing IEntityService implementation so every entity mutation flows through the same MediatR pipeline. This keeps server push notifications consistent with the rest of your application and lets behaviors such as caching, audit logging, and validation remain centralized.

Key ideas that shape the server library:

• Reuse application services – EntityServer<TDto, TDescriptorDto, TEntityService> exposes hub methods that forward to the injected entity service so that your existing command/query handlers stay authoritative.
• Ambient context – Clients can call SetInterceptionConfig to push user/time metadata into IEntityUserService and IEntityTimeService, ensuring downstream handlers know who triggered the change.
• Symmetry with the client – The exported hub methods mirror those used by the client package, keeping bidirectional contracts straightforward.

Getting started

1. Install the package

Install-Package Vorn.EntityManagement.SignalR.Server

2. Register dependencies

builder.Services.AddSingleton<IEntityUserService, HttpContextEntityUserService>();
builder.Services.AddSingleton<IEntityTimeService, EntityTimeService>();
builder.Services.AddSingleton<DocumentService>();

Ensure your service derives from IEntityService<TDto, TDescriptorDto> (for instance, by inheriting from EntityService<TEntity, TDescriptor, TDto, TDescriptorDto> in the core package).

3. Add the hub to your ASP.NET Core app

builder.Services.AddSignalR();
app.MapHub<DocumentHub>("/hubs/documents");

public sealed class DocumentHub(DocumentService service)
    : EntityServer<DocumentDto, DocumentDescriptorDto, DocumentService>(service)
{ }

4. Enrich telemetry and security

Client calls to SetInterceptionConfig populate context providers so MediatR behaviors can stamp auditing metadata or enforce permissions before the handler runs.

5. Notify clients

Because the hub delegates to your entity service, any notifications you publish from your handlers (for example via IHubContext<EntityServer<...>>) stay consistent across REST and SignalR flows.

Usage tips

• Pair the server package with the Vorn.EntityManagement.SignalR.Client package to get a prebuilt client that speaks the same hub contract.
• Apply standard SignalR features like groups, authentication, and authorization policies directly in your derived hub.
• Override hub methods if you need additional validation before forwarding to the entity service; call base.AddAsync(dto) to reuse the default behavior.

Release artifacts

The README ships with the NuGet package so consumers on NuGet.org understand the philosophy and usage pattern without cloning the repository.