@discordjs/builders 0.13.0-dev.1649505810-3c0bbac → 0.13.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as _sapphire_shapeshift from '@sapphire/shapeshift';
-import { APIEmbedField, APIEmbedAuthor, APIEmbedFooter, APIEmbedImage, APIEmbed, APISelectMenuOption, APIMessageComponentEmoji, ButtonStyle, APIBaseComponent, ComponentType, APIModalComponent, APIMessageComponent, APIActionRowComponent, APIModalActionRowComponent, APIMessageActionRowComponent, APIActionRowComponentTypes, APIButtonComponent, APITextInputComponent, TextInputStyle, APIModalInteractionResponseCallbackData, APISelectMenuComponent, ApplicationCommandOptionType, APIApplicationCommandBasicOption, APIApplicationCommandBooleanOption, ChannelType, APIApplicationCommandChannelOption, APIApplicationCommandOptionChoice, APIApplicationCommandIntegerOption, APIApplicationCommandMentionableOption, APIApplicationCommandNumberOption, APIApplicationCommandRoleOption, APIApplicationCommandAttachmentOption, APIApplicationCommandStringOption, APIApplicationCommandUserOption, APIApplicationCommandSubcommandGroupOption, APIApplicationCommandSubcommandOption, RESTPostAPIApplicationCommandsJSONBody, APIApplicationCommandOption, ApplicationCommandType } from 'discord-api-types/v10';
-import { Snowflake } from 'discord-api-types/globals';
+import { APIEmbedField, APIEmbedAuthor, APIEmbedFooter, APIEmbedImage, APIEmbed, APISelectMenuOption, APIMessageComponentEmoji, ButtonStyle, APIActionRowComponentTypes, APIActionRowComponent, APIBaseComponent, ComponentType, APIMessageActionRowComponent, APIModalActionRowComponent, APIButtonComponent, APIMessageComponent, APIModalComponent, APITextInputComponent, TextInputStyle, APIModalInteractionResponseCallbackData, APISelectMenuComponent, LocalizationMap, LocaleString, ApplicationCommandOptionType, APIApplicationCommandBasicOption, APIApplicationCommandAttachmentOption, APIApplicationCommandBooleanOption, ChannelType, APIApplicationCommandChannelOption, APIApplicationCommandOptionChoice, APIApplicationCommandIntegerOption, APIApplicationCommandMentionableOption, APIApplicationCommandNumberOption, APIApplicationCommandRoleOption, APIApplicationCommandStringOption, APIApplicationCommandUserOption, APIApplicationCommandSubcommandGroupOption, APIApplicationCommandSubcommandOption, RESTPostAPIApplicationCommandsJSONBody, APIApplicationCommandOption, Locale, ApplicationCommandType } from 'discord-api-types/v10';
 import { URL } from 'url';
+import { Snowflake } from 'discord-api-types/globals';
 
 declare const fieldNamePredicate: _sapphire_shapeshift.StringValidator<string>;
 declare const fieldValuePredicate: _sapphire_shapeshift.StringValidator<string>;
@@ -297,12 +297,6 @@ declare function spoiler<C extends string>(content: C): `||${C}||`;
  * @param userId The user ID to format
  */
 declare function userMention<C extends Snowflake>(userId: C): `<@${C}>`;
-/**
- * Formats a user ID into a member-nickname mention
- *
- * @param memberId The user ID to format
- */
-declare function memberNicknameMention<C extends Snowflake>(memberId: C): `<@!${C}>`;
 /**
  * Formats a channel ID into a channel mention
  *
@@ -545,35 +539,33 @@ interface JSONEncodable<T> {
  */
 declare function isJSONEncodable(maybeEncodable: unknown): maybeEncodable is JSONEncodable<unknown>;
 
+declare type AnyAPIActionRowComponent = APIActionRowComponentTypes | APIActionRowComponent<APIActionRowComponentTypes>;
 /**
  * Represents a discord component
  */
