@minesa-org/mini-interaction 0.0.4 → 0.0.6

package/dist/builders/MiniContainerBuilder.js

@@ -0,0 +1,347 @@
+import { ComponentType } from "discord-api-types/v10";
+import { resolveJSONEncodable } from "./shared.js";
+function cloneContainerComponent(component) {
+    const resolved = resolveJSONEncodable(component);
+    return { ...resolved };
+}
+function cloneAccessory(accessory) {
+    const resolved = resolveJSONEncodable(accessory);
+    return { ...resolved };
+}
+/** Builder for structured message container payloads. */
+export class ContainerBuilder {
+    data;
+    constructor(data = {}) {
+        const components = data.components
+            ? data.components.map((component) => cloneContainerComponent(component))
+            : [];
+        this.data = {
+            ...data,
+            type: ComponentType.Container,
+            components,
+        };
+    }
+    /** Replaces the components contained in the container. */
+    setComponents(components) {
+        this.data.components = components.map((component) => cloneContainerComponent(component));
+        return this;
+    }
+    /** Replaces the sections contained in the container. */
+    setSections(sections) {
+        return this.setComponents(sections);
+    }
+    /** Adds a component to the container. */
+    addComponent(component) {
+        this.data.components ??= [];
+        this.data.components.push(cloneContainerComponent(component));
+        return this;
+    }
+    /** Adds a section to the container. */
+    addSection(section) {
+        return this.addComponent(section);
+    }
+    /** Sets or clears the accent colour on the container. */
+    setAccentColor(color) {
+        if (color === undefined) {
+            delete this.data.accent_color;
+        }
+        else {
+            this.data.accent_color = color ?? null;
+        }
+        return this;
+    }
+    /** Marks the container as a spoiler. */
+    setSpoiler(spoiler) {
+        if (spoiler === null || spoiler === undefined) {
+            delete this.data.spoiler;
+        }
+        else {
+            this.data.spoiler = spoiler;
+        }
+        return this;
+    }
+    /** Serialises the container into a structured message payload. */
+    toJSON() {
+        const components = this.data.components ?? [];
+        return {
+            ...this.data,
+            type: ComponentType.Container,
+            components: components.map((component) => ({ ...component })),
+        };
+    }
+}
+/** Builder for structured message sections. */
+export class SectionBuilder {
+    data;
+    constructor(data = {}) {
+        const components = data.components
+            ? data.components.map((component) => cloneTextDisplayComponent(component))
+            : [];
+        const rawAccessory = data.accessory;
+        const accessory = rawAccessory === undefined || rawAccessory === null
+            ? undefined
+            : cloneAccessory(rawAccessory);
+        this.data = {
+            ...data,
+            type: ComponentType.Section,
+            components,
+            accessory,
+        };
+    }
+    /** Replaces the text components within the section. */
+    setComponents(components) {
+        this.data.components = components.map((component) => cloneTextDisplayComponent(component));
+        return this;
+    }
+    /** Adds a text component to the section. */
+    addComponent(component) {
+        this.data.components ??= [];
+        this.data.components.push(cloneTextDisplayComponent(component));
+        return this;
+    }
+    /** Sets or clears the accessory component. */
+    setAccessory(accessory) {
+        if (accessory === null || accessory === undefined) {
+            this.data.accessory = undefined;
+        }
+        else {
+            this.data.accessory = cloneAccessory(accessory);
+        }
+        return this;
+    }
+    /** Serialises the section into a structured message payload. */
+    toJSON() {
+        const components = this.data.components ?? [];
+        const accessory = this.data.accessory
+            ? { ...this.data.accessory }
+            : undefined;
+        if (!accessory) {
+            throw new Error("[SectionBuilder] accessory is required for sections");
+        }
+        return {
+            ...this.data,
+            type: ComponentType.Section,
+            components: components.map((component) => ({ ...component })),
+            accessory,
+        };
+    }
+}
+function cloneTextDisplayComponent(component) {
+    const resolved = resolveJSONEncodable(component);
+    return { ...resolved };
+}
+/** Builder for structured message text display components. */
+export class TextDisplayBuilder {
+    data;
+    constructor(data = {}) {
+        this.data = {
+            ...data,
+            type: ComponentType.TextDisplay,
+        };
+    }
+    /** Sets or clears the primary text content. */
+    setContent(content) {
+        if (content === null || content === undefined) {
+            delete this.data.content;
+        }
+        else {
+            this.data.content = content;
+        }
+        return this;
+    }
+    /** Serialises the component into a structured message payload. */
+    toJSON() {
+        if (!this.data.content) {
+            throw new Error("[TextDisplayBuilder] content is required for text displays");
+        }
+        return {
+            ...this.data,
+            type: ComponentType.TextDisplay,
+        };
+    }
+}
+/** Builder for structured message separator components. */
+export class SeparatorBuilder {
+    data;
+    constructor(data = {}) {
+        this.data = {
+            ...data,
+            type: ComponentType.Separator,
+        };
+    }
+    /** Sets whether the separator should render a divider. */
+    setDivider(divider) {
+        if (divider === null || divider === undefined) {
+            delete this.data.divider;
+        }
+        else {
+            this.data.divider = divider;
+        }
+        return this;
+    }
+    /** Sets the separator spacing value. */
+    setSpacing(spacing) {
+        if (spacing === null || spacing === undefined) {
+            delete this.data.spacing;
+        }
+        else {
+            this.data.spacing = spacing;
+        }
+        return this;
+    }
+    /** Serialises the separator payload. */
+    toJSON() {
+        return {
+            ...this.data,
+            type: ComponentType.Separator,
+        };
+    }
+}
+/** Builder for structured message thumbnails. */
+export class ThumbnailBuilder {
+    data;
+    constructor(data = {}) {
+        this.data = {
+            ...data,
+            type: ComponentType.Thumbnail,
+            media: data.media ? { ...data.media } : undefined,
+        };
+    }
+    /** Sets the media payload for the thumbnail. */
+    setMedia(media) {
+        if (media === null || media === undefined) {
+            delete this.data.media;
+        }
+        else {
+            this.data.media = { ...media };
+        }
+        return this;
+    }
+    /** Sets the thumbnail description. */
+    setDescription(description) {
+        if (description === null || description === undefined) {
+            delete this.data.description;
+        }
+        else {
+            this.data.description = description;
+        }
+        return this;
+    }
+    /** Marks the thumbnail as a spoiler. */
+    setSpoiler(spoiler) {
+        if (spoiler === null || spoiler === undefined) {
+            delete this.data.spoiler;
+        }
+        else {
+            this.data.spoiler = spoiler;
+        }
+        return this;
+    }
+    /** Serialises the thumbnail payload. */
+    toJSON() {
+        if (!this.data.media) {
+            throw new Error("[ThumbnailBuilder] media is required for thumbnails");
+        }
+        return {
+            ...this.data,
+            type: ComponentType.Thumbnail,
+        };
+    }
+}
+/** Builder for structured message gallery items. */
+export class GalleryItemBuilder {
+    data;
+    constructor(data = {}) {
+        this.data = {
+            ...data,
+            media: data.media ? { ...data.media } : undefined,
+        };
+    }
+    /** Sets the media item payload. */
+    setMedia(media) {
+        if (media === null || media === undefined) {
+            delete this.data.media;
+        }
+        else {
+            this.data.media = { ...media };
+        }
+        return this;
+    }
+    /** Sets the media description. */
+    setDescription(description) {
+        if (description === null || description === undefined) {
+            delete this.data.description;
+        }
+        else {
+            this.data.description = description;
+        }
+        return this;
+    }
+    /** Marks the media item as a spoiler. */
+    setSpoiler(spoiler) {
+        if (spoiler === null || spoiler === undefined) {
+            delete this.data.spoiler;
+        }
+        else {
+            this.data.spoiler = spoiler;
+        }
+        return this;
+    }
+    /** Serialises the gallery item payload. */
+    toJSON() {
+        if (!this.data.media) {
+            throw new Error("[GalleryItemBuilder] media is required for gallery items");
+        }
+        return {
+            ...this.data,
+            media: { ...this.data.media },
+        };
+    }
+}
+/** Builder for structured message gallery components. */
+export class GalleryBuilder {
+    data;
+    constructor(data = {}) {
+        const items = data.items
+            ? data.items.map((item) => resolveGalleryItem(item))
+            : [];
+        this.data = {
+            ...data,
+            type: ComponentType.MediaGallery,
+            items,
+        };
+    }
+    /** Replaces the gallery items. */
+    setItems(items) {
+        this.data.items = items.map((item) => resolveGalleryItem(item));
+        return this;
+    }
+    /** Adds a gallery item to the payload. */
+    addItem(item) {
+        this.data.items ??= [];
+        this.data.items.push(resolveGalleryItem(item));
+        return this;
+    }
+    /** Serialises the gallery payload. */
+    toJSON() {
+        const items = this.data.items ?? [];
+        if (items.length === 0) {
+            throw new Error("[GalleryBuilder] at least one gallery item is required");
+        }
+        return {
+            ...this.data,
+            type: ComponentType.MediaGallery,
+            items: items.map((item) => ({ ...item })),
+        };
+    }
+}
+function resolveGalleryItem(item) {
+    const resolved = resolveJSONEncodable(item);
+    if (!resolved.media) {
+        throw new Error("[GalleryBuilder] gallery items require media");
+    }
+    return {
+        ...resolved,
+        media: { ...resolved.media },
+    };
+}

