@machina.ai/openapi-contract-tester 2.1.0

package/dist/generators/errors/index.js

@@ -0,0 +1,73 @@
+/**
+ * Error Generators - Public API
+ *
+ * @module generators/errors
+ */
+export { BaseErrorStrategy } from './error-strategy.js';
+export { UnauthorizedErrorStrategy, ForbiddenErrorStrategy, HeuristicAuthErrorStrategy } from './auth-error-strategy.js';
+export { BadRequestErrorStrategy } from './validation-error-strategy.js';
+export { NotFoundErrorStrategy, ConflictErrorStrategy, UnprocessableEntityErrorStrategy, GenericErrorStrategy, } from './business-error-strategy.js';
+export { ErrorStrategyFactory } from './error-strategy-factory.js';
+import { faker } from '@faker-js/faker';
+import { ErrorStrategyFactory } from './error-strategy-factory.js';
+import { createLogger } from '../../utils/logger.js';
+const log = createLogger('error-case-generator');
+/**
+ * Extract error status codes (4xx, 5xx) defined in an endpoint
+ */
+function getDefinedErrorCodes(endpoint) {
+    const errorCodes = [];
+    for (const statusCode of Object.keys(endpoint.responses)) {
+        const code = parseInt(statusCode, 10);
+        if (code >= 400 && code < 600)
+            errorCodes.push(code);
+    }
+    return errorCodes.sort((a, b) => a - b);
+}
+/**
+ * Main entry point: generate error case test cases for all endpoints
+ *
+ * @param endpoints - Array of parsed endpoints
+ * @param spec - Full OpenAPI spec
+ * @param options - Generation options
+ * @returns Array of error case test cases
+ */
+export function generateErrorCaseTests(endpoints, spec, options = {}) {
+    const { seed } = options;
+    log.info('Generating error case tests', {
+        endpointCount: endpoints.length,
+        aiLevel: options.aiLevel || 'off'
+    });
+    if (seed !== undefined) {
+        faker.seed(seed);
+    }
+    const testCases = [];
+    for (const endpoint of endpoints) {
+        const definedErrorCodes = getDefinedErrorCodes(endpoint);
+        if (definedErrorCodes.length > 0) {
+            // Use spec-defined error codes
+            for (const code of definedErrorCodes) {
+                const strategy = ErrorStrategyFactory.createForCode(code);
+                if (strategy.isApplicable(endpoint, spec)) {
+                    testCases.push(...strategy.generate(endpoint, spec, options));
+                }
+            }
+        }
+        else {
+            // Fallback: heuristic strategies
+            for (const strategy of ErrorStrategyFactory.createHeuristicStrategies()) {
+                if (strategy.isApplicable(endpoint, spec)) {
+                    testCases.push(...strategy.generate(endpoint, spec, options));
+                }
+            }
+        }
+    }
+    log.info('Error case tests generated', {
+        totalTests: testCases.length,
+        averagePerEndpoint: endpoints.length > 0
+            ? (testCases.length / endpoints.length).toFixed(1)
+            : '0'
+    });
+    return testCases;
+}
+//# sourceMappingURL=index.js.map

