@minesa-org/mini-interaction 0.0.4 → 0.0.6

package/dist/builders/AutomodRuleBuilder.d.ts

@@ -0,0 +1,45 @@
+import { type APIAutoModerationAction, type APIAutoModerationRuleTriggerMetadata, AutoModerationRuleEventType, AutoModerationRuleTriggerType } from "discord-api-types/v10";
+import type { RESTPostAPIAutoModerationRuleJSONBody } from "discord-api-types/v10";
+import type { JSONEncodable } from "./shared.js";
+/**
+ * Shape describing initial data used to seed the auto moderation rule builder.
+ */
+export type AutomodRuleBuilderData = Partial<RESTPostAPIAutoModerationRuleJSONBody> & {
+    name?: string;
+    event_type?: AutoModerationRuleEventType;
+    trigger_type?: AutoModerationRuleTriggerType;
+    actions?: APIAutoModerationAction[];
+};
+/** Builder that produces Discord auto moderation rule payloads. */
+export declare class AutomodRuleBuilder implements JSONEncodable<RESTPostAPIAutoModerationRuleJSONBody> {
+    private data;
+    constructor(data?: AutomodRuleBuilderData);
+    /** Sets the name of the rule. */
+    setName(name: string): this;
+    /** Sets the event type that will trigger the rule. */
+    setEventType(eventType: AutoModerationRuleEventType): this;
+    /** Sets the trigger type for the rule. */
+    setTriggerType(triggerType: AutoModerationRuleTriggerType): this;
+    /**
+     * Assigns trigger metadata describing how the rule should match content.
+     */
+    setTriggerMetadata(metadata: APIAutoModerationRuleTriggerMetadata | null | undefined): this;
+    /**
+     * Replaces the actions executed when the rule triggers.
+     */
+    setActions(actions: Array<APIAutoModerationAction | JSONEncodable<APIAutoModerationAction>>): this;
+    /** Adds an action to execute when the rule triggers. */
+    addAction(action: APIAutoModerationAction | JSONEncodable<APIAutoModerationAction>): this;
+    /** Enables or disables the rule. */
+    setEnabled(enabled: boolean): this;
+    /** Replaces the list of exempt role ids. */
+    setExemptRoles(roleIds: string[]): this;
+    /** Adds an exempt role id if not already present. */
+    addExemptRole(roleId: string): this;
+    /** Replaces the list of exempt channel ids. */
+    setExemptChannels(channelIds: string[]): this;
+    /** Adds an exempt channel id if not already present. */
+    addExemptChannel(channelId: string): this;
+    /** Serialises the builder into a REST auto moderation rule payload. */
+    toJSON(): RESTPostAPIAutoModerationRuleJSONBody;
+}

package/dist/builders/AutomodRuleBuilder.js

