feat: snapshots

Author: dobrac

packages/js-sdk/src/api/schema.gen.ts

@@ -47,6 +47,10 @@ export type {
   SandboxListOpts,
   SandboxPaginator,
   SandboxNetworkOpts,
+  SnapshotInfo,
+  SnapshotOpts,
+  SnapshotListOpts,
+  SnapshotPaginator,
 } from './sandbox/sandboxApi'
 
 export type { McpServer } from './sandbox/mcp'

packages/js-sdk/src/index.ts

@@ -28,8 +28,9 @@ export { Pty } from './pty'
 /**
  * Options for sending a command request.
  */
-export interface CommandRequestOpts
-  extends Partial<Pick<ConnectionOpts, 'requestTimeoutMs'>> {}
+export interface CommandRequestOpts extends Partial<
+  Pick<ConnectionOpts, 'requestTimeoutMs'>
+> {}
 
 /**
  * Options for starting a new command.

packages/js-sdk/src/sandbox/commands/index.ts

@@ -21,8 +21,10 @@ import { CommandHandle } from './commandHandle'
 import { authenticationHeader, handleRpcError } from '../../envd/rpc'
 import { handleProcessStartEvent } from '../../envd/api'
 
-export interface PtyCreateOpts
-  extends Pick<ConnectionOpts, 'requestTimeoutMs'> {
+export interface PtyCreateOpts extends Pick<
+  ConnectionOpts,
+  'requestTimeoutMs'
+> {
   /**
    * Number of columns for the PTY.
    */

packages/js-sdk/src/sandbox/commands/pty.ts

@@ -129,8 +129,9 @@ function mapModifiedTime(modifiedTime: Timestamp | undefined) {
 /**
  * Options for the sandbox filesystem operations.
  */
-export interface FilesystemRequestOpts
-  extends Partial<Pick<ConnectionOpts, 'requestTimeoutMs'>> {
+export interface FilesystemRequestOpts extends Partial<
+  Pick<ConnectionOpts, 'requestTimeoutMs'>
+> {
   /**
    * User to use for the operation in the sandbox.
    * This affects the resolution of relative paths and ownership of the created filesystem objects.

packages/js-sdk/src/sandbox/filesystem/index.ts

@@ -19,6 +19,10 @@ import {
   SandboxListOpts,
   SandboxPaginator,
   SandboxBetaCreateOpts,
+  SnapshotOpts,
+  SnapshotListOpts,
+  SnapshotInfo,
+  SnapshotPaginator,
 } from './sandboxApi'
 import { getSignature } from './signature'
 import { compareVersions } from 'compare-versions'
@@ -572,6 +576,52 @@ export class Sandbox extends SandboxApi {
     return await SandboxApi.betaPause(this.sandboxId, opts)
   }
 
+  /**
+   * Create a snapshot of the sandbox's current state.
+   *
+   * The snapshot can be used to create new sandboxes with the same filesystem and state.
+   * Snapshots are persistent and survive sandbox deletion.
+   *
+   * Use the returned `snapshotId` with `Sandbox.create(snapshotId)` to create a new sandbox from the snapshot.
+   *
+   * @param opts snapshot options.
+   *
+   * @returns snapshot information including the snapshot ID.
+   *
+   * @example
+   * ```ts
+   * const sandbox = await Sandbox.create()
+   * await sandbox.files.write('/app/state.json', '{"step": 1}')
+   *
+   * // Create a snapshot
+   * const snapshot = await sandbox.snapshot()
+   *
+   * // Create a new sandbox from the snapshot
+   * const newSandbox = await Sandbox.create(snapshot.snapshotId)
+   * ```
+   */
+  async snapshot(opts?: SnapshotOpts): Promise<SnapshotInfo> {
+    return await SandboxApi.createSnapshot(this.sandboxId, {
+      ...this.connectionConfig,
+      ...opts,
+    })
+  }
+
+  /**
+   * List all snapshots created from this sandbox.
+   *
+   * @param opts list options.
+   *
+   * @returns paginator for listing snapshots from this sandbox.
+   */
+  listSnapshots(opts?: Omit<SnapshotListOpts, 'sandboxId'>): SnapshotPaginator {
+    return SandboxApi.listSnapshots({
+      ...this.connectionConfig,
+      ...opts,
+      sandboxId: this.sandboxId,
+    })
+  }
+
   /**
    *
    * Get the MCP URL for the sandbox.