positron.js 1.0.1 → 1.0.3

package/bin/positron.js

@@ -35,6 +35,6 @@ switch (command) {
     break;
 
   default:
-    console.log("Usage: npx positron [build | dev | run]");
+    console.log("Usage: npx positron [build | dev | run | package]");
     process.exit(0);
 }

package/builder.js

@@ -1,7 +1,7 @@
 const fs = require("fs");
 const path = require("path");
 const cp = require("child_process");
-const { success, error, info } = require("./logs");
+const { success, error, info, warn } = require("./logs");
 
 const arch = process.argv.includes("--x64") ? "x64" : process.argv.includes("--arm64") ? "arm64" : process.arch;
 

package/core/mac/main.swift

@@ -18,6 +18,7 @@ let AUTH_TOKEN: String = {
 }()
 
 var windowObservations: [Int: NSKeyValueObservation] = [:]
+var navigationDelegates: [Int: WebViewNavigationDelegate] = [:]
 
 
 import Foundation
@@ -168,6 +169,26 @@ struct IPCResponse: Codable {
     let data: [String: String]
 }
 
+ func GetIPCClient() -> IPCClient {
+    return AppDelegate.shared?.ipcClient ?? IPCClient()
+}
+
+func GetWebView(windowId: Int) -> WKWebView? {
+    guard let window = windows[windowId],
+          let webView = window.contentView as? WKWebView else {
+        printError("GetWebView failed: no webview found for window \(windowId)")
+        return nil
+    }
+    return webView
+}
+
+func GetWindow(windowId: Int) -> NSWindow? {
+    guard let window = windows[windowId] else {
+        printError("GetWindow failed: no window found with ID \(windowId)")
+        return nil
+    }
+    return window
+}
 
 // MARK: - Command Handler
 
@@ -225,6 +246,9 @@ func handleCommand(windowId: Int, command: String, args: [String]) {
         config.userContentController.addUserScript(preload)
 
         let webView = PositronWebView(frame: NSRect(origin: .zero, size: frame.size), configuration: config)
+        let navDelegate = WebViewNavigationDelegate(windowId: windowId)
+        webView.navigationDelegate = navDelegate
+        navigationDelegates[windowId] = navDelegate
         // Resize webview automatically when the window resizes
         webView.autoresizingMask = [.width, .height]
         newWindow.contentView = webView
@@ -242,6 +266,7 @@ func handleCommand(windowId: Int, command: String, args: [String]) {
         observation.invalidate()
         windowObservations.removeValue(forKey: windowId)
     }
+            navigationDelegates.removeValue(forKey: windowId)
 
 
             windows.removeValue(forKey: windowId)
@@ -267,6 +292,19 @@ func handleCommand(windowId: Int, command: String, args: [String]) {
 
     window.performClose(nil) 
 
+case "setSwipeNav":
+        guard let window = windows[windowId],
+              let webView = window.contentView as? WKWebView else {
+            return
+        }
+        
+        let enable = args.first?.lowercased() != "false"
+        webView.allowsBackForwardNavigationGestures = enable
+
+        GetIPCClient().send(
+            IPCResponse(windowId: windowId, event: "setSwipeNav-reply-\(windowId)", data: ["enabled": enable ? "true" : "false"])
+        )
+
 case "forceCloseWindow":
     guard let window = windows[windowId] else { return }
 
@@ -305,7 +343,6 @@ case "forceCloseWindow":
         }
         (window.contentView as? WKWebView)?.load(URLRequest(url: url))
 
-
     case "hide":
         guard let window = windows[windowId] else { return }
         window.orderOut(nil)
@@ -344,7 +381,6 @@ case "forceCloseWindow":
         (window.contentView as? WKWebView)?
             .loadFileURL(fileURL, allowingReadAccessTo: fileURL.deletingLastPathComponent())
 
-
         case "setBounds":
             guard let window = windows[windowId] else { return }
             guard args.count >= 4,
@@ -603,6 +639,24 @@ UNUserNotificationCenter.current().requestAuthorization(
             }
         }
 
