@applitools/screenshoter 3.4.16 → 3.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.4.16",
+  "version": "3.5.0",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -81,10 +81,10 @@
   },
   "devDependencies": {
     "@applitools/bongo": "^2.1.6",
-    "@applitools/driver": "^1.9.21",
+    "@applitools/driver": "^1.9.23",
     "@applitools/scripts": "^1.1.0",
     "@applitools/spec-driver-webdriverio": "^1.2.19",
-    "@applitools/test-utils": "^1.4.3",
+    "@applitools/test-utils": "^1.5.0",
     "appium": "^1.22.3",
     "chromedriver": "^101.0.0",
     "eslint": "^8.16.0",

package/src/extract-coodinates-for-selectors-and-elements.js

@@ -0,0 +1,35 @@
+const utils = require('@applitools/utils')
+
+async function extractCoodinatesForSelectorsAndElements({regionsToCalculate, screenshot, context}) {
+  const codedRegionsByCoordinates = []
+  for (const codedRegion of regionsToCalculate) {
+    if (codedRegion) {
+      const {region} = codedRegion.region ? codedRegion : {region: codedRegion}
+      const elements = await context.elements(region)
+      if (elements.length > 0) {
+        const contextLocationInViewport = await elements[0].context.getLocationInViewport()
+        const scaledRegions = []
+        for (const element of elements) {
+          const elementRegion = await element.getRegion()
+          const region = utils.geometry.offset(elementRegion, contextLocationInViewport)
+          const scaledRegion = utils.geometry.scale(
+            {
+              x: Math.max(0, region.x - screenshot.region.x),
+              y: Math.max(0, region.y - screenshot.region.y),
+              width: region.width,
+              height: region.height,
+            },
+            context.driver.viewportScale,
+          )
+          scaledRegions.push({region: scaledRegion})
+        }
+        codedRegionsByCoordinates.push({regions: scaledRegions, commonSelector: elements[0].commonSelector})
+      } else {
+        codedRegionsByCoordinates.push({regions: []})
+      }
+    }
+  }
+  return codedRegionsByCoordinates
+}
+
+module.exports = extractCoodinatesForSelectorsAndElements

package/src/take-screenshot.js

@@ -3,11 +3,13 @@ const getTarget = require('./get-target')
 const scrollIntoViewport = require('./scroll-into-viewport')
 const takeStitchedScreenshot = require('./take-stitched-screenshot')
 const takeSimpleScreenshot = require('./take-simple-screenshot')
+const extractCoodinatesForSelectorsAndElements = require('./extract-coodinates-for-selectors-and-elements')
 
 async function takeScreenshot({
   driver,
   frames = [],
   region,
+  regionsToCalculate = [],
   fully,
   scrollingMode,
   hideScrollbars,
@@ -62,6 +64,8 @@ async function takeScreenshot({
   }
 
   try {
+    // TODO: identify spot in this function to call to takeScreenshot in the nml-client
+    // if running on native mobile and the user has enabled NML
     if (!window && !driver.isNative) await scrollIntoViewport({...target, logger})
 
     if (fully && !target.region && target.scroller) await target.scroller.moveTo({x: 0, y: 0})
@@ -82,11 +86,13 @@ async function takeScreenshot({
 
     screenshot.image.scale(driver.viewportScale)
 
+    const caltulatedRegions = await extractCoodinatesForSelectorsAndElements({regionsToCalculate, screenshot, context})
+
     if (hooks && hooks.afterScreenshot) {
       await hooks.afterScreenshot({driver, scroller: target.scroller, screenshot})
     }
 
-    return screenshot
+    return {screenshot, caltulatedRegions}
   } finally {
     if (target.scroller) {
       await target.scroller.restoreScrollbars()