[Snyk] Upgrade discord.js from 14.16.3 to 14.17.3 (#155)

2025-12-12 11:56:06 -05:00 · 2025-01-31 16:23:31 -08:00
parent 2a39e20fee
commit 5b542aca1a
23 changed files with 324 additions and 316 deletions
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,7 @@
      "version": "0.8.2",
      "license": "ISC",
      "dependencies": {
-        "discord.js": "^14.16.3",
+        "discord.js": "^14.17.3",
        "dotenv": "^16.4.7",
        "ollama": "^0.5.11",
        "redis": "^4.7.0"
@@ -123,32 +123,26 @@
      }
    },
    "node_modules/@discordjs/builders": {
-      "version": "1.9.0",
-      "resolved": "https://registry.npmjs.org/@discordjs/builders/-/builders-1.9.0.tgz",
-      "integrity": "sha512-0zx8DePNVvQibh5ly5kCEei5wtPBIUbSoE9n+91Rlladz4tgtFbJ36PZMxxZrTEOQ7AHMZ/b0crT/0fCy6FTKg==",
+      "version": "1.10.0",
+      "resolved": "https://registry.npmjs.org/@discordjs/builders/-/builders-1.10.0.tgz",
+      "integrity": "sha512-ikVZsZP+3shmVJ5S1oM+7SveUCK3L9fTyfA8aJ7uD9cNQlTqF+3Irbk2Y22KXTb3C3RNUahRkSInClJMkHrINg==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@discordjs/formatters": "^0.5.0",
+        "@discordjs/formatters": "^0.6.0",
        "@discordjs/util": "^1.1.1",
        "@sapphire/shapeshift": "^4.0.0",
-        "discord-api-types": "0.37.97",
+        "discord-api-types": "^0.37.114",
        "fast-deep-equal": "^3.1.3",
        "ts-mixer": "^6.0.4",
        "tslib": "^2.6.3"
      },
      "engines": {
-        "node": ">=18"
+        "node": ">=16.11.0"
      },
      "funding": {
        "url": "https://github.com/discordjs/discord.js?sponsor"
      }
    },
-    "node_modules/@discordjs/builders/node_modules/discord-api-types": {
-      "version": "0.37.97",
-      "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.37.97.tgz",
-      "integrity": "sha512-No1BXPcVkyVD4ZVmbNgDKaBoqgeQ+FJpzZ8wqHkfmBnTZig1FcH3iPPersiK1TUIAzgClh2IvOuVUYfcWLQAOA==",
-      "license": "MIT"
-    },
    "node_modules/@discordjs/collection": {
      "version": "1.5.3",
      "resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-1.5.3.tgz",
@@ -159,30 +153,24 @@
      }
    },
    "node_modules/@discordjs/formatters": {
-      "version": "0.5.0",
-      "resolved": "https://registry.npmjs.org/@discordjs/formatters/-/formatters-0.5.0.tgz",
-      "integrity": "sha512-98b3i+Y19RFq1Xke4NkVY46x8KjJQjldHUuEbCqMvp1F5Iq9HgnGpu91jOi/Ufazhty32eRsKnnzS8n4c+L93g==",
+      "version": "0.6.0",
+      "resolved": "https://registry.npmjs.org/@discordjs/formatters/-/formatters-0.6.0.tgz",
+      "integrity": "sha512-YIruKw4UILt/ivO4uISmrGq2GdMY6EkoTtD0oS0GvkJFRZbTSdPhzYiUILbJ/QslsvC9H9nTgGgnarnIl4jMfw==",
      "license": "Apache-2.0",
      "dependencies": {
-        "discord-api-types": "0.37.97"
+        "discord-api-types": "^0.37.114"
      },
      "engines": {
-        "node": ">=18"
+        "node": ">=16.11.0"
      },
      "funding": {
        "url": "https://github.com/discordjs/discord.js?sponsor"
      }
    },
