@axe-core/watcher 3.12.0 → 3.13.1-next.13e7eef5

package/dist/utils/initializeSession.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sync_request_1 = __importDefault(require("sync-request"));
+const assert_1 = __importDefault(require("assert"));
+const createDebugger_1 = __importDefault(require("../createDebugger"));
+const uuid_1 = require("uuid");
+const debugLogger = (0, createDebugger_1.default)('config:initializeSession');
+/** Initialize a new session. */
+function initializeSession({ apiKey, serverURL, watcherVersion, sessionID, buildID, gitCommitSha }) {
+    (0, assert_1.default)(apiKey, 'API key is required');
+    (0, assert_1.default)(serverURL, 'Server URL is required');
+    (0, assert_1.default)(watcherVersion, 'Watcher version is required');
+    (0, assert_1.default)(!(sessionID && typeof sessionID !== 'string'), 'Session ID must be a string');
+    (0, assert_1.default)(!(buildID && typeof buildID !== 'string'), 'Build ID must be a string');
+    (0, assert_1.default)(!(sessionID && buildID), 'Session ID and Build ID are mutually exclusive. `sessionId` is deprecated, please use `buildID` instead');
+    (0, assert_1.default)(!(gitCommitSha && typeof gitCommitSha !== 'string'), 'Git commit SHA must be a string');
+    const url = new URL(`/api-pub/watcher/sessions`, serverURL);
+    const res = (0, sync_request_1.default)('POST', url.toString(), {
+        headers: {
+            'X-API-Key': apiKey
+        },
+        json: {
+            watcher_version: watcherVersion,
+            session_id: sessionID,
+            build_id: buildID,
+            git_commit_sha: gitCommitSha
+        }
+    });
+    const body = JSON.parse(res.getBody('utf8'));
+    if (body.errors.length) {
+        debugLogger('Error initializing session:', body.errors);
+        throw new Error(body.errors.join(', '));
+    }
+    if (body.warnings.length) {
+        debugLogger('Warning initializing session:', body.warnings);
+        // eslint-disable-next-line no-console -- We want to emit a warning to the user's console
+        console.warn(body.warnings.join(', '));
+    }
+    if (body.session_id) {
+        debugLogger('Session initialized successfully:', body.session_id);
+        return body.session_id;
+    }
+    /**
+     * Here we account for an old version of Walnut's initializeSession, which does not return a session_id.
+     * See https://github.com/dequelabs/jazzband/issues/1451
+     * TODO: This can eventually be removed when this can no longer be the case. https://github.com/dequelabs/jazzband/issues/1453
+     */
+    if (sessionID) {
+        debugLogger('Session failed to initialize. Returning the provided sessionID:', sessionID);
+        return sessionID;
+    }
+    if (buildID) {
+        debugLogger('Session failed to initialize based on the provided buildID:', buildID);
+        throw new Error('Failed to initialize session based on build_id. Try again later.');
+    }
+    const generatedID = (0, uuid_1.v4)();
+    debugLogger('Session did not initialize successfully. Returning a generated UUID:', generatedID);
+    return generatedID;
+}
+exports.default = initializeSession;
+//# sourceMappingURL=initializeSession.js.map

