feat: add envelope delete command and API endpoint

EnvelopeGenerator.API/Controllers/EnvelopeController.cs

@@ -27,6 +27,8 @@ namespace EnvelopeGenerator.API.Controllers;
 [Authorize]
 public class EnvelopeController : ControllerBase
 {
+    public record DeleteEnvelopeRequest(string Reason);
+
     private readonly ILogger<EnvelopeController> _logger;
     private readonly IMediator _mediator;
 
@@ -108,4 +110,17 @@ public class EnvelopeController : ControllerBase
         else
             return Ok(res);
     }
+
+    [Authorize(AuthenticationSchemes = AuthScheme.Sender)]
+    [HttpDelete("{id:int}")]
+    public async Task<IActionResult> DeleteAsync([FromRoute] int id, [FromBody] DeleteEnvelopeRequest request)
+    {
+        var result = await _mediator.Send(new DeleteEnvelopeCommand
+        {
+            EnvelopeId = id,
+            Reason = request?.Reason ?? string.Empty
+        }.WithAuth(User.GetId()));
+
+        return Ok(result);
+    }
 }

EnvelopeGenerator.API/Middleware/ExceptionHandlingMiddleware.cs

@@ -69,6 +69,11 @@ public class ExceptionHandlingMiddleware
                 message = notFoundEx.Message;
                 break;
 
+            case ForbiddenException forbiddenEx:
+                context.Response.StatusCode = (int)HttpStatusCode.Forbidden;
+                message = forbiddenEx.Message;
+                break;
+
             default:
                 logger.LogError(exception, "Unhandled exception occurred.");
                 context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;

EnvelopeGenerator.Application/Common/Notifications/EnvelopeDeleted/EnvelopeDeletedNotification.cs

@@ -0,0 +1,21 @@
+using EnvelopeGenerator.Domain.Constants;
+using EnvelopeGenerator.Domain.Entities;
+using MediatR;
+
+namespace EnvelopeGenerator.Application.Common.Notifications.EnvelopeDeleted;
+
+public record EnvelopeDeletedNotification : INotification, ISendMailNotification
+{
+    public required Envelope Envelope { get; init; }
+
+    public required EnvelopeReceiver EnvelopeReceiver { get; init; }
+
+    public required string Reason { get; init; }
+
+    public required string SenderReference { get; init; }
+
+    public EmailTemplateType TemplateType => EmailTemplateType.DocumentDeleted;
+
+    public string EmailAddress => EnvelopeReceiver.Receiver?.EmailAddress
+        ?? throw new InvalidOperationException("Receiver email is missing for EnvelopeDeletedNotification.");
+}

EnvelopeGenerator.Application/Common/Notifications/EnvelopeDeleted/Handlers/SendDeletedMailHandler.cs

@@ -0,0 +1,42 @@
+using DigitalData.Core.Abstraction.Application.Repository;
+using DigitalData.EmailProfilerDispatcher.Abstraction.Entities;
+using EnvelopeGenerator.Application.Common.Configurations;
+using EnvelopeGenerator.Domain.Constants;
+using EnvelopeGenerator.Domain.Entities;
+using Microsoft.Extensions.Options;
+
+namespace EnvelopeGenerator.Application.Common.Notifications.EnvelopeDeleted.Handlers;
+
+public class SendDeletedMailHandler : SendMailHandler<EnvelopeDeletedNotification>
+{
+    public SendDeletedMailHandler(
+        IRepository<EmailTemplate> tempRepo,
+        IRepository<EmailOut> emailOutRepo,
+        IOptions<MailParams> mailParamsOptions,
+        IOptions<DispatcherParams> dispatcherParamsOptions)
+        : base(tempRepo, emailOutRepo, mailParamsOptions, dispatcherParamsOptions)
+    {
+    }
+
+    protected override void ConfigureEmailOut(EnvelopeDeletedNotification notification, EmailOut emailOut)
+    {
+        emailOut.ReferenceString = notification.EmailAddress;
+        emailOut.ReferenceId = notification.EnvelopeReceiver.ReceiverId;
+        emailOut.WfId = (int)EnvelopeStatus.MessageDeletionSent;
+    }
+
+    protected override Dictionary<string, string> CreatePlaceHolders(EnvelopeDeletedNotification notification)
+    {
+        var senderName = notification.Envelope.User?.Email;
+        if (string.IsNullOrWhiteSpace(senderName))
+            senderName = notification.SenderReference;
+
+        return new Dictionary<string, string>
+        {
+            ["[NAME_RECEIVER]"] = notification.EnvelopeReceiver.Name ?? string.Empty,
+            ["[NAME_SENDER]"] = senderName ?? string.Empty,
+            ["[DOCUMENT_TITLE]"] = notification.Envelope.Title ?? string.Empty,
+            ["[REASON]"] = notification.Reason
+        };
+    }
+}

