Guide and Documentation Overhaul (#79)

* Update: Local setup

* Update: docker setup changes

* Add: Discord App Creation Guide

* Update: readme changes

* Update: discord app guide link

.env.sample

@@ -4,20 +4,17 @@ CLIENT_TOKEN = BOT_TOKEN
 # id token of a discord server
 GUILD_ID = GUILD_ID
 
-# Channel where the bot listens to messages
-CHANNEL_ID = CHANNEL_ID
-
 # model for the bot to query from (i.e. llama2 [llama2:13b], mistral, codellama, etc... )
 MODEL = MODEL_NAME
 
 # discord bot user id for mentions
 CLIENT_UID = BOT_USER_ID
 
-# ip/port address of docker container, I use 172.18.X.X for docker, 127.0.0.1 for local
+# ip/port address of docker container, I use 172.18.0.3 for docker, 127.0.0.1 for local
 OLLAMA_IP = IP_ADDRESS
 OLLAMA_PORT = PORT
 
-# ip address for discord bot container, I use 172.18.X.X, use different IP than ollama_ip
+# ip address for discord bot container, I use 172.18.0.2, use different IP than ollama_ip
 DISCORD_IP = IP_ADDRESS
 
 # subnet address, ex. 172.18.0.0 as we use /16.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Bug Report for Fixes/Improvements
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest Features
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Issue
+A clear and concise description of what the problem/feature is.
+
+## Solution
+* Provide steps or ideals to how to implement or investigate this new feature.
+
+## References
+* Provide additional context and external references here

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## Steps to Creating a Pull Request
+* Assign yourself as the **Assignee**
+* Allow one of the Code Owners/Maintainers review the changes proposed by the Pull Request.
+* Provide appropriate labels as necessary
+
+> [!TIP]
+> `enchancement` for new features, `documentation` for modifications to the docs, `performance` for performance related changes, and so on.
+
+* Provide a description of the work that has been done.
+    * It is nice to know what was added, removed, modified, and with screenshots of those changes.
+
+> [!TIP]
+> You can have them under **Added**, **Removed**, **Updates**, and **Screenshots** if any (**Changes** could also be used).
+
+## After the Pull Request is Opened
+* One the Pull Request has been created, please add any Issue(s) that are being addressed by this change (if any).
+* If the reviewer(s) mention any changes or open threads for questions, please resolve those as soon as you can.

.github/workflows/build-test.yml

@@ -1,82 +0,0 @@
-name: Builds
-run-name: Validate Node and Docker Builds
-on:
-    push:
-        branches:
-            - master
-
-jobs: 
-    Discord-Node-Build: # test if the node install and run
-        runs-on: ubuntu-latest
-        timeout-minutes: 2
-        steps:
-            - name: Checkout Repository
-              uses: actions/checkout@v4
-
-            - name: Set up Node Environment v18.18.2
-              uses: actions/setup-node@v4
-              with:
-                node-version: 18.18.2
-                cache: 'npm'
-
-            - name: Install Project Dependencies
-              run: |
-                npm install
-
-            - name: Build Application
-              run: |
-                npm run build
-
-            - name: Create Environment Variables
-              run: |
-                touch .env
-                echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-                echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
-                echo CHANNEL_ID = ${{ secrets.CHANNEL_ID }} >> .env
-                echo MODEL = ${{ secrets.MODEL }} >> .env
-                echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
-                echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-                echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-              
-              # set -e ensures if nohup fails, this section fails
-            - name: Startup Discord Bot Client
-              run: |
-                set -e
-                nohup npm run prod &
-
-    Discord-Ollama-Container-Build: # test docker build and run
-      runs-on: ubuntu-latest
-      timeout-minutes: 2
-      steps:
-          - name: Checkout Repository
-            uses: actions/checkout@v4
-
-          - name: Set up Node Environment v18.18.2
-            uses: actions/setup-node@v4
-            with:
-              node-version: 18.18.2
-              cache: 'npm'
-
-          - name: Create Environment Variables
-            run: |
-              touch .env
-              echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-              echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
-              echo CHANNEL_ID = ${{ secrets.CHANNEL_ID }} >> .env
-              echo MODEL = ${{ secrets.MODEL }} >> .env
-              echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
-              echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-              echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-
-          - name: Setup Docker Network and Images
-            run: |
-              npm run docker:start-cpu
-          
-          - name: Check Images Exist
-            run: |
-              (docker images | grep -q 'discord/bot' && docker images | grep -qE 'ollama/ollama') || exit 1
-
-          - name: Check Containers Exist
-            run: |
-              (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1
-

.github/workflows/build.yml

@@ -0,0 +1,88 @@
+name: Builds
+run-name: Validate Node and Docker Builds
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - '/'
+      - '!docs/**'
+      - '!imgs/**'
+      - '!.github/**'
+      - '.github/workflows/**'
+      - '!.gitignore'
+      - '!LICENSE'
+      - '!README'
+
+jobs:
+  Discord-Node-Build: # test if the node install and run
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/hydrogen
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/hydrogen
+          cache: "npm"
+
+      - name: Install Project Dependencies
+        run: |
+          npm install
+
+      - name: Build Application
+        run: |
+          npm run build
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+
+        # set -e ensures if nohup fails, this section fails
+      - name: Startup Discord Bot Client
+        run: |
+          set -e
+          nohup npm run prod &
+
+  Discord-Ollama-Container-Build: # test docker build and run
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/hydrogen
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/hydrogen
+          cache: "npm"
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+
+      - name: Setup Docker Network and Images
+        run: |
+          npm run docker:start-cpu
+
+      - name: Check Images Exist
+        run: |
+          (docker images | grep -q 'discord/bot' && docker images | grep -qE 'ollama/ollama') || exit 1
+
+      - name: Check Containers Exist
+        run: |
+          (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1

.github/workflows/test.yml

@@ -0,0 +1,78 @@
+name: Tests
+run-name: Unit Tests
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - '/'
+      - '!docs/**'
+      - '!imgs/**'
+      - '!.github/**'
+      - '.github/workflows/**'
+      - '!.gitignore'
+      - '!LICENSE'
+      - '!README'
+
+jobs:
+  Discord-Node-Test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/hydrogen
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/hydrogen
+          cache: "npm"
+
+      - name: Install Project Dependencies
+        run: |
+          npm install
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+
+      - name: Test Application
+        run: |
+          npm run test:run
+
+  Discord-Ollama-Container-Test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/hydrogen
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/hydrogen
+          cache: "npm"
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+
+      - name: Setup Docker Network and Images
+        run: |
+          npm run docker:start-cpu
+
+      - name: Test Docker Container
+        run: |
+          npm run docker:test

Dockerfile

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

README.md

@@ -4,7 +4,8 @@
     <h3><a href="#"></a>Ollama as your Discord AI Assistant</h3>
     <p><a href="#"></a><a href="https://creativecommons.org/licenses/by/4.0/"><img alt="License" src="https://img.shields.io/badge/License-CC_BY_4.0-darkgreen.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/kevinthedang/discord-ollama?logo=github" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build-test.yml"><img alt="Build Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build-test.yml/badge.svg" /></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Build Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Testing Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
 </div>
 
 ## About/Goals
@@ -12,13 +13,18 @@ Ollama is an AI model management tool that allows users to install and use custo
 The project aims to:
 * [x] Create a Discord bot that will utilize Ollama and chat to chat with users! 
   * [ ] User Preferences on Chat
-  * [ ] Message Persistance on Channels and Threads
+  * [x] Message Persistance on Channels and Threads
+    * [x] Threads
+    * [x] Channels
   * [x] Containerization with Docker
   * [x] Slash Commands Compatible
-  * [x] Generated Token Length Handling for >2000 ~~or >6000 characters~~
+  * [x] Generated Token Length Handling for >2000
     * [x] Token Length Handling of any message size
-  * [ ] External WebUI Integration
+  * [ ] User vs. Server Preferences
+  * [ ] Redis Caching
   * [x] Administrator Role Compatible
+  * [ ] Multi-User Chat Generation (Multiple users chatting at the same time)
+  * [ ] 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
@@ -27,20 +33,25 @@ The project aims to:
 * Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
 * You will need a `.env` file in the root of the project directory with the bot's token. There is a `.env.sample` is provided for you as a reference for what environment variables.
     * For example, `CLIENT_TOKEN = [Bot Token]`
-* Please refer to the docs for bot setup. **NOTE**: These guides assume you already know how to setup a bot account for discord.
+* Please refer to the docs for bot setup.
     * [Local Machine Setup](./docs/setup-local.md)
     * [Docker Setup for Servers and Local Machines](./docs/setup-docker.md)
+        * Nvidia is recommended for now, but support for other GPUs should be development.
         * Local use is not recommended.
+    * [Creating a Discord App](./docs/setup-discord-app.md)
 
 ## Resources
 * [NodeJS](https://nodejs.org/en)
-    * This project uses `v20.10.0+` (npm `10.2.5`). Consider using [nvm](https://github.com/nvm-sh/nvm) for multiple NodeJS versions.
+    * This project runs on `lts\hydrogen`.
-        * To run dev in `ts-node`, using `v18.18.2` is recommended. **CAUTION**: `v18.19.0` or `lts/hydrogen` will not run properly.
+        * To run dev in `ts-node`/`nodemon`, using `v18.18.2` is recommended. 
         * To run dev with `tsx`, you can use `v20.10.0` or earlier.
     * This project supports any NodeJS version above `16.x.x` to only allow ESModules.
-* [Ollama](https://ollama.ai/)
+* [Ollama](https://ollama.com/)
     * [Ollama Docker Image](https://hub.docker.com/r/ollama/ollama)
-    * **IMPORTANT**: For Nvidia GPU setup, **install** `nvidia container toolkit/runtime` then **configure** it with Docker to utilize Nvidia driver.
+
+> [!CAUTION]
+> `v18.X.X` or `lts/hydrogen` will not run properly for `npm run dev-mon`. It is recommended to just use `npm run dev-tsx` for development. The nodemon version will likely be removed in a future update.
+
 * [Discord Developer Portal](https://discord.com/developers/docs/intro)
 * [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)

docker-compose.yml

@@ -8,11 +8,10 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: discord/bot:0.4.4
+    image: discord/bot:0.5.2
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       GUILD_ID: ${GUILD_ID}
-      CHANNEL_ID: ${CHANNEL_ID}
       MODEL: ${MODEL}
       CLIENT_UID: ${CLIENT_UID}
       OLLAMA_IP: ${OLLAMA_IP}
@@ -40,6 +39,8 @@ services:
     ports: 
       - ${OLLAMA_PORT}:${OLLAMA_PORT}
 
+# Put Redis Container here?
+
 # create a network that supports giving addresses withing a specific subnet
 networks:
   ollama-net:

docs/setup-discord-app.md

@@ -0,0 +1,47 @@
+## Discord App/Bot Setup
+* Refer to the [Discord Developers](https://discord.com/build/app-developers) tab on their site.
+* Click on **Getting Started** and it may prompt you to log in. Do that.
+* You should see this upon logging in.
+
+![First App!](../imgs/tutorial/discord-dev.png)
+
+* Click on **Create App**, you should not be prompted to create an App with a name. If you are apart of a team, you may choose to create it for your team or for yourself.
+
+![App Create Modal](../imgs/tutorial/create-app.png)
+
+* Great! Not you should have your App created. It should bring you to a page like this.
+
+![Created App](../imgs/tutorial/created-app.png)
+
+* From here, you will need you App's token, navigate to the **Bot** tab and click **Reset Token** to generate a new token to interact with you bot.
+* The following app will not exist, usage of this token will be pointless as this is a guide.
+
+![Token](../imgs/tutorial/token.png)
+
+* You will also need your App's **Client ID**, navigate to **OAuth2** and copy your id.
+
+![Client Id](../imgs/tutorial/client-id.png)
+
+* That should be all of the environment variables needed from Discord, now we need this app on your server.
+* Navigate to **Installation** and Copy the provided **Install Link** to allow your App to your server.
+* You should set the **Guild Install** permissions as you like, for this purpose we will allow admin priviledges for now. Ensure the **bot** scope is added to do this.
+
+![Scope](../imgs/tutorial/scope.png)
+![Invite Link](../imgs/tutorial/invite.png)
+
+* Notice that your App's **Client Id** is apart of the **Install Link**.
+* Paste this link in a web browser and you should see something like this.
+
+![Server Invite Initial](../imgs/tutorial/server-invite-1.png)
+
+* Click **Add to Server** and you should see this.
+
+![Server Invite Auth](../imgs/tutorial/server-invite-2-auth.png)
+
+* Choose a server to add the App to, then click **Continue** then **Authorize**. You should see this after that.
+
+![Invite Success](../imgs/tutorial/server-invite-3.png)
+
+* Congratulations! You should now see you App on your server!
+
+![Its Alive!](../imgs/tutorial/bot-in-server.png)

docs/setup-docker.md

@@ -47,6 +47,7 @@ sudo systemctl restart docker
     * `DISCORD_IP = 172.18.0.3`
     * `SUBNET_ADDRESS = 172.18.0.0`
     * 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)
 * You will need a model in the container for this to work properly, on Docker Desktop go to the `Containers` tab, select the `ollama` container, and select `Exec` to run as root on your container. Now, run `ollama pull [model name]` to get your model.
     * For Linux Servers, you need another shell to pull the model, or if you run `docker compose build && docker compose up -d`, then it will run in the background to keep your shell. Run `docker exec -it ollama bash` to get into the container and run the samme pull command above.
 * 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.
@@ -54,6 +55,7 @@ sudo systemctl restart docker
     * `docker compose stop`
     * `docker compose rm`
     * `docker ps` to check if containers have been removed.
+    * This may not work if the nvidia installation was done incorrectly. If this is the case, please utilize the [Manual "Clean-up"](#manual-run-with-docker) shown below.
 * You can also use `npm run clean` to clean up the containers and remove the network to address a possible `Address already in use` problem.
 
 ## Manual Run (with Docker)

docs/setup-local.md

@@ -1,19 +1,24 @@
 ## Ollama Setup
 * Go to Ollama's [Linux download page](https://ollama.ai/download/linux) and run the simple curl command they provide. The command should be `curl https://ollama.ai/install.sh | sh`.
-* Now the the following commands in separate terminals to test out how it works!
+* Since Ollama will run as a systemd service, there is no need to run `ollama serve` unless you disable it. If you do disable it or have an older `ollama` version, do the following:
     * In terminal 1 -> `ollama serve` to setup ollama
     * In terminal 2 -> `ollama run [model name]`, for example `ollama run llama2`
         * The models can vary as you can create your own model. You can also view ollama's [library](https://ollama.ai/library) of models.
-    * If there are any issues running ollama because of missing LLMs, run `ollama pull [model name]` as it will pull the model if Ollama has it in their library.
+* Otherwise, if you have the latest `ollama`, you can just run `ollama run [model name]` rather than running this in 2 terminals.
+* If there are any issues running ollama because of missing LLMs, run `ollama pull [model name]` as it will pull the model if Ollama has it in their library.
     * This can also be done in [wsl](https://learn.microsoft.com/en-us/windows/wsl/install) for Windows machines.
+    * This should also not be a problem is a future feature that allows for pulling of models via discord client. For now, they must be pulled manually.
 * You can now interact with the model you just ran (it might take a second to startup).
     * Response time varies with processing power!
 
 ## To Run Locally (without Docker)
 * Run `npm install` to install the npm packages.
 * Ensure that your [.env](../.env.sample) file's `OLLAMA_IP` is `127.0.0.1` to work properly.
+    * You only need your `CLIENT_TOKEN`, `GUILD_ID`, `MODEL`, `CLIENT_UID`, `OLLAMA_IP`, `OLLAMA_PORT`.
+    * The ollama ip and port should just use it's defaults by nature. If not, utilize `OLLAMA_IP = 127.0.0.1` and `OLLAMA_PORT = 11434`.
 * Now, you can run the bot by running `npm run client` which will build and run the decompiled typescript and run the setup for ollama.
     * **IMPORTANT**: This must be ran in the wsl/Linux instance to work properly! Using Command Prompt/Powershell/Git Bash/etc. will not work on Windows (at least in my experience).
     * Refer to the [resources](../README.md#resources) on what node version to use.
-* Open up a separate terminal/shell (you will need wsl for this if on windows) and run `ollama serve` to startup ollama.
+* If you are using wsl, open up a separate terminal/shell to startup the ollama service. Again, if you are running an older ollama, you must run `ollama serve` in that shell.
+    * If you are on an actual Linux machine/VM there is no need for another terminal (unless you have an older ollama version).
     * If you do not have a model, you will need to run `ollama pull [model name]` in a separate terminal to get it.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.4.4",
+  "version": "0.5.2",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",
@@ -8,15 +8,18 @@
     "dev-tsx": "tsx watch src/index.ts",
     "dev-mon": "nodemon --config nodemon.json src/index.ts",
     "build": "tsc",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "prod": "node .",
     "client": "npm run build && npm run prod",
     "clean": "docker compose down && docker rmi $(docker images | grep $(node -p \"require('./package.json').version\") | 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:start": "npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama",
     "docker:start-cpu": "npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama-cpu",
-    "docker:clean": "docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
+    "docker:clean": "docker rm -f discord && docker rm -f ollama && 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 discord/bot:$(node -p \"require('./package.json').version\") .",
+    "docker:test": "docker run -d --rm -v discord:/src/app --name test discord/bot:$(node -p \"require('./package.json').version\") npm run test:run",
     "docker:client": "docker run -d -v discord:/src/app --name discord --network ollama-net --ip 172.18.0.3 discord/bot:$(node -p \"require('./package.json').version\")",
     "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"
@@ -24,16 +27,18 @@
   "author": "Kevin Dang",
   "license": "ISC",
   "dependencies": {
-    "discord.js": "^14.14.1",
+    "discord.js": "^14.15.3",
-    "dotenv": "^16.3.1",
+    "dotenv": "^16.4.5",
-    "ollama": "^0.5.0"
+    "ollama": "^0.5.2"
   },
   "devDependencies": {
-    "@types/node": "^20.10.5",
+    "@types/node": "^20.14.2",
-    "nodemon": "^3.0.2",
+    "@vitest/coverage-v8": "^1.6.0",
+    "nodemon": "^3.1.3",
     "ts-node": "^10.9.2",
-    "tsx": "^4.6.2",
+    "tsx": "^4.15.5",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0"
   },
   "type": "module",
   "engines": {

src/commands/capacity.ts

@@ -1,6 +1,6 @@
 import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
 import { SlashCommand } from '../utils/commands.js'
-import { openFile } from '../utils/jsonHandler.js'
+import { openConfig } from '../utils/jsonHandler.js'
 
 export const Capacity: SlashCommand = {
     name: 'modify-capacity',
@@ -20,10 +20,10 @@ export const Capacity: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // set state of bot chat features
-        openFile('config.json', interaction.commandName, interaction.options.get('context-capacity')?.value)
+        openConfig('config.json', interaction.commandName, interaction.options.get('context-capacity')?.value)
 
         interaction.reply({
             content: `Message History Capacity has been set to \`${interaction.options.get('context-capacity')?.value}\``,

src/commands/channelToggle.ts

@@ -0,0 +1,34 @@
+import { ApplicationCommandOptionType, ChannelType, Client, CommandInteraction } from 'discord.js'
+import { SlashCommand } from '../utils/commands.js'
+import { openConfig } from '../utils/jsonHandler.js'
+
+export const ChannelToggle: SlashCommand = {
+    name: 'channel-toggle',
+    description: 'toggles channel or thread usage.',
+
+    // set user option for toggling
+    options: [
+        {
+            name: 'toggle-channel',
+            description: 'toggle channel usage, otherwise threads',
+            type: ApplicationCommandOptionType.Boolean,
+            required: true
+        }
+    ],
+
+    // Query for chatting preference
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // fetch channel location
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
+
+
+        // set state of bot channel preferences
+        openConfig('config.json', interaction.commandName, interaction.options.get('toggle-channel')?.value)
+
+        interaction.reply({
+            content: `Channel Preferences have for Regular Channels set to \`${interaction.options.get('toggle-channel')?.value}\``,
+            ephemeral: true
+        })
+    }
+}

src/commands/disable.ts

@@ -1,6 +1,6 @@
 import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
 import { SlashCommand } from '../utils/commands.js'
-import { openFile } from '../utils/jsonHandler.js'
+import { openConfig } from '../utils/jsonHandler.js'
 
 export const Disable: SlashCommand = {
     name: 'toggle-chat',
@@ -32,7 +32,7 @@ export const Disable: SlashCommand = {
         }
 
         // set state of bot chat features
-        openFile('config.json', interaction.commandName, interaction.options.get('enabled')?.value)
+        openConfig('config.json', interaction.commandName, interaction.options.get('enabled')?.value)
 
         interaction.reply({
             content: `Chat features has been \`${interaction.options.get('enabled')?.value ?  "enabled" : "disabled" }\``,

src/commands/index.ts

@@ -5,12 +5,16 @@ import { MessageStream } from './messageStream.js'
 import { Disable } from './disable.js'
 import { Shutoff } from './shutoff.js'
 import { Capacity } from './capacity.js'
+import { PrivateThreadCreate } from './threadPrivateCreate.js'
+import { ChannelToggle } from './channelToggle.js'
 
 export default [
     ThreadCreate,
+    PrivateThreadCreate,
     MessageStyle,
     MessageStream,
     Disable,
     Shutoff,
-    Capacity
+    Capacity,
+    ChannelToggle
 ] as SlashCommand[]

src/commands/messageStream.ts

@@ -1,6 +1,6 @@
 import { ApplicationCommandOptionType, ChannelType, Client, CommandInteraction } from 'discord.js'
 import { SlashCommand } from '../utils/commands.js'
-import { openFile } from '../utils/jsonHandler.js'
+import { openConfig } from '../utils/jsonHandler.js'
 
 export const MessageStream: SlashCommand = {
     name: 'message-stream',
@@ -20,13 +20,13 @@ export const MessageStream: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // verify channel
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // save value to json and write to it
-        openFile('config.json', interaction.commandName, interaction.options.get('stream')?.value)
+        openConfig('config.json', interaction.commandName, interaction.options.get('stream')?.value)
 
         interaction.reply({
-            content: `Message streaming preferences for embed set to: \`${interaction.options.get('stream')?.value}\``,
+            content: `Message streaming preferences set to: \`${interaction.options.get('stream')?.value}\``,
             ephemeral: true
         })
     }

src/commands/messageStyle.ts

@@ -1,6 +1,6 @@
 import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
 import { SlashCommand } from '../utils/commands.js'
-import { openFile } from '../utils/jsonHandler.js'
+import { openConfig } from '../utils/jsonHandler.js'
 
 export const MessageStyle: SlashCommand = {
     name: 'message-style',
@@ -20,10 +20,10 @@ export const MessageStyle: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // set the message style
-        openFile('config.json', interaction.commandName, interaction.options.get('embed')?.value)
+        openConfig('config.json', interaction.commandName, interaction.options.get('embed')?.value)
 
         interaction.reply({
             content: `Message style preferences for embed set to: \`${interaction.options.get('embed')?.value}\``,

src/commands/threadCreate.ts

@@ -1,5 +1,6 @@
 import { ChannelType, Client, CommandInteraction, TextChannel } from 'discord.js'
 import { SlashCommand } from '../utils/commands.js'
+import { openThreadInfo } from '../utils/jsonHandler.js'
 
 export const ThreadCreate: SlashCommand = {
     name: 'thread',
@@ -12,16 +13,21 @@ export const ThreadCreate: SlashCommand = {
         if (!channel || channel.type !== ChannelType.GuildText) return
 
         const thread = await (channel as TextChannel).threads.create({
-            name: `support-${Date.now()}`,
+            name: `${client.user?.username}-support-${Date.now()}`,
-            reason: `Support ticket ${Date.now()}`
+            reason: `Support ticket ${Date.now()}`,
+            type: ChannelType.PublicThread
         })
 
         // Send a message in the thread
-        thread.send(`**User:** ${interaction.user} \n**People in Coversation:** ${thread.memberCount}`)
+        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 prompt.`)
+
+        // handle storing this chat channel
+        // store: thread.id, thread.name
+        openThreadInfo(`${thread.id}.json`, thread)
 
         // user only reply
         return interaction.reply({
-            content: `I can help you in the Thread below. \n**Thread ID:** ${thread.id}`,
+            content: `I can help you in thread **${thread.id}** below.`,
             ephemeral: true
         })
     }

src/commands/threadPrivateCreate.ts

@@ -0,0 +1,34 @@
+import { ChannelType, Client, CommandInteraction, TextChannel } from 'discord.js'
+import { SlashCommand } from '../utils/commands.js'
+import { openThreadInfo } from '../utils/jsonHandler.js'
+
+export const PrivateThreadCreate: SlashCommand = {
+    name: 'private-thread',
+    description: 'creates a private thread and mentions user',
+
+    // Query for server information
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // fetch the channel
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || channel.type !== ChannelType.GuildText) return
+
+        const thread = await (channel as TextChannel).threads.create({
+            name: `${client.user?.username}-private-support-${Date.now()}`,
+            reason: `Support ticket ${Date.now()}`,
+            type: ChannelType.PrivateThread
+        })
+
+        // Send a message in the thread
+        thread.send(`Hello ${interaction.user}! \n\nIt's nice to meet you. Please talk to me by typing @${client.user?.username} with your prompt.`)
+
+        // handle storing this chat channel
+        // store: thread.id, thread.name
+        openThreadInfo(`${thread.id}.json`, thread)
+
+        // user only reply
+        return interaction.reply({
+            content: `I can help you in thread **${thread.id}**. Please refer to the private channel below this one.`,
+            ephemeral: true
+        })
+    }
+}

src/events/index.ts

@@ -2,10 +2,12 @@ import { Event } from '../utils/index.js'
 import interactionCreate from './interactionCreate.js'
 import messageCreate from './messageCreate.js'
 import ready from './ready.js'
+import threadDelete from './threadDelete.js'
 
 // Centralized export for all events
 export default [
     ready,
     messageCreate,
-    interactionCreate
+    interactionCreate,
+    threadDelete
 ] as Event[] // staticly is better ts practice, dynamic exporting is possible

src/events/messageCreate.ts

@@ -1,18 +1,15 @@
-import { ChatResponse } from 'ollama'
+import { embedMessage, event, Events, normalMessage, UserMessage } from '../utils/index.js'
-import { embedMessage, event, Events, normalMessage } from '../utils/index.js'
+import { Configuration, getChannelInfo, getConfig, getThread, openChannelInfo, openConfig, openThreadInfo } from '../utils/jsonHandler.js'
-import { Configuration, getConfig, openFile } from '../utils/jsonHandler.js'
 import { clean } from '../utils/mentionClean.js'
+import { TextChannel, ThreadChannel } from 'discord.js'
 
 /** 
  * Max Message length for free users is 2000 characters (bot or not).
  * @param message the message received from the channel
  */
-export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama }, message) => {
+export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama, client }, message) => {
     log(`Message \"${clean(message.content)}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
 
-    // Hard-coded channel to test output there only, in our case "ollama-endpoint"
-    if (message.channelId != tokens.channel) return
-
     // Do not respond if bot talks in the chat
     if (message.author.tag === message.client.user.tag) return
 
@@ -37,6 +34,14 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
                     return
                 }
 
+                // ensure channel json exists, if not create it
+                if (config.options['channel-toggle']) {
+                    openChannelInfo(message.channelId,
+                        message.channel as TextChannel, 
+                        message.author.tag
+                    )
+                }
+
                 // check if there is a set capacity in config
                 if (typeof config.options['modify-capacity'] !== 'number')
                     log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
@@ -54,7 +59,31 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
             })
         })
 
-        let response: string    
+        // need new check for "open/active" threads/channels here!
+        const chatMessages: UserMessage[] = await new Promise((resolve) => {
+            // set new queue to modify
+            if (config.options['channel-toggle']) {
+                getChannelInfo(`${message.channelId}-${message.author.tag}.json`, (channelInfo) => {
+                    if (channelInfo?.messages)
+                        resolve(channelInfo.messages)
+                    else
+                        log(`Channel ${message.channel}-${message.author.tag} does not exist.`)
+                })
+            } else {
+                getThread(`${message.channelId}.json`, (threadInfo) => {
+                    if (threadInfo?.messages)
+                        resolve(threadInfo.messages)
+                    else
+                        log(`Thread ${message.channelId} does not exist.`)
+                }) 
+            }
+        })
+
+        // response string for ollama to put its response
+        let response: string
+
+        // set up new queue
+        msgHist.setQueue(chatMessages)
 
         // check if we can push, if not, remove oldest
         while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
@@ -82,9 +111,23 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
             role: 'assistant', 
             content: response
         })
+
+        // only update the json on success
+        if (config.options['channel-toggle']) {
+            openChannelInfo(message.channelId, 
+                message.channel as TextChannel, 
+                message.author.tag, 
+                msgHist.getItems()
+            )
+        } else {
+            openThreadInfo(`${message.channelId}.json`, 
+                client.channels.fetch(message.channelId) as unknown as ThreadChannel, 
+                msgHist.getItems()
+            )
+        }
     } catch (error: any) {
         msgHist.pop() // remove message because of failure
-        openFile('config.json', 'message-style', false)
+        openConfig('config.json', 'message-style', false)
         message.reply(`**Error Occurred:**\n\n**Reason:** *${error.message}*`)
     }
 })

src/events/threadDelete.ts

@@ -0,0 +1,20 @@
+import { ThreadChannel } from 'discord.js'
+import { event, Events } from '../utils/index.js'
+import fs from 'fs'
+
+/**
+ * Event to remove the associated .json file for a thread once deleted
+ */
+export default event(Events.ThreadDelete, ({ log }, thread: ThreadChannel) => {
+    const filePath = `data/${thread.id}.json`
+    if (fs.existsSync(filePath)) {
+        fs.unlink(filePath, (error) => {
+            if (error)
+                log(`Error deleting file ${filePath}`, error)
+            else
+                log(`Successfully deleted ${filePath} thread info`)
+        })
+    } else {
+        log(`File ${filePath} does not exist.`)
+    }
+})

src/keys.ts

@@ -2,7 +2,6 @@ import { getEnvVar } from './utils/env.js'
 
 export const Keys = {
     clientToken: getEnvVar('CLIENT_TOKEN'),
-    channel: getEnvVar('CHANNEL_ID'),
     model: getEnvVar('MODEL'),
     clientUid: getEnvVar('CLIENT_UID'),
     guildId: getEnvVar('GUILD_ID'),

src/queues/queue.ts

@@ -53,10 +53,18 @@ export class Queue<T> implements IQueue<T> {
     }
 
     /**
-     * Geet the queue as an array
+     * Get the queue as an array
      * @returns a array of T items
      */
     getItems(): T[] {
         return this.storage
     }
+
+    /**
+     * Set a new queue to modify
+     * @param newQueue new queue of T[] to modify
+     */
+    setQueue(newQueue: T[]): void {
+        this.storage = newQueue
+    }
 }

src/utils/events.ts

@@ -15,7 +15,6 @@ export type EventKeys = keyof ClientEvents // only wants keys of ClientEvents ob
  * @param clientUid the discord id for the bot
  */
 export type Tokens = {
-    channel: string,
     model: string,
     clientUid: string
 }

src/utils/jsonHandler.ts

@@ -1,4 +1,7 @@
+import { TextChannel, ThreadChannel } from 'discord.js'
+import { UserMessage } from './events.js'
 import fs from 'fs'
+import path from 'path'
 
 export interface Configuration {
     readonly name: string
@@ -6,10 +9,24 @@ export interface Configuration {
         'message-stream'?: boolean,
         'message-style'?: boolean,
         'toggle-chat'?: boolean,
-        'modify-capacity'?: number
+        'modify-capacity'?: number,
+        'channel-toggle'?: boolean
     }
 }
 
+export interface Thread {
+    readonly id: string
+    readonly name: string
+    messages: UserMessage[]
+}
+
+export interface Channel {
+    readonly id: string
+    readonly name: string
+    readonly user: string
+    messages: UserMessage[]
+}
+
 /**
  * Method to open a file in the working directory and modify/create it
  * 
@@ -17,19 +34,19 @@ export interface Configuration {
  * @param key key value to access
  * @param value new value to assign
  */
-export function openFile(filename: string, key: string, value: any) {
+export function openConfig(filename: string, key: string, value: any) {
     // check if the file exists, if not then make the config file
     if (fs.existsSync(filename)) {
         fs.readFile(filename, 'utf8', (error, data) => {
             if (error)
-                console.log(`[Error: openFile] Incorrect file format`)
+                console.log(`[Error: openConfig] Incorrect file format`)
             else {
                 const object = JSON.parse(data)
                 object['options'][key] = value
                 fs.writeFileSync(filename, JSON.stringify(object, null, 2))
             }
         })
-    } else {
+    } else { // work on dynamic file creation
         const object: Configuration = JSON.parse('{ \"name\": \"Discord Ollama Confirgurations\" }')
 
         // set standard information for config file and options
@@ -38,10 +55,16 @@ export function openFile(filename: string, key: string, value: any) {
         }
 
         fs.writeFileSync(filename, JSON.stringify(object, null, 2))
-        console.log(`[Util: openFile] Created 'config.json' in working directory`)
+        console.log(`[Util: openConfig] Created '${filename}' in working directory`)
     }
 }
 
+/**
+ * Method to obtain the configurations of the message chat/thread
+ * 
+ * @param filename name of the configuration file to get
+ * @param callback function to allow a promise from getting the config
+ */
 export async function getConfig(filename: string, callback: (config: Configuration | undefined) => void): Promise<void> {
     // attempt to read the file and get the configuration
     if (fs.existsSync(filename)) {
@@ -55,4 +78,129 @@ export async function getConfig(filename: string, callback: (config: Configurati
     } else {
         callback(undefined) // file not found
     }
+}
+
+/**
+ * Method to open/create and modify a json file containing thread information
+ * 
+ * @param filename name of the thread file
+ * @param thread the thread with all of the interactions
+ * @param message message contents and from who
+ */
+export function openThreadInfo(filename: string, thread: ThreadChannel, messages: UserMessage[] = []) {
+    // check if the file exists, if not then make the config file
+    const fullFileName = `data/${filename}`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error)
+                console.log(`[Error: openThreadInfo] Incorrect file format`)
+            else {
+                const object = JSON.parse(data)
+                object['messages'] = messages as []
+                fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+            }
+        })
+    } else { // file doesn't exist, create it
+        const object: Configuration = JSON.parse(`{ \"id\": \"${thread?.id}\", \"name\": \"${thread?.name}\", \"messages\": []}`)
+
+        const directory = path.dirname(fullFileName)
+        if (!fs.existsSync(directory))
+            fs.mkdirSync(directory, { recursive: true })
+
+        // only creating it, no need to add anything
+        fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+        console.log(`[Util: openThreadInfo] Created '${fullFileName}' in working directory`)
+    }
+}
+
+/**
+ * Method to obtain the configurations of the message chat/thread
+ * 
+ * @param filename name of the configuration file to get
+ * @param callback function to allow a promise from getting the config
+ */
+export async function getThread(filename: string, callback: (config: Thread | undefined) => void): Promise<void> {
+    // attempt to read the file and get the configuration
+    const fullFileName = `data/${filename}`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error) {
+                callback(undefined) 
+                return // something went wrong... stop
+            }
+            callback(JSON.parse(data))
+        })
+    } else {
+        callback(undefined) // file not found
+    }
+}
+
+/**
+ * Method to open the channel history
+ * 
+ * @param filename name of the json file for the channel by user
+ * @param channel the text channel info
+ * @param user the user's name
+ * @param messages their messages
+ */
+export async function openChannelInfo(filename: string, channel: TextChannel, user: string, messages: UserMessage[] = []): Promise<void> {
+    // thread exist handler
+    const isThread: boolean = await new Promise((resolve) => {
+        getThread(`${channel.id}.json`, (threadInfo) => {
+            if (threadInfo?.messages)
+                resolve(true)
+            else
+                resolve(false)
+        })
+    })
+
+    // This is an existing thread, don't create another json
+    if (isThread) return
+
+    const fullFileName = `data/${filename}-${user}.json`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error)
+                console.log(`[Error: openChannelInfo] Incorrect file format`)
+            else {
+                const object = JSON.parse(data)
+                if (object['messages'].length === 0)
+                    object['messages'] = messages as []
+                else if (object['messages'].length !== 0 && messages.length !== 0)
+                    object['messages'] = messages as []
+                fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+            }
+        })
+    } else { // file doesn't exist, create it
+        const object: Configuration = JSON.parse(`{ \"id\": \"${channel?.id}\", \"name\": \"${channel?.name}\", \"user\": \"${user}\", \"messages\": []}`)
+
+        const directory = path.dirname(fullFileName)
+        if (!fs.existsSync(directory))
+            fs.mkdirSync(directory, { recursive: true })
+
+        // only creating it, no need to add anything
+        fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+        console.log(`[Util: openChannelInfo] Created '${fullFileName}' in working directory`)
+    }
+}
+
+/**
+ * Method to get the channel information/history
+ * 
+ * @param filename name of the json file for the channel by user
+ * @param callback function to handle resolving message history
+ */
+export async function getChannelInfo(filename: string, callback: (config: Channel | undefined) => void): Promise<void> {
+    const fullFileName = `data/${filename}`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error) {
+                callback(undefined) 
+                return // something went wrong... stop
+            }
+            callback(JSON.parse(data))
+        })
+    } else {
+        callback(undefined) // file not found
+    }
 }

src/utils/messageEmbed.ts

@@ -2,6 +2,7 @@ import { EmbedBuilder, Message } from 'discord.js'
 import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
 import { Queue } from '../queues/queue.js'
+import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 
 /**
  * Method to send replies as normal text on discord like any other user
@@ -13,14 +14,13 @@ export async function embedMessage(
     message: Message,
     ollama: Ollama,
     tokens: {
-        channel: string,
         model: string
     },
     msgHist: Queue<UserMessage>,
     stream: boolean
 ): Promise<string> {
     // bot response
-    let response: ChatResponse | AsyncGenerator<ChatResponse, any, unknown>
+    let response: ChatResponse | AbortableAsyncIterator<ChatResponse>
     let result: string = ''
 
     // initial message to client

src/utils/messageNormal.ts

@@ -2,6 +2,7 @@ import { Message } from 'discord.js'
 import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
 import { Queue } from '../queues/queue.js'
+import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 
 /**
  * Method to send replies as normal text on discord like any other user
@@ -13,14 +14,13 @@ export async function normalMessage(
     message: Message,
     ollama: Ollama,
     tokens: {
-        channel: string,
         model: string
     },
     msgHist: Queue<UserMessage>,
     stream: boolean
 ): Promise<string> {
     // bot's respnse
-    let response: ChatResponse | AsyncGenerator<ChatResponse, any, unknown>
+    let response: ChatResponse | AbortableAsyncIterator<ChatResponse>
     let result: string = ''
 
     await message.channel.send('Generating Response . . .').then(async sentMessage => {
@@ -33,19 +33,23 @@ export async function normalMessage(
 
             // run query based on stream preference, true = stream, false = block
             if (stream) {
-                response = await streamResponse(params)
+                let messageBlock: Message = sentMessage
+                response = await streamResponse(params) // THIS WILL BE SLOW due to discord limits!
                 for await (const portion of response) {
-                    // append token to message
+                    // check if over discord message limit
-                    result += portion.message.content
+                    if (result.length + portion.message.content.length > 2000) {
+                        result = portion.message.content
 
-                    // exceeds handled length
+                        // new message block, wait for it to send and assign new block to respond.
-                    if (result.length > 2000) {
+                        await message.channel.send("Creating new stream block...").then(sentMessage => { messageBlock = sentMessage })
-                        message.channel.send(`Response length ${result.length} has exceeded Discord maximum.\n\nLong Stream messages not supported.`)
+                    } else {
-                        break // stop stream
+                        result += portion.message.content
-                    }
+                        
-
+                        // ensure block is not empty
-                    // resent current output, THIS WILL BE SLOW due to discord limits!
+                        if (result.length > 5)
-                    sentMessage.edit(result || 'No Content Yet...')
+                            messageBlock.edit(result) 
+                    }         
+                    console.log(result)
                 }
             }
             else {

src/utils/streamHandler.ts

@@ -1,23 +1,23 @@
 import { ChatResponse } from "ollama"
 import { ChatParams } from "./index.js"
+import { AbortableAsyncIterator } from "ollama/src/utils.js"
 
 /**
  * Method to query the Ollama client for async generation
  * @param params 
  * @returns Asyn
  */
-export async function streamResponse(params: ChatParams): Promise<AsyncGenerator<ChatResponse, any, unknown>> {
+export async function streamResponse(params: ChatParams): Promise<AbortableAsyncIterator<ChatResponse>> {
     return await params.ollama.chat({
         model: params.model,
         messages: params.msgHist,
         options: {
-            num_thread: 8, // remove if optimization needed further
             mirostat: 1,
             mirostat_tau: 2.0,
             top_k: 70
         },
         stream: true
-    })
+    }) as unknown as AbortableAsyncIterator<ChatResponse>
 }
 
 /**
@@ -30,7 +30,6 @@ export async function blockResponse(params: ChatParams): Promise<ChatResponse> {
         model: params.model,
         messages: params.msgHist,
         options: {
-            num_thread: 8, // remove if optimization needed further
             mirostat: 1,
             mirostat_tau: 2.0,
             top_k: 70

tests/commands.test.ts

@@ -0,0 +1,27 @@
+// describe marks a test suite
+// expect takes a value from an expression
+// it marks a test case
+import { describe, expect, it } from 'vitest'
+import commands from '../src/commands'
+
+/**
+ * Commands test suite, tests the commands object
+ * Each command is to be tested elsewhere, this file
+ * is to ensure that the commands object is defined.
+ * 
+ * @param name name of the test suite
+ * @param fn function holding tests to run
+ */
+describe('#commands', () => {
+    // test definition of commands object
+    it('references defined object', () => {
+        // toBe compares the value to the expected value
+        expect(typeof commands).toBe('object')
+    })
+
+    // 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-style, message-stream, toggle-chat, shutoff, modify-capacity, channel-toggle')
+    })
+})

tests/events.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'vitest'
+import events from '../src/events'
+
+/**
+ * Events test suite, tests the events object
+ * Each event is to be tested elsewhere, this file
+ * is to ensure that the events object is defined.
+ * 
+ * @param name name of the test suite
+ * @param fn function holding tests to run
+ */
+describe('#events', () => {
+    // test definition of events object
+    it('references defined object', () => {
+        expect(typeof events).toBe('object')
+    })
+
+    // test specific events in the object
+    it('references specific events', () => {
+        const eventsString = events.map(e => e.key.toString()).join(', ')
+        expect(eventsString).toBe('ready, messageCreate, interactionCreate, threadDelete')
+    })
+})

tests/getEnvVar.test.ts

@@ -0,0 +1,50 @@
+import { describe, expect, it } from 'vitest'
+import { getEnvVar } from '../src/utils'
+
+/**
+ * getEnvVar test suite, tests the getEnvVar function
+ * 
+ * @param name name of the test suite
+ * @param fn function holding tests to run
+ */
+describe('#getEnvVar', () => {
+    // dummy set of keys
+    const keys = {
+        clientToken: 'CLIENT_TOKEN',
+    }
+
+    // set keys in environment
+    process.env['clientToken'] = keys.clientToken
+
+    // test for non-empty string
+    it('returns a non-empty string', () => {
+        expect(getEnvVar('CLIENT_TOKEN')).not.toBe('')
+    })
+
+    // test for string type
+    it('returns a string', () => {
+        expect(typeof getEnvVar('CLIENT_TOKEN')).toBe('string')
+    })
+
+    // test for distinct key
+    it('returns a distinct key', () => {
+        expect(getEnvVar('CLIENT_TOKEN')).toEqual(process.env[keys.clientToken])
+    })
+
+    // test for fallback case
+    it('returns a fallback', () => {
+        expect(getEnvVar('NON_EXISTENT_KEY', 'fallback')).toBe('fallback')
+    })
+
+    // test that all keys are consistently found
+    it('returns all keys found', () => {
+        for (const key in keys) {
+            expect(getEnvVar(key)).toEqual(keys[key])
+        }
+    })
+
+    // test that an error is thrown if key is not found
+    it('throws an error if key is not found', () => {
+        expect(() => getEnvVar('NON_EXISTENT_KEY')).toThrowError()
+    })
+})

tests/mentionClean.test.ts

@@ -0,0 +1,17 @@
+import { describe, expect, it } from 'vitest'
+import { clean } from '../src/utils/mentionClean'
+import { getEnvVar } from '../src/utils'
+
+/**
+ * MentionClean test suite, tests the clean function
+ * 
+ * @param name name of the test suite
+ * @param fn function holding tests to run
+ */
+describe('#clean', () => {
+    // test for id removal from message
+    it('removes the mention from a message', () => {
+        const message = `<@${getEnvVar('CLIENT_UID')}> Hello, World!`
+        expect(clean(message)).toBe('Hello, World!')
+    })
+})

tests/queue.test.ts

@@ -0,0 +1,62 @@
+import { describe, expect, it } from 'vitest'
+import { Queue } from '../src/queues/queue'
+
+/**
+ * Queue test suite, tests the Queue class
+ * 
+ * @param name name of the test suite
+ * @param fn function holding tests to run
+ */
+describe('#queue', () => {
+    let queue= new Queue<string>()
+
+    // test for queue creation
+    it('creates a new queue', () => {
+        expect(queue).not.toBeNull()
+    })
+
+    // test for queue capacity creation
+    it('adds specific capacity to the queue', () => {
+        queue = new Queue<string>(2)
+        expect(queue).not.toBeNull()
+    })
+
+    // test for enqueue success, size update
+    it('adds items to the queue', () => {
+        queue.enqueue('hello')
+        expect(queue.size()).toBe(1)
+    })
+
+    // test for multiple enqueue success, size update
+    it('adds multiple items to the queue', () => {
+        queue.enqueue('world')
+        expect(queue.size()).toBe(2)
+    })
+
+    // test for enqueue failure upon capacity overflow
+    it('throws an error when the queue is full', () => {
+        expect(() => queue.enqueue('!')).toThrowError()
+    })
+
+    // test for getItems success
+    it('returns all items in the queue', () => {
+        expect(queue.getItems()).toEqual(['hello', 'world'])
+    })
+
+    // test for pop success, size update
+    it('removes an item from the front of the queue', () => {
+        queue.pop()
+        expect(queue.size() && queue.getItems()[0]).toBe(1 && 'hello')
+    })
+
+    // test for dequeue success, size update
+    it('removes an item from the back of the queue', () => {
+        queue.dequeue()
+        expect(queue.size() && queue.getItems()[0]).toBe(0 && 'world')
+    })
+
+    // test for getItems success with nothing in the list
+    it('returns an empty array when the queue is empty', () => {
+        expect(queue.getItems()).toEqual([])
+    })
+})

tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     // Dependent on node version
     "target": "ES2020",
-    "module": "Node16",
+    "module": "NodeNext",
-    "moduleResolution": "Node16",
+    "moduleResolution": "NodeNext",
     "strict": true,
     // We must set the type
     "noImplicitAny": true,
@@ -13,11 +13,17 @@
     "strictNullChecks": true,
     // We can import json files like JavaScript
     "resolveJsonModule": true,
-    // Decompile .ts to .js into a folder named dist
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    // Decompile .ts to .js into a folder named build
     "outDir": "build",
-    "rootDir": "src"
+    "rootDir": "src",
+    "baseUrl": ".",
+    "paths": {
+      "*": ["node_modules/"]
+    }
   },
   // environment for env vars
-  "include": ["src/**/*"],
+  "include": ["src/**/*.ts"],
   "exclude": ["node_modules"]
 }

vitest.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig, configDefaults } from 'vitest/config'
+
+// config for vitest
+export default defineConfig({
+    test: {
+        globals: true, // <-- reduces test file imports
+        coverage: {
+            exclude: [...configDefaults.exclude, 'build/*'], // <-- exclude JS build
+            reporter: ['text', 'html'] // <-- reports in text, html
+        }
+    }
+})