@uuv/a11y 0.0.1 → 1.0.0-beta.10

package/dist/lib/query/by-tag.query.js

@@ -1,20 +1,19 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ByTagQuery = void 0;
-const jquery_1 = __importDefault(require("jquery"));
-class ByTagQuery {
-    selectors;
-    constructor(selectors) {
-        this.selectors = selectors;
-    }
-    execute() {
-        return (0, jquery_1.default)(this.selectors.join(",")).toArray();
-    }
-    getSelector() {
-        return `${this.selectors}`;
-    }
-}
-exports.ByTagQuery = ByTagQuery;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ByTagQuery = void 0;
+const _00_query_1 = require("./00-query");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const $ = require("jquery/dist/jquery.min");
+class ByTagQuery {
+    selectors;
+    constructor(selectors) {
+        this.selectors = selectors;
+    }
+    execute() {
+        return $(this.selectors.join(",")).toArray().map((element) => new _00_query_1.QueryResult(element));
+    }
+    getSelector() {
+        return `${this.selectors}`;
+    }
+}
+exports.ByTagQuery = ByTagQuery;

package/dist/lib/query/compliant-attributes/attribut-specification.d.ts

@@ -0,0 +1,25 @@
+export interface IAttributeSpecification {
+    isSatisfiedBy(element: HTMLElement, attributeName: string): boolean;
+}
+export declare class EmptyAttributeSpecification implements IAttributeSpecification {
+    isSatisfiedBy(element: HTMLElement, attributeName: string): boolean;
+}
+export declare class NotEmptyAttributeSpecification implements IAttributeSpecification {
+    isSatisfiedBy(element: HTMLElement, attributeName: string): boolean;
+}
+export declare class EmptyElementWithIdSpecification implements IAttributeSpecification {
+    isSatisfiedBy(element: HTMLElement, attributeName: string): boolean;
+}
+export declare class NotUniqueIdAttributeSpecification implements IAttributeSpecification {
+    isSatisfiedBy(element: HTMLElement, attributeName: string): boolean;
+}
+export declare class NotEqualsAttributeSpecification implements IAttributeSpecification {
+    private expectedValueList;
+    constructor(expectedValueList: string[]);
+    isSatisfiedBy(element: HTMLElement, attributeName: string): boolean;
+}
+export declare class EqualsAttributeSpecification implements IAttributeSpecification {
+    private expectedValueList;
+    constructor(expectedValueList: string[]);
+    isSatisfiedBy(element: HTMLElement, attributeName: string): boolean;
+}

package/dist/lib/query/compliant-attributes/attribut-specification.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EqualsAttributeSpecification = exports.NotEqualsAttributeSpecification = exports.NotUniqueIdAttributeSpecification = exports.EmptyElementWithIdSpecification = exports.NotEmptyAttributeSpecification = exports.EmptyAttributeSpecification = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const $ = require("jquery/dist/jquery.min");
+class EmptyAttributeSpecification {
+    isSatisfiedBy(element, attributeName) {
+        const attributeValue = element.getAttribute(attributeName);
+        return lodash_1.default.isEmpty(attributeValue);
+    }
+}
+exports.EmptyAttributeSpecification = EmptyAttributeSpecification;
+class NotEmptyAttributeSpecification {
+    isSatisfiedBy(element, attributeName) {
+        const attributeValue = element.getAttribute(attributeName);
+        return !lodash_1.default.isEmpty(attributeValue);
+    }
+}
+exports.NotEmptyAttributeSpecification = NotEmptyAttributeSpecification;
+class EmptyElementWithIdSpecification {
+    isSatisfiedBy(element, attributeName) {
+        const attributeValue = element.getAttribute(attributeName);
+        if (lodash_1.default.isEmpty(attributeValue) || lodash_1.default.isNull(attributeValue)) {
+            return true;
+        }
+        const bindingNodeId = $(`#${attributeValue.replaceAll(".", "\\.")}`).text();
+        return lodash_1.default.isEmpty(bindingNodeId);
+    }
+}
+exports.EmptyElementWithIdSpecification = EmptyElementWithIdSpecification;
+class NotUniqueIdAttributeSpecification {
+    isSatisfiedBy(element, attributeName) {
+        if (lodash_1.default.isNull(element.id) || lodash_1.default.isEmpty(element.id)) {
+            return true;
+        }
+        return $(`[id=${element.id}]`).length > 1;
+    }
+}
+exports.NotUniqueIdAttributeSpecification = NotUniqueIdAttributeSpecification;
+class NotEqualsAttributeSpecification {
+    expectedValueList;
+    constructor(expectedValueList) {
+        this.expectedValueList = expectedValueList;
+    }
+    isSatisfiedBy(element, attributeName) {
+        const attributeValue = element.getAttribute(attributeName);
+        if (lodash_1.default.isNull(attributeValue)) {
+            return true;
+        }
+        return !this.expectedValueList.includes(attributeValue);
+    }
+}
+exports.NotEqualsAttributeSpecification = NotEqualsAttributeSpecification;
+class EqualsAttributeSpecification {
+    expectedValueList;
+    constructor(expectedValueList) {
+        this.expectedValueList = expectedValueList;
+    }
+    isSatisfiedBy(element, attributeName) {
+        const attributeValue = element.getAttribute(attributeName);
+        if (lodash_1.default.isNull(attributeValue)) {
+            return false;
+        }
+        return this.expectedValueList.includes(attributeValue);
+    }
+}
+exports.EqualsAttributeSpecification = EqualsAttributeSpecification;

