seyfert 0.1.0

package/lib/builders/ActionRow.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionRow = void 0;
+const common_1 = require("../common");
+const Base_1 = require("./Base");
+const index_1 = require("./index");
+/**
+ * Represents an Action Row component in a message.
+ * @template T - The type of components in the Action Row.
+ */
+class ActionRow extends Base_1.BaseComponentBuilder {
+    /**
+     * Creates a new instance of the ActionRow class.
+     * @param data - Optional data to initialize the Action Row.
+     * @example
+     * const actionRow = new ActionRow<Button>({ components: [buttonRawJSON] });
+     */
+    constructor({ components, ...data } = {}) {
+        super({ ...data, type: common_1.ComponentType.ActionRow });
+        this.components = (components?.map(index_1.fromComponent) ?? []);
+    }
+    components;
+    /**
+     * Adds one or more components to the Action Row.
+     * @param component - The component(s) to add.
+     * @returns The updated Action Row instance.
+     * @example
+     * actionRow.addComponents(buttonComponent);
+     * actionRow.addComponents(buttonComponent1, buttonComponent2);
+     * actionRow.addComponents([buttonComponent1, buttonComponent2]);
+     */
+    addComponents(...component) {
+        this.components = this.components.concat((0, common_1.fastFlat)(component));
+        return this;
+    }
+    /**
+     * Sets the components of the Action Row.
+     * @param component - The components to set.
+     * @returns The updated Action Row instance.
+     * @example
+     * actionRow.setComponents([buttonComponent1, buttonComponent2]);
+     */
+    setComponents(component) {
+        this.components = [...component];
+        return this;
+    }
+    /**
+     * Converts the Action Row to its JSON representation.
+     * @returns The JSON representation of the Action Row.
+     */
+    toJSON() {
+        const components = this.components.map(c => {
+            return c.toJSON();
+        });
+        return { type: common_1.ComponentType.ActionRow, components };
+    }
+}
+exports.ActionRow = ActionRow;

package/lib/builders/Attachment.d.ts

@@ -0,0 +1,106 @@
+/// <reference types="node" />
+import type { RESTAPIAttachment } from 'discord-api-types/v10';
+import { type RawFile } from '..';
+import type { ImageResolvable } from '../common';
+export interface AttachmentResolvableMap {
+    url: string;
+    buffer: Buffer;
+    path: string;
+}
+export type AttachmentResolvable = AttachmentResolvableMap[keyof AttachmentResolvableMap] | Attachment;
+export type AttachmentDataType = keyof AttachmentResolvableMap;
+export interface AttachmentData {
+    name: string;
+    description: string;
+    resolvable: AttachmentResolvable;
+    type: AttachmentDataType;
+}
+export declare class Attachment {
+    data: Partial<AttachmentData>;
+    /**
+     * Creates a new Attachment instance.
+     * @param data - The partial attachment data.
+     */
+    constructor(data?: Partial<AttachmentData>);
+    /**
+     * Sets the name of the attachment.
+     * @param name - The name of the attachment.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setName('example.jpg');
+     */
+    setName(name: string): this;
+    /**
+     * Sets the description of the attachment.
+     * @param desc - The description of the attachment.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setDescription('This is an example attachment');
+     */
+    setDescription(desc: string): this;
+    /**
+     * Sets the file data of the attachment.
+     * @param type - The type of the attachment data.
+     * @param data - The resolvable data of the attachment.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setFile('url', 'https://example.com/example.jpg');
+     * attachment.setFile('path', '../assets/example.jpg');
+     * attachment.setFile('buffer', Buffer.from(image.decode()));
+     */
+    setFile<T extends AttachmentDataType = AttachmentDataType>(type: T, data: AttachmentResolvableMap[T]): this;
+    /**
+     * Sets whether the attachment is a spoiler.
+     * @param spoiler - Whether the attachment is a spoiler.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setSpoiler(true);
+     */
+    setSpoiler(spoiler: boolean): this;
+    /**
+     * Gets whether the attachment is a spoiler.
+     */
+    get spoiler(): boolean;
+    /**
+     * Converts the Attachment instance to JSON.
+     * @returns The JSON representation of the Attachment instance.
+     */
+    toJSON(): AttachmentData;
+}
+/**
+ * Resolves an attachment to a REST API attachment.
+ * @param resolve - The attachment or attachment data to resolve.
+ * @returns The resolved REST API attachment.
+ */
+export declare function resolveAttachment(resolve: Attachment | AttachmentData | RESTAPIAttachment): Omit<RESTAPIAttachment, 'id'>;
+/**
+ * Resolves a list of attachments to raw files.
+ * @param resources - The list of attachments to resolve.
+ * @returns The resolved raw files.
+ */
+export declare function resolveFiles(resources: (Attachment | RawFile)[]): Promise<RawFile[]>;
+/**
+ * Resolves the data of an attachment.
+ * @param data - The resolvable data of the attachment.
+ * @param type - The type of the attachment data.
+ * @returns The resolved attachment data.
+ */
+export declare function resolveAttachmentData(data: AttachmentResolvable, type: AttachmentDataType): Promise<{
+    data: AttachmentResolvable;
+    contentType?: undefined;
+} | {
+    data: Buffer;
+    contentType: string | null;
+}>;
+/**
+ * Resolves a base64 data to a data URL.
+ * @param data - The base64 data.
+ * @returns The resolved data URL.
+ */
+export declare function resolveBase64(data: string | Buffer): string;
+/**
+ * Resolves an image to a base64 data URL.
+ * @param image - The image to resolve.
+ * @returns The resolved base64 data URL.
+ */
+export declare function resolveImage(image: ImageResolvable): Promise<string>;

