Commiting 1.7

Author: SharePointRadi

src/OneBitSoftware.Utilities.OperationResult/Errors/IOperationError.cs

@@ -0,0 +1,10 @@
+namespace OneBitSoftware.Utilities.Errors;
+
+public interface IOperationError
+{
+    int? Code { get; set; }
+
+    string Message { get; set; }
+
+    string? Details { get; set; }
+}

src/OneBitSoftware.Utilities.OperationResult/Errors/OperationError.cs

@@ -2,12 +2,13 @@
 
 using System.Text;
 
-public class OperationError
+public class OperationError : IOperationError
 {
-    public OperationError(string message, int? code = null)
+    public OperationError(string message, int? code = null, string? details = null)
     {
         this.Message = message;
         this.Code = code;
+        this.Details = details;
     }
 
     public int? Code { get; set; }

src/OneBitSoftware.Utilities.OperationResult/OneBitSoftware.Utilities.OperationResult.csproj

@@ -18,7 +18,8 @@
   </ItemGroup>
 
   <PropertyGroup>
-    <PackageId>OneBitSoftware.Utilities.OperationResult</PackageId>
+	  <Authors>OneBit Software</Authors>
+	  <PackageId>OneBitSoftware.Utilities.OperationResult</PackageId>
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>https://github.com/OneBitSoftware/OperationResult</RepositoryUrl>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
@@ -31,7 +32,7 @@
     <PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>OneBitSoftware; OperationResult;</PackageTags>
-    <Version>1.1.6</Version>
+    <Version>1.1.7</Version>
   </PropertyGroup>
 
 </Project>

src/OneBitSoftware.Utilities.OperationResult/OperationResult.cs

@@ -12,7 +12,7 @@
 /// </summary>
 public class OperationResult
 {
-    private readonly List<OperationError> _errors = new();
+    private readonly List<IOperationError> _errors = new();
     private readonly List<string> _successMessages = new();
 
     private readonly ILogger? _logger;
@@ -41,7 +41,7 @@ public IEnumerable<string> SuccessMessages
     /// <summary>
     /// Gets an <see cref="List{T}"/> containing the error codes and messages of the <see cref="OperationResult{T}" />.
     /// </summary>
-    public IReadOnlyCollection<OperationError> Errors => this._errors.AsReadOnly();
+    public IReadOnlyCollection<IOperationError> Errors => this._errors.AsReadOnly();
 
     /// <summary>
     /// Gets or sets the first exception that resulted from the operation.
@@ -97,7 +97,7 @@ public OperationResult AppendErrors(OperationResult otherOperationResult)
     }
 
     /// <summary>
-    /// This method will append an error with a specific `user-friendly` message to this operation result instance.
+    /// This method will append an <see cref="OperationError"/> error with a specific `user-friendly` message to this operation result instance.
     /// </summary>
     /// <param name="message">A label consuming component defining the 'user-friendly' message.</param>
     /// <param name="code">The unique code of the error.</param>
@@ -115,12 +115,32 @@ public OperationResult AppendError(string message, int? code = null, LogLevel? l
     }
 
     /// <summary>
-    /// Appends an <see cref="OperationError"/> to the internal errors collection.
+    /// This method will append an <typeparamref name="T"/> error with a specific `user-friendly` message to this operation result instance.
+    /// </summary>
+    /// <param name="message">A label consuming component defining the 'user-friendly' message.</param>
+    /// <param name="code">The unique code of the error.</param>
+    /// <param name="logLevel">The logging severity.</param>
+    /// <param name="details">A <see cref="string"/> with error details.</param>
+    /// <typeparam name="T">The type of <see cref="IOperationError"/> to append.</typeparam>
+    /// <returns>The current instance of the <see cref="OperationResult"/>.</returns>
+    public OperationResult AppendError<T>(string message, int? code = null, LogLevel? logLevel = null, string? details = null)
+        where T : IOperationError, new()
+    {
+        if (string.IsNullOrWhiteSpace(message)) throw new ArgumentNullException(nameof(message));
+
+        var error = new T() { Message = message, Code = code, Details = details };
+        this.AppendError(error, logLevel);
+
+        return this;
+    }
+
+    /// <summary>
+    /// Appends an <see cref="IOperationError"/> to the internal errors collection.
     /// </summary>
-    /// <param name="error">An instance of <see cref="OperationError"/> to add to the internal errors collection.</param>
+    /// <param name="error">An instance of <see cref="IOperationError"/> to add to the internal errors collection.</param>
     /// <param name="logLevel">The logging level.</param>
     /// <returns>The current instance of the <see cref="OperationResult"/>.</returns>
-    public OperationResult AppendError(OperationError error, LogLevel? logLevel = LogLevel.Error)
+    public OperationResult AppendError(IOperationError error, LogLevel? logLevel = LogLevel.Error)
     {
         this.AppendErrorInternal(error);
 
@@ -191,10 +211,10 @@ public static OperationResult FromError(string message, int? code = null, LogLev
     private static LogLevel GetLogLevel(LogLevel? optionalLevel) => optionalLevel ?? LogLevel.Error;
 
     /// <summary>
-    /// Appends an <see cref="OperationError"/> to the internal errors collection.
+    /// Appends an <see cref="IOperationError"/> to the internal errors collection.
     /// </summary>
-    /// <param name="error">An instance of <see cref="OperationError"/> to add to the internal errors collection.</param>
-    private void AppendErrorInternal(OperationError error) => this._errors.Add(error);
+    /// <param name="error">An instance of <see cref="IOperationError"/> to add to the internal errors collection.</param>
+    private void AppendErrorInternal(IOperationError error) => this._errors.Add(error);
 }
 
 /// <summary>