donobu 1.0.0

package/dist/utils/MiscUtils.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiscUtils = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const os_1 = require("os");
+const jimp_1 = require("jimp");
+class MiscUtils {
+    constructor() { }
+    static DONOBU_VERSION = MiscUtils.getResourceFileAsString((0, path_1.join)('generated', 'version'));
+    /**
+     * This is the base working directory for the entire application. Care is made
+     * to ensure we do not access data outside of this directory to maintain
+     * proper permissions across platforms.
+     *
+     * Returns platform-specific application data directories:
+     * - macOS: ~/Library/Application Support/Donobu
+     * - Windows: %APPDATA%/Donobu
+     * - Linux: ~/.config/Donobu
+     *
+     * If the BASE_WORKING_DIR environment variable is set, its value is returned.
+     */
+    static baseWorkingDirectory() {
+        const persistenceDirOverride = process.env['BASE_WORKING_DIR'];
+        if (persistenceDirOverride) {
+            return persistenceDirOverride;
+        }
+        const appName = 'Donobu Studio';
+        switch ((0, os_1.platform)()) {
+            case 'win32':
+                // Windows - typically use %APPDATA% (Roaming).
+                return (0, path_1.join)(process.env.APPDATA || (0, path_1.join)((0, os_1.homedir)(), 'AppData', 'Roaming'), appName);
+            case 'darwin':
+                // macOS
+                return (0, path_1.join)((0, os_1.homedir)(), 'Library', 'Application Support', appName);
+            case 'linux':
+                // Linux - following XDG Base Directory Specification.
+                return (0, path_1.join)(process.env.XDG_CONFIG_HOME || (0, path_1.join)((0, os_1.homedir)(), '.config'), appName);
+            default:
+                // Default fallback to home directory for other platforms.
+                return (0, path_1.join)((0, os_1.homedir)(), `.${appName}`);
+        }
+    }
+    /**
+     * Updates token counts in flow metadata based on GPT response
+     */
+    static updateTokenCounts(gptResponse, flowMetadata) {
+        flowMetadata.inputTokensUsed += gptResponse.promptTokensUsed;
+        flowMetadata.completionTokensUsed += gptResponse.completionTokensUsed;
+    }
+    /**
+     * Loads a resource file from the assets directory as a string
+     */
+    static getResourceFileAsString(fileName) {
+        const bytes = this.getResourceFileAsBytes(fileName);
+        return bytes.toString('utf8');
+    }
+    /**
+     * Loads a resource file from the assets directory as a Buffer
+     */
+    static getResourceFileAsBytes(fileName) {
+        // Check if we're running from compiled code.
+        const isProduction = __dirname.includes('dist');
+        const assetPath = isProduction
+            ? (0, path_1.join)(__dirname, '..', 'assets', fileName) // Go up one level from dist/
+            : (0, path_1.join)(__dirname, '..', '..', 'assets', fileName); // Go up two levels from src/
+        return (0, fs_1.readFileSync)(assetPath);
+    }
+    /**
+     * Reduces the resolution of a PNG image by half.
+     *
+     * @param inputImageBytes - The input PNG image as a Buffer.
+     * @returns A Promise that resolves to the resized PNG image as a Buffer.
+     * @throws Error if image processing fails
+     */
+    static async resizePngByHalf(inputImageBytes) {
+        const image = await jimp_1.Jimp.read(inputImageBytes);
+        image.resize({
+            w: Math.floor(image.bitmap.width / 2),
+            h: Math.floor(image.bitmap.height / 2),
+        });
+        return image.getBuffer('image/png');
+    }
+    /**
+     * Returns a duration (in milliseconds) that represents a statistically
+     * plausible human mouse-click press duration.
+     */
+    static generateHumanLikeClickDurationInMs() {
+        // Statistical constants for human-like click-press durations.
+        const CLICK_MEDIAN = 85; // ms
+        const Q1 = 75; // ms
+        const Q3 = 95; // ms
+        const LOWER_FENCE = 55; // ms
+        const UPPER_FENCE = 135; // ms
+        // Box-Muller transform to generate normally distributed values.
+        const u1 = Math.random();
+        const u2 = Math.random();
+        const z = Math.sqrt(-2.0 * Math.log(u1)) * Math.cos(2.0 * Math.PI * u2);
+        // Scale to our desired range (using IQR as a reference for standard deviation).
+        const standardDeviation = (Q3 - Q1) / 1.34896; // Approximate relationship between IQR and SD.
+        const value = CLICK_MEDIAN + z * standardDeviation;
+        // Clamp the value between our fences.
+        return Math.round(Math.min(Math.max(value, LOWER_FENCE), UPPER_FENCE));
+    }
+    /**
+     * Returns a duration (in milliseconds) that represents a statistically
+     * plausible human key press duration.
+     */
+    static generateHumanLikeKeyPressDurationInMs(key) {
+        // Statistical constants for human-like typing.
+        const REGULAR_KEY_MEDIAN = 100; // ms
+        const REGULAR_KEY_Q1 = 80; // ms
+        const REGULAR_KEY_Q3 = 120; // ms
+        const REGULAR_KEY_LOWER_FENCE = 60; // ms
+        const REGULAR_KEY_UPPER_FENCE = 160; // ms
+        // Modifier and special keys are typically held longer
+        const SPECIAL_KEYS = new Set([
+            'Shift',
+            'Control',
+            'Alt',
+            'Meta',
+            'Enter',
+            'Tab',
+            'CapsLock',
+            'ArrowUp',
+            'ArrowDown',
+            'ArrowLeft',
+            'ArrowRight',
+            'Home',
+            'End',
+            'PageUp',
+            'PageDown',
+        ]);
+        const isSpecialKey = SPECIAL_KEYS.has(key);
+        // Generate base duration using Box-Muller transform.
+        const u1 = Math.random();
+        const u2 = Math.random();
+        const z = Math.sqrt(-2.0 * Math.log(u1)) * Math.cos(2.0 * Math.PI * u2);
+        const standardDeviation = (REGULAR_KEY_Q3 - REGULAR_KEY_Q1) / 1.34896;
+        let value = REGULAR_KEY_MEDIAN + z * standardDeviation;
+        // Clamp to reasonable bounds.
+        value = Math.min(Math.max(value, REGULAR_KEY_LOWER_FENCE), REGULAR_KEY_UPPER_FENCE);
+        // Special keys are held longer.
+        if (isSpecialKey) {
+            value *= 1.5; // 50% longer for special keys
+        }
+        // Add small random variation
+        const jitter = Math.random() * 10 - 5; // +/- 5ms random jitter.
+        return Math.round(value + jitter);
+    }
+    /**
+     * Creates a new random tool call ID. This is useful for registering ProposedToolCall and
+     * ToolCalls that were proposed and/or invoked by a user rather than by a GPT, or by GPT
+     * APIs that do not natively use tool call IDs (i.e. Google Gemini). Note OpenAI constrains the
+     * length of tool call IDs to no longer than 40 characters.
+     *
+     * @returns A string representing a unique tool call ID.
+     */
+    static createAdHocToolCallId() {
+        return `adhoc_${crypto.randomUUID().replace(/-/g, '')}`;
+    }
+}
+exports.MiscUtils = MiscUtils;
+//# sourceMappingURL=MiscUtils.js.map

