@svintsow/discord-components 1.0.0

package/README.md

@@ -0,0 +1,8 @@
+# @svintsow/discord-components
+
+Discord Components V2 Builder API for discord.js
+
+## Installation
+
+```bash
+npm install @svintsow/discord-components

package/dist/index.d.mts

@@ -0,0 +1,289 @@
+declare enum ComponentType {
+    Container = 1,
+    Section = 2,
+    TextDisplay = 3,
+    Thumbnail = 4,
+    MediaGallery = 5,
+    MediaGalleryItem = 6,
+    Separator = 7,
+    File = 8,
+    Label = 9
+}
+
+declare const Limits: {
+    readonly MAX_COMPONENTS_PER_CONTAINER: 5;
+    readonly MAX_TEXT_LENGTH: 2000;
+    readonly MAX_DESCRIPTION_LENGTH: 2000;
+    readonly MAX_LABEL_LENGTH: 80;
+    readonly MAX_FILENAME_LENGTH: 255;
+    readonly MAX_GALLERY_ITEMS: 10;
+    readonly MAX_URL_LENGTH: 2048;
+};
+
+declare class ValidationError extends Error {
+    constructor(message: string);
+}
+
+declare class InvalidComponentError extends Error {
+    constructor(message: string);
+}
+
+declare class InvalidURLException extends Error {
+    constructor(message: string);
+}
+
+declare class ComponentLimitError extends Error {
+    constructor(message: string);
+}
+
+interface IComponentBuilder {
+    toJSON(): Record<string, any>;
+    clone(): this;
+}
+
+declare abstract class ComponentBuilder implements IComponentBuilder {
+    abstract toJSON(): Record<string, any>;
+    clone(): this;
+    static from<T extends ComponentBuilder>(this: new (...args: any[]) => T, data: any): T;
+    protected fromJSON(data: any): this;
+}
+
+declare abstract class AccessoryBuilder extends ComponentBuilder {
+    protected type: ComponentType;
+    protected style?: string;
+    setStyle(style: string): this;
+    toJSON(): Record<string, any>;
+}
+
+declare class ContainerBuilder extends ComponentBuilder {
+    private components;
+    private type;
+    constructor();
+    addComponents(...components: ComponentBuilder[]): this;
+    spliceComponents(index: number, deleteCount: number, ...components: ComponentBuilder[]): this;
+    clearComponents(): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+}
+
+declare class SectionBuilder extends ComponentBuilder {
+    private texts;
+    private accessory;
+    constructor();
+    addText(...textComponents: ComponentBuilder[]): this;
+    setAccessory(accessory: AccessoryBuilder): this;
+    clearAccessory(): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class TextDisplayBuilder extends ComponentBuilder {
+    private content;
+    constructor();
+    setContent(text: string): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class ThumbnailBuilder extends ComponentBuilder {
+    private url;
+    private description;
+    private spoiler;
+    constructor();
+    setURL(url: string): this;
+    setDescription(text: string): this;
+    setSpoiler(spoiler: boolean): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class MediaGalleryItemBuilder extends ComponentBuilder {
+    private url;
+    private description;
+    private spoiler;
+    constructor();
+    setURL(url: string): this;
+    setDescription(text: string): this;
+    setSpoiler(spoiler: boolean): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class MediaGalleryBuilder extends ComponentBuilder {
+    private items;
+    constructor();
+    addItems(...items: MediaGalleryItemBuilder[]): this;
+    spliceItems(index: number, deleteCount: number, ...items: MediaGalleryItemBuilder[]): this;
+    clearItems(): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class SeparatorBuilder extends ComponentBuilder {
+    private spacing;
+    private divider;
+    constructor();
+    setSpacing(spacing: number): this;
+    setDivider(divider: boolean): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class FileBuilder extends ComponentBuilder {
+    private url;
+    private filename;
+    private description;
+    constructor();
+    setURL(url: string): this;
+    setFilename(name: string): this;
+    setDescription(text: string): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class LabelBuilder extends ComponentBuilder {
+    private label;
+    private description;
+    constructor();
+    setLabel(text: string): this;
+    setDescription(text: string): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+type AnyComponentBuilder = ContainerBuilder | SectionBuilder | TextDisplayBuilder | ThumbnailBuilder | MediaGalleryBuilder | MediaGalleryItemBuilder | SeparatorBuilder | FileBuilder | LabelBuilder;
+type ComponentJSON = ContainerJSON | SectionJSON | TextDisplayJSON | ThumbnailJSON | MediaGalleryJSON | SeparatorJSON | FileJSON | LabelJSON;
+interface ContainerJSON {
+    type: number;
+    components: ComponentJSON[];
+}
+interface SectionJSON {
+    type: number;
+    texts: ComponentJSON[];
+    accessory?: AccessoryJSON;
+}
+interface TextDisplayJSON {
+    type: number;
+    content: string;
+}
+interface ThumbnailJSON {
+    type: number;
+    url: string;
+    description?: string;
+    spoiler?: boolean;
+}
+interface MediaGalleryJSON {
+    type: number;
+    items: MediaGalleryItemJSON[];
+}
+interface MediaGalleryItemJSON {
+    type: number;
+    url: string;
+    description?: string;
+    spoiler?: boolean;
+}
+interface SeparatorJSON {
+    type: number;
+    spacing: number;
+    divider?: boolean;
+}
+interface FileJSON {
+    type: number;
+    url: string;
+    filename: string;
+    description?: string;
+}
+interface LabelJSON {
+    type: number;
+    label: string;
+    description?: string;
+}
+interface AccessoryJSON {
+    type: number;
+    style?: string;
+}
+
+declare class URLValidator {
+    static validate(url: string): void;
+    static validateOptional(url?: string): void;
+}
+
+declare class StringValidator {
+    static validate(value: any, field: string): void;
+    static validateLength(value: string, maxLength: number, field: string): void;
+    static validateOptional(value?: any, field?: string): void;
+}
+
+declare class ComponentValidator {
+    static validateType(type: ComponentType): void;
+    static validateComponentStructure(obj: any): void;
+}
+
+declare class LimitRules {
+    static validateComponentCount(count: number): void;
+    static validateGalleryItems(count: number): void;
+}
+
+declare class NestingRules {
+    static validateContainerNesting(componentType: ComponentType): void;
+    static validateSectionNesting(componentType: ComponentType): void;
+}
+
+declare class UrlUtils {
+    static isValidUrl(url: string): boolean;
+    static normalizeUrl(url: string): string;
+}
+
+declare class StringUtils {
+    static isString(value: any): value is string;
+    static truncate(text: string, maxLength: number): string;
+    static validateLength(text: string, maxLength: number, field: string): void;
+}
+
+declare class ArrayUtils {
+    static isValidArray<T>(arr: any): arr is T[];
+    static ensureArray<T>(items: T | T[]): T[];
+    static splice<T>(arr: T[], index: number, deleteCount: number, ...items: T[]): T[];
+}
+
+declare class ObjectUtils {
+    static deepClone<T>(obj: T): T;
+    static hasOwnProperty(obj: any, prop: string): boolean;
+    static mergeDeep<T extends Record<string, any>>(target: T, source: Partial<T>): T;
+}
+
+declare class ComponentHelper {
+    static createTextSection(text: string): SectionBuilder;
+    static createContainerFrom(...components: ComponentBuilder[]): ContainerBuilder;
+}
+
+declare class ComponentParser {
+    static parse(data: any): ComponentBuilder;
+    static parseMany(dataArray: any[]): ComponentBuilder[];
+}
+
+declare class ComponentRegistry {
+    private static builders;
+    static register(name: string, builder: typeof ComponentBuilder): void;
+    static get(name: string): typeof ComponentBuilder | undefined;
+    static has(name: string): boolean;
+}
+
+export { AccessoryBuilder, AccessoryJSON, AnyComponentBuilder, ArrayUtils, ComponentBuilder, ComponentHelper, ComponentJSON, ComponentLimitError, ComponentParser, ComponentRegistry, ComponentType, ComponentValidator, ContainerBuilder, ContainerJSON, FileBuilder, FileJSON, IComponentBuilder, InvalidComponentError, InvalidURLException, LabelBuilder, LabelJSON, LimitRules, Limits, MediaGalleryBuilder, MediaGalleryItemBuilder, MediaGalleryItemJSON, MediaGalleryJSON, NestingRules, ObjectUtils, SectionBuilder, SectionJSON, SeparatorBuilder, SeparatorJSON, StringUtils, StringValidator, TextDisplayBuilder, TextDisplayJSON, ThumbnailBuilder, ThumbnailJSON, URLValidator, UrlUtils, ValidationError };

package/dist/index.d.ts

@@ -0,0 +1,289 @@
+declare enum ComponentType {
+    Container = 1,
+    Section = 2,
+    TextDisplay = 3,
+    Thumbnail = 4,
+    MediaGallery = 5,
+    MediaGalleryItem = 6,
+    Separator = 7,
+    File = 8,
+    Label = 9
+}
+
+declare const Limits: {
+    readonly MAX_COMPONENTS_PER_CONTAINER: 5;
+    readonly MAX_TEXT_LENGTH: 2000;
+    readonly MAX_DESCRIPTION_LENGTH: 2000;
+    readonly MAX_LABEL_LENGTH: 80;
+    readonly MAX_FILENAME_LENGTH: 255;
+    readonly MAX_GALLERY_ITEMS: 10;
+    readonly MAX_URL_LENGTH: 2048;
+};
+
+declare class ValidationError extends Error {
+    constructor(message: string);
+}
+
+declare class InvalidComponentError extends Error {
+    constructor(message: string);
+}
+
+declare class InvalidURLException extends Error {
+    constructor(message: string);
+}
+
+declare class ComponentLimitError extends Error {
+    constructor(message: string);
+}
+
+interface IComponentBuilder {
+    toJSON(): Record<string, any>;
+    clone(): this;
+}
+
+declare abstract class ComponentBuilder implements IComponentBuilder {
+    abstract toJSON(): Record<string, any>;
+    clone(): this;
+    static from<T extends ComponentBuilder>(this: new (...args: any[]) => T, data: any): T;
+    protected fromJSON(data: any): this;
+}
+
+declare abstract class AccessoryBuilder extends ComponentBuilder {
+    protected type: ComponentType;
+    protected style?: string;
+    setStyle(style: string): this;
+    toJSON(): Record<string, any>;
+}
+
+declare class ContainerBuilder extends ComponentBuilder {
+    private components;
+    private type;
+    constructor();
+    addComponents(...components: ComponentBuilder[]): this;
+    spliceComponents(index: number, deleteCount: number, ...components: ComponentBuilder[]): this;
+    clearComponents(): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+}
+
+declare class SectionBuilder extends ComponentBuilder {
+    private texts;
+    private accessory;
+    constructor();
+    addText(...textComponents: ComponentBuilder[]): this;
+    setAccessory(accessory: AccessoryBuilder): this;
+    clearAccessory(): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class TextDisplayBuilder extends ComponentBuilder {
+    private content;
+    constructor();
+    setContent(text: string): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class ThumbnailBuilder extends ComponentBuilder {
+    private url;
+    private description;
+    private spoiler;
+    constructor();
+    setURL(url: string): this;
+    setDescription(text: string): this;
+    setSpoiler(spoiler: boolean): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class MediaGalleryItemBuilder extends ComponentBuilder {
+    private url;
+    private description;
+    private spoiler;
+    constructor();
+    setURL(url: string): this;
+    setDescription(text: string): this;
+    setSpoiler(spoiler: boolean): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class MediaGalleryBuilder extends ComponentBuilder {
+    private items;
+    constructor();
+    addItems(...items: MediaGalleryItemBuilder[]): this;
+    spliceItems(index: number, deleteCount: number, ...items: MediaGalleryItemBuilder[]): this;
+    clearItems(): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class SeparatorBuilder extends ComponentBuilder {
+    private spacing;
+    private divider;
+    constructor();
+    setSpacing(spacing: number): this;
+    setDivider(divider: boolean): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class FileBuilder extends ComponentBuilder {
+    private url;
+    private filename;
+    private description;
+    constructor();
+    setURL(url: string): this;
+    setFilename(name: string): this;
+    setDescription(text: string): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+declare class LabelBuilder extends ComponentBuilder {
+    private label;
+    private description;
+    constructor();
+    setLabel(text: string): this;
+    setDescription(text: string): this;
+    toJSON(): Record<string, any>;
+    protected fromJSON(data: any): this;
+    clone(): this;
+    private type;
+}
+
+type AnyComponentBuilder = ContainerBuilder | SectionBuilder | TextDisplayBuilder | ThumbnailBuilder | MediaGalleryBuilder | MediaGalleryItemBuilder | SeparatorBuilder | FileBuilder | LabelBuilder;
+type ComponentJSON = ContainerJSON | SectionJSON | TextDisplayJSON | ThumbnailJSON | MediaGalleryJSON | SeparatorJSON | FileJSON | LabelJSON;
+interface ContainerJSON {
+    type: number;
+    components: ComponentJSON[];
+}
+interface SectionJSON {
+    type: number;
+    texts: ComponentJSON[];
+    accessory?: AccessoryJSON;
+}
+interface TextDisplayJSON {
+    type: number;
+    content: string;
+}
+interface ThumbnailJSON {
+    type: number;
+    url: string;
+    description?: string;
+    spoiler?: boolean;
+}
+interface MediaGalleryJSON {
+    type: number;
+    items: MediaGalleryItemJSON[];
+}
+interface MediaGalleryItemJSON {
+    type: number;
+    url: string;
+    description?: string;
+    spoiler?: boolean;
+}
+interface SeparatorJSON {
+    type: number;
+    spacing: number;
+    divider?: boolean;
+}
+interface FileJSON {
+    type: number;
+    url: string;
+    filename: string;
+    description?: string;
+}
+interface LabelJSON {
+    type: number;
+    label: string;
+    description?: string;
+}
+interface AccessoryJSON {
+    type: number;
+    style?: string;
+}
+
+declare class URLValidator {
+    static validate(url: string): void;
+    static validateOptional(url?: string): void;
+}
+
+declare class StringValidator {
+    static validate(value: any, field: string): void;
+    static validateLength(value: string, maxLength: number, field: string): void;
+    static validateOptional(value?: any, field?: string): void;
+}
+
+declare class ComponentValidator {
+    static validateType(type: ComponentType): void;
+    static validateComponentStructure(obj: any): void;
+}
+
+declare class LimitRules {
+    static validateComponentCount(count: number): void;
+    static validateGalleryItems(count: number): void;
+}
+
+declare class NestingRules {
+    static validateContainerNesting(componentType: ComponentType): void;
+    static validateSectionNesting(componentType: ComponentType): void;
+}
+
+declare class UrlUtils {
+    static isValidUrl(url: string): boolean;
+    static normalizeUrl(url: string): string;
+}
+
+declare class StringUtils {
+    static isString(value: any): value is string;
+    static truncate(text: string, maxLength: number): string;
+    static validateLength(text: string, maxLength: number, field: string): void;
+}
+
+declare class ArrayUtils {
+    static isValidArray<T>(arr: any): arr is T[];
+    static ensureArray<T>(items: T | T[]): T[];
+    static splice<T>(arr: T[], index: number, deleteCount: number, ...items: T[]): T[];
+}
+
+declare class ObjectUtils {
+    static deepClone<T>(obj: T): T;
+    static hasOwnProperty(obj: any, prop: string): boolean;
+    static mergeDeep<T extends Record<string, any>>(target: T, source: Partial<T>): T;
+}
+
+declare class ComponentHelper {
+    static createTextSection(text: string): SectionBuilder;
+    static createContainerFrom(...components: ComponentBuilder[]): ContainerBuilder;
+}
+
+declare class ComponentParser {
+    static parse(data: any): ComponentBuilder;
+    static parseMany(dataArray: any[]): ComponentBuilder[];
+}
+
+declare class ComponentRegistry {
+    private static builders;
+    static register(name: string, builder: typeof ComponentBuilder): void;
+    static get(name: string): typeof ComponentBuilder | undefined;
+    static has(name: string): boolean;
+}
+
+export { AccessoryBuilder, AccessoryJSON, AnyComponentBuilder, ArrayUtils, ComponentBuilder, ComponentHelper, ComponentJSON, ComponentLimitError, ComponentParser, ComponentRegistry, ComponentType, ComponentValidator, ContainerBuilder, ContainerJSON, FileBuilder, FileJSON, IComponentBuilder, InvalidComponentError, InvalidURLException, LabelBuilder, LabelJSON, LimitRules, Limits, MediaGalleryBuilder, MediaGalleryItemBuilder, MediaGalleryItemJSON, MediaGalleryJSON, NestingRules, ObjectUtils, SectionBuilder, SectionJSON, SeparatorBuilder, SeparatorJSON, StringUtils, StringValidator, TextDisplayBuilder, TextDisplayJSON, ThumbnailBuilder, ThumbnailJSON, URLValidator, UrlUtils, ValidationError };