@elara-services/tickets 3.1.3 → 3.1.6

package/index.d.ts

@@ -1,7 +1,7 @@
 declare module "@elara-services/tickets" {
     
     import { Client, MessageOptions, GuildMember, Guild, User, TextBasedChannel, Message, Interaction, ModalOptions } from "discord.js";
-    import Webhook from "discord-hook";
+    import type { DiscordWebhook } from "@elara-services/webhooks";
 
     export interface TicketOptions {
         client: Client;
@@ -67,7 +67,7 @@ declare module "@elara-services/tickets" {
         public constructor(options: TicketOptions);
         public options: TicketOptions;
         public prefix: string;
-        public webhook(): typeof Webhook.prototype;
+        public webhook(): typeof DiscordWebhook.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>>

package/languages/en-US.js

@@ -0,0 +1,36 @@
+module.exports = {
+    NO_CONSTRUCTOR_OPTIONS: (name = "") => name ? `You didn't provide any data in the constructor, fill it out!` : `You forgot to fill out either ${name}`,
+
+    CREATE_TICKET: "Create Ticket",
+    MODAL_CONTENT: "Content",
+    MODAL_CONTENT_PLACEHOLDER: "What's the ticket about?",
+    OPEN_TICKET_TITLE: "Ticket: Opened",
+    OPEN_TICKET_CREATE: "Ticket Created!",
+    OPEN_TICKET_AUDIT_REASON: "Ticket created by:",
+    OPEN_TICKET_MESSAGE_CONTENT: "👋 Hello, please explain what you need help with.",
+    OPEN_TICKET_MESSAGE_FOOTER: "To close the ticket, press the button below",
+    OPEN_TICKET_MESSAGE: "Support will be with you shortly.",
+    CLOSE_TICKET_TITLE: `Ticket: Closed`,
+    CLOSE_TICKET: "Close Ticket",
+    CLOSE_TICKET_FIELD_REASON: "Close Reason",
+    NO_CHANNEL_CREATE: `❌ I was unable to create the ticket channel, if this keeps happening contact one of the staff members via their DMs!`,
+    NO_CHANNEL_DELETE: "",
+    GO_TO_TICKET: "Go to ticket",
+    TICKET_ID: "Ticket ID:",
+    TRANSCRIPT: "Transcript",
+    VIEW_HERE: "View here",
+    NO_REASON: "No Reason Provided",
+    TICKET_LIMIT_ONE_PER_USER: (name = "") => `❌ You can only create one (${name}) ticket at a time.`,
+    TICKET_BLOCKED: `❌ You can't create tickets, if you believe this is a mistake contact one of the staff members.`,
+    ONLY_SUPPORT: "Only support staff can close tickets",
+    TICKET_CLOSE_CONFIRM: `🤔 Are you sure you want to close the ticket?`,
+    TICKET_CLOSE_CONFIRM_BUTTON: `Yes, close the ticket!`,
+    TICKET_CLOSE_PLACEHOLDER: "What's the reason for closing the ticket?",
+    FORM_RESPONSES: "Form Responses",
+    FORM_RESPONSE: "Form Response",
+    ID: (id) => `ID: ${id}`,
+    REASON: "Reason",
+    BAN_REASON: "Ban Reason",
+    NOT_BANNED_MAIN_SERVER: `❌ You can't open this ticket due to you not being banned in the main server!`,
+    UNBAN: "Unban"
+}

package/lib/base.js

@@ -1,11 +1,11 @@
-const { getWebhookInfo, displayMessages, de, webhook } = require("./util"),
+const { getWebhookInfo, displayMessages, de, webhook, getString } = 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'`)
+        if (typeof options !== "object") throw new Error(this.str("NO_CONSTRUCTOR_OPTIONS")());
+        if (!("client" in options) || !("prefix" in options) || !("encryptToken" in options)) throw new Error(this.str("NO_CONSTRUCTOR_OPTIONS")("'client', 'prefix' or 'encryptToken'"));
         this.options = options;
     }
     get prefix() { return `system:ticket:${this.options.prefix}`; };
@@ -16,14 +16,15 @@ module.exports = class Tickets {
             users: this.options.support?.users || []
         }
     }
-
+    str(name) { return getString(name, this.options?.lang || "en-US"); }
+    
     /** @private */
     _debug(...args) {
         if (this.options?.debug) console.log(...args);
         return null;
     }
 
-    button(options = { style: 3, label: "Create Ticket", emoji: { name: "📩" } }) {
+    button(options = { style: 3, label: this.str("CREATE_TICKET"), emoji: { name: "📩" } }) {
         return button({ id: options?.id || this.prefix, style: options.style || 3, title: options.label, emoji: options.emoji });
     };
 
@@ -33,7 +34,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 || this.str("CREATE_TICKET"), components: options?.components?.length >= 1 ? options.components : [{ type: 1, components: [{ type: 4, min_length: 10, max_length: 4000, custom_id: "message", label: this.str("MODAL_CONTENT"), style: 2, placeholder: this.str("MODAL_CONTENT_PLACEHOLDER"), required: true }] }] })
     };
 
     async closeTicket({ member, messages, channel, guild, user, reason } = {}) {
@@ -42,12 +43,12 @@ module.exports = class Tickets {
         let embeds = [
             {
                 author: { name: guild.name, icon_url: guild.iconURL({ dynamic: true }) },
-                title: "Ticket: Closed",
+                title: this.str("CLOSE_TICKET_TITLE"),
                 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,
+                fields: reason ? [ { name: this.str("CLOSE_TICKET_FIELD_REASON"), value: reason?.slice?.(0, 1024) ?? this.str("NO_REASON") } ] : undefined,
                 timestamp: new Date(),
-                footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` },
+                footer: { text: `${this.str("TICKET_ID")} ${channel.name.split("-")[1]}` },
             }
         ];
         new WebhookClient({ id, token })
@@ -67,11 +68,11 @@ module.exports = class Tickets {
                 if (user) user.send({
                     embeds: [{
                         author: { name: guild.name, icon_url: guild.iconURL({ dynamic: true }) },
-                        title: `Ticket: Closed`,
+                        title: this.str("CLOSE_TICKET_TITLE"),
                         color: 0xFF0000,
-                        fields: reason ? [ { name: "Close Reason", value: reason?.slice?.(0, 1024) ?? "No Reason Provided" } ] : undefined,
+                        fields: reason ? [ { name: this.str("CLOSE_TICKET_FIELD_REASON"), value: reason?.slice?.(0, 1024) ?? this.str("NO_REASON") } ] : undefined,
                         timestamp: new Date(),
-                        footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` }
+                        footer: { text: `${this.str("TICKET_ID")} ${channel.name.split("-")[1]}` }
                     }],
                     components: [{ type: 1, components }]
                 }).catch(e => this._debug(e));

