commandkit 0.1.6 → 0.1.7-dev.20231212150647

package/dist/index.d.ts

@@ -1,70 +1,8 @@
-import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption } from 'discord.js';
-
-interface CommandProps {
-    interaction: CommandInteraction;
-    client: Client<true>;
-    handler: CommandKit;
-}
-interface SlashCommandProps {
-    interaction: ChatInputCommandInteraction;
-    client: Client<true>;
-    handler: CommandKit;
-}
-interface ContextMenuCommandProps {
-    interaction: ContextMenuCommandInteraction;
-    client: Client<true>;
-    handler: CommandKit;
-}
-interface ValidationFunctionProps {
-    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
-    client: Client<true>;
-    commandObj: CommandObject;
-    handler: CommandKit;
-}
-interface CommandOptions {
-    guildOnly?: boolean;
-    devOnly?: boolean;
-    deleted?: boolean;
-    userPermissions?: PermissionResolvable;
-    botPermissions?: PermissionResolvable;
-    [key: string]: any;
-}
-declare enum CommandType {
-    'ChatInput' = 1,
-    'Message' = 3,
-    'User' = 2
-}
-type LocaleString = 'id' | 'en-US' | 'en-GB' | 'bg' | 'zh-CN' | 'zh-TW' | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi';
-type BaseCommandData = {
-    name: string;
-    type?: CommandType;
-    name_localizations?: Partial<Record<LocaleString, string | null>>;
-    dm_permission?: boolean;
-    default_member_permissions?: string;
-    nsfw?: boolean;
-};
-type ChatInputCommandData = BaseCommandData & {
-    type?: CommandType.ChatInput;
-    description: string;
-    description_localizations?: Partial<Record<LocaleString, string | null>>;
-    options?: Array<APIApplicationCommandOption>;
-};
-type UserOrMessageCommandData = BaseCommandData & {
-    type: CommandType.User | CommandType.Message;
-};
-type CommandData = ChatInputCommandData | UserOrMessageCommandData;
-type CommandObject = {
-    data: CommandData;
-    options?: CommandOptions;
-    filePath: string;
-    category: string | null;
-    [key: string]: any;
-};
-declare enum ReloadType {
-    'Developer' = "dev",
-    'Global' = "global"
-}
+import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
+/**
+ * Options for instantiating a CommandKit handler.
+ */
 interface CommandKitOptions {
     /**
      * The Discord.js client object to use with CommandKit.
@@ -103,10 +41,175 @@ interface CommandKitOptions {
      */
     bulkRegister?: boolean;
 }
+/**
+ * A reload type for commands.
+ */
 type ReloadOptions = 'dev' | 'global' | ReloadType;
 
