@uuv/a11y 0.0.1 → 1.0.0-beta.10

package/dist/lib/reference/rgaa/rules/5-table.js

@@ -1,3 +1,294 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = [];
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const model_1 = require("../../../model");
+const query_1 = require("../../../query");
+const selector_helper_1 = require("../selector-helper");
+exports.default = [
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.1",
+        wcag: "1.3.1 A",
+        id: "5.1.1",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery(selector_helper_1.table.noCaption.buildSelector(selector_helper_1.table.selector.complex, "")), [
+            query_1.AttributeChecker.emptyAttribute("summary"),
+            query_1.AttributeChecker.emptyHtmlNodeTargetedByTheAttribute("aria-describedby"),
+        ]),
+        description: "Table tag without summary",
+        help: "set a summary to table"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.1",
+        wcag: "1.3.1 A",
+        id: "5.1.1",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery(selector_helper_1.table.noCaption.buildSelector(selector_helper_1.table.hasComplexHeader.buildSelector([], "table"), "")), [
+            query_1.AttributeChecker.emptyHtmlNodeTargetedByTheAttribute("aria-describedby"),
+        ]),
+        description: "Element with role table without summary",
+        help: "set a summary to table"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.2",
+        wcag: "1.3.1 A",
+        id: "5.2.1",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            ...selector_helper_1.table.caption.buildSelector(selector_helper_1.table.selector.complex, ""),
+            ...selector_helper_1.table.summary.buildSelector(selector_helper_1.table.selector.complex, ""),
+            ...selector_helper_1.table.ariaDescribedBy.buildSelector(selector_helper_1.table.selector.complex, ""),
+            ...selector_helper_1.table.caption.buildSelector(selector_helper_1.table.hasComplexHeader.buildSelector([], "table"), ""),
+            ...selector_helper_1.table.summary.buildSelector(selector_helper_1.table.hasComplexHeader.buildSelector([], "table"), ""),
+            ...selector_helper_1.table.ariaDescribedBy.buildSelector(selector_helper_1.table.hasComplexHeader.buildSelector([], "table"), "")
+        ]),
+        description: "if present, attributes summary(before html5), aria-describedby or child tag <caption> must be relevant",
+        attributes: [
+            "summary",
+            "aria-describedby",
+            "child:caption"
+        ],
+        help: "adapt these attributes to be relevant"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.3",
+        wcag: "1.3.2 A, 4.1.2 A",
+        id: "5.3.1",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            selector_helper_1.table.selector.withFormatting,
+        ]),
+        description: "table with presentation role must have revelant content",
+        attributes: [
+            "child:td"
+        ],
+        help: "adapt these <td> children content to be relevant"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.4",
+        wcag: "1.3.1 A",
+        id: "5.4.1",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+            ...selector_helper_1.table.noCaption.buildSelector([selector_helper_1.table.selector.withData], "table"),
+        ]), [
+            query_1.AttributeChecker.emptyAttribute("title"),
+            query_1.AttributeChecker.emptyAttribute("aria-label"),
+            query_1.AttributeChecker.emptyHtmlNodeTargetedByTheAttribute("aria-labelledby"),
+        ]),
+        description: "table must have title",
+        attributes: [
+            "child:caption",
+            "title",
+            "aria-label",
+            "aria-labelledby"
+        ],
+        help: "set one of these attributes"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.5",
+        wcag: "1.3.1 A",
+        id: "5.5.1",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            ...selector_helper_1.table.caption.buildSelector([selector_helper_1.table.selector.withData], "table"),
+            ...selector_helper_1.table.title.buildSelector([selector_helper_1.table.selector.withData], "table"),
+            ...selector_helper_1.table.ariaLabel.buildSelector([selector_helper_1.table.selector.withData], "table"),
+            ...selector_helper_1.table.ariaLabelledBy.buildSelector([selector_helper_1.table.selector.withData], "table"),
+        ]),
+        description: "table must have a revelant title",
+        attributes: [
+            "child:caption",
+            "title",
+            "aria-label",
+            "aria-labelledby"
+        ],
+        help: "adapt one of these attributes to be revelant"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.6",
+        wcag: "1.3.1 A",
+        id: "5.6.1",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            selector_helper_1.table.selector.withData, "[role=table]"
+        ]),
+        description: "table column header must be set properly",
+        help: "each table column header must be set with tag <th> or role=\"columnheader\""
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.6",
+        wcag: "1.3.1 A",
+        id: "5.6.2",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            selector_helper_1.table.selector.withData, "[role=table]"
+        ]),
+        description: "table line header must be set properly",
+        help: "each table line header must be set with tag <th> or role=\"rowheader\""
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.6",
+        wcag: "1.3.1 A",
+        id: "5.6.3",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            selector_helper_1.table.selector.withData, "[role=table]"
+        ]),
+        description: "each header does not apply to the entire row or column must be set properly"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.6",
+        wcag: "1.3.1 A",
+        id: "5.6.4",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            selector_helper_1.table.selector.withData, "[role=table]"
+        ]),
+        description: "each cell associated with several headers structured using a <th> or <td> tag"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.1",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+            ...selector_helper_1.table.thColumnHeader.buildSelector([selector_helper_1.table.selector.withData], "table"),
+        ]), [
+            query_1.AttributeChecker.notUniqueId(),
+            query_1.AttributeChecker.emptyAttribute("scope"),
+            query_1.AttributeChecker.notEquals("role", ["rowheader", "columnheader"])
+        ]),
+        description: "Table column header attributes",
+        help: "Correctly set table column header attributes"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.1",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+            ...selector_helper_1.table.thRowHeader.buildSelector([selector_helper_1.table.selector.withData], "table"),
+        ]), [
+            query_1.AttributeChecker.notUniqueId(),
+            query_1.AttributeChecker.emptyAttribute("scope"),
+            query_1.AttributeChecker.notEquals("role", ["rowheader", "columnheader"])
+        ]),
+        description: "Table row header attributes",
+        help: "Correctly set table row header attributes"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.2",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+            ...selector_helper_1.table.thColumnHeader.buildSelector([selector_helper_1.table.selector.withData], "table"),
+        ]), [
+            query_1.AttributeChecker.notEmptyAttribute("scope"),
+            query_1.AttributeChecker.notEquals("scope", ["col"])
+        ]),
+        description: "Table column header scope attribute",
+        help: "Set table column header scope attribute to col"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.2",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+            ...selector_helper_1.table.thRowHeader.buildSelector([selector_helper_1.table.selector.withData], "table"),
+        ]), [
+            query_1.AttributeChecker.notEmptyAttribute("scope"),
+            query_1.AttributeChecker.notEquals("scope", ["row"])
+        ]),
+        description: "Table row header scope attribute",
+        help: "Set table column header scope attribute to row"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.3",
+        elementType: "table",
+        query: new query_1.OrQuery([
+            new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+                "table:not([role=presentation]) tr:not(:first-child) th:not(:first-child)"
+            ]), [
+                query_1.AttributeChecker.notUniqueId()
+            ]),
+            new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+                "table:not([role=presentation]) tr:not(:first-child) th:not(:first-child)"
+            ]), [
+                query_1.AttributeChecker.notEmptyAttribute("scope")
+            ]),
+            new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+                "table:not([role=presentation]) tr:not(:first-child) th:not(:first-child)"
+            ]), [
+                query_1.AttributeChecker.equals("role", ["rowheader", "columnheader"])
+            ])
+        ]),
+        description: "each header does not apply to the entire row or column must be set properly"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.4",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            selector_helper_1.table.selector.withData, "[role=table]"
+        ]),
+        description: "Each cell associated with several headers, the header attribute must be filled in correctly.",
+        help: "Each cell associated with several headers, the header attribute must contain the list of ids referring to the target headers."
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.5",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+            "table:not([role=presentation]) tr:first-child th",
+            "[role=table] tr:first-child th"
+        ]), [
+            query_1.AttributeChecker.notEmptyAttribute("role"),
+            query_1.AttributeChecker.notEquals("role", ["columnheader"])
+        ]),
+        description: "Table column header role attribute",
+        help: "Set table column header role attribute to 'columnheader'"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.7",
+        wcag: "1.3.1 A",
+        id: "5.7.5",
+        elementType: "table",
+        query: new query_1.CompliantAttributesQuery(new query_1.ByTagQuery([
+            "table:not([role=presentation]) tr:not(:first-child) th:first-child",
+            "[role=table] tr:not(:first-child) th:first-child"
+        ]), [
+            query_1.AttributeChecker.notEmptyAttribute("role"),
+            query_1.AttributeChecker.notEquals("role", ["rowheader"])
+        ]),
+        description: "Table row header role attribute",
+        help: "Set table row header role attribute to 'rowheader'"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "5.8",
+        wcag: "1.3.1 A",
+        id: "5.8.1",
+        elementType: "table",
+        query: new query_1.ByTagQuery([
+            selector_helper_1.table.selector.withFormatting + "[summary]",
+            selector_helper_1.table.selector.withFormatting + ":has(caption)",
+            selector_helper_1.table.selector.withFormatting + ":has(thead)",
+            selector_helper_1.table.selector.withFormatting + ":has(th)",
+            selector_helper_1.table.selector.withFormatting + ":has(tfoot)",
+            selector_helper_1.table.selector.withFormatting + " :has(> [role=rowheader])",
+            selector_helper_1.table.selector.withFormatting + " :has(> [role=columnheader])",
+            selector_helper_1.table.selector.withFormatting + " td[scope]",
+            selector_helper_1.table.selector.withFormatting + " td[headers]",
+            selector_helper_1.table.selector.withFormatting + " td[axis]",
+        ]),
+        description: "table with presentation role must have revelant content",
+        attributes: [
+            "child:td"
+        ],
+        help: "adapt these <td> children content to be relevant"
+    })
+];

