positron.js 1.0.4 → 1.0.6

package/index.js

@@ -13,6 +13,7 @@ const { info, error, warn, success } = require("./logs");
 
 let currMenu = []
 let contextMenu = [];
+let trayMenu = [];
 
 const randomPort = () => {
   const min = 1024;
@@ -180,7 +181,7 @@ ws.on("message", raw => {
           win.destroy();
         }
       }
-      } else if(msg.event == "menu-action" || msg.event == "context-menu-action") {
+      } else if(msg.event == "menu-action" || msg.event == "context-menu-action" || msg.event == "tray-menu-action") {
        
             const findMenuAction = (items, label, channel) => {
       if (!items || items.length === 0) return null;
@@ -199,7 +200,12 @@ ws.on("message", raw => {
       return null; 
     }
         
-        const menuAction = findMenuAction((msg.event === "menu-action" ? currMenu : contextMenu), msg.data.label, msg.data.channel);
+        let searchMenu = msg.event === "menu-action" ? currMenu : (msg.event === "context-menu-action" ? contextMenu : trayMenu);
+        let menuAction = findMenuAction(searchMenu, msg.data.label, msg.data.channel);
+        
+        if (!menuAction && msg.event === "context-menu-action") {
+          menuAction = findMenuAction(trayMenu, msg.data.label, msg.data.channel);
+        }
         
         if (menuAction) {
           menuAction.click();
@@ -317,7 +323,7 @@ class Window extends Events.EventEmitter {
    * @param {string} path The path to the file to load.
    */
   async loadFile(path) {
-    const res = await this.request("loadFile", `loadFile-reply-${this.id}`, path);
+    const res = await this.request("loadFile", { replyChannel: `loadFile-reply-${this.id}` }, path);
     this.emit("file-loaded", path);
     this.emit("navigated", path);
     return res;
@@ -328,7 +334,7 @@ class Window extends Events.EventEmitter {
    * @param {string} url The URL to load.
    */
   async loadURL(url) {
-    const res = await this.request("loadURL", `loadURL-reply-${this.id}`, url);
+    const res = await this.request("loadURL", { replyChannel: `loadURL-reply-${this.id}` }, url);
     this.emit("url-loaded", url);
     this.emit("navigated", url);
     return res;
@@ -349,7 +355,7 @@ emitToRenderer(channel, args = []) {
     activeSocket.send(payload);
     this.emit("ipc-sent", { channel, args });
   } else {
-    warn(`Cannot send IPC message, socket not ready. Channel: ${channel}`);
+    warn(`Cannot send IPC message on ${channel}, socket not ready.`);
   }
 }
 
@@ -575,7 +581,7 @@ focus() {
  * @returns {Promise<boolean>} True if the window is visible, false otherwise.
  */
 async isVisible() {
-  const res = await this.request("isVisible", `isVisible-reply-${this.id}`);
+  const res = await this.request("isVisible");
   return res?.isVisible === "true";
 }
 
@@ -584,7 +590,7 @@ async isVisible() {
  * @returns {Promise<boolean>} True if the window is fullscreen, false otherwise.
  */
 async isFullscreen() {
-  const res = await this.request("isFullscreen", `isFullscreen-reply-${this.id}`);
+  const res = await this.request("isFullscreen");
   return res?.isFullscreen === "true";
 }
 
@@ -603,7 +609,7 @@ reload() {
  * @returns {Promise<Buffer|null>} The captured screenshot as a Buffer, or null if the capture failed.
  */
 async capturePage() {
- const response = await this.request("capturePage", `capture-page-result-${this.id}`);
+ const response = await this.request("capturePage", { replyChannel: `capture-page-result-${this.id}` });
  return response.image ? Buffer.from(response.image, "base64") : null;
 }
 
@@ -612,52 +618,94 @@ async capturePage() {
  * @returns {Promise<boolean>} True if the window can navigate back, false otherwise.
  */
 async canGoBack() {
- const response = await this.request("canGoBack", `canGoBack-reply-${this.id}`);
+ const response = await this.request("canGoBack");
  return response === "true";
 }
 
+// @ts-check
+
+/**
+ * @typedef {Object} RequestOptions
+ * @property {number} [timeout]
+ * @property {boolean} [noTimeout]
+ * @property {string} [replyChannel]
+ */
+
 /**
- * Sends a request/response command to the native layer. The command will be sent, and the method will wait for a response on the specified reply channel. Once a response is received, the promise will resolve with the reply data.
- * @param {string} command The command to send.
- * @param {string} replyChannel The channel to listen for the reply on.
- * @returns {Promise<*>} A promise that resolves to the reply data.
+ * @overload
+ * @param {string} command
+ * @param {...any} args
+ * @returns {Promise<any>}
  */
-async request(command, replyChannel, ...args) {
+
+/**
+ * @overload
+ * @param {string} command
+ * @param {RequestOptions} options
+ * @param {...any} args
+ * @returns {Promise<any>}
+ */
+
+/**
+ * Send an IPC request.
+ * @param {string} command
+ * @param {...any} args
+ */
+async request(command, ...args) {
   return new Promise((resolve, reject) => {
     let settled = false;
 
+    let options = {};
+
+    if(typeof args[0] === "object" && args[0].constructor === Object) {
+      options = args[0];
+      args = args.slice(1);
+    }
+
     if(!command) {
       reject(new Error("Command is required for request"));
       return;
     }
 
-    if(!replyChannel) {
-      replyChannel = `${command}-reply-${this.id}`;
-    }
+    const reqId = crypto.randomUUID();
+
+    let replyChannel = `${command}-reply-${reqId}`;
+
+  if (options.replyChannel) {
+  replyChannel = options.replyChannel;
+} else if(args[0] && (args[0].includes("-reply-") || args[0].includes("-result-"))) {
+  // TEMP TRANSITIONAL LOGIC TO SUPPORT LEGACY REQUESTS THAT PASS REPLY CHANNEL AS FIRST ARGUMENT. WILL BE REMOVED IN A FUTURE RELEASE.
+  replyChannel = args[0];
+}
 
     const unsubscribe = ipc.handle(replyChannel, (data) => {
       if (!settled) {
         settled = true;
         clearTimeout(timeout);
         unsubscribe();
+
+        for (const key in data) {
+          if (data[key] === "true") {
+            data[key] = true;
+          } else if (data[key] === "false") {
+            data[key] = false;
+          } else if (!isNaN(data[key])) {
+            data[key] = Number(data[key]);
+          }
+        } 
+
         resolve(data);
       }
     });
 
     let timeout;
 
-    if(!args.includes("NO_TIMEOUT")) {
+    if(!options.noTimeout) {
       let timeoutDuration = 7000;
-     
-      const timeoutArg = args.find(
-  arg => typeof arg === "string" && arg.startsWith("TIMEOUT=")
-);
-
-if (timeoutArg) {
-
-  args = args.filter(arg => arg !== timeoutArg);
+  
 
-  timeoutDuration = parseInt(timeoutArg.split("=")[1]);
+if (options.timeout) {
+  timeoutDuration = options.timeout;
 }
       
     timeout = setTimeout(() => {
@@ -680,7 +728,7 @@ if (timeoutArg) {
  * @returns {Promise<boolean>} True if the window can navigate forward, false otherwise.
  */
 async canGoForward() {
-  const response = await this.request("canGoForward", `canGoForward-reply-${this.id}`);
+  const response = await this.request("canGoForward");
   return response === "true";
 }
 
@@ -745,7 +793,7 @@ setBounds(x, y, width, height) {
  * @returns {Promise<string|null>} The user's input as a string, or null if the user cancelled the prompt.
  */
 async prompt(message, defaultValue = "") {
-  const res = await this.request("prompt", `prompt-reply-${this.id}`, message, defaultValue);
+  const res = await this.request("prompt", message, defaultValue);
   this.emit("prompt", { message, defaultValue });
   return res?.input;
 }
@@ -782,7 +830,7 @@ setContextMenu(menuTemplate) {
  * @returns {Promise<boolean>} True if the window is focused, false otherwise.
  */
 async isFocused() {
-  const res = await this.request("isFocused", `isFocused-reply-${this.id}`);
+  const res = await this.request("isFocused");
   return res?.isFocused === "true";
 }
 
@@ -791,7 +839,7 @@ async isFocused() {
  * @returns {Promise<{x: number, y: number, width: number, height: number}>} An object containing the window's bounds.
  */
 async getBounds() {
-  return await this.request("getBounds", `getBounds-reply-${this.id}`);
+  return await this.request("getBounds");
 }
 
 /**
@@ -799,7 +847,7 @@ async getBounds() {
  * @returns {Promise<string>} The current URL loaded in the window.
  */
 async getURL() {
-  return (await this.request("getURL", `getURL-reply-${this.id}`))?.url || "";
+  return (await this.request("getURL"))?.url || "";
 }
 
 /**
@@ -807,7 +855,7 @@ async getURL() {
  * @returns {Promise<string>} The current title of the window.
  */
 async getTitle() {
-  return (await this.request("getTitle", `getTitle-reply-${this.id}`)).title || "";
+  return (await this.request("getTitle"))?.title || "";
 }
 
 /**
@@ -834,7 +882,7 @@ setTitlebarTransparent(isTransparent) {
  * @returns {Promise<*>} A Promise that resolves to the result of the evaluation.
  */
 async evaluateJavaScript(script) {
-const res = await this.request("evaluateJS", `evaluateJS-reply-${this.id}`, script);
+const res = await this.request("evaluateJS", script);
 return res.result;
 }
 
@@ -984,7 +1032,7 @@ async removeOnClick(selector) {
  * @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);
+  const res = await this.request("confirm", message);
   this.emit("confirm", message);
   return res?.confirmed === "true";
 }
@@ -995,7 +1043,7 @@ async confirm(message) {
  * @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));
+const res = await this.request("setSwipeNav", String(enabled));
 this.emit("swipe-navigation-updated", enabled);
 }
 
@@ -1004,7 +1052,7 @@ this.emit("swipe-navigation-updated", enabled);
  * @returns {Promise<boolean>} True if swipe navigation is enabled, false otherwise.
  */
 async isSwipeNavigationEnabled() {
-  const res = await this.request("isSwipeNavEnabled", `isSwipeNavEnabled-reply-${this.id}`);
+  const res = await this.request("isSwipeNavEnabled");
   return res?.enabled === "true";
 }
 
@@ -1044,10 +1092,19 @@ async addToContentBlocker(config={ json:[], url:"", file:"", reload:true, clearE
 }
 
 
-  const res = await this.request("addToContentBlocker", `addToContentBlocker-reply-${this.id}`, json, config.reload, config.clearExisting);
+  const res = await this.request("addToContentBlocker", json, config.reload, config.clearExisting);
   this.emit("content-blocker-updated", json);
 }
 
+/**
+ * Displays a file open dialog and returns a Promise that resolves to an array of selected file paths, or null if the user cancelled the dialog.
+ * @param {*} options The options for the file open dialog.
+ * @returns 
+ */
+async showFileOpenDialog(options = {}) {
+  this.emit("show-file-open-dialog", options);
+  return this.request("showFileOpenDialog", options);
+}
 
 
 }
@@ -1055,6 +1112,10 @@ async addToContentBlocker(config={ json:[], url:"", file:"", reload:true, clearE
 const app = {
 
   name:"PositronApp",
+  
+  setTrayMenu(menuTemplate) {
+    trayMenu = menuTemplate;
+  },
 
   /**
    * Quits the application by sending a terminate command to the native layer and then exiting the process. Emits a "before-quit" event before sending the command, and a "quit" event after initiating the quit sequence.
@@ -1111,8 +1172,10 @@ const app = {
    * @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;
+   const getFocused = await this.requestFromNative("getFocusedWindowId");
+   const winId = getFocused?.focusedWindowId ? parseInt(getFocused.focusedWindowId, 10) : -1;
+   const focusedWin = [...activeWindows].find(w => w.id === winId);
+   return focusedWin || { error: "No focused window found" };
   },
 
   /**
@@ -1194,11 +1257,71 @@ userData: {
   /**
    * Full access to the underlying event emitter for application-level events, allowing for advanced event handling patterns if needed.
    */
-  events: appEvents
+  events: appEvents,
+
+  /**
+   * Sends a command to the native layer. This is a low-level method that can be used to send arbitrary commands, but for most use cases you will want to use the higher-level methods provided by the Window class instead. Emits an "ipc-sent" event with the command and arguments as data when done.
+   * @param {string} command The command to send to the native layer.
+   * @param {any[]} args The arguments to send with the command.
+   */
+  sendToNative(command, args) {
+   const firstWin = activeWindows.values().next().value;
+    if (firstWin) {
+      firstWin.sendCommand(command, args);
+    } else {
+      error("No active windows to send command to native layer");
+    }
+  },
   
+  /**
+   * Sends a request to the native layer and returns a Promise that resolves to the response. This is a low-level method that can be used to send arbitrary requests, but for most use cases you will want to use the higher-level methods provided by the Window class instead. Emits an "ipc-request-sent" event with the command and arguments as data when done.
+   * @param {string} command The command to send to the native layer.
+   * @param {any[]} args The arguments to send with the command.
+   * @returns {Promise<any>} A Promise that resolves to the response from the native layer.
+   */
+  async requestFromNative(command, ...args) {
+    const firstWin = activeWindows.values().next().value;
+    if (firstWin) {
+      return await firstWin.request(command, ...args);
+    } else {
+      error("No active windows to send request to native layer");
+      return null;
+    }
+  },
+
+  async isDarkMode() {
+    const res = await this.requestFromNative("isDarkMode");
+    return res?.isDarkMode;
+  }
+
+}
+
+const clipboard = {
+
+  async writeText(text) {
+    app.sendToNative("writeToClipboard", [text]);
+  },
+
+  async readText() {
+    const res = await app.requestFromNative("readFromClipboard");
+    return res.text || "";
+  }
+
+}
+
+const blockPowerSave = {
+  
+  start() {
+    app.sendToNative("blockPowerSave");
+  },
+
+  stop() {
+    app.sendToNative("unblockPowerSave");
+  }
+
 }
 
-module.exports = { Window, ipc, isPackaged, app, PORT };
+module.exports = { Window, ipc, isPackaged, app, PORT, clipboard, blockPowerSave };
 
 const findNearestPackageJson = require("./findpackage");
 

package/package.json

@@ -5,7 +5,7 @@
     "url": "https://github.com/systemsoftware/positron.js"
   },
   "homepage": "https://positronjs.gitbook.io",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "index.js",
   "scripts": {
     "test": "node --test"
@@ -13,7 +13,13 @@
   "keywords": [
     "app",
     "framework",
-    "desktop"
+    "desktop",
+    "cross-platform",
+    "native",
+    "javascript",
+    "node",
+    "macos",
+    "windows"
   ],
   "author": "Bryce",
   "license": "MIT",
@@ -21,6 +27,7 @@
   "dependencies": {
     "@yao-pkg/pkg": "^6.20.0",
     "esbuild": "^0.28.0",
+    "semver": "^7.8.1",
     "ws": "^8.20.1"
   },
   "bin": {

package/packager.js

@@ -1,6 +1,6 @@
 const fs = require("fs");
 const path = require("path");
-const { execSync } = require("child_process");
+const { execSync, execFileSync } = require("child_process");
 const { info, error, success } = require("./logs");
 const https = require("https");
 const esbuild = require("esbuild");
@@ -33,24 +33,27 @@ function performPackager() {
 
 function handleJavaScriptPipeline(appRoot, resourcesPath) {
   const targetOutputFile = path.join(resourcesPath, "index.js");
+  let bundledFiles = [];
 
     info(`[Packager] Bundling JavaScript code with esbuild...`);
     try {
-      esbuild.buildSync({
+      const result = esbuild.buildSync({
         entryPoints: [path.join(appRoot, "index.js")],
         bundle: true,
         platform: "node",
         target: `node${MAJOR_NODE_V}`,
         outfile: targetOutputFile,
-        minify: ob,
+        minify: true,
         sourcemap: false,
+        metafile: true,
       });
+      bundledFiles = Object.keys(result.metafile.inputs).map(f => path.resolve(appRoot, f));
     } catch (err) {
       error("Fatal: esbuild bundling failed.");
       process.exit(1);
     }
 
-    copyAppAssets(appRoot, resourcesPath);
+    copyAppAssets(appRoot, resourcesPath, bundledFiles);
 
 }
 
@@ -70,9 +73,12 @@ async function packageMacOS(appRoot, distDir, appName) {
     error("Fatal: Native compiled binary missing from bin/. Run build first.");
     process.exit(1);
   }
-  fs.copyFileSync(compiledBinary, path.join(macosPath, appName));
-  fs.chmodSync(path.join(macosPath, appName), "755"); 
-  
+  const binaryPath = path.join(macosPath, appName);
+  fs.copyFileSync(compiledBinary, binaryPath);
+  fs.chmodSync(binaryPath, "755"); 
+
+
+
   const packageJsonPath = path.join(appRoot, "package.json");
   const package = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
 
@@ -105,14 +111,29 @@ async function packageMacOS(appRoot, distDir, appName) {
   handleJavaScriptPipeline(appRoot, resourcesPath);
 
   const bundledJs = path.join(resourcesPath, "index.js");
+  const backendName = appName.replace(/([a-z0-9])([A-Z])/g, '$1-$2').replace(/[\s_]+/g, '-').toLowerCase() + '-backend';
   if (fs.existsSync(bundledJs)) {
-    await compileWithPkg(bundledJs, "darwin", resourcesPath, "positron-backend");
+    await compileWithPkg(bundledJs, "darwin", resourcesPath, backendName);
+    const binPathEscaped = path.join(resourcesPath, backendName).replace(/"/g, '\\"');
+   
+          try {
+        let swiftScript = "";
+     if(fs.existsSync(path.join(__dirname, ['positronicon', 'png'].join('.')))) {
+        const iconPathEscaped = path.join(__dirname, ['positronicon', 'png'].join('.')).replace(/"/g, '\\"');
+        swiftScript = `import Cocoa; NSWorkspace.shared.setIcon(NSImage(contentsOfFile: "${iconPathEscaped}"), forFile: "${binPathEscaped}", options: []);`;
+        }
+         execFileSync("swift", ["-e", swiftScript], { stdio: "ignore" });
+      } catch (err) {
+        error("Failed to set custom icon on native binary:", err);
+      }
     
-  //  fs.renameSync(targetNodePath, path.join(resourcesPath, "positron-backend"));
   }
 
   fs.rmSync(path.join(resourcesPath, "icon.ico"), { force: true });
 
+  if(!process.argv.includes('--keep-package-json') || !process.argv.includes('--kpj')) {
+    fs.rmSync(path.join(resourcesPath, "package.json"), { force: true });
+  }
 
   success(`Successfully packaged macOS app at: ${appBundlePath}`);
 }
@@ -162,9 +183,10 @@ async function packageWindows(appRoot, distDir, appName) {
   }
 
   const bundledJs = path.join(resourcesPath, "index.js");
+  const backendName = appName.replace(/([a-z0-9])([A-Z])/g, '$1-$2').replace(/[\s_]+/g, '-').toLowerCase() + '-backend';
   
   if (fs.existsSync(bundledJs)) {
-        await compileWithPkg(bundledJs, "win32", resourcesPath, "positron-backend");
+        await compileWithPkg(bundledJs, "win32", resourcesPath, backendName);
   } else {
     error(`[Packager] Fatal: Bundled JavaScript entry point missing at ${bundledJs}`);
     process.exit(1);
@@ -173,6 +195,10 @@ async function packageWindows(appRoot, distDir, appName) {
   fs.rmSync(path.join(resourcesPath, "icon.icns"), { force: true });
   fs.rmSync(path.join(resourcesPath, "icon.ico"), { force: true });
 
+    if(!process.argv.includes('--keep-package-json') || !process.argv.includes('--kpj')) {
+    fs.rmSync(path.join(resourcesPath, "package.json"), { force: true });
+  }
+
   const macBinaryPath = path.join(outputFolder, "positron-runtime");
   if (fs.existsSync(macBinaryPath)) {
     fs.rmSync(macBinaryPath);
@@ -189,7 +215,7 @@ async function packageWindows(appRoot, distDir, appName) {
   success(`Successfully packaged Windows app directory at: ${outputFolder}`);
 }
 
-function copyAppAssets(src, dest) {
+function copyAppAssets(src, dest, ignoredFiles = []) {
   const ignoreList = ["node_modules", "dist", "bin", ".git"];
   
   function copyRecursive(currentSrc, currentDest) {
@@ -198,6 +224,8 @@ function copyAppAssets(src, dest) {
       if (ignoreList.includes(item)) continue;
 
       const srcPath = path.join(currentSrc, item);
+      if (ignoredFiles.includes(srcPath)) continue;
+
       const destPath = path.join(currentDest, item);
       const stat = fs.statSync(srcPath);
 
@@ -209,7 +237,6 @@ function copyAppAssets(src, dest) {
         fs.mkdirSync(destPath, { recursive: true });
         copyRecursive(srcPath, destPath);
       } else {
-        if (item.endsWith(".js")) continue;
         fs.copyFileSync(srcPath, destPath);
       }
     }
@@ -221,6 +248,14 @@ function copyAppAssets(src, dest) {
 const { exec } = require("@yao-pkg/pkg");
 
 async function compileWithPkg(bundledJsPath, targetPlatform, outputFolder, appName) {
+
+  if(process.argv.includes("--no-pkg")) {
+    const finalPath = path.join(outputFolder, "index.js");
+    fs.copyFileSync(bundledJsPath, finalPath);
+    success(`[Packager] Skipped pkg compilation. Copied bundled JavaScript to: ${finalPath}`);
+    return;
+  }
+
   info(`[Packager] Packaging application into a standalone binary...`);
 
   let pkgTarget = "";

package/tray.js

@@ -0,0 +1,64 @@
+const { app } = require("./index");
+const { Menu } = require("./menu");
+
+let createdTray = false;
+ 
+module.exports = {
+
+create(menu, title = "", icon = "") {
+
+    if(createdTray) {
+        console.warn("Tray already created. Use setMenu, setTitle, or setIcon to update the existing tray.");
+        return;
+    }
+    
+    createdTray = true;
+   
+    if(menu instanceof Menu) {
+        menu = menu.template
+    }
+
+      const stripClick = (items) => {
+    if (!items) return null;
+    return items.map(i => {
+      const newItem = { ...i, click: undefined };
+      if (newItem.items) {
+        newItem.items = stripClick(newItem.items);
+      }
+      return newItem;
+    });
+  };
+
+    app.setTrayMenu(menu);
+    app.sendToNative("createTray", [JSON.stringify(stripClick(menu)), title, icon]);
+  },
+
+  setMenu(menu) {
+    if(menu instanceof Menu) {
+        menu = menu.template
+    }
+
+      const stripClick = (items) => {
+    if (!items) return null;
+    return items.map(i => {
+      const newItem = { ...i, click: undefined };
+      if (newItem.items) {
+        newItem.items = stripClick(newItem.items);
+      }
+      return newItem;
+    });
+  };
+
+    app.setTrayMenu(menu);
+    app.sendToNative("createTray", [JSON.stringify(stripClick(menu)), "setMenu"]);
+  },
+
+  setTitle(title) {
+    app.sendToNative("createTray", [title, "setTitle"]);
+  },
+
+  setIcon(iconPath) {
+    app.sendToNative("createTray", [iconPath, "setIcon"]);
+  }
+
+}