@sapphire/cli 1.5.1-next.5c0f4fc.0 → 1.6.0-next.52e7dec.0

package/dist/commands/generate.js

@@ -25,15 +25,34 @@ async function createComponent(component, name, config, configLoc) {
     else if (await fileExists(corePath)) {
         return CreateFileFromTemplate(`components/${template}`, target, config, params, false, true);
     }
-    throw new Error("Can't find the template.");
+    throw new Error(`Couldn't find a template file for that component type.${parseCommonHints(component)}`);
 }
 async function fetchConfig() {
-    const a = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
-    if (a) {
-        return a;
+    const configFileAsJson = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
+    if (configFileAsJson) {
+        return configFileAsJson;
     }
     return Promise.race([findUp('.sapphirerc.yml', { cwd: '.' }), sleep(5000)]);
 }
+/**
+ * Parses common hints for the user
+ * @param component Component name
+ * @returns A string with a hint for the user
+ */
+function parseCommonHints(component) {
+    const newLine = '\n';
+    const lowerCaseComponent = component.toLowerCase();
+    if (lowerCaseComponent === 'command' || lowerCaseComponent === 'commands') {
+        return `${newLine}Hint: You wrote "${component}", instead of "messagecommand", "slashcommand", or "contextmenucommand"`;
+    }
+    if (lowerCaseComponent === 'interaction-handler' ||
+        lowerCaseComponent === 'interaction-handlers' ||
+        lowerCaseComponent === 'interactionhandler' ||
+        lowerCaseComponent === 'interactionhandlers') {
+        return `${newLine}Hint: You wrote "${component}", instead of "buttoninteractionhandler", "autocompleteinteractionhandler", "modalinteractionhandler", or "selectmenuinteractionhandler"`;
+    }
+    return '';
+}
 export default async (component, name) => {
     const spinner = new Spinner(`Creating a ${component.toLowerCase()}`).start();
     const fail = (error, additionalExecution) => {

package/dist/commands/init.js

@@ -20,7 +20,8 @@ export default async () => {
             arguments: response.arguments,
             commands: response.commands,
             listeners: response.listeners,
-            preconditions: response.preconditions
+            preconditions: response.preconditions,
+            'interaction-handlers': response['interaction-handlers']
         },
         customFileTemplates: {
             enabled: response.cftEnabled,

package/dist/commands/new.js

@@ -45,11 +45,15 @@ async function configureYarnRc(location, name, value) {
     return true;
 }
 async function installYarnV3(location, verbose) {
-    const value = await execa('yarn', ['set', 'version', 'berry'], {
+    const valueSetVersion = await execa('yarn', ['set', 'version', 'berry'], {
         stdio: verbose ? 'inherit' : undefined,
         cwd: `./${location}/`
     });
-    if (value.exitCode !== 0) {
+    const valueInstallPlugins = await execa('yarn', ['plugin', 'import', 'interactive-tools'], {
+        stdio: verbose ? 'inherit' : undefined,
+        cwd: `./${location}/`
+    });
+    if (valueSetVersion.exitCode !== 0 || valueInstallPlugins.exitCode !== 0) {
         throw new Error('An unknown error occurred while installing Yarn v3. Try running Sapphire CLI with "--verbose" flag.');
     }
     await Promise.all([

package/dist/functions/CreateFileFromTemplate.js

@@ -6,35 +6,45 @@ export async function CreateFileFromTemplate(template, target, config, params, c
     const location = custom ? template : `${templatesFolder}${template}`;
     const output = {};
     if (component) {
-        const [c, f] = await getComponentTemplateWithConfig(location);
-        output.c = c;
-        output.f = f;
+        const [config, templateContent] = await getComponentTemplateWithConfig(location);
+        output.config = config;
+        output.templateContent = templateContent;
     }
-    output.f ??= await readFile(location, 'utf8');
-    if (!output.f) {
-        throw new Error("Can't read file.");
+    output.templateContent ??= await readFile(location, 'utf8');
+    if (!output.templateContent) {
+        throw new Error("Couldn't read the template file. Are you sure it exists, the name is correct, and the content is valid?");
     }
     if (params) {
         for (const param of Object.entries(params)) {
-            output.f = output.f.replaceAll(`{{${param[0]}}}`, param[1]);
+            output.templateContent = output.templateContent.replaceAll(`{{${param[0]}}}`, param[1]);
         }
     }
-    if (!output || (component && (!output.c || !output.c.category))) {
-        throw new Error('Invalid template.');
+    if (!output || (component && (!output.config || !output.config.category))) {
+        throw new Error('The template is invalid. Please create a valid template structure.');
     }
-    const dir = component ? config.locations[output.c.category] : null;
-    const ta = component ? target.replace('%L%', dir) : target;
-    if (await fileExists(ta)) {
-        throw new Error('Component already exists');
+    const directoryForOutput = component ? config?.locations[output.config.category] : null;
+    const targetPath = component ? target.replace('%L%', directoryForOutput) : target;
+    if (await fileExists(targetPath)) {
+        throw new Error('A component with the provided name already exists. Please provide a unique name.');
     }
-    await writeFileRecursive(ta, output.f);
+    await writeFileRecursive(targetPath, output.templateContent);
     return true;
 }
+/**
+ * Gets the template and the config from a component template
+ * @param path Path to the template
+ * @returns [config, template] The config and the template
+ */
 async function getComponentTemplateWithConfig(path) {
     const file = await readFile(path, 'utf8');
     const fa = file.split(/---(\r\n|\r|\n|)/gm);
     return [JSON.parse(fa[0]), fa[2]];
 }
+/**
+ * Writes a file recursively
+ * @param target Target path
+ * @param data Data to write
+ */
 async function writeFileRecursive(target, data) {
     const resolvedTarget = resolve(target);
     const dir = dirname(resolvedTarget);

package/dist/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/prompts/PromptInit.js

@@ -47,6 +47,12 @@ export const PromptInit = [
         message: 'Where do you store your preconditions? (do not include the base)',
         initial: 'preconditions'
     },
+    {
+        type: 'text',
+        name: 'interaction-handlers',
+        message: 'Where do you store your interaction handlers? (do not include the base)',
+        initial: 'interaction-handlers'
+    },
     {
         type: 'confirm',
         name: 'cftEnabled',

package/dist/prompts/PromptNew.js

@@ -63,7 +63,8 @@ export const PromptNew = (projectName, yarn, pnpm) => {
         {
             type: (prev) => (prev === 'Yarn' ? 'confirm' : false),
             name: 'yarnV3',
-            message: 'Do you want to use Yarn v3?'
+            message: 'Do you want to use Yarn v3?',
+            initial: true
         },
         {
             type: 'confirm',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/cli",
-  "version": "1.5.1-next.5c0f4fc.0",
+  "version": "1.6.0-next.52e7dec.0",
   "description": "CLI for Sapphire Framework",
   "author": "@sapphire",
   "license": "MIT",
@@ -48,7 +48,10 @@
     "@commitlint/config-conventional": "^17.4.4",
     "@favware/cliff-jumper": "^2.0.0",
     "@favware/npm-deprecate": "^1.0.7",
+    "@sapphire/decorators": "*",
     "@sapphire/eslint-config": "^4.4.0",
+    "@sapphire/framework": "*",
+    "@sapphire/plugin-api": "*",
     "@sapphire/prettier-config": "^1.4.5",
     "@sapphire/ts-config": "^4.0.0",
     "@types/js-yaml": "^4.0.5",
@@ -57,10 +60,11 @@
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
     "cz-conventional-changelog": "^3.3.0",
+    "discord.js": "*",
     "eslint": "^8.38.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "globby": "^13.1.3",
+    "globby": "^13.1.4",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.1",
     "pinst": "^3.0.0",

package/templates/.sapphirerc.json.sapphire

@@ -5,8 +5,9 @@
 		"arguments": "arguments",
 		"commands": "commands",
 		"listeners": "listeners",
-		"preconditions": "preconditions"
-		"routes": "routes",
+		"preconditions": "preconditions",
+		"interaction-handlers": "interaction-handlers",
+		"routes": "routes"
 	},
 	"customFileTemplates": {
 		"enabled": false,

package/templates/.sapphirerc.yml.sapphire

@@ -5,6 +5,7 @@ locations:
   commands: commands
   listeners: listeners
   preconditions: preconditions
+  interaction-handlers: interaction-handlers
   routes: routes
 customFileTemplates:
   enabled: false

package/templates/components/argument.ts.sapphire

@@ -1,11 +1,11 @@
 { "category": "arguments" }
 ---
 import { ApplyOptions } from '@sapphire/decorators';
-import { Argument, ArgumentOptions } from '@sapphire/framework';
+import { Argument } from '@sapphire/framework';
 
-@ApplyOptions<ArgumentOptions>({})
+@ApplyOptions<Argument.Options>({})
 export class UserArgument extends Argument<string> {
-	async run(parameter: string) {
+	public override run(parameter: string) {
 		return this.ok(parameter);
 	}
 }

package/templates/components/autocompleteinteractionhandler.js.sapphire

@@ -0,0 +1,50 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class AutocompleteHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.Autocomplete
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').AutocompleteInteraction} interaction
+	 * @param {import('discord.js').ApplicationCommandOptionChoiceData[]} result
+	 */
+	async run(interaction, result) {
+		return interaction.respond(result);
+	}
+
+	/**
+	 * @param {import('discord.js').AutocompleteInteraction} interaction
+	 */
+	async parse(interaction) {
+		// Only run this interaction for the command with ID '1000000000000000000'
+		if (interaction.commandId !== '1000000000000000000') return this.none();
+		// Get the focussed (current) option
+		const focusedOption = interaction.options.getFocused(true);
+		// Ensure that the option name is one that can be autocompleted, or return none if not.
+		switch (focusedOption.name) {
+			case 'search': {
+				// Search your API or similar. This is example code!
+				const searchResult = await myApi.searchForSomething(focusedOption.value);
+				// Map the search results to the structure required for Autocomplete
+				return this.some(searchResult.map((match) => ({ name: match.name, value: match.key })));
+			}
+			default:
+				return this.none();
+		}
+	}
+}
+
+module.exports = {
+	AutocompleteHandler
+};

package/templates/components/autocompleteinteractionhandler.ts.sapphire

@@ -0,0 +1,32 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import { AutocompleteInteraction, type ApplicationCommandOptionChoiceData } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.Autocomplete
+})
+export class AutocompleteHandler extends InteractionHandler {
+	public override async run(interaction: AutocompleteInteraction, result: ApplicationCommandOptionChoiceData[]) {
+		return interaction.respond(result);
+	}
+
+	public override async parse(interaction: AutocompleteInteraction) {
+		// Only run this interaction for the command with ID '1000000000000000000'
+		if (interaction.commandId !== '1000000000000000000') return this.none();
+		// Get the focussed (current) option
+		const focusedOption = interaction.options.getFocused(true);
+		// Ensure that the option name is one that can be autocompleted, or return none if not.
+		switch (focusedOption.name) {
+			case 'search': {
+				// Search your API or similar. This is example code!
+				const searchResult = await myApi.searchForSomething(focusedOption.value);
+				// Map the search results to the structure required for Autocomplete
+				return this.some(searchResult.map((match) => ({ name: match.name, value: match.key })));
+			}
+			default:
+				return this.none();
+		}
+	}
+}

package/templates/components/buttoninteractionhandler.js.sapphire

@@ -0,0 +1,39 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class ButtonHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.Button
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').ButtonInteraction} interaction
+	 */
+	async run(interaction) {
+		await interaction.reply({
+			content: 'Hello from a button interaction handler!',
+			// Let's make it so only the person who pressed the button can see this message!
+			ephemeral: true
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').ButtonInteraction} interaction
+	 */
+	parse(interaction) {
+		if (interaction.customId !== 'my-awesome-button') return this.none();
+		return this.some();
+	}
+}
+
+module.exports = {
+	ButtonHandler
+};

package/templates/components/buttoninteractionhandler.ts.sapphire

@@ -0,0 +1,24 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import type { ButtonInteraction } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.Button
+})
+export class ButtonHandler extends InteractionHandler {
+	public async run(interaction: ButtonInteraction) {
+		await interaction.reply({
+			content: 'Hello from a button interaction handler!',
+			// Let's make it so only the person who pressed the button can see this message!
+			ephemeral: true
+		});
+	}
+
+	public override parse(interaction: ButtonInteraction) {
+		if (interaction.customId !== 'my-awesome-button') return this.none();
+
+		return this.some();
+	}
+}

package/templates/components/contextmenucommand.ts.sapphire

@@ -16,7 +16,7 @@ export class UserCommand extends Command {
 		);
 	}
 
-	public async contextMenuRun(interaction: Command.ContextMenuCommandInteraction) {
+	public override async contextMenuRun(interaction: Command.ContextMenuCommandInteraction) {
 		return interaction.reply({ content: 'Hello world!' });
 	}
 }

package/templates/components/listener.ts.sapphire

@@ -1,9 +1,9 @@
 { "category": "listeners" }
 ---
 import { ApplyOptions } from '@sapphire/decorators';
-import { Listener, ListenerOptions } from '@sapphire/framework';
+import { Listener } from '@sapphire/framework';
 
-@ApplyOptions<ListenerOptions>({})
+@ApplyOptions<Listener.Options>({})
 export class UserEvent extends Listener {
-	public run() {}
+	public override run() {}
 }

package/templates/components/messagecommand.ts.sapphire

@@ -8,7 +8,7 @@ import type { Message } from 'discord.js';
 	description: 'A basic command'
 })
 export class UserCommand extends Command {
-	public async messageRun(message: Message) {
+	public override async messageRun(message: Message) {
 		return message.channel.send('Hello world!');
 	}
 }

package/templates/components/modalinteractionhandler.js.sapphire

@@ -0,0 +1,39 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class ModalHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.ModalSubmit
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').ModalSubmitInteraction} interaction
+	 */
+	async run(interaction) {
+		await interaction.reply({
+			content: 'Thank you for submitting the form!',
+			ephemeral: true
+		});
+	  }
+
+	/**
+	 * @param {import('discord.js').ModalSubmitInteraction} interaction
+	 */
+	parse(interaction) {
+		if (interaction.customId !== 'hello-popup') return this.none();
+	
+		return this.some();
+	}
+}
+
+module.exports = {
+	ModalHandler
+};

package/templates/components/modalinteractionhandler.ts.sapphire

@@ -0,0 +1,23 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import type { ModalSubmitInteraction } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.ModalSubmit
+})
+export class ModalHandler extends InteractionHandler {
+	public async run(interaction: ModalSubmitInteraction) {
+		await interaction.reply({
+			content: 'Thank you for submitting the form!',
+			ephemeral: true
+		});
+	}
+
+	public override parse(interaction: ModalSubmitInteraction) {
+		if (interaction.customId !== 'hello-popup') return this.none();
+	
+		return this.some();
+	}
+}

package/templates/components/route.js.sapphire

@@ -1,6 +1,7 @@
 { "category": "routes" }
 ---
 const { methods, Route } = require('@sapphire/plugin-api');
+
 class UserRoute extends Route {
 	/**
 	 * @param {Route.Context} context

package/templates/components/selectmenuinteractionhandler.js.sapphire

@@ -0,0 +1,39 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class MenuHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.SelectMenu
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').StringSelectMenuInteraction} interaction
+	 */
+	async run(interaction) {
+		await interaction.reply({
+			// Remember how we can have multiple values? Let's get the first one!
+			content: `You selected: ${interaction.values[0]}`
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').StringSelectMenuInteraction} interaction
+	 */
+	parse(interaction) {
+		if (interaction.customId !== 'my-echo-select') return this.none();
+
+    	return this.some();
+	}
+}
+
+module.exports = {
+	MenuHandler
+};

package/templates/components/selectmenuinteractionhandler.ts.sapphire

@@ -0,0 +1,23 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import type { StringSelectMenuInteraction } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.SelectMenu
+})
+export class MenuHandler extends InteractionHandler {
+	public override async run(interaction: StringSelectMenuInteraction) {
+		await interaction.reply({
+			// Remember how we can have multiple values? Let's get the first one!
+			content: `You selected: ${interaction.values[0]}`
+		});
+	}
+
+	public override parse(interaction: StringSelectMenuInteraction) {
+		if (interaction.customId !== 'my-echo-select') return this.none();
+
+		return this.some();
+	}
+}

package/templates/schemas/.sapphirerc.scheme.json

@@ -27,11 +27,14 @@
 				"preconditions": {
 					"type": "string"
 				},
+				"interaction-handlers": {
+					"type": "string"
+				},
 				"routes": {
 					"type": "string"
 				}
 			},
-			"required": ["base", "arguments", "commands", "listeners", "preconditions"]
+			"required": ["base", "arguments", "commands", "listeners", "preconditions", "interaction-handlers"]
 		},
 		"customFileTemplates": {
 			"description": "Settings about custom component (piece) templates",