axe-core 4.3.5 → 4.4.0-canary.1ba9917

package/README.md

@@ -6,7 +6,7 @@
 [![Commits](https://img.shields.io/github/commit-activity/y/dequelabs/axe-core.svg)](https://github.com/dequelabs/axe-core/commits/develop)
 [![GitHub contributors](https://img.shields.io/github/contributors/dequelabs/axe-core.svg)](https://github.com/dequelabs/axe-core/graphs/contributors)
 [![Join our Slack chat](https://img.shields.io/badge/slack-chat-purple.svg?logo=slack)](https://accessibility.deque.com/axe-community)
-[![Package Quality](http://npm.packagequality.com/shield/axe-core.svg)](http://packagequality.com/#?package=axe-core)
+[![Package Quality](https://npm.packagequality.com/shield/axe-core.svg)](https://packagequality.com/#?package=axe-core)
 
 Axe is an accessibility testing engine for websites and other HTML-based user interfaces. It's fast, secure, lightweight, and was built to seamlessly integrate with any existing test environment so you can automate accessibility testing alongside your regular functional testing.
 

package/axe.d.ts

@@ -50,6 +50,11 @@ declare namespace axe {
   type CrossFrameSelector = CrossTreeSelector[];
 
   type ContextObject = {
+    include?: Node | BaseSelector | Array<Node | BaseSelector | BaseSelector[]>;
+    exclude?: Node | BaseSelector | Array<Node | BaseSelector | BaseSelector[]>;
+  };
+
+  type SerialContextObject = {
     include?: BaseSelector | Array<BaseSelector | BaseSelector[]>;
     exclude?: BaseSelector | Array<BaseSelector | BaseSelector[]>;
   };
@@ -95,6 +100,7 @@ declare namespace axe {
     frameWaitTime?: number;
     preload?: boolean;
     performanceTimer?: boolean;
+    pingWaitTime?: number;
   }
   interface AxeResults extends EnvironmentData {
     toolOptions: RunOptions;
@@ -187,10 +193,7 @@ declare namespace axe {
     cssColors?: { [key: string]: number[] };
   }
   interface Spec {
-    branding?: {
-      brand?: string;
-      application?: string;
-    };
+    branding?: string | Branding;
     reporter?: ReporterVersion;
     checks?: Check[];
     rules?: Rule[];
@@ -203,6 +206,13 @@ declare namespace axe {
     // Deprecated - do not use.
     ver?: string;
   }
+  /**
+   * @deprecated Use branding: string instead to set the application key in help URLs
+   */
+  interface Branding {
+    brand?: string;
+    application?: string;
+  }
   interface Check {
     id: string;
     evaluate?: Function | string;
@@ -259,13 +269,16 @@ declare namespace axe {
     results: PartialRuleResult[];
     environmentData?: EnvironmentData;
   }
-  type PartialResults = Array<PartialResult | null>
+  type PartialResults = Array<PartialResult | null>;
   interface FrameContext {
     frameSelector: CrossTreeSelector;
-    frameContext: ContextObject;
+    frameContext: SerialContextObject;
   }
   interface Utils {
-    getFrameContexts: (context?: ElementContext) => FrameContext[];
+    getFrameContexts: (
+      context?: ElementContext,
+      options?: RunOptions
+    ) => FrameContext[];
     shadowSelect: (selector: CrossTreeSelector) => Element | null;
   }
   interface EnvironmentData {