@sa11y/jest 5.3.2 → 6.1.0

package/README.md

@@ -19,7 +19,6 @@ Accessibility matcher for [Jest](https://jestjs.io)
     - [JSON result transformation](#json-result-transformation)
   - [Limitations](#limitations)
   - [Disabled Checks](#disabled-checks)
-  - [Jest toMatchSnapshot() API Wrapper](#jest-tomatchsnapshot-api-wrapper)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -279,7 +278,3 @@ 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))
-
-### Jest toMatchSnapshot() API Wrapper
-
--   When Snapshot testing is done, jest's `toMatchSnapshot()` API is altering the document.body element attributes as needed to generate snapshots thereby the a11y checks which happen later on `document.body` isn't running on actual elements. To solve this, a wrapper has been introduced to restore the document.body DOM before jest's `toMatchSnapshot` is invoked and use the restored version of document.body for a11y checks.

package/dist/automatic.d.ts

@@ -8,6 +8,7 @@ export type AutoCheckOpts = {
     filesFilter?: 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
  */

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;;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,CAoC9F;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAM7F"}
+{"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,CAoC9F;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAQ7F"}

package/dist/automatic.js

@@ -6,7 +6,7 @@
  * 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.setOriginalDocumentBodyHtml = void 0;
+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");
@@ -28,6 +28,10 @@ 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
  */
@@ -92,7 +96,9 @@ function registerSa11yAutomaticChecks(opts = defaultAutoCheckOpts) {
     if (opts.runAfterEach) {
         // TODO (fix): Make registration idempotent
         (0, common_1.log)('Registering sa11y checks to be run automatically after each test');
-        afterEach(async () => await automaticCheck(opts));
+        afterEach(async () => {
+            await automaticCheck(opts);
+        });
     }
 }
 exports.registerSa11yAutomaticChecks = registerSa11yAutomaticChecks;

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,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAA6D,MAAM,aAAa,CAAC;AASvG,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAWF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAaF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CAW9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAW3C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAK3F"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EACH,aAAa,EAIhB,MAAM,aAAa,CAAC;AAGrB,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AA8BF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CAY9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAK3F"}

package/dist/setup.js

@@ -10,7 +10,6 @@ exports.adaptA11yConfig = exports.registerSa11yMatcher = exports.setup = exports
 const matcher_1 = require("./matcher");
 const automatic_1 = require("./automatic");
 const globals_1 = require("@jest/globals");
-const jest_snapshot_1 = require("jest-snapshot");
 exports.disabledRules = [
     // Descendancy checks that would fail at unit/component level, but pass at page level
     'aria-required-children',
@@ -29,14 +28,6 @@ exports.disabledRules = [
     'audio-caption',
     'video-caption',
 ];
-function wrapperSnapshotMatcher(originalMatcher) {
-    return function (...args) {
-        (0, automatic_1.setOriginalDocumentBodyHtml)(document?.body?.innerHTML ?? '');
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        return originalMatcher.call(globals_1.expect.getState(), ...args);
-    };
-}
 /**
  * Default options for sa11y jest matcher
  */
@@ -47,11 +38,26 @@ const defaultSa11yOpts = {
         consolidateResults: false,
     },
 };
+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);
+    };
+}
 /**
  * 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) {
+    registerRemoveChild();
     registerSa11yMatcher();
     // Set defaults from env vars
     const autoCheckOpts = opts.autoCheckOpts;
@@ -68,9 +74,8 @@ exports.setup = setup;
  * Register accessibility helpers toBeAccessible as jest matchers
  */
 function registerSa11yMatcher() {
-    const wrapper = wrapperSnapshotMatcher(jest_snapshot_1.toMatchSnapshot);
     if (globals_1.expect !== undefined) {
-        globals_1.expect.extend({ toBeAccessible: matcher_1.toBeAccessible, toMatchSnapshot: wrapper });
+        globals_1.expect.extend({ toBeAccessible: matcher_1.toBeAccessible });
     }
     else {
         throw new Error("Unable to find Jest's expect function." +

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "5.3.2",
+    "version": "6.1.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": "5.3.2",
-        "@sa11y/format": "5.3.2",
-        "@sa11y/preset-rules": "5.3.2",
+        "@sa11y/assert": "6.1.0",
+        "@sa11y/format": "6.1.0",
+        "@sa11y/preset-rules": "6.1.0",
         "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
@@ -34,10 +34,8 @@
     },
     "devDependencies": {
         "@jest/globals": "28.1.3",
-        "@sa11y/common": "5.3.2",
-        "@sa11y/test-utils": "5.3.2",
-        "expect": "28.1.3",
-        "jest-snapshot": "28.1.3"
+        "@sa11y/common": "6.1.0",
+        "@sa11y/test-utils": "6.1.0"
     },
     "publishConfig": {
         "access": "public"
@@ -45,5 +43,5 @@
     "engines": {
         "node": "^16 || ^18"
     },
-    "gitHead": "61f4a93425fd67a1fdea694c02ed9582dfc26fc1"
+    "gitHead": "a19cfe75abfad15cdef9919ed753d1479e6af69b"
 }