@elara-services/tickets 3.1.0 → 3.1.3

package/.eslintrc.json

@@ -1,20 +1,20 @@
-{
-    "env": {
-        "node": true,
-        "commonjs": true,
-        "es2021": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 12
-    },
-    "rules": {
-        "no-extra-semi": 0,
-        "no-async-promise-executor": 0,
-        "no-warning-comments": "warn",
-        "no-empty": 0
-    },
-    "ignorePatterns": [
-        "*/*.json"
-    ]
-}
+{
+    "env": {
+        "node": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": 12
+    },
+    "rules": {
+        "no-extra-semi": 0,
+        "no-async-promise-executor": 0,
+        "no-warning-comments": "warn",
+        "no-empty": 0
+    },
+    "ignorePatterns": [
+        "*/*.json"
+    ]
+}

package/README.md

@@ -1,83 +1,87 @@
-# Elara Services: Tickets
-
-This is a customizable ticket system that uses interactions and discord.js
-
-
-# Getting Started
-```js
-const { Client } = require("discord.js"),
-        Tickets = require(`@elara-services/tickets`),
-        client = new Client({ intents: ["GUILDS"] }),
-        tickets = new Tickets({
-            client,
-            prefix: "support", // This is what is used for interactions (buttons) and the start of the channel name
-            encryptToken: "ASB!@#$%^&*(B", // This is to encrypt/decrypt the user IDs in the channel topic, to avoid non-staff from seeing who's ticket it is
-            debug: true, // Only use if you want errors logged.
-            appeals: { // OPTIONAL
-                enabled: true, // If the appeals server checks should be enabled.
-                mainserver: {
-                    id: "", // The main server's id 
-                    checkIfBanned: true // Check if the user is banned in the main server, if not they can't open a ticket.
-                },
-                embeds: {
-                    not_banned: {} // The embeds, content and components for the not banned message. 
-                }
-            },
-
-            modal: {
-                enabled: true, // If this form should be enabled  / shown 
-                title: "", // The top title of the modal / form 
-                questions: [
-                    {
-                        label: "[NAME]", // The name of this question
-                        style: 2, // 1 (SHORT ANSWER) | 2 (LONG ANSWER)
-                        placeholder: "", // The placeholder of the question
-                        value: "", // The default value for the question
-                        required: true, // If the question should be required
-                        min_length: 20, // The min length for the question response
-                        max_length: 4000, // The max length for the question response
-                    }
-                ]
-            },
-            webhook: {
-                id: "", // 'webhookId' support will be removed in the next major version
-                token: "", // 'webhookToken' support will be removed in the next major version
-                username: "Webhook Username Here", // 'webhookUsername' support will be removed in the next major version
-                avatar: "", // 'webhookAvatar' support will be removed in the next major version
-            },
-            support: {
-                canOnlyCloseTickets: true, // If 'true' only roles and users listed below can close tickets. (OR people with 'Manage Server' permission)
-                roles: [ // 'supportRoleIds' support will be removed in the next major version
-                    "123456789"
-                ],
-                users: [ // 'supportUserIds' support will be removed in the next major version
-                    "123456789"
-                ]
-            },
-            ticket: {
-                closeReason: true, // This will enforce users or support staff to provide a reason for closing the ticket
-                limitOnePerUser: true, // This will block users from creating more than one ticket.
-                category: "", // When tickets get created they get created in this category, (OPTIONAL) - Default is the category ID for the starter message's channel.
-                open: {
-                    content: "", // The content of the ticket message once it gets created, use "%user%" or "%server%" for the user mention or server name
-                    embeds: [], // View https://discord.com/developers/docs/resources/channel#embed-object 
-                }
-            }
-    })
-
-client.on("interactionCreate", (int) => tickets.run(int))
-
-client.on("ready", () => {
-    console.log(`Client is ready`);
-    // Use it as "node bot.js --starter" or just create a command in your bot to manage the starter message
-    if (process.argv.find(c => c === "--starter")) {
-        return tickets.starterMessage(`HELP OR SUPPORT CHANNEL ID HERE`, {
-            embeds: [
-                { title: "Support Tickets", description: `Click the button below to create a support ticket!`, color: 0xFF000 }
-            ]
-        })
-    }
-});
-
-client.login("BOT TOKEN HERE")
+# Elara Services: Tickets
+
+This is a customizable ticket system that uses interactions and discord.js
+
+
+# Getting Started
+```js
+const { Client } = require("discord.js"),
+        Tickets = require(`@elara-services/tickets`),
+        client = new Client({ intents: ["GUILDS"] }),
+        tickets = new Tickets({
+            client,
+            prefix: "support", // This is what is used for interactions (buttons) and the start of the channel name
+            encryptToken: "ASB!@#$%^&*(B", // This is to encrypt/decrypt the user IDs in the channel topic, to avoid non-staff from seeing who's ticket it is
+            debug: true, // Only use if you want errors logged.
+            appeals: { // [OPTIONAL]
+                enabled: true, // If the appeals server checks should be enabled.
+                mainserver: {
+                    id: "", // The main server's id 
+                    checkIfBanned: true // Check if the user is banned in the main server, if not they can't open a ticket.
+                },
+                embeds: {
+                    not_banned: {
+                        content: "",
+                        embeds: [], // View https://discord.com/developers/docs/resources/channel#embed-object 
+                        components: [] // View https://discord.com/developers/docs/interactions/message-components#what-is-a-component
+                    } // The embeds, content and components for the not banned message. 
+                }
+            },
+
+            modal: { // [OPTIONAL]
+                enabled: true, // If this form should be enabled  / shown 
+                title: "", // The top title of the modal / form 
+                questions: [
+                    {
+                        label: "[NAME]", // The name of this question
+                        style: 2, // 1 (SHORT ANSWER) | 2 (LONG ANSWER)
+                        placeholder: "", // The placeholder of the question
+                        value: "", // The default value for the question
+                        required: true, // If the question should be required
+                        min_length: 20, // The min length for the question response
+                        max_length: 4000, // The max length for the question response
+                    }
+                ]
+            },
+            webhook: { // [OPTIONAL]
+                id: "", // The webhook ID for this ticket's open and closed logs. 
+                token: "", // The webhook Token for this ticket's open and closed logs.
+                username: "Webhook Username Here", // The webhook username for this ticket's logs.
+                avatar: "", // The webhook avatar for this ticket's logs.
+            },
+            support: { // [OPTIONAL]
+                canOnlyCloseTickets: true, // If 'true' only roles and users listed below can close tickets. (OR people with 'Manage Server' permission)
+                roles: [ // The role ids for the 'support' members
+                    "123456789"
+                ],
+                users: [ // The user ids for the 'support' users
+                    "123456789"
+                ]
+            },
+            ticket: { // [OPTIONAL]
+                closeReason: true, // This will enforce users or support staff to provide a reason for closing the ticket
+                limitOnePerUser: true, // This will block users from creating more than one ticket.
+                category: "", // When tickets get created they get created in this category, (OPTIONAL) - Default is the category ID for the starter message's channel.
+                open: {
+                    content: "", // The content of the ticket message once it gets created, use "%user%" or "%server%" for the user mention or server name
+                    embeds: [], // View https://discord.com/developers/docs/resources/channel#embed-object 
+                }
+            }
+    })
+
+client.on("interactionCreate", (int) => tickets.run(int))
+
+client.on("ready", () => {
+    console.log(`Client is ready`);
+    // Use it as "node bot.js --starter" or just create a command in your bot to manage the starter message
+    if (process.argv.find(c => c === "--starter")) {
+        return tickets.starterMessage(`HELP OR SUPPORT CHANNEL ID HERE`, {
+            embeds: [
+                { title: "Support Tickets", description: `Click the button below to create a support ticket!`, color: 0xFF000 }
+            ]
+        })
+    }
+});
+
+client.login("BOT TOKEN HERE")
 ```

package/index.d.ts

@@ -1,83 +1,89 @@
-declare module "@elara-services/tickets" {
-    
-    import { Client, MessageOptions, GuildMember, Guild, User, TextBasedChannel, Message, Interaction, ModalOptions } from "discord.js";
-    import Webhook from "discord-hook";
-
-    export interface TicketOptions {
-        client: Client;
-        prefix: string;
-        debug?: boolean;
-        encryptToken: string;
-        appeals?: {
-            enabled: boolean;
-            sendBanResults?: boolean;
-            mainserver: {
-                id: string;
-                checkIfBanned: boolean;
-            };
-            embeds?: {
-                not_banned: Pick<MessageOptions, "content" | "embeds" | "components">
-            }
-        };
-        modal?: {
-            enabled: boolean;
-            title?: string;
-            questions?: {
-                label: string;
-                style: 1 | 2;
-                placeholder?: string;
-                value?: string;
-                required?: boolean;
-                min_length?: number;
-                max_length?: number;
-            }[]
-        };
-        webhook?: {
-            id?: string;
-            token?: string;
-            username?: string;
-            avatar?: string
-        };
-        support?: {
-            roles?: string[];
-            users?: string[];
-            canOnlyCloseTickets?: boolean;
-            ignore?: string[]
-        };
-        ticket?: {
-            category?: string;
-            closeReason?: boolean;
-            limitOnePerUser?: boolean;
-            open?: Pick<MessageOptions, "content" | "embeds">
-        }
-
-        /** @deprecated Use 'ticket.category', 'ticketCategory' will be removed in the next major version */
-        ticketCategory?: string;
-        /** @deprecated Use 'ticket.open', 'ticketOpen' will be removed in the next major version */
-        ticketOpen?: Pick<MessageOptions, "content" | "embeds">
-    }
-
-    class Tickets {
-        public constructor(options: TicketOptions);
-        public options: TicketOptions;
-        public prefix: string;
-        public webhook(): typeof Webhook.prototype;
-        public button(options: { style: 1 | 2 | 3 | 4 | 5 | number, id?: string, label?: string, emoji?: { name?: string, id?: string } }): { type: number, custom_id: string, style: number, label?: string, emoji?: { name?: string, id?: string } }
-    
-        public fetchMessages(channel: TextBasedChannel, limit?: number, before?: string, after?: string, around?: string): Promise<Array<Message>>
-        public displayMessages(channel: TextBasedChannel, messages: Array<Message>, ticketID: string, type: string): string;
-        public closeTicket(options: {
-            member: GuildMember,
-            guild: Guild, 
-            user: User,
-            messages: Array<Message>,
-            channel: TextBasedChannel
-        }): Promise<void>;
-
-        public code(id: string, type: string): string;
-        public run(int: Interaction): Promise<void>;
-        public starterMessage(channelId: string, options?: Pick<MessageOptions, "embeds" | "content" | "components" | "attachments">): Promise<void>;
-    };
-
-    export = Tickets;
+declare module "@elara-services/tickets" {
+    
+    import { Client, MessageOptions, GuildMember, Guild, User, TextBasedChannel, Message, Interaction, ModalOptions } from "discord.js";
+    import Webhook from "discord-hook";
+
+    export interface TicketOptions {
+        client: Client;
+        prefix: string;
+        debug?: boolean;
+        encryptToken: string;
+        appeals?: {
+            enabled: boolean;
+            sendBanResults?: boolean;
+            mainserver: {
+                id: string;
+                checkIfBanned: boolean;
+            };
+            embeds?: {
+                not_banned: Pick<MessageOptions, "content" | "embeds" | "components">
+            }
+        };
+        modal?: {
+            enabled: boolean;
+            title?: string;
+            questions?: {
+                label: string;
+                style: 1 | 2;
+                placeholder?: string;
+                value?: string;
+                required?: boolean;
+                min_length?: number;
+                max_length?: number;
+            }[]
+        };
+        webhook?: {
+            id?: string;
+            token?: string;
+            username?: string;
+            avatar?: string
+        };
+        support?: {
+            roles?: string[];
+            users?: string[];
+            canOnlyCloseTickets?: boolean;
+            ignore?: string[]
+        };
+        ticket?: {
+            category?: string;
+            closeReason?: boolean;
+            limitOnePerUser?: boolean;
+            open?: Pick<MessageOptions, "content" | "embeds">
+        }
+
+        /** @deprecated Use 'ticket.category', 'ticketCategory' will be removed in the next major version */
+        ticketCategory?: string;
+        /** @deprecated Use 'ticket.open', 'ticketOpen' will be removed in the next major version */
+        ticketOpen?: Pick<MessageOptions, "content" | "embeds">
+
+        // reports?: {
+        //     enabled: boolean;
+        //     shouldBeTicket?: boolean;
+            
+        // }
+    }
+
+    class Tickets {
+        public constructor(options: TicketOptions);
+        public options: TicketOptions;
+        public prefix: string;
+        public webhook(): typeof Webhook.prototype;
+        public button(options: { style: 1 | 2 | 3 | 4 | 5 | number, id?: string, label?: string, emoji?: { name?: string, id?: string } }): { type: number, custom_id: string, style: number, label?: string, emoji?: { name?: string, id?: string } }
+    
+        public fetchMessages(channel: TextBasedChannel, limit?: number, before?: string, after?: string, around?: string): Promise<Array<Message>>
+        public displayMessages(channel: TextBasedChannel, messages: Array<Message>, ticketID: string, type: string): string;
+        public closeTicket(options: {
+            member: GuildMember,
+            guild: Guild, 
+            user: User,
+            messages: Array<Message>,
+            channel: TextBasedChannel
+        }): Promise<void>;
+
+        public code(id: string, type: string): string;
+        public run(int: Interaction): Promise<void>;
+        public starterMessage(channelId: string, options?: Pick<MessageOptions, "embeds" | "content" | "components" | "attachments">): Promise<void>;
+    };
+
+    export = Tickets;
 }

package/index.js

@@ -1,12 +1,12 @@
-const pack = require("./package.json");
-
-module.exports = (() => {
-    let version = null;
-    try { version = require("discord.js").version; } catch {}
-    if (!version) throw new Error(`[${pack.name}, v${pack.version}]: I was unable to find the discord.js version you're using.`);
-    let [ major ] = version.split(".");
-    if (major === "14") return require("./lib/v14");
-    if (major === "13") return require("./lib/v13");
-    if ([ "12", "11" ].includes(major)) throw new Error(`[${pack.name}, v${pack.version}]: The discord.js version you're using is outdated and unsupported, please update to v13+`)
-    throw new Error(`[${pack.name}, v${pack.version}]: The discord.js version you're using isn't supported by this package. (currently supported: v13, v14)`);
+const pack = require("./package.json");
+
+module.exports = (() => {
+    let version = null;
+    try { version = require("discord.js").version; } catch {}
+    if (!version) throw new Error(`[${pack.name}, v${pack.version}]: I was unable to find the discord.js version you're using.`);
+    let [ major ] = version.split(".");
+    if (major === "14") return require("./lib/v14");
+    if (major === "13") return require("./lib/v13");
+    if ([ "12", "11" ].includes(major)) throw new Error(`[${pack.name}, v${pack.version}]: The discord.js version you're using is outdated and unsupported, please update to v13+`)
+    throw new Error(`[${pack.name}, v${pack.version}]: The discord.js version you're using isn't supported by this package. (currently supported: v13, v14)`);
 })();

