@discordjs/builders 1.4.0-dev.1667304280-8b400ca.0 → 1.4.0-dev.1667390683-5152abf.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _sapphire_shapeshift from '@sapphire/shapeshift';
-import { APIEmbedField, APIEmbedAuthor, APIEmbedFooter, APIEmbedImage, APIEmbed, APISelectMenuOption, APIMessageComponentEmoji, ButtonStyle, APIActionRowComponent, APIActionRowComponentTypes, APIBaseComponent, ComponentType, APIButtonComponent, APISelectMenuComponent, APITextInputComponent, TextInputStyle, APIMessageActionRowComponent, APIModalActionRowComponent, APIModalComponent, APIMessageComponent, APIModalInteractionResponseCallbackData, LocalizationMap, LocaleString, ApplicationCommandOptionType, APIApplicationCommandBasicOption, APIApplicationCommandAttachmentOption, APIApplicationCommandBooleanOption, ChannelType, APIApplicationCommandChannelOption, APIApplicationCommandOptionChoice, APIApplicationCommandIntegerOption, APIApplicationCommandMentionableOption, APIApplicationCommandNumberOption, APIApplicationCommandRoleOption, APIApplicationCommandStringOption, APIApplicationCommandUserOption, APIApplicationCommandSubcommandGroupOption, APIApplicationCommandSubcommandOption, Permissions, RESTPostAPIChatInputApplicationCommandsJSONBody, APIApplicationCommandOption, Locale, RESTPostAPIContextMenuApplicationCommandsJSONBody, ApplicationCommandType } from 'discord-api-types/v10';
+import { APIEmbedField, APIEmbedAuthor, APIEmbedFooter, APIEmbedImage, APIEmbed, APISelectMenuOption, APIMessageComponentEmoji, ButtonStyle, ChannelType, APIActionRowComponent, APIActionRowComponentTypes, APIBaseComponent, ComponentType, APIButtonComponent, APISelectMenuComponent, APIChannelSelectComponent, APIMentionableSelectComponent, APIRoleSelectComponent, APIStringSelectComponent, APIUserSelectComponent, APITextInputComponent, TextInputStyle, APIMessageActionRowComponent, APIModalActionRowComponent, APIModalComponent, APIMessageComponent, APIModalInteractionResponseCallbackData, LocalizationMap, LocaleString, ApplicationCommandOptionType, APIApplicationCommandBasicOption, APIApplicationCommandAttachmentOption, APIApplicationCommandBooleanOption, APIApplicationCommandChannelOption, APIApplicationCommandOptionChoice, APIApplicationCommandIntegerOption, APIApplicationCommandMentionableOption, APIApplicationCommandNumberOption, APIApplicationCommandRoleOption, APIApplicationCommandStringOption, APIApplicationCommandUserOption, APIApplicationCommandSubcommandGroupOption, APIApplicationCommandSubcommandOption, Permissions, RESTPostAPIChatInputApplicationCommandsJSONBody, APIApplicationCommandOption, Locale, RESTPostAPIContextMenuApplicationCommandsJSONBody, ApplicationCommandType } from 'discord-api-types/v10';
 import { URL } from 'node:url';
 import { Snowflake } from 'discord-api-types/globals';
 import { JSONEncodable, Equatable } from '@discordjs/util';
@@ -519,16 +519,16 @@ declare enum Faces {
 }
 
 /**
- * Represents a option within a select menu component
+ * Represents an option within a string select menu component
  */
