accessibility-checker 4.0.1 → 4.0.2

package/cjs/lib/common/config/IArchive.d.ts

@@ -0,0 +1,37 @@
+/******************************************************************************
+     Copyright:: 2023- 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.
+ *****************************************************************************/
+export interface IArchive {
+    id: "latest" | "preview" | "versioned" | string;
+    name: string;
+    path: string;
+    policies: Array<{
+        id: string;
+        name: string;
+        description: string;
+    }>;
+    rulesets: {
+        [key: string]: Array<{
+            id: string;
+            name: string;
+            description: string;
+        }>;
+    };
+    version: string;
+    latest?: boolean;
+    sunset?: boolean;
+    helpPath: string;
+    enginePath: string;
+}

package/cjs/lib/common/config/IArchive.js

@@ -0,0 +1,18 @@
+"use strict";
+/******************************************************************************
+     Copyright:: 2023- 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.
+ *****************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IArchive.js.map

package/cjs/lib/common/config/IArchive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IArchive.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/config/IArchive.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E"}

package/cjs/lib/common/config/IConfig.d.ts

@@ -0,0 +1,152 @@
+/******************************************************************************
+     Copyright:: 2023- 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 { IArchive } from "./IArchive.js";
+export declare enum eAssertResult {
+    ERROR = -1,
+    PASS = 0,
+    BASELINE_MISMATCH = 1,
+    FAIL = 2
+}
+export declare enum eRuleLevel {
+    violation = "violation",
+    potentialviolation = "potentialviolation",
+    recommendation = "recommendation",
+    potentialrecommendation = "potentialrecommendation",
+    manual = "manual",
+    pass = "pass",
+    ignored = "ignored"
+}
+export interface IConfig {
+    /**
+     * (optional) Specify the rule archive
+     *
+     * Run `npx achecker archives` for a list of valid ruleArchive ids and policy ids
+     * Default: "latest"
+     */
+    ruleArchive?: "latest" | "preview" | "versioned" | string;
+    /**
+     * (optional) Specify one or many policies to scan.
+     *
+     * Run `npx achecker archives` for a list of valid ruleArchive ids and policy ids
+     * Default: ["IBM_Accessibility"]
+     */
+    policies?: Array<"IBM_Accessibility" | string>;
+    /**
+     * (optional) Specify one or many violation levels on which to fail the test
+     *
+     * i.e. If specified violation then the testcase will only fail if
+     * a violation is found during the scan.
+     * Default: ["violation", "review"]
+     */
+    failLevels?: eRuleLevel[];
+    /**
+     * (optional) Specify one or many 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.
+     * Default: ["violation", "review"]
+     */
+    reportLevels?: eRuleLevel[];
+    /**
+     * (optional) In which fornats should the results be output
+     * Default: ["json"]
+     */
+    outputFormat?: Array<"json" | "html" | "csv" | "disable" | "xlsx">;
+    /**
+     * (optional) Specify any labels that you would like associated to your scan
+     * Default: []
+     */
+    label?: string[];
+    /**
+     * (optional) Where the scan results should be saved.
+     * Default: "results"
+     */
+    outputFolder?: string;
+    /**
+     * (optional) Should the timestamp be included in the filename of the reports?
+     * Default: true
+     */
+    outputFilenameTimestamp?: boolean;
+    /**
+     * (optional) Where the baseline results should be loaded from
+     * Default: "baselines"
+     */
+    baselineFolder?: string;
+    /**
+     * (optional) Where the tool can read/write cached files (ace-node.js / archive.json)
+     * Default: `${os.tmpdir()}/accessibility-checker/`
+     */
+    cacheFolder?: string;
+    /**
+     * (optional) For tools that scan files, which extensions should we include
+     * Default: ["html", "htm", "svg"]
+     */
+    extensions?: string[];
+}
+export type IConfigInternal = IConfig & {
+    /**
+     * Run in debug mode
+     */
+    DEBUG?: boolean;
+    /**
+     * Spot to store parsed archive file
+     */
+    ruleArchiveSet?: IArchive[];
+    /**
+     * Label to expose to reports
+     */
+    ruleArchiveLabel?: string;
+    /**
+     * (optional) Rule server to pull the rules from and to use for help
+     * Default: "https://able.ibm.com/rules"
+     */
+    ruleServer?: string;
+    /**
+     * Path to the rule pack
+     */
+    rulePack?: string;
+    /**
+     * Path within the archive
+     */
+    ruleArchivePath?: string;
+    /**
+     * Version number of the selected archive
+     */
+    ruleArchiveVersion?: string;
+    /**
+     * (optional) If the tool allows, should we capture screenshots
+     */
+    captureScreenshots?: boolean;
+    /**
+     * (optional) If the tool allows, should we run headless
+     */
+    headless?: "shell" | boolean;
+    /**
+     * (optional) If the tool allows, set the maximum number of tabs to open
+     */
+    maxTabs?: number;
+    /**
+     * Configuration filenames to try loading
+     */
+    configFiles?: string[];
+    toolID?: string;
+    toolName?: string;
+    toolVersion?: string;
+    scanID?: string;
+    ignoreHTTPSErrors: boolean;
+    perfMetrics: boolean;
+    engineMode: "DEFAULT" | "REMOTE" | "INJECT";
+};

