@axe-core/watcher 3.11.0 → 3.11.1-next.06e682d4

package/dist/utils/validateApiKey.test.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("mocha");
+const chai_1 = require("chai");
+const sinon_1 = __importDefault(require("sinon"));
+const proxyquire_1 = __importDefault(require("proxyquire"));
+describe('validateApiKey', () => {
+    describe('when the server returns a non-200 response', () => {
+        it('throws an error', () => {
+            const requestStub = sinon_1.default
+                .stub()
+                .returns({ statusCode: 500, getBody: () => '{"error":"boom"}' });
+            const fn = (0, proxyquire_1.default)('./validateApiKey', {
+                'sync-request': requestStub
+            }).default;
+            chai_1.assert.throws(() => {
+                fn({ apiKey: 'abc', serverURL: 'http://localhost:3000' });
+            }, 'boom');
+        });
+    });
+    describe('when the server returns a 200 response', () => {
+        it('does not throw an error', () => {
+            const requestStub = sinon_1.default
+                .stub()
+                .returns({ statusCode: 200, getBody: () => '{}' });
+            const fn = (0, proxyquire_1.default)('./validateApiKey', {
+                'sync-request': requestStub
+            }).default;
+            chai_1.assert.doesNotThrow(() => {
+                fn({ apiKey: 'abc', serverURL: 'http://localhost:3000' });
+            });
+        });
+        it('throws an error when a user provides an empty string as an API key', () => {
+            const requestStub = sinon_1.default
+                .stub()
+                .returns({ statusCode: 200, getBody: () => '{}' });
+            const fn = (0, proxyquire_1.default)('./validateApiKey', {
+                'sync-request': requestStub
+            }).default;
+            chai_1.assert.throws(() => {
+                fn({ apiKey: '', serverURL: 'http://localhost:3000' });
+            }, 'API key is required');
+        });
+        it('sends API key authentication request with correct format', () => {
+            const requestStub = sinon_1.default
+                .stub()
+                .returns({ statusCode: 200, getBody: () => '{}' });
+            const fn = (0, proxyquire_1.default)('./validateApiKey', {
+                'sync-request': requestStub
+            }).default;
+            const apiKey = 'test-api-key';
+            const serverURL = 'http://localhost:3000';
+            fn({ apiKey, serverURL });
+            (0, chai_1.assert)(requestStub.calledOnce, 'api-key authentication requested more than once');
+            const callArgs = requestStub.getCall(0).args;
+            const [method, url, options] = callArgs;
+            chai_1.assert.strictEqual(method, 'GET', 'Request method is not GET');
+            chai_1.assert.strictEqual(url, `${serverURL}/api/api-keys/validate/axe-devtools-watcher`, 'URL does not match');
+            chai_1.assert.strictEqual(options.headers['X-API-Key'], apiKey, 'X-API-Key header does not match');
+        });
+    });
+});
+//# sourceMappingURL=validateApiKey.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validateApiKey.test.js","sourceRoot":"","sources":["../../src/utils/validateApiKey.test.ts"],"names":[],"mappings":";;;;;AAAA,iBAAc;AACd,+BAA6B;AAC7B,kDAAyB;AACzB,4DAAmC;AAGnC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,QAAQ,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAC1D,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;YACzB,MAAM,WAAW,GAAG,eAAK;iBACtB,IAAI,EAAE;iBACN,OAAO,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,kBAAkB,EAAE,CAAC,CAAA;YAClE,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,kBAAkB,EAAE;gBACxC,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC,OAAgC,CAAA;YAEnC,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;gBACjB,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,uBAAuB,EAAE,CAAC,CAAA;YAC3D,CAAC,EAAE,MAAM,CAAC,CAAA;QACZ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;QACtD,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACjC,MAAM,WAAW,GAAG,eAAK;iBACtB,IAAI,EAAE;iBACN,OAAO,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;YACpD,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,kBAAkB,EAAE;gBACxC,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC,OAAgC,CAAA;YAEnC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE;gBACvB,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,uBAAuB,EAAE,CAAC,CAAA;YAC3D,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;YAC5E,MAAM,WAAW,GAAG,eAAK;iBACtB,IAAI,EAAE;iBACN,OAAO,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;YACpD,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,kBAAkB,EAAE;gBACxC,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC,OAAgC,CAAA;YAEnC,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;gBACjB,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,uBAAuB,EAAE,CAAC,CAAA;YACxD,CAAC,EAAE,qBAAqB,CAAC,CAAA;QAC3B,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,WAAW,GAAG,eAAK;iBACtB,IAAI,EAAE;iBACN,OAAO,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;YACpD,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,kBAAkB,EAAE;gBACxC,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC,OAAgC,CAAA;YAEnC,MAAM,MAAM,GAAG,cAAc,CAAA;YAC7B,MAAM,SAAS,GAAG,uBAAuB,CAAA;YAEzC,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;YAEzB,IAAA,aAAM,EACJ,WAAW,CAAC,UAAU,EACtB,iDAAiD,CAClD,CAAA;YAED,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YAC5C,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAA;YAEvC,aAAM,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,2BAA2B,CAAC,CAAA;YAC9D,aAAM,CAAC,WAAW,CAChB,GAAG,EACH,GAAG,SAAS,6CAA6C,EACzD,oBAAoB,CACrB,CAAA;YACD,aAAM,CAAC,WAAW,CAChB,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAC5B,MAAM,EACN,iCAAiC,CAClC,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/utils/validateAxeRunContext.d.ts

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

package/dist/utils/validateAxeRunContext.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAxeRunContext = validateAxeRunContext;
+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 
+      `);
+    }
+}
+/**
+ * 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

@@ -0,0 +1 @@
+{"version":3,"file":"validateAxeRunContext.js","sourceRoot":"","sources":["../../src/utils/validateAxeRunContext.ts"],"names":[],"mappings":";;AAEA,sDAkBC;AAlBD,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;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

@@ -0,0 +1 @@
+import 'mocha';

package/dist/utils/validateAxeRunContext.test.js

@@ -0,0 +1,100 @@
+"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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAxeRunOptions = validateAxeRunOptions;
+exports.isObject = isObject;
+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(', ')}`);
+        }
+    }
+}
+/** Helper functions */
+/** Checks if the value provided is an object */
+function isObject(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+/** 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

@@ -0,0 +1 @@
+{"version":3,"file":"validateAxeRunOptions.js","sourceRoot":"","sources":["../../src/utils/validateAxeRunOptions.ts"],"names":[],"mappings":";;AAmBA,sDAqCC;AAKD,4BAEC;AA1DD,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;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;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

@@ -0,0 +1 @@
+import 'mocha';