@applitools/screenshoter 3.8.38 → 3.9.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [3.9.0](https://github.com/Applitools-Dev/sdk/compare/js/screenshoter@3.8.38...js/screenshoter@3.9.0) (2024-10-21)
+
+
+### Features
+
+* capture status bar ([#2571](https://github.com/Applitools-Dev/sdk/issues/2571)) ([5e1c75e](https://github.com/Applitools-Dev/sdk/commit/5e1c75ef9cf34af80f08806a3bceaf06a94f2780))
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.5.1
+  #### Bug Fixes
+
+  * isStaleElement error ([#2567](https://github.com/Applitools-Dev/sdk/issues/2567)) ([2675086](https://github.com/Applitools-Dev/sdk/commit/2675086aa28589082249e2958942ee29a5f2ef12))
+* @applitools/driver bumped to 1.19.3
+
+* @applitools/spec-driver-webdriver bumped to 1.1.15
+
+
 ## [3.8.38](https://github.com/Applitools-Dev/sdk/compare/js/screenshoter@3.8.37...js/screenshoter@3.8.38) (2024-10-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.8.38",
+  "version": "3.9.0",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -58,12 +58,12 @@
   "dependencies": {
     "@applitools/image": "1.1.13",
     "@applitools/logger": "2.0.18",
-    "@applitools/snippets": "2.5.0",
+    "@applitools/snippets": "2.5.1",
     "@applitools/utils": "1.7.4"
   },
   "devDependencies": {
-    "@applitools/driver": "^1.19.2",
-    "@applitools/spec-driver-webdriver": "^1.1.14",
+    "@applitools/driver": "^1.19.3",
+    "@applitools/spec-driver-webdriver": "^1.1.15",
     "@applitools/test-utils": "^1.5.17",
     "appium": "^1.22.3",
     "pixelmatch": "^5.3.0",

package/src/take-screenshot.js

@@ -14,7 +14,7 @@ async function takeScreenshot({
   scrollingMode,
   hideScrollbars,
   hideCaret,
-  withStatusBar,
+  captureStatusBar,
   overlap,
   framed,
   wait,
@@ -53,7 +53,7 @@ async function takeScreenshot({
   // framed screenshots could be taken only when screenshot of window/app fully was requested
   framed = framed && fully && window
   // screenshots with status bar could be taken only when screenshot of app or framed app fully was requested
-  withStatusBar = withStatusBar && environment.isNative && window && (!fully || framed)
+  captureStatusBar = captureStatusBar && environment.isNative && window && (!fully || framed)
   scrollingMode = !environment.isWeb ? 'scroll' : scrollingMode
 
   const activeContext = driver.currentContext
@@ -92,7 +92,7 @@ async function takeScreenshot({
     fully && target.scroller
       ? await takeStitchedScreenshot({
           ...target,
-          withStatusBar,
+          captureStatusBar,
           overlap,
           framed,
           wait,
@@ -101,7 +101,7 @@ async function takeScreenshot({
           logger,
           lazyLoad,
         })
-      : await takeSimpleScreenshot({...target, withStatusBar, wait, stabilization, debug, logger})
+      : await takeSimpleScreenshot({...target, captureStatusBar, wait, stabilization, debug, logger})
 
   const viewport = await driver.getViewport()
 

package/src/take-simple-screenshot.js

@@ -1,7 +1,7 @@
 const utils = require('@applitools/utils')
 const makeTakeViewportScreenshot = require('./take-viewport-screenshot')
 
-async function takeSimpleScreenshot({context, region, withStatusBar, wait, stabilization, debug = {}, logger}) {
+async function takeSimpleScreenshot({context, region, captureStatusBar, wait, stabilization, debug = {}, logger}) {
   logger.verbose('Taking image of...')
 
   const driver = context.driver
@@ -9,7 +9,7 @@ async function takeSimpleScreenshot({context, region, withStatusBar, wait, stabi
 
   await utils.general.sleep(wait)
 
-  const image = await takeViewportScreenshot({withStatusBar})
+  const image = await takeViewportScreenshot({captureStatusBar})
 
   if (region) {
     const cropRegion = await driver.getRegionInViewport(context, region)

package/src/take-stitched-screenshot.js

@@ -8,7 +8,7 @@ async function takeStitchedScreenshot({
   context,
   scroller,
   region,
-  withStatusBar,
+  captureStatusBar,
   overlap = {top: 10, bottom: 50},
   framed,
   wait,
@@ -48,7 +48,7 @@ async function takeStitchedScreenshot({
   )
 
   logger.verbose('Getting initial image...')
-  let image = await takeViewportScreenshot({name: 'initial', withStatusBar})
+  let image = await takeViewportScreenshot({name: 'initial', captureStatusBar})
   const firstImage = framed ? makeImage(image) : null
 
   const scrollerRegion = await scroller.getClientRegion()
@@ -61,7 +61,7 @@ async function takeStitchedScreenshot({
   logger.log('Crop region calculated: ', cropRegion)
   if (utils.geometry.isEmpty(cropRegion)) throw new Error('Screenshot region is out of viewport')
 
-  image.crop(withStatusBar ? utils.geometry.offset(cropRegion, {x: 0, y: viewport.statusBarSize}) : cropRegion)
+  image.crop(captureStatusBar ? utils.geometry.offset(cropRegion, {x: 0, y: viewport.statusBarSize}) : cropRegion)
   await image.debug({...debug, name: 'initial', suffix: 'region'})
 
   const contentRegion = utils.geometry.region({x: 0, y: 0}, contentSize)
@@ -158,7 +158,7 @@ async function takeStitchedScreenshot({
     stitchedImage.frame(
       firstImage,
       lastImage,
-      withStatusBar ? utils.geometry.offset(cropRegion, {x: 0, y: viewport.statusBarSize}) : cropRegion,
+      captureStatusBar ? utils.geometry.offset(cropRegion, {x: 0, y: viewport.statusBarSize}) : cropRegion,
     )
     await stitchedImage.debug({...debug, name: 'framed'})
 

package/src/take-viewport-screenshot.js

@@ -150,7 +150,7 @@ function makeTakeMarkedScreenshot({driver, stabilization = {}, debug, logger}) {
 }
 
 function makeTakeNativeScreenshot({driver, stabilization = {}, debug, logger}) {
-  return async function takeScreenshot({name, withStatusBar} = {}) {
+  return async function takeScreenshot({name, captureStatusBar} = {}) {
     logger.verbose('Taking native driver screenshot...')
     const viewport = await driver.getViewport()
     const image = makeImage(await driver.takeScreenshot())
@@ -165,7 +165,7 @@ function makeTakeNativeScreenshot({driver, stabilization = {}, debug, logger}) {
     if (stabilization.crop) image.crop(stabilization.crop)
     else {
       const cropRegion = {...viewport.viewportLocation, ...viewport.viewportSize}
-      if (withStatusBar) {
+      if (captureStatusBar) {
         cropRegion.y = 0
         cropRegion.height += viewport.statusBarSize
       }
@@ -175,7 +175,7 @@ function makeTakeNativeScreenshot({driver, stabilization = {}, debug, logger}) {
     await image.debug({
       ...debug,
       name,
-      suffix: `viewport${withStatusBar ? '-with-statusbar' : ''}`,
+      suffix: `viewport${captureStatusBar ? '-with-statusbar' : ''}`,
     })
 
     return image