slash-create-modify/lib/constants.d.ts

Create and sync Discord slash commands!

/// <reference types="node" />
import { IncomingMessage } from 'http';
import { MessageData } from './structures/message';
export declare const VERSION: string;
export declare const API_VERSION = 10;
export declare const INTERACTION_VERSION = 1;
export declare const API_BASE_URL: string;
export declare const CDN_URL = "https://cdn.discordapp.com";
/** The types of interactions. */
export declare enum InteractionType {
    /** A ping. */
    PING = 1,
    /** @deprecated */
    COMMAND = 2,
    /** A command invocation. */
    APPLICATION_COMMAND = 2,
    /** An invocation of a message component. */
    MESSAGE_COMPONENT = 3,
    /** An autocomplete invocation of a command. */
    APPLICATION_COMMAND_AUTOCOMPLETE = 4,
    /** A modal submission. */
    MODAL_SUBMIT = 5
}
/** The types of interaction responses. */
export declare enum InteractionResponseType {
    /** Acknowledge a `PING`. */
    PONG = 1,
    /** Respond with a message, showing the user's input. */
    CHANNEL_MESSAGE_WITH_SOURCE = 4,
    /** Create a deferred message with source. */
    DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE = 5,
    /** Acknowledge the interaction, edit the original message later. */
    DEFERRED_UPDATE_MESSAGE = 6,
    /** Edits the message the component was attached to. */
    UPDATE_MESSAGE = 7,
    /** Responds to an autocomplete interaction request. */
    APPLICATION_COMMAND_AUTOCOMPLETE_RESULT = 8,
    /** Respond to an interaction with a popup modal. */
    MODAL = 9
}
/** Message flags for interaction responses. */
export declare enum InteractionResponseFlags {
    /** Sends a message back to the invoker, similar to messages by Clyde. */
    EPHEMERAL = 64
}
/**
 * An object mapping the types a command option can use.
 */
export declare enum CommandOptionType {
    /** A sub-command for the application's command */
    SUB_COMMAND = 1,
    /** A group of sub-commands */
    SUB_COMMAND_GROUP = 2,
    /** A string. */
    STRING = 3,
    /** An integer. */
    INTEGER = 4,
    /** A boolean. */
    BOOLEAN = 5,
    /** A user, this would return the user's ID in the interaction. */
    USER = 6,
    /** A channel, this would return the channel's ID in the interaction. */
    CHANNEL = 7,
    /** A role, this would return the role's ID in the interaction. */
    ROLE = 8,
    /** Anything mentionable, returning the ID of the object. */
    MENTIONABLE = 9,
    /** A decimal. */
    NUMBER = 10,
    /** An attachment. */
    ATTACHMENT = 11
}
/** The types of application commands available. */
export declare enum ApplicationCommandType {
    /** Slash commands; a text-based command that shows up when a user types `/` */
    CHAT_INPUT = 1,
    /** A UI-based command that shows up when you right click or tap on a user */
    USER = 2,
    /** A UI-based command that shows up when you right click or tap on a messages */
    MESSAGE = 3
}
/** The types of channels in Discord channels. */
export declare enum ChannelType {
    /** A text channel. */
    GUILD_TEXT = 0,
    /** A direct message between users. */
    DM = 1,
    /** A voice channel. */
    GUILD_VOICE = 2,
    /** A direct message between multiple users. */
    GROUP_DM = 3,
    /** A channel category containing up to 50 channels. */
    GUILD_CATEGORY = 4,
    /** A channel that users can follow and crosspost into their own server. */
    GUILD_NEWS = 5,
    /** A channel in which game developers can sell their game. */
    GUILD_STORE = 6,
    /** A temporary sub-channel within a `GUILD_NEWS` channel. */
    GUILD_NEWS_THREAD = 10,
    /** A temporary sub-channel within a `GUILD_TEXT` channel. */
    GUILD_PUBLIC_THREAD = 11,
    /** A temporary sub-channel within a `GUILD_TEXT` channel. */
    GUILD_PRIVATE_THREAD = 12,
    /** A voice channel for hosting events with an audience. */
    GUILD_STAGE_VOICE = 13
}
/**
 * An partial application command in Discord.
 * @private
 */
