@velliajs/discord 1.0.0

package/src/util/ChannelFlagsBitField.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const { ChannelFlags } = require('discord-api-types/v10');
+const BitField = require('./BitField');
+
+/**
+ * Data structure that makes it easy to interact with a {@link BaseChannel#flags} bitfield.
+ * @extends {BitField}
+ */
+class ChannelFlagsBitField extends BitField {
+  /**
+   * Numeric guild channel flags.
+   * @type {ChannelFlags}
+   * @memberof ChannelFlagsBitField
+   */
+  static Flags = ChannelFlags;
+}
+
+/**
+ * @name ChannelFlagsBitField
+ * @kind constructor
+ * @memberof ChannelFlagsBitField
+ * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
+ */
+
+/**
+ * Bitfield of the packed bits
+ * @type {number}
+ * @name ChannelFlagsBitField#bitfield
+ */
+
+/**
+ * Data that can be resolved to give a channel flag bitfield. This can be:
+ * * A string (see {@link ChannelFlagsBitField.Flags})
+ * * A channel flag
+ * * An instance of ChannelFlagsBitField
+ * * An Array of ChannelFlagsResolvable
+ * @typedef {string|number|ChannelFlagsBitField|ChannelFlagsResolvable[]} ChannelFlagsResolvable
+ */
+
+module.exports = ChannelFlagsBitField;

package/src/util/Channels.js

