/**
* @file HtmlReporter.ts
* @author Mario Galea
* @description
* Generates a styled HTML report comparing old and new API responses,
* including textual differences and JSON payload previews.
*/
import fs from 'fs';
import path from 'path';
import chalk from 'chalk';
import { Logger } from '../utils/Logger';
interface ComparisonResult {
fileName: string;
matched: boolean;
differences?: string[];
oldContent?: any;
newContent?: any;
}
/**
* Responsible for generating an HTML report summarizing API response comparisons.
* Each report includes match status, textual differences, and side-by-side JSON views.
*/
export class HtmlReporter {
private reportsDir: string;
private logger: Logger;
/**
* Constructs the HtmlReporter.
* Creates the reports directory if it does not exist, and initializes the logger.
*/
constructor() {
this.reportsDir = path.join(process.cwd(), 'apiveritas', 'reports');
this.logger = new Logger({ level: 'info' });
if (!fs.existsSync(this.reportsDir)) {
fs.mkdirSync(this.reportsDir, { recursive: true });
this.logger.info(`Reports directory created at: ${this.reportsDir}`);
}
}
/**
* Generates a timestamped HTML report file showing comparison results between two payload folders.
*
* @param oldFolder - Path to the older version of payloads.
* @param newFolder - Path to the newer version of payloads.
* @param comparisonResults - An array of comparison result objects with diff and content data.
* @returns The full path to the generated HTML report.
*/
generateReport(oldFolder: string, newFolder: string, comparisonResults: ComparisonResult[]): string {
const now = new Date();
const timestamp = `${now.getFullYear()}.${(now.getMonth() + 1)
.toString()
.padStart(2, '0')}.${now.getDate().toString().padStart(2, '0')}.${now
.getHours()
.toString()
.padStart(2, '0')}${now.getMinutes().toString().padStart(2, '0')}${now
.getSeconds()
.toString()
.padStart(2, '0')}`;
const filename = `comparison-report-${timestamp}.html`;
const filepath = path.join(this.reportsDir, filename);
const html = `
API Payload Comparison Report