axe-core 4.2.4 → 4.3.0

package/lib/core/base/virtual-node/serial-virtual-node.js

@@ -1,117 +0,0 @@
-import AbstractVirtualNode from './abstract-virtual-node';
-import { assert, validInputTypes } from '../../utils';
-
-class SerialVirtualNode extends AbstractVirtualNode {
-  /**
-   * Convert a serialised node into a VirtualNode object
-   * @param {Object} node Serialised node
-   */
-  constructor(serialNode) {
-    super();
-    this._props = normaliseProps(serialNode);
-    this._attrs = normaliseAttrs(serialNode);
-  }
-
-  // Accessof for DOM node properties
-  get props() {
-    return this._props;
-  }
-
-  /**
-   * Get the value of the given attribute name.
-   * @param {String} attrName The name of the attribute.
-   * @return {String|null} The value of the attribute or null if the attribute does not exist
-   */
-  attr(attrName) {
-    return this._attrs[attrName] || null;
-  }
-
-  /**
-   * Determine if the element has the given attribute.
-   * @param {String} attrName The name of the attribute
-   * @return {Boolean} True if the element has the attribute, false otherwise.
-   */
-  hasAttr(attrName) {
-    return this._attrs[attrName] !== undefined;
-  }
-
-  /**
-   * Return a list of attribute names for the element.
-   * @return {String[]}
-   */
-  get attrNames() {
-    return Object.keys(this._attrs);
-  }
-}
-
-/**
- * Convert between serialised props and DOM-like properties
- * @param {Object} serialNode
- * @return {Object} normalProperties
- */
-function normaliseProps(serialNode) {
-  let { nodeName } = serialNode;
-  const { nodeType = 1 } = serialNode;
-  assert(
-    typeof nodeType === 'number',
-    `nodeType has to be a number, got '${nodeType}'`
-  );
-  assert(
-    typeof nodeName === 'string',
-    `nodeName has to be a string, got '${nodeName}'`
-  );
-
-  nodeName = nodeName.toLowerCase();
-  let type = null;
-  if (nodeName === 'input') {
-    type = (
-      serialNode.type ||
-      (serialNode.attributes && serialNode.attributes.type) ||
-      ''
-    ).toLowerCase();
-
-    if (!validInputTypes().includes(type)) {
-      type = 'text';
-    }
-  }
-
-  const props = {
-    ...serialNode,
-    nodeType,
-    nodeName
-  };
-  if (type) {
-    props.type = type;
-  }
-
-  delete props.attributes;
-  return Object.freeze(props);
-}
-
-/**
- * Convert between serialised attributes and DOM-like attributes
- * @param {Object} serialNode
- * @return {Object} normalAttributes
- */
-function normaliseAttrs({ attributes = {} }) {
-  const attrMap = {
-    htmlFor: 'for',
-    className: 'class'
-  };
-
-  return Object.keys(attributes).reduce((attrs, attrName) => {
-    const value = attributes[attrName];
-    assert(
-      typeof value !== 'object' || value === null,
-      `expects attributes not to be an object, '${attrName}' was`
-    );
-
-    if (value !== undefined) {
-      const mappedName = attrMap[attrName] || attrName;
-      attrs[mappedName] = value !== null ? String(value) : null;
-    }
-    return attrs;
-  }, {});
-}
-
-export default SerialVirtualNode;

package/lib/core/base/virtual-node/virtual-node.js

