Kavita/API/DTOs/SeriesDto.cs

using System;
using API.Entities.Enums;
using API.Entities.Interfaces;

namespace API.DTOs;
#nullable enable

public class SeriesDto : IHasReadTimeEstimate, IHasCoverImage
{
    public int Id { get; init; }
    public string? Name { get; init; }
    public string? OriginalName { get; init; }
    public string? LocalizedName { get; init; }
    public string? SortName { get; init; }
    public int Pages { get; init; }
    public bool CoverImageLocked { get; set; }
    /// <summary>
    /// Sum of pages read from linked Volumes. Calculated at API-time.
    /// </summary>
    public int PagesRead { get; set; }
    /// <summary>
    /// DateTime representing last time the series was Read. Calculated at API-time.
    /// </summary>
    public DateTime LatestReadDate { get; set; }
    /// <summary>
    /// DateTime representing last time a chapter was added to the Series
    /// </summary>
    public DateTime LastChapterAdded { get; set; }
    /// <summary>
    /// Rating from logged in user. Calculated at API-time.
    /// </summary>
    public float UserRating { get; set; }
    /// <summary>
    /// If the user has set the rating or not
    /// </summary>
    public bool HasUserRated { get; set; }

    public MangaFormat Format { get; set; }
    public DateTime Created { get; set; }

    public bool NameLocked { get; set; }
    public bool SortNameLocked { get; set; }
    public bool LocalizedNameLocked { get; set; }
    /// <summary>
    /// Total number of words for the series. Only applies to epubs.
    /// </summary>
    public long WordCount { get; set; }

    public int LibraryId { get; set; }
    public string LibraryName { get; set; } = default!;
    /// <inheritdoc cref="IHasReadTimeEstimate.MinHoursToRead"/>
    public int MinHoursToRead { get; set; }
    /// <inheritdoc cref="IHasReadTimeEstimate.MaxHoursToRead"/>
    public int MaxHoursToRead { get; set; }
    /// <inheritdoc cref="IHasReadTimeEstimate.AvgHoursToRead"/>
    public float AvgHoursToRead { get; set; }
    /// <summary>
    /// The highest level folder for this Series
    /// </summary>
    public string FolderPath { get; set; } = default!;
    /// <summary>
    /// Lowest path (that is under library root) that contains all files for the series.
    /// </summary>
    /// <remarks><see cref="Services.Tasks.Scanner.Parser.Parser.NormalizePath"/> must be used before setting</remarks>
    public string? LowestFolderPath { get; set; }
    /// <summary>
    /// The last time the folder for this series was scanned
    /// </summary>
    public DateTime LastFolderScanned { get; set; }
    #region KavitaPlus
    /// <summary>
    /// Do not match the series with any external Metadata service. This will automatically opt it out of scrobbling.
    /// </summary>
    public bool DontMatch { get; set; }
    /// <summary>
    /// If the series was unable to match, it will be blacklisted until a manual metadata match overrides it
    /// </summary>
    public bool IsBlacklisted { get; set; }
    #endregion

    public string? CoverImage { get; set; }
    public string PrimaryColor { get; set; }
    public string SecondaryColor { get; set; }

    public void ResetColorScape()
    {
        PrimaryColor = string.Empty;
        SecondaryColor = string.Empty;
    }
}