@machina.ai/openapi-contract-tester 2.1.0

package/dist/utils/coverage-calculator.js

@@ -0,0 +1,134 @@
+/**
+ * Coverage Calculator
+ *
+ * Calculates endpoint coverage from test results
+ * without generating new tests (unlike preview-test-coverage)
+ *
+ * @module utils/coverage-calculator
+ */
+/**
+ * Calculates endpoint coverage from test results
+ *
+ * Analyzes results.json to determine which endpoints were tested
+ * and which are missing coverage
+ *
+ * @param results - Test results object with allTests array
+ * @returns Coverage statistics
+ *
+ * @example
+ * ```typescript
+ * const results = JSON.parse(await fs.readFile('results.json', 'utf-8'));
+ * const coverage = calculateCoverageFromResults(results);
+ *
+ * console.log(coverage.coveragePercentage); // "85%"
+ * console.log(coverage.uncoveredEndpoints); // [{ method: "DELETE", path: "/users/{id}" }]
+ * ```
+ */
+export function calculateCoverageFromResults(results) {
+    const endpointMap = new Map();
+    // Extract and group tests by endpoint
+    for (const test of results.allTests || []) {
+        // Get endpoint identifier (prefer explicit endpoint field, fallback to method+path)
+        const method = test.method || 'UNKNOWN';
+        const path = test.path || 'unknown';
+        const endpointKey = test.endpoint || `${method} ${path}`;
+        if (!endpointMap.has(endpointKey)) {
+            endpointMap.set(endpointKey, {
+                method,
+                path,
+                totalTests: 0,
+                passedTests: 0,
+                failedTests: 0,
+            });
+        }
+        const endpoint = endpointMap.get(endpointKey);
+        endpoint.totalTests++;
+        if (test.status === 'passed') {
+            endpoint.passedTests++;
+        }
+        else if (test.status === 'failed') {
+            endpoint.failedTests++;
+        }
+    }
+    // Calculate coverage statistics
+    const totalEndpoints = endpointMap.size;
+    const testedEndpoints = endpointMap.size; // All endpoints in results have at least 1 test
+    // Find uncovered endpoints (in this case, none since we only have tested ones)
+    // This would require OpenAPI spec to find truly uncovered endpoints
+    const uncoveredEndpoints = [];
+    // Build detailed endpoint info
+    const endpointDetails = Array.from(endpointMap.entries()).map(([endpointKey, data]) => ({
+        endpoint: endpointKey,
+        method: data.method,
+        path: data.path,
+        totalTests: data.totalTests,
+        passedTests: data.passedTests,
+        failedTests: data.failedTests,
+        hasCoverage: data.totalTests > 0,
+    }));
+    const coveragePercentage = totalEndpoints > 0
+        ? `${((testedEndpoints / totalEndpoints) * 100).toFixed(2)}%`
+        : '0%';
+    return {
+        totalEndpoints,
+        testedEndpoints,
+        coveragePercentage,
+        uncoveredEndpoints,
+        endpointDetails,
+    };
+}
+/**
+ * Calculates coverage with OpenAPI spec to find truly uncovered endpoints
+ *
+ * Compares test results against OpenAPI spec to identify endpoints
+ * that exist in spec but have no tests
+ *
+ * @param results - Test results object
+ * @param specEndpoints - Parsed endpoints from OpenAPI spec
+ * @returns Coverage statistics including truly uncovered endpoints
+ *
+ * @example
+ * ```typescript
+ * const spec = await parseOpenAPISpec('api.yml');
+ * const endpoints = extractEndpoints(spec);
+ * const coverage = calculateCoverageWithSpec(results, endpoints);
+ *
+ * console.log(coverage.uncoveredEndpoints);
+ * // [{ method: "DELETE", path: "/admin/logs" }]
+ * ```
+ */
+export function calculateCoverageWithSpec(results, specEndpoints) {
+    const baseCoverage = calculateCoverageFromResults(results);
+    // Get all tested endpoints
+    const testedEndpointsSet = new Set();
+    for (const test of results.allTests || []) {
+        const method = test.method || 'UNKNOWN';
+        const path = test.path || 'unknown';
+        const endpointKey = `${method} ${path}`;
+        testedEndpointsSet.add(endpointKey);
+    }
+    // Find uncovered endpoints from spec
+    const uncoveredEndpoints = [];
+    for (const endpoint of specEndpoints) {
+        const endpointKey = `${endpoint.method} ${endpoint.path}`;
+        if (!testedEndpointsSet.has(endpointKey)) {
+            uncoveredEndpoints.push({
+                method: endpoint.method,
+                path: endpoint.path,
+            });
+        }
+    }
+    const totalEndpoints = specEndpoints.length;
+    const testedEndpoints = totalEndpoints - uncoveredEndpoints.length;
+    const coveragePercentage = totalEndpoints > 0
+        ? `${((testedEndpoints / totalEndpoints) * 100).toFixed(2)}%`
+        : '0%';
+    return {
+        ...baseCoverage,
+        totalEndpoints,
+        testedEndpoints,
+        coveragePercentage,
+        uncoveredEndpoints,
+    };
+}
+//# sourceMappingURL=coverage-calculator.js.map

package/dist/utils/coverage-calculator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coverage-calculator.js","sourceRoot":"","sources":["../../src/utils/coverage-calculator.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAyBH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,4BAA4B,CAAC,OAE5C;IACC,MAAM,WAAW,GAAG,IAAI,GAAG,EASxB,CAAC;IAEJ,sCAAsC;IACtC,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC1C,oFAAoF;QACpF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC;QACpC,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,IAAI,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;QAEzD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE;gBAC3B,MAAM;gBACN,IAAI;gBACJ,UAAU,EAAE,CAAC;gBACb,WAAW,EAAE,CAAC;gBACd,WAAW,EAAE,CAAC;aACf,CAAC,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;QAC/C,QAAQ,CAAC,UAAU,EAAE,CAAC;QAEtB,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC7B,QAAQ,CAAC,WAAW,EAAE,CAAC;QACzB,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACpC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAED,gCAAgC;IAChC,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,CAAC;IACxC,MAAM,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,gDAAgD;IAE1F,+EAA+E;IAC/E,oEAAoE;IACpE,MAAM,kBAAkB,GAA4C,EAAE,CAAC;IAEvE,+BAA+B;IAC/B,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAC3D,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACxB,QAAQ,EAAE,WAAW;QACrB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,WAAW,EAAE,IAAI,CAAC,UAAU,GAAG,CAAC;KACjC,CAAC,CACH,CAAC;IAEF,MAAM,kBAAkB,GACtB,cAAc,GAAG,CAAC;QAChB,CAAC,CAAC,GAAG,CAAC,CAAC,eAAe,GAAG,cAAc,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;QAC7D,CAAC,CAAC,IAAI,CAAC;IAEX,OAAO;QACL,cAAc;QACd,eAAe;QACf,kBAAkB;QAClB,kBAAkB;QAClB,eAAe;KAChB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAmC,EACnC,aAAsD;IAEtD,MAAM,YAAY,GAAG,4BAA4B,CAAC,OAAO,CAAC,CAAC;IAE3D,2BAA2B;IAC3B,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC7C,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC;QACpC,MAAM,WAAW,GAAG,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;QACxC,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED,qCAAqC;IACrC,MAAM,kBAAkB,GAA4C,EAAE,CAAC;IACvE,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC1D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YACzC,kBAAkB,CAAC,IAAI,CAAC;gBACtB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC;IAC5C,MAAM,eAAe,GAAG,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC;IACnE,MAAM,kBAAkB,GACtB,cAAc,GAAG,CAAC;QAChB,CAAC,CAAC,GAAG,CAAC,CAAC,eAAe,GAAG,cAAc,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;QAC7D,CAAC,CAAC,IAAI,CAAC;IAEX,OAAO;QACL,GAAG,YAAY;QACf,cAAc;QACd,eAAe;QACf,kBAAkB;QAClB,kBAAkB;KACnB,CAAC;AACJ,CAAC"}

package/dist/utils/data-loader.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Test Data Loader
+ *
+ * Loads test data from various file formats (Excel, CSV, JSON).
+ * Supports sharing test data across teams via files.
+ *
+ * @module utils/data-loader
+ */
+/**
+ * Loads test data from a file (Excel, CSV, or JSON)
+ *
+ * Supports:
+ * - Excel (.xlsx, .xls) - Reads first row as headers, second row as data
+ * - CSV (.csv) - Reads first row as headers, second row as data
+ * - JSON (.json) - Reads entire object
+ *
+ * @param filePath - Absolute path to the data file
+ * @returns Test data as key-value pairs
+ * @throws Error if file format is unsupported or file cannot be read
+ *
+ * @example
+ * ```typescript
+ * // Excel/CSV format:
+ * // | username | password | grant_type |
+ * // | user@bank.com | SecurePass123! | password |
+ *
+ * const data = await loadTestData('./test-data.xlsx');
+ * // Returns: { username: 'user@bank.com', password: 'SecurePass123!', grant_type: 'password' }
+ *
+ * // JSON format:
+ * // { "username": "user@bank.com", "password": "SecurePass123!" }
+ *
+ * const data = await loadTestData('./test-data.json');
+ * // Returns: { username: 'user@bank.com', password: 'SecurePass123!' }
+ * ```
+ */
+export declare function loadTestData(filePath: string): Promise<Record<string, any>>;
+/**
+ * Validates that test data contains required fields
+ *
+ * @param testData - Test data object
+ * @param requiredFields - Array of required field names
+ * @throws Error if any required field is missing
+ *
+ * @example
+ * ```typescript
+ * validateTestData(data, ['username', 'password']);
+ * // Throws if username or password is missing
+ * ```
+ */
+export declare function validateTestData(testData: Record<string, any>, requiredFields: string[]): void;
+//# sourceMappingURL=data-loader.d.ts.map

package/dist/utils/data-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-loader.d.ts","sourceRoot":"","sources":["../../src/utils/data-loader.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAUH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAkBjF;AAsID;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,cAAc,EAAE,MAAM,EAAE,GACvB,IAAI,CAQN"}

package/dist/utils/data-loader.js

@@ -0,0 +1,192 @@
+/**
+ * Test Data Loader
+ *
+ * Loads test data from various file formats (Excel, CSV, JSON).
+ * Supports sharing test data across teams via files.
+ *
+ * @module utils/data-loader
+ */
+import * as XLSX from 'xlsx';
+import * as Papa from 'papaparse';
+import { promises as fs } from 'fs';
+import { extname } from 'path';
+import { createLogger } from './logger.js';
+const log = createLogger('data-loader');
+/**
+ * Loads test data from a file (Excel, CSV, or JSON)
+ *
+ * Supports:
+ * - Excel (.xlsx, .xls) - Reads first row as headers, second row as data
+ * - CSV (.csv) - Reads first row as headers, second row as data
+ * - JSON (.json) - Reads entire object
+ *
+ * @param filePath - Absolute path to the data file
+ * @returns Test data as key-value pairs
+ * @throws Error if file format is unsupported or file cannot be read
+ *
+ * @example
+ * ```typescript
+ * // Excel/CSV format:
+ * // | username | password | grant_type |
+ * // | user@bank.com | SecurePass123! | password |
+ *
+ * const data = await loadTestData('./test-data.xlsx');
+ * // Returns: { username: 'user@bank.com', password: 'SecurePass123!', grant_type: 'password' }
+ *
+ * // JSON format:
+ * // { "username": "user@bank.com", "password": "SecurePass123!" }
+ *
+ * const data = await loadTestData('./test-data.json');
+ * // Returns: { username: 'user@bank.com', password: 'SecurePass123!' }
+ * ```
+ */
+export async function loadTestData(filePath) {
+    const ext = extname(filePath).toLowerCase();
+    log.info('Loading test data from file', { filePath, extension: ext });
+    switch (ext) {
+        case '.xlsx':
+        case '.xls':
+            return await loadExcelData(filePath);
+        case '.csv':
+            return await loadCsvData(filePath);
+        case '.json':
+            return await loadJsonData(filePath);
+        default:
+            throw new Error(`Unsupported test data file format: ${ext}. Supported formats: .xlsx, .xls, .csv, .json`);
+    }
+}
+/**
+ * Loads test data from Excel file
+ *
+ * Expects:
+ * - First row: Column headers (field names)
+ * - Second row: Data values
+ *
+ * @param filePath - Path to Excel file
+ * @returns Test data object
+ * @internal
+ */
+async function loadExcelData(filePath) {
+    try {
+        // Read Excel file
+        const workbook = XLSX.readFile(filePath);
+        // Get first sheet
+        const sheetName = workbook.SheetNames[0];
+        if (!sheetName) {
+            throw new Error('Excel file is empty (no sheets found)');
+        }
+        const worksheet = workbook.Sheets[sheetName];
+        // Convert to JSON (array of objects)
+        const jsonData = XLSX.utils.sheet_to_json(worksheet);
+        if (jsonData.length === 0) {
+            throw new Error('Excel file is empty (no data rows found)');
+        }
+        // Return first row as test data
+        const testData = jsonData[0];
+        log.debug('Loaded Excel data', {
+            filePath,
+            sheetName,
+            rowCount: jsonData.length,
+            fields: Object.keys(testData),
+        });
+        return testData;
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        log.error('Failed to load Excel file', { filePath, error: errorMessage });
+        throw new Error(`Failed to load Excel file: ${errorMessage}`);
+    }
+}
+/**
+ * Loads test data from CSV file
+ *
+ * Expects:
+ * - First row: Column headers (field names)
+ * - Second row: Data values
+ *
+ * @param filePath - Path to CSV file
+ * @returns Test data object
+ * @internal
+ */
+async function loadCsvData(filePath) {
+    try {
+        // Read CSV file
+        const csvContent = await fs.readFile(filePath, 'utf-8');
+        // Parse CSV
+        const result = Papa.parse(csvContent, {
+            header: true, // First row as headers
+            skipEmptyLines: true,
+            dynamicTyping: true, // Auto-convert numbers, booleans
+        });
+        if (result.errors.length > 0) {
+            const errorMessages = result.errors.map((e) => e.message).join(', ');
+            throw new Error(`CSV parsing errors: ${errorMessages}`);
+        }
+        if (result.data.length === 0) {
+            throw new Error('CSV file is empty (no data rows found)');
+        }
+        // Return first row as test data
+        const testData = result.data[0];
+        log.debug('Loaded CSV data', {
+            filePath,
+            rowCount: result.data.length,
+            fields: Object.keys(testData),
+        });
+        return testData;
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        log.error('Failed to load CSV file', { filePath, error: errorMessage });
+        throw new Error(`Failed to load CSV file: ${errorMessage}`);
+    }
+}
+/**
+ * Loads test data from JSON file
+ *
+ * Expects a JSON object with key-value pairs.
+ *
+ * @param filePath - Path to JSON file
+ * @returns Test data object
+ * @internal
+ */
+async function loadJsonData(filePath) {
+    try {
+        // Read JSON file
+        const jsonContent = await fs.readFile(filePath, 'utf-8');
+        // Parse JSON
+        const testData = JSON.parse(jsonContent);
+        if (typeof testData !== 'object' || testData === null || Array.isArray(testData)) {
+            throw new Error('JSON file must contain an object (not an array or primitive)');
+        }
+        log.debug('Loaded JSON data', {
+            filePath,
+            fields: Object.keys(testData),
+        });
+        return testData;
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        log.error('Failed to load JSON file', { filePath, error: errorMessage });
+        throw new Error(`Failed to load JSON file: ${errorMessage}`);
+    }
+}
+/**
+ * Validates that test data contains required fields
+ *
+ * @param testData - Test data object
+ * @param requiredFields - Array of required field names
+ * @throws Error if any required field is missing
+ *
+ * @example
+ * ```typescript
+ * validateTestData(data, ['username', 'password']);
+ * // Throws if username or password is missing
+ * ```
+ */
+export function validateTestData(testData, requiredFields) {
+    const missingFields = requiredFields.filter((field) => !(field in testData));
+    if (missingFields.length > 0) {
+        throw new Error(`Test data is missing required fields: ${missingFields.join(', ')}`);
+    }
+}
+//# sourceMappingURL=data-loader.js.map

package/dist/utils/data-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-loader.js","sourceRoot":"","sources":["../../src/utils/data-loader.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,GAAG,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAgB;IACjD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAE5C,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;IAEtE,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,OAAO,CAAC;QACb,KAAK,MAAM;YACT,OAAO,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvC,KAAK,MAAM;YACT,OAAO,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAC;QACrC,KAAK,OAAO;YACV,OAAO,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC;YACE,MAAM,IAAI,KAAK,CACb,sCAAsC,GAAG,+CAA+C,CACzF,CAAC;IACN,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,aAAa,CAAC,QAAgB;IAC3C,IAAI,CAAC;QACH,kBAAkB;QAClB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEzC,kBAAkB;QAClB,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAE7C,qCAAqC;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAErD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QAED,gCAAgC;QAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAwB,CAAC;QAEpD,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE;YAC7B,QAAQ;YACR,SAAS;YACT,QAAQ,EAAE,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC9B,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,8BAA8B,YAAY,EAAE,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,WAAW,CAAC,QAAgB;IACzC,IAAI,CAAC;QACH,gBAAgB;QAChB,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAExD,YAAY;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YACpC,MAAM,EAAE,IAAI,EAAE,uBAAuB;YACrC,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,IAAI,EAAE,iCAAiC;SACvD,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,uBAAuB,aAAa,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,gCAAgC;QAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAwB,CAAC;QAEvD,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE;YAC3B,QAAQ;YACR,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM;YAC5B,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC9B,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;QACxE,MAAM,IAAI,KAAK,CAAC,4BAA4B,YAAY,EAAE,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,YAAY,CAAC,QAAgB;IAC1C,IAAI,CAAC;QACH,iBAAiB;QACjB,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEzD,aAAa;QACb,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAEzC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QAED,GAAG,CAAC,KAAK,CAAC,kBAAkB,EAAE;YAC5B,QAAQ;YACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC9B,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;QACzE,MAAM,IAAI,KAAK,CAAC,6BAA6B,YAAY,EAAE,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAA6B,EAC7B,cAAwB;IAExB,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC;IAE7E,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,yCAAyC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACpE,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/utils/errors.d.ts

