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

src/utils/env.ts

@@ -21,14 +21,13 @@ 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))
-            throw new Error(`Environment variable ${name} does not follow IPv4 formatting.`)
+    if ((name.endsWith("_IP") || name.endsWith("_ADDRESS")) && !ipValidate.test(value))
+        throw new Error(`Environment variable ${name} does not follow IPv4 formatting.`)
 
     // return env variable
     return value

src/utils/events.ts

@@ -15,8 +15,8 @@ export type EventKeys = keyof ClientEvents // only wants keys of ClientEvents ob
  * @param msgHist message history
  */
 export type ChatParams = {
-    model: string, 
-    ollama: Ollama, 
+    model: string,
+    ollama: Ollama,
     msgHist: UserMessage[]
 }
 
@@ -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 }
 }
@@ -62,8 +75,8 @@ export function event<T extends EventKeys>(key: T, callback: EventCallback<T>):
  * @param ollama the initialized ollama instance
  */
 export function registerEvents(
-    client: Client, 
-    events: Event[], 
+    client: Client,
+    events: Event[],
     msgHist: Queue<UserMessage>,
     ollama: Ollama,
     defaultModel: String

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))
@@ -103,7 +110,7 @@ export async function getChannelInfo(filename: string, callback: (config: Channe
     if (fs.existsSync(fullFileName)) {
         fs.readFile(fullFileName, 'utf8', (error, data) => {
             if (error) {
-                callback(undefined) 
+                callback(undefined)
                 return // something went wrong... stop
             }
             callback(JSON.parse(data))

src/utils/handlers/configHandler.ts

@@ -12,7 +12,7 @@ import path from 'path'
 // add type of change (server, user)
 export function openConfig(filename: string, key: string, value: any) {
     const fullFileName = `data/${filename}`
-    
+
     // check if the file exists, if not then make the config file
     if (fs.existsSync(fullFileName)) {
         fs.readFile(fullFileName, 'utf8', (error, data) => {
@@ -58,7 +58,7 @@ export async function getServerConfig(filename: string, callback: (config: Serve
     if (fs.existsSync(fullFileName)) {
         fs.readFile(fullFileName, 'utf8', (error, data) => {
             if (error) {
-                callback(undefined) 
+                callback(undefined)
                 return // something went wrong... stop
             }
             callback(JSON.parse(data))
@@ -81,7 +81,7 @@ export async function getUserConfig(filename: string, callback: (config: UserCon
     if (fs.existsSync(fullFileName)) {
         fs.readFile(fullFileName, 'utf8', (error, data) => {
             if (error) {
-                callback(undefined) 
+                callback(undefined)
                 return // something went wrong... stop
             }
             callback(JSON.parse(data))

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({

src/utils/messageNormal.ts

@@ -28,7 +28,7 @@ export async function normalMessage(
                 model: model,
                 ollama: ollama,
                 msgHist: msgHist.getItems()
-            } 
+            }
 
             // run query based on stream preference, true = stream, false = block
             if (stream) {
@@ -40,14 +40,15 @@ 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
-                        
+
                         // ensure block is not empty
                         if (result.length > 5)
-                            messageBlock.edit(result) 
-                    }         
+                            messageBlock.edit(result)
+                    }
                     console.log(result)
                 }
             }
@@ -70,8 +71,8 @@ export async function normalMessage(
                     channel.send(result)
                 } 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.`)