@hesed/mysql 0.2.2 → 0.4.0

package/dist/mysql/mysql-utils.js

@@ -1,11 +1,7 @@
-import { encode } from '@toon-format/toon';
 import mysql from 'mysql2/promise';
 import { getMySQLConnectionOptions } from './config-loader.js';
+import { FORMATTERS } from './formatters.js';
 import { analyzeQuery, applyDefaultLimit, checkBlacklist, getQueryType, requiresConfirmation } from './query-validator.js';
-/**
- * MySQL Database Utility
- * Provides core database operations with safety validation and formatting
- */
 export class MySQLUtil {
     config;
     connections;
@@ -13,33 +9,17 @@ export class MySQLUtil {
         this.config = config;
         this.connections = new Map();
     }
-    /**
-     * Close all connections
-     */
     async closeAll() {
         const entries = [...this.connections.values()];
         this.connections.clear();
         await Promise.allSettled(entries.map(async (connPromise) => (await connPromise).end()));
     }
-    /**
-     * Describe table structure
-     */
     async describeTable(profileName, table, format = 'table') {
         try {
             const connection = await this.getConnection(profileName);
             const [rows, fields] = await connection.query(`DESCRIBE ${table}`);
-            let result = '';
-            if (format === 'json') {
-                result += this.formatAsJson(rows);
-            }
-            else if (format === 'toon') {
-                result += this.formatAsToon(rows);
-            }
-            else {
-                result += this.formatAsTable(rows, fields);
-            }
             return {
-                result,
+                result: this.formatRows(rows, fields, format),
                 structure: rows,
                 success: true,
             };
@@ -52,9 +32,6 @@ export class MySQLUtil {
             };
         }
     }
-    /**
-     * Validate and execute a SQL query
-     */
     async executeQuery(profileName, query, format = 'table', skipConfirmation = false) {
         const blacklistCheck = checkBlacklist(query, this.config.safety.blacklistedOperations);
         if (!blacklistCheck.allowed) {
@@ -119,26 +96,13 @@ export class MySQLUtil {
             };
         }
     }
-    /**
-     * Explain query execution plan
-     */
     async explainQuery(profileName, query, format = 'table') {
         try {
             const connection = await this.getConnection(profileName);
             const [rows, fields] = await connection.query(`EXPLAIN ${query}`);
-            let result = '';
-            if (format === 'json') {
-                result += this.formatAsJson(rows);
-            }
-            else if (format === 'toon') {
-                result += this.formatAsToon(rows);
-            }
-            else {
-                result += this.formatAsTable(rows, fields);
-            }
             return {
                 plan: rows,
-                result,
+                result: this.formatRows(rows, fields, format),
                 success: true,
             };
         }
@@ -150,90 +114,6 @@ export class MySQLUtil {
             };
         }
     }
-    /**
-     * Format query results as CSV
-     */
-    formatAsCsv(rows, fields) {
-        if (!rows || rows.length === 0) {
-            return '';
-        }
-        const columnNames = fields.map((f) => f.name);
-        let csv = columnNames.join(',') + '\n';
-        for (const row of rows) {
-            const values = columnNames.map((name) => {
-                const value = row[name] ?? '';
-                const str = String(value);
-                if (str.includes(',') || str.includes('"') || str.includes('\n')) {
-                    return '"' + str.replaceAll('"', '""') + '"';
-                }
-                return str;
-            });
-            csv += values.join(',') + '\n';
-        }
-        return csv;
-    }
-    /**
-     * Format query results as JSON
-     */
-    formatAsJson(rows) {
-        return JSON.stringify(rows, null, 2);
-    }
-    /**
-     * Format query results as table
-     */
-    formatAsTable(rows, fields) {
-        if (!rows || rows.length === 0) {
-            return 'No results';
-        }
-        const columnNames = fields.map((f) => f.name);
-        const columnWidths = columnNames.map((name) => {
-            const dataWidth = Math.max(...rows.map((row) => String(row[name] ?? '').length));
-            return Math.max(name.length, dataWidth, 3);
-        });
-        let table = '┌' + columnWidths.map((w) => '─'.repeat(w + 2)).join('┬') + '┐\n';
-        table += '│ ' + columnNames.map((name, i) => name.padEnd(columnWidths[i])).join(' │ ') + ' │\n';
-        table += '├' + columnWidths.map((w) => '─'.repeat(w + 2)).join('┼') + '┤\n';
-        for (const row of rows) {
-            table +=
-                '│ ' +
-                    columnNames
-                        .map((name, i) => {
-                        const value = row[name] ?? 'NULL';
-                        return String(value).padEnd(columnWidths[i]);
-                    })
-                        .join(' │ ') +
-                    ' │\n';
-        }
-        table += '└' + columnWidths.map((w) => '─'.repeat(w + 2)).join('┴') + '┘';
-        return table;
-    }
-    /**
-     * Format query results as TOON
-     */
-    formatAsToon(rows) {
-        if (!rows || rows.length === 0) {
-            return '';
-        }
-        const serializedRows = rows.map((row) => {
-            const serialized = {};
-            for (const [key, value] of Object.entries(row)) {
-                if (value instanceof Date) {
-                    serialized[key] = Number.isNaN(value.getTime()) ? null : value.toISOString();
-                }
-                else if (Buffer.isBuffer(value)) {
-                    serialized[key] = value.toString('base64');
-                }
-                else {
-                    serialized[key] = value;
-                }
-            }
-            return serialized;
-        });
-        return encode(serializedRows);
-    }
-    /**
-     * List all databases
-     */
     async listDatabases(profileName) {
         try {
             const connection = await this.getConnection(profileName);
@@ -253,9 +133,6 @@ export class MySQLUtil {
             };
         }
     }
