@selenium/atoms 4.51.0 → 4.53.0

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 (392) hide show
  1. package/README.md +56 -0
  2. package/dist/index.d.ts +44 -0
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +42 -0
  5. package/dist/index.js.map +1 -1
  6. package/dist/typescript/accessibility-snapshot-wire.d.ts +4 -0
  7. package/dist/typescript/accessibility-snapshot-wire.d.ts.map +1 -0
  8. package/dist/typescript/accessibility-snapshot-wire.js +18 -0
  9. package/dist/typescript/accessibility-snapshot-wire.js.map +1 -0
  10. package/dist/typescript/accessibility-snapshot.d.ts +3 -0
  11. package/dist/typescript/accessibility-snapshot.d.ts.map +1 -0
  12. package/dist/typescript/accessibility-snapshot.js +18 -0
  13. package/dist/typescript/accessibility-snapshot.js.map +1 -0
  14. package/dist/typescript/active-element.d.ts +2 -0
  15. package/dist/typescript/active-element.d.ts.map +1 -0
  16. package/dist/typescript/active-element.js +19 -0
  17. package/dist/typescript/active-element.js.map +1 -0
  18. package/dist/typescript/clear-local-storage.d.ts +3 -0
  19. package/dist/typescript/clear-local-storage.d.ts.map +1 -0
  20. package/dist/typescript/clear-local-storage.js +25 -0
  21. package/dist/typescript/clear-local-storage.js.map +1 -0
  22. package/dist/typescript/clear-session-storage.d.ts +3 -0
  23. package/dist/typescript/clear-session-storage.d.ts.map +1 -0
  24. package/dist/typescript/clear-session-storage.js +25 -0
  25. package/dist/typescript/clear-session-storage.js.map +1 -0
  26. package/dist/typescript/clear.d.ts +3 -0
  27. package/dist/typescript/clear.d.ts.map +1 -0
  28. package/dist/typescript/clear.js +67 -0
  29. package/dist/typescript/clear.js.map +1 -0
  30. package/dist/typescript/click.d.ts +4 -0
  31. package/dist/typescript/click.d.ts.map +1 -0
  32. package/dist/typescript/click.js +52 -0
  33. package/dist/typescript/click.js.map +1 -0
  34. package/dist/typescript/core/accessibility/accname.d.ts +6 -0
  35. package/dist/typescript/core/accessibility/accname.d.ts.map +1 -0
  36. package/dist/typescript/core/accessibility/accname.js +537 -0
  37. package/dist/typescript/core/accessibility/accname.js.map +1 -0
  38. package/dist/typescript/core/accessibility/context.d.ts +43 -0
  39. package/dist/typescript/core/accessibility/context.d.ts.map +1 -0
  40. package/dist/typescript/core/accessibility/context.js +49 -0
  41. package/dist/typescript/core/accessibility/context.js.map +1 -0
  42. package/dist/typescript/core/accessibility/hidden.d.ts +39 -0
  43. package/dist/typescript/core/accessibility/hidden.d.ts.map +1 -0
  44. package/dist/typescript/core/accessibility/hidden.js +216 -0
  45. package/dist/typescript/core/accessibility/hidden.js.map +1 -0
  46. package/dist/typescript/core/accessibility/roles.d.ts +28 -0
  47. package/dist/typescript/core/accessibility/roles.d.ts.map +1 -0
  48. package/dist/typescript/core/accessibility/roles.js +381 -0
  49. package/dist/typescript/core/accessibility/roles.js.map +1 -0
  50. package/dist/typescript/core/accessibility/snapshot.d.ts +13 -0
  51. package/dist/typescript/core/accessibility/snapshot.d.ts.map +1 -0
  52. package/dist/typescript/core/accessibility/snapshot.js +55 -0
  53. package/dist/typescript/core/accessibility/snapshot.js.map +1 -0
  54. package/dist/typescript/core/accessibility/states.d.ts +18 -0
  55. package/dist/typescript/core/accessibility/states.d.ts.map +1 -0
  56. package/dist/typescript/core/accessibility/states.js +215 -0
  57. package/dist/typescript/core/accessibility/states.js.map +1 -0
  58. package/dist/typescript/core/accessibility/tree.d.ts +10 -0
  59. package/dist/typescript/core/accessibility/tree.d.ts.map +1 -0
  60. package/dist/typescript/core/accessibility/tree.js +261 -0
  61. package/dist/typescript/core/accessibility/tree.js.map +1 -0
  62. package/dist/typescript/core/accessibility/types.d.ts +30 -0
  63. package/dist/typescript/core/accessibility/types.d.ts.map +1 -0
  64. package/dist/typescript/core/accessibility/types.js +18 -0
  65. package/dist/typescript/core/accessibility/types.js.map +1 -0
  66. package/dist/typescript/core/accessibility/value.d.ts +4 -0
  67. package/dist/typescript/core/accessibility/value.d.ts.map +1 -0
  68. package/dist/typescript/core/accessibility/value.js +83 -0
  69. package/dist/typescript/core/accessibility/value.js.map +1 -0
  70. package/dist/typescript/core/accessibility/wire.d.ts +57 -0
  71. package/dist/typescript/core/accessibility/wire.d.ts.map +1 -0
  72. package/dist/typescript/core/accessibility/wire.js +72 -0
  73. package/dist/typescript/core/accessibility/wire.js.map +1 -0
  74. package/dist/typescript/core/attribute.d.ts +3 -0
  75. package/dist/typescript/core/attribute.d.ts.map +1 -0
  76. package/dist/typescript/core/attribute.js +60 -0
  77. package/dist/typescript/core/attribute.js.map +1 -0
  78. package/dist/typescript/core/color.d.ts +2 -0
  79. package/dist/typescript/core/color.d.ts.map +1 -0
  80. package/dist/typescript/core/color.js +248 -0
  81. package/dist/typescript/core/color.js.map +1 -0
  82. package/dist/typescript/core/editable.d.ts +5 -0
  83. package/dist/typescript/core/editable.d.ts.map +1 -0
  84. package/dist/typescript/core/editable.js +55 -0
  85. package/dist/typescript/core/editable.js.map +1 -0
  86. package/dist/typescript/core/element.d.ts +6 -0
  87. package/dist/typescript/core/element.d.ts.map +1 -0
  88. package/dist/typescript/core/element.js +97 -0
  89. package/dist/typescript/core/element.js.map +1 -0
  90. package/dist/typescript/core/enabled.d.ts +2 -0
  91. package/dist/typescript/core/enabled.d.ts.map +1 -0
  92. package/dist/typescript/core/enabled.js +69 -0
  93. package/dist/typescript/core/enabled.js.map +1 -0
  94. package/dist/typescript/core/error.d.ts +13 -0
  95. package/dist/typescript/core/error.d.ts.map +1 -0
  96. package/dist/typescript/core/error.js +40 -0
  97. package/dist/typescript/core/error.js.map +1 -0
  98. package/dist/typescript/core/events.d.ts +91 -0
  99. package/dist/typescript/core/events.d.ts.map +1 -0
  100. package/dist/typescript/core/events.js +131 -0
  101. package/dist/typescript/core/events.js.map +1 -0
  102. package/dist/typescript/core/focus.d.ts +4 -0
  103. package/dist/typescript/core/focus.d.ts.map +1 -0
  104. package/dist/typescript/core/focus.js +88 -0
  105. package/dist/typescript/core/focus.js.map +1 -0
  106. package/dist/typescript/core/focusable.d.ts +2 -0
  107. package/dist/typescript/core/focusable.d.ts.map +1 -0
  108. package/dist/typescript/core/focusable.js +36 -0
  109. package/dist/typescript/core/focusable.js.map +1 -0
  110. package/dist/typescript/core/form.d.ts +2 -0
  111. package/dist/typescript/core/form.d.ts.map +1 -0
  112. package/dist/typescript/core/form.js +76 -0
  113. package/dist/typescript/core/form.js.map +1 -0
  114. package/dist/typescript/core/frame.d.ts +8 -0
  115. package/dist/typescript/core/frame.d.ts.map +1 -0
  116. package/dist/typescript/core/frame.js +95 -0
  117. package/dist/typescript/core/frame.js.map +1 -0
  118. package/dist/typescript/core/geometry.d.ts +28 -0
  119. package/dist/typescript/core/geometry.d.ts.map +1 -0
  120. package/dist/typescript/core/geometry.js +134 -0
  121. package/dist/typescript/core/geometry.js.map +1 -0
  122. package/dist/typescript/core/inject.d.ts +21 -0
  123. package/dist/typescript/core/inject.d.ts.map +1 -0
  124. package/dist/typescript/core/inject.js +282 -0
  125. package/dist/typescript/core/inject.js.map +1 -0
  126. package/dist/typescript/core/interactable.d.ts +2 -0
  127. package/dist/typescript/core/interactable.d.ts.map +1 -0
  128. package/dist/typescript/core/interactable.js +27 -0
  129. package/dist/typescript/core/interactable.js.map +1 -0
  130. package/dist/typescript/core/keyboard.d.ts +15 -0
  131. package/dist/typescript/core/keyboard.d.ts.map +1 -0
  132. package/dist/typescript/core/keyboard.js +356 -0
  133. package/dist/typescript/core/keyboard.js.map +1 -0
  134. package/dist/typescript/core/keys.d.ts +65 -0
  135. package/dist/typescript/core/keys.d.ts.map +1 -0
  136. package/dist/typescript/core/keys.js +125 -0
  137. package/dist/typescript/core/keys.js.map +1 -0
  138. package/dist/typescript/core/locators.d.ts +6 -0
  139. package/dist/typescript/core/locators.d.ts.map +1 -0
  140. package/dist/typescript/core/locators.js +610 -0
  141. package/dist/typescript/core/locators.js.map +1 -0
  142. package/dist/typescript/core/mouse.d.ts +17 -0
  143. package/dist/typescript/core/mouse.d.ts.map +1 -0
  144. package/dist/typescript/core/mouse.js +186 -0
  145. package/dist/typescript/core/mouse.js.map +1 -0
  146. package/dist/typescript/core/overflow.d.ts +5 -0
  147. package/dist/typescript/core/overflow.d.ts.map +1 -0
  148. package/dist/typescript/core/overflow.js +133 -0
  149. package/dist/typescript/core/overflow.js.map +1 -0
  150. package/dist/typescript/core/scroll.d.ts +3 -0
  151. package/dist/typescript/core/scroll.d.ts.map +1 -0
  152. package/dist/typescript/core/scroll.js +77 -0
  153. package/dist/typescript/core/scroll.js.map +1 -0
  154. package/dist/typescript/core/shown.d.ts +3 -0
  155. package/dist/typescript/core/shown.d.ts.map +1 -0
  156. package/dist/typescript/core/shown.js +190 -0
  157. package/dist/typescript/core/shown.js.map +1 -0
  158. package/dist/typescript/core/storage.d.ts +14 -0
  159. package/dist/typescript/core/storage.d.ts.map +1 -0
  160. package/dist/typescript/core/storage.js +98 -0
  161. package/dist/typescript/core/storage.js.map +1 -0
  162. package/dist/typescript/core/style.d.ts +2 -0
  163. package/dist/typescript/core/style.d.ts.map +1 -0
  164. package/dist/typescript/core/style.js +32 -0
  165. package/dist/typescript/core/style.js.map +1 -0
  166. package/dist/typescript/core/useragent.d.ts +3 -0
  167. package/dist/typescript/core/useragent.d.ts.map +1 -0
  168. package/dist/typescript/core/useragent.js +31 -0
  169. package/dist/typescript/core/useragent.js.map +1 -0
  170. package/dist/typescript/default-content.d.ts +2 -0
  171. package/dist/typescript/default-content.d.ts.map +1 -0
  172. package/dist/typescript/default-content.js +20 -0
  173. package/dist/typescript/default-content.js.map +1 -0
  174. package/dist/typescript/execute-async-script.d.ts +2 -0
  175. package/dist/typescript/execute-async-script.d.ts.map +1 -0
  176. package/dist/typescript/execute-async-script.js +20 -0
  177. package/dist/typescript/execute-async-script.js.map +1 -0
  178. package/dist/typescript/execute-script.d.ts +2 -0
  179. package/dist/typescript/execute-script.d.ts.map +1 -0
  180. package/dist/typescript/execute-script.js +20 -0
  181. package/dist/typescript/execute-script.js.map +1 -0
  182. package/dist/typescript/find-element-fragment.d.ts +8 -0
  183. package/dist/typescript/find-element-fragment.d.ts.map +1 -0
  184. package/dist/typescript/find-element-fragment.js +39 -0
  185. package/dist/typescript/find-element-fragment.js.map +1 -0
  186. package/dist/typescript/find-element.d.ts +2 -0
  187. package/dist/typescript/find-element.d.ts.map +1 -0
  188. package/dist/typescript/find-element.js +18 -0
  189. package/dist/typescript/find-element.js.map +1 -0
  190. package/dist/typescript/find-elements.d.ts +1 -2
  191. package/dist/typescript/find-elements.d.ts.map +1 -1
  192. package/dist/typescript/find-elements.js +1 -289
  193. package/dist/typescript/find-elements.js.map +1 -1
  194. package/dist/typescript/frame-by-id-or-name.d.ts +2 -0
  195. package/dist/typescript/frame-by-id-or-name.d.ts.map +1 -0
  196. package/dist/typescript/frame-by-id-or-name.js +22 -0
  197. package/dist/typescript/frame-by-id-or-name.js.map +1 -0
  198. package/dist/typescript/frame-by-index.d.ts +2 -0
  199. package/dist/typescript/frame-by-index.d.ts.map +1 -0
  200. package/dist/typescript/frame-by-index.js +19 -0
  201. package/dist/typescript/frame-by-index.js.map +1 -0
  202. package/dist/typescript/get-attribute-value.d.ts +2 -0
  203. package/dist/typescript/get-attribute-value.d.ts.map +1 -0
  204. package/dist/typescript/get-attribute-value.js +22 -0
  205. package/dist/typescript/get-attribute-value.js.map +1 -0
  206. package/dist/typescript/get-effective-style.d.ts +3 -0
  207. package/dist/typescript/get-effective-style.d.ts.map +1 -0
  208. package/dist/typescript/get-effective-style.js +84 -0
  209. package/dist/typescript/get-effective-style.js.map +1 -0
  210. package/dist/typescript/get-element-from-cache.d.ts +2 -0
  211. package/dist/typescript/get-element-from-cache.d.ts.map +1 -0
  212. package/dist/typescript/get-element-from-cache.js +20 -0
  213. package/dist/typescript/get-element-from-cache.js.map +1 -0
  214. package/dist/typescript/get-frame-window.d.ts +2 -0
  215. package/dist/typescript/get-frame-window.d.ts.map +1 -0
  216. package/dist/typescript/get-frame-window.js +22 -0
  217. package/dist/typescript/get-frame-window.js.map +1 -0
  218. package/dist/typescript/get-local-storage-item.d.ts +3 -0
  219. package/dist/typescript/get-local-storage-item.d.ts.map +1 -0
  220. package/dist/typescript/get-local-storage-item.js +25 -0
  221. package/dist/typescript/get-local-storage-item.js.map +1 -0
  222. package/dist/typescript/get-local-storage-key.d.ts +3 -0
  223. package/dist/typescript/get-local-storage-key.d.ts.map +1 -0
  224. package/dist/typescript/get-local-storage-key.js +26 -0
  225. package/dist/typescript/get-local-storage-key.js.map +1 -0
  226. package/dist/typescript/get-local-storage-keys.d.ts +3 -0
  227. package/dist/typescript/get-local-storage-keys.d.ts.map +1 -0
  228. package/dist/typescript/get-local-storage-keys.js +25 -0
  229. package/dist/typescript/get-local-storage-keys.js.map +1 -0
  230. package/dist/typescript/get-local-storage-size.d.ts +3 -0
  231. package/dist/typescript/get-local-storage-size.d.ts.map +1 -0
  232. package/dist/typescript/get-local-storage-size.js +25 -0
  233. package/dist/typescript/get-local-storage-size.js.map +1 -0
  234. package/dist/typescript/get-location.d.ts +9 -0
  235. package/dist/typescript/get-location.d.ts.map +1 -0
  236. package/dist/typescript/get-location.js +49 -0
  237. package/dist/typescript/get-location.js.map +1 -0
  238. package/dist/typescript/get-session-storage-item.d.ts +3 -0
  239. package/dist/typescript/get-session-storage-item.d.ts.map +1 -0
  240. package/dist/typescript/get-session-storage-item.js +25 -0
  241. package/dist/typescript/get-session-storage-item.js.map +1 -0
  242. package/dist/typescript/get-session-storage-key.d.ts +3 -0
  243. package/dist/typescript/get-session-storage-key.d.ts.map +1 -0
  244. package/dist/typescript/get-session-storage-key.js +26 -0
  245. package/dist/typescript/get-session-storage-key.js.map +1 -0
  246. package/dist/typescript/get-session-storage-keys.d.ts +3 -0
  247. package/dist/typescript/get-session-storage-keys.d.ts.map +1 -0
  248. package/dist/typescript/get-session-storage-keys.js +25 -0
  249. package/dist/typescript/get-session-storage-keys.js.map +1 -0
  250. package/dist/typescript/get-session-storage-size.d.ts +3 -0
  251. package/dist/typescript/get-session-storage-size.d.ts.map +1 -0
  252. package/dist/typescript/get-session-storage-size.js +25 -0
  253. package/dist/typescript/get-session-storage-size.js.map +1 -0
  254. package/dist/typescript/get-size.d.ts +7 -0
  255. package/dist/typescript/get-size.d.ts.map +1 -0
  256. package/dist/typescript/get-size.js +36 -0
  257. package/dist/typescript/get-size.js.map +1 -0
  258. package/dist/typescript/get-text.d.ts +3 -0
  259. package/dist/typescript/get-text.d.ts.map +1 -0
  260. package/dist/typescript/get-text.js +294 -0
  261. package/dist/typescript/get-text.js.map +1 -0
  262. package/dist/typescript/get-top-left-coordinates.d.ts +4 -0
  263. package/dist/typescript/get-top-left-coordinates.d.ts.map +1 -0
  264. package/dist/typescript/get-top-left-coordinates.js +36 -0
  265. package/dist/typescript/get-top-left-coordinates.js.map +1 -0
  266. package/dist/typescript/is-displayed.d.ts +1 -2
  267. package/dist/typescript/is-displayed.d.ts.map +1 -1
  268. package/dist/typescript/is-displayed.js +3 -396
  269. package/dist/typescript/is-displayed.js.map +1 -1
  270. package/dist/typescript/is-editable.d.ts +2 -0
  271. package/dist/typescript/is-editable.d.ts.map +1 -0
  272. package/dist/typescript/is-editable.js +18 -0
  273. package/dist/typescript/is-editable.js.map +1 -0
  274. package/dist/typescript/is-enabled.d.ts +2 -0
  275. package/dist/typescript/is-enabled.d.ts.map +1 -0
  276. package/dist/typescript/is-enabled.js +18 -0
  277. package/dist/typescript/is-enabled.js.map +1 -0
  278. package/dist/typescript/is-focusable.d.ts +2 -0
  279. package/dist/typescript/is-focusable.d.ts.map +1 -0
  280. package/dist/typescript/is-focusable.js +20 -0
  281. package/dist/typescript/is-focusable.js.map +1 -0
  282. package/dist/typescript/is-interactable.d.ts +2 -0
  283. package/dist/typescript/is-interactable.d.ts.map +1 -0
  284. package/dist/typescript/is-interactable.js +19 -0
  285. package/dist/typescript/is-interactable.js.map +1 -0
  286. package/dist/typescript/is-selected.d.ts +3 -0
  287. package/dist/typescript/is-selected.d.ts.map +1 -0
  288. package/dist/typescript/is-selected.js +29 -0
  289. package/dist/typescript/is-selected.js.map +1 -0
  290. package/dist/typescript/remove-local-storage-item.d.ts +3 -0
  291. package/dist/typescript/remove-local-storage-item.d.ts.map +1 -0
  292. package/dist/typescript/remove-local-storage-item.js +25 -0
  293. package/dist/typescript/remove-local-storage-item.js.map +1 -0
  294. package/dist/typescript/remove-session-storage-item.d.ts +3 -0
  295. package/dist/typescript/remove-session-storage-item.d.ts.map +1 -0
  296. package/dist/typescript/remove-session-storage-item.js +25 -0
  297. package/dist/typescript/remove-session-storage-item.js.map +1 -0
  298. package/dist/typescript/set-local-storage-item.d.ts +3 -0
  299. package/dist/typescript/set-local-storage-item.d.ts.map +1 -0
  300. package/dist/typescript/set-local-storage-item.js +26 -0
  301. package/dist/typescript/set-local-storage-item.js.map +1 -0
  302. package/dist/typescript/set-session-storage-item.d.ts +3 -0
  303. package/dist/typescript/set-session-storage-item.d.ts.map +1 -0
  304. package/dist/typescript/set-session-storage-item.js +26 -0
  305. package/dist/typescript/set-session-storage-item.js.map +1 -0
  306. package/dist/typescript/submit.d.ts +3 -0
  307. package/dist/typescript/submit.d.ts.map +1 -0
  308. package/dist/typescript/submit.js +50 -0
  309. package/dist/typescript/submit.js.map +1 -0
  310. package/dist/typescript/type.d.ts +3 -0
  311. package/dist/typescript/type.d.ts.map +1 -0
  312. package/dist/typescript/type.js +201 -0
  313. package/dist/typescript/type.js.map +1 -0
  314. package/index.ts +44 -0
  315. package/package.json +306 -5
  316. package/typescript/accessibility-snapshot-wire.ts +20 -0
  317. package/typescript/accessibility-snapshot.ts +21 -0
  318. package/typescript/active-element.ts +19 -0
  319. package/typescript/clear-local-storage.ts +27 -0
  320. package/typescript/clear-session-storage.ts +27 -0
  321. package/typescript/clear.ts +73 -0
  322. package/typescript/click.ts +55 -0
  323. package/typescript/core/accessibility/accname.ts +587 -0
  324. package/typescript/core/accessibility/context.ts +116 -0
  325. package/typescript/core/accessibility/hidden.ts +242 -0
  326. package/typescript/core/accessibility/roles.ts +410 -0
  327. package/typescript/core/accessibility/snapshot.ts +61 -0
  328. package/typescript/core/accessibility/states.ts +233 -0
  329. package/typescript/core/accessibility/tree.ts +306 -0
  330. package/typescript/core/accessibility/types.ts +52 -0
  331. package/typescript/core/accessibility/value.ts +89 -0
  332. package/typescript/core/accessibility/wire.ts +123 -0
  333. package/typescript/core/attribute.ts +68 -0
  334. package/typescript/core/color.ts +257 -0
  335. package/typescript/core/editable.ts +63 -0
  336. package/typescript/core/element.ts +110 -0
  337. package/typescript/core/enabled.ts +76 -0
  338. package/typescript/core/error.ts +41 -0
  339. package/typescript/core/events.ts +268 -0
  340. package/typescript/core/focus.ts +92 -0
  341. package/typescript/core/focusable.ts +38 -0
  342. package/typescript/core/form.ts +81 -0
  343. package/typescript/core/frame.ts +105 -0
  344. package/typescript/core/geometry.ts +183 -0
  345. package/typescript/core/inject.ts +336 -0
  346. package/typescript/core/interactable.ts +30 -0
  347. package/typescript/core/keyboard.ts +369 -0
  348. package/typescript/core/keys.ts +204 -0
  349. package/typescript/core/locators.ts +704 -0
  350. package/typescript/core/mouse.ts +211 -0
  351. package/typescript/core/overflow.ts +172 -0
  352. package/typescript/core/scroll.ts +92 -0
  353. package/typescript/core/shown.ts +233 -0
  354. package/typescript/core/storage.ts +111 -0
  355. package/typescript/core/style.ts +32 -0
  356. package/typescript/core/useragent.ts +33 -0
  357. package/typescript/default-content.ts +20 -0
  358. package/typescript/execute-async-script.ts +20 -0
  359. package/typescript/execute-script.ts +20 -0
  360. package/typescript/find-element-fragment.ts +45 -0
  361. package/typescript/find-element.ts +18 -0
  362. package/typescript/find-elements.ts +1 -326
  363. package/typescript/frame-by-id-or-name.ts +22 -0
  364. package/typescript/frame-by-index.ts +19 -0
  365. package/typescript/get-attribute-value.ts +22 -0
  366. package/typescript/get-effective-style.ts +93 -0
  367. package/typescript/get-element-from-cache.ts +20 -0
  368. package/typescript/get-frame-window.ts +22 -0
  369. package/typescript/get-local-storage-item.ts +27 -0
  370. package/typescript/get-local-storage-key.ts +28 -0
  371. package/typescript/get-local-storage-keys.ts +27 -0
  372. package/typescript/get-local-storage-size.ts +27 -0
  373. package/typescript/get-location.ts +63 -0
  374. package/typescript/get-session-storage-item.ts +27 -0
  375. package/typescript/get-session-storage-key.ts +28 -0
  376. package/typescript/get-session-storage-keys.ts +27 -0
  377. package/typescript/get-session-storage-size.ts +27 -0
  378. package/typescript/get-size.ts +43 -0
  379. package/typescript/get-text.ts +353 -0
  380. package/typescript/get-top-left-coordinates.ts +38 -0
  381. package/typescript/is-displayed.ts +3 -498
  382. package/typescript/is-editable.ts +18 -0
  383. package/typescript/is-enabled.ts +18 -0
  384. package/typescript/is-focusable.ts +20 -0
  385. package/typescript/is-interactable.ts +19 -0
  386. package/typescript/is-selected.ts +31 -0
  387. package/typescript/remove-local-storage-item.ts +27 -0
  388. package/typescript/remove-session-storage-item.ts +27 -0
  389. package/typescript/set-local-storage-item.ts +28 -0
  390. package/typescript/set-session-storage-item.ts +28 -0
  391. package/typescript/submit.ts +53 -0
  392. package/typescript/type.ts +210 -0
