electrobun 0.0.1 → 0.0.3

package/example/package-lock.json

@@ -1,32 +0,0 @@
-{
-    "name": "example",
-    "lockfileVersion": 3,
-    "requires": true,
-    "packages": {
-        "": {
-            "dependencies": {
-                "electrobun": "file:../"
-            }
-        },
-        "..": {
-            "version": "0.0.1",
-            "license": "MIT",
-            "dependencies": {
-                "@oneidentity/zstd-js": "^1.0.3",
-                "rpc-anywhere": "1.5.0",
-                "tar": "^6.2.1"
-            },
-            "bin": {
-                "electrobun": "src/cli/build/electrobun"
-            },
-            "devDependencies": {
-                "@types/bun": "^1.0.8",
-                "bun": "1.0.26"
-            }
-        },
-        "node_modules/electrobun": {
-            "resolved": "..",
-            "link": true
-        }
-    }
-}

package/example/package.json

@@ -1,11 +0,0 @@
-{
-    "scripts": {
-        "start": "electrobun dev ELECTROBUN_DEBUG_MODE",
-        "build:dev": "electrobun build ELECTROBUN_DEBUG_MODE",
-        "build:canary": "electrobun build env=canary ELECTROBUN_DEBUG_MODE",
-        "start:canary": "electrobun dev env=canary ELECTROBUN_DEBUG_MODE"
-    },
-    "dependencies": {
-        "electrobun": "file:../"
-    }
-}

package/example/src/bun/index.ts

