@vercel/sandbox - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

dist/api-client/base-client.cjs

@@ -5,2 +5,3 @@ const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
 const require_with_retry = require('./with-retry.cjs');
+let zod = require("zod");
 let undici = require("undici");
@@ -68,2 +69,16 @@
 /**
+* The error body shape returned by the Sandbox API. Mirrors the shape the
+* CLI's formatApiError parses.
+*/
+const ErrorResponseBody = zod.z.object({ error: zod.z.object({ message: zod.z.string() }) });
+/**
+* Extract the server-provided error message from an error response body so
+* it can be surfaced in APIError.message. Returns undefined for any other
+* body shape.
+*/
+function extractServerMessage(json) {
+	const parsed = ErrorResponseBody.safeParse(json);
+	return parsed.success ? parsed.data.error.message : void 0;
+}
+/**
 * Allows to read the response text and parse it as JSON casting to the given
@@ -98,9 +113,12 @@ * type. If the response is not ok or cannot be parsed it will return error.
 	}
-	if (!response.ok) return new require_api_error.APIError(response, {
-		message: `Status code ${response.status} is not ok`,
-		json,
-		text,
-		sessionId,
-		sandboxName
-	});
+	if (!response.ok) {
+		const serverMessage = extractServerMessage(json);
+		return new require_api_error.APIError(response, {
+			message: serverMessage ? `Status code ${response.status} is not ok: ${serverMessage}` : `Status code ${response.status} is not ok`,
+			json,
+			text,
+			sessionId,
+			sandboxName
+		});
+	}
 	const validated = validator.safeParse(json);
@@ -107,0 +125,0 @@ if (!validated.success) return new require_api_error.APIError(response, {

dist/api-client/base-client.cjs.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"base-client.cjs","names":["Agent","withRetry","value","sandboxName: string | undefined","APIError","json: Data | ErrorData"],"sources":["../../src/api-client/base-client.ts"],"sourcesContent":["import type { Options as RetryOptions } from \"async-retry\";\nimport { APIError } from \"./api-error.js\";\nimport { ZodType } from \"zod\";\nimport { array } from \"../utils/array.js\";\nimport { withRetry, type RequestOptions } from \"./with-retry.js\";\nimport { Agent } from \"undici\";\n\nexport interface RequestParams extends RequestInit {\n  headers?: Record<string, string>;\n  method?: string;\n  onRetry?(error: any, options: RequestOptions): void;\n  query?: Record<string, number | string | null | undefined | string[]>;\n  retry?: Partial<RetryOptions>;\n}\n\nconst DEFAULT_AGENT = new Agent({\n  bodyTimeout: 0, // disable body timeout to allow long logs streaming\n});\n\n/**\n * A base API client that provides a convenience wrapper for fetching where\n * we can pass query parameters as an object, support retries, debugging\n * and automatic authorization.\n */\nexport class BaseClient {\n  protected token?: string;\n  private fetch: ReturnType<typeof withRetry<RequestInit>>;\n  private debug: boolean;\n  private baseUrl: string;\n  private agent: Agent;\n\n  constructor(params: {\n    debug?: boolean;\n    baseUrl: string;\n    token?: string;\n    fetch?: typeof globalThis.fetch;\n  }) {\n    this.fetch = withRetry(params.fetch ?? globalThis.fetch);\n    this.baseUrl = params.baseUrl;\n    this.debug = params.debug ?? process.env.DEBUG_FETCH === \"true\";\n    this.token = params.token;\n    this.agent = DEFAULT_AGENT;\n  }\n\n  protected async request(path: string, opts?: RequestParams) {\n    const url = new URL(`${this.baseUrl}${path}`);\n    if (opts?.query) {\n      for (const [key, value] of Object.entries(opts.query)) {\n        array(value).forEach((value) => {\n          url.searchParams.append(key, value.toString());\n        });\n      }\n    }\n\n    const start = Date.now();\n    const response = await this.fetch(url.toString(), {\n      ...opts,\n      body: opts?.body,\n      method: opts?.method || \"GET\",\n      headers: this.token\n        ? { Authorization: `Bearer ${this.token}`, ...opts?.headers }\n        : opts?.headers,\n      // @ts-expect-error Node.js' and undici's Agent have different types\n      dispatcher: this.agent,\n      signal: opts?.signal,\n    });\n\n    if (this.debug) {\n      const duration = Date.now() - start;\n      console.log(`[API] ${url} (${response.status}) ${duration}ms`);\n      if (response.status === 429) {\n        const retry = parseInt(response.headers.get(\"Retry-After\") ?? \"\", 10);\n        const hours = Math.floor(retry / 60 / 60);\n        const minutes = Math.floor(retry / 60) % 60;\n        const seconds = retry % 60;\n        console.warn(\n          `[API] ${url} Rate Limited, Retry After ${hours}h ${minutes}m ${seconds}s`,\n        );\n      }\n    }\n\n    return response;\n  }\n}\n\nexport interface Parsed<Data> {\n  response: Response;\n  text: string;\n  json: Data;\n}\n\n/**\n * Extract sessionId from a sandbox API URL.\n */\nfunction extractSessionId(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/sessions\\/([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * Extract sandbox name from a sandbox API url.\n * Excludes known sub-paths like /sessions/ and /snapshots/.\n */\nfunction extractSandboxName(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/(?!sessions(?:\\/|$|\\?))(?!snapshots(?:\\/|$|\\?))([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * Allows to read the response text and parse it as JSON casting to the given\n * type. If the response is not ok or cannot be parsed it will return error.\n *\n * @param response Response to parse.\n * @returns Parsed response or error.\n */\nexport async function parse<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data> | APIError<ErrorData>> {\n  const sessionId = extractSessionId(response.url);\n  let sandboxName: string | undefined;\n  if (!sessionId) {\n    sandboxName = extractSandboxName(response.url);\n  }\n\n  const text = await response.text().catch((err) => {\n    return new APIError<ErrorData>(response, {\n      message: `Can't read response text: ${String(err)}`,\n      sessionId,\n      sandboxName\n    });\n  });\n\n  if (typeof text !== \"string\") {\n    return text;\n  }\n\n  let json: Data | ErrorData;\n\n  try {\n    json = JSON.parse(text || \"{}\");\n  } catch (error) {\n    return new APIError<ErrorData>(response, {\n      message: `Can't parse JSON: ${String(error)}`,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  if (!response.ok) {\n    return new APIError<ErrorData>(response, {\n      message: `Status code ${response.status} is not ok`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  const validated = validator.safeParse(json);\n  if (!validated.success) {\n    return new APIError<ErrorData>(response, {\n      message: `Response JSON is not valid: ${validated.error}`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  return {\n    json: validated.data,\n    response,\n    text,\n  };\n}\n\nexport async function parseOrThrow<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data>> {\n  const result = await parse<Data, ErrorData>(validator, response);\n  if (result instanceof APIError) {\n    throw result;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;AAeA,MAAM,gBAAgB,IAAIA,aAAM,EAC9B,aAAa,GACd,CAAC;;;;;;AAOF,IAAa,aAAb,MAAwB;CAOtB,YAAY,QAKT;AACD,OAAK,QAAQC,6BAAU,OAAO,SAAS,WAAW,MAAM;AACxD,OAAK,UAAU,OAAO;AACtB,OAAK,QAAQ,OAAO,SAAS,QAAQ,IAAI,gBAAgB;AACzD,OAAK,QAAQ,OAAO;AACpB,OAAK,QAAQ;;CAGf,MAAgB,QAAQ,MAAc,MAAsB;EAC1D,MAAM,MAAM,IAAI,IAAI,GAAG,KAAK,UAAU,OAAO;AAC7C,MAAI,MAAM,MACR,MAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,MAAM,CACnD,qBAAM,MAAM,CAAC,SAAS,YAAU;AAC9B,OAAI,aAAa,OAAO,KAAKC,QAAM,UAAU,CAAC;IAC9C;EAIN,MAAM,QAAQ,KAAK,KAAK;EACxB,MAAM,WAAW,MAAM,KAAK,MAAM,IAAI,UAAU,EAAE;GAChD,GAAG;GACH,MAAM,MAAM;GACZ,QAAQ,MAAM,UAAU;GACxB,SAAS,KAAK,QACV;IAAE,eAAe,UAAU,KAAK;IAAS,GAAG,MAAM;IAAS,GAC3D,MAAM;GAEV,YAAY,KAAK;GACjB,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,KAAK,OAAO;GACd,MAAM,WAAW,KAAK,KAAK,GAAG;AAC9B,WAAQ,IAAI,SAAS,IAAI,IAAI,SAAS,OAAO,IAAI,SAAS,IAAI;AAC9D,OAAI,SAAS,WAAW,KAAK;IAC3B,MAAM,QAAQ,SAAS,SAAS,QAAQ,IAAI,cAAc,IAAI,IAAI,GAAG;IACrE,MAAM,QAAQ,KAAK,MAAM,QAAQ,KAAK,GAAG;IACzC,MAAM,UAAU,KAAK,MAAM,QAAQ,GAAG,GAAG;IACzC,MAAM,UAAU,QAAQ;AACxB,YAAQ,KACN,SAAS,IAAI,6BAA6B,MAAM,IAAI,QAAQ,IAAI,QAAQ,GACzE;;;AAIL,SAAO;;;;;;AAaX,SAAS,iBAAiB,KAAiC;AAEzD,QADc,IAAI,MAAM,sCAAsC,GAC/C;;;;;;AAOjB,SAAS,mBAAmB,KAAiC;AAE3D,QADc,IAAI,MAAM,2EAA2E,GACpF;;;;;;;;;AAUjB,eAAsB,MACpB,WACA,UAC6C;CAC7C,MAAM,YAAY,iBAAiB,SAAS,IAAI;CAChD,IAAIC;AACJ,KAAI,CAAC,UACH,eAAc,mBAAmB,SAAS,IAAI;CAGhD,MAAM,OAAO,MAAM,SAAS,MAAM,CAAC,OAAO,QAAQ;AAChD,SAAO,IAAIC,2BAAoB,UAAU;GACvC,SAAS,6BAA6B,OAAO,IAAI;GACjD;GACA;GACD,CAAC;GACF;AAEF,KAAI,OAAO,SAAS,SAClB,QAAO;CAGT,IAAIC;AAEJ,KAAI;AACF,SAAO,KAAK,MAAM,QAAQ,KAAK;UACxB,OAAO;AACd,SAAO,IAAID,2BAAoB,UAAU;GACvC,SAAS,qBAAqB,OAAO,MAAM;GAC3C;GACA;GACA;GACD,CAAC;;AAGJ,KAAI,CAAC,SAAS,GACZ,QAAO,IAAIA,2BAAoB,UAAU;EACvC,SAAS,eAAe,SAAS,OAAO;EAClC;EACN;EACA;EACA;EACD,CAAC;CAGJ,MAAM,YAAY,UAAU,UAAU,KAAK;AAC3C,KAAI,CAAC,UAAU,QACb,QAAO,IAAIA,2BAAoB,UAAU;EACvC,SAAS,+BAA+B,UAAU;EAC5C;EACN;EACA;EACA;EACD,CAAC;AAGJ,QAAO;EACL,MAAM,UAAU;EAChB;EACA;EACD;;AAGH,eAAsB,aACpB,WACA,UACuB;CACvB,MAAM,SAAS,MAAM,MAAuB,WAAW,SAAS;AAChE,KAAI,kBAAkBA,2BACpB,OAAM;AAGR,QAAO"}
+{"version":3,"file":"base-client.cjs","names":["Agent","withRetry","value","z","sandboxName: string | undefined","APIError","json: Data | ErrorData"],"sources":["../../src/api-client/base-client.ts"],"sourcesContent":["import type { Options as RetryOptions } from \"async-retry\";\nimport { APIError } from \"./api-error.js\";\nimport { z, ZodType } from \"zod\";\nimport { array } from \"../utils/array.js\";\nimport { withRetry, type RequestOptions } from \"./with-retry.js\";\nimport { Agent } from \"undici\";\n\nexport interface RequestParams extends RequestInit {\n  headers?: Record<string, string>;\n  method?: string;\n  onRetry?(error: any, options: RequestOptions): void;\n  query?: Record<string, number | string | null | undefined | string[]>;\n  retry?: Partial<RetryOptions>;\n}\n\nconst DEFAULT_AGENT = new Agent({\n  bodyTimeout: 0, // disable body timeout to allow long logs streaming\n});\n\n/**\n * A base API client that provides a convenience wrapper for fetching where\n * we can pass query parameters as an object, support retries, debugging\n * and automatic authorization.\n */\nexport class BaseClient {\n  protected token?: string;\n  private fetch: ReturnType<typeof withRetry<RequestInit>>;\n  private debug: boolean;\n  private baseUrl: string;\n  private agent: Agent;\n\n  constructor(params: {\n    debug?: boolean;\n    baseUrl: string;\n    token?: string;\n    fetch?: typeof globalThis.fetch;\n  }) {\n    this.fetch = withRetry(params.fetch ?? globalThis.fetch);\n    this.baseUrl = params.baseUrl;\n    this.debug = params.debug ?? process.env.DEBUG_FETCH === \"true\";\n    this.token = params.token;\n    this.agent = DEFAULT_AGENT;\n  }\n\n  protected async request(path: string, opts?: RequestParams) {\n    const url = new URL(`${this.baseUrl}${path}`);\n    if (opts?.query) {\n      for (const [key, value] of Object.entries(opts.query)) {\n        array(value).forEach((value) => {\n          url.searchParams.append(key, value.toString());\n        });\n      }\n    }\n\n    const start = Date.now();\n    const response = await this.fetch(url.toString(), {\n      ...opts,\n      body: opts?.body,\n      method: opts?.method || \"GET\",\n      headers: this.token\n        ? { Authorization: `Bearer ${this.token}`, ...opts?.headers }\n        : opts?.headers,\n      // @ts-expect-error Node.js' and undici's Agent have different types\n      dispatcher: this.agent,\n      signal: opts?.signal,\n    });\n\n    if (this.debug) {\n      const duration = Date.now() - start;\n      console.log(`[API] ${url} (${response.status}) ${duration}ms`);\n      if (response.status === 429) {\n        const retry = parseInt(response.headers.get(\"Retry-After\") ?? \"\", 10);\n        const hours = Math.floor(retry / 60 / 60);\n        const minutes = Math.floor(retry / 60) % 60;\n        const seconds = retry % 60;\n        console.warn(\n          `[API] ${url} Rate Limited, Retry After ${hours}h ${minutes}m ${seconds}s`,\n        );\n      }\n    }\n\n    return response;\n  }\n}\n\nexport interface Parsed<Data> {\n  response: Response;\n  text: string;\n  json: Data;\n}\n\n/**\n * Extract sessionId from a sandbox API URL.\n */\nfunction extractSessionId(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/sessions\\/([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * Extract sandbox name from a sandbox API url.\n * Excludes known sub-paths like /sessions/ and /snapshots/.\n */\nfunction extractSandboxName(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/(?!sessions(?:\\/|$|\\?))(?!snapshots(?:\\/|$|\\?))([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * The error body shape returned by the Sandbox API. Mirrors the shape the\n * CLI's formatApiError parses.\n */\nconst ErrorResponseBody = z.object({\n  error: z.object({\n    message: z.string(),\n  }),\n});\n\n/**\n * Extract the server-provided error message from an error response body so\n * it can be surfaced in APIError.message. Returns undefined for any other\n * body shape.\n */\nfunction extractServerMessage(json: unknown): string | undefined {\n  const parsed = ErrorResponseBody.safeParse(json);\n  return parsed.success ? parsed.data.error.message : undefined;\n}\n\n/**\n * Allows to read the response text and parse it as JSON casting to the given\n * type. If the response is not ok or cannot be parsed it will return error.\n *\n * @param response Response to parse.\n * @returns Parsed response or error.\n */\nexport async function parse<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data> | APIError<ErrorData>> {\n  const sessionId = extractSessionId(response.url);\n  let sandboxName: string | undefined;\n  if (!sessionId) {\n    sandboxName = extractSandboxName(response.url);\n  }\n\n  const text = await response.text().catch((err) => {\n    return new APIError<ErrorData>(response, {\n      message: `Can't read response text: ${String(err)}`,\n      sessionId,\n      sandboxName\n    });\n  });\n\n  if (typeof text !== \"string\") {\n    return text;\n  }\n\n  let json: Data | ErrorData;\n\n  try {\n    json = JSON.parse(text || \"{}\");\n  } catch (error) {\n    return new APIError<ErrorData>(response, {\n      message: `Can't parse JSON: ${String(error)}`,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  if (!response.ok) {\n    const serverMessage = extractServerMessage(json);\n    return new APIError<ErrorData>(response, {\n      message: serverMessage\n        ? `Status code ${response.status} is not ok: ${serverMessage}`\n        : `Status code ${response.status} is not ok`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  const validated = validator.safeParse(json);\n  if (!validated.success) {\n    return new APIError<ErrorData>(response, {\n      message: `Response JSON is not valid: ${validated.error}`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  return {\n    json: validated.data,\n    response,\n    text,\n  };\n}\n\nexport async function parseOrThrow<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data>> {\n  const result = await parse<Data, ErrorData>(validator, response);\n  if (result instanceof APIError) {\n    throw result;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;;AAeA,MAAM,gBAAgB,IAAIA,aAAM,EAC9B,aAAa,GACd,CAAC;;;;;;AAOF,IAAa,aAAb,MAAwB;CAOtB,YAAY,QAKT;AACD,OAAK,QAAQC,6BAAU,OAAO,SAAS,WAAW,MAAM;AACxD,OAAK,UAAU,OAAO;AACtB,OAAK,QAAQ,OAAO,SAAS,QAAQ,IAAI,gBAAgB;AACzD,OAAK,QAAQ,OAAO;AACpB,OAAK,QAAQ;;CAGf,MAAgB,QAAQ,MAAc,MAAsB;EAC1D,MAAM,MAAM,IAAI,IAAI,GAAG,KAAK,UAAU,OAAO;AAC7C,MAAI,MAAM,MACR,MAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,MAAM,CACnD,qBAAM,MAAM,CAAC,SAAS,YAAU;AAC9B,OAAI,aAAa,OAAO,KAAKC,QAAM,UAAU,CAAC;IAC9C;EAIN,MAAM,QAAQ,KAAK,KAAK;EACxB,MAAM,WAAW,MAAM,KAAK,MAAM,IAAI,UAAU,EAAE;GAChD,GAAG;GACH,MAAM,MAAM;GACZ,QAAQ,MAAM,UAAU;GACxB,SAAS,KAAK,QACV;IAAE,eAAe,UAAU,KAAK;IAAS,GAAG,MAAM;IAAS,GAC3D,MAAM;GAEV,YAAY,KAAK;GACjB,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,KAAK,OAAO;GACd,MAAM,WAAW,KAAK,KAAK,GAAG;AAC9B,WAAQ,IAAI,SAAS,IAAI,IAAI,SAAS,OAAO,IAAI,SAAS,IAAI;AAC9D,OAAI,SAAS,WAAW,KAAK;IAC3B,MAAM,QAAQ,SAAS,SAAS,QAAQ,IAAI,cAAc,IAAI,IAAI,GAAG;IACrE,MAAM,QAAQ,KAAK,MAAM,QAAQ,KAAK,GAAG;IACzC,MAAM,UAAU,KAAK,MAAM,QAAQ,GAAG,GAAG;IACzC,MAAM,UAAU,QAAQ;AACxB,YAAQ,KACN,SAAS,IAAI,6BAA6B,MAAM,IAAI,QAAQ,IAAI,QAAQ,GACzE;;;AAIL,SAAO;;;;;;AAaX,SAAS,iBAAiB,KAAiC;AAEzD,QADc,IAAI,MAAM,sCAAsC,GAC/C;;;;;;AAOjB,SAAS,mBAAmB,KAAiC;AAE3D,QADc,IAAI,MAAM,2EAA2E,GACpF;;;;;;AAOjB,MAAM,oBAAoBC,MAAE,OAAO,EACjC,OAAOA,MAAE,OAAO,EACd,SAASA,MAAE,QAAQ,EACpB,CAAC,EACH,CAAC;;;;;;AAOF,SAAS,qBAAqB,MAAmC;CAC/D,MAAM,SAAS,kBAAkB,UAAU,KAAK;AAChD,QAAO,OAAO,UAAU,OAAO,KAAK,MAAM,UAAU;;;;;;;;;AAUtD,eAAsB,MACpB,WACA,UAC6C;CAC7C,MAAM,YAAY,iBAAiB,SAAS,IAAI;CAChD,IAAIC;AACJ,KAAI,CAAC,UACH,eAAc,mBAAmB,SAAS,IAAI;CAGhD,MAAM,OAAO,MAAM,SAAS,MAAM,CAAC,OAAO,QAAQ;AAChD,SAAO,IAAIC,2BAAoB,UAAU;GACvC,SAAS,6BAA6B,OAAO,IAAI;GACjD;GACA;GACD,CAAC;GACF;AAEF,KAAI,OAAO,SAAS,SAClB,QAAO;CAGT,IAAIC;AAEJ,KAAI;AACF,SAAO,KAAK,MAAM,QAAQ,KAAK;UACxB,OAAO;AACd,SAAO,IAAID,2BAAoB,UAAU;GACvC,SAAS,qBAAqB,OAAO,MAAM;GAC3C;GACA;GACA;GACD,CAAC;;AAGJ,KAAI,CAAC,SAAS,IAAI;EAChB,MAAM,gBAAgB,qBAAqB,KAAK;AAChD,SAAO,IAAIA,2BAAoB,UAAU;GACvC,SAAS,gBACL,eAAe,SAAS,OAAO,cAAc,kBAC7C,eAAe,SAAS,OAAO;GAC7B;GACN;GACA;GACA;GACD,CAAC;;CAGJ,MAAM,YAAY,UAAU,UAAU,KAAK;AAC3C,KAAI,CAAC,UAAU,QACb,QAAO,IAAIA,2BAAoB,UAAU;EACvC,SAAS,+BAA+B,UAAU;EAC5C;EACN;EACA;EACA;EACD,CAAC;AAGJ,QAAO;EACL,MAAM,UAAU;EAChB;EACA;EACD;;AAGH,eAAsB,aACpB,WACA,UACuB;CACvB,MAAM,SAAS,MAAM,MAAuB,WAAW,SAAS;AAChE,KAAI,kBAAkBA,2BACpB,OAAM;AAGR,QAAO"}

dist/api-client/base-client.d.ts

 import { RequestOptions } from "./with-retry.js";
+import "zod";
 import { Options } from "async-retry";
-import "zod";
 
@@ -5,0 +5,0 @@ //#region src/api-client/base-client.d.ts

dist/api-client/base-client.js

 import { APIError } from "./api-error.js";
 import { array } from "../utils/array.js";
 import { withRetry } from "./with-retry.js";
+import { z } from "zod";
 import { Agent } from "undici";
@@ -66,2 +67,16 @@
 /**
+* The error body shape returned by the Sandbox API. Mirrors the shape the
+* CLI's formatApiError parses.
+*/
+const ErrorResponseBody = z.object({ error: z.object({ message: z.string() }) });
+/**
+* Extract the server-provided error message from an error response body so
+* it can be surfaced in APIError.message. Returns undefined for any other
+* body shape.
+*/
+function extractServerMessage(json) {
+	const parsed = ErrorResponseBody.safeParse(json);
+	return parsed.success ? parsed.data.error.message : void 0;
+}
+/**
 * Allows to read the response text and parse it as JSON casting to the given
@@ -96,9 +111,12 @@ * type. If the response is not ok or cannot be parsed it will return error.
 	}
-	if (!response.ok) return new APIError(response, {
-		message: `Status code ${response.status} is not ok`,
-		json,
-		text,
-		sessionId,
-		sandboxName
-	});
+	if (!response.ok) {
+		const serverMessage = extractServerMessage(json);
+		return new APIError(response, {
+			message: serverMessage ? `Status code ${response.status} is not ok: ${serverMessage}` : `Status code ${response.status} is not ok`,
+			json,
+			text,
+			sessionId,
+			sandboxName
+		});
+	}
 	const validated = validator.safeParse(json);
@@ -105,0 +123,0 @@ if (!validated.success) return new APIError(response, {

dist/api-client/base-client.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"base-client.js","names":["value","sandboxName: string | undefined","json: Data | ErrorData"],"sources":["../../src/api-client/base-client.ts"],"sourcesContent":["import type { Options as RetryOptions } from \"async-retry\";\nimport { APIError } from \"./api-error.js\";\nimport { ZodType } from \"zod\";\nimport { array } from \"../utils/array.js\";\nimport { withRetry, type RequestOptions } from \"./with-retry.js\";\nimport { Agent } from \"undici\";\n\nexport interface RequestParams extends RequestInit {\n  headers?: Record<string, string>;\n  method?: string;\n  onRetry?(error: any, options: RequestOptions): void;\n  query?: Record<string, number | string | null | undefined | string[]>;\n  retry?: Partial<RetryOptions>;\n}\n\nconst DEFAULT_AGENT = new Agent({\n  bodyTimeout: 0, // disable body timeout to allow long logs streaming\n});\n\n/**\n * A base API client that provides a convenience wrapper for fetching where\n * we can pass query parameters as an object, support retries, debugging\n * and automatic authorization.\n */\nexport class BaseClient {\n  protected token?: string;\n  private fetch: ReturnType<typeof withRetry<RequestInit>>;\n  private debug: boolean;\n  private baseUrl: string;\n  private agent: Agent;\n\n  constructor(params: {\n    debug?: boolean;\n    baseUrl: string;\n    token?: string;\n    fetch?: typeof globalThis.fetch;\n  }) {\n    this.fetch = withRetry(params.fetch ?? globalThis.fetch);\n    this.baseUrl = params.baseUrl;\n    this.debug = params.debug ?? process.env.DEBUG_FETCH === \"true\";\n    this.token = params.token;\n    this.agent = DEFAULT_AGENT;\n  }\n\n  protected async request(path: string, opts?: RequestParams) {\n    const url = new URL(`${this.baseUrl}${path}`);\n    if (opts?.query) {\n      for (const [key, value] of Object.entries(opts.query)) {\n        array(value).forEach((value) => {\n          url.searchParams.append(key, value.toString());\n        });\n      }\n    }\n\n    const start = Date.now();\n    const response = await this.fetch(url.toString(), {\n      ...opts,\n      body: opts?.body,\n      method: opts?.method || \"GET\",\n      headers: this.token\n        ? { Authorization: `Bearer ${this.token}`, ...opts?.headers }\n        : opts?.headers,\n      // @ts-expect-error Node.js' and undici's Agent have different types\n      dispatcher: this.agent,\n      signal: opts?.signal,\n    });\n\n    if (this.debug) {\n      const duration = Date.now() - start;\n      console.log(`[API] ${url} (${response.status}) ${duration}ms`);\n      if (response.status === 429) {\n        const retry = parseInt(response.headers.get(\"Retry-After\") ?? \"\", 10);\n        const hours = Math.floor(retry / 60 / 60);\n        const minutes = Math.floor(retry / 60) % 60;\n        const seconds = retry % 60;\n        console.warn(\n          `[API] ${url} Rate Limited, Retry After ${hours}h ${minutes}m ${seconds}s`,\n        );\n      }\n    }\n\n    return response;\n  }\n}\n\nexport interface Parsed<Data> {\n  response: Response;\n  text: string;\n  json: Data;\n}\n\n/**\n * Extract sessionId from a sandbox API URL.\n */\nfunction extractSessionId(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/sessions\\/([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * Extract sandbox name from a sandbox API url.\n * Excludes known sub-paths like /sessions/ and /snapshots/.\n */\nfunction extractSandboxName(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/(?!sessions(?:\\/|$|\\?))(?!snapshots(?:\\/|$|\\?))([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * Allows to read the response text and parse it as JSON casting to the given\n * type. If the response is not ok or cannot be parsed it will return error.\n *\n * @param response Response to parse.\n * @returns Parsed response or error.\n */\nexport async function parse<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data> | APIError<ErrorData>> {\n  const sessionId = extractSessionId(response.url);\n  let sandboxName: string | undefined;\n  if (!sessionId) {\n    sandboxName = extractSandboxName(response.url);\n  }\n\n  const text = await response.text().catch((err) => {\n    return new APIError<ErrorData>(response, {\n      message: `Can't read response text: ${String(err)}`,\n      sessionId,\n      sandboxName\n    });\n  });\n\n  if (typeof text !== \"string\") {\n    return text;\n  }\n\n  let json: Data | ErrorData;\n\n  try {\n    json = JSON.parse(text || \"{}\");\n  } catch (error) {\n    return new APIError<ErrorData>(response, {\n      message: `Can't parse JSON: ${String(error)}`,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  if (!response.ok) {\n    return new APIError<ErrorData>(response, {\n      message: `Status code ${response.status} is not ok`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  const validated = validator.safeParse(json);\n  if (!validated.success) {\n    return new APIError<ErrorData>(response, {\n      message: `Response JSON is not valid: ${validated.error}`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  return {\n    json: validated.data,\n    response,\n    text,\n  };\n}\n\nexport async function parseOrThrow<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data>> {\n  const result = await parse<Data, ErrorData>(validator, response);\n  if (result instanceof APIError) {\n    throw result;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;AAeA,MAAM,gBAAgB,IAAI,MAAM,EAC9B,aAAa,GACd,CAAC;;;;;;AAOF,IAAa,aAAb,MAAwB;CAOtB,YAAY,QAKT;AACD,OAAK,QAAQ,UAAU,OAAO,SAAS,WAAW,MAAM;AACxD,OAAK,UAAU,OAAO;AACtB,OAAK,QAAQ,OAAO,SAAS,QAAQ,IAAI,gBAAgB;AACzD,OAAK,QAAQ,OAAO;AACpB,OAAK,QAAQ;;CAGf,MAAgB,QAAQ,MAAc,MAAsB;EAC1D,MAAM,MAAM,IAAI,IAAI,GAAG,KAAK,UAAU,OAAO;AAC7C,MAAI,MAAM,MACR,MAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,MAAM,CACnD,OAAM,MAAM,CAAC,SAAS,YAAU;AAC9B,OAAI,aAAa,OAAO,KAAKA,QAAM,UAAU,CAAC;IAC9C;EAIN,MAAM,QAAQ,KAAK,KAAK;EACxB,MAAM,WAAW,MAAM,KAAK,MAAM,IAAI,UAAU,EAAE;GAChD,GAAG;GACH,MAAM,MAAM;GACZ,QAAQ,MAAM,UAAU;GACxB,SAAS,KAAK,QACV;IAAE,eAAe,UAAU,KAAK;IAAS,GAAG,MAAM;IAAS,GAC3D,MAAM;GAEV,YAAY,KAAK;GACjB,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,KAAK,OAAO;GACd,MAAM,WAAW,KAAK,KAAK,GAAG;AAC9B,WAAQ,IAAI,SAAS,IAAI,IAAI,SAAS,OAAO,IAAI,SAAS,IAAI;AAC9D,OAAI,SAAS,WAAW,KAAK;IAC3B,MAAM,QAAQ,SAAS,SAAS,QAAQ,IAAI,cAAc,IAAI,IAAI,GAAG;IACrE,MAAM,QAAQ,KAAK,MAAM,QAAQ,KAAK,GAAG;IACzC,MAAM,UAAU,KAAK,MAAM,QAAQ,GAAG,GAAG;IACzC,MAAM,UAAU,QAAQ;AACxB,YAAQ,KACN,SAAS,IAAI,6BAA6B,MAAM,IAAI,QAAQ,IAAI,QAAQ,GACzE;;;AAIL,SAAO;;;;;;AAaX,SAAS,iBAAiB,KAAiC;AAEzD,QADc,IAAI,MAAM,sCAAsC,GAC/C;;;;;;AAOjB,SAAS,mBAAmB,KAAiC;AAE3D,QADc,IAAI,MAAM,2EAA2E,GACpF;;;;;;;;;AAUjB,eAAsB,MACpB,WACA,UAC6C;CAC7C,MAAM,YAAY,iBAAiB,SAAS,IAAI;CAChD,IAAIC;AACJ,KAAI,CAAC,UACH,eAAc,mBAAmB,SAAS,IAAI;CAGhD,MAAM,OAAO,MAAM,SAAS,MAAM,CAAC,OAAO,QAAQ;AAChD,SAAO,IAAI,SAAoB,UAAU;GACvC,SAAS,6BAA6B,OAAO,IAAI;GACjD;GACA;GACD,CAAC;GACF;AAEF,KAAI,OAAO,SAAS,SAClB,QAAO;CAGT,IAAIC;AAEJ,KAAI;AACF,SAAO,KAAK,MAAM,QAAQ,KAAK;UACxB,OAAO;AACd,SAAO,IAAI,SAAoB,UAAU;GACvC,SAAS,qBAAqB,OAAO,MAAM;GAC3C;GACA;GACA;GACD,CAAC;;AAGJ,KAAI,CAAC,SAAS,GACZ,QAAO,IAAI,SAAoB,UAAU;EACvC,SAAS,eAAe,SAAS,OAAO;EAClC;EACN;EACA;EACA;EACD,CAAC;CAGJ,MAAM,YAAY,UAAU,UAAU,KAAK;AAC3C,KAAI,CAAC,UAAU,QACb,QAAO,IAAI,SAAoB,UAAU;EACvC,SAAS,+BAA+B,UAAU;EAC5C;EACN;EACA;EACA;EACD,CAAC;AAGJ,QAAO;EACL,MAAM,UAAU;EAChB;EACA;EACD;;AAGH,eAAsB,aACpB,WACA,UACuB;CACvB,MAAM,SAAS,MAAM,MAAuB,WAAW,SAAS;AAChE,KAAI,kBAAkB,SACpB,OAAM;AAGR,QAAO"}
+{"version":3,"file":"base-client.js","names":["value","sandboxName: string | undefined","json: Data | ErrorData"],"sources":["../../src/api-client/base-client.ts"],"sourcesContent":["import type { Options as RetryOptions } from \"async-retry\";\nimport { APIError } from \"./api-error.js\";\nimport { z, ZodType } from \"zod\";\nimport { array } from \"../utils/array.js\";\nimport { withRetry, type RequestOptions } from \"./with-retry.js\";\nimport { Agent } from \"undici\";\n\nexport interface RequestParams extends RequestInit {\n  headers?: Record<string, string>;\n  method?: string;\n  onRetry?(error: any, options: RequestOptions): void;\n  query?: Record<string, number | string | null | undefined | string[]>;\n  retry?: Partial<RetryOptions>;\n}\n\nconst DEFAULT_AGENT = new Agent({\n  bodyTimeout: 0, // disable body timeout to allow long logs streaming\n});\n\n/**\n * A base API client that provides a convenience wrapper for fetching where\n * we can pass query parameters as an object, support retries, debugging\n * and automatic authorization.\n */\nexport class BaseClient {\n  protected token?: string;\n  private fetch: ReturnType<typeof withRetry<RequestInit>>;\n  private debug: boolean;\n  private baseUrl: string;\n  private agent: Agent;\n\n  constructor(params: {\n    debug?: boolean;\n    baseUrl: string;\n    token?: string;\n    fetch?: typeof globalThis.fetch;\n  }) {\n    this.fetch = withRetry(params.fetch ?? globalThis.fetch);\n    this.baseUrl = params.baseUrl;\n    this.debug = params.debug ?? process.env.DEBUG_FETCH === \"true\";\n    this.token = params.token;\n    this.agent = DEFAULT_AGENT;\n  }\n\n  protected async request(path: string, opts?: RequestParams) {\n    const url = new URL(`${this.baseUrl}${path}`);\n    if (opts?.query) {\n      for (const [key, value] of Object.entries(opts.query)) {\n        array(value).forEach((value) => {\n          url.searchParams.append(key, value.toString());\n        });\n      }\n    }\n\n    const start = Date.now();\n    const response = await this.fetch(url.toString(), {\n      ...opts,\n      body: opts?.body,\n      method: opts?.method || \"GET\",\n      headers: this.token\n        ? { Authorization: `Bearer ${this.token}`, ...opts?.headers }\n        : opts?.headers,\n      // @ts-expect-error Node.js' and undici's Agent have different types\n      dispatcher: this.agent,\n      signal: opts?.signal,\n    });\n\n    if (this.debug) {\n      const duration = Date.now() - start;\n      console.log(`[API] ${url} (${response.status}) ${duration}ms`);\n      if (response.status === 429) {\n        const retry = parseInt(response.headers.get(\"Retry-After\") ?? \"\", 10);\n        const hours = Math.floor(retry / 60 / 60);\n        const minutes = Math.floor(retry / 60) % 60;\n        const seconds = retry % 60;\n        console.warn(\n          `[API] ${url} Rate Limited, Retry After ${hours}h ${minutes}m ${seconds}s`,\n        );\n      }\n    }\n\n    return response;\n  }\n}\n\nexport interface Parsed<Data> {\n  response: Response;\n  text: string;\n  json: Data;\n}\n\n/**\n * Extract sessionId from a sandbox API URL.\n */\nfunction extractSessionId(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/sessions\\/([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * Extract sandbox name from a sandbox API url.\n * Excludes known sub-paths like /sessions/ and /snapshots/.\n */\nfunction extractSandboxName(url: string): string | undefined {\n  const match = url.match(/\\/v2\\/sandboxes\\/(?!sessions(?:\\/|$|\\?))(?!snapshots(?:\\/|$|\\?))([^/?]+)/);\n  return match?.[1];\n}\n\n/**\n * The error body shape returned by the Sandbox API. Mirrors the shape the\n * CLI's formatApiError parses.\n */\nconst ErrorResponseBody = z.object({\n  error: z.object({\n    message: z.string(),\n  }),\n});\n\n/**\n * Extract the server-provided error message from an error response body so\n * it can be surfaced in APIError.message. Returns undefined for any other\n * body shape.\n */\nfunction extractServerMessage(json: unknown): string | undefined {\n  const parsed = ErrorResponseBody.safeParse(json);\n  return parsed.success ? parsed.data.error.message : undefined;\n}\n\n/**\n * Allows to read the response text and parse it as JSON casting to the given\n * type. If the response is not ok or cannot be parsed it will return error.\n *\n * @param response Response to parse.\n * @returns Parsed response or error.\n */\nexport async function parse<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data> | APIError<ErrorData>> {\n  const sessionId = extractSessionId(response.url);\n  let sandboxName: string | undefined;\n  if (!sessionId) {\n    sandboxName = extractSandboxName(response.url);\n  }\n\n  const text = await response.text().catch((err) => {\n    return new APIError<ErrorData>(response, {\n      message: `Can't read response text: ${String(err)}`,\n      sessionId,\n      sandboxName\n    });\n  });\n\n  if (typeof text !== \"string\") {\n    return text;\n  }\n\n  let json: Data | ErrorData;\n\n  try {\n    json = JSON.parse(text || \"{}\");\n  } catch (error) {\n    return new APIError<ErrorData>(response, {\n      message: `Can't parse JSON: ${String(error)}`,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  if (!response.ok) {\n    const serverMessage = extractServerMessage(json);\n    return new APIError<ErrorData>(response, {\n      message: serverMessage\n        ? `Status code ${response.status} is not ok: ${serverMessage}`\n        : `Status code ${response.status} is not ok`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  const validated = validator.safeParse(json);\n  if (!validated.success) {\n    return new APIError<ErrorData>(response, {\n      message: `Response JSON is not valid: ${validated.error}`,\n      json: json as ErrorData,\n      text,\n      sessionId,\n      sandboxName\n    });\n  }\n\n  return {\n    json: validated.data,\n    response,\n    text,\n  };\n}\n\nexport async function parseOrThrow<Data, ErrorData>(\n  validator: ZodType<Data>,\n  response: Response,\n): Promise<Parsed<Data>> {\n  const result = await parse<Data, ErrorData>(validator, response);\n  if (result instanceof APIError) {\n    throw result;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;AAeA,MAAM,gBAAgB,IAAI,MAAM,EAC9B,aAAa,GACd,CAAC;;;;;;AAOF,IAAa,aAAb,MAAwB;CAOtB,YAAY,QAKT;AACD,OAAK,QAAQ,UAAU,OAAO,SAAS,WAAW,MAAM;AACxD,OAAK,UAAU,OAAO;AACtB,OAAK,QAAQ,OAAO,SAAS,QAAQ,IAAI,gBAAgB;AACzD,OAAK,QAAQ,OAAO;AACpB,OAAK,QAAQ;;CAGf,MAAgB,QAAQ,MAAc,MAAsB;EAC1D,MAAM,MAAM,IAAI,IAAI,GAAG,KAAK,UAAU,OAAO;AAC7C,MAAI,MAAM,MACR,MAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,MAAM,CACnD,OAAM,MAAM,CAAC,SAAS,YAAU;AAC9B,OAAI,aAAa,OAAO,KAAKA,QAAM,UAAU,CAAC;IAC9C;EAIN,MAAM,QAAQ,KAAK,KAAK;EACxB,MAAM,WAAW,MAAM,KAAK,MAAM,IAAI,UAAU,EAAE;GAChD,GAAG;GACH,MAAM,MAAM;GACZ,QAAQ,MAAM,UAAU;GACxB,SAAS,KAAK,QACV;IAAE,eAAe,UAAU,KAAK;IAAS,GAAG,MAAM;IAAS,GAC3D,MAAM;GAEV,YAAY,KAAK;GACjB,QAAQ,MAAM;GACf,CAAC;AAEF,MAAI,KAAK,OAAO;GACd,MAAM,WAAW,KAAK,KAAK,GAAG;AAC9B,WAAQ,IAAI,SAAS,IAAI,IAAI,SAAS,OAAO,IAAI,SAAS,IAAI;AAC9D,OAAI,SAAS,WAAW,KAAK;IAC3B,MAAM,QAAQ,SAAS,SAAS,QAAQ,IAAI,cAAc,IAAI,IAAI,GAAG;IACrE,MAAM,QAAQ,KAAK,MAAM,QAAQ,KAAK,GAAG;IACzC,MAAM,UAAU,KAAK,MAAM,QAAQ,GAAG,GAAG;IACzC,MAAM,UAAU,QAAQ;AACxB,YAAQ,KACN,SAAS,IAAI,6BAA6B,MAAM,IAAI,QAAQ,IAAI,QAAQ,GACzE;;;AAIL,SAAO;;;;;;AAaX,SAAS,iBAAiB,KAAiC;AAEzD,QADc,IAAI,MAAM,sCAAsC,GAC/C;;;;;;AAOjB,SAAS,mBAAmB,KAAiC;AAE3D,QADc,IAAI,MAAM,2EAA2E,GACpF;;;;;;AAOjB,MAAM,oBAAoB,EAAE,OAAO,EACjC,OAAO,EAAE,OAAO,EACd,SAAS,EAAE,QAAQ,EACpB,CAAC,EACH,CAAC;;;;;;AAOF,SAAS,qBAAqB,MAAmC;CAC/D,MAAM,SAAS,kBAAkB,UAAU,KAAK;AAChD,QAAO,OAAO,UAAU,OAAO,KAAK,MAAM,UAAU;;;;;;;;;AAUtD,eAAsB,MACpB,WACA,UAC6C;CAC7C,MAAM,YAAY,iBAAiB,SAAS,IAAI;CAChD,IAAIC;AACJ,KAAI,CAAC,UACH,eAAc,mBAAmB,SAAS,IAAI;CAGhD,MAAM,OAAO,MAAM,SAAS,MAAM,CAAC,OAAO,QAAQ;AAChD,SAAO,IAAI,SAAoB,UAAU;GACvC,SAAS,6BAA6B,OAAO,IAAI;GACjD;GACA;GACD,CAAC;GACF;AAEF,KAAI,OAAO,SAAS,SAClB,QAAO;CAGT,IAAIC;AAEJ,KAAI;AACF,SAAO,KAAK,MAAM,QAAQ,KAAK;UACxB,OAAO;AACd,SAAO,IAAI,SAAoB,UAAU;GACvC,SAAS,qBAAqB,OAAO,MAAM;GAC3C;GACA;GACA;GACD,CAAC;;AAGJ,KAAI,CAAC,SAAS,IAAI;EAChB,MAAM,gBAAgB,qBAAqB,KAAK;AAChD,SAAO,IAAI,SAAoB,UAAU;GACvC,SAAS,gBACL,eAAe,SAAS,OAAO,cAAc,kBAC7C,eAAe,SAAS,OAAO;GAC7B;GACN;GACA;GACA;GACD,CAAC;;CAGJ,MAAM,YAAY,UAAU,UAAU,KAAK;AAC3C,KAAI,CAAC,UAAU,QACb,QAAO,IAAI,SAAoB,UAAU;EACvC,SAAS,+BAA+B,UAAU;EAC5C;EACN;EACA;EACA;EACD,CAAC;AAGJ,QAAO;EACL,MAAM,UAAU;EAChB;EACA;EACD;;AAGH,eAAsB,aACpB,WACA,UACuB;CACvB,MAAM,SAAS,MAAM,MAAuB,WAAW,SAAS;AAChE,KAAI,kBAAkB,SACpB,OAAM;AAGR,QAAO"}

dist/sandbox.d.cts

@@ -51,3 +51,3 @@ import { Paginator } from "./utils/paginator.cjs";
    * Array of port numbers to expose from the sandbox. Sandboxes can
-   * expose up to 4 ports.
+   * expose up to 15 ports.
    */
@@ -201,3 +201,5 @@ ports?: number[];
   /**
-   * Whether to resume an existing session. Defaults to true.
+   * Whether to resume an existing session immediately. Defaults to false;
+   * a persistent sandbox still auto-resumes on the first SDK call that
+   * needs a running session (such as `runCommand`).
    */
@@ -222,3 +224,5 @@ resume?: boolean;
   /**
-   * Whether to resume an existing session. Defaults to true.
+   * Whether to resume an existing session immediately. Defaults to false;
+   * a persistent sandbox still auto-resumes on the first SDK call that
+   * needs a running session (such as `runCommand`).
    */
@@ -225,0 +229,0 @@ resume?: boolean;

dist/sandbox.d.ts

@@ -52,3 +52,3 @@ import { Paginator } from "./utils/paginator.js";
    * Array of port numbers to expose from the sandbox. Sandboxes can
-   * expose up to 4 ports.
+   * expose up to 15 ports.
    */
@@ -202,3 +202,5 @@ ports?: number[];
   /**
-   * Whether to resume an existing session. Defaults to true.
+   * Whether to resume an existing session immediately. Defaults to false;
+   * a persistent sandbox still auto-resumes on the first SDK call that
+   * needs a running session (such as `runCommand`).
    */
@@ -223,3 +225,5 @@ resume?: boolean;
   /**
-   * Whether to resume an existing session. Defaults to true.
+   * Whether to resume an existing session immediately. Defaults to false;
+   * a persistent sandbox still auto-resumes on the first SDK call that
+   * needs a running session (such as `runCommand`).
    */
@@ -226,0 +230,0 @@ resume?: boolean;

dist/version.cjs

 
 //#region src/version.ts
-const VERSION = "3.0.0";
+const VERSION = "3.0.1";
 
@@ -5,0 +5,0 @@ //#endregion

dist/version.cjs.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"version.cjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"3.0.0\";\n"],"mappings":";;AACA,MAAa,UAAU"}
+{"version":3,"file":"version.cjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"3.0.1\";\n"],"mappings":";;AACA,MAAa,UAAU"}

dist/version.js

 //#region src/version.ts
-const VERSION = "3.0.0";
+const VERSION = "3.0.1";
 
@@ -4,0 +4,0 @@ //#endregion

dist/version.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"version.js","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"3.0.0\";\n"],"mappings":";AACA,MAAa,UAAU"}
+{"version":3,"file":"version.js","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Autogenerated by inject-version.ts\nexport const VERSION = \"3.0.1\";\n"],"mappings":";AACA,MAAa,UAAU"}

package.json

 {
   "name": "@vercel/sandbox",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Software Development Kit for Vercel Sandbox",
@@ -5,0 +5,0 @@ "type": "module",

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Improved metrics

Total package byte prevSize

1455915

0.31%

Lines of code

16801

0.24%

No dependency changes