Deprecated ephemeral field (#158)

* Update: ephemeral flag added in place of field

* Update: remove unused import

* Update: version increment

---------

Co-authored-by: Kevin Dang <kevinthedang_1@outlook.com>

.env.sample

@@ -13,3 +13,7 @@ DISCORD_IP = IP_ADDRESS
 
 # subnet address, ex. 172.18.0.0 as we use /16.
 SUBNET_ADDRESS = ADDRESS
+
+# redis port and ip, default redis port is 6379
+REDIS_IP = IP_ADDRESS
+REDIS_PORT = PORT

.github/workflows/build.yml

@@ -13,10 +13,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/hydrogen
+      - name: Set up Node Environment lts/jod
         uses: actions/setup-node@v4
         with:
-          node-version: lts/hydrogen
+          node-version: lts/jod
           cache: "npm"
 
       - name: Install Project Dependencies
@@ -33,6 +33,8 @@ jobs:
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
           echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
           echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
         # set -e ensures if nohup fails, this section fails
       - name: Startup Discord Bot Client
@@ -47,10 +49,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/hydrogen
+      - name: Set up Node Environment lts/jod
         uses: actions/setup-node@v4
         with:
-          node-version: lts/hydrogen
+          node-version: lts/jod
           cache: "npm"
 
       - name: Create Environment Variables
@@ -59,6 +61,8 @@ jobs:
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
           echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
           echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
       - name: Setup Docker Network and Images
         run: |
@@ -66,8 +70,8 @@ jobs:
 
       - name: Check Images Exist
         run: |
-          (docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama') || exit 1
+          (docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama' | docker images | grep -qE 'redis') || exit 1
 
       - name: Check Containers Exist
         run: |
-          (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1
+          (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord' && docker ps | grep -q 'redis') || exit 1

.github/workflows/coverage.yml

@@ -14,10 +14,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/hydrogen
+      - name: Set up Node Environment lts/jod
         uses: actions/setup-node@v4
         with:
-          node-version: lts/hydrogen
+          node-version: lts/jod
           cache: "npm"
 
       - name: Install Project Dependencies
@@ -30,6 +30,8 @@ jobs:
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
           echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
           echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
       - name: Collect Code Coverage
         run: |

.github/workflows/release.yml

@@ -14,10 +14,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/hydrogen
+      - name: Set up Node Environment lts/jod
         uses: actions/setup-node@v4
         with:
-          node-version: lts/hydrogen
+          node-version: lts/jod
           cache: "npm"
 
       - name: Create Environment Variables
@@ -26,6 +26,8 @@ jobs:
           echo CLIENT_TOKEN = NOT_REAL_TOKEN >> .env
           echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
           echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
       - name: Get Version from package.json
         run: echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_ENV

.github/workflows/test.yml

@@ -25,10 +25,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/hydrogen
+      - name: Set up Node Environment lts/jod
         uses: actions/setup-node@v4
         with:
-          node-version: lts/hydrogen
+          node-version: lts/jod
           cache: "npm"
 
       - name: Install Project Dependencies
@@ -41,6 +41,8 @@ jobs:
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
           echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
           echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
       - name: Test Application
         run: |

CODEOWNERS

@@ -11,7 +11,7 @@
 
 # Technical/Business Code Ownership
 /src/ @kevinthedang @JT2M0L3Y
-/tests/ @kevinthedang @JT2M0L3Y
+/tests/ @JT2M0L3Y
 /.github/ @kevinthedang
 
 # Docker Ownership

Dockerfile

@@ -1,5 +1,5 @@
-# use node LTS image for version 18
-FROM node:hydrogen-alpine
+# use node LTS image for version 22
+FROM node:jod-alpine
 
 # set working directory inside container
 WORKDIR /app

README.md

@@ -27,12 +27,13 @@ The project aims to:
   * [x] Administrator Role Compatible
   * [x] Multi-User Chat Generation (Multiple users chatting at the same time) - This was built in from Ollama `v0.2.1+`
   * [x] Automatic and Manual model pulling through the Discord client
-* [ ] Allow others to create their own models personalized for their own servers!
-  * [ ] Documentation on creating your own LLM
-  * [ ] Documentation on web scrapping and cleaning
+
+Further, Ollama provides the functionality to utilize custom models or provide context for the top-layer of any model available through the Ollama model library.
+* [Customize a model](https://github.com/ollama/ollama#customize-a-model)
+* [Modelfile Docs](https://github.com/ollama/ollama/blob/main/docs/modelfile.md)
 
 ## Documentation
-These are guides to the feature set included and the events triggered in this app.
+These are guides to the features and capabilities of this app.
 * [User Slash Commands](./docs/commands-guide.md)
 * [Client Events](./docs/events-guide.md)
 
@@ -49,10 +50,12 @@ These are guides to the feature set included and the events triggered in this ap
 
 ## Resources
 * [NodeJS](https://nodejs.org/en)
-    * This project runs on `lts\hydrogen`. 
-    * This project supports any NodeJS version above `16.x.x` to only allow ESModules.
+    * This project runs on `lts\jod` and above. 
+    * This project requires the use of npm version `10.9.0` or above.
 * [Ollama](https://ollama.com/)
     * [Ollama Docker Image](https://hub.docker.com/r/ollama/ollama)
+* [Redis](https://redis.io/)
+    * [Redis Docker Image](https://hub.docker.com/_/redis)
 * [Discord.js Docs](https://discord.js.org/docs/packages/discord.js/main)
 * [Setting up Docker (Ubuntu 20.04)](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-20-04)
     * [Setting up Nvidia Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)

docker-compose.yml

@@ -7,11 +7,13 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: kevinthedang/discord-ollama:0.7.5
+    image: kevinthedang/discord-ollama:0.8.3
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       OLLAMA_IP: ${OLLAMA_IP}
       OLLAMA_PORT: ${OLLAMA_PORT}
+      REDIS_IP: ${REDIS_IP}
+      REDIS_PORT: ${REDIS_PORT}
     networks:
       ollama-net:
         ipv4_address: ${DISCORD_IP}
@@ -26,7 +28,6 @@ services:
     networks:
       ollama-net:
         ipv4_address: ${OLLAMA_IP}
-
     runtime: nvidia             # use Nvidia Container Toolkit for GPU support
     devices:
       - /dev/nvidia0
@@ -35,7 +36,18 @@ services:
     ports: 
       - ${OLLAMA_PORT}:${OLLAMA_PORT}
 
-# Put Redis Container here?
+# setup redis container
+  redis:
+    image: redis:latest
+    container_name: redis
+    restart: always
+    networks:
+      ollama-net:
+        ipv4_address: ${REDIS_IP}
+    volumes:
+      - redis:/root/.redis
+    ports:
+      - ${REDIS_PORT}:${REDIS_PORT}
 
 # create a network that supports giving addresses withing a specific subnet
 networks:
@@ -49,3 +61,4 @@ networks:
 volumes:
   ollama:
   discord:
+  redis:

docs/commands-guide.md

@@ -78,8 +78,7 @@ This is a guide to all of the slash commands for the app.
     ```
     /message-stream stream true
     ```
-    > [!NOTE]
-    > This is a very slow progress on Discord because "spamming" changes within 5 seconds is not allowed.
+    **This is very slow on Discord because "spamming" changes in a channel within a period of 5 seconds is not allowed.**
 
 3. Message Style  
     This command allows a user to select whether to embed the app's response. 

docs/events-guide.md

@@ -1,7 +1,9 @@
 ## Events Guide
 This is a guide to all of the client events for the app.
 
-> [!NOTE] Each of these is logged to the console for a developer to track.
+> [!NOTE]
+> * Each of these is logged to the console for a developer to track.
+> * Possible interactions include commands, buttons, menus, etc.
 
 1. ClientReady  
     This event signifies that the Discord app is online.  
@@ -11,8 +13,6 @@ This is a guide to all of the client events for the app.
     This event signifies that a user interacted from Discord in some way.  
     Here commands are selected from a knowledge bank and executed if found.
 
-    > [!NOTE] Possible interactions include commands, buttons, menus, etc.
-
 3. MessageCreate  
     This event signifies that a message was sent.  
     Here user questions and comments for the LLM are processed.  

docs/setup-docker.md

@@ -43,11 +43,13 @@ sudo systemctl restart docker
 * [GitHub repository](https://github.com/NVIDIA/nvidia-container-toolkit?tab=readme-ov-file) for Nvidia Container Toolkit
 
 ## To Run (with Docker and Docker Compose)
-* With the inclusion of subnets in the `docker-compose.yml`, you will need to set the `SUBNET_ADDRESS`, `OLLAMA_IP`, `OLLAMA_PORT`, and `DISCORD_IP`. Here are some default values if you don't care:
+* With the inclusion of subnets in the `docker-compose.yml`, you will need to set the `SUBNET_ADDRESS`, `OLLAMA_IP`, `OLLAMA_PORT`, `REDIS_IP`, `REDIS_PORT`, and `DISCORD_IP`. Here are some default values if you don't care:
+    * `SUBNET_ADDRESS = 172.18.0.0`
     * `OLLAMA_IP = 172.18.0.2`
     * `OLLAMA_PORT = 11434`
     * `DISCORD_IP = 172.18.0.3`
-    * `SUBNET_ADDRESS = 172.18.0.0`
+    * `REDIS_IP = 172.18.0.4`
+    * `REDIS_PORT = 6379`
     * Don't understand any of this? watch a Networking video to understand subnetting.
     * You also need all environment variables shown in [`.env.sample`](../.env.sample)
 * Otherwise, there is no need to install any npm packages for this, you just need to run `npm run start` to pull the containers and spin them up.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.7.5",
+  "version": "0.8.3",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",
@@ -13,33 +13,36 @@
     "client": "npm run build && npm run prod",
     "clean": "docker compose down && docker rmi $(docker images | grep kevinthedang | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
     "start": "docker compose build --no-cache && docker compose up -d",
-    "docker:clean": "docker rm -f discord && docker rm -f ollama && docker network prune -f && docker rmi $(docker images | grep kevinthedang | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
+    "docker:clean": "docker rm -f discord && docker rm -f ollama && docker rm -f redis && docker network prune -f && docker rmi $(docker images | grep kevinthedang | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
     "docker:network": "docker network create --subnet=172.18.0.0/16 ollama-net",
     "docker:build": "docker build --no-cache -t kevinthedang/discord-ollama:$(node -p \"require('./package.json').version\") .",
     "docker:build-latest": "docker build --no-cache -t kevinthedang/discord-ollama:latest .",
     "docker:client": "docker run -d -v discord:/src/app --name discord --network ollama-net --ip 172.18.0.3 kevinthedang/discord-ollama:$(node -p \"require('./package.json').version\")",
+    "docker:redis": "docker run -d -v redis:/root/.redis -p 6379:6379 --name redis --network ollama-net --ip 172.18.0.4 redis:latest",
     "docker:ollama": "docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --name ollama --network ollama-net --ip 172.18.0.2 ollama/ollama:latest",
     "docker:ollama-cpu": "docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama --network ollama-net --ip 172.18.0.2 ollama/ollama:latest",
-    "docker:start": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama",
-    "docker:start-cpu": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama-cpu"
+    "docker:start": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:redis && npm run docker:client && npm run docker:ollama",
+    "docker:start-cpu": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:redis && npm run docker:client && npm run docker:ollama-cpu"
   },
   "author": "Kevin Dang",
   "license": "ISC",
   "dependencies": {
-    "discord.js": "^14.16.3",
-    "dotenv": "^16.4.5",
-    "ollama": "^0.5.9"
+    "discord.js": "^14.17.3",
+    "dotenv": "^16.4.7",
+    "ollama": "^0.5.11",
+    "redis": "^4.7.0"
   },
   "devDependencies": {
-    "@types/node": "^22.9.0",
-    "@vitest/coverage-v8": "^2.1.4",
+    "@types/node": "^22.10.2",
+    "@vitest/coverage-v8": "^2.1.8",
     "ts-node": "^10.9.2",
     "tsx": "^4.19.2",
-    "typescript": "^5.6.3",
+    "typescript": "^5.7.2",
     "vitest": "^2.1.4"
   },
   "type": "module",
   "engines": {
-    "node": ">=16.0.0"
+    "npm": ">=10.9.0",
+    "node": ">=22.12.0"
   }
 }

src/client.ts

@@ -1,11 +1,11 @@
 import { Client, GatewayIntentBits } from 'discord.js'
 import { Ollama } from 'ollama'
+import { createClient } from 'redis'
 import { Queue } from './queues/queue.js'
 import { UserMessage, registerEvents } from './utils/index.js'
 import Events from './events/index.js'
 import Keys from './keys.js'
 
-
 // initialize the client with the following permissions when logging in
 const client = new Client({
     intents: [
@@ -14,7 +14,12 @@ const client = new Client({
         GatewayIntentBits.GuildMessages,
         GatewayIntentBits.MessageContent
     ]
-});
+})
+
+// initialize connection to redis
+const redis = createClient({
+    url: `redis://${Keys.redisHost}:${Keys.redisPort}`,
+})
 
 // initialize connection to ollama container
 export const ollama = new Ollama({
@@ -27,6 +32,14 @@ const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
 // register all events
 registerEvents(client, Events, messageHistory, ollama, Keys.defaultModel)
 
+// Try to connect to redis
+await redis.connect()
+    .then(() => console.log('[Redis] Connected'))
+    .catch((error) => {
+        console.error('[Redis] Connection Error', error)
+        process.exit(1)
+    })
+
 // Try to log in the client
 await client.login(Keys.clientToken)
     .catch((error) => {

src/commands/capacity.ts

@@ -1,4 +1,4 @@
-import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
 import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const Capacity: SlashCommand = {
@@ -22,11 +22,13 @@ 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}\``,
-            ephemeral: true
+            flags: MessageFlags.Ephemeral
         })
     }
 }

src/commands/cleanUserChannelHistory.ts

@@ -1,4 +1,4 @@
-import { Channel, Client, CommandInteraction, TextChannel } from 'discord.js'
+import { Channel, Client, CommandInteraction, MessageFlags, TextChannel } from 'discord.js'
 import { clearChannelInfo, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const ClearUserChannelHistory: SlashCommand = {
@@ -14,20 +14,22 @@ 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)
             interaction.reply({
                 content: `History cleared in **this channel** cleared for **${interaction.user.username}**.`,
-                ephemeral: true
+                flags: MessageFlags.Ephemeral
             })
         else
             interaction.reply({
                 content: `History was not be found for **${interaction.user.username}** in **this channel**.\n\nPlease chat with **${client.user?.username}** to start a chat history.`,
-                ephemeral: true
+                flags: MessageFlags.Ephemeral
             })
     }
 }

src/commands/deleteModel.ts

@@ -0,0 +1,60 @@
+import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from 'discord.js'
+import { UserCommand, SlashCommand } from '../utils/index.js'
+import { ollama } from '../client.js'
+import { ModelResponse } from 'ollama'
+
+export const DeleteModel: SlashCommand = {
+    name: 'delete-model',
+    description: 'deletes a model from the local list of models. Administrator Only.',
+
+    // set available user options to pass to the command
+    options: [
+        {
+            name: 'model-name',
+            description: 'the name of the model to delete',
+            type: ApplicationCommandOptionType.String,
+            required: true
+        }
+    ],
+
+    // Delete Model locally stored
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // defer reply to avoid timeout
+        await interaction.deferReply()
+        const modelInput: string = interaction.options.get('model-name')!!.value as string
+
+        // fetch channel and message
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || !UserCommand.includes(channel.type)) return
+
+        // Admin Command
+        if (!interaction.memberPermissions?.has('Administrator')) {
+            interaction.reply({
+                content: `${interaction.commandName} is an admin command.\n\nPlease contact a server admin to pull the model you want.`,
+                flags: MessageFlags.Ephemeral
+            })
+            return
+        }
+
+        // check if model exists
+        const modelExists: boolean = await ollama.list()
+            .then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
+
+        try {
+            // call ollama to delete model
+            if (modelExists) {
+                await ollama.delete({ model: modelInput })
+                interaction.editReply({
+                    content: `**${modelInput}** was removed from the the library.`
+                })
+            } else
+                throw new Error()
+        } catch (error) {
+            // could not delete the model
+            interaction.reply({
+                content: `Could not delete the **${modelInput}** model. It probably doesn't exist or you spelled it incorrectly.\n\nPlease try again if this is a mistake.`,
+                flags: MessageFlags.Ephemeral
+            })
+        }
+    }
+}

src/commands/disable.ts

@@ -1,4 +1,4 @@
-import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
 import { AdminCommand, openConfig, SlashCommand } from '../utils/index.js'
 
 export const Disable: SlashCommand = {
@@ -25,17 +25,19 @@ export const Disable: SlashCommand = {
         if (!interaction.memberPermissions?.has('Administrator')) {
             interaction.reply({
                 content: `${interaction.commandName} is an admin command.\n\nPlease contact an admin to use this command for you.`,
-                ephemeral: true
+                flags: MessageFlags.Ephemeral
             })
             return
         }
 
         // 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"}**.`,
-            ephemeral: true
+            flags: MessageFlags.Ephemeral
         })
     }
 }

src/commands/index.ts

@@ -8,6 +8,7 @@ import { PrivateThreadCreate } from './threadPrivateCreate.js'
 import { ClearUserChannelHistory } from './cleanUserChannelHistory.js'
 import { PullModel } from './pullModel.js'
 import { SwitchModel } from './switchModel.js'
+import { DeleteModel } from './deleteModel.js'
 
 export default [
     ThreadCreate,
@@ -18,5 +19,6 @@ export default [
     Capacity,
     ClearUserChannelHistory,
     PullModel,
-    SwitchModel
+    SwitchModel,
+    DeleteModel
 ] as SlashCommand[]

src/commands/messageStream.ts

@@ -1,4 +1,4 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction } from 'discord.js'
+import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from 'discord.js'
 import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const MessageStream: SlashCommand = {
@@ -22,11 +22,13 @@ 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}\``,
-            ephemeral: true
+            flags: MessageFlags.Ephemeral
         })
     }
 }

src/commands/pullModel.ts

@@ -1,12 +1,11 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js";
-import { SlashCommand } from "../utils/commands.js";
-import { ollama } from "../client.js";
-import { ModelResponse } from "ollama";
-import { UserCommand } from "../utils/index.js";
+import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from "discord.js"
+import { ollama } from "../client.js"
+import { ModelResponse } from "ollama"
+import { UserCommand, SlashCommand } from "../utils/index.js"
 
 export const PullModel: SlashCommand = {
     name: 'pull-model',
-    description: 'pulls a model from the ollama model library. Administrator Only',
+    description: 'pulls a model from the ollama model library. Administrator Only.',
 
     // set available user options to pass to the command
     options: [
@@ -32,7 +31,7 @@ export const PullModel: SlashCommand = {
         if (!interaction.memberPermissions?.has('Administrator')) {
             interaction.reply({
                 content: `${interaction.commandName} is an admin command.\n\nPlease contact a server admin to pull the model you want.`,
-                ephemeral: true
+                flags: MessageFlags.Ephemeral
             })
             return
         }

src/commands/shutoff.ts

@@ -1,6 +1,5 @@
-import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { AdminCommand } from '../utils/index.js'
+import { Client, CommandInteraction, MessageFlags } from 'discord.js'
+import { AdminCommand, SlashCommand } from '../utils/index.js'
 
 export const Shutoff: SlashCommand = {
     name: 'shutoff',
@@ -19,7 +18,7 @@ export const Shutoff: SlashCommand = {
         if (!interaction.memberPermissions?.has('Administrator')) {
             interaction.reply({
                 content: `**Shutdown Aborted:**\n\n${interaction.user.tag}, You do not have permission to shutoff **${client.user?.tag}**.`,
-                ephemeral: true
+                flags: MessageFlags.Ephemeral
             })
             return // stop from shutting down
         }
@@ -27,8 +26,9 @@ export const Shutoff: SlashCommand = {
         // Shutoff cleared, do it
         interaction.reply({
             content: `${client.user?.tag} is shutting down.`,
-            ephemeral: true
+            flags: MessageFlags.Ephemeral
         })
+
         console.log(`[Command: shutoff] ${client.user?.tag} is shutting down.`)
 
         // clean up client instance and stop

src/commands/switchModel.ts

@@ -1,8 +1,7 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js";
-import { SlashCommand } from "../utils/commands.js";
-import { ollama } from "../client.js";
-import { ModelResponse } from "ollama";
-import { openConfig, UserCommand } from "../utils/index.js";
+import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js"
+import { ollama } from "../client.js"
+import { ModelResponse } from "ollama"
+import { openConfig, UserCommand, SlashCommand } from "../utils/index.js"
 
 export const SwitchModel: SlashCommand = {
     name: 'switch-model',

src/commands/threadCreate.ts

@@ -1,4 +1,4 @@
-import { ChannelType, Client, CommandInteraction, TextChannel, ThreadChannel } from 'discord.js'
+import { ChannelType, Client, CommandInteraction, MessageFlags, TextChannel, ThreadChannel } from 'discord.js'
 import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'
 
 export const ThreadCreate: SlashCommand = {
@@ -21,14 +21,12 @@ 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({
             content: `I can help you in <#${thread.id}> below.`,
-            ephemeral: true
+            flags: MessageFlags.Ephemeral
         })
     }
 }

src/commands/threadPrivateCreate.ts

@@ -1,4 +1,4 @@
-import { ChannelType, Client, CommandInteraction, TextChannel, ThreadChannel } from 'discord.js'
+import { ChannelType, Client, CommandInteraction, MessageFlags, TextChannel, ThreadChannel } from 'discord.js'
 import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'
 
 export const PrivateThreadCreate: SlashCommand = {
@@ -22,15 +22,12 @@ 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({
             content: `I can help you in <#${thread.id}>.`,
-            ephemeral: true
+            flags: MessageFlags.Ephemeral
         })
     }
 }

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)
-})
+    }
+)

src/events/messageCreate.ts

@@ -1,6 +1,9 @@
 import { TextChannel } from 'discord.js'
 import { event, Events, normalMessage, UserMessage, clean } from '../utils/index.js'
-import { getChannelInfo, getServerConfig, getUserConfig, openChannelInfo, openConfig, UserConfig, getAttachmentData } 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).
@@ -10,7 +13,7 @@ import { getChannelInfo, getServerConfig, getUserConfig, openChannelInfo, openCo
  */
 export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client, defaultModel }, message) => {
     const clientId = client.user!!.id
-    const cleanedMessage = clean(message.content, clientId)
+    let cleanedMessage = clean(message.content, clientId)
     log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
 
         // Do not respond if bot talks in the chat
@@ -138,7 +141,14 @@ export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client
                 throw new Error(`Failed to initialize User Preference for **${message.author.username}**.\n\nIt's likely you do not have a model set. Please use the \`switch-model\` command to do that.`)
 
         // get message attachment if exists
-        const messageAttachment: string[] = await getAttachmentData(message.attachments.first())
+        const attachment = message.attachments.first()
+        let messageAttachment: string[] = []
+
+        if (attachment && attachment.name?.endsWith(".txt"))
+            cleanedMessage += await getTextFileAttachmentData(attachment)
+        else if (attachment)
+            messageAttachment = await getAttachmentData(attachment)
+        
         const model: string = userConfig.options['switch-model']
 
             // set up new queue
@@ -180,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}*`)
         }
-})
+    }
+)

src/events/ready.ts

@@ -14,4 +14,5 @@ export default event(Events.ClientReady, ({ log }, client) => {
         })
 
         log(`Logged in as ${client.user.username}.`)
-})
+    }
+)

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}`)
         }
