@applitools/eyes-puppeteer 1.29.1 → 1.29.3

package/CHANGELOG.md

@@ -1,5 +1,120 @@
 # Changelog
 
+## [1.29.3](https://github.com/Applitools-Dev/sdk/compare/js/eyes-puppeteer@1.29.2...js/eyes-puppeteer@1.29.3) (2025-04-17)
+
+
+### Performance Improvements
+
+* cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.18
+  #### Bug Fixes
+
+  * simplify sandbox creation and ensure cleanup after execution ([#2869](https://github.com/Applitools-Dev/sdk/issues/2869)) ([72c5e01](https://github.com/Applitools-Dev/sdk/commit/72c5e01307f6abd83fab365a7e235124caae0694))
+
+
+
+* @applitools/snippets bumped to 2.6.5
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+* @applitools/driver bumped to 1.21.1
+  #### Bug Fixes
+
+  * executePoll error logging FLD-2870 ([#2890](https://github.com/Applitools-Dev/sdk/issues/2890)) ([a8ff720](https://github.com/Applitools-Dev/sdk/commit/a8ff720efafacabe2023282748a6d8a0f1b3ff73))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.2.2
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/spec-driver-selenium bumped to 1.5.98
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.27
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/screenshoter bumped to 3.11.1
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/nml-client bumped to 1.9.1
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/tunnel-client bumped to 1.6.5
+  #### Bug Fixes
+
+  * enhance error messages in tunnel client ([cab26e6](https://github.com/Applitools-Dev/sdk/commit/cab26e6e3d56fa3cbabaa1a9c68de13046b8f57e))
+* @applitools/ufg-client bumped to 1.16.9
+  #### Bug Fixes
+
+  * basic auth protected resources | FLD-2761 | FMRI-120 ([#2444](https://github.com/Applitools-Dev/sdk/issues/2444)) ([b48cf49](https://github.com/Applitools-Dev/sdk/commit/b48cf49dec50bbf1ed2ba111608a48cf09962565))
+
+
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+* @applitools/ec-client bumped to 1.10.9
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/core bumped to 4.37.0
+  #### Features
+
+  * height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
+
+
+
+* @applitools/eyes bumped to 1.34.0
+  #### Features
+
+  * height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
+
+
+  #### Bug Fixes
+
+  * add checks for undefined regions in CheckSettings | AD-9042 ([#2868](https://github.com/Applitools-Dev/sdk/issues/2868)) ([0f7c991](https://github.com/Applitools-Dev/sdk/commit/0f7c9913d64e0535ba5ffe632923a3bf440be65f))
+
+
+
+
+## [1.29.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes-puppeteer@1.29.1...js/eyes-puppeteer@1.29.2) (2025-04-03)
+
+
+### Dependencies
+
+* @applitools/core bumped to 4.35.1
+  #### Bug Fixes
+
+  * dummy ([9b8ffef](https://github.com/Applitools-Dev/sdk/commit/9b8ffef6277015a9073caf50f5dc5741986fbf07))
+* @applitools/eyes bumped to 1.33.2
+
+
 ## [1.29.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-puppeteer@1.29.0...js/eyes-puppeteer@1.29.1) (2025-03-06)
 
 

package/README.md

@@ -1,12 +1,73 @@
-<div align="center">
+## Applitools Eyes SDK for [Puppeteer](https://pptr.dev/).
 
-![Applitools Eyes](https://i.ibb.co/3hWJK68/applitools-eyes-logo.png)
-### Applitools Eyes SDK for [Puppeteer](https://developers.google.com/web/tools/puppeteer)
-[![npm](https://img.shields.io/npm/v/@applitools/eyes-puppeteer.svg?style=for-the-badge)](https://www.npmjs.com/package/@applitools/eyes-puppeteer)
+## Installation
 
-</div>
-<br/>
+Install eyes-puppeteer as a local dev dependency in your tested project:
 
-## Resources
-- [Quick start](https://applitools.com/tutorials/quickstart/web/puppeteer)
-- [API reference](https://applitools.com/docs/api-ref/sdk-api/puppeteer/javascript/)
+```bash
+npm i -D @applitools/eyes-puppeteer
+```
+
+## Getting started
+
+To get started with this SDK, you need to set the following:
+
+* [Applitools API key](#API)
+* [Eyes server URL](#URL) - Required only if the Eyes server is not deployed on the Eyes public server.
+
+
+### Entering the Applitools API key {#API}
+
+To authenticate via the Applitools server and run tests, you need to set the environment variable `APPLITOOLS_API_KEY` to the API key provided from Applitools Eyes. For details how to retrieve your API key, see [the Applitools documentation](/getting-started/retrieve-api-key) in the  Eyes Knowledge Center.
+
+#### Entering the API Key on Linux or a Mac
+
+```bash
+export APPLITOOLS_API_KEY=<your_key>
+npm test
+```
+
+#### Entering the API Key on Windows
+
+```bash
+set APPLITOOLS_API_KEY=<your_key>
+npx test
+```
+
+#### Entering the API Key programmatically
+
+```js
+eyes.setApiKey('<your API key>')
+```
+
+### Eyes server URL {#URL}
+
+If the Eyes server is not deployed in `https://eyes.applitools.com`, you need to set the Server URL in the environment variable `APPLITOOLS_SERVER_URL`  before running tests.
+
+The server URL of your Applitools Eyes dashboard is in the format `https://<MY_COMPANY>.applitools.com`
+
+
+#### Entering the server URL on Linux or a Mac
+
+```bash
+export APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
+```
+
+#### Entering the server URL on Windows
+
+```bash
+set APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
+```
+
+
+
+
+
+
+## Further information
+
+For further information, see:
+
+* [Quickstart](https://applitools.com/tutorials/sdks/puppeteer/quickstart)
+* [Overview](https://applitools.com/tutorials/sdks/puppeteer)
+* [Changelog](https://applitools.com/tutorials/sdks/puppeteer/changelog)	

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-puppeteer",
-  "version": "1.29.1",
+  "version": "1.29.3",
   "description": "Applitools Eyes SDK for Puppeteer",
   "keywords": [
     "eyes-puppeteer",
@@ -37,8 +37,8 @@
     "up:framework": "echo \"$(jq '.devDependencies.puppeteer = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
   },
   "dependencies": {
-    "@applitools/eyes": "1.32.6",
-    "@applitools/spec-driver-puppeteer": "1.4.25"
+    "@applitools/eyes": "1.34.0",
+    "@applitools/spec-driver-puppeteer": "1.4.27"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.22",

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>;
@@ -266,14 +267,14 @@ export type CheckSettingsAutomationPlain = {
     scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
     fully?: undefined | boolean;
     disableBrowserFetching?: undefined | boolean;
-    layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
+    layoutBreakpoints?: undefined | (boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; } | { breakpoints: boolean; heightBreakpoints: boolean; reload?: undefined | boolean; });
     visualGridOptions?: undefined | { [key: string]: any; };
     ufgOptions?: undefined | { [key: string]: any; };
     nmgOptions?: undefined | { [key: string]: any; };
     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 {
@@ -295,8 +296,9 @@ export class CheckSettingsAutomation {
     fully(fully?: undefined | boolean): CheckSettingsAutomation;
     stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
     disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
-    layoutBreakpoints(breakpoints?: undefined | boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
-    layoutBreakpoints(breakpoints?: undefined | Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
+    layoutBreakpoints(breakpoints: boolean, heightBreakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
+    layoutBreakpoints(breakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
+    layoutBreakpoints(breakpoints: Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
     hook(name: string, script: string): CheckSettingsAutomation;
     beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
     webHook(script: string): CheckSettingsAutomation;
@@ -309,6 +311,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 +486,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 +523,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 +813,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>;