Cypress SDK

v4.13.0 (2025-04-03)

• Switched to Analysis-Web v14.22.0.
• Changed reporters dependencies.

v4.12.0(2025-03-12)

• Switched to Analysis-Web v14.20.1.
• Added configurations for debounce/throttle functionality

v4.11.0 (2025-02-12)

• Switched to Analysis-Web v14.19.0.

v4.10.0 (2025-02-11)

• Switched to Analysis-Web v14.17.0.
• Update engine initialisation script with data needed for analytics.

v4.9.0 (2025-02-10)

• Moved token verification from the Engine to the SDK.

v4.8.0 (2025-01-10)

• Switched to Analysis-Web v14.13.0.

v4.7.0 (2024-11-26)

• Switched to Analysis-Web v14.8.2.
• Bugfix: Fixed screenshots support for JSON reports.

v4.6.1 (2024-11-05)

• License info updated

v4.6.0 (2024-10-24)

• Switching to the Analysis-Web v14.4.1

v4.5.0 (2024-09-02)

• Added support for the external configuration file evConfig.json for the Upload to Platform feature

v4.4.1 (2024-08-29)

• Changes in proxy configuration for the Platform Upload.

v4.4.0 (2024-08-28)

• Switching to the semantic engine 13.2.0

v4.3.0 (2024-08-27)

• The Upload to the platform feature added.

v4.2.0 (2024-08-12)

• Switching to the semantic engine 13.1.2

v4.1.2 (2024-08-21)

• Bugfix: Displaying KB links for AXE issues in the report.

v4.1.0 (2024-06-27)

• Switching to the semantic engine 13.1.0

v4.0.6 (2024-05-27)

• Removed symbols in the file name that are not allowed for Windows OS.

v4.0.5 (2024-05-09)

• Updating axios.

v4.0.4 (2024-04-26)

• Bugfix: Fix for aggregated report being not generated in case of empty reports.

v4.0.3 (2024-03-27)

• Handling empty reports.

v4.0.2 (2024-02-26)

• Adding new options for engine configuration.

v4.0.1 (2024-02-14)

• Adding compatibility with Node 21.

v4.0.0 (2024-01-15)

• Enabling the Ev Core functionality.

v3.20.0 (2024-01-18)

• Bugfix: Fix for aggregated report to include screenshots when the feature is enabled.

v3.19.0 (2024-01-12)

• Switching to the semantic engine 11.0.0

v3.18.0 (2023-12-26)

• Add CSV reporting

v3.17.0 (2023-12-25)

• Switching to the semantic engine 10.1.1

v3.16.0 (2023-11-23)

• Switching to the semantic engine 10.0.1

  1. Fix failure when running sdk on electron
  2. Deal with the async nature of EvCore

v3.15.0 (2023-09-19)

• Switching to the semantic engine 8.3.2

v3.14.0 (2023-08-25)

• Switching to the semantic engine 8.2.0

v3.13.0 (2023-07-21)

• Improvements for the Aggregated Report feature for Cypress 10+
• The screenshots feature is added
• Global Switch ON/OFF: the Evinced functionality can be switched off with the Cypress environment variable or a Global environment variable CYPRESS_EV_SWITCH_ON.

v3.12.0 (2023-07-10)

• Bugfix: Fix for merging config options passed via init, evStart, and evAnalyze

v3.11.0 (2023-07-05)

• The Aggregated Report feature for Cypress 10+ is added

v3.10.0 (2023-06-16)

• Adding new functionality for saving reports

v3.9.0 (2023-06-12)

• Switching to the semantic engine 8.1.0

  1. [UF] Upgrade axe version to 4.7.2 with minor bugfixes and improvements:

  • link-in-text-block Added needs review violations
  • aria-allowed-attr
  • aria-required-children
  • color-contrast

v3.8.0 (2023-05-30)

• Bugfix: Fix crashes when evStart-command is called from before-hook

v3.7.0 (2023-05-17)

• Switching to the semantic engine 8.0.0

  1. [UF] Revisited Accessible Name false positives for elements with IDs containing special characters when shadow DOM is supported
  2. [UF] Added Support for new evCore only validation 'Meaningless Alt Text'
  3. [UF] Upgrade axe version to 4.7.0 with minor bugfixes and improvements:

  • scrollable-region-focusable changed severity level from moderate to serious
  • aria-required-children
  • color-contrast
  • link-in-text-block

v3.6.0 (2023-04-25)

• Adding SPAs' support

v3.5.0 (2023-04-20)

• Switching to the semantic engine 7.4.0

  1. [UF] Fixed a crash when internal iframes finish loading before the main window
  2. [UF] Bugfix: Fix crashes when the Shadow DOM toggle is on

v3.4.0 (2023-03-09)

• Switching to the semantic engine 7.2.1

  • minor bugfix for SVGs at isInViewport calculation

v3.3.0 (2023-02-24)

• Improving merging of configs passed by init() and ev-commands
• Fix of types declarations for config options passed via evStart and evAnalyze

v3.2.0 (2023-02-14)

