commands/moderation/NoteCommand.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 { PermissionsBitField, SlashCommandBuilder } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";

export default class NoteCommand extends Command {
    public readonly name = "note";
    public readonly subcommands = ["view", "create", "edit", "delete", "list", "clear"];
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.String],
            name: "subcommand",
            requiredErrorMessage: `Please provide a valid subcommand! The available subcommands are: \`${this.subcommands.join("`, `")}\`.`
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ModerateMembers, PermissionsBitField.Flags.ViewAuditLog];
    public readonly permissionMode = "or";
    public readonly description = "Manage notes.";
    public readonly detailedDescription = "Use this command to manage notes about users.";
    public readonly argumentSyntaxes = ["<subcommand> [...args]"];

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addSubcommand(subcommand =>
            subcommand
                .setName("view")
                .setDescription("View a note")
                .addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("edit")
                .setDescription("Update a note")
                .addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
                .addStringOption(option => option.setName("content").setDescription("New content"))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("delete")
                .setDescription("Delete a note")
                .addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("clear")
                .setDescription("Clear notes for a user")
                .addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("list")
                .setDescription("List notes for a user")
                .addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("create")
                .setDescription("Add a note to a user")
                .addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
                .addStringOption(option => option.setName("content").setDescription("The content of this note"))
        );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        const subcommand = context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true);

        await this.deferIfInteraction(message);

        const command = this.client.commands.get(`note__${subcommand}`);

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

        if (command) {
            return await command.execute(message, context);
        }
    }
}
1	rakinar2	577	/**
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 { PermissionsBitField, SlashCommandBuilder } from "discord.js";
21			import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22
23			export default class NoteCommand extends Command {
24			public readonly name = "note";
25			public readonly subcommands = ["view", "create", "edit", "delete", "list", "clear"];
26			public readonly validationRules: ValidationRule[] = [
27			{
28			types: [ArgumentType.String],
29			name: "subcommand",
30			requiredErrorMessage: `Please provide a valid subcommand! The available subcommands are: \`${this.subcommands.join("`, `")}\`.`
31			}
32			];
33			public readonly permissions = [PermissionsBitField.Flags.ModerateMembers, PermissionsBitField.Flags.ViewAuditLog];
34			public readonly permissionMode = "or";
35			public readonly description = "Manage notes.";
36			public readonly detailedDescription = "Use this command to manage notes about users.";
37			public readonly argumentSyntaxes = ["<subcommand> [...args]"];
38
39			public readonly slashCommandBuilder = new SlashCommandBuilder()
40			.addSubcommand(subcommand =>
41			subcommand
42			.setName("view")
43			.setDescription("View a note")
44			.addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
45			)
46			.addSubcommand(subcommand =>
47			subcommand
48			.setName("edit")
49			.setDescription("Update a note")
50			.addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
51			.addStringOption(option => option.setName("content").setDescription("New content"))
52			)
53			.addSubcommand(subcommand =>
54			subcommand
55			.setName("delete")
56			.setDescription("Delete a note")
57			.addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
58			)
59			.addSubcommand(subcommand =>
60			subcommand
61			.setName("clear")
62			.setDescription("Clear notes for a user")
63			.addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
64			)
65			.addSubcommand(subcommand =>
66			subcommand
67			.setName("list")
68			.setDescription("List notes for a user")
69			.addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
70			)
71			.addSubcommand(subcommand =>
72			subcommand
73			.setName("create")
74			.setDescription("Add a note to a user")
75			.addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
76			.addStringOption(option => option.setName("content").setDescription("The content of this note"))
77			);
78
79			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
80			const subcommand = context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true);
81
82			await this.deferIfInteraction(message);
83
84			const command = this.client.commands.get(`note__${subcommand}`);
85
86			if (context.isLegacy) context.args.shift();
87
88			if (command) {
89			return await command.execute(message, context);
90			}
91			}
92			}