@openai/agents-core/dist/editor.d.ts

The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.

import type { ApplyPatchOperation } from './types/protocol';
import type { RunContext } from './runContext';
export type { ApplyPatchOperation } from './types/protocol';
/**
 * Result returned by an Editor operation.
 */
export type ApplyPatchResult = {
    /**
     * Whether the operation completed successfully. Defaults to `completed`.
     */
    status?: 'completed' | 'failed';
    /**
     * Optional textual output to forward to the model.
     */
    output?: string;
};
/**
 * Runtime context passed to editor operations.
 */
export type EditorInvocationContext = {
    /**
     * Current run context.
     */
    runContext: RunContext;
};
/**
 * Host interface responsible for applying diffs on disk.
 */
export interface Editor {
    /**
     * Creates a new file from a V4A diff.
     */
    createFile(operation: Extract<ApplyPatchOperation, {
        type: 'create_file';
    }>, context?: EditorInvocationContext): Promise<ApplyPatchResult | void>;
    /**
     * Updates an existing file based on a V4A diff.
     */
    updateFile(operation: Extract<ApplyPatchOperation, {
        type: 'update_file';
    }>, context?: EditorInvocationContext): Promise<ApplyPatchResult | void>;
    /**
     * Deletes an existing file.
     */
    deleteFile(operation: Extract<ApplyPatchOperation, {
        type: 'delete_file';
    }>, context?: EditorInvocationContext): Promise<ApplyPatchResult | void>;
}