Merge branch 'main' into build/bump-discord-api-types

apps/website/src/util/fetchDependencies.ts

@@ -20,7 +20,7 @@ export async function fetchDependencies({
 
 			return Object.entries<string>(parsedDependencies)
 				.filter(([key]) => key.startsWith('@discordjs/') && !key.includes('api-extractor'))
-				.map(([key, value]) => `${key.replace('@discordjs/', '').replaceAll('.', '-')}-${value.replaceAll('.', '-')}`);
+				.map(([key, value]) => `${key.replace('@discordjs/', '').replaceAll('.', '-')}-${sanitizeVersion(value)}`);
 		} catch {
 			return [];
 		}
@@ -36,8 +36,12 @@ export async function fetchDependencies({
 
 		return Object.entries<string>(parsedDependencies)
 			.filter(([key]) => key.startsWith('@discordjs/') && !key.includes('api-extractor'))
-			.map(([key, value]) => `${key.replace('@discordjs/', '').replaceAll('.', '-')}-${value.replaceAll('.', '-')}`);
+			.map(([key, value]) => `${key.replace('@discordjs/', '').replaceAll('.', '-')}-${sanitizeVersion(value)}`);
 	} catch {
 		return [];
 	}
 }
+
+function sanitizeVersion(version: string) {
+	return version.replaceAll('.', '-').replace(/^[\^~]/, '');
+}

packages/api-extractor/src/generators/ApiModelGenerator.ts

@@ -114,7 +114,7 @@ interface DocgenEventJson {
 }
 
 interface DocgenParamJson {
-	default?: string;
+	default?: boolean | number | string;
 	description: string;
 	name: string;
 	nullable?: boolean;
@@ -155,7 +155,7 @@ interface DocgenMethodJson {
 interface DocgenPropertyJson {
 	abstract?: boolean;
 	access?: DocgenAccess;
-	default?: string;
+	default?: boolean | number | string;
 	deprecated?: DocgenDeprecated;
 	description: string;
 	meta: DocgenMetaJson;
@@ -1264,7 +1264,7 @@ export class ApiModelGenerator {
 				const apiItemMetadata: ApiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
 				const docComment: tsdoc.DocComment | undefined = jsDoc
 					? this._tsDocParser.parseString(
-							`/**\n * ${this._fixLinkTags(jsDoc.description) ?? ''}\n${
+							`/**\n * ${this._fixLinkTags(jsDoc.description) ?? ''}${jsDoc.default ? ` (default: ${this._escapeSpecialChars(jsDoc.default)})` : ''}\n${
 								'see' in jsDoc ? jsDoc.see.map((see) => ` * @see ${see}\n`).join('') : ''
 							}${'readonly' in jsDoc && jsDoc.readonly ? ' * @readonly\n' : ''}${
 								'deprecated' in jsDoc && jsDoc.deprecated
@@ -1342,7 +1342,7 @@ export class ApiModelGenerator {
 				const apiItemMetadata: ApiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
 				const docComment: tsdoc.DocComment | undefined = jsDoc
 					? this._tsDocParser.parseString(
-							`/**\n * ${this._fixLinkTags(jsDoc.description) ?? ''}\n${
+							`/**\n * ${this._fixLinkTags(jsDoc.description) ?? ''}${jsDoc.default ? ` (default: ${this._escapeSpecialChars(jsDoc.default)})` : ''}\n${
 								'see' in jsDoc ? jsDoc.see.map((see) => ` * @see ${see}\n`).join('') : ''
 							}${'readonly' in jsDoc && jsDoc.readonly ? ' * @readonly\n' : ''}${
 								'deprecated' in jsDoc && jsDoc.deprecated
@@ -1510,15 +1510,17 @@ export class ApiModelGenerator {
 			const excerptTokens: IExcerptToken[] = [
 				{
 					kind: ExcerptTokenKind.Content,
-					text: `on('${name}', (${
-						jsDoc.params?.length ? `${jsDoc.params[0]?.name}${jsDoc.params[0]?.nullable ? '?' : ''}: ` : ') => {})'
+					text: `public on(eventName: '${name}', listener: (${
+						jsDoc.params?.length
+							? `${jsDoc.params[0]?.name}${jsDoc.params[0]?.optional ? '?' : ''}: `
+							: ') => void): this;'
 					}`,
 				},
 			];
 			const parameters: IApiParameterOptions[] = [];
 			for (let index = 0; index < (jsDoc.params?.length ?? 0) - 1; index++) {
 				const parameter = jsDoc.params![index]!;
-				const newTokens = this._mapVarType(parameter.type);
+				const newTokens = this._mapVarType(parameter.type, parameter.nullable);
 				parameters.push({
 					parameterName: parameter.name,
 					parameterTypeTokenRange: {
@@ -1537,7 +1539,7 @@ export class ApiModelGenerator {
 
 			if (jsDoc.params?.length) {
 				const parameter = jsDoc.params![jsDoc.params.length - 1]!;
-				const newTokens = this._mapVarType(parameter.type);
+				const newTokens = this._mapVarType(parameter.type, parameter.nullable);
 				parameters.push({
 					parameterName: parameter.name,
 					parameterTypeTokenRange: {
@@ -1550,7 +1552,7 @@ export class ApiModelGenerator {
 				excerptTokens.push(...newTokens);
 				excerptTokens.push({
 					kind: ExcerptTokenKind.Content,
-					text: `) => {})`,
+					text: `) => void): this;`,
 				});
 			}
 
@@ -1746,6 +1748,14 @@ export class ApiModelGenerator {
 		return sourceLocation;
 	}
 
+	private _escapeSpecialChars(input: boolean | number | string) {
+		if (typeof input !== 'string') {
+			return input;
+		}
+
+		return input.replaceAll(/(?<char>[{}])/g, '\\$<char>');
+	}
+
 	private _fixLinkTags(input?: string): string | undefined {
 		return input
 			?.replaceAll(linkRegEx, (_match, _p1, _p2, _p3, _p4, _p5, _offset, _string, groups) => {
@@ -1765,7 +1775,7 @@ export class ApiModelGenerator {
 			.replaceAll('* ', '\n * * ');
 	}
 
-	private _mapVarType(typey: DocgenVarTypeJson): IExcerptToken[] {
+	private _mapVarType(typey: DocgenVarTypeJson, nullable?: boolean): IExcerptToken[] {
 		const mapper = Array.isArray(typey) ? typey : (typey.types ?? []);
 		const lookup: { [K in ts.SyntaxKind]?: string } = {
 			[ts.SyntaxKind.ClassDeclaration]: 'class',
@@ -1808,7 +1818,22 @@ export class ApiModelGenerator {
 						{ kind: ExcerptTokenKind.Content, text: symbol ?? '' },
 					];
 				}, []);
-				return index === 0 ? result : [{ kind: ExcerptTokenKind.Content, text: ' | ' }, ...result];
+				return index === 0
+					? mapper.length === 1 && (nullable || ('nullable' in typey && typey.nullable))
+						? [
+								...result,
+								{ kind: ExcerptTokenKind.Content, text: ' | ' },
+								{ kind: ExcerptTokenKind.Reference, text: 'null' },
+							]
+						: result
+					: index === mapper.length - 1 && (nullable || ('nullable' in typey && typey.nullable))
+						? [
+								{ kind: ExcerptTokenKind.Content, text: ' | ' },
+								...result,
+								{ kind: ExcerptTokenKind.Content, text: ' | ' },
+								{ kind: ExcerptTokenKind.Reference, text: 'null' },
+							]
+						: [{ kind: ExcerptTokenKind.Content, text: ' | ' }, ...result];
 			})
 			.filter((excerpt) => excerpt.text.length);
 	}
@@ -1823,7 +1848,7 @@ export class ApiModelGenerator {
 			isOptional: Boolean(prop.nullable),
 			isReadonly: Boolean(prop.readonly),
 			docComment: this._tsDocParser.parseString(
-				`/**\n * ${this._fixLinkTags(prop.description) ?? ''}\n${
+				`/**\n * ${this._fixLinkTags(prop.description) ?? ''}${prop.default ? ` (default: ${this._escapeSpecialChars(prop.default)})` : ''}\n${
 					prop.see?.map((see) => ` * @see ${see}\n`).join('') ?? ''
 				}${prop.readonly ? ' * @readonly\n' : ''} */`,
 			).docComment,

packages/brokers/cliff.toml

@@ -30,8 +30,10 @@ body = """
 			{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
 			{% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
 		{% if commit.breaking %}\
-			{% for breakingChange in commit.footers %}\
-				\n{% raw %}  {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
+			{% for footer in commit.footers %}\
+				{% if footer.breaking %}\
+					\n{% raw %}  {% endraw %}- **{{ footer.token }}{{ footer.separator }}** {{ footer.value }}\
+				{% endif %}\
 			{% endfor %}\
 		{% endif %}\
 	{% endfor %}

packages/builders/cliff.toml

@@ -30,8 +30,10 @@ body = """
 			{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
 			{% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
 		{% if commit.breaking %}\
-			{% for breakingChange in commit.footers %}\
-				\n{% raw %}  {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
+			{% for footer in commit.footers %}\
+				{% if footer.breaking %}\
+					\n{% raw %}  {% endraw %}- **{{ footer.token }}{{ footer.separator }}** {{ footer.value }}\
+				{% endif %}\
 			{% endfor %}\
 		{% endif %}\
 	{% endfor %}

packages/collection/cliff.toml

@@ -30,8 +30,10 @@ body = """
 			{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
 			{% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
 		{% if commit.breaking %}\
-			{% for breakingChange in commit.footers %}\
-				\n{% raw %}  {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
+			{% for footer in commit.footers %}\
+				{% if footer.breaking %}\
+					\n{% raw %}  {% endraw %}- **{{ footer.token }}{{ footer.separator }}** {{ footer.value }}\
+				{% endif %}\
 			{% endfor %}\
 		{% endif %}\
 	{% endfor %}

packages/core/cliff.toml

@@ -30,8 +30,10 @@ body = """
 			{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
 			{% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
 		{% if commit.breaking %}\
-			{% for breakingChange in commit.footers %}\
-				\n{% raw %}  {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
+			{% for footer in commit.footers %}\
+				{% if footer.breaking %}\
+					\n{% raw %}  {% endraw %}- **{{ footer.token }}{{ footer.separator }}** {{ footer.value }}\
+				{% endif %}\
 			{% endfor %}\
 		{% endif %}\
 	{% endfor %}

packages/core/src/api/channel.ts

@@ -45,7 +45,7 @@ export class ChannelsAPI {
 	/**
 	 * Sends a message in a channel
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#create-message}
+	 * @see {@link https://discord.com/developers/docs/resources/message#create-message}
 	 * @param channelId - The id of the channel to send the message in
 	 * @param body - The data for sending the message
 	 * @param options - The options for sending the message
@@ -65,7 +65,7 @@ export class ChannelsAPI {
 	/**
 	 * Edits a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#edit-message}
+	 * @see {@link https://discord.com/developers/docs/resources/message#edit-message}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to edit
 	 * @param body - The data for editing the message
@@ -87,7 +87,7 @@ export class ChannelsAPI {
 	/**
 	 * Fetches the reactions for a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#get-reactions}
+	 * @see {@link https://discord.com/developers/docs/resources/message#get-reactions}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to get the reactions for
 	 * @param emoji - The emoji to get the reactions for
@@ -110,7 +110,7 @@ export class ChannelsAPI {
 	/**
 	 * Deletes a reaction for the current user
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#delete-own-reaction}
+	 * @see {@link https://discord.com/developers/docs/resources/message#delete-own-reaction}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to delete the reaction for
 	 * @param emoji - The emoji to delete the reaction for
@@ -130,7 +130,7 @@ export class ChannelsAPI {
 	/**
 	 * Deletes a reaction for a user
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#delete-user-reaction}
+	 * @see {@link https://discord.com/developers/docs/resources/message#delete-user-reaction}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to delete the reaction for
 	 * @param emoji - The emoji to delete the reaction for
@@ -152,7 +152,7 @@ export class ChannelsAPI {
 	/**
 	 * Deletes all reactions for a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions}
+	 * @see {@link https://discord.com/developers/docs/resources/message#delete-all-reactions}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to delete the reactions for
 	 * @param options - The options for deleting the reactions
@@ -168,7 +168,7 @@ export class ChannelsAPI {
 	/**
 	 * Deletes all reactions of an emoji for a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji}
+	 * @see {@link https://discord.com/developers/docs/resources/message#delete-all-reactions-for-emoji}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to delete the reactions for
 	 * @param emoji - The emoji to delete the reactions for
@@ -186,7 +186,7 @@ export class ChannelsAPI {
 	/**
 	 * Adds a reaction to a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#create-reaction}
+	 * @see {@link https://discord.com/developers/docs/resources/message#create-reaction}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to add the reaction to
 	 * @param emoji - The emoji to add the reaction with
@@ -242,7 +242,7 @@ export class ChannelsAPI {
 	/**
 	 * Fetches the messages of a channel
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-messages}
+	 * @see {@link https://discord.com/developers/docs/resources/message#get-channel-messages}
 	 * @param channelId - The id of the channel to fetch messages from
 	 * @param query - The query options for fetching messages
 	 * @param options - The options for fetching the messages
@@ -299,7 +299,7 @@ export class ChannelsAPI {
 	/**
 	 * Deletes a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#delete-message}
+	 * @see {@link https://discord.com/developers/docs/resources/message#delete-message}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to delete
 	 * @param options - The options for deleting the message
@@ -315,7 +315,7 @@ export class ChannelsAPI {
 	/**
 	 * Bulk deletes messages
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages}
+	 * @see {@link https://discord.com/developers/docs/resources/message#bulk-delete-messages}
 	 * @param channelId - The id of the channel the messages are in
 	 * @param messageIds - The ids of the messages to delete
 	 * @param options - The options for deleting the messages
@@ -331,7 +331,7 @@ export class ChannelsAPI {
 	/**
 	 * Fetches a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-message}
+	 * @see {@link https://discord.com/developers/docs/resources/message#get-channel-message}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to fetch
 	 * @param options - The options for fetching the message
@@ -345,7 +345,7 @@ export class ChannelsAPI {
 	/**
 	 * Crossposts a message
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#crosspost-message}
+	 * @see {@link https://discord.com/developers/docs/resources/message#crosspost-message}
 	 * @param channelId - The id of the channel the message is in
 	 * @param messageId - The id of the message to crosspost
 	 * @param options - The options for crossposting the message
@@ -452,7 +452,7 @@ export class ChannelsAPI {
 	/**
 	 * Creates a new forum post
 	 *
-	 * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-in-forum-channel}
+	 * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel}
 	 * @param channelId - The id of the forum channel to start the thread in
 	 * @param body - The data for starting the thread
 	 * @param options - The options for starting the thread

packages/create-discord-bot/cliff.toml

@@ -30,8 +30,10 @@ body = """
 			{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
 			{% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
 		{% if commit.breaking %}\
-			{% for breakingChange in commit.footers %}\
-				\n{% raw %}  {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
+			{% for footer in commit.footers %}\
+				{% if footer.breaking %}\
+					\n{% raw %}  {% endraw %}- **{{ footer.token }}{{ footer.separator }}** {{ footer.value }}\
+				{% endif %}\
 			{% endfor %}\
 		{% endif %}\
 	{% endfor %}

packages/discord.js/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+# [14.16.2](https://github.com/discordjs/discord.js/compare/14.16.1...14.16.2) - (2024-09-12)
+
+## Bug Fixes
+
+- **ApplicationCommand:** Incorrect comparison in equals method (#10497) ([3c74aa2](https://github.com/discordjs/discord.js/commit/3c74aa204909323ff6d05991438bee2c583e838b)) by @monbrey
+- Type guard for sendable text-based channels (#10482) ([dea6840](https://github.com/discordjs/discord.js/commit/dea68400a38edb90b8b4242d64be14968943130d)) by @vladfrangu
+
+## Documentation
+
+- Update discord documentation links (#10484) ([799fa54](https://github.com/discordjs/discord.js/commit/799fa54fa4434144855be2f7a0bbac6ff8ce9d0b)) by @sdanialraza
+- **Message:** Mark `interaction` as deprecated (#10481) ([c13f18e](https://github.com/discordjs/discord.js/commit/c13f18e90eb6eb315397c095e948993856428757)) by @sdanialraza
+- **ApplicationEmojiManager:** Fix fetch example (#10480) ([4594896](https://github.com/discordjs/discord.js/commit/4594896b5404c6a34e07544951c59ff8f3657184)) by @sdanialraza
+
+## Typings
+
+- Export GroupDM helper type (#10478) ([aff772c](https://github.com/discordjs/discord.js/commit/aff772c7aa3b3de58780a94588d1f3576a434f32)) by @Qjuh
+
 # [14.16.1](https://github.com/discordjs/discord.js/compare/14.16.0...14.16.1) - (2024-09-02)
 
 ## Bug Fixes

packages/discord.js/cliff.toml

@@ -30,8 +30,10 @@ body = """
 			{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
 			{% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
 		{% if commit.breaking %}\
-			{% for breakingChange in commit.footers %}\
-				\n{% raw %}  {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
+			{% for footer in commit.footers %}\
+				{% if footer.breaking %}\
+					\n{% raw %}  {% endraw %}- **{{ footer.token }}{{ footer.separator }}** {{ footer.value }}\
+				{% endif %}\
 			{% endfor %}\
 		{% endif %}\
 	{% endfor %}
@@ -67,8 +69,7 @@ commit_parsers = [
 	{ body = ".*security", group = "Security"},
 ]
 filter_commits = true
-tag_pattern = "[0-9]*"
-skip_tags = "v[0-9]*|@discordjs*"
+tag_pattern = "^[0-9]+"
 ignore_tags = ""
 topo_order = false
 sort_commits = "newest"