-    /**
-     * List all tables in current database
-     */
     async listTables(profileName) {
         try {
             const connection = await this.getConnection(profileName);
@@ -277,26 +154,13 @@ export class MySQLUtil {
             };
         }
     }
-    /**
-     * Show table indexes
-     */
     async showIndexes(profileName, table, format = 'table') {
         try {
             const connection = await this.getConnection(profileName);
             const [rows, fields] = await connection.query(`SHOW INDEXES FROM ${table}`);
-            let result = '';
-            if (format === 'json') {
-                result += this.formatAsJson(rows);
-            }
-            else if (format === 'toon') {
-                result += this.formatAsToon(rows);
-            }
-            else {
-                result += this.formatAsTable(rows, fields);
-            }
             return {
                 indexes: rows,
-                result,
+                result: this.formatRows(rows, fields, format),
                 success: true,
             };
         }
@@ -308,9 +172,6 @@ export class MySQLUtil {
             };
         }
     }
-    /**
-     * Test database connection
-     */
     async testConnection(profileName) {
         try {
             const connection = await this.getConnection(profileName);
@@ -331,34 +192,13 @@ export class MySQLUtil {
             };
         }
     }
-    /**
-     * Format rows for SELECT/SHOW/DESCRIBE/EXPLAIN query result
-     */
+    formatRows(rows, fields, format) {
+        return FORMATTERS[format](rows, fields);
+    }
     formatSelectResult(rows, fields, format) {
         const rowCount = Array.isArray(rows) ? rows.length : 0;
-        let result = `Query executed successfully. Rows returned: ${rowCount}\n\n`;
-        switch (format) {
-            case 'csv': {
-                result += this.formatAsCsv(rows, fields);
-                break;
-            }
-            case 'json': {
-                result += this.formatAsJson(rows);
-                break;
-            }
-            case 'toon': {
-                result += this.formatAsToon(rows);
-                break;
-            }
-            default: {
-                result += this.formatAsTable(rows, fields);
-            }
-        }
-        return result;
+        return `Query executed successfully. Rows returned: ${rowCount}\n\n` + this.formatRows(rows, fields, format);
     }
