sql-preview 0.5.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mehul Fadnavis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/README.md

@@ -0,0 +1,106 @@
+# SQL Preview for VS Code
+
+A Visual Studio Code extension for connecting to **Trino** databases, running SQL queries, and visualizing results directly within your editor.
+
+## Features
+
+- **SQL Query Execution**: Run SQL queries against Trino databases directly from VS Code.
+- **Interactive Results View**: View query results in a high-performance AG Grid table with sorting, filtering, and resizing.
+- **Code Lens Integration**: Execute queries with a single click from your `.sql` files.
+- **Client-Server Architecture**: Uses a dedicated background daemon for reliable connection management and query execution.
+- **Secure Password Storage**: Passwords are encrypted using the OS keyring via VS Code's SecretStorage API.
+- **MCP Integration (Beta)**: Exposes database tools to AI agents via the Model Context Protocol.
+
+## Usage
+
+### Running Queries
+
+1.  Open a `.sql` file.
+2.  **Code Lens**: Click "Run Query" above the SQL block.
+3.  **Command Palette**: Open the palette (`Cmd+Shift+P`) and run `SQL Preview: Run Query`.
+4.  **Shortcut**: Press `Cmd+Enter` (Mac) or `Ctrl+Enter` (Windows/Linux) to run the query.
+
+### Viewing Results
+
+Results appear in the **SQL Preview** panel.
+
+- **Sort**: Click column headers.
+- **Filter**: Use the text boxes below headers.
+- **Export**: Right-click to copy cells.
+
+## Architecture
+
+This extension uses a robust **Client-Server** model:
+
+1.  **Extension (Client)**: The VS Code frontend that handles UI, commands, and configuration.
+2.  **Daemon (Server)**: A separate Node.js process that manages database connections and executes queries.
+3.  **Communication**: The Client and Daemon communicate via the **Model Context Protocol (MCP)** over local sockets.
+
+This separation ensures that long-running queries do not block the VS Code UI and provides a stable environment for database interactions.
+
+## Configuration
+
+Add the following configuration to your `settings.json`:
+
+```json
+{
+  "sqlPreview.defaultConnector": "trino",
+  "sqlPreview.host": "trino-coordinator.example.com",
+  "sqlPreview.port": 443,
+  "sqlPreview.user": "your-username",
+  "sqlPreview.catalog": "hive",
+  "sqlPreview.schema": "default",
+  "sqlPreview.ssl": true,
+  "sqlPreview.sslVerify": true,
+  "sqlPreview.maxRowsToDisplay": 1000,
+  "sqlPreview.logLevel": "INFO" // Options: DEBUG, INFO, WARN, ERROR
+}
+```
+
+### Secure Password Management
+
+For security, passwords are never stored in plain text.
+
+1.  **Set Password**: Run the command `SQL Preview: Set Database Password` or click "Set Password" in the Settings UI.
+2.  **Clear Password**: Run `SQL Preview: Clear Stored Password`.
+
+## 🤖 Model Context Protocol (MCP) Integration (Beta)
+
+This extension includes a built-in MCP server that allows AI assistants (like Claude) to interact with your database.
+
+### Enabling MCP
+
+1.  Open VS Code Settings.
+2.  Set `sqlPreview.mcpEnabled` to `true`.
+3.  (Optional) Set `sqlPreview.mcpSafeMode` to `true` (default) to restrict AI to read-only queries.
+4.  Restart the extension or run `SQL Preview: Restart Background Server`.
+
+### Available Tools
+
+When enabled, the following tools are available to MCP clients:
+
+- `run_query`: Execute a SQL query.
+- `list_tables`: List tables in a schema.
+- `describe_table`: Show table schema.
+- `get_ddl`: Get the CREATE TABLE statement.
+
+## Project Structure
+
+```
+sql-preview/
+├── src/
+│   ├── extension.ts          # Main extension entry point (Client)
+│   ├── server/               # Daemon process (Server)
+│   │   ├── Daemon.ts         # Server entry point
+│   │   └── DaemonMcpServer.ts # MCP implementation
+│   ├── connectors/           # Database connectors (Trino)
+│   └── ui/                   # Webview logic
+└── webviews/                 # Frontend assets (React/HTML/CSS)
+```
+
+## Development
+
+1.  **Clone**: `git clone ...`
+2.  **Install**: `npm install`
+3.  **Build**: `npm run build`
+4.  **Debug**: Press `F5` to start the Extension Host.

package/out/common/errors.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthenticationError = exports.QueryError = exports.ConnectionError = exports.BaseError = void 0;
+class BaseError extends Error {
+    constructor(message, details) {
+        super(message);
+        this.details = details;
+        this.name = this.constructor.name;
+    }
+}
+exports.BaseError = BaseError;
+class ConnectionError extends BaseError {
+    constructor(message, details) {
+        super(message, details);
+    }
+}
+exports.ConnectionError = ConnectionError;
+class QueryError extends BaseError {
+    constructor(message, query, details) {
+        super(message, details);
+        this.query = query;
+    }
+}
+exports.QueryError = QueryError;
+class AuthenticationError extends BaseError {
+    constructor(message, details) {
+        super(message, details);
+    }
+}
+exports.AuthenticationError = AuthenticationError;
+//# sourceMappingURL=errors.js.map

