@bctrl/sdk 1.0.1 → 1.0.3

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 (277) hide show
  1. package/README.md +28 -29
  2. package/dist/bctrl.d.ts +22 -36
  3. package/dist/bctrl.js +40 -75
  4. package/dist/errors.d.ts +49 -43
  5. package/dist/errors.js +83 -120
  6. package/dist/files.d.ts +31 -0
  7. package/dist/files.js +97 -0
  8. package/dist/http.d.ts +18 -0
  9. package/dist/http.js +135 -0
  10. package/dist/index.d.ts +9 -12
  11. package/dist/index.js +7 -23
  12. package/dist/invocations.d.ts +86 -0
  13. package/dist/invocations.js +159 -0
  14. package/dist/pagination.d.ts +2 -0
  15. package/dist/pagination.js +13 -0
  16. package/dist/runs.d.ts +40 -0
  17. package/dist/runs.js +105 -0
  18. package/dist/runtimes.d.ts +69 -0
  19. package/dist/runtimes.js +202 -0
  20. package/dist/spaces.d.ts +40 -0
  21. package/dist/spaces.js +96 -0
  22. package/dist/types.d.ts +413 -0
  23. package/dist/types.js +1 -0
  24. package/dist/utils.d.ts +4 -0
  25. package/dist/utils.js +27 -0
  26. package/dist/version.js +2 -2
  27. package/package.json +4 -21
  28. package/dist/agents/browser-use/index.d.ts +0 -1
  29. package/dist/agents/browser-use/index.js +0 -9
  30. package/dist/agents/browser-use/namespace.d.ts +0 -39
  31. package/dist/agents/browser-use/namespace.js +0 -93
  32. package/dist/agents/index.d.ts +0 -2
  33. package/dist/agents/index.js +0 -17
  34. package/dist/agents/stagehand/core.d.ts +0 -93
  35. package/dist/agents/stagehand/core.js +0 -144
  36. package/dist/agents/stagehand/index.d.ts +0 -3
  37. package/dist/agents/stagehand/index.js +0 -24
  38. package/dist/agents/stagehand/namespace.d.ts +0 -51
  39. package/dist/agents/stagehand/namespace.js +0 -65
  40. package/dist/ai-credentials/client.d.ts +0 -12
  41. package/dist/ai-credentials/client.js +0 -70
  42. package/dist/ai-credentials/index.d.ts +0 -1
  43. package/dist/ai-credentials/index.js +0 -1
  44. package/dist/base/event-binding.d.ts +0 -7
  45. package/dist/base/event-binding.js +0 -23
  46. package/dist/base/types.d.ts +0 -109
  47. package/dist/base/types.js +0 -4
  48. package/dist/browser-extensions/client.d.ts +0 -15
  49. package/dist/browser-extensions/client.js +0 -72
  50. package/dist/browser-extensions/index.d.ts +0 -2
  51. package/dist/browser-extensions/index.js +0 -1
  52. package/dist/browser-profiles/client.d.ts +0 -11
  53. package/dist/browser-profiles/client.js +0 -63
  54. package/dist/browser-profiles/index.d.ts +0 -1
  55. package/dist/browser-profiles/index.js +0 -1
  56. package/dist/captcha/index.d.ts +0 -1
  57. package/dist/captcha/index.js +0 -1
  58. package/dist/captcha/namespace.d.ts +0 -34
  59. package/dist/captcha/namespace.js +0 -41
  60. package/dist/client/index.d.ts +0 -1
  61. package/dist/client/index.js +0 -1
  62. package/dist/client/rpc.d.ts +0 -83
  63. package/dist/client/rpc.js +0 -354
  64. package/dist/config.d.ts +0 -5
  65. package/dist/config.js +0 -28
  66. package/dist/constants/browser.d.ts +0 -2
  67. package/dist/constants/browser.js +0 -1
  68. package/dist/contracts/agent-tools.d.ts +0 -45
  69. package/dist/contracts/agent-tools.js +0 -31
  70. package/dist/contracts/automation.d.ts +0 -265
  71. package/dist/contracts/automation.js +0 -109
  72. package/dist/contracts/browser-management.d.ts +0 -179
  73. package/dist/contracts/browser-management.js +0 -95
  74. package/dist/contracts/browser-use.d.ts +0 -136
  75. package/dist/contracts/browser-use.js +0 -93
  76. package/dist/contracts/captcha.d.ts +0 -114
  77. package/dist/contracts/captcha.js +0 -40
  78. package/dist/contracts/desktop.d.ts +0 -223
  79. package/dist/contracts/desktop.js +0 -121
  80. package/dist/contracts/drivers/playwright.d.ts +0 -2008
  81. package/dist/contracts/drivers/playwright.js +0 -2033
  82. package/dist/contracts/drivers/puppeteer.d.ts +0 -1221
  83. package/dist/contracts/drivers/puppeteer.js +0 -941
  84. package/dist/contracts/drivers/selenium.d.ts +0 -156
  85. package/dist/contracts/drivers/selenium.js +0 -61
  86. package/dist/contracts/drivers/stagehand.d.ts +0 -155
  87. package/dist/contracts/drivers/stagehand.js +0 -7
  88. package/dist/contracts/extensions.d.ts +0 -13
  89. package/dist/contracts/extensions.js +0 -9
  90. package/dist/contracts/index.d.ts +0 -13
  91. package/dist/contracts/index.js +0 -13
  92. package/dist/contracts/public-api.d.ts +0 -360
  93. package/dist/contracts/public-api.js +0 -17
  94. package/dist/contracts/runtime.d.ts +0 -81
  95. package/dist/contracts/runtime.js +0 -16
  96. package/dist/contracts/stagehand.d.ts +0 -253
  97. package/dist/contracts/stagehand.js +0 -145
  98. package/dist/contracts/storage.d.ts +0 -51
  99. package/dist/contracts/storage.js +0 -56
  100. package/dist/contracts/vault.d.ts +0 -119
  101. package/dist/contracts/vault.js +0 -112
  102. package/dist/contracts/version.d.ts +0 -3
  103. package/dist/contracts/version.js +0 -16
  104. package/dist/desktop.d.ts +0 -2
  105. package/dist/desktop.js +0 -3
  106. package/dist/drivers/desktop/index.d.ts +0 -65
  107. package/dist/drivers/desktop/index.js +0 -68
  108. package/dist/drivers/desktop/session.d.ts +0 -313
  109. package/dist/drivers/desktop/session.js +0 -432
  110. package/dist/drivers/playwright/event-emitter.d.ts +0 -160
  111. package/dist/drivers/playwright/event-emitter.js +0 -297
  112. package/dist/drivers/playwright/generated/api-request-context.d.ts +0 -137
  113. package/dist/drivers/playwright/generated/api-request-context.js +0 -154
  114. package/dist/drivers/playwright/generated/api-response.d.ts +0 -119
  115. package/dist/drivers/playwright/generated/api-response.js +0 -123
  116. package/dist/drivers/playwright/generated/browser-context.d.ts +0 -284
  117. package/dist/drivers/playwright/generated/browser-context.js +0 -458
  118. package/dist/drivers/playwright/generated/browser.d.ts +0 -120
  119. package/dist/drivers/playwright/generated/browser.js +0 -151
  120. package/dist/drivers/playwright/generated/clock.d.ts +0 -80
  121. package/dist/drivers/playwright/generated/clock.js +0 -94
  122. package/dist/drivers/playwright/generated/console-message.d.ts +0 -94
  123. package/dist/drivers/playwright/generated/console-message.js +0 -89
  124. package/dist/drivers/playwright/generated/coverage.d.ts +0 -57
  125. package/dist/drivers/playwright/generated/coverage.js +0 -66
  126. package/dist/drivers/playwright/generated/dialog.d.ts +0 -79
  127. package/dist/drivers/playwright/generated/dialog.js +0 -80
  128. package/dist/drivers/playwright/generated/element-handle.d.ts +0 -399
  129. package/dist/drivers/playwright/generated/element-handle.js +0 -501
  130. package/dist/drivers/playwright/generated/frame-locator.d.ts +0 -34
  131. package/dist/drivers/playwright/generated/frame-locator.js +0 -63
  132. package/dist/drivers/playwright/generated/frame.d.ts +0 -557
  133. package/dist/drivers/playwright/generated/frame.js +0 -634
  134. package/dist/drivers/playwright/generated/js-handle.d.ts +0 -72
  135. package/dist/drivers/playwright/generated/js-handle.js +0 -92
  136. package/dist/drivers/playwright/generated/keyboard.d.ts +0 -103
  137. package/dist/drivers/playwright/generated/keyboard.js +0 -113
  138. package/dist/drivers/playwright/generated/locator.d.ts +0 -795
  139. package/dist/drivers/playwright/generated/locator.js +0 -974
  140. package/dist/drivers/playwright/generated/mouse.d.ts +0 -97
  141. package/dist/drivers/playwright/generated/mouse.js +0 -109
  142. package/dist/drivers/playwright/generated/page.d.ts +0 -762
  143. package/dist/drivers/playwright/generated/page.js +0 -988
  144. package/dist/drivers/playwright/generated/touchscreen.d.ts +0 -34
  145. package/dist/drivers/playwright/generated/touchscreen.js +0 -37
  146. package/dist/drivers/playwright/generated/tracing.d.ts +0 -78
  147. package/dist/drivers/playwright/generated/tracing.js +0 -80
  148. package/dist/drivers/playwright/generated/worker.d.ts +0 -53
  149. package/dist/drivers/playwright/generated/worker.js +0 -59
  150. package/dist/drivers/playwright/index.d.ts +0 -19
  151. package/dist/drivers/playwright/index.js +0 -20
  152. package/dist/drivers/playwright/remote-base.d.ts +0 -62
  153. package/dist/drivers/playwright/remote-base.js +0 -86
  154. package/dist/drivers/playwright/types.d.ts +0 -148
  155. package/dist/drivers/playwright/types.js +0 -8
  156. package/dist/drivers/puppeteer/errors.d.ts +0 -50
  157. package/dist/drivers/puppeteer/errors.js +0 -71
  158. package/dist/drivers/puppeteer/event-emitter.d.ts +0 -145
  159. package/dist/drivers/puppeteer/event-emitter.js +0 -259
  160. package/dist/drivers/puppeteer/generated/accessibility.d.ts +0 -77
  161. package/dist/drivers/puppeteer/generated/accessibility.js +0 -74
  162. package/dist/drivers/puppeteer/generated/browser-context.d.ts +0 -116
  163. package/dist/drivers/puppeteer/generated/browser-context.js +0 -168
  164. package/dist/drivers/puppeteer/generated/browser.d.ts +0 -169
  165. package/dist/drivers/puppeteer/generated/browser.js +0 -246
  166. package/dist/drivers/puppeteer/generated/console-message.d.ts +0 -54
  167. package/dist/drivers/puppeteer/generated/console-message.js +0 -69
  168. package/dist/drivers/puppeteer/generated/coverage.d.ts +0 -49
  169. package/dist/drivers/puppeteer/generated/coverage.js +0 -57
  170. package/dist/drivers/puppeteer/generated/dialog.d.ts +0 -46
  171. package/dist/drivers/puppeteer/generated/dialog.js +0 -60
  172. package/dist/drivers/puppeteer/generated/element-handle.d.ts +0 -261
  173. package/dist/drivers/puppeteer/generated/element-handle.js +0 -341
  174. package/dist/drivers/puppeteer/generated/file-chooser.d.ts +0 -34
  175. package/dist/drivers/puppeteer/generated/file-chooser.js +0 -43
  176. package/dist/drivers/puppeteer/generated/frame.d.ts +0 -221
  177. package/dist/drivers/puppeteer/generated/frame.js +0 -302
  178. package/dist/drivers/puppeteer/generated/http-request.d.ts +0 -195
  179. package/dist/drivers/puppeteer/generated/http-request.js +0 -243
  180. package/dist/drivers/puppeteer/generated/http-response.d.ts +0 -142
  181. package/dist/drivers/puppeteer/generated/http-response.js +0 -169
  182. package/dist/drivers/puppeteer/generated/js-handle.d.ts +0 -104
  183. package/dist/drivers/puppeteer/generated/js-handle.js +0 -125
  184. package/dist/drivers/puppeteer/generated/keyboard.d.ts +0 -79
  185. package/dist/drivers/puppeteer/generated/keyboard.js +0 -89
  186. package/dist/drivers/puppeteer/generated/locator.d.ts +0 -141
  187. package/dist/drivers/puppeteer/generated/locator.js +0 -164
  188. package/dist/drivers/puppeteer/generated/mouse.d.ts +0 -74
  189. package/dist/drivers/puppeteer/generated/mouse.js +0 -94
  190. package/dist/drivers/puppeteer/generated/page.d.ts +0 -604
  191. package/dist/drivers/puppeteer/generated/page.js +0 -776
  192. package/dist/drivers/puppeteer/generated/target.d.ts +0 -105
  193. package/dist/drivers/puppeteer/generated/target.js +0 -123
  194. package/dist/drivers/puppeteer/generated/touchscreen.d.ts +0 -87
  195. package/dist/drivers/puppeteer/generated/touchscreen.js +0 -103
  196. package/dist/drivers/puppeteer/generated/tracing.d.ts +0 -38
  197. package/dist/drivers/puppeteer/generated/tracing.js +0 -43
  198. package/dist/drivers/puppeteer/generated/web-worker.d.ts +0 -63
  199. package/dist/drivers/puppeteer/generated/web-worker.js +0 -73
  200. package/dist/drivers/puppeteer/index.d.ts +0 -21
  201. package/dist/drivers/puppeteer/index.js +0 -23
  202. package/dist/drivers/puppeteer/remote-base.d.ts +0 -57
  203. package/dist/drivers/puppeteer/remote-base.js +0 -79
  204. package/dist/drivers/puppeteer/types.d.ts +0 -178
  205. package/dist/drivers/puppeteer/types.js +0 -8
  206. package/dist/drivers/selenium/driver.d.ts +0 -28
  207. package/dist/drivers/selenium/driver.js +0 -169
  208. package/dist/drivers/selenium/element.d.ts +0 -34
  209. package/dist/drivers/selenium/element.js +0 -73
  210. package/dist/drivers/selenium/index.d.ts +0 -3
  211. package/dist/drivers/selenium/index.js +0 -5
  212. package/dist/drivers/selenium/types.d.ts +0 -2
  213. package/dist/drivers/selenium/types.js +0 -12
  214. package/dist/drivers/stagehand/generated/context.d.ts +0 -127
  215. package/dist/drivers/stagehand/generated/context.js +0 -153
  216. package/dist/drivers/stagehand/generated/locator.d.ts +0 -324
  217. package/dist/drivers/stagehand/generated/locator.js +0 -368
  218. package/dist/drivers/stagehand/generated/page.d.ts +0 -377
  219. package/dist/drivers/stagehand/generated/page.js +0 -439
  220. package/dist/drivers/stagehand/generated/response.d.ts +0 -197
  221. package/dist/drivers/stagehand/generated/response.js +0 -232
  222. package/dist/drivers/stagehand/index.d.ts +0 -5
  223. package/dist/drivers/stagehand/index.js +0 -8
  224. package/dist/drivers/stagehand/types.d.ts +0 -1
  225. package/dist/drivers/stagehand/types.js +0 -7
  226. package/dist/extensions/client.d.ts +0 -47
  227. package/dist/extensions/client.js +0 -154
  228. package/dist/extensions/index.d.ts +0 -1
  229. package/dist/extensions/index.js +0 -1
  230. package/dist/internal/dev-client.d.ts +0 -5
  231. package/dist/internal/dev-client.js +0 -9
  232. package/dist/internal/rpc-targets.d.ts +0 -17
  233. package/dist/internal/rpc-targets.js +0 -58
  234. package/dist/internal/serialization.d.ts +0 -32
  235. package/dist/internal/serialization.js +0 -42
  236. package/dist/internal/transport.d.ts +0 -24
  237. package/dist/internal/transport.js +0 -29
  238. package/dist/playwright.d.ts +0 -1
  239. package/dist/playwright.js +0 -2
  240. package/dist/puppeteer.d.ts +0 -1
  241. package/dist/puppeteer.js +0 -2
  242. package/dist/selenium.d.ts +0 -1
  243. package/dist/selenium.js +0 -2
  244. package/dist/stagehand.d.ts +0 -1
  245. package/dist/stagehand.js +0 -2
  246. package/dist/storage/client.d.ts +0 -151
  247. package/dist/storage/client.js +0 -329
  248. package/dist/storage/index.d.ts +0 -2
  249. package/dist/storage/index.js +0 -4
  250. package/dist/telemetry.d.ts +0 -18
  251. package/dist/telemetry.js +0 -93
  252. package/dist/updates/client.d.ts +0 -8
  253. package/dist/updates/client.js +0 -128
  254. package/dist/updates/index.d.ts +0 -1
  255. package/dist/updates/index.js +0 -1
  256. package/dist/utils/http.d.ts +0 -39
  257. package/dist/utils/http.js +0 -88
  258. package/dist/utils/index.d.ts +0 -4
  259. package/dist/utils/index.js +0 -4
  260. package/dist/utils/logger.d.ts +0 -27
  261. package/dist/utils/logger.js +0 -74
  262. package/dist/utils/schema.d.ts +0 -17
  263. package/dist/utils/schema.js +0 -31
  264. package/dist/utils/url.d.ts +0 -5
  265. package/dist/utils/url.js +0 -7
  266. package/dist/vault/client.d.ts +0 -43
  267. package/dist/vault/client.js +0 -123
  268. package/dist/vault/index.d.ts +0 -1
  269. package/dist/vault/index.js +0 -1
  270. package/dist/workspaces/browser-runtime.d.ts +0 -251
  271. package/dist/workspaces/browser-runtime.js +0 -1025
  272. package/dist/workspaces/client.d.ts +0 -48
  273. package/dist/workspaces/client.js +0 -222
  274. package/dist/workspaces/index.d.ts +0 -2
  275. package/dist/workspaces/index.js +0 -2
  276. package/dist/workspaces/runtime-event-pump.d.ts +0 -65
  277. package/dist/workspaces/runtime-event-pump.js +0 -716
