feat: add @types/better-sqlite3 for improved TypeScript support and refactor database functions for clarity

Author: JasonKrik

package-lock.json

@@ -22,7 +22,6 @@
     "fastify": "^5.3.3",
     "fastify-favicon": "^5.0.0",
     "lucia": "^3.2.2",
-
     "pino": "^9.7.0",
     "pino-pretty": "^13.0.0",
     "zod": "^3.25.42"
@@ -32,7 +31,7 @@
     "@commitlint/config-conventional": "^19.8.1",
     "@eslint/js": "^9.27.0",
     "@release-it/conventional-changelog": "^10.0.1",
-
+    "@types/better-sqlite3": "^7.6.13",
     "@typescript-eslint/eslint-plugin": "^8.33.0",
     "@typescript-eslint/parser": "^8.33.0",
     "drizzle-kit": "^0.31.1",

services/backend/package.json

@@ -6,7 +6,7 @@ import { type Plugin, type DatabaseExtension } from '../plugin-system/types'; //
 import { getDbConfig, saveDbConfig, type DbConfig, type SQLiteConfig } from './config';
 
 // Schema Definitions
-import { baseTableDefinitions, pluginTableDefinitions as inputPluginTableDefinitions } from './schema';
+import { /* baseTableDefinitions, */ pluginTableDefinitions as inputPluginTableDefinitions } from './schema';
 
 // Drizzle SQLite
 import { drizzle as drizzleSqliteAdapter, type BetterSQLite3Database } from 'drizzle-orm/better-sqlite3';
@@ -36,11 +36,12 @@ function getColumnBuilder(type: 'text' | 'integer' | 'timestamp') {
   throw new Error(`Unsupported column type ${type}`);
 }
 
