@wailsio/runtime 3.0.0-alpha.5 → 3.0.0-alpha.55

package/types/system.d.ts

@@ -0,0 +1,112 @@
+export function invoke(msg: any): any;
+/**
+ * @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.
+ */
+export 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} OSInfo
+ * @property {string} Branding - The branding of the OS.
+ * @property {string} ID - The ID of the OS.
+ * @property {string} Name - The name of the OS.
+ * @property {string} Version - The version of the OS.
+ */
+/**
+ * @typedef {Object} EnvironmentInfo
+ * @property {string} Arch - The architecture of the system.
+ * @property {boolean} Debug - True if the application is running in debug mode, otherwise false.
+ * @property {string} OS - The operating system in use.
+ * @property {OSInfo} OSInfo - Details of the operating system.
+ * @property {Object} PlatformInfo - Additional platform information.
+ */
+/**
+ * @function
+ * Retrieves environment details.
+ * @returns {Promise<EnvironmentInfo>} - A promise that resolves to an object containing OS and system architecture.
+ */
+export function Environment(): Promise<EnvironmentInfo>;
+/**
+ * Checks if the current operating system is Windows.
+ *
+ * @return {boolean} True if the operating system is Windows, otherwise false.
+ */
+export function IsWindows(): boolean;
+/**
+ * Checks if the current operating system is Linux.
+ *
+ * @returns {boolean} Returns true if the current operating system is Linux, false otherwise.
+ */
+export function IsLinux(): boolean;
+/**
+ * Checks if the current environment is a macOS operating system.
+ *
+ * @returns {boolean} True if the environment is macOS, false otherwise.
+ */
+export function IsMac(): boolean;
+/**
+ * Checks if the current environment architecture is AMD64.
+ * @returns {boolean} True if the current environment architecture is AMD64, false otherwise.
+ */
+export function IsAMD64(): boolean;
+/**
+ * Checks if the current architecture is ARM.
+ *
+ * @returns {boolean} True if the current architecture is ARM, false otherwise.
+ */
+export function IsARM(): boolean;
+/**
+ * Checks if the current environment is ARM64 architecture.
+ *
+ * @returns {boolean} - Returns true if the environment is ARM64 architecture, otherwise returns false.
+ */
+export function IsARM64(): boolean;
+export function IsDebug(): boolean;
+export type 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 type 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: any;
+};

package/types/utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Logs a message to the console with custom formatting.
+ * @param {string} message - The message to be logged.
+ * @return {void}
+ */
+export function debugLog(message: string): void;
+/**
+ * Checks whether the browser supports removing listeners by triggering an AbortSignal
+ * (see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#signal)
+ *
+ * @return {boolean}
+ */
+export function canAbortListeners(): boolean;
+export function whenReady(callback: any): void;

package/types/window.d.ts

