@wdio/image-comparison-core 1.0.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 (416) hide show
  1. package/CHANGELOG.md +82 -0
  2. package/LICENSE +21 -0
  3. package/README.md +12 -0
  4. package/assets/ios/ipadair4th.ipadair5th-bottom.png +0 -0
  5. package/assets/ios/ipadair4th.ipadair5th-top.png +0 -0
  6. package/assets/ios/ipadmini6th-bottom.png +0 -0
  7. package/assets/ios/ipadmini6th-top.png +0 -0
  8. package/assets/ios/ipadpro11-bottom.png +0 -0
  9. package/assets/ios/ipadpro11-top.png +0 -0
  10. package/assets/ios/ipadpro129-bottom.png +0 -0
  11. package/assets/ios/ipadpro129-top.png +0 -0
  12. package/assets/ios/iphone11promax-bottom.png +0 -0
  13. package/assets/ios/iphone11promax-top.png +0 -0
  14. package/assets/ios/iphone12.iphone12pro-top.png +0 -0
  15. package/assets/ios/iphone12.iphone12pro.iphone13.iphone13pro.iphone14-bottom.png +0 -0
  16. package/assets/ios/iphone12mini-top.png +0 -0
  17. package/assets/ios/iphone12mini.iphone13mini-bottom.png +0 -0
  18. package/assets/ios/iphone12promax-top.png +0 -0
  19. package/assets/ios/iphone12promax.iphone13promax.iphone14plus-bottom.png +0 -0
  20. package/assets/ios/iphone13.iphone13pro.iphone14-top.png +0 -0
  21. package/assets/ios/iphone13mini-top.png +0 -0
  22. package/assets/ios/iphone13promax.iphone14plus-top.png +0 -0
  23. package/assets/ios/iphone14pro-bottom.png +0 -0
  24. package/assets/ios/iphone14pro-top.png +0 -0
  25. package/assets/ios/iphone14promax-bottom.png +0 -0
  26. package/assets/ios/iphone14promax-top.png +0 -0
  27. package/assets/ios/iphone15-bottom.png +0 -0
  28. package/assets/ios/iphone15-top.png +0 -0
  29. package/assets/ios/iphonex.iphonexs.iphone11pro-bottom.png +0 -0
  30. package/assets/ios/iphonex.iphonexs.iphone11pro-top.png +0 -0
  31. package/assets/ios/iphonexr.iphone11-bottom.png +0 -0
  32. package/assets/ios/iphonexr.iphone11-top.png +0 -0
  33. package/assets/ios/iphonexsmax-bottom.png +0 -0
  34. package/assets/ios/iphonexsmax-top.png +0 -0
  35. package/dist/base.d.ts +18 -0
  36. package/dist/base.d.ts.map +1 -0
  37. package/dist/base.interfaces.d.ts +200 -0
  38. package/dist/base.interfaces.d.ts.map +1 -0
  39. package/dist/base.interfaces.js +1 -0
  40. package/dist/base.js +58 -0
  41. package/dist/base.test.d.ts +2 -0
  42. package/dist/base.test.d.ts.map +1 -0
  43. package/dist/base.test.js +45 -0
  44. package/dist/clientSideScripts/checkMetaTag.d.ts +2 -0
  45. package/dist/clientSideScripts/checkMetaTag.d.ts.map +1 -0
  46. package/dist/clientSideScripts/checkMetaTag.js +9 -0
  47. package/dist/clientSideScripts/checkMetaTag.test.d.ts +2 -0
  48. package/dist/clientSideScripts/checkMetaTag.test.d.ts.map +1 -0
  49. package/dist/clientSideScripts/checkMetaTag.test.js +25 -0
  50. package/dist/clientSideScripts/customCss.interfaces.d.ts +8 -0
  51. package/dist/clientSideScripts/customCss.interfaces.d.ts.map +1 -0
  52. package/dist/clientSideScripts/customCss.interfaces.js +1 -0
  53. package/dist/clientSideScripts/drawTabbableOnCanvas.d.ts +8 -0
  54. package/dist/clientSideScripts/drawTabbableOnCanvas.d.ts.map +1 -0
  55. package/dist/clientSideScripts/drawTabbableOnCanvas.interfaces.d.ts +4 -0
  56. package/dist/clientSideScripts/drawTabbableOnCanvas.interfaces.d.ts.map +1 -0
  57. package/dist/clientSideScripts/drawTabbableOnCanvas.interfaces.js +1 -0
  58. package/dist/clientSideScripts/drawTabbableOnCanvas.js +275 -0
  59. package/dist/clientSideScripts/drawTabbableOnCanvas.test.d.ts +2 -0
  60. package/dist/clientSideScripts/drawTabbableOnCanvas.test.d.ts.map +1 -0
  61. package/dist/clientSideScripts/drawTabbableOnCanvas.test.js +251 -0
  62. package/dist/clientSideScripts/elementPosition.interfaces.d.ts +3 -0
  63. package/dist/clientSideScripts/elementPosition.interfaces.d.ts.map +1 -0
  64. package/dist/clientSideScripts/elementPosition.interfaces.js +1 -0
  65. package/dist/clientSideScripts/getBoundingClientRect.d.ts +6 -0
  66. package/dist/clientSideScripts/getBoundingClientRect.d.ts.map +1 -0
  67. package/dist/clientSideScripts/getBoundingClientRect.js +12 -0
  68. package/dist/clientSideScripts/getBoundingClientRect.test.d.ts +2 -0
  69. package/dist/clientSideScripts/getBoundingClientRect.test.d.ts.map +1 -0
  70. package/dist/clientSideScripts/getBoundingClientRect.test.js +28 -0
  71. package/dist/clientSideScripts/getDocumentScrollHeight.d.ts +5 -0
  72. package/dist/clientSideScripts/getDocumentScrollHeight.d.ts.map +1 -0
  73. package/dist/clientSideScripts/getDocumentScrollHeight.js +48 -0
  74. package/dist/clientSideScripts/getDocumentScrollHeight.test.d.ts +2 -0
  75. package/dist/clientSideScripts/getDocumentScrollHeight.test.d.ts.map +1 -0
  76. package/dist/clientSideScripts/getDocumentScrollHeight.test.js +30 -0
  77. package/dist/clientSideScripts/getElementPositionTopDom.d.ts +6 -0
  78. package/dist/clientSideScripts/getElementPositionTopDom.d.ts.map +1 -0
  79. package/dist/clientSideScripts/getElementPositionTopDom.js +11 -0
  80. package/dist/clientSideScripts/getElementPositionTopDom.test.d.ts +2 -0
  81. package/dist/clientSideScripts/getElementPositionTopDom.test.d.ts.map +1 -0
  82. package/dist/clientSideScripts/getElementPositionTopDom.test.js +11 -0
  83. package/dist/clientSideScripts/getElementPositionTopScreenNativeMobile.d.ts +14 -0
  84. package/dist/clientSideScripts/getElementPositionTopScreenNativeMobile.d.ts.map +1 -0
  85. package/dist/clientSideScripts/getElementPositionTopScreenNativeMobile.js +19 -0
  86. package/dist/clientSideScripts/getElementPositionTopScreenNativeMobile.test.d.ts +2 -0
  87. package/dist/clientSideScripts/getElementPositionTopScreenNativeMobile.test.d.ts.map +1 -0
  88. package/dist/clientSideScripts/getElementPositionTopScreenNativeMobile.test.js +52 -0
  89. package/dist/clientSideScripts/getMobileWebviewClickAndDimensions.d.ts +6 -0
  90. package/dist/clientSideScripts/getMobileWebviewClickAndDimensions.d.ts.map +1 -0
  91. package/dist/clientSideScripts/getMobileWebviewClickAndDimensions.js +17 -0
  92. package/dist/clientSideScripts/getMobileWebviewClickAndDimensions.test.d.ts +2 -0
  93. package/dist/clientSideScripts/getMobileWebviewClickAndDimensions.test.d.ts.map +1 -0
  94. package/dist/clientSideScripts/getMobileWebviewClickAndDimensions.test.js +47 -0
  95. package/dist/clientSideScripts/getScreenDimensions.d.ts +6 -0
  96. package/dist/clientSideScripts/getScreenDimensions.d.ts.map +1 -0
  97. package/dist/clientSideScripts/getScreenDimensions.js +104 -0
  98. package/dist/clientSideScripts/getScreenDimensions.test.d.ts +2 -0
  99. package/dist/clientSideScripts/getScreenDimensions.test.d.ts.map +1 -0
  100. package/dist/clientSideScripts/getScreenDimensions.test.js +161 -0
  101. package/dist/clientSideScripts/hideRemoveElements.d.ts +8 -0
  102. package/dist/clientSideScripts/hideRemoveElements.d.ts.map +1 -0
  103. package/dist/clientSideScripts/hideRemoveElements.js +60 -0
  104. package/dist/clientSideScripts/hideRemoveElements.test.d.ts +2 -0
  105. package/dist/clientSideScripts/hideRemoveElements.test.d.ts.map +1 -0
  106. package/dist/clientSideScripts/hideRemoveElements.test.js +199 -0
  107. package/dist/clientSideScripts/hideScrollbars.d.ts +9 -0
  108. package/dist/clientSideScripts/hideScrollbars.d.ts.map +1 -0
  109. package/dist/clientSideScripts/hideScrollbars.js +15 -0
  110. package/dist/clientSideScripts/hideScrollbars.test.d.ts +2 -0
  111. package/dist/clientSideScripts/hideScrollbars.test.d.ts.map +1 -0
  112. package/dist/clientSideScripts/hideScrollbars.test.js +12 -0
  113. package/dist/clientSideScripts/injectWebviewOverlay.d.ts +5 -0
  114. package/dist/clientSideScripts/injectWebviewOverlay.d.ts.map +1 -0
  115. package/dist/clientSideScripts/injectWebviewOverlay.js +35 -0
  116. package/dist/clientSideScripts/injectWebviewOverlay.test.d.ts +2 -0
  117. package/dist/clientSideScripts/injectWebviewOverlay.test.d.ts.map +1 -0
  118. package/dist/clientSideScripts/injectWebviewOverlay.test.js +74 -0
  119. package/dist/clientSideScripts/removeElementFromDom.d.ts +5 -0
  120. package/dist/clientSideScripts/removeElementFromDom.d.ts.map +1 -0
  121. package/dist/clientSideScripts/removeElementFromDom.js +9 -0
  122. package/dist/clientSideScripts/removeElementFromDom.test.d.ts +2 -0
  123. package/dist/clientSideScripts/removeElementFromDom.test.d.ts.map +1 -0
  124. package/dist/clientSideScripts/removeElementFromDom.test.js +43 -0
  125. package/dist/clientSideScripts/screenDimensions.interfaces.d.ts +96 -0
  126. package/dist/clientSideScripts/screenDimensions.interfaces.d.ts.map +1 -0
  127. package/dist/clientSideScripts/screenDimensions.interfaces.js +1 -0
  128. package/dist/clientSideScripts/scrollElementIntoView.d.ts +5 -0
  129. package/dist/clientSideScripts/scrollElementIntoView.d.ts.map +1 -0
  130. package/dist/clientSideScripts/scrollElementIntoView.js +31 -0
  131. package/dist/clientSideScripts/scrollElementIntoView.test.d.ts +2 -0
  132. package/dist/clientSideScripts/scrollElementIntoView.test.d.ts.map +1 -0
  133. package/dist/clientSideScripts/scrollElementIntoView.test.js +79 -0
  134. package/dist/clientSideScripts/scrollToPosition.d.ts +5 -0
  135. package/dist/clientSideScripts/scrollToPosition.d.ts.map +1 -0
  136. package/dist/clientSideScripts/scrollToPosition.js +25 -0
  137. package/dist/clientSideScripts/scrollToPosition.test.d.ts +2 -0
  138. package/dist/clientSideScripts/scrollToPosition.test.d.ts.map +1 -0
  139. package/dist/clientSideScripts/scrollToPosition.test.js +72 -0
  140. package/dist/clientSideScripts/setCustomCss.d.ts +6 -0
  141. package/dist/clientSideScripts/setCustomCss.d.ts.map +1 -0
  142. package/dist/clientSideScripts/setCustomCss.js +36 -0
  143. package/dist/clientSideScripts/setCustomCss.test.d.ts +2 -0
  144. package/dist/clientSideScripts/setCustomCss.test.d.ts.map +1 -0
  145. package/dist/clientSideScripts/setCustomCss.test.js +68 -0
  146. package/dist/clientSideScripts/statusAddressToolBarOffsets.interfaces.d.ts +11 -0
  147. package/dist/clientSideScripts/statusAddressToolBarOffsets.interfaces.d.ts.map +1 -0
  148. package/dist/clientSideScripts/statusAddressToolBarOffsets.interfaces.js +1 -0
  149. package/dist/clientSideScripts/toggleTextTransparency.d.ts +5 -0
  150. package/dist/clientSideScripts/toggleTextTransparency.d.ts.map +1 -0
  151. package/dist/clientSideScripts/toggleTextTransparency.js +16 -0
  152. package/dist/clientSideScripts/toggleTextTransparency.test.d.ts +2 -0
  153. package/dist/clientSideScripts/toggleTextTransparency.test.d.ts.map +1 -0
  154. package/dist/clientSideScripts/toggleTextTransparency.test.js +35 -0
  155. package/dist/clientSideScripts/waitForFonts.d.ts +8 -0
  156. package/dist/clientSideScripts/waitForFonts.d.ts.map +1 -0
  157. package/dist/clientSideScripts/waitForFonts.js +20 -0
  158. package/dist/clientSideScripts/waitForFonts.test.d.ts +2 -0
  159. package/dist/clientSideScripts/waitForFonts.test.d.ts.map +1 -0
  160. package/dist/clientSideScripts/waitForFonts.test.js +37 -0
  161. package/dist/commands/check.interfaces.d.ts +35 -0
  162. package/dist/commands/check.interfaces.d.ts.map +1 -0
  163. package/dist/commands/check.interfaces.js +1 -0
  164. package/dist/commands/checkAppElement.d.ts +7 -0
  165. package/dist/commands/checkAppElement.d.ts.map +1 -0
  166. package/dist/commands/checkAppElement.js +44 -0
  167. package/dist/commands/checkAppElement.test.d.ts +2 -0
  168. package/dist/commands/checkAppElement.test.d.ts.map +1 -0
  169. package/dist/commands/checkAppElement.test.js +241 -0
  170. package/dist/commands/checkAppScreen.d.ts +7 -0
  171. package/dist/commands/checkAppScreen.d.ts.map +1 -0
  172. package/dist/commands/checkAppScreen.js +73 -0
  173. package/dist/commands/checkAppScreen.test.d.ts +2 -0
  174. package/dist/commands/checkAppScreen.test.d.ts.map +1 -0
  175. package/dist/commands/checkAppScreen.test.js +295 -0
  176. package/dist/commands/checkElement.d.ts +7 -0
  177. package/dist/commands/checkElement.d.ts.map +1 -0
  178. package/dist/commands/checkElement.js +10 -0
  179. package/dist/commands/checkElement.test.d.ts +2 -0
  180. package/dist/commands/checkElement.test.d.ts.map +1 -0
  181. package/dist/commands/checkElement.test.js +66 -0
  182. package/dist/commands/checkFullPageScreen.d.ts +7 -0
  183. package/dist/commands/checkFullPageScreen.d.ts.map +1 -0
  184. package/dist/commands/checkFullPageScreen.js +56 -0
  185. package/dist/commands/checkFullPageScreen.test.d.ts +2 -0
  186. package/dist/commands/checkFullPageScreen.test.d.ts.map +1 -0
  187. package/dist/commands/checkFullPageScreen.test.js +259 -0
  188. package/dist/commands/checkScreen.d.ts +7 -0
  189. package/dist/commands/checkScreen.d.ts.map +1 -0
  190. package/dist/commands/checkScreen.js +10 -0
  191. package/dist/commands/checkScreen.test.d.ts +2 -0
  192. package/dist/commands/checkScreen.test.d.ts.map +1 -0
  193. package/dist/commands/checkScreen.test.js +62 -0
  194. package/dist/commands/checkTabbablePage.d.ts +7 -0
  195. package/dist/commands/checkTabbablePage.d.ts.map +1 -0
  196. package/dist/commands/checkTabbablePage.js +28 -0
  197. package/dist/commands/checkTabbablePage.test.d.ts +2 -0
  198. package/dist/commands/checkTabbablePage.test.d.ts.map +1 -0
  199. package/dist/commands/checkTabbablePage.test.js +200 -0
  200. package/dist/commands/checkWebElement.d.ts +7 -0
  201. package/dist/commands/checkWebElement.d.ts.map +1 -0
  202. package/dist/commands/checkWebElement.js +52 -0
  203. package/dist/commands/checkWebElement.test.d.ts +2 -0
  204. package/dist/commands/checkWebElement.test.d.ts.map +1 -0
  205. package/dist/commands/checkWebElement.test.js +278 -0
  206. package/dist/commands/checkWebScreen.d.ts +7 -0
  207. package/dist/commands/checkWebScreen.d.ts.map +1 -0
  208. package/dist/commands/checkWebScreen.js +50 -0
  209. package/dist/commands/checkWebScreen.test.d.ts +2 -0
  210. package/dist/commands/checkWebScreen.test.d.ts.map +1 -0
  211. package/dist/commands/checkWebScreen.test.js +227 -0
  212. package/dist/commands/element.interfaces.d.ts +27 -0
  213. package/dist/commands/element.interfaces.d.ts.map +1 -0
  214. package/dist/commands/element.interfaces.js +1 -0
  215. package/dist/commands/fullPage.interfaces.d.ts +38 -0
  216. package/dist/commands/fullPage.interfaces.d.ts.map +1 -0
  217. package/dist/commands/fullPage.interfaces.js +1 -0
  218. package/dist/commands/save.interfaces.d.ts +27 -0
  219. package/dist/commands/save.interfaces.d.ts.map +1 -0
  220. package/dist/commands/save.interfaces.js +1 -0
  221. package/dist/commands/saveAppElement.d.ts +7 -0
  222. package/dist/commands/saveAppElement.d.ts.map +1 -0
  223. package/dist/commands/saveAppElement.js +30 -0
  224. package/dist/commands/saveAppElement.test.d.ts +2 -0
  225. package/dist/commands/saveAppElement.test.d.ts.map +1 -0
  226. package/dist/commands/saveAppElement.test.js +199 -0
  227. package/dist/commands/saveAppScreen.d.ts +7 -0
  228. package/dist/commands/saveAppScreen.d.ts.map +1 -0
  229. package/dist/commands/saveAppScreen.js +43 -0
  230. package/dist/commands/saveAppScreen.test.d.ts +2 -0
  231. package/dist/commands/saveAppScreen.test.d.ts.map +1 -0
  232. package/dist/commands/saveAppScreen.test.js +221 -0
  233. package/dist/commands/saveElement.d.ts +7 -0
  234. package/dist/commands/saveElement.d.ts.map +1 -0
  235. package/dist/commands/saveElement.js +10 -0
  236. package/dist/commands/saveElement.test.d.ts +2 -0
  237. package/dist/commands/saveElement.test.d.ts.map +1 -0
  238. package/dist/commands/saveElement.test.js +62 -0
  239. package/dist/commands/saveFullPageScreen.d.ts +7 -0
  240. package/dist/commands/saveFullPageScreen.d.ts.map +1 -0
  241. package/dist/commands/saveFullPageScreen.js +60 -0
  242. package/dist/commands/saveFullPageScreen.test.d.ts +2 -0
  243. package/dist/commands/saveFullPageScreen.test.d.ts.map +1 -0
  244. package/dist/commands/saveFullPageScreen.test.js +293 -0
  245. package/dist/commands/saveScreen.d.ts +7 -0
  246. package/dist/commands/saveScreen.d.ts.map +1 -0
  247. package/dist/commands/saveScreen.js +10 -0
  248. package/dist/commands/saveScreen.test.d.ts +2 -0
  249. package/dist/commands/saveScreen.test.d.ts.map +1 -0
  250. package/dist/commands/saveScreen.test.js +47 -0
  251. package/dist/commands/saveTabbablePage.d.ts +7 -0
  252. package/dist/commands/saveTabbablePage.d.ts.map +1 -0
  253. package/dist/commands/saveTabbablePage.js +20 -0
  254. package/dist/commands/saveTabbablePage.test.d.ts +2 -0
  255. package/dist/commands/saveTabbablePage.test.d.ts.map +1 -0
  256. package/dist/commands/saveTabbablePage.test.js +74 -0
  257. package/dist/commands/saveWebElement.d.ts +7 -0
  258. package/dist/commands/saveWebElement.d.ts.map +1 -0
  259. package/dist/commands/saveWebElement.js +53 -0
  260. package/dist/commands/saveWebElement.test.d.ts +2 -0
  261. package/dist/commands/saveWebElement.test.d.ts.map +1 -0
  262. package/dist/commands/saveWebElement.test.js +253 -0
  263. package/dist/commands/saveWebScreen.d.ts +7 -0
  264. package/dist/commands/saveWebScreen.d.ts.map +1 -0
  265. package/dist/commands/saveWebScreen.js +48 -0
  266. package/dist/commands/saveWebScreen.test.d.ts +2 -0
  267. package/dist/commands/saveWebScreen.test.d.ts.map +1 -0
  268. package/dist/commands/saveWebScreen.test.js +222 -0
  269. package/dist/commands/screen.interfaces.d.ts +16 -0
  270. package/dist/commands/screen.interfaces.d.ts.map +1 -0
  271. package/dist/commands/screen.interfaces.js +1 -0
  272. package/dist/commands/tabbable.interfaces.d.ts +29 -0
  273. package/dist/commands/tabbable.interfaces.d.ts.map +1 -0
  274. package/dist/commands/tabbable.interfaces.js +1 -0
  275. package/dist/helpers/afterScreenshot.d.ts +7 -0
  276. package/dist/helpers/afterScreenshot.d.ts.map +1 -0
  277. package/dist/helpers/afterScreenshot.interfaces.d.ts +46 -0
  278. package/dist/helpers/afterScreenshot.interfaces.d.ts.map +1 -0
  279. package/dist/helpers/afterScreenshot.interfaces.js +1 -0
  280. package/dist/helpers/afterScreenshot.js +55 -0
  281. package/dist/helpers/afterScreenshot.test.d.ts +2 -0
  282. package/dist/helpers/afterScreenshot.test.d.ts.map +1 -0
  283. package/dist/helpers/afterScreenshot.test.js +241 -0
  284. package/dist/helpers/beforeScreenshot.d.ts +6 -0
  285. package/dist/helpers/beforeScreenshot.d.ts.map +1 -0
  286. package/dist/helpers/beforeScreenshot.interfaces.d.ts +15 -0
  287. package/dist/helpers/beforeScreenshot.interfaces.d.ts.map +1 -0
  288. package/dist/helpers/beforeScreenshot.interfaces.js +1 -0
  289. package/dist/helpers/beforeScreenshot.js +79 -0
  290. package/dist/helpers/beforeScreenshot.test.d.ts +2 -0
  291. package/dist/helpers/beforeScreenshot.test.d.ts.map +1 -0
  292. package/dist/helpers/beforeScreenshot.test.js +261 -0
  293. package/dist/helpers/compare.interfaces.d.ts +16 -0
  294. package/dist/helpers/compare.interfaces.d.ts.map +1 -0
  295. package/dist/helpers/compare.interfaces.js +1 -0
  296. package/dist/helpers/constants.d.ts +108 -0
  297. package/dist/helpers/constants.d.ts.map +1 -0
  298. package/dist/helpers/constants.interfaces.d.ts +30 -0
  299. package/dist/helpers/constants.interfaces.d.ts.map +1 -0
  300. package/dist/helpers/constants.interfaces.js +11 -0
  301. package/dist/helpers/constants.js +436 -0
  302. package/dist/helpers/options.d.ts +64 -0
  303. package/dist/helpers/options.d.ts.map +1 -0
  304. package/dist/helpers/options.interfaces.d.ts +363 -0
  305. package/dist/helpers/options.interfaces.d.ts.map +1 -0
  306. package/dist/helpers/options.interfaces.js +1 -0
  307. package/dist/helpers/options.js +184 -0
  308. package/dist/helpers/options.test.d.ts +2 -0
  309. package/dist/helpers/options.test.d.ts.map +1 -0
  310. package/dist/helpers/options.test.js +428 -0
  311. package/dist/helpers/utils.d.ts +134 -0
  312. package/dist/helpers/utils.d.ts.map +1 -0
  313. package/dist/helpers/utils.interfaces.d.ts +254 -0
  314. package/dist/helpers/utils.interfaces.d.ts.map +1 -0
  315. package/dist/helpers/utils.interfaces.js +1 -0
  316. package/dist/helpers/utils.js +566 -0
  317. package/dist/helpers/utils.test.d.ts +2 -0
  318. package/dist/helpers/utils.test.d.ts.map +1 -0
  319. package/dist/helpers/utils.test.js +900 -0
  320. package/dist/index.d.ts +26 -0
  321. package/dist/index.d.ts.map +1 -0
  322. package/dist/index.js +18 -0
  323. package/dist/methods/compareReport.interfaces.d.ts +109 -0
  324. package/dist/methods/compareReport.interfaces.d.ts.map +1 -0
  325. package/dist/methods/compareReport.interfaces.js +1 -0
  326. package/dist/methods/createCompareReport.d.ts +7 -0
  327. package/dist/methods/createCompareReport.d.ts.map +1 -0
  328. package/dist/methods/createCompareReport.js +61 -0
  329. package/dist/methods/createCompareReport.test.d.ts +2 -0
  330. package/dist/methods/createCompareReport.test.d.ts.map +1 -0
  331. package/dist/methods/createCompareReport.test.js +236 -0
  332. package/dist/methods/elementPosition.d.ts +18 -0
  333. package/dist/methods/elementPosition.d.ts.map +1 -0
  334. package/dist/methods/elementPosition.interfaces.d.ts +14 -0
  335. package/dist/methods/elementPosition.interfaces.d.ts.map +1 -0
  336. package/dist/methods/elementPosition.interfaces.js +1 -0
  337. package/dist/methods/elementPosition.js +34 -0
  338. package/dist/methods/images.d.ts +69 -0
  339. package/dist/methods/images.d.ts.map +1 -0
  340. package/dist/methods/images.executeImageCompare.test.d.ts +2 -0
  341. package/dist/methods/images.executeImageCompare.test.d.ts.map +1 -0
  342. package/dist/methods/images.executeImageCompare.test.js +770 -0
  343. package/dist/methods/images.interfaces.d.ts +214 -0
  344. package/dist/methods/images.interfaces.d.ts.map +1 -0
  345. package/dist/methods/images.interfaces.js +1 -0
  346. package/dist/methods/images.js +428 -0
  347. package/dist/methods/images.test.d.ts +2 -0
  348. package/dist/methods/images.test.d.ts.map +1 -0
  349. package/dist/methods/images.test.js +1465 -0
  350. package/dist/methods/instanceData.d.ts +6 -0
  351. package/dist/methods/instanceData.d.ts.map +1 -0
  352. package/dist/methods/instanceData.interfaces.d.ts +57 -0
  353. package/dist/methods/instanceData.interfaces.d.ts.map +1 -0
  354. package/dist/methods/instanceData.interfaces.js +1 -0
  355. package/dist/methods/instanceData.js +42 -0
  356. package/dist/methods/instanceData.test.d.ts +2 -0
  357. package/dist/methods/instanceData.test.d.ts.map +1 -0
  358. package/dist/methods/instanceData.test.js +224 -0
  359. package/dist/methods/processDiffPixels.d.ts +59 -0
  360. package/dist/methods/processDiffPixels.d.ts.map +1 -0
  361. package/dist/methods/processDiffPixels.js +242 -0
  362. package/dist/methods/processDiffPixels.test.d.ts +2 -0
  363. package/dist/methods/processDiffPixels.test.d.ts.map +1 -0
  364. package/dist/methods/processDiffPixels.test.js +122 -0
  365. package/dist/methods/rectangles.d.ts +51 -0
  366. package/dist/methods/rectangles.d.ts.map +1 -0
  367. package/dist/methods/rectangles.interfaces.d.ts +146 -0
  368. package/dist/methods/rectangles.interfaces.d.ts.map +1 -0
  369. package/dist/methods/rectangles.interfaces.js +1 -0
  370. package/dist/methods/rectangles.js +266 -0
  371. package/dist/methods/rectangles.test.d.ts +2 -0
  372. package/dist/methods/rectangles.test.d.ts.map +1 -0
  373. package/dist/methods/rectangles.test.js +853 -0
  374. package/dist/methods/screenshots.d.ts +37 -0
  375. package/dist/methods/screenshots.d.ts.map +1 -0
  376. package/dist/methods/screenshots.interfaces.d.ts +203 -0
  377. package/dist/methods/screenshots.interfaces.d.ts.map +1 -0
  378. package/dist/methods/screenshots.interfaces.js +1 -0
  379. package/dist/methods/screenshots.js +394 -0
  380. package/dist/methods/screenshots.test.d.ts +2 -0
  381. package/dist/methods/screenshots.test.d.ts.map +1 -0
  382. package/dist/methods/screenshots.test.js +656 -0
  383. package/dist/methods/takeElementScreenshots.d.ts +3 -0
  384. package/dist/methods/takeElementScreenshots.d.ts.map +1 -0
  385. package/dist/methods/takeElementScreenshots.js +104 -0
  386. package/dist/methods/takeElementScreenshots.test.d.ts +2 -0
  387. package/dist/methods/takeElementScreenshots.test.d.ts.map +1 -0
  388. package/dist/methods/takeElementScreenshots.test.js +314 -0
  389. package/dist/methods/takeFullPageScreenshots.d.ts +3 -0
  390. package/dist/methods/takeFullPageScreenshots.d.ts.map +1 -0
  391. package/dist/methods/takeFullPageScreenshots.js +56 -0
  392. package/dist/methods/takeFullPageScreenshots.test.d.ts +2 -0
  393. package/dist/methods/takeFullPageScreenshots.test.d.ts.map +1 -0
  394. package/dist/methods/takeFullPageScreenshots.test.js +72 -0
  395. package/dist/methods/takeWebScreenshots.d.ts +3 -0
  396. package/dist/methods/takeWebScreenshots.d.ts.map +1 -0
  397. package/dist/methods/takeWebScreenshots.js +41 -0
  398. package/dist/methods/takeWebScreenshots.test.d.ts +2 -0
  399. package/dist/methods/takeWebScreenshots.test.d.ts.map +1 -0
  400. package/dist/methods/takeWebScreenshots.test.js +149 -0
  401. package/dist/mocks/image.d.ts +4 -0
  402. package/dist/mocks/image.d.ts.map +1 -0
  403. package/dist/mocks/image.js +3 -0
  404. package/dist/mocks/mocks.d.ts +745 -0
  405. package/dist/mocks/mocks.d.ts.map +1 -0
  406. package/dist/mocks/mocks.js +392 -0
  407. package/dist/resemble/compare.interfaces.d.ts +136 -0
  408. package/dist/resemble/compare.interfaces.d.ts.map +1 -0
  409. package/dist/resemble/compare.interfaces.js +1 -0
  410. package/dist/resemble/compareImages.d.ts +3 -0
  411. package/dist/resemble/compareImages.d.ts.map +1 -0
  412. package/dist/resemble/compareImages.js +21 -0
  413. package/dist/resemble/resemble.jimp.cjs +981 -0
  414. package/dist/resemble/resemble.jimp.d.cts +46 -0
  415. package/dist/resemble/resemble.jimp.d.cts.map +1 -0
  416. package/package.json +47 -0
