@axe-core/playwright 4.6.2-alpha.379 → 4.7.0

package/dist/index.mjs

@@ -0,0 +1,338 @@
+// src/index.ts
+import assert from "assert";
+import axe from "axe-core";
+
+// src/utils.ts
+var normalizeContext = (includes, excludes) => {
+  const base = {
+    exclude: [],
+    include: []
+  };
+  if (excludes.length && Array.isArray(base.exclude)) {
+    base.exclude.push(...excludes);
+  }
+  if (includes.length) {
+    base.include = includes;
+  }
+  return base;
+};
+var analyzePage = ({
+  context,
+  options
+}) => {
+  const axeCore = window.axe;
+  return axeCore.run(context || document, options || {}).then((results) => {
+    return { error: null, results };
+  }).catch((err) => {
+    return { error: err.message, results: null };
+  });
+};
+
+// src/browser.ts
+var axeGetFrameContexts = ({
+  context
+}) => {
+  return window.axe.utils.getFrameContexts(context);
+};
+var axeShadowSelect = ({
+  frameSelector
+}) => {
+  return window.axe.utils.shadowSelect(frameSelector);
+};
+var axeRunPartial = ({
+  context,
+  options
+}) => {
+  return window.axe.runPartial(context, options);
+};
+var axeFinishRun = ({
+  options
+}) => {
+  return window.axe.finishRun(JSON.parse(window.partialResults), options);
+};
+function chunkResultString(chunk) {
+  if (!window.partialResults) {
+    window.partialResults = "";
+  }
+  window.partialResults += chunk;
+}
+
+// src/AxePartialRunner.ts
+var AxePartialRunner = class {
+  constructor(partialPromise, initiator = false) {
+    this.initiator = initiator;
+    this.partialPromise = caught(partialPromise);
+  }
+  partialPromise;
+  childRunners = [];
+  addChildResults(childResultRunner) {
+    this.childRunners.push(childResultRunner);
+  }
+  async getPartials() {
+    try {
+      const parentPartial = await this.partialPromise;
+      const childPromises = this.childRunners.map((childRunner) => {
+        return childRunner ? caught(childRunner.getPartials()) : [null];
+      });
+      const childPartials = (await Promise.all(childPromises)).flat(1);
+      return [parentPartial, ...childPartials];
+    } catch (e) {
+      if (this.initiator) {
+        throw e;
+      }
+      return [null];
+    }
+  }
+};
+var caught = ((f) => {
+  return (p) => (p.catch(f), p);
+})(() => {
+});
+
+// src/index.ts
+var { source } = axe;
+var AxeBuilder = class {
+  page;
+  includes;
+  excludes;
+  option;
+  source;
+  legacyMode = false;
+  errorUrl;
+  constructor({ page, axeSource }) {
+    this.page = page;
+    this.includes = [];
+    this.excludes = [];
+    this.option = {};
+    this.source = axeSource || source;
+    this.errorUrl = "https://github.com/dequelabs/axe-core-npm/blob/develop/packages/playwright/error-handling.md";
+  }
+  /**
+   * Selector to include in analysis.
+   * This may be called any number of times.
+   * @param String selector
+   * @returns this
+   */
+  include(selector) {
+    this.includes.push(selector);
+    return this;
+  }
+  /**
+   * Selector to exclude in analysis.
+   * This may be called any number of times.
+   * @param String selector
+   * @returns this
+   */
+  exclude(selector) {
+    this.excludes.push(selector);
+    return this;
+  }
+  /**
+   * Set options to be passed into axe-core
+   * @param RunOptions options
+   * @returns AxeBuilder
+   */
+  options(options) {
+    this.option = options;
+    return this;
+  }
+  /**
+   * Limit analysis to only the specified rules.
+   * Cannot be used with `AxeBuilder#withTags`
+   * @param String|Array rules
+   * @returns this
+   */
+  withRules(rules) {
+    rules = Array.isArray(rules) ? rules : [rules];
+    this.option = this.option || {};
+    this.option.runOnly = {
+      type: "rule",
+      values: rules
+    };
+    return this;
+  }
+  /**
+   * Limit analysis to only specified tags.
+   * Cannot be used with `AxeBuilder#withRules`
+   * @param String|Array tags
+   * @returns this
+   */
+  withTags(tags) {
+    tags = Array.isArray(tags) ? tags : [tags];
+    this.option = this.option || {};
+    this.option.runOnly = {
+      type: "tag",
+      values: tags
+    };
+    return this;
+  }
+  /**
+   * Set the list of rules to skip when running an analysis.
+   * @param String|Array rules
+   * @returns this
+   */
+  disableRules(rules) {
+    rules = Array.isArray(rules) ? rules : [rules];
+    this.option = this.option || {};
+    this.option.rules = {};
+    for (const rule of rules) {
+      this.option.rules[rule] = { enabled: false };
+    }
+    return this;
+  }
+  /**
+   * Use frameMessenger with <same_origin_only>
+   *
+   * This disables use of axe.runPartial() which is called in each frame, and
+   * axe.finishRun() which is called in a blank page. This uses axe.run() instead,
+   * but with the restriction that cross-origin frames will not be tested.
+   */
+  setLegacyMode(legacyMode = true) {
+    this.legacyMode = legacyMode;
+    return this;
+  }
+  /**
+   * Perform analysis and retrieve results. *Does not chain.*
+   * @return Promise<Result | Error>
+   */
+  async analyze() {
+    const context = normalizeContext(this.includes, this.excludes);
+    const { page, option: options } = this;
+    page.evaluate(this.script());
+    const runPartialDefined = await page.evaluate(
+      'typeof window.axe.runPartial === "function"'
+    );
+    let results;
+    if (!runPartialDefined || this.legacyMode) {
+      results = await this.runLegacy(context);
+      return results;
+    }
+    const partialResults = await this.runPartialRecursive(
+      page.mainFrame(),
+      context
+    );
+    const partials = await partialResults.getPartials();
+    try {
+      return await this.finishRun(partials);
+    } catch (error) {
+      throw new Error(
+        `${error.message}
+ Please check out ${this.errorUrl}`
+      );
+    }
+  }
+  /**
+   * Injects `axe-core` into all frames.
+   * @param Page - playwright page object
+   * @returns Promise<void>
+   */
+  async inject(frames) {
+    for (const iframe of frames) {
+      await iframe.evaluate(await this.script());
+      await iframe.evaluate(await this.axeConfigure());
+    }
+  }
+  /**
+   * Get axe-core source and configurations
+   * @returns String
+   */
+  script() {
+    return this.source;
+  }
+  async runLegacy(context) {
+    const frames = this.page.frames();
+    await this.inject(frames);
+    const axeResults = await this.page.evaluate(analyzePage, {
+      context,
+      options: this.option
+    });
+    if (axeResults.error) {
+      throw new Error(axeResults.error);
+    }
+    return axeResults.results;
+  }
+  /**
+   * Inject `axe-core` into each frame and run `axe.runPartial`.
+   * Because we need to inject axe into all frames all at once
+   * (to avoid any potential problems with the DOM becoming out-of-sync)
+   * but also need to not process results for any child frames if the parent
+   * frame throws an error (requirements of the data structure for `axe.finishRun`),
+   *  we have to return a deeply nested array of Promises and then flatten
+   * the array once all Promises have finished, throwing out any nested Promises
+   * if the parent Promise is not fulfilled.
+   * @param frame - playwright frame object
+   * @param context - axe-core context object
+   * @returns Promise<AxePartialRunner>
+   */
+  async runPartialRecursive(frame, context) {
+    const frameContexts = await frame.evaluate(axeGetFrameContexts, {
+      context
+    });
+    const partialPromise = frame.evaluate(axeRunPartial, {
+      context,
+      options: this.option
+    });
+    const initiator = frame === this.page.mainFrame();
+    const axePartialRunner = new AxePartialRunner(partialPromise, initiator);
+    for (const { frameSelector, frameContext } of frameContexts) {
+      let childResults = null;
+      try {
+        const iframeHandle = await frame.evaluateHandle(axeShadowSelect, {
+          frameSelector
+        });
+        const iframeElement = iframeHandle.asElement();
+        const childFrame = await iframeElement.contentFrame();
+        if (childFrame) {
+          await this.inject([childFrame]);
+          childResults = await this.runPartialRecursive(
+            childFrame,
+            frameContext
+          );
+        }
+      } catch {
+      }
+      axePartialRunner.addChildResults(childResults);
+    }
+    return axePartialRunner;
+  }
+  async finishRun(partialResults) {
+    const { page, option: options } = this;
+    const context = page.context();
+    const blankPage = await context.newPage();
+    assert(
+      blankPage,
+      "Please make sure that you have popup blockers disabled."
+    );
+    blankPage.evaluate(this.script());
+    blankPage.evaluate(await this.axeConfigure());
+    const sizeLimit = 6e7;
+    const partialString = JSON.stringify(partialResults);
+    async function chunkResults(result) {
+      const chunk = result.substring(0, sizeLimit);
+      await blankPage.evaluate(chunkResultString, chunk);
+      if (result.length > sizeLimit) {
+        return await chunkResults(result.substr(sizeLimit));
+      }
+    }
+    await chunkResults(partialString);
+    return await blankPage.evaluate(axeFinishRun, {
+      options
+    }).finally(async () => {
+      await blankPage.close();
+    });
+  }
+  async axeConfigure() {
+    const hasRunPartial = await this.page.evaluate(
+      'typeof window.axe?.runPartial === "function"'
+    );
+    return `
+    ;axe.configure({
+      ${!this.legacyMode && !hasRunPartial ? 'allowedOrigins: ["<unsafe_all_origins>"],' : 'allowedOrigins: ["<same_origin>"],'}
+      branding: { application: 'playwright' }
+    })
+    `;
+  }
+};
+export {
+  AxeBuilder as default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/playwright",
-  "version": "4.6.2-alpha.379+2e0fdb4",
+  "version": "4.7.0",
   "description": "Provides a method to inject and analyze web pages using axe",
   "contributors": [
     {
@@ -26,15 +26,24 @@
     "url": "https://github.com/dequelabs/axe-core-npm.git"
   },
   "license": "MPL-2.0",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "prebuild": "rimraf dist",
-    "build": "tsc",
+    "build": "tsup src/index.ts --dts --format esm,cjs",
     "test": "mocha --timeout 60000 -r ts-node/register 'tests/**.spec.ts'",
+    "test:esm": "node esmTest.mjs",
     "coverage": "nyc npm run test",
     "prepare": "npm run build"
   },
@@ -57,6 +66,7 @@
     "rimraf": "^3.0.2",
     "test-listen": "^1.1.0",
     "ts-node": "^10.9.1",
+    "tsup": "^6.7.0",
     "typescript": "^4.8.4"
   },
   "peerDependencies": {
@@ -81,5 +91,5 @@
     "functions": 100,
     "lines": 95
   },