export interface PartialApplicationCommand {
    /** The name of the command. */
    name: string;
    /** The localiztions for the command name. */
    name_localizations?: Record<string, string> | null;
    /** The description of the command. */
    description?: string;
    /** The localiztions for the command description. */
    description_localizations?: Record<string, string> | null;
    /** The options for the command. */
    options?: ApplicationCommandOption[];
    /** Whether to enable this command for everyone by default. */
    default_permission?: boolean;
    /** Whether to enable this command in direct messages. */
    dm_permission?: boolean | null;
    /** The member permissions required to use this command. */
    default_member_permissions?: string | null;
    /** The type of application this is representing. `1` by default. */
    type?: ApplicationCommandType;
}
/** @hidden */
export interface BulkUpdateCommand extends PartialApplicationCommand {
    /** The command's ID. */
    id?: string;
}
/**
 * An application command in Discord.
 * @private
 */
export interface ApplicationCommand extends PartialApplicationCommand {
    /** The command's ID. */
    id: string;
    /** The application's ID responsible for this command. */
    application_id: string;
    /** The guild ID this comamnd is exlusive to. */
    guild_id?: string;
    /** The version ID of the command. */
    version: string;
}
export interface ApplicationCommandOptionBase {
    /** The type of option this one is. */
    type: CommandOptionType.BOOLEAN | CommandOptionType.USER | CommandOptionType.ROLE | CommandOptionType.MENTIONABLE | CommandOptionType.ATTACHMENT;
    /** The name of the option. */
    name: string;
    /** The localiztions for the option name. */
    name_localizations?: Record<string, string>;
    /** The description of the option. */
    description: string;
    /** The localiztions for the option description. */
    description_localizations?: Record<string, string>;
    /** Whether the parameter is required. */
    required?: boolean;
}
/**
 * @private
 */
export interface ApplicationCommandOptionSubCommand extends Omit<ApplicationCommandOptionBase, 'type'> {
    /** The type of option this one is. */
    type: CommandOptionType.SUB_COMMAND | CommandOptionType.SUB_COMMAND_GROUP;
    /** The sub-options for the option. This can only be used for sub-commands and sub-command groups. */
    options?: ApplicationCommandOption[];
}
/**
 * @private
 */
export interface ApplicationCommandOptionArgument extends Omit<ApplicationCommandOptionBase, 'type'> {
    /** The type of option this one is. */
    type: CommandOptionType.STRING | CommandOptionType.INTEGER | CommandOptionType.NUMBER;
    /** The choices of the option. If set, these are the only values a user can pick from. */
    choices?: ApplicationCommandOptionChoice[];
}
/**
 * @private
 */
export interface ApplicationCommandOptionAutocompletable extends Omit<ApplicationCommandOptionBase, 'type'> {
    /** The type of option this one is. */
    type: CommandOptionType.STRING | CommandOptionType.INTEGER | CommandOptionType.NUMBER;
    /** Whether this option can be autocompleted. */
    autocomplete?: boolean;
}
/**
 * @private
 */
export interface ApplicationCommandOptionChannel extends Omit<ApplicationCommandOptionBase, 'type'> {
    /** The type of option this one is. */
    type: CommandOptionType.CHANNEL;
    /** An array of channel types this option can be. */
    channel_types?: ChannelType[];
}
/**
 * @private
 */
export interface ApplicationCommandOptionLimitedNumber extends Omit<ApplicationCommandOptionBase, 'type'> {
    /** The type of option this one is. */
    type: CommandOptionType.INTEGER | CommandOptionType.NUMBER;
    /** Whether this option can be autocompleted. */
    autocomplete?: boolean;
    /** The minimum value permitted. */
    min_value?: number;
    /** The maximum value permitted. */
    max_value?: number;
}
/** An option in an application command. */
export declare type ApplicationCommandOption = ApplicationCommandOptionBase | ApplicationCommandOptionSubCommand | ApplicationCommandOptionArgument | ApplicationCommandOptionAutocompletable | ApplicationCommandOptionChannel | ApplicationCommandOptionLimitedNumber;
/** A choice for a user to pick from. */
export interface ApplicationCommandOptionChoice {
    /** The name of the choice. */
    name: string;
    /** The value of the choice. */
    value: string | number;
    /** The localiztions for the option name. */
    name_localizations?: Record<string, string>;
}
/** The type of thing to apply the permission to. */
export declare enum ApplicationCommandPermissionType {
    /** A Discord role. */
    ROLE = 1,
    /** A Discord user. */
    USER = 2,
    /** A Discord channel. */
    CHANNEL = 3
}
/** A permission in a command. */
export interface ApplicationCommandPermissions {
    id: string;
    type: ApplicationCommandPermissionType;
    permission: boolean;
}
/** @private */
export interface PartialApplicationCommandPermissions {
    id: string;
    permissions: ApplicationCommandPermissions[];
}
/** @private */
export interface GuildApplicationCommandPermissions extends PartialApplicationCommandPermissions {
    application_id: string;
    guild_id: string;
}
/** @private */
export interface RawRequest {
    method: string;
    url: string;
    auth: boolean;
    body: any;
    route: string;
    reason?: string;
    short: boolean;
    resp: IncomingMessage;
}
/** Any interaction request from Discord. */
export declare type AnyRequestData = PingRequestData | InteractionRequestData | MessageComponentRequestData | CommandAutocompleteRequestData | ModalSubmitRequestData;
/** @private */
export interface RequestData {
    version: 1;
    application_id: string;
    type: InteractionType;
    token: string;
    id: string;
    app_permissions?: string;
}
/**
 * A ping interaction.
 * @private
 */