package/dist/lib/query/compliant-attributes/attribute-checker.d.ts

@@ -0,0 +1,35 @@
+import { IAttributeSpecification } from "./attribut-specification";
+export declare class CompliantSpecification {
+    readonly attribute: string;
+    specification: IAttributeSpecification;
+    constructor(attribute: string, specification: IAttributeSpecification);
+}
+export declare class AttributeChecker {
+    /**
+     * Check if the value of the attributeName is empty
+     * @param attributeName : HTMLElement attributeName
+     */
+    static emptyAttribute(attributeName: string): CompliantSpecification;
+    /**
+     * Check if the value of the attributeName is not empty
+     * @param attributeName : HTMLElement attributeName
+     */
+    static notEmptyAttribute(attributeName: string): CompliantSpecification;
+    /**
+     * Check that the text of the HTMLElement whose id matches the value of the attribute named attributeName another HTMLElement is empty
+     * @param attributeName : HTMLElement attribute name
+     */
+    static emptyHtmlNodeTargetedByTheAttribute(attributeName: string): CompliantSpecification;
+    /**
+     * Check that id attribute is not unique in current page
+     */
+    static notUniqueId(): CompliantSpecification;
+    /**
+     * Check that html element does not have the expected value
+     */
+    static notEquals(attributeName: string, expectedValueList: string[]): CompliantSpecification;
+    /**
+     * Check that html element have the expected value
+     */
+    static equals(attributeName: string, expectedValueList: string[]): CompliantSpecification;
+}

package/dist/lib/query/compliant-attributes/attribute-checker.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttributeChecker = exports.CompliantSpecification = void 0;
+const attribut_specification_1 = require("./attribut-specification");
+class CompliantSpecification {
+    attribute;
+    specification;
+    constructor(attribute, specification) {
+        this.attribute = attribute;
+        this.specification = specification;
+    }
+}
+exports.CompliantSpecification = CompliantSpecification;
+class AttributeChecker {
+    /**
+     * Check if the value of the attributeName is empty
+     * @param attributeName : HTMLElement attributeName
+     */
+    static emptyAttribute(attributeName) {
+        return new CompliantSpecification(attributeName, new attribut_specification_1.EmptyAttributeSpecification());
+    }
+    /**
+     * Check if the value of the attributeName is not empty
+     * @param attributeName : HTMLElement attributeName
+     */
+    static notEmptyAttribute(attributeName) {
+        return new CompliantSpecification(attributeName, new attribut_specification_1.NotEmptyAttributeSpecification());
+    }
+    /**
+     * Check that the text of the HTMLElement whose id matches the value of the attribute named attributeName another HTMLElement is empty
+     * @param attributeName : HTMLElement attribute name
+     */
+    static emptyHtmlNodeTargetedByTheAttribute(attributeName) {
+        return new CompliantSpecification(attributeName, new attribut_specification_1.EmptyElementWithIdSpecification());
+    }
+    /**
+     * Check that id attribute is not unique in current page
+     */
+    static notUniqueId() {
+        return new CompliantSpecification("id", new attribut_specification_1.NotUniqueIdAttributeSpecification());
+    }
+    /**
+     * Check that html element does not have the expected value
+     */
+    static notEquals(attributeName, expectedValueList) {
+        return new CompliantSpecification(attributeName, new attribut_specification_1.NotEqualsAttributeSpecification(expectedValueList));
+    }
+    /**
+     * Check that html element have the expected value
+     */
+    static equals(attributeName, expectedValueList) {
+        return new CompliantSpecification(attributeName, new attribut_specification_1.EqualsAttributeSpecification(expectedValueList));
+    }
+}
+exports.AttributeChecker = AttributeChecker;