package/lib/builders/Attachment.js

@@ -0,0 +1,196 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveImage = exports.resolveBase64 = exports.resolveAttachmentData = exports.resolveFiles = exports.resolveAttachment = exports.Attachment = void 0;
+const node_crypto_1 = require("node:crypto");
+const promises_1 = require("node:fs/promises");
+const node_path_1 = __importDefault(require("node:path"));
+const __1 = require("..");
+class Attachment {
+    data;
+    /**
+     * Creates a new Attachment instance.
+     * @param data - The partial attachment data.
+     */
+    constructor(data = { name: `${(0, node_crypto_1.randomBytes)(8).toString('base64url')}.jpg` }) {
+        this.data = data;
+    }
+    /**
+     * Sets the name of the attachment.
+     * @param name - The name of the attachment.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setName('example.jpg');
+     */
+    setName(name) {
+        this.data.name = name;
+        return this;
+    }
+    /**
+     * Sets the description of the attachment.
+     * @param desc - The description of the attachment.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setDescription('This is an example attachment');
+     */
+    setDescription(desc) {
+        this.data.description = desc;
+        return this;
+    }
+    /**
+     * Sets the file data of the attachment.
+     * @param type - The type of the attachment data.
+     * @param data - The resolvable data of the attachment.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setFile('url', 'https://example.com/example.jpg');
+     * attachment.setFile('path', '../assets/example.jpg');
+     * attachment.setFile('buffer', Buffer.from(image.decode()));
+     */
+    setFile(type, data) {
+        this.data.type = type;
+        this.data.resolvable = data;
+        return this;
+    }
+    /**
+     * Sets whether the attachment is a spoiler.
+     * @param spoiler - Whether the attachment is a spoiler.
+     * @returns The Attachment instance.
+     * @example
+     * attachment.setSpoiler(true);
+     */
+    setSpoiler(spoiler) {
+        if (spoiler === this.spoiler)
+            return this;
+        if (!spoiler) {
+            this.data.name = this.data.name.slice('SPOILER_'.length);
+            return this;
+        }
+        this.data.name = `SPOILER_${this.data.name}`;
+        return this;
+    }
+    /**
+     * Gets whether the attachment is a spoiler.
+     */
+    get spoiler() {
+        return this.data.name?.startsWith('SPOILER_') ?? false;
+    }
+    /**
+     * Converts the Attachment instance to JSON.
+     * @returns The JSON representation of the Attachment instance.
+     */
+    toJSON() {
+        return this.data;
+    }
+}
+exports.Attachment = Attachment;
+/**
+ * Resolves an attachment to a REST API attachment.
+ * @param resolve - The attachment or attachment data to resolve.
+ * @returns The resolved REST API attachment.
+ */
+function resolveAttachment(resolve) {
+    if ('id' in resolve)
+        return resolve;
+    if (resolve instanceof Attachment) {
+        const data = resolve.toJSON();
+        return { filename: data.name, description: data.description };
+    }
+    return { filename: resolve.name, description: resolve.description };
+}
+exports.resolveAttachment = resolveAttachment;
+/**
+ * Resolves a list of attachments to raw files.
+ * @param resources - The list of attachments to resolve.
+ * @returns The resolved raw files.
+ */
+async function resolveFiles(resources) {
+    const data = await Promise.all(resources.map(async (resource, i) => {
+        if (resource instanceof Attachment) {
+            const { type, resolvable, name } = resource.toJSON();
+            const resolve = await resolveAttachmentData(resolvable, type);
+            return { ...resolve, key: `files[${i}]`, name };
+        }
+        return {
+            data: resource.data,
+            contentType: resource.contentType,
+            key: `files[${i}]`,
+            name: resource.name,
+        };
+    }));
+    return data;
+}
+exports.resolveFiles = resolveFiles;
+/**
+ * Resolves the data of an attachment.
+ * @param data - The resolvable data of the attachment.
+ * @param type - The type of the attachment data.
+ * @returns The resolved attachment data.
+ */
+async function resolveAttachmentData(data, type) {
+    if (data instanceof Attachment) {
+        if (!data.data.resolvable)
+            return (0, __1.throwError)('The attachment type has been expressed as attachment but cannot be resolved as one.');
+        return { data: data.data.resolvable };
+    }
+    switch (type) {
+        case 'url': {
+            if (!/^https?:\/\//.test(data))
+                return (0, __1.throwError)(`The attachment type has been expressed as ${type.toUpperCase()} but cannot be resolved as one.`);
+            const res = await fetch(data);
+            return { data: Buffer.from(await res.arrayBuffer()), contentType: res.headers.get('content-type') };
+        }
+        case 'path': {
+            const file = node_path_1.default.resolve(data);
+            const stats = await (0, promises_1.stat)(file);
+            if (!stats.isFile())
+                return (0, __1.throwError)(`The attachment type has been expressed as ${type.toUpperCase()} but cannot be resolved as one.`);
+            return { data: await (0, promises_1.readFile)(file) };
+        }
+        case 'buffer': {
+            if (Buffer.isBuffer(data))
+                return { data };
+            // @ts-expect-error
+            if (typeof data[Symbol.asyncIterator] === 'function') {
+                const buffers = [];
+                for await (const resource of data)
+                    buffers.push(Buffer.from(resource));
+                return { data: Buffer.concat(buffers) };
+            }
+            return (0, __1.throwError)(`The attachment type has been expressed as ${type.toUpperCase()} but cannot be resolved as one.`);
+        }
+        default: {
+            return (0, __1.throwError)(`The attachment type has been expressed as ${type} but cannot be resolved as one.`);
+        }
+    }
+}
+exports.resolveAttachmentData = resolveAttachmentData;
+/**
+ * Resolves a base64 data to a data URL.
+ * @param data - The base64 data.
+ * @returns The resolved data URL.
+ */
+function resolveBase64(data) {
+    if (Buffer.isBuffer(data))
+        return `data:image/jpg;base64,${data.toString('base64')}`;
+    return data;
+}
+exports.resolveBase64 = resolveBase64;
+/**
+ * Resolves an image to a base64 data URL.
+ * @param image - The image to resolve.
+ * @returns The resolved base64 data URL.
+ */
+async function resolveImage(image) {
+    if (image instanceof Attachment) {
+        const { data: { type, resolvable }, } = image;
+        if (type && resolvable)
+            return resolveBase64((await resolveAttachmentData(resolvable, type)).data);
+        return (0, __1.throwError)(`The attachment type has been expressed as ${(type ?? 'Attachment').toUpperCase()} but cannot be resolved as one.`);
+    }
+    const file = await resolveAttachmentData(image.data, image.type);
+    return resolveBase64(file.data);
+}
+exports.resolveImage = resolveImage;

package/lib/builders/Base.d.ts

@@ -0,0 +1,10 @@
+import type { APIBaseComponent, ComponentType } from '../common';
+export declare abstract class BaseComponentBuilder<TYPE extends Partial<APIBaseComponent<ComponentType>> = APIBaseComponent<ComponentType>> {
+    data: Partial<TYPE>;
+    constructor(data: Partial<TYPE>);
+    toJSON(): TYPE;
+}
+export type OptionValuesLength = {
+    max: number;
+    min: number;
+};

package/lib/builders/Base.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseComponentBuilder = void 0;
+class BaseComponentBuilder {
+    data;
+    constructor(data) {
+        this.data = data;
+    }
+    toJSON() {
+        return { ...this.data };
+    }
+}
+exports.BaseComponentBuilder = BaseComponentBuilder;

package/lib/builders/Button.d.ts

@@ -0,0 +1,59 @@
+import { type APIButtonComponent, type APIButtonComponentWithCustomId, type APIButtonComponentWithURL, type ButtonStyle, type EmojiResolvable, type When } from '../common';
+import type { ButtonInteraction } from '../structures';
+import type { ComponentCallback } from './types';
+export type ButtonStylesForID = Exclude<ButtonStyle, ButtonStyle.Link>;
+/**
+ * Represents a button component.
+ * @template Type - The type of the button component.
+ */
+export declare class Button<Type extends boolean = boolean> {
+    data: Partial<When<Type, APIButtonComponentWithCustomId, APIButtonComponentWithURL>>;
+    /**
+     * Creates a new Button instance.
+     * @param data - The initial data for the button.
+     */
+    constructor(data?: Partial<When<Type, APIButtonComponentWithCustomId, APIButtonComponentWithURL>>);
+    /**
+     * Sets the custom ID for the button.
+     * @param id - The custom ID to set.
+     * @returns The modified Button instance.
+     */
+    setCustomId(id: string): Omit<this, 'setURL'>;
+    /**
+     * Sets the URL for the button.
+     * @param url - The URL to set.
+     * @returns The modified Button instance.
+     */
+    setURL(url: string): Omit<this, 'setCustomId' | 'run'>;
+    /**
+     * Sets the label for the button.
+     * @param label - The label to set.
+     * @returns The modified Button instance.
+     */
+    setLabel(label: string): this;
+    /**
+     * Sets the emoji for the button.
+     * @param emoji - The emoji to set.
+     * @returns The modified Button instance.
+     */
+    setEmoji(emoji: EmojiResolvable): this;
+    /**
+     * Sets the disabled state of the button.
+     * @param disabled - Whether the button should be disabled or not.
+     * @returns The modified Button instance.
+     */
+    setDisabled(disabled?: boolean): this;
+    setStyle(style: ButtonStyle.Link): Omit<this, 'setCustomId' | 'run'>;
+    setStyle(style: ButtonStylesForID): Omit<this, 'setURL'>;
+    /**
+     * Sets the callback function to be executed when the button is interacted with.
+     * @param func - The callback function to set.
+     * @returns The modified Button instance.
+     */
+    run(func: ComponentCallback<ButtonInteraction>): Omit<this, 'setURL'>;
+    /**
+     * Converts the Button instance to its JSON representation.
+     * @returns The JSON representation of the Button instance.
+     */
+    toJSON(): APIButtonComponent;
+}

package/lib/builders/Button.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Button = void 0;
+const __1 = require("..");
+const common_1 = require("../common");
+const functions_1 = require("../structures/extra/functions");
+/**
+ * Represents a button component.
+ * @template Type - The type of the button component.
+ */
+class Button {
+    data;
+    /** @internal */
+    __exec;
+    /**
+     * Creates a new Button instance.
+     * @param data - The initial data for the button.
+     */
+    constructor(data = {}) {
+        this.data = data;
+        this.data.type = common_1.ComponentType.Button;
+    }
+    /**
+     * Sets the custom ID for the button.
+     * @param id - The custom ID to set.
+     * @returns The modified Button instance.
+     */
+    setCustomId(id) {
+        // @ts-expect-error
+        this.data.custom_id = id;
+        return this;
+    }
+    /**
+     * Sets the URL for the button.
+     * @param url - The URL to set.
+     * @returns The modified Button instance.
+     */
+    setURL(url) {
+        // @ts-expect-error
+        this.data.url = url;
+        return this;
+    }
+    /**
+     * Sets the label for the button.
+     * @param label - The label to set.
+     * @returns The modified Button instance.
+     */
+    setLabel(label) {
+        this.data.label = label;
+        return this;
+    }
+    /**
+     * Sets the emoji for the button.
+     * @param emoji - The emoji to set.
+     * @returns The modified Button instance.
+     */
+    setEmoji(emoji) {
+        const resolve = (0, functions_1.resolvePartialEmoji)(emoji);
+        if (!resolve)
+            return (0, __1.throwError)('Invalid Emoji');
+        this.data.emoji = resolve;
+        return this;
+    }
+    /**
+     * Sets the disabled state of the button.
+     * @param disabled - Whether the button should be disabled or not.
+     * @returns The modified Button instance.
+     */
+    setDisabled(disabled = true) {
+        this.data.disabled = disabled;
+        return this;
+    }
+    setStyle(style) {
+        this.data.style = style;
+        return this;
+    }
+    /**
+     * Sets the callback function to be executed when the button is interacted with.
+     * @param func - The callback function to set.
+     * @returns The modified Button instance.
+     */
+    run(func) {
+        this.__exec = func;
+        return this;
+    }
+    /**
+     * Converts the Button instance to its JSON representation.
+     * @returns The JSON representation of the Button instance.
+     */
+    toJSON() {
+        return { ...this.data };
+    }
+}
+exports.Button = Button;

package/lib/builders/MessageEmbed.d.ts

@@ -0,0 +1,116 @@
+import { type APIEmbed, type APIEmbedAuthor, type APIEmbedField, type APIEmbedFooter, type ColorResolvable, type ObjectToLower, type RestOrArray } from '../common';
+/**
+ * Represents a message embed.
+ * @example
+ * const embed = new MessageEmbed();
+ * embed.setTitle('Seyfert');
+ * embed.setDescription('Better than discord.js');
+ * embed.setColor('Green');
+ * const embedJSON = embed.json();
+ */
+export declare class Embed {
+    data: Partial<APIEmbed>;
+    /**
+     * Creates a new instance of MessageEmbed.
+     * @param data - The initial data for the embed.
+     * @example
+     * const embed = new MessageEmbed({ title: 'Hello', description: 'This is an example embed' });
+     */
+    constructor(data?: Partial<APIEmbed>);
+    /**
+     * Sets the author of the embed.
+     * @param author - The author information.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setAuthor({ name: 'John Doe', iconURL: 'https://example.com/avatar.png' });
+     */
+    setAuthor(author: ObjectToLower<APIEmbedAuthor>): this;
+    /**
+     * Sets the color of the embed.
+     * @param color - The color of the embed.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setColor('#FF0000');
+     * embed.setColor('Blurple');
+     */
+    setColor(color: ColorResolvable): this;
+    /**
+     * Sets the description of the embed.
+     * @param desc - The description of the embed.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setDescription('This is the description of the embed');
+     */
+    setDescription(desc: string): this;
+    /**
+     * Adds one or more fields to the embed.
+     * @param fields - The fields to add to the embed.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.addFields({ name: 'Field 1', value: 'Value 1' }, { name: 'Field 2', value: 'Value 2' });
+     */
+    addFields(...fields: RestOrArray<APIEmbedField>): this;
+    /**
+     * Sets the fields of the embed.
+     * @param fields - The fields of the embed.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setFields([{ name: 'Field 1', value: 'Value 1' }, { name: 'Field 2', value: 'Value 2' }]);
+     */
+    setFields(fields: APIEmbedField[]): this;
+    /**
+     * Sets the footer of the embed.
+     * @param footer - The footer information.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setFooter({ text: 'This is the footer', iconURL: 'https://example.com/footer.png' });
+     */
+    setFooter(footer: ObjectToLower<Omit<APIEmbedFooter, 'proxy_icon_url'>>): this;
+    /**
+     * Sets the image of the embed.
+     * @param url - The URL of the image.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setImage('https://example.com/image.png');
+     */
+    setImage(url: string): this;
+    /**
+     * Sets the timestamp of the embed.
+     * @param time - The timestamp value.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setTimestamp();
+     * embed.setTimestamp(1628761200000);
+     * embed.setTimestamp(new Date());
+     */
+    setTimestamp(time?: string | number | Date): this;
+    /**
+     * Sets the title of the embed.
+     * @param title - The title of the embed.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setTitle('This is the title');
+     */
+    setTitle(title: string): this;
+    /**
+     * Sets the URL of the embed.
+     * @param url - The URL of the embed.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setURL('https://seyfert.com');
+     */
+    setURL(url: string): this;
+    /**
+     * Sets the thumbnail of the embed.
+     * @param url - The URL of the thumbnail.
+     * @returns The updated MessageEmbed instance.
+     * @example
+     * embed.setThumbnail('https://example.com/thumbnail.png');
+     */
+    setThumbnail(url?: string): this;
+    /**
+     * Converts the MessageEmbed instance to a JSON object.
+     * @returns The JSON representation of the MessageEmbed instance.
+     */
+    toJSON(): APIEmbed;
+}