@axe-core/webdriverjs 4.7.2 → 4.7.3-alpha.398

package/README.md

@@ -10,21 +10,9 @@ Install [Node.js](https://docs.npmjs.com/getting-started/installing-node) if you
 
 > Download and install any necessary browser drivers on your machine's PATH. [More on Webdriver setup](https://www.selenium.dev/documentation/en/webdriver/).
 
-Install Selenium Webdriver: `npm install selenium-webdriver --no-save`
+Install Selenium Webdriver: `npm install selenium-webdriver`
 
-Install @axe-core/webdriverjs and its dependencies:
-
-NPM:
-
-```console
-npm install @axe-core/webdriverjs
-```
-
-Yarn:
-
-```console
-yarn add @axe-core/webdriverjs
-```
+Install @axe-core/webdriverjs: `npm install @axe-core/webdriverjs`
 
 ## Usage
 
@@ -33,19 +21,26 @@ This module uses a chainable API to assist in injecting, configuring, and analyz
 Here is an example of a script that will drive WebdriverJS to a page, perform an analysis, and then log results to the console.
 
 ```js
-const AxeBuilder = require('@axe-core/webdriverjs');
-const WebDriver = require('selenium-webdriver');
-
-const driver = new WebDriver.Builder().forBrowser('firefox').build();
-
-driver.get('https://dequeuniversity.com/demo/mars/').then(() => {
-  new AxeBuilder(driver).analyze((err, results) => {
-    if (err) {
-      // Handle error somehow
-    }
+const { AxeBuilder } = require('@axe-core/webdriverjs');
+const { Builder } = require('selenium-webdriver');
+const chrome = require('selenium-webdriver/chrome');
+
+(async () => {
+  const driver = Builder()
+    .forBrowser('chrome')
+    .setChromeOptions(new chrome.Options().headless())
+    .build();
+  await driver.get('https://dequeuniversity.com/demo/mars/');
+
+  try {
+    const results = await new AxeBuilder(driver).analyze();
     console.log(results);
-  });
-});
+  } catch(e) {
+    // do something with the error
+  }
+
+  await driver.quit();
+})();
 ```
 
 ## AxeBuilder(driver: Webdriver.WebDriver[, axeSource: string])

package/dist/index.d.ts

@@ -81,4 +81,4 @@ declare class AxeBuilder {
     private finishRun;
 }
 
-export { AxeBuilder as default };
+export { AxeBuilder, AxeBuilder as default };

package/dist/index.js

@@ -30,7 +30,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  default: () => src_default
+  AxeBuilder: () => AxeBuilder,
+  default: () => AxeBuilder
 });
 module.exports = __toCommonJS(src_exports);
 var import_axe_core2 = __toESM(require("axe-core"));
