discord-user-bots/src/client/constructs.js

A library that allows you to use the full potential of Discords API to create and operate powerful user bots

/**
 *
 *  ## OVERVIEW
 *
 *  Specifies function option objects
 *  Specifies general classes that parse data into a packet object.
 *
 *  ## WHEN CONTRIBUTING:
 *
 *  Make sure variable names are capitalized.
 *  Options have the "Opts" suffix.
 *
 */

const fs = require("node:fs");
const path = require("node:path");
const FormData = require("form-data");

function removeNulls(obj) {
    for (const key in obj) {
        if (obj[key] === null || obj[key] === undefined) {
            delete obj[key];
        }
    }
}

const MentionsLimiterOpts = {
    allowUsers: true,
    allowRoles: true,
    allowEveryone: true,
    allowRepliedUser: true,
};
class MentionsLimiter {
    /**
     * Mentions object when dealing with messages
     * @param {MentionsLimiterOpts} opts Defaults/options
     */
    constructor(opts = MentionsLimiterOpts) {
        const options = {
            ...MentionsLimiterOpts,
            ...opts,
        };
        this.parse = [];
        this.replied_user = options.allowRepliedUser;

        if (options.allowUsers) this.parse.push("users");
        if (options.allowRoles) this.parse.push("roles");
        if (options.allowEveryone) this.parse.push("everyone");
    }
}

const CustomStatusOpts = {
    text: null,
    emoji: null,
    expireAt: null,
};
class CustomStatus {
    /**
     * Custom status object and logic
     * @param {CustomStatusOpts} opts Defaults/options
     */
    constructor(opts = CustomStatusOpts) {
        const options = {
            ...CustomStatusOpts,
            ...opts,
        };
        this.contents = {
            expires_at: options.expireAt,
            text: options.text,
            emoji_name: options.emoji,
        };

        removeNulls(this.contents);
        if (Object.keys(this.contents).length === 0) this.contents = null;
    }
}

const ProfileSettingsOpts = {
    bio: null,
    bannerColor: null,
    ignoreNulls: true,
};
class SetProfile {
    constructor(opts = ProfileSettingsOpts) {
        const options = {
            ...ProfileSettingsOpts,
            ...opts,
        };
        this.contents = {
            accent_color: options.bannerColor,
            bio: options.bio,
        };
        if (options.ignoreNulls) {
            removeNulls(this.contents);
        }
    }
}

const SendMessageOpts = {
    content: "",
    reply: null,
    tts: false,
    embeds: [],
    allowed_mentions: MentionsLimiterOpts,
    components: null,
    stickers: [],
    attachments: [],
};
class SendMessage {
    /**
     * Message send class for sending messages
     * @param {SendMessageOpts} opts Defaults/options
     */
    constructor(opts = SendMessageOpts) {
        const options = {
            ...SendMessageOpts,
            ...opts,
        };

        const formData = new FormData();

        const attachments = [];
        if (Array.isArray(options.attachments) && options.attachments.length > 0) {
            this.isMultipartFormData = true;

            options.attachments.forEach((item, index) => {
                if (!item) return;

                switch (typeof item) {
                    case "string": {
                        item = {
                            path: item,
                        };
                    }

                    case "object": {
                        if (!item.path) return;

                        const filename = item.name || path.basename(item.path) || `file-${index}`;
                        formData.append(
                            `files[${index}]`,
                            fs.createReadStream(item.path),
                            filename
                        );
                        attachments.push({
                            id: index,
                            filename,
                            description: item.description || filename,
                        });
                        break;
                    }
                }
            });

            options.attachments = attachments;
        }

        this.content = {
            content: options.content,
            tts: options.tts,
            embeds: options.embeds,
            allowed_mentions: new MentionsLimiter(options.allowed_mentions),
            message_reference:
                options.reply !== null
                    ? {
                          message_id: options.reply,
                      }
                    : null,
            components: null,
            sticker_ids: options.stickers,
            ...(attachments.length > 0 ? { attachments } : {}),
        };

        if (this.isMultipartFormData) {
            formData.append("payload_json", JSON.stringify(this.content));
            this.content = formData;
        }
    }
}

module.exports = {
    InviteRegex: /(?<=\W(?:(?:https?:\/\/)?discord\.(?:gg|com)\/))[a-zA-Z-_0-9]{3,20}(?=\b)/i,
    FetchRequestOpts: {
        method: "GET",
        body: null,
        secure: true,
    },
    CreateInviteOpts: {
        validate: null,
        max_age: 0,
        max_uses: 0,
        target_user_id: null,
        target_type: null,
        temporary: false,
    },
    BotConfigOpts: {
        api: "9",
        wsurl: "wss://gateway.discord.gg",
        url: "https://discord.com",
        typinginterval: 1000,
        proxy: undefined,
        headless: false,
    },
    RequestGuildMembers: {
        guild_id: null,
        query: null,
        limit: null,
        presences: null,
        user_ids: null,
    },
    MentionsLimiterOpts,
    CustomStatusOpts,
    ProfileSettingsOpts,
    SendMessageOpts,
    MentionsLimiter,
    CustomStatus,
    SetProfile,
    SendMessage,
};