@wailsio/runtime 3.0.0-alpha.13 → 3.0.0-alpha.15

package/types/event_types.d.ts

@@ -0,0 +1,181 @@
+
+export declare const EventTypes: {
+	Windows: {
+		SystemThemeChanged: string,
+		APMPowerStatusChange: string,
+		APMSuspend: string,
+		APMResumeAutomatic: string,
+		APMResumeSuspend: string,
+		APMPowerSettingChange: string,
+		ApplicationStarted: string,
+		WebViewNavigationCompleted: string,
+		WindowInactive: string,
+		WindowActive: string,
+		WindowClickActive: string,
+		WindowMaximise: string,
+		WindowUnMaximise: string,
+		WindowFullscreen: string,
+		WindowUnFullscreen: string,
+		WindowRestore: string,
+		WindowMinimise: string,
+		WindowUnMinimise: string,
+		WindowClose: string,
+		WindowSetFocus: string,
+		WindowKillFocus: string,
+		WindowDragDrop: string,
+		WindowDragEnter: string,
+		WindowDragLeave: string,
+		WindowDragOver: string,
+	},
+	Mac: {
+		ApplicationDidBecomeActive: string,
+		ApplicationDidChangeBackingProperties: string,
+		ApplicationDidChangeEffectiveAppearance: string,
+		ApplicationDidChangeIcon: string,
+		ApplicationDidChangeOcclusionState: string,
+		ApplicationDidChangeScreenParameters: string,
+		ApplicationDidChangeStatusBarFrame: string,
+		ApplicationDidChangeStatusBarOrientation: string,
+		ApplicationDidFinishLaunching: string,
+		ApplicationDidHide: string,
+		ApplicationDidResignActiveNotification: string,
+		ApplicationDidUnhide: string,
+		ApplicationDidUpdate: string,
+		ApplicationWillBecomeActive: string,
+		ApplicationWillFinishLaunching: string,
+		ApplicationWillHide: string,
+		ApplicationWillResignActive: string,
+		ApplicationWillTerminate: string,
+		ApplicationWillUnhide: string,
+		ApplicationWillUpdate: string,
+		ApplicationDidChangeTheme: string,
+		ApplicationShouldHandleReopen: string,
+		WindowDidBecomeKey: string,
+		WindowDidBecomeMain: string,
+		WindowDidBeginSheet: string,
+		WindowDidChangeAlpha: string,
+		WindowDidChangeBackingLocation: string,
+		WindowDidChangeBackingProperties: string,
+		WindowDidChangeCollectionBehavior: string,
+		WindowDidChangeEffectiveAppearance: string,
+		WindowDidChangeOcclusionState: string,
+		WindowDidChangeOrderingMode: string,
+		WindowDidChangeScreen: string,
+		WindowDidChangeScreenParameters: string,
+		WindowDidChangeScreenProfile: string,
+		WindowDidChangeScreenSpace: string,
+		WindowDidChangeScreenSpaceProperties: string,
+		WindowDidChangeSharingType: string,
+		WindowDidChangeSpace: string,
+		WindowDidChangeSpaceOrderingMode: string,
+		WindowDidChangeTitle: string,
+		WindowDidChangeToolbar: string,
+		WindowDidChangeVisibility: string,
+		WindowDidDeminiaturize: string,
+		WindowDidEndSheet: string,
+		WindowDidEnterFullScreen: string,
+		WindowDidEnterVersionBrowser: string,
+		WindowDidExitFullScreen: string,
+		WindowDidExitVersionBrowser: string,
+		WindowDidExpose: string,
+		WindowDidFocus: string,
+		WindowDidMiniaturize: string,
+		WindowDidMove: string,
+		WindowDidOrderOffScreen: string,
+		WindowDidOrderOnScreen: string,
+		WindowDidResignKey: string,
+		WindowDidResignMain: string,
+		WindowDidResize: string,
+		WindowDidUpdate: string,
+		WindowDidUpdateAlpha: string,
+		WindowDidUpdateCollectionBehavior: string,
+		WindowDidUpdateCollectionProperties: string,
+		WindowDidUpdateShadow: string,
+		WindowDidUpdateTitle: string,
+		WindowDidUpdateToolbar: string,
+		WindowDidUpdateVisibility: string,
+		WindowShouldClose: string,
+		WindowWillBecomeKey: string,
+		WindowWillBecomeMain: string,
+		WindowWillBeginSheet: string,
+		WindowWillChangeOrderingMode: string,
+		WindowWillClose: string,
+		WindowWillDeminiaturize: string,
+		WindowWillEnterFullScreen: string,
+		WindowWillEnterVersionBrowser: string,
+		WindowWillExitFullScreen: string,
+		WindowWillExitVersionBrowser: string,
+		WindowWillFocus: string,
+		WindowWillMiniaturize: string,
+		WindowWillMove: string,
+		WindowWillOrderOffScreen: string,
+		WindowWillOrderOnScreen: string,
+		WindowWillResignMain: string,
+		WindowWillResize: string,
+		WindowWillUnfocus: string,
+		WindowWillUpdate: string,
+		WindowWillUpdateAlpha: string,
+		WindowWillUpdateCollectionBehavior: string,
+		WindowWillUpdateCollectionProperties: string,
+		WindowWillUpdateShadow: string,
+		WindowWillUpdateTitle: string,
+		WindowWillUpdateToolbar: string,
+		WindowWillUpdateVisibility: string,
+		WindowWillUseStandardFrame: string,
+		MenuWillOpen: string,
+		MenuDidOpen: string,
+		MenuDidClose: string,
+		MenuWillSendAction: string,
+		MenuDidSendAction: string,
+		MenuWillHighlightItem: string,
+		MenuDidHighlightItem: string,
+		MenuWillDisplayItem: string,
+		MenuDidDisplayItem: string,
+		MenuWillAddItem: string,
+		MenuDidAddItem: string,
+		MenuWillRemoveItem: string,
+		MenuDidRemoveItem: string,
+		MenuWillBeginTracking: string,
+		MenuDidBeginTracking: string,
+		MenuWillEndTracking: string,
+		MenuDidEndTracking: string,
+		MenuWillUpdate: string,
+		MenuDidUpdate: string,
+		MenuWillPopUp: string,
+		MenuDidPopUp: string,
+		MenuWillSendActionToItem: string,
+		MenuDidSendActionToItem: string,
+		WebViewDidStartProvisionalNavigation: string,
+		WebViewDidReceiveServerRedirectForProvisionalNavigation: string,
+		WebViewDidFinishNavigation: string,
+		WebViewDidCommitNavigation: string,
+		WindowFileDraggingEntered: string,
+		WindowFileDraggingPerformed: string,
+		WindowFileDraggingExited: string,
+	},
+	Linux: {
+		SystemThemeChanged: string,
+	},
+	Common: {
+		ApplicationStarted: string,
+		WindowMaximise: string,
+		WindowUnMaximise: string,
+		WindowFullscreen: string,
+		WindowUnFullscreen: string,
+		WindowRestore: string,
+		WindowMinimise: string,
+		WindowUnMinimise: string,
+		WindowClosing: string,
+		WindowZoom: string,
+		WindowZoomIn: string,
+		WindowZoomOut: string,
+		WindowZoomReset: string,
+		WindowFocus: string,
+		WindowLostFocus: string,
+		WindowShow: string,
+		WindowHide: string,
+		WindowDPIChanged: string,
+		WindowFilesDropped: string,
+		ThemeChanged: string,
+	},
+};

