chromium-bidi 2.1.2: BrowsingContext

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify chromium-bidi.BrowsingContext in pkg:npm/chromium-bidi@2.1.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/chromium-bidi@2.1.2
Demonstrate these symbols/APIs:
  - chromium-bidi.BrowsingContext
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: esm
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:2b9fce6a3a98b6701eef072eca8a9b5bc8f243c58db81c48d77bf6c88a2f9a16","constraints":{"executionContext":"node"},"contract":["BrowsingContext.parseCreateParams parses valid create parameters for tab and window","BrowsingContext.parseCreateParams throws InvalidArgumentException on invalid type","BrowsingContext.parseNavigateParams parses valid navigation parameters with url and wait state","BrowsingContext.parseCloseParams parses close parameters with promptUnload flag","BrowsingContext.parseSetViewportParams parses viewport dimensions and devicePixelRatio","BrowsingContext.parseCaptureScreenshotParams parses screenshot format and clipping options","BrowsingContext.parseLocateNodesParams parses locator strategy and selector","BrowsingContext.parseTraverseHistoryParams parses history delta navigation"],"goal":"verify chromium-bidi.BrowsingContext in pkg:npm/chromium-bidi@2.1.2","kind":"HOW","packages":["pkg:npm/chromium-bidi@2.1.2"],"schemaVersion":1,"symbols":["chromium-bidi.BrowsingContext"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/chromium-bidi@2.1.2"],"schemaVersion":1,"subject":"pkg:npm/chromium-bidi@2.1.2","symbols":["chromium-bidi.BrowsingContext"],"verifierAdapter":"node-typescript@1"}

import { BrowsingContext } from 'chromium-bidi/lib/esm/protocol-parser/protocol-parser.js';
import { InvalidArgumentException } from 'chromium-bidi/lib/esm/protocol/protocol.js';

export function parseCreateParams(params) {
  return BrowsingContext.parseCreateParams(params);
}

export function parseNavigateParams(params) {
  return BrowsingContext.parseNavigateParams(params);
}

export function parseCloseParams(params) {
  return BrowsingContext.parseCloseParams(params);
}

export function parseSetViewportParams(params) {
  return BrowsingContext.parseSetViewportParams(params);
}

export function parseCaptureScreenshotParams(params) {
  return BrowsingContext.parseCaptureScreenshotParams(params);
}

export function parseLocateNodesParams(params) {
  return BrowsingContext.parseLocateNodesParams(params);
}

export function parseTraverseHistoryParams(params) {
  return BrowsingContext.parseTraverseHistoryParams(params);
}

export { BrowsingContext, InvalidArgumentException };

{
  "name": "sample-180421414",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-180421414",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "chromium-bidi": "2.1.2"
      }
    },
    "node_modules/chromium-bidi": {
      "version": "2.1.2",
      "resolved": "https://registry.npmjs.org/chromium-bidi/-/chromium-bidi-2.1.2.tgz",
      "integrity": "sha512-vtRWBK2uImo5/W2oG6/cDkkHSm+2t6VHgnj+Rcwhb0pP74OoUb4GipyRX/T/y39gYQPhioP0DPShn+A7P6CHNw==",
      "license": "Apache-2.0",
      "dependencies": {
        "mitt": "^3.0.1",
        "zod": "^3.24.1"
      },
      "peerDependencies": {
        "devtools-protocol": "*"
      }
    },
    "node_modules/devtools-protocol": {
      "version": "0.0.1686980",
      "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.1686980.tgz",
      "integrity": "sha512-NnnxGO1/cRffXL29DqGysbfgCcsYoIxprtmXgh+UDXFvhTwhRBewcRdGlEXvc3cmROi04JRmd2PqCURsijW25A==",
      "license": "BSD-3-Clause",
      "peer": true
    },
    "node_modules/mitt": {
      "version": "3.0.1",
      "resolved": "https://registry.npmjs.org/mitt/-/mitt-3.0.1.tgz",
      "integrity": "sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==",
      "license": "MIT"
    },
    "node_modules/zod": {
      "version": "3.25.76",
      "resolved": "https://registry.npmjs.org/zod/-/zod-3.25.76.tgz",
      "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==",
      "license": "MIT",
      "funding": {
        "url": "https://github.com/sponsors/colinhacks"
      }
    }
  }
}

