@allwright.dev/core 0.1.0 → 0.1.1

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.0";
+const DEFAULT_RELEASE_VERSION = "0.1.1";
 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, ResolveConfigOptions, ResolvedAllwrightConfig } from "./types.js";
 export { findConfigFile, loadConfigFile, resolveConfig, setServerAddr, shutdown };
-export type { AllwrightConfig, Browser, BrowserInfo, BrowserKind, BrowserType, 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 { AccessibilitySnapshotOptions, AllwrightConfig, Browser, BrowserInfo, BrowserKind, BrowserType, 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 { mobile };

package/dist/page.d.ts

@@ -1,4 +1,4 @@
-import type { ClickResult, CommandOptions, CountResult, ElementResult, FillResult, HighlightOptions, HighlightResult, Locator, NavigateResult, Page, PageInfo, PressOptions, PressResult, RuntimeClient, ScreenshotOptions, ScreenshotResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult } from "./types.js";
+import type { AccessibilitySnapshotOptions, ClickResult, CommandOptions, CountResult, ElementResult, FillResult, HighlightOptions, HighlightResult, Locator, NavigateResult, Page, PageInfo, PressOptions, PressResult, RuntimeClient, ScreenshotOptions, ScreenshotResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult } from "./types.js";
 export declare class PageImpl implements Page {
     #private;
     constructor(input: PageInfo & {
@@ -18,6 +18,7 @@ export declare class PageImpl implements Page {
     textContent(selector: string, options?: CommandOptions): Promise<TextResult>;
     innerText(selector: string, options?: CommandOptions): Promise<TextResult>;
     waitForSelector(selector: string, options?: WaitForSelectorOptions): Promise<WaitForSelectorResult>;
+    accessibilitySnapshot(options?: AccessibilitySnapshotOptions): Promise<string>;
     screenshot(options?: ScreenshotOptions): Promise<ScreenshotResult>;
     close(): Promise<void>;
     ping(message?: string): Promise<string>;

package/dist/page.js

@@ -305,6 +305,33 @@ export class PageImpl {
             }
         }
     }
+    async accessibilitySnapshot(options = {}) {
+        const format = options.format ?? "json";
+        if (format !== "json" && format !== "yaml") {
+            throw new Error("accessibility snapshot format must be 'json' or 'yaml'");
+        }
+        const handle = await this.#getHandle();
+        this.#ensureOpen(handle);
+        handle.stream.write({
+            surfaceSessionId: this.browserSessionId,
+            contextSessionId: this.sessionId,
+            accessibilitySnapshot: {
+                format,
+                retryOptions: options.timeoutMs ? { timeoutMs: options.timeoutMs } : undefined,
+            },
+        });
+        while (true) {
+            const event = await handle.queue.next();
+            if (event.accessibilitySnapshotCaptured)
+                return event.accessibilitySnapshotCaptured.snapshot ?? "";
+            if (event.error?.message)
+                throw formatActionError("accessibility snapshot", event.error.message);
+            if (event.closed) {
+                handle.closed = true;
+                throw new Error(`page session ${this.sessionId} closed while waiting for accessibility snapshot`);
+            }
+        }
+    }
     async screenshot(options = {}) {
         const handle = await this.#getHandle();
         this.#ensureOpen(handle);

package/dist/types.d.ts

@@ -8,6 +8,9 @@ export type BrowserKind = "chromium" | "firefox";
 export interface CommandOptions {
     timeoutMs?: number;
 }
+export interface AccessibilitySnapshotOptions extends CommandOptions {
+    format?: "json" | "yaml";
+}
 export interface NavigateResult {
     url: string;
     note: string;
@@ -105,6 +108,7 @@ export interface Browser extends BrowserInfo {
     browserInfo(): BrowserInfo;
 }
 export interface Page extends PageInfo {
+    accessibilitySnapshot(options?: AccessibilitySnapshotOptions): Promise<string>;
     locator(selector: string): Locator;
     goto(url: string, options?: CommandOptions): Promise<NavigateResult>;
     navigate(url: string, options?: CommandOptions): Promise<NavigateResult>;
@@ -337,6 +341,10 @@ export interface SurfaceSessionEvent {
     };
 }
 export interface ContextSessionEvent {
+    accessibilitySnapshotCaptured?: {
+        snapshot?: string;
+        format?: string;
+    };
     contextSessionId?: string;
     event?: string;
     attached?: {
@@ -591,6 +599,16 @@ export interface WaitForSelectorRequest {
         };
     };
 }
+export interface AccessibilitySnapshotRequest {
+    surfaceSessionId: string;
+    contextSessionId: string;
+    accessibilitySnapshot: {
+        format: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
 export interface ScreenshotRequest {
     surfaceSessionId: string;
     contextSessionId: string;
@@ -607,7 +625,7 @@ export interface CloseContextRequest {
     close: Record<string, never>;
 }
 export type SurfaceSessionRequest = LaunchBrowserRequest | LaunchChromeRequest | OpenContextRequest | ConnectMobileRequest | LaunchAppRequest | SurfacePingRequest | CloseSurfaceRequest;
-export type ContextSessionRequest = ContextPingRequest | NavigateRequest | ClickRequest | CountRequest | HighlightRequest | FocusRequest | FillRequest | HoverRequest | PressRequest | TextContentRequest | InnerTextRequest | WaitForSelectorRequest | ScreenshotRequest | CloseContextRequest;
+export type ContextSessionRequest = ContextPingRequest | 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 {

package/package.json

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

package/proto/core/v1/context.proto

@@ -2,8 +2,11 @@ syntax = "proto3";
 
 package allwright.engine.v1;
 option go_package = "allwright.dev/gen/allwright/engine/v1;enginev1";
+option java_package = "dev.allwright.engine.v1";
+option java_multiple_files = true;
 
 import "core/v1/common.proto";
+import "surfaces/web/v1/web.proto";
 
 message ContextSessionCommand {
   string surface_session_id = 1;
@@ -24,6 +27,7 @@ message ContextSessionCommand {
     GetInnerTextCommand get_inner_text = 14;
     WaitForSelectorCommand wait_for_selector = 15;
     ScreenshotCommand screenshot = 16;
+    AccessibilitySnapshotCommand accessibility_snapshot = 17;
   }
 }
 
@@ -54,6 +58,7 @@ message ContextSessionEvent {
     InnerTextResolvedEvent inner_text_resolved = 16;
     SelectorWaitSatisfiedEvent selector_wait_satisfied = 17;
     ScreenshotCapturedEvent screenshot_captured = 18;
+    AccessibilitySnapshotCapturedEvent accessibility_snapshot_captured = 19;
   }
 }
 

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

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package allwright.engine.v1;
 option go_package = "allwright.dev/gen/allwright/engine/v1;enginev1";
+option java_package = "dev.allwright.engine.v1";
+option java_multiple_files = true;
 
 import "core/v1/common.proto";
 
@@ -37,3 +39,15 @@ message ChromeLaunchedEvent {
   string user_data_dir = 4;
   string initial_page_session_id = 5;
 }
+
+// Empty format defaults to JSON. Accepted values are "json" and "yaml".
+message AccessibilitySnapshotCommand {
+  string format = 1;
+  optional CommandRetryOptions retry_options = 2;
+}
+
+// Both formats encode the same versioned, structured document.
+message AccessibilitySnapshotCapturedEvent {
+  string snapshot = 1;
+  string format = 2;
+}