@@ -0,0 +1,167 @@
+/**
+ * Custom Error Classes for OpenAPI Contract Tester
+ *
+ * Provides semantic error types with error codes for better error handling
+ * and user-friendly error messages.
+ *
+ * @module utils/errors
+ */
+/**
+ * Error codes for different failure scenarios
+ */
+export declare enum ErrorCode {
+    OPENAPI_PARSE_ERROR = "E001",
+    OPENAPI_INVALID_SPEC = "E002",
+    OPENAPI_UNSUPPORTED_VERSION = "E003",
+    OPENAPI_MISSING_PATHS = "E004",
+    OPENAPI_INVALID_SCHEMA = "E005",
+    TEST_GENERATION_FAILED = "E100",
+    NO_ENDPOINTS_FOUND = "E101",
+    INVALID_TEST_CATEGORY = "E102",
+    DATA_GENERATION_FAILED = "E103",
+    TEST_EXECUTION_FAILED = "E200",
+    HTTP_REQUEST_FAILED = "E201",
+    TIMEOUT_ERROR = "E202",
+    NETWORK_ERROR = "E203",
+    AUTH_ERROR = "E204",
+    SCHEMA_VALIDATION_FAILED = "E300",
+    RESPONSE_VALIDATION_FAILED = "E301",
+    CONTRACT_VALIDATION_FAILED = "E302",
+    BUSINESS_RULES_PARSE_ERROR = "E400",
+    BUSINESS_RULES_NOT_FOUND = "E401",
+    BUSINESS_RULES_INVALID = "E402",
+    DOCS_NOT_FOUND = "E403",
+    RULES_EXTRACTION_FAILED = "E404",
+    PACT_GENERATION_FAILED = "E500",
+    PACT_VERIFICATION_FAILED = "E501",
+    PACT_BROKER_ERROR = "E502",
+    MCP_TOOL_NOT_FOUND = "E600",
+    MCP_INVALID_ARGUMENTS = "E601",
+    MCP_INTERNAL_ERROR = "E602",
+    FILE_NOT_FOUND = "E700",
+    FILE_READ_ERROR = "E701",
+    FILE_WRITE_ERROR = "E702",
+    DIRECTORY_NOT_FOUND = "E703",
+    UNKNOWN_ERROR = "E999"
+}
+/**
+ * Base error class with error code and user-friendly messages
+ */
+export declare class BaseError extends Error {
+    /**
+     * Error code for programmatic handling
+     */
+    readonly code: ErrorCode;
+    /**
+     * User-friendly error message
+     */
+    readonly userMessage: string;
+    /**
+     * Additional context/metadata
+     */
+    readonly context?: Record<string, unknown>;
+    /**
+     * Whether this error is retryable
+     */
+    readonly retryable: boolean;
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>, retryable?: boolean);
+    /**
+     * Converts error to JSON for logging/API responses
+     */
+    toJSON(): Record<string, unknown>;
+}
+/**
+ * OpenAPI parsing and validation errors
+ */
+export declare class OpenAPIError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>);
+}
+/**
+ * Test generation errors
+ */
+export declare class TestGenerationError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>);
+}
+/**
+ * Test execution errors (potentially retryable)
+ */
+export declare class TestExecutionError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>, retryable?: boolean);
+}
+/**
+ * Validation errors
+ */
+export declare class ValidationError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>);
+}
+/**
+ * Business rules errors
+ */
+export declare class BusinessRuleError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>);
+}
+/**
+ * Pact contract testing errors
+ */
+export declare class PactError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>, retryable?: boolean);
+}
+/**
+ * MCP server errors
+ */
+export declare class MCPError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>);
+}
+/**
+ * File system errors
+ */
+export declare class FileSystemError extends BaseError {
+    constructor(code: ErrorCode, message: string, userMessage: string, context?: Record<string, unknown>);
+}
+/**
+ * Formats an error for user display (removes stack trace, sanitizes)
+ *
+ * @param error - Error to format
+ * @returns User-friendly error object
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   // ... code
+ * } catch (error) {
+ *   const formatted = formatError(error);
+ *   return { success: false, error: formatted };
+ * }
+ * ```
+ */
+export declare function formatError(error: unknown): {
+    code: string;
+    message: string;
+    retryable?: boolean;
+    context?: Record<string, unknown>;
+};
+/**
+ * Type guard to check if error is retryable
+ *
+ * @param error - Error to check
+ * @returns True if error is retryable
+ */
+export declare function isRetryableError(error: unknown): boolean;
+/**
+ * Wraps a native error in appropriate custom error class
+ *
+ * @param error - Native error
+ * @param context - Additional context
+ * @returns Custom error instance
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await fs.readFile('file.yml');
+ * } catch (error) {
+ *   throw wrapError(error, { file: 'file.yml' });
+ * }
+ * ```
+ */
+export declare function wrapError(error: unknown, context?: Record<string, unknown>): BaseError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/utils/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,oBAAY,SAAS;IAEnB,mBAAmB,SAAS;IAC5B,oBAAoB,SAAS;IAC7B,2BAA2B,SAAS;IACpC,qBAAqB,SAAS;IAC9B,sBAAsB,SAAS;IAG/B,sBAAsB,SAAS;IAC/B,kBAAkB,SAAS;IAC3B,qBAAqB,SAAS;IAC9B,sBAAsB,SAAS;IAG/B,qBAAqB,SAAS;IAC9B,mBAAmB,SAAS;IAC5B,aAAa,SAAS;IACtB,aAAa,SAAS;IACtB,UAAU,SAAS;IAGnB,wBAAwB,SAAS;IACjC,0BAA0B,SAAS;IACnC,0BAA0B,SAAS;IAGnC,0BAA0B,SAAS;IACnC,wBAAwB,SAAS;IACjC,sBAAsB,SAAS;IAC/B,cAAc,SAAS;IACvB,uBAAuB,SAAS;IAGhC,sBAAsB,SAAS;IAC/B,wBAAwB,SAAS;IACjC,iBAAiB,SAAS;IAG1B,kBAAkB,SAAS;IAC3B,qBAAqB,SAAS;IAC9B,kBAAkB,SAAS;IAG3B,cAAc,SAAS;IACvB,eAAe,SAAS;IACxB,gBAAgB,SAAS;IACzB,mBAAmB,SAAS;IAG5B,aAAa,SAAS;CACvB;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC;;OAEG;IACH,SAAgB,IAAI,EAAE,SAAS,CAAC;IAEhC;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD;;OAEG;IACH,SAAgB,SAAS,EAAE,OAAO,CAAC;gBAGjC,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,SAAS,UAAQ;IAenB;;OAEG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CASlC;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,SAAS;gBAEvC,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAIpC;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;gBAE9C,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAIpC;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;gBAE7C,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,SAAS,UAAO;CAInB;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,SAAS;gBAE1C,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAIpC;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,SAAS;gBAE5C,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAIpC;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,SAAS;gBAEpC,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,SAAS,UAAQ;CAIpB;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,SAAS;gBAEnC,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAIpC;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,SAAS;gBAE1C,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAIpC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAuBA;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAExD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,SAAS,CAkEX"}