axe-core 4.8.2 → 4.8.3-canary.b63cd83

package/README.md

@@ -93,7 +93,7 @@ The [axe-core API](doc/API.md) package consists of:
 
 ## Localization
 
-Axe can be built using your local language. To do so, a localization file must be added to the `./locales` directory. This file must have be named in the following manner: `<langcode>.json`. To build axe using this locale, instead of the default, run axe with the `--lang` flag, like so:
+Axe can be built using your local language. To do so, a localization file must be added to the `./locales` directory. This file must be named in the following manner: `<langcode>.json`. To build axe using this locale, instead of the default, run axe with the `--lang` flag, like so:
 
 `grunt build --lang=nl`
 
@@ -101,7 +101,7 @@ or equivalently:
 
 `npm run build -- --lang=nl`
 
-This will create a new build for axe, called `axe.<lang>.js` and `axe.<lang>.min.js`. If you want to build localized versions, simply pass in `--all-lang` instead. If you want to build multiple localized versions (but not all of them), you can pass in a comma-separated list of languages to the `--lang` flag, like `--lang=nl,ja`.
+This will create a new build for axe, called `axe.<lang>.js` and `axe.<lang>.min.js`. If you want to build all localized versions, simply pass in `--all-lang` instead. If you want to build multiple localized versions (but not all of them), you can pass in a comma-separated list of languages to the `--lang` flag, like `--lang=nl,ja`.
 
 To create a new translation for axe, start by running `grunt translate --lang=<langcode>`. This will create a json file fin the `./locales` directory, with the default English text in it for you to translate. Alternatively, you could copy `./locales/_template.json`. We welcome any localization for axe-core. For details on how to contribute, see the Contributing section below. For details on the message syntax, see [Check Message Template](/docs/check-message-template.md).
 

package/axe.d.ts

@@ -1,13 +1,12 @@
 // Type definitions for axe-core
 // Project: https://github.com/dequelabs/axe-core
-// Definitions by: Marcy Sutton <https://github.com/marcysutton>
 
 declare namespace axe {
   type ImpactValue = 'minor' | 'moderate' | 'serious' | 'critical' | null;
 
   type TagValue = string;
 
-  type ReporterVersion = 'v1' | 'v2' | 'raw' | 'raw-env' | 'no-passes';
+  type ReporterVersion = 'v1' | 'v2' | 'raw' | 'rawEnv' | 'no-passes';
 
   type RunOnlyType = 'rule' | 'rules' | 'tag' | 'tags';
 
@@ -132,7 +131,7 @@ declare namespace axe {
   interface RunOptions {
     runOnly?: RunOnly | TagValue[] | string[] | string;
     rules?: RuleObject;
-    reporter?: ReporterVersion;
+    reporter?: ReporterVersion | string;
     resultTypes?: resultGroups[];
     selectors?: boolean;
     ancestry?: boolean;
@@ -333,6 +332,14 @@ declare namespace axe {
     xpath: string[];
     ancestry: UnlabelledFrameSelector;
   }
+  interface DqElement extends SerialDqElement {
+    element: Element;
+    toJSON(): SerialDqElement;
+    mergeSpecs(
+      childSpec: SerialDqElement,
+      parentSpec: SerialDqElement
+    ): SerialDqElement;
+  }
   interface PartialRuleResult {
     id: string;
     result: 'inapplicable';
@@ -351,16 +358,21 @@ declare namespace axe {
     frameContext: FrameContextObject;
   }
 
+  interface RawCheckResult extends Omit<CheckResult, 'relatedNodes'> {
+    relatedNodes?: Array<SerialDqElement | DqElement>;
+  }
+
   interface RawNodeResult<T extends 'passed' | 'failed' | 'incomplete'> {
-    any: CheckResult[];
-    all: CheckResult[];
-    none: CheckResult[];
+    node: SerialDqElement | DqElement;
+    any: RawCheckResult[];
+    all: RawCheckResult[];
+    none: RawCheckResult[];
     impact: ImpactValue | null;
     result: T;
   }
 
   interface RawResult extends Omit<Result, 'nodes'> {
-    inapplicable: [];
+    inapplicable: Array<never>;
     passes: RawNodeResult<'passed'>[];
     incomplete: RawNodeResult<'incomplete'>[];
     violations: RawNodeResult<'failed'>[];
@@ -383,6 +395,7 @@ declare namespace axe {
     attr(attr: string): string | null;
     hasAttr(attr: string): boolean;
     props: { [key: string]: unknown };
+    boundingClientRect: DOMRect;
   }
 
   interface Utils {
@@ -396,7 +409,7 @@ declare namespace axe {
     DqElement: new (
       elm: Element,
       options?: { absolutePaths?: boolean }
-    ) => SerialDqElement;
+    ) => DqElement;
     uuid: (
       options?: { random?: Uint8Array | Array<number> },
       buf?: Uint8Array | Array<number>,