@discordjs/builders 0.7.0 → 0.9.0

package/dist/messages/embed/Embed.js

@@ -1,300 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Embed = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = (0, tslib_1.__importDefault)(require("ow"));
-const Assertions_1 = require("./Assertions");
-/**
- * Represents an embed in a message (image/video preview, rich embed, etc.)
- */
-class Embed {
-    constructor(data = {}) {
-        /**
-         * An array of fields of this embed.
-         */
-        Object.defineProperty(this, "fields", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed title.
-         */
-        Object.defineProperty(this, "title", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed description.
-         */
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed url.
-         */
-        Object.defineProperty(this, "url", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed color.
-         */
-        Object.defineProperty(this, "color", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The timestamp of the embed in the ISO format.
-         */
-        Object.defineProperty(this, "timestamp", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed thumbnail data.
-         */
-        Object.defineProperty(this, "thumbnail", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed image data.
-         */
-        Object.defineProperty(this, "image", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * Received video data.
-         */
-        Object.defineProperty(this, "video", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed author data.
-         */
-        Object.defineProperty(this, "author", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * Received data about the embed provider.
-         */
-        Object.defineProperty(this, "provider", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The embed footer data.
-         */
-        Object.defineProperty(this, "footer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.title = data.title;
-        this.description = data.description;
-        this.url = data.url;
-        this.color = data.color;
-        this.thumbnail = data.thumbnail;
-        this.image = data.image;
-        this.video = data.video;
-        this.author = data.author;
-        this.provider = data.provider;
-        this.footer = data.footer;
-        this.fields = data.fields ?? [];
-        if (data.timestamp)
-            this.timestamp = new Date(data.timestamp).toISOString();
-    }
-    /**
-     * The accumulated length for the embed title, description, fields, footer text, and author name.
-     */
-    get length() {
-        return ((this.title?.length ?? 0) +
-            (this.description?.length ?? 0) +
-            this.fields.reduce((prev, curr) => prev + curr.name.length + curr.value.length, 0) +
-            (this.footer?.text.length ?? 0) +
-            (this.author?.name.length ?? 0));
-    }
-    /**
-     * Adds a field to the embed (max 25).
-     * @param field The field to add.
-     */
-    addField(field) {
-        return this.addFields(field);
-    }
-    /**
-     * Adds fields to the embed (max 25).
-     * @param fields The fields to add.
-     */
-    addFields(...fields) {
-        // Data assertions
-        (0, ow_1.default)(fields, 'fields', Assertions_1.embedFieldsArrayPredicate);
-        // Ensure adding these fields won't exceed the 25 field limit
-        (0, Assertions_1.validateFieldLength)(this.fields, fields.length);
-        this.fields.push(...Embed.normalizeFields(...fields));
-        return this;
-    }
-    /**
-     * Removes, replaces, or inserts fields in the embed (max 25).
-     * @param index The index to start at.
-     * @param deleteCount The number of fields to remove.
-     * @param fields The replacing field objects.
-     */
-    spliceFields(index, deleteCount, ...fields) {
-        // Data assertions
-        (0, ow_1.default)(fields, 'fields', Assertions_1.embedFieldsArrayPredicate);
-        // Ensure adding these fields won't exceed the 25 field limit
-        (0, Assertions_1.validateFieldLength)(this.fields, fields.length - deleteCount);
-        this.fields.splice(index, deleteCount, ...Embed.normalizeFields(...fields));
-        return this;
-    }
-    /**
-     * Sets the author of this embed.
-     * @param options The options for the author.
-     */
-    setAuthor(options) {
-        if (options === null) {
-            this.author = undefined;
-            return this;
-        }
-        const { name, iconURL, url } = options;
-        // Data assertions
-        (0, ow_1.default)(name, 'name', Assertions_1.authorNamePredicate);
-        (0, ow_1.default)(iconURL, 'iconURL', Assertions_1.urlPredicate);
-        (0, ow_1.default)(url, 'url', Assertions_1.urlPredicate);
-        this.author = { name, url, icon_url: iconURL };
-        return this;
-    }
-    /**
-     * Sets the color of this embed.
-     * @param color The color of the embed.
-     */
-    setColor(color) {
-        // Data assertions
-        (0, ow_1.default)(color, 'color', Assertions_1.colorPredicate);
-        this.color = color ?? undefined;
-        return this;
-    }
-    /**
-     * Sets the description of this embed.
-     * @param description The description.
-     */
-    setDescription(description) {
-        // Data assertions
-        (0, ow_1.default)(description, 'description', Assertions_1.descriptionPredicate);
-        this.description = description ?? undefined;
-        return this;
-    }
-    /**
-     * Sets the footer of this embed.
-     * @param options The options for the footer.
-     */
-    setFooter(options) {
-        if (options === null) {
-            this.footer = undefined;
-            return this;
-        }
-        const { text, iconURL } = options;
-        // Data assertions
-        (0, ow_1.default)(text, 'text', Assertions_1.footerTextPredicate);
-        (0, ow_1.default)(iconURL, 'iconURL', Assertions_1.urlPredicate);
-        this.footer = { text, icon_url: iconURL };
-        return this;
-    }
-    /**
-     * Sets the image of this embed.
-     * @param url The URL of the image.
-     */
-    setImage(url) {
-        // Data assertions
-        (0, ow_1.default)(url, 'url', Assertions_1.urlPredicate);
-        this.image = url ? { url } : undefined;
-        return this;
-    }
-    /**
-     * Sets the thumbnail of this embed.
-     * @param url The URL of the thumbnail.
-     */
-    setThumbnail(url) {
-        // Data assertions
-        (0, ow_1.default)(url, 'url', Assertions_1.urlPredicate);
-        this.thumbnail = url ? { url } : undefined;
-        return this;
-    }
-    /**
-     * Sets the timestamp of this embed.
-     * @param timestamp The timestamp or date.
-     */
-    setTimestamp(timestamp = Date.now()) {
-        // Data assertions
-        (0, ow_1.default)(timestamp, 'timestamp', Assertions_1.timestampPredicate);
-        this.timestamp = timestamp ? new Date(timestamp).toISOString() : undefined;
-        return this;
-    }
-    /**
-     * Sets the title of this embed.
-     * @param title The title.
-     */
-    setTitle(title) {
-        // Data assertions
-        (0, ow_1.default)(title, 'title', Assertions_1.titlePredicate);
-        this.title = title ?? undefined;
-        return this;
-    }
-    /**
-     * Sets the URL of this embed.
-     * @param url The URL.
-     */
-    setURL(url) {
-        // Data assertions
-        (0, ow_1.default)(url, 'url', Assertions_1.urlPredicate);
-        this.url = url ?? undefined;
-        return this;
-    }
-    /**
-     * Transforms the embed to a plain object.
-     */
-    toJSON() {
-        return { ...this };
-    }
-    /**
-     * Normalizes field input and resolves strings.
-     * @param fields Fields to normalize.
-     */
-    static normalizeFields(...fields) {
-        return fields.flat(Infinity).map((field) => {
-            (0, ow_1.default)(field.name, 'field name', Assertions_1.fieldNamePredicate);
-            (0, ow_1.default)(field.value, 'field value', Assertions_1.fieldValuePredicate);
-            (0, ow_1.default)(field.inline, 'field inline', Assertions_1.fieldInlinePredicate);
-            return { name: field.name, value: field.value, inline: field.inline ?? undefined };
-        });
-    }
-}
-exports.Embed = Embed;
-//# sourceMappingURL=Embed.js.map

package/dist/messages/embed/Embed.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Embed.js","sourceRoot":"/","sources":["messages/embed/Embed.ts"],"names":[],"mappings":";;;;AAUA,yDAAoB;AACpB,6CAasB;AAatB;;GAEG;AACH,MAAa,KAAK;IA6DjB,YAAmB,OAAiB,EAAE;QA5DtC;;WAEG;QACH;;;;;WAA+B;QAE/B;;WAEG;QACH;;;;;WAAsB;QAEtB;;WAEG;QACH;;;;;WAA4B;QAE5B;;WAEG;QACH;;;;;WAAoB;QAEpB;;WAEG;QACH;;;;;WAAsB;QAEtB;;WAEG;QACH;;;;;WAA0B;QAE1B;;WAEG;QACH;;;;;WAAqC;QAErC;;WAEG;QACH;;;;;WAA6B;QAE7B;;WAEG;QACH;;;;;WAA6B;QAE7B;;WAEG;QACH;;;;;WAA+B;QAE/B;;WAEG;QACH;;;;;WAAmC;QAEnC;;WAEG;QACH;;;;;WAA+B;QAG9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAEhC,IAAI,IAAI,CAAC,SAAS;YAAE,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QAChB,OAAO,CACN,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;YACzB,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,IAAI,CAAC,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAClF,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;YAC/B,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,CAC/B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,KAAoB;QACnC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,GAAG,MAAuB;QAC1C,kBAAkB;QAClB,IAAA,YAAE,EAAC,MAAM,EAAE,QAAQ,EAAE,sCAAyB,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAA,gCAAmB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAEhD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,KAAa,EAAE,WAAmB,EAAE,GAAG,MAAuB;QACjF,kBAAkB;QAClB,IAAA,YAAE,EAAC,MAAM,EAAE,QAAQ,EAAE,sCAAyB,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAA,gCAAmB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC;QAE9D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,OAA6B;QAC7C,IAAI,OAAO,KAAK,IAAI,EAAE;YACrB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,OAAO,IAAI,CAAC;SACZ;QAED,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;QACvC,kBAAkB;QAClB,IAAA,YAAE,EAAC,IAAI,EAAE,MAAM,EAAE,gCAAmB,CAAC,CAAC;QACtC,IAAA,YAAE,EAAC,OAAO,EAAE,SAAS,EAAE,yBAAY,CAAC,CAAC;QACrC,IAAA,YAAE,EAAC,GAAG,EAAE,KAAK,EAAE,yBAAY,CAAC,CAAC;QAE7B,IAAI,CAAC,MAAM,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,KAAoB;QACnC,kBAAkB;QAClB,IAAA,YAAE,EAAC,KAAK,EAAE,OAAO,EAAE,2BAAc,CAAC,CAAC;QAEnC,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,SAAS,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,WAA0B;QAC/C,kBAAkB;QAClB,IAAA,YAAE,EAAC,WAAW,EAAE,aAAa,EAAE,iCAAoB,CAAC,CAAC;QAErD,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,SAAS,CAAC;QAC5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,OAA6B;QAC7C,IAAI,OAAO,KAAK,IAAI,EAAE;YACrB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,OAAO,IAAI,CAAC;SACZ;QAED,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAClC,kBAAkB;QAClB,IAAA,YAAE,EAAC,IAAI,EAAE,MAAM,EAAE,gCAAmB,CAAC,CAAC;QACtC,IAAA,YAAE,EAAC,OAAO,EAAE,SAAS,EAAE,yBAAY,CAAC,CAAC;QAErC,IAAI,CAAC,MAAM,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,GAAkB;QACjC,kBAAkB;QAClB,IAAA,YAAE,EAAC,GAAG,EAAE,KAAK,EAAE,yBAAY,CAAC,CAAC;QAE7B,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,GAAkB;QACrC,kBAAkB;QAClB,IAAA,YAAE,EAAC,GAAG,EAAE,KAAK,EAAE,yBAAY,CAAC,CAAC;QAE7B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,YAAkC,IAAI,CAAC,GAAG,EAAE;QAC/D,kBAAkB;QAClB,IAAA,YAAE,EAAC,SAAS,EAAE,WAAW,EAAE,+BAAkB,CAAC,CAAC;QAE/C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,KAAoB;QACnC,kBAAkB;QAClB,IAAA,YAAE,EAAC,KAAK,EAAE,OAAO,EAAE,2BAAc,CAAC,CAAC;QAEnC,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,SAAS,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,GAAkB;QAC/B,kBAAkB;QAClB,IAAA,YAAE,EAAC,GAAG,EAAE,KAAK,EAAE,yBAAY,CAAC,CAAC;QAE7B,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAAC,GAAG,MAAuB;QACvD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1C,IAAA,YAAE,EAAC,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,+BAAkB,CAAC,CAAC;YACjD,IAAA,YAAE,EAAC,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,gCAAmB,CAAC,CAAC;YACpD,IAAA,YAAE,EAAC,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,iCAAoB,CAAC,CAAC;YAEvD,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;QACpF,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AAjRD,sBAiRC","sourcesContent":["import type {\n\tAPIEmbed,\n\tAPIEmbedAuthor,\n\tAPIEmbedField,\n\tAPIEmbedFooter,\n\tAPIEmbedImage,\n\tAPIEmbedProvider,\n\tAPIEmbedThumbnail,\n\tAPIEmbedVideo,\n} from 'discord-api-types/v9';\nimport ow from 'ow';\nimport {\n\tauthorNamePredicate,\n\tcolorPredicate,\n\tdescriptionPredicate,\n\tembedFieldsArrayPredicate,\n\tfieldInlinePredicate,\n\tfieldNamePredicate,\n\tfieldValuePredicate,\n\tfooterTextPredicate,\n\ttimestampPredicate,\n\ttitlePredicate,\n\turlPredicate,\n\tvalidateFieldLength,\n} from './Assertions';\n\nexport interface AuthorOptions {\n\tname: string;\n\turl?: string;\n\ticonURL?: string;\n}\n\nexport interface FooterOptions {\n\ttext: string;\n\ticonURL?: string;\n}\n\n/**\n * Represents an embed in a message (image/video preview, rich embed, etc.)\n */\nexport class Embed implements APIEmbed {\n\t/**\n\t * An array of fields of this embed.\n\t */\n\tpublic fields: APIEmbedField[];\n\n\t/**\n\t * The embed title.\n\t */\n\tpublic title?: string;\n\n\t/**\n\t * The embed description.\n\t */\n\tpublic description?: string;\n\n\t/**\n\t * The embed url.\n\t */\n\tpublic url?: string;\n\n\t/**\n\t * The embed color.\n\t */\n\tpublic color?: number;\n\n\t/**\n\t * The timestamp of the embed in the ISO format.\n\t */\n\tpublic timestamp?: string;\n\n\t/**\n\t * The embed thumbnail data.\n\t */\n\tpublic thumbnail?: APIEmbedThumbnail;\n\n\t/**\n\t * The embed image data.\n\t */\n\tpublic image?: APIEmbedImage;\n\n\t/**\n\t * Received video data.\n\t */\n\tpublic video?: APIEmbedVideo;\n\n\t/**\n\t * The embed author data.\n\t */\n\tpublic author?: APIEmbedAuthor;\n\n\t/**\n\t * Received data about the embed provider.\n\t */\n\tpublic provider?: APIEmbedProvider;\n\n\t/**\n\t * The embed footer data.\n\t */\n\tpublic footer?: APIEmbedFooter;\n\n\tpublic constructor(data: APIEmbed = {}) {\n\t\tthis.title = data.title;\n\t\tthis.description = data.description;\n\t\tthis.url = data.url;\n\t\tthis.color = data.color;\n\t\tthis.thumbnail = data.thumbnail;\n\t\tthis.image = data.image;\n\t\tthis.video = data.video;\n\t\tthis.author = data.author;\n\t\tthis.provider = data.provider;\n\t\tthis.footer = data.footer;\n\t\tthis.fields = data.fields ?? [];\n\n\t\tif (data.timestamp) this.timestamp = new Date(data.timestamp).toISOString();\n\t}\n\n\t/**\n\t * The accumulated length for the embed title, description, fields, footer text, and author name.\n\t */\n\tpublic get length(): number {\n\t\treturn (\n\t\t\t(this.title?.length ?? 0) +\n\t\t\t(this.description?.length ?? 0) +\n\t\t\tthis.fields.reduce((prev, curr) => prev + curr.name.length + curr.value.length, 0) +\n\t\t\t(this.footer?.text.length ?? 0) +\n\t\t\t(this.author?.name.length ?? 0)\n\t\t);\n\t}\n\n\t/**\n\t * Adds a field to the embed (max 25).\n\t * @param field The field to add.\n\t */\n\tpublic addField(field: APIEmbedField): this {\n\t\treturn this.addFields(field);\n\t}\n\n\t/**\n\t * Adds fields to the embed (max 25).\n\t * @param fields The fields to add.\n\t */\n\tpublic addFields(...fields: APIEmbedField[]): this {\n\t\t// Data assertions\n\t\tow(fields, 'fields', embedFieldsArrayPredicate);\n\n\t\t// Ensure adding these fields won't exceed the 25 field limit\n\t\tvalidateFieldLength(this.fields, fields.length);\n\n\t\tthis.fields.push(...Embed.normalizeFields(...fields));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Removes, replaces, or inserts fields in the embed (max 25).\n\t * @param index The index to start at.\n\t * @param deleteCount The number of fields to remove.\n\t * @param fields The replacing field objects.\n\t */\n\tpublic spliceFields(index: number, deleteCount: number, ...fields: APIEmbedField[]): this {\n\t\t// Data assertions\n\t\tow(fields, 'fields', embedFieldsArrayPredicate);\n\n\t\t// Ensure adding these fields won't exceed the 25 field limit\n\t\tvalidateFieldLength(this.fields, fields.length - deleteCount);\n\n\t\tthis.fields.splice(index, deleteCount, ...Embed.normalizeFields(...fields));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the author of this embed.\n\t * @param options The options for the author.\n\t */\n\tpublic setAuthor(options: AuthorOptions | null): this {\n\t\tif (options === null) {\n\t\t\tthis.author = undefined;\n\t\t\treturn this;\n\t\t}\n\n\t\tconst { name, iconURL, url } = options;\n\t\t// Data assertions\n\t\tow(name, 'name', authorNamePredicate);\n\t\tow(iconURL, 'iconURL', urlPredicate);\n\t\tow(url, 'url', urlPredicate);\n\n\t\tthis.author = { name, url, icon_url: iconURL };\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the color of this embed.\n\t * @param color The color of the embed.\n\t */\n\tpublic setColor(color: number | null): this {\n\t\t// Data assertions\n\t\tow(color, 'color', colorPredicate);\n\n\t\tthis.color = color ?? undefined;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the description of this embed.\n\t * @param description The description.\n\t */\n\tpublic setDescription(description: string | null): this {\n\t\t// Data assertions\n\t\tow(description, 'description', descriptionPredicate);\n\n\t\tthis.description = description ?? undefined;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the footer of this embed.\n\t * @param options The options for the footer.\n\t */\n\tpublic setFooter(options: FooterOptions | null): this {\n\t\tif (options === null) {\n\t\t\tthis.footer = undefined;\n\t\t\treturn this;\n\t\t}\n\n\t\tconst { text, iconURL } = options;\n\t\t// Data assertions\n\t\tow(text, 'text', footerTextPredicate);\n\t\tow(iconURL, 'iconURL', urlPredicate);\n\n\t\tthis.footer = { text, icon_url: iconURL };\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the image of this embed.\n\t * @param url The URL of the image.\n\t */\n\tpublic setImage(url: string | null): this {\n\t\t// Data assertions\n\t\tow(url, 'url', urlPredicate);\n\n\t\tthis.image = url ? { url } : undefined;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the thumbnail of this embed.\n\t * @param url The URL of the thumbnail.\n\t */\n\tpublic setThumbnail(url: string | null): this {\n\t\t// Data assertions\n\t\tow(url, 'url', urlPredicate);\n\n\t\tthis.thumbnail = url ? { url } : undefined;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the timestamp of this embed.\n\t * @param timestamp The timestamp or date.\n\t */\n\tpublic setTimestamp(timestamp: number | Date | null = Date.now()): this {\n\t\t// Data assertions\n\t\tow(timestamp, 'timestamp', timestampPredicate);\n\n\t\tthis.timestamp = timestamp ? new Date(timestamp).toISOString() : undefined;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the title of this embed.\n\t * @param title The title.\n\t */\n\tpublic setTitle(title: string | null): this {\n\t\t// Data assertions\n\t\tow(title, 'title', titlePredicate);\n\n\t\tthis.title = title ?? undefined;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Sets the URL of this embed.\n\t * @param url The URL.\n\t */\n\tpublic setURL(url: string | null): this {\n\t\t// Data assertions\n\t\tow(url, 'url', urlPredicate);\n\n\t\tthis.url = url ?? undefined;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Transforms the embed to a plain object.\n\t */\n\tpublic toJSON(): APIEmbed {\n\t\treturn { ...this };\n\t}\n\n\t/**\n\t * Normalizes field input and resolves strings.\n\t * @param fields Fields to normalize.\n\t */\n\tpublic static normalizeFields(...fields: APIEmbedField[]): APIEmbedField[] {\n\t\treturn fields.flat(Infinity).map((field) => {\n\t\t\tow(field.name, 'field name', fieldNamePredicate);\n\t\t\tow(field.value, 'field value', fieldValuePredicate);\n\t\t\tow(field.inline, 'field inline', fieldInlinePredicate);\n\n\t\t\treturn { name: field.name, value: field.value, inline: field.inline ?? undefined };\n\t\t});\n\t}\n}\n"]}

package/dist/messages/formatters.d.ts

@@ -1,198 +0,0 @@
-/// <reference types="node" />
-import type { Snowflake } from 'discord-api-types/globals';
-import type { URL } from 'url';
-/**
- * Wraps the content inside a codeblock with no language.
- * @param content The content to wrap.
- */
-export declare function codeBlock<C extends string>(content: C): `\`\`\`\n${C}\`\`\``;
-/**
- * Wraps the content inside a codeblock with the specified language.
- * @param language The language for the codeblock.
- * @param content The content to wrap.
- */
-export declare function codeBlock<L extends string, C extends string>(language: L, content: C): `\`\`\`${L}\n${C}\`\`\``;
-/**
- * Wraps the content inside \`backticks\`, which formats it as inline code.
- * @param content The content to wrap.
- */
-export declare function inlineCode<C extends string>(content: C): `\`${C}\``;
-/**
- * Formats the content into italic text.
- * @param content The content to wrap.
- */
-export declare function italic<C extends string>(content: C): `_${C}_`;
-/**
- * Formats the content into bold text.
- * @param content The content to wrap.
- */
-export declare function bold<C extends string>(content: C): `**${C}**`;
-/**
- * Formats the content into underscored text.
- * @param content The content to wrap.
- */
-export declare function underscore<C extends string>(content: C): `__${C}__`;
-/**
- * Formats the content into strike-through text.
- * @param content The content to wrap.
- */
-export declare function strikethrough<C extends string>(content: C): `~~${C}~~`;
-/**
- * Formats the content into a quote. This needs to be at the start of the line for Discord to format it.
- * @param content The content to wrap.
- */
-export declare function quote<C extends string>(content: C): `> ${C}`;
-/**
- * Formats the content into a block quote. This needs to be at the start of the line for Discord to format it.
- * @param content The content to wrap.
- */
-export declare function blockQuote<C extends string>(content: C): `>>> ${C}`;
-/**
- * Wraps the URL into `<>`, which stops it from embedding.
- * @param url The URL to wrap.
- */
-export declare function hideLinkEmbed<C extends string>(url: C): `<${C}>`;
-/**
- * Wraps the URL into `<>`, which stops it from embedding.
- * @param url The URL to wrap.
- */
-export declare function hideLinkEmbed(url: URL): `<${string}>`;
-/**
- * Formats the content and the URL into a masked URL.
- * @param content The content to display.
- * @param url The URL the content links to.
- */
-export declare function hyperlink<C extends string>(content: C, url: URL): `[${C}](${string})`;
-/**
- * Formats the content and the URL into a masked URL.
- * @param content The content to display.
- * @param url The URL the content links to.
- */
-export declare function hyperlink<C extends string, U extends string>(content: C, url: U): `[${C}](${U})`;
-/**
- * Formats the content and the URL into a masked URL.
- * @param content The content to display.
- * @param url The URL the content links to.
- * @param title The title shown when hovering on the masked link.
- */
-export declare function hyperlink<C extends string, T extends string>(content: C, url: URL, title: T): `[${C}](${string} "${T}")`;
-/**
- * Formats the content and the URL into a masked URL.
- * @param content The content to display.
- * @param url The URL the content links to.
- * @param title The title shown when hovering on the masked link.
- */
-export declare function hyperlink<C extends string, U extends string, T extends string>(content: C, url: U, title: T): `[${C}](${U} "${T}")`;
-/**
- * Wraps the content inside spoiler (hidden text).
- * @param content The content to wrap.
- */
-export declare function spoiler<C extends string>(content: C): `||${C}||`;
-/**
- * Formats a user ID into a user mention.
- * @param userId The user ID to format.
- */
-export declare function userMention<C extends Snowflake>(userId: C): `<@${C}>`;
-/**
- * Formats a user ID into a member-nickname mention.
- * @param memberId The user ID to format.
- */
-export declare function memberNicknameMention<C extends Snowflake>(memberId: C): `<@!${C}>`;
-/**
- * Formats a channel ID into a channel mention.
- * @param channelId The channel ID to format.
- */
-export declare function channelMention<C extends Snowflake>(channelId: C): `<#${C}>`;
-/**
- * Formats a role ID into a role mention.
- * @param roleId The role ID to format.
- */
-export declare function roleMention<C extends Snowflake>(roleId: C): `<@&${C}>`;
-/**
- * Formats an emoji ID into a fully qualified emoji identifier
- * @param emojiId The emoji ID to format.
- */
-export declare function formatEmoji<C extends Snowflake>(emojiId: C, animated?: false): `<:_:${C}>`;
-/**
- * Formats an emoji ID into a fully qualified emoji identifier
- * @param emojiId The emoji ID to format.
- * @param animated Whether the emoji is animated or not. Defaults to `false`
- */
-export declare function formatEmoji<C extends Snowflake>(emojiId: C, animated?: true): `<a:_:${C}>`;
-/**
- * Formats a date into a short date-time string.
- * @param date The date to format, defaults to the current time.
- */
-export declare function time(date?: Date): `<t:${bigint}>`;
-/**
- * Formats a date given a format style.
- * @param date The date to format.
- * @param style The style to use.
- */
-export declare function time<S extends TimestampStylesString>(date: Date, style: S): `<t:${bigint}:${S}>`;
-/**
- * Formats the given timestamp into a short date-time string.
- * @param seconds The time to format, represents an UNIX timestamp in seconds.
- */
-export declare function time<C extends number>(seconds: C): `<t:${C}>`;
-/**
- * Formats the given timestamp into a short date-time string.
- * @param seconds The time to format, represents an UNIX timestamp in seconds.
- * @param style The style to use.
- */
-export declare function time<C extends number, S extends TimestampStylesString>(seconds: C, style: S): `<t:${C}:${S}>`;
-/**
- * The [message formatting timestamp styles](https://discord.com/developers/docs/reference#message-formatting-timestamp-styles) supported by Discord.
- */
-export declare const TimestampStyles: {
-    /**
-     * Short time format, consisting of hours and minutes, e.g. 16:20.
-     */
-    readonly ShortTime: "t";
-    /**
-     * Long time format, consisting of hours, minutes, and seconds, e.g. 16:20:30.
-     */
-    readonly LongTime: "T";
-    /**
-     * Short date format, consisting of day, month, and year, e.g. 20/04/2021.
-     */
-    readonly ShortDate: "d";
-    /**
-     * Long date format, consisting of day, month, and year, e.g. 20 April 2021.
-     */
-    readonly LongDate: "D";
-    /**
-     * Short date-time format, consisting of short date and short time formats, e.g. 20 April 2021 16:20.
-     */
-    readonly ShortDateTime: "f";
-    /**
-     * Long date-time format, consisting of long date and short time formats, e.g. Tuesday, 20 April 2021 16:20.
-     */
-    readonly LongDateTime: "F";
-    /**
-     * Relative time format, consisting of a relative duration format, e.g. 2 months ago.
-     */
-    readonly RelativeTime: "R";
-};
-/**
- * The possible values, see {@link TimestampStyles} for more information.
- */
-export declare type TimestampStylesString = typeof TimestampStyles[keyof typeof TimestampStyles];
-/**
- * An enum with all the available faces from Discord's native slash commands
- */
-export declare enum Faces {
-    /**
-     * ¯\\_(ツ)\\_/¯
-     */
-    Shrug = "\u00AF\\_(\u30C4)\\_/\u00AF",
-    /**
-     * (╯°□°）╯︵ ┻━┻
-     */
-    Tableflip = "(\u256F\u00B0\u25A1\u00B0\uFF09\u256F\uFE35 \u253B\u2501\u253B",
-    /**
-     * ┬─┬ ノ( ゜-゜ノ)
-     */
-    Unflip = "\u252C\u2500\u252C \u30CE( \u309C-\u309C\u30CE)"
-}
-//# sourceMappingURL=formatters.d.ts.map

package/dist/messages/formatters.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatters.d.ts","sourceRoot":"/","sources":["messages/formatters.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE/B;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC;AAE9E;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;AAKjH;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAEnE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAE7D;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAE7D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAEnE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAEtE;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAE5D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,CAEnE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;AAElE;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,MAAM,GAAG,CAAC;AAMvD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC,KAAK,MAAM,GAAG,CAAC;AAEvF;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;AAElG;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC3D,OAAO,EAAE,CAAC,EACV,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,CAAC,GACN,IAAI,CAAC,KAAK,MAAM,KAAK,CAAC,IAAI,CAAC;AAE9B;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC7E,OAAO,EAAE,CAAC,EACV,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,CAAC,GACN,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;AAMzB;;;GAGG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAEhE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC,GAAG,CAErE;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAElF;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,SAAS,EAAE,CAAC,GAAG,KAAK,CAAC,GAAG,CAE3E;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAEtE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;AAE5F;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC;AAW5F;;;GAGG;AACH,wBAAgB,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,MAAM,GAAG,CAAC;AAEnD;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,qBAAqB,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,MAAM,IAAI,CAAC,GAAG,CAAC;AAElG;;;GAGG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC;AAE/D;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,qBAAqB,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;AAS/G;;GAEG;AACH,eAAO,MAAM,eAAe;IAC3B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEM,CAAC;AAEX;;GAEG;AACH,oBAAY,qBAAqB,GAAG,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEzF;;GAEG;AACH,oBAAY,KAAK;IAChB;;OAEG;IACH,KAAK,gCAAiB;IAEtB;;OAEG;IACH,SAAS,mEAAiB;IAE1B;;OAEG;IACH,MAAM,oDAAiB;CACvB"}