@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,200 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
2
+ import checkTabbablePage from './checkTabbablePage.js';
3
+ import { BASE_CHECK_OPTIONS } from '../mocks/mocks.js';
4
+ vi.mock('../clientSideScripts/drawTabbableOnCanvas.js', () => ({
5
+ default: vi.fn()
6
+ }));
7
+ vi.mock('../clientSideScripts/removeElementFromDom.js', () => ({
8
+ default: vi.fn()
9
+ }));
10
+ vi.mock('./checkFullPageScreen.js', () => ({
11
+ default: vi.fn().mockResolvedValue({
12
+ fileName: 'test-tabbable.png',
13
+ misMatchPercentage: 0,
14
+ isExactSameImage: true,
15
+ isNewBaseline: false,
16
+ isAboveTolerance: false,
17
+ })
18
+ }));
19
+ describe('checkTabbablePage', () => {
20
+ let checkFullPageScreenSpy;
21
+ const baseOptions = {
22
+ checkTabbableOptions: {
23
+ wic: {
24
+ ...BASE_CHECK_OPTIONS.wic,
25
+ tabbableOptions: {
26
+ circle: {
27
+ backgroundColor: 'red',
28
+ borderColor: 'blue',
29
+ borderWidth: 2,
30
+ fontColor: 'white',
31
+ fontFamily: 'Arial',
32
+ fontSize: 10,
33
+ size: 10,
34
+ showNumber: true,
35
+ },
36
+ line: {
37
+ color: 'green',
38
+ width: 2,
39
+ },
40
+ }
41
+ },
42
+ method: {
43
+ disableBlinkingCursor: false,
44
+ disableCSSAnimation: false,
45
+ enableLayoutTesting: false,
46
+ enableLegacyScreenshotMethod: false,
47
+ fullPageScrollTimeout: 1500,
48
+ hideAfterFirstScroll: [],
49
+ hideScrollBars: true,
50
+ hideElements: [],
51
+ removeElements: [],
52
+ waitForFontsLoaded: true,
53
+ }
54
+ },
55
+ browserInstance: {
56
+ isAndroid: false,
57
+ execute: vi.fn().mockResolvedValue(undefined)
58
+ },
59
+ folders: BASE_CHECK_OPTIONS.folders,
60
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
61
+ isNativeContext: false,
62
+ tag: 'test-tabbable',
63
+ testContext: BASE_CHECK_OPTIONS.testContext
64
+ };
65
+ beforeEach(async () => {
66
+ const checkFullPageScreen = (await import('./checkFullPageScreen.js')).default;
67
+ checkFullPageScreenSpy = vi.mocked(checkFullPageScreen);
68
+ });
69
+ afterEach(() => {
70
+ vi.clearAllMocks();
71
+ });
72
+ it('should throw error when used in native context', async () => {
73
+ const options = {
74
+ ...baseOptions,
75
+ isNativeContext: true
76
+ };
77
+ await expect(checkTabbablePage(options)).rejects.toThrow('The method checkTabbablePage is not supported in native context for native mobile apps!');
78
+ });
79
+ it('should execute checkTabbablePage with basic options', async () => {
80
+ const result = await checkTabbablePage(baseOptions);
81
+ expect(result).toMatchSnapshot();
82
+ expect(baseOptions.browserInstance.execute).toMatchSnapshot();
83
+ expect(checkFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
84
+ });
85
+ it('should handle Android device correctly', async () => {
86
+ const options = {
87
+ ...baseOptions,
88
+ browserInstance: {
89
+ isAndroid: true,
90
+ execute: vi.fn().mockResolvedValue(undefined)
91
+ },
92
+ instanceData: {
93
+ ...baseOptions.instanceData,
94
+ deviceName: 'Pixel 4',
95
+ isAndroid: true,
96
+ isIOS: false,
97
+ platformName: 'Android',
98
+ platformVersion: '11.0'
99
+ },
100
+ testContext: {
101
+ ...baseOptions.testContext,
102
+ instanceData: {
103
+ ...baseOptions.testContext.instanceData,
104
+ deviceName: 'Pixel 4',
105
+ platform: { name: 'Android', version: '11.0' },
106
+ isAndroid: true,
107
+ isIOS: false
108
+ }
109
+ }
110
+ };
111
+ await checkTabbablePage(options);
112
+ expect(checkFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
113
+ });
114
+ it('should handle custom tabbable options', async () => {
115
+ const options = {
116
+ ...baseOptions,
117
+ checkTabbableOptions: {
118
+ ...baseOptions.checkTabbableOptions,
119
+ wic: {
120
+ ...baseOptions.checkTabbableOptions.wic,
121
+ tabbableOptions: {
122
+ circle: {
123
+ backgroundColor: 'yellow',
124
+ borderColor: 'black',
125
+ borderWidth: 3,
126
+ fontColor: 'black',
127
+ fontFamily: 'Helvetica',
128
+ fontSize: 12,
129
+ size: 15,
130
+ showNumber: false,
131
+ },
132
+ line: {
133
+ color: 'red',
134
+ width: 3,
135
+ },
136
+ }
137
+ }
138
+ }
139
+ };
140
+ await checkTabbablePage(options);
141
+ expect(baseOptions.browserInstance.execute).toMatchSnapshot();
142
+ });
143
+ it('should handle errors during execution', async () => {
144
+ const options = {
145
+ ...baseOptions,
146
+ browserInstance: {
147
+ ...baseOptions.browserInstance,
148
+ execute: vi.fn().mockRejectedValue(new Error('Execution failed')),
149
+ sessionStatus: vi.fn(),
150
+ sessionNew: vi.fn(),
151
+ sessionEnd: vi.fn(),
152
+ sessionSubscribe: vi.fn(),
153
+ }
154
+ };
155
+ await expect(checkTabbablePage(options)).rejects.toThrow('Execution failed');
156
+ });
157
+ it('should handle hybrid app options correctly', async () => {
158
+ const options = {
159
+ ...baseOptions,
160
+ checkTabbableOptions: {
161
+ ...baseOptions.checkTabbableOptions,
162
+ wic: {
163
+ ...baseOptions.checkTabbableOptions.wic,
164
+ isHybridApp: true
165
+ }
166
+ }
167
+ };
168
+ await checkTabbablePage(options);
169
+ expect(checkFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
170
+ });
171
+ it('should handle default tabbable options', async () => {
172
+ const options = {
173
+ ...baseOptions,
174
+ checkTabbableOptions: {
175
+ ...baseOptions.checkTabbableOptions,
176
+ wic: {
177
+ ...baseOptions.checkTabbableOptions.wic,
178
+ tabbableOptions: {
179
+ circle: {
180
+ backgroundColor: 'red',
181
+ borderColor: 'blue',
182
+ borderWidth: 2,
183
+ fontColor: 'white',
184
+ fontFamily: 'Arial',
185
+ fontSize: 10,
186
+ size: 10,
187
+ showNumber: true,
188
+ },
189
+ line: {
190
+ color: 'green',
191
+ width: 2,
192
+ },
193
+ }
194
+ }
195
+ }
196
+ };
197
+ await checkTabbablePage(options);
198
+ expect(baseOptions.browserInstance.execute).toMatchSnapshot();
199
+ });
200
+ });
@@ -0,0 +1,7 @@
1
+ import type { ImageCompareResult } from '../methods/images.interfaces.js';
2
+ import type { InternalCheckElementMethodOptions } from './check.interfaces.js';
3
+ /**
4
+ * Compare an image of the element
5
+ */
6
+ export default function checkWebElement({ browserInstance, instanceData, folders, element, tag, checkElementOptions, testContext, isNativeContext, }: InternalCheckElementMethodOptions): Promise<ImageCompareResult | number>;
7
+ //# sourceMappingURL=checkWebElement.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkWebElement.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebElement.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,uBAAuB,CAAA;AAE9E;;GAEG;AACH,wBAA8B,eAAe,CACzC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,OAAO,EACP,GAAG,EACH,mBAAmB,EACnB,WAAW,EACX,eAAuB,GAC1B,EAAE,iCAAiC,GACrC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAyDtC"}
@@ -0,0 +1,52 @@
1
+ import { executeImageCompare } from '../methods/images.js';
2
+ import saveWebElement from './saveWebElement.js';
3
+ import { methodCompareOptions } from '../helpers/options.js';
4
+ import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../helpers/utils.js';
5
+ /**
6
+ * Compare an image of the element
7
+ */
8
+ export default async function checkWebElement({ browserInstance, instanceData, folders, element, tag, checkElementOptions, testContext, isNativeContext = false, }) {
9
+ // 1. Extract common variables
10
+ const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkElementOptions.wic });
11
+ const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, hideScrollBars, resizeDimensions, hideElements = [], removeElements = [], waitForFontsLoaded = false, } = checkElementOptions.method;
12
+ // 2. Take the actual element screenshot and retrieve the needed data
13
+ const saveElementOptions = {
14
+ wic: checkElementOptions.wic,
15
+ method: {
16
+ disableBlinkingCursor,
17
+ disableCSSAnimation,
18
+ enableLayoutTesting,
19
+ enableLegacyScreenshotMethod,
20
+ hideScrollBars,
21
+ resizeDimensions,
22
+ hideElements,
23
+ removeElements,
24
+ waitForFontsLoaded,
25
+ },
26
+ };
27
+ const { devicePixelRatio, fileName } = await saveWebElement({
28
+ browserInstance,
29
+ instanceData,
30
+ folders,
31
+ element,
32
+ tag,
33
+ saveElementOptions,
34
+ });
35
+ // 3. Determine the options
36
+ const compareOptions = methodCompareOptions(checkElementOptions.method);
37
+ const executeCompareOptions = buildBaseExecuteCompareOptions({
38
+ commonCheckVariables,
39
+ wicCompareOptions: checkElementOptions.wic.compareOptions,
40
+ methodCompareOptions: compareOptions,
41
+ devicePixelRatio,
42
+ fileName,
43
+ isElementScreenshot: true,
44
+ });
45
+ // 4. Now execute the compare and return the data
46
+ return executeImageCompare({
47
+ isViewPortScreenshot: true,
48
+ isNativeContext,
49
+ options: executeCompareOptions,
50
+ testContext,
51
+ });
52
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=checkWebElement.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkWebElement.test.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebElement.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,278 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
2
+ import checkWebElement from './checkWebElement.js';
3
+ import { BASE_CHECK_OPTIONS } from '../mocks/mocks.js';
4
+ vi.mock('../methods/images.js', () => ({
5
+ executeImageCompare: vi.fn().mockResolvedValue({
6
+ fileName: 'test-element.png',
7
+ misMatchPercentage: 0,
8
+ isExactSameImage: true,
9
+ isNewBaseline: false,
10
+ isAboveTolerance: false,
11
+ })
12
+ }));
13
+ vi.mock('./saveWebElement.js', () => ({
14
+ default: vi.fn().mockResolvedValue({
15
+ devicePixelRatio: 2,
16
+ fileName: 'test-element.png'
17
+ })
18
+ }));
19
+ vi.mock('../helpers/options.js', () => ({
20
+ methodCompareOptions: vi.fn().mockReturnValue({
21
+ ignoreAlpha: false,
22
+ ignoreAntialiasing: false,
23
+ ignoreColors: false,
24
+ ignoreLess: false,
25
+ ignoreNothing: false,
26
+ rawMisMatchPercentage: false,
27
+ returnAllCompareData: false,
28
+ saveAboveTolerance: 0,
29
+ scaleImagesToSameSize: false,
30
+ })
31
+ }));
32
+ vi.mock('../helpers/utils.js', () => ({
33
+ extractCommonCheckVariables: vi.fn().mockReturnValue({
34
+ actualFolder: '/mock/actual',
35
+ baselineFolder: '/mock/baseline',
36
+ diffFolder: '/mock/diff',
37
+ browserName: 'chrome',
38
+ deviceName: 'Desktop',
39
+ deviceRectangles: { screenSize: { width: 1280, height: 720 } },
40
+ isAndroid: false,
41
+ isMobile: false,
42
+ isAndroidNativeWebScreenshot: false,
43
+ platformName: 'Windows',
44
+ autoSaveBaseline: false,
45
+ savePerInstance: false,
46
+ }),
47
+ buildBaseExecuteCompareOptions: vi.fn().mockImplementation((params) => {
48
+ const wicOptions = params.isElementScreenshot ? {
49
+ ...params.wicCompareOptions,
50
+ blockOutSideBar: false,
51
+ blockOutStatusBar: false,
52
+ blockOutToolBar: false,
53
+ } : params.wicCompareOptions;
54
+ return {
55
+ compareOptions: {
56
+ wic: wicOptions,
57
+ method: params.methodCompareOptions,
58
+ },
59
+ devicePixelRatio: params.devicePixelRatio,
60
+ deviceRectangles: { screenSize: { width: 1280, height: 720 } },
61
+ fileName: params.fileName,
62
+ folderOptions: {
63
+ autoSaveBaseline: false,
64
+ actualFolder: '/mock/actual',
65
+ baselineFolder: '/mock/baseline',
66
+ diffFolder: '/mock/diff',
67
+ browserName: 'chrome',
68
+ deviceName: 'Desktop',
69
+ isMobile: false,
70
+ savePerInstance: false,
71
+ },
72
+ isAndroid: false,
73
+ isAndroidNativeWebScreenshot: false,
74
+ platformName: 'Windows',
75
+ };
76
+ }),
77
+ }));
78
+ describe('checkWebElement', () => {
79
+ let executeImageCompareSpy;
80
+ let saveWebElementSpy;
81
+ const baseOptions = {
82
+ checkElementOptions: {
83
+ wic: BASE_CHECK_OPTIONS.wic,
84
+ method: {
85
+ disableBlinkingCursor: false,
86
+ disableCSSAnimation: false,
87
+ enableLayoutTesting: false,
88
+ enableLegacyScreenshotMethod: false,
89
+ hideScrollBars: true,
90
+ resizeDimensions: undefined,
91
+ hideElements: [],
92
+ removeElements: [],
93
+ waitForFontsLoaded: true,
94
+ }
95
+ },
96
+ browserInstance: {
97
+ isAndroid: false,
98
+ isMobile: false
99
+ },
100
+ folders: BASE_CHECK_OPTIONS.folders,
101
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
102
+ element: { elementId: 'test-element' },
103
+ tag: 'test-element',
104
+ testContext: BASE_CHECK_OPTIONS.testContext
105
+ };
106
+ beforeEach(async () => {
107
+ const { executeImageCompare } = await import('../methods/images.js');
108
+ const saveWebElement = (await import('./saveWebElement.js')).default;
109
+ executeImageCompareSpy = vi.mocked(executeImageCompare);
110
+ saveWebElementSpy = vi.mocked(saveWebElement);
111
+ });
112
+ afterEach(() => {
113
+ vi.clearAllMocks();
114
+ });
115
+ it('should execute checkWebElement with basic options', async () => {
116
+ const result = await checkWebElement(baseOptions);
117
+ expect(result).toMatchSnapshot();
118
+ expect(saveWebElementSpy.mock.calls[0]).toMatchSnapshot();
119
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
120
+ });
121
+ it('should handle Android device correctly', async () => {
122
+ const options = {
123
+ ...baseOptions,
124
+ browserInstance: {
125
+ isAndroid: true,
126
+ isMobile: true
127
+ },
128
+ instanceData: {
129
+ ...baseOptions.instanceData,
130
+ deviceName: 'Pixel 4',
131
+ isAndroid: true,
132
+ isIOS: false,
133
+ platformName: 'Android',
134
+ platformVersion: '11.0',
135
+ nativeWebScreenshot: true
136
+ },
137
+ testContext: {
138
+ ...baseOptions.testContext,
139
+ instanceData: {
140
+ ...baseOptions.testContext.instanceData,
141
+ deviceName: 'Pixel 4',
142
+ platform: { name: 'Android', version: '11.0' },
143
+ isAndroid: true,
144
+ isIOS: false
145
+ }
146
+ }
147
+ };
148
+ await checkWebElement(options);
149
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
150
+ });
151
+ it('should handle custom element options', async () => {
152
+ const mockElement = {
153
+ elementId: 'hide-element',
154
+ selector: '#hide-element',
155
+ isDisplayed: vi.fn().mockResolvedValue(true),
156
+ getSize: vi.fn().mockResolvedValue({ width: 100, height: 100 }),
157
+ getLocation: vi.fn().mockResolvedValue({ x: 0, y: 0 })
158
+ };
159
+ const mockRemoveElement = {
160
+ elementId: 'remove-element',
161
+ selector: '#remove-element',
162
+ isDisplayed: vi.fn().mockResolvedValue(true),
163
+ getSize: vi.fn().mockResolvedValue({ width: 100, height: 100 }),
164
+ getLocation: vi.fn().mockResolvedValue({ x: 0, y: 0 })
165
+ };
166
+ const options = {
167
+ ...baseOptions,
168
+ checkElementOptions: {
169
+ ...baseOptions.checkElementOptions,
170
+ method: {
171
+ disableBlinkingCursor: true,
172
+ disableCSSAnimation: true,
173
+ enableLayoutTesting: true,
174
+ enableLegacyScreenshotMethod: true,
175
+ hideScrollBars: false,
176
+ resizeDimensions: {
177
+ width: 100,
178
+ height: 100,
179
+ top: 0,
180
+ left: 0,
181
+ right: 0,
182
+ bottom: 0
183
+ },
184
+ hideElements: [mockElement],
185
+ removeElements: [mockRemoveElement],
186
+ waitForFontsLoaded: false,
187
+ }
188
+ }
189
+ };
190
+ await checkWebElement(options);
191
+ expect(saveWebElementSpy.mock.calls[0]).toMatchSnapshot();
192
+ });
193
+ it('should handle compare options correctly', async () => {
194
+ const options = {
195
+ ...baseOptions,
196
+ checkElementOptions: {
197
+ ...baseOptions.checkElementOptions,
198
+ wic: {
199
+ ...baseOptions.checkElementOptions.wic,
200
+ compareOptions: {
201
+ ignoreAlpha: true,
202
+ ignoreAntialiasing: true,
203
+ ignoreColors: true,
204
+ ignoreLess: true,
205
+ ignoreNothing: false,
206
+ rawMisMatchPercentage: true,
207
+ returnAllCompareData: true,
208
+ saveAboveTolerance: 0.1,
209
+ scaleImagesToSameSize: true,
210
+ blockOutSideBar: false,
211
+ blockOutStatusBar: false,
212
+ blockOutToolBar: false,
213
+ createJsonReportFiles: false,
214
+ diffPixelBoundingBoxProximity: 0
215
+ }
216
+ }
217
+ }
218
+ };
219
+ await checkWebElement(options);
220
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
221
+ });
222
+ it('should handle device rectangles correctly', async () => {
223
+ const options = {
224
+ ...baseOptions,
225
+ instanceData: {
226
+ ...baseOptions.instanceData,
227
+ deviceRectangles: {
228
+ statusBar: { x: 0, y: 0, width: 100, height: 20 },
229
+ toolBar: { x: 0, y: 20, width: 100, height: 40 },
230
+ sideBar: { x: 0, y: 60, width: 20, height: 100 },
231
+ bottomBar: { x: 0, y: 80, width: 100, height: 20 },
232
+ homeBar: { x: 0, y: 100, width: 100, height: 20 },
233
+ leftSidePadding: { x: 0, y: 0, width: 10, height: 100 },
234
+ rightSidePadding: { x: 90, y: 0, width: 10, height: 100 },
235
+ topSidePadding: { x: 0, y: 0, width: 100, height: 10 },
236
+ bottomSidePadding: { x: 0, y: 90, width: 100, height: 10 },
237
+ screenSize: { x: 0, y: 0, width: 100, height: 120 },
238
+ statusBarAndAddressBar: { x: 0, y: 0, width: 100, height: 60 },
239
+ viewport: { x: 0, y: 60, width: 100, height: 60 }
240
+ }
241
+ }
242
+ };
243
+ await checkWebElement(options);
244
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
245
+ });
246
+ it('should handle hybrid app options correctly', async () => {
247
+ const options = {
248
+ ...baseOptions,
249
+ checkElementOptions: {
250
+ ...baseOptions.checkElementOptions,
251
+ wic: {
252
+ ...baseOptions.checkElementOptions.wic,
253
+ isHybridApp: true
254
+ }
255
+ }
256
+ };
257
+ await checkWebElement(options);
258
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
259
+ });
260
+ it('should handle undefined method options with fallbacks', async () => {
261
+ const options = {
262
+ ...baseOptions,
263
+ checkElementOptions: {
264
+ ...baseOptions.checkElementOptions,
265
+ method: {
266
+ disableBlinkingCursor: false,
267
+ disableCSSAnimation: false,
268
+ enableLayoutTesting: false,
269
+ enableLegacyScreenshotMethod: false,
270
+ hideScrollBars: true,
271
+ waitForFontsLoaded: true,
272
+ }
273
+ }
274
+ };
275
+ await checkWebElement(options);
276
+ expect(saveWebElementSpy.mock.calls[0]).toMatchSnapshot();
277
+ });
278
+ });
@@ -0,0 +1,7 @@
1
+ import type { ImageCompareResult } from '../methods/images.interfaces.js';
2
+ import type { InternalCheckScreenMethodOptions } from './check.interfaces.js';
3
+ /**
4
+ * Compare an image of the viewport of the screen
5
+ */
6
+ export default function checkWebScreen({ browserInstance, instanceData, folders, tag, checkScreenOptions, isNativeContext, testContext, }: InternalCheckScreenMethodOptions): Promise<ImageCompareResult | number>;
7
+ //# sourceMappingURL=checkWebScreen.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkWebScreen.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebScreen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAA;AAE7E;;GAEG;AACH,wBAA8B,cAAc,CACxC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,kBAAkB,EAClB,eAAuB,EACvB,WAAW,GACd,EAAE,gCAAgC,GACpC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAsDtC"}
@@ -0,0 +1,50 @@
1
+ import saveWebScreen from './saveWebScreen.js';
2
+ import { executeImageCompare } from '../methods/images.js';
3
+ import { screenMethodCompareOptions } from '../helpers/options.js';
4
+ import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../helpers/utils.js';
5
+ /**
6
+ * Compare an image of the viewport of the screen
7
+ */
8
+ export default async function checkWebScreen({ browserInstance, instanceData, folders, tag, checkScreenOptions, isNativeContext = false, testContext, }) {
9
+ // 1. Extract common variables
10
+ const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkScreenOptions.wic });
11
+ const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, hideScrollBars, hideElements = [], removeElements = [], waitForFontsLoaded, } = checkScreenOptions.method;
12
+ // 2. Take the actual screenshot and retrieve the needed data
13
+ const saveScreenOptions = {
14
+ wic: checkScreenOptions.wic,
15
+ method: {
16
+ disableBlinkingCursor,
17
+ disableCSSAnimation,
18
+ enableLayoutTesting,
19
+ enableLegacyScreenshotMethod,
20
+ hideScrollBars,
21
+ hideElements,
22
+ removeElements,
23
+ waitForFontsLoaded,
24
+ },
25
+ };
26
+ const { devicePixelRatio, fileName } = await saveWebScreen({
27
+ browserInstance,
28
+ instanceData,
29
+ folders,
30
+ tag,
31
+ saveScreenOptions,
32
+ isNativeContext,
33
+ });
34
+ // 3. Determine the compare options
35
+ const methodCompareOptions = screenMethodCompareOptions(checkScreenOptions.method);
36
+ const executeCompareOptions = buildBaseExecuteCompareOptions({
37
+ commonCheckVariables,
38
+ wicCompareOptions: checkScreenOptions.wic.compareOptions,
39
+ methodCompareOptions,
40
+ devicePixelRatio,
41
+ fileName,
42
+ });
43
+ // 4. Now execute the compare and return the data
44
+ return executeImageCompare({
45
+ isViewPortScreenshot: true,
46
+ isNativeContext,
47
+ options: executeCompareOptions,
48
+ testContext,
49
+ });
50
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=checkWebScreen.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkWebScreen.test.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebScreen.test.ts"],"names":[],"mappings":""}