web-agent-bridge 3.0.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.
- package/LICENSE +72 -21
- package/README.ar.md +1286 -1073
- package/README.md +1764 -1535
- package/bin/agent-runner.js +474 -474
- package/bin/cli.js +237 -138
- package/bin/wab.js +80 -80
- package/examples/bidi-agent.js +119 -119
- package/examples/cross-site-agent.js +91 -91
- package/examples/mcp-agent.js +94 -94
- package/examples/next-app-router/README.md +44 -44
- package/examples/puppeteer-agent.js +108 -108
- package/examples/saas-dashboard/README.md +55 -55
- package/examples/shopify-hydrogen/README.md +74 -74
- package/examples/vision-agent.js +171 -171
- package/examples/wordpress-elementor/README.md +77 -77
- package/package.json +17 -3
- package/public/.well-known/agent-tools.json +180 -180
- package/public/.well-known/ai-assets.json +59 -59
- package/public/.well-known/ai-plugin.json +28 -0
- package/public/.well-known/security.txt +8 -0
- package/public/agent-workspace.html +349 -347
- package/public/ai.html +198 -196
- package/public/api.html +413 -0
- package/public/browser.html +486 -484
- package/public/commander-dashboard.html +243 -243
- package/public/cookies.html +210 -208
- package/public/css/agent-workspace.css +1713 -1713
- package/public/css/premium.css +317 -317
- package/public/css/styles.css +1235 -1235
- package/public/dashboard.html +706 -704
- package/public/demo.html +1770 -1
- package/public/dns.html +507 -0
- package/public/docs.html +587 -585
- package/public/feed.xml +89 -89
- package/public/growth.html +463 -0
- package/public/index.html +341 -9
- package/public/integrations.html +556 -0
- package/public/js/agent-workspace.js +1740 -1740
- package/public/js/auth-nav.js +31 -31
- package/public/js/auth-redirect.js +12 -12
- package/public/js/cookie-consent.js +56 -56
- package/public/js/wab-demo-page.js +721 -721
- package/public/js/ws-client.js +74 -74
- package/public/llms-full.txt +360 -309
- package/public/llms.txt +125 -86
- package/public/login.html +85 -83
- package/public/mesh-dashboard.html +328 -328
- package/public/openapi.json +580 -580
- package/public/phone-shield.html +281 -0
- package/public/premium-dashboard.html +2489 -2487
- package/public/premium.html +793 -791
- package/public/privacy.html +297 -295
- package/public/register.html +105 -103
- package/public/robots.txt +87 -87
- package/public/script/wab-consent.d.ts +36 -36
- package/public/script/wab-consent.js +104 -104
- package/public/script/wab-schema.js +131 -131
- package/public/script/wab.d.ts +108 -108
- package/public/script/wab.min.js +580 -580
- package/public/security.txt +8 -0
- package/public/terms.html +256 -254
- package/script/ai-agent-bridge.js +1754 -1754
- package/sdk/README.md +99 -99
- package/sdk/agent-mesh.js +449 -449
- package/sdk/commander.js +262 -262
- package/sdk/index.d.ts +464 -464
- package/sdk/index.js +18 -1
- package/sdk/multi-agent.js +318 -318
- package/sdk/package.json +12 -1
- package/sdk/safety-shield.js +219 -0
- package/sdk/schema-discovery.js +83 -83
- package/server/adapters/index.js +520 -520
- package/server/config/plans.js +367 -367
- package/server/config/secrets.js +102 -102
- package/server/control-plane/index.js +301 -301
- package/server/data-plane/index.js +354 -354
- package/server/index.js +175 -19
- package/server/llm/index.js +404 -404
- package/server/middleware/adminAuth.js +35 -35
- package/server/middleware/auth.js +50 -50
- package/server/middleware/featureGate.js +88 -88
- package/server/middleware/rateLimits.js +100 -100
- package/server/middleware/sensitiveAction.js +157 -0
- package/server/migrations/001_add_analytics_indexes.sql +7 -7
- package/server/migrations/002_premium_features.sql +418 -418
- package/server/migrations/003_ads_integer_cents.sql +33 -33
- package/server/migrations/004_agent_os.sql +158 -158
- package/server/migrations/005_marketplace_metering.sql +126 -126
- package/server/models/adapters/index.js +33 -33
- package/server/models/adapters/mysql.js +183 -183
- package/server/models/adapters/postgresql.js +172 -172
- package/server/models/adapters/sqlite.js +7 -7
- package/server/models/db.js +681 -681
- package/server/observability/failure-analysis.js +337 -337
- package/server/observability/index.js +394 -394
- package/server/protocol/capabilities.js +223 -223
- package/server/protocol/index.js +243 -243
- package/server/protocol/schema.js +584 -584
- package/server/registry/certification.js +271 -271
- package/server/registry/index.js +326 -326
- package/server/routes/admin-premium.js +671 -671
- package/server/routes/admin.js +261 -261
- package/server/routes/ads.js +130 -130
- package/server/routes/agent-workspace.js +540 -378
- package/server/routes/api.js +150 -150
- package/server/routes/auth.js +71 -71
- package/server/routes/billing.js +45 -45
- package/server/routes/commander.js +316 -316
- package/server/routes/demo-showcase.js +332 -0
- package/server/routes/demo-store.js +154 -0
- package/server/routes/discovery.js +417 -406
- package/server/routes/gateway.js +173 -0
- package/server/routes/license.js +251 -240
- package/server/routes/mesh.js +469 -469
- package/server/routes/noscript.js +543 -543
- package/server/routes/premium-v2.js +686 -686
- package/server/routes/premium.js +724 -724
- package/server/routes/runtime.js +2148 -2147
- package/server/routes/sovereign.js +465 -385
- package/server/routes/universal.js +200 -177
- package/server/routes/wab-api.js +850 -491
- package/server/runtime/container-worker.js +111 -111
- package/server/runtime/container.js +448 -448
- package/server/runtime/distributed-worker.js +362 -362
- package/server/runtime/event-bus.js +210 -210
- package/server/runtime/index.js +253 -253
- package/server/runtime/queue.js +599 -599
- package/server/runtime/replay.js +666 -666
- package/server/runtime/sandbox.js +266 -266
- package/server/runtime/scheduler.js +534 -534
- package/server/runtime/session-engine.js +293 -293
- package/server/runtime/state-manager.js +188 -188
- package/server/security/cross-site-redactor.js +196 -0
- package/server/security/dry-run.js +180 -0
- package/server/security/human-gate-rate-limit.js +147 -0
- package/server/security/human-gate-transports.js +178 -0
- package/server/security/human-gate.js +281 -0
- package/server/security/index.js +368 -368
- package/server/security/intent-engine.js +245 -0
- package/server/security/reward-guard.js +171 -0
- package/server/security/rollback-store.js +239 -0
- package/server/security/token-scope.js +404 -0
- package/server/security/url-policy.js +139 -0
- package/server/services/agent-chat.js +506 -506
- package/server/services/agent-learning.js +601 -575
- package/server/services/agent-memory.js +625 -625
- package/server/services/agent-mesh.js +555 -539
- package/server/services/agent-symphony.js +717 -717
- package/server/services/agent-tasks.js +1807 -1807
- package/server/services/api-key-engine.js +292 -0
- package/server/services/cluster.js +894 -894
- package/server/services/commander.js +738 -738
- package/server/services/edge-compute.js +440 -440
- package/server/services/email.js +204 -204
- package/server/services/hosted-runtime.js +205 -205
- package/server/services/lfd.js +635 -616
- package/server/services/local-ai.js +389 -389
- package/server/services/marketplace.js +270 -270
- package/server/services/metering.js +182 -182
- package/server/services/modules/affiliate-intelligence.js +93 -0
- package/server/services/modules/agent-firewall.js +90 -0
- package/server/services/modules/bounty.js +89 -0
- package/server/services/modules/collective-bargaining.js +92 -0
- package/server/services/modules/dark-pattern.js +66 -0
- package/server/services/modules/gov-intelligence.js +45 -0
- package/server/services/modules/neural.js +55 -0
- package/server/services/modules/notary.js +49 -0
- package/server/services/modules/price-time-machine.js +86 -0
- package/server/services/modules/protocol.js +104 -0
- package/server/services/negotiation.js +439 -439
- package/server/services/plugins.js +771 -771
- package/server/services/premium.js +1 -1
- package/server/services/price-intelligence.js +566 -565
- package/server/services/price-shield.js +1137 -1137
- package/server/services/reputation.js +465 -465
- package/server/services/search-engine.js +357 -357
- package/server/services/security.js +513 -513
- package/server/services/self-healing.js +843 -843
- package/server/services/sovereign-shield.js +542 -0
- package/server/services/stripe.js +192 -192
- package/server/services/swarm.js +788 -788
- package/server/services/universal-scraper.js +662 -661
- package/server/services/verification.js +481 -481
- package/server/services/vision.js +1163 -1163
- package/server/utils/cache.js +125 -125
- package/server/utils/migrate.js +81 -81
- package/server/utils/safe-fetch.js +228 -0
- package/server/utils/secureFields.js +50 -50
- package/server/ws.js +161 -161
- package/templates/artisan-marketplace.yaml +104 -104
- package/templates/book-price-scout.yaml +98 -98
- package/templates/electronics-price-tracker.yaml +108 -108
- package/templates/flight-deal-hunter.yaml +113 -113
- package/templates/freelancer-direct.yaml +116 -116
- package/templates/grocery-price-compare.yaml +93 -93
- package/templates/hotel-direct-booking.yaml +113 -113
- package/templates/local-services.yaml +98 -98
- package/templates/olive-oil-tunisia.yaml +88 -88
- package/templates/organic-farm-fresh.yaml +101 -101
- package/templates/restaurant-direct.yaml +97 -97
- package/server/services/fairness-engine.js +0 -409
- package/server/services/fairness.js +0 -420
package/public/docs.html
CHANGED
|
@@ -1,585 +1,587 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>Documentation — Web Agent Bridge</title>
|
|
7
|
-
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
8
|
-
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
9
|
-
<
|
|
10
|
-
<link rel="
|
|
11
|
-
|
|
12
|
-
<
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
<li><a href="
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
<a href="/
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
<li><a href="#
|
|
44
|
-
<li><a href="#
|
|
45
|
-
<li><a href="#
|
|
46
|
-
<li><a href="#
|
|
47
|
-
<li><a href="#
|
|
48
|
-
<li><a href="#
|
|
49
|
-
<li><a href="#
|
|
50
|
-
<li><a href="#
|
|
51
|
-
<li><a href="#
|
|
52
|
-
<li><a href="#
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
WAB
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
<li><strong>
|
|
76
|
-
<li><strong>
|
|
77
|
-
<li><strong>
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
<
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
<
|
|
87
|
-
|
|
88
|
-
<
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
<span class="prop">
|
|
102
|
-
<span class="prop">
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
<
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
<
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
<span class="
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
<span class="
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
<span class="prop">
|
|
134
|
-
<span class="prop">
|
|
135
|
-
<span class="prop">
|
|
136
|
-
<span class="prop">
|
|
137
|
-
<span class="prop">
|
|
138
|
-
<span class="prop">
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
<span class="prop">
|
|
146
|
-
<span class="prop">
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
<
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
<tr><td><code>
|
|
169
|
-
<tr><td><code>
|
|
170
|
-
<tr><td><code>
|
|
171
|
-
<tr><td><code>
|
|
172
|
-
<tr><td><code>
|
|
173
|
-
<tr><td><code>
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
<
|
|
181
|
-
|
|
182
|
-
<
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
<
|
|
190
|
-
|
|
191
|
-
<span class="
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
<
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
<
|
|
205
|
-
|
|
206
|
-
<span class="
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
<span class="
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
<
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
<
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
<
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
<
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
<
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
<
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
<
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
<span class="prop">
|
|
265
|
-
<span class="prop">
|
|
266
|
-
<span class="prop">
|
|
267
|
-
<span class="prop">
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
<
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
<
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
<
|
|
282
|
-
|
|
283
|
-
<
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
<li><code>
|
|
287
|
-
<li><code>
|
|
288
|
-
<li><code>
|
|
289
|
-
<li><code>
|
|
290
|
-
<li><code>
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
<tr><td><code>
|
|
302
|
-
<tr><td><code>
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
<
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
});
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
});
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
<
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
<
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
<
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
console.<span class="fn">log</span>(<span class="str">`
|
|
352
|
-
|
|
353
|
-
console.<span class="fn">log</span>(<span class="str"
|
|
354
|
-
}</
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
<span class="
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
<span class="
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
<span class="
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
<span class="
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
<
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
<li><strong>
|
|
404
|
-
<li><strong>
|
|
405
|
-
<li><strong>
|
|
406
|
-
<li><strong>
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
<li>
|
|
414
|
-
<li>
|
|
415
|
-
<li>
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
<
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
<span class="prop">
|
|
433
|
-
<span class="prop">
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
}
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
<span class="prop">
|
|
447
|
-
<span class="prop">
|
|
448
|
-
<span class="prop">
|
|
449
|
-
<span class="prop">
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
<span class="prop">
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
<span class="prop">
|
|
469
|
-
<span class="prop">
|
|
470
|
-
<span class="prop">
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
<span class="prop">
|
|
480
|
-
<span class="prop">
|
|
481
|
-
<span class="prop">
|
|
482
|
-
<span class="prop">
|
|
483
|
-
<span class="prop">
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
<span class="prop">
|
|
491
|
-
<span class="prop">
|
|
492
|
-
<span class="prop">
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
<span class="
|
|
496
|
-
<span class="kw">
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
}
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
<
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
<tr><td><code>
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
<tr><td><code>GET /api/sites
|
|
523
|
-
<tr><td><code>
|
|
524
|
-
<tr><td><code>
|
|
525
|
-
<tr><td><code>
|
|
526
|
-
<tr><td><code>
|
|
527
|
-
<tr><td><code>
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
<
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
<
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
<
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
<
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
</
|
|
585
|
-
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Documentation — Web Agent Bridge</title>
|
|
7
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
8
|
+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
9
|
+
<style>body{background:#0a0e1a;color:#f0f4ff;font-family:Inter,-apple-system,BlinkMacSystemFont,'Segoe UI',sans-serif;margin:0;min-height:100vh}</style>
|
|
10
|
+
<link rel="preload" href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&family=JetBrains+Mono:wght@400;500;600&display=swap" as="style" onload="this.onload=null;this.rel='stylesheet'">
|
|
11
|
+
<noscript><link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&family=JetBrains+Mono:wght@400;500;600&display=swap" rel="stylesheet"></noscript>
|
|
12
|
+
<link rel="stylesheet" href="/css/styles.css?v=3.0.1">
|
|
13
|
+
</head>
|
|
14
|
+
<body>
|
|
15
|
+
|
|
16
|
+
<!-- NAVBAR -->
|
|
17
|
+
<nav class="navbar">
|
|
18
|
+
<div class="container">
|
|
19
|
+
<a href="/" class="navbar-brand">
|
|
20
|
+
<div class="brand-icon">⚡</div>
|
|
21
|
+
<span>WAB</span>
|
|
22
|
+
</a>
|
|
23
|
+
<ul class="navbar-links">
|
|
24
|
+
<li><a href="/#features">Features</a></li>
|
|
25
|
+
<li><a href="/#pricing">Pricing</a></li>
|
|
26
|
+
<li><a href="/docs" style="color:var(--text-primary);">Docs</a></li>
|
|
27
|
+
</ul>
|
|
28
|
+
<div class="navbar-actions">
|
|
29
|
+
<a href="/login" class="btn btn-ghost" data-wab-auth="guest">Sign In</a>
|
|
30
|
+
<a href="/dashboard" class="btn btn-primary btn-sm" data-wab-auth="signed-in" style="display:none">Dashboard</a>
|
|
31
|
+
<a href="/register" class="btn btn-primary btn-sm" data-wab-auth="guest">Get Started</a>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
</nav>
|
|
35
|
+
|
|
36
|
+
<!-- DOCS LAYOUT -->
|
|
37
|
+
<div class="container">
|
|
38
|
+
<div class="docs-layout">
|
|
39
|
+
|
|
40
|
+
<!-- Sidebar -->
|
|
41
|
+
<aside class="docs-sidebar">
|
|
42
|
+
<ul>
|
|
43
|
+
<li><a href="#overview" class="active">Overview</a></li>
|
|
44
|
+
<li><a href="#quick-start">Quick Start</a></li>
|
|
45
|
+
<li><a href="#configuration">Configuration</a></li>
|
|
46
|
+
<li><a href="#permissions">Permissions</a></li>
|
|
47
|
+
<li><a href="#api-reference">API Reference</a></li>
|
|
48
|
+
<li><a href="#actions">Actions</a></li>
|
|
49
|
+
<li><a href="#events">Events</a></li>
|
|
50
|
+
<li><a href="#agent-guide">Agent Integration Guide</a></li>
|
|
51
|
+
<li><a href="#security">Security</a></li>
|
|
52
|
+
<li><a href="#examples">Examples</a></li>
|
|
53
|
+
<li><a href="#rest-api">REST API</a></li>
|
|
54
|
+
<li><a href="#faq">FAQ</a></li>
|
|
55
|
+
</ul>
|
|
56
|
+
</aside>
|
|
57
|
+
|
|
58
|
+
<!-- Content -->
|
|
59
|
+
<div class="docs-content">
|
|
60
|
+
|
|
61
|
+
<h2 id="overview">Overview</h2>
|
|
62
|
+
<p>
|
|
63
|
+
<strong>Web Agent Bridge (WAB)</strong> is an open-source middleware script that creates a standardized
|
|
64
|
+
interface between AI agents and websites. Instead of forcing AI agents to parse and guess DOM structures,
|
|
65
|
+
WAB provides a clean, documented command layer that agents can read and execute.
|
|
66
|
+
</p>
|
|
67
|
+
<p>
|
|
68
|
+
When a website includes the WAB script, it exposes a <code>window.AICommands</code> object that describes
|
|
69
|
+
all available actions, their parameters, and how to execute them. AI agents can discover these commands
|
|
70
|
+
instantly and interact with the site accurately and securely.
|
|
71
|
+
</p>
|
|
72
|
+
|
|
73
|
+
<h3>Key Concepts</h3>
|
|
74
|
+
<ul>
|
|
75
|
+
<li><strong>Bridge Script</strong> — The client-side JavaScript file added to websites</li>
|
|
76
|
+
<li><strong>Actions</strong> — Defined operations that AI agents can execute (click, fill, scroll, API call)</li>
|
|
77
|
+
<li><strong>Permissions</strong> — Granular controls over what agents are allowed to do</li>
|
|
78
|
+
<li><strong>License Key</strong> — Unique identifier that links a site to its WAB account</li>
|
|
79
|
+
<li><strong>Auto-Discovery</strong> — Automatic detection of interactive elements on the page</li>
|
|
80
|
+
</ul>
|
|
81
|
+
|
|
82
|
+
<h2 id="quick-start">Quick Start</h2>
|
|
83
|
+
<p>Get your website AI-ready in under 5 minutes.</p>
|
|
84
|
+
|
|
85
|
+
<h3>Step 1: Create an Account</h3>
|
|
86
|
+
<p>Sign up at <a href="/register">/register</a> and add your site from the dashboard. You'll receive a license key.</p>
|
|
87
|
+
|
|
88
|
+
<h3>Step 2: Add the Script</h3>
|
|
89
|
+
<p>Include this in your website's HTML:</p>
|
|
90
|
+
<div class="code-block">
|
|
91
|
+
<div class="code-header">
|
|
92
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
93
|
+
<span class="code-lang">HTML</span>
|
|
94
|
+
</div>
|
|
95
|
+
<div class="code-body">
|
|
96
|
+
<pre><code><span class="cm"><!-- Web Agent Bridge Configuration --></span>
|
|
97
|
+
<script>
|
|
98
|
+
window.AIBridgeConfig = {
|
|
99
|
+
<span class="prop">licenseKey</span>: <span class="str">"WAB-XXXXX-XXXXX-XXXXX-XXXXX"</span>,
|
|
100
|
+
<span class="prop">agentPermissions</span>: {
|
|
101
|
+
<span class="prop">readContent</span>: <span class="bool">true</span>,
|
|
102
|
+
<span class="prop">click</span>: <span class="bool">true</span>,
|
|
103
|
+
<span class="prop">fillForms</span>: <span class="bool">true</span>,
|
|
104
|
+
<span class="prop">scroll</span>: <span class="bool">true</span>
|
|
105
|
+
}
|
|
106
|
+
};
|
|
107
|
+
</script>
|
|
108
|
+
<script src=<span class="str">"https://yourserver.com/script/ai-agent-bridge.js"</span>></script></code></pre>
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
<h3>Step 3: Verify</h3>
|
|
113
|
+
<p>Open your browser console and type <code>window.AICommands</code>. You should see the bridge object with discovered actions.</p>
|
|
114
|
+
|
|
115
|
+
<h2 id="configuration">Configuration</h2>
|
|
116
|
+
<p>The bridge is configured through the <code>window.AIBridgeConfig</code> object, which must be set before loading the script.</p>
|
|
117
|
+
|
|
118
|
+
<div class="code-block">
|
|
119
|
+
<div class="code-header">
|
|
120
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
121
|
+
<span class="code-lang">JavaScript — Full Configuration</span>
|
|
122
|
+
</div>
|
|
123
|
+
<div class="code-body">
|
|
124
|
+
<pre><code>window.AIBridgeConfig = {
|
|
125
|
+
<span class="cm">// License key from your dashboard</span>
|
|
126
|
+
<span class="prop">licenseKey</span>: <span class="str">"WAB-XXXXX-XXXXX-XXXXX-XXXXX"</span>,
|
|
127
|
+
|
|
128
|
+
<span class="cm">// Subscription tier (verified server-side)</span>
|
|
129
|
+
<span class="prop">subscriptionTier</span>: <span class="str">"free"</span>,
|
|
130
|
+
|
|
131
|
+
<span class="cm">// What AI agents are allowed to do</span>
|
|
132
|
+
<span class="prop">agentPermissions</span>: {
|
|
133
|
+
<span class="prop">readContent</span>: <span class="bool">true</span>, <span class="cm">// Read page text</span>
|
|
134
|
+
<span class="prop">click</span>: <span class="bool">true</span>, <span class="cm">// Click elements</span>
|
|
135
|
+
<span class="prop">fillForms</span>: <span class="bool">false</span>, <span class="cm">// Fill and submit forms</span>
|
|
136
|
+
<span class="prop">scroll</span>: <span class="bool">true</span>, <span class="cm">// Scroll the page</span>
|
|
137
|
+
<span class="prop">navigate</span>: <span class="bool">false</span>, <span class="cm">// Navigate between pages</span>
|
|
138
|
+
<span class="prop">apiAccess</span>: <span class="bool">false</span>, <span class="cm">// Call internal APIs (Pro+)</span>
|
|
139
|
+
<span class="prop">automatedLogin</span>: <span class="bool">false</span>, <span class="cm">// Automated login (Starter+)</span>
|
|
140
|
+
<span class="prop">extractData</span>: <span class="bool">false</span> <span class="cm">// Extract structured data (Pro+)</span>
|
|
141
|
+
},
|
|
142
|
+
|
|
143
|
+
<span class="cm">// Access restrictions</span>
|
|
144
|
+
<span class="prop">restrictions</span>: {
|
|
145
|
+
<span class="prop">allowedSelectors</span>: [], <span class="cm">// Empty = allow all</span>
|
|
146
|
+
<span class="prop">blockedSelectors</span>: [<span class="str">".private"</span>, <span class="str">"[data-private]"</span>],
|
|
147
|
+
<span class="prop">requireLoginForActions</span>: [<span class="str">"apiAccess"</span>],
|
|
148
|
+
<span class="prop">rateLimit</span>: { <span class="prop">maxCallsPerMinute</span>: <span class="num">60</span> }
|
|
149
|
+
},
|
|
150
|
+
|
|
151
|
+
<span class="cm">// Activity logging</span>
|
|
152
|
+
<span class="prop">logging</span>: {
|
|
153
|
+
<span class="prop">enabled</span>: <span class="bool">false</span>,
|
|
154
|
+
<span class="prop">level</span>: <span class="str">"basic"</span> <span class="cm">// "basic" or "detailed"</span>
|
|
155
|
+
}
|
|
156
|
+
};</code></pre>
|
|
157
|
+
</div>
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
<h2 id="permissions">Permissions</h2>
|
|
161
|
+
<p>Permissions control what AI agents can do on your site. Each permission can be independently toggled.</p>
|
|
162
|
+
|
|
163
|
+
<table style="margin-bottom:24px;">
|
|
164
|
+
<thead>
|
|
165
|
+
<tr><th>Permission</th><th>Description</th><th>Min Tier</th></tr>
|
|
166
|
+
</thead>
|
|
167
|
+
<tbody>
|
|
168
|
+
<tr><td><code>readContent</code></td><td>Read text content from page elements</td><td>Free</td></tr>
|
|
169
|
+
<tr><td><code>click</code></td><td>Click buttons, links, and interactive elements</td><td>Free</td></tr>
|
|
170
|
+
<tr><td><code>scroll</code></td><td>Scroll the page or to specific elements</td><td>Free</td></tr>
|
|
171
|
+
<tr><td><code>fillForms</code></td><td>Fill form fields and submit forms</td><td>Free</td></tr>
|
|
172
|
+
<tr><td><code>navigate</code></td><td>Navigate to different pages</td><td>Free</td></tr>
|
|
173
|
+
<tr><td><code>automatedLogin</code></td><td>Perform automated login flows</td><td>Starter</td></tr>
|
|
174
|
+
<tr><td><code>apiAccess</code></td><td>Call internal REST API endpoints</td><td>Pro</td></tr>
|
|
175
|
+
<tr><td><code>extractData</code></td><td>Extract structured data from the page</td><td>Pro</td></tr>
|
|
176
|
+
</tbody>
|
|
177
|
+
</table>
|
|
178
|
+
|
|
179
|
+
<h2 id="api-reference">API Reference</h2>
|
|
180
|
+
<p>The <code>window.AICommands</code> object provides the following methods:</p>
|
|
181
|
+
|
|
182
|
+
<h3><code>getActions(category?)</code></h3>
|
|
183
|
+
<p>Returns an array of all available actions. Optionally filter by category.</p>
|
|
184
|
+
<div class="code-block">
|
|
185
|
+
<div class="code-header">
|
|
186
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
187
|
+
<span class="code-lang">JavaScript</span>
|
|
188
|
+
</div>
|
|
189
|
+
<div class="code-body">
|
|
190
|
+
<pre><code><span class="kw">const</span> allActions = window.AICommands.<span class="fn">getActions</span>();
|
|
191
|
+
<span class="kw">const</span> navActions = window.AICommands.<span class="fn">getActions</span>(<span class="str">"navigation"</span>);
|
|
192
|
+
|
|
193
|
+
<span class="cm">// Returns: [{ name, description, trigger, category, requiresAuth, params, fields }]</span></code></pre>
|
|
194
|
+
</div>
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
<h3><code>execute(actionName, params?)</code></h3>
|
|
198
|
+
<p>Execute a registered action. Returns a Promise with the result.</p>
|
|
199
|
+
<div class="code-block">
|
|
200
|
+
<div class="code-header">
|
|
201
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
202
|
+
<span class="code-lang">JavaScript</span>
|
|
203
|
+
</div>
|
|
204
|
+
<div class="code-body">
|
|
205
|
+
<pre><code><span class="kw">const</span> result = <span class="kw">await</span> window.AICommands.<span class="fn">execute</span>(<span class="str">"signup"</span>);
|
|
206
|
+
<span class="cm">// → { success: true, action: "click", selector: "#signup-button" }</span>
|
|
207
|
+
|
|
208
|
+
<span class="kw">const</span> formResult = <span class="kw">await</span> window.AICommands.<span class="fn">execute</span>(<span class="str">"fill_contact_form"</span>, {
|
|
209
|
+
<span class="prop">name</span>: <span class="str">"Alice"</span>,
|
|
210
|
+
<span class="prop">email</span>: <span class="str">"alice@example.com"</span>
|
|
211
|
+
});
|
|
212
|
+
<span class="cm">// → { success: true, results: [...] }</span></code></pre>
|
|
213
|
+
</div>
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
<h3><code>readContent(selector)</code></h3>
|
|
217
|
+
<p>Read text content from a DOM element.</p>
|
|
218
|
+
<div class="code-block">
|
|
219
|
+
<div class="code-header">
|
|
220
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
221
|
+
<span class="code-lang">JavaScript</span>
|
|
222
|
+
</div>
|
|
223
|
+
<div class="code-body">
|
|
224
|
+
<pre><code><span class="kw">const</span> content = window.AICommands.<span class="fn">readContent</span>(<span class="str">"h1.title"</span>);
|
|
225
|
+
<span class="cm">// → { success: true, text: "Welcome!", html: "Welcome!", attributes: {...} }</span></code></pre>
|
|
226
|
+
</div>
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
<h3><code>getPageInfo()</code></h3>
|
|
230
|
+
<p>Get metadata about the current page and bridge state.</p>
|
|
231
|
+
<div class="code-block">
|
|
232
|
+
<div class="code-header">
|
|
233
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
234
|
+
<span class="code-lang">JavaScript</span>
|
|
235
|
+
</div>
|
|
236
|
+
<div class="code-body">
|
|
237
|
+
<pre><code><span class="kw">const</span> info = window.AICommands.<span class="fn">getPageInfo</span>();
|
|
238
|
+
<span class="cm">// → { title, url, domain, lang, bridgeVersion, tier, permissions, actionsCount, rateLimitRemaining }</span></code></pre>
|
|
239
|
+
</div>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
<h3><code>waitForElement(selector, timeout?)</code></h3>
|
|
243
|
+
<p>Wait for a DOM element to appear. Useful for SPAs and dynamically loaded content.</p>
|
|
244
|
+
<div class="code-block">
|
|
245
|
+
<div class="code-header">
|
|
246
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
247
|
+
<span class="code-lang">JavaScript</span>
|
|
248
|
+
</div>
|
|
249
|
+
<div class="code-body">
|
|
250
|
+
<pre><code><span class="kw">await</span> window.AICommands.<span class="fn">waitForElement</span>(<span class="str">".results-loaded"</span>, <span class="num">15000</span>);
|
|
251
|
+
<span class="cm">// Resolves when the element appears, rejects on timeout</span></code></pre>
|
|
252
|
+
</div>
|
|
253
|
+
</div>
|
|
254
|
+
|
|
255
|
+
<h3><code>registerAction(actionDef)</code></h3>
|
|
256
|
+
<p>Register a custom action that AI agents can discover and execute.</p>
|
|
257
|
+
<div class="code-block">
|
|
258
|
+
<div class="code-header">
|
|
259
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
260
|
+
<span class="code-lang">JavaScript</span>
|
|
261
|
+
</div>
|
|
262
|
+
<div class="code-body">
|
|
263
|
+
<pre><code>window.AICommands.<span class="fn">registerAction</span>({
|
|
264
|
+
<span class="prop">name</span>: <span class="str">"addToCart"</span>,
|
|
265
|
+
<span class="prop">description</span>: <span class="str">"Add the current product to cart"</span>,
|
|
266
|
+
<span class="prop">trigger</span>: <span class="str">"click"</span>,
|
|
267
|
+
<span class="prop">selector</span>: <span class="str">"#add-to-cart-btn"</span>,
|
|
268
|
+
<span class="prop">category</span>: <span class="str">"e-commerce"</span>,
|
|
269
|
+
<span class="prop">metadata</span>: { <span class="prop">requiresProduct</span>: <span class="bool">true</span> }
|
|
270
|
+
});</code></pre>
|
|
271
|
+
</div>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
<h3><code>authenticate(agentKey, agentMeta?)</code></h3>
|
|
275
|
+
<p>Authenticate an AI agent to access restricted actions.</p>
|
|
276
|
+
|
|
277
|
+
<h3><code>refresh()</code></h3>
|
|
278
|
+
<p>Re-scan the page and rebuild the action registry. Call this after significant DOM changes.</p>
|
|
279
|
+
|
|
280
|
+
<h3><code>onReady(callback)</code></h3>
|
|
281
|
+
<p>Register a callback for when the bridge finishes initialization.</p>
|
|
282
|
+
|
|
283
|
+
<h2 id="actions">Actions</h2>
|
|
284
|
+
<p>Actions are the core building blocks of WAB. Each action has:</p>
|
|
285
|
+
<ul>
|
|
286
|
+
<li><code>name</code> — Unique identifier</li>
|
|
287
|
+
<li><code>description</code> — Human/AI readable description</li>
|
|
288
|
+
<li><code>trigger</code> — Type of action: <code>click</code>, <code>fill_and_submit</code>, <code>scroll</code>, <code>api</code></li>
|
|
289
|
+
<li><code>selector</code> — CSS selector of the target element</li>
|
|
290
|
+
<li><code>fields</code> — Array of form fields (for fill_and_submit actions)</li>
|
|
291
|
+
<li><code>category</code> — Grouping label</li>
|
|
292
|
+
<li><code>requiresAuth</code> — Whether agent authentication is needed</li>
|
|
293
|
+
</ul>
|
|
294
|
+
|
|
295
|
+
<h3>Action Types</h3>
|
|
296
|
+
<table style="margin-bottom:24px;">
|
|
297
|
+
<thead>
|
|
298
|
+
<tr><th>Trigger</th><th>Description</th><th>Permission</th></tr>
|
|
299
|
+
</thead>
|
|
300
|
+
<tbody>
|
|
301
|
+
<tr><td><code>click</code></td><td>Click on an element</td><td>click</td></tr>
|
|
302
|
+
<tr><td><code>fill_and_submit</code></td><td>Fill form fields and submit</td><td>fillForms</td></tr>
|
|
303
|
+
<tr><td><code>scroll</code></td><td>Scroll to an element or direction</td><td>scroll</td></tr>
|
|
304
|
+
<tr><td><code>api</code></td><td>Call an internal API endpoint</td><td>apiAccess</td></tr>
|
|
305
|
+
</tbody>
|
|
306
|
+
</table>
|
|
307
|
+
|
|
308
|
+
<h2 id="events">Events</h2>
|
|
309
|
+
<p>Subscribe to bridge events for monitoring and integration:</p>
|
|
310
|
+
<div class="code-block">
|
|
311
|
+
<div class="code-header">
|
|
312
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
313
|
+
<span class="code-lang">JavaScript</span>
|
|
314
|
+
</div>
|
|
315
|
+
<div class="code-body">
|
|
316
|
+
<pre><code><span class="kw">const</span> bridge = window.AICommands;
|
|
317
|
+
|
|
318
|
+
bridge.events.<span class="fn">on</span>(<span class="str">'ready'</span>, (data) => {
|
|
319
|
+
console.<span class="fn">log</span>(<span class="str">'Bridge ready'</span>, data.version);
|
|
320
|
+
});
|
|
321
|
+
|
|
322
|
+
bridge.events.<span class="fn">on</span>(<span class="str">'action:before'</span>, ({ action, params }) => {
|
|
323
|
+
console.<span class="fn">log</span>(<span class="str">`Executing: ${action}`</span>);
|
|
324
|
+
});
|
|
325
|
+
|
|
326
|
+
bridge.events.<span class="fn">on</span>(<span class="str">'action:after'</span>, ({ action, result }) => {
|
|
327
|
+
console.<span class="fn">log</span>(<span class="str">`Result: ${result.success}`</span>);
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
bridge.events.<span class="fn">on</span>(<span class="str">'error'</span>, (err) => {
|
|
331
|
+
console.<span class="fn">error</span>(<span class="str">'Bridge error'</span>, err);
|
|
332
|
+
});</code></pre>
|
|
333
|
+
</div>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
<p>Available events: <code>ready</code>, <code>action:before</code>, <code>action:after</code>, <code>action:registered</code>, <code>action:unregistered</code>, <code>agent:authenticate</code>, <code>error</code>, <code>refresh</code>, <code>destroy</code></p>
|
|
337
|
+
|
|
338
|
+
<h2 id="agent-guide">Agent Integration Guide</h2>
|
|
339
|
+
<p>If you're building an AI agent that interacts with websites, here's how to use WAB.</p>
|
|
340
|
+
|
|
341
|
+
<h3>Detecting WAB</h3>
|
|
342
|
+
<div class="code-block">
|
|
343
|
+
<div class="code-header">
|
|
344
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
345
|
+
<span class="code-lang">JavaScript — Agent Side</span>
|
|
346
|
+
</div>
|
|
347
|
+
<div class="code-body">
|
|
348
|
+
<pre><code><span class="cm">// Check if the site supports WAB</span>
|
|
349
|
+
<span class="kw">if</span> (window.AICommands) {
|
|
350
|
+
<span class="kw">const</span> info = window.AICommands.<span class="fn">getPageInfo</span>();
|
|
351
|
+
console.<span class="fn">log</span>(<span class="str">`WAB v${info.bridgeVersion} detected`</span>);
|
|
352
|
+
console.<span class="fn">log</span>(<span class="str">`${info.actionsCount} actions available`</span>);
|
|
353
|
+
console.<span class="fn">log</span>(<span class="str">`Tier: ${info.tier}`</span>);
|
|
354
|
+
} <span class="kw">else</span> {
|
|
355
|
+
console.<span class="fn">log</span>(<span class="str">'No WAB support — fall back to DOM parsing'</span>);
|
|
356
|
+
}</code></pre>
|
|
357
|
+
</div>
|
|
358
|
+
</div>
|
|
359
|
+
|
|
360
|
+
<h3>Discovering and Executing Actions</h3>
|
|
361
|
+
<div class="code-block">
|
|
362
|
+
<div class="code-header">
|
|
363
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
364
|
+
<span class="code-lang">JavaScript — Full Agent Workflow</span>
|
|
365
|
+
</div>
|
|
366
|
+
<div class="code-body">
|
|
367
|
+
<pre><code><span class="kw">async function</span> <span class="fn">agentWorkflow</span>() {
|
|
368
|
+
<span class="kw">const</span> bridge = window.AICommands;
|
|
369
|
+
|
|
370
|
+
<span class="cm">// 1. Authenticate (if needed)</span>
|
|
371
|
+
bridge.<span class="fn">authenticate</span>(<span class="str">"agent-key-123"</span>, {
|
|
372
|
+
<span class="prop">name</span>: <span class="str">"MyAssistant"</span>,
|
|
373
|
+
<span class="prop">version</span>: <span class="str">"2.0"</span>
|
|
374
|
+
});
|
|
375
|
+
|
|
376
|
+
<span class="cm">// 2. Discover available actions</span>
|
|
377
|
+
<span class="kw">const</span> actions = bridge.<span class="fn">getActions</span>();
|
|
378
|
+
|
|
379
|
+
<span class="cm">// 3. Find the action we need</span>
|
|
380
|
+
<span class="kw">const</span> loginAction = actions.<span class="fn">find</span>(a => a.name.<span class="fn">includes</span>(<span class="str">'login'</span>));
|
|
381
|
+
|
|
382
|
+
<span class="cm">// 4. Execute it</span>
|
|
383
|
+
<span class="kw">if</span> (loginAction) {
|
|
384
|
+
<span class="kw">const</span> result = <span class="kw">await</span> bridge.<span class="fn">execute</span>(loginAction.name, {
|
|
385
|
+
<span class="prop">email</span>: <span class="str">"user@example.com"</span>,
|
|
386
|
+
<span class="prop">password</span>: <span class="str">"secure-password"</span>
|
|
387
|
+
});
|
|
388
|
+
console.<span class="fn">log</span>(result);
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
<span class="cm">// 5. Wait for navigation</span>
|
|
392
|
+
<span class="kw">await</span> bridge.<span class="fn">waitForNavigation</span>();
|
|
393
|
+
|
|
394
|
+
<span class="cm">// 6. Refresh actions for new page</span>
|
|
395
|
+
bridge.<span class="fn">refresh</span>();
|
|
396
|
+
}</code></pre>
|
|
397
|
+
</div>
|
|
398
|
+
</div>
|
|
399
|
+
|
|
400
|
+
<h2 id="security">Security</h2>
|
|
401
|
+
<p>WAB is built with security as a first-class concern:</p>
|
|
402
|
+
<ul>
|
|
403
|
+
<li><strong>Permission-based access</strong> — Site owners control exactly what agents can do</li>
|
|
404
|
+
<li><strong>Selector restrictions</strong> — Block sensitive areas of the page from agent interaction</li>
|
|
405
|
+
<li><strong>Rate limiting</strong> — Built-in protection against abuse</li>
|
|
406
|
+
<li><strong>Server-side license verification</strong> — Tier permissions are verified by the licensing server</li>
|
|
407
|
+
<li><strong>Agent authentication</strong> — Optional agent identity verification</li>
|
|
408
|
+
<li><strong>Opt-in only</strong> — Sites must explicitly add the script; users can disable via extensions</li>
|
|
409
|
+
</ul>
|
|
410
|
+
|
|
411
|
+
<h3>Best Practices</h3>
|
|
412
|
+
<ol>
|
|
413
|
+
<li>Always use <code>blockedSelectors</code> to protect sensitive areas (forms with credit cards, admin panels)</li>
|
|
414
|
+
<li>Start with minimal permissions and expand as needed</li>
|
|
415
|
+
<li>Enable logging to monitor agent behavior</li>
|
|
416
|
+
<li>Use the <code>requireLoginForActions</code> restriction for sensitive operations</li>
|
|
417
|
+
<li>Keep your license key confidential</li>
|
|
418
|
+
</ol>
|
|
419
|
+
|
|
420
|
+
<h2 id="examples">Examples</h2>
|
|
421
|
+
|
|
422
|
+
<h3>E-commerce Site</h3>
|
|
423
|
+
<div class="code-block">
|
|
424
|
+
<div class="code-header">
|
|
425
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
426
|
+
<span class="code-lang">JavaScript</span>
|
|
427
|
+
</div>
|
|
428
|
+
<div class="code-body">
|
|
429
|
+
<pre><code>window.AIBridgeConfig = {
|
|
430
|
+
<span class="prop">licenseKey</span>: <span class="str">"WAB-SHOP-XXXXX-XXXXX"</span>,
|
|
431
|
+
<span class="prop">agentPermissions</span>: {
|
|
432
|
+
<span class="prop">readContent</span>: <span class="bool">true</span>,
|
|
433
|
+
<span class="prop">click</span>: <span class="bool">true</span>,
|
|
434
|
+
<span class="prop">fillForms</span>: <span class="bool">true</span>,
|
|
435
|
+
<span class="prop">scroll</span>: <span class="bool">true</span>
|
|
436
|
+
},
|
|
437
|
+
<span class="prop">restrictions</span>: {
|
|
438
|
+
<span class="prop">blockedSelectors</span>: [<span class="str">"#checkout-payment"</span>, <span class="str">".credit-card-form"</span>],
|
|
439
|
+
<span class="prop">rateLimit</span>: { <span class="prop">maxCallsPerMinute</span>: <span class="num">30</span> }
|
|
440
|
+
}
|
|
441
|
+
};
|
|
442
|
+
|
|
443
|
+
<span class="cm">// After the bridge loads, add custom actions</span>
|
|
444
|
+
document.<span class="fn">addEventListener</span>(<span class="str">'wab:ready'</span>, () => {
|
|
445
|
+
window.AICommands.<span class="fn">registerAction</span>({
|
|
446
|
+
<span class="prop">name</span>: <span class="str">"searchProducts"</span>,
|
|
447
|
+
<span class="prop">description</span>: <span class="str">"Search for products by keyword"</span>,
|
|
448
|
+
<span class="prop">trigger</span>: <span class="str">"fill_and_submit"</span>,
|
|
449
|
+
<span class="prop">fields</span>: [{ <span class="prop">name</span>: <span class="str">"query"</span>, <span class="prop">selector</span>: <span class="str">"#search-input"</span>, <span class="prop">type</span>: <span class="str">"text"</span> }],
|
|
450
|
+
<span class="prop">submitSelector</span>: <span class="str">"#search-btn"</span>,
|
|
451
|
+
<span class="prop">category</span>: <span class="str">"search"</span>
|
|
452
|
+
});
|
|
453
|
+
});</code></pre>
|
|
454
|
+
</div>
|
|
455
|
+
</div>
|
|
456
|
+
|
|
457
|
+
<h3>SaaS Dashboard</h3>
|
|
458
|
+
<div class="code-block">
|
|
459
|
+
<div class="code-header">
|
|
460
|
+
<div class="code-dots"><span></span><span></span><span></span></div>
|
|
461
|
+
<span class="code-lang">JavaScript</span>
|
|
462
|
+
</div>
|
|
463
|
+
<div class="code-body">
|
|
464
|
+
<pre><code>window.AIBridgeConfig = {
|
|
465
|
+
<span class="prop">licenseKey</span>: <span class="str">"WAB-SAAS-XXXXX-XXXXX"</span>,
|
|
466
|
+
<span class="prop">subscriptionTier</span>: <span class="str">"pro"</span>,
|
|
467
|
+
<span class="prop">agentPermissions</span>: {
|
|
468
|
+
<span class="prop">readContent</span>: <span class="bool">true</span>,
|
|
469
|
+
<span class="prop">click</span>: <span class="bool">true</span>,
|
|
470
|
+
<span class="prop">fillForms</span>: <span class="bool">true</span>,
|
|
471
|
+
<span class="prop">apiAccess</span>: <span class="bool">true</span>,
|
|
472
|
+
<span class="prop">extractData</span>: <span class="bool">true</span>
|
|
473
|
+
}
|
|
474
|
+
};
|
|
475
|
+
|
|
476
|
+
document.<span class="fn">addEventListener</span>(<span class="str">'wab:ready'</span>, () => {
|
|
477
|
+
<span class="cm">// Custom API action</span>
|
|
478
|
+
window.AICommands.<span class="fn">registerAction</span>({
|
|
479
|
+
<span class="prop">name</span>: <span class="str">"getAnalytics"</span>,
|
|
480
|
+
<span class="prop">description</span>: <span class="str">"Fetch analytics data for the current period"</span>,
|
|
481
|
+
<span class="prop">trigger</span>: <span class="str">"api"</span>,
|
|
482
|
+
<span class="prop">endpoint</span>: <span class="str">"/api/analytics/current"</span>,
|
|
483
|
+
<span class="prop">method</span>: <span class="str">"GET"</span>,
|
|
484
|
+
<span class="prop">requiresAuth</span>: <span class="bool">true</span>,
|
|
485
|
+
<span class="prop">category</span>: <span class="str">"data"</span>
|
|
486
|
+
});
|
|
487
|
+
|
|
488
|
+
<span class="cm">// Custom handler action</span>
|
|
489
|
+
window.AICommands.<span class="fn">registerAction</span>({
|
|
490
|
+
<span class="prop">name</span>: <span class="str">"exportReport"</span>,
|
|
491
|
+
<span class="prop">description</span>: <span class="str">"Generate and download a PDF report"</span>,
|
|
492
|
+
<span class="prop">trigger</span>: <span class="str">"click"</span>,
|
|
493
|
+
<span class="prop">category</span>: <span class="str">"export"</span>,
|
|
494
|
+
<span class="prop">handler</span>: <span class="kw">async</span> () => {
|
|
495
|
+
<span class="kw">const</span> res = <span class="kw">await</span> <span class="fn">fetch</span>(<span class="str">'/api/report/generate'</span>);
|
|
496
|
+
<span class="kw">const</span> blob = <span class="kw">await</span> res.<span class="fn">blob</span>();
|
|
497
|
+
<span class="cm">// trigger download...</span>
|
|
498
|
+
<span class="kw">return</span> { <span class="prop">success</span>: <span class="bool">true</span>, <span class="prop">message</span>: <span class="str">"Report downloaded"</span> };
|
|
499
|
+
}
|
|
500
|
+
});
|
|
501
|
+
});</code></pre>
|
|
502
|
+
</div>
|
|
503
|
+
</div>
|
|
504
|
+
|
|
505
|
+
<h2 id="rest-api">REST API</h2>
|
|
506
|
+
<p>The WAB server provides a REST API for managing sites, licenses, and analytics.</p>
|
|
507
|
+
|
|
508
|
+
<h3>Authentication</h3>
|
|
509
|
+
<table style="margin-bottom:16px;">
|
|
510
|
+
<thead><tr><th>Endpoint</th><th>Method</th><th>Description</th></tr></thead>
|
|
511
|
+
<tbody>
|
|
512
|
+
<tr><td><code>POST /api/auth/register</code></td><td>POST</td><td>Create a new account</td></tr>
|
|
513
|
+
<tr><td><code>POST /api/auth/login</code></td><td>POST</td><td>Sign in and receive JWT token</td></tr>
|
|
514
|
+
<tr><td><code>GET /api/auth/me</code></td><td>GET</td><td>Get current user info</td></tr>
|
|
515
|
+
</tbody>
|
|
516
|
+
</table>
|
|
517
|
+
|
|
518
|
+
<h3>Sites</h3>
|
|
519
|
+
<table style="margin-bottom:16px;">
|
|
520
|
+
<thead><tr><th>Endpoint</th><th>Method</th><th>Description</th></tr></thead>
|
|
521
|
+
<tbody>
|
|
522
|
+
<tr><td><code>GET /api/sites</code></td><td>GET</td><td>List all your sites</td></tr>
|
|
523
|
+
<tr><td><code>POST /api/sites</code></td><td>POST</td><td>Add a new site</td></tr>
|
|
524
|
+
<tr><td><code>GET /api/sites/:id</code></td><td>GET</td><td>Get site details</td></tr>
|
|
525
|
+
<tr><td><code>PUT /api/sites/:id/config</code></td><td>PUT</td><td>Update site configuration</td></tr>
|
|
526
|
+
<tr><td><code>PUT /api/sites/:id/tier</code></td><td>PUT</td><td>Change subscription tier</td></tr>
|
|
527
|
+
<tr><td><code>DELETE /api/sites/:id</code></td><td>DELETE</td><td>Delete a site</td></tr>
|
|
528
|
+
<tr><td><code>GET /api/sites/:id/snippet</code></td><td>GET</td><td>Get install snippet</td></tr>
|
|
529
|
+
<tr><td><code>GET /api/sites/:id/analytics</code></td><td>GET</td><td>Get analytics data</td></tr>
|
|
530
|
+
</tbody>
|
|
531
|
+
</table>
|
|
532
|
+
|
|
533
|
+
<h3>License</h3>
|
|
534
|
+
<table style="margin-bottom:16px;">
|
|
535
|
+
<thead><tr><th>Endpoint</th><th>Method</th><th>Description</th></tr></thead>
|
|
536
|
+
<tbody>
|
|
537
|
+
<tr><td><code>POST /api/license/verify</code></td><td>POST</td><td>Verify a license key for a domain</td></tr>
|
|
538
|
+
<tr><td><code>POST /api/license/track</code></td><td>POST</td><td>Record an analytics event</td></tr>
|
|
539
|
+
</tbody>
|
|
540
|
+
</table>
|
|
541
|
+
|
|
542
|
+
<h2 id="faq">FAQ</h2>
|
|
543
|
+
|
|
544
|
+
<h3>Is WAB free to use?</h3>
|
|
545
|
+
<p>The core script is open source and free forever. Advanced features like API access, detailed analytics, and automated login require a paid subscription.</p>
|
|
546
|
+
|
|
547
|
+
<h3>Does WAB work with all AI agents?</h3>
|
|
548
|
+
<p>WAB works with any agent that can execute JavaScript in a browser context — including Selenium, Puppeteer, Playwright, browser extensions, and AI tools like OpenAI's Operator or Anthropic's Computer Use.</p>
|
|
549
|
+
|
|
550
|
+
<h3>What if my site is a SPA?</h3>
|
|
551
|
+
<p>Call <code>bridge.refresh()</code> after navigation events to re-scan for new elements. The <code>waitForElement()</code> method helps agents wait for dynamically loaded content.</p>
|
|
552
|
+
|
|
553
|
+
<h3>Can I use WAB without the licensing server?</h3>
|
|
554
|
+
<p>Yes. Without a license key, WAB runs in free-tier mode with all basic permissions. The licensing server only validates premium features.</p>
|
|
555
|
+
|
|
556
|
+
</div>
|
|
557
|
+
</div>
|
|
558
|
+
</div>
|
|
559
|
+
|
|
560
|
+
<!-- FOOTER -->
|
|
561
|
+
<footer class="footer" style="margin-top:48px;">
|
|
562
|
+
<div class="container">
|
|
563
|
+
<div class="footer-bottom" style="border-top:none; padding-top:0;">
|
|
564
|
+
<span>© 2026 Web Agent Bridge. MIT License.</span>
|
|
565
|
+
<a href="/" class="btn btn-ghost btn-sm">Back to Home</a>
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
</footer>
|
|
569
|
+
|
|
570
|
+
<script src="/js/auth-nav.js?v=3.0.1"></script>
|
|
571
|
+
<script>
|
|
572
|
+
const links = document.querySelectorAll('.docs-sidebar a');
|
|
573
|
+
const observer = new IntersectionObserver((entries) => {
|
|
574
|
+
entries.forEach(entry => {
|
|
575
|
+
if (entry.isIntersecting) {
|
|
576
|
+
links.forEach(l => l.classList.remove('active'));
|
|
577
|
+
const match = document.querySelector(`.docs-sidebar a[href="#${entry.target.id}"]`);
|
|
578
|
+
if (match) match.classList.add('active');
|
|
579
|
+
}
|
|
580
|
+
});
|
|
581
|
+
}, { rootMargin: '-80px 0px -70% 0px' });
|
|
582
|
+
|
|
583
|
+
document.querySelectorAll('.docs-content h2[id]').forEach(h => observer.observe(h));
|
|
584
|
+
</script>
|
|
585
|
+
<script src="/js/cookie-consent.js?v=3.0.1"></script>
|
|
586
|
+
</body>
|
|
587
|
+
</html>
|