@@ -1,77 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
5
- * Run `pnpm generate:puppeteer` to regenerate.
6
- */
7
- import type { HasHandleId, SimpleRpcSender } from '../../../internal/transport.js';
8
- import { RemoteComponentBase } from '../remote-base.js';
9
- import type { PuppeteerSerializedAXNode } from '../types.js';
10
- /**
11
- * Options for SDK method. Wraps PuppeteerSnapshotOptions with SDK-friendly types.
12
- */
13
- export interface SnapshotOptions {
14
- /**
15
- * Prune uninteresting nodes from the tree. @default true
16
- */
17
- interestingOnly?: boolean;
18
- /**
19
- * Root element to get the accessibility tree for. Can be a handle ID string or any object with a handleId property (e.g., RemotePuppeteerElementHandle). If not provided, defaults to the root node of the entire page.
20
- */
21
- root?: string | HasHandleId;
22
- }
23
- /**
24
- * RemotePuppeteerAccessibility - Remote Puppeteer Accessibility API over RPC.
25
- *
26
- * @see https://pptr.dev/api/puppeteer.accessibility
27
- */
28
- export declare class RemotePuppeteerAccessibility extends RemoteComponentBase {
29
- constructor(sendRpc: SimpleRpcSender);
30
- /**
31
- * Captures the current state of the accessibility tree.
32
- * @param options - Options for the snapshot.
33
- * @returns A promise that resolves to the root AXNode object representing the snapshot of the accessibility tree, or `null` if the tree is empty.
34
- *
35
- * @remarks
36
- * The accessibility tree is used by assistive technology such as screen readers or switches.
37
- *
38
- * Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then
39
- * translated into different platform-specific APIs. Accessibility namespace gives users access
40
- * to the Blink Accessibility Tree.
41
- *
42
- * Most of the accessibility tree gets filtered out when converting from Blink AX Tree to
43
- * Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer
44
- * tries to approximate this filtering, exposing only the "interesting" nodes of the tree.
45
- *
46
- * **NOTE:** The Chrome accessibility tree contains nodes that go unused on most platforms
47
- * and by most screen readers. Puppeteer will discard them as well for an easier to process
48
- * tree, unless `interestingOnly` is set to `false`.
49
- *
50
- * @example
51
- * An example of dumping the entire accessibility tree:
52
- * ```ts
53
- * const snapshot = await page.accessibility.snapshot();
54
- * console.log(snapshot);
55
- * ```
56
- *
57
- * @example
58
- * An example of logging the focused node's name:
59
- * ```ts
60
- * const snapshot = await page.accessibility.snapshot();
61
- * const node = findFocusedNode(snapshot);
62
- * console.log(node && node.name);
63
- *
64
- * function findFocusedNode(node: SerializedAXNode): SerializedAXNode | null {
65
- * if (node.focused) return node;
66
- * for (const child of node.children || []) {
67
- * const focusedChild = findFocusedNode(child);
68
- * if (focusedChild) return focusedChild;
69
- * }
70
- * return null;
71
- * }
72
- * ```
73
- *
74
- * @see https://pptr.dev/api/puppeteer.accessibility.snapshot
75
- */
76
- snapshot(options?: SnapshotOptions): Promise<PuppeteerSerializedAXNode | null>;
77
- }
@@ -1,74 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
5
- * Run `pnpm generate:puppeteer` to regenerate.
6
- */
7
- import { extractHandleId } from '../../../internal/transport.js';
8
- import { RemoteComponentBase } from '../remote-base.js';
9
- /**
10
- * RemotePuppeteerAccessibility - Remote Puppeteer Accessibility API over RPC.
11
- *
12
- * @see https://pptr.dev/api/puppeteer.accessibility
13
- */
14
- export class RemotePuppeteerAccessibility extends RemoteComponentBase {
15
- constructor(sendRpc) {
16
- super(sendRpc);
17
- }
18
- /**
19
- * Captures the current state of the accessibility tree.
20
- * @param options - Options for the snapshot.
21
- * @returns A promise that resolves to the root AXNode object representing the snapshot of the accessibility tree, or `null` if the tree is empty.
22
- *
23
- * @remarks
24
- * The accessibility tree is used by assistive technology such as screen readers or switches.
25
- *
26
- * Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then
27
- * translated into different platform-specific APIs. Accessibility namespace gives users access
28
- * to the Blink Accessibility Tree.
29
- *
30
- * Most of the accessibility tree gets filtered out when converting from Blink AX Tree to
31
- * Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer
32
- * tries to approximate this filtering, exposing only the "interesting" nodes of the tree.
33
- *
34
- * **NOTE:** The Chrome accessibility tree contains nodes that go unused on most platforms
35
- * and by most screen readers. Puppeteer will discard them as well for an easier to process
36
- * tree, unless `interestingOnly` is set to `false`.
37
- *
38
- * @example
39
- * An example of dumping the entire accessibility tree:
40
- * ```ts
41
- * const snapshot = await page.accessibility.snapshot();
42
- * console.log(snapshot);
43
- * ```
44
- *
45
- * @example
46
- * An example of logging the focused node's name:
47
- * ```ts
48
- * const snapshot = await page.accessibility.snapshot();
49
- * const node = findFocusedNode(snapshot);
50
- * console.log(node && node.name);
51
- *
52
- * function findFocusedNode(node: SerializedAXNode): SerializedAXNode | null {
53
- * if (node.focused) return node;
54
- * for (const child of node.children || []) {
55
- * const focusedChild = findFocusedNode(child);
56
- * if (focusedChild) return focusedChild;
57
- * }
58
- * return null;
59
- * }
60
- * ```
61
- *
62
- * @see https://pptr.dev/api/puppeteer.accessibility.snapshot
63
- */
64
- async snapshot(options) {
65
- // Convert options to RPC-friendly format
66
- const rpcOptions = options
67
- ? {
68
- interestingOnly: options.interestingOnly,
69
- root: extractHandleId(options.root),
70
- }
71
- : undefined;
72
- return this.rpc('accessibility.snapshot', [rpcOptions]);
73
- }
74
- }
@@ -1,116 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
5
- * Run `pnpm generate:puppeteer` to regenerate.
6
- */
7
- import type { SimpleRpcSender } from '../../../internal/transport.js';
8
- import { PuppeteerEventEmitter } from '../event-emitter.js';
9
- import type { RemotePuppeteerPage } from './page.js';
10
- import type { BrowserContextEvents, PuppeteerCookie, PuppeteerCookieData, PuppeteerDeleteCookiesRequest, PuppeteerPermission, PuppeteerTarget } from '../types.js';
11
- /**
12
- * RemotePuppeteerBrowserContext - Remote Puppeteer BrowserContext API over RPC.
13
- *
14
- * @see https://pptr.dev/api/puppeteer.browsercontext
15
- */
16
- export declare class RemotePuppeteerBrowserContext extends PuppeteerEventEmitter<BrowserContextEvents> {
17
- private createPage;
18
- protected sendRpc: SimpleRpcSender;
19
- constructor(sendRpc: SimpleRpcSender, options: {
20
- contextId: string;
21
- isDefault?: boolean;
22
- }, createPage: (pageId: string) => RemotePuppeteerPage);
23
- private _contextId;
24
- private _isDefault;
25
- private _isClosed;
26
- private _pages;
27
- /** Get the context ID. */
28
- get id(): string;
29
- /** Whether this is the default context. */
30
- get isDefault(): boolean;
31
- /** Whether this context has been closed. */
32
- get closed(): boolean;
33
- /**
34
- * Mark this context as closed (internal use).
35
- */
36
- markClosed(): void;
37
- private rpc;
38
- /**
39
- * Gets a list of all open pages inside this browser context.
40
- * @see https://pptr.dev/api/puppeteer.browsercontext.pages
41
- */
42
- pages(includeAll?: boolean): Promise<RemotePuppeteerPage[]>;
43
- /**
44
- * Creates a new page in this browser context.
45
- * @see https://pptr.dev/api/puppeteer.browsercontext.newpage
46
- */
47
- newPage(options?: {
48
- timeout?: number;
49
- }): Promise<RemotePuppeteerPage>;
50
- /**
51
- * Close this browser context.
52
- * @see https://pptr.dev/api/puppeteer.browsercontext.close
53
- */
54
- close(): Promise<void>;
55
- /**
56
- * Gets all cookies in this browser context.
57
- *
58
- * @see https://pptr.dev/api/puppeteer.browsercontext.cookies
59
- */
60
- cookies(...urls: string[]): Promise<PuppeteerCookie[]>;
61
- /**
62
- * Sets cookies in this browser context.
63
- *
64
- * @see https://pptr.dev/api/puppeteer.browsercontext.setcookie
65
- */
66
- setCookie(...cookies: PuppeteerCookieData[]): Promise<void>;
67
- /**
68
- * Deletes cookies from this browser context.
69
- *
70
- * @see https://pptr.dev/api/puppeteer.browsercontext.deletecookie
71
- */
72
- deleteCookie(...cookies: PuppeteerCookie[]): Promise<void>;
73
- /**
74
- * Deletes cookies matching the filter criteria from this browser context.
75
- *
76
- * @see https://pptr.dev/api/puppeteer.browsercontext.deletematchingcookies
77
- */
78
- deleteMatchingCookies(...filters: PuppeteerDeleteCookiesRequest[]): Promise<void>;
79
- /**
80
- * Grants this browser context the given permissions within the given origin.
81
- *
82
- * @remarks
83
- * All permissions that are not listed will be automatically denied.
84
- *
85
- * @example
86
- * Grant geolocation permission:
87
- * ```ts
88
- * const context = browser.defaultBrowserContext();
89
- * await context.overridePermissions('https://html5demos.com', ['geolocation']);
90
- * ```
91
- *
92
- * @see https://pptr.dev/api/puppeteer.browsercontext.overridepermissions
93
- */
94
- overridePermissions(origin: string, permissions: PuppeteerPermission[]): Promise<void>;
95
- /**
96
- * Clears all permission overrides for this browser context.
97
- *
98
- * @example
99
- * Clear permission overrides:
100
- * ```ts
101
- * const context = browser.defaultBrowserContext();
102
- * context.overridePermissions('https://example.com', ['clipboard-read']);
103
- * // do stuff ..
104
- * context.clearPermissionOverrides();
105
- * ```
106
- *
107
- * @see https://pptr.dev/api/puppeteer.browsercontext.clearpermissionoverrides
108
- */
109
- clearPermissionOverrides(): Promise<void>;
110
- /**
111
- * Gets all active targets inside this browser context.
112
- *
113
- * @see https://pptr.dev/api/puppeteer.browsercontext.targets
114
- */
115
- targets(): Promise<PuppeteerTarget[]>;
116
- }
@@ -1,168 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
5
- * Run `pnpm generate:puppeteer` to regenerate.
6
- */
7
- import { PuppeteerEventEmitter } from '../event-emitter.js';
8
- /**
9
- * RemotePuppeteerBrowserContext - Remote Puppeteer BrowserContext API over RPC.
10
- *
11
- * @see https://pptr.dev/api/puppeteer.browsercontext
12
- */
13
- export class RemotePuppeteerBrowserContext extends PuppeteerEventEmitter {
14
- createPage;
15
- sendRpc;
16
- constructor(sendRpc, options, createPage) {
17
- super();
18
- this.sendRpc = sendRpc;
19
- this.createPage = createPage;
20
- this._contextId = options?.contextId ?? "default";
21
- this._isDefault = options?.isDefault ?? false;
22
- }
23
- _contextId;
24
- _isDefault;
25
- _isClosed = false;
26
- _pages = new Map();
27
- /** Get the context ID. */
28
- get id() {
29
- return this._contextId;
30
- }
31
- /** Whether this is the default context. */
32
- get isDefault() {
33
- return this._isDefault;
34
- }
35
- /** Whether this context has been closed. */
36
- get closed() {
37
- return this._isClosed;
38
- }
39
- /**
40
- * Mark this context as closed (internal use).
41
- */
42
- markClosed() {
43
- this._isClosed = true;
44
- // Mark all pages as closed
45
- for (const page of this._pages.values()) {
46
- if ('markClosed' in page && typeof page.markClosed === 'function') {
47
- page.markClosed();
48
- }
49
- }
50
- }
51
- rpc(method, args) {
52
- if (this._isClosed) {
53
- throw new Error('Context is closed');
54
- }
55
- return this.sendRpc(method, args);
56
- }
57
- /**
58
- * Gets a list of all open pages inside this browser context.
59
- * @see https://pptr.dev/api/puppeteer.browsercontext.pages
60
- */
61
- async pages(includeAll) {
62
- const pageIds = await this.rpc('pages', [includeAll]);
63
- return pageIds.map((id) => {
64
- let page = this._pages.get(id);
65
- if (!page) {
66
- page = this.createPage(id);
67
- this._pages.set(id, page);
68
- }
69
- return page;
70
- });
71
- }
72
- /**
73
- * Creates a new page in this browser context.
74
- * @see https://pptr.dev/api/puppeteer.browsercontext.newpage
75
- */
76
- async newPage(options) {
77
- const pageId = await this.rpc('newPage', [options]);
78
- const page = this.createPage(pageId);
79
- this._pages.set(pageId, page);
80
- return page;
81
- }
82
- /**
83
- * Close this browser context.
84
- * @see https://pptr.dev/api/puppeteer.browsercontext.close
85
- */
86
- async close() {
87
- if (this._isDefault) {
88
- throw new Error('Cannot close the default context');
89
- }
90
- await this.rpc('close', []);
91
- this.markClosed();
92
- }
93
- /**
94
- * Gets all cookies in this browser context.
95
- *
96
- * @see https://pptr.dev/api/puppeteer.browsercontext.cookies
97
- */
98
- async cookies(...urls) {
99
- return this.sendRpc('cookies', [...urls]);
100
- }
101
- /**
102
- * Sets cookies in this browser context.
103
- *
104
- * @see https://pptr.dev/api/puppeteer.browsercontext.setcookie
105
- */
106
- async setCookie(...cookies) {
107
- await this.sendRpc('setCookie', [...cookies]);
108
- }
109
- /**
110
- * Deletes cookies from this browser context.
111
- *
112
- * @see https://pptr.dev/api/puppeteer.browsercontext.deletecookie
113
- */
114
- async deleteCookie(...cookies) {
115
- await this.sendRpc('deleteCookie', [...cookies]);
116
- }
117
- /**
118
- * Deletes cookies matching the filter criteria from this browser context.
119
- *
120
- * @see https://pptr.dev/api/puppeteer.browsercontext.deletematchingcookies
121
- */
122
- async deleteMatchingCookies(...filters) {
123
- await this.sendRpc('deleteMatchingCookies', [...filters]);
124
- }
125
- /**
126
- * Grants this browser context the given permissions within the given origin.
127
- *
128
- * @remarks
129
- * All permissions that are not listed will be automatically denied.
130
- *
131
- * @example
132
- * Grant geolocation permission:
133
- * ```ts
134
- * const context = browser.defaultBrowserContext();
135
- * await context.overridePermissions('https://html5demos.com', ['geolocation']);
136
- * ```
137
- *
138
- * @see https://pptr.dev/api/puppeteer.browsercontext.overridepermissions
139
- */
140
- async overridePermissions(origin, permissions) {
141
- await this.sendRpc('overridePermissions', [origin, permissions]);
142
- }
143
- /**
144
- * Clears all permission overrides for this browser context.
145
- *
146
- * @example
147
- * Clear permission overrides:
148
- * ```ts
149
- * const context = browser.defaultBrowserContext();
150
- * context.overridePermissions('https://example.com', ['clipboard-read']);
151
- * // do stuff ..
152
- * context.clearPermissionOverrides();
153
- * ```
154
- *
155
- * @see https://pptr.dev/api/puppeteer.browsercontext.clearpermissionoverrides
156
- */
157
- async clearPermissionOverrides() {
158
- await this.sendRpc('clearPermissionOverrides', []);
159
- }
160
- /**
161
- * Gets all active targets inside this browser context.
162
- *
163
- * @see https://pptr.dev/api/puppeteer.browsercontext.targets
164
- */
165
- async targets() {
166
- return this.sendRpc('targets', []);
167
- }
168
- }
@@ -1,169 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
5
- * Run `pnpm generate:puppeteer` to regenerate.
6
- */
7
- import type { SimpleRpcSender } from '../../../internal/transport.js';
8
- import { PuppeteerEventEmitter } from '../event-emitter.js';
9
- import type { RemotePuppeteerPage } from './page.js';
10
- import type { RemotePuppeteerBrowserContext } from './browser-context.js';
11
- import type { BrowserEvents, PuppeteerBrowserContextOptions, PuppeteerCookie, PuppeteerCookieData, PuppeteerDeleteCookiesRequest, PuppeteerTarget, PuppeteerTargetFilter, PuppeteerWaitForTargetOptions, PuppeteerWindowBounds } from '../types.js';
12
- /**
13
- * RemotePuppeteerBrowser - Remote Puppeteer Browser API over RPC.
14
- *
15
- * @see https://pptr.dev/api/puppeteer.browser
16
- */
17
- export declare class RemotePuppeteerBrowser extends PuppeteerEventEmitter<BrowserEvents> {
18
- private createPage;
19
- private createContext;
20
- protected sendRpc: SimpleRpcSender;
21
- constructor(sendRpc: SimpleRpcSender, createPage: (pageId: string) => RemotePuppeteerPage, createContext: (contextId: string, isDefault: boolean) => RemotePuppeteerBrowserContext);
22
- private _isConnected;
23
- private _pages;
24
- private _contexts;
25
- private _defaultContext;
26
- /** Whether the browser is connected. */
27
- get isConnected(): boolean;
28
- /**
29
- * Get all open pages.
30
- * @see https://pptr.dev/api/puppeteer.browser.pages
31
- */
32
- pages(includeAll?: boolean): Promise<RemotePuppeteerPage[]>;
33
- /**
34
- * Create a new page in the default browser context.
35
- * @see https://pptr.dev/api/puppeteer.browser.newpage
36
- */
37
- newPage(options?: {
38
- timeout?: number;
39
- }): Promise<RemotePuppeteerPage>;
40
- /**
41
- * Close the browser.
42
- * @see https://pptr.dev/api/puppeteer.browser.close
43
- */
44
- close(): Promise<void>;
45
- /**
46
- * Disconnect from the browser (without closing it).
47
- * @see https://pptr.dev/api/puppeteer.browser.disconnect
48
- */
49
- disconnect(): void;
50
- /**
51
- * Get the default browser context.
52
- * @see https://pptr.dev/api/puppeteer.browser.defaultbrowsercontext
53
- */
54
- defaultBrowserContext(): RemotePuppeteerBrowserContext;
55
- /**
56
- * Create a new browser context.
57
- * @see https://pptr.dev/api/puppeteer.browser.createbrowsercontext
58
- */
59
- createBrowserContext(options?: PuppeteerBrowserContextOptions): Promise<RemotePuppeteerBrowserContext>;
60
- /**
61
- * Get all browser contexts.
62
- * @see https://pptr.dev/api/puppeteer.browser.browsercontexts
63
- */
64
- browserContexts(): RemotePuppeteerBrowserContext[];
65
- /**
66
- * Wait for a target matching the filter.
67
- * @see https://pptr.dev/api/puppeteer.browser.waitfortarget
68
- */
69
- waitForTarget(filter: PuppeteerTargetFilter, options?: PuppeteerWaitForTargetOptions): Promise<PuppeteerTarget>;
70
- /**
71
- * Get the browser version.
72
- *
73
- * @see https://pptr.dev/api/puppeteer.browser.version
74
- */
75
- version(): Promise<string>;
76
- /**
77
- * Get the browser's user agent.
78
- *
79
- * @see https://pptr.dev/api/puppeteer.browser.useragent
80
- */
81
- userAgent(): Promise<string>;
82
- /**
83
- * Get the WebSocket endpoint for the browser.
84
- *
85
- * @see https://pptr.dev/api/puppeteer.browser.wsendpoint
86
- */
87
- wsEndpoint(): Promise<string>;
88
- /**
89
- * Get browser process info (if available).
90
- *
91
- * @remarks
92
- * Returns serialized process info in RPC mode.
93
- */
94
- process(): Promise<{
95
- pid: number;
96
- } | null>;
97
- /**
98
- * Gets the browser target.
99
- *
100
- * @see https://pptr.dev/api/puppeteer.browser.target
101
- */
102
- target(): Promise<PuppeteerTarget>;
103
- /**
104
- * Gets all active targets inside the browser.
105
- *
106
- * @remarks
107
- * Returns serialized target data in RPC mode.
108
- *
109
- * @see https://pptr.dev/api/puppeteer.browser.targets
110
- */
111
- targets(): Promise<PuppeteerTarget[]>;
112
- /**
113
- * Gets cookies from the default browser context.
114
- *
115
- * @see https://pptr.dev/api/puppeteer.browser.cookies
116
- */
117
- cookies(...urls: string[]): Promise<PuppeteerCookie[]>;
118
- /**
119
- * Sets cookies in the default browser context.
120
- *
121
- * @see https://pptr.dev/api/puppeteer.browser.setcookie
122
- */
123
- setCookie(...cookies: PuppeteerCookieData[]): Promise<void>;
124
- /**
125
- * Deletes cookies from the default browser context.
126
- *
127
- * @see https://pptr.dev/api/puppeteer.browser.deletecookie
128
- */
129
- deleteCookie(...cookies: PuppeteerCookie[]): Promise<void>;
130
- /**
131
- * Deletes cookies matching the filter criteria from the default browser context.
132
- *
133
- * @see https://pptr.dev/api/puppeteer.browser.deletematchingcookies
134
- */
135
- deleteMatchingCookies(...filters: PuppeteerDeleteCookiesRequest[]): Promise<void>;
136
- /**
137
- * Gets the bounds of a browser window.
138
- *
139
- * @see https://pptr.dev/api/puppeteer.browser.getwindowbounds
140
- */
141
- getWindowBounds(windowId: number): Promise<PuppeteerWindowBounds>;
142
- /**
143
- * Sets the bounds of a browser window.
144
- *
145
- * @see https://pptr.dev/api/puppeteer.browser.setwindowbounds
146
- */
147
- setWindowBounds(windowId: number, bounds: PuppeteerWindowBounds): Promise<void>;
148
- /**
149
- * Installs a browser extension.
150
- * @returns The extension ID.
151
- *
152
- * @remarks
153
- * In Chrome, this requires the browser to be launched with `pipe: true`
154
- * and the `--enable-unsafe-extension-debugging` flag.
155
- *
156
- * @see https://pptr.dev/api/puppeteer.browser.installextension
157
- */
158
- installExtension(path: string): Promise<string>;
159
- /**
160
- * Uninstalls a browser extension.
161
- *
162
- * @remarks
163
- * In Chrome, this requires the browser to be launched with `pipe: true`
164
- * and the `--enable-unsafe-extension-debugging` flag.
165
- *
166
- * @see https://pptr.dev/api/puppeteer.browser.uninstallextension
167
- */
168
- uninstallExtension(id: string): Promise<void>;
169
- }