@yasserkhanorg/e2e-agents 0.3.2

package/dist/agent/spec-bridge.d.ts

@@ -0,0 +1,101 @@
+import type { ProviderConfig, HybridConfig } from '../index.js';
+import type { FeatureSpecification } from '../e2e-test-gen/types';
+/**
+ * Configuration for SpecBridge
+ */
+export interface SpecBridgeConfig {
+    /**
+     * LLM provider configuration for PDF parsing
+     * Can be a single provider or hybrid config
+     */
+    llmConfig: ProviderConfig | HybridConfig;
+    /**
+     * Output directory for generated specs (default: 'specs/')
+     */
+    outputDir?: string;
+    /**
+     * Whether to overwrite existing spec files (default: true)
+     */
+    overwrite?: boolean;
+}
+/**
+ * Result of spec conversion
+ */
+export interface ConversionResult {
+    /**
+     * Paths to generated spec files
+     */
+    specPaths: string[];
+    /**
+     * Parsed feature specifications
+     */
+    features: FeatureSpecification[];
+    /**
+     * Total number of scenarios extracted
+     */
+    totalScenarios: number;
+    /**
+     * Any warnings during conversion
+     */
+    warnings: string[];
+}
+/**
+ * Bridge between PDF/JSON specs and Playwright Agent workflow
+ *
+ * Converts specification documents into Playwright-compatible markdown
+ * that can be consumed by Playwright's native agents.
+ */
+export declare class SpecBridge {
+    private parser;
+    private outputDir;
+    private overwrite;
+    constructor(config: SpecBridgeConfig);
+    /**
+     * Convert a specification file to Playwright-compatible markdown specs
+     *
+     * @param inputPath - Path to the input specification (PDF, MD, or JSON)
+     * @param outputDir - Optional override for output directory
+     * @returns Conversion result with paths and metadata
+     */
+    convertToPlaywrightSpecs(inputPath: string, outputDir?: string): Promise<ConversionResult>;
+    /**
+     * Convert a FeatureSpecification to Playwright Agent markdown format
+     *
+     * The format is designed to be consumed by Playwright's Planner and Generator agents.
+     * It includes structured test scenarios in Given-When-Then format.
+     */
+    private toPlaywrightMarkdown;
+    /**
+     * Format a business scenario in Playwright-friendly markdown
+     */
+    private formatScenario;
+    /**
+     * Parse a spec file without writing output
+     * Useful for validation or inspection
+     */
+    parseSpec(inputPath: string): Promise<FeatureSpecification[]>;
+    /**
+     * Validate a specification file
+     */
+    validateSpec(inputPath: string): Promise<{
+        valid: boolean;
+        errors: string[];
+        features: number;
+        scenarios: number;
+    }>;
+    /**
+     * Get a summary of the specification
+     */
+    getSpecSummary(inputPath: string): Promise<string>;
+}
+/**
+ * Create a SpecBridge with Anthropic provider
+ * Convenience function for common use case
+ */
+export declare function createAnthropicBridge(apiKey?: string, outputDir?: string): SpecBridge;
+/**
+ * Create a SpecBridge with Ollama provider (free, local)
+ * Convenience function for local development
+ */
+export declare function createOllamaBridge(model?: string, outputDir?: string): SpecBridge;
+//# sourceMappingURL=spec-bridge.d.ts.map

package/dist/agent/spec-bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec-bridge.d.ts","sourceRoot":"","sources":["../../src/agent/spec-bridge.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EAAc,cAAc,EAAE,YAAY,EAAC,MAAM,aAAa,CAAC;AAG3E,OAAO,KAAK,EAAC,oBAAoB,EAAmB,MAAM,uBAAuB,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,SAAS,EAAE,cAAc,GAAG,YAAY,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACnB,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAU;gBAEf,MAAM,EAAE,gBAAgB;IAepC;;;;;;OAMG;IACG,wBAAwB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkEhG;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IA6D5B;;OAEG;IACH,OAAO,CAAC,cAAc;IAqBtB;;;OAGG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAInE;;OAEG;IACG,YAAY,CACd,SAAS,EAAE,MAAM,GAClB,OAAO,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAC,CAAC;IAqBnF;;OAEG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAuB3D;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,UAAU,CAUrF;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,UAAU,CAWjF"}

package/dist/agent/spec-bridge.js

