Merge branch 'develop' into feature/311-upgrade-glob-v11

- Created a  command for admins to see what cards have been added by type
- Added this information to the logger

#350

.env.example

@@ -7,7 +7,7 @@
 # any secret values.
 
 BOT_TOKEN=
-BOT_VER=0.8.0
+BOT_VER=0.8.1
 BOT_AUTHOR=Vylpes
 BOT_OWNERID=147392775707426816
 BOT_CLIENTID=682942374040961060

package.json

@@ -1,6 +1,6 @@
 {
   "name": "card-drop",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "main": "./dist/bot.js",
   "typings": "./dist",
   "scripts": {

src/Functions/CardMetadataFunction.ts

@@ -5,6 +5,7 @@ import { glob } from "glob";
 import { SeriesMetadata } from "../contracts/SeriesMetadata";
 import { CoreClient } from "../client/client";
 import AppLogger from "../client/appLogger";
+import {CardRarity} from "../constants/CardRarity";
 
 export interface CardMetadataResult {
     IsSuccess: boolean;
@@ -37,7 +38,22 @@ export default class CardMetadataFunction {
 
         if (cardResult.IsSuccess) {
             CoreClient.Cards = cardResult.Result!;
-            AppLogger.LogInfo("Functions/CardMetadataFunction", `Loaded ${CoreClient.Cards.flatMap(x => x.cards).length} cards to database`);
+
+            const allCards = CoreClient.Cards.flatMap(x => x.cards);
+
+            const totalCards = allCards.length;
+            const bronzeCards = allCards.filter(x => x.type == CardRarity.Bronze)
+                .length;
+            const silverCards = allCards.filter(x => x.type == CardRarity.Silver)
+                .length;
+            const goldCards = allCards.filter(x => x.type == CardRarity.Gold)
+                .length;
+            const mangaCards = allCards.filter(x => x.type == CardRarity.Manga)
+                .length;
+            const legendaryCards = allCards.filter(x => x.type == CardRarity.Legendary)
+                .length;
+
+            AppLogger.LogInfo("Functions/CardMetadataFunction", `Loaded ${totalCards} cards to database (${bronzeCards} bronze, ${silverCards} silver, ${goldCards} gold, ${mangaCards} manga, ${legendaryCards} legendary)`);
 
             const duplicateCards = CoreClient.Cards.flatMap(x => x.cards)
                 .filter((card, index, self) => self.findIndex(c => c.id === card.id) !== index);

src/commands/stats.ts

@@ -0,0 +1,51 @@
+import {CommandInteraction, EmbedBuilder, PermissionsBitField, SlashCommandBuilder} from "discord.js";
+import {Command} from "../type/command";
+import {CoreClient} from "../client/client";
+import {CardRarity} from "../constants/CardRarity";
+import EmbedColours from "../constants/EmbedColours";
+
+export default class Stats extends Command {
+    constructor() {
+        super();
+
+        this.CommandBuilder = new SlashCommandBuilder()
+            .setName("stats")
+            .setDescription("Get bot stats such as card info")
+            .setDefaultMemberPermissions(PermissionsBitField.Flags.Administrator);
+    }
+
+    public override async execute(interaction: CommandInteraction) {
+        const allCards = CoreClient.Cards.flatMap(x => x.cards);
+
+        const totalCards = allCards.length;
+        const bronzeCards = allCards.filter(x => x.type == CardRarity.Bronze)
+            .length;
+        const silverCards = allCards.filter(x => x.type == CardRarity.Silver)
+            .length;
+        const goldCards = allCards.filter(x => x.type == CardRarity.Gold)
+            .length;
+        const mangaCards = allCards.filter(x => x.type == CardRarity.Manga)
+            .length;
+        const legendaryCards = allCards.filter(x => x.type == CardRarity.Legendary)
+            .length;
+
+        const description = [
+            `${totalCards} Total`,
+            `${bronzeCards} Bronze`,
+            `${silverCards} Silver`,
+            `${goldCards} Gold`,
+            `${mangaCards} Manga`,
+            `${legendaryCards} Legendary`,
+        ].join("\n");
+
+        const embed = new EmbedBuilder()
+            .setTitle("Stats")
+            .setDescription(description)
+            .setColor(EmbedColours.Ok);
+
+        await interaction.reply({
+            embeds: [ embed ],
+            ephemeral: true,
+        });
+    }
+}

src/contracts/SeriesMetadata.ts

@@ -12,6 +12,7 @@ export interface CardMetadata {
     type: CardRarity,
     path: string,
     subseries?: string,
+    colour?: string,
 }
 
 export interface DropResult {

src/helpers/CardDropHelperMetadata.ts

@@ -5,6 +5,7 @@ import { DropResult } from "../contracts/SeriesMetadata";
 import { CoreClient } from "../client/client";
 import AppLogger from "../client/appLogger";
 import CardConstants from "../constants/CardConstants";
+import StringTools from "./StringTools";
 
 export default class CardDropHelperMetadata {
     public static GetRandomCard(): DropResult | undefined {
@@ -82,12 +83,25 @@ export default class CardDropHelperMetadata {
         AppLogger.LogSilly("CardDropHelperMetadata/GenerateDropEmbed", `Parameters: drop=${drop.card.id}, quantityClaimed=${quantityClaimed}, imageFileName=${imageFileName}`);
 
         const description = drop.card.subseries ?? drop.series.name;
+        let colour = CardRarityToColour(drop.card.type);
+
+        if (drop.card.colour && StringTools.IsHexCode(drop.card.colour)) {
+            const hexCode = Number("0x" + drop.card.colour);
+
+            if (hexCode) {
+                colour = hexCode; 
+            } else {
+                AppLogger.LogWarn("CardDropHelperMetadata/GenerateDropEmbed", `Card's colour override is invalid: ${drop.card.id}, ${drop.card.colour}`);
+            }
+        } else if (drop.card.colour) {
+            AppLogger.LogWarn("CardDropHelperMetadata/GenerateDropEmbed", `Card's colour override is invalid: ${drop.card.id}, ${drop.card.colour}`);
+        }
 
         const embed = new EmbedBuilder()
             .setTitle(drop.card.name)
             .setDescription(description)
             .setFooter({ text: `${CardRarityToString(drop.card.type)} · ${drop.card.id}` })
-            .setColor(CardRarityToColour(drop.card.type))
+            .setColor(colour)
             .setImage(`attachment://${imageFileName}`)
             .addFields([
                 {

src/helpers/SeriesHelper.ts

@@ -31,7 +31,7 @@ export default class SeriesHelper {
         const cardsOnPage = series.cards.splice(page * itemsPerPage, itemsPerPage);
 
         const description = cardsOnPage
-            .map(x => `[${x.id}] ${x.name} ${CardRarityToString(x.type).toUpperCase()}`)
+            .map(x => `[${x.id}] ${x.name} (${CardRarityToString(x.type)})`)
             .join("\n");
 
         const embed = new EmbedBuilder()

src/helpers/StringTools.ts

@@ -39,4 +39,18 @@ export default class StringTools {
     public static ReplaceAll(str: string, find: string, replace: string) {
         return str.replace(new RegExp(find, "g"), replace);
     }
+
+    public static IsHexCode(str: string): boolean {
+        if (str.length != 6) return false;
+
+        const characters = "0123456789abcdefABCDEF";
+
+        for (let i = 0; i < 6; i++) {
+            const char = str[i];
+
+            if (!characters.includes(char)) return false;
+        }
+
+        return true;
+    }
 }

src/registry.ts

@@ -14,6 +14,7 @@ import Inventory from "./commands/inventory";
 import Resync from "./commands/resync";
 import Sacrifice from "./commands/sacrifice";
 import Series from "./commands/series";
+import Stats from "./commands/stats";
 import Trade from "./commands/trade";
 import View from "./commands/view";
 
@@ -45,6 +46,7 @@ export default class Registry {
         CoreClient.RegisterCommand("resync", new Resync());
         CoreClient.RegisterCommand("sacrifice", new Sacrifice());
         CoreClient.RegisterCommand("series", new Series());
+        CoreClient.RegisterCommand("stats", new Stats());
         CoreClient.RegisterCommand("trade", new Trade());
         CoreClient.RegisterCommand("view", new View());