@seontechnologies/playwright-utils 3.10.0

package/dist/cjs/api-request/schema-validation/internal/validation-engine.js

@@ -0,0 +1,395 @@
+"use strict";
+/**
+ * Advanced Schema Validation Engine
+ *
+ * This module provides comprehensive validation for JSON Schema objects with support for:
+ * - Complex schema patterns (anyOf, oneOf, allOf)
+ * - Required field validation
+ * - Property-level validation
+ * - Nested schema validation
+ * - AJV integration with caching
+ *
+ * @module ValidationEngine
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateWithAnyOfSupport = validateWithAnyOfSupport;
+exports.createValidationError = createValidationError;
+exports.formatValidationErrors = formatValidationErrors;
+/**
+ * Schema compilation cache to avoid expensive recompilations
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const compilationCache = new Map();
+const MAX_COMPILATION_CACHE_SIZE = 200;
+/**
+ * Gets or creates an AJV instance for validation
+ *
+ * @returns AJV validation instance
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getAjvInstance() {
+    // Lazy load AJV only when needed
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const Ajv = require('ajv');
+        return new Ajv({
+            allErrors: true,
+            verbose: true,
+            strict: false
+        });
+    }
+    catch {
+        throw new Error('AJV is required for JSON Schema validation. Install with: npm install ajv');
+    }
+}
+/**
+ * Gets a cached validator for the given schema, creating one if needed
+ *
+ * @param schema - Schema to compile
+ * @param ajvInstance - AJV instance to use for compilation
+ * @returns Compiled validator function
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getCachedValidator(schema, ajvInstance) {
+    const cacheKey = JSON.stringify(schema);
+    // Check if validator is already cached
+    if (compilationCache.has(cacheKey)) {
+        return compilationCache.get(cacheKey);
+    }
+    // Implement LRU-style eviction if cache is getting too large
+    if (compilationCache.size >= MAX_COMPILATION_CACHE_SIZE) {
+        // Remove the oldest entry (first key in the Map)
+        const firstKey = compilationCache.keys().next().value;
+        if (firstKey !== undefined) {
+            compilationCache.delete(firstKey);
+        }
+    }
+    // Compile and cache the validator
+    const validator = ajvInstance.compile(schema);
+    compilationCache.set(cacheKey, validator);
+    return validator;
+}
+/**
+ * Validates basic data structure against schema type requirements
+ *
+ * Ensures the root data type matches the schema expectation before
+ * proceeding with detailed property validation.
+ *
+ * @param data - Data to validate
+ * @param schema - Schema with type definition
+ * @returns Validation error if structure is invalid, null if valid
+ */
+function validateBasicStructure(data, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schema) {
+    if (schema.type === 'object' && typeof data !== 'object') {
+        return {
+            path: 'root',
+            message: 'Expected object type',
+            expected: 'object',
+            actual: typeof data
+        };
+    }
+    if (schema.type === 'array' && !Array.isArray(data)) {
+        return {
+            path: 'root',
+            message: 'Expected array type',
+            expected: 'array',
+            actual: typeof data
+        };
+    }
+    return null;
+}
+/**
+ * Validates required fields in the data object
+ *
+ * Checks that all fields listed in schema.required are present
+ * in the data object, regardless of their values.
+ *
+ * @param dataObj - Data object to check
+ * @param schema - Schema with required field definitions
+ * @returns Array of validation errors for missing required fields
+ */
+function validateRequiredFields(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+dataObj, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schema) {
+    const errors = [];
+    if (!schema.required || !Array.isArray(schema.required)) {
+        return errors;
+    }
+    for (const field of schema.required) {
+        if (!(field in dataObj)) {
+            errors.push({
+                path: `/${field}`,
+                message: `Missing required field: ${field}`,
+                expected: field,
+                actual: 'undefined'
+            });
+        }
+    }
+    return errors;
+}
+/**
+ * Validates a value against an anyOf schema constraint
+ *
+ * The anyOf constraint passes if the value matches at least one
+ * of the provided schema options. This is more flexible than oneOf
+ * which requires exactly one match.
+ *
+ * @param value - Value to validate
+ * @param prop - Property schema containing anyOf definitions
+ * @param key - Property name for error reporting
+ * @returns Validation error if no anyOf schemas match, null if valid
+ */
+function validateAnyOfProperty(value, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+prop, key) {
+    // Skip validation if anyOf is not defined or value is undefined
+    if (!prop.anyOf || value === undefined) {
+        return null;
+    }
+    // Test value against each anyOf option
+    for (const option of prop.anyOf) {
+        try {
+            const ajvInstance = getAjvInstance();
+            const validate = getCachedValidator(option, ajvInstance);
+            if (validate(value)) {
+                return null; // Value matches at least one schema
+            }
+        }
+        catch {
+            // Continue to next option if compilation fails
+            continue;
+        }
+    }
+    return {
+        path: `/${key}`,
+        message: 'Value does not match any of the anyOf schemas',
+        expected: 'one or more of anyOf schemas',
+        actual: typeof value === 'object' ? JSON.stringify(value).substring(0, 50) : value
+    };
+}
+/**
+ * Validates a value against a oneOf schema constraint
+ *
+ * The oneOf constraint passes if the value matches exactly one
+ * of the provided schema options. Matching zero or multiple
+ * schemas results in validation failure.
+ *
+ * @param value - Value to validate
+ * @param prop - Property schema containing oneOf definitions
+ * @param key - Property name for error reporting
+ * @returns Validation error if not exactly one oneOf schema matches, null if valid
+ */
+function validateOneOfProperty(value, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+prop, key) {
+    if (!prop.oneOf || value === undefined) {
+        return null;
+    }
+    let matchCount = 0;
+    const matchingSchemas = [];
+    for (let i = 0; i < prop.oneOf.length; i++) {
+        const option = prop.oneOf[i];
+        try {
+            const ajvInstance = getAjvInstance();
+            const validate = getCachedValidator(option, ajvInstance);
+            if (validate(value)) {
+                matchCount++;
+                matchingSchemas.push(`schema-${i}`);
+            }
+        }
+        catch {
+            // Schema compilation error - skip this option
+            continue;
+        }
+    }
+    // oneOf requires exactly one match
+    if (matchCount === 1) {
+        return null;
+    }
+    return {
+        path: `/${key}`,
+        message: matchCount === 0
+            ? 'Value does not match any of the oneOf schemas'
+            : `Value matches ${matchCount} schemas (${matchingSchemas.join(', ')}), but should match exactly one`,
+        expected: 'exactly one of oneOf schemas',
+        actual: value
+    };
+}
+/**
+ * Validates a value against a standard property schema
+ *
+ * Handles basic property validation using AJV compilation
+ * for properties that don't use complex constraints like
+ * anyOf or oneOf.
+ *
+ * @param value - Value to validate
+ * @param prop - Property schema definition
+ * @param key - Property name for error reporting
+ * @returns Validation error if property doesn't match schema, null if valid
+ */
+function validateStandardProperty(value, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+prop, key) {
+    if (!prop.type || value === undefined) {
+        return null;
+    }
+    try {
+        const ajvInstance = getAjvInstance();
+        const validate = getCachedValidator(prop, ajvInstance);
+        if (validate(value)) {
+            return null;
+        }
+        // Extract meaningful error message from AJV
+        const ajvError = validate.errors?.[0];
+        const errorMessage = ajvError?.message || 'Validation failed';
+        const expectedValue = prop.type || 'valid value';
+        const actualValue = typeof value;
+        return {
+            path: `/${key}`,
+            message: `${key}: ${errorMessage}`,
+            expected: expectedValue,
+            actual: actualValue
+        };
+    }
+    catch (error) {
+        return {
+            path: `/${key}`,
+            message: `Schema compilation error: ${error instanceof Error ? error.message : 'Unknown error'}`,
+            expected: 'valid schema',
+            actual: 'compilation failed'
+        };
+    }
+}
+/**
+ * Validates all properties defined in a schema against corresponding data values
+ *
+ * This function orchestrates property-level validation by applying the appropriate
+ * validation strategy (anyOf, oneOf, or standard) for each property defined in
+ * the schema.
+ *
+ * @param dataObj - Data object containing values to validate
+ * @param schema - Schema object with property definitions
+ * @param fullSpec - Complete schema specification for context
+ * @returns Array of validation errors for invalid properties
+ */
+function validateSchemaProperties(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+dataObj, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schema) {
+    const errors = [];
+    if (!schema.properties || typeof schema.properties !== 'object') {
+        return errors;
+    }
+    for (const [key, propSchema] of Object.entries(schema.properties)) {
+        const value = dataObj[key];
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const prop = propSchema;
+        // Apply validation strategies in order of complexity
+        // 1. Try anyOf validation first (most flexible)
+        const anyOfError = validateAnyOfProperty(value, prop, key);
+        if (anyOfError) {
+            errors.push(anyOfError);
+            continue; // Skip other validations if anyOf fails
+        }
+        // 2. Try oneOf validation (strict single match)
+        const oneOfError = validateOneOfProperty(value, prop, key);
+        if (oneOfError) {
+            errors.push(oneOfError);
+            continue; // Skip standard validation if oneOf fails
+        }
+        // 3. Fall back to standard property validation
+        const standardError = validateStandardProperty(value, prop, key);
+        if (standardError) {
+            errors.push(standardError);
+        }
+    }
+    return errors;
+}
+/**
+ * Main validation function with comprehensive anyOf/oneOf support
+ *
+ * This is the primary entry point for complex JSON Schema validation.
+ * It orchestrates all validation steps:
+ * 1. Basic structure validation (type checking)
+ * 2. Required field validation
+ * 3. Property-level validation with complex constraint support
+ *
+ * @param data - Data to validate against the schema
+ * @param schema - JSON Schema object with validation rules
+ * @param fullSpec - Complete schema specification for reference resolution
+ * @returns Array of validation errors (empty array means valid)
+ *
+ * @example
+ * ```typescript
+ * const schema = {
+ *   type: 'object',
+ *   required: ['name'],
+ *   properties: {
+ *     name: { type: 'string' },
+ *     age: { anyOf: [{ type: 'number' }, { type: 'null' }] }
+ *   }
+ * }
+ *
+ * const errors = validateWithAnyOfSupport(data, schema)
+ * if (errors.length === 0) {
+ *   console.log('Data is valid!')
+ * }
+ * ```
+ */
+function validateWithAnyOfSupport(data, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schema) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dataObj = data;
+    // Step 1: Validate basic data structure
+    const structureError = validateBasicStructure(data, schema);
+    if (structureError) {
+        return [structureError]; // Early return for structural failures
+    }
+    // Step 2: Collect all validation errors
+    const errors = [];
+    // Step 3: Validate required fields
+    const requiredFieldErrors = validateRequiredFields(dataObj, schema);
+    errors.push(...requiredFieldErrors);
+    // Step 4: Validate all schema properties
+    const propertyErrors = validateSchemaProperties(dataObj, schema);
+    errors.push(...propertyErrors);
+    return errors;
+}
+/**
+ * Helper function to create detailed validation error objects
+ *
+ * @param path - JSON path to the invalid property
+ * @param message - Human-readable error description
+ * @param expected - Expected value or type
+ * @param actual - Actual value or type that failed validation
+ * @returns Standardized validation error object
+ */
+function createValidationError(path, message, expected, actual) {
+    return {
+        path,
+        message,
+        expected,
+        actual
+    };
+}
+/**
+ * Helper function to format validation errors for logging
+ *
+ * @param errors - Array of validation errors
+ * @returns Formatted error summary string
+ */
+function formatValidationErrors(errors) {
+    if (errors.length === 0) {
+        return 'No validation errors';
+    }
+    return errors
+        .map((error) => `${error.path}: ${error.message} (expected: ${error.expected}, got: ${error.actual})`)
+        .join('\n');
+}
+//# sourceMappingURL=validation-engine.js.map

