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

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

@@ -1,98 +1,97 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-import {IsDebug} from "./system";
-
-const call = newRuntimeCallerWithID(objectNames.ContextMenu, '');
-const ContextMenuOpen = 0;
-
-function openContextMenu(id, x, y, data) {
-    void call(ContextMenuOpen, {id, x, y, data});
-}
-
-export function setupContextMenus() {
-    window.addEventListener('contextmenu', contextMenuHandler);
-}
-
-function contextMenuHandler(event) {
-    // Check for custom context menu
-    let element = event.target;
-    let customContextMenu = window.getComputedStyle(element).getPropertyValue("--custom-contextmenu");
-    customContextMenu = customContextMenu ? customContextMenu.trim() : "";
-    if (customContextMenu) {
-        event.preventDefault();
-        let customContextMenuData = window.getComputedStyle(element).getPropertyValue("--custom-contextmenu-data");
-        openContextMenu(customContextMenu, event.clientX, event.clientY, customContextMenuData);
-        return
-    }
-
-    processDefaultContextMenu(event);
-}
-
-
-/*
---default-contextmenu: auto; (default) will show the default context menu if contentEditable is true OR text has been selected OR element is input or textarea
---default-contextmenu: show; will always show the default context menu
---default-contextmenu: hide; will always hide the default context menu
-
-This rule is inherited like normal CSS rules, so nesting works as expected
-*/
-function processDefaultContextMenu(event) {
-
-    // Debug builds always show the menu
-    if (IsDebug()) {
-        return;
-    }
-
-    // Process default context menu
-    const element = event.target;
-    const computedStyle = window.getComputedStyle(element);
-    const defaultContextMenuAction = computedStyle.getPropertyValue("--default-contextmenu").trim();
-    switch (defaultContextMenuAction) {
-        case "show":
-            return;
-        case "hide":
-            event.preventDefault();
-            return;
-        default:
-            // Check if contentEditable is true
-            if (element.isContentEditable) {
-                return;
-            }
-
-            // Check if text has been selected
-            const selection = window.getSelection();
-            const hasSelection = (selection.toString().length > 0)
-            if (hasSelection) {
-                for (let i = 0; i < selection.rangeCount; i++) {
-                    const range = selection.getRangeAt(i);
-                    const rects = range.getClientRects();
-                    for (let j = 0; j < rects.length; j++) {
-                        const rect = rects[j];
-                        if (document.elementFromPoint(rect.left, rect.top) === element) {
-                            return;
-                        }
-                    }
-                }
-            }
-            // Check if tagname is input or textarea
-            if (element.tagName === "INPUT" || element.tagName === "TEXTAREA") {
-                if (hasSelection || (!element.readOnly && !element.disabled)) {
-                    return;
-                }
-            }
-
-            // hide default context menu
-            event.preventDefault();
-    }
-}
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+
+import {newRuntimeCallerWithID, objectNames} from "./runtime";
+import {IsDebug} from "./system";
+
+// setup
+window.addEventListener('contextmenu', contextMenuHandler);
+
+const call = newRuntimeCallerWithID(objectNames.ContextMenu, '');
+const ContextMenuOpen = 0;
+
+function openContextMenu(id, x, y, data) {
+    void call(ContextMenuOpen, {id, x, y, data});
+}
+
+function contextMenuHandler(event) {
+    // Check for custom context menu
+    let element = event.target;
+    let customContextMenu = window.getComputedStyle(element).getPropertyValue("--custom-contextmenu");
+    customContextMenu = customContextMenu ? customContextMenu.trim() : "";
+    if (customContextMenu) {
+        event.preventDefault();
+        let customContextMenuData = window.getComputedStyle(element).getPropertyValue("--custom-contextmenu-data");
+        openContextMenu(customContextMenu, event.clientX, event.clientY, customContextMenuData);
+        return
+    }
+
+    processDefaultContextMenu(event);
+}
+
+
+/*
+--default-contextmenu: auto; (default) will show the default context menu if contentEditable is true OR text has been selected OR element is input or textarea
+--default-contextmenu: show; will always show the default context menu
+--default-contextmenu: hide; will always hide the default context menu
+
+This rule is inherited like normal CSS rules, so nesting works as expected
+*/
+function processDefaultContextMenu(event) {
+
+    // Debug builds always show the menu
+    if (IsDebug()) {
+        return;
+    }
+
+    // Process default context menu
+    const element = event.target;
+    const computedStyle = window.getComputedStyle(element);
+    const defaultContextMenuAction = computedStyle.getPropertyValue("--default-contextmenu").trim();
+    switch (defaultContextMenuAction) {
+        case "show":
+            return;
+        case "hide":
+            event.preventDefault();
+            return;
+        default:
+            // Check if contentEditable is true
+            if (element.isContentEditable) {
+                return;
+            }
+
+            // Check if text has been selected
+            const selection = window.getSelection();
+            const hasSelection = (selection.toString().length > 0)
+            if (hasSelection) {
+                for (let i = 0; i < selection.rangeCount; i++) {
+                    const range = selection.getRangeAt(i);
+                    const rects = range.getClientRects();
+                    for (let j = 0; j < rects.length; j++) {
+                        const rect = rects[j];
+                        if (document.elementFromPoint(rect.left, rect.top) === element) {
+                            return;
+                        }
+                    }
+                }
+            }
+            // Check if tagname is input or textarea
+            if (element.tagName === "INPUT" || element.tagName === "TEXTAREA") {
+                if (hasSelection || (!element.readOnly && !element.disabled)) {
+                    return;
+                }
+            }
+
+            // hide default context menu
+            event.preventDefault();
+    }
+}

