@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,79 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/playwright/methods/
5
- * Run `pnpm generate:playwright` to regenerate.
6
- */
7
- import type { SimpleRpcSender } from '../../../internal/transport.js';
8
- import type { PlaywrightDialogType } from '../types.js';
9
- import type { RemotePlaywrightPage } from './page.js';
10
- /**
11
- * Serialized Dialog data received over RPC.
12
- */
13
- export interface SerializedDialog {
14
- /** Dialog ID for RPC calls */
15
- id: string;
16
- /** Dialog type */
17
- type: PlaywrightDialogType;
18
- /** Message displayed in the dialog */
19
- message: string;
20
- /** Default value for prompt dialogs */
21
- defaultValue: string;
22
- /** Page ID or null */
23
- pageId: string | null;
24
- }
25
- /**
26
- * RemotePlaywrightDialog - Remote Playwright Dialog API over RPC.
27
- *
28
- * @see https://playwright.dev/docs/api/class-dialog
29
- */
30
- export declare class RemotePlaywrightDialog {
31
- private sendRpc;
32
- private readonly _id;
33
- private readonly _type;
34
- private readonly _message;
35
- private readonly _defaultValue;
36
- constructor(sendRpc: SimpleRpcSender, data: SerializedDialog, createPage: (id: string) => RemotePlaywrightPage);
37
- private readonly _page;
38
- /**
39
- * Accepts the dialog.
40
- * @param promptText - Text to enter in a prompt dialog.
41
- * @see https://playwright.dev/docs/api/class-dialog#dialog-accept
42
- */
43
- accept(promptText?: string): Promise<void>;
44
- /**
45
- * Dismisses the dialog.
46
- * @see https://playwright.dev/docs/api/class-dialog#dialog-dismiss
47
- */
48
- dismiss(): Promise<void>;
49
- /**
50
- * Returns the default prompt value if the dialog is a prompt.
51
- *
52
- * @remarks
53
- * Returns empty string for other dialog types.
54
- *
55
- * @see https://playwright.dev/docs/api/class-dialog#dialog-default-value
56
- */
57
- defaultValue(): string;
58
- /**
59
- * Returns the message displayed in the dialog.
60
- *
61
- * @see https://playwright.dev/docs/api/class-dialog#dialog-message
62
- */
63
- message(): string;
64
- /**
65
- * Returns the page that initiated the dialog, or null if not available.
66
- *
67
- * @see https://playwright.dev/docs/api/class-dialog#dialog-page
68
- */
69
- page(): RemotePlaywrightPage | null;
70
- /**
71
- * Returns the type of the dialog.
72
- *
73
- * @remarks
74
- * One of 'alert', 'beforeunload', 'confirm', or 'prompt'.
75
- *
76
- * @see https://playwright.dev/docs/api/class-dialog#dialog-type
77
- */
78
- type(): PlaywrightDialogType;
79
- }
@@ -1,80 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/playwright/methods/
5
- * Run `pnpm generate:playwright` to regenerate.
6
- */
7
- /**
8
- * RemotePlaywrightDialog - Remote Playwright Dialog API over RPC.
9
- *
10
- * @see https://playwright.dev/docs/api/class-dialog
11
- */
12
- export class RemotePlaywrightDialog {
13
- sendRpc;
14
- _id;
15
- _type;
16
- _message;
17
- _defaultValue;
18
- constructor(sendRpc, data, createPage) {
19
- this.sendRpc = sendRpc;
20
- this._id = data.id;
21
- this._type = data.type;
22
- this._message = data.message;
23
- this._defaultValue = data.defaultValue;
24
- this._page = data.pageId ? createPage(data.pageId) : null;
25
- }
26
- _page;
27
- /**
28
- * Accepts the dialog.
29
- * @param promptText - Text to enter in a prompt dialog.
30
- * @see https://playwright.dev/docs/api/class-dialog#dialog-accept
31
- */
32
- async accept(promptText) {
33
- await this.sendRpc('accept', [this._id, promptText]);
34
- }
35
- /**
36
- * Dismisses the dialog.
37
- * @see https://playwright.dev/docs/api/class-dialog#dialog-dismiss
38
- */
39
- async dismiss() {
40
- await this.sendRpc('dismiss', [this._id]);
41
- }
42
- /**
43
- * Returns the default prompt value if the dialog is a prompt.
44
- *
45
- * @remarks
46
- * Returns empty string for other dialog types.
47
- *
48
- * @see https://playwright.dev/docs/api/class-dialog#dialog-default-value
49
- */
50
- defaultValue() {
51
- return this._defaultValue;
52
- }
53
- /**
54
- * Returns the message displayed in the dialog.
55
- *
56
- * @see https://playwright.dev/docs/api/class-dialog#dialog-message
57
- */
58
- message() {
59
- return this._message;
60
- }
61
- /**
62
- * Returns the page that initiated the dialog, or null if not available.
63
- *
64
- * @see https://playwright.dev/docs/api/class-dialog#dialog-page
65
- */
66
- page() {
67
- return this._page;
68
- }
69
- /**
70
- * Returns the type of the dialog.
71
- *
72
- * @remarks
73
- * One of 'alert', 'beforeunload', 'confirm', or 'prompt'.
74
- *
75
- * @see https://playwright.dev/docs/api/class-dialog#dialog-type
76
- */
77
- type() {
78
- return this._type;
79
- }
80
- }
@@ -1,399 +0,0 @@
1
- /**
2
- * AUTO-GENERATED FILE - DO NOT EDIT
3
- *
4
- * Generated from: packages/automation-spec/src/drivers/playwright/methods/
5
- * Run `pnpm generate:playwright` to regenerate.
6
- */
7
- import type { SimpleRpcSender } from '../../../internal/transport.js';
8
- import { RemoteBase } from '../remote-base.js';
9
- import type { PlaywrightBoundingBox, PlaywrightCheckOptions, PlaywrightClickOptions, PlaywrightElementState, PlaywrightEventInit, PlaywrightFilePayload, PlaywrightFillOptions, PlaywrightHoverOptions, PlaywrightPressOptions, PlaywrightSelectOption, PlaywrightSelectOptionOptions, PlaywrightSetInputFilesOptions, PlaywrightTapOptions, PlaywrightTimeoutOptions, PlaywrightTypeOptions, PlaywrightWaitForSelectorOptions } from '../types.js';
10
- import type { RemotePlaywrightFrame } from './frame.js';
11
- import type { RemotePlaywrightJSHandle } from './js-handle.js';
12
- /**
13
- * RemotePlaywrightElementHandle - Remote Playwright ElementHandle API over RPC.
14
- *
15
- * @see https://playwright.dev/docs/api/class-elementhandle
16
- */
17
- export declare class RemotePlaywrightElementHandle extends RemoteBase {
18
- private createElementHandle;
19
- private createFrame;
20
- private createJSHandle;
21
- constructor(id: string, sendRpc: SimpleRpcSender, createElementHandle: (handleId: string) => RemotePlaywrightElementHandle, createFrame: (frameId: string) => RemotePlaywrightFrame, createJSHandle: (handleId: string) => RemotePlaywrightJSHandle);
22
- /**
23
- * Return this handle as an ElementHandle.
24
- * Since this is already an ElementHandle, returns itself.
25
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-as-element
26
- */
27
- asElement(): RemotePlaywrightElementHandle | null;
28
- /**
29
- * Click the element.
30
- *
31
- * @remarks
32
- * This method clicks the element by performing actionability checks, scrolling into view, and simulating a mouse click. Discouraged in favor of locator.click().
33
- *
34
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-click
35
- */
36
- click(options?: PlaywrightClickOptions): Promise<void>;
37
- /**
38
- * Double-click the element.
39
- *
40
- * @remarks
41
- * Discouraged in favor of locator.dblclick().
42
- *
43
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-dblclick
44
- */
45
- dblclick(options?: PlaywrightClickOptions): Promise<void>;
46
- /**
47
- * Fill an input, textarea, or contenteditable element with the specified value.
48
- *
49
- * @remarks
50
- * This method waits for actionability checks, focuses the element, fills it, and triggers an input event. Pass empty string to clear. Discouraged in favor of locator.fill().
51
- *
52
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-fill
53
- */
54
- fill(value: string, options?: PlaywrightFillOptions): Promise<void>;
55
- /**
56
- * Focus the element and type text into it character by character.
57
- *
58
- * @remarks
59
- * Deprecated: In most cases use locator.fill() instead. Only use this for special keyboard handling. For special keys use press().
60
- *
61
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-type
62
- */
63
- type(text: string, options?: PlaywrightTypeOptions): Promise<void>;
64
- /**
65
- * Focus the element and press a key or key combination.
66
- *
67
- * @remarks
68
- * Key can be a single character or a special key like "Enter", "Control+a", "Shift+ArrowDown". Discouraged in favor of locator.press().
69
- *
70
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-press
71
- */
72
- press(key: string, options?: PlaywrightPressOptions): Promise<void>;
73
- /**
74
- * Hover over the element.
75
- *
76
- * @remarks
77
- * This method hovers over the element by performing actionability checks, scrolling into view, and simulating mouse hover. Discouraged in favor of locator.hover().
78
- *
79
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-hover
80
- */
81
- hover(options?: PlaywrightHoverOptions): Promise<void>;
82
- /**
83
- * Focus the element.
84
- *
85
- * @remarks
86
- * Discouraged in favor of locator.focus().
87
- *
88
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-focus
89
- */
90
- focus(): Promise<void>;
91
- /**
92
- * Tap the element (for touch devices).
93
- *
94
- * @remarks
95
- * This method taps the element by performing actionability checks, scrolling into view, centering, and dispatching touchstart/touchend events. Discouraged in favor of locator.tap().
96
- *
97
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-tap
98
- */
99
- tap(options?: PlaywrightTapOptions): Promise<void>;
100
- /**
101
- * Check a checkbox or radio element.
102
- *
103
- * @remarks
104
- * If the element is already checked, this method returns immediately. Discouraged in favor of locator.check().
105
- *
106
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-check
107
- */
108
- check(options?: PlaywrightCheckOptions): Promise<void>;
109
- /**
110
- * Uncheck a checkbox element.
111
- *
112
- * @remarks
113
- * If the element is already unchecked, this method returns immediately. Discouraged in favor of locator.uncheck().
114
- *
115
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck
116
- */
117
- uncheck(options?: PlaywrightCheckOptions): Promise<void>;
118
- /**
119
- * Check or uncheck a checkbox or radio element.
120
- *
121
- * @remarks
122
- * Discouraged in favor of locator.setChecked().
123
- *
124
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-set-checked
125
- */
126
- setChecked(checked: boolean, options?: PlaywrightCheckOptions): Promise<void>;
127
- /**
128
- * Select one or more options in a <select> element.
129
- * @param values - Options to select. Can be value, label, or option object.
130
- * @returns An array of selected option values.
131
- *
132
- * @remarks
133
- * Discouraged in favor of locator.selectOption().
134
- *
135
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-select-option
136
- */
137
- selectOption(values: string | string[] | PlaywrightSelectOption | PlaywrightSelectOption[], options?: PlaywrightSelectOptionOptions): Promise<string[]>;
138
- /**
139
- * Set the files for a file input element.
140
- * @param files - File paths or file payloads to upload.
141
- *
142
- * @remarks
143
- * Sets the value of the file input to these file paths or files. If some paths are relative, they are resolved relative to the current working directory. Clears selected files if empty array is passed. Discouraged in favor of locator.setInputFiles().
144
- *
145
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-set-input-files
146
- */
147
- setInputFiles(files: string | string[] | PlaywrightFilePayload | PlaywrightFilePayload[], options?: PlaywrightSetInputFilesOptions): Promise<void>;
148
- /**
149
- * Scroll the element into view if not already visible.
150
- *
151
- * @remarks
152
- * If the element is detached from DOM, throws an error. Discouraged in favor of locator.scrollIntoViewIfNeeded().
153
- *
154
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-scroll-into-view-if-needed
155
- */
156
- scrollIntoViewIfNeeded(options?: PlaywrightTimeoutOptions): Promise<void>;
157
- /**
158
- * Dispatch a DOM event on the element.
159
- * @param type - DOM event type, e.g., "click".
160
- * @param eventInit - Event-specific initialization properties.
161
- *
162
- * @remarks
163
- * The event is composed, cancelable and bubbles by default. Regardless of visibility, this will dispatch the event. Discouraged in favor of locator.dispatchEvent().
164
- *
165
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-dispatch-event
166
- */
167
- dispatchEvent(type: string, eventInit?: PlaywrightEventInit): Promise<void>;
168
- /**
169
- * Get the innerHTML of the element.
170
- *
171
- * @remarks
172
- * Discouraged in favor of locator.innerHTML().
173
- *
174
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-inner-html
175
- */
176
- innerHTML(): Promise<string>;
177
- /**
178
- * Get the innerText of the element.
179
- *
180
- * @remarks
181
- * Discouraged in favor of locator.innerText().
182
- *
183
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-inner-text
184
- */
185
- innerText(): Promise<string>;
186
- /**
187
- * Get the textContent of the element.
188
- *
189
- * @remarks
190
- * Discouraged in favor of locator.textContent().
191
- *
192
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-text-content
193
- */
194
- textContent(): Promise<string | null>;
195
- /**
196
- * Get an attribute value of the element.
197
- * @param name - Attribute name to get.
198
- *
199
- * @remarks
200
- * Discouraged in favor of locator.getAttribute().
201
- *
202
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-get-attribute
203
- */
204
- getAttribute(name: string): Promise<string | null>;
205
- /**
206
- * Get the input value for input, textarea, or select elements.
207
- *
208
- * @remarks
209
- * Throws for non-input elements. Discouraged in favor of locator.inputValue().
210
- *
211
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-input-value
212
- */
213
- inputValue(options?: PlaywrightTimeoutOptions): Promise<string>;
214
- /**
215
- * Check if the element is visible.
216
- *
217
- * @remarks
218
- * Returns true if element is visible. Non-attached elements return false. Discouraged in favor of locator.isVisible().
219
- *
220
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-visible
221
- */
222
- isVisible(): Promise<boolean>;
223
- /**
224
- * Check if the element is hidden.
225
- *
226
- * @remarks
227
- * Returns true if element is hidden. Non-attached elements return true. Discouraged in favor of locator.isHidden().
228
- *
229
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-hidden
230
- */
231
- isHidden(): Promise<boolean>;
232
- /**
233
- * Check if the element is enabled.
234
- *
235
- * @remarks
236
- * Discouraged in favor of locator.isEnabled().
237
- *
238
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-enabled
239
- */
240
- isEnabled(): Promise<boolean>;
241
- /**
242
- * Check if the element is disabled.
243
- *
244
- * @remarks
245
- * Discouraged in favor of locator.isDisabled().
246
- *
247
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-disabled
248
- */
249
- isDisabled(): Promise<boolean>;
250
- /**
251
- * Check if a checkbox or radio is checked.
252
- *
253
- * @remarks
254
- * Throws if element is not a checkbox or radio. Discouraged in favor of locator.isChecked().
255
- *
256
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-checked
257
- */
258
- isChecked(): Promise<boolean>;
259
- /**
260
- * Check if the element is editable.
261
- *
262
- * @remarks
263
- * Discouraged in favor of locator.isEditable().
264
- *
265
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-editable
266
- */
267
- isEditable(): Promise<boolean>;
268
- /**
269
- * Get the bounding box of the element.
270
- * @returns Bounding box with x, y, width, height, or null if element is not visible.
271
- *
272
- * @remarks
273
- * Discouraged in favor of locator.boundingBox().
274
- *
275
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-bounding-box
276
- */
277
- boundingBox(): Promise<PlaywrightBoundingBox | null>;
278
- /**
279
- * Get the content frame for iframe elements.
280
- * @returns The frame content, or null if not an iframe.
281
- *
282
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-content-frame
283
- */
284
- contentFrame(): Promise<RemotePlaywrightFrame | null>;
285
- /**
286
- * Get the frame that owns this element.
287
- * @returns The owner frame, or null if element is detached.
288
- *
289
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-owner-frame
290
- */
291
- ownerFrame(): Promise<RemotePlaywrightFrame | null>;
292
- /**
293
- * Evaluate a function in the context of the element.
294
- * @param pageFunction - Function or string to evaluate in the page context.
295
- * @param arg - Argument to pass to the function.
296
- *
297
- * @remarks
298
- * The element is passed as the first argument to the function. If the function returns a Promise, it will be awaited.
299
- *
300
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-evaluate
301
- */
302
- evaluate<R = unknown, Arg = unknown>(pageFunction: string | ((element: Element, arg: Arg) => R | Promise<R>), arg?: unknown): Promise<R>;
303
- /**
304
- * Evaluate a function and return a JSHandle to the result.
305
- * @param pageFunction - Function or string to evaluate in the page context.
306
- * @param arg - Argument to pass to the function.
307
- *
308
- * @remarks
309
- * The element is passed as the first argument. Note: Returns serialized handle reference. Full JSHandle support not yet available.
310
- *
311
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-evaluate-handle
312
- */
313
- evaluateHandle<R = unknown, Arg = unknown>(pageFunction: string | ((element: Element, arg: Arg) => R | Promise<R>), arg?: unknown): Promise<unknown>;
314
- /**
315
- * Query for a child element matching the selector.
316
- * @returns The matching element or null if not found.
317
- *
318
- * @remarks
319
- * Discouraged in favor of locator-based locator.locator().
320
- *
321
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-query-selector
322
- */
323
- $(selector: string): Promise<RemotePlaywrightElementHandle | null>;
324
- /**
325
- * Query for all child elements matching the selector.
326
- * @returns An array of matching elements.
327
- *
328
- * @remarks
329
- * Discouraged in favor of locator-based locator.locator().
330
- *
331
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-query-selector-all
332
- */
333
- $$(selector: string): Promise<RemotePlaywrightElementHandle[]>;
334
- /**
335
- * Evaluate a function on a child element matching the selector.
336
- *
337
- * @remarks
338
- * Throws if no element matches. Discouraged in favor of locator.evaluate().
339
- *
340
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-eval-on-selector
341
- */
342
- $eval<R = unknown, Arg = unknown>(selector: string, pageFunction: string | ((element: Element, arg: Arg) => R | Promise<R>), arg?: unknown): Promise<R>;
343
- /**
344
- * Evaluate a function on all child elements matching the selector.
345
- *
346
- * @remarks
347
- * Discouraged in favor of locator.evaluateAll().
348
- *
349
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-eval-on-selector-all
350
- */
351
- $$eval<R = unknown, Arg = unknown>(selector: string, pageFunction: string | ((elements: Element[], arg: Arg) => R | Promise<R>), arg?: unknown): Promise<R>;
352
- /**
353
- * Wait for the element to reach a specific state.
354
- * @param state - State to wait for: "visible", "hidden", "stable", "enabled", or "disabled".
355
- *
356
- * @remarks
357
- * Discouraged in favor of web-first assertions.
358
- *
359
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-wait-for-element-state
360
- */
361
- waitForElementState(state: PlaywrightElementState, options?: PlaywrightTimeoutOptions): Promise<void>;
362
- /**
363
- * Wait for a child element matching the selector.
364
- * @returns The matching element, or null if waiting for hidden/detached.
365
- *
366
- * @remarks
367
- * Discouraged in favor of locator-based assertions.
368
- *
369
- * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-wait-for-selector
370
- */
371
- waitForSelector(selector: string, options?: PlaywrightWaitForSelectorOptions): Promise<RemotePlaywrightElementHandle | null>;
372
- /**
373
- * Dispose of the handle, releasing it from the browser.
374
- *
375
- * @remarks
376
- * After disposal, any method calls will throw. The SDK sets the disposed flag before the RPC call to prevent race conditions.
377
- *
378
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-dispose
379
- */
380
- dispose(): Promise<void>;
381
- /**
382
- * Get a JSHandle for a property of this element.
383
- *
384
- * @remarks
385
- * Note: Returns serialized handle reference. Full JSHandle support not yet available.
386
- *
387
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-property
388
- */
389
- getProperty(propertyName: string): Promise<unknown>;
390
- /**
391
- * Get the JSON value of the element.
392
- *
393
- * @remarks
394
- * Throws if the object cannot be serialized to JSON (e.g., DOM nodes).
395
- *
396
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-json-value
397
- */
398
- jsonValue<T = unknown>(): Promise<T>;
399
- }