AurorisNet.InteractiveReports.Client.FileDownload
1.0.0
See the version list below for details.
dotnet add package AurorisNet.InteractiveReports.Client.FileDownload --version 1.0.0
NuGet\Install-Package AurorisNet.InteractiveReports.Client.FileDownload -Version 1.0.0
<PackageReference Include="AurorisNet.InteractiveReports.Client.FileDownload" Version="1.0.0" />
<PackageVersion Include="AurorisNet.InteractiveReports.Client.FileDownload" Version="1.0.0" />
<PackageReference Include="AurorisNet.InteractiveReports.Client.FileDownload" />
paket add AurorisNet.InteractiveReports.Client.FileDownload --version 1.0.0
#r "nuget: AurorisNet.InteractiveReports.Client.FileDownload, 1.0.0"
#:package AurorisNet.InteractiveReports.Client.FileDownload@1.0.0
#addin nuget:?package=AurorisNet.InteractiveReports.Client.FileDownload&version=1.0.0
#tool nuget:?package=AurorisNet.InteractiveReports.Client.FileDownload&version=1.0.0
<h1 align="center">Interactive Reports</h1>
<p align="center"> Oracle APEX-style interactive reports for ASP.NET Core.<br> A developer writes one <code>SELECT</code>; users get a report they can search, filter, sort, break, compute, highlight, group, pivot, chart, save, and download. </p>
<p align="center"> <a href="LICENSE"><img alt="MIT license" src="docs/images/badge-license.svg"></a> <img alt=".NET 8" src="docs/images/badge-dotnet.svg"> <img alt=".NET 10" src="docs/images/badge-dotnet-10.svg"> <img alt="Windows supported" src="docs/images/badge-windows.svg"> <img alt="Linux supported" src="docs/images/badge-linux.svg"> <img alt="Databases" src="docs/images/badge-databases.svg"> <a href="https://interactive-report.pages.dev/"><img alt="Live Demo" src="docs/images/badge-demo.svg"></a> </p>
<p align="center"> <strong><a href="https://interactive-report.pages.dev/">🚀 Try the Interactive Demo</a></strong> </p>
What it is
A report is a piece of configuration: a name, a data source, and a SELECT. From
that one statement the server discovers the columns and the browser element gives
users a workspace over the result. Everything a user does becomes a
JSON report state document that the server validates and compiles into
parameterized SQL, pushed down to the database. Nothing the user types ever reaches
the database as SQL text.
- Search, filter, sort, and page with a typed expression language that is the same on every supported database.
- Shape the data: control breaks with subtotals, aggregates, computed columns, row and cell highlights, Group By, Pivot, and charts.
- Save and share layouts as private or published saved reports, or ship them as source-controlled JSON files beside the application.
- Download the current view as CSV or self-contained HTML, with every matching row and the user's formatting. Both formats work with the .NET server and the browser demo.
- Secure by construction: the developer owns the SQL and the trusted context parameters; users own state, and state is always data. Report and saved-report access run through the host's own ASP.NET Core identity and authorization.
- No front-end build. The UI is a self-contained custom element embedded in the NuGet package, with ready-made viewer and administration pages, English and Canadian French, and built-in help.
- SQL Server, PostgreSQL, Oracle, and SQLite all enjoy first class support.
Quick start
For a runnable application with one report and an explicit SQLite dependency, see the minimal sample.
The Windows Authentication sample adds Windows identity, administration, and application authorization hooks.
Install the browser package (which includes the server and core dependencies):
dotnet add package AurorisNet.InteractiveReports
Configure a report in appsettings.json:
"InteractiveReport": {
"Reports": {
"orders": {
"dataSource": "MainDb",
"sql": "SELECT ORDER_ID, CUSTOMER, AMOUNT, ORDER_DATE FROM ORDERS",
"authorization": { "allowAnonymous": true }
}
}
}
Register services and map endpoints in Program.cs:
builder.Services.AddInteractiveReports(builder.Configuration);
builder.Services.AddInteractiveReportJson();
// …
app.MapInteractiveReportJson("/api/reports");
Browse to /api/reports/orders/view, or drop the element into any page:
<script type="module" src="/api/reports/ui/ir.js"></script>
<interactive-report report="orders"></interactive-report>
The Getting started guide continues from here with data-source choices, persistence, authorization, and the next integration steps.
Internet-facing deployment is technically supported, but it is not the recommended topology. Prefer an internal or otherwise trusted network. If the application must be exposed publicly, point reports at a dedicated reporting database or read replica through a least-privileged, read-only principal. Do not run interactive reporting workloads against the primary production database.
Documentation
| Guide | Read it for |
|---|---|
| Getting started | A first working report, data-source choices, persistence setup, and the next integration steps. |
| User Guide | The end-user manual for the report UI. It is also the built-in help behind the toolbar's ? button. |
| Saved reports | Persistence, document visibility and defaults, source-controlled documents, import/export, and administration. |
| Embedding the report | The custom element, host JavaScript API, events, client controls, theming, stylesheets, renderers, edit links, and create buttons. |
| Integration API | Server registration, authorization hooks, trusted context, in-process execution and export, REST routes, and element reference tables. |
| Authorization | The action and resource model, row restrictions with {{RowRestriction}}, the three integration styles, administrator resolution, and denial behaviour. |
| GraphQL adapter | The optional query-only transport for saved reports. |
| Architecture | System boundaries, package structure, report planning and execution, database integration, authorization, persistence, and browser responsibilities. |
| Developing | Building the client, running the test layers, packing, and regenerating documentation screenshots. |
| Testing | The everyday suite, browser automation, and live-dialect verification. |
Developing
npm ci
npx playwright install chromium # on Linux, use: npx playwright install --with-deps chromium
npm run build && npm run start # build everything, then launch Workbench
npm run build:demo # standalone in-browser demo for Cloudflare Pages
npm run start:demo # serve the in-browser demo locally (fetches the serve package on first use)
The developer prerequisites are Node.js 20 or later, the .NET 10 SDK, and Playwright's
Chromium browser. Normal development is supported on Windows and Linux; creating NuGet
and release artifacts is a Windows workflow. The Workbench at http://localhost:5042
hosts every packaged page against a seeded SQLite database. npm test runs the unit,
SQLite browser-server, and documentation tests, and npm run test:all adds the Playwright suite; dotnet test
covers the server. See Developing.
Maintainers can run Actions → Release NuGet packages → Run workflow to build and test all five packages and publish a GitHub Release with packages, symbols, and checksums. Publishing to nuget.org is an optional workflow input; see Publishing a release for setup.
License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. 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. |
-
net8.0
- AurorisNet.InteractiveReports.AspNetCore (>= 1.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on AurorisNet.InteractiveReports.Client.FileDownload:
| Package | Downloads |
|---|---|
|
AurorisNet.Umbraco.AppBlocks.InteractiveReports
Optional Interactive Reports companion for AppBlocks on Umbraco. Requires AppBlocks. |
GitHub repositories
This package is not used by any popular GitHub repositories.