@axe-core/watcher 3.11.1-next.ffd54e39 → 3.11.1-rc.100a71b1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/watcher",
-  "version": "3.11.1-next.ffd54e39",
+  "version": "3.11.1-rc.100a71b1",
   "description": "",
   "license": "UNLICENSED",
   "main": "dist/index.js",
@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "tsc",
-    "test": "mocha 'src/**/*.test.ts'",
+    "test": "mocha 'src/*.test.ts'",
     "test:e2e": "mocha 'e2e/*.test.ts'",
     "serve:e2e": "ts-node e2e/Server.ts",
     "coverage": "nyc npm test",
@@ -18,7 +18,6 @@
     "dev": "tsc -w"
   },
   "dependencies": {
-    "debug": "^4.3.5",
     "eventemitter3": "^5.0.1",
     "node-fetch": "^2.6.7",
     "sync-request": "^6.1.0",
@@ -30,7 +29,6 @@
     "@types/body-parser": "^1.19.2",
     "@types/chai": "^4.3.3",
     "@types/cors": "^2.8.12",
-    "@types/debug": "^4.1.12",
     "@types/express": "^4.17.14",
     "@types/mocha": "^10.0.0",
     "@types/morgan": "^1.9.3",
@@ -54,7 +52,6 @@
     "morgan": "^1.10.0",
     "nock": "^13.3.2",
     "nyc": "^15.1.0",
-    "playwright-core": "^1.43.1",
     "proxyquire": "^2.1.3",
     "puppeteer": "^22.1.0",
     "rimraf": "^5.0.5",

package/dist/createDebugger.d.ts

@@ -1,9 +0,0 @@
-import debug from 'debug';
-/**
- * Creates a debug logger with the given namespace
- *
- * @param namespace The namespace for the debug logger for example: `PlaywrightController` or `PlaywrightWrapping`.
- * @returns debug instance
- */
-declare function createDebugger(namespace: string): debug.Debugger;
-export default createDebugger;

package/dist/createDebugger.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const debug_1 = __importDefault(require("debug"));
-/**
- * The prefix for the debug logger allows users to filter logs by the prefix
- * using the debug package.
- *
- * @example
- * ```bash
- * DEBUG=axe-watcher:* yarn test
- * ```
- */
-const NAMESPACE_PREFIX = 'axe-watcher';
-/**
- * Creates a debug logger with the given namespace
- *
- * @param namespace The namespace for the debug logger for example: `PlaywrightController` or `PlaywrightWrapping`.
- * @returns debug instance
- */
-function createDebugger(namespace) {
-    return (0, debug_1.default)(`${NAMESPACE_PREFIX}:${namespace}`);
-}
-exports.default = createDebugger;
-//# sourceMappingURL=createDebugger.js.map

package/dist/createDebugger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createDebugger.js","sourceRoot":"","sources":["../src/createDebugger.ts"],"names":[],"mappings":";;;;;AAAA,kDAAyB;AAEzB;;;;;;;;GAQG;AACH,MAAM,gBAAgB,GAAG,aAAa,CAAA;AAEtC;;;;;GAKG;AAEH,SAAS,cAAc,CAAC,SAAiB;IACvC,OAAO,IAAA,eAAK,EAAC,GAAG,gBAAgB,IAAI,SAAS,EAAE,CAAC,CAAA;AAClD,CAAC;AAED,kBAAe,cAAc,CAAA"}

package/dist/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from './validateAxeRunOptions';
-export * from './validateAxeRunContext';

package/dist/utils/index.js

@@ -1,20 +0,0 @@
-"use strict";
-// TODO: https://github.com/dequelabs/jazzband/issues/1227
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./validateAxeRunOptions"), exports);
-__exportStar(require("./validateAxeRunContext"), exports);
-//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";AAAA,0DAA0D;;;;;;;;;;;;;;;;AAE1D,0DAAuC;AACvC,0DAAuC"}

package/dist/utils/validateAxeRunContext.d.ts

@@ -1,2 +0,0 @@
-import type { ElementContext } from 'axe-core';
-export declare function validateAxeRunContext(runContext?: ElementContext | undefined): asserts runContext is ElementContext;

package/dist/utils/validateAxeRunContext.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAxeRunContext = void 0;
-function validateAxeRunContext(runContext = undefined) {
-    if (!runContext) {
-        return;
-    }
-    if (!isContextObject(runContext)) {
-        throw new Error(`\`runContext\` must be an object, an array of objects, or a string. Examples: \n
-      - Object: { runContext: { include: 'selector' } }\n
-      - Array: { runContext: ['selector1', 'selector2'] }\n
-      - String: { runContext: 'selector' }\n
-
-      For more detailed examples: https://www.deque.com/axe/core-documentation/api-documentation/#context-parameter 
-      `);
-    }
-}
-exports.validateAxeRunContext = validateAxeRunContext;
-/**
- * Validates the context object for the `runContext` parameter of the `axe.run` method.
- * Borrowed from axe-core's original implementation.
- *
- * @see https://github.com/dequelabs/axe-core/blob/0577a74fab385a590b31c9118f3da7ad55051097/lib/core/base/context/normalize-context.js#L92
- *
- * Removed `window.node` check
- *
- * @param contextSpec - The context object to validate
- * @returns `true` if the context object is valid, `false` otherwise
- */
-function isContextObject(contextSpec) {
-    return ['include', 'exclude'].some(prop => objectHasOwn(contextSpec, prop) &&
-        isContextProp(contextSpec[prop]));
-}
-//@see https://github.com/dequelabs/axe-core/blob/0577a74fab385a590b31c9118f3da7ad55051097/lib/core/base/context/normalize-context.js#L98
-function isContextProp(contextList) {
-    return (typeof contextList === 'string' ||
-        isLabelledFramesSelector(contextList) ||
-        isLabelledShadowDomSelector(contextList) ||
-        isArrayLike(contextList));
-}
-// @see https://github.com/dequelabs/axe-core/blob/0577a74fab385a590b31c9118f3da7ad55051097/lib/core/base/context/normalize-context.js#L178-L184
-function objectHasOwn(obj, prop) {
-    if (!obj || typeof obj !== 'object') {
-        return false;
-    }
-    return Object.prototype.hasOwnProperty.call(obj, prop);
-}
-//@see https://github.com/dequelabs/axe-core/blob/0577a74fab385a590b31c9118f3da7ad55051097/lib/core/base/context/normalize-context.js#L108
-function isLabelledFramesSelector(selector) {
-    return objectHasOwn(selector, 'fromFrames');
-}
-//@see https://github.com/dequelabs/axe-core/blob/0577a74fab385a590b31c9118f3da7ad55051097/lib/core/base/context/normalize-context.js#L112
-function isLabelledShadowDomSelector(selector) {
-    return objectHasOwn(selector, 'fromShadowDom');
-}
-// @see https://github.com/dequelabs/axe-core/blob/0577a74fab385a590b31c9118f3da7ad55051097/lib/core/base/context/normalize-context.js#L160C1-L168C2
-function isArrayLike(arr) {
-    return arr && typeof arr === 'object' && typeof arr.length === 'number';
-}
-//# sourceMappingURL=validateAxeRunContext.js.map

package/dist/utils/validateAxeRunContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateAxeRunContext.js","sourceRoot":"","sources":["../../src/utils/validateAxeRunContext.ts"],"names":[],"mappings":";;;AAEA,SAAgB,qBAAqB,CACnC,aAAyC,SAAS;IAElD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAM;IACR,CAAC;IAED,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb;;;;;;OAMC,CACF,CAAA;IACH,CAAC;AACH,CAAC;AAlBD,sDAkBC;AAED;;;;;;;;;;GAUG;AACH,SAAS,eAAe,CAAC,WAA2B;IAClD,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,IAAI,CAChC,IAAI,CAAC,EAAE,CACL,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC;QAC/B,aAAa,CAAC,WAAW,CAAC,IAA4B,CAAC,CAAC,CAC3D,CAAA;AACH,CAAC;AAED,yIAAyI;AACzI,SAAS,aAAa,CACpB,WAAiD;IAEjD,OAAO,CACL,OAAO,WAAW,KAAK,QAAQ;QAC/B,wBAAwB,CAAC,WAAW,CAAC;QACrC,2BAA2B,CAAC,WAAW,CAAC;QACxC,WAAW,CAAC,WAAW,CAAC,CACzB,CAAA;AACH,CAAC;AAED,gJAAgJ;AAChJ,SAAS,YAAY,CAAC,GAAY,EAAE,IAAiB;IACnD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AACxD,CAAC;AAED,0IAA0I;AAC1I,SAAS,wBAAwB,CAAC,QAAiB;IACjD,OAAO,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;AAC7C,CAAC;AAED,0IAA0I;AAC1I,SAAS,2BAA2B,CAAC,QAAiB;IACpD,OAAO,YAAY,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;AAChD,CAAC;AAED,oJAAoJ;AACpJ,SAAS,WAAW,CAAC,GAAc;IACjC,OAAO,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAA;AACzE,CAAC"}

package/dist/utils/validateAxeRunContext.test.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="cypress/types/mocha" />
-import 'mocha';

package/dist/utils/validateAxeRunContext.test.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("mocha");
-const chai_1 = require("chai");
-const validateAxeRunContext_1 = require("./validateAxeRunContext");
-describe('validateAxeRunContext', () => {
-    describe('when no run context is provided', () => {
-        it('does not throw an error', () => {
-            chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)());
-        });
-    });
-    describe('given a valid run context', () => {
-        describe('when the run context is a string', () => {
-            it('does not throw an error', () => {
-                chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({ include: 'selector' }));
-            });
-        });
-        describe('when the run context is an array of strings', () => {
-            it('does not throw an error', () => {
-                chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({ include: ['selector1', 'selector2'] }));
-            });
-        });
-        describe('when the run context is an object', () => {
-            describe('when the object has an `include` property', () => {
-                it('does not throw an error', () => {
-                    chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({ include: 'selector' }));
-                });
-                describe('and a `fromFrames` property', () => {
-                    it('does not throw an error', () => {
-                        chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({
-                            include: {
-                                fromFrames: ['selector', 'selector']
-                            }
-                        }));
-                    });
-                });
-                describe('and a `fromShadowDom` property', () => {
-                    it('does not throw an error', () => {
-                        chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({
-                            include: {
-                                fromShadowDom: ['selector', 'selector']
-                            }
-                        }));
-                    });
-                });
-            });
-            describe('when the object has an `exclude` property', () => {
-                it('does not throw an error', () => {
-                    chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({ exclude: 'selector' }));
-                });
-                describe('and a `fromFrames` property', () => {
-                    it('does not throw an error', () => {
-                        chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({
-                            exclude: {
-                                fromFrames: ['selector', 'selector']
-                            }
-                        }));
-                    });
-                });
-                describe('and a `fromShadowDom` property', () => {
-                    it('does not throw an error', () => {
-                        chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({
-                            exclude: {
-                                fromShadowDom: ['selector', 'selector']
-                            }
-                        }));
-                    });
-                });
-            });
-            describe('when the object has both `include` and `exclude` properties', () => {
-                it('does not throw an error', () => {
-                    chai_1.assert.doesNotThrow(() => (0, validateAxeRunContext_1.validateAxeRunContext)({ include: 'selector', exclude: 'selector' }));
-                });
-            });
-        });
-    });
-    describe('given an invalid run context', () => {
-        describe('and does not have an `include` or `exclude` property', () => {
-            describe('and is not a string', () => {
-                it('throws an error', () => {
-                    //@ts-expect-error - Testing invalid input
-                    chai_1.assert.throws(() => (0, validateAxeRunContext_1.validateAxeRunContext)(1));
-                });
-            });
-            describe('and is not an array of strings', () => {
-                it('throws an error', () => {
-                    //@ts-expect-error - Testing invalid input
-                    chai_1.assert.throws(() => (0, validateAxeRunContext_1.validateAxeRunContext)([1, 2]));
-                });
-            });
-            describe('and does not have a `fromFrames` or `fromShadowDom` property', () => {
-                it('throws an error', () => {
-                    //@ts-expect-error - Testing invalid input
-                    chai_1.assert.throws(() => (0, validateAxeRunContext_1.validateAxeRunContext)({ a: 'a' }));
-                });
-            });
-        });
-    });
-});
-//# sourceMappingURL=validateAxeRunContext.test.js.map