@@ -1,194 +0,0 @@
-import AbstractVirtualNode from './abstract-virtual-node';
-import { isXHTML, validInputTypes } from '../../utils';
-import { isFocusable, getTabbableElements } from '../../../commons/dom';
-import cache from '../cache';
-
-let isXHTMLGlobal;
-let nodeIndex = 0;
-
-class VirtualNode extends AbstractVirtualNode {
-  /**
-   * Wrap the real node and provide list of the flattened children
-   * @param {Node} node the node in question
-   * @param {VirtualNode} parent The parent VirtualNode
-   * @param {String} shadowId the ID of the shadow DOM to which this node belongs
-   */
-  constructor(node, parent, shadowId) {
-    super();
-    this.shadowId = shadowId;
-    this.children = [];
-    this.actualNode = node;
-    this.parent = parent;
-
-    if (!parent) {
-      nodeIndex = 0;
-    }
-    this.nodeIndex = nodeIndex++;
-
-    this._isHidden = null; // will be populated by axe.utils.isHidden
-    this._cache = {};
-
-    if (typeof isXHTMLGlobal === 'undefined') {
-      isXHTMLGlobal = isXHTML(node.ownerDocument);
-    }
-    this._isXHTML = isXHTMLGlobal;
-
-    // we will normalize the type prop for inputs by looking strictly
-    // at the attribute and not what the browser resolves the type
-    // to be
-    if (node.nodeName.toLowerCase() === 'input') {
-      let type = node.getAttribute('type');
-      type = this._isXHTML ? type : (type || '').toLowerCase();
-
-      if (!validInputTypes().includes(type)) {
-        type = 'text';
-      }
-
-      this._type = type;
-    }
-
-    if (cache.get('nodeMap')) {
-      cache.get('nodeMap').set(node, this);
-    }
-  }
-
-  // abstract Node properties so we can run axe in DOM-less environments.
-  // add to the prototype so memory is shared across all virtual nodes
-  get props() {
-    const {
-      nodeType,
-      nodeName,
-      id,
-      multiple,
-      nodeValue,
-      value
-    } = this.actualNode;
-
-    return {
-      nodeType,
-      nodeName: this._isXHTML ? nodeName : nodeName.toLowerCase(),
-      id,
-      type: this._type,
-      multiple,
-      nodeValue,
-      value
-    };
-  }
-
-  /**
-   * Get the value of the given attribute name.
-   * @param {String} attrName The name of the attribute.
-   * @return {String|null} The value of the attribute or null if the attribute does not exist
-   */
-  attr(attrName) {
-    if (typeof this.actualNode.getAttribute !== 'function') {
-      return null;
-    }
-
-    return this.actualNode.getAttribute(attrName);
-  }
-
-  /**
-   * Determine if the element has the given attribute.
-   * @param {String} attrName The name of the attribute
-   * @return {Boolean} True if the element has the attribute, false otherwise.
-   */
-  hasAttr(attrName) {
-    if (typeof this.actualNode.hasAttribute !== 'function') {
-      return false;
-    }
-
-    return this.actualNode.hasAttribute(attrName);
-  }
-
-  /**
-   * Return a list of attribute names for the element.
-   * @return {String[]}
-   */
-  get attrNames() {
-    if (!this._cache.hasOwnProperty('attrNames')) {
-      let attrs;
-
-      // eslint-disable-next-line no-restricted-syntax
-      if (this.actualNode.attributes instanceof window.NamedNodeMap) {
-        // eslint-disable-next-line no-restricted-syntax
-        attrs = this.actualNode.attributes;
-      }
-      // if the attributes property is not of type NamedNodeMap
-      // then the DOM has been clobbered. E.g. <form><input name="attributes"></form>.
-      // We can clone the node to isolate it and then return
-      // the attributes
-      else {
-        attrs = this.actualNode.cloneNode(false).attributes;
-      }
-
-      this._cache.attrNames = Array.from(attrs).map(attr => attr.name);
-    }
-    return this._cache.attrNames;
-  }
-
-  /**
-   * Return a property of the computed style for this element and cache the result. This is much faster than called `getPropteryValue` every time.
-   * @see https://jsperf.com/get-property-value
-   * @return {String}
-   */
-  getComputedStylePropertyValue(property) {
-    const key = 'computedStyle_' + property;
-    if (!this._cache.hasOwnProperty(key)) {
-      if (!this._cache.hasOwnProperty('computedStyle')) {
-        this._cache.computedStyle = window.getComputedStyle(this.actualNode);
-      }
-
-      this._cache[key] = this._cache.computedStyle.getPropertyValue(property);
-    }
-    return this._cache[key];
-  }
-
-  /**
-   * Determine if the element is focusable and cache the result.
-   * @return {Boolean} True if the element is focusable, false otherwise.
-   */
-  get isFocusable() {
-    if (!this._cache.hasOwnProperty('isFocusable')) {
-      this._cache.isFocusable = isFocusable(this.actualNode);
-    }
-    return this._cache.isFocusable;
-  }
-
-  /**
-   * Return the list of tabbable elements for this element and cache the result.
-   * @return {VirtualNode[]}
-   */
-  get tabbableElements() {
-    if (!this._cache.hasOwnProperty('tabbableElements')) {
-      this._cache.tabbableElements = getTabbableElements(this);
-    }
-    return this._cache.tabbableElements;
-  }
-
-  /**
-   * Return the client rects for this element and cache the result.
-   * @return {DOMRect[]}
-   */
-  get clientRects() {
-    if (!this._cache.hasOwnProperty('clientRects')) {
-      this._cache.clientRects = Array.from(
-        this.actualNode.getClientRects()
-      ).filter(rect => rect.width > 0);
-    }
-    return this._cache.clientRects;
-  }
-
-  /**
-   * Return the bounding rect for this element and cache the result.
-   * @return {DOMRect}
-   */
-  get boundingClientRect() {
-    if (!this._cache.hasOwnProperty('boundingClientRect')) {
-      this._cache.boundingClientRect = this.actualNode.getBoundingClientRect();
-    }
-    return this._cache.boundingClientRect;
-  }
-}
-
-export default VirtualNode;

package/lib/core/constants.js

