donobu 2.15.1 → 2.16.0

package/dist/utils/PlaywrightUtils.d.ts

@@ -1,29 +1,24 @@
-import { BrowserContext, 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[];
-    }
-}
+import { BrowserContext, Page } from 'playwright';
 /**
  * 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 ACCESSIBILITY_TEST_INIT_SCRIPT;
-    private static readonly CLICKABLE_ELEMENTS_TRACKER_INIT_SCRIPT;
+    /**
+     * 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.
+     */
     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";
+    /**
+     * Returns a JavaScript code snippet intended to run as an initialization
+     * script for `DonobuFlow` flows. This enables the {@link ReplayableInteraction}
+     * and {@link PageInteractionTracker.INIT_SCRIPT} to generate
+     * smart selectors.
+     */
+    static readonly SMART_SELECTOR_GENERATOR_INIT_SCRIPT: string;
     /**
      * Attempts to take a screenshot of the given page, returning the raw byte
      * array.
@@ -41,42 +36,9 @@ export declare class PlaywrightUtils {
      * 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;
+    static generateSelectors(element: {
+        evaluate: (pageFunction: any) => Promise<any>;
+    }): Promise<string[]>;
     /**
      * Sets up the given browser context so that it can be minimally used by the
      * rest of Donobu. This involves registering virtual routes for serving up
@@ -84,72 +46,6 @@ export declare class PlaywrightUtils {
      * scripts.
      */
     static setupBasicBrowserContext(browserContext: BrowserContext): Promise<void>;
-    /**
-     * Returns the given locator or its label, if it has one and is associated with a labelable element.
-     * Labelable elements include: button, input (except hidden), meter, output, progress, select, and textarea.
-     */
-    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}.
@@ -163,12 +59,15 @@ export declare class PlaywrightUtils {
      * 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.
+     * Takes a screenshot of the webpage as if it were scrolled down by one viewport.
+     * If the page cannot be scrolled as a whole, tries to find and scroll individual
+     * scrollable elements on the page. After taking the screenshot, it reverts to
+     * the original scroll position.
+     *
+     * @param page The Playwright Page to take a screenshot of
+     * @returns An image buffer of the scrolled down view, or undefined if scrolling isn't possible
      */
-    private static attributeElementsInContext;
+    static getScrolledDownScreenShot(page: Page): Promise<Buffer | undefined>;
 }
 //# sourceMappingURL=PlaywrightUtils.d.ts.map

package/dist/utils/PlaywrightUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlaywrightUtils.d.ts","sourceRoot":"","sources":["../../src/utils/PlaywrightUtils.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,cAAc,EACd,aAAa,EAEb,OAAO,EACP,IAAI,EACL,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAOpE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,0BAA0B,EAAE,MAAM,OAAO,EAAE,CAAC;QAC5C,eAAe,EAAE,MAAM,OAAO,CAAC;QAC/B,4BAA4B,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,CAAC;KAC9D;CACF;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,8BAA8B,CACG;IACzD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sCAAsC,CAG1D;IACJ,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iCAAiC,CACkB;IAC3E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,oCAAoC,CACkB;IAC9E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,qCAAqC,CAGzD;IACJ,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,gCAAgC,CACW;IAGnE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,+BAA+B,CAC9B;IACzB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,wCAAwC,CAC5B;IACpC,gBAAuB,6BAA6B,8BACvB;IAC7B,gBAAuB,2BAA2B,4BAA4B;IAE9E;;;;;;;;OAQG;WACiB,cAAc,CAChC,IAAI,EAAE,IAAI,EACV,IAAI,GAAE,KAAK,GAAG,MAAe,GAC5B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;OAMG;WACiB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAM1E;;;;;OAKG;WACW,kCAAkC,IAAI,MAAM;IAI1D;;;;;;OAMG;WACW,6BAA6B,IAAI,MAAM;IAIrD;;;;;;;;OAQG;WACW,gCAAgC,IAAI,MAAM;IAIxD;;;;;;OAMG;WACW,2BAA2B,IAAI,MAAM;WAIrC,iCAAiC,IAAI,MAAM;WAI3C,4BAA4B,IAAI,MAAM;IAIpD;;;;;OAKG;WACiB,wBAAwB,CAC1C,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;OAGG;WACiB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IA4I5E;;;;;OAKG;WACiB,+BAA+B,CACjD,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAsBxB;;;OAGG;WACiB,gBAAgB,CAClC,WAAW,EAAE,IAAI,EACjB,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IA0BhB;;;OAGG;WACiB,gBAAgB,CAClC,WAAW,EAAE,IAAI,EACjB,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IA0BhB;;;OAGG;WACiB,kBAAkB,CACpC,WAAW,EAAE,IAAI,EACjB,YAAY,EAAE,YAAY,EAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,GACtB,OAAO,CAAC,IAAI,CAAC;IAuChB;;;QAGI;WACgB,iCAAiC,CACnD,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,mBAAmB,EAAE,CAAC;IA4DjC;;;;;OAKG;WACiB,6BAA6B,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAoE5E;;;;;;OAMG;WACiB,4BAA4B,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAmJ3E;;;OAGG;WACiB,uBAAuB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBtE;;;;;OAKG;WACiB,sCAAsC,CACxD,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,IAAI,CAAC;WAqBI,wBAAwB,CAC1C,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,MAAM,CAAC;IAoClB;;;;OAIG;WACW,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAkBjE;;;OAGG;WACW,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;WAkBhC,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;WAI7C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgDnE;;;;OAIG;WACiB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB1E,OAAO,CAAC,MAAM,CAAC,WAAW;IAS1B;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;CAuV1C"}
+{"version":3,"file":"PlaywrightUtils.d.ts","sourceRoot":"","sources":["../../src/utils/PlaywrightUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAUlD;;;GAGG;AACH,qBAAa,eAAe;IAC1B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iCAAiC,CACkB;IAE3E;;;;;OAKG;IACH,gBAAuB,oCAAoC,SACmB;IAE9E;;;;;;;;OAQG;WACiB,cAAc,CAChC,IAAI,EAAE,IAAI,EACV,IAAI,GAAE,KAAK,GAAG,MAAe,GAC5B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;OAMG;WACiB,iBAAiB,CAAC,OAAO,EAAE;QAC7C,QAAQ,EAAE,CAAC,YAAY,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAMrB;;;;;OAKG;WACiB,wBAAwB,CAC1C,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,IAAI,CAAC;IAWhB;;;OAGG;WACW,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;WAkBhC,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;WAI7C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgDnE;;;;OAIG;WACiB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB1E;;;;;;;;OAQG;WACiB,yBAAyB,CAC3C,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CA4I/B"}