@@ -0,0 +1,151 @@
+import { resolveJSONEncodable } from "./shared.js";
+/** Builder that produces Discord auto moderation rule payloads. */
+export class AutomodRuleBuilder {
+    data;
+    constructor(data = {}) {
+        this.data = {
+            ...data,
+            actions: data.actions?.map(cloneAutoModerationAction) ?? [],
+            trigger_metadata: data.trigger_metadata
+                ? cloneTriggerMetadata(data.trigger_metadata)
+                : undefined,
+            exempt_roles: data.exempt_roles ? [...data.exempt_roles] : undefined,
+            exempt_channels: data.exempt_channels
+                ? [...data.exempt_channels]
+                : undefined,
+        };
+    }
+    /** Sets the name of the rule. */
+    setName(name) {
+        this.data.name = name;
+        return this;
+    }
+    /** Sets the event type that will trigger the rule. */
+    setEventType(eventType) {
+        this.data.event_type = eventType;
+        return this;
+    }
+    /** Sets the trigger type for the rule. */
+    setTriggerType(triggerType) {
+        this.data.trigger_type = triggerType;
+        return this;
+    }
+    /**
+     * Assigns trigger metadata describing how the rule should match content.
+     */
+    setTriggerMetadata(metadata) {
+        this.data.trigger_metadata = metadata
+            ? cloneTriggerMetadata(metadata)
+            : undefined;
+        return this;
+    }
+    /**
+     * Replaces the actions executed when the rule triggers.
+     */
+    setActions(actions) {
+        this.data.actions = actions.map((action) => cloneAutoModerationAction(resolveJSONEncodable(action)));
+        return this;
+    }
+    /** Adds an action to execute when the rule triggers. */
+    addAction(action) {
+        if (!this.data.actions) {
+            this.data.actions = [];
+        }
+        this.data.actions.push(cloneAutoModerationAction(resolveJSONEncodable(action)));
+        return this;
+    }
+    /** Enables or disables the rule. */
+    setEnabled(enabled) {
+        this.data.enabled = enabled;
+        return this;
+    }
+    /** Replaces the list of exempt role ids. */
+    setExemptRoles(roleIds) {
+        this.data.exempt_roles = [...roleIds];
+        return this;
+    }
+    /** Adds an exempt role id if not already present. */
+    addExemptRole(roleId) {
+        if (!this.data.exempt_roles) {
+            this.data.exempt_roles = [];
+        }
+        if (!this.data.exempt_roles.includes(roleId)) {
+            this.data.exempt_roles.push(roleId);
+        }
+        return this;
+    }
+    /** Replaces the list of exempt channel ids. */
+    setExemptChannels(channelIds) {
+        this.data.exempt_channels = [...channelIds];
+        return this;
+    }
+    /** Adds an exempt channel id if not already present. */
+    addExemptChannel(channelId) {
+        if (!this.data.exempt_channels) {
+            this.data.exempt_channels = [];
+        }
+        if (!this.data.exempt_channels.includes(channelId)) {
+            this.data.exempt_channels.push(channelId);
+        }
+        return this;
+    }
+    /** Serialises the builder into a REST auto moderation rule payload. */
+    toJSON() {
+        const { name, event_type, trigger_type } = this.data;
+        const actions = this.data.actions ?? [];
+        if (!name) {
+            throw new Error("[AutomodRuleBuilder] name is required");
+        }
+        if (event_type === undefined) {
+            throw new Error("[AutomodRuleBuilder] event type is required");
+        }
+        if (trigger_type === undefined) {
+            throw new Error("[AutomodRuleBuilder] trigger type is required");
+        }
+        if (actions.length === 0) {
+            throw new Error("[AutomodRuleBuilder] at least one action is required");
+        }
+        return {
+            name,
+            event_type,
+            trigger_type,
+            trigger_metadata: this.data.trigger_metadata
+                ? cloneTriggerMetadata(this.data.trigger_metadata)
+                : undefined,
+            actions: actions.map(cloneAutoModerationAction),
+            enabled: this.data.enabled,
+            exempt_roles: this.data.exempt_roles
+                ? [...this.data.exempt_roles]
+                : undefined,
+            exempt_channels: this.data.exempt_channels
+                ? [...this.data.exempt_channels]
+                : undefined,
+        };
+    }
+}
+function cloneTriggerMetadata(metadata) {
+    return {
+        keyword_filter: metadata.keyword_filter
+            ? [...metadata.keyword_filter]
+            : undefined,
+        presets: metadata.presets ? [...metadata.presets] : undefined,
+        allow_list: metadata.allow_list ? [...metadata.allow_list] : undefined,
+        regex_patterns: metadata.regex_patterns
+            ? [...metadata.regex_patterns]
+            : undefined,
+        mention_total_limit: metadata.mention_total_limit,
+        mention_raid_protection_enabled: metadata.mention_raid_protection_enabled,
+    };
+}
+function cloneAutoModerationAction(action) {
+    return {
+        type: action.type,
+        metadata: action.metadata
+            ? {
+                channel_id: action.metadata.channel_id,
+                duration_seconds: action.metadata.duration_seconds,
+                custom_message: action.metadata.custom_message,
+            }
+            : undefined,
+    };
+}

package/dist/builders/EmbedBuilder.d.ts

