Shaunebu.Bussiness.ReportGenerator 1.0.1

Shaunebu.Bussiness.ReportGenerator 🧩📊

Enterprise-Grade Modular Reporting SDK for .NET

✨ Overview

Shaunebu.Bussiness.ReportGenerator is a complete report generation framework that transforms raw data into PDF, HTML, Excel, Word, or Markdown outputs using a flexible, plugin-based pipeline.

DataSource → TemplateEngine → Renderer → Exporter → Catalog → Telemetry → Scheduler

It supports: ✔ Background generation
✔ Multi-tenant isolation
✔ Cloud exporters
✔ HTML/PDF rendering
✔ Distributed automation (Cron)
✔ Auditing & telemetry events
✔ Masking for sensitive data
✔ Plug-in EVERYTHING

This is a turn-key enterprise reporting platform for .NET.

🧠 Architecture Overview

┌───────────────────────────────────────────────────────────────┐
│                      ReportPipeline                           │
├───────────────┬──────────────────┬────────────────────────────┤
│  DataSource   │ TemplateEngine   │          Renderer          │
│  (memory,     │ (token, simple)  │ (pdf, html, excel, word,   │
│   sql, rest…) │                  │  markdown)                 │
├───────────────┴──────────────────┴────────────────────────────┤
│                          Exporter                             │
│ (file, azureblob, s3, email, sendgrid, google drive, rest…)   │
├───────────────────────────────────────────────────────────────┤
│                     Security & Telemetry                      │
│    Masking | Audit | Digital Signature | AppInsights Hooks    │
├───────────────────────────────────────────────────────────────┤
│                          Catalog                              │
│         Query | History | Retention | Multi-tenant            │
├───────────────────────────────────────────────────────────────┤
│                         Scheduler                             │
│             Cron-based automation with triggers               │
└───────────────────────────────────────────────────────────────┘

Every stage is replaceable, extensible, and DI-driven.

🚀 Installation

dotnet add package Shaunebu.Bussiness.ReportGenerator

Optional data source modules:

dotnet add package Shaunebu.Bussiness.ReportGenerator.Data.GraphQL
dotnet add package Shaunebu.Bussiness.ReportGenerator.Data.Rest
dotnet add package Shaunebu.Bussiness.ReportGenerator.Data.Sql

Optional renderer modules:

dotnet add package Shaunebu.Bussiness.ReportGenerator.Renderers.Pdf
dotnet add package Shaunebu.Bussiness.ReportGenerator.Renderers.Html
dotnet add package Shaunebu.Bussiness.ReportGenerator.Renderers.Excel
dotnet add package Shaunebu.Bussiness.ReportGenerator.Renderers.Word
dotnet add package Shaunebu.Bussiness.ReportGenerator.Renderers.Markdown

Optional exporter modules:

dotnet add package Shaunebu.Bussiness.ReportGenerator.Exporters.AwsS3
dotnet add package Shaunebu.Bussiness.ReportGenerator.Exporters.AzureBlob
dotnet add package Shaunebu.Bussiness.ReportGenerator.Exporters.Email
dotnet add package Shaunebu.Bussiness.ReportGenerator.Exporters.GoogleDrive
dotnet add package Shaunebu.Bussiness.ReportGenerator.Exporters.Rest
dotnet add package Shaunebu.Bussiness.ReportGenerator.Exporters.SendGrid

Optional scheduler module:

dotnet add package Shaunebu.Bussiness.ReportGenerator.Scheduler

🧩 Plugin System

Everything in this library is a plugin: ✔ DataSource
✔ TemplateEngine
✔ Renderer
✔ Exporter
✔ AuditSink
✔ TelemetrySink
✔ PDF signer
✔ Catalog provider

All plugins are auto-discovered via PluginManager.

🧱 Data Sources

The library ships with all major data acquisition methods:

You can implement your own easily:

public class MyCustomDataSource : IDataSource { ... }

🎨 Template Engines (implemented)

Your library currently includes:

Razor / Liquid / Handlebars are not included by default — but fully extendable.

🖨️ Renderers Included

📤 Exporters Included

Every exporter is production-ready:

Composite exporter is not included.

🔒 Security Layer

1. Data Masking

Powered by Shaunebu.Security.DataMasking
Automatically masks sensitive fields using:

• [Mask] attributes

• Custom rules

