@applitools/eyes 1.25.0 → 1.26.0

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## [1.26.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.25.1...js/eyes@1.26.0) (2024-10-31)
+
+
+### Features
+
+* html report for playwright ([#2576](https://github.com/Applitools-Dev/sdk/issues/2576)) ([f93f164](https://github.com/Applitools-Dev/sdk/commit/f93f164a289f5676bcc9d650e5e3d90b8e6a6920))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.5
+
+* @applitools/snippets bumped to 2.6.0
+  #### Features
+
+  * html report for playwright ([#2576](https://github.com/Applitools-Dev/sdk/issues/2576)) ([f93f164](https://github.com/Applitools-Dev/sdk/commit/f93f164a289f5676bcc9d650e5e3d90b8e6a6920))
+* @applitools/core-base bumped to 1.19.0
+  #### Features
+
+  * html report for playwright ([#2576](https://github.com/Applitools-Dev/sdk/issues/2576)) ([f93f164](https://github.com/Applitools-Dev/sdk/commit/f93f164a289f5676bcc9d650e5e3d90b8e6a6920))
+* @applitools/driver bumped to 1.19.5
+
+* @applitools/spec-driver-webdriver bumped to 1.1.17
+
+* @applitools/spec-driver-selenium bumped to 1.5.88
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.17
+
+* @applitools/screenshoter bumped to 3.9.3
+
+* @applitools/nml-client bumped to 1.8.15
+
+* @applitools/ec-client bumped to 1.9.11
+
+* @applitools/core bumped to 4.22.0
+  #### Features
+
+  * html report for playwright ([#2576](https://github.com/Applitools-Dev/sdk/issues/2576)) ([f93f164](https://github.com/Applitools-Dev/sdk/commit/f93f164a289f5676bcc9d650e5e3d90b8e6a6920))
+
+
+
+
+## [1.25.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.25.0...js/eyes@1.25.1) (2024-10-29)
+
+
+### Dependencies
+
+* @applitools/screenshoter bumped to 3.9.2
+  #### Bug Fixes
+
+  * test in screenshoter web ([f068dbe](https://github.com/Applitools-Dev/sdk/commit/f068dbe9036163fb3e316411cfd9f47a226d7c9c))
+* @applitools/core bumped to 4.21.2
+
+
 ## [1.25.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.24.0...js/eyes@1.25.0) (2024-10-28)
 
 

package/dist/input/CheckSettings.js

@@ -43,9 +43,6 @@ class CheckSettingsBaseFluent {
         }
     }
     region(region) {
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         this._settings.region = region;
         return this;
     }
@@ -59,9 +56,6 @@ class CheckSettingsBaseFluent {
     ignoreRegion(region) {
         if (!this._settings.ignoreRegions)
             this._settings.ignoreRegions = [];
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         this._settings.ignoreRegions.push(region);
         return this;
     }
@@ -80,9 +74,6 @@ class CheckSettingsBaseFluent {
     layoutRegion(region) {
         if (!this._settings.layoutRegions)
             this._settings.layoutRegions = [];
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         this._settings.layoutRegions.push(region);
         return this;
     }
@@ -93,9 +84,6 @@ class CheckSettingsBaseFluent {
     strictRegion(region) {
         if (!this._settings.strictRegions)
             this._settings.strictRegions = [];
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         this._settings.strictRegions.push(region);
         return this;
     }
@@ -106,9 +94,6 @@ class CheckSettingsBaseFluent {
     contentRegion(region) {
         if (!this._settings.contentRegions)
             this._settings.contentRegions = [];
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         this._settings.contentRegions.push(region);
         return this;
     }
@@ -117,9 +102,6 @@ class CheckSettingsBaseFluent {
         return this;
     }
     floatingRegion(region, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset) {
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         let floatingRegion;
         if (utils.types.has(region, 'region')) {
             const { maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset, ...rest } = region;
@@ -165,9 +147,6 @@ class CheckSettingsBaseFluent {
         return this.floatingRegions(regionOrMaxOffset, ...regions);
     }
     accessibilityRegion(region, type) {
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         const accessibilityRegion = utils.types.has(region, 'region') ? region : { region, type };
         if (!this._settings.accessibilityRegions)
             this._settings.accessibilityRegions = [];
@@ -191,9 +170,6 @@ class CheckSettingsBaseFluent {
         return this;
     }
     dynamicRegion(region, type) {
-        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
-            region = { x: region.left, y: region.top, width: region.width, height: region.height };
-        }
         const dynamicRegion = utils.types.has(region, 'region') ? region : { region, type };
         if (!this._settings.dynamicRegions)
             this._settings.dynamicRegions = [];
@@ -324,6 +300,36 @@ class CheckSettingsBaseFluent {
             },
         });
     }
+    // protected toCoreCodedRegion(region: CodedRegion<TRegion>): Core.CodedRegion<TRegion | utils.Region>
+    // protected toCoreCodedRegion(region: Region | LegacyRegion | TRegion): utils.Region | TRegion
+    toCoreCodedRegion(region) {
+        if (utils.types.has(region, ['region'])) {
+            return { ...region, region: this.toCoreRegion(region.region) };
+        }
+        else {
+            return this.toCoreRegion(region);
+        }
+    }
+    toCoreCodedFloatingRegion(region) {
+        if (utils.types.has(region, 'region')) {
+            const { maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset, ...rest } = region;
+            return {
+                offset: { top: maxUpOffset, bottom: maxDownOffset, left: maxLeftOffset, right: maxRightOffset },
+                ...this.toCoreCodedRegion(rest),
+            };
+        }
+        else {
+            return this.toCoreRegion(region);
+        }
+    }
+    toCoreRegion(region) {
+        if (utils.types.has(region, ['left', 'top', 'width', 'height'])) {
+            return { x: region.left, y: region.top, width: region.width, height: region.height };
+        }
+        else {
+            return region;
+        }
+    }
 }
 exports.CheckSettingsBaseFluent = CheckSettingsBaseFluent;
 class CheckSettingsImageFluent extends CheckSettingsBaseFluent {
@@ -378,20 +384,20 @@ class CheckSettingsImageFluent extends CheckSettingsBaseFluent {
             target: this._target,
             settings: utils.general.removeUndefinedProps({
                 name: this._settings.name,
-                region: this._settings.region,
+                region: this._settings.region ? this.toCoreRegion(this._settings.region) : this._settings.region,
                 matchLevel: this._settings.matchLevel,
                 useDom: this._settings.useDom,
                 sendDom: this._settings.sendDom,
                 enablePatterns: this._settings.enablePatterns,
                 ignoreDisplacements: this._settings.ignoreDisplacements,
                 ignoreCaret: this._settings.ignoreCaret,
-                ignoreRegions: (_a = this._settings.ignoreRegions) === null || _a === void 0 ? void 0 : _a.slice(),
-                layoutRegions: (_b = this._settings.layoutRegions) === null || _b === void 0 ? void 0 : _b.slice(),
-                strictRegions: (_c = this._settings.strictRegions) === null || _c === void 0 ? void 0 : _c.slice(),
-                contentRegions: (_d = this._settings.contentRegions) === null || _d === void 0 ? void 0 : _d.slice(),
-                floatingRegions: (_e = this._settings.floatingRegions) === null || _e === void 0 ? void 0 : _e.slice(),
-                accessibilityRegions: (_f = this._settings.accessibilityRegions) === null || _f === void 0 ? void 0 : _f.slice(),
-                dynamicRegions: (_g = this._settings.dynamicRegions) === null || _g === void 0 ? void 0 : _g.slice(),
+                ignoreRegions: (_a = this._settings.ignoreRegions) === null || _a === void 0 ? void 0 : _a.map(this.toCoreCodedRegion),
+                layoutRegions: (_b = this._settings.layoutRegions) === null || _b === void 0 ? void 0 : _b.map(this.toCoreCodedRegion),
+                strictRegions: (_c = this._settings.strictRegions) === null || _c === void 0 ? void 0 : _c.map(this.toCoreCodedRegion),
+                contentRegions: (_d = this._settings.contentRegions) === null || _d === void 0 ? void 0 : _d.map(this.toCoreCodedRegion),
+                floatingRegions: (_e = this._settings.floatingRegions) === null || _e === void 0 ? void 0 : _e.map(this.toCoreCodedFloatingRegion),
+                accessibilityRegions: (_f = this._settings.accessibilityRegions) === null || _f === void 0 ? void 0 : _f.map(this.toCoreCodedRegion),
+                dynamicRegions: (_g = this._settings.dynamicRegions) === null || _g === void 0 ? void 0 : _g.map(this.toCoreCodedRegion),
                 pageId: this._settings.pageId,
                 userCommandId: this._settings.variationGroupId,
                 assumesMutability: this.assumesMutability(),
@@ -522,11 +528,11 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
         return this.beforeRenderScreenshotHook(script);
     }
     ufgOption(key, value) {
-        this._settings.visualGridOptions = { ...this._settings.visualGridOptions, [key]: value };
+        this._settings.ufgOptions = { ...this._settings.ufgOptions, [key]: value };
         return this;
     }
     ufgOptions(options) {
-        this._settings.visualGridOptions = options;
+        this._settings.ufgOptions = options;
         return this;
     }
     /** @deprecated */
@@ -569,12 +575,12 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
     }
     /** @internal */
     toJSON() {
-        var _a;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         return {
             target: undefined,
             settings: utils.general.removeUndefinedProps({
                 name: this._settings.name,
-                region: this._settings.region,
+                region: this._settings.region ? this.toCoreRegion(this._settings.region) : this._settings.region,
                 frames: this._settings.frames,
                 webview: this._settings.webview,
                 scrollRootElement: this._settings.scrollRootElement,
@@ -585,30 +591,20 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
                 enablePatterns: this._settings.enablePatterns,
                 ignoreDisplacements: this._settings.ignoreDisplacements,
                 ignoreCaret: this._settings.ignoreCaret,
-                ignoreRegions: this._settings.ignoreRegions,
-                layoutRegions: this._settings.layoutRegions,
-                strictRegions: this._settings.strictRegions,
-                contentRegions: this._settings.contentRegions,
-                floatingRegions: this._settings.floatingRegions &&
-                    this._settings.floatingRegions.map(floatingRegion => {
-                        if (utils.types.has(floatingRegion, 'region')) {
-                            const { maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset, ...rest } = floatingRegion;
-                            return {
-                                offset: { top: maxUpOffset, bottom: maxDownOffset, left: maxLeftOffset, right: maxRightOffset },
-                                ...rest,
-                            };
-                        }
-                        return floatingRegion;
-                    }),
-                accessibilityRegions: this._settings.accessibilityRegions,
-                dynamicRegions: this._settings.dynamicRegions,
+                ignoreRegions: (_a = this._settings.ignoreRegions) === null || _a === void 0 ? void 0 : _a.map(this.toCoreCodedRegion),
+                layoutRegions: (_b = this._settings.layoutRegions) === null || _b === void 0 ? void 0 : _b.map(this.toCoreCodedRegion),
+                strictRegions: (_c = this._settings.strictRegions) === null || _c === void 0 ? void 0 : _c.map(this.toCoreCodedRegion),
+                contentRegions: (_d = this._settings.contentRegions) === null || _d === void 0 ? void 0 : _d.map(this.toCoreCodedRegion),
+                floatingRegions: (_e = this._settings.floatingRegions) === null || _e === void 0 ? void 0 : _e.map(this.toCoreCodedFloatingRegion),
+                accessibilityRegions: (_f = this._settings.accessibilityRegions) === null || _f === void 0 ? void 0 : _f.map(this.toCoreCodedRegion),
+                dynamicRegions: (_g = this._settings.dynamicRegions) === null || _g === void 0 ? void 0 : _g.map(this.toCoreCodedRegion),
                 disableBrowserFetching: this._settings.disableBrowserFetching,
                 layoutBreakpoints: utils.types.isDefined(this._settings.layoutBreakpoints)
                     ? utils.types.has(this._settings.layoutBreakpoints, 'breakpoints')
                         ? this._settings.layoutBreakpoints
-                        : { breakpoints: (_a = this._settings.layoutBreakpoints) !== null && _a !== void 0 ? _a : false }
+                        : { breakpoints: (_h = this._settings.layoutBreakpoints) !== null && _h !== void 0 ? _h : false }
                     : undefined,
-                ufgOptions: this._settings.visualGridOptions,
+                ufgOptions: (_j = this._settings.ufgOptions) !== null && _j !== void 0 ? _j : this._settings.visualGridOptions,
                 nmgOptions: this._settings.nmgOptions,
                 screenshotMode: this._settings.useSystemScreenshot ? 'default' : undefined,
                 hooks: this._settings.hooks,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.25.0",
+  "version": "1.26.0",
   "keywords": [
     "applitools",
     "eyes",
@@ -45,7 +45,7 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.21.1",
+    "@applitools/core": "4.22.0",
     "@applitools/logger": "2.0.18",
     "@applitools/utils": "1.7.4"
   },

package/types/input/CheckSettings.d.ts

@@ -8,8 +8,9 @@ import { Region, LegacyRegion } from './Region';
 import { Location } from './Location';
 import { LazyLoadOptions } from './LazyLoadOptions';
 import { DensityMetrics } from './DensityMetrics';
+import * as utils from '@applitools/utils';
 import { DynamicTextType } from '../enums/DynamicTextType';
-type RegionReference<TSpec extends Core.SpecType> = Region | ElementReference<TSpec>;
+type RegionReference<TSpec extends Core.SpecType> = Region | LegacyRegion | ElementReference<TSpec>;
 type ElementReference<TSpec extends Core.SpecType> = TSpec['element'] | SelectorReference<TSpec>;
 type SelectorReference<TSpec extends Core.SpecType> = EyesSelector<TSpec['selector']>;
 type FrameReference<TSpec extends Core.SpecType> = ElementReference<TSpec> | string | number;
@@ -18,7 +19,7 @@ type ContextReference<TSpec extends Core.SpecType> = {
     scrollRootElement?: ElementReference<TSpec>;
 };
 type CodedRegion<TRegion = never> = {
-    region: Region | TRegion;
+    region: Region | LegacyRegion | TRegion;
     padding?: number | {
         top: number;
         bottom: number;
@@ -51,7 +52,7 @@ type CodedDynamicRegion<TRegion = never> = CodedRegion<TRegion> & {
 };
 export type CheckSettingsBase<TRegion = never> = {
     name?: string;
-    region?: Region | TRegion;
+    region?: Region | LegacyRegion | TRegion;
     matchLevel?: MatchLevel;
     useDom?: boolean;
     sendDom?: boolean;
@@ -59,12 +60,12 @@ export type CheckSettingsBase<TRegion = never> = {
     ignoreDisplacements?: boolean;
     ignoreMismatch?: boolean;
     ignoreCaret?: boolean;
-    ignoreRegions?: (CodedRegion<TRegion> | Region | TRegion)[];
-    layoutRegions?: (CodedRegion<TRegion> | Region | TRegion)[];
-    strictRegions?: (CodedRegion<TRegion> | Region | TRegion)[];
-    contentRegions?: (CodedRegion<TRegion> | Region | TRegion)[];
-    floatingRegions?: (CodedFloatingRegion<TRegion> | LegacyCodedFloatingRegion<TRegion> | Region | TRegion)[];
-    accessibilityRegions?: (CodedAccessibilityRegion<TRegion> | Region | TRegion)[];
+    ignoreRegions?: (CodedRegion<TRegion> | Region | LegacyRegion | TRegion)[];
+    layoutRegions?: (CodedRegion<TRegion> | Region | LegacyRegion | TRegion)[];
+    strictRegions?: (CodedRegion<TRegion> | Region | LegacyRegion | TRegion)[];
+    contentRegions?: (CodedRegion<TRegion> | Region | LegacyRegion | TRegion)[];
+    floatingRegions?: (CodedFloatingRegion<TRegion> | LegacyCodedFloatingRegion<TRegion> | Region | LegacyRegion | TRegion)[];
+    accessibilityRegions?: (CodedAccessibilityRegion<TRegion> | Region | LegacyRegion | TRegion)[];
     dynamicRegions?: (CodedDynamicRegion<TRegion> | Region | TRegion)[];
     pageId?: string;
     variationGroupId?: string;
@@ -81,9 +82,13 @@ export type CheckSettingsAutomation<TSpec extends Core.SpecType> = CheckSettings
         breakpoints: number[] | boolean;
         reload?: boolean;
     };
+    /** @deprecated */
     visualGridOptions?: {
         [key: string]: any;
     };
+    ufgOptions?: {
+        [key: string]: any;
+    };
     /** @deprecated */
     nmgOptions?: {
         [key: string]: any;
@@ -159,6 +164,9 @@ export declare class CheckSettingsBaseFluent<TRegion = never> {
     /** @internal */
     protected assumesMutability(): true | undefined;
     protected static makeMutableTreeProxy<K, T extends CheckSettingsBaseFluent<K>>(self: T, ctor: new (...args: any[]) => T): T;
+    protected toCoreCodedRegion(region: CodedRegion<TRegion> | Region | LegacyRegion | TRegion): Core.CodedRegion<TRegion | utils.Region> | utils.Region | TRegion;
+    protected toCoreCodedFloatingRegion(region: CodedFloatingRegion<TRegion> | LegacyCodedFloatingRegion<TRegion> | Region | LegacyRegion | TRegion): Core.FloatingRegion<TRegion | utils.Region> | utils.Region | TRegion;
+    protected toCoreRegion(region: Region | LegacyRegion | TRegion): utils.Region | TRegion;
 }
 export declare class CheckSettingsImageFluent extends CheckSettingsBaseFluent {
     protected _target: Image;