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

namespace xAiModels.Interfaces.Enrichers
{
    public interface IXAiMessageEnricher
    {
        //
        #region Enrichers ...
        /// <summary>
        /// Enrich Specified Item ...
        /// </summary>
        /// <param name="source"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<XAiMessageDto> Enrich(
            XAiMessage source,
            CancellationToken cancellationToken = default
        );

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

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

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