refactor(Interfaces): move Interfaces to Common

EnvelopeGenerator.Application/Common/Interfaces/SQLExecutor/IDocumentExecutor.cs

@@ -0,0 +1,18 @@
+using EnvelopeGenerator.Domain.Entities;
+
+namespace EnvelopeGenerator.Application.Common.Interfaces.SQLExecutor;
+
+/// <summary>
+/// 
+/// </summary>
+public interface IDocumentExecutor
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="base64"></param>
+    /// <param name="envelope_uuid"></param>
+    /// <param name="cancellation"></param>
+    /// <returns></returns>
+    Task<Document> CreateDocumentAsync(string base64, string envelope_uuid, CancellationToken cancellation = default);
+}

EnvelopeGenerator.Application/Common/Interfaces/SQLExecutor/IEnvelopeExecutor.cs

@@ -0,0 +1,21 @@
+using Dapper;
+using EnvelopeGenerator.Domain.Entities;
+
+namespace EnvelopeGenerator.Application.Common.Interfaces.SQLExecutor;
+
+/// <summary>
+/// 
+/// </summary>
+public interface IEnvelopeExecutor : ISQLExecutor
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="userId"></param>
+    /// <param name="title"></param>
+    /// <param name="message"></param>
+    /// <param name="tfaEnabled"></param>
+    /// <param name="cancellation"></param>
+    /// <returns></returns>
+    Task<Envelope> CreateEnvelopeAsync(int userId, string title = "", string message = "", bool tfaEnabled = false, CancellationToken cancellation = default);
+}

EnvelopeGenerator.Application/Common/Interfaces/SQLExecutor/IEnvelopeReceiverExecutor.cs

@@ -0,0 +1,20 @@
+using EnvelopeGenerator.Domain.Entities;
+
+namespace EnvelopeGenerator.Application.Common.Interfaces.SQLExecutor;
+
+/// <summary>
+/// 
+/// </summary>
+public interface IEnvelopeReceiverExecutor
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="envelope_uuid"></param>
+    /// <param name="emailAddress"></param>
+    /// <param name="salutation"></param>
+    /// <param name="phone"></param>
+    /// <param name="cancellation"></param>
+    /// <returns></returns>
+    Task<EnvelopeReceiver?> AddEnvelopeReceiverAsync(string envelope_uuid, string emailAddress, string? salutation = null, string? phone = null, CancellationToken cancellation = default);
+}

EnvelopeGenerator.Application/Common/Interfaces/SQLExecutor/IQuery.cs

@@ -0,0 +1,70 @@
+namespace EnvelopeGenerator.Application.Common.Interfaces.SQLExecutor;
+
+/// <summary>
+/// Provides methods for executing common queries on a given entity type.
+/// This interface abstracts away the direct usage of ORM libraries (such as Entity Framework) for querying data
+/// and provides asynchronous and synchronous operations for querying a collection or single entity.
+/// </summary>
+/// <typeparam name="TEntity">The type of the entity being queried.</typeparam>
+public interface IQuery<TEntity>
+{
+    /// <summary>
+    /// Asynchronously retrieves the first entity or a default value if no entity is found.
+    /// </summary>
+    /// <returns>A task that represents the asynchronous operation. The task result contains the entity or a default value.</returns>
+    public Task<TEntity?> FirstOrDefaultAsync();
+
+    /// <summary>
+    /// Asynchronously retrieves a single entity or a default value if no entity is found.
+    /// </summary>
+    /// <returns>A task that represents the asynchronous operation. The task result contains the entity or a default value.</returns>
+    public Task<TEntity?> SingleOrDefaultAsync();
+
+    /// <summary>
+    /// Asynchronously retrieves a list of entities.
+    /// </summary>
+    /// <returns>A task that represents the asynchronous operation. The task result contains the list of entities.</returns>
+    public Task<IEnumerable<TEntity>> ToListAsync();
+
+    /// <summary>
+    /// Asynchronously retrieves the first entity. Throws an exception if no entity is found.
+    /// </summary>
+    /// <returns>A task that represents the asynchronous operation. The task result contains the first entity.</returns>
+    public Task<TEntity> FirstAsync();
+
+    /// <summary>
+    /// Asynchronously retrieves a single entity. Throws an exception if no entity is found.
+    /// </summary>
+    /// <returns>A task that represents the asynchronous operation. The task result contains the single entity.</returns>
+    public Task<TEntity> SingleAsync();
+
+    /// <summary>
+    /// Synchronously retrieves the first entity or a default value if no entity is found.
+    /// </summary>
+    /// <returns>The first entity or a default value.</returns>
+    public TEntity? FirstOrDefault();
+
+    /// <summary>
+    /// Synchronously retrieves a single entity or a default value if no entity is found.
+    /// </summary>
+    /// <returns>The single entity or a default value.</returns>
+    public TEntity? SingleOrDefault();
+
+    /// <summary>
+    /// Synchronously retrieves a list of entities.
+    /// </summary>
+    /// <returns>The list of entities.</returns>
+    public IEnumerable<TEntity> ToList();
+
+    /// <summary>
+    /// Synchronously retrieves the first entity. Throws an exception if no entity is found.
+    /// </summary>
+    /// <returns>The first entity.</returns>
+    public TEntity First();
+
+    /// <summary>
+    /// Synchronously retrieves a single entity. Throws an exception if no entity is found.
+    /// </summary>
+    /// <returns>The single entity.</returns>
+    public TEntity Single();
+}

