@bctrl/sdk 1.0.1

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 (260) hide show
  1. package/README.md +75 -0
  2. package/dist/agents/browser-use/index.d.ts +1 -0
  3. package/dist/agents/browser-use/index.js +9 -0
  4. package/dist/agents/browser-use/namespace.d.ts +39 -0
  5. package/dist/agents/browser-use/namespace.js +93 -0
  6. package/dist/agents/index.d.ts +2 -0
  7. package/dist/agents/index.js +17 -0
  8. package/dist/agents/stagehand/core.d.ts +93 -0
  9. package/dist/agents/stagehand/core.js +144 -0
  10. package/dist/agents/stagehand/index.d.ts +3 -0
  11. package/dist/agents/stagehand/index.js +24 -0
  12. package/dist/agents/stagehand/namespace.d.ts +51 -0
  13. package/dist/agents/stagehand/namespace.js +65 -0
  14. package/dist/ai-credentials/client.d.ts +12 -0
  15. package/dist/ai-credentials/client.js +70 -0
  16. package/dist/ai-credentials/index.d.ts +1 -0
  17. package/dist/ai-credentials/index.js +1 -0
  18. package/dist/base/event-binding.d.ts +7 -0
  19. package/dist/base/event-binding.js +23 -0
  20. package/dist/base/types.d.ts +109 -0
  21. package/dist/base/types.js +4 -0
  22. package/dist/bctrl.d.ts +37 -0
  23. package/dist/bctrl.js +77 -0
  24. package/dist/browser-extensions/client.d.ts +15 -0
  25. package/dist/browser-extensions/client.js +72 -0
  26. package/dist/browser-extensions/index.d.ts +2 -0
  27. package/dist/browser-extensions/index.js +1 -0
  28. package/dist/browser-profiles/client.d.ts +11 -0
  29. package/dist/browser-profiles/client.js +63 -0
  30. package/dist/browser-profiles/index.d.ts +1 -0
  31. package/dist/browser-profiles/index.js +1 -0
  32. package/dist/captcha/index.d.ts +1 -0
  33. package/dist/captcha/index.js +1 -0
  34. package/dist/captcha/namespace.d.ts +34 -0
  35. package/dist/captcha/namespace.js +41 -0
  36. package/dist/client/index.d.ts +1 -0
  37. package/dist/client/index.js +1 -0
  38. package/dist/client/rpc.d.ts +83 -0
  39. package/dist/client/rpc.js +354 -0
  40. package/dist/config.d.ts +5 -0
  41. package/dist/config.js +28 -0
  42. package/dist/constants/browser.d.ts +2 -0
  43. package/dist/constants/browser.js +1 -0
  44. package/dist/contracts/agent-tools.d.ts +45 -0
  45. package/dist/contracts/agent-tools.js +31 -0
  46. package/dist/contracts/automation.d.ts +265 -0
  47. package/dist/contracts/automation.js +109 -0
  48. package/dist/contracts/browser-management.d.ts +179 -0
  49. package/dist/contracts/browser-management.js +95 -0
  50. package/dist/contracts/browser-use.d.ts +136 -0
  51. package/dist/contracts/browser-use.js +93 -0
  52. package/dist/contracts/captcha.d.ts +114 -0
  53. package/dist/contracts/captcha.js +40 -0
  54. package/dist/contracts/desktop.d.ts +223 -0
  55. package/dist/contracts/desktop.js +121 -0
  56. package/dist/contracts/drivers/playwright.d.ts +2008 -0
  57. package/dist/contracts/drivers/playwright.js +2033 -0
  58. package/dist/contracts/drivers/puppeteer.d.ts +1221 -0
  59. package/dist/contracts/drivers/puppeteer.js +941 -0
  60. package/dist/contracts/drivers/selenium.d.ts +156 -0
  61. package/dist/contracts/drivers/selenium.js +61 -0
  62. package/dist/contracts/drivers/stagehand.d.ts +155 -0
  63. package/dist/contracts/drivers/stagehand.js +7 -0
  64. package/dist/contracts/extensions.d.ts +13 -0
  65. package/dist/contracts/extensions.js +9 -0
  66. package/dist/contracts/index.d.ts +13 -0
  67. package/dist/contracts/index.js +13 -0
  68. package/dist/contracts/public-api.d.ts +360 -0
  69. package/dist/contracts/public-api.js +17 -0
  70. package/dist/contracts/runtime.d.ts +81 -0
  71. package/dist/contracts/runtime.js +16 -0
  72. package/dist/contracts/stagehand.d.ts +253 -0
  73. package/dist/contracts/stagehand.js +145 -0
  74. package/dist/contracts/storage.d.ts +51 -0
  75. package/dist/contracts/storage.js +56 -0
  76. package/dist/contracts/vault.d.ts +119 -0
  77. package/dist/contracts/vault.js +112 -0
  78. package/dist/contracts/version.d.ts +3 -0
  79. package/dist/contracts/version.js +16 -0
  80. package/dist/desktop.d.ts +2 -0
  81. package/dist/desktop.js +3 -0
  82. package/dist/drivers/desktop/index.d.ts +65 -0
  83. package/dist/drivers/desktop/index.js +68 -0
  84. package/dist/drivers/desktop/session.d.ts +313 -0
  85. package/dist/drivers/desktop/session.js +432 -0
  86. package/dist/drivers/playwright/event-emitter.d.ts +160 -0
  87. package/dist/drivers/playwright/event-emitter.js +297 -0
  88. package/dist/drivers/playwright/generated/api-request-context.d.ts +137 -0
  89. package/dist/drivers/playwright/generated/api-request-context.js +154 -0
  90. package/dist/drivers/playwright/generated/api-response.d.ts +119 -0
  91. package/dist/drivers/playwright/generated/api-response.js +123 -0
  92. package/dist/drivers/playwright/generated/browser-context.d.ts +284 -0
  93. package/dist/drivers/playwright/generated/browser-context.js +458 -0
  94. package/dist/drivers/playwright/generated/browser.d.ts +120 -0
  95. package/dist/drivers/playwright/generated/browser.js +151 -0
  96. package/dist/drivers/playwright/generated/clock.d.ts +80 -0
  97. package/dist/drivers/playwright/generated/clock.js +94 -0
  98. package/dist/drivers/playwright/generated/console-message.d.ts +94 -0
  99. package/dist/drivers/playwright/generated/console-message.js +89 -0
  100. package/dist/drivers/playwright/generated/coverage.d.ts +57 -0
  101. package/dist/drivers/playwright/generated/coverage.js +66 -0
  102. package/dist/drivers/playwright/generated/dialog.d.ts +79 -0
  103. package/dist/drivers/playwright/generated/dialog.js +80 -0
  104. package/dist/drivers/playwright/generated/element-handle.d.ts +399 -0
  105. package/dist/drivers/playwright/generated/element-handle.js +501 -0
  106. package/dist/drivers/playwright/generated/frame-locator.d.ts +34 -0
  107. package/dist/drivers/playwright/generated/frame-locator.js +63 -0
  108. package/dist/drivers/playwright/generated/frame.d.ts +557 -0
  109. package/dist/drivers/playwright/generated/frame.js +634 -0
  110. package/dist/drivers/playwright/generated/js-handle.d.ts +72 -0
  111. package/dist/drivers/playwright/generated/js-handle.js +92 -0
  112. package/dist/drivers/playwright/generated/keyboard.d.ts +103 -0
  113. package/dist/drivers/playwright/generated/keyboard.js +113 -0
  114. package/dist/drivers/playwright/generated/locator.d.ts +795 -0
  115. package/dist/drivers/playwright/generated/locator.js +974 -0
  116. package/dist/drivers/playwright/generated/mouse.d.ts +97 -0
  117. package/dist/drivers/playwright/generated/mouse.js +109 -0
  118. package/dist/drivers/playwright/generated/page.d.ts +762 -0
  119. package/dist/drivers/playwright/generated/page.js +988 -0
  120. package/dist/drivers/playwright/generated/touchscreen.d.ts +34 -0
  121. package/dist/drivers/playwright/generated/touchscreen.js +37 -0
  122. package/dist/drivers/playwright/generated/tracing.d.ts +78 -0
  123. package/dist/drivers/playwright/generated/tracing.js +80 -0
  124. package/dist/drivers/playwright/generated/worker.d.ts +53 -0
  125. package/dist/drivers/playwright/generated/worker.js +59 -0
  126. package/dist/drivers/playwright/index.d.ts +19 -0
  127. package/dist/drivers/playwright/index.js +20 -0
  128. package/dist/drivers/playwright/remote-base.d.ts +62 -0
  129. package/dist/drivers/playwright/remote-base.js +86 -0
  130. package/dist/drivers/playwright/types.d.ts +148 -0
  131. package/dist/drivers/playwright/types.js +8 -0
  132. package/dist/drivers/puppeteer/errors.d.ts +50 -0
  133. package/dist/drivers/puppeteer/errors.js +71 -0
  134. package/dist/drivers/puppeteer/event-emitter.d.ts +145 -0
  135. package/dist/drivers/puppeteer/event-emitter.js +259 -0
  136. package/dist/drivers/puppeteer/generated/accessibility.d.ts +77 -0
  137. package/dist/drivers/puppeteer/generated/accessibility.js +74 -0
  138. package/dist/drivers/puppeteer/generated/browser-context.d.ts +116 -0
  139. package/dist/drivers/puppeteer/generated/browser-context.js +168 -0
  140. package/dist/drivers/puppeteer/generated/browser.d.ts +169 -0
  141. package/dist/drivers/puppeteer/generated/browser.js +246 -0
  142. package/dist/drivers/puppeteer/generated/console-message.d.ts +54 -0
  143. package/dist/drivers/puppeteer/generated/console-message.js +69 -0
  144. package/dist/drivers/puppeteer/generated/coverage.d.ts +49 -0
  145. package/dist/drivers/puppeteer/generated/coverage.js +57 -0
  146. package/dist/drivers/puppeteer/generated/dialog.d.ts +46 -0
  147. package/dist/drivers/puppeteer/generated/dialog.js +60 -0
  148. package/dist/drivers/puppeteer/generated/element-handle.d.ts +261 -0
  149. package/dist/drivers/puppeteer/generated/element-handle.js +341 -0
  150. package/dist/drivers/puppeteer/generated/file-chooser.d.ts +34 -0
  151. package/dist/drivers/puppeteer/generated/file-chooser.js +43 -0
  152. package/dist/drivers/puppeteer/generated/frame.d.ts +221 -0
  153. package/dist/drivers/puppeteer/generated/frame.js +302 -0
  154. package/dist/drivers/puppeteer/generated/http-request.d.ts +195 -0
  155. package/dist/drivers/puppeteer/generated/http-request.js +243 -0
  156. package/dist/drivers/puppeteer/generated/http-response.d.ts +142 -0
  157. package/dist/drivers/puppeteer/generated/http-response.js +169 -0
  158. package/dist/drivers/puppeteer/generated/js-handle.d.ts +104 -0
  159. package/dist/drivers/puppeteer/generated/js-handle.js +125 -0
  160. package/dist/drivers/puppeteer/generated/keyboard.d.ts +79 -0
  161. package/dist/drivers/puppeteer/generated/keyboard.js +89 -0
  162. package/dist/drivers/puppeteer/generated/locator.d.ts +141 -0
  163. package/dist/drivers/puppeteer/generated/locator.js +164 -0
  164. package/dist/drivers/puppeteer/generated/mouse.d.ts +74 -0
  165. package/dist/drivers/puppeteer/generated/mouse.js +94 -0
  166. package/dist/drivers/puppeteer/generated/page.d.ts +604 -0
  167. package/dist/drivers/puppeteer/generated/page.js +776 -0
  168. package/dist/drivers/puppeteer/generated/target.d.ts +105 -0
  169. package/dist/drivers/puppeteer/generated/target.js +123 -0
  170. package/dist/drivers/puppeteer/generated/touchscreen.d.ts +87 -0
  171. package/dist/drivers/puppeteer/generated/touchscreen.js +103 -0
  172. package/dist/drivers/puppeteer/generated/tracing.d.ts +38 -0
  173. package/dist/drivers/puppeteer/generated/tracing.js +43 -0
  174. package/dist/drivers/puppeteer/generated/web-worker.d.ts +63 -0
  175. package/dist/drivers/puppeteer/generated/web-worker.js +73 -0
  176. package/dist/drivers/puppeteer/index.d.ts +21 -0
  177. package/dist/drivers/puppeteer/index.js +23 -0
  178. package/dist/drivers/puppeteer/remote-base.d.ts +57 -0
  179. package/dist/drivers/puppeteer/remote-base.js +79 -0
  180. package/dist/drivers/puppeteer/types.d.ts +178 -0
  181. package/dist/drivers/puppeteer/types.js +8 -0
  182. package/dist/drivers/selenium/driver.d.ts +28 -0
  183. package/dist/drivers/selenium/driver.js +169 -0
  184. package/dist/drivers/selenium/element.d.ts +34 -0
  185. package/dist/drivers/selenium/element.js +73 -0
  186. package/dist/drivers/selenium/index.d.ts +3 -0
  187. package/dist/drivers/selenium/index.js +5 -0
  188. package/dist/drivers/selenium/types.d.ts +2 -0
  189. package/dist/drivers/selenium/types.js +12 -0
  190. package/dist/drivers/stagehand/generated/context.d.ts +127 -0
  191. package/dist/drivers/stagehand/generated/context.js +153 -0
  192. package/dist/drivers/stagehand/generated/locator.d.ts +324 -0
  193. package/dist/drivers/stagehand/generated/locator.js +368 -0
  194. package/dist/drivers/stagehand/generated/page.d.ts +377 -0
  195. package/dist/drivers/stagehand/generated/page.js +439 -0
  196. package/dist/drivers/stagehand/generated/response.d.ts +197 -0
  197. package/dist/drivers/stagehand/generated/response.js +232 -0
  198. package/dist/drivers/stagehand/index.d.ts +5 -0
  199. package/dist/drivers/stagehand/index.js +8 -0
  200. package/dist/drivers/stagehand/types.d.ts +1 -0
  201. package/dist/drivers/stagehand/types.js +7 -0
  202. package/dist/errors.d.ts +47 -0
  203. package/dist/errors.js +157 -0
  204. package/dist/extensions/client.d.ts +47 -0
  205. package/dist/extensions/client.js +154 -0
  206. package/dist/extensions/index.d.ts +1 -0
  207. package/dist/extensions/index.js +1 -0
  208. package/dist/index.d.ts +12 -0
  209. package/dist/index.js +23 -0
  210. package/dist/internal/dev-client.d.ts +5 -0
  211. package/dist/internal/dev-client.js +9 -0
  212. package/dist/internal/rpc-targets.d.ts +17 -0
  213. package/dist/internal/rpc-targets.js +58 -0
  214. package/dist/internal/serialization.d.ts +32 -0
  215. package/dist/internal/serialization.js +42 -0
  216. package/dist/internal/transport.d.ts +24 -0
  217. package/dist/internal/transport.js +29 -0
  218. package/dist/playwright.d.ts +1 -0
  219. package/dist/playwright.js +2 -0
  220. package/dist/puppeteer.d.ts +1 -0
  221. package/dist/puppeteer.js +2 -0
  222. package/dist/selenium.d.ts +1 -0
  223. package/dist/selenium.js +2 -0
  224. package/dist/stagehand.d.ts +1 -0
  225. package/dist/stagehand.js +2 -0
  226. package/dist/storage/client.d.ts +151 -0
  227. package/dist/storage/client.js +329 -0
  228. package/dist/storage/index.d.ts +2 -0
  229. package/dist/storage/index.js +4 -0
  230. package/dist/telemetry.d.ts +18 -0
  231. package/dist/telemetry.js +93 -0
  232. package/dist/updates/client.d.ts +8 -0
  233. package/dist/updates/client.js +128 -0
  234. package/dist/updates/index.d.ts +1 -0
  235. package/dist/updates/index.js +1 -0
  236. package/dist/utils/http.d.ts +39 -0
  237. package/dist/utils/http.js +88 -0
  238. package/dist/utils/index.d.ts +4 -0
  239. package/dist/utils/index.js +4 -0
  240. package/dist/utils/logger.d.ts +27 -0
  241. package/dist/utils/logger.js +74 -0
  242. package/dist/utils/schema.d.ts +17 -0
  243. package/dist/utils/schema.js +31 -0
  244. package/dist/utils/url.d.ts +5 -0
  245. package/dist/utils/url.js +7 -0
  246. package/dist/vault/client.d.ts +43 -0
  247. package/dist/vault/client.js +123 -0
  248. package/dist/vault/index.d.ts +1 -0
  249. package/dist/vault/index.js +1 -0
  250. package/dist/version.d.ts +1 -0
  251. package/dist/version.js +4 -0
  252. package/dist/workspaces/browser-runtime.d.ts +251 -0
  253. package/dist/workspaces/browser-runtime.js +1025 -0
  254. package/dist/workspaces/client.d.ts +48 -0
  255. package/dist/workspaces/client.js +222 -0
  256. package/dist/workspaces/index.d.ts +2 -0
  257. package/dist/workspaces/index.js +2 -0
  258. package/dist/workspaces/runtime-event-pump.d.ts +65 -0
  259. package/dist/workspaces/runtime-event-pump.js +716 -0
  260. package/package.json +56 -0
