@allwright.dev/core 0.1.14 → 0.1.15

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.14";
+const DEFAULT_RELEASE_VERSION = "0.1.15";
 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

@@ -3,12 +3,13 @@ import { findConfigFile, loadConfigFile, resolveConfig } from "./config.js";
 import { mobile } from "./mobile.js";
 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";
+import type { Browser, BrowserKind, BrowserType, LaunchOptions, Page, Dialog, FileChooser, Download, HookType, ResolveConfigOptions, ResolvedAllwrightConfig } from "./types.js";
 export { findConfigFile, loadConfigFile, resolveConfig, setServerAddr, shutdown };
-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 type { CapturedOption, BoundingBox, AccessibilitySnapshotOptions, AllwrightConfig, Browser, BrowserInfo, BrowserKind, BrowserType, Hook, HookType, Dialog, 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: {
+    dialog: HookType<Dialog>;
     newPage: HookType<Page>;
     fileChooser: HookType<FileChooser>;
     download: HookType<Download>;

package/dist/index.js

@@ -8,6 +8,7 @@ export { findConfigFile, loadConfigFile, resolveConfig, setServerAddr, shutdown
 export const chromium = new BrowserTypeImpl("chromium");
 export const firefox = new BrowserTypeImpl("firefox");
 export const hooks = {
+    dialog: Object.freeze({ name: "dialog" }),
     newPage: Object.freeze({ name: "newPage" }),
     fileChooser: Object.freeze({ name: "fileChooser" }),
     download: Object.freeze({ name: "download" }),

package/dist/page.js

@@ -42,7 +42,7 @@ export class PageImpl extends WebLocatorBuilders {
         }
     }
     async registerHook(type) {
-        if (type.name !== "newPage" && type.name !== "fileChooser" && type.name !== "download") {
+        if (type.name !== "dialog" && type.name !== "newPage" && type.name !== "fileChooser" && type.name !== "download") {
             throw formatActionError("register hook", `unsupported hook type: ${type.name}`);
         }
         const handle = await this.#getHandle();
@@ -50,11 +50,8 @@ export class PageImpl extends WebLocatorBuilders {
         handle.stream.write({
             surfaceSessionId: this.browserSessionId,
             contextSessionId: this.sessionId,
-            registerHook: type.name === "newPage"
-                ? { newPage: {} }
-                : type.name === "fileChooser"
-                    ? { fileChooser: {} }
-                    : { download: {} },
+            registerHook: type.name === "dialog" ? { dialog: {} } : type.name === "newPage"
+                ? { newPage: {} } : type.name === "fileChooser" ? { fileChooser: {} } : { download: {} },
         });
         while (true) {
             const event = await handle.queue.next();
@@ -79,12 +76,21 @@ export class PageImpl extends WebLocatorBuilders {
             contextSessionId: this.sessionId,
             waitForHook: {
                 hookId,
-                retryOptions: options.timeoutMs ? { timeoutMs: options.timeoutMs } : undefined,
+                retryOptions: options.timeoutMs !== undefined ? { timeoutMs: options.timeoutMs } : undefined,
             },
         });
         while (true) {
             const event = await handle.queue.next();
             if (event.hookCompleted?.hookId === hookId) {
+                if (type.name === "dialog" && event.hookCompleted.dialog?.dialogId) {
+                    const result = event.hookCompleted.dialog;
+                    const id = result.dialogId;
+                    return {
+                        id, page: this, type: result.type ?? "", message: result.message ?? "", defaultValue: result.defaultValue ?? "",
+                        accept: (promptText, options = {}) => this.#handleDialog(id, true, promptText, options),
+                        dismiss: (options = {}) => this.#handleDialog(id, false, undefined, options),
+                    };
+                }
                 if (type.name === "newPage" && event.hookCompleted.newPage?.contextSessionId) {
                     return this.#createPage(event.hookCompleted.newPage.contextSessionId);
                 }
@@ -101,6 +107,25 @@ export class PageImpl extends WebLocatorBuilders {
             }
         }
     }
+    async #handleDialog(dialogId, accept, promptText, options) {
+        const handle = await this.#getHandle();
+        this.#ensureOpen(handle);
+        handle.stream.write({ surfaceSessionId: this.browserSessionId, contextSessionId: this.sessionId,
+            handleDialog: { dialogId, accept, promptText,
+                ...(options.timeoutMs !== undefined ? { retryOptions: { timeoutMs: options.timeoutMs } } : {}),
+            } });
+        while (true) {
+            const event = await handle.queue.next();
+            if (event.dialogHandled?.dialogId === dialogId)
+                return;
+            if (event.error?.message)
+                throw formatActionError("handle dialog", event.error.message);
+            if (event.closed) {
+                handle.closed = true;
+                throw new Error("page closed while handling dialog");
+            }
+        }
+    }
     async setFileChooserFiles(fileChooserId, files, options = {}) {
         const handle = await this.#getHandle();
         this.#ensureOpen(handle);

package/dist/types.d.ts

@@ -108,6 +108,15 @@ export interface Hook<T> {
     readonly type: HookType<T>;
     wait(options?: CommandOptions): Promise<T>;
 }
+export interface Dialog {
+    readonly id: string;
+    readonly page: Page;
+    readonly type: string;
+    readonly message: string;
+    readonly defaultValue: string;
+    accept(promptText?: string, options?: CommandOptions): Promise<void>;
+    dismiss(options?: CommandOptions): Promise<void>;
+}
 export interface FileChooser {
     readonly id: string;
     readonly page: Page | MobileAndroidApp;
@@ -415,8 +424,17 @@ export interface ContextSessionEvent {
     hookRegistered?: {
         hookId?: string;
     };
+    dialogHandled?: {
+        dialogId?: string;
+    };
     hookCompleted?: {
         hookId?: string;
+        dialog?: {
+            dialogId?: string;
+            type?: string;
+            message?: string;
+            defaultValue?: string;
+        };
         newPage?: {
             contextSessionId?: string;
             note?: string;
@@ -567,10 +585,23 @@ export interface OpenContextRequest {
         };
     };
 }
+export interface HandleDialogRequest {
+    surfaceSessionId: string;
+    contextSessionId: string;
+    handleDialog: {
+        dialogId: string;
+        accept: boolean;
+        promptText?: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
 export interface RegisterHookRequest {
     surfaceSessionId: string;
     contextSessionId: string;
     registerHook: {
+        dialog?: Record<string, never>;
         newPage?: Record<string, never>;
         fileChooser?: Record<string, never>;
         download?: Record<string, never>;
@@ -849,7 +880,7 @@ export type ContextSessionRequest = {
             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;
+} | ContextPingRequest | RegisterHookRequest | WaitForHookRequest | HandleDialogRequest | 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 {

package/package.json

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

package/proto/core/v1/context.proto

@@ -39,6 +39,7 @@ message ContextSessionCommand {
     SaveMobileDownloadCommand save_mobile_download = 25;
     ResolveFrameCommand resolve_frame = 26;
     CaptureCommand capture = 27;
+    HandleDialogCommand handle_dialog = 28;
   }
 }
 
@@ -80,6 +81,7 @@ message ContextSessionEvent {
     MobileDownloadSavedEvent mobile_download_saved = 27;
     FrameResolvedEvent frame_resolved = 28;
     CaptureResolvedEvent capture_resolved = 29;
+    DialogHandledEvent dialog_handled = 30;
   }
 }
 
@@ -106,6 +108,7 @@ message RegisterHookCommand {
     RegisterDownloadHook download = 3;
     RegisterMobileFileChooserHook mobile_file_chooser = 4;
     RegisterMobileDownloadHook mobile_download = 5;
+    RegisterDialogHook dialog = 6;
   }
 }
 
@@ -127,6 +130,7 @@ message HookCompletedEvent {
     DownloadHookResult download = 4;
     MobileFileChooserHookResult mobile_file_chooser = 5;
     MobileDownloadHookResult mobile_download = 6;
+    DialogHookResult dialog = 7;
   }
 }
 

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

@@ -40,6 +40,23 @@ message ChromeLaunchedEvent {
   string initial_page_session_id = 5;
 }
 
+// Register before the triggering action; wait returns a pending JavaScript dialog.
+message RegisterDialogHook {}
+message DialogHookResult {
+  string dialog_id = 1;
+  string type = 2;
+  string message = 3;
+  string default_value = 4;
+}
+message HandleDialogCommand {
+  string dialog_id = 1;
+  bool accept = 2;
+  optional string prompt_text = 3;
+  // A single-attempt deadline, not a retry request.
+  optional CommandRetryOptions retry_options = 4;
+}
+message DialogHandledEvent { string dialog_id = 1; }
+
 message RegisterNewPageHook {}
 
 message NewPageHookResult {