package/dist/lib/reference/rgaa/rules/6-link.d.ts

@@ -1,2 +1,2 @@
-declare const _default: never[];
-export default _default;
+declare const _default: never[];
+export default _default;

package/dist/lib/reference/rgaa/rules/6-link.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = [];
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = [];

package/dist/lib/reference/rgaa/rules/7-script.d.ts

@@ -1,2 +1,2 @@
-declare const _default: never[];
-export default _default;
+declare const _default: never[];
+export default _default;

package/dist/lib/reference/rgaa/rules/7-script.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = [];
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = [];

package/dist/lib/reference/rgaa/rules/8-required-element.d.ts

@@ -1,14 +1,13 @@
-import { AutoCheckA11yRule } from "../../../model";
-declare const _default: (AutoCheckA11yRule & {
-    attributes?: string[] | undefined;
-    reference: string;
-    criterion: string;
-    wcag: string;
-    id: string;
-    elementType: string;
-    query: import("../../../query").Query;
-    description?: string | undefined;
-    help?: string | string[] | undefined;
-    shouldNotExist?: boolean | undefined;
-})[];
-export default _default;
+import { AutoCheckA11yRule } from "../../../model";
+declare const _default: (AutoCheckA11yRule & {
+    attributes?: string[] | undefined;
+    criterion: string;
+    wcag: string;
+    id: string;
+    elementType: string;
+    query: import("../../../query").Query;
+    description?: string | undefined;
+    help?: string | string[] | undefined;
+    shouldNotExist?: boolean | undefined;
+})[];
+export default _default;

