langsmith 0.5.21 → 0.5.23

package/dist/experimental/sandbox/client.cjs

@@ -50,7 +50,7 @@ function getDefaultApiKey() {
 /**
  * Client for interacting with the Sandbox Server API.
  *
- * This client provides a simple interface for managing sandboxes and templates.
+ * This client provides a simple interface for managing sandboxes and snapshots.
  *
  * @example
  * ```typescript
@@ -65,8 +65,13 @@ function getDefaultApiKey() {
  *   apiKey: "your-api-key",
  * });
  *
- * // Create a sandbox and run commands
- * const sandbox = await client.createSandbox("python-sandbox");
+ * // Build a snapshot, then create a sandbox from it
+ * const snapshot = await client.createSnapshot(
+ *   "python",
+ *   "python:3.12-slim",
+ *   1_073_741_824 // 1 GiB
+ * );
+ * const sandbox = await client.createSandbox(snapshot.id);
  * try {
  *   const result = await sandbox.run("python --version");
  *   console.log(result.stdout);
@@ -156,421 +161,40 @@ class SandboxClient {
         return response;
     }
     // =========================================================================
-    // Volume Operations
-    // =========================================================================
-    /**
-     * Create a new persistent volume.
-     *
-     * Creates a persistent storage volume that can be referenced in templates.
-     *
-     * @param name - Volume name.
-     * @param options - Creation options including size and optional timeout.
-     * @returns Created Volume.
-     * @throws SandboxCreationError if volume provisioning fails.
-     * @throws ResourceTimeoutError if volume doesn't become ready within timeout.
-     */
-    async createVolume(name, options) {
-        const { size, timeout = 60 } = options;
-        const url = `${this._baseUrl}/volumes`;
-        const payload = {
-            name,
-            size,
-            wait_for_ready: true,
-            timeout,
-        };
-        const response = await this._fetch(url, {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-            signal: AbortSignal.timeout((timeout + 30) * 1000),
-        });
-        if (!response.ok) {
-            await (0, helpers_js_1.handleVolumeCreationError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Get a volume by name.
-     *
-     * @param name - Volume name.
-     * @returns Volume.
-     * @throws LangSmithResourceNotFoundError if volume not found.
-     */
-    async getVolume(name) {
-        const url = `${this._baseUrl}/volumes/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Volume '${name}' not found`, "volume");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * List all volumes.
-     *
-     * @returns List of Volumes.
-     */
-    async listVolumes() {
-        const url = `${this._baseUrl}/volumes`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithSandboxAPIError(`API endpoint not found: ${url}. Check that apiEndpoint is correct.`);
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        const data = await response.json();
-        return (data.volumes ?? []);
-    }
-    /**
-     * Delete a volume.
-     *
-     * @param name - Volume name.
-     * @throws LangSmithResourceNotFoundError if volume not found.
-     * @throws ResourceInUseError if volume is referenced by templates.
-     */
-    async deleteVolume(name) {
-        const url = `${this._baseUrl}/volumes/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url, { method: "DELETE" });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Volume '${name}' not found`, "volume");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleResourceInUseError)(response, "volume");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-    }
-    /**
-     * Update a volume's name and/or size.
-     *
-     * You can update the display name, size, or both in a single request.
-     * Only storage size increases are allowed (storage backend limitation).
-     *
-     * @param name - Current volume name.
-     * @param options - Update options.
-     * @returns Updated Volume.
-     * @throws LangSmithResourceNotFoundError if volume not found.
-     * @throws ValidationError if storage decrease attempted.
-     * @throws LangSmithResourceNameConflictError if newName is already in use.
-     */
-    async updateVolume(name, options) {
-        const { newName, size } = options;
-        if (newName === undefined && size === undefined) {
-            // Nothing to update, just return the current volume
-            return this.getVolume(name);
-        }
-        const url = `${this._baseUrl}/volumes/${encodeURIComponent(name)}`;
-        const payload = {};
-        if (newName !== undefined) {
-            payload.name = newName;
-        }
-        if (size !== undefined) {
-            payload.size = size;
-        }
-        const response = await this._fetch(url, {
-            method: "PATCH",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-        });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Volume '${name}' not found`, "volume");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleConflictError)(response, "volume");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    // =========================================================================
-    // Template Operations
-    // =========================================================================
-    /**
-     * Create a new SandboxTemplate.
-     *
-     * Only the container image, resource limits, and volume mounts can be
-     * configured. All other container details are handled by the server.
-     *
-     * @param name - Template name.
-     * @param options - Creation options including image and resource limits.
-     * @returns Created SandboxTemplate.
-     */
-    async createTemplate(name, options) {
-        const { image, cpu = "500m", memory = "512Mi", storage, volumeMounts, } = options;
-        const url = `${this._baseUrl}/templates`;
-        const payload = {
-            name,
-            image,
-            resources: {
-                cpu,
-                memory,
-            },
-        };
-        if (storage) {
-            payload.resources.storage = storage;
-        }
-        if (volumeMounts && volumeMounts.length > 0) {
-            payload.volume_mounts = volumeMounts.map((vm) => ({
-                volume_name: vm.volume_name,
-                mount_path: vm.mount_path,
-            }));
-        }
-        const response = await this._fetch(url, {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-        });
-        if (!response.ok) {
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Get a SandboxTemplate by name.
-     *
-     * @param name - Template name.
-     * @returns SandboxTemplate.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     */
-    async getTemplate(name) {
-        const url = `${this._baseUrl}/templates/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Template '${name}' not found`, "template");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * List all SandboxTemplates.
-     *
-     * @returns List of SandboxTemplates.
-     */
-    async listTemplates() {
-        const url = `${this._baseUrl}/templates`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithSandboxAPIError(`API endpoint not found: ${url}. Check that apiEndpoint is correct.`);
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        const data = await response.json();
-        return (data.templates ?? []);
-    }
-    /**
-     * Update a template.
-     *
-     * @param name - Current template name.
-     * @param options - Update options (e.g., newName).
-     * @returns Updated SandboxTemplate.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     * @throws LangSmithResourceNameConflictError if newName is already in use.
-     */
-    async updateTemplate(name, options) {
-        const { newName } = options;
-        if (newName === undefined) {
-            // Nothing to update, just return the current template
-            return this.getTemplate(name);
-        }
-        const url = `${this._baseUrl}/templates/${encodeURIComponent(name)}`;
-        const payload = { name: newName };
-        const response = await this._fetch(url, {
-            method: "PATCH",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-        });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Template '${name}' not found`, "template");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleConflictError)(response, "template");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Delete a SandboxTemplate.
-     *
-     * @param name - Template name.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     * @throws ResourceInUseError if template is referenced by sandboxes or pools.
-     */
-    async deleteTemplate(name) {
-        const url = `${this._baseUrl}/templates/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url, { method: "DELETE" });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Template '${name}' not found`, "template");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleResourceInUseError)(response, "template");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-    }
-    // =========================================================================
-    // Pool Operations
-    // =========================================================================
-    /**
-     * Create a new Sandbox Pool.
-     *
-     * Pools pre-provision sandboxes from a template for faster startup.
-     *
-     * @param name - Pool name (lowercase letters, numbers, hyphens; max 63 chars).
-     * @param options - Creation options including templateName, replicas, and optional timeout.
-     * @returns Created Pool.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     * @throws ValidationError if template has volumes attached.
-     * @throws ResourceAlreadyExistsError if pool with this name already exists.
-     * @throws ResourceTimeoutError if pool doesn't reach ready state within timeout.
-     * @throws QuotaExceededError if organization quota is exceeded.
-     */
-    async createPool(name, options) {
-        const { templateName, replicas, timeout = 30 } = options;
-        const url = `${this._baseUrl}/pools`;
-        const payload = {
-            name,
-            template_name: templateName,
-            replicas,
-            wait_for_ready: true,
-            timeout,
-        };
-        const response = await this._fetch(url, {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-            signal: AbortSignal.timeout((timeout + 30) * 1000),
-        });
-        if (!response.ok) {
-            await (0, helpers_js_1.handlePoolError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Get a Pool by name.
-     *
-     * @param name - Pool name.
-     * @returns Pool.
-     * @throws LangSmithResourceNotFoundError if pool not found.
-     */
-    async getPool(name) {
-        const url = `${this._baseUrl}/pools/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Pool '${name}' not found`, "pool");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * List all Pools.
-     *
-     * @returns List of Pools.
-     */
-    async listPools() {
-        const url = `${this._baseUrl}/pools`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithSandboxAPIError(`API endpoint not found: ${url}. Check that apiEndpoint is correct.`);
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        const data = await response.json();
-        return (data.pools ?? []);
-    }
-    /**
-     * Update a Pool's name and/or replica count.
-     *
-     * You can update the display name, replica count, or both.
-     * The template reference cannot be changed after creation.
-     *
-     * @param name - Current pool name.
-     * @param options - Update options.
-     * @returns Updated Pool.
-     * @throws LangSmithResourceNotFoundError if pool not found.
-     * @throws ValidationError if template was deleted.
-     * @throws LangSmithResourceNameConflictError if newName is already in use.
-     * @throws QuotaExceededError if quota exceeded when scaling up.
-     */
-    async updatePool(name, options) {
-        const { newName, replicas } = options;
-        if (newName === undefined && replicas === undefined) {
-            // Nothing to update, just return the current pool
-            return this.getPool(name);
-        }
-        const url = `${this._baseUrl}/pools/${encodeURIComponent(name)}`;
-        const payload = {};
-        if (newName !== undefined) {
-            payload.name = newName;
-        }
-        if (replicas !== undefined) {
-            payload.replicas = replicas;
-        }
-        const response = await this._fetch(url, {
-            method: "PATCH",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-        });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Pool '${name}' not found`, "pool");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleConflictError)(response, "pool");
-            }
-            await (0, helpers_js_1.handlePoolError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Delete a Pool.
-     *
-     * This will terminate all sandboxes in the pool.
-     *
-     * @param name - Pool name.
-     * @throws LangSmithResourceNotFoundError if pool not found.
-     */
-    async deletePool(name) {
-        const url = `${this._baseUrl}/pools/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url, { method: "DELETE" });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Pool '${name}' not found`, "pool");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-    }
-    // =========================================================================
     // Sandbox Operations
     // =========================================================================
     /**
-     * Create a new Sandbox.
+     * Create a new Sandbox from a snapshot.
      *
      * Remember to call `sandbox.delete()` when done to clean up resources.
      *
-     * @param templateName - Name of the SandboxTemplate to use.
-     * @param options - Creation options.
+     * Exactly one of `snapshotId` (positional) or `options.snapshotName` must
+     * be provided. When `snapshotName` is used, the server resolves it to a
+     * snapshot owned by the caller's tenant.
+     *
+     * @param snapshotId - ID of the snapshot to boot from. Create one with
+     *   `createSnapshot()` or `captureSnapshot()`, or pass an existing snapshot ID.
+     *   Pass `undefined` when booting by name via `options.snapshotName`.
+     * @param options - Creation options. Use `options.snapshotName` to boot
+     *   by snapshot name instead of ID.
      * @returns Created Sandbox.
      * @throws ResourceTimeoutError if timeout waiting for sandbox to be ready.
      * @throws SandboxCreationError if sandbox creation fails.
-     * @throws LangSmithValidationError if TTL values are invalid.
+     * @throws LangSmithValidationError if TTL values are invalid, or if neither
+     *   (or both) of `snapshotId` / `options.snapshotName` are provided.
      *
      * @example
      * ```typescript
-     * const sandbox = await client.createSandbox("python-sandbox");
+     * const snapshot = await client.createSnapshot(
+     *   "python",
+     *   "python:3.12-slim",
+     *   1_073_741_824
+     * );
+     * const sandbox = await client.createSandbox(snapshot.id);
+     * // Or, resolve by snapshot name:
+     * const sandbox = await client.createSandbox(undefined, {
+     *   snapshotName: "python",
+     * });
      * try {
      *   const result = await sandbox.run("echo hello");
      *   console.log(result.stdout);
@@ -579,13 +203,10 @@ class SandboxClient {
      * }
      * ```
      */
-    async createSandbox(templateName, options = {}) {
-        const { snapshotId, name, timeout = 30, waitForReady = true, ttlSeconds, idleTtlSeconds, vCpus, memBytes, fsCapacityBytes, proxyConfig, } = options;
-        if (!templateName && !snapshotId) {
-            throw new Error("Either templateName or snapshotId is required");
-        }
-        if (templateName && snapshotId) {
-            throw new Error("Cannot specify both templateName and snapshotId");
+    async createSandbox(snapshotId, options = {}) {
+        const { snapshotName, name, timeout = 30, waitForReady = true, ttlSeconds, idleTtlSeconds, vCpus, memBytes, fsCapacityBytes, proxyConfig, } = options;
+        if (!!snapshotId === !!snapshotName) {
+            throw new errors_js_1.LangSmithValidationError("Exactly one of snapshotId or options.snapshotName must be set", "snapshotId");
         }
         (0, helpers_js_1.validateTtl)(ttlSeconds, "ttlSeconds");
         (0, helpers_js_1.validateTtl)(idleTtlSeconds, "idleTtlSeconds");
@@ -593,12 +214,12 @@ class SandboxClient {
         const payload = {
             wait_for_ready: waitForReady,
         };
-        if (templateName) {
-            payload.template_name = templateName;
-        }
         if (snapshotId) {
             payload.snapshot_id = snapshotId;
         }
+        if (snapshotName) {
+            payload.snapshot_name = snapshotName;
+        }
         if (waitForReady) {
             payload.timeout = timeout;
         }
@@ -768,7 +389,7 @@ class SandboxClient {
      *
      * @example
      * ```typescript
-     * const sandbox = await client.createSandbox("python-sandbox", { waitForReady: false });
+     * const sandbox = await client.createSandbox(snapshot.id, { waitForReady: false });
      * // ... do other work ...
      * const readySandbox = await client.waitForSandbox(sandbox.name);
      * ```
@@ -864,16 +485,13 @@ class SandboxClient {
      *
      * @param sandboxName - Name of the sandbox to capture from.
      * @param name - Snapshot name.
-     * @param options - Capture options (checkpoint, timeout).
+     * @param options - Capture options (timeout).
      * @returns Snapshot in "ready" status.
      */
     async captureSnapshot(sandboxName, name, options = {}) {
-        const { checkpoint, timeout = 60, signal } = options;
+        const { timeout = 60, signal } = options;
         const url = `${this._baseUrl}/boxes/${encodeURIComponent(sandboxName)}/snapshot`;
         const payload = { name };
-        if (checkpoint !== undefined) {
-            payload.checkpoint = checkpoint;
-        }
         const response = await this._postJson(url, payload, { signal });
         const snapshot = (await response.json());
         return this.waitForSnapshot(snapshot.id, { timeout, signal });
@@ -896,13 +514,50 @@ class SandboxClient {
         return (await response.json());
     }
     /**
-     * List all snapshots.
+     * List snapshots, optionally filtered and paginated server-side.
      *
-     * @returns List of Snapshots.
+     * The backend always paginates this endpoint. When `limit` is omitted the
+     * server applies a default page size (currently 50), so a single call is
+     * not guaranteed to return every snapshot visible to the tenant. To iterate
+     * through all results, repeat the call with increasing `offset` values (or
+     * an explicit `limit`) until fewer than `limit` snapshots come back.
+     *
+     * @param options - Optional filter/pagination options.
+     *   - `nameContains`: case-insensitive substring match on snapshot name.
+     *   - `limit`: page size; must be between 1 and 500 (inclusive). Defaults
+     *     to 50 server-side when omitted.
+     *   - `offset`: number of snapshots to skip; must be `>= 0`.
+     *
+     *   Values outside those ranges are rejected by the server.
+     * @returns A single page of Snapshots matching the provided filters.
+     *
+     * @example
+     * ```typescript
+     * const firstPage = await client.listSnapshots();
+     * const page = await client.listSnapshots({
+     *   nameContains: "python",
+     *   limit: 100,
+     *   offset: 0,
+     * });
+     * ```
      */
-    async listSnapshots() {
-        const url = `${this._baseUrl}/snapshots`;
-        const response = await this._fetch(url);
+    async listSnapshots(options = {}) {
+        const { nameContains, limit, offset, signal } = options;
+        const params = new URLSearchParams();
+        if (nameContains !== undefined) {
+            params.set("name_contains", nameContains);
+        }
+        if (limit !== undefined) {
+            params.set("limit", String(limit));
+        }
+        if (offset !== undefined) {
+            params.set("offset", String(offset));
+        }
+        const query = params.toString();
+        const url = query
+            ? `${this._baseUrl}/snapshots?${query}`
+            : `${this._baseUrl}/snapshots`;
+        const response = await this._fetch(url, { signal });
         if (!response.ok) {
             await (0, helpers_js_1.handleClientHttpError)(response);
         }
@@ -952,5 +607,25 @@ class SandboxClient {
         }
         throw new errors_js_1.LangSmithResourceTimeoutError(`Snapshot '${snapshotId}' did not become ready within ${timeout}s`, "snapshot", lastStatus);
     }
+    /**
+     * Returns a string representation of the SandboxClient instance.
+     * This method is called when the object is converted to a string
+     * or logged, ensuring sensitive information like API keys is not exposed.
+     *
+     * @returns A string representation of the SandboxClient.
+     */
+    toString() {
+        return `[LangSmithSandboxClient apiEndpoint=${JSON.stringify(this._baseUrl)}]`;
+    }
+    /**
+     * Custom inspect method for Node.js.
+     * This method is called when the object is inspected in the Node.js REPL
+     * or with console.log, ensuring sensitive information like API keys is not exposed.
+     *
+     * @returns A string representation of the SandboxClient for inspection.
+     */
+    [Symbol.for("nodejs.util.inspect.custom")]() {
+        return this.toString();
+    }
 }
 exports.SandboxClient = SandboxClient;