export interface PingRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.PING;
    user?: CommandUser;
    token: string;
    id: string;
    app_permissions?: string;
}
/**
 * A modal submission within a direct message.
 * @private
 */
export interface DMModalSubmitRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.MODAL_SUBMIT;
    token: string;
    id: string;
    channel_id: string;
    locale?: string;
    user: CommandUser;
    message?: MessageData;
    app_permissions?: string;
    data: {
        custom_id: string;
        components: ComponentActionRow[];
    };
}
/**
 * A modal submission within a guild.
 * @private
 */
export interface GuildModalSubmitRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.MODAL_SUBMIT;
    token: string;
    id: string;
    channel_id: string;
    guild_id: string;
    locale?: string;
    guild_locale?: string;
    member: CommandMember;
    message?: MessageData;
    app_permissions?: string;
    data: {
        custom_id: string;
        components: ComponentActionRow[];
    };
}
/**
 * Any modal submission.
 * @private
 */
export declare type ModalSubmitRequestData = DMModalSubmitRequestData | GuildModalSubmitRequestData;
/**
 * A command interaction within a direct message.
 * @private
 */
export interface DMInteractionRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.APPLICATION_COMMAND;
    token: string;
    id: string;
    channel_id: string;
    locale?: string;
    user: CommandUser;
    app_permissions?: string;
    data: CommandData;
}
/**
 * A command interaction within a guild.
 * @private
 */
export interface GuildInteractionRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.APPLICATION_COMMAND;
    token: string;
    id: string;
    channel_id: string;
    guild_id: string;
    locale?: string;
    guild_locale?: string;
    member: CommandMember;
    app_permissions?: string;
    data: CommandData;
}
/**
 * Any command interaction.
 * @private
 */
export declare type InteractionRequestData = DMInteractionRequestData | GuildInteractionRequestData;
/** The partial message from a message component interaction. */
export interface PartialMessage {
    /** The ID of the message. */
    id: string;
    /** The message flags. */
    flags: number;
}
/** The partial emoji from a message component. */
export interface PartialEmoji {
    /** The ID of the emoji, if it is custom. */
    id?: string;
    /** The name of the emoji, or the raw emoji if not custom. */
    name?: string;
    /** Whether this emoji is animated. */
    animated?: boolean;
}
/**
 * A message component interaction within a direct message.
 * @private
 */
export interface DMMessageComponentRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.MESSAGE_COMPONENT;
    token: string;
    message: MessageData;
    id: string;
    channel_id: string;
    locale?: string;
    guild_locale?: string;
    user: CommandUser;
    app_permissions?: string;
    data: {
        custom_id: string;
        component_type: ComponentType;
        values?: string[];
    };
}
/**
 * A message component interaction within a guild.
 * @private
 */
export interface GuildMessageComponentRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.MESSAGE_COMPONENT;
    token: string;
    message: MessageData;
    id: string;
    channel_id: string;
    guild_id: string;
    member: CommandMember;
    app_permissions?: string;
    data: {
        custom_id: string;
        component_type: ComponentType;
        values?: string[];
    };
}
/**
 * Any message component interaction.
 * @private
 */
export declare type MessageComponentRequestData = DMMessageComponentRequestData | GuildMessageComponentRequestData;
/**
 * A message component interaction within a direct message.
 * @private
 */
export interface DMCommandAutocompleteRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.APPLICATION_COMMAND_AUTOCOMPLETE;
    token: string;
    id: string;
    channel_id: string;
    user: CommandUser;
    app_permissions?: string;
    data: AutocompleteData;
}
/**
 * A message component interaction within a guild.
 * @private
 */
