swing-ui 0.1.25 → 1.0.1

package/types/SwingUI.d.ts

@@ -0,0 +1,727 @@
+/**
+ * Main SwingUI class that handles all communication between JavaScript and GUI and provides many utility methods not related to specific GUI components.
+ * <b>NOTE:</b> Do not instantiate this class, but instead use global `ui` constant, which is an instance of this class.
+ *
+ * See usage example below.
+ *
+ * @class
+ * @global
+ * @see ui
+ * @example <h2>Usage examples:</h2>
+ * const data = ui.clipboard(); // getting clipboard data
+ * const _screens = ui.screens; // getting screens information array
+ * ui.openURL("http://swing-ui.com/");
+ */
+export class SwingUI {
+    /**
+     * @internal
+     * @private
+     */
+    private static WorkerSignalIndex;
+    /**
+     * @internal
+     * @private
+     */
+    private static WorkerSignal;
+    /**
+     * <b>NOTE:</b> Do not instantiate this class. It's already instantiated and assigned to a global variable `ui`.
+     * @internal
+     * @private
+     */
+    private constructor();
+    /**
+     * @internal
+     * @private
+     */
+    private stats;
+    /**
+     * @internal
+     * @private
+     */
+    private gui_process_id;
+    /**
+     * @internal
+     * @private
+     */
+    private callback;
+    /**
+     * @internal
+     * @private
+     */
+    private _msg;
+    InitGUIProcess(): Promise<void>;
+    /**
+     * Send a messages to GUI process via STD out. Use internally for communication only.
+     * @param {Object} msg - JSON Object message to send to GUI.
+     * @param {function(any):any} [callback] - Only pass callback to block event loop and wait for response
+     * @return {any|void} Returns response from GUI or undefined.
+     * @internal
+     * @ignore
+     */
+    sendToGUI(msg: Object, callback?: (arg0: any) => any): any | void;
+    /**
+     * Immediately sends all queued messages to GUI without waiting for queue threshold or execution end. It's similar to flush() function in data streams.
+     * It can be used to force messages to be sent imedietly instead of waiting for message queue to be full, if it's important to update some UI component or content right away.
+     * It may improve performance to set `compress` to `false` to skip compression for already compressed data, such as UI component's background image or large icon.
+     *
+     * @param {boolean} [compress=true] - Whether to compress messages before sending.
+     * @return {this} Returns `this` instance for chaining.
+     * @example <h2>Sending queued messages before proceeding:</h2>
+     * ui.sendMessageQueue();
+     *
+     * @example <h2>Sending queued messages without compressing:</h2>
+     * ui.sendMessageQueue(false);
+     */
+    sendMessageQueue(compress?: boolean): this;
+    /**
+     * Returns a detected or specified application root directory.
+     *
+     * @readonly
+     * @type {string}
+     */
+    readonly get rootDirectory(): string;
+    /**
+     * Gets the JavaScript runtime name ("node", "bun", "deno", or "unknown"). Useful when building an application compatible with multiple JavaScript runtimes.
+     * @type {string}
+     * @readonly
+     * @example <h2>Getting current JavaScript runtime:</h2>
+     * console.log(ui.runtime);
+     * // prints "node", or what ever your runtime is.
+     */
+    readonly get runtime(): string;
+    /**
+     * Returns a short identifier of an operating system on current machine. Possible values: "windows", "linux", "darwin" (for MacOS), "freebsd", "openbsd", "sunos", and "android".
+     * @type {string}
+     * @readonly
+     * @example <h2>Getting a short identifier of an operating system:</h2>
+     * console.log(ui.os); // e.g., prints "windows"
+     */
+    readonly get os(): string;
+    /**
+     * Getter property that returns an array of available UI look and feel IDs on your system. For example Windows OS can have a Windows look and feel that linux doesn't have. Use them to set the desired look and feel using ui.ui(id) method.
+     *
+     * @readonly
+     * @see {@link SwingUI#ui|ui.ui(id)}
+     * @type {string[]}
+     */
+    readonly get list(): string[];
+    /**
+     * Returns an array of screen objects [{x,y,width,height}] that are configured on this computer. X and Y is the position of screens relative to one virtual screen. It's useful when you have multiple screens.
+     *
+     * @readonly
+     * @type {Object[]}
+     * @example <h2>Getting a list of screens:</h2>
+     * console.debug(ui.screens);
+     *
+     * // Example of returned array:
+     * [
+     *   {
+     *     default: true,
+     *     id: '\\Display0',
+     *     description: 'Win32GraphicsDevice[screen=0]',
+     *     x: 0,
+     *     y: 0,
+     *     width: 2560,
+     *     height: 1080,
+     *     refresh_rate: 59,
+     *     bit_depth: 32,
+     *     type: 'screen'
+     *   },
+     *   {
+     *     default: false,
+     *     id: '\\Display1',
+     *     description: 'Win32GraphicsDevice[screen=1]',
+     *     x: -1280,
+     *     y: 255,
+     *     width: 1280,
+     *     height: 1024,
+     *     refresh_rate: 60,
+     *     bit_depth: 32,
+     *     type: 'screen'
+     *   }
+     * ]
+     */
+    readonly get screens(): Object[];
+    /**
+     * Checks if current operating system supports system tray icons.
+     *
+     * @readonly
+     * @type {boolean}
+     */
+    readonly get systemTraySupported(): boolean;
+    /**
+     * Gets a GUI software license information stored in the package.json file of your project.
+     *
+     * @readonly
+     * @type {Object}
+     */
+    readonly get license(): Object;
+    /**
+     * Gets and returns a swing-ui module version from package.json file.
+     *
+     * @readonly
+     * @type {string}
+     */
+    readonly get version(): string;
+    /**
+     * Returns details of memory usage by GUI process.
+     *
+     * @readonly
+     * @type {Object}
+     * @example <h2>Getting RAM details about the GUI process:</h2>
+     * console.log(ui.memoryUsage);
+     *
+     * // Example output
+     * {
+     *   total: 268435456,
+     *   max: 4263510016,
+     *   max_heap: 4263510016,
+     *   used: 23540264,
+     *   non_heap: 39226904,
+     *   free: 244895192,
+     *   heap: 21443112
+     * }
+     */
+    readonly get memoryUsage(): Object;
+    /**
+     * Returns an array of fonts installed on the system.
+     *
+     * @readonly
+     * @type {string[]}
+     * @example <h2>Getting a list of fonts installed on the system:</h2>
+     * console.log(ui.fonts);
+     *
+     * // example output:
+     * [
+     *   'Adobe Arabic',
+     *   'Adobe Caslon Pro',
+     *   'Adobe Caslon Pro Bold',
+     *   ...
+     * ]
+     */
+    readonly get fonts(): string[];
+    /**
+     * A getter to get environment variables.
+     *
+     * @readonly
+     * @type {object}
+     */
+    readonly get env(): object;
+    /**
+     * Gets a current process ID
+     *
+     * @readonly
+     * @type {number}
+     */
+    readonly get pid(): number;
+    /**
+     * Performs garbage collection in JavaScript and GUI.
+     * @return {SwingUI} Returns an instance of SwingUI object for method chaining.
+     * @example <h2>Usage example:</h2>
+     * ui.gc();
+     */
+    gc(): SwingUI;
+    /**
+     * Increases and decreases default font size of all UI components.
+     *
+     * @param {number} by - By how many pixels to adjust font size (positive integer increases size, negative decreases)
+     * @return {this} Returns an instance of SwingUI object for method chaining.
+     */
+    adjustFontSize(by: number): this;
+    /**
+     * Increases and decreases default font size of all controls.
+     *
+     * @param {number} by - By how much to adjust font size (positive increases size, negative decreases)
+     * @return {this} Returns an instance of SwingUI object for method chaining.
+     */
+    adjustDefaultFontSize(by: number): this;
+    /**
+     * Sets default font to be used by all components. Any font property may be changed (name, size, bold, etc.)
+     *
+     * @param {Font} font - New font
+     * @returns {this} Returns an instance of SwingUI object for method chaining.
+     */
+    setDefaultFont(font: Font): this;
+    /**
+     * Sets or reads clipboard content data. Data types must be values of object (enum) DataType.
+     *
+     * @param {object} [data] - Object ob data to be stored in a clipboard {Type: data}. See example below.
+     * @returns {object|SwingUI} When setting arguments, `this` instance of SwingUI is returned, otherwise clipboard data object is returned.
+     * @see DataType
+     * @example <h2>Valid data types for the clipboard data object:</h2>
+     * // Sets all possible data types to clipboard
+     * ui.clipboard({
+     *     Text: "text to copy",
+     *     HTML: "<b>HTML Content</b>",
+     *     JSON: object,
+     *     Image: "base64 encoded image data",
+     *     URIList: ["http://url_1.com", "http://url_2.com"],
+     *     Files: ["C://my_file.txt", ...],
+     *     URL: "http://url.com"
+     * });
+     * @example <h2>Setting some plain text and HTML data to clipboard:</h2>
+     * const data = {};
+     * data[DataType.Text] = "Plain text content";
+     * data[DataType.HTML] = "<b>HTML Content</b>";
+     * ui.clipboard(data);
+     */
+    clipboard(...args: any[]): object | SwingUI;
+    /**
+     *  Sets or gets boolean whether the layout of containers is validated during resizing, or after resizing is complete.
+     *
+     * @param {boolean} [value] - Enables or disables dynamic layout
+     * @return {boolean|SwingUI} When setting arguments, `this` instance of SwingUI is returned, otherwise current value is returned.
+     */
+    dynamicLayout(...args: any[]): boolean | SwingUI;
+    /**
+     * Gets or sets Java's GUI look and feel ID. Obtain a list of supported UIs by the system using ui.list getter property.
+     *
+     * @param {string} [id] - Identifies of Java Swing's UI to be used.
+     * @param {object} [options] - Additional look-and-feel options. Options apply only to some look-and-feels, like FlatLaf. Example: {border-radius: 5}.
+     * @return {string|SwingUI} When setting arguments, `this` instance of SwingUI is returned, otherwise current value is returned.
+     * @throws Error When argument is invalid.
+     * @see SwingUI#list
+     * @example <h2>Setting FlatDarkLaf UI with all options</h2>
+     * ui.ui(
+     *   "FlatDarkLaf",
+     *   {
+     *     borderRadius:8,
+     *     showScrollbarButtons: true,
+     *     scrollbarSize: 14,
+     *     selectedTabColor: "#FFFFFF",
+     *     scrollbarColor: "#FF7777",
+     *     arrowType: "triangle" // "triangle" or "chevron" (default)
+     *   }
+     * );
+     */
+    ui(...args: any[]): string | SwingUI;
+    /**
+     * Shows a message dialog window like alert() in web browser.
+     *
+     * @param {string} message
+     * @param {string} [title] - Message window title
+     * @param {MessageIcon} [icon] - Use: MessageIcon.[Info|Warning|Error]
+     * @param {Window} [ownerWindow] - If set, the message dialog window will attempts to be centered at specified window
+     * @return {void} Does not return a value.
+     */
+    showMessage(message: string, title?: string, icon?: MessageIcon, ownerWindow?: Window): void;
+    /**
+     * Sets a custom Error handler when error events come if from GUI. Event object has a "e.message" parameter, and
+     * may have "e.target" that references a component related to the error.
+     * e:{
+     *     message (always)
+     *     target: (when component is related to the error)
+     * }
+     * @param {function(Object):any} callback - Function to be called instead of default error handling.
+     * @return {SwingUI} Returns `this` instance of SwingUI class.
+     */
+    onError(callback: (arg0: Object) => any): SwingUI;
+    /**
+     * Gets or sets text rendering mode used in UI components.
+     *
+     * @param {string} [mode] - Specifies font antialiasing mode to use (on|lcd|gasp|off) (NOT IMPLEMENTED YET).
+     * @returns {string|null} Returns font antialiasing mode: `on`, `lcd`, `gasp`, `off`, or `null` object if font antialiasing could not be detected.
+     */
+    fontAntialiasing(...args: any[]): string | null;
+    /**
+     *  Gets or sets the event throttle interval for high-frequency events, like mouse motion or resizing. Value is in milliseconds, so 100 means no more than 10 same type of events per component per second.
+     *  Applies only to some high frequency events, such as resizing and moving.
+     *
+     * @param {number} [ms] - Minimum amount of time (in milliseconds) between same type of events per component.
+     * @return {SwingUI|number} When setting arguments, `this` instance of SwingUI is returned, otherwise current value is returned.
+     * @example <h2>Setting and getting examples:</h2>
+     * ui.eventThrottle(10); // Sets new value
+     * console.debug(ui.eventThrottle()); // prints current value
+     */
+    eventThrottle(...args: any[]): SwingUI | number;
+    /**
+     * Adjusts or retrieves the thread pool size and keep-alive time for image loading tasks.
+     * Each argument is optional. Setting `null` to any argument will not change it's value.
+     * Returns current configuration if no arguments are specified.
+     *
+     * @param {number} [min] - The minimum number of threads to keep alive (core pool size). Default is 1.
+     * @param {number} [max] - The maximum number of threads allowed (max pool size). Default is 5.
+     * @param {number} [keep_alive] - The idle time (in seconds) before excess threads are terminated when idle. Default is 5 seconds.
+     * @return {object|SwingUI}  When setting arguments, `this` instance of SwingUI is returned, otherwise current value is returned.
+     */
+    iconLoadingThreads(...args: any[]): object | SwingUI;
+    /**
+     * Requests operating system to move top-most window of this application (or all windows) to foreground before other windows. Operating may refuse to do it.
+     * To forcefully bring a specific Window to the front you can set window.alwaysOnTop(true), and then window.alwaysOnTop(false), but it should not be abused in order to maintain a positive user experience.
+     *
+     * @param {boolean} [all_windows=false] - Move all windows of this application to foreground instead of just top-most window.
+     * @returns {SwingUI} returns `this` ui object for chaining.
+     */
+    requestForeground(all_windows?: boolean): SwingUI;
+    /**
+     * Sets or gets a default menu bar that should be used by macOS at the top of the screen. If the specified menu bar was added to any parent component, it will be removed from that component.
+     * This is supported only on macOS.
+     *
+     * @param {MenuBar|null} [menu_bar] - MenuBar component. Set to `null` to remove default menu bar.
+     * @return {MenuBar|boolean} If called without parameters, a default `Menubar` component is returned or `null` of it was never set; otherwise `boolean` is returned indicating if the operation was accepted by the operating system.
+     * @throws {Error} When passed argument is not a {@link MenuBar} object.
+     */
+    defaultMenuBar(...args: any[]): MenuBar | boolean;
+    /**
+     * Gracefully exits the application with specified exit code (status code) and optional exit signal. Emits onExit() event handlers, closes connection to GUI and notifies GUI to gracefully exit. This is a recommended way to exit the application.
+     *
+     * @param {number} [exitCode] - Exit code.
+     * @param {string} [signal] - One of received exit signals: `SIGINT`, `SIGUSR1`, `SIGUSR2`, `SIGTERM`, `SIGHUP`.
+     * @return {void} Does not return a value.
+     * @example <h2>Exiting the app gracefully:</h2>
+     * ui.exit();
+     * ui.exit(10); // existing with exit code 10
+     * @see SwingUI#onExit
+     */
+    exit(exitCode?: number, signal?: string): void;
+    /**
+     * Sets and gets locking keys state (Caps lock key, Num lock key, and Scroll lock key) to ON and OFF.
+     *
+     * @param {Object} [keys] - Keys object example {caps_lock: false, num_lock: true, scroll_lock: false}. Only set keys you want to change.
+     * @return {Object|SwingUI} When setting arguments, `this` instance of SwingUI is returned, otherwise current value is returned.
+     * @example <h2>Setting Caps Lock to ON</h2>
+     * ui.lockingKeys({caps_lock: true});
+     */
+    lockingKeys(...args: any[]): Object | SwingUI;
+    /**
+     * Gets or sets a position of a pointing device. If "screen" is specified,
+     * the {x,y} position will be relative to the specified screen, otherwise
+     * the position will be set relative to screen at index 0 (default screen).
+     * You can get a list of screens with ui.screens getter.
+     *
+     * @param {number} [x] - Use only to set pointer location
+     * @param {number} [y] - required if x is specified
+     * @param {number} [screen]
+     * @return {Object | SwingUI} When setting arguments, `this` instance of SwingUI is returned, otherwise current value is returned.
+     */
+    mouseLocation(...args: any[]): Object | SwingUI;
+    /**
+     * Performs mouse button action or mouse wheel scrolling action.
+     *
+     * @param {MouseAction} action - MouseAction.[Press, Release, Click, DoubleClick, VerticalScroll, HorizontalScroll]
+     * @param {MouseButton|number} button_or_scrolls - MouseButton.[Left, Right, Middle] OR integer for scroll amount if action is MouseAction.VerticalScroll or MouseAction.HorizontalScroll
+     * @return {SwingUI} Returns `this` instance of SwingUI class.
+     * @see MouseAction
+     */
+    mouseAction(action: MouseAction, button_or_scrolls: MouseButton | number): SwingUI;
+    /**
+     * Performs a key press, key release, or key type operation. For value use one character string when using "Press" or "Release" action, or a string of text to be typed when using "Type" action.
+     *
+     * @param {KeyAction} action - KeyAction.[Press|Release|Type]
+     * @param {number|number[]|string} key_code_or_string - Key code, array of key codes, or a string, which will be converted to an array of key codes.
+     * @return {SwingUI} Returns `this` instance of SwingUI class.
+     * @see KeyAction
+     * @example <h2>Performing a key type action:</h2>
+     * ui.keyboardAction(KeyAction.Type, "A");
+     */
+    keyboardAction(action: KeyAction, key_code_or_string: number | number[] | string, ...args: any[]): SwingUI;
+    /**
+     * Returns the index of the screen whose bounds contain the given coordinate, or -1 if the point does not fall within any configured screen.
+     *
+     * Accepts either:
+     * - Separate numeric coordinates (x, y), or
+     * - A point-like object with numeric `x` and `y` properties.
+     *
+     * @param {number|Object} xOrPoint - Either the X coordinate or a point object containing {x, y}.
+     * @param {number} [y] - The Y coordinate (required if xOrPoint is a number).
+     * @returns {number} The index of the matching screen, or -1 if none matched.
+     * @throws {Error} If the input is invalid (object is missing `x` or `y` properties) or coordinates are not finite numbers.
+     *
+     * @example <h2>Using separate x and y coordinates</h2>
+     * const screenIndex = ui.screenIndexAt(1920, 540);
+     * console.log(screenIndex); // e.g. 1, or -1 if not within any screen
+     *
+     * @example <h2>Using a point object</h2>
+     * const cursor = { x: 3440, y: 1080 };
+     * const screenIndex = ui.screenIndexAt(cursor);
+     * console.log(screenIndex); // e.g. 2, or -1 if not within any screen
+     */
+    screenIndexAt(xOrPoint: number | Object, y?: number): number;
+    /**
+     * Opens provided URL in a default web browser.
+     *
+     * @param {string} url - Website address to open.
+     * @return {this} Returns `this` instance of SwingUI class.
+     */
+    openURL(url: string): this;
+    /**
+     * Opens file or a folder with a default application associated the file type, or inside a file manager application (is specified).
+     *
+     * @param {string} path - Absolute path of a local file or directory.
+     * @param {boolean} [in_file_manager=false] - Indicates if the file should be open inside a default file manager application instead of a default application associated with that file type.
+     * @return {boolean} Returns `true` if the path exists and this operation is supported by the operating system; otherwise returns `false`.
+     */
+    openPath(path: string, in_file_manager?: boolean): boolean;
+    /**
+     * Tells operating system to print a file using default file printing dialog window.
+     *
+     * @param {String} path - Absolute path of a local file to print.
+     * @return {boolean} Returns `true` if the file exists and this operation is supported by the operating system; otherwise returns `false`.
+     */
+    printFile(path: string): boolean;
+    /**
+     * Opens the default mail client’s compose window with fields pre-filled according to a `mailto:` URI.
+     * The `mailto:` URI can include message fields such as `to`, `cc`, `subject`, `body`, etc.
+     * For details, see [RFC 2368](https://www.rfc-editor.org/rfc/rfc2368) (The mailto URL scheme).
+     * In some cases an error message may provide details as to why starting the application failed.
+     *
+     * @param {string} [mailto_uri=""] - A `mailto:` URI. Leave empty to simply open the compose window without any fields filled in.
+     * @returns {boolean} Returns `true` if this action is supported by the operating system and the default mail application compose window starts successfully; otherwise returns `false`.
+     */
+    mail(mailto_uri?: string): boolean;
+    /**
+     * Synchronously pauses main thread code execution for a specified amount of milliseconds.
+     *
+     * @param {number} ms - Amount of milliseconds to sleep.
+     * @returns {boolean} Returns `true` when code execution resumed because of specified timeout, `false` for any other reason.
+     */
+    sleep(ms: number): boolean;
+    /**
+     * Synchronously checks if the file or directory exist.
+     *
+     * @param {string|URL} file_path - File or directory path to check
+     * @returns {boolean} Returns `true` if the file or directory exist; otherwise returns `false`.
+     * @throws {Error} When the file path is invalid.
+     */
+    fileExists(file_path: string | URL): boolean;
+    /**
+     * Synchronously reads a local file and returns its data.
+     * NOTE: Memory limit set by JavaScript runtime and operating system limits the file size that can be read.
+     *
+     * @param {string} file_path
+     * @param {string} [data_type="string"] - Desired return data type: `string`, `Uint8Array`, `ArrayBuffer`, `Buffer`. NOTE: `Buffer` may not be supported in all JavaScript runtimes and exception may occur.
+     * @param {string} [encoding="utf-8"] - Text encoding to use. Only applies when `data_type` argument is "string".
+     * @returns {string|Uint8Array|ArrayBuffer|Buffer} Returns the data in specified data type.
+     * @throws {Error} When the file path is invalid.
+     * @throws {Error} When file doesn't exist.
+     * @throws {Error} When file cannot be read.
+     * @throws {Error} When `data_type` parameter is invalid.
+     */
+    readFile(file_path: string, data_type?: string, encoding?: string): string | Uint8Array | ArrayBuffer | Buffer;
+    /**
+     * Writes data to a file synchronously.
+     *
+     * @param {string|URL} file_path - Local destination file path.
+     * @param {string|ArrayBuffer|Uint8Array|Buffer} data - Data to write to a file.
+     * @param {string} [mode="write"] - "write" or "append"
+     * @param {boolean} [overwrite=true] - `true` to overwrite existing file with the same path. `false` to fail and return `false` if a file with the same path already exists.
+     * @param {boolean} [create_dir=false] - `true` to create directory if it doesn't exist. `false` is default. If `false` and directory doesn't exist, an Errow will be thrown.
+     * @returns {boolean} Returns `true` on success, or throws an Error on failure.
+     * @throws {Error} When the file path is invalid.
+     * @throws {Error} When the file exists and `overwrite` argument is not `true`.
+     * @throws {Error} When access to the file is denied.
+     * @throws {Error} When directory to the specified file failed to be automatically created.
+     * @throws {Error} When the directory of the file path doesn't exist and `create_dir` argument is not true.
+     * @throws {Error} When failed to write the file.
+     */
+    writeFile(file_path: string | URL, data: string | ArrayBuffer | Uint8Array | Buffer, mode?: string, overwrite?: boolean, create_dir?: boolean): boolean;
+    /**
+     * Gets information about a file or directory, like times, size, if it's a file or directory, etc.
+     *
+     * @param {string|URL} file_path - Local file or directory path.
+     * @param {boolean} [about_link=false] - `true` makes the method return information about the symbolic link itself instead of the path the link redirects to. Only applies to symbolic links.
+     * @returns {FileStat} Returns information about specified file or directory, or throws an Error if it doesn't exist, access is denied, or argument is invalid.
+     * @throws {Error} When the file path is invalid.
+     * @throws {Error} When the file is not found.
+     * @see FileStat
+     */
+    fileStat(file_path: string | URL, about_link?: boolean): FileStat;
+    /**
+     * Deletes a file or moves it to trash synchronously.
+     *
+     * @param {string} file_path - Path to the file to delete
+     * @param {boolean} [move_to_trash=false] - Move file to trash instead of completely deleting it.
+     * @returns {boolean} - Returns `true` on success or if the file didn't exist; otherwise returns `false` on failure
+     * @throws {Error} When the file path is invalid.
+     * @throws {Error} When the file path is a directory.
+     */
+    deleteFile(file_path: string, move_to_trash?: boolean): boolean;
+    /**
+     * Deletes a directory synchronously.
+     *
+     * @param {string} dir_path - Path to the directory to delete
+     * @param {boolean} [recursive=false] - Delete directory and its contents. (only has effect if `move_to_trash` parameter is false.
+     * @param {boolean} [move_to_trash=false] - Move file to trash instead of completely deleting it.
+     * @returns {boolean} - Returns true on success, or throws error on failure
+     * @throws {Error} When the directory path is invalid.
+     * @throws {Error} When the path is not a directory.
+     * @throws {Error} When the directory is not empty and `recursive=false`.
+     * @throws {Error} When failed to delete the directory.
+     */
+    deleteDirectory(dir_path: string, recursive?: boolean, move_to_trash?: boolean): boolean;
+    /**
+     * Deletes a file or directory synchronously.
+     *
+     * @param {string} path - Path to the directory to delete
+     * @param {boolean} [recursive=false] - Delete directory and its contents. (only has effect if `move_to_trash` parameter is false.
+     * @param {boolean} [move_to_trash=false] - Move file to trash instead of completely deleting it.
+     * @returns {boolean} - Returns true on success, or throws error on failure
+     * @throws {Error} When the file path is invalid.
+     * @throws {Error} When access is denied.
+     * @throws {Error} When failed to delete the file or directory.
+     */
+    deleteAny(path: string, recursive?: boolean, move_to_trash?: boolean): boolean;
+    /**
+     * Synchronously checks if a file can be read.
+     *
+     * @param {string|URL} file_path - Path to the file to check
+     * @returns {boolean} - Returns true if file can be read, false otherwise
+     * @throws {Error} When the file path is invalid.
+     */
+    canReadFile(file_path: string | URL): boolean;
+    /**
+     * Synchronously checks if a file can be written to.
+     *
+     * @param {string|URL} file_path - Path to the file to check
+     * @returns {boolean} - Returns true if file can be written to, false otherwise
+     * @throws {Error} When the file path is invalid.
+     */
+    canWriteFile(file_path: string | URL): boolean;
+    /**
+     * Creates a directory synchronously.
+     *
+     * @param {string} dir_path - Path to the directory to create
+     * @param {boolean} [recursive=false] - Create parent directories if they don't exist
+     * @returns {boolean} - Returns `true` on success or throws error on failure
+     * @throws {Error} When the directory path is invalid.
+     * @throws {Error} When the directory already exists.
+     * @throws {Error} When failed to create the directory.
+     */
+    makeDirectory(dir_path: string, recursive?: boolean): boolean;
+    /**
+     * Moves or copies a file synchronously. If the destination directory doesn't exist, the operation may fail.
+     *
+     * @param {string} from_file_path - Source file path
+     * @param {string} to_file_path - Destination file path
+     * @param {boolean} [copy=false] - Copy instead of move
+     * @returns {boolean} - Returns true on success, or throws an error on failure
+     * @throws {Error} On failure to move or copy the file.
+     */
+    moveFile(from_file_path: string, to_file_path: string, copy?: boolean): boolean;
+    /**
+     * Moves or copies a directory synchronously. If the destination  parent directory doesn't exist, the operation may fail.
+     *
+     * @param {string} from_dir_path - Source directory path
+     * @param {string} to_dir_path - Destination directory path
+     * @param {boolean} [copy=false] - Copy instead of move
+     * @returns {boolean} - Returns true on success, or throws an error on failure
+     * @throws {Error} On failure to move or copy the file.
+     */
+    moveDirectory(from_dir_path: string, to_dir_path: string, copy?: boolean): boolean;
+    /**
+     * Reads the contents of a directory synchronously and returns an Array of files and directories.
+     *
+     * @param {string} dir_path - Path to the directory to read
+     * @returns {Array<string>} - Returns an Array of filenames/directory names in the directory.
+     * @throws {Error} When the directory path is invalid.
+     * @throws {Error} When the directory is not found.
+     * @throws {Error} When specified path is not a directory.
+     * @throws {Error} When access is denied.
+     * @throws {Error} When failed to read the directory.
+     */
+    listDirectory(dir_path: string): Array<string>;
+    /**
+     * Sets or gets a current working directory.
+     *
+     * @param {string} [dir=undefined] - New directory (omit when getting a directory).
+     * @returns {string} Returns current working directory. Throws error if the directory cannot be found or the user doesn't have permissions to access the specified directory when getting.
+     * @throws {Error} When setting working directory failed because it doesn't exist.
+     */
+    cwd(dir?: string): string;
+    /**
+     * Registers java-wide {@link MouseEvent} event handler that works in all Java apps (but not outside of Java applications).
+     *
+     * @param {function(MouseEvent):any} [callback=undefined] - Function to handle the event
+     * @param {boolean} [remove=false] - Remove the callback from this event
+     * @return {SwingUI|function[]} When called with arguments, returns `this` instance of SwingUI class, otherwise returns an array of current callbacks.
+     * @see MouseEvent
+     */
+    onMouseEvents(callback?: (arg0: MouseEvent) => any, remove?: boolean): SwingUI | Function[];
+    /**
+     * Registers java-wide {@link MouseMotionEvent} event handler that works in all Java apps (but not outside of Java applications).
+     *
+     * @param {function(MouseMotionEvent):any} [callback=undefined] - Function to handle the event
+     * @param {boolean} [remove=false] - Remove the callback from this event
+     * @return {SwingUI|function[]} When called with arguments, returns `this` instance of SwingUI class, otherwise returns an array of current callbacks.
+     * @see MouseMotionEvent
+     */
+    onMouseMotion(callback?: (arg0: MouseMotionEvent) => any, remove?: boolean): SwingUI | Function[];
+    /**
+     * Registers java-wide {@link MouseWheelEvent} handler that works in all Java apps (but not outside of Java applications).
+     *
+     * @param {function(Object):any} [callback=undefined] - Function to handle the {@link MouseWheelEvent}
+     * @param {boolean} [remove=false] - Remove the callback from this event
+     * @return {SwingUI|function[]} When called with arguments, returns `this` instance of SwingUI class, otherwise returns an array of current callbacks.
+     * @see MouseWheelEvent
+     * @see UIComponent#onMouseWheel
+     */
+    onMouseWheel(callback?: (arg0: Object) => any, remove?: boolean): SwingUI | Function[];
+    /**
+     * Registers java-wide {@link KeyEvent} keyboard key event handler. Handles keyboard keys actions made anywhere on the operating system.
+     *
+     * @param {function(KeyEvent):any} [callback=undefined] - Function to handle the event
+     * @param {boolean} [remove=false] - Remove the callback from this event
+     * @returns {SwingUI|function[]} When called with arguments, returns `this` instance of SwingUI class, otherwise returns an array of current callbacks.
+     * @see KeyEvent
+     */
+    onKey(callback?: (arg0: KeyEvent) => any, remove?: boolean): SwingUI | Function[];
+    /**
+     * Registers, gets, or unregisters event handler callbacks for application events on macOS.
+     *
+     * @param {function(AppEvent):any} [callback=undefined] - A callback function that receives an {@link AppEvent} object. Set to `null` to unregister all callbacks for this event. Omit to get an array of callbacks for this event.
+     * @param {boolean} [remove=false] - Remove the callback from this event.
+     * @returns {SwingUI|function[]} If called without parameters, an array of registered callbacks is returned; otherwise `this` instance of SwingUI class is returned.
+     * @see AppEvent
+     */
+    onAppEvents(callback?: (arg0: AppEvent) => any, remove?: boolean): SwingUI | Function[];
+    /**
+     * Registers, unregisters and retrieves event handler that receive STDIN data sent by command line interface (CLI).
+     *
+     * @param {function(Object):any|null|undefined} [callback] - Function to handle the event, `null` to remove all handlers, or omit to retrieve an array of handlers.
+     * @param {boolean} remove - Removed the callback from this event
+     * @return {SwingUI|function[]} If called without parameters, an array of registered callbacks is returned; otherwise `this` instance of SwingUI class is returned.
+     * @example <h2>Registering an event handler to receive CLI input:</h2>
+     * ui.onCLI(e => {console.log(`Received: ${e.data}`);});
+     */
+    onCLI(callback?: (arg0: Object) => any | null | undefined, remove?: boolean): SwingUI | Function[];
+    /**
+     * Registers, unregisters and retrieves event handler for an event emitted when UI look and feel is changed using ui.ui(id) method.
+     *
+     * @param {function(Object):any|null|undefined} [callback] - Function to handle the event, `null` to remove all handlers, or omit to retrieve an array of handlers.
+     * @param {boolean} remove - Removed the callback from this event
+     * @return {SwingUI|function[]} If called without parameters, an array of registered callbacks is returned; otherwise `this` instance of SwingUI class is returned.
+     * @example <h2>Receive UI look and feel change events:</h2>
+     * ui.onUIChange(e => {console.log(e);});
+     *
+     * // when UI changes, it prints the event like this:
+     * {
+     *   newValue: {
+     *     name: "Metal"
+     *     dark: false
+     *     id: "MetalLookAndFeel"
+     *   }
+     *   oldValue: {
+     *     name: "FlatLaf Dark"
+     *     dark: true
+     *     id: "FlatDarkLaf"
+     *   }
+     *   event: "onUIChange"
+     *   type: "change"
+     * }
+     * @see SwingUI#list
+     * @see SwingUI#ui
+     */
+    onUIChange(callback?: (arg0: Object) => any | null | undefined, remove?: boolean): SwingUI | Function[];
+    /**
+     * Registers, unregisters and retrieves event handler for exit event emitted by ui.exit() method.
+     *
+     * @param {function(Object):any|null|undefined} [callback] - Function to handle the event, `null` to remove all handlers, or omit to retrieve an array of handlers.
+     * @param {boolean} remove - Removed the callback from this event
+     * @return {SwingUI|function[]} If called without parameters, an array of registered callbacks is returned; otherwise `this` instance of SwingUI class is returned.
+     * @example <h2>Registering exit event handler:</h2>
+     * ui.onExit(e => {console.log(`Exiting with code: ${e.code}`);});
+     * @see SwingUI#exit
+     */
+    onExit(callback?: (arg0: Object) => any | null | undefined, remove?: boolean): SwingUI | Function[];
+    #private;
+}