sandboxedjs 0.1.23 → 0.1.25

package/dist/index.d.cts

@@ -1605,38 +1605,21 @@ interface ContainerOptions {
     /** Invoked when an in-container HTTP server starts listening. */
     onServerReady?: (port: number, url: string) => void;
     /**
-     * Supply the Nodepod instance instead of letting the container boot one.
+     * Run on a JavaScript runtime you booted yourself.
      *
-     * The default path imports `@scelar/nodepod/headless`, which installs a
-     * `worker_threads` host and is the right choice on Node. In a browser you
-     * boot Nodepod's browser build yourself (it needs a service worker) and hand
-     * the instance over:
+     * The container boots a {@link LocalRuntimePod} when this is omitted, which
+     * is what almost every caller wants. Pass one to share a single runtime
+     * across containers, to seed it differently, or to substitute an
+     * implementation of your own — anything satisfying {@link RuntimePod} works.
      *
      * ```ts
-     * import { Nodepod } from "@scelar/nodepod";
-     * const pod = await Nodepod.boot({ ... });
-     * const box = await createContainer({ pod });
+     * const pod = await LocalRuntimePod.boot({ workdir: "/app" });
+     * const box = await createContainer({ pod, cwd: "/app" });
      * ```
      */
     pod?: RuntimePod;
-    /**
-     * JavaScript runtime implementation. `sandboxedjs` selects the new
-     * clean-room engine while it completes compatibility validation.
-     */
-    runtime?: "sandboxedjs" | "nodepod";
     /** Python runtime settings; a browser host uses this to locate the wasm. */
     python?: PythonOptions;
-    /**
-     * Forwarded to Nodepod when this package boots it in a browser. `swUrl`
-     * points at the service worker if you serve it somewhere other than
-     * `/__sw__.js`; `serviceWorker: false` skips registration entirely, which
-     * also disables preview iframes.
-     */
-    browser?: {
-        swUrl?: string;
-        serviceWorker?: boolean;
-        watermark?: boolean;
-    };
 }
 interface ExecOptions {
     cwd?: string;
@@ -1860,13 +1843,13 @@ declare function exitCodeForSignal(sig: string): number;
 /**
  * The identity the container reports for itself.
  *
- * The release string deliberately matches what Nodepod's `os.release()` returns
- * inside a spawned Node process, so `uname -r` and
- * `node -p "os.release()"` agree.
+ * The runtime's `os.release()` is built from these same constants, so `uname -r`
+ * and `node -p "os.release()"` agree inside the container — a program that
+ * checks the platform gets one answer whichever way it asks.
  */
 declare const KERNEL_NAME = "Linux";
 declare const KERNEL_RELEASE = "5.10.0";
-declare const OS_RELEASE = "PRETTY_NAME=\"SandboxedJS 1.0 (nodepod)\"\nNAME=\"SandboxedJS\"\nVERSION_ID=\"1.0\"\nVERSION=\"1.0 (nodepod)\"\nVERSION_CODENAME=nodepod\nID=sandboxedjs\nID_LIKE=debian\nHOME_URL=\"https://github.com/R1ck404/Nodepod\"\nSUPPORT_URL=\"https://www.npmjs.com/package/sandboxedjs\"\n";
+declare const OS_RELEASE = "PRETTY_NAME=\"SandboxedJS 1.0 (sandbox)\"\nNAME=\"SandboxedJS\"\nVERSION_ID=\"1.0\"\nVERSION=\"1.0 (sandbox)\"\nVERSION_CODENAME=sandbox\nID=sandboxedjs\nID_LIKE=debian\nHOME_URL=\"https://www.npmjs.com/package/sandboxedjs\"\nSUPPORT_URL=\"https://www.npmjs.com/package/sandboxedjs\"\n";
 interface UnameInfo {
     sysname: string;
     nodename: string;
@@ -2137,8 +2120,9 @@ declare function buildRootfs(vfs: Vfs, opts?: RootfsOptions): void;
 declare const NODE_VERSION = "v22.12.0";
 
 /**
- * Package managers: `npm`/`npx`/`yarn`/`pnpm` on top of Nodepod's installer,
- * and an `apt`-shaped front end for the things a container image would ship.
+ * Package managers: `npm`/`npx`/`yarn`/`pnpm` on top of the runtime's package
+ * installer, and an `apt`-shaped front end for the things a container image
+ * would ship.
  */
 
 declare const NPM_VERSION = "10.9.0";
@@ -2416,6 +2400,8 @@ declare class VirtualHttpServer extends EventEmitter {
 }
 declare class VirtualHttpRouter {
     private readonly servers;
+    /** Notified when a server begins listening, for `onServerReady`. */
+    onListen: ((port: number) => void) | undefined;
     register(port: number, server: VirtualHttpServer, owner: string): void;
     unregister(port: number, server: VirtualHttpServer): void;
     activePorts(owner?: string): number[];
@@ -2438,6 +2424,8 @@ interface CoreModulesOptions {
     };
     /** Backs `child_process`; without it the module reports as unavailable. */
     spawnChild?: SpawnChild;
+    /** File holding the process's standard input, exposed as descriptor 0. */
+    stdinPath?: string;
 }
 /** Build the core-module table injected into each isolated JS worker. */
 declare function createCoreModules(options: CoreModulesOptions): {
@@ -2489,6 +2477,8 @@ interface LocalRuntimeOptions {
     files?: Record<string, string | Uint8Array>;
     registry?: string;
     fetch?: typeof globalThis.fetch;
+    /** Invoked when a program inside the runtime starts listening on a port. */
+    onServerReady?: (port: number, url: string) => void;
     /** Extra package substitutions, merged over {@link WASM_ALIASES}. */
     aliases?: Record<string, string>;
     /** Modules supplied by the host rather than resolved from the volume. */
@@ -2537,6 +2527,7 @@ declare class LocalRuntimePod implements RuntimePod {
     private readonly env;
     private readonly aliases;
     private readonly modules;
+    private readonly esbuild;
     private constructor();
     static boot(options?: LocalRuntimeOptions): Promise<LocalRuntimePod>;
     spawn(command: string, args?: string[], options?: Record<string, unknown>): Promise<RuntimeProcess>;
@@ -2544,9 +2535,16 @@ declare class LocalRuntimePod implements RuntimePod {
      * Wait until the process has either started serving or genuinely run out of
      * work.
      *
-     * Timers are the observable half of the event loop, so a process with none
-     * outstanding and no port open has finished — and, being the common case for
-     * a plain script, is settled without waiting at all.
+     * Two different kinds of pending work have to be waited on. Callbacks queued
+     * as microtasks or `nextTick` — which is most of what streams and promise
+     * chains are built from — need only for the current turn to end, so a few
+     * turns of the macrotask queue are yielded first. Without that, a script
+     * whose last act is `process.stdin.on("data", …)` exits before its own
+     * handler runs and produces no output at all. Timers are the part that can
+     * outlive any number of turns, so those are then polled until none remain.
+     *
+     * A plain script that has genuinely finished falls straight through both,
+     * costing a handful of empty turns.
      */
     private settle;
     request(_port: number, _init?: Record<string, unknown>): Promise<RuntimeHttpResponse>;

package/dist/index.d.ts

@@ -1605,38 +1605,21 @@ interface ContainerOptions {
     /** Invoked when an in-container HTTP server starts listening. */
     onServerReady?: (port: number, url: string) => void;
     /**
-     * Supply the Nodepod instance instead of letting the container boot one.
+     * Run on a JavaScript runtime you booted yourself.
      *
-     * The default path imports `@scelar/nodepod/headless`, which installs a
-     * `worker_threads` host and is the right choice on Node. In a browser you
-     * boot Nodepod's browser build yourself (it needs a service worker) and hand
-     * the instance over:
+     * The container boots a {@link LocalRuntimePod} when this is omitted, which
+     * is what almost every caller wants. Pass one to share a single runtime
+     * across containers, to seed it differently, or to substitute an
+     * implementation of your own — anything satisfying {@link RuntimePod} works.
      *
      * ```ts
-     * import { Nodepod } from "@scelar/nodepod";
-     * const pod = await Nodepod.boot({ ... });
-     * const box = await createContainer({ pod });
+     * const pod = await LocalRuntimePod.boot({ workdir: "/app" });
+     * const box = await createContainer({ pod, cwd: "/app" });
      * ```
      */
     pod?: RuntimePod;
-    /**
-     * JavaScript runtime implementation. `sandboxedjs` selects the new
-     * clean-room engine while it completes compatibility validation.
-     */
-    runtime?: "sandboxedjs" | "nodepod";
     /** Python runtime settings; a browser host uses this to locate the wasm. */
     python?: PythonOptions;
-    /**
-     * Forwarded to Nodepod when this package boots it in a browser. `swUrl`
-     * points at the service worker if you serve it somewhere other than
-     * `/__sw__.js`; `serviceWorker: false` skips registration entirely, which
-     * also disables preview iframes.
-     */
-    browser?: {
-        swUrl?: string;
-        serviceWorker?: boolean;
-        watermark?: boolean;
-    };
 }
 interface ExecOptions {
     cwd?: string;
@@ -1860,13 +1843,13 @@ declare function exitCodeForSignal(sig: string): number;
 /**
  * The identity the container reports for itself.
  *
- * The release string deliberately matches what Nodepod's `os.release()` returns
- * inside a spawned Node process, so `uname -r` and
- * `node -p "os.release()"` agree.
+ * The runtime's `os.release()` is built from these same constants, so `uname -r`
+ * and `node -p "os.release()"` agree inside the container — a program that
+ * checks the platform gets one answer whichever way it asks.
  */
 declare const KERNEL_NAME = "Linux";
 declare const KERNEL_RELEASE = "5.10.0";
-declare const OS_RELEASE = "PRETTY_NAME=\"SandboxedJS 1.0 (nodepod)\"\nNAME=\"SandboxedJS\"\nVERSION_ID=\"1.0\"\nVERSION=\"1.0 (nodepod)\"\nVERSION_CODENAME=nodepod\nID=sandboxedjs\nID_LIKE=debian\nHOME_URL=\"https://github.com/R1ck404/Nodepod\"\nSUPPORT_URL=\"https://www.npmjs.com/package/sandboxedjs\"\n";
+declare const OS_RELEASE = "PRETTY_NAME=\"SandboxedJS 1.0 (sandbox)\"\nNAME=\"SandboxedJS\"\nVERSION_ID=\"1.0\"\nVERSION=\"1.0 (sandbox)\"\nVERSION_CODENAME=sandbox\nID=sandboxedjs\nID_LIKE=debian\nHOME_URL=\"https://www.npmjs.com/package/sandboxedjs\"\nSUPPORT_URL=\"https://www.npmjs.com/package/sandboxedjs\"\n";
 interface UnameInfo {
     sysname: string;
     nodename: string;
@@ -2137,8 +2120,9 @@ declare function buildRootfs(vfs: Vfs, opts?: RootfsOptions): void;
 declare const NODE_VERSION = "v22.12.0";
 
 /**
- * Package managers: `npm`/`npx`/`yarn`/`pnpm` on top of Nodepod's installer,
- * and an `apt`-shaped front end for the things a container image would ship.
+ * Package managers: `npm`/`npx`/`yarn`/`pnpm` on top of the runtime's package
+ * installer, and an `apt`-shaped front end for the things a container image
+ * would ship.
  */
 
 declare const NPM_VERSION = "10.9.0";
@@ -2416,6 +2400,8 @@ declare class VirtualHttpServer extends EventEmitter {
 }
 declare class VirtualHttpRouter {
     private readonly servers;
+    /** Notified when a server begins listening, for `onServerReady`. */
+    onListen: ((port: number) => void) | undefined;
     register(port: number, server: VirtualHttpServer, owner: string): void;
     unregister(port: number, server: VirtualHttpServer): void;
     activePorts(owner?: string): number[];
@@ -2438,6 +2424,8 @@ interface CoreModulesOptions {
     };
     /** Backs `child_process`; without it the module reports as unavailable. */
     spawnChild?: SpawnChild;
+    /** File holding the process's standard input, exposed as descriptor 0. */
+    stdinPath?: string;
 }
 /** Build the core-module table injected into each isolated JS worker. */
 declare function createCoreModules(options: CoreModulesOptions): {
@@ -2489,6 +2477,8 @@ interface LocalRuntimeOptions {
     files?: Record<string, string | Uint8Array>;
     registry?: string;
     fetch?: typeof globalThis.fetch;
+    /** Invoked when a program inside the runtime starts listening on a port. */
+    onServerReady?: (port: number, url: string) => void;
     /** Extra package substitutions, merged over {@link WASM_ALIASES}. */
     aliases?: Record<string, string>;
     /** Modules supplied by the host rather than resolved from the volume. */
@@ -2537,6 +2527,7 @@ declare class LocalRuntimePod implements RuntimePod {
     private readonly env;
     private readonly aliases;
     private readonly modules;
+    private readonly esbuild;
     private constructor();
     static boot(options?: LocalRuntimeOptions): Promise<LocalRuntimePod>;
     spawn(command: string, args?: string[], options?: Record<string, unknown>): Promise<RuntimeProcess>;
@@ -2544,9 +2535,16 @@ declare class LocalRuntimePod implements RuntimePod {
      * Wait until the process has either started serving or genuinely run out of
      * work.
      *
-     * Timers are the observable half of the event loop, so a process with none
-     * outstanding and no port open has finished — and, being the common case for
-     * a plain script, is settled without waiting at all.
+     * Two different kinds of pending work have to be waited on. Callbacks queued
+     * as microtasks or `nextTick` — which is most of what streams and promise
+     * chains are built from — need only for the current turn to end, so a few
+     * turns of the macrotask queue are yielded first. Without that, a script
+     * whose last act is `process.stdin.on("data", …)` exits before its own
+     * handler runs and produces no output at all. Timers are the part that can
+     * outlive any number of turns, so those are then polled until none remain.
+     *
+     * A plain script that has genuinely finished falls straight through both,
+     * costing a handful of empty turns.
      */
     private settle;
     request(_port: number, _init?: Record<string, unknown>): Promise<RuntimeHttpResponse>;