package/dist/utils/initializeSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializeSession.js","sourceRoot":"","sources":["../../src/utils/initializeSession.ts"],"names":[],"mappings":";;;;;AAAA,gEAAkC;AAClC,oDAA2B;AAC3B,uEAA8C;AAC9C,+BAAiC;AAEjC,MAAM,WAAW,GAAG,IAAA,wBAAc,EAAC,0BAA0B,CAAC,CAAA;AAkB9D,gCAAgC;AAChC,SAAS,iBAAiB,CAAC,EACzB,MAAM,EACN,SAAS,EACT,cAAc,EACd,SAAS,EACT,OAAO,EACP,YAAY,EACY;IACxB,IAAA,gBAAM,EAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IACrC,IAAA,gBAAM,EAAC,SAAS,EAAE,wBAAwB,CAAC,CAAA;IAC3C,IAAA,gBAAM,EAAC,cAAc,EAAE,6BAA6B,CAAC,CAAA;IACrD,IAAA,gBAAM,EACJ,CAAC,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,CAAC,EAC7C,6BAA6B,CAC9B,CAAA;IACD,IAAA,gBAAM,EAAC,CAAC,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,EAAE,2BAA2B,CAAC,CAAA;IAC9E,IAAA,gBAAM,EACJ,CAAC,CAAC,SAAS,IAAI,OAAO,CAAC,EACvB,yGAAyG,CAC1G,CAAA;IACD,IAAA,gBAAM,EACJ,CAAC,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,EACnD,iCAAiC,CAClC,CAAA;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,2BAA2B,EAAE,SAAS,CAAC,CAAA;IAC3D,MAAM,GAAG,GAAG,IAAA,sBAAO,EAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE;QAC1C,OAAO,EAAE;YACP,WAAW,EAAE,MAAM;SACpB;QACD,IAAI,EAAE;YACJ,eAAe,EAAE,cAAc;YAC/B,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,cAAc,EAAE,YAAY;SAC7B;KACF,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAA8B,CAAA;IAEzE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACvB,WAAW,CAAC,6BAA6B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACzC,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACzB,WAAW,CAAC,+BAA+B,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAE3D,yFAAyF;QACzF,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,WAAW,CAAC,mCAAmC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QACjE,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;;OAIG;IAEH,IAAI,SAAS,EAAE,CAAC;QACd,WAAW,CACT,iEAAiE,EACjE,SAAS,CACV,CAAA;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,WAAW,CACT,6DAA6D,EAC7D,OAAO,CACR,CAAA;QACD,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAA;IACH,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,SAAI,GAAE,CAAA;IAE1B,WAAW,CACT,sEAAsE,EACtE,WAAW,CACZ,CAAA;IACD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,kBAAe,iBAAiB,CAAA"}

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

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

package/dist/utils/initializeSession.test.js

