@axe-core/watcher 1.1.0 → 1.2.0-next.fa8ad6b6
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/README.md +1 -1
- package/dist/util.d.ts +4 -1
- package/dist/util.js +5 -1
- package/dist/util.js.map +1 -1
- package/dist/validateApiKey.d.ts +7 -0
- package/dist/validateApiKey.js +24 -0
- package/dist/validateApiKey.js.map +1 -0
- package/extension/content.js +1 -1
- package/extension/manifest.json +2 -1
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# axe
|
|
1
|
+
# axe® Watcher
|
|
2
2
|
|
|
3
3
|
Using this module requires an account on the [axe Developer Hub](https://axe.deque.com/axe-watcher/projects). In order to get a trial account, please [contact Deque](https://www.deque.com/company/contact/). For information on how to use this module, please follow the instructions on the [axe Developer Hub](https://axe.deque.com/axe-watcher/projects) projects page.
|
|
4
4
|
|
package/dist/util.d.ts
CHANGED
|
@@ -23,6 +23,8 @@ export interface Configuration {
|
|
|
23
23
|
autoAnalyze?: boolean;
|
|
24
24
|
/** Increase / decrease the debounce timeout (ms) between DOM mutations */
|
|
25
25
|
debounceTimeout?: number;
|
|
26
|
+
/** Should the API key be validated before use? Default `true`. */
|
|
27
|
+
validateApiKey?: boolean;
|
|
26
28
|
};
|
|
27
29
|
}
|
|
28
30
|
interface WriteVariablesParams {
|
|
@@ -32,6 +34,7 @@ interface WriteVariablesParams {
|
|
|
32
34
|
autoAnalyze?: boolean;
|
|
33
35
|
debounceTimeout?: number;
|
|
34
36
|
cypress?: boolean;
|
|
37
|
+
validateApiKey?: boolean;
|
|
35
38
|
}
|
|
36
39
|
/** variables.json shape. */
|
|
37
40
|
export interface Variables {
|
|
@@ -51,7 +54,7 @@ export interface Variables {
|
|
|
51
54
|
git_is_dirty?: boolean;
|
|
52
55
|
}
|
|
53
56
|
/** Write the user's settings to the disk, so the extension can load them. */
|
|
54
|
-
export declare function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, debounceTimeout, cypress }: WriteVariablesParams): void;
|
|
57
|
+
export declare function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, debounceTimeout, cypress, validateApiKey: shouldValidateApiKey }: WriteVariablesParams): void;
|
|
55
58
|
interface WriteManifestParams {
|
|
56
59
|
all_frames: boolean;
|
|
57
60
|
exclude_globs: string[];
|
package/dist/util.js
CHANGED
|
@@ -46,6 +46,7 @@ var fs_1 = __importDefault(require("fs"));
|
|
|
46
46
|
var path_1 = __importDefault(require("path"));
|
|
47
47
|
var os_1 = __importDefault(require("os"));
|
|
48
48
|
var git = __importStar(require("./git"));
|
|
49
|
+
var validateApiKey_1 = __importDefault(require("./validateApiKey"));
|
|
49
50
|
exports.PATH_TO_EXTENSION = path_1.default.join(__dirname, '..', 'extension');
|
|
50
51
|
exports.DEFAULT_SERVER_URL = 'https://axe.deque.com/';
|
|
51
52
|
exports.PATH_TO_SESSION_FILE = path_1.default.join(os_1.default.tmpdir(), 'axe-watcher-session.json');
|
|
@@ -67,7 +68,7 @@ var HeadlessNotSupportedError = /** @class */ (function (_super) {
|
|
|
67
68
|
exports.HeadlessNotSupportedError = HeadlessNotSupportedError;
|
|
68
69
|
/** Write the user's settings to the disk, so the extension can load them. */
|
|
69
70
|
function writeVariables(_a) {
|
|
70
|
-
var apiKey = _a.apiKey, serverURL = _a.serverURL, sessionId = _a.sessionId, autoAnalyze = _a.autoAnalyze, debounceTimeout = _a.debounceTimeout, cypress = _a.cypress;
|
|
71
|
+
var apiKey = _a.apiKey, serverURL = _a.serverURL, sessionId = _a.sessionId, autoAnalyze = _a.autoAnalyze, debounceTimeout = _a.debounceTimeout, cypress = _a.cypress, _b = _a.validateApiKey, shouldValidateApiKey = _b === void 0 ? true : _b;
|
|
71
72
|
if (!serverURL) {
|
|
72
73
|
serverURL = exports.DEFAULT_SERVER_URL;
|
|
73
74
|
}
|
|
@@ -78,6 +79,9 @@ function writeVariables(_a) {
|
|
|
78
79
|
catch (err) {
|
|
79
80
|
throw new Error("Error when converting serverURL to URL. Ensure it is formatted properly: ".concat(err));
|
|
80
81
|
}
|
|
82
|
+
if (shouldValidateApiKey) {
|
|
83
|
+
(0, validateApiKey_1.default)({ apiKey: apiKey, serverURL: urlString });
|
|
84
|
+
}
|
|
81
85
|
if (typeof autoAnalyze === 'undefined') {
|
|
82
86
|
autoAnalyze = true;
|
|
83
87
|
}
|
package/dist/util.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAAmB;AACnB,8CAAuB;AACvB,0CAAmB;AACnB,yCAA4B;
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAAmB;AACnB,8CAAuB;AACvB,0CAAmB;AACnB,yCAA4B;AAC5B,oEAA6C;AAEhC,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;AACY,QAAA,wBAAwB,GAAG,GAAG,CAAA;AAE9B,QAAA,aAAa,GAAG;IAC3B,sCAA+B,yBAAiB,CAAE;IAClD,2BAAoB,yBAAiB,CAAE;CAC/B,CAAA;AAEV;IAA+C,6CAAK;IAGlD;QAAA,YACE,kBAAM,sCAAsC,CAAC,SAC9C;QAJM,UAAI,GAAG,2BAA2B,CAAA;;IAIzC,CAAC;IACH,gCAAC;AAAD,CAAC,AAND,CAA+C,KAAK,GAMnD;AANY,8DAAyB;AAwDtC,6EAA6E;AAC7E,SAAgB,cAAc,CAAC,EAQR;QAPrB,MAAM,YAAA,EACN,SAAS,eAAA,EACT,SAAS,eAAA,EACT,WAAW,iBAAA,EACX,eAAe,qBAAA,EACf,OAAO,aAAA,EACP,sBAA2C,EAA3B,oBAAoB,mBAAG,IAAI,KAAA;IAE3C,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,mFAA4E,GAAG,CAAE,CAClF,CAAA;KACF;IAED,IAAI,oBAAoB,EAAE;QACxB,IAAA,wBAAc,EAAC,EAAE,MAAM,QAAA,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAA;KACjD;IAED,IAAI,OAAO,WAAW,KAAK,WAAW,EAAE;QACtC,WAAW,GAAG,IAAI,CAAA;KACnB;IAED,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE;QAC1C,eAAe,GAAG,gCAAwB,CAAA;KAC3C;IAED,oFAAoF;IACpF,uFAAuF;IACvF,IAAI,CAAC,SAAS,IAAI,YAAE,CAAC,UAAU,CAAC,4BAAoB,CAAC,EAAE;QACrD,IAAI;YACF,IAAM,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,gDAAyC,KAAK,CAAE,CAAC,CAAA;SAClE;KACF;IAED,IAAM,SAAS,GAAc;QAC3B,OAAO,EAAE,MAAM;QACf,UAAU,EAAE,SAAS;QACrB,UAAU,EAAE,SAAS;QACrB,YAAY,EAAE,CAAC,CAAC,WAAW;QAC3B,gBAAgB,EAAE,eAAe;QACjC,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,kBAAkB,GAAG,GAAG,CAAC,oBAAoB,EAAE,CAAA;QACzD,IAAM,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;AApED,wCAoEC;AAOD,0CAA0C;AAC1C,SAAgB,aAAa,CAAC,EAGR;QAFpB,UAAU,gBAAA,EACV,aAAa,mBAAA;IAEb,IAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,yBAAiB,EAAE,eAAe,CAAC,CAAA;IAClE,IAAM,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"}
|
|
@@ -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,24 @@
|
|
|
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
|
+
var sync_request_1 = __importDefault(require("sync-request"));
|
|
7
|
+
/** Validate the given `apiKey`. This method is blocking and should not be called unnecessarily. */
|
|
8
|
+
var validateApiKey = function (_a) {
|
|
9
|
+
var apiKey = _a.apiKey, serverURL = _a.serverURL;
|
|
10
|
+
var url = new URL("/api/api-keys/".concat(apiKey, "/validate/axe-devtools-watcher"), serverURL);
|
|
11
|
+
var res = (0, sync_request_1.default)('GET', url.toString(), {
|
|
12
|
+
maxRedirects: 2,
|
|
13
|
+
followRedirects: true,
|
|
14
|
+
maxRetries: 2,
|
|
15
|
+
retry: true,
|
|
16
|
+
retryDelay: 100
|
|
17
|
+
});
|
|
18
|
+
var body = JSON.parse(res.getBody('utf8'));
|
|
19
|
+
if (body.error) {
|
|
20
|
+
throw new Error(body.error);
|
|
21
|
+
}
|
|
22
|
+
};
|
|
23
|
+
exports.default = validateApiKey;
|
|
24
|
+
//# sourceMappingURL=validateApiKey.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validateApiKey.js","sourceRoot":"","sources":["../src/validateApiKey.ts"],"names":[],"mappings":";;;;;AAAA,8DAAkC;AAOlC,mGAAmG;AACnG,IAAM,cAAc,GAAG,UAAC,EAA6B;QAA3B,MAAM,YAAA,EAAE,SAAS,eAAA;IACzC,IAAM,GAAG,GAAG,IAAI,GAAG,CACjB,wBAAiB,MAAM,mCAAgC,EACvD,SAAS,CACV,CAAA;IACD,IAAM,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,IAAM,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"}
|