@uuv/a11y 0.0.1 → 1.0.0-beta.1

package/dist/lib/model/reference.js

@@ -1,66 +1,66 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.A11yReferenceTestCoverage = exports.A11yReferenceCriteriaCoverage = exports.A11yReferenceTopicCoverage = exports.A11yReferenceCoverage = exports.Coverage = exports.Comments = exports.A11yReferenceEnum = void 0;
-var A11yReferenceEnum;
-(function (A11yReferenceEnum) {
-    A11yReferenceEnum["RGAA"] = "RGAA";
-    A11yReferenceEnum["WCAG_WEB"] = "WCAG-WEB";
-    A11yReferenceEnum["WCAG_ANDROID"] = "WCAG-ANDROID";
-    A11yReferenceEnum["WCAG_IOS"] = "WCAG-IOS";
-})(A11yReferenceEnum = exports.A11yReferenceEnum || (exports.A11yReferenceEnum = {}));
-class Comments {
-    info;
-    warning;
-    danger;
-}
-exports.Comments = Comments;
-class Coverage {
-    id;
-    name;
-    auto = 0;
-    partial = 0;
-    wontBeImplemented = 0;
-    manual = 0;
-    inProgress = 0;
-    testsCount = 0;
-    comments;
-    autoPercentage() {
-        return Math.round(this.auto /
-            (this.testsCount) * 100) || 0;
-    }
-}
-exports.Coverage = Coverage;
-class A11yReferenceCoverage {
-    name;
-    topics = [];
-    constructor(name) {
-        this.name = name;
-    }
-}
-exports.A11yReferenceCoverage = A11yReferenceCoverage;
-class A11yReferenceTopicCoverage extends Coverage {
-    criterias = [];
-    constructor(id, name) {
-        super();
-        this.id = id;
-        this.name = name;
-    }
-}
-exports.A11yReferenceTopicCoverage = A11yReferenceTopicCoverage;
-class A11yReferenceCriteriaCoverage extends Coverage {
-    tests = [];
-    constructor(id, name) {
-        super();
-        this.id = id;
-        this.name = name;
-    }
-}
-exports.A11yReferenceCriteriaCoverage = A11yReferenceCriteriaCoverage;
-class A11yReferenceTestCoverage extends Coverage {
-    constructor(id, name) {
-        super();
-        this.id = id;
-        this.name = name;
-    }
-}
-exports.A11yReferenceTestCoverage = A11yReferenceTestCoverage;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.A11yReferenceTestCoverage = exports.A11yReferenceCriteriaCoverage = exports.A11yReferenceTopicCoverage = exports.A11yReferenceCoverage = exports.Coverage = exports.Comments = exports.A11yReferenceEnum = void 0;
+var A11yReferenceEnum;
+(function (A11yReferenceEnum) {
+    A11yReferenceEnum["RGAA"] = "RGAA";
+    A11yReferenceEnum["WCAG_WEB"] = "WCAG-WEB";
+    A11yReferenceEnum["WCAG_ANDROID"] = "WCAG-ANDROID";
+    A11yReferenceEnum["WCAG_IOS"] = "WCAG-IOS";
+})(A11yReferenceEnum = exports.A11yReferenceEnum || (exports.A11yReferenceEnum = {}));
+class Comments {
+    info;
+    warning;
+    danger;
+}
+exports.Comments = Comments;
+class Coverage {
+    id;
+    name;
+    auto = 0;
+    partial = 0;
+    wontBeImplemented = 0;
+    manual = 0;
+    inProgress = 0;
+    testsCount = 0;
+    comments;
+    autoPercentage() {
+        return Math.round(this.auto /
+            (this.testsCount) * 100) || 0;
+    }
+}
+exports.Coverage = Coverage;
+class A11yReferenceCoverage {
+    name;
+    topics = [];
+    constructor(name) {
+        this.name = name;
+    }
+}
+exports.A11yReferenceCoverage = A11yReferenceCoverage;
+class A11yReferenceTopicCoverage extends Coverage {
+    criterias = [];
+    constructor(id, name) {
+        super();
+        this.id = id;
+        this.name = name;
+    }
+}
+exports.A11yReferenceTopicCoverage = A11yReferenceTopicCoverage;
+class A11yReferenceCriteriaCoverage extends Coverage {
+    tests = [];
+    constructor(id, name) {
+        super();
+        this.id = id;
+        this.name = name;
+    }
+}
+exports.A11yReferenceCriteriaCoverage = A11yReferenceCriteriaCoverage;
+class A11yReferenceTestCoverage extends Coverage {
+    constructor(id, name) {
+        super();
+        this.id = id;
+        this.name = name;
+    }
+}
+exports.A11yReferenceTestCoverage = A11yReferenceTestCoverage;

