@uuv/a11y 0.0.1 → 1.0.0-beta.10

package/dist/lib/engine/engine.js

@@ -1,123 +1,135 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Engine = void 0;
-const rxjs_1 = require("rxjs");
-const model_1 = require("../model/");
-class Engine {
-    targetUrl;
-    reference;
-    constructor(targetUrl, reference) {
-        this.targetUrl = targetUrl;
-        this.reference = reference;
-    }
-    buildCheckListItemFromRule(rule) {
-        return new rxjs_1.Observable(observer => {
-            const foundElements = rule.query.execute();
-            const result = this.getRuleResult(rule, foundElements);
-            observer.next(result);
-            observer.complete();
-        });
-    }
-    getRuleResult(rule, foundElements) {
-        if (rule.check === model_1.RuleCheckEnum.MANUAL) {
-            return this.buildResultForManualCheck(rule, foundElements);
-        }
-        else {
-            // Then we are considering rule as RuleCheckEnum.AUTO
-            return this.buildResultForAutoCheck(rule, foundElements);
-        }
-    }
-    buildResultForAutoCheck(rule, $el) {
-        const a11YRuleresult = new model_1.A11yRuleResult(this.targetUrl, rule);
-        if (rule.shouldNotExist) {
-            if ($el?.length > 0) {
-                for (const element of $el) {
-                    const selector = this.getSelector(element);
-                    const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
-                    validation.errorNodes.push({
-                        node: element,
-                        selector: selector,
-                        html: element.outerHTML
-                    });
-                    validation.status = model_1.A11yResultStatus.ERROR;
-                }
-            }
-            else {
-                const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
-                validation.status = model_1.A11yResultStatus.SUCCESS;
-            }
-        }
-        else {
-            if ($el.length === 0 && !rule.elementType.includes("warning") && !rule.elementType.includes("obsolete")) {
-                const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
-                validation.status = model_1.A11yResultStatus.ERROR;
-                validation.errorNodes.push({
-                    selector: rule.query.getSelector(),
-                });
-            }
-            else {
-                const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
-                validation.status = model_1.A11yResultStatus.SUCCESS;
-            }
-        }
-        return a11YRuleresult;
-    }
-    buildResultForManualCheck(rule, $el) {
-        const a11YRuleresult = new model_1.A11yRuleResult(this.targetUrl, rule);
-        const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
-        validation.status = model_1.A11yResultStatus.SUCCESS;
-        for (let i = 0; i < $el.length; i++) {
-            const selector = this.getSelector($el[i]);
-            const attributesToCheck = [];
-            rule.attributes.forEach((attribute) => {
-                const attributeFilledWithInformation = $el[i].getAttribute(attribute);
-                if (attributeFilledWithInformation) {
-                    attributesToCheck.push(` ${attribute}=${attributeFilledWithInformation}`);
-                }
-            });
-            const manualValidation = a11YRuleresult.getOrAddValidation(rule.criterion);
-            manualValidation.status = model_1.A11yResultStatus.MANUAL;
-            manualValidation.nodesToCheckManually.push({
-                node: $el[i],
-                selector: selector,
-                attributes: attributesToCheck.toString(),
-                html: $el[i].outerHTML,
-                help: rule.id ? `${this.reference.getRuleUrl(rule.id)}` : ""
-            });
-        }
-        return a11YRuleresult;
-    }
-    getSelector(element) {
-        const path = [];
-        while (element.nodeType === Node.ELEMENT_NODE) {
-            let selector = element.nodeName.toLowerCase();
-            if (element.id) {
-                selector += "#" + element.id;
-                path.unshift(selector);
-                break;
-            }
-            else if (element.getAttribute("data-testid")) {
-                selector += `[data-testid=${element.getAttribute("data-testid")}]`;
-                path.unshift(selector);
-                break;
-            }
-            else {
-                let sibling = element.previousSibling;
-                let index = 1;
-                while (sibling) {
-                    if (sibling.nodeType === Node.ELEMENT_NODE && sibling.nodeName.toLowerCase() === selector) {
-                        index++;
-                    }
-                    sibling = sibling.previousSibling;
-                }
-                if (index > 1 || element.nextSibling) {
-                    selector += ":nth-of-type(" + index + ")";
-                }
-            }
-            path.unshift(selector);
-            element = element.parentNode;
-        }
-        return path.join(" > ");
-    }
-}
-exports.Engine = Engine;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Engine = void 0;
+const rxjs_1 = require("rxjs");
+const model_1 = require("../model/");
+class Engine {
+    targetUrl;
+    reference;
+    constructor(targetUrl, reference) {
+        this.targetUrl = targetUrl;
+        this.reference = reference;
+    }
+    buildCheckListItemFromRule(rule) {
+        return new rxjs_1.Observable(observer => {
+            const foundElements = rule.query.execute();
+            const result = this.getRuleResult(rule, foundElements);
+            observer.next(result);
+            observer.complete();
+        });
+    }
+    getRuleResult(rule, queryResults) {
+        if (rule.check === model_1.RuleCheckEnum.MANUAL) {
+            return this.buildResultForManualCheck(rule, queryResults);
+        }
+        else {
+            // Then we are considering rule as RuleCheckEnum.AUTO
+            const domNodes = queryResults.map((element) => element.domNode);
+            return this.buildResultForAutoCheck(rule, domNodes);
+        }
+    }
+    buildResultForAutoCheck(rule, $el) {
+        const a11YRuleresult = new model_1.A11yRuleResult(this.targetUrl, rule);
+        if (rule.shouldNotExist) {
+            if ($el?.length > 0) {
+                for (const element of $el) {
+                    const selector = this.getSelector(element);
+                    const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
+                    validation.errorNodes.push({
+                        node: element,
+                        selector: selector,
+                        html: element.outerHTML
+                    });
+                    validation.status = model_1.A11yResultStatus.ERROR;
+                }
+            }
+            else {
+                const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
+                validation.status = model_1.A11yResultStatus.SUCCESS;
+            }
+        }
+        else {
+            if ($el.length === 0 && !rule.elementType.includes("warning") && !rule.elementType.includes("obsolete")) {
+                const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
+                validation.status = model_1.A11yResultStatus.ERROR;
+                validation.errorNodes.push({
+                    selector: rule.query.getSelector(),
+                });
+            }
+            else {
+                const validation = a11YRuleresult.getOrAddValidation(rule.criterion);
+                validation.status = model_1.A11yResultStatus.SUCCESS;
+            }
+        }
+        return a11YRuleresult;
+    }
+    buildResultForManualCheck(rule, queryResults) {
+        const a11YRuleResult = new model_1.A11yRuleResult(this.targetUrl, rule);
+        const validation = a11YRuleResult.getOrAddValidation(rule.criterion);
+        validation.status = model_1.A11yResultStatus.SUCCESS;
+        for (const element of queryResults) {
+            const domNode = element.domNode;
+            const selector = this.getSelector(domNode);
+            const attributesToCheck = [];
+            rule.attributes.forEach((attribute) => {
+                const childData = attribute.split(":");
+                if (childData.length > 1) {
+                    domNode.childNodes.forEach((childNode) => {
+                        if (childNode.nodeName === childData[1]) {
+                            attributesToCheck.push(`${attribute}=${childNode.textContent}`);
+                        }
+                    });
+                }
+                else {
+                    const attributeFilledWithInformation = domNode.getAttribute(attribute);
+                    if (attributeFilledWithInformation) {
+                        attributesToCheck.push(`${attribute}=${attributeFilledWithInformation}`);
+                    }
+                }
+            });
+            const manualValidation = a11YRuleResult.getOrAddValidation(rule.criterion);
+            manualValidation.status = model_1.A11yResultStatus.MANUAL;
+            manualValidation.nodesToCheckManually.push({
+                node: element,
+                selector: selector,
+                attributes: attributesToCheck.join(", "),
+                html: domNode.outerHTML,
+                help: rule.id ? `${this.reference.getRuleUrl(rule.id)}` : ""
+            });
+        }
+        return a11YRuleResult;
+    }
+    getSelector(element) {
+        const path = [];
+        while (element.nodeType === Node.ELEMENT_NODE) {
+            let selector = element.nodeName.toLowerCase();
+            if (element.id) {
+                selector += "#" + element.id;
+                path.unshift(selector);
+                break;
+            }
+            else if (element.getAttribute("data-testid")) {
+                selector += `[data-testid=${element.getAttribute("data-testid")}]`;
+                path.unshift(selector);
+                break;
+            }
+            else {
+                let sibling = element.previousSibling;
+                let index = 1;
+                while (sibling) {
+                    if (sibling.nodeType === Node.ELEMENT_NODE && sibling.nodeName.toLowerCase() === selector) {
+                        index++;
+                    }
+                    sibling = sibling.previousSibling;
+                }
+                if (index > 1 || element.nextSibling) {
+                    selector += ":nth-of-type(" + index + ")";
+                }
+            }
+            path.unshift(selector);
+            element = element.parentNode;
+        }
+        return path.join(" > ");
+    }
+}
+exports.Engine = Engine;

