@wailsio/runtime 3.0.0-alpha.6 → 3.0.0-alpha.60

package/{events.js → src/events.js}

@@ -1,134 +1,140 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-/**
- * @typedef {import("./types").WailsEvent} WailsEvent
- */
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-
-const call = newRuntimeCallerWithID(objectNames.Events, '');
-const EmitMethod = 0;
-const eventListeners = new Map();
-
-class Listener {
-    constructor(eventName, callback, maxCallbacks) {
-        this.eventName = eventName;
-        this.maxCallbacks = maxCallbacks || -1;
-        this.Callback = (data) => {
-            callback(data);
-            if (this.maxCallbacks === -1) return false;
-            this.maxCallbacks -= 1;
-            return this.maxCallbacks === 0;
-        };
-    }
-}
-
-export class WailsEvent {
-    constructor(name, data = null) {
-        this.name = name;
-        this.data = data;
-    }
-}
-
-
-window._wails = window._wails || {};
-window._wails.dispatchWailsEvent = dispatchWailsEvent;
-
-export function dispatchWailsEvent(event) {
-    let listeners = eventListeners.get(event.name);
-    if (listeners) {
-        let toRemove = listeners.filter(listener => {
-            let remove = listener.Callback(event);
-            if (remove) return true;
-        });
-        if (toRemove.length > 0) {
-            listeners = listeners.filter(l => !toRemove.includes(l));
-            if (listeners.length === 0) eventListeners.delete(event.name);
-            else eventListeners.set(event.name, listeners);
-        }
-    }
-}
-
-/**
- * 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.
- */
-export function OnMultiple(eventName, callback, maxCallbacks) {
-    let listeners = eventListeners.get(eventName) || [];
-    const thisListener = new Listener(eventName, callback, maxCallbacks);
-    listeners.push(thisListener);
-    eventListeners.set(eventName, listeners);
-    return () => listenerOff(thisListener);
-}
-
-/**
- * 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, callback) { return OnMultiple(eventName, callback, -1); }
-
-/**
- * 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 {void@return {function} - A function that, when called, will unregister the callback from the event.
- */
-export function Once(eventName, callback) { return OnMultiple(eventName, callback, 1); }
-
-/**
- * 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.
- */
-function listenerOff(listener) {
-    const eventName = listener.eventName;
-    let listeners = eventListeners.get(eventName).filter(l => l !== listener);
-    if (listeners.length === 0) eventListeners.delete(eventName);
-    else eventListeners.set(eventName, listeners);
-}
-
-
-/**
- * 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}
- */
-export function Off(eventName, ...additionalEventNames) {
-    let eventsToRemove = [eventName, ...additionalEventNames];
-    eventsToRemove.forEach(eventName => eventListeners.delete(eventName));
-}
-/**
- * Removes all event listeners.
- *
- * @function OffAll
- * @returns {void}
- */
-export function OffAll() { eventListeners.clear(); }
-
-/**
- * Emits an event using the given event name.
- *
- * @param {WailsEvent} event - The name of the event to emit.
- * @returns {any} - The result of the emitted event.
- */
-export function Emit(event) { return call(EmitMethod, event); }
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+
+/**
+ * @typedef {import("./types").WailsEvent} WailsEvent
+ */
+import {newRuntimeCallerWithID, objectNames} from "./runtime";
+
+import {EventTypes} from "./event_types";
+export const Types = EventTypes;
+
+// Setup
+window._wails = window._wails || {};
+window._wails.dispatchWailsEvent = dispatchWailsEvent;
+
+const call = newRuntimeCallerWithID(objectNames.Events, '');
+const EmitMethod = 0;
+const eventListeners = new Map();
+
+class Listener {
+    constructor(eventName, callback, maxCallbacks) {
+        this.eventName = eventName;
+        this.maxCallbacks = maxCallbacks || -1;
+        this.Callback = (data) => {
+            callback(data);
+            if (this.maxCallbacks === -1) return false;
+            this.maxCallbacks -= 1;
+            return this.maxCallbacks === 0;
+        };
+    }
+}
+
+export class WailsEvent {
+    constructor(name, data = null) {
+        this.name = name;
+        this.data = data;
+    }
+}
+
+export function setup() {
+}
+
+function dispatchWailsEvent(event) {
+    let listeners = eventListeners.get(event.name);
+    if (listeners) {
+        let toRemove = listeners.filter(listener => {
+            let remove = listener.Callback(event);
+            if (remove) return true;
+        });
+        if (toRemove.length > 0) {
+            listeners = listeners.filter(l => !toRemove.includes(l));
+            if (listeners.length === 0) eventListeners.delete(event.name);
+            else eventListeners.set(event.name, listeners);
+        }
+    }
+}
+
+/**
+ * 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.
+ */
+export function OnMultiple(eventName, callback, maxCallbacks) {
+    let listeners = eventListeners.get(eventName) || [];
+    const thisListener = new Listener(eventName, callback, maxCallbacks);
+    listeners.push(thisListener);
+    eventListeners.set(eventName, listeners);
+    return () => listenerOff(thisListener);
+}
+
+/**
+ * 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, callback) { return OnMultiple(eventName, callback, -1); }
+
+/**
+ * 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.
+ */
+export function Once(eventName, callback) { return OnMultiple(eventName, callback, 1); }
+
+/**
+ * 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.
+ */
+function listenerOff(listener) {
+    const eventName = listener.eventName;
+    let listeners = eventListeners.get(eventName).filter(l => l !== listener);
+    if (listeners.length === 0) eventListeners.delete(eventName);
+    else eventListeners.set(eventName, listeners);
+}
+
+
+/**
+ * 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}
+ */
+export function Off(eventName, ...additionalEventNames) {
+    let eventsToRemove = [eventName, ...additionalEventNames];
+    eventsToRemove.forEach(eventName => eventListeners.delete(eventName));
+}
+/**
+ * Removes all event listeners.
+ *
+ * @function OffAll
+ * @returns {void}
+ */
+export function OffAll() { eventListeners.clear(); }
+
+/**
+ * Emits an event using the given event name.
+ *
+ * @param {WailsEvent} event - The name of the event to emit.
+ * @returns {any} - The result of the emitted event.
+ */
+export function Emit(event) { return call(EmitMethod, event); }

