🚀 RELEASE: v0.7.0

Merge pull request #44 from thirdweb-dev/dev

Author: warengonzaga

package.json

@@ -11,8 +11,9 @@
   "license": "GPL-3.0",
   "private": true,
   "dependencies": {
-    "discord.js": "^14.6.0",
+    "discord.js": "^14.10.2",
     "dotenv": "^16.0.3",
+    "fs-extra": "^11.1.1",
     "google-spreadsheet": "^3.3.0",
     "moment": "^2.29.4"
   },

src/bot.js

@@ -1,13 +1,13 @@
-const { 
-	ActivityType, 
+const fs = require('node:fs');
+const path = require('node:path');
+const {
 	Client, 
 	ChannelType, 
 	GatewayIntentBits, 
-	Partials,
-	EmbedBuilder } = require('discord.js');
-const { GoogleSpreadsheet } = require('google-spreadsheet');
-const config = require(`${__dirname}/config.json`);
-const moment = require('moment');
+	Partials } = require('discord.js');
+const config = require('./config.json');
+const { sendEmbedMessage, formatTime } = require('./utils/core');
+const { sendData } = require('./utils/database');
 
 require('dotenv').config();
 
@@ -33,29 +33,6 @@ const client = new Client({
 	]
 });
 
-// load spreadsheet
-const doc = new GoogleSpreadsheet(process.env.GOOGLE_SPREADSHEET_ID);
-
-/**
- * send embed message
- * @param {string} message 
- * @returns pre-defined embed style
- */
-const sendEmbedMessage = (message) => {
-	return new EmbedBuilder()
-	.setDescription(message)
-	.setColor(`#f213a4`);
-}
-
-/**
- * get username from ownerid
- * @param {number} id 
- * @returns 
- */
-const getUsernameFromId = async (id) => {
-	return (await client.users.fetch(id)).username;
-}
-
 // listen to post messages
 client.on('messageCreate', async (message) => {
 	if (message.author.bot) return;
@@ -89,15 +66,12 @@ client.on('messageCreate', async (message) => {
 	if (typeof post.availableTags !== 'undefined') {
 		// filter the tags to get the resolution tag name ID
 		const resolutionTag = post.availableTags.filter((item) => { return item.name == config.tag_name_resolve });
+		const closeTag = post.availableTags.filter((item) => { return item.name == config.tag_name_close });
 		// get the existing tags of the post
 		const postTags = message.channel.appliedTags;
-		
-		// collect tags
-		let initialTags = [resolutionTag[0].id,...postTags];
-		let tags = [...new Set(initialTags)];
 
 		// check if the command has the prefix and includes "resolve"
-		if (message.content.startsWith(config.command_prefix) && message.content.includes(config.command_resolve)) {
+		if (message.content.startsWith(config.command_prefix)) {
 			await message.delete(); // delete the commmand message
 
 			// check if the message is in the forum post and from the support role
@@ -106,39 +80,91 @@ client.on('messageCreate', async (message) => {
 				// check if the post has fewer tags
 				if (postTags.length < 5) {
 
-					// send embed message before resolving the post
-					await message.channel.send({ embeds: [
-							sendEmbedMessage(`${config.reminder_resolve}`)
-						],
-						content: `🔔 <@${message.channel.ownerId}>`
-					})
-
-					// then archive and lock it
-					message.channel.edit({
-						appliedTags: tags,
-						archived: true
-					});
-
 					// gather data
 					const postId = message.channel.id;
 					const resolutionTime = formatTime(message.createdTimestamp);
 					const resolvedBy = member.user.username;
 
-					// check if there's a mentioned user
-					if (mention.users.first()) {
-						// send the data, use the mentioned user as resolvedBy
-						sendData({
-							post_id: postId,
-							resolution_time: resolutionTime,
-							resolved_by: mention.users.first().username,
-						}, config.datasheet_resolve);
-					} else {
-						// send the data with the one who sends the command
-						sendData({
-							post_id: postId,
-							resolution_time: resolutionTime,
-							resolved_by: resolvedBy
-						}, config.datasheet_resolve);
+					// functions for resolve command
+					if (message.content.includes(config.command_resolve)) {
+
+						// data for resolve command
+						// collect tags
+						let initialTags = [resolutionTag[0].id,...postTags];
+						let tags = [...new Set(initialTags)];
+
+						// send embed message upon executing the resolve command
+						await message.channel.send({ 
+							embeds: [
+								sendEmbedMessage(`${config.reminder_resolve}`)
+							],
+							content: `🔔 <@${message.channel.ownerId}>`
+						});
+
+						// then archive and lock it
+						message.channel.edit({
+							appliedTags: tags,
+							archived: true
+						});
+
+						// check if there's a mentioned user
+						if (mention.users.first()) {
+							// send the data, use the mentioned user as resolvedBy
+							sendData({
+								post_id: postId,
+								resolution_time: resolutionTime,
+								resolved_by: mention.users.first().username,
+							}, config.datasheet_resolve);
+						} else {
+							// send the data with the one who sends the command
+							sendData({
+								post_id: postId,
+								resolution_time: resolutionTime,
+								resolved_by: resolvedBy
+							}, config.datasheet_resolve);
+						}
+
+					}
+
+					// functions for close command
+					if (message.content.includes(config.command_close)) {
+
+						// data for resolve command
+						// collect tags
+						let initialTags = [closeTag[0].id,...postTags];
+						let tags = [...new Set(initialTags)];
+
+						// send embed message upon executing the close command
+						await message.channel.send({ 
+							embeds: [
+								sendEmbedMessage(`${config.reminder_close}`)
+							],
+							content: `🔔 <@${message.channel.ownerId}>`
+						});
+
+						// then archive and lock it
+						message.channel.edit({
+							appliedTags: tags,
+							archived: true
+						});
+
+						// check if there's a mentioned user
+						if (mention.users.first()) {
+							// send the data, use the mentioned user as resolvedBy
+							sendData({
+								post_id: postId,
+								close_time: resolutionTime,
+								closed_by: mention.users.first().username,
+							}, config.datasheet_close);
+						} else {
+							// send the data with the one who sends the command
+							sendData({
+								post_id: postId,
+								close_time: resolutionTime,
+								closed_by: resolvedBy
+							}, config.datasheet_close);
+						}
+
 					}
 
 				} else {
@@ -234,8 +260,10 @@ client.on('threadCreate', async post => {
 	const tags = forumTags.join(', ');
 	const firstResponse = `=IFERROR(VLOOKUP(A2:A,${config.datasheet_response}!A2:B,2,0))`;
 	const resolutionTime = `=IFERROR(VLOOKUP(A2:A,${config.datasheet_resolve}!A2:B,2,0))`;
+	const closeTime = `=IFERROR(VLOOKUP(A2:A,${config.datasheet_close}!A2:B,2,0))`;
 	const responder = `=IFERROR(VLOOKUP(A2:A,{${config.datasheet_response}!A2:A,${config.datasheet_response}!C2:C},2,0))`;
 	const resolvedBy = `=IFERROR(VLOOKUP(A2:A,{${config.datasheet_resolve}!A2:A,${config.datasheet_resolve}!C2:C},2,0))`;
+	const closedBy = `=IFERROR(VLOOKUP(A2:A,{${config.datasheet_close}!A2:A,${config.datasheet_close}!C2:C},2,0))`;
 
 	// send the data
 	sendData({
@@ -248,66 +276,25 @@ client.on('threadCreate', async post => {
 		responder: responder,
 		first_response: firstResponse,
 		resolution_time: resolutionTime,
-		resolved_by: resolvedBy
+		resolved_by: resolvedBy,
+		close_time: closeTime,
+		closed_by: closedBy
 	}, config.datasheet_init);
 });
 
-/**
- * sends data to the spreadsheet
- * @param {object} data - data being added as row in the spreadsheet
- * @param {string} datasheet - name of sheet where data being sent e.g. init, response, resolve
- */
-const sendData = async (data, datasheet) => {
-	// authenticate
-	await doc.useServiceAccountAuth({
-		client_email: process.env.GOOGLE_SERVICE_ACCOUNT_EMAIL,
-		private_key: process.env.GOOGLE_PRIVATE_KEY.replace(/\\n/g, "\n"),
-	});
-	// load the "initial" sheet
-	await doc.loadInfo();
-	const sheet = doc.sheetsByTitle[datasheet];
-
-	// check if the data will be send to init sheet
-	if (datasheet === config.datasheet_init) {
-		await sheet.addRow(data);
-	};
-
-	// check if the data will be send to response sheet
-	if (datasheet === config.datasheet_response) {
-		await sheet.addRow(data);
+// reading events file
+const eventsPath = path.join(__dirname, 'events');
+const eventFiles = fs.readdirSync(eventsPath).filter(file => file.endsWith('.js'));
+
+for (const file of eventFiles) {
+	const filePath = path.join(eventsPath, file);
+	const event = require(filePath);
+	if (event.once) {
+		client.once(event.name, (...args) => event.execute(...args));
+	} else {
+		client.on(event.name, (...args) => event.execute(...args));
 	}
-
-	// check if the data will be send to resolve sheet
-	if (datasheet === config.datasheet_resolve) {
-		await sheet.addRow(data);
-	};
-}
-
-/**
- * format time according to UTC
- * @param {number} date - epoch timestamp
- * @returns time and date format
- */
-const formatTime = (date) => {
-	return moment.utc(date).utcOffset(config.utc_offset).format('M/DD/YYYY HH:mm:ss');
 }
 
-// discord error log event
-client.on('error', (err) => {
-	console.log(err);
-});
-
-// discord log event
-client.once('ready', bot => {
-	client.user?.setPresence({
-		activities: [{
-			name: 'for support.',
-			type: ActivityType.Watching
-		}]
-	});
-
-	console.log(`Ready! Logged in as ${bot.user.tag}`);
-});
-
 // log in to Discord with your client's token
 client.login(token);

src/config.json

@@ -3,12 +3,16 @@
     "command_resolve": "resolve",
     "command_close": "close",
     "command_escalate": "escalate",
+    "command_reopen": "reopen",
     "tag_name_resolve": "Solved",
     "tag_name_close": "Closed",
     "tag_name_escalate": "Escalated",
     "datasheet_init": "init",
     "datasheet_response": "response",
     "datasheet_resolve": "resolve",
+    "datasheet_close": "close",
+    "datasheet_escalate": "escalate",
+    "datasheet_reopen": "reopen",
     "utc_offset": -8,
     "reminder_mention": "Hey! If you need help, please read the information in <#1074862134284005396> and post your questions or issues in the <#1029543258822553680> channel. Our team and community members are always ready to help you out. Thank you for building with us!",
     "reminder_max_tags": "Max tags (5) exceeded. Please update the original post with fewer tags and try again.",

src/events/error.js

@@ -0,0 +1,9 @@
+const { Events } = require('discord.js');
+
+module.exports = {
+    name: Events.Error,
+    once: false,
+    execute(error) {
+        console.log(`Not ready due to ${error}`);
+    },
+};

src/events/ready.js

@@ -0,0 +1,16 @@
+const { Events, ActivityType } = require('discord.js');
+
+module.exports = {
+    name: Events.ClientReady,
+    once: true,
+    execute(bot) {
+        bot.user?.setPresence({
+            activities: [{
+                name: 'for support.',
+                type: ActivityType.Watching
+            }]
+        });
+
+        console.log(`Ready! Logged in as ${bot.user.tag}`);
+    },
+};

src/utils/core.js

@@ -0,0 +1,38 @@
+const { EmbedBuilder } = require('discord.js');
+const moment = require('moment');
+const config = require('../config.json');
+
+/**
+ * send embed message
+ * @param {string} message 
+ * @returns pre-defined embed style
+ */
+const sendEmbedMessage = (message) => {
+	return new EmbedBuilder()
+	.setDescription(message)
+	.setColor(`#f213a4`);
+}
+
+/**
+ * format time according to UTC
+ * @param {number} date - epoch timestamp
+ * @returns time and date format
+ */
+const formatTime = (date) => {
+	return moment.utc(date).utcOffset(config.utc_offset).format('M/DD/YYYY HH:mm:ss');
+}
+
+/**
+ * get username from ownerid/author.id
+ * @param {number} id user's id
+ * @returns 
+ */
+const getUsernameFromId = async (id) => {
+	return (await client.users.fetch(id)).username;
+}
+
+module.exports = {
+    sendEmbedMessage,
+    formatTime,
+    getUsernameFromId
+}