package/cjs/lib/common/config/IConfig.js

@@ -0,0 +1,36 @@
+"use strict";
+/******************************************************************************
+     Copyright:: 2023- 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.
+ *****************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eRuleLevel = exports.eAssertResult = void 0;
+var eAssertResult;
+(function (eAssertResult) {
+    eAssertResult[eAssertResult["ERROR"] = -1] = "ERROR";
+    eAssertResult[eAssertResult["PASS"] = 0] = "PASS";
+    eAssertResult[eAssertResult["BASELINE_MISMATCH"] = 1] = "BASELINE_MISMATCH";
+    eAssertResult[eAssertResult["FAIL"] = 2] = "FAIL";
+})(eAssertResult || (exports.eAssertResult = eAssertResult = {}));
+var eRuleLevel;
+(function (eRuleLevel) {
+    eRuleLevel["violation"] = "violation";
+    eRuleLevel["potentialviolation"] = "potentialviolation";
+    eRuleLevel["recommendation"] = "recommendation";
+    eRuleLevel["potentialrecommendation"] = "potentialrecommendation";
+    eRuleLevel["manual"] = "manual";
+    eRuleLevel["pass"] = "pass";
+    eRuleLevel["ignored"] = "ignored";
+})(eRuleLevel || (exports.eRuleLevel = eRuleLevel = {}));
+//# sourceMappingURL=IConfig.js.map

package/cjs/lib/common/config/IConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IConfig.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/config/IConfig.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E;;;AAI/E,IAAY,aAKX;AALD,WAAY,aAAa;IACrB,oDAAU,CAAA;IACV,iDAAQ,CAAA;IACR,2EAAqB,CAAA;IACrB,iDAAQ,CAAA;AACZ,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB;AAGD,IAAY,UAQX;AARD,WAAY,UAAU;IAClB,qCAAuB,CAAA;IACvB,uDAAyC,CAAA;IACzC,+CAAiC,CAAA;IACjC,iEAAmD,CAAA;IACnD,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,iCAAmB,CAAA;AACvB,CAAC,EARW,UAAU,0BAAV,UAAU,QAQrB"}

package/cjs/lib/common/engine/IBounds.d.ts

@@ -0,0 +1,21 @@
+/******************************************************************************
+     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.
+ *****************************************************************************/
+export type Bounds = {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+};

package/cjs/lib/common/engine/IBounds.js

@@ -0,0 +1,18 @@
+"use strict";
+/******************************************************************************
+     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.
+ *****************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IBounds.js.map

package/cjs/lib/common/engine/IBounds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBounds.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/engine/IBounds.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E"}

package/cjs/lib/common/engine/IChecker.d.ts

@@ -0,0 +1,23 @@
+/******************************************************************************
+     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 { Guideline } from "./IGuideline.js";
+import { IEngineReport } from "./IReport.js";
+export interface IChecker {
+    addGuideline(guideline: Guideline): any;
+    getGuidelines(): Guideline[];
+    getGuidelineIds(): string[];
+    check(node: Node | Document, guidelineIds?: string | string[]): Promise<IEngineReport>;
+}

package/cjs/lib/common/engine/IChecker.js

@@ -0,0 +1,18 @@
+"use strict";
+/******************************************************************************
+     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.
+ *****************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IChecker.js.map

package/cjs/lib/common/engine/IChecker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IChecker.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/engine/IChecker.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E"}

package/cjs/lib/common/engine/IEngine.d.ts

@@ -0,0 +1,39 @@
+/******************************************************************************
+     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 { Rule } from "./IRule.js";
+export interface IEngine {
+    /**
+     * Perform a scan on a document or subtree
+     * @param rulesetIds Array of ruleset ids of rulesets to use for this scan
+     * @param root Document or subtree to scan
+     */
+    run(root: Document | Node, options?: {}): Promise<Report>;
+    enableRules(ruleIds: string[]): any;
+    getRule(ruleId: string): Rule;
+    getRulesIds(): string[];
+    getMessage(ruleId: string, ruleIdx: number | string, msgArgs?: string[]): string;
+    getHelp(ruleId: string, ruleIdx: number | string): string;
+    addRules(rule: Rule[]): any;
+    addRule(rule: Rule): any;
+    addNlsMap(map: NlsMap): any;
+    addHelpMap(map: NlsMap): any;
+}
+export type NlsMap = {
+    [key: string]: string[];
+};
+export type HelpMap = {
+    [key: string]: string[];
+};

