Add PaginatedResult and replace all Result<IEnumerable<T>> with it

#58

Author: ziagham

src/FlowSynx.Client/Messages/Responses/PaginatedResult.cs

@@ -0,0 +1,113 @@
+namespace FlowSynx.Client.Messages.Responses;
+
+public class PaginatedResult<T> : Result<List<T>>
+{
+    private PaginatedResult()
+    {
+    }
+
+    private PaginatedResult(
+        bool succeeded,
+        List<T>? data,
+        List<string>? messages,
+        int totalCount,
+        int page,
+        int pageSize)
+    {
+        Succeeded = succeeded;
+        Messages = messages ?? new List<string>();
+        Data = data ?? new List<T>();
+        TotalCount = Math.Max(totalCount, 0);
+        PageSize = NormalizePageSize(pageSize, TotalCount);
+        CurrentPage = NormalizePage(page);
+        TotalPages = PageSize == 0
+            ? 0
+            : (int)Math.Ceiling(TotalCount / (double)PageSize);
+    }
+
+    public int CurrentPage { get; private set; }
+
+    public int TotalPages { get; private set; }
+
+    public int TotalCount { get; private set; }
+
+    public int PageSize { get; private set; }
+
+    public bool HasPreviousPage => CurrentPage > 1;
+
+    public bool HasNextPage => CurrentPage < TotalPages;
+
+    public static PaginatedResult<T> Success(
+        List<T> data,
+        int totalCount,
+        int page,
+        int pageSize)
+    {
+        return new PaginatedResult<T>(true, data, null, totalCount, page, pageSize);
+    }
+
+    public static PaginatedResult<T> Success(List<T> data)
+    {
+        var list = data ?? new List<T>();
+        return new PaginatedResult<T>(true, list, null, list.Count, 1, list.Count == 0 ? 1 : list.Count);
+    }
+
+    public static PaginatedResult<T> Failure()
+    {
+        return new PaginatedResult<T>(false, default, null, 0, 1, 1);
+    }
+
+    public static PaginatedResult<T> Failure(string message)
+    {
+        return new PaginatedResult<T>(false, default, new List<string> { message }, 0, 1, 1);
+    }
+
+    public static PaginatedResult<T> Failure(List<string> messages)
+    {
+        return new PaginatedResult<T>(false, default, messages, 0, 1, 1);
+    }
+
+    public static Task<PaginatedResult<T>> SuccessAsync(
+        List<T> data,
+        int totalCount,
+        int page,
+        int pageSize)
+    {
+        return Task.FromResult(Success(data, totalCount, page, pageSize));
+    }
+
+    public static Task<PaginatedResult<T>> SuccessAsync(List<T> data)
+    {
+        return Task.FromResult(Success(data));
+    }
+
+    public static Task<PaginatedResult<T>> FailureAsync()
+    {
+        return Task.FromResult(Failure());
+    }
+
+    public static Task<PaginatedResult<T>> FailureAsync(string message)
+    {
+        return Task.FromResult(Failure(message));
+    }
+
+    public static Task<PaginatedResult<T>> FailureAsync(List<string> messages)
+    {
+        return Task.FromResult(Failure(messages));
+    }
+
+    private static int NormalizePage(int page)
+    {
+        return page < 1 ? 1 : page;
+    }
+
+    private static int NormalizePageSize(int pageSize, int totalCount)
+    {
+        if (pageSize < 1)
+        {
+            return totalCount == 0 ? 1 : totalCount;
+        }
+
+        return pageSize;
+    }
+}

src/FlowSynx.Client/Services/AuditService.cs

@@ -17,7 +17,7 @@ public class AuditService : IAuditService
     public AuditService(IHttpRequestHandler httpRequestHandler) =>
         _httpRequestHandler = httpRequestHandler;
 
