ICatalogService

// RB2 Core Connect

using System.Threading.Tasks;

namespace CoreConnect.Commerce.Catalog;

public interface ICatalogService
{
    /// <summary>
    /// Lookup URL path to find matching product or category.
    /// </summary>
    /// <param name="request">The request.</param>
    /// <param name="context">The request context.</param>
    /// <param name="cancellationToken">A cancellation token which can be used to cancel the operation.</param>
    /// <returns>The product or category.</returns>
    Task<LookupUrlResponse> LookupUrl(LookupUrlRequest request, IRequestContext context,
        CancellationToken cancellationToken = default);

    /// <summary>
    /// Gets the category tree.
    /// </summary>
    /// <param name="context">The request context.</param>
    /// <param name="cancellationToken">A cancellation token which can be used to cancel the operation.</param>
    /// <returns>The category tree.</returns>
    Task<IEnumerable<Category>> GetCategoryTree(IRequestContext context,
        CancellationToken cancellationToken = default);

    /// <summary>
    /// Gets the specified category.
    /// </summary>
    /// <param name="request">The request.</param>
    /// <param name="context">The request context.</param>
    /// <param name="cancellationToken">A cancellation token which can be used to cancel the operation.</param>
    /// <returns>The category.</returns>
    Task<Category?> GetCategory(GetCategoryRequest request, IRequestContext context,
        CancellationToken cancellationToken = default);

    /// <summary>
    /// Performs a product search.
    /// </summary>
    /// <param name="request">The request.</param>
    /// <param name="context">The context.</param>
    /// <param name="cancellationToken">A cancellation token which can be used to cancel the operation.</param>
    /// <returns>The product search results</returns>
    Task<SearchProductsResponse> SearchProducts(SearchProductsRequest request, IRequestContext context,
        CancellationToken cancellationToken = default);

    /// <summary>
    /// FetchSuggestions
    /// </summary>
    /// <param name="request"></param>
    /// <param name="context"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<SuggestResponse> FetchSuggestions(FetchSuggestionRequest request, IRequestContext context,
        CancellationToken cancellationToken = default);

    /// <summary>
    /// Gets the specified product.
    /// </summary>
    /// <param name="request">The request.</param>
    /// <param name="context">The request context.</param>
    /// <param name="cancellationToken">A cancellation token which can be used to cancel the operation.</param>
    /// <returns>The product.</returns>
    Task<Product?> GetProduct(GetProductRequest request, IRequestContext context,
        CancellationToken cancellationToken = default);
    /// <summary>
    /// Internal api to list all products and trigger a callback
    /// </summary>
    /// <param name="context">context for the request</param>
    /// <param name="callback">Callback</param>
    /// <param name="cancellationToken">Token to cancel</param>
    /// <returns></returns>
    Task ListAllProducts(IRequestContext context, Func<Product, Task> callback, CancellationToken cancellationToken = default);

    /// <summary>
    /// Fetches all products.
    /// </summary>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns></returns>
    IAsyncEnumerable<List<Product>> FetchAllProducts(CancellationToken cancellationToken = default);

    Task<IEnumerable<Category>> GetCategoryFlatList(IRequestContext context, CancellationToken cancellationToken = default);

}