@deepagents/context 2.1.0 → 2.3.0

package/dist/lib/sandbox/container-tool.d.ts

@@ -1,190 +0,0 @@
-import type { CreateBashToolOptions } from 'bash-tool';
-import { type DockerResources, type DockerSandboxVolume } from './docker-sandbox.ts';
-import type { Installer } from './installers/installer.ts';
-import type { AgentSandbox, SkillUploadInput } from './types.ts';
-/**
- * Base options shared by RuntimeContainerToolOptions and DockerfileContainerToolOptions.
- */
-interface BaseContainerToolOptions extends Omit<CreateBashToolOptions, 'sandbox' | 'uploadDirectory'> {
-    /** Bind paths or Docker-managed volumes to attach to the container. */
-    volumes?: DockerSandboxVolume[];
-    /** Resource limits for the container */
-    resources?: DockerResources;
-    /** Environment variables to set in the container */
-    env?: Record<string, string>;
-    /**
-     * Skill directories to upload into the container at startup. Each entry's
-     * contents are copied to `sandbox` and parsed into `sandbox.skills`.
-     */
-    skills?: SkillUploadInput[];
-    /**
-     * Stable container name suffix. When set, the container is named
-     * `sandbox-<name>`; subsequent calls with the same `name` attach to the
-     * running (or stopped) container instead of creating a new one — skipping
-     * installers, volume setup, and env. Otherwise a randomized
-     * `sandbox-<8hex>` name is used per call.
-     */
-    name?: string;
-}
-/**
- * Options for container tool using RuntimeStrategy.
- * Installs packages/binaries at container runtime.
- */
-export interface RuntimeContainerToolOptions extends BaseContainerToolOptions {
-    /** Docker image to use (default: 'alpine:latest') */
-    image?: string;
-    /**
-     * Ordered list of installers run after the container starts.
-     *
-     * Built-in factory helpers:
-     * - `pkg([...])` — OS packages (apk/apt-get auto-detected)
-     * - `urlBinary({ name, url, binaryPath? })` — pre-built binary from a URL
-     * - `npm(name, { ensureRuntime?, version? })` — global npm install
-     * - `pip(name, { ensureRuntime?, version? })` — pip install
-     * - `githubRelease({ owner, repo, version, name, asset })` — GitHub release asset
-     *
-     * For anything else, subclass `Installer` and pass an instance directly.
-     *
-     * @example
-     * ```ts
-     * import { pkg, urlBinary, npm } from '@deepagents/context';
-     *
-     * createContainerTool({
-     *   installers: [
-     *     pkg(['curl', 'jq']),
-     *     npm('prettier', { ensureRuntime: true }),
-     *   ],
-     * });
-     * ```
-     */
-    installers?: Installer[];
-}
-/**
- * Options for container tool using DockerfileStrategy.
- * Builds custom image from Dockerfile (with caching).
- */
-export interface DockerfileContainerToolOptions extends BaseContainerToolOptions {
-    /** Dockerfile content (if contains newlines) or path to Dockerfile */
-    dockerfile: string;
-    /** Build context directory (default: '.') */
-    context?: string;
-}
-/**
- * Options for container tool using ComposeStrategy.
- * Manages multi-container environments via Docker Compose.
- */
-export interface ComposeContainerToolOptions extends Omit<CreateBashToolOptions, 'sandbox' | 'uploadDirectory'> {
-    /** Path to docker-compose.yml file */
-    compose: string;
-    /** Service name to execute commands in (required) */
-    service: string;
-    /** Resource limits for the container */
-    resources?: DockerResources;
-    /**
-     * Skill directories to upload into the container at startup. Each entry's
-     * contents are copied to `sandbox` and parsed into `sandbox.skills`.
-     */
-    skills?: SkillUploadInput[];
-}
-/**
- * Union type for container tool options.
- * - RuntimeContainerToolOptions: Runtime package/binary installation
- * - DockerfileContainerToolOptions: Pre-built images from Dockerfile
- * - ComposeContainerToolOptions: Multi-container environments via Docker Compose
- */
-export type ContainerToolOptions = RuntimeContainerToolOptions | DockerfileContainerToolOptions | ComposeContainerToolOptions;
-/**
- * Creates a bash tool that runs in a Docker container.
- *
- * This is a high-level wrapper that combines `createDockerSandbox()` and
- * `createBashTool()` into a single call. It provides a convenient way to
- * get a bash tool that executes real binaries in an isolated container.
- *
- * Supports three strategies:
- * - **RuntimeStrategy**: Uses existing image, installs packages/binaries at runtime
- * - **DockerfileStrategy**: Builds custom image from Dockerfile (with caching)
- * - **ComposeStrategy**: Multi-container environments via Docker Compose
- *
- * The optional `skills` input makes the sandbox the single source of truth for
- * skills: files are uploaded into the container and `sandbox.skills` is
- * populated from on-disk `SKILL.md` frontmatter.
- *
- * @example RuntimeStrategy (default)
- * ```typescript
- * import { createContainerTool, pkg } from '@deepagents/context';
- *
- * const sandbox = await createContainerTool({
- *   installers: [pkg(['curl', 'jq'])],
- *   volumes: [{
- *     type: 'bind',
- *     hostPath: process.cwd(),
- *     containerPath: '/workspace',
- *     readOnly: false,
- *   }],
- * });
- *
- * // Use with AI SDK
- * const response = await generateText({
- *   model: yourModel,
- *   tools: sandbox.tools,
- *   prompt: 'Fetch the weather data and parse it with jq',
- * });
- *
- * // Clean up when done
- * await sandbox.sandbox.dispose();
- * ```
- *
- * @example RuntimeStrategy with skills
- * ```typescript
- * const sandbox = await createContainerTool({
- *   installers: [pkg(['curl', 'jq'])],
- *   skills: [
- *     { host: './skills', sandbox: '/workspace/skills' },
- *   ],
- * });
- *
- * context.set(role('...'), skills(sandbox));
- * ```
- *
- * @example DockerfileStrategy
- * ```typescript
- * const sandbox = await createContainerTool({
- *   dockerfile: `
- *     FROM python:3.11-slim
- *     RUN pip install pandas numpy
- *   `,
- *   context: '.',
- *   volumes: [{
- *     type: 'bind',
- *     hostPath: process.cwd(),
- *     containerPath: '/workspace',
- *   }],
- * });
- * ```
- *
- * @example ComposeStrategy
- * ```typescript
- * const sandbox = await createContainerTool({
- *   compose: './docker-compose.yml',
- *   service: 'app',
- * });
- * // Commands run in the 'app' service, can reach other services by name
- * await sandbox.sandbox.dispose();  // Stops ALL services
- * ```
- *
- * @example With hooks for logging
- * ```typescript
- * const sandbox = await createContainerTool({
- *   installers: [pkg(['python3'])],
- *   onBeforeBashCall: ({ command }) => {
- *     console.log('Running:', command);
- *   },
- *   onAfterBashCall: ({ command, result }) => {
- *     console.log(`Exit code: ${result.exitCode}`);
- *   },
- * });
- * ```
- */
-export declare function createContainerTool(options?: ContainerToolOptions): Promise<AgentSandbox>;
-export {};
-//# sourceMappingURL=container-tool.d.ts.map

package/dist/lib/sandbox/container-tool.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"container-tool.d.ts","sourceRoot":"","sources":["../../../src/lib/sandbox/container-tool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAGvD,OAAO,EACL,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EAIzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEjE;;GAEG;AACH,UAAU,wBAAyB,SAAQ,IAAI,CAC7C,qBAAqB,EACrB,SAAS,GAAG,iBAAiB,CAC9B;IACC,uEAAuE;IACvE,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAChC,wCAAwC;IACxC,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,oDAAoD;IACpD,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC5B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,wBAAwB;IAC3E,qDAAqD;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,wBAAwB;IAC9E,sEAAsE;IACtE,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,IAAI,CACvD,qBAAqB,EACrB,SAAS,GAAG,iBAAiB,CAC9B;IACC,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B;;;OAGG;IACH,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAC5B,2BAA2B,GAC3B,8BAA8B,GAC9B,2BAA2B,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,wBAAsB,mBAAmB,CACvC,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,YAAY,CAAC,CAuDvB"}