DisCatSharp v10.6.6 Release (#628)

* [ci skip] prep redirects

* docs: add missing docs

* docs: extend changelog with docs update note

* docs: more updates

* chore: cleanup

* chore: code cleanup

Author: Lulalaby

Diff for: BUILDING.md

@@ -608,7 +608,7 @@ internal async Task UpdateAsync()
 				await this.RegisterCommands(this._updateList.Where(x => x.Key == key).Select(x => x.Value).ToList(), key).ConfigureAwait(false);
 			}
 
-			this.MISSING_SCOPE_GUILD_IDS = [..failedGuilds];
+			this.MISSING_SCOPE_GUILD_IDS = [.. failedGuilds];
 			s_missingScopeGuildIdsGlobal.AddRange(failedGuilds);
 			this.ShardStartupFinished = true;
 			FinishedShardCount++;

Diff for: DisCatSharp.ApplicationCommands/ApplicationCommandsExtension.cs

@@ -62,5 +62,5 @@ public static partial class DiscordRegEx
 	public static partial Regex WebhookRegex();
 
 	[GeneratedRegex(@"^<sound:(?<guild_id>\\d+):(?<sound_id>\\d+)>$", RegexOptions.Compiled | RegexOptions.ECMAScript)]
-    public static partial Regex SoundRegex();
+	public static partial Regex SoundRegex();
 }

Diff for: DisCatSharp.Common/RegularExpressions/DiscordRegEx.cs

@@ -4,6 +4,8 @@ items:
 - name: Version 10.X
   expanded: true
   items:
+  - name: Version 10.6.6
+    href: v10/10_6_6.md
   - name: Version 10.6.4
     href: v10/10_6_4.md
   - name: Version 10.6.2

Diff for: DisCatSharp.Docs/changelogs/index.md

@@ -1 +1 @@
-/changelogs/latest /changelogs/v10/10_6_3 303
+/changelogs/latest /changelogs/v10/10_6_6 303

Diff for: DisCatSharp.Docs/changelogs/toc.yml

@@ -16,7 +16,10 @@ public static class DiscordMessageBuilderMethodHooks
 	/// <param name="builder">The  <see cref="DiscordMessageBuilder" /> to add the attachment to.</param>
 	/// <param name="gcpAttachment">The attachment to add.</param>
 	/// <param name="isVoice">Whether this is a voice message attachment.</param>
-	/// <param name="originalStream">The voice message's stream, required if <paramref name="isVoice"/> is <see langword="true"/>.</param>
+	/// <param name="originalStream">
+	///     The voice message's stream, required if <paramref name="isVoice" /> is
+	///     <see langword="true" />.
+	/// </param>
 	/// <returns>The chained <see cref="DiscordMessageBuilder" />.</returns>
 	public static DiscordMessageBuilder AddGcpAttachment(this DiscordMessageBuilder builder, GcpAttachmentUploadInformation gcpAttachment, bool isVoice = false, Stream? originalStream = null)
 	{

Diff for: DisCatSharp.Docs/changelogs/v10/10_6_6.md

@@ -16,7 +16,6 @@
 using DisCatSharp.Lavalink.Enums;
 using DisCatSharp.Lavalink.Enums.Websocket;
 using DisCatSharp.Lavalink.EventArgs;
-using DisCatSharp.Lavalink.Payloads;
 using DisCatSharp.Net;
 using DisCatSharp.Net.Abstractions;
 using DisCatSharp.Net.WebSocket;

Diff for: DisCatSharp.Docs/dcs/_redirects

@@ -66,7 +66,7 @@ internal LavalinkPlayerUpdateModel()
 	public Optional<LavalinkFilters> Filters { internal get; set; }
 
 	/// <summary>
-	/// Gets or sets the user data.
+	///     Gets or sets the user data.
 	/// </summary>
 	[JsonProperty("userData")]
 	public Optional<object> UserData { get; set; }

Diff for: plugins/AITSYS.Docfx.DescriptionGenerator.deps.json renamed to DisCatSharp.Docs/dcs/disable_plugins/AITSYS.Docfx.DescriptionGenerator.deps.json

@@ -56,26 +56,26 @@ internal LavalinkRestPlayerUpdatePayload(string guildId)
 	internal Optional<LavalinkFilters> Filters { get; set; }
 
 	/// <summary>
-	///    Gets or sets the track.
+	///     Gets or sets the track.
 	/// </summary>
 	[JsonProperty("track", NullValueHandling = NullValueHandling.Ignore)]
 	internal Optional<PlayerBase> Track { get; set; }
 }
 
 /// <summary>