package/dist/utils/validateAxeRunContext.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateAxeRunContext.test.js","sourceRoot":"","sources":["../../src/utils/validateAxeRunContext.test.ts"],"names":[],"mappings":";;AAAA,iBAAc;AACd,+BAA6B;AAC7B,mEAA+D;AAE/D,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;QAC/C,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAA,6CAAqB,GAAE,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAChD,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;gBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAC/C,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,6CAA6C,EAAE,GAAG,EAAE;YAC3D,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;gBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE,CAAC,CAC/D,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;YACjD,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;gBACzD,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;oBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAC/C,CAAA;gBACH,CAAC,CAAC,CAAA;gBAEF,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;oBAC3C,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;wBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC;4BACpB,OAAO,EAAE;gCACP,UAAU,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;6BACrC;yBACF,CAAC,CACH,CAAA;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;gBAEF,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;oBAC9C,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;wBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC;4BACpB,OAAO,EAAE;gCACP,aAAa,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;6BACxC;yBACF,CAAC,CACH,CAAA;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;gBACzD,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;oBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAC/C,CAAA;gBACH,CAAC,CAAC,CAAA;gBAEF,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;oBAC3C,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;wBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC;4BACpB,OAAO,EAAE;gCACP,UAAU,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;6BACrC;yBACF,CAAC,CACH,CAAA;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;gBAEF,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;oBAC9C,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;wBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC;4BACpB,OAAO,EAAE;gCACP,aAAa,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;6BACxC;yBACF,CAAC,CACH,CAAA;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,6DAA6D,EAAE,GAAG,EAAE;gBAC3E,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;oBACjC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CACvB,IAAA,6CAAqB,EAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CACpE,CAAA;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;QAC5C,QAAQ,CAAC,sDAAsD,EAAE,GAAG,EAAE;YACpE,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;gBACnC,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;oBACzB,0CAA0C;oBAC1C,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,6CAAqB,EAAC,CAAC,CAAC,CAAC,CAAA;gBAC/C,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;gBAC9C,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;oBACzB,0CAA0C;oBAC1C,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,6CAAqB,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;gBACpD,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,8DAA8D,EAAE,GAAG,EAAE;gBAC5E,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;oBACzB,0CAA0C;oBAC1C,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,6CAAqB,EAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACxD,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/utils/validateAxeRunOptions.d.ts

