From 21dfac90ac214987992dd358c32a1d34f7b9d315 Mon Sep 17 00:00:00 2001 From: Jaw0r3k Date: Mon, 1 May 2023 21:03:19 +0200 Subject: [PATCH] fix: Miscellaneous fixes (#9445) Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com> Co-authored-by: Almeida Co-authored-by: kyranet Fix embeds and components (#9437) fix links and invalid syntax (#9322) --- README.md | 8 ++++---- docs/README.md | 2 +- src/client/Client.js | 2 +- src/managers/ApplicationCommandManager.js | 4 ++-- src/managers/ChannelManager.js | 6 +++--- src/managers/RoleManager.js | 7 +++++-- src/structures/CategoryChannel.js | 15 ++++++++++++++- src/structures/Channel.js | 4 ++-- src/structures/ThreadChannel.js | 4 ++-- src/structures/interfaces/TextBasedChannel.js | 6 +++--- src/util/LimitedCollection.js | 2 +- src/util/Options.js | 6 +++--- src/util/Sweepers.js | 2 +- typings/index.d.ts | 6 ++++-- 14 files changed, 46 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 0e639918f..957b10b40 100644 --- a/README.md +++ b/README.md @@ -100,9 +100,9 @@ client.login('token'); ## Links - [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) -- [Documentation](https://discord.js.org/#/docs) -- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v13.html), including updated and removed items in the library. +- [Documentation](https://old.discordjs.dev/#/docs) +- [Guide](https://v13.discordjs.guide) ([source](https://github.com/discordjs/guide/tree/v13)) + See also the [Update Guide](https://v13.discordjs.guide/additional-info/changes-in-v13.html), including updated and removed items in the library. - [discord.js Discord server](https://discord.gg/djs) - [Discord API Discord server](https://discord.gg/discord-api) - [GitHub](https://github.com/discordjs/discord.js) @@ -116,7 +116,7 @@ client.login('token'); ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation](https://discord.js.org/#/docs). +[documentation](https://old.discordjs.dev/#/docs). See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. ## Help diff --git a/docs/README.md b/docs/README.md index b5ac7978f..5b2aa0c2a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1 @@ -## [View the documentation here.](https://discord.js.org/#/docs) +## [View the documentation here.](https://old.discordjs.dev/#/docs) diff --git a/src/client/Client.js b/src/client/Client.js index d770e8f01..5fa052fb5 100644 --- a/src/client/Client.js +++ b/src/client/Client.js @@ -617,5 +617,5 @@ module.exports = Client; /** * @external Collection - * @see {@link https://discord.js.org/#/docs/collection/main/class/Collection} + * @see {@link https://discord.js.org/docs/packages/collection/stable/Collection:Class} */ diff --git a/src/managers/ApplicationCommandManager.js b/src/managers/ApplicationCommandManager.js index 41870fbeb..57f6f4bfa 100644 --- a/src/managers/ApplicationCommandManager.js +++ b/src/managers/ApplicationCommandManager.js @@ -255,10 +255,10 @@ module.exports = ApplicationCommandManager; /** * @external SlashCommandBuilder - * @see {@link https://discord.js.org/#/docs/builders/main/class/SlashCommandBuilder} + * @see {@link https://discord.js.org/docs/packages/builders/stable/SlashCommandBuilder:Class} */ /** * @external ContextMenuCommandBuilder - * @see {@link https://discord.js.org/#/docs/builders/main/class/ContextMenuCommandBuilder} + * @see {@link https://discord.js.org/docs/packages/builders/stable/ContextMenuCommandBuilder:Class} */ diff --git a/src/managers/ChannelManager.js b/src/managers/ChannelManager.js index 06b25dc74..785d6fff2 100644 --- a/src/managers/ChannelManager.js +++ b/src/managers/ChannelManager.js @@ -33,10 +33,10 @@ class ChannelManager extends CachedManager { * @name ChannelManager#cache */ - _add(data, guild, { cache = true, allowUnknownGuild = false, fromInteraction = false } = {}) { + _add(data, guild, { cache = true, allowUnknownGuild = false } = {}) { const existing = this.cache.get(data.id); if (existing) { - if (cache) existing._patch(data, fromInteraction); + if (cache) existing._patch(data); guild?.channels?._add(existing); if (ThreadChannelTypes.includes(existing.type)) { existing.parent?.threads?._add(existing); @@ -44,7 +44,7 @@ class ChannelManager extends CachedManager { return existing; } - const channel = Channel.create(this.client, data, guild, { allowUnknownGuild, fromInteraction }); + const channel = Channel.create(this.client, data, guild, { allowUnknownGuild }); if (!channel) { this.client.emit(Events.DEBUG, `Failed to find guild, or unknown type for channel ${data.id} ${data.type}`); diff --git a/src/managers/RoleManager.js b/src/managers/RoleManager.js index f3041b84e..a68fcf270 100644 --- a/src/managers/RoleManager.js +++ b/src/managers/RoleManager.js @@ -299,11 +299,14 @@ class RoleManager extends CachedManager { const resolvedRole2 = this.resolve(role2); if (!resolvedRole1 || !resolvedRole2) throw new TypeError('INVALID_TYPE', 'role', 'Role nor a Snowflake'); - if (resolvedRole1.position === resolvedRole2.position) { + const role1Position = resolvedRole1.position; + const role2Position = resolvedRole2.position; + + if (role1Position === role2Position) { return Number(BigInt(resolvedRole2.id) - BigInt(resolvedRole1.id)); } - return resolvedRole1.position - resolvedRole2.position; + return role1Position - role2Position; } /** diff --git a/src/structures/CategoryChannel.js b/src/structures/CategoryChannel.js index 831b787bc..6a1574b3e 100644 --- a/src/structures/CategoryChannel.js +++ b/src/structures/CategoryChannel.js @@ -7,6 +7,19 @@ const GuildChannel = require('./GuildChannel'); * @extends {GuildChannel} */ class CategoryChannel extends GuildChannel { + /** + * The id of the parent of this channel. + * @name CategoryChannel#parentId + * @type {null} + */ + + /** + * The parent of this channel. + * @name CategoryChannel#parent + * @type {null} + * @readonly + */ + /** * Channels that are a part of this category * @type {Collection} @@ -18,7 +31,7 @@ class CategoryChannel extends GuildChannel { /** * Sets the category parent of this channel. - * It is not currently possible to set the parent of a CategoryChannel. + * It is not possible to set the parent of a CategoryChannel. * @method setParent * @memberof CategoryChannel * @instance diff --git a/src/structures/Channel.js b/src/structures/Channel.js index 50dfcefb5..cdffc3a20 100644 --- a/src/structures/Channel.js +++ b/src/structures/Channel.js @@ -186,7 +186,7 @@ class Channel extends Base { return this.type === 'GUILD_DIRECTORY'; } - static create(client, data, guild, { allowUnknownGuild, fromInteraction } = {}) { + static create(client, data, guild, { allowUnknownGuild } = {}) { CategoryChannel ??= require('./CategoryChannel'); DMChannel ??= require('./DMChannel'); NewsChannel ??= require('./NewsChannel'); @@ -238,7 +238,7 @@ class Channel extends Base { case ChannelTypes.GUILD_NEWS_THREAD: case ChannelTypes.GUILD_PUBLIC_THREAD: case ChannelTypes.GUILD_PRIVATE_THREAD: { - channel = new ThreadChannel(guild, data, client, fromInteraction); + channel = new ThreadChannel(guild, data, client); if (!allowUnknownGuild) channel.parent?.threads.cache.set(channel.id, channel); break; } diff --git a/src/structures/ThreadChannel.js b/src/structures/ThreadChannel.js index c635cb388..0f3b7c6a8 100644 --- a/src/structures/ThreadChannel.js +++ b/src/structures/ThreadChannel.js @@ -15,7 +15,7 @@ const { resolveAutoArchiveMaxLimit } = require('../util/Util'); * @implements {TextBasedChannel} */ class ThreadChannel extends Channel { - constructor(guild, data, client, fromInteraction = false) { + constructor(guild, data, client) { super(guild?.client ?? client, data, false); /** @@ -41,7 +41,7 @@ class ThreadChannel extends Channel { * @type {ThreadMemberManager} */ this.members = new ThreadMemberManager(this); - if (data) this._patch(data, fromInteraction); + if (data) this._patch(data); } _patch(data, partial = false) { diff --git a/src/structures/interfaces/TextBasedChannel.js b/src/structures/interfaces/TextBasedChannel.js index a05a1281c..3bafa4324 100644 --- a/src/structures/interfaces/TextBasedChannel.js +++ b/src/structures/interfaces/TextBasedChannel.js @@ -58,12 +58,12 @@ class TextBasedChannel { * @property {boolean} [tts=false] Whether or not the message should be spoken aloud * @property {string} [nonce=''] The nonce for the message * @property {string} [content=''] The content for the message - * @property {MessageEmbed[]|APIEmbed[]} [embeds] The embeds for the message + * @property {Array<(MessageEmbed|APIEmbed)>} [embeds] The embeds for the message * (see [here](https://discord.com/developers/docs/resources/channel#embed-object) for more details) * @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content * (see [here](https://discord.com/developers/docs/resources/channel#allowed-mentions-object) for more details) - * @property {FileOptions[]|BufferResolvable[]|MessageAttachment[]} [files] Files to send with the message - * @property {MessageActionRow[]|MessageActionRowOptions[]} [components] + * @property {Array<(FileOptions|BufferResolvable|MessageAttachment[])>} [files] Files to send with the message + * @property {Array<(MessageActionRow|MessageActionRowOptions)>} [components] * Action rows containing interactive components for the message (buttons, select menus) * @property {MessageAttachment[]} [attachments] Attachments to send in the message */ diff --git a/src/util/LimitedCollection.js b/src/util/LimitedCollection.js index 8ebda0e34..956639d3f 100644 --- a/src/util/LimitedCollection.js +++ b/src/util/LimitedCollection.js @@ -10,7 +10,7 @@ const { TypeError } = require('../errors/DJSError.js'); * @typedef {Function} SweepFilter * @param {LimitedCollection} collection The collection being swept * @returns {Function|null} Return `null` to skip sweeping, otherwise a function passed to `sweep()`, - * See {@link [Collection#sweep](https://discord.js.org/#/docs/collection/main/class/Collection?scrollTo=sweep)} + * See {@link [Collection#sweep](https://discord.js.org/docs/packages/collection/stable/Collection:Class#sweep)} * for the definition of this function. */ diff --git a/src/util/Options.js b/src/util/Options.js index f2420dc21..e77c1c872 100644 --- a/src/util/Options.js +++ b/src/util/Options.js @@ -251,7 +251,7 @@ class Options extends null { } /** - * The default settings passed to {@link Options.cacheWithLimits}. + * The default settings passed to {@link ClientOptions.makeCache}. * The caches that this changes are: * * `MessageManager` - Limit to 200 messages * * `ChannelManager` - Sweep archived threads @@ -281,11 +281,11 @@ class Options extends null { } /** - * The default settings passed to {@link Options.sweepers} (for v14). + * The default settings passed to {@link ClientOptions.sweepers}. * The sweepers that this changes are: * * `threads` - Sweep archived threads every hour, removing those archived more than 4 hours ago * If you want to keep default behavior and add on top of it you can use this object and add on to it, e.g. - * `sweepers: { ...Options.defaultSweeperSettings, messages: { interval: 300, lifetime: 600 } })` + * `sweepers: { ...Options.defaultSweeperSettings, messages: { interval: 300, lifetime: 600 } }` * @type {SweeperOptions} */ Options.defaultSweeperSettings = { diff --git a/src/util/Sweepers.js b/src/util/Sweepers.js index a104d3f4c..76848c52f 100644 --- a/src/util/Sweepers.js +++ b/src/util/Sweepers.js @@ -7,7 +7,7 @@ const { TypeError } = require('../errors/DJSError.js'); /** * @typedef {Function} GlobalSweepFilter * @returns {Function|null} Return `null` to skip sweeping, otherwise a function passed to `sweep()`, - * See {@link [Collection#sweep](https://discord.js.org/#/docs/collection/main/class/Collection?scrollTo=sweep)} + * See {@link [Collection#sweep](https://discord.js.org/docs/packages/collection/stable/Collection:Class#sweep)} * for the definition of this function. */ diff --git a/typings/index.d.ts b/typings/index.d.ts index 0c70b51bb..6b93f4e66 100644 --- a/typings/index.d.ts +++ b/typings/index.d.ts @@ -573,6 +573,8 @@ export type CategoryChannelTypes = ExcludeEnum< export class CategoryChannel extends GuildChannel { public readonly children: Collection>; + public static parent: null; + public parentId: null; public type: 'GUILD_CATEGORY'; public createChannel>( @@ -2594,7 +2596,7 @@ export class TextInputComponent extends BaseMessageComponent { } export class ThreadChannel extends TextBasedChannelMixin(Channel, ['fetchWebhooks', 'createWebhook', 'setNSFW']) { - private constructor(guild: Guild, data?: RawThreadChannelData, client?: Client, fromInteraction?: boolean); + private constructor(guild: Guild, data?: RawThreadChannelData, client?: Client); public archived: boolean | null; public readonly archivedAt: Date | null; public archiveTimestamp: number | null; @@ -6423,7 +6425,7 @@ export type GuildBasedChannel = Extract; export type NonThreadGuildBasedChannel = Exclude; -export type GuildTextBasedChannel = Exclude, ForumChannel>; +export type GuildTextBasedChannel = Extract; export type TextChannelResolvable = Snowflake | TextChannel;