-  "gitHead": "2e0fdb4a4661040b9b8dbb91bed1a96142e4fe0c"
+  "gitHead": "623da3a516cbf1c7a0a0461b23a8c98f094cc18d"
 }

package/dist/AxePartialRunner.d.ts

@@ -1,22 +0,0 @@
-import axe from 'axe-core';
-/**
- * This class parallelizes the async calls to axe.runPartial.
- *
- * In this project, most async calls needs to block execution, such as
- * the axeGetFrameContext() and getChildFrame() and calls.
- *
- * Unlike those calls, axe.runPartial() calls must run in parallel, so that
- * frame tests don't wait for each other. This is necessary to minimize the time
- * between when axe-core finds a frame, and when it is tested.
- */
-declare type GetPartialResultsResponse = Parameters<typeof axe.finishRun>[0];
-export default class AxePartialRunner {
-    private initiator;
-    private partialPromise;
-    private childRunners;
-    constructor(partialPromise: Promise<axe.PartialResult>, initiator?: boolean);
-    addChildResults(childResultRunner: AxePartialRunner | null): void;
-    getPartials(): Promise<GetPartialResultsResponse>;
-}
-export declare const caught: <T>(p: Promise<T>) => Promise<T>;
-export {};

package/dist/AxePartialRunner.js

