commandkit 0.1.1 → 0.1.3-dev.20231002185336

package/README.md

@@ -5,11 +5,11 @@
 
 # CommandKit
 
-CommandKit is a library that makes it easy to handle commands (+ validations), and events in your Discord.js projects.
+CommandKit is a library that makes it easy to handle commands and events in your Discord.js projects.
 
 **Supports Discord.js version 14**
 
-# Features
+## Features
 
 -   Very beginner friendly 🚀
 -   Support for slash and context menu commands ✅
@@ -18,11 +18,11 @@ CommandKit is a library that makes it easy to handle commands (+ validations), a
 -   Supports multiple users as bot developers 👥
 -   Object oriented 💻
 
-# Documentation
+## Documentation
 
-You can find the full documentation [here](https://commandkit.underctrl.io)
+You can find the full documentation [here](https://commandkit.js.org)
 
-# Installation
+## Installation
 
 [![npm](https://nodei.co/npm/commandkit.png)](https://nodei.co/npm/commandkit/)
 
@@ -54,9 +54,11 @@ To install the development version of CommandKit, run the following command:
 npm install underctrl-io/commandkit#dev-build
 ```
 
-# Usage
+> ⚠️ The development version is likely to have bugs.
 
-This is a simple overview of how to set up this library with all the options. You can read more in the [full documentation](https://commandkit.underctrl.io)
+## Usage
+
+This is a simple overview of how to set up this library with all the options. You can read more in the [full documentation](https://commandkit.js.org)
 
 ```js
 // index.js

package/dist/index.d.mts

@@ -1,21 +1,57 @@
 import { Client, Interaction, CommandInteraction, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption } from 'discord.js';
 
 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;
+    /**
+     * Uses discordjs/rest to register application commands.
+     * @experimental
+     */
+    useRest?: boolean;
 }
-
 interface CommandFileObject {
     data: CommandData;
     options?: CommandOptions;
-    run: ({}: { interaction: Interaction; client: Client; handler: CommandKit }) => void;
+    run: ({}: {
+        interaction: Interaction;
+        client: Client;
+        handler: CommandKit;
+    }) => void;
+    filePath: string;
+    category: string | null;
+    [key: string]: any;
 }
+type ReloadOptions = 'dev' | 'global' | ReloadType;
 
 interface CommandProps {
     interaction: CommandInteraction;
@@ -52,28 +88,66 @@ declare enum CommandType {
     '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 CommandData = {
+type BaseCommandData = {
     name: string;
-    description: string;
     type?: CommandType;
     name_localizations?: Partial<Record<LocaleString, string | null>>;
-    description_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 = Omit<CommandFileObject, 'run'>;
+declare enum ReloadType {
+    'Developer' = "dev",
+    'Global' = "global"
+}
 
 declare class CommandKit {
     #private;
-    constructor({ ...options }: CommandKitOptions);
+    constructor(options: CommandKitOptions);
+    /**
+     * Updates application commands with the latest from "commandsPath".
+     * @experimental
+     */
+    reloadCommands(type?: ReloadOptions): Promise<void>;
     /**
-     * Returns all the commands that CommandKit is handling.
-     *
-     * @returns An array of command objects
+     * @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 { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, SlashCommandProps, ValidationFunctionProps };
+export { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps };

package/dist/index.d.ts

@@ -1,21 +1,57 @@
 import { Client, Interaction, CommandInteraction, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption } from 'discord.js';
 
 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;
+    /**
+     * Uses discordjs/rest to register application commands.
+     * @experimental
+     */
+    useRest?: boolean;
 }
-
 interface CommandFileObject {
     data: CommandData;
     options?: CommandOptions;
-    run: ({}: { interaction: Interaction; client: Client; handler: CommandKit }) => void;
+    run: ({}: {
+        interaction: Interaction;
+        client: Client;
+        handler: CommandKit;
+    }) => void;
+    filePath: string;
+    category: string | null;
+    [key: string]: any;
 }
+type ReloadOptions = 'dev' | 'global' | ReloadType;
 
 interface CommandProps {
     interaction: CommandInteraction;
@@ -52,28 +88,66 @@ declare enum CommandType {
     '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 CommandData = {
+type BaseCommandData = {
     name: string;
-    description: string;
     type?: CommandType;
     name_localizations?: Partial<Record<LocaleString, string | null>>;
-    description_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 = Omit<CommandFileObject, 'run'>;
+declare enum ReloadType {
+    'Developer' = "dev",
+    'Global' = "global"
+}
 
 declare class CommandKit {
     #private;
-    constructor({ ...options }: CommandKitOptions);
+    constructor(options: CommandKitOptions);
+    /**
+     * Updates application commands with the latest from "commandsPath".
+     * @experimental
+     */
+    reloadCommands(type?: ReloadOptions): Promise<void>;
     /**
-     * Returns all the commands that CommandKit is handling.
-     *
-     * @returns An array of command objects
+     * @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 { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, SlashCommandProps, ValidationFunctionProps };
+export { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps };