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

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

@@ -1,122 +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";
-}
-
-export function IsDebug() {
-    return environmentCache.Debug === true;
-}
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+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;
+}
+

package/src/utils.js

@@ -0,0 +1,86 @@
+/*
+ _     __     _ __
+| |  / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/**
+ * Logs a message to the console with custom formatting.
+ * @param {string} message - The message to be logged.
+ * @return {void}
+ */
+export function debugLog(message) {
+    // eslint-disable-next-line
+    console.log(
+        '%c wails3 %c ' + message + ' ',
+        'background: #aa0000; color: #fff; border-radius: 3px 0px 0px 3px; padding: 1px; font-size: 0.7rem',
+        'background: #009900; color: #fff; border-radius: 0px 3px 3px 0px; padding: 1px; font-size: 0.7rem'
+    );
+}
+
+/**
+ * Checks whether the browser supports removing listeners by triggering an AbortSignal
+ * (see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#signal)
+ *
+ * @return {boolean}
+ */
+export function canAbortListeners() {
+    if (!EventTarget || !AbortSignal || !AbortController)
+        return false;
+
+    let result = true;
+
+    const target = new EventTarget();
+    const controller = new AbortController();
+    target.addEventListener('test', () => { result = false; }, { signal: controller.signal });
+    controller.abort();
+    target.dispatchEvent(new CustomEvent('test'));
+
+    return result;
+}
+
+/***
+ This technique for proper load detection is taken from HTMX:
+
+ BSD 2-Clause License
+
+ Copyright (c) 2020, Big Sky Software
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ ***/
+
+let isReady = false;
+document.addEventListener('DOMContentLoaded', () => isReady = true);
+
+export function whenReady(callback) {
+    if (isReady || document.readyState === 'complete') {
+        callback();
+    } else {
+        document.addEventListener('DOMContentLoaded', callback);
+    }
+}