@@ -1,96 +0,0 @@
-"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());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.caught = void 0;
-var AxePartialRunner = /** @class */ (function () {
-    function AxePartialRunner(partialPromise, initiator) {
-        if (initiator === void 0) { initiator = false; }
-        this.initiator = initiator;
-        this.childRunners = [];
-        this.partialPromise = (0, exports.caught)(partialPromise);
-    }
-    AxePartialRunner.prototype.addChildResults = function (childResultRunner) {
-        this.childRunners.push(childResultRunner);
-    };
-    AxePartialRunner.prototype.getPartials = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var parentPartial, childPromises, childPartials, e_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 3, , 4]);
-                        return [4 /*yield*/, this.partialPromise];
-                    case 1:
-                        parentPartial = _a.sent();
-                        childPromises = this.childRunners.map(function (childRunner) {
-                            return childRunner ? (0, exports.caught)(childRunner.getPartials()) : [null];
-                        });
-                        return [4 /*yield*/, Promise.all(childPromises)];
-                    case 2:
-                        childPartials = (_a.sent()).flat(1);
-                        return [2 /*return*/, __spreadArray([parentPartial], childPartials, true)];
-                    case 3:
-                        e_1 = _a.sent();
-                        if (this.initiator) {
-                            throw e_1;
-                        }
-                        return [2 /*return*/, [null]];
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    return AxePartialRunner;
-}());
-exports.default = AxePartialRunner;
-// Utility to tell NodeJS not to worry about catching promise errors async.
-// See: https://stackoverflow.com/questions/40920179/should-i-refrain-from-handling-promise-rejection-asynchronously
-exports.caught = (function (f) {
-    return function (p) { return (p.catch(f), p); };
-    /* eslint-disable @typescript-eslint/no-empty-function */
-})(function () { });
-//# sourceMappingURL=AxePartialRunner.js.map