package/dist/utils/MiscUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiscUtils.js","sourceRoot":"","sources":["../../src/utils/MiscUtils.ts"],"names":[],"mappings":";;;AAAA,2BAAkC;AAClC,+BAA4B;AAC5B,2BAAuC;AACvC,+BAA4B;AAE5B,MAAa,SAAS;IACpB,gBAAuB,CAAC;IAEjB,MAAM,CAAU,cAAc,GAAG,SAAS,CAAC,uBAAuB,CACvE,IAAA,WAAI,EAAC,WAAW,EAAE,SAAS,CAAC,CAC7B,CAAC;IAEF;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,oBAAoB;QAChC,MAAM,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAE/D,IAAI,sBAAsB,EAAE,CAAC;YAC3B,OAAO,sBAAsB,CAAC;QAChC,CAAC;QAED,MAAM,OAAO,GAAG,eAAe,CAAC;QAEhC,QAAQ,IAAA,aAAQ,GAAE,EAAE,CAAC;YACnB,KAAK,OAAO;gBACV,+CAA+C;gBAC/C,OAAO,IAAA,WAAI,EACT,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,EAAE,SAAS,CAAC,EAC5D,OAAO,CACR,CAAC;YAEJ,KAAK,QAAQ;gBACX,QAAQ;gBACR,OAAO,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;YAEpE,KAAK,OAAO;gBACV,sDAAsD;gBACtD,OAAO,IAAA,WAAI,EACT,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,CAAC,EACzD,OAAO,CACR,CAAC;YAEJ;gBACE,0DAA0D;gBAC1D,OAAO,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,IAAI,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAC7B,WAGC,EACD,YAGC;QAED,YAAY,CAAC,eAAe,IAAI,WAAW,CAAC,gBAAgB,CAAC;QAC7D,YAAY,CAAC,oBAAoB,IAAI,WAAW,CAAC,oBAAoB,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,uBAAuB,CAAC,QAAgB;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QACpD,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB,CAAC,QAAgB;QACnD,6CAA6C;QAC7C,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,SAAS,GAAG,YAAY;YAC5B,CAAC,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,6BAA6B;YACzE,CAAC,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,6BAA6B;QAClF,OAAO,IAAA,iBAAY,EAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CACjC,eAAuB;QAEvB,MAAM,KAAK,GAAG,MAAM,WAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/C,KAAK,CAAC,MAAM,CAAC;YACX,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;YACrC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;SACvC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kCAAkC;QAC9C,8DAA8D;QAC9D,MAAM,YAAY,GAAG,EAAE,CAAC,CAAC,KAAK;QAC9B,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK;QACpB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK;QACpB,MAAM,WAAW,GAAG,EAAE,CAAC,CAAC,KAAK;QAC7B,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,KAAK;QAC9B,gEAAgE;QAChE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QACxE,gFAAgF;QAChF,MAAM,iBAAiB,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,+CAA+C;QAC9F,MAAM,KAAK,GAAG,YAAY,GAAG,CAAC,GAAG,iBAAiB,CAAC;QACnD,sCAAsC;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,qCAAqC,CAAC,GAAW;QAC7D,+CAA+C;QAC/C,MAAM,kBAAkB,GAAG,GAAG,CAAC,CAAC,KAAK;QACrC,MAAM,cAAc,GAAG,EAAE,CAAC,CAAC,KAAK;QAChC,MAAM,cAAc,GAAG,GAAG,CAAC,CAAC,KAAK;QACjC,MAAM,uBAAuB,GAAG,EAAE,CAAC,CAAC,KAAK;QACzC,MAAM,uBAAuB,GAAG,GAAG,CAAC,CAAC,KAAK;QAC1C,sDAAsD;QACtD,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC;YAC3B,OAAO;YACP,SAAS;YACT,KAAK;YACL,MAAM;YACN,OAAO;YACP,KAAK;YACL,UAAU;YACV,SAAS;YACT,WAAW;YACX,WAAW;YACX,YAAY;YACZ,MAAM;YACN,KAAK;YACL,QAAQ;YACR,UAAU;SACX,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE3C,qDAAqD;QACrD,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAExE,MAAM,iBAAiB,GAAG,CAAC,cAAc,GAAG,cAAc,CAAC,GAAG,OAAO,CAAC;QACtE,IAAI,KAAK,GAAG,kBAAkB,GAAG,CAAC,GAAG,iBAAiB,CAAC;QAEvD,8BAA8B;QAC9B,KAAK,GAAG,IAAI,CAAC,GAAG,CACd,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,uBAAuB,CAAC,EACxC,uBAAuB,CACxB,CAAC;QAEF,gCAAgC;QAChC,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,IAAI,GAAG,CAAC,CAAC,8BAA8B;QAC9C,CAAC;QAED,6BAA6B;QAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,yBAAyB;QAEhE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB;QACjC,OAAO,SAAS,MAAM,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;IAC1D,CAAC;;AApMH,8BAqMC"}

