system-testing 1.0.78 → 1.0.79

package/build/system-test.d.ts

@@ -29,7 +29,7 @@
  * @typedef {object} NotificationMessageArgs
  * @property {boolean} [dismiss] Whether to dismiss the notification after it appears.
  */
-export default class SystemTest {
+export default class SystemTest extends Browser {
     static rootPath: string;
     /**
      * Gets the current system test instance
@@ -57,21 +57,11 @@ export default class SystemTest {
      * @param {SystemTestArgs} [args]
      */
     constructor({ host, port, httpHost, httpPort, httpConnectHost, debug, errorFilter, urlArgs, driver, ...restArgs }?: SystemTestArgs);
-    /** @type {SystemTestCommunicator | undefined} */
-    communicator: SystemTestCommunicator | undefined;
-    /** @type {import("selenium-webdriver").WebDriver | undefined} */
-    driver: import("selenium-webdriver").WebDriver | undefined;
-    /** @type {import("./drivers/webdriver-driver.js").default | undefined} */
-    driverAdapter: import("./drivers/webdriver-driver.js").default | undefined;
     _started: boolean;
-    /** @type {SystemTestDriverConfig | undefined} */
-    _driverConfig: SystemTestDriverConfig | undefined;
     _httpHost: string;
     _httpPort: number;
     /** @type {(error: any) => boolean | undefined} */
     _errorFilter: (error: any) => boolean | undefined;
-    /** @type {Error | undefined} */
-    _httpServerError: Error | undefined;
     /** @type {WebSocketServer | undefined} */
     scoundrelWss: WebSocketServer | undefined;
     /** @type {WebSocketServer | undefined} */
@@ -99,57 +89,11 @@ export default class SystemTest {
     _host: string;
     _port: number;
     _httpConnectHost: string;
-    _debug: boolean;
     _urlArgs: Record<string, any>;
     _rootPath: string;
     /** @type {Record<number, object>} */
     _responses: Record<number, object>;
     _sendCount: number;
-    /**
-     * Gets the base selector for scoping element searches
-     * @returns {string | undefined}
-     */
-    getBaseSelector(): string | undefined;
-    /** @returns {import("selenium-webdriver").WebDriver} */
-    getDriver(): import("selenium-webdriver").WebDriver;
-    /** @returns {import("./drivers/webdriver-driver.js").default} */
-    getDriverAdapter(): import("./drivers/webdriver-driver.js").default;
-    /**
-     * @param {SystemTestDriverConfig} [driverConfig]
-     * @returns {import("./drivers/webdriver-driver.js").default}
-     */
-    createDriver(driverConfig?: SystemTestDriverConfig): import("./drivers/webdriver-driver.js").default;
-    /**
-     * Sets the base selector for scoping element searches
-     * @param {string} baseSelector
-     */
-    setBaseSelector(baseSelector: string): void;
-    _baseSelector: string;
-    /**
-     * Gets a selector scoped to the base selector
-     * @param {string} selector
-     * @returns {string}
-     */
-    getSelector(selector: string): string;
-    /**
-     * Logs messages
-     * @param {any[]} args
-     * @returns {void}
-     */
-    debugError(...args: any[]): void;
-    /**
-     * Logs messages when debugging is enabled
-     * @param {any[]} args
-     * @returns {void}
-     */
-    debugLog(...args: any[]): void;
-    /** @returns {void} */
-    throwIfHttpServerError(): void;
-    /**
-     * @param {Error} error
-     * @returns {void}
-     */
-    onHttpServerError: (error: Error) => void;
     /**
      * Starts Scoundrel server which the browser connects to for remote evaluation in the browser
      * @returns {void}
@@ -167,79 +111,6 @@ export default class SystemTest {
      * @returns {Promise<import("scoundrel-remote-eval/build/client/index.js").default>}
      */
     getScoundrelClient(timeoutMs?: number): Promise<import("scoundrel-remote-eval/build/client/index.js").default>;
-    /**
-     * 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[]>;
-    /**
-     * Clicks an element that has children which fills out the element and would otherwise have caused a ElementClickInterceptedError
-     * @param {string|import("selenium-webdriver").WebElement} elementOrIdentifier
-     * @returns {Promise<void>}
-     */
-    /**
-     * 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>;
-    /**
-     * 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 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>;
-    /**
-     * Gets browser logs
-     * @returns {Promise<string[]>}
-     */
-    getBrowserLogs(): Promise<string[]>;
-    /** @returns {Promise<string>} */
-    getCurrentUrl(): Promise<string>;
-    /** @returns {number} */
-    getTimeouts(): number;
-    /**
-     * 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>;
-    /**
-     * Expects no element to be found by CSS selector
-     * @param {string} selector
-     * @param {FindArgs} [args]
-     * @returns {Promise<void>}
-     */
-    expectNoElement(selector: string, args?: FindArgs): Promise<void>;
-    /**
-     * @param {string} selector
-     * @param {WaitForNoSelectorArgs} [args]
-     * @returns {Promise<void>}
-     */
-    waitForNoSelector(selector: string, args?: WaitForNoSelectorArgs): Promise<void>;
     /**
      * Gets notification messages
      * @returns {Promise<string[]>}
@@ -259,11 +130,6 @@ export default class SystemTest {
      * @returns {boolean}
      */
     isStarted(): boolean;
-    /**
-     * Gets the HTML of the current page
-     * @returns {Promise<string>}
-     */
-    getHTML(): Promise<string>;
     /**
      * Starts the system test
      * @returns {Promise<void>}
@@ -279,23 +145,6 @@ export default class SystemTest {
      * @returns {string}
      */
     buildRootPath(): string;
-    /**
-     * Restores previously set timeouts
-     * @returns {Promise<void>}
-     */
-    restoreTimeouts(): Promise<void>;
-    /**
-     * Sets driver timeouts
-     * @param {number} newTimeout
-     * @returns {Promise<void>}
-     */
-    driverSetTimeouts(newTimeout: number): Promise<void>;
-    /**
-     * Sets timeouts and stores the previous timeouts
-     * @param {number} newTimeout
-     * @returns {Promise<void>}
-     */
-    setTimeouts(newTimeout: number): Promise<void>;
     /**
      * Waits for the client web socket to connect
      * @returns {Promise<void>}
@@ -364,42 +213,6 @@ export default class SystemTest {
      * @returns {Promise<void>}
      */
     reinitialize(): Promise<void>;
-    /**
-     * Visits a path in the browser
-     * @param {string} path
-     * @returns {Promise<void>}
-     */
-    driverVisit(path: string): Promise<void>;
-    /**
-     * Formats browser logs for console output and truncates overly long output.
-     * @param {string[]} logs
-     * @param {number} [maxLines]
-     * @returns {string[]}
-     */
-    formatBrowserLogsForConsole(logs: string[], maxLines?: number): string[];
-    /**
-     * Prints browser logs to stdout for CI visibility when tests fail.
-     * @param {string[]} logs
-     * @returns {void}
-     */
-    printBrowserLogsForFailure(logs: string[]): void;
-    /**
-     * Takes a screenshot, saves HTML and browser logs
-     * @returns {Promise<void>}
-     */
-    takeScreenshot(): Promise<void>;
-    /**
-     * Visits a path in the browser
-     * @param {string} path
-     * @returns {Promise<void>}
-     */
-    visit(path: string): Promise<void>;
-    /**
-     * Dismisses to a path in the browser
-     * @param {string} path
-     * @returns {Promise<void>}
-     */
-    dismissTo(path: string): Promise<void>;
     /**
      * @param {WebSocketServer | undefined} wss
      * @param {string} [label]
@@ -481,8 +294,9 @@ export type NotificationMessageArgs = {
      */
     dismiss?: boolean;
 };
-import SystemTestCommunicator from "./system-test-communicator.js";
+import Browser from "./browser.js";
 import { WebSocketServer } from "ws";
+import SystemTestCommunicator from "./system-test-communicator.js";
 import ServerWebSocket from "scoundrel-remote-eval/build/server/connections/web-socket/index.js";
 import Server from "scoundrel-remote-eval/build/server/index.js";
 import SystemTestHttpServer from "./system-test-http-server.js";