commands/automation/SurveyCommand.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 {
    ActionRowBuilder,
    ButtonBuilder,
    ButtonStyle,
    HeadingLevel,
    SlashCommandBuilder,
    heading
} from "discord.js";
import Command, {
    ArgumentType,
    BasicCommandContext,
    CommandMessage,
    CommandReturn,
    ValidationRule
} from "../../core/Command";

export default class SurveyCommand extends Command {
    public readonly name = "survey";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.String],
            errors: {
                required: "You must provide a form name to view",
                "type:invalid": "You must provide a form name to view"
            },
            optional: false,
            name: "survey"
        }
    ];
    public readonly aliases = ["form"];

    public readonly description = "Shows a survey form to fill out";
    public readonly slashCommandBuilder = new SlashCommandBuilder().addStringOption(option =>
        option.setName("survey").setDescription("The survey name to show").setRequired(true)
    );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        const id = context.isLegacy
            ? context.parsedNamedArgs.survey
            : context.options.getString("survey", true);
        const survey = context.config.survey?.surveys[id];

        if (!survey) {
            await this.error(message, "This survey does not exist.");
            return;
        }

        await message.reply({
            ephemeral: true,
            content: `${heading(survey.name, HeadingLevel.Two)}\n\n${
                survey.description ?? "Please fill out the form by clicking the button below."
            }`,
            components: [
                new ActionRowBuilder<ButtonBuilder>().addComponents(
                    new ButtonBuilder()
                        .setCustomId("survey_" + id)
                        .setLabel("Fill out survey")
                        .setStyle(ButtonStyle.Secondary)
                )
            ]
        });
    }
}
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 {
21	ActionRowBuilder,
22	ButtonBuilder,
23	ButtonStyle,
24	HeadingLevel,
25	SlashCommandBuilder,
26	heading
27	} from "discord.js";
28	import Command, {
29	ArgumentType,
30	BasicCommandContext,
31	CommandMessage,
32	CommandReturn,
33	ValidationRule
34	} from "../../core/Command";
35
36	export default class SurveyCommand extends Command {
37	public readonly name = "survey";
38	public readonly validationRules: ValidationRule[] = [
39	{
40	types: [ArgumentType.String],
41	errors: {
42	required: "You must provide a form name to view",
43	"type:invalid": "You must provide a form name to view"
44	},
45	optional: false,
46	name: "survey"
47	}
48	];
49	public readonly aliases = ["form"];
50
51	public readonly description = "Shows a survey form to fill out";
52	public readonly slashCommandBuilder = new SlashCommandBuilder().addStringOption(option =>
53	option.setName("survey").setDescription("The survey name to show").setRequired(true)
54	);
55
56	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
57	const id = context.isLegacy
58	? context.parsedNamedArgs.survey
59	: context.options.getString("survey", true);
60	const survey = context.config.survey?.surveys[id];
61
62	if (!survey) {
63	await this.error(message, "This survey does not exist.");
64	return;
65	}
66
67	await message.reply({
68	ephemeral: true,
69	content: `${heading(survey.name, HeadingLevel.Two)}\n\n${
70	survey.description ?? "Please fill out the form by clicking the button below."
71	}`,
72	components: [
73	new ActionRowBuilder<ButtonBuilder>().addComponents(
74	new ButtonBuilder()
75	.setCustomId("survey_" + id)
76	.setLabel("Fill out survey")
77	.setStyle(ButtonStyle.Secondary)
78	)
79	]
80	});
81	}
82	}