Skip to content
Autowright

Changelog

Changelog

Release notes and version history for Stepwright and Fixwright packages.

Versioning

Both packages follow Semantic Versioning:

  • Major (X.0.0): Breaking changes
  • Minor (0.X.0): New features, backward compatible
  • Patch (0.0.X): Bug fixes, backward compatible

@korvol/stepwright

v1.0.0 (Initial Release)

Released: December 2024

The first stable release of Stepwright, a fluent API for building structured browser automation scripts.

Features

  • Fluent API: Chain-based script building with .step(), .checkpoint(), and .config()
  • Type-safe data: Generic type parameter for script data with full TypeScript support
  • Checkpoints: Group related steps with retry boundaries
  • Artifacts: Automatic screenshot, DOM, and console capture on failure
  • Video recording: Record script execution for debugging
  • Multiple reporters: Console, JSON, and custom reporter support
  • CLI: Command line interface for running scripts
  • Browser support: Chromium, Firefox, and WebKit via Playwright

API

import { Stepwright } from '@korvol/stepwright';


const script = Stepwright.create<MyData>('Script Name')
  .config({ headless: true })
  .data({ key: 'value' })
  .checkpoint('Section')
    .step('Step 1', async (ctx) => { /* ... */ })
    .step('Step 2', async (ctx) => { /* ... */ })
  .endCheckpoint()
  .run();

@korvol/fixwright

v1.0.0 (Initial Release)

Released: December 2024

The first stable release of Fixwright, AI-powered automatic fixing for failing Stepwright scripts.

Features

  • Claude Agent SDK integration: Uses Claude for intelligent script analysis and fixing
  • Automatic retry: AI attempts fixes until success or max attempts reached
  • Git integration: Create branches and commits for fixes
  • PR creation: Automatically create GitHub Pull Requests
  • File source: Watch directories for failure cases
  • Event-driven: Subscribe to fix lifecycle events
  • Backup support: Automatic backup before modifying files

API

import { FixWright } from '@korvol/fixwright';


const fixwright = new FixWright({
  ai: { apiKey: process.env.ANTHROPIC_API_KEY! },
  maxAttempts: 3,
  git: { enabled: true },
});


fixwright.on('attempt:success', (attempt) => {
  console.log('Fixed:', attempt.description);
});


await fixwright.start();

Upcoming Features

Planned for v1.1.0

  • Parallel step execution: Run independent steps concurrently
  • Step dependencies: Define step prerequisites
  • Custom assertions: Built-in assertion helpers
  • Improved error messages: More actionable failure information
  • Plugin system: Extend functionality via plugins

Planned for v1.2.0

  • Visual regression testing: Compare screenshots across runs
  • Network mocking: Intercept and mock API responses
  • Performance metrics: Capture timing and performance data
  • Distributed execution: Run scripts across multiple machines

Migration Guides

Migrating from Raw Playwright

If you’re migrating from raw Playwright scripts to Stepwright:

// Before: Raw Playwright
import { chromium } from 'playwright';


const browser = await chromium.launch();
const page = await browser.newPage();


await page.goto('https://example.com');
await page.fill('#email', 'test@example.com');
await page.click('#submit');


await browser.close();


// After: Stepwright
import { Stepwright } from '@korvol/stepwright';


const script = Stepwright.create('Example')
  .step('Navigate', async (ctx) => {
    await ctx.page.goto('https://example.com');
  })
  .step('Fill form', async (ctx) => {
    await ctx.page.fill('#email', 'test@example.com');
  })
  .step('Submit', async (ctx) => {
    await ctx.page.click('#submit');
  });


await script.run();

Benefits of migration:

  1. Automatic browser management
  2. Step-by-step failure tracking
  3. Artifact capture on failure
  4. Retry capabilities
  5. Structured reporting

Deprecation Policy

  • Deprecated features are marked in documentation
  • Deprecated features remain for at least one minor version
  • Breaking changes are only introduced in major versions
  • Migration guides are provided for breaking changes

Reporting Issues

Found a bug or have a feature request?

  1. Check existing issues
  2. Create a new issue with:
    • Package version
    • Node.js version
    • Operating system
    • Reproduction steps
    • Expected vs actual behavior

Contributing

We welcome contributions! See our contributing guide for:

  • Development setup
  • Code style guidelines
  • Pull request process
  • Testing requirements

License

Both packages are released under the MIT License.

MIT License


Copyright (c) 2024 Korvol


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Next Steps