package/dist/lib/reference/rgaa/rules/8-required-element.js

@@ -1,78 +1,72 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const model_1 = require("../../../model");
-const query_1 = require("../../../query");
-exports.default = [
-    model_1.AutoCheckA11yRule.from({
-        reference: "RGAA",
-        criterion: "8.1",
-        wcag: "4.1.1 A",
-        id: "8.1.1",
-        elementType: "doctype",
-        query: new query_1.DoctypeQuery(),
-        description: "current page has no doctype or a doctype different to html",
-        help: "add <!DOCTYPE html> in the current page"
-    }),
-    model_1.AutoCheckA11yRule.from({
-        reference: "RGAA",
-        criterion: "8.3",
-        wcag: "3.1.1 A",
-        id: "8.3.1",
-        elementType: "lang",
-        query: new query_1.ByTagQuery([
-            "html:not([lang]):not([xml\\:lang])"
-        ]),
-        description: "current page has no language specified",
-        help: "add lang attribute to html tag"
-    }),
-    model_1.ManualCheckA11yRule.from({
-        reference: "RGAA",
-        criterion: "8.4",
-        wcag: "3.1.1 A",
-        id: "8.4.1",
-        elementType: "lang",
-        query: new query_1.ByTagQuery([
-            "html[lang]",
-            "html[xml\\:lang]"
-        ]),
-        description: "if present, attributes lang, xml:lang must be relevant",
-        help: "adapt these attributes to be relevant"
-    }),
-    model_1.AutoCheckA11yRule.from({
-        reference: "RGAA",
-        criterion: "8.5",
-        wcag: "2.4.2 A",
-        id: "8.5.1",
-        elementType: "title",
-        query: new query_1.ByTagQuery([
-            "title"
-        ]),
-        description: "current page has no title tag",
-        help: "add a title tag to the current page"
-    }),
-    model_1.ManualCheckA11yRule.from({
-        reference: "RGAA",
-        criterion: "8.6",
-        wcag: "2.4.2 A",
-        id: "8.6.1",
-        elementType: "mandatory - title",
-        query: new query_1.ByTagQuery([
-            "title"
-        ]),
-        attributes: [],
-        description: "if present, title tag must be relevant",
-        help: "adapt this tag content"
-    }),
-    model_1.AutoCheckA11yRule.from({
-        reference: "RGAA",
-        criterion: "8.10",
-        wcag: "1.3.2 A",
-        id: "8.10.1",
-        elementType: "mandatory - reading",
-        query: new query_1.ByTagQuery([
-            "[dir]:not([dir='rtl'], [dir='ltr'], [dir='auto'])"
-        ]),
-        description: "if present, dir attribute must be relevant",
-        help: "adapt value of dir attribute"
-    })
-];
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const model_1 = require("../../../model");
+const query_1 = require("../../../query");
+exports.default = [
+    model_1.AutoCheckA11yRule.from({
+        criterion: "8.1",
+        wcag: "4.1.1 A",
+        id: "8.1.1",
+        elementType: "doctype",
+        query: new query_1.DoctypeQuery(),
+        description: "current page has no doctype or a doctype different to html",
+        help: "add <!DOCTYPE html> in the current page"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "8.3",
+        wcag: "3.1.1 A",
+        id: "8.3.1",
+        elementType: "lang",
+        query: new query_1.ByTagQuery([
+            "html:not([lang]):not([xml\\:lang])"
+        ]),
+        description: "current page has no language specified",
+        help: "add lang attribute to html tag"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "8.4",
+        wcag: "3.1.1 A",
+        id: "8.4.1",
+        elementType: "lang",
+        query: new query_1.ByTagQuery([
+            "html[lang]",
+            "html[xml\\:lang]"
+        ]),
+        description: "if present, attributes lang, xml:lang must be relevant",
+        help: "adapt these attributes to be relevant"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "8.5",
+        wcag: "2.4.2 A",
+        id: "8.5.1",
+        elementType: "title",
+        query: new query_1.ByTagQuery([
+            "title"
+        ]),
+        description: "current page has no title tag",
+        help: "add a title tag to the current page"
+    }),
+    model_1.ManualCheckA11yRule.from({
+        criterion: "8.6",
+        wcag: "2.4.2 A",
+        id: "8.6.1",
+        elementType: "mandatory - title",
+        query: new query_1.ByTagQuery([
+            "title"
+        ]),
+        attributes: [],
+        description: "if present, title tag must be relevant",
+        help: "adapt this tag content"
+    }),
+    model_1.AutoCheckA11yRule.from({
+        criterion: "8.10",
+        wcag: "1.3.2 A",
+        id: "8.10.1",
+        elementType: "mandatory - reading",
+        query: new query_1.ByTagQuery([
+            "[dir]:not([dir='rtl'], [dir='ltr'], [dir='auto'])"
+        ]),
+        description: "if present, dir attribute must be relevant",
+        help: "adapt value of dir attribute"
+    })
+];