@@ -0,0 +1,273 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecBridge = void 0;
+exports.createAnthropicBridge = createAnthropicBridge;
+exports.createOllamaBridge = createOllamaBridge;
+/**
+ * Spec Bridge - Bridge between PDF specs and Playwright Agent workflow
+ *
+ * This module converts specification documents (PDF, Markdown, JSON) into
+ * Playwright-compatible markdown files that can be consumed by Playwright's
+ * native agents (Planner, Generator, Healer).
+ *
+ * Flow: PDF → SpecParser → Markdown specs → Playwright Planner
+ *
+ * The Playwright agents (available in Playwright 1.56+) provide production-ready:
+ * - Test planning and exploration
+ * - Test code generation
+ * - Automatic test healing
+ *
+ * Usage:
+ * ```typescript
+ * const bridge = new SpecBridge({type: 'anthropic', apiKey: process.env.ANTHROPIC_API_KEY});
+ * const specPaths = await bridge.convertToPlaywrightSpecs('spec.pdf', 'specs/');
+ * // Now use Playwright agents: @planner, @generator, @healer
+ * ```
+ */
+const fs_1 = require("fs");
+const path_1 = require("path");
+const index_js_1 = require("../index.js");
+const spec_parser_1 = require("../e2e-test-gen/spec_parser");
+/**
+ * Bridge between PDF/JSON specs and Playwright Agent workflow
+ *
+ * Converts specification documents into Playwright-compatible markdown
+ * that can be consumed by Playwright's native agents.
+ */
+class SpecBridge {
+    constructor(config) {
+        // Handle both single provider and hybrid config
+        let llmProvider;
+        if ('primary' in config.llmConfig) {
+            // It's a HybridConfig
+            llmProvider = index_js_1.LLMProviderFactory.createHybrid(config.llmConfig);
+        }
+        else {
+            // It's a ProviderConfig
+            llmProvider = index_js_1.LLMProviderFactory.create(config.llmConfig);
+        }
+        this.parser = new spec_parser_1.SpecificationParser(llmProvider);
+        this.outputDir = config.outputDir || 'specs';
+        this.overwrite = config.overwrite !== false;
+    }
+    /**
+     * Convert a specification file to Playwright-compatible markdown specs
+     *
+     * @param inputPath - Path to the input specification (PDF, MD, or JSON)
+     * @param outputDir - Optional override for output directory
+     * @returns Conversion result with paths and metadata
+     */
+    async convertToPlaywrightSpecs(inputPath, outputDir) {
+        /* eslint-disable no-console */
+        const targetDir = outputDir || this.outputDir;
+        const warnings = [];
+        console.log(`Converting specification: ${inputPath}`);
+        // Parse the specification
+        const specs = await this.parser.parse(inputPath, 'file');
+        if (specs.length === 0) {
+            warnings.push('No features extracted from specification');
+            return {
+                specPaths: [],
+                features: [],
+                totalScenarios: 0,
+                warnings,
+            };
+        }
+        // Create output directory
+        (0, fs_1.mkdirSync)(targetDir, { recursive: true });
+        const specPaths = [];
+        let totalScenarios = 0;
+        for (const spec of specs) {
+            // Validate the spec
+            const validation = this.parser.validateSpec(spec);
+            if (!validation.valid) {
+                warnings.push(`Feature "${spec.name}": ${validation.errors.join(', ')}`);
+            }
+            // Convert to Playwright markdown format
+            const markdown = this.toPlaywrightMarkdown(spec);
+            // Generate output filename
+            const filename = `${spec.id}.md`;
+            const outputPath = (0, path_1.join)(targetDir, filename);
+            // Check for existing file
+            if ((0, fs_1.existsSync)(outputPath) && !this.overwrite) {
+                warnings.push(`Skipping existing file: ${outputPath}`);
+                continue;
+            }
+            // Write the spec file
+            (0, fs_1.writeFileSync)(outputPath, markdown, 'utf-8');
+            specPaths.push(outputPath);
+            totalScenarios += spec.scenarios.length;
+            console.log(`  Created: ${outputPath} (${spec.scenarios.length} scenarios)`);
+        }
+        console.log(`Converted ${specs.length} feature(s) with ${totalScenarios} scenario(s)`);
+        /* eslint-enable no-console */
+        return {
+            specPaths,
+            features: specs,
+            totalScenarios,
+            warnings,
+        };
+    }
+    /**
+     * Convert a FeatureSpecification to Playwright Agent markdown format
+     *
+     * The format is designed to be consumed by Playwright's Planner and Generator agents.
+     * It includes structured test scenarios in Given-When-Then format.
+     */
+    toPlaywrightMarkdown(spec) {
+        const lines = [];
+        // Header
+        lines.push(`# ${spec.name}`);
+        lines.push('');
+        // Metadata
+        lines.push(`**Priority**: ${spec.priority}`);
+        if (spec.targetUrls.length > 0) {
+            lines.push(`**Target URLs**: ${spec.targetUrls.join(', ')}`);
+        }
+        lines.push('');
+        // Description
+        if (spec.description) {
+            lines.push('## Description');
+            lines.push('');
+            lines.push(spec.description);
+            lines.push('');
+        }
+        // Test Scenarios
+        if (spec.scenarios.length > 0) {
+            lines.push('## Test Scenarios');
+            lines.push('');
+            for (const scenario of spec.scenarios) {
+                lines.push(this.formatScenario(scenario));
+                lines.push('');
+            }
+        }
+        // Acceptance Criteria
+        if (spec.acceptanceCriteria.length > 0) {
+            lines.push('## Acceptance Criteria');
+            lines.push('');
+            for (const criterion of spec.acceptanceCriteria) {
+                lines.push(`- ${criterion}`);
+            }
+            lines.push('');
+        }
+        // Screenshots reference (if any)
+        if (spec.screenshots.length > 0) {
+            lines.push('## Reference Screenshots');
+            lines.push('');
+            for (const screenshot of spec.screenshots) {
+                lines.push(`- ${screenshot.description}: \`${screenshot.path}\``);
+            }
+            lines.push('');
+        }
+        // Metadata footer
+        lines.push('---');
+        lines.push(`*Generated from: ${(0, path_1.basename)(spec.sourcePath)}*`);
+        lines.push(`*Feature ID: ${spec.id}*`);
+        return lines.join('\n');
+    }
+    /**
+     * Format a business scenario in Playwright-friendly markdown
+     */
+    formatScenario(scenario) {
+        const lines = [];
+        lines.push(`### ${scenario.name}`);
+        lines.push('');
+        lines.push(`**Priority**: ${scenario.priority}`);
+        lines.push('');
+        if (scenario.given) {
+            lines.push(`**Given**: ${scenario.given}`);
+        }
+        if (scenario.when) {
+            lines.push(`**When**: ${scenario.when}`);
+        }
+        if (scenario.then) {
+            lines.push(`**Then**: ${scenario.then}`);
+        }
+        return lines.join('\n');
+    }
+    /**
+     * Parse a spec file without writing output
+     * Useful for validation or inspection
+     */
+    async parseSpec(inputPath) {
+        return this.parser.parse(inputPath, 'file');
+    }
+    /**
+     * Validate a specification file
+     */
+    async validateSpec(inputPath) {
+        const specs = await this.parser.parse(inputPath, 'file');
+        const allErrors = [];
+        let totalScenarios = 0;
+        for (const spec of specs) {
+            const validation = this.parser.validateSpec(spec);
+            if (!validation.valid) {
+                allErrors.push(...validation.errors.map((e) => `${spec.name}: ${e}`));
+            }
+            totalScenarios += spec.scenarios.length;
+        }
+        return {
+            valid: allErrors.length === 0,
+            errors: allErrors,
+            features: specs.length,
+            scenarios: totalScenarios,
+        };
+    }
+    /**
+     * Get a summary of the specification
+     */
+    async getSpecSummary(inputPath) {
+        const specs = await this.parser.parse(inputPath, 'file');
+        const lines = [];
+        lines.push(`Specification Summary: ${(0, path_1.basename)(inputPath)}`);
+        lines.push('='.repeat(50));
+        lines.push('');
+        for (const spec of specs) {
+            const summary = this.parser.getSpecSummary(spec);
+            lines.push(`Feature: ${summary.name}`);
+            lines.push(`  Priority: ${summary.priority}`);
+            lines.push(`  Scenarios: ${summary.scenarioCount}`);
+            lines.push(`    - Must-have: ${summary.mustHaveScenarios}`);
+            lines.push(`    - Should-have: ${summary.shouldHaveScenarios}`);
+            lines.push(`    - Nice-to-have: ${summary.niceToHaveScenarios}`);
+            lines.push(`  Acceptance Criteria: ${summary.acceptanceCriteriaCount}`);
+            lines.push(`  Has Screenshots: ${summary.hasScreenshots ? 'Yes' : 'No'}`);
+            lines.push('');
+        }
+        return lines.join('\n');
+    }
+}
+exports.SpecBridge = SpecBridge;
+/**
+ * Create a SpecBridge with Anthropic provider
+ * Convenience function for common use case
+ */
+function createAnthropicBridge(apiKey, outputDir) {
+    return new SpecBridge({
+        llmConfig: {
+            type: 'anthropic',
+            config: {
+                apiKey: apiKey || process.env.ANTHROPIC_API_KEY || '',
+            },
+        },
+        outputDir,
+    });
+}
+/**
+ * Create a SpecBridge with Ollama provider (free, local)
+ * Convenience function for local development
+ */
+function createOllamaBridge(model, outputDir) {
+    return new SpecBridge({
+        llmConfig: {
+            type: 'ollama',
+            config: {
+                model: model || 'deepseek-r1:7b',
+                baseUrl: process.env.OLLAMA_BASE_URL || 'http://localhost:11434',
+            },
+        },
+        outputDir,
+    });
+}

