Skip to content

Package and capability catalog ​

This is the canonical discovery contract for the repository. Every public package and template is listed here. Exact public types and members are generated in the API reference; configuration, endpoints and examples live in the linked module guides.

Composition entry points ​

CapabilityPrimary registrationContract documentation
Core ASP.NET foundationAddGrydCore, AddGrydApiVersioning, AddGrydSwaggerCore API
Authentication and tenant authorizationAddGrydAuth, AddGrydAuthTokenValidatorAuth getting started, HTTP reference
CRUDAddGrydCrud, AddGrydCrudQueryKitCRUD getting started, API reference
AuditingAddGrydAuditAudit getting started, configuration
Background jobsAddGrydJobsJobs getting started, configuration
ReportsAddGrydReportsReports getting started, API reference
NotificationsAddGrydNotificationsNotifications getting started, API reference
FilesAddGrydFilesFiles getting started, API reference
ObservabilityAddGrydObservability, AddGrydOpenTelemetryGenerated API reference

Core packages ​

PackageCapability
Gryd.CoreGuards, utility primitives and general extensions.
Gryd.DomainEntities, aggregate roots, value objects, events, audit and tenancy contracts.
Gryd.ApplicationCQRS, result/paging contracts, validation behaviors and application abstractions.
Gryd.InfrastructureEF repositories, unit of work, cache, event dispatch, tenancy and object storage.
Gryd.APIASP.NET controllers, error handling, localization, routing, tenancy, versioning and Swagger.
Gryd.ObservabilityLogging, audit, metrics and tracing abstractions plus MediatR behaviors.
Gryd.Observability.OpenTelemetryOpenTelemetry tracing, metrics, exporters and HTTP enrichers.

Authentication packages ​

PackageCapability
GrydAuth.DomainUsers, tenants, roles, MFA and federation domain model.
GrydAuth.ApplicationAuthentication, authorization, MFA, federation and tenant use cases.
GrydAuth.InfrastructureJWT, refresh/session storage, EF, Redis, external identity providers and secret protection.
GrydAuth.APIVersioned Auth/admin controllers, permission policies and HTTP contracts.

Configuration and lifecycle contracts: authentication, authorization, MFA, multi-tenancy, federation, security.

CRUD packages ​

PackageCapability
GrydCrud.CoreCRUD/query contracts, filters, pagination and operation options.
GrydCrud.ServicesService-based CRUD implementation.
GrydCrud.CqrsCQRS commands, queries and handlers.
GrydCrud.APIGeneric/controller HTTP integration.
GrydCrud.AutoMapperAutoMapper mapping adapter.
GrydCrud.FluentValidationFluentValidation adapter and registration.
GrydCrud.AuthPermission-aware CRUD integration.
GrydCrudConvenience meta-package composing the CRUD layers.

Audit and jobs packages ​

PackageCapability
GrydAudit.CoreAudit entities and contracts.
GrydAudit.ApplicationAudit queries and use cases.
GrydAudit.InfrastructureEF persistence and change interceptors.
GrydAudit.APIAudit HTTP endpoints and registration.
GrydAuditAudit meta-package.
GrydJobs.CoreJob definitions, schedules and provider contracts.
GrydJobs.ApplicationJob commands, queries and orchestration.
GrydJobs.InfrastructurePersistence, workers and Hangfire integration.
GrydJobs.APIDashboard, health checks and job endpoints.
GrydJobsJobs meta-package.

Reports packages ​

PackageCapability
GrydReports.CoreReport definitions, schedules, executions and provider contracts.
GrydReports.ApplicationGeneration, scheduling, delivery and query use cases.
GrydReports.InfrastructurePersistence, storage and report orchestration.
GrydReports.Infrastructure.QuestPdfPDF rendering adapter.
GrydReports.Infrastructure.CsvHelperCSV rendering adapter.
GrydReports.Infrastructure.ClosedXmlExcel rendering adapter.
GrydReports.Scheduling.GrydJobsScheduling integration with GrydJobs.
GrydReports.APIReport HTTP endpoints and health checks.
GrydReportsReports meta-package.

Notifications packages ​

PackageCapability
GrydNotifications.CoreNotification entities, channels, templates and options.
GrydNotifications.ApplicationSend, query and template use cases.
GrydNotifications.InfrastructurePersistence, SMTP, queues, workers and cleanup.
GrydNotifications.Infrastructure.SendGridSendGrid email adapter.
GrydNotifications.Infrastructure.FirebaseFirebase push adapter.
GrydNotifications.SchedulingNotification scheduling contracts and services.
GrydNotifications.APINotification HTTP endpoints, SignalR and health checks.
GrydNotificationsNotifications meta-package.

Files packages ​

PackageCapability
GrydFiles.CoreStored file entities, retention modes, configuration contracts and domain exceptions.
GrydFiles.ApplicationIFileService, the IFileScanner abstraction, profile resolution and startup validation.
GrydFiles.InfrastructureEF persistence, repositories and the five lifecycle jobs.
GrydFiles.Infrastructure.ClamAvClamAV scan provider, speaking INSTREAM to the clamd daemon.
GrydFiles.APIFile lifecycle HTTP endpoints.
GrydFilesFiles meta-package.

CLI templates ​

TemplatePurposeDefaults and options
gryd-minimalSmall API using the core packages and a selected database provider.Template options
gryd-apiComplete API with optional Auth, CRUD, Audit, Jobs, Reports, Notifications and Docker.Template options
gryd-moduleClean Architecture module/solution with optional API, tests and framework modules.Template options

Contract maintenance rule ​

Every new public package or template must be added here. A public type/member change must update XML documentation; a configuration, endpoint or behavior change must update its module guide and examples. scripts/check-doc-contracts.sh and the combined VitePress/DocFX build enforce discoverability and valid navigation in CI.

Released under the MIT License.