@yejiming/dsh-data-agent 0.0.1 → 0.0.2

package/lib/routes.js

@@ -1,5 +1,5 @@
-import { d as parseColumns, f as parseListing, i as DEFAULT_MAX_RESULT_CHARS, m as tableListingSql, o as DEFAULT_QUERY_TIMEOUT_MS, p as parseTableListing, r as DEFAULT_MAX_QUERY_CHARS, t as DEFAULT_CONNECT_TIMEOUT_MS, u as metadataQuery } from "./defaults-D__D30ED.js";
-import { t as runClientQuery } from "./query-DAjhNTo8.js";
+import { d as metadataQuery, f as parseColumns, g as tableListingSql, h as sanitizeIdentifier, i as DEFAULT_MAX_RESULT_CHARS, l as classifyStatement, m as parseTableListing, o as DEFAULT_QUERY_TIMEOUT_MS, p as parseListing, r as DEFAULT_MAX_QUERY_CHARS, t as DEFAULT_CONNECT_TIMEOUT_MS } from "./defaults-Dgu2B2Yq.js";
+import { t as runClientQuery } from "./query-vK9dr7Z6.js";
 import { resolve } from "node:path";
 import z from "schemastery";
 //#region src/routes.ts
@@ -20,7 +20,8 @@ const Config = z.object({
 	introspectMaxTables: z.number().step(1).min(1).default(500),
 	maxResultChars: z.number().step(1).min(1024).default(DEFAULT_MAX_RESULT_CHARS),
 	queryTimeoutMs: z.number().step(1).min(1e3).default(DEFAULT_QUERY_TIMEOUT_MS),
-	maxQueryChars: z.number().step(1).min(1024).default(DEFAULT_MAX_QUERY_CHARS)
+	maxQueryChars: z.number().step(1).min(1024).default(DEFAULT_MAX_QUERY_CHARS),
+	readonly: z.boolean().default(false)
 });
 /**
 * Validate an untrusted /connect body; sqlite paths resolve to absolute
@@ -51,6 +52,8 @@ function validateConnectBody(value, cwd = process.cwd()) {
 	if (user !== void 0 && typeof user !== "string") throw new Error("user 必须是字符串");
 	const password = candidate.password;
 	if (password !== void 0 && typeof password !== "string") throw new Error("password 必须是字符串");
+	const readonly = candidate.readonly;
+	if (readonly !== void 0 && typeof readonly !== "boolean") throw new Error("readonly 必须是布尔值");
 	const connection = {
 		type,
 		database
@@ -59,6 +62,7 @@ function validateConnectBody(value, cwd = process.cwd()) {
 	if (port !== void 0) connection.port = port;
 	if (typeof user === "string" && user.length > 0) connection.user = user;
 	if (typeof password === "string" && password.length > 0) connection.password = password;
+	if (readonly !== void 0) connection.readonly = readonly;
 	return {
 		sessionId,
 		type,
@@ -66,15 +70,14 @@ function validateConnectBody(value, cwd = process.cwd()) {
 		...connection.host !== void 0 ? { host: connection.host } : {},
 		...connection.port !== void 0 ? { port: connection.port } : {},
 		...connection.user !== void 0 ? { user: connection.user } : {},
-		...connection.password !== void 0 ? { password: connection.password } : {}
+		...connection.password !== void 0 ? { password: connection.password } : {},
+		...connection.readonly !== void 0 ? { readonly: connection.readonly } : {}
 	};
 }
-/** Identifier whitelist for schema/table names in metadata queries. */
-const IDENTIFIER_PATTERN = /^[A-Za-z0-9_$#.-]+$/;
-/** Validate one schema/table identifier (rejects any injection-shaped input). */
-function requireIdentifier(value, label) {
+/** Validate one schema/table identifier: reuse the clients' sanitizer (validation + quoting). */
+function requireIdentifier(type, value, label) {
 	if (value === null || value.length === 0) throw new Error(`${label} 不能为空`);
-	if (!IDENTIFIER_PATTERN.test(value)) throw new Error(`${label} 含非法字符（仅允许字母、数字与 _ $ # . -）`);
+	sanitizeIdentifier(type, value);
 	return value;
 }
 /**
@@ -148,7 +151,8 @@ function apply(ctx, config) {
 								...request.host !== void 0 ? { host: request.host } : {},
 								...request.port !== void 0 ? { port: request.port } : {},
 								...request.user !== void 0 ? { user: request.user } : {},
-								...request.password !== void 0 ? { password: request.password } : {}
+								...request.password !== void 0 ? { password: request.password } : {},
+								...request.readonly !== void 0 ? { readonly: request.readonly } : {}
 							};
 							const listing = await runClientQuery(scope, connection, tableListingSql(connection.type, connection), connectOptions, new AbortController().signal, true);
 							if (listing.exitCode !== 0) {
@@ -199,7 +203,7 @@ function apply(ctx, config) {
 							const sessionId = url.searchParams.get("sessionId") ?? "";
 							if (sessionId.length === 0) throw new Error("sessionId 不能为空");
 							const connection = requireConnection(sessionId);
-							const schema = connection.type === "sqlite" ? void 0 : requireIdentifier(url.searchParams.get("schema"), "schema");
+							const schema = connection.type === "sqlite" ? void 0 : requireIdentifier(connection.type, url.searchParams.get("schema"), "schema");
 							const stdout = await runMetadata(connection, "tables", schema);
 							writeJson(200, {
 								ok: true,
@@ -211,8 +215,8 @@ function apply(ctx, config) {
 							const sessionId = url.searchParams.get("sessionId") ?? "";
 							if (sessionId.length === 0) throw new Error("sessionId 不能为空");
 							const connection = requireConnection(sessionId);
-							const schema = connection.type === "sqlite" ? void 0 : requireIdentifier(url.searchParams.get("schema"), "schema");
-							const table = requireIdentifier(url.searchParams.get("table"), "table");
+							const schema = connection.type === "sqlite" ? void 0 : requireIdentifier(connection.type, url.searchParams.get("schema"), "schema");
+							const table = requireIdentifier(connection.type, url.searchParams.get("table"), "table");
 							const stdout = await runMetadata(connection, "describe", schema, table);
 							writeJson(200, {
 								ok: true,
@@ -228,6 +232,7 @@ function apply(ctx, config) {
 							if (typeof sql !== "string" || sql.trim().length === 0) throw new Error("sql 必须是非空字符串");
 							if (sql.length > config.maxQueryChars) throw new Error(`sql 超过长度上限（${config.maxQueryChars} 字符）`);
 							const connection = requireConnection(sessionId);
+							if ((connection.readonly ?? config.readonly) && classifyStatement(sql, connection.type) === "write") throw new Error("当前连接为只读模式，拒绝执行非读语句（仅放行 SELECT/SHOW/DESCRIBE/EXPLAIN/PRAGMA 等）");
 							writeJson(200, {
 								ok: true,
 								result: await runClientQuery(scope, connection, sql, queryOptions, new AbortController().signal)

package/lib/tool.js

@@ -1,5 +1,5 @@
-import { i as DEFAULT_MAX_RESULT_CHARS, l as clientsSchema, o as DEFAULT_QUERY_TIMEOUT_MS } from "./defaults-D__D30ED.js";
-import { t as runClientQuery } from "./query-DAjhNTo8.js";
+import { i as DEFAULT_MAX_RESULT_CHARS, l as classifyStatement, o as DEFAULT_QUERY_TIMEOUT_MS, u as clientsSchema } from "./defaults-Dgu2B2Yq.js";
+import { t as runClientQuery } from "./query-vK9dr7Z6.js";
 import z from "schemastery";
 import { defineTool } from "@deepseek-ai/dsh-tools";
 //#region src/tool.ts
@@ -16,6 +16,7 @@ const Config = z.object({
 	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),
+	readonly: z.boolean().default(false),
 	clients: clientsSchema
 });
 /** One-line sqlcmd label for the terminal card (newlines collapsed). */
@@ -42,6 +43,7 @@ function apply(ctx, config) {
 		queryTimeoutMs: config.queryTimeoutMs,
 		maxResultChars: config.maxResultChars,
 		maxRows: config.maxRows,
+		readonly: config.readonly,
 		clients: config.clients
 	};
 	ctx.tools.register(defineTool({
@@ -95,6 +97,7 @@ function apply(ctx, config) {
 			if (sessionId === void 0) throw new Error("sqlcmd: 缺少会话上下文（agent loop 未注入）");
 			const connection = ctx.dataAgentConnections.getWithSecret(sessionId);
 			if (connection === void 0) throw new Error("请先在「数据库」标签页连接数据库，再使用 sqlcmd（未找到当前会话的连接）");
+			if ((connection.readonly ?? resolved.readonly) && classifyStatement(args.sql, connection.type) === "write") throw new Error("当前连接为只读模式，sqlcmd 拒绝执行非读语句（仅放行 SELECT/SHOW/DESCRIBE/EXPLAIN/PRAGMA 等）");
 			return runClientQuery(ctx, connection, args.sql, {
 				clients: resolved.clients,
 				timeoutMs: resolved.queryTimeoutMs,

package/lib/types/client/locales.d.ts

@@ -15,6 +15,10 @@ export declare const zh: {
     'form.port': string;
     'form.user': string;
     'form.password': string;
+    'form.rememberPassword': string;
+    'form.rememberPassword.hint': string;
+    'form.readonly': string;
+    'form.readonly.hint': string;
     'form.database': string;
     'form.database.oracle': string;
     'form.database.hive': string;
@@ -62,6 +66,10 @@ export declare const en: {
     'form.port': string;
     'form.user': string;
     'form.password': string;
+    'form.rememberPassword': string;
+    'form.rememberPassword.hint': string;
+    'form.readonly': string;
+    'form.readonly.hint': string;
     'form.database': string;
     'form.database.oracle': string;
     'form.database.hive': string;

package/lib/types/client/persistence.d.ts

@@ -12,14 +12,17 @@
 import type { DatabaseType } from './DataAgentWorkbench.tsx';
 /** localStorage key holding the most recent connection configuration. */
 export declare const CONNECTION_STORAGE_KEY = "dsh-data-agent.connection.v1";
-/** The persisted connection configuration (password included). */
+/** The persisted connection configuration. */
 export interface SavedConnection {
     type: DatabaseType;
     host?: string;
     port?: number;
     user?: string;
     database: string;
+    /** Present only when the user explicitly opted in to persist the password. */
     password?: string;
+    /** Opt-in flag; when true, {@link saveConnection} may write `password`. */
+    persistPassword?: boolean;
     /** Diagnostic timestamp of the save. */
     savedAt: string;
 }

package/lib/types/clients.d.ts

@@ -12,6 +12,21 @@
  * @module @yejiming/dsh-data-agent/clients
  */
 import type { DatabaseConnection, DatabaseType } from './connections.ts';
+/**
+ * Classify a SQL text as a read or write statement by its FIRST effective
+ * token (a conservative read whitelist, not a parser). `with` is read only
+ * when its body's first token is `select`. `pragma` is read-only for SQLite.
+ */
+export declare function classifyStatement(sql: string, type: DatabaseType): 'read' | 'write';
+/**
+ * Validate and quote one schema/table identifier for a safe metadata query.
+ * Identifiers are restricted to `[A-Za-z0-9_$]+` and then wrapped per type:
+ * backticks (mysql/hive/impala) or double quotes (postgres/oracle/sqlite),
+ * with the wrapping quote doubled for any interior occurrence. Rejects any
+ * input that could cross the identifier boundary (`#`, `--`, `;`, `'`, `` ` ``,
+ * `"`, `.`, `-` are all refused).
+ */
+export declare function sanitizeIdentifier(type: DatabaseType, identifier: string): string;
 /** One deployment override for a database type's CLI client. */
 export interface ClientConfig {
     /** Executable name (resolved through PATH) or absolute path. */

package/lib/types/connections.d.ts

@@ -37,6 +37,8 @@ export interface DatabaseConnection {
     database: string;
     /** In-memory only; never exposed through {@link DataAgentConnections.get}. */
     password?: string;
+    /** Optional per-session read-only guard (defaults to the plugin's `readonly`). */
+    readonly?: boolean;
     tables?: string[];
 }
 /** Password-free view of one connection (the wire/UI face). */
@@ -46,6 +48,8 @@ export interface ConnectionSummary {
     port?: number;
     user?: string;
     database: string;
+    /** Present only when the connection explicitly set it. */
+    readonly?: boolean;
     tables?: string[];
 }
 /** The host-plane connection store service (`ctx.dataAgentConnections`). */

package/lib/types/index.d.ts

@@ -44,6 +44,8 @@ export interface SeededConnectionConfig {
     port?: number;
     user?: string;
     database: string;
+    /** Optional per-seed read-only guard. */
+    readonly?: boolean;
 }
 /** Required plugin configuration (loader schema with deployment defaults). */
 export interface Config {
@@ -59,6 +61,8 @@ export interface Config {
     queryTimeoutMs: number;
     /** In-memory cap on sqlcmd captured output. */
     maxResultChars: number;
+    /** Default read-only guard: true rejects write statements in sqlcmd//query. */
+    readonly: boolean;
     /** CLI client overrides keyed by database type. */
     clients: ClientsConfig;
     /** Config-seeded connections keyed by session id (`'*'` = wildcard default). */
@@ -72,6 +76,7 @@ export declare const Config: import("@deepseek-ai/schemastery").default<Schemast
     introspectMaxTables: import("@deepseek-ai/schemastery").default<number, number>;
     queryTimeoutMs: import("@deepseek-ai/schemastery").default<number, number>;
     maxResultChars: import("@deepseek-ai/schemastery").default<number, number>;
+    readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
     clients: import("@deepseek-ai/schemastery").default<import("@deepseek-ai/cosmokit").Dict<{
         command?: string | null | undefined;
         args?: string[] | null | undefined;
@@ -85,12 +90,14 @@ export declare const Config: import("@deepseek-ai/schemastery").default<Schemast
         port?: number | null | undefined;
         user?: string | null | undefined;
         database?: string | null | undefined;
+        readonly?: boolean | null | undefined;
     } & import("cosmokit").Dict, string>, import("@deepseek-ai/cosmokit").Dict<Schemastery.ObjectT<{
         type: import("@deepseek-ai/schemastery").default<"mysql" | "postgres" | "sqlite" | "oracle" | "hive" | "impala", "mysql" | "postgres" | "sqlite" | "oracle" | "hive" | "impala">;
         host: import("@deepseek-ai/schemastery").default<string, string>;
         port: import("@deepseek-ai/schemastery").default<number, number>;
         user: import("@deepseek-ai/schemastery").default<string, string>;
         database: import("@deepseek-ai/schemastery").default<string, string>;
+        readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
     }>, string>>;
 }>, Schemastery.ObjectT<{
     presetId: import("@deepseek-ai/schemastery").default<string, string>;
@@ -99,6 +106,7 @@ export declare const Config: import("@deepseek-ai/schemastery").default<Schemast
     introspectMaxTables: import("@deepseek-ai/schemastery").default<number, number>;
     queryTimeoutMs: import("@deepseek-ai/schemastery").default<number, number>;
     maxResultChars: import("@deepseek-ai/schemastery").default<number, number>;
+    readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
     clients: import("@deepseek-ai/schemastery").default<import("@deepseek-ai/cosmokit").Dict<{
         command?: string | null | undefined;
         args?: string[] | null | undefined;
@@ -112,12 +120,14 @@ export declare const Config: import("@deepseek-ai/schemastery").default<Schemast
         port?: number | null | undefined;
         user?: string | null | undefined;
         database?: string | null | undefined;
+        readonly?: boolean | null | undefined;
     } & import("cosmokit").Dict, string>, import("@deepseek-ai/cosmokit").Dict<Schemastery.ObjectT<{
         type: import("@deepseek-ai/schemastery").default<"mysql" | "postgres" | "sqlite" | "oracle" | "hive" | "impala", "mysql" | "postgres" | "sqlite" | "oracle" | "hive" | "impala">;
         host: import("@deepseek-ai/schemastery").default<string, string>;
         port: import("@deepseek-ai/schemastery").default<number, number>;
         user: import("@deepseek-ai/schemastery").default<string, string>;
         database: import("@deepseek-ai/schemastery").default<string, string>;
+        readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
     }>, string>>;
 }>>;
 /**

package/lib/types/routes.d.ts

@@ -63,6 +63,8 @@ export interface Config {
     queryTimeoutMs: number;
     /** Cap on one /query SQL text length. */
     maxQueryChars: number;
+    /** Read-only guard: true rejects write statements in /query. */
+    readonly: boolean;
 }
 /** Loader schema with deployment defaults (no library defaults). */
 export declare const Config: import("@deepseek-ai/schemastery").default<Schemastery.ObjectS<{
@@ -71,12 +73,14 @@ export declare const Config: import("@deepseek-ai/schemastery").default<Schemast
     maxResultChars: import("@deepseek-ai/schemastery").default<number, number>;
     queryTimeoutMs: import("@deepseek-ai/schemastery").default<number, number>;
     maxQueryChars: import("@deepseek-ai/schemastery").default<number, number>;
+    readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
 }>, Schemastery.ObjectT<{
     connectTimeoutMs: import("@deepseek-ai/schemastery").default<number, number>;
     introspectMaxTables: import("@deepseek-ai/schemastery").default<number, number>;
     maxResultChars: import("@deepseek-ai/schemastery").default<number, number>;
     queryTimeoutMs: import("@deepseek-ai/schemastery").default<number, number>;
     maxQueryChars: import("@deepseek-ai/schemastery").default<number, number>;
+    readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
 }>>;
 /** The connection request wire body (validated in the /connect handler). */
 export interface ConnectRequestBody {
@@ -87,6 +91,7 @@ export interface ConnectRequestBody {
     user?: string;
     database: string;
     password?: string;
+    readonly?: boolean;
 }
 /**
  * Validate an untrusted /connect body; sqlite paths resolve to absolute

package/lib/types/tool.d.ts

@@ -26,6 +26,8 @@ export interface Config {
     maxResultChars: number;
     /** Row-count guidance injected into the tool description. */
     maxRows: number;
+    /** Read-only guard: true rejects write statements. */
+    readonly: boolean;
     /** CLI client overrides keyed by database type. */
     clients: Partial<Record<string, ClientConfig>>;
 }
@@ -34,6 +36,7 @@ export declare const Config: import("@deepseek-ai/schemastery").default<Schemast
     queryTimeoutMs: import("@deepseek-ai/schemastery").default<number, number>;
     maxResultChars: import("@deepseek-ai/schemastery").default<number, number>;
     maxRows: import("@deepseek-ai/schemastery").default<number, number>;
+    readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
     clients: import("@deepseek-ai/schemastery").default<import("@deepseek-ai/cosmokit").Dict<{
         command?: string | null | undefined;
         args?: string[] | null | undefined;
@@ -45,6 +48,7 @@ export declare const Config: import("@deepseek-ai/schemastery").default<Schemast
     queryTimeoutMs: import("@deepseek-ai/schemastery").default<number, number>;
     maxResultChars: import("@deepseek-ai/schemastery").default<number, number>;
     maxRows: import("@deepseek-ai/schemastery").default<number, number>;
+    readonly: import("@deepseek-ai/schemastery").default<boolean, boolean>;
     clients: import("@deepseek-ai/schemastery").default<import("@deepseek-ai/cosmokit").Dict<{
         command?: string | null | undefined;
         args?: string[] | null | undefined;

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@yejiming/dsh-data-agent",
   "description": "Data Agent for the dsh web GUI: session-scoped database connections (MySQL/PostgreSQL/SQLite), the sqlcmd tool, the data-agent agent preset, and the database conversation-view tab",
-  "version": "0.0.1",
+  "version": "0.0.2",
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/types/index.d.ts",