package/dist/utils/PlaywrightUtils.d.ts

@@ -0,0 +1,180 @@
+import { ElementHandle, Locator, Page } from 'playwright';
+import { FlowMetadata, State } from '../models/FlowMetadata';
+import { InteractableElement } from '../models/InteractableElement';
+declare global {
+    interface Window {
+        donobuNextState: string | null;
+        donobuGetClickableElements: () => Element[];
+        donobuFocusPage: () => boolean;
+        donobuGenerateSmartSelectors: (element: Element) => string[];
+    }
+}
+/**
+ * Miscellaneous utility functions for working with the Playwright SDK. If you are looking to
+ * instantiate a Playwright instance, see PlaywrightSetup instead.
+ */
+export declare class PlaywrightUtils {
+    private static readonly logger;
+    private static readonly ACCESSIBILITY_TEST_INIT_SCRIPT;
+    private static readonly CLICKABLE_ELEMENTS_TRACKER_INIT_SCRIPT;
+    private static readonly DIALOG_PROMPT_TRACKER_INIT_SCRIPT;
+    private static readonly SMART_SELECTOR_GENERATOR_INIT_SCRIPT;
+    private static readonly PAGE_INTERACTIONS_TRACKER_INIT_SCRIPT;
+    private static readonly DONOBU_CONTROL_PANEL_INIT_SCRIPT;
+    private static readonly DONOBU_CONTROL_PANEL_ELEMENT_ID;
+    private static readonly DONOBU_CONTROL_PANEL_HEADLINE_ELEMENT_ID;
+    static readonly DONOBU_INTERACTABLE_ATTRIBUTE = "data-donobu-interactable";
+    static readonly DONOBU_ANNOTATION_ATTRIBUTE = "data-donobu-annotation";
+    /**
+     * Attempts to take a screenshot of the given page in PNG format, returning
+     * the raw byte array. If the operation fails, an empty array is returned.
+     * Note that if the Donobu control panel is present in the page, it will be
+     * excluded from the screenshot.
+     */
+    static takePngScreenshot(page: Page): Promise<Buffer>;
+    /**
+     * Generate valid selectors for the given element. The generated selectors are
+     * in a priority order based on their ability to identify the given element.
+     * For example, an unambiguous selector that matches the element exactly are
+     * first in the list, and weaker selectors that match multiple elements are
+     * last.
+     */
+    static generateSelectors(element: Locator): Promise<string[]>;
+    /**
+     * Returns a JavaScript code snippet intended to run as an initialization
+     * script for `DonobuFlow` flows. This script helps other scripts to know
+     * which elements have mouse-click related event listeners attached to them
+     * via inspecting the {@code window.donobuGetClickableElements} element array.
+     */
+    static clickableElementsTrackerInitScript(): string;
+    /**
+     * Returns a JavaScript code snippet intended to run as an initialization
+     * script for `DonobuFlow` flows. This script helps flows handle/track
+     * prompts/confirmations. This is done specially since these browser actions
+     * pause the Javascript main thread and also cause issues with running various
+     * Playwright actions. See `DonobuFlow.onDialog(Dialog)` for details.
+     */
+    static dialogPromptTrackerInitScript(): string;
+    /**
+     * Returns a JavaScript code snippet intended to run as an initialization
+     * script for `DonobuFlow` flows. This is an in-page version of the
+     * `SelectorGenerator` class so that smart selectors can be generated in
+     * the web client. This is done so the
+     * {@link PlaywrightUtils.pageInteractionsTrackerInitScript()} can generate
+     * smart selectors on the fly and pass them to the `PageInteractionTracker`
+     * so the page interactions can be converted to synthetic `ToolCallResult`s.
+     */
+    static smartSelectorGeneratorInitScript(): string;
+    /**
+     * This script is used by the `RunAccessibilityTestTool` to test the
+     * accessibility of a webpage. This script is injected on page load, rather
+     * than when running the `RunAccessibilityTestTool` because we need to bypass
+     * webpage Content Security Policy (CSP); this is done by injecting the
+     * script via `BrowserContext#addInitScript`.
+     */
+    static accessibilityTestInitScript(): string;
+    static pageInteractionsTrackerInitScript(): string;
+    static donobuControlPanelInitScript(): string;
+    /**
+     * Creates a visual sparkle effect at the specified browser-page coordinates,
+     * automatically detecting if the point lies inside a same-origin iframe (and nesting deeper
+     * if necessary). Injects the sparkle into that frame’s document at the correct local coords.
+     *
+     * @param page - The Playwright Page object
+     * @param x - The x-coordinate in the top-level page coordinate space (relative to the browser window)
+     * @param y - The y-coordinate in the top-level page coordinate space
+     * @param durationMs - How long the sparkle remains (ms, default 800)
+     * @param emoji - The emoji to display (default '✨')
+     * @param size - CSS font-size for the emoji (default '40px')
+     */
+    static createSparkleEffect(page: Page, x: number, y: number, durationMs?: number, emoji?: string, size?: string): Promise<void>;
+    /**
+     * Recursively finds the deepest same-origin Frame that covers the point (top-level coordinates).
+     * Returns the Frame plus the local coordinates (relative to that frame's viewport).
+     *
+     * If no same-origin child frame covers (x, y), it returns the main frame and the original coords.
+     */
+    private static findDeepestFrameAtPoint;
+    static getLocatorOrItsLabel(element: Locator): Promise<Locator>;
+    /**
+     * Reads and clears the desired next state as directed by the in-flow control
+     * panel. Note that the control panel does not have carte blanche control, as
+     * we only support the control panel signaling an intent to pause and resume a
+     * flow.
+     */
+    static popControlPanelNextDesiredState(page: Page): Promise<State | null>;
+    /**
+     * Hides the control panel by setting its display to 'none'. This ensures the
+     * panel is not visible and does not intercept mouse events.
+     */
+    static hideControlPanel(focusedPage: Page, flowMetadata: FlowMetadata): Promise<void>;
+    /**
+     * Shows the control panel by resetting its display property. Assumes the
+     * original display was 'block'.
+     */
+    static showControlPanel(focusedPage: Page, flowMetadata: FlowMetadata): Promise<void>;
+    /**
+     * Updates all control panels in the given browser context. If the provided
+     * headline is non-null, the headline in the control panel will be updated.
+     */
+    static updateControlPanel(focusedPage: Page, flowMetadata: FlowMetadata, headline: string | null): Promise<void>;
+    /**
+     * Returns all elements that have the
+     * {@link PlaywrightUtils.DONOBU_INTERACTABLE_ATTRIBUTE} HTML attribute.
+     **/
+    static getAttributedInteractableElements(page: Page): Promise<InteractableElement[]>;
+    /**
+     * Assigns a globally unique {@link PlaywrightUtils.DONOBU_INTERACTABLE_ATTRIBUTE}
+     * attribute value to each visible, interactable, element in the given page.
+     * Any pre-existing {@link PlaywrightUtils.DONOBU_INTERACTABLE_ATTRIBUTE}
+     * attributes will be removed.
+     */
+    static attributeInteractableElements(page: Page): Promise<void>;
+    /**
+     * Annotate all elements in the given page that have a
+     * {@link PlaywrightUtils.DONOBU_INTERACTABLE_ATTRIBUTE} HTML attribute.
+     *
+     * The annotations are placed in a shadow root to avoid site-specific CSS,
+     * each having a {@link PlaywrightUtils.DONOBU_ANNOTATION_ATTRIBUTE} attribute.
+     */
+    static annotateInteractableElements(page: Page): Promise<void>;
+    /**
+     * Removes all annotations with a {@link PlaywrightUtils.DONOBU_ANNOTATION_ATTRIBUTE}
+     * HTML attribute in the given page, including any containers in shadow DOM.
+     */
+    static removeDonobuAnnotations(page: Page): Promise<void>;
+    /**
+     * Removes the {@link PlaywrightUtils.DONOBU_INTERACTABLE_ATTRIBUTE} HTML
+     * attribute for all elements in the given page. This attribute is normally
+     * added by the {@link PlaywrightUtils.attributeInteractableElements(Page)}
+     * function.
+     */
+    static deattributeVisibleInteractableElements(page: Page): Promise<void>;
+    static parseUnambiguousSelector(elementHandle: ElementHandle): Promise<string>;
+    /**
+     * Converts an HTML attribute to a JavaScript attribute. For example,
+     * "data-foo-bar" is turned into "fooBar". Notice the dropping of the "data-"
+     * prefix, and the conversion from kebab-case to camelCase.
+     */
+    static convertToJsAttribute(htmlAttribute: string): string;
+    /**
+     * Returned true IFF the given error is a Playwright error regarding page closing,
+     * of if the given error is an instance of {@link PageClosedException}.
+     */
+    static isPageClosedError(error: any): boolean;
+    static ensurePlaywrightInstallation(): Promise<void>;
+    static runPlaywrightCli(args: string[]): Promise<void>;
+    /**
+     * Attempts to wait until the currently focused page is stable. If the page
+     * never stabilizes, it just returns after timing out. If any error occurs,
+     * it is logged and ignored. If page is null, this function has no effect.
+     */
+    static waitForPageStability(page: Page | null): Promise<void>;
+    private static frameFilter;
+    /**
+     * This function is injected into the page (or frame) context. It finds
+     * "interactable" elements, checks visibility, and sets a unique attribute.
+     * It returns the updated offset after labeling.
+     */
+    private static attributeElementsInContext;
+}