@robota-sdk/agent-tools 3.0.0-beta.60 → 3.0.0-beta.62

package/dist/node/index.d.cts

@@ -12,6 +12,167 @@ interface TToolResult {
     startLine?: number;
 }
 
+interface ISandboxRunOptions {
+    timeoutMs?: number;
+    workingDirectory?: string;
+}
+interface ISandboxRunResult {
+    stdout: string;
+    stderr?: string;
+    exitCode: number;
+}
+interface IWorkspaceManifestFileEntry {
+    type: 'file';
+    content: string;
+    encoding?: 'utf8';
+}
+interface IWorkspaceManifestDirectoryEntry {
+    type: 'dir';
+}
+interface IWorkspaceManifestLocalFileEntry {
+    type: 'localFile';
+    src: string;
+}
+interface IWorkspaceManifestLocalDirectoryEntry {
+    type: 'localDir';
+    src: string;
+}
+interface IWorkspaceManifestGitRepositoryEntry {
+    type: 'gitRepo';
+    url: string;
+    ref?: string;
+    shallow?: boolean;
+}
+interface IWorkspaceManifestS3MountEntry {
+    type: 's3Mount';
+    bucket: string;
+    prefix?: string;
+    region: string;
+}
+interface IWorkspaceManifestGcsMountEntry {
+    type: 'gcsMount';
+    bucket: string;
+    prefix?: string;
+}
+interface IWorkspaceManifestR2MountEntry {
+    type: 'r2Mount';
+    bucket: string;
+    accountId: string;
+    prefix?: string;
+}
+interface IWorkspaceManifestAzureBlobMountEntry {
+    type: 'azureBlobMount';
+    container: string;
+    account: string;
+    prefix?: string;
+}
+type TWorkspaceManifestEntry = IWorkspaceManifestFileEntry | IWorkspaceManifestDirectoryEntry | IWorkspaceManifestLocalFileEntry | IWorkspaceManifestLocalDirectoryEntry | IWorkspaceManifestGitRepositoryEntry | IWorkspaceManifestS3MountEntry | IWorkspaceManifestGcsMountEntry | IWorkspaceManifestR2MountEntry | IWorkspaceManifestAzureBlobMountEntry;
+interface IWorkspaceManifestPermissions {
+    read?: string[];
+    write?: string[];
+}
+interface IWorkspaceManifest {
+    entries: Record<string, TWorkspaceManifestEntry>;
+    environment?: Record<string, string>;
+    permissions?: IWorkspaceManifestPermissions;
+}
+interface IWorkspaceManifestApplyOptions {
+    targetRoot?: string;
+    hostRoot?: string;
+}
+type TWorkspaceManifestApplyStatus = 'applied' | 'unsupported';
+interface IWorkspaceManifestAppliedEntry {
+    path: string;
+    type: TWorkspaceManifestEntry['type'];
+    status: TWorkspaceManifestApplyStatus;
+    message?: string;
+}
+interface IWorkspaceManifestApplyResult {
+    entries: IWorkspaceManifestAppliedEntry[];
+}
+interface ISandboxClient {
+    run(command: string, options?: ISandboxRunOptions): Promise<ISandboxRunResult>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    applyManifest?(manifest: IWorkspaceManifest, options?: IWorkspaceManifestApplyOptions): Promise<IWorkspaceManifestApplyResult>;
+    /** Return a provider-owned resumable workspace reference. */
+    snapshot?(): Promise<string>;
+    /** Hydrate this client from a provider-owned workspace reference. */
+    restore?(snapshotId: string): Promise<void>;
+}
+interface ISandboxToolOptions {
+    sandboxClient?: ISandboxClient;
+}
+
+interface IE2BCommandStartOptions {
+    timeoutMs?: number;
+    cwd?: string;
+    background?: false;
+}
+interface IE2BCommandResult {
+    stdout?: string;
+    stderr?: string;
+    exitCode?: number;
+    exit_code?: number;
+}
+interface IE2BCommands {
+    run(command: string, options?: IE2BCommandStartOptions): Promise<IE2BCommandResult>;
+}
+interface IE2BFiles {
+    read(path: string): Promise<string | Uint8Array>;
+    write(path: string, content: string): Promise<void>;
+}
+interface IE2BSnapshot {
+    snapshotId?: string;
+    id?: string;
+}
+interface IE2BSandboxAdapter {
+    sandboxId?: string;
+    commands: IE2BCommands;
+    files: IE2BFiles;
+    pause?(): Promise<boolean | string | void>;
+    connect?(): Promise<IE2BSandboxAdapter>;
+    createSnapshot?(): Promise<IE2BSnapshot>;
+}
+interface IE2BSandboxClientOptions {
+    sandbox: IE2BSandboxAdapter;
+    connectSandbox?: (sandboxId: string) => Promise<IE2BSandboxAdapter>;
+    createSandboxFromSnapshot?: (snapshotId: string) => Promise<IE2BSandboxAdapter>;
+}
+declare class E2BSandboxClient implements ISandboxClient {
+    private sandbox;
+    private readonly connectSandbox?;
+    private readonly createSandboxFromSnapshot?;
+    constructor(options: IE2BSandboxClientOptions);
+    run(command: string, options?: ISandboxRunOptions): Promise<ISandboxRunResult>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    snapshot(): Promise<string>;
+    restore(snapshotId: string): Promise<void>;
+}
+
+type TInMemorySandboxRunHandler = (command: string, options: ISandboxRunOptions | undefined, files: ReadonlyMap<string, string>) => Promise<ISandboxRunResult> | ISandboxRunResult;
+interface IInMemorySandboxClientOptions {
+    files?: Record<string, string>;
+    runHandler?: TInMemorySandboxRunHandler;
+}
+declare class InMemorySandboxClient implements ISandboxClient {
+    private readonly files;
+    private readonly snapshots;
+    private readonly runHandler?;
+    private snapshotSequence;
+    constructor(options?: IInMemorySandboxClientOptions);
+    run(command: string, options?: ISandboxRunOptions): Promise<ISandboxRunResult>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    snapshot(): Promise<string>;
+    restore(snapshotId: string): Promise<void>;
+    getFile(path: string): string | undefined;
+}
+
+declare function applyWorkspaceManifest(sandboxClient: ISandboxClient, manifest: IWorkspaceManifest, options?: IWorkspaceManifestApplyOptions): Promise<IWorkspaceManifestApplyResult>;
+declare function validateWorkspaceManifestPath(path: string): string;
+
 /**
  * Tool registry implementation
  * Manages tool registration, validation, and retrieval
@@ -266,42 +427,36 @@ declare function createOpenAPITool(config: IOpenAPIToolConfig): OpenAPITool;
 declare function zodToJsonSchema(schema: IZodSchema, options?: ISchemaConversionOptions): IToolSchema['parameters'];
 
 /**
- * BashTool — execute shell commands via child_process.spawn
- *
- * Returns TToolResult JSON string. Non-zero exit is returned as success:true
- * with exitCode set, matching Claude Code behaviour (the command ran, it just
- * exited non-zero — the LLM can decide what to do with that information).
+ * Create a BashTool instance — register with Robota agent tools registry.
  */
