accessibility-checker 3.1.0 → 3.1.4

package/lib/ACEngineManager.js

@@ -0,0 +1,220 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACEngineManager = void 0;
+var ACConfigManager_1 = require("./ACConfigManager");
+var request = require("request");
+var path = require("path");
+var fs = require("fs");
+var ace;
+var checker;
+var ACEngineManager = /** @class */ (function () {
+    function ACEngineManager() {
+    }
+    ACEngineManager.loadEngine = function (content) {
+        return __awaiter(this, void 0, void 0, function () {
+            var config, page, browser, scriptStr, manage;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, ACConfigManager_1.ACConfigManager.getConfigUnsupported()];
+                    case 1:
+                        config = _a.sent();
+                        if (!(ACEngineManager.isPuppeteer(content) || ACEngineManager.isPlaywright(content))) return [3 /*break*/, 3];
+                        config.DEBUG && console.log("[INFO] aChecker.loadEngine detected Puppeteer/Playwright");
+                        page = content;
+                        return [4 /*yield*/, page.evaluate(function (scriptUrl) {
+                                try {
+                                    if ('undefined' === typeof (ace)) {
+                                        return new Promise(function (resolve, reject) {
+                                            var script = document.createElement('script');
+                                            script.setAttribute('type', 'text/javascript');
+                                            script.setAttribute('aChecker', 'ACE');
+                                            script.setAttribute('src', scriptUrl);
+                                            script.addEventListener('load', function () {
+                                                resolve();
+                                            });
+                                            var heads = document.getElementsByTagName('head');
+                                            if (heads.length > 0) {
+                                                heads[0].appendChild(script);
+                                            }
+                                            else if (document.body) {
+                                                document.body.appendChild(script);
+                                            }
+                                            else {
+                                                Promise.reject("Invalid document");
+                                            }
+                                        });
+                                    }
+                                }
+                                catch (e) {
+                                    return Promise.reject(e);
+                                }
+                            }, config.ruleServer + "/archives/" + config.ruleArchive + "/js/ace.js")];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/, ACEngineManager.loadEngineLocal()];
+                    case 3:
+                        if (ACEngineManager.isSelenium(content)) {
+                            config.DEBUG && console.log("[INFO] aChecker.loadEngine detected Selenium");
+                            try {
+                                browser = content;
+                                scriptStr = "let cb = arguments[arguments.length - 1];\ntry {\n    if ('undefined' === typeof(ace)) {\n        let script = document.createElement('script');\n        script.setAttribute('type', 'text/javascript');\n        script.setAttribute('aChecker', 'ACE');\n        script.setAttribute('src', '" + config.ruleServer + "/archives/" + config.ruleArchive + "/js/ace.js');\n        script.addEventListener('load', function() {\n            cb();\n        });\n        let heads = document.getElementsByTagName('head');\n        if (heads.length > 0) { heads[0].appendChild(script); }\n        else { document.body.appendChild(script); }\n    } else {\n        cb();\n    }\n} catch (e) {\n    cb(e);\n}\n";
+                                manage = browser.manage();
+                                if (manage.timeouts) {
+                                    manage.timeouts().setScriptTimeout(60000);
+                                }
+                                else if (manage.setTimeouts) {
+                                    manage.setTimeouts({
+                                        "script": 60000
+                                    });
+                                }
+                                return [2 /*return*/, browser.executeAsyncScript(scriptStr).then(function (return_success) {
+                                        return ACEngineManager.loadEngineLocal();
+                                    }).catch(function (err) {
+                                        console.log(err);
+                                    })];
+                            }
+                            catch (e) {
+                                console.log(e);
+                            }
+                        }
+                        else {
+                            config.DEBUG && console.log("[INFO] aChecker.loadEngine detected local");
+                            if (ace) {
+                                return [2 /*return*/, Promise.resolve()];
+                            }
+                            else {
+                                return [2 /*return*/, ACEngineManager.loadEngineLocal()];
+                            }
+                        }
+                        _a.label = 4;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ACEngineManager.loadEngineLocal = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var config;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (ace) {
+                            return [2 /*return*/, Promise.resolve()];
+                        }
+                        return [4 /*yield*/, ACConfigManager_1.ACConfigManager.getConfigUnsupported()];
+                    case 1:
+                        config = _a.sent();
+                        return [2 /*return*/, new Promise(function (resolve, reject) {
+                                request.get(config.ruleServer + "/archives/" + config.ruleArchive + "/js/ace-node.js", function (err, data) {
+                                    if (!data) {
+                                        console.log("Cannot read: " + (config.ruleServer + "/archives/" + config.ruleArchive + "/js/ace.js"));
+                                    }
+                                    data = data.body;
+                                    var engineDir = path.join(__dirname, "engine");
+                                    if (!fs.existsSync(engineDir)) {
+                                        fs.mkdirSync(engineDir);
+                                    }
+                                    var cacheDir = path.join(engineDir, "cache");
+                                    if (!fs.existsSync(cacheDir)) {
+                                        fs.mkdirSync(cacheDir);
+                                    }
+                                    fs.writeFile(path.join(engineDir, "ace-node.js"), data, function (err) {
+                                        try {
+                                            err && console.log(err);
+                                            ace = require("./engine/ace-node");
+                                            checker = new ace.Checker();
+                                        }
+                                        catch (e) {
+                                            console.log(e);
+                                            return reject(e);
+                                        }
+                                        resolve();
+                                    });
+                                });
+                            })];
+                }
+            });
+        });
+    };
+    ACEngineManager.isPuppeteer = function (content) {
+        if (content && content.constructor) {
+            return content.constructor.toString().includes("Puppeteer");
+        }
+        return false;
+    };
+    ACEngineManager.isPlaywright = function (content) {
+        if (content && content.constructor) {
+            return content.constructor.toString().includes("Page");
+        }
+        return false;
+    };
+    ACEngineManager.isSelenium = function (content) {
+        if (content && content.constructor) {
+            return content.constructor.toString().indexOf("Driver") !== -1 ||
+                // check required for selenium >= 3.0.1
+                (content.constructor.name && content.constructor.name.indexOf("Driver") !== -1);
+        }
+        return false;
+    };
+    /**
+     * This function is responsible for building the full help file URL using rule server.
+     *
+     * @param {String} helpFileName - Provide the help file name
+     *
+     * @return {String} helpFileName - The full help file URL
+     *
+     * PRIVATE METHOD
+     *
+     * @memberOf this
+     */
+    ACEngineManager.getHelpURL = function (ruleId) {
+        return checker.engine.getHelp(ruleId);
+    };
+    ;
+    ACEngineManager.getRulesets = function () {
+        return checker.rulesets;
+    };
+    ;
+    ACEngineManager.getChecker = function () {
+        return checker;
+    };
+    return ACEngineManager;
+}());
+exports.ACEngineManager = ACEngineManager;
+//# sourceMappingURL=ACEngineManager.js.map

