@seontechnologies/playwright-utils 3.10.0

package/dist/cjs/api-request/schema-validation/internal/shape-validator.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Shape Validation Engine
+ *
+ * This module provides advanced shape validation capabilities for API responses,
+ * allowing flexible validation patterns including nested objects, functions, and
+ * direct value comparisons.
+ *
+ * @module ShapeValidator
+ */
+import type { ValidationErrorDetail, ShapeAssertion } from '../types';
+/**
+ * Execute shape validation assertions against data
+ *
+ * Shape validation provides a flexible way to validate data structure and values
+ * without requiring formal schemas. It supports:
+ * - Direct value comparisons
+ * - Function-based validators
+ * - Nested object validation
+ * - Custom validation logic
+ *
+ * @param data - Data to validate against shape assertions
+ * @param shapeAssertion - Shape validation rules
+ * @param basePath - Base path for error reporting (used internally for nesting)
+ * @returns Array of validation errors (empty if valid)
+ *
+ * @example
+ * ```typescript
+ * // Direct value validation
+ * const errors = await validateShape(
+ *   { status: 200, name: "test" },
+ *   { status: 200, name: (value) => typeof value === 'string' }
+ * )
+ *
+ * // Nested validation
+ * const errors = await validateShape(
+ *   { user: { id: 123, name: "John" } },
+ *   { user: { id: 123, name: (value) => value.length > 0 } }
+ * )
+ * ```
+ */
+export declare function validateShape(data: unknown, shapeAssertion: ShapeAssertion, basePath?: string): Promise<ValidationErrorDetail[]>;
+/**
+ * Create a shape validator function for common validation patterns
+ *
+ * @param validatorFn - Function that returns true if value is valid
+ * @param errorMessage - Custom error message for validation failures
+ * @returns Shape validator function
+ *
+ * @example
+ * ```typescript
+ * const emailValidator = createShapeValidator(
+ *   (value) => typeof value === 'string' && value.includes('@'),
+ *   'Must be a valid email address'
+ * )
+ *
+ * const errors = await validateShape(
+ *   { email: 'invalid-email' },
+ *   { email: emailValidator }
+ * )
+ * ```
+ */
+export declare function createShapeValidator(validatorFn: (value: unknown) => boolean, errorMessage: string): (value: unknown) => boolean;
+/**
+ * Common shape validators for typical validation scenarios
+ */
+export declare const ShapeValidators: {
+    /**
+     * Validates that a value is a non-empty string
+     */
+    readonly nonEmptyString: (value: unknown) => boolean;
+    /**
+     * Validates that a value is a positive number
+     */
+    readonly positiveNumber: (value: unknown) => boolean;
+    /**
+     * Validates that a value is a non-empty array
+     */
+    readonly nonEmptyArray: (value: unknown) => boolean;
+    /**
+     * Validates that a value exists (not null or undefined)
+     */
+    readonly exists: (value: unknown) => value is {};
+    /**
+     * Creates a validator for string length constraints
+     */
+    readonly stringLength: (min: number, max?: number) => (value: unknown) => boolean;
+    /**
+     * Creates a validator for numeric range constraints
+     */
+    readonly numberRange: (min: number, max: number) => (value: unknown) => boolean;
+    /**
+     * Creates a validator that checks if value matches one of the allowed values
+     */
+    readonly oneOf: <T>(...allowedValues: T[]) => (value: unknown) => value is T;
+};
+//# sourceMappingURL=shape-validator.d.ts.map

package/dist/cjs/api-request/schema-validation/internal/shape-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shape-validator.d.ts","sourceRoot":"","sources":["../../../../../src/api-request/schema-validation/internal/shape-validator.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,OAAO,EACb,cAAc,EAAE,cAAc,EAC9B,QAAQ,SAAK,GACZ,OAAO,CAAC,qBAAqB,EAAE,CAAC,CA+DlC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,EACxC,YAAY,EAAE,MAAM,GACnB,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAQ7B;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;IAC1B;;OAEG;qCACqB,OAAO;IAG/B;;OAEG;qCACqB,OAAO;IAE/B;;OAEG;oCACoB,OAAO;IAE9B;;OAEG;6BACa,OAAO;IAEvB;;OAEG;iCACiB,MAAM,QAAQ,MAAM,aAAa,OAAO;IAO5D;;OAEG;gCACgB,MAAM,OAAO,MAAM,aAAa,OAAO;IAK1D;;OAEG;qBAEA,CAAC,oBAAoB,CAAC,EAAE,aACjB,OAAO,KAAG,KAAK,IAAI,CAAC;CAGtB,CAAA"}

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

