@memberjunction/db-auto-doc 2.117.0 → 2.119.0

package/dist/generators/SQLGenerator.js

@@ -0,0 +1,168 @@
+"use strict";
+/**
+ * Generates SQL scripts with sp_addextendedproperty statements
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQLGenerator = void 0;
+class SQLGenerator {
+    /**
+     * Generate SQL script
+     */
+    generate(state, options = {}) {
+        const lines = [];
+        // Header
+        lines.push('-- Database Documentation Script');
+        lines.push(`-- Generated: ${new Date().toISOString()}`);
+        lines.push(`-- Database: ${state.database.name}`);
+        lines.push(`-- Server: ${state.database.server}`);
+        lines.push('');
+        lines.push('-- This script adds MS_Description extended properties to database objects');
+        lines.push('');
+        // Generate statements for each schema
+        for (const schema of state.schemas) {
+            lines.push('');
+            lines.push(`-- Schema: ${schema.name}`);
+            lines.push('');
+            // Schema description
+            if (schema.description) {
+                lines.push(this.generateSchemaDescription(schema.name, schema.description));
+                lines.push('GO');
+                lines.push('');
+            }
+            // Table descriptions
+            for (const table of schema.tables) {
+                // Check filters
+                if (options.approvedOnly && !table.userApproved) {
+                    continue;
+                }
+                if (options.confidenceThreshold && table.descriptionIterations.length > 0) {
+                    const latest = table.descriptionIterations[table.descriptionIterations.length - 1];
+                    if ((latest.confidence || 0) < options.confidenceThreshold) {
+                        continue;
+                    }
+                }
+                // Table description
+                if (table.description) {
+                    lines.push(`-- Table: ${schema.name}.${table.name}`);
+                    lines.push(this.generateTableDescription(schema.name, table.name, table.description));
+                    lines.push('GO');
+                    lines.push('');
+                }
+                // Column descriptions
+                for (const column of table.columns) {
+                    if (column.description) {
+                        lines.push(this.generateColumnDescription(schema.name, table.name, column.name, column.description));
+                        lines.push('GO');
+                    }
+                }
+                lines.push('');
+            }
+        }
+        return lines.join('\n');
+    }
+    /**
+     * Generate schema description statement
+     */
+    generateSchemaDescription(schemaName, description) {
+        const escapedDescription = this.escapeString(description);
+        return `
+IF EXISTS (
+    SELECT 1 FROM sys.extended_properties
+    WHERE major_id = SCHEMA_ID('${schemaName}')
+    AND name = 'MS_Description'
+    AND minor_id = 0
+)
+BEGIN
+    EXEC sp_dropextendedproperty
+        @name = N'MS_Description',
+        @level0type = N'SCHEMA',
+        @level0name = N'${schemaName}';
+END
+
+EXEC sp_addextendedproperty
+    @name = N'MS_Description',
+    @value = N'${escapedDescription}',
+    @level0type = N'SCHEMA',
+    @level0name = N'${schemaName}';
+`.trim();
+    }
+    /**
+     * Generate table description statement
+     */
+    generateTableDescription(schemaName, tableName, description) {
+        const escapedDescription = this.escapeString(description);
+        return `
+IF EXISTS (
+    SELECT 1 FROM sys.extended_properties ep
+    INNER JOIN sys.tables t ON ep.major_id = t.object_id
+    INNER JOIN sys.schemas s ON t.schema_id = s.schema_id
+    WHERE s.name = '${schemaName}'
+    AND t.name = '${tableName}'
+    AND ep.name = 'MS_Description'
+    AND ep.minor_id = 0
+)
+BEGIN
+    EXEC sp_dropextendedproperty
+        @name = N'MS_Description',
+        @level0type = N'SCHEMA',
+        @level0name = N'${schemaName}',
+        @level1type = N'TABLE',
+        @level1name = N'${tableName}';
+END
+
+EXEC sp_addextendedproperty
+    @name = N'MS_Description',
+    @value = N'${escapedDescription}',
+    @level0type = N'SCHEMA',
+    @level0name = N'${schemaName}',
+    @level1type = N'TABLE',
+    @level1name = N'${tableName}';
+`.trim();
+    }
+    /**
+     * Generate column description statement
+     */
+    generateColumnDescription(schemaName, tableName, columnName, description) {
+        const escapedDescription = this.escapeString(description);
+        return `
+IF EXISTS (
+    SELECT 1 FROM sys.extended_properties ep
+    INNER JOIN sys.tables t ON ep.major_id = t.object_id
+    INNER JOIN sys.schemas s ON t.schema_id = s.schema_id
+    INNER JOIN sys.columns c ON ep.major_id = c.object_id AND ep.minor_id = c.column_id
+    WHERE s.name = '${schemaName}'
+    AND t.name = '${tableName}'
+    AND c.name = '${columnName}'
+    AND ep.name = 'MS_Description'
+)
+BEGIN
+    EXEC sp_dropextendedproperty
+        @name = N'MS_Description',
+        @level0type = N'SCHEMA',
+        @level0name = N'${schemaName}',
+        @level1type = N'TABLE',
+        @level1name = N'${tableName}',
+        @level2type = N'COLUMN',
+        @level2name = N'${columnName}';
+END
+
+EXEC sp_addextendedproperty
+    @name = N'MS_Description',
+    @value = N'${escapedDescription}',
+    @level0type = N'SCHEMA',
+    @level0name = N'${schemaName}',
+    @level1type = N'TABLE',
+    @level1name = N'${tableName}',
+    @level2type = N'COLUMN',
+    @level2name = N'${columnName}';
+`.trim();
+    }
+    /**
+     * Escape string for SQL
+     */
+    escapeString(str) {
+        return str.replace(/'/g, "''");
+    }
+}
+exports.SQLGenerator = SQLGenerator;
+//# sourceMappingURL=SQLGenerator.js.map

