416 lines
15 KiB
JavaScript
416 lines
15 KiB
JavaScript
|
'use strict';
|
||
|
|
|
||
|
|
const { DiscordSnowflake } = require('@sapphire/snowflake');
|
||
|
|
const { ApplicationCommandOptionType } = require('discord-api-types/v9');
|
||
|
|
const Base = require('./Base');
|
||
|
|
const ApplicationCommandPermissionsManager = require('../managers/ApplicationCommandPermissionsManager');
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Represents an application command.
|
||
|
|
* @extends {Base}
|
||
|
|
*/
|
||
|
|
class ApplicationCommand extends Base {
|
||
|
|
constructor(client, data, guild, guildId) {
|
||
|
|
super(client);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The command's id
|
||
|
|
* @type {Snowflake}
|
||
|
|
*/
|
||
|
|
this.id = data.id;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The parent application's id
|
||
|
|
* @type {Snowflake}
|
||
|
|
*/
|
||
|
|
this.applicationId = data.application_id;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The guild this command is part of
|
||
|
|
* @type {?Guild}
|
||
|
|
*/
|
||
|
|
this.guild = guild ?? null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The guild's id this command is part of, this may be non-null when `guild` is `null` if the command
|
||
|
|
* was fetched from the `ApplicationCommandManager`
|
||
|
|
* @type {?Snowflake}
|
||
|
|
*/
|
||
|
|
this.guildId = guild?.id ?? guildId ?? null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The manager for permissions of this command on its guild or arbitrary guilds when the command is global
|
||
|
|
* @type {ApplicationCommandPermissionsManager}
|
||
|
|
*/
|
||
|
|
this.permissions = new ApplicationCommandPermissionsManager(this);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The type of this application command
|
||
|
|
* @type {ApplicationCommandType}
|
||
|
|
*/
|
||
|
|
this.type = data.type;
|
||
|
|
|
||
|
|
this._patch(data);
|
||
|
|
}
|
||
|
|
|
||
|
|
_patch(data) {
|
||
|
|
if ('name' in data) {
|
||
|
|
/**
|
||
|
|
* The name of this command
|
||
|
|
* @type {string}
|
||
|
|
*/
|
||
|
|
this.name = data.name;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('description' in data) {
|
||
|
|
/**
|
||
|
|
* The description of this command
|
||
|
|
* @type {string}
|
||
|
|
*/
|
||
|
|
this.description = data.description;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('options' in data) {
|
||
|
|
/**
|
||
|
|
* The options of this command
|
||
|
|
* @type {ApplicationCommandOption[]}
|
||
|
|
*/
|
||
|
|
this.options = data.options.map(o => this.constructor.transformOption(o, true));
|
||
|
|
} else {
|
||
|
|
this.options ??= [];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('default_permission' in data) {
|
||
|
|
/**
|
||
|
|
* Whether the command is enabled by default when the app is added to a guild
|
||
|
|
* @type {boolean}
|
||
|
|
*/
|
||
|
|
this.defaultPermission = data.default_permission;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('version' in data) {
|
||
|
|
/**
|
||
|
|
* Autoincrementing version identifier updated during substantial record changes
|
||
|
|
* @type {Snowflake}
|
||
|
|
*/
|
||
|
|
this.version = data.version;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The timestamp the command was created at
|
||
|
|
* @type {number}
|
||
|
|
* @readonly
|
||
|
|
*/
|
||
|
|
get createdTimestamp() {
|
||
|
|
return DiscordSnowflake.timestampFrom(this.id);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The time the command was created at
|
||
|
|
* @type {Date}
|
||
|
|
* @readonly
|
||
|
|
*/
|
||
|
|
get createdAt() {
|
||
|
|
return new Date(this.createdTimestamp);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The manager that this command belongs to
|
||
|
|
* @type {ApplicationCommandManager}
|
||
|
|
* @readonly
|
||
|
|
*/
|
||
|
|
get manager() {
|
||
|
|
return (this.guild ?? this.client.application).commands;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Data for creating or editing an application command.
|
||
|
|
* @typedef {Object} ApplicationCommandData
|
||
|
|
* @property {string} name The name of the command, must be in all lowercase if type is
|
||
|
|
* {@link ApplicationCommandType.ChatInput}
|
||
|
|
* @property {string} description The description of the command, if type is {@link ApplicationCommandType.ChatInput}
|
||
|
|
* @property {ApplicationCommandType} [type=ApplicationCommandType.ChatInput] The type of the command
|
||
|
|
* @property {ApplicationCommandOptionData[]} [options] Options for the command
|
||
|
|
* @property {boolean} [defaultPermission=true] Whether the command is enabled by default when the app is added to a
|
||
|
|
* guild
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An option for an application command or subcommand.
|
||
|
|
* <info>In addition to the listed properties, when used as a parameter,
|
||
|
|
* API style `snake_case` properties can be used for compatibility with generators like `@discordjs/builders`.</info>
|
||
|
|
* <warn>Note that providing a value for the `camelCase` counterpart for any `snake_case` property
|
||
|
|
* will discard the provided `snake_case` property.</warn>
|
||
|
|
* @typedef {Object} ApplicationCommandOptionData
|
||
|
|
* @property {ApplicationCommandOptionType} type The type of the option
|
||
|
|
* @property {string} name The name of the option
|
||
|
|
* @property {string} description The description of the option
|
||
|
|
* @property {boolean} [autocomplete] Whether the autocomplete interaction is enabled for a
|
||
|
|
* {@link ApplicationCommandOptionType.String}, {@link ApplicationCommandOptionType.Integer} or
|
||
|
|
* {@link ApplicationCommandOptionType.Number} option
|
||
|
|
* @property {boolean} [required] Whether the option is required
|
||
|
|
* @property {ApplicationCommandOptionChoice[]} [choices] The choices of the option for the user to pick from
|
||
|
|
* @property {ApplicationCommandOptionData[]} [options] Additional options if this option is a subcommand (group)
|
||
|
|
* @property {ChannelType[]} [channelTypes] When the option type is channel,
|
||
|
|
* the allowed types of channels that can be selected
|
||
|
|
* @property {number} [minValue] The minimum value for an {@link ApplicationCommandOptionType.Integer} or
|
||
|
|
* {@link ApplicationCommandOptionType.Number} option
|
||
|
|
* @property {number} [maxValue] The maximum value for an {@link ApplicationCommandOptionType.Integer} or
|
||
|
|
* {@link ApplicationCommandOptionType.Number} option
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Edits this application command.
|
||
|
|
* @param {ApplicationCommandData} data The data to update the command with
|
||
|
|
* @returns {Promise<ApplicationCommand>}
|
||
|
|
* @example
|
||
|
|
* // Edit the description of this command
|
||
|
|
* command.edit({
|
||
|
|
* description: 'New description',
|
||
|
|
* })
|
||
|
|
* .then(console.log)
|
||
|
|
* .catch(console.error);
|
||
|
|
*/
|
||
|
|
edit(data) {
|
||
|
|
return this.manager.edit(this, data, this.guildId);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Edits the name of this ApplicationCommand
|
||
|
|
* @param {string} name The new name of the command
|
||
|
|
* @returns {Promise<ApplicationCommand>}
|
||
|
|
*/
|
||
|
|
setName(name) {
|
||
|
|
return this.edit({ name });
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Edits the description of this ApplicationCommand
|
||
|
|
* @param {string} description The new description of the command
|
||
|
|
* @returns {Promise<ApplicationCommand>}
|
||
|
|
*/
|
||
|
|
setDescription(description) {
|
||
|
|
return this.edit({ description });
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Edits the default permission of this ApplicationCommand
|
||
|
|
* @param {boolean} [defaultPermission=true] The default permission for this command
|
||
|
|
* @returns {Promise<ApplicationCommand>}
|
||
|
|
*/
|
||
|
|
setDefaultPermission(defaultPermission = true) {
|
||
|
|
return this.edit({ defaultPermission });
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Edits the options of this ApplicationCommand
|
||
|
|
* @param {ApplicationCommandOptionData[]} options The options to set for this command
|
||
|
|
* @returns {Promise<ApplicationCommand>}
|
||
|
|
*/
|
||
|
|
setOptions(options) {
|
||
|
|
return this.edit({ options });
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Deletes this command.
|
||
|
|
* @returns {Promise<ApplicationCommand>}
|
||
|
|
* @example
|
||
|
|
* // Delete this command
|
||
|
|
* command.delete()
|
||
|
|
* .then(console.log)
|
||
|
|
* .catch(console.error);
|
||
|
|
*/
|
||
|
|
delete() {
|
||
|
|
return this.manager.delete(this, this.guildId);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether this command equals another command. It compares all properties, so for most operations
|
||
|
|
* it is advisable to just compare `command.id === command2.id` as it is much faster and is often
|
||
|
|
* what most users need.
|
||
|
|
* @param {ApplicationCommand|ApplicationCommandData|APIApplicationCommand} command The command to compare with
|
||
|
|
* @param {boolean} [enforceOptionOrder=false] Whether to strictly check that options and choices are in the same
|
||
|
|
* order in the array <info>The client may not always respect this ordering!</info>
|
||
|
|
* @returns {boolean}
|
||
|
|
*/
|
||
|
|
equals(command, enforceOptionOrder = false) {
|
||
|
|
// If given an id, check if the id matches
|
||
|
|
if (command.id && this.id !== command.id) return false;
|
||
|
|
|
||
|
|
// Check top level parameters
|
||
|
|
if (
|
||
|
|
command.name !== this.name ||
|
||
|
|
('description' in command && command.description !== this.description) ||
|
||
|
|
('version' in command && command.version !== this.version) ||
|
||
|
|
('autocomplete' in command && command.autocomplete !== this.autocomplete) ||
|
||
|
|
(command.type && command.type !== this.type) ||
|
||
|
|
// Future proof for options being nullable
|
||
|
|
// TODO: remove ?? 0 on each when nullable
|
||
|
|
(command.options?.length ?? 0) !== (this.options?.length ?? 0) ||
|
||
|
|
(command.defaultPermission ?? command.default_permission ?? true) !== this.defaultPermission
|
||
|
|
) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (command.options) {
|
||
|
|
return this.constructor.optionsEqual(this.options, command.options, enforceOptionOrder);
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Recursively checks that all options for an {@link ApplicationCommand} are equal to the provided options.
|
||
|
|
* In most cases it is better to compare using {@link ApplicationCommand#equals}
|
||
|
|
* @param {ApplicationCommandOptionData[]} existing The options on the existing command,
|
||
|
|
* should be {@link ApplicationCommand#options}
|
||
|
|
* @param {ApplicationCommandOptionData[]|APIApplicationCommandOption[]} options The options to compare against
|
||
|
|
* @param {boolean} [enforceOptionOrder=false] Whether to strictly check that options and choices are in the same
|
||
|
|
* order in the array <info>The client may not always respect this ordering!</info>
|
||
|
|
* @returns {boolean}
|
||
|
|
*/
|
||
|
|
static optionsEqual(existing, options, enforceOptionOrder = false) {
|
||
|
|
if (existing.length !== options.length) return false;
|
||
|
|
if (enforceOptionOrder) {
|
||
|
|
return existing.every((option, index) => this._optionEquals(option, options[index], enforceOptionOrder));
|
||
|
|
}
|
||
|
|
const newOptions = new Map(options.map(option => [option.name, option]));
|
||
|
|
for (const option of existing) {
|
||
|
|
const foundOption = newOptions.get(option.name);
|
||
|
|
if (!foundOption || !this._optionEquals(option, foundOption)) return false;
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks that an option for an {@link ApplicationCommand} is equal to the provided option
|
||
|
|
* In most cases it is better to compare using {@link ApplicationCommand#equals}
|
||
|
|
* @param {ApplicationCommandOptionData} existing The option on the existing command,
|
||
|
|
* should be from {@link ApplicationCommand#options}
|
||
|
|
* @param {ApplicationCommandOptionData|APIApplicationCommandOption} option The option to compare against
|
||
|
|
* @param {boolean} [enforceOptionOrder=false] Whether to strictly check that options or choices are in the same
|
||
|
|
* order in their array <info>The client may not always respect this ordering!</info>
|
||
|
|
* @returns {boolean}
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
static _optionEquals(existing, option, enforceOptionOrder = false) {
|
||
|
|
if (
|
||
|
|
option.name !== existing.name ||
|
||
|
|
option.type !== existing.type ||
|
||
|
|
option.description !== existing.description ||
|
||
|
|
option.autocomplete !== existing.autocomplete ||
|
||
|
|
(option.required ??
|
||
|
|
([ApplicationCommandOptionType.Subcommand, ApplicationCommandOptionType.SubcommandGroup].includes(option.type)
|
||
|
|
? undefined
|
||
|
|
: false)) !== existing.required ||
|
||
|
|
option.choices?.length !== existing.choices?.length ||
|
||
|
|
option.options?.length !== existing.options?.length ||
|
||
|
|
(option.channelTypes ?? option.channel_types)?.length !== existing.channelTypes?.length ||
|
||
|
|
(option.minValue ?? option.min_value) !== existing.minValue ||
|
||
|
|
(option.maxValue ?? option.max_value) !== existing.maxValue
|
||
|
|
) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (existing.choices) {
|
||
|
|
if (
|
||
|
|
enforceOptionOrder &&
|
||
|
|
!existing.choices.every(
|
||
|
|
(choice, index) => choice.name === option.choices[index].name && choice.value === option.choices[index].value,
|
||
|
|
)
|
||
|
|
) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
if (!enforceOptionOrder) {
|
||
|
|
const newChoices = new Map(option.choices.map(choice => [choice.name, choice]));
|
||
|
|
for (const choice of existing.choices) {
|
||
|
|
const foundChoice = newChoices.get(choice.name);
|
||
|
|
if (!foundChoice || foundChoice.value !== choice.value) return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (existing.channelTypes) {
|
||
|
|
const newTypes = option.channelTypes ?? option.channel_types;
|
||
|
|
for (const type of existing.channelTypes) {
|
||
|
|
if (!newTypes.includes(type)) return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (existing.options) {
|
||
|
|
return this.optionsEqual(existing.options, option.options, enforceOptionOrder);
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An option for an application command or subcommand.
|
||
|
|
* @typedef {Object} ApplicationCommandOption
|
||
|
|
* @property {ApplicationCommandOptionType} type The type of the option
|
||
|
|
* @property {string} name The name of the option
|
||
|
|
* @property {string} description The description of the option
|
||
|
|
* @property {boolean} [required] Whether the option is required
|
||
|
|
* @property {boolean} [autocomplete] Whether the autocomplete interaction is enabled for a
|
||
|
|
* {@link ApplicationCommandOptionType.String}, {@link ApplicationCommandOptionType.Integer} or
|
||
|
|
* {@link ApplicationCommandOptionType.Number} option
|
||
|
|
* @property {ApplicationCommandOptionChoice[]} [choices] The choices of the option for the user to pick from
|
||
|
|
* @property {ApplicationCommandOption[]} [options] Additional options if this option is a subcommand (group)
|
||
|
|
* @property {ChannelType[]} [channelTypes] When the option type is channel,
|
||
|
|
* the allowed types of channels that can be selected
|
||
|
|
* @property {number} [minValue] The minimum value for an {@link ApplicationCommandOptionType.Integer} or
|
||
|
|
* {@link ApplicationCommandOptionType.Number} option
|
||
|
|
* @property {number} [maxValue] The maximum value for an {@link ApplicationCommandOptionType.Integer} or
|
||
|
|
* {@link ApplicationCommandOptionType.Number} option
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A choice for an application command option.
|
||
|
|
* @typedef {Object} ApplicationCommandOptionChoice
|
||
|
|
* @property {string} name The name of the choice
|
||
|
|
* @property {string|number} value The value of the choice
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Transforms an {@link ApplicationCommandOptionData} object into something that can be used with the API.
|
||
|
|
* @param {ApplicationCommandOptionData} option The option to transform
|
||
|
|
* @param {boolean} [received] Whether this option has been received from Discord
|
||
|
|
* @returns {APIApplicationCommandOption}
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
static transformOption(option, received) {
|
||
|
|
const channelTypesKey = received ? 'channelTypes' : 'channel_types';
|
||
|
|
const minValueKey = received ? 'minValue' : 'min_value';
|
||
|
|
const maxValueKey = received ? 'maxValue' : 'max_value';
|
||
|
|
return {
|
||
|
|
type: option.type,
|
||
|
|
name: option.name,
|
||
|
|
description: option.description,
|
||
|
|
required:
|
||
|
|
option.required ??
|
||
|
|
(option.type === ApplicationCommandOptionType.Subcommand ||
|
||
|
|
option.type === ApplicationCommandOptionType.SubcommandGroup
|
||
|
|
? undefined
|
||
|
|
: false),
|
||
|
|
autocomplete: option.autocomplete,
|
||
|
|
choices: option.choices,
|
||
|
|
options: option.options?.map(o => this.transformOption(o, received)),
|
||
|
|
[channelTypesKey]: option.channelTypes ?? option.channel_types,
|
||
|
|
[minValueKey]: option.minValue ?? option.min_value,
|
||
|
|
[maxValueKey]: option.maxValue ?? option.max_value,
|
||
|
|
};
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
module.exports = ApplicationCommand;
|
||
|
|
|
||
|
|
/* eslint-disable max-len */
|
||
|
|
/**
|
||
|
|
* @external APIApplicationCommand
|
||
|
|
* @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-structure}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @external APIApplicationCommandOption
|
||
|
|
* @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure}
|
||
|
|
*/
|