commandkit 0.1.10-dev.20231229085439 → 0.1.10-dev.20240108063947

package/dist/index.d.mts

@@ -1,50 +1,75 @@
-import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
+import * as discord_js from 'discord.js';
+import { ChatInputCommandInteraction, ContextMenuCommandInteraction, AutocompleteInteraction, Client, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, CacheType, Interaction, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder, PartialTextBasedChannelFields, TextBasedChannel, Guild, GuildMember, APIInteractionGuildMember, User } from 'discord.js';
+import { AsyncLocalStorage } from 'async_hooks';
 
 /**
- * Options for instantiating a CommandKit handler.
+ * Validation handler options (validationsPath).
  */
-interface CommandKitOptions {
+interface ValidationHandlerOptions {
+    validationsPath: string;
+}
+
+/**
+ * A handler for command validations.
+ */
+declare class ValidationHandler {
+    #private;
+    constructor({ ...options }: ValidationHandlerOptions);
+    init(): Promise<void>;
+    get validations(): Function[];
+    reloadValidations(): Promise<void>;
+}
+
+/**
+ * Command handler options.
+ * Similar to CommandKit options in structure.
+ */
+interface CommandHandlerOptions {
     /**
-     * The Discord.js client object to use with CommandKit.
+     * The client created by the user.
      */
     client: Client;
     /**
-     * The path to your commands directory.
+     * Path to the user's commands.
      */
-    commandsPath?: string;
+    commandsPath: string;
     /**
-     * The path to your events directory.
+     * An array of developer guild IDs.
      */
-    eventsPath?: string;
+    devGuildIds: string[];
     /**
-     * The path to the validations directory.
+     * An array of developer user IDs.
      */
-    validationsPath?: string;
+    devUserIds: string[];
     /**
-     * List of development guild IDs to restrict devOnly commands to.
+     * An array of developer role IDs.
      */
-    devGuildIds?: string[];
+    devRoleIds: string[];
     /**
-     * List of developer user IDs to restrict devOnly commands to.
+     * A validation handler instance to run validations before commands.
      */
-    devUserIds?: string[];
+    validationHandler?: ValidationHandler;
     /**
-     * List of developer role IDs to restrict devOnly commands to.
+     * A boolean indicating whether to skip CommandKit's built-in validations (permission checking, etc.)
      */
-    devRoleIds?: string[];
+    skipBuiltInValidations: boolean;
     /**
-     * Skip CommandKit's built-in validations (for devOnly commands).
+     * The CommandKit handler that instantiated this.
      */
-    skipBuiltInValidations?: boolean;
+    commandkitInstance: CommandKit;
     /**
-     * Bulk register application commands instead of one-by-one.
+     * A boolean indicating whether to register all commands in bulk.
      */
-    bulkRegister?: boolean;
+    bulkRegister: boolean;
+    /**
+     * Whether to enable hooks context.
+     */
+    enableHooks: boolean;
 }
 /**
- * A reload type for commands.
+ * Represents a command interaction.
  */
-type ReloadOptions = 'dev' | 'global' | ReloadType;
+type CommandKitInteraction = ChatInputCommandInteraction | ContextMenuCommandInteraction | AutocompleteInteraction;
 
 /**
  * Props for command run functions.
@@ -202,8 +227,110 @@ declare enum ReloadType {
     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>;
+}
+
+/**
+ * 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;
+    };
+}
+/**
+ * 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.
      *
@@ -211,6 +338,14 @@ declare class CommandKit {
      * @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".
      */
@@ -376,4 +511,24 @@ declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T
  */
 declare function createEffect(callback: CommandKitEffectCallback): void;
 
-export { AutocompleteProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationProps, createEffect, createSignal, defineConfig, getConfig };
+declare function useClient(): discord_js.Client<boolean>;
+
+declare function useCommandKit(): CommandKit;
+
+type ChatInputReplyData = Parameters<ChatInputCommandInteraction['reply']>[0];
+type MessageData = Parameters<PartialTextBasedChannelFields['send']>[0] | ChatInputReplyData;
+declare function response(data: MessageData): Promise<void>;
+
+declare function useChannel(): TextBasedChannel | null;
+
+declare function useCommandData(): discord_js.RESTPostAPIApplicationCommandsJSONBody;
+
+declare function useGuild(): Guild | null;
+
+declare function useInteraction<T extends CommandKitInteraction = CommandKitInteraction>(): T;
+
+declare function useMember(): GuildMember | APIInteractionGuildMember | null;
+
+declare function useUser(): User;
+
+export { AutocompleteProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationProps, createEffect, createSignal, defineConfig, getConfig, response, useChannel, useClient, useCommandData, useCommandKit, useGuild, useInteraction, useMember, useUser };

package/dist/index.d.ts

@@ -1,50 +1,75 @@
-import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
+import * as discord_js from 'discord.js';
+import { ChatInputCommandInteraction, ContextMenuCommandInteraction, AutocompleteInteraction, Client, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, CacheType, Interaction, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder, PartialTextBasedChannelFields, TextBasedChannel, Guild, GuildMember, APIInteractionGuildMember, User } from 'discord.js';
+import { AsyncLocalStorage } from 'async_hooks';
 
 /**
- * Options for instantiating a CommandKit handler.
+ * Validation handler options (validationsPath).
  */
-interface CommandKitOptions {
+interface ValidationHandlerOptions {
+    validationsPath: string;
+}
+
+/**
+ * A handler for command validations.
+ */
+declare class ValidationHandler {
+    #private;
+    constructor({ ...options }: ValidationHandlerOptions);
+    init(): Promise<void>;
+    get validations(): Function[];
+    reloadValidations(): Promise<void>;
+}
+
+/**
+ * Command handler options.
+ * Similar to CommandKit options in structure.
+ */
+interface CommandHandlerOptions {
     /**
-     * The Discord.js client object to use with CommandKit.
+     * The client created by the user.
      */
     client: Client;
     /**
-     * The path to your commands directory.
+     * Path to the user's commands.
      */
-    commandsPath?: string;
+    commandsPath: string;
     /**
-     * The path to your events directory.
+     * An array of developer guild IDs.
      */
-    eventsPath?: string;
+    devGuildIds: string[];
     /**
-     * The path to the validations directory.
+     * An array of developer user IDs.
      */
-    validationsPath?: string;
+    devUserIds: string[];
     /**
-     * List of development guild IDs to restrict devOnly commands to.
+     * An array of developer role IDs.
      */
-    devGuildIds?: string[];
+    devRoleIds: string[];
     /**
-     * List of developer user IDs to restrict devOnly commands to.
+     * A validation handler instance to run validations before commands.
      */
-    devUserIds?: string[];
+    validationHandler?: ValidationHandler;
     /**
-     * List of developer role IDs to restrict devOnly commands to.
+     * A boolean indicating whether to skip CommandKit's built-in validations (permission checking, etc.)
      */
-    devRoleIds?: string[];
+    skipBuiltInValidations: boolean;
     /**
-     * Skip CommandKit's built-in validations (for devOnly commands).
+     * The CommandKit handler that instantiated this.
      */
-    skipBuiltInValidations?: boolean;
+    commandkitInstance: CommandKit;
     /**
-     * Bulk register application commands instead of one-by-one.
+     * A boolean indicating whether to register all commands in bulk.
      */
-    bulkRegister?: boolean;
+    bulkRegister: boolean;
+    /**
+     * Whether to enable hooks context.
+     */
+    enableHooks: boolean;
 }
 /**
- * A reload type for commands.
+ * Represents a command interaction.
  */
-type ReloadOptions = 'dev' | 'global' | ReloadType;
+type CommandKitInteraction = ChatInputCommandInteraction | ContextMenuCommandInteraction | AutocompleteInteraction;
 
 /**
  * Props for command run functions.
@@ -202,8 +227,110 @@ declare enum ReloadType {
     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>;
+}
+
+/**
+ * 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;
+    };
+}
+/**
+ * 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.
      *
@@ -211,6 +338,14 @@ declare class CommandKit {
      * @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".
      */
@@ -376,4 +511,24 @@ declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T
  */
 declare function createEffect(callback: CommandKitEffectCallback): void;
 
-export { AutocompleteProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationProps, createEffect, createSignal, defineConfig, getConfig };
+declare function useClient(): discord_js.Client<boolean>;
+
+declare function useCommandKit(): CommandKit;
+
+type ChatInputReplyData = Parameters<ChatInputCommandInteraction['reply']>[0];
+type MessageData = Parameters<PartialTextBasedChannelFields['send']>[0] | ChatInputReplyData;
+declare function response(data: MessageData): Promise<void>;
+
+declare function useChannel(): TextBasedChannel | null;
+
+declare function useCommandData(): discord_js.RESTPostAPIApplicationCommandsJSONBody;
+
+declare function useGuild(): Guild | null;
+
+declare function useInteraction<T extends CommandKitInteraction = CommandKitInteraction>(): T;
+
+declare function useMember(): GuildMember | APIInteractionGuildMember | null;
+
+declare function useUser(): User;
+
+export { AutocompleteProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationProps, createEffect, createSignal, defineConfig, getConfig, response, useChannel, useClient, useCommandData, useCommandKit, useGuild, useInteraction, useMember, useUser };