add changelogs + update types

notunderctrl · notunderctrl · commit 60ab3138c4a7 · 2023-12-12T22:28:05.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.9] - 2023-12-12
+
+### Changes (breaking)
+
+-   Update `ValidationFunctionProps` type name to `ValidationProps`.
+-   Update `autocompleteRun` command function name to `autocomplete`.
+-   Update `AutocompleteCommandProps` type name to `AutocompleteProps`.
+
+### Deprecated
+
+-   `guildOnly` in command options. CommandKit no longer handles the `guildOnly` condition. Use `dm_permission` in your command `data` object instead.
+
+### Fixed
+
+-   Broken docs links.
diff --git a/apps/docs/pages/docs/enums/_meta.json b/apps/docs/pages/docs/enums/_meta.json
@@ -1,4 +1,3 @@
 {
-    "CommandType": "CommandType",
     "ReloadType": "ReloadType"
 }
diff --git a/apps/docs/pages/docs/typedef/AutocompleteProps.mdx b/apps/docs/pages/docs/typedef/AutocompleteProps.mdx
@@ -0,0 +1,13 @@
+# SlashCommandProps
+
+### `client`
+
+-   Type: [`Client`](https://old.discordjs.dev/#/docs/discord.js/main/class/Client)
+
+### `handler`
+
+-   Type: [`CommandKit`](/docs/typedef/CommandKit)
+
+### `interaction`
+
+-   Type [`AutocompleteInteraction`](https://old.discordjs.dev/#/docs/discord.js/main/class/AutocompleteInteraction)
diff --git a/apps/docs/pages/docs/typedef/CommandObject.mdx b/apps/docs/pages/docs/typedef/CommandObject.mdx
@@ -2,11 +2,11 @@
 
 ### `data`
 
--   Type: [`CommandData`](/typedef/CommandData)
+-   Type: [`CommandData`](/docs/typedef/CommandData)
 
 ### `options` (optional)
 
--   Type: [`CommandOptions`](/typedef/CommandOptions)
+-   Type: [`CommandOptions`](/docs/typedef/CommandOptions)
 
 ### `filePath`
 
diff --git a/apps/docs/pages/docs/typedef/CommandOptions.mdx b/apps/docs/pages/docs/typedef/CommandOptions.mdx
@@ -1,5 +1,3 @@
-import { Callout } from 'nextra/components';
-
 # CommandOptions
 
 ### `devOnly` (optional)
@@ -8,16 +6,6 @@ import { Callout } from 'nextra/components';
 
 This determines whether the command should only be registered in development guilds and be executed by the bot developers.
 
-### `guildOnly` (optional)
-
-<Callout type="error">
-    This will soon be deprecated. Use `dm_permission` in your command `data` instead.
-</Callout>
-
--   Type: `boolean`
-
-This determines whether the command should only be handled in guilds.
-
 ### `userPermissions` (optional)
 
 -   Type: [`PermissionsString[]`](https://discord.js.org/docs/packages/discord.js/main/PermissionsString:TypeAlias)
diff --git a/apps/docs/pages/docs/typedef/ContextMenuCommandProps.mdx b/apps/docs/pages/docs/typedef/ContextMenuCommandProps.mdx
@@ -6,7 +6,7 @@
 
 ### `handler`
 
--   Type: [`CommandKit`](/typedef/CommandKit)
+-   Type: [`CommandKit`](/docs/typedef/CommandKit)
 
 ### `interaction`
 
diff --git a/apps/docs/pages/docs/typedef/_meta.json b/apps/docs/pages/docs/typedef/_meta.json
@@ -1,4 +1,5 @@
 {
+    "AutocompleteProps": "AutocompleteProps",
     "CommandData": "CommandData",
     "CommandKit": "CommandKit",
     "CommandObject": "CommandObject",
diff --git a/apps/docs/pages/guide/command-file-setup.mdx b/apps/docs/pages/guide/command-file-setup.mdx
@@ -10,7 +10,7 @@ Here's an example `/ping` slash command which replies with "Pong!"
 
 <Tabs items={['CommonJS', 'ESM', 'TypeScript']}>
     <Tabs.Tab>
-        ```js filename="commands/misc/ping.js" copy
+        ```js filename="commands/Misc/ping.js" copy
         module.exports = {
             data: {
                 name: 'ping',
@@ -32,7 +32,7 @@ Here's an example `/ping` slash command which replies with "Pong!"
         ```
     </Tabs.Tab>
     <Tabs.Tab>
-        ```js filename="commands/misc/ping.js" copy
+        ```js filename="commands/Misc/ping.js" copy
         export const data = {
             name: 'ping',
             description: 'Pong!',
@@ -52,7 +52,7 @@ Here's an example `/ping` slash command which replies with "Pong!"
         ```
     </Tabs.Tab>
     <Tabs.Tab>
-        ```ts filename="commands/misc/ping.ts" copy
+        ```ts filename="commands/Misc/ping.ts" copy
         import type { CommandData, SlashCommandProps, CommandOptions } from 'commandkit';
 
         export const data: CommandData = {
@@ -82,7 +82,7 @@ Here's an example `content` command which replies with the content of the target
 
 <Tabs items={['CommonJS', 'ESM', 'TypeScript']}>
     <Tabs.Tab>
-        ```js filename="commands/misc/content.js" copy
+        ```js filename="commands/Misc/content.js" copy
         const { ApplicationCommandType } = require("discord.js");
 
         module.exports = {
@@ -106,7 +106,7 @@ Here's an example `content` command which replies with the content of the target
         ```
     </Tabs.Tab>
     <Tabs.Tab>
-        ```js filename="commands/misc/content.js" copy
+        ```js filename="commands/Misc/content.js" copy
         import { ApplicationCommandType } from "discord.js";
 
         export const data = {
@@ -128,7 +128,7 @@ Here's an example `content` command which replies with the content of the target
         ```
     </Tabs.Tab>
     <Tabs.Tab>
-        ```ts filename="commands/misc/content.ts" copy
+        ```ts filename="commands/Misc/content.ts" copy
         import { type CommandData, type ContextMenuCommandProps, type CommandOptions } from "commandkit";
         import { ApplicationCommandType } from "discord.js";
 
@@ -153,24 +153,158 @@ Here's an example `content` command which replies with the content of the target
 
 </Tabs>
 
+## Autocomplete function
+
+In addition to the `run` function, you can also export an `autocomplete` function from your command file so that you don't have to create a new `"interactionCreate"` event listener.
+
+Here's an example of how to use the `autocomplete` function:
+
+<Tabs items={['CommonJS', 'ESM', 'TypeScript']}>
+    <Tabs.Tab>
+        ```js filename="commands/Fun/pet.js" copy
+        const pets = require('../data/pets.json');
+
+        module.exports = {
+            data: new SlashCommandBuilder()
+                .setName('pet')
+                .setDescription('Find a pet from a list of pets.')
+                .addStringOption((option) =>
+                    option
+                        .setName('pet')
+                        .setDescription('The pet to check.')
+                        .setRequired(true)
+                        .setAutocomplete(true)
+                ),
+
+            run: ({ interaction, client, handler }) => {
+                const targetPetId = interaction.options.getString('pet');
+                const targetPetObj = pets.find((pet) => pet.id === targetPetId);
+
+                interaction.reply(`Your pet name is ${targetPetObj.name}.`);
+            },
+
+            autocomplete: ({ interaction, client, handler }) => {
+                const focusedPetOption = interaction.options.getFocused(true);
+
+                const filteredChoices = pets.filter((pet) => pet.name.startsWith(focusedPetOption));
+
+                const results = filteredChoices.map((pet) => {
+                    return {
+                        name: `${pet.name} | ${pet.type}`,
+                        value: pet.id,
+                    };
+                });
+
+                interaction.respond(results.slice(0, 25));
+            }
+        }
+        ```
+    </Tabs.Tab>
+    <Tabs.Tab>
+        ```js filename="commands/Fun/pet.js" copy
+        import pets from '../data/pets.json';
+
+        export const data = new SlashCommandBuilder()
+            .setName('pet')
+            .setDescription('Find a pet from a list of pets.')
+            .addStringOption((option) =>
+                option
+                    .setName('pet')
+                    .setDescription('The pet to check.')
+                    .setRequired(true)
+                    .setAutocomplete(true)
+            );
+
+        export function run({ interaction, client, handler }) {
+            const targetPetId = interaction.options.getString('pet');
+            const targetPetObj = pets.find((pet) => pet.id === targetPetId);
+
+            interaction.reply(`Your pet name is ${targetPetObj.name}.`);
+        }
+
+        export function autocomplete({ interaction, client, handler }) {
+            const focusedPetOption = interaction.options.getFocused(true);
+
+            const filteredChoices = pets.filter((pet) => pet.name.startsWith(focusedPetOption));
+
+            const results = filteredChoices.map((pet) => {
+                return {
+                    name: `${pet.name} | ${pet.type}`,
+                    value: pet.id,
+                };
+            });
+
+            interaction.respond(results.slice(0, 25));
+        }
+        ```
+    </Tabs.Tab>
+    <Tabs.Tab>
+        ```ts filename="commands/Fun/pet.ts" copy
+        import type { CommandData, AutocompleteProps, CommandOptions } from 'commandkit';
+        import pets from '../data/pets.json';
+
+        export const data = new SlashCommandBuilder()
+            .setName('pet')
+            .setDescription('Find a pet from a list of pets.')
+            .addStringOption((option) =>
+                option
+                    .setName('pet')
+                    .setDescription('The pet to check.')
+                    .setRequired(true)
+                    .setAutocomplete(true)
+            );
+
+        export function run({ interaction, client, handler }: SlashCommandProps) {
+            const targetPetId = interaction.options.getString('pet');
+            const targetPetObj = pets.find((pet) => pet.id === targetPetId);
+
+            interaction.reply(`Your pet name is ${targetPetObj.name}.`);
+        }
+
+        export function autocomplete({ interaction, client, handler }: AutocompleteProps) {
+            const focusedPetOption = interaction.options.getFocused(true);
+
+            const filteredChoices = pets.filter((pet) => pet.name.startsWith(focusedPetOption));
+
+            const results = filteredChoices.map((pet) => {
+                return {
+                    name: `${pet.name} | ${pet.type}`,
+                    value: pet.id,
+                };
+            });
+
+            interaction.respond(results.slice(0, 25));
+        }
+        ```
+    </Tabs.Tab>
+
+</Tabs>
+
 ## Properties and Methods
 
 ### `data`
 
--   Type: [`CommandData`](/typedef/CommandData) | [`SlashCommandBuilder`](https://discord.js.org/docs/packages/builders/main/SlashCommandBuilder:Class) | [`ContextMenuCommandBuilder`](https://discord.js.org/docs/packages/builders/main/ContextMenuCommandBuilder:Class)
+-   Type: [`CommandData`](/docs/typedef/CommandData) | [`SlashCommandBuilder`](https://discord.js.org/docs/packages/builders/main/SlashCommandBuilder:Class) | [`ContextMenuCommandBuilder`](https://discord.js.org/docs/packages/builders/main/ContextMenuCommandBuilder:Class)
 
 This property contains the command's structural information, and is required to register and handle commands.
 
 ### `run`
 
 -   Type: `void`
 
--   Props Type: [`SlashCommandProps`](/typedef/SlashCommandProps) | [`ContextMenuCommandProps`](/typedef/ContextMenuCommandProps)
+-   Props Type: [`SlashCommandProps`](/docs/typedef/SlashCommandProps) | [`ContextMenuCommandProps`](/docs/typedef/ContextMenuCommandProps)
 
 This function will be called when the command is executed.
 
+### `autocomplete`
+
+-   Type: `void`
+-   Props Type: [`AutocompleteProps`](/docs/typedef/AutocompleteProps)
+
+This function will be called when an autocomplete interaction event is triggered for any option set as autocomplete in this command's `data` object.
+
 ### `options` (optional)
 
--   Type: [`CommandOptions`](/typedef/CommandOptions)
+-   Type: [`CommandOptions`](/docs/typedef/CommandOptions)
 
 This property contains the command's registration/handling behaviour.
diff --git a/apps/docs/pages/guide/commandkit-setup.mdx b/apps/docs/pages/guide/commandkit-setup.mdx
@@ -165,4 +165,4 @@ This is used to disable CommandKit's built-in validation functions. Setting this
 -   Type: `boolean`
 -   Default: `false`
 
-This is used to change the behaviour of how CommandKit loads application commands. By default it's one-by-one while comparing changes. Setting this option to `true` will load application commands all at once on every restart, and when [reloadCommands()](/typedef/CommandKit#reloadcommands) is called.
+This is used to change the behaviour of how CommandKit loads application commands. By default it's one-by-one while comparing changes. Setting this option to `true` will load application commands all at once on every restart, and when [`reloadCommands()`](/docs/typedef/CommandKit#reloadcommands) is called.
diff --git a/apps/docs/pages/guide/installation.mdx b/apps/docs/pages/guide/installation.mdx
@@ -3,10 +3,7 @@ import { Callout } from 'nextra/components';
 # Installation
 
 <div align="center" className="my-8">
-    <img
-        src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.svg"
-        width="60%"
-    />
+    <img src="/ckit_logo.svg" width="60%" />
     <br />
     <div className="flex items-center justify-center gap-2">
         <a href="https://ctrl.lol/discord">
diff --git a/apps/docs/pages/guide/validation-file-setup.mdx b/apps/docs/pages/guide/validation-file-setup.mdx
@@ -48,10 +48,10 @@ Validation functions are called on every command trigger, so it's important to k
 
     <Tabs.Tab label="TypeScript">
         ```ts filename="validations/cooldowns.ts" copy
-        import type { ValidationFunctionProps } from 'commandkit';
+        import type { ValidationProps } from 'commandkit';
         import cooldowns from '../cooldowns-cache';
 
-        export default function ({ interaction, commandObj, handler }: ValidationFunctionProps) {
+        export default function ({ interaction, commandObj, handler }: ValidationProps) {
             if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
                 interaction.reply({
                     content: "You're on cooldown, please wait some time before running this command again.",
diff --git a/apps/docs/pages/index.mdx b/apps/docs/pages/index.mdx
@@ -49,7 +49,7 @@ export default function Home() {
 
                     <div className="flex items-center justify-center gap-3 mt-10 md:justify-start text-neutral-100">
                         <Link href='/guide/installation' className="font-semibold bg-[#b079fc] py-2 px-4 rounded-full">Guide</Link>
-                        <Link href='/docs/typedef/CommandData' className="font-semibold bg-blue-500 py-2 px-4 rounded-full">Docs</Link>
+                        <Link href='/docs/typedef/AutocompleteProps' className="font-semibold bg-blue-500 py-2 px-4 rounded-full">Docs</Link>
                         <Link href='https://github.com/underctrl-io/commandkit' className="font-semibold bg-[#fc7993] py-2 px-4 rounded-full" target="_blank" rel="noopener noreferrer">GitHub</Link>
                     </div>
                 </div>
diff --git a/packages/commandkit/package.json b/packages/commandkit/package.json
@@ -1,7 +1,7 @@
 {
     "name": "commandkit",
     "description": "Beginner friendly command & event handler for Discord.js",
-    "version": "0.1.8",
+    "version": "0.1.9",
     "license": "MIT",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",
diff --git a/packages/commandkit/src/CommandKit.ts b/packages/commandkit/src/CommandKit.ts
@@ -111,7 +111,7 @@ export class CommandKit {
         }
 
         const commands = this.#data.commandHandler.commands.map((cmd) => {
-            const { run, ...command } = cmd;
+            const { run, autocomplete, ...command } = cmd;
             return command;
         });
 
diff --git a/packages/commandkit/src/handlers/command-handler/CommandHandler.ts b/packages/commandkit/src/handlers/command-handler/CommandHandler.ts
@@ -181,10 +181,10 @@ export class CommandHandler {
 
             if (!targetCommand) return;
 
-            const { data, options, run, autocompleteRun, ...rest } = targetCommand;
+            const { data, options, run, autocomplete, ...rest } = targetCommand;
 
             // Skip if autocomplete handler is not defined
-            if (isAutocomplete && !autocompleteRun) return;
+            if (isAutocomplete && !autocomplete) return;
 
             const commandObj = {
                 data: targetCommand.data,
@@ -238,7 +238,7 @@ export class CommandHandler {
                 handler: this.#data.commandkitInstance,
             };
 
-            await targetCommand[isAutocomplete ? 'autocompleteRun' : 'run']!(context);
+            await targetCommand[isAutocomplete ? 'autocomplete' : 'run']!(context);
         });
     }
 
diff --git a/packages/commandkit/src/types/index.ts b/packages/commandkit/src/types/index.ts
diff --git a/packages/commandkit/src/typings.ts b/packages/commandkit/src/typings.ts
diff --git a/packages/commandkit/tests/src/commands/misc/ping.ts b/packages/commandkit/tests/src/commands/misc/ping.ts
diff --git a/packages/commandkit/tests/src/validations/devOnly.ts b/packages/commandkit/tests/src/validations/devOnly.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`	`1`	`{`
`2`		`- "CommandType": "CommandType",`
`3`	`2`	`"ReloadType": "ReloadType"`
`4`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
	`2`	`+ "AutocompleteProps": "AutocompleteProps",`
`2`	`3`	`"CommandData": "CommandData",`
`3`	`4`	`"CommandKit": "CommandKit",`
`4`	`5`	`"CommandObject": "CommandObject",`