@wailsio/runtime 3.0.0-alpha.9 → 3.0.0-alpha.94

package/types/screens.d.ts

@@ -1,17 +1,74 @@
+export interface Size {
+    /** The width of a rectangular area. */
+    Width: number;
+    /** The height of a rectangular area. */
+    Height: number;
+}
+export interface Rect {
+    /** The X coordinate of the origin. */
+    X: number;
+    /** The Y coordinate of the origin. */
+    Y: number;
+    /** The width of the rectangle. */
+    Width: number;
+    /** The height of the rectangle. */
+    Height: number;
+}
+export interface Screen {
+    /** Unique identifier for the screen. */
+    ID: string;
+    /** Human-readable name of the screen. */
+    Name: string;
+    /** The scale factor of the screen (DPI/96). 1 = standard DPI, 2 = HiDPI (Retina), etc. */
+    ScaleFactor: number;
+    /** The X coordinate of the screen. */
+    X: number;
+    /** The Y coordinate of the screen. */
+    Y: number;
+    /** Contains the width and height of the screen. */
+    Size: Size;
+    /** Contains the bounds of the screen in terms of X, Y, Width, and Height. */
+    Bounds: Rect;
+    /** Contains the physical bounds of the screen in terms of X, Y, Width, and Height (before scaling). */
+    PhysicalBounds: Rect;
+    /** Contains the area of the screen that is actually usable (excluding taskbar and other system UI). */
+    WorkArea: Rect;
+    /** Contains the physical WorkArea of the screen (before scaling). */
+    PhysicalWorkArea: Rect;
+    /** True if this is the primary monitor selected by the user in the operating system. */
+    IsPrimary: boolean;
+    /** The rotation of the screen. */
+    Rotation: number;
+}
 /**
  * Gets all screens.
- * @returns {Promise<Screen[]>} A promise that resolves to an array of Screen objects.
+ *
+ * @returns A promise that resolves to an array of Screen objects.
  */
-export function GetAll(): Promise<Screen[]>;
+export declare function GetAll(): Promise<Screen[]>;
 /**
  * Gets the primary screen.
- * @returns {Promise<Screen>} A promise that resolves to the primary screen.
+ *
+ * @returns A promise that resolves to the primary screen.
  */
-export function GetPrimary(): Promise<Screen>;
+export declare function GetPrimary(): Promise<Screen>;
 /**
  * Gets the current active screen.
  *
- * @returns {Promise<Screen>} A promise that resolves with the current active screen.
+ * @returns A promise that resolves with the current active screen.
+ */
+export declare function GetCurrent(): Promise<Screen>;
+/**
+ * Gets a screen by its unique display ID.
+ *
+ * @param id - The unique identifier of the screen.
+ * @returns A promise that resolves to the matching Screen.
+ */
+export declare function GetByID(id: string): Promise<Screen>;
+/**
+ * Gets a screen by its index in the screen list.
+ *
+ * @param index - The zero-based index of the screen.
+ * @returns A promise that resolves to the matching Screen.
  */
-export function GetCurrent(): Promise<Screen>;
-export type Screen = any;
+export declare function GetByIndex(index: number): Promise<Screen>;

package/types/system.d.ts

@@ -1,72 +1,107 @@
+export declare function invoke(msg: any): void;
 /**
- * @function
  * Retrieves the system dark mode status.
- * @returns {Promise<boolean>} - A promise that resolves to a boolean value indicating if the system is in dark mode.
+ *
+ * @returns A promise that resolves to a boolean value indicating if the system is in dark mode.
  */
-export function IsDarkMode(): Promise<boolean>;
+export declare function IsDarkMode(): Promise<boolean>;
 /**
  * Fetches the capabilities of the application from the server.
  *
- * @async
- * @function Capabilities
- * @returns {Promise<Object>} A promise that resolves to an object containing the capabilities.
- */
-export function Capabilities(): Promise<any>;
-/**
- * @typedef {object} EnvironmentInfo
- * @property {string} OS - The operating system in use.
- * @property {string} Arch - The architecture of the system.
+ * @returns A promise that resolves to an object containing the capabilities.
  */
