// <copyright file="IChapterRepository.cs" company="PlaceholderCompany">
// Copyright (c) PlaceholderCompany. All rights reserved.
// </copyright>

namespace MediaBrowser.Controller.Persistence;

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Model.Entities;

/// <summary>
/// Interface IChapterRepository.
/// </summary>
public interface IChapterRepository
{
    /// <summary>
    /// Deletes the chapters.
    /// </summary>
    /// <param name="itemId">The item.</param>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns>Task.</returns>
    Task DeleteChaptersAsync(Guid itemId, CancellationToken cancellationToken);

    /// <summary>
    /// Saves the chapters asynchronously.
    /// </summary>
    /// <param name="itemId">The item.</param>
    /// <param name="chapters">The set of chapters.</param>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns>A task representing the asynchronous operation.</returns>
    Task SaveChaptersAsync(Guid itemId, IReadOnlyList<ChapterInfo> chapters, CancellationToken cancellationToken = default);

    /// <summary>
    /// Gets all chapters associated with the baseItem asynchronously.
    /// </summary>
    /// <param name="baseItemId">The BaseItems id.</param>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns>A readonly list of chapter instances.</returns>
    Task<IReadOnlyList<ChapterInfo>> GetChaptersAsync(Guid baseItemId, CancellationToken cancellationToken = default);

    /// <summary>
    /// Gets a single chapter of a BaseItem on a specific index asynchronously.
    /// </summary>
    /// <param name="baseItemId">The BaseItems id.</param>
    /// <param name="index">The index of that chapter.</param>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns>A chapter instance.</returns>
    Task<ChapterInfo?> GetChapterAsync(Guid baseItemId, int index, CancellationToken cancellationToken = default);
}
