commandkit 1.2.0-dev.20250819020008 → 1.2.0-dev.20250820015805

package/dist/{commandkit-5VMG2thU.js → commandkit-C0BuNRSN.js}

@@ -1723,6 +1723,7 @@ const defaultConfig = {
 	},
 	typedCommands: true,
 	disablePrefixCommands: false,
+	disablePermissionsMiddleware: false,
 	showUnknownPrefixCommandsWarning: true,
 	antiCrashScript: {
 		development: true,
@@ -1781,7 +1782,8 @@ function defineConfig(config = {}) {
 		antiCrashScript: {
 			...defaultConfig.antiCrashScript,
 			...config.antiCrashScript
-		}
+		},
+		disablePermissionsMiddleware: config.disablePermissionsMiddleware ?? defaultConfig.disablePermissionsMiddleware
 	};
 	return defined;
 }
@@ -2650,20 +2652,26 @@ var CommandRegistrar = class {
 		const commands = handler.getCommandsArray();
 		return commands.flatMap((cmd) => {
 			const json$1 = "toJSON" in cmd.data.command ? cmd.data.command.toJSON() : cmd.data.command;
-			const collections = [json$1];
+			const __metadata = cmd.metadata ?? cmd.data.metadata;
+			const collections = [{
+				...json$1,
+				__metadata
+			}];
 			if (cmd.data.userContextMenu && json$1.type !== discord_js.ApplicationCommandType.User) collections.push({
 				...json$1,
 				type: discord_js.ApplicationCommandType.User,
 				options: void 0,
 				description_localizations: void 0,
-				description: void 0
+				description: void 0,
+				__metadata
 			});
 			if (cmd.data.messageContextMenu && json$1.type !== discord_js.ApplicationCommandType.Message) collections.push({
 				...json$1,
 				type: discord_js.ApplicationCommandType.Message,
 				description_localizations: void 0,
 				description: void 0,
-				options: void 0
+				options: void 0,
+				__metadata
 			});
 			return collections;
 		});
@@ -2687,18 +2695,18 @@ var CommandRegistrar = class {
 		if (preRegistrationPrevented) return;
 		if (!this.commandkit.client.isReady()) throw new Error("Cannot register commands before the client is ready");
 		const guildCommands = commands.filter((command) => {
-			var _command$guilds;
-			return (_command$guilds = command.guilds) === null || _command$guilds === void 0 ? void 0 : _command$guilds.filter(Boolean).length;
+			var _command$__metadata;
+			return (_command$__metadata = command.__metadata) === null || _command$__metadata === void 0 || (_command$__metadata = _command$__metadata.guilds) === null || _command$__metadata === void 0 ? void 0 : _command$__metadata.filter(Boolean).length;
 		}).map((c) => {
-			var _c$guilds;
+			var _c$__metadata;
 			return {
 				...c,
-				guilds: Array.from(new Set((_c$guilds = c.guilds) === null || _c$guilds === void 0 ? void 0 : _c$guilds.filter(Boolean)))
+				guilds: Array.from(new Set((_c$__metadata = c.__metadata) === null || _c$__metadata === void 0 || (_c$__metadata = _c$__metadata.guilds) === null || _c$__metadata === void 0 ? void 0 : _c$__metadata.filter(Boolean)))
 			};
 		});
 		const globalCommands = commands.filter((command) => {
-			var _command$guilds2;
-			return !((_command$guilds2 = command.guilds) === null || _command$guilds2 === void 0 ? void 0 : _command$guilds2.filter(Boolean).length);
+			var _command$__metadata2;
+			return !((_command$__metadata2 = command.__metadata) === null || _command$__metadata2 === void 0 || (_command$__metadata2 = _command$__metadata2.guilds) === null || _command$__metadata2 === void 0 ? void 0 : _command$__metadata2.filter(Boolean).length);
 		});
 		await this.updateGlobalCommands(globalCommands);
 		await this.updateGuildCommands(guildCommands);
@@ -2722,7 +2730,7 @@ var CommandRegistrar = class {
 		try {
 			const data = await this.api.put(discord_js.Routes.applicationCommands(this.commandkit.client.user.id), { body: commands.map((c) => ({
 				...c,
-				guilds: void 0
+				__metadata: void 0
 			})) });
 			Logger.info(`✨ Refreshed ${data.length} global application (/) commands`);
 		} catch (e) {
@@ -2749,9 +2757,9 @@ var CommandRegistrar = class {
 		try {
 			const guildCommandsMap = /* @__PURE__ */ new Map();
 			commands.forEach((command) => {
-				var _command$guilds3;
-				if (!((_command$guilds3 = command.guilds) === null || _command$guilds3 === void 0 ? void 0 : _command$guilds3.length)) return;
-				command.guilds.forEach((guild) => {
+				var _command$__metadata3, _command$__metadata4;
+				if (!((_command$__metadata3 = command.__metadata) === null || _command$__metadata3 === void 0 || (_command$__metadata3 = _command$__metadata3.guilds) === null || _command$__metadata3 === void 0 ? void 0 : _command$__metadata3.length)) return;
+				(_command$__metadata4 = command.__metadata) === null || _command$__metadata4 === void 0 || (_command$__metadata4 = _command$__metadata4.guilds) === null || _command$__metadata4 === void 0 || _command$__metadata4.forEach((guild) => {
 					if (!guildCommandsMap.has(guild)) guildCommandsMap.set(guild, []);
 					guildCommandsMap.get(guild).push(command);
 				});
@@ -2773,7 +2781,7 @@ var CommandRegistrar = class {
 				if (prevented$1) continue;
 				const data = await this.api.put(discord_js.Routes.applicationGuildCommands(this.commandkit.client.user.id, guild), { body: guildCommands.map((b) => ({
 					...b,
-					guilds: void 0
+					__metadata: void 0
 				})) });
 				count += data.length;
 			}
@@ -2784,8 +2792,91 @@ var CommandRegistrar = class {
 	}
 };
 
+//#endregion
+//#region src/app/middlewares/permissions.ts
+const middlewareId = crypto.randomUUID();
+/**
+* @private
+* @ignore
+*/
+async function beforeExecute(ctx) {
+	var _interaction$channel, _message$channel, _message$member, _command$metadata, _interaction$guild, _message$guild, _command$metadata2;
+	if (getConfig().disablePermissionsMiddleware) return;
+	const { interaction, message, command } = ctx;
+	if (interaction && !interaction.isCommand()) return;
+	if (interaction && ((_interaction$channel = interaction.channel) === null || _interaction$channel === void 0 ? void 0 : _interaction$channel.isDMBased()) || message && ((_message$channel = message.channel) === null || _message$channel === void 0 ? void 0 : _message$channel.isDMBased())) {
+		const channel = (interaction === null || interaction === void 0 ? void 0 : interaction.channel) ?? (message === null || message === void 0 ? void 0 : message.channel);
+		const embed$1 = new discord_js.EmbedBuilder().setTitle(":x: Server-only command!").setDescription("This command can only be used in a server.").setColor("Red");
+		try {
+			if (channel === null || channel === void 0 ? void 0 : channel.isSendable()) if (interaction && interaction.isRepliable()) await interaction.reply({
+				embeds: [embed$1],
+				flags: discord_js.MessageFlags.Ephemeral
+			});
+			else await message.reply({ embeds: [embed$1] });
+		} catch (error) {
+			Logger.error(`Could not send 'Server-only command' DM to user ${(interaction === null || interaction === void 0 ? void 0 : interaction.user.id) ?? (message === null || message === void 0 ? void 0 : message.author.id)} for command ${command.command.name}.`, error);
+		}
+		return ctx.cancel();
+	}
+	const userPermissions = (interaction === null || interaction === void 0 ? void 0 : interaction.memberPermissions) ?? (message === null || message === void 0 || (_message$member = message.member) === null || _message$member === void 0 ? void 0 : _message$member.permissions);
+	let userPermissionsRequired = ((_command$metadata = command.metadata) === null || _command$metadata === void 0 ? void 0 : _command$metadata.userPermissions) ?? [];
+	let missingUserPermissions = [];
+	if (typeof userPermissionsRequired === "string") userPermissionsRequired = [userPermissionsRequired];
+	const botPermissions = (interaction === null || interaction === void 0 || (_interaction$guild = interaction.guild) === null || _interaction$guild === void 0 || (_interaction$guild = _interaction$guild.members.me) === null || _interaction$guild === void 0 ? void 0 : _interaction$guild.permissions) ?? (message === null || message === void 0 || (_message$guild = message.guild) === null || _message$guild === void 0 || (_message$guild = _message$guild.members.me) === null || _message$guild === void 0 ? void 0 : _message$guild.permissions);
+	let botPermissionsRequired = ((_command$metadata2 = command.metadata) === null || _command$metadata2 === void 0 ? void 0 : _command$metadata2.botPermissions) ?? [];
+	let missingBotPermissions = [];
+	if (typeof botPermissionsRequired === "string") botPermissionsRequired = [botPermissionsRequired];
+	if (!userPermissionsRequired.length && !botPermissionsRequired.length) return;
+	if (userPermissionsRequired.length) for (const permission of userPermissionsRequired) {
+		const hasPermission = userPermissions === null || userPermissions === void 0 ? void 0 : userPermissions.has(permission);
+		if (!hasPermission) missingUserPermissions.push(permission);
+	}
+	if (botPermissionsRequired.length) for (const permission of botPermissionsRequired) {
+		const hasPermission = botPermissions === null || botPermissions === void 0 ? void 0 : botPermissions.has(permission);
+		if (!hasPermission) missingBotPermissions.push(permission);
+	}
+	if (!missingUserPermissions.length && !missingBotPermissions.length) return;
+	const pattern = /([a-z])([A-Z])|([A-Z]+)([A-Z][a-z])/g;
+	missingUserPermissions = missingUserPermissions.map((str) => str.replace(pattern, "$1$3 $2$4"));
+	missingBotPermissions = missingBotPermissions.map((str) => str.replace(pattern, "$1$3 $2$4"));
+	let embedDescription = "";
+	const formatter = new Intl.ListFormat("en", {
+		style: "long",
+		type: "conjunction"
+	});
+	const getPermissionWord = (permissions) => permissions.length === 1 ? "permission" : "permissions";
+	if (missingUserPermissions.length) {
+		const formattedPermissions = missingUserPermissions.map((p) => `\`${p}\``);
+		const permissionsString = formatter.format(formattedPermissions);
+		embedDescription += `- You must have the ${permissionsString} ${getPermissionWord(missingUserPermissions)} to be able to run this command.\n`;
+	}
+	if (missingBotPermissions.length) {
+		const formattedPermissions = missingBotPermissions.map((p) => `\`${p}\``);
+		const permissionsString = formatter.format(formattedPermissions);
+		embedDescription += `- I must have the ${permissionsString} ${getPermissionWord(missingBotPermissions)} to be able to execute this command.\n`;
+	}
+	const embed = new discord_js.EmbedBuilder().setTitle(`:x: Missing permissions!`).setDescription(embedDescription).setColor("Red");
+	try {
+		var _message$channel2;
+		if (interaction && interaction.isRepliable()) await interaction.reply({
+			embeds: [embed],
+			flags: discord_js.MessageFlags.Ephemeral
+		});
+		else if (message && ((_message$channel2 = message.channel) === null || _message$channel2 === void 0 ? void 0 : _message$channel2.isSendable())) await message.reply({ embeds: [embed] });
+	} catch (error) {
+		Logger.error(`Could not send 'Not enough permissions' reply to user ${(interaction === null || interaction === void 0 ? void 0 : interaction.user.id) ?? (message === null || message === void 0 ? void 0 : message.author.id)} for command ${command.command.name}.`, error);
+	}
+	return ctx.cancel();
+}
+
 //#endregion
 //#region src/app/handlers/AppCommandHandler.ts
+const KNOWN_NON_HANDLER_KEYS = [
+	"command",
+	"generateMetadata",
+	"metadata",
+	"aiConfig"
+];
 /**
 * @private
 * @internal
@@ -2975,7 +3066,7 @@ var AppCommandHandler = class {
 	* @returns Prepared command execution data or null if command not found
 	*/
 	async prepareCommandRun(source, cmdName) {
-		var _loadedCommand$guilds2;
+		var _loadedCommand$metada3, _loadedCommand$metada4;
 		const config = getConfig();
 		if (config.disablePrefixCommands && source instanceof discord_js.Message) return null;
 		let parser;
@@ -2984,13 +3075,13 @@ var AppCommandHandler = class {
 			const prefix = await this.commandkit.appConfig.getMessageCommandPrefix(source);
 			if (!prefix || !prefix.length) return null;
 			parser = new require_MessageCommandParser.MessageCommandParser(source, Array.isArray(prefix) ? prefix : [prefix], (command) => {
-				var _loadedCommand$guilds, _json$options;
+				var _loadedCommand$metada, _loadedCommand$metada2, _json$options;
 				const loadedCommand$1 = this.findCommandByName(command);
 				if (!loadedCommand$1) {
 					if (require_constants.COMMANDKIT_IS_DEV && this.commandkit.config.showUnknownPrefixCommandsWarning) Logger.error(`Prefix command "${command}" was not found.\nNote: This warning is only shown in development mode as an alert to help you find the command. If you wish to remove this warning, set \`showUnknownPrefixCommandsWarning\` to \`false\` in your commandkit config.`);
 					return null;
 				}
-				if (source.guildId && ((_loadedCommand$guilds = loadedCommand$1.guilds) === null || _loadedCommand$guilds === void 0 ? void 0 : _loadedCommand$guilds.length) && !loadedCommand$1.guilds.includes(source.guildId)) return null;
+				if (source.guildId && ((_loadedCommand$metada = loadedCommand$1.metadata) === null || _loadedCommand$metada === void 0 || (_loadedCommand$metada = _loadedCommand$metada.guilds) === null || _loadedCommand$metada === void 0 ? void 0 : _loadedCommand$metada.length) && !((_loadedCommand$metada2 = loadedCommand$1.metadata) === null || _loadedCommand$metada2 === void 0 ? void 0 : _loadedCommand$metada2.guilds.includes(source.guildId))) return null;
 				const json$1 = "toJSON" in loadedCommand$1.data.command ? loadedCommand$1.data.command.toJSON() : loadedCommand$1.data.command;
 				return ((_json$options = json$1.options) === null || _json$options === void 0 ? void 0 : _json$options.reduce((acc, opt) => {
 					acc[opt.name] = opt.type;
@@ -3013,12 +3104,24 @@ var AppCommandHandler = class {
 		}
 		const loadedCommand = this.findCommandByName(cmdName);
 		if (!loadedCommand) return null;
-		if ((source instanceof discord_js.CommandInteraction || source instanceof discord_js.AutocompleteInteraction) && source.guildId && ((_loadedCommand$guilds2 = loadedCommand.guilds) === null || _loadedCommand$guilds2 === void 0 ? void 0 : _loadedCommand$guilds2.length) && !loadedCommand.guilds.includes(source.guildId)) return null;
+		if ((source instanceof discord_js.CommandInteraction || source instanceof discord_js.AutocompleteInteraction) && source.guildId && ((_loadedCommand$metada3 = loadedCommand.metadata) === null || _loadedCommand$metada3 === void 0 || (_loadedCommand$metada3 = _loadedCommand$metada3.guilds) === null || _loadedCommand$metada3 === void 0 ? void 0 : _loadedCommand$metada3.length) && !((_loadedCommand$metada4 = loadedCommand.metadata) === null || _loadedCommand$metada4 === void 0 ? void 0 : _loadedCommand$metada4.guilds.includes(source.guildId))) return null;
 		const middlewares = [];
-		for (const middlewareId of loadedCommand.command.middlewares) {
-			const middleware = this.loadedMiddlewares.get(middlewareId);
+		for (const middlewareId$1 of loadedCommand.command.middlewares) {
+			const middleware = this.loadedMiddlewares.get(middlewareId$1);
 			if (middleware) middlewares.push(middleware);
 		}
+		if (!getConfig().disablePermissionsMiddleware) middlewares.push({
+			data: { beforeExecute },
+			middleware: {
+				command: null,
+				global: true,
+				id: middlewareId,
+				name: "permissions",
+				parentPath: "",
+				path: "",
+				relativePath: ""
+			}
+		});
 		return {
 			command: loadedCommand,
 			middlewares,
@@ -3032,8 +3135,9 @@ var AppCommandHandler = class {
 	*/
 	findCommandByName(name) {
 		for (const [, loadedCommand] of this.loadedCommands) {
+			var _loadedCommand$data$m;
 			if (loadedCommand.data.command.name === name) return loadedCommand;
-			const aliases = loadedCommand.data.command.aliases;
+			const aliases = (_loadedCommand$data$m = loadedCommand.data.metadata) === null || _loadedCommand$data$m === void 0 ? void 0 : _loadedCommand$data$m.aliases;
 			if (aliases && Array.isArray(aliases) && aliases.includes(name)) return loadedCommand;
 		}
 		return null;
@@ -3098,7 +3202,7 @@ var AppCommandHandler = class {
 		for (const [id, command] of combinedCommands) await this.loadCommand(id, command);
 		if (require_constants.COMMANDKIT_IS_DEV) {
 			const commandNames = Array.from(this.loadedCommands.values()).map((v) => v.data.command.name);
-			const aliases = Array.from(this.loadedCommands.values()).flatMap((v) => v.data.command.aliases || []);
+			const aliases = Array.from(this.loadedCommands.values()).flatMap((v) => v.metadata.aliases || []);
 			const allNames = [...commandNames, ...aliases];
 			await require_types_package.rewriteCommandDeclaration(`type CommandTypeData = ${allNames.map((name) => JSON.stringify(name)).join(" | ")}`);
 		}
@@ -3136,6 +3240,12 @@ var AppCommandHandler = class {
 			if (command.path === null) {
 				this.loadedCommands.set(id, {
 					command,
+					metadata: {
+						guilds: [],
+						aliases: [],
+						userPermissions: [],
+						botPermissions: []
+					},
 					data: { command: {
 						name: command.name,
 						description: `${command.name} command`,
@@ -3146,20 +3256,28 @@ var AppCommandHandler = class {
 			}
 			const commandFileData = await import(`${require_resolve_file_url.toFileURL(command.path)}?t=${Date.now()}`);
 			if (!commandFileData.command) throw new Error(`Invalid export for command ${command.name}: no command definition found`);
+			const metadataFunc = commandFileData.generateMetadata;
+			const metadataObj = commandFileData.metadata;
+			if (metadataFunc && metadataObj) throw new Error("A command may only export either `generateMetadata` or `metadata`, not both");
+			const metadata = (metadataFunc ? await metadataFunc() : metadataObj) ?? {
+				aliases: [],
+				guilds: [],
+				userPermissions: [],
+				botPermissions: []
+			};
 			const commandName = commandFileData.command.name || command.name;
 			const commandDescription = commandFileData.command.description || `${commandName} command`;
 			const updatedCommandData = {
 				...commandFileData.command,
 				name: commandName,
-				description: commandDescription,
-				aliases: commandFileData.command.aliases
+				description: commandDescription
 			};
 			let handlerCount = 0;
 			for (const [key, propValidator] of Object.entries(commandDataSchema)) {
 				const exportedProp = commandFileData[key];
 				if (exportedProp) {
 					if (!await propValidator(exportedProp)) throw new Error(`Invalid export for command ${command.name}: ${key} does not match expected value`);
-					if (key !== "command") handlerCount++;
+					if (!KNOWN_NON_HANDLER_KEYS.includes(key)) handlerCount++;
 				}
 			}
 			if (handlerCount === 0) throw new Error(`Invalid export for command ${command.name}: at least one handler function must be provided`);
@@ -3168,18 +3286,44 @@ var AppCommandHandler = class {
 				const res = await plugin.prepareCommand(ctx, lastUpdated);
 				if (res) lastUpdated = res;
 			});
+			const commandJson = "toJSON" in lastUpdated && typeof lastUpdated.toJSON === "function" ? lastUpdated.toJSON() : lastUpdated;
+			if ("guilds" in commandJson || "aliases" in commandJson) Logger.warn(`Command \`${command.name}\` uses deprecated metadata properties. Please update to use the new \`metadata\` object or \`generateMetadata\` function.`);
 			this.loadedCommands.set(id, {
 				command,
-				guilds: commandFileData.command.guilds,
+				metadata: {
+					guilds: commandJson.guilds,
+					aliases: commandJson.aliases,
+					...metadata
+				},
 				data: {
 					...commandFileData,
-					command: "toJSON" in lastUpdated && typeof lastUpdated.toJSON === "function" ? lastUpdated.toJSON() : lastUpdated
+					metadata: {
+						guilds: commandJson.guilds,
+						aliases: commandJson.aliases,
+						...metadata
+					},
+					command: commandJson
 				}
 			});
 		} catch (error) {
 			Logger.error(`Failed to load command ${command.name} (${id})`, error);
 		}
 	}
+	/**
+	* Gets the metadata for a command.
+	* @param command - The command name to get metadata for
+	* @returns The command metadata or null if not found
+	*/
+	getMetadataFor(command) {
+		const loadedCommand = this.findCommandByName(command);
+		if (!loadedCommand) return null;
+		return loadedCommand.metadata ??= {
+			aliases: [],
+			guilds: [],
+			userPermissions: [],
+			botPermissions: []
+		};
+	}
 };
 
 //#endregion
@@ -4150,6 +4294,12 @@ Object.defineProperty(exports, 'after', {
     return after;
   }
 });
+Object.defineProperty(exports, 'beforeExecute', {
+  enumerable: true,
+  get: function () {
+    return beforeExecute;
+  }
+});
 Object.defineProperty(exports, 'cancelAfter', {
   enumerable: true,
   get: function () {
@@ -4276,6 +4426,12 @@ Object.defineProperty(exports, 'makeContextAwareFunction', {
     return makeContextAwareFunction;
   }
 });
+Object.defineProperty(exports, 'middlewareId', {
+  enumerable: true,
+  get: function () {
+    return middlewareId;
+  }
+});
 Object.defineProperty(exports, 'noAnalytics', {
   enumerable: true,
   get: function () {
@@ -4312,4 +4468,4 @@ Object.defineProperty(exports, 'useEnvironment', {
     return useEnvironment;
   }
 });
-//# sourceMappingURL=commandkit-5VMG2thU.js.map
+//# sourceMappingURL=commandkit-C0BuNRSN.js.map