@yejiming/dsh-data-agent 0.0.6 → 0.0.10

package/lib/defaults-DP4RyRh1.js

@@ -0,0 +1,21 @@
+//#region src/defaults.ts
+/**
+* Package-wide defaults shared by the server half (`src/index.ts`) and the
+* database tool half (`src/tool.ts`). Loader schemas carry these as their
+* defaults so a deployment may override every one of them in cordis.yml.
+* @module @yejiming/dsh-data-agent/defaults
+*/
+/** Preset directory name installed into `$DSH_HOME/.agent-presets/`. */
+const DEFAULT_PRESET_ID = "data-agent";
+/** End-to-end deadline for one `/connect` connectivity check, milliseconds. */
+const DEFAULT_CONNECT_TIMEOUT_MS = 1e4;
+/** End-to-end deadline for one database-tool query, milliseconds. */
+const DEFAULT_QUERY_TIMEOUT_MS = 3e4;
+/** In-memory cap on database-tool captured output (stdout and stderr each). */
+const DEFAULT_MAX_RESULT_CHARS = 2e4;
+/** Cap on one /query SQL text length (abuse guard; the wire body stays small). */
+const DEFAULT_MAX_QUERY_CHARS = 65536;
+/** Grace period for the subprocess terminate escalation. */
+const DEFAULT_GRACE_MS = 5e3;
+//#endregion
+export { DEFAULT_PRESET_ID as a, DEFAULT_MAX_RESULT_CHARS as i, DEFAULT_GRACE_MS as n, DEFAULT_QUERY_TIMEOUT_MS as o, DEFAULT_MAX_QUERY_CHARS as r, DEFAULT_CONNECT_TIMEOUT_MS as t };

package/lib/index.js

