@applitools/eyes-testcafe 2.0.0-beta.8 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,467 @@
+# Change Log
+
+## Unreleased
+
+
+
+
+
+
+
+
+
+
+
+
+## [2.0.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-testcafe-v1.17.4...js/eyes-testcafe@2.0.0) (2023-09-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* drop support of node <16
+
+### Features
+
+* drop support of node &lt;16 ([e743d81](https://github.com/applitools/eyes.sdk.javascript1/commit/e743d814cbd3725dde1304a36a31ccf7d88b16bc))
+* update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+### Code Refactoring
+
+* refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+* use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.1
+  #### Bug Fixes
+
+  * add browser entry point declaration and test ([#1933](https://github.com/applitools/eyes.sdk.javascript1/issues/1933)) ([5ba0720](https://github.com/applitools/eyes.sdk.javascript1/commit/5ba0720d62a9af8a9a2e1c2437c569e6ab19afd8))
+
+
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+* @applitools/logger bumped to 2.0.11
+  #### Bug Fixes
+
+  * add browser entry point declaration and test ([#1933](https://github.com/applitools/eyes.sdk.javascript1/issues/1933)) ([5ba0720](https://github.com/applitools/eyes.sdk.javascript1/commit/5ba0720d62a9af8a9a2e1c2437c569e6ab19afd8))
+
+
+
+* @applitools/socket bumped to 1.1.11
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/req bumped to 1.6.1
+  #### Bug Fixes
+
+  * add browser entry point declaration and test ([#1933](https://github.com/applitools/eyes.sdk.javascript1/issues/1933)) ([5ba0720](https://github.com/applitools/eyes.sdk.javascript1/commit/5ba0720d62a9af8a9a2e1c2437c569e6ab19afd8))
+
+
+
+* @applitools/image bumped to 1.1.6
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.2.2
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/ufg-client bumped to 1.9.2
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/core bumped to 3.11.2
+  #### Reverts
+
+  * perform major changes ([994cd70](https://github.com/applitools/eyes.sdk.javascript1/commit/994cd703ebe891bf68aecd49d77b5fb119f6ebe8))
+
+
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.0.46
+
+* @applitools/spec-driver-selenium bumped to 1.5.60
+
+* @applitools/driver bumped to 1.14.2
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/screenshoter bumped to 3.8.12
+
+* @applitools/nml-client bumped to 1.5.12
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/tunnel-client bumped to 1.2.3
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/ec-client bumped to 1.7.10
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/core-base bumped to 1.6.1
+  #### Reverts
+
+  * perform major changes ([994cd70](https://github.com/applitools/eyes.sdk.javascript1/commit/994cd703ebe891bf68aecd49d77b5fb119f6ebe8))
+
+
+  #### Code Refactoring
+
+  * use Uint8Array instead of Buffer for binary data representation ([#1928](https://github.com/applitools/eyes.sdk.javascript1/issues/1928)) ([d1472ab](https://github.com/applitools/eyes.sdk.javascript1/commit/d1472ab8fd49e9a240e99a44dbf1d180b6c7a54b))
+
+
+
+* @applitools/eyes bumped to 1.9.1
+
+
+## [1.1.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-testcafe@1.1.0...js/eyes-testcafe@1.1.1) (2023-09-12)
+
+
+### Dependencies
+
+* @applitools/core bumped to 3.10.4
+  #### Bug Fixes
+
+  * update dom-snapshot to support xml pages and parens inside css URLs ([0715d56](https://github.com/applitools/eyes.sdk.javascript1/commit/0715d56c675b23be017c1985cbba3a51aba052b1))
+* @applitools/eyes bumped to 1.8.4
+
+
+## [1.1.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-testcafe-v1.0.1...js/eyes-testcafe@1.1.0) (2023-09-11)
+
+
+### Features
+
+* update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+### Code Refactoring
+
+* refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+### Dependencies
+
+* @applitools/core bumped to 3.10.3
+  #### Bug Fixes
+
+  * suppport coded regions with layoutBreakpoints reload ([7903347](https://github.com/applitools/eyes.sdk.javascript1/commit/79033472b9475992a44cf3828ff334c958ae2066))
+* @applitools/eyes bumped to 1.8.3
+
+
+## 1.0.0 (2023-09-04)
+
+
+### Features
+
+* update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+### Code Refactoring
+
+* refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.0
+  #### Features
+
+  * add support for fallback in `req` ([#1899](https://github.com/applitools/eyes.sdk.javascript1/issues/1899)) ([d69c4b5](https://github.com/applitools/eyes.sdk.javascript1/commit/d69c4b5830370c471dfc25b6e2caddca8b458df9))
+* @applitools/socket bumped to 1.1.10
+
+* @applitools/req bumped to 1.6.0
+  #### Features
+
+  * add support for fallback in `req` ([#1899](https://github.com/applitools/eyes.sdk.javascript1/issues/1899)) ([d69c4b5](https://github.com/applitools/eyes.sdk.javascript1/commit/d69c4b5830370c471dfc25b6e2caddca8b458df9))
+  * update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+
+* @applitools/image bumped to 1.1.5
+
+* @applitools/spec-driver-webdriver bumped to 1.0.44
+
+* @applitools/spec-driver-selenium bumped to 1.5.58
+
+* @applitools/spec-driver-puppeteer bumped to 1.2.0
+  #### Features
+
+  * update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+
+* @applitools/ufg-client bumped to 1.8.0
+  #### Features
+
+  * add support for fallback in `req` ([#1899](https://github.com/applitools/eyes.sdk.javascript1/issues/1899)) ([d69c4b5](https://github.com/applitools/eyes.sdk.javascript1/commit/d69c4b5830370c471dfc25b6e2caddca8b458df9))
+
+
+
+* @applitools/logger bumped to 2.0.10
+
+* @applitools/driver bumped to 1.14.0
+  #### Features
+
+  * update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+
+* @applitools/screenshoter bumped to 3.8.10
+
+* @applitools/nml-client bumped to 1.5.10
+
+* @applitools/tunnel-client bumped to 1.2.2
+
+* @applitools/ec-client bumped to 1.7.7
+
+* @applitools/core-base bumped to 1.5.3
+
+* @applitools/core bumped to 3.10.1
+
+* @applitools/eyes bumped to 1.8.1
+
+
+## 1.17.4 - 2022/8/25
+
+### Features
+- Don't fail `eyes.open` when there is a failure to set viewport size in `UFG`.
+### Bug fixes
+- Added `next` sub-module to support `index.d.ts`. added it both with `exports` and `typesVersions`
+- fix selector issue in `testcafe`, the selector and the element are the same and once there are multi selector the it's only peak the element
+
+## 1.17.3 - 2022/7/28
+
+### Features
+- Add the ability for the SDK to lazy load the page prior to performing a check window
+- Support padding for regions in the following region types - ignoreRegions, layoutRegions, strictRegions, contentRegions
+### Bug fixes
+- Fix calling `waitBeforeCapture` when failed to set required viewport size
+- Fix rendering issues with Salesforce Lightning design system
+- Fix issue that prevented self-signed certificates from working when connecting through a proxy server
+- Allow configuration file to be loaded from ancestor directories
+- Fixed bug where a failure in a single UFG environment fails all other environments in the same configuration
+- Better support in DOM slot element
+
+## 1.17.2 - 2022/6/8
+
+### Features
+- Allowed `` values in custom properties
+### Bug fixes
+- Fixed broken links to enums implementation in the README.md
+- Fixed `forceFullPageScreenshot` option behavior
+
+## 1.17.1 - 2022/6/2
+
+### Features
+### Bug fixes
+- Fix rounding error of image size when scaling introduces fractions
+
+## 1.17.0 - 2022/6/1
+
+### Features
+- Dorp support for Node.js versions <=12
+### Bug fixes
+- Fixed incorrect calculation of coded regions in classic mode when using CSS stitching
+
+## 1.16.2 - 2022/5/27
+
+### Features
+### Bug fixes
+- Fixed `CheckSetting`'s `fully` being overridden by `Configuration`'s `forceFullPageScreenshot`
+- Set EyesExceptions (such as new test, diffs exception and failed test exception) to exception property in TestResultsSummary
+- Returned support of `showLogs` in configuration file and object
+- Improve error message when failed to set viewport size
+
+## 1.16.1 - 2022/5/19
+
+### Features
+- Support Galaxy S22 `DeviceName.Galaxy_S22` emulation device
+### Bug fixes
+- Fixed the error with importing `testcafe` module
+
+## 1.16.0 - 2022/5/17
+
+### Features
+- Support UFG for native mobile
+- `runner.getAllTestResults` returns the corresponding UFG browser/device configuration for each test. This is available as `runner.getAllTestResults()[i].browserInfo`.
+- Support `failTestcafeOnDiff` as environment variable `APPLITOOLS_FAIL_TESTCAFE_ON_DIFF`
+- Support iPhone SE `IosDeviceName.iPhone_SE` and iPhone 8 Plus `IosDeviceName.iPhone_8_Plus` iOS devices
+### Bug fixes
+- `runner.getAllTestResults` now aborts unclosed tests
+- `runner.getAllTestResults` now returns all results, including aborted tests
+- `extractText` now supports regions that don't use hints while using `x`/`y` coordinates
+- Support data urls in iframes
+
+## 1.15.5 - 2022/2/22
+
+- add support for configuring notifyOnCompletion through an environment variable ([Trello](https://trello.com/c/WWdwQvpv))
+- updated to @applitools/eyes-sdk-core@13.0.6 (from 13.0.5)
+- updated to @applitools/visual-grid-client@15.9.0 (from 15.8.65)
+
+## 1.15.4 - 2022/2/16
+
+- fixing: Screenshotter dependency consuming 40+ MB of space
+- updated to @applitools/eyes-api@1.1.8 (from 1.1.7)
+- updated to @applitools/eyes-sdk-core@13.0.5 (from 13.0.0)
+- updated to @applitools/utils@1.2.13 (from 1.2.11)
+- updated to @applitools/visual-grid-client@15.8.65 (from 15.8.62)
+- updated to @applitools/visual-grid-client@15.8.65 (from 15.8.62)
+## 1.15.3 - 2022/1/24
+
+- updated 'Agent ID' to 'eyes.testcafe' (from 'eyes.webdriverio')
+- updated to @applitools/eyes-api@1.1.7 (from 1.1.6)
+- updated to @applitools/eyes-sdk-core@13.0.0 (from 12.24.13)
+- updated to @applitools/visual-grid-client@15.8.62 (from 15.8.60)
+
+## 1.15.2 - 2022/1/14
+
+- remove `esModuleInterop` ts compile option
+
+## 1.15.1 - 2022/1/13
+
+- set failTestcafeOnDiff default value to true
+- updated to @applitools/eyes-api@1.1.6 (from 1.1.0)
+- updated to @applitools/eyes-sdk-core@12.24.9 (from 12.23.3)
+- updated to @applitools/utils@1.2.11 (from 1.2.2)
+- updated to @applitools/visual-grid-client@15.8.55 (from 15.8.24)
+- updated to @applitools/eyes-sdk-core@12.24.13 (from 12.24.9)
+- updated to @applitools/visual-grid-client@15.8.60 (from 15.8.55)
+
+## 1.15.0 - 2021/9/6
+
+- updated to @applitools/eyes-api@1.1.0 (from 1.0.7)
+- updated to @applitools/eyes-sdk-core@12.23.3 (from 12.21.5)
+- updated to @applitools/utils@1.2.2 (from 1.2.0)
+- updated to @applitools/visual-grid-client@15.8.24 (from 15.8.13)
+
+## 1.14.3 - 2021/7/14
+
+- fix issue with `Eyes` being exported as a type from legacy type definition file
+
+## 1.14.2 - 2021/7/14
+
+- introduced @applitools/eyes-api package with new api
+- updated to @applitools/eyes-api@1.0.7 (from 1.0.3)
+- updated to @applitools/eyes-sdk-core@12.21.5 (from 12.20.0)
+- updated to @applitools/visual-grid-client@15.8.13 (from 15.8.7)
+
+## 1.14.1 - 2021/5/25
+
+- added full typescript support
+- introduced @applitools/eyes-api package with new api
+- updated to @applitools/eyes-api@1.0.3 (from 1.0.1)
+- updated to @applitools/eyes-sdk-core@12.20.0 (from 12.19.3)
+- updated to @applitools/utils@1.2.0 (from 1.1.3)
+- updated to @applitools/visual-grid-client@15.8.7 (from 15.8.6)
+
+## 1.14.0 - 2021/5/13
+
+- added full typescript support
+- introduced @applitools/eyes-api package with new api
+- updated to @applitools/eyes-api@1.0.1 (from 0.0.2)
+- updated to @applitools/eyes-sdk-core@12.19.3 (from 12.14.2)
+- updated to @applitools/utils@1.1.3 (from 1.1.0)
+- updated to @applitools/visual-grid-client@15.8.6 (from 15.5.14)
+
+## 1.13.1 - 2021/4/22
+
+- fix types for eyes open
+- updated to @applitools/visual-grid-client@15.8.1 (from 15.8.0)
+
+## 1.13.0 - 2021/4/22
+
+- updated to @applitools/visual-grid-client@15.8.0 (from 15.7.1)
+
+## 1.12.8 - 2021/4/6
+
+- updated to @applitools/eyes-sdk-core@12.17.2 (from 12.16.0)
+- updated to @applitools/visual-grid-client@15.7.1 (from 15.6.0)
+
+## 1.12.7 - 2021/3/15
+
+- updated to @applitools/eyes-sdk-core@12.16.0 (from 12.15.0)
+
+## 1.12.6 - 2021/3/3
+
+- fix bug that prevented window resizing from working reliably ([Trello](https://trello.com/c/xNCZNfPi))
+- updated to @applitools/eyes-sdk-core@12.15.0 (from 12.14.10)
+- updated to @applitools/visual-grid-client@15.6.0 (from 15.5.20)
+
+## 1.12.5 - 2021/2/2
+
+- fix default checkWindow behavior- take full page when no target is specified
+- set minimum supported Node version to be consistent with other SDKs (8.9)
+- updated to @applitools/eyes-sdk-core@12.14.7 (from 12.14.2)
+- updated to @applitools/visual-grid-client@15.5.20 (from 15.5.13)
+
+## 1.12.4 - 2021/1/27
+
+- chore: add husky
+- update peer dependency version of testcafe to include earlier versions (e.g., 1.7.x)
+- fix issue where the browser is in an invalid state but eyes.open tries to proceed ([Trello](https://trello.com/c/xNCZNfPi))
+- updated to @applitools/eyes-sdk-core@12.14.2 (from 12.13.0)
+- updated to @applitools/visual-grid-client@15.5.13 (from 15.5.6)
+
+## 1.12.3 - 2021/1/13
+
+- fix for fetching font-face resources from stylesheets [Trello](https://trello.com/c/DwmxtRoR)
+- updated to @applitools/eyes-sdk-core@12.13.0 (from 12.12.2)
+- updated to @applitools/visual-grid-client@15.5.6 (from 15.5.5)
+
+## 1.12.2 - 2021/1/11
+
+- fixed default checkWindow behavior (when no options are provided) to respect backwards compatibility -- so it captures a full page screenshot instead of just the viewport
+- fixed bug in specifying a tag name in checkWindow
+- updated to @applitools/eyes-sdk-core@12.12.2 (from 12.12.1)
+- updated to @applitools/visual-grid-client@15.5.5 (from 15.5.4)
+
+## 1.12.1 - 2021/1/9
+
+- fix performance issue with checkWindow command when used on pages of a non-trivial size
+- updated to @applitools/eyes-sdk-core@12.12.1 (from 12.12.0)
+- updated to @applitools/visual-grid-client@15.5.4 (from 15.5.3)
+
+## 1.12.0 - 2021/1/9
+
+- Updated SDK to use new core with backwards compatibility for existing API [Trello](https://trello.com/c/MZimmaSV)
+- Added support for new Eyes concurrency model [Trello](https://trello.com/c/a7xq2hlL)
+- Added JS layout support [Trello](https://trello.com/c/9dzS8FhB)
+- Added CORS iframe support [Trello](https://trello.com/c/wPl3ef7y)
+- Fix bugs in fetching resources due to TestCafe reverse proxy URLs [Trello](https://trello.com/c/nlMUhJTp)
+- updated to @applitools/visual-grid-client@15.5.3 (from 15.5.0)
+
+## earlier versions
+
+- omitted

package/LICENSE

@@ -1,4 +1,4 @@
--  -
+-  -
 SDK LICENSE AGREEMENT
 IMPORTANT - PLEASE READ CAREFULLY THE TERMS OF THIS LICENSE AGREEMENT (“AGREEMENT”). BY INSTALLING, ACCESSING AND/OR USING THE SOFTWARE (AS DEFINED BELOW), YOU EXPRESSLY ACKNOWLEDGE AND AGREE THAT YOU, OR THE COMPANY YOU REPRESENT, (“YOU” OR “LICENSEE”) ARE ENTERING INTO A LEGAL AGREEMENT WITH APPLITOOLS LTD. AND ITS AFFILIATES (“APPLITOOLS”), AND HAVE UNDERSTOOD AND AGREE TO COMPLY WITH, AND BE LEGALLY BOUND BY, THE TERMS AND CONDITIONS OF THIS AGREEMENT. YOU HEREBY WAIVE ANY RIGHTS OR REQUIREMENTS UNDER ANY LAWS OR REGULATIONS IN ANY JURISDICTION WHICH REQUIRE AN ORIGINAL (NON-ELECTRONIC) SIGNATURE OR DELIVERY OR RETENTION OF NON-ELECTRONIC RECORDS, TO THE EXTENT PERMITTED UNDER APPLICABLE LAW. 
 THE SOFTWARE MAY BE USED SOLELY FOR YOUR PERSONAL, NON-COMMERCIAL PURPOSES. FOR COMMERCIAL PURPOSES PLEASE CONTACT THE REGIONAL APPLITOOLS BUSINESS REPRESENTATIVE.