package/dist/lib/reference/rgaa/rules/9-structure.d.ts

@@ -1,2 +1,2 @@
-declare const _default: never[];
-export default _default;
+declare const _default: never[];
+export default _default;

package/dist/lib/reference/rgaa/rules/9-structure.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = [];
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = [];

package/dist/lib/reference/rgaa/selector-helper.d.ts

@@ -1,17 +1,56 @@
-declare class SelectorRule {
-    readonly SELECTOR: string;
-    readonly ATTRIBUTES: string[];
-    constructor(SELECTOR: string, ATTRIBUTES: string[]);
-    buildSelectorWithAttributes(): string[];
-    buildSelectorWithoutAttributes(): string;
-}
-export declare const informativeContent: {
-    image: SelectorRule;
-    area: SelectorRule;
-    input: SelectorRule;
-    object: SelectorRule;
-    embed: SelectorRule;
-    svg: SelectorRule;
-    canvas: SelectorRule;
-};
-export {};
+declare class SelectorRule {
+    readonly SELECTOR: string;
+    readonly ATTRIBUTES: string[];
+    constructor(SELECTOR: string, ATTRIBUTES: string[]);
+    buildSelectorWithAttributes(): string[];
+}
+export declare const informativeContent: {
+    image: SelectorRule;
+    area: SelectorRule;
+    input: SelectorRule;
+    object: SelectorRule;
+    embed: SelectorRule;
+    svg: SelectorRule;
+    canvas: SelectorRule;
+};
+export declare const siblingElement: {
+    button: SelectorRule;
+    a: SelectorRule;
+};
+/** CSS SELECTOR HELPER *******/
+declare class CssSelectorRule {
+    readonly attributes: string[];
+    readonly selector: string;
+    readonly role: string;
+    constructor(attributes: string[], selector?: string, role?: string);
+    buildSelector(overrideSelector?: string[], overrideRole?: string | undefined): string[];
+}
+export declare const commonCssSelector: {
+    ariaDescribedBy: string[];
+    title: string[];
+    ariaLabelledBy: string[];
+    ariaLabel: string[];
+};
+export declare const tableCssSelector: {
+    complexTh: string[];
+    complexRowHeader: string[];
+    complexColumnHeader: string[];
+};
+export declare const table: {
+    selector: {
+        withFormatting: string;
+        complex: string[];
+        withData: string;
+    };
+    noCaption: CssSelectorRule;
+    caption: CssSelectorRule;
+    summary: CssSelectorRule;
+    ariaDescribedBy: CssSelectorRule;
+    title: CssSelectorRule;
+    ariaLabel: CssSelectorRule;
+    ariaLabelledBy: CssSelectorRule;
+    thColumnHeader: CssSelectorRule;
+    thRowHeader: CssSelectorRule;
+    hasComplexHeader: CssSelectorRule;
+};
+export {};