package/src/flags.js

@@ -0,0 +1,25 @@
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+
+/**
+ * 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.
+ */
+export function GetFlag(keyString) {
+    try {
+        return window._wails.flags[keyString];
+    } catch (e) {
+        throw new Error("Unable to retrieve flag '" + keyString + "': " + e);
+    }
+}

package/src/index.js

@@ -0,0 +1,60 @@
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+// Setup
+window._wails = window._wails || {};
+
+import "./contextmenu";
+import "./drag";
+
+// Re-export public API
+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
+};
+
+let initialised = false;
+export function init() {
+    window._wails.invoke = System.invoke;
+    System.invoke("wails:runtime:ready");
+    initialised = true;
+}
+
+window.addEventListener("load", () => {
+    if (!initialised) {
+        init();
+    }
+});
+
+// Notify backend
+

package/src/nanoid.js

@@ -0,0 +1,42 @@
+// Source: https://github.com/ai/nanoid
+
+// The MIT License (MIT)
+//
+// Copyright 2017 Andrey Sitnik <andrey@sitnik.ru>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy of
+// this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to
+// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+// the Software, and to permit persons to whom the Software is furnished to do so,
+//     subject to the following conditions:
+//
+//     The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+// This alphabet uses `A-Za-z0-9_-` symbols.
+// The order of characters is optimized for better gzip and brotli compression.
+// References to the same file (works both for gzip and brotli):
+// `'use`, `andom`, and `rict'`
+// References to the brotli default dictionary:
+// `-26T`, `1983`, `40px`, `75px`, `bush`, `jack`, `mind`, `very`, and `wolf`
+let urlAlphabet =
+    'useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict'
+
+export let nanoid = (size = 21) => {
+    let id = ''
+    // A compact alternative for `for (var i = 0; i < step; i++)`.
+    let i = size | 0
+    while (i--) {
+        // `| 0` is more compact and faster than `Math.floor()`.
+        id += urlAlphabet[(Math.random() * 64) | 0]
+    }
+    return id
+}

package/src/runtime.js

