@axe-core/watcher 2.3.0-next.9a72df74 → 2.3.0-next.ab05958f
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 +7 -3
- package/dist/util.js +22 -6
- package/dist/util.js.map +1 -1
- package/extension/background.js +1 -1
- package/extension/content.js +1 -1
- package/package.json +1 -1
- package/dist/validateApiKey.d.ts +0 -7
- package/dist/validateApiKey.js +0 -25
- package/dist/validateApiKey.js.map +0 -1
package/dist/util.d.ts
CHANGED
|
@@ -22,8 +22,6 @@ 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;
|
|
27
25
|
}
|
|
28
26
|
export interface Configuration {
|
|
29
27
|
axe: AxeConfiguration;
|
|
@@ -50,7 +48,13 @@ export interface Variables {
|
|
|
50
48
|
git_is_dirty?: boolean;
|
|
51
49
|
}
|
|
52
50
|
/** Write the user's settings to the disk, so the extension can load them. */
|
|
53
|
-
export declare function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, takeScreenshots
|
|
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;
|
|
54
58
|
interface WriteManifestParams {
|
|
55
59
|
all_frames: boolean;
|
|
56
60
|
exclude_globs: string[];
|
package/dist/util.js
CHANGED
|
@@ -35,13 +35,14 @@ 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.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;
|
|
38
|
+
exports.wrappedCallWithSideEffects = exports.markAsWrapped = exports.isWrapped = exports.updateAutoAnalyze = exports.writeManifest = exports.validateApiKey = 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"));
|
|
40
42
|
const fs_1 = __importDefault(require("fs"));
|
|
41
43
|
const path_1 = __importDefault(require("path"));
|
|
42
44
|
const os_1 = __importDefault(require("os"));
|
|
43
45
|
const git = __importStar(require("./git"));
|
|
44
|
-
const validateApiKey_1 = __importDefault(require("./validateApiKey"));
|
|
45
46
|
exports.PATH_TO_EXTENSION = path_1.default.join(__dirname, '..', 'extension');
|
|
46
47
|
exports.DEFAULT_SERVER_URL = 'https://axe.deque.com/';
|
|
47
48
|
exports.PATH_TO_SESSION_FILE = path_1.default.join(os_1.default.tmpdir(), 'axe-watcher-session.json');
|
|
@@ -58,7 +59,7 @@ class HeadlessNotSupportedError extends Error {
|
|
|
58
59
|
}
|
|
59
60
|
exports.HeadlessNotSupportedError = HeadlessNotSupportedError;
|
|
60
61
|
/** Write the user's settings to the disk, so the extension can load them. */
|
|
61
|
-
function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, takeScreenshots
|
|
62
|
+
function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, takeScreenshots }) {
|
|
62
63
|
if (!serverURL) {
|
|
63
64
|
serverURL = exports.DEFAULT_SERVER_URL;
|
|
64
65
|
}
|
|
@@ -69,9 +70,7 @@ function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, ta
|
|
|
69
70
|
catch (err) {
|
|
70
71
|
throw new Error(`Error when converting serverURL to URL. Ensure it is formatted properly: ${err}`);
|
|
71
72
|
}
|
|
72
|
-
|
|
73
|
-
(0, validateApiKey_1.default)({ apiKey, serverURL: urlString });
|
|
74
|
-
}
|
|
73
|
+
(0, exports.validateApiKey)({ apiKey, serverURL: urlString });
|
|
75
74
|
if (typeof autoAnalyze === 'undefined') {
|
|
76
75
|
autoAnalyze = true;
|
|
77
76
|
}
|
|
@@ -111,6 +110,23 @@ function writeVariables({ apiKey, serverURL, sessionId, autoAnalyze, cypress, ta
|
|
|
111
110
|
fs_1.default.writeFileSync(exports.PATH_TO_EXTENSION_VARIABLES, JSON.stringify(variables));
|
|
112
111
|
}
|
|
113
112
|
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;
|
|
114
130
|
/** Update the extension manifest file. */
|
|
115
131
|
function writeManifest({ all_frames, exclude_globs }) {
|
|
116
132
|
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,4CAAmB;AACnB,gDAAuB;AACvB,4CAAmB;AACnB,2CAA4B;
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAAiC;AACjC,gEAAkC;AAClC,oDAA2B;AAC3B,4CAAmB;AACnB,gDAAuB;AACvB,4CAAmB;AACnB,2CAA4B;AAGf,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;AA6CD,6EAA6E;AAC7E,SAAgB,cAAc,CAAC,EAC7B,MAAM,EACN,SAAS,EACT,SAAS,EACT,WAAW,EACX,OAAO,EACP,eAAe,EACM;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,IAAA,sBAAc,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAA;IAEhD,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;AA/DD,wCA+DC;AAOD,mGAAmG;AAC5F,MAAM,cAAc,GAAG,CAAC,EAC7B,MAAM,EACN,SAAS,EACY,EAAQ,EAAE;IAC/B,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;AApBY,QAAA,cAAc,kBAoB1B;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"}
|