@machina.ai/openapi-contract-tester 2.1.0

package/dist/utils/resilience.js

@@ -0,0 +1,269 @@
+/**
+ * Resilience Utilities - Retry Logic and Circuit Breaker
+ *
+ * Provides retry mechanisms and circuit breaker pattern for handling
+ * transient failures gracefully.
+ *
+ * @module utils/resilience
+ */
+import { createLogger } from './logger.js';
+import { isRetryableError } from './errors.js';
+const log = createLogger('resilience');
+/**
+ * Executes a function with retry logic and exponential backoff
+ *
+ * @param fn - Async function to execute
+ * @param options - Retry configuration
+ * @returns Result of the function
+ *
+ * @example
+ * ```typescript
+ * const result = await withRetry(
+ *   async () => fetch('https://api.example.com/data'),
+ *   {
+ *     maxRetries: 3,
+ *     initialDelay: 1000,
+ *     onRetry: (attempt, error, delay) => {
+ *       console.log(`Retry attempt ${attempt} after ${delay}ms`);
+ *     }
+ *   }
+ * );
+ * ```
+ */
+export async function withRetry(fn, options = {}) {
+    const { maxRetries = 3, initialDelay = 1000, maxDelay = 10000, backoffMultiplier = 2, shouldRetry = isRetryableError, onRetry, } = options;
+    let lastError;
+    let delay = initialDelay;
+    for (let attempt = 0; attempt <= maxRetries; attempt++) {
+        try {
+            return await fn();
+        }
+        catch (error) {
+            lastError = error;
+            // Check if we should retry
+            if (attempt === maxRetries || !shouldRetry(error)) {
+                log.debug('Max retries reached or error not retryable', {
+                    attempt,
+                    maxRetries,
+                    retryable: shouldRetry(error),
+                });
+                throw error;
+            }
+            // Calculate delay with exponential backoff
+            const currentDelay = Math.min(delay, maxDelay);
+            delay *= backoffMultiplier;
+            log.warn('Retrying operation', {
+                attempt: attempt + 1,
+                maxRetries,
+                delay: currentDelay,
+                error: error instanceof Error ? error.message : String(error),
+            });
+            // Call retry callback if provided
+            if (onRetry) {
+                onRetry(attempt + 1, error, currentDelay);
+            }
+            // Wait before retrying
+            await sleep(currentDelay);
+        }
+    }
+    // This should never be reached, but TypeScript needs it
+    throw lastError;
+}
+/**
+ * Circuit breaker states
+ */
+export var CircuitState;
+(function (CircuitState) {
+    CircuitState["CLOSED"] = "CLOSED";
+    CircuitState["OPEN"] = "OPEN";
+    CircuitState["HALF_OPEN"] = "HALF_OPEN";
+})(CircuitState || (CircuitState = {}));
+/**
+ * Circuit Breaker pattern implementation
+ *
+ * Prevents cascading failures by failing fast when a service is down
+ *
+ * @example
+ * ```typescript
+ * const breaker = new CircuitBreaker({
+ *   failureThreshold: 5,
+ *   resetTimeout: 60000,
+ * });
+ *
+ * try {
+ *   const result = await breaker.execute(async () => {
+ *     return await fetch('https://api.example.com/data');
+ *   });
+ * } catch (error) {
+ *   console.error('Request failed or circuit is open');
+ * }
+ * ```
+ */
+export class CircuitBreaker {
+    state = CircuitState.CLOSED;
+    failureCount = 0;
+    successCount = 0;
+    nextAttemptTime = 0;
+    options;
+    constructor(options = {}) {
+        this.options = {
+            failureThreshold: options.failureThreshold ?? 5,
+            resetTimeout: options.resetTimeout ?? 60000,
+            successThreshold: options.successThreshold ?? 2,
+            onStateChange: options.onStateChange ?? (() => { }),
+        };
+    }
+    /**
+     * Executes a function with circuit breaker protection
+     *
+     * @param fn - Async function to execute
+     * @returns Result of the function
+     * @throws Error if circuit is OPEN
+     */
+    async execute(fn) {
+        if (this.state === CircuitState.OPEN) {
+            if (Date.now() < this.nextAttemptTime) {
+                const error = new Error('Circuit breaker is OPEN');
+                log.warn('Circuit breaker rejected request', {
+                    state: this.state,
+                    nextAttemptTime: new Date(this.nextAttemptTime).toISOString(),
+                });
+                throw error;
+            }
+            // Transition to HALF_OPEN to test if service recovered
+            this.transitionTo(CircuitState.HALF_OPEN);
+        }
+        try {
+            const result = await fn();
+            this.onSuccess();
+            return result;
+        }
+        catch (error) {
+            this.onFailure();
+            throw error;
+        }
+    }
+    /**
+     * Called when operation succeeds
+     * @internal
+     */
+    onSuccess() {
+        if (this.state === CircuitState.HALF_OPEN) {
+            this.successCount++;
+            log.debug('Circuit breaker success in HALF_OPEN', {
+                successCount: this.successCount,
+                threshold: this.options.successThreshold,
+            });
+            if (this.successCount >= this.options.successThreshold) {
+                this.transitionTo(CircuitState.CLOSED);
+                this.successCount = 0;
+            }
+        }
+        else if (this.state === CircuitState.CLOSED) {
+            // Reset failure count on success
+            this.failureCount = 0;
+        }
+    }
+    /**
+     * Called when operation fails
+     * @internal
+     */
+    onFailure() {
+        this.failureCount++;
+        log.debug('Circuit breaker failure', {
+            state: this.state,
+            failureCount: this.failureCount,
+            threshold: this.options.failureThreshold,
+        });
+        if (this.state === CircuitState.HALF_OPEN) {
+            // Single failure in HALF_OPEN reopens circuit
+            this.transitionTo(CircuitState.OPEN);
+            this.successCount = 0;
+        }
+        else if (this.failureCount >= this.options.failureThreshold) {
+            this.transitionTo(CircuitState.OPEN);
+        }
+    }
+    /**
+     * Transitions circuit to a new state
+     * @internal
+     */
+    transitionTo(newState) {
+        const oldState = this.state;
+        this.state = newState;
+        if (newState === CircuitState.OPEN) {
+            this.nextAttemptTime = Date.now() + this.options.resetTimeout;
+            log.warn('Circuit breaker OPENED', {
+                failureCount: this.failureCount,
+                resetTimeout: this.options.resetTimeout,
+                nextAttemptTime: new Date(this.nextAttemptTime).toISOString(),
+            });
+        }
+        else if (newState === CircuitState.CLOSED) {
+            this.failureCount = 0;
+            log.info('Circuit breaker CLOSED', { previousState: oldState });
+        }
+        else if (newState === CircuitState.HALF_OPEN) {
+            log.info('Circuit breaker HALF_OPEN (testing recovery)');
+        }
+        this.options.onStateChange(oldState, newState);
+    }
+    /**
+     * Gets current circuit state
+     */
+    getState() {
+        return this.state;
+    }
+    /**
+     * Gets current failure count
+     */
+    getFailureCount() {
+        return this.failureCount;
+    }
+    /**
+     * Manually resets the circuit breaker
+     */
+    reset() {
+        log.info('Circuit breaker manually reset');
+        this.transitionTo(CircuitState.CLOSED);
+        this.failureCount = 0;
+        this.successCount = 0;
+        this.nextAttemptTime = 0;
+    }
+}
+/**
+ * Helper function to sleep for a given duration
+ *
+ * @param ms - Milliseconds to sleep
+ */
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+/**
+ * Creates a resilient version of a function with both retry and circuit breaker
+ *
+ * @param fn - Function to make resilient
+ * @param retryOptions - Retry configuration
+ * @param circuitBreakerOptions - Circuit breaker configuration
+ * @returns Wrapped function
+ *
+ * @example
+ * ```typescript
+ * const resilientFetch = makeResilient(
+ *   async (url: string) => fetch(url),
+ *   { maxRetries: 3 },
+ *   { failureThreshold: 5 }
+ * );
+ *
+ * const data = await resilientFetch('https://api.example.com/data');
+ * ```
+ */
+export function makeResilient(fn, retryOptions, circuitBreakerOptions) {
+    const breaker = new CircuitBreaker(circuitBreakerOptions);
+    return (async (...args) => {
+        return await breaker.execute(async () => {
+            return await withRetry(() => fn(...args), retryOptions);
+        });
+    });
+}
+//# sourceMappingURL=resilience.js.map