+export declare function Capabilities(): Promise<Record<string, any>>;
+export interface OSInfo {
+    /** The branding of the OS. */
+    Branding: string;
+    /** The ID of the OS. */
+    ID: string;
+    /** The name of the OS. */
+    Name: string;
+    /** The version of the OS. */
+    Version: string;
+}
+export interface EnvironmentInfo {
+    /** The architecture of the system. */
+    Arch: string;
+    /** True if the application is running in debug mode, otherwise false. */
+    Debug: boolean;
+    /** The operating system in use. */
+    OS: string;
+    /** Details of the operating system. */
+    OSInfo: OSInfo;
+    /** Additional platform information. */
+    PlatformInfo: Record<string, any>;
+}
 /**
- * @function
  * Retrieves environment details.
- * @returns {Promise<EnvironmentInfo>} - A promise that resolves to an object containing OS and system architecture.
+ *
+ * @returns A promise that resolves to an object containing OS and system architecture.
  */
-export function Environment(): Promise<EnvironmentInfo>;
+export declare function Environment(): Promise<EnvironmentInfo>;
 /**
  * Checks if the current operating system is Windows.
  *
- * @return {boolean} True if the operating system is Windows, otherwise false.
+ * @return True if the operating system is Windows, otherwise false.
  */
-export function IsWindows(): boolean;
+export declare function IsWindows(): boolean;
 /**
  * Checks if the current operating system is Linux.
  *
- * @returns {boolean} Returns true if the current operating system is Linux, false otherwise.
+ * @returns Returns true if the current operating system is Linux, false otherwise.
  */
-export function IsLinux(): boolean;
+export declare function IsLinux(): boolean;
 /**
  * Checks if the current environment is a macOS operating system.
  *
- * @returns {boolean} True if the environment is macOS, false otherwise.
+ * @returns True if the environment is macOS, false otherwise.
+ */
+export declare function IsMac(): boolean;
+/**
+ * Checks if the current operating system is iOS.
+ *
+ * @returns True if the operating system is iOS, otherwise false.
+ */
+export declare function IsIOS(): boolean;
+/**
+ * Checks if the current operating system is Android.
+ *
+ * @returns True if the operating system is Android, otherwise false.
  */
-export function IsMac(): boolean;
+export declare function IsAndroid(): boolean;
+/**
+ * Checks if the app is running on a mobile OS (iOS or Android).
+ *
+ * @returns True on iOS or Android, otherwise false.
+ */
+export declare function IsMobile(): boolean;
+/**
+ * Checks if the app is running on a desktop OS (macOS, Windows or Linux).
+ *
+ * @returns True on macOS, Windows or Linux, otherwise false.
+ */
+export declare function IsDesktop(): boolean;
 /**
  * Checks if the current environment architecture is AMD64.
- * @returns {boolean} True if the current environment architecture is AMD64, false otherwise.
+ *
+ * @returns True if the current environment architecture is AMD64, false otherwise.
  */
-export function IsAMD64(): boolean;
+export declare function IsAMD64(): boolean;
 /**
  * Checks if the current architecture is ARM.
  *
- * @returns {boolean} True if the current architecture is ARM, false otherwise.
+ * @returns True if the current architecture is ARM, false otherwise.
  */
-export function IsARM(): boolean;
+export declare function IsARM(): boolean;
 /**
  * Checks if the current environment is ARM64 architecture.
  *
- * @returns {boolean} - Returns true if the environment is ARM64 architecture, otherwise returns false.
+ * @returns Returns true if the environment is ARM64 architecture, otherwise returns false.
  */
-export function IsARM64(): boolean;
-export function IsDebug(): boolean;
-export let invoke: any;
-export type EnvironmentInfo = {
-    /**
-     * - The operating system in use.
-     */
-    OS: string;
-    /**
-     * - The architecture of the system.
-     */
-    Arch: string;
-};
+export declare function IsARM64(): boolean;
+/**
+ * Reports whether the app is being run in debug mode.
+ *
+ * @returns True if the app is being run in debug mode.
+ */
+export declare function IsDebug(): boolean;

