accessibility-checker 3.1.0 → 3.1.4

package/lib/ACConfigManager.js

@@ -0,0 +1,399 @@
+"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.ACConfigManager = void 0;
+/******************************************************************************
+     Copyright:: 2020- IBM, Inc
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+  *****************************************************************************/
+// Load all the modules that are needed
+var pathLib = require("path");
+var fs = require("fs");
+var YAML = require("js-yaml");
+var ACConstants_1 = require("./ACConstants");
+var uuid = require("uuid");
+var request = require("request");
+/**
+ * This function is responsible converting policies into an Array based on string or Array.
+ *
+ * i.e. convert array into string version of array
+ *  "CI162_5_2_DCP070116,CI162_5_2_DCP070116"
+ *
+ *  converts to:
+ *
+ *  [
+ *    "CI162_5_2_DCP070116",
+ *    "CI162_5_2_DCP070116"
+ *  ]
+ *
+ * @param {Array or String} policies - Provide list of policies, single policy or comma seperated policies
+ *
+ * @return {Array} policies - return the policy converted into Array version
+ *
+ * @memberOf this
+ */
+function convertPolicies(policies) {
+    ACConstants_1.ACConstants.DEBUG && console.log("START 'convertPolicies' function");
+    ACConstants_1.ACConstants.DEBUG && console.log("Converting policy provided to Array: ");
+    ACConstants_1.ACConstants.DEBUG && console.log(policies);
+    ACConstants_1.ACConstants.DEBUG && console.log("END 'convertPolicies' function");
+    // In the case policies is an Array return it as engine expects list
+    if (policies instanceof Array) {
+        return policies;
+    }
+    // If the policies is string, we need to convert it to an array. Which includes comma seperated string support also
+    else if (typeof policies === "string") {
+        return policies.split(',');
+    }
+    return policies;
+}
+/**
+ * This function is responsible processing the achecker config which was initialized to make sure it contains,
+ * information which matches what the engine reads.
+ *
+ * i.e.
+ *  Need to change reportLevels and failLevels to match with level declerations in the engine.
+ *      replace violation with level.violation
+ *  Need to change array of policies into a string
+ *      ["CI162_5_2_DCP070116","CI162_5_2_DCP070116"] to "CI162_5_2_DCP070116,CI162_5_2_DCP070116"
+ *
+ * @param {Object} ACConfig - Provide the config object in which needs to be processed.
+ *
+ * @return {Object} ACConfig - return the config object which has been made engine readable
+ *
+ * @memberOf this
+ */
+function processACConfig(ACConfig) {
+    return __awaiter(this, void 0, void 0, function () {
+        var ruleServer, ruleArchiveFile, ruleArchiveParse, err_1, ruleArchivePath, ruleArchive, i, errStr, errStr;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    ACConstants_1.ACConstants.DEBUG && console.log("START 'processACConfig' function");
+                    // Convert the reportLevels and failLevels to match with what the engine provides
+                    // Don't need to convert the levels from the input as we are going to compare with out the level.
+                    // by using contains algo, so that in the reports we can add it without level, until the engine is
+                    // updated to pass back with out level.
+                    //ACConfig.reportLevels = mapLevelsToEngineReadableLevels(ACConfig.reportLevels);
+                    //ACConfig.failLevels = mapLevelsToEngineReadableLevels(ACConfig.failLevels);
+                    // Convert the policies into a comma seperated string
+                    ACConfig.policies = convertPolicies(ACConfig.policies);
+                    ruleServer = ACConfig.ruleServer ? ACConfig.ruleServer : ACConstants_1.ACConstants.ruleServer;
+                    ruleArchiveFile = ruleServer + "/archives.json";
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, new Promise(function (resolve, reject) {
+                            request.get(ruleArchiveFile, function (error, response, body) {
+                                if (error) {
+                                    reject(error);
+                                }
+                                else {
+                                    resolve(JSON.parse(body));
+                                }
+                            });
+                        })];
+                case 2:
+                    ruleArchiveParse = _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_1 = _a.sent();
+                    console.log(err_1);
+                    throw new Error(err_1);
+                case 4:
+                    ruleArchivePath = null;
+                    if (ruleArchiveParse && ruleArchiveParse.length > 0) {
+                        ACConstants_1.ACConstants.DEBUG && console.log("Found archiveFile: " + ruleArchiveFile);
+                        ACConfig.ruleArchiveSet = ruleArchiveParse;
+                        ruleArchive = ACConfig.ruleArchive;
+                        ACConfig.ruleArchiveLabel = ACConfig.ruleArchive;
+                        for (i = 0; i < ACConfig.ruleArchiveSet.length; i++) {
+                            if (ruleArchive == ACConfig.ruleArchiveSet[i].id && !ACConfig.ruleArchiveSet[i].sunset) {
+                                ruleArchivePath = ACConfig.ruleArchiveSet[i].path;
+                                ACConfig.ruleArchiveLabel = ruleArchiveParse[i].name + " (" + ruleArchiveParse[i].id + ")";
+                                break;
+                            }
+                        }
+                        if (!ruleArchivePath) {
+                            errStr = "[ERROR] RuleArchiveInvalid: Make Sure correct rule archive is provided in the configuration file. More information is available in the README.md";
+                            console.error(errStr);
+                            throw new Error(errStr);
+                        }
+                        //}
+                    }
+                    else {
+                        errStr = "[ERROR] UnableToParseArchive: Archives are unable to be parse. Contact support team.";
+                        console.error(errStr);
+                        throw new Error(errStr);
+                    }
+                    // Build the new rulePack based of the baseA11yServerURL 
+                    ACConfig.rulePack = "" + ruleServer + ruleArchivePath + "/js";
+                    ACConfig.ruleServer = ruleServer;
+                    ACConstants_1.ACConstants.DEBUG && console.log("Built new rulePack: " + ACConfig.rulePack);
+                    ACConstants_1.ACConstants.DEBUG && console.log("END 'processACConfig' function");
+                    // Return the updated ACConfig object
+                    return [2 /*return*/, ACConfig];
+            }
+        });
+    });
+}
+/**
+ * This function is responsible initializing all the default values for the configurations, in the case any
+ * of the config options are missing.
+ *
+ * @param {Object} config - Provide the config object in which we need to initialize the default values.
+ *
+ * @return {Object} config - return the config object which has all the default values, in the case
+ *                           some of the options are null or undefined.
+ *
+ * @memberOf this
+ */
+function initializeDefaults(config) {
+    ACConstants_1.ACConstants.DEBUG && console.log("START 'initializeDefaults' function");
+    ACConstants_1.ACConstants.DEBUG && console.log("Config before initialization: ");
+    ACConstants_1.ACConstants.DEBUG && console.log(config);
+    // Make sure all the following options are defined, otherwise reset them to default values.
+    config.ruleArchiveLabel = config.ruleArchiveLabel || ACConstants_1.ACConstants.ruleArchiveLabel || config.ruleArchive;
+    // For capture screenshots need to check for null or undefined and then set default otherwise it will evaluate the
+    // boolean which causes it to always comply with the default value and not user provided option
+    if (config.captureScreenshots === null || config.captureScreenshots === undefined || typeof config.captureScreenshots === "undefined") {
+        config.captureScreenshots = ACConstants_1.ACConstants.captureScreenshots;
+    }
+    // Load in the package.json file so that we can extract the module name and the version to build
+    // a toolID which needs to be used when results are build for the purpose of keeping track of
+    // which tool is uploading the results.
+    var packageObject = require('../package.json');
+    // Build the toolID based on name and version
+    config.toolID = packageObject.name + "-v" + packageObject.version;
+    // Using the uuid module generate a uuid number which is used to assoiciate to the scans that
+    // are done for a single run of karma.
+    config.scanID = uuid.v4();
+    for (var key in ACConstants_1.ACConstants) {
+        config[key] = config[key] || ACConstants_1.ACConstants[key];
+    }
+    ACConstants_1.ACConstants.DEBUG && console.log("Config after initialization: ");
+    ACConstants_1.ACConstants.DEBUG && console.log(config);
+    ACConstants_1.ACConstants.DEBUG && console.log("END 'initializeDefaults' function");
+}
+/**
+ * This function is responsible reading in the .yaml or .yml or .json and set the config options based on this.
+ *
+ * @return {Object} config - return the config object that was read in, refer to function initializeDefaults
+ *                           to view how the object is to be constructed.
+ *
+ * @memberOf this
+ */
+function loadConfigFromYAMLorJSONFile() {
+    ACConstants_1.ACConstants.DEBUG && console.log("START 'loadConfigFromYAMLorJSONFile' function");
+    // Variable Decleration
+    var config = {};
+    // Get the current working directory, where we will look for the yaml, yml or json file
+    var workingDir = process.cwd();
+    ACConstants_1.ACConstants.DEBUG && console.log("Working directory set to: " + workingDir);
+    // List of files to look for in that order, in the case even one is found we stop and load that as the config.
+    // Theses files will be checked for in the working directory:
+    //  ./.achecker.yml
+    //  ./.achecker.yaml
+    //  ./achecker.js
+    //  ./achecker.json
+    //  ./.config/.achecker.yml
+    //  ./.config/.achecker.yaml
+    //  ./.config/achecker.js
+    //  ./.config/achecker.json
+    // The node module, require will load js or json depending on which one is present, in the case
+    // both json and js are present it loads js first.
+    // Refer to ACConstants.js for more details
+    var configFiles = ACConstants_1.ACConstants.configFiles;
+    // Loop over all the possible location where the config file can reside, if one is found load it and break out.
+    for (var i = 0; i < configFiles.length; i++) {
+        // Get the full path to the config file we are going to check
+        var fileToCheck = pathLib.join(workingDir, configFiles[i]);
+        ACConstants_1.ACConstants.DEBUG && console.log("Checking file: " + fileToCheck);
+        // Get the extension of the file we are about to scan
+        var fileExtension = fileToCheck.substr(fileToCheck.lastIndexOf('.') + 1);
+        // If this is a yml or yaml file verify that the file exists and then load as such.
+        if (fileExtension === "yml" || fileExtension === "yaml") {
+            // Start checking which files exists, if it exists then load it as the config that was read in
+            // We only allow specifying a file, and the order it checks is based on what is specified in the array.
+            // i.e. So in the case that it finds yml, it will load and not check the rest, etc...
+            if (fs.existsSync(fileToCheck)) {
+                ACConstants_1.ACConstants.DEBUG && console.log("File: " + fileToCheck + " exists loading it.");
+                ACConstants_1.ACConstants.DEBUG && console.log("Loading as YAML file.");
+                // Load in as yml or yaml file and return this object
+                return YAML.safeLoad(fs.readFileSync(fileToCheck), 'utf8');
+            }
+        }
+        else {
+            ACConstants_1.ACConstants.DEBUG && console.log("Trying to load as json or js.");
+            // Need to use try/catch mech so that in the case the require throws an exception, we can
+            // catch this and discatd the error, as in the case there is no config file provided then
+            // we load in default values.
+            try {
+                // call the resolve to check if the file exists or not, and get the actualy path if it was js or json
+                var jsOrJSONFile = require.resolve(fileToCheck);
+                // Only try to load the achecker js or json file if it exists.
+                if (jsOrJSONFile) {
+                    ACConstants_1.ACConstants.DEBUG && console.log("Loading: " + jsOrJSONFile);
+                    // Load in as json or js and return this object
+                    return require(fileToCheck);
+                }
+            }
+            catch (e) {
+                ACConstants_1.ACConstants.DEBUG && console.log("JSON or JS file does not exists, will load default config.");
+            }
+        }
+    }
+    ACConstants_1.ACConstants.DEBUG && console.log("END 'loadConfigFromYAMLorJSONFile' function");
+    return config;
+}
+/**
+ * This function is responsible for processing the karma configuration for accessibility-checker.
+ * The ACConfig provided in the Karma configuration will be processed by this
+ * function and then the config variables will be assoiciated to the global space so that
+ * they can be accessed from window.__karma__.config
+ *
+ * @param {Object} config - All the Karma configuration, we will extract what we need from this over
+ *                          all object, we need the entire object so that we can reasign some config
+ *                          variables to global scope so that all karma testscases/scripts can access
+ *                          them.
+ *
+ * @return - N/A - Object will be processed and all the params that are needed for this module will
+ *                 be extracted and then the entire object will be added to global space.
+ *
+ * @memberOf this
+ */
+function processConfiguration(config) {
+    return __awaiter(this, void 0, void 0, function () {
+        var ACConfig, configFromFile;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    ACConstants_1.ACConstants.DEBUG && console.log("START 'processConfiguration' function");
+                    ACConfig = null;
+                    configFromFile = null;
+                    // Read in the .yaml (.yml) or .json file to load in the configuration
+                    configFromFile = loadConfigFromYAMLorJSONFile();
+                    ACConstants_1.ACConstants.DEBUG && console.log("Loaded config from file: ");
+                    ACConstants_1.ACConstants.DEBUG && console.log(configFromFile);
+                    // In the case configuration was provided in a yaml, yml or json file, then set this as the configuration
+                    // otherwise load them from the Karma configuration.
+                    if (configFromFile !== null && typeof (configFromFile) !== "undefined" && Object.keys(configFromFile).length !== 0) {
+                        ACConstants_1.ACConstants.DEBUG && console.log("Using config which was loaded from config file.");
+                        ACConfig = configFromFile;
+                    }
+                    else if (config !== null && typeof (config) !== "undefined" && Object.keys(config).length !== 0) {
+                        // Extract the ACConfig from the overall karma configuration, in the case config file
+                        // was not provided.
+                        ACConfig = config;
+                    }
+                    else {
+                        ACConfig = JSON.parse(JSON.stringify(ACConstants_1.ACConstants));
+                    }
+                    // In the case the ACConfig object is not defined, then define it with default config options so
+                    // it can be set in window.__karma__.config.ACConfig, so that we know even in the testcases, other
+                    // wrapper scripts that there was nothing defined at all, and at the same time to make sure that this
+                    // code was actually executed.
+                    initializeDefaults(ACConfig);
+                    // Now we process the final accessibility-checker config object that is build to make sure it is valid, also need to perform some
+                    // mapping for provided paremeters to actualy read by the engine.
+                    return [4 /*yield*/, processACConfig(ACConfig)];
+                case 1:
+                    // Now we process the final accessibility-checker config object that is build to make sure it is valid, also need to perform some
+                    // mapping for provided paremeters to actualy read by the engine.
+                    _a.sent();
+                    // In the case the Karma config is set to config.LOG_DEBUG then also enable the accessibility-checker debuging
+                    ACConfig.DEBUG = ACConstants_1.ACConstants.DEBUG;
+                    ACConstants_1.ACConstants.DEBUG && console.log("END 'processConfiguration' function");
+                    return [2 /*return*/, ACConfig];
+            }
+        });
+    });
+}
+var config = null;
+var ACConfigManager = /** @class */ (function () {
+    function ACConfigManager() {
+    }
+    ACConfigManager.setConfig = function (inConfig) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, processConfiguration(inConfig)];
+                    case 1:
+                        config = _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ACConfigManager.getConfig = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.getConfigUnsupported()];
+            });
+        });
+    };
+    ACConfigManager.getConfigUnsupported = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!!config) return [3 /*break*/, 2];
+                        return [4 /*yield*/, ACConfigManager.setConfig()];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, config];
+                }
+            });
+        });
+    };
+    return ACConfigManager;
+}());
+exports.ACConfigManager = ACConfigManager;
+//# sourceMappingURL=ACConfigManager.js.map

