Tolitech.Auditing.Generators 1.0.0

Tolitech.Auditing.Generators

Source generator that creates audit fields, read-only audit properties, and private audit mutation methods for partial entities.

Use this package together with Tolitech.Auditing.Generators.Abstractions.

How It Works

1. Your project defines audit interfaces with properties annotated by the abstraction attributes.
2. An entity implements those interfaces.
3. The generator emits the backing fields, read-only properties, and private SetAudit methods.

public sealed partial class Product :
    ICreatedAudit<UserId>,
    IUpdatedAudit<UserId>,
    IDeletedAudit<UserId>
{
    public static IResult<Product> Create(UserId userId)
    {
        var product = new Product();
        product.SetCreatedAudit(userId);
        return Result.Created(product);
    }
}

SetCreatedAudit, SetUpdatedAudit, and SetDeletedAudit are generated as private methods. They can be called from inside the same partial entity, but they are not exposed as entity.SetCreatedAudit(...) to external code.

Generated Members

For a generic audit interface, the generator creates members similar to:

private DateTimeOffset? _createdAt;
public DateTimeOffset? CreatedAt => _createdAt;

private UserId? _createdById;
public UserId? CreatedById => _createdById;

private IResult SetCreatedAudit(UserId? createdById)
{
    if (_createdAt.HasValue || _createdById.HasValue)
    {
        return Result.BadRequest();
    }

    _createdAt = DateTimeOffset.UtcNow;
    _createdById = createdById;

    return Result.OK();
}

Custom Behavior

If a specific entity needs different behavior, declare a method with the same signature in the entity. The generator will not generate the default method for that signature.

public sealed partial class Product : ICreatedAudit<UserId>
{
    public IResult SetCreatedAudit(UserId? createdById)
    {
        // Custom rule.
        return Result.OK();
    }
}

Manual methods can be private, public, protected, or internal. Public methods are allowed only when the entity author explicitly chooses to expose them.

Diagnostics

• TAUD001: The audited type must be partial.
• TAUD002: Parent types of nested audited types must be partial.
• TAUD003: A generated audit property conflicts with an existing member.
• TAUD004: A required audit property attribute is missing.
• TAUD005: More than one property uses the same audit attribute.
• TAUD006: An audit property has an invalid type or setter.