awesome-plugins/TypeScript/requirePermission.ts

// @ts-nocheck
/**
 * 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.2.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, CommandControlPlugin, controller,
} from "@sern/handler";

function payload(resp?: string) {
	return {
		fetchReply: true,
		content: resp,
		allowedMentions: { repliedUser: false },
	} as const;
}

export function requirePermission(
	target: "user" | "bot" | "both",
	perm: PermissionResolvable[],
	response?: string
) {
	return CommandControlPlugin<CommandType.Both>(async (ctx, args) => {
		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();
		}
		const bot = (await ctx.guild.members.fetchMe({
			cache: false,
		})!) as GuildMember;
		const memm = ctx.member! as GuildMember;
		switch (target) {
			//*********************************************************************************************************************//
			case "bot":
				if (!bot.permissions.has(perm)) {
					if (!response)
						response = `I cannot use this command, please give me \`${perm.join(
							", "
						)}\` permission(s).`;
					await ctx.reply(payload(response));
					return controller.stop();
				}
				return controller.next();
			//*********************************************************************************************************************//
			case "user":
				if (!memm.permissions.has(perm)) {
					if (!response)
						response = `You cannot use this command because you are missing \`${perm.join(
							", "
						)}\` permission(s).`;
					await ctx.reply(payload(response));
					return controller.stop();
				}
				return controller.next();
			//*********************************************************************************************************************//
			case "both":
				if (
					!bot.permissions.has(perm) ||
					!memm.permissions.has(perm)
				) {
					if (!response)
						response = `Please ensure <@${bot.user.id}> and <@${
							memm.user.id
						}> both have \`${perm.join(", ")}\` permission(s).`;
					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();
		}
	});
}