@@ -0,0 +1,150 @@
+'use strict';
+
+const { lazy } = require('@discordjs/util');
+const { ChannelType } = require('discord-api-types/v10');
+
+const getCategoryChannel = lazy(() => require('../structures/CategoryChannel'));
+const getDMChannel = lazy(() => require('../structures/DMChannel'));
+const getNewsChannel = lazy(() => require('../structures/NewsChannel'));
+const getStageChannel = lazy(() => require('../structures/StageChannel'));
+const getTextChannel = lazy(() => require('../structures/TextChannel'));
+const getThreadChannel = lazy(() => require('../structures/ThreadChannel'));
+const getVoiceChannel = lazy(() => require('../structures/VoiceChannel'));
+const getDirectoryChannel = lazy(() => require('../structures/DirectoryChannel'));
+const getPartialGroupDMChannel = lazy(() => require('../structures/PartialGroupDMChannel'));
+const getForumChannel = lazy(() => require('../structures/ForumChannel'));
+
+/**
+ * Creates a discord.js channel from data received from the API.
+ * @param {Client} client The client
+ * @param {APIChannel} data The data of the channel to create
+ * @param {Guild} [guild] The guild where this channel belongs
+ * @param {Object} [extras] Extra information to supply for creating this channel
+ * @returns {Channel} Any kind of channel.
+ * @ignore
+ */
+function createChannel(client, data, guild, { allowUnknownGuild } = {}) {
+  let channel;
+  if (!data.guild_id && !guild) {
+    if ((data.recipients && data.type !== ChannelType.GroupDM) || data.type === ChannelType.DM) {
+      channel = new (getDMChannel())(client, data);
+    } else if (data.type === ChannelType.GroupDM) {
+      channel = new (getPartialGroupDMChannel())(client, data);
+    }
+  } else {
+    guild ??= client.guilds.cache.get(data.guild_id);
+
+    if (guild || allowUnknownGuild) {
+      switch (data.type) {
+        case ChannelType.GuildText: {
+          channel = new (getTextChannel())(guild, data, client);
+          break;
+        }
+        case ChannelType.GuildVoice: {
+          channel = new (getVoiceChannel())(guild, data, client);
+          break;
+        }
+        case ChannelType.GuildCategory: {
+          channel = new (getCategoryChannel())(guild, data, client);
+          break;
+        }
+        case ChannelType.GuildAnnouncement: {
+          channel = new (getNewsChannel())(guild, data, client);
+          break;
+        }
+        case ChannelType.GuildStageVoice: {
+          channel = new (getStageChannel())(guild, data, client);
+          break;
+        }
+        case ChannelType.AnnouncementThread:
+        case ChannelType.PublicThread:
+        case ChannelType.PrivateThread: {
+          channel = new (getThreadChannel())(guild, data, client);
+          if (!allowUnknownGuild) channel.parent?.threads.cache.set(channel.id, channel);
+          break;
+        }
+        case ChannelType.GuildDirectory:
+          channel = new (getDirectoryChannel())(guild, data, client);
+          break;
+        case ChannelType.GuildForum:
+          channel = new (getForumChannel())(guild, data, client);
+          break;
+      }
+      if (channel && !allowUnknownGuild) guild.channels?.cache.set(channel.id, channel);
+    }
+  }
+  return channel;
+}
+
+/**
+ * Transforms an API guild forum tag to camel-cased guild forum tag.
+ * @param {APIGuildForumTag} tag The tag to transform
+ * @returns {GuildForumTag}
+ * @ignore
+ */
+function transformAPIGuildForumTag(tag) {
+  return {
+    id: tag.id,
+    name: tag.name,
+    moderated: tag.moderated,
+    emoji:
+      tag.emoji_id ?? tag.emoji_name
+        ? {
+            id: tag.emoji_id,
+            name: tag.emoji_name,
+          }
+        : null,
+  };
+}
+
+/**
+ * Transforms a camel-cased guild forum tag to an API guild forum tag.
+ * @param {GuildForumTag} tag The tag to transform
+ * @returns {APIGuildForumTag}
+ * @ignore
+ */
+function transformGuildForumTag(tag) {
+  return {
+    id: tag.id,
+    name: tag.name,
+    moderated: tag.moderated,
+    emoji_id: tag.emoji?.id ?? null,
+    emoji_name: tag.emoji?.name ?? null,
+  };
+}
+
+/**
+ * Transforms an API guild forum default reaction object to a
+ * camel-cased guild forum default reaction object.
+ * @param {APIGuildForumDefaultReactionEmoji} defaultReaction The default reaction to transform
+ * @returns {DefaultReactionEmoji}
+ * @ignore
+ */
+function transformAPIGuildDefaultReaction(defaultReaction) {
+  return {
+    id: defaultReaction.emoji_id,
+    name: defaultReaction.emoji_name,
+  };
+}
+
+/**
+ * Transforms a camel-cased guild forum default reaction object to an
+ * API guild forum default reaction object.
+ * @param {DefaultReactionEmoji} defaultReaction The default reaction to transform
+ * @returns {APIGuildForumDefaultReactionEmoji}
+ * @ignore
+ */
+function transformGuildDefaultReaction(defaultReaction) {
+  return {
+    emoji_id: defaultReaction.id,
+    emoji_name: defaultReaction.name,
+  };
+}
+
+module.exports = {
+  createChannel,
+  transformAPIGuildForumTag,
+  transformGuildForumTag,
+  transformAPIGuildDefaultReaction,
+  transformGuildDefaultReaction,
+};

package/src/util/Colors.js