+    case "confirm":
+        guard let window = windows[windowId] else { return }
+        guard let message = args.first else {
+            printError("confirm — missing message argument")
+            return
+        }
+        let alert = NSAlert()
+        alert.messageText = message
+        alert.addButton(withTitle: "OK")
+        alert.addButton(withTitle: "Cancel")
+
+        alert.beginSheetModal(for: window) { response in
+            let confirmed = (response == .alertFirstButtonReturn)
+            AppDelegate.shared?.ipcClient.send(
+                IPCResponse(windowId: windowId, event: "confirm-reply-\(windowId)", data: ["confirmed": confirmed ? "true" : "false"])
+            )
+        }
+
     case "isFocused":
         guard let window = windows[windowId] else { return }
         let isFocused = window.isKeyWindow
@@ -682,6 +736,24 @@ case "resetMenu":
     }
 }
 
+// MARK: - WebView Navigation Delegate
+
+final class WebViewNavigationDelegate: NSObject, WKNavigationDelegate {
+    let windowId: Int
+
+    init(windowId: Int) {
+        self.windowId = windowId
+    }
+
+    func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
+        let isFile = webView.url?.isFileURL ?? false
+        let eventName = isFile ? "loadFile-reply-\(windowId)" : "loadURL-reply-\(windowId)"
+        AppDelegate.shared?.ipcClient.send(
+            IPCResponse(windowId: windowId, event: eventName, data: [:])
+        )
+    }
+}
+
 // MARK: - WebView → Swift IPC Handler
 
 /// Receives messages from renderer JS: window.webkit.messageHandlers.ipc.postMessage({...})

package/core/win/main.cs

@@ -329,6 +329,17 @@ private void StartNodeProcess(string workingDirectory)
                         window.Title = webView.CoreWebView2.DocumentTitle;
                     };
 
+                    webView.CoreWebView2.NavigationCompleted += (s, e) =>
+                    {
+                        bool isFile = webView.Source != null && webView.Source.IsFile;
+                        string eventName = isFile ? $"loadFile-reply-{windowId}" : $"loadURL-reply-{windowId}";
+                        _ipcClient.Send(new IPCResponse
+                        {
+                            windowId = windowId,
+                            @event = eventName
+                        });
+                    };
+
             webView.CoreWebView2.ContextMenuRequested += (s, e) =>
 {
     if (LayoutMap.TryGetValue(windowId, out var l) && l.ContextMenu != null)
@@ -371,6 +382,23 @@ private void StartNodeProcess(string workingDirectory)
     
     // 3. Attach it to the layout
     layout.ContextMenu = contextMenu;
+    break;
+
+    case "setSwipeNav":
+    if (!WindowsMap.TryGetValue(windowId, out var winSwipeNav)) break;
+    var wvSwipeNav = GetWebView(windowId);
+    if (wvSwipeNav != null)    {
+        bool enable = args.Count == 0 || args[0].ToLower() != "false";
+        wvSwipeNav.CoreWebView2.Settings.IsSwipeNavigationEnabled = enable;
+    }
+    
+    GetIPCClient().Send(new IPCResponse
+    {
+        windowId = windowId,
+        @event = "setSwipeNav-reply-" + windowId,
+        data = new() { { "enabled", (wvSwipeNav?.CoreWebView2.Settings.IsSwipeNavigationEnabled ?? false).ToString().ToLower() } }
+    });
+
     break;
 
                 case "closeWindow":
@@ -610,6 +638,24 @@ case "setBounds":
                     }
                     break;
 
+                case "confirm":
+                    if (args.Count < 1)
+                    {
+                        error("confirm — expected message argument");
+                        break;
+                    }
+                    {
+                        var message = args[0];
+                        var result = MessageBox.Show(message, "Confirm", MessageBoxButton.YesNo) == MessageBoxResult.Yes;
+                        _ipcClient.Send(new IPCResponse
+                        {
+                            windowId = windowId,
+                            @event = "confirm-reply-" + windowId,
+                            data = new() { { "confirmed", result.ToString().ToLower() } }
+                        });
+                    }
+                    break;
+
                 case "emitToRenderer":
                     if (args.Count < 2)
                     {
@@ -830,6 +876,15 @@ case "setBounds":
             return null;
         }
 