EnvelopeGenerator.Application/Envelopes/Commands/DeleteEnvelopeCommand.cs

@@ -0,0 +1,25 @@
+using System.ComponentModel.DataAnnotations;
+using EnvelopeGenerator.Domain.Constants;
+using MediatR;
+
+namespace EnvelopeGenerator.Application.Envelopes.Commands;
+
+public record DeleteEnvelopeResultDto(int EnvelopeId, EnvelopeStatus AppliedStatus, bool IsNoOp);
+
+public record DeleteEnvelopeCommand : IRequest<DeleteEnvelopeResultDto>
+{
+    [Required]
+    public int EnvelopeId { get; init; }
+
+    [Required]
+    [MinLength(1)]
+    public string Reason { get; init; } = string.Empty;
+
+    internal int UserId { get; private set; }
+
+    public DeleteEnvelopeCommand WithAuth(int userId)
+    {
+        UserId = userId;
+        return this;
+    }
+}

EnvelopeGenerator.Application/Envelopes/Commands/DeleteEnvelopeCommandHandler.cs

@@ -0,0 +1,83 @@
+using EnvelopeGenerator.Application.Common.Notifications.EnvelopeDeleted;
+using DigitalData.Core.Abstraction.Application.Repository;
+using DigitalData.Core.Exceptions;
+using EnvelopeGenerator.Application.Histories.Commands;
+using EnvelopeGenerator.Domain.Constants;
+using EnvelopeGenerator.Domain.Entities;
+using MediatR;
+using Microsoft.EntityFrameworkCore;
+using System.Linq;
+
+namespace EnvelopeGenerator.Application.Envelopes.Commands;
+
+public class DeleteEnvelopeCommandHandler : IRequestHandler<DeleteEnvelopeCommand, DeleteEnvelopeResultDto>
+{
+    private readonly IRepository<Envelope> _envelopeRepository;
+    private readonly IMediator _mediator;
+
+    public DeleteEnvelopeCommandHandler(
+        IRepository<Envelope> envelopeRepository,
+        IMediator mediator)
+    {
+        _envelopeRepository = envelopeRepository;
+        _mediator = mediator;
+    }
+
+    public async Task<DeleteEnvelopeResultDto> Handle(DeleteEnvelopeCommand request, CancellationToken cancel)
+    {
+        var reason = request.Reason?.Trim();
+        if (string.IsNullOrWhiteSpace(reason))
+            throw new BadRequestException("Please provide a reason.");
+
+        var envelope = await _envelopeRepository.Query
+            .Include(e => e.User)
+            .Include(e => e.EnvelopeReceivers)
+                .ThenInclude(er => er.Receiver)
+            .FirstOrDefaultAsync(e => e.Id == request.EnvelopeId, cancel)
+            ?? throw new NotFoundException($"Envelope {request.EnvelopeId} not found.");
+
+        if (envelope.UserId != request.UserId)
+            throw new ForbiddenException();
+
+        if (envelope.Status is EnvelopeStatus.EnvelopeDeleted or EnvelopeStatus.EnvelopeWithdrawn)
+            return new DeleteEnvelopeResultDto(envelope.Id, envelope.Status, IsNoOp: true);
+
+        var targetStatus = envelope.Status > EnvelopeStatus.EnvelopeSaved
+            ? EnvelopeStatus.EnvelopeWithdrawn
+            : EnvelopeStatus.EnvelopeDeleted;
+
+        envelope.Status = targetStatus;
+        envelope.Comment = reason;
+        envelope.ChangedWhen = DateTime.Now;
+
+        await _envelopeRepository.UpdateAsync(envelope, e => e.Id == envelope.Id, cancel);
+
+        var userReference = envelope.User?.Email;
+        if (string.IsNullOrWhiteSpace(userReference))
+            throw new BadRequestException("Envelope sender email is missing.");
+
+        await _mediator.Send(new CreateHistoryCommand
+        {
+            EnvelopeId = envelope.Id,
+            UserReference = userReference,
+            Status = targetStatus,
+            Comment = reason
+        }, cancel);
+
+        foreach (var envelopeReceiver in envelope.EnvelopeReceivers ?? Enumerable.Empty<EnvelopeReceiver>())
+        {
+            if (envelopeReceiver.Receiver is null)
+                continue;
+
+            await _mediator.Publish(new EnvelopeDeletedNotification
+            {
+                Envelope = envelope,
+                EnvelopeReceiver = envelopeReceiver,
+                Reason = reason,
+                SenderReference = userReference
+            }, cancel);
+        }
+
+        return new DeleteEnvelopeResultDto(envelope.Id, targetStatus, IsNoOp: false);
+    }
+}

