@lizard-build/sdk 0.1.43 → 0.1.44

package/README.md

@@ -1,4 +1,4 @@
-# Lizard TypeScript SDK
+# Lizard SDK for TypeScript
 
 Run commands, work with files and execute code in Linux sandboxes on Kubernetes. The SDK also manages Lizard apps, databases, storage and projects.
 
@@ -51,26 +51,26 @@ const result = await sandbox.process.exec('printf "hello\\n"', {
 if (result.exitCode !== 0) throw new Error(result.stderr)
 ```
 
-## Run code
+## Run Python
 
-`CodeSandbox` uses the `code-interpreter-v1` template by default. Code errors appear in `result.error`; request failures throw.
+Run Python with the `interpreter` template. Each process command starts a separate Python process, so Python variables do not survive between calls. Save intermediate results to files. The API returns stdout, stderr, and an exit code; it does not return typed notebook results or chart objects.
 
 ```ts
-import { CodeSandbox } from '@lizard-build/sdk'
+import { Sandbox } from '@lizard-build/sdk';
 
-const sandbox = await CodeSandbox.create({ project: 'my-project' })
+const sandbox = await Sandbox.create('interpreter', {
+  projectId: 'proj_123', timeoutMs: 300_000,
+});
 try {
-  const result = await sandbox.runCode('print(6 * 7)', {
-    language: 'python',
-    timeoutMs: 60_000,
-    onStdout: chunk => process.stdout.write(chunk),
-  })
-  if (result.error) throw result.error
+  const result = await sandbox.process.exec("python -c 'print(2 ** 10)'");
+  console.log(result.stdout, result.stderr, result.exitCode);
 } finally {
-  await sandbox.kill()
+  await sandbox.kill();
 }
 ```
 
+`CodeSandbox`, `runCode` / `run_code`, and execution-context methods remain in the SDK, but the hosted template catalog does not provide their required execution server. The legacy default `code-interpreter-v1` is unavailable. Changing its name to `interpreter` does not enable this API. Use `Sandbox.create("interpreter")` and process commands as shown below.
+
 ## Configuration
 
 The SDK reads `LIZARD_API_KEY` and, optionally, `LIZARD_API_URL` (default: `https://lizard.build`). You can also pass `apiKey` and `apiUrl` to the constructor or static sandbox methods.
@@ -79,10 +79,16 @@ Pass `timeoutMs` to `create()` to set the sandbox lifetime. The default is five
 
 ## Runtime limits
 
-Sandboxes run on Kubernetes. Use volumes mounted at `/workspace` to keep files after a sandbox ends. Pause, resume, fork, snapshot creation and snapshot restore return HTTP 501 on the current backend.
+Sandboxes run on Kubernetes. Use volumes mounted at `/workspace` to keep files after a sandbox ends. Pause, resume, fork, snapshot creation, snapshot restore, and file watching return HTTP 501 on the current backend.
 
 `getHost()` returns a hostname without `https://`. File writes accept UTF-8 text or valid UTF-8 bytes; `readBytes()` supports binary downloads.
 
+## Current command and lifetime limits
+
+Command results contain stdout, stderr, and the exit code. Command timeouts are limited to 1–600 seconds. The current runtime does not apply the SDK command options `envs`, `workdir`, or `user`; set the directory and environment in the shell command when needed. Create-time `envs` and `metadata` are also not applied.
+
+The SDK and CLI default to a five-minute lifetime. The raw API and dashboard default to no expiration. Set an explicit lifetime: `timeoutMs: 0` at creation disables expiration; a positive value sets a deadline. `setTimeout` accepts 1000–2147483647 ms, not zero. Commands do not reset the deadline. This is not an idle timer.
+
 ## Learn more
 
 - [Sandbox reference](https://github.com/lizard-build/lizard-sdk/blob/main/docs/sandboxes.md)

package/dist/index.d.mts

@@ -813,14 +813,15 @@ declare class Sandbox extends SandboxClient {
      * Create a new Lizard sandbox from the specified template.
      *
      * Template availability and installed tools depend on the platform and region.
-     * Use `base` for shell commands or `CodeSandbox` for stateful code execution.
+     * Use `base` for shell commands or `interpreter` for Python process commands.
+     * Hosted templates do not support the legacy `CodeSandbox` execution API.
      *
      * @param template Name of the sandbox template to boot from.
      *
      * @example
      * ```ts
      * const sandbox = await Sandbox.create('base', { project: 'my-project' })
-     * const pythonSandbox = await Sandbox.create('code-interpreter-v1', { project: 'my-project', timeoutMs: 10 * 60 * 1000 })
+     * const pythonSandbox = await Sandbox.create('interpreter', { project: 'my-project', timeoutMs: 10 * 60 * 1000 })
      * ```
      */
     static create(template: string, opts?: SandboxOpts): Promise<Sandbox>;
@@ -1682,31 +1683,14 @@ interface CreateContextOpts {
 }
 
 /**
- * A Lizard sandbox with built-in stateful code execution.
+ * Legacy client for the code-interpreter execution server.
  *
- * Extends the base Sandbox with `runCode()` — executes code in a persistent
- * kernel so variables and imports survive between calls.
+ * Current hosted templates do not provide this server. The default
+ * `code-interpreter-v1` template is unavailable; selecting `interpreter`
+ * does not enable this API. Use `Sandbox.create('interpreter', options)`
+ * and `sandbox.process.exec()` for Python commands instead.
  *
- * Supports Python, JavaScript (Node.js), and Bash out of the box.
- *
- * @example
- * ```ts
- * import { CodeSandbox } from '@lizard-build/sdk'
- *
- * const sandbox = await CodeSandbox.create({ project: 'my-project' })
- *
- * await sandbox.runCode('x = 42')
- * const result = await sandbox.runCode('print(x * 2)')
- * console.log(result.stdout) // "84\n"
- *
- * await sandbox.kill()
- * ```
- *
- * @example Run JavaScript:
- * ```ts
- * const result = await sandbox.runCode('1 + 1', { language: 'javascript' })
- * console.log(result.results[0].data) // "2"
- * ```
+ * The methods remain for compatibility with a separately provided server.
  */
 declare class CodeSandbox extends Sandbox {
     protected static readonly defaultTemplate = "code-interpreter-v1";

package/dist/index.d.ts

@@ -813,14 +813,15 @@ declare class Sandbox extends SandboxClient {
      * Create a new Lizard sandbox from the specified template.
      *
      * Template availability and installed tools depend on the platform and region.
-     * Use `base` for shell commands or `CodeSandbox` for stateful code execution.
+     * Use `base` for shell commands or `interpreter` for Python process commands.
+     * Hosted templates do not support the legacy `CodeSandbox` execution API.
      *
      * @param template Name of the sandbox template to boot from.
      *
      * @example
      * ```ts
      * const sandbox = await Sandbox.create('base', { project: 'my-project' })
-     * const pythonSandbox = await Sandbox.create('code-interpreter-v1', { project: 'my-project', timeoutMs: 10 * 60 * 1000 })
+     * const pythonSandbox = await Sandbox.create('interpreter', { project: 'my-project', timeoutMs: 10 * 60 * 1000 })
      * ```
      */
     static create(template: string, opts?: SandboxOpts): Promise<Sandbox>;
@@ -1682,31 +1683,14 @@ interface CreateContextOpts {
 }
 
 /**
- * A Lizard sandbox with built-in stateful code execution.
+ * Legacy client for the code-interpreter execution server.
  *
- * Extends the base Sandbox with `runCode()` — executes code in a persistent
- * kernel so variables and imports survive between calls.
+ * Current hosted templates do not provide this server. The default
+ * `code-interpreter-v1` template is unavailable; selecting `interpreter`
+ * does not enable this API. Use `Sandbox.create('interpreter', options)`
+ * and `sandbox.process.exec()` for Python commands instead.
  *
- * Supports Python, JavaScript (Node.js), and Bash out of the box.
- *
- * @example
- * ```ts
- * import { CodeSandbox } from '@lizard-build/sdk'
- *
- * const sandbox = await CodeSandbox.create({ project: 'my-project' })
- *
- * await sandbox.runCode('x = 42')
- * const result = await sandbox.runCode('print(x * 2)')
- * console.log(result.stdout) // "84\n"
- *
- * await sandbox.kill()
- * ```
- *
- * @example Run JavaScript:
- * ```ts
- * const result = await sandbox.runCode('1 + 1', { language: 'javascript' })
- * console.log(result.results[0].data) // "2"
- * ```
+ * The methods remain for compatibility with a separately provided server.
  */
 declare class CodeSandbox extends Sandbox {
     protected static readonly defaultTemplate = "code-interpreter-v1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizard-build/sdk",
-  "version": "0.1.43",
+  "version": "0.1.44",
   "description": "TypeScript SDK for Lizard: Kubernetes sandboxes, code execution and cloud apps.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",