Kavita/API/DTOs/KavitaPlus/Metadata/MetadataSettingsDto.cs

using System.Collections.Generic;
using API.Entities;
using API.Entities.Enums;
using API.Entities.MetadataMatching;
using NotImplementedException = System.NotImplementedException;

namespace API.DTOs.KavitaPlus.Metadata;


public sealed record MetadataSettingsDto
{
    /// <summary>
    /// If writing any sort of metadata from upstream (AniList, Hardcover) source is allowed
    /// </summary>
    public bool Enabled { get; set; }

    /// <summary>
    /// Allow the Summary to be written
    /// </summary>
    public bool EnableSummary { get; set; }
    /// <summary>
    /// Allow Publication status to be derived and updated
    /// </summary>
    public bool EnablePublicationStatus { get; set; }
    /// <summary>
    /// Allow Relationships between series to be set
    /// </summary>
    public bool EnableRelationships { get; set; }
    /// <summary>
    /// Allow People to be created (including downloading images)
    /// </summary>
    public bool EnablePeople { get; set; }
    /// <summary>
    /// Allow Start date to be set within the Series
    /// </summary>
    public bool EnableStartDate { get; set; }
    /// <summary>
    /// Allow setting the Localized name
    /// </summary>
    public bool EnableLocalizedName { get; set; }
    /// <summary>
    /// Allow setting the cover image
    /// </summary>
    public bool EnableCoverImage { get; set; }

    #region Chapter Metadata
    /// <summary>
    /// Allow Summary to be set within Chapter/Issue
    /// </summary>
    public bool EnableChapterSummary { get; set; }
    /// <summary>
    /// Allow Release Date to be set within Chapter/Issue
    /// </summary>
    public bool EnableChapterReleaseDate { get; set; }
    /// <summary>
    /// Allow Title to be set within Chapter/Issue
    /// </summary>
        public bool EnableChapterTitle { get; set; }
    /// <summary>
    /// Allow Publisher to be set within Chapter/Issue
    /// </summary>
    public bool EnableChapterPublisher { get; set; }
    /// <summary>
    /// Allow setting the cover image for the Chapter/Issue
    /// </summary>
    public bool EnableChapterCoverImage { get; set; }
    #endregion

    // Need to handle the Genre/tags stuff
    public bool EnableGenres { get; set; } = true;
    public bool EnableTags { get; set; } = true;

    /// <summary>
    /// For Authors and Writers, how should names be stored (Exclusively applied for AniList). This does not affect Character names.
    /// </summary>
    public bool FirstLastPeopleNaming { get; set; }

    /// <summary>
    /// Any Genres or Tags that if present, will trigger an Age Rating Override. Highest rating will be prioritized for matching.
    /// </summary>
    public Dictionary<string, AgeRating> AgeRatingMappings { get; set; }

    /// <summary>
    /// A list of rules that allow mapping a genre/tag to another genre/tag
    /// </summary>
    public List<MetadataFieldMappingDto> FieldMappings { get; set; }
    /// <summary>
    /// A list of overrides that will enable writing to locked fields
    /// </summary>
    public List<MetadataSettingField> Overrides { get; set; }

    /// <summary>
    /// Do not allow any Genre/Tag in this list to be written to Kavita
    /// </summary>
    public List<string> Blacklist { get; set; }
    /// <summary>
    /// Only allow these Tags to be written to Kavita
    /// </summary>
    public List<string> Whitelist { get; set; }
    /// <summary>
    /// Which Roles to allow metadata downloading for
    /// </summary>
    public List<PersonRole> PersonRoles { get; set; }


    /// <summary>
    /// Override list contains this field
    /// </summary>
    /// <param name="field"></param>
    /// <returns></returns>
    public bool HasOverride(MetadataSettingField field)
    {
        return Overrides.Contains(field);
    }

    /// <summary>
    /// If this Person role is allowed to be written
    /// </summary>
    /// <param name="character"></param>
    /// <returns></returns>
    public bool IsPersonAllowed(PersonRole character)
    {
        return PersonRoles.Contains(character);
    }
}