-})
+    }
+)

src/keys.ts

@@ -4,7 +4,9 @@ export const Keys = {
     clientToken: getEnvVar('CLIENT_TOKEN'),
     ipAddress: getEnvVar('OLLAMA_IP', '127.0.0.1'), // default ollama ip if none
     portAddress: getEnvVar('OLLAMA_PORT', '11434'), // default ollama port if none
-    defaultModel: getEnvVar('MODEL', 'llama3.2')
+    defaultModel: getEnvVar('MODEL', 'llama3.2'),
+    redisHost: getEnvVar('REDIS_IP', '172.18.0.4'), // default redis host if none
+    redisPort: parseInt(getEnvVar('REDIS_PORT', '6379')) // default redis port if none
 } as const // readonly keys
 
 export default Keys

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

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 }
 }

src/utils/handlers/bufferHandler.ts

@@ -55,3 +55,12 @@ export async function getAttachmentData(attachment: Attachment | undefined): Pro
     const base64String = arrayBufferToBase64(buffer)
     return [base64String]
 }
+
+/**
+ * Method to retrieve the string data from the text file
+ * 
+ * @param attachment the text file to convert to a string
+ */
+export async function getTextFileAttachmentData(attachment: Attachment): Promise<string> {
+    return await (await fetch(attachment.url)).text()
+}

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))

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/mentionClean.ts

@@ -1,5 +1,3 @@
-import Keys from "../keys.js"
-
 /**
  * Clean up the bot user_id so it only has the prompt
  * 

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
 

tests/commands.test.ts

@@ -1,9 +1,21 @@
 // describe marks a test suite
 // expect takes a value from an expression
 // it marks a test case
-import { describe, expect, it } from 'vitest'
+import { describe, expect, it, vi } from 'vitest'
 import commands from '../src/commands/index.js'
 
+/**
+ * Mocking redis found in client.ts because of the commands
+ */
+vi.mock('../src/client.js', () => ({
+    redis: {
+        createClient: vi.fn(),
+        connect: vi.fn(),
+        get: vi.fn(),
+        set: vi.fn()
+    }
+}))
+
 /**
  * Commands test suite, tests the commands object
  * Each command is to be tested elsewhere, this file
@@ -22,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')
+        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(', '))
     })
 })