package/dist/builders/TextInputBuilder.d.ts

@@ -0,0 +1,57 @@
+import { TextInputStyle, type APITextInputComponent } from "discord-api-types/v10";
+import type { JSONEncodable } from "./shared.js";
+/** Shape describing initial text input data accepted by the builder. */
+export type TextInputBuilderData = {
+    customId?: string;
+    label?: string;
+    style?: TextInputStyle;
+    minLength?: number;
+    maxLength?: number;
+    required?: boolean;
+    value?: string;
+    placeholder?: string;
+};
+/** Builder for Discord text input components used in modals. */
+export declare class TextInputBuilder implements JSONEncodable<APITextInputComponent> {
+    private data;
+    /**
+     * Creates a new text input builder with optional seed data.
+     */
+    constructor(data?: TextInputBuilderData);
+    /**
+     * Sets the custom identifier for this text input.
+     */
+    setCustomId(customId: string): this;
+    /**
+     * Sets the label displayed above the text input.
+     */
+    setLabel(label: string): this;
+    /**
+     * Sets the style of the text input (Short or Paragraph).
+     */
+    setStyle(style: TextInputStyle): this;
+    /**
+     * Sets the minimum length of the input text.
+     */
+    setMinLength(minLength: number): this;
+    /**
+     * Sets the maximum length of the input text.
+     */
+    setMaxLength(maxLength: number): this;
+    /**
+     * Sets whether this text input is required.
+     */
+    setRequired(required: boolean): this;
+    /**
+     * Sets the pre-filled value for this text input.
+     */
+    setValue(value: string): this;
+    /**
+     * Sets the placeholder text shown when the input is empty.
+     */
+    setPlaceholder(placeholder: string): this;
+    /**
+     * Serialises the builder into an API compatible text input payload.
+     */
+    toJSON(): APITextInputComponent;
+}