@@ -0,0 +1,33 @@
+import { type APIEmbed, type APIEmbedAuthor, type APIEmbedField, type APIEmbedFooter, type APIEmbedImage, type APIEmbedThumbnail } from "discord-api-types/v10";
+import type { JSONEncodable } from "./shared.js";
+/** Shape describing data used to seed an embed builder instance. */
+export type EmbedBuilderData = Partial<APIEmbed>;
+/** Builder for Discord embed payloads. */
+export declare class EmbedBuilder implements JSONEncodable<APIEmbed> {
+    private data;
+    constructor(data?: EmbedBuilderData);
+    /** Sets or clears the embed title. */
+    setTitle(title: string | null | undefined): this;
+    /** Sets or clears the embed description. */
+    setDescription(description: string | null | undefined): this;
+    /** Sets or clears the embed URL. */
+    setURL(url: string | null | undefined): this;
+    /** Sets or clears the embed color. */
+    setColor(color: number | null | undefined): this;
+    /** Sets the timestamp value using either a Date or ISO string. */
+    setTimestamp(timestamp: Date | number | string | null | undefined): this;
+    /** Sets or clears the footer. */
+    setFooter(footer: APIEmbedFooter | null | undefined): this;
+    /** Sets or clears the image. */
+    setImage(image: APIEmbedImage | null | undefined): this;
+    /** Sets or clears the thumbnail. */
+    setThumbnail(thumbnail: APIEmbedThumbnail | null | undefined): this;
+    /** Sets or clears the author. */
+    setAuthor(author: APIEmbedAuthor | null | undefined): this;
+    /** Replaces the embed fields with the provided values. */
+    setFields(fields: APIEmbedField[]): this;
+    /** Appends fields to the embed. */
+    addFields(...fields: APIEmbedField[]): this;
+    /** Serialises the builder into an API compatible embed payload. */
+    toJSON(): APIEmbed;
+}

package/dist/builders/EmbedBuilder.js

@@ -0,0 +1,94 @@
+/** Builder for Discord embed payloads. */
+export class EmbedBuilder {
+    data;
+    constructor(data = {}) {
+        this.data = {
+            ...data,
+            footer: data.footer ? { ...data.footer } : undefined,
+            image: data.image ? { ...data.image } : undefined,
+            thumbnail: data.thumbnail ? { ...data.thumbnail } : undefined,
+            author: data.author ? { ...data.author } : undefined,
+            fields: data.fields ? data.fields.map((field) => ({ ...field })) : [],
+        };
+    }
+    /** Sets or clears the embed title. */
+    setTitle(title) {
+        this.data.title = title ?? undefined;
+        return this;
+    }
+    /** Sets or clears the embed description. */
+    setDescription(description) {
+        this.data.description = description ?? undefined;
+        return this;
+    }
+    /** Sets or clears the embed URL. */
+    setURL(url) {
+        this.data.url = url ?? undefined;
+        return this;
+    }
+    /** Sets or clears the embed color. */
+    setColor(color) {
+        this.data.color = color ?? undefined;
+        return this;
+    }
+    /** Sets the timestamp value using either a Date or ISO string. */
+    setTimestamp(timestamp) {
+        if (timestamp === null || timestamp === undefined) {
+            this.data.timestamp = undefined;
+        }
+        else if (timestamp instanceof Date) {
+            this.data.timestamp = timestamp.toISOString();
+        }
+        else if (typeof timestamp === "number") {
+            this.data.timestamp = new Date(timestamp).toISOString();
+        }
+        else {
+            this.data.timestamp = new Date(timestamp).toISOString();
+        }
+        return this;
+    }
+    /** Sets or clears the footer. */
+    setFooter(footer) {
+        this.data.footer = footer ? { ...footer } : undefined;
+        return this;
+    }
+    /** Sets or clears the image. */
+    setImage(image) {
+        this.data.image = image ? { ...image } : undefined;
+        return this;
+    }
+    /** Sets or clears the thumbnail. */
+    setThumbnail(thumbnail) {
+        this.data.thumbnail = thumbnail ? { ...thumbnail } : undefined;
+        return this;
+    }
+    /** Sets or clears the author. */
+    setAuthor(author) {
+        this.data.author = author ? { ...author } : undefined;
+        return this;
+    }
+    /** Replaces the embed fields with the provided values. */
+    setFields(fields) {
+        this.data.fields = fields.map((field) => ({ ...field }));
+        return this;
+    }
+    /** Appends fields to the embed. */
+    addFields(...fields) {
+        if (!this.data.fields) {
+            this.data.fields = [];
+        }
+        this.data.fields.push(...fields.map((field) => ({ ...field })));
+        return this;
+    }
+    /** Serialises the builder into an API compatible embed payload. */
+    toJSON() {
+        return {
+            ...this.data,
+            footer: this.data.footer ? { ...this.data.footer } : undefined,
+            image: this.data.image ? { ...this.data.image } : undefined,
+            thumbnail: this.data.thumbnail ? { ...this.data.thumbnail } : undefined,
+            author: this.data.author ? { ...this.data.author } : undefined,
+            fields: this.data.fields?.map((field) => ({ ...field })),
+        };
+    }
+}