package/dist/AxePartialRunner.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AxePartialRunner.js","sourceRoot":"","sources":["../src/AxePartialRunner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAaA;IAIE,0BACE,cAA0C,EAClC,SAA0B;QAA1B,0BAAA,EAAA,iBAA0B;QAA1B,cAAS,GAAT,SAAS,CAAiB;QAJ5B,iBAAY,GAAmC,EAAE,CAAC;QAMxD,IAAI,CAAC,cAAc,GAAG,IAAA,cAAM,EAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IAEM,0CAAe,GAAtB,UAAuB,iBAA0C;QAC/D,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;IAEY,sCAAW,GAAxB;;;;;;;wBAE0B,qBAAM,IAAI,CAAC,cAAc,EAAA;;wBAAzC,aAAa,GAAG,SAAyB;wBACzC,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAA,WAAW;4BACrD,OAAO,WAAW,CAAC,CAAC,CAAC,IAAA,cAAM,EAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;wBAClE,CAAC,CAAC,CAAC;wBACoB,qBAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAA;;wBAAjD,aAAa,GAAG,CAAC,SAAgC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;wBAChE,qCAAQ,aAAa,GAAK,aAAa,SAAE;;;wBAEzC,IAAI,IAAI,CAAC,SAAS,EAAE;4BAClB,MAAM,GAAC,CAAC;yBACT;wBACD,sBAAO,CAAC,IAAI,CAAC,EAAC;;;;;KAEjB;IACH,uBAAC;AAAD,CAAC,AA9BD,IA8BC;;AAED,2EAA2E;AAC3E,oHAAoH;AACvG,QAAA,MAAM,GAAG,CAAC,UAAC,CAAa;IACnC,OAAO,UAAI,CAAa,IAAiB,OAAA,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAf,CAAe,CAAC;IACzD,yDAAyD;AAC3D,CAAC,CAAC,CAAC,cAAO,CAAC,CAAC,CAAC"}

package/dist/browser.d.ts

