@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,72 +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
- /**
10
- * RemotePlaywrightJSHandle - Remote Playwright JSHandle API over RPC.
11
- *
12
- * @see https://playwright.dev/docs/api/class-jshandle
13
- */
14
- export declare class RemotePlaywrightJSHandle extends RemoteBase {
15
- /** Factory to create JSHandle instances */
16
- private readonly _jsHandleFactory;
17
- constructor(id: string, sendRpc: SimpleRpcSender, jsHandleFactory: (id: string) => RemotePlaywrightJSHandle);
18
- protected get jsHandleFactory(): (id: string) => RemotePlaywrightJSHandle;
19
- /**
20
- * Evaluates the given function with this handle as the first argument.
21
- * @param pageFunction - Function to be evaluated in the page context.
22
- * @param arg - Optional argument to pass to the function.
23
- *
24
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate
25
- */
26
- evaluate<R = unknown>(pageFunction: Function | string, arg?: unknown): Promise<R>;
27
- /**
28
- * Evaluates the given function with this handle as the first argument and returns a JSHandle.
29
- * @param pageFunction - Function to be evaluated in the page context.
30
- * @param arg - Optional argument to pass to the function.
31
- *
32
- * @remarks
33
- * Note: Returns serialized handle reference. Full JSHandle support not yet available.
34
- *
35
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate-handle
36
- */
37
- evaluateHandle<R = unknown>(pageFunction: Function | string, arg?: unknown): Promise<unknown>;
38
- /**
39
- * Returns a map of property names to JSHandle instances for own properties of the object.
40
- *
41
- * @remarks
42
- * Note: Returns serialized handle references. Full JSHandle support not yet available.
43
- *
44
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-properties
45
- */
46
- getProperties(): Promise<Map<string, unknown>>;
47
- /**
48
- * Returns a JSHandle for the property with the given name.
49
- * @param propertyName - Property name to get.
50
- *
51
- * @remarks
52
- * Note: Returns serialized handle reference. Full JSHandle support not yet available.
53
- *
54
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-property
55
- */
56
- getProperty(propertyName: string): Promise<unknown>;
57
- /**
58
- * Returns a JSON representation of the object.
59
- *
60
- * @remarks
61
- * If the object has a toJSON function, it will not be called.
62
- *
63
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-json-value
64
- */
65
- jsonValue<T = unknown>(): Promise<T>;
66
- /**
67
- * Releases the handle. After calling dispose, the handle is no longer valid.
68
- *
69
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-dispose
70
- */
71
- dispose(): Promise<void>;
72
- }
@@ -1,92 +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 { RemoteBase } from '../remote-base.js';
8
- import { serializeFunctionSource } from '../../../internal/transport.js';
9
- /**
10
- * RemotePlaywrightJSHandle - Remote Playwright JSHandle API over RPC.
11
- *
12
- * @see https://playwright.dev/docs/api/class-jshandle
13
- */
14
- export class RemotePlaywrightJSHandle extends RemoteBase {
15
- /** Factory to create JSHandle instances */
16
- _jsHandleFactory;
17
- constructor(id, sendRpc, jsHandleFactory) {
18
- super(id, sendRpc);
19
- this._jsHandleFactory = jsHandleFactory;
20
- }
21
- get jsHandleFactory() {
22
- return this._jsHandleFactory;
23
- }
24
- /**
25
- * Evaluates the given function with this handle as the first argument.
26
- * @param pageFunction - Function to be evaluated in the page context.
27
- * @param arg - Optional argument to pass to the function.
28
- *
29
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate
30
- */
31
- async evaluate(pageFunction, arg) {
32
- const _pageFunction = serializeFunctionSource(pageFunction);
33
- return this.rpc('evaluate', [_pageFunction, arg]);
34
- }
35
- /**
36
- * Evaluates the given function with this handle as the first argument and returns a JSHandle.
37
- * @param pageFunction - Function to be evaluated in the page context.
38
- * @param arg - Optional argument to pass to the function.
39
- *
40
- * @remarks
41
- * Note: Returns serialized handle reference. Full JSHandle support not yet available.
42
- *
43
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate-handle
44
- */
45
- async evaluateHandle(pageFunction, arg) {
46
- const _pageFunction = serializeFunctionSource(pageFunction);
47
- return this.rpc('evaluateHandle', [_pageFunction, arg]);
48
- }
49
- /**
50
- * Returns a map of property names to JSHandle instances for own properties of the object.
51
- *
52
- * @remarks
53
- * Note: Returns serialized handle references. Full JSHandle support not yet available.
54
- *
55
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-properties
56
- */
57
- async getProperties() {
58
- return this.rpc('getProperties', []);
59
- }
60
- /**
61
- * Returns a JSHandle for the property with the given name.
62
- * @param propertyName - Property name to get.
63
- *
64
- * @remarks
65
- * Note: Returns serialized handle reference. Full JSHandle support not yet available.
66
- *
67
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-property
68
- */
69
- async getProperty(propertyName) {
70
- return this.rpc('getProperty', [propertyName]);
71
- }
72
- /**
73
- * Returns a JSON representation of the object.
74
- *
75
- * @remarks
76
- * If the object has a toJSON function, it will not be called.
77
- *
78
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-json-value
79
- */
80
- async jsonValue() {
81
- return this.rpc('jsonValue', []);
82
- }
83
- /**
84
- * Releases the handle. After calling dispose, the handle is no longer valid.
85
- *
86
- * @see https://playwright.dev/docs/api/class-jshandle#js-handle-dispose
87
- */
88
- async dispose() {
89
- await this.rpc('dispose', []);
90
- this.markClosed();
91
- }
92
- }
@@ -1,103 +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 { RemoteComponentBase } from '../remote-base.js';
9
- import type { PlaywrightKeyboardPressOptions, PlaywrightKeyboardTypeOptions } from '../types.js';
10
- /**
11
- * RemotePlaywrightKeyboard - Remote Playwright Keyboard API over RPC.
12
- *
13
- * @see https://playwright.dev/docs/api/class-keyboard
14
- */
15
- export declare class RemotePlaywrightKeyboard extends RemoteComponentBase {
16
- constructor(sendRpc: SimpleRpcSender);
17
- /**
18
- * Dispatches a keydown event.
19
- * @param key - Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
20
- *
21
- * @remarks
22
- * If key is a single character and no modifier keys besides Shift are being held down,
23
- * a keypress/input event will also be generated. The text option can be specified to force an input event to be generated.
24
- *
25
- * Modifier keys DO affect keyboard.down. Holding down Shift will type the text in upper case.
26
- *
27
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-down
28
- */
29
- down(key: string): Promise<void>;
30
- /**
31
- * Dispatches a keyup event.
32
- * @param key - Name of the key to release or a character.
33
- *
34
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-up
35
- */
36
- up(key: string): Promise<void>;
37
- /**
38
- * Shortcut for keyboard.down() and keyboard.up().
39
- * @param key - Key to press. Can be a character or a special key name (e.g., `ArrowLeft`, `Shift+A`, `ControlOrMeta+A`).
40
- * @param options - Options for the key press event.
41
- *
42
- * @remarks
43
- * Dispatches a keydown, keypress/input, and keyup event for the specified key.
44
- *
45
- * If key is a single character and no modifier keys besides Shift are being held down,
46
- * a keypress/input event will also be generated.
47
- *
48
- * Modifier keys DO affect keyboard.press. Holding down Shift will type the text in upper case.
49
- *
50
- * Shortcut such as "ControlOrMeta+A" are supported. "ControlOrMeta" resolves to "Control" on Windows/Linux and to "Meta" on macOS.
51
- *
52
- * @example
53
- * ```ts
54
- * await page.keyboard.press('Enter');
55
- * await page.keyboard.press('Shift+A');
56
- * await page.keyboard.press('ControlOrMeta+A');
57
- * ```
58
- *
59
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-press
60
- */
61
- press(key: string, options?: PlaywrightKeyboardPressOptions): Promise<void>;
62
- /**
63
- * Sends a keydown, keypress/input, and keyup event for each character in the text.
64
- * @param text - Text to type.
65
- * @param options - Options for typing.
66
- *
67
- * @remarks
68
- * Use this method when you need to simulate typing character by character,
69
- * for example, if the page has custom keyboard event listeners.
70
- *
71
- * Modifier keys DO NOT affect keyboard.type. Holding down Shift will not type the text in upper case.
72
- *
73
- * For characters not present on a standard US keyboard layout, only an input event will be dispatched.
74
- *
75
- * For simple text input, locator.fill() is generally preferred.
76
- *
77
- * @example
78
- * ```ts
79
- * await page.keyboard.type('Hello'); // Types instantly
80
- * await page.keyboard.type('World', { delay: 100 }); // Types slower, like a user
81
- * ```
82
- *
83
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-type
84
- */
85
- type(text: string, options?: PlaywrightKeyboardTypeOptions): Promise<void>;
86
- /**
87
- * Dispatches only an input event, does not emit keydown, keyup, or keypress events.
88
- * @param text - Text to insert.
89
- *
90
- * @remarks
91
- * This method is useful for directly inserting text without simulating physical key presses.
92
- *
93
- * Modifier keys DO NOT affect keyboard.insertText. Holding down Shift will not type the text in upper case.
94
- *
95
- * @example
96
- * ```ts
97
- * await page.keyboard.insertText('Hello');
98
- * ```
99
- *
100
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-insert-text
101
- */
102
- insertText(text: string): Promise<void>;
103
- }
@@ -1,113 +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 { RemoteComponentBase } from '../remote-base.js';
8
- /**
9
- * RemotePlaywrightKeyboard - Remote Playwright Keyboard API over RPC.
10
- *
11
- * @see https://playwright.dev/docs/api/class-keyboard
12
- */
13
- export class RemotePlaywrightKeyboard extends RemoteComponentBase {
14
- constructor(sendRpc) {
15
- super(sendRpc);
16
- }
17
- /**
18
- * Dispatches a keydown event.
19
- * @param key - Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
20
- *
21
- * @remarks
22
- * If key is a single character and no modifier keys besides Shift are being held down,
23
- * a keypress/input event will also be generated. The text option can be specified to force an input event to be generated.
24
- *
25
- * Modifier keys DO affect keyboard.down. Holding down Shift will type the text in upper case.
26
- *
27
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-down
28
- */
29
- async down(key) {
30
- await this.rpc('keyboard.down', [key]);
31
- }
32
- /**
33
- * Dispatches a keyup event.
34
- * @param key - Name of the key to release or a character.
35
- *
36
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-up
37
- */
38
- async up(key) {
39
- await this.rpc('keyboard.up', [key]);
40
- }
41
- /**
42
- * Shortcut for keyboard.down() and keyboard.up().
43
- * @param key - Key to press. Can be a character or a special key name (e.g., `ArrowLeft`, `Shift+A`, `ControlOrMeta+A`).
44
- * @param options - Options for the key press event.
45
- *
46
- * @remarks
47
- * Dispatches a keydown, keypress/input, and keyup event for the specified key.
48
- *
49
- * If key is a single character and no modifier keys besides Shift are being held down,
50
- * a keypress/input event will also be generated.
51
- *
52
- * Modifier keys DO affect keyboard.press. Holding down Shift will type the text in upper case.
53
- *
54
- * Shortcut such as "ControlOrMeta+A" are supported. "ControlOrMeta" resolves to "Control" on Windows/Linux and to "Meta" on macOS.
55
- *
56
- * @example
57
- * ```ts
58
- * await page.keyboard.press('Enter');
59
- * await page.keyboard.press('Shift+A');
60
- * await page.keyboard.press('ControlOrMeta+A');
61
- * ```
62
- *
63
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-press
64
- */
65
- async press(key, options) {
66
- await this.rpc('keyboard.press', [key, options]);
67
- }
68
- /**
69
- * Sends a keydown, keypress/input, and keyup event for each character in the text.
70
- * @param text - Text to type.
71
- * @param options - Options for typing.
72
- *
73
- * @remarks
74
- * Use this method when you need to simulate typing character by character,
75
- * for example, if the page has custom keyboard event listeners.
76
- *
77
- * Modifier keys DO NOT affect keyboard.type. Holding down Shift will not type the text in upper case.
78
- *
79
- * For characters not present on a standard US keyboard layout, only an input event will be dispatched.
80
- *
81
- * For simple text input, locator.fill() is generally preferred.
82
- *
83
- * @example
84
- * ```ts
85
- * await page.keyboard.type('Hello'); // Types instantly
86
- * await page.keyboard.type('World', { delay: 100 }); // Types slower, like a user
87
- * ```
88
- *
89
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-type
90
- */
91
- async type(text, options) {
92
- await this.rpc('keyboard.type', [text, options]);
93
- }
94
- /**
95
- * Dispatches only an input event, does not emit keydown, keyup, or keypress events.
96
- * @param text - Text to insert.
97
- *
98
- * @remarks
99
- * This method is useful for directly inserting text without simulating physical key presses.
100
- *
101
- * Modifier keys DO NOT affect keyboard.insertText. Holding down Shift will not type the text in upper case.
102
- *
103
- * @example
104
- * ```ts
105
- * await page.keyboard.insertText('Hello');
106
- * ```
107
- *
108
- * @see https://playwright.dev/docs/api/class-keyboard#keyboard-insert-text
109
- */
110
- async insertText(text) {
111
- await this.rpc('keyboard.insertText', [text]);
112
- }
113
- }