From 37620144d8687cfc927c8664182a9fbf341f2f1a Mon Sep 17 00:00:00 2001
From: tkaixiang28 <kai_xiang_teo_from.tp@imda.gov.sg>
Date: Fri, 19 Jul 2024 15:10:28 +0800
Subject: [PATCH] update version

---
 Commands/sphelp.ts | 425 ++++++++++++++++++++++++---------------------
 constants.ts       |   2 +
 index.ts           |  35 ++--
 3 files changed, 245 insertions(+), 217 deletions(-)
 create mode 100644 constants.ts

diff --git a/Commands/sphelp.ts b/Commands/sphelp.ts
index 51b59a7..07c9a75 100644
--- a/Commands/sphelp.ts
+++ b/Commands/sphelp.ts
@@ -1,217 +1,242 @@
-import { ChatInputCommandInteraction} from "discord.js";
+import { ChatInputCommandInteraction } from "discord.js";
+import { UPDATE_DATA, UPDATE_DATE, VERSION } from "../constants";
 
-const sphelp = async (interaction: ChatInputCommandInteraction): Promise<boolean> => {
-    
+const sphelp = async (
+  interaction: ChatInputCommandInteraction,
+): Promise<boolean> => {
+  const helpEmbed: { fields: Array<any>; [key: string]: any } = {
+    title: "Storeman Bot Command Help",
+    fields: [],
+  };
 
-    const helpEmbed: {fields: Array<any>, [key: string]: any} = {
-        title: "Storeman Bot Command Help",
-        fields: [],
-    }
-
-    let embedList = []
+  let embedList = [];
 
-    const commandList = [
-        {
-            name: "/sphelp",
-            value: "Displays this message."
-        },
-        {
-            name: "/spstatus <filter❓> <stockpile❓> <stockpile_group❓>  🙍‍♂️",
-            value: 'Displays the current full stockpile status if no options are specified. \n\nSpecify a `<stockpile>` to show only details for that stockpile, **do not** specify `<filter>` if this option is specified.\n\n `<filter>` can be "Targets" to display only targets or "Group Targets" to display stockpile group targets.\n\n Specify a `<stockpile_group>` to show that stockpile group target only.'
-        },
-        {
-            name: "/spsetamount <item> <amount> <stockpile>  🙍‍♂️",
-            value: "Sets the \`<amount>\` that an \`<item>\` has in **__crates__** inside the \`<stockpile>\`. (E.g \`/spsetamount set Basic Materials Crate 100\`)"
-        },
-        {
-            name: "/spfind <item>  🙍‍♂️",
-            value: "Searches through all the stockpiles for the <item> specified and returns which stockpile has the item."
-        },
-        {
-            name: "/sprefresh <stockpile❓>  🙍‍♂️",
-            value: "Refreshes the timer of **ALL stockpiles** if **no name is specified**, or the timer of \`<stockpile>\`"
-        },
-        {
-            name: "/sptarget set <item> <minimum_amount> <maximum_amount❓> <production_location❓>  👨‍⚖️",
-            value: "Sets the target \`<minimum_amount>\` that an \`<item>\` should have in **__crates__**. (E.g \`/sptarget set Basic Materials Crate 100\`)"
-        },
-        {
-            name: "/sptarget remove <item>  👨‍⚖️",
-            value: "Removes a target item off the stockpile."
-        },
-        {
-            name: "/spstockpile add <stockpile>  👨‍⚖️",
-            value: "Adds an EMPTY stockpile with the name <stockpile>."
-        },
-        {
-            name: "/spstockpile remove <stockpile>  👨‍⚖️",
-            value: "Removes the <stockpile> from the stockpile status and listings."
-        },
-        {
-            name: "/spstockpile purge  👨‍⚖️",
-            value: "Purges all stockpiles and their related information such as pretty names and order settings."
-        },
-        {
-            name: "/spsetpassword <password>  👨‍⚖️",
-            value: "Sets the password used to update information to the HTTP endpoint from the Stockpiler app."
-        },
-        {
-            name: "/splogichannel set <channel>  👨‍⚖️",
-            value: "Sets a logi channel in which stockpile information would always be displayed and updated on."
-        },
-        {
-            name: "/splogichannel remove  👨‍⚖️",
-            value: "Removes a logi channel in which stockpile information would always be displayed and updated on."
-        },
-        {
-            name: "/sprole add <perms> <role>  👨‍⚖️",
-            value: 'Add a role which will be allowed to have <perms>. <perms> can be either "Admin" or "User".'
-        },
-        {
-            name: "/sprole remove <role>  👨‍⚖️",
-            value: "Removes a role from whatever permissions they have."
-        },
-        {
-            name: "/spuser add <perms> <user>  👨‍⚖️",
-            value: 'Add a user which will be allowed to have <perms>. <perms> can be either "Admin" or "User".'
-        },
-        {
-            name: "/spuser remove <user>  👨‍⚖️",
-            value: "Removes a user from whatever permissions they have."
-        },
-        {
-            name: "/spsetorder <stockpile> <order>  👨‍⚖️",
-            value: "Sets the <order> of a <stockpile> in the logi channel message."
-        },
-        {
-            name: "/spsettimeleft <stockpile> <time>  👨‍⚖️",
-            value: "Sets the time left for a reserve <stockpile> before it expires. **NOTE:** <time> is a **UNIX TIMESTAMP**"
-        },
-        {
-            name: "/spnotif add <role>  👨‍⚖️",
-            value: "Adds a <role> to the notification stockpile expiry warning mention list."
-        },
-        {
-            name: "/spnotif remove <role>  👨‍⚖️",
-            value: "Removes a <role> to the notification stockpile expiry warning mention list."
-        },
-        {
-            name: "/spprettyname add <stockpile> <pretty_name>  👨‍⚖️",
-            value: "Adds a <pretty_name> to the <stockpile>. Pretty names are alternative names used to display the stockpile name instead of the original name."
-        },
-        {
-            name: "/spprettyname remove <stockpile>  👨‍⚖️",
-            value: "Removes a pretty name from the <stockpile>. Pretty names are alternative names used to display the stockpile name instead of the original name."
-        },
-        {
-            name: "/spcode add <stockpile> <code>  👨‍⚖️",
-            value: "Adds a stockpile <code> to the <stockpile> specified."
-        },
-        {
-            name: "/spcode remove <stockpile>  👨‍⚖️",
-            value: "Removes the specified stockpile code from the <stockpile>."
-        },
-        {
-            name: "/sploc add <stockpile> <location>  👨‍⚖️",
-            value: "Adds a stockpile <location> to the <stockpile> specified. "
-        },
-        {
-            name: "/sploc remove <stockpile>  👨‍⚖️",
-            value: "Removes the specified stockpile location from the <stockpile>."
-        },
-        {
-            name: "/sploc list  👨‍⚖️",
-            value: "Lists all the possible location codes with their respective full location translations."
-        },
-        {
-            name: "/spdisabletime <disabled> 👨‍⚖️",
-            value: "Whether or not to disable the time-checking feature of Storeman Bot"
-        },
-        {
-            name: "/spgroup create <name> 👨‍⚖️",
-            value: "Creates a stockpile group with <name>"
-        },
-        {
-            name: "/spgroup delete <name> 👨‍⚖️",
-            value: "Removes stockpile group with <name>"
-        },
-        {
-            name: "/spgroup addstockpile <name> <stockpileName> 👨‍⚖️",
-            value: "Adds the stockpile with <stockpileName> to the stockpile group with <name>"
-        },
-        {
-            name: "/spgroup removestockpile <name> 👨‍⚖️",
-            value: "Removes the stockpile with <stockpileName> from the stockpile group with <name>"
-        },
-        {
-            name: "/spgroup settarget <name> <item> <minimum_amount> <maximum_amount❓> <production_location❓> 👨‍⚖️",
-            value: "Sets targets for the stockpile group with <name>, along with \`<minimum_amount>\` that an \`<item>\` should have in **__crates__**. (E.g \`/sptarget set Basic Materials Crate 100\`)"
-        },
-        {
-            name: "/spgroup removetarget <name> <item> 👨‍⚖️",
-            value: "Removes the target <item> from stockpile group targets list with <name>"
-        },
-        
+  const commandList = [
+    {
+      name: "/sphelp",
+      value: "Displays this message.",
+    },
+    {
+      name: "/spstatus <filter❓> <stockpile❓> <stockpile_group❓>  🙍‍♂️",
+      value:
+        'Displays the current full stockpile status if no options are specified. \n\nSpecify a `<stockpile>` to show only details for that stockpile, **do not** specify `<filter>` if this option is specified.\n\n `<filter>` can be "Targets" to display only targets or "Group Targets" to display stockpile group targets.\n\n Specify a `<stockpile_group>` to show that stockpile group target only.',
+    },
+    {
+      name: "/spsetamount <item> <amount> <stockpile>  🙍‍♂️",
+      value:
+        "Sets the `<amount>` that an `<item>` has in **__crates__** inside the `<stockpile>`. (E.g `/spsetamount set Basic Materials Crate 100`)",
+    },
+    {
+      name: "/spfind <item>  🙍‍♂️",
+      value:
+        "Searches through all the stockpiles for the <item> specified and returns which stockpile has the item.",
+    },
+    {
+      name: "/sprefresh <stockpile❓>  🙍‍♂️",
+      value:
+        "Refreshes the timer of **ALL stockpiles** if **no name is specified**, or the timer of `<stockpile>`",
+    },
+    {
+      name: "/sptarget set <item> <minimum_amount> <maximum_amount❓> <production_location❓>  👨‍⚖️",
+      value:
+        "Sets the target `<minimum_amount>` that an `<item>` should have in **__crates__**. (E.g `/sptarget set Basic Materials Crate 100`)",
+    },
+    {
+      name: "/sptarget remove <item>  👨‍⚖️",
+      value: "Removes a target item off the stockpile.",
+    },
+    {
+      name: "/spstockpile add <stockpile>  👨‍⚖️",
+      value: "Adds an EMPTY stockpile with the name <stockpile>.",
+    },
+    {
+      name: "/spstockpile remove <stockpile>  👨‍⚖️",
+      value: "Removes the <stockpile> from the stockpile status and listings.",
+    },
+    {
+      name: "/spstockpile purge  👨‍⚖️",
+      value:
+        "Purges all stockpiles and their related information such as pretty names and order settings.",
+    },
+    {
+      name: "/spsetpassword <password>  👨‍⚖️",
+      value:
+        "Sets the password used to update information to the HTTP endpoint from the Stockpiler app.",
+    },
+    {
+      name: "/splogichannel set <channel>  👨‍⚖️",
+      value:
+        "Sets a logi channel in which stockpile information would always be displayed and updated on.",
+    },
+    {
+      name: "/splogichannel remove  👨‍⚖️",
+      value:
+        "Removes a logi channel in which stockpile information would always be displayed and updated on.",
+    },
+    {
+      name: "/sprole add <perms> <role>  👨‍⚖️",
+      value:
+        'Add a role which will be allowed to have <perms>. <perms> can be either "Admin" or "User".',
+    },
+    {
+      name: "/sprole remove <role>  👨‍⚖️",
+      value: "Removes a role from whatever permissions they have.",
+    },
+    {
+      name: "/spuser add <perms> <user>  👨‍⚖️",
+      value:
+        'Add a user which will be allowed to have <perms>. <perms> can be either "Admin" or "User".',
+    },
+    {
+      name: "/spuser remove <user>  👨‍⚖️",
+      value: "Removes a user from whatever permissions they have.",
+    },
+    {
+      name: "/spsetorder <stockpile> <order>  👨‍⚖️",
+      value: "Sets the <order> of a <stockpile> in the logi channel message.",
+    },
+    {
+      name: "/spsettimeleft <stockpile> <time>  👨‍⚖️",
+      value:
+        "Sets the time left for a reserve <stockpile> before it expires. **NOTE:** <time> is a **UNIX TIMESTAMP**",
+    },
+    {
+      name: "/spnotif add <role>  👨‍⚖️",
+      value:
+        "Adds a <role> to the notification stockpile expiry warning mention list.",
+    },
+    {
+      name: "/spnotif remove <role>  👨‍⚖️",
+      value:
+        "Removes a <role> to the notification stockpile expiry warning mention list.",
+    },
+    {
+      name: "/spprettyname add <stockpile> <pretty_name>  👨‍⚖️",
+      value:
+        "Adds a <pretty_name> to the <stockpile>. Pretty names are alternative names used to display the stockpile name instead of the original name.",
+    },
+    {
+      name: "/spprettyname remove <stockpile>  👨‍⚖️",
+      value:
+        "Removes a pretty name from the <stockpile>. Pretty names are alternative names used to display the stockpile name instead of the original name.",
+    },
+    {
+      name: "/spcode add <stockpile> <code>  👨‍⚖️",
+      value: "Adds a stockpile <code> to the <stockpile> specified.",
+    },
+    {
+      name: "/spcode remove <stockpile>  👨‍⚖️",
+      value: "Removes the specified stockpile code from the <stockpile>.",
+    },
+    {
+      name: "/sploc add <stockpile> <location>  👨‍⚖️",
+      value: "Adds a stockpile <location> to the <stockpile> specified. ",
+    },
+    {
+      name: "/sploc remove <stockpile>  👨‍⚖️",
+      value: "Removes the specified stockpile location from the <stockpile>.",
+    },
+    {
+      name: "/sploc list  👨‍⚖️",
+      value:
+        "Lists all the possible location codes with their respective full location translations.",
+    },
+    {
+      name: "/spdisabletime <disabled> 👨‍⚖️",
+      value:
+        "Whether or not to disable the time-checking feature of Storeman Bot",
+    },
+    {
+      name: "/spgroup create <name> 👨‍⚖️",
+      value: "Creates a stockpile group with <name>",
+    },
+    {
+      name: "/spgroup delete <name> 👨‍⚖️",
+      value: "Removes stockpile group with <name>",
+    },
+    {
+      name: "/spgroup addstockpile <name> <stockpileName> 👨‍⚖️",
+      value:
+        "Adds the stockpile with <stockpileName> to the stockpile group with <name>",
+    },
+    {
+      name: "/spgroup removestockpile <name> 👨‍⚖️",
+      value:
+        "Removes the stockpile with <stockpileName> from the stockpile group with <name>",
+    },
+    {
+      name: "/spgroup settarget <name> <item> <minimum_amount> <maximum_amount❓> <production_location❓> 👨‍⚖️",
+      value:
+        "Sets targets for the stockpile group with <name>, along with `<minimum_amount>` that an `<item>` should have in **__crates__**. (E.g `/sptarget set Basic Materials Crate 100`)",
+    },
+    {
+      name: "/spgroup removetarget <name> <item> 👨‍⚖️",
+      value:
+        "Removes the target <item> from stockpile group targets list with <name>",
+    },
+  ];
 
-    ]
-
-    for (let i = 0; i < commandList.length-1; i++) {
-        if (commandList[i].name !== "\u200b") {
-            commandList.splice(i+1, 0, {name: "\u200b", value: "\u200b"})
-        }
+  for (let i = 0; i < commandList.length - 1; i++) {
+    if (commandList[i].name !== "\u200b") {
+      commandList.splice(i + 1, 0, { name: "\u200b", value: "\u200b" });
     }
+  }
 
-
-    while (commandList.length > 0) {
-        if (commandList.length > 25) {
-            if (helpEmbed.fields.length === 0){
-                helpEmbed.fields = commandList.splice(0, 25)
-                await interaction.editReply({content: "Help Message", embeds: [helpEmbed]})
-            }
-            else {
-                embedList.push({
-                    fields: commandList.splice(0, 25)
-                })
-            }
-        }
-        else {
-            if (helpEmbed.fields.length === 0){
-                helpEmbed.fields = commandList.splice(0, commandList.length)
-                await interaction.editReply({content: "Help Message", embeds: [helpEmbed]})
-            }
-            else {
-                embedList.push({
-                    fields: commandList.splice(0, commandList.length)
-                })
-            }
-        }
-    }
-
-    // Send calculated list of embeds
-    for (let i = 0; i < embedList.length; i++) {
-        await interaction.followUp({
-            embeds: [embedList[i]],
-            ephemeral: true
-        })
+  while (commandList.length > 0) {
+    if (commandList.length > 25) {
+      if (helpEmbed.fields.length === 0) {
+        helpEmbed.fields = commandList.splice(0, 25);
+        await interaction.editReply({
+          content: "Help Message",
+          embeds: [helpEmbed],
+        });
+      } else {
+        embedList.push({
+          fields: commandList.splice(0, 25),
+        });
+      }
+    } else {
+      if (helpEmbed.fields.length === 0) {
+        helpEmbed.fields = commandList.splice(0, commandList.length);
+        await interaction.editReply({
+          content: "Help Message",
+          embeds: [helpEmbed],
+        });
+      } else {
+        embedList.push({
+          fields: commandList.splice(0, commandList.length),
+        });
+      }
     }
+  }
 
+  // Send calculated list of embeds
+  for (let i = 0; i < embedList.length; i++) {
     await interaction.followUp({
-        embeds: [{
-            title: `Storeman Bot Help Menu`,
-            description: `
-            Version 0.9 28/7/2023
+      embeds: [embedList[i]],
+      ephemeral: true,
+    });
+  }
+
+  await interaction.followUp({
+    embeds: [
+      {
+        title: `Storeman Bot Help Menu`,
+        description: `
+            Version ${VERSION} (${UPDATE_DATE})
             Your GuildID is: **__\`${interaction.guildId}\`__** (this is the vale you should be inputting into Stockpiler to send scanned data!)
             
             👨‍⚖️ - Commands that require at least \`Admin\` permissions
             🙍‍♂️ - Commands that require at least \`User\` permissions
             ❓ - Denotes an **optional** parameter
             
-            Currently in beta testing, contact Tkai#8276 for help.`
-        }],
-        ephemeral: true
-    })
+            Currently in beta testing, contact Tkai#8276 for help.`,
+      },
+    ],
+    ephemeral: true,
+  });
 
-    return true;
-}
+  return true;
+};
 
