@memberjunction/cli 2.124.0 → 2.126.0

package/README.md

@@ -689,6 +689,106 @@ mj sync push ./metadata/queries/
 
 ---
 
+### `mj querygen` - AI-Powered SQL Query Generation
+
+Generate domain-specific SQL query templates using artificial intelligence. QueryGen analyzes your database schema, generates business questions, creates SQL queries with Nunjucks templates, tests them, and exports to metadata format.
+
+```bash
+mj querygen [COMMAND] [OPTIONS]
+```
+
+Available querygen commands:
+- `generate` - Generate SQL query templates for entities using AI
+- `validate` - Validate existing query templates
+- `export` - Export queries from database to metadata files
+
+**📚 For detailed documentation:** See the [QueryGen README](../QueryGen/README.md)
+
+#### Quick Examples:
+
+```bash
+# Generate queries for all entities
+mj querygen generate
+
+# Generate for specific entities with verbose output
+mj querygen generate --entities "Customers,Orders" --verbose
+
+# Control entity grouping and refinement
+mj querygen generate --max-entities 2 --max-refinements 3
+
+# Export to specific directory
+mj querygen generate --output ./metadata/queries
+
+# Choose output mode
+mj querygen generate --mode database  # Write directly to database
+mj querygen generate --mode both      # Both metadata and database
+
+# Validate existing queries
+mj querygen validate
+
+# Validate specific directory
+mj querygen validate --path ./metadata/queries --verbose
+
+# Export queries from database to metadata
+mj querygen export
+
+# Export to custom location
+mj querygen export --output ./exported-queries --verbose
+```
+
+#### QueryGen Command Options:
+
+**Generate Command:**
+- `-e, --entities <value>`: Specific entities to generate queries for (comma-separated)
+- `-x, --exclude-entities <value>`: Entities to exclude (comma-separated)
+- `-s, --exclude-schemas <value>`: Schemas to exclude (comma-separated)
+- `-m, --max-entities <value>`: Max entities per group (default: 3)
+- `-r, --max-refinements <value>`: Max refinement iterations (default: 3)
+- `-f, --max-fixes <value>`: Max error-fixing attempts (default: 5)
+- `--model <value>`: Preferred AI model
+- `--vendor <value>`: Preferred AI vendor
+- `-o, --output <value>`: Output directory (default: ./metadata/queries)
+- `--mode <option>`: Output mode: metadata|database|both (default: metadata)
+- `-v, --verbose`: Verbose output
+
+**Validate Command:**
+- `-p, --path <value>`: Path to queries metadata file or directory (default: ./metadata/queries)
+- `-v, --verbose`: Verbose output
+
+**Export Command:**
+- `-o, --output <value>`: Output directory (default: ./metadata/queries)
+- `-v, --verbose`: Verbose output
+
+#### QueryGen Features:
+
+**11-Phase Pipeline:**
+1. Entity Analysis - Analyzes database schema and relationships
+2. Entity Grouping - Creates logical groups of related entities
+3. Business Question Generation - Uses AI to generate domain questions
+4. Vector Similarity Search - Finds similar examples for few-shot learning
+5. SQL Generation - Creates Nunjucks SQL templates with AI
+6. Query Testing - Executes and validates queries
+7. Error Fixing - Automatically fixes SQL errors using AI
+8. Query Evaluation - Assesses query quality
+9. Query Refinement - Iteratively improves queries
+10. Testing & Validation - Comprehensive validation workflow
+11. Metadata Export - Exports to MJ metadata or database
+
+**AI-Powered Features:**
+- Generates realistic business questions for your domain
+- Creates SQL queries with proper Nunjucks templating
+- Automatically tests and fixes SQL errors
+- Refines queries based on evaluation feedback
+- Uses few-shot learning with golden query examples
+
+**Integration:**
+- Outputs to MemberJunction metadata format
+- Compatible with `mj sync push` for database synchronization
+- Supports both metadata files and direct database writes
+- Uses MJ's Query entity with automatic field/parameter extraction
+
+---
+
 ### Utility Commands
 
 #### `mj help`
@@ -721,6 +821,7 @@ The CLI integrates seamlessly with other MemberJunction packages:
 
 - **[@memberjunction/codegen-lib](../CodeGenLib)**: Powers the code generation functionality
 - **[@memberjunction/metadata-sync](../MetadataSync)**: Provides metadata synchronization capabilities ([README](../MetadataSync/README.md))
