@bctrl/sdk 1.0.1 → 1.0.2

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 (279) hide show
  1. package/README.md +24 -29
  2. package/dist/bctrl.d.ts +22 -36
  3. package/dist/bctrl.js +40 -75
  4. package/dist/browsers.d.ts +24 -0
  5. package/dist/browsers.js +82 -0
  6. package/dist/errors.d.ts +49 -43
  7. package/dist/errors.js +83 -120
  8. package/dist/files.d.ts +31 -0
  9. package/dist/files.js +97 -0
  10. package/dist/http.d.ts +18 -0
  11. package/dist/http.js +135 -0
  12. package/dist/index.d.ts +9 -12
  13. package/dist/index.js +8 -23
  14. package/dist/invocations.d.ts +24 -0
  15. package/dist/invocations.js +66 -0
  16. package/dist/pagination.d.ts +2 -0
  17. package/dist/pagination.js +13 -0
  18. package/dist/runs.d.ts +38 -0
  19. package/dist/runs.js +99 -0
  20. package/dist/runtimes.d.ts +73 -0
  21. package/dist/runtimes.js +205 -0
  22. package/dist/spaces.d.ts +41 -0
  23. package/dist/spaces.js +96 -0
  24. package/dist/types.d.ts +386 -0
  25. package/dist/types.js +1 -0
  26. package/dist/utils.d.ts +4 -0
  27. package/dist/utils.js +27 -0
  28. package/dist/version.js +2 -2
  29. package/package.json +12 -31
  30. package/dist/agents/browser-use/index.d.ts +0 -1
  31. package/dist/agents/browser-use/index.js +0 -9
  32. package/dist/agents/browser-use/namespace.d.ts +0 -39
  33. package/dist/agents/browser-use/namespace.js +0 -93
  34. package/dist/agents/index.d.ts +0 -2
  35. package/dist/agents/index.js +0 -17
  36. package/dist/agents/stagehand/core.d.ts +0 -93
  37. package/dist/agents/stagehand/core.js +0 -144
  38. package/dist/agents/stagehand/index.d.ts +0 -3
  39. package/dist/agents/stagehand/index.js +0 -24
  40. package/dist/agents/stagehand/namespace.d.ts +0 -51
  41. package/dist/agents/stagehand/namespace.js +0 -65
  42. package/dist/ai-credentials/client.d.ts +0 -12
  43. package/dist/ai-credentials/client.js +0 -70
  44. package/dist/ai-credentials/index.d.ts +0 -1
  45. package/dist/ai-credentials/index.js +0 -1
  46. package/dist/base/event-binding.d.ts +0 -7
  47. package/dist/base/event-binding.js +0 -23
  48. package/dist/base/types.d.ts +0 -109
  49. package/dist/base/types.js +0 -4
  50. package/dist/browser-extensions/client.d.ts +0 -15
  51. package/dist/browser-extensions/client.js +0 -72
  52. package/dist/browser-extensions/index.d.ts +0 -2
  53. package/dist/browser-extensions/index.js +0 -1
  54. package/dist/browser-profiles/client.d.ts +0 -11
  55. package/dist/browser-profiles/client.js +0 -63
  56. package/dist/browser-profiles/index.d.ts +0 -1
  57. package/dist/browser-profiles/index.js +0 -1
  58. package/dist/captcha/index.d.ts +0 -1
  59. package/dist/captcha/index.js +0 -1
  60. package/dist/captcha/namespace.d.ts +0 -34
  61. package/dist/captcha/namespace.js +0 -41
  62. package/dist/client/index.d.ts +0 -1
  63. package/dist/client/index.js +0 -1
  64. package/dist/client/rpc.d.ts +0 -83
  65. package/dist/client/rpc.js +0 -354
  66. package/dist/config.d.ts +0 -5
  67. package/dist/config.js +0 -28
  68. package/dist/constants/browser.d.ts +0 -2
  69. package/dist/constants/browser.js +0 -1
  70. package/dist/contracts/agent-tools.d.ts +0 -45
  71. package/dist/contracts/agent-tools.js +0 -31
  72. package/dist/contracts/automation.d.ts +0 -265
  73. package/dist/contracts/automation.js +0 -109
  74. package/dist/contracts/browser-management.d.ts +0 -179
  75. package/dist/contracts/browser-management.js +0 -95
  76. package/dist/contracts/browser-use.d.ts +0 -136
  77. package/dist/contracts/browser-use.js +0 -93
  78. package/dist/contracts/captcha.d.ts +0 -114
  79. package/dist/contracts/captcha.js +0 -40
  80. package/dist/contracts/desktop.d.ts +0 -223
  81. package/dist/contracts/desktop.js +0 -121
  82. package/dist/contracts/drivers/playwright.d.ts +0 -2008
  83. package/dist/contracts/drivers/playwright.js +0 -2033
  84. package/dist/contracts/drivers/puppeteer.d.ts +0 -1221
  85. package/dist/contracts/drivers/puppeteer.js +0 -941
  86. package/dist/contracts/drivers/selenium.d.ts +0 -156
  87. package/dist/contracts/drivers/selenium.js +0 -61
  88. package/dist/contracts/drivers/stagehand.d.ts +0 -155
  89. package/dist/contracts/drivers/stagehand.js +0 -7
  90. package/dist/contracts/extensions.d.ts +0 -13
  91. package/dist/contracts/extensions.js +0 -9
  92. package/dist/contracts/index.d.ts +0 -13
  93. package/dist/contracts/index.js +0 -13
  94. package/dist/contracts/public-api.d.ts +0 -360
  95. package/dist/contracts/public-api.js +0 -17
  96. package/dist/contracts/runtime.d.ts +0 -81
  97. package/dist/contracts/runtime.js +0 -16
  98. package/dist/contracts/stagehand.d.ts +0 -253
  99. package/dist/contracts/stagehand.js +0 -145
  100. package/dist/contracts/storage.d.ts +0 -51
  101. package/dist/contracts/storage.js +0 -56
  102. package/dist/contracts/vault.d.ts +0 -119
  103. package/dist/contracts/vault.js +0 -112
  104. package/dist/contracts/version.d.ts +0 -3
  105. package/dist/contracts/version.js +0 -16
  106. package/dist/desktop.d.ts +0 -2
  107. package/dist/desktop.js +0 -3
  108. package/dist/drivers/desktop/index.d.ts +0 -65
  109. package/dist/drivers/desktop/index.js +0 -68
  110. package/dist/drivers/desktop/session.d.ts +0 -313
  111. package/dist/drivers/desktop/session.js +0 -432
  112. package/dist/drivers/playwright/event-emitter.d.ts +0 -160
  113. package/dist/drivers/playwright/event-emitter.js +0 -297
  114. package/dist/drivers/playwright/generated/api-request-context.d.ts +0 -137
  115. package/dist/drivers/playwright/generated/api-request-context.js +0 -154
  116. package/dist/drivers/playwright/generated/api-response.d.ts +0 -119
  117. package/dist/drivers/playwright/generated/api-response.js +0 -123
  118. package/dist/drivers/playwright/generated/browser-context.d.ts +0 -284
  119. package/dist/drivers/playwright/generated/browser-context.js +0 -458
  120. package/dist/drivers/playwright/generated/browser.d.ts +0 -120
  121. package/dist/drivers/playwright/generated/browser.js +0 -151
  122. package/dist/drivers/playwright/generated/clock.d.ts +0 -80
  123. package/dist/drivers/playwright/generated/clock.js +0 -94
  124. package/dist/drivers/playwright/generated/console-message.d.ts +0 -94
  125. package/dist/drivers/playwright/generated/console-message.js +0 -89
  126. package/dist/drivers/playwright/generated/coverage.d.ts +0 -57
  127. package/dist/drivers/playwright/generated/coverage.js +0 -66
  128. package/dist/drivers/playwright/generated/dialog.d.ts +0 -79
  129. package/dist/drivers/playwright/generated/dialog.js +0 -80
  130. package/dist/drivers/playwright/generated/element-handle.d.ts +0 -399
  131. package/dist/drivers/playwright/generated/element-handle.js +0 -501
  132. package/dist/drivers/playwright/generated/frame-locator.d.ts +0 -34
  133. package/dist/drivers/playwright/generated/frame-locator.js +0 -63
  134. package/dist/drivers/playwright/generated/frame.d.ts +0 -557
  135. package/dist/drivers/playwright/generated/frame.js +0 -634
  136. package/dist/drivers/playwright/generated/js-handle.d.ts +0 -72
  137. package/dist/drivers/playwright/generated/js-handle.js +0 -92
  138. package/dist/drivers/playwright/generated/keyboard.d.ts +0 -103
  139. package/dist/drivers/playwright/generated/keyboard.js +0 -113
  140. package/dist/drivers/playwright/generated/locator.d.ts +0 -795
  141. package/dist/drivers/playwright/generated/locator.js +0 -974
  142. package/dist/drivers/playwright/generated/mouse.d.ts +0 -97
  143. package/dist/drivers/playwright/generated/mouse.js +0 -109
  144. package/dist/drivers/playwright/generated/page.d.ts +0 -762
  145. package/dist/drivers/playwright/generated/page.js +0 -988
  146. package/dist/drivers/playwright/generated/touchscreen.d.ts +0 -34
  147. package/dist/drivers/playwright/generated/touchscreen.js +0 -37
  148. package/dist/drivers/playwright/generated/tracing.d.ts +0 -78
  149. package/dist/drivers/playwright/generated/tracing.js +0 -80
  150. package/dist/drivers/playwright/generated/worker.d.ts +0 -53
  151. package/dist/drivers/playwright/generated/worker.js +0 -59
  152. package/dist/drivers/playwright/index.d.ts +0 -19
  153. package/dist/drivers/playwright/index.js +0 -20
  154. package/dist/drivers/playwright/remote-base.d.ts +0 -62
  155. package/dist/drivers/playwright/remote-base.js +0 -86
  156. package/dist/drivers/playwright/types.d.ts +0 -148
  157. package/dist/drivers/playwright/types.js +0 -8
  158. package/dist/drivers/puppeteer/errors.d.ts +0 -50
  159. package/dist/drivers/puppeteer/errors.js +0 -71
  160. package/dist/drivers/puppeteer/event-emitter.d.ts +0 -145
  161. package/dist/drivers/puppeteer/event-emitter.js +0 -259
  162. package/dist/drivers/puppeteer/generated/accessibility.d.ts +0 -77
  163. package/dist/drivers/puppeteer/generated/accessibility.js +0 -74
  164. package/dist/drivers/puppeteer/generated/browser-context.d.ts +0 -116
  165. package/dist/drivers/puppeteer/generated/browser-context.js +0 -168
  166. package/dist/drivers/puppeteer/generated/browser.d.ts +0 -169
  167. package/dist/drivers/puppeteer/generated/browser.js +0 -246
  168. package/dist/drivers/puppeteer/generated/console-message.d.ts +0 -54
  169. package/dist/drivers/puppeteer/generated/console-message.js +0 -69
  170. package/dist/drivers/puppeteer/generated/coverage.d.ts +0 -49
  171. package/dist/drivers/puppeteer/generated/coverage.js +0 -57
  172. package/dist/drivers/puppeteer/generated/dialog.d.ts +0 -46
  173. package/dist/drivers/puppeteer/generated/dialog.js +0 -60
  174. package/dist/drivers/puppeteer/generated/element-handle.d.ts +0 -261
  175. package/dist/drivers/puppeteer/generated/element-handle.js +0 -341
  176. package/dist/drivers/puppeteer/generated/file-chooser.d.ts +0 -34
  177. package/dist/drivers/puppeteer/generated/file-chooser.js +0 -43
  178. package/dist/drivers/puppeteer/generated/frame.d.ts +0 -221
  179. package/dist/drivers/puppeteer/generated/frame.js +0 -302
  180. package/dist/drivers/puppeteer/generated/http-request.d.ts +0 -195
  181. package/dist/drivers/puppeteer/generated/http-request.js +0 -243
  182. package/dist/drivers/puppeteer/generated/http-response.d.ts +0 -142
  183. package/dist/drivers/puppeteer/generated/http-response.js +0 -169
  184. package/dist/drivers/puppeteer/generated/js-handle.d.ts +0 -104
  185. package/dist/drivers/puppeteer/generated/js-handle.js +0 -125
  186. package/dist/drivers/puppeteer/generated/keyboard.d.ts +0 -79
  187. package/dist/drivers/puppeteer/generated/keyboard.js +0 -89
  188. package/dist/drivers/puppeteer/generated/locator.d.ts +0 -141
  189. package/dist/drivers/puppeteer/generated/locator.js +0 -164
  190. package/dist/drivers/puppeteer/generated/mouse.d.ts +0 -74
  191. package/dist/drivers/puppeteer/generated/mouse.js +0 -94
  192. package/dist/drivers/puppeteer/generated/page.d.ts +0 -604
  193. package/dist/drivers/puppeteer/generated/page.js +0 -776
  194. package/dist/drivers/puppeteer/generated/target.d.ts +0 -105
  195. package/dist/drivers/puppeteer/generated/target.js +0 -123
  196. package/dist/drivers/puppeteer/generated/touchscreen.d.ts +0 -87
  197. package/dist/drivers/puppeteer/generated/touchscreen.js +0 -103
  198. package/dist/drivers/puppeteer/generated/tracing.d.ts +0 -38
  199. package/dist/drivers/puppeteer/generated/tracing.js +0 -43
  200. package/dist/drivers/puppeteer/generated/web-worker.d.ts +0 -63
  201. package/dist/drivers/puppeteer/generated/web-worker.js +0 -73
  202. package/dist/drivers/puppeteer/index.d.ts +0 -21
  203. package/dist/drivers/puppeteer/index.js +0 -23
  204. package/dist/drivers/puppeteer/remote-base.d.ts +0 -57
  205. package/dist/drivers/puppeteer/remote-base.js +0 -79
  206. package/dist/drivers/puppeteer/types.d.ts +0 -178
  207. package/dist/drivers/puppeteer/types.js +0 -8
  208. package/dist/drivers/selenium/driver.d.ts +0 -28
  209. package/dist/drivers/selenium/driver.js +0 -169
  210. package/dist/drivers/selenium/element.d.ts +0 -34
  211. package/dist/drivers/selenium/element.js +0 -73
  212. package/dist/drivers/selenium/index.d.ts +0 -3
  213. package/dist/drivers/selenium/index.js +0 -5
  214. package/dist/drivers/selenium/types.d.ts +0 -2
  215. package/dist/drivers/selenium/types.js +0 -12
  216. package/dist/drivers/stagehand/generated/context.d.ts +0 -127
  217. package/dist/drivers/stagehand/generated/context.js +0 -153
  218. package/dist/drivers/stagehand/generated/locator.d.ts +0 -324
  219. package/dist/drivers/stagehand/generated/locator.js +0 -368
  220. package/dist/drivers/stagehand/generated/page.d.ts +0 -377
  221. package/dist/drivers/stagehand/generated/page.js +0 -439
  222. package/dist/drivers/stagehand/generated/response.d.ts +0 -197
  223. package/dist/drivers/stagehand/generated/response.js +0 -232
  224. package/dist/drivers/stagehand/index.d.ts +0 -5
  225. package/dist/drivers/stagehand/index.js +0 -8
  226. package/dist/drivers/stagehand/types.d.ts +0 -1
  227. package/dist/drivers/stagehand/types.js +0 -7
  228. package/dist/extensions/client.d.ts +0 -47
  229. package/dist/extensions/client.js +0 -154
  230. package/dist/extensions/index.d.ts +0 -1
  231. package/dist/extensions/index.js +0 -1
  232. package/dist/internal/dev-client.d.ts +0 -5
  233. package/dist/internal/dev-client.js +0 -9
  234. package/dist/internal/rpc-targets.d.ts +0 -17
  235. package/dist/internal/rpc-targets.js +0 -58
  236. package/dist/internal/serialization.d.ts +0 -32
  237. package/dist/internal/serialization.js +0 -42
  238. package/dist/internal/transport.d.ts +0 -24
  239. package/dist/internal/transport.js +0 -29
  240. package/dist/playwright.d.ts +0 -1
  241. package/dist/playwright.js +0 -2
  242. package/dist/puppeteer.d.ts +0 -1
  243. package/dist/puppeteer.js +0 -2
  244. package/dist/selenium.d.ts +0 -1
  245. package/dist/selenium.js +0 -2
  246. package/dist/stagehand.d.ts +0 -1
  247. package/dist/stagehand.js +0 -2
  248. package/dist/storage/client.d.ts +0 -151
  249. package/dist/storage/client.js +0 -329
  250. package/dist/storage/index.d.ts +0 -2
  251. package/dist/storage/index.js +0 -4
  252. package/dist/telemetry.d.ts +0 -18
  253. package/dist/telemetry.js +0 -93
  254. package/dist/updates/client.d.ts +0 -8
  255. package/dist/updates/client.js +0 -128
  256. package/dist/updates/index.d.ts +0 -1
  257. package/dist/updates/index.js +0 -1
  258. package/dist/utils/http.d.ts +0 -39
  259. package/dist/utils/http.js +0 -88
  260. package/dist/utils/index.d.ts +0 -4
  261. package/dist/utils/index.js +0 -4
  262. package/dist/utils/logger.d.ts +0 -27
  263. package/dist/utils/logger.js +0 -74
  264. package/dist/utils/schema.d.ts +0 -17
  265. package/dist/utils/schema.js +0 -31
  266. package/dist/utils/url.d.ts +0 -5
  267. package/dist/utils/url.js +0 -7
  268. package/dist/vault/client.d.ts +0 -43
  269. package/dist/vault/client.js +0 -123
  270. package/dist/vault/index.d.ts +0 -1
  271. package/dist/vault/index.js +0 -1
  272. package/dist/workspaces/browser-runtime.d.ts +0 -251
  273. package/dist/workspaces/browser-runtime.js +0 -1025
  274. package/dist/workspaces/client.d.ts +0 -48
  275. package/dist/workspaces/client.js +0 -222
  276. package/dist/workspaces/index.d.ts +0 -2
  277. package/dist/workspaces/index.js +0 -2
  278. package/dist/workspaces/runtime-event-pump.d.ts +0 -65
  279. package/dist/workspaces/runtime-event-pump.js +0 -716
