@wailsio/runtime 3.0.0-alpha.4 → 3.0.0-alpha.42

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

@@ -1,122 +1,123 @@
-/*
- _     __     _ __
-| |  / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-import { nanoid } from 'nanoid/non-secure';
-
-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,
-}
-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 {object} 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) {
-    let url = new URL(runtimeURL);
-    if( method ) {
-        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;
-
-    return new Promise((resolve, reject) => {
-        fetch(url, fetchOptions)
-            .then(response => {
-                if (response.ok) {
-                    // check content type
-                    if (response.headers.get("Content-Type") && response.headers.get("Content-Type").indexOf("application/json") !== -1) {
-                        return response.json();
-                    } else {
-                        return response.text();
-                    }
-                }
-                reject(Error(response.statusText));
-            })
-            .then(data => resolve(data))
-            .catch(error => reject(error));
-    });
-}
-
-function runtimeCallWithID(objectID, method, windowName, args) {
-    let url = new URL(runtimeURL);
-    url.searchParams.append("object", objectID);
-    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;
-    return new Promise((resolve, reject) => {
-        fetch(url, fetchOptions)
-            .then(response => {
-                if (response.ok) {
-                    // check content type
-                    if (response.headers.get("Content-Type") && response.headers.get("Content-Type").indexOf("application/json") !== -1) {
-                        return response.json();
-                    } else {
-                        return response.text();
-                    }
-                }
-                reject(Error(response.statusText));
-            })
-            .then(data => resolve(data))
-            .catch(error => reject(error));
-    });
-}
+/*
+ _     __     _ __
+| |  / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+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 {object} 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) {
+    let url = new URL(runtimeURL);
+    if( method ) {
+        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;
+
+    return new Promise((resolve, reject) => {
+        fetch(url, fetchOptions)
+            .then(response => {
+                if (response.ok) {
+                    // check content type
+                    if (response.headers.get("Content-Type") && response.headers.get("Content-Type").indexOf("application/json") !== -1) {
+                        return response.json();
+                    } else {
+                        return response.text();
+                    }
+                }
+                reject(Error(response.statusText));
+            })
+            .then(data => resolve(data))
+            .catch(error => reject(error));
+    });
+}
+
+function runtimeCallWithID(objectID, method, windowName, args) {
+    let url = new URL(runtimeURL);
+    url.searchParams.append("object", objectID);
+    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;
+    return new Promise((resolve, reject) => {
+        fetch(url, fetchOptions)
+            .then(response => {
+                if (response.ok) {
+                    // check content type
+                    if (response.headers.get("Content-Type") && response.headers.get("Content-Type").indexOf("application/json") !== -1) {
+                        return response.json();
+                    } else {
+                        return response.text();
+                    }
+                }
+                reject(Error(response.statusText));
+            })
+            .then(data => resolve(data))
+            .catch(error => reject(error));
+    });
+}

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);
+}

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

@@ -1,118 +1,143 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-let call = newRuntimeCallerWithID(objectNames.System, '');
-const systemIsDarkMode = 0;
-const environment = 1;
-
-/**
- * @function
- * Retrieves the system dark mode status.
- * @returns {Promise<boolean>} - A promise that resolves to a boolean value indicating if the system is in dark mode.
- */
-export function IsDarkMode() {
-    return call(systemIsDarkMode);
-}
-
-
-/**
- * Fetches the capabilities of the application from the server.
- *
- * @async
- * @function Capabilities
- * @returns {Promise<Object>} A promise that resolves to an object containing the capabilities.
- */
-export async function Capabilities() {
-    let response = fetch("/wails/capabilities");
-    return response.json();
-}
-
-/**
- * @typedef {object} EnvironmentInfo
- * @property {string} OS - The operating system in use.
- * @property {string} Arch - The architecture of the system.
- */
-
-/**
- * @function
- * Retrieves environment details.
- * @returns {Promise<EnvironmentInfo>} - A promise that resolves to an object containing OS and system architecture.
- */
-export function Environment() {
-    return call(environment);
-}
-
-export let invoke = null;
-let environmentCache = null;
-
-Environment()
-    .then(result => {
-        environmentCache = result;
-        invoke = IsWindows() ? window.chrome.webview.postMessage : window.webkit.messageHandlers.external.postMessage;
-    })
-    .catch(error => {
-        console.error(`Error getting Environment: ${error}`);
-    });
-
-/**
- * Checks if the current operating system is Windows.
- *
- * @return {boolean} True if the operating system is Windows, otherwise false.
- */
-export function IsWindows() {
-    return environmentCache.OS === "windows";
-}
-
-/**
- * Checks if the current operating system is Linux.
- *
- * @returns {boolean} Returns true if the current operating system is Linux, false otherwise.
- */
-export function IsLinux() {
-    return environmentCache.OS === "linux";
-}
-
-/**
- * Checks if the current environment is a macOS operating system.
- *
- * @returns {boolean} True if the environment is macOS, false otherwise.
- */
-export function IsMac() {
-    return environmentCache.OS === "darwin";
-}
-
-/**
- * Checks if the current environment architecture is AMD64.
- * @returns {boolean} True if the current environment architecture is AMD64, false otherwise.
- */
-export function IsAMD64() {
-    return environmentCache.Arch === "amd64";
-}
-
-/**
- * Checks if the current architecture is ARM.
- *
- * @returns {boolean} True if the current architecture is ARM, false otherwise.
- */
-export function IsARM() {
-    return environmentCache.Arch === "arm";
-}
-
-/**
- * Checks if the current environment is ARM64 architecture.
- *
- * @returns {boolean} - Returns true if the environment is ARM64 architecture, otherwise returns false.
- */
-export function IsARM64() {
-    return environmentCache.Arch === "arm64";
-}
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+
+import {newRuntimeCallerWithID, objectNames} from "./runtime";
+let call = newRuntimeCallerWithID(objectNames.System, '');
+const systemIsDarkMode = 0;
+const environment = 1;
+
+const _invoke = (() => {
+    try {
+        if(window?.chrome?.webview) {
+            return (msg) => window.chrome.webview.postMessage(msg);
+        }
+        if(window?.webkit?.messageHandlers?.external) {
+            return (msg) => window.webkit.messageHandlers.external.postMessage(msg);
+        }
+    } catch(e) {
+        console.warn('\n%c⚠️ Browser Environment Detected %c\n\n%cOnly UI previews are available in the browser. For full functionality, please run the application in desktop mode.\nMore information at: https://v3.wails.io/learn/build/#using-a-browser-for-development\n',
+            'background: #ffffff; color: #000000; font-weight: bold; padding: 4px 8px; border-radius: 4px; border: 2px solid #000000;',
+            'background: transparent;',
+            'color: #ffffff; font-style: italic; font-weight: bold;');
+    }
+    return null;
+})();
+
+export function invoke(msg) {
+    if (!_invoke) return;
+    return _invoke(msg);
+}
+
+/**
+ * @function
+ * Retrieves the system dark mode status.
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean value indicating if the system is in dark mode.
+ */
+export function IsDarkMode() {
+    return call(systemIsDarkMode);
+}
+
+/**
+ * Fetches the capabilities of the application from the server.
+ *
+ * @async
+ * @function Capabilities
+ * @returns {Promise<Object>} A promise that resolves to an object containing the capabilities.
+ */
+export function Capabilities() {
+    let response = fetch("/wails/capabilities");
+    return response.json();
+}
+
+/**
+ * @typedef {Object} OSInfo
+ * @property {string} Branding - The branding of the OS.
+ * @property {string} ID - The ID of the OS.
+ * @property {string} Name - The name of the OS.
+ * @property {string} Version - The version of the OS.
+ */
+
+/**
+ * @typedef {Object} EnvironmentInfo
+ * @property {string} Arch - The architecture of the system.
+ * @property {boolean} Debug - True if the application is running in debug mode, otherwise false.
+ * @property {string} OS - The operating system in use.
+ * @property {OSInfo} OSInfo - Details of the operating system.
+ * @property {Object} PlatformInfo - Additional platform information.
+ */
+
+/**
+ * @function
+ * Retrieves environment details.
+ * @returns {Promise<EnvironmentInfo>} - A promise that resolves to an object containing OS and system architecture.
+ */
+export function Environment() {
+    return call(environment);
+}
+
+/**
+ * Checks if the current operating system is Windows.
+ *
+ * @return {boolean} True if the operating system is Windows, otherwise false.
+ */
+export function IsWindows() {
+    return window._wails.environment.OS === "windows";
+}
+
+/**
+ * Checks if the current operating system is Linux.
+ *
+ * @returns {boolean} Returns true if the current operating system is Linux, false otherwise.
+ */
+export function IsLinux() {
+    return window._wails.environment.OS === "linux";
+}
+
+/**
+ * Checks if the current environment is a macOS operating system.
+ *
+ * @returns {boolean} True if the environment is macOS, false otherwise.
+ */
+export function IsMac() {
+    return window._wails.environment.OS === "darwin";
+}
+
+/**
+ * Checks if the current environment architecture is AMD64.
+ * @returns {boolean} True if the current environment architecture is AMD64, false otherwise.
+ */
+export function IsAMD64() {
+    return window._wails.environment.Arch === "amd64";
+}
+
+/**
+ * Checks if the current architecture is ARM.
+ *
+ * @returns {boolean} True if the current architecture is ARM, false otherwise.
+ */
+export function IsARM() {
+    return window._wails.environment.Arch === "arm";
+}
+
+/**
+ * Checks if the current environment is ARM64 architecture.
+ *
+ * @returns {boolean} - Returns true if the environment is ARM64 architecture, otherwise returns false.
+ */
+export function IsARM64() {
+    return window._wails.environment.Arch === "arm64";
+}
+
+export function IsDebug() {
+    return window._wails.environment.Debug === true;
+}
+