package/dist/generators/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generators/errors/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAA6C,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACzH,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,gCAAgC,EAChC,oBAAoB,GACrB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAIxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,GAAG,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;AAEjD;;GAEG;AACH,SAAS,oBAAoB,CAAC,QAAwB;IACpD,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACtC,IAAI,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG,GAAG;YAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAA2B,EAC3B,IAAwB,EACxB,UAA4B,EAAE;IAE9B,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE;QACtC,aAAa,EAAE,SAAS,CAAC,MAAM;QAC/B,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;KAClC,CAAC,CAAC;IAEH,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAe,EAAE,CAAC;IAEjC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAEzD,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,+BAA+B;YAC/B,KAAK,MAAM,IAAI,IAAI,iBAAiB,EAAE,CAAC;gBACrC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBAC1D,IAAI,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;oBAC1C,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,iCAAiC;YACjC,KAAK,MAAM,QAAQ,IAAI,oBAAoB,CAAC,yBAAyB,EAAE,EAAE,CAAC;gBACxE,IAAI,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;oBAC1C,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,GAAG,CAAC,IAAI,CAAC,4BAA4B,EAAE;QACrC,UAAU,EAAE,SAAS,CAAC,MAAM;QAC5B,kBAAkB,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC;YACtC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC,GAAG;KACR,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/generators/errors/validation-error-strategy.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Validation Error Strategy - 400 Bad Request scenarios
+ *
+ * Generates tests for missing fields, invalid formats, wrong types,
+ * and constraint violations.
+ *
+ * @module generators/errors/validation-error-strategy
+ */
+import type { OpenAPIV3 } from 'openapi-types';
+import type { TestCase, ParsedEndpoint } from '../../types/index.js';
+import { BaseErrorStrategy, type ErrorCaseOptions } from './error-strategy.js';
+/**
+ * Strategy for 400 Bad Request tests
+ */
+export declare class BadRequestErrorStrategy extends BaseErrorStrategy {
+    readonly statusCodes: number[];
+    isApplicable(endpoint: ParsedEndpoint, _spec: OpenAPIV3.Document): boolean;
+    generate(endpoint: ParsedEndpoint, _spec: OpenAPIV3.Document, options: ErrorCaseOptions): TestCase[];
+    private generateMissingFieldTests;
+    private generateInvalidFormatTests;
+    private generateWrongTypeTests;
+    private generateConstraintViolationTests;
+    private buildConstraintTests;
+}
+//# sourceMappingURL=validation-error-strategy.d.ts.map

package/dist/generators/errors/validation-error-strategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-error-strategy.d.ts","sourceRoot":"","sources":["../../../src/generators/errors/validation-error-strategy.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAGrE,OAAO,EAAE,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE/E;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,iBAAiB;IAC5D,QAAQ,CAAC,WAAW,WAAS;IAE7B,YAAY,CAAC,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO;IAI1E,QAAQ,CAAC,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,gBAAgB,GAAG,QAAQ,EAAE;IAWpG,OAAO,CAAC,yBAAyB;IAmCjC,OAAO,CAAC,0BAA0B;IAoClC,OAAO,CAAC,sBAAsB;IAmC9B,OAAO,CAAC,gCAAgC;IAexC,OAAO,CAAC,oBAAoB;CAmF7B"}

package/dist/generators/errors/validation-error-strategy.js

