// Copyright (c) Arlo Godfrey. All Rights Reserved.
// Licensed under the GNU Lesser General Public License, Version 3.0 with additional terms.
// See the LICENSE, LICENSE.LESSER and LICENSE.ADDITIONAL files in the project root for more information.

using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using OwlCore.Events;
using StrixMusic.Sdk.AdapterModels;
using StrixMusic.Sdk.BaseModels;
using StrixMusic.Sdk.CoreModels;

namespace StrixMusic.Sdk.AppModels
{
    /// <summary>
    /// A collection of images.
    /// </summary>
    /// <remarks>Instances of this class may contain data merged from one or more sources.</remarks>
    public interface IImageCollection : IImageCollectionBase, IAppModel, IMerged<ICoreImageCollection>
    {
        /// <summary>
        /// Gets a requested number of <see cref="IImageBase"/>s starting at the given offset.
        /// </summary>
        /// <param name="limit">The max number of items to return.</param>
        /// <param name="offset">Get items starting at this index.</param>
        /// <param name="cancellationToken">A cancellation token that may be used to cancel the ongoing task.</param>
        /// <returns>The requested range of items.</returns>
        IAsyncEnumerable<IImage> GetImagesAsync(int limit, int offset, CancellationToken cancellationToken = default);

        /// <summary>
        /// Adds a new image to the collection.
        /// </summary>
        /// <param name="image">The image to add.</param>
        /// <param name="index">the position to insert the image at.</param>
        /// <param name="cancellationToken">A cancellation token that may be used to cancel the ongoing task.</param>
        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
        Task AddImageAsync(IImage image, int index, CancellationToken cancellationToken = default);

        /// <summary>
        /// Fires when the items are changed.
        /// </summary>
        event CollectionChangedEventHandler<IImage>? ImagesChanged;
    }
}