@allwright.dev/core 0.1.6 → 0.1.7

package/README.md

@@ -33,6 +33,20 @@ await page.click("a[target=_blank]");
 const newPage = await hook.wait();
 ```
 
+```ts
+const hook = await page.registerHook(hooks.fileChooser);
+await page.click("button.open-upload");
+const chooser = await hook.wait();
+await chooser.setFiles("fixtures/document.pdf");
+```
+
+```ts
+const hook = await page.registerHook(hooks.download);
+await page.click("a.download-report");
+const download = await hook.wait();
+await download.saveAs(`artifacts/${download.suggestedFilename}`);
+```
+
 Runnable examples live in [examples/web-basic.ts](./examples/web-basic.ts) and [examples/android-basic.ts](./examples/android-basic.ts).
 
 Shared config files are stack-agnostic and can live in `allwright.config.yaml` or `allwright.config.json`.

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.6";
+const DEFAULT_RELEASE_VERSION = "0.1.7";
 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,13 +3,15 @@ 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, HookType, ResolveConfigOptions, ResolvedAllwrightConfig } from "./types.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, 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, 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: {
     newPage: HookType<Page>;
+    fileChooser: HookType<FileChooser>;
+    download: HookType<Download>;
 };
 export { mobile };
 export type Tab = Page;

package/dist/index.js

@@ -9,6 +9,8 @@ export const chromium = new BrowserTypeImpl("chromium");
 export const firefox = new BrowserTypeImpl("firefox");
 export const hooks = {
     newPage: Object.freeze({ name: "newPage" }),
+    fileChooser: Object.freeze({ name: "fileChooser" }),
+    download: Object.freeze({ name: "download" }),
 };
 export { mobile };
 export async function ping() {

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, HighlightOptions, HighlightResult, Hook, HookType, Locator, NavigateResult, Page, PageInfo, PressOptions, PressResult, RuntimeClient, ScreenshotOptions, ScreenshotResult, TextResult, WaitForSelectorOptions, WaitForSelectorResult } from "./types.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";
 export declare class PageImpl extends WebLocatorBuilders implements Page {
     #private;
     constructor(input: PageInfo & {
@@ -9,6 +9,8 @@ export declare class PageImpl extends WebLocatorBuilders implements Page {
     readonly sessionId: string;
     readonly browserSessionId: string;
     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>;
     locator(selector: string, options?: LocatorFilterOptions): Locator;
     goto(url: string, options?: CommandOptions): Promise<NavigateResult>;
     click(selector: string, options?: CommandOptions): Promise<ClickResult>;
@@ -29,3 +31,19 @@ export declare class PageImpl extends WebLocatorBuilders implements Page {
     navigate(url: string, options?: CommandOptions): Promise<NavigateResult>;
     dispose(): void;
 }
+export declare class FileChooserImpl implements FileChooser {
+    readonly page: PageImpl;
+    readonly id: string;
+    readonly multiple: boolean;
+    constructor(page: PageImpl, id: string, multiple: boolean);
+    isMultiple(): boolean;
+    setFiles(files: string | string[], options?: CommandOptions): Promise<void>;
+}
+export declare class DownloadImpl implements Download {
+    readonly page: PageImpl;
+    readonly id: string;
+    readonly url: string;
+    readonly suggestedFilename: string;
+    constructor(page: PageImpl, id: string, url: string, suggestedFilename: string);
+    saveAs(path: string, options?: CommandOptions): Promise<void>;
+}

package/dist/page.js

@@ -23,7 +23,7 @@ export class PageImpl extends WebLocatorBuilders {
     sessionId;
     browserSessionId;
     async registerHook(type) {
-        if (type.name !== "newPage") {
+        if (type.name !== "newPage" && type.name !== "fileChooser" && type.name !== "download") {
             throw formatActionError("register hook", `unsupported hook type: ${type.name}`);
         }
         const handle = await this.#getHandle();
@@ -31,7 +31,11 @@ export class PageImpl extends WebLocatorBuilders {
         handle.stream.write({
             surfaceSessionId: this.browserSessionId,
             contextSessionId: this.sessionId,
-            registerHook: { newPage: {} },
+            registerHook: type.name === "newPage"
+                ? { newPage: {} }
+                : type.name === "fileChooser"
+                    ? { fileChooser: {} }
+                    : { download: {} },
         });
         while (true) {
             const event = await handle.queue.next();
@@ -65,6 +69,12 @@ export class PageImpl extends WebLocatorBuilders {
                 if (type.name === "newPage" && event.hookCompleted.newPage?.contextSessionId) {
                     return this.#createPage(event.hookCompleted.newPage.contextSessionId);
                 }
+                if (type.name === "fileChooser" && event.hookCompleted.fileChooser?.fileChooserId) {
+                    return new FileChooserImpl(this, event.hookCompleted.fileChooser.fileChooserId, event.hookCompleted.fileChooser.isMultiple ?? false);
+                }
+                if (type.name === "download" && event.hookCompleted.download?.downloadId) {
+                    return new DownloadImpl(this, event.hookCompleted.download.downloadId, event.hookCompleted.download.url ?? "", event.hookCompleted.download.suggestedFilename ?? "");
+                }
                 throw formatActionError(`wait for ${type.name} hook`, "hook returned an invalid result");
             }
             if (event.error?.message) {
@@ -72,6 +82,50 @@ export class PageImpl extends WebLocatorBuilders {
             }
         }
     }
+    async setFileChooserFiles(fileChooserId, files, options = {}) {
+        const handle = await this.#getHandle();
+        this.#ensureOpen(handle);
+        handle.stream.write({
+            surfaceSessionId: this.browserSessionId,
+            contextSessionId: this.sessionId,
+            setFileChooserFiles: {
+                fileChooserId,
+                files,
+                retryOptions: options.timeoutMs ? { timeoutMs: options.timeoutMs } : undefined,
+            },
+        });
+        while (true) {
+            const event = await handle.queue.next();
+            if (event.fileChooserFilesSet?.fileChooserId === fileChooserId) {
+                return;
+            }
+            if (event.error?.message) {
+                throw formatActionError("set file chooser files", event.error.message);
+            }
+        }
+    }
+    async saveDownload(downloadId, path, options = {}) {
+        const handle = await this.#getHandle();
+        this.#ensureOpen(handle);
+        handle.stream.write({
+            surfaceSessionId: this.browserSessionId,
+            contextSessionId: this.sessionId,
+            saveDownload: {
+                downloadId,
+                path,
+                retryOptions: options.timeoutMs ? { timeoutMs: options.timeoutMs } : undefined,
+            },
+        });
+        while (true) {
+            const event = await handle.queue.next();
+            if (event.downloadSaved?.downloadId === downloadId) {
+                return;
+            }
+            if (event.error?.message) {
+                throw formatActionError("save download", event.error.message);
+            }
+        }
+    }
     locator(selector, options) {
         const result = new LocatorImpl({ page: this, selector: normalizeSelectorForTransport(selector) });
         return options ? result.filter(options) : result;
@@ -566,3 +620,38 @@ export class PageImpl extends WebLocatorBuilders {
         });
     }
 }
+export class FileChooserImpl {
+    page;
+    id;
+    multiple;
+    constructor(page, id, multiple) {
+        this.page = page;
+        this.id = id;
+        this.multiple = multiple;
+    }
+    isMultiple() {
+        return this.multiple;
+    }
+    async setFiles(files, options = {}) {
+        const paths = typeof files === "string" ? [files] : files;
+        if (!this.multiple && paths.length > 1) {
+            throw formatActionError("set file chooser files", "file chooser does not accept multiple files");
+        }
+        await this.page.setFileChooserFiles(this.id, paths, options);
+    }
+}
+export class DownloadImpl {
+    page;
+    id;
+    url;
+    suggestedFilename;
+    constructor(page, id, url, suggestedFilename) {
+        this.page = page;
+        this.id = id;
+        this.url = url;
+        this.suggestedFilename = suggestedFilename;
+    }
+    async saveAs(path, options = {}) {
+        await this.page.saveDownload(this.id, path, options);
+    }
+}

package/dist/types.d.ts

@@ -108,6 +108,19 @@ export interface Hook<T> {
     readonly type: HookType<T>;
     wait(options?: CommandOptions): Promise<T>;
 }
+export interface FileChooser {
+    readonly id: string;
+    readonly page: Page;
+    isMultiple(): boolean;
+    setFiles(files: string | string[], options?: CommandOptions): Promise<void>;
+}
+export interface Download {
+    readonly id: string;
+    readonly page: Page;
+    readonly url: string;
+    readonly suggestedFilename: string;
+    saveAs(path: string, options?: CommandOptions): Promise<void>;
+}
 export interface Browser extends BrowserInfo {
     page(): Page;
     initialPage(): Page;
@@ -387,6 +400,27 @@ export interface ContextSessionEvent {
             contextSessionId?: string;
             note?: string;
         };
+        fileChooser?: {
+            fileChooserId?: string;
+            isMultiple?: boolean;
+            note?: string;
+        };
+        download?: {
+            downloadId?: string;
+            url?: string;
+            suggestedFilename?: string;
+            note?: string;
+        };
+    };
+    fileChooserFilesSet?: {
+        fileChooserId?: string;
+        files?: string[];
+        note?: string;
+    };
+    downloadSaved?: {
+        downloadId?: string;
+        path?: string;
+        note?: string;
     };
     navigated?: {
         url?: string;
@@ -481,6 +515,30 @@ export interface RegisterHookRequest {
     contextSessionId: string;
     registerHook: {
         newPage?: Record<string, never>;
+        fileChooser?: Record<string, never>;
+        download?: Record<string, never>;
+    };
+}
+export interface SaveDownloadRequest {
+    surfaceSessionId: string;
+    contextSessionId: string;
+    saveDownload: {
+        downloadId: string;
+        path: string;
+        retryOptions?: {
+            timeoutMs?: number;
+        };
+    };
+}
+export interface SetFileChooserFilesRequest {
+    surfaceSessionId: string;
+    contextSessionId: string;
+    setFileChooserFiles: {
+        fileChooserId: string;
+        files: string[];
+        retryOptions?: {
+            timeoutMs?: number;
+        };
     };
 }
 export interface WaitForHookRequest {
@@ -672,7 +730,7 @@ export interface CloseContextRequest {
     close: Record<string, never>;
 }
 export type SurfaceSessionRequest = LaunchBrowserRequest | LaunchChromeRequest | OpenContextRequest | ConnectMobileRequest | LaunchAppRequest | SurfacePingRequest | CloseSurfaceRequest;
-export type ContextSessionRequest = ContextPingRequest | RegisterHookRequest | WaitForHookRequest | NavigateRequest | ClickRequest | CountRequest | HighlightRequest | FocusRequest | FillRequest | HoverRequest | PressRequest | TextContentRequest | InnerTextRequest | WaitForSelectorRequest | AccessibilitySnapshotRequest | ScreenshotRequest | CloseContextRequest;
+export type ContextSessionRequest = ContextPingRequest | RegisterHookRequest | WaitForHookRequest | SetFileChooserFilesRequest | SaveDownloadRequest | 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.6",
+  "version": "0.1.7",
   "description": "High-level TypeScript client for the allwright automation engine.",
   "license": "MIT",
   "type": "module",

package/proto/core/v1/context.proto

@@ -30,6 +30,8 @@ message ContextSessionCommand {
     AccessibilitySnapshotCommand accessibility_snapshot = 17;
     RegisterHookCommand register_hook = 18;
     WaitForHookCommand wait_for_hook = 19;
+    SetFileChooserFilesCommand set_file_chooser_files = 20;
+    SaveDownloadCommand save_download = 21;
   }
 }
 
@@ -63,6 +65,8 @@ message ContextSessionEvent {
     AccessibilitySnapshotCapturedEvent accessibility_snapshot_captured = 19;
     HookRegisteredEvent hook_registered = 20;
     HookCompletedEvent hook_completed = 21;
+    FileChooserFilesSetEvent file_chooser_files_set = 22;
+    DownloadSavedEvent download_saved = 23;
   }
 }
 
@@ -85,6 +89,8 @@ message ContextSessionErrorEvent {
 message RegisterHookCommand {
   oneof hook {
     RegisterNewPageHook new_page = 1;
+    RegisterFileChooserHook file_chooser = 2;
+    RegisterDownloadHook download = 3;
   }
 }
 
@@ -102,6 +108,8 @@ message HookCompletedEvent {
 
   oneof result {
     NewPageHookResult new_page = 2;
+    FileChooserHookResult file_chooser = 3;
+    DownloadHookResult download = 4;
   }
 }
 

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

@@ -46,3 +46,44 @@ message NewPageHookResult {
   string context_session_id = 1;
   string note = 2;
 }
+
+message RegisterFileChooserHook {}
+
+message FileChooserHookResult {
+  string file_chooser_id = 1;
+  bool is_multiple = 2;
+  string note = 3;
+}
+
+message SetFileChooserFilesCommand {
+  string file_chooser_id = 1;
+  repeated string files = 2;
+  optional CommandRetryOptions retry_options = 3;
+}
+
+message FileChooserFilesSetEvent {
+  string file_chooser_id = 1;
+  repeated string files = 2;
+  string note = 3;
+}
+
+message RegisterDownloadHook {}
+
+message DownloadHookResult {
+  string download_id = 1;
+  string url = 2;
+  string suggested_filename = 3;
+  string note = 4;
+}
+
+message SaveDownloadCommand {
+  string download_id = 1;
+  string path = 2;
+  optional CommandRetryOptions retry_options = 3;
+}
+
+message DownloadSavedEvent {
+  string download_id = 1;
+  string path = 2;
+  string note = 3;
+}