package/dist/builders/TextInputBuilder.js

@@ -0,0 +1,98 @@
+import { ComponentType, TextInputStyle, } from "discord-api-types/v10";
+/** Builder for Discord text input components used in modals. */
+export class TextInputBuilder {
+    data;
+    /**
+     * Creates a new text input builder with optional seed data.
+     */
+    constructor(data = {}) {
+        this.data = {
+            customId: data.customId,
+            label: data.label,
+            style: data.style ?? TextInputStyle.Short,
+            minLength: data.minLength,
+            maxLength: data.maxLength,
+            required: data.required,
+            value: data.value,
+            placeholder: data.placeholder,
+        };
+    }
+    /**
+     * Sets the custom identifier for this text input.
+     */
+    setCustomId(customId) {
+        this.data.customId = customId;
+        return this;
+    }
+    /**
+     * Sets the label displayed above the text input.
+     */
+    setLabel(label) {
+        this.data.label = label;
+        return this;
+    }
+    /**
+     * Sets the style of the text input (Short or Paragraph).
+     */
+    setStyle(style) {
+        this.data.style = style;
+        return this;
+    }
+    /**
+     * Sets the minimum length of the input text.
+     */
+    setMinLength(minLength) {
+        this.data.minLength = minLength;
+        return this;
+    }
+    /**
+     * Sets the maximum length of the input text.
+     */
+    setMaxLength(maxLength) {
+        this.data.maxLength = maxLength;
+        return this;
+    }
+    /**
+     * Sets whether this text input is required.
+     */
+    setRequired(required) {
+        this.data.required = required;
+        return this;
+    }
+    /**
+     * Sets the pre-filled value for this text input.
+     */
+    setValue(value) {
+        this.data.value = value;
+        return this;
+    }
+    /**
+     * Sets the placeholder text shown when the input is empty.
+     */
+    setPlaceholder(placeholder) {
+        this.data.placeholder = placeholder;
+        return this;
+    }
+    /**
+     * Serialises the builder into an API compatible text input payload.
+     */
+    toJSON() {
+        if (!this.data.customId) {
+            throw new Error("[TextInputBuilder] custom_id is required.");
+        }
+        if (!this.data.label) {
+            throw new Error("[TextInputBuilder] label is required.");
+        }
+        return {
+            type: ComponentType.TextInput,
+            custom_id: this.data.customId,
+            label: this.data.label,
+            style: this.data.style ?? TextInputStyle.Short,
+            min_length: this.data.minLength,
+            max_length: this.data.maxLength,
+            required: this.data.required,
+            value: this.data.value,
+            placeholder: this.data.placeholder,
+        };
+    }
+}

package/dist/builders/index.d.ts

@@ -11,4 +11,12 @@ export { ChannelSelectMenuBuilder } from "./ChannelSelectMenuBuilder.js";
 export type { ChannelSelectMenuBuilderData } from "./ChannelSelectMenuBuilder.js";
 export { ModalBuilder } from "./ModalBuilder.js";
 export type { ModalBuilderData, ModalComponentLike } from "./ModalBuilder.js";
