using DigitalData.Core.Abstractions;
using DigitalData.UserManager.Application.DTOs.User;
using EnvelopeGenerator.Application.DTOs.Receiver;
using static EnvelopeGenerator.CommonServices.Constants;

namespace EnvelopeGenerator.Application.DTOs.EnvelopeHistory;

/// <summary>
/// Data Transfer Object representing the history of an envelope, including status, sender, receiver, and related metadata.
/// </summary>
public record EnvelopeHistoryDto : IUnique<long>
{
    /// <summary>
    /// Unique identifier for the envelope history entry.
    /// </summary>
    public long Id { get; set; }

    /// <summary>
    /// Identifier of the associated envelope.
    /// </summary>
    public int EnvelopeId { get; set; }

    /// <summary>
    /// Reference string for the user related to this history entry.
    /// </summary>
    public string UserReference { get; set; }

    /// <summary>
    /// Status code of the envelope at this history point.
    /// </summary>
    public int Status { get; set; }

    /// <summary>
    /// Human-readable name of the status.
    /// </summary>
    public string? StatusName { get; set; }

    /// <summary>
    /// Date and time when this history entry was added.
    /// </summary>
    public DateTime AddedWhen { get; set; }

    /// <summary>
    /// Date and time when an action was performed, if applicable.
    /// </summary>
    public DateTime? ActionDate { get; set; }

    /// <summary>
    /// Information about the sender associated with this history entry.
    /// </summary>
    public UserCreateDto? Sender { get; set; }

    /// <summary>
    /// Information about the receiver associated with this history entry.
    /// </summary>
    public ReceiverReadDto? Receiver { get; set; }

    /// <summary>
    /// Type of reference for this history entry.
    /// </summary>
    public ReferenceType ReferenceType { get; set; }

    /// <summary>
    /// Optional comment related to this history entry.
    /// </summary>
    public string? Comment { get; set; }

    /// <inheritdoc/>
    public override int GetHashCode()
    {
        return Id.GetHashCode();
    }
};