@wailsio/runtime 3.0.0-alpha.5 → 3.0.0-alpha.56

package/dialogs.js

@@ -1,138 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-/**
- * @typedef {import("./types").MessageDialogOptions} MessageDialogOptions
- * @typedef {import("./types").OpenDialogOptions} OpenDialogOptions
- * @typedef {import("./types").SaveDialogOptions} SaveDialogOptions
- */
-
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-
-import { nanoid } from 'nanoid/non-secure';
-
-// 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 {object} 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}
- */
-export function dialogCallback(id, data, isJSON) {
-    let p = dialogResponses.get(id);
-    if (p) {
-        if (isJSON) {
-            p.resolve(JSON.parse(data));
-        } else {
-            p.resolve(data);
-        }
-        dialogResponses.delete(id);
-    }
-}
-
-/**
- * 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, message) {
-    let p = dialogResponses.get(id);
-    if (p) {
-        p.reject(message);
-        dialogResponses.delete(id);
-    }
-}
-
-
-// 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 {OpenDialogOptions} 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 {SaveDialogOptions} 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);

package/flags.js

@@ -1,63 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-let flags = new Map();
-
-function convertToMap(obj) {
-    const map = new Map();
-
-    for (const [key, value] of Object.entries(obj)) {
-        if (typeof value === 'object' && value !== null) {
-            map.set(key, convertToMap(value)); // Recursively convert nested object
-        } else {
-            map.set(key, value);
-        }
-    }
-
-    return map;
-}
-
-fetch("/wails/flags").then((response) => {
-    response.json().then((data) => {
-        flags = convertToMap(data);
-    });
-});
-
-
-function getValueFromMap(keyString) {
-    const keys = keyString.split('.');
-    let value = flags;
-
-    for (const key of keys) {
-        if (value instanceof Map) {
-            value = value.get(key);
-        } else {
-            value = value[key];
-        }
-
-        if (value === undefined) {
-            break;
-        }
-    }
-
-    return value;
-}
-
-/**
- * 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) {
-    return getValueFromMap(keyString);
-}

package/index.js

@@ -1,56 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-import {setupContextMenus} from "./contextmenu";
-import {setupDrag} from "./drag";
-import {reloadWML} from "./wml";
-import {Emit, Off, OffAll, On, Once, OnMultiple, WailsEvent} from './events';
-import {ByID, ByName, Plugin} from "./calls";
-import {Error, Info, OpenFile, Question, SaveFile, Warning} from "./dialogs";
-
-export * as Application from "./application";
-export * as Browser from "./browser";
-export * as Clipboard from "./clipboard";
-export * as ContextMenu from "./contextmenu";
-export * as Flags from "./flags";
-export * as Runtime from "./runtime";
-export * as Screens from "./screens";
-export * as System from "./system";
-export * as Window from "./window";
-
-export const Events = {
-    On,
-    Off,
-    OnMultiple,
-    WailsEvent,
-    OffAll,
-    Emit,
-    Once
-
-}
-
-export const Call = {
-    Plugin,
-    ByID,
-    ByName
-}
-
-export const Dialogs = {
-    Info,
-    Error,
-    OpenFile, Question, Warning, SaveFile
-}
-
-setupContextMenus();
-setupDrag();
-
-document.addEventListener("DOMContentLoaded", function () {
-    reloadWML();
-});

package/runtime.js

@@ -1,122 +0,0 @@
-/*
- _     __     _ __
-| |  / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-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));
-    });
-}

package/screens.js

@@ -1,45 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-/**
- * @typedef {import("./api/types").Screen} 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/types.d.ts

@@ -1,130 +0,0 @@
-
-export interface Button {
-    // The label of the button
-    Label?: string;
-    // True if this button is the cancel button (selected when pressing escape)
-    IsCancel?: boolean;
-    // True if this button is the default button (selected when pressing enter)
-    IsDefault?: boolean;
-}
-
-interface MessageDialogOptions {
-    // The title for the dialog
-    Title?: string;
-    // The message to display
-    Message?: string;
-    // The buttons to use on the dialog
-    Buttons?: Button[];
-    // Whether the dialog is detached from the current window
-    Detached?: boolean;
-}
-
-export interface OpenFileDialogOptions {
-    // Allows the user to be able to select directories
-    CanChooseDirectories?: boolean;
-    // Allows the user to be able to select files
-    CanChooseFiles?: boolean;
-    // Provide an option to create directories in the dialog
-    CanCreateDirectories?: boolean;
-    // Makes the dialog show hidden files
-    ShowHiddenFiles?: boolean;
-    // Whether the dialog should follow filesystem aliases
-    ResolvesAliases?: boolean;
-    // Allow the user to select multiple files or directories
-    AllowsMultipleSelection?: boolean;
-    // Hide the extension when showing the filename
-    HideExtension?: boolean;
-    // Allow the user to select files where the system hides their extensions
-    CanSelectHiddenExtension?: boolean;
-    // Treats file packages as directories, e.g. .app on macOS
-    TreatsFilePackagesAsDirectories?: boolean;
-    // Allows selection of filetypes not specified in the filters
-    AllowsOtherFiletypes?: boolean;
-    // The file filters to use in the dialog
-    Filters?: FileFilter[];
-    // The title of the dialog
-    Title?: string;
-    // The message to display
-    Message?: string;
-    // The label for the select button
-    ButtonText?: string;
-    // The default directory to open the dialog in
-    Directory?: string;
-    // Whether the dialog is detached from the current window
-    Detached?: boolean;
-}
-export interface FileFilter {
-    // The display name for the filter, e.g. "Text Files"
-    DisplayName?: string;
-    // The pattern to use for the filter, e.g. "*.txt;*.md"
-    Pattern?: string;
-}
-export interface SaveFileDialogOptions {
-    // Provide an option to create directories in the dialog
-    CanCreateDirectories?: boolean;
-    // Makes the dialog show hidden files
-    ShowHiddenFiles?: boolean;
-    // Allow the user to select files where the system hides their extensions
-    CanSelectHiddenExtension?: boolean;
-    // Allows selection of filetypes not specified in the filters
-    AllowOtherFiletypes?: boolean;
-    // Hide the extension when showing the filename
-    HideExtension?: boolean;
-    // Treats file packages as directories, e.g. .app on macOS
-    TreatsFilePackagesAsDirectories?: boolean;
-    // The message to show in the dialog
-    Message?: string;
-    // The default directory to open the dialog in
-    Directory?: string;
-    // The default filename to use in the dialog
-    Filename?: string;
-    // The label for the select button
-    ButtonText?: string;
-    // Whether the dialog is detached from the current window
-    Detached?: boolean;
-}
-
-export interface Screen {
-    // The screen ID
-    Id: string;
-    // The screen name
-    Name: string;
-    // The screen scale. 1 = standard resolution, 2: 2x retina, etc.
-    Scale: number;
-    // The X position of the screen
-    X: number;
-    // The Y position of the screen
-    Y: number;
-    // The width and height of the screen
-    Size: Size;
-    // The bounds of the screen
-    Bounds: Rect;
-    // The work area of the screen
-    WorkArea: Rect;
-    // True if this is the primary screen
-    IsPrimary: boolean;
-    // The rotation of the screen
-    Rotation: number;
-}
-export interface Rect {
-    X: number;
-    Y: number;
-    Width: number;
-    Height: number;
-}
-
-export interface WailsEvent {
-    // The name of the event
-    Name: string;
-    // The data associated with the event
-    Data?: any;
-}
-
-export interface Size {
-    Width: number;
-    Height: number;
-}
-export interface Position {
-    X: number;
-    Y: number;
-}

package/window.js

@@ -1,122 +0,0 @@
-/*
- _	   __	  _ __
-| |	 / /___ _(_) /____
-| | /| / / __ `/ / / ___/
-| |/ |/ / /_/ / / (__  )
-|__/|__/\__,_/_/_/____/
-The electron alternative for Go
-(c) Lea Anthony 2019-present
-*/
-
-/* jshint esversion: 9 */
-
-/**
- * @typedef {import("../api/types").Size} Size
- * @typedef {import("../api/types").Position} Position
- * @typedef {import("../api/types").Screen} Screen
- */
-
-import {newRuntimeCallerWithID, objectNames} from "./runtime";
-
-const center = 0;
-const setTitle = 1;
-const fullscreen = 2;
-const unFullscreen = 3;
-const setSize = 4;
-const size = 5;
-const setMaxSize = 6;
-const setMinSize = 7;
-const setAlwaysOnTop = 8;
-const setRelativePosition = 9;
-const relativePosition = 10;
-const screen = 11;
-const hide = 12;
-const maximise = 13;
-const unMaximise = 14;
-const toggleMaximise = 15;
-const minimise = 16;
-const unMinimise = 17;
-const restore = 18;
-const show = 19;
-const close = 20;
-const setBackgroundColour = 21;
-const setResizable = 22;
-const width = 23;
-const height = 24;
-const zoomIn = 25;
-const zoomOut = 26;
-const zoomReset = 27;
-const getZoomLevel = 28;
-const setZoomLevel = 29;
-
-const thisWindow = newRuntimeCallerWithID(objectNames.Window, '');
-
-function createWindow(call) {
-    return {
-        Get: (windowName) => createWindow(newRuntimeCallerWithID(objectNames.Window, windowName)),
-        Center: () => call(center),
-        SetTitle: (title) => call(setTitle, {title}),
-        Fullscreen: () => call(fullscreen),
-        UnFullscreen: () => call(unFullscreen),
-        SetSize: (width, height) => call(setSize, {width, height}),
-        Size: () => call(size),
-        SetMaxSize: (width, height) => call(setMaxSize, {width, height}),
-        SetMinSize: (width, height) => call(setMinSize, {width, height}),
-        SetAlwaysOnTop: (onTop) => call(setAlwaysOnTop, {alwaysOnTop: onTop}),
-        SetRelativePosition: (x, y) => call(setRelativePosition, {x, y}),
-        RelativePosition: () => call(relativePosition),
-        Screen: () => call(screen),
-        Hide: () => call(hide),
-        Maximise: () => call(maximise),
-        UnMaximise: () => call(unMaximise),
-        ToggleMaximise: () => call(toggleMaximise),
-        Minimise: () => call(minimise),
-        UnMinimise: () => call(unMinimise),
-        Restore: () => call(restore),
-        Show: () => call(show),
-        Close: () => call(close),
-        SetBackgroundColour: (r, g, b, a) => call(setBackgroundColour, {r, g, b, a}),
-        SetResizable: (resizable) => call(setResizable, {resizable}),
-        Width: () => call(width),
-        Height: () => call(height),
-        ZoomIn: () => call(zoomIn),
-        ZoomOut: () => call(zoomOut),
-        ZoomReset: () => call(zoomReset),
-        GetZoomLevel: () => call(getZoomLevel),
-        SetZoomLevel: (zoomLevel) => call(setZoomLevel, {zoomLevel}),
-    };
-}
-
-/**
- * Gets the specified window.
- *
- * @param {string} windowName - The name of the window to get.
- * @return {Object} - The specified window object.
- */
-export function Get(windowName) {
-    return createWindow(newRuntimeCallerWithID(objectNames.Window, windowName));
-}
-
-/**
- * Returns a map of all methods in the current window.
- * @returns {Map} - A map of window methods.
- */
-export 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;
-}
-export default {
-    ...Get('')
-}