package/dist/builders/MiniContainerBuilder.d.ts

@@ -0,0 +1,131 @@
+import type { APIComponentInContainer, APIContainerComponent, APIMediaGalleryComponent, APIMediaGalleryItem, APISectionAccessoryComponent, APISectionComponent, APISeparatorComponent, APITextDisplayComponent, APIThumbnailComponent, APIUnfurledMediaItem } from "discord-api-types/v10";
+import { SeparatorSpacingSize } from "discord-api-types/v10";
+import type { JSONEncodable } from "./shared.js";
+/** Structured message container payload. */
+export type MiniContainerComponent = APIContainerComponent;
+/** Section within a structured message container. */
+export type MiniSectionComponent = APISectionComponent;
+/** Text display structured message component. */
+export type MiniTextDisplayComponent = APITextDisplayComponent;
+/** Separator structured message component. */
+export type MiniSeparatorComponent = APISeparatorComponent;
+/** Thumbnail payload used within sections. */
+export type MiniThumbnailComponent = APIThumbnailComponent;
+/** Gallery item payload. */
+export type MiniGalleryItemComponent = APIMediaGalleryItem;
+/** Gallery structured message component. */
+export type MiniGalleryComponent = APIMediaGalleryComponent;
+/** Union of supported components within a container. */
+export type MiniContentComponent = APIComponentInContainer;
+/** Union of supported section accessory components. */
+export type MiniSectionAccessoryComponent = APISectionAccessoryComponent;
+/** Data accepted by the container builder constructor. */
+export type ContainerBuilderData = Partial<Omit<MiniContainerComponent, "components">> & {
+    components?: Array<MiniContentComponent | JSONEncodable<MiniContentComponent>>;
+};
+/** Data accepted by the section builder constructor. */
+export type SectionBuilderData = Partial<Omit<MiniSectionComponent, "components" | "accessory">> & {
+    components?: Array<MiniTextDisplayComponent | JSONEncodable<MiniTextDisplayComponent>>;
+    accessory?: MiniSectionAccessoryComponent | JSONEncodable<MiniSectionAccessoryComponent>;
+};
+/** Data accepted by the text display builder constructor. */
+export type TextDisplayBuilderData = Partial<MiniTextDisplayComponent>;
+/** Data accepted by the separator builder constructor. */
+export type SeparatorBuilderData = Partial<MiniSeparatorComponent>;
+/** Data accepted by the gallery builder constructor. */
+export type GalleryBuilderData = Partial<Omit<MiniGalleryComponent, "items">> & {
+    items?: Array<MiniGalleryItemComponent | JSONEncodable<MiniGalleryItemComponent>>;
+};
+/** Data accepted by the gallery item builder constructor. */
+export type GalleryItemBuilderData = Partial<MiniGalleryItemComponent>;
+/** Data accepted by the thumbnail builder constructor. */
+export type ThumbnailBuilderData = Partial<MiniThumbnailComponent>;
+/** Builder for structured message container payloads. */
+export declare class ContainerBuilder implements JSONEncodable<MiniContainerComponent> {
+    private data;
+    constructor(data?: ContainerBuilderData);
+    /** Replaces the components contained in the container. */
+    setComponents(components: Array<MiniContentComponent | JSONEncodable<MiniContentComponent>>): this;
+    /** Replaces the sections contained in the container. */
+    setSections(sections: Array<MiniSectionComponent | JSONEncodable<MiniSectionComponent>>): this;
+    /** Adds a component to the container. */
+    addComponent(component: MiniContentComponent | JSONEncodable<MiniContentComponent>): this;
+    /** Adds a section to the container. */
+    addSection(section: MiniSectionComponent | JSONEncodable<MiniSectionComponent>): this;
+    /** Sets or clears the accent colour on the container. */
+    setAccentColor(color: number | null | undefined): this;
+    /** Marks the container as a spoiler. */
+    setSpoiler(spoiler: boolean | null | undefined): this;
+    /** Serialises the container into a structured message payload. */
+    toJSON(): MiniContainerComponent;
+}
+/** Builder for structured message sections. */
+export declare class SectionBuilder implements JSONEncodable<MiniSectionComponent> {
+    private data;
+    constructor(data?: SectionBuilderData);
+    /** Replaces the text components within the section. */
+    setComponents(components: Array<MiniTextDisplayComponent | JSONEncodable<MiniTextDisplayComponent>>): this;
+    /** Adds a text component to the section. */
+    addComponent(component: MiniTextDisplayComponent | JSONEncodable<MiniTextDisplayComponent>): this;
+    /** Sets or clears the accessory component. */
+    setAccessory(accessory: MiniSectionAccessoryComponent | JSONEncodable<MiniSectionAccessoryComponent> | null | undefined): this;
+    /** Serialises the section into a structured message payload. */
+    toJSON(): MiniSectionComponent;
+}
+/** Builder for structured message text display components. */
+export declare class TextDisplayBuilder implements JSONEncodable<MiniTextDisplayComponent> {
+    private data;
+    constructor(data?: TextDisplayBuilderData);
+    /** Sets or clears the primary text content. */
+    setContent(content: string | null | undefined): this;
+    /** Serialises the component into a structured message payload. */
+    toJSON(): MiniTextDisplayComponent;
+}
+/** Builder for structured message separator components. */
+export declare class SeparatorBuilder implements JSONEncodable<MiniSeparatorComponent> {
+    private data;
+    constructor(data?: SeparatorBuilderData);
+    /** Sets whether the separator should render a divider. */
+    setDivider(divider: boolean | null | undefined): this;
+    /** Sets the separator spacing value. */
+    setSpacing(spacing: SeparatorSpacingSize | null | undefined): this;
+    /** Serialises the separator payload. */
+    toJSON(): MiniSeparatorComponent;
+}
+/** Builder for structured message thumbnails. */
+export declare class ThumbnailBuilder implements JSONEncodable<MiniThumbnailComponent> {
+    private data;
+    constructor(data?: ThumbnailBuilderData);
+    /** Sets the media payload for the thumbnail. */
+    setMedia(media: APIUnfurledMediaItem | null | undefined): this;
+    /** Sets the thumbnail description. */
+    setDescription(description: string | null | undefined): this;
+    /** Marks the thumbnail as a spoiler. */
+    setSpoiler(spoiler: boolean | null | undefined): this;
+    /** Serialises the thumbnail payload. */
+    toJSON(): MiniThumbnailComponent;
+}
+/** Builder for structured message gallery items. */
+export declare class GalleryItemBuilder implements JSONEncodable<MiniGalleryItemComponent> {
+    private data;
+    constructor(data?: GalleryItemBuilderData);
+    /** Sets the media item payload. */
+    setMedia(media: APIUnfurledMediaItem | null | undefined): this;
+    /** Sets the media description. */
+    setDescription(description: string | null | undefined): this;
+    /** Marks the media item as a spoiler. */
+    setSpoiler(spoiler: boolean | null | undefined): this;
+    /** Serialises the gallery item payload. */
+    toJSON(): MiniGalleryItemComponent;
+}
+/** Builder for structured message gallery components. */
+export declare class GalleryBuilder implements JSONEncodable<MiniGalleryComponent> {
+    private data;
+    constructor(data?: GalleryBuilderData);
+    /** Replaces the gallery items. */
+    setItems(items: Array<MiniGalleryItemComponent | JSONEncodable<MiniGalleryItemComponent>>): this;
+    /** Adds a gallery item to the payload. */
+    addItem(item: MiniGalleryItemComponent | JSONEncodable<MiniGalleryItemComponent>): this;
+    /** Serialises the gallery payload. */
+    toJSON(): MiniGalleryComponent;
+}