System messages

src/SystemMessage.ts

@@ -0,0 +1,110 @@
+import { ColorResolvable, GuildMember, MessageEmbed, TextChannel, User } from 'discord.js';
+import { Command, PermissionsError } from './Command.js';
+
+type MessageType = 'PERMISSION' | 'ERROR' | 'NOT_FOUND';
+interface SystemMessageAppearance {
+    title: string,
+    bottomText?: string,
+    accentColor?: ColorResolvable,
+    showTimestamp?: boolean,
+    footer?: string
+}
+interface SystemMessageData {
+    command?: Command,
+    phrase?: string,
+    user?: GuildMember | User,
+    error?: Error | PermissionsError | string
+}
+
+class SystemMessageManager {
+    PERMISSION: SystemMessageAppearance;
+    ERROR: SystemMessageAppearance;
+    NOT_FOUND: SystemMessageAppearance;
+    deleteTimeout: number;
+    constructor(botName?: string) {
+        this.PERMISSION = {
+            title: '👮‍♂️ Insufficient permissions',
+            bottomText: "You don't have enough permissions to run this command",
+            accentColor: '#1d1dc4',
+            showTimestamp: true
+        }
+        this.ERROR = {
+            title: '❌ An error occurred',
+            bottomText: 'Something went wrong while processing your request.',
+            accentColor: '#f00',
+            showTimestamp: true
+        }
+        this.NOT_FOUND = {
+            title: '🔍 Command not found',
+            accentColor: '#ff5500',
+            showTimestamp: false,
+            footer: botName
+        }
+        this.deleteTimeout = Infinity;
+    }
+    async send(type: MessageType, data?: SystemMessageData, channel?: TextChannel) : Promise<MessageEmbed | void> {
+        if(this[type]) {
+            const embed = new MessageEmbed();
+            embed.setTitle(this[type].title);
+            if(this[type].bottomText) embed.setDescription(this[type].bottomText);
+            embed.setColor(this[type].accentColor || '#000');
+            if(this[type].showTimestamp) embed.setTimestamp();
+            if(this[type].footer) embed.setFooter(this[type].footer);
+            if(data) {
+                switch(type) {
+                    case 'ERROR':
+                        if(data.command) {
+                            embed.addField('Command name:', data.command.name, false);
+                        }
+                        if(data.error) {
+                            if(data.error instanceof Error || data.error instanceof PermissionsError) {
+                                embed.addField('Error details:', data.error.toString(), false);
+                            }
+                            else if(typeof data.error == 'string') {
+                                embed.addField('Error details:', data.error, false);
+                            }
+                        }
+                        if(data.user) {
+                            embed.addField('User:', data.user.toString(), false);
+                        }
+                        break;
+                    case 'NOT_FOUND':
+                        if(data.phrase) {
+                            embed.addField('Phrase:', data.phrase, false);
+                        }
+                        break;
+                    case 'PERMISSION':
+                        if(data.user) {
+                            embed.addField('User:', data.user.toString(), false);
+                        }
+                        if(data.command) {
+                            embed.addField('Command name:', data.command.name, false);
+                            if(data.command.permissions) {
+                                let permList: string = '';
+                                data.command.permissions.toArray(false).map(p => {
+                                    permList += p + '\n';
+                                });
+                                embed.addField('Required permissions:', permList, false);
+                            }
+                        }
+                        break;
+                }
+            }
+            if(channel) {
+                const message = await channel.send(embed);
+                if(this.deleteTimeout != Infinity && message.deletable) {
+                    await message.delete({ timeout: this.deleteTimeout });
+                }
+            }
+            else {
+                return embed;
+            }
+        }
+        else {
+            console.error('ERROR! System message: Incorrect parameter');
+            return;
+        }
+    }
+}
+
+export { MessageType, SystemMessageAppearance, SystemMessageManager };