@@ -1,403 +0,0 @@
-import Electrobun, {
-  BrowserWindow,
-  BrowserView,
-  ApplicationMenu,
-  ContextMenu,
-  Tray,
-  type RPCSchema,
-  type ElectrobunEvent,
-  createRPC,
-  Utils,
-} from "electrobun/bun";
-import { type MyWebviewRPC } from "../mainview/rpc";
-import { type MyExtensionSchema } from "../myextension/rpc";
-import { resolve, resolveSync } from "bun";
-import { homedir } from "os";
-import { join } from "path";
-
-// Electrobun.Updater.getLocalVersion();
-
-const updateInfo = await Electrobun.Updater.checkForUpdate();
-
-if (updateInfo.updateAvailable) {
-  console.log("update available");
-  // todo (yoav): add a button to the UI to trigger this
-  await Electrobun.Updater.downloadUpdate();
-}
-
-if (Electrobun.Updater.updateInfo()?.updateReady) {
-  console.log("update app");
-  await Electrobun.Updater.applyUpdate();
-}
-
-// const myWebviewRPC = createRPC<MyWebviewRPC["bun"], MyWebviewRPC["webview"]>({
-//     maxRequestTime: 5000,
-//     requestHandler: {
-//         doMoreMath: ({a, b}) => {
-//             console.log('\n\n\n\n')
-//             console.log(`win1 webview asked me to do more math with: ${a} and ${b}`)
-//             return a + b;
-//         },
-//         // todo (yoav): messages currently require subscripting
-//         // logToBun: ({msg}) => {
-//         //     console.log('\n\nWebview asked to logToBun: ', msg, '\n\n')
-//         // }
-//     }
-// });
-
-const tray = new Tray({
-  title: "Example Tray Item (click to create menu)",
-  // Note: __dirname here will evaulate to src/bun when running in dev mode
-  // todo: we should include it as an asset and use that url
-  // This can be a views url or an absolute file path
-  image: `views://assets/electrobun-logo-32-template.png`,
-  template: true,
-  width: 32,
-  height: 32,
-});
-
-// map action names to clicked state
-const menuState = {
-  "item-1": false,
-  "sub-item-1": false,
-  "sub-item-2": true,
-};
-
-const updateTrayMenu = () => {
-  tray.setMenu([
-    {
-      type: "normal",
-      label: `Toggle me`,
-      action: "item-1",
-      checked: menuState["item-1"],
-      tooltip: `I'm a tooltip`,
-      submenu: [
-        {
-          type: "normal",
-          label: "Click me to toggle sub-item 2",
-          tooltip: "i will also unhide sub-item-3",
-          action: "sub-item-1",
-        },
-        {
-          type: "divider",
-        },
-        {
-          type: "normal",
-          label: "Toggle sub-item-3's visibility",
-          action: "sub-item-2",
-          enabled: menuState["sub-item-1"],
-        },
-        {
-          type: "normal",
-          label: "I was hidden",
-          action: "sub-item-3",
-          hidden: menuState["sub-item-2"],
-        },
-      ],
-    },
-  ]);
-};
-
-// TODO: events should be typed
-tray.on("tray-clicked", (e) => {
-  const { id, action } = e.data as { id: number; action: string };
-
-  if (action === "") {
-    // main menu was clicked before we create a system tray menu for it.
-    updateTrayMenu();
-    tray.setTitle("Example Tray Item (click to open menu)");
-  } else {
-    // once there's a menu, we can toggle the state of the menu items
-    menuState[action] = !menuState[action];
-    updateTrayMenu();
-  }
-  // respond to left and right clicks on the tray icon/name
-  console.log("event listener for tray clicked", e.data.action);
-});
-
-ApplicationMenu.setApplicationMenu([
-  {
-    submenu: [{ label: "Quit", role: "quit" }],
-  },
-  {
-    label: "Edit",
-    submenu: [
-      { role: "undo" },
-      { role: "redo" },
-      { type: "separator" },
-      {
-        label: "Custom Menu Item  🚀",
-        action: "custom-action-1",
-        tooltip: "I'm a tooltip",
-      },
-      {
-        label: "Custom menu disabled",
-        enabled: false,
-        action: "custom-action-2",
-      },
-      { type: "separator" },
-      { role: "cut" },
-      { role: "copy" },
-      { role: "paste" },
-      { role: "pasteAndMatchStyle" },
-      { role: "delete" },
-      { role: "selectAll" },
-    ],
-  },
-]);
-
-Electrobun.events.on("application-menu-clicked", (e) => {
-  console.log("application menu clicked", e.data.action); // custom-actino
-});
-
-// typically you'd wire up a frontend rightclick event, preventDefault, rpc to bun, then fire this.
-// but you can also fire and handle context menus entirely from bun globally positioned on screen
-// even if you have no windows open and another app is focused
-setTimeout(() => {
-  ContextMenu.showContextMenu([
-    { role: "undo" },
-    { role: "redo" },
-    { type: "separator" },
-    {
-      label: "Custom Menu Item  🚀",
-      action: "custom-action-1",
-      tooltip: "I'm a tooltip",
-    },
-    {
-      label: "Custom menu disabled",
-      enabled: false,
-      action: "custom-action-2",
-    },
-    {
-      label: "Custom menu disabled",
-      enabled: false,
-      action: "custom-action-2",
-      // todo: support a data property on all menus (app, tray, context)
-      data: {
-        some: "data",
-        that: "is serialized",
-        nested: { thing: 23 },
-      },
-    },
-    { type: "separator" },
-    { role: "cut" },
-    { role: "copy" },
-    { role: "paste" },
-    { role: "pasteAndMatchStyle" },
-    { role: "delete" },
-    { role: "selectAll" },
-  ]);
-}, 5000);
-
-Electrobun.events.on("context-menu-clicked", (e) => {
-  console.log("context event", e.data.action);
-});
-
-const myWebviewRPC = BrowserView.defineRPC<MyWebviewRPC>({
-  maxRequestTime: 5000,
-  handlers: {
-    requests: {
-      doMoreMath: ({ a, b }) => {
-        console.log("\n\n\n\n");
-        console.log(
-          `win1 webview asked me to do more math with: ${a} and ${b}`
-        );
-        return a + b;
-      },
-    },
-    messages: {
-      "*": (messageName, payload) => {
-        console.log("----------.,.,.,.", messageName, payload);
-      },
-      logToBun: ({ msg }) => {
-        console.log(
-          "^^^^^^^^^^^^^^^^^^^^^^^^^------------............ received message",
-          msg
-        );
-        // console.log('\n\nWebview asked to logToBun: ', msg, '\n\n')
-      },
-    },
-  },
-});
-
-const win = new BrowserWindow({
-  title: "my url window",
-  url: "views://mainview/index.html",
-  frame: {
-    width: 1800,
-    height: 600,
-    x: 2000,
-    y: 2000,
-  },
-  rpc: myWebviewRPC,
-  syncRpc: {
-    // TODO: make adding typescript types to syncRpc nicer
-    doSyncMath: ({ a, b }) => {
-      console.log("doing sync math in bun", a, b);
-      return a + b;
-    },
-  },
-});
-
-win.setTitle("url browserwindow");
-
-setTimeout(async () => {
-  const result = await win.webview.rpc?.request.evaluateJavascriptWithResponse({
-    // script: `document.body.textContent`,
-    script: `
-    return new Promise(
-      resolve => {
-        setTimeout(() => {
-          resolve(document.body.textContent + 'hi hi hi')
-        }, 1000)
-      }
-    )
-    `,
-  });
-
-  console.log("evaluateJavascriptWithResponse", result);
-}, 1000);
-
-const wikiWindow = new BrowserWindow({
-  title: "my url window",
-  url: "https://en.wikipedia.org/wiki/Special:Random",
-  preload: "views://myextension/preload.js",
-  frame: {
-    width: 600,
-    height: 600,
-    x: 0,
-    y: 0,
-  },
-  // todo (yoav): can we pass this to the webview's preload code so it doesn't have to be included
-  // in the user's webview bundle?
-  // rpc: createRPC<MyExtensionSchema["bun"], MyExtensionSchema["webview"]>({
-  //     maxRequestTime: 5000,
-  //     // requestHandler: {}
-  // })         ,
-  rpc: BrowserView.defineRPC<MyExtensionSchema>({
-    maxRequestTime: 5000,
-    handlers: {
-      requests: {},
-      messages: {},
-    },
-  }),
-});
-
-wikiWindow.on("close", (event) => {
-  const { id } = event.data;
-  console.log("wiki window closed", id);
-});
-
-wikiWindow.on("resize", (event) => {
-  const { id, x, y, width, height } = event.data;
-  console.log("wiki window resized", id, x, y, width, height);
-});
-
-wikiWindow.on("move", (event) => {
-  const { id, x, y } = event.data;
-  console.log("wiki window moved", id, x, y);
-});
-
-const webviewTagWindow = new BrowserWindow({
-  title: "webview tag test",
-  url: "views://webviewtag/index.html",
-  frame: {
-    width: 1800,
-    height: 1200,
-    x: 1300,
-    y: 100,
-  },
-  titleBarStyle: "hiddenInset",
-});
-
-// TODO: make this a unit test
-// setTimeout(() => {
-//   console.log("trashing item");
-//   Utils.moveToTrash("/Users/yoav/Desktop/600x200_copy.jpg");
-// }, 2000);
-
-// TODO: make this a unit test
-// setTimeout(() => {
-//   console.log("open in finder");
-//   Utils.showItemInFolder("/Users/yoav/Desktop/600x200_copy.jpg");
-// }, 2000);
-
-// TODO: make this a unit test
-// will always return an array whether multiple selection is enabled or not
-// if no file is chosen the array will be [""] ie: index 0 will have an empty string
-// setTimeout(async () => {
-//   console.log("open file dialogue");
-//   const chosenPaths = await Utils.openFileDialog({
-//     startingFolder: join(homedir(), "Desktop"),
-//     allowedFileTypes: "*",
-//     // allowedFileTypes: "png,jpg",
-//     canChooseFiles: true,
-//     canChooseDirectory: false,
-//     allowsMultipleSelection: true,
-//   });
-//   console.log("chosen paths", chosenPaths);
-// }, 2000);
-
-// wikiWindow.setRPC()
-
-// todo (yoav): typescript types should resolve for e and e.setResponse
-Electrobun.events.on("will-navigate", (e) => {
-  console.log(
-    "example global will navigate handler",
-    e.data.url,
-    e.data.webviewId
-  );
-  e.response = { allow: true };
-});
-
-wikiWindow.webview.on("will-navigate", (e) => {
-  console.log(
-    "example webview will navigate handler",
-    e.data.url,
-    e.data.webviewId
-  );
-  if (e.responseWasSet && e.response.allow === false) {
-    e.response.allow = true;
-    // e.clearResponse();
-  }
-});
-
-wikiWindow.webview.on("did-navigate", (e) => {
-  console.log(
-    "did-navigate event handler in bun for wikiWindow",
-    e.data.detail
-  );
-});
-
-wikiWindow.setTitle("New title from bun");
-
-setTimeout(() => {
-  win.webview.executeJavascript(
-    'document.body.innerHTML = "executing random js in win2 webview";'
-  );
-
-  setTimeout(() => {
-    // asking wikipedia for the title of the article
-    wikiWindow.webview.rpc?.request
-      .getTitle()
-      .then((result) => {
-        console.log("\n\n\n\n");
-        console.log(`visiting wikipedia article for: ${result}`);
-        console.log("\n\n\n\n");
-      })
-      .catch((err) => {
-        console.log("getTitle error", err);
-      });
-
-    win.webview.rpc?.request
-      .doMath({ a: 3, b: 4 })
-      .then((result) => {
-        console.log("\n\n\n\n");
-        console.log(`I asked win1 webview to do math and it said: ${result}`);
-        console.log("\n\n\n\n");
-      })
-      .catch(() => {});
-
-    win.webview.rpc?.send.logToWebview({ msg: "hi from bun!" });
-  }, 1000);
-}, 3000);

