@applitools/eyes-webdriverio 5.42.0 → 5.42.2

package/CHANGELOG.md

@@ -10,6 +10,18 @@
 
 
 
+## 5.42.2 - 2023/3/7
+
+### Features
+- Added `Resize` value to `StitchMode` enum
+### Bug fixes
+
+## 5.42.1 - 2023/3/7
+
+### Features
+- Added support for scroll root elements in ufg (only for native apps)
+### Bug fixes
+
 ## 5.42.0 - 2023/2/17
 
 ### Features

package/README.md

@@ -397,6 +397,23 @@ eyes.check(Target.webview('webview-id'))
 
 After the check command, the SDK will switch the driver back to the app context that it was prior to performing the check.
 
+##### Density metrics (`densityMetrics`)
+
+In order to set the density metrics for the screenshot, use the `densityMetrics` method. This method accepts a object value with the following properties:
+
+- `xdpi` - The exact physical pixels per inch of the screen in the X dimension.
+- `ydpi` - The exact physical pixels per inch of the screen in the Y dimension.
+- `scaleRatio` - The scale ratio.
+
+```js
+// set density metrics
+eyes.check(Target.window().densityMetrics({
+  xdpi: 100,
+  ydpi: 100,
+  scaleRatio: 1
+}))
+```
+
 ###### Other checkSettings configuration
 
 <!-- TODO add explanation -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-webdriverio",
-  "version": "5.42.0",
+  "version": "5.42.2",
   "description": "Applitools Eyes SDK for WebdriverIO",
   "keywords": [
     "eyes-webdriverio",
@@ -101,7 +101,7 @@
     "setup": "yarn docker:setup",
     "docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
     "docker:teardown": "docker-compose down",
-    "upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION webdriver@$APPLITOOLS_WEBDRIVERIO_VERSION @types/node@${NODE_VERSION%%.*}; echo \"$packagejson\" > package.json; fi",
+    "upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION @types/node@${NODE_VERSION%%.*}; echo \"$packagejson\" > package.json; fi",
     "deps": "bongo deps",
     "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio(node:14) wdio(node:12) wdio(protocol:cdp) wdio(framework:6) wdio(framework:5)'",
     "gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils eyes-sdk-core visual-grid-client eyes-api spec-driver-webdriverio utils driver snippets screenshoter'",
@@ -111,14 +111,14 @@
     "postversion": "bongo postversion"
   },
   "dependencies": {
-    "@applitools/core": "2.3.6",
-    "@applitools/eyes-api": "1.13.6",
-    "@applitools/spec-driver-webdriverio": "1.4.27"
+    "@applitools/core": "2.3.14",
+    "@applitools/eyes-api": "1.13.12",
+    "@applitools/spec-driver-webdriverio": "1.4.30"
   },
   "devDependencies": {
     "@applitools/api-extractor": "1.2.11",
     "@applitools/bongo": "^2.2.5",
-    "@applitools/sdk-coverage-tests": "^2.7.10",
+    "@applitools/sdk-coverage-tests": "^2.7.12",
     "@applitools/test-utils": "1.5.12",
     "@types/mocha": "^9.1.1",
     "@types/node": "16",

package/types/index.d.ts

@@ -73,7 +73,9 @@ export class Eyes {
     }, settings: Array<OCRRegion>): Promise<Array<string>>;
     extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
     close(throwErr?: undefined | boolean): Promise<TestResults>;
+    closeAsync(): Promise<void>;
     abort(): Promise<TestResults>;
+    abortAsync(): Promise<void>;
     getViewportSize(): Promise<RectangleSize>;
     setViewportSize(size: RectangleSizePlain): Promise<void>;
     getScrollRootElement(): Element | EyesSelector<Selector>;
@@ -190,7 +192,7 @@ export type ConfigurationPlain = {
     matchTimeout?: undefined | number;
     forceFullPageScreenshot?: undefined | boolean;
     waitBeforeScreenshots?: undefined | number;
-    stitchMode?: undefined | "Scroll" | "CSS";
+    stitchMode?: undefined | "Scroll" | "CSS" | "Resize";
     hideScrollbars?: undefined | boolean;
     hideCaret?: undefined | boolean;
     stitchOverlap?: undefined | number;
@@ -456,6 +458,7 @@ export class CheckSettingsAutomation {
     timeout(timeout: number): CheckSettingsAutomation;
     waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
     lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
+    densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
     name(name: string): CheckSettingsAutomation;
     withName(name: string): CheckSettingsAutomation;
     ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
@@ -741,10 +744,13 @@ export enum SessionType {
     SEQUENTIAL = 'SEQUENTIAL',
     PROGRESSION = 'PROGRESSION'
 }
-export type StitchModePlain = "Scroll" | "CSS";
+export type StitchModePlain = "Scroll" | "CSS" | "Resize";
 export enum StitchMode {
     SCROLL = 'Scroll',
-    CSS = 'CSS'
+    Scroll = 'Scroll',
+    CSS = 'CSS',
+    RESIZE = 'Resize',
+    Resize = 'Resize'
 }
 export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
 export enum TestResultsStatus {
@@ -866,6 +872,7 @@ export type CheckSettingsImagePlain = {
     }>;
     pageId?: undefined | string;
     variationGroupId?: undefined | string;
+    densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
 };
 export class CheckSettingsImage {
     constructor(settings?: undefined | CheckSettingsImage | CheckSettingsImagePlain, target?: undefined | {