@axe-core/watcher 2.3.0-next.6b0a8481 → 2.3.0-next.6b912a21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/util.d.ts +3 -7
- package/dist/util.js +6 -22
- package/dist/util.js.map +1 -1
- package/dist/validateApiKey.d.ts +7 -0
- package/dist/validateApiKey.js +25 -0
- package/dist/validateApiKey.js.map +1 -0
- package/extension/background.js +1 -1
- package/extension/content.js +1 -1
- package/package.json +1 -1
package/dist/util.d.ts
CHANGED
|
@@ -22,6 +22,8 @@ interface AxeConfiguration {
|
|
|
22
22
|
* when changes are made.
|
|
23
23
|
*/
|
|
24
24
|
autoAnalyze?: boolean;
|
|
25
|
+
/** Should the API key be validated before use? Default `true`. */
|
|
26
|
+
validateApiKey?: boolean;
|
|
25
27
|
}
|
|
26
28
|
export interface Configuration {
|
|
27
29
|
axe: AxeConfiguration;
|
|
@@ -48,13 +50,7 @@ export interface Variables {
|
|
|
48
50
|
git_is_dirty?: boolean;
|
|
49
51
|
}
|
|
50
52
|
/** Write the user's settings to the disk, so the extension can load them. */
|
|
51
|
-
export declare function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, takeScreenshots }: WriteVariablesParams): void;
|
|
52
|
-
interface ValidateApiKeyParams {
|
|
53
|
-
apiKey: string;
|
|
54
|
-
serverURL: string;
|
|
55
|
-
}
|
|
56
|
-
/** Validate the given `apiKey`. This method is blocking and should not be called unnecessarily. */
|
|
57
|
-
export declare const validateApiKey: ({ apiKey, serverURL }: ValidateApiKeyParams) => void;
|
|
53
|
+
export declare function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, takeScreenshots, validateApiKey: shouldValidateApiKey }: WriteVariablesParams): void;
|
|
58
54
|
interface WriteManifestParams {
|
|
59
55
|
all_frames: boolean;
|
|
60
56
|
exclude_globs: string[];
|
package/dist/util.js
CHANGED
|
@@ -35,14 +35,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
35
35
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
36
36
|
};
|
|
37
37
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
38
|
-
exports.wrappedCallWithSideEffects = exports.markAsWrapped = exports.isWrapped = exports.updateAutoAnalyze = exports.writeManifest = exports.
|
|
38
|
+
exports.wrappedCallWithSideEffects = exports.markAsWrapped = exports.isWrapped = exports.updateAutoAnalyze = exports.writeManifest = exports.writeVariables = exports.HeadlessNotSupportedError = exports.extensionArgs = exports.PATH_TO_EXTENSION_VARIABLES = exports.PATH_TO_SESSION_FILE = exports.DEFAULT_SERVER_URL = exports.PATH_TO_EXTENSION = void 0;
|
|
39
39
|
const uuid_1 = require("uuid");
|
|
40
|
-
const sync_request_1 = __importDefault(require("sync-request"));
|
|
41
|
-
const assert_1 = __importDefault(require("assert"));
|
|
42
40
|
const fs_1 = __importDefault(require("fs"));
|
|
43
41
|
const path_1 = __importDefault(require("path"));
|
|
44
42
|
const os_1 = __importDefault(require("os"));
|
|
45
43
|
const git = __importStar(require("./git"));
|
|
44
|
+
const validateApiKey_1 = __importDefault(require("./validateApiKey"));
|
|
46
45
|
exports.PATH_TO_EXTENSION = path_1.default.join(__dirname, '..', 'extension');
|
|
47
46
|
exports.DEFAULT_SERVER_URL = 'https://axe.deque.com/';
|
|
48
47
|
exports.PATH_TO_SESSION_FILE = path_1.default.join(os_1.default.tmpdir(), 'axe-watcher-session.json');
|
|
@@ -59,7 +58,7 @@ class HeadlessNotSupportedError extends Error {
|
|
|
59
58
|
}
|
|
60
59
|
exports.HeadlessNotSupportedError = HeadlessNotSupportedError;
|
|
61
60
|
/** Write the user's settings to the disk, so the extension can load them. */
|
|
62
|
-
function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, takeScreenshots }) {
|
|
61
|
+
function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, takeScreenshots, validateApiKey: shouldValidateApiKey = true }) {
|
|
63
62
|
if (!serverURL) {
|
|
64
63
|
serverURL = exports.DEFAULT_SERVER_URL;
|
|
65
64
|
}
|
|
@@ -70,7 +69,9 @@ function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, ta
|
|
|
70
69
|
catch (err) {
|
|
71
70
|
throw new Error(`Error when converting serverURL to URL. Ensure it is formatted properly: ${err}`);
|
|
72
71
|
}
|
|
73
|
-
(
|
|
72
|
+
if (shouldValidateApiKey) {
|
|
73
|
+
(0, validateApiKey_1.default)({ apiKey, serverURL: urlString });
|
|
74
|
+
}
|
|
74
75
|
if (typeof autoAnalyze === 'undefined') {
|
|
75
76
|
autoAnalyze = true;
|
|
76
77
|
}
|
|
@@ -110,23 +111,6 @@ function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, ta
|
|
|
110
111
|
fs_1.default.writeFileSync(exports.PATH_TO_EXTENSION_VARIABLES, JSON.stringify(variables));
|
|
111
112
|
}
|
|
112
113
|
exports.writeVariables = writeVariables;
|
|
113
|
-
/** Validate the given `apiKey`. This method is blocking and should not be called unnecessarily. */
|
|
114
|
-
const validateApiKey = ({ apiKey, serverURL }) => {
|
|
115
|
-
(0, assert_1.default)(apiKey, 'API key is required');
|
|
116
|
-
const url = new URL(`/api/api-keys/${apiKey}/validate/axe-devtools-watcher`, serverURL);
|
|
117
|
-
const res = (0, sync_request_1.default)('GET', url.toString(), {
|
|
118
|
-
maxRedirects: 2,
|
|
119
|
-
followRedirects: true,
|
|
120
|
-
maxRetries: 2,
|
|
121
|
-
retry: true,
|
|
122
|
-
retryDelay: 100
|
|
123
|
-
});
|
|
124
|
-
const body = JSON.parse(res.getBody('utf8'));
|
|
125
|
-
if (body.error) {
|
|
126
|
-
throw new Error(body.error);
|
|
127
|
-
}
|
|
128
|
-
};
|
|
129
|
-
exports.validateApiKey = validateApiKey;
|
|
130
114
|
/** Update the extension manifest file. */
|
|
131
115
|
function writeManifest({ all_frames, exclude_globs }) {
|
|
132
116
|
const manifestPath = path_1.default.join(exports.PATH_TO_EXTENSION, 'manifest.json');
|
package/dist/util.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAAiC;AACjC,
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAAiC;AACjC,4CAAmB;AACnB,gDAAuB;AACvB,4CAAmB;AACnB,2CAA4B;AAC5B,sEAA6C;AAGhC,QAAA,iBAAiB,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAA;AAC3D,QAAA,kBAAkB,GAAG,wBAAwB,CAAA;AAC7C,QAAA,oBAAoB,GAAG,cAAI,CAAC,IAAI,CAC3C,YAAE,CAAC,MAAM,EAAE,EACX,0BAA0B,CAC3B,CAAA;AACY,QAAA,2BAA2B,GAAG,cAAI,CAAC,IAAI,CAClD,yBAAiB,EACjB,gBAAgB,CACjB,CAAA;AAEY,QAAA,aAAa,GAAG;IAC3B,+BAA+B,yBAAiB,EAAE;IAClD,oBAAoB,yBAAiB,EAAE;CAC/B,CAAA;AAEV,MAAa,yBAA0B,SAAQ,KAAK;IAGlD;QACE,KAAK,CAAC,sCAAsC,CAAC,CAAA;QAHxC,SAAI,GAAG,2BAA2B,CAAA;IAIzC,CAAC;CACF;AAND,8DAMC;AA+CD,6EAA6E;AAC7E,SAAgB,cAAc,CAAC,EAC7B,MAAM,EACN,SAAS,EACT,SAAS,EACT,WAAW,EACX,OAAO,EACP,eAAe,EACf,cAAc,EAAE,oBAAoB,GAAG,IAAI,EACtB;IACrB,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,0BAAkB,CAAA;KAC/B;IAED,IAAI,SAAS,CAAA;IACb,IAAI;QACF,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAA;KAC1C;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,KAAK,CACb,4EAA4E,GAAG,EAAE,CAClF,CAAA;KACF;IAED,IAAI,oBAAoB,EAAE;QACxB,IAAA,wBAAc,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAA;KACjD;IAED,IAAI,OAAO,WAAW,KAAK,WAAW,EAAE;QACtC,WAAW,GAAG,IAAI,CAAA;KACnB;IAED,oFAAoF;IACpF,uFAAuF;IACvF,IAAI,CAAC,SAAS,IAAI,YAAE,CAAC,UAAU,CAAC,4BAAoB,CAAC,EAAE;QACrD,IAAI;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,4BAAoB,EAAE,MAAM,CAAC,CAAC,CAAA;YACtE,SAAS,GAAG,IAAI,CAAC,EAAY,CAAA;SAC9B;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,yCAAyC,KAAK,EAAE,CAAC,CAAA;SAClE;KACF;IAED,MAAM,SAAS,GAAc;QAC3B,OAAO,EAAE,MAAM;QACf,UAAU,EAAE,SAAS;QACrB,uFAAuF;QACvF,UAAU,EAAE,SAAS,IAAI,IAAA,SAAI,GAAE;QAC/B,gBAAgB,EAAE,CAAC,CAAC,eAAe;QACnC,YAAY,EAAE,CAAC,CAAC,WAAW;QAC3B,OAAO,EAAE,CAAC,CAAC,OAAO;KACnB,CAAA;IAED,wEAAwE;IACxE,IAAI,GAAG,CAAC,YAAY,EAAE,EAAE;QACtB,SAAS,CAAC,UAAU,GAAG,GAAG,CAAC,aAAa,EAAE,CAAA;QAC1C,SAAS,CAAC,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE,CAAA;QAChC,SAAS,CAAC,kBAAkB,GAAG,GAAG,CAAC,oBAAoB,EAAE,CAAA;QACzD,MAAM,IAAI,GAAG,GAAG,CAAC,aAAa,EAAE,CAAA;QAChC,SAAS,CAAC,cAAc,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA;QACrC,SAAS,CAAC,iBAAiB,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAA;QAC1C,SAAS,CAAC,gBAAgB,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,CAAA;QACxC,SAAS,CAAC,kBAAkB,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAA;QAC5C,SAAS,CAAC,OAAO,GAAG,GAAG,CAAC,YAAY,EAAE,CAAA;QACtC,SAAS,CAAC,YAAY,GAAG,GAAG,CAAC,OAAO,EAAE,CAAA;KACvC;IAED,YAAE,CAAC,aAAa,CAAC,mCAA2B,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAA;AAC1E,CAAC;AAlED,wCAkEC;AAOD,0CAA0C;AAC1C,SAAgB,aAAa,CAAC,EAC5B,UAAU,EACV,aAAa,EACO;IACpB,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,yBAAiB,EAAE,eAAe,CAAC,CAAA;IAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAA;IACnE,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,UAAU,CAAA;IACnD,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,aAAa,CAAA;IACzD,YAAE,CAAC,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;AACnE,CAAC;AATD,sCASC;AAEM,MAAM,iBAAiB,GAAG,CAAC,GAAY,EAAQ,EAAE;IACtD,MAAM,YAAY,GAAG,YAAE,CAAC,YAAY,CAAC,mCAA2B,EAAE,OAAO,CAAC,CAAA;IAC1E,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;IAC1C,SAAS,CAAC,YAAY,GAAG,GAAG,CAAA;IAC5B,YAAE,CAAC,aAAa,CAAC,mCAA2B,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAA;AAC1E,CAAC,CAAA;AALY,QAAA,iBAAiB,qBAK7B;AAED,MAAM,QAAQ,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAA;AAM9C,mCAAmC;AAC5B,MAAM,SAAS,GAAG,CAAI,CAAqB,EAAW,EAAE;IAC7D,IAAI,CAAC,CAAC,EAAE;QACN,OAAO,KAAK,CAAA;KACb;IACD,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAA;AAC7B,CAAC,CAAA;AALY,QAAA,SAAS,aAKrB;AAED,wCAAwC;AACjC,MAAM,aAAa,GAAG,CAAC,CAAU,EAAQ,EAAE;IAChD,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE;QACjC,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,KAAK;QACjB,KAAK,EAAE,IAAI;KACZ,CAAC,CAAA;AACJ,CAAC,CAAA;AANY,QAAA,aAAa,iBAMzB;AAEM,MAAM,0BAA0B,GACrC,CAAC,MAAe,EAAE,IAAY,EAAE,UAAsB,EAAE,EAAE,CAC1D,CAAO,GAAG,IAAe,EAAoB,EAAE;IAC7C,wCAAwC;IACxC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IAC1C,MAAM,UAAU,CAAC,OAAO,EAAE,CAAA;IAC1B,OAAO,MAAM,CAAA;AACf,CAAC,CAAA,CAAA;AAPU,QAAA,0BAA0B,8BAOpC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
interface Params {
|
|
2
|
+
apiKey: string;
|
|
3
|
+
serverURL: string;
|
|
4
|
+
}
|
|
5
|
+
/** Validate the given `apiKey`. This method is blocking and should not be called unnecessarily. */
|
|
6
|
+
declare const validateApiKey: ({ apiKey, serverURL }: Params) => void;
|
|
7
|
+
export default validateApiKey;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const sync_request_1 = __importDefault(require("sync-request"));
|
|
7
|
+
const assert_1 = __importDefault(require("assert"));
|
|
8
|
+
/** Validate the given `apiKey`. This method is blocking and should not be called unnecessarily. */
|
|
9
|
+
const validateApiKey = ({ apiKey, serverURL }) => {
|
|
10
|
+
(0, assert_1.default)(apiKey, 'API key is required');
|
|
11
|
+
const url = new URL(`/api/api-keys/${apiKey}/validate/axe-devtools-watcher`, serverURL);
|
|
12
|
+
const res = (0, sync_request_1.default)('GET', url.toString(), {
|
|
13
|
+
maxRedirects: 2,
|
|
14
|
+
followRedirects: true,
|
|
15
|
+
maxRetries: 2,
|
|
16
|
+
retry: true,
|
|
17
|
+
retryDelay: 100
|
|
18
|
+
});
|
|
19
|
+
const body = JSON.parse(res.getBody('utf8'));
|
|
20
|
+
if (body.error) {
|
|
21
|
+
throw new Error(body.error);
|
|
22
|
+
}
|
|
23
|
+
};
|
|
24
|
+
exports.default = validateApiKey;
|
|
25
|
+
//# sourceMappingURL=validateApiKey.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validateApiKey.js","sourceRoot":"","sources":["../src/validateApiKey.ts"],"names":[],"mappings":";;;;;AAAA,gEAAkC;AAClC,oDAA2B;AAO3B,mGAAmG;AACnG,MAAM,cAAc,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,EAAU,EAAQ,EAAE;IAC7D,IAAA,gBAAM,EAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IACrC,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,iBAAiB,MAAM,gCAAgC,EACvD,SAAS,CACV,CAAA;IACD,MAAM,GAAG,GAAG,IAAA,sBAAO,EAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE;QACzC,YAAY,EAAE,CAAC;QACf,eAAe,EAAE,IAAI;QACrB,UAAU,EAAE,CAAC;QACb,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,GAAG;KAChB,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;IAC5C,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;KAC5B;AACH,CAAC,CAAA;AAED,kBAAe,cAAc,CAAA"}
|