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

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@wailsio/runtime",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.7",
   "description": "Wails Runtime",
   "main": "index.js",
+  "types": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/wailsapp/wails.git"

package/types.d.ts

@@ -1,130 +1,135 @@
 
+/**
+ * Describes the properties of a Button object.
+ */
 export interface Button {
-    // The label of the button
+    // Text that appears within the button.
     Label?: string;
-    // True if this button is the cancel button (selected when pressing escape)
+    // True if the button should cancel an operation when clicked.
     IsCancel?: boolean;
-    // True if this button is the default button (selected when pressing enter)
+    // True if the button should be the default action when the user presses enter.
     IsDefault?: boolean;
 }
 
-interface MessageDialogOptions {
-    // The title for the dialog
+/**
+ * Describes the properties of a FileFilter object.
+ */
+export interface FileFilter {
+    // Display name for the filter, it could be "Text Files", "Images" etc.
+    DisplayName?: string;
+    // Pattern to match for the filter, e.g. "*.txt;*.md" for text markdown files.
+    Pattern?: string;
+}
+
+/**
+ * Describes the properties of a Position object.
+ */
+export interface Position {
+    X: number;
+    Y: number;
+}
+
+/**
+ * Describes the properties of a Size object.
+ * Extends the properties of Position.
+ */
+export type Size = Position;
+
+/**
+ * Describes the properties of a Rect object.
+ * Extends the properties of Size.
+ */
+export type Rect = Size & Position;
+
+/**
+ * Describes the possible rotations a Screen can have.
+ */
+export enum Rotation {
+    Zero = 0,
+    Ninety = 90,
+    OneEighty = 180,
+    TwoSeventy = 270
+}
+
+/**
+ * Describes the properties of a Screen object.
+ */
+export interface 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. Can be one of 0, 90, 180, 270 degrees.
+    Rotation: Rotation;
+}
+
+/**
+ * Describes the properties of a MessageDialogOptions object.
+ */
+export interface MessageDialogOptions {
+    // The title of the dialog window.
     Title?: string;
-    // The message to display
+    // The main message to show in the dialog.
     Message?: string;
-    // The buttons to use on the dialog
+    // Array of button options to show in the dialog.
     Buttons?: Button[];
-    // Whether the dialog is detached from the current window
+    // True if the dialog should appear detached from the main window (if applicable).
     Detached?: boolean;
 }
 