@@ -1,67 +1,143 @@
-import { a as DEFAULT_PRESET_ID, d as clientsSchema, i as DEFAULT_MAX_RESULT_CHARS, o as DEFAULT_QUERY_TIMEOUT_MS, t as DEFAULT_CONNECT_TIMEOUT_MS } from "./defaults-Bac6QvNt.js";
-import { access, cp, mkdir } from "node:fs/promises";
+import { o as clientsSchema, t as createConnectionService } from "./connections-WmjuUrDj.js";
+import { a as DEFAULT_PRESET_ID, i as DEFAULT_MAX_RESULT_CHARS, o as DEFAULT_QUERY_TIMEOUT_MS, r as DEFAULT_MAX_QUERY_CHARS, t as DEFAULT_CONNECT_TIMEOUT_MS } from "./defaults-DP4RyRh1.js";
+import { r as apply$1 } from "./command-LFgLb6el.js";
+import { n as apply$2 } from "./tool-Dka6RyEp.js";
+import { createHash } from "node:crypto";
+import { access, cp, mkdir, readFile, writeFile } from "node:fs/promises";
 import { homedir } from "node:os";
 import { join, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
+import Storage from "@deepseek-ai/dsh-storage";
+import * as storageDomainPlugin from "@deepseek-ai/dsh-storage-domain";
+import { defineDomain, domainTable } from "@deepseek-ai/dsh-storage-domain";
+import * as storageJsonPlugin from "@deepseek-ai/dsh-storage-json";
 import z from "schemastery";
-/** Build the password-stripped copy of one connection. */
-function summarize(connection) {
-	const summary = {
-		type: connection.type,
-		database: connection.database
-	};
-	if (connection.host !== void 0) summary.host = connection.host;
-	if (connection.port !== void 0) summary.port = connection.port;
-	if (connection.user !== void 0) summary.user = connection.user;
-	if (connection.readonly !== void 0) summary.readonly = connection.readonly;
-	if (connection.tables !== void 0) summary.tables = [...connection.tables];
-	return summary;
-}
-/** Create a fresh connection store (per-process singleton, one per plugin instance). */
-function createConnectionStore() {
-	const connections = /* @__PURE__ */ new Map();
-	/** Exact entry first; the wildcard (`'*'`) entry is the fallback. */
-	const exactOrWildcard = (sessionId) => connections.get(sessionId) ?? connections.get("*");
+import { z as z$1 } from "zod";
+//#region src/storage.ts
+/**
+* Durable, non-secret connection profiles, session bindings, and form drafts.
+*
+* The domain intentionally excludes passwords, resolved credentials, SQL,
+* table metadata, and client output. Form drafts likewise accept no secret
+* fields. Runtime secrets stay in
+* {@link DataAgentConnectionService}; durable records only retain enough
+* information to rebuild a connection description in another DSH surface.
+* @module @yejiming/dsh-data-agent/storage
+*/
+/** Storage-domain identity. Bump the version only with an explicit migration. */
+const CONNECTION_STORAGE_DOMAIN = "data_agent_connections";
+/** Durable profile schema. There is deliberately no `password` field. */
+const persistedConnectionProfileSchema = z$1.object({
+	name: z$1.string().min(1).optional(),
+	type: z$1.enum([
+		"mysql",
+		"postgres",
+		"sqlite",
+		"oracle",
+		"hive",
+		"impala"
+	]),
+	host: z$1.string().optional(),
+	port: z$1.number().int().min(1).max(65535).optional(),
+	user: z$1.string().optional(),
+	database: z$1.string().min(1),
+	readonly: z$1.boolean().optional(),
+	passwordRef: z$1.string().regex(/^[A-Za-z_][A-Za-z0-9_]*$/).optional(),
+	updatedAt: z$1.string().min(1)
+}).strict();
+/** Durable session-to-profile binding schema. */
+const sessionConnectionBindingSchema = z$1.object({
+	profileId: z$1.string().min(1),
+	updatedAt: z$1.string().min(1)
+}).strict();
+/** Session form draft schema. Secret-shaped fields are rejected by strict mode. */
+const persistedConnectionFormDraftSchema = z$1.object({
+	type: z$1.enum([
+		"mysql",
+		"postgres",
+		"sqlite",
+		"oracle",
+		"hive",
+		"impala"
+	]),
+	host: z$1.string(),
+	port: z$1.string(),
+	user: z$1.string(),
+	database: z$1.string(),
+	readonly: z$1.boolean(),
+	updatedAt: z$1.string().min(1)
+}).strict();
+/** Single source of truth for the storage layout and durable validation. */
+const connectionStorageSpec = defineDomain({
+	name: CONNECTION_STORAGE_DOMAIN,
+	version: 1,
+	tables: {
+		profiles: domainTable(persistedConnectionProfileSchema),
+		bindings: domainTable(sessionConnectionBindingSchema),
+		drafts: domainTable(persistedConnectionFormDraftSchema)
+	}
+});
+/** Project a typed DSH domain handle onto the service's persistence seam. */
+function createDomainConnectionPersistence(domain) {
+	const profiles = domain.table("profiles");
+	const bindings = domain.table("bindings");
+	const drafts = domain.table("drafts");
 	return {
-		set(sessionId, connection) {
-			connections.set(sessionId, connection);
+		getProfile(profileId) {
+			return profiles.get(profileId);
+		},
+		putProfile(profileId, profile) {
+			return profiles.put(profileId, profile);
+		},
+		deleteProfile(profileId) {
+			return profiles.delete(profileId);
 		},
-		get(sessionId) {
-			const connection = exactOrWildcard(sessionId);
-			return connection === void 0 ? void 0 : summarize(connection);
+		getBinding(sessionId) {
+			return bindings.get(sessionId);
 		},
-		getWithSecret(sessionId) {
-			return exactOrWildcard(sessionId);
+		putBinding(sessionId, binding) {
+			return bindings.put(sessionId, binding);
 		},
-		has(sessionId) {
-			return exactOrWildcard(sessionId) !== void 0;
+		deleteBinding(sessionId) {
+			return bindings.delete(sessionId);
 		},
-		clear(sessionId) {
-			connections.delete(sessionId);
+		getDraft(sessionId) {
+			return drafts.get(sessionId);
+		},
+		putDraft(sessionId, draft) {
+			return drafts.put(sessionId, draft);
 		}
 	};
 }
 //#endregion
 //#region src/index.ts
 /**
-* Data Agent server half for the dsh web GUI. The host row provides the
-* `dataAgentConnections` service (session-scoped in-memory store; passwords
-* never leave memory), seeds config connections (`connections`, `'*'` =
-* wildcard default), and installs the `data-agent` agent preset into
-* `$DSH_HOME/.agent-presets/` (idempotent, never overwrites a user-edited
-* directory).
+* Data Agent profile entry. The host row provides the
+* `dataAgentConnections` service (shared non-secret profile/binding storage;
+* temporary passwords stay process-local), seeds config connections (`connections`, `'*'` =
+* wildcard default), installs the `data-agent` agent preset into
+* `$DSH_HOME/.agent-presets/`, and preloads the preset-scoped database tools
+* and command through this profile bundle entry.
 *
 * The HTTP routes live in the separate `./routes` entry
 * (`@yejiming/dsh-data-agent/routes`, cordis row `data-agent-routes`) so
-* this row keeps working in headless profiles without a webserver; the
-* database tools themselves live in the `./tool` entry and are mounted only
-* by the data-agent preset.
+* this row keeps working in headless profiles without a webserver. The
+* database implementations still have public `./tool` and `./command`
+* exports, but the shipped preset does not dynamically import those package
+* subpaths. Loading them here keeps Desktop on the same profile-startup path
+* as other UI bundles and avoids Electron ASAR package-resolution drift.
 * @module @yejiming/dsh-data-agent
 */
 /** Cordis plugin name (diagnostics only). */
 const name = "data-agent";
-/** Services required before the store can serve. */
-const inject = ["subprocess"];
+/** Services required before the profile entry can mount its preset layer. */
+const inject = [
+	"agentPresets",
+	"commands",
+	"credentials",
+	"subprocess",
+	"tools"
+];
 /** Loader schema with deployment defaults (no library defaults). */
 const Config = z.object({
 	presetId: z.string().default(DEFAULT_PRESET_ID),
@@ -70,7 +146,10 @@ const Config = z.object({
 	introspectMaxTables: z.number().step(1).min(1).default(500),
 	queryTimeoutMs: z.number().step(1).min(1e3).default(DEFAULT_QUERY_TIMEOUT_MS),
 	maxResultChars: z.number().step(1).min(1024).default(DEFAULT_MAX_RESULT_CHARS),
+	maxRows: z.number().step(1).min(1).default(100),
+	maxQueryChars: z.number().step(1).min(1024).default(DEFAULT_MAX_QUERY_CHARS),
 	readonly: z.boolean().default(false),
+	persistConnections: z.boolean().default(true),
 	clients: clientsSchema,
 	connections: z.dict(z.object({
 		type: z.union([
@@ -85,7 +164,9 @@ const Config = z.object({
 		port: z.natural(),
 		user: z.string(),
 		database: z.string(),
-		readonly: z.boolean()
+		readonly: z.boolean(),
+		passwordRef: z.string().pattern(/^[A-Za-z_][A-Za-z0-9_]*$/),
+		password: z.never().hidden()
 	})).default({})
 });
 /**
@@ -99,35 +180,95 @@ function resolveDshHome(env = process.env) {
 }
 /**
 * Install the packaged `preset/data-agent/` directory into
-* `$DSH_HOME/.agent-presets/<presetId>/`. Idempotent: an existing target
-* directory is left untouched (user edits survive); `installPreset: false`
-* never calls this. Best-effort — a failure logs a warning with manual
-* install instructions instead of failing the boot.
+* `$DSH_HOME/.agent-presets/<presetId>/`. Idempotent: an existing target is
+* normally left untouched. The exact package-owned 0.0.9 composition is
+* migrated once because its two dynamic package rows are incompatible with
+* DSH Desktop's unpacked-ASAR loader; user-edited compositions are never
+* overwritten. `installPreset: false` never calls this. Best-effort — a
+* failure logs a warning with manual install instructions instead of failing
+* the boot.
 */
 async function installPreset(ctx, presetId) {
 	const targetDir = join(resolveDshHome(), ".agent-presets", presetId);
+	const sourceDir = fileURLToPath(new URL("../preset/data-agent/", import.meta.url));
 	try {
 		await access(targetDir);
-		ctx.logger.info("data-agent: preset \"%s\" already present at %s, skipping install", presetId, targetDir);
-		return;
+		return await synchronizeExistingPreset(ctx, targetDir, sourceDir, presetId);
 	} catch {}
-	const sourceDir = fileURLToPath(new URL("../preset/data-agent/", import.meta.url));
 	try {
 		await mkdir(targetDir, { recursive: true });
 		await cp(sourceDir, targetDir, { recursive: true });
 		ctx.logger.info("data-agent: installed preset \"%s\" to %s", presetId, targetDir);
+		return true;
 	} catch (error) {
 		ctx.logger.warn("data-agent: failed to install preset \"%s\" to %s (%s); copy preset/data-agent/ manually to enable the 数据模式 preset", presetId, targetDir, error instanceof Error ? error.message : String(error));
+		return false;
 	}
 }
+/** SHA-256 of the unmodified 0.0.9 composition that imported /tool and /command dynamically. */
+const LEGACY_PRESET_0_0_9_SHA256 = "bae875a90d638ea78715030246b0f8a9f1a2c3359ca61febb6ceb59d0fcd930a";
+/** Public for regression tests of the non-destructive preset migration gate. */
+function isLegacyManagedPreset(source) {
+	return createHash("sha256").update(source).digest("hex") === LEGACY_PRESET_0_0_9_SHA256;
+}
+/** Upgrade only the exact package-owned legacy composition; preserve every edited preset. */
+async function synchronizeExistingPreset(ctx, targetDir, sourceDir, presetId) {
+	const composition = join(targetDir, "agent.cordis.yml");
+	try {
+		const current = await readFile(composition, "utf8");
+		if (isLegacyManagedPreset(current)) {
+			const replacement = await readFile(join(sourceDir, "agent.cordis.yml"), "utf8");
+			await writeFile(composition, replacement, "utf8");
+			ctx.logger.info("data-agent: migrated preset at %s to profile-preloaded tools (removed dynamic /tool and /command rows)", composition);
+			return true;
+		}
+		if (current.includes("@yejiming/dsh-data-agent/tool") || current.includes("@yejiming/dsh-data-agent/command")) {
+			ctx.logger.warn("data-agent: user-edited preset at %s still imports /tool or /command dynamically; remove those rows so the profile-preloaded preset capabilities can activate in DSH Desktop", composition);
+			return false;
+		}
+		ctx.logger.info("data-agent: preset \"%s\" already present at %s, skipping install", presetId, targetDir);
+		return true;
+	} catch (error) {
+		ctx.logger.warn("data-agent: could not inspect existing preset %s (%s); it was not overwritten", composition, error instanceof Error ? error.message : String(error));
+		return false;
+	}
+}
+/** Exact profile-local package installation command used by diagnostics/docs. */
+function profileInstallCommand(profile) {
+	return `dsh plugin --profile ${profile} add @yejiming/dsh-data-agent`;
+}
+/** Actionable diagnostic for a roster-visible preset whose profile lacks this package. */
+function missingProfileDependencyMessage(profile) {
+	return `data-agent preset is visible, but its profile-preloaded capabilities are absent from profile "${profile}". Run: ${profileInstallCommand(profile)}`;
+}
+/**
+* Register the statically imported database tools and command under the exact
+* standing key owned by the data-agent preset. Selecting the preset performs
+* no package import and only links the agent scope to this key.
+*/
+async function mountPresetCapabilities(ctx, key, scopeTag, config) {
+	const scoped = ctx.extend({ [scopeTag]: key });
+	apply$2(scoped, config);
+	apply$1(scoped);
+}
+/** Read the host-owned scope tag from AgentPresets' already-created standing mount. */
+async function standingScopeTag(ctx, presetId, key) {
+	const pending = ctx.agentPresets.standing?.get(presetId);
+	if (pending === void 0) throw new Error(`data-agent: preset "${presetId}" has no standing scope after standingKeyFor()`);
+	const standing = await pending;
+	if (standing.key !== key) throw new Error(`data-agent: preset "${presetId}" standing scope changed during profile preload`);
+	const tag = Object.getOwnPropertySymbols(standing.scope.ctx).find((candidate) => Reflect.get(standing.scope.ctx, candidate) === key);
+	if (tag === void 0) throw new Error(`data-agent: preset "${presetId}" standing context exposes no scope tag`);
+	return tag;
+}
 /**
-* Mount the data-agent host row: connection store, config-seeded
-* connections, and preset self-install. HTTP routes are the sibling
-* `data-agent-routes` row (`./routes`).
+* Mount the data-agent profile row: connection store, config-seeded
+* connections, preset installation, and profile-preloaded preset capabilities.
+* HTTP routes are the sibling `data-agent-routes` row (`./routes`).
 * @param ctx - host cordis context.
 * @param config - validated loader configuration.
 */
-function apply(ctx, config) {
+async function apply(ctx, config) {
 	const resolved = {
 		presetId: config.presetId,
 		installPreset: config.installPreset,
@@ -135,24 +276,80 @@ function apply(ctx, config) {
 		introspectMaxTables: config.introspectMaxTables,
 		queryTimeoutMs: config.queryTimeoutMs,
 		maxResultChars: config.maxResultChars,
+		maxRows: config.maxRows,
+		maxQueryChars: config.maxQueryChars,
 		readonly: config.readonly,
+		persistConnections: config.persistConnections,
 		clients: config.clients,
 		connections: config.connections
 	};
-	const store = createConnectionStore();
-	ctx.provide("dataAgentConnections", store);
-	for (const [sessionId, spec] of Object.entries(config.connections)) {
-		const connection = {
-			type: spec.type,
-			database: spec.type === "sqlite" ? resolve(process.cwd(), spec.database) : spec.database,
-			...spec.host !== void 0 ? { host: spec.host } : {},
-			...spec.port !== void 0 ? { port: spec.port } : {},
-			...spec.user !== void 0 ? { user: spec.user } : {},
-			...spec.readonly !== void 0 ? { readonly: spec.readonly } : {}
-		};
-		store.set(sessionId, connection);
+	const mountService = (scope, persistence) => {
+		const store = createConnectionService(scope, {
+			connectTimeoutMs: resolved.connectTimeoutMs,
+			queryTimeoutMs: resolved.queryTimeoutMs,
+			maxResultChars: resolved.maxResultChars,
+			maxQueryChars: resolved.maxQueryChars,
+			introspectMaxTables: resolved.introspectMaxTables,
+			readonly: resolved.readonly,
+			clients: resolved.clients
+		}, persistence);
+		scope.provide("dataAgentConnections", store);
+		for (const [sessionId, spec] of Object.entries(resolved.connections)) {
+			const connection = {
+				type: spec.type,
+				database: spec.type === "sqlite" ? resolve(process.cwd(), spec.database) : spec.database,
+				...spec.host !== void 0 ? { host: spec.host } : {},
+				...spec.port !== void 0 ? { port: spec.port } : {},
+				...spec.user !== void 0 ? { user: spec.user } : {},
+				...spec.passwordRef !== void 0 ? { passwordRef: spec.passwordRef } : {},
+				...spec.readonly !== void 0 ? { readonly: spec.readonly } : {}
+			};
+			store.set(sessionId, connection);
+		}
+	};
+	const presetReady = resolved.installPreset ? await installPreset(ctx, resolved.presetId) : false;
+	if (resolved.persistConnections) {
+		const domain = await (await ensureStorageDomain(ctx)).open(connectionStorageSpec);
+		ctx.effect(() => () => domain.close(), "data-agent: close connection storage domain");
+		mountService(ctx, createDomainConnectionPersistence(domain));
+	} else {
+		ctx.logger.warn("data-agent: persistConnections=false; connection state is process-local and cannot restore across Web/TUI");
+		mountService(ctx);
+	}
+	if (presetReady) {
+		const standingKey = await ctx.agentPresets.standingKeyFor(resolved.presetId);
+		await mountPresetCapabilities(ctx, standingKey, await standingScopeTag(ctx, resolved.presetId, standingKey), {
+			queryTimeoutMs: resolved.queryTimeoutMs,
+			maxResultChars: resolved.maxResultChars,
+			maxRows: resolved.maxRows,
+			maxQueryChars: resolved.maxQueryChars,
+			readonly: resolved.readonly,
+			clients: resolved.clients
+		});
+	}
+}
+/**
+* Reuse a surface-provided storage stack (Web) or mount the same JSON stack
+* when an interactive profile such as dsh-tui does not ship one.
+*/
+async function ensureStorageDomain(ctx) {
+	const existing = ctx.get("storageDomain");
+	if (existing !== void 0) return existing;
+	ctx.logger.info("data-agent: storageDomain is absent; mounting the JSON storage stack for this profile");
+	let storage = ctx.get("storage");
+	if (storage === void 0) {
+		await ctx.plugin(Storage);
+		storage = ctx.get("storage");
+	}
+	if (storage === void 0) throw new Error("data-agent: failed to mount DSH storage hub");
+	if (!storage.backend.names().includes("json")) await ctx.plugin(storageJsonPlugin, { root: join(resolveDshHome(), "storages") });
+	let facility = ctx.get("storageDomain");
+	if (facility === void 0) {
+		await ctx.plugin(storageDomainPlugin, { backend: "json" });
+		facility = ctx.get("storageDomain");
 	}
-	if (resolved.installPreset) installPreset(ctx, resolved.presetId);
+	if (facility === void 0) throw new Error("data-agent: failed to mount DSH storage-domain facility");
+	return facility;
 }
 //#endregion
-export { Config, apply, inject, installPreset, name, resolveDshHome };
+export { Config, apply, inject, installPreset, isLegacyManagedPreset, missingProfileDependencyMessage, mountPresetCapabilities, name, profileInstallCommand, resolveDshHome };