+declare function createBashTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * BashTool instance — register with Robota agent tools registry.
  */
 declare const bashTool: FunctionTool;
 
 /**
- * ReadTool — read a file and return its contents with line numbers (cat -n style).
- *
- * Supports offset/limit for partial reads. Detects binary files and refuses to
- * return their raw bytes. Default limit is 2000 lines.
+ * Create a ReadTool instance — register with Robota agent tools registry.
  */
+declare function createReadTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * ReadTool instance — register with Robota agent tools registry.
  */
 declare const readTool: FunctionTool;
 
 /**
- * WriteTool — write content to a file, auto-creating parent directories.
+ * Create a WriteTool instance — register with Robota agent tools registry.
  */
+declare function createWriteTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * WriteTool instance — register with Robota agent tools registry.
  */
 declare const writeTool: FunctionTool;
 
 /**
- * EditTool — perform string-replace edits on a file.
- *
- * By default, requires the oldString to appear exactly once in the file
- * (ensuring surgical edits). Pass replaceAll:true to replace all occurrences.
+ * Create an EditTool instance — register with Robota agent tools registry.
  */
+declare function createEditTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * EditTool instance — register with Robota agent tools registry.
  */
@@ -346,4 +501,4 @@ declare const webFetchTool: FunctionTool;
  */
 declare const webSearchTool: FunctionTool;
 
