fix: fix the implementation for DiscordRoleTags

feat: DiscordRole.RoleType

Author: Lulalaby

DisCatSharp/Entities/Guild/DiscordRole.cs

@@ -17,7 +17,7 @@ namespace DisCatSharp.Entities;
 /// <summary>
 ///     Represents a discord role, to which users can be assigned.
 /// </summary>
-public class DiscordRole : SnowflakeObject, IEquatable<DiscordRole>
+public sealed class DiscordRole : SnowflakeObject, IEquatable<DiscordRole>
 {
 	[JsonProperty("color", NullValueHandling = NullValueHandling.Ignore)]
 	internal int ColorInternal;
@@ -29,7 +29,7 @@ public class DiscordRole : SnowflakeObject, IEquatable<DiscordRole>
 	///     Gets the role unicode_emoji.
 	/// </summary>
 	[JsonProperty("unicode_emoji", NullValueHandling = NullValueHandling.Ignore)]
-	internal string UnicodeEmojiString;
+	internal string? UnicodeEmojiString;
 
 	/// <summary>
 	///     Initializes a new instance of the <see cref="DiscordRole" /> class.
@@ -53,7 +53,7 @@ internal DiscordRole()
 	///     Gets the description of this role.
 	/// </summary>
 	[JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)]
-	public string Description { get; internal set; }
+	public string? Description { get; internal set; }
 
 	/// <summary>
 	///     Gets the color of this role.
@@ -96,26 +96,31 @@ public DiscordColor Color
 	///     Gets the tags this role has.
 	/// </summary>
 	[JsonProperty("tags", NullValueHandling = NullValueHandling.Ignore)]
-	public DiscordRoleTags Tags { get; internal set; }
+	public DiscordRoleTags? Tags { get; internal set; }
+
+	/// <summary>
+	///     Determines the type of role based on its tags.
+	/// </summary>
+	public RoleType Type => this.Tags?.DetermineRoleType() ?? RoleType.Normal;
 
 	/// <summary>
 	///     Gets the role icon's hash.
 	/// </summary>
 	[JsonProperty("icon", NullValueHandling = NullValueHandling.Ignore)]
-	public string IconHash { get; internal set; }
+	public string? IconHash { get; internal set; }
 
 	/// <summary>
 	///     Gets the role icon's url.
 	/// </summary>
 	[JsonIgnore]
-	public string IconUrl
+	public string? IconUrl
 		=> !string.IsNullOrWhiteSpace(this.IconHash) ? $"{DiscordDomain.GetDomain(CoreDomain.DiscordCdn).Url}{Endpoints.ROLE_ICONS}/{this.Id.ToString(CultureInfo.InvariantCulture)}/{this.IconHash}.png?size=64" : null;
 
 	/// <summary>
 	///     Gets the unicode emoji.
 	/// </summary>
 	[JsonIgnore]
-	public DiscordEmoji UnicodeEmoji
+	public DiscordEmoji? UnicodeEmoji
 		=> this.UnicodeEmojiString != null ? DiscordEmoji.FromName(this.Discord, $":{this.UnicodeEmojiString}:", false) : null;
 
 	/// <summary>
@@ -132,7 +137,7 @@ public DiscordGuild Guild
 	}
 
 	[JsonIgnore]
-	internal DiscordGuild GuildInternal { get; set; }
+	internal DiscordGuild? GuildInternal { get; set; }
 
 	/// <summary>
 	///     Gets the role flags.
@@ -231,7 +236,7 @@ public override int GetHashCode()
 	/// <exception cref="NotFoundException">Thrown when the role does not exist.</exception>
 	/// <exception cref="BadRequestException">Thrown when an invalid parameter was provided.</exception>
 	/// <exception cref="ServerErrorException">Thrown when Discord is unable to process the request.</exception>
