@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 @@
1
+ {"version":3,"file":"mocks.d.ts","sourceRoot":"","sources":["../../src/mocks/mocks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAA;AACxF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAE/E,eAAO,MAAM,yBAAyB,EAAE,uBAoCvC,CAAA;AACD,eAAO,MAAM,YAAY;;;CAGxB,CAAA;AACD,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;CAqBlC,CAAA;AACD,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;CAmB3B,CAAA;AACD,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiEvB,CAAA;AACD,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkG9B,CAAA;AACD,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuDlC,CAAA;AACD,eAAO,MAAM,qBAAqB;;;CAGjC,CAAA;AACD,eAAO,MAAM,qBAAqB;;;;;;;;;CASjC,CAAA;AACD,eAAO,MAAM,0BAA0B,GAAI,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGvD,CAAA;AACF,eAAO,MAAM,yBAAyB,GAAI,cAAc;;;CAGtD,CAAA;AACF,eAAO,MAAM,mBAAmB,GAAI,cAAc;;;;;;;;;CAGhD,CAAA;AACF,eAAO,MAAM,iBAAiB,GAAI,MAAM,QAAQ,GAAG,SAAS,EAAE,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAK/D,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAAH,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyBf,CAAA;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,yBAAyB,EACjE,WAAW,EAAE,CAAC,EACd,SAAS,GAAE,OAAO,CAAC,CAAC,CAAM,GAC3B,CAAC,CAmCH"}
@@ -0,0 +1,392 @@
1
+ export const BEFORE_SCREENSHOT_OPTIONS = {
2
+ instanceData: {
3
+ appName: 'chrome-app',
4
+ browserName: 'chrome',
5
+ browserVersion: '75.0.1',
6
+ deviceName: '',
7
+ devicePixelRatio: 1,
8
+ initialDevicePixelRatio: 1,
9
+ deviceRectangles: {
10
+ statusBar: { y: 0, x: 0, width: 0, height: 0 },
11
+ homeBar: { y: 0, x: 0, width: 0, height: 0 },
12
+ screenSize: { height: 0, width: 0 },
13
+ statusBarAndAddressBar: { y: 0, x: 0, width: 0, height: 0 },
14
+ viewport: { y: 0, x: 0, width: 0, height: 0 },
15
+ bottomBar: { y: 0, x: 0, width: 0, height: 0 },
16
+ leftSidePadding: { y: 0, x: 0, width: 0, height: 0 },
17
+ rightSidePadding: { y: 0, x: 0, width: 0, height: 0 },
18
+ },
19
+ isAndroid: false,
20
+ isIOS: false,
21
+ isMobile: false,
22
+ logName: 'chrome-latest',
23
+ name: 'chrome-name',
24
+ nativeWebScreenshot: true,
25
+ platformName: 'Windows 10',
26
+ platformVersion: '1234',
27
+ },
28
+ addressBarShadowPadding: 6,
29
+ disableBlinkingCursor: true,
30
+ disableCSSAnimation: true,
31
+ enableLayoutTesting: false,
32
+ noScrollBars: true,
33
+ toolBarShadowPadding: 6,
34
+ hideElements: ['<div></div>'],
35
+ removeElements: ['<div></div>'],
36
+ waitForFontsLoaded: true,
37
+ };
38
+ export const CONFIGURABLE = {
39
+ writable: true,
40
+ configurable: true,
41
+ };
42
+ export const NAVIGATOR_APP_VERSIONS = {
43
+ ANDROID: {
44
+ 7: '5.0 (Linux; Android 7.1.1; Android SDK built for x86 Build/NYC) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.91 Mobile Safari/537.3',
45
+ 8: '5.0 (Linux; Android 8.1; Android SDK built for x86 Build/NYC) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.91 Mobile Safari/537.3',
46
+ 9: '5.0 (Linux; Android 9; Android SDK built for x86 Build/NYC) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.91 Mobile Safari/537.3',
47
+ 10: '5.0 (Linux; Android 10; Android SDK built for x86 Build/NYC) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.91 Mobile Safari/537.3',
48
+ 11: '5.0 (Linux; Android 11; Android SDK built for x86 Build/NYC) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.91 Mobile Safari/537.3',
49
+ },
50
+ IOS: {
51
+ 10: '5.0 (iPhone; CPU iPhone OS 10_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/10.0 Mobile/15E148 Safari/604.1',
52
+ 11: '5.0 (iPhone; CPU iPhone OS 11_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.0 Mobile/15E148 Safari/604.1',
53
+ 12: '5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1',
54
+ 13: '5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0 Mobile/15E148 Safari/604.1',
55
+ 14: '5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1',
56
+ 15: '5.0 (iPhone; CPU iPhone OS 15_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.0 Mobile/15E148 Safari/604.1',
57
+ },
58
+ IPADOS: {
59
+ 13: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.1 Safari/605.1.15',
60
+ 14: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Safari/605.1.15',
61
+ 15: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.0 Safari/605.1.15',
62
+ },
63
+ };
64
+ export const ANDROID_DEVICES = {
65
+ NEXUS_5X: {
66
+ height: 732,
67
+ width: 412,
68
+ innerHeight: 604,
69
+ innerWidth: 412,
70
+ },
71
+ NEXUS_5X_INNER_HEIGHT: {
72
+ height: 732,
73
+ width: 412,
74
+ innerHeight: 800,
75
+ innerWidth: 412,
76
+ },
77
+ TABLET_WIDTH: {
78
+ height: 768,
79
+ width: 1024,
80
+ innerHeight: 604,
81
+ innerWidth: 412,
82
+ },
83
+ };
84
+ export const IOS_DEVICES = {
85
+ IPHONE: {
86
+ height: 667,
87
+ width: 375,
88
+ innerHeight: 553,
89
+ innerWidth: 375,
90
+ scrollWidth: 375,
91
+ sideBar: 0,
92
+ },
93
+ IPHONE_X: {
94
+ height: 812,
95
+ width: 375,
96
+ innerHeight: 635,
97
+ innerWidth: 375,
98
+ scrollWidth: 375,
99
+ sideBar: 0,
100
+ },
101
+ IPHONE_HEIGHT: {
102
+ height: 896,
103
+ width: 1024,
104
+ innerHeight: 719,
105
+ innerWidth: 414,
106
+ scrollWidth: 414,
107
+ sideBar: 0,
108
+ },
109
+ IPHONE_11: {
110
+ height: 896,
111
+ width: 375,
112
+ innerHeight: 635,
113
+ innerWidth: 375,
114
+ scrollWidth: 375,
115
+ sideBar: 0,
116
+ },
117
+ IPAD: {
118
+ height: 1366,
119
+ width: 1024,
120
+ innerHeight: 1292,
121
+ innerWidth: 1024,
122
+ scrollWidth: 1024,
123
+ sideBar: 0,
124
+ },
125
+ IPAD_LANDSCAPE: {
126
+ height: 1366,
127
+ width: 1024,
128
+ innerHeight: 746,
129
+ innerWidth: 1046,
130
+ scrollWidth: 1046,
131
+ sideBar: 320,
132
+ },
133
+ IPAD_BIG_SIZE: {
134
+ height: 5432,
135
+ width: 9876,
136
+ innerHeight: 5324,
137
+ innerWidth: 9768,
138
+ scrollWidth: 9768,
139
+ sideBar: 108,
140
+ },
141
+ IPAD_PRO_LANDSCAPE: {
142
+ height: 1366,
143
+ width: 1024,
144
+ innerHeight: 954,
145
+ innerWidth: 1046,
146
+ scrollWidth: 1046,
147
+ sideBar: 320,
148
+ },
149
+ };
150
+ export const BASE_CHECK_OPTIONS = {
151
+ wic: {
152
+ addressBarShadowPadding: 6,
153
+ autoElementScroll: true,
154
+ addIOSBezelCorners: false,
155
+ autoSaveBaseline: false,
156
+ clearFolder: false,
157
+ userBasedFullPageScreenshot: false,
158
+ enableLegacyScreenshotMethod: false,
159
+ formatImageName: '{tag}-{logName}-{width}x{height}-dpr-{dpr}',
160
+ isHybridApp: false,
161
+ savePerInstance: true,
162
+ toolBarShadowPadding: 6,
163
+ disableBlinkingCursor: false,
164
+ disableCSSAnimation: false,
165
+ enableLayoutTesting: false,
166
+ fullPageScrollTimeout: 1500,
167
+ hideScrollBars: true,
168
+ waitForFontsLoaded: true,
169
+ compareOptions: {
170
+ ignoreAlpha: false,
171
+ ignoreAntialiasing: false,
172
+ ignoreColors: false,
173
+ ignoreLess: false,
174
+ ignoreNothing: false,
175
+ rawMisMatchPercentage: false,
176
+ returnAllCompareData: false,
177
+ saveAboveTolerance: 0,
178
+ scaleImagesToSameSize: false,
179
+ blockOutSideBar: false,
180
+ blockOutStatusBar: false,
181
+ blockOutToolBar: false,
182
+ createJsonReportFiles: false,
183
+ diffPixelBoundingBoxProximity: 5,
184
+ },
185
+ tabbableOptions: {
186
+ circle: {
187
+ backgroundColor: 'rgba(255, 0, 0, 0.4)',
188
+ borderColor: 'rgba(255, 0, 0, 1)',
189
+ borderWidth: 1,
190
+ fontColor: 'rgba(0, 0, 0, 1)',
191
+ fontFamily: 'Arial',
192
+ fontSize: 10,
193
+ size: 10,
194
+ },
195
+ line: {
196
+ color: 'rgba(255, 0, 0, 1)',
197
+ width: 1,
198
+ },
199
+ }
200
+ },
201
+ instanceData: {
202
+ appName: 'TestApp',
203
+ browserName: 'Chrome',
204
+ browserVersion: '118.0.0.0',
205
+ deviceName: 'iPhone 14',
206
+ devicePixelRatio: 2,
207
+ deviceRectangles: {
208
+ bottomBar: { y: 800, x: 0, width: 390, height: 0 },
209
+ homeBar: { x: 0, y: 780, width: 390, height: 34 },
210
+ leftSidePadding: { y: 0, x: 0, width: 0, height: 0 },
211
+ rightSidePadding: { y: 0, x: 0, width: 0, height: 0 },
212
+ screenSize: { height: 844, width: 390 },
213
+ statusBar: { x: 0, y: 0, width: 390, height: 47 },
214
+ statusBarAndAddressBar: { y: 0, x: 0, width: 390, height: 47 },
215
+ viewport: { y: 47, x: 0, width: 390, height: 733 }
216
+ },
217
+ initialDevicePixelRatio: 2,
218
+ isAndroid: false,
219
+ isIOS: true,
220
+ isMobile: true,
221
+ logName: 'test-log',
222
+ name: 'test-device',
223
+ nativeWebScreenshot: false,
224
+ platformName: 'iOS',
225
+ platformVersion: '17.0'
226
+ },
227
+ folders: {
228
+ actualFolder: '/test/actual',
229
+ baselineFolder: '/test/baseline',
230
+ diffFolder: '/test/diff'
231
+ },
232
+ testContext: {
233
+ commandName: 'checkScreen',
234
+ framework: 'vitest',
235
+ parent: 'test suite',
236
+ title: 'test title',
237
+ tag: 'test-tag',
238
+ instanceData: {
239
+ browser: { name: 'Chrome', version: '118.0.0.0' },
240
+ deviceName: 'iPhone 14',
241
+ platform: { name: 'iOS', version: '17.0' },
242
+ app: 'TestApp',
243
+ isMobile: true,
244
+ isAndroid: false,
245
+ isIOS: true
246
+ }
247
+ }
248
+ };
249
+ export const BEFORE_SCREENSHOT_MOCK = {
250
+ browserName: 'chrome',
251
+ browserVersion: '120.0.0',
252
+ deviceName: 'desktop',
253
+ dimensions: {
254
+ body: {
255
+ scrollHeight: 1000,
256
+ offsetHeight: 1000
257
+ },
258
+ html: {
259
+ clientWidth: 1200,
260
+ scrollWidth: 1200,
261
+ clientHeight: 900,
262
+ scrollHeight: 1000,
263
+ offsetHeight: 1000
264
+ },
265
+ window: {
266
+ devicePixelRatio: 2,
267
+ innerHeight: 900,
268
+ innerWidth: 1200,
269
+ isEmulated: false,
270
+ isLandscape: false,
271
+ outerHeight: 1000,
272
+ outerWidth: 1200,
273
+ screenHeight: 1080,
274
+ screenWidth: 1920,
275
+ },
276
+ },
277
+ isAndroid: false,
278
+ isAndroidChromeDriverScreenshot: false,
279
+ isAndroidNativeWebScreenshot: false,
280
+ isIOS: false,
281
+ isMobile: false,
282
+ isTestInBrowser: true,
283
+ isTestInMobileBrowser: false,
284
+ addressBarShadowPadding: 0,
285
+ toolBarShadowPadding: 0,
286
+ appName: '',
287
+ logName: 'chrome',
288
+ name: 'chrome',
289
+ platformName: 'desktop',
290
+ platformVersion: '120.0.0',
291
+ devicePixelRatio: 2,
292
+ deviceRectangles: {
293
+ bottomBar: { height: 0, width: 0, x: 0, y: 0 },
294
+ homeBar: { height: 0, width: 0, x: 0, y: 0 },
295
+ leftSidePadding: { height: 0, width: 0, x: 0, y: 0 },
296
+ rightSidePadding: { height: 0, width: 0, x: 0, y: 0 },
297
+ screenSize: { height: 0, width: 0 },
298
+ statusBar: { height: 0, width: 0, x: 0, y: 0 },
299
+ statusBarAndAddressBar: { height: 0, width: 0, x: 0, y: 0 },
300
+ viewport: { height: 0, width: 0, x: 0, y: 0 }
301
+ },
302
+ initialDevicePixelRatio: 2,
303
+ nativeWebScreenshot: false
304
+ };
305
+ export const AFTER_SCREENSHOT_MOCK = {
306
+ devicePixelRatio: 2,
307
+ fileName: 'test-screen.png'
308
+ };
309
+ export const COMMON_METHOD_OPTIONS = {
310
+ disableBlinkingCursor: false,
311
+ disableCSSAnimation: false,
312
+ enableLayoutTesting: false,
313
+ enableLegacyScreenshotMethod: false,
314
+ hideScrollBars: true,
315
+ hideElements: [],
316
+ removeElements: [],
317
+ waitForFontsLoaded: true,
318
+ };
319
+ export const createBeforeScreenshotMock = (overrides = {}) => ({
320
+ ...BEFORE_SCREENSHOT_MOCK,
321
+ ...overrides
322
+ });
323
+ export const createAfterScreenshotMock = (overrides = {}) => ({
324
+ ...AFTER_SCREENSHOT_MOCK,
325
+ ...overrides
326
+ });
327
+ export const createMethodOptions = (overrides = {}) => ({
328
+ ...COMMON_METHOD_OPTIONS,
329
+ ...overrides
330
+ });
331
+ export const createBaseOptions = (type, overrides = {}) => {
332
+ const baseOptions = {
333
+ browserInstance: {
334
+ isAndroid: false,
335
+ isMobile: false
336
+ },
337
+ folders: BASE_CHECK_OPTIONS.folders,
338
+ instanceData: BASE_CHECK_OPTIONS.instanceData,
339
+ tag: `test-${type}`
340
+ };
341
+ if (type === 'screen') {
342
+ return {
343
+ ...baseOptions,
344
+ saveScreenOptions: {
345
+ wic: BASE_CHECK_OPTIONS.wic,
346
+ method: COMMON_METHOD_OPTIONS
347
+ },
348
+ ...overrides
349
+ };
350
+ }
351
+ return {
352
+ ...baseOptions,
353
+ saveElementOptions: {
354
+ wic: BASE_CHECK_OPTIONS.wic,
355
+ method: COMMON_METHOD_OPTIONS
356
+ },
357
+ ...overrides
358
+ };
359
+ };
360
+ export function createTestOptions(baseOptions, overrides = {}) {
361
+ const result = {
362
+ ...baseOptions,
363
+ ...overrides
364
+ };
365
+ if ('saveScreenOptions' in baseOptions && 'saveScreenOptions' in result) {
366
+ const baseScreenOptions = baseOptions.saveScreenOptions;
367
+ const overrideScreenOptions = overrides.saveScreenOptions || {};
368
+ result.saveScreenOptions = {
369
+ ...baseScreenOptions,
370
+ ...overrideScreenOptions,
371
+ wic: {
372
+ ...BASE_CHECK_OPTIONS.wic,
373
+ ...(baseScreenOptions?.wic || {}),
374
+ ...(overrideScreenOptions?.wic || {})
375
+ }
376
+ };
377
+ }
378
+ if ('saveElementOptions' in baseOptions && 'saveElementOptions' in result) {
379
+ const baseElementOptions = baseOptions.saveElementOptions;
380
+ const overrideElementOptions = overrides.saveElementOptions || {};
381
+ result.saveElementOptions = {
382
+ ...baseElementOptions,
383
+ ...overrideElementOptions,
384
+ wic: {
385
+ ...BASE_CHECK_OPTIONS.wic,
386
+ ...(baseElementOptions?.wic || {}),
387
+ ...(overrideElementOptions?.wic || {})
388
+ }
389
+ };
390
+ }
391
+ return result;
392
+ }
@@ -0,0 +1,136 @@
1
+ import type { BaseBoundingBox, BaseCoordinates, BaseDimensions } from '../base.interfaces.js';
2
+ export interface CompareData {
3
+ /** The mismatch percentage like 0.12345567 */
4
+ rawMisMatchPercentage: number;
5
+ /** The mismatch percentage like 0.12 */
6
+ misMatchPercentage: number;
7
+ /** The image buffer */
8
+ getBuffer: () => Buffer;
9
+ /** The bounds of the diff area */
10
+ diffBounds: BaseBoundingBox;
11
+ /** The analysis time in milliseconds */
12
+ analysisTime: number;
13
+ /** The diff pixels location(s) and color(s) */
14
+ diffPixels: BaseCoordinates[];
15
+ }
16
+ /**
17
+ * Src: @types/resemblejs
18
+ */
19
+ type OutputSettings = {
20
+ /** Color to use for highlighting errors */
21
+ errorColor?: {
22
+ /** Red color component (0-255) */
23
+ red: number;
24
+ /** Green color component (0-255) */
25
+ green: number;
26
+ /** Blue color component (0-255) */
27
+ blue: number;
28
+ } | undefined;
29
+ /** Type of error highlighting to use */
30
+ errorType?: OutputErrorType | undefined;
31
+ /** Custom error pixel processing function */
32
+ errorPixel?: ((px: number[], offset: number, d1: Color, d2: Color) => void) | undefined;
33
+ /** Transparency level for the output image */
34
+ transparency?: number | undefined;
35
+ /** Threshold for large image processing */
36
+ largeImageThreshold?: number | undefined;
37
+ /** Whether to use cross-origin for image loading */
38
+ useCrossOrigin?: boolean | undefined;
39
+ /** Bounding box to focus comparison on */
40
+ boundingBox?: Box | undefined;
41
+ /** Box area to ignore during comparison */
42
+ ignoredBox?: Box | undefined;
43
+ /** Multiple bounding boxes to focus comparison on */
44
+ boundingBoxes?: Box[] | undefined;
45
+ /** Multiple box areas to ignore during comparison */
46
+ ignoredBoxes?: Box[] | undefined;
47
+ /** Color to ignore during comparison */
48
+ ignoreAreasColoredWith?: Color | undefined;
49
+ };
50
+ type Box = {
51
+ /** Left boundary of the box */
52
+ left: number;
53
+ /** Top boundary of the box */
54
+ top: number;
55
+ /** Right boundary of the box */
56
+ right: number;
57
+ /** Bottom boundary of the box */
58
+ bottom: number;
59
+ };
60
+ type Color = {
61
+ /** Red color component (0-255) */
62
+ r: number;
63
+ /** Green color component (0-255) */
64
+ g: number;
65
+ /** Blue color component (0-255) */
66
+ b: number;
67
+ /** Alpha transparency component (0-255) */
68
+ a: number;
69
+ };
70
+ type Tolerance = {
71
+ /** Tolerance for red color component */
72
+ red?: number;
73
+ /** Tolerance for green color component */
74
+ green?: number;
75
+ /** Tolerance for blue color component */
76
+ blue?: number;
77
+ /** Tolerance for alpha transparency component */
78
+ alpha?: number;
79
+ /** Minimum brightness tolerance */
80
+ minBrightness?: number;
81
+ /** Maximum brightness tolerance */
82
+ maxBrightness?: number;
83
+ };
84
+ type OutputErrorType = 'flat' | 'movement' | 'flatDifferenceIntensity' | 'movementDifferenceIntensity' | 'diffOnly';
85
+ export type ComparisonIgnoreOption = 'nothing' | 'less' | 'antialiasing' | 'colors' | 'alpha';
86
+ export interface ComparisonOptions {
87
+ /** Output settings for the comparison */
88
+ output?: OutputSettings | undefined;
89
+ /** Threshold to return early if mismatch exceeds this value */
90
+ returnEarlyThreshold?: number | undefined;
91
+ /** Whether to scale images to the same size before comparison */
92
+ scaleToSameSize?: boolean | undefined;
93
+ /** What aspects to ignore during comparison */
94
+ ignore?: ComparisonIgnoreOption | ComparisonIgnoreOption[] | undefined;
95
+ /** Tolerance settings for color differences */
96
+ tolerance?: Tolerance | undefined;
97
+ }
98
+ export interface ComparisonResult {
99
+ /**
100
+ * Error information if error encountered
101
+ *
102
+ * Note: If error encountered, other properties will be undefined
103
+ */
104
+ error?: unknown | undefined;
105
+ /**
106
+ * Time consumed by the comparison (in milliseconds)
107
+ */
108
+ analysisTime: number;
109
+ /**
110
+ * Do the two images have the same dimensions?
111
+ */
112
+ isSameDimensions: boolean;
113
+ /**
114
+ * The difference in width and height between the dimensions of the two compared images
115
+ */
116
+ dimensionDifference: BaseDimensions;
117
+ /**
118
+ * The percentage of pixels which do not match between the images
119
+ */
120
+ rawMisMatchPercentage: number;
121
+ /**
122
+ * Same as `rawMisMatchPercentage` but fixed to 2-digit after the decimal point
123
+ */
124
+ misMatchPercentage: number;
125
+ diffBounds: Box;
126
+ /**
127
+ * Get a data URL for the comparison image
128
+ */
129
+ getImageDataUrl(): string;
130
+ /**
131
+ * Get data buffer
132
+ */
133
+ getBuffer?: (includeOriginal: boolean) => Buffer;
134
+ }
135
+ export {};
136
+ //# sourceMappingURL=compare.interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"compare.interfaces.d.ts","sourceRoot":"","sources":["../../src/resemble/compare.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAE7F,MAAM,WAAW,WAAW;IACxB,8CAA8C;IAC9C,qBAAqB,EAAE,MAAM,CAAC;IAC9B,wCAAwC;IACxC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB;IACvB,SAAS,EAAE,MAAM,MAAM,CAAC;IACxB,kCAAkC;IAClC,UAAU,EAAE,eAAe,CAAC;IAC5B,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC3C,UAAU,EAAE,eAAe,EAAE,CAAC;CAErC;AAED;;GAEG;AACH,KAAK,cAAc,GAAG;IAClB,2CAA2C;IAC3C,UAAU,CAAC,EACL;QACE,kCAAkC;QAClC,GAAG,EAAE,MAAM,CAAC;QACZ,oCAAoC;QACpC,KAAK,EAAE,MAAM,CAAC;QACd,mCAAmC;QACnC,IAAI,EAAE,MAAM,CAAC;KAChB,GACC,SAAS,CAAC;IAChB,wCAAwC;IACxC,SAAS,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACxC,6CAA6C;IAC7C,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IACxF,8CAA8C;IAC9C,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,2CAA2C;IAC3C,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,oDAAoD;IACpD,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC,0CAA0C;IAC1C,WAAW,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IAC9B,2CAA2C;IAC3C,UAAU,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IAC7B,qDAAqD;IACrD,aAAa,CAAC,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC;IAClC,qDAAqD;IACrD,YAAY,CAAC,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC;IACjC,wCAAwC;IACxC,sBAAsB,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;CAC9C,CAAC;AAEF,KAAK,GAAG,GAAG;IACP,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,KAAK,KAAK,GAAG;IACT,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,oCAAoC;IACpC,CAAC,EAAE,MAAM,CAAC;IACV,mCAAmC;IACnC,CAAC,EAAE,MAAM,CAAC;IACV,2CAA2C;IAC3C,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,wCAAwC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,KAAK,eAAe,GAAG,MAAM,GAAG,UAAU,GAAG,yBAAyB,GAAG,6BAA6B,GAAG,UAAU,CAAC;AAEpH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,MAAM,GAAG,cAAc,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC9F,MAAM,WAAW,iBAAiB;IAC9B,yCAAyC;IACzC,MAAM,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACpC,+DAA+D;IAC/D,oBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,iEAAiE;IACjE,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,MAAM,CAAC,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,GAAG,SAAS,CAAC;IACvE,+CAA+C;IAC/C,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CACrC;AACD,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,mBAAmB,EAAE,cAAc,CAAC;IAEpC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B,UAAU,EAAE,GAAG,CAAC;IAEhB;;OAEG;IACH,eAAe,IAAI,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,eAAe,EAAE,OAAO,KAAK,MAAM,CAAC;CACpD"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,3 @@
1
+ import type { CompareData, ComparisonOptions } from './compare.interfaces.js';
2
+ export default function compareImages(image1: Buffer, image2: Buffer, options: ComparisonOptions): Promise<CompareData>;
3
+ //# sourceMappingURL=compareImages.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"compareImages.d.ts","sourceRoot":"","sources":["../../src/resemble/compareImages.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAE7E,wBAA8B,aAAa,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,GAC3B,OAAO,CAAC,WAAW,CAAC,CAmBtB"}
@@ -0,0 +1,21 @@
1
+ // @ts-ignore: Ignoring type checking for this module import
2
+ import * as resembleJimp from './resemble.jimp.cjs';
3
+ export default async function compareImages(image1, image2, options) {
4
+ /**
5
+ * Resemble.js implemented in the way that scales 2nd images to the size of 1st.
6
+ * Experimentally proven that downscaling images produces more accurate result than upscaling
7
+ */
8
+ const { imageToCompare1, imageToCompare2 } = options.scaleToSameSize && image1.length > image2.length
9
+ ? {
10
+ imageToCompare1: image2,
11
+ imageToCompare2: image1,
12
+ }
13
+ : { imageToCompare1: image1, imageToCompare2: image2 };
14
+ try {
15
+ const data = await resembleJimp.default.compare(imageToCompare1, imageToCompare2, options);
16
+ return data;
17
+ }
18
+ catch (err) {
19
+ throw err;
20
+ }
21
+ }