@applitools/eyes-playwright 1.13.0 → 1.13.2

package/CHANGELOG.md

@@ -11,6 +11,20 @@
 
 
 
+## 1.13.2 - 2023/1/20
+
+### Features
+### Bug fixes
+- Fixed dependency issue on windows
+
+## 1.13.1 - 2023/1/17
+
+### Features
+### Bug fixes
+- Handle fake shadowRoot with UFG
+- Handed error during polling in long requests to eyes server
+- Additional internal event logs
+
 ## 1.13.0 - 2022/11/29
 
 ### Features

package/README.md

@@ -7,52 +7,55 @@
 </div>
 <br/>
 
-## Table of contents
+### Table of contents
 
 - [Installation](#installation)
 - [Applitools API key](#applitools-api-key)
 - [Usage](#usage)
 - [Getting started with the API](#getting-started-with-the-api)
-  * [Eyes constructor](#eyes-constructor)
-  * [open](#open)
-    + [Visual tests and baselines](#visual-tests-and-baselines)
-    + [Batches](#batches)
-  * [check](#check)
-    + [Arguments to `eyes.check`](#arguments-to-eyescheck)
-      - [`tag`](#tag)
-      - [`checkSettings`](#checksettings)
-        * [Page screenshot](#page-screenshot)
-        * [Region screenshot](#region-screenshot)
-        * [Switching into frames](#switching-into-frames)
-        * [Ignore Regions](#ignore-regions)
-        * [Floating Regions](#floating-regions)
-        * [Content/Strict/Layout Regions](#content-strict-layout-regions)
-        * [Accessiblity Regions](#accessiblity-regions)
-        * [Scroll root element](#scroll-root-element)
-        * [Other checkSettings configuration](#other-checksettings-configuration)
-  * [close](#close)
+  - [Eyes constructor](#eyes-constructor)
+  - [open](#open)
+    - [Visual tests and baselines](#visual-tests-and-baselines)
+    - [Batches](#batches)
+  - [check](#check)
+    - [`checkSettings`](#checksettings)
+      - [Page screenshot](#page-screenshot)
+      - [Region screenshot](#region-screenshot)
+      - [Working with frames](#working-with-frames)
+      - [Ignore Regions](#ignore-regions)
+      - [Floating Regions](#floating-regions)
+      - [Content/Strict/Layout Regions](#contentstrictlayout-regions)
+      - [Accessiblity Regions](#accessiblity-regions)
+      - [Scroll root element](#scroll-root-element)
+      - [Tag (`withName`)](#tag-withname)
+      - [Lazy loading (`lazyLoad`)](#lazy-loading-lazyload)
+        - [Other checkSettings configuration](#other-checksettings-configuration)
+  - [close](#close)
 - [Runners](#runners)
-  * [Purpose of runners](#purpose-of-runners)
-    + [1. Use the Ultrafast grid](#1-use-the-ultra-fast-grid)
-    + [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
+  - [Purpose of runners](#purpose-of-runners)
+    - [1. Use the Ultrafast grid](#1-use-the-ultrafast-grid)
+    - [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
 - [Recipes for common tasks](#recipes-for-common-tasks)
-  * [Configure Server URL](#configure-server-url)
-  * [Configure Proxy](#configure-proxy)
-  * [Make every visual test correspond to a functional test](#make-every-visual-test-correspond-to-a-functional-test)
-  * [Organize tests in batches](#organize-tests-in-batches)
-    + [Method 1: environment variable](#method-1--environment-variable)
-    + [Method 2: `eyes.setBatch`](#method-2--eyessetbatch)
-  * [Stitch mode](#stitch-mode)
-    + [Background information](#background-information)
+  - [Configure Server URL](#configure-server-url)
+  - [Configure Proxy](#configure-proxy)
+  - [Make every visual test correspond to a functional test](#make-every-visual-test-correspond-to-a-functional-test)
+  - [Organize tests in batches](#organize-tests-in-batches)
+    - [Method 1: environment variable](#method-1-environment-variable)
+    - [Method 2: `eyes.setBatch`](#method-2-eyessetbatch)
+  - [Stitch mode](#stitch-mode)
+    - [Background information](#background-information)
       - [1. Stitch mode: Scroll](#1-stitch-mode-scroll)
       - [2. Stitch mode: CSS](#2-stitch-mode-css)
-  * [Stitch overlap](#stitch-overlap)
-  * [Match level](#match-level)
-  * [Ignore displacements](#ignore-displacements)
-  * [Test properties](#test-properties)
-  * [Test results](#test-results)
-  * [Logging](#logging)
-  * [Configuring browsers for the Ultrafast grid](#configuring-browsers-for-the-ultra-fast-grid)
+  - [Stitch overlap](#stitch-overlap)
+  - [Match level](#match-level)
+  - [Ignore displacements](#ignore-displacements)
+  - [Test properties](#test-properties)
+  - [Test results](#test-results)
+  - [Logging](#logging)
+  - [Configuring browsers for the Ultrafast grid](#configuring-browsers-for-the-ultrafast-grid)
+    - [Desktop browsers](#desktop-browsers)
+    - [Chrome device emulation](#chrome-device-emulation)
+    - [iOS device](#ios-device)
 
 
 ## Installation
@@ -716,7 +719,7 @@ It's possible to provide additional information about each test in custom fields
 This is done by calling `setProperties` on the configuration, and providing it with an array of properties with the structure `{name, value}`. For example:
 
 ```js
-const {Eyes, Target} = require('@applitools/eyes-playwright')
+const {Eyes} = require('@applitools/eyes-playwright')
 
 const eyes = new Eyes()
 
@@ -725,6 +728,21 @@ configuration.setProperties([{name: 'my custom property', value: 'some value'}])
 eyes.setConfiguration(configuration)
 ```
 
+The test properties could also be specified per batch by calling `setProperties` on the batch info, and providing it with an array of properties with the structure `{name, value}`. For example:
+
+```js
+const {Eyes, BatchInfo} = require('@applitools/eyes-playwright')
+
+const eyes = new Eyes()
+
+const batch = new BatchInfo()
+batch.setProperties([{name: 'my custom batch property', value: 'some value'}])
+
+const configuration = eyes.getConfiguration()
+configuration.setBatch(batch)
+eyes.setConfiguration(configuration)
+```
+
 ### Test results
 
 The results of the test can be consumed as the return value from `eyes.close`. Here's an example for creating a formatted output string out of the `TestResults` object:

package/dist/api.js

@@ -26,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = void 0;
+exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.CheckSettingsAutomation = exports.Configuration = exports.Eyes = void 0;
 const core_1 = require("@applitools/core");
 const api = __importStar(require("@applitools/eyes-api"));
 const spec = __importStar(require("@applitools/spec-driver-playwright"));
@@ -43,10 +43,13 @@ class Configuration extends api.Configuration {
 }
 exports.Configuration = Configuration;
 Configuration._spec = sdk;
-class CheckSettings extends api.CheckSettingsAutomation {
+class CheckSettingsAutomation extends api.CheckSettingsAutomation {
+}
+exports.CheckSettingsAutomation = CheckSettingsAutomation;
+CheckSettingsAutomation._spec = sdk;
+class CheckSettings extends CheckSettingsAutomation {
 }
 exports.CheckSettings = CheckSettings;
-CheckSettings._spec = sdk;
 exports.Target = { ...api.Target, spec: sdk };
 class BatchClose extends api.BatchClose {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-playwright",
-  "version": "1.13.0",
+  "version": "1.13.2",
   "description": "Applitools Eyes SDK for Playwright",
   "keywords": [
     "eyes-playwright",
@@ -58,17 +58,17 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "1.2.14",
-    "@applitools/eyes-api": "1.10.6",
-    "@applitools/spec-driver-playwright": "1.3.4"
+    "@applitools/core": "1.4.2",
+    "@applitools/eyes-api": "1.12.2",
+    "@applitools/spec-driver-playwright": "1.3.7"
   },
   "devDependencies": {
     "@applitools/api-extractor": "1.2.11",
-    "@applitools/bongo": "^2.2.0",
+    "@applitools/bongo": "^2.2.2",
     "@applitools/scripts": "1.2.0",
-    "@applitools/sdk-coverage-tests": "2.7.8",
+    "@applitools/sdk-coverage-tests": "2.7.10",
     "@applitools/sdk-shared": "0.9.15",
-    "@applitools/test-utils": "1.5.2",
+    "@applitools/test-utils": "1.5.8",
     "@types/mocha": "^9.1.1",
     "@types/node": "12",
     "@typescript-eslint/eslint-plugin": "^5.27.0",

package/types/api.d.ts

@@ -1,9 +1,10 @@
 import type { Driver, Element, Selector } from '@applitools/spec-driver-playwright';
 import * as api from '@applitools/eyes-api';
+import * as spec from '@applitools/spec-driver-playwright';
 export * from '@applitools/eyes-api';
 export { Driver, Element, Selector };
 export declare class Eyes extends api.Eyes<Driver, Element, Selector> {
-    protected static readonly _spec: import("@applitools/core").Core<Driver, Element | Selector, (string & {
+    protected static readonly _spec: import("@applitools/core").Core<Driver, spec.Context, Element<Node> | Selector, (string & {
         __applitoolsBrand?: never;
     }) | (import("playwright-core").Locator & {
         __applitoolsBrand?: never;
@@ -12,24 +13,26 @@ export declare class Eyes extends api.Eyes<Driver, Element, Selector> {
 }
 export type ConfigurationPlain = api.ConfigurationPlain<Element, Selector>;
 export declare class Configuration extends api.Configuration<Element, Selector> {
-    protected static readonly _spec: import("@applitools/core").Core<Driver, Element | Selector, (string & {
+    protected static readonly _spec: import("@applitools/core").Core<Driver, spec.Context, Element<Node> | Selector, (string & {
         __applitoolsBrand?: never;
     }) | (import("playwright-core").Locator & {
         __applitoolsBrand?: never;
     })>;
 }
 export type OCRRegion = api.OCRRegion<Element, Selector>;
-export type CheckSettingsPlain = api.CheckSettingsAutomationPlain<Element, Selector>;
-export declare class CheckSettings extends api.CheckSettingsAutomation<Element, Selector> {
-    protected static readonly _spec: import("@applitools/core").Core<Driver, Element | Selector, (string & {
+export type CheckSettingsAutomationPlain = api.CheckSettingsAutomationPlain<Element, Selector>;
+export declare class CheckSettingsAutomation extends api.CheckSettingsAutomation<Element, Selector> {
+    protected static readonly _spec: import("@applitools/core").Core<Driver, spec.Context, Element<Node> | Selector, (string & {
         __applitoolsBrand?: never;
     }) | (import("playwright-core").Locator & {
         __applitoolsBrand?: never;
     })>;
 }
-export declare const Target: api.Target<Element, Selector>;
+export declare class CheckSettings extends CheckSettingsAutomation {
+}
+export declare const Target: api.Target<Element<Node>, Selector>;
 export declare class BatchClose extends api.BatchClose {
-    protected static readonly _spec: import("@applitools/core").Core<Driver, Element | Selector, (string & {
+    protected static readonly _spec: import("@applitools/core").Core<Driver, spec.Context, Element<Node> | Selector, (string & {
         __applitoolsBrand?: never;
     }) | (import("playwright-core").Locator & {
         __applitoolsBrand?: never;