mirror of
https://github.com/sern-handler/awesome-plugins
synced 2026-06-06 01:16:51 +00:00
1c653b723e
This change fixes an issue where the code would crash stating that a specific subcommand was not found on {command}.
Also shortened/ cleaned up the code for various checks.
90 lines
3.2 KiB
TypeScript
90 lines
3.2 KiB
TypeScript
//@ts-nocheck
|
|
/**
|
|
* @plugin
|
|
* Inspired by the plugin "requirePermission" created by Benzo-Fury & needhamgary, this plugin will set permissions for specific subcommands without manually writing it into the code.
|
|
*
|
|
* @author @Peter-MJ-Parker [<@371759410009341952>]
|
|
* @author @MaxiIsSlayy [<@237210568791031809>]
|
|
* @version 1.0.2
|
|
* @example
|
|
* ```ts
|
|
* import { subcommandPermCheck } from "../plugins/subcommandPerms.js";
|
|
* import { commandModule, CommandType } from "@sern/handler";
|
|
* import { PermissionFlagBits } from "discord.js";
|
|
* export default commandModule({
|
|
* type: CommandType.Slash,
|
|
* plugins: [
|
|
* subcommandPermCheck({
|
|
* list: [
|
|
* { name: "string", perms: [PermissionFlagBits.Administrator] },
|
|
* { name: "number", perms: [PermissionFlagBits.SendMessages, PermissionFlagBits.UseVAD] }
|
|
* ],
|
|
* needAllPerms: true, //Require the member to have all perms stated (true) or at least one (false)?
|
|
* //response: "OPTIONAL - respond to user with this message or default."
|
|
* })
|
|
* ],
|
|
* execute: ({ interaction }) => {
|
|
* //your code here
|
|
* }
|
|
* })
|
|
* ```
|
|
* @end
|
|
*/
|
|
import { type GuildMember, type PermissionResolvable, type TextChannel, PermissionsBitField } from 'discord.js';
|
|
import { type CommandType, CommandControlPlugin, controller } from '@sern/handler';
|
|
|
|
export const permsToString = (...perms: PermissionResolvable[]) => {
|
|
return new PermissionsBitField(perms)
|
|
.toArray()
|
|
.map(perm => `\`${perm}\``)
|
|
.join(', ');
|
|
};
|
|
|
|
export function subcommandPermCheck(opts: Options) {
|
|
return CommandControlPlugin<CommandType.Slash>(async ctx => {
|
|
if (!ctx.isSlash()) {
|
|
throw new Error('You did not provide a slash command.', {
|
|
cause: "The plugin 'subcommandPermCheck' is meant for Slash commands only!"
|
|
});
|
|
}
|
|
|
|
if (ctx.guild === null) {
|
|
ctx.reply("PermCheck > A command stopped because we couldn't check a users permissions (was used in dms)");
|
|
return controller.stop();
|
|
}
|
|
const member = ctx.member as GuildMember;
|
|
const subcommands = opts.list;
|
|
const sub = ctx.options.getSubcommand();
|
|
|
|
if (!subcommands.some(opt => opt.name === sub)) {
|
|
throw new Error("You provided a subcommand name which doesn't exist in given command.", {
|
|
cause: `${sub} not found on command: ${ctx.interaction.commandName}.`
|
|
});
|
|
}
|
|
for (const { perms } of subcommands) {
|
|
const each = permsToString(perms);
|
|
const memberPermissions = member.permissionsIn(ctx.channel as TextChannel);
|
|
const hasPermission = opts.needAllPerms ? memberPermissions.has(perms) : memberPermissions.any(perms);
|
|
|
|
if (!hasPermission) {
|
|
const split = each.split(', ');
|
|
const quantifier = split.length > 1 ? (opts.needAllPerms ? 'all of' : 'at least one of') : '';
|
|
const str = `${quantifier} the following permission${split.length > 1 ? 's' : ''}`;
|
|
|
|
await ctx.reply({
|
|
content: opts.response ?? `You are required to have ${str} to run this subcommand in this channel:\n${each}`,
|
|
ephemeral: true
|
|
});
|
|
return controller.stop();
|
|
}
|
|
}
|
|
return controller.next();
|
|
});
|
|
}
|
|
|
|
interface Options {
|
|
list: { name: string; perms: PermissionResolvable[] }[];
|
|
needAllPerms: boolean;
|
|
response?: string;
|
|
}
|