{
  "name": "sample-180421414",
  "version": "1.0.0",
  "description": "Minimal sample verifying chromium-bidi.BrowsingContext in pkg:npm/chromium-bidi@2.1.2",
  "type": "module",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "keywords": [],
  "author": "",
  "license": "MIT-0",
  "dependencies": {
    "chromium-bidi": "2.1.2"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify chromium-bidi.BrowsingContext in pkg:npm/chromium-bidi@2.1.2",
  "kind": "HOW",
  "packages": [
    "pkg:npm/chromium-bidi@2.1.2"
  ],
  "symbols": [
    "chromium-bidi.BrowsingContext"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "esm",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

import assert from 'node:assert';
import {
  InvalidArgumentException,
  parseCreateParams,
  parseNavigateParams,
  parseCloseParams,
  parseSetViewportParams,
  parseCaptureScreenshotParams,
  parseLocateNodesParams,
  parseTraverseHistoryParams,
} from '../index.js';

async function runContract() {
  // 1. BrowsingContext.parseCreateParams parses valid create parameters for tab and window
  const createTab = parseCreateParams({ type: 'tab' });
  assert.strictEqual(createTab.type, 'tab');
  const createWindow = parseCreateParams({ type: 'window', referenceContext: 'ctx-0' });
  assert.strictEqual(createWindow.type, 'window');
  assert.strictEqual(createWindow.referenceContext, 'ctx-0');

  // 2. BrowsingContext.parseCreateParams throws InvalidArgumentException on invalid type
  assert.throws(
    () => parseCreateParams({ type: 'invalid' }),
    (err) => {
      assert(err instanceof InvalidArgumentException, 'Error must be InvalidArgumentException');
      assert.strictEqual(err.error, 'invalid argument');
      return true;
    }
  );

  // 3. BrowsingContext.parseNavigateParams parses valid navigation parameters with url and wait state
  const nav = parseNavigateParams({
    context: 'ctx-1',
    url: 'https://example.com',
    wait: 'complete',
  });
  assert.strictEqual(nav.context, 'ctx-1');
  assert.strictEqual(nav.url, 'https://example.com');
  assert.strictEqual(nav.wait, 'complete');

  // 4. BrowsingContext.parseCloseParams parses close parameters with promptUnload flag
  const close = parseCloseParams({ context: 'ctx-1', promptUnload: true });
  assert.strictEqual(close.context, 'ctx-1');
  assert.strictEqual(close.promptUnload, true);

  // 5. BrowsingContext.parseSetViewportParams parses viewport dimensions and devicePixelRatio
  const viewport = parseSetViewportParams({
    context: 'ctx-1',
    viewport: { width: 1280, height: 720 },
    devicePixelRatio: 1.5,
  });
  assert.strictEqual(viewport.context, 'ctx-1');
  assert.strictEqual(viewport.viewport.width, 1280);
  assert.strictEqual(viewport.viewport.height, 720);
  assert.strictEqual(viewport.devicePixelRatio, 1.5);

  // 6. BrowsingContext.parseCaptureScreenshotParams parses screenshot format and clipping options
  const screenshot = parseCaptureScreenshotParams({
    context: 'ctx-1',
    format: { type: 'image/png' },
  });
  assert.strictEqual(screenshot.context, 'ctx-1');
  assert.strictEqual(screenshot.format.type, 'image/png');

  // 7. BrowsingContext.parseLocateNodesParams parses locator strategy and selector
  const locate = parseLocateNodesParams({
    context: 'ctx-1',
    locator: { type: 'css', value: '#main' },
  });
  assert.strictEqual(locate.context, 'ctx-1');
  assert.strictEqual(locate.locator.type, 'css');
  assert.strictEqual(locate.locator.value, '#main');

  // 8. BrowsingContext.parseTraverseHistoryParams parses history delta navigation
  const history = parseTraverseHistoryParams({
    context: 'ctx-1',
    delta: -2,
  });
  assert.strictEqual(history.context, 'ctx-1');
  assert.strictEqual(history.delta, -2);

  console.log('Contract tests passed successfully.');
}

runContract().catch((err) => {
  console.error('Contract test failed:', err);
  process.exit(1);
});