sqlite-hub 0.16.0 → 0.17.2

package/server/routes/settings.js

@@ -1,4 +1,5 @@
 const express = require("express");
+const Database = require("better-sqlite3");
 const fs = require("node:fs");
 const path = require("node:path");
 const { route, successResponse } = require("../utils/errors");
@@ -9,6 +10,23 @@ function readAppVersion() {
   return packageJson.version ?? "0.0.0";
 }
 
+function readSqliteVersion() {
+  const db = new Database(":memory:");
+
+  try {
+    return db.prepare("SELECT sqlite_version() AS version").get().version ?? "unknown";
+  } finally {
+    db.close();
+  }
+}
+
+function readSettingsMetadata() {
+  return {
+    appVersion: readAppVersion(),
+    sqliteVersion: readSqliteVersion(),
+  };
+}
+
 function createSettingsRouter({ appStateStore }) {
   const router = express.Router();
 
@@ -18,9 +36,7 @@ function createSettingsRouter({ appStateStore }) {
       res.json(
         successResponse({
           data: appStateStore.getSettings(),
-          metadata: {
-            appVersion: readAppVersion(),
-          },
+          metadata: readSettingsMetadata(),
         })
       );
     })
@@ -34,9 +50,7 @@ function createSettingsRouter({ appStateStore }) {
         successResponse({
           message: "Settings updated.",
           data: settings,
-          metadata: {
-            appVersion: readAppVersion(),
-          },
+          metadata: readSettingsMetadata(),
         })
       );
     })