-export { FunctionTool, type IFunctionToolExecutionMetadata, type IFunctionToolResult, type IFunctionToolValidationOptions, type ISchemaConversionOptions, type IZodParseResult, type IZodSchema, type IZodSchemaDef, OpenAPITool, type TToolResult, ToolRegistry, bashTool, createFunctionTool, createOpenAPITool, createZodFunctionTool, editTool, globTool, grepTool, readTool, webFetchTool, webSearchTool, writeTool, zodToJsonSchema };
+export { E2BSandboxClient, FunctionTool, type IE2BSandboxAdapter, type IE2BSandboxClientOptions, type IFunctionToolExecutionMetadata, type IFunctionToolResult, type IFunctionToolValidationOptions, type IInMemorySandboxClientOptions, type ISandboxClient, type ISandboxRunOptions, type ISandboxRunResult, type ISandboxToolOptions, type ISchemaConversionOptions, type IWorkspaceManifest, type IWorkspaceManifestAppliedEntry, type IWorkspaceManifestApplyOptions, type IWorkspaceManifestApplyResult, type IWorkspaceManifestAzureBlobMountEntry, type IWorkspaceManifestDirectoryEntry, type IWorkspaceManifestFileEntry, type IWorkspaceManifestGcsMountEntry, type IWorkspaceManifestGitRepositoryEntry, type IWorkspaceManifestLocalDirectoryEntry, type IWorkspaceManifestLocalFileEntry, type IWorkspaceManifestPermissions, type IWorkspaceManifestR2MountEntry, type IWorkspaceManifestS3MountEntry, type IZodParseResult, type IZodSchema, type IZodSchemaDef, InMemorySandboxClient, OpenAPITool, type TInMemorySandboxRunHandler, type TToolResult, type TWorkspaceManifestApplyStatus, type TWorkspaceManifestEntry, ToolRegistry, applyWorkspaceManifest, bashTool, createBashTool, createEditTool, createFunctionTool, createOpenAPITool, createReadTool, createWriteTool, createZodFunctionTool, editTool, globTool, grepTool, readTool, validateWorkspaceManifestPath, webFetchTool, webSearchTool, writeTool, zodToJsonSchema };

package/dist/node/index.d.ts

@@ -12,6 +12,167 @@ interface TToolResult {
     startLine?: number;
 }
 
