Project.cs

using Ipfs;
using OwlCore.ComponentModel;
using System.Collections.Generic;

namespace WindowsAppCommunity.Sdk.Models;

/// <summary>
/// Represents a project.
/// </summary>
public record Project : IEntity, IUserRoleCollection, IAccentColor, IProjectCollection, ISources<Cid>
{
    /// <summary>
    /// The canonical publisher for this project.
    /// </summary>
    public Cid? Publisher { get; set; }

    /// <summary>
    /// The name of this project.
    /// </summary>
    public string Name { get; set; } = string.Empty;

    /// <summary>
    /// A description of this project.
    /// </summary>
    public string Description { get; set; } = string.Empty;

    /// <summary>
    /// An extended description of this project.
    /// </summary>
    public string ExtendedDescription { get; set; } = string.Empty;

    /// <summary>
    /// A list of <see cref="Image"/>s demonstrating this project.
    /// </summary>
    public Image[] Images { get; set; } = [];

    /// <summary>
    /// A list of features provided by this project.
    /// </summary>
    public string[] Features { get; set; } = [];

    /// <summary>
    /// A hex-encoded accent color for this publisher.
    /// </summary>
    public string? AccentColor { get; set; }

    /// <summary>
    /// The category defining this project, as found in an app store.
    /// </summary>
    public string Category { get; set; } = string.Empty;

    /// <summary>
    /// Other projects which this project may depend on for various reasons.
    /// </summary>
    public Cid[] Projects { get; set; } = [];

    /// <summary>
    /// The <see cref="User"/>s who collaborate on this project, and their corresponding roles.
    /// </summary>
    public UserRole[] Users { get; set; } = [];

    /// <summary>
    /// Represents links to external profiles or resources added by the user.
    /// </summary>
    public Link[] Links { get; set; } = [];

    /// <summary>
    /// Holds information about project assets that have been published for consumption by an end user, such as a Microsoft Store app, a package on nuget.org, a git repo, etc.
    /// </summary>
    public Connection[] Connections { get; set; } = [];

    /// <summary>
    /// A flag that indicates whether the profile has requested to be forgotten.
    /// </summary>
    public bool? ForgetMe { get; set; }

    /// <summary>
    /// A flag indicating whether this is a non-public project.
    /// </summary>
    public bool IsUnlisted { get; set; }

    /// <summary>
    /// The event stream sources for this project.
    public required ICollection<Cid> Sources { get; init; }
}