Dependencies and Readme Updates (#74)

.github/workflows/build.yml

@@ -13,10 +13,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Install Project Dependencies
@@ -50,10 +50,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Create Environment Variables

.github/workflows/test.yml

@@ -21,10 +21,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Install Project Dependencies
@@ -52,10 +52,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Create Environment Variables

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

@@ -14,9 +14,11 @@ 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] Threads
+    * [ ] 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
   * [x] Administrator Role Compatible
@@ -28,20 +30,29 @@ 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)
         * Local use is not recommended.
 
+> [!NOTE]
+> These guides assume you already know how to setup a bot account for discord. Documentation will be added later.
+
 ## 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.
-        * 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`, 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 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.
+
+> [!NOTE]
+> 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`.
+
 * [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)

package.json

@@ -16,7 +16,7 @@
     "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",
@@ -27,17 +27,17 @@
   "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",
     "@vitest/coverage-v8": "^1.6.0",
-    "nodemon": "^3.0.2",
+    "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",

src/commands/messageStream.ts

@@ -26,7 +26,7 @@ export const MessageStream: SlashCommand = {
         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/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
@@ -19,7 +20,7 @@ export async function embedMessage(
     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
@@ -19,7 +20,7 @@ export async function normalMessage(
     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 => {

src/utils/streamHandler.ts

@@ -1,12 +1,13 @@
 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,
@@ -16,7 +17,7 @@ export async function streamResponse(params: ChatParams): Promise<AsyncGenerator
             top_k: 70
         },
         stream: true
-    })
+    }) as unknown as AbortableAsyncIterator<ChatResponse>
 }
 
 /**

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