@velliajs/discord 1.0.2 → 1.0.4

package/src/errors/ErrorCodes.js

@@ -1,165 +1,6 @@
 'use strict';
 
-/**
- * @typedef {Object} DiscordjsErrorCodes
-
- * @property {'ClientInvalidOption'} ClientInvalidOption
- * @property {'ClientInvalidProvidedShards'} ClientInvalidProvidedShards
- * @property {'ClientMissingIntents'} ClientMissingIntents
- * @property {'ClientNotReady'} ClientNotReady
-
- * @property {'TokenInvalid'} TokenInvalid
- * @property {'TokenMissing'} TokenMissing
- * @property {'ApplicationCommandPermissionsTokenMissing'} ApplicationCommandPermissionsTokenMissing
-
- * @property {'WSCloseRequested'} WSCloseRequested
- * <warn>This property is deprecated.</warn>
- * @property {'WSConnectionExists'} WSConnectionExists
- * <warn>This property is deprecated.</warn>
- * @property {'WSNotOpen'} WSNotOpen
- * <warn>This property is deprecated.</warn>
- * @property {'ManagerDestroyed'} ManagerDestroyed
-
- * @property {'BitFieldInvalid'} BitFieldInvalid
-
- * @property {'ShardingInvalid'} ShardingInvalid
- * <warn>This property is deprecated.</warn>
- * @property {'ShardingRequired'} ShardingRequired
- * <warn>This property is deprecated.</warn>
- * @property {'InvalidIntents'} InvalidIntents
- * <warn>This property is deprecated.</warn>
- * @property {'DisallowedIntents'} DisallowedIntents
- * <warn>This property is deprecated.</warn>
- * @property {'ShardingNoShards'} ShardingNoShards
- * @property {'ShardingInProcess'} ShardingInProcess
- * @property {'ShardingInvalidEvalBroadcast'} ShardingInvalidEvalBroadcast
- * @property {'ShardingShardNotFound'} ShardingShardNotFound
- * @property {'ShardingAlreadySpawned'} ShardingAlreadySpawned
- * @property {'ShardingProcessExists'} ShardingProcessExists
- * @property {'ShardingWorkerExists'} ShardingWorkerExists
- * @property {'ShardingReadyTimeout'} ShardingReadyTimeout
- * @property {'ShardingReadyDisconnected'} ShardingReadyDisconnected
- * @property {'ShardingReadyDied'} ShardingReadyDied
- * @property {'ShardingNoChildExists'} ShardingNoChildExists
- * @property {'ShardingShardMiscalculation'} ShardingShardMiscalculation
-
- * @property {'ColorRange'} ColorRange
- * @property {'ColorConvert'} ColorConvert
-
- * @property {'InviteOptionsMissingChannel'} InviteOptionsMissingChannel
-
- * @property {'ButtonLabel'} ButtonLabel
- * @property {'ButtonURL'} ButtonURL
- * @property {'ButtonCustomId'} ButtonCustomId
-
- * @property {'SelectMenuCustomId'} SelectMenuCustomId
- * @property {'SelectMenuPlaceholder'} SelectMenuPlaceholder
- * @property {'SelectOptionLabel'} SelectOptionLabel
- * @property {'SelectOptionValue'} SelectOptionValue
- * @property {'SelectOptionDescription'} SelectOptionDescription
 
- * @property {'InteractionCollectorError'} InteractionCollectorError
-
- * @property {'FileNotFound'} FileNotFound
-
- * @property {'UserBannerNotFetched'} UserBannerNotFetched
- * @property {'UserNoDMChannel'} UserNoDMChannel
-
- * @property {'VoiceNotStageChannel'} VoiceNotStageChannel
-
- * @property {'VoiceStateNotOwn'} VoiceStateNotOwn
- * @property {'VoiceStateInvalidType'} VoiceStateInvalidType
-
- * @property {'ReqResourceType'} ReqResourceType
-
- * @property {'ImageFormat'} ImageFormat
- * @property {'ImageSize'} ImageSize
-
- * @property {'MessageBulkDeleteType'} MessageBulkDeleteType
- * @property {'MessageNonceType'} MessageNonceType
- * @property {'MessageContentType'} MessageContentType
-
- * @property {'SplitMaxLen'} SplitMaxLen
-
- * @property {'BanResolveId'} BanResolveId
- * @property {'FetchBanResolveId'} FetchBanResolveId
-
- * @property {'PruneDaysType'} PruneDaysType
-
- * @property {'GuildChannelResolve'} GuildChannelResolve
- * @property {'GuildVoiceChannelResolve'} GuildVoiceChannelResolve
- * @property {'GuildChannelOrphan'} GuildChannelOrphan
- * @property {'GuildChannelUnowned'} GuildChannelUnowned
- * @property {'GuildOwned'} GuildOwned
- * @property {'GuildMembersTimeout'} GuildMembersTimeout
- * @property {'GuildUncachedMe'} GuildUncachedMe
- * @property {'ChannelNotCached'} ChannelNotCached
- * @property {'StageChannelResolve'} StageChannelResolve
- * @property {'GuildScheduledEventResolve'} GuildScheduledEventResolve
- * @property {'FetchOwnerId'} FetchOwnerId
-
- * @property {'InvalidType'} InvalidType
- * @property {'InvalidElement'} InvalidElement
-
- * @property {'MessageThreadParent'} MessageThreadParent
- * @property {'MessageExistingThread'} MessageExistingThread
- * @property {'ThreadInvitableType'} ThreadInvitableType
-
- * @property {'WebhookMessage'} WebhookMessage
- * @property {'WebhookTokenUnavailable'} WebhookTokenUnavailable
- * @property {'WebhookURLInvalid'} WebhookURLInvalid
- * @property {'WebhookApplication'} WebhookApplication
- * @property {'MessageReferenceMissing'} MessageReferenceMissing
-
- * @property {'EmojiType'} EmojiType
- * @property {'EmojiManaged'} EmojiManaged
- * @property {'MissingManageGuildExpressionsPermission'} MissingManageGuildExpressionsPermission
- * @property {'MissingManageEmojisAndStickersPermission'} MissingManageEmojisAndStickersPermission
- * <warn>This property is deprecated. Use `MissingManageGuildExpressionsPermission` instead.</warn>
- *
- * @property {'NotGuildSticker'} NotGuildSticker
-
- * @property {'ReactionResolveUser'} ReactionResolveUser
-
- * @property {'VanityURL'} VanityURL
-
- * @property {'InviteResolveCode'} InviteResolveCode
-
- * @property {'InviteNotFound'} InviteNotFound
-
- * @property {'DeleteGroupDMChannel'} DeleteGroupDMChannel
- * @property {'FetchGroupDMChannel'} FetchGroupDMChannel
-
- * @property {'MemberFetchNonceLength'} MemberFetchNonceLength
-
- * @property {'GlobalCommandPermissions'} GlobalCommandPermissions
- * @property {'GuildUncachedEntityResolve'} GuildUncachedEntityResolve
-
- * @property {'InteractionAlreadyReplied'} InteractionAlreadyReplied
- * @property {'InteractionNotReplied'} InteractionNotReplied
- * @property {'InteractionEphemeralReplied'} InteractionEphemeralReplied
- * <warn>This property is deprecated.</warn>
-
- * @property {'CommandInteractionOptionNotFound'} CommandInteractionOptionNotFound
- * @property {'CommandInteractionOptionType'} CommandInteractionOptionType
- * @property {'CommandInteractionOptionEmpty'} CommandInteractionOptionEmpty
- * @property {'CommandInteractionOptionNoSubcommand'} CommandInteractionOptionNoSubcommand
- * @property {'CommandInteractionOptionNoSubcommandGroup'} CommandInteractionOptionNoSubcommandGroup
- * @property {'CommandInteractionOptionInvalidChannelType'} CommandInteractionOptionInvalidChannelType
- * @property {'AutocompleteInteractionOptionNoFocusedOption'} AutocompleteInteractionOptionNoFocusedOption
-
- * @property {'ModalSubmitInteractionFieldNotFound'} ModalSubmitInteractionFieldNotFound
- * @property {'ModalSubmitInteractionFieldType'} ModalSubmitInteractionFieldType
-
- * @property {'InvalidMissingScopes'} InvalidMissingScopes
- * @property {'InvalidScopesWithPermissions'} InvalidScopesWithPermissions
-
- * @property {'NotImplemented'} NotImplemented
-
- * @property {'GuildForumMessageRequired'} GuildForumMessageRequired
-
- * @property {'SweepFilterReturn'} SweepFilterReturn
- */
 
 const keys = [
   'ClientInvalidOption',
@@ -311,9 +152,6 @@ const keys = [
   'GuildForumMessageRequired',
 ];
 
-// JSDoc for IntelliSense purposes
-/**
- * @type {DiscordjsErrorCodes}
- * @ignore
- */
+
+
 module.exports = Object.fromEntries(keys.map(key => [key, key]));

package/src/index.js

@@ -2,7 +2,7 @@
 
 const { __exportStar } = require('tslib');
 
-// "Root" classes (starting points)
+
 exports.BaseClient = require('./client/BaseClient');
 exports.Client = require('./client/Client');
 exports.Shard = require('./sharding/Shard');
@@ -10,13 +10,13 @@ exports.ShardClientUtil = require('./sharding/ShardClientUtil');
 exports.ShardingManager = require('./sharding/ShardingManager');
 exports.WebhookClient = require('./client/WebhookClient');
 
-// Errors
+
 exports.DiscordjsError = require('./errors/DJSError').DiscordjsError;
 exports.DiscordjsTypeError = require('./errors/DJSError').DiscordjsTypeError;
 exports.DiscordjsRangeError = require('./errors/DJSError').DiscordjsRangeError;
 exports.DiscordjsErrorCodes = require('./errors/ErrorCodes');
 
-// Utilities
+
 exports.ActivityFlagsBitField = require('./util/ActivityFlagsBitField');
 exports.ApplicationFlagsBitField = require('./util/ApplicationFlagsBitField');
 exports.BaseManager = require('./managers/BaseManager');
@@ -46,7 +46,7 @@ __exportStar(require('./util/Util.js'), exports);
 exports.WebSocketShardEvents = require('./util/WebSocketShardEvents');
 exports.version = require('../package.json').version;
 
-// Managers
+
 exports.ApplicationCommandManager = require('./managers/ApplicationCommandManager');
 exports.ApplicationCommandPermissionsManager = require('./managers/ApplicationCommandPermissionsManager');
 exports.AutoModerationRuleManager = require('./managers/AutoModerationRuleManager');
@@ -82,7 +82,7 @@ exports.VoiceStateManager = require('./managers/VoiceStateManager');
 exports.WebSocketManager = require('./client/websocket/WebSocketManager');
 exports.WebSocketShard = require('./client/websocket/WebSocketShard');
 
-// Structures
+
 exports.ActionRow = require('./structures/ActionRow');
 exports.ActionRowBuilder = require('./structures/ActionRowBuilder');
 exports.Activity = require('./structures/Presence').Activity;
@@ -204,7 +204,7 @@ exports.WidgetMember = require('./structures/WidgetMember');
 exports.WelcomeChannel = require('./structures/WelcomeChannel');
 exports.WelcomeScreen = require('./structures/WelcomeScreen');
 
-// External
+
 __exportStar(require('discord-api-types/v10'), exports);
 __exportStar(require('@discordjs/builders'), exports);
 __exportStar(require('@discordjs/formatters'), exports);

package/src/managers/ApplicationCommandManager.js

@@ -10,39 +10,22 @@ const { DiscordjsTypeError, ErrorCodes } = require('../errors');
 const ApplicationCommand = require('../structures/ApplicationCommand');
 const PermissionsBitField = require('../util/PermissionsBitField');
 
-/**
- * Manages API methods for application commands and stores their cache.
- * @extends {CachedManager}
- */
+
 class ApplicationCommandManager extends CachedManager {
   constructor(client, iterable) {
     super(client, ApplicationCommand, iterable);
 
-    /**
-     * The manager for permissions of arbitrary commands on arbitrary guilds
-     * @type {ApplicationCommandPermissionsManager}
-     */
+    
     this.permissions = new ApplicationCommandPermissionsManager(this);
   }
 
-  /**
-   * The cache of this manager
-   * @type {Collection<Snowflake, ApplicationCommand>}
-   * @name ApplicationCommandManager#cache
-   */
+  
 
   _add(data, cache, guildId) {
     return super._add(data, cache, { extras: [this.guild, guildId] });
   }
 
-  /**
-   * The APIRouter path to the commands
-   * @param {Snowflake} [options.id] The application command's id
-   * @param {Snowflake} [options.guildId] The guild's id to use in the path,
-   * ignored when using a {@link GuildApplicationCommandManager}
-   * @returns {string}
-   * @private
-   */
+  
   commandPath({ id, guildId } = {}) {
     if (this.guild ?? guildId) {
       if (id) {
@@ -59,49 +42,15 @@ class ApplicationCommandManager extends CachedManager {
     return Routes.applicationCommands(this.client.application.id);
   }
 
-  /**
-   * Data that resolves to give an ApplicationCommand object. This can be:
-   * * An ApplicationCommand object
-   * * A Snowflake
-   * @typedef {ApplicationCommand|Snowflake} ApplicationCommandResolvable
-   */
+  
 
-  /**
-   * Data that resolves to the data of an ApplicationCommand
-   * @typedef {ApplicationCommandData|APIApplicationCommand} ApplicationCommandDataResolvable
-   */
+  
 
-  /**
-   * Options used to fetch data from Discord
-   * @typedef {Object} BaseFetchOptions
-   * @property {boolean} [cache=true] Whether to cache the fetched data if it wasn't already
-   * @property {boolean} [force=false] Whether to skip the cache check and request the API
-   */
+  
 
-  /**
-   * Options used to fetch Application Commands from Discord
-   * @typedef {BaseFetchOptions} FetchApplicationCommandOptions
-   * @property {Snowflake} [guildId] The guild's id to fetch commands for, for when the guild is not cached
-   * @property {LocaleString} [locale] The locale to use when fetching this command
-   * @property {boolean} [withLocalizations] Whether to fetch all localization data
-   */
+  
 
-  /**
-   * Obtains one or multiple application commands from Discord, or the cache if it's already available.
-   * @param {Snowflake} [id] The application command's id
-   * @param {FetchApplicationCommandOptions} [options] Additional options for this fetch
-   * @returns {Promise<ApplicationCommand|Collection<Snowflake, ApplicationCommand>>}
-   * @example
-   * // Fetch a single command
-   * client.application.commands.fetch('123456789012345678')
-   *   .then(command => console.log(`Fetched command ${command.name}`))
-   *   .catch(console.error);
-   * @example
-   * // Fetch all commands
-   * guild.commands.fetch()
-   *   .then(commands => console.log(`Fetched ${commands.size} commands`))
-   *   .catch(console.error);
-   */
+  
   async fetch(id, { guildId, cache = true, force = false, locale, withLocalizations } = {}) {
     if (typeof id === 'object') {
       ({ guildId, cache = true, locale, withLocalizations } = id);
@@ -123,21 +72,7 @@ class ApplicationCommandManager extends CachedManager {
     return data.reduce((coll, command) => coll.set(command.id, this._add(command, cache, guildId)), new Collection());
   }
 
-  /**
-   * Creates an application command.
-   * @param {ApplicationCommandDataResolvable} command The command
-   * @param {Snowflake} [guildId] The guild's id to create this command in,
-   * ignored when using a {@link GuildApplicationCommandManager}
-   * @returns {Promise<ApplicationCommand>}
-   * @example
-   * // Create a new command
-   * client.application.commands.create({
-   *   name: 'test',
-   *   description: 'A test command',
-   * })
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
   async create(command, guildId) {
     const data = await this.client.rest.post(this.commandPath({ guildId }), {
       body: this.constructor.transformCommand(command),
@@ -145,28 +80,7 @@ class ApplicationCommandManager extends CachedManager {
     return this._add(data, true, guildId);
   }
 
-  /**
-   * Sets all the commands for this application or guild.
-   * @param {ApplicationCommandDataResolvable[]} commands The commands
-   * @param {Snowflake} [guildId] The guild's id to create the commands in,
-   * ignored when using a {@link GuildApplicationCommandManager}
-   * @returns {Promise<Collection<Snowflake, ApplicationCommand>>}
-   * @example
-   * // Set all commands to just this one
-   * client.application.commands.set([
-   *   {
-   *     name: 'test',
-   *     description: 'A test command',
-   *   },
-   * ])
-   *   .then(console.log)
-   *   .catch(console.error);
-   * @example
-   * // Remove all commands
-   * guild.commands.set([])
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
   async set(commands, guildId) {
     const data = await this.client.rest.put(this.commandPath({ guildId }), {
       body: commands.map(c => this.constructor.transformCommand(c)),
@@ -174,21 +88,7 @@ class ApplicationCommandManager extends CachedManager {
     return data.reduce((coll, command) => coll.set(command.id, this._add(command, true, guildId)), new Collection());
   }
 
-  /**
-   * Edits an application command.
-   * @param {ApplicationCommandResolvable} command The command to edit
-   * @param {Partial<ApplicationCommandDataResolvable>} data The data to update the command with
-   * @param {Snowflake} [guildId] The guild's id where the command registered,
-   * ignored when using a {@link GuildApplicationCommandManager}
-   * @returns {Promise<ApplicationCommand>}
-   * @example
-   * // Edit an existing command
-   * client.application.commands.edit('123456789012345678', {
-   *   description: 'New description',
-   * })
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
   async edit(command, data, guildId) {
     const id = this.resolveId(command);
     if (!id) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'command', 'ApplicationCommandResolvable');
@@ -199,18 +99,7 @@ class ApplicationCommandManager extends CachedManager {
     return this._add(patched, true, guildId);
   }
 
-  /**
-   * Deletes an application command.
-   * @param {ApplicationCommandResolvable} command The command to delete
-   * @param {Snowflake} [guildId] The guild's id where the command is registered,
-   * ignored when using a {@link GuildApplicationCommandManager}
-   * @returns {Promise<?ApplicationCommand>}
-   * @example
-   * // Delete a command
-   * guild.commands.delete('123456789012345678')
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
   async delete(command, guildId) {
     const id = this.resolveId(command);
     if (!id) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'command', 'ApplicationCommandResolvable');
@@ -222,12 +111,7 @@ class ApplicationCommandManager extends CachedManager {
     return cached ?? null;
   }
 
-  /**
-   * Transforms an {@link ApplicationCommandData} object into something that can be used with the API.
-   * @param {ApplicationCommandDataResolvable} command The command to transform
-   * @returns {APIApplicationCommand}
-   * @private
-   */
+  
   static transformCommand(command) {
     if (isJSONEncodable(command)) return command.toJSON();