+- **[@memberjunction/query-gen](../QueryGen)**: AI-powered SQL query template generation ([README](../QueryGen/README.md))
 - **[@memberjunction/ai-cli](../AI/AICLI)**: Enables AI agent and action execution ([README](../AI/AICLI/README.md))
 - **[@memberjunction/testing-cli](../TestingFramework/CLI)**: Testing framework for database-driven tests ([README](../TestingFramework/CLI/README.md))
 - **[@memberjunction/db-auto-doc](../DBAutoDoc)**: AI-powered database documentation generator ([README](../DBAutoDoc/README.md))

package/dist/commands/querygen/export.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class Export extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/querygen/export.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const query_gen_1 = require("@memberjunction/query-gen");
+const metadata_sync_1 = require("@memberjunction/metadata-sync");
+class Export extends core_1.Command {
+    static description = 'Export queries from database to metadata files';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>`,
+        `<%= config.bin %> <%= command.id %> --output ./metadata/queries`,
+        `<%= config.bin %> <%= command.id %> --verbose`,
+    ];
+    static flags = {
+        output: core_1.Flags.string({
+            char: 'o',
+            description: 'Output directory',
+            default: './metadata/queries'
+        }),
+        verbose: core_1.Flags.boolean({ char: 'v', description: 'Verbose output' }),
+    };
+    async run() {
+        const { flags } = await this.parse(Export);
+        try {
+            // Load MJ configuration and initialize provider
+            const mjConfig = (0, metadata_sync_1.loadMJConfig)();
+            if (!mjConfig) {
+                this.error('No mj.config.cjs found in current directory or parent directories');
+            }
+            await (0, metadata_sync_1.initializeProvider)(mjConfig);
+            // Convert flags to options object for QueryGen
+            const options = {
+                output: flags.output,
+                verbose: flags.verbose
+            };
+            // Call QueryGen export command
+            await (0, query_gen_1.exportCommand)(options);
+        }
+        catch (error) {
+            // QueryGen commands call process.exit(), so this may not be reached
+            // But we handle it just in case
+            this.error(error);
+        }
+    }
+}
+exports.default = Export;

package/dist/commands/querygen/generate.d.ts

@@ -0,0 +1,20 @@
+import { Command } from '@oclif/core';
+export default class Generate extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        entities: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'exclude-entities': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'exclude-schemas': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'max-entities': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'target-groups': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'max-refinements': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'max-fixes': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        model: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        vendor: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        output: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        mode: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/querygen/generate.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const query_gen_1 = require("@memberjunction/query-gen");
+const metadata_sync_1 = require("@memberjunction/metadata-sync");
+const aiengine_1 = require("@memberjunction/aiengine");
+class Generate extends core_1.Command {
+    static description = 'Generate SQL query templates for entities using AI';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>`,
+        `<%= config.bin %> <%= command.id %> --entities "Customers,Orders"`,
+        `<%= config.bin %> <%= command.id %> --max-entities 5 --verbose`,
+        `<%= config.bin %> <%= command.id %> --mode database`,
+    ];
+    static flags = {
+        entities: core_1.Flags.string({
+            char: 'e',
+            description: 'Specific entities to generate queries for (comma-separated)',
+            multiple: false
+        }),
+        'exclude-entities': core_1.Flags.string({
+            char: 'x',
+            description: 'Entities to exclude (comma-separated)',
+            multiple: false
+        }),
+        'exclude-schemas': core_1.Flags.string({
+            char: 's',
+            description: 'Schemas to exclude (comma-separated)',
+            multiple: false
+        }),
+        'max-entities': core_1.Flags.integer({
+            char: 'm',
+            description: 'Max entities per group',
+            default: 3
+        }),
+        'target-groups': core_1.Flags.integer({
+            char: 't',
+            description: 'Target number of entity groups to generate',
+            default: 75
+        }),
+        'max-refinements': core_1.Flags.integer({
+            char: 'r',
+            description: 'Max refinement iterations',
+            default: 3
+        }),
+        'max-fixes': core_1.Flags.integer({
+            char: 'f',
+            description: 'Max error-fixing attempts',
+            default: 5
+        }),
+        model: core_1.Flags.string({ description: 'Preferred AI model' }),
+        vendor: core_1.Flags.string({ description: 'Preferred AI vendor' }),
+        output: core_1.Flags.string({
+            char: 'o',
+            description: 'Output directory',
+            default: './metadata/queries'
+        }),
+        mode: core_1.Flags.string({
+            description: 'Output mode: metadata|database|both',
+            default: 'metadata',
+            options: ['metadata', 'database', 'both']
+        }),
+        verbose: core_1.Flags.boolean({ char: 'v', description: 'Verbose output' }),
+    };
+    async run() {
+        const { flags } = await this.parse(Generate);
+        try {
+            // Load MJ configuration and initialize provider
+            const mjConfig = (0, metadata_sync_1.loadMJConfig)();
+            if (!mjConfig) {
+                this.error('No mj.config.cjs found in current directory or parent directories');
+            }
+            await (0, metadata_sync_1.initializeProvider)(mjConfig);
+            // Get system user and initialize AI Engine
+            const systemUser = (0, metadata_sync_1.getSystemUser)();
+            await aiengine_1.AIEngine.Instance.Config(false, systemUser);
+            // Convert flags to options object for QueryGen
+            const options = {
+                entities: flags.entities,
+                excludeEntities: flags['exclude-entities'],
+                excludeSchemas: flags['exclude-schemas'],
+                maxEntities: flags['max-entities'],
+                targetGroupCount: flags['target-groups'],
+                maxRefinements: flags['max-refinements'],
+                maxFixes: flags['max-fixes'],
+                model: flags.model,
+                vendor: flags.vendor,
+                output: flags.output,
+                mode: flags.mode,
+                verbose: flags.verbose
+            };
+            // Call QueryGen generate command
+            await (0, query_gen_1.generateCommand)(options);
+        }
+        catch (error) {
+            // QueryGen commands call process.exit(), so this may not be reached
+            // But we handle it just in case
+            this.error(error);
+        }
+    }
+}
+exports.default = Generate;

