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