@openai/agents-core 0.8.5 → 0.9.1

package/dist/sandbox/sandboxes/unixLocal.d.ts

@@ -0,0 +1,95 @@
+import type { Editor } from '../../editor';
+import type { ToolOutputImage } from '../../tool';
+import { type ChildProcessWithoutNullStreams } from 'node:child_process';
+import type { SandboxClient, SandboxClientOptions, SandboxClientCreateArgs, SandboxConcurrencyLimits } from '../client';
+import { type ExposedPortEndpoint, type ExecCommandArgs, type ListDirectoryArgs, type MaterializeEntryArgs, type ReadFileArgs, type SandboxDirectoryEntry, type SandboxExecResult, type SandboxSession, type SandboxSessionState, type ViewImageArgs, type WriteStdinArgs } from '../session';
+import { Manifest } from '../manifest';
+import { type ResolveSandboxPathOptions } from '../workspacePaths';
+import type { LocalSandboxSnapshot, LocalSandboxSnapshotSpec } from './types';
+export interface UnixLocalSandboxClientOptions extends SandboxClientOptions {
+    workspaceBaseDir?: string;
+    snapshot?: LocalSandboxSnapshotSpec;
+    defaultShell?: string;
+    exposedPorts?: number[];
+    concurrencyLimits?: SandboxConcurrencyLimits;
+}
+export interface UnixLocalSandboxSessionState extends SandboxSessionState {
+    workspaceRootPath: string;
+    workspaceRootOwned: boolean;
+    environment: Record<string, string>;
+    snapshotSpec?: LocalSandboxSnapshotSpec | null;
+    snapshot?: LocalSandboxSnapshot | null;
+    snapshotFingerprint?: string | null;
+    snapshotFingerprintVersion?: string | null;
+    configuredExposedPorts?: number[];
+}
+type UnixRunAsIdentity = {
+    username: string;
+    uid: number;
+    gid: number;
+    isCurrentUser: boolean;
+};
+export declare class UnixLocalSandboxSession<TState extends UnixLocalSandboxSessionState = UnixLocalSandboxSessionState> implements SandboxSession<TState> {
+    readonly state: TState;
+    protected readonly defaultShell?: string;
+    private readonly activeProcesses;
+    private nextSessionId;
+    private closed;
+    constructor(args: {
+        state: TState;
+        defaultShell?: string;
+    });
+    createEditor(runAs?: string): Editor;
+    supportsPty(): boolean;
+    resolveExposedPort(port: number): Promise<ExposedPortEndpoint>;
+    execCommand(args: ExecCommandArgs): Promise<string>;
+    exec(args: ExecCommandArgs): Promise<SandboxExecResult>;
+    writeStdin(args: WriteStdinArgs): Promise<string>;
+    viewImage(args: ViewImageArgs): Promise<ToolOutputImage>;
+    pathExists(path: string, runAs?: string): Promise<boolean>;
+    readFile(args: ReadFileArgs): Promise<Uint8Array>;
+    listDir(args: ListDirectoryArgs): Promise<SandboxDirectoryEntry[]>;
+    materializeEntry(args: MaterializeEntryArgs): Promise<void>;
+    applyManifest(manifest: Manifest, runAs?: string): Promise<void>;
+    persistWorkspace(): Promise<Uint8Array>;
+    hydrateWorkspace(data: string | ArrayBuffer | Uint8Array): Promise<void>;
+    stop(): Promise<void>;
+    shutdown(): Promise<void>;
+    delete(): Promise<void>;
+    close(): Promise<void>;
+    private stopActiveProcesses;
+    resolveSandboxPath(path?: string, options?: ResolveSandboxPathOptions): string;
+    protected resolveCommandWorkdir(path?: string): string;
+    private resolveSandboxPathTarget;
+    private resolveLocalBindMountPath;
+    protected resolveLogicalPath(path?: string): string;
+    protected spawnShellCommand(command: string, args: {
+        cwd: string;
+        logicalCwd: string;
+        shell?: string;
+        login: boolean;
+        runAs?: string;
+        tty?: boolean;
+    }): Promise<ChildProcessWithoutNullStreams>;
+    protected translateCommandInput(command: string): string;
+    protected translateCommandOutput(output: string): string;
+    protected materializeRestoredWorkspaceMounts(): Promise<void>;
+    protected logicalWorkdirForPath(path?: string): string;
+    protected resolveCommandRunAs(runAs?: string): Promise<UnixRunAsIdentity | undefined>;
+    resolveFilesystemRunAs(runAs?: string): Promise<UnixRunAsIdentity | undefined>;
+    protected resolveRunAsIdentity(runAs?: string): Promise<UnixRunAsIdentity | undefined>;
+    private trackChildProcess;
+    private allocateProcessId;
+}
+export declare class UnixLocalSandboxClient implements SandboxClient<UnixLocalSandboxClientOptions, UnixLocalSandboxSessionState> {
+    readonly backendId = "unix_local";
+    readonly supportsDefaultOptions = true;
+    private readonly options;
+    constructor(options?: UnixLocalSandboxClientOptions);
+    create(args?: SandboxClientCreateArgs<UnixLocalSandboxClientOptions> | Manifest, manifestOptions?: UnixLocalSandboxClientOptions): Promise<UnixLocalSandboxSession>;
+    resume(state: UnixLocalSandboxSessionState): Promise<UnixLocalSandboxSession>;
+    serializeSessionState(state: UnixLocalSandboxSessionState): Promise<Record<string, unknown>>;
+    deserializeSessionState(state: Record<string, unknown>): Promise<UnixLocalSandboxSessionState>;
+    private restoreIfNeeded;
+}
+export {};