ApplicationCommandsConfiguration.cs

using System;

using DisCatSharp.Attributes;

using Microsoft.Extensions.DependencyInjection;

namespace DisCatSharp.ApplicationCommands;

/// <summary>
/// A configuration for a <see cref="ApplicationCommandsExtension"/>
/// </summary>
public sealed class ApplicationCommandsConfiguration
{
	/// <summary>
	/// <para>Sets the service provider.</para>
	/// <para>Objects in this provider are used when instantiating application command modules.</para>
	/// <para>This allows passing data around without resorting to static members.</para>
	/// <para>Defaults to <see langword="null"/>.</para>
	/// </summary>
	public IServiceProvider ServiceProvider { internal get; set; } = new ServiceCollection().BuildServiceProvider(true);

	/// <summary>
	/// <para>This option enables the default help command.</para>
	/// <para>Disabling this will allow you to make your own help command.</para>
	/// <para>Defaults to <see langword="true"/>.</para>
	/// </summary>
	public bool EnableDefaultHelp { internal get; set; } = true;

	/// <summary>
	/// <para>This option enables the default help command with user apps capability.</para>
	/// <para>Mutually exclusive with <see cref="EnableDefaultHelp"/>.</para>
	/// <para>Defaults to <see langword="false"/>.</para>
	/// </summary>
	[DiscordInExperiment, RequiresFeature(Features.Experiment, "Requires you to be part of the user apps experiment and the apps owner.")]
	public bool EnableDefaultUserAppsHelp { get; set; } = false;

	/// <summary>
	/// This option enables the localization feature.
	/// <para>Defaults to <see langword="false"/>.</para>
	/// </summary>
	public bool EnableLocalization { internal get; set; } = false;

	// TODO: Check if it interferes with callback hints
	/// <summary>
	/// <para>Automatically defer all responses.</para>
	/// <note type="note">If you enable this, you can't use CreateResponse. Use EditResponse instead.</note>
	/// <para>Defaults to <see langword="false"/>.</para>
	/// </summary>
	public bool AutoDefer { internal get; set; } = false;

	/// <summary>
	/// <para>This option informs the module to check through all guilds whether the
	/// <see target="_blank" alt="Application Commands Scope" href="https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes">application.commands</see> scope is set.</para>
	/// <note type="warning">This will take quite a while, when the bot is on more than 1k guilds.</note>
	/// <para>Defaults to <see langword="false"/>.</para>
	/// </summary>
	public bool CheckAllGuilds { internal get; set; } = false;

	/// <summary>
	/// <para>This option increases the debug output of the module.</para>
	/// <note type="warning">
	/// <para>This is not recommended for production use.</para>
	/// <para>Enable this option only if DisCatSharp support advises you to do so.</para>
	/// </note>
	/// <para>Defaults to <see langword="false"/>.</para>
	/// </summary>
	public bool DebugStartup { internal get; set; } = false;

	/// <summary>
	/// <para>Whether to only generate translations files and abort after that.</para>
	/// <para>Defaults to <see langword="false"/>.</para>
	/// </summary>
	public bool GenerateTranslationFilesOnly { internal get; set; } = false;

	/// <summary>
	/// Whether to enable unit test mode.
	/// </summary>
	internal bool UnitTestMode { get; set; } = false;

	/// <summary>
	/// Creates a new configuration with default values.
	/// </summary>
	[ActivatorUtilitiesConstructor]
	public ApplicationCommandsConfiguration()
	{ }

	/// <summary>
	/// Utilized via dependency injection pipeline.
	/// </summary>
	/// <param name="provider">The service provider.</param>
	[ActivatorUtilitiesConstructor]
	public ApplicationCommandsConfiguration(IServiceProvider provider)
	{
		this.ServiceProvider = provider;
	}

	/// <summary>
	/// Creates a new instance of <see cref="ApplicationCommandsConfiguration"/>, copying the properties of another configuration.
	/// </summary>
	/// <param name="acc">Configuration the properties of which are to be copied.</param>
	public ApplicationCommandsConfiguration(ApplicationCommandsConfiguration acc)
	{
		this.EnableDefaultHelp = acc.EnableDefaultHelp;
		this.ServiceProvider = acc.ServiceProvider;
		this.DebugStartup = acc.DebugStartup;
		this.CheckAllGuilds = acc.CheckAllGuilds;
		this.AutoDefer = acc.AutoDefer;
		this.EnableLocalization = acc.EnableLocalization;
		this.GenerateTranslationFilesOnly = acc.GenerateTranslationFilesOnly;
		this.EnableDefaultUserAppsHelp = acc.EnableDefaultUserAppsHelp;
		this.UnitTestMode = acc.UnitTestMode;
	}
}