last ...

Interfaces/IXBaseProvider.cs

@@ -0,0 +1,202 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Linq.Expressions;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.SignalR;
+using Microsoft.EntityFrameworkCore.Query;
+using xDataService.Configuration;
+using xDataService.Interfaces;
+using xIdentityService.Interfaces;
+using xModels.Base;
+using xModels.Dtos;
+using xPushService.Base;
+
+namespace xPushService.Interfaces
+{
+    public interface IXBaseProvider<TEntity, TDto, TKey>
+    where TEntity : XBaseEntity<TKey>
+    where TDto : XBaseEntityDto<TKey>
+    {
+        //
+        #region Props ...
+        //
+        IXIdentityProvider IdentityProvider { get; }
+        XDataServiceConfiguration DataConfiguration { get; }
+        IHubContext<XBaseEntityHub<TEntity, TKey>> Hub { get; }
+        IXBaseRepositoryService<TEntity, TDto, TKey> RepositoryService { get; }
+        #endregion
+
+        //
+        #region Actions ...
+        /// <summary>
+        /// add a new Dto ...
+        /// </summary>
+        /// <param name="item"></param>
+        /// <param name="saveChanges"></param>
+        /// <param name="connectionId"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<TDto> AddAsync(
+            TDto item,
+            bool saveChanges = true,
+            string connectionId = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Update an Dto values ...
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="item"></param>
+        /// <param name="saveChanges"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<TDto> UpdateAsync(
+            TKey id,
+            TDto item,
+            bool saveChanges = true,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// remove an Dto by it's Id ...
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="softDelete"></param>
+        /// <param name="saveChanges"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<TDto> RemoveAsync(
+            TKey id,
+            bool softDelete = true,
+            bool saveChanges = true,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// count all exists Dtos ...
+        /// </summary>
+        /// <param name="ignoreSoftDeleteds"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<int> CountAsync(
+            bool ignoreSoftDeleteds = true,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Check a Dto exists or not ...
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="ignoreSoftDeleteds"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<bool> IsExistsAsync(
+            TKey id,
+            bool ignoreSoftDeleteds = true,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// retrieve an Dto by it's Id ...
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="ignoreSoftDeleteds"></param>
+        /// <param name="includeBuilder"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<TDto> GetAsync(
+            TKey id,
+            bool ignoreSoftDeleteds = true,
+            Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> includeBuilder = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// retrieve all exists Dtos ...
+        /// </summary>
+        /// <param name="ignoreSoftDeleteds"></param>
+        /// <param name="orderBuilder"></param>
+        /// <param name="includeBuilder"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<IEnumerable<TDto>> GetAllAsync(
+            bool ignoreSoftDeleteds = true,
+            Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> orderBuilder = null,
+            Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> includeBuilder = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// find an Dto by providing a Conditional Expression ...
+        /// </summary>
+        /// <param name="predicate"></param>
+        /// <param name="ignoreSoftDeleteds"></param>
+        /// <param name="includeBuilder"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<TDto> FindOneAsync(
+            Expression<Func<TEntity, bool>> predicate,
+            bool ignoreSoftDeleteds = true,
+            Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> includeBuilder = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// find a collection of Dtos by proving a Conditional Expression ...
+        /// </summary>
+        /// <param name="predicate"></param>
+        /// <param name="ignoreSoftDeleteds"></param>
+        /// <param name="orderBuilder"></param>
+        /// <param name="includeBuilder"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<IEnumerable<TDto>> FindManyAsync(
+            Expression<Func<TEntity, bool>> predicate,
+            bool ignoreSoftDeleteds = true,
+            Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> orderBuilder = null,
+            Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> includeBuilder = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// retrieve Dtos based on XQuery Pagination structure ...
+        /// </summary>
+        /// <param name="query"></param>
+        /// <param name="ignoreSoftDeleteds"></param>
+        /// <param name="predicate"></param>
+        /// <param name="orderBuilder"></param>
+        /// <param name="includeBuilder"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<XQueryResult<TDto>> QueryAsync(
+            XQuery query,
+            bool ignoreSoftDeleteds = true,
+            Expression<Func<TEntity, bool>> predicate = null,
+            Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> orderBuilder = null,
+            Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> includeBuilder = null,
+            CancellationToken cancellationToken = default
+        );
+        #endregion
+
+        //
+        #region Hub Actions ...
+        /// <summary>
+        /// Send Custom Push Message ...
+        /// </summary>
+        /// <param name="action"></param>
+        /// <param name="payLoad"></param>
+        /// <param name="connectionId"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task SendPush(
+            string action,
+            string payLoad,
+            string connectionId = null,
+            CancellationToken cancellationToken = default
+        );
+        #endregion        
+    }
+}