@hesed/mysql 0.1.0

package/dist/mysql/query-validator.js

@@ -0,0 +1,103 @@
+/**
+ * Query Validation and Safety Module
+ * Provides SQL query analysis and safety checks
+ */
+/**
+ * Check if query contains blacklisted operations
+ */
+export function checkBlacklist(query, blacklistedOperations) {
+    const normalizedQuery = query.trim().toUpperCase();
+    for (const operation of blacklistedOperations) {
+        const normalizedOp = operation.toUpperCase();
+        if (normalizedQuery.includes(normalizedOp)) {
+            return {
+                allowed: false,
+                reason: `Operation "${operation}" is blacklisted and not allowed`,
+            };
+        }
+    }
+    return { allowed: true };
+}
+/**
+ * Check if query requires user confirmation
+ */
+export function requiresConfirmation(query, confirmationOperations) {
+    const normalizedQuery = query.trim().toUpperCase();
+    for (const operation of confirmationOperations) {
+        const normalizedOp = operation.toUpperCase();
+        if (normalizedQuery.startsWith(normalizedOp) || normalizedQuery.includes(` ${normalizedOp} `)) {
+            return {
+                message: `This query contains a destructive operation: ${operation}`,
+                required: true,
+            };
+        }
+    }
+    return { required: false };
+}
+/**
+ * Get query type (SELECT, INSERT, UPDATE, etc.)
+ */
+export function getQueryType(query) {
+    const normalizedQuery = query.trim().toUpperCase();
+    const firstWord = normalizedQuery.split(/\s+/)[0];
+    const knownTypes = [
+        'SELECT',
+        'INSERT',
+        'UPDATE',
+        'DELETE',
+        'DROP',
+        'CREATE',
+        'ALTER',
+        'TRUNCATE',
+        'SHOW',
+        'DESCRIBE',
+        'EXPLAIN',
+    ];
+    if (knownTypes.includes(firstWord)) {
+        return firstWord;
+    }
+    return 'UNKNOWN';
+}
+/**
+ * Analyze query for potential issues and provide warnings
+ */
+export function analyzeQuery(query) {
+    const warnings = [];
+    const normalizedQuery = query.trim().toUpperCase();
+    // Check for missing WHERE clause in UPDATE/DELETE
+    if ((normalizedQuery.startsWith('UPDATE') || normalizedQuery.startsWith('DELETE')) &&
+        !normalizedQuery.includes('WHERE')) {
+        warnings.push({
+            level: 'warning',
+            message: 'Missing WHERE clause in UPDATE/DELETE query',
+            suggestion: 'This will affect all rows in the table. Add a WHERE clause to limit scope.',
+        });
+    }
+    // Check for SELECT * (potential performance issue)
+    if (normalizedQuery.includes('SELECT *')) {
+        warnings.push({
+            level: 'info',
+            message: 'Using SELECT * may impact performance',
+            suggestion: 'Consider selecting only the columns you need.',
+        });
+    }
+    // Check for missing LIMIT in SELECT
+    if (normalizedQuery.startsWith('SELECT') && !normalizedQuery.includes('LIMIT')) {
+        warnings.push({
+            level: 'info',
+            message: 'SELECT query without LIMIT',
+            suggestion: 'Consider adding a LIMIT clause to prevent large result sets.',
+        });
+    }
+    return warnings;
+}
+/**
+ * Apply default LIMIT to SELECT queries if not present
+ */
+export function applyDefaultLimit(query, defaultLimit) {
+    const normalizedQuery = query.trim().toUpperCase();
+    if (normalizedQuery.startsWith('SELECT') && !normalizedQuery.includes('LIMIT')) {
+        return `${query.trim()} LIMIT ${defaultLimit}`;
+    }
+    return query;
+}

package/oclif.manifest.json