EnvelopeGenerator.Server/EnvelopeGenerator.Server/Controllers/EnvelopeController.cs

@@ -27,6 +27,8 @@ namespace EnvelopeGenerator.Server.Controllers;
 [Authorize]
 public class EnvelopeController : ControllerBase
 {
+    public record DeleteEnvelopeRequest(string Reason);
+
     private readonly ILogger<EnvelopeController> _logger;
     private readonly IMediator _mediator;
 
@@ -108,4 +110,17 @@ public class EnvelopeController : ControllerBase
         else
             return Ok(res);
     }
+
+    [Authorize(AuthenticationSchemes = AuthScheme.Sender)]
+    [HttpDelete("{id:int}")]
+    public async Task<IActionResult> DeleteAsync([FromRoute] int id, [FromBody] DeleteEnvelopeRequest request)
+    {
+        var result = await _mediator.Send(new DeleteEnvelopeCommand
+        {
+            EnvelopeId = id,
+            Reason = request?.Reason ?? string.Empty
+        }.WithAuth(User.GetId()));
+
+        return Ok(result);
+    }
 }

EnvelopeGenerator.Server/EnvelopeGenerator.Server/Middleware/ExceptionHandlingMiddleware.cs

@@ -69,6 +69,11 @@ public class ExceptionHandlingMiddleware
                 message = notFoundEx.Message;
                 break;
 
+            case ForbiddenException forbiddenEx:
+                context.Response.StatusCode = (int)HttpStatusCode.Forbidden;
+                message = forbiddenEx.Message;
+                break;
+
             default:
                 logger.LogError(exception, "Unhandled exception occurred.");
                 context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;

EnvelopeGenerator.Server/EnvelopeGenerator.Server/appsettings.json

@@ -186,7 +186,7 @@
   },
   "DbTriggerParams": {
     "Envelope": [ "TBSIG_ENVELOPE_HISTORY_AFT_INS" ],
-    "EnvelopeHistory": [ "TBSIG_ENVELOPE_HISTORY_AFT_INS" ],
+    "History": [ "TBSIG_ENVELOPE_HISTORY_AFT_INS" ],
     "EmailOut": [ "TBEMLP_EMAIL_OUT_AFT_INS", "TBEMLP_EMAIL_OUT_AFT_UPD" ],
     "EnvelopeReceiverReadOnly": [ "TBSIG_ENVELOPE_RECEIVER_READ_ONLY_UPD" ],
     "Receiver": [],