@@ -0,0 +1,73 @@
+'use strict';
+
+/**
+ * @typedef {Object} Colors
+ * @property {number} Default 0x000000 | rgb(0,0,0)
+ * @property {number} White 0xFFFFFF | rgb(255,255,255)
+ * @property {number} Aqua 0x1ABC9C | rgb(26,188,156)
+ * @property {number} Green 0x57F287 | rgb(87,242,135)
+ * @property {number} Blue 0x3498DB | rgb(52,152,219)
+ * @property {number} Yellow 0xFEE75C | rgb(254,231,92)
+ * @property {number} Purple 0x9B59B6 | rgb(155,89,182)
+ * @property {number} LuminousVividPink 0xE91E63 | rgb(233,30,99)
+ * @property {number} Fuchsia 0xEB459E | rgb(235,69,158)
+ * @property {number} Gold 0xF1C40F | rgb(241,196,15)
+ * @property {number} Orange 0xE67E22 | rgb(230,126,34)
+ * @property {number} Red 0xED4245 | rgb(237,66,69)
+ * @property {number} Grey 0x95A5A6 | rgb(149,165,166)
+ * @property {number} Navy 0x34495E | rgb(52,73,94)
+ * @property {number} DarkAqua 0x11806A | rgb(17,128,106)
+ * @property {number} DarkGreen 0x1F8B4C | rgb(31,139,76)
+ * @property {number} DarkBlue 0x206694 | rgb(32,102,148)
+ * @property {number} DarkPurple 0x71368A | rgb(113,54,138)
+ * @property {number} DarkVividPink 0xAD1457 | rgb(173,20,87)
+ * @property {number} DarkGold 0xC27C0E | rgb(194,124,14)
+ * @property {number} DarkOrange 0xA84300 | rgb(168,67,0)
+ * @property {number} DarkRed 0x992D22 | rgb(153,45,34)
+ * @property {number} DarkGrey 0x979C9F | rgb(151,156,159)
+ * @property {number} DarkerGrey 0x7F8C8D | rgb(127,140,141)
+ * @property {number} LightGrey 0xBCC0C0 | rgb(188,192,192)
+ * @property {number} DarkNavy 0x2C3E50 | rgb(44,62,80)
+ * @property {number} Blurple 0x5865F2 | rgb(88,101,242)
+ * @property {number} Greyple 0x99AAb5 | rgb(153,170,181)
+ * @property {number} DarkButNotBlack 0x2C2F33 | rgb(44,47,51)
+ * @property {number} NotQuiteBlack 0x23272A | rgb(35,39,42)
+ */
+
+// JSDoc for IntelliSense purposes
+/**
+ * @type {Colors}
+ * @ignore
+ */
+module.exports = {
+  Default: 0x000000,
+  White: 0xffffff,
+  Aqua: 0x1abc9c,
+  Green: 0x57f287,
+  Blue: 0x3498db,
+  Yellow: 0xfee75c,
+  Purple: 0x9b59b6,
+  LuminousVividPink: 0xe91e63,
+  Fuchsia: 0xeb459e,
+  Gold: 0xf1c40f,
+  Orange: 0xe67e22,
+  Red: 0xed4245,
+  Grey: 0x95a5a6,
+  Navy: 0x34495e,
+  DarkAqua: 0x11806a,
+  DarkGreen: 0x1f8b4c,
+  DarkBlue: 0x206694,
+  DarkPurple: 0x71368a,
+  DarkVividPink: 0xad1457,
+  DarkGold: 0xc27c0e,
+  DarkOrange: 0xa84300,
+  DarkRed: 0x992d22,
+  DarkGrey: 0x979c9f,
+  DarkerGrey: 0x7f8c8d,
+  LightGrey: 0xbcc0c0,
+  DarkNavy: 0x2c3e50,
+  Blurple: 0x5865f2,
+  Greyple: 0x99aab5,
+  DarkButNotBlack: 0x2c2f33,
+  NotQuiteBlack: 0x23272a,
+};

package/src/util/Components.js

