@allwright.dev/core 0.1.12 → 0.1.14

package/README.md

@@ -79,3 +79,36 @@ suites:
 ```
 
 The TypeScript package exports `findConfigFile()`, `loadConfigFile()`, `resolveConfig()`, and `launchConfiguredBrowser()` so runner packages can consume the same config model without inventing language-specific config files.
+
+### Iframes
+
+An iframe resolves to a normal `Page`, including nested and cross-origin frames:
+
+```ts
+const frame = await page.locator("#checkout-frame").Frame({ timeoutMs: 10_000 });
+await frame.locator("input[name=email]").fill("buyer@example.com");
+const nested = await frame.locator("iframe").frame({ timeoutMs: 5_000 });
+```
+
+`Frame()` and `frame()` are aliases. The timeout covers finding exactly one iframe,
+resolving its browsing context, and waiting for a fully loaded document with 200 ms
+without DOM mutations. The default is 10 seconds. Closing the frame page releases
+its session; it does not remove the iframe or close the parent tab. Resolve a new
+frame page after the iframe is replaced.
+
+### Read page and element state
+
+```ts
+const url = await page.url();
+const value = await page.locator('input, textarea').inputValue();
+const options = await page.locator('select').selectedOptions(); // [{ value, label, index }]
+const selectedText = await page.locator('textarea').selectedText();
+const checked = await page.locator('input[type=checkbox]').isChecked();
+const text = await page.locator('h1').innerText(); // { selector, text, note }
+const attribute = await page.locator('a').getAttribute('href');
+const box = await page.locator('button').boundingBox(); // { x, y, width, height }
+```
+
+Element reads also have page methods such as `page.inputValue(selector, options)` and accept `timeoutMs`. Reads use the first locator match and work in frame pages. `inputValue` reads the live property of an input, textarea, or select. `selectedOptions` supports native selects (including multiple selections) and ARIA combobox/listbox options marked `aria-selected="true"`. `selectedText` returns the textbox's selected substring, an empty string for a caret, or `null` for input types without selection support. `isChecked` supports native checkbox/radio and ARIA checked controls; ARIA mixed state returns false.
+
+Missing attributes return `null` (an empty attribute remains `""`). Bounding boxes use CSS pixels relative to the page/frame viewport and return `null` for hidden or zero-area elements. Missing elements and incompatible control types raise errors. Use `textContent()` for raw text or `innerText()` for rendered text.

package/dist/bootstrap.js

@@ -12,7 +12,7 @@ const ALLWRIGHT_HOME_ENV_VAR = "ALLWRIGHT_HOME";
 const ALLWRIGHT_REPOSITORY_ENV_VAR = "ALLWRIGHT_REPOSITORY";
 const ALLWRIGHT_VERSION_ENV_VAR = "ALLWRIGHT_VERSION";
 const DEFAULT_RELEASE_REPOSITORY = "allwright-dev/allwright";
-const DEFAULT_RELEASE_VERSION = "0.1.12";
+const DEFAULT_RELEASE_VERSION = "0.1.14";
 const STARTUP_TIMEOUT_MS = 20_000;
 const PING_TIMEOUT_MS = 1_000;
 const PROTO_ROOT = fileURLToPath(new URL("../proto/", import.meta.url));

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import { PageImpl } from "./page.js";
 import { setServerAddr, shutdown } from "./runtime.js";
 import type { Browser, BrowserKind, BrowserType, LaunchOptions, Page, FileChooser, Download, HookType, ResolveConfigOptions, ResolvedAllwrightConfig } from "./types.js";
 export { findConfigFile, loadConfigFile, resolveConfig, setServerAddr, shutdown };
-export type { AccessibilitySnapshotOptions, AllwrightConfig, Browser, BrowserInfo, BrowserKind, BrowserType, Hook, HookType, FileChooser, Download, ClickResult, CommandOptions, CountResult, ElementResult, FillResult, HighlightOptions, HighlightResult, LaunchOptions, MobileAndroidConnectOptions, MobileAndroidDevice, MobileAndroidLaunchOptions, MobileAndroidLocator, MobileAndroidApp, Locator, LocatorInfo, MobileSurfaceNamespace, NavigateResult, Page, PageInfo, PressOptions, PressResult, ResolveConfigOptions, ResolvedAllwrightConfig, RetryConfig, ScreenshotOptions, ScreenshotResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult, } from "./types.js";
+export type { CapturedOption, BoundingBox, AccessibilitySnapshotOptions, AllwrightConfig, Browser, BrowserInfo, BrowserKind, BrowserType, Hook, HookType, FileChooser, Download, ClickResult, CommandOptions, CountResult, ElementResult, FillResult, HighlightOptions, HighlightResult, LaunchOptions, MobileAndroidConnectOptions, MobileAndroidDevice, MobileAndroidLaunchOptions, MobileAndroidLocator, MobileAndroidApp, Locator, LocatorInfo, MobileSurfaceNamespace, NavigateResult, Page, PageInfo, PressOptions, PressResult, ResolveConfigOptions, ResolvedAllwrightConfig, RetryConfig, ScreenshotOptions, ScreenshotResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult, } from "./types.js";
 export declare const chromium: BrowserType;
 export declare const firefox: BrowserType;
 export declare const hooks: {

package/dist/locator.d.ts

@@ -1,9 +1,11 @@
 import { WebLocatorBuilders, type LocatorFilterOptions } from "./web-locators.js";
-import type { ClickResult, CommandOptions, CountResult, ElementResult, FillResult, HighlightOptions, HighlightResult, Locator, LocatorInfo, Page, PressOptions, PressResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult } from "./types.js";
+import type { BoundingBox, CapturedOption, ClickResult, CommandOptions, CountResult, ElementResult, FillResult, HighlightOptions, HighlightResult, Locator, LocatorInfo, Page, PressOptions, PressResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult } from "./types.js";
 export declare class LocatorImpl extends WebLocatorBuilders implements Locator {
     readonly page: Page;
     readonly selector: string;
     constructor(input: LocatorInfo);
+    frame(options?: CommandOptions): Promise<Page>;
+    Frame(options?: CommandOptions): Promise<Page>;
     click(options?: CommandOptions): Promise<ClickResult>;
     count(options?: CommandOptions): Promise<CountResult>;
     highlight(options?: HighlightOptions): Promise<HighlightResult>;
@@ -11,6 +13,12 @@ export declare class LocatorImpl extends WebLocatorBuilders implements Locator {
     fill(value: string, options?: CommandOptions): Promise<FillResult>;
     hover(options?: CommandOptions): Promise<ElementResult>;
     press(key: string, options?: PressOptions): Promise<PressResult>;
+    inputValue(options?: CommandOptions): Promise<string>;
+    selectedOptions(options?: CommandOptions): Promise<CapturedOption[]>;
+    selectedText(options?: CommandOptions): Promise<string | null>;
+    isChecked(options?: CommandOptions): Promise<boolean>;
+    getAttribute(name: string, options?: CommandOptions): Promise<string | null>;
+    boundingBox(options?: CommandOptions): Promise<BoundingBox | null>;
     textContent(options?: CommandOptions): Promise<TextResult>;
     innerText(options?: CommandOptions): Promise<TextResult>;
     waitFor(options?: WaitForSelectorOptions): Promise<WaitForSelectorResult>;

package/dist/locator.js

@@ -8,6 +8,8 @@ export class LocatorImpl extends WebLocatorBuilders {
         this.page = input.page;
         this.selector = input.selector;
     }
+    frame(options = {}) { return this.page.frame(this.selector, options); }
+    Frame(options = {}) { return this.frame(options); }
     async click(options = {}) {
         return this.page.click(this.selector, options);
     }
@@ -29,6 +31,24 @@ export class LocatorImpl extends WebLocatorBuilders {
     async press(key, options = {}) {
         return this.page.press(this.selector, key, options);
     }
+    async inputValue(options = {}) {
+        return this.page.inputValue(this.selector, options);
+    }
+    async selectedOptions(options = {}) {
+        return this.page.selectedOptions(this.selector, options);
+    }
+    async selectedText(options = {}) {
+        return this.page.selectedText(this.selector, options);
+    }
+    async isChecked(options = {}) {
+        return this.page.isChecked(this.selector, options);
+    }
+    async getAttribute(name, options = {}) {
+        return this.page.getAttribute(this.selector, name, options);
+    }
+    async boundingBox(options = {}) {
+        return this.page.boundingBox(this.selector, options);
+    }
     async textContent(options = {}) {
         return this.page.textContent(this.selector, options);
     }

package/dist/page.d.ts

@@ -1,5 +1,5 @@
 import { WebLocatorBuilders, type LocatorFilterOptions } from "./web-locators.js";
-import type { AccessibilitySnapshotOptions, ClickResult, CommandOptions, CountResult, ElementResult, FillResult, FileChooser, Download, HighlightOptions, HighlightResult, Hook, HookType, Locator, NavigateResult, Page, PageInfo, PressOptions, PressResult, RuntimeClient, ScreenshotOptions, ScreenshotResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult } from "./types.js";
+import type { BoundingBox, CapturedOption, AccessibilitySnapshotOptions, ClickResult, CommandOptions, CountResult, ElementResult, FillResult, FileChooser, Download, HighlightOptions, HighlightResult, Hook, HookType, Locator, NavigateResult, Page, PageInfo, PressOptions, PressResult, RuntimeClient, ScreenshotOptions, ScreenshotResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult } from "./types.js";
 export declare class PageImpl extends WebLocatorBuilders implements Page {
     #private;
     constructor(input: PageInfo & {
@@ -8,6 +8,7 @@ export declare class PageImpl extends WebLocatorBuilders implements Page {
     });
     readonly sessionId: string;
     readonly browserSessionId: string;
+    frame(selector: string, options?: CommandOptions): Promise<Page>;
     registerHook<T>(type: HookType<T>): Promise<Hook<T>>;
     setFileChooserFiles(fileChooserId: string, files: string[], options?: CommandOptions): Promise<void>;
     saveDownload(downloadId: string, path: string, options?: CommandOptions): Promise<void>;
@@ -20,6 +21,13 @@ export declare class PageImpl extends WebLocatorBuilders implements Page {
     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>;
+    url(options?: CommandOptions): Promise<string>;
+    inputValue(selector: string, options?: CommandOptions): Promise<string>;
+    selectedOptions(selector: string, options?: CommandOptions): Promise<CapturedOption[]>;
+    selectedText(selector: string, options?: CommandOptions): Promise<string | null>;
+    isChecked(selector: string, options?: CommandOptions): Promise<boolean>;
+    getAttribute(selector: string, name: string, options?: CommandOptions): Promise<string | null>;
+    boundingBox(selector: string, options?: CommandOptions): Promise<BoundingBox | null>;
     textContent(selector: string, options?: CommandOptions): Promise<TextResult>;
     innerText(selector: string, options?: CommandOptions): Promise<TextResult>;
     waitForSelector(selector: string, options?: WaitForSelectorOptions): Promise<WaitForSelectorResult>;

package/dist/page.js

@@ -24,6 +24,23 @@ export class PageImpl extends WebLocatorBuilders {
     }
     sessionId;
     browserSessionId;
+    async frame(selector, options = {}) {
+        const handle = await this.#getHandle();
+        this.#ensureOpen(handle);
+        handle.stream.write({ surfaceSessionId: this.browserSessionId, contextSessionId: this.sessionId,
+            resolveFrame: { cssSelector: normalizeSelectorForTransport(selector), retryOptions: options.timeoutMs !== undefined ? { timeoutMs: options.timeoutMs } : undefined } });
+        while (true) {
+            const event = await handle.queue.next();
+            if (event.frameResolved?.contextSessionId)
+                return this.#createPage(event.frameResolved.contextSessionId);
+            if (event.error?.message)
+                throw formatActionError("resolve frame", event.error.message, selector);
+            if (event.closed) {
+                handle.closed = true;
+                throw new Error("page closed while resolving frame");
+            }
+        }
+    }
     async registerHook(type) {
         if (type.name !== "newPage" && type.name !== "fileChooser" && type.name !== "download") {
             throw formatActionError("register hook", `unsupported hook type: ${type.name}`);
@@ -459,6 +476,52 @@ export class PageImpl extends WebLocatorBuilders {
             }
         }
     }
+    async #capture(kind, selector, attributeName, options) {
+        const handle = await this.#getHandle();
+        this.#ensureOpen(handle);
+        handle.stream.write({ surfaceSessionId: this.browserSessionId, contextSessionId: this.sessionId,
+            capture: { kind, cssSelector: selector ? normalizeSelectorForTransport(selector) : "", attributeName,
+                retryOptions: options.timeoutMs !== undefined ? { timeoutMs: options.timeoutMs } : undefined } });
+        while (true) {
+            const event = await handle.queue.next();
+            if (event.captureResolved)
+                return event.captureResolved;
+            if (event.error)
+                throw formatActionError("capture", event.error.message ?? "capture failed", selector);
+            if (event.closed) {
+                handle.closed = true;
+                throw new Error("page session closed while capturing");
+            }
+        }
+    }
+    async url(options = {}) {
+        const r = await this.#capture("CAPTURE_KIND_URL", "", "", options);
+        return r.value ?? "";
+    }
+    async inputValue(selector, options = {}) {
+        const r = await this.#capture("CAPTURE_KIND_INPUT_VALUE", selector, "", options);
+        return r.value ?? "";
+    }
+    async selectedOptions(selector, options = {}) {
+        const r = await this.#capture("CAPTURE_KIND_SELECTED_OPTIONS", selector, "", options);
+        return r.selectedOptions ?? [];
+    }
+    async selectedText(selector, options = {}) {
+        const r = await this.#capture("CAPTURE_KIND_SELECTED_TEXT", selector, "", options);
+        return r.value ?? null;
+    }
+    async isChecked(selector, options = {}) {
+        const r = await this.#capture("CAPTURE_KIND_CHECKED", selector, "", options);
+        return r.checked ?? false;
+    }
+    async getAttribute(selector, name, options = {}) {
+        const r = await this.#capture("CAPTURE_KIND_ATTRIBUTE", selector, name, options);
+        return r.value ?? null;
+    }
+    async boundingBox(selector, options = {}) {
+        const r = await this.#capture("CAPTURE_KIND_BOUNDING_BOX", selector, "", options);
+        return r.boundingBox ?? null;
+    }
     async textContent(selector, options = {}) {
         return this.#readText(selector, options, true);
     }

package/dist/types.d.ts

@@ -133,6 +133,14 @@ export interface Browser extends BrowserInfo {
     browserInfo(): BrowserInfo;
 }
 export interface Page extends PageInfo, WebLocators {
+    url(options?: CommandOptions): Promise<string>;
+    inputValue(selector: string, options?: CommandOptions): Promise<string>;
+    selectedOptions(selector: string, options?: CommandOptions): Promise<CapturedOption[]>;
+    selectedText(selector: string, options?: CommandOptions): Promise<string | null>;
+    isChecked(selector: string, options?: CommandOptions): Promise<boolean>;
+    getAttribute(selector: string, name: string, options?: CommandOptions): Promise<string | null>;
+    boundingBox(selector: string, options?: CommandOptions): Promise<BoundingBox | null>;
+    frame(selector: string, options?: CommandOptions): Promise<Page>;
     registerHook<T>(type: HookType<T>): Promise<Hook<T>>;
     accessibilitySnapshot(options?: AccessibilitySnapshotOptions): Promise<string>;
     locator(selector: string, options?: LocatorFilterOptions): Locator;
@@ -206,6 +214,14 @@ export interface MobileSurfaceNamespace {
     };
 }
 export interface Locator extends WebLocators {
+    inputValue(options?: CommandOptions): Promise<string>;
+    selectedOptions(options?: CommandOptions): Promise<CapturedOption[]>;
+    selectedText(options?: CommandOptions): Promise<string | null>;
+    isChecked(options?: CommandOptions): Promise<boolean>;
+    getAttribute(name: string, options?: CommandOptions): Promise<string | null>;
+    boundingBox(options?: CommandOptions): Promise<BoundingBox | null>;
+    frame(options?: CommandOptions): Promise<Page>;
+    Frame(options?: CommandOptions): Promise<Page>;
     not(other: Locator): Locator;
     filter(options?: LocatorFilterOptions): Locator;
     nth(index: number): Locator;
@@ -374,6 +390,10 @@ export interface SurfaceSessionEvent {
     };
 }
 export interface ContextSessionEvent {
+    captureResolved?: CaptureResult;
+    frameResolved?: {
+        contextSessionId?: string;
+    };
     accessibilitySnapshotCaptured?: {
         snapshot?: string;
         format?: string;
@@ -809,7 +829,27 @@ export interface CloseContextRequest {
     close: Record<string, never>;
 }
 export type SurfaceSessionRequest = LaunchBrowserRequest | LaunchChromeRequest | OpenContextRequest | ConnectMobileRequest | LaunchAppRequest | SurfacePingRequest | CloseSurfaceRequest;
-export type ContextSessionRequest = ContextPingRequest | RegisterHookRequest | WaitForHookRequest | SetFileChooserFilesRequest | SaveDownloadRequest | UploadFileChunkRequest | ReadFileChunkRequest | SetMobileFileChooserFilesRequest | SaveMobileDownloadRequest | NavigateRequest | ClickRequest | CountRequest | HighlightRequest | FocusRequest | FillRequest | HoverRequest | PressRequest | TextContentRequest | InnerTextRequest | WaitForSelectorRequest | AccessibilitySnapshotRequest | ScreenshotRequest | CloseContextRequest;
+export type ContextSessionRequest = {
+    surfaceSessionId: string;
+    contextSessionId: string;
+    capture: {
+        kind: string;
+        cssSelector: string;
+        attributeName: string;
+        retryOptions?: {
+            timeoutMs: number;
+        };
+    };
+} | {
+    surfaceSessionId: string;
+    contextSessionId: string;
+    resolveFrame: {
+        cssSelector: string;
+        retryOptions?: {
+            timeoutMs: number;
+        };
+    };
+} | ContextPingRequest | RegisterHookRequest | WaitForHookRequest | SetFileChooserFilesRequest | SaveDownloadRequest | UploadFileChunkRequest | ReadFileChunkRequest | SetMobileFileChooserFilesRequest | SaveMobileDownloadRequest | NavigateRequest | ClickRequest | CountRequest | HighlightRequest | FocusRequest | FillRequest | HoverRequest | PressRequest | TextContentRequest | InnerTextRequest | WaitForSelectorRequest | AccessibilitySnapshotRequest | ScreenshotRequest | CloseContextRequest;
 export type SurfaceSessionStream = grpc.ClientDuplexStream<SurfaceSessionRequest, SurfaceSessionEvent>;
 export type ContextSessionStream = grpc.ClientDuplexStream<ContextSessionRequest, ContextSessionEvent>;
 export interface EngineServiceClientShape {
@@ -851,3 +891,20 @@ export declare class EventQueue<T> {
     fail(error: Error): void;
     next(): Promise<T>;
 }
+export interface CapturedOption {
+    value: string;
+    label: string;
+    index: number;
+}
+export interface BoundingBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface CaptureResult {
+    value?: string;
+    checked?: boolean;
+    selectedOptions?: CapturedOption[];
+    boundingBox?: BoundingBox;
+}

package/package.json

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

package/proto/core/v1/context.proto

@@ -37,6 +37,8 @@ message ContextSessionCommand {
     ReadFileChunkCommand read_file_chunk = 23;
     SetMobileFileChooserFilesCommand set_mobile_file_chooser_files = 24;
     SaveMobileDownloadCommand save_mobile_download = 25;
+    ResolveFrameCommand resolve_frame = 26;
+    CaptureCommand capture = 27;
   }
 }
 
@@ -76,6 +78,8 @@ message ContextSessionEvent {
     FileChunkEvent file_chunk = 25;
     MobileFileChooserFilesSetEvent mobile_file_chooser_files_set = 26;
     MobileDownloadSavedEvent mobile_download_saved = 27;
+    FrameResolvedEvent frame_resolved = 28;
+    CaptureResolvedEvent capture_resolved = 29;
   }
 }
 
@@ -309,3 +313,40 @@ message AccessibilitySnapshotCapturedEvent {
   string snapshot = 1;
   string format = 2;
 }
+
+// Read-only web inspection. Element reads use the first locator match.
+enum CaptureKind {
+  CAPTURE_KIND_UNSPECIFIED = 0;
+  CAPTURE_KIND_URL = 1;
+  CAPTURE_KIND_INPUT_VALUE = 2;
+  CAPTURE_KIND_SELECTED_OPTIONS = 3;
+  CAPTURE_KIND_SELECTED_TEXT = 4;
+  CAPTURE_KIND_CHECKED = 5;
+  CAPTURE_KIND_ATTRIBUTE = 6;
+  CAPTURE_KIND_BOUNDING_BOX = 7;
+}
+message CaptureCommand {
+  CaptureKind kind = 1;
+  string css_selector = 2;
+  string attribute_name = 3;
+  optional CommandRetryOptions retry_options = 4;
+}
+message CapturedOption {
+  string value = 1;
+  string label = 2;
+  uint32 index = 3;
+}
+message BoundingBox {
+  double x = 1;
+  double y = 2;
+  double width = 3;
+  double height = 4;
+}
+message CaptureResolvedEvent {
+  // Absent for a missing attribute or unsupported text selection.
+  optional string value = 1;
+  optional bool checked = 2;
+  repeated CapturedOption selected_options = 3;
+  // Viewport coordinates in CSS pixels, absent for an element without a visible box.
+  optional BoundingBox bounding_box = 4;
+}

package/proto/surfaces/web/v1/web.proto

@@ -88,3 +88,12 @@ message DownloadSavedEvent {
   uint64 size = 4;
   string note = 5;
 }
+
+// Resolve an iframe locator to a page after its document has loaded and settled.
+message ResolveFrameCommand {
+  string css_selector = 1;
+  optional CommandRetryOptions retry_options = 2;
+}
+message FrameResolvedEvent {
+  string context_session_id = 1;
+}