-	public Task ModifyPositionAsync(int position, string reason = null)
+	public Task ModifyPositionAsync(int position, string? reason = null)
 	{
 		var roles = this.Guild.Roles.Values.OrderByDescending(xr => xr.Position)
 			.Select(x => new RestGuildRoleReorderPayload
@@ -263,7 +268,7 @@ public Task ModifyPositionAsync(int position, string reason = null)
 	/// <exception cref="NotFoundException">Thrown when the role does not exist.</exception>
 	/// <exception cref="BadRequestException">Thrown when an invalid parameter was provided.</exception>
 	/// <exception cref="ServerErrorException">Thrown when Discord is unable to process the request.</exception>
-	public Task ModifyAsync(string name = null, Permissions? permissions = null, DiscordColor? color = null, bool? hoist = null, bool? mentionable = null, string reason = null)
+	public Task ModifyAsync(string name = null, Permissions? permissions = null, DiscordColor? color = null, bool? hoist = null, bool? mentionable = null, string? reason = null)
 		=> this.Discord.ApiClient.ModifyGuildRoleAsync(this.GuildId, this.Id, name, permissions, color?.Value, hoist, mentionable, Optional.None, Optional.None, reason);
 
 	/// <summary>
@@ -326,7 +331,7 @@ public Task ModifyAsync(Action<RoleEditModel> action)
 	/// <exception cref="NotFoundException">Thrown when the role does not exist.</exception>
 	/// <exception cref="BadRequestException">Thrown when an invalid parameter was provided.</exception>
 	/// <exception cref="ServerErrorException">Thrown when Discord is unable to process the request.</exception>
-	public Task DeleteAsync(string reason = null)
+	public Task DeleteAsync(string? reason = null)
 		=> this.Discord.ApiClient.DeleteRoleAsync(this.GuildId, this.Id, reason);
 
 #endregion

DisCatSharp/Entities/Guild/DiscordRoleTags.cs

@@ -1,53 +1,74 @@
-using Newtonsoft.Json;
+using DisCatSharp.Entities;
+using DisCatSharp.Enums;
 
-namespace DisCatSharp.Entities;
+using Newtonsoft.Json;
 
 /// <summary>
-///     Represents a discord role tags.
+///     Represents a Discord role tags object with detailed classification logic.
 /// </summary>
-public class DiscordRoleTags : ObservableApiObject
+public sealed class DiscordRoleTags : ObservableApiObject
 {
+	/// <summary>
+	///     Whether this role is a guild's linked role.
+	/// </summary>
 	[JsonProperty("guild_connections", NullValueHandling = NullValueHandling.Include)]
-	internal bool? GuildConnection = false;
+	public bool? GuildConnections { get; internal set; }
 
+	/// <summary>
+	///     Whether this is the guild's booster role.
+	/// </summary>
 	[JsonProperty("premium_subscriber", NullValueHandling = NullValueHandling.Include)]
-	internal bool? PremiumSubscriber = false;
+	public bool? PremiumSubscriber { get; internal set; }
 
 	/// <summary>
-	///     Gets the id of the bot this role belongs to.
+	///     Gets the ID of the bot this role belongs to.
 	/// </summary>
-	[JsonProperty("bot_id", NullValueHandling = NullValueHandling.Ignore)]
+	[JsonProperty("bot_id", NullValueHandling = NullValueHandling.Include)]
 	public ulong? BotId { get; internal set; }
 
 	/// <summary>
-	///     Gets the id of the integration this role belongs to.
+	///     Gets the ID of the integration this role belongs to.
 	/// </summary>
-	[JsonProperty("integration_id", NullValueHandling = NullValueHandling.Ignore)]
+	[JsonProperty("integration_id", NullValueHandling = NullValueHandling.Include)]
 	public ulong? IntegrationId { get; internal set; }
 
 	/// <summary>
-	///     Gets whether this is the guild's booster role.
+	///     Gets the ID of this role's subscription SKU and listing.
 	/// </summary>
-	[JsonIgnore]
-	public bool IsPremiumSubscriber
-		=> this.PremiumSubscriber.HasValue && this.PremiumSubscriber.Value;
-
-	/// <summary>
-	///     The id of this role's subscription sku and listing.
-	/// </summary>
-	[JsonProperty("subscription_listing_id", NullValueHandling = NullValueHandling.Ignore)]
+	[JsonProperty("subscription_listing_id", NullValueHandling = NullValueHandling.Include)]
 	public ulong? SubscriptionListingId { get; internal set; }
 
 	/// <summary>
 	///     Whether this role is available for purchase.
 	/// </summary>
-	[JsonProperty("available_for_purchase", NullValueHandling = NullValueHandling.Ignore)]
+	[JsonProperty("available_for_purchase", NullValueHandling = NullValueHandling.Include)]
 	public bool? AvailableForPurchase { get; internal set; }
 
 	/// <summary>
-	///     Gets whether this is the guild's premium subscriber role.
+	///     Determines the type of role based on its tags.
 	/// </summary>
-	[JsonIgnore]
-	public bool IsLinkedRole
-		=> this.GuildConnection.HasValue && this.GuildConnection.Value;
+	public RoleType DetermineRoleType()
+	{
+		if (this.BotId is not null)
+			return RoleType.Bot;
+
+		switch (this.GuildConnections)
+		{
+			case false when this.PremiumSubscriber is null:
+				return RoleType.Booster;
+			case false when this.PremiumSubscriber is false:
+				return RoleType.ServerProduct;
+			case false when this.IntegrationId is not null && this.PremiumSubscriber is false:
+				return RoleType.PremiumSubscriber;
+			case false when this.IntegrationId is not null && this.SubscriptionListingId is not null:
+				return RoleType.PremiumSubscriberTier;
+		}
+
+		if (this.IntegrationId is not null && this.BotId is null && this.PremiumSubscriber is null && this.SubscriptionListingId is null)
+			return RoleType.ExternalPlatform;
+
+		return this.GuildConnections is null
+			? RoleType.RoleConnection
+			: RoleType.Normal;
+	}
 }

DisCatSharp/Enums/Guild/RoleType.cs

@@ -0,0 +1,57 @@
+using System.ComponentModel;
+
+namespace DisCatSharp.Enums;
+
+/// <summary>
+///     Represents the classification of a Discord role.
+/// </summary>
+public enum RoleType
+{
+	/// <summary>
+	///     The role type is unknown.
+	/// </summary>
+	[Description("Normal role type.")]
+	Normal,
+
+	/// <summary>
+	///     A bot or application role.
+	/// </summary>
+	[Description("Bot or application role.")]
+	Bot,
+
+	/// <summary>
+	///     A booster role.
+	/// </summary>
+	[Description("Server booster role.")]
+	Booster,
+
+	/// <summary>
+	///     A server product role.
+	/// </summary>
+	[Description("Server product role.")]
+	ServerProduct,
+
+	/// <summary>
+	///     A premium subscriber role.
+	/// </summary>
+	[Description("Premium subscriber role.")]
+	PremiumSubscriber,
+
+	/// <summary>
+	///     A premium subscriber tier role.
+	/// </summary>
+	[Description("Premium subscriber tier role.")]
+	PremiumSubscriberTier,
+
+	/// <summary>
+	///     A role linked to an external platform (e.g., Twitch or YouTube).
+	/// </summary>
+	[Description("External platform role. For example Twitch or YouTube.")]
+	ExternalPlatform,
+
+	/// <summary>
+	///     A role connection role.
+	/// </summary>
+	[Description("Role connection role.")]
+	RoleConnection
+}