@@ -1,14 +0,0 @@
-import type { GetFrameContextsParams, RunPartialParams, FinishRunParams, ShadowSelectParams } from './types';
-import { FrameContext, AxeResults, PartialResult } from 'axe-core';
-import axeCore from 'axe-core';
-declare global {
-    interface Window {
-        axe: typeof axeCore;
-        partialResults: string;
-    }
-}
-export declare const axeGetFrameContexts: ({ context }: GetFrameContextsParams) => FrameContext[];
-export declare const axeShadowSelect: ({ frameSelector }: ShadowSelectParams) => Element | null;
-export declare const axeRunPartial: ({ context, options }: RunPartialParams) => Promise<PartialResult>;
-export declare const axeFinishRun: ({ options }: FinishRunParams) => Promise<AxeResults>;
-export declare function chunkResultString(chunk: string): void;

package/dist/browser.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.chunkResultString = exports.axeFinishRun = exports.axeRunPartial = exports.axeShadowSelect = exports.axeGetFrameContexts = void 0;
-var axeGetFrameContexts = function (_a) {
-    var context = _a.context;
-    return window.axe.utils.getFrameContexts(context);
-};
-exports.axeGetFrameContexts = axeGetFrameContexts;
-var axeShadowSelect = function (_a) {
-    var frameSelector = _a.frameSelector;
-    return window.axe.utils.shadowSelect(frameSelector);
-};
-exports.axeShadowSelect = axeShadowSelect;
-var axeRunPartial = function (_a) {
-    var context = _a.context, options = _a.options;
-    return window.axe.runPartial(context, options);
-};
-exports.axeRunPartial = axeRunPartial;
-var axeFinishRun = function (_a) {
-    var options = _a.options;
-    return window.axe.finishRun(JSON.parse(window.partialResults), options);
-};
-exports.axeFinishRun = axeFinishRun;
-function chunkResultString(chunk) {
-    var _a;
-    (_a = window.partialResults) !== null && _a !== void 0 ? _a : (window.partialResults = '');
-    window.partialResults += chunk;
-}
-exports.chunkResultString = chunkResultString;
-//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":";;;AAmBO,IAAM,mBAAmB,GAAG,UAAC,EAEX;QADvB,OAAO,aAAA;IAEP,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACpD,CAAC,CAAC;AAJW,QAAA,mBAAmB,uBAI9B;AAEK,IAAM,eAAe,GAAG,UAAC,EAEX;QADnB,aAAa,mBAAA;IAEb,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;AACtD,CAAC,CAAC;AAJW,QAAA,eAAe,mBAI1B;AAEK,IAAM,aAAa,GAAG,UAAC,EAGX;QAFjB,OAAO,aAAA,EACP,OAAO,aAAA;IAEP,OAAO,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACjD,CAAC,CAAC;AALW,QAAA,aAAa,iBAKxB;AAEK,IAAM,YAAY,GAAG,UAAC,EAEX;QADhB,OAAO,aAAA;IAEP,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,CAAC;AAC1E,CAAC,CAAC;AAJW,QAAA,YAAY,gBAIvB;AAEF,SAAgB,iBAAiB,CAAC,KAAa;;IAC7C,MAAA,MAAM,CAAC,cAAc,oCAArB,MAAM,CAAC,cAAc,GAAK,EAAE,EAAC;IAC7B,MAAM,CAAC,cAAc,IAAI,KAAK,CAAC;AACjC,CAAC;AAHD,8CAGC"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA4B;AAY5B,qCAAkC;AAClC,iCAAwD;AAExD,qCAMmB;AACnB,wEAAkD;AAElD;IASE,oBAAY,EAAwC;YAAtC,IAAI,UAAA,EAAE,SAAS,eAAA;QAHrB,eAAU,GAAG,KAAK,CAAC;QAIzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,SAAS,IAAI,iBAAM,CAAC;QAClC,IAAI,CAAC,QAAQ;YACX,8FAA8F,CAAC;IACnG,CAAC;IAED;;;;;OAKG;IAEI,4BAAO,GAAd,UAAe,QAA6B;QAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IAEI,4BAAO,GAAd,UAAe,QAA6B;QAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IAEI,4BAAO,GAAd,UAAe,OAAmB;QAChC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IAEI,8BAAS,GAAhB,UAAiB,KAAwB;QACvC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC/C,0BAA0B;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG;YACpB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IAEI,6BAAQ,GAAf,UAAgB,IAAuB;QACrC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3C,0BAA0B;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG;YACpB,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI;SACb,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IAEI,iCAAY,GAAnB,UAAoB,KAAwB;QAC1C,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC/C,0BAA0B;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC;QAEvB,KAAmB,UAAK,EAAL,eAAK,EAAL,mBAAK,EAAL,IAAK,EAAE;YAArB,IAAM,IAAI,cAAA;YACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,kCAAa,GAApB,UAAqB,UAAiB;QAAjB,2BAAA,EAAA,iBAAiB;QACpC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IAEU,4BAAO,GAApB;;;;;;wBACQ,OAAO,GAAG,IAAA,wBAAgB,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;wBACzD,KAA4B,IAAI,EAA9B,IAAI,UAAA,EAAU,OAAO,YAAA,CAAU;wBAEvC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;wBACH,qBAAM,IAAI,CAAC,QAAQ,CAC3C,6CAA6C,CAC9C,EAAA;;wBAFK,iBAAiB,GAAG,SAEzB;6BAIG,CAAA,CAAC,iBAAiB,IAAI,IAAI,CAAC,UAAU,CAAA,EAArC,wBAAqC;wBAC7B,qBAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAA;;wBAAvC,OAAO,GAAG,SAA6B,CAAC;wBACxC,sBAAO,OAAO,EAAC;4BAEM,qBAAM,IAAI,CAAC,mBAAmB,CACnD,IAAI,CAAC,SAAS,EAAE,EAChB,OAAO,CACR,EAAA;;wBAHK,cAAc,GAAG,SAGtB;wBACgB,qBAAM,cAAc,CAAC,WAAW,EAAE,EAAA;;wBAA7C,QAAQ,GAAG,SAAkC;;;;wBAG1C,qBAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAA;4BAArC,sBAAO,SAA8B,EAAC;;;wBAEtC,MAAM,IAAI,KAAK,CACb,UAAI,OAAe,CAAC,OAAO,iCAAuB,IAAI,CAAC,QAAQ,CAAE,CAClE,CAAC;;;;;KAEL;IAED;;;;OAIG;IAEW,2BAAM,GAApB,UAAqB,MAAe;;;;;;8BACP,EAAN,iBAAM;;;6BAAN,CAAA,oBAAM,CAAA;wBAAhB,MAAM;wBACT,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,QAAQ,CAAA;wBAAC,qBAAM,IAAI,CAAC,MAAM,EAAE,EAAA;4BAAzC,qBAAM,cAAgB,SAAmB,EAAC,EAAA;;wBAA1C,SAA0C,CAAC;wBACrC,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,QAAQ,CAAA;wBAAC,qBAAM,IAAI,CAAC,YAAY,EAAE,EAAA;4BAA/C,qBAAM,cAAgB,SAAyB,EAAC,EAAA;;wBAAhD,SAAgD,CAAC;;;wBAF9B,IAAM,CAAA;;;;;;KAI5B;IAED;;;OAGG;IAEK,2BAAM,GAAd;QACE,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEa,8BAAS,GAAvB,UAAwB,OAA4B;;;;;;wBAI5C,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;wBAClC,qBAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAA;;wBAAzB,SAAyB,CAAC;wBACP,qBAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAW,EAAE;gCACvD,OAAO,SAAA;gCACP,OAAO,EAAE,IAAI,CAAC,MAAM;6BACrB,CAAC,EAAA;;wBAHI,UAAU,GAAG,SAGjB;wBAEF,IAAI,UAAU,CAAC,KAAK,EAAE;4BACpB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;yBACnC;wBAED,sBAAO,UAAU,CAAC,OAAO,EAAC;;;;KAC3B;IAED;;;;;;;;;;;;OAYG;IAEW,wCAAmB,GAAjC,UACE,KAAY,EACZ,OAA4B;;;;;4BAEN,qBAAM,KAAK,CAAC,QAAQ,CAAC,6BAAmB,EAAE;4BAC9D,OAAO,SAAA;yBACR,CAAC,EAAA;;wBAFI,aAAa,GAAG,SAEpB;wBACI,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,uBAAa,EAAE;4BACnD,OAAO,SAAA;4BACP,OAAO,EAAE,IAAI,CAAC,MAAM;yBACrB,CAAC,CAAC;wBACG,SAAS,GAAG,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;wBAC5C,gBAAgB,GAAG,IAAI,0BAAgB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;8BAEd,EAAb,+BAAa;;;6BAAb,CAAA,2BAAa,CAAA;wBAAhD,wBAA+B,EAA7B,aAAa,mBAAA,EAAE,YAAY,kBAAA;wBAClC,YAAY,GAA4B,IAAI,CAAC;;;;wBAE1B,qBAAM,KAAK,CAAC,cAAc,CAAC,yBAAe,EAAE;gCAC/D,aAAa,eAAA;6BACd,CAAC,EAAA;;wBAFI,YAAY,GAAG,SAEnB;wBAEI,aAAa,GACjB,YAAY,CAAC,SAAS,EAA4B,CAAC;wBAClC,qBAAM,aAAa,CAAC,YAAY,EAAE,EAAA;;wBAA/C,UAAU,GAAG,SAAkC;6BACjD,UAAU,EAAV,wBAAU;wBACZ,qBAAM,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;wBACjB,qBAAM,IAAI,CAAC,mBAAmB,CAC3C,UAAU,EACV,YAAY,CACb,EAAA;;wBAHD,YAAY,GAAG,SAGd,CAAC;;;;;;;wBAKN,gBAAgB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;;;wBApBH,IAAa,CAAA;;6BAuB3D,sBAAO,gBAAgB,EAAC;;;;KACzB;IAEa,8BAAS,GAAvB,UAAwB,cAA8B;;YAkBpD,SAAe,YAAY,CAAC,MAAc;;;;;;gCAClC,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;gCAC7C,qBAAM,SAAS,CAAC,QAAQ,CAAC,2BAAiB,EAAE,KAAK,CAAC,EAAA;;gCAAlD,SAAkD,CAAC;qCAE/C,CAAA,MAAM,CAAC,MAAM,GAAG,SAAS,CAAA,EAAzB,wBAAyB;gCACpB,qBAAM,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAA;oCAAnD,sBAAO,SAA4C,EAAC;;;;;aAEvD;;;;;;wBAxBK,KAA4B,IAAI,EAA9B,IAAI,UAAA,EAAU,OAAO,YAAA,CAAU;wBACjC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,qBAAM,OAAO,CAAC,OAAO,EAAE,EAAA;;wBAAnC,SAAS,GAAG,SAAuB;wBAEzC,IAAA,gBAAM,EACJ,SAAS,EACT,yDAAyD,CAC1D,CAAC;wBAEF,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;wBAClC,KAAA,CAAA,KAAA,SAAS,CAAA,CAAC,QAAQ,CAAA;wBAAC,qBAAM,IAAI,CAAC,YAAY,EAAE,EAAA;;wBAA5C,cAAmB,SAAyB,EAAC,CAAC;wBAIxC,SAAS,GAAG,QAAU,CAAC;wBACvB,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;wBAWrD,qBAAM,YAAY,CAAC,aAAa,CAAC,EAAA;;wBAAjC,SAAiC,CAAC;wBAC3B,qBAAM,SAAS;iCACnB,QAAQ,CAAC,sBAAY,EAAE;gCACtB,OAAO,SAAA;6BACR,CAAC;iCACD,OAAO,CAAC;;;gDACP,qBAAM,SAAS,CAAC,KAAK,EAAE,EAAA;;4CAAvB,SAAuB,CAAC;;;;iCACzB,CAAC,EAAA;4BANJ,sBAAO,SAMH,EAAC;;;;KACN;IAEa,iCAAY,GAA1B;;;;;4BACwB,qBAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAC5C,8CAA8C,CAC/C,EAAA;;wBAFK,aAAa,GAAG,SAErB;wBAED,sBAAO,wCAGH,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,aAAa;gCAChC,CAAC,CAAC,2CAA2C;gCAC7C,CAAC,CAAC,oCAAoC,kEAI3C,EAAC;;;;KACH;IACH,iBAAC;AAAD,CAAC,AA/SD,IA+SC"}