package/example/src/mainview/index.css

@@ -1,4 +0,0 @@
-body {
-    background: #111;
-    color: #fff;
-}

package/example/src/mainview/index.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>My Electrobun app</title>
-    <script src="views://mainview/index.js"></script>
-    <link rel="stylesheet" href="views://mainview/index.css">
-</head>
-<body>
-    <h1>hi World</h1>    
-</body>
-</html>

package/example/src/mainview/index.ts

@@ -1,45 +0,0 @@
-import ElectrobunView, { Electroview } from "electrobun/view";
-import { type MyWebviewRPC } from "./rpc";
-
-const rpc = Electroview.defineRPC<MyWebviewRPC>({
-  handlers: {
-    requests: {
-      doMath: ({ a, b }) => {
-        document.body.innerHTML += `bun asked me to do math with ${a} and ${b}\n`;
-        return a + b;
-      },
-    },
-    messages: {
-      logToWebview: ({ msg }) => {
-        console.log(`bun asked me to logToWebview: ${msg}`);
-      },
-    },
-  },
-});
-const electrobun = new ElectrobunView.Electroview({ rpc });
-
-setTimeout(() => {
-  // sync rpc test
-  // The entire thread will halt while waiting for bun to respond
-  // todo: make it nice to add typescript types for syncrpc
-  const syncMathResult = electrobun.syncRpc({
-    method: "doSyncMath",
-    params: { a: 5, b: 9 },
-  });
-
-  console.log("----> sync result:", syncMathResult);
-  document.body.innerHTML += `<br> \nsync result: ${syncMathResult}\n`;
-}, 5000);
-
-setTimeout(() => {
-  if (electrobun.rpc) {
-    electrobun.rpc.request
-      .doMoreMath({ a: 9, b: 8 })
-      .then((result) => {
-        document.body.innerHTML += `I asked bun to do more math and it said ${result}\n`;
-      })
-      .catch(() => {});
-
-    electrobun.rpc.send.logToBun({ msg: "hello from webview" });
-  }
-}, 5000);

