Initial first release

.env.example

@@ -0,0 +1,8 @@
+DATABASE_URL="file:../dev.db" # SQLite database relative to the ./prisma path
+PLEROMA_INSTANCE_URL="https://instance.tld" # Pleroma instance full URL including scheme
+PLEROMA_INSTANCE_DOMAIN="instance.tld" # used if you want to only want to respond to people from a particular instance
+ONLY_LOCAL_REPLIES="true" # reply to only users locally on your instance
+OLLAMA_URL="http://localhost:11434" # OLLAMA connection URL
+OLLAMA_SYSTEM_PROMPT="" # system prompt - used to help tune the responses from the AI
+OLLAMA_MODEL="" # Ollama model for responses e.g dolphin-mistral:latest
+INSTANCE_BEARER_TOKEN="" # instance auth/bearer token (check the "verify_credentials" endpoint request headers in Chrome DevTools if on Soapbox)

.gitignore

@@ -1,5 +1,7 @@
 node_modules
 # Keep environment variables out of version control
 .env
+*.log
+*.db
 
 /generated/prisma

dist/main.js

@@ -0,0 +1,133 @@
+import striptags from "striptags";
+import { PrismaClient } from "../generated/prisma/client.js";
+const prisma = new PrismaClient();
+const getNotifications = async () => {
+    try {
+        const request = await fetch(`${process.env.PLEROMA_INSTANCE_URL}/api/v1/notifications?types[]=mention`, {
+            method: "GET",
+            headers: {
+                Authorization: `Bearer ${process.env.INSTANCE_BEARER_TOKEN}`,
+            },
+        });
+        const notifications = await request.json();
+        return notifications;
+    }
+    catch (error) {
+        throw new Error(error.message);
+    }
+};
+const notifications = await getNotifications();
+const storeUserData = async (notification) => {
+    try {
+        const user = await prisma.user.upsert({
+            where: { userFqn: notification.status.account.fqn },
+            update: {
+                lastRespondedTo: new Date(Date.now()),
+            },
+            create: {
+                userFqn: notification.status.account.fqn,
+                lastRespondedTo: new Date(Date.now()),
+            },
+        });
+    }
+    catch (error) {
+        throw new Error(error.message);
+    }
+};
+const alreadyRespondedTo = async (notification) => {
+    try {
+        const duplicate = await prisma.response.findFirst({
+            where: { pleromaNotificationId: notification.status.id },
+        });
+        if (duplicate) {
+            return true;
+        }
+        return false;
+    }
+    catch (error) {
+        throw new Error(error.message);
+    }
+};
+const storePromptData = async (notification, ollamaResponseBody) => {
+    try {
+        await prisma.response.create({
+            data: {
+                response: ollamaResponseBody.response,
+                request: striptags(notification.status.content),
+                to: notification.account.fqn,
+                pleromaNotificationId: notification.status.id,
+                createdAt: new Date(Date.now()),
+            },
+        });
+    }
+    catch (error) {
+        throw new Error(error.message);
+    }
+};
+const generateOllamaRequest = async (notification) => {
+    try {
+        if (striptags(notification.status.content).includes("!prompt") &&
+            !notification.status.account.bot) {
+            if (process.env.ONLY_LOCAL_REPLIES === "true" &&
+                !notification.status.account.fqn.includes(`@${process.env.PLEROMA_INSTANCE_DOMAIN}`)) {
+                return;
+            }
+            if (await alreadyRespondedTo(notification)) {
+                // console.log(
+                //   `Already responded to notification ID ${notification.status.id}. Canceling.`
+                // );
+                return;
+            }
+            await storeUserData(notification);
+            const ollamaRequestBody = {
+                model: process.env.OLLAMA_MODEL,
+                system: process.env.OLLAMA_SYSTEM_PROMPT,
+                prompt: striptags(notification.status.content),
+                stream: false,
+            };
+            const response = await fetch(`${process.env.OLLAMA_URL}/api/generate`, {
+                method: "POST",
+                body: JSON.stringify(ollamaRequestBody),
+            });
+            const ollamaResponse = await response.json();
+            await storePromptData(notification, ollamaResponse);
+            console.log(`${notification.status.account.fqn} asked:\n${notification.status.content}\nResponse:\n${ollamaResponse.response}`);
+            postReplyToStatus(notification, ollamaResponse);
+        }
+    }
+    catch (error) {
+        throw new Error(error.message);
+    }
+};
+const postReplyToStatus = async (notification, ollamaResponseBody) => {
+    try {
+        const mentions = notification.status.mentions?.map((mention) => {
+            return mention.acct;
+        });
+        let statusBody = {
+            content_type: "text/markdown",
+            status: ollamaResponseBody.response,
+            in_reply_to_id: notification.status.id,
+            to: mentions,
+        };
+        const response = await fetch(`${process.env.PLEROMA_INSTANCE_URL}/api/v1/statuses`, {
+            method: "POST",
+            headers: {
+                Authorization: `Bearer ${process.env.INSTANCE_BEARER_TOKEN}`,
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(statusBody),
+        });
+        if (!response.ok) {
+            throw new Error(`New status request failed: ${response.statusText}`);
+        }
+    }
+    catch (error) {
+        throw new Error(error.message);
+    }
+};
+if (notifications) {
+    await Promise.all(notifications.map((notification) => {
+        generateOllamaRequest(notification);
+    }));
+}

package-lock.json

@@ -1,15 +1,17 @@
 {
-  "name": "fedi-ncai",
+  "name": "pleroma-ollama-bot",
   "version": "1.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
-      "name": "fedi-ncai",
+      "name": "pleroma-ollama-bot",
       "version": "1.0.0",
-      "license": "ISC",
       "dependencies": {
+        "@prisma/client": "^6.10.1",
         "@types/node": "^24.0.5",
+        "dotenv": "^17.0.0",
+        "striptags": "^3.2.0",
         "ts-node": "^10.9.2",
         "typescript": "^5.8.3"
       },
@@ -54,11 +56,33 @@
         "@jridgewell/sourcemap-codec": "^1.4.10"
       }
     },
