@allwright.dev/core 0.1.23 → 0.1.24

package/README.md

@@ -51,11 +51,17 @@ Paths passed to `setFiles` and `saveAs` belong to the test process, even when
 the Allwright server is remote. Android apps support the same `fileChooser` and
 `download` hook shape; Android `newPage` hooks are not applicable.
 
-Runnable examples live in [examples/web-basic.ts](./examples/web-basic.ts), [examples/android-basic.ts](./examples/android-basic.ts), and [examples/ios-basic.ts](./examples/ios-basic.ts).
-
-Android, iOS, and macOS applications implement the shared `NativeApp` and
+Runnable examples cover every implemented surface:
+[Web](./examples/web-basic.ts), [Android](./examples/android-basic.ts),
+[iOS](./examples/ios-basic.ts), [macOS](./examples/macos-basic.ts), and
+[Windows](./examples/windows-basic.ts). The desktop examples default to
+Calculator on macOS and Notepad on Windows and accept `ALLWRIGHT_MAC_APP_ID`
+or `ALLWRIGHT_WINDOWS_APP_ID`.
+
+Android, iOS, macOS, and Windows applications implement the shared `NativeApp` and
 `NativeAppLocator` interfaces. Platform-specific type names such as
-`MobileAndroidApp`, `MobileIosLocator`, and `DesktopMacLocator` remain exported
+`MobileAndroidApp`, `MobileIosLocator`, `DesktopMacLocator`, and
+`DesktopWindowsLocator` remain exported
 as aliases for compatibility and platform-oriented annotations.
 
 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.23";
+const DEFAULT_RELEASE_VERSION = "0.1.24";
 const STARTUP_TIMEOUT_MS = 20_000;
 const PING_TIMEOUT_MS = 1_000;
 const PROTO_ROOT = fileURLToPath(new URL("../proto/", import.meta.url));

package/dist/desktop.js