+interface ISandboxRunOptions {
+    timeoutMs?: number;
+    workingDirectory?: string;
+}
+interface ISandboxRunResult {
+    stdout: string;
+    stderr?: string;
+    exitCode: number;
+}
+interface IWorkspaceManifestFileEntry {
+    type: 'file';
+    content: string;
+    encoding?: 'utf8';
+}
+interface IWorkspaceManifestDirectoryEntry {
+    type: 'dir';
+}
+interface IWorkspaceManifestLocalFileEntry {
+    type: 'localFile';
+    src: string;
+}
+interface IWorkspaceManifestLocalDirectoryEntry {
+    type: 'localDir';
+    src: string;
+}
+interface IWorkspaceManifestGitRepositoryEntry {
+    type: 'gitRepo';
+    url: string;
+    ref?: string;
+    shallow?: boolean;
+}
+interface IWorkspaceManifestS3MountEntry {
+    type: 's3Mount';
+    bucket: string;
+    prefix?: string;
+    region: string;
+}
+interface IWorkspaceManifestGcsMountEntry {
+    type: 'gcsMount';
+    bucket: string;
+    prefix?: string;
+}
+interface IWorkspaceManifestR2MountEntry {
+    type: 'r2Mount';
+    bucket: string;
+    accountId: string;
+    prefix?: string;
+}
+interface IWorkspaceManifestAzureBlobMountEntry {
+    type: 'azureBlobMount';
+    container: string;
+    account: string;
+    prefix?: string;
+}
+type TWorkspaceManifestEntry = IWorkspaceManifestFileEntry | IWorkspaceManifestDirectoryEntry | IWorkspaceManifestLocalFileEntry | IWorkspaceManifestLocalDirectoryEntry | IWorkspaceManifestGitRepositoryEntry | IWorkspaceManifestS3MountEntry | IWorkspaceManifestGcsMountEntry | IWorkspaceManifestR2MountEntry | IWorkspaceManifestAzureBlobMountEntry;
+interface IWorkspaceManifestPermissions {
+    read?: string[];
+    write?: string[];
+}
+interface IWorkspaceManifest {
+    entries: Record<string, TWorkspaceManifestEntry>;
+    environment?: Record<string, string>;
+    permissions?: IWorkspaceManifestPermissions;
+}
+interface IWorkspaceManifestApplyOptions {
+    targetRoot?: string;
+    hostRoot?: string;
+}
+type TWorkspaceManifestApplyStatus = 'applied' | 'unsupported';
+interface IWorkspaceManifestAppliedEntry {
+    path: string;
+    type: TWorkspaceManifestEntry['type'];
+    status: TWorkspaceManifestApplyStatus;
+    message?: string;
+}
+interface IWorkspaceManifestApplyResult {
+    entries: IWorkspaceManifestAppliedEntry[];
+}
+interface ISandboxClient {
+    run(command: string, options?: ISandboxRunOptions): Promise<ISandboxRunResult>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    applyManifest?(manifest: IWorkspaceManifest, options?: IWorkspaceManifestApplyOptions): Promise<IWorkspaceManifestApplyResult>;
+    /** Return a provider-owned resumable workspace reference. */
+    snapshot?(): Promise<string>;
+    /** Hydrate this client from a provider-owned workspace reference. */
+    restore?(snapshotId: string): Promise<void>;
+}
+interface ISandboxToolOptions {
+    sandboxClient?: ISandboxClient;
+}
+
+interface IE2BCommandStartOptions {
+    timeoutMs?: number;
+    cwd?: string;
+    background?: false;
+}
+interface IE2BCommandResult {
+    stdout?: string;
+    stderr?: string;
+    exitCode?: number;
+    exit_code?: number;
+}
+interface IE2BCommands {
+    run(command: string, options?: IE2BCommandStartOptions): Promise<IE2BCommandResult>;
+}
+interface IE2BFiles {
+    read(path: string): Promise<string | Uint8Array>;
+    write(path: string, content: string): Promise<void>;
+}
+interface IE2BSnapshot {
+    snapshotId?: string;
+    id?: string;
+}
+interface IE2BSandboxAdapter {
+    sandboxId?: string;
+    commands: IE2BCommands;
+    files: IE2BFiles;
+    pause?(): Promise<boolean | string | void>;
+    connect?(): Promise<IE2BSandboxAdapter>;
+    createSnapshot?(): Promise<IE2BSnapshot>;
+}
+interface IE2BSandboxClientOptions {
+    sandbox: IE2BSandboxAdapter;
+    connectSandbox?: (sandboxId: string) => Promise<IE2BSandboxAdapter>;
+    createSandboxFromSnapshot?: (snapshotId: string) => Promise<IE2BSandboxAdapter>;
+}
+declare class E2BSandboxClient implements ISandboxClient {
+    private sandbox;
+    private readonly connectSandbox?;
+    private readonly createSandboxFromSnapshot?;
+    constructor(options: IE2BSandboxClientOptions);
+    run(command: string, options?: ISandboxRunOptions): Promise<ISandboxRunResult>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    snapshot(): Promise<string>;
+    restore(snapshotId: string): Promise<void>;
+}
+
+type TInMemorySandboxRunHandler = (command: string, options: ISandboxRunOptions | undefined, files: ReadonlyMap<string, string>) => Promise<ISandboxRunResult> | ISandboxRunResult;
+interface IInMemorySandboxClientOptions {
+    files?: Record<string, string>;
+    runHandler?: TInMemorySandboxRunHandler;
+}
+declare class InMemorySandboxClient implements ISandboxClient {
+    private readonly files;
+    private readonly snapshots;
+    private readonly runHandler?;
+    private snapshotSequence;
+    constructor(options?: IInMemorySandboxClientOptions);
+    run(command: string, options?: ISandboxRunOptions): Promise<ISandboxRunResult>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    snapshot(): Promise<string>;
+    restore(snapshotId: string): Promise<void>;
+    getFile(path: string): string | undefined;
+}
+
+declare function applyWorkspaceManifest(sandboxClient: ISandboxClient, manifest: IWorkspaceManifest, options?: IWorkspaceManifestApplyOptions): Promise<IWorkspaceManifestApplyResult>;
+declare function validateWorkspaceManifestPath(path: string): string;
+
 /**
  * Tool registry implementation
  * Manages tool registration, validation, and retrieval
@@ -266,42 +427,36 @@ declare function createOpenAPITool(config: IOpenAPIToolConfig): OpenAPITool;
 declare function zodToJsonSchema(schema: IZodSchema, options?: ISchemaConversionOptions): IToolSchema['parameters'];
 
 /**
- * BashTool — execute shell commands via child_process.spawn
- *
- * Returns TToolResult JSON string. Non-zero exit is returned as success:true
- * with exitCode set, matching Claude Code behaviour (the command ran, it just
- * exited non-zero — the LLM can decide what to do with that information).
+ * Create a BashTool instance — register with Robota agent tools registry.
  */