-declare class SelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption> {
+declare class StringSelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption> {
     data: Partial<APISelectMenuOption>;
     /**
-     * Creates a new select menu option from API data
+     * Creates a new string select menu option from API data
      *
-     * @param data - The API data to create this select menu option with
+     * @param data - The API data to create this string select menu option with
      * @example
-     * Creating a select menu option from an API data object
+     * Creating a string select menu option from an API data object
      * ```ts
      * const selectMenuOption = new SelectMenuOptionBuilder({
      * 	label: 'catchy label',
@@ -536,7 +536,7 @@ declare class SelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOpti
      * });
      * ```
      * @example
-     * Creating a select menu option using setters and API data
+     * Creating a string select menu option using setters and API data
      * ```ts
      * const selectMenuOption = new SelectMenuOptionBuilder({
      * 	default: true,
@@ -619,12 +619,13 @@ declare const jsonOptionValidator: _sapphire_shapeshift.ObjectValidator<{
     }> | undefined;
     default: boolean | undefined;
 }>>;
-declare const optionValidator: _sapphire_shapeshift.InstanceValidator<SelectMenuOptionBuilder>;
-declare const optionsValidator: _sapphire_shapeshift.ArrayValidator<SelectMenuOptionBuilder[], SelectMenuOptionBuilder>;
+declare const optionValidator: _sapphire_shapeshift.InstanceValidator<StringSelectMenuOptionBuilder>;
+declare const optionsValidator: _sapphire_shapeshift.ArrayValidator<StringSelectMenuOptionBuilder[], StringSelectMenuOptionBuilder>;
 declare const optionsLengthValidator: _sapphire_shapeshift.NumberValidator<number>;
-declare function validateRequiredSelectMenuParameters(options: SelectMenuOptionBuilder[], customId?: string): void;
+declare function validateRequiredSelectMenuParameters(options: StringSelectMenuOptionBuilder[], customId?: string): void;
 declare const defaultValidator: _sapphire_shapeshift.BooleanValidator<boolean>;
 declare function validateRequiredSelectMenuOptionParameters(label?: string, value?: string): void;
+declare const channelTypesValidator: _sapphire_shapeshift.ArrayValidator<ChannelType[], ChannelType>;
 declare const urlValidator: _sapphire_shapeshift.StringValidator<string>;
 declare function validateRequiredButtonParameters(style?: ButtonStyle, label?: string, emoji?: APIMessageComponentEmoji, customId?: string, url?: string): void;
 
@@ -642,6 +643,7 @@ declare const Assertions$4_optionsLengthValidator: typeof optionsLengthValidator
 declare const Assertions$4_validateRequiredSelectMenuParameters: typeof validateRequiredSelectMenuParameters;
 declare const Assertions$4_defaultValidator: typeof defaultValidator;
 declare const Assertions$4_validateRequiredSelectMenuOptionParameters: typeof validateRequiredSelectMenuOptionParameters;
+declare const Assertions$4_channelTypesValidator: typeof channelTypesValidator;
 declare const Assertions$4_urlValidator: typeof urlValidator;
 declare const Assertions$4_validateRequiredButtonParameters: typeof validateRequiredButtonParameters;
 declare namespace Assertions$4 {
@@ -661,6 +663,7 @@ declare namespace Assertions$4 {
     Assertions$4_validateRequiredSelectMenuParameters as validateRequiredSelectMenuParameters,
     Assertions$4_defaultValidator as defaultValidator,
     Assertions$4_validateRequiredSelectMenuOptionParameters as validateRequiredSelectMenuOptionParameters,
+    Assertions$4_channelTypesValidator as channelTypesValidator,
     Assertions$4_urlValidator as urlValidator,
     Assertions$4_validateRequiredButtonParameters as validateRequiredButtonParameters,
   };
@@ -768,14 +771,41 @@ declare class ButtonBuilder extends ComponentBuilder<APIButtonComponent> {
     toJSON(): APIButtonComponent;
 }
 
-/**
- * Represents a select menu component
- */
-declare class SelectMenuBuilder extends ComponentBuilder<APISelectMenuComponent> {
+declare class BaseSelectMenuBuilder<SelectMenuType extends APISelectMenuComponent> extends ComponentBuilder<SelectMenuType> {
     /**
-     * The options within this select menu
+     * Sets the placeholder for this select menu
+     *
+     * @param placeholder - The placeholder to use for this select menu
+     */
+    setPlaceholder(placeholder: string): this;
+    /**
+     * Sets the minimum values that must be selected in the select menu
+     *
+     * @param minValues - The minimum values that must be selected
      */
-    readonly options: SelectMenuOptionBuilder[];
+    setMinValues(minValues: number): this;
+    /**
+     * Sets the maximum values that must be selected in the select menu
+     *
+     * @param maxValues - The maximum values that must be selected
+     */
+    setMaxValues(maxValues: number): this;
+    /**
+     * Sets the custom id for this select menu
+     *
+     * @param customId - The custom id to use for this select menu
+     */
+    setCustomId(customId: string): this;
+    /**
+     * Sets whether this select menu is disabled
+     *
+     * @param disabled - Whether this select menu is disabled
+     */
+    setDisabled(disabled?: boolean): this;
+    toJSON(): SelectMenuType;
+}
+
+declare class ChannelSelectMenuBuilder extends BaseSelectMenuBuilder<APIChannelSelectComponent> {
     /**
      * Creates a new select menu from API data
      *
@@ -783,78 +813,166 @@ declare class SelectMenuBuilder extends ComponentBuilder<APISelectMenuComponent>
      * @example
      * Creating a select menu from an API data object
      * ```ts
-     * const selectMenu = new SelectMenuBuilder({
+     * const selectMenu = new ChannelSelectMenuBuilder({
      * 	custom_id: 'a cool select menu',
      * 	placeholder: 'select an option',
      * 	max_values: 2,
-     * 	options: [
-     * 		{ label: 'option 1', value: '1' },
-     * 		{ label: 'option 2', value: '2' },
-     * 		{ label: 'option 3', value: '3' },
-     * 	],
      * });
      * ```
      * @example
      * Creating a select menu using setters and API data
      * ```ts
-     * const selectMenu = new SelectMenuBuilder({
+     * const selectMenu = new ChannelSelectMenuBuilder({
      * 	custom_id: 'a cool select menu',
      * })
-     * 	.setMinValues(1)
-     * 	.addOptions({
-     * 		label: 'Catchy',
-     * 		value: 'catch',
-     * 	});
+     * 	.addChannelTypes(ChannelType.GuildText, ChannelType.GuildAnnouncement)
+     * 	.setMinValues(2)
      * ```
      */
-    constructor(data?: Partial<APISelectMenuComponent>);
+    constructor(data?: Partial<APIChannelSelectComponent>);
+    addChannelTypes(...types: RestOrArray<ChannelType>): this;
+    setChannelTypes(...types: RestOrArray<ChannelType>): this;
     /**
-     * Sets the placeholder for this select menu
-     *
-     * @param placeholder - The placeholder to use for this select menu
+     * {@inheritDoc ComponentBuilder.toJSON}
      */
-    setPlaceholder(placeholder: string): this;
+    toJSON(): APIChannelSelectComponent;
+}
+
+declare class MentionableSelectMenuBuilder extends BaseSelectMenuBuilder<APIMentionableSelectComponent> {
     /**
-     * Sets the minimum values that must be selected in the select menu
+     * Creates a new select menu from API data
      *
-     * @param minValues - The minimum values that must be selected
+     * @param data - The API data to create this select menu with
+     * @example
+     * Creating a select menu from an API data object
+     * ```ts
+     * const selectMenu = new MentionableSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * 	placeholder: 'select an option',
+     * 	max_values: 2,
+     * });
+     * ```
+     * @example
+     * Creating a select menu using setters and API data
+     * ```ts
+     * const selectMenu = new MentionableSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * })
+     * 	.setMinValues(1)
+     * ```
      */
-    setMinValues(minValues: number): this;
+    constructor(data?: Partial<APIMentionableSelectComponent>);
+}
+
+declare class RoleSelectMenuBuilder extends BaseSelectMenuBuilder<APIRoleSelectComponent> {
     /**
-     * Sets the maximum values that must be selected in the select menu
+     * Creates a new select menu from API data
      *
-     * @param maxValues - The maximum values that must be selected
+     * @param data - The API data to create this select menu with
+     * @example
+     * Creating a select menu from an API data object
+     * ```ts
+     * const selectMenu = new RoleSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * 	placeholder: 'select an option',
+     * 	max_values: 2,
+     * });
+     * ```
+     * @example
+     * Creating a select menu using setters and API data
+     * ```ts
+     * const selectMenu = new RoleSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * })
+     * 	.setMinValues(1)
+     * ```
      */
-    setMaxValues(maxValues: number): this;
+    constructor(data?: Partial<APIRoleSelectComponent>);
+}
+
+/**
+ * Represents a string select menu component
+ */
+declare class StringSelectMenuBuilder extends BaseSelectMenuBuilder<APIStringSelectComponent> {
     /**
-     * Sets the custom id for this select menu
-     *
-     * @param customId - The custom id to use for this select menu
+     * The options within this select menu
      */
-    setCustomId(customId: string): this;
+    readonly options: StringSelectMenuOptionBuilder[];
     /**
-     * Sets whether this select menu is disabled
+     * Creates a new select menu from API data
      *
-     * @param disabled - Whether this select menu is disabled
+     * @param data - The API data to create this select menu with
+     * @example
+     * Creating a select menu from an API data object
+     * ```ts
+     * const selectMenu = new StringSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * 	placeholder: 'select an option',
+     * 	max_values: 2,
+     * 	options: [
+     * 		{ label: 'option 1', value: '1' },
+     * 		{ label: 'option 2', value: '2' },
+     * 		{ label: 'option 3', value: '3' },
+     * 	],
+     * });
+     * ```
+     * @example
+     * Creating a select menu using setters and API data
+     * ```ts
+     * const selectMenu = new StringSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * })
+     * 	.setMinValues(1)
+     * 	.addOptions({
+     * 		label: 'Catchy',
+     * 		value: 'catch',
+     * 	});
+     * ```
      */
-    setDisabled(disabled?: boolean): this;
+    constructor(data?: Partial<APIStringSelectComponent>);
     /**
      * Adds options to this select menu
      *
      * @param options - The options to add to this select menu
      * @returns
      */
-    addOptions(...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>): this;
+    addOptions(...options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder>): this;
     /**
      * Sets the options on this select menu
      *
      * @param options - The options to set on this select menu
      */
-    setOptions(...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>): this;
+    setOptions(...options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder>): this;
     /**
      * {@inheritDoc ComponentBuilder.toJSON}
      */
-    toJSON(): APISelectMenuComponent;
+    toJSON(): APIStringSelectComponent;
+}
+
+declare class UserSelectMenuBuilder extends BaseSelectMenuBuilder<APIUserSelectComponent> {
+    /**
+     * Creates a new select menu from API data
+     *
+     * @param data - The API data to create this select menu with
+     * @example
+     * Creating a select menu from an API data object
+     * ```ts
+     * const selectMenu = new UserSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * 	placeholder: 'select an option',
+     * 	max_values: 2,
+     * });
+     * ```
+     * @example
+     * Creating a select menu using setters and API data
+     * ```ts
+     * const selectMenu = new UserSelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * })
+     * 	.setMinValues(1)
+     * ```
+     */
+    constructor(data?: Partial<APIUserSelectComponent>);
 }
 
 declare class TextInputBuilder extends ComponentBuilder<APITextInputComponent> implements Equatable<APITextInputComponent | JSONEncodable<APITextInputComponent>> {
@@ -944,7 +1062,7 @@ declare class TextInputBuilder extends ComponentBuilder<APITextInputComponent> i
 
 declare type MessageComponentBuilder = ActionRowBuilder<MessageActionRowComponentBuilder> | MessageActionRowComponentBuilder;
 declare type ModalComponentBuilder = ActionRowBuilder<ModalActionRowComponentBuilder> | ModalActionRowComponentBuilder;
-declare type MessageActionRowComponentBuilder = ButtonBuilder | SelectMenuBuilder;
+declare type MessageActionRowComponentBuilder = ButtonBuilder | ChannelSelectMenuBuilder | MentionableSelectMenuBuilder | RoleSelectMenuBuilder | StringSelectMenuBuilder | UserSelectMenuBuilder;
 declare type ModalActionRowComponentBuilder = TextInputBuilder;
 declare type AnyComponentBuilder = MessageActionRowComponentBuilder | ModalActionRowComponentBuilder;
 /**
@@ -1013,8 +1131,12 @@ declare class ActionRowBuilder<T extends AnyComponentBuilder> extends ComponentB
 interface MappedComponentTypes {
     [ComponentType.ActionRow]: ActionRowBuilder<AnyComponentBuilder>;
     [ComponentType.Button]: ButtonBuilder;
-    [ComponentType.SelectMenu]: SelectMenuBuilder;
+    [ComponentType.StringSelect]: StringSelectMenuBuilder;
     [ComponentType.TextInput]: TextInputBuilder;
+    [ComponentType.UserSelect]: UserSelectMenuBuilder;
+    [ComponentType.RoleSelect]: RoleSelectMenuBuilder;
+    [ComponentType.MentionableSelect]: MentionableSelectMenuBuilder;
+    [ComponentType.ChannelSelect]: ChannelSelectMenuBuilder;
 }
 /**
  * Factory for creating components from API data
@@ -1665,4 +1787,4 @@ declare const isValidationEnabled: () => boolean;
  */
 declare const version: string;
 
-export { ActionRowBuilder, AnyAPIActionRowComponent, AnyComponentBuilder, ApplicationCommandNumericOptionMinMaxValueMixin, ApplicationCommandOptionAllowedChannelTypes, ApplicationCommandOptionBase, ApplicationCommandOptionChannelTypesMixin, ApplicationCommandOptionWithChoicesAndAutocompleteMixin, ButtonBuilder, Assertions$4 as ComponentAssertions, ComponentBuilder, Assertions as ContextMenuCommandAssertions, ContextMenuCommandBuilder, ContextMenuCommandType, Assertions$5 as EmbedAssertions, EmbedAuthorData, EmbedAuthorOptions, EmbedBuilder, EmbedFooterData, EmbedFooterOptions, EmbedImageData, Faces, IconData, MappedComponentTypes, MessageActionRowComponentBuilder, MessageComponentBuilder, ModalActionRowComponentBuilder, Assertions$2 as ModalAssertions, ModalBuilder, ModalComponentBuilder, RGBTuple, RestOrArray, SelectMenuBuilder, SelectMenuOptionBuilder, SharedNameAndDescription, SharedSlashCommandOptions, Assertions$1 as SlashCommandAssertions, SlashCommandAttachmentOption, SlashCommandBooleanOption, SlashCommandBuilder, SlashCommandChannelOption, SlashCommandIntegerOption, SlashCommandMentionableOption, SlashCommandNumberOption, SlashCommandOptionsOnlyBuilder, SlashCommandRoleOption, SlashCommandStringOption, SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuilder, SlashCommandSubcommandsOnlyBuilder, SlashCommandUserOption, Assertions$3 as TextInputAssertions, TextInputBuilder, TimestampStyles, TimestampStylesString, ToAPIApplicationCommandOptions, blockQuote, bold, channelLink, channelMention, chatInputApplicationCommandMention, codeBlock, createComponentBuilder, disableValidators, embedLength, enableValidators, formatEmoji, hideLinkEmbed, hyperlink, inlineCode, isValidationEnabled, italic, messageLink, normalizeArray, quote, roleMention, spoiler, strikethrough, time, underscore, userMention, version };
+export { ActionRowBuilder, AnyAPIActionRowComponent, AnyComponentBuilder, ApplicationCommandNumericOptionMinMaxValueMixin, ApplicationCommandOptionAllowedChannelTypes, ApplicationCommandOptionBase, ApplicationCommandOptionChannelTypesMixin, ApplicationCommandOptionWithChoicesAndAutocompleteMixin, BaseSelectMenuBuilder, ButtonBuilder, ChannelSelectMenuBuilder, Assertions$4 as ComponentAssertions, ComponentBuilder, Assertions as ContextMenuCommandAssertions, ContextMenuCommandBuilder, ContextMenuCommandType, Assertions$5 as EmbedAssertions, EmbedAuthorData, EmbedAuthorOptions, EmbedBuilder, EmbedFooterData, EmbedFooterOptions, EmbedImageData, Faces, IconData, MappedComponentTypes, MentionableSelectMenuBuilder, MessageActionRowComponentBuilder, MessageComponentBuilder, ModalActionRowComponentBuilder, Assertions$2 as ModalAssertions, ModalBuilder, ModalComponentBuilder, RGBTuple, RestOrArray, RoleSelectMenuBuilder, StringSelectMenuBuilder as SelectMenuBuilder, StringSelectMenuOptionBuilder as SelectMenuOptionBuilder, SharedNameAndDescription, SharedSlashCommandOptions, Assertions$1 as SlashCommandAssertions, SlashCommandAttachmentOption, SlashCommandBooleanOption, SlashCommandBuilder, SlashCommandChannelOption, SlashCommandIntegerOption, SlashCommandMentionableOption, SlashCommandNumberOption, SlashCommandOptionsOnlyBuilder, SlashCommandRoleOption, SlashCommandStringOption, SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuilder, SlashCommandSubcommandsOnlyBuilder, SlashCommandUserOption, StringSelectMenuBuilder, StringSelectMenuOptionBuilder, Assertions$3 as TextInputAssertions, TextInputBuilder, TimestampStyles, TimestampStylesString, ToAPIApplicationCommandOptions, UserSelectMenuBuilder, blockQuote, bold, channelLink, channelMention, chatInputApplicationCommandMention, codeBlock, createComponentBuilder, disableValidators, embedLength, enableValidators, formatEmoji, hideLinkEmbed, hyperlink, inlineCode, isValidationEnabled, italic, messageLink, normalizeArray, quote, roleMention, spoiler, strikethrough, time, underscore, userMention, version };