commands/automation/AFKsCommand.ts

/**
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import { SlashCommandBuilder } from "discord.js";
import Command, {
    ArgumentType,
    BasicCommandContext,
    CommandMessage,
    CommandReturn,
    RunCommandOptions,
    ValidationRule
} from "../../core/Command";

export type AFKsCommandScope = "guild" | "everywhere" | "global";

export default class AFKsCommand extends Command {
    public readonly name = "afks";
    public readonly subcommands = ["remove", "delete", "clear"];
    public readonly subCommandCheck = true;
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.String],
            errors: {
                required: `Please provide a valid subcommand! The valid commands are: \`${this.subcommands.join(
                    "`, `"
                )}\``,
                "type:invalid": "Please provide a valid subcommand!"
            },
            name: "subcommand"
        }
    ];
    public readonly permissions = [];
    public readonly description = "Manage AFK statuses of other members.";
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addSubcommand(subcommand =>
            subcommand
                .setName("remove")
                .setDescription("Removes AFK status for a user")
                .addUserOption(option =>
                    option.setName("user").setDescription("The user").setRequired(true)
                )
                .addStringOption(option =>
                    option
                        .setName("scope")
                        .setDescription("Scope for this removal; defaults to Guild Scope")
                        .setChoices(
                            {
                                name: "Guild-Scoped",
                                value: "guild"
                            },
                            {
                                name: "Global",
                                value: "global"
                            },
                            {
                                name: "Everywhere",
                                value: "everywhere"
                            }
                        )
                )
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("clear")
                .setDescription("Removes AFK statuses for all users in a guild")
        );

    async execute(
        message: CommandMessage,
        context: BasicCommandContext,
        options: RunCommandOptions
    ): Promise<CommandReturn> {
        const subcommand = context.isLegacy
            ? context.parsedNamedArgs.subcommand
            : context.options.getSubcommand(true);
        const command = this.client.commands.get(`afks__${subcommand}`);

        if (!command) {
            await this.error(message, this.validationRules[0].errors!.required!);
            return;
        }

        if (context.isLegacy) context.args.shift();

        return await command.run({
            ...options,
            message,
            context
        });
    }
}
1	/**
2	* This file is part of SudoBot.
3	*
4	* Copyright (C) 2021-2023 OSN Developers.
5	*
6	* SudoBot is free software; you can redistribute it and/or modify it
7	* under the terms of the GNU Affero General Public License as published by
8	* the Free Software Foundation, either version 3 of the License, or
9	* (at your option) any later version.
10	*
11	* SudoBot is distributed in the hope that it will be useful, but
12	* WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU Affero General Public License for more details.
15	*
16	* You should have received a copy of the GNU Affero General Public License
17	* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18	*/
19
20	import { SlashCommandBuilder } from "discord.js";
21	import Command, {
22	ArgumentType,
23	BasicCommandContext,
24	CommandMessage,
25	CommandReturn,
26	RunCommandOptions,
27	ValidationRule
28	} from "../../core/Command";
29
30	export type AFKsCommandScope = "guild" \| "everywhere" \| "global";
31
32	export default class AFKsCommand extends Command {
33	public readonly name = "afks";
34	public readonly subcommands = ["remove", "delete", "clear"];
35	public readonly subCommandCheck = true;
36	public readonly validationRules: ValidationRule[] = [
37	{
38	types: [ArgumentType.String],
39	errors: {
40	required: `Please provide a valid subcommand! The valid commands are: \`${this.subcommands.join(
41	"`, `"
42	)}\``,
43	"type:invalid": "Please provide a valid subcommand!"
44	},
45	name: "subcommand"
46	}
47	];
48	public readonly permissions = [];
49	public readonly description = "Manage AFK statuses of other members.";
50	public readonly slashCommandBuilder = new SlashCommandBuilder()
51	.addSubcommand(subcommand =>
52	subcommand
53	.setName("remove")
54	.setDescription("Removes AFK status for a user")
55	.addUserOption(option =>
56	option.setName("user").setDescription("The user").setRequired(true)
57	)
58	.addStringOption(option =>
59	option
60	.setName("scope")
61	.setDescription("Scope for this removal; defaults to Guild Scope")
62	.setChoices(
63	{
64	name: "Guild-Scoped",
65	value: "guild"
66	},
67	{
68	name: "Global",
69	value: "global"
70	},
71	{
72	name: "Everywhere",
73	value: "everywhere"
74	}
75	)
76	)
77	)
78	.addSubcommand(subcommand =>
79	subcommand
80	.setName("clear")
81	.setDescription("Removes AFK statuses for all users in a guild")
82	);
83
84	async execute(
85	message: CommandMessage,
86	context: BasicCommandContext,
87	options: RunCommandOptions
88	): Promise<CommandReturn> {
89	const subcommand = context.isLegacy
90	? context.parsedNamedArgs.subcommand
91	: context.options.getSubcommand(true);
92	const command = this.client.commands.get(`afks__${subcommand}`);
93
94	if (!command) {
95	await this.error(message, this.validationRules[0].errors!.required!);
96	return;
97	}
98
99	if (context.isLegacy) context.args.shift();
100
101	return await command.run({
102	...options,
103	message,
104	context
105	});
106	}
107	}