EnvelopeGenerator.Application/Common/Interfaces/SQLExecutor/ISQL.cs

@@ -0,0 +1,20 @@
+namespace EnvelopeGenerator.Application.Common.Interfaces.SQLExecutor;
+
+/// <summary>
+/// Represents a raw SQL query contract.
+/// </summary>
+public interface ISQL
+{
+    /// <summary>
+    /// Gets the raw SQL query string.
+    /// </summary>
+    string Raw { get; }
+}
+
+/// <summary>
+/// Represents a typed SQL query contract for a specific entity.
+/// </summary>
+/// <typeparam name="TEntity">The type of the entity associated with the SQL query.</typeparam>
+public interface ISQL<TEntity> : ISQL
+{
+}

EnvelopeGenerator.Application/Common/Interfaces/SQLExecutor/ISQLExecutor.cs

@@ -0,0 +1,27 @@
+namespace EnvelopeGenerator.Application.Common.Interfaces.SQLExecutor;
+
+/// <summary>
+/// Defines methods for executing raw SQL queries or custom SQL query classes and returning query executors for further operations.
+/// Provides abstraction for raw SQL execution as well as mapping the results to <typeparamref name="TEntity"/> objects.
+/// </summary>
+/// <typeparam name="TEntity">The entity type to which the SQL query results will be mapped.</typeparam>
+public interface ISQLExecutor<TEntity>: ISQLExecutor
+{
+    /// <summary>
+    /// Executes a raw SQL query and returns an <see cref="IQuery{TEntity}"/> for further querying operations on the result.
+    /// </summary>
+    /// <param name="sql">The raw SQL query to execute.</param>
+    /// <param name="cancellation">Optional cancellation token for the operation.</param>
+    /// <param name="parameters">Optional parameters for the SQL query.</param>
+    /// <returns>An <see cref="IQuery{TEntity}"/> instance for further query operations on the result.</returns>
+    IQuery<TEntity> Execute(string sql, CancellationToken cancellation = default, params object[] parameters);
+
+    /// <summary>
+    /// Executes a custom SQL query defined by a class that implements <see cref="ISQL{TEntity}"/> and returns an <see cref="IQuery{TEntity}"/> for further querying operations on the result.
+    /// </summary>
+    /// <typeparam name="TSQL">The type of the custom SQL query class implementing <see cref="ISQL{TEntity}"/>.</typeparam>
+    /// <param name="cancellation">Optional cancellation token for the operation.</param>
+    /// <param name="parameters">Optional parameters for the SQL query.</param>
+    /// <returns>An <see cref="IQuery{TEntity}"/> instance for further query operations on the result.</returns>
+    IQuery<TEntity> Execute<TSQL>(CancellationToken cancellation = default, params object[] parameters) where TSQL : ISQL<TEntity>;
+}

EnvelopeGenerator.Application/Common/Interfaces/SQLExecutor/ISQLExecutorBaseEntity.cs

@@ -0,0 +1,29 @@
+using Dapper;
+
+namespace EnvelopeGenerator.Application.Common.Interfaces.SQLExecutor;
+
+/// <summary>
+/// 
+/// </summary>
+public interface ISQLExecutor
+{
+    /// <summary>
+    /// Executes a raw SQL query and returns an <see cref="IQuery{TEntity}"/> for further querying operations on the result.
+    /// </summary>
+    /// <typeparam name="TEntity">The entity type to which the SQL query results will be mapped.</typeparam>
+    /// <param name="sql">The raw SQL query to execute.</param>
+    /// <param name="parameters">Parameters for the SQL query.</param>
+    /// <param name="cancellation">Optional cancellation token for the operation.</param>
+    /// <returns>An <see cref="IQuery{TEntity}"/> instance for further query operations on the result.</returns>
+    Task<IEnumerable<TEntity>> Execute<TEntity>(string sql, DynamicParameters parameters, CancellationToken cancellation = default);
+
+    /// <summary>
+    /// Executes a custom SQL query defined by a class that implements <see cref="ISQL{TEntity}"/> and returns an <see cref="IQuery{TEntity}"/> for further querying operations on the result.
+    /// </summary>
+    /// <typeparam name="TEntity">The entity type to which the SQL query results will be mapped.</typeparam>
+    /// <typeparam name="TSQL">The type of the custom SQL query class implementing <see cref="ISQL{TEntity}"/>.</typeparam>
+    /// <param name="parameters">Parameters for the SQL query.</param>
+    /// <param name="cancellation">Optional cancellation token for the operation.</param>
+    /// <returns>An <see cref="IQuery{TEntity}"/> instance for further query operations on the result.</returns>
+    Task<IEnumerable<TEntity>> Execute<TEntity, TSQL>(DynamicParameters parameters, CancellationToken cancellation = default) where TSQL : ISQL;
+}