accessibility-checker 4.0.1 → 4.0.2

package/mjs/bin/achecker.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/mjs/bin/achecker.js

@@ -0,0 +1,236 @@
+#!/usr/bin/env node
+/******************************************************************************
+     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 * as aChecker from "../index.js";
+import * as fs from "fs";
+import * as readline from "readline";
+import * as path from "path";
+let validCLParams = [
+    "inputFile"
+];
+let splitCLParams = [
+    "policies",
+    "failLevels",
+    "reportLevels",
+    "outputFormat",
+    "label"
+];
+function processCommandLine(ACConfig) {
+    const [, , ...args] = process.argv;
+    let lastArg = null;
+    let lastFlag = null;
+    for (let arg of args) {
+        if (arg.match(/^--.*$/)) {
+            lastFlag = arg.substring(2);
+            lastArg = null;
+        }
+        else if (lastFlag) {
+            if (lastFlag in ACConfig || validCLParams.includes(lastFlag)) {
+                if (splitCLParams.includes(lastFlag)) {
+                    arg = arg.split(",");
+                }
+                ACConfig[lastFlag] = arg;
+            }
+            lastFlag = lastArg = null;
+        }
+        else {
+            lastArg = arg;
+        }
+    }
+    if (lastArg) {
+        ACConfig.inputFile = lastArg;
+    }
+}
+async function getFiles(dir) {
+    let retVal = [];
+    for (let f of fs.readdirSync(dir)) {
+        if (f[0] === ".") {
+            // skip
+        }
+        else {
+            f = path.join(dir, f);
+            if (fs.lstatSync(f).isDirectory()) {
+                retVal = retVal.concat(await getFiles(f));
+            }
+            else if (f.endsWith(".htm") || f.endsWith(".html")) {
+                retVal.push(f);
+            }
+        }
+    }
+    return retVal;
+}
+async function showHelp(config) {
+    let lastArg = config.inputFile;
+    if (!lastArg || lastArg === "help") {
+        console.log(`Usage: achecker [flags] [command / file / directory / URL]
+
+Commands:
+    archives                : Display valid archive ids and policy ids
+
+Flags:
+    Flags can be set via .achecker.yml or aceconfig.js files. Specifying the flags here
+    will override those options.
+
+    --ruleArchive           : Archive id to use. Run "achecker archives" for valid ids
+    --policies              : Comma separated list of policies. Run "achecker archives"
+                                for valid ids
+    --failLevels            : Comma separated list of levels that will indicate
+                                a failure. Valid values: violation,
+                                potentialviolation, recommendation,
+                                potentialrecommendation, manual
+    --reportLevels          : Comma separated list of levels that will be included
+                                in reports. Valid values: violation,
+                                potentialviolation, recommendation,
+                                potentialrecommendation, manual, pass
+    --outputFormat          : Comma separated list of output report formats.
+                                Valid values: json, csv, xlsx, html, or disable
+    --label                 : Comma separated list of labels to include in reports
+    --outputFolder          : Folder to output results and reports
+    --baselineFolder        : Folder that includes baseline files
+`);
+        process.exit(-1);
+    }
+    else if (lastArg === "archives") {
+        let archiveInfo = {
+            "latest": []
+        };
+        console.log();
+        console.log("Archive [Archive Id]");
+        console.log("  - Policy [Policy Id]:");
+        console.log("-----------------------");
+        console.log();
+        for (const archive of config.ruleArchiveSet) {
+            if (archive.sunset)
+                continue;
+            console.log(`${archive.name} [${archive.id}]`);
+            for (const policy of archive.policies) {
+                console.log(`  - ${policy.name} [${policy.id}]`);
+            }
+            archiveInfo[archive.id] = archive.policies;
+            if (archive.latest) {
+                archiveInfo['latest'] = archiveInfo[archive.id];
+            }
+        }
+        process.exit(-1);
+    }
+}
+async function getInputFileList() {
+    let config = await aChecker.getConfig();
+    processCommandLine(config);
+    await showHelp(config);
+    let inputs = [];
+    let filename = config.inputFile.trim();
+    if (filename.endsWith(".txt")) {
+        const fileStream = fs.createReadStream(filename);
+        const rl = readline.createInterface({
+            input: fileStream,
+            crlfDelay: Infinity
+        });
+        // Note: we use the crlfDelay option to recognize all instances of CR LF
+        // ('\r\n') in input.txt as a single line break.
+        for await (const line of rl) {
+            if (line.trim().length === 0) {
+            }
+            else if (line.startsWith(path.sep)) {
+                inputs.push(line);
+            }
+            else if (line.match(/[a-z]{4,5}:\/\//)) {
+                inputs.push(line);
+            }
+            else {
+                inputs.push(path.join(path.dirname(filename), line));
+            }
+        }
+    }
+    else {
+        inputs = [filename];
+    }
+    let retVal = [];
+    for (const input of inputs) {
+        let isDirectory = false;
+        try {
+            isDirectory = fs.lstatSync(input).isDirectory();
+        }
+        catch (e) { }
+        if (isDirectory) {
+            retVal = retVal.concat(await getFiles(input));
+        }
+        else {
+            retVal.push(input);
+        }
+    }
+    return retVal;
+}
+// Prepare the configuration
+getInputFileList().then(async (rptInputFiles) => {
+    let idx = 0;
+    let failures = [];
+    let errors = 0;
+    try {
+        for (let f of rptInputFiles) {
+            let result;
+            let isFile = false;
+            try {
+                isFile = fs.lstatSync(f).isFile();
+                f = path.resolve(f);
+            }
+            catch (e) { }
+            if (isFile) {
+                result = await aChecker.getCompliance("file://" + f, f.replace(/^file:\/\//, "").replace(/[:?&=]/g, "_"));
+            }
+            else {
+                result = await aChecker.getCompliance(f, f.replace(/^(https?:|file:)\/\//, "").replace(/[:?&=]/g, "_"));
+            }
+            if (result) {
+                if (aChecker.assertCompliance(result.report) === 0) {
+                    console.log("Passed:", f);
+                }
+                else {
+                    failures.push({
+                        file: f,
+                        report: result.report
+                    });
+                    console.log("Failed:", f);
+                }
+            }
+            else {
+                ++errors;
+                console.log("Error:", f);
+            }
+        }
+    }
+    catch (e) {
+        console.error(e);
+    }
+    finally {
+        await aChecker.close();
+    }
+    if (failures.length > 0) {
+        console.log();
+        console.log("Failing scan details:");
+        console.log();
+        for (const fail of failures) {
+            console.log(aChecker.stringifyResults(fail.report));
+        }
+    }
+    console.log();
+    console.log(`${rptInputFiles.length - failures.length - errors} of ${rptInputFiles.length} passed.`);
+    //await aChecker.close();
+    if (failures.length !== 0 || errors !== 0) {
+        process.exitCode = 1;
+    }
+});
+//# sourceMappingURL=achecker.js.map

package/mjs/bin/achecker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"achecker.js","sourceRoot":"","sources":["../../../src-ts/bin/achecker.js"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;gFAcgF;AAEhF,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AACrC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,IAAI,aAAa,GAAG;IAChB,WAAW;CACd,CAAA;AAED,IAAI,aAAa,GAAG;IAChB,UAAU;IACV,YAAY;IACZ,cAAc;IACd,cAAc;IACd,OAAO;CACV,CAAA;AAED,SAAS,kBAAkB,CAAC,QAAQ;IAChC,MAAM,CAAC,EAAE,AAAD,EAAG,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IACnC,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,KAAK,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACnB,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtB,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC5B,OAAO,GAAG,IAAI,CAAC;QACnB,CAAC;aAAM,IAAI,QAAQ,EAAE,CAAC;YAClB,IAAI,QAAQ,IAAI,QAAQ,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3D,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACzB,CAAC;gBACD,QAAQ,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;YAC7B,CAAC;YACD,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC;QAC9B,CAAC;aAAM,CAAC;YACJ,OAAO,GAAG,GAAG,CAAC;QAClB,CAAC;IACL,CAAC;IACD,IAAI,OAAO,EAAE,CAAC;QACV,QAAQ,CAAC,SAAS,GAAG,OAAO,CAAC;IACjC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,GAAG;IACvB,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACf,OAAO;QACX,CAAC;aAAM,CAAC;YACJ,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtB,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBAChC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,MAAM;IAC1B,IAAI,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;IAC/B,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CACnB;;;;;;;;;;;;;;;;;;;;;;;;;CAyBC,CAAC,CAAC;QACK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;SAAM,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAChC,IAAI,WAAW,GAAG;YACd,QAAQ,EAAC,EAAE;SACd,CAAA;QACD,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACvC,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC1C,IAAI,OAAO,CAAC,MAAM;gBAAE,SAAS;YAC7B,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;YAC/C,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACpC,OAAO,CAAC,GAAG,CAAC,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;YACrD,CAAC;YACD,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;YAC3C,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACjB,WAAW,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;AACL,CAAC;AAED,KAAK,UAAU,gBAAgB;IAC3B,IAAI,MAAM,GAAG,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC;IACxC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC3B,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvB,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACvC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEjD,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC;YAChC,KAAK,EAAE,UAAU;YACjB,SAAS,EAAE,QAAQ;SACtB,CAAC,CAAC;QACH,wEAAwE;QACxE,gDAAgD;QAEhD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAE/B,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;iBAAM,IAAI,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACvC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;YACzD,CAAC;QACL,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC;YACD,WAAW,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QACpD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;QACd,IAAI,WAAW,EAAE,CAAC;YACd,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,4BAA4B;AAC5B,gBAAgB,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;IAC5C,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,CAAC;QACD,KAAK,IAAI,CAAC,IAAI,aAAa,EAAE,CAAC;YAC1B,IAAI,MAAM,CAAC;YACX,IAAI,MAAM,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC;gBACD,MAAM,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;gBAClC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACxB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;YACd,IAAI,MAAM,EAAE,CAAC;gBACT,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,SAAS,GAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,EAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAC,GAAG,CAAC,CAAC,CAAC;YAC1G,CAAC;iBAAM,CAAC;gBACJ,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,EAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAC,GAAG,CAAC,CAAC,CAAC;YAC1G,CAAC;YACD,IAAI,MAAM,EAAE,CAAC;gBACT,IAAI,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjD,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;gBAC9B,CAAC;qBAAM,CAAC;oBACJ,QAAQ,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,CAAC;wBACP,MAAM,EAAE,MAAM,CAAC,MAAM;qBACxB,CAAC,CAAC;oBACH,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;gBAC9B,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,EAAE,MAAM,CAAC;gBACT,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;YAAS,CAAC;QACP,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACrC,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACxD,CAAC;IACL,CAAC;IACD,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,OAAO,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,MAAM,GAAC,QAAQ,CAAC,MAAM,GAAC,MAAM,OAAO,aAAa,CAAC,MAAM,UAAU,CAAC,CAAA;IAChG,yBAAyB;IACzB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;QACxC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACzB,CAAC;AACL,CAAC,CAAC,CAAA"}

package/mjs/index.d.ts

@@ -0,0 +1,319 @@
+/******************************************************************************
+    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 { eAssertResult, ICheckerReport, ICheckerResult, ReportResult } from "./lib/api/IChecker.js";
+import { IConfig, IConfigInternal } from "./lib/common/config/IConfig.js";
+import { IBaselineReport } from "./lib/common/engine/IReport.js";
+/**
+ * This function is responsible performing a scan based on the context that is provided, following are
+ * the supported context type:
+ *    Single node (HTMLElement)
+ *    Local file path (String)
+ *    URL (String)
+ *    document node
+ *    data stream for html content (String)
+ *
+ *  Future Items
+ *    Multiple node (Array of HTMLElements) ---> FUTURE
+ *
+ * @param {(String|HTMLElement|DocumentNode|Puppeteer Page |)} content - Provide the context to scan, which includes the items from above.
+ * @param {String} label - Provide a label for the scan that is being performed
+ * @param {Function} callback - (optional) Provide callback function which will be executed once the results are extracted.
+ * @return Promise with the ICheckerResult
+ */
+export declare function getCompliance(content: any, label: string, callback?: (report: ReportResult, webdriver: any) => void): Promise<ICheckerResult>;
+/**
+ * This function is responsible for comparing the scan results with baseline or checking that there are
+ * no violations which fall into the failsLevels levels. In the case a baseline is found then baseline will
+ * be used to perform the check, in the case no baseline is provided then we comply with only failing if
+ * there is a sinble violation which falls into failLevels.
+ *
+ * @param {ReportResult} actual - the actual results object provided by the user, this object should follow the
+ *                          same format as outlined in the return of aChecker.buildReport function.
+ *
+ * @return {int} - return 0 in the case actual matches baseline or no violations fall into failsLevels,
+ *                 return 1 in the case actual results does not match baseline results,
+ *                 return 2 in the case that there is a failure based on failLevels (this means no baseline found).
+ *                 return -1 in the case that there is an exception that occured in the results object which came from the scan engine.
+ */
+export declare function assertCompliance(report: IBaselineReport): eAssertResult;
+/**
+ * This function is responsible for printing the scan results to console.
+ *
+ * @param {Object} results - Provide the results from the scan.
+ *
+ * @return {String} resultsString - String representation of the results/violations.
+ *
+ * PUBLIC API
+ *
+ * @memberOf this
+ */
+export declare function stringifyResults(report: ICheckerReport): string;
+export declare function getConfig(): Promise<IConfig>;
+export declare function getConfigUnsupported(): Promise<IConfigInternal>;
+export declare function close(): Promise<void>;
+/**
+ * This function is responsible for getting the diff results based on label for a scan that was already performed.
+ *
+ * @param {String} label - Provide a lable for which to get the diff results for.
+ *
+ * @return {Object} - return the diff results object from global space based on label provided, the object will be
+ *                    in the same format as outlined in the return of aChecker.diffResultsWithExpected function.
+ */
+export declare function getDiffResults(label: string): any;
+/**
+ * This function is responsible for getting the baseline object for a label that was provided.
+ *
+ * @param {String} label - Provide a lable for which to get the baseline for.
+ *
+ * @return {Object} - return the baseline object from global space based on label provided, the object will be
+ *                    in the same format as outlined in the return of aChecker.buildReport function.
+ */
+export declare function getBaseline(label: string): IBaselineReport;
+/**
+ * This function is responsible for comparing actual with expected and returning all the differences as an array.
+ *
+ * @param {Object} actual - Provide the actual object to be used for compare
+ * @param {Object} expected - Provide the expected object to be used for compare
+ * @param {boolean} clean - Provide a boolean if both the actual and expected objects need to be cleaned
+ *                          cleaning refers to converting the objects to match with a basic compliance
+ *                          compare of xpath and ruleId.
+ *
+ * @return {Object} differences - return an array of diff objects that were found, following is the format of the object:
+ * [
+ *     {
+ *         "kind": "E",
+ *         "path": [
+ *             "reports",
+ *             0,
+ *             "issues",
+ *             10,
+ *             "xpath"
+ *         ],
+ *         "lhs": "/html[1]/body[1]/div[2]/table[5]",
+ *         "rhs": "/html[1]/body[1]/div[2]/table[5]d",
+ *     },
+ *     {
+ *         "kind": "E",
+ *         "path": [
+ *             "label"
+ *         ],
+ *         "lhs": "Table-layoutMultiple",
+ *         "rhs": "dependencies/tools-rules-html/v2/a11y/test/g471/Table-layoutMultiple.html",
+ *     }
+ * ]
+ */
+export declare function diffResultsWithExpected(actual: any, expected: any, clean: any): any;
+/**
+ * This function is responsible for cleaning up the compliance baseline or actual results, based on
+ * a pre-defined set of criterias, such as the following:
+ *      1. No need to compare summary object
+ *      2. Only need to compare the ruleId and xpath in for each of the issues
+ *
+ * @param {Object} objectToClean - Provide either an baseline or actual results object which would be in the
+ *                                 the same format as outlined in the return of aChecker.buildReport function.
+ *
+ * @return {Object} objectToClean - return an object that was cleaned to only contain the information that is
+ *                                  needed for compare. Following is a sample of how the cleaned object will look like:
+ * {
+ *     "label": "unitTestContent",
+ *     "reports": [
+ *         {
+ *             "frameIdx": "0",
+ *             "frameTitle": "Frame 0",
+ *             "issues": [
+ *                 {
+ *                     "ruleId": "1",
+ *                     "xpath": "/html[1]/head[1]/style[1]"
+ *                 }
+ *                 ....
+ *             ]
+ *         },
+ *         {
+ *             "frameIdx": "1",
+ *             "frameTitle": "Frame 1",
+ *             "issues": [
+ *                 {
+ *                     "ruleId": "471",
+ *                     "xpath": "/html[1]/body[1]/div[2]/table[3]"
+ *                 }
+ *                 ....
+ *             ]
+ *         }
+ *     ]
+ * }
+ */
+export declare function cleanComplianceObjectBeforeCompare(objectToClean: any): any;
+export declare function addRuleset(ruleset: any): void;
+export declare function getRuleset(rsId: any): Promise<any>;
+export declare function getRulesets(): Promise<any[]>;
+export declare function getRules(): Promise<any[]>;
+export declare const ruleIdToLegacyId: {
+    list_structure_proper: string;
+    marquee_elem_avoid: string;
+    heading_markup_misuse: string;
+    imagebutton_alt_exists: string;
+    img_ismap_misuse: string;
+    object_text_exists: string;
+    applet_alt_exists: string;
+    media_audio_transcribed: string;
+    blockquote_cite_exists: string;
+    meta_refresh_delay: string;
+    frame_title_exists: string;
+    input_label_exists: string;
+    media_alt_brief: string;
+    a_target_warning: string;
+    area_alt_exists: string;
+    RPT_Media_ImgColorUsage: string;
+    meta_redirect_optional: string;
+    element_attribute_deprecated: string;
+    text_quoted_correctly: string;
+    element_mouseevent_keyboard: string;
+    page_title_exists: string;
+    text_block_heading: string;
+    form_submit_button_exists: string;
+    element_id_unique: string;
+    form_font_color: string;
+    form_label_unique: string;
+    img_alt_misuse: string;
+    img_longdesc_misuse: string;
+    img_alt_valid: string;
+    style_background_decorative: string;
+    asciiart_alt_exists: string;
+    media_track_available: string;
+    media_alt_exists: string;
+    style_color_misuse: string;
+    select_options_grouped: string;
+    list_markup_review: string;
+    script_onclick_misuse: string;
+    table_structure_misuse: string;
+    WCAG20_Img_AltTriggerNonDecorative: string;
+    blink_elem_deprecated: string;
+    blink_css_review: string;
+    html_skipnav_exists: string;
+    page_title_valid: string;
+    heading_content_exists: string;
+    html_lang_exists: string;
+    form_interaction_review: string;
+    a_text_purpose: string;
+    fieldset_legend_valid: string;
+    media_live_captioned: string;
+    text_sensory_misuse: string;
+    media_autostart_controllable: string;
+    style_focus_visible: string;
+    img_alt_redundant: string;
+    RPT_Style_ExternalStyleSheet: string;
+    script_onclick_avoid: string;
+    table_summary_redundant: string;
+    input_label_before: string;
+    input_label_after: string;
+    embed_noembed_exists: string;
+    table_scope_valid: string;
+    img_alt_null: string;
+    input_fields_grouped: string;
+    input_checkboxes_grouped: string;
+    script_select_review: string;
+    input_onchange_review: string;
+    embed_alt_exists: string;
+    noembed_content_exists: string;
+    table_caption_empty: string;
+    table_caption_nested: string;
+    label_content_exists: string;
+    dir_attribute_valid: string;
+    frame_src_valid: string;
+    table_headers_related: string;
+    table_layout_linearized: string;
+    table_headers_exists: string;
+    label_ref_valid: string;
+    element_accesskey_unique: string;
+    script_focus_blur_review: string;
+    imagemap_alt_exists: string;
+    emoticons_alt_exists: string;
+    style_before_after_review: string;
+    text_whitespace_valid: string;
+    aria_role_allowed: string;
+    aria_attribute_value_valid: string;
+    aria_id_unique: string;
+    aria_attribute_required: string;
+    aria_attribute_exists: string;
+    aria_attribute_allowed: string;
+    aria_activedescendant_tabindex_valid: string;
+    aria_child_tabbable: string;
+    aria_keyboard_handler_exists: string;
+    img_alt_decorative: string;
+    aria_search_label_unique: string;
+    aria_application_label_unique: string;
+    aria_application_labelled: string;
+    aria_document_label_unique: string;
+    WCAG20_Label_TargetInvisible: string;
+    caption_track_exists: string;
+    media_keyboard_controllable: string;
+    HAAC_Input_HasRequired: string;
+    aria_img_labelled: string;
+    img_alt_background: string;
+    element_accesskey_labelled: string;
+    aria_attribute_conflict: string;
+    canvas_content_described: string;
+    figure_label_exists: string;
+    input_placeholder_label_visible: string;
+    form_submit_review: string;
+    text_contrast_sufficient: string;
+    text_contrast_sufficient_PV: string;
+    skip_main_exists: string;
+    skip_main_described: string;
+    aria_child_valid: string;
+    aria_parent_required: string;
+    aria_eventhandler_role_valid: string;
+    aria_widget_labelled: string;
+    aria_content_in_landmark: string;
+    aria_region_labelled: string;
+    aria_main_label_visible: string;
+    aria_banner_label_unique: string;
+    aria_complementary_label_unique: string;
+    aria_contentinfo_label_unique: string;
+    aria_form_label_unique: string;
+    aria_navigation_label_unique: string;
+    aria_complementary_label_visible: string;
+    aria_article_label_unique: string;
+    Rpt_Aria_ArticleRoleLabel_Implicit: string;
+    Rpt_Aria_MultipleGroupRoles_Implicit: string;
+    Rpt_Aria_GroupRoleLabel_Implicit: string;
+    aria_contentinfo_single: string;
+    aria_banner_single: string;
+    aria_contentinfo_misuse: string;
+    aria_complementary_labelled: string;
+    aria_region_label_unique: string;
+    widget_tabbable_exists: string;
+    widget_tabbable_single: string;
+    style_highcontrast_visible: string;
+    aria_main_label_unique: string;
+    download_keyboard_controllable: string;
+    error_message_exists: string;
+    list_children_valid: string;
+    aria_activedescendant_valid: string;
+    application_content_accessible: string;
+    aria_toolbar_label_unique: string;
+    HAAC_Combobox_ARIA_11_Guideline: string;
+    HAAC_Combobox_Must_Have_Text_Input: string;
+    HAAC_Combobox_DOM_Focus: string;
+    HAAC_Combobox_Autocomplete: string;
+    HAAC_Combobox_Autocomplete_Invalid: string;
+    HAAC_Combobox_Expanded: string;
+    HAAC_Combobox_Popup: string;
+    style_viewport_resizable: string;
+    label_name_visible: string;
+    input_autocomplete_valid: string;
+    input_label_visible: string;
+};