@@ -1,70 +0,0 @@
-const definitions = [
-  {
-    name: 'NA',
-    value: 'inapplicable',
-    priority: 0,
-    group: 'inapplicable'
-  },
-  {
-    name: 'PASS',
-    value: 'passed',
-    priority: 1,
-    group: 'passes'
-  },
-  {
-    name: 'CANTTELL',
-    value: 'cantTell',
-    priority: 2,
-    group: 'incomplete'
-  },
-  {
-    name: 'FAIL',
-    value: 'failed',
-    priority: 3,
-    group: 'violations'
-  }
-];
-
-const constants = {
-  helpUrlBase: 'https://dequeuniversity.com/rules/',
-  results: [],
-  resultGroups: [],
-  resultGroupMap: {},
-  impact: Object.freeze(['minor', 'moderate', 'serious', 'critical']),
-  preload: Object.freeze({
-    /**
-     * array of supported & preload(able) asset types.
-     */
-    assets: ['cssom', 'media'],
-    /**
-     * timeout value when resolving preload(able) assets
-     */
-    timeout: 10000
-  }),
-  allOrigins: '<unsafe_all_origins>',
-  sameOrigin: '<same_origin>'
-};
-
-definitions.forEach(definition => {
-  const name = definition.name;
-  const value = definition.value;
-  const priority = definition.priority;
-  const group = definition.group;
-
-  constants[name] = value;
-  constants[name + '_PRIO'] = priority;
-  constants[name + '_GROUP'] = group;
-
-  constants.results[priority] = value;
-  constants.resultGroups[priority] = group;
-
-  constants.resultGroupMap[value] = group;
-});
-
-// Freeze everything
-Object.freeze(constants.results);
-Object.freeze(constants.resultGroups);
-Object.freeze(constants.resultGroupMap);
-Object.freeze(constants);
-
-export default constants;

package/lib/core/core.js

@@ -1,91 +0,0 @@
-import constants from './constants';
-import log from './log';
-
-import AbstractVirtualNode from './base/virtual-node/abstract-virtual-node';
-import SerialVirtualNode from './base/virtual-node/serial-virtual-node';
-import VirtualNode from './base/virtual-node/virtual-node';
-import cache from './base/cache';
-
-import Audit from './base/audit';
-import CheckResult from './base/check-result';
-import Check from './base/check';
-import Context from './base/context';
-import metadataFunctionMap from './base/metadata-function-map';
-import RuleResult from './base/rule-result';
-import Rule from './base/rule';
-
-import * as imports from './imports';
-
-import cleanup from './public/cleanup';
-import configure from './public/configure';
-import frameMessenger from './public/frame-messenger';
-import getRules from './public/get-rules';
-import load from './public/load';
-import registerPlugin from './public/plugins';
-import { hasReporter, getReporter, addReporter } from './public/reporter';
-import reset from './public/reset';
-import runRules from './public/run-rules';
-import runVirtualRule from './public/run-virtual-rule';
-import run from './public/run';
-import setup from './public/setup';
-import teardown from './public/teardown';
-
-import naReporter from './reporters/na';
-import noPassesReporter from './reporters/no-passes';
-import rawEnvReporter from './reporters/raw-env';
-import rawReporter from './reporters/raw';
-import v1Reporter from './reporters/v1';
-import v2Reporter from './reporters/v2';
-
-import * as commons from '../commons';
-import * as utils from './utils';
-
-axe.constants = constants;
-axe.log = log;
-
-axe.AbstractVirtualNode = AbstractVirtualNode;
-axe.SerialVirtualNode = SerialVirtualNode;
-axe.VirtualNode = VirtualNode;
-axe._cache = cache;
-
-// Setting up this private/temp namespace for the tests (which cannot yet `import/export` things).
-// TODO: remove `_thisWillBeDeletedDoNotUse`
-axe._thisWillBeDeletedDoNotUse = axe._thisWillBeDeletedDoNotUse || {};
-axe._thisWillBeDeletedDoNotUse.base = {
-  Audit,
-  CheckResult,
-  Check,
-  Context,
-  RuleResult,
-  Rule,
-  metadataFunctionMap
-};
-
-axe.imports = imports;
-
-axe.cleanup = cleanup;
-axe.configure = configure;
-axe.frameMessenger = frameMessenger;
-axe.getRules = getRules;
-axe._load = load;
-axe.plugins = {};
-axe.registerPlugin = registerPlugin;
-axe.hasReporter = hasReporter;
-axe.getReporter = getReporter;
-axe.addReporter = addReporter;
-axe.reset = reset;
-axe._runRules = runRules;
-axe.runVirtualRule = runVirtualRule;
-axe.run = run;
-axe.setup = setup;
-axe.teardown = teardown;
-
-axe.commons = commons;
-axe.utils = utils;
-
-axe.addReporter('na', naReporter);
-axe.addReporter('no-passes', noPassesReporter);
-axe.addReporter('rawEnv', rawEnvReporter);
-axe.addReporter('raw', rawReporter);
-axe.addReporter('v1', v1Reporter);
-axe.addReporter('v2', v2Reporter, true);

