accessibility-checker 3.1.53 → 3.1.55

package/lib/common/engine/IReport.d.ts

@@ -0,0 +1,166 @@
+/******************************************************************************
+     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 { eRuleLevel } from "../config/IConfig";
+export declare enum eRuleConfidence {
+    PASS = "PASS",
+    FAIL = "FAIL",
+    POTENTIAL = "POTENTIAL",
+    MANUAL = "MANUAL"
+}
+export declare enum eRulePolicy {
+    VIOLATION = "VIOLATION",
+    RECOMMENDATION = "RECOMMENDATION",
+    INFORMATION = "INFORMATION"
+}
+export declare enum eToolkitLevel {
+    LEVEL_ONE = "1",
+    LEVEL_TWO = "2",
+    LEVEL_THREE = "3",
+    LEVEL_FOUR = "4"
+}
+export declare enum eRuleCategory {
+    ACCESSIBILITY = "Accessibility",
+    DESIGN = "Design",
+    OTHER = "Other"
+}
+export declare enum eRulesetType {
+    DEFAULT = "default",
+    EXTENSION = "extension"
+}
+export interface Bounds {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export interface IRuleset {
+    id: string;
+    name: string;
+    category: eRuleCategory;
+    description: string;
+    type?: eRulesetType;
+    checkpoints: Array<{
+        num: string;
+        scId?: string;
+        name: string;
+        wcagLevel: string;
+        summary: string;
+        rules?: Array<{
+            id: string;
+            level: eRulePolicy;
+            toolkitLevel: eToolkitLevel;
+        }>;
+    }>;
+}
+export interface IEngineReport {
+    results: IEngineResult[];
+    numExecuted: number;
+    ruleTime: number;
+    totalTime?: number;
+    screenshot?: string;
+    nls?: {
+        [ruleId: string]: {
+            [reasonId: string]: string;
+        };
+    };
+}
+export interface IEngineResult {
+    category?: eRuleCategory;
+    ruleId: string;
+    value: [eRulePolicy, eRuleConfidence];
+    reasonId?: number | string;
+    messageArgs?: string[];
+    apiArgs?: any[];
+    node?: Node;
+    path: {
+        [ns: string]: string;
+    };
+    ruleTime: number;
+    message: string;
+    bounds?: Bounds;
+    snippet: string;
+    help?: string;
+}
+export interface IBaselineResult extends IEngineResult {
+    ignored: boolean;
+    help: string;
+    level: eRuleLevel;
+}
+export interface IBaselineReport {
+    results: IBaselineResult[];
+    numExecuted: number;
+    nls: {
+        [ruleId: string]: {
+            [reasonId: string]: string;
+        };
+    };
+    summary: {
+        counts: {
+            violation: number;
+            potentialviolation: number;
+            recommendation: number;
+            potentialrecommendation: number;
+            manual: number;
+            pass: number;
+            ignored: number;
+            elements: number;
+            elementsViolation: number;
+            elementsViolationReview: number;
+        };
+        scanTime: number;
+        ruleArchive: string;
+        policies: string[];
+        reportLevels: string[];
+        startScan: number;
+        URL: string;
+    };
+    scanID: string;
+    toolID: string;
+    label: string;
+}
+export type CompressedReport = [
+    number,
+    string,
+    string,
+    string,
+    string,
+    number,
+    number,
+    string,
+    string[],
+    string[],
+    CompressedIssue[]
+];
+export type CompressedIssue = [
+    // results
+    eRuleCategory | undefined,
+    string,
+    [
+        eRulePolicy,
+        eRuleConfidence
+    ],
+    // value
+    number | string | undefined,
+    string[],
+    {
+        [ns: string]: string;
+    },
+    number,
+    string,
+    string,
+    boolean,
+    string
+];

package/lib/common/engine/IReport.js

@@ -0,0 +1,50 @@
+"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.eRulesetType = exports.eRuleCategory = exports.eToolkitLevel = exports.eRulePolicy = exports.eRuleConfidence = void 0;
+var eRuleConfidence;
+(function (eRuleConfidence) {
+    eRuleConfidence["PASS"] = "PASS";
+    eRuleConfidence["FAIL"] = "FAIL";
+    eRuleConfidence["POTENTIAL"] = "POTENTIAL";
+    eRuleConfidence["MANUAL"] = "MANUAL";
+})(eRuleConfidence || (exports.eRuleConfidence = eRuleConfidence = {}));
+var eRulePolicy;
+(function (eRulePolicy) {
+    eRulePolicy["VIOLATION"] = "VIOLATION";
+    eRulePolicy["RECOMMENDATION"] = "RECOMMENDATION";
+    eRulePolicy["INFORMATION"] = "INFORMATION";
+})(eRulePolicy || (exports.eRulePolicy = eRulePolicy = {}));
+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 eRuleCategory;
+(function (eRuleCategory) {
+    eRuleCategory["ACCESSIBILITY"] = "Accessibility";
+    eRuleCategory["DESIGN"] = "Design";
+    eRuleCategory["OTHER"] = "Other";
+})(eRuleCategory || (exports.eRuleCategory = eRuleCategory = {}));
+var eRulesetType;
+(function (eRulesetType) {
+    eRulesetType["DEFAULT"] = "default";
+    eRulesetType["EXTENSION"] = "extension";
+})(eRulesetType || (exports.eRulesetType = eRulesetType = {}));
+//# sourceMappingURL=IReport.js.map

package/lib/common/engine/IReport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IReport.js","sourceRoot":"","sources":["../../../../src-ts/lib/common/engine/IReport.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E;;;AAK/E,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,gCAAa,CAAA;IACb,gCAAa,CAAA;IACb,0CAAuB,CAAA;IACvB,oCAAiB,CAAA;AACrB,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAED,IAAY,WAIX;AAJD,WAAY,WAAW;IACnB,sCAAuB,CAAA;IACvB,gDAAiC,CAAA;IACjC,0CAA2B,CAAA;AAC/B,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAED,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,aAIX;AAJD,WAAY,aAAa;IACrB,gDAA+B,CAAA;IAC/B,kCAAiB,CAAA;IACjB,gCAAe,CAAA;AACnB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAED,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;AAC3B,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}

package/lib/common/engine/IRuleset.d.ts

@@ -0,0 +1,35 @@
+/******************************************************************************
+    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 { eRuleCategory, eRulePolicy, eRulesetType, eToolkitLevel } from "./IReport";
+export interface IRuleset {
+    id: string;
+    name: string;
+    category: eRuleCategory;
+    description: string;
+    type?: eRulesetType;
+    checkpoints: Array<{
+        num: string;
+        scId?: string;
+        name: string;
+        wcagLevel: string;
+        summary: string;
+        rules?: Array<{
+            id: string;
+            level: eRulePolicy;
+            toolkitLevel: eToolkitLevel;
+        }>;
+    }>;
+}

package/lib/common/engine/IRuleset.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=IRuleset.js.map

package/lib/common/engine/IRuleset.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "accessibility-checker",
-  "version": "3.1.53",
+  "version": "3.1.55",
   "description": "An automated testing tools for accessibility testing using Puppeteer, Selenium, or Zombie",
   "main": "index.js",
   "scripts": {