123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
/** * Copyright 2018 Google Inc. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the 'License'); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * *     http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an 'AS IS' BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */import { CDPSession } from "./Connection.js";import { ElementHandle } from "./ElementHandle.js";/** * Represents a Node and the properties of it that are relevant to Accessibility. * @public */export interface SerializedAXNode {  /**   * The {@link https://www.w3.org/TR/wai-aria/#usage_intro | role} of the node.   */  role: string;  /**   * A human readable name for the node.   */  name?: string;  /**   * The current value of the node.   */  value?: string | number;  /**   * An additional human readable description of the node.   */  description?: string;  /**   * Any keyboard shortcuts associated with this node.   */  keyshortcuts?: string;  /**   * A human readable alternative to the role.   */  roledescription?: string;  /**   * A description of the current value.   */  valuetext?: string;  disabled?: boolean;  expanded?: boolean;  focused?: boolean;  modal?: boolean;  multiline?: boolean;  /**   * Whether more than one child can be selected.   */  multiselectable?: boolean;  readonly?: boolean;  required?: boolean;  selected?: boolean;  /**   * Whether the checkbox is checked, or in a   * {@link https://www.w3.org/TR/wai-aria-practices/examples/checkbox/checkbox-2/checkbox-2.html | mixed state}.   */  checked?: boolean | "mixed";  /**   * Whether the node is checked or in a mixed state.   */  pressed?: boolean | "mixed";  /**   * The level of a heading.   */  level?: number;  valuemin?: number;  valuemax?: number;  autocomplete?: string;  haspopup?: string;  /**   * Whether and in what way this node's value is invalid.   */  invalid?: string;  orientation?: string;  /**   * Children of this node, if there are any.   */  children?: SerializedAXNode[];}/** * @public */export interface SnapshotOptions {  /**   * Prune uninteresting nodes from the tree.   * @defaultValue true   */  interestingOnly?: boolean;  /**   * Root node to get the accessibility tree for   * @defaultValue The root node of the entire page.   */  root?: ElementHandle<any>;}/** * The Accessibility class provides methods for inspecting Chromium's * accessibility tree. The accessibility tree is used by assistive technology * such as {@link https://en.wikipedia.org/wiki/Screen_reader | screen readers} or * {@link https://en.wikipedia.org/wiki/Switch_access | switches}. * * @remarks * * Accessibility is a very platform-specific thing. On different platforms, * there are different screen readers that might have wildly different output. * * Blink - Chrome's rendering engine - has a concept of "accessibility tree", * which is then translated into different platform-specific APIs. Accessibility * namespace gives users access to the Blink Accessibility Tree. * * Most of the accessibility tree gets filtered out when converting from Blink * AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. * By default, Puppeteer tries to approximate this filtering, exposing only * the "interesting" nodes of the tree. * * @public */export declare class Accessibility {  #private;  /**   * @internal   */  constructor(client: CDPSession);  /**   * Captures the current state of the accessibility tree.   * The returned object represents the root accessible node of the page.   *   * @remarks   *   * **NOTE** The Chromium accessibility tree contains nodes that go unused on   * most platforms and by most screen readers. Puppeteer will discard them as   * well for an easier to process tree, unless `interestingOnly` is set to   * `false`.   *   * @example   * An example of dumping the entire accessibility tree:   *   * ```ts   * const snapshot = await page.accessibility.snapshot();   * console.log(snapshot);   * ```   *   * @example   * An example of logging the focused node's name:   *   * ```ts   * const snapshot = await page.accessibility.snapshot();   * const node = findFocusedNode(snapshot);   * console.log(node && node.name);   *   * function findFocusedNode(node) {   *   if (node.focused) return node;   *   for (const child of node.children || []) {   *     const foundNode = findFocusedNode(child);   *     return foundNode;   *   }   *   return null;   * }   * ```   *   * @returns An AXNode object representing the snapshot.   */  snapshot(options?: SnapshotOptions): Promise<SerializedAXNode | null>;  private serializeTree;  private collectInterestingNodes;}