48 lines
2.2 KiB
TypeScript
48 lines
2.2 KiB
TypeScript
/**
|
|
* Interface for providing runtime capabilities to sandboxed iframes.
|
|
* Each provider injects data and runtime functions into the sandbox context.
|
|
*/
|
|
export interface SandboxRuntimeProvider {
|
|
/**
|
|
* Returns data to inject into window scope.
|
|
* Keys become window properties (e.g., { attachments: [...] } -> window.attachments)
|
|
*/
|
|
getData(): Record<string, any>;
|
|
/**
|
|
* Returns a runtime function that will be stringified and executed in the sandbox.
|
|
* The function receives sandboxId and has access to data from getData() via window.
|
|
*
|
|
* IMPORTANT: This function will be converted to string via .toString() and injected
|
|
* into the sandbox, so it cannot reference external variables or imports.
|
|
*/
|
|
getRuntime(): (sandboxId: string) => void;
|
|
/**
|
|
* Optional message handler for bidirectional communication.
|
|
* All providers receive all messages - decide internally what to handle.
|
|
*
|
|
* @param message - The message from the sandbox
|
|
* @param respond - Function to send a response back to the sandbox
|
|
*/
|
|
handleMessage?(message: any, respond: (response: any) => void): Promise<void>;
|
|
/**
|
|
* Optional documentation describing what globals/functions this provider injects.
|
|
* This will be appended to tool descriptions dynamically so the LLM knows what's available.
|
|
*/
|
|
getDescription(): string;
|
|
/**
|
|
* Optional lifecycle callback invoked when sandbox execution starts.
|
|
* Providers can use this to track abort signals for cancellation of async operations.
|
|
*
|
|
* @param sandboxId - The unique identifier for this sandbox execution
|
|
* @param signal - Optional AbortSignal that will be triggered if execution is cancelled
|
|
*/
|
|
onExecutionStart?(sandboxId: string, signal?: AbortSignal): void;
|
|
/**
|
|
* Optional lifecycle callback invoked when sandbox execution ends (success, error, or abort).
|
|
* Providers can use this to clean up any resources associated with the sandbox.
|
|
*
|
|
* @param sandboxId - The unique identifier for this sandbox execution
|
|
*/
|
|
onExecutionEnd?(sandboxId: string): void;
|
|
}
|
|
//# sourceMappingURL=SandboxRuntimeProvider.d.ts.map
|