package/lib/util.js

@@ -1,6 +1,21 @@
 const { AES } = require("@elara-services/packages"),
       { Collection, version } = require("discord.js"),
-        Webhook = require("discord-hook");
+      { DiscordWebhook: Webhook } = require("@elara-services/webhooks"),
+        defLang = require("../languages/en-US"),
+        pack = require("../package.json");
+
+exports.getString = (name, lang = "en-US") => {
+    if (!lang) lang = "en-US";
+    let str = '[UNKNOWN STRING]';
+    if (!pack.languages.includes(lang)) lang = "en-US";
+    try {
+        let file = require(`../languages/${lang}.js`);
+        if (file[name]) str = file[name];
+    } catch {
+        if (defLang[name]) str = defLang[name];
+    };
+    return str;
+}
 
 exports.code = (message, type = "d", token) => {
     if (!message || !type) return "";

package/lib/v13.js

@@ -1,7 +1,7 @@
 const { MessageEmbed } = require("discord.js"),
         base = require("./base"),
       { de, code, fetchMessages, hasTicket, embed, webhook, getAppealServer } = require("./util"),
-      { generate } = require("shortid"),
+      { generate } = require("@elara-services/utils"),
       { Interactions: { button, modal } } = require("@elara-services/packages");
 
 module.exports = class Tickets extends base {
@@ -161,22 +161,22 @@ module.exports = class Tickets extends base {
                 if (!ban) return send(
                     typeof appeals.embeds?.not_banned === "object" ?
                         appeals.embeds.not_banned :
-                        { embeds: [ embed(`❌ You can't open this ticket due to you not being banned in the main server!`, { guild, color: 0xFF0000 }) ] }
+                        { embeds: [ embed(this.str("NOT_BANNED_MAIN_SERVER"), { guild, color: 0xFF0000 }) ] }
                 );
                 sendBanReason = {
-                    embeds: [ embed(ban?.reason ?? "No Reason Provided", { title: "Ban Reason", guild: server }) ],
+                    embeds: [ embed(ban?.reason ?? this.str("NO_REASON"), { title: this.str("BAN_REASON"), guild: server }) ],
                     components: [
                         {
                             type: 1, components: [
-                                button({ id: `unban:${member.id}`, style: 4, title: "Unban", emoji: { name: "🔒" } })
+                                button({ id: `unban:${member.id}`, style: 4, title: this.str("UNBAN"), emoji: { name: "🔒" } })
                             ]
                         }
                     ]
                 }
             }
         }
-        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})`,
+        let channel = await guild.channels.create(`${this.options.prefix}-${generate(5)}`, {
+            type: "GUILD_TEXT", parent: category, reason: `${this.str("OPEN_TICKET_AUDIT_REASON")} @${member.user.tag} (${member.id})`,
             topic: `ID: ${code(member.id, "e", this.options.encryptToken)}`,
             permissionOverwrites: [
                 { type: "member", id: this.options.client.user.id, allow: ["ADD_REACTIONS", "ATTACH_FILES", "SEND_MESSAGES", "READ_MESSAGE_HISTORY", "EMBED_LINKS", "USE_EXTERNAL_EMOJIS", "VIEW_CHANNEL", "MENTION_EVERYONE"] },
@@ -185,25 +185,25 @@ module.exports = class Tickets extends base {
                 ...permissions
             ]
         }).catch(e => this._debug(e));
-        if (!channel) return send({ embeds: [embed(`❌ 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({ embeds: [embed(this.str("NO_CHANNEL_CREATE"))] });
         let msg = await channel.send({
-            content: (this.options.ticket?.open || 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.ticket?.open || this.options.ticketOpen)?.embeds || [ embed(undefined, { title: `Support will be with you shortly.`, color: 0xF50DE3, guild, footer: { text: `To close the ticket, press the button below` } }) ],
-            components: [ { type: 1, components: [ button({ id: `${this.prefix}:close`, title: `Close Ticket`, style: 4, emoji: { name: "🔒" } }) ] }]
+            content: (this.options.ticket?.open || this.options.ticketOpen)?.content?.replace?.(/%user%/gi, member.user.toString())?.replace?.(/%server%/gi, guild.name) || `${member.user.toString()} ${this.str("OPEN_TICKET_MESSAGE_CONTENT")}`,
+            embeds: (this.options.ticket?.open || this.options.ticketOpen)?.embeds || [ embed(undefined, { title: this.str("OPEN_TICKET_MESSAGE"), color: 0xF50DE3, guild, footer: { text: this.str("OPEN_TICKET_MESSAGE_FOOTER") } }) ],
+            components: [ { type: 1, components: [ button({ id: `${this.prefix}:close`, title: this.str("CLOSE_TICKET"), style: 4, emoji: { name: "🔒" } }) ] }]
         }).catch(e => this._debug(e));
         if (!msg) return null;
         if (sendBanReason) await channel.send(sendBanReason).catch(e => this._debug(e));
         if (embeds?.length <= 10) for await (const embed of embeds) await channel.send({ embeds: [embed] }).catch(e => this._debug(e));
         if (this.webhookOptions.id && this.webhookOptions.token) webhook(this.webhookOptions)
             .embed(embed(`${de.user} User: ${member.user.toString()} \`@${member.user.tag}\` (${member.id})\n${de.channel} Channel: \`#${channel.name}\` (${channel.id})`, {
-                title: `TIcket: Opened`,
+                title: this.str("OPEN_TICKET_TITLE"),
                 color: 0xFF000,
-                footer: { text: `Ticket ID: ${channel.name.split("-")[1]}` },
+                footer: { text: `${this.str("TICKET_ID")} ${channel.name.split("-")[1]}` },
                 guild
             })).send().catch(e => this._debug(e));
         return send({
-            embeds: [ embed(channel.toString(), { color: 0xFF000, author: { name: `Ticket Created!`, icon_url: `https://cdn.discordapp.com/emojis/476629550797684736.gif` } }) ],
-            components: [{ type: 1, components: [button({ title: "Go to ticket", url: msg.url })] }]
+            embeds: [ embed(channel.toString(), { color: 0xFF000, author: { name: this.str("OPEN_TICKET_CREATE"), icon_url: `https://cdn.discordapp.com/emojis/476629550797684736.gif` } }) ],
+            components: [{ type: 1, components: [button({ title: this.str("GO_TO_TICKET"), url: msg.url })] }]
         })
     }
 
