@memberjunction/db-auto-doc 2.117.0 → 2.118.0

package/dist/core/AnalysisEngine.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Main analysis orchestrator
+ * Coordinates the entire documentation generation workflow
+ */
+import { DatabaseDocumentation, AnalysisRun, SchemaDefinition } from '../types/state.js';
+import { TableNode, BackpropagationTrigger } from '../types/analysis.js';
+import { DBAutoDocConfig } from '../types/config.js';
+import { PromptEngine } from '../prompts/PromptEngine.js';
+import { StateManager } from '../state/StateManager.js';
+import { IterationTracker } from '../state/IterationTracker.js';
+export declare class AnalysisEngine {
+    private config;
+    private promptEngine;
+    private stateManager;
+    private iterationTracker;
+    private backpropagationEngine;
+    private convergenceDetector;
+    private guardrailsManager;
+    private startTime;
+    private currentRun?;
+    constructor(config: DBAutoDocConfig, promptEngine: PromptEngine, stateManager: StateManager, iterationTracker: IterationTracker);
+    /**
+     * Initialize timing for guardrails and set current run
+     */
+    startAnalysis(run: AnalysisRun): void;
+    /**
+     * Process a single dependency level
+     */
+    processLevel(state: DatabaseDocumentation, run: AnalysisRun, level: number, tables: TableNode[]): Promise<BackpropagationTrigger[]>;
+    /**
+     * Analyze a single table
+     */
+    private analyzeTable;
+    /**
+     * Build context for table analysis
+     */
+    private buildTableContext;
+    /**
+     * Compare descriptions using LLM to determine material changes
+     */
+    private compareDescriptions;
+    /**
+     * Perform dependency-level sanity check
+     * Checks consistency across tables at the same dependency level
+     */
+    performDependencyLevelSanityCheck(state: DatabaseDocumentation, run: AnalysisRun, level: number, tables: TableNode[]): Promise<boolean>;
+    /**
+     * Perform schema-level sanity check
+     * Holistic review after entire schema is analyzed
+     */
+    performSchemaLevelSanityCheck(state: DatabaseDocumentation, run: AnalysisRun, schema: SchemaDefinition): Promise<boolean>;
+    /**
+     * Perform cross-schema sanity check
+     * Validates consistency across all schemas
+     */
+    performCrossSchemaSanityCheck(state: DatabaseDocumentation, run: AnalysisRun): Promise<boolean>;
+    /**
+     * Check convergence
+     */
+    checkConvergence(state: DatabaseDocumentation, run: AnalysisRun): boolean;
+    /**
+     * Execute backpropagation
+     */
+    executeBackpropagation(state: DatabaseDocumentation, run: AnalysisRun, triggers: BackpropagationTrigger[]): Promise<void>;
+    /**
+     * Extract FK insights from column descriptions and create feedback to discovery phase
+     *
+     * **DEPRECATED**: This method previously used brittle regex heuristics to parse natural language
+     * descriptions. Per architectural decision, we should use LLM for language understanding, not regex.
+     *
+     * **TODO**: Replace with structured LLM output approach:
+     * 1. Update table-analysis prompt to include a "foreignKeys" array in JSON response:
+     *    {
+     *      "tableDescription": "...",
+     *      "columnDescriptions": [...],
+     *      "foreignKeys": [
+     *        { "column": "prd_id", "referencesTable": "inv.prd", "referencesColumn": "prd_id" }
+     *      ]
+     *    }
+     * 2. Process the structured foreignKeys array directly instead of parsing descriptions
+     * 3. Use deterministic code only for statistics calculation, LLM for reasoning
+     *
+     * For now, this method is disabled to prevent brittle regex-based FK detection.
+     */
+    private extractAndFeedbackFKInsights;
+    /**
+     * Process structured FK insights from LLM and create feedback to discovery phase
+     *
+     * Uses the foreignKeys array from table-analysis prompt response instead of brittle regex parsing.
+     * Per architectural decision: use LLM for language understanding, deterministic code for processing.
+     */
+    private processFKInsightsFromLLM;
+    /**
+     * Find a column in the state schemas
+     */
+    private findColumnInState;
+    /**
+     * Update table-level dependsOn and dependents arrays when creating FK relationships
+     * This is required for ERD diagram generation
+     */
+    private updateTableDependencies;
+    /**
+     * Resolve target table from LLM hint (e.g., "product", "warehouse", "supplier")
+     * Returns the best matching table and its likely PK column
+     */
+    private resolveTargetTable;
+}
+//# sourceMappingURL=AnalysisEngine.d.ts.map

package/dist/core/AnalysisEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalysisEngine.d.ts","sourceRoot":"","sources":["../../src/core/AnalysisEngine.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,gBAAgB,EAAqC,MAAM,mBAAmB,CAAC;AAC5H,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAwB,MAAM,sBAAsB,CAAC;AAU/F,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAKhE,qBAAa,cAAc;IAQvB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,gBAAgB;IAV1B,OAAO,CAAC,qBAAqB,CAAwB;IACrD,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,UAAU,CAAC,CAAc;gBAGvB,MAAM,EAAE,eAAe,EACvB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,EAC1B,gBAAgB,EAAE,gBAAgB;IA4B5C;;OAEG;IACI,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAM5C;;OAEG;IACU,YAAY,CACvB,KAAK,EAAE,qBAAqB,EAC5B,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,SAAS,EAAE,GAClB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAqBpC;;OAEG;YACW,YAAY;IAwJ1B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAuDzB;;OAEG;YACW,mBAAmB;IAuEjC;;;OAGG;IACU,iCAAiC,CAC5C,KAAK,EAAE,qBAAqB,EAC5B,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,SAAS,EAAE,GAClB,OAAO,CAAC,OAAO,CAAC;IAwEnB;;;OAGG;IACU,6BAA6B,CACxC,KAAK,EAAE,qBAAqB,EAC5B,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,OAAO,CAAC;IA6FnB;;;OAGG;IACU,6BAA6B,CACxC,KAAK,EAAE,qBAAqB,EAC5B,GAAG,EAAE,WAAW,GACf,OAAO,CAAC,OAAO,CAAC;IA+EnB;;OAEG;IACI,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,EAAE,WAAW,GAAG,OAAO;IAWhF;;OAEG;IACU,sBAAsB,CACjC,KAAK,EAAE,qBAAqB,EAC5B,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,sBAAsB,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,4BAA4B;IAWpC;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAoIhC;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAezB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IA0D/B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;CAiE3B"}