@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,66 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
2
+ import checkElement from './checkElement.js';
3
+ import { BASE_CHECK_OPTIONS } from '../mocks/mocks.js';
4
+ vi.mock('./checkAppElement.js', () => ({
5
+ default: vi.fn().mockResolvedValue({
6
+ fileName: 'test-app-element.png',
7
+ misMatchPercentage: 0,
8
+ isExactSameImage: true,
9
+ isNewBaseline: false,
10
+ isAboveTolerance: false,
11
+ })
12
+ }));
13
+ vi.mock('./checkWebElement.js', () => ({
14
+ default: vi.fn().mockResolvedValue({
15
+ fileName: 'test-web-element.png',
16
+ misMatchPercentage: 0,
17
+ isExactSameImage: true,
18
+ isNewBaseline: false,
19
+ isAboveTolerance: false,
20
+ })
21
+ }));
22
+ describe('checkElement', () => {
23
+ let checkAppElementSpy;
24
+ let checkWebElementSpy;
25
+ const baseOptions = {
26
+ checkElementOptions: {
27
+ wic: BASE_CHECK_OPTIONS.wic,
28
+ method: {}
29
+ },
30
+ browserInstance: { isAndroid: false },
31
+ element: { selector: '#test-element' },
32
+ folders: BASE_CHECK_OPTIONS.folders,
33
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
34
+ isNativeContext: true,
35
+ tag: 'test-element',
36
+ testContext: {
37
+ ...BASE_CHECK_OPTIONS.testContext,
38
+ commandName: 'checkElement'
39
+ }
40
+ };
41
+ beforeEach(async () => {
42
+ const checkAppElement = (await import('./checkAppElement.js')).default;
43
+ const checkWebElement = (await import('./checkWebElement.js')).default;
44
+ checkAppElementSpy = vi.mocked(checkAppElement);
45
+ checkWebElementSpy = vi.mocked(checkWebElement);
46
+ });
47
+ afterEach(() => {
48
+ vi.clearAllMocks();
49
+ });
50
+ it('should call checkAppElement when isNativeContext is true', async () => {
51
+ const result = await checkElement(baseOptions);
52
+ expect(result).toMatchSnapshot();
53
+ expect(checkAppElementSpy.mock.calls[0]).toMatchSnapshot();
54
+ expect(checkWebElementSpy).not.toHaveBeenCalled();
55
+ });
56
+ it('should call checkWebElement', async () => {
57
+ const options = {
58
+ ...baseOptions,
59
+ isNativeContext: false
60
+ };
61
+ const result = await checkElement(options);
62
+ expect(result).toMatchSnapshot();
63
+ expect(checkWebElementSpy.mock.calls[0]).toMatchSnapshot();
64
+ expect(checkAppElementSpy).not.toHaveBeenCalled();
65
+ });
66
+ });
@@ -0,0 +1,7 @@
1
+ import type { ImageCompareResult } from '../methods/images.interfaces.js';
2
+ import type { InternalCheckFullPageMethodOptions } from './check.interfaces.js';
3
+ /**
4
+ * Compare a fullpage screenshot
5
+ */
6
+ export default function checkFullPageScreen({ browserInstance, checkFullPageOptions, folders, instanceData, isNativeContext, tag, testContext, }: InternalCheckFullPageMethodOptions): Promise<ImageCompareResult | number>;
7
+ //# sourceMappingURL=checkFullPageScreen.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkFullPageScreen.d.ts","sourceRoot":"","sources":["../../src/commands/checkFullPageScreen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,uBAAuB,CAAA;AAE/E;;GAEG;AACH,wBAA8B,mBAAmB,CAC7C,EACI,eAAe,EACf,oBAAoB,EACpB,OAAO,EACP,YAAY,EACZ,eAAuB,EACvB,GAAG,EACH,WAAW,GACd,EAAE,kCAAkC,GACtC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CA+DtC"}
@@ -0,0 +1,56 @@
1
+ import { executeImageCompare } from '../methods/images.js';
2
+ import saveFullPageScreen from './saveFullPageScreen.js';
3
+ import { methodCompareOptions } from '../helpers/options.js';
4
+ import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../helpers/utils.js';
5
+ /**
6
+ * Compare a fullpage screenshot
7
+ */
8
+ export default async function checkFullPageScreen({ browserInstance, checkFullPageOptions, folders, instanceData, isNativeContext = false, tag, testContext, }) {
9
+ // 1. Extract common variables
10
+ const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkFullPageOptions.wic });
11
+ const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, fullPageScrollTimeout, hideAfterFirstScroll = [], hideScrollBars, hideElements = [], removeElements = [], waitForFontsLoaded, } = checkFullPageOptions.method;
12
+ // 2. Check if the method is supported in native context
13
+ if (isNativeContext) {
14
+ throw new Error('The method checkFullPageScreen is not supported in native context for native mobile apps!');
15
+ }
16
+ // 3. Take the actual full page screenshot and retrieve the needed data
17
+ const saveFullPageOptions = {
18
+ wic: checkFullPageOptions.wic,
19
+ method: {
20
+ disableBlinkingCursor,
21
+ disableCSSAnimation,
22
+ enableLayoutTesting,
23
+ enableLegacyScreenshotMethod,
24
+ fullPageScrollTimeout,
25
+ hideAfterFirstScroll,
26
+ hideScrollBars,
27
+ hideElements,
28
+ removeElements,
29
+ waitForFontsLoaded,
30
+ },
31
+ };
32
+ const { devicePixelRatio, fileName } = await saveFullPageScreen({
33
+ browserInstance,
34
+ folders,
35
+ instanceData,
36
+ isNativeContext,
37
+ saveFullPageOptions,
38
+ tag,
39
+ });
40
+ // 4. Determine the options
41
+ const compareOptions = methodCompareOptions(checkFullPageOptions.method);
42
+ const executeCompareOptions = buildBaseExecuteCompareOptions({
43
+ commonCheckVariables,
44
+ wicCompareOptions: checkFullPageOptions.wic.compareOptions,
45
+ methodCompareOptions: compareOptions,
46
+ devicePixelRatio,
47
+ fileName,
48
+ });
49
+ // 5. Now execute the compare and return the data
50
+ return executeImageCompare({
51
+ isViewPortScreenshot: false,
52
+ isNativeContext,
53
+ options: executeCompareOptions,
54
+ testContext,
55
+ });
56
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=checkFullPageScreen.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkFullPageScreen.test.d.ts","sourceRoot":"","sources":["../../src/commands/checkFullPageScreen.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,259 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
2
+ import checkFullPageScreen from './checkFullPageScreen.js';
3
+ import { BASE_CHECK_OPTIONS } from '../mocks/mocks.js';
4
+ vi.mock('../helpers/options.js', () => ({
5
+ methodCompareOptions: vi.fn().mockReturnValue({
6
+ ignoreAlpha: false,
7
+ ignoreAntialiasing: false,
8
+ ignoreColors: false,
9
+ ignoreLess: false,
10
+ ignoreNothing: false,
11
+ rawMisMatchPercentage: false,
12
+ returnAllCompareData: false,
13
+ saveAboveTolerance: 0,
14
+ scaleImagesToSameSize: false,
15
+ })
16
+ }));
17
+ vi.mock('../helpers/utils.js', () => ({
18
+ extractCommonCheckVariables: vi.fn().mockReturnValue({
19
+ actualFolder: '/mock/actual',
20
+ baselineFolder: '/mock/baseline',
21
+ diffFolder: '/mock/diff',
22
+ browserName: 'chrome',
23
+ deviceName: 'Desktop',
24
+ deviceRectangles: { screenSize: { width: 1280, height: 720 } },
25
+ isAndroid: false,
26
+ isMobile: false,
27
+ isAndroidNativeWebScreenshot: false,
28
+ platformName: 'Windows',
29
+ isIOS: false,
30
+ autoSaveBaseline: false,
31
+ savePerInstance: false,
32
+ isHybridApp: false,
33
+ }),
34
+ buildBaseExecuteCompareOptions: vi.fn().mockImplementation((params) => ({
35
+ compareOptions: {
36
+ wic: params.wicCompareOptions,
37
+ method: params.methodCompareOptions,
38
+ },
39
+ devicePixelRatio: params.devicePixelRatio,
40
+ deviceRectangles: { screenSize: { width: 1280, height: 720 } },
41
+ fileName: params.fileName,
42
+ folderOptions: {
43
+ autoSaveBaseline: false,
44
+ actualFolder: '/mock/actual',
45
+ baselineFolder: '/mock/baseline',
46
+ diffFolder: '/mock/diff',
47
+ browserName: 'chrome',
48
+ deviceName: 'Desktop',
49
+ isMobile: false,
50
+ savePerInstance: false,
51
+ },
52
+ isAndroid: false,
53
+ isAndroidNativeWebScreenshot: false,
54
+ isIOS: false,
55
+ isHybridApp: false,
56
+ platformName: 'Windows',
57
+ })),
58
+ }));
59
+ vi.mock('../methods/images.js', () => ({
60
+ executeImageCompare: vi.fn().mockResolvedValue({
61
+ fileName: 'test-result.png',
62
+ misMatchPercentage: 0,
63
+ isExactSameImage: true,
64
+ isNewBaseline: false,
65
+ isAboveTolerance: false,
66
+ })
67
+ }));
68
+ vi.mock('./saveFullPageScreen.js', () => ({
69
+ default: vi.fn().mockResolvedValue({
70
+ devicePixelRatio: 2,
71
+ fileName: 'test-fullpage.png'
72
+ })
73
+ }));
74
+ describe('checkFullPageScreen', () => {
75
+ let executeImageCompareSpy;
76
+ let saveFullPageScreenSpy;
77
+ const baseOptions = {
78
+ checkFullPageOptions: {
79
+ wic: BASE_CHECK_OPTIONS.wic,
80
+ method: {
81
+ disableBlinkingCursor: false,
82
+ disableCSSAnimation: false,
83
+ enableLayoutTesting: false,
84
+ enableLegacyScreenshotMethod: false,
85
+ fullPageScrollTimeout: 1500,
86
+ hideAfterFirstScroll: [],
87
+ hideScrollBars: true,
88
+ hideElements: [],
89
+ removeElements: [],
90
+ waitForFontsLoaded: true,
91
+ }
92
+ },
93
+ browserInstance: { isAndroid: false },
94
+ folders: BASE_CHECK_OPTIONS.folders,
95
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
96
+ isNativeContext: false,
97
+ tag: 'test-fullpage',
98
+ testContext: BASE_CHECK_OPTIONS.testContext
99
+ };
100
+ beforeEach(async () => {
101
+ const { executeImageCompare } = await import('../methods/images.js');
102
+ const saveFullPageScreen = (await import('./saveFullPageScreen.js')).default;
103
+ executeImageCompareSpy = vi.mocked(executeImageCompare);
104
+ saveFullPageScreenSpy = vi.mocked(saveFullPageScreen);
105
+ });
106
+ afterEach(() => {
107
+ vi.clearAllMocks();
108
+ });
109
+ it('should throw error when used in native context', async () => {
110
+ const options = {
111
+ ...baseOptions,
112
+ isNativeContext: true
113
+ };
114
+ await expect(checkFullPageScreen(options)).rejects.toThrow('The method checkFullPageScreen is not supported in native context for native mobile apps!');
115
+ });
116
+ it('should execute checkFullPageScreen with basic options', async () => {
117
+ const result = await checkFullPageScreen(baseOptions);
118
+ expect(result).toMatchSnapshot();
119
+ expect(saveFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
120
+ });
121
+ it('should handle Android device correctly', async () => {
122
+ const options = {
123
+ ...baseOptions,
124
+ browserInstance: { isAndroid: true },
125
+ instanceData: {
126
+ ...baseOptions.instanceData,
127
+ deviceName: 'Pixel 4',
128
+ isAndroid: true,
129
+ isIOS: false,
130
+ platformName: 'Android',
131
+ platformVersion: '11.0'
132
+ },
133
+ testContext: {
134
+ ...baseOptions.testContext,
135
+ instanceData: {
136
+ ...baseOptions.testContext.instanceData,
137
+ deviceName: 'Pixel 4',
138
+ platform: { name: 'Android', version: '11.0' },
139
+ isAndroid: true,
140
+ isIOS: false
141
+ }
142
+ }
143
+ };
144
+ await checkFullPageScreen(options);
145
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
146
+ });
147
+ it('should merge compare options correctly', async () => {
148
+ const options = {
149
+ ...baseOptions,
150
+ checkFullPageOptions: {
151
+ ...baseOptions.checkFullPageOptions,
152
+ wic: {
153
+ ...baseOptions.checkFullPageOptions.wic,
154
+ compareOptions: {
155
+ ...baseOptions.checkFullPageOptions.wic.compareOptions,
156
+ ignoreAlpha: true,
157
+ ignoreAntialiasing: true,
158
+ ignoreColors: true,
159
+ }
160
+ },
161
+ method: {
162
+ ...baseOptions.checkFullPageOptions.method,
163
+ disableBlinkingCursor: true,
164
+ disableCSSAnimation: true,
165
+ enableLayoutTesting: true,
166
+ }
167
+ }
168
+ };
169
+ await checkFullPageScreen(options);
170
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
171
+ });
172
+ it('should handle hideElements and removeElements correctly', async () => {
173
+ const mockElement1 = { elementId: 'hide-element', selector: '#hide' };
174
+ const mockElement2 = { elementId: 'remove-element', selector: '#remove' };
175
+ const options = {
176
+ ...baseOptions,
177
+ checkFullPageOptions: {
178
+ ...baseOptions.checkFullPageOptions,
179
+ method: {
180
+ ...baseOptions.checkFullPageOptions.method,
181
+ hideElements: [mockElement1],
182
+ removeElements: [mockElement2],
183
+ }
184
+ }
185
+ };
186
+ await checkFullPageScreen(options);
187
+ expect(saveFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
188
+ });
189
+ it('should handle hideAfterFirstScroll correctly', async () => {
190
+ const mockElement = { elementId: 'hide-element', selector: '#hide' };
191
+ const options = {
192
+ ...baseOptions,
193
+ checkFullPageOptions: {
194
+ ...baseOptions.checkFullPageOptions,
195
+ method: {
196
+ ...baseOptions.checkFullPageOptions.method,
197
+ hideAfterFirstScroll: [mockElement],
198
+ }
199
+ }
200
+ };
201
+ await checkFullPageScreen(options);
202
+ expect(saveFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
203
+ });
204
+ it('should handle all full page specific options', async () => {
205
+ const options = {
206
+ ...baseOptions,
207
+ checkFullPageOptions: {
208
+ ...baseOptions.checkFullPageOptions,
209
+ method: {
210
+ disableBlinkingCursor: true,
211
+ disableCSSAnimation: true,
212
+ enableLayoutTesting: true,
213
+ enableLegacyScreenshotMethod: true,
214
+ fullPageScrollTimeout: 2000,
215
+ hideAfterFirstScroll: [],
216
+ hideScrollBars: false,
217
+ hideElements: [],
218
+ removeElements: [],
219
+ waitForFontsLoaded: false,
220
+ }
221
+ }
222
+ };
223
+ await checkFullPageScreen(options);
224
+ expect(saveFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
225
+ });
226
+ it('should handle hybrid app options correctly', async () => {
227
+ const options = {
228
+ ...baseOptions,
229
+ checkFullPageOptions: {
230
+ ...baseOptions.checkFullPageOptions,
231
+ wic: {
232
+ ...baseOptions.checkFullPageOptions.wic,
233
+ isHybridApp: true
234
+ }
235
+ }
236
+ };
237
+ await checkFullPageScreen(options);
238
+ expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
239
+ });
240
+ it('should handle undefined method options with fallbacks', async () => {
241
+ const options = {
242
+ ...baseOptions,
243
+ checkFullPageOptions: {
244
+ ...baseOptions.checkFullPageOptions,
245
+ method: {
246
+ disableBlinkingCursor: false,
247
+ disableCSSAnimation: false,
248
+ enableLayoutTesting: false,
249
+ enableLegacyScreenshotMethod: false,
250
+ fullPageScrollTimeout: 1500,
251
+ hideScrollBars: true,
252
+ waitForFontsLoaded: true,
253
+ }
254
+ }
255
+ };
256
+ await checkFullPageScreen(options);
257
+ expect(saveFullPageScreenSpy.mock.calls[0]).toMatchSnapshot();
258
+ });
259
+ });
@@ -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 checkScreen({ browserInstance, checkScreenOptions, folders, instanceData, isNativeContext, tag, testContext, }: InternalCheckScreenMethodOptions): Promise<ImageCompareResult | number>;
7
+ //# sourceMappingURL=checkScreen.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkScreen.d.ts","sourceRoot":"","sources":["../../src/commands/checkScreen.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAGzE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAA;AAE7E;;GAEG;AACH,wBAA8B,WAAW,CACrC,EACI,eAAe,EACf,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,eAAe,EACf,GAAG,EACH,WAAW,GACd,EAAE,gCAAgC,GACpC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAItC"}
@@ -0,0 +1,10 @@
1
+ import checkAppScreen from './checkAppScreen.js';
2
+ import checkWebScreen from './checkWebScreen.js';
3
+ /**
4
+ * Compare an image of the viewport of the screen
5
+ */
6
+ export default async function checkScreen({ browserInstance, checkScreenOptions, folders, instanceData, isNativeContext, tag, testContext, }) {
7
+ return isNativeContext
8
+ ? checkAppScreen({ browserInstance, checkScreenOptions, folders, instanceData, isNativeContext, tag, testContext })
9
+ : checkWebScreen({ browserInstance, checkScreenOptions, folders, instanceData, isNativeContext, tag, testContext });
10
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=checkScreen.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkScreen.test.d.ts","sourceRoot":"","sources":["../../src/commands/checkScreen.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,62 @@
1
+ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
2
+ import checkScreen from './checkScreen.js';
3
+ import { BASE_CHECK_OPTIONS } from '../mocks/mocks.js';
4
+ vi.mock('./checkAppScreen.js', () => ({
5
+ default: vi.fn().mockResolvedValue({
6
+ fileName: 'test-app-screen.png',
7
+ misMatchPercentage: 0,
8
+ isExactSameImage: true,
9
+ isNewBaseline: false,
10
+ isAboveTolerance: false,
11
+ })
12
+ }));
13
+ vi.mock('./checkWebScreen.js', () => ({
14
+ default: vi.fn().mockResolvedValue({
15
+ fileName: 'test-web-screen.png',
16
+ misMatchPercentage: 0,
17
+ isExactSameImage: true,
18
+ isNewBaseline: false,
19
+ isAboveTolerance: false,
20
+ })
21
+ }));
22
+ describe('checkScreen', () => {
23
+ let checkAppScreenSpy;
24
+ let checkWebScreenSpy;
25
+ const baseOptions = {
26
+ checkScreenOptions: {
27
+ wic: BASE_CHECK_OPTIONS.wic,
28
+ method: {}
29
+ },
30
+ browserInstance: { isAndroid: false },
31
+ folders: BASE_CHECK_OPTIONS.folders,
32
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
33
+ isNativeContext: true,
34
+ tag: 'test-screen',
35
+ testContext: BASE_CHECK_OPTIONS.testContext
36
+ };
37
+ beforeEach(async () => {
38
+ const checkAppScreen = (await import('./checkAppScreen.js')).default;
39
+ const checkWebScreen = (await import('./checkWebScreen.js')).default;
40
+ checkAppScreenSpy = vi.mocked(checkAppScreen);
41
+ checkWebScreenSpy = vi.mocked(checkWebScreen);
42
+ });
43
+ afterEach(() => {
44
+ vi.clearAllMocks();
45
+ });
46
+ it('should call checkAppScreen when isNativeContext is true', async () => {
47
+ const result = await checkScreen(baseOptions);
48
+ expect(result).toMatchSnapshot();
49
+ expect(checkAppScreenSpy.mock.calls[0]).toMatchSnapshot();
50
+ expect(checkWebScreenSpy).not.toHaveBeenCalled();
51
+ });
52
+ it('should call checkWebScreen when isNativeContext is false', async () => {
53
+ const options = {
54
+ ...baseOptions,
55
+ isNativeContext: false
56
+ };
57
+ const result = await checkScreen(options);
58
+ expect(result).toMatchSnapshot();
59
+ expect(checkWebScreenSpy.mock.calls[0]).toMatchSnapshot();
60
+ expect(checkAppScreenSpy).not.toHaveBeenCalled();
61
+ });
62
+ });
@@ -0,0 +1,7 @@
1
+ import type { ImageCompareResult } from '../index.js';
2
+ import type { InternalCheckTabbablePageMethodOptions } from './check.interfaces.js';
3
+ /**
4
+ * Compare an image with all tab executions
5
+ */
6
+ export default function checkTabbablePage({ browserInstance, checkTabbableOptions, folders, instanceData, isNativeContext, tag, testContext, }: InternalCheckTabbablePageMethodOptions): Promise<ImageCompareResult | number>;
7
+ //# sourceMappingURL=checkTabbablePage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkTabbablePage.d.ts","sourceRoot":"","sources":["../../src/commands/checkTabbablePage.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,KAAK,EAAE,sCAAsC,EAAE,MAAM,uBAAuB,CAAA;AAEnF;;GAEG;AACH,wBAA8B,iBAAiB,CAC3C,EACI,eAAe,EACf,oBAAoB,EACpB,OAAO,EACP,YAAY,EACZ,eAAuB,EACvB,GAAG,EACH,WAAW,GACd,EAAE,sCAAsC,GAC1C,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAyBtC"}
@@ -0,0 +1,28 @@
1
+ import drawTabbableOnCanvas from '../clientSideScripts/drawTabbableOnCanvas.js';
2
+ import removeElementFromDom from '../clientSideScripts/removeElementFromDom.js';
3
+ import checkFullPageScreen from './checkFullPageScreen.js';
4
+ /**
5
+ * Compare an image with all tab executions
6
+ */
7
+ export default async function checkTabbablePage({ browserInstance, checkTabbableOptions, folders, instanceData, isNativeContext = false, tag, testContext, }) {
8
+ // 1a. Check if the method is supported in native context
9
+ if (isNativeContext) {
10
+ throw new Error('The method checkTabbablePage is not supported in native context for native mobile apps!');
11
+ }
12
+ // 1b. Inject drawing the tabbables
13
+ await browserInstance.execute(drawTabbableOnCanvas, checkTabbableOptions.wic.tabbableOptions);
14
+ // 2. Create the screenshot
15
+ const fullPageCompareData = await checkFullPageScreen({
16
+ browserInstance,
17
+ checkFullPageOptions: checkTabbableOptions,
18
+ instanceData,
19
+ folders,
20
+ isNativeContext,
21
+ testContext,
22
+ tag,
23
+ });
24
+ // 3. Remove the canvas
25
+ await browserInstance.execute(removeElementFromDom, 'wic-tabbable-canvas');
26
+ // 4. Return the data
27
+ return fullPageCompareData;
28
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=checkTabbablePage.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkTabbablePage.test.d.ts","sourceRoot":"","sources":["../../src/commands/checkTabbablePage.test.ts"],"names":[],"mappings":""}