@applitools/eyes-playwright 1.36.4 → 1.37.0

package/CHANGELOG.md

@@ -1,5 +1,127 @@
 # Changelog
 
+## [1.37.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.36.5...js/eyes-playwright@1.37.0) (2025-03-30)
+
+
+### Features
+
+* allow fully to be sent from the configuration object ([#2867](https://github.com/Applitools-Dev/sdk/issues/2867)) ([e8e7fbc](https://github.com/Applitools-Dev/sdk/commit/e8e7fbcb545e9bab899691d8d136b69f4a67e0d8))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.8.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+* @applitools/dom-snapshot bumped to 4.11.17
+  #### Bug Fixes
+
+  * input range value render issue - add input range to need map list ([#2866](https://github.com/Applitools-Dev/sdk/issues/2866)) ([6b3c113](https://github.com/Applitools-Dev/sdk/commit/6b3c113ab3068fc89b3d3917a12fc51bad66ca97))
+
+
+
+* @applitools/socket bumped to 1.2.3
+
+* @applitools/driver bumped to 1.21.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+
+
+
+* @applitools/spec-driver-playwright bumped to 1.5.9
+
+* @applitools/screenshoter bumped to 3.11.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+
+
+
+* @applitools/req bumped to 1.7.9
+
+* @applitools/image bumped to 1.1.18
+
+* @applitools/nml-client bumped to 1.8.27
+
+* @applitools/ufg-client bumped to 1.16.8
+
+* @applitools/core-base bumped to 1.22.3
+  #### Bug Fixes
+
+  * reject openCheckAndClose on request failures ([#2870](https://github.com/Applitools-Dev/sdk/issues/2870)) ([1d12d60](https://github.com/Applitools-Dev/sdk/commit/1d12d60991e8f222002273d5447702158f1cba84))
+
+
+
+* @applitools/core bumped to 4.34.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+  * offline results state granularity ([#2872](https://github.com/Applitools-Dev/sdk/issues/2872)) ([c5f6e4e](https://github.com/Applitools-Dev/sdk/commit/c5f6e4ed87c4855704ce1a6c568393a35b677c1d))
+
+
+  #### Bug Fixes
+
+  * reject openCheckAndClose on request failures ([#2870](https://github.com/Applitools-Dev/sdk/issues/2870)) ([1d12d60](https://github.com/Applitools-Dev/sdk/commit/1d12d60991e8f222002273d5447702158f1cba84))
+
+
+
+* @applitools/logger bumped to 2.1.2
+
+* @applitools/dom-capture bumped to 11.5.5
+
+* @applitools/spec-driver-webdriver bumped to 1.2.1
+
+* @applitools/spec-driver-selenium bumped to 1.5.97
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.26
+
+* @applitools/tunnel-client bumped to 1.6.4
+
+* @applitools/ec-client bumped to 1.10.7
+
+* @applitools/eyes bumped to 1.33.0
+  #### Features
+
+  * allow fully to be sent from the configuration object ([#2867](https://github.com/Applitools-Dev/sdk/issues/2867)) ([e8e7fbc](https://github.com/Applitools-Dev/sdk/commit/e8e7fbcb545e9bab899691d8d136b69f4a67e0d8))
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+  * offline results state granularity ([#2872](https://github.com/Applitools-Dev/sdk/issues/2872)) ([c5f6e4e](https://github.com/Applitools-Dev/sdk/commit/c5f6e4ed87c4855704ce1a6c568393a35b677c1d))
+
+
+
+
+## [1.36.5](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.36.4...js/eyes-playwright@1.36.5) (2025-03-13)
+
+
+### Bug Fixes
+
+* playwright 1.50 report failing due to a new attachments step ([#2840](https://github.com/Applitools-Dev/sdk/issues/2840)) ([07a466f](https://github.com/Applitools-Dev/sdk/commit/07a466f1ddd42eb5b50ac2e19ae7e79d9dae4701))
+* playwright bad import of configuration ([#2837](https://github.com/Applitools-Dev/sdk/issues/2837)) ([cec8dee](https://github.com/Applitools-Dev/sdk/commit/cec8deed06788029baf63f156c5d84002d7168fb))
+
+
+### Dependencies
+
+* @applitools/spec-driver-webdriver bumped to 1.2.0
+  #### Features
+
+  * support HTTPS_PROXY and HTTP_PROXY environment variables ([#2795](https://github.com/Applitools-Dev/sdk/issues/2795)) ([226ae08](https://github.com/Applitools-Dev/sdk/commit/226ae08627381a1212df8b938c6576e82c777914))
+* @applitools/core bumped to 4.33.0
+  #### Features
+
+  * support HTTPS_PROXY and HTTP_PROXY environment variables ([#2795](https://github.com/Applitools-Dev/sdk/issues/2795)) ([226ae08](https://github.com/Applitools-Dev/sdk/commit/226ae08627381a1212df8b938c6576e82c777914))
+
+
+
+* @applitools/screenshoter bumped to 3.10.7
+
+* @applitools/nml-client bumped to 1.8.26
+
+* @applitools/ec-client bumped to 1.10.6
+
+* @applitools/eyes bumped to 1.32.7
+
+
 ## [1.36.4](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.36.3...js/eyes-playwright@1.36.4) (2025-03-06)
 
 

package/dist/fixture/getEyes.js

@@ -6,12 +6,14 @@ const index_1 = require("../index");
 const eyesConfiguration_1 = require("./defaults/eyesConfiguration");
 const url_1 = require("url");
 async function getEyes({ testInfo, eyesConfig, eyesRunner, page, }) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     if (page.__eyes) {
         return page.__eyes;
     }
     const { configFile } = testInfo.config;
-    const playwrightConfig = (_b = (_a = ((configFile ? await import((0, url_1.pathToFileURL)(configFile).href) : {}))) === null || _a === void 0 ? void 0 : _a.use) === null || _b === void 0 ? void 0 : _b.eyesConfig;
+    const playwrightConfigModule = configFile ? await import((0, url_1.pathToFileURL)(configFile).href) : {};
+    const playwrightConfig = ((_a = playwrightConfigModule === null || playwrightConfigModule === void 0 ? void 0 : playwrightConfigModule.use) === null || _a === void 0 ? void 0 : _a.eyesConfig) ||
+        ((_c = (_b = playwrightConfigModule === null || playwrightConfigModule === void 0 ? void 0 : playwrightConfigModule.default) === null || _b === void 0 ? void 0 : _b.use) === null || _c === void 0 ? void 0 : _c.eyesConfig);
     const projectConfig = testInfo.project.use.eyesConfig;
     const configuration = (0, eyesConfiguration_1.getFinalEyesConfiguration)({
         playwrightConfig,
@@ -30,7 +32,7 @@ async function getEyes({ testInfo, eyesConfig, eyesRunner, page, }) {
         dontCloseBatches: true,
         ...configuration,
     });
-    addLogHandlers(eyes, (_d = (_c = eyesConfig.logConfig) !== null && _c !== void 0 ? _c : projectConfig === null || projectConfig === void 0 ? void 0 : projectConfig.logConfig) !== null && _d !== void 0 ? _d : playwrightConfig === null || playwrightConfig === void 0 ? void 0 : playwrightConfig.logConfig, testInfo);
+    addLogHandlers(eyes, (_e = (_d = eyesConfig.logConfig) !== null && _d !== void 0 ? _d : projectConfig === null || projectConfig === void 0 ? void 0 : projectConfig.logConfig) !== null && _e !== void 0 ? _e : playwrightConfig === null || playwrightConfig === void 0 ? void 0 : playwrightConfig.logConfig, testInfo);
     eyes.open = makeStep('eyes.open', eyes.open.bind(eyes));
     eyes.check = makeStep('eyes.check', eyes.check.bind(eyes));
     eyes.close = makeStep('eyes.close', eyes.close.bind(eyes));

package/dist/fixture/reporter.js

@@ -55,9 +55,16 @@ class EyesReporter extends HtmlReporter {
         if (index > -1) {
             const internalId = result.attachments[index].body.toString();
             this.internalIds.push(internalId);
-            result.attachments.splice(index, 1);
+            this.removeInternalIdAttachment(result);
         }
     }
+    removeInternalIdAttachment(result) {
+        var _a;
+        const index = result.attachments ? result.attachments.findIndex(a => a.name === 'internalId') : -1;
+        if (index > -1)
+            (_a = result.attachments) === null || _a === void 0 ? void 0 : _a.splice(index, 1);
+        result.steps.forEach(step => this.removeInternalIdAttachment(step));
+    }
     async onEnd(result) {
         await super.onEnd(result);
         const testResultsMap = {};

package/dist/fixture/toHaveScreenshot.js

@@ -6,7 +6,7 @@ const index_1 = require("./index");
 const getEyes_1 = require("./getEyes");
 exports.expect = test_1.expect.extend({
     async toHaveScreenshot(pageOrLocator, nameOrOptions = {}, optOptions = {}) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         const testInfo = index_1.test.info();
         if (!testInfo) {
             throw new Error(`toHaveScreenshot() must be called during the test`);
@@ -127,7 +127,7 @@ exports.expect = test_1.expect.extend({
                         ? nameOrOptions.name
                         : undefined,
             region: locator !== null && locator !== void 0 ? locator : options.clip,
-            fully: options.fullPage,
+            fully: (_f = options.fullPage) !== null && _f !== void 0 ? _f : configuration.fully,
             ignoreRegions: options.mask,
         });
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-playwright",
-  "version": "1.36.4",
+  "version": "1.37.0",
   "description": "Applitools Eyes SDK for Playwright",
   "keywords": [
     "eyes-playwright",
@@ -51,17 +51,17 @@
     "build:report": "rollup --config src/fixture/build/rollup.config.ts --configPlugin typescript && cp src/fixture/reporterStyle.css dist/fixture && cp -R src/fixture/images dist/fixture",
     "build:cli": "cp -R src/fixture/example dist/fixture",
     "generate:tests": "NODE_OPTIONS='--experimental-import-meta-resolve --experimental-loader=@applitools/generic/dist/code-loader.js' generic ./test/generic/config.mjs",
-    "test": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) run --top-level mocha './**/*.spec.{js,ts}' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
-    "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
+    "test": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) run --top-level mocha './test/*.spec.{js,ts}' --exit",
+    "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-8} --exit",
     "test:fixture": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(npx uuid).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright-fixture' APPLITOOLS_BATCH_ID=$(npx uuid) run playwright test",
     "setup": "run playwright:setup",
     "playwright:setup": "yarn playwright install --with-deps chromium firefox webkit",
     "up:framework": "echo \"$(jq '.devDependencies.playwright = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
   },
   "dependencies": {
-    "@applitools/eyes": "1.32.6",
-    "@applitools/spec-driver-playwright": "1.5.8",
-    "@applitools/utils": "1.7.8",
+    "@applitools/eyes": "1.33.0",
+    "@applitools/spec-driver-playwright": "1.5.9",
+    "@applitools/utils": "1.8.0",
     "@inquirer/prompts": "7.0.1",
     "chalk": "4.1.2",
     "yargs": "17.7.2"

package/types/index.d.ts

@@ -8,6 +8,7 @@ export type SpecType = {
     element: Element;
     selector: Selector;
     secondary: never;
+    userFunction: unknown;
 };
 export class Eyes {
     static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
@@ -273,7 +274,7 @@ export type CheckSettingsAutomationPlain = {
     useSystemScreenshot?: undefined | boolean;
     hooks?: undefined | { beforeCaptureScreenshot: string; };
     timeout?: undefined | number;
-    waitBeforeCapture?: undefined | number;
+    waitBeforeCapture?: undefined | number | (() => Promise<void>);
     lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
 };
 export class CheckSettingsAutomation {
@@ -309,6 +310,7 @@ export class CheckSettingsAutomation {
     useSystemScreenshot(useSystemScreenshot?: undefined | boolean): CheckSettingsAutomation;
     timeout(timeout: number): CheckSettingsAutomation;
     waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
+    waitBeforeCapture(waitBeforeCapture: (() => Promise<void>)): CheckSettingsAutomation;
     lazyLoad(options?: undefined | boolean): CheckSettingsAutomation;
     lazyLoad(options?: undefined | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
     densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
@@ -483,6 +485,7 @@ export type ConfigurationPlain = {
     enablePatterns?: undefined | boolean;
     environmentName?: undefined | string;
     forceFullPageScreenshot?: undefined | boolean;
+    fully?: undefined | boolean;
     gitMergeBaseTimestamp?: undefined | string;
     latestCommitInfo?: undefined | { timestamp: string; sha: string; };
     hideCaret?: undefined | boolean;
@@ -519,7 +522,7 @@ export type ConfigurationPlain = {
     useDom?: undefined | boolean;
     viewportSize?: undefined | RectangleSizePlain;
     visualGridOptions?: undefined | Record<string, any>;
-    waitBeforeCapture?: undefined | number;
+    waitBeforeCapture?: undefined | number | (() => Promise<void>);
     waitBeforeScreenshots?: undefined | number;
 };
 export class Configuration implements Required<ConfigurationPlain> {
@@ -809,14 +812,19 @@ export class Configuration implements Required<ConfigurationPlain> {
     getVisualGridOptions(): { [key: string]: any; };
     setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
     setVisualGridOption(key: string, value: any): Configuration;
-    get waitBeforeCapture(): number;
-    set waitBeforeCapture(waitBeforeCapture: number);
-    getWaitBeforeCapture(): number;
+    get waitBeforeCapture(): number | (() => Promise<void>);
+    set waitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>));
+    getWaitBeforeCapture(): number | (() => Promise<void>);
     setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
+    setWaitBeforeCapture(waitBeforeCapture: (() => Promise<void>)): Configuration;
     get waitBeforeScreenshots(): number;
     set waitBeforeScreenshots(waitBeforeScreenshots: number);
     getWaitBeforeScreenshots(): number;
     setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
+    get fully(): boolean;
+    set fully(fully: boolean);
+    getFully(): boolean;
+    setFully(fully: boolean): Configuration;
 }
 export class BatchClose {
     static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;