package/types/updater.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Updater event name constants.
+ *
+ * Use these instead of hard-coding string literals when subscribing to
+ * updater events from JavaScript:
+ *
+ *     import { Events, Updater } from "@wailsio/runtime";
+ *
+ *     Events.On(Updater.Events.UpdateAvailable, (e) => {
+ *         console.log("update found:", e.data.version);
+ *     });
+ *
+ *     Events.On(Updater.Events.DownloadProgress, (e) => {
+ *         const p = e.data;
+ *         console.log(`${p.written} / ${p.total} bytes`);
+ *     });
+ *
+ * Mirrors the Go-side constants in `pkg/updater/events.go` and the
+ * user-action constants in `pkg/updater/window_lifecycle.go`. Any
+ * changes here must stay in sync with those files — there's an
+ * integration test that asserts the strings match.
+ */
+export declare const Events: Readonly<{
+    /** A Check round-trip is starting. Payload: null. */
+    CheckStarted: "wails:updater:check-started";
+    /** Check found a newer release. Payload: Release. */
+    UpdateAvailable: "wails:updater:update-available";
+    /** Check confirmed the caller is up to date. Payload: null. */
+    NoUpdate: "wails:updater:no-update";
+    /** Download is starting. Payload: Release. */
+    DownloadStarted: "wails:updater:download-started";
+    /** Periodic progress tick during download (~10 Hz). Payload: Progress. */
+    DownloadProgress: "wails:updater:download-progress";
+    /** All bytes are on disk, but verification has not yet started. Payload: Release. */
+    DownloadComplete: "wails:updater:download-complete";
+    /** Signature / digest verification has started. Payload: Release. */
+    Verifying: "wails:updater:verifying";
+    /** The Updater is swapping the binary into place. Payload: Release. */
+    Installing: "wails:updater:installing";
+    /** Update is staged and a restart is pending. Payload: Release. */
+    UpdateReady: "wails:updater:update-ready";
+    /** Something failed. Payload: ErrorInfo { stage, message, provider }. */
+    Error: "wails:updater:error";
+    /** Host-side context delivered once per session. Payload: Meta { currentVersion, skippedVersion }. */
+    Meta: "wails:updater:meta";
+    /** Sub-namespace: user-action events that the UI emits BACK to the host. */
+    User: Readonly<{
+        /** User clicked Install on an Available update. */
+        Install: "wails:updater:user:install";
+        /** User clicked Restart & Apply on a Ready update. */
+        Restart: "wails:updater:user:restart";
+        /** User clicked Skip This Version. */
+        Skip: "wails:updater:user:skip";
+        /** User clicked Remind Me Later. */
+        Remind: "wails:updater:user:remind";
+        /** User clicked Close / Cancel. */
+        Cancel: "wails:updater:user:cancel";
+    }>;
+    /** Sub-namespace: framework-internal events the UI emits to coordinate
+     *  with the host. Most app code can ignore these. */
+    Window: Readonly<{
+        /** The window finished loading and asks the host to replay current state. */
+        Ready: "wails:updater:window:ready";
+    }>;
+}>;

package/types/utils.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Logs a message to the console with custom formatting.
+ *
+ * @param message - The message to be logged.
+ */
+export declare function debugLog(message: any): void;
+/**
+ * Checks whether the webview supports the {@link MouseEvent#buttons} property.
+ * Looking at you macOS High Sierra!
+ */
+export declare function canTrackButtons(): boolean;
+/**
+ * Checks whether the browser supports removing listeners by triggering an AbortSignal
+ * (see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#signal).
+ */
+export declare function canAbortListeners(): boolean;
+/**
+ * Resolves the closest HTMLElement ancestor of an event's target.
+ */
+export declare function eventTarget(event: Event): HTMLElement;
+export declare function whenReady(callback: () => void): void;

package/types/window.d.ts

@@ -1,17 +1,331 @@
+import type { Screen } from "./screens.js";
 /**
- * Gets the specified window.
- *
- * @param {string} windowName - The name of the window to get.
- * @return {Object} - The specified window object.
+ * Called from Go when a file drag enters the window on Linux/macOS.
  */
-export function Get(windowName: string): any;
+declare function handleDragEnter(): void;
 /**
- * Returns a map of all methods in the current window.
- * @returns {Map} - A map of window methods.
+ * Called from Go when a file drag leaves the window on Linux/macOS.
  */