package/dist/lib/query/compliant-attributes/compliant-attributes.query.d.ts

@@ -0,0 +1,9 @@
+import { Query, QueryResult } from "../00-query";
+import { CompliantSpecification } from "./attribute-checker";
+export declare class CompliantAttributesQuery implements Query {
+    readonly subQuery: Query;
+    readonly attributeSpecifications: CompliantSpecification[];
+    constructor(subQuery: Query, attributeSpecifications: CompliantSpecification[]);
+    execute(): QueryResult[];
+    getSelector(): string;
+}

package/dist/lib/query/compliant-attributes/compliant-attributes.query.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompliantAttributesQuery = void 0;
+class CompliantAttributesQuery {
+    subQuery;
+    attributeSpecifications;
+    constructor(subQuery, attributeSpecifications) {
+        this.subQuery = subQuery;
+        this.attributeSpecifications = attributeSpecifications;
+    }
+    execute() {
+        return this.subQuery.execute().filter((element) => {
+            let result = true;
+            this.attributeSpecifications.forEach(attributeSpecification => {
+                result = result && attributeSpecification.specification.isSatisfiedBy(element.domNode, attributeSpecification.attribute);
+            });
+            return result;
+        });
+    }
+    getSelector() {
+        return `CompliantAttributes: ${this.subQuery.getSelector()}`;
+    }
+}
+exports.CompliantAttributesQuery = CompliantAttributesQuery;

package/dist/lib/query/doctype.query.d.ts

@@ -1,5 +1,5 @@
-import { Query } from "./00-query";
-export declare class DoctypeQuery implements Query {
-    execute(): HTMLElement[];
-    getSelector(): string;
-}
+import { Query, QueryResult } from "./00-query";
+export declare class DoctypeQuery implements Query {
+    execute(): QueryResult[];
+    getSelector(): string;
+}

package/dist/lib/query/doctype.query.js

@@ -1,15 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DoctypeQuery = void 0;
-class DoctypeQuery {
-    execute() {
-        if (document?.doctype?.name !== "html") {
-            return [document.documentElement];
-        }
-        return [];
-    }
-    getSelector() {
-        return "doctype";
-    }
-}
-exports.DoctypeQuery = DoctypeQuery;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DoctypeQuery = void 0;
+const _00_query_1 = require("./00-query");
+class DoctypeQuery {
+    execute() {
+        if (document?.doctype?.name !== "html") {
+            return [new _00_query_1.QueryResult(document.documentElement)];
+        }
+        return [];
+    }
+    getSelector() {
+        return "doctype";
+    }
+}
+exports.DoctypeQuery = DoctypeQuery;

package/dist/lib/query/form.query.d.ts

@@ -1,8 +1,8 @@
-import { Query } from "./00-query";
-export declare class FormQuery implements Query {
-    LABEL_ATTRIBUTE: string;
-    FORMFIELD_SELECTORS: string[];
-    FORMFIELD_LABEL_ATTRIBUTES: string[];
-    execute(): HTMLElement[];
-    getSelector(): string;
-}
+import { Query, QueryResult } from "./00-query";
+export declare class FormQuery implements Query {
+    LABEL_ATTRIBUTE: string;
+    FORMFIELD_SELECTORS: string[];
+    FORMFIELD_LABEL_ATTRIBUTES: string[];
+    execute(): QueryResult[];
+    getSelector(): string;
+}

package/dist/lib/query/form.query.js

