@wailsio/runtime 3.0.0-alpha.64 → 3.0.0-alpha.66

package/types/events.d.ts

@@ -1,271 +1,66 @@
-export function setup(): void;
+export { Types } from "./event_types.js";
+/**
+ * The type of handlers for a given event.
+ */
+export type Callback = (ev: WailsEvent) => void;
+/**
+ * Represents a system event or a custom event emitted through wails-provided facilities.
+ */
+export declare class WailsEvent {
+    /**
+     * The name of the event.
+     */
+    name: string;
+    /**
+     * Optional data associated with the emitted event.
+     */
+    data: any;
+    /**
+     * Name of the originating window. Omitted for application events.
+     * Will be overridden if set manually.
+     */
+    sender?: string;
+    constructor(name: string, data?: any);
+}
 /**
  * Register a callback function to be called multiple times for a specific event.
  *
- * @param {string} eventName - The name of the event to register the callback for.
- * @param {function} callback - The callback function to be called when the event is triggered.
- * @param {number} maxCallbacks - The maximum number of times the callback can be called for the event. Once the maximum number is reached, the callback will no longer be called.
- *
- @return {function} - A function that, when called, will unregister the callback from the event.
+ * @param eventName - The name of the event to register the callback for.
+ * @param callback - The callback function to be called when the event is triggered.
+ * @param maxCallbacks - The maximum number of times the callback can be called for the event. Once the maximum number is reached, the callback will no longer be called.
+ * @returns A function that, when called, will unregister the callback from the event.
  */
-export function OnMultiple(eventName: string, callback: Function, maxCallbacks: number): Function;
+export declare function OnMultiple(eventName: string, callback: Callback, maxCallbacks: number): () => void;
 /**
  * Registers a callback function to be executed when the specified event occurs.
  *
- * @param {string} eventName - The name of the event.
- * @param {function} callback - The callback function to be executed. It takes no parameters.
- * @return {function} - A function that, when called, will unregister the callback from the event. */
-export function On(eventName: string, callback: Function): Function;
+ * @param eventName - The name of the event to register the callback for.
+ * @param callback - The callback function to be called when the event is triggered.
+ * @returns A function that, when called, will unregister the callback from the event.
+ */
+export declare function On(eventName: string, callback: Callback): () => void;
 /**
  * Registers a callback function to be executed only once for the specified event.
  *
- * @param {string} eventName - The name of the event.
- * @param {function} callback - The function to be executed when the event occurs.
- * @return {function} - A function that, when called, will unregister the callback from the event.
+ * @param eventName - The name of the event to register the callback for.
+ * @param callback - The callback function to be called when the event is triggered.
+ * @returns A function that, when called, will unregister the callback from the event.
  */
-export function Once(eventName: string, callback: Function): Function;
+export declare function Once(eventName: string, callback: Callback): () => void;
 /**
  * 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}
+ * @param eventNames - The name of the events to remove listeners for.
  */
-export function Off(eventName: string, ...additionalEventNames: string[]): undefined;
+export declare function Off(...eventNames: [string, ...string[]]): void;
 /**
  * Removes all event listeners.
- *
- * @function OffAll
- * @returns {void}
  */
-export function OffAll(): void;
+export declare function OffAll(): void;
 /**
- * Emits an event using the given event name.
+ * Emits the given event.
  *
- * @param {WailsEvent} event - The name of the event to emit.
- * @returns {any} - The result of the emitted event.
+ * @param event - The name of the event to emit.
+ * @returns A promise that will be fulfilled once the event has been emitted.
  */
