@lunibee/builders 0.2.3 → 0.3.0

package/src/components.ts

@@ -1,32 +1,9 @@
-// Re-export the canonical ButtonType from @lunibee/types so the builders package
-// never ships a drifting duplicate (the old local copy was missing `Premium: 6`).
-import { ButtonType } from "@lunibee/types";
-export { ButtonType };
+import { ButtonType, ComponentEnum } from "@lunibee/types";
+export { ButtonType, ComponentEnum };
 
-/** Component type constants exposed by Lunibee. */
-export const ComponentEnum = {
-    ActionRow: 1,
-    Button: 2,
-    StringSelect: 3,
-    TextInput: 4,
-    UserSelect: 5,
-    RoleSelect: 6,
-    MentionableSelect: 7,
-    ChannelSelect: 8,
-    Section: 9,
-    TextDisplay: 10,
-    Thumbnail: 11,
-    MediaGallery: 12,
-    File: 13,
-    Separator: 14,
-    ContentInventoryEntry: 16,
-    Container: 17,
-} as const;
 export const TextInputType = { Short: 1, Paragraph: 2 } as const;
 /** One {@link TextInputType} value, usable as a type. */
 export type TextInputType = (typeof TextInputType)[keyof typeof TextInputType];
-/** One {@link ComponentEnum} value, usable as a type. */
-export type ComponentEnum = (typeof ComponentEnum)[keyof typeof ComponentEnum];
 export interface APIComponentEmoji {
     id?: string | null;
     name?: string | null;
@@ -197,38 +174,52 @@ export class CreateActionRow<
         return { type: ComponentEnum.ActionRow, components };
     }
 }