export interface GuildCommandAutocompleteRequestData {
    version: 1;
    application_id: string;
    type: InteractionType.APPLICATION_COMMAND_AUTOCOMPLETE;
    token: string;
    id: string;
    channel_id: string;
    guild_id: string;
    member: CommandMember;
    app_permissions?: string;
    data: AutocompleteData;
}
/** @private */
export interface AutocompleteData {
    id: string;
    name: string;
    type: ApplicationCommandType;
    version: string;
    options: AnyCommandOption[];
}
/**
 * Any message component interaction.
 * @private
 */
export declare type CommandAutocompleteRequestData = DMCommandAutocompleteRequestData | GuildCommandAutocompleteRequestData;
/** @private */
export interface ResolvedMemberData {
    avatar?: string;
    roles: string[];
    premium_since: string | null;
    communication_disabled_until: string | null;
    pending: boolean;
    nick: string | null;
    joined_at: string;
}
/** @private */
export interface CommandMember extends ResolvedMemberData {
    user: CommandUser;
    mute: boolean;
    deaf: boolean;
    permissions: string;
}
/** @private */
export interface CommandUser {
    id: string;
    username: string;
    avatar: string | null;
    avatar_decoration: string | null;
    discriminator: string;
    public_flags: number;
}
/** @private */
export interface ResolvedRole {
    color: number;
    hoist: boolean;
    id: string;
    icon?: string;
    managed: boolean;
    mentionable: boolean;
    name: string;
    permissions: string;
    position: number;
    unicode_emoji?: string;
}
/** @private */
export interface ResolvedChannel {
    id: string;
    name: string;
    permissions: string;
    type: number;
}
/** @hidden */
export interface UserObject extends CommandUser {
    /** Whether this user is a bot. */
    bot?: boolean;
}
/** @private */
export interface CommandData {
    id: string;
    name: string;
    options?: AnyCommandOption[];
    resolved?: {
        users?: {
            [id: string]: CommandUser;
        };
        members?: {
            [id: string]: ResolvedMemberData;
        };
        roles?: {
            [id: string]: ResolvedRole;
        };
        channels?: {
            [id: string]: ResolvedChannel;
        };
        messages?: {
            [id: string]: MessageData;
        };
        attachments?: {
            [id: string]: AttachmentData;
        };
    };
    type: ApplicationCommandType;
    target_id?: string;
}
/** @private */
export declare type AnyCommandOption = CommandStringOption | CommandIntegerOption | CommandBooleanOption | CommandSubcommandOption;
/** @private */
export interface CommandStringOption {
    /** The name for the option. */
    name: string;
    type?: CommandOptionType.STRING | CommandOptionType.USER | CommandOptionType.CHANNEL | CommandOptionType.ROLE;
    value: string;
    focused?: boolean;
    min_length?: number;
    max_length?: number;
}
/** @private */
export interface CommandIntegerOption {
    /** The name for the option. */
    name: string;
    type?: CommandOptionType.INTEGER;
    value: number;
    focused?: boolean;
    min_value?: number;
    max_value?: number;
}
/** @private */
export interface CommandBooleanOption {
    /** The name for the option. */
    name: string;
    type?: CommandOptionType.BOOLEAN;
    value: boolean;
}
/** @private */
export interface CommandSubcommandOption {
    /** The name for the option. */
    name: string;
    type?: CommandOptionType.SUB_COMMAND | CommandOptionType.SUB_COMMAND_GROUP;
    options?: AnyCommandOption[];
}
/** The types of components available. */
export declare enum ComponentType {
    /** A row of components. */
    ACTION_ROW = 1,
    /** A button component. */
    BUTTON = 2,
    /** A select component. */
    SELECT = 3,
    /** A text input. */
    TEXT_INPUT = 4
}
/** The types of component button styles. */
export declare enum ButtonStyle {
    /** A primary-colored button. */
    PRIMARY = 1,
    /** A gray, secondary button. */
    SECONDARY = 2,
    /** A green button. */
    SUCCESS = 3,
    /** A red button. */
    DESTRUCTIVE = 4,
    /** A gray button with a link icon. */
    LINK = 5
}
export declare enum TextInputStyle {
    /** A single-line input */
    SHORT = 1,
    /** A multi-line input */
    PARAGRAPH = 2
}
/** Any component. */
export declare type AnyComponent = ComponentActionRow | AnyComponentButton | ComponentSelectMenu | ComponentTextInput;
/** A row of components. */
export interface ComponentActionRow {
    /** The type of component to use. */
    type: ComponentType.ACTION_ROW;
    /** The components to show inside this row. */
    components: (AnyComponentButton | ComponentSelectMenu | ComponentTextInput)[];
}
/** Any component button. */
export declare type AnyComponentButton = ComponentButton | ComponentButtonLink;
/** A regular component button. */
export interface ComponentButton {
    /** The type of component to use. */
    type: ComponentType.BUTTON;
    /** The style of button to show. */
    style: ButtonStyle.PRIMARY | ButtonStyle.SECONDARY | ButtonStyle.SUCCESS | ButtonStyle.DESTRUCTIVE;
    /** The identifier for this button. */
    custom_id: string;
    /** The label of the button. */
    label: string;
    /** The emoji to show inside the button. */
    emoji?: PartialEmoji;
    /** Whether this button will show as disabled. */
    disabled?: boolean;
}
/** A component button with a link. */
export interface ComponentButtonLink extends Omit<ComponentButton, 'custom_id' | 'style'> {
    /** The style of button to show. */
    style: ButtonStyle.LINK;
    /** The URL for link buttons. */
    url: string;
}
export interface ComponentSelectMenu {
    /** The type of component to use. */
    type: ComponentType.SELECT;
    /** The identifier of the of the menu. */
    custom_id: string;
    /** The options to show inside this menu. */
    options: ComponentSelectOption[];
    /** The string to show in absence of a selected option. */
    placeholder?: string;
    /** The minimum number of items to be chosen. */
    min_values?: number;
    /** The maximum number of items to be chosen. */
    max_values?: number;
    /** Whether this menu will show as disabled. */
    disabled?: boolean;
}
export interface ComponentSelectOption {
    /** The description of this option. */
    description?: string;
    /** The emoji to show with the option. */
    emoji?: PartialEmoji;
    /** The label of this option. */
    label: string;
    /** The value of this option. */
    value: string;
    /** Should this render by default */
    default?: boolean;
}
export interface ComponentTextInput {
    /** The type of component to use. */
    type: ComponentType.TEXT_INPUT;
    /** The identifier of the of the input. */
    custom_id: string;
    /** The label of the input. */
    label: string;
    /** The style of the input. */
    style: TextInputStyle;
    /** The minimum length of the input. */
    min_length?: number;
    /** The maximum length of the input. */
    max_length?: number;
    /** Whether this component is required to be filled. */
    required?: boolean;
    /** A pre-filled value for this input. */
    value?: string;
    /** Custom placeholder text if the input is empty. */
    placeholder?: string;
}
/** An attachment from an interaction. */
export interface AttachmentData {
    /** The ID of the attachment. */
    id: string;
    /** The filename of the attachment. */
    filename: string;
    /** The description of the attachment. */
    description?: string;
    /** The content type of the attachment. */
    content_type?: string;
    /** The size of the attachment in bytes. */
    size: number;
    /** The URL of the attachment. */
    url: string;
    /** The proxy URL of the attachment. */
    proxy_url: string;
    /** The height of the attachment. */
    height?: number;
    /** The width of the attachment. */
    width?: number;
    /** Whether the attachment is ephemeral */
    ephermal?: boolean;
}
/** Any image format supported by Discord. */
export declare type ImageFormat = 'jpg' | 'jpeg' | 'png' | 'webp' | 'gif';
export declare const ImageFormats: string[];
export declare const ImageSizeBoundaries: {
    MINIMUM: number;
    MAXIMUM: number;
};
export declare const PermissionNames: {
    [perm: string]: string;
};
export declare const Endpoints: {
    COMMANDS: (applicationID: string) => string;
    GUILD_COMMANDS: (applicationID: string, guildID: string) => string;
    COMMAND: (applicationID: string, commandID: string) => string;
    GUILD_COMMAND: (applicationID: string, guildID: string, commandID: string) => string;
    GUILD_COMMAND_PERMISSIONS: (applicationID: string, guildID: string) => string;
    COMMAND_PERMISSIONS: (applicationID: string, guildID: string, commandID: string) => string;
    INTERACTION_CALLBACK: (interactionID: string, interactionToken: string) => string;
    MESSAGE: (applicationID: string, interactionToken: string, messageID?: string) => string;
    FOLLOWUP_MESSAGE: (applicationID: string, interactionToken: string) => string;
    DEFAULT_USER_AVATAR: (userDiscriminator: string | number) => string;
    USER_AVATAR: (userID: string, userAvatar: string) => string;
    USER_AVATAR_DECORATION: (userID: string, userDecoration: string) => string;
    ROLE_ICON: (roleID: string, roleIcon: string) => string;
    GUILD_MEMBER_AVATAR: (guildID: string, memberID: string, memberAvatar: string) => string;
};