• Recursive object parsing

• Complex nested models

• Protected collections and dictionaries

2. Audit Logging

Each execution logs:

• Tenant

• Renderer

• Exporter

• Template engine

• Duration

• Status (success/failure)

• Error (if any)

3. PDF Signing

Optional, lightweight explanation: ✔ Uses .pfx certificate
✔ Signs PDF bytes in-memory
✔ Adds digital signature
✔ Tamper-evident seal

📈 Telemetry

Telemetry integrates with: ✔ ILogger
✔ Custom sinks
✔ Application Insights (via AddReportGeneratorTelemetry) Telemetry events:

Each event includes:

• TraceId

• TenantId

• DataSource / Renderer / Exporter

• DurationMs

• Status

• Exception (if any)

📚 Report Catalog

A built-in historical registry for reports.

Supported operations

Multi-tenant supported

Every record includes:

• TenantId

• Report name

• Status

• Output path or filename

• Timing

• Metadata dictionary

⏰ Scheduler (Cron Automation)

Built with Shaunebu.Common.Scheduler. ✔ Create scheduled jobs
✔ Cron expressions
✔ Manual triggering
✔ Telemetry-aware
✔ Tenant-aware
✔ Stored by reportId

Example

await scheduler.ScheduleReportAsync("DailySales", "0 9 * * *");
await scheduler.TriggerNowAsync("DailySales");

🧪 Full Demo (with masking, telemetry, scheduling)

The library includes a complete diagnostic dashboard script that tests: ✔ Plugin registration
✔ Rendering (PDF)
✔ Masking
✔ Telemetry
✔ Scheduler
✔ Catalog
✔ Exporting Result:

🎉 ALL TESTS PASSED SUCCESSFULLY!

🧠 Fluent Builder API

This is the primary developer experience.

Example

var result = await factory.Create()
    .WithName("InvoiceReport")
    .WithTenant("tenant-123")
    .WithMeta("requestId", Guid.NewGuid())
    .FromMemory(model)
    .WithTemplateString(template)
    .ToPdf("output.pdf")
    .WithTelemetry()
    .WithSecurityMasking()
    .ExportAsync();

Builder Methods

Core

• Create()

• WithName(string)

• WithTenant(string)

• WithMeta(string, object)

• FromMemory(object)

• FromSql(query)

• FromRest(...)

• WithTemplateString(string)

• WithTemplateFile(path)

Rendering

• ToPdf("file.pdf")

• ToHtml("file.html")

• ToExcel("file.xlsx")

• ToWord("file.docx")

• ToMarkdown("file.md")

Security & Telemetry

• WithTelemetry()

• WithSecurityMasking()

Execute

• ExportAsync()

🔧 appsettings.json Example

{
  "ReportGenerator": {
    "Definitions": {
      "SalesReport": {
        "DataSource": "memory",
        "Renderer": "pdf",
        "Exporter": "file",
        "TemplateString": "<h1>${Customer}</h1>",
        "FileName": "SalesReport.pdf",
        "Parameters": {
          "Customer": "Fabrikam"
        }
      }
    }
  }
}

🧠 Internals (Deep Dive)

Pipeline Steps

1. Fetch data from IDataSource

2. Apply masking (optional)

3. Select template engine

4. Render template → HTML

5. Render output format

6. Sign PDF (optional)

7. Export to target

8. Store in catalog

9. Trigger telemetry sinks

10. Audit logging

11. Return RenderResult

RenderResult includes

• Bytes

• FilePath

• FileName

• MimeType

• Metadata

📊 Use Cases

Enterprise

• Monthly billing

• Multi-tenant invoices

• Tax reports

• Financial exports

• HR letters

• PDF confirmations

SAAS Platforms

• On-demand reports

• Admin dashboards

• Export user data

• Email-based delivery

API Backends

• Generate reports via REST

• Background jobs

MAUI Apps

• Client-side previews

• Portable file generation

🪄 Extending the System

Create a new DataSource

public class MySource : IDataSource { ... }

Add a new exporter

public class SlackExporter : IReportExporter { ... }

Custom telemetry sink

public class MyTelemetrySink : IReportTelemetrySink { ... }

Add as DI extension

services.AddSlackExporter();

🧠 References

• QuestPDF Documentation

• ClosedXML Docs

• RazorLight Engine

• OpenXML SDK Docs