-export function Emit(event: WailsEvent): any;
-export const Types: {
-    Windows: {
-        APMPowerSettingChange: string;
-        APMPowerStatusChange: string;
-        APMResumeAutomatic: string;
-        APMResumeSuspend: string;
-        APMSuspend: string;
-        ApplicationStarted: string;
-        SystemThemeChanged: string;
-        WebViewNavigationCompleted: string;
-        WindowActive: string;
-        WindowBackgroundErase: string;
-        WindowClickActive: string;
-        WindowClosing: string;
-        WindowDidMove: string;
-        WindowDidResize: string;
-        WindowDPIChanged: string;
-        WindowDragDrop: string;
-        WindowDragEnter: string;
-        WindowDragLeave: string;
-        WindowDragOver: string;
-        WindowEndMove: string;
-        WindowEndResize: string;
-        WindowFullscreen: string;
-        WindowHide: string;
-        WindowInactive: string;
-        WindowKeyDown: string;
-        WindowKeyUp: string;
-        WindowKillFocus: string;
-        WindowNonClientHit: string;
-        WindowNonClientMouseDown: string;
-        WindowNonClientMouseLeave: string;
-        WindowNonClientMouseMove: string;
-        WindowNonClientMouseUp: string;
-        WindowPaint: string;
-        WindowRestore: string;
-        WindowSetFocus: string;
-        WindowShow: string;
-        WindowStartMove: string;
-        WindowStartResize: string;
-        WindowUnFullscreen: string;
-        WindowZOrderChanged: string;
-        WindowMinimise: string;
-        WindowUnMinimise: string;
-        WindowMaximise: string;
-        WindowUnMaximise: string;
-    };
-    Mac: {
-        ApplicationDidBecomeActive: string;
-        ApplicationDidChangeBackingProperties: string;
-        ApplicationDidChangeEffectiveAppearance: string;
-        ApplicationDidChangeIcon: string;
-        ApplicationDidChangeOcclusionState: string;
-        ApplicationDidChangeScreenParameters: string;
-        ApplicationDidChangeStatusBarFrame: string;
-        ApplicationDidChangeStatusBarOrientation: string;
-        ApplicationDidChangeTheme: string;
-        ApplicationDidFinishLaunching: string;
-        ApplicationDidHide: string;
-        ApplicationDidResignActive: string;
-        ApplicationDidUnhide: string;
-        ApplicationDidUpdate: string;
-        ApplicationShouldHandleReopen: string;
-        ApplicationWillBecomeActive: string;
-        ApplicationWillFinishLaunching: string;
-        ApplicationWillHide: string;
-        ApplicationWillResignActive: string;
-        ApplicationWillTerminate: string;
-        ApplicationWillUnhide: string;
-        ApplicationWillUpdate: string;
-        MenuDidAddItem: string;
-        MenuDidBeginTracking: string;
-        MenuDidClose: string;
-        MenuDidDisplayItem: string;
-        MenuDidEndTracking: string;
-        MenuDidHighlightItem: string;
-        MenuDidOpen: string;
-        MenuDidPopUp: string;
-        MenuDidRemoveItem: string;
-        MenuDidSendAction: string;
-        MenuDidSendActionToItem: string;
-        MenuDidUpdate: string;
-        MenuWillAddItem: string;
-        MenuWillBeginTracking: string;
-        MenuWillDisplayItem: string;
-        MenuWillEndTracking: string;
-        MenuWillHighlightItem: string;
-        MenuWillOpen: string;
-        MenuWillPopUp: string;
-        MenuWillRemoveItem: string;
-        MenuWillSendAction: string;
-        MenuWillSendActionToItem: string;
-        MenuWillUpdate: string;
-        WebViewDidCommitNavigation: string;
-        WebViewDidFinishNavigation: string;
-        WebViewDidReceiveServerRedirectForProvisionalNavigation: string;
-        WebViewDidStartProvisionalNavigation: 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;
-        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;
-        WindowDidZoom: string;
-        WindowFileDraggingEntered: string;
-        WindowFileDraggingExited: string;
-        WindowFileDraggingPerformed: string;
-        WindowHide: string;
-        WindowMaximise: string;
-        WindowUnMaximise: string;
-        WindowMinimise: string;
-        WindowUnMinimise: string;
-        WindowShouldClose: string;
-        WindowShow: 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;
-        WindowZoomIn: string;
-        WindowZoomOut: string;
-        WindowZoomReset: string;
-    };
-    Linux: {
-        ApplicationStartup: string;
-        SystemThemeChanged: string;
-        WindowDeleteEvent: string;
-        WindowDidMove: string;
-        WindowDidResize: string;
-        WindowFocusIn: string;
-        WindowFocusOut: string;
-        WindowLoadChanged: string;
-    };
-    Common: {
-        ApplicationOpenedWithFile: string;
-        ApplicationStarted: string;
-        ThemeChanged: string;
-        WindowClosing: string;
-        WindowDidMove: string;
-        WindowDidResize: string;
-        WindowDPIChanged: string;
-        WindowFilesDropped: string;
-        WindowFocus: string;
-        WindowFullscreen: string;
-        WindowHide: string;
-        WindowLostFocus: string;
-        WindowMaximise: string;
-        WindowMinimise: string;
-        WindowRestore: string;
-        WindowRuntimeReady: string;
-        WindowShow: string;
-        WindowUnFullscreen: string;
-        WindowUnMaximise: string;
-        WindowUnMinimise: string;
-        WindowZoom: string;
-        WindowZoomIn: string;
-        WindowZoomOut: string;
-        WindowZoomReset: string;
-    };
-};
-export class WailsEvent {
-    constructor(name: any, data?: any);
-    name: any;
-    data: any;
-}
+export declare function Emit(event: WailsEvent): Promise<void>;

