Purview.EventSourcing.Admin.Client 2.0.0-prerelease.34

Purview.EventSourcing.Admin.Client

Purview.EventSourcing.Admin.Client is a typed C# client for the Purview Event Sourcing Admin API, generated by NSwag from the committed OpenAPI document (OpenApi/admin.openapi.json). It exposes strongly-typed methods for every Admin API endpoint and is used by the Admin portal Razor UI (Purview.EventSourcing.Admin.Site) and samples.

Install

dotnet add package Purview.EventSourcing.Admin.Client

Register the client

builder.Services.AddAdminApiClient();

When AdminClientOptions.BaseUrl is not configured, the client sends relative request URIs so it can be pointed at the Admin API's origin by the hosting application:

builder.Services.AddAdminApiClient(options =>
{
    options.BaseUrl = new Uri("https://admin.example.com");
    options.AccessToken = "optional-bearer-token";
});

AddAdminApiClient registers AdminApiClient as a typed HttpClient through IHttpClientFactory. The optional configureClient hook lets callers add delegating handlers (for example to resolve a same-origin base URL from the current HTTP request).

The generated client targets the Admin API route prefix from the OpenAPI document (by default /admin/api).

Usage

var client = serviceProvider.GetRequiredService<AdminApiClient>();

var aggregates = await client.SearchAggregatesAsync(
    new AggregateSearchRequest { AggregateType = "OrderAggregate", PageSize = 25 },
    cancellationToken
);

var events = await client.GetAggregateEventRangeAsync(
    "OrderAggregate",
    aggregateId,
    pageSize: 25,
    cancellationToken: cancellationToken
);

var export = await client.ExportAggregateEventsAsync("OrderAggregate", aggregateId);

Methods:

• SearchAggregatesAsync(AggregateSearchRequest body)
• GetAggregateAsync(string aggregateType, string aggregateId)
• GetAggregateEventRangeAsync(string aggregateType, string aggregateId, ...)
• GetAggregateProjectionAtVersionAsync(string aggregateType, string aggregateId, long? version)
• GetAggregateProjectionAtTimeAsync(string aggregateType, string aggregateId, DateTimeOffset? asOfUtc)
• ExportAggregateEventsAsync(string aggregateType, string aggregateId, ...) returning a FileResponse over the JSON Lines stream

Non-success responses throw AdminApiException.

Regenerating the client

The client is generated from the Admin API OpenAPI document. After changing the Admin API contracts or endpoints:

just admin-openapi-export   # regenerate OpenApi/admin.openapi.json
just admin-client-generate  # regenerate Generated/AdminApiClient.g.cs via NSwag

Both the OpenAPI document and the generated client are committed, so consumers get a deterministic, reviewable client.

Notes

• Uses System.Text.Json (no Newtonsoft dependency).
• The JsonElement DTO carries raw event/projection JSON in its AdditionalProperties dictionary.
• When BaseUrl is left unset, the hosting application must resolve the origin (for example Purview.EventSourcing.Admin.Site does this via a delegating handler that reads the current HTTP request).

Documentation

• Homepage
• Documentation

Related packages

• Admin API: Purview.EventSourcing.Admin.Api
• Admin site: Purview.EventSourcing.Admin.Site