package/src/create.js

@@ -0,0 +1,125 @@
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+
+/**
+ * Any is a dummy creation function for simple or unknown types.
+ * @template T
+ * @param {any} source
+ * @returns {T}
+ */
+export function Any(source) {
+    return /** @type {T} */(source);
+}
+
+/**
+ * ByteSlice is a creation function that replaces
+ * null strings with empty strings.
+ * @param {any} source
+ * @returns {string}
+ */
+export function ByteSlice(source) {
+    return /** @type {any} */((source == null) ? "" : source);
+}
+
+/**
+ * Array takes a creation function for an arbitrary type
+ * and returns an in-place creation function for an array
+ * whose elements are of that type.
+ * @template T
+ * @param {(source: any) => T} element
+ * @returns {(source: any) => T[]}
+ */
+export function Array(element) {
+    if (element === Any) {
+        return (source) => (source === null ? [] : source);
+    }
+
+    return (source) => {
+        if (source === null) {
+            return [];
+        }
+        for (let i = 0; i < source.length; i++) {
+            source[i] = element(source[i]);
+        }
+        return source;
+    };
+}
+
+/**
+ * Map takes creation functions for two arbitrary types
+ * and returns an in-place creation function for an object
+ * whose keys and values are of those types.
+ * @template K, V
+ * @param {(source: any) => K} key
+ * @param {(source: any) => V} value
+ * @returns {(source: any) => { [_: K]: V }}
+ */
+export function Map(key, value) {
+    if (value === Any) {
+        return (source) => (source === null ? {} : source);
+    }
+
+    return (source) => {
+        if (source === null) {
+            return {};
+        }
+        for (const key in source) {
+            source[key] = value(source[key]);
+        }
+        return source;
+    };
+}
+
+/**
+ * Nullable takes a creation function for an arbitrary type
+ * and returns a creation function for a nullable value of that type.
+ * @template T
+ * @param {(source: any) => T} element
+ * @returns {(source: any) => (T | null)}
+ */
+export function Nullable(element) {
+    if (element === Any) {
+        return Any;
+    }
+
+    return (source) => (source === null ? null : element(source));
+}
+
+/**
+ * Struct takes an object mapping field names to creation functions
+ * and returns an in-place creation function for a struct.
+ * @template {{ [_: string]: ((source: any) => any) }} T
+ * @template {{ [Key in keyof T]?: ReturnType<T[Key]> }} U
+ * @param {T} createField
+ * @returns {(source: any) => U}
+ */
+export function Struct(createField) {
+    let allAny = true;
+    for (const name in createField) {
+        if (createField[name] !== Any) {
+            allAny = false;
+            break;
+        }
+    }
+    if (allAny) {
+        return Any;
+    }
+
+    return (source) => {
+        for (const name in createField) {
+            if (name in source) {
+                source[name] = createField[name](source[name]);
+            }
+        }
+        return source;
+    };
+}

