using API.Entities;
using API.Entities.Enums;

namespace API.DTOs.SideNav;
#nullable enable

public sealed record SideNavStreamDto
{
    public int Id { get; set; }
    public required string Name { get; set; }
    /// <summary>
    /// Is System Provided
    /// </summary>
    public bool IsProvided { get; set; }
    /// <summary>
    /// Sort Order on the Dashboard
    /// </summary>
    public int Order { get; set; }
    /// <summary>
    /// If Not IsProvided, the appropriate smart filter
    /// </summary>
    /// <remarks>Encoded filter</remarks>
    public string? SmartFilterEncoded { get; set; }
    public int? SmartFilterId { get; set; }
    /// <summary>
    /// External Source Url if configured
    /// </summary>
    public int ExternalSourceId { get; set; }
    public ExternalSourceDto? ExternalSource { get; set; }
    /// <summary>
    /// For system provided
    /// </summary>
    public SideNavStreamType StreamType { get; set; }
    public bool Visible { get; set; }
    public int? LibraryId { get; set; }
    /// <summary>
    /// Only available for SideNavStreamType.Library
    /// </summary>
    public LibraryDto? Library { get; set; }
}