spindb 0.37.2 → 0.38.0

package/config/engine-defaults.ts

@@ -1,336 +0,0 @@
-/**
- * Engine-specific default configurations
- * Extracted for dependency injection pattern - allows each engine to define its own defaults
- */
-
-import { Engine, ALL_ENGINES } from '../types'
-
-export type EngineDefaults = {
-  // Default version to use when not specified
-  defaultVersion: string
-  // Default port for this engine
-  defaultPort: number
-  // Port range to scan if default is busy
-  portRange: { start: number; end: number }
-  // Latest major version (used for Homebrew package names like postgresql@17)
-  latestVersion: string
-  // Default superuser name
-  superuser: string
-  // Connection string scheme (e.g., 'postgresql', 'mysql')
-  connectionScheme: string
-  // Log file name within container directory
-  logFileName: string
-  // PID file name (relative to data directory or container)
-  pidFileName: string
-  // Subdirectory for data files within container
-  dataSubdir: string
-  // Client tools required for this engine
-  clientTools: string[]
-  // Default max connections (higher than PostgreSQL default of 100 for parallel builds)
-  maxConnections: number
-}
-
-export const engineDefaults: Record<Engine, EngineDefaults> = {
-  [Engine.PostgreSQL]: {
-    defaultVersion: '18',
-    defaultPort: 5432,
-    portRange: { start: 5432, end: 5500 },
-    latestVersion: '18',
-    superuser: 'postgres',
-    connectionScheme: 'postgresql',
-    logFileName: 'postgres.log',
-    pidFileName: 'postmaster.pid',
-    dataSubdir: 'data',
-    clientTools: ['psql', 'pg_dump', 'pg_restore', 'pg_basebackup'],
-    maxConnections: 200, // Higher than default 100 for parallel builds (Next.js, etc.)
-  },
-  [Engine.MySQL]: {
-    defaultVersion: '8.4',
-    defaultPort: 3306,
-    portRange: { start: 3306, end: 3400 },
-    latestVersion: '9',
-    superuser: 'root',
-    connectionScheme: 'mysql',
-    logFileName: 'mysql.log',
-    pidFileName: 'mysql.pid',
-    dataSubdir: 'data',
-    clientTools: ['mysql', 'mysqldump', 'mysqladmin'],
-    maxConnections: 200, // Higher than default 151 for parallel builds
-  },
-  [Engine.MariaDB]: {
-    defaultVersion: '11.8',
-    defaultPort: 3307, // Different from MySQL to allow side-by-side
-    portRange: { start: 3307, end: 3400 },
-    latestVersion: '11.8',
-    superuser: 'root',
-    connectionScheme: 'mysql', // MariaDB uses MySQL protocol
-    logFileName: 'mariadb.log',
-    pidFileName: 'mariadb.pid',
-    dataSubdir: 'data',
-    clientTools: ['mysql', 'mysqldump', 'mysqladmin'],
-    maxConnections: 200, // Higher than default 151 for parallel builds
-  },
-  [Engine.SQLite]: {
-    defaultVersion: '3',
-    defaultPort: 0, // File-based, no port
-    portRange: { start: 0, end: 0 }, // N/A
-    latestVersion: '3',
-    superuser: '', // No authentication
-    connectionScheme: 'sqlite',
-    logFileName: '', // No log file
-    pidFileName: '', // No PID file (no server process)
-    dataSubdir: '', // File is the data
-    clientTools: ['sqlite3'],
-    maxConnections: 0, // N/A - file-based
-  },
-  [Engine.DuckDB]: {
-    defaultVersion: '1',
-    defaultPort: 0, // File-based, no port
-    portRange: { start: 0, end: 0 }, // N/A
-    latestVersion: '1',
-    superuser: '', // No authentication
-    connectionScheme: 'duckdb',
-    logFileName: '', // No log file
-    pidFileName: '', // No PID file (no server process)
-    dataSubdir: '', // File is the data
-    clientTools: ['duckdb'],
-    maxConnections: 0, // N/A - file-based
-  },
-  [Engine.MongoDB]: {
-    defaultVersion: '8.0',
-    defaultPort: 27017,
-    portRange: { start: 27017, end: 27100 },
-    latestVersion: '8.2',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'mongodb',
-    logFileName: 'mongodb.log',
-    pidFileName: 'mongod.pid',
-    dataSubdir: 'data',
-    clientTools: ['mongosh', 'mongodump', 'mongorestore'],
-    maxConnections: 0, // Not applicable for MongoDB
-  },
-  [Engine.Redis]: {
-    defaultVersion: '8',
-    defaultPort: 6379,
-    portRange: { start: 6379, end: 6400 },
-    latestVersion: '8',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'redis',
-    logFileName: 'redis.log',
-    pidFileName: 'redis.pid',
-    dataSubdir: 'data',
-    clientTools: ['redis-cli'],
-    maxConnections: 0, // Not applicable for Redis
-  },
-  [Engine.Valkey]: {
-    defaultVersion: '9',
-    defaultPort: 6379,
-    portRange: { start: 6379, end: 6479 },
-    latestVersion: '9',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'redis', // Use redis:// scheme for client compatibility
-    logFileName: 'valkey.log',
-    pidFileName: 'valkey.pid',
-    dataSubdir: 'data',
-    clientTools: ['valkey-cli'],
-    maxConnections: 0, // Not applicable for Valkey
-  },
-  [Engine.ClickHouse]: {
-    defaultVersion: '25.12',
-    defaultPort: 9000, // Native TCP port (HTTP is 8123)
-    portRange: { start: 9000, end: 9100 },
-    latestVersion: '25.12',
-    superuser: 'default', // Default user in ClickHouse
-    connectionScheme: 'clickhouse',
-    logFileName: 'clickhouse-server.log',
-    pidFileName: 'clickhouse.pid',
-    dataSubdir: 'data',
-    clientTools: ['clickhouse'],
-    maxConnections: 0, // Not applicable
-  },
-  [Engine.Qdrant]: {
-    defaultVersion: '1',
-    defaultPort: 6333, // HTTP REST API port (gRPC is 6334)
-    portRange: { start: 6333, end: 6400 },
-    latestVersion: '1',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'http',
-    logFileName: 'qdrant.log',
-    pidFileName: 'qdrant.pid',
-    dataSubdir: 'storage',
-    clientTools: [], // Qdrant uses REST API, no separate CLI tools
-    maxConnections: 0, // Not applicable for vector DB
-  },
-  [Engine.Meilisearch]: {
-    defaultVersion: '1',
-    defaultPort: 7700, // HTTP REST API port
-    portRange: { start: 7700, end: 7800 },
-    latestVersion: '1',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'http',
-    logFileName: 'meilisearch.log',
-    pidFileName: 'meilisearch.pid',
-    dataSubdir: 'data',
-    clientTools: [], // Meilisearch uses REST API, no separate CLI tools
-    maxConnections: 0, // Not applicable for search engine
-  },
-  [Engine.FerretDB]: {
-    defaultVersion: '2',
-    defaultPort: 27017, // MongoDB-compatible port
-    portRange: { start: 27017, end: 27100 },
-    latestVersion: '2',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'mongodb', // MongoDB-compatible protocol
-    logFileName: 'ferretdb.log',
-    pidFileName: 'ferretdb.pid',
-    dataSubdir: 'pg_data', // PostgreSQL backend data directory
-    clientTools: ['mongosh', 'mongodump', 'mongorestore'], // Uses MongoDB client tools
-    maxConnections: 200, // PostgreSQL backend default
-  },
-  [Engine.CouchDB]: {
-    defaultVersion: '3',
-    defaultPort: 5984, // CouchDB default HTTP port
-    portRange: { start: 5984, end: 6084 },
-    latestVersion: '3',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'http',
-    logFileName: 'couchdb.log',
-    pidFileName: 'couchdb.pid',
-    dataSubdir: 'data',
-    clientTools: [], // CouchDB uses REST API, no separate CLI tools
-    maxConnections: 0, // Not applicable
-  },
-  [Engine.CockroachDB]: {
-    defaultVersion: '25',
-    defaultPort: 26257, // CockroachDB default SQL port (HTTP UI at port + 1)
-    portRange: { start: 26257, end: 26357 },
-    latestVersion: '25',
-    superuser: 'root', // Default user in insecure mode
-    connectionScheme: 'postgresql', // Uses PostgreSQL wire protocol
-    logFileName: 'cockroach.log',
-    pidFileName: 'cockroach.pid',
-    dataSubdir: 'data',
-    clientTools: ['cockroach'],
-    maxConnections: 0, // Not applicable - managed internally
-  },
-  [Engine.SurrealDB]: {
-    defaultVersion: '2',
-    defaultPort: 8000, // SurrealDB default HTTP/WS port
-    portRange: { start: 8000, end: 8100 },
-    latestVersion: '2',
-    superuser: 'root', // Default user with password 'root'
-    connectionScheme: 'ws', // WebSocket for real-time connections
-    logFileName: 'surrealdb.log',
-    pidFileName: 'surrealdb.pid',
-    dataSubdir: 'data',
-    clientTools: ['surreal'],
-    maxConnections: 0, // Not applicable - managed internally
-  },
-  [Engine.QuestDB]: {
-    defaultVersion: '9',
-    defaultPort: 8812, // QuestDB PostgreSQL wire protocol port
-    portRange: { start: 8812, end: 8912 },
-    latestVersion: '9',
-    superuser: 'admin', // Default user with password 'quest'
-    connectionScheme: 'postgresql', // Uses PostgreSQL wire protocol
-    logFileName: 'questdb.log',
-    pidFileName: 'questdb.pid',
-    dataSubdir: 'db',
-    clientTools: ['questdb'],
-    maxConnections: 0, // Not applicable - managed internally
-  },
-  [Engine.TypeDB]: {
-    defaultVersion: '3',
-    defaultPort: 1729, // TypeDB main port (gRPC protocol)
-    portRange: { start: 1729, end: 1829 },
-    latestVersion: '3',
-    superuser: 'admin', // Default admin user (password: 'password')
-    connectionScheme: 'typedb', // TypeDB proprietary protocol
-    logFileName: 'typedb.log',
-    pidFileName: 'typedb.pid',
-    dataSubdir: 'data',
-    clientTools: ['typedb', 'typedb_console_bin'],
-    maxConnections: 0, // Not applicable - managed internally
-  },
-  [Engine.InfluxDB]: {
-    defaultVersion: '3',
-    defaultPort: 8086, // InfluxDB HTTP API port
-    portRange: { start: 8086, end: 8186 },
-    latestVersion: '3',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'http',
-    logFileName: 'influxdb.log',
-    pidFileName: 'influxdb.pid',
-    dataSubdir: 'data',
-    clientTools: [], // InfluxDB uses REST API, no separate CLI tools
-    maxConnections: 0, // Not applicable for time-series DB
-  },
-  [Engine.Weaviate]: {
-    defaultVersion: '1',
-    defaultPort: 8080, // Weaviate HTTP REST API port (gRPC is port + 1)
-    portRange: { start: 8080, end: 8180 },
-    latestVersion: '1',
-    superuser: '', // No auth by default for local dev
-    connectionScheme: 'http',
-    logFileName: 'weaviate.log',
-    pidFileName: 'weaviate.pid',
-    dataSubdir: 'data',
-    clientTools: [], // Weaviate uses REST/GraphQL API, no separate CLI tools
-    maxConnections: 0, // Not applicable for vector DB
-  },
-  [Engine.TigerBeetle]: {
-    defaultVersion: '0.16',
-    defaultPort: 3000,
-    portRange: { start: 3000, end: 3100 },
-    latestVersion: '0.16',
-    superuser: '', // No auth
-    connectionScheme: '', // Custom binary protocol, no URI scheme
-    logFileName: 'tigerbeetle.log',
-    pidFileName: 'tigerbeetle.pid',
-    dataSubdir: 'data',
-    clientTools: ['tigerbeetle'], // Single binary serves as both server and REPL
-    maxConnections: 0, // Not applicable
-  },
-}
-
-/**
- * Type guard to check if a string is a valid Engine
- */
-function isValidEngine(value: string): value is Engine {
-  return value in engineDefaults
-}
-
-/**
- * Get engine defaults by name
- * @param engine Engine (e.g., Engine.PostgreSQL or 'postgresql')
- * @throws Error if engine is not found
- */
-export function getEngineDefaults(engine: Engine | string): EngineDefaults {
-  const normalized = engine.toLowerCase()
-  if (!isValidEngine(normalized)) {
-    const available = Object.keys(engineDefaults).join(', ')
-    throw new Error(
-      `Unknown engine "${engine}". Available engines: ${available}`,
-    )
-  }
-  return engineDefaults[normalized]
-}
-
-// Check if an engine is supported
-export function isEngineSupported(engine: Engine | string): boolean {
-  return isValidEngine(engine.toLowerCase())
-}
-
-// Get list of all supported engine names
-export function getSupportedEngines(): Engine[] {
-  return [...ALL_ENGINES]
-}
-
-/**
- * Get Homebrew package name for PostgreSQL client tools
- * Returns 'postgresql@18' format for versioned installs
- */
-export function getPostgresHomebrewPackage(): string {
-  const version = engineDefaults[Engine.PostgreSQL].latestVersion
-  return `postgresql@${version}`
-}