+declare function createBashTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * BashTool instance — register with Robota agent tools registry.
  */
 declare const bashTool: FunctionTool;
 
 /**
- * ReadTool — read a file and return its contents with line numbers (cat -n style).
- *
- * Supports offset/limit for partial reads. Detects binary files and refuses to
- * return their raw bytes. Default limit is 2000 lines.
+ * Create a ReadTool instance — register with Robota agent tools registry.
  */
+declare function createReadTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * ReadTool instance — register with Robota agent tools registry.
  */
 declare const readTool: FunctionTool;
 
 /**
- * WriteTool — write content to a file, auto-creating parent directories.
+ * Create a WriteTool instance — register with Robota agent tools registry.
  */
+declare function createWriteTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * WriteTool instance — register with Robota agent tools registry.
  */
 declare const writeTool: FunctionTool;
 
 /**
- * EditTool — perform string-replace edits on a file.
- *
- * By default, requires the oldString to appear exactly once in the file
- * (ensuring surgical edits). Pass replaceAll:true to replace all occurrences.
+ * Create an EditTool instance — register with Robota agent tools registry.
  */
+declare function createEditTool(options?: ISandboxToolOptions): FunctionTool;
 /**
  * EditTool instance — register with Robota agent tools registry.
  */
@@ -346,4 +501,4 @@ declare const webFetchTool: FunctionTool;
  */
 declare const webSearchTool: FunctionTool;
 
-export { FunctionTool, type IFunctionToolExecutionMetadata, type IFunctionToolResult, type IFunctionToolValidationOptions, type ISchemaConversionOptions, type IZodParseResult, type IZodSchema, type IZodSchemaDef, OpenAPITool, type TToolResult, ToolRegistry, bashTool, createFunctionTool, createOpenAPITool, createZodFunctionTool, editTool, globTool, grepTool, readTool, webFetchTool, webSearchTool, writeTool, zodToJsonSchema };
+export { E2BSandboxClient, FunctionTool, type IE2BSandboxAdapter, type IE2BSandboxClientOptions, type IFunctionToolExecutionMetadata, type IFunctionToolResult, type IFunctionToolValidationOptions, type IInMemorySandboxClientOptions, type ISandboxClient, type ISandboxRunOptions, type ISandboxRunResult, type ISandboxToolOptions, type ISchemaConversionOptions, type IWorkspaceManifest, type IWorkspaceManifestAppliedEntry, type IWorkspaceManifestApplyOptions, type IWorkspaceManifestApplyResult, type IWorkspaceManifestAzureBlobMountEntry, type IWorkspaceManifestDirectoryEntry, type IWorkspaceManifestFileEntry, type IWorkspaceManifestGcsMountEntry, type IWorkspaceManifestGitRepositoryEntry, type IWorkspaceManifestLocalDirectoryEntry, type IWorkspaceManifestLocalFileEntry, type IWorkspaceManifestPermissions, type IWorkspaceManifestR2MountEntry, type IWorkspaceManifestS3MountEntry, type IZodParseResult, type IZodSchema, type IZodSchemaDef, InMemorySandboxClient, OpenAPITool, type TInMemorySandboxRunHandler, type TToolResult, type TWorkspaceManifestApplyStatus, type TWorkspaceManifestEntry, ToolRegistry, applyWorkspaceManifest, bashTool, createBashTool, createEditTool, createFunctionTool, createOpenAPITool, createReadTool, createWriteTool, createZodFunctionTool, editTool, globTool, grepTool, readTool, validateWorkspaceManifestPath, webFetchTool, webSearchTool, writeTool, zodToJsonSchema };