@@ -1,13 +0,0 @@
-import type { RunOptions as AxeRunOptions } from 'axe-core';
-export type RunOptions = Pick<AxeRunOptions, 'runOnly' | 'rules' | 'ancestry'>;
-/**
- * We only provide a subset of axe-core's RunOptions.
- * We want to sanitize the user's input to ensure they are not providing
- * any invalid properties that are outside of the subset we provide.
- *
- * @param runOptions The user's run options.
- */
-export declare function validateAxeRunOptions(runOptions?: RunOptions | undefined): asserts runOptions is RunOptions;
-/** Helper functions */
-/** Checks if the value provided is an object */
-export declare function isObject(value: unknown): value is Record<string, unknown>;

package/dist/utils/validateAxeRunOptions.js

@@ -1,162 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isObject = exports.validateAxeRunOptions = void 0;
-const VALID_RUN_ONLY_TYPES = [
-    'rules',
-    'rule',
-    'tag',
-    'tags'
-];
-/**
- * We only provide a subset of axe-core's RunOptions.
- * We want to sanitize the user's input to ensure they are not providing
- * any invalid properties that are outside of the subset we provide.
- *
- * @param runOptions The user's run options.
- */
-function validateAxeRunOptions(runOptions = undefined) {
-    if (!runOptions) {
-        return;
-    }
-    const runOptionsKeys = Object.keys(runOptions);
-    const validKeys = [
-        'runOnly',
-        'rules',
-        'ancestry'
-    ];
-    for (const key of runOptionsKeys) {
-        switch (key) {
-            case 'ancestry':
-                if (!isBoolean(runOptions.ancestry)) {
-                    throw new Error('`ancestry` property must be a boolean. Full example: `{ ancestry: true }`');
-                }
-                break;
-            case 'rules':
-                validateRulesProperty(runOptions.rules);
-                break;
-            case 'runOnly':
-                validateRunOnlyProperty(runOptions.runOnly);
-                break;
-            default:
-                throw new Error(`Invalid property found in \`runOptions\`: ${key}. The available properties are: ${validKeys.join(', ')}`);
-        }
-    }
-}
-exports.validateAxeRunOptions = validateAxeRunOptions;
-/** Helper functions */
-/** Checks if the value provided is an object */
-function isObject(value) {
-    return value !== null && typeof value === 'object' && !Array.isArray(value);
-}
-exports.isObject = isObject;
-/** Checks if the value provided is a boolean */
-function isBoolean(value) {
-    return typeof value === 'boolean';
-}
-/**
- * Validate the user's `rules` object and its values. As a user can provide:
- * @example
- * {
- *  rules: {
- *   'ruleId1': { enabled: false },
- *   'ruleId2': { enabled: false }
- *   'ruleId3': { enabled: false }
- *   // ...
- *  }
- * }
- *
- * @param rules The user's rules object.
- */
-function validateRulesProperty(rules) {
-    if (!isObject(rules)) {
-        throw new Error('`rules` property must be an object. Full example: `{ rules: { "ruleId": { enabled: false } } }`');
-    }
-    if (!Object.keys(rules).length) {
-        throw new Error('`rules` object must contain at least one key-value pair. Full example: `{ rules: { "ruleId": { enabled: false } } }`');
-    }
-    // Validate each K:V pair in the `rules` object e.g. { 'ruleId': { enabled: false } }
-    for (const ruleKey of Object.keys(rules)) {
-        const ruleValue = rules[ruleKey];
-        if (!isObject(ruleValue)) {
-            throw new Error(`The value of the \`${ruleKey}\` key in the \`rules\` object must be an object. Full example: \`{ rules: { "ruleId": { enabled: false } } }\``);
-        }
-        if (Object.keys(ruleValue).length !== 1) {
-            throw new Error(`The \`${ruleKey}\` key in the \`rules\` object must only contain the \`enabled\` property. Full example: \`{ rules: { "ruleId": { enabled: false } } }\``);
-        }
-        if (!('enabled' in ruleValue)) {
-            throw new Error(`The \`${ruleKey}\` key in the \`rules\` object must contain an \`enabled\` property. Full example: \`{ rules: { "ruleId": { enabled: false } } }\``);
-        }
-        if (!isBoolean(ruleValue.enabled)) {
-            throw new Error(`The \`enabled\` property of the \`${ruleKey}\` key in the \`rules\` object must be a boolean. Full example: \`{ rules: { "ruleId": { enabled: false } } }\``);
-        }
-    }
-}
-/**
- * Validate the user's `runOnly` configuration. A user can provide:
- * @example
- * {
- *  runOnly: {
- *    type: 'rule',
- *    values: ['ruleId1', 'ruleId2', 'ruleId3']
- *  }
- * }
- *
- * OR
- *
- * @example
- * {
- *  runOnly: ['ruleId1', 'ruleId2', 'ruleId3']
- * }
- *
- * OR
- *
- * @example
- * {
- *  runOnly: 'ruleId1'
- * }
- *
- * @param runOnly The user's runOnly object, array, or string.
- */
-function validateRunOnlyProperty(runOnly) {
-    const isRunOnlyObject = isObject(runOnly);
-    const isRunOnlyArray = Array.isArray(runOnly);
-    const isRunOnlyString = typeof runOnly === 'string';
-    if (!isRunOnlyObject && !isRunOnlyArray && !isRunOnlyString) {
-        throw new Error(`\`runOnly\` property must be an object, an array, or a string. Examples: \n
-        - Object: { runOnly: { type: 'rule', values: ['ruleId1'] } }\n
-        - Array: { runOnly: ['ruleId1', 'ruleId2', 'ruleId3'] }\n
-        - String: { runOnly: 'ruleId1' }\n
-
-        For more detailed examples: https://www.deque.com/axe/core-documentation/api-documentation/#options-parameter 
-      `);
-    }
-    if (isRunOnlyArray) {
-        if (!runOnly.length) {
-            throw new Error(`\`runOnly\` array must contain at least one string value. Example: { runOnly: ['ruleId1', 'ruleId2'] }`);
-        }
-        if (runOnly.some(value => typeof value !== 'string')) {
-            throw new Error(`\`runOnly\` array must contain only strings. Example: { runOnly: ['ruleId1', 'ruleId2'] }`);
-        }
-    }
-    if (isRunOnlyObject) {
-        if (!('type' in runOnly)) {
-            throw new Error(`\`runOnly\` object must contain a \`type\` property. Example: { runOnly: { type: 'rule', values: ['ruleId1'] } }`);
-        }
-        if (!('values' in runOnly)) {
-            throw new Error(`\`runOnly\` object must contain a \`values\` property. Example: { runOnly: { type: 'rule', values: ['ruleId1'] } }`);
-        }
-        if (!VALID_RUN_ONLY_TYPES.includes(runOnly.type)) {
-            throw new Error(`\`runOnly\` object's \`type\` property must be one of the following: ${VALID_RUN_ONLY_TYPES.join(', ')}`);
-        }
-        if (!Array.isArray(runOnly.values)) {
-            throw new Error(`\`runOnly\` object's \`values\` property must be an array. Example: { runOnly: { type: 'rule', values: ['ruleId1'] } }`);
-        }
-        if (!runOnly.values.length) {
-            throw new Error(`\`runOnly\` object's \`values\` property must contain at least one value. Example: { runOnly: { type: 'rule', values: ['ruleId1'] } }`);
-        }
-        if (runOnly.values.some(value => typeof value !== 'string')) {
-            throw new Error(`\`runOnly\` object's \`values\` property must contain only strings. Example: { runOnly: { type: 'rule', values: ['ruleId1'] } }`);
-        }
-    }
-}
-//# sourceMappingURL=validateAxeRunOptions.js.map