@@ -0,0 +1,407 @@
+export class Window {
+    /**
+     * Initialises a window object with the specified name.
+     *
+     * @private
+     * @param {string} name - The name of the target window.
+     */
+    private constructor();
+    /**
+     * Gets the specified window.
+     *
+     * @public
+     * @param {string} name - The name of the window to get.
+     * @return {Window} - The corresponding window object.
+     */
+    public Get(name: string): Window;
+    /**
+     * Returns the absolute position of the window.
+     *
+     * @public
+     * @return {Promise<Position>} - The current absolute position of the window.
+     */
+    public Position(): Promise<Position>;
+    /**
+     * Centers the window on the screen.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Center(): Promise<void>;
+    /**
+     * Closes the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Close(): Promise<void>;
+    /**
+     * Disables min/max size constraints.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public DisableSizeConstraints(): Promise<void>;
+    /**
+     * Enables min/max size constraints.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public EnableSizeConstraints(): Promise<void>;
+    /**
+     * Focuses the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Focus(): Promise<void>;
+    /**
+     * Forces the window to reload the page assets.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public ForceReload(): Promise<void>;
+    /**
+     * Doc.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Fullscreen(): Promise<void>;
+    /**
+     * Returns the screen that the window is on.
+     *
+     * @public
+     * @return {Promise<Screen>} - The screen the window is currently on
+     */
+    public GetScreen(): Promise<Screen>;
+    /**
+     * Returns the current zoom level of the window.
+     *
+     * @public
+     * @return {Promise<number>} - The current zoom level
+     */
+    public GetZoom(): Promise<number>;
+    /**
+     * Returns the height of the window.
+     *
+     * @public
+     * @return {Promise<number>} - The current height of the window
+     */
+    public Height(): Promise<number>;
+    /**
+     * Hides the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Hide(): Promise<void>;
+    /**
+     * Returns true if the window is focused.
+     *
+     * @public
+     * @return {Promise<boolean>} - Whether the window is currently focused
+     */
+    public IsFocused(): Promise<boolean>;
+    /**
+     * Returns true if the window is fullscreen.
+     *
+     * @public
+     * @return {Promise<boolean>} - Whether the window is currently fullscreen
+     */
+    public IsFullscreen(): Promise<boolean>;
+    /**
+     * Returns true if the window is maximised.
+     *
+     * @public
+     * @return {Promise<boolean>} - Whether the window is currently maximised
+     */
+    public IsMaximised(): Promise<boolean>;
+    /**
+     * Returns true if the window is minimised.
+     *
+     * @public
+     * @return {Promise<boolean>} - Whether the window is currently minimised
+     */
+    public IsMinimised(): Promise<boolean>;
+    /**
+     * Maximises the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Maximise(): Promise<void>;
+    /**
+     * Minimises the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Minimise(): Promise<void>;
+    /**
+     * Returns the name of the window.
+     *
+     * @public
+     * @return {Promise<string>} - The name of the window
+     */
+    public Name(): Promise<string>;
+    /**
+     * Opens the development tools pane.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public OpenDevTools(): Promise<void>;
+    /**
+     * Returns the relative position of the window to the screen.
+     *
+     * @public
+     * @return {Promise<Position>} - The current relative position of the window
+     */
+    public RelativePosition(): Promise<Position>;
+    /**
+     * Reloads the page assets.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Reload(): Promise<void>;
+    /**
+     * Returns true if the window is resizable.
+     *
+     * @public
+     * @return {Promise<boolean>} - Whether the window is currently resizable
+     */
+    public Resizable(): Promise<boolean>;
+    /**
+     * Restores the window to its previous state if it was previously minimised, maximised or fullscreen.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Restore(): Promise<void>;
+    /**
+     * Sets the absolute position of the window.
+     *
+     * @public
+     * @param {number} x - The desired horizontal absolute position of the window
+     * @param {number} y - The desired vertical absolute position of the window
+     * @return {Promise<void>}
+     */
+    public SetPosition(x: number, y: number): Promise<void>;
+    /**
+     * Sets the window to be always on top.
+     *
+     * @public
+     * @param {boolean} alwaysOnTop - Whether the window should stay on top
+     * @return {Promise<void>}
+     */
+    public SetAlwaysOnTop(alwaysOnTop: boolean): Promise<void>;
+    /**
+     * Sets the background colour of the window.
+     *
+     * @public
+     * @param {number} r - The desired red component of the window background
+     * @param {number} g - The desired green component of the window background
+     * @param {number} b - The desired blue component of the window background
+     * @param {number} a - The desired alpha component of the window background
+     * @return {Promise<void>}
+     */
+    public SetBackgroundColour(r: number, g: number, b: number, a: number): Promise<void>;
+    /**
+     * Removes the window frame and title bar.
+     *
+     * @public
+     * @param {boolean} frameless - Whether the window should be frameless
+     * @return {Promise<void>}
+     */
+    public SetFrameless(frameless: boolean): Promise<void>;
+    /**
+     * Disables the system fullscreen button.
+     *
+     * @public
+     * @param {boolean} enabled - Whether the fullscreen button should be enabled
+     * @return {Promise<void>}
+     */
+    public SetFullscreenButtonEnabled(enabled: boolean): Promise<void>;
+    /**
+     * Sets the maximum size of the window.
+     *
+     * @public
+     * @param {number} width - The desired maximum width of the window
+     * @param {number} height - The desired maximum height of the window
+     * @return {Promise<void>}
+     */
+    public SetMaxSize(width: number, height: number): Promise<void>;
+    /**
+     * Sets the minimum size of the window.
+     *
+     * @public
+     * @param {number} width - The desired minimum width of the window
+     * @param {number} height - The desired minimum height of the window
+     * @return {Promise<void>}
+     */
+    public SetMinSize(width: number, height: number): Promise<void>;
+    /**
+     * Sets the relative position of the window to the screen.
+     *
+     * @public
+     * @param {number} x - The desired horizontal relative position of the window
+     * @param {number} y - The desired vertical relative position of the window
+     * @return {Promise<void>}
+     */
+    public SetRelativePosition(x: number, y: number): Promise<void>;
+    /**
+     * Sets whether the window is resizable.
+     *
+     * @public
+     * @param {boolean} resizable - Whether the window should be resizable
+     * @return {Promise<void>}
+     */
+    public SetResizable(resizable: boolean): Promise<void>;
+    /**
+     * Sets the size of the window.
+     *
+     * @public
+     * @param {number} width - The desired width of the window
+     * @param {number} height - The desired height of the window
+     * @return {Promise<void>}
+     */
+    public SetSize(width: number, height: number): Promise<void>;
+    /**
+     * Sets the title of the window.
+     *
+     * @public
+     * @param {string} title - The desired title of the window
+     * @return {Promise<void>}
+     */
+    public SetTitle(title: string): Promise<void>;
+    /**
+     * Sets the zoom level of the window.
+     *
+     * @public
+     * @param {number} zoom - The desired zoom level
+     * @return {Promise<void>}
+     */
+    public SetZoom(zoom: number): Promise<void>;
+    /**
+     * Shows the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Show(): Promise<void>;
+    /**
+     * Returns the size of the window.
+     *
+     * @public
+     * @return {Promise<Size>} - The current size of the window
+     */
+    public Size(): Promise<Size>;
+    /**
+     * Toggles the window between fullscreen and normal.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public ToggleFullscreen(): Promise<void>;
+    /**
+     * Toggles the window between maximised and normal.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public ToggleMaximise(): Promise<void>;
+    /**
+     * Un-fullscreens the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public UnFullscreen(): Promise<void>;
+    /**
+     * Un-maximises the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public UnMaximise(): Promise<void>;
+    /**
+     * Un-minimises the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public UnMinimise(): Promise<void>;
+    /**
+     * Returns the width of the window.
+     *
+     * @public
+     * @return {Promise<number>} - The current width of the window
+     */
+    public Width(): Promise<number>;
+    /**
+     * Zooms the window.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public Zoom(): Promise<void>;
+    /**
+     * Increases the zoom level of the webview content.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public ZoomIn(): Promise<void>;
+    /**
+     * Decreases the zoom level of the webview content.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public ZoomOut(): Promise<void>;
+    /**
+     * Resets the zoom level of the webview content.
+     *
+     * @public
+     * @return {Promise<void>}
+     */
+    public ZoomReset(): Promise<void>;
+}
+export default thisWindow;
+export type Screen = import("./screens").Screen;
+/**
+ * A record describing the position of a window.
+ */
+export type 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.
+ */
+export type Size = {
+    /**
+     * - The width of the window
+     */
+    width: number;
+    /**
+     * - The height of the window
+     */
+    height: number;
+};
+/**
+ * The window within which the script is running.
+ *
+ * @type {Window}
+ */
+declare const thisWindow: Window;

package/types/wml.d.ts

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

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
-    });
-}