• Switching to the semantic engine 7.2.0

  • [UF] Provide configuration to override issues' severity level. Usage:

  1CONFIG.CUSTOM_ISSUE_SEVERITY: {
  2 WRONG_SEMANTIC_ROLE: 'Low',
  3 'AXE-ARIA-ALLOWED-ROLE': 'High'
  4}

  • [UF] Provide configuration to override issue's severity names. Usage:

  1CONFIG.CUSTOM_SEVERITY_NAMES:  {
  2 CRITICAL: 'High',
  3 SERIOUS: 'High',
  4 MINOR: 'Low'
  5}

  • [UF] Upgrade axe version to 4.6.3 with minor bugfixes and improvements to:
    • link-in-text-block
    • color-contrast
    • aria-required-children
    • scrollable-region-focusable
    • autocomplete-valid

v3.1.0 (2023-02-13)

• Added ability to pass knowledgeBaseLink-parameter via init() for passing custom settings for representation Issues in the reports

v3.0.0 (2023-02-07)

• Base SDK on Cypress version 10 instead of 8
• Removal of the deprecated evReport-command

v2.10.0 (2023-01-26)

• Temporarily turning off SPA support

v2.9.0-spa (2023-01-24)

• Fix an incorrect amount of issues' bug when calling evStart-command in tests with navigation over SPA
• Temporarily turning off of the Language detection validation
• Switching to the semantic engine 7.0.0

  • Bugfix: Provided a compatibility of html-report-generator with the Node v14 (replaceAll-method substitution).
  • [UF] upgraded AXE version to 4.5.2
    • 2 new validations were added, disabled by default: meta-refresh-no-exceptions, target-size
    • link-in-text-block is now a "regular"/"needs review" validation, and enabled by default
    • empty-table-header validation was changed from "needs review" to "best practice"
    • input-image-alt and meta-viewport are no longer best practices.
    • Deprecated Internet Explorer support

v2.8.0 (2022-11-16)

• Switching on licensing
• Correct default internal configuration of feature flags
• Added ability to pass skipValidations-parameter via evStart() and evAnalyze() for tuning engine validators settings
• Added new option to the evSaveFile command for saving reports in SARIF format
• Downgrading requirements for Node (to >=12)
• Switching to the semantic engine 4.0.0

  1. Ignore validations for dynamically created href (false pos)

v2.6.0 (2022-09-29)

• Switching to the semantic engine 2.1.0

  1. Added a new Evinced validation: "Unadjustable Text Spacing"
  2. Disabled AXE's "avoid-inline-spacing" validation for its False Positives rate. The issue will be covered by the new "Unadjustable Text Spacing" validation.
  3. Minor bugfix of wrong order validations algorithm.
  4. Bugfix in license check

v2.5.0 (2022-08-31)

• Logging API to manage engine's logging behavior
• Temporary switch off licensing
• Switching to the semantic engine 2.0.0

  1. Introducing a new validation: missing focus indication
  2. Rename validation: from now on, focus indication will be called insufficient focus indication
  3. HTML report rebranding

v2.4.1 (2022-04-21)

• Renamed evReport() to evAnalyze(). evReport() is considered deprecated and will be removed in the next major release
• When turning on logIssues, the log title will be evIssue instead of evReport
• Every Evinced command is now logged to Cypress' log (via cy.log())
• "When not in strict mode, internal Evinced exceptions will be caught and converted to warnings

v2.3.1 (2022-03-03)

• Delete redundant API from AnalysisReportComponent type
• Change package scope from evinced-private to evinced

v2.3.0 (2022-02-21)

Features

• New evSaveFile command for saving the report in JSON and HTML format

Documentation

• Updated README documentation according to new evSaveFile command
• Updated type-declarations according to new evSaveFile command

v2.2.0 (2021-12-20)

Features

• Performance improvements
• Use axe 4.3.3
• Improve the construction of elements' selectors

Bug Fixes

• Fix a console error when visiting a page before running an Evinced command

Documentation

• Removed redundant comment about evStart in beforeEach

v2.1.0 (2021-07-25)

Features

• Verified support for Cypress 8
• Better support for web components slots
• Add more logs when in debug mode

Bug Fixes

• Fix recording while page navigation in SPAs
• Fix evValid to be used without providing any options
• Fix case-sensitive placeholder comparisons
• Fix forms with inputs named children
• Fix epic link fields in Jira tickets

Documentation

• Added more Knowledge Base links

v2.0.0 (2021-06-23)

Features

• Simplify the signature of evValid and add type declarations
• Add option to evValid to filter issues by type
• Add raw issue data to Cypress log when used by logIssues in evReport/evStop
• Disable telemetry reporting
• Clean Evinced state between tests in case Cypress reuses the same window instance
• Add license file
• Verified support for Cypress 7
• Upgrade Axe to 4.2.0
• Ignore Google Maps components

Bug Fixes

• Fix a race condition bug when using evStart in beforeEach

Documentation

• Add evValid examples
• Add axeConfig example

v1.2.0 (2021-04-19)

Features

• Support Axe configuration
• Add strict mode option (throw exceptions on warnings)
• Enable telemetry reporting (collect scanned URLs, validations, and performance metrics)

Documentation

• Minor note regarding calling evStart in beforeEach
• Add Axe config types

Bug Fixes

• Fix calling evStart() when Cypress window doesn't exist yet (in beforeEach for example)

v1.1.0 (2021-04-08)

Features

• Add Typescript declerations

Documentation

• Add JSDoc documentation

Bug Fixes

• Throw an exception when calling evStop() without calling evStart() first
• Print a warning when calling evStart() multiple times