@sa11y/jest 7.1.0-alpha.2 → 7.1.1

package/README.md

@@ -19,6 +19,7 @@ Accessibility matcher for [Jest](https://jestjs.io)
     - [JSON result transformation](#json-result-transformation)
   - [Limitations](#limitations)
   - [Disabled Checks](#disabled-checks)
+- [Related Packages](#related-packages)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -108,7 +109,7 @@ it('should be accessible', async () => {
     // Setup DOM to be tested for accessibility
     //...
 
-    // assert that whole DOM is accessible (using base preset-rule)
+    // assert that DOM is accessible (using base preset-rule)
     await expect(document).toBeAccessible();
 
     // Can be used to test accessibility of a specific HTML element
@@ -278,3 +279,7 @@ Automatic checks currently has the following limitations.
 ### Disabled Checks
 
 -   @sa11y/jest automatic checks also disabled rules which were disabled in `toBeAccessible` Jest API ([disabled-checks](https://github.com/salesforce/sa11y/tree/master/packages/jest#disabled-checks))
+
+## Related Packages
+
+-   [`@sa11y/matcher`](../matcher/README.md): Provides the core accessibility checking APIs used by this package. Use it directly for custom test runners or advanced integrations.

package/dist/automatic.d.ts

@@ -1,35 +1,3 @@
-/**
- * Options for Automatic checks to be passed to {@link registerSa11yAutomaticChecks}
- */
-export type AutoCheckOpts = {
-    runAfterEach?: boolean;
-    cleanupAfterEach?: boolean;
-    consolidateResults?: boolean;
-    filesFilter?: string[];
-    runDOMMutationObserver?: boolean;
-    enableIncompleteResults?: boolean;
-};
-export type RenderedDOMSaveOpts = {
-    renderedDOMDumpDirPath?: string;
-    generateRenderedDOMFileSaveLocation?: (testFilePath: string, testName: string) => {
-        fileName: string;
-        fileUrl: string;
-    };
-};
-export declare const setOriginalDocumentBodyHtml: (bodyHtml: string | null) => void;
-export declare const getOriginalDocumentBodyHtml: () => string | null;
-/**
- * Check if current test file needs to be skipped based on any provided filter
- */
-export declare function skipTest(testPath: string | undefined, filesFilter?: string[]): boolean;
-/**
- * Run accessibility check on each element node in the body using {@link toBeAccessible}
- * @param opts - Options for automatic checks {@link AutoCheckOpts}
- */
-export declare function automaticCheck(opts?: AutoCheckOpts, renderedDOMSaveOpts?: RenderedDOMSaveOpts): Promise<void>;
-/**
- * Register accessibility checks to be run automatically after each test
- * @param opts - Options for automatic checks {@link AutoCheckOpts}
- */
-export declare function registerSa11yAutomaticChecks(opts?: AutoCheckOpts, renderedDOMSaveOpts?: RenderedDOMSaveOpts): void;
+import type { AutoCheckOpts } from '@sa11y/matcher';
+export declare function registerSa11yAutomaticChecks(opts?: AutoCheckOpts): void;
 //# sourceMappingURL=automatic.d.ts.map

package/dist/automatic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAI7B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAC9B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,mCAAmC,CAAC,EAAE,CAClC,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,KACf;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9C,CAAC;AAsBF,eAAO,MAAM,2BAA2B,aAAc,MAAM,GAAG,IAAI,SAElE,CAAC;AAEF,eAAO,MAAM,2BAA2B,qBAEvC,CAAC;AAEF;;GAEG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAUtF;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAChC,IAAI,GAAE,aAAoC,EAC1C,mBAAmB,GAAE,mBAAgD,GACtE,OAAO,CAAC,IAAI,CAAC,CAmGf;AAsBD;;;GAGG;AACH,wBAAgB,4BAA4B,CACxC,IAAI,GAAE,aAAoC,EAC1C,mBAAmB,GAAE,mBAAgD,GACtE,IAAI,CAmBN"}
+{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAc7F"}

package/dist/automatic.js

@@ -1,188 +1,29 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSa11yAutomaticChecks = void 0;
 /*
- * Copyright (c) 2021, salesforce.com, inc.
+ * Copyright (c) 2025, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerSa11yAutomaticChecks = exports.automaticCheck = exports.skipTest = exports.getOriginalDocumentBodyHtml = exports.setOriginalDocumentBodyHtml = void 0;
-const common_1 = require("@sa11y/common");
-const assert_1 = require("@sa11y/assert");
-const format_1 = require("@sa11y/format");
-const matcher_1 = require("./matcher");
 const globals_1 = require("@jest/globals");
-const preset_rules_1 = require("@sa11y/preset-rules");
-/**
- * Default options when {@link registerSa11yAutomaticChecks} is invoked
- */
-const defaultAutoCheckOpts = {
-    runAfterEach: true,
-    cleanupAfterEach: true,
-    consolidateResults: true,
-    filesFilter: [],
-    runDOMMutationObserver: false,
-    enableIncompleteResults: false,
-};
-const defaultRenderedDOMSaveOpts = {
-    renderedDOMDumpDirPath: '',
-};
-let originalDocumentBodyHtml = null;
-let mutatedNodes = [];
-const setOriginalDocumentBodyHtml = (bodyHtml) => {
-    originalDocumentBodyHtml = bodyHtml ?? null;
-};
-exports.setOriginalDocumentBodyHtml = setOriginalDocumentBodyHtml;
-const getOriginalDocumentBodyHtml = () => {
-    return originalDocumentBodyHtml;
-};
-exports.getOriginalDocumentBodyHtml = getOriginalDocumentBodyHtml;
-/**
- * Check if current test file needs to be skipped based on any provided filter
- */
-function skipTest(testPath, filesFilter) {
-    if (!testPath || !filesFilter || !(filesFilter?.length > 0))
-        return false;
-    const skipTest = filesFilter.some((fileName) => testPath.toLowerCase().includes(fileName.toLowerCase()));
-    if (skipTest) {
-        (0, common_1.log)(`Skipping automatic accessibility check on ${testPath} as it matches given files filter: ${filesFilter.toString()}`);
-    }
-    return skipTest;
-}
-exports.skipTest = skipTest;
-/**
- * Run accessibility check on each element node in the body using {@link toBeAccessible}
- * @param opts - Options for automatic checks {@link AutoCheckOpts}
- */
-async function automaticCheck(opts = defaultAutoCheckOpts, renderedDOMSaveOpts = defaultRenderedDOMSaveOpts) {
-    if (skipTest(globals_1.expect.getState().testPath, opts.filesFilter))
-        return;
-    // Skip automatic check if test is using fake timer as it would result in timeout
-    if ((0, matcher_1.isTestUsingFakeTimer)()) {
-        (0, common_1.log)('Skipping automatic accessibility check as Jest fake timer is in use.');
+const matcher_1 = require("@sa11y/matcher");
+const matcher_2 = require("./matcher");
+function registerSa11yAutomaticChecks(opts = matcher_1.defaultAutoCheckOpts) {
+    if (!opts.runAfterEach)
         return;
-    }
-    const customRules = (0, common_1.useCustomRules)();
-    let config = customRules.length === 0
-        ? (0, preset_rules_1.adaptA11yConfig)(preset_rules_1.defaultRuleset)
-        : (0, preset_rules_1.adaptA11yConfigCustomRules)(preset_rules_1.defaultRuleset, customRules);
-    if (opts.enableIncompleteResults)
-        config = (0, preset_rules_1.adaptA11yConfigIncompleteResults)(config);
-    let a11yResults = [];
-    const currentDocumentHtml = document.body.innerHTML;
-    if (originalDocumentBodyHtml) {
-        document.body.innerHTML = originalDocumentBodyHtml;
-    }
-    // Create a DOM walker filtering only elements (skipping text, comment nodes etc)
-    const walker = document.createTreeWalker(document.body, NodeFilter.SHOW_ELEMENT);
-    let currNode = walker.firstChild();
-    let renderedDOMSavedFileName = '';
-    try {
-        if (!opts.runDOMMutationObserver) {
-            while (currNode !== null) {
-                // TODO (spike): Use a logger lib with log levels selectable at runtime
-                // console.log(
-                //     `♿ [DEBUG] Automatically checking a11y of ${currNode.nodeName}
-                //      for test "${expect.getState().currentTestName}"
-                //      : ${testPath}`
-                // );
-                // W-10004832 - Exclude descendancy based rules from automatic checks
-                a11yResults.push(...(await (0, assert_1.getA11yResultsJSDOM)(currNode, config, opts.enableIncompleteResults)));
-                currNode = walker.nextSibling();
-            }
-        }
-        else {
-            const a11yResultsJSDOM = await (0, assert_1.getA11yResultsJSDOM)(document.body, config, opts.enableIncompleteResults);
-            if (a11yResultsJSDOM?.length > 0) {
-                if (!!renderedDOMSaveOpts.renderedDOMDumpDirPath &&
-                    !!renderedDOMSaveOpts.generateRenderedDOMFileSaveLocation) {
-                    try {
-                        // save the document body HTML
-                        const testFilePath = globals_1.expect.getState().testPath ?? '';
-                        const testName = globals_1.expect.getState().currentTestName ?? '';
-                        if (!testFilePath || !testName) {
-                            console.log(`Skipping saving rendered DOM HTML as one or both of test file path and test name are empty`);
-                        }
-                        else {
-                            const { fileName, fileUrl } = renderedDOMSaveOpts.generateRenderedDOMFileSaveLocation(testFilePath, testName);
-                            renderedDOMSavedFileName = fileUrl;
-                            (0, common_1.writeHtmlFileInPath)(renderedDOMSaveOpts.renderedDOMDumpDirPath, fileName, document.body.innerHTML);
-                        }
-                    }
-                    catch (e) {
-                        console.log(`ran into an error while saving rendered DOM - ${e.message}`);
-                    }
-                }
-            }
-            a11yResults.push(...a11yResultsJSDOM);
-            document.body.innerHTML = '';
-            // loop mutated nodes
-            for await (const mutatedNode of mutatedNodes) {
-                if (mutatedNode) {
-                    document.body.innerHTML = mutatedNode;
-                    a11yResults.push(...(await (0, assert_1.getA11yResultsJSDOM)(document.body, config, opts.enableIncompleteResults)));
-                }
-            }
-        }
-    }
-    finally {
+    const observer = new MutationObserver(matcher_1.mutationObserverCallback);
+    beforeEach(() => {
         if (opts.runDOMMutationObserver) {
-            mutatedNodes = [];
-        }
-        (0, exports.setOriginalDocumentBodyHtml)(null);
-        document.body.innerHTML = currentDocumentHtml;
-        if (opts.cleanupAfterEach)
-            document.body.innerHTML = ''; // remove non-element nodes
-        // TODO (spike): Disable stack trace for automatic checks.
-        //  Will this affect all errors globally?
-        // Error.stackTraceLimit = 0;
-        if (process.env.SELECTOR_FILTER_KEYWORDS) {
-            a11yResults = (0, format_1.exceptionListFilterSelectorKeywords)(a11yResults, process.env.SELECTOR_FILTER_KEYWORDS.split(','));
+            observer.observe(document.body, matcher_1.observerOptions);
         }
-        format_1.A11yError.checkAndThrow(a11yResults, { deduplicate: opts.consolidateResults, renderedDOMSavedFileName });
-    }
-}
-exports.automaticCheck = automaticCheck;
-function observerCallback(mutations, _observer) {
-    for (const mutation of mutations) {
-        mutation.addedNodes.forEach((node) => {
-            if (node?.parentElement?.innerHTML) {
-                mutatedNodes.push(node.parentElement.innerHTML);
-            }
-            else if (node?.outerHTML) {
-                mutatedNodes.push(node?.outerHTML);
-            }
-        });
-    }
-}
-// https://developer.mozilla.org/en-US/docs/Web/API/MutationObserverInit
-const observerOptions = {
-    subtree: true,
-    childList: true,
-    attributes: true,
-    characterData: true, // monitor changes to the character data contained within nodes
-};
-/**
- * Register accessibility checks to be run automatically after each test
- * @param opts - Options for automatic checks {@link AutoCheckOpts}
- */
-function registerSa11yAutomaticChecks(opts = defaultAutoCheckOpts, renderedDOMSaveOpts = defaultRenderedDOMSaveOpts) {
-    if (opts.runAfterEach) {
-        const observer = new MutationObserver(observerCallback);
-        // TODO (fix): Make registration idempotent
-        (0, common_1.log)('Registering sa11y checks to be run automatically after each test');
-        beforeEach(() => {
-            if (opts.runDOMMutationObserver) {
-                observer.observe(document.body, observerOptions);
-            }
-        });
-        afterEach(async () => {
-            if (opts.runDOMMutationObserver) {
-                observer.disconnect(); // stop mutation observer
-            }
-            await automaticCheck(opts, renderedDOMSaveOpts);
-        });
-    }
+    });
+    afterEach(async () => {
+        if (opts.runDOMMutationObserver)
+            observer.disconnect();
+        await (0, matcher_1.runAutomaticCheck)(opts, globals_1.expect.getState().testPath, matcher_2.isTestUsingFakeTimer);
+    });
 }
 exports.registerSa11yAutomaticChecks = registerSa11yAutomaticChecks;
 //# sourceMappingURL=automatic.js.map

package/dist/groupViolationResultsProcessor.d.ts

@@ -1,20 +1,4 @@
 import { AggregatedResult } from '@jest/test-result';
-export type ErrorElement = {
-    html: string;
-    selectors: string;
-    hierarchy: string;
-    any: string;
-    all: string;
-    none: string;
-    relatedNodeAny: string;
-    relatedNodeAll: string;
-    relatedNodeNone: string;
-    message?: string;
-};
-/**
- * Create a test failure html elements array grouped by rule violation
- */
-export declare function createA11yErrorElements(errorElements: ErrorElement[]): string;
 /**
  * Custom results processor for a11y results grouping the violations. Only affects JSON results file output.
  * To be used with jest cli options --json --outputFile

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;AAelF,MAAM,MAAM,YAAY,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAoBF;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,YAAY,EAAE,UAqDpE;AA4GD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAa5E;AAED,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAaxF"}
+{"version":3,"file":"groupViolationResultsProcessor.d.ts","sourceRoot":"","sources":["../src/groupViolationResultsProcessor.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAA+B,MAAM,mBAAmB,CAAC;AA0DlF;;;;;;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,134 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resultsProcessorManualChecks = exports.resultsProcessor = exports.createA11yErrorElements = void 0;
+exports.resultsProcessorManualChecks = exports.resultsProcessor = void 0;
 const common_1 = require("@sa11y/common");
 const format_1 = require("@sa11y/format");
-const formatSpacing = '\t'.repeat(4);
-const formatForAxeMessage = `\n${formatSpacing}\t`;
-const axeMessages = {
-    toSolveAny: `${formatForAxeMessage}- More Info: To solve the problem, you need to fix at least (1) of the following:\n`,
-    toSolveFirst: `${formatForAxeMessage}- More Info: To solve the problem, you need to fix one of the following:\n`,
-    toSolveSecond: `${formatForAxeMessage}- And fix the following:\n`,
-    relatedNodes: `${formatForAxeMessage}- Related Nodes: \n`,
-};
-/**
- * Create a test failure html elements array grouped by rule violation
- */
-function createA11yErrorElements(errorElements) {
-    const a11yErrorElements = [];
-    let onlyOneSummary = false;
-    const appendRelatedNodes = (errorMessage, relatedNodes) => {
-        return relatedNodes ? `${errorMessage}${axeMessages.relatedNodes}${relatedNodes}` : errorMessage;
-    };
-    errorElements.forEach((errorElement, index) => {
-        let errorMessage = `${formatSpacing}(${index + 1}) - HTML element : ${errorElement.html
-            .replace(/&lt;/g, '<')
-            .replace(/&gt;/, '>')}`;
-        errorMessage += `${formatForAxeMessage}- CSS selector(s) : ${errorElement.selectors.replace(/&gt;/, '>')}`;
-        errorMessage += `${formatForAxeMessage}- HTML Tag Hierarchy : ${errorElement.hierarchy}`;
-        if (errorElement.message)
-            errorMessage += `${formatForAxeMessage}- Error Message (Needs Review) : ${errorElement.message}`;
-        const isAny = errorElement.any?.length > 0;
-        const isAll = errorElement.all?.length > 0;
-        const isNone = errorElement.none?.length > 0;
-        if (!onlyOneSummary) {
-            if (isAny) {
-                errorMessage += `${axeMessages.toSolveAny}${errorElement.any}`;
-                errorMessage = appendRelatedNodes(errorMessage, errorElement.relatedNodeAny);
-                if (isAll) {
-                    errorMessage += `${axeMessages.toSolveSecond}${errorElement.all}`;
-                    errorMessage = appendRelatedNodes(errorMessage, errorElement.relatedNodeAll);
-                }
-                if (isNone) {
-                    errorMessage += `${axeMessages.toSolveSecond}${errorElement.none}`;
-                    errorMessage = appendRelatedNodes(errorMessage, errorElement.relatedNodeNone);
-                }
-            }
-            else if (isAll) {
-                errorMessage += `${axeMessages.toSolveFirst}${errorElement.all}`;
-                errorMessage = appendRelatedNodes(errorMessage, errorElement.relatedNodeAll);
-                if (isNone) {
-                    errorMessage += `${axeMessages.toSolveSecond}${errorElement.none}`;
-                    errorMessage = appendRelatedNodes(errorMessage, errorElement.relatedNodeNone);
-                }
-            }
-            else {
-                if (isNone) {
-                    errorMessage += `${axeMessages.toSolveFirst}${errorElement.none}`;
-                    errorMessage = appendRelatedNodes(errorMessage, errorElement.relatedNodeNone);
-                }
-            }
-        }
-        else {
-            errorMessage = appendRelatedNodes(errorMessage, errorElement.relatedNodeAny);
-        }
-        onlyOneSummary = isAny && !isAll && !isNone;
-        a11yErrorElements.push(errorMessage);
-    });
-    return a11yErrorElements.join('\n');
-}
-exports.createA11yErrorElements = createA11yErrorElements;
-/**
- * Create a test failure violation error message grouped by rule violation
- */
-function createA11yRuleViolation(a11yRule, ruleIndex) {
-    return `(${ruleIndex}) [${a11yRule.id}] ${a11yRule.description}
-            * Error element(s) : ${a11yRule.errorElements.length}\n${createA11yErrorElements(a11yRule.errorElements)}
-            * Help:
-                • 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,
-            relatedNodeAny: a11yResult.relatedNodeAny,
-            relatedNodeAll: a11yResult.relatedNodeAll,
-            relatedNodeNone: a11yResult.relatedNodeNone,
-            message: a11yResult?.message,
-        });
-    });
-    const a11yFailureMessage = `
-${error.renderedDOMSavedFileName ? `HTML Source: ${error.renderedDOMSavedFileName}\n` : ''}
-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);
-}
+const matcher_1 = require("@sa11y/matcher");
 /**
  * Convert any a11y errors from test failures into their own test suite, results
  */
@@ -146,7 +21,7 @@ function processA11yErrors(results, testSuite, testResult) {
         if (error.name === format_1.A11yError.name) {
             a11yErrorsExist = true;
             a11yFailureDetails.push({ ...failure });
-            processA11yDetailsAndMessages(error, a11yFailureMessages);
+            (0, matcher_1.processA11yDetailsAndMessages)(error, a11yFailureMessages);
         }
     });
     if (!a11yErrorsExist) {
@@ -164,7 +39,7 @@ function processA11yMatcherErrors(results, testSuite, testResult) {
     testResult.failureDetails.forEach((failure) => {
         const error = failure?.error?.matcherResult?.a11yError;
         if (error !== undefined) {
-            processA11yDetailsAndMessages(error, a11yFailureMessages);
+            (0, matcher_1.processA11yDetailsAndMessages)(error, a11yFailureMessages);
             testResult.failureMessages = [...a11yFailureMessages];
         }
     });
@@ -209,7 +84,6 @@ exports.resultsProcessorManualChecks = resultsProcessorManualChecks;
 const exportedFunctions = {
     resultsProcessor,
     resultsProcessorManualChecks,
-    createA11yErrorElements,
 };
 module.exports = exportedFunctions;
 //# sourceMappingURL=groupViolationResultsProcessor.js.map

package/dist/matcher.d.ts

@@ -1,22 +1,6 @@
 /// <reference types="jest" />
 import { A11yCheckableContext } from '@sa11y/assert';
-import { A11yError } from '@sa11y/format';
 import { A11yConfig } from '@sa11y/common';
-declare global {
-    namespace jest {
-        interface Matchers<R> extends jest.CustomMatcher {
-            toBeAccessible(config?: A11yConfig): Promise<CustomMatcherResult>;
-        }
-    }
-}
-/**
- * Jest expect matcher to check DOM for accessibility issues
- * @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 & {
-    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
@@ -24,4 +8,7 @@ export declare function toBeAccessible(received?: A11yCheckableContext, config?:
  * Ref: https://github.com/facebook/jest/issues/10555
  */
 export declare function isTestUsingFakeTimer(): boolean;
+export declare function toBeAccessible(received?: A11yCheckableContext, config?: A11yConfig): Promise<jest.CustomMatcherResult & {
+    a11yError: Error;
+}>;
 //# sourceMappingURL=matcher.d.ts.map

package/dist/matcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matcher.d.ts","sourceRoot":"","sources":["../src/matcher.ts"],"names":[],"mappings":";AAQA,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"}
+{"version":3,"file":"matcher.d.ts","sourceRoot":"","sources":["../src/matcher.ts"],"names":[],"mappings":";AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI3C;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAO9C;AAED,wBAAsB,cAAc,CAChC,QAAQ,GAAE,oBAA+B,EACzC,MAAM,GAAE,UAA2B,GACpC,OAAO,CAAC,IAAI,CAAC,mBAAmB,GAAG;IAAE,SAAS,EAAE,KAAK,CAAA;CAAE,CAAC,CAc1D"}

package/dist/matcher.js

@@ -1,60 +1,15 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBeAccessible = exports.isTestUsingFakeTimer = void 0;
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2025, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTestUsingFakeTimer = exports.toBeAccessible = void 0;
 const jest_matcher_utils_1 = require("jest-matcher-utils");
-const assert_1 = require("@sa11y/assert");
-const format_1 = require("@sa11y/format");
 const preset_rules_1 = require("@sa11y/preset-rules");
-const fakeTimerErrMsg = 'Cannot run accessibility check when Jest fake timer is in use. ' +
-    'Switch to real timer before invoking accessibility check. ' +
-    'Ref: https://jestjs.io/docs/timer-mocks';
-const matcherHintMsg = `expected document to have no accessibility violations but found`;
-const expectedMsg = `0 issues`;
-const formatOptions = {
-    a11yViolationIndicator: '⭕',
-    helpUrlIndicator: '🔗',
-    highlighter: jest_matcher_utils_1.printReceived,
-    deduplicate: false,
-};
-/**
- * Jest expect matcher to check DOM for accessibility issues
- * @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.
- */
-async function toBeAccessible(received = document, config = preset_rules_1.defaultRuleset) {
-    let isAccessible = true;
-    // a11yError can be 'undefined' when used with `not` matcher and there is no error
-    let a11yError = new format_1.A11yError([], []);
-    let receivedMsg = expectedMsg;
-    if (isTestUsingFakeTimer())
-        throw new Error(fakeTimerErrMsg);
-    // TODO (Improvement): Can we detect if this is invoked async and error if not ?
-    try {
-        await (0, assert_1.assertAccessible)(received, (0, preset_rules_1.adaptA11yConfig)(config));
-    }
-    catch (e) {
-        if (e instanceof format_1.A11yError) {
-            a11yError = e;
-            isAccessible = false;
-            receivedMsg = `${a11yError.length} issues`;
-        }
-        else {
-            throw e;
-        }
-    }
-    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;
+const matcher_1 = require("@sa11y/matcher");
 /**
  * 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
@@ -68,4 +23,19 @@ function isTestUsingFakeTimer() {
         (setTimeout.hasOwnProperty('_isMockFunction') || setTimeout.hasOwnProperty('clock')));
 }
 exports.isTestUsingFakeTimer = isTestUsingFakeTimer;
+async function toBeAccessible(received = document, config = preset_rules_1.defaultRuleset) {
+    if (isTestUsingFakeTimer())
+        throw new Error(matcher_1.fakeTimerErrMsg);
+    const { isAccessible, a11yError, receivedMsg } = await (0, matcher_1.runA11yCheck)(received, config);
+    return {
+        pass: isAccessible,
+        message: () => (0, jest_matcher_utils_1.matcherHint)(`toBeAccessible`) +
+            `\n\nExpected: no accessibility violations\nReceived: ${receivedMsg}\n\n${a11yError.format({
+                ...matcher_1.formatOptions,
+                highlighter: jest_matcher_utils_1.printReceived,
+            })}`,
+        a11yError,
+    };
+}
+exports.toBeAccessible = toBeAccessible;
 //# sourceMappingURL=matcher.js.map

package/dist/setup.d.ts

@@ -1,18 +1,3 @@
-import { AutoCheckOpts, RenderedDOMSaveOpts } from './automatic';
-/**
- * Options to be passed on to {@link setup}
- */
-export type Sa11yOpts = {
-    autoCheckOpts: AutoCheckOpts;
-    renderedDOMSaveOpts: RenderedDOMSaveOpts;
-};
-/**
- * Register Sa11y Jest API and automatic checks depending on {@link Sa11yOpts}
- * @param opts - {@link Sa11yOpts} to opt-in to automatic checks
- */
-export declare function setup(opts?: Sa11yOpts): void;
-/**
- * Register accessibility helpers toBeAccessible as jest matchers
- */
+export declare function setup(opts?: import("@sa11y/matcher/dist/setup").Sa11yOpts): void;
 export declare function registerSa11yMatcher(): void;
 //# sourceMappingURL=setup.d.ts.map

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AASA,OAAO,EACH,aAAa,EAIb,mBAAmB,EACtB,MAAM,aAAa,CAAC;AAIrB;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;CAK5C,CAAC;AAuCF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CAmD9D;AACD;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAiBA,wBAAgB,KAAK,CAAC,IAAI,gDAAmB,GAAG,IAAI,CAanD;AACD,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C"}

package/dist/setup.js

@@ -1,108 +1,32 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSa11yMatcher = exports.setup = void 0;
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2025, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerSa11yMatcher = exports.setup = void 0;
-const matcher_1 = require("./matcher");
-const common_1 = require("@sa11y/common");
-const automatic_1 = require("./automatic");
 const globals_1 = require("@jest/globals");
-const preset_rules_1 = require("@sa11y/preset-rules");
-/**
- * Default options for sa11y jest matcher
- */
-const defaultSa11yOpts = {
-    autoCheckOpts: {
-        runAfterEach: false,
-        cleanupAfterEach: false,
-        consolidateResults: false,
-        runDOMMutationObserver: false,
-        enableIncompleteResults: false,
-    },
-    renderedDOMSaveOpts: {
-        renderedDOMDumpDirPath: '',
-    },
-};
-function registerRemoveChild() {
-    // eslint-disable-next-line @typescript-eslint/unbound-method
-    const originalRemoveChild = Element.prototype.removeChild;
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
-    Element.prototype.removeChild = function (oldChild) {
-        if (oldChild.parentNode === this) {
-            // Your custom implementation here
-            if (!(0, automatic_1.getOriginalDocumentBodyHtml)()) {
-                (0, automatic_1.setOriginalDocumentBodyHtml)(document?.body?.innerHTML ?? '');
-            }
-        }
-        return originalRemoveChild.call(this, oldChild);
-    };
-}
-const improvedChecksFilter = [
-    'ui-email-stream-components/modules/emailStream/adminHealthInsights/__tests__/adminHealthInsights.test.js',
-];
-/**
- * Register Sa11y Jest API and automatic checks depending on {@link Sa11yOpts}
- * @param opts - {@link Sa11yOpts} to opt-in to automatic checks
- */
-function setup(opts = defaultSa11yOpts) {
-    if (process.env.SA11Y_AUTO) {
-        const testPath = globals_1.expect.getState().testPath ?? '';
-        const ignoreImprovedChecks = improvedChecksFilter.some((fileName) => testPath.toLowerCase().includes(fileName.toLowerCase()));
-        if (!ignoreImprovedChecks) {
-            registerRemoveChild();
-        }
+const matcher_1 = require("@sa11y/matcher");
+const automatic_1 = require("./automatic");
+const matcher_2 = require("./matcher");
+function setup(opts = matcher_1.defaultSa11yOpts) {
+    const testPath = globals_1.expect.getState().testPath ?? '';
+    const ignoreImprovedChecks = matcher_1.improvedChecksFilter.some((fileName) => testPath.toLowerCase().includes(fileName.toLowerCase()));
+    if (process.env.SA11Y_AUTO && !ignoreImprovedChecks) {
+        (0, matcher_1.registerRemoveChild)();
     }
     registerSa11yMatcher();
-    (0, common_1.registerCustomRules)(preset_rules_1.changesData, preset_rules_1.rulesData, preset_rules_1.checkData);
-    // Set defaults from env vars
+    (0, matcher_1.registerCustomSa11yRules)();
     const autoCheckOpts = opts.autoCheckOpts;
-    autoCheckOpts.runAfterEach || (autoCheckOpts.runAfterEach = !!process.env.SA11Y_AUTO);
-    // Consolidate results if automatic checks is enabled
-    autoCheckOpts.consolidateResults || (autoCheckOpts.consolidateResults = autoCheckOpts.runAfterEach);
-    autoCheckOpts.cleanupAfterEach || (autoCheckOpts.cleanupAfterEach = !!process.env.SA11Y_CLEANUP);
-    if (process.env.SA11Y_AUTO_FILTER?.trim().length)
-        autoCheckOpts.filesFilter || (autoCheckOpts.filesFilter = process.env.SA11Y_AUTO_FILTER.split(','));
-    const exemptedFiles = (0, common_1.useFilesToBeExempted)();
-    if (exemptedFiles.length !== 0) {
-        autoCheckOpts.filesFilter = (autoCheckOpts.filesFilter ?? []).concat(exemptedFiles);
-    }
-    // TODO remove @W-14447754 - add files filter
-    autoCheckOpts.filesFilter = (autoCheckOpts.filesFilter ?? []).concat([
-        'ui-help-components/modules/forceHelp/linkToReleaseNotes/__tests__/linkToReleaseNotes.spec.js',
-        'ui-help-components/modules/forceHelp/linkToNonSalesforceResource/__tests__/linkToNonSalesforceResource.spec.js',
-        'ui-help-components/modules/forceHelp/linkToAppexchange/__tests__/linkToAppexchange.spec.js',
-        'ui-help-components/modules/forceHelp/linkToTrailblazer/__tests__/linkToTrailblazer.spec.js',
-        'ui-help-components/modules/forceHelp/linkToVidyard/__tests__/linkToVidyard.spec.js',
-        'ui-help-components/modules/forceHelp/linkToSalesforceDevelopers/__tests__/linkToSalesforceDevelopers.spec.js',
-        'ui-help-components/modules/forceHelp/linkToWebinar/__tests__/linkToWebinar.spec.js',
-        'ui-help-components/modules/forceHelp/linkToTrust/__tests__/linkToTrust.spec.js',
-        'ui-help-components/modules/forceHelp/linkToPartnerCommunity/__tests__/linkToPartnerCommunity.spec.js',
-        'ui-help-components/modules/forceHelp/linkToDocResource/__tests__/linkToDocResource.spec.js',
-        'ui-help-components/modules/forceHelp/searchResultItem/__tests__/searchResultItem.spec.js',
-        'ui-help-components/modules/forceHelp/linkToTrailhead/__tests__/linkToTrailhead.spec.js',
-        'ui-help-components/modules/forceHelp/linkToSalesforceSuccess/__tests__/linkToSalesforceSuccess.spec.js',
-        'ui-help-components/modules/forceHelp/linkToSalesforceHelp/__tests__/linkToSalesforceHelp.spec.js',
-        'ui-help-components/modules/forceHelp/link/__tests__/link.spec.js',
-        'ui-help-components/modules/forceHelp/searchResults/__tests__/searchResults.spec.js',
-        'ui-help-components/modules/forceHelp/linkToKnownIssue/__tests__/linkToKnownIssue.spec.js',
-    ]);
-    // set the flag to true to run sa11y in DOM Mutation Observer mode
-    autoCheckOpts.runDOMMutationObserver || (autoCheckOpts.runDOMMutationObserver = !!process.env.SA11Y_ENABLE_DOM_MUTATION_OBSERVER);
-    autoCheckOpts.enableIncompleteResults || (autoCheckOpts.enableIncompleteResults = !!process.env.SA11Y_ENABLE_INCOMPLETE_RESULTS);
-    const renderedDOMSaveOpts = opts.renderedDOMSaveOpts;
-    (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts, renderedDOMSaveOpts);
+    (0, matcher_1.updateAutoCheckOpts)(autoCheckOpts);
+    (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts);
 }
 exports.setup = setup;
-/**
- * Register accessibility helpers toBeAccessible as jest matchers
- */
 function registerSa11yMatcher() {
     if (globals_1.expect !== undefined) {
-        globals_1.expect.extend({ toBeAccessible: matcher_1.toBeAccessible });
+        globals_1.expect.extend({ toBeAccessible: matcher_2.toBeAccessible });
     }
     else {
         throw new Error("Unable to find Jest's expect function." +

package/package.json

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