eve 0.36.0 → 0.37.1

package/dist/src/compiled/@vercel/sandbox/api-client/api-client.d.ts

@@ -4,6 +4,7 @@ import { FileWriter } from "./file-writer.js";
 import { NetworkPolicy } from "../network-policy.js";
 import { WithPrivate } from "../utils/types.js";
 import { RUNTIMES } from "../constants.js";
+import { BaseCreateSandboxParams } from "../sandbox.js";
 import { z } from "#compiled/zod/index.js";
 import { Readable } from "stream";
 
@@ -180,6 +181,7 @@ declare class APIClient extends BaseClient {
       expiration?: number;
       deleteEvicted?: boolean;
     };
+    mounts?: BaseCreateSandboxParams["mounts"];
     signal?: AbortSignal;
   }>): Promise<Parsed<{
     sandbox: {
@@ -290,6 +292,271 @@ declare class APIClient extends BaseClient {
       statusUpdatedAt?: number | undefined;
       cwd?: string | undefined;
       tags?: Record<string, string> | undefined;
+      mounts?: Record<string, {
+        drive: string;
+        mode?: "read-only" | "read-write" | undefined;
+      }> | undefined;
+      snapshotExpiration?: number | undefined;
+      keepLastSnapshots?: {
+        count: number;
+        expiration?: number | undefined;
+        deleteEvicted?: boolean | undefined;
+      } | undefined;
+    };
+    session: {
+      [x: string]: unknown;
+      id: string;
+      memory: number;
+      vcpus: number;
+      region: string;
+      runtime: string;
+      timeout: number;
+      status: "pending" | "running" | "stopping" | "stopped" | "failed" | "aborted" | "snapshotting";
+      requestedAt: number;
+      createdAt: number;
+      cwd: string;
+      updatedAt: number;
+      startedAt?: number | undefined;
+      requestedStopAt?: number | undefined;
+      stoppedAt?: number | undefined;
+      abortedAt?: number | undefined;
+      duration?: number | undefined;
+      sourceSnapshotId?: string | undefined;
+      snapshottedAt?: number | undefined;
+      interactivePort?: number | undefined;
+      networkPolicy?: {
+        [x: string]: unknown;
+        mode: "allow-all";
+      } | {
+        [x: string]: unknown;
+        mode: "deny-all";
+      } | {
+        [x: string]: unknown;
+        mode: "custom";
+        allowedDomains?: string[] | undefined;
+        allowedCIDRs?: string[] | undefined;
+        deniedCIDRs?: string[] | undefined;
+        injectionRules?: {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+          match?: {
+            path?: {
+              exact?: string | undefined;
+              startsWith?: string | undefined;
+              regex?: string | undefined;
+            } | undefined;
+            method?: string[] | undefined;
+            queryString?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+            headers?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+          } | undefined;
+        }[] | undefined;
+        forwardRules?: {
+          domain: string;
+          forwardURL: string;
+          match?: {
+            path?: {
+              exact?: string | undefined;
+              startsWith?: string | undefined;
+              regex?: string | undefined;
+            } | undefined;
+            method?: string[] | undefined;
+            queryString?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+            headers?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+          } | undefined;
+        }[] | undefined;
+      } | undefined;
+      activeCpuDurationMs?: number | undefined;
+      networkTransfer?: {
+        ingress: number;
+        egress: number;
+      } | undefined;
+    };
+    routes: {
+      url: string;
+      subdomain: string;
+      port: number;
+    }[];
+    resumed?: boolean | undefined;
+  }>>;
+  forkSandbox(params: WithPrivate<{
+    sourceSandbox: string;
+    projectId: string;
+    name?: string;
+    ports?: number[];
+    timeout?: number;
+    resources?: {
+      vcpus: number;
+    };
+    persistent?: boolean;
+    image?: string;
+    networkPolicy?: NetworkPolicy;
+    env?: Record<string, string>;
+    tags?: Record<string, string>;
+    snapshotExpiration?: number;
+    keepLastSnapshots?: {
+      count: number;
+      expiration?: number;
+      deleteEvicted?: boolean;
+    };
+    signal?: AbortSignal;
+  }>): Promise<Parsed<{
+    sandbox: {
+      name: string;
+      persistent: boolean;
+      createdAt: number;
+      updatedAt: number;
+      currentSessionId: string;
+      status: "pending" | "running" | "stopping" | "stopped" | "failed" | "aborted" | "snapshotting";
+      region?: string | undefined;
+      vcpus?: number | undefined;
+      memory?: number | undefined;
+      runtime?: string | undefined;
+      image?: string | undefined;
+      timeout?: number | undefined;
+      networkPolicy?: {
+        [x: string]: unknown;
+        mode: "allow-all";
+      } | {
+        [x: string]: unknown;
+        mode: "deny-all";
+      } | {
+        [x: string]: unknown;
+        mode: "custom";
+        allowedDomains?: string[] | undefined;
+        allowedCIDRs?: string[] | undefined;
+        deniedCIDRs?: string[] | undefined;
+        injectionRules?: {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+          match?: {
+            path?: {
+              exact?: string | undefined;
+              startsWith?: string | undefined;
+              regex?: string | undefined;
+            } | undefined;
+            method?: string[] | undefined;
+            queryString?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+            headers?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+          } | undefined;
+        }[] | undefined;
+        forwardRules?: {
+          domain: string;
+          forwardURL: string;
+          match?: {
+            path?: {
+              exact?: string | undefined;
+              startsWith?: string | undefined;
+              regex?: string | undefined;
+            } | undefined;
+            method?: string[] | undefined;
+            queryString?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+            headers?: {
+              key?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+              value?: {
+                exact?: string | undefined;
+                startsWith?: string | undefined;
+                regex?: string | undefined;
+              } | undefined;
+            }[] | undefined;
+          } | undefined;
+        }[] | undefined;
+      } | undefined;
+      totalEgressBytes?: number | undefined;
+      totalIngressBytes?: number | undefined;
+      totalActiveCpuDurationMs?: number | undefined;
+      totalDurationMs?: number | undefined;
+      expiresAt?: number | undefined;
+      currentSnapshotId?: string | undefined;
+      statusUpdatedAt?: number | undefined;
+      cwd?: string | undefined;
+      tags?: Record<string, string> | undefined;
+      mounts?: Record<string, {
+        drive: string;
+        mode?: "read-only" | "read-write" | undefined;
+      }> | undefined;
       snapshotExpiration?: number | undefined;
       keepLastSnapshots?: {
         count: number;
@@ -742,6 +1009,47 @@ declare class APIClient extends BaseClient {
       count: string;
     } | undefined;
   }>>;
+  listDrives(params: {
+    projectId: string;
+    limit?: number;
+    cursor?: string | number;
+    since?: number | string;
+    until?: number | string;
+    sortBy?: "createdAt" | "updatedAt" | "name";
+    sortOrder?: "asc" | "desc";
+    namePrefix?: string;
+    signal?: AbortSignal;
+  }): Promise<Parsed<{
+    drives: {
+      name: string;
+      projectId: string;
+      maxSizeBytes: number;
+      createdAt: number;
+      updatedAt: number;
+      currentSessionId?: string | undefined;
+      currentSandboxName?: string | undefined;
+    }[];
+    pagination: {
+      count: number;
+      next: string | null;
+    };
+  }>>;
+  getOrCreateDrive(params: {
+    projectId: string;
+    name: string;
+    maxSizeBytes?: number;
+    signal?: AbortSignal;
+  }): Promise<Parsed<{
+    drive: {
+      name: string;
+      projectId: string;
+      maxSizeBytes: number;
+      createdAt: number;
+      updatedAt: number;
+      currentSessionId?: string | undefined;
+      currentSandboxName?: string | undefined;
+    };
+  }>>;
   writeFiles(params: {
     sessionId: string;
     cwd: string;
@@ -924,6 +1232,10 @@ declare class APIClient extends BaseClient {
       statusUpdatedAt?: number | undefined;
       cwd?: string | undefined;
       tags?: Record<string, string> | undefined;
+      mounts?: Record<string, {
+        drive: string;
+        mode?: "read-only" | "read-write" | undefined;
+      }> | undefined;
       snapshotExpiration?: number | undefined;
       keepLastSnapshots?: {
         count: number;
@@ -1169,6 +1481,10 @@ declare class APIClient extends BaseClient {
       statusUpdatedAt?: number | undefined;
       cwd?: string | undefined;
       tags?: Record<string, string> | undefined;
+      mounts?: Record<string, {
+        drive: string;
+        mode?: "read-only" | "read-write" | undefined;
+      }> | undefined;
       snapshotExpiration?: number | undefined;
       keepLastSnapshots?: {
         count: number;
@@ -1181,6 +1497,21 @@ declare class APIClient extends BaseClient {
       next: string | null;
     };
   }>>;
+  deleteDrive(params: {
+    projectId: string;
+    name: string;
+    signal?: AbortSignal;
+  }): Promise<Parsed<{
+    drive: {
+      name: string;
+      projectId: string;
+      maxSizeBytes: number;
+      createdAt: number;
+      updatedAt: number;
+      currentSessionId?: string | undefined;
+      currentSandboxName?: string | undefined;
+    };
+  }>>;
   updateSandbox(params: {
     name: string;
     projectId: string;
@@ -1311,6 +1642,10 @@ declare class APIClient extends BaseClient {
       statusUpdatedAt?: number | undefined;
       cwd?: string | undefined;
       tags?: Record<string, string> | undefined;
+      mounts?: Record<string, {
+        drive: string;
+        mode?: "read-only" | "read-write" | undefined;
+      }> | undefined;
       snapshotExpiration?: number | undefined;
       keepLastSnapshots?: {
         count: number;
@@ -1437,6 +1772,10 @@ declare class APIClient extends BaseClient {
       statusUpdatedAt?: number | undefined;
       cwd?: string | undefined;
       tags?: Record<string, string> | undefined;
+      mounts?: Record<string, {
+        drive: string;
+        mode?: "read-only" | "read-write" | undefined;
+      }> | undefined;
       snapshotExpiration?: number | undefined;
       keepLastSnapshots?: {
         count: number;

package/dist/src/compiled/@vercel/sandbox/api-client/index.d.ts

@@ -1,2 +1,2 @@
-import { Command, CommandData, CommandFinishedData, CommandFinishedResponse, CommandResponse, CreateSnapshotResponse, InteractiveSessionResponse, LogError, LogLine, LogLineData, LogOutputLine, Sandbox, SandboxMetaData, SandboxRoute, SandboxRouteData, Session, SessionMetaData, SessionResponse, Snapshot, SnapshotMetadata, SnapshotResponse, SnapshotTreeNode, SnapshotTreeNodeData, StopSessionResponse } from "./validators.js";
+import { Command, CommandData, CommandFinishedData, CommandFinishedResponse, CommandResponse, CreateSnapshotResponse, Drive, DriveMetadata, InteractiveSessionResponse, LogError, LogLine, LogLineData, LogOutputLine, Sandbox, SandboxMetaData, SandboxRoute, SandboxRouteData, Session, SessionMetaData, SessionResponse, Snapshot, SnapshotMetadata, SnapshotResponse, SnapshotTreeNode, SnapshotTreeNodeData, StopSessionResponse } from "./validators.js";
 import { APIClient } from "./api-client.js";

package/dist/src/compiled/@vercel/sandbox/api-client/validators.d.ts

@@ -517,6 +517,16 @@ declare const SnapshotResponse: z.ZodObject<{
     parentId: z.ZodOptional<z.ZodString>;
   }, z.core.$strip>;
 }, z.core.$strip>;
+declare const Drive: z.ZodObject<{
+  name: z.ZodString;
+  projectId: z.ZodString;
+  maxSizeBytes: z.ZodNumber;
+  currentSessionId: z.ZodOptional<z.ZodString>;
+  currentSandboxName: z.ZodOptional<z.ZodString>;
+  createdAt: z.ZodNumber;
+  updatedAt: z.ZodNumber;
+}, z.core.$strip>;
+type DriveMetadata = z.infer<typeof Drive>;
 declare const Sandbox: z.ZodObject<{
   name: z.ZodString;
   persistent: z.ZodBoolean;
@@ -630,6 +640,13 @@ declare const Sandbox: z.ZodObject<{
   statusUpdatedAt: z.ZodOptional<z.ZodNumber>;
   cwd: z.ZodOptional<z.ZodString>;
   tags: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  mounts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+    drive: z.ZodString;
+    mode: z.ZodOptional<z.ZodEnum<{
+      "read-only": "read-only";
+      "read-write": "read-write";
+    }>>;
+  }, z.core.$strip>>>;
   snapshotExpiration: z.ZodOptional<z.ZodNumber>;
   keepLastSnapshots: z.ZodOptional<z.ZodObject<{
     count: z.ZodNumber;
@@ -869,6 +886,13 @@ declare const StopSessionResponse: z.ZodObject<{
     statusUpdatedAt: z.ZodOptional<z.ZodNumber>;
     cwd: z.ZodOptional<z.ZodString>;
     tags: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    mounts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+      drive: z.ZodString;
+      mode: z.ZodOptional<z.ZodEnum<{
+        "read-only": "read-only";
+        "read-write": "read-write";
+      }>>;
+    }, z.core.$strip>>>;
     snapshotExpiration: z.ZodOptional<z.ZodNumber>;
     keepLastSnapshots: z.ZodOptional<z.ZodObject<{
       count: z.ZodNumber;
@@ -895,5 +919,5 @@ declare const StopSessionResponse: z.ZodObject<{
   }, z.core.$strip>>;
 }, z.core.$strip>;
 //#endregion
-export { Command, CommandData, CommandFinishedData, CommandFinishedResponse, CommandResponse, CreateSnapshotResponse, InteractiveSessionResponse, LogError, LogLine, LogLineData, LogOutputLine, Sandbox, SandboxMetaData, SandboxRoute, SandboxRouteData, Session, SessionMetaData, SessionResponse, Snapshot, SnapshotMetadata, SnapshotResponse, SnapshotTreeNode, SnapshotTreeNodeData, StopSessionResponse };
+export { Command, CommandData, CommandFinishedData, CommandFinishedResponse, CommandResponse, CreateSnapshotResponse, Drive, DriveMetadata, InteractiveSessionResponse, LogError, LogLine, LogLineData, LogOutputLine, Sandbox, SandboxMetaData, SandboxRoute, SandboxRouteData, Session, SessionMetaData, SessionResponse, Snapshot, SnapshotMetadata, SnapshotResponse, SnapshotTreeNode, SnapshotTreeNodeData, StopSessionResponse };
 //# sourceMappingURL=validators.d.ts.map

package/dist/src/compiled/@vercel/sandbox/drive.d.ts

@@ -0,0 +1,140 @@
+import { Paginator } from "./utils/paginator.js";
+import { DriveMetadata } from "./api-client/validators.js";
+import { APIClient, WithFetchOptions } from "./api-client/api-client.js";
+import "./api-client/index.js";
+import { Credentials } from "./utils/get-credentials.js";
+import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from "./_workflow-serde.js";
+
+//#region src/drive.d.ts
+interface SerializedDrive {
+  drive: DriveMetadata;
+  projectId?: string;
+}
+/** @inline */
+interface GetOrCreateDriveParams {
+  /**
+   * The name of the drive to get or create. Must be unique within the project.
+   */
+  name: string;
+  /**
+   * Maximum drive size in bytes. If omitted, a default of 100 GiB is used.
+   */
+  maxSize?: number;
+  /**
+   * An AbortSignal to cancel the operation.
+   */
+  signal?: AbortSignal;
+}
+/**
+ * A Drive is a persistent, bottomless storage that can be attached and detached to Sandboxes.
+ * Drives can be mounted as read-write or read-only, at a configurable path with `Sandbox.create()`.
+ *
+ * Use {@link Drive.getOrCreate} to construct.
+ * @hideconstructor
+ */
+declare class Drive {
+  private _client;
+  private drive;
+  private readonly _projectId;
+  /**
+   * Lazily resolve credentials and construct an API client.
+   * @internal
+   */
+  private ensureClient;
+  /**
+   * The name of the drive.
+   */
+  get name(): string;
+  /**
+   * The project ID that owns the drive.
+   */
+  get projectId(): string;
+  /**
+   * The maximum drive size in bytes.
+   */
+  get maxSize(): number;
+  /**
+   * Current session ID the drive is attached to, if any.
+   */
+  get currentSessionId(): string | undefined;
+  /**
+   * Current sandbox name the drive is attached to, if any.
+   */
+  get currentSandboxName(): string | undefined;
+  /**
+   * Timestamp when the drive was created.
+   */
+  get createdAt(): Date;
+  /**
+   * Timestamp when the drive was last updated.
+   */
+  get updatedAt(): Date;
+  /**
+   * Serialize a Drive instance to plain data for @workflow/serde.
+   *
+   * @param instance - The Drive instance to serialize
+   * @returns A plain object containing drive metadata
+   */
+  static [WORKFLOW_SERIALIZE](instance: Drive): SerializedDrive;
+  /**
+   * Deserialize a Drive from serialized data.
+   *
+   * The deserialized instance uses the serialized metadata synchronously and
+   * lazily creates an API client only when methods perform API requests.
+   *
+   * @param data - The serialized drive data
+   * @returns The reconstructed Drive instance
+   */
+  static [WORKFLOW_DESERIALIZE](data: SerializedDrive): Drive;
+  constructor({
+    client,
+    drive,
+    projectId
+  }: {
+    client?: APIClient;
+    drive: DriveMetadata;
+    projectId?: string;
+  });
+  /**
+   * Allow to get a list of drives for a team narrowed to the given params.
+   * It returns both the drives and the pagination metadata to allow getting
+   * the next page of results.
+   *
+   * The returned object is async-iterable to auto-paginate through all pages:
+   *
+   * ```ts
+   * const result = await Drive.list({ limit: 10 });
+   * for await (const drive of result) { ... }
+   * // or: await result.toArray();
+   * // or: for await (const page of result.pages()) { ... }
+   * ```
+   */
+  static list(params?: Partial<Parameters<APIClient["listDrives"]>[0]> & Partial<Credentials> & WithFetchOptions): Promise<Paginator<{
+    drives: Drive[];
+    pagination: {
+      count: number;
+      next: string | null;
+    };
+  }, "drives">>;
+  /**
+   * Retrieve an existing drive, or create a new one if it doesn't exists.
+   *
+   * @param params - Get/create parameters and optional credentials.
+   * @returns A promise resolving to the {@link Drive}.
+   */
+  static getOrCreate(params: (GetOrCreateDriveParams | (GetOrCreateDriveParams & Credentials)) & WithFetchOptions): Promise<Drive>;
+  /**
+   * Delete this drive. The drive must not be attached to any sandbox.
+   * This operation is irreversible and will delete all data stored in the drive.
+   *
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves once the drive has been deleted.
+   */
+  delete(opts?: {
+    signal?: AbortSignal;
+  }): Promise<void>;
+}
+//#endregion
+export { Drive, SerializedDrive };
+//# sourceMappingURL=drive.d.ts.map

package/dist/src/compiled/@vercel/sandbox/index.d.ts

@@ -7,6 +7,7 @@ import { ExecutionContext } from "./execution-context.js";
 import { Session } from "./session.js";
 import { FileSystem } from "./filesystem.js";
 import { SandboxUser, SandboxUserAlreadyExistsError } from "./sandbox-user.js";
-import { Sandbox, SerializedSandbox } from "./sandbox.js";
+import { Sandbox, SandboxMountMode, SandboxMounts, SerializedSandbox } from "./sandbox.js";
+import { Drive, SerializedDrive } from "./drive.js";
 import { InvalidRequestProxyHandler, ProxyHandler, ProxyMeta, defineSandboxProxy } from "./proxy.js";
-export { APIError, Command, CommandFinished, type CommandOutput, type ExecutionContext, FileSystem, type InvalidRequestProxyHandler, type NetworkPolicy, type NetworkPolicyKeyValueMatcher, type NetworkPolicyMatch, type NetworkPolicyMatcher, type NetworkPolicyRule, type NetworkTransformer, type ProxyHandler, type ProxyMeta, Sandbox, SandboxUser, SandboxUserAlreadyExistsError, type SerializedCommand, type SerializedCommandFinished, type SerializedSandbox, type SerializedSnapshot, Session, Snapshot, type SnapshotTreeNodeData, StreamError, defineSandboxProxy };
+export { APIError, Command, CommandFinished, type CommandOutput, Drive, type ExecutionContext, FileSystem, type InvalidRequestProxyHandler, type NetworkPolicy, type NetworkPolicyKeyValueMatcher, type NetworkPolicyMatch, type NetworkPolicyMatcher, type NetworkPolicyRule, type NetworkTransformer, type ProxyHandler, type ProxyMeta, Sandbox, type SandboxMountMode, type SandboxMounts, SandboxUser, SandboxUserAlreadyExistsError, type SerializedCommand, type SerializedCommandFinished, type SerializedDrive, type SerializedSandbox, type SerializedSnapshot, Session, Snapshot, type SnapshotTreeNodeData, StreamError, defineSandboxProxy };