computesdk 1.9.5 → 1.9.6

package/dist/index.d.mts

@@ -94,6 +94,75 @@ interface TypedProviderSandbox<TProvider extends Provider<any, any, any>> extend
     getInstance(): ExtractProviderSandboxType<TProvider>;
 }
 
+/**
+ * Unified Provider Configuration
+ *
+ * Single source of truth for all provider auth requirements.
+ * Used by both explicit mode (computesdk) and magic mode (workbench).
+ */
+/**
+ * Provider auth requirements
+ *
+ * Structure: { provider: [[option1_vars], [option2_vars], ...] }
+ * - Outer array: OR conditions (any option can satisfy auth)
+ * - Inner arrays: AND conditions (all vars in option must be present)
+ *
+ * Example: vercel: [['OIDC_TOKEN'], ['TOKEN', 'TEAM_ID', 'PROJECT_ID']]
+ *   -> Ready if OIDC_TOKEN is set, OR if all three traditional vars are set
+ */
+declare const PROVIDER_AUTH: {
+    readonly e2b: readonly [readonly ["E2B_API_KEY"]];
+    readonly modal: readonly [readonly ["MODAL_TOKEN_ID", "MODAL_TOKEN_SECRET"]];
+    readonly railway: readonly [readonly ["RAILWAY_API_KEY", "RAILWAY_PROJECT_ID", "RAILWAY_ENVIRONMENT_ID"]];
+    readonly daytona: readonly [readonly ["DAYTONA_API_KEY"]];
+    readonly vercel: readonly [readonly ["VERCEL_OIDC_TOKEN"], readonly ["VERCEL_TOKEN", "VERCEL_TEAM_ID", "VERCEL_PROJECT_ID"]];
+    readonly runloop: readonly [readonly ["RUNLOOP_API_KEY"]];
+    readonly cloudflare: readonly [readonly ["CLOUDFLARE_API_TOKEN", "CLOUDFLARE_ACCOUNT_ID"]];
+    readonly codesandbox: readonly [readonly ["CSB_API_KEY"]];
+    readonly blaxel: readonly [readonly ["BL_API_KEY", "BL_WORKSPACE"]];
+};
+/**
+ * All supported provider names (excluding gateway which is special)
+ */
+declare const PROVIDER_NAMES: ProviderName[];
+/**
+ * Provider name type derived from PROVIDER_AUTH
+ */
+type ProviderName = keyof typeof PROVIDER_AUTH;
+/**
+ * Header mapping for each provider
+ * Maps config field names to HTTP header names
+ */
+declare const PROVIDER_HEADERS: Record<ProviderName, Record<string, string>>;
+/**
+ * Environment variable to config field mapping for each provider
+ */
+declare const PROVIDER_ENV_MAP: Record<ProviderName, Record<string, string>>;
+/**
+ * Dashboard URLs for each provider (for error messages)
+ */
+declare const PROVIDER_DASHBOARD_URLS: Record<ProviderName, string>;
+/**
+ * Check if a provider name is valid
+ */
+declare function isValidProvider(name: string): name is ProviderName;
+/**
+ * Build headers from provider config
+ */
+declare function buildProviderHeaders(provider: ProviderName, config: Record<string, string | undefined>): Record<string, string>;
+/**
+ * Get provider config from environment variables
+ */
+declare function getProviderConfigFromEnv(provider: ProviderName): Record<string, string>;
+/**
+ * Check if provider has complete auth from environment
+ */
+declare function isProviderAuthComplete(provider: ProviderName): boolean;
+/**
+ * Get missing env vars for a provider (returns the option closest to completion)
+ */
+declare function getMissingEnvVars(provider: ProviderName): string[];
+
 /**
  * Common options for creating snapshots
  */
