@vercel/sandbox 2.0.0-beta.19 → 2.0.0-beta.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/sandbox.d.ts CHANGED
@@ -524,8 +524,6 @@ declare class Sandbox {
524
524
  }>>;
525
525
  }, "strip", zod0.ZodTypeAny, {
526
526
  domain: string;
527
- headers?: Record<string, string> | undefined;
528
- headerNames?: string[] | undefined;
529
527
  match?: {
530
528
  path?: {
531
529
  exact?: string | undefined;
@@ -558,10 +556,10 @@ declare class Sandbox {
558
556
  } | undefined;
559
557
  }[] | undefined;
560
558
  } | undefined;
561
- }, {
562
- domain: string;
563
559
  headers?: Record<string, string> | undefined;
564
560
  headerNames?: string[] | undefined;
561
+ }, {
562
+ domain: string;
565
563
  match?: {
566
564
  path?: {
567
565
  exact?: string | undefined;
@@ -594,6 +592,8 @@ declare class Sandbox {
594
592
  } | undefined;
595
593
  }[] | undefined;
596
594
  } | undefined;
595
+ headers?: Record<string, string> | undefined;
596
+ headerNames?: string[] | undefined;
597
597
  }>, "many">>;
598
598
  forwardRules: zod0.ZodOptional<zod0.ZodArray<zod0.ZodObject<{
599
599
  domain: zod0.ZodString;
@@ -1188,6 +1188,9 @@ declare class Sandbox {
1188
1188
  /**
1189
1189
  * Update the sandbox configuration.
1190
1190
  *
1191
+ * When `ports` is provided, it is treated as the full desired port list:
1192
+ * any currently exposed port omitted from the array will be deregistered.
1193
+ *
1191
1194
  * @param params - Fields to update.
1192
1195
  * @param opts - Optional abort signal.
1193
1196
  */
@@ -1199,6 +1202,7 @@ declare class Sandbox {
1199
1202
  timeout?: number;
1200
1203
  networkPolicy?: NetworkPolicy;
1201
1204
  tags?: Record<string, string>;
1205
+ ports?: number[];
1202
1206
  snapshotExpiration?: number;
1203
1207
  currentSnapshotId?: string;
1204
1208
  }, opts?: {
@@ -1450,8 +1454,6 @@ declare class Sandbox {
1450
1454
  }>>;
1451
1455
  }, "strip", zod0.ZodTypeAny, {
1452
1456
  domain: string;
1453
- headers?: Record<string, string> | undefined;
1454
- headerNames?: string[] | undefined;
1455
1457
  match?: {
1456
1458
  path?: {
1457
1459
  exact?: string | undefined;
@@ -1484,10 +1486,10 @@ declare class Sandbox {
1484
1486
  } | undefined;
1485
1487
  }[] | undefined;
1486
1488
  } | undefined;
1487
- }, {
1488
- domain: string;
1489
1489
  headers?: Record<string, string> | undefined;
1490
1490
  headerNames?: string[] | undefined;
1491
+ }, {
1492
+ domain: string;
1491
1493
  match?: {
1492
1494
  path?: {
1493
1495
  exact?: string | undefined;
@@ -1520,6 +1522,8 @@ declare class Sandbox {
1520
1522
  } | undefined;
1521
1523
  }[] | undefined;
1522
1524
  } | undefined;
1525
+ headers?: Record<string, string> | undefined;
1526
+ headerNames?: string[] | undefined;
1523
1527
  }>, "many">>;
1524
1528
  forwardRules: zod0.ZodOptional<zod0.ZodArray<zod0.ZodObject<{
1525
1529
  domain: zod0.ZodString;
@@ -1962,8 +1966,6 @@ declare class Sandbox {
1962
1966
  }>>;
1963
1967
  }, "strip", zod0.ZodTypeAny, {
1964
1968
  domain: string;
1965
- headers?: Record<string, string> | undefined;
1966
- headerNames?: string[] | undefined;
1967
1969
  match?: {
1968
1970
  path?: {
1969
1971
  exact?: string | undefined;
@@ -1996,10 +1998,10 @@ declare class Sandbox {
1996
1998
  } | undefined;
1997
1999
  }[] | undefined;
1998
2000
  } | undefined;
1999
- }, {
2000
- domain: string;
2001
2001
  headers?: Record<string, string> | undefined;
2002
2002
  headerNames?: string[] | undefined;
2003
+ }, {
2004
+ domain: string;
2003
2005
  match?: {
2004
2006
  path?: {
2005
2007
  exact?: string | undefined;
@@ -2032,6 +2034,8 @@ declare class Sandbox {
2032
2034
  } | undefined;
2033
2035
  }[] | undefined;
2034
2036
  } | undefined;
2037
+ headers?: Record<string, string> | undefined;
2038
+ headerNames?: string[] | undefined;
2035
2039
  }>, "many">>;
2036
2040
  forwardRules: zod0.ZodOptional<zod0.ZodArray<zod0.ZodObject<{
2037
2041
  domain: zod0.ZodString;
@@ -2474,8 +2478,6 @@ declare class Sandbox {
2474
2478
  }>>;
2475
2479
  }, "strip", zod0.ZodTypeAny, {
2476
2480
  domain: string;
2477
- headers?: Record<string, string> | undefined;
2478
- headerNames?: string[] | undefined;
2479
2481
  match?: {
2480
2482
  path?: {
2481
2483
  exact?: string | undefined;
@@ -2508,10 +2510,10 @@ declare class Sandbox {
2508
2510
  } | undefined;
2509
2511
  }[] | undefined;
2510
2512
  } | undefined;
2511
- }, {
2512
- domain: string;
2513
2513
  headers?: Record<string, string> | undefined;
2514
2514
  headerNames?: string[] | undefined;
2515
+ }, {
2516
+ domain: string;
2515
2517
  match?: {
2516
2518
  path?: {
2517
2519
  exact?: string | undefined;
@@ -2544,6 +2546,8 @@ declare class Sandbox {
2544
2546
  } | undefined;
2545
2547
  }[] | undefined;
2546
2548
  } | undefined;
2549
+ headers?: Record<string, string> | undefined;
2550
+ headerNames?: string[] | undefined;
2547
2551
  }>, "many">>;
2548
2552
  forwardRules: zod0.ZodOptional<zod0.ZodArray<zod0.ZodObject<{
2549
2553
  domain: zod0.ZodString;
package/dist/sandbox.js CHANGED
@@ -18,7 +18,7 @@ function isNotFoundError(err) {
18
18
  return err instanceof APIError && err.response.status === 404;
19
19
  }
20
20
  function isSnapshotNotFoundError(err) {
21
- return err instanceof APIError && err.response.status === 400 && err.json?.error?.code === "snapshot_not_found";
21
+ return err instanceof APIError && err.response.status === 410 && err.json?.error?.code === "snapshot_not_found";
22
22
  }
23
23
  function isSandboxStoppingError(err) {
24
24
  return err instanceof APIError && err.response.status === 422 && err.json?.error?.code === "sandbox_stopping";
@@ -694,6 +694,9 @@ var Sandbox = class Sandbox {
694
694
  /**
695
695
  * Update the sandbox configuration.
696
696
  *
697
+ * When `ports` is provided, it is treated as the full desired port list:
698
+ * any currently exposed port omitted from the array will be deregistered.
699
+ *
697
700
  * @param params - Fields to update.
698
701
  * @param opts - Optional abort signal.
699
702
  */
@@ -705,7 +708,7 @@ var Sandbox = class Sandbox {
705
708
  vcpus: params.resources.vcpus,
706
709
  memory: params.resources.vcpus * 2048
707
710
  };
708
- this.sandbox = (await client.updateSandbox({
711
+ const response = await client.updateSandbox({
709
712
  name: this.sandbox.name,
710
713
  projectId: this.projectId,
711
714
  persistent: params.persistent,
@@ -713,10 +716,13 @@ var Sandbox = class Sandbox {
713
716
  timeout: params.timeout,
714
717
  networkPolicy: params.networkPolicy,
715
718
  tags: params.tags,
719
+ ports: params.ports,
716
720
  snapshotExpiration: params.snapshotExpiration,
717
721
  currentSnapshotId: params.currentSnapshotId,
718
722
  signal: opts?.signal
719
- })).json.sandbox;
723
+ });
724
+ this.sandbox = response.json.sandbox;
725
+ if (params.ports !== void 0 && response.json.routes) this.session?.updateRoutes(response.json.routes);
720
726
  if (params.networkPolicy) try {
721
727
  return await this.session?.update({ networkPolicy: params.networkPolicy }, opts);
722
728
  } catch (err) {
@@ -1 +1 @@
1
- {"version":3,"file":"sandbox.js","names":["resources: { vcpus: number; memory: number } | undefined"],"sources":["../src/sandbox.ts"],"sourcesContent":["import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from \"@workflow/serde\";\nimport type {\n SessionMetaData,\n SandboxRouteData,\n SandboxMetaData,\n SnapshotMetadata,\n} from \"./api-client/index.js\";\nimport { APIClient } from \"./api-client/index.js\";\nimport { APIError } from \"./api-client/api-error.js\";\nimport { type Credentials, getCredentials } from \"./utils/get-credentials.js\";\nimport { getPrivateParams, type WithPrivate } from \"./utils/types.js\";\nimport type { WithFetchOptions } from \"./api-client/api-client.js\";\nimport type { RUNTIMES } from \"./constants.js\";\nimport { Session, type RunCommandParams } from \"./session.js\";\nimport type { Command, CommandFinished } from \"./command.js\";\nimport type { Snapshot } from \"./snapshot.js\";\nimport type { SandboxSnapshot } from \"./utils/sandbox-snapshot.js\";\nimport type {\n NetworkPolicy,\n NetworkPolicyKeyValueMatcher,\n NetworkPolicyMatch,\n NetworkPolicyMatcher,\n} from \"./network-policy.js\";\nimport { fromAPINetworkPolicy } from \"./utils/network-policy.js\";\nimport { attachPaginator } from \"./utils/paginator.js\";\nimport { setTimeout } from \"node:timers/promises\";\nimport { FileSystem } from \"./filesystem.js\";\n\nexport type {\n NetworkPolicy,\n NetworkPolicyKeyValueMatcher,\n NetworkPolicyMatch,\n NetworkPolicyMatcher,\n};\n\n/** @inline */\nexport interface BaseCreateSandboxParams {\n /**\n * The name of the sandbox. If omitted, a random name will be generated.\n */\n name?: string;\n /**\n * The source of the sandbox.\n *\n * Omit this parameter start a sandbox without a source.\n *\n * For git sources:\n * - `depth`: Creates shallow clones with limited commit history (minimum: 1)\n * - `revision`: Clones and checks out a specific commit, branch, or tag\n */\n source?:\n | {\n type: \"git\";\n url: string;\n depth?: number;\n revision?: string;\n }\n | {\n type: \"git\";\n url: string;\n username: string;\n password: string;\n depth?: number;\n revision?: string;\n }\n | { type: \"tarball\"; url: string };\n /**\n * Array of port numbers to expose from the sandbox. Sandboxes can\n * expose up to 4 ports.\n */\n ports?: number[];\n /**\n * Timeout in milliseconds before the sandbox auto-terminates.\n */\n timeout?: number;\n /**\n * Resources to allocate to the sandbox.\n *\n * Your sandbox will get the amount of vCPUs you specify here and\n * 2048 MB of memory per vCPU.\n */\n resources?: { vcpus: number };\n /**\n * The runtime of the sandbox, currently only `node24`, `node22`, `node26` and `python3.13` are supported.\n * If not specified, the default runtime `node24` will be used.\n */\n runtime?: RUNTIMES | (string & {});\n /**\n * Network policy to define network restrictions for the sandbox.\n * Defaults to full internet access if not specified.\n */\n networkPolicy?: NetworkPolicy;\n /**\n * Default environment variables for the sandbox.\n * These are inherited by all commands unless overridden with\n * the `env` option in `runCommand`.\n *\n * @example\n * const sandbox = await Sandbox.create({\n * env: { NODE_ENV: \"production\", API_KEY: \"secret\" },\n * });\n * // All commands will have NODE_ENV and API_KEY set\n * await sandbox.runCommand(\"node\", [\"app.js\"]);\n */\n env?: Record<string, string>;\n /**\n * Key-value tags to associate with the sandbox. Maximum 5 tags.\n * @example { env: \"staging\", team: \"infra\" }\n */\n tags?: Record<string, string>;\n\n /**\n * An AbortSignal to cancel sandbox creation.\n */\n signal?: AbortSignal;\n /**\n * Enable or disable automatic restore of the filesystem between sessions.\n */\n persistent?: boolean;\n /**\n * Default snapshot expiration in milliseconds.\n * When set, snapshots created for this sandbox will expire after this duration.\n * Use `0` for no expiration.\n */\n snapshotExpiration?: number;\n /**\n * Called when the sandbox session is resumed (e.g., after a snapshot restore).\n * Use this to re-warm caches, restore transient state, or run other setup logic.\n */\n onResume?: (sandbox: Sandbox) => Promise<void>;\n}\n\nexport type CreateSandboxParams =\n | BaseCreateSandboxParams\n | (Omit<BaseCreateSandboxParams, \"runtime\" | \"source\"> & {\n source: { type: \"snapshot\"; snapshotId: string };\n });\n\n/** @inline */\ninterface GetSandboxParams {\n /**\n * The name of the sandbox.\n */\n name: string;\n /**\n * Whether to resume an existing session. Defaults to true.\n */\n resume?: boolean;\n /**\n * An AbortSignal to cancel the operation.\n */\n signal?: AbortSignal;\n /**\n * Called when the sandbox session is resumed (e.g., after a snapshot restore).\n * Use this to re-warm caches, restore transient state, or run other setup logic.\n */\n onResume?: (sandbox: Sandbox) => Promise<void>;\n}\n\n/**\n * Extends both {@link BaseCreateSandboxParams} and {@link GetSandboxParams}\n * (minus `name`, which is required on get but optional here) so that any\n * new parameter added to either flow is picked up automatically. The\n * structural overlap on `signal` / `onResume` is intentional — both\n * interfaces declare them with identical optional types.\n * @inline\n */\ninterface GetOrCreateSandboxParams\n extends BaseCreateSandboxParams,\n Omit<GetSandboxParams, \"name\"> {\n /**\n * Called once after a sandbox is freshly created (not when an existing\n * sandbox is retrieved). Use this for one-time setup such as seeding\n * files or warming caches. The returned promise is awaited before\n * {@link Sandbox.getOrCreate} resolves.\n */\n onCreate?: (sandbox: Sandbox) => Promise<void>;\n}\n\nfunction isSandboxStoppedError(err: unknown): boolean {\n return err instanceof APIError && err.response.status === 410;\n}\n\nfunction isNotFoundError(err: unknown): boolean {\n return err instanceof APIError && err.response.status === 404;\n}\n\nfunction isSnapshotNotFoundError(err: unknown): boolean {\n return (\n err instanceof APIError &&\n err.response.status === 400 &&\n (err.json as any)?.error?.code === \"snapshot_not_found\"\n );\n}\n\nfunction isSandboxStoppingError(err: unknown): boolean {\n return (\n err instanceof APIError &&\n err.response.status === 422 &&\n (err.json as any)?.error?.code === \"sandbox_stopping\"\n );\n}\n\nfunction isSandboxSnapshottingError(err: unknown): boolean {\n return (\n err instanceof APIError &&\n err.response.status === 422 &&\n (err.json as any)?.error?.code === \"sandbox_snapshotting\"\n );\n}\n\n/**\n * Serialized representation of a Sandbox for @workflow/serde.\n * Fields `metadata` and `routes` are the original wire format from main.\n * Fields `sandboxMetadata` and `projectId` are added for named-sandboxes.\n */\nexport interface SerializedSandbox {\n metadata: SandboxSnapshot;\n routes: SandboxRouteData[];\n sandboxMetadata?: SandboxMetaData;\n projectId?: string;\n}\n\n// ============================================================================\n// Sandbox class\n// ============================================================================\n\n/**\n * A Sandbox is a persistent, isolated Linux MicroVMs to run commands in.\n * Use {@link Sandbox.create} or {@link Sandbox.get} to construct.\n * @hideconstructor\n */\nexport class Sandbox {\n private _client: APIClient | null = null;\n private readonly projectId: string;\n\n /**\n * In-flight resume promise, used to deduplicate concurrent resume calls.\n */\n private resumePromise: Promise<void> | null = null;\n\n /**\n * Internal Session instance for the current VM.\n */\n private session: Session | undefined;\n\n /**\n * Internal metadata about the sandbox.\n */\n private sandbox: SandboxMetaData;\n\n /**\n * Hook that will be executed when a new session is created during resume.\n */\n private readonly onResume?: (sandbox: Sandbox) => Promise<void>;\n\n /**\n * A `node:fs/promises`-compatible API for interacting with the sandbox filesystem.\n *\n * @example\n * const content = await sandbox.fs.readFile('/etc/hostname', 'utf8');\n * await sandbox.fs.writeFile('/tmp/hello.txt', 'Hello, world!');\n * const files = await sandbox.fs.readdir('/tmp');\n * const stats = await sandbox.fs.stat('/tmp/hello.txt');\n */\n public readonly fs: FileSystem;\n\n /**\n * Lazily resolve credentials and construct an API client.\n * @internal\n */\n private async ensureClient(): Promise<APIClient> {\n \"use step\";\n if (this._client) return this._client;\n const credentials = await getCredentials();\n this._client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n });\n return this._client;\n }\n\n /**\n * The name of this sandbox.\n */\n public get name(): string {\n return this.sandbox.name;\n }\n\n /**\n * Routes from ports to subdomains.\n * @hidden\n */\n public get routes(): SandboxRouteData[] {\n return this.currentSession().routes;\n }\n\n /**\n * Whether the sandbox persists the state.\n */\n public get persistent(): boolean {\n return this.sandbox.persistent;\n }\n\n /**\n * The region this sandbox runs in.\n */\n public get region(): string | undefined {\n return this.sandbox.region;\n }\n\n /**\n * Number of virtual CPUs allocated.\n */\n public get vcpus(): number | undefined {\n return this.sandbox.vcpus;\n }\n\n /**\n * Memory allocated in MB.\n */\n public get memory(): number | undefined {\n return this.sandbox.memory;\n }\n\n /** Runtime identifier (e.g. \"node24\", \"python3.13\"). */\n public get runtime(): string | undefined {\n return this.sandbox.runtime;\n }\n\n /**\n * Cumulative egress bytes across all sessions.\n */\n public get totalEgressBytes(): number | undefined {\n return this.sandbox.totalEgressBytes;\n }\n\n /**\n * Cumulative ingress bytes across all sessions.\n */\n public get totalIngressBytes(): number | undefined {\n return this.sandbox.totalIngressBytes;\n }\n\n /**\n * Cumulative active CPU duration in milliseconds across all sessions.\n */\n public get totalActiveCpuDurationMs(): number | undefined {\n return this.sandbox.totalActiveCpuDurationMs;\n }\n\n /**\n * Cumulative wall-clock duration in milliseconds across all sessions.\n */\n public get totalDurationMs(): number | undefined {\n return this.sandbox.totalDurationMs;\n }\n\n /**\n * When this sandbox was last updated.\n */\n public get updatedAt(): Date {\n return new Date(this.sandbox.updatedAt);\n }\n\n /**\n * When the sandbox status was last updated.\n */\n public get statusUpdatedAt(): Date | undefined {\n return this.sandbox.statusUpdatedAt\n ? new Date(this.sandbox.statusUpdatedAt)\n : undefined;\n }\n\n /**\n * When this sandbox was created.\n */\n public get createdAt(): Date {\n return new Date(this.sandbox.createdAt);\n }\n\n /**\n * Interactive port.\n */\n public get interactivePort(): number | undefined {\n return this.currentSession().interactivePort;\n }\n\n /**\n * The status of the current session.\n */\n public get status(): SessionMetaData[\"status\"] {\n return this.currentSession().status;\n }\n\n /**\n * The default timeout of this sandbox in milliseconds.\n */\n public get timeout(): number | undefined {\n return this.sandbox.timeout;\n }\n\n /**\n * Key-value tags attached to the sandbox.\n */\n public get tags(): Record<string, string> | undefined {\n return this.sandbox.tags;\n }\n\n /**\n * The default network policy of this sandbox.\n */\n public get networkPolicy(): NetworkPolicy | undefined {\n return this.sandbox.networkPolicy\n ? fromAPINetworkPolicy(this.sandbox.networkPolicy)\n : undefined;\n }\n\n /**\n * If the session was created from a snapshot, the ID of that snapshot.\n */\n public get sourceSnapshotId(): string | undefined {\n return this.currentSession().sourceSnapshotId;\n }\n\n /**\n * The current snapshot ID of this sandbox, if any.\n */\n public get currentSnapshotId(): string | undefined {\n return this.sandbox.currentSnapshotId;\n }\n\n /**\n * The default snapshot expiration in milliseconds, if set.\n */\n public get snapshotExpiration(): number | undefined {\n return this.sandbox.snapshotExpiration;\n }\n\n /**\n * The amount of CPU used by the session. Only reported once the VM is stopped.\n */\n public get activeCpuUsageMs(): number | undefined {\n return this.currentSession().activeCpuUsageMs;\n }\n\n /**\n * The amount of network data used by the session. Only reported once the VM is stopped.\n */\n public get networkTransfer():\n | { ingress: number; egress: number }\n | undefined {\n return this.currentSession().networkTransfer;\n }\n\n /**\n * Allow to get a list of sandboxes for a team narrowed to the given params.\n * It returns both the sandboxes and the pagination metadata to allow getting\n * the next page of results.\n *\n * The returned object is async-iterable to auto-paginate through all pages:\n *\n * ```ts\n * const result = await Sandbox.list({ namePrefix: \"ci-\" });\n * for await (const sandbox of result) { ... }\n * // or: await result.toArray();\n * // or: for await (const page of result.pages()) { ... }\n * ```\n */\n static async list(\n params?: Partial<Parameters<APIClient[\"listSandboxes\"]>[0]> &\n Partial<Credentials> &\n WithFetchOptions,\n ) {\n \"use step\";\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params?.fetch,\n });\n const fetchPage = async (cursor?: string) => {\n const response = await client.listSandboxes({\n ...credentials,\n ...params,\n ...(cursor !== undefined && { cursor }),\n });\n return response.json;\n };\n const firstPage = await fetchPage(params?.cursor);\n return attachPaginator(firstPage, {\n itemsKey: \"sandboxes\",\n fetchNext: fetchPage,\n signal: params?.signal,\n });\n }\n\n /**\n * Serialize a Sandbox instance to plain data for @workflow/serde.\n *\n * @param instance - The Sandbox instance to serialize\n * @returns A plain object containing sandbox metadata and routes\n */\n static [WORKFLOW_SERIALIZE](instance: Sandbox): SerializedSandbox {\n return {\n metadata: instance.session?._sessionSnapshot!,\n routes: instance.session?.routes ?? [],\n sandboxMetadata: instance.sandbox,\n projectId: instance.projectId,\n };\n }\n\n /**\n * Deserialize a Sandbox from serialized snapshot data.\n *\n * The deserialized instance uses the serialized metadata synchronously and\n * lazily creates an API client only when methods perform API requests.\n *\n * @param data - The serialized sandbox data\n * @returns The reconstructed Sandbox instance\n */\n static [WORKFLOW_DESERIALIZE](data: SerializedSandbox): Sandbox {\n const sandbox = new Sandbox({\n sandbox: data.sandboxMetadata!,\n routes: data.routes,\n projectId: data.projectId,\n });\n if (data.metadata) {\n sandbox.session = new Session({ routes: data.routes, snapshot: data.metadata });\n }\n return sandbox;\n }\n\n /**\n * Create a new sandbox.\n *\n * @param params - Creation parameters and optional credentials.\n * @returns A promise resolving to the created {@link Sandbox}.\n * @example\n * <caption>Create a sandbox with default options</caption>\n * const sandbox = await Sandbox.create();\n *\n * @example\n * <caption>Create a sandbox and drop it in the end of the block</caption>\n * async function fn() {\n * await using const sandbox = await Sandbox.create();\n * // Sandbox automatically stopped at the end of the lexical scope\n * }\n */\n static async create(\n params?: WithPrivate<\n CreateSandboxParams | (CreateSandboxParams & Credentials)\n > &\n WithFetchOptions,\n ): Promise<Sandbox & AsyncDisposable> {\n \"use step\";\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params?.fetch,\n });\n\n const privateParams = getPrivateParams(params);\n const response = await client.createSandbox({\n source: params?.source,\n projectId: credentials.projectId,\n ports: params?.ports ?? [],\n timeout: params?.timeout,\n resources: params?.resources,\n runtime: params && \"runtime\" in params ? params?.runtime : undefined,\n networkPolicy: params?.networkPolicy,\n env: params?.env,\n tags: params?.tags,\n snapshotExpiration: params?.snapshotExpiration,\n signal: params?.signal,\n name: params?.name,\n persistent: params?.persistent,\n ...privateParams,\n });\n\n return new DisposableSandbox({\n client,\n session: response.json.session,\n sandbox: response.json.sandbox,\n routes: response.json.routes,\n projectId: credentials.projectId,\n onResume: params?.onResume,\n });\n }\n\n /**\n * Retrieve an existing sandbox and resume its session.\n *\n * @param params - Get parameters and optional credentials.\n * @returns A promise resolving to the {@link Sandbox}.\n */\n static async get(\n params: WithPrivate<GetSandboxParams | (GetSandboxParams & Credentials)> &\n WithFetchOptions,\n ): Promise<Sandbox> {\n \"use step\";\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params.fetch,\n });\n\n const privateParams = getPrivateParams(params);\n const response = await client.getSandbox({\n name: params.name,\n projectId: credentials.projectId,\n resume: params.resume,\n signal: params.signal,\n ...privateParams,\n });\n\n const sandbox = new Sandbox({\n client,\n session: response.json.session,\n sandbox: response.json.sandbox,\n routes: response.json.routes,\n projectId: credentials.projectId,\n onResume: params.onResume,\n });\n\n if (response.json.resumed && params.onResume) {\n await params.onResume(sandbox);\n }\n\n return sandbox;\n }\n\n /**\n * Retrieve an existing named sandbox, or create a new one if none exists.\n *\n * If `name` is omitted, this always creates a new sandbox and fires\n * `onCreate`. If `name` is provided, it first tries {@link Sandbox.get};\n * on `not_found` it creates a new sandbox with that name; on\n * `snapshot_not_found` it deletes the stale named sandbox and creates\n * a fresh one with the same name.\n *\n * @param params - Get/create parameters plus an optional `onCreate` hook.\n * @returns A promise resolving to the {@link Sandbox}.\n *\n * @example\n * <caption>Idempotent named sandbox with one-time setup</caption>\n * const sandbox = await Sandbox.getOrCreate({\n * name: \"my-workspace\",\n * onCreate: async (sbx) => {\n * await sbx.writeFiles([\n * { path: \"README.md\", content: Buffer.from(\"# Hello\") },\n * ]);\n * },\n * });\n *\n * @example\n * <caption>Unnamed — always creates</caption>\n * const sandbox = await Sandbox.getOrCreate({\n * onCreate: async (sbx) => {\n * await sbx.runCommand(\"npm\", [\"install\"]);\n * },\n * });\n */\n static async getOrCreate(\n params?: WithPrivate<\n GetOrCreateSandboxParams | (GetOrCreateSandboxParams & Credentials)\n > &\n WithFetchOptions,\n ): Promise<Sandbox> {\n \"use step\";\n // No name → always create, fire onCreate.\n if (!params?.name) {\n const sandbox = await Sandbox.create(params);\n if (params?.onCreate) {\n await params.onCreate(sandbox);\n }\n return sandbox;\n }\n\n try {\n return await Sandbox.get(\n params as unknown as Parameters<typeof Sandbox.get>[0],\n );\n } catch (err) {\n if (isNotFoundError(err)) {\n // Sandbox does not exist: re-create it.\n const sandbox = await Sandbox.create(params);\n if (params.onCreate) {\n await params.onCreate(sandbox);\n }\n return sandbox;\n }\n\n if (isSnapshotNotFoundError(err)) {\n // Sandbox exists but the snapshot has expired. Delete it and create\n // a new one.\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params.fetch,\n });\n const privateParams = getPrivateParams(params);\n try {\n await client.deleteSandbox({\n name: params.name,\n projectId: credentials.projectId,\n signal: params.signal,\n ...privateParams,\n });\n } catch (deleteErr) {\n // Tolerate 404 — the named sandbox was already cleaned up by a\n // concurrent request. Propagate anything else.\n if (!isNotFoundError(deleteErr)) {\n throw deleteErr;\n }\n }\n\n const sandbox = await Sandbox.create(params);\n if (params.onCreate) {\n await params.onCreate(sandbox);\n }\n return sandbox;\n }\n\n throw err;\n }\n }\n\n /**\n * Create a new Sandbox instance.\n *\n * @param params.client - Optional API client. If not provided, will be lazily created using global credentials.\n * @param params.routes - Port-to-subdomain mappings for exposed ports\n * @param params.sandbox - Sandbox snapshot metadata\n */\n constructor({\n client,\n routes,\n session,\n sandbox,\n projectId,\n onResume,\n }: {\n client?: APIClient;\n routes: SandboxRouteData[];\n session?: SessionMetaData;\n sandbox: SandboxMetaData;\n projectId?: string;\n onResume?: (sandbox: Sandbox) => Promise<void>;\n }) {\n this._client = client ?? null;\n if (session) {\n this.session = new Session({ client: client!, routes, session });\n }\n this.sandbox = sandbox;\n this.projectId = projectId ?? \"\";\n this.onResume = onResume;\n this.fs = new FileSystem(this);\n }\n\n /**\n * Get the current session (the running VM) for this sandbox.\n *\n * @returns The {@link Session} instance.\n */\n currentSession(): Session {\n if (!this.session) {\n throw new Error(\"No active session. Run a command or call resume first.\");\n }\n return this.session;\n }\n\n /**\n * Resume this sandbox by creating a new session via `getSandbox`.\n */\n private async resume(signal?: AbortSignal): Promise<void> {\n if (!this.resumePromise) {\n this.resumePromise = this.doResume(signal).finally(() => {\n this.resumePromise = null;\n });\n }\n return this.resumePromise;\n }\n\n private async doResume(signal?: AbortSignal): Promise<void> {\n const client = await this.ensureClient();\n const response = await client.getSandbox({\n name: this.sandbox.name,\n projectId: this.projectId,\n resume: true,\n signal,\n });\n this.session = new Session({\n client,\n routes: response.json.routes,\n session: response.json.session,\n });\n if (this.onResume && response.json.resumed) {\n await this.onResume(this);\n }\n }\n\n /**\n * Poll until the current session reaches a terminal state, then resume.\n */\n private async waitForStopAndResume(signal?: AbortSignal): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n const pollingInterval = 500;\n let status = this.session!.status;\n\n while (status === \"stopping\" || status === \"snapshotting\") {\n await setTimeout(pollingInterval, undefined, { signal });\n const poll = await client.getSession({\n sessionId: this.session!.sessionId,\n signal,\n });\n this.session = new Session({\n client,\n routes: poll.json.routes,\n session: poll.json.session,\n });\n status = poll.json.session.status;\n }\n await this.resume(signal);\n }\n\n /**\n * Execute `fn`, and if the session is stopped/stopping/snapshotting, resume and retry.\n */\n private async withResume<T>(\n fn: () => Promise<T>,\n signal?: AbortSignal,\n ): Promise<T> {\n if (!this.session) {\n await this.resume(signal);\n }\n try {\n return await fn();\n } catch (err) {\n if (isSandboxStoppedError(err)) {\n await this.resume(signal);\n return fn();\n }\n if (isSandboxStoppingError(err) || isSandboxSnapshottingError(err)) {\n await this.waitForStopAndResume(signal);\n return fn();\n }\n throw err;\n }\n }\n\n /**\n * Start executing a command in this sandbox.\n *\n * @param command - The command to execute.\n * @param args - Arguments to pass to the command.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the command execution.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n async runCommand(\n command: string,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<CommandFinished>;\n /**\n * Start executing a command in detached mode.\n *\n * @param params - The command parameters.\n * @returns A {@link Command} instance for the running command.\n */\n async runCommand(\n params: RunCommandParams & { detached: true },\n ): Promise<Command>;\n\n /**\n * Start executing a command in this sandbox.\n *\n * @param params - The command parameters.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n\n async runCommand(params: RunCommandParams): Promise<CommandFinished>;\n\n async runCommand(\n commandOrParams: string | RunCommandParams,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<Command | CommandFinished> {\n \"use step\";\n const signal =\n typeof commandOrParams === \"string\"\n ? opts?.signal\n : commandOrParams.signal;\n return this.withResume(\n () => this.session!.runCommand(commandOrParams as any, args, opts),\n signal,\n );\n }\n\n /**\n * Internal helper to start a command in the sandbox.\n *\n * @param params - Command execution parameters.\n * @returns A {@link Command} or {@link CommandFinished}, depending on `detached`.\n * @internal\n */\n async getCommand(\n cmdId: string,\n opts?: { signal?: AbortSignal },\n ): Promise<Command> {\n \"use step\";\n return this.withResume(\n () => this.session!.getCommand(cmdId, opts),\n opts?.signal,\n );\n }\n\n /**\n * Create a directory in the filesystem of this sandbox.\n *\n * @param path - Path of the directory to create\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n */\n async mkDir(path: string, opts?: { signal?: AbortSignal }): Promise<void> {\n \"use step\";\n return this.withResume(\n () => this.session!.mkDir(path, opts),\n opts?.signal,\n );\n }\n\n /**\n * Read a file from the filesystem of this sandbox as a stream.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to a ReadableStream containing the file contents, or null if file not found\n */\n async readFile(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<NodeJS.ReadableStream | null> {\n \"use step\";\n return this.withResume(\n () => this.session!.readFile(file, opts),\n opts?.signal,\n );\n }\n\n /**\n * Read a file from the filesystem of this sandbox as a Buffer.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the file contents as a Buffer, or null if file not found\n */\n async readFileToBuffer(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<Buffer | null> {\n \"use step\";\n return this.withResume(\n () => this.session!.readFileToBuffer(file, opts),\n opts?.signal,\n );\n }\n\n /**\n * Download a file from the sandbox to the local filesystem.\n *\n * @param src - Source file on the sandbox, with path and optional cwd\n * @param dst - Destination file on the local machine, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.mkdirRecursive - If true, create parent directories for the destination if they don't exist.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The absolute path to the written file, or null if the source file was not found\n */\n async downloadFile(\n src: { path: string; cwd?: string },\n dst: { path: string; cwd?: string },\n opts?: { mkdirRecursive?: boolean; signal?: AbortSignal },\n ): Promise<string | null> {\n \"use step\";\n return this.withResume(\n () => this.session!.downloadFile(src, dst, opts),\n opts?.signal,\n );\n }\n\n /**\n * Write files to the filesystem of this sandbox.\n * Defaults to writing to /vercel/sandbox unless an absolute path is specified.\n * Writes files using the `vercel-sandbox` user.\n *\n * @param files - Array of files with path, content, and optional mode (permissions)\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the files are written\n *\n * @example\n * // Write an executable script\n * await sandbox.writeFiles([\n * { path: \"/usr/local/bin/myscript\", content: \"#!/bin/bash\\necho hello\", mode: 0o755 }\n * ]);\n */\n async writeFiles(\n files: {\n path: string;\n content: string | Uint8Array;\n mode?: number;\n }[],\n opts?: { signal?: AbortSignal },\n ) {\n \"use step\";\n return this.withResume(\n () => this.session!.writeFiles(files, opts),\n opts?.signal,\n );\n }\n\n /**\n * Get the public domain of a port of this sandbox.\n *\n * @param p - Port number to resolve\n * @returns A full domain (e.g. `https://subdomain.vercel.run`)\n * @throws If the port has no associated route\n */\n domain(p: number): string {\n return this.currentSession().domain(p);\n }\n\n /**\n * Stop the sandbox.\n *\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The final session state after stopping, with optional snapshot metadata.\n */\n async stop(opts?: {\n signal?: AbortSignal;\n }): Promise<SandboxSnapshot & { snapshot?: SnapshotMetadata }> {\n \"use step\";\n if (!this.session) {\n throw new Error(\"No active session to stop.\");\n }\n const { session, sandbox, snapshot } = await this.session.stop(opts);\n if (sandbox) {\n this.sandbox = sandbox;\n }\n return Object.assign(session, { snapshot });\n }\n\n /**\n * Update the network policy for this sandbox.\n *\n * @deprecated Use {@link Sandbox.update} instead.\n *\n * @param networkPolicy - The new network policy to apply.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the network policy is updated.\n *\n * @example\n * // Restrict to specific domains\n * await sandbox.updateNetworkPolicy({\n * allow: [\"*.npmjs.org\", \"github.com\"],\n * });\n *\n * @example\n * // Inject credentials with per-domain transformers\n * await sandbox.updateNetworkPolicy({\n * allow: {\n * \"ai-gateway.vercel.sh\": [{\n * transform: [{\n * headers: { authorization: \"Bearer ...\" }\n * }]\n * }],\n * \"*\": []\n * }\n * });\n *\n * @example\n * // Deny all network access\n * await sandbox.updateNetworkPolicy(\"deny-all\");\n */\n async updateNetworkPolicy(\n networkPolicy: NetworkPolicy,\n opts?: { signal?: AbortSignal },\n ): Promise<NetworkPolicy> {\n \"use step\";\n await this.withResume(\n () => this.session!.update({ networkPolicy: networkPolicy }, opts),\n opts?.signal,\n );\n\n return this.session!.networkPolicy!;\n }\n\n /**\n * Extend the timeout of the sandbox by the specified duration.\n *\n * This allows you to extend the lifetime of a sandbox up until the maximum\n * execution timeout for your plan.\n *\n * @param duration - The duration in milliseconds to extend the timeout by\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the timeout is extended\n *\n * @example\n * const sandbox = await Sandbox.create({ timeout: ms('10m') });\n * // Extends timeout by 5 minutes, to a total of 15 minutes.\n * await sandbox.extendTimeout(ms('5m'));\n */\n async extendTimeout(\n duration: number,\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n return this.withResume(\n () => this.session!.extendTimeout(duration, opts),\n opts?.signal,\n );\n }\n\n /**\n * Create a snapshot from this currently running sandbox. New sandboxes can\n * then be created from this snapshot using {@link Sandbox.createFromSnapshot}.\n *\n * Note: this sandbox will be stopped as part of the snapshot creation process.\n *\n * @param opts - Optional parameters.\n * @param opts.expiration - Optional expiration time in milliseconds. Use 0 for no expiration at all.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the Snapshot instance\n */\n async snapshot(opts?: {\n expiration?: number;\n signal?: AbortSignal;\n }): Promise<Snapshot> {\n \"use step\";\n return this.withResume(\n () => this.session!.snapshot(opts),\n opts?.signal,\n );\n }\n\n /**\n * Update the sandbox configuration.\n *\n * @param params - Fields to update.\n * @param opts - Optional abort signal.\n */\n async update(\n params: {\n persistent?: boolean;\n resources?: { vcpus?: number };\n timeout?: number;\n networkPolicy?: NetworkPolicy;\n tags?: Record<string, string>;\n snapshotExpiration?: number;\n currentSnapshotId?: string;\n },\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n let resources: { vcpus: number; memory: number } | undefined;\n if (params.resources?.vcpus) {\n resources = {\n vcpus: params.resources.vcpus,\n memory: params.resources.vcpus * 2048,\n };\n }\n\n // Update the sandbox config. This config will be used on the next session.\n const response = await client.updateSandbox({\n name: this.sandbox.name,\n projectId: this.projectId,\n persistent: params.persistent,\n resources,\n timeout: params.timeout,\n networkPolicy: params.networkPolicy,\n tags: params.tags,\n snapshotExpiration: params.snapshotExpiration,\n currentSnapshotId: params.currentSnapshotId,\n signal: opts?.signal,\n });\n this.sandbox = response.json.sandbox;\n\n // Update the current session config. This only applies to network policy.\n if (params.networkPolicy) {\n try {\n return await this.session?.update(\n { networkPolicy: params.networkPolicy },\n opts,\n );\n } catch (err) {\n if (isSandboxStoppedError(err) || isSandboxStoppingError(err)) {\n return;\n }\n throw err;\n }\n }\n }\n\n /**\n * Delete this sandbox.\n *\n * After deletion the instance becomes inert — all further API calls will\n * throw immediately.\n */\n async delete(opts?: { signal?: AbortSignal }): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n await client.deleteSandbox({\n name: this.sandbox.name,\n projectId: this.projectId,\n signal: opts?.signal,\n });\n }\n\n /**\n * List sessions (VMs) that have been created for this sandbox.\n *\n * @param params - Optional pagination parameters.\n * @returns The list of sessions and pagination metadata.\n */\n async listSessions(params?: {\n limit?: number;\n cursor?: string;\n sortOrder?: \"asc\" | \"desc\";\n signal?: AbortSignal;\n }) {\n \"use step\";\n const client = await this.ensureClient();\n const fetchPage = async (cursor?: string) => {\n const response = await client.listSessions({\n projectId: this.projectId,\n name: this.sandbox.name,\n limit: params?.limit,\n cursor,\n sortOrder: params?.sortOrder,\n signal: params?.signal,\n });\n return response.json;\n };\n const firstPage = await fetchPage(params?.cursor);\n return attachPaginator(firstPage, {\n itemsKey: \"sessions\",\n fetchNext: fetchPage,\n signal: params?.signal,\n });\n }\n\n /**\n * List snapshots that belong to this sandbox.\n *\n * @param params - Optional pagination parameters.\n * @returns The list of snapshots and pagination metadata.\n */\n async listSnapshots(params?: {\n limit?: number;\n cursor?: string;\n sortOrder?: \"asc\" | \"desc\";\n signal?: AbortSignal;\n }) {\n \"use step\";\n const client = await this.ensureClient();\n const fetchPage = async (cursor?: string) => {\n const response = await client.listSnapshots({\n projectId: this.projectId,\n name: this.sandbox.name,\n limit: params?.limit,\n cursor,\n sortOrder: params?.sortOrder,\n signal: params?.signal,\n });\n return response.json;\n };\n const firstPage = await fetchPage(params?.cursor);\n return attachPaginator(firstPage, {\n itemsKey: \"snapshots\",\n fetchNext: fetchPage,\n signal: params?.signal,\n });\n }\n}\n\n/**\n * A {@link Sandbox} that can automatically be disposed using a `await using` statement.\n *\n * @example\n * {\n * await using const sandbox = await Sandbox.create();\n * }\n * // Sandbox is automatically stopped here\n */\nclass DisposableSandbox extends Sandbox implements AsyncDisposable {\n async [Symbol.asyncDispose]() {\n await this.stop();\n }\n}\n"],"mappings":";;;;;;;;;;;;;AAmLA,SAAS,sBAAsB,KAAuB;AACpD,QAAO,eAAe,YAAY,IAAI,SAAS,WAAW;;AAG5D,SAAS,gBAAgB,KAAuB;AAC9C,QAAO,eAAe,YAAY,IAAI,SAAS,WAAW;;AAG5D,SAAS,wBAAwB,KAAuB;AACtD,QACE,eAAe,YACf,IAAI,SAAS,WAAW,OACvB,IAAI,MAAc,OAAO,SAAS;;AAIvC,SAAS,uBAAuB,KAAuB;AACrD,QACE,eAAe,YACf,IAAI,SAAS,WAAW,OACvB,IAAI,MAAc,OAAO,SAAS;;AAIvC,SAAS,2BAA2B,KAAuB;AACzD,QACE,eAAe,YACf,IAAI,SAAS,WAAW,OACvB,IAAI,MAAc,OAAO,SAAS;;;;;;;AAyBvC,IAAa,UAAb,MAAa,QAAQ;;;;;CAuCnB,MAAc,eAAmC;AAC/C;AACA,MAAI,KAAK,QAAS,QAAO,KAAK;EAC9B,MAAM,cAAc,MAAM,gBAAgB;AAC1C,OAAK,UAAU,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACpB,CAAC;AACF,SAAO,KAAK;;;;;CAMd,IAAW,OAAe;AACxB,SAAO,KAAK,QAAQ;;;;;;CAOtB,IAAW,SAA6B;AACtC,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,aAAsB;AAC/B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAA6B;AACtC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,QAA4B;AACrC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAA6B;AACtC,SAAO,KAAK,QAAQ;;;CAItB,IAAW,UAA8B;AACvC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,mBAAuC;AAChD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,oBAAwC;AACjD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,2BAA+C;AACxD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,kBAAsC;AAC/C,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;CAMzC,IAAW,kBAAoC;AAC7C,SAAO,KAAK,QAAQ,kBAChB,IAAI,KAAK,KAAK,QAAQ,gBAAgB,GACtC;;;;;CAMN,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;CAMzC,IAAW,kBAAsC;AAC/C,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,SAAoC;AAC7C,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,UAA8B;AACvC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,OAA2C;AACpD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,gBAA2C;AACpD,SAAO,KAAK,QAAQ,gBAChB,qBAAqB,KAAK,QAAQ,cAAc,GAChD;;;;;CAMN,IAAW,mBAAuC;AAChD,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,oBAAwC;AACjD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,qBAAyC;AAClD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,mBAAuC;AAChD,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,kBAEG;AACZ,SAAO,KAAK,gBAAgB,CAAC;;;;;;;;;;;;;;;;CAiB/B,aAAa,KACX,QAGA;AACA;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,QAAQ;GAChB,CAAC;EACF,MAAM,YAAY,OAAO,WAAoB;AAM3C,WALiB,MAAM,OAAO,cAAc;IAC1C,GAAG;IACH,GAAG;IACH,GAAI,WAAW,UAAa,EAAE,QAAQ;IACvC,CAAC,EACc;;AAGlB,SAAO,gBADW,MAAM,UAAU,QAAQ,OAAO,EACf;GAChC,UAAU;GACV,WAAW;GACX,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;CASJ,QAAQ,oBAAoB,UAAsC;AAChE,SAAO;GACL,UAAU,SAAS,SAAS;GAC5B,QAAQ,SAAS,SAAS,UAAU,EAAE;GACtC,iBAAiB,SAAS;GAC1B,WAAW,SAAS;GACrB;;;;;;;;;;;CAYH,QAAQ,sBAAsB,MAAkC;EAC9D,MAAM,UAAU,IAAI,QAAQ;GAC1B,SAAS,KAAK;GACd,QAAQ,KAAK;GACb,WAAW,KAAK;GACjB,CAAC;AACF,MAAI,KAAK,SACP,SAAQ,UAAU,IAAI,QAAQ;GAAE,QAAQ,KAAK;GAAQ,UAAU,KAAK;GAAU,CAAC;AAEjF,SAAO;;;;;;;;;;;;;;;;;;CAmBT,aAAa,OACX,QAIoC;AACpC;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,QAAQ;GAChB,CAAC;EAEF,MAAM,gBAAgB,iBAAiB,OAAO;EAC9C,MAAM,WAAW,MAAM,OAAO,cAAc;GAC1C,QAAQ,QAAQ;GAChB,WAAW,YAAY;GACvB,OAAO,QAAQ,SAAS,EAAE;GAC1B,SAAS,QAAQ;GACjB,WAAW,QAAQ;GACnB,SAAS,UAAU,aAAa,SAAS,QAAQ,UAAU;GAC3D,eAAe,QAAQ;GACvB,KAAK,QAAQ;GACb,MAAM,QAAQ;GACd,oBAAoB,QAAQ;GAC5B,QAAQ,QAAQ;GAChB,MAAM,QAAQ;GACd,YAAY,QAAQ;GACpB,GAAG;GACJ,CAAC;AAEF,SAAO,IAAI,kBAAkB;GAC3B;GACA,SAAS,SAAS,KAAK;GACvB,SAAS,SAAS,KAAK;GACvB,QAAQ,SAAS,KAAK;GACtB,WAAW,YAAY;GACvB,UAAU,QAAQ;GACnB,CAAC;;;;;;;;CASJ,aAAa,IACX,QAEkB;AAClB;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,OAAO;GACf,CAAC;EAEF,MAAM,gBAAgB,iBAAiB,OAAO;EAC9C,MAAM,WAAW,MAAM,OAAO,WAAW;GACvC,MAAM,OAAO;GACb,WAAW,YAAY;GACvB,QAAQ,OAAO;GACf,QAAQ,OAAO;GACf,GAAG;GACJ,CAAC;EAEF,MAAM,UAAU,IAAI,QAAQ;GAC1B;GACA,SAAS,SAAS,KAAK;GACvB,SAAS,SAAS,KAAK;GACvB,QAAQ,SAAS,KAAK;GACtB,WAAW,YAAY;GACvB,UAAU,OAAO;GAClB,CAAC;AAEF,MAAI,SAAS,KAAK,WAAW,OAAO,SAClC,OAAM,OAAO,SAAS,QAAQ;AAGhC,SAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCT,aAAa,YACX,QAIkB;AAClB;AAEA,MAAI,CAAC,QAAQ,MAAM;GACjB,MAAM,UAAU,MAAM,QAAQ,OAAO,OAAO;AAC5C,OAAI,QAAQ,SACV,OAAM,OAAO,SAAS,QAAQ;AAEhC,UAAO;;AAGT,MAAI;AACF,UAAO,MAAM,QAAQ,IACnB,OACD;WACM,KAAK;AACZ,OAAI,gBAAgB,IAAI,EAAE;IAExB,MAAM,UAAU,MAAM,QAAQ,OAAO,OAAO;AAC5C,QAAI,OAAO,SACT,OAAM,OAAO,SAAS,QAAQ;AAEhC,WAAO;;AAGT,OAAI,wBAAwB,IAAI,EAAE;IAGhC,MAAM,cAAc,MAAM,eAAe,OAAO;IAChD,MAAM,SAAS,IAAI,UAAU;KAC3B,QAAQ,YAAY;KACpB,OAAO,YAAY;KACnB,OAAO,OAAO;KACf,CAAC;IACF,MAAM,gBAAgB,iBAAiB,OAAO;AAC9C,QAAI;AACF,WAAM,OAAO,cAAc;MACzB,MAAM,OAAO;MACb,WAAW,YAAY;MACvB,QAAQ,OAAO;MACf,GAAG;MACJ,CAAC;aACK,WAAW;AAGlB,SAAI,CAAC,gBAAgB,UAAU,CAC7B,OAAM;;IAIV,MAAM,UAAU,MAAM,QAAQ,OAAO,OAAO;AAC5C,QAAI,OAAO,SACT,OAAM,OAAO,SAAS,QAAQ;AAEhC,WAAO;;AAGT,SAAM;;;;;;;;;;CAWV,YAAY,EACV,QACA,QACA,SACA,SACA,WACA,YAQC;OAvgBK,UAA4B;OAM5B,gBAAsC;AAkgB5C,OAAK,UAAU,UAAU;AACzB,MAAI,QACF,MAAK,UAAU,IAAI,QAAQ;GAAU;GAAS;GAAQ;GAAS,CAAC;AAElE,OAAK,UAAU;AACf,OAAK,YAAY,aAAa;AAC9B,OAAK,WAAW;AAChB,OAAK,KAAK,IAAI,WAAW,KAAK;;;;;;;CAQhC,iBAA0B;AACxB,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,yDAAyD;AAE3E,SAAO,KAAK;;;;;CAMd,MAAc,OAAO,QAAqC;AACxD,MAAI,CAAC,KAAK,cACR,MAAK,gBAAgB,KAAK,SAAS,OAAO,CAAC,cAAc;AACvD,QAAK,gBAAgB;IACrB;AAEJ,SAAO,KAAK;;CAGd,MAAc,SAAS,QAAqC;EAC1D,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,WAAW,MAAM,OAAO,WAAW;GACvC,MAAM,KAAK,QAAQ;GACnB,WAAW,KAAK;GAChB,QAAQ;GACR;GACD,CAAC;AACF,OAAK,UAAU,IAAI,QAAQ;GACzB;GACA,QAAQ,SAAS,KAAK;GACtB,SAAS,SAAS,KAAK;GACxB,CAAC;AACF,MAAI,KAAK,YAAY,SAAS,KAAK,QACjC,OAAM,KAAK,SAAS,KAAK;;;;;CAO7B,MAAc,qBAAqB,QAAqC;AACtE;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,kBAAkB;EACxB,IAAI,SAAS,KAAK,QAAS;AAE3B,SAAO,WAAW,cAAc,WAAW,gBAAgB;AACzD,SAAM,WAAW,iBAAiB,QAAW,EAAE,QAAQ,CAAC;GACxD,MAAM,OAAO,MAAM,OAAO,WAAW;IACnC,WAAW,KAAK,QAAS;IACzB;IACD,CAAC;AACF,QAAK,UAAU,IAAI,QAAQ;IACzB;IACA,QAAQ,KAAK,KAAK;IAClB,SAAS,KAAK,KAAK;IACpB,CAAC;AACF,YAAS,KAAK,KAAK,QAAQ;;AAE7B,QAAM,KAAK,OAAO,OAAO;;;;;CAM3B,MAAc,WACZ,IACA,QACY;AACZ,MAAI,CAAC,KAAK,QACR,OAAM,KAAK,OAAO,OAAO;AAE3B,MAAI;AACF,UAAO,MAAM,IAAI;WACV,KAAK;AACZ,OAAI,sBAAsB,IAAI,EAAE;AAC9B,UAAM,KAAK,OAAO,OAAO;AACzB,WAAO,IAAI;;AAEb,OAAI,uBAAuB,IAAI,IAAI,2BAA2B,IAAI,EAAE;AAClE,UAAM,KAAK,qBAAqB,OAAO;AACvC,WAAO,IAAI;;AAEb,SAAM;;;CAqCV,MAAM,WACJ,iBACA,MACA,MACoC;AACpC;EACA,MAAM,SACJ,OAAO,oBAAoB,WACvB,MAAM,SACN,gBAAgB;AACtB,SAAO,KAAK,iBACJ,KAAK,QAAS,WAAW,iBAAwB,MAAM,KAAK,EAClE,OACD;;;;;;;;;CAUH,MAAM,WACJ,OACA,MACkB;AAClB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,WAAW,OAAO,KAAK,EAC3C,MAAM,OACP;;;;;;;;;CAUH,MAAM,MAAM,MAAc,MAAgD;AACxE;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,MAAM,MAAM,KAAK,EACrC,MAAM,OACP;;;;;;;;;;CAWH,MAAM,SACJ,MACA,MACuC;AACvC;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,SAAS,MAAM,KAAK,EACxC,MAAM,OACP;;;;;;;;;;CAWH,MAAM,iBACJ,MACA,MACwB;AACxB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,iBAAiB,MAAM,KAAK,EAChD,MAAM,OACP;;;;;;;;;;;;CAaH,MAAM,aACJ,KACA,KACA,MACwB;AACxB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,aAAa,KAAK,KAAK,KAAK,EAChD,MAAM,OACP;;;;;;;;;;;;;;;;;;CAmBH,MAAM,WACJ,OAKA,MACA;AACA;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,WAAW,OAAO,KAAK,EAC3C,MAAM,OACP;;;;;;;;;CAUH,OAAO,GAAmB;AACxB,SAAO,KAAK,gBAAgB,CAAC,OAAO,EAAE;;;;;;;;;CAUxC,MAAM,KAAK,MAEoD;AAC7D;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,6BAA6B;EAE/C,MAAM,EAAE,SAAS,SAAS,aAAa,MAAM,KAAK,QAAQ,KAAK,KAAK;AACpE,MAAI,QACF,MAAK,UAAU;AAEjB,SAAO,OAAO,OAAO,SAAS,EAAE,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC7C,MAAM,oBACJ,eACA,MACwB;AACxB;AACA,QAAM,KAAK,iBACH,KAAK,QAAS,OAAO,EAAiB,eAAe,EAAE,KAAK,EAClE,MAAM,OACP;AAED,SAAO,KAAK,QAAS;;;;;;;;;;;;;;;;;;CAmBvB,MAAM,cACJ,UACA,MACe;AACf;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,cAAc,UAAU,KAAK,EACjD,MAAM,OACP;;;;;;;;;;;;;CAcH,MAAM,SAAS,MAGO;AACpB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,SAAS,KAAK,EAClC,MAAM,OACP;;;;;;;;CASH,MAAM,OACJ,QASA,MACe;AACf;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,IAAIA;AACJ,MAAI,OAAO,WAAW,MACpB,aAAY;GACV,OAAO,OAAO,UAAU;GACxB,QAAQ,OAAO,UAAU,QAAQ;GAClC;AAgBH,OAAK,WAZY,MAAM,OAAO,cAAc;GAC1C,MAAM,KAAK,QAAQ;GACnB,WAAW,KAAK;GAChB,YAAY,OAAO;GACnB;GACA,SAAS,OAAO;GAChB,eAAe,OAAO;GACtB,MAAM,OAAO;GACb,oBAAoB,OAAO;GAC3B,mBAAmB,OAAO;GAC1B,QAAQ,MAAM;GACf,CAAC,EACsB,KAAK;AAG7B,MAAI,OAAO,cACT,KAAI;AACF,UAAO,MAAM,KAAK,SAAS,OACzB,EAAE,eAAe,OAAO,eAAe,EACvC,KACD;WACM,KAAK;AACZ,OAAI,sBAAsB,IAAI,IAAI,uBAAuB,IAAI,CAC3D;AAEF,SAAM;;;;;;;;;CAWZ,MAAM,OAAO,MAAgD;AAC3D;AAEA,SADe,MAAM,KAAK,cAAc,EAC3B,cAAc;GACzB,MAAM,KAAK,QAAQ;GACnB,WAAW,KAAK;GAChB,QAAQ,MAAM;GACf,CAAC;;;;;;;;CASJ,MAAM,aAAa,QAKhB;AACD;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,YAAY,OAAO,WAAoB;AAS3C,WARiB,MAAM,OAAO,aAAa;IACzC,WAAW,KAAK;IAChB,MAAM,KAAK,QAAQ;IACnB,OAAO,QAAQ;IACf;IACA,WAAW,QAAQ;IACnB,QAAQ,QAAQ;IACjB,CAAC,EACc;;AAGlB,SAAO,gBADW,MAAM,UAAU,QAAQ,OAAO,EACf;GAChC,UAAU;GACV,WAAW;GACX,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;CASJ,MAAM,cAAc,QAKjB;AACD;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,YAAY,OAAO,WAAoB;AAS3C,WARiB,MAAM,OAAO,cAAc;IAC1C,WAAW,KAAK;IAChB,MAAM,KAAK,QAAQ;IACnB,OAAO,QAAQ;IACf;IACA,WAAW,QAAQ;IACnB,QAAQ,QAAQ;IACjB,CAAC,EACc;;AAGlB,SAAO,gBADW,MAAM,UAAU,QAAQ,OAAO,EACf;GAChC,UAAU;GACV,WAAW;GACX,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;;;;;AAaN,IAAM,oBAAN,cAAgC,QAAmC;CACjE,OAAO,OAAO,gBAAgB;AAC5B,QAAM,KAAK,MAAM"}
1
+ {"version":3,"file":"sandbox.js","names":["resources: { vcpus: number; memory: number } | undefined"],"sources":["../src/sandbox.ts"],"sourcesContent":["import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from \"@workflow/serde\";\nimport type {\n SessionMetaData,\n SandboxRouteData,\n SandboxMetaData,\n SnapshotMetadata,\n} from \"./api-client/index.js\";\nimport { APIClient } from \"./api-client/index.js\";\nimport { APIError } from \"./api-client/api-error.js\";\nimport { type Credentials, getCredentials } from \"./utils/get-credentials.js\";\nimport { getPrivateParams, type WithPrivate } from \"./utils/types.js\";\nimport type { WithFetchOptions } from \"./api-client/api-client.js\";\nimport type { RUNTIMES } from \"./constants.js\";\nimport { Session, type RunCommandParams } from \"./session.js\";\nimport type { Command, CommandFinished } from \"./command.js\";\nimport type { Snapshot } from \"./snapshot.js\";\nimport type { SandboxSnapshot } from \"./utils/sandbox-snapshot.js\";\nimport type {\n NetworkPolicy,\n NetworkPolicyKeyValueMatcher,\n NetworkPolicyMatch,\n NetworkPolicyMatcher,\n} from \"./network-policy.js\";\nimport { fromAPINetworkPolicy } from \"./utils/network-policy.js\";\nimport { attachPaginator } from \"./utils/paginator.js\";\nimport { setTimeout } from \"node:timers/promises\";\nimport { FileSystem } from \"./filesystem.js\";\n\nexport type {\n NetworkPolicy,\n NetworkPolicyKeyValueMatcher,\n NetworkPolicyMatch,\n NetworkPolicyMatcher,\n};\n\n/** @inline */\nexport interface BaseCreateSandboxParams {\n /**\n * The name of the sandbox. If omitted, a random name will be generated.\n */\n name?: string;\n /**\n * The source of the sandbox.\n *\n * Omit this parameter start a sandbox without a source.\n *\n * For git sources:\n * - `depth`: Creates shallow clones with limited commit history (minimum: 1)\n * - `revision`: Clones and checks out a specific commit, branch, or tag\n */\n source?:\n | {\n type: \"git\";\n url: string;\n depth?: number;\n revision?: string;\n }\n | {\n type: \"git\";\n url: string;\n username: string;\n password: string;\n depth?: number;\n revision?: string;\n }\n | { type: \"tarball\"; url: string };\n /**\n * Array of port numbers to expose from the sandbox. Sandboxes can\n * expose up to 4 ports.\n */\n ports?: number[];\n /**\n * Timeout in milliseconds before the sandbox auto-terminates.\n */\n timeout?: number;\n /**\n * Resources to allocate to the sandbox.\n *\n * Your sandbox will get the amount of vCPUs you specify here and\n * 2048 MB of memory per vCPU.\n */\n resources?: { vcpus: number };\n /**\n * The runtime of the sandbox, currently only `node24`, `node22`, `node26` and `python3.13` are supported.\n * If not specified, the default runtime `node24` will be used.\n */\n runtime?: RUNTIMES | (string & {});\n /**\n * Network policy to define network restrictions for the sandbox.\n * Defaults to full internet access if not specified.\n */\n networkPolicy?: NetworkPolicy;\n /**\n * Default environment variables for the sandbox.\n * These are inherited by all commands unless overridden with\n * the `env` option in `runCommand`.\n *\n * @example\n * const sandbox = await Sandbox.create({\n * env: { NODE_ENV: \"production\", API_KEY: \"secret\" },\n * });\n * // All commands will have NODE_ENV and API_KEY set\n * await sandbox.runCommand(\"node\", [\"app.js\"]);\n */\n env?: Record<string, string>;\n /**\n * Key-value tags to associate with the sandbox. Maximum 5 tags.\n * @example { env: \"staging\", team: \"infra\" }\n */\n tags?: Record<string, string>;\n\n /**\n * An AbortSignal to cancel sandbox creation.\n */\n signal?: AbortSignal;\n /**\n * Enable or disable automatic restore of the filesystem between sessions.\n */\n persistent?: boolean;\n /**\n * Default snapshot expiration in milliseconds.\n * When set, snapshots created for this sandbox will expire after this duration.\n * Use `0` for no expiration.\n */\n snapshotExpiration?: number;\n /**\n * Called when the sandbox session is resumed (e.g., after a snapshot restore).\n * Use this to re-warm caches, restore transient state, or run other setup logic.\n */\n onResume?: (sandbox: Sandbox) => Promise<void>;\n}\n\nexport type CreateSandboxParams =\n | BaseCreateSandboxParams\n | (Omit<BaseCreateSandboxParams, \"runtime\" | \"source\"> & {\n source: { type: \"snapshot\"; snapshotId: string };\n });\n\n/** @inline */\ninterface GetSandboxParams {\n /**\n * The name of the sandbox.\n */\n name: string;\n /**\n * Whether to resume an existing session. Defaults to true.\n */\n resume?: boolean;\n /**\n * An AbortSignal to cancel the operation.\n */\n signal?: AbortSignal;\n /**\n * Called when the sandbox session is resumed (e.g., after a snapshot restore).\n * Use this to re-warm caches, restore transient state, or run other setup logic.\n */\n onResume?: (sandbox: Sandbox) => Promise<void>;\n}\n\n/**\n * Extends both {@link BaseCreateSandboxParams} and {@link GetSandboxParams}\n * (minus `name`, which is required on get but optional here) so that any\n * new parameter added to either flow is picked up automatically. The\n * structural overlap on `signal` / `onResume` is intentional — both\n * interfaces declare them with identical optional types.\n * @inline\n */\ninterface GetOrCreateSandboxParams\n extends BaseCreateSandboxParams,\n Omit<GetSandboxParams, \"name\"> {\n /**\n * Called once after a sandbox is freshly created (not when an existing\n * sandbox is retrieved). Use this for one-time setup such as seeding\n * files or warming caches. The returned promise is awaited before\n * {@link Sandbox.getOrCreate} resolves.\n */\n onCreate?: (sandbox: Sandbox) => Promise<void>;\n}\n\nfunction isSandboxStoppedError(err: unknown): boolean {\n return err instanceof APIError && err.response.status === 410;\n}\n\nfunction isNotFoundError(err: unknown): boolean {\n return err instanceof APIError && err.response.status === 404;\n}\n\nfunction isSnapshotNotFoundError(err: unknown): boolean {\n return (\n err instanceof APIError &&\n err.response.status === 410 &&\n (err.json as any)?.error?.code === \"snapshot_not_found\"\n );\n}\n\nfunction isSandboxStoppingError(err: unknown): boolean {\n return (\n err instanceof APIError &&\n err.response.status === 422 &&\n (err.json as any)?.error?.code === \"sandbox_stopping\"\n );\n}\n\nfunction isSandboxSnapshottingError(err: unknown): boolean {\n return (\n err instanceof APIError &&\n err.response.status === 422 &&\n (err.json as any)?.error?.code === \"sandbox_snapshotting\"\n );\n}\n\n/**\n * Serialized representation of a Sandbox for @workflow/serde.\n * Fields `metadata` and `routes` are the original wire format from main.\n * Fields `sandboxMetadata` and `projectId` are added for named-sandboxes.\n */\nexport interface SerializedSandbox {\n metadata: SandboxSnapshot;\n routes: SandboxRouteData[];\n sandboxMetadata?: SandboxMetaData;\n projectId?: string;\n}\n\n// ============================================================================\n// Sandbox class\n// ============================================================================\n\n/**\n * A Sandbox is a persistent, isolated Linux MicroVMs to run commands in.\n * Use {@link Sandbox.create} or {@link Sandbox.get} to construct.\n * @hideconstructor\n */\nexport class Sandbox {\n private _client: APIClient | null = null;\n private readonly projectId: string;\n\n /**\n * In-flight resume promise, used to deduplicate concurrent resume calls.\n */\n private resumePromise: Promise<void> | null = null;\n\n /**\n * Internal Session instance for the current VM.\n */\n private session: Session | undefined;\n\n /**\n * Internal metadata about the sandbox.\n */\n private sandbox: SandboxMetaData;\n\n /**\n * Hook that will be executed when a new session is created during resume.\n */\n private readonly onResume?: (sandbox: Sandbox) => Promise<void>;\n\n /**\n * A `node:fs/promises`-compatible API for interacting with the sandbox filesystem.\n *\n * @example\n * const content = await sandbox.fs.readFile('/etc/hostname', 'utf8');\n * await sandbox.fs.writeFile('/tmp/hello.txt', 'Hello, world!');\n * const files = await sandbox.fs.readdir('/tmp');\n * const stats = await sandbox.fs.stat('/tmp/hello.txt');\n */\n public readonly fs: FileSystem;\n\n /**\n * Lazily resolve credentials and construct an API client.\n * @internal\n */\n private async ensureClient(): Promise<APIClient> {\n \"use step\";\n if (this._client) return this._client;\n const credentials = await getCredentials();\n this._client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n });\n return this._client;\n }\n\n /**\n * The name of this sandbox.\n */\n public get name(): string {\n return this.sandbox.name;\n }\n\n /**\n * Routes from ports to subdomains.\n * @hidden\n */\n public get routes(): SandboxRouteData[] {\n return this.currentSession().routes;\n }\n\n /**\n * Whether the sandbox persists the state.\n */\n public get persistent(): boolean {\n return this.sandbox.persistent;\n }\n\n /**\n * The region this sandbox runs in.\n */\n public get region(): string | undefined {\n return this.sandbox.region;\n }\n\n /**\n * Number of virtual CPUs allocated.\n */\n public get vcpus(): number | undefined {\n return this.sandbox.vcpus;\n }\n\n /**\n * Memory allocated in MB.\n */\n public get memory(): number | undefined {\n return this.sandbox.memory;\n }\n\n /** Runtime identifier (e.g. \"node24\", \"python3.13\"). */\n public get runtime(): string | undefined {\n return this.sandbox.runtime;\n }\n\n /**\n * Cumulative egress bytes across all sessions.\n */\n public get totalEgressBytes(): number | undefined {\n return this.sandbox.totalEgressBytes;\n }\n\n /**\n * Cumulative ingress bytes across all sessions.\n */\n public get totalIngressBytes(): number | undefined {\n return this.sandbox.totalIngressBytes;\n }\n\n /**\n * Cumulative active CPU duration in milliseconds across all sessions.\n */\n public get totalActiveCpuDurationMs(): number | undefined {\n return this.sandbox.totalActiveCpuDurationMs;\n }\n\n /**\n * Cumulative wall-clock duration in milliseconds across all sessions.\n */\n public get totalDurationMs(): number | undefined {\n return this.sandbox.totalDurationMs;\n }\n\n /**\n * When this sandbox was last updated.\n */\n public get updatedAt(): Date {\n return new Date(this.sandbox.updatedAt);\n }\n\n /**\n * When the sandbox status was last updated.\n */\n public get statusUpdatedAt(): Date | undefined {\n return this.sandbox.statusUpdatedAt\n ? new Date(this.sandbox.statusUpdatedAt)\n : undefined;\n }\n\n /**\n * When this sandbox was created.\n */\n public get createdAt(): Date {\n return new Date(this.sandbox.createdAt);\n }\n\n /**\n * Interactive port.\n */\n public get interactivePort(): number | undefined {\n return this.currentSession().interactivePort;\n }\n\n /**\n * The status of the current session.\n */\n public get status(): SessionMetaData[\"status\"] {\n return this.currentSession().status;\n }\n\n /**\n * The default timeout of this sandbox in milliseconds.\n */\n public get timeout(): number | undefined {\n return this.sandbox.timeout;\n }\n\n /**\n * Key-value tags attached to the sandbox.\n */\n public get tags(): Record<string, string> | undefined {\n return this.sandbox.tags;\n }\n\n /**\n * The default network policy of this sandbox.\n */\n public get networkPolicy(): NetworkPolicy | undefined {\n return this.sandbox.networkPolicy\n ? fromAPINetworkPolicy(this.sandbox.networkPolicy)\n : undefined;\n }\n\n /**\n * If the session was created from a snapshot, the ID of that snapshot.\n */\n public get sourceSnapshotId(): string | undefined {\n return this.currentSession().sourceSnapshotId;\n }\n\n /**\n * The current snapshot ID of this sandbox, if any.\n */\n public get currentSnapshotId(): string | undefined {\n return this.sandbox.currentSnapshotId;\n }\n\n /**\n * The default snapshot expiration in milliseconds, if set.\n */\n public get snapshotExpiration(): number | undefined {\n return this.sandbox.snapshotExpiration;\n }\n\n /**\n * The amount of CPU used by the session. Only reported once the VM is stopped.\n */\n public get activeCpuUsageMs(): number | undefined {\n return this.currentSession().activeCpuUsageMs;\n }\n\n /**\n * The amount of network data used by the session. Only reported once the VM is stopped.\n */\n public get networkTransfer():\n | { ingress: number; egress: number }\n | undefined {\n return this.currentSession().networkTransfer;\n }\n\n /**\n * Allow to get a list of sandboxes for a team narrowed to the given params.\n * It returns both the sandboxes and the pagination metadata to allow getting\n * the next page of results.\n *\n * The returned object is async-iterable to auto-paginate through all pages:\n *\n * ```ts\n * const result = await Sandbox.list({ namePrefix: \"ci-\" });\n * for await (const sandbox of result) { ... }\n * // or: await result.toArray();\n * // or: for await (const page of result.pages()) { ... }\n * ```\n */\n static async list(\n params?: Partial<Parameters<APIClient[\"listSandboxes\"]>[0]> &\n Partial<Credentials> &\n WithFetchOptions,\n ) {\n \"use step\";\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params?.fetch,\n });\n const fetchPage = async (cursor?: string) => {\n const response = await client.listSandboxes({\n ...credentials,\n ...params,\n ...(cursor !== undefined && { cursor }),\n });\n return response.json;\n };\n const firstPage = await fetchPage(params?.cursor);\n return attachPaginator(firstPage, {\n itemsKey: \"sandboxes\",\n fetchNext: fetchPage,\n signal: params?.signal,\n });\n }\n\n /**\n * Serialize a Sandbox instance to plain data for @workflow/serde.\n *\n * @param instance - The Sandbox instance to serialize\n * @returns A plain object containing sandbox metadata and routes\n */\n static [WORKFLOW_SERIALIZE](instance: Sandbox): SerializedSandbox {\n return {\n metadata: instance.session?._sessionSnapshot!,\n routes: instance.session?.routes ?? [],\n sandboxMetadata: instance.sandbox,\n projectId: instance.projectId,\n };\n }\n\n /**\n * Deserialize a Sandbox from serialized snapshot data.\n *\n * The deserialized instance uses the serialized metadata synchronously and\n * lazily creates an API client only when methods perform API requests.\n *\n * @param data - The serialized sandbox data\n * @returns The reconstructed Sandbox instance\n */\n static [WORKFLOW_DESERIALIZE](data: SerializedSandbox): Sandbox {\n const sandbox = new Sandbox({\n sandbox: data.sandboxMetadata!,\n routes: data.routes,\n projectId: data.projectId,\n });\n if (data.metadata) {\n sandbox.session = new Session({ routes: data.routes, snapshot: data.metadata });\n }\n return sandbox;\n }\n\n /**\n * Create a new sandbox.\n *\n * @param params - Creation parameters and optional credentials.\n * @returns A promise resolving to the created {@link Sandbox}.\n * @example\n * <caption>Create a sandbox with default options</caption>\n * const sandbox = await Sandbox.create();\n *\n * @example\n * <caption>Create a sandbox and drop it in the end of the block</caption>\n * async function fn() {\n * await using const sandbox = await Sandbox.create();\n * // Sandbox automatically stopped at the end of the lexical scope\n * }\n */\n static async create(\n params?: WithPrivate<\n CreateSandboxParams | (CreateSandboxParams & Credentials)\n > &\n WithFetchOptions,\n ): Promise<Sandbox & AsyncDisposable> {\n \"use step\";\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params?.fetch,\n });\n\n const privateParams = getPrivateParams(params);\n const response = await client.createSandbox({\n source: params?.source,\n projectId: credentials.projectId,\n ports: params?.ports ?? [],\n timeout: params?.timeout,\n resources: params?.resources,\n runtime: params && \"runtime\" in params ? params?.runtime : undefined,\n networkPolicy: params?.networkPolicy,\n env: params?.env,\n tags: params?.tags,\n snapshotExpiration: params?.snapshotExpiration,\n signal: params?.signal,\n name: params?.name,\n persistent: params?.persistent,\n ...privateParams,\n });\n\n return new DisposableSandbox({\n client,\n session: response.json.session,\n sandbox: response.json.sandbox,\n routes: response.json.routes,\n projectId: credentials.projectId,\n onResume: params?.onResume,\n });\n }\n\n /**\n * Retrieve an existing sandbox and resume its session.\n *\n * @param params - Get parameters and optional credentials.\n * @returns A promise resolving to the {@link Sandbox}.\n */\n static async get(\n params: WithPrivate<GetSandboxParams | (GetSandboxParams & Credentials)> &\n WithFetchOptions,\n ): Promise<Sandbox> {\n \"use step\";\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params.fetch,\n });\n\n const privateParams = getPrivateParams(params);\n const response = await client.getSandbox({\n name: params.name,\n projectId: credentials.projectId,\n resume: params.resume,\n signal: params.signal,\n ...privateParams,\n });\n\n const sandbox = new Sandbox({\n client,\n session: response.json.session,\n sandbox: response.json.sandbox,\n routes: response.json.routes,\n projectId: credentials.projectId,\n onResume: params.onResume,\n });\n\n if (response.json.resumed && params.onResume) {\n await params.onResume(sandbox);\n }\n\n return sandbox;\n }\n\n /**\n * Retrieve an existing named sandbox, or create a new one if none exists.\n *\n * If `name` is omitted, this always creates a new sandbox and fires\n * `onCreate`. If `name` is provided, it first tries {@link Sandbox.get};\n * on `not_found` it creates a new sandbox with that name; on\n * `snapshot_not_found` it deletes the stale named sandbox and creates\n * a fresh one with the same name.\n *\n * @param params - Get/create parameters plus an optional `onCreate` hook.\n * @returns A promise resolving to the {@link Sandbox}.\n *\n * @example\n * <caption>Idempotent named sandbox with one-time setup</caption>\n * const sandbox = await Sandbox.getOrCreate({\n * name: \"my-workspace\",\n * onCreate: async (sbx) => {\n * await sbx.writeFiles([\n * { path: \"README.md\", content: Buffer.from(\"# Hello\") },\n * ]);\n * },\n * });\n *\n * @example\n * <caption>Unnamed — always creates</caption>\n * const sandbox = await Sandbox.getOrCreate({\n * onCreate: async (sbx) => {\n * await sbx.runCommand(\"npm\", [\"install\"]);\n * },\n * });\n */\n static async getOrCreate(\n params?: WithPrivate<\n GetOrCreateSandboxParams | (GetOrCreateSandboxParams & Credentials)\n > &\n WithFetchOptions,\n ): Promise<Sandbox> {\n \"use step\";\n // No name → always create, fire onCreate.\n if (!params?.name) {\n const sandbox = await Sandbox.create(params);\n if (params?.onCreate) {\n await params.onCreate(sandbox);\n }\n return sandbox;\n }\n\n try {\n return await Sandbox.get(\n params as unknown as Parameters<typeof Sandbox.get>[0],\n );\n } catch (err) {\n if (isNotFoundError(err)) {\n // Sandbox does not exist: re-create it.\n const sandbox = await Sandbox.create(params);\n if (params.onCreate) {\n await params.onCreate(sandbox);\n }\n return sandbox;\n }\n\n if (isSnapshotNotFoundError(err)) {\n // Sandbox exists but the snapshot has expired. Delete it and create\n // a new one.\n const credentials = await getCredentials(params);\n const client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n fetch: params.fetch,\n });\n const privateParams = getPrivateParams(params);\n try {\n await client.deleteSandbox({\n name: params.name,\n projectId: credentials.projectId,\n signal: params.signal,\n ...privateParams,\n });\n } catch (deleteErr) {\n // Tolerate 404 — the named sandbox was already cleaned up by a\n // concurrent request. Propagate anything else.\n if (!isNotFoundError(deleteErr)) {\n throw deleteErr;\n }\n }\n\n const sandbox = await Sandbox.create(params);\n if (params.onCreate) {\n await params.onCreate(sandbox);\n }\n return sandbox;\n }\n\n throw err;\n }\n }\n\n /**\n * Create a new Sandbox instance.\n *\n * @param params.client - Optional API client. If not provided, will be lazily created using global credentials.\n * @param params.routes - Port-to-subdomain mappings for exposed ports\n * @param params.sandbox - Sandbox snapshot metadata\n */\n constructor({\n client,\n routes,\n session,\n sandbox,\n projectId,\n onResume,\n }: {\n client?: APIClient;\n routes: SandboxRouteData[];\n session?: SessionMetaData;\n sandbox: SandboxMetaData;\n projectId?: string;\n onResume?: (sandbox: Sandbox) => Promise<void>;\n }) {\n this._client = client ?? null;\n if (session) {\n this.session = new Session({ client: client!, routes, session });\n }\n this.sandbox = sandbox;\n this.projectId = projectId ?? \"\";\n this.onResume = onResume;\n this.fs = new FileSystem(this);\n }\n\n /**\n * Get the current session (the running VM) for this sandbox.\n *\n * @returns The {@link Session} instance.\n */\n currentSession(): Session {\n if (!this.session) {\n throw new Error(\"No active session. Run a command or call resume first.\");\n }\n return this.session;\n }\n\n /**\n * Resume this sandbox by creating a new session via `getSandbox`.\n */\n private async resume(signal?: AbortSignal): Promise<void> {\n if (!this.resumePromise) {\n this.resumePromise = this.doResume(signal).finally(() => {\n this.resumePromise = null;\n });\n }\n return this.resumePromise;\n }\n\n private async doResume(signal?: AbortSignal): Promise<void> {\n const client = await this.ensureClient();\n const response = await client.getSandbox({\n name: this.sandbox.name,\n projectId: this.projectId,\n resume: true,\n signal,\n });\n this.session = new Session({\n client,\n routes: response.json.routes,\n session: response.json.session,\n });\n if (this.onResume && response.json.resumed) {\n await this.onResume(this);\n }\n }\n\n /**\n * Poll until the current session reaches a terminal state, then resume.\n */\n private async waitForStopAndResume(signal?: AbortSignal): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n const pollingInterval = 500;\n let status = this.session!.status;\n\n while (status === \"stopping\" || status === \"snapshotting\") {\n await setTimeout(pollingInterval, undefined, { signal });\n const poll = await client.getSession({\n sessionId: this.session!.sessionId,\n signal,\n });\n this.session = new Session({\n client,\n routes: poll.json.routes,\n session: poll.json.session,\n });\n status = poll.json.session.status;\n }\n await this.resume(signal);\n }\n\n /**\n * Execute `fn`, and if the session is stopped/stopping/snapshotting, resume and retry.\n */\n private async withResume<T>(\n fn: () => Promise<T>,\n signal?: AbortSignal,\n ): Promise<T> {\n if (!this.session) {\n await this.resume(signal);\n }\n try {\n return await fn();\n } catch (err) {\n if (isSandboxStoppedError(err)) {\n await this.resume(signal);\n return fn();\n }\n if (isSandboxStoppingError(err) || isSandboxSnapshottingError(err)) {\n await this.waitForStopAndResume(signal);\n return fn();\n }\n throw err;\n }\n }\n\n /**\n * Start executing a command in this sandbox.\n *\n * @param command - The command to execute.\n * @param args - Arguments to pass to the command.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the command execution.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n async runCommand(\n command: string,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<CommandFinished>;\n /**\n * Start executing a command in detached mode.\n *\n * @param params - The command parameters.\n * @returns A {@link Command} instance for the running command.\n */\n async runCommand(\n params: RunCommandParams & { detached: true },\n ): Promise<Command>;\n\n /**\n * Start executing a command in this sandbox.\n *\n * @param params - The command parameters.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n\n async runCommand(params: RunCommandParams): Promise<CommandFinished>;\n\n async runCommand(\n commandOrParams: string | RunCommandParams,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<Command | CommandFinished> {\n \"use step\";\n const signal =\n typeof commandOrParams === \"string\"\n ? opts?.signal\n : commandOrParams.signal;\n return this.withResume(\n () => this.session!.runCommand(commandOrParams as any, args, opts),\n signal,\n );\n }\n\n /**\n * Internal helper to start a command in the sandbox.\n *\n * @param params - Command execution parameters.\n * @returns A {@link Command} or {@link CommandFinished}, depending on `detached`.\n * @internal\n */\n async getCommand(\n cmdId: string,\n opts?: { signal?: AbortSignal },\n ): Promise<Command> {\n \"use step\";\n return this.withResume(\n () => this.session!.getCommand(cmdId, opts),\n opts?.signal,\n );\n }\n\n /**\n * Create a directory in the filesystem of this sandbox.\n *\n * @param path - Path of the directory to create\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n */\n async mkDir(path: string, opts?: { signal?: AbortSignal }): Promise<void> {\n \"use step\";\n return this.withResume(\n () => this.session!.mkDir(path, opts),\n opts?.signal,\n );\n }\n\n /**\n * Read a file from the filesystem of this sandbox as a stream.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to a ReadableStream containing the file contents, or null if file not found\n */\n async readFile(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<NodeJS.ReadableStream | null> {\n \"use step\";\n return this.withResume(\n () => this.session!.readFile(file, opts),\n opts?.signal,\n );\n }\n\n /**\n * Read a file from the filesystem of this sandbox as a Buffer.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the file contents as a Buffer, or null if file not found\n */\n async readFileToBuffer(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<Buffer | null> {\n \"use step\";\n return this.withResume(\n () => this.session!.readFileToBuffer(file, opts),\n opts?.signal,\n );\n }\n\n /**\n * Download a file from the sandbox to the local filesystem.\n *\n * @param src - Source file on the sandbox, with path and optional cwd\n * @param dst - Destination file on the local machine, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.mkdirRecursive - If true, create parent directories for the destination if they don't exist.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The absolute path to the written file, or null if the source file was not found\n */\n async downloadFile(\n src: { path: string; cwd?: string },\n dst: { path: string; cwd?: string },\n opts?: { mkdirRecursive?: boolean; signal?: AbortSignal },\n ): Promise<string | null> {\n \"use step\";\n return this.withResume(\n () => this.session!.downloadFile(src, dst, opts),\n opts?.signal,\n );\n }\n\n /**\n * Write files to the filesystem of this sandbox.\n * Defaults to writing to /vercel/sandbox unless an absolute path is specified.\n * Writes files using the `vercel-sandbox` user.\n *\n * @param files - Array of files with path, content, and optional mode (permissions)\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the files are written\n *\n * @example\n * // Write an executable script\n * await sandbox.writeFiles([\n * { path: \"/usr/local/bin/myscript\", content: \"#!/bin/bash\\necho hello\", mode: 0o755 }\n * ]);\n */\n async writeFiles(\n files: {\n path: string;\n content: string | Uint8Array;\n mode?: number;\n }[],\n opts?: { signal?: AbortSignal },\n ) {\n \"use step\";\n return this.withResume(\n () => this.session!.writeFiles(files, opts),\n opts?.signal,\n );\n }\n\n /**\n * Get the public domain of a port of this sandbox.\n *\n * @param p - Port number to resolve\n * @returns A full domain (e.g. `https://subdomain.vercel.run`)\n * @throws If the port has no associated route\n */\n domain(p: number): string {\n return this.currentSession().domain(p);\n }\n\n /**\n * Stop the sandbox.\n *\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The final session state after stopping, with optional snapshot metadata.\n */\n async stop(opts?: {\n signal?: AbortSignal;\n }): Promise<SandboxSnapshot & { snapshot?: SnapshotMetadata }> {\n \"use step\";\n if (!this.session) {\n throw new Error(\"No active session to stop.\");\n }\n const { session, sandbox, snapshot } = await this.session.stop(opts);\n if (sandbox) {\n this.sandbox = sandbox;\n }\n return Object.assign(session, { snapshot });\n }\n\n /**\n * Update the network policy for this sandbox.\n *\n * @deprecated Use {@link Sandbox.update} instead.\n *\n * @param networkPolicy - The new network policy to apply.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the network policy is updated.\n *\n * @example\n * // Restrict to specific domains\n * await sandbox.updateNetworkPolicy({\n * allow: [\"*.npmjs.org\", \"github.com\"],\n * });\n *\n * @example\n * // Inject credentials with per-domain transformers\n * await sandbox.updateNetworkPolicy({\n * allow: {\n * \"ai-gateway.vercel.sh\": [{\n * transform: [{\n * headers: { authorization: \"Bearer ...\" }\n * }]\n * }],\n * \"*\": []\n * }\n * });\n *\n * @example\n * // Deny all network access\n * await sandbox.updateNetworkPolicy(\"deny-all\");\n */\n async updateNetworkPolicy(\n networkPolicy: NetworkPolicy,\n opts?: { signal?: AbortSignal },\n ): Promise<NetworkPolicy> {\n \"use step\";\n await this.withResume(\n () => this.session!.update({ networkPolicy: networkPolicy }, opts),\n opts?.signal,\n );\n\n return this.session!.networkPolicy!;\n }\n\n /**\n * Extend the timeout of the sandbox by the specified duration.\n *\n * This allows you to extend the lifetime of a sandbox up until the maximum\n * execution timeout for your plan.\n *\n * @param duration - The duration in milliseconds to extend the timeout by\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the timeout is extended\n *\n * @example\n * const sandbox = await Sandbox.create({ timeout: ms('10m') });\n * // Extends timeout by 5 minutes, to a total of 15 minutes.\n * await sandbox.extendTimeout(ms('5m'));\n */\n async extendTimeout(\n duration: number,\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n return this.withResume(\n () => this.session!.extendTimeout(duration, opts),\n opts?.signal,\n );\n }\n\n /**\n * Create a snapshot from this currently running sandbox. New sandboxes can\n * then be created from this snapshot using {@link Sandbox.createFromSnapshot}.\n *\n * Note: this sandbox will be stopped as part of the snapshot creation process.\n *\n * @param opts - Optional parameters.\n * @param opts.expiration - Optional expiration time in milliseconds. Use 0 for no expiration at all.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the Snapshot instance\n */\n async snapshot(opts?: {\n expiration?: number;\n signal?: AbortSignal;\n }): Promise<Snapshot> {\n \"use step\";\n return this.withResume(\n () => this.session!.snapshot(opts),\n opts?.signal,\n );\n }\n\n /**\n * Update the sandbox configuration.\n *\n * When `ports` is provided, it is treated as the full desired port list:\n * any currently exposed port omitted from the array will be deregistered.\n *\n * @param params - Fields to update.\n * @param opts - Optional abort signal.\n */\n async update(\n params: {\n persistent?: boolean;\n resources?: { vcpus?: number };\n timeout?: number;\n networkPolicy?: NetworkPolicy;\n tags?: Record<string, string>;\n ports?: number[];\n snapshotExpiration?: number;\n currentSnapshotId?: string;\n },\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n let resources: { vcpus: number; memory: number } | undefined;\n if (params.resources?.vcpus) {\n resources = {\n vcpus: params.resources.vcpus,\n memory: params.resources.vcpus * 2048,\n };\n }\n\n // Update the sandbox config. This config will be used on the next session.\n const response = await client.updateSandbox({\n name: this.sandbox.name,\n projectId: this.projectId,\n persistent: params.persistent,\n resources,\n timeout: params.timeout,\n networkPolicy: params.networkPolicy,\n tags: params.tags,\n ports: params.ports,\n snapshotExpiration: params.snapshotExpiration,\n currentSnapshotId: params.currentSnapshotId,\n signal: opts?.signal,\n });\n this.sandbox = response.json.sandbox;\n if (params.ports !== undefined && response.json.routes) {\n this.session?.updateRoutes(response.json.routes);\n }\n\n // Update the current session config. This only applies to network policy.\n if (params.networkPolicy) {\n try {\n return await this.session?.update(\n { networkPolicy: params.networkPolicy },\n opts,\n );\n } catch (err) {\n if (isSandboxStoppedError(err) || isSandboxStoppingError(err)) {\n return;\n }\n throw err;\n }\n }\n }\n\n /**\n * Delete this sandbox.\n *\n * After deletion the instance becomes inert — all further API calls will\n * throw immediately.\n */\n async delete(opts?: { signal?: AbortSignal }): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n await client.deleteSandbox({\n name: this.sandbox.name,\n projectId: this.projectId,\n signal: opts?.signal,\n });\n }\n\n /**\n * List sessions (VMs) that have been created for this sandbox.\n *\n * @param params - Optional pagination parameters.\n * @returns The list of sessions and pagination metadata.\n */\n async listSessions(params?: {\n limit?: number;\n cursor?: string;\n sortOrder?: \"asc\" | \"desc\";\n signal?: AbortSignal;\n }) {\n \"use step\";\n const client = await this.ensureClient();\n const fetchPage = async (cursor?: string) => {\n const response = await client.listSessions({\n projectId: this.projectId,\n name: this.sandbox.name,\n limit: params?.limit,\n cursor,\n sortOrder: params?.sortOrder,\n signal: params?.signal,\n });\n return response.json;\n };\n const firstPage = await fetchPage(params?.cursor);\n return attachPaginator(firstPage, {\n itemsKey: \"sessions\",\n fetchNext: fetchPage,\n signal: params?.signal,\n });\n }\n\n /**\n * List snapshots that belong to this sandbox.\n *\n * @param params - Optional pagination parameters.\n * @returns The list of snapshots and pagination metadata.\n */\n async listSnapshots(params?: {\n limit?: number;\n cursor?: string;\n sortOrder?: \"asc\" | \"desc\";\n signal?: AbortSignal;\n }) {\n \"use step\";\n const client = await this.ensureClient();\n const fetchPage = async (cursor?: string) => {\n const response = await client.listSnapshots({\n projectId: this.projectId,\n name: this.sandbox.name,\n limit: params?.limit,\n cursor,\n sortOrder: params?.sortOrder,\n signal: params?.signal,\n });\n return response.json;\n };\n const firstPage = await fetchPage(params?.cursor);\n return attachPaginator(firstPage, {\n itemsKey: \"snapshots\",\n fetchNext: fetchPage,\n signal: params?.signal,\n });\n }\n}\n\n/**\n * A {@link Sandbox} that can automatically be disposed using a `await using` statement.\n *\n * @example\n * {\n * await using const sandbox = await Sandbox.create();\n * }\n * // Sandbox is automatically stopped here\n */\nclass DisposableSandbox extends Sandbox implements AsyncDisposable {\n async [Symbol.asyncDispose]() {\n await this.stop();\n }\n}\n"],"mappings":";;;;;;;;;;;;;AAmLA,SAAS,sBAAsB,KAAuB;AACpD,QAAO,eAAe,YAAY,IAAI,SAAS,WAAW;;AAG5D,SAAS,gBAAgB,KAAuB;AAC9C,QAAO,eAAe,YAAY,IAAI,SAAS,WAAW;;AAG5D,SAAS,wBAAwB,KAAuB;AACtD,QACE,eAAe,YACf,IAAI,SAAS,WAAW,OACvB,IAAI,MAAc,OAAO,SAAS;;AAIvC,SAAS,uBAAuB,KAAuB;AACrD,QACE,eAAe,YACf,IAAI,SAAS,WAAW,OACvB,IAAI,MAAc,OAAO,SAAS;;AAIvC,SAAS,2BAA2B,KAAuB;AACzD,QACE,eAAe,YACf,IAAI,SAAS,WAAW,OACvB,IAAI,MAAc,OAAO,SAAS;;;;;;;AAyBvC,IAAa,UAAb,MAAa,QAAQ;;;;;CAuCnB,MAAc,eAAmC;AAC/C;AACA,MAAI,KAAK,QAAS,QAAO,KAAK;EAC9B,MAAM,cAAc,MAAM,gBAAgB;AAC1C,OAAK,UAAU,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACpB,CAAC;AACF,SAAO,KAAK;;;;;CAMd,IAAW,OAAe;AACxB,SAAO,KAAK,QAAQ;;;;;;CAOtB,IAAW,SAA6B;AACtC,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,aAAsB;AAC/B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAA6B;AACtC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,QAA4B;AACrC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAA6B;AACtC,SAAO,KAAK,QAAQ;;;CAItB,IAAW,UAA8B;AACvC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,mBAAuC;AAChD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,oBAAwC;AACjD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,2BAA+C;AACxD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,kBAAsC;AAC/C,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;CAMzC,IAAW,kBAAoC;AAC7C,SAAO,KAAK,QAAQ,kBAChB,IAAI,KAAK,KAAK,QAAQ,gBAAgB,GACtC;;;;;CAMN,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;CAMzC,IAAW,kBAAsC;AAC/C,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,SAAoC;AAC7C,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,UAA8B;AACvC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,OAA2C;AACpD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,gBAA2C;AACpD,SAAO,KAAK,QAAQ,gBAChB,qBAAqB,KAAK,QAAQ,cAAc,GAChD;;;;;CAMN,IAAW,mBAAuC;AAChD,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,oBAAwC;AACjD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,qBAAyC;AAClD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,mBAAuC;AAChD,SAAO,KAAK,gBAAgB,CAAC;;;;;CAM/B,IAAW,kBAEG;AACZ,SAAO,KAAK,gBAAgB,CAAC;;;;;;;;;;;;;;;;CAiB/B,aAAa,KACX,QAGA;AACA;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,QAAQ;GAChB,CAAC;EACF,MAAM,YAAY,OAAO,WAAoB;AAM3C,WALiB,MAAM,OAAO,cAAc;IAC1C,GAAG;IACH,GAAG;IACH,GAAI,WAAW,UAAa,EAAE,QAAQ;IACvC,CAAC,EACc;;AAGlB,SAAO,gBADW,MAAM,UAAU,QAAQ,OAAO,EACf;GAChC,UAAU;GACV,WAAW;GACX,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;CASJ,QAAQ,oBAAoB,UAAsC;AAChE,SAAO;GACL,UAAU,SAAS,SAAS;GAC5B,QAAQ,SAAS,SAAS,UAAU,EAAE;GACtC,iBAAiB,SAAS;GAC1B,WAAW,SAAS;GACrB;;;;;;;;;;;CAYH,QAAQ,sBAAsB,MAAkC;EAC9D,MAAM,UAAU,IAAI,QAAQ;GAC1B,SAAS,KAAK;GACd,QAAQ,KAAK;GACb,WAAW,KAAK;GACjB,CAAC;AACF,MAAI,KAAK,SACP,SAAQ,UAAU,IAAI,QAAQ;GAAE,QAAQ,KAAK;GAAQ,UAAU,KAAK;GAAU,CAAC;AAEjF,SAAO;;;;;;;;;;;;;;;;;;CAmBT,aAAa,OACX,QAIoC;AACpC;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,QAAQ;GAChB,CAAC;EAEF,MAAM,gBAAgB,iBAAiB,OAAO;EAC9C,MAAM,WAAW,MAAM,OAAO,cAAc;GAC1C,QAAQ,QAAQ;GAChB,WAAW,YAAY;GACvB,OAAO,QAAQ,SAAS,EAAE;GAC1B,SAAS,QAAQ;GACjB,WAAW,QAAQ;GACnB,SAAS,UAAU,aAAa,SAAS,QAAQ,UAAU;GAC3D,eAAe,QAAQ;GACvB,KAAK,QAAQ;GACb,MAAM,QAAQ;GACd,oBAAoB,QAAQ;GAC5B,QAAQ,QAAQ;GAChB,MAAM,QAAQ;GACd,YAAY,QAAQ;GACpB,GAAG;GACJ,CAAC;AAEF,SAAO,IAAI,kBAAkB;GAC3B;GACA,SAAS,SAAS,KAAK;GACvB,SAAS,SAAS,KAAK;GACvB,QAAQ,SAAS,KAAK;GACtB,WAAW,YAAY;GACvB,UAAU,QAAQ;GACnB,CAAC;;;;;;;;CASJ,aAAa,IACX,QAEkB;AAClB;EACA,MAAM,cAAc,MAAM,eAAe,OAAO;EAChD,MAAM,SAAS,IAAI,UAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACnB,OAAO,OAAO;GACf,CAAC;EAEF,MAAM,gBAAgB,iBAAiB,OAAO;EAC9C,MAAM,WAAW,MAAM,OAAO,WAAW;GACvC,MAAM,OAAO;GACb,WAAW,YAAY;GACvB,QAAQ,OAAO;GACf,QAAQ,OAAO;GACf,GAAG;GACJ,CAAC;EAEF,MAAM,UAAU,IAAI,QAAQ;GAC1B;GACA,SAAS,SAAS,KAAK;GACvB,SAAS,SAAS,KAAK;GACvB,QAAQ,SAAS,KAAK;GACtB,WAAW,YAAY;GACvB,UAAU,OAAO;GAClB,CAAC;AAEF,MAAI,SAAS,KAAK,WAAW,OAAO,SAClC,OAAM,OAAO,SAAS,QAAQ;AAGhC,SAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCT,aAAa,YACX,QAIkB;AAClB;AAEA,MAAI,CAAC,QAAQ,MAAM;GACjB,MAAM,UAAU,MAAM,QAAQ,OAAO,OAAO;AAC5C,OAAI,QAAQ,SACV,OAAM,OAAO,SAAS,QAAQ;AAEhC,UAAO;;AAGT,MAAI;AACF,UAAO,MAAM,QAAQ,IACnB,OACD;WACM,KAAK;AACZ,OAAI,gBAAgB,IAAI,EAAE;IAExB,MAAM,UAAU,MAAM,QAAQ,OAAO,OAAO;AAC5C,QAAI,OAAO,SACT,OAAM,OAAO,SAAS,QAAQ;AAEhC,WAAO;;AAGT,OAAI,wBAAwB,IAAI,EAAE;IAGhC,MAAM,cAAc,MAAM,eAAe,OAAO;IAChD,MAAM,SAAS,IAAI,UAAU;KAC3B,QAAQ,YAAY;KACpB,OAAO,YAAY;KACnB,OAAO,OAAO;KACf,CAAC;IACF,MAAM,gBAAgB,iBAAiB,OAAO;AAC9C,QAAI;AACF,WAAM,OAAO,cAAc;MACzB,MAAM,OAAO;MACb,WAAW,YAAY;MACvB,QAAQ,OAAO;MACf,GAAG;MACJ,CAAC;aACK,WAAW;AAGlB,SAAI,CAAC,gBAAgB,UAAU,CAC7B,OAAM;;IAIV,MAAM,UAAU,MAAM,QAAQ,OAAO,OAAO;AAC5C,QAAI,OAAO,SACT,OAAM,OAAO,SAAS,QAAQ;AAEhC,WAAO;;AAGT,SAAM;;;;;;;;;;CAWV,YAAY,EACV,QACA,QACA,SACA,SACA,WACA,YAQC;OAvgBK,UAA4B;OAM5B,gBAAsC;AAkgB5C,OAAK,UAAU,UAAU;AACzB,MAAI,QACF,MAAK,UAAU,IAAI,QAAQ;GAAU;GAAS;GAAQ;GAAS,CAAC;AAElE,OAAK,UAAU;AACf,OAAK,YAAY,aAAa;AAC9B,OAAK,WAAW;AAChB,OAAK,KAAK,IAAI,WAAW,KAAK;;;;;;;CAQhC,iBAA0B;AACxB,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,yDAAyD;AAE3E,SAAO,KAAK;;;;;CAMd,MAAc,OAAO,QAAqC;AACxD,MAAI,CAAC,KAAK,cACR,MAAK,gBAAgB,KAAK,SAAS,OAAO,CAAC,cAAc;AACvD,QAAK,gBAAgB;IACrB;AAEJ,SAAO,KAAK;;CAGd,MAAc,SAAS,QAAqC;EAC1D,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,WAAW,MAAM,OAAO,WAAW;GACvC,MAAM,KAAK,QAAQ;GACnB,WAAW,KAAK;GAChB,QAAQ;GACR;GACD,CAAC;AACF,OAAK,UAAU,IAAI,QAAQ;GACzB;GACA,QAAQ,SAAS,KAAK;GACtB,SAAS,SAAS,KAAK;GACxB,CAAC;AACF,MAAI,KAAK,YAAY,SAAS,KAAK,QACjC,OAAM,KAAK,SAAS,KAAK;;;;;CAO7B,MAAc,qBAAqB,QAAqC;AACtE;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,kBAAkB;EACxB,IAAI,SAAS,KAAK,QAAS;AAE3B,SAAO,WAAW,cAAc,WAAW,gBAAgB;AACzD,SAAM,WAAW,iBAAiB,QAAW,EAAE,QAAQ,CAAC;GACxD,MAAM,OAAO,MAAM,OAAO,WAAW;IACnC,WAAW,KAAK,QAAS;IACzB;IACD,CAAC;AACF,QAAK,UAAU,IAAI,QAAQ;IACzB;IACA,QAAQ,KAAK,KAAK;IAClB,SAAS,KAAK,KAAK;IACpB,CAAC;AACF,YAAS,KAAK,KAAK,QAAQ;;AAE7B,QAAM,KAAK,OAAO,OAAO;;;;;CAM3B,MAAc,WACZ,IACA,QACY;AACZ,MAAI,CAAC,KAAK,QACR,OAAM,KAAK,OAAO,OAAO;AAE3B,MAAI;AACF,UAAO,MAAM,IAAI;WACV,KAAK;AACZ,OAAI,sBAAsB,IAAI,EAAE;AAC9B,UAAM,KAAK,OAAO,OAAO;AACzB,WAAO,IAAI;;AAEb,OAAI,uBAAuB,IAAI,IAAI,2BAA2B,IAAI,EAAE;AAClE,UAAM,KAAK,qBAAqB,OAAO;AACvC,WAAO,IAAI;;AAEb,SAAM;;;CAqCV,MAAM,WACJ,iBACA,MACA,MACoC;AACpC;EACA,MAAM,SACJ,OAAO,oBAAoB,WACvB,MAAM,SACN,gBAAgB;AACtB,SAAO,KAAK,iBACJ,KAAK,QAAS,WAAW,iBAAwB,MAAM,KAAK,EAClE,OACD;;;;;;;;;CAUH,MAAM,WACJ,OACA,MACkB;AAClB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,WAAW,OAAO,KAAK,EAC3C,MAAM,OACP;;;;;;;;;CAUH,MAAM,MAAM,MAAc,MAAgD;AACxE;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,MAAM,MAAM,KAAK,EACrC,MAAM,OACP;;;;;;;;;;CAWH,MAAM,SACJ,MACA,MACuC;AACvC;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,SAAS,MAAM,KAAK,EACxC,MAAM,OACP;;;;;;;;;;CAWH,MAAM,iBACJ,MACA,MACwB;AACxB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,iBAAiB,MAAM,KAAK,EAChD,MAAM,OACP;;;;;;;;;;;;CAaH,MAAM,aACJ,KACA,KACA,MACwB;AACxB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,aAAa,KAAK,KAAK,KAAK,EAChD,MAAM,OACP;;;;;;;;;;;;;;;;;;CAmBH,MAAM,WACJ,OAKA,MACA;AACA;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,WAAW,OAAO,KAAK,EAC3C,MAAM,OACP;;;;;;;;;CAUH,OAAO,GAAmB;AACxB,SAAO,KAAK,gBAAgB,CAAC,OAAO,EAAE;;;;;;;;;CAUxC,MAAM,KAAK,MAEoD;AAC7D;AACA,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,6BAA6B;EAE/C,MAAM,EAAE,SAAS,SAAS,aAAa,MAAM,KAAK,QAAQ,KAAK,KAAK;AACpE,MAAI,QACF,MAAK,UAAU;AAEjB,SAAO,OAAO,OAAO,SAAS,EAAE,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC7C,MAAM,oBACJ,eACA,MACwB;AACxB;AACA,QAAM,KAAK,iBACH,KAAK,QAAS,OAAO,EAAiB,eAAe,EAAE,KAAK,EAClE,MAAM,OACP;AAED,SAAO,KAAK,QAAS;;;;;;;;;;;;;;;;;;CAmBvB,MAAM,cACJ,UACA,MACe;AACf;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,cAAc,UAAU,KAAK,EACjD,MAAM,OACP;;;;;;;;;;;;;CAcH,MAAM,SAAS,MAGO;AACpB;AACA,SAAO,KAAK,iBACJ,KAAK,QAAS,SAAS,KAAK,EAClC,MAAM,OACP;;;;;;;;;;;CAYH,MAAM,OACJ,QAUA,MACe;AACf;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,IAAIA;AACJ,MAAI,OAAO,WAAW,MACpB,aAAY;GACV,OAAO,OAAO,UAAU;GACxB,QAAQ,OAAO,UAAU,QAAQ;GAClC;EAIH,MAAM,WAAW,MAAM,OAAO,cAAc;GAC1C,MAAM,KAAK,QAAQ;GACnB,WAAW,KAAK;GAChB,YAAY,OAAO;GACnB;GACA,SAAS,OAAO;GAChB,eAAe,OAAO;GACtB,MAAM,OAAO;GACb,OAAO,OAAO;GACd,oBAAoB,OAAO;GAC3B,mBAAmB,OAAO;GAC1B,QAAQ,MAAM;GACf,CAAC;AACF,OAAK,UAAU,SAAS,KAAK;AAC7B,MAAI,OAAO,UAAU,UAAa,SAAS,KAAK,OAC9C,MAAK,SAAS,aAAa,SAAS,KAAK,OAAO;AAIlD,MAAI,OAAO,cACT,KAAI;AACF,UAAO,MAAM,KAAK,SAAS,OACzB,EAAE,eAAe,OAAO,eAAe,EACvC,KACD;WACM,KAAK;AACZ,OAAI,sBAAsB,IAAI,IAAI,uBAAuB,IAAI,CAC3D;AAEF,SAAM;;;;;;;;;CAWZ,MAAM,OAAO,MAAgD;AAC3D;AAEA,SADe,MAAM,KAAK,cAAc,EAC3B,cAAc;GACzB,MAAM,KAAK,QAAQ;GACnB,WAAW,KAAK;GAChB,QAAQ,MAAM;GACf,CAAC;;;;;;;;CASJ,MAAM,aAAa,QAKhB;AACD;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,YAAY,OAAO,WAAoB;AAS3C,WARiB,MAAM,OAAO,aAAa;IACzC,WAAW,KAAK;IAChB,MAAM,KAAK,QAAQ;IACnB,OAAO,QAAQ;IACf;IACA,WAAW,QAAQ;IACnB,QAAQ,QAAQ;IACjB,CAAC,EACc;;AAGlB,SAAO,gBADW,MAAM,UAAU,QAAQ,OAAO,EACf;GAChC,UAAU;GACV,WAAW;GACX,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;CASJ,MAAM,cAAc,QAKjB;AACD;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,YAAY,OAAO,WAAoB;AAS3C,WARiB,MAAM,OAAO,cAAc;IAC1C,WAAW,KAAK;IAChB,MAAM,KAAK,QAAQ;IACnB,OAAO,QAAQ;IACf;IACA,WAAW,QAAQ;IACnB,QAAQ,QAAQ;IACjB,CAAC,EACc;;AAGlB,SAAO,gBADW,MAAM,UAAU,QAAQ,OAAO,EACf;GAChC,UAAU;GACV,WAAW;GACX,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;;;;;AAaN,IAAM,oBAAN,cAAgC,QAAmC;CACjE,OAAO,OAAO,gBAAgB;AAC5B,QAAM,KAAK,MAAM"}
package/dist/session.cjs CHANGED
@@ -204,6 +204,10 @@ var Session = class Session {
204
204
  this.session = require_sandbox_snapshot.toSandboxSnapshot(params.session);
205
205
  }
206
206
  }
207
+ /** @internal */
208
+ updateRoutes(routes) {
209
+ this.routes = routes;
210
+ }
207
211
  /**
208
212
  * Get a previously run command by its ID.
209
213
  *
@@ -1 +1 @@
1
- {"version":3,"file":"session.cjs","names":["getCredentials","APIClient","WORKFLOW_SERIALIZE","WORKFLOW_DESERIALIZE","toSandboxSnapshot","Command","params: RunCommandParams","command","CommandFinished","path","consumeReadable","Snapshot"],"sources":["../src/session.ts"],"sourcesContent":["import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from \"@workflow/serde\";\nimport { type SessionMetaData, type SandboxRouteData, type SandboxMetaData, type SnapshotMetadata, APIClient } from \"./api-client/index.js\";\nimport type { Writable } from \"stream\";\nimport { pipeline } from \"stream/promises\";\nimport { createWriteStream } from \"fs\";\nimport { mkdir } from \"fs/promises\";\nimport { dirname, resolve } from \"path\";\nimport { Command, CommandFinished } from \"./command.js\";\nimport { Snapshot } from \"./snapshot.js\";\nimport { consumeReadable } from \"./utils/consume-readable.js\";\nimport type {\n NetworkPolicy,\n NetworkPolicyRule,\n NetworkTransformer,\n} from \"./network-policy.js\";\nimport { toSandboxSnapshot, type SandboxSnapshot } from \"./utils/sandbox-snapshot.js\";\nimport { getCredentials } from \"./utils/get-credentials.js\";\n\nexport type { NetworkPolicy, NetworkPolicyRule, NetworkTransformer };\n\n/**\n * Serialized representation of a Session for @workflow/serde.\n */\nexport interface SerializedSession {\n session: SandboxSnapshot;\n routes: SandboxRouteData[];\n}\n\n/** @inline */\nexport interface RunCommandParams {\n /**\n * The command to execute\n */\n cmd: string;\n /**\n * Arguments to pass to the command\n */\n args?: string[];\n /**\n * Working directory to execute the command in\n */\n cwd?: string;\n /**\n * Environment variables to set for this command\n */\n env?: Record<string, string>;\n /**\n * If true, execute this command with root privileges. Defaults to false.\n */\n sudo?: boolean;\n /**\n * If true, the command will return without waiting for `exitCode`\n */\n detached?: boolean;\n /**\n * A `Writable` stream where `stdout` from the command will be piped\n */\n stdout?: Writable;\n /**\n * A `Writable` stream where `stderr` from the command will be piped\n */\n stderr?: Writable;\n /**\n * An AbortSignal to cancel the command execution\n */\n signal?: AbortSignal;\n}\n\n/**\n * A Session represents a running VM instance within a {@link Sandbox}.\n *\n * Obtain a session via {@link Sandbox.currentSession}.\n */\nexport class Session {\n private _client: APIClient | null = null;\n\n /**\n * Lazily resolve credentials and construct an API client.\n * This is used in step contexts where the Sandbox was deserialized\n * without a client (e.g. when crossing workflow/step boundaries).\n * Uses getCredentials() which resolves from OIDC or env vars.\n * @internal\n */\n private async ensureClient(): Promise<APIClient> {\n \"use step\";\n if (this._client) return this._client;\n const credentials = await getCredentials();\n this._client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n });\n return this._client;\n }\n\n /**\n * Routes from ports to subdomains.\n * @hidden\n */\n public readonly routes: SandboxRouteData[];\n\n /**\n * Internal metadata about the current session.\n */\n private session: SandboxSnapshot;\n\n private get client(): APIClient {\n if (!this._client) throw new Error(\"API client not initialized\");\n return this._client;\n }\n\n /** @internal */\n get _sessionSnapshot(): SandboxSnapshot {\n return this.session;\n }\n\n /**\n * Unique ID of this session.\n */\n public get sessionId(): string {\n return this.session.id;\n }\n\n public get interactivePort(): number | undefined {\n return this.session.interactivePort ?? undefined;\n }\n\n /**\n * The status of this session.\n */\n public get status(): SessionMetaData[\"status\"] {\n return this.session.status;\n }\n\n /**\n * The creation date of this session.\n */\n public get createdAt(): Date {\n return new Date(this.session.createdAt);\n }\n\n /**\n * The timeout of this session in milliseconds.\n */\n public get timeout(): number {\n return this.session.timeout;\n }\n\n /**\n * The network policy of this session.\n */\n public get networkPolicy(): NetworkPolicy | undefined {\n return this.session.networkPolicy;\n }\n\n /**\n * If the session was created from a snapshot, the ID of that snapshot.\n */\n public get sourceSnapshotId(): string | undefined {\n return this.session.sourceSnapshotId;\n }\n\n /**\n * Memory allocated to this session in MB.\n */\n public get memory(): number {\n return this.session.memory;\n }\n\n /**\n * Number of vCPUs allocated to this session.\n */\n public get vcpus(): number {\n return this.session.vcpus;\n }\n\n /**\n * The region where this session is hosted.\n */\n public get region(): string {\n return this.session.region;\n }\n\n /**\n * Runtime identifier (e.g. \"node24\", \"python3.13\").\n */\n public get runtime(): string {\n return this.session.runtime;\n }\n\n /**\n * The working directory of this session.\n */\n public get cwd(): string {\n return this.session.cwd;\n }\n\n /**\n * When this session was requested.\n */\n public get requestedAt(): Date {\n return new Date(this.session.requestedAt);\n }\n\n /**\n * When this session started running.\n */\n public get startedAt(): Date | undefined {\n return this.session.startedAt != null\n ? new Date(this.session.startedAt)\n : undefined;\n }\n\n /**\n * When this session was requested to stop.\n */\n public get requestedStopAt(): Date | undefined {\n return this.session.requestedStopAt != null\n ? new Date(this.session.requestedStopAt)\n : undefined;\n }\n\n /**\n * When this session was stopped.\n */\n public get stoppedAt(): Date | undefined {\n return this.session.stoppedAt != null\n ? new Date(this.session.stoppedAt)\n : undefined;\n }\n\n /**\n * When this session was aborted.\n */\n public get abortedAt(): Date | undefined {\n return this.session.abortedAt != null\n ? new Date(this.session.abortedAt)\n : undefined;\n }\n\n /**\n * The wall-clock duration of this session in milliseconds.\n */\n public get duration(): number | undefined {\n return this.session.duration;\n }\n\n /**\n * When a snapshot was requested for this session.\n */\n public get snapshottedAt(): Date | undefined {\n return this.session.snapshottedAt != null\n ? new Date(this.session.snapshottedAt)\n : undefined;\n }\n\n /**\n * When this session was last updated.\n */\n public get updatedAt(): Date {\n return new Date(this.session.updatedAt);\n }\n\n /**\n * The amount of active CPU used by the session. Only reported once the VM is\n * stopped.\n */\n public get activeCpuUsageMs(): number | undefined {\n return this.session.activeCpuDurationMs;\n }\n\n /**\n * The amount of network data used by the session. Only reported once the VM\n * is stopped.\n */\n public get networkTransfer():\n | { ingress: number; egress: number }\n | undefined {\n return this.session.networkTransfer;\n }\n\n /**\n * Serialize a Session instance to plain data for @workflow/serde.\n *\n * Although Sandbox handles top-level serialization, Session needs these\n * methods so the Workflow SWC compiler can resolve the class by name.\n * The `new Session(...)` self-reference in WORKFLOW_DESERIALIZE forces\n * rolldown to preserve the class name in the compiled output.\n */\n static [WORKFLOW_SERIALIZE](instance: Session): SerializedSession {\n return {\n session: instance.session,\n routes: instance.routes,\n };\n }\n\n static [WORKFLOW_DESERIALIZE](data: SerializedSession): Session {\n return new Session({ routes: data.routes, snapshot: data.session });\n }\n\n constructor(params: {\n client: APIClient;\n routes: SandboxRouteData[];\n session: SessionMetaData;\n } | {\n /** @internal – used during deserialization with an already-converted snapshot */\n routes: SandboxRouteData[];\n snapshot: SandboxSnapshot;\n }) {\n this.routes = params.routes;\n if (\"snapshot\" in params) {\n this.session = params.snapshot;\n } else {\n this._client = params.client;\n this.session = toSandboxSnapshot(params.session);\n }\n }\n\n /**\n * Get a previously run command by its ID.\n *\n * @param cmdId - ID of the command to retrieve\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A {@link Command} instance representing the command\n */\n async getCommand(\n cmdId: string,\n opts?: { signal?: AbortSignal },\n ): Promise<Command> {\n \"use step\";\n const client = await this.ensureClient();\n const command = await client.getCommand({\n sessionId: this.session.id,\n cmdId,\n signal: opts?.signal,\n });\n\n return new Command({\n client,\n sessionId: this.session.id,\n cmd: command.json.command,\n });\n }\n\n /**\n * Start executing a command in this session.\n *\n * @param command - The command to execute.\n * @param args - Arguments to pass to the command.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the command execution.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n async runCommand(\n command: string,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<CommandFinished>;\n\n /**\n * Start executing a command in detached mode.\n *\n * @param params - The command parameters.\n * @returns A {@link Command} instance for the running command.\n */\n async runCommand(\n params: RunCommandParams & { detached: true },\n ): Promise<Command>;\n\n /**\n * Start executing a command in this session.\n *\n * @param params - The command parameters.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n async runCommand(params: RunCommandParams): Promise<CommandFinished>;\n\n async runCommand(\n commandOrParams: string | RunCommandParams,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<Command | CommandFinished> {\n \"use step\";\n const client = await this.ensureClient();\n const params: RunCommandParams =\n typeof commandOrParams === \"string\"\n ? { cmd: commandOrParams, args, signal: opts?.signal }\n : commandOrParams;\n const wait = params.detached ? false : true;\n const pipeLogs = async (command: Command): Promise<void> => {\n if (!params.stdout && !params.stderr) {\n return;\n }\n\n try {\n for await (const log of command.logs({ signal: params.signal })) {\n if (log.stream === \"stdout\") {\n params.stdout?.write(log.data);\n } else if (log.stream === \"stderr\") {\n params.stderr?.write(log.data);\n }\n }\n } catch (err) {\n if (params.signal?.aborted) {\n return;\n }\n throw err;\n }\n };\n\n if (wait) {\n const commandStream = await client.runCommand({\n sessionId: this.session.id,\n command: params.cmd,\n args: params.args ?? [],\n cwd: params.cwd,\n env: params.env ?? {},\n sudo: params.sudo ?? false,\n wait: true,\n signal: params.signal,\n });\n\n const command = new Command({\n client,\n sessionId: this.session.id,\n cmd: commandStream.command,\n });\n\n const [finished] = await Promise.all([\n commandStream.finished,\n pipeLogs(command),\n ]);\n return new CommandFinished({\n client,\n sessionId: this.session.id,\n cmd: finished,\n exitCode: finished.exitCode ?? 0,\n });\n }\n\n const commandResponse = await client.runCommand({\n sessionId: this.session.id,\n command: params.cmd,\n args: params.args ?? [],\n cwd: params.cwd,\n env: params.env ?? {},\n sudo: params.sudo ?? false,\n signal: params.signal,\n });\n\n const command = new Command({\n client,\n sessionId: this.session.id,\n cmd: commandResponse.json.command,\n });\n\n void pipeLogs(command).catch((err) => {\n if (params.signal?.aborted) {\n return;\n }\n (params.stderr ?? params.stdout)?.emit(\"error\", err);\n });\n\n return command;\n }\n\n /**\n * Create a directory in the filesystem of this session.\n *\n * @param path - Path of the directory to create\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n */\n async mkDir(path: string, opts?: { signal?: AbortSignal }): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n await client.mkDir({\n sessionId: this.session.id,\n path: path,\n signal: opts?.signal,\n });\n }\n\n /**\n * Read a file from the filesystem of this session as a stream.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to a ReadableStream containing the file contents, or null if file not found\n */\n async readFile(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<NodeJS.ReadableStream | null> {\n \"use step\";\n const client = await this.ensureClient();\n return client.readFile({\n sessionId: this.session.id,\n path: file.path,\n cwd: file.cwd,\n signal: opts?.signal,\n });\n }\n\n /**\n * Read a file from the filesystem of this session as a Buffer.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the file contents as a Buffer, or null if file not found\n */\n async readFileToBuffer(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<Buffer | null> {\n \"use step\";\n const client = await this.ensureClient();\n const stream = await client.readFile({\n sessionId: this.session.id,\n path: file.path,\n cwd: file.cwd,\n signal: opts?.signal,\n });\n\n if (stream === null) {\n return null;\n }\n\n return consumeReadable(stream);\n }\n\n /**\n * Download a file from the session to the local filesystem.\n *\n * @param src - Source file on the session, with path and optional cwd\n * @param dst - Destination file on the local machine, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.mkdirRecursive - If true, create parent directories for the destination if they don't exist.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The absolute path to the written file, or null if the source file was not found\n */\n async downloadFile(\n src: { path: string; cwd?: string },\n dst: { path: string; cwd?: string },\n opts?: { mkdirRecursive?: boolean; signal?: AbortSignal },\n ): Promise<string | null> {\n \"use step\";\n const client = await this.ensureClient();\n if (!src?.path) {\n throw new Error(\"downloadFile: source path is required\");\n }\n\n if (!dst?.path) {\n throw new Error(\"downloadFile: destination path is required\");\n }\n\n const stream = await client.readFile({\n sessionId: this.session.id,\n path: src.path,\n cwd: src.cwd,\n signal: opts?.signal,\n });\n\n if (stream === null) {\n return null;\n }\n\n try {\n const dstPath = resolve(dst.cwd ?? \"\", dst.path);\n if (opts?.mkdirRecursive) {\n await mkdir(dirname(dstPath), { recursive: true });\n }\n await pipeline(stream, createWriteStream(dstPath), {\n signal: opts?.signal,\n });\n return dstPath;\n } finally {\n stream.destroy();\n }\n }\n\n /**\n * Write files to the filesystem of this session.\n * Defaults to writing to /vercel/sandbox unless an absolute path is specified.\n * Writes files using the `vercel-sandbox` user.\n *\n * @param files - Array of files with path and stream/buffer contents\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the files are written\n */\n async writeFiles(\n files: { path: string; content: string | Uint8Array; mode?: number }[],\n opts?: { signal?: AbortSignal },\n ) {\n \"use step\";\n const client = await this.ensureClient();\n return client.writeFiles({\n sessionId: this.session.id,\n cwd: this.session.cwd,\n extractDir: \"/\",\n files: files,\n signal: opts?.signal,\n });\n }\n\n /**\n * Get the public domain of a port of this session.\n *\n * @param p - Port number to resolve\n * @returns A full domain (e.g. `https://subdomain.vercel.run`)\n * @throws If the port has no associated route\n */\n domain(p: number): string {\n const route = this.routes.find(({ port }) => port == p);\n if (route) {\n return `https://${route.subdomain}.vercel.run`;\n } else {\n throw new Error(`No route for port ${p}`);\n }\n }\n\n /**\n * Stop this session.\n *\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The final session state and optional sandbox metadata.\n */\n async stop(opts?: {\n signal?: AbortSignal;\n }): Promise<{ session: SandboxSnapshot; sandbox?: SandboxMetaData; snapshot?: SnapshotMetadata }> {\n \"use step\";\n const client = await this.ensureClient();\n const response = await client.stopSession({\n sessionId: this.session.id,\n signal: opts?.signal,\n });\n this.session = toSandboxSnapshot(response.json.session);\n return { session: this.session, sandbox: response.json.sandbox, snapshot: response.json.snapshot };\n }\n\n /**\n * Update the current session's settings.\n *\n * @param params - Fields to update.\n * @param params.networkPolicy - The new network policy to apply.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n *\n * @example\n * // Restrict to specific domains\n * await session.update({\n * networkPolicy: {\n * allow: [\"*.npmjs.org\", \"github.com\"],\n * }\n * });\n *\n * @example\n * // Inject credentials with per-domain transformers\n * await session.update({\n * networkPolicy: {\n * allow: {\n * \"ai-gateway.vercel.sh\": [{\n * transform: [{\n * headers: { authorization: \"Bearer ...\" }\n * }]\n * }],\n * \"*\": []\n * }\n * }\n * });\n *\n * @example\n * // Deny all network access\n * await session.update({ networkPolicy: \"deny-all\" });\n */\n async update(\n params: {\n networkPolicy?: NetworkPolicy;\n },\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n if (params.networkPolicy !== undefined) {\n const client = await this.ensureClient();\n const response = await client.updateNetworkPolicy({\n sessionId: this.session.id,\n networkPolicy: params.networkPolicy,\n signal: opts?.signal,\n });\n\n // Update the internal session with the new network policy\n this.session = toSandboxSnapshot(response.json.session);\n }\n }\n\n /**\n * Extend the timeout of the session by the specified duration.\n *\n * This allows you to extend the lifetime of a session up until the maximum\n * execution timeout for your plan.\n *\n * @param duration - The duration in milliseconds to extend the timeout by\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the timeout is extended\n *\n * @example\n * const sandbox = await Sandbox.create({ timeout: ms('10m') });\n * const session = sandbox.currentSession();\n * // Extends timeout by 5 minutes, to a total of 15 minutes.\n * await session.extendTimeout(ms('5m'));\n */\n async extendTimeout(\n duration: number,\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n const response = await client.extendTimeout({\n sessionId: this.session.id,\n duration,\n signal: opts?.signal,\n });\n\n // Update the internal sandbox metadata with the new timeout value\n this.session = toSandboxSnapshot(response.json.session);\n }\n\n /**\n * Create a snapshot from this currently running session. New sandboxes can\n * then be created from this snapshot using {@link Sandbox.create}.\n *\n * Note: this session will be stopped as part of the snapshot creation process.\n *\n * @param opts - Optional parameters.\n * @param opts.expiration - Optional expiration time in milliseconds. Use 0 for no expiration at all.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the Snapshot instance\n */\n async snapshot(opts?: {\n expiration?: number;\n signal?: AbortSignal;\n }): Promise<Snapshot> {\n \"use step\";\n const client = await this.ensureClient();\n const response = await client.createSnapshot({\n sessionId: this.session.id,\n expiration: opts?.expiration,\n signal: opts?.signal,\n });\n\n this.session = toSandboxSnapshot(response.json.session);\n\n return new Snapshot({\n client,\n snapshot: response.json.snapshot,\n });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAyEA,IAAa,UAAb,MAAa,QAAQ;;;;;;;;CAUnB,MAAc,eAAmC;AAC/C;AACA,MAAI,KAAK,QAAS,QAAO,KAAK;EAC9B,MAAM,cAAc,MAAMA,wCAAgB;AAC1C,OAAK,UAAU,IAAIC,6BAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACpB,CAAC;AACF,SAAO,KAAK;;CAcd,IAAY,SAAoB;AAC9B,MAAI,CAAC,KAAK,QAAS,OAAM,IAAI,MAAM,6BAA6B;AAChE,SAAO,KAAK;;;CAId,IAAI,mBAAoC;AACtC,SAAO,KAAK;;;;;CAMd,IAAW,YAAoB;AAC7B,SAAO,KAAK,QAAQ;;CAGtB,IAAW,kBAAsC;AAC/C,SAAO,KAAK,QAAQ,mBAAmB;;;;;CAMzC,IAAW,SAAoC;AAC7C,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;CAMzC,IAAW,UAAkB;AAC3B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,gBAA2C;AACpD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,mBAAuC;AAChD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAAiB;AAC1B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,QAAgB;AACzB,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAAiB;AAC1B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,UAAkB;AAC3B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,MAAc;AACvB,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,cAAoB;AAC7B,SAAO,IAAI,KAAK,KAAK,QAAQ,YAAY;;;;;CAM3C,IAAW,YAA8B;AACvC,SAAO,KAAK,QAAQ,aAAa,OAC7B,IAAI,KAAK,KAAK,QAAQ,UAAU,GAChC;;;;;CAMN,IAAW,kBAAoC;AAC7C,SAAO,KAAK,QAAQ,mBAAmB,OACnC,IAAI,KAAK,KAAK,QAAQ,gBAAgB,GACtC;;;;;CAMN,IAAW,YAA8B;AACvC,SAAO,KAAK,QAAQ,aAAa,OAC7B,IAAI,KAAK,KAAK,QAAQ,UAAU,GAChC;;;;;CAMN,IAAW,YAA8B;AACvC,SAAO,KAAK,QAAQ,aAAa,OAC7B,IAAI,KAAK,KAAK,QAAQ,UAAU,GAChC;;;;;CAMN,IAAW,WAA+B;AACxC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,gBAAkC;AAC3C,SAAO,KAAK,QAAQ,iBAAiB,OACjC,IAAI,KAAK,KAAK,QAAQ,cAAc,GACpC;;;;;CAMN,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;;CAOzC,IAAW,mBAAuC;AAChD,SAAO,KAAK,QAAQ;;;;;;CAOtB,IAAW,kBAEG;AACZ,SAAO,KAAK,QAAQ;;;;;;;;;;CAWtB,QAAQC,qCAAoB,UAAsC;AAChE,SAAO;GACL,SAAS,SAAS;GAClB,QAAQ,SAAS;GAClB;;CAGH,QAAQC,uCAAsB,MAAkC;AAC9D,SAAO,IAAI,QAAQ;GAAE,QAAQ,KAAK;GAAQ,UAAU,KAAK;GAAS,CAAC;;CAGrE,YAAY,QAQT;OAzOK,UAA4B;AA0OlC,OAAK,SAAS,OAAO;AACrB,MAAI,cAAc,OAChB,MAAK,UAAU,OAAO;OACjB;AACL,QAAK,UAAU,OAAO;AACtB,QAAK,UAAUC,2CAAkB,OAAO,QAAQ;;;;;;;;;;;CAYpD,MAAM,WACJ,OACA,MACkB;AAClB;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,UAAU,MAAM,OAAO,WAAW;GACtC,WAAW,KAAK,QAAQ;GACxB;GACA,QAAQ,MAAM;GACf,CAAC;AAEF,SAAO,IAAIC,wBAAQ;GACjB;GACA,WAAW,KAAK,QAAQ;GACxB,KAAK,QAAQ,KAAK;GACnB,CAAC;;CAoCJ,MAAM,WACJ,iBACA,MACA,MACoC;AACpC;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAMC,SACJ,OAAO,oBAAoB,WACvB;GAAE,KAAK;GAAiB;GAAM,QAAQ,MAAM;GAAQ,GACpD;EACN,MAAM,OAAO,OAAO,WAAW,QAAQ;EACvC,MAAM,WAAW,OAAO,cAAoC;AAC1D,OAAI,CAAC,OAAO,UAAU,CAAC,OAAO,OAC5B;AAGF,OAAI;AACF,eAAW,MAAM,OAAOC,UAAQ,KAAK,EAAE,QAAQ,OAAO,QAAQ,CAAC,CAC7D,KAAI,IAAI,WAAW,SACjB,QAAO,QAAQ,MAAM,IAAI,KAAK;aACrB,IAAI,WAAW,SACxB,QAAO,QAAQ,MAAM,IAAI,KAAK;YAG3B,KAAK;AACZ,QAAI,OAAO,QAAQ,QACjB;AAEF,UAAM;;;AAIV,MAAI,MAAM;GACR,MAAM,gBAAgB,MAAM,OAAO,WAAW;IAC5C,WAAW,KAAK,QAAQ;IACxB,SAAS,OAAO;IAChB,MAAM,OAAO,QAAQ,EAAE;IACvB,KAAK,OAAO;IACZ,KAAK,OAAO,OAAO,EAAE;IACrB,MAAM,OAAO,QAAQ;IACrB,MAAM;IACN,QAAQ,OAAO;IAChB,CAAC;GAEF,MAAMA,YAAU,IAAIF,wBAAQ;IAC1B;IACA,WAAW,KAAK,QAAQ;IACxB,KAAK,cAAc;IACpB,CAAC;GAEF,MAAM,CAAC,YAAY,MAAM,QAAQ,IAAI,CACnC,cAAc,UACd,SAASE,UAAQ,CAClB,CAAC;AACF,UAAO,IAAIC,gCAAgB;IACzB;IACA,WAAW,KAAK,QAAQ;IACxB,KAAK;IACL,UAAU,SAAS,YAAY;IAChC,CAAC;;EAGJ,MAAM,kBAAkB,MAAM,OAAO,WAAW;GAC9C,WAAW,KAAK,QAAQ;GACxB,SAAS,OAAO;GAChB,MAAM,OAAO,QAAQ,EAAE;GACvB,KAAK,OAAO;GACZ,KAAK,OAAO,OAAO,EAAE;GACrB,MAAM,OAAO,QAAQ;GACrB,QAAQ,OAAO;GAChB,CAAC;EAEF,MAAM,UAAU,IAAIH,wBAAQ;GAC1B;GACA,WAAW,KAAK,QAAQ;GACxB,KAAK,gBAAgB,KAAK;GAC3B,CAAC;AAEF,EAAK,SAAS,QAAQ,CAAC,OAAO,QAAQ;AACpC,OAAI,OAAO,QAAQ,QACjB;AAEF,IAAC,OAAO,UAAU,OAAO,SAAS,KAAK,SAAS,IAAI;IACpD;AAEF,SAAO;;;;;;;;;CAUT,MAAM,MAAM,QAAc,MAAgD;AACxE;AAEA,SADe,MAAM,KAAK,cAAc,EAC3B,MAAM;GACjB,WAAW,KAAK,QAAQ;GACxB,MAAMI;GACN,QAAQ,MAAM;GACf,CAAC;;;;;;;;;;CAWJ,MAAM,SACJ,MACA,MACuC;AACvC;AAEA,UADe,MAAM,KAAK,cAAc,EAC1B,SAAS;GACrB,WAAW,KAAK,QAAQ;GACxB,MAAM,KAAK;GACX,KAAK,KAAK;GACV,QAAQ,MAAM;GACf,CAAC;;;;;;;;;;CAWJ,MAAM,iBACJ,MACA,MACwB;AACxB;EAEA,MAAM,SAAS,OADA,MAAM,KAAK,cAAc,EACZ,SAAS;GACnC,WAAW,KAAK,QAAQ;GACxB,MAAM,KAAK;GACX,KAAK,KAAK;GACV,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,WAAW,KACb,QAAO;AAGT,SAAOC,yCAAgB,OAAO;;;;;;;;;;;;CAahC,MAAM,aACJ,KACA,KACA,MACwB;AACxB;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;AACxC,MAAI,CAAC,KAAK,KACR,OAAM,IAAI,MAAM,wCAAwC;AAG1D,MAAI,CAAC,KAAK,KACR,OAAM,IAAI,MAAM,6CAA6C;EAG/D,MAAM,SAAS,MAAM,OAAO,SAAS;GACnC,WAAW,KAAK,QAAQ;GACxB,MAAM,IAAI;GACV,KAAK,IAAI;GACT,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,WAAW,KACb,QAAO;AAGT,MAAI;GACF,MAAM,4BAAkB,IAAI,OAAO,IAAI,IAAI,KAAK;AAChD,OAAI,MAAM,eACR,gDAAoB,QAAQ,EAAE,EAAE,WAAW,MAAM,CAAC;AAEpD,uCAAe,kCAA0B,QAAQ,EAAE,EACjD,QAAQ,MAAM,QACf,CAAC;AACF,UAAO;YACC;AACR,UAAO,SAAS;;;;;;;;;;;;;CAcpB,MAAM,WACJ,OACA,MACA;AACA;AAEA,UADe,MAAM,KAAK,cAAc,EAC1B,WAAW;GACvB,WAAW,KAAK,QAAQ;GACxB,KAAK,KAAK,QAAQ;GAClB,YAAY;GACL;GACP,QAAQ,MAAM;GACf,CAAC;;;;;;;;;CAUJ,OAAO,GAAmB;EACxB,MAAM,QAAQ,KAAK,OAAO,MAAM,EAAE,WAAW,QAAQ,EAAE;AACvD,MAAI,MACF,QAAO,WAAW,MAAM,UAAU;MAElC,OAAM,IAAI,MAAM,qBAAqB,IAAI;;;;;;;;;CAW7C,MAAM,KAAK,MAEuF;AAChG;EAEA,MAAM,WAAW,OADF,MAAM,KAAK,cAAc,EACV,YAAY;GACxC,WAAW,KAAK,QAAQ;GACxB,QAAQ,MAAM;GACf,CAAC;AACF,OAAK,UAAUN,2CAAkB,SAAS,KAAK,QAAQ;AACvD,SAAO;GAAE,SAAS,KAAK;GAAS,SAAS,SAAS,KAAK;GAAS,UAAU,SAAS,KAAK;GAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsCpG,MAAM,OACJ,QAGA,MACe;AACf;AACA,MAAI,OAAO,kBAAkB,OAS3B,MAAK,UAAUA,4CAPE,OADF,MAAM,KAAK,cAAc,EACV,oBAAoB;GAChD,WAAW,KAAK,QAAQ;GACxB,eAAe,OAAO;GACtB,QAAQ,MAAM;GACf,CAAC,EAGwC,KAAK,QAAQ;;;;;;;;;;;;;;;;;;;CAqB3D,MAAM,cACJ,UACA,MACe;AACf;AASA,OAAK,UAAUA,4CAPE,OADF,MAAM,KAAK,cAAc,EACV,cAAc;GAC1C,WAAW,KAAK,QAAQ;GACxB;GACA,QAAQ,MAAM;GACf,CAAC,EAGwC,KAAK,QAAQ;;;;;;;;;;;;;CAczD,MAAM,SAAS,MAGO;AACpB;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,WAAW,MAAM,OAAO,eAAe;GAC3C,WAAW,KAAK,QAAQ;GACxB,YAAY,MAAM;GAClB,QAAQ,MAAM;GACf,CAAC;AAEF,OAAK,UAAUA,2CAAkB,SAAS,KAAK,QAAQ;AAEvD,SAAO,IAAIO,0BAAS;GAClB;GACA,UAAU,SAAS,KAAK;GACzB,CAAC"}
1
+ {"version":3,"file":"session.cjs","names":["getCredentials","APIClient","WORKFLOW_SERIALIZE","WORKFLOW_DESERIALIZE","toSandboxSnapshot","Command","params: RunCommandParams","command","CommandFinished","path","consumeReadable","Snapshot"],"sources":["../src/session.ts"],"sourcesContent":["import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from \"@workflow/serde\";\nimport { type SessionMetaData, type SandboxRouteData, type SandboxMetaData, type SnapshotMetadata, APIClient } from \"./api-client/index.js\";\nimport type { Writable } from \"stream\";\nimport { pipeline } from \"stream/promises\";\nimport { createWriteStream } from \"fs\";\nimport { mkdir } from \"fs/promises\";\nimport { dirname, resolve } from \"path\";\nimport { Command, CommandFinished } from \"./command.js\";\nimport { Snapshot } from \"./snapshot.js\";\nimport { consumeReadable } from \"./utils/consume-readable.js\";\nimport type {\n NetworkPolicy,\n NetworkPolicyRule,\n NetworkTransformer,\n} from \"./network-policy.js\";\nimport { toSandboxSnapshot, type SandboxSnapshot } from \"./utils/sandbox-snapshot.js\";\nimport { getCredentials } from \"./utils/get-credentials.js\";\n\nexport type { NetworkPolicy, NetworkPolicyRule, NetworkTransformer };\n\n/**\n * Serialized representation of a Session for @workflow/serde.\n */\nexport interface SerializedSession {\n session: SandboxSnapshot;\n routes: SandboxRouteData[];\n}\n\n/** @inline */\nexport interface RunCommandParams {\n /**\n * The command to execute\n */\n cmd: string;\n /**\n * Arguments to pass to the command\n */\n args?: string[];\n /**\n * Working directory to execute the command in\n */\n cwd?: string;\n /**\n * Environment variables to set for this command\n */\n env?: Record<string, string>;\n /**\n * If true, execute this command with root privileges. Defaults to false.\n */\n sudo?: boolean;\n /**\n * If true, the command will return without waiting for `exitCode`\n */\n detached?: boolean;\n /**\n * A `Writable` stream where `stdout` from the command will be piped\n */\n stdout?: Writable;\n /**\n * A `Writable` stream where `stderr` from the command will be piped\n */\n stderr?: Writable;\n /**\n * An AbortSignal to cancel the command execution\n */\n signal?: AbortSignal;\n}\n\n/**\n * A Session represents a running VM instance within a {@link Sandbox}.\n *\n * Obtain a session via {@link Sandbox.currentSession}.\n */\nexport class Session {\n private _client: APIClient | null = null;\n\n /**\n * Lazily resolve credentials and construct an API client.\n * This is used in step contexts where the Sandbox was deserialized\n * without a client (e.g. when crossing workflow/step boundaries).\n * Uses getCredentials() which resolves from OIDC or env vars.\n * @internal\n */\n private async ensureClient(): Promise<APIClient> {\n \"use step\";\n if (this._client) return this._client;\n const credentials = await getCredentials();\n this._client = new APIClient({\n teamId: credentials.teamId,\n token: credentials.token,\n });\n return this._client;\n }\n\n /**\n * Routes from ports to subdomains.\n * @hidden\n */\n public readonly routes: SandboxRouteData[];\n\n /**\n * Internal metadata about the current session.\n */\n private session: SandboxSnapshot;\n\n private get client(): APIClient {\n if (!this._client) throw new Error(\"API client not initialized\");\n return this._client;\n }\n\n /** @internal */\n get _sessionSnapshot(): SandboxSnapshot {\n return this.session;\n }\n\n /**\n * Unique ID of this session.\n */\n public get sessionId(): string {\n return this.session.id;\n }\n\n public get interactivePort(): number | undefined {\n return this.session.interactivePort ?? undefined;\n }\n\n /**\n * The status of this session.\n */\n public get status(): SessionMetaData[\"status\"] {\n return this.session.status;\n }\n\n /**\n * The creation date of this session.\n */\n public get createdAt(): Date {\n return new Date(this.session.createdAt);\n }\n\n /**\n * The timeout of this session in milliseconds.\n */\n public get timeout(): number {\n return this.session.timeout;\n }\n\n /**\n * The network policy of this session.\n */\n public get networkPolicy(): NetworkPolicy | undefined {\n return this.session.networkPolicy;\n }\n\n /**\n * If the session was created from a snapshot, the ID of that snapshot.\n */\n public get sourceSnapshotId(): string | undefined {\n return this.session.sourceSnapshotId;\n }\n\n /**\n * Memory allocated to this session in MB.\n */\n public get memory(): number {\n return this.session.memory;\n }\n\n /**\n * Number of vCPUs allocated to this session.\n */\n public get vcpus(): number {\n return this.session.vcpus;\n }\n\n /**\n * The region where this session is hosted.\n */\n public get region(): string {\n return this.session.region;\n }\n\n /**\n * Runtime identifier (e.g. \"node24\", \"python3.13\").\n */\n public get runtime(): string {\n return this.session.runtime;\n }\n\n /**\n * The working directory of this session.\n */\n public get cwd(): string {\n return this.session.cwd;\n }\n\n /**\n * When this session was requested.\n */\n public get requestedAt(): Date {\n return new Date(this.session.requestedAt);\n }\n\n /**\n * When this session started running.\n */\n public get startedAt(): Date | undefined {\n return this.session.startedAt != null\n ? new Date(this.session.startedAt)\n : undefined;\n }\n\n /**\n * When this session was requested to stop.\n */\n public get requestedStopAt(): Date | undefined {\n return this.session.requestedStopAt != null\n ? new Date(this.session.requestedStopAt)\n : undefined;\n }\n\n /**\n * When this session was stopped.\n */\n public get stoppedAt(): Date | undefined {\n return this.session.stoppedAt != null\n ? new Date(this.session.stoppedAt)\n : undefined;\n }\n\n /**\n * When this session was aborted.\n */\n public get abortedAt(): Date | undefined {\n return this.session.abortedAt != null\n ? new Date(this.session.abortedAt)\n : undefined;\n }\n\n /**\n * The wall-clock duration of this session in milliseconds.\n */\n public get duration(): number | undefined {\n return this.session.duration;\n }\n\n /**\n * When a snapshot was requested for this session.\n */\n public get snapshottedAt(): Date | undefined {\n return this.session.snapshottedAt != null\n ? new Date(this.session.snapshottedAt)\n : undefined;\n }\n\n /**\n * When this session was last updated.\n */\n public get updatedAt(): Date {\n return new Date(this.session.updatedAt);\n }\n\n /**\n * The amount of active CPU used by the session. Only reported once the VM is\n * stopped.\n */\n public get activeCpuUsageMs(): number | undefined {\n return this.session.activeCpuDurationMs;\n }\n\n /**\n * The amount of network data used by the session. Only reported once the VM\n * is stopped.\n */\n public get networkTransfer():\n | { ingress: number; egress: number }\n | undefined {\n return this.session.networkTransfer;\n }\n\n /**\n * Serialize a Session instance to plain data for @workflow/serde.\n *\n * Although Sandbox handles top-level serialization, Session needs these\n * methods so the Workflow SWC compiler can resolve the class by name.\n * The `new Session(...)` self-reference in WORKFLOW_DESERIALIZE forces\n * rolldown to preserve the class name in the compiled output.\n */\n static [WORKFLOW_SERIALIZE](instance: Session): SerializedSession {\n return {\n session: instance.session,\n routes: instance.routes,\n };\n }\n\n static [WORKFLOW_DESERIALIZE](data: SerializedSession): Session {\n return new Session({ routes: data.routes, snapshot: data.session });\n }\n\n constructor(params: {\n client: APIClient;\n routes: SandboxRouteData[];\n session: SessionMetaData;\n } | {\n /** @internal – used during deserialization with an already-converted snapshot */\n routes: SandboxRouteData[];\n snapshot: SandboxSnapshot;\n }) {\n this.routes = params.routes;\n if (\"snapshot\" in params) {\n this.session = params.snapshot;\n } else {\n this._client = params.client;\n this.session = toSandboxSnapshot(params.session);\n }\n }\n\n /** @internal */\n updateRoutes(routes: SandboxRouteData[]): void {\n (this as { routes: SandboxRouteData[] }).routes = routes;\n }\n\n /**\n * Get a previously run command by its ID.\n *\n * @param cmdId - ID of the command to retrieve\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A {@link Command} instance representing the command\n */\n async getCommand(\n cmdId: string,\n opts?: { signal?: AbortSignal },\n ): Promise<Command> {\n \"use step\";\n const client = await this.ensureClient();\n const command = await client.getCommand({\n sessionId: this.session.id,\n cmdId,\n signal: opts?.signal,\n });\n\n return new Command({\n client,\n sessionId: this.session.id,\n cmd: command.json.command,\n });\n }\n\n /**\n * Start executing a command in this session.\n *\n * @param command - The command to execute.\n * @param args - Arguments to pass to the command.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the command execution.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n async runCommand(\n command: string,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<CommandFinished>;\n\n /**\n * Start executing a command in detached mode.\n *\n * @param params - The command parameters.\n * @returns A {@link Command} instance for the running command.\n */\n async runCommand(\n params: RunCommandParams & { detached: true },\n ): Promise<Command>;\n\n /**\n * Start executing a command in this session.\n *\n * @param params - The command parameters.\n * @returns A {@link CommandFinished} result once execution is done.\n */\n async runCommand(params: RunCommandParams): Promise<CommandFinished>;\n\n async runCommand(\n commandOrParams: string | RunCommandParams,\n args?: string[],\n opts?: { signal?: AbortSignal },\n ): Promise<Command | CommandFinished> {\n \"use step\";\n const client = await this.ensureClient();\n const params: RunCommandParams =\n typeof commandOrParams === \"string\"\n ? { cmd: commandOrParams, args, signal: opts?.signal }\n : commandOrParams;\n const wait = params.detached ? false : true;\n const pipeLogs = async (command: Command): Promise<void> => {\n if (!params.stdout && !params.stderr) {\n return;\n }\n\n try {\n for await (const log of command.logs({ signal: params.signal })) {\n if (log.stream === \"stdout\") {\n params.stdout?.write(log.data);\n } else if (log.stream === \"stderr\") {\n params.stderr?.write(log.data);\n }\n }\n } catch (err) {\n if (params.signal?.aborted) {\n return;\n }\n throw err;\n }\n };\n\n if (wait) {\n const commandStream = await client.runCommand({\n sessionId: this.session.id,\n command: params.cmd,\n args: params.args ?? [],\n cwd: params.cwd,\n env: params.env ?? {},\n sudo: params.sudo ?? false,\n wait: true,\n signal: params.signal,\n });\n\n const command = new Command({\n client,\n sessionId: this.session.id,\n cmd: commandStream.command,\n });\n\n const [finished] = await Promise.all([\n commandStream.finished,\n pipeLogs(command),\n ]);\n return new CommandFinished({\n client,\n sessionId: this.session.id,\n cmd: finished,\n exitCode: finished.exitCode ?? 0,\n });\n }\n\n const commandResponse = await client.runCommand({\n sessionId: this.session.id,\n command: params.cmd,\n args: params.args ?? [],\n cwd: params.cwd,\n env: params.env ?? {},\n sudo: params.sudo ?? false,\n signal: params.signal,\n });\n\n const command = new Command({\n client,\n sessionId: this.session.id,\n cmd: commandResponse.json.command,\n });\n\n void pipeLogs(command).catch((err) => {\n if (params.signal?.aborted) {\n return;\n }\n (params.stderr ?? params.stdout)?.emit(\"error\", err);\n });\n\n return command;\n }\n\n /**\n * Create a directory in the filesystem of this session.\n *\n * @param path - Path of the directory to create\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n */\n async mkDir(path: string, opts?: { signal?: AbortSignal }): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n await client.mkDir({\n sessionId: this.session.id,\n path: path,\n signal: opts?.signal,\n });\n }\n\n /**\n * Read a file from the filesystem of this session as a stream.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to a ReadableStream containing the file contents, or null if file not found\n */\n async readFile(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<NodeJS.ReadableStream | null> {\n \"use step\";\n const client = await this.ensureClient();\n return client.readFile({\n sessionId: this.session.id,\n path: file.path,\n cwd: file.cwd,\n signal: opts?.signal,\n });\n }\n\n /**\n * Read a file from the filesystem of this session as a Buffer.\n *\n * @param file - File to read, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the file contents as a Buffer, or null if file not found\n */\n async readFileToBuffer(\n file: { path: string; cwd?: string },\n opts?: { signal?: AbortSignal },\n ): Promise<Buffer | null> {\n \"use step\";\n const client = await this.ensureClient();\n const stream = await client.readFile({\n sessionId: this.session.id,\n path: file.path,\n cwd: file.cwd,\n signal: opts?.signal,\n });\n\n if (stream === null) {\n return null;\n }\n\n return consumeReadable(stream);\n }\n\n /**\n * Download a file from the session to the local filesystem.\n *\n * @param src - Source file on the session, with path and optional cwd\n * @param dst - Destination file on the local machine, with path and optional cwd\n * @param opts - Optional parameters.\n * @param opts.mkdirRecursive - If true, create parent directories for the destination if they don't exist.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The absolute path to the written file, or null if the source file was not found\n */\n async downloadFile(\n src: { path: string; cwd?: string },\n dst: { path: string; cwd?: string },\n opts?: { mkdirRecursive?: boolean; signal?: AbortSignal },\n ): Promise<string | null> {\n \"use step\";\n const client = await this.ensureClient();\n if (!src?.path) {\n throw new Error(\"downloadFile: source path is required\");\n }\n\n if (!dst?.path) {\n throw new Error(\"downloadFile: destination path is required\");\n }\n\n const stream = await client.readFile({\n sessionId: this.session.id,\n path: src.path,\n cwd: src.cwd,\n signal: opts?.signal,\n });\n\n if (stream === null) {\n return null;\n }\n\n try {\n const dstPath = resolve(dst.cwd ?? \"\", dst.path);\n if (opts?.mkdirRecursive) {\n await mkdir(dirname(dstPath), { recursive: true });\n }\n await pipeline(stream, createWriteStream(dstPath), {\n signal: opts?.signal,\n });\n return dstPath;\n } finally {\n stream.destroy();\n }\n }\n\n /**\n * Write files to the filesystem of this session.\n * Defaults to writing to /vercel/sandbox unless an absolute path is specified.\n * Writes files using the `vercel-sandbox` user.\n *\n * @param files - Array of files with path and stream/buffer contents\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the files are written\n */\n async writeFiles(\n files: { path: string; content: string | Uint8Array; mode?: number }[],\n opts?: { signal?: AbortSignal },\n ) {\n \"use step\";\n const client = await this.ensureClient();\n return client.writeFiles({\n sessionId: this.session.id,\n cwd: this.session.cwd,\n extractDir: \"/\",\n files: files,\n signal: opts?.signal,\n });\n }\n\n /**\n * Get the public domain of a port of this session.\n *\n * @param p - Port number to resolve\n * @returns A full domain (e.g. `https://subdomain.vercel.run`)\n * @throws If the port has no associated route\n */\n domain(p: number): string {\n const route = this.routes.find(({ port }) => port == p);\n if (route) {\n return `https://${route.subdomain}.vercel.run`;\n } else {\n throw new Error(`No route for port ${p}`);\n }\n }\n\n /**\n * Stop this session.\n *\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns The final session state and optional sandbox metadata.\n */\n async stop(opts?: {\n signal?: AbortSignal;\n }): Promise<{ session: SandboxSnapshot; sandbox?: SandboxMetaData; snapshot?: SnapshotMetadata }> {\n \"use step\";\n const client = await this.ensureClient();\n const response = await client.stopSession({\n sessionId: this.session.id,\n signal: opts?.signal,\n });\n this.session = toSandboxSnapshot(response.json.session);\n return { session: this.session, sandbox: response.json.sandbox, snapshot: response.json.snapshot };\n }\n\n /**\n * Update the current session's settings.\n *\n * @param params - Fields to update.\n * @param params.networkPolicy - The new network policy to apply.\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n *\n * @example\n * // Restrict to specific domains\n * await session.update({\n * networkPolicy: {\n * allow: [\"*.npmjs.org\", \"github.com\"],\n * }\n * });\n *\n * @example\n * // Inject credentials with per-domain transformers\n * await session.update({\n * networkPolicy: {\n * allow: {\n * \"ai-gateway.vercel.sh\": [{\n * transform: [{\n * headers: { authorization: \"Bearer ...\" }\n * }]\n * }],\n * \"*\": []\n * }\n * }\n * });\n *\n * @example\n * // Deny all network access\n * await session.update({ networkPolicy: \"deny-all\" });\n */\n async update(\n params: {\n networkPolicy?: NetworkPolicy;\n },\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n if (params.networkPolicy !== undefined) {\n const client = await this.ensureClient();\n const response = await client.updateNetworkPolicy({\n sessionId: this.session.id,\n networkPolicy: params.networkPolicy,\n signal: opts?.signal,\n });\n\n // Update the internal session with the new network policy\n this.session = toSandboxSnapshot(response.json.session);\n }\n }\n\n /**\n * Extend the timeout of the session by the specified duration.\n *\n * This allows you to extend the lifetime of a session up until the maximum\n * execution timeout for your plan.\n *\n * @param duration - The duration in milliseconds to extend the timeout by\n * @param opts - Optional parameters.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves when the timeout is extended\n *\n * @example\n * const sandbox = await Sandbox.create({ timeout: ms('10m') });\n * const session = sandbox.currentSession();\n * // Extends timeout by 5 minutes, to a total of 15 minutes.\n * await session.extendTimeout(ms('5m'));\n */\n async extendTimeout(\n duration: number,\n opts?: { signal?: AbortSignal },\n ): Promise<void> {\n \"use step\";\n const client = await this.ensureClient();\n const response = await client.extendTimeout({\n sessionId: this.session.id,\n duration,\n signal: opts?.signal,\n });\n\n // Update the internal sandbox metadata with the new timeout value\n this.session = toSandboxSnapshot(response.json.session);\n }\n\n /**\n * Create a snapshot from this currently running session. New sandboxes can\n * then be created from this snapshot using {@link Sandbox.create}.\n *\n * Note: this session will be stopped as part of the snapshot creation process.\n *\n * @param opts - Optional parameters.\n * @param opts.expiration - Optional expiration time in milliseconds. Use 0 for no expiration at all.\n * @param opts.signal - An AbortSignal to cancel the operation.\n * @returns A promise that resolves to the Snapshot instance\n */\n async snapshot(opts?: {\n expiration?: number;\n signal?: AbortSignal;\n }): Promise<Snapshot> {\n \"use step\";\n const client = await this.ensureClient();\n const response = await client.createSnapshot({\n sessionId: this.session.id,\n expiration: opts?.expiration,\n signal: opts?.signal,\n });\n\n this.session = toSandboxSnapshot(response.json.session);\n\n return new Snapshot({\n client,\n snapshot: response.json.snapshot,\n });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAyEA,IAAa,UAAb,MAAa,QAAQ;;;;;;;;CAUnB,MAAc,eAAmC;AAC/C;AACA,MAAI,KAAK,QAAS,QAAO,KAAK;EAC9B,MAAM,cAAc,MAAMA,wCAAgB;AAC1C,OAAK,UAAU,IAAIC,6BAAU;GAC3B,QAAQ,YAAY;GACpB,OAAO,YAAY;GACpB,CAAC;AACF,SAAO,KAAK;;CAcd,IAAY,SAAoB;AAC9B,MAAI,CAAC,KAAK,QAAS,OAAM,IAAI,MAAM,6BAA6B;AAChE,SAAO,KAAK;;;CAId,IAAI,mBAAoC;AACtC,SAAO,KAAK;;;;;CAMd,IAAW,YAAoB;AAC7B,SAAO,KAAK,QAAQ;;CAGtB,IAAW,kBAAsC;AAC/C,SAAO,KAAK,QAAQ,mBAAmB;;;;;CAMzC,IAAW,SAAoC;AAC7C,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;CAMzC,IAAW,UAAkB;AAC3B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,gBAA2C;AACpD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,mBAAuC;AAChD,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAAiB;AAC1B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,QAAgB;AACzB,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,SAAiB;AAC1B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,UAAkB;AAC3B,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,MAAc;AACvB,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,cAAoB;AAC7B,SAAO,IAAI,KAAK,KAAK,QAAQ,YAAY;;;;;CAM3C,IAAW,YAA8B;AACvC,SAAO,KAAK,QAAQ,aAAa,OAC7B,IAAI,KAAK,KAAK,QAAQ,UAAU,GAChC;;;;;CAMN,IAAW,kBAAoC;AAC7C,SAAO,KAAK,QAAQ,mBAAmB,OACnC,IAAI,KAAK,KAAK,QAAQ,gBAAgB,GACtC;;;;;CAMN,IAAW,YAA8B;AACvC,SAAO,KAAK,QAAQ,aAAa,OAC7B,IAAI,KAAK,KAAK,QAAQ,UAAU,GAChC;;;;;CAMN,IAAW,YAA8B;AACvC,SAAO,KAAK,QAAQ,aAAa,OAC7B,IAAI,KAAK,KAAK,QAAQ,UAAU,GAChC;;;;;CAMN,IAAW,WAA+B;AACxC,SAAO,KAAK,QAAQ;;;;;CAMtB,IAAW,gBAAkC;AAC3C,SAAO,KAAK,QAAQ,iBAAiB,OACjC,IAAI,KAAK,KAAK,QAAQ,cAAc,GACpC;;;;;CAMN,IAAW,YAAkB;AAC3B,SAAO,IAAI,KAAK,KAAK,QAAQ,UAAU;;;;;;CAOzC,IAAW,mBAAuC;AAChD,SAAO,KAAK,QAAQ;;;;;;CAOtB,IAAW,kBAEG;AACZ,SAAO,KAAK,QAAQ;;;;;;;;;;CAWtB,QAAQC,qCAAoB,UAAsC;AAChE,SAAO;GACL,SAAS,SAAS;GAClB,QAAQ,SAAS;GAClB;;CAGH,QAAQC,uCAAsB,MAAkC;AAC9D,SAAO,IAAI,QAAQ;GAAE,QAAQ,KAAK;GAAQ,UAAU,KAAK;GAAS,CAAC;;CAGrE,YAAY,QAQT;OAzOK,UAA4B;AA0OlC,OAAK,SAAS,OAAO;AACrB,MAAI,cAAc,OAChB,MAAK,UAAU,OAAO;OACjB;AACL,QAAK,UAAU,OAAO;AACtB,QAAK,UAAUC,2CAAkB,OAAO,QAAQ;;;;CAKpD,aAAa,QAAkC;AAC7C,EAAC,KAAwC,SAAS;;;;;;;;;;CAWpD,MAAM,WACJ,OACA,MACkB;AAClB;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,UAAU,MAAM,OAAO,WAAW;GACtC,WAAW,KAAK,QAAQ;GACxB;GACA,QAAQ,MAAM;GACf,CAAC;AAEF,SAAO,IAAIC,wBAAQ;GACjB;GACA,WAAW,KAAK,QAAQ;GACxB,KAAK,QAAQ,KAAK;GACnB,CAAC;;CAoCJ,MAAM,WACJ,iBACA,MACA,MACoC;AACpC;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAMC,SACJ,OAAO,oBAAoB,WACvB;GAAE,KAAK;GAAiB;GAAM,QAAQ,MAAM;GAAQ,GACpD;EACN,MAAM,OAAO,OAAO,WAAW,QAAQ;EACvC,MAAM,WAAW,OAAO,cAAoC;AAC1D,OAAI,CAAC,OAAO,UAAU,CAAC,OAAO,OAC5B;AAGF,OAAI;AACF,eAAW,MAAM,OAAOC,UAAQ,KAAK,EAAE,QAAQ,OAAO,QAAQ,CAAC,CAC7D,KAAI,IAAI,WAAW,SACjB,QAAO,QAAQ,MAAM,IAAI,KAAK;aACrB,IAAI,WAAW,SACxB,QAAO,QAAQ,MAAM,IAAI,KAAK;YAG3B,KAAK;AACZ,QAAI,OAAO,QAAQ,QACjB;AAEF,UAAM;;;AAIV,MAAI,MAAM;GACR,MAAM,gBAAgB,MAAM,OAAO,WAAW;IAC5C,WAAW,KAAK,QAAQ;IACxB,SAAS,OAAO;IAChB,MAAM,OAAO,QAAQ,EAAE;IACvB,KAAK,OAAO;IACZ,KAAK,OAAO,OAAO,EAAE;IACrB,MAAM,OAAO,QAAQ;IACrB,MAAM;IACN,QAAQ,OAAO;IAChB,CAAC;GAEF,MAAMA,YAAU,IAAIF,wBAAQ;IAC1B;IACA,WAAW,KAAK,QAAQ;IACxB,KAAK,cAAc;IACpB,CAAC;GAEF,MAAM,CAAC,YAAY,MAAM,QAAQ,IAAI,CACnC,cAAc,UACd,SAASE,UAAQ,CAClB,CAAC;AACF,UAAO,IAAIC,gCAAgB;IACzB;IACA,WAAW,KAAK,QAAQ;IACxB,KAAK;IACL,UAAU,SAAS,YAAY;IAChC,CAAC;;EAGJ,MAAM,kBAAkB,MAAM,OAAO,WAAW;GAC9C,WAAW,KAAK,QAAQ;GACxB,SAAS,OAAO;GAChB,MAAM,OAAO,QAAQ,EAAE;GACvB,KAAK,OAAO;GACZ,KAAK,OAAO,OAAO,EAAE;GACrB,MAAM,OAAO,QAAQ;GACrB,QAAQ,OAAO;GAChB,CAAC;EAEF,MAAM,UAAU,IAAIH,wBAAQ;GAC1B;GACA,WAAW,KAAK,QAAQ;GACxB,KAAK,gBAAgB,KAAK;GAC3B,CAAC;AAEF,EAAK,SAAS,QAAQ,CAAC,OAAO,QAAQ;AACpC,OAAI,OAAO,QAAQ,QACjB;AAEF,IAAC,OAAO,UAAU,OAAO,SAAS,KAAK,SAAS,IAAI;IACpD;AAEF,SAAO;;;;;;;;;CAUT,MAAM,MAAM,QAAc,MAAgD;AACxE;AAEA,SADe,MAAM,KAAK,cAAc,EAC3B,MAAM;GACjB,WAAW,KAAK,QAAQ;GACxB,MAAMI;GACN,QAAQ,MAAM;GACf,CAAC;;;;;;;;;;CAWJ,MAAM,SACJ,MACA,MACuC;AACvC;AAEA,UADe,MAAM,KAAK,cAAc,EAC1B,SAAS;GACrB,WAAW,KAAK,QAAQ;GACxB,MAAM,KAAK;GACX,KAAK,KAAK;GACV,QAAQ,MAAM;GACf,CAAC;;;;;;;;;;CAWJ,MAAM,iBACJ,MACA,MACwB;AACxB;EAEA,MAAM,SAAS,OADA,MAAM,KAAK,cAAc,EACZ,SAAS;GACnC,WAAW,KAAK,QAAQ;GACxB,MAAM,KAAK;GACX,KAAK,KAAK;GACV,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,WAAW,KACb,QAAO;AAGT,SAAOC,yCAAgB,OAAO;;;;;;;;;;;;CAahC,MAAM,aACJ,KACA,KACA,MACwB;AACxB;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;AACxC,MAAI,CAAC,KAAK,KACR,OAAM,IAAI,MAAM,wCAAwC;AAG1D,MAAI,CAAC,KAAK,KACR,OAAM,IAAI,MAAM,6CAA6C;EAG/D,MAAM,SAAS,MAAM,OAAO,SAAS;GACnC,WAAW,KAAK,QAAQ;GACxB,MAAM,IAAI;GACV,KAAK,IAAI;GACT,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,WAAW,KACb,QAAO;AAGT,MAAI;GACF,MAAM,4BAAkB,IAAI,OAAO,IAAI,IAAI,KAAK;AAChD,OAAI,MAAM,eACR,gDAAoB,QAAQ,EAAE,EAAE,WAAW,MAAM,CAAC;AAEpD,uCAAe,kCAA0B,QAAQ,EAAE,EACjD,QAAQ,MAAM,QACf,CAAC;AACF,UAAO;YACC;AACR,UAAO,SAAS;;;;;;;;;;;;;CAcpB,MAAM,WACJ,OACA,MACA;AACA;AAEA,UADe,MAAM,KAAK,cAAc,EAC1B,WAAW;GACvB,WAAW,KAAK,QAAQ;GACxB,KAAK,KAAK,QAAQ;GAClB,YAAY;GACL;GACP,QAAQ,MAAM;GACf,CAAC;;;;;;;;;CAUJ,OAAO,GAAmB;EACxB,MAAM,QAAQ,KAAK,OAAO,MAAM,EAAE,WAAW,QAAQ,EAAE;AACvD,MAAI,MACF,QAAO,WAAW,MAAM,UAAU;MAElC,OAAM,IAAI,MAAM,qBAAqB,IAAI;;;;;;;;;CAW7C,MAAM,KAAK,MAEuF;AAChG;EAEA,MAAM,WAAW,OADF,MAAM,KAAK,cAAc,EACV,YAAY;GACxC,WAAW,KAAK,QAAQ;GACxB,QAAQ,MAAM;GACf,CAAC;AACF,OAAK,UAAUN,2CAAkB,SAAS,KAAK,QAAQ;AACvD,SAAO;GAAE,SAAS,KAAK;GAAS,SAAS,SAAS,KAAK;GAAS,UAAU,SAAS,KAAK;GAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsCpG,MAAM,OACJ,QAGA,MACe;AACf;AACA,MAAI,OAAO,kBAAkB,OAS3B,MAAK,UAAUA,4CAPE,OADF,MAAM,KAAK,cAAc,EACV,oBAAoB;GAChD,WAAW,KAAK,QAAQ;GACxB,eAAe,OAAO;GACtB,QAAQ,MAAM;GACf,CAAC,EAGwC,KAAK,QAAQ;;;;;;;;;;;;;;;;;;;CAqB3D,MAAM,cACJ,UACA,MACe;AACf;AASA,OAAK,UAAUA,4CAPE,OADF,MAAM,KAAK,cAAc,EACV,cAAc;GAC1C,WAAW,KAAK,QAAQ;GACxB;GACA,QAAQ,MAAM;GACf,CAAC,EAGwC,KAAK,QAAQ;;;;;;;;;;;;;CAczD,MAAM,SAAS,MAGO;AACpB;EACA,MAAM,SAAS,MAAM,KAAK,cAAc;EACxC,MAAM,WAAW,MAAM,OAAO,eAAe;GAC3C,WAAW,KAAK,QAAQ;GACxB,YAAY,MAAM;GAClB,QAAQ,MAAM;GACf,CAAC;AAEF,OAAK,UAAUA,2CAAkB,SAAS,KAAK,QAAQ;AAEvD,SAAO,IAAIO,0BAAS;GAClB;GACA,UAAU,SAAS,KAAK;GACzB,CAAC"}
@@ -191,6 +191,8 @@ declare class Session {
191
191
  routes: SandboxRouteData[];
192
192
  snapshot: SandboxSnapshot;
193
193
  });
194
+ /** @internal */
195
+ updateRoutes(routes: SandboxRouteData[]): void;
194
196
  /**
195
197
  * Get a previously run command by its ID.
196
198
  *
package/dist/session.d.ts CHANGED
@@ -191,6 +191,8 @@ declare class Session {
191
191
  routes: SandboxRouteData[];
192
192
  snapshot: SandboxSnapshot;
193
193
  });
194
+ /** @internal */
195
+ updateRoutes(routes: SandboxRouteData[]): void;
194
196
  /**
195
197
  * Get a previously run command by its ID.
196
198
  *
package/dist/session.js CHANGED
@@ -203,6 +203,10 @@ var Session = class Session {
203
203
  this.session = toSandboxSnapshot(params.session);
204
204
  }
205
205
  }
206
+ /** @internal */
207
+ updateRoutes(routes) {
208
+ this.routes = routes;
209
+ }
206
210
  /**
207
211
  * Get a previously run command by its ID.
208
212
  *