package/example/src/mainview/rpc.ts

@@ -1,36 +0,0 @@
-import { type RPCSchema } from "electrobun";
-
-export type MyWebviewRPC = {
-  bun: RPCSchema<{
-    requests: {
-      doMoreMath: {
-        params: {
-          a: number;
-          b: number;
-        };
-        response: number;
-      };
-    };
-    messages: {
-      logToBun: {
-        msg: string;
-      };
-    };
-  }>;
-  webview: RPCSchema<{
-    requests: {
-      doMath: {
-        params: {
-          a: number;
-          b: number;
-        };
-        response: number;
-      };
-    };
-    messages: {
-      logToWebview: {
-        msg: string;
-      };
-    };
-  }>;
-};

package/example/src/myextension/preload.ts

@@ -1,15 +0,0 @@
-import ElectrobunView, {Electroview } from 'electrobun/view'
-import {type MyExtensionSchema} from './rpc';
-
-const rpc = Electroview.defineRPC<MyExtensionSchema>({    
-    handlers: {
-        requests: {
-            getTitle: () => {                                        
-                return document.title;            
-            }
-        }
-    }
-});
-
-const electrobun = new ElectrobunView.Electroview({rpc});
-

package/example/src/myextension/rpc.ts

@@ -1,15 +0,0 @@
-import {type RPCSchema } from 'electrobun'
-
-export type MyExtensionSchema = {
-    bun: RPCSchema<{
-        
-    }>,
-    webview:  RPCSchema<{
-        requests: {
-            getTitle: {
-                params: void,
-                response: string
-            }
-        }   
-    }>
-}

package/example/src/webviewtag/index.html