@@ -0,0 +1,180 @@
+"use strict";
+/**
+ * Shape Validation Engine
+ *
+ * This module provides advanced shape validation capabilities for API responses,
+ * allowing flexible validation patterns including nested objects, functions, and
+ * direct value comparisons.
+ *
+ * @module ShapeValidator
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShapeValidators = void 0;
+exports.validateShape = validateShape;
+exports.createShapeValidator = createShapeValidator;
+/**
+ * Execute shape validation assertions against data
+ *
+ * Shape validation provides a flexible way to validate data structure and values
+ * without requiring formal schemas. It supports:
+ * - Direct value comparisons
+ * - Function-based validators
+ * - Nested object validation
+ * - Custom validation logic
+ *
+ * @param data - Data to validate against shape assertions
+ * @param shapeAssertion - Shape validation rules
+ * @param basePath - Base path for error reporting (used internally for nesting)
+ * @returns Array of validation errors (empty if valid)
+ *
+ * @example
+ * ```typescript
+ * // Direct value validation
+ * const errors = await validateShape(
+ *   { status: 200, name: "test" },
+ *   { status: 200, name: (value) => typeof value === 'string' }
+ * )
+ *
+ * // Nested validation
+ * const errors = await validateShape(
+ *   { user: { id: 123, name: "John" } },
+ *   { user: { id: 123, name: (value) => value.length > 0 } }
+ * )
+ * ```
+ */
+async function validateShape(data, shapeAssertion, basePath = '') {
+    const errors = [];
+    for (const [key, assertion] of Object.entries(shapeAssertion)) {
+        const currentPath = basePath ? `${basePath}.${key}` : key;
+        const dataObj = data;
+        const value = dataObj[key];
+        if (typeof assertion === 'function') {
+            // Shape validator function
+            try {
+                const result = assertion(value);
+                if (result === false) {
+                    errors.push({
+                        path: currentPath,
+                        message: `Shape validation failed for ${key}`,
+                        expected: 'validation to pass',
+                        actual: value
+                    });
+                }
+            }
+            catch (error) {
+                errors.push({
+                    path: currentPath,
+                    message: `Shape validation error: ${error instanceof Error ? error.message : String(error)}`,
+                    expected: 'validation to pass',
+                    actual: value
+                });
+            }
+        }
+        else if (typeof assertion === 'object' &&
+            assertion !== null &&
+            !Array.isArray(assertion)) {
+            // Nested shape assertion
+            if (typeof value === 'object' && value !== null) {
+                const nestedErrors = await validateShape(value, assertion, currentPath);
+                errors.push(...nestedErrors);
+            }
+            else {
+                errors.push({
+                    path: currentPath,
+                    message: 'Expected object for nested shape validation',
+                    expected: 'object',
+                    actual: typeof value
+                });
+            }
+        }
+        else {
+            // Direct value comparison
+            if (value !== assertion) {
+                errors.push({
+                    path: currentPath,
+                    message: `Shape assertion failed: expected ${assertion}, got ${value}`,
+                    expected: assertion,
+                    actual: value
+                });
+            }
+        }
+    }
+    return errors;
+}
+/**
+ * Create a shape validator function for common validation patterns
+ *
+ * @param validatorFn - Function that returns true if value is valid
+ * @param errorMessage - Custom error message for validation failures
+ * @returns Shape validator function
+ *
+ * @example
+ * ```typescript
+ * const emailValidator = createShapeValidator(
+ *   (value) => typeof value === 'string' && value.includes('@'),
+ *   'Must be a valid email address'
+ * )
+ *
+ * const errors = await validateShape(
+ *   { email: 'invalid-email' },
+ *   { email: emailValidator }
+ * )
+ * ```
+ */
+function createShapeValidator(validatorFn, errorMessage) {
+    return (value) => {
+        const isValid = validatorFn(value);
+        if (!isValid) {
+            throw new Error(errorMessage);
+        }
+        return isValid;
+    };
+}
+/**
+ * Common shape validators for typical validation scenarios
+ */
+exports.ShapeValidators = {
+    /**
+     * Validates that a value is a non-empty string
+     */
+    nonEmptyString: (value) => typeof value === 'string' && value.length > 0,
+    /**
+     * Validates that a value is a positive number
+     */
+    positiveNumber: (value) => typeof value === 'number' && value > 0,
+    /**
+     * Validates that a value is a non-empty array
+     */
+    nonEmptyArray: (value) => Array.isArray(value) && value.length > 0,
+    /**
+     * Validates that a value exists (not null or undefined)
+     */
+    exists: (value) => value !== null && value !== undefined,
+    /**
+     * Creates a validator for string length constraints
+     */
+    stringLength: (min, max) => (value) => {
+        if (typeof value !== 'string')
+            return false;
+        if (value.length < min)
+            return false;
+        if (max !== undefined && value.length > max)
+            return false;
+        return true;
+    },
+    /**
+     * Creates a validator for numeric range constraints
+     */
+    numberRange: (min, max) => (value) => {
+        if (typeof value !== 'number')
+            return false;
+        return value >= min && value <= max;
+    },
+    /**
+     * Creates a validator that checks if value matches one of the allowed values
+     */
+    oneOf: (...allowedValues) => (value) => {
+        return allowedValues.includes(value);
+    }
+};
+//# sourceMappingURL=shape-validator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shape-validator.js","sourceRoot":"","sources":["../../../../../src/api-request/schema-validation/internal/shape-validator.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAkCH,sCAmEC;AAsBD,oDAWC;AAlID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,KAAK,UAAU,aAAa,CACjC,IAAa,EACb,cAA8B,EAC9B,QAAQ,GAAG,EAAE;IAEb,MAAM,MAAM,GAA4B,EAAE,CAAA;IAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QAC9D,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;QACzD,MAAM,OAAO,GAAG,IAA+B,CAAA;QAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QAE1B,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,2BAA2B;YAC3B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;gBAC/B,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;oBACrB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,WAAW;wBACjB,OAAO,EAAE,+BAA+B,GAAG,EAAE;wBAC7C,QAAQ,EAAE,oBAAoB;wBAC9B,MAAM,EAAE,KAAK;qBACd,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,2BAA2B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;oBAC5F,QAAQ,EAAE,oBAAoB;oBAC9B,MAAM,EAAE,KAAK;iBACd,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,IACL,OAAO,SAAS,KAAK,QAAQ;YAC7B,SAAS,KAAK,IAAI;YAClB,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EACzB,CAAC;YACD,yBAAyB;YACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAChD,MAAM,YAAY,GAAG,MAAM,aAAa,CACtC,KAAK,EACL,SAA2B,EAC3B,WAAW,CACZ,CAAA;gBACD,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAA;YAC9B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,6CAA6C;oBACtD,QAAQ,EAAE,QAAQ;oBAClB,MAAM,EAAE,OAAO,KAAK;iBACrB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,0BAA0B;YAC1B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,oCAAoC,SAAS,SAAS,KAAK,EAAE;oBACtE,QAAQ,EAAE,SAAS;oBACnB,MAAM,EAAE,KAAK;iBACd,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,oBAAoB,CAClC,WAAwC,EACxC,YAAoB;IAEpB,OAAO,CAAC,KAAc,EAAE,EAAE;QACxB,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAA;QAClC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;QAC/B,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA;AACH,CAAC;AAED;;GAEG;AACU,QAAA,eAAe,GAAG;IAC7B;;OAEG;IACH,cAAc,EAAE,CAAC,KAAc,EAAE,EAAE,CACjC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;IAE/C;;OAEG;IACH,cAAc,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC;IAE1E;;OAEG;IACH,aAAa,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;IAE3E;;OAEG;IACH,MAAM,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;IAEjE;;OAEG;IACH,YAAY,EAAE,CAAC,GAAW,EAAE,GAAY,EAAE,EAAE,CAAC,CAAC,KAAc,EAAE,EAAE;QAC9D,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAA;QAC3C,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;YAAE,OAAO,KAAK,CAAA;QACpC,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;YAAE,OAAO,KAAK,CAAA;QACzD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,WAAW,EAAE,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,CAAC,KAAc,EAAE,EAAE;QAC5D,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAA;QAC3C,OAAO,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,CAAA;IACrC,CAAC;IAED;;OAEG;IACH,KAAK,EACH,CAAI,GAAG,aAAkB,EAAE,EAAE,CAC7B,CAAC,KAAc,EAAc,EAAE;QAC7B,OAAO,aAAa,CAAC,QAAQ,CAAC,KAAU,CAAC,CAAA;IAC3C,CAAC;CACK,CAAA"}

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

@@ -0,0 +1,63 @@
+/**
+ * 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
+ */
+import type { ValidationErrorDetail } from '../types';
+/**
+ * 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!')
+ * }
+ * ```
+ */
+export declare function validateWithAnyOfSupport(data: unknown, schema: any): ValidationErrorDetail[];
+/**
+ * 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
+ */
+export declare function createValidationError(path: string, message: string, expected: unknown, actual: unknown): ValidationErrorDetail;
+/**
+ * Helper function to format validation errors for logging
+ *
+ * @param errors - Array of validation errors
+ * @returns Formatted error summary string
+ */
+export declare function formatValidationErrors(errors: ValidationErrorDetail[]): string;
+//# sourceMappingURL=validation-engine.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validation-engine.d.ts","sourceRoot":"","sources":["../../../../../src/api-request/schema-validation/internal/validation-engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AA0VrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,OAAO,EAEb,MAAM,EAAE,GAAG,GACV,qBAAqB,EAAE,CAsBzB;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,OAAO,GACd,qBAAqB,CAOvB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,qBAAqB,EAAE,GAC9B,MAAM,CAWR"}