Refactor: Replace EnvelopeTypeId with EnvelopeType enum
Replaced all instances of `EnvelopeTypeId` (int/int?) with `Type` (EnvelopeType/EnvelopeType?) across the codebase to improve type safety and readability. Updated affected properties, methods, and logic in DTOs, commands, handlers, and Razor components. Introduced conditional compilation to handle differences between .NET and .NET Framework where necessary. Removed obsolete helper methods for `EnvelopeTypeId`. This refactor ensures consistent use of the strongly-typed `EnvelopeType` enum, reducing the risk of invalid values and aligning with best practices.
This commit is contained in:
@@ -67,7 +67,7 @@ public record EnvelopeDto : IEnvelope
|
||||
/// <summary>
|
||||
///
|
||||
/// </summary>
|
||||
public int? EnvelopeTypeId { get; set; }
|
||||
public EnvelopeType? Type { get; set; }
|
||||
|
||||
// TODO: use ReadAndConfirm property name
|
||||
/// <summary>
|
||||
|
||||
@@ -10,7 +10,7 @@ public class EnvelopeTypeDefaultsDto
|
||||
/// <summary>
|
||||
/// Gets or sets the unique identifier of the envelope type.
|
||||
/// </summary>
|
||||
public int Id { get; set; }
|
||||
public EnvelopeType Id { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the title of the envelope type.
|
||||
|
||||
@@ -22,7 +22,7 @@ public record CreateEnvelopeCommand : IRequest<EnvelopeDto?>
|
||||
/// <summary>
|
||||
/// Kennung des ausgewaehlten Umschlagtyps (Vorlage).
|
||||
/// </summary>
|
||||
public int? EnvelopeTypeId { get; set; }
|
||||
public EnvelopeType? Type { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Sprachcode fuer Umschlaginhalt und Benachrichtigungen.
|
||||
|
||||
@@ -93,7 +93,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
e.Title = title;
|
||||
e.Message = message;
|
||||
e.TfaEnabled = request.TFAEnabled;
|
||||
e.EnvelopeTypeId = settings.EnvelopeTypeId;
|
||||
e.Type = settings.Type;
|
||||
e.Language = settings.Language;
|
||||
e.UseAccessCode = settings.UseAccessCode;
|
||||
e.FinalEmailToCreator = settings.FinalEmailToCreator;
|
||||
@@ -112,7 +112,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
envelope.Title = title;
|
||||
envelope.Message = message;
|
||||
envelope.TfaEnabled = request.TFAEnabled;
|
||||
envelope.EnvelopeTypeId = settings.EnvelopeTypeId;
|
||||
envelope.Type = settings.Type;
|
||||
envelope.Language = settings.Language;
|
||||
envelope.UseAccessCode = settings.UseAccessCode;
|
||||
envelope.FinalEmailToCreator = settings.FinalEmailToCreator;
|
||||
@@ -141,7 +141,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
AddedWhen = now,
|
||||
ChangedWhen = now,
|
||||
Comment = string.Empty,
|
||||
EnvelopeTypeId = settings.EnvelopeTypeId,
|
||||
Type = settings.Type,
|
||||
Language = settings.Language,
|
||||
TfaEnabled = request.TFAEnabled,
|
||||
UseAccessCode = settings.UseAccessCode,
|
||||
@@ -163,7 +163,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
e.Title = title;
|
||||
e.Message = message;
|
||||
e.TfaEnabled = request.TFAEnabled;
|
||||
e.EnvelopeTypeId = settings.EnvelopeTypeId;
|
||||
e.Type = settings.Type;
|
||||
e.Language = settings.Language;
|
||||
e.UseAccessCode = settings.UseAccessCode;
|
||||
e.FinalEmailToCreator = settings.FinalEmailToCreator;
|
||||
@@ -182,7 +182,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
envelope.Title = title;
|
||||
envelope.Message = message;
|
||||
envelope.TfaEnabled = request.TFAEnabled;
|
||||
envelope.EnvelopeTypeId = settings.EnvelopeTypeId;
|
||||
envelope.Type = settings.Type;
|
||||
envelope.Language = settings.Language;
|
||||
envelope.UseAccessCode = settings.UseAccessCode;
|
||||
envelope.FinalEmailToCreator = settings.FinalEmailToCreator;
|
||||
@@ -224,11 +224,11 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
private async Task<EnvelopeSettings> ResolveEnvelopeSettingsAsync(CreateEnvelopeCommand request, Envelope? existing, CancellationToken cancel)
|
||||
{
|
||||
EnvelopeTypeDefaults? selectedType = null;
|
||||
if (request.EnvelopeTypeId is int envelopeTypeId && envelopeTypeId > 0)
|
||||
if (request.Type is EnvelopeType type)
|
||||
{
|
||||
selectedType = await EnvelopeTypeRepository.Query
|
||||
.FirstOrDefaultAsync(t => t.Id == envelopeTypeId, cancel)
|
||||
?? throw new BadRequestException($"Envelope type {envelopeTypeId} not found.");
|
||||
.FirstOrDefaultAsync(t => t.Id == type, cancel)
|
||||
?? throw new BadRequestException($"Envelope type {type} not found.");
|
||||
}
|
||||
|
||||
var expiresWhenDays = Math.Max(0,
|
||||
@@ -252,7 +252,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
useAccessCode = true;
|
||||
|
||||
return new EnvelopeSettings(
|
||||
EnvelopeTypeId: request.EnvelopeTypeId ?? existing?.EnvelopeTypeId,
|
||||
Type: request.Type ?? existing?.Type,
|
||||
Language: ResolveLanguage(request.Language, selectedType?.Language, existing?.Language),
|
||||
UseAccessCode: useAccessCode,
|
||||
FinalEmailToCreator: request.FinalEmailToCreator
|
||||
@@ -298,7 +298,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
}
|
||||
|
||||
private sealed record EnvelopeSettings(
|
||||
int? EnvelopeTypeId,
|
||||
EnvelopeType? Type,
|
||||
string Language,
|
||||
bool UseAccessCode,
|
||||
int FinalEmailToCreator,
|
||||
@@ -570,7 +570,7 @@ public class CreateEnvelopeCommandHandler(IServiceProvider Provider, IMapper Map
|
||||
{
|
||||
await EnvNtfService.Notify(er.Receiver.EmailAddress, new DocumentReceivedNotification
|
||||
{
|
||||
AdvancedSignature = envelope.Type() == EnvelopeType.AdvancedSignature,
|
||||
AdvancedSignature = envelope.Type == EnvelopeType.AdvancedSignature,
|
||||
DocumentTitle = envelope.Title ?? string.Empty,
|
||||
NameReceiver = er.Name ?? string.Empty,
|
||||
EnvelopeUuid = envelope.Uuid,
|
||||
|
||||
@@ -171,7 +171,7 @@ public class ReadEnvelopeQueryHandler : IRequestHandler<ReadEnvelopeQuery, IEnum
|
||||
ChangedWhen = e.ChangedWhen,
|
||||
Title = e.Title ?? string.Empty,
|
||||
Language = e.Language,
|
||||
EnvelopeTypeId = e.EnvelopeTypeId,
|
||||
Type = e.Type,
|
||||
FinalEmailToCreator = e.FinalEmailToCreator,
|
||||
FinalEmailToReceivers = e.FinalEmailToReceivers,
|
||||
SendReminderEmails = e.SendReminderEmails,
|
||||
|
||||
@@ -31,7 +31,7 @@ namespace EnvelopeGenerator.Domain.Constants
|
||||
$"Invalid EnvelopeTypeId '{envelopeTypeId}' for envelope. " +
|
||||
$"Valid {nameof(EnvelopeType)} values are: [{validValues}]. " +
|
||||
"This indicates a data integrity issue: the envelope may have been " +
|
||||
"created or updated with an invalid EnvelopeTypeId in the database.");
|
||||
"created or updated with an invalid EnvelopeType in the database.");
|
||||
}
|
||||
|
||||
return (EnvelopeType)Enum.ToObject(typeof(EnvelopeType), envelopeTypeId);
|
||||
|
||||
@@ -106,7 +106,12 @@ namespace EnvelopeGenerator.Domain.Entities
|
||||
public int? ReminderIntervalDays { get; set; }
|
||||
|
||||
[Column("ENVELOPE_TYPE")]
|
||||
public int? EnvelopeTypeId { get; set; }
|
||||
#if NET
|
||||
|
||||
public EnvelopeType? Type { get; set; }
|
||||
#elif NETFRAMEWORK
|
||||
public int EnvelopeTypeId { get; set; }
|
||||
#endif
|
||||
|
||||
[JsonIgnore]
|
||||
[NotMapped]
|
||||
@@ -155,7 +160,7 @@ namespace EnvelopeGenerator.Domain.Entities
|
||||
DocResult
|
||||
{ get; set; }
|
||||
|
||||
[ForeignKey("EnvelopeTypeId")]
|
||||
[ForeignKey("Type")]
|
||||
public virtual EnvelopeTypeDefaults
|
||||
#if nullable
|
||||
?
|
||||
|
||||
@@ -14,7 +14,7 @@ namespace EnvelopeGenerator.Domain.Entities
|
||||
[Key]
|
||||
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
|
||||
[Column("GUID")]
|
||||
public int Id { get; set; } = 0;
|
||||
public EnvelopeType Id { get; set; } = 0;
|
||||
|
||||
[Required]
|
||||
[Column("TITLE", TypeName = "nvarchar(128)")]
|
||||
|
||||
@@ -9,7 +9,12 @@ namespace EnvelopeGenerator.Domain.Interfaces
|
||||
{
|
||||
public interface IEnvelope
|
||||
{
|
||||
int? EnvelopeTypeId { get; set; }
|
||||
#if NET
|
||||
|
||||
public EnvelopeType? Type { get; set; }
|
||||
#elif NETFRAMEWORK
|
||||
int EnvelopeTypeId { get; set; }
|
||||
#endif
|
||||
|
||||
byte[]
|
||||
#if nullable
|
||||
@@ -22,35 +27,27 @@ namespace EnvelopeGenerator.Domain.Interfaces
|
||||
{
|
||||
public static bool IsReadAndConfirm(this IEnvelope envelope)
|
||||
{
|
||||
return envelope.EnvelopeTypeId == 2;
|
||||
#if NET
|
||||
|
||||
return envelope.Type == EnvelopeType.ReadAndConfirm;
|
||||
#elif NETFRAMEWORK
|
||||
return envelope.EnvelopeTypeId == (int)EnvelopeType.ReadAndConfirm;
|
||||
#endif
|
||||
}
|
||||
|
||||
public static bool IsReadAndSign(this IEnvelope envelope)
|
||||
{
|
||||
return envelope.EnvelopeTypeId != 2;
|
||||
#if NET
|
||||
|
||||
return envelope.Type != EnvelopeType.ReadAndConfirm;
|
||||
#elif NETFRAMEWORK
|
||||
return envelope.EnvelopeTypeId != (int)EnvelopeType.ReadAndConfirm;
|
||||
#endif
|
||||
}
|
||||
|
||||
public static bool IsBurned(this IEnvelope envelope)
|
||||
{
|
||||
return envelope.DocResult != null;
|
||||
}
|
||||
|
||||
public static EnvelopeType? Type(this IEnvelope envelope)
|
||||
{
|
||||
if (envelope.EnvelopeTypeId is int envelopeTypeId)
|
||||
return envelopeTypeId.ToEnvelopeType();
|
||||
return null;
|
||||
}
|
||||
|
||||
public static void SetType(this IEnvelope envelope, EnvelopeType type)
|
||||
{
|
||||
envelope.EnvelopeTypeId = (int)type;
|
||||
}
|
||||
|
||||
public static TEnvelope WithType<TEnvelope>(this TEnvelope envelope, EnvelopeType type) where TEnvelope : IEnvelope
|
||||
{
|
||||
envelope.SetType(type);
|
||||
return envelope;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -543,10 +543,11 @@
|
||||
{
|
||||
_validationMessage = null;
|
||||
var raw = args.Value?.ToString();
|
||||
if (int.TryParse(raw, out var id) && id > 0)
|
||||
if (int.TryParse(raw, out var typeInt))
|
||||
{
|
||||
_selectedEnvelopeType = id.ToEnvelopeType();
|
||||
var selectedType = EnvelopeTypes.FirstOrDefault(x => x.Id == id);
|
||||
var type = typeInt.ToEnvelopeType();
|
||||
_selectedEnvelopeType = type;
|
||||
var selectedType = EnvelopeTypes.FirstOrDefault(x => x.Id == type);
|
||||
if (selectedType is not null)
|
||||
ApplyEnvelopeTypeDefaults(selectedType);
|
||||
|
||||
@@ -756,7 +757,7 @@
|
||||
var result = new CreateEnvelopeWizardResult(
|
||||
Title: _title.Trim(),
|
||||
Message: _message.Trim(),
|
||||
EnvelopeTypeId: (int?)_selectedEnvelopeType,
|
||||
Type: _selectedEnvelopeType,
|
||||
Language: string.IsNullOrWhiteSpace(_language) ? "de-DE" : _language,
|
||||
UseAccessCode: _useAccessCode,
|
||||
TFAEnabled: _tfaEnabled,
|
||||
@@ -1085,7 +1086,7 @@
|
||||
if (!_selectedEnvelopeType.HasValue)
|
||||
return;
|
||||
|
||||
var selectedType = EnvelopeTypes.FirstOrDefault(x => x.Id == (int)_selectedEnvelopeType);
|
||||
var selectedType = EnvelopeTypes.FirstOrDefault(x => x.Id == _selectedEnvelopeType);
|
||||
if (selectedType is not null)
|
||||
ApplyEnvelopeTypeDefaults(selectedType);
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ namespace EnvelopeGenerator.Server.Client.Components.Sender;
|
||||
public sealed record CreateEnvelopeWizardResult(
|
||||
string Title,
|
||||
string Message,
|
||||
int? EnvelopeTypeId,
|
||||
EnvelopeType? Type,
|
||||
string Language,
|
||||
bool UseAccessCode,
|
||||
bool TFAEnabled,
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
using EnvelopeGenerator.Domain.Constants;
|
||||
|
||||
namespace EnvelopeGenerator.Server.Client.Models;
|
||||
|
||||
/// <summary>
|
||||
@@ -38,7 +40,7 @@ public record EnvelopeClientDto
|
||||
public DateTime AddedWhen { get; init; }
|
||||
public DateTime? ChangedWhen { get; init; }
|
||||
public string Language { get; init; } = "de-DE";
|
||||
public int? EnvelopeTypeId { get; init; }
|
||||
public EnvelopeType? Type { get; init; }
|
||||
public string? EnvelopeTypeTitle { get; init; }
|
||||
public bool UseAccessCode { get; init; }
|
||||
public bool TFAEnabled { get; init; }
|
||||
|
||||
@@ -100,7 +100,7 @@
|
||||
<div class="sender-settings-grid">
|
||||
<div class="sender-settings-field">
|
||||
<label class="sender-settings-label">@L("EnvelopeType", "Umschlagtyp")</label>
|
||||
<select value="@(_selectedEnvelopeTypeId?.ToString() ?? string.Empty)"
|
||||
<select value="@(_selectedType?.ToString() ?? string.Empty)"
|
||||
@onchange="OnEnvelopeTypeChanged"
|
||||
class="sender-settings-select">
|
||||
<option value="">@L("SenderEditor_SelectTemplate", "Vorlage auswählen")</option>
|
||||
@@ -692,7 +692,7 @@
|
||||
bool _titleTouched = false;
|
||||
|
||||
List<EnvelopeTypeDefaultsDto> _envelopeTypes = [];
|
||||
int? _selectedEnvelopeTypeId;
|
||||
EnvelopeType? _selectedType;
|
||||
string _language = "de-DE";
|
||||
bool _useAccessCode;
|
||||
bool _tfaEnabled;
|
||||
@@ -778,7 +778,7 @@
|
||||
|
||||
_envelopeTitle = envelope.Title ?? string.Empty;
|
||||
_envelopeMessage = envelope.Message ?? string.Empty;
|
||||
_selectedEnvelopeTypeId = envelope.EnvelopeTypeId;
|
||||
_selectedType = envelope.Type;
|
||||
_language = string.IsNullOrWhiteSpace(envelope.Language) ? "de-DE" : envelope.Language;
|
||||
_useAccessCode = envelope.UseAccessCode;
|
||||
_tfaEnabled = envelope.TFAEnabled;
|
||||
@@ -963,13 +963,15 @@
|
||||
Task OnEnvelopeTypeChanged(ChangeEventArgs e)
|
||||
{
|
||||
var raw = e.Value?.ToString();
|
||||
if (!int.TryParse(raw, out var id) || id <= 0)
|
||||
if (!int.TryParse(raw, out var idInt) || idInt <= 0)
|
||||
{
|
||||
_selectedEnvelopeTypeId = null;
|
||||
_selectedType = null;
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
_selectedEnvelopeTypeId = id;
|
||||
var id = idInt.ToEnvelopeType();
|
||||
|
||||
_selectedType = id;
|
||||
var selectedType = _envelopeTypes.FirstOrDefault(x => x.Id == id);
|
||||
if (selectedType is not null)
|
||||
ApplyEnvelopeTypeDefaults(selectedType);
|
||||
@@ -1350,7 +1352,7 @@
|
||||
return new CreateEnvelopeCommand
|
||||
{
|
||||
EnvelopeId = envelopeId,
|
||||
EnvelopeTypeId = _selectedEnvelopeTypeId,
|
||||
Type = _selectedType,
|
||||
Title = _envelopeTitle,
|
||||
Message = _envelopeMessage,
|
||||
Language = _language,
|
||||
|
||||
@@ -796,7 +796,7 @@
|
||||
|
||||
var command = new CreateEnvelopeCommand
|
||||
{
|
||||
EnvelopeTypeId = result.EnvelopeTypeId,
|
||||
Type = result.Type,
|
||||
Title = result.Title,
|
||||
Message = result.Message,
|
||||
Language = string.IsNullOrWhiteSpace(result.Language) ? "de-DE" : result.Language,
|
||||
|
||||
@@ -46,7 +46,7 @@ public sealed class CreateEnvelopeBootstrapStorageService(IJSRuntime jsRuntime)
|
||||
public sealed record CreateEnvelopeBootstrapPayload(
|
||||
string Title,
|
||||
string Message,
|
||||
int? EnvelopeTypeId,
|
||||
EnvelopeType? Type,
|
||||
string Language,
|
||||
bool UseAccessCode,
|
||||
bool TFAEnabled,
|
||||
|
||||
Reference in New Issue
Block a user