+        public static Window? GetWindow(int windowId)
+        {
+            if (WindowsMap.TryGetValue(windowId, out var window))
+                return window;
+            return null;
+        }
+
+        public static IPCClient GetIPCClient() => _ipcClient;
+
         // MARK: - Menu Management
 
         private static void BuildAndAttachMenu(int windowId, string jsonStr)

package/index.js

@@ -294,16 +294,6 @@ class Window extends Events.EventEmitter {
     this.emit("title-updated", title); 
   }
 
-  /**
-   * Loads a remote URL in the window. Emits "url-loaded" and "navigated" events with the URL as data.
-   * @param {string} url The URL to load.
-   */
-  loadURL(url) { 
-    this.sendCommand("loadURL", [url]); 
-    this.emit("url-loaded", url); 
-    this.emit("navigated", url); 
-  }
-
   /**
    * Triggers the print dialog for the window. Emits a "print" event. Note that the actual print functionality and dialog is handled by the native layer, so behavior may vary across platforms.
    */
@@ -322,13 +312,25 @@ class Window extends Events.EventEmitter {
   }
 
   /**
-   * Loads a local file in the window. Emits "file-loaded" and "navigated" events with the file path as data.
+   * Loads a file into the window. The path can be an absolute file path or a relative path from the application's root directory. Emits a "file-loaded" event with the path as data, and a "navigated" event with the path as data.
    * @param {string} path The path to the file to load.
    */
