shoc-backend/SeaHaven.Services/DTOs/DispatchServiceDTOs.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

131 lines
4 KiB
C#

namespace SeaHaven.Services.DTOs
{
public class DispatchVerificationException : Exception
{
public List<string> Missing { get; }
public DispatchVerificationException(List<string> missing) : base("Cannot verify")
{
Missing = missing;
}
}
public class DispatchToVendorInput
{
public List<int> WorkOrderIds { get; set; } = new();
public List<int> VendorIds { get; set; } = new();
public decimal? NTEAmount { get; set; }
public string? Description { get; set; }
public DateTime? ScheduledDate { get; set; }
public int? TaskListTemplateId { get; set; }
public List<string>? CustomChecklistItems { get; set; }
public string? UserId { get; set; }
public string? SenderName { get; set; }
}
public class DispatchResultItem
{
public int Id { get; set; }
public string? DispatchNumber { get; set; }
public string? PONumber { get; set; }
public string? VendorName { get; set; }
public string? Status { get; set; }
public int WorkOrderCount { get; set; }
}
public class DispatchToVendorResult
{
public string Message { get; set; } = "";
public List<DispatchResultItem> Dispatches { get; set; } = new();
}
public class UpdateDispatchInput
{
public int Id { get; set; }
public string? Status { get; set; }
public decimal? NTEAmount { get; set; }
public DateTime? ScheduledDate { get; set; }
public DateTime? CompletedDate { get; set; }
public string? Description { get; set; }
public string? UserId { get; set; }
}
public class AddDispatchCommentInput
{
public int DispatchId { get; set; }
public string? Text { get; set; }
public bool SendEmail { get; set; }
public string? UserId { get; set; }
}
public class AddDispatchCommentResult
{
public int Id { get; set; }
public DateTime? CreatedDate { get; set; }
public string? Commenttext { get; set; }
public string? CommentType { get; set; }
public string? UserName { get; set; }
}
public class AddDispatchSignoffInput
{
public int DispatchId { get; set; }
public string? SignoffType { get; set; }
public string? Name { get; set; }
public string? Signature { get; set; }
public string? SignatureMethod { get; set; }
}
public class AddDispatchSignoffResult
{
public int Id { get; set; }
public string? SignoffType { get; set; }
public string? Name { get; set; }
public DateTime? SignedAt { get; set; }
public string? SignatureMethod { get; set; }
}
public class VerifyDispatchResult
{
public string Message { get; set; } = "";
public string? VerifiedBy { get; set; }
public DateTime? VerifiedAt { get; set; }
}
public class VerifyDispatchError
{
public string Status { get; set; } = "Error";
public string Message { get; set; } = "";
public List<string> Missing { get; set; } = new();
}
public class ChecklistItemUpdateInput
{
public int Id { get; set; }
public bool IsCompleted { get; set; }
public string? CompletedBy { get; set; }
}
public class ChecklistItemUpdateResult
{
public string Message { get; set; } = "";
public int Id { get; set; }
public bool? IsCompleted { get; set; }
public string? CompletedBy { get; set; }
public DateTime? CompletedAt { get; set; }
}
public class AddChecklistItemInput
{
public int DispatchId { get; set; }
public int? WorkOrderId { get; set; }
public string? ItemText { get; set; }
}
public class AddChecklistItemResult
{
public int Id { get; set; }
public string? ItemText { get; set; }
public int? SortOrder { get; set; }
public bool? IsCompleted { get; set; }
}
}