electrobun 0.0.18 → 0.0.19-beta.6

package/src/cli/package-lock.json

@@ -0,0 +1,93 @@
+{
+  "name": "electrobun-cli",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "electrobun-cli",
+      "dependencies": {
+        "@oneidentity/zstd-js": "^1.0.3",
+        "bsdiff-wasm": "^0.1.4",
+        "node-tar": "^1.0.0"
+      },
+      "devDependencies": {
+        "@types/bun": "latest"
+      },
+      "peerDependencies": {
+        "typescript": "^5.0.0"
+      }
+    },
+    "node_modules/@oneidentity/zstd-js": {
+      "version": "1.0.3",
+      "license": "SEE LICENSE IN LICENSE",
+      "dependencies": {
+        "@types/emscripten": "^1.39.4"
+      }
+    },
+    "node_modules/@types/bun": {
+      "version": "1.0.10",
+      "resolved": "https://registry.npmjs.org/@types/bun/-/bun-1.0.10.tgz",
+      "integrity": "sha512-Jaz6YYAdm1u3NVlgSyEK+qGmrlLQ20sbWeEoXD64b9w6z/YKYNWlfaphu+xF2Kiy5Tpykm5Q9jIquLegwXx4ng==",
+      "dev": true,
+      "dependencies": {
+        "bun-types": "1.0.33"
+      }
+    },
+    "node_modules/@types/emscripten": {
+      "version": "1.39.10",
+      "license": "MIT"
+    },
+    "node_modules/@types/node": {
+      "version": "20.11.30",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~5.26.4"
+      }
+    },
+    "node_modules/@types/ws": {
+      "version": "8.5.10",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@types/node": "*"
+      }
+    },
+    "node_modules/bsdiff-wasm": {
+      "version": "0.1.4",
+      "license": "MIT"
+    },
+    "node_modules/bun-types": {
+      "version": "1.0.33",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@types/node": "~20.11.3",
+        "@types/ws": "~8.5.10"
+      }
+    },
+    "node_modules/node-tar": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/node-tar/-/node-tar-1.0.0.tgz",
+      "integrity": "sha512-cowng5lugLQ3Bb5wWYfWM3067/S9xHDwCw3RWbqn0swqmgApDwklyg31XRci97cT7gNbVHmxoXQSkr2zDi5n+g==",
+      "deprecated": "please use 'tar'"
+    },
+    "node_modules/typescript": {
+      "version": "5.4.3",
+      "license": "Apache-2.0",
+      "peer": true,
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "5.26.5",
+      "dev": true,
+      "license": "MIT"
+    }
+  }
+}

package/src/cli/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "electrobun-cli",
+  "module": "index.ts",
+  "type": "module",
+  "devDependencies": {
+    
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {    
+  },
+  "trustedDependencies": []
+}

package/test-npm-install.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# Test npm installation locally
+echo "Testing Electrobun npm installation..."
+
+# Create a temporary test directory
+TEST_DIR=$(mktemp -d)
+cd $TEST_DIR
+
+echo "Test directory: $TEST_DIR"
+
+# Initialize a test project
+npm init -y
+
+# Set environment variable to use specific version
+export ELECTROBUN_VERSION=v0.0.19-beta.1
+
+# Install electrobun (will use local package.json)
+npm install file:///home/yoav/code/electrobun
+
+# Check if installation worked
+if [ -f "node_modules/electrobun/dist/electrobun" ]; then
+    echo "✓ Electrobun CLI installed successfully"
+    ./node_modules/.bin/electrobun --version
+else
+    echo "✗ Electrobun CLI not found"
+fi
+
+# List installed files
+echo -e "\nInstalled files:"
+find node_modules/electrobun -type f -name "*.ts" | head -10
+find node_modules/electrobun/dist -type f | head -10
+
+echo -e "\nTest complete. Directory: $TEST_DIR"

package/dist/api/browser/builtinrpcSchema.ts