-  loadFile(path) { 
-    this.sendCommand("loadFile", [path]); 
-    this.emit("file-loaded", path); 
-    this.emit("navigated", path); 
+  async loadFile(path) {
+    const res = await this.request("loadFile", `loadFile-reply-${this.id}`, path);
+    this.emit("file-loaded", path);
+    this.emit("navigated", path);
+    return res;
+  }
+
+  /**
+   * Loads a URL into the window. Emits a "url-loaded" event with the URL as data, and a "navigated" event with the URL as data.
+   * @param {string} url The URL to load.
+   */
+  async loadURL(url) {
+    const res = await this.request("loadURL", `loadURL-reply-${this.id}`, url);
+    this.emit("url-loaded", url);
+    this.emit("navigated", url);
+    return res;
   }
 
   /**
@@ -625,7 +627,7 @@ if (timeoutArg) {
 
   args = args.filter(arg => arg !== timeoutArg);
 
-  timeoutDuration = parseInt(timeoutArg.split("=")[1], 10);
+  timeoutDuration = parseInt(timeoutArg.split("=")[1]);
 }
       
     timeout = setTimeout(() => {
@@ -763,7 +765,7 @@ async getBounds() {
  * @returns {Promise<string>} The current URL loaded in the window.
  */
 async getURL() {
-  return await this.request("getURL", `getURL-reply-${this.id}`);
+  return (await this.request("getURL", `getURL-reply-${this.id}`))?.url || "";
 }
 
 /**
@@ -771,7 +773,7 @@ async getURL() {
  * @returns {Promise<string>} The current title of the window.
  */
 async getTitle() {
-  return await this.request("getTitle", `getTitle-reply-${this.id}`);
+  return (await this.request("getTitle", `getTitle-reply-${this.id}`)).title || "";
 }
 
 /**
@@ -799,7 +801,168 @@ setTitlebarTransparent(isTransparent) {
  */
 async evaluateJavaScript(script) {
 const res = await this.request("evaluateJS", `evaluateJS-reply-${this.id}`, script);
-return res;
+return res.result;
+}
+
+/**
+ * Gets the user agent string of the window. Returns a Promise that resolves to the user agent as a string.
+ * @returns {Promise<string>} The user agent string of the window.
+ */
+async getUserAgent() {
+  return await this.evaluateJavaScript("navigator.userAgent");
+}
+
+/**
+ * Sets the style of elements matching a CSS selector. Returns a Promise that resolves when the style has been applied.
+ * @param {string} selector The CSS selector for the elements to style.
+ * @param {Object} style The style properties to apply.
+ * @returns {Promise<void>} A Promise that resolves when the style has been applied.
+ */
+async setStyleOf(selector, style) {
+  const styleString = Object.entries(style).map(([key, value]) => `${key}: ${value};`).join(" ");
+  const script = `
+  (function() { 
+    const elements = document.querySelectorAll(${JSON.stringify(selector)});
+    elements.forEach(el => {
+      Object.entries(${JSON.stringify(style)}).forEach(([key, value]) => {
+        el.style[key] = value;
+      });
+    });
+  })();
+  `;
+  await this.evaluateJavaScript(script);
+  this.emit("style-updated", { selector, style });
+}
+
+/**
+ * Sets an attribute of elements matching a CSS selector. Returns a Promise that resolves when the attribute has been set.
+ * @param {string} selector The CSS selector for the elements to update.
+ * @param {string} attribute The name of the attribute to set.
+ * @param {string} value The value to set for the attribute.
+ * @returns {Promise<void>} A Promise that resolves when the attribute has been set.
+ */
+async setAttributeOf(selector, attribute, value) {
+  const script = `
+  (function() {
+    const elements = document.querySelectorAll(${JSON.stringify(selector)});
+    elements.forEach(el => {
+      el.setAttribute(${JSON.stringify(attribute)}, ${JSON.stringify(value)});
+    });
+  })();
+  `;
+  await this.evaluateJavaScript(script);
+  this.emit("attribute-updated", { selector, attribute, value });
+}
+
+/**
+ * Removes an attribute from elements matching a CSS selector. Returns a Promise that resolves when the attribute has been removed.
+ * @param {string} selector The CSS selector for the elements to update.
+ * @param {string} attribute The name of the attribute to remove.
+ * @returns {Promise<void>} A Promise that resolves when the attribute has been removed.
+ */
+async removeAttributeOf(selector, attribute) {
+  const script = `
+    (function() {
+      const elements = document.querySelectorAll(${JSON.stringify(selector)});
+      elements.forEach(el => {
+        el.removeAttribute(${JSON.stringify(attribute)});
+      });
+    })();
+  `;
+  await this.evaluateJavaScript(script);
+  this.emit("attribute-removed", { selector, attribute });
+}
+
+/**
+ * Removes specific style properties from elements matching a CSS selector. Returns a Promise that resolves when the styles have been removed.
+ * @param {string} selector The CSS selector for the elements to update.
+ * @param {string[]} styleProperties The style properties to remove.
+ * @returns {Promise<void>} A Promise that resolves when the styles have been removed.
+ */
+async removeStyleOf(selector, styleProperties) {
+  const propertiesString = styleProperties.map(prop => `${prop}:`).join("|");
+  const script = `
+    (function() {
+      const elements = document.querySelectorAll(${JSON.stringify(selector)});
+      elements.forEach(el => {
+        el.style.cssText = el.style.cssText.split(";").filter(rule => {
+          return !${JSON.stringify(propertiesString)}.includes(rule.trim().split(":")[0] + ":");
+        }).join(";");
+      });
+    })();
+  `;
+  await this.evaluateJavaScript(script);
+  this.emit("style-removed", { selector, styleProperties });
+}
+
+/**
+ * Adds or replaces click handlers that emit IPC events.
+ *
+ * @param {string} selector - The CSS selector for the elements to attach the click handlers to.
+ * @param {string} channel - The IPC channel to emit events on when the elements are clicked.
+ * @param {{ replace?: boolean }} [options] - Optional settings for the click handlers. If `replace` is true, any existing IPC click handlers on the elements will be removed before adding the new handler. If false or omitted, the new handler will be added alongside existing handlers without removing them.
+ * @returns {Promise<void>} A Promise that resolves when the click handlers have been added.
+ */
+async onClick(selector, channel, { replace = true } = {}) {
+  const script = `
+  (function() {
+      const selector = ${JSON.stringify(selector)};
+      const channel = ${JSON.stringify(channel)};
+      const replace = ${replace};
+
+      const elements = document.querySelectorAll(selector);
+
+      elements.forEach(el => {
+        if (replace) {
+          el.onclick = () => {
+            window.ipc.send(channel, { selector });
+          }
+        } else {
+        el.addEventListener("click", () => {
+          window.ipc.send(channel, { selector });
+        });  
+        }
+            })
+  })();
+  `;
+
+  await this.evaluateJavaScript(script);
+}
+
+/**
+ * Removes click handlers that emit IPC events from elements matching the specified CSS selector. This will remove all click handlers that were added via the onClick method for the given selector, regardless of the channel or whether they were set to replace existing handlers.
+ * @param {string} selector The CSS selector for the elements to remove click handlers from.
+ * @returns {Promise<void>} A Promise that resolves when the click handlers have been removed.
+ */
+async removeOnClick(selector) {
+  const script = `
+    const elements = document.querySelectorAll(${JSON.stringify(selector)});
+    elements.forEach(el => {
+      el.onclick = null;
+    });
+  `;
+  await this.evaluateJavaScript(script);
+}
+
+/**
+ * Displays a confirmation dialog with the given message. Returns a Promise that resolves to true if the user confirmed, or false if the user cancelled. Emits a "confirm" event with the message as data when done.
+ * @param {string} message The message to display in the confirmation dialog.
+ * @returns {Promise<boolean>} True if the user confirmed, false if the user cancelled.
+ */
+async confirm(message) {
+  const res = await this.request("confirm", `confirm-reply-${this.id}`, message);
+  this.emit("confirm", message);
+  return res?.confirmed === "true";
+}
+
+/**
+ * Enables or disables swipe navigation for the window. When enabled, users can navigate back and forward through their history by swiping left or right on a trackpad or touchscreen. Emits a "swipe-navigation-updated" event with the new value when done.
+ * @param {boolean} enabled Whether swipe navigation should be enabled.
+ * @returns {Promise<void>} A Promise that resolves when the swipe navigation setting has been updated.
+ */
+async setSwipeNavigation(enabled) {
+const res = await this.request("setSwipeNav", `setSwipeNav-reply-${this.id}`, String(enabled));
+this.emit("swipe-navigation-updated", enabled);
 }
 
 }