+/**
+ * Props for command run functions.
+ */
+interface CommandProps {
+    /**
+     * The current command interaction object.
+     */
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction | AutocompleteInteraction;
+    /**
+     * The Discord.js client object that CommandKit is handling.
+     */
+    client: Client<true>;
+    /**
+     * The current CommandKit handler instance.
+     */
+    handler: CommandKit;
+}
+/**
+ * Props for autocomplete command run functions.
+ */
+interface AutocompleteCommandProps extends CommandProps {
+    /**
+     * The current autocomplete command interaction object.
+     */
+    interaction: AutocompleteInteraction;
+}
+/**
+ * Props for slash (chat input) command run functions.
+ */
+interface SlashCommandProps extends CommandProps {
+    /**
+     * The current slash (chat input) command interaction object.
+     */
+    interaction: ChatInputCommandInteraction;
+}
+/**
+ * Props for context menu command run functions.
+ */
+interface ContextMenuCommandProps extends CommandProps {
+    /**
+     * The current context menu command interaction object.
+     */
+    interaction: ContextMenuCommandInteraction;
+}
+/**
+ * Props for user context menu command run functions.
+ */
+interface UserContextMenuCommandProps extends CommandProps {
+    interaction: UserContextMenuCommandInteraction;
+}
+/**
+ * Props for message context menu command run functions.
+ */
+interface MessageContextMenuCommandProps extends CommandProps {
+    interaction: MessageContextMenuCommandInteraction;
+}
+/**
+ * Props for command validation functions.
+ */
+interface ValidationFunctionProps {
+    /**
+     * The current command interaction object.
+     */
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
+    /**
+     * The Discord.js client object that CommandKit is handling.
+     */
+    client: Client<true>;
+    /**
+     * The current (local) target command object.
+     */
+    commandObj: CommandObject;
+    /**
+     * The current CommandKit handler instance.
+     */
+    handler: CommandKit;
+}
+/**
+ * Additional command configuration options.
+ */
+interface CommandOptions {
+    /**
+     * A boolean indicating whether the command is guild-only.
+     * Used for built-in validation.
+     *
+     * @deprecated Use `dm_permission` in the command's `data` object instead.
+     */
+    guildOnly?: boolean;
+    /**
+     * A boolean indicating whether the command is developer-only.
+     * Used for registration and built-in validation.
+     */
+    devOnly?: boolean;
+    /**
+     * A boolean indicating whether the command is deleted/ignored on restart/reload.
+     */
+    deleted?: boolean;
+    /**
+     * A string or array of permissions that a user needs for the current command to be executed.
+     * Used for built-in validation.
+     *
+     * @example
+     * userPermissions: 'BanMembers'
+     * or
+     * userPermissions: ['BanMembers', 'KickMembers']
+     */
+    userPermissions?: PermissionsString | PermissionsString[];
+    /**
+     * A string or array of permissions that the bot needs to execute the current command.
+     * Used for built-in validation.
+     *
+     * @example
+     * botPermissions: 'BanMembers'
+     * or
+     * botPermissions: ['BanMembers', 'KickMembers']
+     */
+    botPermissions?: PermissionsString | PermissionsString[];
+    [key: string]: any;
+}
+type CommandData = RESTPostAPIApplicationCommandsJSONBody;
+type CommandObject = {
+    /**
+     * An object which defines the structure of the application command.
+     */
+    data: CommandData;
+    /**
+     * Additional command configuration options.
+     */
+    options?: CommandOptions;
+    /**
+     * The path to the command file.
+     */
+    filePath: string;
+    /**
+     * The command's category. Determined based on the command folder.
+     *
+     * @example
+     * ```txt
+     * "/src/commands/ping.js" -> null
+     * "/src/commands/Misc/ping.js" -> "Misc"
+     * ```
+     */
+    category: string | null;
+    [key: string]: any;
+};
+declare enum ReloadType {
+    /**
+     * Reload developer/guild commands.
+     */
+    Developer = "dev",
+    /**
+     * Reload global commands.
+     */
+    Global = "global"
+}
+
 declare class CommandKit {
     #private;
+    /**
+     * Create a new command and event handler with CommandKit.
+     *
+     * @param options - The default CommandKit configuration.
+     * @see {@link https://commandkit.js.org/docs/commandkit-setup}
+     */
     constructor(options: CommandKitOptions);
     /**
      * Updates application commands with the latest from "commandsPath".
@@ -150,4 +253,122 @@ declare class CommandKit {
     get devRoleIds(): string[];
 }
 
-export { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps };
+/**
+ * The handler to run when a button is clicked. This handler is called with the interaction as the first argument.
+ * If the first argument is null, it means that the interaction collector has been destroyed.
+ */
+type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction | null) => Awaitable<void>;
+type CommandKitButtonBuilderInteractionCollectorDispatchContextData = {
+    /**
+     * The message to listen for button interactions on.
+     */
+    message: Message;
+    /**
+     * The duration (in ms) that the collector should run for.
+     */
+    time?: number;
+    /**
+     * If the collector should automatically reset the timer when a button is clicked.
+     */
+    autoReset?: boolean;
+} & Omit<InteractionCollectorOptions<ButtonInteraction>, 'filter' | 'componentType'>;
+declare class ButtonKit extends ButtonBuilder {
+    #private;
+    /**
+     * Sets up an inline interaction collector for this button. This collector by default allows as many interactions as possible if it is actively used.
+     * If unused, this expires after 24 hours or custom time if specified.
+     * @param handler The handler to run when the button is clicked
+     * @param data The context data to use for the interaction collector
+     * @returns This button
+     * @example
+     * ```ts
+     * const button = new ButtonKit()
+     *   .setLabel('Click me')
+     *   .setStyle(ButtonStyle.Primary)
+     *   .setCustomId('click_me');
+     *
+     * const row = new ActionRowBuilder().addComponents(button);
+     *
+     * const message = await channel.send({ content: 'Click the button', components: [row] });
+     *
+     * button.onClick(async (interaction) => {
+     *   await interaction.reply('You clicked me!');
+     * }, { message });
+     *
+     * // Remove onClick handler and destroy the interaction collector
+     * button.onClick(null);
+     * ```
+     */
+    onClick(handler: null): this;
+    onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
+}
+
+interface CommandKitConfig {
+    /**
+     * The source directory of the project.
+     */
+    src: string;
+    /**
+     * The main "javascript" file of the project.
+     */
+    main: string;
+    /**
+     * Whether or not to use the watch mode. Defaults to `true`.
+     */
+    watch: boolean;
+    /**
+     * The output directory of the project. Defaults to `dist`.
+     */
+    outDir: string;
+    /**
+     * Whether or not to include extra env utilities. Defaults to `true`.
+     */
+    envExtra: boolean;
+    /**
+     * Node.js cli options.
+     */
+    nodeOptions: string[];
+    /**
+     * Whether or not to clear default restart logs. Defaults to `true`.
+     */
+    clearRestartLogs: boolean;
+    /**
+     * Whether or not to minify the output. Defaults to `false`.
+     */
+    minify: boolean;
+    /**
+     * Whether or not to include sourcemaps in production build. Defaults to `false`.
+     */
+    sourcemap: boolean | 'inline';
+    /**
+     * Whether or not to include anti-crash handler in production. Defaults to `true`.
+     */
+    antiCrash: boolean;
+}
+declare function getConfig(): CommandKitConfig;
+declare const requiredProps: readonly ["src", "main"];
+type R = (typeof requiredProps)[number];
+type PartialConfig<T extends CommandKitConfig> = Partial<Omit<T, R>> & Pick<T, R>;
+declare function defineConfig(config: PartialConfig<CommandKitConfig>): Partial<CommandKitConfig>;
+
+type CommandKitEffectCallback = () => void;
+type CommandKitSignalInitializer<T> = T | (() => T);
+type CommandKitSignalUpdater<T> = T | ((prev: T) => T);
+type CommandKitSignal<T> = readonly [
+    () => T,
+    (value: CommandKitSignalUpdater<T>) => void,
+    () => void
+];
+/**
+ * Creates a new signal.
+ * @param value - The initial value to use.
+ * @returns An array of functions: a getter, a setter, and a disposer.
+ */
+declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T>): CommandKitSignal<T>;
+/**
+ * Creates a new effect.
+ * @param callback - The callback function to execute.
+ */
+declare function createEffect(callback: CommandKitEffectCallback): void;
+
+export { AutocompleteCommandProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationFunctionProps, createEffect, createSignal, defineConfig, getConfig };