web-agent-bridge 3.2.0 → 3.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. package/LICENSE +72 -72
  2. package/README.ar.md +1286 -1152
  3. package/README.md +1764 -1635
  4. package/bin/agent-runner.js +474 -474
  5. package/bin/cli.js +237 -138
  6. package/bin/wab.js +80 -80
  7. package/examples/bidi-agent.js +119 -119
  8. package/examples/cross-site-agent.js +91 -91
  9. package/examples/mcp-agent.js +94 -94
  10. package/examples/next-app-router/README.md +44 -44
  11. package/examples/puppeteer-agent.js +108 -108
  12. package/examples/saas-dashboard/README.md +55 -55
  13. package/examples/shopify-hydrogen/README.md +74 -74
  14. package/examples/vision-agent.js +171 -171
  15. package/examples/wordpress-elementor/README.md +77 -77
  16. package/package.json +16 -3
  17. package/public/.well-known/agent-tools.json +180 -180
  18. package/public/.well-known/ai-assets.json +59 -59
  19. package/public/.well-known/security.txt +8 -0
  20. package/public/agent-workspace.html +349 -349
  21. package/public/ai.html +198 -198
  22. package/public/api.html +413 -412
  23. package/public/browser.html +486 -486
  24. package/public/commander-dashboard.html +243 -243
  25. package/public/cookies.html +210 -210
  26. package/public/css/agent-workspace.css +1713 -1713
  27. package/public/css/premium.css +317 -317
  28. package/public/css/styles.css +1235 -1235
  29. package/public/dashboard.html +706 -706
  30. package/public/dns.html +507 -0
  31. package/public/docs.html +587 -587
  32. package/public/feed.xml +89 -89
  33. package/public/growth.html +463 -463
  34. package/public/index.html +1070 -982
  35. package/public/integrations.html +556 -0
  36. package/public/js/agent-workspace.js +1740 -1740
  37. package/public/js/auth-nav.js +31 -31
  38. package/public/js/auth-redirect.js +12 -12
  39. package/public/js/cookie-consent.js +56 -56
  40. package/public/js/wab-demo-page.js +721 -721
  41. package/public/js/ws-client.js +74 -74
  42. package/public/llms-full.txt +360 -360
  43. package/public/llms.txt +125 -125
  44. package/public/login.html +85 -85
  45. package/public/mesh-dashboard.html +328 -328
  46. package/public/openapi.json +580 -580
  47. package/public/phone-shield.html +281 -0
  48. package/public/premium-dashboard.html +2489 -2489
  49. package/public/premium.html +793 -793
  50. package/public/privacy.html +297 -297
  51. package/public/register.html +105 -105
  52. package/public/robots.txt +87 -87
  53. package/public/script/wab-consent.d.ts +36 -36
  54. package/public/script/wab-consent.js +104 -104
  55. package/public/script/wab-schema.js +131 -131
  56. package/public/script/wab.d.ts +108 -108
  57. package/public/script/wab.min.js +580 -580
  58. package/public/security.txt +8 -0
  59. package/public/terms.html +256 -256
  60. package/script/ai-agent-bridge.js +1754 -1754
  61. package/sdk/README.md +99 -99
  62. package/sdk/agent-mesh.js +449 -449
  63. package/sdk/commander.js +262 -262
  64. package/sdk/index.d.ts +464 -464
  65. package/sdk/index.js +12 -1
  66. package/sdk/multi-agent.js +318 -318
  67. package/sdk/package.json +1 -1
  68. package/sdk/safety-shield.js +219 -0
  69. package/sdk/schema-discovery.js +83 -83
  70. package/server/adapters/index.js +520 -520
  71. package/server/config/plans.js +367 -367
  72. package/server/config/secrets.js +102 -102
  73. package/server/control-plane/index.js +301 -301
  74. package/server/data-plane/index.js +354 -354
  75. package/server/index.js +531 -427
  76. package/server/llm/index.js +404 -404
  77. package/server/middleware/adminAuth.js +35 -35
  78. package/server/middleware/auth.js +50 -50
  79. package/server/middleware/featureGate.js +88 -88
  80. package/server/middleware/rateLimits.js +100 -100
  81. package/server/middleware/sensitiveAction.js +157 -0
  82. package/server/migrations/001_add_analytics_indexes.sql +7 -7
  83. package/server/migrations/002_premium_features.sql +418 -418
  84. package/server/migrations/003_ads_integer_cents.sql +33 -33
  85. package/server/migrations/004_agent_os.sql +158 -158
  86. package/server/migrations/005_marketplace_metering.sql +126 -126
  87. package/server/models/adapters/index.js +33 -33
  88. package/server/models/adapters/mysql.js +183 -183
  89. package/server/models/adapters/postgresql.js +172 -172
  90. package/server/models/adapters/sqlite.js +7 -7
  91. package/server/models/db.js +681 -681
  92. package/server/observability/failure-analysis.js +337 -337
  93. package/server/observability/index.js +394 -394
  94. package/server/protocol/capabilities.js +223 -223
  95. package/server/protocol/index.js +243 -243
  96. package/server/protocol/schema.js +584 -584
  97. package/server/registry/certification.js +271 -271
  98. package/server/registry/index.js +326 -326
  99. package/server/routes/admin-premium.js +671 -671
  100. package/server/routes/admin.js +261 -261
  101. package/server/routes/ads.js +130 -130
  102. package/server/routes/agent-workspace.js +540 -540
  103. package/server/routes/api.js +150 -150
  104. package/server/routes/auth.js +71 -71
  105. package/server/routes/billing.js +45 -45
  106. package/server/routes/commander.js +316 -316
  107. package/server/routes/demo-showcase.js +332 -332
  108. package/server/routes/demo-store.js +154 -0
  109. package/server/routes/discovery.js +417 -417
  110. package/server/routes/gateway.js +173 -157
  111. package/server/routes/license.js +251 -240
  112. package/server/routes/mesh.js +469 -469
  113. package/server/routes/noscript.js +543 -543
  114. package/server/routes/premium-v2.js +686 -686
  115. package/server/routes/premium.js +724 -724
  116. package/server/routes/runtime.js +2148 -2147
  117. package/server/routes/sovereign.js +465 -385
  118. package/server/routes/universal.js +200 -185
  119. package/server/routes/wab-api.js +850 -501
  120. package/server/runtime/container-worker.js +111 -111
  121. package/server/runtime/container.js +448 -448
  122. package/server/runtime/distributed-worker.js +362 -362
  123. package/server/runtime/event-bus.js +210 -210
  124. package/server/runtime/index.js +253 -253
  125. package/server/runtime/queue.js +599 -599
  126. package/server/runtime/replay.js +666 -666
  127. package/server/runtime/sandbox.js +266 -266
  128. package/server/runtime/scheduler.js +534 -534
  129. package/server/runtime/session-engine.js +293 -293
  130. package/server/runtime/state-manager.js +188 -188
  131. package/server/security/cross-site-redactor.js +196 -0
  132. package/server/security/dry-run.js +180 -0
  133. package/server/security/human-gate-rate-limit.js +147 -0
  134. package/server/security/human-gate-transports.js +178 -0
  135. package/server/security/human-gate.js +281 -0
  136. package/server/security/index.js +368 -368
  137. package/server/security/intent-engine.js +245 -0
  138. package/server/security/reward-guard.js +171 -0
  139. package/server/security/rollback-store.js +239 -0
  140. package/server/security/token-scope.js +404 -0
  141. package/server/security/url-policy.js +139 -0
  142. package/server/services/agent-chat.js +506 -506
  143. package/server/services/agent-learning.js +601 -575
  144. package/server/services/agent-memory.js +625 -625
  145. package/server/services/agent-mesh.js +555 -539
  146. package/server/services/agent-symphony.js +717 -717
  147. package/server/services/agent-tasks.js +1807 -1807
  148. package/server/services/api-key-engine.js +292 -261
  149. package/server/services/cluster.js +894 -894
  150. package/server/services/commander.js +738 -738
  151. package/server/services/edge-compute.js +440 -440
  152. package/server/services/email.js +204 -204
  153. package/server/services/hosted-runtime.js +205 -205
  154. package/server/services/lfd.js +635 -635
  155. package/server/services/local-ai.js +389 -389
  156. package/server/services/marketplace.js +270 -270
  157. package/server/services/metering.js +182 -182
  158. package/server/services/modules/affiliate-intelligence.js +93 -93
  159. package/server/services/modules/agent-firewall.js +90 -90
  160. package/server/services/modules/bounty.js +89 -89
  161. package/server/services/modules/collective-bargaining.js +92 -92
  162. package/server/services/modules/dark-pattern.js +66 -66
  163. package/server/services/modules/gov-intelligence.js +45 -45
  164. package/server/services/modules/neural.js +55 -55
  165. package/server/services/modules/notary.js +49 -49
  166. package/server/services/modules/price-time-machine.js +86 -86
  167. package/server/services/modules/protocol.js +104 -104
  168. package/server/services/negotiation.js +439 -439
  169. package/server/services/plugins.js +771 -771
  170. package/server/services/price-intelligence.js +566 -566
  171. package/server/services/price-shield.js +1137 -1137
  172. package/server/services/reputation.js +465 -465
  173. package/server/services/search-engine.js +357 -357
  174. package/server/services/security.js +513 -513
  175. package/server/services/self-healing.js +843 -843
  176. package/server/services/sovereign-shield.js +542 -0
  177. package/server/services/stripe.js +192 -192
  178. package/server/services/swarm.js +788 -788
  179. package/server/services/universal-scraper.js +662 -661
  180. package/server/services/verification.js +481 -481
  181. package/server/services/vision.js +1163 -1163
  182. package/server/utils/cache.js +125 -125
  183. package/server/utils/migrate.js +81 -81
  184. package/server/utils/safe-fetch.js +228 -0
  185. package/server/utils/secureFields.js +50 -50
  186. package/server/ws.js +161 -161
  187. package/templates/artisan-marketplace.yaml +104 -104
  188. package/templates/book-price-scout.yaml +98 -98
  189. package/templates/electronics-price-tracker.yaml +108 -108
  190. package/templates/flight-deal-hunter.yaml +113 -113
  191. package/templates/freelancer-direct.yaml +116 -116
  192. package/templates/grocery-price-compare.yaml +93 -93
  193. package/templates/hotel-direct-booking.yaml +113 -113
  194. package/templates/local-services.yaml +98 -98
  195. package/templates/olive-oil-tunisia.yaml +88 -88
  196. package/templates/organic-farm-fresh.yaml +101 -101
  197. package/templates/restaurant-direct.yaml +97 -97
  198. package/public/score.html +0 -263
  199. package/server/migrations/006_growth_suite.sql +0 -138
  200. package/server/routes/growth.js +0 -962
  201. package/server/services/fairness-engine.js +0 -409
  202. package/server/services/fairness.js +0 -420