@@ -1,87 +1,87 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormQuery = void 0;
-class FormQuery {
-    LABEL_ATTRIBUTE = "$LABEL";
-    FORMFIELD_SELECTORS = [
-        "input[type=text]",
-        "input[type=password]",
-        "input[type=search]",
-        "input[type=email]",
-        "input[type=number]",
-        "input[type=tel]",
-        "input[type=url]",
-        "textarea",
-        "input[type=checkbox]",
-        "input[type=radio]",
-        "input[type=date]",
-        "input[type=range]",
-        "input[type=color]",
-        "input[type=time]",
-        "input[type=month]",
-        "input[type=week]",
-        "input[type=datetime]",
-        "select",
-        "datalist",
-        "optgroup",
-        "option",
-        "input[type=file]",
-        "output",
-        "progress",
-        "meter",
-        "progressbar",
-        "slider",
-        "spinbutton",
-        "textbox",
-        "listbox",
-        "searchbox",
-        "combobox",
-        "checkbox",
-        "radio",
-        "switch",
-        "input[type=submit]",
-        "input[type=reset]",
-        "input[type=hidden]",
-        "input[type=image]",
-        "input[type=button]",
-        "button"
-    ];
-    FORMFIELD_LABEL_ATTRIBUTES = [
-        "aria-labelledby",
-        "aria-label",
-        "title",
-        "$LABEL"
-    ];
-    execute() {
-        // const foundElements = $(this.FORMFIELD_SELECTORS.join(","));
-        // const elements: HTMLElement[] = [];
-        // let counter = 0;
-        // while (counter < foundElements.length - 1) {
-        //     const element = foundElements[counter];
-        //     const attributeFound = rule.attributes.filter(value => {
-        //         return element.getAttribute(value);
-        //     });
-        //     if (attributeFound.length === 0) {
-        //         if (rule.attributes.includes(CustomAttribute.LABEL.toString())) {
-        //             if (!element.id) {
-        //                 elements.push(element);
-        //                 counter++;
-        //             } else {
-        //                 const foundLabelElements = jquery(`label[for=${element.id}]`);
-        //                 if (foundLabelElements.length === 0) {
-        //                     elements.push(element);
-        //                     counter++;
-        //                 }
-        //             }
-        //         }
-        //     }
-        //     counter++;
-        // }
-        //TODO implements filter
-        return [];
-    }
-    getSelector() {
-        return "FormFilter";
-    }
-}
-exports.FormQuery = FormQuery;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormQuery = void 0;
+class FormQuery {
+    LABEL_ATTRIBUTE = "$LABEL";
+    FORMFIELD_SELECTORS = [
+        "input[type=text]",
+        "input[type=password]",
+        "input[type=search]",
+        "input[type=email]",
+        "input[type=number]",
+        "input[type=tel]",
+        "input[type=url]",
+        "textarea",
+        "input[type=checkbox]",
+        "input[type=radio]",
+        "input[type=date]",
+        "input[type=range]",
+        "input[type=color]",
+        "input[type=time]",
+        "input[type=month]",
+        "input[type=week]",
+        "input[type=datetime]",
+        "select",
+        "datalist",
+        "optgroup",
+        "option",
+        "input[type=file]",
+        "output",
+        "progress",
+        "meter",
+        "progressbar",
+        "slider",
+        "spinbutton",
+        "textbox",
+        "listbox",
+        "searchbox",
+        "combobox",
+        "checkbox",
+        "radio",
+        "switch",
+        "input[type=submit]",
+        "input[type=reset]",
+        "input[type=hidden]",
+        "input[type=image]",
+        "input[type=button]",
+        "button"
+    ];
+    FORMFIELD_LABEL_ATTRIBUTES = [
+        "aria-labelledby",
+        "aria-label",
+        "title",
+        "$LABEL"
+    ];
+    execute() {
+        // const foundElements = $(this.FORMFIELD_SELECTORS.join(","));
+        // const elements: HTMLElement[] = [];
+        // let counter = 0;
+        // while (counter < foundElements.length - 1) {
+        //     const element = foundElements[counter];
+        //     const attributeFound = rule.attributes.filter(value => {
+        //         return element.getAttribute(value);
+        //     });
+        //     if (attributeFound.length === 0) {
+        //         if (rule.attributes.includes(CustomAttribute.LABEL.toString())) {
+        //             if (!element.id) {
+        //                 elements.push(element);
+        //                 counter++;
+        //             } else {
+        //                 const foundLabelElements = jquery(`label[for=${element.id}]`);
+        //                 if (foundLabelElements.length === 0) {
+        //                     elements.push(element);
+        //                     counter++;
+        //                 }
+        //             }
+        //         }
+        //     }
+        //     counter++;
+        // }
+        //TODO implements filter
+        return [];
+    }
+    getSelector() {
+        return "FormFilter";
+    }
+}
+exports.FormQuery = FormQuery;

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