package/dist/cjs/api-request/schema-validation/internal/validation-engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-engine.js","sourceRoot":"","sources":["../../../../../src/api-request/schema-validation/internal/validation-engine.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;AA2XH,4DA0BC;AAWD,sDAYC;AAQD,wDAaC;AA7bD;;GAEG;AACH,8DAA8D;AAC9D,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAe,CAAA;AAC/C,MAAM,0BAA0B,GAAG,GAAG,CAAA;AAEtC;;;;GAIG;AACH,8DAA8D;AAC9D,SAAS,cAAc;IACrB,iCAAiC;IACjC,IAAI,CAAC;QACH,8DAA8D;QAC9D,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;QAC1B,OAAO,IAAI,GAAG,CAAC;YACb,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,8DAA8D;AAC9D,SAAS,kBAAkB,CAAC,MAAW,EAAE,WAAgB;IACvD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAEvC,uCAAuC;IACvC,IAAI,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACvC,CAAC;IAED,6DAA6D;IAC7D,IAAI,gBAAgB,CAAC,IAAI,IAAI,0BAA0B,EAAE,CAAC;QACxD,iDAAiD;QACjD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAA;QACrD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAED,kCAAkC;IAClC,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7C,gBAAgB,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;IAEzC,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,sBAAsB,CAC7B,IAAa;AACb,8DAA8D;AAC9D,MAAW;IAEX,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzD,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,sBAAsB;YAC/B,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,OAAO,IAAI;SACpB,CAAA;IACH,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,qBAAqB;YAC9B,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,OAAO,IAAI;SACpB,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,sBAAsB;AAC7B,8DAA8D;AAC9D,OAAY;AACZ,8DAA8D;AAC9D,MAAW;IAEX,MAAM,MAAM,GAA4B,EAAE,CAAA;IAE1C,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,IAAI,KAAK,EAAE;gBACjB,OAAO,EAAE,2BAA2B,KAAK,EAAE;gBAC3C,QAAQ,EAAE,KAAK;gBACf,MAAM,EAAE,WAAW;aACpB,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,qBAAqB,CAC5B,KAAc;AACd,8DAA8D;AAC9D,IAAS,EACT,GAAW;IAEX,gEAAgE;IAChE,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,uCAAuC;IACvC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,cAAc,EAAE,CAAA;YACpC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YAExD,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpB,OAAO,IAAI,CAAA,CAAC,oCAAoC;YAClD,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,+CAA+C;YAC/C,SAAQ;QACV,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,IAAI,GAAG,EAAE;QACf,OAAO,EAAE,+CAA+C;QACxD,QAAQ,EAAE,8BAA8B;QACxC,MAAM,EACJ,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK;KAC7E,CAAA;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,qBAAqB,CAC5B,KAAc;AACd,8DAA8D;AAC9D,IAAS,EACT,GAAW;IAEX,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,MAAM,eAAe,GAAa,EAAE,CAAA;IAEpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC5B,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,cAAc,EAAE,CAAA;YACpC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YAExD,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpB,UAAU,EAAE,CAAA;gBACZ,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;YACrC,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,8CAA8C;YAC9C,SAAQ;QACV,CAAC;IACH,CAAC;IAED,mCAAmC;IACnC,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO;QACL,IAAI,EAAE,IAAI,GAAG,EAAE;QACf,OAAO,EACL,UAAU,KAAK,CAAC;YACd,CAAC,CAAC,+CAA+C;YACjD,CAAC,CAAC,iBAAiB,UAAU,aAAa,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,iCAAiC;QACzG,QAAQ,EAAE,8BAA8B;QACxC,MAAM,EAAE,KAAK;KACd,CAAA;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,wBAAwB,CAC/B,KAAc;AACd,8DAA8D;AAC9D,IAAS,EACT,GAAW;IAEX,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,cAAc,EAAE,CAAA;QACpC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QAEtD,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,IAAI,CAAA;QACb,CAAC;QAED,4CAA4C;QAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,YAAY,GAAG,QAAQ,EAAE,OAAO,IAAI,mBAAmB,CAAA;QAC7D,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,IAAI,aAAa,CAAA;QAChD,MAAM,WAAW,GAAG,OAAO,KAAK,CAAA;QAEhC,OAAO;YACL,IAAI,EAAE,IAAI,GAAG,EAAE;YACf,OAAO,EAAE,GAAG,GAAG,KAAK,YAAY,EAAE;YAClC,QAAQ,EAAE,aAAa;YACvB,MAAM,EAAE,WAAW;SACpB,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,IAAI,EAAE,IAAI,GAAG,EAAE;YACf,OAAO,EAAE,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE;YAChG,QAAQ,EAAE,cAAc;YACxB,MAAM,EAAE,oBAAoB;SAC7B,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,wBAAwB;AAC/B,8DAA8D;AAC9D,OAAY;AACZ,8DAA8D;AAC9D,MAAW;IAEX,MAAM,MAAM,GAA4B,EAAE,CAAA;IAE1C,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QAChE,OAAO,MAAM,CAAA;IACf,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAClE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAC1B,8DAA8D;QAC9D,MAAM,IAAI,GAAG,UAAiB,CAAA;QAE9B,qDAAqD;QACrD,gDAAgD;QAChD,MAAM,UAAU,GAAG,qBAAqB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;QAC1D,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACvB,SAAQ,CAAC,wCAAwC;QACnD,CAAC;QAED,gDAAgD;QAChD,MAAM,UAAU,GAAG,qBAAqB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;QAC1D,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACvB,SAAQ,CAAC,0CAA0C;QACrD,CAAC;QAED,+CAA+C;QAC/C,MAAM,aAAa,GAAG,wBAAwB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;QAChE,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,wBAAwB,CACtC,IAAa;AACb,8DAA8D;AAC9D,MAAW;IAEX,8DAA8D;IAC9D,MAAM,OAAO,GAAG,IAAW,CAAA;IAE3B,wCAAwC;IACxC,MAAM,cAAc,GAAG,sBAAsB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC3D,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,CAAC,cAAc,CAAC,CAAA,CAAC,uCAAuC;IACjE,CAAC;IAED,wCAAwC;IACxC,MAAM,MAAM,GAA4B,EAAE,CAAA;IAE1C,mCAAmC;IACnC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACnE,MAAM,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAA;IAEnC,yCAAyC;IACzC,MAAM,cAAc,GAAG,wBAAwB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAChE,MAAM,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAA;IAE9B,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,IAAY,EACZ,OAAe,EACf,QAAiB,EACjB,MAAe;IAEf,OAAO;QACL,IAAI;QACJ,OAAO;QACP,QAAQ;QACR,MAAM;KACP,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,MAA+B;IAE/B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,sBAAsB,CAAA;IAC/B,CAAC;IAED,OAAO,MAAM;SACV,GAAG,CACF,CAAC,KAAK,EAAE,EAAE,CACR,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,eAAe,KAAK,CAAC,QAAQ,UAAU,KAAK,CAAC,MAAM,GAAG,CACxF;SACA,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC"}