package/README.md CHANGED
@@ -1,1635 +1,1764 @@
1
- # Web Agent Bridge (WAB)
2
-
3
- [![npm](https://img.shields.io/npm/v/web-agent-bridge)](https://www.npmjs.com/package/web-agent-bridge)
4
- [![CI](https://github.com/abokenan444/web-agent-bridge/actions/workflows/ci.yml/badge.svg)](https://github.com/abokenan444/web-agent-bridge/actions/workflows/ci.yml)
5
- [![License: Open Core](https://img.shields.io/badge/License-Open_Core-blue.svg)](LICENSE)
6
- [![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg)](https://nodejs.org/)
7
- [![Docker](https://img.shields.io/badge/docker-ready-blue.svg)](https://hub.docker.com/)
8
- [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
9
-
10
- > **robots.txt told bots what NOT to do. WAB tells AI agents what they CAN do.**
11
-
12
- 🌐 **Live Website:** [https://webagentbridge.com](https://webagentbridge.com) — Try the Agent Workspace, dashboards, and many more features live.
13
-
14
- **English** | **[العربية](README.ar.md)**
15
-
16
- WAB is an open-source middleware layer that bridges AI agents and websites — like **OpenAPI for human-facing pages**. Website owners embed a script that exposes a standardized `window.AICommands` interface. AI agents discover available actions, execute commands, and interact with sites accurately — no DOM parsing, no scraping, no guesswork.
17
-
18
- ### Three Paths to WAB
19
-
20
- | Path | For | How |
21
- |---|---|---|
22
- | **🏢 Website Owner** | Control how AI interacts with your site | Embed the script, configure permissions |
23
- | **🤖 Agent Developer** | Build reliable agents that work on any WAB-enabled site | Use `window.AICommands` or the Agent SDK |
24
- | **🔧 Self-Hosting** | Run the full WAB platform for your organization | Clone, deploy, manage licenses & analytics |
25
- | **WordPress** | Sites powered by WP | Use the **[Web Agent Bridge WordPress plugin](web-agent-bridge-wordpress/README.md)** (settings, shortcode, per-page disable, hooks) |
26
-
27
- ---
28
-
29
- ## Features
30
-
31
- - **Auto-Discovery** — Automatically detects buttons, forms, and navigation on the page
32
- - **Structured Auto-Discovery** — Detects schema.org JSON-LD + microdata products/offers and exposes read actions
33
- - **Commerce + Booking Intents** — Detects common actions like add-to-cart, checkout, and booking/reservation flows
34
- - **Permission System** — Granular control over what AI agents can do (click, fill forms, API access, etc.)
35
- - **Standardized Interface** — Unified `window.AICommands` object any agent can consume
36
- - **Secure License Exchange** — Embed uses public `siteId` + `/api/license/token`; long-lived license keys stay in the owner dashboard, not in HTML
37
- - **Rate Limiting** — Multi-dimensional abuse protection (IP + license key + site)
38
- - **Analytics Dashboard** — Track how AI agents interact with your site
39
- - **Real-Time Analytics** — WebSocket-based live event streaming with auto-reconnection
40
- - **In-Memory Caching** — TTL-based cache layer reduces DB reads on hot paths
41
- - **Analytics Queue** — Batched writes with transaction support for high-throughput tracking
42
- - **WebDriver BiDi Compatible** — Standard protocol support via `window.__wab_bidi`
43
- - **CDN Versioning** — Serve scripts via versioned URLs (`/v1/ai-agent-bridge.js`, `/latest/ai-agent-bridge.js`)
44
- - **Docker Ready** — One-command deployment with Docker Compose
45
- - **DB Migrations** — Numbered SQL migration runner with tracking table
46
- - **Custom Actions** — Register your own actions with custom handlers
47
- - **Subscription Tiers** — Free core + paid premium features (API access, analytics, automated login)
48
- - **Event System** — Subscribe to bridge events for monitoring
49
- - **Security Sandbox** — Origin validation, session tokens, command signing, audit logging, auto-lockdown
50
- - **Self-Healing Selectors** — Resilient element resolution with fuzzy matching for dynamic SPAs
51
- - **Stealth Mode** — Human-like interaction patterns (requires explicit consent)
52
- - **Multi-Database** — SQLite (default), PostgreSQL, MySQL via pluggable adapters
53
- - **Agent SDK** — Built-in SDK for building AI agents with Puppeteer/Playwright
54
- - **React Package** — `@web-agent-bridge/react` with `WABProvider`, `useWAB`, `useWABAction`, and `useWABActions`
55
- - **Vue Package** — `@web-agent-bridge/vue` composables (`useWAB`, `useWABAction`, `useWABActions`) for Vue 3+
56
- - **Svelte Package** — `@web-agent-bridge/svelte` stores (`createWAB`, `createWABAction`) for Svelte 3+
57
- - **LangChain Adapter** — `@web-agent-bridge/langchain` wraps WAB actions as LangChain tools for LLM agents
58
- - **GDPR/CCPA Consent** — Optional `wab-consent.js` banner with `WABConsent.showBanner()` and `hasConsent()` gate
59
- - **Admin Dashboard** — User management, tier grants, system analytics
60
- - **Stripe Integration** — Payment processing with customer portal
61
- - **Plugin Architecture** — Dynamic plugin system with hook-based execution, per-site installation, priority ordering, ratings, and audit logging
62
- - **Vision Analysis Service** — Multi-provider screenshot analysis (local Moondream, OpenAI, Anthropic, Ollama) with interactive element detection, bounding box extraction, and AES-256-GCM encrypted API keys
63
- - **Fairness Engine** — Neutrality layer ensuring AI agents give equal opportunity to small and large sites with fairness-weighted search, commission transparency tracking, and trust signature validation
64
- - **Agent Memory System** — Persistent behavioral memory with 4 memory types, 5 categories, semantic associations, importance scoring, and TTL-based expiration
65
- - **Premium Traffic Intelligence** — Advanced bot detection (30+ agent types), behavioral profiling, anomaly/spike detection, security exploit detection (SQLi, XSS), and webhook alerting
66
- - **E-Mail Service** — SMTP-based transactional emails (welcome, registration, password reset, contact) with branded HTML templates
67
- - **NoScript Fallback** — 1×1 tracking pixel endpoint for analytics collection when JavaScript is unavailable
68
- - **WAB-MCP Adapter** — Expose WAB site capabilities as MCP tools for Claude, GPT, Gemini, and other MCP-compatible AI agents
69
- - **WordPress Plugin** — Native WordPress plugin with settings page, per-page action meta boxes, discovery document generation, and dashboard widget
70
- - **WAB Browser (Desktop)** — Standalone Electron desktop browser with built-in ad blocker (80+ domains), scam shield, fairness ranking, agent chat, bookmarks, history, and WAB protocol support. *Desktop source is maintained in a separate private build pipeline (`wab-browser/`); the PWA source below is fully open.*
71
- - **PWA Browser (Mobile)** — Progressive Web App browser for Android/iOS with ad blocking (80+ domains), WAB Search engine, scam detection, fairness ranking, real AI agent chat, and offline-first service worker. Full source at `public/pwa/`.
72
- - **Schema Discovery SDK** — Server-side extraction of schema.org JSON-LD Product nodes from HTML with automatic WAB action hint generation
73
-
74
- ### v2.0Digital Fortress Features
75
-
76
- - **Real-time Negotiation Engine** — AI agents negotiate prices directly with WAB-enabled sites using multi-round sessions. 8 condition types (bulk, loyalty, time-based, first-purchase, cart-value, seasonal, membership, referral) and 4 discount types (percentage, fixed, free-shipping, bonus-item). Includes daily usage limits, minimum order values, and full audit trail of all offers
77
- - **Anti-Hallucination Shield** Cross-verification engine comparing DOM vs vision screenshots, market benchmark validation, temporal consistency checks, and Levenshtein text similarity scoring. 4 severity levels (minor → fraud) and 5 response actions (warn, halt, confirm-human, auto-correct, block)
78
- - **Decentralized Reputation System** — HMAC-signed trust attestations from the agent network covering 6 attestation types (purchase, booking, query, form, navigation, verification). 7 trust levels (unknown → blacklisted), temporal decay, Sybil resistance, global leaderboard, and challenge/dispute system
79
- - **Sovereign Dashboard** — Real-time command center with fairness radar, privacy shield, negotiation logs, verification checks, and AI model switcher. Exposes `/api/sovereign/dashboard/sovereign` aggregate endpoint
80
- - **Community Agent Hub** — 11 pre-built YAML agent templates (hotel booking, grocery comparison, artisan marketplace, flight deals, etc.) with CLI runner: `npx wab-agent run template.yaml`
81
- - **AI Brain Swapping** — Local AI runtime that auto-discovers Ollama and llama.cpp endpoints plus custom OpenAI-compatible APIs. Model capability tracking for text/vision, context window management, latency-based routing, and inference logging with token metrics
82
- - **Cross-Site Agent Orchestration** — One agent manages multiple WAB-enabled sites simultaneously via `WABMultiAgent`. Compare prices across stores, aggregate data, run parallel actions, and find the best deal automatically
83
-
84
- ### v2.3Private Agent Mesh (Distributed Mind)
85
-
86
- - **Inter-Agent Protocol** — Agents communicate through a private mesh with 5 built-in channels (alerts, discoveries, tactics, negotiations, votes). 6 message types with confidence scoring, auto-expiring stale agents via heartbeat, peer verification of shared knowledge. All communication stays local — no external transmission
87
- - **Local Reinforcement Learning** Agents learn from every user decision using UCB1 multi-armed bandit action selection, gradient-descent policy updates with sigmoid activation, temporal discounting, and sequential pattern mining. Zero external API calls — all learning is local
88
- - **Symphony Orchestrator** — Four specialized agents (Researcher, Analyst, Negotiator, Guardian) collaborate autonomously through rule-based engines. 5 templates, 6-phase pipeline (analyze → research → negotiate → guard → synthesize → decide), Guardian veto for safety, weighted consensus. Full phase logging with duration tracking. No external LLM dependency
89
- - **Agent Mesh Dashboard** — Real-time visualization of your agent mesh: active agents, communication channels, shared knowledge base, symphony compositions, and learning performance metrics
90
-
91
- ### v2.4Commander & Edge Intelligence
92
-
93
- - **Commander Agent System** — Local-first mission orchestration engine that decomposes high-level goals into task DAGs. Agent registry with capabilities tracking, parallel execution engine, learning integration for outcome feedback, and edge coordination for distributed work
94
- - **Edge Compute System** Transforms every user device into a sovereign AI node. Hardware profiling (CPU, RAM, GPU), AES-256-GCM encrypted inter-node communication, weighted load balancing, heartbeat-based health monitoring with auto-failover, and swarm formation with capability-based clustering
95
- - **Swarm Execution Engine** — Launch multiple agents in parallel to solve a single task. Configurable strategies (parallel, sequential, hybrid), result merging with best-score selection, role specialization, fairness-weighted aggregation, and per-agent confidence scoring
96
-
97
- ### v2.5Agent Workspace & Multilingual AI
98
-
99
- - **Agent Workspace** — Premium 4-panel workspace for non-technical users: embedded browser, smart agent chat, real-time negotiation monitor, and results panel. Subscription tiers (Free/Starter/Pro/Enterprise), deal tracking, and admin management. Live at [webagentbridge.com/workspace](https://webagentbridge.com/workspace)
100
- - **Bilingual UI (AR/EN)** Full Arabic/English interface with auto-detection from browser language. Toggle instantly between languages. RTL/LTR layout support
101
- - **Multilingual Agent** — The smart agent understands and responds in any language the user writes in — Arabic, English, French, Spanish, Turkish, and more. No restrictions on input style, dialect, or format
102
- - **Dynamic Pricing Shield** — Detects price manipulation by websites that change prices based on device type, geolocation, cookies, browsing history, referral source, or repeat visits. The agent probes the same page with 12 distinct identity personas (clean desktop, mobile, Mac premium, EU/MENA/SEA geo, repeat visitor, Google/social/comparison referral, privacy-focused, bot-like) and uses statistical analysis (coefficient of variation, z-score outliers) to expose hidden pricing. Includes manipulation scoring (0–100), actionable tips, historical trend detection, and a strategy builder that recommends the best identity for the lowest price. Full API at `/api/sovereign/price-shield/`
103
-
104
- ### v3.0Agent OS (Execution Layer for the Web)
105
-
106
- WAB v3.0 transforms the project from an advanced automation tool into a **real Agent Operating System** — a complete execution layer for AI agents on the web, comparable to MCP but purpose-built for browser interaction.
107
-
108
- - **WAB Protocol (WABP) v1.0.0** — Formal protocol with JSON Schema command registry, typed messages, input/output validation, and versioned command definitions. 10 built-in commands (discover, execute, semantic.execute, agent.register, task.submit, task.status, commerce.compare, commerce.negotiate, mesh.send, ai.infer). Every command has declared capabilities, risk levels, and permission requirements
109
- - **Capability Negotiation** Dynamic capability grants between agents and sites. Risk-based auto-approval (low-risk auto-granted, high-risk requires policy), rate limiting per capability, expirable grants with usage tracking, and full revocation support
110
- - **Agent Runtime Engine** — Production-grade task runtime with priority queue scheduler, dependency resolution, retry with exponential backoff, pause/resume/cancel, concurrency limits, and state machine transitions. EventBus with async middleware, namespace wildcards, replay buffer (10K events), and dead letter queue
111
- - **Execution Sandbox** — Per-task isolation with resource limits (timeout, maxMemory, maxNetworkCalls, maxDomOperations), domain allowlists, blocked selector enforcement, capability checks at execution time, and full audit trail of every operation
112
- - **State Manager** — Agent state persistence with labeled checkpoints, rollback to any checkpoint, state transitions with validation, merge operations, and TTL-based cleanup
113
- - **Observability Stack** — Structured JSON logger with child loggers and pluggable sinks, distributed tracer with parent-child spans (OpenTelemetry-compatible), and metrics collector with counters, gauges, histograms (p50/p90/p95/p99 percentiles), and time series for dashboards
114
- - **Security Model** — AgentIdentity (registration, hashed API key authentication, session management with TTL, IP allowlists, revocation), CommandSigner (HMAC-SHA256 signing/verification with nonce + timestamp, timing-safe comparison), and SiteIsolation (per-site access control, allowed/blocked agents, max concurrency, selector blocking, data classification)
115
- - **Control Plane** — AgentManager for deployment lifecycle (deploy, assign to sites, health checks, undeploy) and PolicyEngine with typed rules, condition evaluation (equals, contains, pattern, min, max, in), priority-ordered policy binding, and entity-level policy enforcement
116
- - **Data Plane** — SemanticActionResolver maps `domain.action` notation (e.g., `checkout.addItem`) to concrete implementations per site. Executor routes tasks through tracing + metrics, supports semantic/pipeline/parallel execution modes, with 8 built-in semantic actions for checkout, search, auth, navigation, and content
117
- - **Multi-Model LLM Abstraction** — Unified interface for OpenAI (chat completions + embeddings), Anthropic (messages API), and Ollama (local models with auto-discovery). LLMManager provides automatic fallback chain through all providers, response caching (5min TTL), cost tracking via token counts, and model listing
118
- - **Registry & Ecosystem** — CommandRegistry (like npm for WAB commands — register, discover, search by category/tag/capability, usage tracking), SiteRegistry (WAB-enabled sites directory with verification, capability listing, visit tracking), and TemplateRegistry (reusable workflow templates with download counts and ratings)
119
- - **Unified Runtime API** — All Agent OS layers exposed via RESTful endpoints at `/api/os/*`: protocol discovery, agent identity/auth, task CRUD, semantic execution, deployments, policies, isolation, observability (metrics/traces/logs), registry (commands/sites/templates), LLM operations, command signing, and Server-Sent Events for real-time streaming
120
- - **WABAgentOS SDK Client** — New `WABAgentOS` class in the SDK provides full TypeScript-typed API for all Agent OS operations: register authenticate negotiate capabilities submit tasks execute semantically query observability subscribe to events
121
-
122
- ### v3.1WAP Deep Architecture (Protocol Hardening)
123
-
124
- v3.1 hardens the Agent OS into a production-grade system that *surpasses* MCP — making WAP (Web Agent Protocol) the top-level protocol with MCP as just one adapter.
125
-
126
- - **WAP Discovery Spec** — Formal `/.well-known/agent-tools.json` discovery document. AI agents can find all WAP capabilities, commands, permissions, runtime config, security model, and SDKs from a single standardized URL
127
- - **Adapter Layer** — WAP sits at the top; MCP, REST/GraphQL, and Browser automation are transport adapters beneath it. MCP Adapter exposes all WAB commands as MCP tools (list_tools / call_tool). REST Adapter registers external APIs as first-class WAP endpoints with auth, mapping, and rate limiting. Browser Adapter translates semantic actions (checkout.addItem, search.query, auth.login) into concrete browser step plans with selector fallbacks and verification
128
- - **Auth Middleware** — All `/api/os/*` mutation endpoints require authentication (Bearer token, API key, or agent header). Public read endpoints remain open for discovery. GET requests pass through for read-only access
129
- - **Deterministic Replay Engine** — Records all task inputs, outputs, and side-effects. Supports replay with verification mode (re-execute and compare), dry-run mode (inspect recorded steps), and diff between two recordings. Enables debugging, regression testing, and workflow certification
130
- - **Failure Analysis & Classification** — Automatic classification of failures into 9 categories (network, timeout, permission, validation, execution, rate_limit, resource, dependency, unknown). Root cause analysis, severity scoring, retryability assessment, suggested fixes, and pattern detection for recurring failures
131
- - **Session Engine** — Browser execution sessions with cookie jar (set/get/domain-scoped), localStorage/sessionStorage emulation, navigation history, variable store, session export/import for transfer, and TTL-based expiration
132
- - **Certification System** — Site compatibility verification with 13 weighted checks across 7 categories (integration, protocol, data, security, fairness, compliance, sovereignty). Issues certificates at 5 levels (none basic standard premium sovereign) with 90-day validity, HMAC-signed badges, and revocation
133
- - **DB Persistence Layer** — SQLite tables for all Agent OS entities: agents, sessions, tasks, deployments, registry commands/sites/templates, audit log (immutable append-only), capability grants, and policies. Auto-migrates on boot
134
- - **65+ API Endpoints** — Adapters (MCP tools, REST endpoints, browser mappings), replay (recordings, replay, diff, stats), sessions (CRUD, cookies, storage, export/import), failure analysis (query, patterns, summary, classify), certification (verify, certificates, revoke), plus all existing v3.0 endpoints
135
-
136
- > **Many more features** are available on the live website that aren't listed here dashboards, analytics, admin tools, and more. Visit [webagentbridge.com](https://webagentbridge.com) to explore.
137
-
138
- ### v3.2 — API Gateway & Advanced Modules
139
-
140
- v3.2 introduces a **unified API gateway** at `/api/v1` with 10 advanced modules for AI agent protection, consumer rights, price intelligence, and regulatory compliance. All modules use centralized API key authentication with plan-based access control.
141
-
142
- 🌐 **Live API Docs:** [webagentbridge.com/api](https://webagentbridge.com/api) (English / العربية)
143
-
144
- #### API Plans & Pricing
145
-
146
- | Plan | Price | Requests/Day | Requests/Min | Modules |
147
- |------|-------|-------------|-------------|----------|
148
- | **Free** | $0/mo | 100 | 10 | Protocol, Price Time Machine, Dark Pattern, Bounty |
149
- | **Pro** | $29/mo | 10,000 | 100 | All Free + Firewall, Neural, Bargaining, Affiliate |
150
- | **Business** | $149/mo | 100,000 | 500 | All 10 modules (incl. Notary, Gov Intelligence) |
151
- | **Enterprise** | Custom | Unlimited | Custom | All 10 + SLA + on-premise option |
152
-
153
- **Get your API key:** `POST /api/v1/keys/generate` with `{"plan": "FREE", "owner": "name", "email": "you@example.com"}`
154
-
155
- #### The 10 Modules
156
-
157
- | # | Module | Route | Type | Min Plan | Description |
158
- |---|--------|-------|------|----------|-------------|
159
- | 01 | **Agent Firewall** | `/api/v1/firewall` | 🟡 API Open · Engine Closed | PRO | Scans URLs/content for prompt injection, phishing, malicious domains |
160
- | 02 | **Cryptographic Notary** | `/api/v1/notary` | 🔴 Fully Closed | BUSINESS | Issues legally admissible cryptographic certificates for price discrimination proof |
161
- | 03 | **Dark Pattern Detector** | `/api/v1/dark-pattern` | 🔴 Fully Closed | FREE | Detects all 17 OECD-classified dark patterns with EU DSA/DMA audit reports |
162
- | 04 | **Collective Bargaining** | `/api/v1/bargaining` | 🟡 Join Open · Engine Closed | PRO | Anonymous buyer grouping for bulk discount negotiation |
163
- | 05 | **Gov Intelligence** | `/api/v1/gov` | 🔴 Fully Closed | BUSINESS | Regulatory compliance database and domain compliance checking |
164
- | 06 | **Price Time Machine** | `/api/v1/price` | 🟡 API Open · DB Closed | FREE | Historical price tracking and fake discount detection |
165
- | 07 | **WAB Neural Engine** | `/api/v1/neural` | 🔴 Fully Closed | PRO | Local AI inference for URL analysis, content classification, embeddings |
166
- | 08 | **WAB Protocol** | `/api/v1/protocol` | 🟢 Fully Open Source | FREE | Open wab.json trust protocol validator and schema endpoint |
167
- | 09 | **Bounty Network** | `/api/v1/bounty` | 🟡 Report Open · Rules Closed | FREE | Community-powered threat reporting and bug bounty with leaderboard |
168
- | 10 | **Affiliate Intelligence** | `/api/v1/affiliate` | 🟡 API Open · DB Closed | PRO | Detects affiliate link manipulation, cookie stuffing, tracking pixel abuse |
169
-
170
- **Type Legend:** 🟢 Fully open source · 🟡 Public API interface, proprietary engine · 🔴 Fully closed (returns 503 without engine)
171
-
172
- #### Authentication
173
-
174
- All module endpoints require an API key via one of three methods:
175
-
176
- ```bash
177
- # Option 1: Authorization header (recommended)
178
- curl -X POST https://www.webagentbridge.com/api/v1/firewall/scan \
179
- -H "Authorization: Bearer wab_live_pro_YOUR_KEY" \
180
- -H "Content-Type: application/json" \
181
- -d '{"url": "https://example.com", "content": "page content..."}'
182
-
183
- # Option 2: X-WAB-Key header
184
- curl -H "X-WAB-Key: wab_live_pro_YOUR_KEY" \
185
- https://www.webagentbridge.com/api/v1/protocol/check/example.com
186
-
187
- # Option 3: Query parameter
188
- curl https://www.webagentbridge.com/api/v1/bounty/stats?api_key=wab_live_fre_YOUR_KEY
189
- ```
190
-
191
- #### Key Management
192
-
193
- | Endpoint | Method | Description |
194
- |----------|--------|-------------|
195
- | `/api/v1/keys/generate` | POST | Create a new API key |
196
- | `/api/v1/keys/validate` | POST | Validate an existing key |
197
- | `/api/v1/keys/usage` | GET | Check usage and quotas |
198
- | `/api/v1/keys/revoke` | POST | Revoke a key |
199
- | `/api/v1/keys/rotate` | POST | Rotate a key (revoke old, issue new) |
200
-
201
- #### Gateway Endpoints
202
-
203
- | Endpoint | Method | Description |
204
- |----------|--------|-------------|
205
- | `/api/v1/health` | GET | Gateway health check (public) |
206
- | `/api/v1/plans` | GET | List available plans and pricing (public) |
207
- | `/api/v1/modules` | GET | List all available modules (public) |
208
-
209
- #### How to Subscribe
210
-
211
- 1. Visit [webagentbridge.com/api](https://webagentbridge.com/api) to explore available modules
212
- 2. Generate a **Free** API key: `POST /api/v1/keys/generate` with your name and email
213
- 3. Start making requests to any Free-tier module immediately
214
- 4. Upgrade to **Pro** ($29/mo) or **Business** ($149/mo) for access to advanced modules
215
- 5. Manage your keys via the `/api/v1/keys/*` endpoints
216
-
217
- ---
218
-
219
- ## Quick Start
220
-
221
- ### 1. Install & Run the Server
222
-
223
- ```bash
224
- # Option A: Clone and run
225
- git clone https://github.com/abokenan444/web-agent-bridge.git
226
- cd web-agent-bridge
227
- npm install
228
- cp .env.example .env
229
- npm start
230
-
231
- # Option B: npx (one command)
232
- npx web-agent-bridge start
233
-
234
- # Option C: Docker
235
- docker compose up -d
236
- ```
237
-
238
- ### 2. Create an Account
239
-
240
- Visit `http://localhost:3000/register` and create an account, then add your site from the dashboard.
241
-
242
- ### 3. Add the Script to Your Website
243
-
244
- ```html
245
- <!-- Recommended: copy the snippet from your dashboard (uses siteId only) -->
246
- <script>
247
- window.AIBridgeConfig = {
248
- siteId: "your-site-uuid-from-dashboard",
249
- configEndpoint: "https://yourserver.com/api/license/token",
250
- agentPermissions: {
251
- readContent: true,
252
- click: true,
253
- fillForms: true,
254
- scroll: true
255
- }
256
- };
257
- </script>
258
- <script src="https://yourserver.com/script/ai-agent-bridge.js"></script>
259
- ```
260
-
261
- The server matches **Origin** to your registered site domain, then returns a short-lived **session token**. Analytics (`/api/license/track`) require that session — not the long-lived license key. Keep the license key in the dashboard only.
262
-
263
- ### 4. AI Agents Can Now Interact
264
-
265
- ```javascript
266
- // From the AI agent's side
267
- const bridge = window.AICommands;
268
- const actions = bridge.getActions(); // discover actions
269
- await bridge.execute("signup"); // execute an action
270
- const info = bridge.getPageInfo(); // get page metadata
271
- ```
272
-
273
- ---
274
-
275
- ## Project Structure
276
-
277
- ```
278
- web-agent-bridge/
279
- ├── server/ # Express.js backend
280
- │ ├── index.js # Server entry point
281
- │ ├── ws.js # WebSocket server (live analytics)
282
- │ ├── routes/
283
- │ │ ├── auth.js # Authentication (register/login)
284
- │ │ ├── api.js # Sites, config, analytics API
285
- │ │ ├── license.js # License verification, token exchange & tracking
286
- │ │ ├── admin.js # Admin dashboard API
287
- │ │ ├── admin-premium.js # Admin premium analytics (memory, vision, swarm, plugins)
288
- │ │ ├── billing.js # Stripe billing integration
289
- │ │ ├── sovereign.js # v2.0: negotiation, reputation, verification, dashboard
290
- │ │ ├── mesh.js # v2.3: agent mesh protocol routes
291
- │ │ ├── commander.js # v2.4: mission orchestration routes
292
- │ │ ├── premium.js # Premium features
293
- │ │ ├── premium-v2.js # v2 premium (memory, vision, healing, swarm, plugins)
294
- │ │ ├── discovery.js # WAB discovery + fairness-weighted search
295
- │ │ ├── wab-api.js # WAB HTTP transport (alternative to JS/WS)
296
- │ │ ├── noscript.js # NoScript tracking pixel fallback
297
- │ │ └── gateway.js # v3.2: Unified API Gateway (/api/v1)
298
- │ ├── services/
299
- │ │ ├── negotiation.js # Real-time negotiation engine
300
- │ │ ├── verification.js # Anti-hallucination shield
301
- │ │ ├── reputation.js # Decentralized reputation system
302
- ├── agent-mesh.js # Inter-agent protocol (mesh)
303
- ├── agent-learning.js # Local reinforcement learning (UCB1)
304
- ├── agent-symphony.js # Symphony orchestrator (4 roles, 6 phases)
305
- │ │ ├── agent-memory.js # Persistent agent memory with associations
306
- │ │ ├── commander.js # Mission orchestration & task DAGs
307
- │ │ ├── edge-compute.js # Edge computing / sovereign AI nodes
308
- │ │ ├── swarm.js # Swarm execution engine
309
- │ │ ├── fairness.js # Fairness & neutrality engine
310
- │ │ ├── vision.js # Vision analysis (multi-provider)
311
- │ │ ├── self-healing.js # Self-healing selector corrections
312
- │ │ ├── local-ai.js # Local AI model runtime
313
- │ │ ├── plugins.js # Plugin architecture (hooks, registry)
314
- │ │ ├── premium.js # Premium traffic intelligence & bot detection
315
- │ │ ├── email.js # SMTP email service
316
- │ │ ├── stripe.js # Stripe payment integration
317
- │ │ ├── api-key-engine.js # v3.2: API key auth, rate limiting, plans
318
- │ │ └── modules/ # v3.2: API Gateway modules
319
- │ │ ├── protocol.js # WAB Protocol validator (open)
320
- ├── agent-firewall.js # Agent Firewall (partial)
321
- │ │ ├── price-time-machine.js # Price Time Machine (partial)
322
- │ │ ├── bounty.js # Bounty Network (partial)
323
- │ │ ├── collective-bargaining.js # Collective Bargaining (partial)
324
- │ │ ├── affiliate-intelligence.js # Affiliate Intelligence (partial)
325
- │ │ ├── neural.js # Neural Engine (closed)
326
- │ │ ├── dark-pattern.js # Dark Pattern Detector (closed)
327
- │ │ ├── gov-intelligence.js # Gov Intelligence (closed)
328
- │ │ └── notary.js # Cryptographic Notary (closed)
329
- │ ├── middleware/
330
- │ │ ├── auth.js # JWT authentication middleware
331
- │ │ ├── adminAuth.js # Admin authentication
332
- │ │ └── rateLimits.js # Multi-layer rate limiting
333
- │ ├── models/
334
- │ │ ├── db.js # Database operations
335
- │ │ └── adapters/ # SQLite, PostgreSQL, MySQL adapters
336
- │ ├── migrations/ # Numbered SQL migrations
337
- └── utils/
338
- ├── cache.js # In-memory TTL cache + analytics queue
339
- ├── migrate.js # Migration runner
340
- └── secureFields.js # Field-level encryption utilities
341
- ├── public/ # Frontend
342
- │ ├── index.html # Landing page
343
- │ ├── dashboard.html # Management dashboard
344
- │ ├── premium-dashboard.html # Premium analytics dashboard
345
- │ ├── docs.html # Documentation
346
- │ ├── login.html / register.html # Auth pages
347
- │ ├── admin/ # Admin panel
348
- │ ├── pwa/ # Progressive Web App (mobile browser)
349
- │ │ ├── manifest.json # PWA manifest
350
- │ │ ├── sw.js # Service worker (offline-first)
351
- ├── index.html # Mobile browser UI
352
- │ │ ├── app.js # Ad blocker, scam shield, fairness
353
- │ │ ├── app.css # Mobile-optimized dark theme
354
- │ │ └── icons/ # PWA icons (192x192, 512x512)
355
- │ ├── script/
356
- │ │ ├── wab.min.js # Minified WAB client library
357
- │ │ ├── wab-consent.js # GDPR/CCPA consent banner
358
- ├── wab-schema.js # Schema.org discovery
359
- │ ├── wab.d.ts # TypeScript definitions
360
- │ └── wab-consent.d.ts # Consent TypeScript definitions
361
- ├── js/ # Dashboard frontend JS
362
- └── css/ # Stylesheets
363
- ├── script/
364
- └── ai-agent-bridge.js # The bridge script (embed in websites)
365
- ├── examples/ # Agent examples
366
- │ ├── puppeteer-agent.js # Puppeteer + window.AICommands
367
- │ ├── bidi-agent.js # WebDriver BiDi protocol
368
- │ ├── vision-agent.js # Vision/NLP intent resolution
369
- │ ├── mcp-agent.js # MCP adapter usage for Claude/GPT
370
- │ ├── cross-site-agent.js # Multi-domain orchestration
371
- │ ├── next-app-router/ # Next.js App Router integration
372
- │ ├── shopify-hydrogen/ # Shopify Hydrogen storefront
373
- │ ├── wordpress-elementor/ # WordPress + Elementor setup
374
- └── saas-dashboard/ # SaaS dashboard actions
375
- ├── packages/ # Framework wrappers
376
- ├── react/ # @web-agent-bridge/react
377
- │ ├── vue/ # @web-agent-bridge/vue
378
- │ ├── svelte/ # @web-agent-bridge/svelte
379
- └── langchain/ # @web-agent-bridge/langchain
380
- ├── sdk/ # Agent SDK
381
- │ ├── index.js # WABAgent for Puppeteer/Playwright
382
- │ └── schema-discovery.js # Server-side schema.org extraction
383
- ├── wab-mcp-adapter/ # MCP adapter for Claude/GPT/Gemini
384
- ├── index.js # MCP tool definitions
385
- │ └── package.json
386
- ├── wab-browser/ # Electron desktop browser
387
- ├── main.js # Electron main process
388
- │ ├── preload.js # Bridge preload
389
- └── package.json
390
- ├── web-agent-bridge-wordpress/ # WordPress plugin
391
- │ ├── web-agent-bridge.php # Plugin entry point
392
- │ ├── includes/ # PHP classes (API, Actions, Dashboard)
393
- └── assets/ # Plugin CSS/JS
394
- ├── bin/
395
- │ ├── cli.js # CLI entry point (wab-agent)
396
- │ └── wab.js # Agent runner
397
- ├── templates/ # 11 Community Agent Hub YAML templates
398
- ├── docs/
399
- │ ├── SPEC.md # WAB Protocol Specification
400
- └── DEPLOY.md # Deployment guide
401
- ├── demo-store/ # Demo store for testing
402
- ├── deploy/ # Nginx configs
403
- ├── tests/ # Jest + Supertest test suite
404
- ├── .env # Environment variables
405
- └── package.json
406
- ```
407
-
408
- ---
409
-
410
- ## API Endpoints
411
-
412
- ### Authentication
413
- | Endpoint | Method | Description |
414
- |---|---|---|
415
- | `/api/auth/register` | POST | Create account |
416
- | `/api/auth/login` | POST | Sign in, receive JWT |
417
- | `/api/auth/me` | GET | Get current user |
418
-
419
- ### Sites
420
- | Endpoint | Method | Description |
421
- |---|---|---|
422
- | `/api/sites` | GET | List your sites |
423
- | `/api/sites` | POST | Add a new site |
424
- | `/api/sites/:id` | GET | Get site details |
425
- | `/api/sites/:id/config` | PUT | Update configuration |
426
- | `/api/sites/:id/tier` | PUT | Change subscription tier |
427
- | `/api/sites/:id` | DELETE | Delete a site |
428
- | `/api/sites/:id/snippet` | GET | Get install code snippet |
429
- | `/api/sites/:id/analytics` | GET | Get analytics data |
430
-
431
- ### License (Public)
432
- | Endpoint | Method | Description |
433
- |---|---|---|
434
- | `/api/license/verify` | POST | Verify license key for domain (cached) |
435
- | `/api/license/token` | POST | Exchange `siteId` (Origin must match domain) or `licenseKey` for session token |
436
- | `/api/license/session` | POST | Validate session token (domain-locked) |
437
- | `/api/license/track` | POST | Record analytics (`sessionToken` + Origin) |
438
-
439
- ### Sovereign (v2.0)
440
- | Endpoint | Method | Description |
441
- |---|---|---|
442
- | `/api/sovereign/reputation/agents` | POST | Register a new agent |
443
- | `/api/sovereign/reputation/attestations` | POST | Submit a trust attestation |
444
- | `/api/sovereign/reputation/sites/:siteId` | GET | Get site reputation |
445
- | `/api/sovereign/reputation/leaderboard` | GET | Get reputation leaderboard |
446
- | `/api/sovereign/negotiation/rules` | POST | Create negotiation rule |
447
- | `/api/sovereign/negotiation/rules/:siteId` | GET | Get rules for a site |
448
- | `/api/sovereign/negotiation/sessions` | POST | Open negotiation session |
449
- | `/api/sovereign/negotiation/sessions/:id/propose` | POST | Submit counter-offer |
450
- | `/api/sovereign/negotiation/sessions/:id/confirm` | POST | Confirm a deal |
451
- | `/api/sovereign/verify/price` | POST | Verify price (DOM vs vision) |
452
- | `/api/sovereign/verify/text` | POST | Verify text accuracy |
453
- | `/api/sovereign/verify/page` | POST | Full page verification |
454
- | `/api/sovereign/dashboard/sovereign` | GET | Dashboard aggregate data |
455
-
456
- ### Agent Mesh (v2.3)
457
- | Endpoint | Method | Description |
458
- |---|---|---|
459
- | `/api/mesh/agents` | POST | Register agent in mesh |
460
- | `/api/mesh/agents` | GET | List mesh agents |
461
- | `/api/mesh/channels` | GET | List communication channels |
462
- | `/api/mesh/messages` | POST | Publish message to channel |
463
- | `/api/mesh/messages/:channel` | GET | Get messages from channel |
464
- | `/api/mesh/knowledge` | POST | Share knowledge to mesh |
465
- | `/api/mesh/knowledge` | GET | Query knowledge base |
466
- | `/api/mesh/votes` | POST | Start a vote |
467
- | `/api/mesh/votes/:id/cast` | POST | Cast a vote |
468
- | `/api/mesh/votes/:id/tally` | GET | Get vote results |
469
-
470
- ### Commander (v2.4)
471
- | Endpoint | Method | Description |
472
- |---|---|---|
473
- | `/api/commander/missions` | POST | Create a new mission |
474
- | `/api/commander/missions/:id/launch` | POST | Launch mission execution |
475
- | `/api/commander/missions/:id` | GET | Get mission status |
476
- | `/api/commander/missions` | GET | List all missions |
477
- | `/api/commander/agents` | POST | Register an agent |
478
- | `/api/commander/agents` | GET | List registered agents |
479
- | `/api/commander/edge/nodes` | POST | Register edge node |
480
- | `/api/commander/edge/nodes` | GET | List edge nodes |
481
- | `/api/commander/ai/models` | GET | Discover local AI models |
482
- | `/api/commander/ai/infer` | POST | Run local AI inference |
483
- | `/api/commander/stats` | GET | Unified platform statistics |
484
-
485
- ### Premium v2
486
- | Endpoint | Method | Description |
487
- |---|---|---|
488
- | `/api/premium/v2/memory` | POST | Store agent memory |
489
- | `/api/premium/v2/memory/:agentId` | GET | Recall agent memories |
490
- | `/api/premium/v2/memory/associate` | POST | Create memory association |
491
- | `/api/premium/v2/memory/:id` | DELETE | Forget a memory |
492
- | `/api/premium/v2/memory/consolidate` | POST | Consolidate old memories |
493
- | `/api/premium/v2/vision/analyze` | POST | Analyze screenshot |
494
- | `/api/premium/v2/vision/elements` | POST | Extract interactive elements |
495
- | `/api/premium/v2/healing/corrections` | POST | Register selector correction |
496
- | `/api/premium/v2/healing/resolve` | POST | Resolve broken selector |
497
- | `/api/premium/v2/swarm/execute` | POST | Launch swarm task |
498
- | `/api/premium/v2/swarm/:id` | GET | Get swarm results |
499
- | `/api/premium/v2/plugins` | GET | List available plugins |
500
- | `/api/premium/v2/plugins/:id/install` | POST | Install plugin for site |
501
- | `/api/premium/v2/plugins/:id/hooks` | POST | Execute plugin hook |
502
-
503
- ### Discovery & Fairness
504
- | Endpoint | Method | Description |
505
- |---|---|---|
506
- | `/api/discovery` | GET | WAB discovery document |
507
- | `/api/discovery/search` | GET | Fairness-weighted site search |
508
- | `/api/discovery/register` | POST | Register site in WAB directory |
509
-
510
- ### WAB Protocol (HTTP Transport)
511
- | Endpoint | Method | Description |
512
- |---|---|---|
513
- | `/api/wab/session` | POST | Exchange session token |
514
- | `/api/wab/actions` | GET | Get available actions |
515
- | `/api/wab/execute` | POST | Execute action via HTTP |
516
-
517
- ### NoScript Fallback
518
- | Endpoint | Method | Description |
519
- |---|---|---|
520
- | `/noscript/pixel.gif` | GET | 1×1 tracking pixel for non-JS environments |
521
-
522
- ---
523
-
524
- ## Bridge Script API
525
-
526
- Once loaded, `window.AICommands` exposes:
527
-
528
- | Method | Description |
529
- |---|---|
530
- | `getActions(category?)` | List available actions |
531
- | `getAction(name)` | Get a specific action |
532
- | `execute(name, params?)` | Execute an action |
533
- | `readContent(selector)` | Read element content |
534
- | `getPageInfo()` | Get page and bridge metadata |
535
- | `waitForElement(selector, timeout?)` | Wait for DOM element |
536
- | `waitForNavigation(timeout?)` | Wait for URL change |
537
- | `registerAction(def)` | Register a custom action |
538
- | `authenticate(key, meta?)` | Authenticate an agent |
539
- | `refresh()` | Re-scan the page |
540
- | `onReady(callback)` | Callback when bridge is ready |
541
- | `events.on(event, cb)` | Subscribe to events |
542
-
543
- ---
544
-
545
- ## Configuration
546
-
547
- ```javascript
548
- window.AIBridgeConfig = {
549
- // Recommended — copy siteId from dashboard snippet (no license key in HTML)
550
- siteId: "uuid-from-dashboard",
551
- configEndpoint: "/api/license/token",
552
-
553
- // Legacy: token exchange via license key (avoid embedding in public pages)
554
- // licenseKey: "WAB-...",
555
-
556
- agentPermissions: {
557
- readContent: true, // Read page text
558
- click: true, // Click elements
559
- fillForms: false, // Fill/submit forms
560
- scroll: true, // Scroll page
561
- navigate: false, // Navigate pages
562
- apiAccess: false, // Internal API calls (Pro+)
563
- automatedLogin: false, // Auto login (Starter+)
564
- extractData: false // Data extraction (Pro+)
565
- },
566
- restrictions: {
567
- allowedSelectors: [],
568
- blockedSelectors: [".private", "[data-private]"],
569
- requireLoginForActions: ["apiAccess"],
570
- rateLimit: { maxCallsPerMinute: 60 }
571
- },
572
- logging: { enabled: false, level: "basic" }
573
- };
574
- ```
575
-
576
- ---
577
-
578
- ## Subscription Tiers
579
-
580
- | Feature | Free | Starter | Pro | Enterprise |
581
- |---|:---:|:---:|:---:|:---:|
582
- | Auto-discovery | ✓ | ✓ | ✓ | ✓ |
583
- | Click/Scroll | ✓ | ✓ | ✓ | ✓ |
584
- | Form filling | | ✓ | ✓ | ✓ |
585
- | Basic logging | ✓ | ✓ | ✓ | ✓ |
586
- | Automated login | ✗ | ✓ | ✓ | ✓ |
587
- | Analytics dashboard | ✗ | ✓ | ✓ | ✓ |
588
- | API access | ✗ | ✗ | ✓ | ✓ |
589
- | Data extraction | ✗ | ✗ | ✓ | ✓ |
590
- | Custom rate limits | ✗ | ✗ | ✗ | ✓ |
591
- | Webhooks | ✗ | ✗ | ✗ | ✓ |
592
-
593
- ---
594
-
595
- ## Tech Stack
596
-
597
- - **Backend**: Node.js + Express + WebSocket (ws)
598
- - **Database**: SQLite (via better-sqlite3) with migration runner
599
- - **Auth**: JWT + bcrypt + session tokens (domain-locked)
600
- - **Caching**: In-memory TTL cache + batched analytics queue
601
- - **Payments**: Stripe integration with billing portal
602
- - **Frontend**: Vanilla HTML/CSS/JS (no framework dependencies)
603
- - **Framework Wrappers**: React, Vue 3, Svelte (optional)
604
- - **LLM Integration**: LangChain adapter, MCP adapter
605
- - **Security**: Helmet, CORS, CSP, multi-layer rate limiting
606
- - **Containers**: Docker + Docker Compose
607
- - **CI/CD**: GitHub Actions (test + auto-publish to npm)
608
- - **Testing**: Jest + Supertest
609
-
610
- ---
611
-
612
- ## WebDriver BiDi Compatibility
613
-
614
- WAB exposes a `window.__wab_bidi` interface for agents using standardized WebDriver BiDi protocol:
615
-
616
- ```javascript
617
- // Get BiDi context
618
- const context = window.__wab_bidi.getContext();
619
-
620
- // Send BiDi command
621
- const result = await window.__wab_bidi.send({
622
- id: 1,
623
- method: 'wab.executeAction',
624
- params: { name: 'signup', data: {} }
625
- });
626
-
627
- // Supported methods:
628
- // wab.getContext, wab.getActions, wab.executeAction, wab.readContent, wab.getPageInfo
629
- ```
630
-
631
- ---
632
-
633
- ## Real-Time Analytics (WebSocket)
634
-
635
- Connect to `ws://localhost:3000/ws/analytics` for live analytics. Use the built-in `WABWebSocket` client for automatic reconnection with exponential backoff:
636
-
637
- ```javascript
638
- // Recommended: use the auto-reconnecting client
639
- import { WABWebSocket } from './js/ws-client.js';
640
-
641
- const ws = new WABWebSocket('jwt-token', 'site-id');
642
- ws.on('analytic', (data) => console.log(data));
643
- ws.on('reconnecting', ({ attempt, delay }) => console.log(`Reconnecting #${attempt}...`));
644
- ws.connect();
645
- ```
646
-
647
- ```javascript
648
- // Or connect manually
649
- const ws = new WebSocket('ws://localhost:3000/ws/analytics');
650
- ws.onopen = () => ws.send(JSON.stringify({ type: 'auth', token: 'jwt-token', siteId: 'site-id' }));
651
- ws.onmessage = (e) => console.log(JSON.parse(e.data));
652
- ```
653
-
654
- ### WebSocket Message Protocol
655
-
656
- **Client → Server Messages:**
657
-
658
- | Message | Fields | Description |
659
- |---|---|---|
660
- | `auth` | `type`, `token`, `siteId` | Authenticate and subscribe to a site's events |
661
-
662
- ```json
663
- { "type": "auth", "token": "eyJhbGciOi...", "siteId": "uuid-of-site" }
664
- ```
665
-
666
- **Server → Client Messages:**
667
-
668
- | Message Type | Fields | Description |
669
- |---|---|---|
670
- | `auth:success` | `type`, `siteId` | Authentication succeeded |
671
- | `analytic` | `type`, `timestamp`, `actionName`, `agentId`, `success` | Real-time analytics event |
672
- | `error` | `type`, `message` | Error (invalid auth, malformed message) |
673
-
674
- ```json
675
- // Success response
676
- { "type": "auth:success", "siteId": "uuid-of-site" }
677
-
678
- // Analytics event
679
- {
680
- "type": "analytic",
681
- "timestamp": "2024-01-15T10:30:00.000Z",
682
- "actionName": "click-signup",
683
- "agentId": "agent-123",
684
- "triggerType": "click",
685
- "success": true
686
- }
687
-
688
- // Error
689
- { "type": "error", "message": "Invalid message or auth failed" }
690
- ```
691
-
692
- **Connection Lifecycle:**
693
- 1. Connect to `ws://host:port/ws/analytics`
694
- 2. Send `auth` message with valid JWT and site ID
695
- 3. Receive `auth:success` confirmation
696
- 4. Receive `analytic` events as they occur
697
- 5. Server sends heartbeat pings every 30 seconds — dead connections are cleaned up automatically
698
-
699
- ---
700
-
701
- ## CDN & Versioning
702
-
703
- Scripts are served at versioned URLs for cache-safe deployments:
704
-
705
- | URL | Description |
706
- |---|---|
707
- | `/script/ai-agent-bridge.js` | Default path |
708
- | `/v1/ai-agent-bridge.js` | Version-pinned (recommended) |
709
- | `/latest/ai-agent-bridge.js` | Always latest (use with caution) |
710
-
711
- ---
712
-
713
- ## Docker
714
-
715
- ```bash
716
- # Quick start
717
- docker compose up -d
718
-
719
- # Or build manually
720
- docker build -t web-agent-bridge .
721
- docker run -p 3000:3000 -e JWT_SECRET=your-secret -e JWT_SECRET_ADMIN=your-admin-secret web-agent-bridge
722
- ```
723
-
724
- ---
725
-
726
- ## Testing
727
-
728
- ```bash
729
- npm test
730
- ```
731
-
732
- Tests cover: authentication, site CRUD, config management, license verification, analytics tracking, and static pages.
733
-
734
- ---
735
-
736
- ## Agent SDK
737
-
738
- WAB includes a built-in SDK for building AI agents. See [`sdk/README.md`](sdk/README.md) for full documentation.
739
-
740
- ```javascript
741
- const puppeteer = require('puppeteer');
742
- const { WABAgent } = require('web-agent-bridge/sdk');
743
-
744
- const browser = await puppeteer.launch();
745
- const page = await browser.newPage();
746
- const agent = new WABAgent(page);
747
-
748
- await agent.navigateAndWait('https://example.com');
749
- const actions = await agent.getActions();
750
- await agent.execute('signup', { email: 'user@test.com' });
751
- await browser.close();
752
- ```
753
-
754
- ### SDK Extras
755
-
756
- The SDK now includes additional helpers for advanced agent workflows:
757
-
758
- ```javascript
759
- // Wait for GDPR consent before proceeding
760
- await agent.waitForConsent();
761
-
762
- // Discover all actions + page meta
763
- const disc = await agent.discover();
764
- console.log(disc.actions, disc.meta);
765
-
766
- // Run a sequence of actions (stops on first failure by default)
767
- const results = await agent.runPipeline([
768
- { name: 'login', params: { email: 'a@b.com', pass: 'secret' } },
769
- { name: 'addToCart', params: { sku: 'ABC123' } },
770
- { name: 'checkout' }
771
- ]);
772
-
773
- // Run actions in parallel
774
- const parallel = await agent.executeParallel([
775
- { name: 'getCartCount' },
776
- { name: 'getWishlistCount' }
777
- ]);
778
-
779
- // Capture screenshot (base64) for vision agents
780
- const b64 = await agent.screenshot({ fullPage: true });
781
- ```
782
-
783
- ---
784
-
785
- ## Framework Packages
786
-
787
- ### Vue 3
788
-
789
- ```bash
790
- npm install @web-agent-bridge/vue
791
- ```
792
-
793
- ```javascript
794
- import { useWAB, useWABAction } from '@web-agent-bridge/vue';
795
-
796
- // In setup()
797
- const { ready, execute } = useWAB({ siteUrl: 'https://example.com' });
798
- const cart = useWABAction('addToCart');
799
-
800
- // In template handler
801
- await cart.run({ sku: 'ABC123' });
802
- console.log(cart.result.value);
803
- ```
804
-
805
- ### Svelte
806
-
807
- ```bash
808
- npm install @web-agent-bridge/svelte
809
- ```
810
-
811
- ```svelte
812
- <script>
813
- import { createWAB, createWABAction } from '@web-agent-bridge/svelte';
814
-
815
- const wab = createWAB();
816
- const cart = createWABAction('addToCart');
817
-
818
- async function add() {
819
- await cart.run({ sku: 'ABC123' });
820
- }
821
- </script>
822
-
823
- {#if $cart.loading}Adding...{/if}
824
- {#if $cart.result}Added!{/if}
825
- <button on:click={add}>Add to Cart</button>
826
- ```
827
-
828
- ### LangChain / LangGraph
829
-
830
- ```bash
831
- npm install @web-agent-bridge/langchain
832
- ```
833
-
834
- ```javascript
835
- const { WABToolkit } = require('@web-agent-bridge/langchain');
836
- const { ChatOpenAI } = require('@langchain/openai');
837
- const { AgentExecutor, createOpenAIToolsAgent } = require('langchain/agents');
838
-
839
- // HTTP mode — discover + execute via the WAB server
840
- const toolkit = new WABToolkit({ siteUrl: 'https://shop.example.com' });
841
- const tools = await toolkit.getTools();
842
-
843
- // Browser mode — use with Puppeteer/Playwright
844
- const { WABAgent } = require('web-agent-bridge/sdk');
845
- const toolkit2 = new WABToolkit({ agent: new WABAgent(page) });
846
- const tools2 = await toolkit2.getTools();
847
-
848
- // Pass tools to any LangChain agent
849
- const llm = new ChatOpenAI({ model: 'gpt-4o' });
850
- const agent = await createOpenAIToolsAgent({ llm, tools, prompt });
851
- const executor = new AgentExecutor({ agent, tools });
852
- await executor.invoke({ input: 'Add the first product to my cart' });
853
- ```
854
-
855
- ---
856
-
857
- ## GDPR / CCPA Consent
858
-
859
- Load the consent script after `wab.min.js` to gate agent actions behind user consent:
860
-
861
- ```html
862
- <script src="/script/wab.min.js"></script>
863
- <script src="/script/wab-consent.js"></script>
864
- <script>
865
- WABConsent.showBanner({
866
- policyUrl: '/privacy',
867
- message: 'Allow AI agents to interact with this page?',
868
- onAccept: () => WAB.init({ siteUrl: location.origin }),
869
- onDecline: () => console.log('Agent access declined')
870
- });
871
- </script>
872
- ```
873
-
874
- SDK agents can check consent programmatically:
875
-
876
- ```javascript
877
- const agent = new WABAgent(page);
878
- const ok = await agent.hasConsent(); // true | false
879
- await agent.waitForConsent(); // blocks until Allow is clicked
880
- ```
881
-
882
- ---
883
-
884
- ## Agent Examples
885
-
886
- Ready-to-run agent examples in the [`examples/`](examples/) directory:
887
-
888
- | File | Description |
889
- |---|---|
890
- | `puppeteer-agent.js` | Basic agent using Puppeteer + `window.AICommands` |
891
- | `bidi-agent.js` | Agent using WebDriver BiDi protocol via `window.__wab_bidi` |
892
- | `vision-agent.js` | Vision/NLP agent resolves natural language intents to actions using a local keyword-based resolver (no external API) |
893
- | `mcp-agent.js` | MCP adapter usage for Claude and GPT with tool discovery and execution |
894
- | `cross-site-agent.js` | Multi-domain orchestration compare prices across stores, aggregate data, find best deals |
895
-
896
- ## Framework + CMS Examples
897
-
898
- Additional integration examples are available in:
899
-
900
- | Path | Description |
901
- |---|---|
902
- | `examples/next-app-router/` | Next.js App Router integration with `@web-agent-bridge/react` |
903
- | `examples/shopify-hydrogen/` | Hydrogen storefront integration with practical cart actions |
904
- | `examples/wordpress-elementor/` | WordPress + Elementor setup with schema-assisted actions |
905
- | `examples/saas-dashboard/` | Notion-style SaaS dashboard actions for KPI read + workflow triggers |
906
-
907
- ```bash
908
- node examples/puppeteer-agent.js http://localhost:3000
909
- node examples/bidi-agent.js http://localhost:3000
910
- node examples/vision-agent.js http://localhost:3000
911
- ```
912
-
913
- ---
914
-
915
- ## Multi-Database Support
916
-
917
- WAB defaults to SQLite but supports PostgreSQL and MySQL via database adapters.
918
-
919
- ```bash
920
- # SQLite (default — no setup needed)
921
- npm start
922
-
923
- # PostgreSQL
924
- npm install pg
925
- DB_ADAPTER=postgresql DATABASE_URL=postgres://user:pass@localhost:5432/wab npm start
926
-
927
- # MySQL
928
- npm install mysql2
929
- DB_ADAPTER=mysql DATABASE_URL=mysql://user:pass@localhost:3306/wab npm start
930
- ```
931
-
932
- ### When to Choose Which Database
933
-
934
- | Scenario | Recommended DB | Why |
935
- |---|---|---|
936
- | Local dev / prototyping | SQLite | Zero setup, single file, instant |
937
- | Small production (< 100 sites) | SQLite | Fast, no external dependencies |
938
- | Medium production (100-10K sites) | PostgreSQL | Better concurrency, JSONB support |
939
- | Large / enterprise production | PostgreSQL | Replication, backups, scalability |
940
- | Existing MySQL infrastructure | MySQL | Integrate with what you already use |
941
-
942
- See [`server/models/adapters/`](server/models/adapters/) for adapter implementations.
943
-
944
- ---
945
-
946
- ## Security Architecture
947
-
948
- WAB implements defense-in-depth to protect the bridge from misuse:
949
-
950
- ### Secure License Exchange
951
-
952
- 1. **Dashboard snippet (recommended):** `siteId` + `configEndpoint`. The browser sends `POST /api/license/token` with `{ siteId }`; the server checks **Origin** against the site’s registered domain and issues a session token.
953
- 2. **Legacy:** `licenseKey` + `configEndpoint` (or deprecated `_licenseKey`) still works for token exchange but should not be embedded in public HTML.
954
- 3. **Session** is domain-locked (1h TTL); **analytics** use `sessionToken` on `POST /api/license/track` (not the license key).
955
- 4. **WebSocket** `/ws/analytics`: user JWT must **own** the `siteId`; admin JWT may observe any site.
956
-
957
- ```
958
- Client Server
959
- │── POST /api/license/token ──→│ { siteId } + Origin header
960
- │ │ domain match sessionToken
961
- │←── { sessionToken, tier } ──│
962
- │── POST /api/license/track ─→│ { sessionToken, actionName } + Origin
963
- ```
964
-
965
- **Production:** set `JWT_SECRET`, `JWT_SECRET_ADMIN`, `STRIPE_WEBHOOK_SECRET`, `ALLOWED_ORIGINS`, and create the first admin via `BOOTSTRAP_ADMIN_*` or `node scripts/create-admin.js`.
966
-
967
- ### Security Sandbox
968
-
969
- Every bridge instance runs inside a `SecuritySandbox` that provides:
970
-
971
- - **Session tokens** — Unique cryptographic token per session prevents replay attacks
972
- - **Origin validation** Only whitelisted origins can interact with the bridge
973
- - **Command validation** — All commands are validated for format, length, and blocklist
974
- - **Audit logging** — Every action is logged with timestamp, agent fingerprint, and status
975
- - **Escalation protection**Attempts to access higher-tier features trigger automatic lockdown after 5 violations
976
- - **Auto-lockdown** — Bridge becomes read-only when security violations are detected
977
-
978
- ```javascript
979
- // Get security status
980
- const info = bridge.getPageInfo();
981
- console.log(info.security);
982
- // { sandboxActive: true, locked: false, sessionToken: "a3f2..." }
983
-
984
- // View audit log
985
- const audit = bridge.security.getAuditLog(20);
986
- ```
987
-
988
- ### Selector Restrictions
989
-
990
- Block sensitive page sections from agent access:
991
-
992
- ```javascript
993
- window.AIBridgeConfig = {
994
- restrictions: {
995
- blockedSelectors: [".private", "[data-private]", "#payment-form"],
996
- allowedSelectors: [".public-content"]
997
- }
998
- };
999
- ```
1000
-
1001
- ---
1002
-
1003
- ## Self-Healing Selectors
1004
-
1005
- Modern SPAs frequently change their DOM structure. WAB's self-healing system ensures selectors keep working even when the page changes:
1006
-
1007
- ### How It Works
1008
-
1009
- 1. **Fingerprinting** When actions are discovered, WAB stores a rich fingerprint of each element (tag, id, classes, text, ARIA attributes, position)
1010
- 2. **7-Strategy Resolution** When a selector breaks, WAB tries these strategies in order:
1011
- - `data-wab-id` attribute (most stable — add to your HTML)
1012
- - `data-testid` attribute
1013
- - Element ID
1014
- - `aria-label` (semantic, usually survives redesigns)
1015
- - `name` attribute
1016
- - Fuzzy text matching (bigram similarity > 70%)
1017
- - Role + position heuristic
1018
- 3. **SPA Observer** — A `MutationObserver` watches for DOM changes and automatically re-discovers actions with a 500ms debounce
1019
-
1020
- ```javascript
1021
- // Check healing stats
1022
- const info = bridge.getPageInfo();
1023
- console.log(info.selfHealing);
1024
- // { tracked: 12, healed: 3, failed: 0 }
1025
-
1026
- // Listen for healing events
1027
- bridge.events.on('selector:healed', (data) => {
1028
- console.log(`Healed: ${data.action} via ${data.strategy}`);
1029
- });
1030
- ```
1031
-
1032
- ### Best Practices for Site Owners
1033
-
1034
- Add `data-wab-id` attributes to critical elements for maximum stability:
1035
-
1036
- ```html
1037
- <button data-wab-id="signup-btn">Sign Up</button>
1038
- <form data-wab-id="login-form">...</form>
1039
- ```
1040
-
1041
- ---
1042
-
1043
- ## Stealth Mode
1044
-
1045
- For sites with anti-bot protection, WAB can simulate human-like interaction patterns. **Stealth mode requires explicit consent** to ensure ethical use.
1046
-
1047
- ```javascript
1048
- window.AIBridgeConfig = {
1049
- stealth: {
1050
- enabled: true,
1051
- consent: true // Required — confirms site owner authorizes human-like patterns
1052
- }
1053
- };
1054
- ```
1055
-
1056
- > **⚠️ Ethical Use Policy:** Stealth mode is designed for accessibility and testing on your own websites. Using it to bypass security controls on sites you do not own may violate terms of service and applicable laws.
1057
-
1058
- When enabled, all interactions use:
1059
-
1060
- | Feature | Description |
1061
- |---|---|
1062
- | **Mouse event chain** | `mouseover → mouseenter → mousemove → mousedown → mouseup → click` with natural coordinates |
1063
- | **Typing simulation** | Character-by-character input with 30-120ms delays per keystroke |
1064
- | **Scroll easing** | Multi-step scrolling with variable speed |
1065
- | **Random delays** | 50-400ms natural pauses between actions |
1066
-
1067
- ```javascript
1068
- // Enable/disable at runtime (consent required)
1069
- bridge.stealth.enable(true); // true = consent granted
1070
- bridge.stealth.disable();
1071
- ```
1072
-
1073
- ---
1074
-
1075
- ## CLI
1076
-
1077
- Install globally or use via npx:
1078
-
1079
- ```bash
1080
- # Run the server
1081
- npx web-agent-bridge start
1082
- npx web-agent-bridge start --port 8080
1083
-
1084
- # Initialize a new project
1085
- npx web-agent-bridge init
1086
- ```
1087
-
1088
- ---
1089
-
1090
- ## Environment Variables
1091
-
1092
- See `.env.example`. Important:
1093
-
1094
- ```
1095
- PORT=3000
1096
- NODE_ENV=development
1097
- JWT_SECRET=long-random-user-signing-secret
1098
- JWT_SECRET_ADMIN=long-random-admin-signing-secret # required in production
1099
- ALLOWED_ORIGINS=http://localhost:3000,https://your-app.com
1100
- STRIPE_WEBHOOK_SECRET=whsec_... # Stripe webhook verify
1101
- CREDENTIALS_ENCRYPTION_KEY=... # optional SMTP password encryption
1102
- DB_ADAPTER=sqlite
1103
- DATABASE_URL=
1104
- ```
1105
-
1106
- First admin: set `BOOTSTRAP_ADMIN_EMAIL` / `BOOTSTRAP_ADMIN_PASSWORD` when the `admins` table is empty, or run `node scripts/create-admin.js <email> <password>`.
1107
-
1108
- ---
1109
-
1110
- ## Real-time Negotiation Engine
1111
-
1112
- Site owners define negotiation rules. AI agents negotiate prices in multi-round sessions:
1113
-
1114
- ```javascript
1115
- // Agent opens a negotiation session
1116
- const session = await fetch('/api/sovereign/negotiation/sessions', {
1117
- method: 'POST',
1118
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1119
- body: JSON.stringify({
1120
- siteId: 'site-uuid',
1121
- agentId: 'agent-id',
1122
- originalPrice: 49.99,
1123
- itemId: 'product-123',
1124
- itemName: 'Olive Oil 1L'
1125
- })
1126
- }).then(r => r.json());
1127
-
1128
- // Agent makes a counter-offer
1129
- const counter = await fetch(`/api/sovereign/negotiation/sessions/${session.sessionId}/propose`, {
1130
- method: 'POST',
1131
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1132
- body: JSON.stringify({
1133
- agentId: 'agent-id',
1134
- proposedPrice: 39.99
1135
- })
1136
- }).then(r => r.json());
1137
- // { status: 'accepted', finalPrice: 42.49, message: 'Deal! ...' }
1138
- ```
1139
-
1140
- ### Condition Types
1141
- | Condition | Description |
1142
- |---|---|
1143
- | `bulk_quantity` | Discounts based on order quantity |
1144
- | `loyalty` | Rewards for repeat customers |
1145
- | `time_based` | Happy hour / flash sale windows |
1146
- | `first_purchase` | Welcome discount for new buyers |
1147
- | `cart_value` | Minimum cart value threshold |
1148
- | `seasonal` | Date-range seasonal promotions |
1149
- | `membership` | Member-only pricing |
1150
- | `referral` | Referral-based discounts |
1151
-
1152
- ---
1153
-
1154
- ## Anti-Hallucination Shield
1155
-
1156
- Cross-verification engine that catches AI hallucinations before they reach users:
1157
-
1158
- ```javascript
1159
- // Verify a price
1160
- const result = await fetch('/api/sovereign/verify/price', {
1161
- method: 'POST',
1162
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1163
- body: JSON.stringify({
1164
- siteId: 'site-uuid',
1165
- domValue: 29.99,
1166
- visionValue: 29.99,
1167
- category: 'electronics',
1168
- itemName: 'USB Cable'
1169
- })
1170
- }).then(r => r.json());
1171
- // { verified: true, confidence: 0.98, severity: 'none', layers: { dom_vision: { match: true }, ... } }
1172
-
1173
- // Verify text content
1174
- const textResult = await fetch('/api/sovereign/verify/text', {
1175
- method: 'POST',
1176
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1177
- body: JSON.stringify({
1178
- siteId: 'site-uuid',
1179
- source: 'dom',
1180
- value: 'Free shipping on orders over $50',
1181
- expected: 'Free shipping on orders over $50'
1182
- })
1183
- }).then(r => r.json());
1184
- // { verified: true, similarity: 1.0 }
1185
- ```
1186
-
1187
- ### Verification Layers
1188
- 1. **DOM vs Vision** — Compares DOM-extracted price with screenshot OCR value
1189
- 2. **Market Benchmark** — Validates against historical price benchmarks for the category
1190
- 3. **Temporal Consistency** — Checks if price changed suspiciously since last verification
1191
- 4. **Composite Score** — Weighted combination of all layers with severity classification
1192
-
1193
- ---
1194
-
1195
- ## Community Agent Hub
1196
-
1197
- Pre-built YAML agent templates for common use cases. Run any template from the CLI:
1198
-
1199
- ```bash
1200
- # List available templates
1201
- npx wab-agent templates
1202
-
1203
- # Run a template
1204
- npx wab-agent run olive-oil-tunisia --budget 50 --region tunis
1205
-
1206
- # Run with custom server
1207
- npx wab-agent run hotel-direct-booking --server https://yourserver.com --checkin 2025-01-15
1208
- ```
1209
-
1210
- ### Available Templates
1211
- | Template | Description |
1212
- |---|---|
1213
- | `olive-oil-tunisia` | Find olive oil from small Tunisian farms |
1214
- | `hotel-direct-booking` | Book hotels directly, bypass aggregators |
1215
- | `artisan-marketplace` | Handmade products from independent artisans |
1216
- | `grocery-price-compare` | Compare grocery prices across local stores |
1217
- | `freelancer-direct` | Find freelancers without platform fees |
1218
- | `restaurant-direct` | Order from restaurants without delivery apps |
1219
- | `book-price-scout` | Find books from indie bookstores |
1220
- | `flight-deal-hunter` | Find flights direct from airlines |
1221
- | `electronics-price-tracker` | Track electronics prices with history |
1222
- | `local-services` | Find local service providers |
1223
- | `organic-farm-fresh` | Organic produce direct from farms |
1224
-
1225
- ### Create Your Own Template
1226
-
1227
- ```yaml
1228
- name: my-custom-agent
1229
- description: My custom agent template
1230
- goal: Find the best deals on custom products
1231
- version: "1.0"
1232
- target_sites:
1233
- - https://example.com
1234
- parameters:
1235
- budget:
1236
- type: number
1237
- default: 100
1238
- description: Maximum budget
1239
- actions:
1240
- - name: discover
1241
- wab_action: discover
1242
- - name: search
1243
- wab_action: execute
1244
- action_name: search
1245
- params:
1246
- query: "{{keyword}}"
1247
- - name: negotiate
1248
- wab_action: negotiate
1249
- params:
1250
- item_id: "{{item_id}}"
1251
- max_price: "{{budget}}"
1252
- negotiation:
1253
- enabled: true
1254
- max_rounds: 3
1255
- accept_threshold: 0.85
1256
- fairness_rules:
1257
- - Prefer independent sellers over large platforms
1258
- - Verify all prices before purchase
1259
- ```
1260
-
1261
- ---
1262
-
1263
- ## Commander Agent System
1264
-
1265
- The Commander is a local-first mission orchestration engine that decomposes high-level goals into task DAGs and distributes work across specialized agents:
1266
-
1267
- ```javascript
1268
- // Create a mission
1269
- const mission = await fetch('/api/commander/missions', {
1270
- method: 'POST',
1271
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1272
- body: JSON.stringify({
1273
- goal: 'Find the cheapest olive oil across 5 stores',
1274
- strategy: 'parallel',
1275
- agents: ['researcher-1', 'analyst-1', 'negotiator-1']
1276
- })
1277
- }).then(r => r.json());
1278
-
1279
- // Launch mission
1280
- await fetch(`/api/commander/missions/${mission.id}/launch`, { method: 'POST', headers: { 'Authorization': 'Bearer ' + token } });
1281
-
1282
- // Check status
1283
- const status = await fetch(`/api/commander/missions/${mission.id}`, { headers: { 'Authorization': 'Bearer ' + token } }).then(r => r.json());
1284
- // → { status: 'completed', tasks: [...], result: { bestPrice: 12.99, store: 'farm-direct' } }
1285
- ```
1286
-
1287
- ### Commander Capabilities
1288
- | Feature | Description |
1289
- |---|---|
1290
- | **Mission Decomposition** | Breaks high-level goals into task DAGs with dependency tracking |
1291
- | **Agent Registry** | Tracks agent capabilities, availability, and performance history |
1292
- | **Parallel Execution** | Runs independent tasks concurrently across multiple agents |
1293
- | **Learning Integration** | Records outcomes for reinforcement learning feedback |
1294
- | **Edge Coordination** | Distributes compute-heavy tasks to edge nodes |
1295
-
1296
- ---
1297
-
1298
- ## Edge Compute System
1299
-
1300
- Transform every user device into a sovereign AI node — no central cloud required:
1301
-
1302
- ```javascript
1303
- // Register a device as an edge node
1304
- const node = await fetch('/api/commander/edge/nodes', {
1305
- method: 'POST',
1306
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1307
- body: JSON.stringify({
1308
- name: 'my-laptop',
1309
- capabilities: { cpu: 8, ram: 16384, gpu: true },
1310
- supportedTasks: ['text-inference', 'vision-analysis', 'price-comparison']
1311
- })
1312
- }).then(r => r.json());
1313
-
1314
- // List available edge nodes
1315
- const nodes = await fetch('/api/commander/edge/nodes', { headers: { 'Authorization': 'Bearer ' + token } }).then(r => r.json());
1316
- ```
1317
-
1318
- | Feature | Description |
1319
- |---|---|
1320
- | **Hardware Profiling** | Detects CPU, RAM, GPU capabilities per node |
1321
- | **AES-256-GCM Encryption** | All inter-node data is encrypted end-to-end |
1322
- | **Weighted Load Balancing** | Routes tasks based on hardware + availability scores |
1323
- | **Heartbeat Health Monitoring** | Auto-failover when nodes become unresponsive |
1324
- | **Swarm Formation** | Capability-based clustering of nodes for distributed tasks |
1325
-
1326
- ---
1327
-
1328
- ## Swarm Execution Engine
1329
-
1330
- Launch multiple agents in parallel to solve a single task, then intelligently merge their outputs:
1331
-
1332
- ```javascript
1333
- // Launch a swarm task
1334
- const swarm = await fetch('/api/premium/v2/swarm/execute', {
1335
- method: 'POST',
1336
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1337
- body: JSON.stringify({
1338
- task: 'Find best laptop deals under $1000',
1339
- strategy: 'parallel', // parallel | sequential | hybrid
1340
- agentCount: 4,
1341
- roles: ['researcher', 'analyst', 'price-checker', 'reviewer'],
1342
- mergeStrategy: 'best-score' // best-score | fairness-weighted | consensus
1343
- })
1344
- }).then(r => r.json());
1345
- // { swarmId: '...', agents: 4, status: 'running' }
1346
-
1347
- // Get merged results
1348
- const results = await fetch(`/api/premium/v2/swarm/${swarm.swarmId}`, {
1349
- headers: { 'Authorization': 'Bearer ' + token }
1350
- }).then(r => r.json());
1351
- // → { status: 'completed', merged: { bestDeal: {...}, confidence: 0.94 } }
1352
- ```
1353
-
1354
- ---
1355
-
1356
- ## Fairness Engine
1357
-
1358
- A neutrality layer ensuring AI agents give equal opportunity to small and large sites, preventing monopolistic concentration of agent traffic:
1359
-
1360
- ```javascript
1361
- // Fairness-weighted search (instead of pure relevance)
1362
- const results = await fetch('/api/discovery/search?q=olive+oil&fairness=true', {
1363
- headers: { 'Authorization': 'Bearer ' + token }
1364
- }).then(r => r.json());
1365
- // Small farms ranked alongside Amazon — weighted by neutrality score, not just SEO
1366
-
1367
- // Register site in WAB directory
1368
- await fetch('/api/discovery/register', {
1369
- method: 'POST',
1370
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1371
- body: JSON.stringify({
1372
- domain: 'small-farm.example.com',
1373
- category: 'food',
1374
- commissionRate: 0, // Direct — no middleman
1375
- independentSeller: true
1376
- })
1377
- }).then(r => r.json());
1378
- ```
1379
-
1380
- ### How Neutrality Scoring Works
1381
- | Factor | Weight | Description |
1382
- |---|---|---|
1383
- | **Configuration completeness** | 25% | How well the site has configured WAB |
1384
- | **Trust score** | 25% | Reputation attestations from the agent network |
1385
- | **Transparency** | 25% | Commission disclosure, pricing clarity |
1386
- | **Responsiveness** | 25% | API response time, uptime, action success rate |
1387
-
1388
- Small independent sites with good WAB configuration can outrank large platforms on fairness-weighted searches.
1389
-
1390
- ---
1391
-
1392
- ## Agent Memory System
1393
-
1394
- Persistent behavioral memory allowing agents to remember user preferences, learn patterns, and build associations:
1395
-
1396
- ```javascript
1397
- // Store a memory
1398
- await fetch('/api/premium/v2/memory', {
1399
- method: 'POST',
1400
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1401
- body: JSON.stringify({
1402
- agentId: 'agent-1',
1403
- type: 'preference', // preference | interaction | correction | pattern
1404
- category: 'purchase', // navigation | purchase | search | form | custom
1405
- key: 'preferred-brand',
1406
- value: 'organic-only',
1407
- importance: 0.9
1408
- })
1409
- }).then(r => r.json());
1410
-
1411
- // Recall memories
1412
- const memories = await fetch('/api/premium/v2/memory/agent-1?category=purchase&limit=10', {
1413
- headers: { 'Authorization': 'Bearer ' + token }
1414
- }).then(r => r.json());
1415
-
1416
- // Create associations
1417
- await fetch('/api/premium/v2/memory/associate', {
1418
- method: 'POST',
1419
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1420
- body: JSON.stringify({
1421
- sourceId: 'memory-1',
1422
- targetId: 'memory-2',
1423
- relationship: 'leads_to' // leads_to | similar_to | replaces | depends_on
1424
- })
1425
- }).then(r => r.json());
1426
- ```
1427
-
1428
- ---
1429
-
1430
- ## Vision Analysis Service
1431
-
1432
- Multi-provider screenshot analysis for interactive element detection and data extraction:
1433
-
1434
- ```javascript
1435
- // Analyze a screenshot
1436
- const analysis = await fetch('/api/premium/v2/vision/analyze', {
1437
- method: 'POST',
1438
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1439
- body: JSON.stringify({
1440
- screenshot: 'base64-encoded-image...',
1441
- provider: 'auto', // auto | local | openai | anthropic | ollama
1442
- extractElements: true
1443
- })
1444
- }).then(r => r.json());
1445
- // → { elements: [{ type: 'button', text: 'Add to Cart', selector: '#add-btn', confidence: 0.95, bbox: [120, 340, 200, 40] }] }
1446
-
1447
- // Extract interactive elements only
1448
- const elements = await fetch('/api/premium/v2/vision/elements', {
1449
- method: 'POST',
1450
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1451
- body: JSON.stringify({ screenshot: 'base64...', types: ['button', 'input', 'link'] })
1452
- }).then(r => r.json());
1453
- ```
1454
-
1455
- ### Supported Vision Providers
1456
- | Provider | Local? | Description |
1457
- |---|---|---|
1458
- | **Moondream** | | Lightweight local vision model |
1459
- | **Ollama** | | Local models via Ollama (llava, bakllava) |
1460
- | **OpenAI** | ❌ | GPT-4 Vision |
1461
- | **Anthropic** | ❌ | Claude Vision |
1462
-
1463
- ---
1464
-
1465
- ## Plugin Architecture
1466
-
1467
- Dynamic plugin system allowing third-party extensions:
1468
-
1469
- ```javascript
1470
- // List available plugins
1471
- const plugins = await fetch('/api/premium/v2/plugins', {
1472
- headers: { 'Authorization': 'Bearer ' + token }
1473
- }).then(r => r.json());
1474
-
1475
- // Install a plugin for your site
1476
- await fetch('/api/premium/v2/plugins/price-alert/install', {
1477
- method: 'POST',
1478
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1479
- body: JSON.stringify({ siteId: 'site-uuid', config: { threshold: 10 } })
1480
- }).then(r => r.json());
1481
-
1482
- // Execute a plugin hook
1483
- await fetch('/api/premium/v2/plugins/price-alert/hooks', {
1484
- method: 'POST',
1485
- headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1486
- body: JSON.stringify({ hook: 'onPriceChange', data: { oldPrice: 49.99, newPrice: 39.99 } })
1487
- }).then(r => r.json());
1488
- ```
1489
-
1490
- ---
1491
-
1492
- ## Premium Traffic Intelligence
1493
-
1494
- Advanced bot detection and traffic profiling for premium sites:
1495
-
1496
- | Capability | Description |
1497
- |---|---|
1498
- | **30+ Bot Types** | Detects Google, Bing, ChatGPT, Claude, Perplexity, and more |
1499
- | **Behavioral Profiling** | Classifies agent behavior by signature, platform, and type |
1500
- | **Anomaly Detection** | Spike detection and pattern analysis for unusual traffic |
1501
- | **Security Exploit Detection** | Flags SQL injection, XSS patterns, and rate anomalies |
1502
- | **Webhook Alerting** | Triggers webhooks on suspicious activity |
1503
- | **Compliance Audit Logging** | Full audit trail for regulatory compliance |
1504
-
1505
- ---
1506
-
1507
- ## WAB-MCP Adapter
1508
-
1509
- Expose WAB site capabilities as [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) tools for Claude, GPT, Gemini, and other MCP-compatible AI agents:
1510
-
1511
- ```javascript
1512
- const { WABMCPAdapter } = require('wab-mcp-adapter');
1513
-
1514
- // Create adapter for a WAB-enabled site
1515
- const adapter = new WABMCPAdapter({
1516
- siteUrl: 'https://shop.example.com',
1517
- transport: 'http' // http | websocket | direct
1518
- });
1519
-
1520
- // Get MCP tool definitions
1521
- const tools = await adapter.getTools();
1522
- // [{ name: 'discover', description: '...', inputSchema: {...} }, ...]
1523
-
1524
- // Execute via MCP
1525
- const result = await adapter.executeTool('execute_action', {
1526
- name: 'addToCart',
1527
- params: { sku: 'ABC123' }
1528
- });
1529
- ```
1530
-
1531
- ### Built-in MCP Tools
1532
- | Tool | Description |
1533
- |---|---|
1534
- | `discover` | Auto-discover available actions on a WAB site |
1535
- | `get_actions` | Get list of all actions with parameters |
1536
- | `execute_action` | Execute a specific action |
1537
- | `read_content` | Read content from the page |
1538
- | `get_page_info` | Get page metadata |
1539
- | `fairness_search` | Search the WAB directory with fairness weighting |
1540
- | `authenticate` | Authenticate an agent with the site |
1541
-
1542
- ---
1543
-
1544
- ## WAB Browser (Desktop)
1545
-
1546
- Standalone Electron desktop browser with built-in privacy and fairness features:
1547
-
1548
- - **Ad Blocker** — 80+ blocked ad domains + URL pattern matching + cosmetic CSS rules
1549
- - **Scam Shield** Detects suspicious TLDs and brand-name spoofing in URLs
1550
- - **Fairness Ranking** — Prioritizes independent sites, flags big-tech concentration
1551
- - **Agent Chat** Built-in AI assistant panel for browsing help
1552
- - **Notifications** — Page analysis with safety and fairness alerts
1553
- - **Ghost Mode** Privacy-first browsing with no tracking
1554
- - **Smart Search** WAB Search integration for independent search
1555
- - **Desktop/Mobile Toggle** Switch user-agent for responsive testing
1556
-
1557
- ```bash
1558
- # Run the WAB Browser
1559
- cd wab-browser
1560
- npm install
1561
- npx electron .
1562
-
1563
- # Build installer (Windows NSIS)
1564
- npm run build:win
1565
- ```
1566
-
1567
- ---
1568
-
1569
- ## PWA Browser (Mobile)
1570
-
1571
- Progressive Web App browser for Android and iOS — installable from any mobile browser:
1572
-
1573
- - **Ad Blocker** — 80+ ad domain blacklist + URL pattern matching
1574
- - **Scam Detection** — Suspicious TLD alerts and brand-name spoofing checks
1575
- - **Fairness Mode** Filters big-tech sites to promote independent alternatives
1576
- - **Offline-First** Service worker caches shell assets for offline launch
1577
- - **WAB Search** Independent search engine with multi-source aggregation, autocomplete, and trending
1578
- - **AI Agent Chat** — Real AI agent (OpenAI / local Ollama / smart fallback) with conversation memory, web search, and security analysis
1579
-
1580
- Install at: `https://yourserver.com/pwa/`
1581
-
1582
- ---
1583
-
1584
- ## WordPress Plugin
1585
-
1586
- Native WordPress plugin for adding WAB support to any WordPress site:
1587
-
1588
- ```bash
1589
- # Install
1590
- cp -r web-agent-bridge-wordpress/ /wp-content/plugins/web-agent-bridge/
1591
- ```
1592
-
1593
- | Feature | Description |
1594
- |---|---|
1595
- | **Settings Page** | Configure API base URL, site ID, permissions |
1596
- | **Per-Page Actions** | Meta box for adding custom WAB actions per page/post |
1597
- | **Discovery Document** | Auto-generates WAB discovery endpoint |
1598
- | **Dashboard Widget** | Shows WAB status and agent interaction stats |
1599
- | **Shortcode** | `[wab_bridge]` shortcode for embedding WAB on specific pages |
1600
- | **Hooks API** | `wab_before_action` / `wab_after_action` for custom logic |
1601
-
1602
- See [`web-agent-bridge-wordpress/README.md`](web-agent-bridge-wordpress/README.md) for full documentation.
1603
-
1604
- ---
1605
-
1606
- ## WAB Protocol Specification
1607
-
1608
- The full normative specification is available at [`docs/SPEC.md`](docs/SPEC.md):
1609
-
1610
- | Layer | Description |
1611
- |---|---|
1612
- | **Protocol Layer** | Discovery document format, command protocol, fairness protocol |
1613
- | **Runtime Layer** | `window.AICommands` interface, auto-discovery engine, security sandbox |
1614
- | **Transport Layer** | JavaScript global, WebSocket, HTTP, WebDriver BiDi, MCP |
1615
-
1616
- ### 5-Phase Lifecycle
1617
- 1. **Discover** — Agent finds WAB discovery document (`.well-known/wab.json` or script tag)
1618
- 2. **Authenticate** Agent exchanges `siteId` for session token
1619
- 3. **Plan** — Agent reads available actions and page metadata
1620
- 4. **Execute** — Agent runs actions through the bridge
1621
- 5. **Confirm** — Results are verified via Anti-Hallucination Shield
1622
-
1623
- ---
1624
-
1625
- ## License
1626
-
1627
- WAB uses an **Open Core** dual-license model:
1628
-
1629
- | Layer | License | Components |
1630
- |-------|---------|------------|
1631
- | **Open Source** | MIT | SDK, Widget, MCP Server, Trust Protocol Spec, Browser Extension, Protocol module, Public module APIs |
1632
- | **Proprietary** | Closed | Detection Engine, Threat DB, WAB Score Model, Fairness Algorithm, Neural Engine, Dark Pattern Engine, Gov Engine, Notary Engine, Firewall Engine, Price Engine, Bargaining Engine, Bounty Verification, Affiliate DB |
1633
- | **Commercial** | Paid API | API Gateway modules (Free/Pro/Business/Enterprise tiers), Data Marketplace, AI Safety Layer, Enterprise SDK |
1634
-
1635
- See [LICENSE](LICENSE) for full details.
1
+ # Web Agent Bridge (WAB)
2
+
3
+ [![npm](https://img.shields.io/npm/v/web-agent-bridge)](https://www.npmjs.com/package/web-agent-bridge)
4
+ [![npm downloads](https://img.shields.io/npm/dm/web-agent-bridge?label=npm%20downloads&color=red)](https://www.npmjs.com/package/web-agent-bridge)
5
+ [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
6
+ [![CI](https://github.com/abokenan444/web-agent-bridge/actions/workflows/ci.yml/badge.svg)](https://github.com/abokenan444/web-agent-bridge/actions/workflows/ci.yml)
7
+ [![License: Open Core](https://img.shields.io/badge/License-Open_Core-blue.svg)](LICENSE)
8
+ [![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg)](https://nodejs.org/)
9
+ [![Docker](https://img.shields.io/badge/docker-ready-blue.svg)](https://hub.docker.com/)
10
+ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
11
+ [![Discord](https://img.shields.io/badge/Discord-Join%20Community-5865F2?logo=discord&logoColor=white)](https://discord.gg/NnbpJYEF)
12
+
13
+ > **robots.txt told bots what NOT to do. WAB tells AI agents what they CAN do.**
14
+
15
+ 🌐 **Live Website:** [https://webagentbridge.com](https://webagentbridge.com) — Try the Agent Workspace, dashboards, and many more features live.
16
+
17
+ **English** | **[العربية](README.ar.md)**
18
+
19
+ WAB is **the open AI↔Web protocol and agent platform**. What started as a small middleware script has grown into a full stack: a standardized `window.AICommands` interface (like **OpenAPI for human-facing pages**), a sovereign desktop browser, a phone-shield communication layer, DNS-level discovery, an agent mesh, a multi-module API gateway, and SDKs for React/Vue/Svelte/LangChain. Website owners control what AI can do; agents discover capabilities, execute commands, and interact with sites accurately — no DOM parsing, no scraping, no guesswork.
20
+
21
+ ### Three Paths to WAB
22
+
23
+ | Path | For | How |
24
+ |---|---|---|
25
+ | **🏢 Website Owner** | Control how AI interacts with your site | Embed the script, configure permissions |
26
+ | **🤖 Agent Developer** | Build reliable agents that work on any WAB-enabled site | Use `window.AICommands` or the Agent SDK |
27
+ | **🔧 Self-Hosting** | Run the full WAB platform for your organization | Clone, deploy, manage licenses & analytics |
28
+ | **WordPress** | Sites powered by WP | Use the **[Web Agent Bridge WordPress plugin](web-agent-bridge-wordpress/README.md)** (settings, shortcode, per-page disable, hooks) |
29
+
30
+ ---
31
+
32
+ ## Features
33
+
34
+ - **Auto-Discovery** — Automatically detects buttons, forms, and navigation on the page
35
+ - **Structured Auto-Discovery** — Detects schema.org JSON-LD + microdata products/offers and exposes read actions
36
+ - **Commerce + Booking Intents** — Detects common actions like add-to-cart, checkout, and booking/reservation flows
37
+ - **Permission System** — Granular control over what AI agents can do (click, fill forms, API access, etc.)
38
+ - **Standardized Interface** — Unified `window.AICommands` object any agent can consume
39
+ - **Secure License Exchange** — Embed uses public `siteId` + `/api/license/token`; long-lived license keys stay in the owner dashboard, not in HTML
40
+ - **Rate Limiting** — Multi-dimensional abuse protection (IP + license key + site)
41
+ - **Analytics Dashboard** — Track how AI agents interact with your site
42
+ - **Real-Time Analytics** — WebSocket-based live event streaming with auto-reconnection
43
+ - **In-Memory Caching** — TTL-based cache layer reduces DB reads on hot paths
44
+ - **Analytics Queue** — Batched writes with transaction support for high-throughput tracking
45
+ - **WebDriver BiDi Compatible** — Standard protocol support via `window.__wab_bidi`
46
+ - **CDN Versioning** — Serve scripts via versioned URLs (`/v1/ai-agent-bridge.js`, `/latest/ai-agent-bridge.js`)
47
+ - **Docker Ready** — One-command deployment with Docker Compose
48
+ - **DB Migrations** — Numbered SQL migration runner with tracking table
49
+ - **Custom Actions** — Register your own actions with custom handlers
50
+ - **Subscription Tiers** — Free core + paid premium features (API access, analytics, automated login)
51
+ - **Event System** — Subscribe to bridge events for monitoring
52
+ - **Security Sandbox** — Origin validation, session tokens, command signing, audit logging, auto-lockdown
53
+ - **Self-Healing Selectors** — Resilient element resolution with fuzzy matching for dynamic SPAs
54
+ - **Stealth Mode** — Human-like interaction patterns (requires explicit consent)
55
+ - **Multi-Database** — SQLite (default), PostgreSQL, MySQL via pluggable adapters
56
+ - **Agent SDK** — Built-in SDK for building AI agents with Puppeteer/Playwright
57
+ - **React Package** — `@web-agent-bridge/react` with `WABProvider`, `useWAB`, `useWABAction`, and `useWABActions`
58
+ - **Vue Package** — `@web-agent-bridge/vue` composables (`useWAB`, `useWABAction`, `useWABActions`) for Vue 3+
59
+ - **Svelte Package** — `@web-agent-bridge/svelte` stores (`createWAB`, `createWABAction`) for Svelte 3+
60
+ - **LangChain Adapter** — `@web-agent-bridge/langchain` wraps WAB actions as LangChain tools for LLM agents
61
+ - **GDPR/CCPA Consent** — Optional `wab-consent.js` banner with `WABConsent.showBanner()` and `hasConsent()` gate
62
+ - **Admin Dashboard** — User management, tier grants, system analytics
63
+ - **Stripe Integration** — Payment processing with customer portal
64
+ - **Plugin Architecture** — Dynamic plugin system with hook-based execution, per-site installation, priority ordering, ratings, and audit logging
65
+ - **Vision Analysis Service** — Multi-provider screenshot analysis (local Moondream, OpenAI, Anthropic, Ollama) with interactive element detection, bounding box extraction, and AES-256-GCM encrypted API keys
66
+ - **Fairness Engine** — Neutrality layer ensuring AI agents give equal opportunity to small and large sites with fairness-weighted search, commission transparency tracking, and trust signature validation
67
+ - **Agent Memory System** — Persistent behavioral memory with 4 memory types, 5 categories, semantic associations, importance scoring, and TTL-based expiration
68
+ - **Premium Traffic Intelligence** — Advanced bot detection (30+ agent types), behavioral profiling, anomaly/spike detection, security exploit detection (SQLi, XSS), and webhook alerting
69
+ - **E-Mail Service** — SMTP-based transactional emails (welcome, registration, password reset, contact) with branded HTML templates
70
+ - **NoScript Fallback** — 1×1 tracking pixel endpoint for analytics collection when JavaScript is unavailable
71
+ - **WAB-MCP Adapter** — Expose WAB site capabilities as MCP tools for Claude, GPT, Gemini, and other MCP-compatible AI agents
72
+ - **WordPress Plugin** — Native WordPress plugin with settings page, per-page action meta boxes, discovery document generation, and dashboard widget
73
+ - **WAB Browser (Desktop)** — Standalone Electron desktop browser with built-in ad blocker (80+ domains), scam shield, fairness ranking, agent chat, bookmarks, history, and WAB protocol support. *Desktop source is maintained in a separate private build pipeline (`wab-browser/`); the PWA source below is fully open.*
74
+ - **PWA Browser (Mobile)** Progressive Web App browser for Android/iOS with ad blocking (80+ domains), WAB Search engine, scam detection, fairness ranking, real AI agent chat, and offline-first service worker. Full source at `public/pwa/`.
75
+ - **Schema Discovery SDK** — Server-side extraction of schema.org JSON-LD Product nodes from HTML with automatic WAB action hint generation
76
+
77
+ ### v2.0Digital Fortress Features
78
+
79
+ - **Real-time Negotiation Engine** — AI agents negotiate prices directly with WAB-enabled sites using multi-round sessions. 8 condition types (bulk, loyalty, time-based, first-purchase, cart-value, seasonal, membership, referral) and 4 discount types (percentage, fixed, free-shipping, bonus-item). Includes daily usage limits, minimum order values, and full audit trail of all offers
80
+ - **Anti-Hallucination Shield** — Cross-verification engine comparing DOM vs vision screenshots, market benchmark validation, temporal consistency checks, and Levenshtein text similarity scoring. 4 severity levels (minor → fraud) and 5 response actions (warn, halt, confirm-human, auto-correct, block)
81
+ - **Decentralized Reputation System** — HMAC-signed trust attestations from the agent network covering 6 attestation types (purchase, booking, query, form, navigation, verification). 7 trust levels (unknown → blacklisted), temporal decay, Sybil resistance, global leaderboard, and challenge/dispute system
82
+ - **Sovereign Dashboard** — Real-time command center with fairness radar, privacy shield, negotiation logs, verification checks, and AI model switcher. Exposes `/api/sovereign/dashboard/sovereign` aggregate endpoint
83
+ - **Community Agent Hub** — 11 pre-built YAML agent templates (hotel booking, grocery comparison, artisan marketplace, flight deals, etc.) with CLI runner: `npx wab-agent run template.yaml`
84
+ - **AI Brain Swapping** Local AI runtime that auto-discovers Ollama and llama.cpp endpoints plus custom OpenAI-compatible APIs. Model capability tracking for text/vision, context window management, latency-based routing, and inference logging with token metrics
85
+ - **Cross-Site Agent Orchestration** — One agent manages multiple WAB-enabled sites simultaneously via `WABMultiAgent`. Compare prices across stores, aggregate data, run parallel actions, and find the best deal automatically
86
+
87
+ ### v2.3Private Agent Mesh (Distributed Mind)
88
+
89
+ - **Inter-Agent Protocol** — Agents communicate through a private mesh with 5 built-in channels (alerts, discoveries, tactics, negotiations, votes). 6 message types with confidence scoring, auto-expiring stale agents via heartbeat, peer verification of shared knowledge. All communication stays local — no external transmission
90
+ - **Local Reinforcement Learning** — Agents learn from every user decision using UCB1 multi-armed bandit action selection, gradient-descent policy updates with sigmoid activation, temporal discounting, and sequential pattern mining. Zero external API calls — all learning is local
91
+ - **Symphony Orchestrator** Four specialized agents (Researcher, Analyst, Negotiator, Guardian) collaborate autonomously through rule-based engines. 5 templates, 6-phase pipeline (analyze → research → negotiate → guard → synthesize → decide), Guardian veto for safety, weighted consensus. Full phase logging with duration tracking. No external LLM dependency
92
+ - **Agent Mesh Dashboard** — Real-time visualization of your agent mesh: active agents, communication channels, shared knowledge base, symphony compositions, and learning performance metrics
93
+
94
+ ### v2.4Commander & Edge Intelligence
95
+
96
+ - **Commander Agent System** — Local-first mission orchestration engine that decomposes high-level goals into task DAGs. Agent registry with capabilities tracking, parallel execution engine, learning integration for outcome feedback, and edge coordination for distributed work
97
+ - **Edge Compute System** Transforms every user device into a sovereign AI node. Hardware profiling (CPU, RAM, GPU), AES-256-GCM encrypted inter-node communication, weighted load balancing, heartbeat-based health monitoring with auto-failover, and swarm formation with capability-based clustering
98
+ - **Swarm Execution Engine** — Launch multiple agents in parallel to solve a single task. Configurable strategies (parallel, sequential, hybrid), result merging with best-score selection, role specialization, fairness-weighted aggregation, and per-agent confidence scoring
99
+
100
+ ### v2.5Agent Workspace & Multilingual AI
101
+
102
+ - **Agent Workspace** — Premium 4-panel workspace for non-technical users: embedded browser, smart agent chat, real-time negotiation monitor, and results panel. Subscription tiers (Free/Starter/Pro/Enterprise), deal tracking, and admin management. Live at [webagentbridge.com/workspace](https://webagentbridge.com/workspace)
103
+ - **Bilingual UI (AR/EN)** — Full Arabic/English interface with auto-detection from browser language. Toggle instantly between languages. RTL/LTR layout support
104
+ - **Multilingual Agent** The smart agent understands and responds in any language the user writes in — Arabic, English, French, Spanish, Turkish, and more. No restrictions on input style, dialect, or format
105
+ - **Dynamic Pricing Shield** — Detects price manipulation by websites that change prices based on device type, geolocation, cookies, browsing history, referral source, or repeat visits. The agent probes the same page with 12 distinct identity personas (clean desktop, mobile, Mac premium, EU/MENA/SEA geo, repeat visitor, Google/social/comparison referral, privacy-focused, bot-like) and uses statistical analysis (coefficient of variation, z-score outliers) to expose hidden pricing. Includes manipulation scoring (0–100), actionable tips, historical trend detection, and a strategy builder that recommends the best identity for the lowest price. Full API at `/api/sovereign/price-shield/`
106
+
107
+ ### v3.0 — Agent OS (Execution Layer for the Web)
108
+
109
+ WAB v3.0 transforms the project from an advanced automation tool into a **real Agent Operating System** a complete execution layer for AI agents on the web, comparable to MCP but purpose-built for browser interaction.
110
+
111
+ - **WAB Protocol (WABP) v1.0.0** — Formal protocol with JSON Schema command registry, typed messages, input/output validation, and versioned command definitions. 10 built-in commands (discover, execute, semantic.execute, agent.register, task.submit, task.status, commerce.compare, commerce.negotiate, mesh.send, ai.infer). Every command has declared capabilities, risk levels, and permission requirements
112
+ - **Capability Negotiation** — Dynamic capability grants between agents and sites. Risk-based auto-approval (low-risk auto-granted, high-risk requires policy), rate limiting per capability, expirable grants with usage tracking, and full revocation support
113
+ - **Agent Runtime Engine** — Production-grade task runtime with priority queue scheduler, dependency resolution, retry with exponential backoff, pause/resume/cancel, concurrency limits, and state machine transitions. EventBus with async middleware, namespace wildcards, replay buffer (10K events), and dead letter queue
114
+ - **Execution Sandbox** — Per-task isolation with resource limits (timeout, maxMemory, maxNetworkCalls, maxDomOperations), domain allowlists, blocked selector enforcement, capability checks at execution time, and full audit trail of every operation
115
+ - **State Manager** — Agent state persistence with labeled checkpoints, rollback to any checkpoint, state transitions with validation, merge operations, and TTL-based cleanup
116
+ - **Observability Stack** — Structured JSON logger with child loggers and pluggable sinks, distributed tracer with parent-child spans (OpenTelemetry-compatible), and metrics collector with counters, gauges, histograms (p50/p90/p95/p99 percentiles), and time series for dashboards
117
+ - **Security Model** — AgentIdentity (registration, hashed API key authentication, session management with TTL, IP allowlists, revocation), CommandSigner (HMAC-SHA256 signing/verification with nonce + timestamp, timing-safe comparison), and SiteIsolation (per-site access control, allowed/blocked agents, max concurrency, selector blocking, data classification)
118
+ - **Control Plane** — AgentManager for deployment lifecycle (deploy, assign to sites, health checks, undeploy) and PolicyEngine with typed rules, condition evaluation (equals, contains, pattern, min, max, in), priority-ordered policy binding, and entity-level policy enforcement
119
+ - **Data Plane** — SemanticActionResolver maps `domain.action` notation (e.g., `checkout.addItem`) to concrete implementations per site. Executor routes tasks through tracing + metrics, supports semantic/pipeline/parallel execution modes, with 8 built-in semantic actions for checkout, search, auth, navigation, and content
120
+ - **Multi-Model LLM Abstraction** — Unified interface for OpenAI (chat completions + embeddings), Anthropic (messages API), and Ollama (local models with auto-discovery). LLMManager provides automatic fallback chain through all providers, response caching (5min TTL), cost tracking via token counts, and model listing
121
+ - **Registry & Ecosystem** — CommandRegistry (like npm for WAB commands — register, discover, search by category/tag/capability, usage tracking), SiteRegistry (WAB-enabled sites directory with verification, capability listing, visit tracking), and TemplateRegistry (reusable workflow templates with download counts and ratings)
122
+ - **Unified Runtime API** All Agent OS layers exposed via RESTful endpoints at `/api/os/*`: protocol discovery, agent identity/auth, task CRUD, semantic execution, deployments, policies, isolation, observability (metrics/traces/logs), registry (commands/sites/templates), LLM operations, command signing, and Server-Sent Events for real-time streaming
123
+ - **WABAgentOS SDK Client** — New `WABAgentOS` class in the SDK provides full TypeScript-typed API for all Agent OS operations: register → authenticate → negotiate capabilities → submit tasks → execute semantically → query observability → subscribe to events
124
+
125
+ ### v3.1 — WAP Deep Architecture (Protocol Hardening)
126
+
127
+ v3.1 hardens the Agent OS into a production-grade system that *surpasses* MCP making WAP (Web Agent Protocol) the top-level protocol with MCP as just one adapter.
128
+
129
+ - **WAP Discovery Spec** — Formal `/.well-known/agent-tools.json` discovery document. AI agents can find all WAP capabilities, commands, permissions, runtime config, security model, and SDKs from a single standardized URL
130
+ - **Adapter Layer** — WAP sits at the top; MCP, REST/GraphQL, and Browser automation are transport adapters beneath it. MCP Adapter exposes all WAB commands as MCP tools (list_tools / call_tool). REST Adapter registers external APIs as first-class WAP endpoints with auth, mapping, and rate limiting. Browser Adapter translates semantic actions (checkout.addItem, search.query, auth.login) into concrete browser step plans with selector fallbacks and verification
131
+ - **Auth Middleware** — All `/api/os/*` mutation endpoints require authentication (Bearer token, API key, or agent header). Public read endpoints remain open for discovery. GET requests pass through for read-only access
132
+ - **Deterministic Replay Engine** — Records all task inputs, outputs, and side-effects. Supports replay with verification mode (re-execute and compare), dry-run mode (inspect recorded steps), and diff between two recordings. Enables debugging, regression testing, and workflow certification
133
+ - **Failure Analysis & Classification** — Automatic classification of failures into 9 categories (network, timeout, permission, validation, execution, rate_limit, resource, dependency, unknown). Root cause analysis, severity scoring, retryability assessment, suggested fixes, and pattern detection for recurring failures
134
+ - **Session Engine** — Browser execution sessions with cookie jar (set/get/domain-scoped), localStorage/sessionStorage emulation, navigation history, variable store, session export/import for transfer, and TTL-based expiration
135
+ - **Certification System** — Site compatibility verification with 13 weighted checks across 7 categories (integration, protocol, data, security, fairness, compliance, sovereignty). Issues certificates at 5 levels (none → basic → standard → premium → sovereign) with 90-day validity, HMAC-signed badges, and revocation
136
+ - **DB Persistence Layer** SQLite tables for all Agent OS entities: agents, sessions, tasks, deployments, registry commands/sites/templates, audit log (immutable append-only), capability grants, and policies. Auto-migrates on boot
137
+ - **65+ API Endpoints** — Adapters (MCP tools, REST endpoints, browser mappings), replay (recordings, replay, diff, stats), sessions (CRUD, cookies, storage, export/import), failure analysis (query, patterns, summary, classify), certification (verify, certificates, revoke), plus all existing v3.0 endpoints
138
+
139
+ > **Many more features** are available on the live website that aren't listed here — dashboards, analytics, admin tools, and more. Visit [webagentbridge.com](https://webagentbridge.com) to explore.
140
+
141
+ ### v3.2 — API Gateway & Advanced Modules
142
+
143
+ v3.2 introduces a **unified API gateway** at `/api/v1` with 10 advanced modules for AI agent protection, consumer rights, price intelligence, and regulatory compliance. All modules use centralized API key authentication with plan-based access control.
144
+
145
+ 🌐 **Live API Docs:** [webagentbridge.com/api](https://webagentbridge.com/api) (English / العربية)
146
+
147
+ #### API Plans & Pricing
148
+
149
+ | Plan | Price | Requests/Day | Requests/Min | Modules |
150
+ |------|-------|-------------|-------------|----------|
151
+ | **Free** | $0/mo | 100 | 10 | Protocol, Price Time Machine, Dark Pattern, Bounty |
152
+ | **Pro** | $29/mo | 10,000 | 100 | All Free + Firewall, Neural, Bargaining, Affiliate |
153
+ | **Business** | $149/mo | 100,000 | 500 | All 10 modules (incl. Notary, Gov Intelligence) |
154
+ | **Enterprise** | Custom | Unlimited | Custom | All 10 + SLA + on-premise option |
155
+
156
+ **Get your API key:** `POST /api/v1/keys/generate` with `{"plan": "FREE", "owner": "name", "email": "you@example.com"}`
157
+
158
+ #### The 10 Modules
159
+
160
+ | # | Module | Route | Type | Min Plan | Description |
161
+ |---|--------|-------|------|----------|-------------|
162
+ | 01 | **Agent Firewall** | `/api/v1/firewall` | 🟡 API Open · Engine Closed | PRO | Scans URLs/content for prompt injection, phishing, malicious domains |
163
+ | 02 | **Cryptographic Notary** | `/api/v1/notary` | 🔴 Fully Closed | BUSINESS | Issues legally admissible cryptographic certificates for price discrimination proof |
164
+ | 03 | **Dark Pattern Detector** | `/api/v1/dark-pattern` | 🔴 Fully Closed | FREE | Detects all 17 OECD-classified dark patterns with EU DSA/DMA audit reports |
165
+ | 04 | **Collective Bargaining** | `/api/v1/bargaining` | 🟡 Join Open · Engine Closed | PRO | Anonymous buyer grouping for bulk discount negotiation |
166
+ | 05 | **Gov Intelligence** | `/api/v1/gov` | 🔴 Fully Closed | BUSINESS | Regulatory compliance database and domain compliance checking |
167
+ | 06 | **Price Time Machine** | `/api/v1/price` | 🟡 API Open · DB Closed | FREE | Historical price tracking and fake discount detection |
168
+ | 07 | **WAB Neural Engine** | `/api/v1/neural` | 🔴 Fully Closed | PRO | Local AI inference for URL analysis, content classification, embeddings |
169
+ | 08 | **WAB Protocol** | `/api/v1/protocol` | 🟢 Fully Open Source | FREE | Open wab.json trust protocol validator and schema endpoint |
170
+ | 09 | **Bounty Network** | `/api/v1/bounty` | 🟡 Report Open · Rules Closed | FREE | Community-powered threat reporting and bug bounty with leaderboard |
171
+ | 10 | **Affiliate Intelligence** | `/api/v1/affiliate` | 🟡 API Open · DB Closed | PRO | Detects affiliate link manipulation, cookie stuffing, tracking pixel abuse |
172
+
173
+ **Type Legend:** 🟢 Fully open source · 🟡 Public API interface, proprietary engine · 🔴 Fully closed (returns 503 without engine)
174
+
175
+ #### Authentication
176
+
177
+ All module endpoints require an API key via one of three methods:
178
+
179
+ ```bash
180
+ # Option 1: Authorization header (recommended)
181
+ curl -X POST https://www.webagentbridge.com/api/v1/firewall/scan \
182
+ -H "Authorization: Bearer wab_live_pro_YOUR_KEY" \
183
+ -H "Content-Type: application/json" \
184
+ -d '{"url": "https://example.com", "content": "page content..."}'
185
+
186
+ # Option 2: X-WAB-Key header
187
+ curl -H "X-WAB-Key: wab_live_pro_YOUR_KEY" \
188
+ https://www.webagentbridge.com/api/v1/protocol/check/example.com
189
+
190
+ # Option 3: Query parameter
191
+ curl https://www.webagentbridge.com/api/v1/bounty/stats?api_key=wab_live_fre_YOUR_KEY
192
+ ```
193
+
194
+ #### Key Management
195
+
196
+ | Endpoint | Method | Description |
197
+ |----------|--------|-------------|
198
+ | `/api/v1/keys/generate` | POST | Create a new API key |
199
+ | `/api/v1/keys/validate` | POST | Validate an existing key |
200
+ | `/api/v1/keys/usage` | GET | Check usage and quotas |
201
+ | `/api/v1/keys/revoke` | POST | Revoke a key |
202
+ | `/api/v1/keys/rotate` | POST | Rotate a key (revoke old, issue new) |
203
+
204
+ #### Gateway Endpoints
205
+
206
+ | Endpoint | Method | Description |
207
+ |----------|--------|-------------|
208
+ | `/api/v1/health` | GET | Gateway health check (public) |
209
+ | `/api/v1/plans` | GET | List available plans and pricing (public) |
210
+ | `/api/v1/modules` | GET | List all available modules (public) |
211
+
212
+ #### How to Subscribe
213
+
214
+ 1. Visit [webagentbridge.com/api](https://webagentbridge.com/api) to explore available modules
215
+ 2. Generate a **Free** API key: `POST /api/v1/keys/generate` with your name and email
216
+ 3. Start making requests to any Free-tier module immediately
217
+ 4. Upgrade to **Pro** ($29/mo) or **Business** ($149/mo) for access to advanced modules
218
+ 5. Manage your keys via the `/api/v1/keys/*` endpoints
219
+
220
+ ---
221
+
222
+ ## Quick Start
223
+
224
+ > **Looking for a 5-minute install?** See **[INSTALL.md](INSTALL.md)** — a dedicated bilingual (English / العربية) quick-install guide that gets you a sovereign WAB-enabled site with DNS Discovery in one command.
225
+
226
+ ### Deploy in One Click
227
+
228
+ | Platform | Button | Storage | Free Tier |
229
+ |---|---|---|---|
230
+ | **Railway** | [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/web-agent-bridge?referralCode=wab) | Persistent SQLite | $5 credit/mo |
231
+ | **Vercel** | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fabokenan444%2Fweb-agent-bridge&env=JWT_SECRET,JWT_SECRET_ADMIN&project-name=web-agent-bridge) | Ephemeral | Generous free tier |
232
+ | **Netlify** | [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/abokenan444/web-agent-bridge) | Ephemeral | 100GB bandwidth/mo |
233
+ | **Cloudflare** | [![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/abokenan444/web-agent-bridge) | Edge KV | 100K req/day |
234
+
235
+ > **Recommended for production:** Railway (persistent storage) or self-hosted with Docker.
236
+
237
+ ### 1. Install & Run the Server
238
+
239
+ ```bash
240
+ # Option A: One-line install on any Linux server (Ubuntu/Debian/CentOS/Alpine)
241
+ curl -fsSL https://raw.githubusercontent.com/abokenan444/web-agent-bridge/master/integrations/install/install.sh | sudo bash
242
+
243
+ # Option B: Clone and run
244
+ git clone https://github.com/abokenan444/web-agent-bridge.git
245
+ cd web-agent-bridge
246
+ npm install
247
+ cp .env.example .env
248
+ npm start
249
+
250
+ # Option C: npx (one command)
251
+ npx web-agent-bridge start
252
+
253
+ # Option D: Docker (standard)
254
+ docker compose up -d
255
+
256
+ # Option E: Docker with Nginx + SSL (production)
257
+ WAB_DOMAIN=yourdomain.com docker compose -f docker-compose.nginx.yml up -d
258
+ ```
259
+
260
+ ### 2. Create an Account
261
+
262
+ Visit `http://localhost:3000/register` and create an account, then add your site from the dashboard.
263
+
264
+ ### 3. Add the Script to Your Website
265
+
266
+ ```html
267
+ <!-- Recommended: copy the snippet from your dashboard (uses siteId only) -->
268
+ <script>
269
+ window.AIBridgeConfig = {
270
+ siteId: "your-site-uuid-from-dashboard",
271
+ configEndpoint: "https://yourserver.com/api/license/token",
272
+ agentPermissions: {
273
+ readContent: true,
274
+ click: true,
275
+ fillForms: true,
276
+ scroll: true
277
+ }
278
+ };
279
+ </script>
280
+ <script src="https://yourserver.com/script/ai-agent-bridge.js"></script>
281
+ ```
282
+
283
+ The server matches **Origin** to your registered site domain, then returns a short-lived **session token**. Analytics (`/api/license/track`) require that session — not the long-lived license key. Keep the license key in the dashboard only.
284
+
285
+ ### 4. AI Agents Can Now Interact
286
+
287
+ ```javascript
288
+ // From the AI agent's side
289
+ const bridge = window.AICommands;
290
+ const actions = bridge.getActions(); // discover actions
291
+ await bridge.execute("signup"); // execute an action
292
+ const info = bridge.getPageInfo(); // get page metadata
293
+ ```
294
+
295
+ ---
296
+
297
+ ## Project Structure
298
+
299
+ ```
300
+ web-agent-bridge/
301
+ ├── server/ # Express.js backend
302
+ │ ├── index.js # Server entry point
303
+ │ ├── ws.js # WebSocket server (live analytics)
304
+ │ ├── routes/
305
+ │ │ ├── auth.js # Authentication (register/login)
306
+ │ │ ├── api.js # Sites, config, analytics API
307
+ │ │ ├── license.js # License verification, token exchange & tracking
308
+ │ │ ├── admin.js # Admin dashboard API
309
+ │ │ ├── admin-premium.js # Admin premium analytics (memory, vision, swarm, plugins)
310
+ │ │ ├── billing.js # Stripe billing integration
311
+ │ │ ├── sovereign.js # v2.0: negotiation, reputation, verification, dashboard
312
+ │ │ ├── mesh.js # v2.3: agent mesh protocol routes
313
+ │ │ ├── commander.js # v2.4: mission orchestration routes
314
+ │ │ ├── premium.js # Premium features
315
+ │ │ ├── premium-v2.js # v2 premium (memory, vision, healing, swarm, plugins)
316
+ │ │ ├── discovery.js # WAB discovery + fairness-weighted search
317
+ │ │ ├── wab-api.js # WAB HTTP transport (alternative to JS/WS)
318
+ │ │ ├── noscript.js # NoScript tracking pixel fallback
319
+ │ │ └── gateway.js # v3.2: Unified API Gateway (/api/v1)
320
+ │ ├── services/
321
+ │ │ ├── negotiation.js # Real-time negotiation engine
322
+ │ │ ├── verification.js # Anti-hallucination shield
323
+ │ │ ├── reputation.js # Decentralized reputation system
324
+ │ │ ├── agent-mesh.js # Inter-agent protocol (mesh)
325
+ │ │ ├── agent-learning.js # Local reinforcement learning (UCB1)
326
+ │ │ ├── agent-symphony.js # Symphony orchestrator (4 roles, 6 phases)
327
+ │ │ ├── agent-memory.js # Persistent agent memory with associations
328
+ │ │ ├── commander.js # Mission orchestration & task DAGs
329
+ ├── edge-compute.js # Edge computing / sovereign AI nodes
330
+ │ │ ├── swarm.js # Swarm execution engine
331
+ │ │ ├── fairness.js # Fairness & neutrality engine
332
+ │ │ ├── vision.js # Vision analysis (multi-provider)
333
+ ├── self-healing.js # Self-healing selector corrections
334
+ │ │ ├── local-ai.js # Local AI model runtime
335
+ │ │ ├── plugins.js # Plugin architecture (hooks, registry)
336
+ ├── premium.js # Premium traffic intelligence & bot detection
337
+ │ ├── email.js # SMTP email service
338
+ ├── stripe.js # Stripe payment integration
339
+ ├── api-key-engine.js # v3.2: API key auth, rate limiting, plans
340
+ └── modules/ # v3.2: API Gateway modules
341
+ │ │ ├── protocol.js # WAB Protocol validator (open)
342
+ ├── agent-firewall.js # Agent Firewall (partial)
343
+ ├── price-time-machine.js # Price Time Machine (partial)
344
+ ├── bounty.js # Bounty Network (partial)
345
+ ├── collective-bargaining.js # Collective Bargaining (partial)
346
+ ├── affiliate-intelligence.js # Affiliate Intelligence (partial)
347
+ ├── neural.js # Neural Engine (closed)
348
+ ├── dark-pattern.js # Dark Pattern Detector (closed)
349
+ │ │ ├── gov-intelligence.js # Gov Intelligence (closed)
350
+ │ │ └── notary.js # Cryptographic Notary (closed)
351
+ │ ├── middleware/
352
+ │ │ ├── auth.js # JWT authentication middleware
353
+ │ │ ├── adminAuth.js # Admin authentication
354
+ │ │ └── rateLimits.js # Multi-layer rate limiting
355
+ │ ├── models/
356
+ │ │ ├── db.js # Database operations
357
+ │ │ └── adapters/ # SQLite, PostgreSQL, MySQL adapters
358
+ │ ├── migrations/ # Numbered SQL migrations
359
+ └── utils/
360
+ ├── cache.js # In-memory TTL cache + analytics queue
361
+ ├── migrate.js # Migration runner
362
+ └── secureFields.js # Field-level encryption utilities
363
+ ├── public/ # Frontend
364
+ ├── index.html # Landing page
365
+ ├── dashboard.html # Management dashboard
366
+ │ ├── premium-dashboard.html # Premium analytics dashboard
367
+ │ ├── docs.html # Documentation
368
+ │ ├── login.html / register.html # Auth pages
369
+ │ ├── admin/ # Admin panel
370
+ │ ├── pwa/ # Progressive Web App (mobile browser)
371
+ ├── manifest.json # PWA manifest
372
+ ├── sw.js # Service worker (offline-first)
373
+ ├── index.html # Mobile browser UI
374
+ │ ├── app.js # Ad blocker, scam shield, fairness
375
+ │ │ ├── app.css # Mobile-optimized dark theme
376
+ │ └── icons/ # PWA icons (192x192, 512x512)
377
+ │ ├── script/
378
+ ├── wab.min.js # Minified WAB client library
379
+ │ ├── wab-consent.js # GDPR/CCPA consent banner
380
+ │ │ ├── wab-schema.js # Schema.org discovery
381
+ ├── wab.d.ts # TypeScript definitions
382
+ └── wab-consent.d.ts # Consent TypeScript definitions
383
+ ├── js/ # Dashboard frontend JS
384
+ └── css/ # Stylesheets
385
+ ├── script/
386
+ │ └── ai-agent-bridge.js # The bridge script (embed in websites)
387
+ ├── examples/ # Agent examples
388
+ │ ├── puppeteer-agent.js # Puppeteer + window.AICommands
389
+ ├── bidi-agent.js # WebDriver BiDi protocol
390
+ ├── vision-agent.js # Vision/NLP intent resolution
391
+ │ ├── mcp-agent.js # MCP adapter usage for Claude/GPT
392
+ │ ├── cross-site-agent.js # Multi-domain orchestration
393
+ ├── next-app-router/ # Next.js App Router integration
394
+ ├── shopify-hydrogen/ # Shopify Hydrogen storefront
395
+ │ ├── wordpress-elementor/ # WordPress + Elementor setup
396
+ │ └── saas-dashboard/ # SaaS dashboard actions
397
+ ├── packages/ # Framework wrappers
398
+ ├── react/ # @web-agent-bridge/react
399
+ │ ├── vue/ # @web-agent-bridge/vue
400
+ ├── svelte/ # @web-agent-bridge/svelte
401
+ │ └── langchain/ # @web-agent-bridge/langchain
402
+ ├── sdk/ # Agent SDK
403
+ ├── index.js # WABAgent for Puppeteer/Playwright
404
+ │ └── schema-discovery.js # Server-side schema.org extraction
405
+ ├── wab-mcp-adapter/ # MCP adapter for Claude/GPT/Gemini
406
+ │ ├── index.js # MCP tool definitions
407
+ │ └── package.json
408
+ ├── wab-browser/ # Electron desktop browser
409
+ │ ├── main.js # Electron main process
410
+ │ ├── preload.js # Bridge preload
411
+ │ └── package.json
412
+ ├── web-agent-bridge-wordpress/ # WordPress plugin
413
+ │ ├── web-agent-bridge.php # Plugin entry point
414
+ │ ├── includes/ # PHP classes (API, Actions, Dashboard)
415
+ │ └── assets/ # Plugin CSS/JS
416
+ ├── bin/
417
+ │ ├── cli.js # CLI entry point (wab-agent)
418
+ │ └── wab.js # Agent runner
419
+ ├── templates/ # 11 Community Agent Hub YAML templates
420
+ ├── docs/
421
+ │ ├── SPEC.md # WAB Protocol Specification
422
+ │ └── DEPLOY.md # Deployment guide
423
+ ├── demo-store/ # Demo store for testing
424
+ ├── deploy/ # Nginx configs
425
+ ├── tests/ # Jest + Supertest test suite
426
+ ├── .env # Environment variables
427
+ └── package.json
428
+ ```
429
+
430
+ ---
431
+
432
+ ## API Endpoints
433
+
434
+ ### Authentication
435
+ | Endpoint | Method | Description |
436
+ |---|---|---|
437
+ | `/api/auth/register` | POST | Create account |
438
+ | `/api/auth/login` | POST | Sign in, receive JWT |
439
+ | `/api/auth/me` | GET | Get current user |
440
+
441
+ ### Sites
442
+ | Endpoint | Method | Description |
443
+ |---|---|---|
444
+ | `/api/sites` | GET | List your sites |
445
+ | `/api/sites` | POST | Add a new site |
446
+ | `/api/sites/:id` | GET | Get site details |
447
+ | `/api/sites/:id/config` | PUT | Update configuration |
448
+ | `/api/sites/:id/tier` | PUT | Change subscription tier |
449
+ | `/api/sites/:id` | DELETE | Delete a site |
450
+ | `/api/sites/:id/snippet` | GET | Get install code snippet |
451
+ | `/api/sites/:id/analytics` | GET | Get analytics data |
452
+
453
+ ### License (Public)
454
+ | Endpoint | Method | Description |
455
+ |---|---|---|
456
+ | `/api/license/verify` | POST | Verify license key for domain (cached) |
457
+ | `/api/license/token` | POST | Exchange `siteId` (Origin must match domain) or `licenseKey` for session token |
458
+ | `/api/license/session` | POST | Validate session token (domain-locked) |
459
+ | `/api/license/track` | POST | Record analytics (`sessionToken` + Origin) |
460
+
461
+ ### Sovereign (v2.0)
462
+ | Endpoint | Method | Description |
463
+ |---|---|---|
464
+ | `/api/sovereign/reputation/agents` | POST | Register a new agent |
465
+ | `/api/sovereign/reputation/attestations` | POST | Submit a trust attestation |
466
+ | `/api/sovereign/reputation/sites/:siteId` | GET | Get site reputation |
467
+ | `/api/sovereign/reputation/leaderboard` | GET | Get reputation leaderboard |
468
+ | `/api/sovereign/negotiation/rules` | POST | Create negotiation rule |
469
+ | `/api/sovereign/negotiation/rules/:siteId` | GET | Get rules for a site |
470
+ | `/api/sovereign/negotiation/sessions` | POST | Open negotiation session |
471
+ | `/api/sovereign/negotiation/sessions/:id/propose` | POST | Submit counter-offer |
472
+ | `/api/sovereign/negotiation/sessions/:id/confirm` | POST | Confirm a deal |
473
+ | `/api/sovereign/verify/price` | POST | Verify price (DOM vs vision) |
474
+ | `/api/sovereign/verify/text` | POST | Verify text accuracy |
475
+ | `/api/sovereign/verify/page` | POST | Full page verification |
476
+ | `/api/sovereign/dashboard/sovereign` | GET | Dashboard aggregate data |
477
+
478
+ ### Agent Mesh (v2.3)
479
+ | Endpoint | Method | Description |
480
+ |---|---|---|
481
+ | `/api/mesh/agents` | POST | Register agent in mesh |
482
+ | `/api/mesh/agents` | GET | List mesh agents |
483
+ | `/api/mesh/channels` | GET | List communication channels |
484
+ | `/api/mesh/messages` | POST | Publish message to channel |
485
+ | `/api/mesh/messages/:channel` | GET | Get messages from channel |
486
+ | `/api/mesh/knowledge` | POST | Share knowledge to mesh |
487
+ | `/api/mesh/knowledge` | GET | Query knowledge base |
488
+ | `/api/mesh/votes` | POST | Start a vote |
489
+ | `/api/mesh/votes/:id/cast` | POST | Cast a vote |
490
+ | `/api/mesh/votes/:id/tally` | GET | Get vote results |
491
+
492
+ ### Commander (v2.4)
493
+ | Endpoint | Method | Description |
494
+ |---|---|---|
495
+ | `/api/commander/missions` | POST | Create a new mission |
496
+ | `/api/commander/missions/:id/launch` | POST | Launch mission execution |
497
+ | `/api/commander/missions/:id` | GET | Get mission status |
498
+ | `/api/commander/missions` | GET | List all missions |
499
+ | `/api/commander/agents` | POST | Register an agent |
500
+ | `/api/commander/agents` | GET | List registered agents |
501
+ | `/api/commander/edge/nodes` | POST | Register edge node |
502
+ | `/api/commander/edge/nodes` | GET | List edge nodes |
503
+ | `/api/commander/ai/models` | GET | Discover local AI models |
504
+ | `/api/commander/ai/infer` | POST | Run local AI inference |
505
+ | `/api/commander/stats` | GET | Unified platform statistics |
506
+
507
+ ### Premium v2
508
+ | Endpoint | Method | Description |
509
+ |---|---|---|
510
+ | `/api/premium/v2/memory` | POST | Store agent memory |
511
+ | `/api/premium/v2/memory/:agentId` | GET | Recall agent memories |
512
+ | `/api/premium/v2/memory/associate` | POST | Create memory association |
513
+ | `/api/premium/v2/memory/:id` | DELETE | Forget a memory |
514
+ | `/api/premium/v2/memory/consolidate` | POST | Consolidate old memories |
515
+ | `/api/premium/v2/vision/analyze` | POST | Analyze screenshot |
516
+ | `/api/premium/v2/vision/elements` | POST | Extract interactive elements |
517
+ | `/api/premium/v2/healing/corrections` | POST | Register selector correction |
518
+ | `/api/premium/v2/healing/resolve` | POST | Resolve broken selector |
519
+ | `/api/premium/v2/swarm/execute` | POST | Launch swarm task |
520
+ | `/api/premium/v2/swarm/:id` | GET | Get swarm results |
521
+ | `/api/premium/v2/plugins` | GET | List available plugins |
522
+ | `/api/premium/v2/plugins/:id/install` | POST | Install plugin for site |
523
+ | `/api/premium/v2/plugins/:id/hooks` | POST | Execute plugin hook |
524
+
525
+ ### Discovery & Fairness
526
+ | Endpoint | Method | Description |
527
+ |---|---|---|
528
+ | `/api/discovery` | GET | WAB discovery document |
529
+ | `/api/discovery/search` | GET | Fairness-weighted site search |
530
+ | `/api/discovery/register` | POST | Register site in WAB directory |
531
+
532
+ ### WAB Protocol (HTTP Transport)
533
+ | Endpoint | Method | Description |
534
+ |---|---|---|
535
+ | `/api/wab/session` | POST | Exchange session token |
536
+ | `/api/wab/actions` | GET | Get available actions |
537
+ | `/api/wab/execute` | POST | Execute action via HTTP |
538
+
539
+ ### NoScript Fallback
540
+ | Endpoint | Method | Description |
541
+ |---|---|---|
542
+ | `/noscript/pixel.gif` | GET | 1×1 tracking pixel for non-JS environments |
543
+
544
+ ---
545
+
546
+ ## Bridge Script API
547
+
548
+ Once loaded, `window.AICommands` exposes:
549
+
550
+ | Method | Description |
551
+ |---|---|
552
+ | `getActions(category?)` | List available actions |
553
+ | `getAction(name)` | Get a specific action |
554
+ | `execute(name, params?)` | Execute an action |
555
+ | `readContent(selector)` | Read element content |
556
+ | `getPageInfo()` | Get page and bridge metadata |
557
+ | `waitForElement(selector, timeout?)` | Wait for DOM element |
558
+ | `waitForNavigation(timeout?)` | Wait for URL change |
559
+ | `registerAction(def)` | Register a custom action |
560
+ | `authenticate(key, meta?)` | Authenticate an agent |
561
+ | `refresh()` | Re-scan the page |
562
+ | `onReady(callback)` | Callback when bridge is ready |
563
+ | `events.on(event, cb)` | Subscribe to events |
564
+
565
+ ---
566
+
567
+ ## Configuration
568
+
569
+ ```javascript
570
+ window.AIBridgeConfig = {
571
+ // Recommended — copy siteId from dashboard snippet (no license key in HTML)
572
+ siteId: "uuid-from-dashboard",
573
+ configEndpoint: "/api/license/token",
574
+
575
+ // Legacy: token exchange via license key (avoid embedding in public pages)
576
+ // licenseKey: "WAB-...",
577
+
578
+ agentPermissions: {
579
+ readContent: true, // Read page text
580
+ click: true, // Click elements
581
+ fillForms: false, // Fill/submit forms
582
+ scroll: true, // Scroll page
583
+ navigate: false, // Navigate pages
584
+ apiAccess: false, // Internal API calls (Pro+)
585
+ automatedLogin: false, // Auto login (Starter+)
586
+ extractData: false // Data extraction (Pro+)
587
+ },
588
+ restrictions: {
589
+ allowedSelectors: [],
590
+ blockedSelectors: [".private", "[data-private]"],
591
+ requireLoginForActions: ["apiAccess"],
592
+ rateLimit: { maxCallsPerMinute: 60 }
593
+ },
594
+ logging: { enabled: false, level: "basic" }
595
+ };
596
+ ```
597
+
598
+ ---
599
+
600
+ ## Subscription Tiers
601
+
602
+ | Feature | Free | Starter | Pro | Enterprise |
603
+ |---|:---:|:---:|:---:|:---:|
604
+ | Auto-discovery | | | ✓ | ✓ |
605
+ | Click/Scroll | | | ✓ | ✓ |
606
+ | Form filling | | ✓ | ✓ | ✓ |
607
+ | Basic logging | | | ✓ | ✓ |
608
+ | Automated login | ✗ | ✓ | ✓ | ✓ |
609
+ | Analytics dashboard | ✗ | ✓ | ✓ | ✓ |
610
+ | API access | ✗ | ✗ | ✓ | ✓ |
611
+ | Data extraction | ✗ | ✗ | ✓ | ✓ |
612
+ | Custom rate limits | ✗ | ✗ | ✗ | ✓ |
613
+ | Webhooks | ✗ | ✗ | ✗ | ✓ |
614
+
615
+ ---
616
+
617
+ ## Tech Stack
618
+
619
+ - **Backend**: Node.js + Express + WebSocket (ws)
620
+ - **Database**: SQLite (via better-sqlite3) with migration runner
621
+ - **Auth**: JWT + bcrypt + session tokens (domain-locked)
622
+ - **Caching**: In-memory TTL cache + batched analytics queue
623
+ - **Payments**: Stripe integration with billing portal
624
+ - **Frontend**: Vanilla HTML/CSS/JS (no framework dependencies)
625
+ - **Framework Wrappers**: React, Vue 3, Svelte (optional)
626
+ - **LLM Integration**: LangChain adapter, MCP adapter
627
+ - **Security**: Helmet, CORS, CSP, multi-layer rate limiting
628
+ - **Containers**: Docker + Docker Compose
629
+ - **CI/CD**: GitHub Actions (test + auto-publish to npm)
630
+ - **Testing**: Jest + Supertest
631
+
632
+ ---
633
+
634
+ ## WebDriver BiDi Compatibility
635
+
636
+ WAB exposes a `window.__wab_bidi` interface for agents using standardized WebDriver BiDi protocol:
637
+
638
+ ```javascript
639
+ // Get BiDi context
640
+ const context = window.__wab_bidi.getContext();
641
+
642
+ // Send BiDi command
643
+ const result = await window.__wab_bidi.send({
644
+ id: 1,
645
+ method: 'wab.executeAction',
646
+ params: { name: 'signup', data: {} }
647
+ });
648
+
649
+ // Supported methods:
650
+ // wab.getContext, wab.getActions, wab.executeAction, wab.readContent, wab.getPageInfo
651
+ ```
652
+
653
+ ---
654
+
655
+ ## Real-Time Analytics (WebSocket)
656
+
657
+ Connect to `ws://localhost:3000/ws/analytics` for live analytics. Use the built-in `WABWebSocket` client for automatic reconnection with exponential backoff:
658
+
659
+ ```javascript
660
+ // Recommended: use the auto-reconnecting client
661
+ import { WABWebSocket } from './js/ws-client.js';
662
+
663
+ const ws = new WABWebSocket('jwt-token', 'site-id');
664
+ ws.on('analytic', (data) => console.log(data));
665
+ ws.on('reconnecting', ({ attempt, delay }) => console.log(`Reconnecting #${attempt}...`));
666
+ ws.connect();
667
+ ```
668
+
669
+ ```javascript
670
+ // Or connect manually
671
+ const ws = new WebSocket('ws://localhost:3000/ws/analytics');
672
+ ws.onopen = () => ws.send(JSON.stringify({ type: 'auth', token: 'jwt-token', siteId: 'site-id' }));
673
+ ws.onmessage = (e) => console.log(JSON.parse(e.data));
674
+ ```
675
+
676
+ ### WebSocket Message Protocol
677
+
678
+ **Client Server Messages:**
679
+
680
+ | Message | Fields | Description |
681
+ |---|---|---|
682
+ | `auth` | `type`, `token`, `siteId` | Authenticate and subscribe to a site's events |
683
+
684
+ ```json
685
+ { "type": "auth", "token": "eyJhbGciOi...", "siteId": "uuid-of-site" }
686
+ ```
687
+
688
+ **Server → Client Messages:**
689
+
690
+ | Message Type | Fields | Description |
691
+ |---|---|---|
692
+ | `auth:success` | `type`, `siteId` | Authentication succeeded |
693
+ | `analytic` | `type`, `timestamp`, `actionName`, `agentId`, `success` | Real-time analytics event |
694
+ | `error` | `type`, `message` | Error (invalid auth, malformed message) |
695
+
696
+ ```json
697
+ // Success response
698
+ { "type": "auth:success", "siteId": "uuid-of-site" }
699
+
700
+ // Analytics event
701
+ {
702
+ "type": "analytic",
703
+ "timestamp": "2024-01-15T10:30:00.000Z",
704
+ "actionName": "click-signup",
705
+ "agentId": "agent-123",
706
+ "triggerType": "click",
707
+ "success": true
708
+ }
709
+
710
+ // Error
711
+ { "type": "error", "message": "Invalid message or auth failed" }
712
+ ```
713
+
714
+ **Connection Lifecycle:**
715
+ 1. Connect to `ws://host:port/ws/analytics`
716
+ 2. Send `auth` message with valid JWT and site ID
717
+ 3. Receive `auth:success` confirmation
718
+ 4. Receive `analytic` events as they occur
719
+ 5. Server sends heartbeat pings every 30 seconds — dead connections are cleaned up automatically
720
+
721
+ ---
722
+
723
+ ## CDN & Versioning
724
+
725
+ Scripts are served at versioned URLs for cache-safe deployments:
726
+
727
+ | URL | Description |
728
+ |---|---|
729
+ | `/script/ai-agent-bridge.js` | Default path |
730
+ | `/v1/ai-agent-bridge.js` | Version-pinned (recommended) |
731
+ | `/latest/ai-agent-bridge.js` | Always latest (use with caution) |
732
+
733
+ ---
734
+
735
+ ## Docker
736
+
737
+ ```bash
738
+ # Standard quick start
739
+ docker compose up -d
740
+
741
+ # Production with Nginx + automatic SSL (Let's Encrypt)
742
+ WAB_DOMAIN=yourdomain.com docker compose -f docker-compose.nginx.yml up -d
743
+
744
+ # Build manually
745
+ docker build -t web-agent-bridge .
746
+ docker run -p 3000:3000 \
747
+ -e JWT_SECRET=$(openssl rand -base64 48) \
748
+ -e JWT_SECRET_ADMIN=$(openssl rand -base64 48) \
749
+ -v wab-data:/app/data \
750
+ web-agent-bridge
751
+ ```
752
+
753
+ ### Docker Compose Files
754
+
755
+ | File | Description | Use Case |
756
+ |---|---|---|
757
+ | `docker-compose.yml` | WAB server only | Development, simple deployments |
758
+ | `docker-compose.nginx.yml` | WAB + Nginx + SSL | Production with custom domain |
759
+
760
+ ### Cloudflare Worker (Edge Deployment)
761
+
762
+ Deploy WAB at the edge no server required:
763
+
764
+ ```bash
765
+ # Install Wrangler
766
+ npm install -g wrangler
767
+ wrangler login
768
+
769
+ # Deploy from integrations/cloudflare-worker/
770
+ cd integrations/cloudflare-worker
771
+ wrangler secret put WAB_SERVER_URL
772
+ wrangler secret put WAB_SITE_ID
773
+ wrangler secret put WAB_API_KEY
774
+ wrangler deploy
775
+ ```
776
+
777
+ See [`integrations/cloudflare-worker/README.md`](integrations/cloudflare-worker/README.md) for full guide.
778
+
779
+ ---
780
+
781
+ ## Testing
782
+
783
+ ```bash
784
+ npm test
785
+ ```
786
+
787
+ Tests cover: authentication, site CRUD, config management, license verification, analytics tracking, and static pages.
788
+
789
+ ---
790
+
791
+ ## Agent SDK
792
+
793
+ WAB includes a built-in SDK for building AI agents. See [`sdk/README.md`](sdk/README.md) for full documentation.
794
+
795
+ ```javascript
796
+ const puppeteer = require('puppeteer');
797
+ const { WABAgent } = require('web-agent-bridge/sdk');
798
+
799
+ const browser = await puppeteer.launch();
800
+ const page = await browser.newPage();
801
+ const agent = new WABAgent(page);
802
+
803
+ await agent.navigateAndWait('https://example.com');
804
+ const actions = await agent.getActions();
805
+ await agent.execute('signup', { email: 'user@test.com' });
806
+ await browser.close();
807
+ ```
808
+
809
+ ### SDK Extras
810
+
811
+ The SDK now includes additional helpers for advanced agent workflows:
812
+
813
+ ```javascript
814
+ // Wait for GDPR consent before proceeding
815
+ await agent.waitForConsent();
816
+
817
+ // Discover all actions + page meta
818
+ const disc = await agent.discover();
819
+ console.log(disc.actions, disc.meta);
820
+
821
+ // Run a sequence of actions (stops on first failure by default)
822
+ const results = await agent.runPipeline([
823
+ { name: 'login', params: { email: 'a@b.com', pass: 'secret' } },
824
+ { name: 'addToCart', params: { sku: 'ABC123' } },
825
+ { name: 'checkout' }
826
+ ]);
827
+
828
+ // Run actions in parallel
829
+ const parallel = await agent.executeParallel([
830
+ { name: 'getCartCount' },
831
+ { name: 'getWishlistCount' }
832
+ ]);
833
+
834
+ // Capture screenshot (base64) for vision agents
835
+ const b64 = await agent.screenshot({ fullPage: true });
836
+ ```
837
+
838
+ ---
839
+
840
+ ## Framework Packages
841
+
842
+ ### Vue 3
843
+
844
+ ```bash
845
+ npm install @web-agent-bridge/vue
846
+ ```
847
+
848
+ ```javascript
849
+ import { useWAB, useWABAction } from '@web-agent-bridge/vue';
850
+
851
+ // In setup()
852
+ const { ready, execute } = useWAB({ siteUrl: 'https://example.com' });
853
+ const cart = useWABAction('addToCart');
854
+
855
+ // In template handler
856
+ await cart.run({ sku: 'ABC123' });
857
+ console.log(cart.result.value);
858
+ ```
859
+
860
+ ### Svelte
861
+
862
+ ```bash
863
+ npm install @web-agent-bridge/svelte
864
+ ```
865
+
866
+ ```svelte
867
+ <script>
868
+ import { createWAB, createWABAction } from '@web-agent-bridge/svelte';
869
+
870
+ const wab = createWAB();
871
+ const cart = createWABAction('addToCart');
872
+
873
+ async function add() {
874
+ await cart.run({ sku: 'ABC123' });
875
+ }
876
+ </script>
877
+
878
+ {#if $cart.loading}Adding...{/if}
879
+ {#if $cart.result}Added!{/if}
880
+ <button on:click={add}>Add to Cart</button>
881
+ ```
882
+
883
+ ### LangChain / LangGraph
884
+
885
+ ```bash
886
+ npm install @web-agent-bridge/langchain
887
+ ```
888
+
889
+ ```javascript
890
+ const { WABToolkit } = require('@web-agent-bridge/langchain');
891
+ const { ChatOpenAI } = require('@langchain/openai');
892
+ const { AgentExecutor, createOpenAIToolsAgent } = require('langchain/agents');
893
+
894
+ // HTTP modediscover + execute via the WAB server
895
+ const toolkit = new WABToolkit({ siteUrl: 'https://shop.example.com' });
896
+ const tools = await toolkit.getTools();
897
+
898
+ // Browser mode use with Puppeteer/Playwright
899
+ const { WABAgent } = require('web-agent-bridge/sdk');
900
+ const toolkit2 = new WABToolkit({ agent: new WABAgent(page) });
901
+ const tools2 = await toolkit2.getTools();
902
+
903
+ // Pass tools to any LangChain agent
904
+ const llm = new ChatOpenAI({ model: 'gpt-4o' });
905
+ const agent = await createOpenAIToolsAgent({ llm, tools, prompt });
906
+ const executor = new AgentExecutor({ agent, tools });
907
+ await executor.invoke({ input: 'Add the first product to my cart' });
908
+ ```
909
+
910
+ ---
911
+
912
+ ## GDPR / CCPA Consent
913
+
914
+ Load the consent script after `wab.min.js` to gate agent actions behind user consent:
915
+
916
+ ```html
917
+ <script src="/script/wab.min.js"></script>
918
+ <script src="/script/wab-consent.js"></script>
919
+ <script>
920
+ WABConsent.showBanner({
921
+ policyUrl: '/privacy',
922
+ message: 'Allow AI agents to interact with this page?',
923
+ onAccept: () => WAB.init({ siteUrl: location.origin }),
924
+ onDecline: () => console.log('Agent access declined')
925
+ });
926
+ </script>
927
+ ```
928
+
929
+ SDK agents can check consent programmatically:
930
+
931
+ ```javascript
932
+ const agent = new WABAgent(page);
933
+ const ok = await agent.hasConsent(); // true | false
934
+ await agent.waitForConsent(); // blocks until Allow is clicked
935
+ ```
936
+
937
+ ---
938
+
939
+ ## Agent Examples
940
+
941
+ Ready-to-run agent examples in the [`examples/`](examples/) directory:
942
+
943
+ | File | Description |
944
+ |---|---|
945
+ | `puppeteer-agent.js` | Basic agent using Puppeteer + `window.AICommands` |
946
+ | `bidi-agent.js` | Agent using WebDriver BiDi protocol via `window.__wab_bidi` |
947
+ | `vision-agent.js` | Vision/NLP agent — resolves natural language intents to actions using a local keyword-based resolver (no external API) |
948
+ | `mcp-agent.js` | MCP adapter usage for Claude and GPT with tool discovery and execution |
949
+ | `cross-site-agent.js` | Multi-domain orchestration — compare prices across stores, aggregate data, find best deals |
950
+
951
+ ## Framework + CMS Examples
952
+
953
+ Additional integration examples are available in:
954
+
955
+ | Path | Description |
956
+ |---|---|
957
+ | `examples/next-app-router/` | Next.js App Router integration with `@web-agent-bridge/react` |
958
+ | `examples/shopify-hydrogen/` | Hydrogen storefront integration with practical cart actions |
959
+ | `examples/wordpress-elementor/` | WordPress + Elementor setup with schema-assisted actions |
960
+ | `examples/saas-dashboard/` | Notion-style SaaS dashboard actions for KPI read + workflow triggers |
961
+
962
+ ```bash
963
+ node examples/puppeteer-agent.js http://localhost:3000
964
+ node examples/bidi-agent.js http://localhost:3000
965
+ node examples/vision-agent.js http://localhost:3000
966
+ ```
967
+
968
+ ---
969
+
970
+ ## Multi-Database Support
971
+
972
+ WAB defaults to SQLite but supports PostgreSQL and MySQL via database adapters.
973
+
974
+ ```bash
975
+ # SQLite (defaultno setup needed)
976
+ npm start
977
+
978
+ # PostgreSQL
979
+ npm install pg
980
+ DB_ADAPTER=postgresql DATABASE_URL=postgres://user:pass@localhost:5432/wab npm start
981
+
982
+ # MySQL
983
+ npm install mysql2
984
+ DB_ADAPTER=mysql DATABASE_URL=mysql://user:pass@localhost:3306/wab npm start
985
+ ```
986
+
987
+ ### When to Choose Which Database
988
+
989
+ | Scenario | Recommended DB | Why |
990
+ |---|---|---|
991
+ | Local dev / prototyping | SQLite | Zero setup, single file, instant |
992
+ | Small production (< 100 sites) | SQLite | Fast, no external dependencies |
993
+ | Medium production (100-10K sites) | PostgreSQL | Better concurrency, JSONB support |
994
+ | Large / enterprise production | PostgreSQL | Replication, backups, scalability |
995
+ | Existing MySQL infrastructure | MySQL | Integrate with what you already use |
996
+
997
+ See [`server/models/adapters/`](server/models/adapters/) for adapter implementations.
998
+
999
+ ---
1000
+
1001
+ ## Security Architecture
1002
+
1003
+ WAB implements defense-in-depth to protect the bridge from misuse:
1004
+
1005
+ ### Secure License Exchange
1006
+
1007
+ 1. **Dashboard snippet (recommended):** `siteId` + `configEndpoint`. The browser sends `POST /api/license/token` with `{ siteId }`; the server checks **Origin** against the site’s registered domain and issues a session token.
1008
+ 2. **Legacy:** `licenseKey` + `configEndpoint` (or deprecated `_licenseKey`) still works for token exchange but should not be embedded in public HTML.
1009
+ 3. **Session** is domain-locked (1h TTL); **analytics** use `sessionToken` on `POST /api/license/track` (not the license key).
1010
+ 4. **WebSocket** `/ws/analytics`: user JWT must **own** the `siteId`; admin JWT may observe any site.
1011
+
1012
+ ```
1013
+ Client Server
1014
+ │── POST /api/license/token ──→│ { siteId } + Origin header
1015
+ │ │ domain match → sessionToken
1016
+ │←── { sessionToken, tier } ──│
1017
+ │── POST /api/license/track ─→│ { sessionToken, actionName } + Origin
1018
+ ```
1019
+
1020
+ **Production:** set `JWT_SECRET`, `JWT_SECRET_ADMIN`, `STRIPE_WEBHOOK_SECRET`, `ALLOWED_ORIGINS`, and create the first admin via `BOOTSTRAP_ADMIN_*` or `node scripts/create-admin.js`.
1021
+
1022
+ ### Security Sandbox
1023
+
1024
+ Every bridge instance runs inside a `SecuritySandbox` that provides:
1025
+
1026
+ - **Session tokens** Unique cryptographic token per session prevents replay attacks
1027
+ - **Origin validation** — Only whitelisted origins can interact with the bridge
1028
+ - **Command validation** — All commands are validated for format, length, and blocklist
1029
+ - **Audit logging** — Every action is logged with timestamp, agent fingerprint, and status
1030
+ - **Escalation protection** — Attempts to access higher-tier features trigger automatic lockdown after 5 violations
1031
+ - **Auto-lockdown** — Bridge becomes read-only when security violations are detected
1032
+
1033
+ ```javascript
1034
+ // Get security status
1035
+ const info = bridge.getPageInfo();
1036
+ console.log(info.security);
1037
+ // { sandboxActive: true, locked: false, sessionToken: "a3f2..." }
1038
+
1039
+ // View audit log
1040
+ const audit = bridge.security.getAuditLog(20);
1041
+ ```
1042
+
1043
+ ### Selector Restrictions
1044
+
1045
+ Block sensitive page sections from agent access:
1046
+
1047
+ ```javascript
1048
+ window.AIBridgeConfig = {
1049
+ restrictions: {
1050
+ blockedSelectors: [".private", "[data-private]", "#payment-form"],
1051
+ allowedSelectors: [".public-content"]
1052
+ }
1053
+ };
1054
+ ```
1055
+
1056
+ ---
1057
+
1058
+ ## Self-Healing Selectors
1059
+
1060
+ Modern SPAs frequently change their DOM structure. WAB's self-healing system ensures selectors keep working even when the page changes:
1061
+
1062
+ ### How It Works
1063
+
1064
+ 1. **Fingerprinting** When actions are discovered, WAB stores a rich fingerprint of each element (tag, id, classes, text, ARIA attributes, position)
1065
+ 2. **7-Strategy Resolution** When a selector breaks, WAB tries these strategies in order:
1066
+ - `data-wab-id` attribute (most stable — add to your HTML)
1067
+ - `data-testid` attribute
1068
+ - Element ID
1069
+ - `aria-label` (semantic, usually survives redesigns)
1070
+ - `name` attribute
1071
+ - Fuzzy text matching (bigram similarity > 70%)
1072
+ - Role + position heuristic
1073
+ 3. **SPA Observer** — A `MutationObserver` watches for DOM changes and automatically re-discovers actions with a 500ms debounce
1074
+
1075
+ ```javascript
1076
+ // Check healing stats
1077
+ const info = bridge.getPageInfo();
1078
+ console.log(info.selfHealing);
1079
+ // { tracked: 12, healed: 3, failed: 0 }
1080
+
1081
+ // Listen for healing events
1082
+ bridge.events.on('selector:healed', (data) => {
1083
+ console.log(`Healed: ${data.action} via ${data.strategy}`);
1084
+ });
1085
+ ```
1086
+
1087
+ ### Best Practices for Site Owners
1088
+
1089
+ Add `data-wab-id` attributes to critical elements for maximum stability:
1090
+
1091
+ ```html
1092
+ <button data-wab-id="signup-btn">Sign Up</button>
1093
+ <form data-wab-id="login-form">...</form>
1094
+ ```
1095
+
1096
+ ---
1097
+
1098
+ ## Stealth Mode
1099
+
1100
+ For sites with anti-bot protection, WAB can simulate human-like interaction patterns. **Stealth mode requires explicit consent** to ensure ethical use.
1101
+
1102
+ ```javascript
1103
+ window.AIBridgeConfig = {
1104
+ stealth: {
1105
+ enabled: true,
1106
+ consent: true // Required confirms site owner authorizes human-like patterns
1107
+ }
1108
+ };
1109
+ ```
1110
+
1111
+ > **⚠️ Ethical Use Policy:** Stealth mode is designed for accessibility and testing on your own websites. Using it to bypass security controls on sites you do not own may violate terms of service and applicable laws.
1112
+
1113
+ When enabled, all interactions use:
1114
+
1115
+ | Feature | Description |
1116
+ |---|---|
1117
+ | **Mouse event chain** | `mouseover → mouseenter → mousemove → mousedown → mouseup → click` with natural coordinates |
1118
+ | **Typing simulation** | Character-by-character input with 30-120ms delays per keystroke |
1119
+ | **Scroll easing** | Multi-step scrolling with variable speed |
1120
+ | **Random delays** | 50-400ms natural pauses between actions |
1121
+
1122
+ ```javascript
1123
+ // Enable/disable at runtime (consent required)
1124
+ bridge.stealth.enable(true); // true = consent granted
1125
+ bridge.stealth.disable();
1126
+ ```
1127
+
1128
+ ---
1129
+
1130
+ ## CLI
1131
+
1132
+ Install globally or use via npx:
1133
+
1134
+ ```bash
1135
+ # Run the server
1136
+ npx web-agent-bridge start
1137
+ npx web-agent-bridge start --port 8080
1138
+
1139
+ # Initialize a new project
1140
+ npx web-agent-bridge init
1141
+ ```
1142
+
1143
+ ---
1144
+
1145
+ ## Environment Variables
1146
+
1147
+ See `.env.example`. Important:
1148
+
1149
+ ```
1150
+ PORT=3000
1151
+ NODE_ENV=development
1152
+ JWT_SECRET=long-random-user-signing-secret
1153
+ JWT_SECRET_ADMIN=long-random-admin-signing-secret # required in production
1154
+ ALLOWED_ORIGINS=http://localhost:3000,https://your-app.com
1155
+ STRIPE_WEBHOOK_SECRET=whsec_... # Stripe webhook verify
1156
+ CREDENTIALS_ENCRYPTION_KEY=... # optional SMTP password encryption
1157
+ DB_ADAPTER=sqlite
1158
+ DATABASE_URL=
1159
+ ```
1160
+
1161
+ First admin: set `BOOTSTRAP_ADMIN_EMAIL` / `BOOTSTRAP_ADMIN_PASSWORD` when the `admins` table is empty, or run `node scripts/create-admin.js <email> <password>`.
1162
+
1163
+ ---
1164
+
1165
+ ## Real-time Negotiation Engine
1166
+
1167
+ Site owners define negotiation rules. AI agents negotiate prices in multi-round sessions:
1168
+
1169
+ ```javascript
1170
+ // Agent opens a negotiation session
1171
+ const session = await fetch('/api/sovereign/negotiation/sessions', {
1172
+ method: 'POST',
1173
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1174
+ body: JSON.stringify({
1175
+ siteId: 'site-uuid',
1176
+ agentId: 'agent-id',
1177
+ originalPrice: 49.99,
1178
+ itemId: 'product-123',
1179
+ itemName: 'Olive Oil 1L'
1180
+ })
1181
+ }).then(r => r.json());
1182
+
1183
+ // Agent makes a counter-offer
1184
+ const counter = await fetch(`/api/sovereign/negotiation/sessions/${session.sessionId}/propose`, {
1185
+ method: 'POST',
1186
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1187
+ body: JSON.stringify({
1188
+ agentId: 'agent-id',
1189
+ proposedPrice: 39.99
1190
+ })
1191
+ }).then(r => r.json());
1192
+ // → { status: 'accepted', finalPrice: 42.49, message: 'Deal! ...' }
1193
+ ```
1194
+
1195
+ ### Condition Types
1196
+ | Condition | Description |
1197
+ |---|---|
1198
+ | `bulk_quantity` | Discounts based on order quantity |
1199
+ | `loyalty` | Rewards for repeat customers |
1200
+ | `time_based` | Happy hour / flash sale windows |
1201
+ | `first_purchase` | Welcome discount for new buyers |
1202
+ | `cart_value` | Minimum cart value threshold |
1203
+ | `seasonal` | Date-range seasonal promotions |
1204
+ | `membership` | Member-only pricing |
1205
+ | `referral` | Referral-based discounts |
1206
+
1207
+ ---
1208
+
1209
+ ## Anti-Hallucination Shield
1210
+
1211
+ Cross-verification engine that catches AI hallucinations before they reach users:
1212
+
1213
+ ```javascript
1214
+ // Verify a price
1215
+ const result = await fetch('/api/sovereign/verify/price', {
1216
+ method: 'POST',
1217
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1218
+ body: JSON.stringify({
1219
+ siteId: 'site-uuid',
1220
+ domValue: 29.99,
1221
+ visionValue: 29.99,
1222
+ category: 'electronics',
1223
+ itemName: 'USB Cable'
1224
+ })
1225
+ }).then(r => r.json());
1226
+ // → { verified: true, confidence: 0.98, severity: 'none', layers: { dom_vision: { match: true }, ... } }
1227
+
1228
+ // Verify text content
1229
+ const textResult = await fetch('/api/sovereign/verify/text', {
1230
+ method: 'POST',
1231
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1232
+ body: JSON.stringify({
1233
+ siteId: 'site-uuid',
1234
+ source: 'dom',
1235
+ value: 'Free shipping on orders over $50',
1236
+ expected: 'Free shipping on orders over $50'
1237
+ })
1238
+ }).then(r => r.json());
1239
+ // → { verified: true, similarity: 1.0 }
1240
+ ```
1241
+
1242
+ ### Verification Layers
1243
+ 1. **DOM vs Vision** — Compares DOM-extracted price with screenshot OCR value
1244
+ 2. **Market Benchmark** — Validates against historical price benchmarks for the category
1245
+ 3. **Temporal Consistency** — Checks if price changed suspiciously since last verification
1246
+ 4. **Composite Score** — Weighted combination of all layers with severity classification
1247
+
1248
+ ---
1249
+
1250
+ ## Community Agent Hub
1251
+
1252
+ Pre-built YAML agent templates for common use cases. Run any template from the CLI:
1253
+
1254
+ ```bash
1255
+ # List available templates
1256
+ npx wab-agent templates
1257
+
1258
+ # Run a template
1259
+ npx wab-agent run olive-oil-tunisia --budget 50 --region tunis
1260
+
1261
+ # Run with custom server
1262
+ npx wab-agent run hotel-direct-booking --server https://yourserver.com --checkin 2025-01-15
1263
+ ```
1264
+
1265
+ ### Available Templates
1266
+ | Template | Description |
1267
+ |---|---|
1268
+ | `olive-oil-tunisia` | Find olive oil from small Tunisian farms |
1269
+ | `hotel-direct-booking` | Book hotels directly, bypass aggregators |
1270
+ | `artisan-marketplace` | Handmade products from independent artisans |
1271
+ | `grocery-price-compare` | Compare grocery prices across local stores |
1272
+ | `freelancer-direct` | Find freelancers without platform fees |
1273
+ | `restaurant-direct` | Order from restaurants without delivery apps |
1274
+ | `book-price-scout` | Find books from indie bookstores |
1275
+ | `flight-deal-hunter` | Find flights direct from airlines |
1276
+ | `electronics-price-tracker` | Track electronics prices with history |
1277
+ | `local-services` | Find local service providers |
1278
+ | `organic-farm-fresh` | Organic produce direct from farms |
1279
+
1280
+ ### Create Your Own Template
1281
+
1282
+ ```yaml
1283
+ name: my-custom-agent
1284
+ description: My custom agent template
1285
+ goal: Find the best deals on custom products
1286
+ version: "1.0"
1287
+ target_sites:
1288
+ - https://example.com
1289
+ parameters:
1290
+ budget:
1291
+ type: number
1292
+ default: 100
1293
+ description: Maximum budget
1294
+ actions:
1295
+ - name: discover
1296
+ wab_action: discover
1297
+ - name: search
1298
+ wab_action: execute
1299
+ action_name: search
1300
+ params:
1301
+ query: "{{keyword}}"
1302
+ - name: negotiate
1303
+ wab_action: negotiate
1304
+ params:
1305
+ item_id: "{{item_id}}"
1306
+ max_price: "{{budget}}"
1307
+ negotiation:
1308
+ enabled: true
1309
+ max_rounds: 3
1310
+ accept_threshold: 0.85
1311
+ fairness_rules:
1312
+ - Prefer independent sellers over large platforms
1313
+ - Verify all prices before purchase
1314
+ ```
1315
+
1316
+ ---
1317
+
1318
+ ## Commander Agent System
1319
+
1320
+ The Commander is a local-first mission orchestration engine that decomposes high-level goals into task DAGs and distributes work across specialized agents:
1321
+
1322
+ ```javascript
1323
+ // Create a mission
1324
+ const mission = await fetch('/api/commander/missions', {
1325
+ method: 'POST',
1326
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1327
+ body: JSON.stringify({
1328
+ goal: 'Find the cheapest olive oil across 5 stores',
1329
+ strategy: 'parallel',
1330
+ agents: ['researcher-1', 'analyst-1', 'negotiator-1']
1331
+ })
1332
+ }).then(r => r.json());
1333
+
1334
+ // Launch mission
1335
+ await fetch(`/api/commander/missions/${mission.id}/launch`, { method: 'POST', headers: { 'Authorization': 'Bearer ' + token } });
1336
+
1337
+ // Check status
1338
+ const status = await fetch(`/api/commander/missions/${mission.id}`, { headers: { 'Authorization': 'Bearer ' + token } }).then(r => r.json());
1339
+ // → { status: 'completed', tasks: [...], result: { bestPrice: 12.99, store: 'farm-direct' } }
1340
+ ```
1341
+
1342
+ ### Commander Capabilities
1343
+ | Feature | Description |
1344
+ |---|---|
1345
+ | **Mission Decomposition** | Breaks high-level goals into task DAGs with dependency tracking |
1346
+ | **Agent Registry** | Tracks agent capabilities, availability, and performance history |
1347
+ | **Parallel Execution** | Runs independent tasks concurrently across multiple agents |
1348
+ | **Learning Integration** | Records outcomes for reinforcement learning feedback |
1349
+ | **Edge Coordination** | Distributes compute-heavy tasks to edge nodes |
1350
+
1351
+ ---
1352
+
1353
+ ## Edge Compute System
1354
+
1355
+ Transform every user device into a sovereign AI node — no central cloud required:
1356
+
1357
+ ```javascript
1358
+ // Register a device as an edge node
1359
+ const node = await fetch('/api/commander/edge/nodes', {
1360
+ method: 'POST',
1361
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1362
+ body: JSON.stringify({
1363
+ name: 'my-laptop',
1364
+ capabilities: { cpu: 8, ram: 16384, gpu: true },
1365
+ supportedTasks: ['text-inference', 'vision-analysis', 'price-comparison']
1366
+ })
1367
+ }).then(r => r.json());
1368
+
1369
+ // List available edge nodes
1370
+ const nodes = await fetch('/api/commander/edge/nodes', { headers: { 'Authorization': 'Bearer ' + token } }).then(r => r.json());
1371
+ ```
1372
+
1373
+ | Feature | Description |
1374
+ |---|---|
1375
+ | **Hardware Profiling** | Detects CPU, RAM, GPU capabilities per node |
1376
+ | **AES-256-GCM Encryption** | All inter-node data is encrypted end-to-end |
1377
+ | **Weighted Load Balancing** | Routes tasks based on hardware + availability scores |
1378
+ | **Heartbeat Health Monitoring** | Auto-failover when nodes become unresponsive |
1379
+ | **Swarm Formation** | Capability-based clustering of nodes for distributed tasks |
1380
+
1381
+ ---
1382
+
1383
+ ## Swarm Execution Engine
1384
+
1385
+ Launch multiple agents in parallel to solve a single task, then intelligently merge their outputs:
1386
+
1387
+ ```javascript
1388
+ // Launch a swarm task
1389
+ const swarm = await fetch('/api/premium/v2/swarm/execute', {
1390
+ method: 'POST',
1391
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1392
+ body: JSON.stringify({
1393
+ task: 'Find best laptop deals under $1000',
1394
+ strategy: 'parallel', // parallel | sequential | hybrid
1395
+ agentCount: 4,
1396
+ roles: ['researcher', 'analyst', 'price-checker', 'reviewer'],
1397
+ mergeStrategy: 'best-score' // best-score | fairness-weighted | consensus
1398
+ })
1399
+ }).then(r => r.json());
1400
+ // { swarmId: '...', agents: 4, status: 'running' }
1401
+
1402
+ // Get merged results
1403
+ const results = await fetch(`/api/premium/v2/swarm/${swarm.swarmId}`, {
1404
+ headers: { 'Authorization': 'Bearer ' + token }
1405
+ }).then(r => r.json());
1406
+ // → { status: 'completed', merged: { bestDeal: {...}, confidence: 0.94 } }
1407
+ ```
1408
+
1409
+ ---
1410
+
1411
+ ## Fairness Engine
1412
+
1413
+ A neutrality layer ensuring AI agents give equal opportunity to small and large sites, preventing monopolistic concentration of agent traffic:
1414
+
1415
+ ```javascript
1416
+ // Fairness-weighted search (instead of pure relevance)
1417
+ const results = await fetch('/api/discovery/search?q=olive+oil&fairness=true', {
1418
+ headers: { 'Authorization': 'Bearer ' + token }
1419
+ }).then(r => r.json());
1420
+ // Small farms ranked alongside Amazon — weighted by neutrality score, not just SEO
1421
+
1422
+ // Register site in WAB directory
1423
+ await fetch('/api/discovery/register', {
1424
+ method: 'POST',
1425
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1426
+ body: JSON.stringify({
1427
+ domain: 'small-farm.example.com',
1428
+ category: 'food',
1429
+ commissionRate: 0, // Direct — no middleman
1430
+ independentSeller: true
1431
+ })
1432
+ }).then(r => r.json());
1433
+ ```
1434
+
1435
+ ### How Neutrality Scoring Works
1436
+ | Factor | Weight | Description |
1437
+ |---|---|---|
1438
+ | **Configuration completeness** | 25% | How well the site has configured WAB |
1439
+ | **Trust score** | 25% | Reputation attestations from the agent network |
1440
+ | **Transparency** | 25% | Commission disclosure, pricing clarity |
1441
+ | **Responsiveness** | 25% | API response time, uptime, action success rate |
1442
+
1443
+ Small independent sites with good WAB configuration can outrank large platforms on fairness-weighted searches.
1444
+
1445
+ ---
1446
+
1447
+ ## Agent Memory System
1448
+
1449
+ Persistent behavioral memory allowing agents to remember user preferences, learn patterns, and build associations:
1450
+
1451
+ ```javascript
1452
+ // Store a memory
1453
+ await fetch('/api/premium/v2/memory', {
1454
+ method: 'POST',
1455
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1456
+ body: JSON.stringify({
1457
+ agentId: 'agent-1',
1458
+ type: 'preference', // preference | interaction | correction | pattern
1459
+ category: 'purchase', // navigation | purchase | search | form | custom
1460
+ key: 'preferred-brand',
1461
+ value: 'organic-only',
1462
+ importance: 0.9
1463
+ })
1464
+ }).then(r => r.json());
1465
+
1466
+ // Recall memories
1467
+ const memories = await fetch('/api/premium/v2/memory/agent-1?category=purchase&limit=10', {
1468
+ headers: { 'Authorization': 'Bearer ' + token }
1469
+ }).then(r => r.json());
1470
+
1471
+ // Create associations
1472
+ await fetch('/api/premium/v2/memory/associate', {
1473
+ method: 'POST',
1474
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1475
+ body: JSON.stringify({
1476
+ sourceId: 'memory-1',
1477
+ targetId: 'memory-2',
1478
+ relationship: 'leads_to' // leads_to | similar_to | replaces | depends_on
1479
+ })
1480
+ }).then(r => r.json());
1481
+ ```
1482
+
1483
+ ---
1484
+
1485
+ ## Vision Analysis Service
1486
+
1487
+ Multi-provider screenshot analysis for interactive element detection and data extraction:
1488
+
1489
+ ```javascript
1490
+ // Analyze a screenshot
1491
+ const analysis = await fetch('/api/premium/v2/vision/analyze', {
1492
+ method: 'POST',
1493
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1494
+ body: JSON.stringify({
1495
+ screenshot: 'base64-encoded-image...',
1496
+ provider: 'auto', // auto | local | openai | anthropic | ollama
1497
+ extractElements: true
1498
+ })
1499
+ }).then(r => r.json());
1500
+ // { elements: [{ type: 'button', text: 'Add to Cart', selector: '#add-btn', confidence: 0.95, bbox: [120, 340, 200, 40] }] }
1501
+
1502
+ // Extract interactive elements only
1503
+ const elements = await fetch('/api/premium/v2/vision/elements', {
1504
+ method: 'POST',
1505
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1506
+ body: JSON.stringify({ screenshot: 'base64...', types: ['button', 'input', 'link'] })
1507
+ }).then(r => r.json());
1508
+ ```
1509
+
1510
+ ### Supported Vision Providers
1511
+ | Provider | Local? | Description |
1512
+ |---|---|---|
1513
+ | **Moondream** | ✅ | Lightweight local vision model |
1514
+ | **Ollama** | | Local models via Ollama (llava, bakllava) |
1515
+ | **OpenAI** | | GPT-4 Vision |
1516
+ | **Anthropic** | ❌ | Claude Vision |
1517
+
1518
+ ---
1519
+
1520
+ ## Plugin Architecture
1521
+
1522
+ Dynamic plugin system allowing third-party extensions:
1523
+
1524
+ ```javascript
1525
+ // List available plugins
1526
+ const plugins = await fetch('/api/premium/v2/plugins', {
1527
+ headers: { 'Authorization': 'Bearer ' + token }
1528
+ }).then(r => r.json());
1529
+
1530
+ // Install a plugin for your site
1531
+ await fetch('/api/premium/v2/plugins/price-alert/install', {
1532
+ method: 'POST',
1533
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1534
+ body: JSON.stringify({ siteId: 'site-uuid', config: { threshold: 10 } })
1535
+ }).then(r => r.json());
1536
+
1537
+ // Execute a plugin hook
1538
+ await fetch('/api/premium/v2/plugins/price-alert/hooks', {
1539
+ method: 'POST',
1540
+ headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' },
1541
+ body: JSON.stringify({ hook: 'onPriceChange', data: { oldPrice: 49.99, newPrice: 39.99 } })
1542
+ }).then(r => r.json());
1543
+ ```
1544
+
1545
+ ---
1546
+
1547
+ ## Premium Traffic Intelligence
1548
+
1549
+ Advanced bot detection and traffic profiling for premium sites:
1550
+
1551
+ | Capability | Description |
1552
+ |---|---|
1553
+ | **30+ Bot Types** | Detects Google, Bing, ChatGPT, Claude, Perplexity, and more |
1554
+ | **Behavioral Profiling** | Classifies agent behavior by signature, platform, and type |
1555
+ | **Anomaly Detection** | Spike detection and pattern analysis for unusual traffic |
1556
+ | **Security Exploit Detection** | Flags SQL injection, XSS patterns, and rate anomalies |
1557
+ | **Webhook Alerting** | Triggers webhooks on suspicious activity |
1558
+ | **Compliance Audit Logging** | Full audit trail for regulatory compliance |
1559
+
1560
+ ---
1561
+
1562
+ ## WAB-MCP Adapter
1563
+
1564
+ Expose WAB site capabilities as [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) tools for Claude, GPT, Gemini, and other MCP-compatible AI agents:
1565
+
1566
+ ```javascript
1567
+ const { WABMCPAdapter } = require('wab-mcp-adapter');
1568
+
1569
+ // Create adapter for a WAB-enabled site
1570
+ const adapter = new WABMCPAdapter({
1571
+ siteUrl: 'https://shop.example.com',
1572
+ transport: 'http' // http | websocket | direct
1573
+ });
1574
+
1575
+ // Get MCP tool definitions
1576
+ const tools = await adapter.getTools();
1577
+ // [{ name: 'discover', description: '...', inputSchema: {...} }, ...]
1578
+
1579
+ // Execute via MCP
1580
+ const result = await adapter.executeTool('execute_action', {
1581
+ name: 'addToCart',
1582
+ params: { sku: 'ABC123' }
1583
+ });
1584
+ ```
1585
+
1586
+ ### Built-in MCP Tools
1587
+ | Tool | Description |
1588
+ |---|---|
1589
+ | `discover` | Auto-discover available actions on a WAB site |
1590
+ | `get_actions` | Get list of all actions with parameters |
1591
+ | `execute_action` | Execute a specific action |
1592
+ | `read_content` | Read content from the page |
1593
+ | `get_page_info` | Get page metadata |
1594
+ | `fairness_search` | Search the WAB directory with fairness weighting |
1595
+ | `authenticate` | Authenticate an agent with the site |
1596
+
1597
+ ---
1598
+
1599
+ ## WAB Browser (Desktop)
1600
+
1601
+ Standalone Electron desktop browser with built-in privacy and fairness features:
1602
+
1603
+ - **Ad Blocker** — 80+ blocked ad domains + URL pattern matching + cosmetic CSS rules
1604
+ - **Scam Shield** — Detects suspicious TLDs and brand-name spoofing in URLs
1605
+ - **Fairness Ranking** — Prioritizes independent sites, flags big-tech concentration
1606
+ - **Agent Chat** — Built-in AI assistant panel for browsing help
1607
+ - **Notifications** — Page analysis with safety and fairness alerts
1608
+ - **Ghost Mode** Privacy-first browsing with no tracking
1609
+ - **Smart Search** — WAB Search integration for independent search
1610
+ - **Desktop/Mobile Toggle** Switch user-agent for responsive testing
1611
+
1612
+ ```bash
1613
+ # Run the WAB Browser
1614
+ cd wab-browser
1615
+ npm install
1616
+ npx electron .
1617
+
1618
+ # Build installer (Windows NSIS)
1619
+ npm run build:win
1620
+ ```
1621
+
1622
+ ---
1623
+
1624
+ ## PWA Browser (Mobile)
1625
+
1626
+ Progressive Web App browser for Android and iOS — installable from any mobile browser:
1627
+
1628
+ - **Ad Blocker** — 80+ ad domain blacklist + URL pattern matching
1629
+ - **Scam Detection** Suspicious TLD alerts and brand-name spoofing checks
1630
+ - **Fairness Mode** — Filters big-tech sites to promote independent alternatives
1631
+ - **Offline-First** Service worker caches shell assets for offline launch
1632
+ - **WAB Search** Independent search engine with multi-source aggregation, autocomplete, and trending
1633
+ - **AI Agent Chat** Real AI agent (OpenAI / local Ollama / smart fallback) with conversation memory, web search, and security analysis
1634
+
1635
+ Install at: `https://yourserver.com/pwa/`
1636
+
1637
+ ---
1638
+
1639
+ ## WordPress Plugin
1640
+
1641
+ Native WordPress plugin for adding WAB support to any WordPress site.
1642
+
1643
+ ### Standard Plugin (Deactivatable)
1644
+
1645
+ ```bash
1646
+ # Install manually
1647
+ cp -r web-agent-bridge-wordpress/ /wp-content/plugins/web-agent-bridge/
1648
+
1649
+ # Or install via WP-CLI from WordPress.org
1650
+ wp plugin install web-agent-bridge --activate
1651
+ ```
1652
+
1653
+ | Feature | Description |
1654
+ |---|---|
1655
+ | **Settings Page** | Configure API base URL, site ID, permissions |
1656
+ | **Per-Page Actions** | Meta box for adding custom WAB actions per page/post |
1657
+ | **Discovery Document** | Auto-generates WAB discovery endpoint |
1658
+ | **Dashboard Widget** | Shows WAB status and agent interaction stats |
1659
+ | **Shortcode** | `[wab_bridge]` shortcode for embedding WAB on specific pages |
1660
+ | **Hooks API** | `wab_before_action` / `wab_after_action` for custom logic |
1661
+
1662
+ ### Must-Use Plugin (Always Active, Cannot Be Deactivated)
1663
+
1664
+ For hosting providers and managed WordPress environments:
1665
+
1666
+ ```bash
1667
+ # One-command install (requires WP-CLI)
1668
+ bash web-agent-bridge-wordpress/mu-plugin/install-wab-mu.sh --wp-path /var/www/html
1669
+
1670
+ # Or manually copy to mu-plugins/
1671
+ cp web-agent-bridge-wordpress/mu-plugin/web-agent-bridge-mu.php /wp-content/mu-plugins/
1672
+ wp rewrite flush
1673
+ ```
1674
+
1675
+ The MU plugin is **always loaded by WordPress core** before any regular plugin — it cannot be deactivated from the admin panel. When the full plugin is absent, it runs a minimal fallback that serves `/.well-known/wab.json` and injects the WAB script.
1676
+
1677
+ **wp-config.php overrides:**
1678
+ ```php
1679
+ define( 'WAB_MU_API_BASE', 'https://wab.yourdomain.com' ); // Custom WAB server
1680
+ define( 'WAB_MU_DISCOVERY_CACHE_TTL', 600 ); // Cache TTL in seconds
1681
+ ```
1682
+
1683
+ See [`web-agent-bridge-wordpress/README.md`](web-agent-bridge-wordpress/README.md) and [`web-agent-bridge-wordpress/mu-plugin/README.md`](web-agent-bridge-wordpress/mu-plugin/README.md) for full documentation.
1684
+
1685
+ ---
1686
+
1687
+ ## WAB Protocol Specification
1688
+
1689
+ The full normative specification is available at [`docs/SPEC.md`](docs/SPEC.md):
1690
+
1691
+ | Layer | Description |
1692
+ |---|---|
1693
+ | **Protocol Layer** | Discovery document format, command protocol, fairness protocol |
1694
+ | **Runtime Layer** | `window.AICommands` interface, auto-discovery engine, security sandbox |
1695
+ | **Transport Layer** | JavaScript global, WebSocket, HTTP, WebDriver BiDi, MCP |
1696
+
1697
+ ### DNS Discovery
1698
+
1699
+ WAB supports DNS-level discovery, allowing AI agents to find your capabilities document without any HTTP request. Add a single TXT record to your domain:
1700
+
1701
+ ```
1702
+ _wab.yourdomain.com TXT "v=wab1; endpoint=https://yourdomain.com/.well-known/wab.json"
1703
+ ```
1704
+
1705
+ Full setup guides for Cloudflare, cPanel, GoDaddy, and Namecheap are available in:
1706
+ - [DNS-DISCOVERY.md](DNS-DISCOVERY.md) — English
1707
+ - [DNS-DISCOVERY.ar.md](DNS-DISCOVERY.ar.md) — العربية
1708
+
1709
+ ### 5-Phase Lifecycle
1710
+ 1. **Discover** — Agent finds WAB discovery document (`.well-known/wab.json` or script tag)
1711
+ 2. **Authenticate** — Agent exchanges `siteId` for session token
1712
+ 3. **Plan** — Agent reads available actions and page metadata
1713
+ 4. **Execute** — Agent runs actions through the bridge
1714
+ 5. **Confirm** — Results are verified via Anti-Hallucination Shield
1715
+
1716
+ ---
1717
+
1718
+ ## License
1719
+
1720
+ WAB uses an **Open Core** dual-license model:
1721
+
1722
+ | Layer | License | Components |
1723
+ |-------|---------|------------|
1724
+ | **Open Source** | MIT | SDK, Widget, MCP Server, Trust Protocol Spec, Browser Extension, Protocol module, Public module APIs, install.sh, Cloudflare Worker, Netlify Functions, Vercel config, Railway config |
1725
+ | **Open Source** | GPL-2.0 | WordPress Plugin (standard + Must-Use), WP-CLI installer |
1726
+ | **Proprietary (Free)** | Closed / Free | Detection Engine, Threat DB, WAB Score Model, Fairness Algorithm, Neural Engine, Dark Pattern Engine, Gov Engine, Notary Engine, Firewall Engine, Price Engine, Bargaining Engine, Bounty Verification, Affiliate DB |
1727
+ | **Commercial** | Paid API | API Gateway modules (Free/Pro/Business/Enterprise tiers), Data Marketplace, AI Safety Layer, Enterprise SDK |
1728
+
1729
+ ### Integration Components License Summary
1730
+
1731
+ | Integration | File | License | Notes |
1732
+ |---|---|---|---|
1733
+ | Linux Installer | `integrations/install/install.sh` | MIT | Fully open source |
1734
+ | Docker | `Dockerfile`, `docker-compose*.yml` | MIT | Fully open source |
1735
+ | Cloudflare Worker | `integrations/cloudflare-worker/worker.js` | MIT | Fully open source |
1736
+ | Netlify Functions | `integrations/netlify/functions/` | MIT | Fully open source |
1737
+ | Vercel Config | `integrations/vercel/vercel.json` | MIT | Fully open source |
1738
+ | Railway Config | `integrations/railway/railway.json` | MIT | Fully open source |
1739
+ | WordPress Plugin | `web-agent-bridge-wordpress/` | GPL-2.0 | Fully open source |
1740
+ | WordPress MU Plugin | `web-agent-bridge-wordpress/mu-plugin/` | GPL-2.0 | Fully open source |
1741
+ | WAB Server Core | `server/` | Open Core | Free tier + paid features |
1742
+ | WAB Browser | `wab-browser/` | Proprietary (Free) | Free to use, source private |
1743
+ | DNS Discovery Docs | `DNS-DISCOVERY.md` | MIT | Fully open source |
1744
+
1745
+ See [LICENSE](LICENSE) for full details.
1746
+
1747
+ ## Contributors ✨
1748
+
1749
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
1750
+ <!-- prettier-ignore-start -->
1751
+ <!-- markdownlint-disable -->
1752
+ <table>
1753
+ <tbody>
1754
+ <tr>
1755
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/abokenan444"><img src="https://avatars.githubusercontent.com/u/abokenan444?s=100" width="100px;" alt="WAB Founder"/><br /><sub><b>WAB Founder</b></sub></a><br /><a href="https://github.com/abokenan444/web-agent-bridge/commits?author=abokenan444" title="Code">💻</a> <a href="#ideas-abokenan444" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/abokenan444/web-agent-bridge/commits?author=abokenan444" title="Documentation">📖</a> <a href="#design-abokenan444" title="Design">🎨</a> <a href="#maintenance-abokenan444" title="Maintenance">🚧</a> <a href="#projectManagement-abokenan444" title="Project Management">📆</a></td>
1756
+ </tr>
1757
+ </tbody>
1758
+ </table>
1759
+
1760
+ <!-- markdownlint-restore -->
1761
+ <!-- prettier-ignore-end -->
1762
+
1763
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
1764
+