package/dist/utils/resilience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resilience.js","sourceRoot":"","sources":["../../src/utils/resilience.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,GAAG,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;AA0CvC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,EAAoB,EACpB,UAAwB,EAAE;IAE1B,MAAM,EACJ,UAAU,GAAG,CAAC,EACd,YAAY,GAAG,IAAI,EACnB,QAAQ,GAAG,KAAK,EAChB,iBAAiB,GAAG,CAAC,EACrB,WAAW,GAAG,gBAAgB,EAC9B,OAAO,GACR,GAAG,OAAO,CAAC;IAEZ,IAAI,SAAkB,CAAC;IACvB,IAAI,KAAK,GAAG,YAAY,CAAC;IAEzB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,EAAE,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,KAAK,CAAC;YAElB,2BAA2B;YAC3B,IAAI,OAAO,KAAK,UAAU,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClD,GAAG,CAAC,KAAK,CAAC,4CAA4C,EAAE;oBACtD,OAAO;oBACP,UAAU;oBACV,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC;iBAC9B,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;YACd,CAAC;YAED,2CAA2C;YAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC/C,KAAK,IAAI,iBAAiB,CAAC;YAE3B,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE;gBAC7B,OAAO,EAAE,OAAO,GAAG,CAAC;gBACpB,UAAU;gBACV,KAAK,EAAE,YAAY;gBACnB,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAC9D,CAAC,CAAC;YAEH,kCAAkC;YAClC,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,OAAO,GAAG,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;YAC5C,CAAC;YAED,uBAAuB;YACvB,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,wDAAwD;IACxD,MAAM,SAAS,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,6BAAa,CAAA;IACb,uCAAuB,CAAA;AACzB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AA8BD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,cAAc;IACjB,KAAK,GAAiB,YAAY,CAAC,MAAM,CAAC;IAC1C,YAAY,GAAG,CAAC,CAAC;IACjB,YAAY,GAAG,CAAC,CAAC;IACjB,eAAe,GAAG,CAAC,CAAC;IACX,OAAO,CAAkC;IAE1D,YAAY,UAAiC,EAAE;QAC7C,IAAI,CAAC,OAAO,GAAG;YACb,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,CAAC;YAC/C,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,KAAK;YAC3C,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,CAAC;YAC/C,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;SACnD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAI,EAAoB;QACnC,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;gBACtC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;gBACnD,GAAG,CAAC,IAAI,CAAC,kCAAkC,EAAE;oBAC3C,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,eAAe,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE;iBAC9D,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;YACd,CAAC;YAED,uDAAuD;YACvD,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;YAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,SAAS;QACf,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,SAAS,EAAE,CAAC;YAC1C,IAAI,CAAC,YAAY,EAAE,CAAC;YAEpB,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE;gBAChD,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB;aACzC,CAAC,CAAC;YAEH,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBACvD,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBACvC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;YAC9C,iCAAiC;YACjC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,SAAS;QACf,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE;YACnC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB;SACzC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,SAAS,EAAE,CAAC;YAC1C,8CAA8C;YAC9C,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACxB,CAAC;aAAM,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9D,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,QAAsB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;QAEtB,IAAI,QAAQ,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YAC9D,GAAG,CAAC,IAAI,CAAC,wBAAwB,EAAE;gBACjC,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;gBACvC,eAAe,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE;aAC9D,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,QAAQ,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;YAC5C,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,GAAG,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;QAClE,CAAC;aAAM,IAAI,QAAQ,KAAK,YAAY,CAAC,SAAS,EAAE,CAAC;YAC/C,GAAG,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,GAAG,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC3C,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;IAC3B,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,aAAa,CAC3B,EAAK,EACL,YAA2B,EAC3B,qBAA6C;IAE7C,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,qBAAqB,CAAC,CAAC;IAE1D,OAAO,CAAC,KAAK,EAAE,GAAG,IAAmB,EAAmC,EAAE;QACxE,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACtC,OAAO,MAAM,SAAS,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAM,CAAC;AACV,CAAC"}

