Added axe-webdriverjs typings with axe-core@3.0.3

notNeededPackages.json

@@ -124,7 +124,7 @@
             "libraryName": "axe-core",
             "typingsPackageName": "axe-core",
             "sourceRepoURL": "https://github.com/dequelabs/axe-core",
-            "asOfVersion": "2.0.7"
+            "asOfVersion": "3.0.3"
         },
         {
             "libraryName": "axios",

types/axe-webdriverjs/axe-webdriverjs-tests.ts

@@ -0,0 +1,31 @@
+import { Result, RunOptions, Spec } from "axe-core";
+import { AxeBuilder, AxeAnalysis } from "axe-webdriverjs";
+import { WebDriver } from "selenium-webdriver";
+
+const inTest = async (webDriver: WebDriver) => {
+    const builderCalled: AxeBuilder = AxeBuilder(webDriver);
+    const builderNewed: AxeBuilder = new AxeBuilder(webDriver);
+
+    const runOptions: RunOptions = {};
+    const spec: Spec = {};
+
+    const analysis: AxeAnalysis = await AxeBuilder(webDriver)
+        .include("include")
+        .exclude("exclude")
+        .options(runOptions)
+        .withRules("rule")
+        .withRules(["rule", "rule"])
+        .withTags("tag")
+        .withTags(["tag", "tag"])
+        .disableRules("rule")
+        .disableRules(["rule", "rule"])
+        .configure(spec)
+        .analyze((internalResults: AxeAnalysis) => {});
+
+    const inapplicable: Result[] = analysis.inapplicable;
+    const incomplete: Result[] = analysis.incomplete;
+    const passes: Result[] = analysis.passes;
+    const timestamp: string = analysis.timestamp;
+    const url: string = analysis.url;
+    const violations: Result[] = analysis.violations;
+};

types/axe-webdriverjs/index.d.ts

@@ -2,11 +2,12 @@
 // Project: https://github.com/dequelabs/axe-webdriverjs#readme
 // Definitions by: My Self <https://github.com/JoshuaKGoldberg>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.3
 
 import { Result, RunOptions, Spec } from "axe-core";
 import { WebDriver } from "selenium-webdriver";
 
-export interface IAxeAnalysis {
+export interface AxeAnalysis {
     inapplicable: Result[];
     incomplete: Result[];
     passes: Result[];
@@ -16,9 +17,6 @@ export interface IAxeAnalysis {
 }
 
 export interface AxeBuilder {
-    (driver: WebDriver): AxeBuilder;
-    new (driver: WebDriver): AxeBuilder;
-
     /**
      * Includes a selector in analysis.
      *
@@ -38,21 +36,22 @@ export interface AxeBuilder {
      *
      * @param options   aXe options object.
      * @remarks Will override any other configured options, including calls to `withRules` and `withTags`.
+     * @see https://github.com/dequelabs/axe-core/issues/937
      */
     options(options: RunOptions): this;
 
     /**
      * Limits analysis to only the specified rules.
-     * 
+     *
      * @param rules   Array of rule IDs, or a single rule ID as a string.
      * @remarks Cannot be used with `withTags`.
      */
     withRules(rules: string | string[]): this;
 
     /**
-     * Limist analysis to only the specified tags.  
+     * Limist analysis to only the specified tags.
      *
-     * @param rules   Array of tags, or a single tag as a string
+     * @param rules   Array of tags, or a single tag as a string.
      * @remarks Cannot be used with `withRules`.
      */
     withTags(tags: string | string[]): this;
@@ -60,7 +59,7 @@ export interface AxeBuilder {
     /**
      * Set the list of rules to skip when running an analysis
      *
-     * @param rules   Array of rule IDs, or a single rule ID as a string
+     * @param rules   Array of rule IDs, or a single rule ID as a string.
      */
     disableRules(rules: string | string[]): this;
 
@@ -72,8 +71,13 @@ export interface AxeBuilder {
     configure(config: Spec): this;
 
     /**
-    * Perform analysis and retrieve results.
-    * @param callback   Function to execute when analysis completes.
-    */
-    analyze(callback: (results: IAxeAnalysis) => void): Promise<IAxeAnalysis>;
+     * Perform analysis and retrieve results.
+     * @param callback   Function to execute when analysis completes.
+     */
+    analyze(callback: (results: AxeAnalysis) => void): Promise<AxeAnalysis>;
 }
+
+export const AxeBuilder: {
+    (driver: WebDriver): AxeBuilder;
+    new (driver: WebDriver): AxeBuilder;
+};

types/axe-webdriverjs/package.json

@@ -1,7 +1,6 @@
 {
     "private": true,
     "dependencies": {
-        "@types/selenium-webdriver": "^3.0.0",
-        "axe-core": "^2.6.1"
+        "axe-core": "^3.0.3"
     }
 }

types/axe-webdriverjs/tsconfig.json

@@ -6,6 +6,7 @@
         ],
         "noImplicitAny": true,
         "noImplicitThis": true,
+        "strictFunctionTypes": true,
         "strictNullChecks": true,
         "baseUrl": "../",
         "typeRoots": [

types/jest-axe/package.json

@@ -1,6 +1,6 @@
 {
     "private": true,
     "dependencies": {
-        "axe-core": "^2.6.1"
+        "axe-core": "^3.0.3"
     }
 }