shoc-backend/SeaHaven.DataServices/Interfaces/IDispatchDataService.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

56 lines
3.3 KiB
C#

using Data.SeaHavenIndustries;
using SeaHaven.DataServices.Dto;
using SeaHaven.DataServices.Models;
namespace SeaHaven.DataServices.Interfaces
{
public interface IDispatchDataService
{
Task<Dispatch?> GetByIdAsync(int id);
Task<Dispatch?> GetByIdWithDetailsAsync(int id);
Task<Dispatch?> GetByIdWithVendorAndWorkOrderAsync(int id);
Task<IEnumerable<Dispatch>> GetAllAsync();
Task<IEnumerable<Dispatch>> GetByVendorIdAsync(int vendorId);
Task<IEnumerable<Dispatch>> GetByWorkOrderIdAsync(int workOrderId);
Task<IEnumerable<Dispatch>> GetByWorkOrderIdsAsync(IEnumerable<int> workOrderIds);
Task<IEnumerable<Dispatch>> GetByStatusAsync(string status);
Task<(IEnumerable<Dispatch> Items, int TotalCount)> GetPagedAsync(int page, int pageSize, string? search = null, string? status = null);
Task<Dispatch> AddAsync(Dispatch dispatch);
Task UpdateAsync(Dispatch dispatch);
Task DeleteAsync(int id);
Task<bool> ExistsAsync(int id);
Task<string> GenerateNextDispatchNumberAsync();
Task<string> GenerateNextPONumberAsync();
Task<int> CountAsync();
Task<IEnumerable<DispatchChecklistItem>> GetChecklistItemsAsync(int dispatchId);
Task<DispatchChecklistItem?> GetChecklistItemByIdAsync(int id);
Task AddChecklistItemAsync(DispatchChecklistItem item);
Task UpdateChecklistItemAsync(DispatchChecklistItem item);
Task<IEnumerable<DispatchSignoff>> GetSignoffsAsync(int dispatchId);
Task AddSignoffAsync(DispatchSignoff signoff);
Task StageSignoffAsync(DispatchSignoff signoff, CancellationToken cancellationToken);
Task<bool> HasSignoffTypeAsync(int dispatchId, string signoffType);
Task<IEnumerable<DispatchWorkOrder>> GetDispatchWorkOrdersAsync(int dispatchId);
Task AddDispatchWorkOrderAsync(DispatchWorkOrder dispatchWorkOrder);
Task<DispatchListResult> GetListAsync(DispatchListQuery query, CancellationToken cancellationToken);
Task<DispatchDetailDTO?> GetDetailAsync(int id, CancellationToken cancellationToken);
Task<DispatchDetailReadModel?> GetDispatchDetailAsync(int id);
Task<IReadOnlyList<VendorDispatchSummaryData>> GetVendorDispatchSummariesAsync(
int vendorId, string? status, CancellationToken cancellationToken);
Task<Dispatch?> GetVendorDispatchDetailAsync(
int id, int vendorId, CancellationToken cancellationToken);
Task<Dispatch?> GetVendorDispatchForMutationAsync(
int id, int vendorId, CancellationToken cancellationToken);
Task<IReadOnlyList<PortalChecklistItemData>> GetPortalChecklistAsync(
int dispatchId, CancellationToken cancellationToken);
Task<IReadOnlyList<PortalSignoffData>> GetPortalSignoffsAsync(
int dispatchId, CancellationToken cancellationToken);
Task<DispatchChecklistItem?> GetChecklistItemForDispatchAsync(
int itemId, int dispatchId, CancellationToken cancellationToken);
Task StageAuditLogAsync(WorkOrderAuditLog log, CancellationToken cancellationToken);
Task<string?> GetDispatchDispatcherUserIdAsync(
int workOrderId, CancellationToken cancellationToken);
Task SaveChangesAsync(CancellationToken cancellationToken);
}
}