@@ -0,0 +1,152 @@
+'use strict';
+
+// This file contains the typedefs for camel-cased JSON data
+const { ComponentBuilder } = require('@discordjs/builders');
+const { ComponentType } = require('discord-api-types/v10');
+/**
+ * @typedef {Object} BaseComponentData
+ * @property {ComponentType} type The type of component
+ */
+
+/**
+ * @typedef {BaseComponentData} ActionRowData
+ * @property {ComponentData[]} components The components in this action row
+ */
+
+/**
+ * @typedef {BaseComponentData} ButtonComponentData
+ * @property {ButtonStyle} style The style of the button
+ * @property {?boolean} disabled Whether this button is disabled
+ * @property {string} label The label of this button
+ * @property {?APIMessageComponentEmoji} emoji The emoji on this button
+ * @property {?string} customId The custom id of the button
+ * @property {?string} url The URL of the button
+ */
+
+/**
+ * @typedef {object} SelectMenuComponentOptionData
+ * @property {string} label The label of the option
+ * @property {string} value The value of the option
+ * @property {?string} description The description of the option
+ * @property {?APIMessageComponentEmoji} emoji The emoji on the option
+ * @property {?boolean} default Whether this option is selected by default
+ */
+
+/**
+ * @typedef {BaseComponentData} SelectMenuComponentData
+ * @property {string} customId The custom id of the select menu
+ * @property {?boolean} disabled Whether the select menu is disabled or not
+ * @property {?number} maxValues The maximum amount of options that can be selected
+ * @property {?number} minValues The minimum amount of options that can be selected
+ * @property {?SelectMenuComponentOptionData[]} options The options in this select menu
+ * @property {?string} placeholder The placeholder of the select menu
+ */
+
+/**
+ * @typedef {ActionRowData|ButtonComponentData|SelectMenuComponentData} MessageComponentData
+ */
+
+/**
+ * @typedef {BaseComponentData} TextInputComponentData
+ * @property {string} customId The custom id of the text input
+ * @property {TextInputStyle} style The style of the text input
+ * @property {string} label The text that appears on top of the text input field
+ * @property {?number} minLength The minimum number of characters that can be entered in the text input
+ * @property {?number} maxLength The maximum number of characters that can be entered in the text input
+ * @property {?boolean} required Whether or not the text input is required or not
+ * @property {?string} value The pre-filled text in the text input
+ * @property {?string} placeholder Placeholder for the text input
+ */
+
+/**
+ * @typedef {ActionRowData|ButtonComponentData|SelectMenuComponentData|TextInputComponentData} ComponentData
+ */
+
+/**
+ * Any emoji data that can be used within a button
+ * @typedef {APIMessageComponentEmoji|string} ComponentEmojiResolvable
+ */
+
+/**
+ * Transforms API data into a component
+ * @param {APIMessageComponent|Component} data The data to create the component from
+ * @returns {Component}
+ */
+function createComponent(data) {
+  if (data instanceof Component) {
+    return data;
+  }
+
+  switch (data.type) {
+    case ComponentType.ActionRow:
+      return new ActionRow(data);
+    case ComponentType.Button:
+      return new ButtonComponent(data);
+    case ComponentType.StringSelect:
+      return new StringSelectMenuComponent(data);
+    case ComponentType.TextInput:
+      return new TextInputComponent(data);
+    case ComponentType.UserSelect:
+      return new UserSelectMenuComponent(data);
+    case ComponentType.RoleSelect:
+      return new RoleSelectMenuComponent(data);
+    case ComponentType.MentionableSelect:
+      return new MentionableSelectMenuComponent(data);
+    case ComponentType.ChannelSelect:
+      return new ChannelSelectMenuComponent(data);
+    default:
+      return new Component(data);
+  }
+}
+
+/**
+ * Transforms API data into a component builder
+ * @param {APIMessageComponent|ComponentBuilder} data The data to create the component from
+ * @returns {ComponentBuilder}
+ */
+function createComponentBuilder(data) {
+  if (data instanceof ComponentBuilder) {
+    return data;
+  }
+
+  switch (data.type) {
+    case ComponentType.ActionRow:
+      return new ActionRowBuilder(data);
+    case ComponentType.Button:
+      return new ButtonBuilder(data);
+    case ComponentType.StringSelect:
+      return new StringSelectMenuBuilder(data);
+    case ComponentType.TextInput:
+      return new TextInputBuilder(data);
+    case ComponentType.UserSelect:
+      return new UserSelectMenuBuilder(data);
+    case ComponentType.RoleSelect:
+      return new RoleSelectMenuBuilder(data);
+    case ComponentType.MentionableSelect:
+      return new MentionableSelectMenuBuilder(data);
+    case ComponentType.ChannelSelect:
+      return new ChannelSelectMenuBuilder(data);
+    default:
+      return new ComponentBuilder(data);
+  }
+}
+
+module.exports = { createComponent, createComponentBuilder };
+
+const ActionRow = require('../structures/ActionRow');
+const ActionRowBuilder = require('../structures/ActionRowBuilder');
+const ButtonBuilder = require('../structures/ButtonBuilder');
+const ButtonComponent = require('../structures/ButtonComponent');
+const ChannelSelectMenuBuilder = require('../structures/ChannelSelectMenuBuilder');
+const ChannelSelectMenuComponent = require('../structures/ChannelSelectMenuComponent');
+const Component = require('../structures/Component');
+const MentionableSelectMenuBuilder = require('../structures/MentionableSelectMenuBuilder');
+const MentionableSelectMenuComponent = require('../structures/MentionableSelectMenuComponent');
+const RoleSelectMenuBuilder = require('../structures/RoleSelectMenuBuilder');
+const RoleSelectMenuComponent = require('../structures/RoleSelectMenuComponent');
+const StringSelectMenuBuilder = require('../structures/StringSelectMenuBuilder');
+const StringSelectMenuComponent = require('../structures/StringSelectMenuComponent');
+const TextInputBuilder = require('../structures/TextInputBuilder');
+const TextInputComponent = require('../structures/TextInputComponent');
+const UserSelectMenuBuilder = require('../structures/UserSelectMenuBuilder');
+const UserSelectMenuComponent = require('../structures/UserSelectMenuComponent');