@@ -0,0 +1,183 @@
+"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"));
+const initializeSession_1 = __importDefault(require("./initializeSession"));
+describe('initializeSession', () => {
+    afterEach(sinon_1.default.restore);
+    const defaultParams = {
+        apiKey: 'abc',
+        serverURL: 'http://localhost:3000',
+        watcherVersion: '1.0.0',
+        sessionID: null,
+        buildID: null,
+        gitCommitSha: null
+    };
+    describe('validating input', () => {
+        describe('when the API key is missing', () => {
+            it('throws an error', () => {
+                chai_1.assert.throws(() => {
+                    //@ts-expect-error - expected missing apiKey
+                    (0, initializeSession_1.default)({});
+                }, 'API key is required');
+            });
+        });
+        describe('when the server URL is missing', () => {
+            it('throws an error', () => {
+                chai_1.assert.throws(() => {
+                    //@ts-expect-error - expected missing serverURL
+                    (0, initializeSession_1.default)({ apiKey: 'abc' });
+                }, 'Server URL is required');
+            });
+        });
+        describe('when the watcher version is missing', () => {
+            it('throws an error', () => {
+                chai_1.assert.throws(() => {
+                    //@ts-expect-error - expected missing watcherVersion
+                    (0, initializeSession_1.default)({
+                        apiKey: 'abc',
+                        serverURL: 'http://localhost:3000'
+                    });
+                }, 'Watcher version is required');
+            });
+        });
+        describe('when the session ID is not a string', () => {
+            it('throws an error', () => {
+                chai_1.assert.throws(() => {
+                    (0, initializeSession_1.default)({
+                        ...defaultParams,
+                        //@ts-expect-error - expected sessionID to be a string
+                        sessionID: 123
+                    });
+                }, 'Session ID must be a string');
+            });
+        });
+        describe('when the build ID is not a string', () => {
+            it('throws an error', () => {
+                chai_1.assert.throws(() => {
+                    (0, initializeSession_1.default)({
+                        ...defaultParams,
+                        //@ts-expect-error - expected buildID to be a string
+                        buildID: 123
+                    });
+                }, 'Build ID must be a string');
+            });
+        });
+        describe('when both session ID and build ID are provided', () => {
+            it('throws an error', () => {
+                chai_1.assert.throws(() => {
+                    (0, initializeSession_1.default)({
+                        ...defaultParams,
+                        sessionID: 'abc',
+                        buildID: '123'
+                    });
+                }, 'Session ID and Build ID are mutually exclusive. `sessionId` is deprecated, please use `buildID` instead');
+            });
+        });
+        describe('when the git commit SHA is not a string', () => {
+            it('throws an error', () => {
+                chai_1.assert.throws(() => {
+                    (0, initializeSession_1.default)({
+                        ...defaultParams,
+                        //@ts-expect-error - expected gitCommitSha to be a string
+                        gitCommitSha: 123
+                    });
+                }, 'Git commit SHA must be a string');
+            });
+        });
+    });
+    describe('when the server returns a non-200 response', () => {
+        afterEach(sinon_1.default.restore);
+        it('throws an error', () => {
+            const requestStub = sinon_1.default
+                .stub()
+                .returns({ statusCode: 500, getBody: () => '{"errors":["boom"]}' });
+            const fn = (0, proxyquire_1.default)('./initializeSession', {
+                'sync-request': requestStub
+            }).default;
+            chai_1.assert.throws(() => {
+                fn(defaultParams);
+            }, 'boom');
+        });
+    });
+    describe('when the server returns a 200 response', () => {
+        it('does not throw an error', () => {
+            const expectedBody = {
+                errors: [],
+                warnings: [],
+                session_id: 'abc'
+            };
+            const requestStub = sinon_1.default.stub().returns({
+                statusCode: 200,
+                getBody: () => JSON.stringify(expectedBody)
+            });
+            const fn = (0, proxyquire_1.default)('./initializeSession', {
+                'sync-request': requestStub
+            }).default;
+            const invoke = fn(defaultParams);
+            chai_1.assert.doesNotThrow(() => invoke);
+            chai_1.assert.deepEqual(invoke, expectedBody.session_id);
+        });
+        describe('and no session_id is returned', () => {
+            const expectedBody = {
+                errors: [],
+                warnings: []
+            };
+            const sessionID = 'xyz';
+            describe('and a sessionID is provided', () => {
+                it('uses the sessionID', () => {
+                    const requestStub = sinon_1.default.stub().returns({
+                        statusCode: 200,
+                        getBody: () => JSON.stringify(expectedBody)
+                    });
+                    const fn = (0, proxyquire_1.default)('./initializeSession', {
+                        'sync-request': requestStub
+                    }).default;
+                    const invoke = fn({
+                        ...defaultParams,
+                        ...{ sessionID }
+                    });
+                    chai_1.assert.deepEqual(invoke, sessionID);
+                });
+            });
+            describe('and a buildID is provided', () => {
+                it('throws', () => {
+                    const requestStub = sinon_1.default.stub().returns({
+                        statusCode: 200,
+                        getBody: () => JSON.stringify(expectedBody)
+                    });
+                    const fn = (0, proxyquire_1.default)('./initializeSession', {
+                        'sync-request': requestStub
+                    }).default;
+                    const buildID = 'def';
+                    chai_1.assert.throws(() => fn({
+                        ...defaultParams,
+                        ...{ buildID }
+                    }), 'Failed to initialize session based on build_id. Try again later.');
+                });
+            });
+            describe('and neither a sessionID nor a buildID are provided', () => {
+                it('uses a generated UUID', () => {
+                    const requestStub = sinon_1.default.stub().returns({
+                        statusCode: 200,
+                        getBody: () => JSON.stringify(expectedBody)
+                    });
+                    const generatedID = 'ghi';
+                    const uuidStub = sinon_1.default.stub().returns(generatedID);
+                    const fn = (0, proxyquire_1.default)('./initializeSession', {
+                        'sync-request': requestStub,
+                        uuid: { v4: uuidStub }
+                    }).default;
+                    const invoke = fn(defaultParams);
+                    chai_1.assert.deepEqual(invoke, generatedID);
+                });
+            });
+        });
+    });
+});
+//# sourceMappingURL=initializeSession.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"initializeSession.test.js","sourceRoot":"","sources":["../../src/utils/initializeSession.test.ts"],"names":[],"mappings":";;;;;AAAA,iBAAc;AACd,+BAA6B;AAC7B,kDAAyB;AACzB,4DAAmC;AACnC,4EAE4B;AAE5B,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,SAAS,CAAC,eAAK,CAAC,OAAO,CAAC,CAAA;IAExB,MAAM,aAAa,GAA4B;QAC7C,MAAM,EAAE,KAAK;QACb,SAAS,EAAE,uBAAuB;QAClC,cAAc,EAAE,OAAO;QACvB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,IAAI;KACnB,CAAA;IAED,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;YAC3C,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBACzB,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;oBACjB,4CAA4C;oBAC5C,IAAA,2BAAiB,EAAC,EAAE,CAAC,CAAA;gBACvB,CAAC,EAAE,qBAAqB,CAAC,CAAA;YAC3B,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;YAC9C,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBACzB,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;oBACjB,+CAA+C;oBAC/C,IAAA,2BAAiB,EAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;gBACtC,CAAC,EAAE,wBAAwB,CAAC,CAAA;YAC9B,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;YACnD,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBACzB,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;oBACjB,oDAAoD;oBACpD,IAAA,2BAAiB,EAAC;wBAChB,MAAM,EAAE,KAAK;wBACb,SAAS,EAAE,uBAAuB;qBACnC,CAAC,CAAA;gBACJ,CAAC,EAAE,6BAA6B,CAAC,CAAA;YACnC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;YACnD,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBACzB,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;oBACjB,IAAA,2BAAiB,EAAC;wBAChB,GAAG,aAAa;wBAChB,sDAAsD;wBACtD,SAAS,EAAE,GAAG;qBACf,CAAC,CAAA;gBACJ,CAAC,EAAE,6BAA6B,CAAC,CAAA;YACnC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;YACjD,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBACzB,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;oBACjB,IAAA,2BAAiB,EAAC;wBAChB,GAAG,aAAa;wBAChB,oDAAoD;wBACpD,OAAO,EAAE,GAAG;qBACb,CAAC,CAAA;gBACJ,CAAC,EAAE,2BAA2B,CAAC,CAAA;YACjC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,gDAAgD,EAAE,GAAG,EAAE;YAC9D,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBACzB,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;oBACjB,IAAA,2BAAiB,EAAC;wBAChB,GAAG,aAAa;wBAChB,SAAS,EAAE,KAAK;wBAChB,OAAO,EAAE,KAAK;qBACf,CAAC,CAAA;gBACJ,CAAC,EAAE,yGAAyG,CAAC,CAAA;YAC/G,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACvD,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBACzB,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;oBACjB,IAAA,2BAAiB,EAAC;wBAChB,GAAG,aAAa;wBAChB,yDAAyD;wBACzD,YAAY,EAAE,GAAG;qBAClB,CAAC,CAAA;gBACJ,CAAC,EAAE,iCAAiC,CAAC,CAAA;YACvC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAC1D,SAAS,CAAC,eAAK,CAAC,OAAO,CAAC,CAAA;QAExB,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,qBAAqB,EAAE,CAAC,CAAA;YACrE,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,qBAAqB,EAAE;gBAC3C,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC,OAAmC,CAAA;YAEtC,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE;gBACjB,EAAE,CAAC,aAAa,CAAC,CAAA;YACnB,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,YAAY,GAAG;gBACnB,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,EAAE;gBACZ,UAAU,EAAE,KAAK;aAClB,CAAA;YACD,MAAM,WAAW,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC;gBACvC,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;aAC5C,CAAC,CAAA;YACF,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,qBAAqB,EAAE;gBAC3C,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC,OAAmC,CAAA;YAEtC,MAAM,MAAM,GAAG,EAAE,CAAC,aAAa,CAAC,CAAA;YAEhC,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAA;YACjC,aAAM,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;QAEF,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;YAC7C,MAAM,YAAY,GAAG;gBACnB,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,EAAE;aACb,CAAA;YACD,MAAM,SAAS,GAAG,KAAK,CAAA;YAEvB,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;gBAC3C,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;oBAC5B,MAAM,WAAW,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC;wBACvC,UAAU,EAAE,GAAG;wBACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;qBAC5C,CAAC,CAAA;oBACF,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,qBAAqB,EAAE;wBAC3C,cAAc,EAAE,WAAW;qBAC5B,CAAC,CAAC,OAAmC,CAAA;oBAEtC,MAAM,MAAM,GAAG,EAAE,CAAC;wBAChB,GAAG,aAAa;wBAChB,GAAG,EAAE,SAAS,EAAE;qBACjB,CAAC,CAAA;oBAEF,aAAM,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;gBACrC,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;gBACzC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;oBAChB,MAAM,WAAW,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC;wBACvC,UAAU,EAAE,GAAG;wBACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;qBAC5C,CAAC,CAAA;oBACF,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,qBAAqB,EAAE;wBAC3C,cAAc,EAAE,WAAW;qBAC5B,CAAC,CAAC,OAAmC,CAAA;oBAEtC,MAAM,OAAO,GAAG,KAAK,CAAA;oBAErB,aAAM,CAAC,MAAM,CACX,GAAG,EAAE,CACH,EAAE,CAAC;wBACD,GAAG,aAAa;wBAChB,GAAG,EAAE,OAAO,EAAE;qBACf,CAAC,EACJ,kEAAkE,CACnE,CAAA;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,oDAAoD,EAAE,GAAG,EAAE;gBAClE,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;oBAC/B,MAAM,WAAW,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC;wBACvC,UAAU,EAAE,GAAG;wBACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;qBAC5C,CAAC,CAAA;oBACF,MAAM,WAAW,GAAG,KAAK,CAAA;oBACzB,MAAM,QAAQ,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;oBAClD,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,qBAAqB,EAAE;wBAC3C,cAAc,EAAE,WAAW;wBAC3B,IAAI,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE;qBACvB,CAAC,CAAC,OAAmC,CAAA;oBAEtC,MAAM,MAAM,GAAG,EAAE,CAAC,aAAa,CAAC,CAAA;oBAEhC,aAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;gBACvC,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/utils/isValidExcludePattern.d.ts

