@qualweb/act-rules 0.6.39 → 0.7.0

package/README.md

@@ -4,7 +4,44 @@ Implementation of the [ACT rules](https://www.w3.org/WAI/standards-guidelines/ac
 
 ## How to use
 
-**This is an internal module of QualWeb. To use it check either [@qualweb/cli](https://github.com/qualweb/cli) or [@qualweb/core](https://github.com/qualweb/core). You can also perform evaluations at [http://qualweb.di.fc.ul.pt/evaluator/](http://qualweb.di.fc.ul.pt/evaluator/), or by installing the [chrome extension](https://chrome.google.com/webstore/detail/qualweb-extension/ljgilomdnehokancdcbkmbndkkiggioc).**
+This package is intended to be used with [@qualweb/core](https://github.com/qualweb/core).
+
+Add both packages to your project: 
+
+```bash
+npm i --save @qualweb/core @qualweb/act-rules
+```
+
+In your own code, pass an instance of the `ACTRules` class to QualWeb's evaluate method:
+
+```typescript
+import { ACTRules } from '@qualweb/act-rules';
+import { QualWeb } from '@qualweb/core';
+
+async function main() {
+  const qw = new QualWeb();
+
+  await qw.start();
+
+  const actRuleInstance = new ACTRules({
+    // Include/exclude specific rules here. Omitting any filters implies *all*
+    // rules are included.
+    levels: ['A', 'AA'],
+    exclude: ['QW-ACT-R3'],
+  });
+
+  const urlToEvaluate = 'https://www.google.com';
+
+  const report = await qw.evaluate({
+    url: urlToEvaluate,
+    modules: [actRuleInstance],
+  });
+
+  await qw.stop();
+
+  console.debug(report[urlToEvaluate].metadata);
+}
+```
 
 ## Implemented rules
 
@@ -73,7 +110,6 @@ Implementation of the [ACT rules](https://www.w3.org/WAI/standards-guidelines/ac
 | QW-ACT-R69      | [9e45ec](https://www.w3.org/WAI/standards-guidelines/act/rules/9e45ec/) | Word spacing in style attributes is not !important                                  |
 | QW-ACT-R70      | [akn7bn](https://www.w3.org/WAI/standards-guidelines/act/rules/akn7bn/) | Iframe with interactive elements is not excluded from tab-order                     |
 | QW-ACT-R71      | [bisz58](https://www.w3.org/WAI/standards-guidelines/act/rules/bisz58/) | Meta element has no refresh delay (no exception)                                    |
-| QW-ACT-R72      | [8a213c](https://www.w3.org/WAI/standards-guidelines/act/rules/8a213c/) | First focusable element is link to non-repeated content                             |
 | QW-ACT-R73      | [3e12e1](https://www.w3.org/WAI/standards-guidelines/act/rules/3e12e1/) | Block of repeated content is collapsible                                            |
 | QW-ACT-R74      | [ye5d6e](https://www.w3.org/WAI/standards-guidelines/act/rules/ye5d6e/) | Document has an instrument to move focus to non-repeated content                    |
 | QW-ACT-R75      | [cf77f2](https://www.w3.org/WAI/standards-guidelines/act/rules/cf77f2/) | Bypass Blocks of Repeated Content                                                   |

package/dist/ACTRulesModule.d.ts

@@ -0,0 +1,11 @@
+import type { EvaluationReport, ModuleOptions, TestingData } from '@qualweb/core/evaluation';
+import { ModuleType, ExecutableModuleContext } from '@qualweb/core/evaluation';
+import type { TranslationOptions } from '@qualweb/locale';
+import type { QualwebPage } from '@qualweb/core/lib';
+export declare class ACTRulesModule extends ExecutableModuleContext {
+    readonly name = ModuleType.ACT_RULES;
+    protected getModulePackage(): string;
+    protected runModule(page: QualwebPage, options: ModuleOptions, translate: TranslationOptions, data: TestingData): Promise<EvaluationReport>;
+    private testSpecialCases;
+}
+//# sourceMappingURL=ACTRulesModule.d.ts.map

package/dist/ACTRulesModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACTRulesModule.d.ts","sourceRoot":"","sources":["../src/ACTRulesModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,UAAU,EACV,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,qBAAa,cAAe,SAAQ,uBAAuB;IACzD,SAAgB,IAAI,wBAAwB;IAE5C,SAAS,CAAC,gBAAgB,IAAI,MAAM;cAIpB,SAAS,CACvB,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,kBAAkB,EAC7B,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,gBAAgB,CAAC;IAgD5B,OAAO,CAAC,gBAAgB;CAOzB"}

package/dist/ACTRulesModule.js

@@ -0,0 +1,65 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACTRulesModule = void 0;
+const evaluation_1 = require("@qualweb/core/evaluation");
+class ACTRulesModule extends evaluation_1.ExecutableModuleContext {
+    constructor() {
+        super(...arguments);
+        this.name = evaluation_1.ModuleType.ACT_RULES;
+    }
+    getModulePackage() {
+        return '@qualweb/act-rules';
+    }
+    runModule(page, options, translate, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield page.evaluate((translate, options, data) => {
+                window.act = new ACTRulesRunner(options, translate).configure(options).test(data);
+            }, translate, options, data);
+            if (this.testSpecialCases(options)) {
+                const viewport = page.getViewport();
+                yield page.setViewport({
+                    resolution: {
+                        width: 640,
+                        height: 512
+                    },
+                    mobile: viewport === null || viewport === void 0 ? void 0 : viewport.isMobile,
+                    landscape: viewport === null || viewport === void 0 ? void 0 : viewport.isLandscape,
+                    touch: viewport === null || viewport === void 0 ? void 0 : viewport.hasTouch
+                });
+                yield page.evaluate(() => {
+                    var _a, _b;
+                    (_b = (_a = window.act).testSpecial) === null || _b === void 0 ? void 0 : _b.call(_a);
+                });
+                if (viewport) {
+                    yield page.setViewport({
+                        resolution: {
+                            width: viewport.width,
+                            height: viewport.height
+                        },
+                        mobile: viewport === null || viewport === void 0 ? void 0 : viewport.isMobile,
+                        landscape: viewport === null || viewport === void 0 ? void 0 : viewport.isLandscape,
+                        touch: viewport === null || viewport === void 0 ? void 0 : viewport.hasTouch
+                    });
+                }
+            }
+            return page.evaluate(() => {
+                return window.act.getReport();
+            });
+        });
+    }
+    testSpecialCases(options) {
+        return (!options ||
+            ((!options.include || options.include.includes('QW-ACT-R40') || options.include.includes('59br37')) &&
+                (!options.exclude || !options.exclude.includes('QW-ACT-R40') || !options.exclude.includes('59br37'))));
+    }
+}
+exports.ACTRulesModule = ACTRulesModule;

package/dist/ACTRulesRunner.d.ts

@@ -0,0 +1,14 @@
+import { ModuleTranslator } from '@qualweb/core/locale';
+import type { ModuleOptions, TestingData } from '@qualweb/core/evaluation';
+import { EvaluationModuleDefinition } from '@qualweb/core/evaluation';
+import { ACTRulesTester } from './lib/ACTRulesTester.object';
+import { TranslationOptions } from '@qualweb/locale';
+export declare class ACTRulesRunner extends EvaluationModuleDefinition<ACTRulesTester> {
+    protected readonly translator: ModuleTranslator;
+    constructor(moduleOptions: ModuleOptions, translationOptions: TranslationOptions);
+    configure(options?: ModuleOptions): this;
+    test(data: TestingData): this;
+    private getMetaElements;
+    testSpecial(): this;
+}
+//# sourceMappingURL=ACTRulesRunner.d.ts.map

package/dist/ACTRulesRunner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACTRulesRunner.d.ts","sourceRoot":"","sources":["../src/ACTRulesRunner.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAEL,0BAA0B,EAE3B,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,qBAAa,cAAe,SAAQ,0BAA0B,CAAC,cAAc,CAAC;IAK5E,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE7B,aAAa,EAAE,aAAa,EAAE,kBAAkB,EAAE,kBAAkB;IAiBvE,SAAS,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI;IAMxC,IAAI,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAO7C,OAAO,CAAC,eAAe;IAgBhB,WAAW,IAAI,IAAI;CAI3B"}

package/dist/ACTRulesRunner.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACTRulesRunner = void 0;
+const locale_1 = require("@qualweb/core/locale");
+const evaluation_1 = require("@qualweb/core/evaluation");
+const ACTRulesTester_object_1 = require("./lib/ACTRulesTester.object");
+class ACTRulesRunner extends evaluation_1.EvaluationModuleDefinition {
+    constructor(moduleOptions, translationOptions) {
+        const moduleType = evaluation_1.ModuleType.ACT_RULES;
+        const report = new evaluation_1.ModuleReport(moduleType);
+        const tester = new ACTRulesTester_object_1.ACTRulesTester(report);
+        super(moduleType, moduleOptions, translationOptions, report, tester);
+        this.translator = new locale_1.ModuleTranslator(this.type, this.translate);
+        this.tester.init(this.translator);
+    }
+    configure(options) {
+        super.configure(options || this.moduleOptions);
+        this.tester.configureCompositeRules();
+        return this;
+    }
+    test(data) {
+        const metaElements = this.getMetaElements(data.sourceHtml);
+        this.tester.validateMetaElements(metaElements);
+        this.tester.execute();
+        return this;
+    }
+    getMetaElements(sourceHtml) {
+        if (!sourceHtml) {
+            return [];
+        }
+        const parser = new DOMParser();
+        const sourceDoc = parser.parseFromString('', 'text/html');
+        sourceDoc.documentElement.innerHTML = sourceHtml;
+        const elements = sourceDoc.querySelectorAll('meta');
+        const metaElements = new Array();
+        elements.forEach((element) => metaElements.push(window.qwPage.createQWElement(element)));
+        return metaElements;
+    }
+    testSpecial() {
+        this.tester.validateZoomedTextNodeNotClippedWithCSSOverflow();
+        return this;
+    }
+}
+exports.ACTRulesRunner = ACTRulesRunner;