+import * as staticSchema from './schema.sqlite';
+
 function generateSchema(): AnySchema {
   // Import the static schema instead of generating it dynamically
   // This avoids SQL syntax errors caused by dynamic schema generation
-  const staticSchema = require('./schema.sqlite');
-  const generatedSchema = { ...staticSchema };
+  const generatedSchema: AnySchema = { ...staticSchema };
 
   // Add plugin tables to the static schema
   for (const [tableName, tableColumns] of Object.entries(inputPluginTableDefinitions)) {
@@ -60,7 +61,7 @@ function generateSchema(): AnySchema {
   return generatedSchema;
 }
 
-async function ensureMigrationsTable(_db: AnyDatabase) { // db param not used due to raw exec
+async function ensureMigrationsTable() { // db param not used due to raw exec
   const createTableQuery = `
     CREATE TABLE IF NOT EXISTS ${MIGRATIONS_TABLE_NAME} (
       id INTEGER PRIMARY KEY AUTOINCREMENT,
@@ -72,7 +73,7 @@ async function ensureMigrationsTable(_db: AnyDatabase) { // db param not used du
   (dbConnection as SqliteDriver.Database).exec(createTableQuery);
 }
 
-async function applyMigrations(db: AnyDatabase) {
+async function applyMigrations() {
   const projectRootMigrationsDir = path.join(process.cwd(), 'drizzle');
 
   // fs.stat is async with fs/promises, so await it or use fs.existsSync
@@ -93,7 +94,7 @@ async function applyMigrations(db: AnyDatabase) {
   }
 
   console.log(`[INFO] Checking for new migrations in ${migrationsPath}...`);
-  await ensureMigrationsTable(db);
+  await ensureMigrationsTable();
 
   let appliedMigrations: { name: string }[] = [];
   const selectAppliedQuery = `SELECT migration_name as name FROM ${MIGRATIONS_TABLE_NAME}`;
@@ -173,7 +174,7 @@ export async function initializeDatabase(): Promise<boolean> {
   if (!dbExists) console.log(`[INFO] SQLite database created at: ${absoluteDbPath}`);
 
   if (dbInstance) { // Ensure dbInstance is not null
-    await applyMigrations(dbInstance);
+    await applyMigrations();
   } else {
     throw new Error("Database instance could not be created.");
   }
@@ -284,7 +285,7 @@ export function registerPluginTables(plugins: Plugin[]) {
   }
 }
 
-export async function createPluginTables(_db: AnyDatabase, plugins: Plugin[]) { // db param not used
+export async function createPluginTables(plugins: Plugin[]) { // db param not used
   console.log('[INFO] Attempting to create plugin tables (Note: Better handled by migrations)...');
   if (!currentDbConfig) {
       console.error("[ERROR] Cannot create plugin tables: DB config unknown.");

services/backend/src/db/index.ts

@@ -107,14 +107,16 @@ export const pluginTableDefinitions: Record<string, Record<string, (columnBuilde
 // Example of how it will be used in db/index.ts:
 //
 // import { baseTableDefinitions } from './schema';
-// import { pgTable, text as pgTextColumnBuilder, integer as pgIntegerColumnBuilder } from 'drizzle-orm/pg-core';
+// import { sqliteTable, text as sqliteTextColumnBuilder, integer as sqliteIntegerColumnBuilder } from 'drizzle-orm/sqlite-core';
 //
-// const users = pgTable('users', {
-//   id: baseTableDefinitions.users.id(pgTextColumnBuilder),
-//   email: baseTableDefinitions.users.email(pgTextColumnBuilder),
-//   name: baseTableDefinitions.users.name(pgTextColumnBuilder),
-//   createdAt: baseTableDefinitions.users.createdAt(pgIntegerColumnBuilder),
-//   updatedAt: baseTableDefinitions.users.updatedAt(pgIntegerColumnBuilder),
+// const users = sqliteTable('users', {
+//   id: baseTableDefinitions.users.id(sqliteTextColumnBuilder),
+//   email: baseTableDefinitions.users.email(sqliteTextColumnBuilder),
+//   name: baseTableDefinitions.users.name(sqliteTextColumnBuilder),
+//   createdAt: baseTableDefinitions.users.createdAt(sqliteIntegerColumnBuilder),
+//   updatedAt: baseTableDefinitions.users.updatedAt(sqliteIntegerColumnBuilder),
 // });
 //
-// export const schema = { users };
+// // The actual schema is built in 'services/backend/src/db/schema.sqlite.ts'
+// // and augmented with plugin tables in 'services/backend/src/db/index.ts'
+// // export const schema = { users };

services/backend/src/db/schema.ts

@@ -30,6 +30,7 @@ function initializeLucia(): Lucia {
   }
 
   // Use existing database connection and schema
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const db = getDb() as BetterSQLite3Database<any>;
   const schema = getSchema();
 

services/backend/src/lib/lucia.ts

@@ -33,6 +33,7 @@ export default async function logoutRoute(fastify: FastifyInstance) {
             if (authSessionTable && authSessionTable.id) {
               const dbStatus = getDbStatus();
               if (dbStatus.dialect === 'sqlite') {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 const sqliteDb = db as BetterSQLite3Database<any>;
                 await sqliteDb.delete(authSessionTable).where(eq(authSessionTable.id, sessionId));
               }
@@ -81,6 +82,7 @@ export default async function logoutRoute(fastify: FastifyInstance) {
           if (authSessionTable && authSessionTable.id) {
             const dbStatus = getDbStatus();
             if (dbStatus.dialect === 'sqlite') {
+              // eslint-disable-next-line @typescript-eslint/no-explicit-any
               const sqliteDb = db as BetterSQLite3Database<any>;
               await sqliteDb.delete(authSessionTable).where(eq(authSessionTable.id, sessionId));
             }

services/backend/src/routes/auth/logout.ts

@@ -3,16 +3,15 @@ import 'fastify'
 import { type AnyDatabase } from '../db' 
 // Import types for raw connections/pools
 import type SqliteDriver from 'better-sqlite3'
-import type { Pool as PgPool } from 'pg'
 import { type PluginManager } from '../plugin-system'
 
 declare module 'fastify' {
   interface FastifyInstance {
     // 'db' can now be a Drizzle instance for SQLite or PostgreSQL, or null if not initialized
     db: AnyDatabase | null
 
-    // 'rawDbConnection' holds the underlying driver connection (better-sqlite3) or pool (pg)
-    rawDbConnection: SqliteDriver.Database | PgPool | null
+    // 'rawDbConnection' holds the underlying driver connection (better-sqlite3)
+    rawDbConnection: SqliteDriver.Database | null
 
     // The 'sqlite' property is deprecated in favor of 'rawDbConnection' to avoid ambiguity.
     // If some parts of the application still rely on it, it should be:

services/backend/src/types/fastify.ts

@@ -76,7 +76,7 @@
 </template>
 
 <script setup lang="ts">
-import { ref, onMounted } from 'vue';
+import { onMounted } from 'vue';
 import { useRouter } from 'vue-router';
 import { useForm } from 'vee-validate';
 import { toTypedSchema } from '@vee-validate/zod';