Add audit interfaces and fields to domain entities

Introduced interfaces for audit fields (AddedWhen, ChangedWhen, ChangedWho, AddedWho) and updated domain entities to implement them. Adjusted properties for consistency and nullability. Updated MappingProfile to map audit fields between DTOs and entities. Improves auditability and standardization across the domain model.

EnvelopeGenerator.Application/Common/Dto/MappingProfile.cs

@@ -28,8 +28,8 @@ public class MappingProfile : Profile
         CreateMap<EmailTemplate, EmailTemplateDto>();
         CreateMap<Envelope, EnvelopeDto>();
         CreateMap<Document, DocumentDto>();
-        CreateMap<Domain.Entities.History, HistoryDto>();
+        CreateMap<Domain.Entities.History, HistoryDto>().ForMember(dest => dest.ActionDate, opt => opt.MapFrom(src => src.ChangedWhen));
-        CreateMap<Domain.Entities.History, HistoryCreateDto>();
+        CreateMap<Domain.Entities.History, HistoryCreateDto>().ForMember(dest => dest.ActionDate, opt => opt.MapFrom(src => src.ChangedWhen));
         CreateMap<Domain.Entities.EnvelopeReceiver, EnvelopeReceiverDto>();
         CreateMap<Domain.Entities.EnvelopeReceiver, EnvelopeReceiverSecretDto>();
         CreateMap<EnvelopeType, EnvelopeTypeDto>();
@@ -44,8 +44,8 @@ public class MappingProfile : Profile
         CreateMap<EmailTemplateDto, EmailTemplate>();
         CreateMap<EnvelopeDto, Envelope>();
         CreateMap<DocumentDto, Document>();
-        CreateMap<HistoryDto, Domain.Entities.History>();
+        CreateMap<HistoryDto, Domain.Entities.History>().ForMember(dest => dest.ChangedWhen, opt => opt.MapFrom(src => src.ActionDate));
-        CreateMap<HistoryCreateDto, Domain.Entities.History>();
+        CreateMap<HistoryCreateDto, Domain.Entities.History>().ForMember(dest => dest.ChangedWhen, opt => opt.MapFrom(src => src.ActionDate));
         CreateMap<EnvelopeReceiverDto, Domain.Entities.EnvelopeReceiver>();
         CreateMap<EnvelopeTypeDto, EnvelopeType>();
         CreateMap<ReceiverDto, Domain.Entities.Receiver>().ForMember(rcv => rcv.EnvelopeReceivers, rcvReadDto => rcvReadDto.Ignore());

EnvelopeGenerator.Domain/Entities/Document.cs