@@ -0,0 +1,2 @@
+declare const isValidExcludePattern: (pattern: unknown[]) => void;
+export default isValidExcludePattern;

package/dist/utils/isValidExcludePattern.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const isValidExcludePattern = (pattern) => {
+    const isValid = pattern.every(p => typeof p === 'string');
+    if (!isValid) {
+        throw new Error(`Invalid exclude pattern: ${pattern}. Please refer to the minimatch usage documentation.`);
+    }
+};
+exports.default = isValidExcludePattern;
+//# sourceMappingURL=isValidExcludePattern.js.map

package/dist/utils/isValidExcludePattern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidExcludePattern.js","sourceRoot":"","sources":["../../src/utils/isValidExcludePattern.ts"],"names":[],"mappings":";;AAAA,MAAM,qBAAqB,GAAG,CAAC,OAAkB,EAAQ,EAAE;IACzD,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,4BAA4B,OAAO,sDAAsD,CAC1F,CAAA;IACH,CAAC;AACH,CAAC,CAAA;AAED,kBAAe,qBAAqB,CAAA"}

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

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

package/dist/utils/isValidExcludePattern.test.js

@@ -0,0 +1,17 @@
+"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 isValidExcludePattern_1 = __importDefault(require("./isValidExcludePattern"));
+describe('isValidExcludePattern', () => {
+    it('returns true for valid exclude patterns', () => {
+        chai_1.assert.doesNotThrow(() => (0, isValidExcludePattern_1.default)(['foo', 'bar']));
+    });
+    it('returns false for invalid exclude patterns', () => {
+        chai_1.assert.throws(() => (0, isValidExcludePattern_1.default)(['foo', 'bar', 1]));
+    });
+});
+//# sourceMappingURL=isValidExcludePattern.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isValidExcludePattern.test.js","sourceRoot":"","sources":["../../src/utils/isValidExcludePattern.test.ts"],"names":[],"mappings":";;;;;AAAA,iBAAc;AACd,+BAA6B;AAC7B,oFAA2D;AAE3D,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,aAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAA,+BAAqB,EAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,aAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+BAAqB,EAAC,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/D,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/utils/mergeChromeArgs.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A helper function to merge the user provided arguments with the extension args
+ * for Chrome.
+ *
+ * @param args The user provided arguments to merge with the extension args.
+ * @param disableOtherExtensions Whether to disable other extensions.
+ * @returns The merged arguments to pass to Chrome.
+ */
+declare function mergeChromeArgs(userArgs: string[], { disableOtherExtensions }: {
+    disableOtherExtensions: boolean;
+}): string[];
+export default mergeChromeArgs;