package/src/util/Constants.js

@@ -0,0 +1,230 @@
+'use strict';
+
+const { ChannelType, MessageType, ComponentType, ImageFormat, StickerFormatType } = require('discord-api-types/v10');
+
+/**
+ * Max bulk deletable message age
+ * @typedef {number} MaxBulkDeletableMessageAge
+ */
+exports.MaxBulkDeletableMessageAge = 1_209_600_000;
+
+/**
+ * The name of an item to be swept in Sweepers
+ * * `autoModerationRules`
+ * * `applicationCommands` - both global and guild commands
+ * * `bans`
+ * * `emojis`
+ * * `invites` - accepts the `lifetime` property, using it will sweep based on expires timestamp
+ * * `guildMembers`
+ * * `messages` - accepts the `lifetime` property, using it will sweep based on edited or created timestamp
+ * * `presences`
+ * * `reactions`
+ * * `stageInstances`
+ * * `stickers`
+ * * `threadMembers`
+ * * `threads` - accepts the `lifetime` property, using it will sweep archived threads based on archived timestamp
+ * * `users`
+ * * `voiceStates`
+ * @typedef {string} SweeperKey
+ */
+exports.SweeperKeys = [
+  'autoModerationRules',
+  'applicationCommands',
+  'bans',
+  'emojis',
+  'invites',
+  'guildMembers',
+  'messages',
+  'presences',
+  'reactions',
+  'stageInstances',
+  'stickers',
+  'threadMembers',
+  'threads',
+  'users',
+  'voiceStates',
+];
+
+/**
+ * The types of messages that are not `System`. The available types are:
+ * * {@link MessageType.Default}
+ * * {@link MessageType.Reply}
+ * * {@link MessageType.ChatInputCommand}
+ * * {@link MessageType.ContextMenuCommand}
+ * @typedef {MessageType[]} NonSystemMessageTypes
+ */
+exports.NonSystemMessageTypes = [
+  MessageType.Default,
+  MessageType.Reply,
+  MessageType.ChatInputCommand,
+  MessageType.ContextMenuCommand,
+];
+
+/**
+ * The guild channels that are text-based.
+ * * TextChannel
+ * * NewsChannel
+ * * ThreadChannel
+ * * VoiceChannel
+ * * StageChannel
+ * @typedef {TextChannel|NewsChannel|ThreadChannel|VoiceChannel|StageChannel} GuildTextBasedChannel
+ */
+
+/**
+ * The types of guild channels that are text-based. The available types are:
+ * * {@link ChannelType.GuildText}
+ * * {@link ChannelType.GuildAnnouncement}
+ * * {@link ChannelType.AnnouncementThread}
+ * * {@link ChannelType.PublicThread}
+ * * {@link ChannelType.PrivateThread}
+ * * {@link ChannelType.GuildVoice}
+ * * {@link ChannelType.GuildStageVoice}
+ * @typedef {ChannelType[]} GuildTextBasedChannelTypes
+ */
+exports.GuildTextBasedChannelTypes = [
+  ChannelType.GuildText,
+  ChannelType.GuildAnnouncement,
+  ChannelType.AnnouncementThread,
+  ChannelType.PublicThread,
+  ChannelType.PrivateThread,
+  ChannelType.GuildVoice,
+  ChannelType.GuildStageVoice,
+];
+
+/**
+ * The channels that are text-based.
+ * * DMChannel
+ * * GuildTextBasedChannel
+ * @typedef {DMChannel|GuildTextBasedChannel} TextBasedChannels
+ */
+
+/**
+ * Data that resolves to give a text-based channel. This can be:
+ * * A text-based channel
+ * * A snowflake
+ * @typedef {TextBasedChannels|Snowflake} TextBasedChannelsResolvable
+ */
+
+/**
+ * The types of channels that are text-based. The available types are:
+ * * {@link ChannelType.DM}
+ * * {@link ChannelType.GuildText}
+ * * {@link ChannelType.GuildAnnouncement}
+ * * {@link ChannelType.AnnouncementThread}
+ * * {@link ChannelType.PublicThread}
+ * * {@link ChannelType.PrivateThread}
+ * * {@link ChannelType.GuildVoice}
+ * * {@link ChannelType.GuildStageVoice}
+ * @typedef {ChannelType[]} TextBasedChannelTypes
+ */
+exports.TextBasedChannelTypes = [...exports.GuildTextBasedChannelTypes, ChannelType.DM];
+
+/**
+ * The types of channels that are threads. The available types are:
+ * * {@link ChannelType.AnnouncementThread}
+ * * {@link ChannelType.PublicThread}
+ * * {@link ChannelType.PrivateThread}
+ * @typedef {ChannelType[]} ThreadChannelTypes
+ */
+exports.ThreadChannelTypes = [ChannelType.AnnouncementThread, ChannelType.PublicThread, ChannelType.PrivateThread];
+
+/**
+ * The types of channels that are voice-based. The available types are:
+ * * {@link ChannelType.GuildVoice}
+ * * {@link ChannelType.GuildStageVoice}
+ * @typedef {ChannelType[]} VoiceBasedChannelTypes
+ */
+exports.VoiceBasedChannelTypes = [ChannelType.GuildVoice, ChannelType.GuildStageVoice];
+
+/**
+ * The types of select menus. The available types are:
+ * * {@link ComponentType.StringSelect}
+ * * {@link ComponentType.UserSelect}
+ * * {@link ComponentType.RoleSelect}
+ * * {@link ComponentType.MentionableSelect}
+ * * {@link ComponentType.ChannelSelect}
+ * @typedef {ComponentType[]} SelectMenuTypes
+ */
+exports.SelectMenuTypes = [
+  ComponentType.StringSelect,
+  ComponentType.UserSelect,
+  ComponentType.RoleSelect,
+  ComponentType.MentionableSelect,
+  ComponentType.ChannelSelect,
+];
+
+/**
+ * The types of messages that can be deleted. The available types are:
+ * * {@link MessageType.AutoModerationAction}
+ * * {@link MessageType.ChannelFollowAdd}
+ * * {@link MessageType.ChannelPinnedMessage}
+ * * {@link MessageType.ChatInputCommand}
+ * * {@link MessageType.ContextMenuCommand}
+ * * {@link MessageType.Default}
+ * * {@link MessageType.GuildBoost}
+ * * {@link MessageType.GuildBoostTier1}
+ * * {@link MessageType.GuildBoostTier2}
+ * * {@link MessageType.GuildBoostTier3}
+ * * {@link MessageType.GuildInviteReminder}
+ * * {@link MessageType.InteractionPremiumUpsell}
+ * * {@link MessageType.Reply}
+ * * {@link MessageType.RoleSubscriptionPurchase}
+ * * {@link MessageType.StageEnd}
+ * * {@link MessageType.StageRaiseHand}
+ * * {@link MessageType.StageSpeaker}
+ * * {@link MessageType.StageStart}
+ * * {@link MessageType.StageTopic}
+ * * {@link MessageType.ThreadCreated}
+ * * {@link MessageType.UserJoin}
+ * @typedef {MessageType[]} DeletableMessageTypes
+ */
+exports.DeletableMessageTypes = [
+  MessageType.AutoModerationAction,
+  MessageType.ChannelFollowAdd,
+  MessageType.ChannelPinnedMessage,
+  MessageType.ChatInputCommand,
+  MessageType.ContextMenuCommand,
+  MessageType.Default,
+  MessageType.GuildBoost,
+  MessageType.GuildBoostTier1,
+  MessageType.GuildBoostTier2,
+  MessageType.GuildBoostTier3,
+  MessageType.GuildInviteReminder,
+  MessageType.InteractionPremiumUpsell,
+  MessageType.Reply,
+  MessageType.RoleSubscriptionPurchase,
+  MessageType.StageEnd,
+  MessageType.StageRaiseHand,
+  MessageType.StageSpeaker,
+  MessageType.StageStart,
+  MessageType.StageTopic,
+  MessageType.ThreadCreated,
+  MessageType.UserJoin,
+];
+
+/**
+ * A mapping between sticker formats and their respective image formats.
+ * * {@link StickerFormatType.PNG} -> {@link ImageFormat.PNG}
+ * * {@link StickerFormatType.APNG} -> {@link ImageFormat.PNG}
+ * * {@link StickerFormatType.Lottie} -> {@link ImageFormat.Lottie}
+ * * {@link StickerFormatType.GIF} -> {@link ImageFormat.GIF}
+ * @typedef {Object} StickerFormatExtensionMap
+ */
+exports.StickerFormatExtensionMap = {
+  [StickerFormatType.PNG]: ImageFormat.PNG,
+  [StickerFormatType.APNG]: ImageFormat.PNG,
+  [StickerFormatType.Lottie]: ImageFormat.Lottie,
+  [StickerFormatType.GIF]: ImageFormat.GIF,
+};
+
+/**
+ * @typedef {Object} Constants Constants that can be used in an enum or object-like way.
+ * @property {number} MaxBulkDeletableMessageAge Max bulk deletable message age
+ * @property {SweeperKey[]} SweeperKeys The possible names of items that can be swept in sweepers
+ * @property {NonSystemMessageTypes} NonSystemMessageTypes The types of messages that are not deemed a system type
+ * @property {TextBasedChannelTypes} TextBasedChannelTypes The types of channels that are text-based
+ * @property {ThreadChannelTypes} ThreadChannelTypes The types of channels that are threads
+ * @property {VoiceBasedChannelTypes} VoiceBasedChannelTypes The types of channels that are voice-based
+ * @property {SelectMenuTypes} SelectMenuTypes The types of components that are select menus.
+ * @property {Object} StickerFormatExtensionMap A mapping between sticker formats and their respective image formats.
+ */