-    "node_modules/@discordjs/formatters/node_modules/discord-api-types": {
-      "version": "0.37.97",
-      "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.37.97.tgz",
-      "integrity": "sha512-No1BXPcVkyVD4ZVmbNgDKaBoqgeQ+FJpzZ8wqHkfmBnTZig1FcH3iPPersiK1TUIAzgClh2IvOuVUYfcWLQAOA==",
-      "license": "MIT"
-    },
    "node_modules/@discordjs/rest": {
-      "version": "2.4.0",
-      "resolved": "https://registry.npmjs.org/@discordjs/rest/-/rest-2.4.0.tgz",
-      "integrity": "sha512-Xb2irDqNcq+O8F0/k/NaDp7+t091p+acb51iA4bCKfIn+WFWd6HrNvcsSbMMxIR9NjcMZS6NReTKygqiQN+ntw==",
+      "version": "2.4.2",
+      "resolved": "https://registry.npmjs.org/@discordjs/rest/-/rest-2.4.2.tgz",
+      "integrity": "sha512-9bOvXYLQd5IBg/kKGuEFq3cstVxAMJ6wMxO2U3wjrgO+lHv8oNCT+BBRpuzVQh7BoXKvk/gpajceGvQUiRoJ8g==",
      "license": "Apache-2.0",
      "dependencies": {
        "@discordjs/collection": "^2.1.1",
@@ -190,7 +178,7 @@
        "@sapphire/async-queue": "^1.5.3",
        "@sapphire/snowflake": "^3.5.3",
        "@vladfrangu/async_event_emitter": "^2.4.6",
-        "discord-api-types": "0.37.97",
+        "discord-api-types": "^0.37.114",
        "magic-bytes.js": "^1.10.0",
        "tslib": "^2.6.3",
        "undici": "6.19.8"
@@ -214,12 +202,6 @@
        "url": "https://github.com/discordjs/discord.js?sponsor"
      }
    },
-    "node_modules/@discordjs/rest/node_modules/discord-api-types": {
-      "version": "0.37.97",
-      "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.37.97.tgz",
-      "integrity": "sha512-No1BXPcVkyVD4ZVmbNgDKaBoqgeQ+FJpzZ8wqHkfmBnTZig1FcH3iPPersiK1TUIAzgClh2IvOuVUYfcWLQAOA==",
-      "license": "MIT"
-    },
    "node_modules/@discordjs/util": {
      "version": "1.1.1",
      "resolved": "https://registry.npmjs.org/@discordjs/util/-/util-1.1.1.tgz",
@@ -233,20 +215,20 @@
      }
    },
    "node_modules/@discordjs/ws": {
-      "version": "1.1.1",
-      "resolved": "https://registry.npmjs.org/@discordjs/ws/-/ws-1.1.1.tgz",
-      "integrity": "sha512-PZ+vLpxGCRtmr2RMkqh8Zp+BenUaJqlS6xhgWKEZcgC/vfHLEzpHtKkB0sl3nZWpwtcKk6YWy+pU3okL2I97FA==",
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/@discordjs/ws/-/ws-1.2.0.tgz",
+      "integrity": "sha512-QH5CAFe3wHDiedbO+EI3OOiyipwWd+Q6BdoFZUw/Wf2fw5Cv2fgU/9UEtJRmJa9RecI+TAhdGPadMaEIur5yJg==",
      "license": "Apache-2.0",
      "dependencies": {
        "@discordjs/collection": "^2.1.0",
-        "@discordjs/rest": "^2.3.0",
+        "@discordjs/rest": "^2.4.1",
        "@discordjs/util": "^1.1.0",
        "@sapphire/async-queue": "^1.5.2",
        "@types/ws": "^8.5.10",
        "@vladfrangu/async_event_emitter": "^2.2.4",
-        "discord-api-types": "0.37.83",
+        "discord-api-types": "^0.37.114",
        "tslib": "^2.6.2",
-        "ws": "^8.16.0"
+        "ws": "^8.17.0"
      },
      "engines": {
        "node": ">=16.11.0"
@@ -267,12 +249,6 @@
        "url": "https://github.com/discordjs/discord.js?sponsor"
      }
    },