package/config/engines-registry.ts

@@ -1,150 +0,0 @@
-import { readFile } from 'fs/promises'
-import { fileURLToPath } from 'url'
-import { dirname, join } from 'path'
-import { type Engine, ALL_ENGINES } from '../types'
-
-export type EngineConfig = {
-  displayName: string
-  icon: string
-  status: 'integrated' | 'pending' | 'planned'
-  binarySource: 'hostdb' | 'system' | 'edb'
-  supportedVersions: string[]
-  defaultVersion: string
-  defaultPort: number | null
-  runtime: 'server' | 'embedded'
-  queryLanguage: string
-  scriptFileLabel: string | null
-  connectionScheme: string
-  superuser: string | null
-  clientTools: string[]
-  licensing?: string | string[]
-  notes?: string
-  platforms?: string[]
-  versionPlatforms?: Record<string, string[]>
-}
-
-export type EnginesJson = {
-  $schema?: string
-  engines: Record<Engine, EngineConfig>
-}
-
-// Cache for loaded engines config
-let cachedEngines: EnginesJson | null = null
-
-// Get directory of this file for relative path resolution
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = dirname(__filename)
-
-export async function loadEnginesJson(): Promise<EnginesJson> {
-  if (cachedEngines) return cachedEngines
-
-  const jsonPath = join(__dirname, 'engines.json')
-
-  let content: string
-  try {
-    content = await readFile(jsonPath, 'utf-8')
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error)
-    throw new Error(`Failed to read engines.json at ${jsonPath}: ${message}`)
-  }
-
-  let parsed: EnginesJson
-  try {
-    parsed = JSON.parse(content) as EnginesJson
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error)
-    throw new Error(`Failed to parse engines.json at ${jsonPath}: ${message}`)
-  }
-
-  // Structural validation: ensure parsed has expected shape
-  if (!parsed || typeof parsed !== 'object') {
-    throw new Error(
-      `engines.json at ${jsonPath} has invalid structure: expected object`,
-    )
-  }
-  if (!parsed.engines || typeof parsed.engines !== 'object') {
-    throw new Error(
-      `engines.json at ${jsonPath} has invalid structure: missing or invalid 'engines' field`,
-    )
-  }
-
-  // Runtime validation: ensure all engines are present
-  for (const engine of ALL_ENGINES) {
-    if (!(engine in parsed.engines)) {
-      throw new Error(
-        `engines.json is missing engine: ${engine}. ` +
-          `All engines from the Engine enum must be present.`,
-      )
-    }
-  }
-
-  cachedEngines = parsed
-  return cachedEngines
-}
-
-export async function getEngineConfig(engine: Engine): Promise<EngineConfig> {
-  const data = await loadEnginesJson()
-  return data.engines[engine]
-}
-
-export function getAllEngines(): Engine[] {
-  return [...ALL_ENGINES]
-}
-
-export function clearEnginesCache(): void {
-  cachedEngines = null
-}
-
-/**
- * Filter engines data to only include engines and versions supported on the given platform.
- *
- * - If an engine has `platforms` and the platformKey isn't listed, the engine is removed.
- * - If an engine has `versionPlatforms`, versions whose entry excludes the platformKey are removed.
- *   Versions with no entry in `versionPlatforms` are kept (assumed all-platform).
- * - If filtering removes all versions, the engine is removed.
- * - If the defaultVersion is removed, it's set to the first remaining version.
- */
-export function filterEnginesByPlatform(
-  enginesData: EnginesJson,
-  platformKey: string,
-): EnginesJson {
-  const filtered: Record<string, EngineConfig> = {}
-
-  for (const [name, config] of Object.entries(enginesData.engines)) {
-    // Engine-level platform check
-    if (config.platforms && !config.platforms.includes(platformKey)) {
-      continue
-    }
-
-    // Version-level platform check
-    if (config.versionPlatforms) {
-      const filteredVersions = config.supportedVersions.filter((version) => {
-        const platforms = config.versionPlatforms![version]
-        // If no entry for this version, it's available on all platforms
-        if (!platforms) return true
-        return platforms.includes(platformKey)
-      })
-
-      if (filteredVersions.length === 0) {
-        continue
-      }
-
-      const defaultVersion = filteredVersions.includes(config.defaultVersion)
-        ? config.defaultVersion
-        : filteredVersions[0]
-
-      filtered[name] = {
-        ...config,
-        supportedVersions: filteredVersions,
-        defaultVersion,
-      }
-    } else {
-      filtered[name] = config
-    }
-  }
-
-  return {
-    ...enginesData,
-    engines: filtered as Record<Engine, EngineConfig>,
-  }
-}

