feat: museum

prisma/migrations/20260302041732_museum/migration.sql

@@ -0,0 +1,12 @@
+-- CreateTable
+CREATE TABLE "Museum" (
+    "userId" TEXT NOT NULL,
+    "itemId" TEXT NOT NULL,
+    "amount" BIGINT NOT NULL,
+    "completedAt" TIMESTAMP(3),
+
+    CONSTRAINT "Museum_pkey" PRIMARY KEY ("userId","itemId")
+);
+
+-- AddForeignKey
+ALTER TABLE "Museum" ADD CONSTRAINT "Museum_userId_fkey" FOREIGN KEY ("userId") REFERENCES "Economy"("userId") ON DELETE CASCADE ON UPDATE CASCADE;

prisma/schema.prisma

@@ -222,6 +222,7 @@ model Economy {
   Boosters           Booster[]
   EconomyWorker      EconomyWorker[]
   Inventory          Inventory[]
+  Museum             Museum[]
   Crafting           Crafting[]
   Game               Game[]
   Stats              Stats[]
@@ -377,6 +378,18 @@ model Inventory {
   @@id([userId, item])
 }
 
+model Museum {
+  userId String
+
+  itemId        String
+  amount        BigInt
+  completedAt   DateTime?
+
+  economy Economy @relation(fields: [userId], references: [userId], onDelete: Cascade)
+
+  @@id([userId, itemId])
+}
+
 model EconomyWorker {
   userId   String
   workerId String

src/commands/museum.ts

@@ -0,0 +1,298 @@
+import {
+  ButtonBuilder,
+  ButtonStyle,
+  CommandInteraction,
+  ContainerBuilder,
+  Interaction,
+  Message,
+  MessageFlags,
+  resolveColor,
+  StringSelectMenuBuilder,
+  StringSelectMenuOptionBuilder,
+  TextDisplayBuilder,
+} from "discord.js";
+import { inPlaceSort } from "fast-sort";
+import { Command, NypsiCommandInteraction, NypsiMessage, SendMessage } from "../models/Command";
+import { ErrorEmbed, getColor } from "../models/EmbedBuilders";
+import { getInventory } from "../utils/functions/economy/inventory";
+import { addToMuseum, getMuseum } from "../utils/functions/economy/museum";
+import { getItems } from "../utils/functions/economy/utils";
+import PageManager from "../utils/functions/page";
+import { addCooldown, getResponse, onCooldown } from "../utils/handlers/cooldownhandler";
+
+const cmd = new Command("museum", "view your museum progress", "money");
+
+cmd.slashEnabled = true;
+cmd.slashData
+  .addSubcommand((progress) =>
+    progress.setName("donate").setDescription("donate an item to the museum"),
+  )
+  .addSubcommand((view) =>
+    view
+      .setName("view")
+      .setDescription("view your museum")
+      .addStringOption((option) =>
+        option
+          .setName("museum-category")
+          .setDescription("the category you want to view")
+          .setAutocomplete(true),
+      ),
+  );
+
+async function run(
+  message: NypsiMessage | (NypsiCommandInteraction & CommandInteraction),
+  send: SendMessage,
+  args: string[],
+) {
+  if (await onCooldown(cmd.name, message.member)) {
+    const res = await getResponse(cmd.name, message.member);
+
+    if (res.respond) send({ embeds: [res.embed] });
+    return;
+  }
+
+  //TODO: change where this is + duration
+  await addCooldown(cmd.name, message.member, 1);
+
+  const items = getItems();
+
+  const itemCategories = [
+    ...new Set(
+      Object.values(items)
+        .map((item) => item.museum?.category)
+        .filter(Boolean),
+    ),
+  ].sort();
+
+  itemCategories.unshift("home");
+
+  let inventory = await getInventory(message.member);
+
+  const categorySelectMenu = (disabled = false, selected = "home") => {
+    return new StringSelectMenuBuilder()
+      .setCustomId(`select-category`)
+      .setDisabled(disabled)
+      .addOptions(
+        itemCategories.map((category) => {
+          return new StringSelectMenuOptionBuilder()
+            .setLabel(category)
+            .setValue(category)
+            .setDefault(category == selected);
+        }),
+      );
+  };
+
+  const doCategorySelect = async (interaction: Interaction) => {
+    if (!interaction.isStringSelectMenu() || interaction.customId != "select-category")
+      return false;
+    return interaction.values[0];
+  };
+
+  let msg: Message;
+
+  const homeView = async () => {
+    const container = (disabled = false) =>
+      new ContainerBuilder()
+        .setAccentColor(resolveColor(getColor(message.member)))
+        .addTextDisplayComponents(new TextDisplayBuilder().setContent("## museum"))
+        .addSeparatorComponents((separator) => separator)
+        .addTextDisplayComponents(new TextDisplayBuilder().setContent("select a category of item"))
+        .addActionRowComponents((row) => row.addComponents(categorySelectMenu(disabled)));
+
+    if (msg) {
+      await msg.edit({
+        flags: MessageFlags.IsComponentsV2,
+        components: [container()],
+      });
+    } else {
+      msg = await send({
+        flags: MessageFlags.IsComponentsV2,
+        components: [container()],
+      });
+    }
+
+    const filter = (i: Interaction) => i.user.id == message.author.id;
+
+    const pageManager: any = async () => {
+      let fail = false;
+
+      const response = await msg
+        .awaitMessageComponent({ filter, time: 60000 })
+        .then(async (collected) => {
+          await collected.deferUpdate().catch(() => {
+            fail = true;
+            return pageManager();
+          });
+          return { res: collected.customId, interaction: collected };
+        })
+        .catch(async () => {
+          fail = true;
+          await msg.edit({ flags: MessageFlags.IsComponentsV2, components: [container(true)] });
+        });
+
+      if (fail) return;
+      if (!response) return;
+
+      const { res, interaction } = response;
+
+      const categorySelect = await doCategorySelect(interaction);
+
+      if (categorySelect) {
+        inventory = await getInventory(message.member);
+        return categoryView(categorySelect);
+      }
+
+      inventory = await getInventory(message.member);
+      await msg.edit({ flags: MessageFlags.IsComponentsV2, components: [container()] });
+      return pageManager();
+    };
+
+    return pageManager();
+  };
+
+  const categoryView = async (category: string) => {
+    const itemsInCategory = Object.values(items).filter((i) => i.museum?.category == category);
+    const museum = await getMuseum(message.member);
+
+    const desc: string[] = [];
+
+    inPlaceSort(itemsInCategory).asc((item) => item.id);
+
+    for (const item of itemsInCategory) {
+      desc.push(
+        `### ${item.emoji} ${item.name}\n` +
+          `donated **${museum.count(item)}/${item.museum.threshold}**${museum.completed(item) ? ` - completed <t:${Math.floor(new Date(museum.completedAt(item)).getTime() / 1000)}:R> (#**${await museum.completedPlacement(item)}**)` : ""}` +
+          ``,
+      );
+    }
+
+    const pages = PageManager.createPages(desc, 8);
+    let currentPage = 1;
+
+    const container = (disabled = false) => {
+      const builder = new ContainerBuilder()
+        .setAccentColor(resolveColor(getColor(message.member)))
+        .addTextDisplayComponents(
+          new TextDisplayBuilder().setContent(
+            `## ${message.member.user.username}'s museum - ${category}`,
+          ),
+        )
+        .addSeparatorComponents((separator) => separator)
+        .addTextDisplayComponents(
+          new TextDisplayBuilder().setContent(pages.get(currentPage).join("\n")),
+        );
+
+      if (pages.size > 1) {
+        builder
+          .addTextDisplayComponents(
+            new TextDisplayBuilder().setContent(`-# page ${currentPage}/${pages.size}`),
+          )
+          .addActionRowComponents((row) =>
+            row.addComponents(
+              new ButtonBuilder()
+                .setCustomId("⬅")
+                .setLabel("back")
+                .setStyle(ButtonStyle.Primary)
+                .setDisabled(disabled || currentPage == 1),
+              new ButtonBuilder()
+                .setCustomId("➡")
+                .setLabel("next")
+                .setStyle(ButtonStyle.Primary)
+                .setDisabled(disabled || currentPage == pages.size),
+            ),
+          );
+      }
+
+      return builder
+        .addSeparatorComponents((separator) => separator)
+        .addTextDisplayComponents(new TextDisplayBuilder().setContent("select a category of item"))
+        .addActionRowComponents((row) => row.addComponents(categorySelectMenu(disabled, category)));
+    };
+
+    if (msg) {
+      await msg.edit({
+        flags: MessageFlags.IsComponentsV2,
+        components: [container()],
+      });
+    } else {
+      msg = await send({
+        flags: MessageFlags.IsComponentsV2,
+        components: [container()],
+      });
+    }
+
+    const filter = (i: Interaction) => i.user.id == message.author.id;
+
+    const pageManager: any = async () => {
+      let fail = false;
+
+      const response = await msg
+        .awaitMessageComponent({ filter, time: 60000 })
+        .then(async (collected) => {
+          await collected.deferUpdate().catch(() => {
+            fail = true;
+            return pageManager();
+          });
+          return { res: collected.customId, interaction: collected };
+        })
+        .catch(async () => {
+          fail = true;
+          await msg.edit({ flags: MessageFlags.IsComponentsV2, components: [container(true)] });
+        });
+
+      if (fail) return;
+      if (!response) return;
+
+      const { res, interaction } = response;
+
+      const categorySelect = await doCategorySelect(interaction);
+
+      if (categorySelect) {
+        inventory = await getInventory(message.member);
+        return categorySelect == "home" ? homeView() : categoryView(categorySelect);
+      } else if (res == "➡") {
+        if (currentPage < pages.size) currentPage++;
+      } else if (res == "⬅") {
+        if (currentPage > 1) currentPage--;
+      }
+
+      inventory = await getInventory(message.member);
+      await msg.edit({ flags: MessageFlags.IsComponentsV2, components: [container()] });
+      return pageManager();
+    };
+
+    return pageManager();
+  };
+
+  if (args[0]?.toLowerCase() == "donate") {
+    if (args.length < 2) {
+      return send({ embeds: [new ErrorEmbed("/museum donate <item> <amount>")] });
+    }
+
+    let itemId = args[1].toLowerCase();
+
+    if (!items[itemId]) {
+      return send({ embeds: [new ErrorEmbed("invalid item")] });
+    }
+
+    let amount = args.length == 2 ? 1 : parseInt(args[2]);
+
+    if (amount <= 0 || isNaN(amount) || !amount) {
+      return send({ embeds: [new ErrorEmbed("invalid amount")] });
+    }
+
+    // TEMP - always add
+    await addToMuseum(message.member, itemId, amount);
+  } else if (args.length) {
+    if (args[0]?.toLowerCase() == "view") args.shift();
+    if (args.length == 0 || args[0].toLowerCase() == "home") return homeView();
+    let category = args[0]?.toLowerCase();
+    if (itemCategories.includes(category)) {
+      return categoryView(category);
+    } else return send({ embeds: [new ErrorEmbed(`could not find category \`${category}\``)] });
+  } else return homeView();
+}
+
+cmd.setRun(run);
+
+module.exports = cmd;

src/interactions/museum_category.ts

@@ -0,0 +1,20 @@
+import { AutocompleteHandler } from "../types/InteractionHandler";
+import { getItems } from "../utils/functions/economy/utils";
+
+export default {
+  name: "museum-category",
+  type: "autocomplete",
+  async run(interaction) {
+    return await interaction.respond(
+      [
+        ...new Set(
+          Object.values(getItems())
+            .map((item) => item.museum?.category)
+            .filter(Boolean),
+        ),
+      ]
+        .sort()
+        .map((category) => ({ name: category, value: category })),
+    );
+  },
+} as AutocompleteHandler;

src/types/Economy.ts

@@ -9,6 +9,11 @@ export interface Item {
   buy?: number;
   sell?: number;
   role: string;
+  museum?: {
+    category: string;
+    threshold: number;
+    no_overflow?: boolean;
+  };
   default_count?: number;
   booster_desc?: string;
   aliases?: string[];

src/utils/Constants.ts

@@ -253,6 +253,7 @@ export default {
         GUILD_USER: "cache:economy:guild:user",
         GUILD_UPGRADES: "cache:economy:guild:upgrades",
         INVENTORY: "cache:economy:inventory",
+        MUSEUM: "cache:economy:museum",
         NETWORTH: "cache:economy:networth",
         PADLOCK: "cache:economy:padlock",
         PASSIVE: "cache:economy:passive",