Paperwork.Core.Extensions 1.0.1

Paperwork.Core.Extensions

Shared portal configuration, $assets/$maps remote-file resolution, and cross-platform auth handlers for Paperwork.Core consumers. Split out of the private Paperwork Designer/Viewer solution so the Paperwork.CLI and the Designer/Viewer web apps share one implementation instead of hand-ported, drifting copies.

For full documentation see Paperwork.help.

Installation

dotnet add package Paperwork.Core.Extensions

Requires Paperwork.Core (pulled in automatically as a dependency).

What's in here

PaperworkConfig

A portal's runtime configuration — asset storage root, map provider endpoints, domain allow/block lists. Populate it once (per session for a long-lived app, per invocation for a one-shot CLI) before generating:

using Paperwork;

PaperworkConfig.SetCurrent(new PaperworkConfig
{
    Endpoints = [
        new PaperworkEndpoint { Key = "asset.storageRoot", Url = "https://firebasestorage.googleapis.com/v0/b/your-bucket/o/" },
    ],
});

Path mapping fix

Scryber's default path mapping silently prepends a base path (e.g. the process's working directory, for a console app) onto any reference that isn't already an absolute URI — including Paperwork's own "$assets/..." and "$maps/..." synthetic paths, which then never match the resolvers below. Call this once at startup, before generating anything:

PaperworkServiceProviderSetup.EnsureRegistered();

Asset and map resolution

Wire these into your PaperworkFactory via .WithFileRequests(...) to resolve $assets/... (Storage-relative images/fonts/files) and $maps/<Provider>/... (static map images, via a Cloud Function proxy) references embedded in template content or field values:

using Paperwork.Assets;
using Paperwork.Maps;
using Paperwork.Generation;

var fileRequests = new PaperworkMapFileRequestService(
    new PaperworkAssetFileRequestService(
        new EmptyFileRequestService(),
        assetAuthToken: firebaseIdTokenOrNull));  // null for public/unauthenticated fetches

var factory = PaperworkFactory.Create(httpClient)
    .WithFileRequests(fileRequests)
    .WithDefaultAuth()   // see below
    .Build();

Generation must use the async render path (builder.UseAsync() / BuildBytesAsync() on an async-configured builder) if any $assets/$maps/Source-type reference is present — the synchronous path doesn't wait on outstanding async remote file requests.

Auth handlers

WithDefaultAuth() (extension on PaperworkFactory) registers two browser-free IPaperworkAuthService implementations:

var factory = PaperworkFactory.Create(httpClient)
    .WithDefaultAuth()
    .Build();

A third handler, NoCors (routes around browser CORS restrictions via a proxy function), is not in this package — it only makes sense for a browser-hosted (Blazor WASM) consumer, which has its own equivalent extension.

What's not in here

• Anything genuinely browser/WASM-specific (a NoCors-style CORS proxy handler, for instance) — that stays in the consuming app.
• Per-environment configuration (which Firebase project's bucket/API keys to use) — that's specific to how each consumer resolves its own environments and isn't something this package can own.

License

MIT