@@ -47,4 +61,6 @@ function createSettingsRouter({ appStateStore }) {
 
 module.exports = {
   createSettingsRouter,
+  readSettingsMetadata,
+  readSqliteVersion,
 };

package/server/server.js

@@ -3,6 +3,11 @@ const helmet = require("helmet");
 const rateLimit = require("express-rate-limit");
 const path = require("node:path");
 const { errorMiddleware } = require("./utils/errors");
+const {
+  LOOPBACK_HOST,
+  listenOnLoopback,
+  localRequestSecurity,
+} = require("./middleware/localRequestSecurity");
 const { resolveAppStatePaths } = require("./utils/appPaths");
 const { AppStateStore } = require("./services/storage/appStateStore");
 const { ConnectionManager } = require("./services/sqlite/connectionManager");
@@ -10,6 +15,7 @@ const { OverviewService } = require("./services/sqlite/overviewService");
 const { SqlExecutor } = require("./services/sqlite/sqlExecutor");
 const { ImportService } = require("./services/sqlite/importService");
 const { BackupService } = require("./services/sqlite/backupService");
+const { NativeFileDialogService } = require("./services/nativeFileDialogService");
 const { ExportService } = require("./services/sqlite/exportService");
 const { StructureService } = require("./services/sqlite/structureService");
 const { DataBrowserService } = require("./services/sqlite/dataBrowserService");
@@ -25,6 +31,7 @@ const { createTableDesignerRouter } = require("./routes/tableDesigner");
 const { createMediaTaggingRouter } = require("./routes/mediaTagging");
 const { createSettingsRouter } = require("./routes/settings");
 const { createExportRouter } = require("./routes/export");
+const { createDocumentsRouter } = require("./routes/documents");
 
 const PACKAGE_ROOT = path.resolve(__dirname, "..");
 const FRONTEND_ROOT = path.join(PACKAGE_ROOT, "frontend");
@@ -36,6 +43,7 @@ const {
   legacyDatabasePaths: LEGACY_DATABASE_PATHS,
 } = resolveAppStatePaths(PACKAGE_ROOT);
 const DEFAULT_PORT = 4173;
+const DEFAULT_HOST = LOOPBACK_HOST;
 
 const appStateStore = new AppStateStore(APP_STATE_DB_PATH, {
   legacyFilePath: LEGACY_STATE_PATH,
@@ -46,6 +54,7 @@ const overviewService = new OverviewService({ connectionManager });
 const sqlExecutor = new SqlExecutor({ connectionManager, appStateStore });
 const importService = new ImportService({ connectionManager });
 const backupService = new BackupService({ connectionManager });
+const nativeFileDialogService = new NativeFileDialogService();
 const exportService = new ExportService({
   appStateStore,
   connectionManager,
@@ -65,6 +74,7 @@ app.use(
     contentSecurityPolicy: false,
   })
 );
+app.use("/api", localRequestSecurity);
 app.use(
   "/api",
   rateLimit({
@@ -96,6 +106,7 @@ app.use(
     connectionManager,
     importService,
     backupService,
+    nativeFileDialogService,
   })
 );
 app.use("/api/db", createOverviewRouter({ overviewService }));
@@ -107,6 +118,7 @@ app.use("/api/table-designer", createTableDesignerRouter({ tableDesignerService
 app.use("/api/media-tagging", createMediaTaggingRouter({ mediaTaggingService }));
 app.use("/api/settings", createSettingsRouter({ appStateStore }));
 app.use("/api/export", createExportRouter({ exportService }));
+app.use("/api/documents", createDocumentsRouter({ appStateStore, connectionManager }));
 
 // auth: public favicon response; it exposes no application data.
 app.get("/favicon.ico", (req, res) => {
@@ -143,6 +155,10 @@ app.use(
   "/vendor/material-symbols",
   express.static(path.resolve(__dirname, "..", "node_modules", "material-symbols"))
 );
+app.use(
+  "/vendor/marked",
+  express.static(path.resolve(__dirname, "..", "node_modules", "marked"))
+);
 app.use(express.static(FRONTEND_ROOT));
 app.use("/db_logos", express.static(path.join(APP_STATE_DIRECTORY, "db_logos")));
 app.use(errorMiddleware);
@@ -185,7 +201,7 @@ function startServer({ port } = {}) {
   const resolvedPort = resolvePort(port);
 
   return new Promise((resolve, reject) => {
-    const server = app.listen(resolvedPort);
+    const server = listenOnLoopback(app, resolvedPort);
 
     server.once("error", reject);
     server.once("listening", () => {
@@ -212,6 +228,7 @@ module.exports = {
   app,
   appStateStore,
   connectionManager,
+  DEFAULT_HOST,
   DEFAULT_PORT,
   parsePortArgument,
   resolvePort,

package/server/services/nativeFileDialogService.js

@@ -0,0 +1,168 @@
+const path = require("node:path");
+const os = require("node:os");
+const { execFile } = require("node:child_process");
+const { promisify } = require("node:util");
+const { AppError } = require("../utils/errors");
+
+const execFileAsync = promisify(execFile);
+const DEFAULT_DATABASE_FILENAME = "new-database.sqlite";
+
+function escapePowerShellSingleQuotedString(value) {
+  return String(value).replaceAll("'", "''");
+}
+
+function buildDialogAttempts({ platform = process.platform, homeDirectory = os.homedir() } = {}) {
+  const defaultPath = path.join(homeDirectory, DEFAULT_DATABASE_FILENAME);
+
+  if (platform === "darwin") {
+    return [
+      {
+        command: "osascript",
+        args: [
+          "-e",
+          "on run argv",
+          "-e",
+          'set selectedFile to choose file name with prompt "Create SQLite Database" default location POSIX file (item 1 of argv) default name (item 2 of argv)',
+          "-e",
+          "return POSIX path of selectedFile",
+          "-e",
+          "end run",
+          homeDirectory,
+          DEFAULT_DATABASE_FILENAME,
+        ],
+        cancelledExitCodes: new Set([1]),
+        cancelledErrorPattern: /user canceled|-128/i,
+      },
+    ];
+  }
+
+  if (platform === "win32") {
+    const initialDirectory = escapePowerShellSingleQuotedString(homeDirectory);
+    const script = [
+      "Add-Type -AssemblyName System.Windows.Forms",
+      "$dialog = New-Object System.Windows.Forms.SaveFileDialog",
+      "$dialog.Title = 'Create SQLite Database'",
+      "$dialog.Filter = 'SQLite databases (*.db;*.sqlite;*.sqlite3)|*.db;*.sqlite;*.sqlite3|All files (*.*)|*.*'",
+      "$dialog.DefaultExt = 'sqlite'",
+      "$dialog.AddExtension = $true",
+      `$dialog.InitialDirectory = '${initialDirectory}'`,
+      `$dialog.FileName = '${DEFAULT_DATABASE_FILENAME}'`,
+      "if ($dialog.ShowDialog() -eq [System.Windows.Forms.DialogResult]::OK) {",
+      "  [Console]::Out.Write($dialog.FileName)",
+      "} else {",
+      "  exit 2",
+      "}",
+    ].join("; ");
+
+    return [
+      {
+        command: "powershell.exe",
+        args: ["-NoProfile", "-STA", "-Command", script],
+        cancelledExitCodes: new Set([2]),
+      },
+    ];
+  }
+
+  return [
+    {
+      command: "zenity",
+      args: [
+        "--file-selection",
+        "--save",
+        "--title=Create SQLite Database",
+        `--filename=${defaultPath}`,
+        "--file-filter=SQLite databases | *.db *.sqlite *.sqlite3",
+        "--file-filter=All files | *",
+      ],
+      cancelledExitCodes: new Set([1]),
+    },
+    {
+      command: "kdialog",
+      args: [
+        "--getsavefilename",
+        defaultPath,
+        "SQLite databases (*.db *.sqlite *.sqlite3)",
+        "--title",
+        "Create SQLite Database",
+      ],
+      cancelledExitCodes: new Set([1]),
+    },
+  ];
+}
+
+function normalizeSelectedDatabasePath(value) {
+  const selectedPath = String(value ?? "").trim();
+
+  if (!selectedPath) {
+    return null;
+  }
+
+  return path.extname(selectedPath) ? selectedPath : `${selectedPath}.sqlite`;
+}
+
+function isMissingDialogCommand(error) {
+  return error?.code === "ENOENT";
+}
+
+function isCancelledDialog(error, attempt) {
+  if (!attempt.cancelledExitCodes.has(Number(error?.code))) {
+    return false;
+  }
+
+  if (!attempt.cancelledErrorPattern) {
+    return true;
+  }
+
+  return attempt.cancelledErrorPattern.test(`${error?.message ?? ""}\n${error?.stderr ?? ""}`);
+}
+
+class NativeFileDialogService {
+  constructor(options = {}) {
+    this.platform = options.platform ?? process.platform;
+    this.homeDirectory = options.homeDirectory ?? os.homedir();
+    this.executeFile = options.executeFile ?? execFileAsync;
+  }
+
+  async chooseCreateDatabasePath() {
+    const attempts = buildDialogAttempts({
+      platform: this.platform,
+      homeDirectory: this.homeDirectory,
+    });
+
+    for (const attempt of attempts) {
+      try {
+        const result = await this.executeFile(attempt.command, attempt.args, {
+          maxBuffer: 64 * 1024,
+          windowsHide: true,
+        });
+
+        return normalizeSelectedDatabasePath(result?.stdout);
+      } catch (error) {
+        if (isCancelledDialog(error, attempt)) {
+          return null;
+        }
+
+        if (isMissingDialogCommand(error)) {
+          continue;
+        }
+
+        throw new AppError("The native file dialog could not be opened.", 500, {
+          code: "NATIVE_FILE_DIALOG_FAILED",
+          details: { platform: this.platform },
+        });
+      }
+    }
+
+    throw new AppError("No supported native file dialog is available on this system.", 501, {
+      code: "NATIVE_FILE_DIALOG_UNAVAILABLE",
+      details: { platform: this.platform },
+    });
+  }
+}
+
+module.exports = {
+  DEFAULT_DATABASE_FILENAME,
+  NativeFileDialogService,
+  buildDialogAttempts,
+  normalizeSelectedDatabasePath,
+};

package/server/services/sqlite/dataBrowserService.js

@@ -74,10 +74,6 @@ function formatPreviewValue(value) {
 }
 
 function isUnchangedSubmittedValue(currentValue, submittedValue) {
-  if (currentValue === null && submittedValue === "") {
-    return true;
-  }
-
   return formatPreviewValue(currentValue) === formatPreviewValue(submittedValue);
 }
 

package/server/services/sqlite/exportService.js

@@ -91,6 +91,8 @@ class ExportService {
         })
     );
     const result = this.sqlExecutor.execute(sql, {
+      blobMode: "full",
+      maxRows: null,
       persistHistory: false,
       requireReader: true,
     });
@@ -132,7 +134,9 @@ class ExportService {
         .filter(Boolean)
         .join(" ")
     );
-    const rows = serializeRows(statement.all(...(filter?.params ?? [])));
+    const rows = serializeRows(statement.all(...(filter?.params ?? [])), {
+      blobMode: "full",
+    });
     const columns = statement.columns().map((column) => column.name);
     const content = renderExportContent({
       columns,

package/server/services/sqlite/sqlExecutor.js

@@ -2,6 +2,45 @@ const { ValidationError, mapSqliteError } = require("../../utils/errors");
 const { serializeRows } = require("../../utils/sqliteTypes");
 const { getTableDetail } = require("./introspection");
 
+const DEFAULT_RESULT_ROW_LIMIT = 5000;
+
+function normalizeResultRowLimit(value) {
+  if (value === null || value === false) {
+    return null;
+  }
+
+  const normalized = value === undefined ? DEFAULT_RESULT_ROW_LIMIT : Number(value);
+
+  if (!Number.isInteger(normalized) || normalized < 1) {
+    throw new ValidationError("SQL result row limit must be a positive integer or null.");
+  }
+
+  return normalized;
+}
+
+function readResultRows(prepared, rowLimit) {
+  if (rowLimit === null) {
+    return {
+      rows: prepared.all(),
+      truncated: false,
+    };
+  }
+
+  const rows = [];
+  let truncated = false;
+
+  for (const row of prepared.iterate()) {
+    if (rows.length >= rowLimit) {
+      truncated = true;
+      break;
+    }
+
+    rows.push(row);
+  }
+
+  return { rows, truncated };
+}
+
 function getSerializedMemoryBytes(value) {
   try {
     return Buffer.byteLength(JSON.stringify(value ?? null), "utf8");
@@ -365,6 +404,7 @@ class SqlExecutor {
     const db = this.connectionManager.getActiveDatabase();
     const connection = this.connectionManager.getActiveConnection();
     const statements = splitSqlStatements(sql);
+    const rowLimit = normalizeResultRowLimit(options.maxRows);
 
     if (statements.length === 0) {
       throw new ValidationError("No executable SQL statements were found.");
@@ -386,9 +426,11 @@ class SqlExecutor {
         }
 
         if (prepared.reader) {
-          const rows = prepared.all();
+          const { rows, truncated } = readResultRows(prepared, rowLimit);
           const columnDefinitions = prepared.columns();
-          const serializedRows = serializeRows(rows);
+          const serializedRows = serializeRows(rows, {
+            blobMode: options.blobMode,
+          });
           const editableResult = resolveEditableResult(db, columnDefinitions, serializedRows);
           const columns = columnDefinitions.map((column) => column.name);
           const result = {
@@ -397,6 +439,8 @@ class SqlExecutor {
             keyword,
             kind: "resultSet",
             rowCount: serializedRows.length,
+            truncated,
+            rowLimit,
             columns,
             rows: editableResult?.rows ?? serializedRows,
             editing: editableResult
@@ -463,6 +507,8 @@ class SqlExecutor {
       rows: lastResultSet?.rows ?? [],
       columns: lastResultSet?.columns ?? [],
       editing: lastResultSet?.editing ?? null,
+      truncated: Boolean(lastResultSet?.truncated),
+      rowLimit: lastResultSet ? lastResultSet.rowLimit : null,
       affectedRowCount: totalChanges,
       resultKind: lastResultSet ? "resultSet" : results.at(-1)?.kind ?? "unknown",
     };
@@ -490,6 +536,9 @@ class SqlExecutor {
 }
 
 module.exports = {
+  DEFAULT_RESULT_ROW_LIMIT,
   SqlExecutor,
+  normalizeResultRowLimit,
+  readResultRows,
   splitSqlStatements,
 };