-declare abstract class ComponentBuilder<DataType extends Partial<APIBaseComponent<ComponentType>> & {
-    type: ComponentType;
-} = APIBaseComponent<ComponentType>> implements JSONEncodable<APIModalComponent | APIMessageComponent | APIActionRowComponent<APIModalActionRowComponent | APIMessageActionRowComponent>> {
+declare abstract class ComponentBuilder<DataType extends Partial<APIBaseComponent<ComponentType>> = APIBaseComponent<ComponentType>> implements JSONEncodable<AnyAPIActionRowComponent> {
     /**
      * The API data associated with this component
      */
-    readonly data: DataType;
-    abstract toJSON(): APIActionRowComponentTypes | APIActionRowComponent<APIModalActionRowComponent | APIMessageActionRowComponent>;
-    constructor(data: DataType);
+    readonly data: Partial<DataType>;
+    abstract toJSON(): AnyAPIActionRowComponent;
+    constructor(data: Partial<DataType>);
 }
 
 declare type MessageComponentBuilder = MessageActionRowComponentBuilder | ActionRowBuilder<MessageActionRowComponentBuilder>;
 declare type ModalComponentBuilder = ModalActionRowComponentBuilder | ActionRowBuilder<ModalActionRowComponentBuilder>;
 declare type MessageActionRowComponentBuilder = ButtonBuilder | SelectMenuBuilder;
 declare type ModalActionRowComponentBuilder = TextInputBuilder;
+declare type AnyComponentBuilder = MessageActionRowComponentBuilder | ModalActionRowComponentBuilder;
 /**
  * Represents an action row component
  */
-declare class ActionRowBuilder<T extends MessageActionRowComponentBuilder | ModalActionRowComponentBuilder = MessageActionRowComponentBuilder | ModalActionRowComponentBuilder> extends ComponentBuilder<Omit<Partial<APIActionRowComponent<APIMessageActionRowComponent | APIModalActionRowComponent>> & {
-    type: ComponentType.ActionRow;
-}, 'components'>> {
+declare class ActionRowBuilder<T extends AnyComponentBuilder> extends ComponentBuilder<APIActionRowComponent<APIMessageActionRowComponent | APIModalActionRowComponent>> {
     /**
      * The components within this action row
      */
     readonly components: T[];
-    constructor({ components, ...data }?: Partial<APIActionRowComponent<APIMessageActionRowComponent | APIModalActionRowComponent>>);
+    constructor({ components, ...data }?: Partial<APIActionRowComponent<APIActionRowComponentTypes>>);
     /**
      * Adds components to this action row.
      * @param components The components to add to this action row.
@@ -591,9 +583,7 @@ declare class ActionRowBuilder<T extends MessageActionRowComponentBuilder | Moda
 /**
  * Represents a non-validated button component
  */
-declare class UnsafeButtonBuilder extends ComponentBuilder<Partial<APIButtonComponent> & {
-    type: ComponentType.Button;
-}> {
+declare class UnsafeButtonBuilder extends ComponentBuilder<APIButtonComponent> {
     constructor(data?: Partial<APIButtonComponent>);
     /**
      * Sets the style of this button
@@ -642,7 +632,7 @@ declare class ButtonBuilder extends UnsafeButtonBuilder {
 }
 
 interface MappedComponentTypes {
-    [ComponentType.ActionRow]: ActionRowBuilder;
+    [ComponentType.ActionRow]: ActionRowBuilder<AnyComponentBuilder>;
     [ComponentType.Button]: ButtonBuilder;
     [ComponentType.SelectMenu]: SelectMenuBuilder;
     [ComponentType.TextInput]: TextInputBuilder;
@@ -656,9 +646,7 @@ declare function createComponentBuilder<T extends keyof MappedComponentTypes>(da
 }): MappedComponentTypes[T];
 declare function createComponentBuilder<C extends MessageComponentBuilder | ModalComponentBuilder>(data: C): C;
 
-declare class UnsafeTextInputBuilder extends ComponentBuilder<Partial<APITextInputComponent> & {
-    type: ComponentType.TextInput;
-}> {
+declare class UnsafeTextInputBuilder extends ComponentBuilder<APITextInputComponent> {
     constructor(data?: APITextInputComponent & {
         type?: ComponentType.TextInput;
     });
@@ -745,7 +733,7 @@ declare namespace Assertions$3 {
 }
 
 declare class UnsafeModalBuilder implements JSONEncodable<APIModalInteractionResponseCallbackData> {
-    readonly data: Partial<Omit<APIModalInteractionResponseCallbackData, 'components'>>;
+    readonly data: Partial<APIModalInteractionResponseCallbackData>;
     readonly components: ActionRowBuilder<ModalActionRowComponentBuilder>[];
     constructor({ components, ...data }?: Partial<APIModalInteractionResponseCallbackData>);
     /**
@@ -778,7 +766,7 @@ declare class ModalBuilder extends UnsafeModalBuilder {
 }
 
 declare const titleValidator: _sapphire_shapeshift.StringValidator<string>;
-declare const componentsValidator: _sapphire_shapeshift.BaseValidator<[ActionRowBuilder<MessageActionRowComponentBuilder | TextInputBuilder>, ...ActionRowBuilder<MessageActionRowComponentBuilder | TextInputBuilder>[]]>;
+declare const componentsValidator: _sapphire_shapeshift.BaseValidator<[ActionRowBuilder<AnyComponentBuilder>, ...ActionRowBuilder<AnyComponentBuilder>[]]>;
 declare function validateRequiredParameters$2(customId?: string, title?: string, components?: ActionRowBuilder<ModalActionRowComponentBuilder>[]): void;
 
 declare const Assertions$2_titleValidator: typeof titleValidator;
@@ -794,9 +782,7 @@ declare namespace Assertions$2 {
 /**
  * Represents a non-validated select menu component
  */
-declare class UnsafeSelectMenuBuilder extends ComponentBuilder<Partial<Omit<APISelectMenuComponent, 'options'>> & {
-    type: ComponentType.SelectMenu;
-}> {
+declare class UnsafeSelectMenuBuilder extends ComponentBuilder<APISelectMenuComponent> {
     /**
      * The options within this select menu
      */
@@ -857,7 +843,9 @@ declare class SelectMenuBuilder extends UnsafeSelectMenuBuilder {
 
 declare class SharedNameAndDescription {
     readonly name: string;
+    readonly name_localizations?: LocalizationMap;
     readonly description: string;
+    readonly description_localizations?: LocalizationMap;
     /**
      * Sets the name
      *
@@ -870,6 +858,32 @@ declare class SharedNameAndDescription {
      * @param description The description
      */
     setDescription(description: string): this;
+    /**
+     * Sets a name localization
+     *
+     * @param locale The locale to set a description for
+     * @param localizedName The localized description for the given locale
+     */
+    setNameLocalization(locale: LocaleString, localizedName: string | null): this;
+    /**
+     * Sets the name localizations
+     *
+     * @param localizedNames The dictionary of localized descriptions to set
+     */
+    setNameLocalizations(localizedNames: LocalizationMap | null): this;
+    /**
+     * Sets a description localization
+     *
+     * @param locale The locale to set a description for
+     * @param localizedDescription The localized description for the given locale
+     */
+    setDescriptionLocalization(locale: LocaleString, localizedDescription: string | null): this;
+    /**
+     * Sets the description localizations
+     *
+     * @param localizedDescriptions The dictionary of localized descriptions to set
+     */
+    setDescriptionLocalizations(localizedDescriptions: LocalizationMap | null): this;
 }
 
 declare abstract class ApplicationCommandOptionBase extends SharedNameAndDescription {
@@ -885,6 +899,11 @@ declare abstract class ApplicationCommandOptionBase extends SharedNameAndDescrip
     protected runRequiredValidations(): void;
 }
 
+declare class SlashCommandAttachmentOption extends ApplicationCommandOptionBase {
+    readonly type: ApplicationCommandOptionType.Attachment;
+    toJSON(): APIApplicationCommandAttachmentOption;
+}
+
 declare class SlashCommandBooleanOption extends ApplicationCommandOptionBase {
     readonly type: ApplicationCommandOptionType.Boolean;
     toJSON(): APIApplicationCommandBooleanOption;
@@ -970,11 +989,6 @@ declare class SlashCommandRoleOption extends ApplicationCommandOptionBase {
     toJSON(): APIApplicationCommandRoleOption;
 }
 
-declare class SlashCommandAttachmentOption extends ApplicationCommandOptionBase {
-    readonly type: ApplicationCommandOptionType.Attachment;
-    toJSON(): APIApplicationCommandAttachmentOption;
-}
-
 declare class SlashCommandStringOption extends ApplicationCommandOptionBase {
     readonly type: ApplicationCommandOptionType.String;
     toJSON(): APIApplicationCommandStringOption;
@@ -1102,10 +1116,18 @@ declare class SlashCommandBuilder {
      * The name of this slash command
      */
     readonly name: string;
+    /**
+     * The localized names for this command
+     */
+    readonly name_localizations?: LocalizationMap;
     /**
      * The description of this slash command
      */
     readonly description: string;
+    /**
+     * The localized descriptions for this command
+     */
+    readonly description_localizations?: LocalizationMap;
     /**
      * The options of this slash command
      */
@@ -1157,6 +1179,7 @@ interface ToAPIApplicationCommandOptions {
 
 declare function validateName$1(name: unknown): asserts name is string;
 declare function validateDescription(description: unknown): asserts description is string;
+declare function validateLocale(locale: unknown): Locale;
 declare function validateMaxOptionsLength(options: unknown): asserts options is ToAPIApplicationCommandOptions[];
 declare function validateRequiredParameters$1(name: string, description: string, options: ToAPIApplicationCommandOptions[]): void;
 declare function validateDefaultPermission$1(value: unknown): asserts value is boolean;
@@ -1165,6 +1188,7 @@ declare function validateChoicesLength(amountAdding: number, choices?: APIApplic
 declare function assertReturnOfBuilder<T extends ApplicationCommandOptionBase | SlashCommandSubcommandBuilder | SlashCommandSubcommandGroupBuilder>(input: unknown, ExpectedInstanceOf: new () => T): asserts input is T;
 
 declare const Assertions$1_validateDescription: typeof validateDescription;
+declare const Assertions$1_validateLocale: typeof validateLocale;
 declare const Assertions$1_validateMaxOptionsLength: typeof validateMaxOptionsLength;
 declare const Assertions$1_validateRequired: typeof validateRequired;
 declare const Assertions$1_validateChoicesLength: typeof validateChoicesLength;
@@ -1173,6 +1197,7 @@ declare namespace Assertions$1 {
   export {
     validateName$1 as validateName,
     Assertions$1_validateDescription as validateDescription,
+    Assertions$1_validateLocale as validateLocale,
     Assertions$1_validateMaxOptionsLength as validateMaxOptionsLength,
     validateRequiredParameters$1 as validateRequiredParameters,
     validateDefaultPermission$1 as validateDefaultPermission,
@@ -1260,4 +1285,4 @@ declare function isEquatable(maybeEquatable: unknown): maybeEquatable is Equatab
 
 declare function embedLength(data: APIEmbed): number;
 
-export { ActionRowBuilder, ButtonBuilder, Assertions$4 as ComponentAssertions, ComponentBuilder, Assertions as ContextMenuCommandAssertions, ContextMenuCommandBuilder, ContextMenuCommandType, Assertions$5 as EmbedAssertions, EmbedAuthorData, EmbedAuthorOptions, EmbedBuilder, EmbedFooterData, EmbedFooterOptions, EmbedImageData, Equatable, Faces, IconData, JSONEncodable, MappedComponentTypes, MessageActionRowComponentBuilder, MessageComponentBuilder, ModalActionRowComponentBuilder, Assertions$2 as ModalAssertions, ModalBuilder, ModalComponentBuilder, RGBTuple, SelectMenuBuilder, SelectMenuOptionBuilder, 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, UnsafeButtonBuilder, UnsafeEmbedBuilder, UnsafeModalBuilder, UnsafeSelectMenuBuilder, UnsafeSelectMenuOptionBuilder, UnsafeTextInputBuilder, blockQuote, bold, channelMention, codeBlock, createComponentBuilder, embedLength, formatEmoji, hideLinkEmbed, hyperlink, inlineCode, isEquatable, isJSONEncodable, italic, memberNicknameMention, quote, roleMention, spoiler, strikethrough, time, underscore, userMention };
+export { ActionRowBuilder, AnyAPIActionRowComponent, AnyComponentBuilder, ButtonBuilder, Assertions$4 as ComponentAssertions, ComponentBuilder, Assertions as ContextMenuCommandAssertions, ContextMenuCommandBuilder, ContextMenuCommandType, Assertions$5 as EmbedAssertions, EmbedAuthorData, EmbedAuthorOptions, EmbedBuilder, EmbedFooterData, EmbedFooterOptions, EmbedImageData, Equatable, Faces, IconData, JSONEncodable, MappedComponentTypes, MessageActionRowComponentBuilder, MessageComponentBuilder, ModalActionRowComponentBuilder, Assertions$2 as ModalAssertions, ModalBuilder, ModalComponentBuilder, RGBTuple, SelectMenuBuilder, SelectMenuOptionBuilder, 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, UnsafeButtonBuilder, UnsafeEmbedBuilder, UnsafeModalBuilder, UnsafeSelectMenuBuilder, UnsafeSelectMenuOptionBuilder, UnsafeTextInputBuilder, blockQuote, bold, channelMention, codeBlock, createComponentBuilder, embedLength, formatEmoji, hideLinkEmbed, hyperlink, inlineCode, isEquatable, isJSONEncodable, italic, quote, roleMention, spoiler, strikethrough, time, underscore, userMention };