package/dist/commands/querygen/validate.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class Validate extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        path: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/querygen/validate.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const query_gen_1 = require("@memberjunction/query-gen");
+const metadata_sync_1 = require("@memberjunction/metadata-sync");
+class Validate extends core_1.Command {
+    static description = 'Validate existing query templates';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>`,
+        `<%= config.bin %> <%= command.id %> --path ./metadata/queries`,
+        `<%= config.bin %> <%= command.id %> --verbose`,
+    ];
+    static flags = {
+        path: core_1.Flags.string({
+            char: 'p',
+            description: 'Path to queries metadata file or directory',
+            default: './metadata/queries'
+        }),
+        verbose: core_1.Flags.boolean({ char: 'v', description: 'Verbose output' }),
+    };
+    async run() {
+        const { flags } = await this.parse(Validate);
+        try {
+            // Load MJ configuration and initialize provider
+            const mjConfig = (0, metadata_sync_1.loadMJConfig)();
+            if (!mjConfig) {
+                this.error('No mj.config.cjs found in current directory or parent directories');
+            }
+            await (0, metadata_sync_1.initializeProvider)(mjConfig);
+            // Convert flags to options object for QueryGen
+            const options = {
+                path: flags.path,
+                verbose: flags.verbose
+            };
+            // Call QueryGen validate command
+            await (0, query_gen_1.validateCommand)(options);
+        }
+        catch (error) {
+            // QueryGen commands call process.exit(), so this may not be reached
+            // But we handle it just in case
+            this.error(error);
+        }
+    }
+}
+exports.default = Validate;

package/oclif.manifest.json

@@ -94,6 +94,38 @@
         "index.js"
       ]
     },
+    "clean": {
+      "aliases": [],
+      "args": {},
+      "description": "Resets the MemberJunction database to a pre-installation state",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>\n"
+      ],
+      "flags": {
+        "verbose": {
+          "char": "v",
+          "description": "Enable additional logging",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "clean",
+      "pluginAlias": "@memberjunction/cli",
+      "pluginName": "@memberjunction/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "clean",
+        "index.js"
+      ]
+    },
     "codegen": {
       "aliases": [],
       "args": {},
@@ -562,10 +594,10 @@
         "status.js"
       ]
     },
-    "clean": {
+    "install": {
       "aliases": [],
       "args": {},
-      "description": "Resets the MemberJunction database to a pre-installation state",
+      "description": "Install MemberJunction",
       "examples": [
         "<%= config.bin %> <%= command.id %>\n"
       ],
@@ -580,7 +612,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "clean",
+      "id": "install",
       "pluginAlias": "@memberjunction/cli",
       "pluginName": "@memberjunction/cli",
       "pluginType": "core",
@@ -590,7 +622,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "clean",
+        "install",
         "index.js"
       ]
     },
@@ -634,17 +666,28 @@
         "index.js"
       ]
     },
-    "install": {
+    "querygen:export": {
       "aliases": [],
       "args": {},
-      "description": "Install MemberJunction",
+      "description": "Export queries from database to metadata files",
       "examples": [
-        "<%= config.bin %> <%= command.id %>\n"
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --output ./metadata/queries",
+        "<%= config.bin %> <%= command.id %> --verbose"
       ],
       "flags": {
+        "output": {
+          "char": "o",
+          "description": "Output directory",
+          "name": "output",
+          "default": "./metadata/queries",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "verbose": {
           "char": "v",
-          "description": "Enable additional logging",
+          "description": "Verbose output",
           "name": "verbose",
           "allowNo": false,
           "type": "boolean"
@@ -652,7 +695,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "install",
+      "id": "querygen:export",
       "pluginAlias": "@memberjunction/cli",
       "pluginName": "@memberjunction/cli",
       "pluginType": "core",
@@ -662,8 +705,182 @@
       "relativePath": [
         "dist",
         "commands",
-        "install",
-        "index.js"
+        "querygen",
+        "export.js"
+      ]
+    },
+    "querygen:generate": {
+      "aliases": [],
+      "args": {},
+      "description": "Generate SQL query templates for entities using AI",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --entities \"Customers,Orders\"",
+        "<%= config.bin %> <%= command.id %> --max-entities 5 --verbose",
+        "<%= config.bin %> <%= command.id %> --mode database"
+      ],
+      "flags": {
+        "entities": {
+          "char": "e",
+          "description": "Specific entities to generate queries for (comma-separated)",
+          "name": "entities",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "exclude-entities": {
+          "char": "x",
+          "description": "Entities to exclude (comma-separated)",
+          "name": "exclude-entities",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "exclude-schemas": {
+          "char": "s",
+          "description": "Schemas to exclude (comma-separated)",
+          "name": "exclude-schemas",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "max-entities": {
+          "char": "m",
+          "description": "Max entities per group",
+          "name": "max-entities",
+          "default": 3,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-groups": {
+          "char": "t",
+          "description": "Target number of entity groups to generate",
+          "name": "target-groups",
+          "default": 75,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "max-refinements": {
+          "char": "r",
+          "description": "Max refinement iterations",
+          "name": "max-refinements",
+          "default": 3,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "max-fixes": {
+          "char": "f",
+          "description": "Max error-fixing attempts",
+          "name": "max-fixes",
+          "default": 5,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "model": {
+          "description": "Preferred AI model",
+          "name": "model",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "vendor": {
+          "description": "Preferred AI vendor",
+          "name": "vendor",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "output": {
+          "char": "o",
+          "description": "Output directory",
+          "name": "output",
+          "default": "./metadata/queries",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "mode": {
+          "description": "Output mode: metadata|database|both",
+          "name": "mode",
+          "default": "metadata",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "metadata",
+            "database",
+            "both"
+          ],
+          "type": "option"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Verbose output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "querygen:generate",
+      "pluginAlias": "@memberjunction/cli",
+      "pluginName": "@memberjunction/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "querygen",
+        "generate.js"
+      ]
+    },
+    "querygen:validate": {
+      "aliases": [],
+      "args": {},
+      "description": "Validate existing query templates",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --path ./metadata/queries",
+        "<%= config.bin %> <%= command.id %> --verbose"
+      ],
+      "flags": {
+        "path": {
+          "char": "p",
+          "description": "Path to queries metadata file or directory",
+          "name": "path",
+          "default": "./metadata/queries",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Verbose output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "querygen:validate",
+      "pluginAlias": "@memberjunction/cli",
+      "pluginName": "@memberjunction/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "querygen",
+        "validate.js"
       ]
     },
     "sync:file-reset": {
@@ -2285,5 +2502,5 @@
       ]
     }
   },
-  "version": "2.124.0"
+  "version": "2.126.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/cli",
-  "version": "2.124.0",
+  "version": "2.126.0",
   "description": "MemberJunction command line tools",
   "keywords": [
     "oclif"
@@ -51,13 +51,14 @@
   },
   "dependencies": {
     "@inquirer/prompts": "^5.0.1",
-    "@memberjunction/ai-cli": "2.124.0",
-    "@memberjunction/codegen-lib": "2.124.0",
-    "@memberjunction/core": "2.124.0",
-    "@memberjunction/db-auto-doc": "2.124.0",
-    "@memberjunction/metadata-sync": "2.124.0",
-    "@memberjunction/sqlserver-dataprovider": "2.124.0",
-    "@memberjunction/testing-cli": "2.124.0",
+    "@memberjunction/ai-cli": "2.126.0",
+    "@memberjunction/codegen-lib": "2.126.0",
+    "@memberjunction/core": "2.126.0",
+    "@memberjunction/db-auto-doc": "2.126.0",
+    "@memberjunction/metadata-sync": "2.126.0",
+    "@memberjunction/query-gen": "2.126.0",
+    "@memberjunction/sqlserver-dataprovider": "2.126.0",
+    "@memberjunction/testing-cli": "2.126.0",
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-version": "^2.0.17",