PouryaKit.Reporting.Module 0.1.0-preview.2

This is a prerelease version of PouryaKit.Reporting.Module.

dotnet add package PouryaKit.Reporting.Module --version 0.1.0-preview.2

NuGet\Install-Package PouryaKit.Reporting.Module -Version 0.1.0-preview.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="PouryaKit.Reporting.Module" Version="0.1.0-preview.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="PouryaKit.Reporting.Module" Version="0.1.0-preview.2" />
                    

                            Directory.Packages.props

<PackageReference Include="PouryaKit.Reporting.Module" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add PouryaKit.Reporting.Module --version 0.1.0-preview.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: PouryaKit.Reporting.Module, 0.1.0-preview.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package PouryaKit.Reporting.Module@0.1.0-preview.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=PouryaKit.Reporting.Module&version=0.1.0-preview.2&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=PouryaKit.Reporting.Module&version=0.1.0-preview.2&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

PouryaKit.Reporting.Module

The Kit's report Module, a Module shipped as a package. A Host adds it once beside its own Modules. An Actor requests a report job over HTTP, and the Module stores the job in its own schema, generates the file in the background, stores it in the Host's one file storage provider, and serves the job's state and a time-limited download link to its requester. A recurring retention removes expired jobs and their files.

Install

dotnet add package PouryaKit.Reporting.Module --prerelease

When to use it

An Actor requests a report that takes a while to build, and downloads it when it is ready.
You add report kinds to a Host by implementing the two ports.
You need to know what a stale claim, a late settlement, another Actor or tenant, or the retention does to a job.

It renders with PouryaKit.Reporting and stores through PouryaKit.Storage, so the Host composes one provider, such as PouryaKit.Storage.S3.

Quick start

Add the Module to the Host and implement its two ports, as the Proving Sample does. The Host also registers an IActorPermissions of PouryaKit.Security and one file storage provider, or its build fails:

modules.Add<ReportModule>();
builder.Services.AddSingleton<IReportRequestAuthorizer, SalesReports>();
builder.Services.AddSingleton<IReportLayouts, SalesReports>();

The first port decides who may request a kind, with which parameters:

public Task<bool> MayRequestAsync(
    OperationContext context,
    ReportRequest request,
    CancellationToken cancellationToken
)
{
    return Task.FromResult(
        context.Actor.Kind == ActorKind.Person
            && context.Tenant is not null
            && request.Kind == Kind
            && MonthOf(request) is not null
    );
}

What you get

A job stored with its requester and tenant.
Generation by attempts that each claim the job, so a stale claim can be taken over.
A job served within its tenant to its requester, or an Actor the Host grants the tenant's jobs.
A retention that removes expired jobs and their files.

The Module stores over one fixed connection string name and cannot be told another, since a Composition Root takes no parameters. Give the Host's database that name and keep the message store on the same database (Composing it).

The file is rendered in memory inside the attempt's Unit of Work, so keep a kind to what fits there.

Learn more

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- PouryaKit.Messaging.Wolverine.EFCore (>= 0.1.0-preview.2)
- PouryaKit.Modularity (>= 0.1.0-preview.2)
- PouryaKit.Persistence.Dapper (>= 0.1.0-preview.2)
- PouryaKit.Persistence.Postgres (>= 0.1.0-preview.2)
- PouryaKit.Reporting (>= 0.1.0-preview.2)
- PouryaKit.Security (>= 0.1.0-preview.2)
- PouryaKit.Storage (>= 0.1.0-preview.2)
- PouryaKit.Validation (>= 0.1.0-preview.2)
- PouryaKit.Web (>= 0.1.0-preview.2)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
0.1.0-preview.2	71	11/1/2026
0.1.0-preview.1	71	10/31/2026
0.1.0-preview.0.28	73	10/26/2026

PouryaKit.Reporting.Module 0.1.0-preview.2