discord.js 15.0.0-djs-file-upload.1761302390-5ae769c9e → 15.0.0-pr-11006.1765450224-e636950b2

package/src/util/Components.js

@@ -1,9 +1,37 @@
-/* eslint-disable no-use-before-define */
 'use strict';
 
-// eslint-disable-next-line import-x/order
+const { lazy } = require('@discordjs/util');
 const { ComponentType } = require('discord-api-types/v10');
 
+// Fixes circular dependencies.
+const getActionRow = lazy(() => require('../structures/ActionRow.js').ActionRow);
+const getButtonComponent = lazy(() => require('../structures/ButtonComponent.js').ButtonComponent);
+const getChannelSelectMenuComponent = lazy(
+  () => require('../structures/ChannelSelectMenuComponent.js').ChannelSelectMenuComponent,
+);
+const getComponent = lazy(() => require('../structures/Component.js').Component);
+const getContainerComponent = lazy(() => require('../structures/ContainerComponent.js').ContainerComponent);
+const getFileComponent = lazy(() => require('../structures/FileComponent.js').FileComponent);
+const getLabelComponent = lazy(() => require('../structures/LabelComponent.js').LabelComponent);
+const getMediaGalleryComponent = lazy(() => require('../structures/MediaGalleryComponent.js').MediaGalleryComponent);
+const getMentionableSelectMenuComponent = lazy(
+  () => require('../structures/MentionableSelectMenuComponent.js').MentionableSelectMenuComponent,
+);
+const getRoleSelectMenuComponent = lazy(
+  () => require('../structures/RoleSelectMenuComponent.js').RoleSelectMenuComponent,
+);
+const getSectionComponent = lazy(() => require('../structures/SectionComponent.js').SectionComponent);
+const getSeparatorComponent = lazy(() => require('../structures/SeparatorComponent.js').SeparatorComponent);
+const getStringSelectMenuComponent = lazy(
+  () => require('../structures/StringSelectMenuComponent.js').StringSelectMenuComponent,
+);
+const getTextDisplayComponent = lazy(() => require('../structures/TextDisplayComponent.js').TextDisplayComponent);
+const getTextInputComponent = lazy(() => require('../structures/TextInputComponent.js').TextInputComponent);
+const getThumbnailComponent = lazy(() => require('../structures/ThumbnailComponent.js').ThumbnailComponent);
+const getUserSelectMenuComponent = lazy(
+  () => require('../structures/UserSelectMenuComponent.js').UserSelectMenuComponent,
+);
+
 /**
  * @typedef {Object} BaseComponentData
  * @property {number} [id] the id of this component
@@ -47,7 +75,7 @@ const { ComponentType } = require('discord-api-types/v10');
 /**
  * @typedef {BaseComponentData} FileUploadComponentData
  * @property {string} customId The custom id of the file upload
- * @property {number} [minValues] The minimum number of files that can be uploaded (0-10)
+ * @property {number} [minValues] The minimum number of files that must be uploaded (0-10)
  * @property {number} [maxValues] The maximum number of files that can be uploaded (1-10)
  * @property {boolean} [required] Whether this component is required in modals
  */
@@ -57,7 +85,7 @@ const { ComponentType } = require('discord-api-types/v10');
  * @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 {number} [minValues] The minimum amount of options that must be selected
  * @property {string} [placeholder] The placeholder of the select menu
  * @property {boolean} [required] Whether this component is required in modals
  */
@@ -192,6 +220,25 @@ const { ComponentType } = require('discord-api-types/v10');
  * SectionComponent|SeparatorComponent|TextDisplayComponent} MessageTopLevelComponent
  */
 
