import { ReviewReport } from '../entities/ReviewReport';
import { SecurityIssue } from '../entities/SecurityIssue';
import { TestSuggestion } from '../entities/TestSuggestion';
import { DocSuggestion } from '../entities/DocSuggestion';

export type OutputFormat = 'console' | 'markdown' | 'json' | 'html' | 'github' | 'file';

export interface OutputOptions {
  readonly format: OutputFormat;
  readonly outputPath?: string;
  readonly includeMetadata?: boolean;
  readonly verbose?: boolean;
  readonly colorize?: boolean;
  readonly template?: string;
}

export interface OutputPort {
  /**
   * Display a review report
   */
  displayReviewReport(report: ReviewReport, options?: OutputOptions): Promise<void>;

  /**
   * Display security issues
   */
  displaySecurityIssues(issues: SecurityIssue[], options?: OutputOptions): Promise<void>;

  /**
   * Display test suggestions
   */
  displayTestSuggestions(suggestions: TestSuggestion[], options?: OutputOptions): Promise<void>;

  /**
   * Display documentation suggestions
   */
  displayDocSuggestions(suggestions: DocSuggestion[], options?: OutputOptions): Promise<void>;

  /**
   * Display a simple message
   */
  displayMessage(message: string, options?: OutputOptions): Promise<void>;

  /**
   * Display an error message
   */
  displayError(error: string, options?: OutputOptions): Promise<void>;

  /**
   * Display a warning message
   */
  displayWarning(warning: string, options?: OutputOptions): Promise<void>;

  /**
   * Display a success message
   */
  displaySuccess(message: string, options?: OutputOptions): Promise<void>;

  /**
   * Display a progress indicator
   */
  displayProgress(message: string): void;

  /**
   * Clear the progress indicator
   */
  clearProgress(): void;

  /**
   * Display a table of data
   */
  displayTable(data: Record<string, unknown>[], options?: OutputOptions): Promise<void>;

  /**
   * Export data to a file
   */
  exportToFile(data: unknown, filePath: string, format: OutputFormat): Promise<void>;
}