package/dist/utils/validateAxeRunOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateAxeRunOptions.js","sourceRoot":"","sources":["../../src/utils/validateAxeRunOptions.ts"],"names":[],"mappings":";;;AAKA,MAAM,oBAAoB,GAA+B;IACvD,OAAO;IACP,MAAM;IACN,KAAK;IACL,MAAM;CACP,CAAA;AAED;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,aAAqC,SAAS;IAE9C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAM;IACR,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC9C,MAAM,SAAS,GAAoC;QACjD,SAAS;QACT,OAAO;QACP,UAAU;KACX,CAAA;IAED,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,UAAU;gBACb,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACpC,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;gBACH,CAAC;gBACD,MAAK;YAEP,KAAK,OAAO;gBACV,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;gBACvC,MAAK;YACP,KAAK,SAAS;gBACZ,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;gBAC3C,MAAK;YAEP;gBACE,MAAM,IAAI,KAAK,CACb,6CAA6C,GAAG,mCAAmC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC1G,CAAA;QACL,CAAC;IACH,CAAC;AACH,CAAC;AArCD,sDAqCC;AAED,uBAAuB;AAEvB,gDAAgD;AAChD,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC;AAFD,4BAEC;AAED,gDAAgD;AAChD,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,OAAO,KAAK,KAAK,SAAS,CAAA;AACnC,CAAC;AAED;;;;;;;;;;;;;GAaG;AAEH,SAAS,qBAAqB,CAAC,KAA0B;IACvD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAA;IACH,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,sHAAsH,CACvH,CAAA;IACH,CAAC;IAED,qFAAqF;IACrF,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;QAEhC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,sBAAsB,OAAO,iHAAiH,CAC/I,CAAA;QACH,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,SAAS,OAAO,0IAA0I,CAC3J,CAAA;QACH,CAAC;QAED,IAAI,CAAC,CAAC,SAAS,IAAI,SAAS,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,SAAS,OAAO,oIAAoI,CACrJ,CAAA;QACH,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CACb,qCAAqC,OAAO,iHAAiH,CAC9J,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,SAAS,uBAAuB,CAAC,OAA8B;IAC7D,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAA;IACzC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7C,MAAM,eAAe,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAA;IAEnD,IAAI,CAAC,eAAe,IAAI,CAAC,cAAc,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CACb;;;;;;OAMC,CACF,CAAA;IACH,CAAC;IAED,IAAI,cAAc,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAA;QACH,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CACb,2FAA2F,CAC5F,CAAA;QACH,CAAC;IACH,CAAC;IAED,IAAI,eAAe,EAAE,CAAC;QACpB,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,kHAAkH,CACnH,CAAA;QACH,CAAC;QAED,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,oHAAoH,CACrH,CAAA;QACH,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CACb,wEAAwE,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC1G,CAAA;QACH,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,wHAAwH,CACzH,CAAA;QACH,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,uIAAuI,CACxI,CAAA;QACH,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CACb,iIAAiI,CAClI,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/utils/validateAxeRunOptions.test.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="cypress/types/mocha" />
-import 'mocha';