@open-discord-bots/framework 0.2.17 → 0.3.1

package/dist/api/modules/component.d.ts

@@ -0,0 +1,928 @@
+import { ODId, ODValidId, ODManagerData, ODNoGeneric, ODManager, ODValidButtonColor, ODInterfaceWithPartialProperty } from "./base.js";
+import * as discord from "discord.js";
+import { ODWorkerManager, ODWorkerCallback } from "./worker.js";
+import { ODDebugger } from "./console.js";
+/**## ODComponentFactoryInstance `class`
+ * An Open Discord component factory instance.
+ *
+ * It will contain the final root component which is returned by an `ODComponentFactory`.
+ * This component can be used in another `ODComponentFactory` or rendered to a message/modal.
+ */
+export declare class ODComponentFactoryInstance<Component extends ODComponent<object, any>> {
+    /**The root component of this factory. */
+    private rootComponent;
+    /**The root component of this factory. */
+    getComponent(): Component | null;
+    /**Set the root component of this factory. */
+    setComponent(c: Component | null): void;
+}
+/**## ODComponentFactory `class`
+ * An Open Discord component factory.
+ *
+ * It is a collection of functions/workers/hooks which will build a Discord message/modal component from scratch.
+ * Plugins can intercept and modify these workers to replace default behaviour or layout.
+ */
+export declare class ODComponentFactory<Component extends ODComponent<object, any>, Origin extends string, Params, WorkerIds extends string = string> extends ODManagerData {
+    /**A collection of all workers for this component factory.  */
+    workers: ODWorkerManager<ODComponentFactoryInstance<Component>, Origin, Params, WorkerIds>;
+    constructor(id: ODValidId, callback?: ODWorkerCallback<ODComponentFactoryInstance<Component>, Origin, Params>, priority?: number, callbackId?: ODValidId);
+    /**Run all workers and return the resulting component. */
+    build(origin: Origin, params: Params): Promise<ODComponentInferBuildResult<Component>>;
+}
+/**## ODComponentManagerIdConstraint `type`
+ * The constraint/layout for id mappings/interfaces of the `ODComponentManager` class.
+ */
+export type ODComponentManagerIdConstraint = Record<string, {
+    origin: string;
+    params: object;
+    workers: string;
+}>;
+/**## ODBaseComponentManager `class`
+ * A generic Open Discord component manager.
+ *
+ * It contains a collection of all Open Discord component factories. You can:
+ * - Add your own message/modal component factories
+ * - Modify existing message/modal component factories
+ *
+ * Messages created using this system are not compatible with `ODBuilder` messages!
+ */
+export declare class ODBaseComponentManager<IdList extends ODComponentManagerIdConstraint = ODComponentManagerIdConstraint, Component extends ODComponent<object, any> = ODComponent<object, any>> extends ODManager<ODComponentFactory<Component, string, {}, string>> {
+    get<FactoryId extends keyof ODNoGeneric<IdList>>(id: FactoryId): ODComponentFactory<Component, IdList[FactoryId]["origin"], IdList[FactoryId]["params"], IdList[FactoryId]["workers"]>;
+    get(id: ODValidId): ODComponentFactory<Component, string, {}, string> | null;
+    remove<FactoryId extends keyof ODNoGeneric<IdList>>(id: FactoryId): ODComponentFactory<Component, IdList[FactoryId]["origin"], IdList[FactoryId]["params"], IdList[FactoryId]["workers"]>;
+    remove(id: ODValidId): ODComponentFactory<Component, string, {}, string> | null;
+    exists(id: keyof ODNoGeneric<IdList>): boolean;
+    exists(id: ODValidId): boolean;
+}
+/**## ODSharedComponentManager `class
+ * A special class with types for shared message/modal `ODComponent`'s.
+ * Create button, dropdown or any other layout component template to use them in messages & modals.
+ */
+export declare class ODSharedComponentManager<IdList extends ODComponentManagerIdConstraint = ODComponentManagerIdConstraint> extends ODBaseComponentManager<IdList, ODComponent<object, any>> {
+    constructor(debug: ODDebugger);
+}
+/**## ODMessageComponentManager `class
+ * A special class with types for `ODMessageComponent`'s.
+ * Create message templates to use as replies and make use of shared components.
+ */
+export declare class ODMessageComponentManager<IdList extends ODComponentManagerIdConstraint = ODComponentManagerIdConstraint> extends ODBaseComponentManager<IdList, ODMessageComponent | ODSimpleMessageComponent> {
+    constructor(debug: ODDebugger);
+}
+/**## ODModalComponentManager `class
+ * A special class with types for `ODModalComponent`'s.
+ * Create modal templates to use as forms and make use of shared components.
+ */
+export declare class ODModalComponentManager<IdList extends ODComponentManagerIdConstraint = ODComponentManagerIdConstraint> extends ODBaseComponentManager<IdList, ODModalComponent> {
+    constructor(debug: ODDebugger);
+}
+/**## ODComponentManager `class`
+ * An Open Discord component manager.
+ *
+ * Create message & modal templates, re-use components and design all visual elements of the bot.
+ *
+ * Using the Open Discord component system has many advantages compared to vanilla `discord.js`:
+ * - Plugins can extend, edit & replace messages & components
+ * - Includes automatic error handling
+ * - Independent workers/hooks (with priority)
+ * - Fail-safe design using try-catch
+ * - Automatic switch between components v2 and legacy components depending on message requirements
+ * - Get to know the origin of the request (e.g. button, dropdown, modal, ...)
+ * - And so much more!
+ */
+export declare class ODComponentManager<SharedIdList extends ODComponentManagerIdConstraint = ODComponentManagerIdConstraint, MessageIdList extends ODComponentManagerIdConstraint = ODComponentManagerIdConstraint, ModalIdList extends ODComponentManagerIdConstraint = ODComponentManagerIdConstraint> {
+    /**The manager for all shared components. */
+    shared: ODSharedComponentManager<SharedIdList>;
+    /**The manager for all messages components. */
+    messages: ODMessageComponentManager<MessageIdList>;
+    /**The manager for all modals components. */
+    modals: ODModalComponentManager<ModalIdList>;
+    constructor(debug: ODDebugger);
+}
+/**## ODComponentInferBuildResult `type`
+ * Infer the build result of a certain component.
+ */
+export type ODComponentInferBuildResult<Component> = Component extends ODComponent<object, infer BuildResult> ? BuildResult : never;
+/**## ODComponent `class`
+ * An Open Discord message/modal component.
+ *
+ * This class itself doesn't do anything, but is a blueprint for other
+ * `ODComponent` classes which represent the new Discord message/modal components.
+ */
+export declare abstract class ODComponent<Data extends object, BuildResult> {
+    /**The id of this message/modal component. */
+    id: ODId;
+    /**The data or configuration of this message/modal component. */
+    readonly data: Data;
+    constructor(id: ODValidId, data: Data);
+    /**Build this component. Returns `null` when invalid. */
+    abstract build(): Promise<BuildResult | null> | BuildResult | null;
+}
+/**## ODGroupComponent `class`
+ * An Open Discord message/modal component with children.
+ *
+ * This class itself doesn't do anything, but is a blueprint for other
+ * `ODGroupComponent` classes which represent the new Discord message/modal components.
+ */
+export declare abstract class ODGroupComponent<Data extends object, ChildComponent extends ODComponent<object, any>, BuildResult> extends ODComponent<Data, BuildResult> {
+    /**The collection of child components. */
+    readonly children: ChildComponent[];
+    /**Add a new component to this group. There are multiple modes available:
+     * - `start`: insert at the start of the list.
+     * - `end`: insert at the end of the list.
+     * - `before`: insert before an existing component `referenceId` (`start` if `referenceId` is invalid)
+     * - `after`: insert after an existing component `referenceId` (`end` if `referenceId` is invalid)
+     * - `index`: insert at a certain index `referenceIndex` (`end` if `referenceIndex` is invalid)
+     */
+    addComponent(c: ChildComponent, mode: "start" | "end"): void;
+    addComponent(c: ChildComponent, mode: "before" | "after", referenceId: ODValidId): void;
+    addComponent(c: ChildComponent, mode: "index", referenceIndex: number): void;
+    /**Get a component with a certain ID in this group. Returns `null` if non-existent. */
+    getComponent(id: ODValidId): ChildComponent | null;
+    /**Get the position of a component with a certain ID in this group. Returns `-1` if non-existent. */
+    getComponentPosition(id: ODValidId): number;
+    /**Returns if a component with a certain ID exists in this group. */
+    existsComponent(id: ODValidId): boolean;
+    /**Remove a component with a certain ID from this group. Returns the removed component or `null if non-existent. */
+    removeComponent(id: ODValidId): ChildComponent | null;
+    /**Moves an existing component to a new location in this group. There are multiple modes available:
+     * - `start`: move to the start of the list.
+     * - `end`: move to the end of the list.
+     * - `before`: move before an existing component `referenceId` (`start` if `referenceId` is invalid)
+     * - `after`: move after an existing component `referenceId` (`end` if `referenceId` is invalid)
+     * - `index`: move to a certain index `referenceIndex` (`end` if `referenceIndex` is invalid)
+     */
+    moveComponent(id: ODValidId, mode: "start" | "end"): void;
+    moveComponent(id: ODValidId, mode: "before" | "after", referenceId: ODValidId): void;
+    moveComponent(id: ODValidId, mode: "index", referenceIndex: number): void;
+}
+/**## ODParentComponent `class`
+ * An Open Discord message/modal component with a single child.
+ *
+ * This class itself doesn't do anything, but is a blueprint for other
+ * `ODParentComponent` classes which represent the new Discord message/modal components.
+ */
+export declare abstract class ODParentComponent<Data extends object, ChildComponent extends ODComponent<object, any>, BuildResult> extends ODComponent<Data, BuildResult> {
+    /**The child component of this parent. */
+    private rawChild;
+    /**The child component of this parent. */
+    get child(): ChildComponent | null;
+    /**Set the child component of this parent. */
+    setComponent(c: ChildComponent | null): void;
+}
+/**## ODMessageComponentData `type`
+ * The configurable settings/options for the `ODMessageComponent`.
+ */
+export interface ODMessageComponentData {
+    /**Should the message be sent as ephemeral? */
+    ephemeral?: boolean;
+    /**Suppress/hide embeds. */
+    supressEmbeds?: boolean;
+    /**Do not send notifications to mentioned users or roles. */
+    supressNotifications?: boolean;
+    /**Additional options that aren't covered by the Open Discord api!*/
+    additionalOptions?: Omit<discord.MessageCreateOptions, "poll" | "content" | "embeds" | "components" | "files" | "flags" | "stickers">;
+    /**Add additional files which can be used in components as `attachment://...`  */
+    additionalAttachments?: discord.AttachmentBuilder[];
+}
+/**## ODValidMessageComponents `type`
+ * A collection of all valid top-level components that can be sent in a message.
+ */
+export type ODValidMessageComponents = ODTextComponent | ODFileComponent | ODGalleryComponent;
+/**## ODMessageComponentBuildResult `type`
+ * The constructed message from an `ODMessageComponent`.
+ */
+export interface ODMessageComponentBuildResult {
+    /**The message to send. */
+    msg: discord.MessageCreateOptions;
+    /**Is this message using Components V2? */
+    componentsV2: boolean;
+    /**Should the message be sent as ephemeral? */
+    ephemeral: boolean;
+    /**Suppress/hide embeds. */
+    supressEmbeds: boolean;
+    /**Do not send notifications to mentioned users or roles. */
+    supressNotifications: boolean;
+    /**The id of the `ODMessageComponent` this message was built with. */
+    id: ODId;
+}
+/**## ODMessageComponent `class`
+ * A message builder with **components v2** support.
+ * Add items to this message using `addComponent()`.
+ *
+ * Use `ODSimpleMessageComponent` for components v1, polls, embeds, etc
+ */
+export declare class ODMessageComponent extends ODGroupComponent<ODMessageComponentData, ODValidMessageComponents, ODMessageComponentBuildResult> {
+    constructor(id: ODValidId, data?: Partial<ODMessageComponentData>);
+    build(): Promise<{
+        id: ODId;
+        msg: {
+            nonce?: string | number;
+            forward?: discord.ForwardOptions;
+            tts?: boolean;
+            reply?: discord.ReplyOptions;
+            allowedMentions?: discord.MessageMentionOptions;
+            enforceNonce?: boolean;
+            components: discord.JSONEncodable<discord.APIMessageTopLevelComponent>[];
+            files: discord.AttachmentBuilder[];
+        };
+        componentsV2: boolean;
+        ephemeral: boolean;
+        supressEmbeds: boolean;
+        supressNotifications: boolean;
+    }>;
+    /**Enable/disable ephemeral mode. */
+    setEphemeral(value: boolean): void;
+    /**Enable supress (hide) embeds mode. */
+    setSupressEmbeds(value: boolean): void;
+    /**Enable supress (hide) notifications mode. */
+    setSupressNotifications(value: boolean): void;
+    /**Add an additional attachment which can be used in components as `attachment://...` */
+    addAdditionalAttachments(...attachments: discord.AttachmentBuilder[]): void;
+}
+/**## ODSimpleMessageComponentData `type`
+ * The configurable settings/options for the `ODSimpleMessageComponent`.
+ */
+export interface ODSimpleMessageComponentData {
+    /**Should the message be sent as ephemeral? */
+    ephemeral?: boolean;
+    /**Suppress/hide embeds. */
+    supressEmbeds?: boolean;
+    /**Do not send notifications to mentioned users or roles. */
+    supressNotifications?: boolean;
+    /**Additional options that aren't covered by the Open Discord api!*/
+    additionalOptions?: Omit<discord.MessageCreateOptions, "poll" | "content" | "embeds" | "components" | "files" | "flags">;
+    /**Add additional files which can be used in components as `attachment://...`  */
+    additionalAttachments?: discord.AttachmentBuilder[];
+}
+/**## ODValidSimpleMessageComponents `type`
+ * A collection of all valid top-level components that can be sent in a simple message (components v1).
+ */
+export type ODValidSimpleMessageComponents = ODContentComponent | ODEmbedComponent | ODFileComponent | ODPollComponent;
+/**## ODSimpleMessageComponent `class`
+ * A message builder with **components v1** support.
+ * Add items to this message using `addComponent()`.
+ *
+ * Use `ODMessageComponent` for components v2, components, containers, etc
+ */
+export declare class ODSimpleMessageComponent extends ODGroupComponent<ODSimpleMessageComponentData, ODValidSimpleMessageComponents, ODMessageComponentBuildResult> {
+    constructor(id: ODValidId, data?: Partial<ODMessageComponentData>);
+    build(): Promise<{
+        id: ODId;
+        msg: {
+            nonce?: string | number;
+            forward?: discord.ForwardOptions;
+            stickers?: readonly discord.StickerResolvable[];
+            tts?: boolean;
+            reply?: discord.ReplyOptions;
+            allowedMentions?: discord.MessageMentionOptions;
+            enforceNonce?: boolean;
+            content: string | undefined;
+            embeds: discord.EmbedBuilder[];
+            poll: discord.PollData | undefined;
+            files: discord.AttachmentBuilder[];
+        };
+        componentsV2: boolean;
+        ephemeral: boolean;
+        supressEmbeds: boolean;
+        supressNotifications: boolean;
+    }>;
+    /**Enable/disable ephemeral mode. */
+    setEphemeral(value: boolean): void;
+    /**Enable supress (hide) embeds mode. */
+    setSupressEmbeds(value: boolean): void;
+    /**Enable supress (hide) notifications mode. */
+    setSupressNotifications(value: boolean): void;
+    /**Add an additional attachment which can be used in components as `attachment://...` */
+    addAdditionalAttachments(...attachments: discord.AttachmentBuilder[]): void;
+}
+/**## ODModalComponentData `type`
+ * The configurable settings/options for the `ODModalComponent`.
+ */
+export interface ODModalComponentData {
+    /**The title of the modal (max 45 characters). */
+    title: string;
+    /**The custom id of this modal. */
+    customId?: string;
+}
+/**## ODValidModalComponents `type`
+ * A collection of all valid top-level components that can be sent in a message.
+ */
+export type ODValidModalComponents = ODLabelComponent | ODTextComponent;
+/**## ODModalComponent `class`
+ * A modal builder with **components v2** support.
+ * Add questions, select menu's & labels to this modal using `addComponent()`.
+ */
+export declare class ODModalComponent extends ODGroupComponent<ODModalComponentData, ODValidModalComponents, discord.ModalBuilder> {
+    constructor(id: ODValidId, data?: Partial<ODModalComponentData>);
+    build(): Promise<discord.ModalBuilder>;
+    /**Set the title of the modal. */
+    setTitle(title: string): void;
+    /**Set the custom id of this modal. */
+    setCustomId(id: string | null): this;
+}
+/**## ODActionRowComponentData `type`
+ * The configurable settings/options for the `ODActionRowComponent`.
+ */
+export interface ODActionRowComponentData {
+}
+/**## ODValidActionRowComponents `type`
+ * A collection of all valid action row components.
+ */
+export type ODValidActionRowComponents = ODButtonComponent | ODDropdownComponent;
+/**## ODActionRowComponent `class`
+ * An actionrow component which is a container for buttons, a select menu or inputs in a message or modal.
+ */
+export declare class ODActionRowComponent extends ODGroupComponent<ODActionRowComponentData, ODValidActionRowComponents, discord.ActionRowBuilder<discord.MessageActionRowComponentBuilder>> {
+    constructor(id: ODValidId, data?: Partial<ODActionRowComponentData>);
+    build(): Promise<discord.ActionRowBuilder<discord.MessageActionRowComponentBuilder>>;
+}
+/**## ODContainerComponentData `type`
+ * The configurable settings/options for the `ODContainerComponent`.
+ */
+export interface ODContainerComponentData {
+    /**The color of this container. */
+    color?: discord.ColorResolvable;
+    /**Mark the contents of this container as spoiler. */
+    spoiler: boolean;
+}
+/**## ODValidContainerComponents `type`
+ * A collection of all valid container components.
+ */
+export type ODValidContainerComponents = ODActionRowComponent | ODTextComponent | ODSectionComponent | ODGalleryComponent | ODSeparatorComponent | ODFileComponent;
+/**## ODContainerComponent `class`
+ * An embed-like container for text, titles, buttons, sections, separators and other components.
+ */
+export declare class ODContainerComponent extends ODGroupComponent<ODContainerComponentData, ODValidContainerComponents, {
+    container: discord.ContainerBuilder;
+    attachments: discord.AttachmentBuilder[];
+}> {
+    constructor(id: ODValidId, data?: Partial<ODContainerComponentData>);
+    build(): Promise<{
+        container: discord.ContainerBuilder;
+        attachments: discord.AttachmentBuilder[];
+    }>;
+    /**Set the accent color of this embed-like container. */
+    setColor(color: discord.ColorResolvable | null): void;
+    /**Mark the contents of this container as spoiler. */
+    setSpoiler(spoiler: boolean): void;
+}
+/**## ODSectionComponentData `type`
+ * The configurable settings/options for the `ODSectionComponent`.
+ */
+export interface ODSectionComponentData {
+    /**The accessory component shown on the right side of the section. */
+    accessory?: ODButtonComponent | ODThumbnailComponent;
+}
+/**## ODSectionComponent `class`
+ * A layout component that allows you to contextually associate content with an accessory component.
+ * - Components: Left
+ * - Accessory: Right
+ */
+export declare class ODSectionComponent extends ODGroupComponent<ODSectionComponentData, ODTextComponent, discord.SectionBuilder> {
+    constructor(id: ODValidId, data?: Partial<ODSectionComponentData>);
+    build(): Promise<discord.SectionBuilder>;
+    /**Set the accessory component shown on the right side of the section. */
+    setAccessory(accessory: ODButtonComponent | ODThumbnailComponent | null): void;
+}
+/**## ODLabelComponentData `type`
+ * The configurable settings/options for the `ODLabelComponent`.
+ */
+export interface ODLabelComponentData {
+    /**The title for the child component in the modal. */
+    title: string;
+    /**An option description for the child component in the modal. */
+    description?: string;
+}
+/**## ODValidLabelComponents `type`
+ * A collection of all valid label components.
+ */
+export type ODValidLabelComponents = ODShortInputComponent | ODParagraphInputComponent | ODDropdownComponent | ODRadioGroupComponent | ODCheckboxGroupComponent | ODCheckboxComponent | ODFileUploadComponent;
+/**## ODLabelComponent `class`
+ * A visual separator between components. The visibility and padding of this separator can be changed.
+ */
+export declare class ODLabelComponent extends ODParentComponent<ODLabelComponentData, ODValidLabelComponents, discord.LabelBuilder> {
+    constructor(id: ODValidId, data: Partial<ODLabelComponentData>);
+    build(): Promise<discord.LabelBuilder>;
+    /**Set the title of the child component in the modal. */
+    setTitle(title: string): void;
+    /**Set the description of the child component in the modal. */
+    setDescription(description: string | null): void;
+}
+/**## ODSeparatorComponentData `type`
+ * The configurable settings/options for the `ODSeparatorComponent`.
+ */
+export interface ODSeparatorComponentData {
+    /**Whether a visual divider should be displayed in the component. (Default: `true`) */
+    divider: boolean;
+    /**Size of separator padding (Default: `small`) */
+    spacing: "small" | "large";
+}
+/**## ODSeparatorComponent `class`
+ * A visual separator between components. The visibility and padding of this separator can be changed.
+ */
+export declare class ODSeparatorComponent extends ODComponent<ODSeparatorComponentData, discord.SeparatorBuilder> {
+    constructor(id: ODValidId, data: Partial<ODSeparatorComponentData>);
+    build(): Promise<discord.SeparatorBuilder>;
+    /**Set whether a visual divider should be displayed in the component. (Default: `true`). */
+    setDivider(divider: boolean): void;
+    /**Set the size of separator padding (Default `small`). */
+    setSpacing(spacing: "small" | "large"): void;
+}
+/**## ODTextComponentData `type`
+ * The configurable settings/options for the `ODTextComponent`.
+ */
+export interface ODTextComponentData {
+    /**The text to display. */
+    content: string;
+}
+/**## ODTextComponent `class`
+ * A text component which renders markdown text in a message.
+ */
+export declare class ODTextComponent extends ODComponent<ODTextComponentData, discord.TextDisplayBuilder> {
+    constructor(id: ODValidId, data: Partial<ODTextComponentData>);
+    build(): Promise<discord.TextDisplayBuilder>;
+    /**Set the text to display. */
+    setContent(value: string): void;
+}
+/**## ODFileComponentData `type`
+ * The configurable settings/options for the `ODFileComponent`.
+ */
+export interface ODFileComponentData {
+    /**The name of this file. */
+    name: string;
+    /**The description of this file. */
+    description?: string;
+    /**Should this file be marked as a spoiler? */
+    spoiler?: boolean;
+    /**The binary/text contents of the file. Ignored when `externalUrl` is used. */
+    content?: discord.BufferResolvable;
+    /**A URL to an external file or image. When specified, the `content` (setContent) will be ignored. */
+    externalUrl?: string;
+}
+/**## ODFileComponent `class`
+ * A file component which adds a file in a message.
+ */
+export declare class ODFileComponent extends ODComponent<ODFileComponentData, {
+    file: discord.FileBuilder;
+    attachment: discord.AttachmentBuilder | null;
+}> {
+    constructor(id: ODValidId, data: Partial<ODFileComponentData>);
+    build(): Promise<{
+        attachment: discord.AttachmentBuilder | null;
+        file: discord.FileBuilder;
+    }>;
+    /**Set the filename + extension. */
+    setName(value: string): void;
+    /**Set the file description. */
+    setDescription(value: string | null): void;
+    /**Set the text/binary contents of the file. */
+    setContent(value: discord.BufferResolvable | null): void;
+    /**Set a URL to an external file or image. When used, `setContent()` will be ignored! */
+    setExternalUrl(value: string | null): void;
+    /**Mark the file as spoiler. */
+    setSpoiler(value: boolean): void;
+}
+/**## ODGalleryComponentData `type`
+ * The configurable settings/options for the `ODGalleryComponent`.
+ */
+export interface ODGalleryComponentData {
+}
+/**## ODGalleryComponent `class`
+ * A gallery component which renders a grid of media items (images/videos) in a message.
+ * Add items to this gallery using `addComponent()`.
+ */
+export declare class ODGalleryComponent extends ODGroupComponent<ODGalleryComponentData, ODFileComponent, {
+    gallery: discord.MediaGalleryBuilder;
+    attachments: discord.AttachmentBuilder[];
+}> {
+    constructor(id: ODValidId, data?: Partial<ODGalleryComponentData>);
+    build(): Promise<{
+        gallery: discord.MediaGalleryBuilder;
+        attachments: discord.AttachmentBuilder[];
+    }>;
+}
+/**## ODThumbnailComponentData `type`
+ * The configurable settings/options for the `ODThumbnailComponent`.
+ */
+export interface ODThumbnailComponentData {
+    /**The URL of the thumbnail image. Can be an external URL or `attachment://filename.ext`. */
+    url: string;
+    /**The alt text/description of the thumbnail image. */
+    description?: string;
+    /**Should this thumbnail be marked as a spoiler? */
+    spoiler?: boolean;
+}
+/**## ODThumbnailComponent `class`
+ * A thumbnail component which renders a small image as an accessory inside an `ODSectionComponent`.
+ * This component must be used via `ODSectionComponent.setComponent()`
+ */
+export declare class ODThumbnailComponent extends ODComponent<ODThumbnailComponentData, discord.ThumbnailBuilder> {
+    constructor(id: ODValidId, data: Partial<ODThumbnailComponentData>);
+    build(): Promise<discord.ThumbnailBuilder>;
+    /**Set the URL of the thumbnail image. */
+    setUrl(value: string): void;
+    /**Set the alt text/description of the thumbnail image. */
+    setDescription(value: string | null): void;
+    /**Mark the thumbnail as a spoiler. */
+    setSpoiler(value: boolean): void;
+}
+/**## ODContentComponentData `type`
+ * The configurable settings/options for the `ODContentComponent`.
+ */
+export interface ODContentComponentData {
+    /**The text to display. */
+    content: string;
+}
+/**## ODContentComponent `class`
+ * A text component which renders markdown text in a message without `Components V2` enabled. (Old behaviour)
+ */
+export declare class ODContentComponent extends ODComponent<ODContentComponentData, {
+    content: string;
+}> {
+    constructor(id: ODValidId, data: Partial<ODContentComponentData>);
+    build(): Promise<{
+        content: string;
+    }>;
+    /**Set the text to display. */
+    setContent(value: string): void;
+}
+/**## ODEmbedComponentData `type`
+ * The configurable settings/options for the `ODEmbedComponent`.
+ */
+export interface ODEmbedComponentData {
+    /**The title of the embed. */
+    title?: string;
+    /**The color of the embed. */
+    color?: discord.ColorResolvable;
+    /**The url of the embed. */
+    url?: string;
+    /**The description of the embed. */
+    description?: string;
+    /**The author text of the embed. */
+    authorText?: string;
+    /**The author image of the embed. */
+    authorImage?: string;
+    /**The author url of the embed. */
+    authorUrl?: string;
+    /**The footer text of the embed. */
+    footerText?: string;
+    /**The footer image of the embed. */
+    footerImage?: string;
+    /**The image of the embed. */
+    image?: string;
+    /**The thumbnail of the embed. */
+    thumbnail?: string;
+    /**The fields of the embed. */
+    fields?: ODInterfaceWithPartialProperty<discord.EmbedField, "inline">[];
+    /**The timestamp of the embed. */
+    timestamp?: number | Date;
+}
+/**## ODEmbedComponent `class`
+ * An embed component which renders an embed in a message without `Components V2` enabled. (Old behaviour)
+ */
+export declare class ODEmbedComponent extends ODComponent<ODEmbedComponentData, discord.EmbedBuilder> {
+    constructor(id: ODValidId, data: Partial<ODEmbedComponentData>);
+    build(): Promise<discord.EmbedBuilder>;
+    /**Set the title of this embed */
+    setTitle(title: string | null): this;
+    /**Set the color of this embed */
+    setColor(color: discord.ColorResolvable | null): this;
+    /**Set the url of this embed */
+    setUrl(url: string | null): this;
+    /**Set the description of this embed */
+    setDescription(description: string | null): this;
+    /**Set the author of this embed */
+    setAuthor(text: string | null, image?: string | null, url?: string | null): this;
+    /**Set the footer of this embed */
+    setFooter(text: string | null, image?: string | null): this;
+    /**Set the image of this embed */
+    setImage(image: string | null): this;
+    /**Set the thumbnail of this embed */
+    setThumbnail(thumbnail: string | null): this;
+    /**Set the fields of this embed */
+    setFields(fields: ODInterfaceWithPartialProperty<discord.EmbedField, "inline">[]): this;
+    /**Add fields to this embed */
+    addFields(...fields: ODInterfaceWithPartialProperty<discord.EmbedField, "inline">[]): this;
+    /**Clear all fields from this embed */
+    clearFields(): this;
+    /**Set the timestamp of this embed. When set to `true`, the current timestamp is used. */
+    setTimestamp(timestamp: number | Date | true | null): this;
+}
+/**## ODPollComponentData `type`
+ * The configurable settings/options for the `ODPollComponent`.
+ */
+export interface ODPollComponentData {
+    /**The poll question. */
+    question: string;
+    /**The duration of the poll in hours. */
+    durationHours: number;
+    /**Available poll answers. */
+    answers: discord.PollAnswerData[];
+    /**Allow selecting multiple answers. */
+    allowMultiSelect: boolean;
+}
+/**## ODPollComponent `class`
+ * A poll component which adds a poll to a message without `Components V2` enabled. (Old behaviour)
+ */
+export declare class ODPollComponent extends ODComponent<ODPollComponentData, discord.PollData> {
+    constructor(id: ODValidId, data: Partial<ODPollComponentData>);
+    build(): Promise<{
+        layoutType: discord.PollLayoutType;
+        allowMultiselect: boolean;
+        duration: number;
+        question: {
+            text: string;
+        };
+        answers: discord.PollAnswerData[];
+    }>;
+    /**Set the poll question. */
+    setQuestion(question: string): void;
+    /**Set the poll duration in hours. */
+    setDurationHours(duration: number): void;
+    /**Allow selecting multiple answers. */
+    setMultiSelect(multi: boolean): void;
+    /**Set the poll answers. */
+    setAnswers(answers: discord.PollAnswerData[]): void;
+    /**Add additional poll answers. */
+    addAnswers(...answers: discord.PollAnswerData[]): void;
+}
+/**## ODButtonComponentData `type`
+ * The configurable settings/options for the `ODButtonComponent`.
+ */
+export interface ODButtonComponentData {
+    /**The custom id of this button. Ignored when `url` is specified. */
+    customId?: string;
+    /**The url of this button. Disables interactions & customId */
+    url?: string;
+    /**The button color. Ignored when `url` is specified. */
+    color: ODValidButtonColor;
+    /**The button label */
+    label?: string;
+    /**The button emoji */
+    emoji?: string;
+    /**Is the button disabled? */
+    disabled: boolean;
+}
+/**## ODButtonComponent `class`
+ * A button component which renders an interactive button inside the message.
+ * A reply can be sent using Open Discord responders.
+ */
+export declare class ODButtonComponent extends ODComponent<ODButtonComponentData, discord.ButtonBuilder> {
+    constructor(id: ODValidId, data: Partial<ODButtonComponentData>);
+    build(): Promise<discord.ButtonBuilder>;
+    /**Get the `discord.ButtonStyle` for the specified `ODValidButtonColor` */
+    protected getButtonStyle(): discord.ButtonStyle;
+    /**Set the custom id of this button. Ignored when `setUrl()` is used. */
+    setCustomId(id: string | null): this;
+    /**Set the url of this button. */
+    setUrl(url: string | null): this;
+    /**Set the color of this button. Ignored when `setUrl()` is used. */
+    setColor(color: ODValidButtonColor): this;
+    /**Set the label of this button. */
+    setLabel(label: string | null): this;
+    /**Set the emoji of this button. */
+    setEmoji(emoji: string | null): this;
+    /**Disable this button. */
+    setDisabled(disabled: boolean): this;
+}
+/**## ODShortInputComponentData `type`
+ * The configurable settings/options for the `ODShortInputComponent`.
+ */
+export interface ODShortInputComponentData {
+    /**The custom id of this modal text input. */
+    customId?: string;
+    /**The min length of this modal text input. */
+    minLength?: number;
+    /**The max length of this modal text input. */
+    maxLength?: number;
+    /**Is this modal text input required? */
+    required: boolean;
+    /**The placeholder of this modal text input. */
+    placeholder?: string;
+    /**The initial value of this modal text input. */
+    initialValue?: string;
+}
+/**## ODShortInputComponent `class`
+ * A short text input component for modals.
+ * It must be placed inside an `ODLabelComponent`.
+ */
+export declare class ODShortInputComponent extends ODComponent<ODShortInputComponentData, discord.TextInputBuilder> {
+    constructor(id: ODValidId, data: Partial<ODShortInputComponentData>);
+    build(): Promise<discord.TextInputBuilder>;
+    /**Set the custom id of this modal text input. */
+    setCustomId(id: string | null): this;
+    /**Set the minimum amount of characters of this modal text input. */
+    setMinLength(length: number | null): this;
+    /**Set the maximum amount of characters of this modal text input. */
+    setMaxLength(length: number | null): this;
+    /**Set the placeholder of this modal text input. */
+    setPlaceholder(placeholder: string | null): this;
+    /**Set the initial value of this modal text input. */
+    setInitialValue(initialValue: string | null): this;
+    /**Mark this modal text input as required. */
+    setRequired(required: boolean): this;
+}
+/**## ODParagraphInputComponentData `type`
+ * The configurable settings/options for the `ODParagraphInputComponent`.
+ */
+export interface ODParagraphInputComponentData {
+    /**The custom id of this modal text input. */
+    customId?: string;
+    /**The min length of this modal text input. */
+    minLength?: number;
+    /**The max length of this modal text input. */
+    maxLength?: number;
+    /**Is this modal text input required? */
+    required: boolean;
+    /**The placeholder of this modal text input. */
+    placeholder?: string;
+    /**The initial value of this modal text input. */
+    initialValue?: string;
+}
+/**## ODParagraphInputComponent `class`
+ * A paragraph text input component for modals.
+ * It must be placed inside an `ODLabelComponent`.
+ */
+export declare class ODParagraphInputComponent extends ODComponent<ODParagraphInputComponentData, discord.TextInputBuilder> {
+    constructor(id: ODValidId, data: Partial<ODParagraphInputComponentData>);
+    build(): Promise<discord.TextInputBuilder>;
+    /**Set the custom id of this modal text input. */
+    setCustomId(id: string | null): this;
+    /**Set the minimum amount of characters of this modal text input. */
+    setMinLength(length: number | null): this;
+    /**Set the maximum amount of characters of this modal text input. */
+    setMaxLength(length: number | null): this;
+    /**Set the placeholder of this modal text input. */
+    setPlaceholder(placeholder: string | null): this;
+    /**Set the initial value of this modal text input. */
+    setInitialValue(initialValue: string | null): this;
+    /**Mark this modal text input as required. */
+    setRequired(required: boolean): this;
+}
+/**## ODDropdownComponentData `type`
+ * The configurable settings/options for the `ODDropdownComponent`.
+ */
+export interface ODDropdownComponentData {
+    /**The type of this dropdown. */
+    type: "string" | "role" | "channel" | "user" | "mentionable";
+    /**The custom id of this dropdown. */
+    customId?: string;
+    /**The placeholder of this dropdown. */
+    placeholder?: string;
+    /**The minimum amount of items to be selected in this dropdown. */
+    minValues?: number;
+    /**The maximum amount of items to be selected in this dropdown. */
+    maxValues?: number;
+    /**Is this dropdown disabled? */
+    disabled?: boolean;
+    /**Allowed channel types when the type is "channel" */
+    channelTypes?: discord.ChannelType[];
+    /**The options when the type is "string" */
+    options?: discord.SelectMenuComponentOptionData[];
+    /**The options when the type is "user" */
+    users?: discord.User[];
+    /**The options when the type is "role" */
+    roles?: discord.Role[];
+    /**The options when the type is "channel" */
+    channels?: discord.Channel[];
+    /**The options when the type is "mentionable" */
+    mentionables?: (discord.User | discord.Role)[];
+}
+/**## ODDropdownComponent `class`
+ * A dropdown component which renders an interactive dropdown inside the message/modal.
+ * A reply can be sent using Open Discord responders.
+ */
+export declare class ODDropdownComponent extends ODComponent<ODDropdownComponentData, discord.BaseSelectMenuBuilder<discord.APISelectMenuComponent>> {
+    constructor(id: ODValidId, data: Partial<ODDropdownComponentData>);
+    build(): Promise<discord.StringSelectMenuBuilder | discord.UserSelectMenuBuilder | discord.RoleSelectMenuBuilder | discord.MentionableSelectMenuBuilder | discord.ChannelSelectMenuBuilder>;
+    /**Set the custom id of this dropdown. */
+    setCustomId(id: string | null): this;
+    /**Set the type of this dropdown. */
+    setType(type: "string" | "role" | "channel" | "user" | "mentionable"): this;
+    /**Set the minimum selection amount of this dropdown. */
+    setMinValues(amount: number | null): this;
+    /**Set the maximum selection amount of this dropdown. */
+    setMaxValues(amount: number | null): this;
+    /**Set the placeholder of this dropdown. */
+    setPlaceholder(placeholder: string | null): this;
+    /**Disable this dropdown. */
+    setDisabled(disabled: boolean): this;
+    /**Set the available channel types of this dropdown. */
+    setChannelTypes(channelTypes: discord.ChannelType[]): this;
+    /**Set the options of this dropdown (when `type == "string"`) */
+    setOptions(options: discord.SelectMenuComponentOptionData[]): this;
+    /**Set the users of this dropdown (when `type == "user"`) */
+    setUsers(users: discord.User[]): this;
+    /**Set the roles of this dropdown (when `type == "role"`) */
+    setRoles(roles: discord.Role[]): this;
+    /**Set the channels of this dropdown (when `type == "channel"`) */
+    setChannels(channels: discord.Channel[]): this;
+    /**Set the mentionables of this dropdown (when `type == "mentionable"`) */
+    setMentionables(mentionables: (discord.User | discord.Role)[]): this;
+}
+/**## ODRadioGroupComponentData `type`
+ * The configurable settings/options for the `ODRadioGroupComponent`.
+ */
+export interface ODRadioGroupComponentData {
+    /**The custom id of this radio group. */
+    customId?: string;
+    /**Is this radio group required? (At least one option must be selected) */
+    required: boolean;
+    /**The available radio options. (min 2, max 10) */
+    options: discord.APIRadioGroupOption[];
+}
+/**## ODRadioGroupComponent `class`
+ * A radio group component which renders an interactive radio group input inside a modal.
+ */
+export declare class ODRadioGroupComponent extends ODComponent<ODRadioGroupComponentData, discord.RadioGroupBuilder> {
+    constructor(id: ODValidId, data: Partial<ODRadioGroupComponentData>);
+    build(): Promise<discord.RadioGroupBuilder>;
+    /**Set the custom id of this radio group. */
+    setCustomId(id: string | null): this;
+    /**Mark this radio group as required (At least one option must be selected). */
+    setRequired(required: boolean): this;
+    /**Set the available radio options (min 2, max 10) */
+    setOptions(options: discord.APIRadioGroupOption[]): this;
+}
+/**## ODCheckboxGroupComponentData `type`
+ * The configurable settings/options for the `ODCheckboxGroupComponent`.
+ */
+export interface ODCheckboxGroupComponentData {
+    /**The custom id of this checkbox group. */
+    customId?: string;
+    /**Is this checkbox group required? (At least one option must be selected) */
+    required: boolean;
+    /**The available checkbox options. (min 1, max 10) */
+    options: discord.APICheckboxGroupOption[];
+    /**The minimum amount of checkboxes to be selected. */
+    minValues?: number;
+    /**The maximum amount of checkboxes to be selected. */
+    maxValues?: number;
+}
+/**## ODCheckboxGroupComponent `class`
+ * A checkbox group component which renders an interactive checkbox group input inside a modal.
+ */
+export declare class ODCheckboxGroupComponent extends ODComponent<ODCheckboxGroupComponentData, discord.CheckboxGroupBuilder> {
+    constructor(id: ODValidId, data: Partial<ODCheckboxGroupComponentData>);
+    build(): Promise<discord.CheckboxGroupBuilder>;
+    /**Set the custom id of this checkbox group. */
+    setCustomId(id: string | null): this;
+    /**Mark this checkbox group as required (At least one option must be selected). */
+    setRequired(required: boolean): this;
+    /**Set the available checkbox options (min 2, max 10) */
+    setOptions(options: discord.APICheckboxGroupOption[]): this;
+    /**Set the minimum amount of selected checkboxes. */
+    setMinValues(amount: number | null): this;
+    /**Set the maximum amount of selected checkboxes. */
+    setMaxValues(amount: number | null): this;
+}
+/**## ODCheckboxComponentData `type`
+ * The configurable settings/options for the `ODCheckboxComponent`.
+ */
+export interface ODCheckboxComponentData {
+    /**The custom id of this checkbox. */
+    customId?: string;
+    /**Is this checkbox enabled by default? */
+    default: boolean;
+}
+/**## ODCheckboxComponent `class`
+ * A checkbox component which renders an interactive checkbox input inside a modal.
+ * The label & description should be set via an `ODLabelComponent`
+ */
+export declare class ODCheckboxComponent extends ODComponent<ODCheckboxComponentData, discord.CheckboxBuilder> {
+    constructor(id: ODValidId, data: Partial<ODCheckboxComponentData>);
+    build(): Promise<discord.CheckboxBuilder>;
+    /**Set the custom id of this checkbox. */
+    setCustomId(id: string | null): this;
+    /**Mark this checkbox as enabled by default. */
+    setDefault(enabledByDefault: boolean): this;
+}
+/**## ODFileUploadComponentData `type`
+ * The configurable settings/options for the `ODFileUploadComponent`.
+ */
+export interface ODFileUploadComponentData {
+    /**The custom id of this file upload. */
+    customId?: string;
+    /**Is this file upload required? */
+    required: boolean;
+    /**The minimum amount of files to upload (0-10). */
+    minAmount?: number;
+    /**The maximum amount of files to upload (1-10). */
+    maxAmount?: number;
+}
+/**## ODFileUploadComponent `class`
+ * A file upload component which allows users to upload one or multiple files inside a modal.
+ * The label & description should be set via an `ODLabelComponent`
+ */
+export declare class ODFileUploadComponent extends ODComponent<ODFileUploadComponentData, discord.FileUploadBuilder> {
+    constructor(id: ODValidId, data: Partial<ODFileUploadComponentData>);
+    build(): Promise<discord.FileUploadBuilder>;
+    /**Set the custom id of this dropdown. */
+    setCustomId(id: string | null): this;
+    /**Mark this file upload as required. */
+    setRequired(required: boolean): this;
+    /**Set the minimum amount of files to upload (0-10). */
+    setMinAmount(amount: number | null): this;
+    /**Set the maximum amount of files to upload (1-10). */
+    setMaxAmount(amount: number | null): this;
+}