+    "node_modules/@prisma/client": {
+      "version": "6.10.1",
+      "resolved": "https://registry.npmjs.org/@prisma/client/-/client-6.10.1.tgz",
+      "integrity": "sha512-Re4pMlcUsQsUTAYMK7EJ4Bw2kg3WfZAAlr8GjORJaK4VOP6LxRQUQ1TuLnxcF42XqGkWQ36q5CQF1yVadANQ6w==",
+      "hasInstallScript": true,
+      "license": "Apache-2.0",
+      "engines": {
+        "node": ">=18.18"
+      },
+      "peerDependencies": {
+        "prisma": "*",
+        "typescript": ">=5.1.0"
+      },
+      "peerDependenciesMeta": {
+        "prisma": {
+          "optional": true
+        },
+        "typescript": {
+          "optional": true
+        }
+      }
+    },
     "node_modules/@prisma/config": {
       "version": "6.10.1",
       "resolved": "https://registry.npmjs.org/@prisma/config/-/config-6.10.1.tgz",
       "integrity": "sha512-kz4/bnqrOrzWo8KzYguN0cden4CzLJJ+2VSpKtF8utHS3l1JS0Lhv6BLwpOX6X9yNreTbZQZwewb+/BMPDCIYQ==",
-      "dev": true,
+      "devOptional": true,
       "license": "Apache-2.0",
       "dependencies": {
         "jiti": "2.4.2"
@@ -68,14 +92,14 @@
       "version": "6.10.1",
       "resolved": "https://registry.npmjs.org/@prisma/debug/-/debug-6.10.1.tgz",
       "integrity": "sha512-k2YT53cWxv9OLjW4zSYTZ6Z7j0gPfCzcr2Mj99qsuvlxr8WAKSZ2NcSR0zLf/mP4oxnYG842IMj3utTgcd7CaA==",
-      "dev": true,
+      "devOptional": true,
       "license": "Apache-2.0"
     },
     "node_modules/@prisma/engines": {
       "version": "6.10.1",
       "resolved": "https://registry.npmjs.org/@prisma/engines/-/engines-6.10.1.tgz",
       "integrity": "sha512-Q07P5rS2iPwk2IQr/rUQJ42tHjpPyFcbiH7PXZlV81Ryr9NYIgdxcUrwgVOWVm5T7ap02C0dNd1dpnNcSWig8A==",
-      "dev": true,
+      "devOptional": true,
       "hasInstallScript": true,
       "license": "Apache-2.0",
       "dependencies": {
@@ -89,14 +113,14 @@
       "version": "6.10.1-1.9b628578b3b7cae625e8c927178f15a170e74a9c",
       "resolved": "https://registry.npmjs.org/@prisma/engines-version/-/engines-version-6.10.1-1.9b628578b3b7cae625e8c927178f15a170e74a9c.tgz",
       "integrity": "sha512-ZJFTsEqapiTYVzXya6TUKYDFnSWCNegfUiG5ik9fleQva5Sk3DNyyUi7X1+0ZxWFHwHDr6BZV5Vm+iwP+LlciA==",
-      "dev": true,
+      "devOptional": true,
       "license": "Apache-2.0"
     },
     "node_modules/@prisma/fetch-engine": {
       "version": "6.10.1",
       "resolved": "https://registry.npmjs.org/@prisma/fetch-engine/-/fetch-engine-6.10.1.tgz",
       "integrity": "sha512-clmbG/Jgmrc/n6Y77QcBmAUlq9LrwI9Dbgy4pq5jeEARBpRCWJDJ7PWW1P8p0LfFU0i5fsyO7FqRzRB8mkdS4g==",
-      "dev": true,
+      "devOptional": true,
       "license": "Apache-2.0",
       "dependencies": {
         "@prisma/debug": "6.10.1",
@@ -108,7 +132,7 @@
       "version": "6.10.1",
       "resolved": "https://registry.npmjs.org/@prisma/get-platform/-/get-platform-6.10.1.tgz",
       "integrity": "sha512-4CY5ndKylcsce9Mv+VWp5obbR2/86SHOLVV053pwIkhVtT9C9A83yqiqI/5kJM9T1v1u1qco/bYjDKycmei9HA==",
-      "dev": true,
+      "devOptional": true,
       "license": "Apache-2.0",
       "dependencies": {
         "@prisma/debug": "6.10.1"
@@ -192,11 +216,23 @@
         "node": ">=0.3.1"
       }
     },
+    "node_modules/dotenv": {
+      "version": "17.0.0",
+      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-17.0.0.tgz",
+      "integrity": "sha512-A0BJ5lrpJVSfnMMXjmeO0xUnoxqsBHWCoqqTnGwGYVdnctqXXUEhJOO7LxmgxJon9tEZFGpe0xPRX0h2v3AANQ==",
+      "license": "BSD-2-Clause",
+      "engines": {
+        "node": ">=12"
+      },
+      "funding": {
+        "url": "https://dotenvx.com"
+      }
+    },
     "node_modules/jiti": {
       "version": "2.4.2",
       "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.4.2.tgz",
       "integrity": "sha512-rg9zJN+G4n2nfJl5MW3BMygZX56zKPNVEYYqq7adpmMh4Jn2QNEwhvQlFy6jPVdcod7txZtKHWnyZiA3a0zP7A==",
-      "dev": true,
+      "devOptional": true,
       "license": "MIT",
       "bin": {
         "jiti": "lib/jiti-cli.mjs"
@@ -212,7 +248,7 @@
       "version": "6.10.1",
       "resolved": "https://registry.npmjs.org/prisma/-/prisma-6.10.1.tgz",
       "integrity": "sha512-khhlC/G49E4+uyA3T3H5PRBut486HD2bDqE2+rvkU0pwk9IAqGFacLFUyIx9Uw+W2eCtf6XGwsp+/strUwMNPw==",
-      "dev": true,
+      "devOptional": true,
       "hasInstallScript": true,
       "license": "Apache-2.0",
       "dependencies": {
@@ -234,6 +270,12 @@
         }
       }
     },
+    "node_modules/striptags": {
+      "version": "3.2.0",
+      "resolved": "https://registry.npmjs.org/striptags/-/striptags-3.2.0.tgz",
+      "integrity": "sha512-g45ZOGzHDMe2bdYMdIvdAfCQkCTDMGBazSw1ypMowwGIee7ZQ5dU0rBJ8Jqgl+jAKIv4dbeE1jscZq9wid1Tkw==",
+      "license": "MIT"
+    },
     "node_modules/ts-node": {
       "version": "10.9.2",
       "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",

package.json

@@ -3,13 +3,18 @@
   "version": "1.0.0",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "tsc && node -r dotenv/config dist/main.js",
+    "build": "tsc"
   },
+  "type": "module",
   "keywords": [],
   "author": "NiceCrew",
-  "description": "A bot that responds to activities from Pleroma instances using Ollama's API.",
+  "description": "A simple bot that responds to activities from Pleroma instances using Ollama's API.",
   "dependencies": {
+    "@prisma/client": "^6.10.1",
     "@types/node": "^24.0.5",
+    "dotenv": "^17.0.0",
+    "striptags": "^3.2.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
   },

prisma/migrations/20250629160031_initial_database_logic/migration.sql

@@ -0,0 +1,19 @@
+-- CreateTable
+CREATE TABLE "Response" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "from" TEXT NOT NULL,
+    "to" TEXT NOT NULL,
+    "content" TEXT NOT NULL,
+    "createdAt" DATETIME,
+    "processedAt" DATETIME
+);
+
+-- CreateTable
+CREATE TABLE "User" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "userFqn" TEXT NOT NULL,
+    "receivedAt" DATETIME
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User_userFqn_key" ON "User"("userFqn");

prisma/migrations/20250629161333_use_lastrespondedto_rather_than_createdat/migration.sql

@@ -0,0 +1,20 @@
+/*
+  Warnings:
+
+  - You are about to drop the column `receivedAt` on the `User` table. All the data in the column will be lost.
+
+*/
+-- RedefineTables
+PRAGMA defer_foreign_keys=ON;
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_User" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "userFqn" TEXT NOT NULL,
+    "lastRespondedTo" DATETIME
+);
+INSERT INTO "new_User" ("id", "userFqn") SELECT "id", "userFqn" FROM "User";
+DROP TABLE "User";
+ALTER TABLE "new_User" RENAME TO "User";
+CREATE UNIQUE INDEX "User_userFqn_key" ON "User"("userFqn");
+PRAGMA foreign_keys=ON;
+PRAGMA defer_foreign_keys=OFF;

prisma/migrations/20250629175251_use_simple_ids_prune_response_schema/migration.sql

@@ -0,0 +1,25 @@
+/*
+  Warnings:
+
+  - The primary key for the `Response` table will be changed. If it partially fails, the table could be left without primary key constraint.
+  - You are about to drop the column `content` on the `Response` table. All the data in the column will be lost.
+  - You are about to drop the column `from` on the `Response` table. All the data in the column will be lost.
+  - You are about to alter the column `id` on the `Response` table. The data in that column could be lost. The data in that column will be cast from `String` to `Int`.
+
+*/
+-- RedefineTables
+PRAGMA defer_foreign_keys=ON;
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_Response" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "to" TEXT NOT NULL,
+    "request" TEXT,
+    "response" TEXT,
+    "createdAt" DATETIME,
+    "processedAt" DATETIME
+);
+INSERT INTO "new_Response" ("createdAt", "id", "processedAt", "to") SELECT "createdAt", "id", "processedAt", "to" FROM "Response";
+DROP TABLE "Response";
+ALTER TABLE "new_Response" RENAME TO "Response";
+PRAGMA foreign_keys=ON;
+PRAGMA defer_foreign_keys=OFF;

