commandkit 0.1.6-dev.20231113071041 → 0.1.6-dev.20231124164249

package/dist/index.d.mts

@@ -1,70 +1,228 @@
 import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionsString, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
+/**
+ * Base props for commands.
+ */
 interface CommandProps {
+    /**
+     * Represents the command's interaction.
+     */
     interaction: CommandInteraction;
+    /**
+     * The client created in your main file.
+     */
     client: Client<true>;
+    /**
+     * The main CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Props for slash command run functions.
+ */
 interface SlashCommandProps {
+    /**
+     * Represents the command's interaction.
+     */
     interaction: ChatInputCommandInteraction;
+    /**
+     * The client created in your main file.
+     */
     client: Client<true>;
+    /**
+     * The CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Props for context menu command run functions.
+ */
 interface ContextMenuCommandProps {
+    /**
+     * Represents the command's interaction.
+     */
     interaction: ContextMenuCommandInteraction;
+    /**
+     * The client created in your main file.
+     */
     client: Client<true>;
+    /**
+     * The CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Props for command validations.
+ */
 interface ValidationFunctionProps {
+    /**
+     * Represents the command's interaction.
+     * Either a slash command or a context menu command interaction.
+     */
     interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
+    /**
+     * The client created in your main file.
+     * Represented as a ready client (`Client<true>`).
+     */
     client: Client<true>;
+    /**
+     * The command object that is being validated.
+     */
     commandObj: CommandObject;
+    /**
+     * The CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Configuration for commands.
+ */
 interface CommandOptions {
+    /**
+     * Boolean indicating whether the command is guild-only.
+     * @deprecated - Use `dm_permission` in the command's data instead.
+     */
     guildOnly?: boolean;
+    /**
+     * Boolean indicating whether the command is developer only.
+     */
     devOnly?: boolean;
+    /**
+     * Boolean indicating whether the command is deleted and should not be registered.
+     */
     deleted?: boolean;
+    /**
+     * An array of user permissions.
+     *
+     * @example
+     * userPermissions: ['BanMembers']
+     */
     userPermissions?: PermissionsString[];
+    /**
+     * An array of bot permissions.
+     *
+     * @example
+     * botPermissions: ['BanMembers']
+     */
     botPermissions?: PermissionsString[];
     [key: string]: any;
 }
 declare enum CommandType {
+    /**
+     * Slash commands.
+     */
     'ChatInput' = 1,
+    /**
+     * Message context menu commands.
+     */
     'Message' = 3,
+    /**
+     * User context menu commands.
+     */
     'User' = 2
 }
 type LocaleString = 'id' | `en-${'GB' | 'US'}` | 'bg' | `zh-${'CN' | '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';
+/**
+ * Common items for command data.
+ */
 type BaseCommandData = {
+    /**
+     * The name of the command.
+     */
     name: string;
+    /**
+     * The type of the command.
+     */
     type?: CommandType;
+    /**
+     * i18n for the command name.
+     */
     name_localizations?: Partial<Record<LocaleString, string | null>>;
+    /**
+     * Whether to allow this command in DMs.
+     */
     dm_permission?: boolean;
+    /**
+     * Default permissions for members for the command.
+     */
     default_member_permissions?: string;
+    /**
+     * Whether the command is age-restricted.
+     */
     nsfw?: boolean;
 };
+/**
+ * Data for chat input commands.
+ */
 type ChatInputCommandData = BaseCommandData & {
+    /**
+     * The command's type.
+     */
     type?: CommandType.ChatInput;
+    /**
+     * The description of the command.
+     */
     description: string;
+    /**
+     * i18n for the command description.
+     */
     description_localizations?: Partial<Record<LocaleString, string | null>>;
+    /**
+     * Chat input command options.
+     */
     options?: Array<APIApplicationCommandOption>;
 };
+/**
+ * Represents any context menu command data.
+ */
 type UserOrMessageCommandData = BaseCommandData & {
     type: CommandType.User | CommandType.Message;
 };
 type CommandData = ChatInputCommandData | UserOrMessageCommandData;
 type CommandObject = {
+    /**
+     * Command data which is a slash command builder or raw JSON data.
+     * @example
+     * {
+     *      name: 'ping',
+     *      description: 'Replies with Pong!'
+     * }
+     */
     data: CommandData;
+    /**
+     * CommandKit command options.
+     * @example
+     * {
+     *      devOnly: true,
+     *      userPermissions: ['ManageGuild'],
+     *      botPermissions: ['ManageGuild'],
+     * }
+     */
     options?: CommandOptions;
+    /**
+     * The path to the command file.
+     */
     filePath: string;
+    /**
+     * The command's category.
+     */
     category: string | null;
     [key: string]: any;
 };
 declare enum ReloadType {
+    /**
+     * Reload developer/guild commands.
+     */
     Developer = "dev",
+    /**
+     * Reload global commands.
+     */
     Global = "global"
 }
 
+/**
+ * Options for instantiating a CommandKit handler.
+ */
 interface CommandKitOptions {
     /**
      * The Discord.js client object to use with CommandKit.
@@ -103,10 +261,18 @@ interface CommandKitOptions {
      */
     bulkRegister?: boolean;
 }
+/**
+ * A reload type for commands.
+ */
 type ReloadOptions = 'dev' | 'global' | ReloadType;
 
 declare class CommandKit {
     #private;
+    /**
+     * Create a new handler with CommandKit.
+     * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+     * @see {@link https://commandkit.js.org/docs/commandkit-setup}
+     */
     constructor(options: CommandKitOptions);
     /**
      * Updates application commands with the latest from "commandsPath".
@@ -204,7 +370,16 @@ type CommandKitSignal<T> = readonly [
     (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 { ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps, createEffect, createSignal };

package/dist/index.d.ts

@@ -1,70 +1,228 @@
 import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionsString, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
+/**
+ * Base props for commands.
+ */
 interface CommandProps {
+    /**
+     * Represents the command's interaction.
+     */
     interaction: CommandInteraction;
+    /**
+     * The client created in your main file.
+     */
     client: Client<true>;
+    /**
+     * The main CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Props for slash command run functions.
+ */
 interface SlashCommandProps {
+    /**
+     * Represents the command's interaction.
+     */
     interaction: ChatInputCommandInteraction;
+    /**
+     * The client created in your main file.
+     */
     client: Client<true>;
+    /**
+     * The CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Props for context menu command run functions.
+ */
 interface ContextMenuCommandProps {
+    /**
+     * Represents the command's interaction.
+     */
     interaction: ContextMenuCommandInteraction;
+    /**
+     * The client created in your main file.
+     */
     client: Client<true>;
+    /**
+     * The CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Props for command validations.
+ */
 interface ValidationFunctionProps {
+    /**
+     * Represents the command's interaction.
+     * Either a slash command or a context menu command interaction.
+     */
     interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
+    /**
+     * The client created in your main file.
+     * Represented as a ready client (`Client<true>`).
+     */
     client: Client<true>;
+    /**
+     * The command object that is being validated.
+     */
     commandObj: CommandObject;
+    /**
+     * The CommandKit handler that instantiated this.
+     */
     handler: CommandKit;
 }
+/**
+ * Configuration for commands.
+ */
 interface CommandOptions {
+    /**
+     * Boolean indicating whether the command is guild-only.
+     * @deprecated - Use `dm_permission` in the command's data instead.
+     */
     guildOnly?: boolean;
+    /**
+     * Boolean indicating whether the command is developer only.
+     */
     devOnly?: boolean;
+    /**
+     * Boolean indicating whether the command is deleted and should not be registered.
+     */
     deleted?: boolean;
+    /**
+     * An array of user permissions.
+     *
+     * @example
+     * userPermissions: ['BanMembers']
+     */
     userPermissions?: PermissionsString[];
+    /**
+     * An array of bot permissions.
+     *
+     * @example
+     * botPermissions: ['BanMembers']
+     */
     botPermissions?: PermissionsString[];
     [key: string]: any;
 }
 declare enum CommandType {
+    /**
+     * Slash commands.
+     */
     'ChatInput' = 1,
+    /**
+     * Message context menu commands.
+     */
     'Message' = 3,
+    /**
+     * User context menu commands.
+     */
     'User' = 2
 }
 type LocaleString = 'id' | `en-${'GB' | 'US'}` | 'bg' | `zh-${'CN' | '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';
+/**
+ * Common items for command data.
+ */
 type BaseCommandData = {
+    /**
+     * The name of the command.
+     */
     name: string;
+    /**
+     * The type of the command.
+     */
     type?: CommandType;
+    /**
+     * i18n for the command name.
+     */
     name_localizations?: Partial<Record<LocaleString, string | null>>;
+    /**
+     * Whether to allow this command in DMs.
+     */
     dm_permission?: boolean;
+    /**
+     * Default permissions for members for the command.
+     */
     default_member_permissions?: string;
+    /**
+     * Whether the command is age-restricted.
+     */
     nsfw?: boolean;
 };
+/**
+ * Data for chat input commands.
+ */
 type ChatInputCommandData = BaseCommandData & {
+    /**
+     * The command's type.
+     */
     type?: CommandType.ChatInput;
+    /**
+     * The description of the command.
+     */
     description: string;
+    /**
+     * i18n for the command description.
+     */
     description_localizations?: Partial<Record<LocaleString, string | null>>;
+    /**
+     * Chat input command options.
+     */
     options?: Array<APIApplicationCommandOption>;
 };
+/**
+ * Represents any context menu command data.
+ */
 type UserOrMessageCommandData = BaseCommandData & {
     type: CommandType.User | CommandType.Message;
 };
 type CommandData = ChatInputCommandData | UserOrMessageCommandData;
 type CommandObject = {
+    /**
+     * Command data which is a slash command builder or raw JSON data.
+     * @example
+     * {
+     *      name: 'ping',
+     *      description: 'Replies with Pong!'
+     * }
+     */
     data: CommandData;
+    /**
+     * CommandKit command options.
+     * @example
+     * {
+     *      devOnly: true,
+     *      userPermissions: ['ManageGuild'],
+     *      botPermissions: ['ManageGuild'],
+     * }
+     */
     options?: CommandOptions;
+    /**
+     * The path to the command file.
+     */
     filePath: string;
+    /**
+     * The command's category.
+     */
     category: string | null;
     [key: string]: any;
 };
 declare enum ReloadType {
+    /**
+     * Reload developer/guild commands.
+     */
     Developer = "dev",
+    /**
+     * Reload global commands.
+     */
     Global = "global"
 }
 
+/**
+ * Options for instantiating a CommandKit handler.
+ */
 interface CommandKitOptions {
     /**
      * The Discord.js client object to use with CommandKit.
@@ -103,10 +261,18 @@ interface CommandKitOptions {
      */
     bulkRegister?: boolean;
 }
+/**
+ * A reload type for commands.
+ */
 type ReloadOptions = 'dev' | 'global' | ReloadType;
 
 declare class CommandKit {
     #private;
+    /**
+     * Create a new handler with CommandKit.
+     * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+     * @see {@link https://commandkit.js.org/docs/commandkit-setup}
+     */
     constructor(options: CommandKitOptions);
     /**
      * Updates application commands with the latest from "commandsPath".
@@ -204,7 +370,16 @@ type CommandKitSignal<T> = readonly [
     (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 { ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps, createEffect, createSignal };

package/dist/index.js

@@ -32,8 +32,6 @@ var src_exports = {};
 __export(src_exports, {
   ButtonKit: () => ButtonKit,
   CommandKit: () => CommandKit,
-  CommandType: () => CommandType,
-  ReloadType: () => ReloadType,
   createEffect: () => createEffect,
   createSignal: () => createSignal
 });
@@ -787,6 +785,11 @@ var ValidationHandler = class {
 // src/CommandKit.ts
 var CommandKit = class {
   #data;
+  /**
+   * Create a new handler with CommandKit.
+   * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+   * @see {@link https://commandkit.js.org/docs/commandkit-setup}
+   */
   constructor(options) {
     if (!options.client) {
       throw new Error(colors_default.red('"client" is required when instantiating CommandKit.'));
@@ -799,6 +802,9 @@ var CommandKit = class {
     this.#data = options;
     this.#init();
   }
+  /**
+   * (Private) Initialize CommandKit.
+   */
   async #init() {
     if (this.#data.eventsPath) {
       const eventHandler = new EventHandler({
@@ -1013,25 +1019,10 @@ function createEffect(callback) {
 function getCurrentObserver() {
   return context[context.length - 1];
 }
-
-// src/types/index.ts
-var CommandType = /* @__PURE__ */ ((CommandType2) => {
-  CommandType2[CommandType2["ChatInput"] = 1] = "ChatInput";
-  CommandType2[CommandType2["Message"] = 3] = "Message";
-  CommandType2[CommandType2["User"] = 2] = "User";
-  return CommandType2;
-})(CommandType || {});
-var ReloadType = /* @__PURE__ */ ((ReloadType2) => {
-  ReloadType2["Developer"] = "dev";
-  ReloadType2["Global"] = "global";
-  return ReloadType2;
-})(ReloadType || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ButtonKit,
   CommandKit,
-  CommandType,
-  ReloadType,
   createEffect,
   createSignal
 });

package/dist/index.mjs

@@ -754,6 +754,11 @@ var ValidationHandler = class {
 // src/CommandKit.ts
 var CommandKit = class {
   #data;
+  /**
+   * Create a new handler with CommandKit.
+   * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+   * @see {@link https://commandkit.js.org/docs/commandkit-setup}
+   */
   constructor(options) {
     if (!options.client) {
       throw new Error(colors_default.red('"client" is required when instantiating CommandKit.'));
@@ -766,6 +771,9 @@ var CommandKit = class {
     this.#data = options;
     this.#init();
   }
+  /**
+   * (Private) Initialize CommandKit.
+   */
   async #init() {
     if (this.#data.eventsPath) {
       const eventHandler = new EventHandler({
@@ -984,24 +992,9 @@ function createEffect(callback) {
 function getCurrentObserver() {
   return context[context.length - 1];
 }
-
-// src/types/index.ts
-var CommandType = /* @__PURE__ */ ((CommandType2) => {
-  CommandType2[CommandType2["ChatInput"] = 1] = "ChatInput";
-  CommandType2[CommandType2["Message"] = 3] = "Message";
-  CommandType2[CommandType2["User"] = 2] = "User";
-  return CommandType2;
-})(CommandType || {});
-var ReloadType = /* @__PURE__ */ ((ReloadType2) => {
-  ReloadType2["Developer"] = "dev";
-  ReloadType2["Global"] = "global";
-  return ReloadType2;
-})(ReloadType || {});
 export {
   ButtonKit,
   CommandKit,
-  CommandType,
-  ReloadType,
   createEffect,
   createSignal
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "commandkit",
   "description": "Beginner friendly command & event handler for Discord.js",
-  "version": "0.1.6-dev.20231113071041",
+  "version": "0.1.6-dev.20231124164249",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",