@@ -1,141 +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 type { PuppeteerActionOptions, PuppeteerLocatorClickOptions, PuppeteerLocatorScrollOptions, PuppeteerVisibilityOption } from '../types.js';
9
- import { RemotePuppeteerElementHandle } from './element-handle.js';
10
- /** Factory function for creating element handles (uses SDK type) */
11
- export type ElementHandleFactoryLocal = (handleId: string) => RemotePuppeteerElementHandle;
12
- /** Factory function for creating locators */
13
- export type LocatorFactory = (selector: string) => RemotePuppeteerLocator;
14
- /** Predicate function for filter() */
15
- export type LocatorPredicate<T, S extends T = T> = (value: T) => value is S;
16
- /** Mapper function for map() */
17
- export type LocatorMapper<T, S> = (value: T) => S | Promise<S>;
18
- /**
19
- * Internal state for RemotePuppeteerLocator configuration.
20
- */
21
- interface RemotePuppeteerLocatorState {
22
- /** Timeout in milliseconds */
23
- timeout: number;
24
- /** Visibility filter */
25
- visibility: PuppeteerVisibilityOption;
26
- /** Whether to scroll element into viewport */
27
- ensureElementIsInTheViewport: boolean;
28
- /** Whether to wait for element to be enabled */
29
- waitForEnabled: boolean;
30
- /** Whether to wait for stable bounding box */
31
- waitForStableBoundingBox: boolean;
32
- /** Filter predicate function as string */
33
- filterPredicate: string | undefined;
34
- /** Map function as string */
35
- mapMapper: string | undefined;
36
- }
37
- /**
38
- * RemotePuppeteerLocator - Remote Puppeteer Locator API over RPC.
39
- *
40
- * @see https://pptr.dev/api/puppeteer.locator
41
- */
42
- export declare class RemotePuppeteerLocator<T = Element> {
43
- private _state;
44
- readonly selector: string;
45
- private sendRpc;
46
- private createElementHandle;
47
- private createLocator;
48
- constructor(selector: string, sendRpc: SimpleRpcSender, createElementHandle: ElementHandleFactoryLocal, createLocator: LocatorFactory, state?: Partial<RemotePuppeteerLocatorState>);
49
- /**
50
- * Clones the locator.
51
- * @returns A new locator with the same configuration.
52
- */
53
- clone(): RemotePuppeteerLocator<T>;
54
- /**
55
- * Creates a new locator with timeout set to the specified value.
56
- * Timeout in milliseconds
57
- */
58
- setTimeout(timeout: number): RemotePuppeteerLocator<T>;
59
- /**
60
- * Creates a new locator with visibility set to the specified value.
61
- * Visibility filter
62
- */
63
- setVisibility(visibility: PuppeteerVisibilityOption): RemotePuppeteerLocator<T>;
64
- /**
65
- * Creates a new locator with ensureElementIsInTheViewport set to the specified value.
66
- * Whether to scroll element into viewport
67
- */
68
- setEnsureElementIsInTheViewport(ensureElementIsInTheViewport: boolean): RemotePuppeteerLocator<T>;
69
- /**
70
- * Creates a new locator with waitForEnabled set to the specified value.
71
- * Whether to wait for element to be enabled
72
- */
73
- setWaitForEnabled(waitForEnabled: boolean): RemotePuppeteerLocator<T>;
74
- /**
75
- * Creates a new locator with waitForStableBoundingBox set to the specified value.
76
- * Whether to wait for stable bounding box
77
- */
78
- setWaitForStableBoundingBox(waitForStableBoundingBox: boolean): RemotePuppeteerLocator<T>;
79
- /**
80
- * Creates a race between multiple locators.
81
- *
82
- * @remarks
83
- * Races multiple locators to find the first matching element.
84
- * Only the first locator to match will receive the action.
85
- *
86
- * @example
87
- * await RemotePuppeteerLocator.race([
88
- * page.locator('button.submit'),
89
- * page.locator('input[type="submit"]'),
90
- * ]).click();
91
- *
92
- * @see https://pptr.dev/api/puppeteer.locator.race
93
- */
94
- static race<T extends readonly RemotePuppeteerLocator<unknown>[]>(locators: T): Promise<RemotePuppeteerLocator<T[number] extends RemotePuppeteerLocator<infer U> ? U : never>>;
95
- /**
96
- * Clicks the located element.
97
- *
98
- * @see https://pptr.dev/api/puppeteer.locator.click
99
- */
100
- click(options?: Readonly<PuppeteerLocatorClickOptions>): Promise<void>;
101
- /**
102
- * Fills out the input identified by the locator.
103
- *
104
- * @remarks
105
- * The type of the input is determined at runtime and the appropriate fill-out
106
- * method is chosen based on the type. contenteditable, select, textarea and
107
- * input elements are supported.
108
- *
109
- * @see https://pptr.dev/api/puppeteer.locator.fill
110
- */
111
- fill(value: string, options?: Readonly<PuppeteerActionOptions>): Promise<void>;
112
- /**
113
- * Hovers over the located element.
114
- *
115
- * @see https://pptr.dev/api/puppeteer.locator.hover
116
- */
117
- hover(options?: Readonly<PuppeteerActionOptions>): Promise<void>;
118
- /**
119
- * Scrolls the located element.
120
- *
121
- * @see https://pptr.dev/api/puppeteer.locator.scroll
122
- */
123
- scroll(options?: Readonly<PuppeteerLocatorScrollOptions>): Promise<void>;
124
- /**
125
- * Waits for the locator to get the serialized value from the page.
126
- *
127
- * @remarks
128
- * Note this requires the value to be JSON-serializable.
129
- * If a mapper was applied via map(), returns the mapped value.
130
- *
131
- * @see https://pptr.dev/api/puppeteer.locator.wait
132
- */
133
- wait(options?: Readonly<PuppeteerActionOptions>): Promise<T>;
134
- /**
135
- * Waits for the locator to get a handle from the page.
136
- *
137
- * @see https://pptr.dev/api/puppeteer.locator.waithandle
138
- */
139
- waitHandle(options?: Readonly<PuppeteerActionOptions>): Promise<RemotePuppeteerElementHandle>;
140
- }
141
- export {};
@@ -1,164 +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
- /**
8
- * RemotePuppeteerLocator - Remote Puppeteer Locator API over RPC.
9
- *
10
- * @see https://pptr.dev/api/puppeteer.locator
11
- */
12
- export class RemotePuppeteerLocator {
13
- _state = {
14
- timeout: 30000,
15
- visibility: 'visible',
16
- ensureElementIsInTheViewport: true,
17
- waitForEnabled: true,
18
- waitForStableBoundingBox: true,
19
- filterPredicate: undefined,
20
- mapMapper: undefined,
21
- };
22
- selector;
23
- sendRpc;
24
- createElementHandle;
25
- createLocator;
26
- constructor(selector, sendRpc, createElementHandle, createLocator, state) {
27
- this.selector = selector;
28
- this.sendRpc = sendRpc;
29
- this.createElementHandle = createElementHandle;
30
- this.createLocator = createLocator;
31
- if (state) {
32
- this._state = { ...this._state, ...state };
33
- }
34
- }
35
- /**
36
- * Clones the locator.
37
- * @returns A new locator with the same configuration.
38
- */
39
- clone() {
40
- return new RemotePuppeteerLocator(this.selector, this.sendRpc, this.createElementHandle, this.createLocator, { ...this._state });
41
- }
42
- /**
43
- * Creates a new locator with timeout set to the specified value.
44
- * Timeout in milliseconds
45
- */
46
- setTimeout(timeout) {
47
- const locator = this.clone();
48
- locator._state.timeout = timeout;
49
- return locator;
50
- }
51
- /**
52
- * Creates a new locator with visibility set to the specified value.
53
- * Visibility filter
54
- */
55
- setVisibility(visibility) {
56
- const locator = this.clone();
57
- locator._state.visibility = visibility;
58
- return locator;
59
- }
60
- /**
61
- * Creates a new locator with ensureElementIsInTheViewport set to the specified value.
62
- * Whether to scroll element into viewport
63
- */
64
- setEnsureElementIsInTheViewport(ensureElementIsInTheViewport) {
65
- const locator = this.clone();
66
- locator._state.ensureElementIsInTheViewport = ensureElementIsInTheViewport;
67
- return locator;
68
- }
69
- /**
70
- * Creates a new locator with waitForEnabled set to the specified value.
71
- * Whether to wait for element to be enabled
72
- */
73
- setWaitForEnabled(waitForEnabled) {
74
- const locator = this.clone();
75
- locator._state.waitForEnabled = waitForEnabled;
76
- return locator;
77
- }
78
- /**
79
- * Creates a new locator with waitForStableBoundingBox set to the specified value.
80
- * Whether to wait for stable bounding box
81
- */
82
- setWaitForStableBoundingBox(waitForStableBoundingBox) {
83
- const locator = this.clone();
84
- locator._state.waitForStableBoundingBox = waitForStableBoundingBox;
85
- return locator;
86
- }
87
- /**
88
- * Creates a race between multiple locators.
89
- *
90
- * @remarks
91
- * Races multiple locators to find the first matching element.
92
- * Only the first locator to match will receive the action.
93
- *
94
- * @example
95
- * await RemotePuppeteerLocator.race([
96
- * page.locator('button.submit'),
97
- * page.locator('input[type="submit"]'),
98
- * ]).click();
99
- *
100
- * @see https://pptr.dev/api/puppeteer.locator.race
101
- */
102
- static async race(locators) {
103
- // TODO: Implement static method
104
- throw new Error('Not implemented');
105
- }
106
- /**
107
- * Clicks the located element.
108
- *
109
- * @see https://pptr.dev/api/puppeteer.locator.click
110
- */
111
- async click(options) {
112
- await this.sendRpc('locator:click', [options]);
113
- }
114
- /**
115
- * Fills out the input identified by the locator.
116
- *
117
- * @remarks
118
- * The type of the input is determined at runtime and the appropriate fill-out
119
- * method is chosen based on the type. contenteditable, select, textarea and
120
- * input elements are supported.
121
- *
122
- * @see https://pptr.dev/api/puppeteer.locator.fill
123
- */
124
- async fill(value, options) {
125
- await this.sendRpc('locator:fill', [value, options]);
126
- }
127
- /**
128
- * Hovers over the located element.
129
- *
130
- * @see https://pptr.dev/api/puppeteer.locator.hover
131
- */
132
- async hover(options) {
133
- await this.sendRpc('locator:hover', [options]);
134
- }
135
- /**
136
- * Scrolls the located element.
137
- *
138
- * @see https://pptr.dev/api/puppeteer.locator.scroll
139
- */
140
- async scroll(options) {
141
- await this.sendRpc('locator:scroll', [options]);
142
- }
143
- /**
144
- * Waits for the locator to get the serialized value from the page.
145
- *
146
- * @remarks
147
- * Note this requires the value to be JSON-serializable.
148
- * If a mapper was applied via map(), returns the mapped value.
149
- *
150
- * @see https://pptr.dev/api/puppeteer.locator.wait
151
- */
152
- async wait(options) {
153
- return this.sendRpc('locator:wait', [options]);
154
- }
155
- /**
156
- * Waits for the locator to get a handle from the page.
157
- *
158
- * @see https://pptr.dev/api/puppeteer.locator.waithandle
159
- */
160
- async waitHandle(options) {
161
- const result = await this.sendRpc('locator:waitHandle', [options]);
162
- return this.createElementHandle(result.id);
163
- }
164
- }
@@ -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 type { SimpleRpcSender } from '../../../internal/transport.js';
8
- import { RemoteComponentBase } from '../remote-base.js';
9
- import type { PuppeteerDragData, PuppeteerMouseClickOptions, PuppeteerMouseMoveOptions, PuppeteerMouseOptions, PuppeteerMouseWheelOptions, PuppeteerPoint } from '../types.js';
10
- /**
11
- * RemotePuppeteerMouse - Remote Puppeteer Mouse API over RPC.
12
- *
13
- * @see https://pptr.dev/api/puppeteer.mouse
14
- */
15
- export declare class RemotePuppeteerMouse extends RemoteComponentBase {
16
- constructor(sendRpc: SimpleRpcSender);
17
- /**
18
- * Click at specific coordinates.
19
- * @see https://pptr.dev/api/puppeteer.mouse.click
20
- */
21
- click(x: number, y: number, options?: PuppeteerMouseClickOptions): Promise<void>;
22
- /**
23
- * Move mouse to specific coordinates.
24
- * @see https://pptr.dev/api/puppeteer.mouse.move
25
- */
26
- move(x: number, y: number, options?: PuppeteerMouseMoveOptions): Promise<void>;
27
- /**
28
- * Press mouse button down.
29
- * @see https://pptr.dev/api/puppeteer.mouse.down
30
- */
31
- down(options?: PuppeteerMouseOptions): Promise<void>;
32
- /**
33
- * Release mouse button.
34
- * @see https://pptr.dev/api/puppeteer.mouse.up
35
- */
36
- up(options?: PuppeteerMouseOptions): Promise<void>;
37
- /**
38
- * Scroll mouse wheel.
39
- * @see https://pptr.dev/api/puppeteer.mouse.wheel
40
- */
41
- wheel(options?: PuppeteerMouseWheelOptions): Promise<void>;
42
- /**
43
- * Dispatches a drag event.
44
- * @see https://pptr.dev/api/puppeteer.mouse.drag
45
- */
46
- drag(start: PuppeteerPoint, target: PuppeteerPoint): Promise<PuppeteerDragData>;
47
- /**
48
- * Perform a drag and drop operation.
49
- * @see https://pptr.dev/api/puppeteer.mouse.draganddrop
50
- */
51
- dragAndDrop(start: PuppeteerPoint, target: PuppeteerPoint, options?: {
52
- delay?: number;
53
- }): Promise<void>;
54
- /**
55
- * Dispatches a dragenter event.
56
- * @see https://pptr.dev/api/puppeteer.mouse.dragenter
57
- */
58
- dragEnter(target: PuppeteerPoint, data: PuppeteerDragData): Promise<void>;
59
- /**
60
- * Dispatches a dragover event.
61
- * @see https://pptr.dev/api/puppeteer.mouse.dragover
62
- */
63
- dragOver(target: PuppeteerPoint, data: PuppeteerDragData): Promise<void>;
64
- /**
65
- * Performs a dragenter, dragover, and drop in sequence.
66
- * @see https://pptr.dev/api/puppeteer.mouse.drop
67
- */
68
- drop(target: PuppeteerPoint, data: PuppeteerDragData): Promise<void>;
69
- /**
70
- * Resets the mouse to the default state.
71
- * @see https://pptr.dev/api/puppeteer.mouse.reset
72
- */
73
- reset(): Promise<void>;
74
- }
@@ -1,94 +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 { RemoteComponentBase } from '../remote-base.js';
8
- /**
9
- * RemotePuppeteerMouse - Remote Puppeteer Mouse API over RPC.
10
- *
11
- * @see https://pptr.dev/api/puppeteer.mouse
12
- */
13
- export class RemotePuppeteerMouse extends RemoteComponentBase {
14
- constructor(sendRpc) {
15
- super(sendRpc);
16
- }
17
- /**
18
- * Click at specific coordinates.
19
- * @see https://pptr.dev/api/puppeteer.mouse.click
20
- */
21
- async click(x, y, options) {
22
- await this.rpc('mouse.click', [x, y, options]);
23
- }
24
- /**
25
- * Move mouse to specific coordinates.
26
- * @see https://pptr.dev/api/puppeteer.mouse.move
27
- */
28
- async move(x, y, options) {
29
- await this.rpc('mouse.move', [x, y, options]);
30
- }
31
- /**
32
- * Press mouse button down.
33
- * @see https://pptr.dev/api/puppeteer.mouse.down
34
- */
35
- async down(options) {
36
- await this.rpc('mouse.down', [options]);
37
- }
38
- /**
39
- * Release mouse button.
40
- * @see https://pptr.dev/api/puppeteer.mouse.up
41
- */
42
- async up(options) {
43
- await this.rpc('mouse.up', [options]);
44
- }
45
- /**
46
- * Scroll mouse wheel.
47
- * @see https://pptr.dev/api/puppeteer.mouse.wheel
48
- */
49
- async wheel(options) {
50
- await this.rpc('mouse.wheel', [options]);
51
- }
52
- /**
53
- * Dispatches a drag event.
54
- * @see https://pptr.dev/api/puppeteer.mouse.drag
55
- */
56
- async drag(start, target) {
57
- return this.rpc('mouse.drag', [start, target]);
58
- }
59
- /**
60
- * Perform a drag and drop operation.
61
- * @see https://pptr.dev/api/puppeteer.mouse.draganddrop
62
- */
63
- async dragAndDrop(start, target, options) {
64
- await this.rpc('mouse.dragAndDrop', [start, target, options]);
65
- }
66
- /**
67
- * Dispatches a dragenter event.
68
- * @see https://pptr.dev/api/puppeteer.mouse.dragenter
69
- */
70
- async dragEnter(target, data) {
71
- await this.rpc('mouse.dragEnter', [target, data]);
72
- }
73
- /**
74
- * Dispatches a dragover event.
75
- * @see https://pptr.dev/api/puppeteer.mouse.dragover
76
- */
77
- async dragOver(target, data) {
78
- await this.rpc('mouse.dragOver', [target, data]);
79
- }
80
- /**
81
- * Performs a dragenter, dragover, and drop in sequence.
82
- * @see https://pptr.dev/api/puppeteer.mouse.drop
83
- */
84
- async drop(target, data) {
85
- await this.rpc('mouse.drop', [target, data]);
86
- }
87
- /**
88
- * Resets the mouse to the default state.
89
- * @see https://pptr.dev/api/puppeteer.mouse.reset
90
- */
91
- async reset() {
92
- await this.rpc('mouse.reset', []);
93
- }
94
- }