-    public async Task<HttpResult<Result<IEnumerable<AuditsListResponse>>>> ListAsync(
+    public async Task<HttpResult<PaginatedResult<AuditsListResponse>>> ListAsync(
         CancellationToken cancellationToken = default)
     {
         var requestMessage = new Request
@@ -27,7 +27,7 @@ public async Task<HttpResult<Result<IEnumerable<AuditsListResponse>>>> ListAsync
         };
 
         return await _httpRequestHandler
-            .SendRequestAsync<Result<IEnumerable<AuditsListResponse>>>(requestMessage, cancellationToken);
+            .SendRequestAsync< PaginatedResult < AuditsListResponse>>(requestMessage, cancellationToken);
     }
 
     public async Task<HttpResult<Result<AuditDetailsResponse>>> DetailsAsync(

src/FlowSynx.Client/Services/IAuditService.cs

@@ -17,7 +17,7 @@ public interface IAuditService
     /// A task that represents the asynchronous operation. The task result contains an
     /// <see cref="HttpResult{T}"/> with a <see cref="Result{T}"/> holding a collection of <see cref="AuditsListResponse"/>.
     /// </returns>
-    Task<HttpResult<Result<IEnumerable<AuditsListResponse>>>> ListAsync(
+    Task<HttpResult<PaginatedResult<AuditsListResponse>>> ListAsync(
         CancellationToken cancellationToken = default);
 
     /// <summary>

src/FlowSynx.Client/Services/ILogsService.cs

@@ -18,7 +18,7 @@ public interface ILogsService
     /// A task that represents the asynchronous operation. The task result contains an
     /// <see cref="HttpResult{T}"/> with a <see cref="Result{T}"/> holding a collection of <see cref="LogsListResponse"/>.
     /// </returns>
-    Task<HttpResult<Result<IEnumerable<LogsListResponse>>>> ListAsync(
+    Task<HttpResult<PaginatedResult<LogsListResponse>>> ListAsync(
         LogsListRequest request,
         CancellationToken cancellationToken = default);
 }

src/FlowSynx.Client/Services/IPluginConfigService.cs

@@ -17,7 +17,7 @@ public interface IPluginConfigService
     /// A task that represents the asynchronous operation. The task result contains an
     /// <see cref="HttpResult{T}"/> with a <see cref="Result{T}"/> holding a collection of <see cref="PluginConfigListResponse"/>.
     /// </returns>
-    Task<HttpResult<Result<IEnumerable<PluginConfigListResponse>>>> ListAsync(
+    Task<HttpResult<PaginatedResult<PluginConfigListResponse>>> ListAsync(
         CancellationToken cancellationToken = default);
 
     /// <summary>

src/FlowSynx.Client/Services/IPluginsService.cs

@@ -17,7 +17,7 @@ public interface IPluginsService
     /// A task that represents the asynchronous operation. The task result contains an
     /// <see cref="HttpResult{T}"/> with a <see cref="Result{T}"/> holding a collection of <see cref="PluginsListResponse"/>.
     /// </returns>
-    Task<HttpResult<Result<IEnumerable<PluginsListResponse>>>> ListAsync(
+    Task<HttpResult<PaginatedResult<PluginsListResponse>>> ListAsync(
         CancellationToken cancellationToken = default);
 
     /// <summary>

src/FlowSynx.Client/Services/IWorkflowsService.cs

@@ -14,7 +14,7 @@ public interface IWorkflowsService
     /// </summary>
     /// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
     /// <returns>A result containing a list of workflow summaries.</returns>
-    Task<HttpResult<Result<IEnumerable<WorkflowListResponse>>>> ListAsync(
+    Task<HttpResult<PaginatedResult<WorkflowListResponse>>> ListAsync(
         CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -63,7 +63,7 @@ Task<HttpResult<Result<Unit>>> DeleteAsync(
     /// <param name="request">The request specifying filters for executions.</param>
     /// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
     /// <returns>A result containing a list of workflow executions.</returns>
-    Task<HttpResult<Result<IEnumerable<WorkflowExecutionListResponse>>>> ExecutionsAsync(
+    Task<HttpResult<PaginatedResult<WorkflowExecutionListResponse>>> ExecutionsAsync(
        WorkflowExecutionListRequest request,
        CancellationToken cancellationToken = default);
 
@@ -103,7 +103,7 @@ Task<HttpResult<Result<Unit>>> CancelExecutionsAsync(
     /// <param name="request">The request for the approvals list.</param>
     /// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
     /// <returns>A result containing a collection of workflow execution approval responses.</returns>
-    Task<HttpResult<Result<IEnumerable<WorkflowExecutionPendingApprovalsResponse>>>> ExecutionPendingApprovalsAsync(
+    Task<HttpResult<PaginatedResult<WorkflowExecutionPendingApprovalsResponse>>> ExecutionPendingApprovalsAsync(
        WorkflowExecutionPendingApprovalsRequest request,
        CancellationToken cancellationToken = default);
 
@@ -143,7 +143,7 @@ Task<HttpResult<Result<WorkflowExecutionLogsResponse>>> ExecutionsLogsAsync(
     /// <param name="request">The request object containing workflow execution identifiers associated tasks.</param>
     /// <param name="cancellationToken">A token that can be used to cancel the asynchronous operation.</param>
     /// <returns>A result containing list of execution tasks.</returns>
-    Task<HttpResult<Result<IEnumerable<WorkflowExecutionTasksResponse>>>> ExecutionTasksAsync(
+    Task<HttpResult<PaginatedResult<WorkflowExecutionTasksResponse>>> ExecutionTasksAsync(
         WorkflowExecutionTasksRequest request,
         CancellationToken cancellationToken = default);
 
@@ -163,7 +163,7 @@ Task<HttpResult<Result<WorkflowTaskExecutionDetailsResponse>>> TaskExecutionDeta
     /// <param name="request">The request specifying which task execution logs to retrieve.</param>
     /// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
     /// <returns>A result containing the task execution logs.</returns>
-    Task<HttpResult<Result<IEnumerable<WorkflowTaskExecutionLogsResponse>>>> TaskExecutionLogsAsync(
+    Task<HttpResult<PaginatedResult<WorkflowTaskExecutionLogsResponse>>> TaskExecutionLogsAsync(
        WorkflowTaskExecutionLogsRequest request,
        CancellationToken cancellationToken = default);
 
@@ -173,7 +173,7 @@ Task<HttpResult<Result<IEnumerable<WorkflowTaskExecutionLogsResponse>>>> TaskExe
     /// <param name="request">The request specifying filter criteria for triggers.</param>
     /// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
     /// <returns>A result containing a list of workflow triggers.</returns>
-    Task<HttpResult<Result<IEnumerable<WorkflowTriggersListResponse>>>> TriggersAsync(
+    Task<HttpResult<PaginatedResult<WorkflowTriggersListResponse>>> TriggersAsync(
         WorkflowTriggersListRequest request,
         CancellationToken cancellationToken = default);
 

src/FlowSynx.Client/Services/LogsService.cs

@@ -12,7 +12,7 @@ public class LogsService: ILogsService
 
     public LogsService(IHttpRequestHandler httpRequestHandler) => _httpRequestHandler = httpRequestHandler;
 
-    public async Task<HttpResult<Result<IEnumerable<LogsListResponse>>>> ListAsync(
+    public async Task<HttpResult<PaginatedResult<LogsListResponse>>> ListAsync(
         LogsListRequest request,
         CancellationToken cancellationToken = default)
     {
@@ -24,6 +24,6 @@ public async Task<HttpResult<Result<IEnumerable<LogsListResponse>>>> ListAsync(
         };
 
         return await _httpRequestHandler
-            .SendRequestAsync<LogsListRequest, Result<IEnumerable<LogsListResponse>>>(requestMessage, cancellationToken);
+            .SendRequestAsync<LogsListRequest, PaginatedResult < LogsListResponse>>(requestMessage, cancellationToken);
     }
 }

src/FlowSynx.Client/Services/PluginConfigService.cs

@@ -13,7 +13,7 @@ public class PluginConfigService: IPluginConfigService
     public PluginConfigService(IHttpRequestHandler httpRequestHandler) => 
         _httpRequestHandler = httpRequestHandler;
 
-    public async Task<HttpResult<Result<IEnumerable<PluginConfigListResponse>>>> ListAsync(
+    public async Task<HttpResult<PaginatedResult<PluginConfigListResponse>>> ListAsync(
         CancellationToken cancellationToken = default)
     {
         var requestMessage = new Request
@@ -22,7 +22,7 @@ public async Task<HttpResult<Result<IEnumerable<PluginConfigListResponse>>>> Lis
             Uri = "config"
         };
 
-        return await _httpRequestHandler.SendRequestAsync<Result<IEnumerable<PluginConfigListResponse>>>(requestMessage, cancellationToken);
+        return await _httpRequestHandler.SendRequestAsync<PaginatedResult<PluginConfigListResponse>>(requestMessage, cancellationToken);
     }
 
     public async Task<HttpResult<Result<AddPluginConfigResponse>>> AddAsync(

src/FlowSynx.Client/Services/PluginsService.cs

@@ -13,7 +13,7 @@ public class PluginsService: IPluginsService
     public PluginsService(IHttpRequestHandler httpRequestHandler) => 
         _httpRequestHandler = httpRequestHandler;
 
-    public async Task<HttpResult<Result<IEnumerable<PluginsListResponse>>>> ListAsync(
+    public async Task<HttpResult<PaginatedResult<PluginsListResponse>>> ListAsync(
         CancellationToken cancellationToken = default)
     {
         var requestMessage = new Request
@@ -23,7 +23,7 @@ public async Task<HttpResult<Result<IEnumerable<PluginsListResponse>>>> ListAsyn
         };
 
         return await _httpRequestHandler
-            .SendRequestAsync<Result<IEnumerable<PluginsListResponse>>>(requestMessage, cancellationToken);
+            .SendRequestAsync<PaginatedResult<PluginsListResponse>>(requestMessage, cancellationToken);
     }
 
     public async Task<HttpResult<Result<Unit>>> InstallAsync(