-export function WindowMethods(targetWindow: any): Map<any, any>;
-declare const _default: any;
-export default _default;
-export type Size = any;
-export type Position = any;
-export type Screen = any;
+declare function handleDragLeave(): void;
+/**
+ * Called from Go during file drag to update hover state on Linux/macOS.
+ * @param x - X coordinate in CSS pixels
+ * @param y - Y coordinate in CSS pixels
+ */
+declare function handleDragOver(x: number, y: number): void;
+export { handleDragEnter, handleDragLeave, handleDragOver };
+/**
+ * A record describing the position of a window.
+ */
+interface Position {
+    /** The horizontal position of the window. */
+    x: number;
+    /** The vertical position of the window. */
+    y: number;
+}
+/**
+ * A record describing the size of a window.
+ */
+interface Size {
+    /** The width of the window. */
+    width: number;
+    /** The height of the window. */
+    height: number;
+}
+declare const callerSym: unique symbol;
+declare class Window {
+    private [callerSym];
+    /**
+     * Initialises a window object with the specified name.
+     *
+     * @private
+     * @param name - The name of the target window.
+     */
+    constructor(name?: string);
+    /**
+     * Gets the specified window.
+     *
+     * @param name - The name of the window to get.
+     * @returns The corresponding window object.
+     */
+    Get(name: string): Window;
+    /**
+     * Returns the absolute position of the window.
+     *
+     * @returns The current absolute position of the window.
+     */
+    Position(): Promise<Position>;
+    /**
+     * Centers the window on the screen.
+     */
+    Center(): Promise<void>;
+    /**
+     * Closes the window.
+     */
+    Close(): Promise<void>;
+    /**
+     * Disables min/max size constraints.
+     */
+    DisableSizeConstraints(): Promise<void>;
+    /**
+     * Enables min/max size constraints.
+     */
+    EnableSizeConstraints(): Promise<void>;
+    /**
+     * Focuses the window.
+     */
+    Focus(): Promise<void>;
+    /**
+     * Forces the window to reload the page assets.
+     */
+    ForceReload(): Promise<void>;
+    /**
+     * Switches the window to fullscreen mode.
+     */
+    Fullscreen(): Promise<void>;
+    /**
+     * Returns the screen that the window is on.
+     *
+     * @returns The screen the window is currently on.
+     */
+    GetScreen(): Promise<Screen>;
+    /**
+     * Returns the current zoom level of the window.
+     *
+     * @returns The current zoom level.
+     */
+    GetZoom(): Promise<number>;
+    /**
+     * Returns the height of the window.
+     *
+     * @returns The current height of the window.
+     */
+    Height(): Promise<number>;
+    /**
+     * Hides the window.
+     */
+    Hide(): Promise<void>;
+    /**
+     * Returns true if the window is focused.
+     *
+     * @returns Whether the window is currently focused.
+     */
+    IsFocused(): Promise<boolean>;
+    /**
+     * Returns true if the window is fullscreen.
+     *
+     * @returns Whether the window is currently fullscreen.
+     */
+    IsFullscreen(): Promise<boolean>;
+    /**
+     * Returns true if the window is maximised.
+     *
+     * @returns Whether the window is currently maximised.
+     */
+    IsMaximised(): Promise<boolean>;
+    /**
+     * Returns true if the window is minimised.
+     *
+     * @returns Whether the window is currently minimised.
+     */
+    IsMinimised(): Promise<boolean>;
+    /**
+     * Maximises the window.
+     */
+    Maximise(): Promise<void>;
+    /**
+     * Minimises the window.
+     */
+    Minimise(): Promise<void>;
+    /**
+     * Returns the name of the window.
+     *
+     * @returns The name of the window.
+     */
+    Name(): Promise<string>;
+    /**
+     * Opens the development tools pane.
+     */
+    OpenDevTools(): Promise<void>;
+    /**
+     * Returns the relative position of the window to the screen.
+     *
+     * @returns The current relative position of the window.
+     */
+    RelativePosition(): Promise<Position>;
+    /**
+     * Reloads the page assets.
+     */
+    Reload(): Promise<void>;
+    /**
+     * Returns true if the window is resizable.
+     *
+     * @returns Whether the window is currently resizable.
+     */
+    Resizable(): Promise<boolean>;
+    /**
+     * Restores the window to its previous state if it was previously minimised, maximised or fullscreen.
+     */
+    Restore(): Promise<void>;
+    /**
+     * Sets the absolute position of the window.
+     *
+     * @param x - The desired horizontal absolute position of the window.
+     * @param y - The desired vertical absolute position of the window.
+     */
+    SetPosition(x: number, y: number): Promise<void>;
+    /**
+     * Sets the window to be always on top.
+     *
+     * @param alwaysOnTop - Whether the window should stay on top.
+     */
+    SetAlwaysOnTop(alwaysOnTop: boolean): Promise<void>;
+    /**
+     * Sets the background colour of the window.
+     *
+     * @param r - The desired red component of the window background.
+     * @param g - The desired green component of the window background.
+     * @param b - The desired blue component of the window background.
+     * @param a - The desired alpha component of the window background.
+     */
+    SetBackgroundColour(r: number, g: number, b: number, a: number): Promise<void>;
+    /**
+     * Removes the window frame and title bar.
+     *
+     * @param frameless - Whether the window should be frameless.
+     */
+    SetFrameless(frameless: boolean): Promise<void>;
+    /**
+     * Disables the system fullscreen button.
+     *
+     * @param enabled - Whether the fullscreen button should be enabled.
+     */
+    SetFullscreenButtonEnabled(enabled: boolean): Promise<void>;
+    /**
+     * Sets the maximum size of the window.
+     *
+     * @param width - The desired maximum width of the window.
+     * @param height - The desired maximum height of the window.
+     */
+    SetMaxSize(width: number, height: number): Promise<void>;
+    /**
+     * Sets the minimum size of the window.
+     *
+     * @param width - The desired minimum width of the window.
+     * @param height - The desired minimum height of the window.
+     */
+    SetMinSize(width: number, height: number): Promise<void>;
+    /**
+     * Sets the relative position of the window to the screen.
+     *
+     * @param x - The desired horizontal relative position of the window.
+     * @param y - The desired vertical relative position of the window.
+     */
+    SetRelativePosition(x: number, y: number): Promise<void>;
+    /**
+     * Sets whether the window is resizable.
+     *
+     * @param resizable - Whether the window should be resizable.
+     */
+    SetResizable(resizable: boolean): Promise<void>;
+    /**
+     * Sets the size of the window.
+     *
+     * @param width - The desired width of the window.
+     * @param height - The desired height of the window.
+     */
+    SetSize(width: number, height: number): Promise<void>;
+    /**
+     * Sets the title of the window.
+     *
+     * @param title - The desired title of the window.
+     */
+    SetTitle(title: string): Promise<void>;
+    /**
+     * Sets the zoom level of the window.
+     *
+     * @param zoom - The desired zoom level.
+     */
+    SetZoom(zoom: number): Promise<void>;
+    /**
+     * Shows the window.
+     */
+    Show(): Promise<void>;
+    /**
+     * Returns the size of the window.
+     *
+     * @returns The current size of the window.
+     */
+    Size(): Promise<Size>;
+    /**
+     * Toggles the window between fullscreen and normal.
+     */
+    ToggleFullscreen(): Promise<void>;
+    /**
+     * Toggles the window between maximised and normal.
+     */
+    ToggleMaximise(): Promise<void>;
+    /**
+     * Toggles the window between frameless and normal.
+     */
+    ToggleFrameless(): Promise<void>;
+    /**
+     * Un-fullscreens the window.
+     */
+    UnFullscreen(): Promise<void>;
+    /**
+     * Un-maximises the window.
+     */
+    UnMaximise(): Promise<void>;
+    /**
+     * Un-minimises the window.
+     */
+    UnMinimise(): Promise<void>;
+    /**
+     * Returns the width of the window.
+     *
+     * @returns The current width of the window.
+     */
+    Width(): Promise<number>;
+    /**
+     * Zooms the window.
+     */
+    Zoom(): Promise<void>;
+    /**
+     * Increases the zoom level of the webview content.
+     */
+    ZoomIn(): Promise<void>;
+    /**
+     * Decreases the zoom level of the webview content.
+     */
+    ZoomOut(): Promise<void>;
+    /**
+     * Resets the zoom level of the webview content.
+     */
+    ZoomReset(): Promise<void>;
+    /**
+     * Handles file drops originating from platform-specific code (e.g., macOS/Linux native drag-and-drop).
+     * Gathers information about the drop target element and sends it back to the Go backend.
+     *
+     * @param filenames - An array of file paths (strings) that were dropped.
+     * @param x - The x-coordinate of the drop event (CSS pixels).
+     * @param y - The y-coordinate of the drop event (CSS pixels).
+     */
+    HandlePlatformFileDrop(filenames: string[], x: number, y: number): void;
+    /**
+     * Moves the window to the center of the specified screen's work area.
+     *
+     * @param screenID - The ID of the target screen.
+     */
+    SetScreen(screenID: string): Promise<void>;
+    SnapAssist(): Promise<void>;
+    /**
+     * Opens the print dialog for the window.
+     */
+    Print(): Promise<void>;
+}
+/**
+ * The window within which the script is running.
+ */
+declare const thisWindow: Window;
+export default thisWindow;

package/types/wml.d.ts

@@ -1,6 +1,8 @@
+/**
+ * Schedules an automatic reload of WML to be performed as soon as the document is fully loaded.
+ */
+export declare function Enable(): void;
 /**
  * Reloads the WML page by adding necessary event listeners and browser listeners.
- *
- * @return {void}
  */
-export function reloadWML(): void;
+export declare function Reload(): void;