@@ -1,94 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>webview tag test</title>
-    <script src="views://webviewtag/index.js"></script>
-</head>
-<body style="height: 100vh; padding-top: 20px;"
-ondragover="console.log(event);document.getElementById('draginfo').innerHTML = 'clientX: '+event.clientX+' | clientY: '+event.clientY;">    
-    <div class="electrobun-webkit-app-region-drag" style=" cursor:move; -webkit-user-select: none; position:absolute; top: 0; right: 0; left: 80px; background: #222; padding: 3px 10px; color: #eee;">draggable area: move the window by adding .electrobun-webkit-app-region-drag class to any html element</div>
-    <h1>Webview Tag Test</h1>
-    <button onclick="document.querySelector('electrobun-webview').goBack()">Go Back</button>
-    <button onclick="document.querySelector('electrobun-webview').goForward()">Go Forward</button>
-    <button onclick="document.querySelector('electrobun-webview').reload()">Reload</button>
-    <button onclick="document.querySelector('electrobun-webview').setAttribute('src', 'https://eggbun.sh')">eggbun.sh</button>
-    <button onclick="document.querySelector('electrobun-webview').setAttribute('src', 'https://github.com/blackboardsh/electrobun')">github.com/blackboardsh/electrobun</button>
-    <button onclick="document.querySelector('electrobun-webview').syncScreenshot()">Sync Screenshot</button>
-    <button onclick="document.querySelector('electrobun-webview').startMirroring()">Start Mirroring</button>
-    <button onclick="document.querySelector('electrobun-webview').stopMirroring()">Stop Mirroring</button>
-    <button onclick="document.querySelector('electrobun-webview').syncScreenshot()">Sync Screenshot</button>
-    <button onclick="document.querySelector('electrobun-webview').toggleTransparent()">Toggle Transparent</button>
-    <button onclick="document.querySelector('electrobun-webview').togglePassthrough()">Toggle Passthrough</button>
-    <button onclick="document.querySelector('electrobun-webview').toggleHidden()">Toggle Hidden</button>
-    <button onclick="document.querySelector('electrobun-webview').toggleDelegateMode()">Toggle delegate mode</button>
-    <button onclick="document.querySelector('electrobun-webview').toggleHiddenMirrorMode()">Toggle Hidden Mirror mode</button>
-    
-    
-    <electrobun-webview  src="https://electrobun.dev" preload="" ></electrobun-webview>    
-    <electrobun-webview preload="window.onload = () => {document.body.innerHTML += 'hello from preload';}"  html="<html><body><h1>webview tag with html</h1></body></html>" ></electrobun-webview>    
-    <h2>Test loading a bundled png via views:// scheme</h2>
-    <img src="views://webviewtag/electrobun.png" />
-
-    <h2>parition test</h2>
-    <electrobun-webview  src="http://wikipedia.org" partition="" ></electrobun-webview>    
-    <electrobun-webview  src="http://wikipedia.org" partition="" ></electrobun-webview>
-    
-    <electrobun-webview  src="http://wikipedia.org" partition="persist:test1" ></electrobun-webview>
-    <electrobun-webview  src="http://wikipedia.org" partition="persist:test1" ></electrobun-webview>
-
-    <electrobun-webview  src="http://wikipedia.org" partition="persist:test2" ></electrobun-webview>
-    <electrobun-webview  src="http://wikipedia.org" partition="temp:2" ></electrobun-webview>
-
-    
-    <div draggable="true" style="padding: 10px; width:100px;height:100px;border:5px solid black; cursor:move;">drag me into the webview when delegate mode is enabled</div>
-    <span id="draginfo"></span>
-
-    <script>
-        document.querySelector('electrobun-webview').on('did-navigate', () => {
-            console.log('did-navigate');
-        });
-
-        document.querySelector('electrobun-webview').on('did-navigate-in-page', () => {
-            console.log('did-navigate-in-page');
-        });
-
-        document.querySelector('electrobun-webview').on('did-commit-navigation', () => {
-            console.log('did-commit-navigation');
-        });
-
-        document.querySelector('electrobun-webview').on('dom-ready', (e) => {
-            console.log('dom-ready is fired', e.detail);
-        });
-
-        document.querySelector('electrobun-webview').on('new-window-open', (e) => {
-            console.log('new-window-open is fired', e.detail);
-        });
-
-        setTimeout(() => {
-            document.querySelector('electrobun-webview').callAsyncJavaScript({
-                // script: `document.body.innerHTML = 'hello from host browser context'`,
-                // script: `document.body.textContent`,
-                script: `
-                return new Promise(
-                    resolve => {
-                        setTimeout(() => {
-                            resolve(document.location.href + 'from host browser context')
-                        }, 1000)
-                    }
-                )
-                `,
-                }).then(result => {
-                    console.log('evalResult', result);
-                }).catch(err => {
-                    // Note: add a typo to the script to see the error
-                    console.error('evalError', err);
-                });
-        }, 1000)
-
-
-        
-    </script>
-</body>
-</html>