package/dist/cjs/api-request/schema-validation/types.d.ts

@@ -0,0 +1,92 @@
+/** Schema validation types for API request responses */
+import type { ZodSchema } from 'zod';
+import type { ApiRequestResponse } from '../api-request';
+/** Supported schema formats */
+export type SupportedSchema = object | ZodSchema | string;
+/** Validation mode - throw errors or return results */
+export type ValidationMode = 'throw' | 'return';
+/** Shape validation function for custom assertions */
+export type ShapeValidator<T = unknown> = (value: T) => boolean | void;
+/** Shape validation object with nested assertions */
+export type ShapeAssertion = {
+    [key: string]: unknown | ShapeValidator | ShapeAssertion;
+};
+/** Options for validateSchema method */
+export type ValidateSchemaOptions = {
+    /** Custom shape assertions to run alongside schema validation */
+    shape?: ShapeAssertion;
+    /** Validation mode - 'throw' (default) or 'return' */
+    mode?: ValidationMode;
+    /** Enable UI mode display for this validation */
+    uiMode?: boolean;
+    /** For OpenAPI schemas - target specific path (interchangeable with endpoint) */
+    path?: string;
+    /** For OpenAPI schemas - target specific endpoint (interchangeable with path) */
+    endpoint?: string;
+    /** For OpenAPI schemas - target specific HTTP method */
+    method?: string;
+    /** For OpenAPI schemas - target specific status code */
+    status?: number;
+};
+/** Validation error details */
+export type ValidationErrorDetail = {
+    /** JSON path to the error location */
+    path: string;
+    /** Error message */
+    message: string;
+    /** Expected value or constraint */
+    expected?: unknown;
+    /** Actual value that failed validation */
+    actual?: unknown;
+};
+/** Validation result details */
+export type ValidationResult = {
+    /** Whether validation passed */
+    success: boolean;
+    /** List of validation errors (empty if success) */
+    errors: ValidationErrorDetail[];
+    /** Schema format that was used */
+    schemaFormat: 'JSON Schema' | 'Zod Schema' | 'YAML OpenAPI' | 'JSON OpenAPI';
+    /** Validation execution time in milliseconds */
+    validationTime: number;
+    /** The actual schema used for validation (for debugging) */
+    schema?: object;
+    /** UI display data if uiMode is enabled */
+    uiData?: {
+        statusIcon: '✅' | '❌';
+        validationSummary: string;
+        schemaInfo: string;
+        errorDetails?: string[];
+    };
+};
+/** Enhanced API response with validation result */
+export type ValidatedApiResponse<T = unknown> = ApiRequestResponse<T> & {
+    /** Validation result details */
+    validationResult: ValidationResult;
+    /** Original response before validation */
+    originalResponse: ApiRequestResponse<T>;
+};
+/** Validation error thrown when schema validation fails */
+export declare class ValidationError extends Error {
+    readonly validationResult: ValidationResult;
+    readonly requestContext?: {
+        method: string;
+        path: string;
+        body?: unknown;
+        headers?: Record<string, string>;
+    } | undefined;
+    readonly responseContext?: {
+        status: number;
+        body: unknown;
+    } | undefined;
+    constructor(message: string, validationResult: ValidationResult, requestContext?: {
+        method: string;
+        path: string;
+        body?: unknown;
+        headers?: Record<string, string>;
+    } | undefined, responseContext?: {
+        status: number;
+        body: unknown;
+    } | undefined);
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/cjs/api-request/schema-validation/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api-request/schema-validation/types.ts"],"names":[],"mappings":"AAAA,wDAAwD;AAExD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExD,+BAA+B;AAC/B,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,SAAS,GACT,MAAM,CAAA;AAEV,uDAAuD;AACvD,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,QAAQ,CAAA;AAE/C,sDAAsD;AACtD,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAA;AAEtE,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,GAAG,cAAc,CAAA;CACzD,CAAA;AAED,wCAAwC;AACxC,MAAM,MAAM,qBAAqB,GAAG;IAClC,iEAAiE;IACjE,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB,sDAAsD;IACtD,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,iDAAiD;IACjD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iFAAiF;IACjF,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,+BAA+B;AAC/B,MAAM,MAAM,qBAAqB,GAAG;IAClC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,gCAAgC;AAChC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gCAAgC;IAChC,OAAO,EAAE,OAAO,CAAA;IAChB,mDAAmD;IACnD,MAAM,EAAE,qBAAqB,EAAE,CAAA;IAC/B,kCAAkC;IAClC,YAAY,EAAE,aAAa,GAAG,YAAY,GAAG,cAAc,GAAG,cAAc,CAAA;IAC5E,gDAAgD;IAChD,cAAc,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,2CAA2C;IAC3C,MAAM,CAAC,EAAE;QACP,UAAU,EAAE,GAAG,GAAG,GAAG,CAAA;QACrB,iBAAiB,EAAE,MAAM,CAAA;QACzB,UAAU,EAAE,MAAM,CAAA;QAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;KACxB,CAAA;CACF,CAAA;AAED,mDAAmD;AACnD,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,OAAO,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG;IACtE,gCAAgC;IAChC,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,0CAA0C;IAC1C,gBAAgB,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAA;CACxC,CAAA;AAED,2DAA2D;AAC3D,qBAAa,eAAgB,SAAQ,KAAK;aAGtB,gBAAgB,EAAE,gBAAgB;aAClC,cAAc,CAAC,EAAE;QAC/B,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACjC;aACe,eAAe,CAAC,EAAE;QAChC,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,OAAO,CAAA;KACd;gBAXD,OAAO,EAAE,MAAM,EACC,gBAAgB,EAAE,gBAAgB,EAClC,cAAc,CAAC,EAAE;QAC/B,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACjC,YAAA,EACe,eAAe,CAAC,EAAE;QAChC,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,OAAO,CAAA;KACd,YAAA;CAKJ"}

package/dist/cjs/api-request/schema-validation/types.js

@@ -0,0 +1,16 @@
+"use strict";
+/** Schema validation types for API request responses */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = void 0;
+/** Validation error thrown when schema validation fails */
+class ValidationError extends Error {
+    constructor(message, validationResult, requestContext, responseContext) {
+        super(message);
+        this.validationResult = validationResult;
+        this.requestContext = requestContext;
+        this.responseContext = responseContext;
+        this.name = 'ValidationError';
+    }
+}
+exports.ValidationError = ValidationError;
+//# sourceMappingURL=types.js.map

package/dist/cjs/api-request/schema-validation/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api-request/schema-validation/types.ts"],"names":[],"mappings":";AAAA,wDAAwD;;;AAiFxD,2DAA2D;AAC3D,MAAa,eAAgB,SAAQ,KAAK;IACxC,YACE,OAAe,EACC,gBAAkC,EAClC,cAKf,EACe,eAGf;QAED,KAAK,CAAC,OAAO,CAAC,CAAA;QAZE,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,mBAAc,GAAd,cAAc,CAK7B;QACe,oBAAe,GAAf,eAAe,CAG9B;QAGD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IAC/B,CAAC;CACF;AAlBD,0CAkBC"}

package/dist/cjs/api-request/ui-display.d.ts

@@ -0,0 +1,42 @@
+/**
+ * UI display functionality for API requests
+ * Adapted from pw-api-plugin to provide rich visual feedback in Playwright UI
+ */
+import { type Page } from '@playwright/test';
+/** Request data interface for UI display */
+export interface RequestDataInterface {
+    url: string;
+    method: string;
+    headers?: object;
+    data?: any;
+    params?: object;
+    otherOptions?: object;
+    validationInfo?: {
+        schemaFormat: string;
+        validationTime: number;
+        success: boolean;
+        errorCount: number;
+    };
+}
+/** Response data interface for UI display */
+export interface ResponseDataInterface {
+    status: number;
+    statusClass: string;
+    statusText: string;
+    headers?: object;
+    body?: any;
+    duration?: number;
+    validationResult?: {
+        icon: '✅' | '❌';
+        summary: string;
+        schemaInfo: string;
+        errors?: string[];
+        schema?: object;
+    };
+}
+/**
+ * Adds an API card to the UI by updating the page content with the provided request and response data.
+ * Only works when a page context is available (UI tests)
+ */
+export declare const addApiCardToUI: (requestData: RequestDataInterface, responseData: ResponseDataInterface, page?: Page, uiMode?: boolean) => Promise<void>;
+//# sourceMappingURL=ui-display.d.ts.map

package/dist/cjs/api-request/ui-display.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-display.d.ts","sourceRoot":"","sources":["../../../src/api-request/ui-display.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH,OAAO,EAAQ,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAGlD,4CAA4C;AAC5C,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,cAAc,EAAE,MAAM,CAAA;QACtB,OAAO,EAAE,OAAO,CAAA;QAChB,UAAU,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,6CAA6C;AAC7C,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gBAAgB,CAAC,EAAE;QACjB,IAAI,EAAE,GAAG,GAAG,GAAG,CAAA;QACf,OAAO,EAAE,MAAM,CAAA;QACf,UAAU,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;QACjB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,aAAa,oBAAoB,EACjC,cAAc,qBAAqB,EACnC,OAAO,IAAI,EACX,SAAS,OAAO,KACf,OAAO,CAAC,IAAI,CAgCd,CAAA"}