Archived
new extensible CommandManager
This commit is contained in:
mmacierzanka committed
1 parent
4a6f496009
commit
b2c33e7555
1 file changed
+14
-293
+14
-293
@@ -1,312 +1,33 @@
|
||||
import axios from "axios";
|
||||
import { CommandInteraction, Message } from "discord.js";
|
||||
import { BaseCommand } from "../structures/BaseCommand.js";
|
||||
import { MissingParameterError } from "../errors.js";
|
||||
import { BooleanParameter, InputParameter, NumberParameter, ObjectParameter, StringParameter } from "../structures/Parameter.js";
|
||||
import { TextCommand } from "../structures/TextCommand.js";
|
||||
import { CommandMessageStructure } from "../types/TextCommand.js";
|
||||
import { applicationState } from "../state.js";
|
||||
import { MessageCommand } from "../structures/MessageCommand.js";
|
||||
import { CommandType, PhraseOccurrenceData } from "../types/BaseCommand.js";
|
||||
import { UserCommand } from "../structures/UserCommand.js";
|
||||
import { CommandResolvable, CommandStructure } from "../types/commands.js";
|
||||
import { applicationState } from "../state";
|
||||
import { BaseCommand } from "../structures/BaseCommand";
|
||||
|
||||
/**
|
||||
* @class Command manager
|
||||
*/
|
||||
export class CommandManager {
|
||||
private readonly _chatCommandsList: TextCommand[] = [];
|
||||
private readonly _messagesCommandsList: MessageCommand[] = [];
|
||||
private readonly _userCommandsList: UserCommand[] = [];
|
||||
private readonly _list: BaseCommand[] = [];
|
||||
|
||||
/**
|
||||
* Prefix used as a way to trigger the bot using messages
|
||||
* @type {string}
|
||||
*/
|
||||
public readonly prefix?: string;
|
||||
|
||||
/**
|
||||
* Separator used to split user input to a list of {@link InputParameter}s (applies to prefix interactions)
|
||||
* @type {string}
|
||||
*/
|
||||
public readonly parameterSeparator: string;
|
||||
|
||||
/**
|
||||
* @constructor
|
||||
* @param {string} [prefix] - prefix used as a way to trigger the bot using messages
|
||||
* @param {string} parameterSeparator - used to split user input to a list of {@link InputParameter}s (applies to prefix interactions)
|
||||
*/
|
||||
constructor(prefix?: string, parameterSeparator?: string) {
|
||||
this.prefix = prefix;
|
||||
this.parameterSeparator = parameterSeparator || ",";
|
||||
public get(q: string): BaseCommand | null {
|
||||
return this._list.find((c) => c.name === q) || null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the command by name, alias or keyword
|
||||
* @param {string} phrase - command name, alias or keyword
|
||||
* @returns {TextCommand | MessageCommand | UserCommand | null} Retrieved extension of {@link BaseCommand} object from the manager or *null*
|
||||
*/
|
||||
public get<T extends CommandType>(phrase: string, type: T): CommandStructure<T> | null {
|
||||
let command: CommandStructure<T> | null = null;
|
||||
switch (type) {
|
||||
case "CHAT":
|
||||
command = (this._chatCommandsList.find((c) => c.name === phrase) as CommandStructure<T>) || null;
|
||||
if (!command) {
|
||||
this._chatCommandsList.map((c) => {
|
||||
if (c.aliases) {
|
||||
c.aliases.map((a) => {
|
||||
if (a === phrase) {
|
||||
command = c as CommandStructure<T>;
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
break;
|
||||
case "MESSAGE":
|
||||
command = (this._messagesCommandsList.find((c) => c.name === phrase) as CommandStructure<T>) || null;
|
||||
break;
|
||||
case "USER":
|
||||
command = (this._userCommandsList.find((c) => c.name === phrase) as CommandStructure<T>) || null;
|
||||
break;
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
return command;
|
||||
get list(): readonly BaseCommand[] {
|
||||
return Object.freeze([...this._list]);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {CommandType} filter - type of commands included in the list
|
||||
* @returns {BaseCommand[]} List of commands registered in the manager
|
||||
*/
|
||||
public getList<T extends CommandType>(filter?: T): readonly CommandStructure<T>[] {
|
||||
switch (filter) {
|
||||
case "CHAT":
|
||||
return Object.freeze([...this._chatCommandsList]) as readonly CommandStructure<T>[];
|
||||
case "MESSAGE":
|
||||
return Object.freeze([...this._messagesCommandsList]) as readonly CommandStructure<T>[];
|
||||
case "USER":
|
||||
return Object.freeze([...this._userCommandsList]) as readonly CommandStructure<T>[];
|
||||
default:
|
||||
return Object.freeze([...this._chatCommandsList, ...this._messagesCommandsList, ...this._userCommandsList]) as CommandStructure<T>[];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the given {@link Command} to the instance manager with initial processing
|
||||
* @param {BaseCommand} command - {@link Command} instance object
|
||||
* @returns {boolean} Whether this command has been added successfully
|
||||
*/
|
||||
public add(command: CommandResolvable): void {
|
||||
public add(command: BaseCommand): void {
|
||||
try {
|
||||
if (applicationState.running) {
|
||||
throw new Error("Cannot add a command while the application is running");
|
||||
}
|
||||
if (command instanceof TextCommand) {
|
||||
const nameOccurrence: PhraseOccurrenceData | null = this.findPhraseOccurrence(command.type, command.name);
|
||||
if (nameOccurrence) {
|
||||
throw new Error(`The name "${command.name}" has already been registered as ${nameOccurrence.type} in the "${nameOccurrence.command.name}" command.`);
|
||||
if (command instanceof BaseCommand) {
|
||||
if (this.get(command.name)) {
|
||||
throw new Error(`A command with name "${command.name}" is already registered in this manager`);
|
||||
} else {
|
||||
this._list.push(command);
|
||||
}
|
||||
command.aliases &&
|
||||
command.aliases.map((a, i, ar) => {
|
||||
const aliasOccurrence: PhraseOccurrenceData | null = this.findPhraseOccurrence(command.type, a);
|
||||
if (aliasOccurrence) {
|
||||
console.warn(
|
||||
`[⚠ WARN] The name "${a}" is already registered as ${aliasOccurrence.type} in the "${aliasOccurrence.command.name}" command. It will be removed from the "${command.name}" command.`
|
||||
);
|
||||
ar.splice(i, 1);
|
||||
}
|
||||
});
|
||||
command.parameters &&
|
||||
command.parameters.map((p) => {
|
||||
if (p.type != "string" && p.choices) {
|
||||
throw new Error('Parameter with defined choices must have a "string" type');
|
||||
}
|
||||
});
|
||||
this._chatCommandsList.push(command);
|
||||
} else if (command instanceof MessageCommand) {
|
||||
const nameOccurrence = this.findPhraseOccurrence(command.type, command.name);
|
||||
if (nameOccurrence) {
|
||||
throw new Error(`The name "${command.name}" has already been registered as ${nameOccurrence.type} in the "${nameOccurrence.command.name}" command.`);
|
||||
}
|
||||
this._messagesCommandsList.push(command);
|
||||
} else if (command instanceof UserCommand) {
|
||||
const nameOccurrence = this.findPhraseOccurrence(command.type, command.name);
|
||||
if (nameOccurrence) {
|
||||
throw new Error(`The name "${command.name}" has already been registered as ${nameOccurrence.type} in the "${nameOccurrence.command.name}" command.`);
|
||||
}
|
||||
this._userCommandsList.push(command);
|
||||
} else {
|
||||
throw new TypeError("Invalid argument type");
|
||||
throw new TypeError("Incorrect argument type");
|
||||
}
|
||||
} catch (e) {
|
||||
console.error(`[❌ ERROR] ${e}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers commands from a manager in the Discord API
|
||||
*
|
||||
* @returns
|
||||
*/
|
||||
public async register(applicationId: string, token: string) {
|
||||
const globalList = [
|
||||
...this._chatCommandsList.filter((c) => (!Array.isArray(c.guilds) || c.guilds.length === 0) && c.slash).map((c) => c.toObject()),
|
||||
...this._messagesCommandsList.filter((c) => !Array.isArray(c.guilds) || c.guilds.length === 0).map((c) => c.toObject()),
|
||||
...this._userCommandsList.filter((c) => !Array.isArray(c.guilds) || c.guilds.length === 0).map((c) => c.toObject()),
|
||||
];
|
||||
const globalRegisterRq = await axios.put(`https://discord.com/api/v8/applications/${applicationId}/commands`, globalList, { headers: { Authorization: `Bot ${token}` } });
|
||||
}
|
||||
|
||||
public fetch(i: Message | CommandInteraction): CommandMessageStructure | null {
|
||||
if (i instanceof Message) {
|
||||
if (!this.prefix) return null;
|
||||
if (!i.author.bot && i.content.startsWith(this.prefix)) {
|
||||
const content = i.content.replace(this.prefix, "");
|
||||
const name = content.split(" ")[0];
|
||||
const command = this.get(name, "CHAT");
|
||||
if (command) {
|
||||
const argumentsText = content.replace(name, "");
|
||||
const paramsList = argumentsText.split(this.parameterSeparator).map((a) => {
|
||||
return a.replace(" ", "");
|
||||
});
|
||||
if ((paramsList[0] == "" || paramsList[0] == " ") && paramsList.length == 1) {
|
||||
paramsList.splice(0, 1);
|
||||
}
|
||||
const parameters: InputParameter[] = [];
|
||||
command instanceof TextCommand &&
|
||||
command.parameters.map((p, i) => {
|
||||
if (!p.optional && !paramsList[i]) {
|
||||
throw new MissingParameterError(p);
|
||||
} else if (p.optional && !paramsList[i]) {
|
||||
return;
|
||||
}
|
||||
switch (p.type) {
|
||||
case "mentionable":
|
||||
case "channel":
|
||||
case "role":
|
||||
case "user":
|
||||
parameters.push(new ObjectParameter(p, paramsList[i]));
|
||||
break;
|
||||
case "string":
|
||||
parameters.push(new StringParameter(p, paramsList[i]));
|
||||
break;
|
||||
case "boolean":
|
||||
parameters.push(new BooleanParameter(p, paramsList[i]));
|
||||
break;
|
||||
case "number":
|
||||
parameters.push(new NumberParameter(p, paramsList[i]));
|
||||
break;
|
||||
default:
|
||||
parameters.push(new InputParameter(p, paramsList[i]));
|
||||
break;
|
||||
}
|
||||
});
|
||||
return {
|
||||
command: command,
|
||||
parameters: parameters,
|
||||
};
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
} else if (i instanceof CommandInteraction) {
|
||||
let cmd: BaseCommand | null = null;
|
||||
if (i.isContextMenu()) {
|
||||
cmd = this.get(i.commandName, i.targetType);
|
||||
} else {
|
||||
cmd = this.get(i.commandName, "CHAT");
|
||||
}
|
||||
if (cmd) {
|
||||
if (i.options?.data) {
|
||||
const paramsList = i.options.data;
|
||||
const parameters: InputParameter[] = [];
|
||||
cmd instanceof TextCommand &&
|
||||
cmd.parameters.map((p) => {
|
||||
const inputParam = paramsList.find((d) => d.name == p.name);
|
||||
if (!p.optional && !inputParam) {
|
||||
throw new MissingParameterError(p);
|
||||
} else if (p.optional && !inputParam) {
|
||||
return;
|
||||
}
|
||||
switch (p.type) {
|
||||
case "mentionable":
|
||||
case "channel":
|
||||
case "role":
|
||||
case "user":
|
||||
parameters.push(new ObjectParameter(p, inputParam?.value));
|
||||
break;
|
||||
case "string":
|
||||
parameters.push(new StringParameter(p, inputParam?.value));
|
||||
break;
|
||||
case "boolean":
|
||||
parameters.push(new BooleanParameter(p, inputParam?.value));
|
||||
break;
|
||||
case "number":
|
||||
parameters.push(new NumberParameter(p, inputParam?.value));
|
||||
break;
|
||||
default:
|
||||
parameters.push(new InputParameter(p, inputParam?.value));
|
||||
break;
|
||||
}
|
||||
});
|
||||
return {
|
||||
command: cmd,
|
||||
parameters: parameters,
|
||||
};
|
||||
}
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private findPhraseOccurrence(type: CommandType, phrase?: string): PhraseOccurrenceData | null {
|
||||
let returnValue: PhraseOccurrenceData | null = null;
|
||||
switch (type) {
|
||||
case "CHAT":
|
||||
this._chatCommandsList.map((c) => {
|
||||
if (phrase == c.name) {
|
||||
returnValue = {
|
||||
command: c,
|
||||
type: "NAME",
|
||||
};
|
||||
} else if (c.aliases && c.aliases.indexOf(phrase || "") != -1) {
|
||||
returnValue = {
|
||||
command: c,
|
||||
type: "ALIAS",
|
||||
};
|
||||
}
|
||||
});
|
||||
break;
|
||||
case "MESSAGE":
|
||||
this._messagesCommandsList.map((c) => {
|
||||
if (phrase == c.name) {
|
||||
returnValue = {
|
||||
command: c,
|
||||
type: "NAME",
|
||||
};
|
||||
}
|
||||
});
|
||||
break;
|
||||
case "USER":
|
||||
this._userCommandsList.map((c) => {
|
||||
if (phrase == c.name) {
|
||||
returnValue = {
|
||||
command: c,
|
||||
type: "NAME",
|
||||
};
|
||||
}
|
||||
});
|
||||
default:
|
||||
break;
|
||||
}
|
||||
return returnValue;
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user