@qualweb/core 0.8.0-alpha2 → 0.8.1

package/README.md

@@ -1,164 +1,146 @@
 # QualWeb core
 
-The core allows you to perform automatic accessibility evaluations on web pages. It contains 3 evaluation modules:
+The core allows you to perform automatic accessibility evaluations on web pages. By itself, core does not contain any
+evaluation modules, but are added separately. The [monorepo](https://github.com/qualweb/qualweb) contains several
+modules that we maintain:
 
-- [@qualweb/act-rules](https://github.com/qualweb/act-rules)
-- [@qualweb/wcag-techniques](https://github.com/qualweb/wcag-techniques)
-- [@qualweb/best-practices](https://github.com/qualweb/best-practices)
+- [@qualweb/act-rules](https://github.com/qualweb/qualweb/tree/main/packages/act-rules)
+- [@qualweb/wcag-techniques](https://github.com/qualweb/qualweb/tree/main/packages/wcag-techniques)
+- [@qualweb/best-practices](https://github.com/qualweb/qualweb/tree/main/packages/best-practices)
+- [@qualweb/cui-checks](https://github.com/qualweb/qualweb/tree/main/packages/cui-checks)
+- [@qualweb/counter](https://github.com/qualweb/qualweb/tree/main/packages/counter)
 
 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).
 
 ## How to install
 
+As a base example, here's how to install core and the ACT rules module. The procedure for all modules is generally the same (but do check their READMEs for specifics):
+
 ```shell
-  $ npm i @qualweb/core --save
+  $ npm i --save @qualweb/core @qualweb/act-rules
 ```
 
 ## How to run
 
-```javascript
-  'use strict';
-
-  const { QualWeb, generateEARLReport } = require('@qualweb/core');
-
-  (async () => {
-    const plugins = {
-      // Check https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-adblocker
-      adBlock: true, // Default value = false
-      // Check https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth
-      stealth: true // Default value = false
-    };
-    const qualweb = new QualWeb(plugins);
-
-    const clusterOptions = {
-      maxConcurrency: 5, // Performs several urls evaluations at the same time - the higher the number given, more resources will be used. Default value = 1
-      timeout: 60 * 1000, // Timeout for loading page. Default value = 30 seconds
-      monitor: true // Displays urls information on the terminal. Default value = false
-    };
-
-    const launchOptions = {
-      ... // check https://github.com/puppeteer/puppeteer/blob/v10.1.0/docs/api.md#puppeteerlaunchoptions
-      // In most cases there's no need to give additional options. Just leave the field undefined
-    };
-
-    // Starts the QualWeb core engine
-    await qualweb.start(clusterOptions, launchOptions);
-
-    // QualWeb evaluation report
-    const qualwebOptions = {
-      url: 'https://act-rules.github.io/pages/about/',
-      ...
-    };
-
-    // Evaluates the given options - will only return after all urls have finished evaluating or resulted in an error
-    const reports = await qualweb.evaluate(qualwebOptions);
-
-    console.log(reports);
-    //  {
-    //    "url": "report",
-    //    "url2": "report2"
-    //  }
-
-    // Stops the QualWeb core engine
-    await qualweb.stop();
-
-    const earlOptions = {
-      // Check the options in the section below
-    };
-
-    // if you want an EARL report
-    const earlReports = generateEARLReport(reports, earlOptions);
-
-    console.log(earlReports);
-    //  {
-    //    "url": "earlReport",
-    //    "url2": "earlReport2"
-    //  }
-  })();
-```
+```typescript
+import { QualWeb } from '@qualweb/core';
+import { ACTRules } from '@qualweb/act-rules';
+
+async function main() {
+  // First, initialize QualWeb. In this step, you can also enable the use of
+  // some Puppeteer plugins that may help in the evaluation process.
+  const qualweb = new QualWeb({
+    // Check https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-adblocker
+    adBlock: true, // Default value = false
+    // Check https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth
+    stealth: true // Default value = false
+  });
+
+  // Also create an instance of the evaluation module(s) you want to run.
+  const actRulesModule = new ACTRules({
+    // See @qualweb/act-rules for options.
+  });
+
+  // Then, start the QualWeb core proper. This starts puppeteer and makes core
+  // ready to run evaluations.
+
+  await qualweb.start(
+    {
+      // Concurrently runs more evaluations. Default = 1
+      maxConcurrency: 5,
+      // Timeout for reaching remote URLs. Default = 30 seconds.
+      timeout: 60 * 1000,
+      // Displays diagnost information in stdout/terminal. Default = false
+      monitor: true,
+    },
+    {
+      // Disable headless mode (i.e. show a browser window) for evaluations.
+      // By default, the browser window is not visible when running.
+      headless: false,
+    },
+  );
 
-## Options
+  const urlToEvaluate = 'https://www.w3.org/WAI/standards-guidelines/act/rules/';
 
-The available options fot the **evaluate()** function are:
+  // QualWeb stores resulting reports in a POJO, keyed by the URL.
+  const reports = qualweb.evaluate({
+    url: urlToEvaluate,
+    // Set the modules to be run here. Each module will be run once for each URL
+    // that QualWeb visits. In this example, just `urlToEvaluate`.
+    modules: [
+      actRulesModule,
+    ],
+  });
 
-```jsonc
-{
-  "url": "https://act-rules.github.io/pages/about/", // url to evaluate
-  "urls": ["https://act-rules.github.io/pages/about/", "https://act-rules.github.io/rules/"], // Array of urls
-  "file": "/path/to/file/with/urls", // urls must be separated by a newline (\n)
-  "crawl": "https://act-rules.github.io", // Domain to crawl and obtain the urls
-  "html": "<html-code>", // Full webpage html, or just small snippets
-  "log": {
-    "file": true, // Logs errors to a file. Default value = false
-    "console": false // Logs errors to the console. Default value = false
-  },
-  "viewport": {
-    "mobile": false, // default value = false
-    "landscape": true, // default value = viewPort.width > viewPort.height
-    "userAgent": "custom user agent", // default value for desktop = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:22.0) Gecko/20100101 Firefox/22.0', default value for mobile = 'Mozilla/5.0 (Linux; U; Android 2.2; en-us; DROID2 GLOBAL Build/S273) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1'
-    "resolution": {
-      "width": 1920, // default value for desktop = 1366, default value for mobile = 1080
-      "height": 1080 // default value for desktop = 768, default value for mobile = 1920
-    }
-  },
-  "waitUntil": ["load", "networkidle0"], // Events to wait before starting evaluation, default value = "load". For more check https://github.com/puppeteer/puppeteer/blob/v10.1.0/docs/api.md#pagegotourl-options
-  "validator": "http://127.0.0.1/validate", // HTML validator service endpoint. The url will be attached after of the given endpoint
-  "crawlOptions": {
-    "maxDepth": 2, // max depth to search, 0 to search only the given domain. Default value = -1 (search everything)
-    "maxUrls": 100, // max urls to find. Default value = -1 (search everything)
-    "timeout": 60, // how many seconds the domain should be crawled before it ends. Default value = -1 (never stops)
-    "maxParallelCrawls": 10, // max urls to crawl at the same time. Default value = 5
-    "logging": true // logs domain, current depth, urls found and time passed to the terminal
-  },
-  "translate": "en", // OR { "translate": "en", "fallback": "en" } OR { own translation object } check https://github.com/qualweb/locale#readme. Default = "en"
-  "execute": {
-    // choose which modules to execute
-    "wappalyzer": false, // wappalyzer module (https://github.com/qualweb/wappalyzer) - default value = false
-    "act": true, // act-rules module (https://github.com/qualweb/act-rules) - default value = true
-    "wcag": true, // wcag-techniques module (https://github.com/qualweb/wcag-techniques) - default value = true
-    "bp": false, // best-practices module (https://github.com/qualweb/best-practices) - default value = true
-    "counter": false // counter module (https://github.com/qualweb/counter) - default value = false
-  },
-  "act-rules": {
-    // More information about this options at https://github.com/qualweb/act-rules
-    "rules": ["QW-ACT-R1", "b5c3f8"], // Array of rules to execute, can be passed the QualWeb Rule ID or the ACT Rule ID
-    "exclude": ["QW-ACT-R1", "b5c3f8"], // Array of rules to exclude, can be passed the QualWeb Rule ID or the ACT Rule ID
-    "levels": ["A", "AA", "AAA"], // Conformance levels to execute,
-    "principles": ["Perceivable", "Operable", "Understandable", "Robust"] // Principles to execute
-  },
-  "wcag-techniques": {
-    // More information about this options at https://github.com/qualweb/wcag-techniques
-    "rules": ["QW-WCAG-T1", "H39"], // Array of techniques to execute, can be passed the QualWeb Technique ID or the WCAG 2.1 Technique Code
-    "exclude": ["QW-WCAG-T1", "H39"], // Array of techniques to exclude, can be passed the QualWeb Technique ID or the WCAG 2.1 Technique Code
-    "levels": ["A", "AA", "AAA"], // Conformance levels to execute,
-    "principles": ["Perceivable", "Operable", "Understandable", "Robust"] // Principles to execute
-  },
-  "best-practices": {
-    // More information about this options at https://github.com/qualweb/best-practices
-    "bestPractices": ["QW-BP1", "QW-BP2"], // Array of best practices to execute
-    "exclude": ["QW-BP1", "QW-BP2"] // Array of best practices to exclude
-  }
+  const urlReport = reports[urlToEvaluate];
+
+  console.debug(urlReport.metadata);
+
+  // Remember to stop QualWeb once you're done. This closes the Puppeteer
+  // instance.
+  await qualweb.stop();
 }
 ```
 
-The available options fot the **generateEARLReport()** function are:
+### EARL reports
 
-```jsonc
-{
-  "aggregated": true, // default value = false
-  "aggregatedName": "websites.json", // The name to save the aggregated earl reports. default value = first url of the list
-  "modules": {
-    // Choose which modules to convert the report to earl, by default all modules are converted if they were executed
-    "act": true, // default value = true
-    "wcag": false, // default value = true
-    "best-practices": false // default value = true
-  } // If the "modules" value is given, any missing module value missing it's automatically set to false
+The package `@qualweb/earl-reporter` can convert a report from QualWeb's own
+format to the [Evaluation And Reporting Language](https://www.w3.org/WAI/standards-guidelines/act/report/earl/) report format:
+
+```typescript
+import { generateEARLReport } from '@qualweb/earl-reporter';
+
+// Reports that were previously generated by QualWeb.evaluate()
+const reports = { /** ... */ };
+
+const earlReports = generateEARLReport(reports);
+
+// EARL reports are also keyed by the evaluated URL.
+```
+
+### Plugins
+
+QualWeb allows for middleware-style plugins to run at set times during evaluation. Use this if you need to set special values prior to loading a page or right before the evaluation itself runs, such as authorization cookies to access a page that requires login.
+
+```typescript
+import { QualWeb } from '@qualweb/core';
+
+async function main() {
+  const qw = new QualWeb();
+
+  let cookies: any = {};
+
+  qw.use({
+    beforePageLoad(page, url) {
+      // This code runs after a new Puppeteer page has been created but before
+      // it navigates to the target URL.
+    },
+    afterPageLoad(page, url) {
+      // This code is called right after a page has been loaded by Puppeteer
+      // but before QualWeb runs.
+
+      cookies = await page.cookies();
+    },
+  });
+
+  await qw.start();
+
+  const reports = await qw.evaluate({
+    url: 'https://www.google.com',
+  });
+
+  // reports will now contain the evaluation for google.com while cookies will
+  // contain any cookies that were stored as a result of navigating to the URL.
+
+  await qw.stop();
 }
 ```
 
+The available options fot the **evaluate()** function are documented [here](src/lib/QualwebOptions.ts)
+
 ## Report details
 
-In this section it's explained the evaluation report in detail. For a detailed version of the EARL report check [@qualweb/earl-reporter](https://github.com/qualweb/earl-reporter#report-details).
+In this section it's explained the evaluation report in detail. For a detailed version of the EARL report check [@qualweb/earl-reporter](https://github.com/qualweb/qualweb/tree/main/packages/earl-reporter).
 
 ```jsonc
   {
@@ -367,120 +349,6 @@ In this section it's explained the evaluation report in detail. For a detailed v
   }
 ```
 
-## Implemented ACT Rules
-
-| QualWeb Rule ID | ACT Rule ID                                        | ACT Rule Name                                                                       |
-| --------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| QW-ACT-R1       | [2779a5](https://act-rules.github.io/rules/2779a5) | HTML Page has a title                                                               |
-| QW-ACT-R2       | [b5c3f8](https://act-rules.github.io/rules/b5c3f8) | HTML has lang attribute                                                             |
-| QW-ACT-R3       | [5b7ae0](https://act-rules.github.io/rules/5b7ae0) | HTML lang and xml:lang match                                                        |
-| QW-ACT-R4       | [bc659a](https://act-rules.github.io/rules/bc659a) | Meta-refresh no delay                                                               |
-| QW-ACT-R5       | [bf051a](https://act-rules.github.io/rules/bf051a) | Validity of HTML Lang attribute                                                     |
-| QW-ACT-R6       | [59796f](https://act-rules.github.io/rules/59796f) | Image button has accessible name                                                    |
-| QW-ACT-R7       | [b33eff](https://act-rules.github.io/rules/b33eff) | Orientation of the page is not restricted using CSS transform property              |
-| QW-ACT-R9       | [b20e66](https://act-rules.github.io/rules/b20e66) | Links with identical accessible names have equivalent purpose                       |
-| QW-ACT-R10      | [4b1c6c](https://act-rules.github.io/rules/4b1c6c) | `iframe` elements with identical accessible names have equivalent purpose           |
-| QW-ACT-R11      | [97a4e1](https://act-rules.github.io/rules/97a4e1) | Button has accessible name                                                          |
-| QW-ACT-R12      | [c487ae](https://act-rules.github.io/rules/c487ae) | Link has accessible name                                                            |
-| QW-ACT-R13      | [6cfa84](https://act-rules.github.io/rules/6cfa84) | Element with `aria-hidden` has no focusable content                                 |
-| QW-ACT-R14      | [b4f0c3](https://act-rules.github.io/rules/b4f0c3) | meta viewport does not prevent zoom                                                 |
-| QW-ACT-R15      | [80f0bf](https://act-rules.github.io/rules/80f0bf) | audio or video has no audio that plays automatically                                |
-| QW-ACT-R16      | [e086e5](https://act-rules.github.io/rules/e086e5) | Form control has accessible name                                                    |
-| QW-ACT-R17      | [23a2a8](https://act-rules.github.io/rules/23a2a8) | Image has accessible name                                                           |
-| QW-ACT-R18      | [3ea0c8](https://act-rules.github.io/rules/3ea0c8) | `id` attribute value is unique                                                      |
-| QW-ACT-R19      | [cae760](https://act-rules.github.io/rules/cae760) | iframe element has accessible name                                                  |
-| QW-ACT-R20      | [674b10](https://act-rules.github.io/rules/674b10) | role attribute has valid value                                                      |
-| QW-ACT-R21      | [7d6734](https://act-rules.github.io/rules/7d6734) | svg element with explicit role has accessible name                                  |
-| QW-ACT-R22      | [de46e4](https://act-rules.github.io/rules/de46e4) | Element within body has valid lang attribute                                        |
-| QW-ACT-R23      | [c5a4ea](https://act-rules.github.io/rules/c5a4ea) | video element visual content has accessible alternative                             |
-| QW-ACT-R24      | [73f2c2](https://act-rules.github.io/rules/73f2c2) | autocomplete attribute has valid value                                              |
-| QW-ACT-R25      | [5c01ea](https://act-rules.github.io/rules/5c01ea) | ARIA state or property is permitted                                                 |
-| QW-ACT-R26      | [eac66b](https://act-rules.github.io/rules/eac66b) | video element auditory content has accessible alternative                           |
-| QW-ACT-R27      | [5f99a7](https://act-rules.github.io/rules/5f99a7) | This rule checks that each aria- attribute specified is defined in ARIA 1.1.        |
-| QW-ACT-R28      | [4e8ab6](https://act-rules.github.io/rules/4e8ab6) | Element with role attribute has required states and properties                      |
-| QW-ACT-R29      | [e7aa44](https://act-rules.github.io/rules/e7aa44) | Audio element content has text alternative                                          |
-| QW-ACT-R30      | [2ee8b8](https://act-rules.github.io/rules/2ee8b8) | Visible label is part of accessible name                                            |
-| QW-ACT-R31      | [c3232f](https://act-rules.github.io/rules/c3232f) | Video element visual-only content has accessible alternative                        |
-| QW-ACT-R32      | [1ec09b](https://act-rules.github.io/rules/1ec09b) | video element visual content has strict accessible alternative                      |
-| QW-ACT-R33      | [ff89c9](https://act-rules.github.io/rules/ff89c9) | ARIA required context role                                                          |
-| QW-ACT-R34      | [6a7281](https://act-rules.github.io/rules/6a7281) | ARIA state or property has valid value                                              |
-| QW-ACT-R35      | [ffd0e9](https://act-rules.github.io/rules/ffd0e9) | Heading has accessible name                                                         |
-| QW-ACT-R36      | [a25f45](https://act-rules.github.io/rules/a25f45) | Headers attribute specified on a cell refers to cells in the same table element     |
-| QW-ACT-R37      | [afw4f7](https://act-rules.github.io/rules/afw4f7) | Text has minimum contrast                                                           |
-| QW-ACT-R38      | [bc4a75](https://act-rules.github.io/rules/bc4a75) | ARIA required owned elements                                                        |
-| QW-ACT-R39      | [d0f69e](https://act-rules.github.io/rules/d0f69e) | All table header cells have assigned data cells                                     |
-| QW-ACT-R40      | [59br37](https://act-rules.github.io/rules/59br37) | Zoomed text node is not clipped with CSS overflow                                   |
-| QW-ACT-R41      | [36b590](https://act-rules.github.io/rules/36b590) | Error message describes invalid form field value                                    |
-| QW-ACT-R42      | [8fc3b6](https://act-rules.github.io/rules/8fc3b6) | Object element has non-empty accessible name                                        |
-| QW-ACT-R43      | [0ssw9k](https://act-rules.github.io/rules/0ssw9k) | Scrollable element is keyboard accessible                                           |
-| QW-ACT-R44      | [fd3a94](https://act-rules.github.io/rules/fd3a94) | Links with identical accessible names and context serve equivalent purpose          |
-| QW-ACT-R48      | [46ca7f](https://act-rules.github.io/rules/46ca7f) | Element marked as decorative is not exposed                                         |
-| QW-ACT-R49      | [aaa1bf](https://act-rules.github.io/rules/aaa1bf) | Audio or video that plays automatically has no audio that lasts more than 3 seconds |
-| QW-ACT-R50      | [4c31df](https://act-rules.github.io/rules/4c31df) | Audio or video that plays automatically has a control mechanism                     |
-| QW-ACT-R51      | [fd26cf](https://act-rules.github.io/rules/fd26cf) | video element visual-only content is media alternative for text                     |
-| QW-ACT-R52      | [ac7dc6](https://act-rules.github.io/rules/ac7dc6) | video element visual-only content has description track                             |
-| QW-ACT-R53      | [ee13b5](https://act-rules.github.io/rules/ee13b5) | video element visual-only content has transcript                                    |
-| QW-ACT-R54      | [d7ba54](https://act-rules.github.io/rules/d7ba54) | video element visual-only content has audio track alternative                       |
-| QW-ACT-R55      | [1ea59c](https://act-rules.github.io/rules/1ea59c) | video element visual content has audio description                                  |
-| QW-ACT-R56      | [ab4d13](https://act-rules.github.io/rules/ab4d13) | video element content is media alternative for text                                 |
-| QW-ACT-R57      | [f196ce](https://act-rules.github.io/rules/f196ce) | video element visual content has description track                                  |
-| QW-ACT-R58      | [2eb176](https://act-rules.github.io/rules/2eb176) | audio element content has transcript                                                |
-| QW-ACT-R59      | [afb423](https://act-rules.github.io/rules/afb423) | audio element content is media alternative for text                                 |
-| QW-ACT-R60      | [f51b46](https://act-rules.github.io/rules/f51b46) | video element auditory content has captions                                         |
-| QW-ACT-R61      | [1a02b0](https://act-rules.github.io/rules/1a02b0) | video element visual content has transcript                                         |
-| QW-ACT-R62      | [oj04fd](https://act-rules.github.io/rules/oj04fd) | Element in sequential focus order has visible focus                                 |
-| QW-ACT-R63      | [b40fd1](https://act-rules.github.io/rules/b40fd1) | Document has a landmark with non-repeated content                                   |
-| QW-ACT-R64      | [047fe0](https://act-rules.github.io/rules/047fe0) | Document has heading for non-repeated content                                       |
-| QW-ACT-R65      | [307n5z](https://act-rules.github.io/rules/307n5z) | Element with presentational children has no focusable content                       |
-| QW-ACT-R66      | [m6b1q3](https://act-rules.github.io/rules/m6b1q3) | Menuitem has non-empty accessible name                                              |
-| QW-ACT-R67      | [24afc2](https://act-rules.github.io/rules/24afc2) | Letter spacing in style attributes is not !important                                |
-| QW-ACT-R68      | [78fd32](https://act-rules.github.io/rules/78fd32) | Line height in style attributes is not !important                                   |
-| QW-ACT-R69      | [9e45ec](https://act-rules.github.io/rules/9e45ec) | Word spacing in style attributes is not !important                                  |
-| QW-ACT-R70      | [akn7bn](https://act-rules.github.io/rules/akn7bn) | frame with negative tabindex has no interactive elements                            |
-| QW-ACT-R71      | [bisz58](https://act-rules.github.io/rules/bisz58) | `meta` element has no refresh delay (no exception)                                  |
-| QW-ACT-R72      | [8a213c](https://act-rules.github.io/rules/8a213c) | First focusable element is link to non-repeated content                             |
-| QW-ACT-R73      | [3e12e1](https://act-rules.github.io/rules/3e12e1) | Block of repeated content is collapsible                                            |
-| QW-ACT-R74      | [ye5d6e](https://act-rules.github.io/rules/ye5d6e) | Document has an instrument to move focus to non-repeated content                    |
-| QW-ACT-R75      | [cf77f2](https://act-rules.github.io/rules/cf77f2) | Bypass Blocks of Repeated Content                                                   |
-| QW-ACT-R76      | [09o5cg](https://act-rules.github.io/rules/09o5cg) | Text has enhanced contrast                                                          |
-
-## Implemented WCAG 2.1 Techniques
-
-| QualWeb Technique ID | WCAG Technique ID                                                                                                                                                       | WCAG Technique Name                                                                                                                                  |
-| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| QW-WCAG-T1           | [H24](https://www.w3.org/WAI/WCAG21/Techniques/html/H24)                                                                                                                | Providing text alternatives for the area elements of image maps                                                                                      |
-| QW-WCAG-T2           | [H39](https://www.w3.org/WAI/WCAG21/Techniques/html/H39)                                                                                                                | Using caption elements to associate data table captions with data tables                                                                             |
-| QW-WCAG-T3           | [H71](https://www.w3.org/WAI/WCAG21/Techniques/html/H71)                                                                                                                | Providing a description for groups of form controls using fieldset and legend elements                                                               |
-| QW-WCAG-T4           | [H73](https://www.w3.org/WAI/WCAG21/Techniques/html/H73)                                                                                                                | Using the summary attribute of the table element to give an overview of data tables                                                                  |
-| QW-WCAG-T5           | [H36](https://www.w3.org/WAI/WCAG21/Techniques/html/H36)                                                                                                                | Using alt attributes on images used as submit buttons                                                                                                |
-| QW-WCAG-T6           | [SCR20](https://www.w3.org/WAI/WCAG21/Techniques/client-side-script/SCR20)                                                                                              | Using both keyboard and other device-specific functions                                                                                              |
-| QW-WCAG-T7           | [H28](https://www.w3.org/WAI/WCAG21/Techniques/html/H28)                                                                                                                | Providing definitions for abbreviations by using the abbr element                                                                                    |
-| QW-WCAG-T8           | [F30](https://www.w3.org/WAI/WCAG21/Techniques/failures/F30)                                                                                                            | Failure of Success Criterion 1.1.1 and 1.2.1 due to using text alternatives that are not alternatives                                                |
-| QW-WCAG-T9           | [G141](https://www.w3.org/WAI/WCAG21/Techniques/general/G141)                                                                                                           | Organizing a page using headings                                                                                                                     |
-| QW-WCAG-T10          | [H2](https://www.w3.org/WAI/WCAG21/Techniques/html/H2)                                                                                                                  | Combining adjacent image and text links for the same resource                                                                                        |
-| QW-WCAG-T11          | [H35](https://www.w3.org/WAI/WCAG21/Techniques/html/H35)                                                                                                                | Providing text alternatives on applet elements                                                                                                       |
-| QW-WCAG-T12          | [F46](https://www.w3.org/WAI/WCAG21/Techniques/failures/F46)                                                                                                            | Failure of Success Criterion 1.3.1 due to using th elements, caption elements, or non-empty summary attributes in layout tables                      |
-| QW-WCAG-T13          | [F47](https://www.w3.org/WAI/WCAG21/Techniques/failures/F47)                                                                                                            | Failure of Success Criterion 2.2.2 due to using the blink element                                                                                    |
-| QW-WCAG-T14          | [H43](https://www.w3.org/WAI/WCAG21/Techniques/html/H43)                                                                                                                | Using id and headers attributes to associate data cells with header cells in data tables                                                             |
-| QW-WCAG-T15          | [H59](https://www.w3.org/WAI/WCAG21/Techniques/html/H59)                                                                                                                | Using the link element and navigation tools                                                                                                          |
-| QW-WCAG-T16          | [H88](https://www.w3.org/WAI/WCAG21/Techniques/html/H88)                                                                                                                | Using HTML according to spec                                                                                                                         |
-| QW-WCAG-T17          | [G162](https://www.w3.org/WAI/WCAG21/Techniques/general/G162)                                                                                                           | Positioning labels to maximize predictability of relationships                                                                                       |
-| QW-WCAG-T18          | [H51](https://www.w3.org/WAI/WCAG21/Techniques/html/H51)                                                                                                                | Using table markup to present tabular information                                                                                                    |
-| QW-WCAG-T19          | [H32](https://www.w3.org/WAI/WCAG21/Techniques/html/H32)                                                                                                                | Providing submit buttons                                                                                                                             |
-| QW-WCAG-T20          | [H33](https://www.w3.org/WAI/WCAG21/Techniques/html/H33)                                                                                                                | Supplementing link text with the title attribute                                                                                                     |
-| QW-WCAG-T21          | [F89](https://www.w3.org/WAI/WCAG21/Techniques/failures/F89)                                                                                                            | Failure of Success Criteria 2.4.4, 2.4.9 and 4.1.2 due to not providing an accessible name for an image which is the only content in a link          |
-| QW-WCAG-T22          | [F52](https://www.w3.org/WAI/WCAG21/Techniques/failures/F52)                                                                                                            | Failure of Success Criterion 3.2.1 and 3.2.5 due to opening a new window as soon as a new page is loaded                                             |
-| QW-WCAG-T23          | [G1](https://www.w3.org/WAI/WCAG21/Techniques/general/G1)                                                                                                               | Adding a link at the top of each page that goes directly to the main content area                                                                    |
-| QW-WCAG-T24          | [F55](https://www.w3.org/WAI/WCAG21/Techniques/failures/F55)                                                                                                            | Failure of Success Criteria 2.1.1, 2.4.7, and 3.2.1 due to using script to remove focus when focus is received                                       |
-| QW-WCAG-T25          | [H63](https://www.w3.org/WAI/WCAG21/Techniques/html/H63)                                                                                                                | Using the scope attribute to associate header cells and data cells in data tables                                                                    |
-| QW-WCAG-T26          | [F59](https://www.w3.org/WAI/WCAG21/Techniques/failures/F59)                                                                                                            | Failure of Success Criterion 4.1.2 due to using script to make div or span a user interface control in HTML without providing a role for the control |
-| QW-WCAG-T27          | [F88](https://www.w3.org/WAI/WCAG21/Techniques/failures/F88)                                                                                                            | Failure of Success Criterion 1.4.8 due to using text that is justified (aligned to both the left and the right margins)                              |
-| QW-WCAG-T28          | [C12](https://www.w3.org/WAI/WCAG21/Techniques/css/C12) [C13](https://www.w3.org/WAI/WCAG21/Techniques/css/C13) [C14](https://www.w3.org/WAI/WCAG21/Techniques/css/C14) | Using `percent, em, names` for font sizes                                                                                                            |
-| QW-WCAG-T29          | [C19](https://www.w3.org/WAI/WCAG21/Techniques/css/C19)                                                                                                                 | Specifying alignment either to the left or right in CSS                                                                                              |
-| QW-WCAG-T30          | [F4](https://www.w3.org/WAI/WCAG21/Techniques/failures/F4)                                                                                                              | Failure of Success Criterion 2.2.2 due to using text-decoration:blink without a mechanism to stop it in less than five seconds                       |
-| QW-WCAG-T31          | [F24](https://www.w3.org/WAI/WCAG21/Techniques/failures/F24)                                                                                                            | Failure of Success Criterion 1.4.3, 1.4.6 and 1.4.8 due to specifying foreground colors without specifying background colors or vice versa           |
-| QW-WCAG-T32          | [H48](https://www.w3.org/WAI/WCAG21/Techniques/html/H48)                                                                                                                | Using ol, ul and dl for lists or groups of links                                                                                                     |
-
 # Evaluation problems
 
 Sometimes, some webpages fail to evaluate, or the evaluation may take a really long time. Before creating an issue check the **error.log** file and verify that:
@@ -489,7 +357,7 @@ Sometimes, some webpages fail to evaluate, or the evaluation may take a really l
 - The webpage exists;
 - If using https, that the certificate is valid;
   - If you really want to evaluate the page with an invalid certificate, add "--ignore-certificate-errors" to the `args` in qualweb puppeteer launch options.
-- The webpage is not password protected;
+- The webpage is not password protected. Consider adding a small plugin to set authorization cookies as an option.
 - The webpage is an [HTML Document](https://dom.spec.whatwg.org/#concept-document).
 
 # License

package/dist/index.d.ts

@@ -1,20 +1,6 @@
-/// <reference types="@qualweb/types" />
-import { LaunchOptions, BrowserLaunchArgumentOptions, BrowserConnectOptions, Viewport } from 'puppeteer';
-import { QualwebOptions, Evaluations, PuppeteerPlugins, ClusterOptions, LoadEvent } from '@qualweb/core';
-import { generateEARLReport } from '@qualweb/earl-reporter';
-import { CrawlOptions } from '@qualweb/crawler';
-import 'colors';
-declare class QualWeb {
-    private cluster?;
-    constructor(plugins?: PuppeteerPlugins);
-    start(clusterOptions?: ClusterOptions, puppeteerOptions?: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions): Promise<void>;
-    stop(): Promise<void>;
-    evaluate(options: QualwebOptions): Promise<Evaluations>;
-    crawl(domain: string, options?: CrawlOptions, viewport?: Viewport, waitUntil?: LoadEvent | Array<LoadEvent>): Promise<Array<string>>;
-    private checkUrls;
-    private handleLocales;
-    private verifyTranslationObject;
-}
-declare function getFileUrls(file: string): Promise<Array<string>>;
-export { QualWeb, generateEARLReport, getFileUrls };
+export * from './qualweb';
+export * from './lib/evaluation';
+export * from './lib/i18n';
+export { QualwebOptions, PuppeteerLifeCycleEvent } from './lib/QualwebOptions';
+export { CounterReport } from './lib/evaluation/CounterReport';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,aAAa,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAKzG,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAG5D,OAAO,EAAW,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIzD,OAAO,QAAQ,CAAC;AAQhB,cAAM,OAAO;IAIX,OAAO,CAAC,OAAO,CAAC,CAAU;gBAOd,OAAO,CAAC,EAAE,gBAAgB;IAezB,KAAK,CAChB,cAAc,CAAC,EAAE,cAAc,EAC/B,gBAAgB,CAAC,EAAE,aAAa,GAAG,4BAA4B,GAAG,qBAAqB,GACtF,OAAO,CAAC,IAAI,CAAC;IAcH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAUrB,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAiFvD,KAAK,CAChB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,YAAY,EACtB,QAAQ,CAAC,EAAE,QAAQ,EACnB,SAAS,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,GACvC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAmBX,SAAS;IAqCvB,OAAO,CAAC,aAAa;IA2BrB,OAAO,CAAC,uBAAuB;CAoBhC;AAQD,iBAAe,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAY/D;AA2DD,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC"}