@@ -0,0 +1,214 @@
+/**
+ * Validation Error Strategy - 400 Bad Request scenarios
+ *
+ * Generates tests for missing fields, invalid formats, wrong types,
+ * and constraint violations.
+ *
+ * @module generators/errors/validation-error-strategy
+ */
+import { generateInvalidValue } from '../data-generator.js';
+import { generateAuthHeaders } from '../../utils/auth-generator.js';
+import { BaseErrorStrategy } from './error-strategy.js';
+/**
+ * Strategy for 400 Bad Request tests
+ */
+export class BadRequestErrorStrategy extends BaseErrorStrategy {
+    statusCodes = [400];
+    isApplicable(endpoint, _spec) {
+        return !!endpoint.requestBody;
+    }
+    generate(endpoint, _spec, options) {
+        if (!endpoint.requestBody)
+            return [];
+        return [
+            ...this.generateMissingFieldTests(endpoint, options),
+            ...this.generateInvalidFormatTests(endpoint, options),
+            ...this.generateWrongTypeTests(endpoint, options),
+            ...this.generateConstraintViolationTests(endpoint, options),
+        ];
+    }
+    generateMissingFieldTests(endpoint, options) {
+        const testCases = [];
+        const schema = endpoint.requestBody;
+        if (!schema || schema.type !== 'object')
+            return testCases;
+        const required = schema.required || [];
+        if (required.length === 0)
+            return testCases;
+        for (const requiredField of required) {
+            const body = this.generateBody(schema, options);
+            delete body[requiredField];
+            testCases.push({
+                id: this.buildId(endpoint, `400-missing-${requiredField}`),
+                name: `${endpoint.method} ${endpoint.path} - Missing required field: ${requiredField}`,
+                description: `Request without required field '${requiredField}' should return 400`,
+                category: 'error-case',
+                method: endpoint.method,
+                path: endpoint.path,
+                pathParams: this.generatePathParams(endpoint),
+                headers: generateAuthHeaders(endpoint.securitySchemes || []),
+                body,
+                contentType: endpoint.requestContentType,
+                expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: {
+                    field: requiredField,
+                    message: /required|mandatory|missing/i,
+                },
+            });
+        }
+        return testCases;
+    }
+    generateInvalidFormatTests(endpoint, options) {
+        const testCases = [];
+        const schema = endpoint.requestBody;
+        if (!schema || schema.type !== 'object' || !schema.properties)
+            return testCases;
+        for (const [fieldName, fieldSchema] of Object.entries(schema.properties)) {
+            if ('$ref' in fieldSchema)
+                continue;
+            const field = fieldSchema;
+            if (!field.format)
+                continue;
+            const body = this.generateBody(schema, options);
+            body[fieldName] = generateInvalidValue(field, 'format');
+            testCases.push({
+                id: this.buildId(endpoint, `400-invalid-${field.format}-${fieldName}`),
+                name: `${endpoint.method} ${endpoint.path} - Invalid ${field.format} format: ${fieldName}`,
+                description: `Invalid ${field.format} format for '${fieldName}' should return 400`,
+                category: 'error-case',
+                method: endpoint.method,
+                path: endpoint.path,
+                pathParams: this.generatePathParams(endpoint),
+                headers: generateAuthHeaders(endpoint.securitySchemes || []),
+                body,
+                contentType: endpoint.requestContentType,
+                expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: {
+                    field: fieldName,
+                    message: new RegExp(`format|invalid.*${field.format}`, 'i'),
+                },
+            });
+        }
+        return testCases;
+    }
+    generateWrongTypeTests(endpoint, options) {
+        const testCases = [];
+        const schema = endpoint.requestBody;
+        if (!schema || schema.type !== 'object' || !schema.properties)
+            return testCases;
+        for (const [fieldName, fieldSchema] of Object.entries(schema.properties)) {
+            if ('$ref' in fieldSchema)
+                continue;
+            const field = fieldSchema;
+            if (!field.type)
+                continue;
+            const body = this.generateBody(schema, options);
+            body[fieldName] = generateInvalidValue(field, 'type');
+            testCases.push({
+                id: this.buildId(endpoint, `400-wrong-type-${fieldName}`),
+                name: `${endpoint.method} ${endpoint.path} - Wrong type for ${fieldName}`,
+                description: `Wrong type for '${fieldName}' (expected ${field.type}) should return 400`,
+                category: 'error-case',
+                method: endpoint.method,
+                path: endpoint.path,
+                pathParams: this.generatePathParams(endpoint),
+                headers: generateAuthHeaders(endpoint.securitySchemes || []),
+                body,
+                expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: {
+                    field: fieldName,
+                    message: /type|invalid.*type/i,
+                },
+            });
+        }
+        return testCases;
+    }
+    generateConstraintViolationTests(endpoint, options) {
+        const testCases = [];
+        const schema = endpoint.requestBody;
+        if (!schema || schema.type !== 'object' || !schema.properties)
+            return testCases;
+        for (const [fieldName, fieldSchema] of Object.entries(schema.properties)) {
+            if ('$ref' in fieldSchema)
+                continue;
+            const field = fieldSchema;
+            testCases.push(...this.buildConstraintTests(endpoint, schema, field, fieldName, options));
+        }
+        return testCases;
+    }
+    buildConstraintTests(endpoint, schema, field, fieldName, options) {
+        const tests = [];
+        const authHeaders = generateAuthHeaders(endpoint.securitySchemes || []);
+        const pathParams = this.generatePathParams(endpoint);
+        if (field.type === 'string' && field.minLength !== undefined && field.minLength > 0) {
+            const body = this.generateBody(schema, options);
+            body[fieldName] = generateInvalidValue(field, 'minLength');
+            tests.push({
+                id: this.buildId(endpoint, `400-${fieldName}-minlength`),
+                name: `${endpoint.method} ${endpoint.path} - ${fieldName} below minLength`,
+                description: `'${fieldName}' below minLength (${field.minLength}) should return 400`,
+                category: 'error-case', method: endpoint.method, path: endpoint.path,
+                pathParams, headers: authHeaders, body, expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: { field: fieldName, message: /minLength|too short|minimum.*\d+/i },
+            });
+        }
+        if (field.type === 'string' && field.maxLength !== undefined) {
+            const body = this.generateBody(schema, options);
+            body[fieldName] = generateInvalidValue(field, 'maxLength');
+            tests.push({
+                id: this.buildId(endpoint, `400-${fieldName}-maxlength`),
+                name: `${endpoint.method} ${endpoint.path} - ${fieldName} exceeds maxLength`,
+                description: `'${fieldName}' exceeds maxLength (${field.maxLength}) should return 400`,
+                category: 'error-case', method: endpoint.method, path: endpoint.path,
+                pathParams, headers: authHeaders, body, expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: { field: fieldName, message: /maxLength|too long|maximum.*\d+/i },
+            });
+        }
+        if ((field.type === 'integer' || field.type === 'number') && field.minimum !== undefined) {
+            const body = this.generateBody(schema, options);
+            body[fieldName] = generateInvalidValue(field, 'minimum');
+            tests.push({
+                id: this.buildId(endpoint, `400-${fieldName}-minimum`),
+                name: `${endpoint.method} ${endpoint.path} - ${fieldName} below minimum`,
+                description: `'${fieldName}' below minimum (${field.minimum}) should return 400`,
+                category: 'error-case', method: endpoint.method, path: endpoint.path,
+                pathParams, headers: authHeaders, body, expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: { field: fieldName, message: new RegExp(`minimum|must be at least ${field.minimum}`, 'i') },
+            });
+        }
+        if ((field.type === 'integer' || field.type === 'number') && field.maximum !== undefined) {
+            const body = this.generateBody(schema, options);
+            body[fieldName] = generateInvalidValue(field, 'maximum');
+            tests.push({
+                id: this.buildId(endpoint, `400-${fieldName}-maximum`),
+                name: `${endpoint.method} ${endpoint.path} - ${fieldName} exceeds maximum`,
+                description: `'${fieldName}' exceeds maximum (${field.maximum}) should return 400`,
+                category: 'error-case', method: endpoint.method, path: endpoint.path,
+                pathParams, headers: authHeaders, body, expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: { field: fieldName, message: new RegExp(`maximum|must be at most ${field.maximum}`, 'i') },
+            });
+        }
+        if (field.enum && field.enum.length > 0) {
+            const body = this.generateBody(schema, options);
+            body[fieldName] = generateInvalidValue(field, 'enum');
+            tests.push({
+                id: this.buildId(endpoint, `400-${fieldName}-enum`),
+                name: `${endpoint.method} ${endpoint.path} - ${fieldName} invalid enum value`,
+                description: `Invalid enum value for '${fieldName}' should return 400`,
+                category: 'error-case', method: endpoint.method, path: endpoint.path,
+                pathParams, headers: authHeaders, body, expectedStatus: 400,
+                requiresAuth: endpoint.requiresAuth,
+                expectedError: { field: fieldName, message: /enum|allowed values|must be one of/i },
+            });
+        }
+        return tests;
+    }
+}
+//# sourceMappingURL=validation-error-strategy.js.map