package/out/common/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/common/errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,SAAU,SAAQ,KAAK;IAClC,YACE,OAAe,EACC,OAAgB;QAEhC,KAAK,CAAC,OAAO,CAAC,CAAC;QAFC,YAAO,GAAP,OAAO,CAAS;QAGhC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AARD,8BAQC;AAED,MAAa,eAAgB,SAAQ,SAAS;IAC5C,YAAY,OAAe,EAAE,OAAgB;QAC3C,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF;AAJD,0CAIC;AAED,MAAa,UAAW,SAAQ,SAAS;IACvC,YACE,OAAe,EACC,KAAc,EAC9B,OAAgB;QAEhB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAHR,UAAK,GAAL,KAAK,CAAS;IAIhC,CAAC;CACF;AARD,gCAQC;AAED,MAAa,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAe,EAAE,OAAgB;QAC3C,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF;AAJD,kDAIC"}

package/out/common/types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEBUG"] = "DEBUG";
+    LogLevel["INFO"] = "INFO";
+    LogLevel["WARN"] = "WARN";
+    LogLevel["ERROR"] = "ERROR";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+//# sourceMappingURL=types.js.map

package/out/common/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";;;AAkCA,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB"}

package/out/server/ConsoleLogger.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.ConsoleLogger = void 0;
+const types_1 = require("../common/types");
+class ConsoleLogger {
+    constructor() {
+        this.logLevel = types_1.LogLevel.INFO;
+        const envLevel = process.env['SQL_PREVIEW_LOG_LEVEL'];
+        if (envLevel && Object.values(types_1.LogLevel).includes(envLevel)) {
+            this.logLevel = envLevel;
+        }
+    }
+    static getInstance() {
+        if (!ConsoleLogger.instance) {
+            ConsoleLogger.instance = new ConsoleLogger();
+        }
+        return ConsoleLogger.instance;
+    }
+    shouldLog(level) {
+        const levels = [types_1.LogLevel.DEBUG, types_1.LogLevel.INFO, types_1.LogLevel.WARN, types_1.LogLevel.ERROR];
+        return levels.indexOf(level) >= levels.indexOf(this.logLevel);
+    }
+    info(message, data) {
+        if (this.shouldLog(types_1.LogLevel.INFO)) {
+            console.log(`[INFO] ${message}`, data ? JSON.stringify(data) : '');
+        }
+    }
+    error(message, error) {
+        if (this.shouldLog(types_1.LogLevel.ERROR)) {
+            console.error(`[ERROR] ${message}`, error);
+        }
+    }
+    warn(message, data) {
+        if (this.shouldLog(types_1.LogLevel.WARN)) {
+            console.warn(`[WARN] ${message}`, data ? JSON.stringify(data) : '');
+        }
+    }
+    debug(message, data) {
+        if (this.shouldLog(types_1.LogLevel.DEBUG)) {
+            console.debug(`[DEBUG] ${message}`, data ? JSON.stringify(data) : '');
+        }
+    }
+}
+exports.ConsoleLogger = ConsoleLogger;
+exports.logger = ConsoleLogger.getInstance();
+//# sourceMappingURL=ConsoleLogger.js.map

package/out/server/ConsoleLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConsoleLogger.js","sourceRoot":"","sources":["../../src/server/ConsoleLogger.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;AAE3C,MAAa,aAAa;IAIxB;QAFQ,aAAQ,GAAa,gBAAQ,CAAC,IAAI,CAAC;QAGzC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACtD,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAQ,CAAC,CAAC,QAAQ,CAAC,QAAoB,CAAC,EAAE,CAAC;YACvE,IAAI,CAAC,QAAQ,GAAG,QAAoB,CAAC;QACvC,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;YAC5B,aAAa,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QAC/C,CAAC;QACD,OAAO,aAAa,CAAC,QAAQ,CAAC;IAChC,CAAC;IAEO,SAAS,CAAC,KAAe;QAC/B,MAAM,MAAM,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,gBAAQ,CAAC,IAAI,EAAE,gBAAQ,CAAC,IAAI,EAAE,gBAAQ,CAAC,KAAK,CAAC,CAAC;QAC9E,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChE,CAAC;IAEM,IAAI,CAAC,OAAe,EAAE,IAAc;QACzC,IAAI,IAAI,CAAC,SAAS,CAAC,gBAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAe,EAAE,KAAe;QAC3C,IAAI,IAAI,CAAC,SAAS,CAAC,gBAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CAAC,WAAW,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAEM,IAAI,CAAC,OAAe,EAAE,IAAc;QACzC,IAAI,IAAI,CAAC,SAAS,CAAC,gBAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,UAAU,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAe,EAAE,IAAc;QAC1C,IAAI,IAAI,CAAC,SAAS,CAAC,gBAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CAAC,WAAW,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;CACF;AA9CD,sCA8CC;AAEY,QAAA,MAAM,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC"}