@wailsio/runtime 3.0.0-alpha.7 → 3.0.0-alpha.72

package/types/window.d.ts

@@ -0,0 +1,306 @@
+import type { Screen } from "./screens.js";
+/**
+ * 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 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.
+     * @param y - The y-coordinate of the drop event.
+     */
+    HandlePlatformFileDrop(filenames: string[], x: number, y: number): void;
+    SnapAssist(): Promise<void>;
+}
+/**
+ * The window within which the script is running.
+ */
+declare const thisWindow: Window;
+export default thisWindow;

package/types/wml.d.ts

@@ -0,0 +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.
+ */
+export declare function Reload(): void;

package/browser.js

@@ -1,24 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-
-const call = newRuntimeCallerWithID(objectNames.Browser, '');
-const BrowserOpenURL = 0;
-
-/**
- * Open a browser window to the given URL
- * @param {string} url - The URL to open
- * @returns {Promise<string>}
- */
-export function OpenURL(url) {
-    return call(BrowserOpenURL, {url});
-}

package/calls.js

@@ -1,123 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-import { newRuntimeCallerWithID, objectNames } from "./runtime";
-import { nanoid } from 'nanoid/non-secure';
-
-const CallBinding = 0;
-const call = newRuntimeCallerWithID(objectNames.Call, '');
-let callResponses = new Map();
-
-window._wails = window._wails || {};
-window._wails.callCallback = resultHandler;
-window._wails.callErrorCallback = errorHandler;
-
-function generateID() {
-    let result;
-    do {
-        result = nanoid();
-    } while (callResponses.has(result));
-    return result;
-}
-
-export function resultHandler(id, data, isJSON) {
-    const promiseHandler = getAndDeleteResponse(id);
-    if (promiseHandler) {
-        promiseHandler.resolve(isJSON ? JSON.parse(data) : data);
-    }
-}
-
-export function errorHandler(id, message) {
-    const promiseHandler = getAndDeleteResponse(id);
-    if (promiseHandler) {
-        promiseHandler.reject(message);
-    }
-}
-
-function getAndDeleteResponse(id) {
-    const response = callResponses.get(id);
-    callResponses.delete(id);
-    return response;
-}
-
-function callBinding(type, options = {}) {
-    return new Promise((resolve, reject) => {
-        const id = generateID();
-        options["call-id"] = id;
-        callResponses.set(id, { resolve, reject });
-        call(type, options).catch((error) => {
-            reject(error);
-            callResponses.delete(id);
-        });
-    });
-}
-
-/**
- * Call method.
- *
- * @param {Object} options - The options for the method.
- * @returns {Object} - The result of the call.
- */
-export function Call(options) {
-    return callBinding(CallBinding, options);
-}
-
-/**
- * Executes a method by name.
- *
- * @param {string} name - The name of the method in the format 'package.struct.method'.
- * @param {...*} args - The arguments to pass to the method.
- * @throws {Error} If the name is not a string or is not in the correct format.
- * @returns {*} The result of the method execution.
- */
-export function ByName(name, ...args) {
-    if (typeof name !== "string" || name.split(".").length !== 3) {
-        throw new Error("CallByName requires a string in the format 'package.struct.method'");
-    }
-    let [packageName, structName, methodName] = name.split(".");
-    return callBinding(CallBinding, {
-        packageName,
-        structName,
-        methodName,
-        args
-    });
-}
-
-/**
- * Calls a method by its ID with the specified arguments.
- *
- * @param {string} methodID - The ID of the method to call.
- * @param {...*} args - The arguments to pass to the method.
- * @return {*} - The result of the method call.
- */
-export function ByID(methodID, ...args) {
-    return callBinding(CallBinding, {
-        methodID,
-        args
-    });
-}
-
-/**
- * Calls a method on a plugin.
- *
- * @param {string} pluginName - The name of the plugin.
- * @param {string} methodName - The name of the method to call.
- * @param {...*} args - The arguments to pass to the method.
- * @returns {*} - The result of the method call.
- */
-export function Plugin(pluginName, methodName, ...args) {
-    return callBinding(CallBinding, {
-        packageName: "wails-plugins",
-        structName: pluginName,
-        methodName,
-        args
-    });
-}

package/clipboard.js

@@ -1,35 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-
-const call = newRuntimeCallerWithID(objectNames.Clipboard, '');
-const ClipboardSetText = 0;
-const ClipboardText = 1;
-
-/**
- * Sets the text to the Clipboard.
- *
- * @param {string} text - The text to be set to the Clipboard.
- * @return {Promise} - A Promise that resolves when the operation is successful.
- */
-export function SetText(text) {
-    return call(ClipboardSetText, {text});
-}
-
-/**
- * Get the Clipboard text
- * @returns {Promise<string>} A promise that resolves with the text from the Clipboard.
- */
-export function Text() {
-    return call(ClipboardText);
-}

package/contextmenu.js

@@ -1,98 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-import {IsDebug} from "./system";
-
-const call = newRuntimeCallerWithID(objectNames.ContextMenu, '');
-const ContextMenuOpen = 0;
-
-function openContextMenu(id, x, y, data) {
-    void call(ContextMenuOpen, {id, x, y, data});
-}
-
-export function setupContextMenus() {
-    window.addEventListener('contextmenu', contextMenuHandler);
-}
-
-function contextMenuHandler(event) {
-    // Check for custom context menu
-    let element = event.target;
-    let customContextMenu = window.getComputedStyle(element).getPropertyValue("--custom-contextmenu");
-    customContextMenu = customContextMenu ? customContextMenu.trim() : "";
-    if (customContextMenu) {
-        event.preventDefault();
-        let customContextMenuData = window.getComputedStyle(element).getPropertyValue("--custom-contextmenu-data");
-        openContextMenu(customContextMenu, event.clientX, event.clientY, customContextMenuData);
-        return
-    }
-
-    processDefaultContextMenu(event);
-}
-
-
-/*
---default-contextmenu: auto; (default) will show the default context menu if contentEditable is true OR text has been selected OR element is input or textarea
---default-contextmenu: show; will always show the default context menu
---default-contextmenu: hide; will always hide the default context menu
-
-This rule is inherited like normal CSS rules, so nesting works as expected
-*/
-function processDefaultContextMenu(event) {
-
-    // Debug builds always show the menu
-    if (IsDebug()) {
-        return;
-    }
-
-    // Process default context menu
-    const element = event.target;
-    const computedStyle = window.getComputedStyle(element);
-    const defaultContextMenuAction = computedStyle.getPropertyValue("--default-contextmenu").trim();
-    switch (defaultContextMenuAction) {
-        case "show":
-            return;
-        case "hide":
-            event.preventDefault();
-            return;
-        default:
-            // Check if contentEditable is true
-            if (element.isContentEditable) {
-                return;
-            }
-
-            // Check if text has been selected
-            const selection = window.getSelection();
-            const hasSelection = (selection.toString().length > 0)
-            if (hasSelection) {
-                for (let i = 0; i < selection.rangeCount; i++) {
-                    const range = selection.getRangeAt(i);
-                    const rects = range.getClientRects();
-                    for (let j = 0; j < rects.length; j++) {
-                        const rect = rects[j];
-                        if (document.elementFromPoint(rect.left, rect.top) === element) {
-                            return;
-                        }
-                    }
-                }
-            }
-            // Check if tagname is input or textarea
-            if (element.tagName === "INPUT" || element.tagName === "TEXTAREA") {
-                if (hasSelection || (!element.readOnly && !element.disabled)) {
-                    return;
-                }
-            }
-
-            // hide default context menu
-            event.preventDefault();
-    }
-}