shoc-backend/SeaHaven.Services/DTOs/DispatchDTOs.cs
Alexandre Brandizzi 7d245eb717
refactor: enforce backend boundaries and optimize dispatch (#30)
* refactor(api): enforce service and data-service boundaries

* refactor(api): complete feature service boundaries

* refactor(identity): enforce service and data boundaries

* refactor(vendors): enforce service and data boundaries

* refactor(workorders): enforce service and data boundaries

* refactor(backend): enforce architecture and optimize dispatch

* style(backend): format changed architecture files

* fix(architecture): address backend review follow-ups

* fix(backend): sanitize exception disclosure in changed API endpoints

Replace raw exception-message disclosure (ex.Message) returned to API
callers with a stable sanitized public message plus correlated structured
internal logging, across the endpoints changed in this PR.

- Add SanitizedErrors helper: logs the original exception at Error with a
  generated correlation id and returns a stable public message referencing
  it so support can trace without exposing internals.
- Inject ILogger<T> into the 14 changed controllers and route every
  ex.Message/dbex.Message disclosure through the helper, preserving status
  codes, response shapes, and business data (e.g. OpenWorkOrders).
- Leave FluentValidation (vex.Errors) and existing fixed-message catches
  untouched; out-of-scope controllers (Account/Contact/Employee/Asset/
  PMSchedule) are unchanged.
- Add focused tests proving internal exception text is not returned and
  that Error logging carrying the original exception is invoked.

* fix(architecture): abstract job run state access

* style: format board update service

* test: use collection assertion idiom
2026-07-24 17:35:34 -03:00

184 lines
7.1 KiB
C#

namespace SeaHaven.Services.DTOs
{
public class DispatchDTO
{
public int Id { get; set; }
public string? DispatchNumber { get; set; }
public string? Status { get; set; }
public int? VendorId { get; set; }
public string? VendorName { get; set; }
public DateTime? ScheduledDate { get; set; }
public DateTime? CompletedDate { get; set; }
public DateTime? CreatedDate { get; set; }
public string? CreatedBy { get; set; }
}
public class CreateDispatchDTO
{
public required int VendorId { get; set; }
public DateTime? ScheduledDate { get; set; }
public string? Status { get; set; }
}
public class UpdateDispatchDTO
{
public int? VendorId { get; set; }
public DateTime? ScheduledDate { get; set; }
public DateTime? CompletedDate { get; set; }
public string? Status { get; set; }
}
public class DispatchListEntryDTO
{
public int Id { get; set; }
public string? DispatchNumber { get; set; }
public string? PONumber { get; set; }
public decimal? NTEAmount { get; set; }
public string? Status { get; set; }
public DateTime? DispatchedAt { get; set; }
public DateTime? ScheduledDate { get; set; }
public DateTime? CompletedDate { get; set; }
public DateTime? AcknowledgedAt { get; set; }
public DateTime? VerifiedAt { get; set; }
public int? VendorId { get; set; }
public string? VendorName { get; set; }
public int? WorkOrderId { get; set; }
public string? PrimaryWOInternalNumber { get; set; }
public string? PrimaryWOTitle { get; set; }
public string? LocationName { get; set; }
public int WorkOrderCount { get; set; }
public int PendingUpliftCount { get; set; }
}
public class DispatchListResultDTO
{
public IReadOnlyList<DispatchListEntryDTO> Items { get; set; } = Array.Empty<DispatchListEntryDTO>();
public int Total { get; set; }
public int Page { get; set; }
public int PageSize { get; set; }
}
public class DispatchDetailVendorResultDTO
{
public int Id { get; set; }
public string? CompanyName { get; set; }
public string? ContactName { get; set; }
public string? Email { get; set; }
public string? Phone { get; set; }
public string? Address { get; set; }
public string? City { get; set; }
public string? State { get; set; }
public string? Zip { get; set; }
public string? TradeSpecialties { get; set; }
}
public class DispatchDetailLocationResultDTO
{
public int Id { get; set; }
public string? Name { get; set; }
public string? Address1 { get; set; }
public string? City { get; set; }
public string? State { get; set; }
public string? Zip { get; set; }
}
public class DispatchDetailLinkedWorkOrderDTO
{
public int WorkOrderId { get; set; }
public string? InternalWONumber { get; set; }
public string? Title { get; set; }
public string? Priority { get; set; }
public string? Status { get; set; }
public string? LocationName { get; set; }
public string? Trade { get; set; }
public string? SubTrade { get; set; }
public string? Problem { get; set; }
}
public class DispatchDetailChecklistDTO
{
public int Id { get; set; }
public string? ItemText { get; set; }
public bool IsCompleted { get; set; }
public string? CompletedBy { get; set; }
public DateTime? CompletedAt { get; set; }
public int SortOrder { get; set; }
public int? WorkOrderId { get; set; }
}
public class DispatchDetailSignoffDTO
{
public int Id { get; set; }
public string? SignoffType { get; set; }
public string? Name { get; set; }
public string? Signature { get; set; }
public string? SignatureMethod { get; set; }
public DateTime? SignedAt { get; set; }
}
public class DispatchDetailCommentDTO
{
public int Id { get; set; }
public string? Commenttext { get; set; }
public string? Commenter { get; set; }
public string? CommentType { get; set; }
public string? RecordType { get; set; }
public DateTime? CreatedDate { get; set; }
public string? UserId { get; set; }
public string UserName { get; set; } = "";
}
public class DispatchDetailUpliftDTO
{
public int Id { get; set; }
public decimal? CurrentNTE { get; set; }
public decimal RequestedNTE { get; set; }
public decimal Delta { get; set; }
public string? VendorReason { get; set; }
public string? Status { get; set; }
public int RequiredTier { get; set; }
public string? RequestedByVendorName { get; set; }
public DateTime? RequestedAt { get; set; }
public DateTime? DecidedAt { get; set; }
public string? DecisionNote { get; set; }
public string DecidedByName { get; set; } = "";
}
public class DispatchDetailAuditLogDTO
{
public int Id { get; set; }
public string? Action { get; set; }
public string? FieldName { get; set; }
public string? OldValue { get; set; }
public string? NewValue { get; set; }
public DateTime? CreatedAt { get; set; }
public string? UserId { get; set; }
public string UserName { get; set; } = "";
}
public class DispatchDetailResultDTO
{
public int Id { get; set; }
public string? DispatchNumber { get; set; }
public string? PONumber { get; set; }
public decimal? NTEAmount { get; set; }
public string? Description { get; set; }
public string? Status { get; set; }
public DateTime? ScheduledDate { get; set; }
public DateTime? CompletedDate { get; set; }
public DateTime? DispatchedAt { get; set; }
public DateTime? AcknowledgedAt { get; set; }
public DateTime? VerifiedAt { get; set; }
public string? VerifiedBy { get; set; }
public bool EmailSent { get; set; }
public int? WorkOrderId { get; set; }
public DispatchDetailVendorResultDTO? Vendor { get; set; }
public DispatchDetailLocationResultDTO? PrimaryLocation { get; set; }
public IReadOnlyList<DispatchDetailLinkedWorkOrderDTO> WorkOrders { get; set; } = Array.Empty<DispatchDetailLinkedWorkOrderDTO>();
public IReadOnlyList<DispatchDetailChecklistDTO> Checklist { get; set; } = Array.Empty<DispatchDetailChecklistDTO>();
public IReadOnlyList<DispatchDetailSignoffDTO> Signoffs { get; set; } = Array.Empty<DispatchDetailSignoffDTO>();
public IReadOnlyList<DispatchDetailCommentDTO> Comments { get; set; } = Array.Empty<DispatchDetailCommentDTO>();
public IReadOnlyList<DispatchDetailUpliftDTO> UpliftRequests { get; set; } = Array.Empty<DispatchDetailUpliftDTO>();
public IReadOnlyList<DispatchDetailAuditLogDTO> AuditLog { get; set; } = Array.Empty<DispatchDetailAuditLogDTO>();
}
}