package/src/dialogs.js

@@ -0,0 +1,200 @@
+/*
+ _	   __	  _ __
+| |	 / /___ _(_) /____
+| | /| / / __ `/ / / ___/
+| |/ |/ / /_/ / / (__  )
+|__/|__/\__,_/_/_/____/
+The electron alternative for Go
+(c) Lea Anthony 2019-present
+*/
+
+/* jshint esversion: 9 */
+
+/**
+ * @typedef {Object} OpenFileDialogOptions
+ * @property {boolean} [CanChooseDirectories] - Indicates if directories can be chosen.
+ * @property {boolean} [CanChooseFiles] - Indicates if files can be chosen.
+ * @property {boolean} [CanCreateDirectories] - Indicates if directories can be created.
+ * @property {boolean} [ShowHiddenFiles] - Indicates if hidden files should be shown.
+ * @property {boolean} [ResolvesAliases] - Indicates if aliases should be resolved.
+ * @property {boolean} [AllowsMultipleSelection] - Indicates if multiple selection is allowed.
+ * @property {boolean} [HideExtension] - Indicates if the extension should be hidden.
+ * @property {boolean} [CanSelectHiddenExtension] - Indicates if hidden extensions can be selected.
+ * @property {boolean} [TreatsFilePackagesAsDirectories] - Indicates if file packages should be treated as directories.
+ * @property {boolean} [AllowsOtherFiletypes] - Indicates if other file types are allowed.
+ * @property {FileFilter[]} [Filters] - Array of file filters.
+ * @property {string} [Title] - Title of the dialog.
+ * @property {string} [Message] - Message to show in the dialog.
+ * @property {string} [ButtonText] - Text to display on the button.
+ * @property {string} [Directory] - Directory to open in the dialog.
+ * @property {boolean} [Detached] - Indicates if the dialog should appear detached from the main window.
+ */
+
+
+/**
+ * @typedef {Object} SaveFileDialogOptions
+ * @property {string} [Filename] - Default filename to use in the dialog.
+ * @property {boolean} [CanChooseDirectories] - Indicates if directories can be chosen.
+ * @property {boolean} [CanChooseFiles] - Indicates if files can be chosen.
+ * @property {boolean} [CanCreateDirectories] - Indicates if directories can be created.
+ * @property {boolean} [ShowHiddenFiles] - Indicates if hidden files should be shown.
+ * @property {boolean} [ResolvesAliases] - Indicates if aliases should be resolved.
+ * @property {boolean} [AllowsMultipleSelection] - Indicates if multiple selection is allowed.
+ * @property {boolean} [HideExtension] - Indicates if the extension should be hidden.
+ * @property {boolean} [CanSelectHiddenExtension] - Indicates if hidden extensions can be selected.
+ * @property {boolean} [TreatsFilePackagesAsDirectories] - Indicates if file packages should be treated as directories.
+ * @property {boolean} [AllowsOtherFiletypes] - Indicates if other file types are allowed.
+ * @property {FileFilter[]} [Filters] - Array of file filters.
+ * @property {string} [Title] - Title of the dialog.
+ * @property {string} [Message] - Message to show in the dialog.
+ * @property {string} [ButtonText] - Text to display on the button.
+ * @property {string} [Directory] - Directory to open in the dialog.
+ * @property {boolean} [Detached] - Indicates if the dialog should appear detached from the main window.
+ */
+
+/**
+ * @typedef {Object} MessageDialogOptions
+ * @property {string} [Title] - The title of the dialog window.
+ * @property {string} [Message] - The main message to show in the dialog.
+ * @property {Button[]} [Buttons] - Array of button options to show in the dialog.
+ * @property {boolean} [Detached] - True if the dialog should appear detached from the main window (if applicable).
+ */
+
+/**
+ * @typedef {Object} Button
+ * @property {string} [Label] - Text that appears within the button.
+ * @property {boolean} [IsCancel] - True if the button should cancel an operation when clicked.
+ * @property {boolean} [IsDefault] - True if the button should be the default action when the user presses enter.
+ */
+
+/**
+ * @typedef {Object} FileFilter
+ * @property {string} [DisplayName] - Display name for the filter, it could be "Text Files", "Images" etc.
+ * @property {string} [Pattern] - Pattern to match for the filter, e.g. "*.txt;*.md" for text markdown files.
+ */
+
+// setup
+window._wails = window._wails || {};
+window._wails.dialogErrorCallback = dialogErrorCallback;
+window._wails.dialogResultCallback = dialogResultCallback;
+
+import {newRuntimeCallerWithID, objectNames} from "./runtime";
+
+import { nanoid } from './nanoid.js';
+
+// Define constants from the `methods` object in Title Case
+const DialogInfo = 0;
+const DialogWarning = 1;
+const DialogError = 2;
+const DialogQuestion = 3;
+const DialogOpenFile = 4;
+const DialogSaveFile = 5;
+
+const call = newRuntimeCallerWithID(objectNames.Dialog, '');
+const dialogResponses = new Map();
+
+/**
+ * Generates a unique id that is not present in dialogResponses.
+ * @returns {string} unique id
+ */
+function generateID() {
+    let result;
+    do {
+        result = nanoid();
+    } while (dialogResponses.has(result));
+    return result;
+}
+
+/**
+ * Shows a dialog of specified type with the given options.
+ * @param {number} type - type of dialog
+ * @param {MessageDialogOptions|OpenFileDialogOptions|SaveFileDialogOptions} options - options for the dialog
+ * @returns {Promise} promise that resolves with result of dialog
+ */
+function dialog(type, options = {}) {
+    const id = generateID();
+    options["dialog-id"] = id;
+    return new Promise((resolve, reject) => {
+        dialogResponses.set(id, {resolve, reject});
+        call(type, options).catch((error) => {
+            reject(error);
+            dialogResponses.delete(id);
+        });
+    });
+}
+
+/**
+ * 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}
+ */
+function dialogResultCallback(id, data, isJSON) {
+    let p = dialogResponses.get(id);
+    if (p) {
+        dialogResponses.delete(id);
+        if (isJSON) {
+            p.resolve(JSON.parse(data));
+        } else {
+            p.resolve(data);
+        }
+    }
+}
+
+/**
+ * Callback function for handling errors in dialog.
+ *
+ * @param {string} id - The id of the dialog response.
+ * @param {string} message - The error message.
+ *
+ * @return {void}
+ */
+function dialogErrorCallback(id, message) {
+    let p = dialogResponses.get(id);
+    if (p) {
+        dialogResponses.delete(id);
+        p.reject(new Error(message));
+    }
+}
+
+
+// Replace `methods` with constants in Title Case
+
+/**
+ * @param {MessageDialogOptions} options - Dialog options
+ * @returns {Promise<string>} - The label of the button pressed
+ */
+export const Info = (options) => dialog(DialogInfo, options);
+
+/**
+ * @param {MessageDialogOptions} options - Dialog options
+ * @returns {Promise<string>} - The label of the button pressed
+ */
+export const Warning = (options) => dialog(DialogWarning, options);
+
+/**
+ * @param {MessageDialogOptions} options - Dialog options
+ * @returns {Promise<string>} - The label of the button pressed
+ */
+export const Error = (options) => dialog(DialogError, options);
+
+/**
+ * @param {MessageDialogOptions} options - Dialog options
+ * @returns {Promise<string>} - The label of the button pressed
+ */
+export const Question = (options) => dialog(DialogQuestion, options);
+
+/**
+ * @param {OpenFileDialogOptions} options - Dialog options
+ * @returns {Promise<string[]|string>} Returns selected file or list of files. Returns blank string if no file is selected.
+ */
+export const OpenFile = (options) => dialog(DialogOpenFile, options);
+
+/**
+ * @param {SaveFileDialogOptions} options - Dialog options
+ * @returns {Promise<string>} Returns the selected file. Returns blank string if no file is selected.
+ */
+export const SaveFile = (options) => dialog(DialogSaveFile, options);