package/dist/generators/SQLGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SQLGenerator.js","sourceRoot":"","sources":["../../src/generators/SQLGenerator.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AASH,MAAa,YAAY;IACvB;;OAEG;IACI,QAAQ,CACb,KAA4B,EAC5B,UAA+B,EAAE;QAEjC,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,SAAS;QACT,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACxD,KAAK,CAAC,IAAI,CAAC,gBAAgB,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,cAAc,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,4EAA4E,CAAC,CAAC;QACzF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,sCAAsC;QACtC,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACxC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAEf,qBAAqB;YACrB,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC5E,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;YAED,qBAAqB;YACrB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClC,gBAAgB;gBAChB,IAAI,OAAO,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBAChD,SAAS;gBACX,CAAC;gBAED,IAAI,OAAO,CAAC,mBAAmB,IAAI,KAAK,CAAC,qBAAqB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1E,MAAM,MAAM,GAAG,KAAK,CAAC,qBAAqB,CAAC,KAAK,CAAC,qBAAqB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBACnF,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;wBAC3D,SAAS;oBACX,CAAC;gBACH,CAAC;gBAED,oBAAoB;gBACpB,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;oBACtB,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;oBACrD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;oBACtF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACjB,CAAC;gBAED,sBAAsB;gBACtB,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBACnC,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;wBACvB,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,yBAAyB,CAC5B,MAAM,CAAC,IAAI,EACX,KAAK,CAAC,IAAI,EACV,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,WAAW,CACnB,CACF,CAAC;wBACF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACnB,CAAC;gBACH,CAAC;gBAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,yBAAyB,CAAC,UAAkB,EAAE,WAAmB;QACvE,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE1D,OAAO;;;kCAGuB,UAAU;;;;;;;;0BAQlB,UAAU;;;;;iBAKnB,kBAAkB;;sBAEb,UAAU;CAC/B,CAAC,IAAI,EAAE,CAAC;IACP,CAAC;IAED;;OAEG;IACK,wBAAwB,CAC9B,UAAkB,EAClB,SAAiB,EACjB,WAAmB;QAEnB,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE1D,OAAO;;;;;sBAKW,UAAU;oBACZ,SAAS;;;;;;;;0BAQH,UAAU;;0BAEV,SAAS;;;;;iBAKlB,kBAAkB;;sBAEb,UAAU;;sBAEV,SAAS;CAC9B,CAAC,IAAI,EAAE,CAAC;IACP,CAAC;IAED;;OAEG;IACK,yBAAyB,CAC/B,UAAkB,EAClB,SAAiB,EACjB,UAAkB,EAClB,WAAmB;QAEnB,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE1D,OAAO;;;;;;sBAMW,UAAU;oBACZ,SAAS;oBACT,UAAU;;;;;;;0BAOJ,UAAU;;0BAEV,SAAS;;0BAET,UAAU;;;;;iBAKnB,kBAAkB;;sBAEb,UAAU;;sBAEV,SAAS;;sBAET,UAAU;CAC/B,CAAC,IAAI,EAAE,CAAC;IACP,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,GAAW;QAC9B,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;CACF;AAlMD,oCAkMC"}