@@ -0,0 +1,136 @@
1
+ import { z } from 'zod';
2
+ export declare const BrowserUseAgentConfigSchema: z.ZodObject<{
3
+ llm: z.ZodOptional<z.ZodString>;
4
+ pageId: z.ZodOptional<z.ZodUUID>;
5
+ useVision: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodLiteral<"auto">]>>;
6
+ visionDetailLevel: z.ZodOptional<z.ZodEnum<{
7
+ auto: "auto";
8
+ low: "low";
9
+ high: "high";
10
+ }>>;
11
+ pageExtractionLlm: z.ZodOptional<z.ZodString>;
12
+ fallbackLlm: z.ZodOptional<z.ZodString>;
13
+ initialActions: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
14
+ maxActionsPerStep: z.ZodOptional<z.ZodNumber>;
15
+ maxFailures: z.ZodOptional<z.ZodNumber>;
16
+ finalResponseAfterFailure: z.ZodOptional<z.ZodBoolean>;
17
+ useThinking: z.ZodOptional<z.ZodBoolean>;
18
+ flashMode: z.ZodOptional<z.ZodBoolean>;
19
+ overrideSystemMessage: z.ZodOptional<z.ZodString>;
20
+ extendSystemMessage: z.ZodOptional<z.ZodString>;
21
+ saveConversationPath: z.ZodOptional<z.ZodString>;
22
+ saveConversationPathEncoding: z.ZodOptional<z.ZodString>;
23
+ availableFilePaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
24
+ sensitiveData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
25
+ generateGif: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
26
+ includeAttributes: z.ZodOptional<z.ZodArray<z.ZodString>>;
27
+ maxSteps: z.ZodOptional<z.ZodNumber>;
28
+ maxHistoryItems: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
29
+ llmTimeout: z.ZodOptional<z.ZodNumber>;
30
+ stepTimeout: z.ZodOptional<z.ZodNumber>;
31
+ directlyOpenUrl: z.ZodOptional<z.ZodBoolean>;
32
+ calculateCost: z.ZodOptional<z.ZodBoolean>;
33
+ displayFilesInDoneText: z.ZodOptional<z.ZodBoolean>;
34
+ }, z.core.$loose>;
35
+ export type BrowserUseAgentConfig = z.infer<typeof BrowserUseAgentConfigSchema>;
36
+ export declare const BrowserUseExecuteOptionsSchema: z.ZodObject<{
37
+ maxSteps: z.ZodOptional<z.ZodNumber>;
38
+ tools: z.ZodOptional<z.ZodObject<{
39
+ storage: z.ZodOptional<z.ZodObject<{
40
+ enabled: z.ZodOptional<z.ZodBoolean>;
41
+ prefix: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodOptional<z.ZodString>>>;
42
+ inputFiles: z.ZodOptional<z.ZodArray<z.ZodString>>;
43
+ }, z.core.$strict>>;
44
+ vault: z.ZodOptional<z.ZodObject<{
45
+ toolPrefix: z.ZodOptional<z.ZodString>;
46
+ defaultListFilter: z.ZodOptional<z.ZodObject<{
47
+ prefix: z.ZodOptional<z.ZodString>;
48
+ origin: z.ZodOptional<z.ZodString>;
49
+ limit: z.ZodOptional<z.ZodNumber>;
50
+ }, z.core.$strip>>;
51
+ allowRawReads: z.ZodOptional<z.ZodBoolean>;
52
+ enabled: z.ZodOptional<z.ZodBoolean>;
53
+ }, z.core.$strict>>;
54
+ captcha: z.ZodOptional<z.ZodObject<{
55
+ enabled: z.ZodOptional<z.ZodBoolean>;
56
+ pageId: z.ZodOptional<z.ZodUUID>;
57
+ }, z.core.$strict>>;
58
+ }, z.core.$strict>>;
59
+ }, z.core.$strip>;
60
+ export type BrowserUseExecuteOptions = z.infer<typeof BrowserUseExecuteOptionsSchema>;
61
+ export declare const BrowserUseCodeAgentConfigSchema: z.ZodObject<{
62
+ llm: z.ZodOptional<z.ZodString>;
63
+ pageId: z.ZodOptional<z.ZodUUID>;
64
+ maxSteps: z.ZodOptional<z.ZodNumber>;
65
+ maxFailures: z.ZodOptional<z.ZodNumber>;
66
+ saveConversationPath: z.ZodOptional<z.ZodString>;
67
+ }, z.core.$loose>;
68
+ export type BrowserUseCodeAgentConfig = z.infer<typeof BrowserUseCodeAgentConfigSchema>;
69
+ export declare const BrowserUseStepSchema: z.ZodObject<{
70
+ action: z.ZodString;
71
+ result: z.ZodOptional<z.ZodUnknown>;
72
+ screenshot: z.ZodOptional<z.ZodString>;
73
+ timestamp: z.ZodNumber;
74
+ reasoning: z.ZodOptional<z.ZodString>;
75
+ error: z.ZodOptional<z.ZodString>;
76
+ }, z.core.$strip>;
77
+ export type BrowserUseStep = z.infer<typeof BrowserUseStepSchema>;
78
+ export declare const BrowserUseUsageSchema: z.ZodObject<{
79
+ inputTokens: z.ZodOptional<z.ZodNumber>;
80
+ outputTokens: z.ZodOptional<z.ZodNumber>;
81
+ totalCost: z.ZodOptional<z.ZodNumber>;
82
+ }, z.core.$strip>;
83
+ export declare const BrowserUseOutputFileSchema: z.ZodObject<{
84
+ path: z.ZodString;
85
+ name: z.ZodString;
86
+ size: z.ZodNumber;
87
+ }, z.core.$strip>;
88
+ export type BrowserUseOutputFile = z.infer<typeof BrowserUseOutputFileSchema>;
89
+ export declare const BrowserUseInterruptionReasonSchema: z.ZodEnum<{
90
+ explicit_stop: "explicit_stop";
91
+ session_shutdown: "session_shutdown";
92
+ timeout: "timeout";
93
+ service_exit: "service_exit";
94
+ }>;
95
+ export type BrowserUseInterruptionReason = z.infer<typeof BrowserUseInterruptionReasonSchema>;
96
+ export declare const BrowserUseResultSchema: z.ZodObject<{
97
+ finalResult: z.ZodUnknown;
98
+ history: z.ZodArray<z.ZodObject<{
99
+ action: z.ZodString;
100
+ result: z.ZodOptional<z.ZodUnknown>;
101
+ screenshot: z.ZodOptional<z.ZodString>;
102
+ timestamp: z.ZodNumber;
103
+ reasoning: z.ZodOptional<z.ZodString>;
104
+ error: z.ZodOptional<z.ZodString>;
105
+ }, z.core.$strip>>;
106
+ isComplete: z.ZodBoolean;
107
+ interrupted: z.ZodBoolean;
108
+ interruptionReason: z.ZodOptional<z.ZodEnum<{
109
+ explicit_stop: "explicit_stop";
110
+ session_shutdown: "session_shutdown";
111
+ timeout: "timeout";
112
+ service_exit: "service_exit";
113
+ }>>;
114
+ error: z.ZodOptional<z.ZodString>;
115
+ usage: z.ZodOptional<z.ZodObject<{
116
+ inputTokens: z.ZodOptional<z.ZodNumber>;
117
+ outputTokens: z.ZodOptional<z.ZodNumber>;
118
+ totalCost: z.ZodOptional<z.ZodNumber>;
119
+ }, z.core.$strip>>;
120
+ outputFiles: z.ZodOptional<z.ZodArray<z.ZodObject<{
121
+ path: z.ZodString;
122
+ name: z.ZodString;
123
+ size: z.ZodNumber;
124
+ }, z.core.$strip>>>;
125
+ }, z.core.$strip>;
126
+ export type BrowserUseResult = z.infer<typeof BrowserUseResultSchema>;
127
+ export interface BrowserUseAgent {
128
+ execute(task: string, options?: BrowserUseExecuteOptions): Promise<BrowserUseResult>;
129
+ }
130
+ export interface BrowserUseCodeAgent {
131
+ execute(task: string, options?: BrowserUseExecuteOptions): Promise<BrowserUseResult>;
132
+ }
133
+ export interface BrowserUseAPI {
134
+ agent(config?: BrowserUseAgentConfig): BrowserUseAgent;
135
+ codeAgent(config?: BrowserUseCodeAgentConfig): BrowserUseCodeAgent;
136
+ }
@@ -0,0 +1,93 @@
1
+ import { z } from 'zod';
2
+ import { AgentInvocationToolsSchema } from './agent-tools.js';
3
+ export const BrowserUseAgentConfigSchema = z.object({
4
+ llm: z.string().optional(),
5
+ pageId: z.uuid().optional(),
6
+ useVision: z.union([z.boolean(), z.literal('auto')]).optional(),
7
+ visionDetailLevel: z.enum(['low', 'high', 'auto']).optional(),
8
+ pageExtractionLlm: z.string().optional(),
9
+ fallbackLlm: z.string().optional(),
10
+ initialActions: z.array(z.unknown()).optional(),
11
+ maxActionsPerStep: z.number().int().positive().optional(),
12
+ maxFailures: z.number().int().nonnegative().optional(),
13
+ finalResponseAfterFailure: z.boolean().optional(),
14
+ useThinking: z.boolean().optional(),
15
+ flashMode: z.boolean().optional(),
16
+ overrideSystemMessage: z.string().optional(),
17
+ extendSystemMessage: z.string().optional(),
18
+ saveConversationPath: z.string().optional(),
19
+ saveConversationPathEncoding: z.string().optional(),
20
+ availableFilePaths: z.array(z.string()).optional(),
21
+ sensitiveData: z.record(z.string(), z.string()).optional(),
22
+ generateGif: z.union([z.boolean(), z.string()]).optional(),
23
+ includeAttributes: z.array(z.string()).optional(),
24
+ maxSteps: z.number().int().positive().optional(),
25
+ maxHistoryItems: z.number().int().positive().nullable().optional(),
26
+ llmTimeout: z.number().positive().optional(),
27
+ stepTimeout: z.number().positive().optional(),
28
+ directlyOpenUrl: z.boolean().optional(),
29
+ calculateCost: z.boolean().optional(),
30
+ displayFilesInDoneText: z.boolean().optional(),
31
+ }).loose();
32
+ export const BrowserUseExecuteOptionsSchema = z.object({
33
+ maxSteps: z.number().int().positive().optional(),
34
+ tools: AgentInvocationToolsSchema.optional(),
35
+ });
36
+ export const BrowserUseCodeAgentConfigSchema = z.object({
37
+ llm: z.string().optional(),
38
+ pageId: z.uuid().optional(),
39
+ maxSteps: z.number().int().positive().optional(),
40
+ maxFailures: z.number().int().nonnegative().optional(),
41
+ saveConversationPath: z.string().optional(),
42
+ }).loose();
43
+ export const BrowserUseStepSchema = z.object({
44
+ action: z.string(),
45
+ result: z.unknown().optional(),
46
+ screenshot: z.string().optional(),
47
+ timestamp: z.number(),
48
+ reasoning: z.string().optional(),
49
+ error: z.string().optional(),
50
+ });
51
+ export const BrowserUseUsageSchema = z.object({
52
+ inputTokens: z.number().optional(),
53
+ outputTokens: z.number().optional(),
54
+ totalCost: z.number().optional(),
55
+ });
56
+ export const BrowserUseOutputFileSchema = z.object({
57
+ path: z.string(),
58
+ name: z.string(),
59
+ size: z.number(),
60
+ });
61
+ export const BrowserUseInterruptionReasonSchema = z.enum([
62
+ 'explicit_stop',
63
+ 'session_shutdown',
64
+ 'timeout',
65
+ 'service_exit',
66
+ ]);
67
+ export const BrowserUseResultSchema = z.object({
68
+ finalResult: z.unknown(),
69
+ history: z.array(BrowserUseStepSchema),
70
+ isComplete: z.boolean(),
71
+ interrupted: z.boolean(),
72
+ interruptionReason: BrowserUseInterruptionReasonSchema.optional(),
73
+ error: z.string().optional(),
74
+ usage: BrowserUseUsageSchema.optional(),
75
+ outputFiles: z.array(BrowserUseOutputFileSchema).optional(),
76
+ }).superRefine((value, ctx) => {
77
+ if (value.interrupted) {
78
+ if (!value.interruptionReason) {
79
+ ctx.addIssue({
80
+ code: z.ZodIssueCode.custom,
81
+ message: 'interruptionReason is required when interrupted=true',
82
+ path: ['interruptionReason'],
83
+ });
84
+ }
85
+ if (value.isComplete) {
86
+ ctx.addIssue({
87
+ code: z.ZodIssueCode.custom,
88
+ message: 'isComplete must be false when interrupted=true',
89
+ path: ['isComplete'],
90
+ });
91
+ }
92
+ }
93
+ });
@@ -0,0 +1,114 @@
1
+ import { z } from 'zod';
2
+ export declare const CaptchaTypeSchema: z.ZodEnum<{
3
+ recaptcha_v2: "recaptcha_v2";
4
+ recaptcha_v3: "recaptcha_v3";
5
+ turnstile: "turnstile";
6
+ hcaptcha: "hcaptcha";
7
+ geetest_v3: "geetest_v3";
8
+ geetest_v4: "geetest_v4";
9
+ arkose: "arkose";
10
+ mtcaptcha: "mtcaptcha";
11
+ lemin: "lemin";
12
+ friendly_captcha: "friendly_captcha";
13
+ datadome: "datadome";
14
+ }>;
15
+ export type CaptchaType = z.infer<typeof CaptchaTypeSchema>;
16
+ export declare const CaptchaDetectArgsSchema: z.ZodOptional<z.ZodObject<{
17
+ types: z.ZodOptional<z.ZodArray<z.ZodEnum<{
18
+ recaptcha_v2: "recaptcha_v2";
19
+ recaptcha_v3: "recaptcha_v3";
20
+ turnstile: "turnstile";
21
+ hcaptcha: "hcaptcha";
22
+ geetest_v3: "geetest_v3";
23
+ geetest_v4: "geetest_v4";
24
+ arkose: "arkose";
25
+ mtcaptcha: "mtcaptcha";
26
+ lemin: "lemin";
27
+ friendly_captcha: "friendly_captcha";
28
+ datadome: "datadome";
29
+ }>>>;
30
+ }, z.core.$strip>>;
31
+ export type CaptchaDetectArgs = z.infer<typeof CaptchaDetectArgsSchema>;
32
+ export declare const CaptchaDetectionSchema: z.ZodObject<{
33
+ type: z.ZodEnum<{
34
+ recaptcha_v2: "recaptcha_v2";
35
+ recaptcha_v3: "recaptcha_v3";
36
+ turnstile: "turnstile";
37
+ hcaptcha: "hcaptcha";
38
+ geetest_v3: "geetest_v3";
39
+ geetest_v4: "geetest_v4";
40
+ arkose: "arkose";
41
+ mtcaptcha: "mtcaptcha";
42
+ lemin: "lemin";
43
+ friendly_captcha: "friendly_captcha";
44
+ datadome: "datadome";
45
+ }>;
46
+ siteKey: z.ZodOptional<z.ZodString>;
47
+ source: z.ZodEnum<{
48
+ dom: "dom";
49
+ script: "script";
50
+ network: "network";
51
+ }>;
52
+ }, z.core.$strip>;
53
+ export type CaptchaDetection = z.infer<typeof CaptchaDetectionSchema>;
54
+ export declare const CaptchaDetectResultSchema: z.ZodObject<{
55
+ found: z.ZodBoolean;
56
+ captchas: z.ZodArray<z.ZodObject<{
57
+ type: z.ZodEnum<{
58
+ recaptcha_v2: "recaptcha_v2";
59
+ recaptcha_v3: "recaptcha_v3";
60
+ turnstile: "turnstile";
61
+ hcaptcha: "hcaptcha";
62
+ geetest_v3: "geetest_v3";
63
+ geetest_v4: "geetest_v4";
64
+ arkose: "arkose";
65
+ mtcaptcha: "mtcaptcha";
66
+ lemin: "lemin";
67
+ friendly_captcha: "friendly_captcha";
68
+ datadome: "datadome";
69
+ }>;
70
+ siteKey: z.ZodOptional<z.ZodString>;
71
+ source: z.ZodEnum<{
72
+ dom: "dom";
73
+ script: "script";
74
+ network: "network";
75
+ }>;
76
+ }, z.core.$strip>>;
77
+ }, z.core.$strip>;
78
+ export type CaptchaDetectResult = z.infer<typeof CaptchaDetectResultSchema>;
79
+ export declare const CaptchaSolveArgsSchema: z.ZodOptional<z.ZodObject<{
80
+ type: z.ZodOptional<z.ZodEnum<{
81
+ recaptcha_v2: "recaptcha_v2";
82
+ recaptcha_v3: "recaptcha_v3";
83
+ turnstile: "turnstile";
84
+ hcaptcha: "hcaptcha";
85
+ geetest_v3: "geetest_v3";
86
+ geetest_v4: "geetest_v4";
87
+ arkose: "arkose";
88
+ mtcaptcha: "mtcaptcha";
89
+ lemin: "lemin";
90
+ friendly_captcha: "friendly_captcha";
91
+ datadome: "datadome";
92
+ }>>;
93
+ }, z.core.$strip>>;
94
+ export type CaptchaSolveArgs = z.infer<typeof CaptchaSolveArgsSchema>;
95
+ export declare const CaptchaSolveResultSchema: z.ZodObject<{
96
+ success: z.ZodBoolean;
97
+ type: z.ZodOptional<z.ZodEnum<{
98
+ recaptcha_v2: "recaptcha_v2";
99
+ recaptcha_v3: "recaptcha_v3";
100
+ turnstile: "turnstile";
101
+ hcaptcha: "hcaptcha";
102
+ geetest_v3: "geetest_v3";
103
+ geetest_v4: "geetest_v4";
104
+ arkose: "arkose";
105
+ mtcaptcha: "mtcaptcha";
106
+ lemin: "lemin";
107
+ friendly_captcha: "friendly_captcha";
108
+ datadome: "datadome";
109
+ }>>;
110
+ token: z.ZodOptional<z.ZodString>;
111
+ duration: z.ZodOptional<z.ZodNumber>;
112
+ error: z.ZodOptional<z.ZodString>;
113
+ }, z.core.$strip>;
114
+ export type CaptchaSolveResult = z.infer<typeof CaptchaSolveResultSchema>;
@@ -0,0 +1,40 @@
1
+ import { z } from 'zod';
2
+ export const CaptchaTypeSchema = z.enum([
3
+ 'recaptcha_v2',
4
+ 'recaptcha_v3',
5
+ 'turnstile',
6
+ 'hcaptcha',
7
+ 'geetest_v3',
8
+ 'geetest_v4',
9
+ 'arkose',
10
+ 'mtcaptcha',
11
+ 'lemin',
12
+ 'friendly_captcha',
13
+ 'datadome',
14
+ ]);
15
+ export const CaptchaDetectArgsSchema = z
16
+ .object({
17
+ types: z.array(CaptchaTypeSchema).optional(),
18
+ })
19
+ .optional();
20
+ export const CaptchaDetectionSchema = z.object({
21
+ type: CaptchaTypeSchema,
22
+ siteKey: z.string().optional(),
23
+ source: z.enum(['dom', 'script', 'network']),
24
+ });
25
+ export const CaptchaDetectResultSchema = z.object({
26
+ found: z.boolean(),
27
+ captchas: z.array(CaptchaDetectionSchema),
28
+ });
29
+ export const CaptchaSolveArgsSchema = z
30
+ .object({
31
+ type: CaptchaTypeSchema.optional(),
32
+ })
33
+ .optional();
34
+ export const CaptchaSolveResultSchema = z.object({
35
+ success: z.boolean(),
36
+ type: CaptchaTypeSchema.optional(),
37
+ token: z.string().optional(),
38
+ duration: z.number().optional(),
39
+ error: z.string().optional(),
40
+ });
@@ -0,0 +1,223 @@
1
+ import { z } from 'zod';
2
+ export declare const PointSchema: z.ZodObject<{
3
+ x: z.ZodNumber;
4
+ y: z.ZodNumber;
5
+ }, z.core.$strip>;
6
+ export declare const SizeSchema: z.ZodObject<{
7
+ width: z.ZodNumber;
8
+ height: z.ZodNumber;
9
+ }, z.core.$strip>;
10
+ export declare const BoundsSchema: z.ZodObject<{
11
+ x: z.ZodNumber;
12
+ y: z.ZodNumber;
13
+ width: z.ZodNumber;
14
+ height: z.ZodNumber;
15
+ }, z.core.$strip>;
16
+ export declare const WindowInfoSchema: z.ZodObject<{
17
+ handle: z.ZodNumber;
18
+ title: z.ZodString;
19
+ processId: z.ZodNumber;
20
+ bounds: z.ZodObject<{
21
+ x: z.ZodNumber;
22
+ y: z.ZodNumber;
23
+ width: z.ZodNumber;
24
+ height: z.ZodNumber;
25
+ }, z.core.$strip>;
26
+ isVisible: z.ZodBoolean;
27
+ isFocused: z.ZodBoolean;
28
+ }, z.core.$loose>;
29
+ export declare const DisplayInfoSchema: z.ZodObject<{
30
+ id: z.ZodNumber;
31
+ bounds: z.ZodObject<{
32
+ x: z.ZodNumber;
33
+ y: z.ZodNumber;
34
+ width: z.ZodNumber;
35
+ height: z.ZodNumber;
36
+ }, z.core.$strip>;
37
+ isPrimary: z.ZodBoolean;
38
+ scaleFactor: z.ZodNumber;
39
+ }, z.core.$loose>;
40
+ export declare const BrowserLaunchResultSchema: z.ZodObject<{
41
+ pid: z.ZodNumber;
42
+ cdpUrl: z.ZodString;
43
+ debuggerUrl: z.ZodString;
44
+ sessionId: z.ZodString;
45
+ defaultContextId: z.ZodString;
46
+ defaultPageId: z.ZodString;
47
+ }, z.core.$loose>;
48
+ export type Point = z.infer<typeof PointSchema>;
49
+ export type Size = z.infer<typeof SizeSchema>;
50
+ export type Bounds = z.infer<typeof BoundsSchema>;
51
+ export type WindowInfo = z.infer<typeof WindowInfoSchema>;
52
+ export type DisplayInfo = z.infer<typeof DisplayInfoSchema>;
53
+ export type BrowserLaunchResult = z.infer<typeof BrowserLaunchResultSchema>;
54
+ export declare const CuaAgentConfigSchema: z.ZodObject<{
55
+ model: z.ZodOptional<z.ZodString>;
56
+ maxTrajectoryBudget: z.ZodOptional<z.ZodNumber>;
57
+ systemPrompt: z.ZodOptional<z.ZodString>;
58
+ apiKey: z.ZodOptional<z.ZodString>;
59
+ }, z.core.$strip>;
60
+ export declare const CuaRunOptionsSchema: z.ZodObject<{
61
+ maxSteps: z.ZodOptional<z.ZodNumber>;
62
+ actionDelay: z.ZodOptional<z.ZodNumber>;
63
+ screenshotBeforeAction: z.ZodOptional<z.ZodBoolean>;
64
+ }, z.core.$strip>;
65
+ export type CuaAgentConfig = z.infer<typeof CuaAgentConfigSchema>;
66
+ export type CuaRunOptions = z.infer<typeof CuaRunOptionsSchema>;
67
+ export declare const CuaActionSchema: z.ZodObject<{
68
+ type: z.ZodEnum<{
69
+ type: "type";
70
+ key: "key";
71
+ screenshot: "screenshot";
72
+ wait: "wait";
73
+ click: "click";
74
+ drag: "drag";
75
+ scroll: "scroll";
76
+ left_click: "left_click";
77
+ right_click: "right_click";
78
+ double_click: "double_click";
79
+ keypress: "keypress";
80
+ hotkey: "hotkey";
81
+ mouse_move: "mouse_move";
82
+ move: "move";
83
+ }>;
84
+ coordinates: z.ZodOptional<z.ZodObject<{
85
+ x: z.ZodNumber;
86
+ y: z.ZodNumber;
87
+ }, z.core.$strip>>;
88
+ fromCoordinates: z.ZodOptional<z.ZodObject<{
89
+ x: z.ZodNumber;
90
+ y: z.ZodNumber;
91
+ }, z.core.$strip>>;
92
+ toCoordinates: z.ZodOptional<z.ZodObject<{
93
+ x: z.ZodNumber;
94
+ y: z.ZodNumber;
95
+ }, z.core.$strip>>;
96
+ text: z.ZodOptional<z.ZodString>;
97
+ key: z.ZodOptional<z.ZodString>;
98
+ keys: z.ZodOptional<z.ZodArray<z.ZodString>>;
99
+ direction: z.ZodOptional<z.ZodEnum<{
100
+ left: "left";
101
+ right: "right";
102
+ up: "up";
103
+ down: "down";
104
+ }>>;
105
+ duration: z.ZodOptional<z.ZodNumber>;
106
+ }, z.core.$loose>;
107
+ export declare const CuaResultSchema: z.ZodObject<{
108
+ type: z.ZodEnum<{
109
+ error: "error";
110
+ message: "message";
111
+ action: "action";
112
+ reasoning: "reasoning";
113
+ complete: "complete";
114
+ }>;
115
+ content: z.ZodOptional<z.ZodString>;
116
+ action: z.ZodOptional<z.ZodObject<{
117
+ type: z.ZodEnum<{
118
+ type: "type";
119
+ key: "key";
120
+ screenshot: "screenshot";
121
+ wait: "wait";
122
+ click: "click";
123
+ drag: "drag";
124
+ scroll: "scroll";
125
+ left_click: "left_click";
126
+ right_click: "right_click";
127
+ double_click: "double_click";
128
+ keypress: "keypress";
129
+ hotkey: "hotkey";
130
+ mouse_move: "mouse_move";
131
+ move: "move";
132
+ }>;
133
+ coordinates: z.ZodOptional<z.ZodObject<{
134
+ x: z.ZodNumber;
135
+ y: z.ZodNumber;
136
+ }, z.core.$strip>>;
137
+ fromCoordinates: z.ZodOptional<z.ZodObject<{
138
+ x: z.ZodNumber;
139
+ y: z.ZodNumber;
140
+ }, z.core.$strip>>;
141
+ toCoordinates: z.ZodOptional<z.ZodObject<{
142
+ x: z.ZodNumber;
143
+ y: z.ZodNumber;
144
+ }, z.core.$strip>>;
145
+ text: z.ZodOptional<z.ZodString>;
146
+ key: z.ZodOptional<z.ZodString>;
147
+ keys: z.ZodOptional<z.ZodArray<z.ZodString>>;
148
+ direction: z.ZodOptional<z.ZodEnum<{
149
+ left: "left";
150
+ right: "right";
151
+ up: "up";
152
+ down: "down";
153
+ }>>;
154
+ duration: z.ZodOptional<z.ZodNumber>;
155
+ }, z.core.$loose>>;
156
+ toolUseId: z.ZodOptional<z.ZodString>;
157
+ }, z.core.$loose>;
158
+ export declare const CuaRunResultSchema: z.ZodObject<{
159
+ success: z.ZodBoolean;
160
+ steps: z.ZodArray<z.ZodObject<{
161
+ type: z.ZodEnum<{
162
+ error: "error";
163
+ message: "message";
164
+ action: "action";
165
+ reasoning: "reasoning";
166
+ complete: "complete";
167
+ }>;
168
+ content: z.ZodOptional<z.ZodString>;
169
+ action: z.ZodOptional<z.ZodObject<{
170
+ type: z.ZodEnum<{
171
+ type: "type";
172
+ key: "key";
173
+ screenshot: "screenshot";
174
+ wait: "wait";
175
+ click: "click";
176
+ drag: "drag";
177
+ scroll: "scroll";
178
+ left_click: "left_click";
179
+ right_click: "right_click";
180
+ double_click: "double_click";
181
+ keypress: "keypress";
182
+ hotkey: "hotkey";
183
+ mouse_move: "mouse_move";
184
+ move: "move";
185
+ }>;
186
+ coordinates: z.ZodOptional<z.ZodObject<{
187
+ x: z.ZodNumber;
188
+ y: z.ZodNumber;
189
+ }, z.core.$strip>>;
190
+ fromCoordinates: z.ZodOptional<z.ZodObject<{
191
+ x: z.ZodNumber;
192
+ y: z.ZodNumber;
193
+ }, z.core.$strip>>;
194
+ toCoordinates: z.ZodOptional<z.ZodObject<{
195
+ x: z.ZodNumber;
196
+ y: z.ZodNumber;
197
+ }, z.core.$strip>>;
198
+ text: z.ZodOptional<z.ZodString>;
199
+ key: z.ZodOptional<z.ZodString>;
200
+ keys: z.ZodOptional<z.ZodArray<z.ZodString>>;
201
+ direction: z.ZodOptional<z.ZodEnum<{
202
+ left: "left";
203
+ right: "right";
204
+ up: "up";
205
+ down: "down";
206
+ }>>;
207
+ duration: z.ZodOptional<z.ZodNumber>;
208
+ }, z.core.$loose>>;
209
+ toolUseId: z.ZodOptional<z.ZodString>;
210
+ }, z.core.$loose>>;
211
+ totalSteps: z.ZodNumber;
212
+ error: z.ZodOptional<z.ZodString>;
213
+ }, z.core.$loose>;
214
+ export declare const CuaPredictClickResultSchema: z.ZodObject<{
215
+ x: z.ZodNumber;
216
+ y: z.ZodNumber;
217
+ confidence: z.ZodOptional<z.ZodNumber>;
218
+ description: z.ZodOptional<z.ZodString>;
219
+ }, z.core.$loose>;
220
+ export type CuaAction = z.infer<typeof CuaActionSchema>;
221
+ export type CuaResult = z.infer<typeof CuaResultSchema>;
222
+ export type CuaRunResult = z.infer<typeof CuaRunResultSchema>;
223
+ export type CuaPredictClickResult = z.infer<typeof CuaPredictClickResultSchema>;