Merge branch 'main' into main

discordjs · Oct 12, 2024 · 9a1d51e · 9a1d51e
2 parents 3eec8fa + 960a80d
commit 9a1d51e
Show file tree

Hide file tree

Showing 273 changed files with 5,693 additions and 6,630 deletions.
diff --git a/apps/website/src/util/fetchDependencies.ts b/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(/^[\^~]/, '');
+}
diff --git a/packages/api-extractor/src/generators/ApiModelGenerator.ts b/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,

diff --git a/packages/brokers/CHANGELOG.md b/packages/brokers/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+# [@discordjs/brokers@1.0.0](https://github.com/discordjs/discord.js/compare/@discordjs/[email protected]...@discordjs/[email protected]) - (2024-09-01)
+
+## Refactor
+
+- **brokers:** Re-design API to make groups a constructor option (#10297) ([38a37b5](https://github.com/discordjs/discord.js/commit/38a37b5caf06913131c6dc2dc5cc258aecfe2266))
+- **brokers:** Make option props more correct (#10242) ([393ded4](https://github.com/discordjs/discord.js/commit/393ded4ea14e73b2bb42226f57896130329f88ca))
+  - **BREAKING CHANGE:** Classes now take redis client as standalone parameter, various props from the base option interface moved to redis options
+
 # [@discordjs/brokers@0.3.0](https://github.com/discordjs/discord.js/compare/@discordjs/[email protected]...@discordjs/[email protected]) - (2024-05-04)
 
 ## Bug Fixes

diff --git a/packages/brokers/README.md b/packages/brokers/README.md
@@ -23,7 +23,7 @@
 
 ## Installation
 
-**Node.js 18 or newer is required.**
+**Node.js 20 or newer is required.**
 
 ```sh
 npm install @discordjs/brokers

diff --git a/packages/brokers/cliff.toml b/packages/brokers/cliff.toml
@@ -28,13 +28,22 @@ body = """
 			**{{commit.scope}}:** \
 		  {% endif %}\
 			{{ 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 %}
-{% endfor %}\n
+{% endfor %}\
+{% if github.contributors | filter(attribute="is_first_time", value=true) | length %}\
+	\n### New Contributors\n
+	{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}\
+		* @{{ contributor.username }} made their first contribution in #{{ contributor.pr_number }}
+	{% endfor %}\
+{% endif %}\n
 """
 trim = true
 footer = ""

diff --git a/packages/brokers/package.json b/packages/brokers/package.json
@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json.schemastore.org/package.json",
 	"name": "@discordjs/brokers",
-	"version": "0.3.0",
+	"version": "1.0.0",
 	"description": "Powerful set of message brokers",
 	"scripts": {
 		"test": "vitest run",
@@ -89,7 +89,7 @@
 		"vitest": "^2.0.5"
 	},
 	"engines": {
-		"node": ">=18"
+		"node": ">=20"
 	},
 	"publishConfig": {
 		"access": "public",

diff --git a/packages/builders/CHANGELOG.md b/packages/builders/CHANGELOG.md
@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+# [@discordjs/builders@1.9.0](https://github.com/discordjs/discord.js/compare/@discordjs/[email protected]...@discordjs/[email protected]) - (2024-09-01)
+
+## Features
+
+- User-installable apps (#10227) ([fc0b6f7](https://github.com/discordjs/discord.js/commit/fc0b6f7f8ebd94a4a05fac0c76e49b23752a8e65))
+- **builders:** Update to @sapphire/shapeshift v4 (#10291) ([2d5531f](https://github.com/discordjs/discord.js/commit/2d5531f35c6b4d70f83e46b99c284030108dcf5c))
+- **SlashCommandBuilder:** Add explicit command type when building (#10395) ([b2970bb](https://github.com/discordjs/discord.js/commit/b2970bb2dddf70d2d918fda825059315f35d23f3))
+- Premium buttons (#10353) ([4f59b74](https://github.com/discordjs/discord.js/commit/4f59b740d01b9ff2213949708a36e17da32b89c3))
+- Add user-installable apps support  (#10348) ([9c76bbe](https://github.com/discordjs/discord.js/commit/9c76bbea172d49320f7fdac19ec1a43a49d05116))
+
 # [@discordjs/builders@1.8.2](https://github.com/discordjs/discord.js/compare/@discordjs/[email protected]...@discordjs/[email protected]) - (2024-06-02)
 
 ## Bug Fixes

diff --git a/packages/builders/README.md b/packages/builders/README.md
@@ -23,7 +23,7 @@
 
 ## Installation
 
-**Node.js 16.11.0 or newer is required.**
+**Node.js 18 or newer is required.**
 
 ```sh
 npm install @discordjs/builders

diff --git a/packages/builders/__tests__/components/actionRow.test.ts b/packages/builders/__tests__/components/actionRow.test.ts
@@ -7,8 +7,8 @@ import {
 import { describe, test, expect } from 'vitest';
 import {
 	ActionRowBuilder,
-	ButtonBuilder,
 	createComponentBuilder,
+	PrimaryButtonBuilder,
 	StringSelectMenuBuilder,
 	StringSelectMenuOptionBuilder,
 } from '../../src/index.js';
@@ -41,21 +41,14 @@ const rowWithSelectMenuData: APIActionRowComponent<APIMessageActionRowComponent>
 					value: 'two',
 				},
 			],
-			max_values: 10,
-			min_values: 12,
+			max_values: 2,
+			min_values: 2,
 		},
 	],
 };
 
 describe('Action Row Components', () => {
 	describe('Assertion Tests', () => {
-		test('GIVEN valid components THEN do not throw', () => {
-			expect(() => new ActionRowBuilder().addComponents(new ButtonBuilder())).not.toThrowError();
-			expect(() => new ActionRowBuilder().setComponents(new ButtonBuilder())).not.toThrowError();
-			expect(() => new ActionRowBuilder().addComponents([new ButtonBuilder()])).not.toThrowError();
-			expect(() => new ActionRowBuilder().setComponents([new ButtonBuilder()])).not.toThrowError();
-		});
-
 		test('GIVEN valid JSON input THEN valid JSON output is given', () => {
 			const actionRowData: APIActionRowComponent<APIMessageActionRowComponent> = {
 				type: ComponentType.ActionRow,
@@ -72,22 +65,10 @@ describe('Action Row Components', () => {
 						style: ButtonStyle.Link,
 						url: 'https://google.com',
 					},
-					{
-						type: ComponentType.StringSelect,
-						placeholder: 'test',
-						custom_id: 'test',
-						options: [
-							{
-								label: 'option',
-								value: 'option',
-							},
-						],
-					},
 				],
 			};
 
 			expect(new ActionRowBuilder(actionRowData).toJSON()).toEqual(actionRowData);
-			expect(new ActionRowBuilder().toJSON()).toEqual({ type: ComponentType.ActionRow, components: [] });
 			expect(() => createComponentBuilder({ type: ComponentType.ActionRow, components: [] })).not.toThrowError();
 		});
 
@@ -120,24 +101,23 @@ describe('Action Row Components', () => {
 								value: 'two',
 							},
 						],
-						max_values: 10,
-						min_values: 12,
+						max_values: 1,
+						min_values: 1,
 					},
 				],
 			};
 
 			expect(new ActionRowBuilder(rowWithButtonData).toJSON()).toEqual(rowWithButtonData);
 			expect(new ActionRowBuilder(rowWithSelectMenuData).toJSON()).toEqual(rowWithSelectMenuData);
-			expect(new ActionRowBuilder().toJSON()).toEqual({ type: ComponentType.ActionRow, components: [] });
 			expect(() => createComponentBuilder({ type: ComponentType.ActionRow, components: [] })).not.toThrowError();
 		});
 
 		test('GIVEN valid builder options THEN valid JSON output is given 2', () => {
-			const button = new ButtonBuilder().setLabel('test').setStyle(ButtonStyle.Primary).setCustomId('123');
+			const button = new PrimaryButtonBuilder().setLabel('test').setCustomId('123');
 			const selectMenu = new StringSelectMenuBuilder()
 				.setCustomId('1234')
-				.setMaxValues(10)
-				.setMinValues(12)
+				.setMaxValues(2)
+				.setMinValues(2)
 				.setOptions(
 					new StringSelectMenuOptionBuilder().setLabel('one').setValue('one'),
 					new StringSelectMenuOptionBuilder().setLabel('two').setValue('two'),
@@ -147,10 +127,39 @@ describe('Action Row Components', () => {
 					new StringSelectMenuOptionBuilder().setLabel('two').setValue('two'),
 				]);
 
-			expect(new ActionRowBuilder().addComponents(button).toJSON()).toEqual(rowWithButtonData);
-			expect(new ActionRowBuilder().addComponents(selectMenu).toJSON()).toEqual(rowWithSelectMenuData);
-			expect(new ActionRowBuilder().addComponents([button]).toJSON()).toEqual(rowWithButtonData);
-			expect(new ActionRowBuilder().addComponents([selectMenu]).toJSON()).toEqual(rowWithSelectMenuData);
+			expect(new ActionRowBuilder().addPrimaryButtonComponents(button).toJSON()).toEqual(rowWithButtonData);
+			expect(new ActionRowBuilder().addStringSelectMenuComponent(selectMenu).toJSON()).toEqual(rowWithSelectMenuData);
+			expect(new ActionRowBuilder().addPrimaryButtonComponents([button]).toJSON()).toEqual(rowWithButtonData);
+		});
+
+		test('GIVEN 2 select menus THEN it throws', () => {
+			const selectMenu = new StringSelectMenuBuilder()
+				.setCustomId('1234')
+				.setOptions(
+					new StringSelectMenuOptionBuilder().setLabel('one').setValue('one'),
+					new StringSelectMenuOptionBuilder().setLabel('two').setValue('two'),
+				);
+
+			expect(() =>
+				new ActionRowBuilder()
+					.addStringSelectMenuComponent(selectMenu)
+					.addStringSelectMenuComponent(selectMenu)
+					.toJSON(),
+			).toThrowError();
+		});
+
+		test('GIVEN a button and a select menu THEN it throws', () => {
+			const button = new PrimaryButtonBuilder().setLabel('test').setCustomId('123');
+			const selectMenu = new StringSelectMenuBuilder()
+				.setCustomId('1234')
+				.setOptions(
+					new StringSelectMenuOptionBuilder().setLabel('one').setValue('one'),
+					new StringSelectMenuOptionBuilder().setLabel('two').setValue('two'),
+				);
+
+			expect(() =>
+				new ActionRowBuilder().addStringSelectMenuComponent(selectMenu).addPrimaryButtonComponents(button).toJSON(),
+			).toThrowError();
 		});
 	});
 });