-///   The lavalink rest player update player track payload.
+///     The lavalink rest player update player track payload.
 /// </summary>
 internal class PlayerBase
 {
 	/// <summary>
-	/// Gets or sets the user data.
+	///     Gets or sets the user data.
 	/// </summary>
 	[JsonProperty("userData", NullValueHandling = NullValueHandling.Ignore)]
 	public object? UserData { get; set; }
 }
 
 /// <summary>
-///    The lavalink rest player update player track payload.
+///     The lavalink rest player update player track payload.
 /// </summary>
 internal sealed class PlayerWithIdentifier : PlayerBase
 {
@@ -87,7 +87,7 @@ internal sealed class PlayerWithIdentifier : PlayerBase
 }
 
 /// <summary>
-///    The lavalink rest player update player track payload.
+///     The lavalink rest player update player track payload.
 /// </summary>
 internal sealed class PlayerWithEncoded : PlayerBase
 {

Diff for: plugins/AITSYS.Docfx.DescriptionGenerator.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/AITSYS.Docfx.DescriptionGenerator.dll

@@ -88,7 +88,8 @@ public class HostTests
 
 	private IHostBuilder Create(Dictionary<string, string?> configValues) =>
 		Host.CreateDefaultBuilder()
-			.ConfigureLogging(logging => {
+			.ConfigureLogging(logging =>
+			{
 				logging.ClearProviders();
 				logging.AddConsole();
 			})
@@ -97,7 +98,8 @@ private IHostBuilder Create(Dictionary<string, string?> configValues) =>
 
 	private IHostBuilder Create(string filename) =>
 		Host.CreateDefaultBuilder()
-			.ConfigureLogging(logging => {
+			.ConfigureLogging(logging =>
+			{
 				logging.ClearProviders();
 				logging.AddConsole();
 			})
@@ -108,7 +110,8 @@ private IHostBuilder Create<TInterface, TBot>(string filename)
 		where TInterface : class, IDiscordHostedService
 		where TBot : class, TInterface, IDiscordHostedService =>
 		Host.CreateDefaultBuilder()
-			.ConfigureLogging(logging => {
+			.ConfigureLogging(logging =>
+			{
 				logging.ClearProviders();
 				logging.AddConsole();
 			})

Diff for: plugins/AITSYS.Docfx.LastModified.deps.json renamed to DisCatSharp.Docs/dcs/disable_plugins/AITSYS.Docfx.LastModified.deps.json

@@ -71,10 +71,10 @@ protected BaseDiscordClient(DiscordConfiguration config)
 				var optionsFactory = new OptionsFactory<ConsoleLoggerOptions>([configureNamedOptions], []);
 				var optionsMonitor = new OptionsMonitor<ConsoleLoggerOptions>(optionsFactory, [], new OptionsCache<ConsoleLoggerOptions>());
 				/*
-			var configureFormatterOptions = new ConfigureNamedOptions<ConsoleFormatterOptions>(string.Empty, x => { x.TimestampFormat = this.Configuration.LogTimestampFormat; });
-			var formatterFactory = new OptionsFactory<ConsoleFormatterOptions>(new[] { configureFormatterOptions }, Enumerable.Empty<IPostConfigureOptions<ConsoleFormatterOptions>>());
-			var formatterMonitor = new OptionsMonitor<ConsoleFormatterOptions>(formatterFactory, Enumerable.Empty<IOptionsChangeTokenSource<ConsoleFormatterOptions>>(), new OptionsCache<ConsoleFormatterOptions>());
-			*/
+				var configureFormatterOptions = new ConfigureNamedOptions<ConsoleFormatterOptions>(string.Empty, x => { x.TimestampFormat = this.Configuration.LogTimestampFormat; });
+				var formatterFactory = new OptionsFactory<ConsoleFormatterOptions>(new[] { configureFormatterOptions }, Enumerable.Empty<IPostConfigureOptions<ConsoleFormatterOptions>>());
+				var formatterMonitor = new OptionsMonitor<ConsoleFormatterOptions>(formatterFactory, Enumerable.Empty<IOptionsChangeTokenSource<ConsoleFormatterOptions>>(), new OptionsCache<ConsoleFormatterOptions>());
+				*/
 
 				var l = new ConsoleLoggerProvider(optionsMonitor);
 				this.Configuration.LoggerFactory = new LoggerFactory();

Diff for: plugins/AITSYS.Docfx.LastModified.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/AITSYS.Docfx.LastModified.dll

@@ -384,6 +384,7 @@ internal async Task HandleDispatchAsync(GatewayPayload payload)
 				var requestId = (ulong)dat["id"]!;
 				await this.OnGuildJoinRequestDeleteAsync(requestId, uid, this.Guilds[gid]).ConfigureAwait(false);
 				break;
+
 #endregion
 
 #region Invite
@@ -917,7 +918,7 @@ internal async Task OnChannelUpdateEventAsync(DiscordChannel channel)
 				Id = channelNew.Id,
 				LastMessageId = channelNew.LastMessageId,
 				Name = channelNew.Name,
-				PermissionOverwritesInternal = [..channelNew.PermissionOverwritesInternal],
+				PermissionOverwritesInternal = [.. channelNew.PermissionOverwritesInternal],
 				Position = channelNew.Position,
 				Topic = channelNew.Topic,
 				Type = channelNew.Type,

Diff for: plugins/AngleSharp.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/AngleSharp.dll

@@ -14,8 +14,20 @@ namespace DisCatSharp;
 /// </summary>
 public sealed partial class DiscordClient
 {
+	/// <summary>
+	///     Stores the registered event handlers.
+	/// </summary>
 	private readonly Dictionary<Type, object> _registeredEventhandlers = [];
+
+	/// <summary>
+	///     Maps a tuple of handler, type, and a boolean indicating whether static methods were registered to a list of event
+	///     info and delegate arrays.
+	/// </summary>
 	private readonly Dictionary<(object?, Type, bool), List<(EventInfo, Delegate)[]>> _registrationToDelegate = [];
+
+	/// <summary>
+	///     Maps a type to a list of anonymous handler objects.
+	/// </summary>
 	private readonly Dictionary<Type, List<object>> _typeToAnonymousHandlers = [];
 
 	/// <summary>

Diff for: plugins/LibGit2Sharp.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/LibGit2Sharp.dll

@@ -134,7 +134,14 @@ public int Ping
 	public IReadOnlyDictionary<ulong, DiscordPresence> Presences
 		=> this._presencesLazy.Value;
 
+	/// <summary>
+	///     Gets the internal collection of presences.
+	/// </summary>
 	internal ConcurrentDictionary<ulong, DiscordPresence> PresencesInternal = [];
+
+	/// <summary>
+	///     Lazily gets the collection of presences held by this client.
+	/// </summary>
 	private Lazy<IReadOnlyDictionary<ulong, DiscordPresence>> _presencesLazy;
 
 	/// <summary>
@@ -143,7 +150,14 @@ public IReadOnlyDictionary<ulong, DiscordPresence> Presences
 	public IReadOnlyDictionary<string, DiscordActivity> EmbeddedActivities
 		=> this._embeddedActivitiesLazy.Value;
 
+	/// <summary>
+	///     Gets the internal collection of embedded activities.
+	/// </summary>
 	internal ConcurrentDictionary<string, DiscordActivity> EmbeddedActivitiesInternal = [];
+
+	/// <summary>
+	///     Lazily gets the collection of embedded activities held by this client.
+	/// </summary>
 	private Lazy<IReadOnlyDictionary<string, DiscordActivity>> _embeddedActivitiesLazy;
 
 	/// <summary>
@@ -419,7 +433,6 @@ public async Task ConnectAsync(DiscordActivity? activity = null, UserStatus? sta
 			return;
 
 		if (this.Configuration.AutoFetchSkuIds)
-		{
 			try
 			{
 				var skus = await this.ApiClient.GetSkusAsync(this.CurrentApplication.Id).ConfigureAwait(false);
@@ -432,7 +445,6 @@ public async Task ConnectAsync(DiscordActivity? activity = null, UserStatus? sta
 			{
 				this.Logger.LogError(LoggerEvents.Startup, ex, "Failed to fetch SKU IDs");
 			}
-		}
 
 		if (this.Configuration.AutoFetchApplicationEmojis)
 			try
@@ -621,16 +633,22 @@ public async Task<IReadOnlyList<DiscordSku>> GetSkusAsync()
 	/// <param name="before">Retrieve entitlements before this entitlement ID.</param>
 	/// <param name="after">Retrieve entitlements after this entitlement ID.</param>
 	/// <param name="limit">Number of entitlements to return, 1-100, default 100.</param>
-	/// <param name="excludeEnded">Whether or not ended entitlements should be omitted. Defaults to false, ended entitlements are included by default.</param>
-	/// <param name="excludeDeleted">Whether or not deleted entitlements should be omitted. Defaults to true, deleted entitlements are not included by default.</param>
+	/// <param name="excludeEnded">
+	///     Whether or not ended entitlements should be omitted. Defaults to false, ended entitlements
+	///     are included by default.
+	/// </param>
+	/// <param name="excludeDeleted">
+	///     Whether or not deleted entitlements should be omitted. Defaults to true, deleted
+	///     entitlements are not included by default.
+	/// </param>
 	/// <returns>A list of <see cref="DiscordEntitlement" />.</returns>
 	/// <exception cref="NotFoundException">Thrown when the entitlements do not exist.</exception>
 	[RequiresFeature(Features.MonetizedApplication)]
 	public async Task<IReadOnlyList<DiscordEntitlement>> GetEntitlementsAsync(ulong? guildId = null, ulong? userId = null, List<ulong>? skuIds = null, ulong? before = null, ulong? after = null, int limit = 100, bool? excludeEnded = null, bool? excludeDeleted = null)
 		=> await this.ApiClient.GetEntitlementsAsync(this.CurrentApplication.Id, guildId, userId, skuIds, before, after, limit, excludeEnded, excludeDeleted).ConfigureAwait(false);
 
 	/// <summary>
-	///     Gets an entitlement for given <paramref name="applicationId"/>.
+	///     Gets an entitlement for given <paramref name="applicationId" />.
 	/// </summary>
 	/// <param name="entitlementId">The entitlement id to fetch.</param>
 	/// <returns>The requested <see cref="DiscordEntitlement" />.</returns>

Diff for: plugins/System.Composition.AttributedModel.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/System.Composition.AttributedModel.dll

@@ -459,7 +459,9 @@ internal void EventErrorHandler<TSender, TArgs>(AsyncEvent<TSender, TArgs> async
 	private void Goof<TSender, TArgs>(AsyncEvent<TSender, TArgs> asyncEvent, Exception ex, AsyncEventHandler<TSender, TArgs> handler, TSender sender, TArgs eventArgs)
 		where TArgs : AsyncEventArgs => this.Logger.LogCritical(LoggerEvents.EventHandlerException, ex, "Exception event handler {Method} (defined in {DeclaringType}) threw an exception", handler.Method, handler.Method.DeclaringType);
 
-	/// <inheritdoc />
+	/// <summary>
+	///     Disposes the client.
+	/// </summary>
 	~DiscordOAuth2Client()
 	{
 		this.Dispose();

Diff for: plugins/System.Composition.Convention.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/System.Composition.Convention.dll

@@ -790,7 +790,7 @@ public event AsyncEventHandler<DiscordClient, GuildSoundboardSoundsUpdateEventAr
 	private AsyncEvent<DiscordClient, GuildSoundboardSoundsUpdateEventArgs> _guildSoundboardSoundsUpdated;
 
 	/// <summary>
-	///     Fired in response to <see cref="DiscordClient.RequestSoundboardSoundsAsync"/>.
+	///     Fired in response to <see cref="DiscordClient.RequestSoundboardSoundsAsync" />.
 	/// </summary>
 	public event AsyncEventHandler<DiscordClient, SoundboardSoundsEventArgs> SoundboardSounds
 	{
@@ -2198,6 +2198,5 @@ private Task Client_GuildJoinRequestUpdated(DiscordClient client, GuildJoinReque
 	private Task Client_GuildJoinRequestDeleted(DiscordClient client, GuildJoinRequestDeleteEventArgs e)
 		=> this._guildJoinRequestDeleted.InvokeAsync(client, e);
 
-
 #endregion
 }

Diff for: plugins/System.Composition.Hosting.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/System.Composition.Hosting.dll

@@ -185,6 +185,9 @@ internal async Task<int> InitializeShardsAsync()
 
 #region Destructor
 
+	/// <summary>
+	///     Disposes the client.
+	/// </summary>
 	~DiscordShardedClient()
 	{
 		this.InternalStopAsync(false).GetAwaiter().GetResult();

Diff for: plugins/System.Composition.Runtime.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/System.Composition.Runtime.dll

@@ -20,13 +20,21 @@ namespace DisCatSharp;
 /// </summary>
 public class DiscordWebhookClient
 {
+	/// <summary>
+	///     Gets the API client for this webhook client.
+	/// </summary>
 	internal readonly DiscordApiClient ApiClient;
+
+	/// <summary>
+	///     Gets the log timestamp format for this webhook client.
+	/// </summary>
 	internal readonly string LogTimestampFormat;
 
+	/// <summary>
+	///     Gets the minimum log level for this webhook client.
+	/// </summary>
 	internal readonly LogLevel MinimumLogLevel;
 
-	internal List<DiscordWebhook> Hooks;
-
 	/// <summary>
 	///     Creates a new webhook client.
 	/// </summary>
@@ -76,6 +84,11 @@ public DiscordWebhookClient(
 		this.Webhooks = new ReadOnlyCollection<DiscordWebhook>(this.Hooks);
 	}
 
+	/// <summary>
+	///     Gets the list of registered webhooks.
+	/// </summary>
+	internal List<DiscordWebhook> Hooks { get; set; } = [];
+
 	/// <summary>
 	///     Gets the logger for this client.
 	/// </summary>
@@ -235,6 +248,9 @@ public async Task<Dictionary<DiscordWebhook, DiscordMessage>> BroadcastMessageAs
 		return messages;
 	}
 
+	/// <summary>
+	///     Disposes the client.
+	/// </summary>
 	~DiscordWebhookClient()
 	{
 		this.Hooks.Clear();

Diff for: plugins/System.Composition.TypedParts.dll renamed to DisCatSharp.Docs/dcs/disable_plugins/System.Composition.TypedParts.dll

@@ -39,7 +39,7 @@ internal DiscordApplication(TransportApplication tapp)
 		this.CustomInstallUrl = tapp.CustomInstallUrl;
 		this.InstallParams = tapp.InstallParams;
 		this.RoleConnectionsVerificationUrl = tapp.RoleConnectionsVerificationUrl.ValueOrDefault();
-		this.Tags = [..tapp.Tags];
+		this.Tags = [.. tapp.Tags];
 		this.Id = tapp.Id;
 		this.Name = tapp.Name;
 		this.IconHash = tapp.IconHash;
@@ -87,7 +87,7 @@ internal DiscordApplication(TransportApplication tapp)
 				.Select(x => x.User)
 				.ToArray();
 
-			this.Members = [..users];
+			this.Members = [.. users];
 			this.Team.Owner = members.First(x => x.Role == "owner").User;
 			this.Team.Members = new List<DiscordTeamMember>(members);
 			this.TeamName = this.Team.Name;

Diff for: plugins/runtimes/linux-arm/native/libgit2-3f4182d.so renamed to DisCatSharp.Docs/dcs/disable_plugins/runtimes/linux-arm/native/libgit2-3f4182d.so

@@ -70,8 +70,4 @@ public override int GetHashCode()
 	/// <returns>Whether the two channels are not equal.</returns>
 	public static bool operator !=(DiscordGuildDirectoryChannel e1, DiscordGuildDirectoryChannel e2)
 		=> !(e1 == e2);
-
-#region Methods
-
-#endregion
 }