@vercel/sandbox 1.9.0 → 1.9.2

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

@@ -0,0 +1,403 @@
+import { BaseClient, Parsed, RequestParams } from "./base-client.cjs";
+import { CommandData, CommandFinishedData, CommandFinishedResponse, CommandResponse, CreateSnapshotResponse, ExtendTimeoutResponse, LogLineStderr, LogLineStdout, SandboxResponse, SnapshotResponse, UpdateNetworkPolicyResponse } from "./validators.cjs";
+import { FileWriter } from "./file-writer.cjs";
+import { NetworkPolicy } from "../network-policy.cjs";
+import { WithPrivate } from "../utils/types.cjs";
+import { RUNTIMES } from "../constants.cjs";
+import { z } from "zod";
+import { Readable } from "stream";
+
+//#region src/api-client/api-client.d.ts
+interface WithFetchOptions {
+  fetch?: typeof globalThis.fetch;
+}
+declare class APIClient extends BaseClient {
+  private teamId;
+  private projectId;
+  private isJwtToken;
+  constructor(params: {
+    baseUrl?: string;
+    teamId: string;
+    token: string;
+    fetch?: typeof globalThis.fetch;
+  });
+  private ensureValidToken;
+  protected request(path: string, params?: RequestParams): Promise<Response>;
+  getSandbox(params: WithPrivate<{
+    sandboxId: string;
+    signal?: AbortSignal;
+  }>): Promise<Parsed<{
+    sandbox: {
+      status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
+      id: string;
+      memory: number;
+      vcpus: number;
+      region: string;
+      runtime: string;
+      timeout: number;
+      requestedAt: number;
+      createdAt: number;
+      cwd: string;
+      updatedAt: number;
+      startedAt?: number | undefined;
+      requestedStopAt?: number | undefined;
+      stoppedAt?: number | undefined;
+      abortedAt?: number | undefined;
+      duration?: number | undefined;
+      sourceSnapshotId?: string | undefined;
+      snapshottedAt?: number | undefined;
+      interactivePort?: number | undefined;
+      networkPolicy?: z.objectInputType<{
+        mode: z.ZodLiteral<"allow-all">;
+      }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
+        mode: z.ZodLiteral<"deny-all">;
+      }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
+        mode: z.ZodLiteral<"custom">;
+        allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
+          domain: z.ZodString;
+          headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+          headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }>, "many">>;
+      }, z.ZodTypeAny, "passthrough"> | undefined;
+      activeCpuDurationMs?: number | undefined;
+      networkTransfer?: {
+        ingress: number;
+        egress: number;
+      } | undefined;
+    };
+    routes: {
+      url: string;
+      subdomain: string;
+      port: number;
+    }[];
+  }>>;
+  createSandbox(params: WithPrivate<{
+    ports?: number[];
+    projectId: string;
+    source?: {
+      type: "git";
+      url: string;
+      depth?: number;
+      revision?: string;
+      username?: string;
+      password?: string;
+    } | {
+      type: "tarball";
+      url: string;
+    } | {
+      type: "snapshot";
+      snapshotId: string;
+    };
+    timeout?: number;
+    resources?: {
+      vcpus: number;
+    };
+    runtime?: RUNTIMES | (string & {});
+    networkPolicy?: NetworkPolicy;
+    env?: Record<string, string>;
+    signal?: AbortSignal;
+  }>): Promise<Parsed<{
+    sandbox: {
+      status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
+      id: string;
+      memory: number;
+      vcpus: number;
+      region: string;
+      runtime: string;
+      timeout: number;
+      requestedAt: number;
+      createdAt: number;
+      cwd: string;
+      updatedAt: number;
+      startedAt?: number | undefined;
+      requestedStopAt?: number | undefined;
+      stoppedAt?: number | undefined;
+      abortedAt?: number | undefined;
+      duration?: number | undefined;
+      sourceSnapshotId?: string | undefined;
+      snapshottedAt?: number | undefined;
+      interactivePort?: number | undefined;
+      networkPolicy?: z.objectInputType<{
+        mode: z.ZodLiteral<"allow-all">;
+      }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
+        mode: z.ZodLiteral<"deny-all">;
+      }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
+        mode: z.ZodLiteral<"custom">;
+        allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
+          domain: z.ZodString;
+          headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+          headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }>, "many">>;
+      }, z.ZodTypeAny, "passthrough"> | undefined;
+      activeCpuDurationMs?: number | undefined;
+      networkTransfer?: {
+        ingress: number;
+        egress: number;
+      } | undefined;
+    };
+    routes: {
+      url: string;
+      subdomain: string;
+      port: number;
+    }[];
+  }>>;
+  runCommand(params: {
+    sandboxId: string;
+    cwd?: string;
+    command: string;
+    args: string[];
+    env: Record<string, string>;
+    sudo: boolean;
+    wait: true;
+    signal?: AbortSignal;
+  }): Promise<{
+    command: CommandData;
+    finished: Promise<CommandFinishedData>;
+  }>;
+  runCommand(params: {
+    sandboxId: string;
+    cwd?: string;
+    command: string;
+    args: string[];
+    env: Record<string, string>;
+    sudo: boolean;
+    wait?: false;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
+  getCommand(params: {
+    sandboxId: string;
+    cmdId: string;
+    wait: true;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof CommandFinishedResponse>>>;
+  getCommand(params: {
+    sandboxId: string;
+    cmdId: string;
+    wait?: boolean;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
+  mkDir(params: {
+    sandboxId: string;
+    path: string;
+    cwd?: string;
+    signal?: AbortSignal;
+  }): Promise<Parsed<{}>>;
+  getFileWriter(params: {
+    sandboxId: string;
+    extractDir: string;
+    signal?: AbortSignal;
+  }): {
+    response: Promise<Response>;
+    writer: FileWriter;
+  };
+  listSandboxes(params: {
+    /**
+     * The ID or name of the project to which the sandboxes belong.
+     * @example "my-project"
+     */
+    projectId: string;
+    /**
+     * Maximum number of sandboxes to list from a request.
+     * @example 10
+     */
+    limit?: number;
+    /**
+     * Get sandboxes created after this JavaScript timestamp.
+     * @example 1540095775941
+     */
+    since?: number | Date;
+    /**
+     * Get sandboxes created before this JavaScript timestamp.
+     * @example 1540095775951
+     */
+    until?: number | Date;
+    signal?: AbortSignal;
+  }): Promise<Parsed<{
+    sandboxes: {
+      status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
+      id: string;
+      memory: number;
+      vcpus: number;
+      region: string;
+      runtime: string;
+      timeout: number;
+      requestedAt: number;
+      createdAt: number;
+      cwd: string;
+      updatedAt: number;
+      startedAt?: number | undefined;
+      requestedStopAt?: number | undefined;
+      stoppedAt?: number | undefined;
+      abortedAt?: number | undefined;
+      duration?: number | undefined;
+      sourceSnapshotId?: string | undefined;
+      snapshottedAt?: number | undefined;
+      interactivePort?: number | undefined;
+      networkPolicy?: z.objectInputType<{
+        mode: z.ZodLiteral<"allow-all">;
+      }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
+        mode: z.ZodLiteral<"deny-all">;
+      }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
+        mode: z.ZodLiteral<"custom">;
+        allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
+          domain: z.ZodString;
+          headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+          headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }, {
+          domain: string;
+          headers?: Record<string, string> | undefined;
+          headerNames?: string[] | undefined;
+        }>, "many">>;
+      }, z.ZodTypeAny, "passthrough"> | undefined;
+      activeCpuDurationMs?: number | undefined;
+      networkTransfer?: {
+        ingress: number;
+        egress: number;
+      } | undefined;
+    }[];
+    pagination: {
+      count: number;
+      next: number | null;
+      prev: number | null;
+    };
+  }>>;
+  listSnapshots(params: {
+    /**
+     * The ID or name of the project to which the snapshots belong.
+     * @example "my-project"
+     */
+    projectId: string;
+    /**
+     * Maximum number of snapshots to list from a request.
+     * @example 10
+     */
+    limit?: number;
+    /**
+     * Get snapshots created after this JavaScript timestamp.
+     * @example 1540095775941
+     */
+    since?: number | Date;
+    /**
+     * Get snapshots created before this JavaScript timestamp.
+     * @example 1540095775951
+     */
+    until?: number | Date;
+    signal?: AbortSignal;
+  }): Promise<Parsed<{
+    pagination: {
+      count: number;
+      next: number | null;
+      prev: number | null;
+    };
+    snapshots: {
+      status: "failed" | "created" | "deleted";
+      id: string;
+      region: string;
+      createdAt: number;
+      updatedAt: number;
+      sourceSandboxId: string;
+      sizeBytes: number;
+      expiresAt?: number | undefined;
+    }[];
+  }>>;
+  writeFiles(params: {
+    sandboxId: string;
+    cwd: string;
+    files: {
+      path: string;
+      content: string | Uint8Array;
+      mode?: number;
+    }[];
+    extractDir: string;
+    signal?: AbortSignal;
+  }): Promise<void>;
+  readFile(params: {
+    sandboxId: string;
+    path: string;
+    cwd?: string;
+    signal?: AbortSignal;
+  }): Promise<Readable | null>;
+  killCommand(params: {
+    sandboxId: string;
+    commandId: string;
+    signal: number;
+    abortSignal?: AbortSignal;
+  }): Promise<Parsed<{
+    command: {
+      id: string;
+      startedAt: number;
+      cwd: string;
+      name: string;
+      args: string[];
+      sandboxId: string;
+      exitCode: number | null;
+    };
+  }>>;
+  getLogs(params: {
+    sandboxId: string;
+    cmdId: string;
+    signal?: AbortSignal;
+  }): AsyncGenerator<z.infer<typeof LogLineStdout> | z.infer<typeof LogLineStderr>, void, void> & Disposable & {
+    close(): void;
+  };
+  stopSandbox(params: {
+    sandboxId: string;
+    signal?: AbortSignal;
+    blocking?: boolean;
+  }): Promise<Parsed<z.infer<typeof SandboxResponse>>>;
+  updateNetworkPolicy(params: {
+    sandboxId: string;
+    networkPolicy: NetworkPolicy;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof UpdateNetworkPolicyResponse>>>;
+  extendTimeout(params: {
+    sandboxId: string;
+    duration: number;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof ExtendTimeoutResponse>>>;
+  createSnapshot(params: {
+    sandboxId: string;
+    expiration?: number;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof CreateSnapshotResponse>>>;
+  deleteSnapshot(params: {
+    snapshotId: string;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof SnapshotResponse>>>;
+  getSnapshot(params: {
+    snapshotId: string;
+    signal?: AbortSignal;
+  }): Promise<Parsed<z.infer<typeof SnapshotResponse>>>;
+}
+//#endregion
+export { APIClient, WithFetchOptions };
+//# sourceMappingURL=api-client.d.cts.map