package/types/flags.d.ts

@@ -1,7 +1,7 @@
 /**
  * Retrieves the value associated with the specified key from the flag map.
  *
- * @param {string} keyString - The key to retrieve the value for.
- * @return {*} - The value associated with the specified key.
+ * @param key - The key to retrieve the value for.
+ * @return The value associated with the specified key.
  */
-export function GetFlag(keyString: string): any;
+export declare function GetFlag(key: string): any;

package/types/index.d.ts

@@ -1,14 +1,16 @@
-export function init(): void;
-import * as Application from "./application";
-import * as Browser from "./browser";
-import * as Call from "./calls";
-import * as Clipboard from "./clipboard";
-import * as Create from "./create";
-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 Window from "./window";
-import * as WML from "./wml";
-export { Application, Browser, Call, Clipboard, Create, Dialogs, Events, Flags, Screens, System, Window, WML };
+import "./contextmenu.js";
+import "./drag.js";
+import * as Application from "./application.js";
+import * as Browser from "./browser.js";
+import * as Call from "./calls.js";
+import * as Clipboard from "./clipboard.js";
+import * as Create from "./create.js";
+import * as Dialogs from "./dialogs.js";
+import * as Events from "./events.js";
+import * as Flags from "./flags.js";
+import * as Screens from "./screens.js";
+import * as System from "./system.js";
+import Window from "./window.js";
+import * as WML from "./wml.js";
+export { Application, Browser, Call, Clipboard, Dialogs, Events, Flags, Screens, System, Window, WML };
+export * from "./cancellable.js";

package/types/listener.d.ts

@@ -0,0 +1,9 @@
+export declare const eventListeners: Map<string, Listener[]>;
+export declare class Listener {
+    eventName: string;
+    callback: (data: any) => void;
+    maxCallbacks: number;
+    constructor(eventName: string, callback: (data: any) => void, maxCallbacks: number);
+    dispatch(data: any): boolean;
+}
+export declare function listenerOff(listener: Listener): void;

package/types/nanoid.d.ts

@@ -1 +1 @@
-export function nanoid(size?: number): string;
+export declare function nanoid(size?: number): string;

package/types/runtime.d.ts

@@ -1,30 +1,22 @@
-/**
- * Creates a runtime caller function that invokes a specified method on a given object within a specified window context.
- *
- * @param {Object} object - The object on which the method is to be invoked.
- * @param {string} windowName - The name of the window context in which the method should be called.
- * @returns {Function} A runtime caller function that takes the method name and optionally arguments and invokes the method within the specified window context.
- */
-export function newRuntimeCaller(object: any, windowName: string): Function;
+export declare const objectNames: Readonly<{
+    Call: 0;
+    Clipboard: 1;
+    Application: 2;
+    Events: 3;
+    ContextMenu: 4;
+    Dialog: 5;
+    Window: 6;
+    Screens: 7;
+    System: 8;
+    Browser: 9;
+    CancelCall: 10;
+}>;
+export declare let clientId: string;
 /**
  * Creates a new runtime caller with specified ID.
  *
- * @param {number} object - The object to invoke the method on.
- * @param {string} windowName - The name of the window.
- * @return {Function} - The new runtime caller function.
+ * @param object - The object to invoke the method on.
+ * @param windowName - The name of the window.
+ * @return The new runtime caller function.
  */
