@memberjunction/db-auto-doc 2.116.0 → 2.118.0

package/bin/run.js

@@ -1,5 +1,12 @@
 #!/usr/bin/env node
 
+// Load environment variables from .env file in current working directory
+require('dotenv').config()
+
+// Load AI providers to prevent tree shaking
+const { LoadAIProviders } = require('@memberjunction/ai-provider-bundle');
+LoadAIProviders();
+
 const oclif = require('@oclif/core')
 
 oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/dist/api/DBAutoDocAPI.d.ts

@@ -0,0 +1,252 @@
+/**
+ * DBAutoDoc Programmatic API
+ *
+ * A clean, simple API for using DBAutoDoc as a library.
+ * Provides programmatic access to analysis, export, and status checking.
+ *
+ * @example
+ * ```typescript
+ * import { DBAutoDocAPI } from '@memberjunction/db-auto-doc';
+ *
+ * const api = new DBAutoDocAPI();
+ *
+ * const result = await api.analyze({
+ *   database: {
+ *     provider: 'sqlserver',
+ *     server: 'localhost',
+ *     database: 'MyDB',
+ *     user: 'sa',
+ *     password: 'password'
+ *   },
+ *   ai: {
+ *     provider: 'anthropic',
+ *     model: 'claude-3-opus-20240229',
+ *     apiKey: 'sk-...'
+ *   },
+ *   onProgress: (message, data) => console.log(`${message}:`, data)
+ * });
+ *
+ * console.log(`Analysis complete: ${result.outputFolder}`);
+ * console.log(`Tokens used: ${result.summary.totalTokens}`);
+ * ```
+ */
+import { DatabaseConfig, AIConfig, AnalysisConfig } from '../types/config.js';
+import { AnalysisSummary } from '../types/state.js';
+/**
+ * Progress callback function
+ * Called during analysis with status updates
+ *
+ * @param message - Status message describing what's happening
+ * @param data - Optional data object with additional context (e.g., { tableName, progress: 0.45 })
+ */
+export type ProgressCallback = (message: string, data?: Record<string, any>) => void;
+/**
+ * API Configuration subset
+ * Only includes the essential configuration options for programmatic use
+ */
+export interface DBAutoDocAPIConfig {
+    /** Database connection configuration */
+    database: DatabaseConfig;
+    /** AI provider configuration */
+    ai: AIConfig;
+    /** Optional analysis configuration (uses sensible defaults if not provided) */
+    analysis?: Partial<AnalysisConfig>;
+    /** Optional seed context for better analysis results */
+    seedContext?: {
+        overallPurpose?: string;
+        businessDomains?: string[];
+        industryContext?: string;
+        customInstructions?: string;
+    };
+    /** Optional output directory (default: ./output) */
+    outputDir?: string;
+    /** Schema filtering */
+    schemas?: {
+        include?: string[];
+        exclude?: string[];
+    };
+    /** Table filtering */
+    tables?: {
+        exclude?: string[];
+    };
+}
+/**
+ * Analysis execution result
+ * Contains the complete analysis state and metadata
+ */
+export interface AnalysisExecutionResult {
+    /** Whether analysis succeeded */
+    success: boolean;
+    /** Path to the output folder containing state.json and generated files */
+    outputFolder: string;
+    /** Path to the state file */
+    stateFile: string;
+    /** Analysis summary with metrics */
+    summary: AnalysisSummary;
+    /** Error message if analysis failed */
+    message?: string;
+}
+/**
+ * Export result
+ * Contains paths to generated files
+ */
+export interface ExportResult {
+    /** Whether export succeeded */
+    success: boolean;
+    /** Path to generated SQL file (if requested) */
+    sqlFile?: string;
+    /** Path to generated Markdown file (if requested) */
+    markdownFile?: string;
+    /** Error message if export failed */
+    message?: string;
+}
+/**
+ * Status information for an analysis
+ */
+export interface AnalysisStatus {
+    /** Whether a state file exists */
+    exists: boolean;
+    /** When analysis was created */
+    createdAt?: string;
+    /** When analysis was last modified */
+    lastModified?: string;
+    /** Total iterations performed */
+    totalIterations?: number;
+    /** Total tokens used */
+    totalTokens?: number;
+    /** Estimated cost in dollars */
+    estimatedCost?: number;
+    /** Number of schemas analyzed */
+    totalSchemas?: number;
+    /** Number of tables analyzed */
+    totalTables?: number;
+    /** Number of columns analyzed */
+    totalColumns?: number;
+}
+/**
+ * DBAutoDocAPI - Main API class
+ *
+ * Simple, type-safe interface for DBAutoDoc functionality:
+ * - analyze() - Run full analysis or resume from checkpoint
+ * - export() - Generate SQL and/or Markdown from analysis state
+ * - getStatus() - Check analysis progress and metrics
+ */
+export declare class DBAutoDocAPI {
+    /**
+     * Run database analysis
+     *
+     * Performs full or resumed database analysis, saving results to the output folder.
+     *
+     * @param config - API configuration with database and AI settings
+     * @param progressCallback - Optional callback for progress updates
+     * @returns Analysis result with output folder path and metrics
+     *
+     * @example
+     * ```typescript
+     * const result = await api.analyze({
+     *   database: { provider: 'sqlserver', server: 'localhost', ... },
+     *   ai: { provider: 'anthropic', model: 'claude-3-opus-20240229', ... },
+     *   onProgress: (msg, data) => console.log(msg, data)
+     * });
+     *
+     * if (result.success) {
+     *   console.log(`Analysis saved to: ${result.outputFolder}`);
+     *   console.log(`Tokens used: ${result.summary.totalTokens}`);
+     * }
+     * ```
+     */
+    analyze(config: DBAutoDocAPIConfig & {
+        onProgress?: ProgressCallback;
+    }): Promise<AnalysisExecutionResult>;
+    /**
+     * Resume analysis from a checkpoint
+     *
+     * Continues a previous analysis from where it left off.
+     *
+     * @param stateFile - Path to the state.json file to resume from
+     * @param config - Updated configuration (optional, uses config from state if not provided)
+     * @param progressCallback - Optional callback for progress updates
+     * @returns Analysis execution result
+     *
+     * @example
+     * ```typescript
+     * const result = await api.resume('./output/run-5/state.json', {
+     *   database: { ... },  // Optional: provide updated config
+     *   ai: { ... },
+     *   onProgress: (msg) => console.log(msg)
+     * });
+     * ```
+     */
+    resume(stateFile: string, config?: DBAutoDocAPIConfig & {
+        onProgress?: ProgressCallback;
+    }): Promise<AnalysisExecutionResult>;
+    /**
+     * Export analysis results as SQL and/or Markdown
+     *
+     * Generates SQL extended properties script and/or Markdown documentation
+     * from an existing analysis state file.
+     *
+     * @param stateFile - Path to the state.json file to export from
+     * @param options - Export options
+     * @returns Export result with paths to generated files
+     *
+     * @example
+     * ```typescript
+     * // Generate both SQL and Markdown
+     * const result = await api.export('./output/run-5/state.json', {
+     *   sql: true,
+     *   markdown: true,
+     *   outputDir: './docs'
+     * });
+     *
+     * if (result.success) {
+     *   console.log(`SQL: ${result.sqlFile}`);
+     *   console.log(`Markdown: ${result.markdownFile}`);
+     * }
+     * ```
+     */
+    export(stateFile: string, options?: {
+        /** Generate SQL extended properties script (default: true) */
+        sql?: boolean;
+        /** Generate Markdown documentation (default: true) */
+        markdown?: boolean;
+        /** Output directory for generated files (default: same as state file directory) */
+        outputDir?: string;
+        /** Only include approved items (default: false) */
+        approvedOnly?: boolean;
+        /** Minimum confidence threshold for inclusion (0-1, default: 0) */
+        confidenceThreshold?: number;
+    }): Promise<ExportResult>;
+    /**
+     * Get analysis status and metrics
+     *
+     * Returns current analysis status and metrics from a state file.
+     * Useful for tracking progress or checking if analysis is complete.
+     *
+     * @param stateFile - Path to the state.json file
+     * @returns Status information
+     *
+     * @example
+     * ```typescript
+     * const status = await api.getStatus('./output/run-5/state.json');
+     *
+     * if (status.exists) {
+     *   console.log(`Schemas: ${status.totalSchemas}`);
+     *   console.log(`Tables: ${status.totalTables}`);
+     *   console.log(`Tokens: ${status.totalTokens}`);
+     *   console.log(`Cost: $${status.estimatedCost?.toFixed(2)}`);
+     * }
+     * ```
+     */
+    getStatus(stateFile: string): Promise<AnalysisStatus>;
+    /**
+     * Build full configuration from API config
+     * Applies sensible defaults for analysis settings
+     */
+    private buildFullConfig;
+    /**
+     * Build default configuration (used when resuming without new config)
+     */
+    private buildDefaultConfig;
+}
+//# sourceMappingURL=DBAutoDocAPI.d.ts.map

