codereview-aia 0.1.3 → 0.1.4

package/dist/utils/diagramGenerator.js

@@ -0,0 +1,218 @@
+"use strict";
+/**
+ * @fileoverview Diagram generator for creating Mermaid architecture diagrams.
+ *
+ * This module is responsible for extracting and generating Mermaid diagrams
+ * from review content, particularly for architectural reviews.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractMermaidDiagrams = extractMermaidDiagrams;
+exports.generateDiagramPrompt = generateDiagramPrompt;
+exports.saveDiagramFiles = saveDiagramFiles;
+exports.processDiagrams = processDiagrams;
+exports.enhancePromptForDiagrams = enhancePromptForDiagrams;
+const fs = __importStar(require("node:fs/promises"));
+const path = __importStar(require("node:path"));
+const logger_1 = __importDefault(require("./logger"));
+/**
+ * Extract Mermaid diagram blocks from review content
+ * @param content Review content that may contain Mermaid diagram blocks
+ * @returns Array of Mermaid diagram strings
+ */
+function extractMermaidDiagrams(content) {
+    const diagrams = [];
+    // Match Mermaid code blocks in various formats
+    const mermaidBlockRegex = /```mermaid\n([\s\S]*?)```/g;
+    let match;
+    while ((match = mermaidBlockRegex.exec(content)) !== null) {
+        diagrams.push(match[1].trim());
+    }
+    // Also check for inline mermaid notation that might be present
+    const inlineMermaidRegex = /graph\s+(TB|TD|BT|RL|LR)[\s\S]*?(?=\n\n|\n##|$)/g;
+    while ((match = inlineMermaidRegex.exec(content)) !== null) {
+        // Only add if not already captured in a code block
+        const diagram = match[0].trim();
+        if (!diagrams.some((d) => d.includes(diagram))) {
+            diagrams.push(diagram);
+        }
+    }
+    return diagrams;
+}
+/**
+ * Generate a Mermaid diagram prompt for architectural reviews
+ * @param projectName Name of the project being reviewed
+ * @param framework Framework being used (if detected)
+ * @returns Prompt text for generating architecture diagrams
+ */
+function generateDiagramPrompt(projectName, framework) {
+    const frameworkContext = framework ? ` (${framework} framework)` : '';
+    return `
+## Architecture Diagram
+
+Please generate a Mermaid diagram that visualizes the architecture of the ${projectName}${frameworkContext} project. Include:
+
+1. **Component Diagram**: Show the main components/modules and their relationships
+2. **Data Flow**: Illustrate how data flows through the system
+3. **Key Dependencies**: Show external services, databases, and APIs
+4. **Layer Architecture**: If applicable, show the layered architecture (presentation, business logic, data access)
+
+Use the following Mermaid syntax:
+
+\`\`\`mermaid
+graph TB
+    subgraph "Presentation Layer"
+        UI[User Interface]
+        API[API Gateway]
+    end
+    
+    subgraph "Business Logic"
+        Service[Service Layer]
+        Domain[Domain Models]
+    end
+    
+    subgraph "Data Layer"
+        DB[(Database)]
+        Cache[(Cache)]
+    end
+    
+    UI --> API
+    API --> Service
+    Service --> Domain
+    Service --> DB
+    Service --> Cache
+\`\`\`
+
+Please provide a comprehensive architecture diagram based on the actual code structure analyzed.
+`;
+}
+/**
+ * Save Mermaid diagrams to separate files
+ * @param diagrams Array of Mermaid diagram strings
+ * @param outputPath Path to the main review output file
+ * @returns Promise resolving to the paths of saved diagram files
+ */
+async function saveDiagramFiles(diagrams, outputPath) {
+    if (diagrams.length === 0) {
+        logger_1.default.debug('No diagrams to save');
+        return [];
+    }
+    const savedPaths = [];
+    const baseDir = path.dirname(outputPath);
+    const baseName = path.basename(outputPath, path.extname(outputPath));
+    for (let i = 0; i < diagrams.length; i++) {
+        const diagramNumber = diagrams.length > 1 ? `-${i + 1}` : '';
+        const diagramPath = path.join(baseDir, `${baseName}-diagram${diagramNumber}.md`);
+        // Create markdown file with the Mermaid diagram
+        const diagramContent = `# Architecture Diagram${diagramNumber ? ` ${i + 1}` : ''}
+
+Generated from: ${path.basename(outputPath)}
+Date: ${new Date().toISOString()}
+
+## Diagram
+
+\`\`\`mermaid
+${diagrams[i]}
+\`\`\`
+
+## Rendering Instructions
+
+To view this diagram:
+1. Use a Markdown viewer that supports Mermaid (GitHub, GitLab, VS Code with Mermaid extension)
+2. Or paste the Mermaid code into https://mermaid.live/
+3. Or use the Mermaid CLI: \`mmdc -i ${path.basename(diagramPath)} -o ${baseName}-diagram${diagramNumber}.svg\`
+
+## Notes
+
+This diagram was automatically generated as part of an architectural code review.
+For the full review, see: ${path.basename(outputPath)}
+`;
+        try {
+            await fs.writeFile(diagramPath, diagramContent, 'utf-8');
+            savedPaths.push(diagramPath);
+            logger_1.default.info(`Saved architecture diagram to: ${diagramPath}`);
+        }
+        catch (error) {
+            logger_1.default.error(`Failed to save diagram file: ${error}`);
+        }
+    }
+    return savedPaths;
+}
+/**
+ * Process review content to extract and save diagrams
+ * @param reviewContent The full review content
+ * @param outputPath Path to the main review output file
+ * @param options Review options
+ * @returns Promise resolving to paths of any saved diagram files
+ */
+async function processDiagrams(reviewContent, outputPath, options) {
+    // Only process diagrams if the flag is set and it's an architectural review
+    if (!options.diagram || options.type !== 'architectural') {
+        return [];
+    }
+    logger_1.default.info('Processing review content for architecture diagrams...');
+    // Extract any Mermaid diagrams from the review content
+    const diagrams = extractMermaidDiagrams(reviewContent);
+    if (diagrams.length === 0) {
+        logger_1.default.info('No Mermaid diagrams found in review content');
+        return [];
+    }
+    logger_1.default.info(`Found ${diagrams.length} Mermaid diagram(s) in review`);
+    // Save the diagrams to separate files
+    return saveDiagramFiles(diagrams, outputPath);
+}
+/**
+ * Enhance review prompt to include diagram generation
+ * @param originalPrompt The original review prompt
+ * @param options Review options
+ * @param projectName Project name
+ * @param framework Detected framework (optional)
+ * @returns Enhanced prompt with diagram instructions
+ */
+function enhancePromptForDiagrams(originalPrompt, options, projectName, framework) {
+    // Only enhance if diagram flag is set and it's an architectural review
+    if (!options.diagram || options.type !== 'architectural') {
+        return originalPrompt;
+    }
+    const diagramPrompt = generateDiagramPrompt(projectName, framework);
+    // Add the diagram prompt to the original prompt
+    return `${originalPrompt}
+
+${diagramPrompt}`;
+}
+//# sourceMappingURL=diagramGenerator.js.map

package/dist/utils/diagramGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagramGenerator.js","sourceRoot":"","sources":["../../src/utils/diagramGenerator.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWH,wDAuBC;AAQD,sDAyCC;AAQD,4CAiDC;AASD,0CAwBC;AAUD,4DAiBC;AAtMD,qDAAuC;AACvC,gDAAkC;AAClC,sDAA8B;AAE9B;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IACpD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,+CAA+C;IAC/C,MAAM,iBAAiB,GAAG,4BAA4B,CAAC;IACvD,IAAI,KAAK,CAAC;IAEV,OAAO,CAAC,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC1D,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,+DAA+D;IAC/D,MAAM,kBAAkB,GAAG,kDAAkD,CAAC;IAE9E,OAAO,CAAC,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC3D,mDAAmD;QACnD,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC/C,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,WAAmB,EAAE,SAAkB;IAC3E,MAAM,gBAAgB,GAAG,SAAS,CAAC,CAAC,CAAC,KAAK,SAAS,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAEtE,OAAO;;;4EAGmE,WAAW,GAAG,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCzG,CAAC;AACF,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,gBAAgB,CAAC,QAAkB,EAAE,UAAkB;IAC3E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,gBAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACpC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAErE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACzC,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,WAAW,aAAa,KAAK,CAAC,CAAC;QAEjF,gDAAgD;QAChD,MAAM,cAAc,GAAG,yBAAyB,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;;kBAElE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;QACnC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;;;;;EAK9B,QAAQ,CAAC,CAAC,CAAC;;;;;;;;uCAQ0B,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,QAAQ,WAAW,aAAa;;;;;4BAK5E,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;CACpD,CAAC;QAEE,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;YACzD,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC7B,gBAAM,CAAC,IAAI,CAAC,kCAAkC,WAAW,EAAE,CAAC,CAAC;QAC/D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAM,CAAC,KAAK,CAAC,gCAAgC,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CACnC,aAAqB,EACrB,UAAkB,EAClB,OAA4C;IAE5C,4EAA4E;IAC5E,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QACzD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,gBAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IAEtE,uDAAuD;IACvD,MAAM,QAAQ,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC;IAEvD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,gBAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;QAC3D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,gBAAM,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,MAAM,+BAA+B,CAAC,CAAC;IAErE,sCAAsC;IACtC,OAAO,gBAAgB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,wBAAwB,CACtC,cAAsB,EACtB,OAA4C,EAC5C,WAAmB,EACnB,SAAkB;IAElB,uEAAuE;IACvE,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QACzD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,MAAM,aAAa,GAAG,qBAAqB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAEpE,gDAAgD;IAChD,OAAO,GAAG,cAAc;;EAExB,aAAa,EAAE,CAAC;AAClB,CAAC"}

package/dist/utils/errorLogger.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview Error logging utilities for the code review tool.
+ *
+ * This module provides error logging functionality to capture and persist error
+ * information for debugging and troubleshooting. It writes detailed error logs
+ * to files with timestamps and contextual information to help diagnose issues.
+ *
+ * Key responsibilities:
+ * - Capturing error details including stack traces
+ * - Recording contextual information about the error environment
+ * - Writing error logs to timestamped files
+ * - Creating error log directories as needed
+ * - Providing a consistent error logging interface across the application
+ *
+ * These utilities help developers diagnose and fix issues by preserving detailed
+ * error information that might otherwise be lost in console output.
+ */
+/**
+ * Log an error to a file
+ * @param error Error to log
+ * @param context Additional context information
+ * @returns Promise resolving to the path of the error log file
+ */
+export declare function logError(error: unknown, context?: Record<string, unknown>): Promise<string>;

package/dist/utils/errorLogger.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * @fileoverview Error logging utilities for the code review tool.
+ *
+ * This module provides error logging functionality to capture and persist error
+ * information for debugging and troubleshooting. It writes detailed error logs
+ * to files with timestamps and contextual information to help diagnose issues.
+ *
+ * Key responsibilities:
+ * - Capturing error details including stack traces
+ * - Recording contextual information about the error environment
+ * - Writing error logs to timestamped files
+ * - Creating error log directories as needed
+ * - Providing a consistent error logging interface across the application
+ *
+ * These utilities help developers diagnose and fix issues by preserving detailed
+ * error information that might otherwise be lost in console output.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logError = logError;
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const fileSystem_1 = require("./fileSystem");
+const logger_1 = __importDefault(require("./logger"));
+/**
+ * Log an error to a file
+ * @param error Error to log
+ * @param context Additional context information
+ * @returns Promise resolving to the path of the error log file
+ */
+async function logError(error, context = {}) {
+    try {
+        // Create error logs directory
+        const errorLogsDir = node_path_1.default.resolve('error-logs');
+        await (0, fileSystem_1.createDirectory)(errorLogsDir);
+        // Generate timestamp for the filename
+        const timestamp = new Date().toISOString().replace(/:/g, '-');
+        const errorLogPath = node_path_1.default.join(errorLogsDir, `error-${timestamp}.json`);
+        // Format error object
+        const errorObj = {
+            timestamp: new Date().toISOString(),
+            message: error instanceof Error ? error.message : 'Unknown error',
+            stack: error instanceof Error ? error.stack : undefined,
+            context,
+        };
+        // Write error to file
+        await promises_1.default.writeFile(errorLogPath, JSON.stringify(errorObj, null, 2));
+        logger_1.default.error(`Error logged to: ${errorLogPath}`);
+        return errorLogPath;
+    }
+    catch (logError) {
+        logger_1.default.error('Failed to log error:', logError);
+        return '';
+    }
+}
+//# sourceMappingURL=errorLogger.js.map

package/dist/utils/errorLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorLogger.js","sourceRoot":"","sources":["../../src/utils/errorLogger.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;;;AAaH,4BA8BC;AAzCD,gEAAkC;AAClC,0DAA6B;AAC7B,6CAA+C;AAC/C,sDAA8B;AAE9B;;;;;GAKG;AACI,KAAK,UAAU,QAAQ,CAC5B,KAAc,EACd,UAAmC,EAAE;IAErC,IAAI,CAAC;QACH,8BAA8B;QAC9B,MAAM,YAAY,GAAG,mBAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAChD,MAAM,IAAA,4BAAe,EAAC,YAAY,CAAC,CAAC;QAEpC,sCAAsC;QACtC,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC9D,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,SAAS,OAAO,CAAC,CAAC;QAExE,sBAAsB;QACtB,MAAM,QAAQ,GAAG;YACf,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;YACjE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;YACvD,OAAO;SACR,CAAC;QAEF,sBAAsB;QACtB,MAAM,kBAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAEpE,gBAAM,CAAC,KAAK,CAAC,oBAAoB,YAAY,EAAE,CAAC,CAAC;QACjD,OAAO,YAAY,CAAC;IACtB,CAAC;IAAC,OAAO,QAAQ,EAAE,CAAC;QAClB,gBAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;QAC/C,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/utils/estimationUtils.d.ts

@@ -0,0 +1,139 @@
+/**
+ * @fileoverview Utilities for estimating token usage and costs for code reviews.
+ *
+ * This module provides functions for estimating token usage and costs for code reviews
+ * based on file content and model selection. It uses the tokenCounter utilities for
+ * basic token counting and cost calculation, and adds specialized functions for
+ * estimating review-specific token usage patterns.
+ */
+import type { FileInfo } from '../types/review';
+/**
+ * Estimate the number of output tokens based on input tokens and review type
+ * @param inputTokens Number of input tokens
+ * @param reviewType Type of review
+ * @returns Estimated number of output tokens
+ */
+export declare function estimateOutputTokens(inputTokens: number, reviewType: string): number;
+/**
+ * Estimate token usage and cost for a set of files
+ *
+ * This function calculates the estimated token usage and cost for reviewing a set of files
+ * using a specified AI model. It considers:
+ * - The content of each file (code, comments, etc.)
+ * - The type of review being performed (quick, security, architectural, etc.)
+ * - The specific AI model being used and its pricing structure
+ *
+ * The estimation includes overhead tokens for system prompts and instructions that are
+ * included in every review, in addition to the tokens from the file content itself.
+ *
+ * @param files Array of file information objects containing file content and metadata
+ * @param reviewType Type of review (quick, security, architectural, performance)
+ * @param modelName Name of the model to use (e.g., 'openrouter:anthropic/claude-3-opus-20240229')
+ * @returns Estimated token usage and cost information including:
+ *   - inputTokens: Number of tokens in the input (files + prompts)
+ *   - outputTokens: Estimated number of tokens in the AI response
+ *   - totalTokens: Total token usage (input + output)
+ *   - estimatedCost: Estimated cost in USD
+ *   - formattedCost: Cost formatted as a string (e.g., '$0.12 USD')
+ *   - fileCount: Number of files being reviewed
+ *   - totalFileSize: Total size of all files in bytes
+ */
+export declare function estimateReviewCost(files: FileInfo[], reviewType: string, modelName?: string): Promise<{
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+    estimatedCost: number;
+    formattedCost: string;
+    fileCount: number;
+    totalFileSize: number;
+}>;
+/**
+ * Format estimation results as a human-readable string
+ *
+ * This function takes the estimation results from estimateReviewCost or estimateFromFilePaths
+ * and formats them into a user-friendly string that can be displayed to the user.
+ *
+ * The formatted string includes:
+ * - Number of files being reviewed
+ * - Total file size
+ * - Input token count
+ * - Estimated output token count
+ * - Total token usage
+ * - Estimated cost in USD
+ *
+ * @param estimation Estimation results from estimateReviewCost or estimateFromFilePaths
+ * @param reviewType Type of review (quick, security, architectural, performance)
+ * @param modelName Name of the model being used
+ * @returns Formatted estimation string ready for display
+ * @example
+ * // Example output:
+ * // Estimation for 5 files (25.5 KB) using openrouter:anthropic/claude-3-opus-20240229:
+ * // - Review type: quick
+ * // - Input tokens: 5,000
+ * // - Output tokens: 2,500 (estimated)
+ * // - Total tokens: 7,500
+ * // - Estimated Cost: $0.015 USD
+ */
+export declare function formatEstimation(estimation: ReturnType<typeof estimateReviewCost> extends Promise<infer T> ? T : never, reviewType: string, modelName: string): string;
+/**
+ * Estimate token usage and cost for a set of file paths
+ *
+ * This function is a convenience wrapper around estimateReviewCost that takes file paths
+ * instead of FileInfo objects. It reads the content of each file and then calls
+ * estimateReviewCost to calculate the token usage and cost.
+ *
+ * This is particularly useful for the --estimate command line flag, which needs to
+ * estimate costs before actually performing a review.
+ *
+ * @param filePaths Array of file paths to estimate token usage for
+ * @param reviewType Type of review (quick, security, architectural, performance)
+ * @param modelName Name of the model to use (e.g., 'openrouter:anthropic/claude-3-opus-20240229')
+ * @returns Estimated token usage and cost information (same as estimateReviewCost)
+ * @throws Error if any file cannot be read
+ * @see estimateReviewCost for details on the return value
+ */
+export declare function estimateFromFilePaths(filePaths: string[], reviewType: string, modelName?: string): Promise<ReturnType<typeof estimateReviewCost> extends Promise<infer T> ? T : never>;
+/**
+ * Estimate token usage and cost for a multi-pass review
+ *
+ * This function extends the standard token estimation by accounting for the overhead
+ * of multi-pass reviews, including context maintenance between passes and additional
+ * overhead for each pass.
+ *
+ * @param files Array of file information objects containing file content and metadata
+ * @param reviewType Type of review (quick, security, architectural, performance)
+ * @param modelName Name of the model to use (e.g., 'openrouter:anthropic/claude-3-opus-20240229')
+ * @param options Additional estimation options
+ * @param options.passCount Number of passes to estimate (if known)
+ * @param options.contextMaintenanceFactor Factor for context maintenance overhead (0-1)
+ * @returns Estimated token usage and cost information for multi-pass review
+ */
+export declare function estimateMultiPassReviewCost(files: FileInfo[], reviewType: string, modelName?: string, options?: {
+    passCount?: number;
+    contextMaintenanceFactor?: number;
+}): Promise<{
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+    estimatedCost: number;
+    formattedCost: string;
+    fileCount: number;
+    totalFileSize: number;
+    passCount: number;
+    perPassCosts: {
+        passNumber: number;
+        inputTokens: number;
+        outputTokens: number;
+        totalTokens: number;
+        estimatedCost: number;
+    }[];
+}>;
+/**
+ * Format multi-pass estimation results as a human-readable string
+ *
+ * @param estimation Multi-pass estimation results
+ * @param reviewType Type of review
+ * @param modelName Name of the model being used
+ * @returns Formatted estimation string
+ */
+export declare function formatMultiPassEstimation(estimation: ReturnType<typeof estimateMultiPassReviewCost> extends Promise<infer T> ? T : never, reviewType: string, modelName: string): string;