-export class CreateStringSelect {
-    readonly #data: APIStringSelectComponent = {
-        type: ComponentEnum.StringSelect,
-    };
+/** Setters shared by string and entity select menus. */
+export class CreateSelectMenu {
+    readonly #select: APIStringSelectComponent | APIEntitySelectComponent;
+    protected constructor(
+        data: APIStringSelectComponent | APIEntitySelectComponent,
+    ) {
+        this.#select = data;
+    }
     public setCustomId(value: string): this {
         validateText(value, 100, "Component custom ID");
-        this.#data.custom_id = value;
+        this.#select.custom_id = value;
         return this;
     }
     public setPlaceholder(value: string): this {
         validateText(value, 150, "Component placeholder");
-        this.#data.placeholder = value;
+        this.#select.placeholder = value;
         return this;
     }
     public setMinValues(value: number): this {
         validateCount(value, "min_values", 0);
-        this.#data.min_values = value;
+        this.#select.min_values = value;
         return this;
     }
     public setMaxValues(value: number): this {
         validateCount(value, "max_values", 1);
-        this.#data.max_values = value;
+        this.#select.max_values = value;
         return this;
     }
     public setRequired(value = true): this {
-        this.#data.required = value;
+        this.#select.required = value;
         return this;
     }
     public setDisabled(value = true): this {
-        this.#data.disabled = value;
+        this.#select.disabled = value;
         return this;
     }
+}
+export class CreateStringSelect extends CreateSelectMenu {
+    readonly #data: APIStringSelectComponent;
+    public constructor() {
+        const data: APIStringSelectComponent = {
+            type: ComponentEnum.StringSelect,
+        };
+        super(data);
+        this.#data = data;
+    }
     public addOptions(...options: APISelectOption[]): this {
         if (!options.length)
             throw new TypeError("At least one select option is required.");
@@ -358,7 +349,7 @@ export class CreateButton {
         return structuredClone(data);
     }
 }
-export class CreateEntitySelect {
+export class CreateEntitySelect extends CreateSelectMenu {
     readonly #data: APIEntitySelectComponent;
     public constructor(
         type:
@@ -374,35 +365,9 @@ export class CreateEntitySelect {
             type !== ComponentEnum.ChannelSelect
         )
             throw new TypeError("Invalid select component type.");
-        this.#data = { type };
-    }
-    public setCustomId(value: string): this {
-        validateText(value, 100, "Component custom ID");
-        this.#data.custom_id = value;
-        return this;
-    }
-    public setPlaceholder(value: string): this {
-        validateText(value, 150, "Component placeholder");
-        this.#data.placeholder = value;
-        return this;
-    }
-    public setMinValues(value: number): this {
-        validateCount(value, "min_values", 0);
-        this.#data.min_values = value;
-        return this;
-    }
-    public setMaxValues(value: number): this {
-        validateCount(value, "max_values", 1);
-        this.#data.max_values = value;
-        return this;
-    }
-    public setRequired(value = true): this {
-        this.#data.required = value;
-        return this;
-    }
-    public setDisabled(value = true): this {
-        this.#data.disabled = value;
-        return this;
+        const data: APIEntitySelectComponent = { type };
+        super(data);
+        this.#data = data;
     }
     public setDefaultValues(...values: APISelectDefaultValue[]): this {
         this.#data.default_values = values.map((value) => ({ ...value }));
@@ -797,119 +762,3 @@ export function componentsV2Message<
         flags: (options?.flags ?? 0) | IS_COMPONENTS_V2,
     };
 }
-
-// ─── Deprecated names (0.2.2), removed in 0.3.0 ────────────────────────────────
-// Builders are now `CreateX` (`ButtonBuilder` → `CreateButton`); `…Style` became
-// `…Type` and `…Type` became `…Enum`.
-
-/** @deprecated Use {@link CreateButton}. Removed in 0.3.0. */
-export const ButtonBuilder = CreateButton;
-/** @deprecated Use {@link CreateButton}. Removed in 0.3.0. */
-export type ButtonBuilder = CreateButton;
-
-/** @deprecated Use {@link CreateChannelSelectMenu}. Removed in 0.3.0. */
-export const ChannelSelectMenuBuilder = CreateChannelSelectMenu;
-/** @deprecated Use {@link CreateChannelSelectMenu}. Removed in 0.3.0. */
-export type ChannelSelectMenuBuilder = CreateChannelSelectMenu;
-
-/** @deprecated Use {@link CreateContainer}. Removed in 0.3.0. */
-export const ContainerBuilder = CreateContainer;
-/** @deprecated Use {@link CreateContainer}. Removed in 0.3.0. */
-export type ContainerBuilder = CreateContainer;
-
-/** @deprecated Use {@link CreateContentInventoryEntry}. Removed in 0.3.0. */
-export const ContentInventoryEntryBuilder = CreateContentInventoryEntry;
-/** @deprecated Use {@link CreateContentInventoryEntry}. Removed in 0.3.0. */
-export type ContentInventoryEntryBuilder = CreateContentInventoryEntry;
-
-/** @deprecated Use {@link CreateEntitySelect}. Removed in 0.3.0. */
-export const EntitySelectBuilder = CreateEntitySelect;
-/** @deprecated Use {@link CreateEntitySelect}. Removed in 0.3.0. */
-export type EntitySelectBuilder = CreateEntitySelect;
-
-/** @deprecated Use {@link CreateFileComponent}. Removed in 0.3.0. */
-export const FileComponentBuilder = CreateFileComponent;
-/** @deprecated Use {@link CreateFileComponent}. Removed in 0.3.0. */
-export type FileComponentBuilder = CreateFileComponent;
-
-/** @deprecated Use {@link CreateMediaGallery}. Removed in 0.3.0. */
-export const MediaGalleryBuilder = CreateMediaGallery;
-/** @deprecated Use {@link CreateMediaGallery}. Removed in 0.3.0. */
-export type MediaGalleryBuilder = CreateMediaGallery;
-
-/** @deprecated Use {@link CreateMentionableSelectMenu}. Removed in 0.3.0. */
-export const MentionableSelectMenuBuilder = CreateMentionableSelectMenu;
-/** @deprecated Use {@link CreateMentionableSelectMenu}. Removed in 0.3.0. */
-export type MentionableSelectMenuBuilder = CreateMentionableSelectMenu;
-
-/** @deprecated Use {@link CreateModal}. Removed in 0.3.0. */
-export const ModalBuilder = CreateModal;
-/** @deprecated Use {@link CreateModal}. Removed in 0.3.0. */
-export type ModalBuilder = CreateModal;
-
-/** @deprecated Use {@link CreateRoleSelectMenu}. Removed in 0.3.0. */
-export const RoleSelectMenuBuilder = CreateRoleSelectMenu;
-/** @deprecated Use {@link CreateRoleSelectMenu}. Removed in 0.3.0. */
-export type RoleSelectMenuBuilder = CreateRoleSelectMenu;
-
-/** @deprecated Use {@link CreateSection}. Removed in 0.3.0. */
-export const SectionBuilder = CreateSection;
-/** @deprecated Use {@link CreateSection}. Removed in 0.3.0. */
-export type SectionBuilder = CreateSection;
-
-/** @deprecated Use {@link CreateSeparator}. Removed in 0.3.0. */
-export const SeparatorBuilder = CreateSeparator;
-/** @deprecated Use {@link CreateSeparator}. Removed in 0.3.0. */
-export type SeparatorBuilder = CreateSeparator;
-
-/** @deprecated Use {@link CreateStringSelect}. Removed in 0.3.0. */
-export const StringSelectBuilder = CreateStringSelect;
-/** @deprecated Use {@link CreateStringSelect}. Removed in 0.3.0. */
-export type StringSelectBuilder = CreateStringSelect;
-
-/** @deprecated Use {@link CreateStringSelectMenu}. Removed in 0.3.0. */
-export const StringSelectMenuBuilder = CreateStringSelect;
-/** @deprecated Use {@link CreateStringSelectMenu}. Removed in 0.3.0. */
-export type StringSelectMenuBuilder = CreateStringSelect;
-
-/** @deprecated Use {@link CreateTextDisplay}. Removed in 0.3.0. */
-export const TextDisplayBuilder = CreateTextDisplay;
-/** @deprecated Use {@link CreateTextDisplay}. Removed in 0.3.0. */
-export type TextDisplayBuilder = CreateTextDisplay;
-
-/** @deprecated Use {@link CreateTextInput}. Removed in 0.3.0. */
-export const TextInputBuilder = CreateTextInput;
-/** @deprecated Use {@link CreateTextInput}. Removed in 0.3.0. */
-export type TextInputBuilder = CreateTextInput;
-
-/** @deprecated Use {@link CreateThumbnail}. Removed in 0.3.0. */
-export const ThumbnailBuilder = CreateThumbnail;
-/** @deprecated Use {@link CreateThumbnail}. Removed in 0.3.0. */
-export type ThumbnailBuilder = CreateThumbnail;
-
-/** @deprecated Use {@link CreateUserSelectMenu}. Removed in 0.3.0. */
-export const UserSelectMenuBuilder = CreateUserSelectMenu;
-/** @deprecated Use {@link CreateUserSelectMenu}. Removed in 0.3.0. */
-export type UserSelectMenuBuilder = CreateUserSelectMenu;
-
-/** @deprecated Use {@link CreateActionRow}. Removed in 0.3.0. */
-export const ActionRowBuilder = CreateActionRow;
-/** @deprecated Use {@link CreateActionRow}. Removed in 0.3.0. */
-export type ActionRowBuilder<
-    T extends { toJSON(): APIActionRowChild } = { toJSON(): APIActionRowChild },
-> = CreateActionRow<T>;
-
-/** @deprecated Use {@link ButtonType}. Removed in 0.3.0. */
-export const ButtonStyle = ButtonType;
-/** @deprecated Use {@link ButtonType}. Removed in 0.3.0. */
-export type ButtonStyle = ButtonType;
-
-/** @deprecated Use {@link TextInputType}. Removed in 0.3.0. */
-export const TextInputStyle = TextInputType;
-/** @deprecated Use {@link TextInputType}. Removed in 0.3.0. */
-export type TextInputStyle = TextInputType;
-
-/** @deprecated Use {@link ComponentEnum}. Removed in 0.3.0. */
-export const ComponentType = ComponentEnum;
-/** @deprecated Use {@link ComponentEnum}. Removed in 0.3.0. */
-export type ComponentType = ComponentEnum;

package/src/embed.ts

@@ -1,62 +1,76 @@
 /** Discord API embed field payload. */
 export interface EmbedField {
-    /** Field name. */ name: string;
-    /** Field value. */ value: string;
-    /** Whether the field is displayed inline. */ inline?: boolean;
+    /** Field name. */
+    name: string;
+    /** Field value. */
+    value: string;
+    /** Whether the field is displayed inline. */
+    inline?: boolean;
 }
 /** Discord API embed footer payload. */
 export interface EmbedFooter {
-    /** Footer text. */ text: string;
-    /** Footer icon URL. */ icon_url?: string;
+    /** Footer text. */
+    text: string;
+    /** Footer icon URL. */
+    icon_url?: string;
 }
 /** Discord API embed author payload. */
 export interface EmbedAuthor {
-    /** Author display name. */ name: string;
-    /** Author URL. */ url?: string;
-    /** Author icon URL. */ icon_url?: string;
+    /** Author display name. */
+    name: string;
+    /** Author URL. */
+    url?: string;
+    /** Author icon URL. */
+    icon_url?: string;
 }
 /** Strict Discord API embed payload. */
 export interface APIEmbed {
-    /** Embed title. */ title?: string;
-    /** Embed description. */ description?: string;
-    /** Embed URL. */ url?: string;
-    /** Embed color. */ color?: number;
-    /** ISO-8601 timestamp. */ timestamp?: string;
-    /** Embed footer. */ footer?: EmbedFooter;
-    /** Embed author. */ author?: EmbedAuthor;
-    /** Thumbnail payload. */ thumbnail?: { /** Thumbnail URL. */ url: string };
-    /** Image payload. */ image?: { /** Image URL. */ url: string };
-    /** Embed fields. */ fields?: EmbedField[];
+    /** Embed title. */
+    title?: string;
+    /** Embed description. */
+    description?: string;
+    /** Embed URL. */
+    url?: string;
+    /** Embed color. */
+    color?: number;
+    /** ISO-8601 timestamp. */
+    timestamp?: string;
+    /** Embed footer. */
+    footer?: EmbedFooter;
+    /** Embed author. */
+    author?: EmbedAuthor;
+    /** Thumbnail payload. */
+    thumbnail?: { /** Thumbnail URL. */ url: string };
+    /** Image payload. */
+    image?: { /** Image URL. */ url: string };
+    /** Embed fields. */
+    fields?: EmbedField[];
 }
 
 /** Builds compile-time-safe rich embed payloads for Discord API requests. */
 export class CreateEmbed {
     readonly #data: APIEmbed = {};
-    /** Sets the embed title. @param value Title text, or null to clear. @returns This builder. @throws {RangeError} If title exceeds Discord's limit. */ public setTitle(
-        value: string | null,
-    ): this {
+    /** Sets the embed title. @param value Title text, or null to clear. @returns This builder. @throws {RangeError} If title exceeds Discord's limit. */
+    public setTitle(value: string | null): this {
         if (value === null) delete this.#data.title;
         else this.#data.title = validate(value, 256, "Embed title");
         return this;
     }
-    /** Sets the embed description. @param value Description text, or null to clear. @returns This builder. @throws {RangeError} If description exceeds Discord's limit. */ public setDescription(
-        value: string | null,
-    ): this {
+    /** Sets the embed description. @param value Description text, or null to clear. @returns This builder. @throws {RangeError} If description exceeds Discord's limit. */
+    public setDescription(value: string | null): this {
         if (value === null) delete this.#data.description;
         else
             this.#data.description = validate(value, 4096, "Embed description");
         return this;
     }
-    /** Sets the embed URL. @param value Absolute URL, or null to clear. @returns This builder. @throws {TypeError} If URL is invalid. */ public setURL(
-        value: string | null,
-    ): this {
+    /** Sets the embed URL. @param value Absolute URL, or null to clear. @returns This builder. @throws {TypeError} If URL is invalid. */
+    public setURL(value: string | null): this {
         if (value === null) delete this.#data.url;
         else this.#data.url = url(value, "Embed URL");
         return this;
     }
-    /** Sets the embed color. @param value RGB integer. @returns This builder. @throws {RangeError} If color is outside 24-bit RGB range. */ public setColor(
-        value: number,
-    ): this {
+    /** Sets the embed color. @param value RGB integer. @returns This builder. @throws {RangeError} If color is outside 24-bit RGB range. */
+    public setColor(value: number): this {
         if (!Number.isInteger(value) || value < 0 || value > 0xffffff)
             throw new RangeError(
                 "Embed color must be an integer between 0 and 16777215.",
@@ -64,18 +78,16 @@ export class CreateEmbed {
         this.#data.color = value;
         return this;
     }
-    /** Sets the embed timestamp. @param value Date value. @returns This builder. @throws {RangeError} If date is invalid. */ public setTimestamp(
-        value = new Date(),
-    ): this {
+    /** Sets the embed timestamp. @param value Date value. @returns This builder. @throws {RangeError} If date is invalid. */
+    public setTimestamp(value = new Date()): this {
         const date = value instanceof Date ? value : new Date(value);
         if (Number.isNaN(date.getTime()))
             throw new RangeError("Embed timestamp must be a valid date.");
         this.#data.timestamp = date.toISOString();
         return this;
     }
-    /** Sets the embed footer. @param value Footer payload. @returns This builder. @throws {RangeError} If footer text exceeds Discord's limit. */ public setFooter(
-        value: EmbedFooter,
-    ): this {
+    /** Sets the embed footer. @param value Footer payload. @returns This builder. @throws {RangeError} If footer text exceeds Discord's limit. */
+    public setFooter(value: EmbedFooter): this {
         this.#data.footer = {
             text: validate(value.text, 2048, "Footer text"),
             ...(value.icon_url
@@ -84,9 +96,8 @@ export class CreateEmbed {
         };
         return this;
     }
-    /** Sets the embed author. @param value Author payload. @returns This builder. @throws {RangeError} If author name exceeds Discord's limit. */ public setAuthor(
-        value: EmbedAuthor,
-    ): this {
+    /** Sets the embed author. @param value Author payload. @returns This builder. @throws {RangeError} If author name exceeds Discord's limit. */
+    public setAuthor(value: EmbedAuthor): this {
         this.#data.author = {
             name: validate(value.name, 256, "Author name"),
             ...(value.url ? { url: url(value.url, "Author URL") } : {}),
@@ -96,9 +107,8 @@ export class CreateEmbed {
         };
         return this;
     }
-    /** Sets the thumbnail URL. @param value Thumbnail URL or payload, or null to clear. @returns This builder. @throws {TypeError} If URL is invalid. */ public setThumbnail(
-        value: { url: string } | string | null,
-    ): this {
+    /** Sets the thumbnail URL. @param value Thumbnail URL or payload, or null to clear. @returns This builder. @throws {TypeError} If URL is invalid. */
+    public setThumbnail(value: { url: string } | string | null): this {
         if (value === null) {
             delete this.#data.thumbnail;
             return this;
@@ -107,9 +117,8 @@ export class CreateEmbed {
         this.#data.thumbnail = { url: url(valueURL, "Thumbnail URL") };
         return this;
     }
-    /** Sets the image URL. @param value Image URL or payload, or null to clear. @returns This builder. @throws {TypeError} If URL is invalid. */ public setImage(
-        value: { url: string } | string | null,
-    ): this {
+    /** Sets the image URL. @param value Image URL or payload, or null to clear. @returns This builder. @throws {TypeError} If URL is invalid. */
+    public setImage(value: { url: string } | string | null): this {
         if (value === null) {
             delete this.#data.image;
             return this;
@@ -120,9 +129,8 @@ export class CreateEmbed {
     }
     /** Adds embed fields. Accepts both the spread form `addFields(a, b)` and the
      * single-array form `addFields([a, b])` for discord.js `RestOrArray` parity.
-     * @param fields Field payloads, spread or as a single array. @returns This builder. @throws {RangeError} If the 25-field limit is exceeded. */ public addFields(
-        ...fields: EmbedField[] | [EmbedField[]]
-    ): this {
+     * @param fields Field payloads, spread or as a single array. @returns This builder. @throws {RangeError} If the 25-field limit is exceeded. */
+    public addFields(...fields: EmbedField[] | [EmbedField[]]): this {
         const resolved = (
             fields.length === 1 && Array.isArray(fields[0]) ? fields[0] : fields
         ) as EmbedField[];
@@ -147,7 +155,8 @@ export class CreateEmbed {
         this.#data.fields = [];
         return this.addFields(...fields);
     }
-    /** Replaces fields starting at an index. @param index Start index. @param deleteCount Number of fields to remove. @param fields Replacement fields. @returns This builder. @throws {RangeError} If arguments are invalid or the 25-field limit is exceeded. */ public spliceFields(
+    /** Replaces fields starting at an index. @param index Start index. @param deleteCount Number of fields to remove. @param fields Replacement fields. @returns This builder. @throws {RangeError} If arguments are invalid or the 25-field limit is exceeded. */
+    public spliceFields(
         index: number,
         deleteCount: number,
         ...fields: EmbedField[]
@@ -170,19 +179,23 @@ export class CreateEmbed {
         this.#data.fields = current;
         return this;
     }
-    /** Removes all embed fields. @returns This builder. */ public clearFields(): this {
+    /** Removes all embed fields. @returns This builder. */
+    public clearFields(): this {
         delete this.#data.fields;
         return this;
     }
-    /** Removes the embed title. @returns This builder. */ public clearTitle(): this {
+    /** Removes the embed title. @returns This builder. */
+    public clearTitle(): this {
         delete this.#data.title;
         return this;
     }
-    /** Removes the embed description. @returns This builder. */ public clearDescription(): this {
+    /** Removes the embed description. @returns This builder. */
+    public clearDescription(): this {
         delete this.#data.description;
         return this;
     }
-    /** Returns a deep-cloned Discord API payload. @returns Strict embed payload. */ public get data(): APIEmbed {
+    /** Returns a deep-cloned Discord API payload. @returns Strict embed payload. */
+    public get data(): APIEmbed {
         return this.toJSON();
     }
     public toJSON(): APIEmbed {
@@ -203,12 +216,3 @@ function url(value: string, field: string): string {
         throw new TypeError(`${field} must be a valid URL.`, { cause: error });
     }
 }
-
-// ─── Deprecated names (0.2.2), removed in 0.3.0 ────────────────────────────────
-// Builders are now `CreateX` (`ButtonBuilder` → `CreateButton`); `…Style` became
-// `…Type` and `…Type` became `…Enum`.
-
-/** @deprecated Use {@link CreateEmbed}. Removed in 0.3.0. */
-export const EmbedBuilder = CreateEmbed;
-/** @deprecated Use {@link CreateEmbed}. Removed in 0.3.0. */
-export type EmbedBuilder = CreateEmbed;

package/src/index.ts

@@ -45,53 +45,6 @@ export {
     CreateContextMenuCommand,
 } from "./commands.js";
 export { CreateAttachment, type AttachmentData } from "./attachment.js";
-
-// Deprecated names (0.2.2), removed in 0.3.0.
-export { AttachmentBuilder } from "./attachment.js";
-export { EmbedBuilder } from "./embed.js";
-export {
-    AttachmentOptionBuilder,
-    BooleanOptionBuilder,
-    ChannelOptionBuilder,
-    CommandOptionBuilder,
-    ContextMenuCommandBuilder,
-    IntegerOptionBuilder,
-    MentionableOptionBuilder,
-    MessageCommandBuilder,
-    NumberOptionBuilder,
-    RoleOptionBuilder,
-    SlashCommandBuilder,
-    StringOptionBuilder,
-    SubcommandBuilder,
-    SubcommandGroupBuilder,
-    UserCommandBuilder,
-    UserOptionBuilder,
-    ApplicationCommandOptionType,
-} from "./commands.js";
-export {
-    ButtonBuilder,
-    ChannelSelectMenuBuilder,
-    ContainerBuilder,
-    ContentInventoryEntryBuilder,
-    EntitySelectBuilder,
-    FileComponentBuilder,
-    MediaGalleryBuilder,
-    MentionableSelectMenuBuilder,
-    ModalBuilder,
-    RoleSelectMenuBuilder,
-    SectionBuilder,
-    SeparatorBuilder,
-    StringSelectBuilder,
-    StringSelectMenuBuilder,
-    TextDisplayBuilder,
-    TextInputBuilder,
-    ThumbnailBuilder,
-    UserSelectMenuBuilder,
-    ActionRowBuilder,
-    ButtonStyle,
-    TextInputStyle,
-    ComponentType,
-} from "./components.js";
 export type {
     APIComponent,
     APIComponentEmoji,