@sa11y/jest 6.9.0 → 6.9.2

package/dist/groupViolationResultsProcessor.d.ts

@@ -6,5 +6,6 @@ import { AggregatedResult } from '@jest/test-result';
  * Ref: https://jestjs.io/docs/configuration#testresultsprocessor-string
  *  - Mapping of AggregatedResult to JSON format to https://github.com/facebook/jest/blob/master/packages/jest-test-result/src/formatTestResults.ts
  */
-export default function resultsProcessor(results: AggregatedResult): AggregatedResult;
+export declare function resultsProcessor(results: AggregatedResult): AggregatedResult;
+export declare function resultsProcessorManualChecks(results: AggregatedResult): AggregatedResult;
 //# sourceMappingURL=groupViolationResultsProcessor.d.ts.map

package/dist/groupViolationResultsProcessor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"groupViolationResultsProcessor.d.ts","sourceRoot":"","sources":["../src/groupViolationResultsProcessor.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAA+B,MAAM,mBAAmB,CAAC;AAyJlF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAapF"}
+{"version":3,"file":"groupViolationResultsProcessor.d.ts","sourceRoot":"","sources":["../src/groupViolationResultsProcessor.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAA+B,MAAM,mBAAmB,CAAC;AAkLlF;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAa5E;AAED,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAaxF"}

package/dist/groupViolationResultsProcessor.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.resultsProcessorManualChecks = exports.resultsProcessor = void 0;
 const common_1 = require("@sa11y/common");
 const format_1 = require("@sa11y/format");
 const formatSpacing = '\t'.repeat(8);
@@ -54,6 +55,52 @@ function createA11yRuleViolation(a11yRule, ruleIndex) {
                 • Help URL: ${a11yRule.helpUrl}
                 • WCAG Criteria: ${a11yRule.wcagCriteria}`;
 }
+/**
+ * Create a test processA11yDetailsAndMessages violation error message grouped by rule violation
+ */
+function processA11yDetailsAndMessages(error, a11yFailureMessages) {
+    const a11yRuleViolations = {};
+    let a11yRuleViolationsCount = 0;
+    let a11yErrorElementsCount = 0;
+    error.a11yResults.forEach((a11yResult) => {
+        a11yErrorElementsCount++;
+        if (!a11yRuleViolations[a11yResult.wcag]) {
+            a11yRuleViolationsCount++;
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            a11yRuleViolations[a11yResult.wcag] = {
+                id: a11yResult.id,
+                description: a11yResult.description,
+                helpUrl: a11yResult.helpUrl,
+                wcagCriteria: a11yResult.wcag,
+                summary: a11yResult.summary,
+                errorElements: [],
+            };
+        }
+        a11yRuleViolations[a11yResult.wcag].errorElements.push({
+            html: a11yResult.html,
+            selectors: a11yResult.selectors,
+            hierarchy: a11yResult.ancestry,
+            any: a11yResult.any,
+            all: a11yResult.all,
+            none: a11yResult.none,
+        });
+    });
+    const a11yFailureMessage = `
+    The test has failed the accessibility check. Accessibility Stacktrace/Issues:
+    ${a11yErrorElementsCount} HTML elements have accessibility issue(s). ${a11yRuleViolationsCount} rules failed.
+
+    ${Object.values(a11yRuleViolations)
+        .map((a11yRuleViolation, index) => createA11yRuleViolation(a11yRuleViolation, index + 1))
+        .join('\n')}
+
+
+    For more info about automated accessibility testing: https://sfdc.co/a11y-test
+    For tips on fixing accessibility bugs: https://sfdc.co/a11y
+    For technical questions regarding Salesforce accessibility tools, contact our Sa11y team: http://sfdc.co/sa11y-users
+    For guidance on accessibility related specifics, contact our A11y team: http://sfdc.co/tmp-a11y
+    `;
+    a11yFailureMessages.push(a11yFailureMessage);
+}
 /**
  * Convert any a11y errors from test failures into their own test suite, results
  */
@@ -71,47 +118,7 @@ function processA11yErrors(results, testSuite, testResult) {
         if (error.name === format_1.A11yError.name) {
             a11yErrorsExist = true;
             a11yFailureDetails.push({ ...failure });
-            const a11yRuleViolations = {};
-            let a11yRuleViolationsCount = 0;
-            let a11yErrorElementsCount = 0;
-            error.a11yResults.forEach((a11yResult) => {
-                a11yErrorElementsCount++;
-                if (!a11yRuleViolations[a11yResult.wcag]) {
-                    a11yRuleViolationsCount++;
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                    a11yRuleViolations[a11yResult.wcag] = {
-                        id: a11yResult.id,
-                        description: a11yResult.description,
-                        helpUrl: a11yResult.helpUrl,
-                        wcagCriteria: a11yResult.wcag,
-                        summary: a11yResult.summary,
-                        errorElements: [],
-                    };
-                }
-                a11yRuleViolations[a11yResult.wcag].errorElements.push({
-                    html: a11yResult.html,
-                    selectors: a11yResult.selectors,
-                    hierarchy: a11yResult.ancestry,
-                    any: a11yResult.any,
-                    all: a11yResult.all,
-                    none: a11yResult.none,
-                });
-            });
-            const a11yFailureMessage = `
-            The test has failed the accessibility check. Accessibility Stacktrace/Issues:
-            ${a11yErrorElementsCount} HTML elements have accessibility issue(s). ${a11yRuleViolationsCount} rules failed.
-
-            ${Object.values(a11yRuleViolations)
-                .map((a11yRuleViolation, index) => createA11yRuleViolation(a11yRuleViolation, index + 1))
-                .join('\n')}
-
-
-            For more info about automated accessibility testing: https://sfdc.co/a11y-test
-            For tips on fixing accessibility bugs: https://sfdc.co/a11y
-            For technical questions regarding Salesforce accessibility tools, contact our Sa11y team: http://sfdc.co/sa11y-users
-            For guidance on accessibility related specifics, contact our A11y team: http://sfdc.co/tmp-a11y
-            `;
-            a11yFailureMessages.push(a11yFailureMessage);
+            processA11yDetailsAndMessages(error, a11yFailureMessages);
         }
     });
     if (!a11yErrorsExist) {
@@ -124,6 +131,16 @@ function processA11yErrors(results, testSuite, testResult) {
     testResult.failureMessages = [...a11yFailureMessages];
     testResult.status = a11yFailureDetails.length === 0 ? 'passed' : testResult.status;
 }
+function processA11yMatcherErrors(results, testSuite, testResult) {
+    const a11yFailureMessages = [];
+    testResult.failureDetails.forEach((failure) => {
+        const error = failure?.error?.matcherResult?.a11yError;
+        if (error !== undefined) {
+            processA11yDetailsAndMessages(error, a11yFailureMessages);
+            testResult.failureMessages = [...a11yFailureMessages];
+        }
+    });
+}
 /**
  * Custom results processor for a11y results grouping the violations. Only affects JSON results file output.
  * To be used with jest cli options --json --outputFile
@@ -144,7 +161,26 @@ function resultsProcessor(results) {
     });
     return results;
 }
-exports.default = resultsProcessor;
+exports.resultsProcessor = resultsProcessor;
+function resultsProcessorManualChecks(results) {
+    (0, common_1.log)(`Processing ${results.numTotalTests} tests ..`);
+    results.testResults // suite results
+        .filter((testSuite) => testSuite.numFailingTests > 0)
+        .forEach((testSuite) => {
+        testSuite.testResults // individual test results
+            .filter((testResult) => testResult.status === 'failed')
+            .forEach((testResult) => {
+            processA11yMatcherErrors(results, testSuite, testResult);
+        });
+    });
+    return results;
+}
+exports.resultsProcessorManualChecks = resultsProcessorManualChecks;
 // The processor must be a node module that exports a function
-module.exports = resultsProcessor;
+// Explicitly typing the exports for Node.js compatibility
+const exportedFunctions = {
+    resultsProcessor,
+    resultsProcessorManualChecks,
+};
+module.exports = exportedFunctions;
 //# sourceMappingURL=groupViolationResultsProcessor.js.map

package/dist/matcher.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="jest" />
 import { A11yCheckableContext } from '@sa11y/assert';
+import { A11yError } from '@sa11y/format';
 import { A11yConfig } from '@sa11y/common';
 declare global {
     namespace jest {
@@ -13,7 +14,9 @@ declare global {
  * @param received - DOM or HTML Element to be tested for accessibility. Defaults to current DOM.
  * @param config - A11yConfig to be used to test for accessibility. Defaults to `base` ruleset.
  */
-export declare function toBeAccessible(received?: A11yCheckableContext, config?: A11yConfig): Promise<jest.CustomMatcherResult>;
+export declare function toBeAccessible(received?: A11yCheckableContext, config?: A11yConfig): Promise<jest.CustomMatcherResult & {
+    a11yError: A11yError;
+}>;
 /**
  * Detect if fake timer is being used in a jest test.
  * Fake timers result in axe timeout https://github.com/dequelabs/axe-core/issues/3055

package/dist/matcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matcher.d.ts","sourceRoot":"","sources":["../src/matcher.ts"],"names":[],"mappings":";AASA,OAAO,EAAE,oBAAoB,EAAoB,MAAM,eAAe,CAAC;AAGvE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI3C,OAAO,CAAC,MAAM,CAAC;IAEX,UAAU,IAAI,CAAC;QAEX,UAAU,QAAQ,CAAC,CAAC,CAAE,SAAQ,IAAI,CAAC,aAAa;YAC5C,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;SACrE;KACJ;CACJ;AAeD;;;;GAIG;AACH,wBAAsB,cAAc,CAChC,QAAQ,GAAE,oBAA+B,EACzC,MAAM,GAAE,UAA2B,GACpC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CA8BnC;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAO9C"}
+{"version":3,"file":"matcher.d.ts","sourceRoot":"","sources":["../src/matcher.ts"],"names":[],"mappings":";AASA,OAAO,EAAE,oBAAoB,EAAoB,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,SAAS,EAAW,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI3C,OAAO,CAAC,MAAM,CAAC;IAEX,UAAU,IAAI,CAAC;QAEX,UAAU,QAAQ,CAAC,CAAC,CAAE,SAAQ,IAAI,CAAC,aAAa;YAC5C,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;SACrE;KACJ;CACJ;AAeD;;;;GAIG;AACH,wBAAsB,cAAc,CAChC,QAAQ,GAAE,oBAA+B,EACzC,MAAM,GAAE,UAA2B,GACpC,OAAO,CAAC,IAAI,CAAC,mBAAmB,GAAG;IAAE,SAAS,EAAE,SAAS,CAAA;CAAE,CAAC,CA+B9D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAO9C"}

package/dist/matcher.js

@@ -52,6 +52,7 @@ async function toBeAccessible(received = document, config = preset_rules_1.defau
     return {
         pass: isAccessible,
         message: () => (0, jest_matcher_utils_1.matcherHint)(`${toBeAccessible.name}: ${matcherHintMsg} ${receivedMsg}: \n\n ${a11yError.format(formatOptions)}`, `${a11yError.length} issues`, expectedMsg),
+        a11yError: a11yError,
     };
 }
 exports.toBeAccessible = toBeAccessible;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "6.9.0",
+    "version": "6.9.2",
     "description": "Accessibility testing matcher for Jest",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/jest#readme",
@@ -24,9 +24,9 @@
     ],
     "dependencies": {
         "@jest/test-result": "^27",
-        "@sa11y/assert": "6.9.0",
-        "@sa11y/format": "6.9.0",
-        "@sa11y/preset-rules": "6.9.0",
+        "@sa11y/assert": "6.9.2",
+        "@sa11y/format": "6.9.2",
+        "@sa11y/preset-rules": "6.9.2",
         "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
@@ -34,8 +34,8 @@
     },
     "devDependencies": {
         "@jest/globals": "28.1.3",
-        "@sa11y/common": "6.9.0",
-        "@sa11y/test-utils": "6.9.0"
+        "@sa11y/common": "6.9.2",
+        "@sa11y/test-utils": "6.9.2"
     },
     "publishConfig": {
         "access": "public"
@@ -43,5 +43,5 @@
     "engines": {
         "node": "^16 || ^18 || ^20"
     },
-    "gitHead": "90bd6111dfe1bec4ff98d5e1527a245c3c0a5498"
+    "gitHead": "2eca6d223e98bd7794c7283bd87d7c1d57d407cb"
 }