@@ -9,14 +9,16 @@ class DesktopMacImpl {
     runtime;
     stream;
     queue;
+    platformLabel;
     #closed = false;
     #currentApp;
-    constructor(sessionId, surfaceSessionId, runtime, stream, queue, initialAppSessionId) {
+    constructor(sessionId, surfaceSessionId, runtime, stream, queue, initialAppSessionId, platformLabel = "macOS") {
         this.sessionId = sessionId;
         this.surfaceSessionId = surfaceSessionId;
         this.runtime = runtime;
         this.stream = stream;
         this.queue = queue;
+        this.platformLabel = platformLabel;
         this.#currentApp = new NativeAppImpl(runtime, surfaceSessionId, initialAppSessionId);
     }
     app() {
@@ -24,7 +26,7 @@ class DesktopMacImpl {
     }
     async launch(options) {
         if (this.#closed)
-            throw new Error(`macOS desktop session ${this.sessionId} is closed`);
+            throw new Error(`${this.platformLabel} desktop session ${this.sessionId} is closed`);
         this.stream.write({
             launchDesktopApp: {
                 appId: options.appId,
@@ -42,7 +44,7 @@ class DesktopMacImpl {
                 throw new Error(event.error.message);
             if (event.closed) {
                 this.#closed = true;
-                throw new Error(`macOS desktop session ${this.sessionId} closed while launching app`);
+                throw new Error(`${this.platformLabel} desktop session ${this.sessionId} closed while launching app`);
             }
         }
     }
@@ -61,7 +63,28 @@ class DesktopMacSurfaceImpl {
         while (true) {
             const event = await queue.next();
             if (event.desktopConnected?.initialAppSessionId) {
-                return new DesktopMacImpl(event.desktopConnected.desktopSessionId ?? event.sessionId ?? "", event.sessionId ?? "", runtime, stream, queue, event.desktopConnected.initialAppSessionId);
+                return new DesktopMacImpl(event.desktopConnected.desktopSessionId ?? event.sessionId ?? "", event.sessionId ?? "", runtime, stream, queue, event.desktopConnected.initialAppSessionId, "macOS");
+            }
+            if (event.error?.message)
+                throw new Error(event.error.message);
+        }
+    }
+}
+class DesktopWindowsSurfaceImpl {
+    async connect(options = {}) {
+        const runtime = await getRuntime();
+        const { stream, queue } = await createBrowserSessionHandle(runtime);
+        stream.write({
+            connectDesktop: {
+                platform: 2,
+                agentEndpoint: options.agentEndpoint,
+                retryOptions: retryOptions(options.timeoutMs),
+            },
+        });
+        while (true) {
+            const event = await queue.next();
+            if (event.desktopConnected?.initialAppSessionId) {
+                return new DesktopMacImpl(event.desktopConnected.desktopSessionId ?? event.sessionId ?? "", event.sessionId ?? "", runtime, stream, queue, event.desktopConnected.initialAppSessionId, "Windows");
             }
             if (event.error?.message)
                 throw new Error(event.error.message);
@@ -70,4 +93,5 @@ class DesktopMacSurfaceImpl {
 }
 export const desktop = {
     mac: new DesktopMacSurfaceImpl(),
+    windows: new DesktopWindowsSurfaceImpl(),
 };

package/dist/index.d.ts

@@ -6,7 +6,7 @@ import { PageImpl } from "./page.js";
 import { setServerAddr, shutdown } from "./runtime.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, Dialog, FileChooser, Download, ClickResult, CommandOptions, CountResult, ElementResult, FillResult, HighlightOptions, HighlightResult, LaunchOptions, NativeApp, NativeAppLocator, MobileAndroidConnectOptions, MobileAndroidDevice, MobileAndroidLaunchOptions, MobileAndroidLocator, MobileAndroidApp, MobileIosConnectOptions, MobileIosDevice, MobileIosLaunchOptions, MobileIosLocator, MobileIosApp, Locator, LocatorInfo, MobileSurfaceNamespace, DesktopMacApp, DesktopMacConnectOptions, DesktopMacDesktop, DesktopMacLaunchOptions, DesktopMacLocator, DesktopSurfaceNamespace, 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, NativeApp, NativeAppLocator, MobileAndroidConnectOptions, MobileAndroidDevice, MobileAndroidLaunchOptions, MobileAndroidLocator, MobileAndroidApp, MobileIosConnectOptions, MobileIosDevice, MobileIosLaunchOptions, MobileIosLocator, MobileIosApp, Locator, LocatorInfo, MobileSurfaceNamespace, DesktopMacApp, DesktopMacConnectOptions, DesktopMacDesktop, DesktopMacLaunchOptions, DesktopMacLocator, DesktopWindowsApp, DesktopWindowsConnectOptions, DesktopWindowsDesktop, DesktopWindowsLaunchOptions, DesktopWindowsLocator, DesktopSurfaceNamespace, 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/types.d.ts

@@ -273,10 +273,22 @@ export interface DesktopMacDesktop {
     app(): DesktopMacApp;
     launch(options: DesktopMacLaunchOptions): Promise<DesktopMacApp>;
 }
+export type DesktopWindowsConnectOptions = DesktopMacConnectOptions;
+export type DesktopWindowsLaunchOptions = DesktopMacLaunchOptions;
+export type DesktopWindowsApp = NativeApp;
+export type DesktopWindowsLocator = NativeAppLocator;
+export interface DesktopWindowsDesktop {
+    readonly sessionId: string;
+    app(): DesktopWindowsApp;
+    launch(options: DesktopWindowsLaunchOptions): Promise<DesktopWindowsApp>;
+}
 export interface DesktopSurfaceNamespace {
     mac: {
         connect(options?: DesktopMacConnectOptions): Promise<DesktopMacDesktop>;
     };
+    windows: {
+        connect(options?: DesktopWindowsConnectOptions): Promise<DesktopWindowsDesktop>;
+    };
 }
 export interface Locator extends WebLocators {
     inputValue(options?: CommandOptions): Promise<string>;

package/package.json

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