docs

Author: andriotisnikos1

src/commands/auctions/create/interactionListeners/action-buttons.ts

@@ -7,6 +7,10 @@ import {
   confirmedAuctionCreationDisplayContainer
 } from "../util/staticComponents";
 
+/**
+ * Listens to the buttons on the container generated by the base listener
+ * and handles the confirm and cancel actions.
+ */
 client.on("interactionCreate", async (interaction) => {
   if (!interaction.isButton()) return;
   if (!interaction.customId.startsWith("auction:create:")) return;

src/commands/auctions/create/interactionListeners/base.ts

@@ -6,6 +6,12 @@ import { MessageFlags, PrimaryEntryPointCommandInteraction } from "discord.js";
 import AuctionCreator from "../util/AuctionCreator";
 import { invalidAuctionCreateDisplayContainer } from "../util/staticComponents";
 
+
+/**
+ * Base listener of the auction create command. Verifies that the user
+ * has a linked MinionAH account and initializes the AuctionCreator
+ * to generate the confirmation display container.
+ */
 client.on("interactionCreate", async (interaction) => {
   if (!interaction.isCommand()) return;
   if (interaction instanceof PrimaryEntryPointCommandInteraction) return;

src/commands/auctions/create/util/AuctionCreator.ts

@@ -64,6 +64,12 @@ export default class AuctionCreator {
     AuctionCreator.auctionCreators.delete(username);
   }
 
+  /**
+   * Finalizes the auction creation process and saves the auction to the database.
+   * Although checked by the base listener, we re-validate the existence of the linked MinionAH user
+   * since we use it anyway here.
+   * @param username 
+   */
   public static async confirmCreation(username: string) {
     const creator = AuctionCreator.auctionCreators.get(username);
     if (!creator) {
@@ -102,6 +108,11 @@ export default class AuctionCreator {
     });
   }
 
+  /**
+   * Generates the confirmation display container for the auction creation process.
+   * The container includes all the auction details and confirm/cancel buttons.
+   * @returns 
+   */
   public async getConfirmationDisplayContainer() {
     const minionData = await prisma.minion.findFirst({
       where: {

src/commands/auctions/delete/interactionListeners/action-buttons.ts

@@ -4,6 +4,11 @@ import genericErrorContainer from "$src/shared/displayContainers/genericErrorCon
 import { MessageFlags } from "discord.js";
 import auctionsDeleteComponents from "../util/auctionsDeleteComponents";
 
+
+/** 
+ * Listens to the buttons on the container generated by the base listener
+ * and handles the confirm and cancel actions for auction deletion.
+ */
 client.on("interactionCreate", async (interaction) => {
   if (!interaction.isButton()) return;
   if (!interaction.customId.startsWith("auction:delete:")) return;
@@ -12,6 +17,7 @@ client.on("interactionCreate", async (interaction) => {
     const targetAuctionID = kv.get<string>(
       `auction:delete:pending:${interaction.user.username}`
     );
+
     if (!targetAuctionID) {
       await interaction.reply({
         components: [
@@ -21,6 +27,7 @@ client.on("interactionCreate", async (interaction) => {
       });
       return;
     }
+
     switch (action) {
       case "confirm": {
         await prisma.auction.delete({

src/commands/auctions/delete/interactionListeners/auctionID-autocomplete.ts

@@ -5,6 +5,11 @@ import { kv, prisma } from "$src/central.config";
 import { client } from "$src/discord/client";
 import getLinkedMinionAHUser from "$src/shared/user/getLinkedMinionAHUser";
 
+
+/**
+ * Handles the autocomplete interaction for the auction ID
+ * option in the auctions delete command, option `auction
+ */
 client.on("interactionCreate", async (interaction) => {
   if (!interaction.isAutocomplete()) return;
   if (interaction.commandName !== "auctions") return;

src/commands/auctions/delete/interactionListeners/base.ts

@@ -7,6 +7,13 @@ import getLinkedMinionAHUser from "$src/shared/user/getLinkedMinionAHUser";
 import { MessageFlags, PrimaryEntryPointCommandInteraction } from "discord.js";
 import auctionsDeleteComponents from "../util/auctionsDeleteComponents";
 
+
+/**
+ * Base listener of the auction delete command. Verifies that the user
+ * has a linked MinionAH account and that the specified auction
+ * exists and belongs to them. If so, generates a confirmation
+ * display container for deletion.
+ */
 client.on("interactionCreate", async (interaction) => {
   if (!interaction.isCommand()) return;
   if (interaction instanceof PrimaryEntryPointCommandInteraction) return;

src/commands/auctions/myauctions/myauctions.ts

@@ -17,6 +17,13 @@ export default new SlashCommandSubcommandBuilder()
   .setName("myauctions")
   .setDescription("List your auctions");
 
+
+/**
+ * Master (only) listener of the myauctions subcommand. Auction listings can
+ * be handled by SearchSequence extensions using custom auction getters.
+ * This listener verifies that the user has a linked MinionAH account
+ * and initializes a SearchSequence to display their auctions.
+ */
 client.on("interactionCreate", async (interaction) => {
   if (!interaction.isCommand()) return;
   if (interaction instanceof PrimaryEntryPointCommandInteraction) return;

src/commands/auctions/myauctions/util/getMyAuctionsConstructor.ts

@@ -10,7 +10,8 @@ interface GetAuctionsConfig {
 }
 
 /**
- * Template function to get auctions for a specific user
+ * Template function to get auctions for a specific user.
+ * The resulting auctionGetter is used as the getter in SearchSequence
  * @param userID
  * @returns
  */
@@ -35,11 +36,11 @@ export default function getMyAuctionsConstructor(userID: string) {
         // check for both minion type and tier
         ...(minionType && minionTier
           ? {
-              minion_id: {
-                contains: minionType.toUpperCase(),
-                endsWith: "\\_" + minionTier
-              }
+            minion_id: {
+              contains: minionType.toUpperCase(),
+              endsWith: "\\_" + minionTier
             }
+          }
           : {}),
         user_id: userID
       },
@@ -65,11 +66,11 @@ export default function getMyAuctionsConstructor(userID: string) {
         // check for both minion type and tier
         ...(minionType && minionTier
           ? {
-              minion_id: {
-                contains: minionType.toUpperCase(),
-                endsWith: "\\_" + minionTier
-              }
+            minion_id: {
+              contains: minionType.toUpperCase(),
+              endsWith: "\\_" + minionTier
             }
+          }
           : {}),
         user_id: userID
       }