-export function newRuntimeCallerWithID(object: number, windowName: string): Function;
-export namespace objectNames {
-    let Call: number;
-    let Clipboard: number;
-    let Application: number;
-    let Events: number;
-    let ContextMenu: number;
-    let Dialog: number;
-    let Window: number;
-    let Screens: number;
-    let System: number;
-    let Browser: number;
-    let CancelCall: number;
-}
-export let clientId: string;
+export declare function newRuntimeCaller(object: number, windowName?: string): (method: number, args?: any) => Promise<any>;

package/types/screens.d.ts

@@ -1,94 +1,60 @@
-/**
- * Gets all screens.
- * @returns {Promise<Screen[]>} A promise that resolves to an array of Screen objects.
- */
-export function GetAll(): Promise<Screen[]>;
-/**
- * Gets the primary screen.
- * @returns {Promise<Screen>} A promise that resolves to the primary screen.
- */
-export function GetPrimary(): Promise<Screen>;
-/**
- * Gets the current active screen.
- *
- * @returns {Promise<Screen>} A promise that resolves with the current active screen.
- */
-export function GetCurrent(): Promise<Screen>;
-export type Size = {
-    /**
-     * - The width.
-     */
+export interface Size {
+    /** The width of a rectangular area. */
     Width: number;
-    /**
-     * - The height.
-     */
+    /** The height of a rectangular area. */
     Height: number;
-};
-export type Rect = {
-    /**
-     * - The X coordinate of the origin.
-     */
+}
+export interface Rect {
+    /** The X coordinate of the origin. */
     X: number;
-    /**
-     * - The Y coordinate of the origin.
-     */
+    /** The Y coordinate of the origin. */
     Y: number;
-    /**
-     * - The width of the rectangle.
-     */
+    /** The width of the rectangle. */
     Width: number;
-    /**
-     * - The height of the rectangle.
-     */
+    /** The height of the rectangle. */
     Height: number;
-};
-export type Screen = {
-    /**
-     * - Unique identifier for the screen.
-     */
+}
+export interface Screen {
+    /** Unique identifier for the screen. */
     ID: string;
-    /**
-     * - Human readable name of the screen.
-     */
+    /** Human-readable name of the screen. */
     Name: string;
-    /**
-     * - The scale factor of the screen (DPI/96). 1 = standard DPI, 2 = HiDPI (Retina), etc.
-     */
+    /** The scale factor of the screen (DPI/96). 1 = standard DPI, 2 = HiDPI (Retina), etc. */
     ScaleFactor: number;
-    /**
-     * - The X coordinate of the screen.
-     */
+    /** The X coordinate of the screen. */
     X: number;
-    /**
-     * - The Y coordinate of the screen.
-     */
+    /** The Y coordinate of the screen. */
     Y: number;
-    /**
-     * - Contains the width and height of the screen.
-     */
+    /** Contains the width and height of the screen. */
     Size: Size;
-    /**
-     * - Contains the bounds of the screen in terms of X, Y, Width, and Height.
-     */
+    /** 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).
-     */
+    /** 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).
-     */
+    /** 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).
-     */
+    /** 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.
-     */
+    /** True if this is the primary monitor selected by the user in the operating system. */
     IsPrimary: boolean;
-    /**
-     * - The rotation of the screen.
-     */
+    /** The rotation of the screen. */
     Rotation: number;
-};
+}
+/**
+ * Gets all screens.
+ *
+ * @returns A promise that resolves to an array of Screen objects.
+ */
+export declare function GetAll(): Promise<Screen[]>;
+/**
+ * Gets the primary screen.
+ *
+ * @returns A promise that resolves to the primary screen.
+ */
+export declare function GetPrimary(): Promise<Screen>;
+/**
+ * Gets the current active screen.
+ *
+ * @returns A promise that resolves with the current active screen.
+ */
+export declare function GetCurrent(): Promise<Screen>;