@@ -0,0 +1,527 @@
+{
+  "commands": {
+    "mysql:describe-table": {
+      "aliases": [],
+      "args": {},
+      "description": "Describe the structure of a MySQL table",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --table users",
+        "<%= config.bin %> <%= command.id %> --table orders --format json --profile prod"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "table": {
+          "char": "t",
+          "description": "Table name to describe",
+          "name": "table",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:describe-table",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "describe-table.js"
+      ]
+    },
+    "mysql:explain-query": {
+      "aliases": [],
+      "args": {
+        "query": {
+          "description": "SQL query to explain",
+          "name": "query",
+          "required": true
+        }
+      },
+      "description": "Show the execution plan for a MySQL query",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> \"SELECT * FROM users WHERE id = 1\"",
+        "<%= config.bin %> <%= command.id %> \"SELECT * FROM orders JOIN users ON orders.user_id = users.id\" --format json"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:explain-query",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "explain-query.js"
+      ]
+    },
+    "mysql:list-databases": {
+      "aliases": [],
+      "args": {},
+      "description": "List all databases accessible on the MySQL server",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile staging"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:list-databases",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "list-databases.js"
+      ]
+    },
+    "mysql:list-tables": {
+      "aliases": [],
+      "args": {},
+      "description": "List all tables in the current MySQL database",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile local"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:list-tables",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "list-tables.js"
+      ]
+    },
+    "mysql:query": {
+      "aliases": [],
+      "args": {
+        "query": {
+          "description": "SQL query to execute",
+          "name": "query",
+          "required": true
+        }
+      },
+      "description": "Execute a SQL query against a MySQL database",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> \"SELECT * FROM users LIMIT 10\"",
+        "<%= config.bin %> <%= command.id %> \"UPDATE users SET email = 'user@email.com' WHERE id = 999\" --format json",
+        "<%= config.bin %> <%= command.id %> \"DELETE FROM sessions\" --profile prod --skip-confirmation"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "csv",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "skip-confirmation": {
+          "description": "Skip confirmation prompt for destructive operations",
+          "name": "skip-confirmation",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:query",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "query.js"
+      ]
+    },
+    "mysql:show-indexes": {
+      "aliases": [],
+      "args": {},
+      "description": "Show indexes for a MySQL table",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --table users",
+        "<%= config.bin %> <%= command.id %> --table orders --format json --profile prod"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "table": {
+          "char": "t",
+          "description": "Table name to show indexes for",
+          "name": "table",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:show-indexes",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "show-indexes.js"
+      ]
+    },
+    "mysql:auth:add": {
+      "aliases": [],
+      "args": {},
+      "description": "Add a MySQL connection profile",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --no-ssl"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "database": {
+          "char": "d",
+          "description": "Database name",
+          "name": "database",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "host": {
+          "description": "MySQL host",
+          "name": "host",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "password": {
+          "char": "p",
+          "description": "Password",
+          "name": "password",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "char": "P",
+          "description": "MySQL port",
+          "name": "port",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "profile": {
+          "description": "Profile name",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ssl": {
+          "description": "Use SSL",
+          "name": "ssl",
+          "required": false,
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "user": {
+          "char": "u",
+          "description": "Username",
+          "name": "user",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:auth:add",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "auth",
+        "add.js"
+      ]
+    },
+    "mysql:auth:test": {
+      "aliases": [],
+      "args": {},
+      "description": "Test MySQL database connection",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile staging"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "profile": {
+          "description": "Profile name to test",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:auth:test",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "auth",
+        "test.js"
+      ]
+    },
+    "mysql:auth:update": {
+      "aliases": [],
+      "args": {},
+      "description": "Update an existing MySQL connection profile",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --ssl",
+        "<%= config.bin %> <%= command.id %> --profile staging"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "database": {
+          "char": "d",
+          "description": "Database name",
+          "name": "database",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "host": {
+          "description": "MySQL host",
+          "name": "host",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "password": {
+          "char": "p",
+          "description": "Password",
+          "name": "password",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "char": "P",
+          "description": "MySQL port",
+          "name": "port",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "profile": {
+          "description": "Profile name to update",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ssl": {
+          "description": "Use SSL",
+          "name": "ssl",
+          "required": false,
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "user": {
+          "char": "u",
+          "description": "Username",
+          "name": "user",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:auth:update",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "auth",
+        "update.js"
+      ]
+    }
+  },
+  "version": "0.1.0"
+}