package/lib/ACEngineManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACEngineManager.js","sourceRoot":"","sources":["../../src-ts/lib/ACEngineManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAoD;AACpD,iCAAmC;AACnC,2BAA6B;AAC7B,uBAAyB;AAEzB,IAAI,GAAG,CAAC;AAER,IAAI,OAAO,CAAC;AAEZ;IAAA;IAkKA,CAAC;IAjKgB,0BAAU,GAAvB,UAAwB,OAAO;;;;;4BACd,qBAAM,iCAAe,CAAC,oBAAoB,EAAE,EAAA;;wBAArD,MAAM,GAAG,SAA4C;6BACrD,CAAA,eAAe,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA,EAA7E,wBAA6E;wBAC7E,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,0DAA0D,CAAC,CAAC;wBACpF,IAAI,GAAG,OAAO,CAAC;wBACnB,qBAAM,IAAI,CAAC,QAAQ,CAAC,UAAC,SAAS;gCAC1B,IAAI;oCACA,IAAI,WAAW,KAAK,OAAM,CAAC,GAAG,CAAC,EAAE;wCAC7B,OAAO,IAAI,OAAO,CAAO,UAAC,OAAO,EAAE,MAAM;4CACrC,IAAI,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;4CAC9C,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;4CAC/C,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;4CACvC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;4CACtC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE;gDAC5B,OAAO,EAAE,CAAC;4CACd,CAAC,CAAC,CAAC;4CACH,IAAI,KAAK,GAAG,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;4CAClD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gDAAE,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;6CAAE;iDAClD,IAAI,QAAQ,CAAC,IAAI,EAAE;gDAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;6CAAE;iDACzD;gDAAE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;6CAAE;wCAChD,CAAC,CAAC,CAAA;qCACL;iCACJ;gCAAC,OAAO,CAAC,EAAE;oCACR,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iCAC5B;4BACL,CAAC,EAAK,MAAM,CAAC,UAAU,kBAAa,MAAM,CAAC,WAAW,eAAY,CAAC,EAAA;;wBApBnE,SAoBmE,CAAC;wBACpE,sBAAO,eAAe,CAAC,eAAe,EAAE,EAAC;;wBACtC,IAAI,eAAe,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;4BAC5C,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAC;4BAC5E,IAAI;gCACI,OAAO,GAAG,OAAO,CAAC;gCAElB,SAAS,GAC7B,qSAMsC,MAAM,CAAC,UAAU,kBAAa,MAAM,CAAC,WAAW,8VAarF,CAAA;gCACmB,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;gCAC9B,IAAI,MAAM,CAAC,QAAQ,EAAE;oCACjB,MAAM,CAAC,QAAQ,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;iCAC7C;qCAAM,IAAI,MAAM,CAAC,WAAW,EAAE;oCAC3B,MAAM,CAAC,WAAW,CAAC;wCACf,QAAQ,EAAE,KAAK;qCAClB,CAAC,CAAA;iCACL;gCAED,sBAAO,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,cAAc;wCACtE,OAAO,eAAe,CAAC,eAAe,EAAE,CAAC;oCAC7C,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,GAAG;wCAClB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oCACrB,CAAC,CAAC,EAAC;6BACN;4BAAC,OAAO,CAAC,EAAE;gCACR,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;6BAClB;yBACJ;6BAAM;4BACH,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;4BACzE,IAAI,GAAG,EAAE;gCACL,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;6BAC5B;iCAAM;gCACH,sBAAO,eAAe,CAAC,eAAe,EAAE,EAAC;6BAC5C;yBACJ;;;;;;KACJ;IAEY,+BAAe,GAA5B;;;;;;wBACI,IAAI,GAAG,EAAE;4BACL,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;yBAC5B;wBACY,qBAAM,iCAAe,CAAC,oBAAoB,EAAE,EAAA;;wBAArD,MAAM,GAAG,SAA4C;wBAEzD,sBAAO,IAAI,OAAO,CAAO,UAAC,OAAO,EAAE,MAAM;gCACrC,OAAO,CAAC,GAAG,CAAI,MAAM,CAAC,UAAU,kBAAa,MAAM,CAAC,WAAW,oBAAiB,EAAE,UAAU,GAAG,EAAE,IAAI;oCACjG,IAAI,CAAC,IAAI,EAAE;wCACP,OAAO,CAAC,GAAG,CAAC,eAAe,IAAM,MAAM,CAAC,UAAU,kBAAa,MAAM,CAAC,WAAW,eAAY,CAAA,CAAC,CAAC;qCAClG;oCACD,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;oCACjB,IAAI,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oCAC/C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;wCAC3B,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;qCAC3B;oCACD,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oCAC7C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;wCAC1B,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;qCAC1B;oCACD,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,UAAU,GAAG;wCACjE,IAAI;4CACA,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;4CACxB,GAAG,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;4CACnC,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;yCAC/B;wCAAC,OAAO,CAAC,EAAE;4CACR,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;4CACf,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;yCACpB;wCACD,OAAO,EAAE,CAAC;oCACd,CAAC,CAAC,CAAC;gCACP,CAAC,CAAC,CAAC;4BACP,CAAC,CAAC,EAAC;;;;KACN;IAEM,2BAAW,GAAlB,UAAmB,OAAO;QACtB,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE;YAChC,OAAO,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;SAC/D;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEM,4BAAY,GAAnB,UAAoB,OAAO;QACvB,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE;YAChC,OAAO,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC1D;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEM,0BAAU,GAAjB,UAAkB,OAAO;QACrB,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE;YAChC,OAAO,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAC1D,uCAAuC;gBACvC,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACvF;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAGD;;;;;;;;;;OAUG;IACI,0BAAU,GAAjB,UAAkB,MAAM;QACpB,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAAA,CAAC;IAEK,2BAAW,GAAlB;QACI,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAAA,CAAC;IAEK,0BAAU,GAAjB;QACI,OAAO,OAAO,CAAC;IACnB,CAAC;IACL,sBAAC;AAAD,CAAC,AAlKD,IAkKC;AAlKY,0CAAe"}

package/lib/ACHelper.d.ts

@@ -0,0 +1,2 @@
+import { ICheckerResult } from "./api/IChecker";
+export declare function getComplianceHelper(content: any, label: any): Promise<ICheckerResult>;