@vercel/sandbox 0.0.22 → 0.0.23

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @vercel/sandbox@0.0.22 build /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
+> @vercel/sandbox@0.0.23 build /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
 > tsc
 

package/.turbo/turbo-typecheck.log

@@ -1,4 +1,4 @@
 
-> @vercel/sandbox@0.0.22 typecheck /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
+> @vercel/sandbox@0.0.23 typecheck /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
 > tsc --noEmit
 

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/sandbox
 
+## 0.0.23
+
+### Patch Changes
+
+- Add `Sandbox.extendTimeout()` ([#148](https://github.com/vercel/sandbox-sdk/pull/148))
+
 ## 0.0.22
 
 ### Patch Changes

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

@@ -1,5 +1,5 @@
 import { BaseClient, type Parsed, type RequestParams } from "./base-client";
-import { SandboxResponse, CommandResponse, CommandFinishedResponse, LogLine } from "./validators";
+import { SandboxResponse, CommandResponse, CommandFinishedResponse, LogLine, ExtendTimeoutResponse } from "./validators";
 import { FileWriter } from "./file-writer";
 import { z } from "zod";
 import { WithPrivate } from "../utils/types";
@@ -218,4 +218,9 @@ export declare class APIClient extends BaseClient {
         sandboxId: string;
         signal?: AbortSignal;
     }): Promise<Parsed<z.infer<typeof SandboxResponse>>>;
+    extendTimeout(params: {
+        sandboxId: string;
+        duration: number;
+        signal?: AbortSignal;
+    }): Promise<Parsed<z.infer<typeof ExtendTimeoutResponse>>>;
 }

package/dist/api-client/api-client.js

@@ -212,6 +212,14 @@ class APIClient extends base_client_1.BaseClient {
         const url = `/v1/sandboxes/${params.sandboxId}/stop`;
         return (0, base_client_1.parseOrThrow)(validators_1.SandboxResponse, await this.request(url, { method: "POST", signal: params.signal }));
     }
+    async extendTimeout(params) {
+        const url = `/v1/sandboxes/${params.sandboxId}/extend-timeout`;
+        return (0, base_client_1.parseOrThrow)(validators_1.ExtendTimeoutResponse, await this.request(url, {
+            method: "POST",
+            body: JSON.stringify({ duration: params.duration }),
+            signal: params.signal,
+        }));
+    }
 }
 exports.APIClient = APIClient;
 async function pipe(readable, output) {

package/dist/api-client/validators.d.ts

@@ -540,3 +540,90 @@ export declare const SandboxesResponse: z.ZodObject<{
         prev: number | null;
     };
 }>;
