@allwright.dev/core 0.0.32 → 0.0.34

package/dist/types.d.ts

@@ -0,0 +1,482 @@
+import grpc from "@grpc/grpc-js";
+export interface LaunchOptions {
+    browserBinary?: string;
+    timeoutMs?: number;
+}
+export type BrowserKind = "chromium" | "firefox";
+export interface CommandOptions {
+    timeoutMs?: number;
+}
+export interface NavigateResult {
+    url: string;
+    note: string;
+    bidiSessionId: string;
+    mapperTargetId: string;
+    mapperSessionId: string;
+    packageVersion: string;
+}
+export interface ClickResult {
+    selector: string;
+    note: string;
+    bidiSessionId: string;
+}
+export interface CountResult {
+    selector: string;
+    count: number;
+    note: string;
+}
+export interface HighlightOptions {
+    timeoutMs?: number;
+    durationMs?: number;
+}
+export interface HighlightResult {
+    selector: string;
+    count: number;
+    note: string;
+}
+export interface ElementResult {
+    selector: string;
+    note: string;
+}
+export interface FillResult {
+    selector: string;
+    value: string;
+    note: string;
+}
+export interface PressOptions {
+    timeoutMs?: number;
+    text?: string;
+}
+export interface PressResult {
+    selector: string;
+    key: string;
+    note: string;
+}
+export interface TextResult {
+    selector: string;
+    text: string;
+    note: string;
+}
+export interface WaitForSelectorOptions {
+    timeoutMs?: number;
+    visible?: boolean;
+}
+export interface WaitForSelectorResult {
+    selector: string;
+    visible: boolean;
+    note: string;
+}
+export interface BrowserInfo {
+    sessionId: string;
+    browserName: string;
+    launchNote: string;
+    cdpWebSocketURL: string;
+    userDataDir: string;
+}
+export interface PageInfo {
+    sessionId: string;
+    browserSessionId: string;
+}
+export interface LocatorInfo {
+    page: Page;
+    selector: string;
+}
+export interface BrowserType {
+    launch(options?: LaunchOptions): Promise<Browser>;
+}
+export interface Browser extends BrowserInfo {
+    page(): Page;
+    initialPage(): Page;
+    initialTab(): Page;
+    pages(): Page[];
+    newPage(options?: CommandOptions): Promise<Page>;
+    newTab(options?: CommandOptions): Promise<Page>;
+    close(): Promise<void>;
+    ping(message?: string): Promise<string>;
+    browserInfo(): BrowserInfo;
+}
+export interface Page extends PageInfo {
+    locator(selector: string): Locator;
+    goto(url: string, options?: CommandOptions): Promise<NavigateResult>;
+    navigate(url: string, options?: CommandOptions): Promise<NavigateResult>;
+    click(selector: string, options?: CommandOptions): Promise<ClickResult>;
+    count(selector: string, options?: CommandOptions): Promise<CountResult>;
+    highlight(selector: string, options?: HighlightOptions): Promise<HighlightResult>;
+    focus(selector: string, options?: CommandOptions): Promise<ElementResult>;
+    fill(selector: string, value: string, options?: CommandOptions): Promise<FillResult>;
+    hover(selector: string, options?: CommandOptions): Promise<ElementResult>;
+    press(selector: string, key: string, options?: PressOptions): Promise<PressResult>;
+    textContent(selector: string, options?: CommandOptions): Promise<TextResult>;
+    innerText(selector: string, options?: CommandOptions): Promise<TextResult>;
+    waitForSelector(selector: string, options?: WaitForSelectorOptions): Promise<WaitForSelectorResult>;
+    close(): Promise<void>;
+    ping(message?: string): Promise<string>;
+    pageInfo(): PageInfo;
+}
+export interface Locator {
+    readonly page: Page;
+    readonly selector: string;
+    click(options?: CommandOptions): Promise<ClickResult>;
+    count(options?: CommandOptions): Promise<CountResult>;
+    highlight(options?: HighlightOptions): Promise<HighlightResult>;
+    focus(options?: CommandOptions): Promise<ElementResult>;
+    fill(value: string, options?: CommandOptions): Promise<FillResult>;
+    hover(options?: CommandOptions): Promise<ElementResult>;
+    press(key: string, options?: PressOptions): Promise<PressResult>;
+    textContent(options?: CommandOptions): Promise<TextResult>;
+    innerText(options?: CommandOptions): Promise<TextResult>;
+    waitFor(options?: WaitForSelectorOptions): Promise<WaitForSelectorResult>;
+    locator(selector: string): Locator;
+}
+export interface AllwrightConfig {
+    schemaVersion?: 1;
+    server?: {
+        addr?: string;
+    };
+    browser?: {
+        name?: BrowserKind;
+        binary?: string;
+        launchOptions?: LaunchOptions;
+    };
+    expect?: RetryConfig;
+    suites?: Record<string, AllwrightSuiteConfig>;
+}
+export interface AllwrightSuiteConfig {
+    server?: {
+        addr?: string;
+    };
+    browser?: {
+        name?: BrowserKind;
+        binary?: string;
+        launchOptions?: LaunchOptions;
+    };
+    expect?: RetryConfig;
+}
+export interface RetryConfig {
+    timeoutMs?: number;
+    intervalMs?: number;
+}
+export interface ResolvedAllwrightConfig {
+    configFilePath: string | null;
+    suiteName: string | null;
+    serverAddr?: string;
+    browserName: BrowserKind;
+    browserBinary?: string;
+    launchOptions: LaunchOptions;
+    expect: RetryConfig;
+}
+export interface ResolveConfigOptions {
+    cwd?: string;
+    configFile?: string;
+    suite?: string;
+}
+export interface PingResponse {
+    message?: string;
+}
+export interface ChromeLaunchedPayload {
+    browser?: string;
+    note?: string;
+    cdpWebsocketUrl?: string;
+    userDataDir?: string;
+    initialTabSessionId?: string;
+}
+export interface BrowserLaunchedPayload {
+    browserKind?: number;
+    browser?: string;
+    note?: string;
+    userDataDir?: string;
+    initialTabSessionId?: string;
+}
+export interface BrowserSessionEvent {
+    sessionId?: string;
+    event?: string;
+    chromeLaunched?: ChromeLaunchedPayload;
+    browserLaunched?: BrowserLaunchedPayload;
+    tabOpened?: {
+        tabSessionId?: string;
+        note?: string;
+    };
+    pong?: {
+        message?: string;
+    };
+    closed?: {
+        reason?: string;
+    };
+    error?: {
+        message?: string;
+    };
+}
+export interface TabSessionEvent {
+    tabSessionId?: string;
+    event?: string;
+    attached?: {
+        note?: string;
+    };
+    pong?: {
+        message?: string;
+    };
+    closed?: {
+        reason?: string;
+    };
+    error?: {
+        message?: string;
+    };
+    navigated?: {
+        url?: string;
+        note?: string;
+    };
+    chromiumBidiInjection?: {
+        note?: string;
+        bidiSessionId?: string;
+        mapperTargetId?: string;
+        mapperSessionId?: string;
+        packageVersion?: string;
+    };
+    elementClicked?: {
+        cssSelector?: string;
+        note?: string;
+        bidiSessionId?: string;
+    };
+    elementCounted?: {
+        cssSelector?: string;
+        count?: number;
+        note?: string;
+    };
+    elementsHighlighted?: {
+        cssSelector?: string;
+        count?: number;
+        note?: string;
+    };
+    elementFocused?: {
+        cssSelector?: string;
+        note?: string;
+    };
+    elementFilled?: {
+        cssSelector?: string;
+        value?: string;
+        note?: string;
+    };
+    elementHovered?: {
+        cssSelector?: string;
+        note?: string;
+    };
+    keyPressed?: {
+        cssSelector?: string;
+        key?: string;
+        note?: string;
+    };
+    textContentResolved?: {
+        cssSelector?: string;
+        text?: string;
+        note?: string;
+    };
+    innerTextResolved?: {
+        cssSelector?: string;
+        text?: string;
+        note?: string;
+    };
+    selectorWaitSatisfied?: {
+        cssSelector?: string;
+        visible?: boolean;
+        note?: string;
+    };
+}
+export interface LaunchChromeRequest {
+    launchChrome: {
+        chromeBinary?: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface LaunchBrowserRequest {
+    launchBrowser: {
+        browserKind: number;
+        browserBinary?: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface OpenTabRequest {
+    openTab: {
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface BrowserPingRequest {
+    ping: {
+        message: string;
+    };
+}
+export interface CloseBrowserRequest {
+    close: Record<string, never>;
+}
+export interface TabPingRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    ping: {
+        message: string;
+    };
+}
+export interface NavigateRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    navigate: {
+        url: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface ClickRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    clickElement: {
+        cssSelector: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface CountRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    countElements: {
+        cssSelector: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface HighlightRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    highlightElements: {
+        cssSelector: string;
+        durationMs?: number;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface FocusRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    focusElement: {
+        cssSelector: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface FillRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    fillElement: {
+        cssSelector: string;
+        value: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface HoverRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    hoverElement: {
+        cssSelector: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface PressRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    pressKey: {
+        cssSelector: string;
+        key: string;
+        text?: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface TextContentRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    getTextContent: {
+        cssSelector: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface InnerTextRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    getInnerText: {
+        cssSelector: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface WaitForSelectorRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    waitForSelector: {
+        cssSelector: string;
+        visible?: boolean;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface CloseTabRequest {
+    browserSessionId: string;
+    tabSessionId: string;
+    close: Record<string, never>;
+}
+export type BrowserSessionRequest = LaunchBrowserRequest | LaunchChromeRequest | OpenTabRequest | BrowserPingRequest | CloseBrowserRequest;
+export type TabSessionRequest = TabPingRequest | NavigateRequest | ClickRequest | CountRequest | HighlightRequest | FocusRequest | FillRequest | HoverRequest | PressRequest | TextContentRequest | InnerTextRequest | WaitForSelectorRequest | CloseTabRequest;
+export type BrowserSessionStream = grpc.ClientDuplexStream<BrowserSessionRequest, BrowserSessionEvent>;
+export type PageSessionStream = grpc.ClientDuplexStream<TabSessionRequest, TabSessionEvent>;
+export interface EngineServiceClientShape {
+    Ping(request: Record<string, never>, callback: (error: grpc.ServiceError | null, response: PingResponse) => void): void;
+    BrowserSession(): BrowserSessionStream;
+    TabSession(): PageSessionStream;
+    close(): void;
+}
+export interface EngineProtoRoot {
+    allwright: {
+        engine: {
+            v1: {
+                EngineService: grpc.ServiceClientConstructor;
+            };
+        };
+    };
+}
+export interface RuntimeClient {
+    client: EngineServiceClientShape;
+}
+export interface BrowserLaunchState {
+    runtime: RuntimeClient;
+    stream: BrowserSessionStream;
+    queue: EventQueue<BrowserSessionEvent>;
+    sessionId: string;
+    launched: BrowserLaunchedPayload;
+}
+export interface PageHandle {
+    stream: PageSessionStream;
+    queue: EventQueue<TabSessionEvent>;
+    closed: boolean;
+}
+export declare class EventQueue<T> {
+    #private;
+    push(item: T): void;
+    fail(error: Error): void;
+    next(): Promise<T>;
+}

package/dist/types.js

@@ -0,0 +1,33 @@
+export class EventQueue {
+    #items = [];
+    #waiters = [];
+    #endedError = null;
+    push(item) {
+        const waiter = this.#waiters.shift();
+        if (waiter) {
+            waiter.resolve(item);
+            return;
+        }
+        this.#items.push(item);
+    }
+    fail(error) {
+        if (this.#endedError) {
+            return;
+        }
+        this.#endedError = error;
+        while (this.#waiters.length > 0) {
+            this.#waiters.shift().reject(error);
+        }
+    }
+    async next() {
+        if (this.#items.length > 0) {
+            return this.#items.shift();
+        }
+        if (this.#endedError) {
+            throw this.#endedError;
+        }
+        return new Promise((resolve, reject) => {
+            this.#waiters.push({ resolve, reject });
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allwright.dev/core",
-  "version": "0.0.32",
+  "version": "0.0.34",
   "description": "High-level TypeScript client for the allwright automation engine.",
   "license": "MIT",
   "type": "module",