web-agent-bridge 1.1.1 → 1.1.2

package/sdk/README.md

@@ -1,55 +1,55 @@
-# WAB Agent SDK
-
-SDK for building AI agents that interact with [Web Agent Bridge](https://github.com/abokenan444/web-agent-bridge).
-
-## Quick Start
-
-```javascript
-const puppeteer = require('puppeteer');
-const { WABAgent } = require('web-agent-bridge/sdk');
-
-const browser = await puppeteer.launch();
-const page = await browser.newPage();
-
-const agent = new WABAgent(page);
-await agent.navigateAndWait('https://example.com');
-
-// Discover available actions
-const actions = await agent.getActions();
-console.log(actions);
-
-// Execute an action
-const result = await agent.execute('signup', { email: 'user@example.com' });
-
-// Read page content
-const content = await agent.readContent('h1');
-
-await browser.close();
-```
-
-## BiDi Mode
-
-```javascript
-const agent = new WABAgent(page, { useBiDi: true });
-await agent.waitForBridge();
-
-const context = await agent.getBiDiContext();
-const actions = await agent.getActions();
-await agent.execute('click-login');
-```
-
-## API
-
-| Method | Description |
-|---|---|
-| `waitForBridge()` | Wait for WAB to load on the page |
-| `hasBridge()` | Check if WAB is available |
-| `getActions(category?)` | List available actions |
-| `getAction(name)` | Get a specific action |
-| `execute(name, params?)` | Execute an action |
-| `readContent(selector)` | Read element text content |
-| `getPageInfo()` | Get page metadata |
-| `authenticate(apiKey, meta?)` | Authenticate the agent |
-| `navigateAndWait(url)` | Navigate and wait for bridge |
-| `executeSteps(steps)` | Execute multiple actions in sequence |
-| `getBiDiContext()` | Get BiDi context (BiDi mode only) |
+# WAB Agent SDK
+
+SDK for building AI agents that interact with [Web Agent Bridge](https://github.com/abokenan444/web-agent-bridge).
+
+## Quick Start
+
+```javascript
+const puppeteer = require('puppeteer');
+const { WABAgent } = require('web-agent-bridge/sdk');
+
+const browser = await puppeteer.launch();
+const page = await browser.newPage();
+
+const agent = new WABAgent(page);
+await agent.navigateAndWait('https://example.com');
+
+// Discover available actions
+const actions = await agent.getActions();
+console.log(actions);
+
+// Execute an action
+const result = await agent.execute('signup', { email: 'user@example.com' });
+
+// Read page content
+const content = await agent.readContent('h1');
+
+await browser.close();
+```
+
+## BiDi Mode
+
+```javascript
+const agent = new WABAgent(page, { useBiDi: true });
+await agent.waitForBridge();
+
+const context = await agent.getBiDiContext();
+const actions = await agent.getActions();
+await agent.execute('click-login');
+```
+
+## API
+
+| Method | Description |
+|---|---|
+| `waitForBridge()` | Wait for WAB to load on the page |
+| `hasBridge()` | Check if WAB is available |
+| `getActions(category?)` | List available actions |
+| `getAction(name)` | Get a specific action |
+| `execute(name, params?)` | Execute an action |
+| `readContent(selector)` | Read element text content |
+| `getPageInfo()` | Get page metadata |
+| `authenticate(apiKey, meta?)` | Authenticate the agent |
+| `navigateAndWait(url)` | Navigate and wait for bridge |
+| `executeSteps(steps)` | Execute multiple actions in sequence |
+| `getBiDiContext()` | Get BiDi context (BiDi mode only) |

package/sdk/index.js

@@ -1,203 +1,203 @@
-/**
- * WAB Agent SDK
- *
- * Helpers for building AI agents that interact with Web Agent Bridge.
- * Works with Puppeteer, Playwright, or any browser automation tool.
- *
- * Usage:
- *   const { WABAgent } = require('./sdk');
- *   const agent = new WABAgent(page);
- *   await agent.waitForBridge();
- *   const actions = await agent.getActions();
- *   await agent.execute('signup', { email: 'test@example.com' });
- */
-
-class WABAgent {
-  /**
-   * @param {object} page — A Puppeteer or Playwright page object
-   * @param {object} [options]
-   * @param {number} [options.timeout=10000] — Default timeout in ms
-   * @param {boolean} [options.useBiDi=false] — Use BiDi interface instead of AICommands
-   */
-  constructor(page, options = {}) {
-    this.page = page;
-    this.timeout = options.timeout || 10000;
-    this.useBiDi = options.useBiDi || false;
-    this._biDiId = 0;
-  }
-
-  /**
-   * Wait for the WAB bridge to be ready on the page.
-   * @returns {Promise<boolean>}
-   */
-  async waitForBridge() {
-    const iface = this.useBiDi ? '__wab_bidi' : 'AICommands';
-    await this.page.waitForFunction(
-      (name) => typeof window[name] !== 'undefined',
-      { timeout: this.timeout },
-      iface
-    );
-    return true;
-  }
-
-  /**
-   * Check if the bridge is loaded on the current page.
-   * @returns {Promise<boolean>}
-   */
-  async hasBridge() {
-    const iface = this.useBiDi ? '__wab_bidi' : 'AICommands';
-    return this.page.evaluate((name) => typeof window[name] !== 'undefined', iface);
-  }
-
-  /**
-   * Get all available actions.
-   * @param {string} [category] — Optional category filter
-   * @returns {Promise<Array>}
-   */
-  async getActions(category) {
-    if (this.useBiDi) {
-      const result = await this._bidiSend('wab.getActions', category ? { category } : {});
-      return result.result || [];
-    }
-    return this.page.evaluate((cat) => window.AICommands.getActions(cat), category);
-  }
-
-  /**
-   * Get a single action by name.
-   * @param {string} name
-   * @returns {Promise<object|null>}
-   */
-  async getAction(name) {
-    return this.page.evaluate((n) => window.AICommands.getAction(n), name);
-  }
-
-  /**
-   * Execute an action by name.
-   * @param {string} name — Action name
-   * @param {object} [params] — Action parameters
-   * @returns {Promise<object>}
-   */
-  async execute(name, params) {
-    if (this.useBiDi) {
-      const result = await this._bidiSend('wab.executeAction', { name, data: params || {} });
-      return result.result || result;
-    }
-    return this.page.evaluate(
-      (n, p) => window.AICommands.execute(n, p),
-      name, params
-    );
-  }
-
-  /**
-   * Read text content of an element.
-   * @param {string} selector — CSS selector
-   * @returns {Promise<object>}
-   */
-  async readContent(selector) {
-    if (this.useBiDi) {
-      const result = await this._bidiSend('wab.readContent', { selector });
-      return result.result || result;
-    }
-    return this.page.evaluate((sel) => window.AICommands.readContent(sel), selector);
-  }
-
-  /**
-   * Get page info and bridge metadata.
-   * @returns {Promise<object>}
-   */
-  async getPageInfo() {
-    if (this.useBiDi) {
-      const result = await this._bidiSend('wab.getPageInfo');
-      return result.result || result;
-    }
-    return this.page.evaluate(() => window.AICommands.getPageInfo());
-  }
-
-  /**
-   * Authenticate an agent with the bridge.
-   * @param {string} apiKey
-   * @param {object} [meta] — Agent metadata
-   * @returns {Promise<object>}
-   */
-  async authenticate(apiKey, meta) {
-    return this.page.evaluate(
-      (key, m) => window.AICommands.authenticate(key, m),
-      apiKey, meta
-    );
-  }
-
-  /**
-   * Navigate to a URL and wait for the bridge.
-   * @param {string} url
-   * @returns {Promise<void>}
-   */
-  async navigateAndWait(url) {
-    await this.page.goto(url, { waitUntil: 'networkidle2' });
-    await this.waitForBridge();
-  }
-
-  /**
-   * Execute multiple actions in sequence.
-   * @param {Array<{name: string, params?: object}>} steps
-   * @returns {Promise<Array>}
-   */
-  async executeSteps(steps) {
-    const results = [];
-    for (const step of steps) {
-      results.push(await this.execute(step.name, step.params));
-    }
-    return results;
-  }
-
-  /**
-   * Get the WAB discovery document for the current page.
-   * @returns {Promise<object>}
-   */
-  async discover() {
-    if (this.useBiDi) {
-      const result = await this._bidiSend('wab.discover');
-      return result.result || result;
-    }
-    return this.page.evaluate(() => window.AICommands.discover());
-  }
-
-  /**
-   * Ping the bridge for a health check.
-   * @returns {Promise<object>}
-   */
-  async ping() {
-    if (this.useBiDi) {
-      const result = await this._bidiSend('wab.ping');
-      return result.result || result;
-    }
-    return this.page.evaluate(() => window.AICommands.ping());
-  }
-
-  /**
-   * Get BiDi context (only available when useBiDi is true).
-   * @returns {Promise<object>}
-   */
-  async getBiDiContext() {
-    return this.page.evaluate(() => window.__wab_bidi.getContext());
-  }
-
-  /**
-   * Get the WAB protocol interface data.
-   * @returns {Promise<object>}
-   */
-  async getProtocolInfo() {
-    return this.page.evaluate(() => window.__wab_protocol ? {
-      version: window.__wab_protocol.version,
-      protocol: window.__wab_protocol.protocol,
-      discovery: window.__wab_protocol.discover()
-    } : null);
-  }
-
-  /** @private */
-  async _bidiSend(method, params = {}) {
-    const cmd = { id: ++this._biDiId, method, params };
-    return this.page.evaluate((c) => window.__wab_bidi.send(c), cmd);
-  }
-}
-
-module.exports = { WABAgent };
+/**
+ * WAB Agent SDK
+ *
+ * Helpers for building AI agents that interact with Web Agent Bridge.
+ * Works with Puppeteer, Playwright, or any browser automation tool.
+ *
+ * Usage:
+ *   const { WABAgent } = require('./sdk');
+ *   const agent = new WABAgent(page);
+ *   await agent.waitForBridge();
+ *   const actions = await agent.getActions();
+ *   await agent.execute('signup', { email: 'test@example.com' });
+ */
+
+class WABAgent {
+  /**
+   * @param {object} page — A Puppeteer or Playwright page object
+   * @param {object} [options]
+   * @param {number} [options.timeout=10000] — Default timeout in ms
+   * @param {boolean} [options.useBiDi=false] — Use BiDi interface instead of AICommands
+   */
+  constructor(page, options = {}) {
+    this.page = page;
+    this.timeout = options.timeout || 10000;
+    this.useBiDi = options.useBiDi || false;
+    this._biDiId = 0;
+  }
+
+  /**
+   * Wait for the WAB bridge to be ready on the page.
+   * @returns {Promise<boolean>}
+   */
+  async waitForBridge() {
+    const iface = this.useBiDi ? '__wab_bidi' : 'AICommands';
+    await this.page.waitForFunction(
+      (name) => typeof window[name] !== 'undefined',
+      { timeout: this.timeout },
+      iface
+    );
+    return true;
+  }
+
+  /**
+   * Check if the bridge is loaded on the current page.
+   * @returns {Promise<boolean>}
+   */
+  async hasBridge() {
+    const iface = this.useBiDi ? '__wab_bidi' : 'AICommands';
+    return this.page.evaluate((name) => typeof window[name] !== 'undefined', iface);
+  }
+
+  /**
+   * Get all available actions.
+   * @param {string} [category] — Optional category filter
+   * @returns {Promise<Array>}
+   */
+  async getActions(category) {
+    if (this.useBiDi) {
+      const result = await this._bidiSend('wab.getActions', category ? { category } : {});
+      return result.result || [];
+    }
+    return this.page.evaluate((cat) => window.AICommands.getActions(cat), category);
+  }
+
+  /**
+   * Get a single action by name.
+   * @param {string} name
+   * @returns {Promise<object|null>}
+   */
+  async getAction(name) {
+    return this.page.evaluate((n) => window.AICommands.getAction(n), name);
+  }
+
+  /**
+   * Execute an action by name.
+   * @param {string} name — Action name
+   * @param {object} [params] — Action parameters
+   * @returns {Promise<object>}
+   */
+  async execute(name, params) {
+    if (this.useBiDi) {
+      const result = await this._bidiSend('wab.executeAction', { name, data: params || {} });
+      return result.result || result;
+    }
+    return this.page.evaluate(
+      (n, p) => window.AICommands.execute(n, p),
+      name, params
+    );
+  }
+
+  /**
+   * Read text content of an element.
+   * @param {string} selector — CSS selector
+   * @returns {Promise<object>}
+   */
+  async readContent(selector) {
+    if (this.useBiDi) {
+      const result = await this._bidiSend('wab.readContent', { selector });
+      return result.result || result;
+    }
+    return this.page.evaluate((sel) => window.AICommands.readContent(sel), selector);
+  }
+
+  /**
+   * Get page info and bridge metadata.
+   * @returns {Promise<object>}
+   */
+  async getPageInfo() {
+    if (this.useBiDi) {
+      const result = await this._bidiSend('wab.getPageInfo');
+      return result.result || result;
+    }
+    return this.page.evaluate(() => window.AICommands.getPageInfo());
+  }
+
+  /**
+   * Authenticate an agent with the bridge.
+   * @param {string} apiKey
+   * @param {object} [meta] — Agent metadata
+   * @returns {Promise<object>}
+   */
+  async authenticate(apiKey, meta) {
+    return this.page.evaluate(
+      (key, m) => window.AICommands.authenticate(key, m),
+      apiKey, meta
+    );
+  }
+
+  /**
+   * Navigate to a URL and wait for the bridge.
+   * @param {string} url
+   * @returns {Promise<void>}
+   */
+  async navigateAndWait(url) {
+    await this.page.goto(url, { waitUntil: 'networkidle2' });
+    await this.waitForBridge();
+  }
+
+  /**
+   * Execute multiple actions in sequence.
+   * @param {Array<{name: string, params?: object}>} steps
+   * @returns {Promise<Array>}
+   */
+  async executeSteps(steps) {
+    const results = [];
+    for (const step of steps) {
+      results.push(await this.execute(step.name, step.params));
+    }
+    return results;
+  }
+
+  /**
+   * Get the WAB discovery document for the current page.
+   * @returns {Promise<object>}
+   */
+  async discover() {
+    if (this.useBiDi) {
+      const result = await this._bidiSend('wab.discover');
+      return result.result || result;
+    }
+    return this.page.evaluate(() => window.AICommands.discover());
+  }
+
+  /**
+   * Ping the bridge for a health check.
+   * @returns {Promise<object>}
+   */
+  async ping() {
+    if (this.useBiDi) {
+      const result = await this._bidiSend('wab.ping');
+      return result.result || result;
+    }
+    return this.page.evaluate(() => window.AICommands.ping());
+  }
+
+  /**
+   * Get BiDi context (only available when useBiDi is true).
+   * @returns {Promise<object>}
+   */
+  async getBiDiContext() {
+    return this.page.evaluate(() => window.__wab_bidi.getContext());
+  }
+
+  /**
+   * Get the WAB protocol interface data.
+   * @returns {Promise<object>}
+   */
+  async getProtocolInfo() {
+    return this.page.evaluate(() => window.__wab_protocol ? {
+      version: window.__wab_protocol.version,
+      protocol: window.__wab_protocol.protocol,
+      discovery: window.__wab_protocol.discover()
+    } : null);
+  }
+
+  /** @private */
+  async _bidiSend(method, params = {}) {
+    const cmd = { id: ++this._biDiId, method, params };
+    return this.page.evaluate((c) => window.__wab_bidi.send(c), cmd);
+  }
+}
+
+module.exports = { WABAgent };

package/sdk/package.json

@@ -1,14 +1,14 @@
-{
-  "name": "@anthropic-wab/agent-sdk",
-  "version": "1.0.0",
-  "description": "SDK for building AI agents that interact with Web Agent Bridge (WAB)",
-  "main": "index.js",
-  "license": "MIT",
-  "keywords": ["wab", "ai-agent", "sdk", "web-automation", "bridge"],
-  "peerDependencies": {
-    "puppeteer": ">=20.0.0"
-  },
-  "peerDependenciesMeta": {
-    "puppeteer": { "optional": true }
-  }
-}
+{
+  "name": "@anthropic-wab/agent-sdk",
+  "version": "1.0.0",
+  "description": "SDK for building AI agents that interact with Web Agent Bridge (WAB)",
+  "main": "index.js",
+  "license": "MIT",
+  "keywords": ["wab", "ai-agent", "sdk", "web-automation", "bridge"],
+  "peerDependencies": {
+    "puppeteer": ">=20.0.0"
+  },
+  "peerDependenciesMeta": {
+    "puppeteer": { "optional": true }
+  }
+}