package/dist/types.d.ts

@@ -1,28 +0,0 @@
-import type { Page } from 'playwright-core';
-import type { RunOptions, AxeResults, ContextObject, CrossTreeSelector, PartialResult, SerialContextObject } from 'axe-core';
-export declare type PartialResults = PartialResult | null;
-export interface AnalyzePageParams {
-    context: SerialContextObject;
-    options: RunOptions;
-}
-export interface AxePlaywrightParams {
-    page: Page;
-    axeSource?: string;
-}
-export interface AnalyzePageResponse {
-    results: AxeResults;
-    error: string | null;
-}
-export interface GetFrameContextsParams {
-    context: ContextObject;
-}
-export interface ShadowSelectParams {
-    frameSelector: CrossTreeSelector;
-}
-export interface RunPartialParams {
-    context: ContextObject;
-    options: RunOptions;
-}
-export interface FinishRunParams {
-    options: RunOptions;
-}

package/dist/types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/utils.d.ts

@@ -1,15 +0,0 @@
-import type { SerialContextObject, SerialSelectorList } from 'axe-core';
-import type { AnalyzePageParams, AnalyzePageResponse } from './types';
-/**
- * Get running context
- * @param Array include
- * @param Array exclude
- * @returns SerialContextObject
- */
-export declare const normalizeContext: (includes: SerialSelectorList, excludes: SerialSelectorList) => SerialContextObject;
-/**
- * Analyze the page.
- * @param AnalyzePageParams analyzeContext
- * @returns Promise<AnalyzePageResponse>
- */
-export declare const analyzePage: ({ context, options }: AnalyzePageParams) => Promise<AnalyzePageResponse>;

