@anvia/sandbox 0.3.6 → 0.4.0

package/dist/index.d.ts

@@ -31,12 +31,27 @@ interface SandboxSession {
     listFiles(path?: string): Promise<SandboxFileEntry[]>;
     destroy(): Promise<void>;
 }
+interface SandboxPortSession extends SandboxSession {
+    readonly publishedPorts: readonly SandboxPublishedPort[];
+    waitForPort(containerPort: number, options?: SandboxWaitForPortOptions): Promise<SandboxPublishedPort>;
+}
+interface SandboxProcessSession extends SandboxSession {
+    startProcess(options: SandboxProcessStartOptions): Promise<SandboxProcessInfo>;
+    listProcesses(): Promise<SandboxProcessInfo[]>;
+    readProcessLogs(processId: string, options?: SandboxProcessLogsOptions): Promise<SandboxProcessLogs>;
+    stopProcess(processId: string, options?: SandboxProcessStopOptions): Promise<SandboxProcessInfo>;
+}
+interface DockerSandboxSession extends SandboxPortSession, SandboxProcessSession {
+}
 interface SandboxCreateSessionOptions {
     id?: string;
     workspace?: SandboxWorkspaceOptions;
     manifest?: SandboxManifest;
     metadata?: Record<string, string>;
 }