@@ -1,6 +1,13 @@
-export * from "./00-query";
-export * from "./by-tag.query";
-export * from "./doctype.query";
-export * from "./form.query";
-export * from "./by-role.query";
-export * from "./accessible-name.query";
+export * from "./00-query";
+export * from "./by-tag.query";
+export * from "./doctype.query";
+export * from "./form.query";
+export * from "./by-role.query";
+export * from "./by-sibling.query";
+export * from "./operators/operator-query";
+export * from "./operators/or-query";
+export * from "./operators/and-query";
+export * from "./accessible-name.query";
+export * from "./compliant-attributes/compliant-attributes.query";
+export * from "./compliant-attributes/attribute-checker";
+export * from "./compliant-attributes/attribut-specification";

package/dist/lib/query/index.js

@@ -1,22 +1,29 @@
-"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("./00-query"), exports);
-__exportStar(require("./by-tag.query"), exports);
-__exportStar(require("./doctype.query"), exports);
-__exportStar(require("./form.query"), exports);
-__exportStar(require("./by-role.query"), exports);
-__exportStar(require("./accessible-name.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("./00-query"), exports);
+__exportStar(require("./by-tag.query"), exports);
+__exportStar(require("./doctype.query"), exports);
+__exportStar(require("./form.query"), exports);
+__exportStar(require("./by-role.query"), exports);
+__exportStar(require("./by-sibling.query"), exports);
+__exportStar(require("./operators/operator-query"), exports);
+__exportStar(require("./operators/or-query"), exports);
+__exportStar(require("./operators/and-query"), exports);
+__exportStar(require("./accessible-name.query"), exports);
+__exportStar(require("./compliant-attributes/compliant-attributes.query"), exports);
+__exportStar(require("./compliant-attributes/attribute-checker"), exports);
+__exportStar(require("./compliant-attributes/attribut-specification"), exports);

package/dist/lib/query/operators/and-query.d.ts

@@ -0,0 +1,8 @@
+import { IOperatorQuery } from "./operator-query";
+import { Query, QueryResult } from "../00-query";
+export declare class AndQuery implements IOperatorQuery, Query {
+    readonly queries: Query[];
+    constructor(queries: Query[]);
+    execute(): QueryResult[];
+    getSelector(): string;
+}

package/dist/lib/query/operators/and-query.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AndQuery = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const DOM_NODE_ATTRIBUTE = "domNode";
+class AndQuery {
+    queries;
+    constructor(queries) {
+        this.queries = queries;
+    }
+    execute() {
+        const queryResults = this.queries.map(query => query.execute());
+        return queryResults.reduce((left, right) => {
+            return lodash_1.default.intersectionBy(left, right, DOM_NODE_ATTRIBUTE);
+        });
+    }
+    getSelector() {
+        const result = this.queries.map(query => query.execute());
+        return `${lodash_1.default.intersection(...result).map(query => query.domNode).join(",")}`;
+    }
+}
+exports.AndQuery = AndQuery;

package/dist/lib/query/operators/operator-query.d.ts

@@ -0,0 +1,8 @@
+import { Query } from "../00-query";
+export interface IOperatorQuery {
+    queries: Query[];
+}
+export declare class OperatorQuery {
+    static Or: (...queries: Query[]) => Query;
+    static And: (...queries: Query[]) => Query;
+}

package/dist/lib/query/operators/operator-query.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperatorQuery = void 0;
+const or_query_1 = require("./or-query");
+const and_query_1 = require("./and-query");
+class OperatorQuery {
+    static Or = (...queries) => {
+        return new or_query_1.OrQuery(queries);
+    };
+    static And = (...queries) => {
+        return new and_query_1.AndQuery(queries);
+    };
+}
+exports.OperatorQuery = OperatorQuery;

package/dist/lib/query/operators/or-query.d.ts

@@ -0,0 +1,8 @@
+import { IOperatorQuery } from "./operator-query";
+import { Query, QueryResult } from "../00-query";
+export declare class OrQuery implements IOperatorQuery, Query {
+    readonly queries: Query[];
+    constructor(queries: Query[]);
+    execute(): QueryResult[];
+    getSelector(): string;
+}