package/dist/agent/spec-builder.d.ts

@@ -0,0 +1,102 @@
+import type { ProviderConfig } from '../provider_interface.js';
+import type { HybridConfig } from '../provider_factory.js';
+import type { FeatureSpecification } from '../e2e-test-gen/types.js';
+/**
+ * Configuration for SpecBridge
+ */
+export interface SpecBridgeConfig {
+    /**
+     * LLM provider configuration for PDF parsing
+     * Can be a single provider or hybrid config
+     */
+    llmConfig: ProviderConfig | HybridConfig;
+    /**
+     * Output directory for generated specs (default: 'specs/')
+     */
+    outputDir?: string;
+    /**
+     * Whether to overwrite existing spec files (default: true)
+     */
+    overwrite?: boolean;
+}
+/**
+ * Result of spec conversion
+ */
+export interface ConversionResult {
+    /**
+     * Paths to generated spec files
+     */
+    specPaths: string[];
+    /**
+     * Parsed feature specifications
+     */
+    features: FeatureSpecification[];
+    /**
+     * Total number of scenarios extracted
+     */
+    totalScenarios: number;
+    /**
+     * Any warnings during conversion
+     */
+    warnings: string[];
+}
+/**
+ * Bridge between PDF/JSON specs and Playwright Agent workflow
+ *
+ * Converts specification documents into Playwright-compatible markdown
+ * that can be consumed by Playwright's native agents.
+ */
+export declare class SpecBridge {
+    private parser;
+    private outputDir;
+    private overwrite;
+    constructor(config: SpecBridgeConfig);
+    /**
+     * Convert a specification file to Playwright-compatible markdown specs
+     *
+     * @param inputPath - Path to the input specification (PDF, MD, or JSON)
+     * @param outputDir - Optional override for output directory
+     * @returns Conversion result with paths and metadata
+     */
+    convertToPlaywrightSpecs(inputPath: string, outputDir?: string): Promise<ConversionResult>;
+    /**
+     * Convert a FeatureSpecification to Playwright Agent markdown format
+     *
+     * The format is designed to be consumed by Playwright's Planner and Generator agents.
+     * It includes structured test scenarios in Given-When-Then format.
+     */
+    private toPlaywrightMarkdown;
+    /**
+     * Format a business scenario in Playwright-friendly markdown
+     */
+    private formatScenario;
+    /**
+     * Parse a spec file without writing output
+     * Useful for validation or inspection
+     */
+    parseSpec(inputPath: string): Promise<FeatureSpecification[]>;
+    /**
+     * Validate a specification file
+     */
+    validateSpec(inputPath: string): Promise<{
+        valid: boolean;
+        errors: string[];
+        features: number;
+        scenarios: number;
+    }>;
+    /**
+     * Get a summary of the specification
+     */
+    getSpecSummary(inputPath: string): Promise<string>;
+}
+/**
+ * Create a SpecBridge with Anthropic provider
+ * Convenience function for common use case
+ */
+export declare function createAnthropicBridge(apiKey?: string, outputDir?: string): SpecBridge;
+/**
+ * Create a SpecBridge with Ollama provider (free, local)
+ * Convenience function for local development
+ */
+export declare function createOllamaBridge(model?: string, outputDir?: string): SpecBridge;
+//# sourceMappingURL=spec-builder.d.ts.map

package/dist/agent/spec-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec-builder.d.ts","sourceRoot":"","sources":["../../src/agent/spec-builder.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EAAc,cAAc,EAAC,MAAM,0BAA0B,CAAC;AAC1E,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAGzD,OAAO,KAAK,EAAC,oBAAoB,EAAmB,MAAM,0BAA0B,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,SAAS,EAAE,cAAc,GAAG,YAAY,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACnB,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAU;gBAEf,MAAM,EAAE,gBAAgB;IAepC;;;;;;OAMG;IACG,wBAAwB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkEhG;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IA6D5B;;OAEG;IACH,OAAO,CAAC,cAAc;IAqBtB;;;OAGG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAInE;;OAEG;IACG,YAAY,CACd,SAAS,EAAE,MAAM,GAClB,OAAO,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAC,CAAC;IAqBnF;;OAEG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAuB3D;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,UAAU,CAUrF;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,UAAU,CAWjF"}