package/dist/generators/errors/validation-error-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-error-strategy.js","sourceRoot":"","sources":["../../../src/generators/errors/validation-error-strategy.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAyB,MAAM,qBAAqB,CAAC;AAE/E;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IACnD,WAAW,GAAG,CAAC,GAAG,CAAC,CAAC;IAE7B,YAAY,CAAC,QAAwB,EAAE,KAAyB;QAC9D,OAAO,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;IAChC,CAAC;IAED,QAAQ,CAAC,QAAwB,EAAE,KAAyB,EAAE,OAAyB;QACrF,IAAI,CAAC,QAAQ,CAAC,WAAW;YAAE,OAAO,EAAE,CAAC;QAErC,OAAO;YACL,GAAG,IAAI,CAAC,yBAAyB,CAAC,QAAQ,EAAE,OAAO,CAAC;YACpD,GAAG,IAAI,CAAC,0BAA0B,CAAC,QAAQ,EAAE,OAAO,CAAC;YACrD,GAAG,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,OAAO,CAAC;YACjD,GAAG,IAAI,CAAC,gCAAgC,CAAC,QAAQ,EAAE,OAAO,CAAC;SAC5D,CAAC;IACJ,CAAC;IAEO,yBAAyB,CAAC,QAAwB,EAAE,OAAyB;QACnF,MAAM,SAAS,GAAe,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAE1D,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;QACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAE5C,KAAK,MAAM,aAAa,IAAI,QAAQ,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC;YAE3B,SAAS,CAAC,IAAI,CAAC;gBACb,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,aAAa,EAAE,CAAC;gBAC1D,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,8BAA8B,aAAa,EAAE;gBACtF,WAAW,EAAE,mCAAmC,aAAa,qBAAqB;gBAClF,QAAQ,EAAE,YAAY;gBACtB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,UAAU,EAAE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC;gBAC7C,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,eAAe,IAAI,EAAE,CAAC;gBAC5D,IAAI;gBACJ,WAAW,EAAE,QAAQ,CAAC,kBAAkB;gBACxC,cAAc,EAAE,GAAG;gBACnB,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE;oBACb,KAAK,EAAE,aAAa;oBACpB,OAAO,EAAE,6BAA6B;iBACvC;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,0BAA0B,CAAC,QAAwB,EAAE,OAAyB;QACpF,MAAM,SAAS,GAAe,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU;YAAE,OAAO,SAAS,CAAC;QAEhF,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACzE,IAAI,MAAM,IAAI,WAAW;gBAAE,SAAS;YACpC,MAAM,KAAK,GAAG,WAAqC,CAAC;YACpD,IAAI,CAAC,KAAK,CAAC,MAAM;gBAAE,SAAS;YAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAExD,SAAS,CAAC,IAAI,CAAC;gBACb,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,KAAK,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;gBACtE,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,cAAc,KAAK,CAAC,MAAM,YAAY,SAAS,EAAE;gBAC1F,WAAW,EAAE,WAAW,KAAK,CAAC,MAAM,gBAAgB,SAAS,qBAAqB;gBAClF,QAAQ,EAAE,YAAY;gBACtB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,UAAU,EAAE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC;gBAC7C,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,eAAe,IAAI,EAAE,CAAC;gBAC5D,IAAI;gBACJ,WAAW,EAAE,QAAQ,CAAC,kBAAkB;gBACxC,cAAc,EAAE,GAAG;gBACnB,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE;oBACb,KAAK,EAAE,SAAS;oBAChB,OAAO,EAAE,IAAI,MAAM,CAAC,mBAAmB,KAAK,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC;iBAC5D;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,sBAAsB,CAAC,QAAwB,EAAE,OAAyB;QAChF,MAAM,SAAS,GAAe,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU;YAAE,OAAO,SAAS,CAAC;QAEhF,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACzE,IAAI,MAAM,IAAI,WAAW;gBAAE,SAAS;YACpC,MAAM,KAAK,GAAG,WAAqC,CAAC;YACpD,IAAI,CAAC,KAAK,CAAC,IAAI;gBAAE,SAAS;YAE1B,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAEtD,SAAS,CAAC,IAAI,CAAC;gBACb,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,kBAAkB,SAAS,EAAE,CAAC;gBACzD,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,qBAAqB,SAAS,EAAE;gBACzE,WAAW,EAAE,mBAAmB,SAAS,eAAe,KAAK,CAAC,IAAI,qBAAqB;gBACvF,QAAQ,EAAE,YAAY;gBACtB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,UAAU,EAAE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC;gBAC7C,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,eAAe,IAAI,EAAE,CAAC;gBAC5D,IAAI;gBACJ,cAAc,EAAE,GAAG;gBACnB,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE;oBACb,KAAK,EAAE,SAAS;oBAChB,OAAO,EAAE,qBAAqB;iBAC/B;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,gCAAgC,CAAC,QAAwB,EAAE,OAAyB;QAC1F,MAAM,SAAS,GAAe,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU;YAAE,OAAO,SAAS,CAAC;QAEhF,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACzE,IAAI,MAAM,IAAI,WAAW;gBAAE,SAAS;YACpC,MAAM,KAAK,GAAG,WAAqC,CAAC;YAEpD,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAC5F,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,oBAAoB,CAC1B,QAAwB,EACxB,MAA8B,EAC9B,KAA6B,EAC7B,SAAiB,EACjB,OAAyB;QAEzB,MAAM,KAAK,GAAe,EAAE,CAAC;QAC7B,MAAM,WAAW,GAAG,mBAAmB,CAAC,QAAQ,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAErD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;YACpF,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAC3D,KAAK,CAAC,IAAI,CAAC;gBACT,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,SAAS,YAAY,CAAC;gBACxD,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,MAAM,SAAS,kBAAkB;gBAC1E,WAAW,EAAE,IAAI,SAAS,sBAAsB,KAAK,CAAC,SAAS,qBAAqB;gBACpF,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACpE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG;gBAC3D,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,mCAAmC,EAAE;aAClF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAC3D,KAAK,CAAC,IAAI,CAAC;gBACT,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,SAAS,YAAY,CAAC;gBACxD,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,MAAM,SAAS,oBAAoB;gBAC5E,WAAW,EAAE,IAAI,SAAS,wBAAwB,KAAK,CAAC,SAAS,qBAAqB;gBACtF,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACpE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG;gBAC3D,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,kCAAkC,EAAE;aACjF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACzF,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACzD,KAAK,CAAC,IAAI,CAAC;gBACT,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,SAAS,UAAU,CAAC;gBACtD,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,MAAM,SAAS,gBAAgB;gBACxE,WAAW,EAAE,IAAI,SAAS,oBAAoB,KAAK,CAAC,OAAO,qBAAqB;gBAChF,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACpE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG;gBAC3D,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,4BAA4B,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,EAAE;aAC3G,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACzF,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACzD,KAAK,CAAC,IAAI,CAAC;gBACT,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,SAAS,UAAU,CAAC;gBACtD,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,MAAM,SAAS,kBAAkB;gBAC1E,WAAW,EAAE,IAAI,SAAS,sBAAsB,KAAK,CAAC,OAAO,qBAAqB;gBAClF,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACpE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG;gBAC3D,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,2BAA2B,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,EAAE;aAC1G,CAAC,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAA4B,CAAC;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACtD,KAAK,CAAC,IAAI,CAAC;gBACT,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,SAAS,OAAO,CAAC;gBACnD,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,MAAM,SAAS,qBAAqB;gBAC7E,WAAW,EAAE,2BAA2B,SAAS,qBAAqB;gBACtE,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACpE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG;gBAC3D,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,qCAAqC,EAAE;aACpF,CAAC,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/dist/generators/happy-path-generator.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Happy Path Test Case Generator
+ *
+ * Generates valid test cases for all endpoints in an OpenAPI specification.
+ * These tests represent the "happy path" - normal, successful scenarios with valid data.
+ *
+ * @module generators/happy-path-generator
+ */
+import type { TestCase, ParsedEndpoint } from '../types/index.js';
+import { type GeneratorOptions } from './data-generator.js';
+/**
+ * Generates happy path test cases for all endpoints in an OpenAPI specification
+ *
+ * @param endpoints - Array of parsed endpoints from OpenAPI spec
+ * @param options - Generation options
+ * @returns Array of happy path test cases
+ *
+ * @example
+ * ```typescript
+ * const spec = await parseOpenAPISpec('./api.yml');
+ * const endpoints = extractEndpoints(spec);
+ * const tests = generateHappyPathTests(endpoints);
+ * console.log(`Generated ${tests.length} happy path tests`);
+ * ```
+ */
+export declare function generateHappyPathTests(endpoints: ParsedEndpoint[], options?: HappyPathOptions): Promise<TestCase[]>;
+/**
+ * Options for happy path test generation
+ */
+export interface HappyPathOptions extends GeneratorOptions {
+    /**
+     * Real test data to use instead of faker (for valid credentials, user data, etc.)
+     * Keys should match property names in request bodies (e.g., username, password, email)
+     * @example { username: 'user@bank.com', password: 'SecurePass123!' }
+     */
+    realData?: Record<string, unknown>;
+    /**
+     * Whether to prefer examples from schema over faker
+     * @default true
+     */
+    useExamples?: boolean;
+}
+/**
+ * Generates happy path test cases for a specific endpoint path
+ *
+ * Useful when you want to generate tests for only certain endpoints.
+ *
+ * @param endpoints - Array of parsed endpoints
+ * @param pathFilter - Path pattern to filter (e.g., '/users', '/users/{id}')
+ * @param options - Generation options
+ * @returns Array of happy path test cases for matching endpoints
+ *
+ * @example
+ * ```typescript
+ * const spec = await parseOpenAPISpec('./api.yml');
+ * const endpoints = extractEndpoints(spec);
+ * const userTests = generateHappyPathTestsForPath(endpoints, '/users');
+ * ```
+ */
+export declare function generateHappyPathTestsForPath(endpoints: ParsedEndpoint[], pathFilter: string, options?: HappyPathOptions): Promise<TestCase[]>;
+/**
+ * Generates happy path test cases for a specific HTTP method
+ *
+ * @param endpoints - Array of parsed endpoints
+ * @param methodFilter - HTTP method to filter (e.g., 'GET', 'POST')
+ * @param options - Generation options
+ * @returns Array of happy path test cases for matching method
+ *
+ * @example
+ * ```typescript
+ * const spec = await parseOpenAPISpec('./api.yml');
+ * const endpoints = extractEndpoints(spec);
+ * const postTests = generateHappyPathTestsForMethod(endpoints, 'POST');
+ * ```
+ */
+export declare function generateHappyPathTestsForMethod(endpoints: ParsedEndpoint[], methodFilter: string, options?: HappyPathOptions): Promise<TestCase[]>;
+/**
+ * Generates happy path test cases for endpoints with a specific tag
+ *
+ * @param endpoints - Array of parsed endpoints
+ * @param tag - OpenAPI tag to filter by
+ * @param options - Generation options
+ * @returns Array of happy path test cases for matching tag
+ *
+ * @example
+ * ```typescript
+ * const spec = await parseOpenAPISpec('./api.yml');
+ * const endpoints = extractEndpoints(spec);
+ * const userTests = generateHappyPathTestsForTag(endpoints, 'users');
+ * ```
+ */
+export declare function generateHappyPathTestsForTag(endpoints: ParsedEndpoint[], tag: string, options?: HappyPathOptions): Promise<TestCase[]>;
+//# sourceMappingURL=happy-path-generator.d.ts.map

package/dist/generators/happy-path-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"happy-path-generator.d.ts","sourceRoot":"","sources":["../../src/generators/happy-path-generator.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAyC,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGnG;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,sBAAsB,CAC1C,SAAS,EAAE,cAAc,EAAE,EAC3B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,QAAQ,EAAE,CAAC,CAkBrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAiND;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,6BAA6B,CACjD,SAAS,EAAE,cAAc,EAAE,EAC3B,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,QAAQ,EAAE,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,+BAA+B,CACnD,SAAS,EAAE,cAAc,EAAE,EAC3B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,QAAQ,EAAE,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,4BAA4B,CAChD,SAAS,EAAE,cAAc,EAAE,EAC3B,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,QAAQ,EAAE,CAAC,CAKrB"}