@sa11y/jest 7.0.1 → 7.1.0-alpha.2

package/README.md

@@ -108,7 +108,7 @@ it('should be accessible', async () => {
     // Setup DOM to be tested for accessibility
     //...
 
-    // assert that DOM is accessible (using base preset-rule)
+    // assert that whole DOM is accessible (using base preset-rule)
     await expect(document).toBeAccessible();
 
     // Can be used to test accessibility of a specific HTML element

package/dist/automatic.d.ts

@@ -9,6 +9,13 @@ export type AutoCheckOpts = {
     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;
 /**
@@ -19,10 +26,10 @@ export declare function skipTest(testPath: string | undefined, filesFilter?: str
  * 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): Promise<void>;
+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): void;
+export declare function registerSa11yAutomaticChecks(opts?: AutoCheckOpts, renderedDOMSaveOpts?: RenderedDOMSaveOpts): 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;AAkBF,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,CAAC,IAAI,GAAE,aAAoC,GAAG,OAAO,CAAC,IAAI,CAAC,CAmE9F;AAsBD;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAmB7F"}
+{"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"}

package/dist/automatic.js

@@ -24,6 +24,9 @@ const defaultAutoCheckOpts = {
     runDOMMutationObserver: false,
     enableIncompleteResults: false,
 };
+const defaultRenderedDOMSaveOpts = {
+    renderedDOMDumpDirPath: '',
+};
 let originalDocumentBodyHtml = null;
 let mutatedNodes = [];
 const setOriginalDocumentBodyHtml = (bodyHtml) => {
@@ -51,7 +54,7 @@ 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) {
+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
@@ -73,6 +76,7 @@ async function automaticCheck(opts = defaultAutoCheckOpts) {
     // 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) {
@@ -88,7 +92,29 @@ async function automaticCheck(opts = defaultAutoCheckOpts) {
             }
         }
         else {
-            a11yResults.push(...(await (0, assert_1.getA11yResultsJSDOM)(document.body, config, opts.enableIncompleteResults)));
+            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) {
@@ -113,7 +139,7 @@ async function automaticCheck(opts = defaultAutoCheckOpts) {
         if (process.env.SELECTOR_FILTER_KEYWORDS) {
             a11yResults = (0, format_1.exceptionListFilterSelectorKeywords)(a11yResults, process.env.SELECTOR_FILTER_KEYWORDS.split(','));
         }
-        format_1.A11yError.checkAndThrow(a11yResults, { deduplicate: opts.consolidateResults });
+        format_1.A11yError.checkAndThrow(a11yResults, { deduplicate: opts.consolidateResults, renderedDOMSavedFileName });
     }
 }
 exports.automaticCheck = automaticCheck;
@@ -140,7 +166,7 @@ const observerOptions = {
  * Register accessibility checks to be run automatically after each test
  * @param opts - Options for automatic checks {@link AutoCheckOpts}
  */
-function registerSa11yAutomaticChecks(opts = defaultAutoCheckOpts) {
+function registerSa11yAutomaticChecks(opts = defaultAutoCheckOpts, renderedDOMSaveOpts = defaultRenderedDOMSaveOpts) {
     if (opts.runAfterEach) {
         const observer = new MutationObserver(observerCallback);
         // TODO (fix): Make registration idempotent
@@ -154,7 +180,7 @@ function registerSa11yAutomaticChecks(opts = defaultAutoCheckOpts) {
             if (opts.runDOMMutationObserver) {
                 observer.disconnect(); // stop mutation observer
             }
-            await automaticCheck(opts);
+            await automaticCheck(opts, renderedDOMSaveOpts);
         });
     }
 }

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;AA2GD;;;;;;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;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"}

package/dist/groupViolationResultsProcessor.js

@@ -113,6 +113,7 @@ function processA11yDetailsAndMessages(error, a11yFailureMessages) {
         });
     });
     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.
 

package/dist/setup.d.ts

@@ -1,9 +1,10 @@
-import { AutoCheckOpts } from './automatic';
+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}

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,EAIhB,MAAM,aAAa,CAAC;AAIrB;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAoCF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CAiD9D;AACD;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C"}
+{"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"}

package/dist/setup.js

@@ -23,6 +23,9 @@ const defaultSa11yOpts = {
         runDOMMutationObserver: false,
         enableIncompleteResults: false,
     },
+    renderedDOMSaveOpts: {
+        renderedDOMDumpDirPath: '',
+    },
 };
 function registerRemoveChild() {
     // eslint-disable-next-line @typescript-eslint/unbound-method
@@ -90,7 +93,8 @@ function setup(opts = defaultSa11yOpts) {
     // 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);
-    (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts);
+    const renderedDOMSaveOpts = opts.renderedDOMSaveOpts;
+    (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts, renderedDOMSaveOpts);
 }
 exports.setup = setup;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "7.0.1",
+    "version": "7.1.0-alpha.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": "7.0.1",
-        "@sa11y/format": "7.0.1",
-        "@sa11y/preset-rules": "7.0.1",
+        "@sa11y/assert": "7.1.0-alpha.2",
+        "@sa11y/format": "7.1.0-alpha.2",
+        "@sa11y/preset-rules": "7.1.0-alpha.2",
         "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
@@ -34,8 +34,8 @@
     },
     "devDependencies": {
         "@jest/globals": "28.1.3",
-        "@sa11y/common": "7.0.1",
-        "@sa11y/test-utils": "7.0.1"
+        "@sa11y/common": "7.1.0-alpha.2",
+        "@sa11y/test-utils": "7.1.0-alpha.2"
     },
     "publishConfig": {
         "access": "public"
@@ -43,5 +43,5 @@
     "engines": {
         "node": "^18 || ^20"
     },
-    "gitHead": "cfcd509c1d62778322fbaa4089ada3a498df316c"
+    "gitHead": "108d459f5c12828a7071769bef8812be898df56b"
 }