@elara-services/tickets 2.0.4 → 2.1.2

package/README.md

@@ -51,6 +51,7 @@ const { Client } = require("discord.js"),
             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"
             ],

package/index.d.ts

@@ -12,7 +12,7 @@ declare module "@elara-services/tickets" {
         ticketOpen?: Pick<MessageOptions, "content" | "embeds">
         appeals?: {
             enabled: boolean;
-            mainServer: {
+            mainserver: {
                 id: string;
                 checkIfBanned: boolean;
             };
@@ -42,6 +42,7 @@ declare module "@elara-services/tickets" {
         support?: {
             roles?: string[];
             users?: string[];
+            canOnlyCloseTickets?: boolean;
         };
 
         /** @deprecated Use 'webhook.id' */

package/index.js

@@ -1,20 +1,20 @@
 const { Collection, WebhookClient, MessageEmbed } = require("discord.js"),
-    { encrypt, decrypt } = require("aes256"),
-    { generate } = require("shortid"),
-    { Interactions: { button, modal } } = require("@elara-services/packages"),
-      Webhook = require("discord-hook"),
-      de = {
-        user: "<:Members:860931214232125450>",
-        channel: "<:Channel:841654412509839390>",
-        transcript: "<:Log:792290922749624320>"
-      }
+      { generate } = require("shortid"),
+      { Interactions: { button, modal }, AES } = require("@elara-services/packages"),
+        Webhook = require("discord-hook"),
+        de = {
+            user: "<:Members:860931214232125450>",
+            channel: "<:Channel:841654412509839390>",
+            transcript: "<:Log:792290922749624320>"
+        };
 
 module.exports = class Tickets {
-    constructor(options) {
+    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}`; };
 
     /** @private */
@@ -26,6 +26,7 @@ module.exports = class Tickets {
             avatar: this.options.webhook?.avatar || this.options.webhookAvatar || "https://cdn.discordapp.com/emojis/818757771310792704.png?v=1"
         }
     }
+    
     webhook() {
         const { id, token, username, avatar } = this.webhookOptions;
         return new Webhook(`https://discord.com/api/webhooks/${id}/${token}`, { username, avatar_url: avatar });
@@ -38,7 +39,6 @@ module.exports = class Tickets {
         if (int?.isButton?.() || int?.isModalSubmit()) {
             let { guild, channel, member, customId } = int,
                 category = guild?.channels?.resolve?.(this.options.ticketCategory || channel?.parentId);
-
             if (!guild || !guild.available || !channel || !member || !category) return;
 
             /**
@@ -53,21 +53,21 @@ module.exports = class Tickets {
             };
             switch (customId) {
                 case this.prefix: {
-                    if (this.options.modal?.enabled) {
-                        return int.showModal(this.modal({
-                            title: this.options.modal.title,
-                            components: this.options.modal.questions?.length >= 1 ?
-                                this.options.modal.questions.slice(0, 5).map(c => ({ type: 1, components: [{ min_length: c.min_length || 10, max_length: c.max_length || 4000, type: 4, style: c.style || 2, label: c.label, value: c.value, placeholder: c.placeholder, required: c.required, custom_id: c.label || `random_${Math.floor(Math.random() * 10000)}` }] })) :
-                                []
-                        })).catch(e => this._debug(e));
-                    }
+                    if (this.options.modal?.enabled) return int.showModal(this.modal({ title: this.options.modal.title, components: this.options.modal.questions?.length >= 1 ? this.options.modal.questions.slice(0, 5).map(c => ({ type: 1, components: [{ min_length: c.min_length || 10, max_length: c.max_length || 4000, type: 4, style: c.style || 2, label: c.label, value: c.value, placeholder: c.placeholder, required: c.required, custom_id: c.label || `random_${Math.floor(Math.random() * 10000)}` }] })) : [] })).catch(e => this._debug(e));
                     return this.handleCreate({ guild, member, category, send })
                 };
 
-                case `${this.prefix}:close`: return send({ ephemeral: true, content: `🤔 Are you sure you want to close this ticket?`, components: [{ type: 1, components: [{ type: 2, custom_id: `${this.prefix}:close:confirm:${this.code(channel.topic?.split?.("ID: ")?.[1])}`, label: "Yes close the ticket", style: 4, emoji: { id: "807031399563264030" } }] }] })
+                case `${this.prefix}:close`: {
+                    if (this.options.support?.canOnlyCloseTickets && !member.permissions.has("MANAGE_GUILD")) {
+                        let [ support, staffOnly ] = [ this.getSupportIds(), () => send({ ephemeral: true, embeds: [ { author: { name: `Only support staff can close tickets`, iconURL: "https://cdn.discordapp.com/emojis/781955502035697745.gif" }, color: 0xFF0000 } ] })  ];
+                        if (!support.users?.includes?.(member.id)) return staffOnly();
+                        if (support.roles?.length && !support.roles.some(c => member.roles.cache.has(c))) return staffOnly()
+                    }
+                    return send({ ephemeral: true, content: `🤔 Are you sure you want to close this ticket?`, components: [{ type: 1, components: [{ type: 2, custom_id: `${this.prefix}:close:confirm:${this.code(channel.topic?.split?.("ID: ")?.[1])}`, label: "Yes close the ticket", style: 4, emoji: { id: "807031399563264030" } }] }] })
+                }
 
                 case `${this.prefix}:modal_submit`: {
-                    let [embed, fields, split] = [new MessageEmbed().setColor("ORANGE"), [], false];
+                    let [ embed, fields, split ] = [ new MessageEmbed().setColor("ORANGE").setTimestamp().setTitle(`For Responses`).setFooter({ text: `ID: ${member.id}` }).setAuthor({ name: member.user.username, iconURL: member.user.displayAvatarURL({ dynamic: true }) }),  [], false];
                     for (const c of int.fields.components) {
                         for (const cc of c.components) {
                             if (cc.value && cc.customId) {
@@ -79,31 +79,23 @@ module.exports = class Tickets {
                     }
                     if (embed.length >= 6000 || split) {
                         return this.handleCreate({ guild, member, category, send, embeds: fields.map((v, i) => ({
-                            title: `Form Response: ${v.name}`,
-                            color: embed.color,
-                            description: v.value,
+                            title: `Form Response: ${v.name}`, color: embed.color, description: v.value,
                             author: i === 0 ? { name: member.user.username, iconURL: member.user.displayAvatarURL({ dynamic: true }) } : undefined,
                             timestamp: fields.length - 1 === i ? new Date() : undefined,
                             footer: fields.length - 1 === i ? { text: `ID: ${member.id}` } : undefined
                         })) })
                     };
-                    
-                    return this.handleCreate({ guild, member, category, send, embeds: [
-                        embed
-                            .setTitle(`Form Responses`)
-                            .setTimestamp()
-                            .setAuthor({ name: member.user.username, iconURL: member.user.displayAvatarURL({ dynamic: true }) })
-                            .setFooter({ text: `ID: ${member.id}` })
-                    ]})
+                    return this.handleCreate({ guild, member, category, send, embeds: [ embed ]})
                 }
             };
             if (customId.startsWith(`${this.prefix}:close:confirm`)) {
-                let user = this.options.client.users.resolve(customId.split("close:confirm:")[1]) ?? await this.options.client.users.fetch(customId.split("close:confirm:")[1]).catch(() => null);
-                if (!user) return send({ content: `❌ I was unable to fetch the user that opened the ticket.`, ephemeral: true })
+                await send({ ephemeral: true }, true);
+                let user = await this.options.client.users.fetch(customId.split("close:confirm:")[1]).catch(() => null);
+                if (!user) return send({ content: `❌ I was unable to fetch the user that opened the ticket.` })
                 let messages = await this.fetchMessages(channel, 5000);
-                if (!messages || !messages.length) return send({ ephemeral: true, content: `❌ I was unable to close the ticket, I couldn't fetch the messages in this channel.` })
+                if (!messages?.length) return send({ content: `❌ I was unable to close the ticket, I couldn't fetch the messages in this channel.` })
                 let closed = await channel.delete(`${member.user.tag} (${member.id}) closed the ticket.`).catch(e => this._debug(e));
-                if (!closed) return send({ ephemeral: true, content: `${emojis.x} I was unable to delete the channel & close the ticket.` })
+                if (!closed) return send({ content: `❌ I was unable to delete the channel & close the ticket.` })
                 return this.closeTicket({ channel, guild, user, member, messages });
             }
         };
@@ -111,10 +103,15 @@ module.exports = class Tickets {
 
     /** @private */
     async handleCreate({ guild, member, category, send, embeds = [] } = {}) {
-        let [support, supportUsers, supportIds] = [[], [], this.getSupportIds()];
+        await send({ ephemeral: true }, true);
+        let [ supportIds, permissions, allow, { appeals } ] = [
+            this.getSupportIds(), [],
+            ["ADD_REACTIONS", "ATTACH_FILES", "CREATE_INSTANT_INVITE", "EMBED_LINKS", "READ_MESSAGE_HISTORY", "VIEW_CHANNEL", "USE_EXTERNAL_EMOJIS", "SEND_MESSAGES"],
+            this.options ?? {}
+        ];
         if (supportIds.roles.length) for (const sup of supportIds.roles) {
             let role = guild.roles.resolve(sup);
-            if (role) support.push(sup);
+            if (role) permissions.push({ type: "role", id: sup, allow });
         };
 
         if (supportIds.users.length) for (const uId of supportIds.users) {
@@ -122,11 +119,9 @@ module.exports = class Tickets {
                 if (e?.stack?.includes?.("Unknown Member")) this.options.support.users = this.options.support.users.filter(c => c !== uId);
                 return this._debug(e);
             });
-            if (member) supportUsers.push(uId);
+            if (member) permissions.push({ type: "member", id: uId, allow });
         }
-        await send({ ephemeral: true }, true);
-        if (this.options.appeals?.enabled) {
-            let appeals = this.options.appeals;
+        if (appeals?.enabled) {
             if (appeals.mainserver?.id && appeals.mainserver.checkIfBanned) {
                 let server = this.options.client.guilds.resolve(appeals.mainserver.id);
                 if (server?.available) {
@@ -149,14 +144,6 @@ module.exports = class Tickets {
                 }
             }
         }
-        let [permissions, allow] = [
-            [],
-            ["ADD_REACTIONS", "ATTACH_FILES", "CREATE_INSTANT_INVITE", "EMBED_LINKS", "READ_MESSAGE_HISTORY", "VIEW_CHANNEL", "USE_EXTERNAL_EMOJIS", "SEND_MESSAGES"]
-        ];
-        if (support.length) for (const sup of support) permissions.push({ type: "role", id: sup, allow });
-        if (supportUsers.length) for (const user of supportUsers) permissions.push({ type: "member", id: user, allow });
-
-        /** @type {import("discord.js").TextChannel} */
         let channel = await guild.channels.create(`${this.options.prefix}-${generate().slice(0, 5).replace(/-|_/g, "")}`, {
             type: "GUILD_TEXT", parent: category, reason: `Ticket created by: @${member.user.tag} (${member.id})`,
             topic: `ID: ${this.code(member.id, "e")}`,
@@ -167,7 +154,7 @@ module.exports = class Tickets {
                 ...permissions
             ]
         }).catch(e => this._debug(e));
-        if (!channel) return send({ content: `${emojis.x} I was unable to create the ticket channel, if this keeps happening contact one of the staff members via their DMs!` });
+        if (!channel) return send({ content: `❌ I was unable to create the ticket channel, if this keeps happening contact one of the staff members via their DMs!` });
         let msg = await channel.send({
             content: this.options.ticketOpen?.content?.replace?.(/%user%/gi, member.user.toString())?.replace?.(/%server%/gi, guild.name) || `${member.user.toString()} 👋 Hello, please explain what you need help with.`,
             embeds: this.options.ticketOpen?.embeds || [{
@@ -191,24 +178,13 @@ module.exports = class Tickets {
                 footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` },
             }).send().catch(e => this._debug(e));
         return send({
-            embeds: [
-                {
-                    author: { name: `Ticket Created!`, icon_url: `https://cdn.discordapp.com/emojis/476629550797684736.gif` },
-                    description: channel.toString(),
-                    color: 0xFF000
-                }
-            ],
+            embeds: [ { author: { name: `Ticket Created!`, icon_url: `https://cdn.discordapp.com/emojis/476629550797684736.gif` }, description: channel.toString(), color: 0xFF000 } ],
             components: [ { type: 1, components: [ button({ title: "Go to ticket", url: msg.url }) ] } ]
         })
     }
 
     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
-        });
+        return button({ id: options?.id || this.prefix, style: options.style || 3, title: options.label, emoji: options.emoji });
     };
 
     /**
@@ -217,17 +193,7 @@ module.exports = class Tickets {
      * @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 }
-                    ]
-                }
-            ]
-        })
+        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 starterMessage(channelId, options) {
@@ -235,20 +201,16 @@ module.exports = class Tickets {
         if (!channel) return Promise.reject(`No channel found for: ${channelId}`);
         if (!channel.isText()) return Promise.reject(`The channel ID provided isn't a text-based-channel`);
         if (!channel.permissionsFor?.(this.options.client.user.id)?.has?.(["VIEW_CHANNEL", "SEND_MESSAGES", "EMBED_LINKS", "ATTACH_FILES", "READ_MESSAGE_HISTORY"])) return Promise.reject(`I'm missing permissions in ${channel.name} (${channelId})`);
-        return channel.send({
-            content: options?.content,
-            files: options?.attachments,
-            embeds: options?.embeds,
-            components: options?.components || [{ type: 1, components: [this.button()] }]
-        })
+        return channel.send({ content: options?.content, files: options?.attachments, embeds: options?.embeds, components: options?.components || [{ type: 1, components: [this.button()] }] })
             .then(() => console.log(`Sent the starter message in ${channel.name} (${channel.id})`))
     };
 
     code(id, type = "d") {
         try {
+            const aes = new AES(this.options.encryptToken);
             switch (type) {
-                case "e": return encrypt(this.options.encryptToken, id);
-                case "d": return decrypt(this.options.encryptToken, id);
+                case "e": return aes.encrypt(id);
+                case "d": return aes.decrypt(id);
             }
         } catch {
             return id;
@@ -273,13 +235,6 @@ module.exports = class Tickets {
         return [...(await channel.messages.fetch({ limit, before, after, around }).catch(() => new Collection())).values()];
     };
 
-    /**
-     * @param {import("discord.js").TextBasedChannel} channel 
-     * @param {import("discord.js").Message[]} messages 
-     * @param {string} ticketID 
-     * @param {string} type 
-     * @returns {string}
-     */
     displayMessages(channel, messages = [], ticketID, type) {
         let users = [];
         for (const i of messages.values()) {
@@ -380,15 +335,7 @@ module.exports = class Tickets {
                 }).catch(e => this._debug(e));
             }).catch(e => this._debug(e));
     };
-    /**
-     * @typedef {Object} getSupportResponse
-     * @property {string[]} [roles]
-     * @property {string[]} [users]
-     * 
-     * 
-     * @private
-     * @returns {getSupportResponse}
-     */
+
     getSupportIds() {
         return {
             roles: this.options.support?.roles || this.options.supportRoleIds || [],
@@ -398,9 +345,7 @@ module.exports = class Tickets {
 
     /** @private */
     _debug(...args) {
-        if (!this.options?.debug) return null;
-        console.log(...args);
+        if (this.options?.debug) console.log(...args);
         return null;
     }
-
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elara-services/tickets",
-  "version": "2.0.4",
+  "version": "2.1.2",
   "description": "Helper for tickets",
   "main": "index.js",
   "types": "index.d.ts",
@@ -8,7 +8,7 @@
   "author": "SUPERCHIEFYT (Elara-Discord-Bots, Elara-Services)",
   "license": "MIT",
   "optionalDependencies": {
-    "discord.js": "13.8.0"
+    "discord.js": "13.8.1"
   },
   "dependencies": {
     "@elara-services/packages": "5.0.0",