@@ -215,4 +215,4 @@ module.exports = class Tickets extends base {
         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})`))
     };
-};
+}

package/lib/v14.js

@@ -1,7 +1,7 @@
 const { EmbedBuilder: MessageEmbed, InteractionType, PermissionFlagsBits, ChannelType } = require("discord.js"),
         base = require("./base"),
       { de, code, fetchMessages, hasTicket, embed, webhook, getAppealServer } = require("./util"),
-      { generate } = require("shortid"),
+      { generate } = require("@elara-services/utils"),
       { Interactions: { button, modal } } = require("@elara-services/packages");
 
 module.exports = class Tickets extends base {
@@ -186,7 +186,7 @@ module.exports = class Tickets extends base {
             }
         }
         let channel = await guild.channels.create({
-            name: `${this.options.prefix}-${generate().slice(0, 5).replace(/-|_/g, "")}`,
+            name: `${this.options.prefix}-${generate(5)}`,
             type: ChannelType.GuildText, 
             parent: category, 
             reason: `Ticket created by: @${member.user.tag} (${member.id})`,
@@ -249,7 +249,7 @@ module.exports = class Tickets extends base {
     async starterMessage(channelId, options) {
         let channel = this.options.client.channels.resolve(channelId);
         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.isTextBased()) return Promise.reject(`The channel ID provided isn't a text-based-channel`);
         if (!channel.permissionsFor?.(this.options.client.user.id)?.has?.([
             PermissionFlagsBits.ViewChannel,
             PermissionFlagsBits.SendMessages,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elara-services/tickets",
-  "version": "3.1.3",
+  "version": "3.1.6",
   "description": "Helper for tickets",
   "main": "index.js",
   "types": "index.d.ts",
@@ -16,8 +16,8 @@
   },
   "dependencies": {
     "@elara-services/packages": "5.0.0",
-    "discord-hook": "2.0.0",
-    "shortid": "2.2.16"
+    "@elara-services/utils": "^1.2.11",
+    "@elara-services/webhooks": "^2.1.7"
   },
   "devDependencies": {
     "eslint": "8.20.0"
@@ -33,5 +33,8 @@
     "appeals",
     "banappeal",
     "discordtickets"
+  ],
+  "languages": [
+    "en-US"
   ]
 }