commands/automation/BallotCommand.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,
    ValidationRule
} from "../../core/Command";

export default class BallotCommand extends Command {
    public readonly name = "ballot";
    public readonly subcommands = ["create", "delete", "view", "votelist"];
    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 aliases = ["poll"];
    public readonly description = "Create and manage ballots/polls.";
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addSubcommand(subcommand =>
            subcommand
                .setName("create")
                .setDescription("Sends a poll/ballot embed")
                .addStringOption(option =>
                    option
                        .setName("content")
                        .setDescription("The ballot/poll content")
                        .setRequired(true)
                )
                .addBooleanOption(option =>
                    option
                        .setName("anonymous")
                        .setDescription(
                            "Anonymous mode won't show your name in the ballot. Default is true"
                        )
                )
                .addChannelOption(option =>
                    option
                        .setName("channel")
                        .setDescription(
                            "The channel where the message will be sent, defaults to the current channel"
                        )
                )
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("view")
                .setDescription("Shows a poll/ballot")
                .addIntegerOption(option =>
                    option.setName("id").setDescription("The ballot ID").setRequired(true)
                )
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("votelist")
                .setDescription("Shows a list of each vote in a poll/ballot")
                .addIntegerOption(option =>
                    option.setName("id").setDescription("The ballot ID").setRequired(true)
                )
                .addStringOption(option =>
                    option
                        .setName("mode")
                        .setDescription("Determines what kind of data is shown")
                        .setChoices(
                            {
                                name: "All Votes",
                                value: "all"
                            },
                            {
                                name: "Upvotes",
                                value: "upvotes"
                            },
                            {
                                name: "Downvotes",
                                value: "downvotes"
                            }
                        )
                )
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("delete")
                .setDescription("Deletes a poll/ballot")
                .addIntegerOption(option =>
                    option.setName("id").setDescription("The ballot ID").setRequired(true)
                )
        );

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

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

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

        return await command.execute(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	ValidationRule
27	} from "../../core/Command";
28
29	export default class BallotCommand extends Command {
30	public readonly name = "ballot";
31	public readonly subcommands = ["create", "delete", "view", "votelist"];
32	public readonly subCommandCheck = true;
33	public readonly validationRules: ValidationRule[] = [
34	{
35	types: [ArgumentType.String],
36	errors: {
37	required: `Please provide a valid subcommand! The valid commands are: \`${this.subcommands.join(
38	"`, `"
39	)}\``,
40	"type:invalid": "Please provide a valid subcommand!"
41	},
42	name: "subcommand"
43	}
44	];
45	public readonly permissions = [];
46	public readonly aliases = ["poll"];
47	public readonly description = "Create and manage ballots/polls.";
48	public readonly slashCommandBuilder = new SlashCommandBuilder()
49	.addSubcommand(subcommand =>
50	subcommand
51	.setName("create")
52	.setDescription("Sends a poll/ballot embed")
53	.addStringOption(option =>
54	option
55	.setName("content")
56	.setDescription("The ballot/poll content")
57	.setRequired(true)
58	)
59	.addBooleanOption(option =>
60	option
61	.setName("anonymous")
62	.setDescription(
63	"Anonymous mode won't show your name in the ballot. Default is true"
64	)
65	)
66	.addChannelOption(option =>
67	option
68	.setName("channel")
69	.setDescription(
70	"The channel where the message will be sent, defaults to the current channel"
71	)
72	)
73	)
74	.addSubcommand(subcommand =>
75	subcommand
76	.setName("view")
77	.setDescription("Shows a poll/ballot")
78	.addIntegerOption(option =>
79	option.setName("id").setDescription("The ballot ID").setRequired(true)
80	)
81	)
82	.addSubcommand(subcommand =>
83	subcommand
84	.setName("votelist")
85	.setDescription("Shows a list of each vote in a poll/ballot")
86	.addIntegerOption(option =>
87	option.setName("id").setDescription("The ballot ID").setRequired(true)
88	)
89	.addStringOption(option =>
90	option
91	.setName("mode")
92	.setDescription("Determines what kind of data is shown")
93	.setChoices(
94	{
95	name: "All Votes",
96	value: "all"
97	},
98	{
99	name: "Upvotes",
100	value: "upvotes"
101	},
102	{
103	name: "Downvotes",
104	value: "downvotes"
105	}
106	)
107	)
108	)
109	.addSubcommand(subcommand =>
110	subcommand
111	.setName("delete")
112	.setDescription("Deletes a poll/ballot")
113	.addIntegerOption(option =>
114	option.setName("id").setDescription("The ballot ID").setRequired(true)
115	)
116	);
117
118	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
119	const subcommand = context.isLegacy
120	? context.parsedNamedArgs.subcommand
121	: context.options.getSubcommand(true);
122	const command = this.client.commands.get(`ballot__${subcommand}`);
123
124	if (!command) {
125	await this.error(message, this.validationRules[0].errors!.required!);
126	return;
127	}
128
129	if (context.isLegacy) context.args.shift();
130
131	return await command.execute(message, context);
132	}
133	}