-    /**
-     * Get or create MySQL connection for a profile
-     */
     async getConnection(profileName) {
         const existing = this.connections.get(profileName);
         if (existing) {

package/dist/mysql/query-validator.d.ts

@@ -1,7 +1,3 @@
-/**
- * Query Validation and Safety Module
- * Provides SQL query analysis and safety checks
- */
 interface BlacklistCheckResult {
     allowed: boolean;
     reason?: string;
@@ -15,24 +11,9 @@ interface QueryWarning {
     message: string;
     suggestion: string;
 }
-/**
- * Check if query contains blacklisted operations
- */
 export declare function checkBlacklist(query: string, blacklistedOperations: string[]): BlacklistCheckResult;
-/**
- * Check if query requires user confirmation
- */
 export declare function requiresConfirmation(query: string, confirmationOperations: string[]): ConfirmationCheckResult;
-/**
- * Get query type (SELECT, INSERT, UPDATE, etc.)
- */
 export declare function getQueryType(query: string): string;
-/**
- * Analyze query for potential issues and provide warnings
- */
 export declare function analyzeQuery(query: string): QueryWarning[];
-/**
- * Apply default LIMIT to SELECT queries if not present
- */
 export declare function applyDefaultLimit(query: string, defaultLimit: number): string;
 export {};

package/dist/mysql/query-validator.js

@@ -1,10 +1,3 @@
-/**
- * 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) {
@@ -18,9 +11,6 @@ export function checkBlacklist(query, blacklistedOperations) {
     }
     return { allowed: true };
 }
-/**
- * Check if query requires user confirmation
- */
 export function requiresConfirmation(query, confirmationOperations) {
     const normalizedQuery = query.trim().toUpperCase();
     for (const operation of confirmationOperations) {
@@ -34,9 +24,6 @@ export function requiresConfirmation(query, confirmationOperations) {
     }
     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];
@@ -58,9 +45,6 @@ export function getQueryType(query) {
     }
     return 'UNKNOWN';
 }
-/**
- * Analyze query for potential issues and provide warnings
- */
 export function analyzeQuery(query) {
     const warnings = [];
     const normalizedQuery = query.trim().toUpperCase();
@@ -91,9 +75,6 @@ export function analyzeQuery(query) {
     }
     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')) {

package/oclif.manifest.json

@@ -291,10 +291,10 @@
     "mysql:auth:add": {
       "aliases": [],
       "args": {},
-      "description": "Add a MySQL connection profile",
+      "description": "Add MySQL authentication",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --no-ssl"
+        "<%= config.bin %> <%= command.id %> -p prod"
       ],
       "flags": {
         "json": {
@@ -304,10 +304,10 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "database": {
-          "char": "d",
-          "description": "Database name",
-          "name": "database",
+        "profile": {
+          "char": "p",
+          "description": "Profile name",
+          "name": "profile",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
@@ -321,27 +321,35 @@
           "multiple": false,
           "type": "option"
         },
-        "password": {
-          "char": "p",
-          "description": "Password",
-          "name": "password",
+        "port": {
+          "description": "MySQL port",
+          "name": "port",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "port": {
-          "char": "P",
-          "description": "MySQL port",
-          "name": "port",
+        "user": {
+          "char": "u",
+          "description": "Username",
+          "name": "user",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "profile": {
-          "description": "Profile name",
-          "name": "profile",
+        "password": {
+          "description": "Password",
+          "name": "password",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "database": {
+          "char": "d",
+          "description": "Database name",
+          "name": "database",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
@@ -350,15 +358,124 @@
         "ssl": {
           "description": "Use SSL",
           "name": "ssl",
+          "required": true,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "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:delete": {
+      "aliases": [],
+      "args": {},
+      "description": "Delete an authentication profile",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> -p prod"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "profile": {
+          "char": "p",
+          "description": "Profile to delete",
+          "name": "profile",
           "required": false,
-          "allowNo": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:auth:delete",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "auth",
+        "delete.js"
+      ]
+    },
+    "mysql:auth:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List authentication profiles",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "mysql:auth:list",
+      "pluginAlias": "@hesed/mysql",
+      "pluginName": "@hesed/mysql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "mysql",
+        "auth",
+        "list.js"
+      ]
+    },
+    "mysql:auth:profile": {
+      "aliases": [],
+      "args": {},
+      "description": "Set or show the default authentication profile",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --default test"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
           "type": "boolean"
         },
-        "user": {
-          "char": "u",
-          "description": "Username",
-          "name": "user",
-          "required": true,
+        "default": {
+          "description": "Profile to set as default",
+          "name": "default",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -366,7 +483,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "mysql:auth:add",
+      "id": "mysql:auth:profile",
       "pluginAlias": "@hesed/mysql",
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
@@ -378,16 +495,16 @@
         "commands",
         "mysql",
         "auth",
-        "add.js"
+        "profile.js"
       ]
     },
     "mysql:auth:test": {
       "aliases": [],
       "args": {},
-      "description": "Test MySQL database connection",
+      "description": "Test authentication and connection",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --profile staging"
+        "<%= config.bin %> <%= command.id %> -p prod"
       ],
       "flags": {
         "json": {
@@ -398,7 +515,8 @@
           "type": "boolean"
         },
         "profile": {
-          "description": "Profile name to test",
+          "char": "p",
+          "description": "Authentication profile name",
           "name": "profile",
           "required": false,
           "hasDynamicHelp": false,
@@ -426,10 +544,10 @@
     "mysql:auth:update": {
       "aliases": [],
       "args": {},
-      "description": "Update an existing MySQL connection profile",
+      "description": "Update MySQL authentication",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --ssl",
-        "<%= config.bin %> <%= command.id %> --profile staging"
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> -p test"
       ],
       "flags": {
         "json": {
@@ -439,10 +557,10 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "database": {
-          "char": "d",
-          "description": "Database name",
-          "name": "database",
+        "profile": {
+          "char": "p",
+          "description": "Profile name",
+          "name": "profile",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
@@ -456,47 +574,46 @@
           "multiple": false,
           "type": "option"
         },
-        "password": {
-          "char": "p",
-          "description": "Password",
-          "name": "password",
+        "port": {
+          "description": "MySQL port",
+          "name": "port",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "port": {
-          "char": "P",
-          "description": "MySQL port",
-          "name": "port",
+        "user": {
+          "char": "u",
+          "description": "Username",
+          "name": "user",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "profile": {
-          "description": "Profile name to update",
-          "name": "profile",
-          "required": false,
+        "password": {
+          "description": "Password",
+          "name": "password",
+          "required": true,
           "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",
+        "database": {
+          "char": "d",
+          "description": "Database name",
+          "name": "database",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "ssl": {
+          "description": "Use SSL",
+          "name": "ssl",
+          "required": true,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -517,5 +634,5 @@
       ]
     }
   },
-  "version": "0.2.2"
+  "version": "0.4.0"
 }