@@ -0,0 +1,105 @@
1
+ // Licensed to the Software Freedom Conservancy (SFC) under one
2
+ // or more contributor license agreements. See the NOTICE file
3
+ // distributed with this work for additional information
4
+ // regarding copyright ownership. The SFC licenses this file
5
+ // to you under the Apache License, Version 2.0 (the
6
+ // "License"); you may not use this file except in compliance
7
+ // with the License. You may obtain a copy of the License at
8
+ //
9
+ // http://www.apache.org/licenses/LICENSE-2.0
10
+ //
11
+ // Unless required by applicable law or agreed to in writing,
12
+ // software distributed under the License is distributed on an
13
+ // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ // KIND, either express or implied. See the License for the
15
+ // specific language governing permissions and limitations
16
+ // under the License.
17
+
18
+ import { isElement } from './element.js'
19
+ import { NO_SUCH_FRAME, botError } from './error.js'
20
+ import { findElements } from './locators.js'
21
+
22
+ // The window the atom is running in. Closure routed every one of these through
23
+ // bot.getWindow() because the inject layer retargets command execution at a
24
+ // frame; an atom called directly is already in the frame it is asking about.
25
+ function windowOr(optWindow?: Window): Window {
26
+ return optWindow || window
27
+ }
28
+
29
+ export function isFrame(element: Element): boolean {
30
+ return isElement(element, 'FRAME') || isElement(element, 'IFRAME')
31
+ }
32
+
33
+ // goog.dom.getFrameContentWindow. Returning null rather than propagating is
34
+ // the contract -- a frame that is detached, or whose document cannot be
35
+ // reached, is reported as "no window" rather than as a failure.
36
+ export function getFrameContentWindow(frame: HTMLIFrameElement | HTMLFrameElement): Window | null {
37
+ try {
38
+ return frame.contentWindow || (frame.contentDocument ? frame.contentDocument.defaultView : null)
39
+ } catch (_unreachable) {
40
+ return null
41
+ }
42
+ }
43
+
44
+ export function defaultContent(optWindow?: Window): Window | null {
45
+ return windowOr(optWindow).top
46
+ }
47
+
48
+ // Falls back to the body so that a document with nothing focused still answers
49
+ // with an element. bot.dom.getActiveElement is the other spelling of this and
50
+ // returns null instead; the frame one is what the active_element atom means.
51
+ export function activeElement(optWindow?: Window): Element {
52
+ const doc = windowOr(optWindow).document
53
+ return doc.activeElement || doc.body
54
+ }
55
+
56
+ export function getFrameWindow(element: Element): Window | null {
57
+ if (isFrame(element)) {
58
+ return getFrameContentWindow(element as HTMLIFrameElement | HTMLFrameElement)
59
+ }
60
+ throw botError(NO_SUCH_FRAME, "The given element isn't a frame or an iframe.")
61
+ }
62
+
63
+ // Name wins over id, despite the atom being called frame_by_id_or_name.
64
+ //
65
+ // Both lookups are deliberately shallow: frames[] holds only this window's own
66
+ // children and the id search runs over this window's document, so a nested or
67
+ // parent frame is not found from here. The Closure tests pin that -- searching
68
+ // the top window for a frame nested two levels down returns null.
69
+ //
70
+ // Inherited hazard: reading `name` off a cross-origin frame throws a
71
+ // SecurityError, because Window.name is not on the cross-origin allowlist.
72
+ // The Closure original has the same hole; it is not fixed here because that
73
+ // would be a behaviour change rather than a port. (frame.js:106)
74
+ export function findFrameByNameOrId(nameOrId: string | number, optRoot?: Window): Window | null {
75
+ const domWindow = windowOr(optRoot)
76
+
77
+ const numFrames = domWindow.frames.length
78
+ for (let i = 0; i < numFrames; i++) {
79
+ const frame = domWindow.frames[i]
80
+ // frameElement is the <frame>/<iframe> in the parent document, and null
81
+ // across an origin boundary, where the window itself carries the name.
82
+ const frameElement = frame.frameElement || frame
83
+ if ((frameElement as { name?: unknown }).name == nameOrId) {
84
+ // Safari 4 handed back an HTMLFrameElement here instead of a Window, so
85
+ // the original re-resolved it. Every supported browser gives a Window.
86
+ return frame
87
+ }
88
+ }
89
+
90
+ // bot.locators.id compared with ==, so a numeric id matched; the id locator
91
+ // here compares strings exactly.
92
+ const elements = findElements({ id: String(nameOrId) }, domWindow.document)
93
+ for (let i = 0; i < elements.length; i++) {
94
+ const frameElement = elements[i]
95
+ if (frameElement && isFrame(frameElement)) {
96
+ return getFrameContentWindow(frameElement as HTMLIFrameElement | HTMLFrameElement)
97
+ }
98
+ }
99
+
100
+ return null
101
+ }
102
+
103
+ export function findFrameByIndex(index: number, optRoot?: Window): Window | null {
104
+ return windowOr(optRoot).frames[index] || null
105
+ }
@@ -0,0 +1,183 @@
1
+ // Licensed to the Software Freedom Conservancy (SFC) under one
2
+ // or more contributor license agreements. See the NOTICE file
3
+ // distributed with this work for additional information
4
+ // regarding copyright ownership. The SFC licenses this file
5
+ // to you under the Apache License, Version 2.0 (the
6
+ // "License"); you may not use this file except in compliance
7
+ // with the License. You may obtain a copy of the License at
8
+ //
9
+ // http://www.apache.org/licenses/LICENSE-2.0
10
+ //
11
+ // Unless required by applicable law or agreed to in writing,
12
+ // software distributed under the License is distributed on an
13
+ // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ // KIND, either express or implied. See the License for the
15
+ // specific language governing permissions and limitations
16
+ // under the License.
17
+
18
+ import { isElement } from './element.js'
19
+
20
+ export interface Rect {
21
+ left: number;
22
+ top: number;
23
+ right: number;
24
+ bottom: number;
25
+ width: number;
26
+ height: number;
27
+ }
28
+
29
+ export interface Coordinate {
30
+ x: number;
31
+ y: number;
32
+ }
33
+
34
+ export interface ImageMapResult {
35
+ image: Element | null;
36
+ rect: Rect;
37
+ }
38
+
39
+ // The sub-region accepted by getClientRegion and the scrolling helpers. A bare
40
+ // coordinate means the single pixel at that point, matching Closure's
41
+ // `new goog.math.Rect(region.x, region.y, 1, 1)` coercion.
42
+ export type Region = { left: number; top: number; width: number; height: number } | Coordinate;
43
+
44
+ // Reading a rect is injectable because isShownElement memoises it across the
45
+ // hundreds of reads one isDisplayed call makes; everyone else wants the plain
46
+ // uncached read.
47
+ export type RectReader = (elem: Element) => Rect;
48
+
49
+ export function createRect(left: number, top: number, width: number, height: number): Rect {
50
+ return {
51
+ left: left,
52
+ top: top,
53
+ right: left + width,
54
+ bottom: top + height,
55
+ width: width,
56
+ height: height,
57
+ }
58
+ }
59
+
60
+ function clamp(value: number, min: number, max: number): number {
61
+ return Math.min(Math.max(value, min), max)
62
+ }
63
+
64
+ function getAreaRelativeRect(area: HTMLAreaElement): Rect {
65
+ var shape = area.shape.toLowerCase()
66
+ var coords = area.coords.split(',').map(function (value) {
67
+ return Number(value.trim())
68
+ })
69
+
70
+ if (shape === 'rect' && coords.length === 4) {
71
+ return createRect(coords[0], coords[1], coords[2] - coords[0], coords[3] - coords[1])
72
+ }
73
+
74
+ if (shape === 'circle' && coords.length === 3) {
75
+ return createRect(coords[0] - coords[2], coords[1] - coords[2], coords[2] * 2, coords[2] * 2)
76
+ }
77
+
78
+ if (shape === 'poly' && coords.length > 2) {
79
+ var minX = coords[0]
80
+ var minY = coords[1]
81
+ var maxX = minX
82
+ var maxY = minY
83
+
84
+ for (var index = 2; index + 1 < coords.length; index += 2) {
85
+ minX = Math.min(minX, coords[index])
86
+ maxX = Math.max(maxX, coords[index])
87
+ minY = Math.min(minY, coords[index + 1])
88
+ maxY = Math.max(maxY, coords[index + 1])
89
+ }
90
+
91
+ return createRect(minX, minY, maxX - minX, maxY - minY)
92
+ }
93
+
94
+ return createRect(0, 0, 0, 0)
95
+ }
96
+
97
+ function findImageUsingMap(mapName: string, doc: Document): Element | null {
98
+ // Use querySelector instead of a full-DOM scan; escape the map name so
99
+ // special characters in the CSS attribute value string are handled safely.
100
+ return doc.querySelector('[usemap="#' + mapName.replace(/\\/g, '\\\\').replace(/"/g, '\\"') + '"]')
101
+ }
102
+
103
+ export function maybeFindImageMap(elem: Element, getRect: RectReader = getClientRect): ImageMapResult | null {
104
+ var isMap = isElement(elem, 'MAP')
105
+ if (!isMap && !isElement(elem, 'AREA')) {
106
+ return null
107
+ }
108
+
109
+ var map = isMap ? elem : isElement(elem.parentNode, 'MAP') ? elem.parentNode : null
110
+ var image: Element | null = null
111
+ var rect = createRect(0, 0, 0, 0)
112
+
113
+ if (isElement(map, 'MAP') && (map as HTMLMapElement).name) {
114
+ image = findImageUsingMap((map as HTMLMapElement).name, (map as HTMLMapElement).ownerDocument)
115
+ if (image) {
116
+ rect = getRect(image)
117
+ if (!isMap && isElement(elem, 'AREA') && (elem as HTMLAreaElement).shape.toLowerCase() !== 'default') {
118
+ var relativeRect = getAreaRelativeRect(elem as HTMLAreaElement)
119
+ var relativeX = Math.min(Math.max(relativeRect.left, 0), rect.width)
120
+ var relativeY = Math.min(Math.max(relativeRect.top, 0), rect.height)
121
+ var width = Math.min(relativeRect.width, rect.width - relativeX)
122
+ var height = Math.min(relativeRect.height, rect.height - relativeY)
123
+ rect = createRect(relativeX + rect.left, relativeY + rect.top, width, height)
124
+ }
125
+ }
126
+ }
127
+
128
+ return { image: image, rect: rect }
129
+ }
130
+
131
+ // getRect is threaded through to the image-map lookup so a memoising caller
132
+ // keeps its cache for the <img> an <area> resolves to, not just the <area>.
133
+ export function getClientRect(elem: Element, getRect?: RectReader): Rect {
134
+ var imageMap = maybeFindImageMap(elem, getRect || getClientRect)
135
+ if (imageMap) {
136
+ return imageMap.rect
137
+ }
138
+
139
+ var elemTagName = typeof elem.tagName === 'string' ? elem.tagName : ''
140
+ if (elemTagName.toUpperCase() === 'HTML') {
141
+ var doc = elem.ownerDocument
142
+ // In quirks mode (no DOCTYPE), viewport dimensions come from document.body;
143
+ // documentElement.clientWidth/Height is unreliable and can be 0.
144
+ var sizeElem = doc.compatMode === 'CSS1Compat' ? doc.documentElement : (doc.body || doc.documentElement)
145
+ return createRect(0, 0, sizeElem.clientWidth, sizeElem.clientHeight)
146
+ }
147
+
148
+ try {
149
+ var nativeRect = elem.getBoundingClientRect()
150
+ return {
151
+ left: nativeRect.left,
152
+ top: nativeRect.top,
153
+ right: nativeRect.right,
154
+ bottom: nativeRect.bottom,
155
+ width: nativeRect.right - nativeRect.left,
156
+ height: nativeRect.bottom - nativeRect.top,
157
+ }
158
+ } catch (_error) {
159
+ return createRect(0, 0, 0, 0)
160
+ }
161
+ }
162
+
163
+ // The element's rect, optionally narrowed to a sub-region clamped inside it.
164
+ // Each edge is clamped against the edge computed before it, so a region wider
165
+ // than the element collapses to the element rather than spilling past it --
166
+ // preserve that ordering, it is load-bearing.
167
+ export function getClientRegion(elem: Element, optRegion?: Region, getRect: RectReader = getClientRect): Rect {
168
+ var rect = getRect(elem)
169
+ if (!optRegion) {
170
+ return rect
171
+ }
172
+
173
+ var region = 'left' in optRegion
174
+ ? optRegion
175
+ : { left: optRegion.x, top: optRegion.y, width: 1, height: 1 }
176
+
177
+ var left = clamp(rect.left + region.left, rect.left, rect.right)
178
+ var top = clamp(rect.top + region.top, rect.top, rect.bottom)
179
+ var right = clamp(left + region.width, left, rect.right)
180
+ var bottom = clamp(top + region.height, top, rect.bottom)
181
+
182
+ return createRect(left, top, right - left, bottom - top)
183
+ }
@@ -0,0 +1,336 @@
1
+ // Licensed to the Software Freedom Conservancy (SFC) under one
2
+ // or more contributor license agreements. See the NOTICE file
3
+ // distributed with this work for additional information
4
+ // regarding copyright ownership. The SFC licenses this file
5
+ // to you under the Apache License, Version 2.0 (the
6
+ // "License"); you may not use this file except in compliance
7
+ // with the License. You may obtain a copy of the License at
8
+ //
9
+ // http://www.apache.org/licenses/LICENSE-2.0
10
+ //
11
+ // Unless required by applicable law or agreed to in writing,
12
+ // software distributed under the License is distributed on an
13
+ // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ // KIND, either express or implied. See the License for the
15
+ // specific language governing permissions and limitations
16
+ // under the License.
17
+
18
+ import {
19
+ JAVASCRIPT_ERROR,
20
+ NO_SUCH_WINDOW,
21
+ SCRIPT_TIMEOUT,
22
+ STALE_ELEMENT_REFERENCE,
23
+ UNKNOWN_ERROR,
24
+ botError,
25
+ } from './error.js'
26
+
27
+ // bot.inject: the element cache, the {ELEMENT}/{WINDOW} handle format and the
28
+ // {status, value} response envelope that injected scripts talk through.
29
+ //
30
+ // Statuses are W3C error strings, and success is 'success'. bot.inject sent
31
+ // bot.ErrorCode numbers (0, 10, 28...), the JSON wire protocol's encoding;
32
+ // a consumer that compared against those numbers has to compare strings now.
33
+
34
+ export const ELEMENT_KEY = 'ELEMENT'
35
+ export const WINDOW_KEY = 'WINDOW'
36
+ export const SUCCESS = 'success'
37
+
38
+ // Both live on the document rather than in module state because every atom is
39
+ // a separate bundle with its own module scope: the document is the only thing
40
+ // two injected atoms share. They must stay byte-identical to bot.inject.cache,
41
+ // or an id minted by a Closure atom is stale to a TypeScript one and the
42
+ // reverse, for as long as both kinds are injected into the same page.
43
+ const CACHE_KEY = '$wdc_'
44
+ const ELEMENT_KEY_PREFIX = ':wdc:'
45
+
46
+ export interface Response {
47
+ status: string
48
+ value: unknown
49
+ }
50
+
51
+ type Cacheable = Element | Document | Window
52
+ type Cache = Record<string, unknown> & { nextId: number }
53
+
54
+ function getCache(optDoc?: Document | null): Cache {
55
+ const doc = (optDoc || document) as unknown as Record<string, Cache | undefined>
56
+ let cache = doc[CACHE_KEY]
57
+ if (!cache) {
58
+ // The id counter lives in the cache so it resets whenever the cache does.
59
+ cache = doc[CACHE_KEY] = { nextId: Date.now() } as Cache
60
+ }
61
+ // The original notes nextId sometimes reads back as NaN; reseed rather than
62
+ // mint ':wdc:NaN'.
63
+ if (!cache.nextId) {
64
+ cache.nextId = Date.now()
65
+ }
66
+ return cache
67
+ }
68
+
69
+ // Keyed by the owning document, so a window -- which has no ownerDocument --
70
+ // and a document both land in the current document's cache.
71
+ export function addElement(el: Cacheable): string {
72
+ const cache = getCache((el as Element).ownerDocument)
73
+ for (const key in cache) {
74
+ if (cache[key] == el) {
75
+ return key
76
+ }
77
+ }
78
+ const id = ELEMENT_KEY_PREFIX + cache.nextId++
79
+ cache[id] = el
80
+ return id
81
+ }
82
+
83
+ // Stale rather than no-such-element for an unknown key: the id may have come
84
+ // from a previous document's cache, which is gone after a navigation.
85
+ export function getElement(key: string, optDoc?: Document): Element | Window {
86
+ key = decodeURIComponent(key)
87
+ const doc = optDoc || document
88
+ const cache = getCache(doc)
89
+ // The cache also holds its own id counter, which is not a handle.
90
+ const el = cache[key] as Record<string, unknown> | number | undefined
91
+ if (typeof el !== 'object' || el === null) {
92
+ throw botError(STALE_ELEMENT_REFERENCE, 'Element does not exist in cache')
93
+ }
94
+
95
+ if ('setInterval' in el) {
96
+ if (el['closed']) {
97
+ delete cache[key]
98
+ throw botError(NO_SUCH_WINDOW, 'Window has been closed.')
99
+ }
100
+ return el as unknown as Window
101
+ }
102
+
103
+ // Attached means reachable from the documentElement, stepping out of shadow
104
+ // roots through their host.
105
+ let node = el as unknown as Node | null
106
+ while (node) {
107
+ if (node == doc.documentElement) {
108
+ return el as unknown as Element
109
+ }
110
+ if ((node as ShadowRoot).host && node.nodeType === Node.DOCUMENT_FRAGMENT_NODE) {
111
+ node = (node as ShadowRoot).host
112
+ }
113
+ node = node.parentNode
114
+ }
115
+ delete cache[key]
116
+ throw botError(STALE_ELEMENT_REFERENCE, 'Element is no longer attached to the DOM')
117
+ }
118
+
119
+ function isArrayLike(value: object): value is ArrayLike<unknown> {
120
+ return typeof (value as { length?: unknown }).length == 'number'
121
+ }
122
+
123
+ // Makes a value JSON-safe: elements and documents become {ELEMENT: id},
124
+ // windows {WINDOW: id}, functions their source, undefined null, and other
125
+ // objects are walked keeping only string keys.
126
+ //
127
+ // `seen` is never popped, so an object reached twice through different paths
128
+ // -- not a cycle, just shared -- is reported as recursive too. Inherited from
129
+ // bot.inject.wrapValue; kept because it is what consumers get today.
130
+ export function wrapValue(value: unknown): unknown {
131
+ const seen: object[] = []
132
+ const wrap = (value: unknown): unknown => {
133
+ switch (typeof value) {
134
+ case 'string':
135
+ case 'number':
136
+ case 'boolean':
137
+ return value
138
+ case 'function':
139
+ return value.toString()
140
+ case 'object': {
141
+ if (value === null) {
142
+ return null
143
+ }
144
+ // A real Array is mapped without joining `seen` -- goog.typeOf calls it
145
+ // 'array', not 'object' -- so the same array twice is not "recursive".
146
+ if (Array.isArray(value)) {
147
+ return value.map(wrap)
148
+ }
149
+ if (seen.indexOf(value) >= 0) {
150
+ throw botError(JAVASCRIPT_ERROR, 'Recursive object cannot be transferred')
151
+ }
152
+
153
+ // Duck-typed rather than instanceof, which is false for a node from
154
+ // another frame's realm.
155
+ const nodeType = (value as { nodeType?: unknown }).nodeType
156
+ if ('nodeType' in value && (nodeType == Node.ELEMENT_NODE || nodeType == Node.DOCUMENT_NODE)) {
157
+ return { [ELEMENT_KEY]: addElement(value as Element) }
158
+ }
159
+ if ('document' in value) {
160
+ return { [WINDOW_KEY]: addElement(value as Window) }
161
+ }
162
+
163
+ seen.push(value)
164
+ if (isArrayLike(value)) {
165
+ return Array.prototype.map.call(value, wrap)
166
+ }
167
+ const result: Record<string, unknown> = {}
168
+ for (const key in value) {
169
+ result[key] = wrap((value as Record<string, unknown>)[key])
170
+ }
171
+ return result
172
+ }
173
+ default:
174
+ return null
175
+ }
176
+ }
177
+ return wrap(value)
178
+ }
179
+
180
+ // Resolves {ELEMENT}/{WINDOW} handles against optDoc's cache. Functions pass
181
+ // through untouched so a script can be handed a callback.
182
+ export function unwrapValue(value: unknown, optDoc?: Document): unknown {
183
+ if (Array.isArray(value)) {
184
+ return value.map((v) => unwrapValue(v, optDoc))
185
+ }
186
+ if (typeof value == 'function') {
187
+ return value
188
+ }
189
+ if (value !== null && typeof value == 'object') {
190
+ const obj = value as Record<string, unknown>
191
+ if (ELEMENT_KEY in obj) {
192
+ return getElement(obj[ELEMENT_KEY] as string, optDoc)
193
+ }
194
+ if (WINDOW_KEY in obj) {
195
+ return getElement(obj[WINDOW_KEY] as string, optDoc)
196
+ }
197
+ const result: Record<string, unknown> = {}
198
+ for (const key in obj) {
199
+ result[key] = unwrapValue(obj[key], optDoc)
200
+ }
201
+ return result
202
+ }
203
+ return value
204
+ }
205
+
206
+ export function wrapResponse(value: unknown): Response {
207
+ return { status: SUCCESS, value: wrapValue(value) }
208
+ }
209
+
210
+ // Only a string code is a status. A DOMException carries a legacy numeric
211
+ // `code` (12 for a bad selector), which would otherwise leak through as one.
212
+ export function wrapError(err: unknown): Response {
213
+ const code = (err as { code?: unknown } | null)?.code
214
+ return {
215
+ status: typeof code == 'string' ? code : UNKNOWN_ERROR,
216
+ value: { message: (err as Error | null)?.message },
217
+ }
218
+ }
219
+
220
+ // Compiles `fn` in the target window's realm so that globals it names resolve
221
+ // there. A string is a function body; a function is recompiled from its
222
+ // source, which assumes it closes over nothing outside that window.
223
+ function recompileFunction(fn: Function | string, theWindow: Window): Function {
224
+ const WindowFunction = (theWindow as unknown as { Function: FunctionConstructor }).Function
225
+ if (typeof fn === 'string') {
226
+ return new WindowFunction(fn)
227
+ }
228
+ return theWindow == window ? fn : new WindowFunction('return (' + fn + ').apply(null,arguments);')
229
+ }
230
+
231
+ export function executeScript(
232
+ fn: Function | string,
233
+ args: unknown[],
234
+ optStringify?: boolean,
235
+ optWindow?: Window,
236
+ ): string | Response {
237
+ const win = optWindow || window
238
+ let ret: Response
239
+ try {
240
+ const compiled = recompileFunction(fn, win)
241
+ const unwrappedArgs = unwrapValue(args, win.document) as unknown[]
242
+ ret = wrapResponse(compiled.apply(null, unwrappedArgs))
243
+ } catch (ex) {
244
+ ret = wrapError(ex)
245
+ }
246
+ return optStringify ? JSON.stringify(ret) : ret
247
+ }
248
+
249
+ // The script finishes by calling the callback appended as its last argument.
250
+ // onDone is always called exactly once: with that value, with the error the
251
+ // script threw, on timeout, or when the window unloads underneath it.
252
+ export function executeAsyncScript(
253
+ fn: Function | string,
254
+ args: unknown[],
255
+ timeout: number,
256
+ onDone: (result: string | Response) => void,
257
+ optStringify?: boolean,
258
+ optWindow?: Window,
259
+ ): void {
260
+ const win = optWindow || window
261
+ let timeoutId: number | undefined
262
+ let responseSent = false
263
+
264
+ function onunload(): void {
265
+ sendResponse(
266
+ UNKNOWN_ERROR,
267
+ Error('Detected a page unload event; asynchronous script execution does not work across page loads.'),
268
+ )
269
+ }
270
+
271
+ function sendResponse(status: string, value: unknown): void {
272
+ if (responseSent) {
273
+ return
274
+ }
275
+ // Marked before delivery, so an onDone that throws cannot be followed by
276
+ // the timeout or the unload handler delivering a second response.
277
+ responseSent = true
278
+ win.removeEventListener('unload', onunload, true)
279
+ win.clearTimeout(timeoutId)
280
+ let response: Response
281
+ if (status != SUCCESS) {
282
+ const cause = value as { message?: string; stack?: string }
283
+ const err = botError(status, cause.message || value + '')
284
+ err.stack = cause.stack
285
+ response = wrapError(err)
286
+ } else {
287
+ // A value that cannot be transferred, such as a cyclic object, is the
288
+ // script's error to report, not an exception thrown back into it.
289
+ try {
290
+ response = wrapResponse(value)
291
+ } catch (e) {
292
+ response = wrapError(e)
293
+ }
294
+ }
295
+ onDone(optStringify ? JSON.stringify(response) : response)
296
+ }
297
+
298
+ if (win.closed) {
299
+ sendResponse(UNKNOWN_ERROR, 'Unable to execute script; the target window is closed.')
300
+ return
301
+ }
302
+
303
+ win.addEventListener('unload', onunload, true)
304
+
305
+ const startTime = Date.now()
306
+ // Compiling and unwrapping sit inside the try, as they do in executeScript,
307
+ // so a syntax error or a stale element argument reaches onDone with its own
308
+ // status. bot.inject threw those out of the atom instead.
309
+ try {
310
+ const compiled = recompileFunction(fn, win)
311
+ const unwrappedArgs = unwrapValue(args, win.document) as unknown[]
312
+ unwrappedArgs.push((value: unknown) => sendResponse(SUCCESS, value))
313
+ compiled.apply(win, unwrappedArgs)
314
+
315
+ // Armed after the call, so a script that calls back from a zero-length
316
+ // timer is not beaten to it by its own timeout -- and not at all if it
317
+ // already called back, or the timer would outlive the call for nothing.
318
+ if (!responseSent) {
319
+ timeoutId = win.setTimeout(() => {
320
+ sendResponse(
321
+ SCRIPT_TIMEOUT,
322
+ Error('Timed out waiting for asynchronous script result after ' + (Date.now() - startTime) + ' ms'),
323
+ )
324
+ }, Math.max(0, timeout))
325
+ }
326
+ } catch (ex) {
327
+ const code = (ex as { code?: unknown }).code
328
+ sendResponse(typeof code == 'string' ? code : UNKNOWN_ERROR, ex)
329
+ }
330
+ }
331
+
332
+ // webdriver.atoms.inject.getWindow: the window named by a {WINDOW: id} handle,
333
+ // or the current one.
334
+ export function getWindow(optWindow?: { [WINDOW_KEY]: string }): Window {
335
+ return optWindow ? (getElement(optWindow[WINDOW_KEY]) as Window) : window
336
+ }
@@ -0,0 +1,30 @@
1
+ // Licensed to the Software Freedom Conservancy (SFC) under one
2
+ // or more contributor license agreements. See the NOTICE file
3
+ // distributed with this work for additional information
4
+ // regarding copyright ownership. The SFC licenses this file
5
+ // to you under the Apache License, Version 2.0 (the
6
+ // "License"); you may not use this file except in compliance
7
+ // with the License. You may obtain a copy of the License at
8
+ //
9
+ // http://www.apache.org/licenses/LICENSE-2.0
10
+ //
11
+ // Unless required by applicable law or agreed to in writing,
12
+ // software distributed under the License is distributed on an
13
+ // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ // KIND, either express or implied. See the License for the
15
+ // specific language governing permissions and limitations
16
+ // under the License.
17
+
18
+ import { isEnabled } from './enabled.js'
19
+ import isShown from './shown.js'
20
+ import { getEffectiveStyle } from './style.js'
21
+
22
+ // Opacity is ignored deliberately: a fully transparent control still takes
23
+ // clicks, so it is interactable even though it is not displayed.
24
+ export function isInteractable(element: Element): boolean {
25
+ return (
26
+ isShown(element, /* optIgnoreOpacity= */ true) &&
27
+ isEnabled(element) &&
28
+ getEffectiveStyle(element, 'pointer-events') !== 'none'
29
+ )
30
+ }