system-testing 1.0.73 → 1.0.75

package/build/drivers/webdriver-driver.d.ts

@@ -0,0 +1,173 @@
+/**
+ * Base driver using selenium-webdriver sessions.
+ */
+export default class WebDriverDriver {
+    /**
+     * @param {object} args
+     * @param {import("../system-test.js").default} args.systemTest
+     * @param {Record<string, any>} [args.options]
+     */
+    constructor({ systemTest, options }: {
+        systemTest: import("../system-test.js").default;
+        options?: Record<string, any>;
+    });
+    systemTest: import("../system-test.js").default;
+    options: Record<string, any>;
+    baseUrl: string;
+    webDriver: import("selenium-webdriver").WebDriver;
+    _driverTimeouts: number;
+    _timeouts: number;
+    /**
+     * @param {string} baseUrl
+     * @returns {void}
+     */
+    setBaseUrl(baseUrl: string): void;
+    /** @returns {string} */
+    getBaseUrl(): string;
+    /** @returns {number} */
+    getTimeouts(): number;
+    /**
+     * @returns {import("selenium-webdriver").WebDriver}
+     */
+    getWebDriver(): import("selenium-webdriver").WebDriver;
+    /**
+     * @param {import("selenium-webdriver").WebDriver} webDriver
+     * @returns {void}
+     */
+    setWebDriver(webDriver: import("selenium-webdriver").WebDriver): void;
+    /**
+     * @returns {Promise<void>}
+     */
+    start(): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    stop(): Promise<void>;
+    /**
+     * @param {number} newTimeout
+     * @returns {Promise<void>}
+     */
+    driverSetTimeouts(newTimeout: number): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    restoreTimeouts(): Promise<void>;
+    /**
+     * @param {number} newTimeout
+     * @returns {Promise<void>}
+     */
+    setTimeouts(newTimeout: number): Promise<void>;
+    /**
+     * @param {string} selector
+     * @returns {string}
+     */
+    getSelector(selector: string): string;
+    /**
+     * @param {string} path
+     * @returns {Promise<void>}
+     */
+    driverVisit(path: string): Promise<void>;
+    /** @returns {Promise<string>} */
+    getCurrentUrl(): Promise<string>;
+    /** @returns {Promise<string>} */
+    getHTML(): Promise<string>;
+    /** @returns {Promise<string>} */
+    takeScreenshot(): Promise<string>;
+    /**
+     * Gets browser logs
+     * @returns {Promise<string[]>}
+     */
+    getBrowserLogs(): Promise<string[]>;
+    /**
+     * Finds all elements by CSS selector
+     * @param {string} selector
+     * @param {FindArgs} [args]
+     * @returns {Promise<import("selenium-webdriver").WebElement[]>}
+     */
+    all(selector: string, args?: FindArgs): Promise<import("selenium-webdriver").WebElement[]>;
+    /**
+     * Finds a single element by CSS selector
+     * @param {string} selector
+     * @param {FindArgs} [args]
+     * @returns {Promise<import("selenium-webdriver").WebElement>}
+     */
+    find(selector: string, args?: FindArgs): Promise<import("selenium-webdriver").WebElement>;
+    /**
+     * Finds a single element by test ID
+     * @param {string} testId
+     * @param {FindArgs} [args]
+     * @returns {Promise<import("selenium-webdriver").WebElement>}
+     */
+    findByTestId(testId: string, args?: FindArgs): Promise<import("selenium-webdriver").WebElement>;
+    /**
+     * Finds a single element by test ID
+     * @param {string} testID
+     * @param {FindArgs} [args]
+     * @returns {Promise<import("selenium-webdriver").WebElement>}
+     */
+    findByTestID(testID: string, args?: FindArgs): Promise<import("selenium-webdriver").WebElement>;
+    /**
+     * @param {string|import("selenium-webdriver").WebElement|{selector: string} & FindArgs} elementOrIdentifier
+     * @param {FindArgs} [args]
+     * @returns {Promise<import("selenium-webdriver").WebElement>}
+     */
+    _findElement(elementOrIdentifier: string | import("selenium-webdriver").WebElement | ({
+        selector: string;
+    } & FindArgs), args?: FindArgs): Promise<import("selenium-webdriver").WebElement>;
+    /**
+     * Finds a single element by CSS selector without waiting
+     * @param {string} selector
+     * @param {FindArgs} [args]
+     * @returns {Promise<import("selenium-webdriver").WebElement>}
+     */
+    findNoWait(selector: string, args?: FindArgs): Promise<import("selenium-webdriver").WebElement>;
+    /**
+     * Clicks an element, allowing selector args when using a CSS selector.
+     * @param {string|import("selenium-webdriver").WebElement} elementOrIdentifier
+     * @param {FindArgs} [args]
+     * @returns {Promise<void>}
+     */
+    click(elementOrIdentifier: string | import("selenium-webdriver").WebElement, args?: FindArgs): Promise<void>;
+    /**
+     * Interacts with an element by calling a method on it with the given arguments.
+     * Retrying on ElementNotInteractableError, ElementClickInterceptedError, or StaleElementReferenceError.
+     * @param {import("selenium-webdriver").WebElement|string|{selector: string} & FindArgs} elementOrIdentifier The element or a CSS selector to find the element.
+     * @param {string} methodName The method name to call on the element.
+     * @param {...any} args Arguments to pass to the method.
+     * @returns {Promise<any>}
+     */
+    interact(elementOrIdentifier: import("selenium-webdriver").WebElement | string | ({
+        selector: string;
+    } & FindArgs), methodName: string, ...args: any[]): Promise<any>;
+    /**
+     * @param {string} selector
+     * @param {WaitForNoSelectorArgs} [args]
+     * @returns {Promise<void>}
+     */
+    waitForNoSelector(selector: string, args?: WaitForNoSelectorArgs): Promise<void>;
+    /**
+     * @param {() => Promise<any>} callback
+     * @returns {Promise<any>}
+     */
+    _withRethrownErrors(callback: () => Promise<any>): Promise<any>;
+}
+export type FindArgs = {
+    /**
+     * Override timeout for lookup.
+     */
+    timeout?: number;
+    /**
+     * Whether to require elements to be visible.
+     */
+    visible?: boolean;
+    /**
+     * Whether to scope by the base selector.
+     */
+    useBaseSelector?: boolean;
+};
+export type WaitForNoSelectorArgs = {
+    /**
+     * Whether to scope by the base selector.
+     */
+    useBaseSelector?: boolean;
+};