craftdriver 1.1.0 → 1.2.0

package/docs/tracing.md

@@ -14,7 +14,7 @@ process crash cannot lose the evidence that led up to it.
 ```ts
 import { chromium } from 'craftdriver';
 
-const browser = await chromium.launch({ enableBiDi: true });
+const browser = await chromium.launch();
 
 await browser.startTrace({ outDir: './artefacts/login' });
 try {
@@ -202,7 +202,7 @@ import { autoTrace } from './auto-trace';
 
 describe('Login', () => {
   let browser: Browser;
-  beforeAll(async () => { browser = await Browser.launch({ enableBiDi: true }); });
+  beforeAll(async () => { browser = await Browser.launch(); });
   afterAll(async () => { await browser.quit(); });
 
   autoTrace(() => browser);   // ← that's it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "craftdriver",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Modern WebDriver automation library for NodeJS",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,14 +17,18 @@
     "test:firefox": "BROWSER_NAME=firefox HEADLESS=true vitest run --maxWorkers=2",
     "test:chrome": "BROWSER_NAME=chrome vitest run",
     "test:chromium": "BROWSER_NAME=chromium vitest run",
+    "test:recipes": "HEADLESS=true vitest run --config vitest.recipes.config.ts",
     "bench": "HEADLESS=true vitest run --config vitest.perf.config.ts",
     "bench:realapp": "HEADLESS=true vitest run --config vitest.perf.realapp.config.ts",
     "clean": "rimraf dist",
     "serve": "http-server ./examples -a 127.0.0.1 -p 8080 -c-1 --cors",
     "examples:start": "npm run serve",
+    "docs:examples": "node scripts/copy-examples.mjs",
     "docs:api": "node scripts/gen-api-reference.mjs",
     "docs:api:check": "node scripts/gen-api-reference.mjs --check",
+    "predocs:dev": "npm run docs:examples",
     "docs:dev": "vitepress dev docs",
+    "predocs:build": "npm run docs:examples",
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs",
     "docs:check": "npm run docs:api:check && npm run docs:build",

package/skills/craftdriver/SKILL.md

@@ -34,8 +34,9 @@ break the moment markup shifts.
 3. `instanceof CraftdriverError` is true on every public throw;
    `instanceof Error` is also true.
 4. BiDi features (`network`, `logs`, tracing, init scripts, true load
-   events) require `Browser.launch({ enableBiDi: true })`. The error
-   code on the wrong transport is `UNSUPPORTED`.
+   events) work out of the box — `enableBiDi` defaults to `true`. They only
+   break if you explicitly pass `enableBiDi: false`; the error code on the
+   wrong transport is `UNSUPPORTED`.
 5. Tests fetch from the example server. Start it in a separate
    terminal: `npm run examples:start` before `npm test`.
 

package/skills/craftdriver/cheatsheet.md

@@ -12,7 +12,8 @@ import { Browser } from 'craftdriver';
 const browser = await Browser.launch({
   browserName: 'chrome',   // 'chrome' | 'chromium' | 'firefox'
   headless: true,
-  enableBiDi: true,        // required for network / logs / tracing / init scripts
+  // enableBiDi defaults to true — network / logs / tracing / init scripts
+  // all need it, so only set enableBiDi: false if you must disable it.
 });
 try {
   await browser.navigateTo('https://example.com');

package/skills/craftdriver/patterns.md

@@ -6,7 +6,7 @@ Worked recipes. Each is ≤ ~200 tokens; load on demand from
 ## 1. Login, save storage state for reuse
 
 ```ts
-const browser = await Browser.launch({ enableBiDi: true });
+const browser = await Browser.launch();
 await browser.navigateTo('https://app.example.com/login');
 await browser.locator(By.labelText('Email')).fill('jane@example.com');
 await browser.locator(By.labelText('Password')).fill(process.env.PW!);
@@ -23,10 +23,7 @@ await browser.quit();
 
 ```ts
 const state = JSON.parse(await fs.readFile('.auth/state.json', 'utf8'));
-const browser = await Browser.launch({
-  enableBiDi: true,
-  storageState: state,
-});
+const browser = await Browser.launch({ storageState: state });
 await browser.navigateTo('https://app.example.com/dashboard');
 await browser.locator(By.testId('dashboard')).expect().toBeVisible();
 ```