package/cjs/lib/common/engine/IEngine.js

@@ -0,0 +1,18 @@
+"use strict";
+/******************************************************************************
+     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.
+ *****************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IEngine.js.map

package/cjs/lib/common/engine/IEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEngine.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/engine/IEngine.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E"}

package/cjs/lib/common/engine/IGuideline.d.ts

@@ -0,0 +1,53 @@
+/******************************************************************************
+     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 { eRulePolicy } from "./IRule.js";
+export declare enum eToolkitLevel {
+    LEVEL_ONE = "1",
+    LEVEL_TWO = "2",
+    LEVEL_THREE = "3",
+    LEVEL_FOUR = "4"
+}
+export declare enum eGuidelineCategory {
+    ACCESSIBILITY = "Accessibility",
+    DESIGN = "Design",
+    OTHER = "Other"
+}
+export declare enum eGuidelineType {
+    DEFAULT = "default",
+    EXTENSION = "extension"
+}
+export type Checkpoint = {
+    num: string;
+    scId?: string;
+    name: string;
+    wcagLevel: string;
+    summary: string;
+    rules?: Array<{
+        id: string;
+        reasonCodes?: string[];
+        level: eRulePolicy;
+        toolkitLevel: eToolkitLevel;
+        enabled?: boolean;
+    }>;
+};
+export type Guideline = {
+    id: string;
+    name: string;
+    category: eGuidelineCategory;
+    description: string;
+    type?: eGuidelineType;
+    checkpoints: Array<Checkpoint>;
+};

package/cjs/lib/common/engine/IGuideline.js

@@ -0,0 +1,37 @@
+"use strict";
+/******************************************************************************
+     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.
+ *****************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eGuidelineType = exports.eGuidelineCategory = exports.eToolkitLevel = void 0;
+var eToolkitLevel;
+(function (eToolkitLevel) {
+    eToolkitLevel["LEVEL_ONE"] = "1";
+    eToolkitLevel["LEVEL_TWO"] = "2";
+    eToolkitLevel["LEVEL_THREE"] = "3";
+    eToolkitLevel["LEVEL_FOUR"] = "4";
+})(eToolkitLevel || (exports.eToolkitLevel = eToolkitLevel = {}));
+var eGuidelineCategory;
+(function (eGuidelineCategory) {
+    eGuidelineCategory["ACCESSIBILITY"] = "Accessibility";
+    eGuidelineCategory["DESIGN"] = "Design";
+    eGuidelineCategory["OTHER"] = "Other";
+})(eGuidelineCategory || (exports.eGuidelineCategory = eGuidelineCategory = {}));
+var eGuidelineType;
+(function (eGuidelineType) {
+    eGuidelineType["DEFAULT"] = "default";
+    eGuidelineType["EXTENSION"] = "extension";
+})(eGuidelineType || (exports.eGuidelineType = eGuidelineType = {}));
+//# sourceMappingURL=IGuideline.js.map

package/cjs/lib/common/engine/IGuideline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IGuideline.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/engine/IGuideline.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E;;;AAI/E,IAAY,aAKX;AALD,WAAY,aAAa;IACrB,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,kCAAiB,CAAA;IACjB,iCAAgB,CAAA;AACpB,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,qDAA+B,CAAA;IAC/B,uCAAiB,CAAA;IACjB,qCAAe,CAAA;AACnB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,qCAAmB,CAAA;IACnB,yCAAuB,CAAA;AAC3B,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB"}

package/cjs/lib/common/engine/IMapper.d.ts

@@ -0,0 +1,32 @@
+/******************************************************************************
+     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 { Bounds } from "./IBounds.js";
+export type IMapResult = {
+    node: Node;
+    namespace: string;
+    role: string;
+    rolePath: string;
+    attributes: {
+        [key: string]: string;
+    };
+    bounds?: Bounds;
+};
+export interface IMapper {
+    reset(node: Node): void;
+    openScope(node: Node): IMapResult[];
+    closeScope(node: Node): IMapResult[];
+    getNamespace(): string;
+}

package/cjs/lib/common/engine/IMapper.js

@@ -0,0 +1,18 @@
+"use strict";
+/******************************************************************************
+     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.
+ *****************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IMapper.js.map

package/cjs/lib/common/engine/IMapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMapper.js","sourceRoot":"","sources":["../../../../../src-ts/lib/common/engine/IMapper.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E"}