@@ -1,10 +0,0 @@
-// consider just makeing a shared types file
-
-export type BuiltinBunToWebviewSchema = {
-  requests: {
-    evaluateJavascriptWithResponse: {
-      params: { script: string };
-      response: any;
-    };
-  };
-};

package/dist/api/browser/index.ts

@@ -1,474 +0,0 @@
-import {
-  type RPCSchema,
-  type RPCRequestHandler,
-  type RPCOptions,
-  type RPCMessageHandlerFn,
-  type WildcardRPCMessageHandlerFn,
-  type RPCTransport,
-  createRPC,
-} from "rpc-anywhere";
-import { ConfigureWebviewTags } from "./webviewtag";
-// todo: should this just be injected as a preload script?
-import { isAppRegionDrag } from "./stylesAndElements";
-import type { BuiltinBunToWebviewSchema } from "./builtinrpcSchema";
-
-interface ElectrobunWebviewRPCSChema {
-  bun: RPCSchema;
-  webview: RPCSchema;
-}
-
-const WEBVIEW_ID = window.__electrobunWebviewId;
-const RPC_SOCKET_PORT = window.__electrobunRpcSocketPort;
-
-// todo (yoav): move this stuff to browser/rpc/webview.ts
-type ZigWebviewHandlers = RPCSchema<{
-  requests: {
-    webviewTagCallAsyncJavaScript: {
-      params: {
-        messageId: string;
-        webviewId: number;
-        hostWebviewId: number;
-        script: string;
-      };
-      response: void;
-    };
-  };
-}>;
-
-type WebviewTagHandlers = RPCSchema<{
-  requests: {};
-  messages: {
-    webviewTagResize: {
-      id: number;
-      frame: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-      };
-      masks: string;
-    };
-    webviewTagUpdateSrc: {
-      id: number;
-      url: string;
-    };
-    webviewTagGoBack: {
-      id: number;
-    };
-    webviewTagGoForward: {
-      id: number;
-    };
-    webviewTagReload: {
-      id: number;
-    };
-    webviewTagRemove: {
-      id: number;
-    };
-    startWindowMove: {
-      id: number;
-    };
-    stopWindowMove: {
-      id: number;
-    };
-    moveWindowBy: {
-      id: number;
-      x: number;
-      y: number;
-    };
-    webviewTagSetTransparent: {
-      id: number;
-      transparent: boolean;
-    };
-    webviewTagToggleMirroring: {
-      id: number;
-      enable: boolean;
-    };
-    webviewTagSetPassthrough: {
-      id: number;
-      enablePassthrough: boolean;
-    };
-    webviewTagSetHidden: {
-      id: number;
-      hidden: boolean;
-    };
-  };
-}>;
-
-class Electroview<T> {
-  bunSocket?: WebSocket;
-  // user's custom rpc browser <-> bun
-  rpc?: T;
-  rpcHandler?: (msg: any) => void;
-  // electrobun rpc browser <-> zig
-  zigRpc?: any;
-  zigRpcHandler?: (msg: any) => void;
-  // give it a default function
-  syncRpc: (params: any) => any = () => {
-    console.log("syncRpc not initialized");
-  };
-
-  constructor(config: { rpc: T }) {
-    this.rpc = config.rpc;
-    this.init();
-  }
-
-  init() {
-    // todo (yoav): should init webviewTag by default when src is local
-    // and have a setting that forces it enabled or disabled
-    this.initZigRpc();
-    this.initSocketToBun();
-    // Note:
-    // syncRPC messages doesn't need to be defined since there's no need for sync 1-way message
-    // just use non-blocking async rpc for that, we just need sync requests
-    // We don't need request ids either since we're not receiving the response on a different pipe
-    if (true) {
-      // TODO: define sync requests on schema (separate from async reqeusts and messages)
-      this.syncRpc = (msg: { method: string; params: any }) => {
-        try {
-          const messageString = JSON.stringify(msg);
-          return this.bunBridgeSync(messageString);
-        } catch (error) {
-          console.error(
-            "bun: failed to serialize message to webview syncRpc",
-            error
-          );
-        }
-      };
-    }
-    ConfigureWebviewTags(true, this.zigRpc, this.syncRpc);
-
-    this.initElectrobunListeners();
-
-    window.__electrobun = {
-      receiveMessageFromBun: this.receiveMessageFromBun.bind(this),
-      receiveMessageFromZig: this.receiveMessageFromZig.bind(this),
-    };
-
-    if (this.rpc) {
-      this.rpc.setTransport(this.createTransport());
-    }
-  }
-
-  initZigRpc() {
-    this.zigRpc = createRPC<WebviewTagHandlers, ZigWebviewHandlers>({
-      transport: this.createZigTransport(),
-      // requestHandler: {
-
-      // },
-      maxRequestTime: 1000,
-    });
-  }
-
-  initSocketToBun() {
-    // todo: upgrade to tls
-    const socket = new WebSocket(
-      `ws://localhost:${RPC_SOCKET_PORT}/socket?webviewId=${WEBVIEW_ID}`
-    );
-
-    this.bunSocket = socket;
-
-    socket.addEventListener("open", () => {
-      // this.bunSocket?.send("Hello from webview " + WEBVIEW_ID);
-    });
-
-    socket.addEventListener("message", async (event) => {
-      const message = event.data;
-      if (typeof message === "string") {
-        try {
-          const encryptedPacket = JSON.parse(message);
-
-          const decrypted = await window.__electrobun_decrypt(
-            encryptedPacket.encryptedData,
-            encryptedPacket.iv,
-            encryptedPacket.tag
-          );
-
-          this.rpcHandler?.(JSON.parse(decrypted));
-        } catch (err) {
-          console.error("Error parsing bun message:", err);
-        }
-      } else if (message instanceof Blob) {
-        // Handle binary data (e.g., convert Blob to ArrayBuffer if needed)
-      } else {
-        console.error("UNKNOWN DATA TYPE RECEIVED:", event.data);
-      }
-    });
-
-    socket.addEventListener("error", (event) => {
-      console.error("Socket error:", event);
-    });
-
-    socket.addEventListener("close", (event) => {
-      // console.log("Socket closed:", event);
-    });
-  }
-
-  // This will be attached to the global object, zig can rpc reply by executingJavascript
-  // of that global reference to the function
-  receiveMessageFromZig(msg: any) {
-    if (this.zigRpcHandler) {
-      this.zigRpcHandler(msg);
-    }
-  }
-
-  // TODO: implement proper rpc-anywhere style rpc here
-  // todo: this is duplicated in webviewtag.ts and should be DRYed up
-  sendToZig(message: {}) {
-    window.webkit.messageHandlers.webviewTagBridge.postMessage(
-      JSON.stringify(message)
-    );
-  }
-
-  initElectrobunListeners() {
-    document.addEventListener("mousedown", (e) => {
-      if (isAppRegionDrag(e)) {
-        this.zigRpc?.send.startWindowMove({ id: WEBVIEW_ID });
-      }
-    });
-
-    document.addEventListener("mouseup", (e) => {
-      if (isAppRegionDrag(e)) {
-        this.zigRpc?.send.stopWindowMove({ id: WEBVIEW_ID });
-      }
-    });
-  }
-
-  createTransport() {
-    const that = this;
-    return {
-      send(message) {
-        try {
-          const messageString = JSON.stringify(message);
-          that.bunBridge(messageString);
-        } catch (error) {
-          console.error("bun: failed to serialize message to webview", error);
-        }
-      },
-      registerHandler(handler) {
-        that.rpcHandler = handler;
-      },
-    };
-  }
-
-  createZigTransport(): RPCTransport {
-    const that = this;
-    return {
-      send(message) {
-        window.webkit.messageHandlers.webviewTagBridge.postMessage(
-          JSON.stringify(message)
-        );
-      },
-      registerHandler(handler) {
-        that.zigRpcHandler = handler;
-        // webview tag doesn't handle any messages from zig just yet
-      },
-    };
-  }
-
-  // call any of your bun syncrpc methods in a way that appears synchronous from the browser context
-  bunBridgeSync(msg: string) {
-    console.warn("DEPRECATED: use async rpc if possible");
-    var xhr = new XMLHttpRequest();
-    // Note: setting false here makes the xhr request blocking. This completely
-    // blocks the main thread which is terrible. You can use this safely from a webworker.
-    // There are also cases where exposing bun sync apis (eg: existsSync) is useful especially
-    // on a first pass when migrating from Electron to Electrobun.
-    // This mechanism is designed to make any rpc call over the bridge into a sync blocking call
-    // from the browser context while bun asynchronously replies. Use it sparingly from the main thread.
-    xhr.open("POST", "views://syncrpc", false); // Synchronous call
-    xhr.send(msg);
-    if (!xhr.responseText) {
-      return xhr.responseText;
-    }
-
-    try {
-      return JSON.parse(xhr.responseText);
-    } catch {
-      return xhr.responseText;
-    }
-  }
-
-  async bunBridge(msg: string) {
-    if (this.bunSocket?.readyState === WebSocket.OPEN) {
-      try {
-        const { encryptedData, iv, tag } = await window.__electrobun_encrypt(
-          msg
-        );
-
-        const encryptedPacket = {
-          encryptedData: encryptedData,
-          iv: iv,
-          tag: tag,
-        };
-        const encryptedPacketString = JSON.stringify(encryptedPacket);
-        this.bunSocket.send(encryptedPacketString);
-        return;
-      } catch (error) {
-        console.error("Error sending message to bun via socket:", error);
-      }
-    }
-
-    // if socket's are unavailable, fallback to postMessage
-
-    // Note: messageHandlers seem to freeze when sending large messages
-    // but xhr to views://rpc can run into CORS issues on non views://
-    // loaded content (eg: when writing extensions/preload scripts for
-    // remote content).
-
-    // Since most messages--especially those on remote content, are small
-    // we can solve most use cases by having a fallback to xhr for
-    // large messages
-
-    // TEMP: disable the fallback for now. for some reason suddenly can't
-    // repro now that other places are chunking messages and laptop restart
-
-    if (true || msg.length < 8 * 1024) {
-      window.webkit.messageHandlers.bunBridge.postMessage(msg);
-    } else {
-      var xhr = new XMLHttpRequest();
-
-      // Note: we're only using synchronouse http on this async
-      // call to get around CORS for now
-      // Note: DO NOT use postMessage handlers since it
-      // freezes the process when sending lots of large messages
-
-      xhr.open("POST", "views://rpc", false); // sychronous call
-      xhr.send(msg);
-    }
-  }
-
-  receiveMessageFromBun(msg) {
-    // NOTE: in the webview messages are passed by executing ElectrobunView.receiveMessageFromBun(object)
-    // so they're already parsed into an object here
-    if (this.rpcHandler) {
-      this.rpcHandler(msg);
-    }
-  }
-  // todo (yoav): This is mostly just the reverse of the one in BrowserView.ts on the bun side. Should DRY this up.
-  static defineRPC<
-    Schema extends ElectrobunWebviewRPCSChema,
-    BunSchema extends RPCSchema = Schema["bun"],
-    WebviewSchema extends RPCSchema = Schema["webview"]
-  >(config: {
-    maxRequestTime?: number;
-    handlers: {
-      requests?: RPCRequestHandler<WebviewSchema["requests"]>;
-      messages?: {
-        [key in keyof WebviewSchema["messages"]]: RPCMessageHandlerFn<
-          WebviewSchema["messages"],
-          key
-        >;
-      } & {
-        "*"?: WildcardRPCMessageHandlerFn<WebviewSchema["messages"]>;
-      };
-    };
-  }) {
-    // Note: RPC Anywhere requires defining the requests that a schema handles and the messages that a schema sends.
-    // eg: BunSchema {
-    //   requests: // ... requests bun handles, sent by webview
-    //   messages: // ... messages bun sends, handled by webview
-    // }
-    // In some generlized contexts that makes sense,
-    // In the Electrobun context it can feel a bit counter-intuitive so we swap this around a bit. In Electrobun, the
-    // webview and bun are known endpoints so we simplify schema definitions by combining them.
-    // Schema {
-    //   bun: BunSchema {
-    //      requests: // ... requests bun sends, handled by webview,
-    //      messages: // ... messages bun sends, handled by webview
-    //    },
-    //   webview: WebviewSchema {
-    //      requests: // ... requests webview sends, handled by bun,
-    //      messages: // ... messages webview sends, handled by bun
-    //    },
-    // }
-    // electrobun also treats messages as "requests that we don't wait for to complete", and normalizes specifying the
-    // handlers for them alongside request handlers.
-
-    const builtinHandlers: {
-      requests: RPCRequestHandler<BuiltinBunToWebviewSchema["requests"]>;
-    } = {
-      requests: {
-        evaluateJavascriptWithResponse: ({ script }) => {
-          return new Promise((resolve) => {
-            try {
-              const resultFunction = new Function(script);
-              const result = resultFunction();
-
-              if (result instanceof Promise) {
-                result
-                  .then((resolvedResult) => {
-                    resolve(resolvedResult);
-                  })
-                  .catch((error) => {
-                    console.error("bun: async script execution failed", error);
-                    resolve(String(error));
-                  });
-              } else {
-                resolve(result);
-              }
-            } catch (error) {
-              console.error("bun: failed to eval script", error);
-              resolve(String(error));
-            }
-          });
-        },
-      },
-    };
-
-    type mixedWebviewSchema = {
-      requests: BunSchema["requests"];
-      messages: WebviewSchema["messages"];
-    };
-
-    type mixedBunSchema = {
-      requests: WebviewSchema["requests"] &
-        BuiltinBunToWebviewSchema["requests"];
-      messages: BunSchema["messages"];
-    };
-
-    const rpcOptions = {
-      maxRequestTime: config.maxRequestTime,
-      requestHandler: {
-        ...config.handlers.requests,
-        ...builtinHandlers.requests,
-      },
-      transport: {
-        // Note: RPC Anywhere will throw if you try add a message listener if transport.registerHandler is falsey
-        registerHandler: () => {},
-      },
-    } as RPCOptions<mixedBunSchema, mixedWebviewSchema>;
-
-    const rpc = createRPC<mixedBunSchema, mixedWebviewSchema>(rpcOptions);
-
-    const messageHandlers = config.handlers.messages;
-    if (messageHandlers) {
-      // note: this can only be done once there is a transport
-      // @ts-ignore - this is due to all the schema mixing we're doing, fine to ignore
-      // while types in here are borked, they resolve correctly/bubble up to the defineRPC call site.
-      rpc.addMessageListener(
-        "*",
-        (messageName: keyof WebviewSchema["messages"], payload) => {
-          const globalHandler = messageHandlers["*"];
-          if (globalHandler) {
-            globalHandler(messageName, payload);
-          }
-
-          const messageHandler = messageHandlers[messageName];
-          if (messageHandler) {
-            messageHandler(payload);
-          }
-        }
-      );
-    }
-
-    return rpc;
-  }
-}
-
-export { type RPCSchema, createRPC, Electroview };
-
-const Electrobun = {
-  Electroview,
-};
-
-export default Electrobun;

package/dist/api/browser/stylesAndElements.ts

@@ -1,3 +0,0 @@
-export const isAppRegionDrag = (e: MouseEvent) => {
-  return e.target?.classList.contains("electrobun-webkit-app-region-drag");
-};