@@ -1,4 +1,5 @@
-using EnvelopeGenerator.Domain.Interfaces;
+using System;
+using EnvelopeGenerator.Domain.Interfaces;
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 #if NETFRAMEWORK
@@ -11,11 +12,11 @@ namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_ENVELOPE_DOCUMENT", Schema = "dbo")]
-public class Document : IHasEnvelope
+public class Document : IHasEnvelope, IHasAddedWhen
 {
     public Document()
     {
@@ -36,9 +37,13 @@ public class Document : IHasEnvelope
         = 0;
 #endif
 
+    [Required]
+    [Column("ADDED_WHEN", TypeName = "datetime")]
+    public DateTime AddedWhen { get; set; }
+
     [Column("BYTE_DATA", TypeName = "varbinary(max)")]
     public byte[]
-#if NET
+#if nullable
         ?
 #endif
         ByteData { get; set; }
@@ -52,21 +57,21 @@ public class Document : IHasEnvelope
 
     [Column("FILENAME_ORIGINAL", TypeName = "nvarchar(256)")]
     public string
-#if NET
+#if nullable
         ?
 #endif
         FileNameOriginal { get; set; }
     #endregion
 
     public virtual List<Signature>
-#if NET
+#if nullable
         ?
 #endif
         Elements { get; set; }
 
     [ForeignKey("EnvelopeId")]
     public virtual Envelope
-#if NET
+#if nullable
         ?
 #endif
         Envelope { get; set; }

EnvelopeGenerator.Domain/Entities/DocumentStatus.cs

@@ -1,21 +1,21 @@
-using System.ComponentModel.DataAnnotations;
+using System;
+using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 using DigitalData.Core.Abstractions.Interfaces;
 using EnvelopeGenerator.Domain.Interfaces;
 
 #if NETFRAMEWORK
-using System;
 #endif
 
 namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_DOCUMENT_STATUS", Schema = "dbo")]
-public class DocumentStatus : IHasEnvelope, IHasReceiver, IEntity
+public class DocumentStatus : IHasEnvelope, IHasReceiver, IEntity, IHasAddedWhen, IHasChangedWhen
 {
     public DocumentStatus()
     {
@@ -42,6 +42,13 @@ public class DocumentStatus : IHasEnvelope, IHasReceiver, IEntity
     [Column("STATUS")]
     public Constants.DocumentStatus Status { get; set; }
 
+    [Required]
+    [Column("ADDED_WHEN", TypeName = "datetime")]
+    public DateTime AddedWhen { get; set; }
+
+    [Column("CHANGED_WHEN", TypeName = "datetime")]
+    public DateTime? ChangedWhen { get; set; }
+
     [Column("VALUE", TypeName = "nvarchar(max)")]
     public string Value { get; set; }
 

EnvelopeGenerator.Domain/Entities/ElementAnnotation.cs

@@ -1,18 +1,19 @@
-using System.ComponentModel.DataAnnotations;
+using System;
+using EnvelopeGenerator.Domain.Interfaces;
+using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 #if NETFRAMEWORK
-using System;
 #endif
 
 namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_DOCUMENT_RECEIVER_ELEMENT_ANNOTATION")]
-public class ElementAnnotation
+public class ElementAnnotation : IHasAddedWhen, IHasChangedWhen, IHasChangedWho
 {
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
@@ -74,14 +75,14 @@ public class ElementAnnotation
     [Column("CHANGED_WHO", TypeName = "nvarchar(100)")]
     [StringLength(100)]
     public string
-#if NET
+#if nullable
         ?
 #endif
         ChangedWho { get; set; }
 
     [ForeignKey("ElementId")]
     public virtual Signature
-#if NET
+#if nullable
         ?
 #endif
         Element { get; set; }

EnvelopeGenerator.Domain/Entities/EmailTemplate.cs

@@ -1,20 +1,21 @@
-using DigitalData.Core.Abstractions.Interfaces;
+using System;
+using DigitalData.Core.Abstractions.Interfaces;
+using EnvelopeGenerator.Domain.Interfaces;
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 #if NETFRAMEWORK
-using System;
 #endif
 
 namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_EMAIL_TEMPLATE", Schema = "dbo")]
-public class EmailTemplate : IEntity
+public class EmailTemplate : IEntity, IHasAddedWhen, IHasChangedWhen
 {
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
@@ -36,7 +37,7 @@ public class EmailTemplate : IEntity
     public DateTime AddedWhen { get; set; }
 
     [Column("CHANGED_WHEN", TypeName = "datetime")]
-    public DateTime ChangedWhen { get; set; }
+    public DateTime? ChangedWhen { get; set; }
 }
 
 #if NETFRAMEWORK

EnvelopeGenerator.Domain/Entities/Envelope.cs

@@ -1,11 +1,12 @@
-using DigitalData.UserManager.Domain.Entities;
+using System;
+using EnvelopeGenerator.Domain.Interfaces;
+using DigitalData.UserManager.Domain.Entities;
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 using EnvelopeGenerator.Domain.Constants;
 using Newtonsoft.Json;
 
 #if NETFRAMEWORK
-using System;
 using System.Collections.Generic;
 using System.Linq;
 #endif
@@ -14,11 +15,11 @@ namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_ENVELOPE", Schema = "dbo")]
-public class Envelope
+public class Envelope : IHasAddedWhen, IHasChangedWhen
 {
     public Envelope()
     {
@@ -77,7 +78,7 @@ public class Envelope
 
     [Column("TITLE", TypeName = "nvarchar(128)")]
     public string
-#if NET
+#if nullable
         ?
 #endif
         Title { get; set; }
@@ -142,15 +143,14 @@ public class Envelope
     [NotMapped]
     [Column("DOC_RESULT")]
     public byte[]
-#if NET
+#if nullable
         ?
 #endif
-        DocResult
+        DocResult { get; set; }
-    { get; set; }
 
     [ForeignKey("EnvelopeTypeId")]
     public virtual EnvelopeType
-#if NET
+#if nullable
         ?
 #endif
         Type { get; set; }
@@ -164,19 +164,19 @@ public class Envelope
 #endif
 
     public List<Document>
-#if NET
+#if nullable
         ?
 #endif
         Documents { get; set; }
 
     public List<History>
-#if NET
+#if nullable
         ?
 #endif
         Histories { get; set; }
 
     public List<EnvelopeReceiver>
-#if NET
+#if nullable
         ?
 #endif
         EnvelopeReceivers { get; set; }

EnvelopeGenerator.Domain/Entities/EnvelopeReceiver.cs

@@ -1,21 +1,21 @@
-using System.ComponentModel.DataAnnotations;
+using System;
+using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 using DigitalData.Core.Abstractions.Interfaces;
 using EnvelopeGenerator.Domain.Interfaces;
 
 #if NETFRAMEWORK
-using System;
 #endif
 
 namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_ENVELOPE_RECEIVER", Schema = "dbo")]
-public class EnvelopeReceiver : IHasEnvelope, IHasReceiver, IEntity
+public class EnvelopeReceiver : IHasEnvelope, IHasReceiver, IEntity, IHasAddedWhen, IHasChangedWhen
 {
     public EnvelopeReceiver()
     {
@@ -42,7 +42,7 @@ public class EnvelopeReceiver : IHasEnvelope, IHasReceiver, IEntity
 
     [Column("COMPANY_NAME", TypeName = "nvarchar(128)")]
     public string
-#if NET
+#if nullable
         ?
 #endif
         CompanyName { get; set; }
@@ -58,7 +58,7 @@ public class EnvelopeReceiver : IHasEnvelope, IHasReceiver, IEntity
     public DateTime AddedWhen { get; set; }
 
     [Column("CHANGED_WHEN", TypeName = "datetime")]
-    public DateTime ChangedWhen { get; set; }
+    public DateTime? ChangedWhen { get; set; }
 
     [Column("PHONE_NUMBER")]
     [StringLength(20)]
@@ -73,14 +73,14 @@ public class EnvelopeReceiver : IHasEnvelope, IHasReceiver, IEntity
 
     [ForeignKey("EnvelopeId")]
     public Envelope
-#if NET
+#if nullable
         ?
 #endif
             Envelope { get; set; }
 
     [ForeignKey("ReceiverId")]
     public Receiver
-#if NET
+#if nullable
         ?
 #endif
             Receiver { get; set; }

EnvelopeGenerator.Domain/Entities/EnvelopeReceiverReadOnly.cs

@@ -1,14 +1,13 @@
-using System.ComponentModel.DataAnnotations.Schema;
+using System;
+using System.ComponentModel.DataAnnotations.Schema;
 using System.ComponentModel.DataAnnotations;
+using EnvelopeGenerator.Domain.Interfaces;
 using DigitalData.EmailProfilerDispatcher.Abstraction.Attributes;
-#if NETFRAMEWORK
-using System;
-#endif
 
 namespace EnvelopeGenerator.Domain.Entities
 {
     [Table("TBSIG_ENVELOPE_RECEIVER_READ_ONLY")]
-    public class EnvelopeReceiverReadOnly
+    public class EnvelopeReceiverReadOnly : IHasAddedWhen, IHasChangedWhen, IHasAddedWho
     {
         [Key]
         [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
@@ -42,16 +41,12 @@ namespace EnvelopeGenerator.Domain.Entities
 
         [Column("ADDED_WHEN")]
         [Required]
-        public DateTime
+        public DateTime AddedWhen { get; set; }
-#if NET
-            ?
-#endif
-            AddedWhen { get; set; }
 
         [Column("CHANGED_WHO")]
         [StringLength(100)]
         public string
-#if NET
+#if nullable
             ?
 #endif
             ChangedWho { get; set; }

EnvelopeGenerator.Domain/Entities/History.cs

@@ -1,24 +1,20 @@
-using DigitalData.UserManager.Domain.Entities;
+using System;
+using DigitalData.UserManager.Domain.Entities;
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 using EnvelopeGenerator.Domain.Interfaces;
 using EnvelopeGenerator.Domain.Constants;
 using DigitalData.Core.Abstractions.Interfaces;
 
-
-#if NETFRAMEWORK
-using System;
-#endif
-
 namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_ENVELOPE_HISTORY", Schema = "dbo")]
-public class History : IHasEnvelope, IHasReceiver, IEntity
+public class History : IHasEnvelope, IHasReceiver, IEntity, IHasAddedWhen, IHasChangedWhen
 {
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
@@ -43,7 +39,7 @@ public class History : IHasEnvelope, IHasReceiver, IEntity
     public DateTime AddedWhen { get; set; }
 
     [Column("ACTION_DATE", TypeName = "datetime")]
-    public DateTime? ActionDate { get; set; } = DateTime.Now;
+    public DateTime? ChangedWhen { get; set; }
     
     [Column("COMMENT", TypeName = "nvarchar(max)")]
     public string

EnvelopeGenerator.Domain/Entities/Receiver.cs

@@ -1,8 +1,9 @@
-using System.ComponentModel.DataAnnotations;
+using System;
+using EnvelopeGenerator.Domain.Interfaces;
+using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 using System.Drawing;
 #if NETFRAMEWORK
-using System;
 using System.Collections.Generic;
 #endif
 
@@ -10,11 +11,11 @@ namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_RECEIVER", Schema = "dbo")]
-public class Receiver
+public class Receiver : IHasAddedWhen
 {
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]

EnvelopeGenerator.Domain/Entities/Signature.cs

@@ -1,9 +1,9 @@
-using EnvelopeGenerator.Domain.Interfaces;
+using System;
+using EnvelopeGenerator.Domain.Interfaces;
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 #if NETFRAMEWORK
-using System;
 using System.Collections.Generic;
 #endif
 
@@ -11,11 +11,11 @@ namespace EnvelopeGenerator.Domain.Entities
 #if NET
     ;
 #elif NETFRAMEWORK
-    {
+{
 #endif
 
 [Table("TBSIG_DOCUMENT_RECEIVER_ELEMENT", Schema = "dbo")]
-public class Signature : ISignature, IHasReceiver
+public class Signature : ISignature, IHasReceiver, IHasAddedWhen, IHasChangedWhen, IHasChangedWho
 {
     public Signature()
     {
@@ -92,14 +92,14 @@ public class Signature : ISignature, IHasReceiver
     [Required]
     [Column("ADDED_WHEN", TypeName = "datetime")]
     [DefaultValue("GETDATE()")]
-    public DateTime? AddedWhen { get; set; }
+    public DateTime AddedWhen { get; set; }
 
     [Column("CHANGED_WHEN", TypeName = "datetime")]
     public DateTime? ChangedWhen { get; set; }
 
     [Column("CHANGED_WHO", TypeName = "nvarchar(100)")]
     public string
-#if NET
+#if nullable
         ?
 #endif
         ChangedWho { get; set; }
@@ -109,13 +109,13 @@ public class Signature : ISignature, IHasReceiver
 
     [ForeignKey("ReceiverId")]
     public virtual Receiver
-#if NET
+#if nullable
         ?
 #endif
         Receiver { get; set; }
 
     public virtual IEnumerable<ElementAnnotation>
-#if NET
+#if nullable
         ?
 #endif
         Annotations { get; set; }

EnvelopeGenerator.Domain/Interfaces/IHasAddedWhen.cs

@@ -0,0 +1,11 @@
+#if NETFRAMEWORK
+using System;
+#endif
+
+namespace EnvelopeGenerator.Domain.Interfaces
+{
+    public interface IHasAddedWhen
+    {
+        DateTime AddedWhen { get; set; }
+    }
+}

EnvelopeGenerator.Domain/Interfaces/IHasAddedWho.cs

@@ -0,0 +1,11 @@
+#if NETFRAMEWORK
+using System;
+#endif
+
+namespace EnvelopeGenerator.Domain.Interfaces
+{
+    public interface IHasAddedWho
+    {
+        string AddedWho { get; set; }
+    }
+}

EnvelopeGenerator.Domain/Interfaces/IHasChangedWhen.cs

@@ -0,0 +1,11 @@
+#if NETFRAMEWORK
+using System;
+#endif
+
+namespace EnvelopeGenerator.Domain.Interfaces
+{
+    public interface IHasChangedWhen
+    {
+        DateTime? ChangedWhen { get; set; }
+    }
+}

EnvelopeGenerator.Domain/Interfaces/IHasChangedWho.cs

@@ -0,0 +1,11 @@
+namespace EnvelopeGenerator.Domain.Interfaces
+{
+    public interface IHasChangedWho
+    {
+        string
+#if nullable
+            ?
+#endif
+            ChangedWho { get; set; }
+    }
+}