-export interface OpenFileDialogOptions {
-    // Allows the user to be able to select directories
+/**
+ * Describes the properties common to OpenFileDialogOptions and SaveFileDialogOptions objects.
+ */
+export interface DialogOptions {
     CanChooseDirectories?: boolean;
-    // Allows the user to be able to select files
     CanChooseFiles?: boolean;
-    // Provide an option to create directories in the dialog
     CanCreateDirectories?: boolean;
-    // Makes the dialog show hidden files
     ShowHiddenFiles?: boolean;
-    // Whether the dialog should follow filesystem aliases
     ResolvesAliases?: boolean;
-    // Allow the user to select multiple files or directories
     AllowsMultipleSelection?: boolean;
-    // Hide the extension when showing the filename
     HideExtension?: boolean;
-    // Allow the user to select files where the system hides their extensions
     CanSelectHiddenExtension?: boolean;
-    // Treats file packages as directories, e.g. .app on macOS
     TreatsFilePackagesAsDirectories?: boolean;
-    // Allows selection of filetypes not specified in the filters
     AllowsOtherFiletypes?: boolean;
-    // The file filters to use in the dialog
     Filters?: FileFilter[];
-    // The title of the dialog
     Title?: string;
-    // The message to display
     Message?: string;
-    // The label for the select button
     ButtonText?: string;
-    // The default directory to open the dialog in
     Directory?: string;
-    // Whether the dialog is detached from the current window
-    Detached?: boolean;
-}
-export interface FileFilter {
-    // The display name for the filter, e.g. "Text Files"
-    DisplayName?: string;
-    // The pattern to use for the filter, e.g. "*.txt;*.md"
-    Pattern?: string;
-}
-export interface SaveFileDialogOptions {
-    // Provide an option to create directories in the dialog
-    CanCreateDirectories?: boolean;
-    // Makes the dialog show hidden files
-    ShowHiddenFiles?: boolean;
-    // Allow the user to select files where the system hides their extensions
-    CanSelectHiddenExtension?: boolean;
-    // Allows selection of filetypes not specified in the filters
-    AllowOtherFiletypes?: boolean;
-    // Hide the extension when showing the filename
-    HideExtension?: boolean;
-    // Treats file packages as directories, e.g. .app on macOS
-    TreatsFilePackagesAsDirectories?: boolean;
-    // The message to show in the dialog
-    Message?: string;
-    // The default directory to open the dialog in
-    Directory?: string;
-    // The default filename to use in the dialog
-    Filename?: string;
-    // The label for the select button
-    ButtonText?: string;
-    // Whether the dialog is detached from the current window
     Detached?: boolean;
 }
 
-export interface Screen {
-    // The screen ID
-    Id: string;
-    // The screen name
-    Name: string;
-    // The screen scale. 1 = standard resolution, 2: 2x retina, etc.
-    Scale: number;
-    // The X position of the screen
-    X: number;
-    // The Y position of the screen
-    Y: number;
-    // The width and height of the screen
-    Size: Size;
-    // The bounds of the screen
-    Bounds: Rect;
-    // The work area of the screen
-    WorkArea: Rect;
-    // True if this is the primary screen
-    IsPrimary: boolean;
-    // The rotation of the screen
-    Rotation: number;
-}
-export interface Rect {
-    X: number;
-    Y: number;
-    Width: number;
-    Height: number;
-}
+/**
+ * Describes properties unique to OpenFileDialogOptions.
+ */
+export type OpenFileDialogOptions = DialogOptions;
 
+/**
+ * Describes properties unique to SaveFileDialogOptions.
+ */
+export type SaveFileDialogOptions = DialogOptions & {
+    // Default filename to use for the save dialog.
+    Filename?: string;
+};
+
+/**
+ * Describes the properties of a WailsEvent object.
+ */
 export interface WailsEvent {
-    // The name of the event
+    // The name of the event.
     Name: string;
-    // The data associated with the event
-    Data?: any;
-}
-
-export interface Size {
-    Width: number;
-    Height: number;
-}
-export interface Position {
-    X: number;
-    Y: number;
+    // Any data associated with the event.
+    Data?: unknown;
 }

package/wml.js

@@ -2,6 +2,7 @@
 import {Emit, WailsEvent} from "./events";
 import {Question} from "./dialogs";
 import {WindowMethods, Get} from "./window";
+import {OpenURL} from "./browser";
 
 /**
  * Sends an event with the given name and optional data.
@@ -48,22 +49,23 @@ function addWMLEventListeners() {
     });
 }
 
+
 /**
- * Calls a method on the window object.
- *
- * @param {string} method - The name of the method to call on the window object.
- *
- * @return {void}
+ * Calls a method on a specified window.
+ * @param {string} windowName - The name of the window to call the method on.
+ * @param {string} method - The name of the method to call.
  */
-function callWindowMethod(method) {
-    // TODO: Make this a parameter!
-    let windowName = '';
-    let targetWindow = Get('');
+function callWindowMethod(windowName, method) {
+    let targetWindow = Get(windowName);
     let methodMap = WindowMethods(targetWindow);
     if (!methodMap.has(method)) {
         console.log("Window method " + method + " not found");
     }
-    methodMap.get(method)();
+    try {
+        methodMap.get(method)();
+    } catch (e) {
+        console.error("Error calling window method '" + method + "': " + e);
+    }
 }
 
 /**
@@ -77,18 +79,19 @@ function addWMLWindowListeners() {
     elements.forEach(function (element) {
         const windowMethod = element.getAttribute('wml-window');
         const confirm = element.getAttribute('wml-confirm');
-        const trigger = element.getAttribute('wml-trigger') || "click";
+        const trigger = element.getAttribute('wml-trigger') || 'click';
+        const targetWindow = element.getAttribute('wml-target-window') || '';
 
         let callback = function () {
             if (confirm) {
                 Question({Title: "Confirm", Message:confirm, Buttons:[{Label:"Yes"},{Label:"No", IsDefault:true}]}).then(function (result) {
                     if (result !== "No") {
-                        callWindowMethod(windowMethod);
+                        callWindowMethod(targetWindow, windowMethod);
                     }
                 });
                 return;
             }
-            callWindowMethod(windowMethod);
+            callWindowMethod(targetWindow, windowMethod);
         };
 
         // Remove existing listeners
@@ -119,12 +122,12 @@ function addWMLOpenBrowserListener() {
             if (confirm) {
                 Question({Title: "Confirm", Message:confirm, Buttons:[{Label:"Yes"},{Label:"No", IsDefault:true}]}).then(function (result) {
                     if (result !== "No") {
-                        void wails.Browser.OpenURL(url);
+                        void OpenURL(url);
                     }
                 });
                 return;
             }
-            void wails.Browser.OpenURL(url);
+            void OpenURL(url);
         };
 
         // Remove existing listeners