Aelena.FileApi.Core 0.3.1

Aelena.FileApi.Core

Pure document processing for .NET — DOCX, images, email, hashing, PII detection, readability, text analysis and ZIP inspection.

No ASP.NET dependencies and no copyleft dependencies, so it works equally well in a console app, a desktop app, an Azure Function, or behind an HTTP or gRPC host. Every operation is a static method taking byte[] and returning an immutable record — no streams to manage, no IFormFile, no shared mutable state.

MIT licensed. Nothing in this package's dependency graph is copyleft.

📖 Full documentation, examples and the complete endpoint list are in the repository README.

Install

dotnet add package Aelena.FileApi.Core

Targets net10.0 and net11.0.

What it does

Example

using Aelena.FileApi.Core.Services.Common;

var bytes = await File.ReadAllBytesAsync("contract.docx");

// Content fingerprints
var hashes = HashService.ComputeHash(bytes, "contract.docx");
Console.WriteLine(hashes.Sha256);

// Personal data, with position and surrounding context
var pii = PiiService.Detect(text, "contract.docx");
foreach (var match in pii.Matches)
    Console.WriteLine($"{match.PiiType}: {match.Value} at {match.Start}");

// Readability
var score = ReadabilityService.Analyse(text, "contract.docx", language: "en");
Console.WriteLine($"Flesch {score.FleschReadingEase:F1} — {score.Interpretation}");

Expected failures — an unsupported format, an out-of-range page, a malformed regex — throw FileApiException, which carries an HTTP status code and a message written for the caller rather than the maintainer. Caller-supplied regular expressions run with a match timeout.

PDF is a separate package, deliberately

PDF operations live in Aelena.FileApi.Core.Pdf, which is AGPL-3.0-or-later because it is built on iText 7.

That separation is the reason this package can be MIT: it has no reference to iText, direct or transitive. CI asserts it on every push by inspecting both the declared dependencies and the files inside the packed .nupkg, so the boundary cannot quietly erode. Add the PDF package only if you have read the AGPL and accept it, or hold a commercial iText licence.

The three packages

Aelena.FileApi.Core          MIT, no iText anywhere in its graph
        ▲
        │ depends on
        │
Aelena.FileApi.Core.Pdf      AGPL — adds iText 7, and only this package does

Core.Pdf depends on Core, never the reverse: installing the PDF package gives you the whole toolkit, while installing Core alone keeps every copyleft dependency out of your build. The CLI is a tool package, so it bundles its dependencies rather than declaring them — its empty dependency list does not mean iText is absent from it.

Note on ImageSharp

Imaging goes through SixLabors.ImageSharp, which is under the Six Labors Split License: free for open-source and for organisations below a revenue threshold, commercial licence above it. Not copyleft, but worth knowing where you stand.

More

• 📖 Repository and full documentation
• ⚖️ Licensing explained in detail
• 📝 Changelog
• 🐛 Issues