Finish Dev Mode and Deploy Scripts (#227)

Co-authored-by: Vlad Frangu <[email protected]>

Author: IanMitchell

.devcontainer/.gitkeep

@@ -39,7 +39,7 @@
 			"label": "interactionkit.dev"
 		}
 	},
-	"postCreateCommand": "npm install",
+	"postCreateCommand": "npm install && npm run build",
 	"features": {
 		"git": "latest",
 		"github-cli": "latest",

.devcontainer/devcontainer.json

@@ -4,7 +4,10 @@
 	"type": "module",
 	"scripts": {
 		"deploy": "ikit deploy",
-		"bot": "DEBUG=* ikit dev"
+		"bot": "DEBUG=* ikit dev",
+		"typecheck": "tsc --noEmit",
+		"prettier": "prettier src/**/*.ts --check",
+		"lint": "eslint ./src/**/*.ts"
 	},
 	"engines": {
 		"node": ">=18"

apps/flint/package.json

@@ -5,7 +5,7 @@ export default new SlashCommand({
 	description: "Get a pong back",
 	handler: async (interaction) => {
 		try {
-			await interaction.reply({ message: "pong reload", ephemeral: true });
+			await interaction.reply({ message: "pong", ephemeral: true });
 		} catch (err: unknown) {
 			console.error("Error!");
 		}

apps/flint/src/commands/ping.ts

@@ -9,14 +9,14 @@
 	"packageManager": "[email protected]",
 	"type": "module",
 	"scripts": {
-		"cli": "turbo run cli --filter=create-ikit-app",
-		"dev": "turbo run dev --no-cache --parallel --continue",
-		"bot": "turbo run bot --no-cache",
-		"clean": "turbo run clean",
-		"build": "turbo run build",
-		"typecheck": "turbo run typecheck",
-		"prettier": "turbo run prettier",
-		"lint": "turbo run lint",
+		"cli": "cross-env FORCE_COLOR=1 turbo run cli --filter=create-ikit-app",
+		"dev": "cross-env FORCE_COLOR=1 turbo run dev --no-cache --parallel --continue",
+		"bot": "cross-env FORCE_COLOR=1 turbo run bot --no-cache",
+		"clean": "cross-env FORCE_COLOR=1 turbo run clean",
+		"build": "cross-env FORCE_COLOR=1 turbo run build",
+		"typecheck": "cross-env FORCE_COLOR=1 turbo run typecheck",
+		"prettier": "cross-env FORCE_COLOR=1 turbo run prettier",
+		"lint": "cross-env FORCE_COLOR=1 turbo run lint",
 		"pretest": "npm run clean && npm run build",
 		"test": "vitest run",
 		"version": "npx changeset version",
@@ -36,6 +36,7 @@
 		"@types/node": "^18.7.7",
 		"@typescript-eslint/eslint-plugin": "^5.33.1",
 		"@typescript-eslint/parser": "^5.33.1",
+		"cross-env": "^7.0.3",
 		"eslint": "^8.22.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-config-xo": "^0.41.0",

package-lock.json

@@ -9,14 +9,9 @@ import type SlashCommand from "./commands/slash-command.js";
 import type { ExecutableComponent } from "./components/index.js";
 import { isExecutableComponent } from "./components/index.js";
 import Config from "./config.js";
-import type ApplicationCommandInteraction from "./interactions/application-commands/application-command-interaction.js";
 import * as Interaction from "./interactions/index.js";
-import type {
-	InteractionKitCommand,
-	MapValue,
-	SerializableComponent,
-} from "./interfaces.js";
-import { response, ResponseStatus } from "./requests/response.js";
+import type { MapValue, SerializableComponent } from "./interfaces.js";
+import { ResponseStatus, response } from "./requests/response.js";
 
 const log = debug("ikit:application");
 
@@ -40,12 +35,17 @@ type CommandMap = {
 
 type CommandMapValue<K extends keyof CommandMap> = MapValue<CommandMap[K]>;
 
+export type AllCommands =
+	| SlashCommand
+	| ContextMenu<ApplicationCommandType.User>
+	| ContextMenu<ApplicationCommandType.Message>;
+
 export default class Application {
 	#applicationId: Snowflake;
 	#publicKey: string;
 	#token: string;
 	#commands: CommandMap;
-	#components: Map<string, ExecutableComponent> = new Map();
+	#components = new Map<string, ExecutableComponent>();
 	#shutdown: AbortController;
 
 	constructor({ applicationId, publicKey, token }: ApplicationArgs) {
@@ -93,14 +93,14 @@ export default class Application {
 			.flat();
 	}
 
-	addCommand(command: InteractionKitCommand<ApplicationCommandInteraction>) {
+	addCommand(command: AllCommands) {
 		if (this.#commands[command.type]?.has(command.name.toLowerCase())) {
 			throw new Error(
 				`Error registering ${command.name.toLowerCase()}: Duplicate names are not allowed`
 			);
 		}
 
-		log(`Registering the ${command.name.toLowerCase()} command`);
+		log(`Adding the ${command.name.toLowerCase()} command`);
 
 		this.#commands[command.type].set(
 			command.name.toLowerCase(),
@@ -112,9 +112,7 @@ export default class Application {
 		return this;
 	}
 
-	addCommands(
-		...commands: Array<InteractionKitCommand<ApplicationCommandInteraction>>
-	) {
+	addCommands(...commands: AllCommands[]) {
 		commands.forEach((command) => this.addCommand(command));
 		return this;
 	}
@@ -185,7 +183,8 @@ export default class Application {
 					json,
 					(status: ResponseStatus, json: Record<string, any>) => {
 						resolve(response(status, json));
-					}
+					},
+					request
 				);
 			});
 		} catch (error: unknown) {

package.json

@@ -2,7 +2,12 @@ import arg from "arg";
 import boxen from "boxen";
 import chalk from "chalk";
 import debug from "debug";
-import { bulkOverwriteGuildApplicationCommands } from "discord-api";
+import {
+	bulkOverwriteGuildApplicationCommands,
+	client,
+	getGuildApplicationCommands,
+} from "discord-api";
+import type { RESTGetAPIApplicationGuildCommandsResult } from "discord-api-types/v10";
 import server from "discord-edge-runner";
 import type { Snowflake } from "discord-snowflake";
 import ngrok from "ngrok";
@@ -14,35 +19,53 @@ import {
 
 const log = debug("cli:dev");
 
-async function updateCommands(guildId: Snowflake) {
-	// Start application
-	const application = await getApplicationEntrypoint();
-
-	log("Checking for command updates in Development Server");
-	const devCommandChangeSet = await getGuildApplicationCommandChanges(
-		application,
-		guildId
-	);
-
-	log(
-		`${devCommandChangeSet.newCommands.size} new commands, ${devCommandChangeSet.updatedCommands.size} changed commands, ${devCommandChangeSet.deletedCommands.size} removed commands, and ${devCommandChangeSet.unchangedCommands.size} unchanged commands.`
-	);
-
-	const serializedCommands = application.commands.map((command) =>
-		command.serialize()
-	);
+const listFormatter = new Intl.ListFormat("en", {
+	style: "long",
+	type: "conjunction",
+});
 
+async function updateCommands(
+	guildId: Snowflake,
+	commands: RESTGetAPIApplicationGuildCommandsResult
+) {
 	try {
-		if (devCommandChangeSet.hasChanges) {
-			await bulkOverwriteGuildApplicationCommands(
+		// Start application
+		const application = await getApplicationEntrypoint();
+
+		log("Checking for command updates in Development Server");
+		const comparison = await getGuildApplicationCommandChanges(
+			application,
+			guildId,
+			commands
+		);
+
+		log(
+			listFormatter.format([
+				chalk.green(`${comparison.new.size} new commands`),
+				chalk.yellow(`${comparison.updated.size} updated commands`),
+				chalk.red(`${comparison.deleted.size} deleted commands`),
+				chalk.gray(`${comparison.unchanged.size} unchanged commands`),
+			])
+		);
+
+		if (comparison.changed) {
+			const serializedCommands = application.commands.map((command) =>
+				command.serialize()
+			);
+
+			const response = await bulkOverwriteGuildApplicationCommands(
 				application.id,
 				guildId,
 				serializedCommands
 			);
+
+			return response;
 		}
 	} catch (error: unknown) {
 		log((error as Error).message);
 	}
+
+	return commands;
 }
 
 export default async function dev(argv?: string[]) {
@@ -79,6 +102,7 @@ export default async function dev(argv?: string[]) {
 	}
 
 	const guildId = process.env.DEVELOPMENT_SERVER_ID as Snowflake;
+	client.setToken(process.env.TOKEN);
 
 	// Parse input args
 	const args = arg(
@@ -96,8 +120,14 @@ export default async function dev(argv?: string[]) {
 	const port = args["--port"] ?? 3000;
 	let entrypoint = args["--entrypoint"] ?? "";
 
+	let commands: RESTGetAPIApplicationGuildCommandsResult;
+
 	try {
 		entrypoint = await getEdgeEntrypoint(entrypoint);
+		commands = await getGuildApplicationCommands(
+			process.env.APPLICATION_ID as Snowflake,
+			guildId
+		);
 	} catch (error: unknown) {
 		log(chalk.red((error as Error).message));
 		process.exit(1);
@@ -117,7 +147,7 @@ export default async function dev(argv?: string[]) {
 			FORCE_COLOR: "1",
 		},
 		onReload: async () => {
-			await updateCommands(guildId);
+			commands = await updateCommands(guildId, commands);
 		},
 		onError: (error: unknown) => {
 			log(chalk.red({ error }));

packages/interaction-kit/src/application.ts

@@ -5,6 +5,7 @@ import type {
 	NumberOption,
 	StringOption,
 } from "../../commands/options/index.js";
+import type { Awaitable } from "../../interfaces.js";
 import type SlashCommandAutocompleteInteraction from "./application-command-autocomplete.js";
 
 // 🥺 selects when, discord?
@@ -20,5 +21,9 @@ export type SlashCommandAutocompleteType =
 	| NumberOption;
 
 export interface Autocomplete<T extends AutocompleteInteractionTypes> {
-	autocomplete?: (interaction: T, application: Application) => Promise<void>;
+	autocomplete?: (
+		interaction: T,
+		application: Application,
+		request: Request
+	) => Awaitable;
 }