package/types/events.d.ts

@@ -1,4 +1,14 @@
-export function dispatchWailsEvent(event: any): void;
+/**
+ * Sets up event callbacks for Wails.
+ *
+ * @function setupEventCallbacks
+ *
+ * @description This method is responsible for setting up event callbacks for Wails. It checks if the global object `_wails` exists on the `window` object, and if not, initializes it
+ *. It then assigns the `dispatchWailsEvent` function as a property on the `_wails` object.
+ *
+ * @returns {undefined} Returns nothing.
+ */
+export function setupEventCallbacks(): undefined;
 /**
  * Register a callback function to be called multiple times for a specific event.
  *
@@ -21,9 +31,9 @@ export function On(eventName: string, callback: Function): Function;
  *
  * @param {string} eventName - The name of the event.
  * @param {function} callback - The function to be executed when the event occurs.
- * @return {void@return {function} - A function that, when called, will unregister the callback from the event.
+ * @return {function} - A function that, when called, will unregister the callback from the event.
  */
-export function Once(eventName: string, callback: Function): void;
+export function Once(eventName: string, callback: Function): Function;
 /**
  * Removes event listeners for the specified event names.
  *
@@ -46,6 +56,199 @@ export function OffAll(): void;
  * @returns {any} - The result of the emitted event.
  */
 export function Emit(event: WailsEvent): any;