+export declare const ExtendTimeoutResponse: z.ZodObject<{
+    sandbox: z.ZodObject<{
+        id: z.ZodString;
+        memory: z.ZodNumber;
+        vcpus: z.ZodNumber;
+        region: z.ZodString;
+        runtime: z.ZodString;
+        timeout: z.ZodNumber;
+        status: z.ZodEnum<["pending", "running", "stopping", "stopped", "failed"]>;
+        requestedAt: z.ZodNumber;
+        startedAt: z.ZodOptional<z.ZodNumber>;
+        requestedStopAt: z.ZodOptional<z.ZodNumber>;
+        stoppedAt: z.ZodOptional<z.ZodNumber>;
+        duration: z.ZodOptional<z.ZodNumber>;
+        createdAt: z.ZodNumber;
+        cwd: z.ZodString;
+        updatedAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        region: string;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
+        id: string;
+        memory: number;
+        vcpus: number;
+        runtime: string;
+        requestedAt: number;
+        createdAt: number;
+        updatedAt: number;
+        duration?: number | undefined;
+        startedAt?: number | undefined;
+        requestedStopAt?: number | undefined;
+        stoppedAt?: number | undefined;
+    }, {
+        region: string;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
+        id: string;
+        memory: number;
+        vcpus: number;
+        runtime: string;
+        requestedAt: number;
+        createdAt: number;
+        updatedAt: number;
+        duration?: number | undefined;
+        startedAt?: number | undefined;
+        requestedStopAt?: number | undefined;
+        stoppedAt?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    sandbox: {
+        region: string;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
+        id: string;
+        memory: number;
+        vcpus: number;
+        runtime: string;
+        requestedAt: number;
+        createdAt: number;
+        updatedAt: number;
+        duration?: number | undefined;
+        startedAt?: number | undefined;
+        requestedStopAt?: number | undefined;
+        stoppedAt?: number | undefined;
+    };
+}, {
+    sandbox: {
+        region: string;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        timeout: number;
+        cwd: string;
+        id: string;
+        memory: number;
+        vcpus: number;
+        runtime: string;
+        requestedAt: number;
+        createdAt: number;
+        updatedAt: number;
+        duration?: number | undefined;
+        startedAt?: number | undefined;
+        requestedStopAt?: number | undefined;
+        stoppedAt?: number | undefined;
+    };
+}>;

package/dist/api-client/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SandboxesResponse = exports.LogLine = exports.EmptyResponse = exports.CommandFinishedResponse = exports.CommandResponse = exports.SandboxAndRoutesResponse = exports.SandboxResponse = exports.Command = exports.Pagination = exports.SandboxRoute = exports.Sandbox = void 0;
+exports.ExtendTimeoutResponse = exports.SandboxesResponse = exports.LogLine = exports.EmptyResponse = exports.CommandFinishedResponse = exports.CommandResponse = exports.SandboxAndRoutesResponse = exports.SandboxResponse = exports.Command = exports.Pagination = exports.SandboxRoute = exports.Sandbox = void 0;
 const zod_1 = require("zod");
 exports.Sandbox = zod_1.z.object({
     id: zod_1.z.string(),
@@ -74,3 +74,6 @@ exports.SandboxesResponse = zod_1.z.object({
     sandboxes: zod_1.z.array(exports.Sandbox),
     pagination: exports.Pagination,
 });
+exports.ExtendTimeoutResponse = zod_1.z.object({
+    sandbox: exports.Sandbox,
+});

package/dist/sandbox.d.ts

@@ -130,10 +130,14 @@ export declare class Sandbox {
      * The status of the sandbox.
      */
     get status(): SandboxMetaData["status"];
+    /**
+     * The timeout of the sandbox in milliseconds.
+     */
+    get timeout(): number;
     /**
      * Internal metadata about this sandbox.
      */
-    private readonly sandbox;
+    private sandbox;
     /**
      * Allow to get a list of sandboxes for a team narrowed to the given params.
      * It returns both the sandboxes and the pagination metadata to allow getting
@@ -294,5 +298,19 @@ export declare class Sandbox {
     stop(opts?: {
         signal?: AbortSignal;
     }): Promise<void>;
+    /**
+     * Extend the timeout of the sandbox by the specified duration.
+     *
+     * This allows you to extend the lifetime of a sandbox up until the maximum
+     * execution timeout for your plan.
+     *
+     * @param duration - The duration in milliseconds to extend the timeout by
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel the operation.
+     * @returns A promise that resolves when the timeout is extended
+     */
+    extendTimeout(duration: number, opts?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
 }
 export {};

package/dist/sandbox.js

@@ -24,6 +24,12 @@ class Sandbox {
     get status() {
         return this.sandbox.status;
     }
+    /**
+     * The timeout of the sandbox in milliseconds.
+     */
+    get timeout() {
+        return this.sandbox.timeout;
+    }
     /**
      * Allow to get a list of sandboxes for a team narrowed to the given params.
      * It returns both the sandboxes and the pagination metadata to allow getting
@@ -242,5 +248,25 @@ class Sandbox {
             signal: opts?.signal,
         });
     }
+    /**
+     * Extend the timeout of the sandbox by the specified duration.
+     *
+     * This allows you to extend the lifetime of a sandbox up until the maximum
+     * execution timeout for your plan.
+     *
+     * @param duration - The duration in milliseconds to extend the timeout by
+     * @param opts - Optional parameters.
+     * @param opts.signal - An AbortSignal to cancel the operation.
+     * @returns A promise that resolves when the timeout is extended
+     */
+    async extendTimeout(duration, opts) {
+        const response = await this.client.extendTimeout({
+            sandboxId: this.sandbox.id,
+            duration,
+            signal: opts?.signal,
+        });
+        // Update the internal sandbox metadata with the new timeout value
+        this.sandbox = response.json.sandbox;
+    }
 }
 exports.Sandbox = Sandbox;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.0.22";
+export declare const VERSION = "0.0.23";

package/dist/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // Autogenerated by inject-version.ts
-exports.VERSION = "0.0.22";
+exports.VERSION = "0.0.23";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sandbox",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/api-client/api-client.ts

@@ -12,6 +12,7 @@ import {
   EmptyResponse,
   LogLine,
   SandboxesResponse,
+  ExtendTimeoutResponse,
 } from "./validators";
 import { APIError } from "./api-error";
 import { FileWriter } from "./file-writer";
@@ -393,6 +394,22 @@ export class APIClient extends BaseClient {
       await this.request(url, { method: "POST", signal: params.signal }),
     );
   }
+
+  async extendTimeout(params: {
+    sandboxId: string;
+    duration: number;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof ExtendTimeoutResponse>>> {
+    const url = `/v1/sandboxes/${params.sandboxId}/extend-timeout`;
+    return parseOrThrow(
+      ExtendTimeoutResponse,
+      await this.request(url, {
+        method: "POST",
+        body: JSON.stringify({ duration: params.duration }),
+        signal: params.signal,
+      }),
+    );
+  }
 }
 
 async function pipe(

package/src/api-client/validators.ts

@@ -89,3 +89,7 @@ export const SandboxesResponse = z.object({
   sandboxes: z.array(Sandbox),
   pagination: Pagination,
 });
+
+export const ExtendTimeoutResponse = z.object({
+  sandbox: Sandbox,
+});

package/src/sandbox.test.ts

@@ -1,6 +1,8 @@
 import { it, beforeEach, afterEach, expect } from "vitest";
 import { consumeReadable } from "./utils/consume-readable";
 import { Sandbox } from "./sandbox";
+import { APIError } from "./api-client/api-error";
+import ms from "ms";
 
 const PORTS = [3000, 4000];
 let sandbox: Sandbox;
@@ -64,3 +66,26 @@ for (const port of ports) {
 
   await server.kill();
 });
+
+it("allows extending the sandbox timeout", async () => {
+  const originalTimeout = sandbox.timeout;
+  const extensionDuration = ms("5m");
+
+  await sandbox.extendTimeout(extensionDuration);
+  expect(sandbox.timeout).toEqual(originalTimeout + extensionDuration);
+});
+
+it("raises an error when the timeout cannot be updated", async () => {
+  try {
+    await sandbox.extendTimeout(ms("5d"));
+    expect.fail("Expected extendTimeout to throw an error");
+  } catch (error) {
+    expect(error).toBeInstanceOf(APIError);
+    expect(error).toMatchObject({
+      response: { status: 400 },
+      json: {
+        error: { code: "sandbox_timeout_invalid" },
+      },
+    });
+  }
+});

package/src/sandbox.ts

@@ -142,10 +142,17 @@ export class Sandbox {
     return this.sandbox.status;
   }
 
+  /**
+   * The timeout of the sandbox in milliseconds.
+   */
+  public get timeout(): number {
+    return this.sandbox.timeout;
+  }
+
   /**
    * Internal metadata about this sandbox.
    */
-  private readonly sandbox: SandboxMetaData;
+  private sandbox: SandboxMetaData;
 
   /**
    * Allow to get a list of sandboxes for a team narrowed to the given params.
@@ -444,4 +451,29 @@ export class Sandbox {
       signal: opts?.signal,
     });
   }
+
+  /**
+   * Extend the timeout of the sandbox by the specified duration.
+   *
+   * This allows you to extend the lifetime of a sandbox up until the maximum
+   * execution timeout for your plan.
+   *
+   * @param duration - The duration in milliseconds to extend the timeout by
+   * @param opts - Optional parameters.
+   * @param opts.signal - An AbortSignal to cancel the operation.
+   * @returns A promise that resolves when the timeout is extended
+   */
+  async extendTimeout(
+    duration: number,
+    opts?: { signal?: AbortSignal },
+  ): Promise<void> {
+    const response = await this.client.extendTimeout({
+      sandboxId: this.sandbox.id,
+      duration,
+      signal: opts?.signal,
+    });
+
+    // Update the internal sandbox metadata with the new timeout value
+    this.sandbox = response.json.sandbox;
+  }
 }

package/src/version.ts

@@ -1,2 +1,2 @@
 // Autogenerated by inject-version.ts
-export const VERSION = "0.0.22";
+export const VERSION = "0.0.23";