feat: stickies for forum posts which get posted on forum post create

.github/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 Update <small>_ December 2022</small>
 
+- feat: stickies for forum posts which get posted on forum post create (19/12/2022)
 - refactor: outdated information + links in commands (08/12/2022)
 - fix: fix latlong image typo and prime meridian alignment (04/12/2022)
 - refactor: update wb command for change in Stable (03/12/2022)

.github/command-docs.md

@@ -173,6 +173,7 @@
 | .faq                  | Sends the FAQ                                                                                           | ---                                        |
 | .roleassignment       | Sends the role assignment messages                                                                      | ---                                        |
 | .rules                | Sends the rules                                                                                         | ---                                        |
+| .sticky               | Manage sticky messages which are posted in Forum Posts when a new post is created                       | ---                                        |
 | .temporarycommandedit | Manage temporary commands, which are simple output commands to highlight temporary situations to users. | .tempcommandedit <br> .tcedit <br> .tcmod  |
 | .timeout              | ---                                                                                                     | ---                                        |
 | .unban                | ---                                                                                                     | ---                                        |

src/commands/index.ts

@@ -154,6 +154,7 @@ import { flyPadAbout } from './support/flyPadAbout';
 import { navdata } from './support/navdata';
 import { winss } from './support/winss';
 import { simridgeLog } from './support/simbridgeLog';
+import { sticky } from './moderation/sticky';
 
 const commands: BaseCommandDefinition[] = [
     typeCommand,
@@ -310,6 +311,7 @@ const commands: BaseCommandDefinition[] = [
     navdata,
     winss,
     simridgeLog,
+    sticky,
 ];
 
 const commandsObject: { [k: string]: BaseCommandDefinition } = {};

src/handlers/forumPostCreate.ts

@@ -0,0 +1,35 @@
+import { getConn } from '../lib/db';
+import Logger from '../lib/logger';
+import StickyMessage from '../lib/schemas/stickyMessageSchema';
+import { stickyMessageEmbed } from '../lib/stickyMessageEmbed';
+
+module.exports = {
+    event: 'threadCreate',
+    executor: async (thread) => {
+        const { parentId, parent, name } = thread;
+        Logger.debug(`Thread Create - Handling thread create for ${name}`);
+        const { name: parentName, type } = parent;
+        Logger.debug(`Thread Create - Parent ID: ${parentId} - Parent Type: ${type} - Parent Name: ${parentName}`);
+        if (type !== 15) {
+            Logger.debug('Thread Create - Thread not created in a Forum Channel, skipping.');
+            return;
+        }
+
+        const conn = getConn();
+        if (!conn) {
+            Logger.debug('Thread Create - Unable to connect to database, skipping.');
+            return;
+        }
+
+        const stickyMessageSearchResult = await StickyMessage.find({ channelId: parentId });
+        const [stickyMessage] = stickyMessageSearchResult.length === 1 ? stickyMessageSearchResult : [];
+        if (!stickyMessage) {
+            Logger.debug('Forum Post Create - No sticky for the forum, skipping.');
+            return;
+        }
+
+        const { message, imageUrl } = stickyMessage;
+        Logger.debug('Forum Post Create - Posting new sticky.');
+        await thread.send({ embeds: [stickyMessageEmbed(message, imageUrl)] });
+    },
+};

src/lib/schemas/stickyMessageSchema.ts

@@ -0,0 +1,19 @@
+import mongoose, { Schema } from 'mongoose';
+
+const stickyMessageSchema = new Schema({
+    channelId: {
+        type: String,
+        unique: true,
+    },
+    message: String,
+    imageUrl: String,
+    timeInterval: Number,
+    messageCount: Number,
+    moderator: String,
+    updatedTimestamp: Date,
+    lastPostedId: String,
+});
+
+const stickyMessage = mongoose.model('StickyMessage', stickyMessageSchema);
+
+export default stickyMessage;

src/lib/stickyMessageEmbed.ts

@@ -0,0 +1,12 @@
+import { Colors } from '../constants';
+import { makeEmbed } from './embed';
+
+export const STICKY_MESSAGE_TITLE = 'Stickied Message';
+export const STICKY_MOD_TITLE = 'Sticky Message - Log';
+
+export const stickyMessageEmbed = (description: string, imageUrl: string) => makeEmbed({
+    title: STICKY_MESSAGE_TITLE,
+    description,
+    color: Colors.FBW_CYAN,
+    image: imageUrl ? { url: imageUrl } : null,
+});