package/dist/lib/model/result.d.ts

@@ -1,57 +1,57 @@
-import { A11yRule } from "./rule";
-import { A11yReference } from "./reference";
-export declare enum A11yResultStatus {
-    UNKNOWN = "unknown",
-    SUCCESS = "success",
-    MANUAL = "manual",
-    ERROR = "error"
-}
-export interface NonCompliantNode {
-    node?: HTMLElement;
-    selector: string;
-    html?: string;
-}
-export interface NodeToCheckManually {
-    node: HTMLElement;
-    selector: string;
-    attributes: string;
-    html: string;
-    help: string;
-}
-export declare class A11yRuleValidationResult {
-    readonly criteria: string;
-    status: A11yResultStatus;
-    errorNodes: NonCompliantNode[];
-    nodesToCheckManually: NodeToCheckManually[];
-    constructor(criteria: string);
-}
-export declare class A11yRuleResult {
-    readonly url: string;
-    readonly rule: A11yRule;
-    status: A11yResultStatus;
-    validations: A11yRuleValidationResult[];
-    constructor(url: string, rule: A11yRule);
-    getOrAddValidation(criteria: string): A11yRuleValidationResult;
-    getErrorNodes(): NonCompliantNode[];
-    getNodesToCheckManually(): NodeToCheckManually[];
-    computeStatus(): void;
-    private getStatus;
-}
-export declare class A11yResult {
-    readonly url: string;
-    readonly reference: A11yReference;
-    status: A11yResultStatus;
-    ruleResults: A11yRuleResult[];
-    constructor(url: string, reference: A11yReference);
-    computeStatus(): void;
-    summary(): {
-        status: A11yResultStatus;
-        criteria: {};
-    };
-    private buildSummaryForCriterion;
-    private getPosition;
-    private groupRuleResultByLevel;
-    private getKeyOfLevel;
-    private groupRuleResultByCriterion;
-    private groupRuleResultByTestOfACriterion;
-}
+import { A11yRule } from "./rule";
+import { A11yReference } from "./reference";
+export declare enum A11yResultStatus {
+    UNKNOWN = "unknown",
+    SUCCESS = "success",
+    MANUAL = "manual",
+    ERROR = "error"
+}
+export interface NonCompliantNode {
+    node?: HTMLElement;
+    selector: string;
+    html?: string;
+}
+export interface NodeToCheckManually {
+    node: HTMLElement;
+    selector: string;
+    attributes: string;
+    html: string;
+    help: string;
+}
+export declare class A11yRuleValidationResult {
+    readonly criteria: string;
+    status: A11yResultStatus;
+    errorNodes: NonCompliantNode[];
+    nodesToCheckManually: NodeToCheckManually[];
+    constructor(criteria: string);
+}
+export declare class A11yRuleResult {
+    readonly url: string;
+    readonly rule: A11yRule;
+    status: A11yResultStatus;
+    validations: A11yRuleValidationResult[];
+    constructor(url: string, rule: A11yRule);
+    getOrAddValidation(criteria: string): A11yRuleValidationResult;
+    getErrorNodes(): NonCompliantNode[];
+    getNodesToCheckManually(): NodeToCheckManually[];
+    computeStatus(): void;
+    private getStatus;
+}
+export declare class A11yResult {
+    readonly url: string;
+    readonly reference: A11yReference;
+    status: A11yResultStatus;
+    ruleResults: A11yRuleResult[];
+    constructor(url: string, reference: A11yReference);
+    computeStatus(): void;
+    summary(): {
+        status: A11yResultStatus;
+        criteria: {};
+    };
+    private buildSummaryForCriterion;
+    private getPosition;
+    private groupRuleResultByLevel;
+    private getKeyOfLevel;
+    private groupRuleResultByCriterion;
+    private groupRuleResultByTestOfACriterion;
+}

