using TrajetKmTracker.Api.Models.DTOs;

namespace TrajetKmTracker.Api.Services;

/// <summary>
/// Résultat de la modification d'un Trajet par <see cref="TrajetService.UpdateAsync"/>.
/// Porte le <see cref="TrajetDto"/> mis à jour et un éventuel avertissement lorsque la
/// distance n'a pas pu être (re)calculée faute de coordonnées résolubles. Dans ce cas, le
/// Trajet est tout de même mis à jour avec une Distance nulle et un message d'avertissement
/// (Exigence 2.4). En revanche, un échec du calcul lui-même (indisponibilité ORS/BAN sur des
/// coordonnées connues) provoque un rollback et la levée d'une
/// <see cref="Exceptions.DistanceRecalculException"/> (Exigence 5.8).
/// </summary>
/// <param name="Trajet">Le trajet mis à jour, tel qu'il sera exposé au client.</param>
/// <param name="Avertissement">
/// Vrai lorsque la distance n'a pas pu être calculée (Distance nulle persistée).
/// </param>
/// <param name="Message">Message d'avertissement associé, ou <c>null</c>.</param>
public record TrajetUpdateResult(
    TrajetDto Trajet,
    bool Avertissement,
    string? Message);