import {z} from 'zod' export type GetApiSandboxesArgs = {showTerminated?: boolean | undefined, cursor?: string | undefined, limit?: number | undefined, sort?: ('createdAt:desc' | 'createdAt:asc' | 'name:asc' | 'name:desc') | undefined, q?: string | undefined, anchor?: 'end' | undefined, externalId?: string | undefined}; export type GetApiSandboxesOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const coreEvent = z.object({canaryRevision: z.string().optional(), message: z.string().optional(), revision: z.string().optional(), status: z.string().optional(), time: z.string().optional(), type: z.string().optional()}); export const coreEvents = z.array(coreEvent); export const metadataLabels = z.record(z.string(), z.string()); export const metadata = z.object({createdAt: z.string().optional(), updatedAt: z.string().optional(), createdBy: z.string().optional(), updatedBy: z.string().optional(), displayName: z.string().optional(), externalId: z.string().optional(), labels: metadataLabels.optional(), name: z.string(), plan: z.string().optional(), url: z.string().optional(), workspace: z.string().optional()}); export const expirationPolicy = z.object({action: z.literal("delete").optional(), type: z.enum(["ttl-idle", "ttl-max-age", "date"]).optional(), value: z.string().optional()}); export const sandboxLifecycle = z.object({expirationPolicies: z.array(expirationPolicy).optional(), terminatedRetention: z.string().optional()}); export const egressPolicy = z.object({destinations: z.array(z.string()).optional(), mode: z.string().optional(), name: z.string().optional()}); export const egressConfig = z.object({gateway: z.string().optional(), mode: z.string().optional(), policies: z.array(egressPolicy).optional()}); export const firewallConfig = z.object({rulesets: z.array(z.string()).optional()}); export const proxyTarget = z.object({body: z.record(z.string(), z.string()).optional(), destinations: z.array(z.string()).optional(), headers: z.record(z.string(), z.string()).optional(), secrets: z.record(z.string(), z.string()).optional()}); export const proxyConfig = z.object({allowedDomains: z.array(z.string()).optional(), bypass: z.array(z.string()).optional(), forbiddenDomains: z.array(z.string()).optional(), routing: z.array(proxyTarget).optional()}); export const sandboxNetwork = z.object({allowedDomains: z.array(z.string()).optional(), egress: egressConfig.optional(), firewall: firewallConfig.optional(), forbiddenDomains: z.array(z.string()).optional(), proxy: proxyConfig.optional(), subnet: z.string().optional()}); export const env = z.object({name: z.string().optional(), secret: z.boolean().optional(), value: z.string().optional()}); export const port = z.object({name: z.string().optional(), protocol: z.enum(["HTTP", "TCP", "UDP", "TLS"]).optional(), target: z.number().int()}); export const ports = z.array(port); export const sandboxRuntime = z.object({envs: z.array(env).optional(), expires: z.string().optional(), extraArgs: z.record(z.string(), z.string()).optional(), image: z.string().optional(), memory: z.number().int().optional(), ports: ports.optional(), terminationGracePeriodSeconds: z.number().int().optional(), ttl: z.string().optional()}); export const volumeAttachment = z.object({mountPath: z.string().optional(), name: z.string().optional(), readOnly: z.boolean().optional()}); export const volumeAttachments = z.array(volumeAttachment); export const sandboxSpec = z.object({enabled: z.boolean().optional(), lifecycle: sandboxLifecycle.optional(), network: sandboxNetwork.optional(), region: z.string().optional(), runtime: sandboxRuntime.optional(), volumes: volumeAttachments.optional(), vpc: z.string().optional()}); export const status = z.enum(["DELETING", "TERMINATED", "FAILED", "DEACTIVATED", "DEACTIVATING", "UPLOADING", "BUILDING", "DEPLOYING", "DEPLOYED", "BUILT"]); export const sandbox = z.object({events: coreEvents.optional(), expiresIn: z.number().int().optional(), lastUsedAt: z.string().optional(), metadata: metadata, nodeGeneration: z.string().optional(), spec: sandboxSpec, state: z.enum(["RUNNING", "STANDBY"]).optional(), status: status.optional()}); export const paginationMeta = z.object({hasMore: z.boolean().optional(), nextCursor: z.string().optional(), total: z.number().int().optional()}); export const sandboxList = z.object({data: z.array(sandbox).optional(), meta: paginationMeta.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List sandboxes * * GET /sandboxes * * Also accepts auth: ApiKeyAuth */ export const getApiSandboxes = async (args: GetApiSandboxesArgs, options?: GetApiSandboxesOptions) => { const {baseUrl = "https://api.blaxel.ai/v0", fetch: fetchFn = fetch, OAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.showTerminated != null) query.append("showTerminated", String(args.showTerminated)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.q != null) query.append("q", String(args.q)) if (args.anchor != null) query.append("anchor", String(args.anchor)) if (args.externalId != null) query.append("externalId", String(args.externalId)) if (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/sandboxes${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(sandboxList, await res.json()) };