+interface DockerSandboxCreateSessionOptions extends SandboxCreateSessionOptions {
+    ports?: readonly number[];
+}
 interface SandboxManifest {
     files?: Record<string, string | Uint8Array>;
     directories?: string[];
@@ -49,6 +64,7 @@ interface SandboxLimits {
     memoryMb?: number;
     cpus?: number;
     pidsLimit?: number;
+    maxProcesses?: number;
 }
 interface SandboxExecOptions {
     command: string;
@@ -88,6 +104,46 @@ interface SandboxFileEntry {
     type: SandboxFileType;
     size?: number;
 }
+interface SandboxPublishedPort {
+    containerPort: number;
+    host: "127.0.0.1";
+    hostPort: number;
+    protocol: "tcp";
+}
+interface SandboxWaitForPortOptions {
+    timeoutMs?: number;
+    intervalMs?: number;
+    signal?: AbortSignal;
+}
+interface SandboxProcessStartOptions {
+    command: string;
+    args?: string[];
+    cwd?: string;
+    env?: Record<string, string>;
+}
+type SandboxProcessStatus = "running" | "exited" | "stopped";
+interface SandboxProcessInfo {
+    id: string;
+    command: string;
+    args: string[];
+    cwd?: string;
+    status: SandboxProcessStatus;
+    exitCode?: number;
+    startedAt: string;
+    endedAt?: string;
+}
+interface SandboxProcessLogsOptions {
+    tailBytes?: number;
+}
+interface SandboxProcessLogs {
+    stdout: string;
+    stderr: string;
+    stdoutTruncated: boolean;
+    stderrTruncated: boolean;
+}
+interface SandboxProcessStopOptions {
+    gracePeriodMs?: number;
+}
 interface DockerSandboxSecurityOptions {
     readonlyRootfs?: boolean;
     noNewPrivileges?: boolean;
@@ -141,8 +197,9 @@ interface SandboxToolsOptions {
     exec?: SandboxExecToolPolicy;
     readFile?: SandboxFileToolPolicy;
     writeFile?: SandboxFileToolPolicy;
+    process?: SandboxProcessToolPolicy;
 }
-type SandboxToolName = "exec_command" | "read_file" | "write_file" | "list_files";
+type SandboxToolName = "exec_command" | "read_file" | "write_file" | "list_files" | "list_ports" | "start_process" | "list_processes" | "read_process_logs" | "stop_process" | "wait_for_port";
 interface SandboxExecToolPolicy {
     allowedCommands?: string[];
     blockedCommands?: string[];
@@ -152,8 +209,17 @@ interface SandboxExecToolPolicy {
 interface SandboxFileToolPolicy {
     maxBytes?: number;
 }
+interface SandboxProcessToolPolicy {
+    maxLogBytes?: number;
+    defaultWaitTimeoutMs?: number;
+    maxWaitTimeoutMs?: number;
+    stopGracePeriodMs?: number;
+}
 type SandboxToolsFactory = (session: SandboxSession, options?: SandboxToolsOptions) => AnyTool[];
 
+declare function isSandboxPortSession(session: SandboxSession): session is SandboxPortSession;
+declare function isSandboxProcessSession(session: SandboxSession): session is SandboxProcessSession;
+
 declare class DockerSandbox implements Sandbox {
     readonly provider = "docker";
     private readonly image;
@@ -172,10 +238,12 @@ declare class DockerSandbox implements Sandbox {
     static node(options?: DockerSandboxOptions): DockerSandbox;
     static python(options?: DockerSandboxOptions): DockerSandbox;
     static deno(options?: DockerSandboxOptions): DockerSandbox;
-    createSession(options?: SandboxCreateSessionOptions): Promise<SandboxSession>;
+    createSession(options?: DockerSandboxCreateSessionOptions): Promise<DockerSandboxSession>;
     private ensureImage;
     private createRunArgs;
     private appendNetworkArgs;
+    private assertPortNetworkCompatible;
+    private inspectPublishedPorts;
     private appendLimitArgs;
     private appendSecurityArgs;
     private cliOptions;
@@ -210,7 +278,11 @@ declare class SandboxFileSizeError extends SandboxError {
 }
 declare class SandboxToolPolicyError extends SandboxError {
 }
+declare class SandboxPortError extends SandboxError {
+}
+declare class SandboxProcessError extends SandboxError {
+}
 
 declare function createSandboxTools(session: SandboxSession, options?: SandboxToolsOptions): AnyTool[];
 
-export { DockerSandbox, type DockerSandboxNetworkOptions, type DockerSandboxOptions, type DockerSandboxSecurityOptions, type Sandbox, type SandboxCreateSessionOptions, SandboxDockerCommandError, SandboxDockerUnavailableError, SandboxError, type SandboxExecEndEvent, type SandboxExecEvent, type SandboxExecOptions, type SandboxExecResult, type SandboxExecStreamEvent, type SandboxExecToolPolicy, type SandboxFileEntry, SandboxFileSizeError, type SandboxFileToolPolicy, type SandboxFileType, type SandboxFileWriteEvent, type SandboxHooks, type SandboxLifecycleOptions, type SandboxLimits, type SandboxManifest, type SandboxNetworkMode, SandboxPathError, type SandboxSession, SandboxSessionDestroyedError, type SandboxSessionEvent, SandboxTimeoutError, type SandboxToolName, SandboxToolPolicyError, type SandboxToolsFactory, type SandboxToolsOptions, type SandboxWorkspaceOptions, createSandboxTools };
+export { DockerSandbox, type DockerSandboxCreateSessionOptions, type DockerSandboxNetworkOptions, type DockerSandboxOptions, type DockerSandboxSecurityOptions, type DockerSandboxSession, type Sandbox, type SandboxCreateSessionOptions, SandboxDockerCommandError, SandboxDockerUnavailableError, SandboxError, type SandboxExecEndEvent, type SandboxExecEvent, type SandboxExecOptions, type SandboxExecResult, type SandboxExecStreamEvent, type SandboxExecToolPolicy, type SandboxFileEntry, SandboxFileSizeError, type SandboxFileToolPolicy, type SandboxFileType, type SandboxFileWriteEvent, type SandboxHooks, type SandboxLifecycleOptions, type SandboxLimits, type SandboxManifest, type SandboxNetworkMode, SandboxPathError, SandboxPortError, type SandboxPortSession, SandboxProcessError, type SandboxProcessInfo, type SandboxProcessLogs, type SandboxProcessLogsOptions, type SandboxProcessSession, type SandboxProcessStartOptions, type SandboxProcessStatus, type SandboxProcessStopOptions, type SandboxProcessToolPolicy, type SandboxPublishedPort, type SandboxSession, SandboxSessionDestroyedError, type SandboxSessionEvent, SandboxTimeoutError, type SandboxToolName, SandboxToolPolicyError, type SandboxToolsFactory, type SandboxToolsOptions, type SandboxWaitForPortOptions, type SandboxWorkspaceOptions, createSandboxTools, isSandboxPortSession, isSandboxProcessSession };