Honua.Sdk.ConsoleShare 1.13.1

Honua.Sdk.ConsoleShare

Browser-safe Console Share client and shared contracts for Honua Console hosts (Blazor Web and optional .NET MAUI Blazor Hybrid). Wraps the server Console Share access, public-link, and embed-token lifecycle surface so Console hosts consume server-owned share contracts without duplicating DTOs.

Install

Install directly when a host only needs Console Share access and link/embed controls.

Stable releases are on nuget.org and install anonymously. An unversioned add resolves to the newest stable release (the current SDK version is in the repo README). Prereleases stay on the authenticated GitHub Packages feed; see INSTALL.md.

dotnet add package Honua.Sdk.ConsoleShare

using Honua.Sdk.ConsoleShare.Extensions;

builder.Services.AddHonuaConsoleShare(o =>
{
    o.BaseAddress = new Uri("https://your-honua-server");
    o.BearerTokenProvider = tokenProvider.GetAccessTokenAsync;
});

Use IHonuaConsoleShareClient to read a share detail, update access, validate a dependency closure before a visibility change, and manage the public-link and embed-token lifecycle. Use IHonuaConsoleShareExportClient (register with AddHonuaConsoleShareExport) to manage scheduled Share export definitions and runs and to read Share traffic projections. Use IHonuaConsoleShareOpenDataClient (register with AddHonuaConsoleShareOpenData) to author open-data pages, evaluate open-data eligibility, preview DCAT/data.json exports, drive STAC publish/unpublish, and read the anonymous open-data, DCAT, Schema.org, and STAC projections. The share contracts live in Honua.Sdk.Abstractions (namespace Honua.Sdk.Abstractions.Console.Share) so browser and native hosts share one DTO set.

REST surface

The client targets the Console Share surface under /api/v1/console/shares.

IHonuaConsoleShareExportClient targets the Share export and traffic admin surface under /api/v1/admin/share.

IHonuaConsoleShareOpenDataClient targets the authenticated open-data publication surface under /api/v1/console/content/{id}/open-data and the anonymous open-data read surface under /api/v1/open-data.

The authenticated open-data endpoints and the anonymous dataset read return data inside the server's { "success", "data", ... } envelope; the client unwraps the data payload. The anonymous data.json, Schema.org, and STAC reads return standards-shaped documents directly.

GetShareAsync returns HonuaShareItemDetail (the share summary plus grants and any active public link / embed token) deserialized from the unwrapped server JSON. All request and response bodies resolve through a source-generated JSON context, so serialization is trimming/AOT-safe.

var detail = await share.GetShareAsync(shareId, cancellationToken);

if (detail.Item.Visibility != HonuaShareVisibility.Public)
{
    var closure = await share.ValidateDependencyClosureAsync(
        shareId,
        new HonuaShareAccessUpdate { Visibility = HonuaShareVisibility.Public },
        cancellationToken);

    if (closure.Valid)
    {
        await share.UpdateAccessAsync(
            shareId,
            new HonuaShareAccessUpdate { Visibility = HonuaShareVisibility.Public },
            cancellationToken);

        var link = await share.CreatePublicLinkAsync(
            shareId,
            new HonuaPublicLinkRequest { Enabled = true },
            cancellationToken);

        Console.WriteLine(link.Url);
    }
}

Errors

Non-success HTTP statuses throw HonuaConsoleShareApiException (preserving StatusCode, problem Title/Detail, and the raw ResponseBody) — including anonymous/forbidden states surfaced as 401/403 problem documents. Successful responses whose body does not satisfy the share contract throw HonuaConsoleShareContractException.

Scope

This package wraps the Console Share access, public-link, and embed-token lifecycle surface, the Share export-definition / export-run and Share-traffic admin surface, and the open-data / DCAT / STAC publication surface (authenticated page authoring, eligibility, DCAT preview, and STAC publish/unpublish, plus the anonymous open-data, DCAT, Schema.org, and STAC read projections).

Documentation

• Console client contracts
• Client behavior
• Browser / WASM support