package/dist/utils/mergeChromeArgs.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("./constants");
+// Extension flags for Chrome
+const DISABLE_OTHER_EXTENSIONS_FLAG = '--disable-extensions-except';
+const LOAD_EXTENSION_FLAG = '--load-extension';
+/**
+ * A helper function to merge the user provided arguments with the extension args
+ * for Chrome.
+ *
+ * @param args The user provided arguments to merge with the extension args.
+ * @param disableOtherExtensions Whether to disable other extensions.
+ * @returns The merged arguments to pass to Chrome.
+ */
+function mergeChromeArgs(userArgs, { disableOtherExtensions }) {
+    /**
+     * It's possible for the user to do:
+     * `--load-extension=/path/A, --load-extension=/path/B`
+     *
+     * We only want to append our extension path onto
+     * the last occurrence of `--load-extension`.
+     */
+    let loadExtensionFlagIndex = -1;
+    let disableExtensionsFlagIndex = -1;
+    /**
+     * We do not want to modify the user's args directly.
+     * We only want to modify and merge the extension args
+     * with the user's args if they exist.
+     *
+     * It's possible for some integrations like WebDriverJS
+     * to optionally include the `--` prefix in the flag,
+     * when we check for the extension flag we need to account for this.
+     */
+    for (const [index, arg] of userArgs.entries()) {
+        if (arg.includes(LOAD_EXTENSION_FLAG) || arg.includes('load-extension')) {
+            loadExtensionFlagIndex = index;
+        }
+        if (arg.includes(DISABLE_OTHER_EXTENSIONS_FLAG) ||
+            arg.includes('disable-extensions-except')) {
+            disableExtensionsFlagIndex = index;
+        }
+    }
+    // The user has provided a `--load-extension` flag
+    // We want to append our extension path to the list of extensions.
+    if (loadExtensionFlagIndex !== -1) {
+        userArgs[loadExtensionFlagIndex] += `,${constants_1.PATH_TO_EXTENSION}`;
+    }
+    else {
+        userArgs.push(`${LOAD_EXTENSION_FLAG}=${constants_1.PATH_TO_EXTENSION}`);
+    }
+    // If the user has already disabled other extensions, we want to append
+    // our extension path to the list of disabled extensions.
+    if (disableExtensionsFlagIndex !== -1) {
+        userArgs[disableExtensionsFlagIndex] += `,${constants_1.PATH_TO_EXTENSION}`;
+        /**
+         * Puppeteer and Playwright by default include `--disable-extensions` which
+         * disables all extensions. We need to explicitly enable the axe-core/watcher
+         * extension.
+         *
+         * @see https://github.com/GoogleChrome/chrome-launcher/blob/main/docs/chrome-flags-for-tools.md#sources
+         *
+         * Cypress does not include `--disable-extensions` by default but does include
+         * their own extension outside of `--load-extension` so we do not able to disable it
+         * when injecting the axe-core/watcher extension.
+         */
+    }
+    else if (disableOtherExtensions) {
+        userArgs.push(`${DISABLE_OTHER_EXTENSIONS_FLAG}=${constants_1.PATH_TO_EXTENSION}`);
+    }
+    return userArgs;
+}
+exports.default = mergeChromeArgs;
+//# sourceMappingURL=mergeChromeArgs.js.map