@@ -285,11 +354,64 @@ interface ModalProviderConfig {
 interface RailwayProviderConfig {
     /** Railway API token */
     apiToken?: string;
+    /** Railway project ID */
+    projectId?: string;
+    /** Railway environment ID */
+    environmentId?: string;
+}
+/**
+ * Daytona provider configuration for explicit compute mode
+ */
+interface DaytonaProviderConfig {
+    /** Daytona API key */
+    apiKey?: string;
+}
+/**
+ * Vercel provider configuration for explicit compute mode
+ */
+interface VercelProviderConfig {
+    /** Vercel OIDC token (preferred, simpler auth) */
+    oidcToken?: string;
+    /** Vercel API token (traditional auth) */
+    token?: string;
+    /** Vercel team ID (required with token) */
+    teamId?: string;
+    /** Vercel project ID (required with token) */
+    projectId?: string;
+}
+/**
+ * Runloop provider configuration for explicit compute mode
+ */
+interface RunloopProviderConfig {
+    /** Runloop API key */
+    apiKey?: string;
+}
+/**
+ * Cloudflare provider configuration for explicit compute mode
+ */
+interface CloudflareProviderConfig {
+    /** Cloudflare API token */
+    apiToken?: string;
+    /** Cloudflare account ID */
+    accountId?: string;
+}
+/**
+ * CodeSandbox provider configuration for explicit compute mode
+ */
+interface CodesandboxProviderConfig {
+    /** CodeSandbox API key */
+    apiKey?: string;
 }
 /**
- * Supported provider names for explicit compute mode
+ * Blaxel provider configuration for explicit compute mode
  */
-type ExplicitProviderName = 'e2b' | 'modal' | 'railway';
+interface BlaxelProviderConfig {
+    /** Blaxel API key */
+    apiKey?: string;
+    /** Blaxel workspace */
+    workspace?: string;
+}
+
 /**
  * Explicit compute configuration for callable compute()
  *
@@ -298,7 +420,7 @@ type ExplicitProviderName = 'e2b' | 'modal' | 'railway';
  */
 interface ExplicitComputeConfig {
     /** Provider name to use */
-    provider: ExplicitProviderName;
+    provider: ProviderName;
     /** ComputeSDK API key (required for gateway mode) */
     apiKey: string;
     /** E2B provider configuration */
@@ -307,6 +429,18 @@ interface ExplicitComputeConfig {
     modal?: ModalProviderConfig;
     /** Railway provider configuration */
     railway?: RailwayProviderConfig;
+    /** Daytona provider configuration */
+    daytona?: DaytonaProviderConfig;
+    /** Vercel provider configuration */
+    vercel?: VercelProviderConfig;
+    /** Runloop provider configuration */
+    runloop?: RunloopProviderConfig;
+    /** Cloudflare provider configuration */
+    cloudflare?: CloudflareProviderConfig;
+    /** CodeSandbox provider configuration */
+    codesandbox?: CodesandboxProviderConfig;
+    /** Blaxel provider configuration */
+    blaxel?: BlaxelProviderConfig;
 }
 /**
  * Callable compute type - works as both singleton and factory function
@@ -558,6 +692,7 @@ declare function autoConfigureCompute(): Provider | null;
  *
  * Default configuration values and provider definitions
  */
+
 /**
  * Default gateway URL for sandbox lifecycle operations
  */
@@ -569,7 +704,7 @@ declare const GATEWAY_URL = "https://gateway.computesdk.com";
 declare const PROVIDER_PRIORITY: readonly ["e2b", "railway", "daytona", "modal", "runloop", "vercel", "cloudflare", "codesandbox", "blaxel"];
 /**
  * Required environment variables for each provider
- * Used to detect which provider to use from environment
+ * @deprecated Use PROVIDER_AUTH from provider-config instead
  */
 declare const PROVIDER_ENV_VARS: {
     readonly e2b: readonly ["E2B_API_KEY"];
@@ -582,10 +717,6 @@ declare const PROVIDER_ENV_VARS: {
     readonly codesandbox: readonly ["CSB_API_KEY"];
     readonly blaxel: readonly ["BL_API_KEY", "BL_WORKSPACE"];
 };
-/**
- * Type for provider names
- */
-type ProviderName = keyof typeof PROVIDER_ENV_VARS;
 
 /**
  * Utility functions for ComputeSDK
@@ -670,4 +801,4 @@ interface HandleComputeRequestParams {
     provider: Provider;
 }
 
-export { type BaseProviderConfig, type CallableCompute, type ComputeAPI, type ComputeConfig, type ComputeRequest, type ComputeResponse, type CreateSandboxParams, type CreateSandboxParamsWithOptionalProvider, type CreateSnapshotOptions, type CreateTemplateOptions, type E2BProviderConfig, type ExplicitComputeConfig, type ExplicitProviderName, type ExtractProviderSandboxType, GATEWAY_URL, type GatewayConfig, type HandleComputeRequestParams, type ListSnapshotsOptions, type ListTemplatesOptions, type ModalProviderConfig, PROVIDER_ENV_VARS, PROVIDER_PRIORITY, type Provider, type ProviderConfig, type ProviderMode, type ProviderName, type ProviderSandbox, type ProviderSandboxManager, type ProviderSnapshotManager, type ProviderTemplateManager, type RailwayProviderConfig, type SandboxInfo, type SandboxMethods, type SnapshotMethods, type TemplateMethods, type TypedComputeAPI, type TypedProviderSandbox, autoConfigureCompute, calculateBackoff, compute, createCompute, createProvider, createProviderFromConfig, detectProvider, gateway, getProviderHeaders, handleComputeRequest, isGatewayModeEnabled };
+export { type BaseProviderConfig, type BlaxelProviderConfig, type CallableCompute, type CloudflareProviderConfig, type CodesandboxProviderConfig, type ComputeAPI, type ComputeConfig, type ComputeRequest, type ComputeResponse, type CreateSandboxParams, type CreateSandboxParamsWithOptionalProvider, type CreateSnapshotOptions, type CreateTemplateOptions, type DaytonaProviderConfig, type E2BProviderConfig, type ExplicitComputeConfig, type ProviderName as ExplicitProviderName, type ExtractProviderSandboxType, GATEWAY_URL, type GatewayConfig, type HandleComputeRequestParams, type ListSnapshotsOptions, type ListTemplatesOptions, type ModalProviderConfig, PROVIDER_AUTH, PROVIDER_DASHBOARD_URLS, PROVIDER_ENV_MAP, PROVIDER_ENV_VARS, PROVIDER_HEADERS, PROVIDER_NAMES, PROVIDER_PRIORITY, type Provider, type ProviderConfig, type ProviderMode, type ProviderName, type ProviderSandbox, type ProviderSandboxManager, type ProviderSnapshotManager, type ProviderTemplateManager, type RailwayProviderConfig, type RunloopProviderConfig, type SandboxInfo, type SandboxMethods, type SnapshotMethods, type TemplateMethods, type TypedComputeAPI, type TypedProviderSandbox, type VercelProviderConfig, autoConfigureCompute, buildProviderHeaders, calculateBackoff, compute, createCompute, createProvider, createProviderFromConfig, detectProvider, gateway, getMissingEnvVars, getProviderConfigFromEnv, getProviderHeaders, handleComputeRequest, isGatewayModeEnabled, isProviderAuthComplete, isValidProvider };

package/dist/index.d.ts

@@ -94,6 +94,75 @@ interface TypedProviderSandbox<TProvider extends Provider<any, any, any>> extend
     getInstance(): ExtractProviderSandboxType<TProvider>;
 }
 
+/**
+ * Unified Provider Configuration
+ *
+ * Single source of truth for all provider auth requirements.
+ * Used by both explicit mode (computesdk) and magic mode (workbench).
+ */
+/**
+ * Provider auth requirements
+ *
+ * Structure: { provider: [[option1_vars], [option2_vars], ...] }
+ * - Outer array: OR conditions (any option can satisfy auth)
+ * - Inner arrays: AND conditions (all vars in option must be present)
+ *
+ * Example: vercel: [['OIDC_TOKEN'], ['TOKEN', 'TEAM_ID', 'PROJECT_ID']]
+ *   -> Ready if OIDC_TOKEN is set, OR if all three traditional vars are set
+ */
+declare const PROVIDER_AUTH: {
+    readonly e2b: readonly [readonly ["E2B_API_KEY"]];
+    readonly modal: readonly [readonly ["MODAL_TOKEN_ID", "MODAL_TOKEN_SECRET"]];
+    readonly railway: readonly [readonly ["RAILWAY_API_KEY", "RAILWAY_PROJECT_ID", "RAILWAY_ENVIRONMENT_ID"]];
+    readonly daytona: readonly [readonly ["DAYTONA_API_KEY"]];
+    readonly vercel: readonly [readonly ["VERCEL_OIDC_TOKEN"], readonly ["VERCEL_TOKEN", "VERCEL_TEAM_ID", "VERCEL_PROJECT_ID"]];
+    readonly runloop: readonly [readonly ["RUNLOOP_API_KEY"]];
+    readonly cloudflare: readonly [readonly ["CLOUDFLARE_API_TOKEN", "CLOUDFLARE_ACCOUNT_ID"]];
+    readonly codesandbox: readonly [readonly ["CSB_API_KEY"]];
+    readonly blaxel: readonly [readonly ["BL_API_KEY", "BL_WORKSPACE"]];
+};
+/**
+ * All supported provider names (excluding gateway which is special)
+ */
+declare const PROVIDER_NAMES: ProviderName[];
+/**
+ * Provider name type derived from PROVIDER_AUTH
+ */
+type ProviderName = keyof typeof PROVIDER_AUTH;
+/**
+ * Header mapping for each provider
+ * Maps config field names to HTTP header names
+ */
+declare const PROVIDER_HEADERS: Record<ProviderName, Record<string, string>>;
+/**
+ * Environment variable to config field mapping for each provider
+ */
+declare const PROVIDER_ENV_MAP: Record<ProviderName, Record<string, string>>;
+/**
+ * Dashboard URLs for each provider (for error messages)
+ */
+declare const PROVIDER_DASHBOARD_URLS: Record<ProviderName, string>;
+/**
+ * Check if a provider name is valid
+ */
+declare function isValidProvider(name: string): name is ProviderName;
+/**
+ * Build headers from provider config
+ */
+declare function buildProviderHeaders(provider: ProviderName, config: Record<string, string | undefined>): Record<string, string>;
+/**
+ * Get provider config from environment variables
+ */
+declare function getProviderConfigFromEnv(provider: ProviderName): Record<string, string>;
+/**
+ * Check if provider has complete auth from environment
+ */
+declare function isProviderAuthComplete(provider: ProviderName): boolean;
+/**
+ * Get missing env vars for a provider (returns the option closest to completion)
+ */
+declare function getMissingEnvVars(provider: ProviderName): string[];
+
 /**
  * Common options for creating snapshots
  */
@@ -285,11 +354,64 @@ interface ModalProviderConfig {
 interface RailwayProviderConfig {
     /** Railway API token */
     apiToken?: string;
+    /** Railway project ID */
+    projectId?: string;
+    /** Railway environment ID */
+    environmentId?: string;
+}
+/**
+ * Daytona provider configuration for explicit compute mode
+ */
+interface DaytonaProviderConfig {
+    /** Daytona API key */
+    apiKey?: string;
+}
+/**
+ * Vercel provider configuration for explicit compute mode
+ */
+interface VercelProviderConfig {
+    /** Vercel OIDC token (preferred, simpler auth) */
+    oidcToken?: string;
+    /** Vercel API token (traditional auth) */
+    token?: string;
+    /** Vercel team ID (required with token) */
+    teamId?: string;
+    /** Vercel project ID (required with token) */
+    projectId?: string;
+}
+/**
+ * Runloop provider configuration for explicit compute mode
+ */
+interface RunloopProviderConfig {
+    /** Runloop API key */
+    apiKey?: string;
+}
+/**
+ * Cloudflare provider configuration for explicit compute mode
+ */
+interface CloudflareProviderConfig {
+    /** Cloudflare API token */
+    apiToken?: string;
+    /** Cloudflare account ID */
+    accountId?: string;
+}
+/**
+ * CodeSandbox provider configuration for explicit compute mode
+ */
+interface CodesandboxProviderConfig {
+    /** CodeSandbox API key */
+    apiKey?: string;
 }
 /**
- * Supported provider names for explicit compute mode
+ * Blaxel provider configuration for explicit compute mode
  */
-type ExplicitProviderName = 'e2b' | 'modal' | 'railway';
+interface BlaxelProviderConfig {
+    /** Blaxel API key */
+    apiKey?: string;
+    /** Blaxel workspace */
+    workspace?: string;
+}
+
 /**
  * Explicit compute configuration for callable compute()
  *
@@ -298,7 +420,7 @@ type ExplicitProviderName = 'e2b' | 'modal' | 'railway';
  */
 interface ExplicitComputeConfig {
     /** Provider name to use */
-    provider: ExplicitProviderName;
+    provider: ProviderName;
     /** ComputeSDK API key (required for gateway mode) */
     apiKey: string;
     /** E2B provider configuration */
@@ -307,6 +429,18 @@ interface ExplicitComputeConfig {
     modal?: ModalProviderConfig;
     /** Railway provider configuration */
     railway?: RailwayProviderConfig;
+    /** Daytona provider configuration */
+    daytona?: DaytonaProviderConfig;
+    /** Vercel provider configuration */
+    vercel?: VercelProviderConfig;
+    /** Runloop provider configuration */
+    runloop?: RunloopProviderConfig;
+    /** Cloudflare provider configuration */
+    cloudflare?: CloudflareProviderConfig;
+    /** CodeSandbox provider configuration */
+    codesandbox?: CodesandboxProviderConfig;
+    /** Blaxel provider configuration */
+    blaxel?: BlaxelProviderConfig;
 }
 /**
  * Callable compute type - works as both singleton and factory function
@@ -558,6 +692,7 @@ declare function autoConfigureCompute(): Provider | null;
  *
  * Default configuration values and provider definitions
  */
+
 /**
  * Default gateway URL for sandbox lifecycle operations
  */
@@ -569,7 +704,7 @@ declare const GATEWAY_URL = "https://gateway.computesdk.com";
 declare const PROVIDER_PRIORITY: readonly ["e2b", "railway", "daytona", "modal", "runloop", "vercel", "cloudflare", "codesandbox", "blaxel"];
 /**
  * Required environment variables for each provider
- * Used to detect which provider to use from environment
+ * @deprecated Use PROVIDER_AUTH from provider-config instead
  */
 declare const PROVIDER_ENV_VARS: {
     readonly e2b: readonly ["E2B_API_KEY"];
@@ -582,10 +717,6 @@ declare const PROVIDER_ENV_VARS: {
     readonly codesandbox: readonly ["CSB_API_KEY"];
     readonly blaxel: readonly ["BL_API_KEY", "BL_WORKSPACE"];
 };
-/**
- * Type for provider names
- */
-type ProviderName = keyof typeof PROVIDER_ENV_VARS;
 
 /**
  * Utility functions for ComputeSDK
@@ -670,4 +801,4 @@ interface HandleComputeRequestParams {
     provider: Provider;
 }
 
-export { type BaseProviderConfig, type CallableCompute, type ComputeAPI, type ComputeConfig, type ComputeRequest, type ComputeResponse, type CreateSandboxParams, type CreateSandboxParamsWithOptionalProvider, type CreateSnapshotOptions, type CreateTemplateOptions, type E2BProviderConfig, type ExplicitComputeConfig, type ExplicitProviderName, type ExtractProviderSandboxType, GATEWAY_URL, type GatewayConfig, type HandleComputeRequestParams, type ListSnapshotsOptions, type ListTemplatesOptions, type ModalProviderConfig, PROVIDER_ENV_VARS, PROVIDER_PRIORITY, type Provider, type ProviderConfig, type ProviderMode, type ProviderName, type ProviderSandbox, type ProviderSandboxManager, type ProviderSnapshotManager, type ProviderTemplateManager, type RailwayProviderConfig, type SandboxInfo, type SandboxMethods, type SnapshotMethods, type TemplateMethods, type TypedComputeAPI, type TypedProviderSandbox, autoConfigureCompute, calculateBackoff, compute, createCompute, createProvider, createProviderFromConfig, detectProvider, gateway, getProviderHeaders, handleComputeRequest, isGatewayModeEnabled };
+export { type BaseProviderConfig, type BlaxelProviderConfig, type CallableCompute, type CloudflareProviderConfig, type CodesandboxProviderConfig, type ComputeAPI, type ComputeConfig, type ComputeRequest, type ComputeResponse, type CreateSandboxParams, type CreateSandboxParamsWithOptionalProvider, type CreateSnapshotOptions, type CreateTemplateOptions, type DaytonaProviderConfig, type E2BProviderConfig, type ExplicitComputeConfig, type ProviderName as ExplicitProviderName, type ExtractProviderSandboxType, GATEWAY_URL, type GatewayConfig, type HandleComputeRequestParams, type ListSnapshotsOptions, type ListTemplatesOptions, type ModalProviderConfig, PROVIDER_AUTH, PROVIDER_DASHBOARD_URLS, PROVIDER_ENV_MAP, PROVIDER_ENV_VARS, PROVIDER_HEADERS, PROVIDER_NAMES, PROVIDER_PRIORITY, type Provider, type ProviderConfig, type ProviderMode, type ProviderName, type ProviderSandbox, type ProviderSandboxManager, type ProviderSnapshotManager, type ProviderTemplateManager, type RailwayProviderConfig, type RunloopProviderConfig, type SandboxInfo, type SandboxMethods, type SnapshotMethods, type TemplateMethods, type TypedComputeAPI, type TypedProviderSandbox, type VercelProviderConfig, autoConfigureCompute, buildProviderHeaders, calculateBackoff, compute, createCompute, createProvider, createProviderFromConfig, detectProvider, gateway, getMissingEnvVars, getProviderConfigFromEnv, getProviderHeaders, handleComputeRequest, isGatewayModeEnabled, isProviderAuthComplete, isValidProvider };