package/dist/lib/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./reference";
-export * from "./model";
-export * from "./query";
+export * from "./reference";
+export * from "./model";
+export * from "./query";

package/dist/lib/index.js

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./reference"), exports);
-__exportStar(require("./model"), exports);
-__exportStar(require("./query"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./reference"), exports);
+__exportStar(require("./model"), exports);
+__exportStar(require("./query"), exports);

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

@@ -1,14 +1,14 @@
-import { A11yReference } from "./reference";
-import { Observable } from "rxjs";
-import { A11yResult } from "./result";
-import { A11yRule } from "./rule";
-import { Engine } from "../engine/engine";
-export declare abstract class A11yChecker {
-    readonly url: string;
-    readonly engine: Engine;
-    readonly reference: A11yReference;
-    protected constructor(url: string, engine: Engine, reference: A11yReference);
-    abstract rules(): A11yRule[];
-    validate(): Observable<A11yResult>;
-    private buildCheckList;
-}
+import { A11yReference } from "./reference";
+import { Observable } from "rxjs";
+import { A11yResult } from "./result";
+import { A11yRule } from "./rule";
+import { Engine } from "../engine/engine";
+export declare abstract class A11yChecker {
+    readonly url: string;
+    readonly engine: Engine;
+    readonly reference: A11yReference;
+    protected constructor(url: string, engine: Engine, reference: A11yReference);
+    abstract rules(): A11yRule[];
+    validate(): Observable<A11yResult>;
+    private buildCheckList;
+}

package/dist/lib/model/checker.js

@@ -1,35 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.A11yChecker = void 0;
-const rxjs_1 = require("rxjs");
-const result_1 = require("./result");
-class A11yChecker {
-    url;
-    engine;
-    reference;
-    constructor(url, engine, reference) {
-        this.url = url;
-        this.engine = engine;
-        this.reference = reference;
-    }
-    validate() {
-        const result = new result_1.A11yResult(this.url, this.reference);
-        const rules = this.rules();
-        const checkList = this.buildCheckList(rules);
-        return (0, rxjs_1.forkJoin)(checkList)
-            .pipe((0, rxjs_1.map)((ruleResults) => {
-            result.ruleResults = ruleResults;
-            result.computeStatus();
-            return result;
-        }), (0, rxjs_1.tap)(result => {
-            console.debug("result");
-            console.debug(result);
-        }));
-    }
-    buildCheckList(rules) {
-        const checkList = [];
-        rules.forEach(rule => checkList.push(this.engine.buildCheckListItemFromRule(rule)));
-        return checkList;
-    }
-}
-exports.A11yChecker = A11yChecker;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.A11yChecker = void 0;
+const rxjs_1 = require("rxjs");
+const result_1 = require("./result");
+class A11yChecker {
+    url;
+    engine;
+    reference;
+    constructor(url, engine, reference) {
+        this.url = url;
+        this.engine = engine;
+        this.reference = reference;
+    }
+    validate() {
+        const result = new result_1.A11yResult(this.url, this.reference);
+        const rules = this.rules();
+        const checkList = this.buildCheckList(rules);
+        return (0, rxjs_1.forkJoin)(checkList)
+            .pipe((0, rxjs_1.map)((ruleResults) => {
+            result.ruleResults = ruleResults;
+            result.computeStatus();
+            return result;
+        }), (0, rxjs_1.tap)(result => {
+            console.debug("result");
+            console.debug(result);
+        }));
+    }
+    buildCheckList(rules) {
+        const checkList = [];
+        rules.forEach(rule => checkList.push(this.engine.buildCheckListItemFromRule(rule)));
+        return checkList;
+    }
+}
+exports.A11yChecker = A11yChecker;

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

@@ -1,4 +1,4 @@
-export * from "./checker";
-export * from "./reference";
-export * from "./result";
-export * from "./rule";
+export * from "./reference";
+export * from "./checker";
+export * from "./result";
+export * from "./rule";

package/dist/lib/model/index.js

@@ -1,20 +1,20 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./checker"), exports);
-__exportStar(require("./reference"), exports);
-__exportStar(require("./result"), exports);
-__exportStar(require("./rule"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./reference"), exports);
+__exportStar(require("./checker"), exports);
+__exportStar(require("./result"), exports);
+__exportStar(require("./rule"), exports);

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

@@ -1,55 +1,55 @@
-import { A11yRule } from "./rule";
-export interface A11yReference {
-    name: string;
-    version: string;
-    rules: A11yRule[];
-    url: string;
-    /**
-     * Build complete coverage
-     */
-    coverage(): A11yReferenceCoverage;
-    /**
-     * Returns online rule url related to a ruleId
-     * @param ruleId
-     */
-    getRuleUrl(ruleId: string): string;
-}
-export declare enum A11yReferenceEnum {
-    RGAA = "RGAA",
-    WCAG_WEB = "WCAG-WEB",
-    WCAG_ANDROID = "WCAG-ANDROID",
-    WCAG_IOS = "WCAG-IOS"
-}
-export declare class Comments {
-    info?: string;
-    warning?: string;
-    danger?: string;
-}
-export declare abstract class Coverage {
-    id: string;
-    name?: string;
-    auto: number;
-    partial: number;
-    wontBeImplemented: number;
-    manual: number;
-    inProgress: number;
-    testsCount: number;
-    comments?: Comments;
-    autoPercentage(): number;
-}
-export declare class A11yReferenceCoverage {
-    name: string;
-    topics: A11yReferenceTopicCoverage[];
-    constructor(name: string);
-}
-export declare class A11yReferenceTopicCoverage extends Coverage {
-    criterias: A11yReferenceCriteriaCoverage[];
-    constructor(id: any, name: any);
-}
-export declare class A11yReferenceCriteriaCoverage extends Coverage {
-    tests: A11yReferenceTestCoverage[];
-    constructor(id: any, name: any);
-}
-export declare class A11yReferenceTestCoverage extends Coverage {
-    constructor(id: any, name: any);
-}
+import { A11yRule } from "./rule";
+export interface A11yReference {
+    name: string;
+    version: string;
+    rules: A11yRule[];
+    url: string;
+    /**
+     * Build complete coverage
+     */
+    coverage(): A11yReferenceCoverage;
+    /**
+     * Returns online rule url related to a ruleId
+     * @param ruleId
+     */
+    getRuleUrl(ruleId: string): string;
+}
+export declare enum A11yReferenceEnum {
+    RGAA = "RGAA",
+    WCAG_WEB = "WCAG-WEB",
+    WCAG_ANDROID = "WCAG-ANDROID",
+    WCAG_IOS = "WCAG-IOS"
+}
+export declare class Comments {
+    info?: string;
+    warning?: string;
+    danger?: string;
+}
+export declare abstract class Coverage {
+    id: string;
+    name?: string;
+    auto: number;
+    partial: number;
+    wontBeImplemented: number;
+    manual: number;
+    inProgress: number;
+    testsCount: number;
+    comments?: Comments;
+    autoPercentage(): number;
+}
+export declare class A11yReferenceCoverage {
+    name: string;
+    topics: A11yReferenceTopicCoverage[];
+    constructor(name: string);
+}
+export declare class A11yReferenceTopicCoverage extends Coverage {
+    criterias: A11yReferenceCriteriaCoverage[];
+    constructor(id: any, name: any);
+}
+export declare class A11yReferenceCriteriaCoverage extends Coverage {
+    tests: A11yReferenceTestCoverage[];
+    constructor(id: any, name: any);
+}
+export declare class A11yReferenceTestCoverage extends Coverage {
+    constructor(id: any, name: any);
+}