package/lib/base.js

@@ -1,80 +1,80 @@
-const { getWebhookInfo, displayMessages, de, webhook } = require("./util"),
-      { Interactions: { button, modal } } = require("@elara-services/packages"),
-      { WebhookClient } = require("discord.js");
-
-module.exports = class Tickets {
-    constructor(options) {
-        if (typeof options !== "object") throw new Error(`You didn't provide any data in the constructor, fill it out!`);
-        if (!("client" in options) || !("prefix" in options) || !("encryptToken" in options)) throw new Error(`You forgot to fill out either 'client', 'prefix' or 'encryptToken'`)
-        this.options = options;
-    }
-    get prefix() { return `system:ticket:${this.options.prefix}`; };
-    get webhookOptions() { return getWebhookInfo(this.options); };
-    get getSupportIds() {
-        return {
-            roles: this.options.support?.roles || [],
-            users: this.options.support?.users || []
-        }
-    }
-
-    /** @private */
-    _debug(...args) {
-        if (this.options?.debug) console.log(...args);
-        return null;
-    }
-
-    button(options = { style: 3, label: "Create Ticket", emoji: { name: "📩" } }) {
-        return button({ id: options?.id || this.prefix, style: options.style || 3, title: options.label, emoji: options.emoji });
-    };
-
-    /**
-     * @param {object} options 
-     * @param {string} [options.title] The title of the modal submit form 
-     * @param {import("@elara-services/packages").Modal['components']} [options.components]
-     */
-    modal(options = { title: "", components: [] }) {
-        return modal({ id: `${this.prefix}:modal_submit`, title: options?.title || "Create Ticket", components: options?.components?.length >= 1 ? options.components : [{ type: 1, components: [{ type: 4, min_length: 10, max_length: 4000, custom_id: "message", label: "Content", style: 2, placeholder: "What's the ticket about?", required: true }] }] })
-    };
-
-    async closeTicket({ member, messages, channel, guild, user, reason } = {}) {
-        const { id, token, username, avatar: avatarURL } = this.webhookOptions;
-        if (!id || !token) return;
-        let embeds = [
-            {
-                author: { name: guild.name, icon_url: guild.iconURL({ dynamic: true }) },
-                title: "Ticket: Closed",
-                description: `${de.user}User: ${user.toString()} \`@${user.tag}\` (${user.id})\n${de.user}Closed By: ${member.toString()} (${member.id})\n${de.channel}Channel: \`#${channel.name}\` (${channel.id})`,
-                color: 0xFF0000,
-                fields: reason ? [ { name: "Close Reason", value: reason?.slice?.(0, 1024) ?? "No Reason Provided" } ] : undefined,
-                timestamp: new Date(),
-                footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` },
-            }
-        ];
-        new WebhookClient({ id, token })
-            .send({
-                username, avatarURL,
-                embeds,
-                files: [{ name: "transcript.txt", attachment: Buffer.from(displayMessages(channel, messages.reverse(), channel.name.split("-")[1], this.options.prefix)) }]
-            })
-            .then(m => {
-                let components = [{ type: 2, style: 5, label: "Transcript", emoji: { id: "792290922749624320" }, url: `https://my.elara.services/tickets?url=${Array.isArray(m.attachments) ? m.attachments?.[0]?.url : m.attachments?.first?.()?.url ?? "URL_NOT_FOUND"}` }];
-                embeds[0].description += `\n${de.transcript} Transcript: [View here](${components[0].url})`
-                webhook(this.webhookOptions)
-                    .embeds(embeds)
-                    .button({ type: 1, components })
-                    .edit(m.id)
-                    .catch(e => this._debug(e));
-                if (user) user.send({
-                    embeds: [{
-                        author: { name: guild.name, icon_url: guild.iconURL({ dynamic: true }) },
-                        title: `Ticket: Closed`,
-                        color: 0xFF0000,
-                        fields: reason ? [ { name: "Close Reason", value: reason?.slice?.(0, 1024) ?? "No Reason Provided" } ] : undefined,
-                        timestamp: new Date(),
-                        footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` }
-                    }],
-                    components: [{ type: 1, components }]
-                }).catch(e => this._debug(e));
-            }).catch(e => this._debug(e));
-    };
+const { getWebhookInfo, displayMessages, de, webhook } = require("./util"),
+      { Interactions: { button, modal } } = require("@elara-services/packages"),
+      { WebhookClient } = require("discord.js");
+
+module.exports = class Tickets {
+    constructor(options) {
+        if (typeof options !== "object") throw new Error(`You didn't provide any data in the constructor, fill it out!`);
+        if (!("client" in options) || !("prefix" in options) || !("encryptToken" in options)) throw new Error(`You forgot to fill out either 'client', 'prefix' or 'encryptToken'`)
+        this.options = options;
+    }
+    get prefix() { return `system:ticket:${this.options.prefix}`; };
+    get webhookOptions() { return getWebhookInfo(this.options); };
+    get getSupportIds() {
+        return {
+            roles: this.options.support?.roles || [],
+            users: this.options.support?.users || []
+        }
+    }
+
+    /** @private */
+    _debug(...args) {
+        if (this.options?.debug) console.log(...args);
+        return null;
+    }
+
+    button(options = { style: 3, label: "Create Ticket", emoji: { name: "📩" } }) {
+        return button({ id: options?.id || this.prefix, style: options.style || 3, title: options.label, emoji: options.emoji });
+    };
+
+    /**
+     * @param {object} options 
+     * @param {string} [options.title] The title of the modal submit form 
+     * @param {import("@elara-services/packages").Modal['components']} [options.components]
+     */
+    modal(options = { title: "", components: [] }) {
+        return modal({ id: `${this.prefix}:modal_submit`, title: options?.title || "Create Ticket", components: options?.components?.length >= 1 ? options.components : [{ type: 1, components: [{ type: 4, min_length: 10, max_length: 4000, custom_id: "message", label: "Content", style: 2, placeholder: "What's the ticket about?", required: true }] }] })
+    };
+
+    async closeTicket({ member, messages, channel, guild, user, reason } = {}) {
+        const { id, token, username, avatar: avatarURL } = this.webhookOptions;
+        if (!id || !token) return;
+        let embeds = [
+            {
+                author: { name: guild.name, icon_url: guild.iconURL({ dynamic: true }) },
+                title: "Ticket: Closed",
+                description: `${de.user}User: ${user.toString()} \`@${user.tag}\` (${user.id})\n${de.user}Closed By: ${member.toString()} (${member.id})\n${de.channel}Channel: \`#${channel.name}\` (${channel.id})`,
+                color: 0xFF0000,
+                fields: reason ? [ { name: "Close Reason", value: reason?.slice?.(0, 1024) ?? "No Reason Provided" } ] : undefined,
+                timestamp: new Date(),
+                footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` },
+            }
+        ];
+        new WebhookClient({ id, token })
+            .send({
+                username, avatarURL,
+                embeds,
+                files: [{ name: "transcript.txt", attachment: Buffer.from(displayMessages(channel, messages.reverse(), channel.name.split("-")[1], this.options.prefix)) }]
+            })
+            .then(m => {
+                let components = [{ type: 2, style: 5, label: "Transcript", emoji: { id: "792290922749624320" }, url: `https://view.elara.workers.dev/tickets?url=${Array.isArray(m.attachments) ? m.attachments?.[0]?.url : m.attachments?.first?.()?.url ?? "URL_NOT_FOUND"}` }];
+                embeds[0].description += `\n${de.transcript} Transcript: [View here](${components[0].url})`
+                webhook(this.webhookOptions)
+                    .embeds(embeds)
+                    .button({ type: 1, components })
+                    .edit(m.id)
+                    .catch(e => this._debug(e));
+                if (user) user.send({
+                    embeds: [{
+                        author: { name: guild.name, icon_url: guild.iconURL({ dynamic: true }) },
+                        title: `Ticket: Closed`,
+                        color: 0xFF0000,
+                        fields: reason ? [ { name: "Close Reason", value: reason?.slice?.(0, 1024) ?? "No Reason Provided" } ] : undefined,
+                        timestamp: new Date(),
+                        footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` }
+                    }],
+                    components: [{ type: 1, components }]
+                }).catch(e => this._debug(e));
+            }).catch(e => this._debug(e));
+    };
 };