package/dist/utils/mergeChromeArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeChromeArgs.js","sourceRoot":"","sources":["../../src/utils/mergeChromeArgs.ts"],"names":[],"mappings":";;AAAA,2CAA+C;AAE/C,6BAA6B;AAC7B,MAAM,6BAA6B,GAAG,6BAA6B,CAAA;AACnE,MAAM,mBAAmB,GAAG,kBAAkB,CAAA;AAE9C;;;;;;;GAOG;AAEH,SAAS,eAAe,CACtB,QAAkB,EAClB,EACE,sBAAsB,EAGvB;IAED;;;;;;OAMG;IACH,IAAI,sBAAsB,GAAG,CAAC,CAAC,CAAA;IAC/B,IAAI,0BAA0B,GAAG,CAAC,CAAC,CAAA;IAEnC;;;;;;;;OAQG;IACH,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,IAAI,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACxE,sBAAsB,GAAG,KAAK,CAAA;QAChC,CAAC;QAED,IACE,GAAG,CAAC,QAAQ,CAAC,6BAA6B,CAAC;YAC3C,GAAG,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EACzC,CAAC;YACD,0BAA0B,GAAG,KAAK,CAAA;QACpC,CAAC;IACH,CAAC;IAED,kDAAkD;IAClD,kEAAkE;IAClE,IAAI,sBAAsB,KAAK,CAAC,CAAC,EAAE,CAAC;QAClC,QAAQ,CAAC,sBAAsB,CAAC,IAAI,IAAI,6BAAiB,EAAE,CAAA;IAC7D,CAAC;SAAM,CAAC;QACN,QAAQ,CAAC,IAAI,CAAC,GAAG,mBAAmB,IAAI,6BAAiB,EAAE,CAAC,CAAA;IAC9D,CAAC;IAED,uEAAuE;IACvE,yDAAyD;IACzD,IAAI,0BAA0B,KAAK,CAAC,CAAC,EAAE,CAAC;QACtC,QAAQ,CAAC,0BAA0B,CAAC,IAAI,IAAI,6BAAiB,EAAE,CAAA;QAE/D;;;;;;;;;;WAUG;IACL,CAAC;SAAM,IAAI,sBAAsB,EAAE,CAAC;QAClC,QAAQ,CAAC,IAAI,CAAC,GAAG,6BAA6B,IAAI,6BAAiB,EAAE,CAAC,CAAA;IACxE,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,kBAAe,eAAe,CAAA"}

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

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