package/dist/validators/openapi-validator.d.ts

@@ -0,0 +1,198 @@
+/**
+ * OpenAPI Response Validator
+ *
+ * Validates API responses against OpenAPI specifications.
+ * Checks status codes, headers, content types, and response bodies.
+ *
+ * @module validators/openapi-validator
+ */
+import type { TestResult, ParsedEndpoint, ValidationResult } from '../types/index.js';
+/**
+ * Validates an API response against OpenAPI specification
+ *
+ * Checks:
+ * - Status code matches expected
+ * - Content-Type header is correct
+ * - Response body matches schema
+ *
+ * @param response - Actual API response
+ * @param endpoint - Expected endpoint definition
+ * @param expectedStatus - Expected status code
+ * @returns Validation result with detailed errors
+ *
+ * @example
+ * ```typescript
+ * const response = {
+ *   status: 200,
+ *   headers: { 'content-type': 'application/json' },
+ *   body: { id: 1, name: 'John' }
+ * };
+ *
+ * const result = validateResponse(response, endpoint, 200);
+ * if (!result.valid) {
+ *   console.error('Response validation failed:', result.errors);
+ * }
+ * ```
+ */
+export declare function validateResponse(response: {
+    status: number;
+    headers: Record<string, string>;
+    body: unknown;
+}, endpoint: ParsedEndpoint, expectedStatus: number): ValidationResult;
+/**
+ * Validates that response status code is in the 2xx success range
+ *
+ * @param status - HTTP status code
+ * @returns True if status is successful (200-299)
+ *
+ * @example
+ * ```typescript
+ * isSuccessStatus(200) // true
+ * isSuccessStatus(201) // true
+ * isSuccessStatus(204) // true
+ * isSuccessStatus(400) // false
+ * isSuccessStatus(500) // false
+ * ```
+ */
+export declare function isSuccessStatus(status: number): boolean;
+/**
+ * Validates that response status code is in the 4xx client error range
+ *
+ * @param status - HTTP status code
+ * @returns True if status is client error (400-499)
+ *
+ * @example
+ * ```typescript
+ * isClientError(400) // true
+ * isClientError(404) // true
+ * isClientError(422) // true
+ * isClientError(200) // false
+ * isClientError(500) // false
+ * ```
+ */
+export declare function isClientError(status: number): boolean;
+/**
+ * Validates that response status code is in the 5xx server error range
+ *
+ * @param status - HTTP status code
+ * @returns True if status is server error (500-599)
+ *
+ * @example
+ * ```typescript
+ * isServerError(500) // true
+ * isServerError(503) // true
+ * isServerError(200) // false
+ * isServerError(400) // false
+ * ```
+ */
+export declare function isServerError(status: number): boolean;
+/**
+ * Gets a human-readable description of an HTTP status code
+ *
+ * @param status - HTTP status code
+ * @returns Description of the status code
+ *
+ * @example
+ * ```typescript
+ * getStatusDescription(200) // "OK"
+ * getStatusDescription(404) // "Not Found"
+ * getStatusDescription(500) // "Internal Server Error"
+ * ```
+ */
+export declare function getStatusDescription(status: number): string;
+/**
+ * Validates test result against expected outcome
+ *
+ * Compares actual test result with expected values and generates
+ * detailed validation errors.
+ *
+ * @param testResult - Actual test execution result
+ * @param expectedStatus - Expected HTTP status code
+ * @param endpoint - Endpoint definition with response schemas
+ * @returns Validation result
+ *
+ * @example
+ * ```typescript
+ * const testResult = {
+ *   id: 'test-1',
+ *   name: 'POST /users',
+ *   status: 'passed',
+ *   actualStatus: 201,
+ *   response: { id: 1, email: 'user@example.com' }
+ * };
+ *
+ * const result = validateTestResult(testResult, 201, endpoint);
+ * if (!result.valid) {
+ *   console.error('Test result validation failed');
+ * }
+ * ```
+ */
+export declare function validateTestResult(testResult: TestResult, expectedStatus: number, endpoint: ParsedEndpoint): ValidationResult;
+/**
+ * Validates error response format
+ *
+ * Many APIs follow standard error response formats (RFC 7807, JSON:API, etc.).
+ * This function checks if error responses contain expected fields.
+ *
+ * @param response - Error response body
+ * @param expectedFormat - Expected error format
+ * @returns Validation result
+ *
+ * @example
+ * ```typescript
+ * const errorResponse = {
+ *   error: 'Bad Request',
+ *   message: 'Email is required',
+ *   statusCode: 400
+ * };
+ *
+ * const result = validateErrorResponse(errorResponse, 'standard');
+ * ```
+ */
+export declare function validateErrorResponse(response: unknown, expectedFormat?: 'standard' | 'rfc7807' | 'jsonapi'): ValidationResult;
+/**
+ * Compares two response bodies for equality
+ *
+ * Performs deep comparison, useful for contract testing where
+ * exact response structure is expected.
+ *
+ * @param actual - Actual response body
+ * @param expected - Expected response body
+ * @returns True if responses match
+ *
+ * @example
+ * ```typescript
+ * const actual = { id: 1, name: 'John' };
+ * const expected = { id: 1, name: 'John' };
+ * const matches = compareResponses(actual, expected); // true
+ * ```
+ */
+export declare function compareResponses(actual: unknown, expected: unknown): boolean;
+/**
+ * Extracts error details from a failed response
+ *
+ * Attempts to extract meaningful error information from various
+ * error response formats.
+ *
+ * @param response - Error response body
+ * @returns Extracted error details
+ *
+ * @example
+ * ```typescript
+ * const errorResponse = {
+ *   error: 'ValidationError',
+ *   message: 'Email is required',
+ *   statusCode: 400,
+ *   details: { field: 'email' }
+ * };
+ *
+ * const details = extractErrorDetails(errorResponse);
+ * // { message: 'Email is required', code: 'ValidationError', details: { field: 'email' } }
+ * ```
+ */
+export declare function extractErrorDetails(response: unknown): {
+    message?: string;
+    code?: string;
+    details?: unknown;
+};
+//# sourceMappingURL=openapi-validator.d.ts.map

package/dist/validators/openapi-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-validator.d.ts","sourceRoot":"","sources":["../../src/validators/openapi-validator.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAGtF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE;IACR,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,EAAE,OAAO,CAAC;CACf,EACD,QAAQ,EAAE,cAAc,EACxB,cAAc,EAAE,MAAM,GACrB,gBAAgB,CA+ClB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAgB3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,MAAM,EACtB,QAAQ,EAAE,cAAc,GACvB,gBAAgB,CA4ClB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,OAAO,EACjB,cAAc,GAAE,UAAU,GAAG,SAAS,GAAG,SAAsB,GAC9D,gBAAgB,CAwDlB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAE5E;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,OAAO,GAAG;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAYA"}