@sa11y/jest 6.9.5 → 6.10.0

package/dist/automatic.d.ts

@@ -6,6 +6,7 @@ export type AutoCheckOpts = {
     cleanupAfterEach?: boolean;
     consolidateResults?: boolean;
     filesFilter?: string[];
+    runDOMMutationObserver?: boolean;
 };
 export declare const setOriginalDocumentBodyHtml: (bodyHtml: string | null) => void;
 export declare const getOriginalDocumentBodyHtml: () => string | null;

package/dist/automatic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAeA;;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;CAC1B,CAAC;AAcF,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,CAkD9F;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAQ7F"}
+{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAeA;;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;CACpC,CAAC;AAiBF,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,CAiF9F;AAsBD;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAmB7F"}

package/dist/automatic.js

@@ -22,8 +22,10 @@ const defaultAutoCheckOpts = {
     cleanupAfterEach: true,
     consolidateResults: true,
     filesFilter: [],
+    runDOMMutationObserver: false,
 };
 let originalDocumentBodyHtml = null;
+let mutatedNodes = [];
 const setOriginalDocumentBodyHtml = (bodyHtml) => {
     originalDocumentBodyHtml = bodyHtml ?? null;
 };
@@ -67,22 +69,44 @@ async function automaticCheck(opts = defaultAutoCheckOpts) {
     let currNode = walker.firstChild();
     const customRules = (0, common_1.useCustomRules)();
     try {
-        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
+        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
+                if (customRules.length === 0)
+                    violations.push(...(await (0, assert_1.getViolationsJSDOM)(currNode, (0, setup_1.adaptA11yConfig)(preset_rules_1.defaultRuleset))));
+                else
+                    violations.push(...(await (0, assert_1.getViolationsJSDOM)(currNode, (0, setup_1.adaptA11yConfigCustomRules)(preset_rules_1.defaultRuleset, customRules))));
+                currNode = walker.nextSibling();
+            }
+        }
+        else {
             if (customRules.length === 0)
-                violations.push(...(await (0, assert_1.getViolationsJSDOM)(currNode, (0, setup_1.adaptA11yConfig)(preset_rules_1.defaultRuleset))));
+                violations.push(...(await (0, assert_1.getViolationsJSDOM)(document.body, (0, setup_1.adaptA11yConfig)(preset_rules_1.defaultRuleset))));
             else
-                violations.push(...(await (0, assert_1.getViolationsJSDOM)(currNode, (0, setup_1.adaptA11yConfigCustomRules)(preset_rules_1.defaultRuleset, customRules))));
-            currNode = walker.nextSibling();
+                violations.push(...(await (0, assert_1.getViolationsJSDOM)(document.body, (0, setup_1.adaptA11yConfigCustomRules)(preset_rules_1.defaultRuleset, customRules))));
+            document.body.innerHTML = '';
+            // loop mutated nodes
+            for await (const mutatedNode of mutatedNodes) {
+                if (mutatedNode) {
+                    document.body.innerHTML = mutatedNode;
+                    if (customRules.length === 0)
+                        violations.push(...(await (0, assert_1.getViolationsJSDOM)(document.body, (0, setup_1.adaptA11yConfig)(preset_rules_1.defaultRuleset))));
+                    else
+                        violations.push(...(await (0, assert_1.getViolationsJSDOM)(document.body, (0, setup_1.adaptA11yConfigCustomRules)(preset_rules_1.defaultRuleset, customRules))));
+                }
+            }
         }
     }
     finally {
+        if (opts.runDOMMutationObserver) {
+            mutatedNodes = [];
+        }
         (0, exports.setOriginalDocumentBodyHtml)(null);
         document.body.innerHTML = currentDocumentHtml;
         if (opts.cleanupAfterEach)
@@ -97,15 +121,43 @@ async function automaticCheck(opts = defaultAutoCheckOpts) {
     }
 }
 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) {
     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);
         });
     }

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAA6C,MAAM,eAAe,CAAC;AACtF,OAAO,EACH,aAAa,EAIhB,MAAM,aAAa,CAAC;AAIrB,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAkCF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CA6C9D;AACD;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C;AACD;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,UAAU,CAKhG;AACD,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAM3F"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAA6C,MAAM,eAAe,CAAC;AACtF,OAAO,EACH,aAAa,EAIhB,MAAM,aAAa,CAAC;AAIrB,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAmCF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CAgD9D;AACD;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C;AACD;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,UAAU,CAKhG;AACD,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAM3F"}

package/dist/setup.js

@@ -38,6 +38,7 @@ const defaultSa11yOpts = {
         runAfterEach: false,
         cleanupAfterEach: false,
         consolidateResults: false,
+        runDOMMutationObserver: false,
     },
 };
 function registerRemoveChild() {
@@ -103,6 +104,8 @@ function setup(opts = defaultSa11yOpts) {
         '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);
     (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts);
 }
 exports.setup = setup;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "6.9.5",
+    "version": "6.10.0",
     "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.5",
-        "@sa11y/format": "6.9.5",
-        "@sa11y/preset-rules": "6.9.5",
+        "@sa11y/assert": "6.10.0",
+        "@sa11y/format": "6.10.0",
+        "@sa11y/preset-rules": "6.10.0",
         "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
@@ -34,8 +34,8 @@
     },
     "devDependencies": {
         "@jest/globals": "28.1.3",
-        "@sa11y/common": "6.9.5",
-        "@sa11y/test-utils": "6.9.5"
+        "@sa11y/common": "6.10.0",
+        "@sa11y/test-utils": "6.10.0"
     },
     "publishConfig": {
         "access": "public"
@@ -43,5 +43,5 @@
     "engines": {
         "node": "^16 || ^18 || ^20"
     },
-    "gitHead": "20778083b656180c2b077a4a7148cf813c05d040"
+    "gitHead": "1f5d3dc24b26e096686cc22436998661705b490a"
 }