DigitalData.Core/DigitalData.Core.Application/ServiceMessage.cs

using DigitalData.Core.Contracts.Application;
using System.Text.Json.Serialization;

namespace DigitalData.Core.Application
{
    /// <summary>
    /// Represents the outcome of a service operation, encapsulating the success or failure status,
    /// and any associated messages. It also supports optional translation of message keys for localization purposes.
    /// </summary>
    public class ServiceMessage : IServiceMessage
    {
        /// <summary>
        /// Initializes a new instance of the ServiceMessage class.
        /// </summary>
        public ServiceMessage()
        {
        }

        /// <summary>
        /// Initializes a new instance of the ServiceMessage class, specifying the success status.
        /// Optionally, a function for translating message keys can be provided.
        /// If a translation function is provided, it will be used for both string and enum message keys.
        /// </summary>
        /// <param name="isSuccess">Indicates whether the service operation was successful.</param>
        /// If provided, it will also be adapted for translating enum keys by converting them to strings first.</param>
        [Obsolete("Deprecated: initialize objects using object initializer.")]
        public ServiceMessage(bool isSuccess)
        {
            IsSuccess = isSuccess;
        }

        /// <summary>
        /// Initializes a new instance of the ServiceMessage class with specified success status, and messages.
        /// </summary>
        /// <param name="isSuccess">Indicates whether the service operation was successful.</param>
        /// <param name="messages">An array of messages related to the operation's outcome.</param>
        [Obsolete("Deprecated: initialize objects using object initializer.")]
        public ServiceMessage(bool isSuccess, params string[] messages)
        {
            IsSuccess = isSuccess;
            Messages = messages.ToList<string>(); 
        }

        /// <summary>
        /// Gets or sets a value indicating whether the service operation was successful.
        /// </summary>
        public bool IsSuccess { get; set; } = false;

        /// <summary>
        /// Gets or sets the flag that indicates the specific status type of the service operation.
        /// This flag helps in categorizing the state of the operation more granularly.
        /// </summary>
        [JsonIgnore]
        public Enum Flag { get; set; } = Application.Flag.Null;

        /// <summary>
        /// Checks if the current service message's flag matches the specified flag.
        /// This method is useful for conditional logic based on the status of the operation.
        /// </summary>
        /// <param name="flag">The flag to check against the current service message's flag.</param>
        /// <returns>true if the flags match; otherwise, false.</returns>
        public bool HasFlag(Enum flag) => Flag.ToString() == flag.ToString();

        /// <summary>
        /// [Obsolete("Deprecated: Use ClientMessages instead.")]
        /// Gets a collection of messages associated with the service operation. These messages can be error descriptions,
        /// success notifications, or other relevant information related to the operation's outcome.
        /// </summary>
        [Obsolete("Deprecated: Use ClientMessages instead.")]
        public List<string> Messages { get; init; } = new();

        /// <summary>
        /// Gets a collection of messages intended for client display. This replaces the deprecated 'Messages' property.
        /// </summary>
        public List<string> ClientMessages { get; init; } = new();

        /// <summary>
        /// Gets a collection of messages used for tracing program execution at a fine-grained level. These are typically voluminous and detailed.
        /// </summary>
        [JsonIgnore]
        public List<string> TraceMessages { get; init; } = new();

        /// <summary>
        /// Gets a collection of messages helpful for debugging during development. These messages are often diagnostic.
        /// </summary>
        [JsonIgnore]
        public List<string> DebugMessages { get; init; } = new();

        /// <summary>
        /// Gets a collection of informational messages, less critical than warnings, generally used for non-critical notifications.
        /// </summary>
        [JsonIgnore]
        public List<string> InformationMessages { get; init; } = new();

        /// <summary>
        /// Gets a collection of messages indicating potential issues that are not necessarily errors, but which may require attention.
        /// </summary>
        [JsonIgnore]
        public List<string> WarningMessages { get; init; } = new();

        /// <summary>
        /// Gets a collection of error messages indicating failures or problems within the service.
        /// </summary>
        [JsonIgnore]
        public List<string> ErrorMessages { get; init; } = new();

        /// <summary>
        /// Gets a collection of messages indicating critical issues that require immediate attention.
        /// </summary>
        [JsonIgnore]
        public List<string> CriticalMessages { get; init; } = new();

        /// <summary>
        /// A function that translates a message key from a string to its localized or transformed representation.
        /// This property allows for custom translation logic to be applied based on the application's needs.
        /// </summary>
        [JsonIgnore]
        public Func<string, string> KeyTranslator { get; init; } = key => key;

        /// <summary>
        /// Adds a new message to the collection of messages associated with the service operation.
        /// </summary>
        /// <param name="message">The message to add.</param>
        /// <returns>The current instance of ServiceMessage, allowing for method chaining.</returns>
        [Obsolete("Deprecated: Use ClientMessages instead.")]
        public IServiceMessage WithMessage(string message)
        {
            Messages.Add(message);
            return this;
        }

        /// <summary>
        /// Adds a message corresponding to the specified message key to the collection of messages associated with the service operation.
        /// This method uses the string representation of the enum value as the message.
        /// </summary>
        /// <param name="messageKey">The enum value representing the message key.</param>
        /// <returns>The current instance of ServiceMessage, allowing for method chaining.</returns>
        [Obsolete("Deprecated: Use ClientMessages instead.")]
        public IServiceMessage WithMessageKey(Enum messageKey)
        {
            Messages.Add(messageKey.ToString());
            return this;
        }
    }
}