fix: Miscellaneous fixes (#9445)

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
Co-authored-by: Almeida <almeidx@pm.me>
Co-authored-by: kyranet <kyradiscord@gmail.com>
Fix embeds and components (#9437)
fix links and invalid syntax (#9322)
This commit is contained in:
Jaw0r3k 2023-05-01 21:03:19 +02:00 committed by GitHub
parent d867936fce
commit 21dfac90ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 46 additions and 28 deletions

View file

@ -100,9 +100,9 @@ client.login('token');
## Links ## Links
- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) - [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website))
- [Documentation](https://discord.js.org/#/docs) - [Documentation](https://old.discordjs.dev/#/docs)
- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - [Guide](https://v13.discordjs.guide) ([source](https://github.com/discordjs/guide/tree/v13))
See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v13.html), including updated and removed items in the library. 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.js Discord server](https://discord.gg/djs)
- [Discord API Discord server](https://discord.gg/discord-api) - [Discord API Discord server](https://discord.gg/discord-api)
- [GitHub](https://github.com/discordjs/discord.js) - [GitHub](https://github.com/discordjs/discord.js)
@ -116,7 +116,7 @@ client.login('token');
## Contributing ## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the 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. See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR.
## Help ## Help

View file

@ -1 +1 @@
## [View the documentation here.](https://discord.js.org/#/docs) ## [View the documentation here.](https://old.discordjs.dev/#/docs)

View file

@ -617,5 +617,5 @@ module.exports = Client;
/** /**
* @external Collection * @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}
*/ */

View file

@ -255,10 +255,10 @@ module.exports = ApplicationCommandManager;
/** /**
* @external SlashCommandBuilder * @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 * @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}
*/ */

View file

@ -33,10 +33,10 @@ class ChannelManager extends CachedManager {
* @name ChannelManager#cache * @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); const existing = this.cache.get(data.id);
if (existing) { if (existing) {
if (cache) existing._patch(data, fromInteraction); if (cache) existing._patch(data);
guild?.channels?._add(existing); guild?.channels?._add(existing);
if (ThreadChannelTypes.includes(existing.type)) { if (ThreadChannelTypes.includes(existing.type)) {
existing.parent?.threads?._add(existing); existing.parent?.threads?._add(existing);
@ -44,7 +44,7 @@ class ChannelManager extends CachedManager {
return existing; return existing;
} }
const channel = Channel.create(this.client, data, guild, { allowUnknownGuild, fromInteraction }); const channel = Channel.create(this.client, data, guild, { allowUnknownGuild });
if (!channel) { if (!channel) {
this.client.emit(Events.DEBUG, `Failed to find guild, or unknown type for channel ${data.id} ${data.type}`); this.client.emit(Events.DEBUG, `Failed to find guild, or unknown type for channel ${data.id} ${data.type}`);

View file

@ -299,11 +299,14 @@ class RoleManager extends CachedManager {
const resolvedRole2 = this.resolve(role2); const resolvedRole2 = this.resolve(role2);
if (!resolvedRole1 || !resolvedRole2) throw new TypeError('INVALID_TYPE', 'role', 'Role nor a Snowflake'); 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 Number(BigInt(resolvedRole2.id) - BigInt(resolvedRole1.id));
} }
return resolvedRole1.position - resolvedRole2.position; return role1Position - role2Position;
} }
/** /**

View file

@ -7,6 +7,19 @@ const GuildChannel = require('./GuildChannel');
* @extends {GuildChannel} * @extends {GuildChannel}
*/ */
class CategoryChannel 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 * Channels that are a part of this category
* @type {Collection<Snowflake, GuildChannel>} * @type {Collection<Snowflake, GuildChannel>}
@ -18,7 +31,7 @@ class CategoryChannel extends GuildChannel {
/** /**
* Sets the category parent of this channel. * Sets the category parent of this channel.
* <warn>It is not currently possible to set the parent of a CategoryChannel.</warn> * <warn>It is not possible to set the parent of a CategoryChannel.</warn>
* @method setParent * @method setParent
* @memberof CategoryChannel * @memberof CategoryChannel
* @instance * @instance

View file

@ -186,7 +186,7 @@ class Channel extends Base {
return this.type === 'GUILD_DIRECTORY'; return this.type === 'GUILD_DIRECTORY';
} }
static create(client, data, guild, { allowUnknownGuild, fromInteraction } = {}) { static create(client, data, guild, { allowUnknownGuild } = {}) {
CategoryChannel ??= require('./CategoryChannel'); CategoryChannel ??= require('./CategoryChannel');
DMChannel ??= require('./DMChannel'); DMChannel ??= require('./DMChannel');
NewsChannel ??= require('./NewsChannel'); NewsChannel ??= require('./NewsChannel');
@ -238,7 +238,7 @@ class Channel extends Base {
case ChannelTypes.GUILD_NEWS_THREAD: case ChannelTypes.GUILD_NEWS_THREAD:
case ChannelTypes.GUILD_PUBLIC_THREAD: case ChannelTypes.GUILD_PUBLIC_THREAD:
case ChannelTypes.GUILD_PRIVATE_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); if (!allowUnknownGuild) channel.parent?.threads.cache.set(channel.id, channel);
break; break;
} }

View file

@ -15,7 +15,7 @@ const { resolveAutoArchiveMaxLimit } = require('../util/Util');
* @implements {TextBasedChannel} * @implements {TextBasedChannel}
*/ */
class ThreadChannel extends Channel { class ThreadChannel extends Channel {
constructor(guild, data, client, fromInteraction = false) { constructor(guild, data, client) {
super(guild?.client ?? client, data, false); super(guild?.client ?? client, data, false);
/** /**
@ -41,7 +41,7 @@ class ThreadChannel extends Channel {
* @type {ThreadMemberManager} * @type {ThreadMemberManager}
*/ */
this.members = new ThreadMemberManager(this); this.members = new ThreadMemberManager(this);
if (data) this._patch(data, fromInteraction); if (data) this._patch(data);
} }
_patch(data, partial = false) { _patch(data, partial = false) {

View file

@ -58,12 +58,12 @@ class TextBasedChannel {
* @property {boolean} [tts=false] Whether or not the message should be spoken aloud * @property {boolean} [tts=false] Whether or not the message should be spoken aloud
* @property {string} [nonce=''] The nonce for the message * @property {string} [nonce=''] The nonce for the message
* @property {string} [content=''] The content 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) * (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 * @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) * (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 {Array<(FileOptions|BufferResolvable|MessageAttachment[])>} [files] Files to send with the message
* @property {MessageActionRow[]|MessageActionRowOptions[]} [components] * @property {Array<(MessageActionRow|MessageActionRowOptions)>} [components]
* Action rows containing interactive components for the message (buttons, select menus) * Action rows containing interactive components for the message (buttons, select menus)
* @property {MessageAttachment[]} [attachments] Attachments to send in the message * @property {MessageAttachment[]} [attachments] Attachments to send in the message
*/ */

View file

@ -10,7 +10,7 @@ const { TypeError } = require('../errors/DJSError.js');
* @typedef {Function} SweepFilter * @typedef {Function} SweepFilter
* @param {LimitedCollection} collection The collection being swept * @param {LimitedCollection} collection The collection being swept
* @returns {Function|null} Return `null` to skip sweeping, otherwise a function passed to `sweep()`, * @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. * for the definition of this function.
*/ */

View file

@ -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: * The caches that this changes are:
* * `MessageManager` - Limit to 200 messages * * `MessageManager` - Limit to 200 messages
* * `ChannelManager` - Sweep archived threads * * `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: * The sweepers that this changes are:
* * `threads` - Sweep archived threads every hour, removing those archived more than 4 hours ago * * `threads` - Sweep archived threads every hour, removing those archived more than 4 hours ago
* <info>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. * <info>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 } })`</info> * `sweepers: { ...Options.defaultSweeperSettings, messages: { interval: 300, lifetime: 600 } }`</info>
* @type {SweeperOptions} * @type {SweeperOptions}
*/ */
Options.defaultSweeperSettings = { Options.defaultSweeperSettings = {

View file

@ -7,7 +7,7 @@ const { TypeError } = require('../errors/DJSError.js');
/** /**
* @typedef {Function} GlobalSweepFilter * @typedef {Function} GlobalSweepFilter
* @returns {Function|null} Return `null` to skip sweeping, otherwise a function passed to `sweep()`, * @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. * for the definition of this function.
*/ */

6
typings/index.d.ts vendored
View file

@ -573,6 +573,8 @@ export type CategoryChannelTypes = ExcludeEnum<
export class CategoryChannel extends GuildChannel { export class CategoryChannel extends GuildChannel {
public readonly children: Collection<Snowflake, Exclude<NonThreadGuildBasedChannel, CategoryChannel>>; public readonly children: Collection<Snowflake, Exclude<NonThreadGuildBasedChannel, CategoryChannel>>;
public static parent: null;
public parentId: null;
public type: 'GUILD_CATEGORY'; public type: 'GUILD_CATEGORY';
public createChannel<T extends Exclude<CategoryChannelTypes, 'GUILD_STORE' | ChannelTypes.GUILD_STORE>>( public createChannel<T extends Exclude<CategoryChannelTypes, 'GUILD_STORE' | ChannelTypes.GUILD_STORE>>(
@ -2594,7 +2596,7 @@ export class TextInputComponent extends BaseMessageComponent {
} }
export class ThreadChannel extends TextBasedChannelMixin(Channel, ['fetchWebhooks', 'createWebhook', 'setNSFW']) { 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 archived: boolean | null;
public readonly archivedAt: Date | null; public readonly archivedAt: Date | null;
public archiveTimestamp: number | null; public archiveTimestamp: number | null;
@ -6423,7 +6425,7 @@ export type GuildBasedChannel = Extract<AnyChannel, { guild: Guild }>;
export type NonThreadGuildBasedChannel = Exclude<GuildBasedChannel, ThreadChannel>; export type NonThreadGuildBasedChannel = Exclude<GuildBasedChannel, ThreadChannel>;
export type GuildTextBasedChannel = Exclude<Extract<GuildBasedChannel, TextBasedChannel>, ForumChannel>; export type GuildTextBasedChannel = Extract<GuildBasedChannel, TextBasedChannel>;
export type TextChannelResolvable = Snowflake | TextChannel; export type TextChannelResolvable = Snowflake | TextChannel;