@lizard-build/sdk 0.1.40 → 0.1.41

package/dist/index.d.ts

@@ -114,7 +114,7 @@ declare class AddonsAPI {
         memoryMb?: number;
         storageGb?: number;
     }): Promise<Addon>;
-    /** Restart an addon VM. */
+    /** Restart an addon. */
     redeploy(projectId: string, addonId: string): Promise<void>;
     rename(projectId: string, addonId: string, name: string): Promise<unknown>;
     secrets(projectId: string, addonId: string): Promise<Array<{
@@ -395,7 +395,7 @@ interface ProcessInfo {
 /** Signals accepted by {@link Process.kill}. */
 type ProcessSignal = 'SIGTERM' | 'SIGKILL' | 'SIGINT' | 'SIGHUP' | 'SIGQUIT' | 'SIGUSR1' | 'SIGUSR2';
 /**
- * The result of a process execution inside a Lizard microVM.
+ * The result of a process execution inside a Lizard sandbox.
  */
 interface ProcessResult {
     stdout: string;
@@ -418,7 +418,7 @@ interface ProcessOpts {
     onPid?: (pid: number) => void;
 }
 /**
- * Runs processes inside a Lizard sandbox microVM.
+ * Runs processes inside a Lizard sandbox.
  *
  * Access via `sandbox.process`.
  */
@@ -427,12 +427,12 @@ declare class Process {
     private readonly config;
     constructor(sandboxId: string, config: ConnectionConfig);
     /**
-     * Execute a command inside the microVM and wait for it to complete.
+     * Execute a command inside the sandbox and wait for it to complete.
      *
      * The command runs in a shell inside the Lizard sandbox and returns
      * stdout, stderr, and the exit code when it finishes.
      *
-     * @param cmd Shell command to run inside the microVM.
+     * @param cmd Shell command to run inside the sandbox.
      * @param opts Optional execution options — environment variables, working
      *   directory, user, and timeout.
      *
@@ -511,7 +511,7 @@ interface FileInfo {
     modTime?: number;
 }
 /**
- * Read and write files inside a Lizard sandbox microVM.
+ * Read and write files inside a Lizard sandbox.
  *
  * Access via `sandbox.fs`.
  */
@@ -520,23 +520,24 @@ declare class Fs {
     private readonly config;
     constructor(sandboxId: string, config: ConnectionConfig);
     /**
-     * Write a file into the microVM filesystem.
+     * Write a file into the sandbox filesystem.
      *
      * Creates parent directories automatically if they don't exist.
+     * Byte input must contain valid UTF-8; arbitrary binary uploads are unsupported.
      *
      * @example
      * ```ts
      * await sandbox.fs.write('/app/index.js', 'console.log("hello")')
      * ```
      *
-     * @example Write binary data:
+     * @example Write UTF-8 bytes:
      * ```ts
-     * await sandbox.fs.write('/app/data.bin', buffer)
+     * await sandbox.fs.write('/app/notes.txt', new TextEncoder().encode('hello'))
      * ```
      */
     write(path: string, data: string | Uint8Array, opts?: FsOpts): Promise<void>;
     /**
-     * Read a file from the microVM filesystem.
+     * Read a file from the sandbox filesystem.
      *
      * @returns The file contents as a UTF-8 string.
      *
@@ -546,22 +547,23 @@ declare class Fs {
      * ```
      */
     read(path: string, opts?: FsOpts): Promise<string>;
+    /** Read a file as bytes. */
+    readBytes(path: string, opts?: FsOpts): Promise<Uint8Array>;
     /**
-     * List files and directories at the given path inside the microVM.
+     * List files and directories at the given path inside the sandbox.
      *
      * @example
      * ```ts
      * const entries = await sandbox.fs.list('/app')
      * ```
      */
-    readBytes(path: string, opts?: FsOpts): Promise<Uint8Array>;
     list(path: string, opts?: FsOpts): Promise<FileInfo[]>;
     /**
-     * Remove a file or directory from the microVM filesystem.
+     * Remove a file or directory from the sandbox filesystem.
      */
     remove(path: string, opts?: FsOpts): Promise<void>;
     /**
-     * Create a directory (and any missing parents) inside the microVM.
+     * Create a directory (and any missing parents) inside the sandbox.
      */
     makeDir(path: string, opts?: FsOpts): Promise<void>;
     /**
@@ -730,10 +732,9 @@ declare class SandboxClient {
 }
 
 /**
- * A Lizard sandbox — an isolated Linux environment that starts in under a second.
+ * A Linux sandbox running on Kubernetes.
  *
- * Each sandbox is a full Linux environment with its own filesystem, network, and
- * process namespace, restored from a pre-warmed template snapshot.
+ * Run commands, read and write files, and expose HTTP ports in a sandbox.
  *
  * Sandboxes are **ephemeral**: killing one, or letting it hit its timeout, discards
  * everything written inside it. State that has to outlive a sandbox belongs on a
@@ -745,10 +746,14 @@ declare class SandboxClient {
  * import { Sandbox } from '@lizard-build/sdk'
  *
  * const sandbox = await Sandbox.create('base', { project: 'my-project' })
- * await sandbox.fs.write('/app/index.js', 'console.log("hello world")')
- * const result = await sandbox.process.exec('node /app/index.js')
- * console.log(result.stdout) // "hello world"
- * await sandbox.kill()
+ * try {
+ *   await sandbox.fs.write('/tmp/hello.txt', 'hello world')
+ *   const result = await sandbox.process.exec('cat /tmp/hello.txt')
+ *   if (result.exitCode !== 0) throw new Error(result.stderr)
+ *   console.log(result.stdout)
+ * } finally {
+ *   await sandbox.kill()
+ * }
  * ```
  *
  * @example Carry work across sandboxes with a volume:
@@ -769,11 +774,11 @@ declare class Sandbox extends SandboxClient {
     protected static readonly defaultTemplate: string;
     protected static readonly defaultTimeoutMs: number;
     /**
-     * Unique identifier of this sandbox microVM.
+     * Unique identifier of this sandbox.
      */
     readonly sandboxId: string;
     /**
-     * Read and write files inside the microVM filesystem.
+     * Read and write files inside the sandbox filesystem.
      *
      * @example
      * ```ts
@@ -783,7 +788,7 @@ declare class Sandbox extends SandboxClient {
      */
     readonly fs: Fs;
     /**
-     * Execute processes inside the microVM.
+     * Execute processes inside the sandbox.
      *
      * @example
      * ```ts
@@ -807,16 +812,15 @@ declare class Sandbox extends SandboxClient {
     /**
      * Create a new Lizard sandbox from the specified template.
      *
-     * Available templates: `base` (Debian + Node.js 26) and `code-interpreter-v1`
-     * (Python 3.14 + Node.js 26). Custom templates can be built and pushed via
-     * `lizard push`.
+     * Template availability and installed tools depend on the platform and region.
+     * Use `base` for shell commands or `CodeSandbox` for stateful code execution.
      *
      * @param template Name of the sandbox template to boot from.
      *
      * @example
      * ```ts
      * const sandbox = await Sandbox.create('base', { project: 'my-project' })
-     * const sandbox = await Sandbox.create('code-interpreter-v1', { project: 'my-project', timeoutMs: 10 * 60 * 1000 })
+     * const pythonSandbox = await Sandbox.create('code-interpreter-v1', { project: 'my-project', timeoutMs: 10 * 60 * 1000 })
      * ```
      */
     static create(template: string, opts?: SandboxOpts): Promise<Sandbox>;
@@ -826,11 +830,7 @@ declare class Sandbox extends SandboxClient {
      * Verifies the sandbox exists and is reachable, then returns a handle to it.
      * Throws `NotFoundError` if it has been killed or has expired.
      *
-     * This used to call `resume` first, on the assumption that a sandbox you are
-     * reconnecting to might be paused. Sandboxes are pods now and pause/resume is a
-     * `501` on every one of them, so that call turned every `connect()` into an
-     * error against a perfectly healthy sandbox. Connecting does not need to change
-     * a sandbox's state, so it no longer tries to.
+     * Connecting reads sandbox metadata without changing its state.
      *
      * @example
      * ```ts
@@ -852,25 +852,21 @@ declare class Sandbox extends SandboxClient {
     /**
      * Kill the sandbox and release its resources immediately.
      *
-     * @returns `true` if the microVM was terminated, `false` if it was already gone.
+     * @returns `true` if the sandbox was terminated, `false` if it was already gone.
      */
     kill(opts?: ConnectionOpts): Promise<boolean>;
     /**
-     * Pause the sandbox by freezing it in place.
+     * Request sandbox pause. The Kubernetes backend returns HTTP 501.
      *
-     * @deprecated Not implemented for the current runtime — always throws
-     * `LizardError` with HTTP 501. Sandboxes run as pods, and the equivalent is a CRIU
-     * checkpoint of the pod, which is not built. To park work across a gap, put it on a
-     * {@link Volume} and create a fresh sandbox on that volume later; the volume is the
-     * part that is meant to outlive a sandbox.
+     * @deprecated Unsupported on Kubernetes. Save files to a {@link Volume}
+     * and attach it to a new sandbox instead.
      */
     pause(opts?: ConnectionOpts): Promise<boolean>;
     /**
-     * Resume a paused sandbox.
+     * Request sandbox resume. The Kubernetes backend returns HTTP 501.
      *
-     * @deprecated Not implemented for the current runtime — always throws
-     * `LizardError` with HTTP 501. See {@link pause}. `Sandbox.connect()` no longer
-     * calls this, so reconnecting to a running sandbox works without it.
+     * @deprecated Unsupported on Kubernetes. Use {@link Sandbox.connect} to
+     * reconnect to a running sandbox.
      */
     resume(opts?: ConnectionOpts): Promise<boolean>;
     /**
@@ -884,23 +880,25 @@ declare class Sandbox extends SandboxClient {
      */
     setTimeout(timeoutMs: number, opts?: ConnectionOpts): Promise<void>;
     /**
-     * Get the public HTTPS URL for a port exposed inside the sandbox.
+     * Register a public HTTPS route and return its hostname without a scheme.
      *
-     * Useful for accessing HTTP servers started inside the microVM from your
+     * Useful for accessing HTTP servers started inside the sandbox from your
      * agent or tests without additional tunneling.
      *
      * @example
      * ```ts
-     * await sandbox.process.exec('npx -y serve -p 3000 &')
-     * const url = sandbox.getHost(3000)
-     * // https://{sandboxId}-3000.sandbox.{region}.onlizard.com
+     * // Start an HTTP server on port 3000 before exposing it.
+     * const hostname = await sandbox.getHost(3000)
+     * console.log(`https://${hostname}`)
      * ```
      */
     getHost(port: number, opts?: ConnectionOpts): Promise<string>;
+    /** Fork is unsupported on Kubernetes; the backend returns HTTP 501. */
     fork(opts?: {
         count?: number;
         timeoutMs?: number;
     }): Promise<unknown>;
+    /** Snapshot creation is unsupported on Kubernetes; the backend returns HTTP 501. */
     snapshot(name?: string): Promise<unknown>;
     unexpose(port: number): Promise<void>;
     logs(opts?: {
@@ -908,6 +906,7 @@ declare class Sandbox extends SandboxClient {
         signal?: AbortSignal;
     }): AsyncGenerator<StreamEvent, any, any>;
     static snapshots(projectId: string, opts?: ConnectionOpts): Promise<unknown[]>;
+    /** Snapshot restore is unsupported on Kubernetes; the backend returns HTTP 501. */
     static restore(snapshotId: string, opts?: ConnectionOpts & {
         timeoutMs?: number;
     }): Promise<Sandbox>;
@@ -1602,7 +1601,7 @@ type OutputItem = {
     message: string;
     traceback: string;
 };
-/** Error thrown when executed code raises an exception. */
+/** Error returned in Execution.error when executed code raises an exception. */
 declare class ExecutionError extends Error {
     readonly name: string;
     readonly traceback: string;
@@ -1637,7 +1636,7 @@ interface RunCodeOpts {
     context?: CodeContext;
     /** Extra environment variables available to the code. */
     envs?: Record<string, string>;
-    /** Max time to wait for the code to finish, in ms. Default: 60_000. */
+    /** Client timeout in milliseconds. No client timer is set when omitted. */
     timeoutMs?: number;
     onStdout?: (data: string) => void;
     onStderr?: (data: string) => void;
@@ -1659,7 +1658,7 @@ interface CreateContextOpts {
  *
  * @example
  * ```ts
- * import { CodeSandbox } from 'lizard/code-interpreter'
+ * import { CodeSandbox } from '@lizard-build/sdk'
  *
  * const sandbox = await CodeSandbox.create({ project: 'my-project' })
  *
@@ -1690,8 +1689,7 @@ declare class CodeSandbox extends Sandbox {
      *
      * @returns Execution result with stdout, stderr, results, and any error.
      *
-     * @throws {ExecutionError} if you pass neither language nor context and no
-     *   default context exists — which cannot happen in normal usage.
+     * Code errors appear in `execution.error`; request failures throw.
      *
      * @example
      * ```ts

package/dist/index.js

@@ -501,12 +501,12 @@ var Process = class {
     this.config = config;
   }
   /**
-   * Execute a command inside the microVM and wait for it to complete.
+   * Execute a command inside the sandbox and wait for it to complete.
    *
    * The command runs in a shell inside the Lizard sandbox and returns
    * stdout, stderr, and the exit code when it finishes.
    *
-   * @param cmd Shell command to run inside the microVM.
+   * @param cmd Shell command to run inside the sandbox.
    * @param opts Optional execution options — environment variables, working
    *   directory, user, and timeout.
    *
@@ -638,18 +638,19 @@ var Fs = class {
     this.config = config;
   }
   /**
-   * Write a file into the microVM filesystem.
+   * Write a file into the sandbox filesystem.
    *
    * Creates parent directories automatically if they don't exist.
+   * Byte input must contain valid UTF-8; arbitrary binary uploads are unsupported.
    *
    * @example
    * ```ts
    * await sandbox.fs.write('/app/index.js', 'console.log("hello")')
    * ```
    *
-   * @example Write binary data:
+   * @example Write UTF-8 bytes:
    * ```ts
-   * await sandbox.fs.write('/app/data.bin', buffer)
+   * await sandbox.fs.write('/app/notes.txt', new TextEncoder().encode('hello'))
    * ```
    */
   async write(path, data, opts) {
@@ -662,7 +663,7 @@ var Fs = class {
     if (!res.ok) await handleApiError(res);
   }
   /**
-   * Read a file from the microVM filesystem.
+   * Read a file from the sandbox filesystem.
    *
    * @returns The file contents as a UTF-8 string.
    *
@@ -679,14 +680,7 @@ var Fs = class {
     if (!res.ok) await handleApiError(res);
     return res.text();
   }
-  /**
-   * List files and directories at the given path inside the microVM.
-   *
-   * @example
-   * ```ts
-   * const entries = await sandbox.fs.list('/app')
-   * ```
-   */
+  /** Read a file as bytes. */
   async readBytes(path, opts) {
     const url = new URL(`${this.config.apiUrl}/api/sandboxes/${this.sandboxId}/files`);
     url.searchParams.set("path", path);
@@ -695,6 +689,14 @@ var Fs = class {
     if (!res.ok) await handleApiError(res);
     return new Uint8Array(await res.arrayBuffer());
   }
+  /**
+   * List files and directories at the given path inside the sandbox.
+   *
+   * @example
+   * ```ts
+   * const entries = await sandbox.fs.list('/app')
+   * ```
+   */
   async list(path, opts) {
     const url = new URL(`${this.config.apiUrl}/api/sandboxes/${this.sandboxId}/files/list`);
     url.searchParams.set("path", path);
@@ -704,7 +706,7 @@ var Fs = class {
     return res.json();
   }
   /**
-   * Remove a file or directory from the microVM filesystem.
+   * Remove a file or directory from the sandbox filesystem.
    */
   async remove(path, opts) {
     const res = await fetch(`${this.config.apiUrl}/api/sandboxes/${this.sandboxId}/files`, {
@@ -715,7 +717,7 @@ var Fs = class {
     if (!res.ok) await handleApiError(res);
   }
   /**
-   * Create a directory (and any missing parents) inside the microVM.
+   * Create a directory (and any missing parents) inside the sandbox.
    */
   async makeDir(path, opts) {
     await this.execInternal(`mkdir -p ${JSON.stringify(path)}`, opts?.user);
@@ -943,11 +945,7 @@ var Sandbox = class extends SandboxClient {
    * Verifies the sandbox exists and is reachable, then returns a handle to it.
    * Throws `NotFoundError` if it has been killed or has expired.
    *
-   * This used to call `resume` first, on the assumption that a sandbox you are
-   * reconnecting to might be paused. Sandboxes are pods now and pause/resume is a
-   * `501` on every one of them, so that call turned every `connect()` into an
-   * error against a perfectly healthy sandbox. Connecting does not need to change
-   * a sandbox's state, so it no longer tries to.
+   * Connecting reads sandbox metadata without changing its state.
    *
    * @example
    * ```ts
@@ -972,29 +970,25 @@ var Sandbox = class extends SandboxClient {
   /**
    * Kill the sandbox and release its resources immediately.
    *
-   * @returns `true` if the microVM was terminated, `false` if it was already gone.
+   * @returns `true` if the sandbox was terminated, `false` if it was already gone.
    */
   async kill(opts) {
     return SandboxClient.killSandbox(this.sandboxId, this.resolveOpts(opts));
   }
   /**
-   * Pause the sandbox by freezing it in place.
+   * Request sandbox pause. The Kubernetes backend returns HTTP 501.
    *
-   * @deprecated Not implemented for the current runtime — always throws
-   * `LizardError` with HTTP 501. Sandboxes run as pods, and the equivalent is a CRIU
-   * checkpoint of the pod, which is not built. To park work across a gap, put it on a
-   * {@link Volume} and create a fresh sandbox on that volume later; the volume is the
-   * part that is meant to outlive a sandbox.
+   * @deprecated Unsupported on Kubernetes. Save files to a {@link Volume}
+   * and attach it to a new sandbox instead.
    */
   async pause(opts) {
     return SandboxClient.pauseSandbox(this.sandboxId, this.resolveOpts(opts));
   }
   /**
-   * Resume a paused sandbox.
+   * Request sandbox resume. The Kubernetes backend returns HTTP 501.
    *
-   * @deprecated Not implemented for the current runtime — always throws
-   * `LizardError` with HTTP 501. See {@link pause}. `Sandbox.connect()` no longer
-   * calls this, so reconnecting to a running sandbox works without it.
+   * @deprecated Unsupported on Kubernetes. Use {@link Sandbox.connect} to
+   * reconnect to a running sandbox.
    */
   async resume(opts) {
     return SandboxClient.resumeSandbox(this.sandboxId, this.resolveOpts(opts));
@@ -1014,25 +1008,27 @@ var Sandbox = class extends SandboxClient {
     return SandboxClient.setTimeoutSandbox(this.sandboxId, timeoutMs, this.resolveOpts(opts));
   }
   /**
-   * Get the public HTTPS URL for a port exposed inside the sandbox.
+   * Register a public HTTPS route and return its hostname without a scheme.
    *
-   * Useful for accessing HTTP servers started inside the microVM from your
+   * Useful for accessing HTTP servers started inside the sandbox from your
    * agent or tests without additional tunneling.
    *
    * @example
    * ```ts
-   * await sandbox.process.exec('npx -y serve -p 3000 &')
-   * const url = sandbox.getHost(3000)
-   * // https://{sandboxId}-3000.sandbox.{region}.onlizard.com
+   * // Start an HTTP server on port 3000 before exposing it.
+   * const hostname = await sandbox.getHost(3000)
+   * console.log(`https://${hostname}`)
    * ```
    */
   async getHost(port, opts) {
     const { hostname } = await SandboxClient.exposeSandboxPort(this.sandboxId, port, this.resolveOpts(opts));
     return hostname;
   }
+  /** Fork is unsupported on Kubernetes; the backend returns HTTP 501. */
   fork(opts = {}) {
     return new PlatformClient(this.resolveOpts()).post(`/api/sandboxes/${this.sandboxId}/fork`, { count: opts.count ?? 1, timeoutMs: opts.timeoutMs ?? 0 });
   }
+  /** Snapshot creation is unsupported on Kubernetes; the backend returns HTTP 501. */
   snapshot(name) {
     return new PlatformClient(this.resolveOpts()).post(`/api/sandboxes/${this.sandboxId}/snapshot`, { name });
   }
@@ -1045,6 +1041,7 @@ var Sandbox = class extends SandboxClient {
   static snapshots(projectId, opts) {
     return new PlatformClient(opts ?? {}).get(`/api/projects/${projectId}/snapshots`);
   }
+  /** Snapshot restore is unsupported on Kubernetes; the backend returns HTTP 501. */
   static async restore(snapshotId, opts) {
     const result = await new PlatformClient(opts ?? {}).post(`/api/sandbox-snapshots/${encodeURIComponent(snapshotId)}/fork`, { timeoutMs: opts?.timeoutMs ?? 0 });
     return new this({ ...opts, sandboxId: result.sandboxId ?? result.id });
@@ -1157,7 +1154,7 @@ var AddonsAPI = class {
     });
     return this.get(projectId, addonId);
   }
-  /** Restart an addon VM. */
+  /** Restart an addon. */
   redeploy(projectId, addonId) {
     return this.client.post(`/api/projects/${projectId}/addons/${addonId}/redeploy`, {});
   }
@@ -1759,8 +1756,7 @@ var CodeSandbox = class extends Sandbox {
    *
    * @returns Execution result with stdout, stderr, results, and any error.
    *
-   * @throws {ExecutionError} if you pass neither language nor context and no
-   *   default context exists — which cannot happen in normal usage.
+   * Code errors appear in `execution.error`; request failures throw.
    *
    * @example
    * ```ts