@vercel/sandbox 0.0.8 → 0.0.10

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

@@ -1,82 +1,375 @@
 import { z } from "zod";
-export declare const CreatedSandbox: z.ZodObject<{
+export type SandboxData = z.infer<typeof Sandbox>;
+export declare const 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;
+    updatedAt: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    region: string;
+    timeout: number;
+    status: "pending" | "running" | "stopping" | "stopped" | "failed";
+    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;
+    timeout: number;
+    status: "pending" | "running" | "stopping" | "stopped" | "failed";
+    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;
+}>;
+export type SandboxRouteData = z.infer<typeof SandboxRoute>;
+export declare const SandboxRoute: z.ZodObject<{
+    url: z.ZodString;
+    subdomain: z.ZodString;
+    port: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    port: number;
+    url: string;
+    subdomain: string;
+}, {
+    port: number;
+    url: string;
+    subdomain: string;
+}>;
+export type CommandData = z.infer<typeof Command>;
+export declare const Command: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    args: z.ZodArray<z.ZodString, "many">;
+    cwd: z.ZodString;
     sandboxId: z.ZodString;
+    exitCode: z.ZodNullable<z.ZodNumber>;
+    startedAt: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    cwd: string;
+    args: string[];
+    id: string;
+    startedAt: number;
+    sandboxId: string;
+    exitCode: number | null;
+}, {
+    name: string;
+    cwd: string;
+    args: string[];
+    id: string;
+    startedAt: number;
+    sandboxId: string;
+    exitCode: number | null;
+}>;
+export declare const SandboxResponse: 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;
+        updatedAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        region: string;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+    };
+}>;
+export declare const SandboxAndRoutesResponse: 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;
+        updatedAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        region: string;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+    }>;
+} & {
     routes: z.ZodArray<z.ZodObject<{
+        url: z.ZodString;
         subdomain: z.ZodString;
         port: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         port: number;
+        url: string;
         subdomain: string;
     }, {
         port: number;
+        url: string;
         subdomain: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    sandboxId: string;
+    sandbox: {
+        region: string;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+    };
     routes: {
         port: number;
+        url: string;
         subdomain: string;
     }[];
 }, {
-    sandboxId: string;
+    sandbox: {
+        region: string;
+        timeout: number;
+        status: "pending" | "running" | "stopping" | "stopped" | "failed";
+        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;
+    };
     routes: {
         port: number;
+        url: string;
         subdomain: string;
     }[];
 }>;
-export declare const CreatedCommand: z.ZodObject<{
-    cmdId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    cmdId: string;
-}, {
-    cmdId: string;
-}>;
-export declare const Command: z.ZodObject<{
-    args: z.ZodArray<z.ZodString, "many">;
-    cmdId: z.ZodString;
-    cwd: z.ZodString;
-    exitCode: z.ZodNullable<z.ZodNumber>;
-    name: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    cwd: string;
-    args: string[];
-    cmdId: string;
-    exitCode: number | null;
-}, {
-    name: string;
-    cwd: string;
-    args: string[];
-    cmdId: string;
-    exitCode: number | null;
-}>;
-export declare const CommandFinished: z.ZodObject<{
-    args: z.ZodArray<z.ZodString, "many">;
-    cmdId: z.ZodString;
-    cwd: z.ZodString;
-    exitCode: z.ZodNumber;
-    name: z.ZodString;
+export declare const CommandResponse: z.ZodObject<{
+    command: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        args: z.ZodArray<z.ZodString, "many">;
+        cwd: z.ZodString;
+        sandboxId: z.ZodString;
+        exitCode: z.ZodNullable<z.ZodNumber>;
+        startedAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number | null;
+    }, {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number | null;
+    }>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
-    cwd: string;
-    args: string[];
-    cmdId: string;
-    exitCode: number;
+    command: {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number | null;
+    };
 }, {
-    name: string;
-    cwd: string;
-    args: string[];
-    cmdId: string;
-    exitCode: number;
+    command: {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number | null;
+    };
 }>;
-export declare const WrittenFile: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-export declare const StoppedSandbox: z.ZodObject<{
-    sandboxId: z.ZodString;
+export declare const CommandFinishedResponse: z.ZodObject<{
+    command: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        args: z.ZodArray<z.ZodString, "many">;
+        cwd: z.ZodString;
+        sandboxId: z.ZodString;
+        startedAt: z.ZodNumber;
+    } & {
+        exitCode: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number;
+    }, {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number;
+    }>;
 }, "strip", z.ZodTypeAny, {
-    sandboxId: string;
+    command: {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number;
+    };
 }, {
-    sandboxId: string;
+    command: {
+        name: string;
+        cwd: string;
+        args: string[];
+        id: string;
+        startedAt: number;
+        sandboxId: string;
+        exitCode: number;
+    };
 }>;
+export declare const EmptyResponse: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 export declare const LogLine: z.ZodObject<{
     stream: z.ZodEnum<["stdout", "stderr"]>;
     data: z.ZodString;

package/dist/api-client/validators.js

@@ -1,32 +1,53 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLine = exports.StoppedSandbox = exports.WrittenFile = exports.CommandFinished = exports.Command = exports.CreatedCommand = exports.CreatedSandbox = void 0;
+exports.LogLine = exports.EmptyResponse = exports.CommandFinishedResponse = exports.CommandResponse = exports.SandboxAndRoutesResponse = exports.SandboxResponse = exports.Command = exports.SandboxRoute = exports.Sandbox = void 0;
 const zod_1 = require("zod");
-exports.CreatedSandbox = zod_1.z.object({
-    sandboxId: zod_1.z.string(),
-    routes: zod_1.z.array(zod_1.z.object({ subdomain: zod_1.z.string(), port: zod_1.z.number() })),
+exports.Sandbox = zod_1.z.object({
+    id: zod_1.z.string(),
+    memory: zod_1.z.number(),
+    vcpus: zod_1.z.number(),
+    region: zod_1.z.string(),
+    runtime: zod_1.z.string(),
+    timeout: zod_1.z.number(),
+    status: zod_1.z.enum(["pending", "running", "stopping", "stopped", "failed"]),
+    requestedAt: zod_1.z.number(),
+    startedAt: zod_1.z.number().optional(),
+    requestedStopAt: zod_1.z.number().optional(),
+    stoppedAt: zod_1.z.number().optional(),
+    duration: zod_1.z.number().optional(),
+    createdAt: zod_1.z.number(),
+    updatedAt: zod_1.z.number(),
 });
-exports.CreatedCommand = zod_1.z.object({
-    cmdId: zod_1.z.string(),
+exports.SandboxRoute = zod_1.z.object({
+    url: zod_1.z.string(),
+    subdomain: zod_1.z.string(),
+    port: zod_1.z.number(),
 });
 exports.Command = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
     args: zod_1.z.array(zod_1.z.string()),
-    cmdId: zod_1.z.string(),
     cwd: zod_1.z.string(),
+    sandboxId: zod_1.z.string(),
     exitCode: zod_1.z.number().nullable(),
-    name: zod_1.z.string(),
+    startedAt: zod_1.z.number(),
 });
-exports.CommandFinished = zod_1.z.object({
-    args: zod_1.z.array(zod_1.z.string()),
-    cmdId: zod_1.z.string(),
-    cwd: zod_1.z.string(),
+const CommandFinished = exports.Command.extend({
     exitCode: zod_1.z.number(),
-    name: zod_1.z.string(),
 });
-exports.WrittenFile = zod_1.z.object({});
-exports.StoppedSandbox = zod_1.z.object({
-    sandboxId: zod_1.z.string(),
+exports.SandboxResponse = zod_1.z.object({
+    sandbox: exports.Sandbox,
+});
+exports.SandboxAndRoutesResponse = exports.SandboxResponse.extend({
+    routes: zod_1.z.array(exports.SandboxRoute),
+});
+exports.CommandResponse = zod_1.z.object({
+    command: exports.Command,
+});
+exports.CommandFinishedResponse = zod_1.z.object({
+    command: CommandFinished,
 });
+exports.EmptyResponse = zod_1.z.object({});
 exports.LogLine = zod_1.z.object({
     stream: zod_1.z.enum(["stdout", "stderr"]),
     data: zod_1.z.string(),

package/dist/command.d.ts

@@ -1,4 +1,5 @@
-import { APIClient } from "./api-client";
+import { APIClient, type CommandData } from "./api-client";
+import { Signal } from "./utils/resolveSignal";
 /**
  * A command executed in a Sandbox.
  *
@@ -19,20 +20,24 @@ export declare class Command {
      * ID of the sandbox this command is running in.
      */
     private sandboxId;
+    /**
+     * Data for the command execution.
+     */
+    private cmd;
     /**
      * ID of the command execution.
      */
-    cmdId: string;
+    get cmdId(): string;
     /**
      * @param params - Object containing the client, sandbox ID, and command ID.
      * @param params.client - API client used to interact with the backend.
      * @param params.sandboxId - The ID of the sandbox where the command is running.
      * @param params.cmdId - The ID of the command execution.
      */
-    constructor({ client, sandboxId, cmdId, }: {
+    constructor({ client, sandboxId, cmd, }: {
         client: APIClient;
         sandboxId: string;
-        cmdId: string;
+        cmd: CommandData;
     });
     /**
      * Iterate over the output of this command.
@@ -97,6 +102,14 @@ export declare class Command {
      * @returns The standard error output of the command.
      */
     stderr(): Promise<string>;
+    /**
+     * Kill a running command in a sandbox.
+     *
+     * @param params - commandId and the signal to send the running process.
+     * Defaults to SIGTERM.
+     * @returns Promise<void>.
+     */
+    kill(signal?: Signal): Promise<void>;
 }
 /**
  * A command that has finished executing.
@@ -121,7 +134,7 @@ export declare class CommandFinished extends Command {
     constructor(params: {
         client: APIClient;
         sandboxId: string;
-        cmdId: string;
+        cmd: CommandData;
         exitCode: number;
     });
 }

package/dist/command.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandFinished = exports.Command = void 0;
+const resolveSignal_1 = require("./utils/resolveSignal");
 /**
  * A command executed in a Sandbox.
  *
@@ -12,16 +13,22 @@ exports.CommandFinished = exports.Command = void 0;
  * @hideconstructor
  */
 class Command {
+    /**
+     * ID of the command execution.
+     */
+    get cmdId() {
+        return this.cmd.id;
+    }
     /**
      * @param params - Object containing the client, sandbox ID, and command ID.
      * @param params.client - API client used to interact with the backend.
      * @param params.sandboxId - The ID of the sandbox where the command is running.
      * @param params.cmdId - The ID of the command execution.
      */
-    constructor({ client, sandboxId, cmdId, }) {
+    constructor({ client, sandboxId, cmd, }) {
         this.client = client;
         this.sandboxId = sandboxId;
-        this.cmdId = cmdId;
+        this.cmd = cmd;
     }
     /**
      * Iterate over the output of this command.
@@ -44,7 +51,7 @@ class Command {
     logs() {
         return this.client.getLogs({
             sandboxId: this.sandboxId,
-            cmdId: this.cmdId,
+            cmdId: this.cmd.id,
         });
     }
     /**
@@ -62,14 +69,14 @@ class Command {
     async wait() {
         const command = await this.client.getCommand({
             sandboxId: this.sandboxId,
-            cmdId: this.cmdId,
+            cmdId: this.cmd.id,
             wait: true,
         });
         return new CommandFinished({
             client: this.client,
             sandboxId: this.sandboxId,
-            cmdId: command.json.cmdId,
-            exitCode: command.json.exitCode,
+            cmd: command.json.command,
+            exitCode: command.json.command.exitCode,
         });
     }
     /**
@@ -112,6 +119,20 @@ class Command {
     async stderr() {
         return this.output("stderr");
     }
+    /**
+     * Kill a running command in a sandbox.
+     *
+     * @param params - commandId and the signal to send the running process.
+     * Defaults to SIGTERM.
+     * @returns Promise<void>.
+     */
+    async kill(signal) {
+        await this.client.killCommand({
+            sandboxId: this.sandboxId,
+            commandId: this.cmd.id,
+            signal: (0, resolveSignal_1.resolveSignal)(signal ?? "SIGTERM"),
+        });
+    }
 }
 exports.Command = Command;
 /**