package/config/engines.schema.json

@@ -1,135 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "SpinDB Engines Configuration",
-  "type": "object",
-  "required": ["engines"],
-  "properties": {
-    "$schema": {
-      "type": "string"
-    },
-    "engines": {
-      "type": "object",
-      "additionalProperties": {
-        "$ref": "#/definitions/engine"
-      }
-    }
-  },
-  "definitions": {
-    "engine": {
-      "type": "object",
-      "required": [
-        "displayName",
-        "icon",
-        "status",
-        "binarySource",
-        "supportedVersions",
-        "defaultVersion",
-        "defaultPort",
-        "runtime",
-        "queryLanguage",
-        "scriptFileLabel",
-        "connectionScheme",
-        "superuser",
-        "clientTools"
-      ],
-      "properties": {
-        "displayName": {
-          "type": "string",
-          "description": "Human-readable name for the engine"
-        },
-        "icon": {
-          "type": "string",
-          "description": "Emoji icon for the engine"
-        },
-        "status": {
-          "type": "string",
-          "enum": ["integrated", "pending", "planned"],
-          "description": "Integration status of the engine"
-        },
-        "binarySource": {
-          "type": "string",
-          "enum": ["hostdb", "system", "edb"],
-          "description": "Source for engine binaries"
-        },
-        "supportedVersions": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "List of supported major versions"
-        },
-        "defaultVersion": {
-          "type": "string",
-          "description": "Default version to use when not specified"
-        },
-        "defaultPort": {
-          "type": ["integer", "null"],
-          "description": "Default port number (null for embedded databases)"
-        },
-        "runtime": {
-          "type": "string",
-          "enum": ["server", "embedded"],
-          "description": "Whether the engine runs as a server or embedded"
-        },
-        "queryLanguage": {
-          "type": "string",
-          "enum": ["sql", "javascript", "redis", "rest", "surrealql", "typeql"],
-          "description": "Query language used by the engine"
-        },
-        "scriptFileLabel": {
-          "type": ["string", "null"],
-          "description": "Menu label for running script files (e.g., 'Run SQL file', 'Run TypeQL file'). Null for REST API engines that don't support script files."
-        },
-        "connectionScheme": {
-          "type": "string",
-          "description": "URI scheme for connection strings"
-        },
-        "superuser": {
-          "type": ["string", "null"],
-          "description": "Default superuser name (null if none)"
-        },
-        "clientTools": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "List of client tools bundled with the engine"
-        },
-        "licensing": {
-          "oneOf": [
-            {
-              "type": "string",
-              "description": "Single license identifier"
-            },
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "description": "Multiple license options"
-            }
-          ],
-          "description": "License type(s) for the engine"
-        },
-        "notes": {
-          "type": "string",
-          "description": "Additional notes about the engine"
-        },
-        "platforms": {
-          "type": "array",
-          "items": { "type": "string" },
-          "description": "Supported platform-arch combos (e.g. 'darwin-arm64'). If omitted, all platforms are supported."
-        },
-        "versionPlatforms": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "array",
-            "items": { "type": "string" }
-          },
-          "description": "Per-version platform overrides. Keys are version strings, values are platform-arch arrays."
-        }
-      },
-      "additionalProperties": false
-    }
-  }
-}