-
-
-
## Self-host requirements
> [!IMPORTANT]
@@ -25,21 +19,12 @@ Kowalski is a a simple Telegram bot made in Node.js.
- A Telegram bot (create one at [@BotFather](https://t.me/botfather))
- FFmpeg (only for the `/yt` command)
- Docker and Docker Compose (only required for Docker setup)
+- Postgres
-## Running locally (non-Docker setup)
+### AI Requirements
-First, clone the repo with Git:
-
-```bash
-git clone --recurse-submodules https://github.com/ABOCN/TelegramBot
-```
-
-Next, inside the repository directory, create an `.env` file with some content, which you can see the [example .env file](.env.example) to fill info with. To see the meaning of each one, see [the Functions section](#env-functions).
-
-After editing the file, save all changes and run the bot with ``bun start``.
-
-> [!TIP]
-> To deal with dependencies, just run ``bun install`` or ``bun i`` at any moment to install all of them.
+- High-end CPU *or* GPU (~ 6GB vRAM)
+- If using CPU, enough RAM to load the models (~6GB w/ defaults)
## Running with Docker
@@ -55,9 +40,30 @@ You can also run Kowalski using Docker, which simplifies the setup process. Make
### Using Docker Compose
+1. **Copy compose file**
+
+ _Without AI (Ollama)_
+
+ ```bash
+ mv docker-compose.yml.example docker-compose.yml
+ ```
+
+ _With AI (Ollama)_
+
+ ```bash
+ mv docker-compose.yml.ai.example docker-compose.yml
+ ```
+
1. **Make sure to setup your `.env` file first!**
-2. **Run the container**
+ In order to successfuly deploy Kowalski, you will need to edit both your `.env` file and enter matching values in `webui/.env`.
+
+ > [!TIP]
+ > If you intend to setup AI, the defaults for Docker are already included (just uncomment) and don't need to be changed.
+ >
+ > Further setup may be needed for GPUs. See the Ollama documentation for more.
+
+1. **Run the container**
```bash
docker compose up -d
@@ -69,30 +75,76 @@ If you prefer to use Docker directly, you can use these instructions instead.
1. **Make sure to setup your `.env` file first!**
-2. **Build the image**
+ In order to successfuly deploy Kowalski, you will need to edit both your `.env` file and enter matching values in `webui/.env`.
+
+1. **Build the image**
```bash
docker build -t kowalski .
```
-3. **Run the container**
+1. **Run the container**
```bash
docker run -d --name kowalski --restart unless-stopped -v $(pwd)/.env:/usr/src/app/.env:ro kowalski
```
+> [!NOTE]
+> You must setup Ollama on your own if you would like to use AI features.
+
+## Running locally (non-Docker/development setup)
+
+First, clone the repo with Git:
+
+```bash
+git clone --recurse-submodules https://github.com/ABOCN/TelegramBot
+```
+
+Next, inside the repository directory, create an `.env` file with some content, which you can see the [example .env file](.env.example) to fill info with. To see the meaning of each one, see [the Functions section](#env-functions).
+
+After editing the file, save all changes and run the bot with ``bun start``.
+
+> [!TIP]
+> To deal with dependencies, just run ``bun install`` or ``bun i`` at any moment to install all of them.
+
+### Efficant Local (w/ Docker) Development
+
+If you want to develop a component of Kowalski, without dealing with the headache of several terminals, we suggest you follow these guidelines:
+
+1. If you are working on one component, run it with Bun, and Dockerize the other components.
+1. Minimize the amount of non-Dockerized components to reduce headaches.
+1. You will have to change your `.env` a lot. This is a common source of issues. Make sure the hostname and port are correct.
+
## .env Functions
> [!IMPORTANT]
> Take care of your ``.env`` file, as it is so much important and needs to be secret (like your passwords), as anyone can do whatever they want to the bot with this token!
+### Bot
+
- **botSource**: Put the link to your bot source code.
- **botPrivacy**: Put the link to your bot privacy policy.
- **maxRetries**: Maximum number of retries for a failing command on Kowalski. Default is 5. If the limit is hit, the bot will crash past this number.
- **botToken**: Put your bot token that you created at [@BotFather](https://t.me/botfather).
+- **ollamaEnabled** (optional): Enables/disables AI features
+- **ollamaApi** (optional): Ollama API endpoint for various AI features, will be disabled if not set
+- **handlerTimeout** (optional): How long handlers will wait before timing out. Set this high if using large AI models.
+- **flashModel** (optional): Which model will be used for /ask
+- **thinkingModel** (optional): Which model will be used for /think
+- **updateEveryChars** (optional): The amount of chars until message update triggers (for streaming response)
+- **databaseUrl**: Database server configuration (see `.env.example`)
- **botAdmins**: Put the ID of the people responsible for managing the bot. They can use some administrative + exclusive commands on any group.
- **lastKey**: Last.fm API key, for use on `lastfm.js` functions, like see who is listening to what song and etc.
- **weatherKey**: Weather.com API key, used for the `/weather` command.
+- **longerLogs**: Set to `true` to enable verbose logging whenever possible.
+
+> [!NOTE]
+> Further, advanced fine-tuning and configuration can be done in TypeScript with the files in the `/config` folder.
+
+### WebUI
+
+- **botApiUrl**: Likely will stay the same, but changes the API that the bot exposes
+- **databaseUrl**: Database server configuration (see `.env.example`)
## Troubleshooting
@@ -100,12 +152,18 @@ If you prefer to use Docker directly, you can use these instructions instead.
**Q:** I get a "Permission denied (EACCES)" error in the console when running the `/yt` command
-**A:** Make sure `src/plugins/yt-dlp/yt-dlp` is executable. You can do this on Linux like so:
+**A:** Make sure `telegram/plugins/yt-dlp/yt-dlp` is executable. You can do this on Linux like so:
```bash
-chmod +x src/plugins/yt-dlp/yt-dlp
+chmod +x telegram/plugins/yt-dlp/yt-dlp
```
+### AI
+
+**Q:** How can I disable AI features?
+
+**A:** AI features are disabled by default, unless you have set `ollamaEnabled` to `true` in your `.env` file. Set it back to `false` to disable.
+
## Contributors
@@ -117,3 +175,5 @@ Made with [contrib.rocks](https://contrib.rocks).
## About/License
BSD-3-Clause - 2024 Lucas Gabriel (lucmsilva).
+
+With some components under Unlicense.
diff --git a/TERMS_OF_USE.md b/TERMS_OF_USE.md
old mode 100644
new mode 100755
diff --git a/config/ai.ts b/config/ai.ts
new file mode 100755
index 0000000..6c6ddb0
--- /dev/null
+++ b/config/ai.ts
@@ -0,0 +1,420 @@
+export interface ModelInfo {
+ name: string;
+ label: string;
+ descriptionEn: string;
+ descriptionPt: string;
+ models: Array<{
+ name: string;
+ label: string;
+ parameterSize: string;
+ thinking: boolean;
+ uncensored: boolean;
+ }>;
+}
+
+export const defaultFlashModel = "gemma3:4b"
+export const defaultThinkingModel = "qwen3:4b"
+export const unloadModelAfterB = 12 // how many billion params until model is auto-unloaded
+export const maxUserQueueSize = 3
+
+export const models: ModelInfo[] = [
+ {
+ name: 'gemma3n',
+ label: 'gemma3n',
+ descriptionEn: 'Gemma3n is a family of open, light on-device models for general tasks.',
+ descriptionPt: 'Gemma3n é uma família de modelos abertos, leves e para dispositivos locais, para tarefas gerais.',
+ models: [
+ {
+ name: 'gemma3n:e2b',
+ label: 'Gemma3n e2b',
+ parameterSize: '2B',
+ thinking: false,
+ uncensored: false
+ },
+ {
+ name: 'gemma3n:e4b',
+ label: 'Gemma3n e4b',
+ parameterSize: '4B',
+ thinking: false,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'gemma3',
+ label: 'gemma3 [ & Uncensored ]',
+ descriptionEn: 'Gemma3-abliterated is a family of open, uncensored models for general tasks.',
+ descriptionPt: 'Gemma3-abliterated é uma família de modelos abertos, não censurados, para tarefas gerais.',
+ models: [
+ {
+ name: 'huihui_ai/gemma3-abliterated:1b',
+ label: 'Gemma3 Uncensored 1B',
+ parameterSize: '1B',
+ thinking: false,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/gemma3-abliterated:4b',
+ label: 'Gemma3 Uncensored 4B',
+ parameterSize: '4B',
+ thinking: false,
+ uncensored: true
+ },
+ {
+ name: 'gemma3:1b',
+ label: 'Gemma3 1B',
+ parameterSize: '1B',
+ thinking: false,
+ uncensored: false
+ },
+ {
+ name: 'gemma3:4b',
+ label: 'Gemma3 4B',
+ parameterSize: '4B',
+ thinking: false,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'qwen3',
+ label: 'Qwen3',
+ descriptionEn: 'Qwen3 is a multilingual reasoning model series.',
+ descriptionPt: 'Qwen3 é uma série de modelos multilingues.',
+ models: [
+ {
+ name: 'qwen3:0.6b',
+ label: 'Qwen3 0.6B',
+ parameterSize: '0.6B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'qwen3:1.7b',
+ label: 'Qwen3 1.7B',
+ parameterSize: '1.7B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'qwen3:4b',
+ label: 'Qwen3 4B',
+ parameterSize: '4B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'qwen3:8b',
+ label: 'Qwen3 8B',
+ parameterSize: '8B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'qwen3:14b',
+ label: 'Qwen3 14B',
+ parameterSize: '14B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'qwen3:30b',
+ label: 'Qwen3 30B',
+ parameterSize: '30B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'qwen3:32b',
+ label: 'Qwen3 32B',
+ parameterSize: '32B',
+ thinking: true,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'qwen3-abliterated',
+ label: 'Qwen3 [ Uncensored ]',
+ descriptionEn: 'Qwen3-abliterated is a multilingual reasoning model series.',
+ descriptionPt: 'Qwen3-abliterated é uma série de modelos multilingues.',
+ models: [
+ {
+ name: 'huihui_ai/qwen3-abliterated:0.6b',
+ label: 'Qwen3 Uncensored 0.6B',
+ parameterSize: '0.6B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/qwen3-abliterated:1.7b',
+ label: 'Qwen3 Uncensored 1.7B',
+ parameterSize: '1.7B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/qwen3-abliterated:4b',
+ label: 'Qwen3 Uncensored 4B',
+ parameterSize: '4B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/qwen3-abliterated:8b',
+ label: 'Qwen3 Uncensored 8B',
+ parameterSize: '8B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/qwen3-abliterated:14b',
+ label: 'Qwen3 Uncensored 14B',
+ parameterSize: '14B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/qwen3-abliterated:30b',
+ label: 'Qwen3 Uncensored 30B',
+ parameterSize: '30B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/qwen3-abliterated:32b',
+ label: 'Qwen3 Uncensored 32B',
+ parameterSize: '32B',
+ thinking: true,
+ uncensored: true
+ },
+ ]
+ },
+ {
+ name: 'qwq',
+ label: 'QwQ',
+ descriptionEn: 'QwQ is the reasoning model of the Qwen series.',
+ descriptionPt: 'QwQ é o modelo de raciocínio da série Qwen.',
+ models: [
+ {
+ name: 'qwq:32b',
+ label: 'QwQ 32B',
+ parameterSize: '32B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'huihui_ai/qwq-abliterated:32b',
+ label: 'QwQ Uncensored 32B',
+ parameterSize: '32B',
+ thinking: true,
+ uncensored: true
+ },
+ ]
+ },
+ {
+ name: 'llama4',
+ label: 'Llama4',
+ descriptionEn: 'The latest collection of multimodal models from Meta.',
+ descriptionPt: 'A coleção mais recente de modelos multimodais da Meta.',
+ models: [
+ {
+ name: 'llama4:scout',
+ label: 'Llama4 109B A17B',
+ parameterSize: '109B',
+ thinking: false,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'deepseek',
+ label: 'DeepSeek [ & Uncensored ]',
+ descriptionEn: 'DeepSeek is a research model for reasoning tasks.',
+ descriptionPt: 'DeepSeek é um modelo de pesquisa para tarefas de raciocínio.',
+ models: [
+ {
+ name: 'deepseek-r1:1.5b',
+ label: 'DeepSeek 1.5B',
+ parameterSize: '1.5B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'deepseek-r1:7b',
+ label: 'DeepSeek 7B',
+ parameterSize: '7B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'deepseek-r1:8b',
+ label: 'DeepSeek 8B',
+ parameterSize: '8B',
+ thinking: true,
+ uncensored: false
+ },
+ {
+ name: 'huihui_ai/deepseek-r1-abliterated:1.5b',
+ label: 'DeepSeek Uncensored 1.5B',
+ parameterSize: '1.5B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/deepseek-r1-abliterated:7b',
+ label: 'DeepSeek Uncensored 7B',
+ parameterSize: '7B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/deepseek-r1-abliterated:8b',
+ label: 'DeepSeek Uncensored 8B',
+ parameterSize: '8B',
+ thinking: true,
+ uncensored: true
+ },
+ {
+ name: 'huihui_ai/deepseek-r1-abliterated:14b',
+ label: 'DeepSeek Uncensored 14B',
+ parameterSize: '14B',
+ thinking: true,
+ uncensored: true
+ },
+ ]
+ },
+ {
+ name: 'hermes3',
+ label: 'Hermes3',
+ descriptionEn: 'Hermes 3 is the latest version of the flagship Hermes series of LLMs by Nous Research.',
+ descriptionPt: 'Hermes 3 é a versão mais recente da série Hermes de LLMs da Nous Research.',
+ models: [
+ {
+ name: 'hermes3:3b',
+ label: 'Hermes3 3B',
+ parameterSize: '3B',
+ thinking: false,
+ uncensored: false
+ },
+ {
+ name: 'hermes3:8b',
+ label: 'Hermes3 8B',
+ parameterSize: '8B',
+ thinking: false,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'mistral',
+ label: 'Mistral',
+ descriptionEn: 'The 7B model released by Mistral AI, updated to version 0.3.',
+ descriptionPt: 'O modelo 7B lançado pela Mistral AI, atualizado para a versão 0.3.',
+ models: [
+ {
+ name: 'mistral:7b',
+ label: 'Mistral 7B',
+ parameterSize: '7B',
+ thinking: false,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'phi4 [ & Uncensored ]',
+ label: 'Phi4',
+ descriptionEn: 'Phi-4 is a 14B parameter, state-of-the-art open model from Microsoft. ',
+ descriptionPt: 'Phi-4 é um modelo de 14B de última geração, aberto pela Microsoft.',
+ models: [
+ {
+ name: 'phi4:14b',
+ label: 'Phi4 14B',
+ parameterSize: '14B',
+ thinking: false,
+ uncensored: false
+ },
+ {
+ name: 'huihui_ai/phi4-abliterated:14b',
+ label: 'Phi4 Uncensored 14B',
+ parameterSize: '14B',
+ thinking: false,
+ uncensored: true
+ },
+ ]
+ },
+ {
+ name: 'phi3',
+ label: 'Phi3',
+ descriptionEn: 'Phi-3 is a family of lightweight 3B (Mini) and 14B (Medium) state-of-the-art open models by Microsoft.',
+ descriptionPt: 'Phi-3 é uma família de modelos leves de 3B (Mini) e 14B (Médio) de última geração, abertos pela Microsoft.',
+ models: [
+ {
+ name: 'phi3:3.8b',
+ label: 'Phi3 3.8B',
+ parameterSize: '3.8B',
+ thinking: false,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'llama3',
+ label: 'Llama4',
+ descriptionEn: 'Llama 3, a lightweight model from Meta.',
+ descriptionPt: 'Llama 3, um modelo leve da Meta.',
+ models: [
+ {
+ name: 'llama3:8b',
+ label: 'Llama3 8B',
+ parameterSize: '8B',
+ thinking: false,
+ uncensored: false
+ },
+ ]
+ },
+ {
+ name: 'llama3.1 [ Uncensored ]',
+ label: 'Llama3.1',
+ descriptionEn: 'Ablitered v3 llama-3.1 8b with uncensored prompt ',
+ descriptionPt: 'Llama3.1 é um modelo aberto, leve e para dispositivos locais, com prompt não censurado.',
+ models: [
+ {
+ name: 'mannix/llama3.1-8b-abliterated:latest',
+ label: 'Llama3.1 8B',
+ parameterSize: '8B',
+ thinking: false,
+ uncensored: true
+ },
+ ]
+ },
+ {
+ name: 'llama3.2 [ & Uncensored ]',
+ label: 'Llama3.2',
+ descriptionEn: 'Llama3.2 is a family of open, lightweight models for general tasks.',
+ descriptionPt: 'Llama3.2 é uma família de modelos abertos, leves e para dispositivos locais, para tarefas gerais.',
+ models: [
+ {
+ name: 'llama3.2:1b',
+ label: 'Llama3.2 1B',
+ parameterSize: '1B',
+ thinking: false,
+ uncensored: false
+ },
+ {
+ name: 'llama3.2:3b',
+ label: 'Llama3.2 3B',
+ parameterSize: '3B',
+ thinking: false,
+ uncensored: false
+ },
+ {
+ name: 'socialnetwooky/llama3.2-abliterated:3b_q8_0',
+ label: 'Llama3.2 Uncensored 3B',
+ parameterSize: '3B',
+ thinking: false,
+ uncensored: true
+ },
+ ]
+ },
+];
\ No newline at end of file
diff --git a/config/settings.ts b/config/settings.ts
new file mode 100755
index 0000000..1fe94b3
--- /dev/null
+++ b/config/settings.ts
@@ -0,0 +1,2 @@
+export const seriesPageSize = 4;
+export const modelPageSize = 4;
\ No newline at end of file
diff --git a/database/schema.ts b/database/schema.ts
new file mode 100755
index 0000000..ce9a8ed
--- /dev/null
+++ b/database/schema.ts
@@ -0,0 +1,52 @@
+import {
+ integer,
+ pgTable,
+ varchar,
+ timestamp,
+ boolean,
+ real,
+ index
+} from "drizzle-orm/pg-core";
+
+export const usersTable = pgTable("users", {
+ telegramId: varchar({ length: 255 }).notNull().primaryKey(),
+ username: varchar({ length: 255 }).notNull(),
+ firstName: varchar({ length: 255 }).notNull(),
+ lastName: varchar({ length: 255 }).notNull(),
+ aiEnabled: boolean().notNull().default(false),
+ showThinking: boolean().notNull().default(false),
+ customAiModel: varchar({ length: 255 }).notNull().default("deepseek-r1:1.5b"),
+ aiTemperature: real().notNull().default(0.9),
+ aiRequests: integer().notNull().default(0),
+ aiCharacters: integer().notNull().default(0),
+ disabledCommands: varchar({ length: 255 }).array().notNull().default([]),
+ languageCode: varchar({ length: 255 }).notNull(),
+ aiTimeoutUntil: timestamp(),
+ aiMaxExecutionTime: integer().default(0),
+ createdAt: timestamp().notNull().defaultNow(),
+ updatedAt: timestamp().notNull().defaultNow(),
+});
+
+export const twoFactorTable = pgTable("two_factor", {
+ userId: varchar({ length: 255 }).notNull().references(() => usersTable.telegramId).primaryKey(),
+ currentCode: varchar({ length: 255 }).notNull(),
+ codeExpiresAt: timestamp().notNull(),
+ codeAttempts: integer().notNull().default(0),
+ createdAt: timestamp().notNull().defaultNow(),
+ updatedAt: timestamp().notNull().defaultNow(),
+}, (table) => [
+ index("idx_two_factor_user_id").on(table.userId),
+ index("idx_two_factor_code_expires_at").on(table.codeExpiresAt),
+]);
+
+export const sessionsTable = pgTable("sessions", {
+ id: varchar({ length: 255 }).notNull().primaryKey(),
+ userId: varchar({ length: 255 }).notNull().references(() => usersTable.telegramId),
+ sessionToken: varchar({ length: 255 }).notNull().unique(),
+ expiresAt: timestamp().notNull(),
+ createdAt: timestamp().notNull().defaultNow(),
+ updatedAt: timestamp().notNull().defaultNow(),
+}, (table) => [
+ index("idx_sessions_user_id").on(table.userId),
+ index("idx_sessions_expires_at").on(table.expiresAt),
+]);
diff --git a/docker-compose.yml b/docker-compose.yml
deleted file mode 100644
index 0aab44a..0000000
--- a/docker-compose.yml
+++ /dev/null
@@ -1,9 +0,0 @@
-services:
- kowalski:
- build: .
- container_name: kowalski
- restart: unless-stopped
- volumes:
- - ./.env:/usr/src/app/.env:ro
- environment:
- - NODE_ENV=production
\ No newline at end of file
diff --git a/docker-compose.yml.ai.example b/docker-compose.yml.ai.example
new file mode 100755
index 0000000..fe467ab
--- /dev/null
+++ b/docker-compose.yml.ai.example
@@ -0,0 +1,30 @@
+services:
+ kowalski:
+ build: .
+ container_name: kowalski
+ ports:
+ - "3000:3000"
+ volumes:
+ - ./.env:/usr/src/app/.env:ro
+ - ./telegram/props/lastfm.json:/usr/src/app/telegram/props/lastfm.json
+ environment:
+ - NODE_ENV=production
+ env_file:
+ - .env
+ depends_on:
+ - postgres
+ - ollama
+ ollama:
+ image: ollama/ollama
+ container_name: kowalski-ollama
+ volumes:
+ - ./ollama:/root/.ollama
+ postgres:
+ image: postgres:17
+ container_name: kowalski-postgres
+ volumes:
+ - ./db:/var/lib/postgresql/data
+ environment:
+ - POSTGRES_USER=kowalski
+ - POSTGRES_PASSWORD=kowalski
+ - POSTGRES_DB=kowalski
\ No newline at end of file
diff --git a/docker-compose.yml.example b/docker-compose.yml.example
new file mode 100755
index 0000000..d94e78d
--- /dev/null
+++ b/docker-compose.yml.example
@@ -0,0 +1,24 @@
+services:
+ kowalski:
+ build: .
+ container_name: kowalski
+ ports:
+ - "3000:3000"
+ volumes:
+ - ./.env:/usr/src/app/.env:ro
+ - ./telegram/props/lastfm.json:/usr/src/app/telegram/props/lastfm.json
+ environment:
+ - NODE_ENV=production
+ env_file:
+ - .env
+ depends_on:
+ - postgres
+ postgres:
+ image: postgres:17
+ container_name: kowalski-postgres
+ volumes:
+ - ./db:/var/lib/postgresql/data
+ environment:
+ - POSTGRES_USER=kowalski
+ - POSTGRES_PASSWORD=kowalski
+ - POSTGRES_DB=kowalski
\ No newline at end of file
diff --git a/drizzle.config.ts b/drizzle.config.ts
new file mode 100755
index 0000000..51b8e1d
--- /dev/null
+++ b/drizzle.config.ts
@@ -0,0 +1,11 @@
+import 'dotenv/config';
+import { defineConfig } from 'drizzle-kit';
+
+export default defineConfig({
+ out: './drizzle',
+ schema: './database/schema.ts',
+ dialect: 'postgresql',
+ dbCredentials: {
+ url: process.env.databaseUrl!,
+ },
+});
diff --git a/nodemon.json b/nodemon.json
old mode 100644
new mode 100755
index 918bcb8..d9938ac
--- a/nodemon.json
+++ b/nodemon.json
@@ -1,6 +1,6 @@
-{
- "ignore": ["src/props/*.json", "src/props/*.txt"],
- "watch": ["src"],
+{
+ "ignore": ["telegram/props/*.json", "telegram/props/*.txt"],
+ "watch": ["telegram", "database", "config"],
"ext": "ts,js",
- "exec": "bun src/bot.ts"
+ "exec": "bun telegram/bot.ts"
}
\ No newline at end of file
diff --git a/package.json b/package.json
old mode 100644
new mode 100755
index 5c53440..b5c33cc
--- a/package.json
+++ b/package.json
@@ -1,14 +1,25 @@
{
"scripts": {
- "start": "nodemon src/bot.ts"
+ "start": "nodemon telegram/bot.ts",
+ "docs": "bunx typedoc",
+ "serve:docs": "bun run serve-docs.ts"
},
"dependencies": {
"@dotenvx/dotenvx": "^1.45.1",
"@types/bun": "^1.2.17",
"axios": "^1.10.0",
+ "dotenv": "^17.0.0",
+ "drizzle-orm": "^0.44.2",
+ "express": "^5.1.0",
"node-html-parser": "^7.0.1",
"nodemon": "^3.1.10",
+ "pg": "^8.16.3",
"telegraf": "^4.16.3",
"youtube-url": "^0.5.0"
+ },
+ "devDependencies": {
+ "@types/pg": "^8.15.4",
+ "drizzle-kit": "^0.31.4",
+ "tsx": "^4.20.3"
}
}
diff --git a/src/bot.ts b/src/bot.ts
deleted file mode 100644
index 3422e56..0000000
--- a/src/bot.ts
+++ /dev/null
@@ -1,79 +0,0 @@
-import { Telegraf } from 'telegraf';
-import path from 'path';
-import fs from 'fs';
-import { isOnSpamWatch } from './spamwatch/spamwatch';
-import '@dotenvx/dotenvx';
-import './plugins/ytDlpWrapper';
-
-// Ensures bot token is set, and not default value
-if (!process.env.botToken || process.env.botToken === 'InsertYourBotTokenHere') {
- console.error('Bot token is not set. Please set the bot token in the .env file.')
- process.exit(1)
-}
-
-const bot = new Telegraf(process.env.botToken);
-const maxRetries = process.env.maxRetries || 5;
-let restartCount = 0;
-
-const loadCommands = () => {
- const commandsPath = path.join(__dirname, 'commands');
-
- try {
- const files = fs.readdirSync(commandsPath)
- .filter(file => file.endsWith('.ts') || file.endsWith('.js'));
-
- files.forEach((file) => {
- try {
- const commandPath = path.join(commandsPath, file);
- const command = require(commandPath).default || require(commandPath);
- if (typeof command === 'function') {
- command(bot, isOnSpamWatch);
- }
- } catch (error) {
- console.error(`Failed to load command file ${file}: ${error.message}`);
- }
- });
- } catch (error) {
- console.error(`Failed to read commands directory: ${error.message}`);
- }
-};
-
-const startBot = async () => {
- const botInfo = await bot.telegram.getMe();
- console.log(`${botInfo.first_name} is running...`);
- try {
- await bot.launch();
- restartCount = 0;
- } catch (error) {
- console.error('Failed to start bot:', error.message);
- if (restartCount < Number(maxRetries)) {
- restartCount++;
- console.log(`Retrying to start bot... Attempt ${restartCount}`);
- setTimeout(startBot, 5000);
- } else {
- console.error('Maximum retry attempts reached. Exiting.');
- process.exit(1);
- }
- }
-};
-
-const handleShutdown = (signal) => {
- console.log(`Received ${signal}. Stopping bot...`);
- bot.stop(signal);
- process.exit(0);
-};
-
-process.once('SIGINT', () => handleShutdown('SIGINT'));
-process.once('SIGTERM', () => handleShutdown('SIGTERM'));
-
-process.on('uncaughtException', (error) => {
- console.error('Uncaught Exception:', error.message);
- console.error(error.stack);
-});
-
-process.on('unhandledRejection', (reason, promise) => {
- console.error('Unhandled Rejection at:', promise, 'reason:', reason);
-});
-
-loadCommands();
-startBot();
diff --git a/src/commands/animal.ts b/src/commands/animal.ts
deleted file mode 100644
index 63cbb7b..0000000
--- a/src/commands/animal.ts
+++ /dev/null
@@ -1,132 +0,0 @@
-import Resources from '../props/resources.json';
-import { getStrings } from '../plugins/checklang';
-import { isOnSpamWatch } from '../spamwatch/spamwatch';
-import spamwatchMiddlewareModule from '../spamwatch/Middleware';
-import axios from 'axios';
-import { Context, Telegraf } from 'telegraf';
-import { replyToMessageId } from '../utils/reply-to-message-id';
-import { languageCode } from '../utils/language-code';
-
-const spamwatchMiddleware = spamwatchMiddlewareModule(isOnSpamWatch);
-
-export default (bot: Telegraf