@@ -431,7 +432,14 @@ var AxeBuilder = class {
     if (runPartialSupported !== true || this.legacyMode) {
       return this.runLegacy(context);
     }
-    const partials = await this.runPartialRecursive(context, true);
+    const { pageLoad } = await this.driver.manage().getTimeouts();
+    this.driver.manage().setTimeouts({ pageLoad: 1e3 });
+    let partials;
+    try {
+      partials = await this.runPartialRecursive(context);
+    } finally {
+      this.driver.manage().setTimeouts({ pageLoad });
+    }
     try {
       return await this.finishRun(partials);
     } catch (error2) {
@@ -465,8 +473,8 @@ var AxeBuilder = class {
   /**
    * Get partial results from the current context and its child frames
    */
-  async runPartialRecursive(context, initiator = false) {
-    if (!initiator) {
+  async runPartialRecursive(context, frameStack = []) {
+    if (frameStack.length) {
       await axeSourceInject(this.driver, this.axeSource, this.config);
     }
     const frameContexts = await axeGetFrameContext(this.driver, context);
@@ -474,16 +482,16 @@ var AxeBuilder = class {
       await axeRunPartial(this.driver, context, this.option)
     ];
     for (const { frameContext, frameSelector, frame } of frameContexts) {
-      let switchedFrame = false;
       try {
         (0, import_assert.default)(frame, `Expect frame of "${frameSelector}" to be defined`);
         await this.driver.switchTo().frame(frame);
-        switchedFrame = true;
-        partials.push(...await this.runPartialRecursive(frameContext));
+        partials.push(...await this.runPartialRecursive(frameContext, [...frameStack, frame]));
         await this.driver.switchTo().parentFrame();
       } catch {
-        if (switchedFrame) {
-          await this.driver.switchTo().parentFrame();
+        const win = await this.driver.getWindowHandle();
+        await this.driver.switchTo().window(win);
+        for (const frameElm of frameStack) {
+          await this.driver.switchTo().frame(frameElm);
         }
         partials.push("null");
       }
@@ -496,6 +504,7 @@ var AxeBuilder = class {
   async finishRun(partials) {
     const { driver, axeSource, config, option } = this;
     const win = await driver.getWindowHandle();
+    await driver.switchTo().window(win);
     try {
       await driver.executeScript(`window.open('about:blank')`);
       const handlers = await driver.getAllWindowHandles();
@@ -514,7 +523,7 @@ ${error2}`
     return res;
   }
 };
-if (typeof module === "object") {
-  exports = module.exports = AxeBuilder;
-}
-var src_default = AxeBuilder;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AxeBuilder
+});

package/dist/index.mjs

@@ -397,7 +397,14 @@ var AxeBuilder = class {
     if (runPartialSupported !== true || this.legacyMode) {
       return this.runLegacy(context);
     }
-    const partials = await this.runPartialRecursive(context, true);
+    const { pageLoad } = await this.driver.manage().getTimeouts();
+    this.driver.manage().setTimeouts({ pageLoad: 1e3 });
+    let partials;
+    try {
+      partials = await this.runPartialRecursive(context);
+    } finally {
+      this.driver.manage().setTimeouts({ pageLoad });
+    }
     try {
       return await this.finishRun(partials);
     } catch (error2) {
@@ -431,8 +438,8 @@ var AxeBuilder = class {
   /**
    * Get partial results from the current context and its child frames
    */
-  async runPartialRecursive(context, initiator = false) {
-    if (!initiator) {
+  async runPartialRecursive(context, frameStack = []) {
+    if (frameStack.length) {
       await axeSourceInject(this.driver, this.axeSource, this.config);
     }
     const frameContexts = await axeGetFrameContext(this.driver, context);
@@ -440,16 +447,16 @@ var AxeBuilder = class {
       await axeRunPartial(this.driver, context, this.option)
     ];
     for (const { frameContext, frameSelector, frame } of frameContexts) {
-      let switchedFrame = false;
       try {
         assert(frame, `Expect frame of "${frameSelector}" to be defined`);
         await this.driver.switchTo().frame(frame);
-        switchedFrame = true;
-        partials.push(...await this.runPartialRecursive(frameContext));
+        partials.push(...await this.runPartialRecursive(frameContext, [...frameStack, frame]));
         await this.driver.switchTo().parentFrame();
       } catch {
-        if (switchedFrame) {
-          await this.driver.switchTo().parentFrame();
+        const win = await this.driver.getWindowHandle();
+        await this.driver.switchTo().window(win);
+        for (const frameElm of frameStack) {
+          await this.driver.switchTo().frame(frameElm);
         }
         partials.push("null");
       }
@@ -462,6 +469,7 @@ var AxeBuilder = class {
   async finishRun(partials) {
     const { driver, axeSource, config, option } = this;
     const win = await driver.getWindowHandle();
+    await driver.switchTo().window(win);
     try {
       await driver.executeScript(`window.open('about:blank')`);
       const handlers = await driver.getAllWindowHandles();
@@ -480,10 +488,7 @@ ${error2}`
     return res;
   }
 };
-if (typeof module === "object") {
-  exports = module.exports = AxeBuilder;
-}
-var src_default = AxeBuilder;
 export {
-  src_default as default
+  AxeBuilder,
+  AxeBuilder as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/webdriverjs",
-  "version": "4.7.2",
+  "version": "4.7.3-alpha.398+9cb50eb",
   "description": "Provides a method to inject and analyze web pages using axe",
   "contributors": [
     {
@@ -48,8 +48,8 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsup src/index.ts --dts --format esm,cjs",
-    "test": "mocha --timeout 10000 -r ts-node/register './tests/**/*.spec.ts'",
-    "test:esm": "node esmTest.mjs",
+    "test": "mocha --timeout 60000 -r ts-node/register 'test/**.spec.ts'",
+    "test:esm": "node test/esmTest.mjs",
     "coverage": "nyc npm run test",
     "prepare": "npm run build"
   },
@@ -119,5 +119,5 @@
     "functions": 85,
     "lines": 85
   },
-  "gitHead": "c0b063144d198360aeb73eb0cedec992062962fc"
+  "gitHead": "9cb50ebb6b138cb0aa6b785bc7c826c4b9a21086"
 }