dsh-db-studio 0.0.0-stage → 1.0.2

package/lib/store.js

@@ -0,0 +1,203 @@
+/**
+ * Connection store for dsh-db-studio.
+ *
+ * Connections live in `<home>/dsh-db-studio/connections.json` (mode 0600,
+ * directory 0700). The browser never receives a password: `publicConnection()`
+ * strips it and reports `hasPassword` instead. Passwords are stored in the
+ * local file because a database client has to be able to reconnect without
+ * the user retyping them; the file permissions are the boundary, and the
+ * README says so plainly.
+ *
+ * @module dsh-db-studio/store
+ */
+
+import { randomUUID } from 'node:crypto'
+import { chmod, mkdir, readFile, rename, rm, writeFile } from 'node:fs/promises'
+import { join } from 'node:path'
+import { absolutePath, studioHome } from './home.js'
+
+const FILE_MODE = 0o600
+const DIR_MODE = 0o700
+
+/** Connection kinds this plugin knows how to open. */
+export const CONNECTION_KINDS = ['sqlite', 'postgres', 'mysql']
+
+/** Default TCP ports per kind. */
+const DEFAULT_PORTS = { postgres: 5432, mysql: 3306 }
+
+/** Trimmed string or undefined. */
+function text(value) {
+  return typeof value === 'string' && value.trim() ? value.trim() : undefined
+}
+
+/** A boolean with a default. */
+function bool(value, fallback) {
+  return typeof value === 'boolean' ? value : fallback
+}
+
+/** A port number, or the kind's default. */
+function portOf(value, kind) {
+  const n = typeof value === 'number' ? value : Number.parseInt(String(value ?? ''), 10)
+  return Number.isInteger(n) && n > 0 && n < 65536 ? n : DEFAULT_PORTS[kind]
+}
+
+/**
+ * Validate and normalize one connection.
+ *
+ * Throws a plain Error with a user-facing Chinese/English message when the
+ * shape cannot be stored. `existing` supplies the fields an update may omit
+ * (notably the password).
+ */
+export function normalizeConnection(input, existing = null) {
+  if (!input || typeof input !== 'object' || Array.isArray(input)) {
+    throw new Error('连接配置格式不正确 / invalid connection object')
+  }
+  const kind = text(input.kind) ?? existing?.kind
+  if (!CONNECTION_KINDS.includes(kind)) {
+    throw new Error('连接类型必须是 sqlite、postgres 或 mysql / kind must be sqlite, postgres or mysql')
+  }
+  const now = new Date().toISOString()
+  const out = {
+    id: existing?.id ?? text(input.id) ?? randomUUID(),
+    name: text(input.name) ?? existing?.name ?? (kind === 'sqlite' ? 'SQLite 数据库' : kind === 'postgres' ? 'PostgreSQL' : 'MySQL'),
+    kind,
+    readOnly: bool(input.readOnly, existing?.readOnly ?? false),
+    createdAt: existing?.createdAt ?? now,
+    updatedAt: now,
+  }
+  if (typeof input.demo === 'boolean') out.demo = input.demo
+  else if (existing?.demo !== undefined) out.demo = existing.demo
+
+  if (kind === 'sqlite') {
+    const file = text(input.file) ?? existing?.file
+    if (!file) throw new Error('SQLite 连接需要文件路径 / a SQLite connection needs a file path')
+    out.file = absolutePath(file)
+    // SQLite credentials do not exist; keep the rest of the object clean.
+    return out
+  }
+
+  out.host = text(input.host) ?? existing?.host ?? '127.0.0.1'
+  out.port = portOf(input.port ?? existing?.port, kind)
+  out.database = text(input.database) ?? existing?.database
+  if (!out.database) throw new Error('请填写数据库名 / a database name is required')
+  out.user = text(input.user) ?? existing?.user ?? (kind === 'postgres' ? 'postgres' : 'root')
+  if (typeof input.ssl === 'boolean') out.ssl = input.ssl
+  else if (existing?.ssl !== undefined) out.ssl = existing.ssl
+  else out.ssl = false
+
+  if (typeof input.password === 'string' && input.password !== '') out.password = input.password
+  else if (existing?.password !== undefined) out.password = existing.password
+  if (input.clearPassword === true) delete out.password
+  return out
+}
+
+/** The browser-safe projection of a connection: no password, ever. */
+export function publicConnection(connection) {
+  if (!connection) return null
+  const { password, ...rest } = connection
+  return { ...rest, hasPassword: typeof password === 'string' && password.length > 0 }
+}
+
+/** A human-readable one-line target for a connection. */
+export function connectionTarget(connection) {
+  if (connection.kind === 'sqlite') return connection.file
+  return `${connection.user}@${connection.host}:${connection.port}/${connection.database}`
+}
+
+/** The connection file is shared by every reload of the plugin in this home. */
+export class ConnectionStore {
+  constructor(home) {
+    this.home = home
+    this.dir = studioHome(home)
+    this.file = join(this.dir, 'connections.json')
+    this.connections = []
+    this.loaded = false
+  }
+
+  /** Read from disk. A missing or malformed file becomes an empty store. */
+  async load() {
+    if (this.loaded) return this
+    this.loaded = true
+    try {
+      const raw = await readFile(this.file, 'utf8')
+      const parsed = JSON.parse(raw)
+      if (Array.isArray(parsed?.connections)) {
+        this.connections = parsed.connections.filter((row) => row && typeof row === 'object' && row.id)
+      }
+    } catch (error) {
+      if (error?.code !== 'ENOENT') {
+        console.warn('dsh-db-studio: ignoring unreadable connections file —', error?.message ?? error)
+      }
+    }
+    return this
+  }
+
+  /** Persist atomically: write a sibling then rename into place. */
+  async save() {
+    await mkdir(this.dir, { recursive: true, mode: DIR_MODE })
+    const body = JSON.stringify({ version: 1, connections: this.connections }, null, 2) + '\n'
+    const temp = `${this.file}.${process.pid}.${Date.now()}.tmp`
+    await writeFile(temp, body, { mode: FILE_MODE })
+    await rename(temp, this.file)
+    // rename preserves the temp file's mode; chmod is belt-and-braces for a
+    // pre-existing file whose mode was widened outside this plugin.
+    await chmod(this.file, FILE_MODE).catch(() => {})
+  }
+
+  /** All connections, secrets redacted, in insertion order. */
+  list() {
+    return this.connections.map(publicConnection)
+  }
+
+  /** Raw connection by id (host-side use only). */
+  get(id) {
+    return this.connections.find((row) => row.id === id) ?? null
+  }
+
+  /** The first connection, used when an agent tool omits an id. */
+  first() {
+    return this.connections[0] ?? null
+  }
+
+  /** Add a validated connection and persist it. */
+  async add(input) {
+    const connection = normalizeConnection(input)
+    if (this.connections.some((row) => row.id === connection.id)) {
+      connection.id = randomUUID()
+    }
+    this.connections.push(connection)
+    await this.save()
+    return publicConnection(connection)
+  }
+
+  /** Patch an existing connection. `undefined` keeps a field; password is special. */
+  async update(id, patch) {
+    const index = this.connections.findIndex((row) => row.id === id)
+    if (index === -1) throw new Error('连接不存在 / connection not found')
+    const merged = normalizeConnection({ ...this.connections[index], ...patch }, this.connections[index])
+    merged.id = id
+    this.connections[index] = merged
+    await this.save()
+    return publicConnection(merged)
+  }
+
+  /** Remove a connection. The demo connection is recreated by `ensureDemo`. */
+  async remove(id) {
+    const before = this.connections.length
+    this.connections = this.connections.filter((row) => row.id !== id)
+    if (this.connections.length === before) throw new Error('连接不存在 / connection not found')
+    await this.save()
+    return true
+  }
+
+  /** Replace the whole list (used by demo seeding); persists immediately. */
+  async replaceAll(connections) {
+    this.connections = connections
+    await this.save()
+  }
+
+  /** Remove the store (tests). */
+  async destroy() {
+    await rm(this.dir, { recursive: true, force: true })
+  }
+}