package/lib/core/imports/index.js

@@ -1,39 +0,0 @@
-import { CssSelectorParser } from 'css-selector-parser';
-import doT from '@deque/dot';
-import emojiRegexText from 'emoji-regex';
-import memoize from 'memoizee';
-
-import es6promise from 'es6-promise';
-import { Uint32Array } from 'typedarray';
-import 'weakmap-polyfill';
-
-if (!('Promise' in window)) {
-  es6promise.polyfill();
-}
-
-if (!('Uint32Array' in window)) {
-  window.Uint32Array = Uint32Array;
-}
-if (window.Uint32Array) {
-  // @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/some
-  if (!('some' in window.Uint32Array.prototype)) {
-    Object.defineProperty(window.Uint32Array.prototype, 'some', {
-      value: Array.prototype.some
-    });
-  }
-
-  if (!('reduce' in window.Uint32Array.prototype)) {
-    // @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/reduce
-    Object.defineProperty(window.Uint32Array.prototype, 'reduce', {
-      value: Array.prototype.reduce
-    });
-  }
-}
-
-/**
- * Namespace `axe.imports` which holds required external dependencies
- *
- * @namespace imports
- * @memberof axe
- */
-export { CssSelectorParser, doT, emojiRegexText, memoize };

package/lib/core/index.js

@@ -1,40 +0,0 @@
-/*exported axe, commons */
-/*global axeFunction, module, define */
-// exported namespace for axe
-/*eslint no-use-before-define: 0, no-unused-vars: 0*/
-var axe = axe || {};
-axe.version = '<%= pkg.version %>';
-
-if (typeof define === 'function' && define.amd) {
-  // Explicitly naming the module to avoid mismatched anonymous define() modules when injected in a page
-  define('axe-core', [], () => axe);
-}
-if (
-  typeof module === 'object' &&
-  module.exports &&
-  typeof axeFunction.toString === 'function'
-) {
-  axe.source =
-    '(' +
-    axeFunction.toString() +
-    ')(typeof window === "object" ? window : this);';
-  module.exports = axe;
-}
-if (typeof window.getComputedStyle === 'function') {
-  window.axe = axe;
-}
-// local namespace for common functions
-var commons;
-
-function SupportError(error) {
-  this.name = 'SupportError';
-  this.cause = error.cause;
-  this.message = `\`${error.cause}\` - feature unsupported in your environment.`;
-  if (error.ruleId) {
-    this.ruleId = error.ruleId;
-    this.message += ` Skipping ${this.ruleId} rule.`;
-  }
-  this.stack = new Error().stack;
-}
-SupportError.prototype = Object.create(Error.prototype);
-SupportError.prototype.constructor = SupportError;

package/lib/core/log.js

@@ -1,13 +0,0 @@
-/*eslint no-console: 0 */
-
-/**
- * Logs a message to the developer console (if it exists and is active).
- */
-function log() {
-  if (typeof console === 'object' && console.log) {
-    // IE does not support console.log.apply
-    Function.prototype.apply.call(console.log, console, arguments);
-  }
-}
-
-export default log;

package/lib/core/public/cleanup.js

@@ -1,51 +0,0 @@
-function cleanup(resolve, reject) {
-  resolve = resolve || function res() {};
-  reject = reject || axe.log;
-
-  if (!axe._audit) {
-    throw new Error('No audit configured');
-  }
-
-  var q = axe.utils.queue();
-  // If a plugin fails it's cleanup, we still want the others to run
-  var cleanupErrors = [];
-
-  Object.keys(axe.plugins).forEach(key => {
-    q.defer(res => {
-      var rej = function rej(err) {
-        cleanupErrors.push(err);
-        res();
-      };
-      try {
-        axe.plugins[key].cleanup(res, rej);
-      } catch (err) {
-        rej(err);
-      }
-    });
-  });
-
-  var flattenedTree = axe.utils.getFlattenedTree(document.body);
-
-  axe.utils.querySelectorAll(flattenedTree, 'iframe, frame').forEach(node => {
-    q.defer((res, rej) => {
-      return axe.utils.sendCommandToFrame(
-        node.actualNode,
-        {
-          command: 'cleanup-plugin'
-        },
-        res,
-        rej
-      );
-    });
-  });
-
-  q.then(results => {
-    if (cleanupErrors.length === 0) {
-      resolve(results);
-    } else {
-      reject(cleanupErrors);
-    }
-  }).catch(reject);
-}
-
-export default cleanup;