-export default sphelp
+export default sphelp;
diff --git a/constants.ts b/constants.ts
new file mode 100644
index 0000000..c242ee3
--- /dev/null
+++ b/constants.ts
@@ -0,0 +1,2 @@
+export const VERSION = 1.0;
+export const UPDATE_DATE = "19/7/2024";
diff --git a/index.ts b/index.ts
index f2cd3c1..c615e36 100644
--- a/index.ts
+++ b/index.ts
@@ -39,6 +39,7 @@ import spgroup from "./Commands/spgroup";
 import sprefresh from "./Commands/sprefresh";
 import spuser from "./Commands/spuser";
 import autoCompleteHandler from "./Utils/autoCompleteHandler";
+import { UPDATE_DATE, VERSION } from "./constants";
 
 require("dotenv").config();
 const host = process.env.APP_HOST ? process.env.APP_HOST : "0.0.0.0";
@@ -119,7 +120,7 @@ const updateFirstTimeSetup = async (newInstance: boolean): Promise<void> => {
     console.info(
       "Generated a random password since none was previously set: " +
         password +
-        ". You can change this using /spsetpassword via the bot"
+        ". You can change this using /spsetpassword via the bot",
     );
     await collections.config.insertOne({
       version: currentVersion,
@@ -129,7 +130,7 @@ const updateFirstTimeSetup = async (newInstance: boolean): Promise<void> => {
   } else {
     await collections.config.updateOne(
       {},
-      { $set: { version: currentVersion } }
+      { $set: { version: currentVersion } },
     );
     console.info("Completed Storeman Bot update");
   }
@@ -144,7 +145,7 @@ const guildCreateEventHandler = async (guild: Guild) => {
       "Bot has joined a new server named: " +
         guild.name +
         " with ID: " +
-        guild.id
+        guild.id,
     );
     const password = crypto.randomBytes(32).toString("hex");
     await collections.config.insertOne({
@@ -158,7 +159,7 @@ const guildCreateEventHandler = async (guild: Guild) => {
     const globalCollection = getCollections("global-settings");
     await globalCollection.config.updateOne(
       {},
-      { $push: { serverIDList: guild.id } }
+      { $push: { serverIDList: guild.id } },
     );
 
     const stockpileTimes: any = NodeCacheObj.get("stockpileTimes");
@@ -177,7 +178,7 @@ const guildCreateEventHandler = async (guild: Guild) => {
 
 const guildDeleteEventHandler = async (guildID: string) => {
   console.log(
-    "Bot has been kicked (or deleted) from the server with ID:" + guildID
+    "Bot has been kicked (or deleted) from the server with ID:" + guildID,
   );
   const mongoClient = getMongoClientObj();
   const db = mongoClient.db("stockpiler-" + guildID);
@@ -196,7 +197,7 @@ const guildDeleteEventHandler = async (guildID: string) => {
   if (found) {
     await collections.config.updateOne(
       {},
-      { $set: { serverIDList: configObj.serverIDList } }
+      { $set: { serverIDList: configObj.serverIDList } },
     );
     const stockpileTimes: any = NodeCacheObj.get("stockpileTimes");
     const notifRoles: any = NodeCacheObj.get("notifRoles");
@@ -209,11 +210,11 @@ const guildDeleteEventHandler = async (guildID: string) => {
     delete disableTimeNotif[guildID];
     delete stockpileGroups[guildID];
     console.log(
-      "Deleted the database and config records of the guild successfully"
+      "Deleted the database and config records of the guild successfully",
     );
   } else
     console.log(
-      "Delete request received but no such guildID exists in Storeman Bot records."
+      "Delete request received but no such guildID exists in Storeman Bot records.",
     );
 };
 
@@ -257,7 +258,7 @@ const createCacheStartup = async (client: Client) => {
           insertCommands(configObj.serverIDList[i]);
           await collections.config.updateOne(
             {},
-            { $set: { version: currentVersion } }
+            { $set: { version: currentVersion } },
           );
         }
       }
@@ -427,7 +428,7 @@ const main = async (): Promise<void> => {
           console.log(
             "[!!!]: An error has occured in the command " +
               interaction.commandName +
-              ". Please kindly report this to the developer on Discord (Tkai#8276)"
+              ". Please kindly report this to the developer on Discord (Tkai#8276)",
           );
           interaction.followUp({
             content:
@@ -438,7 +439,7 @@ const main = async (): Promise<void> => {
           });
         } else if (interaction.isButton()) {
           console.log(
-            "[!!!]: An error has occured in a button action. Please kindly report this to the developer on Discord (Tkai#8276)"
+            "[!!!]: An error has occured in a button action. Please kindly report this to the developer on Discord (Tkai#8276)",
           );
           interaction.followUp({
             content:
@@ -477,7 +478,7 @@ const main = async (): Promise<void> => {
         "[Command Queue:] Finished 1 command for " +
           interaction.guildId +
           ". Remaining length of queue: " +
-          multiServerCommandQueue[interaction.guildId!].length
+          multiServerCommandQueue[interaction.guildId!].length,
       );
     } else {
       commandCallQueue.splice(0, 1);
@@ -486,7 +487,7 @@ const main = async (): Promise<void> => {
       }
       console.log(
         "[Command Queue:] Finished 1 command. Remaining length of queue: " +
-          commandCallQueue.length
+          commandCallQueue.length,
       );
     }
   };
@@ -580,7 +581,7 @@ const main = async (): Promise<void> => {
           } catch (e) {
             response.writeHead(403, { "Content-Type": "application/json" });
             response.end(
-              JSON.stringify({ success: false, error: "invalid-json" })
+              JSON.stringify({ success: false, error: "invalid-json" }),
             );
           }
         });
@@ -588,7 +589,7 @@ const main = async (): Promise<void> => {
         response.writeHead(200, { "Content-Type": "text/html" });
         response.write(`
                     <html>
-                        <h1>Storeman Bot</h1>
+                        <h1>Storeman Bot - ${VERSION} (${UPDATE_DATE})</h1>
                         <p>If you are seeing this page, it means you have reached the Storeman Bot sanity check web page. Please use the <a href="https://github.com/tehruttiger/Stockpiler">Stockpiler</a> app to communicate with our servers instead!</p>
                     </html>
                 `);
@@ -598,7 +599,7 @@ const main = async (): Promise<void> => {
 
     server.listen(parseInt(process.env.APP_PORT!), host);
     console.log(
-      `HTTP server now listening at http://${host}:${process.env.APP_PORT}`
+      `HTTP server now listening at http://${host}:${process.env.APP_PORT}`,
     );
 
     // This is called once client(the bot) is ready
@@ -629,7 +630,7 @@ const main = async (): Promise<void> => {
 
         if (multiServerCommandQueue[interaction.guildId!].length === 1) {
           console.log(
-            `[Command Queue:] No queue ahead for ${interaction.guildId}, starting.`
+            `[Command Queue:] No queue ahead for ${interaction.guildId}, starting.`,
           );
           handleCommand(multiServerCommandQueue[interaction.guildId!][0]);
         }