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

package/src/window.js

@@ -10,12 +10,38 @@ The electron alternative for Go
 
 /* jshint esversion: 9 */
 
+// Import screen jsdoc definition from ./screens.js
 /**
- * @typedef {import("../api/types").Size} Size
- * @typedef {import("../api/types").Position} Position
- * @typedef {import("../api/types").Screen} Screen
+ * @typedef {import("./screens").Screen} Screen
  */
 
+/**
+ * @typedef {Object} Position
+ * @property {number} X - The X coordinate.
+ * @property {number} Y - The Y coordinate.
+ */
+
+/**
+ * @typedef {Object} Size
+ * @property {number} X - The width.
+ * @property {number} Y - The height.
+ */
+
+
+/**
+ * @typedef {Object} Rect
+ * @property {number} X - The X coordinate of the top-left corner.
+ * @property {number} Y - The Y coordinate of the top-left corner.
+ * @property {number} Width - The width of the rectangle.
+ * @property {number} Height - The height of the rectangle.
+ */
+
+/**
+ * @typedef {('Zero'|'Ninety'|'OneEighty'|'TwoSeventy')} Rotation
+ * The rotation of the screen. Can be one of 'Zero', 'Ninety', 'OneEighty', 'TwoSeventy'.
+ */
+
+
 import {newRuntimeCallerWithID, objectNames} from "./runtime";
 
 const center = 0;
@@ -49,7 +75,7 @@ const zoomReset = 27;
 const getZoomLevel = 28;
 const setZoomLevel = 29;
 