package/dist/lib/model/result.js

@@ -1,144 +1,144 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.A11yResult = exports.A11yRuleResult = exports.A11yRuleValidationResult = exports.A11yResultStatus = void 0;
-var A11yResultStatus;
-(function (A11yResultStatus) {
-    A11yResultStatus["UNKNOWN"] = "unknown";
-    A11yResultStatus["SUCCESS"] = "success";
-    A11yResultStatus["MANUAL"] = "manual";
-    A11yResultStatus["ERROR"] = "error";
-})(A11yResultStatus = exports.A11yResultStatus || (exports.A11yResultStatus = {}));
-class A11yRuleValidationResult {
-    criteria;
-    status = A11yResultStatus.UNKNOWN;
-    errorNodes = [];
-    nodesToCheckManually = [];
-    constructor(criteria) {
-        this.criteria = criteria;
-    }
-}
-exports.A11yRuleValidationResult = A11yRuleValidationResult;
-class A11yRuleResult {
-    url;
-    rule;
-    status = A11yResultStatus.UNKNOWN;
-    validations = [];
-    constructor(url, rule) {
-        this.url = url;
-        this.rule = rule;
-    }
-    getOrAddValidation(criteria) {
-        let validation = this.validations.find(value => value.criteria === criteria);
-        if (!validation) {
-            validation = new A11yRuleValidationResult(criteria);
-            this.validations.push(validation);
-        }
-        return validation;
-    }
-    getErrorNodes() {
-        let nodeFound = [];
-        this.validations.forEach(validation => {
-            nodeFound = nodeFound.concat(validation.errorNodes);
-        });
-        return nodeFound;
-    }
-    getNodesToCheckManually() {
-        let nodeFound = [];
-        this.validations.forEach(validation => {
-            nodeFound = nodeFound.concat(validation.nodesToCheckManually);
-        });
-        return nodeFound;
-    }
-    computeStatus() {
-        this.status = this.getStatus();
-    }
-    getStatus() {
-        if (this.validations.find(validation => validation.status === A11yResultStatus.UNKNOWN)) {
-            return A11yResultStatus.UNKNOWN;
-        }
-        if (this.validations.find(validation => validation.status === A11yResultStatus.ERROR)) {
-            return A11yResultStatus.ERROR;
-        }
-        if (this.validations.find(validation => validation.status === A11yResultStatus.MANUAL)) {
-            return A11yResultStatus.MANUAL;
-        }
-        return A11yResultStatus.SUCCESS;
-    }
-}
-exports.A11yRuleResult = A11yRuleResult;
-class A11yResult {
-    url;
-    reference;
-    status = A11yResultStatus.UNKNOWN;
-    ruleResults = [];
-    constructor(url, reference) {
-        this.url = url;
-        this.reference = reference;
-    }
-    computeStatus() {
-        this.status = computeStatus(this.ruleResults);
-    }
-    summary() {
-        const summary = {
-            status: this.status,
-            criteria: {}
-        };
-        this.groupRuleResultByCriterion().forEach((rulesResult, key) => {
-            summary.criteria[key] = this.buildSummaryForCriterion(key, rulesResult);
-        });
-        return summary;
-    }
-    buildSummaryForCriterion(criterion, criterionRulesResult) {
-        const criterionSummary = {
-            status: computeStatus(criterionRulesResult),
-            tests: {}
-        };
-        this.groupRuleResultByTestOfACriterion(criterion).forEach((rulesResult, key) => {
-            criterionSummary.tests[key] = {
-                status: computeStatus(rulesResult)
-            };
-        });
-        return criterionSummary;
-    }
-    getPosition(inputString, subString, index) {
-        return inputString.split(subString, index).join(subString).length;
-    }
-    groupRuleResultByLevel(ruleResults, level) {
-        const ruleResultPerCriteria = new Map();
-        ruleResults.forEach(ruleResult => {
-            const key = this.getKeyOfLevel(ruleResult, level);
-            if (!ruleResultPerCriteria.has(key)) {
-                ruleResultPerCriteria.set(key, []);
-            }
-            ruleResultPerCriteria.get(key)?.push(ruleResult);
-        });
-        return ruleResultPerCriteria;
-    }
-    getKeyOfLevel(ruleResult, level) {
-        const nextLevelPosition = this.getPosition(ruleResult.rule.id, ".", level + 1);
-        return ruleResult.rule.id.substring(0, nextLevelPosition > 0 ? nextLevelPosition : undefined);
-    }
-    groupRuleResultByCriterion() {
-        return this.groupRuleResultByLevel(this.ruleResults, 1);
-    }
-    groupRuleResultByTestOfACriterion(criterion) {
-        return this.groupRuleResultByLevel(this.ruleResults.filter(ruleResult => criterion === this.getKeyOfLevel(ruleResult, 1)), 2);
-    }
-}
-exports.A11yResult = A11yResult;
-const computeStatus = (ruleResults) => {
-    ruleResults.forEach(ruleResult => ruleResult.computeStatus());
-    return getStatus(ruleResults);
-};
-const getStatus = (ruleResults) => {
-    if (ruleResults.find(ruleResult => ruleResult.status === A11yResultStatus.UNKNOWN)) {
-        return A11yResultStatus.UNKNOWN;
-    }
-    if (ruleResults.find(ruleResult => ruleResult.status === A11yResultStatus.ERROR)) {
-        return A11yResultStatus.ERROR;
-    }
-    if (ruleResults.find(ruleResult => ruleResult.status === A11yResultStatus.MANUAL)) {
-        return A11yResultStatus.MANUAL;
-    }
-    return A11yResultStatus.SUCCESS;
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.A11yResult = exports.A11yRuleResult = exports.A11yRuleValidationResult = exports.A11yResultStatus = void 0;
+var A11yResultStatus;
+(function (A11yResultStatus) {
+    A11yResultStatus["UNKNOWN"] = "unknown";
+    A11yResultStatus["SUCCESS"] = "success";
+    A11yResultStatus["MANUAL"] = "manual";
+    A11yResultStatus["ERROR"] = "error";
+})(A11yResultStatus = exports.A11yResultStatus || (exports.A11yResultStatus = {}));
+class A11yRuleValidationResult {
+    criteria;
+    status = A11yResultStatus.UNKNOWN;
+    errorNodes = [];
+    nodesToCheckManually = [];
+    constructor(criteria) {
+        this.criteria = criteria;
+    }
+}
+exports.A11yRuleValidationResult = A11yRuleValidationResult;
+class A11yRuleResult {
+    url;
+    rule;
+    status = A11yResultStatus.UNKNOWN;
+    validations = [];
+    constructor(url, rule) {
+        this.url = url;
+        this.rule = rule;
+    }
+    getOrAddValidation(criteria) {
+        let validation = this.validations.find(value => value.criteria === criteria);
+        if (!validation) {
+            validation = new A11yRuleValidationResult(criteria);
+            this.validations.push(validation);
+        }
+        return validation;
+    }
+    getErrorNodes() {
+        let nodeFound = [];
+        this.validations.forEach(validation => {
+            nodeFound = nodeFound.concat(validation.errorNodes);
+        });
+        return nodeFound;
+    }
+    getNodesToCheckManually() {
+        let nodeFound = [];
+        this.validations.forEach(validation => {
+            nodeFound = nodeFound.concat(validation.nodesToCheckManually);
+        });
+        return nodeFound;
+    }
+    computeStatus() {
+        this.status = this.getStatus();
+    }
+    getStatus() {
+        if (this.validations.find(validation => validation.status === A11yResultStatus.UNKNOWN)) {
+            return A11yResultStatus.UNKNOWN;
+        }
+        if (this.validations.find(validation => validation.status === A11yResultStatus.ERROR)) {
+            return A11yResultStatus.ERROR;
+        }
+        if (this.validations.find(validation => validation.status === A11yResultStatus.MANUAL)) {
+            return A11yResultStatus.MANUAL;
+        }
+        return A11yResultStatus.SUCCESS;
+    }
+}
+exports.A11yRuleResult = A11yRuleResult;
+class A11yResult {
+    url;
+    reference;
+    status = A11yResultStatus.UNKNOWN;
+    ruleResults = [];
+    constructor(url, reference) {
+        this.url = url;
+        this.reference = reference;
+    }
+    computeStatus() {
+        this.status = computeStatus(this.ruleResults);
+    }
+    summary() {
+        const summary = {
+            status: this.status,
+            criteria: {}
+        };
+        this.groupRuleResultByCriterion().forEach((rulesResult, key) => {
+            summary.criteria[key] = this.buildSummaryForCriterion(key, rulesResult);
+        });
+        return summary;
+    }
+    buildSummaryForCriterion(criterion, criterionRulesResult) {
+        const criterionSummary = {
+            status: computeStatus(criterionRulesResult),
+            tests: {}
+        };
+        this.groupRuleResultByTestOfACriterion(criterion).forEach((rulesResult, key) => {
+            criterionSummary.tests[key] = {
+                status: computeStatus(rulesResult)
+            };
+        });
+        return criterionSummary;
+    }
+    getPosition(inputString, subString, index) {
+        return inputString.split(subString, index).join(subString).length;
+    }
+    groupRuleResultByLevel(ruleResults, level) {
+        const ruleResultPerCriteria = new Map();
+        ruleResults.forEach(ruleResult => {
+            const key = this.getKeyOfLevel(ruleResult, level);
+            if (!ruleResultPerCriteria.has(key)) {
+                ruleResultPerCriteria.set(key, []);
+            }
+            ruleResultPerCriteria.get(key)?.push(ruleResult);
+        });
+        return ruleResultPerCriteria;
+    }
+    getKeyOfLevel(ruleResult, level) {
+        const nextLevelPosition = this.getPosition(ruleResult.rule.id, ".", level + 1);
+        return ruleResult.rule.id.substring(0, nextLevelPosition > 0 ? nextLevelPosition : undefined);
+    }
+    groupRuleResultByCriterion() {
+        return this.groupRuleResultByLevel(this.ruleResults, 1);
+    }
+    groupRuleResultByTestOfACriterion(criterion) {
+        return this.groupRuleResultByLevel(this.ruleResults.filter(ruleResult => criterion === this.getKeyOfLevel(ruleResult, 1)), 2);
+    }
+}
+exports.A11yResult = A11yResult;
+const computeStatus = (ruleResults) => {
+    ruleResults.forEach(ruleResult => ruleResult.computeStatus());
+    return getStatus(ruleResults);
+};
+const getStatus = (ruleResults) => {
+    if (ruleResults.find(ruleResult => ruleResult.status === A11yResultStatus.UNKNOWN)) {
+        return A11yResultStatus.UNKNOWN;
+    }
+    if (ruleResults.find(ruleResult => ruleResult.status === A11yResultStatus.ERROR)) {
+        return A11yResultStatus.ERROR;
+    }
+    if (ruleResults.find(ruleResult => ruleResult.status === A11yResultStatus.MANUAL)) {
+        return A11yResultStatus.MANUAL;
+    }
+    return A11yResultStatus.SUCCESS;
+};