package/dist/generators/SampleQueryGenerator.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Sample Query Generator
+ * Generates reference SQL queries for AI agents using LLM-powered analysis
+ */
+import { PromptEngine } from '../prompts/PromptEngine.js';
+import { BaseAutoDocDriver } from '../drivers/BaseAutoDocDriver.js';
+import { SampleQueryGenerationResult, SampleQueryGenerationConfig } from '../types/sample-queries.js';
+import { SchemaDefinition } from '../types/state.js';
+export declare class SampleQueryGenerator {
+    private config;
+    private promptEngine;
+    private driver;
+    private model;
+    private effortLevel?;
+    private maxTokens;
+    private outputFilePath?;
+    private summaryFilePath?;
+    private totalTokensUsed;
+    private totalCost;
+    private startTime;
+    constructor(config: SampleQueryGenerationConfig, promptEngine: PromptEngine, driver: BaseAutoDocDriver, model: string, effortLevel?: number | undefined, maxTokens?: number, // Default from typical AI config
+    outputFilePath?: string | undefined, // Optional path for incremental query writes
+    summaryFilePath?: string | undefined);
+    generateQueries(schemas: SchemaDefinition[]): Promise<SampleQueryGenerationResult>;
+    private generateQueriesForSchema;
+    private selectImportantTables;
+    private calculateTableImportance;
+    /**
+     * Generate queries using two-prompt approach:
+     * 1. Plan what queries to create (lightweight)
+     * 2. Generate SQL for each query individually (detailed)
+     */
+    private generateQueriesForTable;
+    /**
+     * PHASE 1: Plan what queries to create (lightweight, all at once)
+     */
+    private planQueries;
+    /**
+     * PHASE 2: Generate SQL for a single query (detailed)
+     */
+    private generateQuerySQL;
+    private buildQueryGenerationContext;
+    private getRelatedTables;
+    private convertToTableContext;
+    private convertToColumnContext;
+    private getDatabaseType;
+    private getSeedContextDescription;
+    private parseQueryGenerationResponse;
+    private processGeneratedQueries;
+    private validateQuery;
+    private prepareValidationQuery;
+    private getSampleParameterValue;
+    private aggregateQueryMetrics;
+    /**
+     * Write queries and summary to files incrementally after each table completes
+     * This allows users to cancel the run and still see completed queries and progress
+     */
+    private writeIncrementalOutput;
+    /**
+     * Calculate summary statistics from current set of queries
+     */
+    private calculateSummary;
+}
+//# sourceMappingURL=SampleQueryGenerator.d.ts.map

package/dist/generators/SampleQueryGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SampleQueryGenerator.d.ts","sourceRoot":"","sources":["../../src/generators/SampleQueryGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEpE,OAAO,EAEL,2BAA2B,EAE3B,2BAA2B,EAU5B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,mBAAmB,CAAC;AA6CtE,qBAAa,oBAAoB;IAM7B,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,WAAW,CAAC;IACpB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,cAAc,CAAC;IACvB,OAAO,CAAC,eAAe,CAAC;IAZ1B,OAAO,CAAC,eAAe,CAAa;IACpC,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,SAAS,CAAa;gBAGpB,MAAM,EAAE,2BAA2B,EACnC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,MAAM,EACb,WAAW,CAAC,oBAAQ,EACpB,SAAS,GAAE,MAAc,EAAG,iCAAiC;IAC7D,cAAc,CAAC,oBAAQ,EAAG,6CAA6C;IACvE,eAAe,CAAC,oBAAQ;IAGrB,eAAe,CAC1B,OAAO,EAAE,gBAAgB,EAAE,GAC1B,OAAO,CAAC,2BAA2B,CAAC;YAsDzB,wBAAwB;IAqCtC,OAAO,CAAC,qBAAqB;IAqB7B,OAAO,CAAC,wBAAwB;IAkBhC;;;;OAIG;YACW,uBAAuB;IAsDrC;;OAEG;YACW,WAAW;IAkDzB;;OAEG;YACW,gBAAgB;IA8C9B,OAAO,CAAC,2BAA2B;IAanC,OAAO,CAAC,gBAAgB;IAkBxB,OAAO,CAAC,qBAAqB;IAmB7B,OAAO,CAAC,sBAAsB;IA4B9B,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,4BAA4B;YAYtB,uBAAuB;YA+CvB,aAAa;IA4B3B,OAAO,CAAC,sBAAsB;IA2B9B,OAAO,CAAC,uBAAuB;IA2B/B,OAAO,CAAC,qBAAqB;IAgB7B;;;OAGG;YACW,sBAAsB;IA2BpC;;OAEG;IACH,OAAO,CAAC,gBAAgB;CAmBzB"}