docs: add missing, fix existing (#10842)

* docs: add missing, fix existing

* refactor: new stuff

* fix: requested changes

* fix: use `@link` for `@mixes`

Co-authored-by: Qjuh <[email protected]>

* chore: disable bad eslint rule

---------

Co-authored-by: Qjuh <[email protected]>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: 3 people

eslint.config.js

@@ -135,6 +135,7 @@ export default tseslint.config(
 		files: [`packages/builders/**/*${commonFiles}`],
 		rules: {
 			'@typescript-eslint/no-empty-object-type': 0,
+			'jsdoc/valid-types': 0,
 		},
 	},
 	{

packages/builders/src/components/ActionRow.ts

@@ -1,5 +1,3 @@
-/* eslint-disable jsdoc/check-param-names */
-
 import type {
 	APITextInputComponent,
 	APIActionRowComponent,
@@ -43,10 +41,11 @@ export interface ActionRowBuilderData
 
 /**
  * A builder that creates API-compatible JSON data for action rows.
- *
- * @typeParam ComponentType - The types of components this action row holds
  */
 export class ActionRowBuilder extends ComponentBuilder<APIActionRowComponent<APIComponentInActionRow>> {
+	/**
+	 * @internal
+	 */
 	protected readonly data: ActionRowBuilderData;
 
 	/**
@@ -57,7 +56,7 @@ export class ActionRowBuilder extends ComponentBuilder<APIActionRowComponent<API
 	}
 
 	/**
-	 * Creates a new action row from API data.
+	 * Creates a new action row.
 	 *
 	 * @param data - The API data to create this action row with
 	 * @example
@@ -90,12 +89,15 @@ export class ActionRowBuilder extends ComponentBuilder<APIActionRowComponent<API
 	 * 	.addComponents(button2, button3);
 	 * ```
 	 */
-	public constructor({ components = [], ...data }: Partial<APIActionRowComponent<APIComponentInActionRow>> = {}) {
+	public constructor(data: Partial<APIActionRowComponent<APIComponentInActionRow>> = {}) {
 		super();
+
+		const { components = [], ...rest } = data;
+
 		this.data = {
-			...structuredClone(data),
-			type: ComponentType.ActionRow,
+			...structuredClone(rest),
 			components: components.map((component) => createComponentBuilder(component)),
+			type: ComponentType.ActionRow,
 		};
 	}
 

packages/builders/src/components/Component.ts

@@ -13,6 +13,9 @@ export interface ComponentBuilderBaseData {
 export abstract class ComponentBuilder<Component extends APIBaseComponent<ComponentType>>
 	implements JSONEncodable<Component>
 {
+	/**
+	 * @internal
+	 */
 	protected abstract readonly data: ComponentBuilderBaseData;
 
 	/**

packages/builders/src/components/button/Button.ts

@@ -7,6 +7,9 @@ import { ComponentBuilder } from '../Component.js';
  * A builder that creates API-compatible JSON data for buttons.
  */
 export abstract class BaseButtonBuilder<ButtonData extends APIButtonComponent> extends ComponentBuilder<ButtonData> {
+	/**
+	 * @internal
+	 */
 	declare protected readonly data: Partial<ButtonData>;
 
 	/**

packages/builders/src/components/button/CustomIdButton.ts

@@ -7,6 +7,9 @@ export type CustomIdButtonStyle = APIButtonComponentWithCustomId['style'];
 
 /**
  * A builder that creates API-compatible JSON data for buttons with custom IDs.
+ *
+ * @mixes {@link BaseButtonBuilder}\<{@link discord-api-types/v10#(APIButtonComponentWithCustomId:interface)}\>
+ * @mixes {@link EmojiOrLabelButtonMixin}
  */
 export abstract class CustomIdButtonBuilder extends Mixin(
 	BaseButtonBuilder<APIButtonComponentWithCustomId>,

packages/builders/src/components/button/LinkButton.ts

@@ -10,6 +10,9 @@ import { EmojiOrLabelButtonMixin } from './mixins/EmojiOrLabelButtonMixin.js';
 
 /**
  * A builder that creates API-compatible JSON data for buttons with links.
+ *
+ * @mixes {@link BaseButtonBuilder}\<{@link discord-api-types/v10#(APIButtonComponentWithURL:interface)}\>
+ * @mixes {@link EmojiOrLabelButtonMixin}
  */
 export class LinkButtonBuilder extends Mixin(BaseButtonBuilder<APIButtonComponentWithURL>, EmojiOrLabelButtonMixin) {
 	protected override readonly data: Partial<APIButtonComponentWithURL>;

packages/builders/src/components/button/mixins/EmojiOrLabelButtonMixin.ts

@@ -3,7 +3,13 @@ import type { APIButtonComponent, APIButtonComponentWithSKUId, APIMessageCompone
 export interface EmojiOrLabelButtonData
 	extends Pick<Exclude<APIButtonComponent, APIButtonComponentWithSKUId>, 'emoji' | 'label'> {}
 
+/**
+ * A mixin that adds emoji and label symbols to a button builder.
+ */
 export class EmojiOrLabelButtonMixin {
+	/**
+	 * @internal
+	 */
 	declare protected readonly data: EmojiOrLabelButtonData;
 
 	/**

packages/builders/src/components/selectMenu/BaseSelectMenu.ts

@@ -5,12 +5,15 @@ import { ComponentBuilder } from '../Component.js';
 /**
  * The base select menu builder that contains common symbols for select menu builders.
  *
- * @typeParam SelectMenuType - The type of select menu this would be instantiated for.
+ * @typeParam Data - The type of API data that is stored within the builder
  */
 export abstract class BaseSelectMenuBuilder<Data extends APISelectMenuComponent>
 	extends ComponentBuilder<Data>
 	implements JSONEncodable<APISelectMenuComponent>
 {
+	/**
+	 * @internal
+	 */
 	protected abstract override readonly data: Partial<
 		Pick<Data, 'custom_id' | 'disabled' | 'id' | 'max_values' | 'min_values' | 'placeholder'>
 	>;

packages/builders/src/components/selectMenu/ChannelSelectMenu.ts

@@ -17,9 +17,9 @@ export class ChannelSelectMenuBuilder extends BaseSelectMenuBuilder<APIChannelSe
 	protected override readonly data: Partial<APIChannelSelectComponent>;
 
 	/**
-	 * Creates a new select menu from API data.
+	 * Creates a new channel select menu.
 	 *
-	 * @param data - The API data to create this select menu with
+	 * @param data - The API data to create this channel select menu with
 	 * @example
 	 * Creating a select menu from an API data object:
 	 * ```ts

packages/builders/src/components/selectMenu/MentionableSelectMenu.ts

@@ -17,9 +17,9 @@ export class MentionableSelectMenuBuilder extends BaseSelectMenuBuilder<APIMenti
 	protected override readonly data: Partial<APIMentionableSelectComponent>;
 
 	/**
-	 * Creates a new select menu from API data.
+	 * Creates a new mentionable select menu.
 	 *
-	 * @param data - The API data to create this select menu with
+	 * @param data - The API data to create this mentionable select menu with
 	 * @example
 	 * Creating a select menu from an API data object:
 	 * ```ts