@@ -0,0 +1,293 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
2
+ import saveFullPageScreen from './saveFullPageScreen.js';
3
+ import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js';
4
+ import { takeFullPageScreenshots } from '../methods/takeFullPageScreenshots.js';
5
+ import { makeFullPageBase64Image } from '../methods/images.js';
6
+ import afterScreenshot from '../helpers/afterScreenshot.js';
7
+ import beforeScreenshot from '../helpers/beforeScreenshot.js';
8
+ import { BASE_CHECK_OPTIONS, createMethodOptions } from '../mocks/mocks.js';
9
+ import { canUseBidiScreenshot } from '../helpers/utils.js';
10
+ vi.mock('../helpers/beforeScreenshot.js', () => ({
11
+ default: vi.fn().mockResolvedValue({
12
+ browserName: 'chrome',
13
+ browserVersion: '120.0.0',
14
+ deviceName: 'desktop',
15
+ dimensions: {
16
+ window: {
17
+ devicePixelRatio: 2,
18
+ innerHeight: 900,
19
+ isEmulated: false,
20
+ isLandscape: false,
21
+ outerHeight: 1000,
22
+ outerWidth: 1200,
23
+ screenHeight: 1080,
24
+ screenWidth: 1920,
25
+ },
26
+ },
27
+ isAndroid: false,
28
+ isAndroidChromeDriverScreenshot: false,
29
+ isAndroidNativeWebScreenshot: false,
30
+ isIOS: false,
31
+ isMobile: false,
32
+ isTestInBrowser: true,
33
+ logName: 'chrome',
34
+ name: 'chrome',
35
+ platformName: 'desktop',
36
+ platformVersion: '120.0.0',
37
+ })
38
+ }));
39
+ vi.mock('../methods/takeFullPageScreenshots.js', () => ({
40
+ takeFullPageScreenshots: vi.fn().mockResolvedValue({
41
+ fullPageHeight: 2000,
42
+ fullPageWidth: 1200,
43
+ data: [{
44
+ canvasWidth: 1200,
45
+ canvasYPosition: 0,
46
+ imageHeight: 2000,
47
+ imageWidth: 1200,
48
+ imageXPosition: 0,
49
+ imageYPosition: 0,
50
+ screenshot: 'test-screenshot-data',
51
+ }]
52
+ })
53
+ }));
54
+ vi.mock('../methods/images.js', () => ({
55
+ makeFullPageBase64Image: vi.fn().mockResolvedValue('fullpage-screenshot-data')
56
+ }));
57
+ vi.mock('../helpers/afterScreenshot.js', () => ({
58
+ default: vi.fn().mockResolvedValue({
59
+ devicePixelRatio: 2,
60
+ fileName: 'test-fullpage.png'
61
+ })
62
+ }));
63
+ vi.mock('../helpers/utils.js', () => ({
64
+ canUseBidiScreenshot: vi.fn().mockReturnValue(false),
65
+ getMethodOrWicOption: vi.fn().mockImplementation((method, wic, option) => {
66
+ return method[option] ?? wic[option];
67
+ })
68
+ }));
69
+ vi.mock('../helpers/options.js', () => ({
70
+ createBeforeScreenshotOptions: vi.fn().mockReturnValue({
71
+ instanceData: { test: 'data' },
72
+ addressBarShadowPadding: 6,
73
+ toolBarShadowPadding: 6,
74
+ disableBlinkingCursor: false,
75
+ disableCSSAnimation: false,
76
+ enableLayoutTesting: false,
77
+ hideElements: [],
78
+ noScrollBars: false,
79
+ removeElements: [],
80
+ waitForFontsLoaded: false,
81
+ }),
82
+ buildAfterScreenshotOptions: vi.fn().mockReturnValue({
83
+ actualFolder: '/test/actual',
84
+ base64Image: 'fullpage-screenshot-data',
85
+ disableBlinkingCursor: false,
86
+ disableCSSAnimation: false,
87
+ enableLayoutTesting: false,
88
+ filePath: {
89
+ browserName: 'chrome',
90
+ deviceName: 'desktop',
91
+ isMobile: false,
92
+ savePerInstance: false,
93
+ },
94
+ fileName: {
95
+ browserName: 'chrome',
96
+ browserVersion: '120.0.0',
97
+ deviceName: 'desktop',
98
+ devicePixelRatio: 2,
99
+ formatImageName: '{tag}-{browserName}-{width}x{height}',
100
+ isMobile: false,
101
+ isTestInBrowser: true,
102
+ logName: 'chrome',
103
+ name: 'chrome',
104
+ outerHeight: 1000,
105
+ outerWidth: 1200,
106
+ platformName: 'desktop',
107
+ platformVersion: '120.0.0',
108
+ screenHeight: 1080,
109
+ screenWidth: 1920,
110
+ tag: 'test-fullpage'
111
+ },
112
+ hideElements: [],
113
+ hideScrollBars: false,
114
+ isLandscape: false,
115
+ isNativeContext: false,
116
+ platformName: 'desktop',
117
+ removeElements: [],
118
+ })
119
+ }));
120
+ describe('saveFullPageScreen', () => {
121
+ let createBeforeScreenshotOptionsSpy;
122
+ let buildAfterScreenshotOptionsSpy;
123
+ let takeFullPageScreenshotsSpy;
124
+ let makeFullPageBase64ImageSpy;
125
+ let afterScreenshotSpy;
126
+ let canUseBidiScreenshotSpy;
127
+ let beforeScreenshotSpy;
128
+ const createBidiMockData = (screenshot) => ({
129
+ fullPageHeight: -1,
130
+ fullPageWidth: -1,
131
+ data: [{
132
+ canvasWidth: 0,
133
+ canvasYPosition: 0,
134
+ imageHeight: 0,
135
+ imageWidth: 0,
136
+ imageXPosition: 0,
137
+ imageYPosition: 0,
138
+ screenshot,
139
+ }]
140
+ });
141
+ const baseOptions = {
142
+ browserInstance: { isAndroid: false, isMobile: false },
143
+ folders: BASE_CHECK_OPTIONS.folders,
144
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
145
+ isNativeContext: false,
146
+ saveFullPageOptions: {
147
+ wic: BASE_CHECK_OPTIONS.wic,
148
+ method: createMethodOptions({
149
+ disableBlinkingCursor: false,
150
+ disableCSSAnimation: false,
151
+ enableLayoutTesting: false,
152
+ enableLegacyScreenshotMethod: false,
153
+ hideScrollBars: true,
154
+ hideElements: [],
155
+ removeElements: [],
156
+ waitForFontsLoaded: true,
157
+ })
158
+ },
159
+ tag: 'test-fullpage'
160
+ };
161
+ beforeEach(async () => {
162
+ createBeforeScreenshotOptionsSpy = vi.mocked(createBeforeScreenshotOptions);
163
+ buildAfterScreenshotOptionsSpy = vi.mocked(buildAfterScreenshotOptions);
164
+ takeFullPageScreenshotsSpy = vi.mocked(takeFullPageScreenshots);
165
+ makeFullPageBase64ImageSpy = vi.mocked(makeFullPageBase64Image);
166
+ afterScreenshotSpy = vi.mocked(afterScreenshot);
167
+ canUseBidiScreenshotSpy = vi.mocked(canUseBidiScreenshot);
168
+ beforeScreenshotSpy = vi.mocked(beforeScreenshot);
169
+ });
170
+ afterEach(() => {
171
+ vi.clearAllMocks();
172
+ });
173
+ it('should throw an error when in native context', async () => {
174
+ const options = {
175
+ ...baseOptions,
176
+ isNativeContext: true
177
+ };
178
+ await expect(saveFullPageScreen(options)).rejects.toThrow('The method saveFullPageScreen is not supported in native context for native mobile apps!');
179
+ });
180
+ it('should use BiDi when conditions are met', async () => {
181
+ canUseBidiScreenshotSpy.mockReturnValueOnce(true);
182
+ takeFullPageScreenshotsSpy.mockResolvedValueOnce(createBidiMockData('test-bidi-screenshot-data'));
183
+ const options = {
184
+ ...baseOptions,
185
+ saveFullPageOptions: {
186
+ ...baseOptions.saveFullPageOptions,
187
+ method: createMethodOptions({
188
+ userBasedFullPageScreenshot: false,
189
+ enableLegacyScreenshotMethod: false
190
+ })
191
+ }
192
+ };
193
+ await saveFullPageScreen(options);
194
+ expect(takeFullPageScreenshotsSpy.mock.calls[0]).toMatchSnapshot();
195
+ });
196
+ it('should use BiDi when canUseBidiScreenshot=true, userBasedFullPageScreenshot=true, enableLegacyScreenshotMethod=false', async () => {
197
+ canUseBidiScreenshotSpy.mockReturnValueOnce(true);
198
+ takeFullPageScreenshotsSpy.mockResolvedValueOnce(createBidiMockData('test-bidi-screenshot-data-2'));
199
+ const options = {
200
+ ...baseOptions,
201
+ saveFullPageOptions: {
202
+ ...baseOptions.saveFullPageOptions,
203
+ method: createMethodOptions({
204
+ userBasedFullPageScreenshot: true,
205
+ enableLegacyScreenshotMethod: false
206
+ })
207
+ }
208
+ };
209
+ await saveFullPageScreen(options);
210
+ expect(takeFullPageScreenshotsSpy.mock.calls[0]).toMatchSnapshot();
211
+ });
212
+ it('should not use BiDi when canUseBidiScreenshot=true, userBasedFullPageScreenshot=false, enableLegacyScreenshotMethod=true', async () => {
213
+ canUseBidiScreenshotSpy.mockReturnValueOnce(true);
214
+ const options = {
215
+ ...baseOptions,
216
+ saveFullPageOptions: {
217
+ ...baseOptions.saveFullPageOptions,
218
+ method: createMethodOptions({
219
+ userBasedFullPageScreenshot: false,
220
+ enableLegacyScreenshotMethod: true
221
+ })
222
+ }
223
+ };
224
+ await saveFullPageScreen(options);
225
+ expect(takeFullPageScreenshotsSpy.mock.calls[0]).toMatchSnapshot();
226
+ });
227
+ it('should take full page screenshots and return result', async () => {
228
+ const result = await saveFullPageScreen(baseOptions);
229
+ expect(createBeforeScreenshotOptionsSpy.mock.calls[0]).toMatchSnapshot();
230
+ expect(takeFullPageScreenshotsSpy.mock.calls[0]).toMatchSnapshot();
231
+ expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot();
232
+ expect(makeFullPageBase64ImageSpy.mock.calls[0]).toMatchSnapshot();
233
+ expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot();
234
+ expect(result).toEqual({
235
+ devicePixelRatio: 2,
236
+ fileName: 'test-fullpage.png'
237
+ });
238
+ });
239
+ it('should handle missing dimension values with NaN fallbacks', async () => {
240
+ beforeScreenshotSpy.mockResolvedValueOnce({
241
+ browserName: 'chrome',
242
+ browserVersion: '120.0.0',
243
+ deviceName: 'desktop',
244
+ dimensions: {
245
+ body: {
246
+ scrollHeight: 2000,
247
+ offsetHeight: 1000,
248
+ },
249
+ html: {
250
+ clientWidth: 1200,
251
+ scrollWidth: 1200,
252
+ clientHeight: 1000,
253
+ scrollHeight: 2000,
254
+ offsetHeight: 1000,
255
+ },
256
+ window: {
257
+ devicePixelRatio: undefined,
258
+ innerHeight: undefined,
259
+ isEmulated: false,
260
+ isLandscape: false,
261
+ outerHeight: undefined,
262
+ outerWidth: undefined,
263
+ screenHeight: undefined,
264
+ screenWidth: undefined,
265
+ },
266
+ },
267
+ isAndroid: false,
268
+ isAndroidChromeDriverScreenshot: false,
269
+ isAndroidNativeWebScreenshot: false,
270
+ isIOS: false,
271
+ isMobile: false,
272
+ isTestInBrowser: true,
273
+ logName: 'chrome',
274
+ name: 'chrome',
275
+ platformName: 'desktop',
276
+ platformVersion: '120.0.0',
277
+ isTestInMobileBrowser: false,
278
+ addressBarShadowPadding: 6,
279
+ toolBarShadowPadding: 6,
280
+ appName: 'test-app',
281
+ elementAddressBarPadding: 0,
282
+ elementToolBarPadding: 0,
283
+ pixelDensity: 1,
284
+ });
285
+ const result = await saveFullPageScreen(baseOptions);
286
+ expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot();
287
+ expect(makeFullPageBase64ImageSpy.mock.calls[0]).toMatchSnapshot();
288
+ expect(result).toEqual({
289
+ devicePixelRatio: 2,
290
+ fileName: 'test-fullpage.png'
291
+ });
292
+ });
293
+ });
@@ -0,0 +1,7 @@
1
+ import type { ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js';
2
+ import type { InternalSaveScreenMethodOptions } from './save.interfaces.js';
3
+ /**
4
+ * Saves an image of the viewport of the desktop browser or the screen of a mobile device
5
+ */
6
+ export default function saveScreen({ browserInstance, folders, instanceData, isNativeContext, tag, saveScreenOptions, }: InternalSaveScreenMethodOptions): Promise<ScreenshotOutput>;
7
+ //# sourceMappingURL=saveScreen.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"saveScreen.d.ts","sourceRoot":"","sources":["../../src/commands/saveScreen.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAGhF,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAA;AAE3E;;GAEG;AACH,wBAA8B,UAAU,CACpC,EACI,eAAe,EACf,OAAO,EACP,YAAY,EACZ,eAAe,EACf,GAAG,EACH,iBAAiB,GACpB,EAAE,+BAA+B,GACnC,OAAO,CAAC,gBAAgB,CAAC,CAI3B"}
@@ -0,0 +1,10 @@
1
+ import saveAppScreen from './saveAppScreen.js';
2
+ import saveWebScreen from './saveWebScreen.js';
3
+ /**
4
+ * Saves an image of the viewport of the desktop browser or the screen of a mobile device
5
+ */
6
+ export default async function saveScreen({ browserInstance, folders, instanceData, isNativeContext, tag, saveScreenOptions, }) {
7
+ return isNativeContext
8
+ ? saveAppScreen({ browserInstance, folders, instanceData, isNativeContext, saveScreenOptions, tag })
9
+ : saveWebScreen({ browserInstance, folders, instanceData, isNativeContext, saveScreenOptions, tag });
10
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=saveScreen.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"saveScreen.test.d.ts","sourceRoot":"","sources":["../../src/commands/saveScreen.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,47 @@
1
+ import { describe, it, expect, vi, afterEach, beforeEach } from 'vitest';
2
+ import saveScreen from './saveScreen.js';
3
+ import { createBaseOptions } from '../mocks/mocks.js';
4
+ vi.mock('./saveAppScreen.js', () => ({
5
+ default: vi.fn().mockResolvedValue({
6
+ devicePixelRatio: 2,
7
+ fileName: 'test-app-screen.png'
8
+ })
9
+ }));
10
+ vi.mock('./saveWebScreen.js', () => ({
11
+ default: vi.fn().mockResolvedValue({
12
+ devicePixelRatio: 2,
13
+ fileName: 'test-web-screen.png'
14
+ })
15
+ }));
16
+ describe('saveScreen', () => {
17
+ let saveAppScreen;
18
+ let saveWebScreen;
19
+ const baseOptions = createBaseOptions('screen');
20
+ beforeEach(async () => {
21
+ saveAppScreen = (await import('./saveAppScreen.js')).default;
22
+ saveWebScreen = (await import('./saveWebScreen.js')).default;
23
+ });
24
+ afterEach(() => {
25
+ vi.clearAllMocks();
26
+ });
27
+ it('should call saveAppScreen when in native context', async () => {
28
+ const options = {
29
+ ...baseOptions,
30
+ isNativeContext: true
31
+ };
32
+ const result = await saveScreen(options);
33
+ expect(result).toMatchSnapshot();
34
+ expect(saveAppScreen).toHaveBeenCalledWith(options);
35
+ expect(saveWebScreen).not.toHaveBeenCalled();
36
+ });
37
+ it('should call saveWebScreen when not in native context', async () => {
38
+ const options = {
39
+ ...baseOptions,
40
+ isNativeContext: false
41
+ };
42
+ const result = await saveScreen(options);
43
+ expect(result).toMatchSnapshot();
44
+ expect(saveWebScreen).toHaveBeenCalledWith(options);
45
+ expect(saveAppScreen).not.toHaveBeenCalled();
46
+ });
47
+ });
@@ -0,0 +1,7 @@
1
+ import type { ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js';
2
+ import type { InternalSaveTabbablePageMethodOptions } from './save.interfaces.js';
3
+ /**
4
+ * Saves an image of all tab executions
5
+ */
6
+ export default function saveTabbablePage({ browserInstance, instanceData, isNativeContext, folders, tag, saveTabbableOptions, }: InternalSaveTabbablePageMethodOptions): Promise<ScreenshotOutput>;
7
+ //# sourceMappingURL=saveTabbablePage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"saveTabbablePage.d.ts","sourceRoot":"","sources":["../../src/commands/saveTabbablePage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAIhF,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,sBAAsB,CAAA;AAEjF;;GAEG;AACH,wBAA8B,gBAAgB,CAC1C,EACI,eAAe,EACf,YAAY,EACZ,eAAuB,EACvB,OAAO,EACP,GAAG,EACH,mBAAmB,GACtB,EAAE,qCAAqC,GACzC,OAAO,CAAC,gBAAgB,CAAC,CAiB3B"}
@@ -0,0 +1,20 @@
1
+ import drawTabbableOnCanvas from '../clientSideScripts/drawTabbableOnCanvas.js';
2
+ import saveFullPageScreen from './saveFullPageScreen.js';
3
+ import removeElementFromDom from '../clientSideScripts/removeElementFromDom.js';
4
+ /**
5
+ * Saves an image of all tab executions
6
+ */
7
+ export default async function saveTabbablePage({ browserInstance, instanceData, isNativeContext = false, folders, tag, saveTabbableOptions, }) {
8
+ // 1a. Check if the method is supported in native context
9
+ if (isNativeContext) {
10
+ throw new Error('The method saveTabbablePage is not supported in native context for native mobile apps!');
11
+ }
12
+ // 1b. Inject drawing the tabbables
13
+ await browserInstance.execute(drawTabbableOnCanvas, saveTabbableOptions.wic.tabbableOptions);
14
+ // 2. Create the screenshot
15
+ const fullPageData = await saveFullPageScreen({ browserInstance, folders, instanceData, isNativeContext, saveFullPageOptions: saveTabbableOptions, tag });
16
+ // 3. Remove the canvas
17
+ await browserInstance.execute(removeElementFromDom, 'wic-tabbable-canvas');
18
+ // 4. Return the data
19
+ return fullPageData;
20
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=saveTabbablePage.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"saveTabbablePage.test.d.ts","sourceRoot":"","sources":["../../src/commands/saveTabbablePage.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,74 @@
1
+ import { describe, it, expect, vi, afterEach, beforeEach } from 'vitest';
2
+ import saveTabbablePage from './saveTabbablePage.js';
3
+ import { BASE_CHECK_OPTIONS, createMethodOptions } from '../mocks/mocks.js';
4
+ vi.mock('./saveFullPageScreen.js', () => ({
5
+ default: vi.fn().mockResolvedValue({
6
+ devicePixelRatio: 2,
7
+ fileName: 'test-tabbable-page.png'
8
+ })
9
+ }));
10
+ vi.mock('../clientSideScripts/drawTabbableOnCanvas.js', () => ({
11
+ default: vi.fn()
12
+ }));
13
+ vi.mock('../clientSideScripts/removeElementFromDom.js', () => ({
14
+ default: vi.fn()
15
+ }));
16
+ describe('saveTabbablePage', () => {
17
+ let saveFullPageScreen;
18
+ const executeMock = vi.fn().mockResolvedValue(undefined);
19
+ const baseOptions = {
20
+ browserInstance: {
21
+ execute: executeMock,
22
+ isAndroid: false,
23
+ isMobile: false
24
+ },
25
+ folders: BASE_CHECK_OPTIONS.folders,
26
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
27
+ isNativeContext: false,
28
+ saveTabbableOptions: {
29
+ wic: {
30
+ ...BASE_CHECK_OPTIONS.wic,
31
+ tabbableOptions: {
32
+ circle: {
33
+ backgroundColor: 'red',
34
+ borderColor: 'blue',
35
+ borderWidth: 2,
36
+ fontColor: 'white',
37
+ fontFamily: 'Arial',
38
+ fontSize: 10,
39
+ size: 10,
40
+ showNumber: true
41
+ },
42
+ line: {
43
+ color: 'blue',
44
+ width: 1
45
+ }
46
+ }
47
+ },
48
+ method: createMethodOptions()
49
+ },
50
+ tag: 'test-tabbable-page'
51
+ };
52
+ beforeEach(async () => {
53
+ saveFullPageScreen = (await vi.importMock('./saveFullPageScreen.js')).default;
54
+ });
55
+ afterEach(() => {
56
+ vi.clearAllMocks();
57
+ });
58
+ it('should throw an error when in native context', async () => {
59
+ const options = {
60
+ ...baseOptions,
61
+ isNativeContext: true
62
+ };
63
+ await expect(saveTabbablePage(options)).rejects.toThrow('The method saveTabbablePage is not supported in native context for native mobile apps!');
64
+ expect(executeMock).not.toHaveBeenCalled();
65
+ expect(saveFullPageScreen).not.toHaveBeenCalled();
66
+ });
67
+ it('should save a tabbable page screenshot', async () => {
68
+ const result = await saveTabbablePage(baseOptions);
69
+ expect(result).toMatchSnapshot();
70
+ expect(executeMock).toHaveBeenCalledTimes(2);
71
+ expect(executeMock.mock.calls).toMatchSnapshot();
72
+ expect(saveFullPageScreen.mock.calls).toMatchSnapshot();
73
+ });
74
+ });
@@ -0,0 +1,7 @@
1
+ import type { ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js';
2
+ import type { InternalSaveElementMethodOptions } from './save.interfaces.js';
3
+ /**
4
+ * Saves an image of an element
5
+ */
6
+ export default function saveWebElement({ browserInstance, instanceData, folders, element, tag, saveElementOptions, }: InternalSaveElementMethodOptions): Promise<ScreenshotOutput>;
7
+ //# sourceMappingURL=saveWebElement.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"saveWebElement.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebElement.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAOhF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAA;AAE5E;;GAEG;AACH,wBAA8B,cAAc,CACxC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,OAAO,EACP,GAAG,EACH,kBAAkB,GACrB,EAAE,gCAAgC,GACpC,OAAO,CAAC,gBAAgB,CAAC,CA+D3B"}
@@ -0,0 +1,53 @@
1
+ import { takeElementScreenshot } from '../methods/takeElementScreenshots.js';
2
+ import beforeScreenshot from '../helpers/beforeScreenshot.js';
3
+ import afterScreenshot from '../helpers/afterScreenshot.js';
4
+ import { DEFAULT_RESIZE_DIMENSIONS } from '../helpers/constants.js';
5
+ import { canUseBidiScreenshot, getMethodOrWicOption } from '../helpers/utils.js';
6
+ import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js';
7
+ /**
8
+ * Saves an image of an element
9
+ */
10
+ export default async function saveWebElement({ browserInstance, instanceData, folders, element, tag, saveElementOptions, }) {
11
+ // 1. Set some variables
12
+ const { addressBarShadowPadding, autoElementScroll, formatImageName, savePerInstance } = saveElementOptions.wic;
13
+ const enableLegacyScreenshotMethod = getMethodOrWicOption(saveElementOptions.method, saveElementOptions.wic, 'enableLegacyScreenshotMethod');
14
+ const resizeDimensions = saveElementOptions.method.resizeDimensions || DEFAULT_RESIZE_DIMENSIONS;
15
+ // 2. Prepare the screenshot
16
+ const beforeOptions = createBeforeScreenshotOptions(instanceData, saveElementOptions.method, saveElementOptions.wic);
17
+ const enrichedInstanceData = await beforeScreenshot(browserInstance, beforeOptions, true);
18
+ const { deviceName, dimensions: { window: { devicePixelRatio, innerHeight, isEmulated, isLandscape, }, }, initialDevicePixelRatio, isAndroid, isAndroidChromeDriverScreenshot, isAndroidNativeWebScreenshot, isIOS, isMobile, } = enrichedInstanceData;
19
+ // 3. Take the screenshot
20
+ const elementScreenshotOptions = {
21
+ addressBarShadowPadding,
22
+ autoElementScroll,
23
+ deviceName,
24
+ devicePixelRatio: devicePixelRatio || 1,
25
+ deviceRectangles: instanceData.deviceRectangles,
26
+ element,
27
+ isEmulated,
28
+ initialDevicePixelRatio: initialDevicePixelRatio || 1,
29
+ innerHeight,
30
+ isAndroidNativeWebScreenshot,
31
+ isAndroidChromeDriverScreenshot,
32
+ isAndroid,
33
+ isIOS,
34
+ isLandscape,
35
+ isMobile,
36
+ resizeDimensions,
37
+ toolBarShadowPadding: beforeOptions.toolBarShadowPadding,
38
+ };
39
+ const shouldUseBidi = canUseBidiScreenshot(browserInstance) && !isMobile && !enableLegacyScreenshotMethod;
40
+ const screenshotData = await takeElementScreenshot(browserInstance, elementScreenshotOptions, shouldUseBidi);
41
+ // 4. Return the data
42
+ const afterOptions = buildAfterScreenshotOptions({
43
+ base64Image: screenshotData.base64Image,
44
+ folders,
45
+ tag,
46
+ isNativeContext: false,
47
+ instanceData,
48
+ enrichedInstanceData,
49
+ beforeOptions,
50
+ wicOptions: { formatImageName, savePerInstance }
51
+ });
52
+ return afterScreenshot(browserInstance, afterOptions);
53
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=saveWebElement.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"saveWebElement.test.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebElement.test.ts"],"names":[],"mappings":""}