Merge branch 'main' into feat/voice-encryption

apps/website/src/components/ParameterNode.tsx

@@ -29,6 +29,7 @@ export async function ParameterNode({
 								{description ? <Badges node={parameter} /> : null}
 								{parameter.name}
 								{parameter.isOptional ? '?' : ''}: <ExcerptNode node={parameter.typeExcerpt} version={version} />
+								{parameter.defaultValue ? ` = ${parameter.defaultValue}` : ''}
 							</span>
 							{description && parameter.description?.length ? (
 								<div className="mt-4 pl-4">

apps/website/src/components/PropertyNode.tsx

@@ -51,7 +51,13 @@ export async function PropertyNode({
 													<LinkIcon aria-hidden size={16} />
 												</Link>
 												{property.displayName}
-												{property.isOptional ? '?' : ''} : <ExcerptNode node={property.typeExcerpt} version={version} />
+												{property.isOptional ? '?' : ''} : <ExcerptNode node={property.typeExcerpt} version={version} />{' '}
+												{property.summary?.defaultValueBlock.length
+													? `= ${property.summary.defaultValueBlock.reduce(
+															(acc: string, def: { kind: string; text: string }) => `${acc}${def.text}`,
+															'',
+														)}`
+													: ''}
 											</span>
 										</h3>
 

packages/api-extractor-model/src/mixins/ApiParameterListMixin.ts

@@ -14,6 +14,7 @@ import type { IExcerptTokenRange } from './Excerpt.js';
  * @public
  */
 export interface IApiParameterOptions {
+	defaultValue: string | undefined;
 	isOptional: boolean;
 	isRest: boolean;
 	parameterName: string;
@@ -124,6 +125,7 @@ export function ApiParameterListMixin<TBaseClass extends IApiItemConstructor>(
 							isOptional: Boolean(parameterOptions.isOptional),
 							isRest: Boolean(parameterOptions.isRest),
 							parent: this,
+							defaultValue: parameterOptions.defaultValue,
 						});
 
 						this[_parameters].push(parameter);
@@ -171,6 +173,7 @@ export function ApiParameterListMixin<TBaseClass extends IApiItemConstructor>(
 					parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange,
 					isOptional: parameter.isOptional,
 					isRest: parameter.isRest,
+					defaultValue: parameter.defaultValue,
 				});
 			}
 

packages/api-extractor-model/src/model/ApiPackage.ts

@@ -41,6 +41,7 @@ const MinifyJSONMapping = {
 	constraintTokenRange: 'ctr',
 	dependencies: 'dp',
 	defaultTypeTokenRange: 'dtr',
+	defaultValue: 'dv',
 	docComment: 'd',
 	endIndex: 'en',
 	excerptTokens: 'ex',
@@ -293,7 +294,11 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented
 
 		const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration();
 
-		if (versionToDeserialize >= ApiJsonSchemaVersion.V_1004 && 'tsdocConfig' in jsonObject.metadata) {
+		if (
+			versionToDeserialize >= ApiJsonSchemaVersion.V_1004 &&
+			'tsdocConfig' in jsonObject.metadata &&
+			'$schema' in jsonObject.metadata.tsdocConfig
+		) {
 			const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromObject(jsonObject.metadata.tsdocConfig);
 			if (tsdocConfigFile.hasErrors) {
 				throw new Error(`Error loading ${apiJsonFilename}:\n` + tsdocConfigFile.getErrorSummary());

packages/api-extractor-model/src/model/Deserializer.ts

@@ -262,6 +262,7 @@ function mapParam(
 			startIndex: 1 + index + paramTokens.slice(0, index).reduce((akk, num) => akk + num, 0),
 			endIndex: 1 + index + paramTokens.slice(0, index + 1).reduce((akk, num) => akk + num, 0),
 		},
+		defaultValue: param.default,
 	};
 }
 

packages/api-extractor-model/src/model/Parameter.ts

@@ -12,6 +12,7 @@ import type { Excerpt } from '../mixins/Excerpt.js';
  * @public
  */
 export interface IParameterOptions {
+	defaultValue: string | undefined;
 	isOptional: boolean;
 	isRest: boolean;
 	name: string;
@@ -56,6 +57,11 @@ export class Parameter {
 	 */
 	public isRest: boolean;
 
+	/**
+	 * The default value for this parameter if optional
+	 */
+	public defaultValue: string | undefined;
+
 	private readonly _parent: ApiParameterListMixin;
 
 	public constructor(options: IParameterOptions) {
@@ -64,6 +70,7 @@ export class Parameter {
 		this.isOptional = options.isOptional;
 		this.isRest = options.isRest;
 		this._parent = options.parent;
+		this.defaultValue = options.defaultValue;
 	}
 
 	/**

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

@@ -843,6 +843,7 @@ export class ApiModelGenerator {
 			const parameters: IApiParameterOptions[] = this._captureParameters(
 				nodesToCapture,
 				functionDeclaration.parameters,
+				jsDoc?.params,
 			);
 
 			const excerptTokens: IExcerptToken[] = this._buildExcerptTokens(astDeclaration, nodesToCapture);
@@ -1043,6 +1044,7 @@ export class ApiModelGenerator {
 				const parameters: IApiParameterOptions[] = this._captureParameters(
 					nodesToCapture,
 					methodDeclaration.parameters,
+					jsDoc?.params,
 				);
 
 				const excerptTokens: IExcerptToken[] = this._buildExcerptTokens(astDeclaration, nodesToCapture);
@@ -1137,7 +1139,11 @@ export class ApiModelGenerator {
 					methodSignature.typeParameters,
 				);
 
-				const parameters: IApiParameterOptions[] = this._captureParameters(nodesToCapture, methodSignature.parameters);
+				const parameters: IApiParameterOptions[] = this._captureParameters(
+					nodesToCapture,
+					methodSignature.parameters,
+					jsDoc?.params,
+				);
 
 				const excerptTokens: IExcerptToken[] = this._buildExcerptTokens(astDeclaration, nodesToCapture);
 				const apiItemMetadata: ApiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
@@ -1342,7 +1348,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) ?? ''}${jsDoc.default ? ` (default: ${this._escapeSpecialChars(jsDoc.default)})` : ''}\n${
+							`/**\n * ${this._fixLinkTags(jsDoc.description) ?? ''}${jsDoc.default ? `\n * @defaultValue ${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
@@ -1529,6 +1535,7 @@ export class ApiModelGenerator {
 					},
 					isOptional: Boolean(parameter.optional),
 					isRest: parameter.name.startsWith('...'),
+					defaultValue: parameter.default?.toString(),
 				});
 				excerptTokens.push(...newTokens);
 				excerptTokens.push({
@@ -1548,6 +1555,7 @@ export class ApiModelGenerator {
 					},
 					isOptional: Boolean(parameter.optional),
 					isRest: parameter.name.startsWith('...'),
+					defaultValue: parameter.default?.toString(),
 				});
 				excerptTokens.push(...newTokens);
 				excerptTokens.push({
@@ -1640,6 +1648,7 @@ export class ApiModelGenerator {
 	private _captureParameters(
 		nodesToCapture: IExcerptBuilderNodeToCapture[],
 		parameterNodes: ts.NodeArray<ts.ParameterDeclaration>,
+		jsDoc?: DocgenParamJson[] | undefined,
 	): IApiParameterOptions[] {
 		const parameters: IApiParameterOptions[] = [];
 		for (const parameter of parameterNodes) {
@@ -1650,6 +1659,9 @@ export class ApiModelGenerator {
 				parameterTypeTokenRange,
 				isOptional: this._collector.typeChecker.isOptionalParameter(parameter),
 				isRest: Boolean(parameter.dotDotDotToken),
+				defaultValue:
+					parameter.initializer?.getText() ??
+					jsDoc?.find((param) => param.name === parameter.name.getText().trim())?.default?.toString(),
 			});
 		}
 
@@ -1753,7 +1765,7 @@ export class ApiModelGenerator {
 			return input;
 		}
 
-		return input.replaceAll(/(?<char>[{}])/g, '\\$<char>');
+		return input.replaceAll(/(?<char>[@{}])/g, '\\$<char>');
 	}
 
 	private _fixLinkTags(input?: string): string | undefined {
@@ -1848,7 +1860,7 @@ export class ApiModelGenerator {
 			isOptional: Boolean(prop.nullable),
 			isReadonly: Boolean(prop.readonly),
 			docComment: this._tsDocParser.parseString(
-				`/**\n * ${this._fixLinkTags(prop.description) ?? ''}${prop.default ? ` (default: ${this._escapeSpecialChars(prop.default)})` : ''}\n${
+				`/**\n * ${this._fixLinkTags(prop.description) ?? ''}\n${prop.default ? ` * @defaultValue ${this._escapeSpecialChars(prop.default)}\n` : ''}${
 					prop.see?.map((see) => ` * @see ${see}\n`).join('') ?? ''
 				}${prop.readonly ? ' * @readonly\n' : ''} */`,
 			).docComment,
@@ -1860,7 +1872,7 @@ export class ApiModelGenerator {
 					}${prop.name} :`,
 				},
 				...mappedVarType,
-				{ kind: ExcerptTokenKind.Content, text: ';' },
+				{ kind: ExcerptTokenKind.Content, text: `${prop.default ? ` = ${prop.default}` : ''};` },
 			],
 			propertyTypeTokenRange: { startIndex: 1, endIndex: 1 + mappedVarType.length },
 			releaseTag: prop.access === 'private' ? ReleaseTag.Internal : ReleaseTag.Public,
@@ -1883,6 +1895,7 @@ export class ApiModelGenerator {
 				startIndex: 1 + index + paramTokens.slice(0, index).reduce((akk, num) => akk + num, 0),
 				endIndex: 1 + index + paramTokens.slice(0, index + 1).reduce((akk, num) => akk + num, 0),
 			},
+			defaultValue: param.default?.toString(),
 		};
 	}
 
@@ -1907,7 +1920,7 @@ export class ApiModelGenerator {
 			excerptTokens.push(...newTokens);
 			excerptTokens.push({
 				kind: ExcerptTokenKind.Content,
-				text: `, ${method.params![index + 1]!.name}${
+				text: `${method.params![index]!.default ? ` = ${method.params![index]!.default}` : ''}, ${method.params![index + 1]!.name}${
 					method.params![index + 1]!.nullable || method.params![index + 1]!.optional ? '?' : ''
 				}: `,
 			});
@@ -1917,7 +1930,10 @@ export class ApiModelGenerator {
 			const newTokens = this._mapVarType(method.params[method.params.length - 1]!.type);
 			paramTokens.push(newTokens.length);
 			excerptTokens.push(...newTokens);
-			excerptTokens.push({ kind: ExcerptTokenKind.Content, text: `): ` });
+			excerptTokens.push({
+				kind: ExcerptTokenKind.Content,
+				text: `${method.params![method.params.length - 1]!.default ? ` = ${method.params![method.params.length - 1]!.default}` : ''}): `,
+			});
 		}
 
 		const returnTokens = this._mapVarType(method.returns?.[0] ?? []);

packages/builders/__tests__/components/button.test.ts

@@ -5,7 +5,6 @@ import {
 	type APIButtonComponentWithURL,
 } from 'discord-api-types/v10';
 import { describe, test, expect } from 'vitest';
-import { ButtonBuilder } from '../../src/components/button/Button.js';
 import { PrimaryButtonBuilder, PremiumButtonBuilder, LinkButtonBuilder } from '../../src/index.js';
 
 const longStr =

packages/builders/__tests__/types.test.ts

@@ -16,6 +16,6 @@ type BuilderPropsOnly<Type = ChatInputCommandBuilder> = Pick<
 	}
 >;
 
-expectTypeOf(getBuilder().addStringOption(getStringOption())).toMatchTypeOf<BuilderPropsOnly>();
+expectTypeOf(getBuilder().addStringOptions(getStringOption())).toMatchTypeOf<BuilderPropsOnly>();
 
-expectTypeOf(getBuilder().addSubcommand(getSubcommand())).toMatchTypeOf<BuilderPropsOnly>();
+expectTypeOf(getBuilder().addSubcommands(getSubcommand())).toMatchTypeOf<BuilderPropsOnly>();

packages/builders/package.json

@@ -66,7 +66,7 @@
 	"funding": "https://github.com/discordjs/discord.js?sponsor",
 	"dependencies": {
 		"@discordjs/util": "workspace:^",
-		"discord-api-types": "^0.37.101",
+		"discord-api-types": "^0.37.103",
 		"ts-mixer": "^6.0.4",
 		"tslib": "^2.6.3",
 		"zod": "^3.23.8",

packages/collection/__tests__/collection.test.ts

@@ -70,12 +70,20 @@ describe('at() tests', () => {
 		expect(coll.at(0)).toStrictEqual(1);
 	});
 
+	test('positive non-integer index', () => {
+		expect(coll.at(1.5)).toStrictEqual(2);
+	});
+
 	test('negative index', () => {
 		expect(coll.at(-1)).toStrictEqual(3);
 	});
 
+	test('negative non-integer index', () => {
+		expect(coll.at(-2.5)).toStrictEqual(2);
+	});
+
 	test('invalid positive index', () => {
-		expect(coll.at(4)).toBeUndefined();
+		expect(coll.at(3)).toBeUndefined();
 	});
 
 	test('invalid negative index', () => {
@@ -432,12 +440,20 @@ describe('keyAt() tests', () => {
 		expect(coll.keyAt(0)).toStrictEqual('a');
 	});
 
+	test('positive non-integer index', () => {
+		expect(coll.keyAt(1.5)).toStrictEqual('b');
+	});
+
 	test('negative index', () => {
 		expect(coll.keyAt(-1)).toStrictEqual('c');
 	});
 
+	test('negative non-integer index', () => {
+		expect(coll.keyAt(-2.5)).toStrictEqual('b');
+	});
+
 	test('invalid positive index', () => {
-		expect(coll.keyAt(4)).toBeUndefined();
+		expect(coll.keyAt(3)).toBeUndefined();
 	});
 
 	test('invalid negative index', () => {