package/package.json

@@ -1,6 +1,71 @@
 {
   "name": "dsh-db-studio",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.2",
+  "description": "Connect to databases in DeepSeek Harness (DSH), then query and edit data right in the conversation.",
+  "type": "module",
+  "license": "MIT",
+  "keywords": [
+    "dsh",
+    "deepseek-harness",
+    "dsh-plugin",
+    "database",
+    "sqlite",
+    "postgresql",
+    "mysql",
+    "conversation",
+    "ai-agent"
+  ],
+  "main": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./client": "./lib/client.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib",
+    "docs",
+    "cordis.patch.yml",
+    "README.md",
+    "README.en.md",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">=22.13",
+    "dsh": ">=0.2.1-rc.3"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "platform": "web",
+      "inject": [
+        "@deepseek-ai/dsh-client-locale",
+        "@deepseek-ai/dsh-client-ui-layout",
+        "@deepseek-ai/dsh-client-ui-sidebar",
+        "@deepseek-ai/dsh-client-ui-commands"
+      ]
+    }
+  },
+  "dependencies": {
+    "mysql2": "^3.24.6",
+    "pg": "^8.23.1"
+  },
+  "scripts": {
+    "test": "node --test test/*.test.js",
+    "check": "node --check lib/index.js && node --check lib/service.js && node --check lib/drivers.js && node --check lib/store.js && node --check lib/home.js && node --check lib/client.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/etShaw-zh/dsh-db-studio.git"
+  },
+  "author": "Jianjun Xiao <et_shaw@126.com>",
+  "homepage": "https://github.com/etShaw-zh/dsh-db-studio#readme",
+  "bugs": {
+    "url": "https://github.com/etShaw-zh/dsh-db-studio/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}