commandkit 0.1.11-dev.20240202064607 → 0.1.11-dev.20240203230231

package/dist/CommandKit--SA9LcIq.d.mts

@@ -0,0 +1,452 @@
+import { ValidationHandler } from './handlers/validation-handler/ValidationHandler.mjs';
+import * as discord_js from 'discord.js';
+import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, AutocompleteInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, Interaction, CacheType } from 'discord.js';
+import { AsyncLocalStorage } from 'async_hooks';
+
+/**
+ * Command handler options.
+ * Similar to CommandKit options in structure.
+ */
+interface CommandHandlerOptions {
+    /**
+     * The client created by the user.
+     */
+    client: Client;
+    /**
+     * Path to the user's commands.
+     */
+    commandsPath: string;
+    /**
+     * An array of developer guild IDs.
+     */
+    devGuildIds: string[];
+    /**
+     * An array of developer user IDs.
+     */
+    devUserIds: string[];
+    /**
+     * An array of developer role IDs.
+     */
+    devRoleIds: string[];
+    /**
+     * A validation handler instance to run validations before commands.
+     */
+    validationHandler?: ValidationHandler;
+    /**
+     * A boolean indicating whether to skip CommandKit's built-in validations (permission checking, etc.)
+     */
+    skipBuiltInValidations: boolean;
+    /**
+     * The CommandKit handler that instantiated this.
+     */
+    commandkitInstance: CommandKit;
+    /**
+     * A boolean indicating whether to register all commands in bulk.
+     */
+    bulkRegister: boolean;
+    /**
+     * Whether to enable hooks context.
+     */
+    enableHooks: boolean;
+}
+/**
+ * Private command handler data.
+ */
+interface CommandHandlerData extends CommandHandlerOptions {
+    /**
+     * An array of command file objects.
+     */
+    commands: CommandFileObject[];
+    /**
+     * An array of built-in validations.
+     */
+    builtInValidations: BuiltInValidation[];
+    /**
+     * A validation handler instance to run validations before commands.
+     */
+    validationHandler?: ValidationHandler;
+}
+/**
+ * Parameters for CommandKit's built-in validations.
+ */
+interface BuiltInValidationParams {
+    /**
+     * The target command to validate.
+     */
+    targetCommand: CommandFileObject;
+    /**
+     * The interaction of the target command.
+     */
+    interaction: CommandKitInteraction;
+    /**
+     * The command handler's data.
+     */
+    handlerData: CommandHandlerData;
+}
+/**
+ * Represents a command interaction.
+ */
+type CommandKitInteraction = ChatInputCommandInteraction | ContextMenuCommandInteraction | AutocompleteInteraction;
+/**
+ * A built in validation. Returns a boolean or void.
+ */
+type BuiltInValidation = ({}: BuiltInValidationParams) => boolean | void;
+
+/**
+ * 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 AutocompleteProps 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 ValidationProps {
+    /**
+     * The current command interaction object.
+     */
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | AutocompleteInteraction;
+    /**
+     * 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"
+}
+
+interface hCommandContext {
+    interaction: CommandKitInteraction;
+    command: CommandData;
+}
+/**
+ * A handler for client application commands.
+ */
+declare class CommandHandler {
+    #private;
+    context: AsyncLocalStorage<hCommandContext> | null;
+    constructor({ ...options }: CommandHandlerOptions);
+    init(): Promise<void>;
+    handleCommands(): void;
+    get commands(): CommandFileObject[];
+    reloadCommands(type?: ReloadOptions): Promise<void>;
+}
+
+/**
+ * Event handler options.
+ */
+interface EventHandlerOptions {
+    client: Client;
+    eventsPath: string;
+    commandKitInstance: CommandKit;
+}
+/**
+ * Private event handler data.
+ */
+interface EventHandlerData extends EventHandlerOptions {
+    events: {
+        name: string;
+        functions: Function[];
+    }[];
+}
+
+/**
+ * A handler for client events.
+ */
+declare class EventHandler {
+    #private;
+    constructor({ ...options }: EventHandlerOptions);
+    init(): Promise<void>;
+    get events(): {
+        name: string;
+        functions: Function[];
+    }[];
+    reloadEvents(commandHandler?: CommandHandler): Promise<void>;
+}
+
+/**
+ * Options for instantiating a CommandKit handler.
+ */
+interface CommandKitOptions {
+    /**
+     * The Discord.js client object to use with CommandKit.
+     */
+    client: Client;
+    /**
+     * The path to your commands directory.
+     */
+    commandsPath?: string;
+    /**
+     * The path to your events directory.
+     */
+    eventsPath?: string;
+    /**
+     * The path to the validations directory.
+     */
+    validationsPath?: string;
+    /**
+     * List of development guild IDs to restrict devOnly commands to.
+     */
+    devGuildIds?: string[];
+    /**
+     * List of developer user IDs to restrict devOnly commands to.
+     */
+    devUserIds?: string[];
+    /**
+     * List of developer role IDs to restrict devOnly commands to.
+     */
+    devRoleIds?: string[];
+    /**
+     * Skip CommandKit's built-in validations (for devOnly commands).
+     */
+    skipBuiltInValidations?: boolean;
+    /**
+     * Bulk register application commands instead of one-by-one.
+     */
+    bulkRegister?: boolean;
+    /**
+     * Options for experimental features.
+     */
+    experimental?: {
+        /**
+         * Enable hooks. This allows you to utilize hooks such as `useInteraction()` to access the interaction object anywhere inside the command.
+         */
+        hooks?: boolean;
+    };
+}
+/**
+ * Private data for the CommandKit class.
+ */
+interface CommandKitData extends CommandKitOptions {
+    commandHandler?: CommandHandler;
+    eventHandler?: EventHandler;
+    validationHandler?: ValidationHandler;
+}
+/**
+ * Represents a command context.
+ */
+interface CommandContext<T extends Interaction, Cached extends CacheType> {
+    /**
+     * The interaction that triggered this command.
+     */
+    interaction: Interaction<CacheType>;
+    /**
+     * The client that instantiated this command.
+     */
+    client: Client;
+    /**
+     * The command data.
+     */
+    handler: CommandKit;
+}
+/**
+ * Represents a command file.
+ */
+interface CommandFileObject {
+    data: CommandData;
+    options?: CommandOptions;
+    run: <Cached extends CacheType = CacheType>(ctx: CommandContext<Interaction, Cached>) => Awaited<void>;
+    autocomplete?: <Cached extends CacheType = CacheType>(ctx: CommandContext<Interaction, Cached>) => Awaited<void>;
+    filePath: string;
+    category: string | null;
+    [key: string]: any;
+}
+/**
+ * A reload type for commands.
+ */
+type ReloadOptions = 'dev' | 'global' | ReloadType;
+
+declare class CommandKit {
+    #private;
+    static _instance: CommandKit | null;
+    /**
+     * 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);
+    /**
+     * Get the client attached to this CommandKit instance.
+     */
+    get client(): discord_js.Client<boolean>;
+    /**
+     * Get command handler instance.
+     */
+    get commandHandler(): CommandHandler | undefined;
+    /**
+     * Updates application commands with the latest from "commandsPath".
+     */
+    reloadCommands(type?: ReloadOptions): Promise<void>;
+    /**
+     * Updates application events with the latest from "eventsPath".
+     */
+    reloadEvents(): Promise<void>;
+    /**
+     * Updates application command validations with the latest from "validationsPath".
+     */
+    reloadValidations(): Promise<void>;
+    /**
+     * @returns An array of objects of all the commands that CommandKit is handling.
+     */
+    get commands(): CommandObject[];
+    /**
+     * @returns The path to the commands folder which was set when instantiating CommandKit.
+     */
+    get commandsPath(): string | undefined;
+    /**
+     * @returns The path to the events folder which was set when instantiating CommandKit.
+     */
+    get eventsPath(): string | undefined;
+    /**
+     * @returns The path to the validations folder which was set when instantiating CommandKit.
+     */
+    get validationsPath(): string | undefined;
+    /**
+     * @returns An array of all the developer user IDs which was set when instantiating CommandKit.
+     */
+    get devUserIds(): string[];
+    /**
+     * @returns An array of all the developer guild IDs which was set when instantiating CommandKit.
+     */
+    get devGuildIds(): string[];
+    /**
+     * @returns An array of all the developer role IDs which was set when instantiating CommandKit.
+     */
+    get devRoleIds(): string[];
+}
+
+export { type AutocompleteProps as A, type BuiltInValidationParams as B, CommandKit as C, type EventHandlerOptions as E, type MessageContextMenuCommandProps as M, ReloadType as R, type SlashCommandProps as S, type UserContextMenuCommandProps as U, type ValidationProps as V, type CommandProps as a, type ContextMenuCommandProps as b, type CommandOptions as c, type CommandData as d, type CommandObject as e, CommandHandler as f, type CommandKitInteraction as g, type hCommandContext as h, type CommandFileObject as i, type ReloadOptions as j, type CommandHandlerOptions as k, type CommandHandlerData as l, type BuiltInValidation as m, type EventHandlerData as n, EventHandler as o, type CommandKitOptions as p, type CommandKitData as q, type CommandContext as r };