using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using xContentService.Models.Dtos;
using xContentService.Models.Entities;

namespace xContentService.Interfaces.Enrichers
{
    public interface IXContentEnricher
    {
        //
        #region Enrichers ...
        /// <summary>
        /// Enrich Specified Item ...
        /// </summary>
        /// <param name="source"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<XContentDto> Enrich(
            XContent source,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Enrich Specified Item ...
        /// </summary>
        /// <param name="source"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<XContentDto> Enrich(
            XContentDto source,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Enrich Specified Items ...
        /// </summary>
        /// <param name="sources"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<IEnumerable<XContentDto>> EnrichRange(
            IEnumerable<XContent> sources,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Enrich Specified Items ...
        /// </summary>
        /// <param name="sources"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<IEnumerable<XContentDto>> EnrichRange(
            IEnumerable<XContentDto> sources,
            CancellationToken cancellationToken = default
        );
        #endregion                
    }
}