@velliajs/discord 1.0.2 → 1.0.4

package/src/util/DataResolver.js

@@ -7,59 +7,29 @@ const { fetch } = require('undici');
 const { DiscordjsError, DiscordjsTypeError, ErrorCodes } = require('../errors');
 const Invite = require('../structures/Invite');
 
-/**
- * The DataResolver identifies different objects and tries to resolve a specific piece of information from them.
- * @private
- */
+
 class DataResolver extends null {
-  /**
-   * Data that can be resolved to give an invite code. This can be:
-   * * An invite code
-   * * An invite URL
-   * @typedef {string} InviteResolvable
-   */
-
-  /**
-   * Data that can be resolved to give a template code. This can be:
-   * * A template code
-   * * A template URL
-   * @typedef {string} GuildTemplateResolvable
-   */
-
-  /**
-   * Resolves the string to a code based on the passed regex.
-   * @param {string} data The string to resolve
-   * @param {RegExp} regex The RegExp used to extract the code
-   * @returns {string}
-   */
+  
+
+  
+
+  
   static resolveCode(data, regex) {
     return regex.exec(data)?.[1] ?? data;
   }
 
-  /**
-   * Resolves InviteResolvable to an invite code.
-   * @param {InviteResolvable} data The invite resolvable to resolve
-   * @returns {string}
-   */
+  
   static resolveInviteCode(data) {
     return this.resolveCode(data, Invite.InvitesPattern);
   }
 
-  /**
-   * Resolves GuildTemplateResolvable to a template code.
-   * @param {GuildTemplateResolvable} data The template resolvable to resolve
-   * @returns {string}
-   */
+  
   static resolveGuildTemplateCode(data) {
     const GuildTemplate = require('../structures/GuildTemplate');
     return this.resolveCode(data, GuildTemplate.GuildTemplatesPattern);
   }
 
-  /**
-   * Resolves a Base64Resolvable, a string, or a BufferResolvable to a Base 64 image.
-   * @param {BufferResolvable|Base64Resolvable} image The image to be resolved
-   * @returns {Promise<?string>}
-   */
+  
   static async resolveImage(image) {
     if (!image) return null;
     if (typeof image === 'string' && image.startsWith('data:')) {
@@ -69,48 +39,21 @@ class DataResolver extends null {
     return this.resolveBase64(file.data);
   }
 
-  /**
-   * Data that resolves to give a Base64 string, typically for image uploading. This can be:
-   * * A Buffer
-   * * A base64 string
-   * @typedef {Buffer|string} Base64Resolvable
-   */
-
-  /**
-   * Resolves a Base64Resolvable to a Base 64 image.
-   * @param {Base64Resolvable} data The base 64 resolvable you want to resolve
-   * @returns {?string}
-   */
+  
+
+  
   static resolveBase64(data) {
     if (Buffer.isBuffer(data)) return `data:image/jpg;base64,${data.toString('base64')}`;
     return data;
   }
 
-  /**
-   * Data that can be resolved to give a Buffer. This can be:
-   * * A Buffer
-   * * The path to a local file
-   * * A URL <warn>When provided a URL, discord.js will fetch the URL internally in order to create a Buffer.
-   * This can pose a security risk when the URL has not been sanitized</warn>
-   * @typedef {string|Buffer} BufferResolvable
-   */
-
-  /**
-   * @external Stream
-   * @see {@link https://nodejs.org/api/stream.html}
-   */
-
-  /**
-   * @typedef {Object} ResolvedFile
-   * @property {Buffer} data Buffer containing the file data
-   * @property {string} [contentType] Content type of the file
-   */
-
-  /**
-   * Resolves a BufferResolvable to a Buffer.
-   * @param {BufferResolvable|Stream} resource The buffer or stream resolvable to resolve
-   * @returns {Promise<ResolvedFile>}
-   */
+  
+
+  
+
+  
+
+  
   static async resolveFile(resource) {
     if (Buffer.isBuffer(resource)) return { data: resource };
 
@@ -121,7 +64,7 @@ class DataResolver extends null {
     }
 
     if (typeof resource === 'string') {
-      if (/^https?:\/\//.test(resource)) {
+      if (/^https?:\/\
         const res = await fetch(resource);
         return { data: Buffer.from(await res.arrayBuffer()), contentType: res.headers.get('content-type') };
       }

package/src/util/Events.js

@@ -1,87 +1,9 @@
 'use strict';
 
-/**
- * @typedef {Object} Events
- * @property {string} ApplicationCommandPermissionsUpdate applicationCommandPermissionsUpdate
- * @property {string} AutoModerationActionExecution autoModerationActionExecution
- * @property {string} AutoModerationRuleCreate autoModerationRuleCreate
- * @property {string} AutoModerationRuleDelete autoModerationRuleDelete
- * @property {string} AutoModerationRuleUpdate autoModerationRuleUpdate
- * @property {string} CacheSweep cacheSweep
- * @property {string} ChannelCreate channelCreate
- * @property {string} ChannelDelete channelDelete
- * @property {string} ChannelPinsUpdate channelPinsUpdate
- * @property {string} ChannelUpdate channelUpdate
- * @property {string} ClientReady ready
- * @property {string} Debug debug
- * @property {string} Error error
- * @property {string} GuildAuditLogEntryCreate guildAuditLogEntryCreate
- * @property {string} GuildBanAdd guildBanAdd
- * @property {string} GuildBanRemove guildBanRemove
- * @property {string} GuildCreate guildCreate
- * @property {string} GuildDelete guildDelete
- * @property {string} GuildEmojiCreate emojiCreate
- * @property {string} GuildEmojiDelete emojiDelete
- * @property {string} GuildEmojiUpdate emojiUpdate
- * @property {string} GuildIntegrationsUpdate guildIntegrationsUpdate
- * @property {string} GuildMemberAdd guildMemberAdd
- * @property {string} GuildMemberAvailable guildMemberAvailable
- * @property {string} GuildMemberRemove guildMemberRemove
- * @property {string} GuildMembersChunk guildMembersChunk
- * @property {string} GuildMemberUpdate guildMemberUpdate
- * @property {string} GuildRoleCreate roleCreate
- * @property {string} GuildRoleDelete roleDelete
- * @property {string} GuildRoleUpdate roleUpdate
- * @property {string} GuildScheduledEventCreate guildScheduledEventCreate
- * @property {string} GuildScheduledEventDelete guildScheduledEventDelete
- * @property {string} GuildScheduledEventUpdate guildScheduledEventUpdate
- * @property {string} GuildScheduledEventUserAdd guildScheduledEventUserAdd
- * @property {string} GuildScheduledEventUserRemove guildScheduledEventUserRemove
- * @property {string} GuildStickerCreate stickerCreate
- * @property {string} GuildStickerDelete stickerDelete
- * @property {string} GuildStickerUpdate stickerUpdate
- * @property {string} GuildUnavailable guildUnavailable
- * @property {string} GuildUpdate guildUpdate
- * @property {string} InteractionCreate interactionCreate
- * @property {string} Invalidated invalidated
- * @property {string} InviteCreate inviteCreate
- * @property {string} InviteDelete inviteDelete
- * @property {string} MessageBulkDelete messageDeleteBulk
- * @property {string} MessageCreate messageCreate
- * @property {string} MessageDelete messageDelete
- * @property {string} MessageReactionAdd messageReactionAdd
- * @property {string} MessageReactionRemove messageReactionRemove
- * @property {string} MessageReactionRemoveAll messageReactionRemoveAll
- * @property {string} MessageReactionRemoveEmoji messageReactionRemoveEmoji
- * @property {string} MessageUpdate messageUpdate
- * @property {string} PresenceUpdate presenceUpdate
- * @property {string} ShardDisconnect shardDisconnect
- * @property {string} ShardError shardError
- * @property {string} ShardReady shardReady
- * @property {string} ShardReconnecting shardReconnecting
- * @property {string} ShardResume shardResume
- * @property {string} StageInstanceCreate stageInstanceCreate
- * @property {string} StageInstanceDelete stageInstanceDelete
- * @property {string} StageInstanceUpdate stageInstanceUpdate
- * @property {string} ThreadCreate threadCreate
- * @property {string} ThreadDelete threadDelete
- * @property {string} ThreadListSync threadListSync
- * @property {string} ThreadMembersUpdate threadMembersUpdate
- * @property {string} ThreadMemberUpdate threadMemberUpdate
- * @property {string} ThreadUpdate threadUpdate
- * @property {string} TypingStart typingStart
- * @property {string} UserUpdate userUpdate
- * @property {string} VoiceServerUpdate voiceServerUpdate
- * @property {string} VoiceStateUpdate voiceStateUpdate
- * @property {string} Warn warn
- * @property {string} WebhooksUpdate webhookUpdate
- */
 
-// JSDoc for IntelliSense purposes
-/**
- * @type {Events}
- * @ignore
- */
+
+
+
 module.exports = {
   ApplicationCommandPermissionsUpdate: 'applicationCommandPermissionsUpdate',
   AutoModerationActionExecution: 'autoModerationActionExecution',

package/src/util/Formatters.js

@@ -21,389 +21,142 @@ const {
   userMention,
 } = require('@discordjs/builders');
 
-/**
- * Formats an application command name and id into an application command mention.
- * @method chatInputApplicationCommandMention
- * @param {string} commandName The name of the application command
- * @param {string|Snowflake} subcommandGroupOrSubOrId
- * The subcommand group name, subcommand name, or application command id
- * @param {string|Snowflake} [subcommandNameOrId] The subcommand name or application command id
- * @param {string} [commandId] The id of the application command
- * @returns {string}
- */
-
-/**
- * Wraps the content inside a code block with an optional language.
- * @method codeBlock
- * @param {string} contentOrLanguage The language to use or content if a second parameter isn't provided
- * @param {string} [content] The content to wrap
- * @returns {string}
- */
-
-/**
- * Wraps the content inside \`backticks\`, which formats it as inline code.
- * @method inlineCode
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Formats the content into italic text.
- * @method italic
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Formats the content into bold text.
- * @method bold
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Formats the content into underscored text.
- * @method underscore
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Formats the content into strike-through text.
- * @method strikethrough
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Formats the content into a quote.
- * <info>This needs to be at the start of the line for Discord to format it.</info>
- * @method quote
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Formats the content into a block quote.
- * <info>This needs to be at the start of the line for Discord to format it.</info>
- * @method blockQuote
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Wraps the URL into `<>`, which stops it from embedding.
- * @method hideLinkEmbed
- * @param {string} content The content to wrap
- * @returns {string}
- */
-
-/**
- * Formats the content and the URL into a masked URL with an optional title.
- * @method hyperlink
- * @param {string} content The content to display
- * @param {string} url The URL the content links to
- * @param {string} [title] The title shown when hovering on the masked link
- * @returns {string}
- */
-
-/**
- * Formats the content into spoiler text.
- * @method spoiler
- * @param {string} content The content to spoiler
- * @returns {string}
- */
-
-/**
- * Formats a user id into a user mention.
- * @method userMention
- * @param {Snowflake} userId The user id to format
- * @returns {string}
- */
-
-/**
- * Formats a channel id into a channel mention.
- * @method channelMention
- * @param {Snowflake} channelId The channel id to format
- * @returns {string}
- */
-
-/**
- * Formats a role id into a role mention.
- * @method roleMention
- * @param {Snowflake} roleId The role id to format
- * @returns {string}
- */
-
-/**
- * Formats an emoji id into a fully qualified emoji identifier.
- * @method formatEmoji
- * @param {Snowflake} emojiId The emoji id to format
- * @param {boolean} [animated=false] Whether the emoji is animated
- * @returns {string}
- */
-
-/**
- * Formats a channel link for a channel.
- * @method channelLink
- * @param {Snowflake} channelId The id of the channel
- * @param {Snowflake} [guildId] The id of the guild
- * @returns {string}
- */
-
-/**
- * Formats a message link for a channel.
- * @method messageLink
- * @param {Snowflake} channelId The id of the channel
- * @param {Snowflake} messageId The id of the message
- * @param {Snowflake} [guildId] The id of the guild
- * @returns {string}
- */
-
-/**
- * A message formatting timestamp style, as defined in
- * [here](https://discord.com/developers/docs/reference#message-formatting-timestamp-styles).
- * * `t` Short time format, consisting of hours and minutes, e.g. 16:20.
- * * `T` Long time format, consisting of hours, minutes, and seconds, e.g. 16:20:30.
- * * `d` Short date format, consisting of day, month, and year, e.g. 20/04/2021.
- * * `D` Long date format, consisting of day, month, and year, e.g. 20 April 2021.
- * * `f` Short date-time format, consisting of short date and short time formats, e.g. 20 April 2021 16:20.
- * * `F` Long date-time format, consisting of long date and short time formats, e.g. Tuesday, 20 April 2021 16:20.
- * * `R` Relative time format, consisting of a relative duration format, e.g. 2 months ago.
- * @typedef {string} TimestampStylesString
- */
-
-/**
- * Formats a date into a short date-time string.
- * @method time
- * @param {number|Date} [date] The date to format
- * @param {TimestampStylesString} [style] The style to use
- * @returns {string}
- */
-
-/**
- * Contains various Discord-specific functions for formatting messages.
- * @deprecated This class is redundant as all methods of the class can be imported from discord.js directly.
- */
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 class Formatters extends null {
-  /**
-   * Formats the content into a block quote.
-   * <info>This needs to be at the start of the line for Discord to format it.</info>
-   * @method blockQuote
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static blockQuote = deprecate(
     blockQuote,
     'Formatters.blockQuote() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats the content into bold text.
-   * @method bold
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static bold = deprecate(
     bold,
     'Formatters.bold() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats a channel id into a channel mention.
-   * @method channelMention
-   * @memberof Formatters
-   * @param {Snowflake} channelId The channel id to format
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static channelMention = deprecate(
     channelMention,
     'Formatters.channelMention() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Wraps the content inside a code block with an optional language.
-   * @method codeBlock
-   * @memberof Formatters
-   * @param {string} contentOrLanguage The language to use or content if a second parameter isn't provided
-   * @param {string} [content] The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static codeBlock = deprecate(
     codeBlock,
     'Formatters.codeBlock() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats an emoji id into a fully qualified emoji identifier.
-   * @method formatEmoji
-   * @memberof Formatters
-   * @param {string} emojiId The emoji id to format
-   * @param {boolean} [animated=false] Whether the emoji is animated
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static formatEmoji = deprecate(
     formatEmoji,
     'Formatters.formatEmoji() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Wraps the URL into `<>`, which stops it from embedding.
-   * @method hideLinkEmbed
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static hideLinkEmbed = deprecate(
     hideLinkEmbed,
     'Formatters.hideLinkEmbed() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats the content and the URL into a masked URL with an optional title.
-   * @method hyperlink
-   * @memberof Formatters
-   * @param {string} content The content to display
-   * @param {string} url The URL the content links to
-   * @param {string} [title] The title shown when hovering on the masked link
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static hyperlink = deprecate(
     hyperlink,
     'Formatters.hyperlink() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Wraps the content inside \`backticks\`, which formats it as inline code.
-   * @method inlineCode
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static inlineCode = deprecate(
     inlineCode,
     'Formatters.inlineCode() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats the content into italic text.
-   * @method italic
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static italic = deprecate(
     italic,
     'Formatters.italic() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats the content into a quote. This needs to be at the start of the line for Discord to format it.
-   * @method quote
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static quote = deprecate(
     quote,
     'Formatters.quote() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats a role id into a role mention.
-   * @method roleMention
-   * @memberof Formatters
-   * @param {Snowflake} roleId The role id to format
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static roleMention = deprecate(
     roleMention,
     'Formatters.roleMention() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats the content into spoiler text.
-   * @method spoiler
-   * @memberof Formatters
-   * @param {string} content The content to spoiler
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static spoiler = deprecate(
     spoiler,
     'Formatters.spoiler() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats the content into strike-through text.
-   * @method strikethrough
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static strikethrough = deprecate(
     strikethrough,
     'Formatters.strikethrough() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats a date into a short date-time string.
-   * @method time
-   * @memberof Formatters
-   * @param {number|Date} [date] The date to format
-   * @param {TimestampStylesString} [style] The style to use
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static time = deprecate(
     time,
     'Formatters.time() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * The message formatting timestamp
-   * [styles](https://discord.com/developers/docs/reference#message-formatting-timestamp-styles) supported by Discord.
-   * @type {Object<string, TimestampStylesString>}
-   * @memberof Formatters
-   * @deprecated Import this property directly from discord.js instead.
-   */
+  
   static TimestampStyles = TimestampStyles;
 
-  /**
-   * Formats the content into underscored text.
-   * @method underscore
-   * @memberof Formatters
-   * @param {string} content The content to wrap
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static underscore = deprecate(
     underscore,
     'Formatters.underscore() is deprecated. Import this method directly from discord.js instead.',
   );
 
-  /**
-   * Formats a user id into a user mention.
-   * @method userMention
-   * @memberof Formatters
-   * @param {Snowflake} userId The user id to format
-   * @returns {string}
-   * @deprecated Import this method directly from discord.js instead.
-   */
+  
   static userMention = deprecate(
     userMention,
     'Formatters.userMention() is deprecated. Import this method directly from discord.js instead.',