@@ -832,7 +995,7 @@ const app = {
   },
 
   /**
-   * Adds an event listener for application-level events. Supported events include "before-quit" and "quit".
+   * Adds an event listener for application-level events.
    * @param {string} event The name of the event to listen for.
    * @param {Function} listener The callback function to invoke when the event is emitted.
    */
@@ -858,11 +1021,19 @@ const app = {
     this.events.once(event, listener);
   },
 
+  /**
+   * Gets the currently focused window. Returns a Promise that resolves to the focused Window instance, or null if no windows are currently focused. Emits a "focused-window-retrieved" event with the focused window as data when done.
+   * @returns {Promise<Window|null>} The currently focused window, or null if no windows are focused.
+   */
   async getFocusedWindow() {
    const results = await Promise.all([...activeWindows].map(win => win.isFocused().then(isFocused => ({ win, isFocused }))));
    return results.find(({ isFocused }) => isFocused)?.win || null;
   },
 
+  /**
+   * Sets the application name, which is used for things like the user data directory and may be used by the native layer for other purposes.
+   * @param {*} name The new name for the application. This will be converted to a string before being used.
+   */
   setName(name) {
     process.env.POSITRON_APP_NAME = name;
     this.events.emit("name-updated", name);
@@ -874,6 +1045,10 @@ const app = {
   },
 
 userData: {
+  /**
+   * Gets the path to the user data directory for the application. The path is determined based on the operating system and the application name. If the directory does not exist, it will be created. Emits a "user-data-path-retrieved" event with the path as data when done.
+   * @returns {string} The path to the user data directory.
+   */
   getPath() {
     let userPath = null;
 
@@ -902,6 +1077,9 @@ userData: {
     return userPath;
   },
 
+  /**
+   * Creates the user data directory if it does not already exist. Emits a "user-data-created" event when the directory is created successfully.
+   */
   create() {
     const userPath = this.getPath();
 
@@ -911,6 +1089,10 @@ userData: {
     }
   },
 
+  /**
+   * Deletes the user data directory and all of its contents. Use with caution, as this will permanently remove all user data for the application. Emits a "user-data-deleted" event when the directory is deleted successfully.
+   */
+
   delete() {
     const userPath = this.getPath();
 

package/package.json

@@ -5,7 +5,7 @@
     "url": "https://github.com/systemsoftware/positron.js"
   },
   "homepage": "https://positronjs.gitbook.io",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "index.js",
   "scripts": {
     "test": "node --test"