+export { TextInputBuilder } from "./TextInputBuilder.js";
+export type { TextInputBuilderData } from "./TextInputBuilder.js";
+export { AutomodRuleBuilder } from "./AutomodRuleBuilder.js";
+export type { AutomodRuleBuilderData } from "./AutomodRuleBuilder.js";
+export { EmbedBuilder } from "./EmbedBuilder.js";
+export type { EmbedBuilderData } from "./EmbedBuilder.js";
+export { ContainerBuilder, SectionBuilder, TextDisplayBuilder, SeparatorBuilder, GalleryBuilder, GalleryItemBuilder, ThumbnailBuilder, } from "./MiniContainerBuilder.js";
+export type { ContainerBuilderData, SectionBuilderData, TextDisplayBuilderData, SeparatorBuilderData, GalleryBuilderData, GalleryItemBuilderData, ThumbnailBuilderData, MiniContainerComponent, MiniSectionComponent, MiniTextDisplayComponent, MiniSeparatorComponent, MiniGalleryComponent, MiniGalleryItemComponent, MiniThumbnailComponent, MiniContentComponent, MiniSectionAccessoryComponent, } from "./MiniContainerBuilder.js";
 export type { JSONEncodable } from "./shared.js";

package/dist/builders/index.js

@@ -5,3 +5,7 @@ export { StringSelectMenuBuilder } from "./StringSelectMenuBuilder.js";
 export { RoleSelectMenuBuilder } from "./RoleSelectMenuBuilder.js";
 export { ChannelSelectMenuBuilder } from "./ChannelSelectMenuBuilder.js";
 export { ModalBuilder } from "./ModalBuilder.js";
+export { TextInputBuilder } from "./TextInputBuilder.js";
+export { AutomodRuleBuilder } from "./AutomodRuleBuilder.js";
+export { EmbedBuilder } from "./EmbedBuilder.js";
+export { ContainerBuilder, SectionBuilder, TextDisplayBuilder, SeparatorBuilder, GalleryBuilder, GalleryItemBuilder, ThumbnailBuilder, } from "./MiniContainerBuilder.js";

package/dist/clients/MiniInteraction.d.ts

@@ -3,6 +3,7 @@ import { APIInteractionResponse, RESTPostAPIChatInputApplicationCommandsJSONBody
 import type { MiniInteractionCommand } from "../types/Commands.js";
 import { RoleConnectionMetadataTypes } from "../types/RoleConnectionMetadataTypes.js";
 import { type MessageComponentInteraction } from "../utils/MessageComponentInteraction.js";
+import { type ModalSubmitInteraction } from "../utils/ModalSubmitInteraction.js";
 /** Configuration parameters for the MiniInteraction client. */
 export type MiniInteractionOptions = {
     applicationId: string;
@@ -41,6 +42,13 @@ export type MiniInteractionComponent = {
     customId: string;
     handler: MiniInteractionComponentHandler;
 };
+/** Handler signature invoked for Discord modal submit interactions. */
+export type MiniInteractionModalHandler = (interaction: ModalSubmitInteraction) => Promise<APIInteractionResponse | void> | APIInteractionResponse | void;
+/** Structure describing a modal handler mapped to a custom id. */
+export type MiniInteractionModal = {
+    customId: string;
+    handler: MiniInteractionModalHandler;
+};
 /** Node.js HTTP handler compatible with frameworks like Express or Next.js API routes. */
 export type MiniInteractionNodeHandler = (request: IncomingMessage, response: ServerResponse) => void;
 /** Web Fetch API compatible request handler for platforms such as Cloudflare Workers. */
@@ -62,6 +70,7 @@ export declare class MiniInteraction {
     private readonly componentsDirectory;
     private readonly commands;
     private readonly componentHandlers;
+    private readonly modalHandlers;
     private commandsLoaded;
     private loadCommandsPromise;
     private componentsLoaded;
@@ -94,6 +103,18 @@ export declare class MiniInteraction {
      * @param components - The component definitions to register.
      */
     useComponents(components: MiniInteractionComponent[]): this;
+    /**
+     * Registers a single modal handler mapped to a custom identifier.
+     *
+     * @param modal - The modal definition to register.
+     */
+    useModal(modal: MiniInteractionModal): this;
+    /**
+     * Registers multiple modal handlers in a single call.
+     *
+     * @param modals - The modal definitions to register.
+     */
+    useModals(modals: MiniInteractionModal[]): this;
     /**
      * Recursively loads components from the configured components directory.
      *
@@ -194,6 +215,10 @@ export declare class MiniInteraction {
      * Handles execution of a message component interaction.
      */
     private handleMessageComponent;
+    /**
+     * Handles execution of a modal submit interaction.
+     */
+    private handleModalSubmit;
     /**
      * Handles execution of an application command interaction.
      */