Skip to content

Secure, Fast, and Extensible Sandbox runtime for AI agents.

3.6 KB
Raw Blame
// Copyright 2026 The OpenSandbox Authors
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * INTERNAL / ADVANCED ENTRYPOINT
 *
 * This subpath exposes low-level OpenAPI clients and adapters for advanced integrations.
 * It is intentionally NOT exported from the root entrypoint (`@alibaba-group/opensandbox`),
 * because generated OpenAPI types are not considered stable public API.
 *
 * Import path:
 * - `@alibaba-group/opensandbox/internal`
 */

export { createLifecycleClient } from "./openapi/lifecycleClient.js";
export { createDiagnosticClient } from "./openapi/diagnosticClient.js";
export type { LifecycleClient } from "./openapi/lifecycleClient.js";
export { createExecdClient } from "./openapi/execdClient.js";
export type { ExecdClient } from "./openapi/execdClient.js";
export { createEgressClient } from "./openapi/egressClient.js";
export type { EgressClient } from "./openapi/egressClient.js";

// Data-plane header policy, shared with companion SDKs such as the code interpreter.
export { createDataPlaneHeaders } from "./factory/defaultAdapterFactory.js";

// OpenAPI schema types (NOT stable public API; internal-only).
export type { paths as LifecyclePaths } from "./api/lifecycle.js";
export type { paths as ExecdPaths } from "./api/execd.js";
export type { paths as EgressPaths } from "./api/egress.js";

export { SandboxesAdapter } from "./adapters/sandboxesAdapter.js";
export { EgressAdapter } from "./adapters/egressAdapter.js";
export type { EgressRawHttpOptions } from "./adapters/egressAdapter.js";
export { NetworkPolicyAdapter } from "./adapters/networkPolicyAdapter.js";
export { HealthAdapter } from "./adapters/healthAdapter.js";
export { MetricsAdapter } from "./adapters/metricsAdapter.js";
export { FilesystemAdapter } from "./adapters/filesystemAdapter.js";
export { CommandsAdapter } from "./adapters/commandsAdapter.js";
export { IsolatedSessionsAdapter } from "./adapters/isolatedSessionsAdapter.js";
export { IsolatedFilesystemAdapter } from "./adapters/isolatedFilesystemAdapter.js";
export { EndpointCache } from "./core/endpointCache.js";

// Cross-origin redirect protection helpers (advanced/testing).
export {
  createRedirectSafeFetch,
  hasProtectedHeaders,
  stripProtectedHeaders,
  stripCredentialHeaders,
  isSameOrigin,
  PROTECTED_HEADER_PREFIXES,
  CROSS_ORIGIN_CREDENTIAL_HEADERS,
} from "./config/redirectFetch.js";
export type { RedirectSafeFetchOptions } from "./config/redirectFetch.js";

// Client-IP detection helpers (advanced/testing).
export {
  detectOutboundIp,
  selectClientIp,
  getClientIp,
  ensureClientIpReady,
  withClientIp,
  _setClientIpForTest,
  _restartDetectionForTest,
  _resetClientIpCacheForTest,
} from "./config/clientIp.js";

// Wake retry contract (OSEP-0024) helpers (advanced/testing).
export {
  createWakeRetryFetch,
  parseRetryAfterMs,
  resolveWakeRetryAfterMs,
  isWakeTimeoutResponse,
  WAKE_MARKER_HEADER,
  WAKE_MARKER_VALUE,
  WAKE_DEFAULT_RETRY_AFTER_MS,
  RETRY_AFTER_CAP_MS,
} from "./config/wakeRetry.js";
export { validateIdlePolicy } from "./internal/idlePolicy.js";
export { validateRenewalPolicy } from "./internal/renewalPolicy.js";