axe-core 4.11.4 → 4.12.0-canary.81853d9

package/axe.d.ts

@@ -147,6 +147,9 @@ declare namespace axe {
     performanceTimer?: boolean;
     pingWaitTime?: number;
   }
+  interface NormalizedRunOptions extends RunOptions {
+    runOnly?: RunOnly;
+  }
   interface PreloadOptions {
     assets: string[];
     timeout?: number;
@@ -331,7 +334,7 @@ declare namespace axe {
     matches?: string | ((node: Element, virtualNode: VirtualNode) => boolean);
     reviewOnFail?: boolean;
     actIds?: string[];
-    metadata?: Omit<RuleMetadata, 'ruleId' | 'tags' | 'actIds'>;
+    metadata?: Omit<RuleMetadata, 'ruleId' | 'tags' | 'actIds' | 'enabled'>;
   }
   interface AxePlugin {
     id: string;
@@ -349,6 +352,7 @@ declare namespace axe {
     helpUrl: string;
     tags: string[];
     actIds?: string[];
+    enabled?: boolean;
   }
   interface SerialDqElement {
     source: string;
@@ -501,6 +505,7 @@ declare namespace axe {
       offset?: number
     ) => string | Uint8Array | Array<number>;
     nodeSerializer: NodeSerializer;
+    normalizeRunOptions: (options?: RunOptions) => NormalizedRunOptions;
   }
 
   interface Aria {
@@ -618,13 +623,23 @@ declare namespace axe {
    * @param  {Array}  tags  Optional array of tags
    * @return {Array}  Array of rules
    */
-  function getRules(tags?: string[]): RuleMetadata[];
+  function getRules(
+    tags?: string[]
+  ): (Omit<RuleMetadata, 'enabled'> & { enabled: boolean })[];
 
   /**
    * Restores the default axe configuration
    */
   function reset(): void;
 
+  /**
+   * Restores the default locale that was active before any
+   * `axe.configure({ locale })` call. No-op if no non-default
+   * locale has ever been applied. Does not affect any other
+   * configuration.
+   */
+  function resetLocale(): void;
+
   /**
    * Function to register a plugin configuration in document and its subframes
    * @param  {Object}    plugin    A plugin configuration object
@@ -670,6 +685,31 @@ declare namespace axe {
     isDefault?: boolean
   ): void;
 
+  /**
+   * Run axe in the current window only
+   * @param   {ElementContext} context  Optional The `Context` specification object @see Context
+   * @param   {RunOptions}     options  Optional Options passed into rules or checks, temporarily modifying them.
+   * @returns {Promise<PartialResult>}  Partial result, for use in axe.finishRun.
+   */
+  function externalAPIs(params?: {
+    elementInternalsTimeout?: number;
+    getElementInternals?: () => Promise<ElementInternalsMap>;
+  }): void;
+
+  type ElementInternalsMap = Array<{
+    ancestry: CrossTreeSelector;
+    internals: Record<string, InternalsData>;
+  }>;
+  type InternalsData = string | InternalsDataIdref | InternalsDataIdrefs;
+  type InternalsDataIdref = {
+    type: 'HTMLElement';
+    value: CrossTreeSelector;
+  };
+  type InternalsDataIdrefs = {
+    type: 'NodeList';
+    value: CrossTreeSelector[];
+  };
+
   // axe.frameMessenger
   type FrameMessenger = {
     open: (topicHandler: TopicHandler) => Close | void;