+const ComponentTypeToClass = {
+  [ComponentType.ActionRow]: getActionRow,
+  [ComponentType.Button]: getButtonComponent,
+  [ComponentType.StringSelect]: getStringSelectMenuComponent,
+  [ComponentType.TextInput]: getTextInputComponent,
+  [ComponentType.UserSelect]: getUserSelectMenuComponent,
+  [ComponentType.RoleSelect]: getRoleSelectMenuComponent,
+  [ComponentType.MentionableSelect]: getMentionableSelectMenuComponent,
+  [ComponentType.ChannelSelect]: getChannelSelectMenuComponent,
+  [ComponentType.Container]: getContainerComponent,
+  [ComponentType.TextDisplay]: getTextDisplayComponent,
+  [ComponentType.File]: getFileComponent,
+  [ComponentType.MediaGallery]: getMediaGalleryComponent,
+  [ComponentType.Section]: getSectionComponent,
+  [ComponentType.Separator]: getSeparatorComponent,
+  [ComponentType.Thumbnail]: getThumbnailComponent,
+  [ComponentType.Label]: getLabelComponent,
+};
+
 /**
  * Transforms API data into a component
  *
@@ -200,7 +247,7 @@ const { ComponentType } = require('discord-api-types/v10');
  * @ignore
  */
 function createComponent(data) {
-  return data instanceof Component ? data : new (ComponentTypeToClass[data.type] ?? Component)(data);
+  return data instanceof getComponent() ? data : new (ComponentTypeToClass[data.type]?.() ?? getComponent())(data);
 }
 
 /**
@@ -241,40 +288,3 @@ function findComponentByCustomId(components, customId) {
 
 exports.createComponent = createComponent;
 exports.findComponentByCustomId = findComponentByCustomId;
-
-const { ActionRow } = require('../structures/ActionRow.js');
-const { ButtonComponent } = require('../structures/ButtonComponent.js');
-const { ChannelSelectMenuComponent } = require('../structures/ChannelSelectMenuComponent.js');
-const { Component } = require('../structures/Component.js');
-const { ContainerComponent } = require('../structures/ContainerComponent.js');
-const { FileComponent } = require('../structures/FileComponent.js');
-const { LabelComponent } = require('../structures/LabelComponent.js');
-const { MediaGalleryComponent } = require('../structures/MediaGalleryComponent.js');
-const { MentionableSelectMenuComponent } = require('../structures/MentionableSelectMenuComponent.js');
-const { RoleSelectMenuComponent } = require('../structures/RoleSelectMenuComponent.js');
-const { SectionComponent } = require('../structures/SectionComponent.js');
-const { SeparatorComponent } = require('../structures/SeparatorComponent.js');
-const { StringSelectMenuComponent } = require('../structures/StringSelectMenuComponent.js');
-const { TextDisplayComponent } = require('../structures/TextDisplayComponent.js');
-const { TextInputComponent } = require('../structures/TextInputComponent.js');
-const { ThumbnailComponent } = require('../structures/ThumbnailComponent.js');
-const { UserSelectMenuComponent } = require('../structures/UserSelectMenuComponent.js');
-
-const ComponentTypeToClass = {
-  [ComponentType.ActionRow]: ActionRow,
-  [ComponentType.Button]: ButtonComponent,
-  [ComponentType.StringSelect]: StringSelectMenuComponent,
-  [ComponentType.TextInput]: TextInputComponent,
-  [ComponentType.UserSelect]: UserSelectMenuComponent,
-  [ComponentType.RoleSelect]: RoleSelectMenuComponent,
-  [ComponentType.MentionableSelect]: MentionableSelectMenuComponent,
-  [ComponentType.ChannelSelect]: ChannelSelectMenuComponent,
-  [ComponentType.Container]: ContainerComponent,
-  [ComponentType.TextDisplay]: TextDisplayComponent,
-  [ComponentType.File]: FileComponent,
-  [ComponentType.MediaGallery]: MediaGalleryComponent,
-  [ComponentType.Section]: SectionComponent,
-  [ComponentType.Separator]: SeparatorComponent,
-  [ComponentType.Thumbnail]: ThumbnailComponent,
-  [ComponentType.Label]: LabelComponent,
-};

package/src/util/Constants.js

@@ -202,6 +202,7 @@ exports.UndeletableMessageTypes = [
   MessageType.ThreadStarterMessage,
 ];
 
+/* eslint-disable jsdoc/valid-types */
 /**
  * A mapping between sticker formats and their respective image formats.
  * - {@link StickerFormatType.PNG} -> {@link ImageFormat.PNG}
@@ -221,6 +222,7 @@ exports.StickerFormatExtensionMap = {
   [StickerFormatType.Lottie]: ImageFormat.Lottie,
   [StickerFormatType.GIF]: ImageFormat.GIF,
 };
+/* eslint-enable jsdoc/valid-types */
 
 /**
  * Holographic color values for role styling.

package/src/util/DataResolver.js

@@ -3,10 +3,14 @@
 const { Buffer } = require('node:buffer');
 const fs = require('node:fs/promises');
 const path = require('node:path');
+const { lazy } = require('@discordjs/util');
 const { fetch } = require('undici');
 const { DiscordjsError, DiscordjsTypeError, ErrorCodes } = require('../errors/index.js');
 const { BaseInvite } = require('../structures/BaseInvite.js');
 
+// Fixes circular dependencies.
+const getGuildTemplate = lazy(() => require('../structures/GuildTemplate.js').GuildTemplate);
+
 /**
  * Data that can be resolved to give an invite code. This can be:
  * - An invite code
@@ -54,8 +58,7 @@ function resolveInviteCode(data) {
  * @private
  */
 function resolveGuildTemplateCode(data) {
-  const { GuildTemplate } = require('../structures/GuildTemplate.js');
-  return resolveCode(data, GuildTemplate.GuildTemplatesPattern);
+  return resolveCode(data, getGuildTemplate().GuildTemplatesPattern);
 }
 
 /**

package/src/util/GuildMemberFlagsBitField.js

@@ -11,7 +11,7 @@ const { BitField } = require('./BitField.js');
  */
 class GuildMemberFlagsBitField extends BitField {
   /**
-   * Numeric guild guild member flags.
+   * Numeric guild member flags.
    *
    * @type {GuildMemberFlags}
    * @memberof GuildMemberFlagsBitField

package/src/util/Options.js

@@ -5,12 +5,16 @@ const { DefaultWebSocketManagerOptions } = require('@discordjs/ws');
 const { version } = require('../../package.json');
 const { toSnakeCase } = require('./Transformers.js');
 
-// TODO(ckohen): switch order of params so full manager is first and "type" is optional
+/**
+ * @typedef {Object} CacheFactoryParams
+ * @property {Function} holds The class that the cache will hold.
+ * @property {Function} manager The fully extended manager class the cache is being requested from.
+ * @property {Function} managerType The base manager class the cache is being requested from.
+ */
+
 /**
  * @typedef {Function} CacheFactory
- * @param {Function} managerType The base manager class the cache is being requested from.
- * @param {Function} holds The class that the cache will hold.
- * @param {Function} manager The fully extended manager class the cache is being requested from.
+ * @param {CacheFactoryParams} params The parameters
  * @returns {Collection} A Collection used to store the cache of the manager.
  */
 
@@ -121,7 +125,7 @@ class Options extends null {
     const { Collection } = require('@discordjs/collection');
     const { LimitedCollection } = require('./LimitedCollection.js');
 
-    return (managerType, _, manager) => {
+    return ({ managerType, manager }) => {
       const setting = settings[manager.name] ?? settings[managerType.name];
       /* eslint-disable-next-line eqeqeq */
       if (setting == null) {

package/src/util/Util.js

@@ -2,13 +2,18 @@
 
 const { parse } = require('node:path');
 const { Collection } = require('@discordjs/collection');
+const { lazy } = require('@discordjs/util');
 const { ChannelType, RouteBases, Routes } = require('discord-api-types/v10');
 const { fetch } = require('undici');
-// eslint-disable-next-line import-x/order
 const { Colors } = require('./Colors.js');
 // eslint-disable-next-line import-x/order
 const { DiscordjsError, DiscordjsRangeError, DiscordjsTypeError, ErrorCodes } = require('../errors/index.js');
 
+// Fixes circular dependencies.
+const getAttachment = lazy(() => require('../structures/Attachment.js').Attachment);
+const getGuildChannel = lazy(() => require('../structures/GuildChannel.js').GuildChannel);
+const getSKU = lazy(() => require('../structures/SKU.js').SKU);
+
 const isObject = data => typeof data === 'object' && data !== null;
 
 /**
@@ -352,8 +357,7 @@ function resolveColor(color) {
  * @returns {Collection}
  */
 function discordSort(collection) {
-  // eslint-disable-next-line no-use-before-define
-  const isGuildChannel = collection.first() instanceof GuildChannel;
+  const isGuildChannel = collection.first() instanceof getGuildChannel();
   return collection.toSorted(
     isGuildChannel
       ? (a, b) => a.rawPosition - b.rawPosition || Number(BigInt(a.id) - BigInt(b.id))
@@ -469,11 +473,19 @@ function cleanCodeBlockContent(text) {
   return text.replaceAll('```', '`\u200B``');
 }
 
+/**
+ * Represents the credentials used for a webhook in the form of its id and token.
+ *
+ * @typedef {Object} WebhookDataIdWithToken
+ * @property {Snowflake} id The webhook's id
+ * @property {string} token The webhook's token
+ */
+
 /**
  * Parses a webhook URL for the id and token.
  *
  * @param {string} url The URL to parse
- * @returns {?WebhookClientDataIdWithToken} `null` if the URL is invalid, otherwise the id and the token
+ * @returns {?WebhookDataIdWithToken} `null` if the URL is invalid, otherwise the id and the token
  */
 function parseWebhookURL(url) {
   const matches =
@@ -547,8 +559,7 @@ function transformResolved(
   if (attachments) {
     result.attachments = new Collection();
     for (const attachment of Object.values(attachments)) {
-      // eslint-disable-next-line no-use-before-define
-      const patched = new Attachment(attachment);
+      const patched = new (getAttachment())(attachment);
       result.attachments.set(attachment.id, patched);
     }
   }
@@ -564,8 +575,7 @@ function transformResolved(
  */
 function resolveSKUId(resolvable) {
   if (typeof resolvable === 'string') return resolvable;
-  // eslint-disable-next-line no-use-before-define
-  if (resolvable instanceof SKU) return resolvable.id;
+  if (resolvable instanceof getSKU()) return resolvable.id;
   return null;
 }
 
@@ -592,8 +602,3 @@ exports.setPosition = setPosition;
 exports.basename = basename;
 exports.findName = findName;
 exports.transformResolved = transformResolved;
-
-// Fixes Circular
-const { Attachment } = require('../structures/Attachment.js');
-const { GuildChannel } = require('../structures/GuildChannel.js');
-const { SKU } = require('../structures/SKU.js');