Vorn.Entities.Server 9.1.2

Vorn.Entities.Server

This package adapts the core entity management abstractions to SignalR. It ships a typed hub base, EF Core configuration helpers, and notification relays so real-time clients see the same CRUD surface as REST consumers.

Install

dotnet add package Vorn.Entities.Server

Add Vorn.Entities for the core entities and Vorn.Entities.SignalR.Client if you plan to build clients.

Register services

builder.Services.AddSignalR();
builder.Services.AddVornEntityManagement();      // generated or manual registration of handlers/caches
builder.Services.AddSingleton<IEntityUserService, HttpContextEntityUserService>();
builder.Services.AddSingleton<IEntityTimeService, EntityTimeService>();
builder.Services.AddTransient<INotificationHandler<EntityNotificationCore>, EntityNotificationHandler>();

EntityNotificationHandler listens for persistence notifications and relays them to every connected client through the hub.

Configure EF Core

public sealed class AppDbContext(DbContextOptions<AppDbContext> options)
    : DbContext(options)
{
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        modelBuilder
            .ConfigureEntityDateTimeOffsetConversions()
            .ConfigureEntitySoftDeleteFilters();
    }
}

The extensions align your schema with the expectations of the Entity base type (UTC timestamps, soft deletes).

Create a hub

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

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

The base class exposes every CRUD method (AddAsync, UpdateAsync, GetListAsync, RemoveByIdAsync, paging, counts, etc.) and forwards caller context through IEntityUserService.

Emit notifications from elsewhere

Inject IHubContext<DocumentHub> (or the generic base) when background jobs need to notify clients:

public sealed class DocumentNotificationPublisher(IHubContext<DocumentHub> hub)
{
    public Task PublishAsync(DocumentDto dto)
        => hub.Clients.All.SendAsync(EntityServerMethods.EntityChanged, dto);
}

The constant EntityServerMethods.EntityChanged matches what the client base subscribes to.

Tips

• Override hub methods if you need additional validation or want to extend the contract—call await base.AddAsync(...) to keep the default behavior.
• Group hubs per aggregate and use SignalR groups to scope notifications to tenants or contexts.
• Pair with the client package to get automatic reconnection, error handling, and notification processing on the UI.