prisma/migrations/20250629181550_add_pleroma_notification_i_ds/migration.sql

@@ -0,0 +1,17 @@
+-- RedefineTables
+PRAGMA defer_foreign_keys=ON;
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_Response" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "pleromaNotificationId" TEXT NOT NULL DEFAULT 'null',
+    "to" TEXT NOT NULL,
+    "request" TEXT,
+    "response" TEXT,
+    "createdAt" DATETIME,
+    "processedAt" DATETIME
+);
+INSERT INTO "new_Response" ("createdAt", "id", "processedAt", "request", "response", "to") SELECT "createdAt", "id", "processedAt", "request", "response", "to" FROM "Response";
+DROP TABLE "Response";
+ALTER TABLE "new_Response" RENAME TO "Response";
+PRAGMA foreign_keys=ON;
+PRAGMA defer_foreign_keys=OFF;

prisma/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (e.g., Git)
+provider = "sqlite"

prisma/schema.prisma

@@ -11,6 +11,18 @@ datasource db {
   url      = env("DATABASE_URL")
 }
 
-model Notification {
+model Response {
-  
+  id                    Int       @id @default(autoincrement())
+  pleromaNotificationId String    @default("null")
+  to                    String
+  request               String?
+  response              String?
+  createdAt             DateTime?
+  processedAt           DateTime?
+}
+
+model User {
+  id              Int       @id @default(autoincrement())
+  userFqn         String    @unique
+  lastRespondedTo DateTime?
 }

src/main.ts

@@ -0,0 +1,172 @@
+import {
+  OllamaRequest,
+  OllamaResponse,
+  NewStatusBody,
+  Notification,
+} from "../types.js";
+import striptags from "striptags";
+import { PrismaClient } from "../generated/prisma/client.js";
+
+const prisma = new PrismaClient();
+
+const getNotifications = async () => {
+  try {
+    const request = await fetch(
+      `${process.env.PLEROMA_INSTANCE_URL}/api/v1/notifications?types[]=mention`,
+      {
+        method: "GET",
+        headers: {
+          Authorization: `Bearer ${process.env.INSTANCE_BEARER_TOKEN}`,
+        },
+      }
+    );
+
+    const notifications: Notification[] = await request.json();
+
+    return notifications;
+  } catch (error: any) {
+    throw new Error(error.message);
+  }
+};
+
+const notifications = await getNotifications();
+
+const storeUserData = async (notification: Notification) => {
+  try {
+    const user = await prisma.user.upsert({
+      where: { userFqn: notification.status.account.fqn },
+      update: {
+        lastRespondedTo: new Date(Date.now()),
+      },
+      create: {
+        userFqn: notification.status.account.fqn,
+        lastRespondedTo: new Date(Date.now()),
+      },
+    });
+  } catch (error: any) {
+    throw new Error(error.message);
+  }
+};
+
+const alreadyRespondedTo = async (
+  notification: Notification
+): Promise<boolean> => {
+  try {
+    const duplicate = await prisma.response.findFirst({
+      where: { pleromaNotificationId: notification.status.id },
+    });
+    if (duplicate) {
+      return true;
+    }
+    return false;
+  } catch (error: any) {
+    throw new Error(error.message);
+  }
+};
+
+const storePromptData = async (
+  notification: Notification,
+  ollamaResponseBody: OllamaResponse
+) => {
+  try {
+    await prisma.response.create({
+      data: {
+        response: ollamaResponseBody.response,
+        request: striptags(notification.status.content),
+        to: notification.account.fqn,
+        pleromaNotificationId: notification.status.id,
+        createdAt: new Date(Date.now()),
+      },
+    });
+  } catch (error: any) {
+    throw new Error(error.message);
+  }
+};
+
+const generateOllamaRequest = async (
+  notification: Notification
+): Promise<OllamaResponse | undefined> => {
+  try {
+    if (
+      striptags(notification.status.content).includes("!prompt") &&
+      !notification.status.account.bot
+    ) {
+      if (
+        process.env.ONLY_LOCAL_REPLIES === "true" &&
+        !notification.status.account.fqn.includes(
+          `@${process.env.PLEROMA_INSTANCE_DOMAIN}`
+        )
+      ) {
+        return;
+      }
+      if (await alreadyRespondedTo(notification)) {
+        // console.log(
+        //   `Already responded to notification ID ${notification.status.id}. Canceling.`
+        // );
+        return;
+      }
+      await storeUserData(notification);
+      const ollamaRequestBody: OllamaRequest = {
+        model: process.env.OLLAMA_MODEL as string,
+        system: process.env.OLLAMA_SYSTEM_PROMPT as string,
+        prompt: striptags(notification.status.content),
+        stream: false,
+      };
+      const response = await fetch(`${process.env.OLLAMA_URL}/api/generate`, {
+        method: "POST",
+        body: JSON.stringify(ollamaRequestBody),
+      });
+      const ollamaResponse: OllamaResponse = await response.json();
+      await storePromptData(notification, ollamaResponse);
+      console.log(
+        `${notification.status.account.fqn} asked:\n${notification.status.content}\nResponse:\n${ollamaResponse.response}`
+      );
+      postReplyToStatus(notification, ollamaResponse);
+    }
+  } catch (error: any) {
+    throw new Error(error.message);
+  }
+};
+
+const postReplyToStatus = async (
+  notification: Notification,
+  ollamaResponseBody: OllamaResponse
+) => {
+  try {
+    const mentions = notification.status.mentions?.map((mention) => {
+      return mention.acct;
+    });
+    let statusBody: NewStatusBody = {
+      content_type: "text/markdown",
+      status: ollamaResponseBody.response,
+      in_reply_to_id: notification.status.id,
+      to: mentions,
+    };
+
+    const response = await fetch(
+      `${process.env.PLEROMA_INSTANCE_URL}/api/v1/statuses`,
+      {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${process.env.INSTANCE_BEARER_TOKEN}`,
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify(statusBody),
+      }
+    );
+
+    if (!response.ok) {
+      throw new Error(`New status request failed: ${response.statusText}`);
+    }
+  } catch (error: any) {
+    throw new Error(error.message);
+  }
+};
+
+if (notifications) {
+  await Promise.all(
+    notifications.map((notification) => {
+      generateOllamaRequest(notification);
+    })
+  );
+}

tsconfig.json

@@ -1,113 +1,16 @@
 {
   "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
+    "target": "ES2022",
-
+    "module": "nodenext",
-    /* Projects */
+    "moduleResolution": "NodeNext",
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    "esModuleInterop": true,
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    "outDir": "./dist",
-    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    "rootDir": "./src",
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    "strict": true,
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    "forceConsistentCasingInFileNames": true,
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+    "skipLibCheck": true,
-
+    "resolveJsonModule": true
-    /* Language and Environment */
+  },
-    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+  "include": ["src/**/*", "types.d.ts"],
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+  "exclude": ["node_modules", "dist"]
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "libReplacement": true,                           /* Enable lib replacement. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
-    /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
-    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
-    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
-    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
-    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
-    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
-    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files. */
-    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
-    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
-
-    /* JavaScript Support */
-    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-
-    /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
-    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
-    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-
-    /* Interop Constraints */
-    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
-    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
-    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
-    // "erasableSyntaxOnly": true,                       /* Do not allow runtime constructs that are not part of ECMAScript. */
-    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-
-    /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
-    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
-    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
-    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
-    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
-    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
-    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
-    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
-    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
-    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-    /* Completeness */
-    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
-  }
 }

types.d.ts

@@ -22,8 +22,21 @@ export interface Account {
 }
 
 export interface OllamaRequest {
-  model: string; // must be a valid and locally installed Ollama model
+  /**
-  prompt: string; // user prompt
+   * Name of the Ollama model to generate a response from. Must be a valid and locally installed model.
+   */
+  model: string;
+  /**
+   * The prompt sent from the end-user.
+   */
+  prompt: string;
+  /**
+   * Whatever system prompt you'd like to add to the model to make it more unique, or force it to respond a certain way.
+   */
+  system: string;
+  /**
+   * Whether to stream responses from the API, or have it sent all as one payload.
+   */
   stream?: boolean = false; // stream response vs get response in one full message
 }