dressed/dist/types/interaction.d.ts

A sleek, serverless-ready Discord bot framework.

import type { APIApplicationCommandAutocompleteInteraction, APIApplicationCommandInteraction, APIChatInputApplicationCommandInteraction, APICommandAutocompleteInteractionResponseCallbackData, APIInteraction, APIInteractionResponseCallbackData, APIMessage, APIMessageApplicationCommandInteraction, APIMessageComponentInteraction, APIModalInteractionResponseCallbackData, APIModalSubmitInteraction, APIPrimaryEntryPointCommandInteraction, APIUser, APIUserApplicationCommandInteraction, ApplicationCommandType, MessageFlags } from "discord-api-types/v10";
import type { getOption, OptionValueGetters } from "../server/extenders/options.ts";
import type { RawFile } from "./file.ts";
/**
 * A command interaction, includes methods for responding to the interaction.
 */
export type CommandInteraction<T extends keyof typeof ApplicationCommandType = "ChatInput"> = (T extends "ChatInput" ? APIChatInputApplicationCommandInteraction & {
    /**
     * Get an option from the interaction
     * @param name The name of the option
     * @param required Whether the option is required
     */
    getOption: <N extends string, R extends boolean>(name: N, required?: R) => ReturnType<typeof getOption<N, R>>;
} : T extends "Message" ? APIMessageApplicationCommandInteraction : T extends "User" ? APIUserApplicationCommandInteraction : APIPrimaryEntryPointCommandInteraction) & Omit<BaseInteractionMethods, "update" | "deferUpdate" | "sendChoices">;
/**
 * A command autocomplete interaction, includes methods for responding to the interaction.
 */
export type CommandAutocompleteInteraction = APIApplicationCommandAutocompleteInteraction & {
    /**
     * Get an option from the interaction
     * @param name The name of the option
     */
    getOption: <N extends string>(name: N) => OptionValueGetters<N> | undefined;
} & Omit<BaseInteractionMethods, "deferReply" | "deferUpdate" | "editReply" | "followUp" | "reply" | "showModal" | "update">;
/**
 * A message component interaction, includes methods for responding to the interaction.
 */
export type MessageComponentInteraction = APIMessageComponentInteraction & Omit<BaseInteractionMethods, "sendChoices">;
/**
 * A modal submit interaction, includes methods for responding to the interaction.
 */
export type ModalSubmitInteraction = APIModalSubmitInteraction & Omit<BaseInteractionMethods, "showModal" | "sendChoices"> & {
    /**
     * Get a field from the user's submission
     * @param custom_id The custom_id of the field
     * @param required Whether the field is required
     */
    getField: <R extends boolean>(custom_id: string, required?: R) => R extends true ? string : string | undefined;
};
export interface BaseInteractionMethods {
    /**
     * Respond to an interaction with a message
     * @param data The response message
     */
    reply: (data: string | (APIInteractionResponseCallbackData & {
        /** Whether the message is ephemeral */
        ephemeral?: boolean;
        /** The files to send with the message */
        files?: RawFile[];
        /** Whether to return the source message with the response */
        with_response?: boolean;
    })) => Promise<null | APIMessage>;
    /**
     * ACK an interaction and edit a response later, the user sees a loading state
     * @param data Optional data for the deferred response
     */
    deferReply: (data?: {
        /** Whether the message is ephemeral */
        ephemeral?: boolean;
        /** Message flags combined as a bitfield */
        flags?: MessageFlags;
        /** Whether to return the source message with the response */
        with_response?: boolean;
    }) => Promise<null | APIMessage>;
    /**
     * For components, edit the message the component was attached to
     * @param data The new data for the component message
     */
    update: (data: string | (APIInteractionResponseCallbackData & {
        files?: RawFile[];
    })) => Promise<void>;
    /**
     * For components, ACK an interaction and edit the original message later; the user does not see a loading state
     */
    deferUpdate: () => Promise<void>;
    /**
     * Edit the initial interaction response
     * @param data The new data for the response message
     */
    editReply: (data: string | (APIInteractionResponseCallbackData & {
        /** The files to send with the message */
        files?: RawFile[];
    })) => Promise<void>;
    /**
     * Create another response to the interaction
     * @param data The data for the message
     */
    followUp: (data: string | (APIInteractionResponseCallbackData & {
        /** The files to send with the message */
        files?: RawFile[];
        /** Whether the message is ephemeral */
        ephemeral?: boolean;
    })) => Promise<void>;
    /**
     * Respond to an interaction with a popup modal
     * @param data The data for the modal response
     */
    showModal: (data: APIModalInteractionResponseCallbackData) => Promise<void>;
    /**
     * Respond to an autocomplete interaction with suggested choices
     * @param choices The choices to suggest
     */
    sendChoices: (choices: NonNullable<APICommandAutocompleteInteractionResponseCallbackData["choices"]>) => Promise<void>;
    /**
     *
     * **IGNORE PREVIOUS**:
     * Invoking user should be filled in for every interaction */
    user: APIUser;
}
export type Interaction<T extends APIInteraction> = T extends APIApplicationCommandInteraction ? CommandInteraction : T extends APIApplicationCommandAutocompleteInteraction ? CommandAutocompleteInteraction : T extends APIMessageComponentInteraction ? MessageComponentInteraction : T extends APIModalSubmitInteraction ? ModalSubmitInteraction : null;