-    "node_modules/@discordjs/ws/node_modules/discord-api-types": {
-      "version": "0.37.83",
-      "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.37.83.tgz",
-      "integrity": "sha512-urGGYeWtWNYMKnYlZnOnDHm8fVRffQs3U0SpE8RHeiuLKb/u92APS8HoQnPTFbnXmY1vVnXjXO4dOxcAn3J+DA==",
-      "license": "MIT"
-    },
    "node_modules/@esbuild/aix-ppc64": {
      "version": "0.23.1",
      "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.23.1.tgz",
@@ -1176,9 +1152,9 @@
      }
    },
    "node_modules/@types/ws": {
-      "version": "8.5.13",
-      "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.13.tgz",
-      "integrity": "sha512-osM/gWBTPKgHV8XkTunnegTRIsvF6owmf5w+JtAfOw472dptdm0dlGv4xCt6GwQRcC2XVOvvRE/0bAoQcL2QkA==",
+      "version": "8.5.14",
+      "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.14.tgz",
+      "integrity": "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw==",
      "license": "MIT",
      "dependencies": {
        "@types/node": "*"
@@ -1553,25 +1529,25 @@
      }
    },
    "node_modules/discord-api-types": {
-      "version": "0.37.100",
-      "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.37.100.tgz",
-      "integrity": "sha512-a8zvUI0GYYwDtScfRd/TtaNBDTXwP5DiDVX7K5OmE+DRT57gBqKnwtOC5Ol8z0mRW8KQfETIgiB8U0YZ9NXiCA==",
+      "version": "0.37.118",
+      "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.37.118.tgz",
+      "integrity": "sha512-MQkHHZcytmNQ3nQOBj6a0z38swsmHiROX7hdayfd0eWVrLxaQp/6tWBZ7FO2MCKKsc+W3QWnnfOJTbtyk8C4TQ==",
      "license": "MIT"
    },
    "node_modules/discord.js": {
-      "version": "14.16.3",
-      "resolved": "https://registry.npmjs.org/discord.js/-/discord.js-14.16.3.tgz",
-      "integrity": "sha512-EPCWE9OkA9DnFFNrO7Kl1WHHDYFXu3CNVFJg63bfU7hVtjZGyhShwZtSBImINQRWxWP2tgo2XI+QhdXx28r0aA==",
+      "version": "14.17.3",
+      "resolved": "https://registry.npmjs.org/discord.js/-/discord.js-14.17.3.tgz",
+      "integrity": "sha512-8/j8udc3CU7dz3Eqch64UaSHoJtUT6IXK4da5ixjbav4NAXJicloWswD/iwn1ImZEMoAV3LscsdO0zhBh6H+0Q==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@discordjs/builders": "^1.9.0",
+        "@discordjs/builders": "^1.10.0",
        "@discordjs/collection": "1.5.3",
-        "@discordjs/formatters": "^0.5.0",
-        "@discordjs/rest": "^2.4.0",
+        "@discordjs/formatters": "^0.6.0",
+        "@discordjs/rest": "^2.4.2",
        "@discordjs/util": "^1.1.1",
-        "@discordjs/ws": "1.1.1",
+        "@discordjs/ws": "^1.2.0",
        "@sapphire/snowflake": "3.5.3",
-        "discord-api-types": "0.37.100",
+        "discord-api-types": "^0.37.114",
        "fast-deep-equal": "3.1.3",
        "lodash.snakecase": "4.1.1",
        "tslib": "^2.6.3",
--- a/package.json
+++ b/package.json
@@ -27,7 +27,7 @@
  "author": "Kevin Dang",
  "license": "ISC",
  "dependencies": {
-    "discord.js": "^14.16.3",
+    "discord.js": "^14.17.3",
    "dotenv": "^16.4.7",
    "ollama": "^0.5.11",
    "redis": "^4.7.0"
--- a/src/commands/capacity.ts
+++ b/src/commands/capacity.ts
@@ -22,7 +22,9 @@ export const Capacity: SlashCommand = {
        if (!channel || !UserCommand.includes(channel.type)) return

        // set state of bot chat features
-        openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('context-capacity')?.value)
+        openConfig(`${interaction.user.username}-config.json`, interaction.commandName,
+            interaction.options.get('context-capacity')?.value
+        )

        interaction.reply({
            content: `Max message history is now set to \`${interaction.options.get('context-capacity')?.value}\``,
--- a/src/commands/cleanUserChannelHistory.ts
+++ b/src/commands/cleanUserChannelHistory.ts
@@ -14,9 +14,11 @@ export const ClearUserChannelHistory: SlashCommand = {
        if (!channel || !UserCommand.includes(channel.type)) return

        // clear channel info for user
-        const successfulWipe = await clearChannelInfo(interaction.channelId, 
+        const successfulWipe = await clearChannelInfo(
+            interaction.channelId,
            interaction.channel as TextChannel,
-            interaction.user.username)
+            interaction.user.username
+        )

        // check result of clearing history
        if (successfulWipe)
--- a/src/commands/disable.ts
+++ b/src/commands/disable.ts
@@ -31,10 +31,12 @@ export const Disable: SlashCommand = {
        }

        // set state of bot chat features
-        openConfig(`${interaction.guildId}-config.json`, interaction.commandName, interaction.options.get('enabled')?.value)
+        openConfig(`${interaction.guildId}-config.json`, interaction.commandName,
+            interaction.options.get('enabled')?.value
+        )

        interaction.reply({
-            content: `${client.user?.username} is now **${interaction.options.get('enabled')?.value ?  "enabled" : "disabled" }**.`,
+            content: `${client.user?.username} is now **${interaction.options.get('enabled')?.value ? "enabled" : "disabled"}**.`,
            ephemeral: true
        })
    }
--- a/src/commands/messageStream.ts
+++ b/src/commands/messageStream.ts
@@ -22,7 +22,9 @@ export const MessageStream: SlashCommand = {
        if (!channel || !UserCommand.includes(channel.type)) return

        // save value to json and write to it
-        openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('stream')?.value)
+        openConfig(`${interaction.user.username}-config.json`, interaction.commandName,
+            interaction.options.get('stream')?.value
+        )

        interaction.reply({
            content: `Message streaming is now set to: \`${interaction.options.get('stream')?.value}\``,
--- a/src/commands/shutoff.ts
+++ b/src/commands/shutoff.ts
@@ -28,6 +28,7 @@ export const Shutoff: SlashCommand = {
            content: `${client.user?.tag} is shutting down.`,
            ephemeral: true
        })
+
        console.log(`[Command: shutoff] ${client.user?.tag} is shutting down.`)

        // clean up client instance and stop
--- a/src/commands/threadCreate.ts
+++ b/src/commands/threadCreate.ts
@@ -21,9 +21,7 @@ export const ThreadCreate: SlashCommand = {
        thread.send(`Hello ${interaction.user} and others! \n\nIt's nice to meet you. Please talk to me by typing **@${client.user?.username}** with your message.`)

        // handle storing this chat channel
-        openChannelInfo(thread.id, 
-            thread as ThreadChannel, 
-            interaction.user.tag)
+        openChannelInfo(thread.id, thread as ThreadChannel, interaction.user.tag)

        // user only reply
        return interaction.reply({
--- a/src/commands/threadPrivateCreate.ts
+++ b/src/commands/threadPrivateCreate.ts
@@ -22,10 +22,7 @@ export const PrivateThreadCreate: SlashCommand = {

        // handle storing this chat channel
        // store: thread.id, thread.name
-        openChannelInfo(thread.id, 
-            thread as ThreadChannel,
-            interaction.user.tag
-        )
+        openChannelInfo(thread.id, thread as ThreadChannel, interaction.user.tag)

        // user only reply
        return interaction.reply({
--- a/src/events/interactionCreate.ts
+++ b/src/events/interactionCreate.ts
@@ -16,4 +16,5 @@ export default event(Events.InteractionCreate, async ({ log, client }, interacti

        // the command exists, execute it
        command.run(client, interaction)
-})
+    }
+)
--- a/src/events/messageCreate.ts
+++ b/src/events/messageCreate.ts
@@ -1,6 +1,9 @@
 import { TextChannel } from 'discord.js'
-import { event, Events, normalMessage, UserMessage, clean, getTextFileAttachmentData } from '../utils/index.js'
-import { getChannelInfo, getServerConfig, getUserConfig, openChannelInfo, openConfig, UserConfig, getAttachmentData } from '../utils/index.js'
+import { event, Events, normalMessage, UserMessage, clean } from '../utils/index.js'
+import {
+    getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
+    openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
+} from '../utils/index.js'

 /** 
 * Max Message length for free users is 2000 characters (bot or not).
@@ -187,4 +190,5 @@ export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client
            msgHist.pop() // remove message because of failure
            message.reply(`**Error Occurred:**\n\n**Reason:** *${error.message}*`)
        }
-})
+    }
+)
--- a/src/events/ready.ts
+++ b/src/events/ready.ts
@@ -14,4 +14,5 @@ export default event(Events.ClientReady, ({ log }, client) => {
        })

        log(`Logged in as ${client.user.username}.`)
-})
+    }
+)
--- a/src/events/threadDelete.ts
+++ b/src/events/threadDelete.ts
@@ -37,4 +37,5 @@ export default event(Events.ThreadDelete, async ({ log }, thread: ThreadChannel)
        } catch (error) {
            log(`Issue deleting user history files from ${thread.id}`)
        }
-})
+    }
+)
--- a/src/utils/env.ts
+++ b/src/utils/env.ts
@@ -21,13 +21,12 @@ export function getEnvVar(name: string, fallback?: string): string {
        throw new Error(`Environment variable ${name} is not set.`)

    // validate User-Generated Discord Application Tokens 
-    if (name === "CLIENT_TOKEN")
-        if (value.length < 72) throw new Error(`The "CLIENT_TOKEN" provided is not of at least length 72. 
+    if (name === "CLIENT_TOKEN" && value.length > 72)
+        throw new Error(`The "CLIENT_TOKEN" provided is not of at least length 72. 
            This is probably an invalid token unless Discord updated their token policy. Please provide a valid token.`)

    // validate IPv4 address found in environment variables
-    if (name.endsWith("_IP") || name.endsWith("_ADDRESS"))
-        if (!ipValidate.test(value))
+    if ((name.endsWith("_IP") || name.endsWith("_ADDRESS")) && !ipValidate.test(value))
        throw new Error(`Environment variable ${name} does not follow IPv4 formatting.`)

    // return env variable
--- a/src/utils/events.ts
+++ b/src/utils/events.ts
@@ -24,6 +24,7 @@ export type ChatParams = {
 * Format for the messages to be stored when communicating when the bot
 * @param role either assistant, user, or system
 * @param content string of the message the user or assistant provided
+ * @param images array of images that the user or assistant provided
 */
 export type UserMessage = {
    role: string,
@@ -33,12 +34,18 @@ export type UserMessage = {

 // Event properties
 export interface EventProps {
-    client: Client
-    log: LogMethod
-    msgHist: Queue<UserMessage>
+    client: Client,
+    log: LogMethod,
+    msgHist: Queue<UserMessage>,
    ollama: Ollama,
    defaultModel: String
 }
+
+/**
+ * Format for the callback function tied to an event
+ * @param props the properties of the event
+ * @param args the arguments of the event
+ */
 export type EventCallback<T extends EventKeys> = (
    props: EventProps,
    ...args: ClientEvents[T]
@@ -50,6 +57,12 @@ export interface Event<T extends EventKeys = EventKeys> {
    callback: EventCallback<T>
 }

+/**
+ * Method to create an event object
+ * @param key type of event
+ * @param callback function to run when event is triggered
+ * @returns event object
+ */
 export function event<T extends EventKeys>(key: T, callback: EventCallback<T>): Event<T> {
    return { key, callback }
 }
--- a/src/utils/handlers/chatHistoryHandler.ts
+++ b/src/utils/handlers/chatHistoryHandler.ts
@@ -80,7 +80,14 @@ export async function openChannelInfo(filename: string, channel: TextChannel | T
            }
        })
    } else { // file doesn't exist, create it
-        const object: Configuration = JSON.parse(`{ \"id\": \"${channel?.id}\", \"name\": \"${channel?.name}\", \"user\": \"${user}\", \"messages\": []}`)
+        const object: Configuration = JSON.parse(
+            `{ 
+                \"id\": \"${channel?.id}\", 
+                \"name\": \"${channel?.name}\", 
+                \"user\": \"${user}\", 
+                \"messages\": []
+            }`
+        )

        const directory = path.dirname(fullFileName)
        if (!fs.existsSync(directory))
--- a/src/utils/handlers/streamHandler.ts
+++ b/src/utils/handlers/streamHandler.ts
@@ -5,7 +5,7 @@ import { AbortableAsyncIterator } from "ollama/src/utils.js"
 /**
 * Method to query the Ollama client for async generation
 * @param params 
- * @returns Asyn
+ * @returns AsyncIterator<ChatResponse> generated by the Ollama client
 */
 export async function streamResponse(params: ChatParams): Promise<AbortableAsyncIterator<ChatResponse>> {
    return await params.ollama.chat({
--- a/src/utils/messageNormal.ts
+++ b/src/utils/messageNormal.ts
@@ -40,7 +40,8 @@ export async function normalMessage(
                        result = portion.message.content

                        // new message block, wait for it to send and assign new block to respond.
-                        await channel.send("Creating new stream block...").then(sentMessage => { messageBlock = sentMessage })
+                        await channel.send("Creating new stream block...")
+                            .then(sentMessage => { messageBlock = sentMessage })
                    } else {
                        result += portion.message.content

@@ -71,7 +72,7 @@ export async function normalMessage(
                } else // edit the 'generic' response to new message since <2000
                    sentMessage.edit(result)
            }
-        } catch(error: any) {
+        } catch (error: any) {
            console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
            if (error.message.includes('try pulling it first'))
                sentMessage.edit(`**Response generation failed.**\n\nReason: You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`)
--- a/tests/commands.test.ts
+++ b/tests/commands.test.ts
@@ -34,7 +34,8 @@ describe('Commands Existence', () => {
    // test specific commands in the object
    it('references specific commands', () => {
        const commandsString = commands.map(e => e.name).join(', ')
-        expect(commandsString).toBe('thread, private-thread, message-stream, toggle-chat, shutoff, modify-capacity, clear-user-channel-history, pull-model, switch-model, delete-model')
+        const expectedCommands = ['thread', 'private-thread', 'message-stream', 'toggle-chat', 'shutoff', 'modify-capacity', 'clear-user-channel-history', 'pull-model', 'switch-model', 'delete-model']
+        expect(commandsString).toBe(expectedCommands.join(', '))
    })
 })

--- a/tests/queue.test.ts
+++ b/tests/queue.test.ts
@@ -8,7 +8,7 @@ import { Queue } from '../src/queues/queue.js'
 * @param fn function holding tests to run
 */
 describe('Queue Structure', () => {
-    let queue= new Queue<string>()
+    let queue = new Queue<string>()

    // test for queue creation
    it('creates a new queue', () => {