@burdenoff/sdk-libs 2026.529.1 → 2026.627.1

package/dist/modules/sandbox/index.d.cts

@@ -0,0 +1,403 @@
+import { J as Json, S as SdkModule } from '../../module-JDbvil5h.cjs';
+import 'graphql-request';
+
+type SandboxTemplate = 'AI_BUILDER' | 'WORKFLOW_MULTI_NODE' | 'MISC_SHELL' | 'CUSTOM' | 'VIBECONTROLS';
+type SandboxStatus = 'PENDING' | 'PROVISIONING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'EXPIRED' | 'FAILED';
+type SandboxMode = 'DEPLOYMENT' | 'JOB';
+type StorageMode = 'NONE' | 'EPHEMERAL' | 'PERSISTENT';
+interface ContainerPort {
+    containerPort: number;
+    name?: string | null;
+    protocol?: string | null;
+}
+interface EnvVar {
+    name: string;
+    value: string;
+}
+interface ContainerResources {
+    requestsCpu?: string | null;
+    requestsMemory?: string | null;
+    limitsCpu?: string | null;
+    limitsMemory?: string | null;
+}
+interface ContainerSpec {
+    name: string;
+    image: string;
+    ports?: ContainerPort[];
+    env?: EnvVar[];
+    command?: string[];
+    args?: string[];
+    resources?: ContainerResources;
+}
+interface ContainerStatus {
+    name: string;
+    ready: boolean;
+    port?: number | null;
+    restartCount?: number | null;
+}
+interface SandboxStorage {
+    mode: StorageMode;
+    sizeGi?: number | null;
+    mountPath?: string | null;
+    retainOnDelete: boolean;
+}
+interface SandboxResources {
+    cpuRequest: string;
+    cpuLimit: string;
+    memoryRequest: string;
+    memoryLimit: string;
+}
+interface SandboxNetwork {
+    exposeService: boolean;
+    internalUrl?: string | null;
+    containerUrls?: Json;
+    serviceName?: string | null;
+}
+interface Sandbox {
+    id: string;
+    name: string;
+    description?: string | null;
+    template: SandboxTemplate;
+    mode: SandboxMode;
+    status: SandboxStatus;
+    crdName?: string | null;
+    podName?: string | null;
+    namespace: string;
+    runtimeClass: string;
+    containers: ContainerSpec[];
+    containerStatuses?: ContainerStatus[];
+    resources: SandboxResources;
+    storage: SandboxStorage;
+    network: SandboxNetwork;
+    ttlSeconds: number;
+    expiresAt: string;
+    metadata?: Json;
+    errorMessage?: string | null;
+    workspaceId: string;
+    context?: Json;
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+    stoppedAt?: string | null;
+}
+interface SandboxList {
+    items: Sandbox[];
+    total: number;
+    hasMore: boolean;
+}
+interface SandboxFilterInput {
+    template?: SandboxTemplate;
+    status?: SandboxStatus;
+    workspaceId?: string;
+}
+interface SandboxPaginationInput {
+    limit?: number;
+    offset?: number;
+    page?: number;
+}
+interface SandboxStats {
+    activeSandboxes: number;
+    totalCreated: number;
+    totalDeleted: number;
+    runningNow: number;
+    provisioningNow: number;
+    stoppedNow: number;
+    expiredCount: number;
+    failedCount: number;
+    totalCpuUsed: string;
+    totalMemoryUsed: string;
+}
+interface SandboxConfig {
+    id: string;
+    defaultTtlSeconds: number;
+    maxTtlSeconds: number;
+    allowedTemplates: SandboxTemplate[];
+    maxConcurrentPerUser: number;
+    maxConcurrentPerWorkspace: number;
+    defaultCpuRequest: string;
+    defaultCpuLimit: string;
+    defaultMemoryRequest: string;
+    defaultMemoryLimit: string;
+    workspaceId: string;
+    updatedAt: string;
+}
+interface SandboxTemplateConfig {
+    id: string;
+    name: string;
+    description?: string | null;
+    template: SandboxTemplate;
+    isDefault: boolean;
+    containers: ContainerSpec[];
+    resources: SandboxResources;
+    storage: SandboxStorage;
+    ttlSeconds: number;
+    config?: Json;
+    metadata?: Json;
+    allowedImages?: string[];
+    workspaceId: string;
+    context?: Json;
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface SandboxTemplateConfigList {
+    items: SandboxTemplateConfig[];
+    total: number;
+    hasMore: boolean;
+}
+interface ContainerPortInput {
+    containerPort: number;
+    name?: string;
+    protocol?: string;
+}
+interface EnvVarInput {
+    name: string;
+    value: string;
+}
+interface ContainerResourcesInput {
+    requestsCpu?: string;
+    requestsMemory?: string;
+    limitsCpu?: string;
+    limitsMemory?: string;
+}
+interface ContainerSpecInput {
+    name: string;
+    image: string;
+    ports?: ContainerPortInput[];
+    env?: EnvVarInput[];
+    command?: string[];
+    args?: string[];
+    resources?: ContainerResourcesInput;
+}
+interface SandboxStorageInput {
+    mode?: StorageMode;
+    sizeGi?: number;
+    mountPath?: string;
+    retainOnDelete?: boolean;
+}
+interface SandboxResourcesInput {
+    cpuRequest?: string;
+    cpuLimit?: string;
+    memoryRequest?: string;
+    memoryLimit?: string;
+}
+interface CreateSandboxInput {
+    name: string;
+    description?: string;
+    template: SandboxTemplate;
+    mode?: SandboxMode;
+    containers: ContainerSpecInput[];
+    resources?: SandboxResourcesInput;
+    storage?: SandboxStorageInput;
+    ttlSeconds?: number;
+    metadata?: Json;
+    context: {
+        workspaceId: string;
+    };
+    templateId?: string;
+}
+interface CreateSandboxTemplateInput {
+    name: string;
+    description?: string;
+    template: SandboxTemplate;
+    isDefault?: boolean;
+    containers?: ContainerSpecInput[];
+    resources?: SandboxResourcesInput;
+    storage?: SandboxStorageInput;
+    ttlSeconds?: number;
+    config?: Json;
+    metadata?: Json;
+    allowedImages?: string[];
+    context: {
+        workspaceId: string;
+    };
+}
+interface UpdateSandboxTemplateInput {
+    id: string;
+    name?: string;
+    description?: string;
+    isDefault?: boolean;
+    containers?: ContainerSpecInput[];
+    resources?: SandboxResourcesInput;
+    storage?: SandboxStorageInput;
+    ttlSeconds?: number;
+    config?: Json;
+    metadata?: Json;
+    allowedImages?: string[];
+    context: {
+        workspaceId: string;
+    };
+}
+interface UpdateSandboxConfigInput {
+    defaultTtlSeconds?: number;
+    maxTtlSeconds?: number;
+    allowedTemplates?: SandboxTemplate[];
+    maxConcurrentPerUser?: number;
+    maxConcurrentPerWorkspace?: number;
+    defaultCpuRequest?: string;
+    defaultCpuLimit?: string;
+    defaultMemoryRequest?: string;
+    defaultMemoryLimit?: string;
+    context: {
+        workspaceId: string;
+    };
+}
+interface SandboxAvailableTag {
+    id: string;
+    key: string;
+    label: string;
+    color?: string | null;
+}
+interface SandboxTagAssignment {
+    id: string;
+    entityId: string;
+    entityType: string;
+    tagId: string;
+    source: string;
+    assignedAt?: string | null;
+    assignedBy?: string | null;
+    validFrom?: string | null;
+    validTo?: string | null;
+    metadata?: Json;
+    tag?: {
+        id: string;
+    } | null;
+}
+interface CreateSandboxTagInput {
+    label: string;
+    color?: string;
+}
+interface GetSandboxTagsInput {
+    sandboxId: string;
+}
+interface TagSandboxInput {
+    sandboxId: string;
+    tagId: string;
+    source?: string;
+    validFrom?: string;
+    validTo?: string;
+    metadata?: Json;
+}
+interface UntagSandboxInput {
+    sandboxId: string;
+    tagId: string;
+}
+interface ReplaceSandboxTagsInput {
+    sandboxId: string;
+    tagIds: string[];
+}
+interface SandboxNodeInfo {
+    name: string;
+    status: string;
+    allocatableCpu: string;
+    allocatableMemory: string;
+    sandboxPodCount: number;
+    labels?: Json;
+}
+interface SandboxActivity {
+    id: string;
+    action: string;
+    actorId: string;
+    status: string;
+    sandboxName: string;
+    sandboxId?: string | null;
+    createdAt: string;
+}
+interface SandboxActivityList {
+    items: SandboxActivity[];
+    total: number;
+}
+type SandboxExportFormat = 'CSV' | 'JSON';
+type SandboxExportJobStatus = 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+interface SandboxExportJob {
+    id: string;
+    workspaceId: string;
+    format: SandboxExportFormat;
+    status: SandboxExportJobStatus;
+    requestedBy: string;
+    rowCount?: number | null;
+    downloadUrl?: string | null;
+    errorMessage?: string | null;
+    expiresAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ExportSandboxesInput {
+    workspaceId: string;
+    format: SandboxExportFormat;
+    filter?: SandboxFilterInput;
+    includeUsageEvents?: boolean;
+    context: {
+        workspaceId: string;
+    };
+}
+interface SandboxArtifactBytes {
+    filename: string;
+    mimeType: string;
+    size: number;
+    contentBase64: string;
+}
+interface SandboxArtifactBytesInput {
+    sandboxId: string;
+    sessionId: string;
+    path: string;
+    onBehalfOfUserId?: string;
+    context?: {
+        workspaceId: string;
+    };
+}
+interface ProxySandboxRequestInput {
+    sandboxId: string;
+    method: string;
+    path: string;
+    body?: Json;
+    containerName?: string;
+    context: {
+        workspaceId: string;
+    };
+}
+interface ProxySandboxResponse {
+    status: number;
+    body?: Json;
+}
+
+interface SandboxContext {
+    workspaceId: string;
+}
+interface SandboxApi {
+    list(filter: SandboxFilterInput | undefined, pagination: SandboxPaginationInput | undefined, context: SandboxContext): Promise<SandboxList>;
+    get(id: string, context: SandboxContext): Promise<Sandbox | null>;
+    create(input: CreateSandboxInput): Promise<Sandbox>;
+    delete(id: string, context: SandboxContext): Promise<boolean>;
+    start(id: string, context: SandboxContext): Promise<Sandbox>;
+    stop(id: string, context: SandboxContext): Promise<Sandbox>;
+    extendTTL(id: string, additionalSeconds: number, context: SandboxContext): Promise<Sandbox>;
+    getLogs(id: string, containerName: string, context: SandboxContext, tailLines?: number): Promise<string>;
+    getStats(context: SandboxContext): Promise<SandboxStats>;
+    getConfig(context: SandboxContext): Promise<SandboxConfig>;
+    updateConfig(input: UpdateSandboxConfigInput): Promise<SandboxConfig>;
+    listTemplates(context: SandboxContext, template?: SandboxTemplate, pagination?: SandboxPaginationInput): Promise<SandboxTemplateConfigList>;
+    getTemplate(id: string, context: SandboxContext): Promise<SandboxTemplateConfig | null>;
+    createTemplate(input: CreateSandboxTemplateInput): Promise<SandboxTemplateConfig>;
+    updateTemplate(input: UpdateSandboxTemplateInput): Promise<SandboxTemplateConfig>;
+    deleteTemplate(id: string, context: SandboxContext): Promise<boolean>;
+    availableTags(query?: string, limit?: number): Promise<SandboxAvailableTag[]>;
+    getTags(input: GetSandboxTagsInput): Promise<SandboxTagAssignment[]>;
+    createTag(input: CreateSandboxTagInput): Promise<SandboxAvailableTag>;
+    tag(input: TagSandboxInput): Promise<SandboxTagAssignment>;
+    untag(input: UntagSandboxInput): Promise<boolean>;
+    replaceTags(input: ReplaceSandboxTagsInput): Promise<SandboxTagAssignment[]>;
+    listAll(context: SandboxContext, filter?: SandboxFilterInput, pagination?: SandboxPaginationInput): Promise<SandboxList>;
+    listNodes(context: SandboxContext): Promise<SandboxNodeInfo[]>;
+    getActive(context: SandboxContext): Promise<Sandbox[]>;
+    getRecentActivity(context: SandboxContext, limit?: number): Promise<SandboxActivityList>;
+    exportSandboxes(input: ExportSandboxesInput): Promise<SandboxExportJob>;
+    getExportJob(workspaceId: string, jobId: string, context: SandboxContext): Promise<SandboxExportJob>;
+    listExportJobs(workspaceId: string, context: SandboxContext, pagination?: SandboxPaginationInput): Promise<SandboxExportJob[]>;
+    getArtifactBytes(input: SandboxArtifactBytesInput): Promise<SandboxArtifactBytes>;
+    proxyRequest(input: ProxySandboxRequestInput): Promise<ProxySandboxResponse>;
+}
+
+declare const sandboxModule: SdkModule<SandboxApi>;
+
+export { type ContainerPort, type ContainerPortInput, type ContainerResources, type ContainerResourcesInput, type ContainerSpec, type ContainerSpecInput, type ContainerStatus, type CreateSandboxInput, type CreateSandboxTagInput, type CreateSandboxTemplateInput, type EnvVar, type EnvVarInput, type ExportSandboxesInput, type GetSandboxTagsInput, type ProxySandboxRequestInput, type ProxySandboxResponse, type ReplaceSandboxTagsInput, type Sandbox, type SandboxActivity, type SandboxActivityList, type SandboxApi, type SandboxArtifactBytes, type SandboxArtifactBytesInput, type SandboxAvailableTag, type SandboxConfig, type SandboxContext, type SandboxExportFormat, type SandboxExportJob, type SandboxExportJobStatus, type SandboxFilterInput, type SandboxList, type SandboxMode, type SandboxNetwork, type SandboxNodeInfo, type SandboxPaginationInput, type SandboxResources, type SandboxResourcesInput, type SandboxStats, type SandboxStatus, type SandboxStorage, type SandboxStorageInput, type SandboxTagAssignment, type SandboxTemplate, type SandboxTemplateConfig, type SandboxTemplateConfigList, type StorageMode, type TagSandboxInput, type UntagSandboxInput, type UpdateSandboxConfigInput, type UpdateSandboxTemplateInput, sandboxModule as default };