package/lib/ACConfigManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACConfigManager.js","sourceRoot":"","sources":["../../src-ts/lib/ACConfigManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;gFAcgF;AAC/E,uCAAuC;AACxC,8BAAgC;AAChC,uBAAyB;AACzB,8BAAgC;AAChC,6CAA4C;AAC5C,2BAA6B;AAC7B,iCAAmC;AAGnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAS,eAAe,CAAC,QAA2B;IAChD,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;IAErE,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IAC1E,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE3C,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IAEnE,oEAAoE;IACpE,IAAI,QAAQ,YAAY,KAAK,EAAE;QAC3B,OAAO,QAAQ,CAAC;KACnB;IACD,mHAAmH;SAC9G,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;QACnC,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAe,eAAe,CAAC,QAAQ;;;;;;oBACnC,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;oBAErE,iFAAiF;oBACjF,iGAAiG;oBACjG,kGAAkG;oBAClG,uCAAuC;oBACvC,iFAAiF;oBACjF,6EAA6E;oBAE7E,qDAAqD;oBACrD,QAAQ,CAAC,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAGnD,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,yBAAW,CAAC,UAAU,CAAC;oBAGhF,eAAe,GAAM,UAAU,mBAAgB,CAAC;;;;oBAG7B,qBAAM,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;4BACjD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,QAAQ,EAAE,IAAI;gCACxD,IAAI,KAAK,EAAE;oCACP,MAAM,CAAC,KAAK,CAAC,CAAC;iCACjB;qCAAM;oCACH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;iCAC7B;4BACL,CAAC,CAAC,CAAC;wBACP,CAAC,CAAC,EAAA;;oBARF,gBAAgB,GAAG,SAQjB,CAAC;;;;oBAEH,OAAO,CAAC,GAAG,CAAC,KAAG,CAAC,CAAC;oBACjB,MAAM,IAAI,KAAK,CAAC,KAAG,CAAC,CAAC;;oBAErB,eAAe,GAAG,IAAI,CAAC;oBAC3B,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;wBACjD,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,eAAe,CAAC,CAAC;wBAC1E,QAAQ,CAAC,cAAc,GAAG,gBAAgB,CAAC;wBACvC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;wBACvC,QAAQ,CAAC,gBAAgB,GAAG,QAAQ,CAAC,WAAW,CAAC;wBACjD,KAAS,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;4BACrD,IAAI,WAAW,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;gCACpF,eAAe,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gCAClD,QAAQ,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC;gCAC3F,MAAM;6BACT;yBACJ;wBACD,IAAI,CAAC,eAAe,EAAE;4BACZ,MAAM,GAAG,kJAAkJ,CAAC;4BAClK,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;4BACtB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;yBAC3B;wBACD,GAAG;qBACN;yBAAM;wBACG,MAAM,GAAG,sFAAsF,CAAC;wBACtG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;wBACtB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;qBAC3B;oBAED,yDAAyD;oBACzD,QAAQ,CAAC,QAAQ,GAAG,KAAG,UAAU,GAAG,eAAe,QAAK,CAAC;oBACzD,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;oBAEjC,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAE7E,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;oBAEnE,qCAAqC;oBACrC,sBAAO,QAAQ,EAAC;;;;CACnB;AAED;;;;;;;;;;GAUG;AACH,SAAS,kBAAkB,CAAC,MAA0B;IAClD,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;IAExE,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IACnE,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,2FAA2F;IAC3F,MAAM,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,yBAAW,CAAC,gBAAgB,IAAI,MAAM,CAAC,WAAW,CAAC;IACxG,kHAAkH;IAClH,+FAA+F;IAC/F,IAAI,MAAM,CAAC,kBAAkB,KAAK,IAAI,IAAI,MAAM,CAAC,kBAAkB,KAAK,SAAS,IAAI,OAAO,MAAM,CAAC,kBAAkB,KAAK,WAAW,EAAE;QACnI,MAAM,CAAC,kBAAkB,GAAG,yBAAW,CAAC,kBAAkB,CAAC;KAC9D;IAED,gGAAgG;IAChG,6FAA6F;IAC7F,uCAAuC;IACvC,IAAI,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE/C,6CAA6C;IAC7C,MAAM,CAAC,MAAM,GAAG,aAAa,CAAC,IAAI,GAAG,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC;IAElE,6FAA6F;IAC7F,sCAAsC;IACtC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAE1B,KAAK,IAAM,GAAG,IAAI,yBAAW,EAAE;QAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,yBAAW,CAAC,GAAG,CAAC,CAAC;KACjD;IAED,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAClE,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEzC,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,4BAA4B;IACjC,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;IAElF,uBAAuB;IACvB,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,uFAAuF;IACvF,IAAI,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE/B,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,4BAA4B,GAAG,UAAU,CAAC,CAAC;IAE5E,8GAA8G;IAC9G,6DAA6D;IAC7D,mBAAmB;IACnB,oBAAoB;IACpB,iBAAiB;IACjB,mBAAmB;IACnB,2BAA2B;IAC3B,4BAA4B;IAC5B,yBAAyB;IACzB,2BAA2B;IAC3B,+FAA+F;IAC/F,kDAAkD;IAClD,2CAA2C;IAC3C,IAAI,WAAW,GAAG,yBAAW,CAAC,WAAW,CAAC;IAE1C,+GAA+G;IAC/G,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAEzC,6DAA6D;QAC7D,IAAI,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3D,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,WAAW,CAAC,CAAC;QAElE,qDAAqD;QACrD,IAAI,aAAa,GAAG,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzE,mFAAmF;QACnF,IAAI,aAAa,KAAK,KAAK,IAAI,aAAa,KAAK,MAAM,EAAE;YACrD,8FAA8F;YAC9F,uGAAuG;YACvG,qFAAqF;YACrF,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;gBAE5B,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,WAAW,GAAG,qBAAqB,CAAC,CAAC;gBAEjF,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;gBAE1D,qDAAqD;gBACrD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;aAC9D;SACJ;aAAM;YACH,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;YAElE,yFAAyF;YACzF,yFAAyF;YACzF,6BAA6B;YAC7B,IAAI;gBAEA,qGAAqG;gBACrG,IAAI,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAEhD,8DAA8D;gBAC9D,IAAI,YAAY,EAAE;oBAEd,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,YAAY,CAAC,CAAA;oBAE5D,+CAA+C;oBAC/C,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;iBAC/B;aACJ;YAAC,OAAO,CAAC,EAAE;gBACR,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,4DAA4D,CAAC,CAAA;aACjG;SACJ;KACJ;IAED,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;IAEhF,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAe,oBAAoB,CAAC,MAAO;;;;;;oBACvC,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;oBAGtE,QAAQ,GAA+B,IAAI,CAAC;oBAC5C,cAAc,GAAG,IAAI,CAAC;oBAE1B,sEAAsE;oBACtE,cAAc,GAAG,4BAA4B,EAAE,CAAC;oBAEhD,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;oBAC9D,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;oBAEjD,yGAAyG;oBACzG,oDAAoD;oBACpD,IAAI,cAAc,KAAK,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,KAAK,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;wBAChH,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;wBAEpF,QAAQ,GAAG,cAAc,CAAC;qBAC7B;yBAAM,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;wBAC/F,qFAAqF;wBACrF,oBAAoB;wBACpB,QAAQ,GAAG,MAAM,CAAC;qBACrB;yBAAM;wBACH,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,yBAAW,CAAC,CAAC,CAAC;qBACtD;oBAED,gGAAgG;oBAChG,kGAAkG;oBAClG,qGAAqG;oBACrG,8BAA8B;oBAC9B,kBAAkB,CAAC,QAAQ,CAAC,CAAC;oBAE7B,iIAAiI;oBACjI,iEAAiE;oBACjE,qBAAM,eAAe,CAAC,QAAQ,CAAC,EAAA;;oBAF/B,iIAAiI;oBACjI,iEAAiE;oBACjE,SAA+B,CAAC;oBAEhC,8GAA8G;oBAC9G,QAAQ,CAAC,KAAK,GAAG,yBAAW,CAAC,KAAK,CAAC;oBAEnC,yBAAW,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;oBACxE,sBAAO,QAAQ,EAAC;;;;CACnB;AAED,IAAI,MAAM,GAAwB,IAAI,CAAC;AACvC;IAAA;IAeA,CAAC;IAdgB,yBAAS,GAAtB,UAAuB,QAAuC;;;;4BACjD,qBAAM,oBAAoB,CAAC,QAAQ,CAAC,EAAA;;wBAA7C,MAAM,GAAG,SAAoC,CAAC;;;;;KACjD;IAEY,yBAAS,GAAtB;;;gBACI,sBAAO,IAAI,CAAC,oBAAoB,EAAE,EAAC;;;KACtC;IAEY,oCAAoB,GAAjC;;;;;6BACQ,CAAC,MAAM,EAAP,wBAAO;wBACP,qBAAM,eAAe,CAAC,SAAS,EAAE,EAAA;;wBAAjC,SAAiC,CAAC;;4BAEtC,sBAAO,MAAM,EAAC;;;;KACjB;IACL,sBAAC;AAAD,CAAC,AAfD,IAeC;AAfY,0CAAe"}