package/dist/utils.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.analyzePage = exports.normalizeContext = void 0;
-/**
- * Get running context
- * @param Array include
- * @param Array exclude
- * @returns SerialContextObject
- */
-var normalizeContext = function (includes, excludes) {
-    var _a;
-    var base = {
-        exclude: [],
-        include: []
-    };
-    if (excludes.length && Array.isArray(base.exclude)) {
-        (_a = base.exclude).push.apply(_a, excludes);
-    }
-    if (includes.length) {
-        base.include = includes;
-    }
-    return base;
-};
-exports.normalizeContext = normalizeContext;
-/**
- * Analyze the page.
- * @param AnalyzePageParams analyzeContext
- * @returns Promise<AnalyzePageResponse>
- */
-var analyzePage = function (_a) {
-    var context = _a.context, options = _a.options;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    var axeCore = window.axe;
-    // Run axe-core
-    return axeCore
-        .run(context || document, options || {})
-        .then(function (results) {
-        return { error: null, results: results };
-    })
-        .catch(function (err) {
-        return { error: err.message, results: null };
-    });
-};
-exports.analyzePage = analyzePage;
-//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAOA;;;;;GAKG;AAEI,IAAM,gBAAgB,GAAG,UAC9B,QAA4B,EAC5B,QAA4B;;IAE5B,IAAM,IAAI,GAAwB;QAChC,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,IAAI,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAClD,CAAA,KAAA,IAAI,CAAC,OAAO,CAAA,CAAC,IAAI,WAAI,QAAQ,EAAE;KAChC;IAED,IAAI,QAAQ,CAAC,MAAM,EAAE;QACnB,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;KACzB;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAhBW,QAAA,gBAAgB,oBAgB3B;AAEF;;;;GAIG;AAEI,IAAM,WAAW,GAAG,UAAC,EAGR;QAFlB,OAAO,aAAA,EACP,OAAO,aAAA;IAEP,8DAA8D;IAC9D,IAAM,OAAO,GAAI,MAAc,CAAC,GAAG,CAAC;IAEpC,eAAe;IACf,OAAO,OAAO;SACX,GAAG,CAAC,OAAO,IAAI,QAAQ,EAAE,OAAO,IAAI,EAAE,CAAC;SACvC,IAAI,CAAC,UAAC,OAAmB;QACxB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,SAAA,EAAE,CAAC;IAClC,CAAC,CAAC;SACD,KAAK,CAAC,UAAC,GAAU;QAChB,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC/C,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAhBW,QAAA,WAAW,eAgBtB"}