commands/moderation/UserNoteCommand.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 UserNoteCommand extends Command {
    public readonly name = "unote";
    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 aliases = ["usernote", "unotes", "usernotes"];

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .setName("usernote")
        .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(`unote__${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 UserNoteCommand extends Command {
24			public readonly name = "unote";
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			public readonly aliases = ["usernote", "unotes", "usernotes"];
44
45			public readonly slashCommandBuilder = new SlashCommandBuilder()
46			.setName("usernote")
47			.addSubcommand(subcommand =>
48			subcommand
49			.setName("view")
50			.setDescription("View a note")
51			.addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
52			)
53			.addSubcommand(subcommand =>
54			subcommand
55			.setName("edit")
56			.setDescription("Update a note")
57			.addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
58			.addStringOption(option => option.setName("content").setDescription("New content"))
59			)
60			.addSubcommand(subcommand =>
61			subcommand
62			.setName("delete")
63			.setDescription("Delete a note")
64			.addIntegerOption(option => option.setName("id").setDescription("The note ID").setRequired(true))
65			)
66			.addSubcommand(subcommand =>
67			subcommand
68			.setName("clear")
69			.setDescription("Clear notes for a user")
70			.addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
71			)
72			.addSubcommand(subcommand =>
73			subcommand
74			.setName("list")
75			.setDescription("List notes for a user")
76			.addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
77			)
78			.addSubcommand(subcommand =>
79			subcommand
80			.setName("create")
81			.setDescription("Add a note to a user")
82			.addUserOption(option => option.setName("user").setDescription("The target user").setRequired(true))
83			.addStringOption(option => option.setName("content").setDescription("The content of this note"))
84			);
85
86			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
87			const subcommand = context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true);
88
89			await this.deferIfInteraction(message);
90
91			const command = this.client.commands.get(`unote__${subcommand}`);
92
93			if (context.isLegacy) context.args.shift();
94
95			if (command) {
96			return await command.execute(message, context);
97			}
98			}
99			}