+export const Types: {
+    Windows: {
+        SystemThemeChanged: string;
+        APMPowerStatusChange: string;
+        APMSuspend: string;
+        APMResumeAutomatic: string;
+        APMResumeSuspend: string;
+        APMPowerSettingChange: string;
+        ApplicationStarted: string;
+        WebViewNavigationCompleted: string;
+        WindowInactive: string;
+        WindowActive: string;
+        WindowClickActive: string;
+        WindowMaximise: string;
+        WindowUnMaximise: string;
+        WindowFullscreen: string;
+        WindowUnFullscreen: string;
+        WindowRestore: string;
+        WindowMinimise: string;
+        WindowUnMinimise: string;
+        WindowClose: string;
+        WindowSetFocus: string;
+        WindowKillFocus: string;
+        WindowDragDrop: string;
+        WindowDragEnter: string;
+        WindowDragLeave: string;
+        WindowDragOver: string;
+    };
+    Mac: {
+        ApplicationDidBecomeActive: string;
+        ApplicationDidChangeBackingProperties: string;
+        ApplicationDidChangeEffectiveAppearance: string;
+        ApplicationDidChangeIcon: string;
+        ApplicationDidChangeOcclusionState: string;
+        ApplicationDidChangeScreenParameters: string;
+        ApplicationDidChangeStatusBarFrame: string;
+        ApplicationDidChangeStatusBarOrientation: string;
+        ApplicationDidFinishLaunching: string;
+        ApplicationDidHide: string;
+        ApplicationDidResignActiveNotification: string;
+        ApplicationDidUnhide: string;
+        ApplicationDidUpdate: string;
+        ApplicationWillBecomeActive: string;
+        ApplicationWillFinishLaunching: string;
+        ApplicationWillHide: string;
+        ApplicationWillResignActive: string;
+        ApplicationWillTerminate: string;
+        ApplicationWillUnhide: string;
+        ApplicationWillUpdate: string;
+        ApplicationDidChangeTheme: string;
+        ApplicationShouldHandleReopen: string;
+        WindowDidBecomeKey: string;
+        WindowDidBecomeMain: string;
+        WindowDidBeginSheet: string;
+        WindowDidChangeAlpha: string;
+        WindowDidChangeBackingLocation: string;
+        WindowDidChangeBackingProperties: string;
+        WindowDidChangeCollectionBehavior: string;
+        WindowDidChangeEffectiveAppearance: string;
+        WindowDidChangeOcclusionState: string;
+        WindowDidChangeOrderingMode: string;
+        WindowDidChangeScreen: string;
+        WindowDidChangeScreenParameters: string;
+        WindowDidChangeScreenProfile: string;
+        WindowDidChangeScreenSpace: string;
+        WindowDidChangeScreenSpaceProperties: string;
+        WindowDidChangeSharingType: string;
+        WindowDidChangeSpace: string;
+        WindowDidChangeSpaceOrderingMode: string;
+        /**
+         * Removes the specified listener from the event listeners collection.
+         * If all listeners for the event are removed, the event key is deleted from the collection.
+         *
+         * @param {Object} listener - The listener to be removed.
+         */
+        WindowDidChangeTitle: string;
+        WindowDidChangeToolbar: string;
+        WindowDidChangeVisibility: string;
+        WindowDidDeminiaturize: string;
+        WindowDidEndSheet: string;
+        WindowDidEnterFullScreen: string;
+        WindowDidEnterVersionBrowser: string;
+        WindowDidExitFullScreen: string;
+        WindowDidExitVersionBrowser: string;
+        /**
+         * Removes event listeners for the specified event names.
+         *
+         * @param {string} eventName - The name of the event to remove listeners for.
+         * @param {...string} additionalEventNames - Additional event names to remove listeners for.
+         * @return {undefined}
+         */
+        WindowDidExpose: string;
+        WindowDidFocus: string;
+        WindowDidMiniaturize: string;
+        WindowDidMove: string;
+        WindowDidOrderOffScreen: string;
+        WindowDidOrderOnScreen: string;
+        WindowDidResignKey: string;
+        WindowDidResignMain: string;
+        WindowDidResize: string;
+        WindowDidUpdate: string;
+        WindowDidUpdateAlpha: string;
+        WindowDidUpdateCollectionBehavior: string;
+        WindowDidUpdateCollectionProperties: string;
+        WindowDidUpdateShadow: string;
+        WindowDidUpdateTitle: string;
+        WindowDidUpdateToolbar: string;
+        WindowDidUpdateVisibility: string;
+        WindowShouldClose: string;
+        WindowWillBecomeKey: string;
+        WindowWillBecomeMain: string;
+        WindowWillBeginSheet: string;
+        WindowWillChangeOrderingMode: string;
+        WindowWillClose: string;
+        WindowWillDeminiaturize: string;
+        WindowWillEnterFullScreen: string;
+        WindowWillEnterVersionBrowser: string;
+        WindowWillExitFullScreen: string;
+        WindowWillExitVersionBrowser: string;
+        WindowWillFocus: string;
+        WindowWillMiniaturize: string;
+        WindowWillMove: string;
+        WindowWillOrderOffScreen: string;
+        WindowWillOrderOnScreen: string;
+        WindowWillResignMain: string;
+        WindowWillResize: string;
+        WindowWillUnfocus: string;
+        WindowWillUpdate: string;
+        WindowWillUpdateAlpha: string;
+        WindowWillUpdateCollectionBehavior: string;
+        WindowWillUpdateCollectionProperties: string;
+        WindowWillUpdateShadow: string;
+        WindowWillUpdateTitle: string;
+        WindowWillUpdateToolbar: string;
+        WindowWillUpdateVisibility: string;
+        WindowWillUseStandardFrame: string;
+        MenuWillOpen: string;
+        MenuDidOpen: string;
+        MenuDidClose: string;
+        MenuWillSendAction: string;
+        MenuDidSendAction: string;
+        MenuWillHighlightItem: string;
+        MenuDidHighlightItem: string;
+        MenuWillDisplayItem: string;
+        MenuDidDisplayItem: string;
+        MenuWillAddItem: string;
+        MenuDidAddItem: string;
+        MenuWillRemoveItem: string;
+        MenuDidRemoveItem: string;
+        MenuWillBeginTracking: string;
+        MenuDidBeginTracking: string;
+        MenuWillEndTracking: string;
+        MenuDidEndTracking: string;
+        MenuWillUpdate: string;
+        MenuDidUpdate: string;
+        MenuWillPopUp: string;
+        MenuDidPopUp: string;
+        MenuWillSendActionToItem: string;
+        MenuDidSendActionToItem: string;
+        WebViewDidStartProvisionalNavigation: string;
+        WebViewDidReceiveServerRedirectForProvisionalNavigation: string;
+        WebViewDidFinishNavigation: string;
+        WebViewDidCommitNavigation: string;
+        WindowFileDraggingEntered: string;
+        WindowFileDraggingPerformed: string;
+        WindowFileDraggingExited: string;
+    };
+    Linux: {
+        SystemThemeChanged: string;
+    };
+    Common: {
+        ApplicationStarted: string;
+        WindowMaximise: string;
+        WindowUnMaximise: string;
+        WindowFullscreen: string;
+        WindowUnFullscreen: string;
+        WindowRestore: string;
+        WindowMinimise: string;
+        WindowUnMinimise: string;
+        WindowClosing: string;
+        WindowZoom: string;
+        WindowZoomIn: string;
+        WindowZoomOut: string;
+        WindowZoomReset: string;
+        WindowFocus: string;
+        WindowLostFocus: string;
+        WindowShow: string;
+        WindowHide: string;
+        WindowDPIChanged: string;
+        WindowFilesDropped: string;
+        ThemeChanged: string;
+    };
+};
 export class WailsEvent {
     constructor(name: any, data?: any);
     name: any;

package/types/index.d.ts

@@ -1,49 +1,12 @@
-export namespace Events {
-    export { On };
-    export { Off };
-    export { OnMultiple };
-    export { WailsEvent };
-    export { OffAll };
-    export { Emit };
-    export { Once };
-}
-export namespace Call {
-    export { Plugin };
-    export { ByID };
-    export { ByName };
-}
-export namespace Dialogs {
-    export { Info };
-    export { Error };
-    export { OpenFile };
-    export { Question };
-    export { Warning };
-    export { SaveFile };
-}
-import * as Application from "./application";
-import * as Browser from "./browser";
-import * as Clipboard from "./clipboard";
-import * as ContextMenu from "./contextmenu";
-import * as Flags from "./flags";
-import * as Runtime from "./runtime";
-import * as Screens from "./screens";
-import * as System from "./system";
-import * as Window from "./window";
-import * as WML from "./wml";
-import { On } from './events';
-import { Off } from './events';
-import { OnMultiple } from './events';
-import { WailsEvent } from './events';
-import { OffAll } from './events';
-import { Emit } from './events';
-import { Once } from './events';
-import { Plugin } from "./calls";
-import { ByID } from "./calls";
-import { ByName } from "./calls";
-import { Info } from "./dialogs";
-import { Error } from "./dialogs";
-import { OpenFile } from "./dialogs";
-import { Question } from "./dialogs";
-import { Warning } from "./dialogs";
-import { SaveFile } from "./dialogs";
-export { Application, Browser, Clipboard, ContextMenu, Flags, Runtime, Screens, System, Window, WML };
+import * as Application from "./application";
+import * as Browser from "./browser";
+import * as Call from "./calls";
+import * as Clipboard from "./clipboard";
+import * as Dialogs from "./dialogs";
+import * as Events from "./events";
+import * as Flags from "./flags";
+import * as Screens from "./screens";
+import * as System from "./system";
+import * as Window from "./window";
+import * as WML from './wml';
+export { Application, Browser, Call, Clipboard, Dialogs, Events, Flags, Screens, System, Window, WML };

package/types/screens.d.ts

@@ -14,4 +14,41 @@ export function GetPrimary(): Promise<Screen>;
  * @returns {Promise<Screen>} A promise that resolves with the current active screen.
  */
 export function GetCurrent(): Promise<Screen>;
-export type Screen = any;
+export type Screen = {
+    /**
+     * - Unique identifier for the screen.
+     */
+    Id: string;
+    /**
+     * - Human readable name of the screen.
+     */
+    Name: string;
+    /**
+     * - The resolution scale of the screen. 1 = standard resolution, 2 = high (Retina), etc.
+     */
+    Scale: number;
+    /**
+     * - Contains the X and Y coordinates of the screen's position.
+     */
+    Position: Position;
+    /**
+     * - 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 area of the screen that is actually usable (excluding taskbar and other system UI).
+     */
+    WorkArea: Rect;
+    /**
+     * - True if this is the primary monitor selected by the user in the operating system.
+     */
+    IsPrimary: boolean;
+    /**
+     * - The rotation of the screen.
+     */
+    Rotation: Rotation;
+};

package/types/window.d.ts

@@ -6,12 +6,177 @@
  */
 export function Get(windowName: string): any;
 /**
- * Returns a map of all methods in the current window.
- * @returns {Map} - A map of window methods.
- */
-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;
+ * Centers the window on the screen.
+ */
+export function Center(): void;
+/**
+ * Sets the title of the window.
+ * @param {string} title - The title to set.
+ */
+export function SetTitle(title: string): void;
+/**
+ * Sets the window to fullscreen.
+ */
+export function Fullscreen(): void;
+/**
+ * Sets the size of the window.
+ * @param {number} width - The width of the window.
+ * @param {number} height - The height of the window.
+ */
+export function SetSize(width: number, height: number): void;
+/**
+ * Gets the size of the window.
+ */
+export function Size(): any;
+export type Size = {
+    /**
+     * - The width.
+     */
+    X: number;
+    /**
+     * - The height.
+     */
+    Y: number;
+};
+/**
+ * Sets the maximum size of the window.
+ * @param {number} width - The maximum width of the window.
+ * @param {number} height - The maximum height of the window.
+ */
+export function SetMaxSize(width: number, height: number): void;
+/**
+ * Sets the minimum size of the window.
+ * @param {number} width - The minimum width of the window.
+ * @param {number} height - The minimum height of the window.
+ */
+export function SetMinSize(width: number, height: number): void;
+/**
+ * Sets the window to always be on top.
+ * @param {boolean} onTop - Whether the window should always be on top.
+ */
+export function SetAlwaysOnTop(onTop: boolean): void;
+/**
+ * Sets the relative position of the window.
+ * @param {number} x - The x-coordinate of the window's position.
+ * @param {number} y - The y-coordinate of the window's position.
+ */
+export function SetRelativePosition(x: number, y: number): void;
+/**
+ * Gets the relative position of the window.
+ */
+export function RelativePosition(): any;
+/**
+ * Gets the screen that the window is on.
+ */
+export function Screen(): any;
+export type Screen = import("./screens").Screen;
+/**
+ * Hides the window.
+ */
+export function Hide(): void;
+/**
+ * Maximises the window.
+ */
+export function Maximise(): void;
+/**
+ * Un-maximises the window.
+ */
+export function UnMaximise(): void;
+/**
+ * Toggles the maximisation of the window.
+ */
+export function ToggleMaximise(): void;
+/**
+ * Minimises the window.
+ */
+export function Minimise(): void;
+/**
+ * Un-minimises the window.
+ */
+export function UnMinimise(): void;
+/**
+ * Restores the window.
+ */
+export function Restore(): void;
+/**
+ * Shows the window.
+ */
+export function Show(): void;
+/**
+ * Closes the window.
+ */
+export function Close(): void;
+/**
+ * Sets the background colour of the window.
+ * @param {number} r - The red component of the colour.
+ * @param {number} g - The green component of the colour.
+ * @param {number} b - The blue component of the colour.
+ * @param {number} a - The alpha component of the colour.
+ */
+export function SetBackgroundColour(r: number, g: number, b: number, a: number): void;
+/**
+ * Sets whether the window is resizable.
+ * @param {boolean} resizable - Whether the window should be resizable.
+ */
+export function SetResizable(resizable: boolean): void;
+/**
+ * Gets the width of the window.
+ */
+export function Width(): any;
+/**
+ * Gets the height of the window.
+ */
+export function Height(): any;
+/**
+ * Zooms in the window.
+ */
+export function ZoomIn(): void;
+/**
+ * Zooms out the window.
+ */
+export function ZoomOut(): void;
+/**
+ * Resets the zoom of the window.
+ */
+export function ZoomReset(): void;
+/**
+ * Gets the zoom level of the window.
+ */
+export function GetZoomLevel(): any;
+/**
+ * Sets the zoom level of the window.
+ * @param {number} zoomLevel - The zoom level to set.
+ */
+export function SetZoomLevel(zoomLevel: number): void;
+export type Position = {
+    /**
+     * - The X coordinate.
+     */
+    X: number;
+    /**
+     * - The Y coordinate.
+     */
+    Y: number;
+};
+export type Rect = {
+    /**
+     * - The X coordinate of the top-left corner.
+     */
+    X: number;
+    /**
+     * - The Y coordinate of the top-left corner.
+     */
+    Y: number;
+    /**
+     * - The width of the rectangle.
+     */
+    Width: number;
+    /**
+     * - The height of the rectangle.
+     */
+    Height: number;
+};
+/**
+ * The rotation of the screen. Can be one of 'Zero', 'Ninety', 'OneEighty', 'TwoSeventy'.
+ */
+export type Rotation = ('Zero' | 'Ninety' | 'OneEighty' | 'TwoSeventy');