@codesandbox/sdk/dist/cjs/types.d.ts

The CodeSandbox SDK

import { VMTier } from "./VMTier";
import { HostToken } from "./HostTokens";
import { Config } from "./api-clients/client/client";
import { Tracer } from "@opentelemetry/api";
export interface PitcherManagerResponse {
    bootupType: "RUNNING" | "CLEAN" | "RESUME" | "FORK";
    pitcherURL: string;
    workspacePath: string;
    userWorkspacePath: string;
    pitcherManagerVersion: string;
    pitcherVersion: string;
    latestPitcherVersion: string;
    pitcherToken: string;
    cluster: string;
}
export interface SystemMetricsStatus {
    cpu: {
        cores: number;
        used: number;
        configured: number;
    };
    memory: {
        usedKiB: number;
        totalKiB: number;
        configuredKiB: number;
    };
    storage: {
        usedKB: number;
        totalKB: number;
        configuredKB: number;
    };
}
/**
 * Sandbox privacy settings
 */
export type SandboxPrivacy = "public" | "unlisted" /** @deprecated Use "public" or "public-hosts" instead */ | "private" | "public-hosts";
export type SandboxInfo = {
    id: string;
    createdAt: Date;
    updatedAt: Date;
    title?: string;
    description?: string;
    privacy: SandboxPrivacy;
    tags: string[];
};
export type SandboxListOpts = {
    tags?: string[];
    orderBy?: "inserted_at" | "updated_at";
    direction?: "asc" | "desc";
    status?: "running";
};
export interface SandboxListResponse {
    sandboxes: SandboxInfo[];
    hasMore: boolean;
    totalCount: number;
    pagination: {
        currentPage: number;
        nextPage: number | null;
        pageSize: number;
    };
}
export type PaginationOpts = {
    page?: number;
    pageSize?: number;
};
export interface ClientOpts {
    baseUrl?: string;
    /**
     * Custom fetch implementation
     *
     * @default fetch
     */
    fetch?: Config["fetch"];
    /**
     * Additional headers to send with each request
     */
    headers?: Record<string, string>;
    /**
     * Optional OpenTelemetry tracer for instrumenting SDK operations
     */
    tracer?: Tracer;
}
export declare const DEFAULT_SUBSCRIPTIONS: {
    client: {
        status: boolean;
    };
    file: {
        status: boolean;
        selection: boolean;
        ot: boolean;
    };
    fs: {
        operations: boolean;
    };
    git: {
        status: boolean;
        operations: boolean;
    };
    port: {
        status: boolean;
    };
    setup: {
        progress: boolean;
    };
    shell: {
        status: boolean;
    };
    system: {
        metrics: boolean;
    };
};
export interface StartSandboxOpts {
    /**
     * Country, served as a hint on where you want the sandbox to be scheduled. For example, if "NL" is given
     * as a country, the sandbox will be scheduled in a cluster inside Europe. Note that this is not a guarantee,
     * and the sandbox might end up in a different region based on availability and scheduling decisions.
     *
     * Follows ISO 3166-1 alpha-2 codes.
     */
    ipcountry?: string;
    /**
     * Determines which specs to start the VM with. If not specified, the VM will start with the default specs for the workspace.
     * Check {@link VMTier} for available tiers.
     *
     * You can only specify a VM tier when starting a VM that is inside your workspace.
     * Specifying a VM tier for someone else's sandbox will return an error.
     */
    vmTier?: VMTier;
    /**
     * The amount of seconds to wait before hibernating the sandbox after inactivity.
     *
     * Defaults to 300 seconds for free users, 1800 seconds for pro users. Maximum is 86400 seconds (1 day).
     */
    hibernationTimeoutSeconds?: number;
    /**
     * Configuration for when the VM should automatically wake up from hibernation.
     */
    automaticWakeupConfig?: {
        /**
         * Whether the VM should automatically wake up on HTTP requests to hosts exposed (excludes WebSocket requests)
         *
         * @default true
         */
        http: boolean;
        /**
         * Whether the VM should automatically wake up on WebSocket connections to host exposed
         *
         * @default false
         */
        websocket: boolean;
    };
}
export type CreateSandboxBaseOpts = {
    /**
     * What the privacy of the new sandbox should be. Defaults to "public".
     */
    privacy?: SandboxPrivacy;
    /**
     * The title of the new sandbox.
     */
    title?: string;
    /**
     * The description of the new sandbox.
     */
    description?: string;
    /**
     * Which tags to add to the sandbox, can be used for categorization and filtering. Max 10 tags.
     */
    tags?: string[];
    /**
     * In which folder to put the sandbox in (inside your workspace).
     */
    path?: string;
};
export interface SessionCreateOptions {
    id?: string;
    permission?: "read" | "write";
    git?: {
        provider: string;
        username?: string;
        accessToken?: string;
        email: string;
        name?: string;
    };
    env?: Record<string, string>;
    hostToken?: HostToken;
}
export type SandboxSessionDTO = {
    sandboxId: string;
    pitcherToken: string;
    pitcherURL: string;
    userWorkspacePath: string;
};
export type CreateSandboxOpts = CreateSandboxBaseOpts & {
    /**
     * What template to fork from, this is the id of another sandbox. Defaults to our
     * [universal template](https://codesandbox.io/s/github/codesandbox/sandbox-templates/tree/main/universal).
     */
    id?: string;
};
export type SandboxOpts = {
    id: string;
    bootupType: PitcherManagerResponse["bootupType"];
    cluster: string;
    isUpToDate: boolean;
};
export type SandboxSession = PitcherManagerResponse & {
    isPint: boolean;
    sandboxId: string;
    sessionId?: string;
    hostToken?: HostToken;
};