feat: allow bot to check own perms in commands (#55)

* feat: allow bot to check own perms in commands edited current perm check plugin. original credits exist. * refactor: made requested changes to feat pr. * fixed bad import in example * refactor: possibly fixed errors * refactor: removed unnecessary console.log() * Update myPermCheck.ts * refactor: final changes to feature * Rename myPermCheck.ts to requirePermission.ts * Update optional response wording Co-authored-by: Evo <85353424+EvolutionX-10@users.noreply.github.com> Co-authored-by: Evo <85353424+EvolutionX-10@users.noreply.github.com>
2026-06-06 01:16:51 +00:00 · 2022-12-04 20:04:54 -06:00
parent 7d672d0380
commit 7bf80d114d
1 changed files with 81 additions and 0 deletions
--- a/TypeScript/requirePermission.ts
+++ b/TypeScript/requirePermission.ts
@@ -0,0 +1,81 @@
+/**
+ * This is perm check, it allows users to parse the permission you want and let the plugin do the rest. (check bot or user for that perm).
+ *
+ * @author @Benzo-Fury [<@762918086349029386>]
+ * @author @needhamgary [<@342314924804014081>]
+ * @version 1.1.0
+ * @example
+ * ```ts
+ * import { requirePermission } from "../plugins/myPermCheck";
+ * import { commandModule, CommandType } from "@sern/handler";
+ * export default commandModule({
+ *  plugins: [ requirePermission<CommandType>('target', 'permission', 'No response (optional)') ],
+ *  execute: (ctx) => {
+ * 		//your code here
+ *  }
+ * })
+ * ```
+ */
+
+import type { GuildMember, PermissionResolvable } from "discord.js";
+import {
+	CommandType,
+	Controller,
+	EventPlugin,
+	PluginType
+} from "@sern/handler";
+
+function payload(resp?: string) {
+	return { fetchReply: true, content: resp } as const;
+}
+
+export function requirePermission<T extends CommandType>(
+	target: "user" | "bot",
+	perm: PermissionResolvable,
+	response?: string
+): EventPlugin<T> {
+	return {
+		type: PluginType.Event,
+		description: "Checks bot/user perms",
+		async execute(event, controller: Controller) {
+			const [ctx] = event;
+			if (ctx.guild === null) {
+				ctx.reply(payload("This command cannot be used here"));
+				console.warn(
+					"PermCheck > A command stopped because we couldn't check a users permissions (was used in dms)"
+				); //delete this line if you dont want to be notified when a command is used outside of a guild/server
+				return controller.stop();
+			}
+			switch (target) {
+				case "bot":
+					if (
+						!(
+							(await ctx.guild.members.fetchMe({
+								cache: false
+							})!) as GuildMember
+						).permissions.has(perm)
+					) {
+						if (!response)
+							response = `I cannot use this command, please give me \`${perm}\` permission.`;
+						await ctx.reply(payload(response));
+						return controller.stop();
+					}
+					return controller.next();
+				case "user":
+					if (!(ctx.member! as GuildMember).permissions.has(perm)) {
+						if (!response)
+							response = `You cannot use this command because you are missing \`${perm}\` permission.`;
+						await ctx.reply(payload(response));
+						return controller.stop();
+					}
+					return controller.next();
+				default:
+					console.warn(
+						"Perm Check >>> You didn't specify user or bot."
+					);
+					ctx.reply(payload("User or Bot was not specified."));
+					return controller.stop();
+			}
+		}
+	};
+}