package/dist/api/DBAutoDocAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DBAutoDocAPI.d.ts","sourceRoot":"","sources":["../../src/api/DBAutoDocAPI.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AASH,OAAO,EAAmB,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC/F,OAAO,EAAyB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE3E;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;AAErF;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,wCAAwC;IACxC,QAAQ,EAAE,cAAc,CAAC;IAEzB,gCAAgC;IAChC,EAAE,EAAE,QAAQ,CAAC;IAEb,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAEnC,wDAAwD;IACxD,WAAW,CAAC,EAAE;QACZ,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IAEF,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,uBAAuB;IACvB,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IAEF,sBAAsB;IACtB,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,iCAAiC;IACjC,OAAO,EAAE,OAAO,CAAC;IAEjB,0EAA0E;IAC1E,YAAY,EAAE,MAAM,CAAC;IAErB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAElB,oCAAoC;IACpC,OAAO,EAAE,eAAe,CAAC;IAEzB,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,OAAO,EAAE,OAAO,CAAC;IAEjB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,MAAM,EAAE,OAAO,CAAC;IAEhB,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iCAAiC;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,gCAAgC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,OAAO,CAClB,MAAM,EAAE,kBAAkB,GAAG;QAAE,UAAU,CAAC,EAAE,gBAAgB,CAAA;KAAE,GAC7D,OAAO,CAAC,uBAAuB,CAAC;IAwDnC;;;;;;;;;;;;;;;;;;OAkBG;IACU,MAAM,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,kBAAkB,GAAG;QAAE,UAAU,CAAC,EAAE,gBAAgB,CAAA;KAAE,GAC9D,OAAO,CAAC,uBAAuB,CAAC;IAwFnC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,MAAM,CACjB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QACR,8DAA8D;QAC9D,GAAG,CAAC,EAAE,OAAO,CAAC;QAEd,sDAAsD;QACtD,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,mFAAmF;QACnF,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,mDAAmD;QACnD,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB,mEAAmE;QACnE,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,GACA,OAAO,CAAC,YAAY,CAAC;IAuDxB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAyBlE;;;OAGG;IACH,OAAO,CAAC,eAAe;IAyEvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;CAqF3B"}