GerbilManager/GerbilManagerWebAPI/Dtos/ApiDtos.cs

using GerbilManagerWebAPI.Models;

namespace GerbilManagerWebAPI.Dtos
{
    // Response DTOs ----------------------------------------------------------
    // Enums serialise as string names; JSON property names are camelCase (configured
    // globally in Program.cs). FK references are FLAT ids (no nested objects) per the
    // frontend contract (Kelly's pedigree + Oscar's filters depend on this).

    public record GerbilDto(
        Guid Id,
        string Name,
        Gender Gender,
        GerbilStatus Status,
        Guid? LitterId,
        Guid? OriginContactId,
        Guid? ReceiverContactId,
        Guid? EnclosureId,
        Guid? ColorVarietyId,
        DateOnly? DateOfBirth,
        DateOnly? DateOfDeath,
        string? CauseOfDeath,
        DateOnly? GoHomeDate,
        string? Genotype,
        string? SpottingType,
        string? Notes,
        string? ImportSource,
        string? ExternalRef,
        string? OriginBreeder,
        List<string> CharacterTraits,
        string? CharacterNote,
        bool? IsDeaf,
        bool IsResident,
        string? ProfilePhotoUrl,
        bool IsCastrated,
        string? Provenance,
        int? BirthOrder = null);

    public record LitterDto(
        Guid Id,
        string Name,
        DateOnly? Date,
        int? TotalBorn,
        int? DeathsWithin8Weeks,
        int? Stillborn,
        Guid? FatherId,
        Guid? MotherId,
        DateOnly? ExpectedGoHomeDate,
        string? Notes,
        string? Provenance,
        bool ShowInChronicle);

    public record ContactDto(Guid Id, string Name, string? Email, string? Phone, string? Address, string? Notes, bool IsBreeder, bool IsReceiver, string? NameSuffix, string? Provenance);

    public record EnclosureDto(
        Guid Id, string Name, string? Notes,
        string? Size, int? Capacity,
        DateOnly? LastCleanedDate, int? CleaningCycleDays, DateOnly? NextCleaningDate);

    public record ColorVarietyDto(Guid Id, string Name, string? CanonicalGenotype, int SortOrder);

    public record HealthRecordDto(
        Guid Id, Guid GerbilId, DateOnly Date, HealthRecordType Type,
        string Description, string? Veterinarian, DateTimeOffset CreatedAt);

    public record WeightRecordDto(
        Guid Id, Guid GerbilId, DateOnly Date, int WeightGrams, string? Notes);

    public record PhotoDto(Guid Id, string FileName, string? Caption, int SortOrder, string Url);

    // VERIFIED/PROTECTED OVERRIDE -------------------------------------------
    // Status: "unchanged" = raw import agrees with the golden state; "drifted" = the raw import
    // differs from the golden state (see ImportDiff — a signal for what the importer might still
    // get wrong); "missing" = the verified animal no longer exists in the imported data.
    public record VerifiedGerbilDto(
        Guid GerbilId,
        string? EntityName,
        bool IsVerified,
        string Status,
        DateTimeOffset? VerifiedAt,
        DateTimeOffset UpdatedAt,
        string? Note,
        IReadOnlyList<string> ProtectedFields,
        IReadOnlyList<SnapshotDiffDto> ImportDiff);

    /// <summary>One field difference between the golden state and the raw import.</summary>
    public record SnapshotDiffDto(string Path, string? GoldenValue, string? ImportValue);

    /// <summary>Export entry for the committed regression fixture (verified-golden.json).</summary>
    public record VerifiedGoldenEntry(
        Guid GerbilId, string? Name, DateTimeOffset? VerifiedAt, Import.GerbilSnapshot? Snapshot);

    // Request DTOs -----------------------------------------------------------

    /// <summary>Body for POST /verified-gerbils/{id} — optional free-text note.</summary>
    public record VerifyGerbilInput(string? Note);

    public record GerbilInput(
        string? Name,
        Gender? Gender,
        GerbilStatus? Status,
        Guid? LitterId,
        Guid? OriginContactId,
        Guid? ReceiverContactId,
        Guid? EnclosureId,
        Guid? ColorVarietyId,
        DateOnly? DateOfBirth,
        DateOnly? DateOfDeath,
        string? CauseOfDeath,
        DateOnly? GoHomeDate,
        string? Genotype,
        string? SpottingType,
        string? Notes,
        string? ImportSource,
        string? ExternalRef,
        string? OriginBreeder,
        List<string>? CharacterTraits,
        string? CharacterNote,
        bool? IsDeaf,
        bool? IsResident,
        bool? IsCastrated);

    public record LitterInput(
        string Name,
        DateOnly? Date,
        int? TotalBorn,
        int? DeathsWithin8Weeks,
        int? Stillborn,
        Guid? FatherId,
        Guid? MotherId,
        DateOnly? ExpectedGoHomeDate,
        string? Notes,
        bool? ShowInChronicle = null);

    public record ContactInput(string Name, string? Email, string? Phone, string? Address, string? Notes, bool IsBreeder, bool IsReceiver, string? NameSuffix);

    public record EnclosureInput(
        string Name, string? Notes,
        string? Size, int? Capacity,
        DateOnly? LastCleanedDate, int? CleaningCycleDays);

    public record ColorVarietyInput(string Name, string? CanonicalGenotype, int? SortOrder);

    public record HealthRecordInput(
        Guid GerbilId, DateOnly Date, HealthRecordType Type, string Description, string? Veterinarian);

    public record WeightRecordInput(Guid GerbilId, DateOnly Date, int WeightGrams, string? Notes);

    /// <summary>Hypothetical pairing request for POST /genetics/test-inbreeding.</summary>
    public record TestInbreedingDto(Guid? FatherId, Guid? MotherId);
}