@minesa-org/mini-interaction 0.0.1

package/dist/commands/CommandBuilder.d.ts

@@ -0,0 +1,278 @@
+import { ChannelType, type APIApplicationCommandAttachmentOption, type APIApplicationCommandBasicOption, type APIApplicationCommandChannelOption, type APIApplicationCommandMentionableOption, type APIApplicationCommandNumberOption, type APIApplicationCommandOption, type APIApplicationCommandOptionChoice, type APIApplicationCommandRoleOption, type APIApplicationCommandStringOption, type APIApplicationCommandSubcommandGroupOption, type APIApplicationCommandSubcommandOption, type APIApplicationCommandUserOption, type LocalizationMap, type Permissions, type RESTPostAPIChatInputApplicationCommandsJSONBody } from "discord-api-types/v10";
+/** Supported integration types for Discord application commands. */
+export declare enum IntegrationType {
+    GuildInstall = 0,
+    UserInstall = 1
+}
+/** Supported contexts where a command can be invoked. */
+export declare enum CommandContext {
+    Guild = 0,
+    Bot = 1,
+    DM = 2
+}
+/**
+ * Provides shared builder utilities for application command option definitions.
+ */
+declare abstract class BaseOptionBuilder<Data extends APIApplicationCommandOption> {
+    protected readonly data: Data;
+    /**
+     * Creates a new option builder wrapper around an underlying option payload.
+     */
+    protected constructor(data: Data);
+    /**
+     * Sets the option name while validating Discord's requirements.
+     */
+    setName(name: string): this;
+    /**
+     * Sets localized translations for the option name.
+     */
+    setNameLocalizations(localizations: LocalizationMap | null): this;
+    /**
+     * Sets the option description while validating Discord's length requirements.
+     */
+    setDescription(description: string): this;
+    /**
+     * Sets localized translations for the option description.
+     */
+    setDescriptionLocalizations(localizations: LocalizationMap | null): this;
+    /**
+     * Produces a deep copy of the built option payload for safe reuse.
+     */
+    toJSON(): Data;
+}
+/**
+ * Extends {@link BaseOptionBuilder} with helpers specific to basic command options.
+ */
+declare abstract class BaseCommandOptionBuilder<Data extends APIApplicationCommandBasicOption> extends BaseOptionBuilder<Data> {
+    /**
+     * Marks the option as required within its parent context.
+     */
+    setRequired(required?: boolean): this;
+}
+/** Builder for attachment command options. */
+declare class AttachmentOptionBuilder extends BaseCommandOptionBuilder<APIApplicationCommandAttachmentOption> {
+    constructor();
+}
+/** Builder for user command options. */
+declare class UserOptionBuilder extends BaseCommandOptionBuilder<APIApplicationCommandUserOption> {
+    constructor();
+}
+/** Builder for role command options. */
+declare class RoleOptionBuilder extends BaseCommandOptionBuilder<APIApplicationCommandRoleOption> {
+    constructor();
+}
+/** Builder for mentionable command options. */
+declare class MentionableOptionBuilder extends BaseCommandOptionBuilder<APIApplicationCommandMentionableOption> {
+    constructor();
+}
+/** Builder for channel command options with channel type filtering support. */
+declare class ChannelOptionBuilder extends BaseCommandOptionBuilder<APIApplicationCommandChannelOption> {
+    constructor();
+    /**
+     * Limits selectable channels to the provided channel types.
+     */
+    addChannelTypes(...channelTypes: ChannelType[]): this;
+}
+/** Builder for string command options, including choice and autocomplete support. */
+declare class StringOptionBuilder extends BaseCommandOptionBuilder<APIApplicationCommandStringOption> {
+    constructor();
+    /**
+     * Adds a single choice option for the string command option.
+     */
+    addChoice(name: string, value: string): this;
+    /**
+     * Adds multiple choice entries for the string command option.
+     */
+    addChoices(...choices: APIApplicationCommandOptionChoice<string>[]): this;
+    /**
+     * Replaces the existing choice set with the provided entries.
+     */
+    setChoices(...choices: APIApplicationCommandOptionChoice<string>[]): this;
+    /**
+     * Enables or disables autocomplete for the string option.
+     */
+    setAutocomplete(autocomplete?: boolean): this;
+    /**
+     * Sets the minimum string length accepted for the option value.
+     */
+    setMinLength(minLength: number): this;
+    /**
+     * Sets the maximum string length accepted for the option value.
+     */
+    setMaxLength(maxLength: number): this;
+}
+/** Builder for numeric command options with choice and range support. */
+declare class NumberOptionBuilder extends BaseCommandOptionBuilder<APIApplicationCommandNumberOption> {
+    constructor();
+    /**
+     * Adds a single numeric choice for the option.
+     */
+    addChoice(name: string, value: number): this;
+    /**
+     * Adds multiple numeric choice entries for the option.
+     */
+    addChoices(...choices: APIApplicationCommandOptionChoice<number>[]): this;
+    /**
+     * Replaces the current choice set with the provided entries.
+     */
+    setChoices(...choices: APIApplicationCommandOptionChoice<number>[]): this;
+    /**
+     * Enables or disables autocomplete for the numeric option.
+     */
+    setAutocomplete(autocomplete?: boolean): this;
+    /**
+     * Sets the minimum numeric value allowed for the option.
+     */
+    setMinValue(minValue: number): this;
+    /**
+     * Sets the maximum numeric value allowed for the option.
+     */
+    setMaxValue(maxValue: number): this;
+}
+/** Callback type accepted by option builder helper methods for customization. */
+type OptionBuilderCallback<Builder> = (builder: Builder) => Builder | void;
+/** Builder used to compose individual slash command subcommands. */
+declare class SubcommandBuilder extends BaseOptionBuilder<APIApplicationCommandSubcommandOption> {
+    constructor();
+    /**
+     * Ensures the subcommand does not exceed Discord's option limit.
+     */
+    private assertOptionLimit;
+    /**
+     * Adds a string option configured through the supplied callback.
+     */
+    addStringOption(callback: OptionBuilderCallback<StringOptionBuilder>): this;
+    /**
+     * Adds a number option configured through the supplied callback.
+     */
+    addNumberOption(callback: OptionBuilderCallback<NumberOptionBuilder>): this;
+    /**
+     * Adds an attachment option configured through the supplied callback.
+     */
+    addAttachmentOption(callback: OptionBuilderCallback<AttachmentOptionBuilder>): this;
+    /**
+     * Adds a user option configured through the supplied callback.
+     */
+    addUserOption(callback: OptionBuilderCallback<UserOptionBuilder>): this;
+    /**
+     * Adds a role option configured through the supplied callback.
+     */
+    addRoleOption(callback: OptionBuilderCallback<RoleOptionBuilder>): this;
+    /**
+     * Adds a mentionable option configured through the supplied callback.
+     */
+    addMentionableOption(callback: OptionBuilderCallback<MentionableOptionBuilder>): this;
+    /**
+     * Adds a channel option configured through the supplied callback.
+     */
+    addChannelOption(callback: OptionBuilderCallback<ChannelOptionBuilder>): this;
+    /**
+     * Produces a serialisable representation of the subcommand configuration.
+     */
+    toJSON(): APIApplicationCommandSubcommandOption;
+}
+/** Builder used to compose groups of subcommands. */
+declare class SubcommandGroupBuilder extends BaseOptionBuilder<APIApplicationCommandSubcommandGroupOption> {
+    constructor();
+    /**
+     * Ensures the group does not exceed Discord's subcommand limit.
+     */
+    private assertSubcommandLimit;
+    /**
+     * Adds a subcommand configured through the supplied callback.
+     */
+    addSubcommand(callback: OptionBuilderCallback<SubcommandBuilder>): this;
+    /**
+     * Produces a serialisable representation of the subcommand group configuration.
+     */
+    toJSON(): APIApplicationCommandSubcommandGroupOption;
+}
+/** Fluent builder for constructing Discord chat input command payloads. */
+export declare class CommandBuilder {
+    private readonly data;
+    /**
+     * Ensures the command does not exceed Discord's option limit.
+     */
+    private assertOptionLimit;
+    /**
+     * Sets the command name while validating Discord's requirements.
+     */
+    setName(name: string): this;
+    /**
+     * Sets localized translations for the command name.
+     */
+    setNameLocalizations(localizations: LocalizationMap | null): this;
+    /**
+     * Sets the command description while enforcing Discord's length rules.
+     */
+    setDescription(description: string): this;
+    /**
+     * Sets localized translations for the command description.
+     */
+    setDescriptionLocalizations(localizations: LocalizationMap | null): this;
+    /**
+     * Configures the default member permissions required to use the command.
+     */
+    setDefaultMemberPermissions(permissions: Permissions | bigint | number | string | null): this;
+    /**
+     * Sets whether the command is available in direct messages.
+     */
+    setDMPermission(dmPermission: boolean): this;
+    /**
+     * Marks the command as not safe for work.
+     */
+    setNSFW(nsfw: boolean): this;
+    /**
+     * Limits the contexts in which the command can appear.
+     */
+    setContexts(contexts: CommandContext[] | null): this;
+    /**
+     * Specifies the integration types supported by the command.
+     */
+    setIntegrationTypes(integrationTypes: IntegrationType[]): this;
+    /**
+     * Adds a subcommand to the command definition.
+     */
+    addSubcommand(callback: OptionBuilderCallback<SubcommandBuilder>): this;
+    /**
+     * Adds a subcommand group to the command definition.
+     */
+    addSubcommandGroup(callback: OptionBuilderCallback<SubcommandGroupBuilder>): this;
+    /**
+     * Adds a string option to the command definition.
+     */
+    addStringOption(callback: OptionBuilderCallback<StringOptionBuilder>): this;
+    /**
+     * Adds a number option to the command definition.
+     */
+    addNumberOption(callback: OptionBuilderCallback<NumberOptionBuilder>): this;
+    /**
+     * Adds an attachment option to the command definition.
+     */
+    addAttachmentOption(callback: OptionBuilderCallback<AttachmentOptionBuilder>): this;
+    /**
+     * Adds a user option to the command definition.
+     */
+    addUserOption(callback: OptionBuilderCallback<UserOptionBuilder>): this;
+    /**
+     * Adds a role option to the command definition.
+     */
+    addRoleOption(callback: OptionBuilderCallback<RoleOptionBuilder>): this;
+    /**
+     * Adds a mentionable option to the command definition.
+     */
+    addMentionableOption(callback: OptionBuilderCallback<MentionableOptionBuilder>): this;
+    /**
+     * Adds a channel option to the command definition.
+     */
+    addChannelOption(callback: OptionBuilderCallback<ChannelOptionBuilder>): this;
+    /**
+     * Produces the final REST payload for the configured command.
+     */
+    toJSON(): RESTPostAPIChatInputApplicationCommandsJSONBody;
+    /**
+     * Allows the builder to be coerced into its JSON payload automatically.
+     */
+    valueOf(): RESTPostAPIChatInputApplicationCommandsJSONBody;
+}
+export type { AttachmentOptionBuilder, ChannelOptionBuilder, MentionableOptionBuilder, NumberOptionBuilder, RoleOptionBuilder, StringOptionBuilder, SubcommandBuilder, SubcommandGroupBuilder, UserOptionBuilder, };