@hesed/mysql 0.5.1 → 0.5.2

package/README.md

@@ -26,7 +26,7 @@ $ npm install -g @hesed/mysql
 $ mq COMMAND
 running command...
 $ mq (--version)
-@hesed/mysql/0.5.1 linux-x64 node-v24.17.0
+@hesed/mysql/0.5.2 linux-x64 node-v24.17.0
 $ mq --help [COMMAND]
 USAGE
   $ mq COMMAND
@@ -45,7 +45,7 @@ USAGE
 * [`mq mysql auth update`](#mq-mysql-auth-update)
 * [`mq mysql databases`](#mq-mysql-databases)
 * [`mq mysql describe-table TABLE`](#mq-mysql-describe-table-table)
-* [`mq mysql explain-query QUERY`](#mq-mysql-explain-query-query)
+* [`mq mysql explain QUERY`](#mq-mysql-explain-query)
 * [`mq mysql indexes TABLE`](#mq-mysql-indexes-table)
 * [`mq mysql query QUERY`](#mq-mysql-query-query)
 * [`mq mysql tables`](#mq-mysql-tables)
@@ -80,7 +80,7 @@ EXAMPLES
   $ mq mysql auth add -p prod
 ```
 
-_See code: [src/commands/mysql/auth/add.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/add.ts)_
+_See code: [src/commands/mysql/auth/add.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/auth/add.ts)_
 
 ## `mq mysql auth delete`
 
@@ -105,7 +105,7 @@ EXAMPLES
   $ mq mysql auth delete -p prod
 ```
 
-_See code: [src/commands/mysql/auth/delete.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/delete.ts)_
+_See code: [src/commands/mysql/auth/delete.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/auth/delete.ts)_
 
 ## `mq mysql auth list`
 
@@ -125,7 +125,7 @@ EXAMPLES
   $ mq mysql auth list
 ```
 
-_See code: [src/commands/mysql/auth/list.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/list.ts)_
+_See code: [src/commands/mysql/auth/list.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/auth/list.ts)_
 
 ## `mq mysql auth profile`
 
@@ -150,7 +150,7 @@ EXAMPLES
   $ mq mysql auth profile --default test
 ```
 
-_See code: [src/commands/mysql/auth/profile.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/profile.ts)_
+_See code: [src/commands/mysql/auth/profile.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/auth/profile.ts)_
 
 ## `mq mysql auth test`
 
@@ -175,7 +175,7 @@ EXAMPLES
   $ mq mysql auth test -p prod
 ```
 
-_See code: [src/commands/mysql/auth/test.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/test.ts)_
+_See code: [src/commands/mysql/auth/test.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/auth/test.ts)_
 
 ## `mq mysql auth update`
 
@@ -207,7 +207,7 @@ EXAMPLES
   $ mq mysql auth update -p test
 ```
 
-_See code: [src/commands/mysql/auth/update.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/update.ts)_
+_See code: [src/commands/mysql/auth/update.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/auth/update.ts)_
 
 ## `mq mysql databases`
 
@@ -232,7 +232,7 @@ EXAMPLES
   $ mq mysql databases -p staging
 ```
 
-_See code: [src/commands/mysql/databases.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/databases.ts)_
+_See code: [src/commands/mysql/databases.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/databases.ts)_
 
 ## `mq mysql describe-table TABLE`
 
@@ -240,15 +240,14 @@ Describe the structure of a MySQL table
 
 ```
 USAGE
-  $ mq mysql describe-table TABLE [--json] [--format table|json|toon] [-p <value>]
+  $ mq mysql describe-table TABLE [--json] [-p <value>] [--toon]
 
 ARGUMENTS
   TABLE  Table name to describe
 
 FLAGS
   -p, --profile=<value>  Database profile name from config
-      --format=<option>  [default: table] Output format
-                         <options: table|json|toon>
+      --toon             Format output as toon
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -259,26 +258,25 @@ DESCRIPTION
 EXAMPLES
   $ mq mysql describe-table users
 
-  $ mq mysql describe-table orders --format json -p prod
+  $ mq mysql describe-table orders --toon -p prod
 ```
 
-_See code: [src/commands/mysql/describe-table.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/describe-table.ts)_
+_See code: [src/commands/mysql/describe-table.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/describe-table.ts)_
 
-## `mq mysql explain-query QUERY`
+## `mq mysql explain QUERY`
 
 Show the execution plan for a MySQL query
 
 ```
 USAGE
-  $ mq mysql explain-query QUERY [--json] [--format table|json|toon] [-p <value>]
+  $ mq mysql explain QUERY [--json] [-p <value>] [--toon]
 
 ARGUMENTS
   QUERY  SQL query to explain
 
 FLAGS
   -p, --profile=<value>  Database profile name from config
-      --format=<option>  [default: table] Output format
-                         <options: table|json|toon>
+      --toon             Format output as toon
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -287,12 +285,12 @@ DESCRIPTION
   Show the execution plan for a MySQL query
 
 EXAMPLES
-  $ mq mysql explain-query "SELECT * FROM users WHERE id = 1"
+  $ mq mysql explain "SELECT * FROM users WHERE id = 1"
 
-  $ mq mysql explain-query "SELECT * FROM orders JOIN users ON orders.user_id = users.id" --format json
+  $ mq mysql explain "SELECT * FROM orders JOIN users ON orders.user_id = users.id" --json
 ```
 
-_See code: [src/commands/mysql/explain-query.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/explain-query.ts)_
+_See code: [src/commands/mysql/explain.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/explain.ts)_
 
 ## `mq mysql indexes TABLE`
 
@@ -300,15 +298,14 @@ Show indexes for a MySQL table
 
 ```
 USAGE
-  $ mq mysql indexes TABLE [--json] [--format table|json|toon] [-p <value>]
+  $ mq mysql indexes TABLE [--json] [-p <value>] [--toon]
 
 ARGUMENTS
   TABLE  Table name to show indexes for
 
 FLAGS
   -p, --profile=<value>  Database profile name from config
-      --format=<option>  [default: table] Output format
-                         <options: table|json|toon>
+      --toon             Format output as toon
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -319,10 +316,10 @@ DESCRIPTION
 EXAMPLES
   $ mq mysql indexes users
 
-  $ mq mysql indexes orders --format json -p prod
+  $ mq mysql indexes orders --json -p prod
 ```
 
-_See code: [src/commands/mysql/indexes.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/indexes.ts)_
+_See code: [src/commands/mysql/indexes.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/indexes.ts)_
 
 ## `mq mysql query QUERY`
 
@@ -330,16 +327,15 @@ Execute a SQL query against a MySQL database
 
 ```
 USAGE
-  $ mq mysql query QUERY [--json] [--format table|json|csv|toon] [-p <value>] [--skip-confirmation]
+  $ mq mysql query QUERY [--json] [-p <value>] [--skip-confirmation] [--toon]
 
 ARGUMENTS
   QUERY  SQL query to execute
 
 FLAGS
   -p, --profile=<value>    Database profile name from config
-      --format=<option>    [default: table] Output format
-                           <options: table|json|csv|toon>
       --skip-confirmation  Skip confirmation prompt for destructive operations
+      --toon               Format output as toon
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -348,14 +344,14 @@ DESCRIPTION
   Execute a SQL query against a MySQL database
 
 EXAMPLES
-  $ mq mysql query "SELECT * FROM users LIMIT 10"
+  $ mq mysql query "SELECT * FROM users LIMIT 10" --json
 
-  $ mq mysql query "UPDATE users SET email = 'user@email.com' WHERE id = 999" --format json
+  $ mq mysql query "UPDATE users SET email = 'user@email.com' WHERE id = 999"
 
   $ mq mysql query "DELETE FROM sessions" -p prod --skip-confirmation
 ```
 
-_See code: [src/commands/mysql/query.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/query.ts)_
+_See code: [src/commands/mysql/query.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/query.ts)_
 
 ## `mq mysql tables`
 
@@ -363,11 +359,14 @@ List all tables in the current MySQL database
 
 ```
 USAGE
-  $ mq mysql tables [-p <value>]
+  $ mq mysql tables [--json] [-p <value>]
 
 FLAGS
   -p, --profile=<value>  Database profile name from config
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   List all tables in the current MySQL database
 
@@ -377,5 +376,5 @@ EXAMPLES
   $ mq mysql tables -p local
 ```
 
-_See code: [src/commands/mysql/tables.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/tables.ts)_
+_See code: [src/commands/mysql/tables.ts](https://github.com/hesedcasa/mysql/blob/v0.5.2/src/commands/mysql/tables.ts)_
 <!-- commandsstop -->

package/dist/base-command.d.ts

@@ -7,6 +7,4 @@ export declare abstract class BaseCommand extends Command {
     protected toErrorJson(err: unknown): {
         error: string;
     };
-    private formatFlagValue;
-    private hasFormatFlag;
 }

package/dist/base-command.js

@@ -4,8 +4,6 @@ export class BaseCommand extends Command {
     jsonEnabled() {
         const separatorIndex = this.argv.indexOf('--');
         const flagArgs = separatorIndex === -1 ? this.argv : this.argv.slice(0, separatorIndex);
-        if (this.hasFormatFlag(flagArgs))
-            return this.formatFlagValue(flagArgs) === 'json';
         return flagArgs.includes('--json');
     }
     // oclif sets this.parsed=true only after Parser.parse() returns successfully.
@@ -36,15 +34,4 @@ export class BaseCommand extends Command {
         const message = err instanceof Error ? err.message : String(err);
         return { error: message };
     }
-    formatFlagValue(flagArgs) {
-        for (const [index, arg] of flagArgs.entries()) {
-            if (arg === '--format')
-                return flagArgs[index + 1];
-            if (arg.startsWith('--format='))
-                return arg.slice('--format='.length);
-        }
-    }
-    hasFormatFlag(flagArgs) {
-        return flagArgs.some((arg) => arg === '--format' || arg.startsWith('--format='));
-    }
 }

package/dist/commands/mysql/databases.d.ts

@@ -1,11 +1,10 @@
-import { Command } from '@oclif/core';
-export default class MySQLDatabases extends Command {
+import type { ApiResult } from '@hesed/plugin-lib';
+import { BaseCommand } from '../../base-command.js';
+export default class MySQLDatabases extends BaseCommand {
     static description: string;
-    static enableJsonFlag: boolean;
     static examples: string[];
     static flags: {
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    jsonEnabled(): boolean;
-    run(): Promise<string[]>;
+    run(): Promise<ApiResult>;
 }

package/dist/commands/mysql/databases.js

@@ -1,22 +1,21 @@
-import { Command, Flags } from '@oclif/core';
+import { Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
 import { closeConnections, listDatabases } from '../../mysql/index.js';
-export default class MySQLDatabases extends Command {
+export default class MySQLDatabases extends BaseCommand {
     static description = 'List all databases accessible on the MySQL server';
-    static enableJsonFlag = true;
     static examples = ['<%= config.bin %> <%= command.id %>', '<%= config.bin %> <%= command.id %> -p staging'];
     static flags = {
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
     };
-    jsonEnabled() {
-        return true;
-    }
     async run() {
         const { flags } = await this.parse(MySQLDatabases);
         const result = await listDatabases(this.config, flags.profile);
         await closeConnections();
         if (result.success) {
-            return result.databases ?? [];
+            this.log(result.data?.result ?? '');
+            delete result.data.result;
+            return result;
         }
-        this.error(result.error ?? 'Failed to list databases');
+        this.error(String(result.error ?? 'Failed to list databases'));
     }
 }

package/dist/commands/mysql/describe-table.d.ts

@@ -1,3 +1,4 @@
+import { ApiResult } from '@hesed/plugin-lib';
 import { BaseCommand } from '../../base-command.js';
 export default class MySQLDescribeTable extends BaseCommand {
     static args: {
@@ -6,8 +7,8 @@ export default class MySQLDescribeTable extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
-        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        toon: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<unknown>;
+    run(): Promise<ApiResult>;
 }

package/dist/commands/mysql/describe-table.js

@@ -8,24 +8,21 @@ export default class MySQLDescribeTable extends BaseCommand {
     static description = 'Describe the structure of a MySQL table';
     static examples = [
         '<%= config.bin %> <%= command.id %> users',
-        '<%= config.bin %> <%= command.id %> orders --format json -p prod',
+        '<%= config.bin %> <%= command.id %> orders --toon -p prod',
     ];
     static flags = {
-        format: Flags.string({
-            default: 'table',
-            description: 'Output format',
-            options: ['table', 'json', 'toon'],
-        }),
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
+        toon: Flags.boolean({ description: 'Format output as toon', required: false }),
     };
     async run() {
         const { args, flags } = await this.parse(MySQLDescribeTable);
-        const result = await describeTable(this.config, args.table, flags.profile, flags.format);
+        const result = await describeTable(this.config, args.table, flags.profile, flags.toon ? 'toon' : flags.json ? 'json' : 'table');
         await closeConnections();
         if (result.success) {
-            this.log(result.result ?? '');
+            this.log(result.data?.result ?? '');
+            delete result.data.result;
             return result;
         }
-        this.error(result.error ?? 'Failed to describe table');
+        this.error(String(result.error ?? 'Failed to describe table'));
     }
 }

package/dist/commands/mysql/{explain-query.d.ts → explain.d.ts}

@@ -1,3 +1,4 @@
+import { ApiResult } from '@hesed/plugin-lib';
 import { BaseCommand } from '../../base-command.js';
 export default class MySQLExplain extends BaseCommand {
     static args: {
@@ -6,8 +7,8 @@ export default class MySQLExplain extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
-        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        toon: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<unknown>;
+    run(): Promise<ApiResult>;
 }

package/dist/commands/mysql/{explain-query.js → explain.js}

@@ -8,24 +8,21 @@ export default class MySQLExplain extends BaseCommand {
     static description = 'Show the execution plan for a MySQL query';
     static 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',
+        '<%= config.bin %> <%= command.id %> "SELECT * FROM orders JOIN users ON orders.user_id = users.id" --json',
     ];
     static flags = {
-        format: Flags.string({
-            default: 'table',
-            description: 'Output format',
-            options: ['table', 'json', 'toon'],
-        }),
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
+        toon: Flags.boolean({ description: 'Format output as toon', required: false }),
     };
     async run() {
         const { args, flags } = await this.parse(MySQLExplain);
-        const result = await explainQuery(this.config, args.query, flags.profile, flags.format);
+        const result = await explainQuery(this.config, args.query, flags.profile, flags.toon ? 'toon' : flags.json ? 'json' : 'table');
         await closeConnections();
         if (result.success) {
-            this.log(result.result ?? '');
+            this.log(result.data?.result ?? '');
+            delete result.data.result;
             return result;
         }
-        this.error(result.error ?? 'Failed to explain query');
+        this.error(String(result.error ?? 'Failed to explain query'));
     }
 }

package/dist/commands/mysql/indexes.d.ts

@@ -1,3 +1,4 @@
+import { ApiResult } from '@hesed/plugin-lib';
 import { BaseCommand } from '../../base-command.js';
 export default class MySQLIndexes extends BaseCommand {
     static args: {
@@ -6,8 +7,8 @@ export default class MySQLIndexes extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
-        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        toon: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<unknown>;
+    run(): Promise<ApiResult>;
 }

package/dist/commands/mysql/indexes.js

@@ -8,24 +8,21 @@ export default class MySQLIndexes extends BaseCommand {
     static description = 'Show indexes for a MySQL table';
     static examples = [
         '<%= config.bin %> <%= command.id %> users',
-        '<%= config.bin %> <%= command.id %> orders --format json -p prod',
+        '<%= config.bin %> <%= command.id %> orders --json -p prod',
     ];
     static flags = {
-        format: Flags.string({
-            default: 'table',
-            description: 'Output format',
-            options: ['table', 'json', 'toon'],
-        }),
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
+        toon: Flags.boolean({ description: 'Format output as toon', required: false }),
     };
     async run() {
         const { args, flags } = await this.parse(MySQLIndexes);
-        const result = await showIndexes(this.config, args.table, flags.profile, flags.format);
+        const result = await showIndexes(this.config, args.table, flags.profile, flags.toon ? 'toon' : flags.json ? 'json' : 'table');
         await closeConnections();
         if (result.success) {
-            this.log(result.result ?? '');
+            this.log(result.data?.result ?? '');
+            delete result.data.result;
             return result;
         }
-        this.error(result.error ?? 'Failed to show indexes');
+        this.error(String(result.error ?? 'Failed to show indexes'));
     }
 }

package/dist/commands/mysql/query.d.ts

@@ -1,3 +1,4 @@
+import { ApiResult } from '@hesed/plugin-lib';
 import { BaseCommand } from '../../base-command.js';
 export default class MySQLQuery extends BaseCommand {
     static args: {
@@ -6,9 +7,9 @@ export default class MySQLQuery extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
-        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'skip-confirmation': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        toon: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<unknown>;
+    run(): Promise<ApiResult>;
 }

package/dist/commands/mysql/query.js

@@ -7,40 +7,37 @@ export default class MySQLQuery extends BaseCommand {
     };
     static description = 'Execute a SQL query against a MySQL database';
     static 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 %> "SELECT * FROM users LIMIT 10" --json',
+        '<%= config.bin %> <%= command.id %> "UPDATE users SET email = \'user@email.com\' WHERE id = 999"',
         '<%= config.bin %> <%= command.id %> "DELETE FROM sessions" -p prod --skip-confirmation',
     ];
     static flags = {
-        format: Flags.string({
-            default: 'table',
-            description: 'Output format',
-            options: ['table', 'json', 'csv', 'toon'],
-        }),
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
         'skip-confirmation': Flags.boolean({
             default: false,
             description: 'Skip confirmation prompt for destructive operations',
         }),
+        toon: Flags.boolean({ description: 'Format output as toon', required: false }),
     };
     async run() {
         const { args, flags } = await this.parse(MySQLQuery);
-        const result = await executeQuery(this.config, args.query, flags.profile, flags.format, flags['skip-confirmation']);
+        const result = await executeQuery(this.config, args.query, flags.profile, flags.toon ? 'toon' : flags.json ? 'json' : 'table', flags['skip-confirmation']);
         await closeConnections();
         if (result.success) {
             // Notices (warnings, row counts) go to stderr so machine-readable formats
             // leave stdout as clean, parseable data.
-            if (result.notices)
-                this.logToStderr(result.notices);
-            if (this.jsonEnabled())
-                return this.parseJsonOutput(result.result);
-            this.log(result.result ?? '');
+            if (result.data?.notices)
+                this.logToStderr(result.data.notices);
+            // result is a formatted string for human/csv/toon output; for --json it
+            // holds the parsed payload, but jsonEnabled() suppresses log() in that case.
+            this.log(typeof result.data?.result === 'string' ? result.data.result : '');
+            delete result.data.notices;
             return result;
         }
-        if (result.requiresConfirmation) {
-            this.log(`${result.message ?? 'Destructive operation requires confirmation.'}\nRe-run with --skip-confirmation to proceed.`);
+        if (result.data?.requiresConfirmation) {
+            this.log(`${result.data?.message ?? 'Destructive operation requires confirmation.'}\nRe-run with --skip-confirmation to proceed.`);
             return result;
         }
-        this.error(result.error ?? 'Query failed');
+        this.error(String(result.error ?? 'Query failed'));
     }
 }

package/dist/commands/mysql/tables.d.ts

@@ -1,10 +1,10 @@
-import { Command } from '@oclif/core';
-export default class MySQLTables extends Command {
+import type { ApiResult } from '@hesed/plugin-lib';
+import { BaseCommand } from '../../base-command.js';
+export default class MySQLTables extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    jsonEnabled(): boolean;
-    run(): Promise<string[]>;
+    run(): Promise<ApiResult>;
 }

package/dist/commands/mysql/tables.js

@@ -1,21 +1,21 @@
-import { Command, Flags } from '@oclif/core';
+import { Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
 import { closeConnections, listTables } from '../../mysql/index.js';
-export default class MySQLTables extends Command {
+export default class MySQLTables extends BaseCommand {
     static description = 'List all tables in the current MySQL database';
     static examples = ['<%= config.bin %> <%= command.id %>', '<%= config.bin %> <%= command.id %> -p local'];
     static flags = {
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
     };
-    jsonEnabled() {
-        return true;
-    }
     async run() {
         const { flags } = await this.parse(MySQLTables);
         const result = await listTables(this.config, flags.profile);
         await closeConnections();
         if (result.success) {
-            return result.tables ?? [];
+            this.log(result.data?.result ?? '');
+            delete result.data.result;
+            return result;
         }
-        this.error(result.error ?? 'Failed to list tables');
+        this.error(String(result.error ?? 'Failed to list tables'));
     }
 }

package/dist/mysql/database.d.ts

@@ -1,49 +1,57 @@
-export interface QueryResult {
-    error?: string;
+import type { ApiResult } from '@hesed/plugin-lib';
+export type OutputFormat = 'csv' | 'json' | 'table' | 'toon';
+export interface QueryData {
     message?: string;
     notices?: string;
     requiresConfirmation?: boolean;
-    result?: string;
-    success: boolean;
+    result?: unknown;
 }
-export interface DatabaseListResult {
-    databases?: string[];
-    error?: string;
+export interface DatabaseListData {
+    databases: string[];
     result?: string;
-    success: boolean;
 }
-export interface TableListResult {
-    error?: string;
+export interface TableListData {
     result?: string;
-    success: boolean;
-    tables?: string[];
+    tables: string[];
 }
-export interface TableStructureResult {
-    error?: string;
+export interface TableStructureData {
     result?: string;
-    structure?: Record<string, unknown>[];
-    success: boolean;
+    structure: Record<string, unknown>[];
 }
-export interface IndexResult {
-    error?: string;
-    indexes?: Record<string, unknown>[];
+export interface IndexData {
+    indexes: Record<string, unknown>[];
     result?: string;
-    success: boolean;
 }
-export interface ExplainResult {
-    error?: string;
-    plan?: Record<string, unknown>[];
+export interface ExplainData {
+    plan: Record<string, unknown>[];
     result?: string;
-    success: boolean;
 }
-export interface ConnectionTestResult {
-    database?: string;
-    error?: string;
+interface ConnectionTestData {
+    database: string;
     result?: string;
-    success: boolean;
-    version?: string;
+    version: string;
 }
-export type OutputFormat = 'csv' | 'json' | 'table' | 'toon';
+export type QueryResult = ApiResult & {
+    data?: QueryData;
+};
+export type DatabaseListResult = ApiResult & {
+    data?: DatabaseListData;
+};
+export type TableListResult = ApiResult & {
+    data?: TableListData;
+};
+export type TableStructureResult = ApiResult & {
+    data?: TableStructureData;
+};
+export type IndexResult = ApiResult & {
+    data?: IndexData;
+};
+export type ExplainResult = ApiResult & {
+    data?: ExplainData;
+};
+export type ConnectionTestResult = ApiResult & {
+    data?: ConnectionTestData;
+};
 export interface DatabaseUtil {
     closeAll(): Promise<void>;
     describeTable(profileName: string, table: string, format?: OutputFormat): Promise<TableStructureResult>;
@@ -53,3 +61,4 @@ export interface DatabaseUtil {
     listTables(profileName: string): Promise<TableListResult>;
     showIndexes(profileName: string, table: string, format?: OutputFormat): Promise<IndexResult>;
 }
+export {};

package/dist/mysql/mysql-utils.js

@@ -19,8 +19,10 @@ export class MySQLUtil {
             const connection = await this.getConnection(profileName);
             const [rows, fields] = await connection.query(`DESCRIBE ${table}`);
             return {
-                result: this.formatRows(rows, fields, format),
-                structure: rows,
+                data: {
+                    result: this.formatRows(rows, fields, format),
+                    structure: rows,
+                },
                 success: true,
             };
         }
@@ -44,8 +46,10 @@ export class MySQLUtil {
             const confirmationCheck = requiresConfirmation(query, this.config.safety.requireConfirmationFor);
             if (confirmationCheck.required) {
                 return {
-                    message: `${confirmationCheck.message}\nQuery: ${query}`,
-                    requiresConfirmation: true,
+                    data: {
+                        message: `${confirmationCheck.message}\nQuery: ${query}`,
+                        requiresConfirmation: true,
+                    },
                     success: false,
                 };
             }
@@ -71,15 +75,20 @@ export class MySQLUtil {
             const connection = await this.getConnection(profileName);
             const [rows, fields] = await connection.query(finalQuery);
             const isRead = queryType === 'SELECT' || queryType === 'SHOW' || queryType === 'DESCRIBE' || queryType === 'EXPLAIN';
-            const data = isRead
+            let data = isRead
                 ? this.formatReadResult(rows, fields, format, notices)
-                : this.formatWriteResult(rows, notices);
+                : this.formatWriteResult(rows, notices, format);
+            if (format === 'json') {
+                data = JSON.parse(data);
+            }
             const notice = notices.join('\n\n');
             // For human (table) output everything stays on stdout, exactly as before.
             // For machine formats the data is returned alone and notices go to stderr.
             return {
-                notices: machineFormat ? notice : undefined,
-                result: machineFormat ? data : `${notice}\n\n${data}`,
+                data: {
+                    notices: machineFormat ? notice : undefined,
+                    result: machineFormat ? data : `${notice}\n\n${data}`,
+                },
                 success: true,
             };
         }
@@ -96,8 +105,10 @@ export class MySQLUtil {
             const connection = await this.getConnection(profileName);
             const [rows, fields] = await connection.query(`EXPLAIN ${query}`);
             return {
-                plan: rows,
-                result: this.formatRows(rows, fields, format),
+                data: {
+                    plan: rows,
+                    result: this.formatRows(rows, fields, format),
+                },
                 success: true,
             };
         }
@@ -115,8 +126,10 @@ export class MySQLUtil {
             const [rows] = await connection.query('SHOW DATABASES');
             const databases = rows.map((row) => row.Database);
             return {
-                databases,
-                result: `Databases:\n${databases.map((db) => `  • ${db}`).join('\n')}`,
+                data: {
+                    databases,
+                    result: `Databases:\n${databases.map((db) => `  • ${db}`).join('\n')}`,
+                },
                 success: true,
             };
         }
@@ -136,9 +149,11 @@ export class MySQLUtil {
             const tableKey = Object.keys(rowsArray[0])[0];
             const tables = rowsArray.map((row) => row[tableKey]);
             return {
-                result: `Tables in database:\n${tables.map((table) => `  • ${table}`).join('\n')}`,
+                data: {
+                    result: `Tables in database:\n${tables.map((table) => `  • ${table}`).join('\n')}`,
+                    tables,
+                },
                 success: true,
-                tables,
             };
         }
         catch (error) {
@@ -154,8 +169,10 @@ export class MySQLUtil {
             const connection = await this.getConnection(profileName);
             const [rows, fields] = await connection.query(`SHOW INDEXES FROM ${table}`);
             return {
-                indexes: rows,
-                result: this.formatRows(rows, fields, format),
+                data: {
+                    indexes: rows,
+                    result: this.formatRows(rows, fields, format),
+                },
                 success: true,
             };
         }
@@ -173,10 +190,12 @@ export class MySQLUtil {
             const [rows] = await connection.query('SELECT VERSION() as version, DATABASE() as current_database');
             const info = rows[0];
             return {
-                database: info.current_database,
-                result: `Connection successful!\n\nProfile: ${profileName}\nMySQL Version: ${info.version}\nCurrent Database: ${info.current_database}`,
+                data: {
+                    database: info.current_database,
+                    result: `Connection successful!\n\nProfile: ${profileName}\nMySQL Version: ${info.version}\nCurrent Database: ${info.current_database}`,
+                    version: info.version,
+                },
                 success: true,
-                version: info.version,
             };
         }
         catch (error) {
@@ -195,10 +214,18 @@ export class MySQLUtil {
     formatRows(rows, fields, format) {
         return FORMATTERS[format](rows, fields);
     }
-    formatWriteResult(rows, notices) {
+    formatWriteResult(rows, notices, format) {
         const affectedRows = rows.affectedRows ?? 0;
         const insertId = rows.insertId ?? null;
         notices.push('Query executed successfully.');
+        // The caller JSON.parses the result for json output, so emit valid JSON
+        // here rather than the human-readable string (which would throw on parse).
+        if (format === 'json') {
+            const payload = { affectedRows };
+            if (insertId)
+                payload.insertId = insertId;
+            return JSON.stringify(payload, null, 2);
+        }
         let data = `Affected rows: ${affectedRows}\n`;
         if (insertId)
             data += `Insert ID: ${insertId}\n`;

package/oclif.manifest.json

@@ -54,7 +54,7 @@
       "description": "Describe the structure of a MySQL table",
       "examples": [
         "<%= config.bin %> <%= command.id %> users",
-        "<%= config.bin %> <%= command.id %> orders --format json -p prod"
+        "<%= config.bin %> <%= command.id %> orders --toon -p prod"
       ],
       "flags": {
         "json": {
@@ -64,19 +64,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "description": "Output format",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "table",
-            "json",
-            "toon"
-          ],
-          "type": "option"
-        },
         "profile": {
           "char": "p",
           "description": "Database profile name from config",
@@ -85,6 +72,13 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "toon": {
+          "description": "Format output as toon",
+          "name": "toon",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -103,7 +97,7 @@
         "describe-table.js"
       ]
     },
-    "mysql:explain-query": {
+    "mysql:explain": {
       "aliases": [],
       "args": {
         "query": {
@@ -115,7 +109,7 @@
       "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"
+        "<%= config.bin %> <%= command.id %> \"SELECT * FROM orders JOIN users ON orders.user_id = users.id\" --json"
       ],
       "flags": {
         "json": {
@@ -125,19 +119,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "description": "Output format",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "table",
-            "json",
-            "toon"
-          ],
-          "type": "option"
-        },
         "profile": {
           "char": "p",
           "description": "Database profile name from config",
@@ -146,11 +127,18 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "toon": {
+          "description": "Format output as toon",
+          "name": "toon",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "mysql:explain-query",
+      "id": "mysql:explain",
       "pluginAlias": "@hesed/mysql",
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
@@ -161,7 +149,7 @@
         "dist",
         "commands",
         "mysql",
-        "explain-query.js"
+        "explain.js"
       ]
     },
     "mysql:indexes": {
@@ -176,7 +164,7 @@
       "description": "Show indexes for a MySQL table",
       "examples": [
         "<%= config.bin %> <%= command.id %> users",
-        "<%= config.bin %> <%= command.id %> orders --format json -p prod"
+        "<%= config.bin %> <%= command.id %> orders --json -p prod"
       ],
       "flags": {
         "json": {
@@ -186,19 +174,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "description": "Output format",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "table",
-            "json",
-            "toon"
-          ],
-          "type": "option"
-        },
         "profile": {
           "char": "p",
           "description": "Database profile name from config",
@@ -207,6 +182,13 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "toon": {
+          "description": "Format output as toon",
+          "name": "toon",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -236,8 +218,8 @@
       },
       "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 %> \"SELECT * FROM users LIMIT 10\" --json",
+        "<%= config.bin %> <%= command.id %> \"UPDATE users SET email = 'user@email.com' WHERE id = 999\"",
         "<%= config.bin %> <%= command.id %> \"DELETE FROM sessions\" -p prod --skip-confirmation"
       ],
       "flags": {
@@ -248,20 +230,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "description": "Output format",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "table",
-            "json",
-            "csv",
-            "toon"
-          ],
-          "type": "option"
-        },
         "profile": {
           "char": "p",
           "description": "Database profile name from config",
@@ -276,6 +244,13 @@
           "name": "skip-confirmation",
           "allowNo": false,
           "type": "boolean"
+        },
+        "toon": {
+          "description": "Format output as toon",
+          "name": "toon",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -303,6 +278,13 @@
         "<%= config.bin %> <%= command.id %> -p local"
       ],
       "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "profile": {
           "char": "p",
           "description": "Database profile name from config",
@@ -320,7 +302,7 @@
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -675,5 +657,5 @@
       ]
     }
   },
-  "version": "0.5.1"
+  "version": "0.5.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hesed/mysql",
   "description": "CLI for MySQL database interaction",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "author": "Hesed",
   "bin": {
     "mq": "./bin/run.js"
@@ -49,7 +49,7 @@
   ],
   "homepage": "https://github.com/hesedcasa/mysql",
   "keywords": [
-    "oclif"
+    "mysql"
   ],
   "license": "Apache-2.0",
   "main": "dist/index.js",