using Dpz.Core.Public.Entity.Seo;

namespace Dpz.Core.Service.RepositoryService;

public interface IPageMetadataService
{
    /// <summary>
    /// relations:[controller,action,id,...]
    /// </summary>
    /// <param name="relations"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<VmPageMetadata?> GetPageMetadataAsync(
        IReadOnlyCollection<string> relations,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 根据路由获取页面元数据
    /// </summary>
    /// <param name="controller">控制器</param>
    /// <param name="action">动作</param>
    /// <param name="routeId">路由ID（可选）</param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<VmPageMetadata?> GetPageMetadataByRouteAsync(
        string? controller,
        string? action,
        string? routeId = null,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 根据结构化路由获取页面元数据
    /// </summary>
    Task<VmPageMetadata?> GetPageMetadataByRouteAsync(
        PageMetadataRoute route,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 根据结构化路由获取最终页面元数据
    /// </summary>
    Task<VmPageMetadata?> ResolvePageMetadataAsync(
        PageMetadataRoute route,
        VmPageMetadata? explicitMetadata = null,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 获取公共页面元数据
    /// </summary>
    Task<VmPageMetadata?> GetPublicMetadataAsync(CancellationToken cancellationToken = default);

    /// <summary>
    /// 根据ID获取页面元数据
    /// </summary>
    /// <param name="id"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<VmPageMetadata?> GetByIdAsync(string id, CancellationToken cancellationToken = default);

    /// <summary>
    /// get page metadata pages.
    /// </summary>
    /// <param name="searchText">query text</param>
    /// <param name="pageIndex">page index</param>
    /// <param name="pageSize">page size</param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<IPagedList<VmPageMetadata>> GetPageAsync(
        string? searchText = null,
        int pageIndex = 1,
        int pageSize = 20,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 获取全部页面元数据
    /// </summary>
    /// <returns></returns>
    Task<IList<VmPageMetadata>> GetPageMetadataAsync(CancellationToken cancellationToken = default);

    /// <summary>
    /// update page metadata
    /// </summary>
    /// <param name="pageMetadata"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task SavePageMetadataAsync(
        VmPageMetadata pageMetadata,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 刷新页面元数据缓存
    /// </summary>
    /// <returns></returns>
    Task RefreshCacheAsync(CancellationToken cancellationToken = default);

    /// <summary>
    /// delete page metadata
    /// </summary>
    /// <param name="id"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task DeleteAsync(string id, CancellationToken cancellationToken = default);
}