bvisor 0.0.1 → 0.0.3

package/README.md

@@ -6,7 +6,23 @@ Node.js bindings for bVisor. Linux only.
 
 Requires: Zig 0.16+, Docker
 
+From the repo root (next to build.zig), run:
+
+```bash
+zig build test-node
+```
+
+For a targeted test, from this directory, run:
 ```bash
-npm run dev    # builds native binaries (zig build), then runs test.ts in a linux container
+# Install the latest published bvisor and run test.ts in a linux container
+npm run test:published
 ```
 
+## Publishing
+
+Bump versions across all packages, then publish:
+
+```bash
+bun run version:patch
+bun run publish:all
+```

package/index.ts

@@ -0,0 +1 @@
+export { Sandbox } from "./src/sandbox";

package/package.json

@@ -1,25 +1,38 @@
 {
   "name": "bvisor",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "bun": "./index.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "files": [
-    "dist/"
+    "dist/",
+    "index.ts",
+    "src/"
   ],
   "scripts": {
     "build": "tsc",
+    "prebuild": "cd ../../.. && zig build",
     "prepublishOnly": "npm run build",
-    "predev": "cd ../../.. && zig build",
-    "dev": "docker run --rm -v .:/app -w /app oven/bun:alpine sh -c 'bun install && bun test.ts'"
+    "test:published": "docker run --rm -v ./test.ts:/test.ts:ro oven/bun:alpine sh -c 'cd /tmp && echo {} > package.json && bun add bvisor && cp /test.ts . && bun test.ts'",
+    "version:patch": "npm version patch --workspaces --no-git-tag-version --force && npm version patch --no-git-tag-version --force",
+    "publish:all": "npm run prebuild && cd platforms/linux-arm64-musl && bun publish --access public && cd ../linux-arm64-gnu && bun publish --access public && cd ../linux-x64-musl && bun publish --access public && cd ../linux-x64-gnu && bun publish --access public && cd ../.. && bun publish --access public"
   },
+  "workspaces": [
+    "platforms/*"
+  ],
   "dependencies": {
     "detect-libc": "^2.0.3"
   },
   "optionalDependencies": {
-    "@bvisor/linux-arm64-musl": "0.0.1",
-    "@bvisor/linux-arm64-gnu": "0.0.1",
-    "@bvisor/linux-x64-musl": "0.0.1",
-    "@bvisor/linux-x64-gnu": "0.0.1"
+    "@bvisor/linux-arm64-musl": "0.0.2",
+    "@bvisor/linux-arm64-gnu": "0.0.2",
+    "@bvisor/linux-x64-musl": "0.0.2",
+    "@bvisor/linux-x64-gnu": "0.0.2"
   },
   "devDependencies": {
     "@types/node": "^25.2.0",

package/src/napi.ts

@@ -0,0 +1,5 @@
+// Phantom-typed opaque handle to a native object.
+// N-API "externals" are opaque pointers that JS holds but can't inspect.
+// The phantom T prevents accidentally swapping e.g. External<"Sandbox"> and External<"Stream">.
+declare const __external: unique symbol;
+export type External<T> = unknown & { [__external]: T };

package/src/native.ts

@@ -0,0 +1,23 @@
+import { arch, platform } from "os";
+import { familySync, MUSL } from "detect-libc";
+import { External } from "./napi";
+
+if (platform() !== "linux") {
+  throw new Error("bVisor only supports Linux");
+}
+
+/** FFI contract: typed interface for the native Zig module loaded via require(). */
+export interface NativeModule {
+  createSandbox(): External<"Sandbox">;
+  sandboxRunCmd(
+    sandbox: External<"Sandbox">,
+    command: string
+  ): {
+    stdout: External<"Stream">;
+    stderr: External<"Stream">;
+  };
+  streamNext(stream: External<"Stream">): Uint8Array | null;
+}
+
+const libc = familySync() === MUSL ? "musl" : "gnu";
+export const native: NativeModule = require(`@bvisor/linux-${arch()}-${libc}`);

package/src/sandbox.ts

@@ -0,0 +1,60 @@
+import { External } from "./napi";
+import { native } from "./native";
+
+class Stream {
+  private ptr: External<"Stream">;
+
+  constructor(ptr: External<"Stream">) {
+    this.ptr = ptr;
+  }
+
+  toReadableStream(): ReadableStream<Uint8Array> {
+    const self = this;
+    return new ReadableStream({
+      async pull(controller) {
+        // TODO: make streamNext return a promise
+        const chunk = native.streamNext(self.ptr);
+        if (chunk) {
+          controller.enqueue(chunk);
+        } else {
+          controller.close();
+        }
+      },
+    });
+  }
+}
+
+export class Sandbox {
+  private ptr: External<"Sandbox">;
+
+  constructor() {
+    this.ptr = native.createSandbox();
+  }
+
+  runCmd(command: string) {
+    const result = native.sandboxRunCmd(this.ptr, command);
+    return createOutput(
+      new Stream(result.stdout).toReadableStream(),
+      new Stream(result.stderr).toReadableStream()
+    );
+  }
+}
+
+export interface Output {
+  stdoutStream: ReadableStream<Uint8Array>;
+  stderrStream: ReadableStream<Uint8Array>;
+  stdout: () => Promise<string>;
+  stderr: () => Promise<string>;
+}
+
+function createOutput(
+  stdoutStream: ReadableStream<Uint8Array>,
+  stderrStream: ReadableStream<Uint8Array>
+): Output {
+  return {
+    stdoutStream,
+    stderrStream,
+    stdout: () => new Response(stdoutStream).text(),
+    stderr: () => new Response(stderrStream).text(),
+  };
+}