-const thisWindow = newRuntimeCallerWithID(objectNames.Window, '');
+const thisWindow = Get('');
 
 function createWindow(call) {
     return {
@@ -98,25 +124,220 @@ export function Get(windowName) {
 }
 
 /**
- * Returns a map of all methods in the current window.
- * @returns {Map} - A map of window methods.
+ * Centers the window on the screen.
+ */
+export function Center() {
+    thisWindow.Center();
+}
+
+/**
+ * Sets the title of the window.
+ * @param {string} title - The title to set.
+ */
+export function SetTitle(title) {
+    thisWindow.SetTitle(title);
+}
+
+/**
+ * Sets the window to fullscreen.
+ */
+export function Fullscreen() {
+    thisWindow.Fullscreen();
+}
+
+/**
+ * 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, height) {
+    thisWindow.SetSize(width, height);
+}
+
+/**
+ * Gets the size of the window.
+ */
+export function Size() {
+    return thisWindow.Size();
+}
+
+/**
+ * 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, height) {
+    thisWindow.SetMaxSize(width, height);
+}
+
+/**
+ * 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 WindowMethods(targetWindow) {
-    // Create a new map to store methods
-    let result = new Map();
+export function SetMinSize(width, height) {
+    thisWindow.SetMinSize(width, height);
+}
 
-    // Iterate over all properties of the window object
-    for (let method in targetWindow) {
-        // Check if the property is indeed a method (function)
-        if(typeof targetWindow[method] === 'function') {
-            // Add the method to the map
-            result.set(method, targetWindow[method]);
-        }
+/**
+ * Sets the window to always be on top.
+ * @param {boolean} onTop - Whether the window should always be on top.
+ */
+export function SetAlwaysOnTop(onTop) {
+    thisWindow.SetAlwaysOnTop(onTop);
+}
 
-    }
-    // Return the map of window methods
-    return result;
+/**
+ * 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, y) {
+    thisWindow.SetRelativePosition(x, y);
 }
-export default {
-    ...Get('')
+
+/**
+ * Gets the relative position of the window.
+ */
+export function RelativePosition() {
+    return thisWindow.RelativePosition();
+}
+
+/**
+ * Gets the screen that the window is on.
+ */
+export function Screen() {
+    return thisWindow.Screen();
+}
+
+/**
+ * Hides the window.
+ */
+export function Hide() {
+    thisWindow.Hide();
+}
+
+/**
+ * Maximises the window.
+ */
+export function Maximise() {
+    thisWindow.Maximise();
+}
+
+/**
+ * Un-maximises the window.
+ */
+export function UnMaximise() {
+    thisWindow.UnMaximise();
+}
+
+/**
+ * Toggles the maximisation of the window.
+ */
+export function ToggleMaximise() {
+    thisWindow.ToggleMaximise();
+}
+
+/**
+ * Minimises the window.
+ */
+export function Minimise() {
+    thisWindow.Minimise();
+}
+
+/**
+ * Un-minimises the window.
+ */
+export function UnMinimise() {
+    thisWindow.UnMinimise();
+}
+
+/**
+ * Restores the window.
+ */
+export function Restore() {
+    thisWindow.Restore();
+}
+
+/**
+ * Shows the window.
+ */
+export function Show() {
+    thisWindow.Show();
+}
+
+/**
+ * Closes the window.
+ */
+export function Close() {
+    thisWindow.Close();
+}
+
+/**
+ * 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, g, b, a) {
+    thisWindow.SetBackgroundColour(r, g, b, a);
+}
+
+/**
+ * Sets whether the window is resizable.
+ * @param {boolean} resizable - Whether the window should be resizable.
+ */
+export function SetResizable(resizable) {
+    thisWindow.SetResizable(resizable);
+}
+
+/**
+ * Gets the width of the window.
+ */
+export function Width() {
+    return thisWindow.Width();
+}
+
+/**
+ * Gets the height of the window.
+ */
+export function Height() {
+    return thisWindow.Height();
+}
+
+/**
+ * Zooms in the window.
+ */
+export function ZoomIn() {
+    thisWindow.ZoomIn();
+}
+
+/**
+ * Zooms out the window.
+ */
+export function ZoomOut() {
+    thisWindow.ZoomOut();
+}
+
+/**
+ * Resets the zoom of the window.
+ */
+export function ZoomReset() {
+    thisWindow.ZoomReset();
+}
+
+/**
+ * Gets the zoom level of the window.
+ */
+export function GetZoomLevel() {
+    return thisWindow.GetZoomLevel();
+}
+
+/**
+ * Sets the zoom level of the window.
+ * @param {number} zoomLevel - The zoom level to set.
+ */
+export function SetZoomLevel(zoomLevel) {
+    thisWindow.SetZoomLevel(zoomLevel);
 }

package/src/wml.js

@@ -1,7 +1,7 @@
 
 import {Emit, WailsEvent} from "./events";
 import {Question} from "./dialogs";
-import {WindowMethods, Get} from "./window";
+import {Get} from "./window";
 import {OpenURL} from "./browser";
 
 /**
@@ -149,3 +149,24 @@ export function Reload() {
     addWMLWindowListeners();
     addWMLOpenBrowserListener();
 }
+
+/**
+ * Returns a map of all methods in the current window.
+ * @returns {Map} - A map of window methods.
+ */
+function WindowMethods(targetWindow) {
+    // Create a new map to store methods
+    let result = new Map();
+
+    // Iterate over all properties of the window object
+    for (let method in targetWindow) {
+        // Check if the property is indeed a method (function)
+        if(typeof targetWindow[method] === 'function') {
+            // Add the method to the map
+            result.set(method, targetWindow[method]);
+        }
+
+    }
+    // Return the map of window methods
+    return result;
+}

package/types/calls.d.ts

@@ -1,5 +1,3 @@
-export function resultHandler(id: any, data: any, isJSON: any): void;
-export function errorHandler(id: any, message: any): void;
 /**
  * Call method.
  *

package/types/dialogs.d.ts

@@ -1,28 +1,184 @@
-/**
- * Handles the callback from a dialog.
- *
- * @param {string} id - The ID of the dialog response.
- * @param {string} data - The data received from the dialog.
- * @param {boolean} isJSON - Flag indicating whether the data is in JSON format.
- *
- * @return {undefined}
- */
-export function dialogResultCallback(id: string, data: string, isJSON: boolean): undefined;
-/**
- * Callback function for handling errors in dialog.
- *
- * @param {string} id - The id of the dialog response.
- * @param {string} message - The error message.
- *
- * @return {void}
- */
-export function dialogErrorCallback(id: string, message: string): void;
-export function Info(options: any): Promise<string>;
-export function Warning(options: any): Promise<string>;
-export function Error(options: any): Promise<string>;
-export function Question(options: any): Promise<string>;
-export function OpenFile(options: any): Promise<string[] | string>;
-export function SaveFile(options: any): Promise<string>;
-export type MessageDialogOptions = any;
-export type OpenDialogOptions = any;
-export type SaveDialogOptions = any;
+export function Info(options: MessageDialogOptions): Promise<string>;
+export function Warning(options: MessageDialogOptions): Promise<string>;
+export function Error(options: MessageDialogOptions): Promise<string>;
+export function Question(options: MessageDialogOptions): Promise<string>;
+export function OpenFile(options: OpenFileDialogOptions): Promise<string[] | string>;
+export function SaveFile(options: SaveFileDialogOptions): Promise<string>;
+export type OpenFileDialogOptions = {
+    /**
+     * - Indicates if directories can be chosen.
+     */
+    CanChooseDirectories?: boolean;
+    /**
+     * - Indicates if files can be chosen.
+     */
+    CanChooseFiles?: boolean;
+    /**
+     * - Indicates if directories can be created.
+     */
+    CanCreateDirectories?: boolean;
+    /**
+     * - Indicates if hidden files should be shown.
+     */
+    ShowHiddenFiles?: boolean;
+    /**
+     * - Indicates if aliases should be resolved.
+     */
+    ResolvesAliases?: boolean;
+    /**
+     * - Indicates if multiple selection is allowed.
+     */
+    AllowsMultipleSelection?: boolean;
+    /**
+     * - Indicates if the extension should be hidden.
+     */
+    HideExtension?: boolean;
+    /**
+     * - Indicates if hidden extensions can be selected.
+     */
+    CanSelectHiddenExtension?: boolean;
+    /**
+     * - Indicates if file packages should be treated as directories.
+     */
+    TreatsFilePackagesAsDirectories?: boolean;
+    /**
+     * - Indicates if other file types are allowed.
+     */
+    AllowsOtherFiletypes?: boolean;
+    /**
+     * - Array of file filters.
+     */
+    Filters?: FileFilter[];
+    /**
+     * - Title of the dialog.
+     */
+    Title?: string;
+    /**
+     * - Message to show in the dialog.
+     */
+    Message?: string;
+    /**
+     * - Text to display on the button.
+     */
+    ButtonText?: string;
+    /**
+     * - Directory to open in the dialog.
+     */
+    Directory?: string;
+    /**
+     * - Indicates if the dialog should appear detached from the main window.
+     */
+    Detached?: boolean;
+};
+export type SaveFileDialogOptions = {
+    /**
+     * - Default filename to use in the dialog.
+     */
+    Filename?: string;
+    /**
+     * - Indicates if directories can be chosen.
+     */
+    CanChooseDirectories?: boolean;
+    /**
+     * - Indicates if files can be chosen.
+     */
+    CanChooseFiles?: boolean;
+    /**
+     * - Indicates if directories can be created.
+     */
+    CanCreateDirectories?: boolean;
+    /**
+     * - Indicates if hidden files should be shown.
+     */
+    ShowHiddenFiles?: boolean;
+    /**
+     * - Indicates if aliases should be resolved.
+     */
+    ResolvesAliases?: boolean;
+    /**
+     * - Indicates if multiple selection is allowed.
+     */
+    AllowsMultipleSelection?: boolean;
+    /**
+     * - Indicates if the extension should be hidden.
+     */
+    HideExtension?: boolean;
+    /**
+     * - Indicates if hidden extensions can be selected.
+     */
+    CanSelectHiddenExtension?: boolean;
+    /**
+     * - Indicates if file packages should be treated as directories.
+     */
+    TreatsFilePackagesAsDirectories?: boolean;
+    /**
+     * - Indicates if other file types are allowed.
+     */
+    AllowsOtherFiletypes?: boolean;
+    /**
+     * - Array of file filters.
+     */
+    Filters?: FileFilter[];
+    /**
+     * - Title of the dialog.
+     */
+    Title?: string;
+    /**
+     * - Message to show in the dialog.
+     */
+    Message?: string;
+    /**
+     * - Text to display on the button.
+     */
+    ButtonText?: string;
+    /**
+     * - Directory to open in the dialog.
+     */
+    Directory?: string;
+    /**
+     * - Indicates if the dialog should appear detached from the main window.
+     */
+    Detached?: boolean;
+};
+export type MessageDialogOptions = {
+    /**
+     * - The title of the dialog window.
+     */
+    Title?: string;
+    /**
+     * - The main message to show in the dialog.
+     */
+    Message?: string;
+    /**
+     * - Array of button options to show in the dialog.
+     */
+    Buttons?: Button[];
+    /**
+     * - True if the dialog should appear detached from the main window (if applicable).
+     */
+    Detached?: boolean;
+};
+export type Button = {
+    /**
+     * - Text that appears within the button.
+     */
+    Label?: string;
+    /**
+     * - True if the button should cancel an operation when clicked.
+     */
+    IsCancel?: boolean;
+    /**
+     * - True if the button should be the default action when the user presses enter.
+     */
+    IsDefault?: boolean;
+};
+export type 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;
+};