Noayo.Domain 0.0.1

Noayo

Noayo (from French noyau, "core" or "kernel") is a family of lightweight .NET class libraries that provide foundational building blocks for domain modelling and infrastructure wiring in line-of-business applications.

Packages

Install

dotnet add package Noayo.Domain

Target Frameworks: net8.0, net9.0

Quick Start

Define an entity

using Noayo.Domain.Auditing;
using Noayo.Domain.Entities;
using Noayo.Domain.SoftDeletion;

public class Customer
    : IEntity<Guid>, IAuditable, IAuditable<Guid>, ITimeStamped, ISoftDeletable<Guid>
{
    public Guid Id { get; set; }

    // IAuditable — display names
    public string? CreatedBy { get; set; }
    public string? UpdatedBy { get; set; }

    // IAuditable<Guid> — typed FK
    public Guid? CreatedByUserId { get; set; }
    public Guid? UpdatedByUserId { get; set; }

    // ITimeStamped
    public DateTime CreatedAt { get; set; }
    public DateTime? UpdatedAt { get; set; }

    // ISoftDeletable<Guid>
    public bool IsDeleted { get; set; }
    public DateTime? DeletedAt { get; set; }
    public string? DeletedBy { get; set; }
    public Guid? DeletedByUserId { get; set; }

    // Domain properties
    public string Name { get; set; } = string.Empty;
}

Return a paged result

using Noayo.Domain.Paging;

PagedResult<Customer> result = new(
    items: customers,
    pageNumber: 1,
    pageSize: 20,
    totalCount: 150);

Console.WriteLine($"Page {result.PageNumber} of {result.TotalPages}");
Console.WriteLine($"Has next page: {result.HasNextPage}");

Attribute-based opt-in

using Noayo.Domain.Attributes;

[Audited]
[SoftDeleted]
public class CreateCustomerCommand { /* … */ }

Infrastructure code (e.g. an EF Core SaveChangesInterceptor) can use [Audited] as a convention-based alternative to implementing IAuditable + ITimeStamped, and [SoftDeleted] as an alternative to ISoftDeletable.

IAuditContext seam

IAuditContext is the dependency-free contract between the request pipeline and the persistence layer:

// Request pipeline (e.g. FastEndpoints middleware) sets the flags:
auditContext.AuditEnabled = true;
auditContext.SoftDeleteEnabled = true;

// Persistence interceptor reads them during SaveChanges.

Register AuditContext as scoped in your DI container:

services.AddScoped<IAuditContext, AuditContext>();

Companion Packages (Planned)

Behavior implied by the interfaces is wired up in separate packages, each depending only on Noayo.Domain plus the one framework it integrates with:

• Noayo.Domain.EntityFrameworkCore — AuditSaveChangesInterceptor, SoftDeleteSaveChangesInterceptor, ApplySoftDeleteQueryFilters(), ToPagedResultAsync().
• Noayo.Domain.FastEndpoints — AuditMiddleware<TRequest, TResponse> that reads [Audited]/[SoftDeleted] attributes and sets flags on the scoped IAuditContext.
• Noayo.Domain.AspNetCore — Default ICurrentUserAccessor backed by IHttpContextAccessor.

License

MIT