@@ -0,0 +1,92 @@
+/*
+ _     __     _ __
+| |  / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+import { nanoid } from './nanoid.js';
+
+const runtimeURL = window.location.origin + "/wails/runtime";
+
+// Object Names
+export const objectNames = {
+    Call: 0,
+    Clipboard: 1,
+    Application: 2,
+    Events: 3,
+    ContextMenu: 4,
+    Dialog: 5,
+    Window: 6,
+    Screens: 7,
+    System: 8,
+    Browser: 9,
+    CancelCall: 10,
+}
+export let clientId = nanoid();
+
+/**
+ * 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, windowName) {
+    return function (method, args=null) {
+        return runtimeCall(object + "." + method, windowName, args);
+    };
+}
+
+/**
+ * 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.
+ */
+export function newRuntimeCallerWithID(object, windowName) {
+    return function (method, args=null) {
+        return runtimeCallWithID(object, method, windowName, args);
+    };
+}
+
+
+function runtimeCall(method, windowName, args) {
+    return runtimeCallWithID(null, method, windowName, args);
+}
+
+async function runtimeCallWithID(objectID, method, windowName, args) {
+    let url = new URL(runtimeURL);
+    if (objectID != null) {
+        url.searchParams.append("object", objectID);
+    }
+    if (method != null) {
+        url.searchParams.append("method", method);
+    }
+    let fetchOptions = {
+        headers: {},
+    };
+    if (windowName) {
+        fetchOptions.headers["x-wails-window-name"] = windowName;
+    }
+    if (args) {
+        url.searchParams.append("args", JSON.stringify(args));
+    }
+    fetchOptions.headers["x-wails-client-id"] = clientId;
+
+    let response = await fetch(url, fetchOptions);
+    if (!response.ok) {
+        throw new Error(await response.text());
+    }
+
+    if (response.headers.get("Content-Type") && response.headers.get("Content-Type").indexOf("application/json") !== -1) {
+        return response.json();
+    } else {
+        return response.text();
+    }
+}

package/src/screens.js

@@ -0,0 +1,71 @@
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+
+/**
+ * @typedef {Object} Size
+ * @property {number} Width - The width.
+ * @property {number} Height - The height.
+ */
+
+/**
+ * @typedef {Object} Rect
+ * @property {number} X - The X coordinate of the origin.
+ * @property {number} Y - The Y coordinate of the origin.
+ * @property {number} Width - The width of the rectangle.
+ * @property {number} Height - The height of the rectangle.
+ */
+
+/**
+ * @typedef {Object} Screen
+ * @property {string} ID - Unique identifier for the screen.
+ * @property {string} Name - Human readable name of the screen.
+ * @property {number} ScaleFactor - The scale factor of the screen (DPI/96). 1 = standard DPI, 2 = HiDPI (Retina), etc.
+ * @property {number} X - The X coordinate of the screen.
+ * @property {number} Y - The Y coordinate of the screen.
+ * @property {Size} Size - Contains the width and height of the screen.
+ * @property {Rect} Bounds - Contains the bounds of the screen in terms of X, Y, Width, and Height.
+ * @property {Rect} PhysicalBounds - Contains the physical bounds of the screen in terms of X, Y, Width, and Height (before scaling).
+ * @property {Rect} WorkArea - Contains the area of the screen that is actually usable (excluding taskbar and other system UI).
+ * @property {Rect} PhysicalWorkArea - Contains the physical WorkArea of the screen (before scaling).
+ * @property {boolean} IsPrimary - True if this is the primary monitor selected by the user in the operating system.
+ * @property {number} Rotation - The rotation of the screen.
+ */
+
+import { newRuntimeCallerWithID, objectNames } from "./runtime";
+const call = newRuntimeCallerWithID(objectNames.Screens, "");
+
+const getAll = 0;
+const getPrimary = 1;
+const getCurrent = 2;
+
+/**
+ * Gets all screens.
+ * @returns {Promise<Screen[]>} A promise that resolves to an array of Screen objects.
+ */
+export function GetAll() {
+    return call(getAll);
+}
+/**
+ * Gets the primary screen.
+ * @returns {Promise<Screen>} A promise that resolves to the primary screen.
+ */
+export function GetPrimary() {
+    return call(getPrimary);
+}
+/**
+ * Gets the current active screen.
+ *
+ * @returns {Promise<Screen>} A promise that resolves with the current active screen.
+ */
+export function GetCurrent() {
+    return call(getCurrent);
+}