@wdio/mcp 2.1.0 → 2.2.0

package/lib/snapshot.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Browser accessibility tree snapshot
+ * Extracts semantic information about page elements (roles, names, states)
+ */
+interface AccessibilityNode {
+    role: string;
+    name: string;
+    value: string;
+    description: string;
+    disabled: string;
+    focused: string;
+    selected: string;
+    checked: string;
+    expanded: string;
+    pressed: string;
+    readonly: string;
+    required: string;
+    level: string | number;
+    valuemin: string | number;
+    valuemax: string | number;
+    autocomplete: string;
+    haspopup: string;
+    invalid: string;
+    modal: string;
+    multiline: string;
+    multiselectable: string;
+    orientation: string;
+    keyshortcuts: string;
+    roledescription: string;
+    valuetext: string;
+}
+/**
+ * Get browser accessibility tree snapshot
+ * Browser-only - requires Puppeteer access via WebDriverIO browser instance
+ *
+ * @param browser - WebDriverIO browser instance
+ * @returns Flattened accessibility tree nodes
+ */
+declare function getBrowserAccessibilityTree(browser: WebdriverIO.Browser): Promise<AccessibilityNode[]>;
+
+type ElementType = 'interactable' | 'visual' | 'all';
+interface BrowserElementInfo {
+    tagName: string;
+    type: string;
+    id: string;
+    className: string;
+    textContent: string;
+    value: string;
+    placeholder: string;
+    href: string;
+    ariaLabel: string;
+    role: string;
+    src: string;
+    alt: string;
+    cssSelector: string;
+    isInViewport: boolean;
+}
+interface GetBrowserElementsOptions {
+    /** Type of elements to return. Default: 'interactable' */
+    elementType?: ElementType;
+}
+/**
+ * Get browser interactable elements
+ * Wrapper function that executes the script in browser context
+ *
+ * @param browser - WebDriverIO browser instance
+ * @param options - Options for element filtering
+ * @returns Array of visible element information
+ */
+declare function getBrowserInteractableElements(browser: WebdriverIO.Browser, options?: GetBrowserElementsOptions): Promise<BrowserElementInfo[]>;
+
+interface FilterOptions {
+    includeTagNames?: string[];
+    excludeTagNames?: string[];
+    requireAttributes?: string[];
+    minAttributeCount?: number;
+    fetchableOnly?: boolean;
+    clickableOnly?: boolean;
+    visibleOnly?: boolean;
+}
+
+/**
+ * Mobile element detection utilities for iOS and Android
+ *
+ * Uses page source parsing for optimal performance (2 HTTP calls vs 600+ for 50 elements)
+ */
+
+/**
+ * Element info returned by getMobileVisibleElements
+ * Uses uniform fields (all elements have same keys) to enable TOON tabular format
+ */
+interface MobileElementInfo {
+    selector: string;
+    tagName: string;
+    isInViewport: boolean;
+    text: string;
+    resourceId: string;
+    accessibilityId: string;
+    isEnabled: boolean;
+    altSelector: string;
+    bounds?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+/**
+ * Options for getMobileVisibleElements
+ */
+interface GetMobileElementsOptions {
+    includeContainers?: boolean;
+    includeBounds?: boolean;
+    filterOptions?: FilterOptions;
+}
+/**
+ * Get all visible elements from a mobile app
+ *
+ * Performance: 2 HTTP calls (getWindowSize + getPageSource) vs 12+ per element with legacy approach
+ */
+declare function getMobileVisibleElements(browser: WebdriverIO.Browser, platform: 'ios' | 'android', options?: GetMobileElementsOptions): Promise<MobileElementInfo[]>;
+
+export { type AccessibilityNode, type BrowserElementInfo, type ElementType, type GetBrowserElementsOptions, type GetMobileElementsOptions, type MobileElementInfo, getBrowserAccessibilityTree, getBrowserInteractableElements, getMobileVisibleElements };