package/lib/ACConstants.d.ts

@@ -0,0 +1,17 @@
+/******************************************************************************
+     Copyright:: 2020- IBM, Inc
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+  *****************************************************************************/
+import { IConfigUnsupported } from "./api/IChecker";
+export declare const ACConstants: IConfigUnsupported;

package/lib/ACConstants.js

@@ -1,3 +1,4 @@
+"use strict";
 /******************************************************************************
      Copyright:: 2020- IBM, Inc
 
@@ -13,62 +14,42 @@
     See the License for the specific language governing permissions and
     limitations under the License.
   *****************************************************************************/
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACConstants = void 0;
 /*******************************************************************************
  * NAME: ACConstants.js
  * DESCRIPTION: Stores all the constants that are used by karma-ibma.
  *******************************************************************************/
-
 // Load all the modules that are needed
-var pathLib = require('path');
-
+var pathLib = require("path");
+var IEngine_1 = require("./api/IEngine");
 // Used to specify all the constant
-var constants = {
+exports.ACConstants = {
     DEBUG: process.env.DEBUG === "true",
-
     maxTabs: 1,
-
     policies: ["IBM_Accessibility"],
-
     // Specify the default rule pack server to use. (Where to pull the rules and engine from).
-    rulePack: "https://able.ibm.com/rules/archives/latest/js",
-
+    ruleServer: "https://able.ibm.com/rules",
     //Specify the rule set to be use.
     ruleArchive: "latest",
-
     // Specify default violation levels on which to fail the test.
     // i.e. If specified violation then the testcase will only fail if
     //      a violation is found uring the scan.
-    failLevels: ["violation", "potentialviolation"],
-
+    failLevels: [IEngine_1.eRuleLevel.violation, IEngine_1.eRuleLevel.potentialviolation],
     // Specify default violation levels which should be reported.
     // i.e. If specified violation then in the report it would only contain
     //      results which are level of violation.
-    reportLevels: ["violation",
-                   "potentialviolation"
-                  ],
-
+    reportLevels: [IEngine_1.eRuleLevel.violation, IEngine_1.eRuleLevel.potentialviolation],
     // Specify default value if screenshoot should be captured of the current page that is being scanned.
     captureScreenshots: false,
-
     // Specify default value for which type should the results be outputted to
     outputFormat: "json",
-
     // Specify default location where the results should be saved
     outputFolder: "results",
-
     // Specify default location where the baselines should be saved
-    baselinefolder: "baselines",
-
-    // Specify default value if Hidden content be scanned or not.
-    checkHiddenContent: false,
-
+    baselineFolder: "baselines",
     // Specify default value for Which file extensions should be checked
     extensions: ["html", "htm", "svg"],
-
-    // Specify default value for the engine file name. This the
-    engineFileName: "ace.js",
-
     // List of files to look for in that order, in the case even one is found we stop and load that as the config.
     // Theses files will be checked for in the working directory:
     //  ./.achecker.yml
@@ -82,13 +63,6 @@ var constants = {
     // The node module, require will load js or json depending on which one is present, in the case
     // both json and js are present it loads js first.
     configFiles: [".achecker.yml", ".achecker.yaml", "achecker", pathLib.join(".config", ".achecker.yml"), pathLib.join(".config", ".achecker.yaml"), pathLib.join(".config", "achecker")],
-
-    // Specify the Base Accessibility Server URL
-    baseA11yServerURL: "https://able.ibm.com/rules",
-
-    // Specify true or false to allow setting rulePack with a custom server
-    customRuleServer: false
+    ignoreHTTPSErrors: false
 };
-
-// Export this the constants
-module.exports = constants;
+//# sourceMappingURL=ACConstants.js.map

package/lib/ACConstants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACConstants.js","sourceRoot":"","sources":["../../src-ts/lib/ACConstants.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;gFAcgF;;;AAEhF;;;iFAGiF;AAEjF,uCAAuC;AACvC,8BAAgC;AAEhC,yCAA2C;AAE3C,mCAAmC;AACtB,QAAA,WAAW,GAAwB;IAC5C,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,MAAM;IACnC,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,CAAC,mBAAmB,CAAC;IAC/B,0FAA0F;IAC1F,UAAU,EAAE,4BAA4B;IAExC,iCAAiC;IACjC,WAAW,EAAE,QAAQ;IAErB,8DAA8D;IAC9D,kEAAkE;IAClE,4CAA4C;IAC5C,UAAU,EAAE,CAAC,oBAAU,CAAC,SAAS,EAAE,oBAAU,CAAC,kBAAkB,CAAC;IAEjE,6DAA6D;IAC7D,uEAAuE;IACvE,6CAA6C;IAC7C,YAAY,EAAE,CAAC,oBAAU,CAAC,SAAS,EAAE,oBAAU,CAAC,kBAAkB,CAAC;IAEnE,qGAAqG;IACrG,kBAAkB,EAAE,KAAK;IAEzB,0EAA0E;IAC1E,YAAY,EAAE,MAAM;IAEpB,6DAA6D;IAC7D,YAAY,EAAE,SAAS;IAEvB,+DAA+D;IAC/D,cAAc,EAAE,WAAW;IAE3B,oEAAoE;IACpE,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC;IAElC,8GAA8G;IAC9G,6DAA6D;IAC7D,mBAAmB;IACnB,oBAAoB;IACpB,iBAAiB;IACjB,mBAAmB;IACnB,2BAA2B;IAC3B,4BAA4B;IAC5B,yBAAyB;IACzB,2BAA2B;IAC3B,+FAA+F;IAC/F,kDAAkD;IAClD,WAAW,EAAE,CAAC,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEtL,iBAAiB,EAAE,KAAK;CAC3B,CAAC"}

package/lib/ACEngineManager.d.ts

@@ -0,0 +1,21 @@
+export declare class ACEngineManager {
+    static loadEngine(content: any): Promise<any>;
+    static loadEngineLocal(): Promise<void>;
+    static isPuppeteer(content: any): any;
+    static isPlaywright(content: any): any;
+    static isSelenium(content: any): boolean;
+    /**
+     * 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
+     */
+    static getHelpURL(ruleId: any): any;
+    static getRulesets(): any;
+    static getChecker(): any;
+}