@codex-native/sdk 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,562 @@
+import { ContentBlock } from '@modelcontextprotocol/sdk/types.js';
+
+/** The status of a command execution. */
+type CommandExecutionStatus = "in_progress" | "completed" | "failed";
+/** A command executed by the agent. */
+type CommandExecutionItem = {
+    id: string;
+    type: "command_execution";
+    /** The command line executed by the agent. */
+    command: string;
+    /** Aggregated stdout and stderr captured while the command was running. */
+    aggregated_output: string;
+    /** Set when the command exits; omitted while still running. */
+    exit_code?: number;
+    /** Current status of the command execution. */
+    status: CommandExecutionStatus;
+};
+/** Indicates the type of the file change. */
+type PatchChangeKind = "add" | "delete" | "update";
+/** A set of file changes by the agent. */
+type FileUpdateChange = {
+    path: string;
+    kind: PatchChangeKind;
+};
+/** The status of a file change. */
+type PatchApplyStatus = "completed" | "failed";
+/** A set of file changes by the agent. Emitted once the patch succeeds or fails. */
+type FileChangeItem = {
+    id: string;
+    type: "file_change";
+    /** Individual file changes that comprise the patch. */
+    changes: FileUpdateChange[];
+    /** Whether the patch ultimately succeeded or failed. */
+    status: PatchApplyStatus;
+};
+/** The status of an MCP tool call. */
+type McpToolCallStatus = "in_progress" | "completed" | "failed";
+/**
+ * Represents a call to an MCP tool. The item starts when the invocation is dispatched
+ * and completes when the MCP server reports success or failure.
+ */
+type McpToolCallItem = {
+    id: string;
+    type: "mcp_tool_call";
+    /** Name of the MCP server handling the request. */
+    server: string;
+    /** The tool invoked on the MCP server. */
+    tool: string;
+    /** Arguments forwarded to the tool invocation. */
+    arguments: unknown;
+    /** Result payload returned by the MCP server for successful calls. */
+    result?: {
+        content: ContentBlock[];
+        structured_content: unknown;
+    };
+    /** Error message reported for failed calls. */
+    error?: {
+        message: string;
+    };
+    /** Current status of the tool invocation. */
+    status: McpToolCallStatus;
+};
+/** Response from the agent. Either natural-language text or JSON when structured output is requested. */
+type AgentMessageItem = {
+    id: string;
+    type: "agent_message";
+    /** Either natural-language text or JSON when structured output is requested. */
+    text: string;
+};
+/** Agent's reasoning summary. */
+type ReasoningItem = {
+    id: string;
+    type: "reasoning";
+    text: string;
+};
+/** Captures a web search request. Completes when results are returned to the agent. */
+type WebSearchItem = {
+    id: string;
+    type: "web_search";
+    query: string;
+};
+/** Describes a non-fatal error surfaced as an item. */
+type ErrorItem = {
+    id: string;
+    type: "error";
+    message: string;
+};
+/** An item in the agent's to-do list. */
+type TodoItem = {
+    text: string;
+    completed: boolean;
+};
+/**
+ * Tracks the agent's running to-do list. Starts when the plan is issued, updates as steps change,
+ * and completes when the turn ends.
+ */
+type TodoListItem = {
+    id: string;
+    type: "todo_list";
+    items: TodoItem[];
+};
+/** Canonical union of thread items and their type-specific payloads. */
+type ThreadItem = AgentMessageItem | ReasoningItem | CommandExecutionItem | FileChangeItem | McpToolCallItem | WebSearchItem | TodoListItem | ErrorItem;
+
+/** Emitted when a new thread is started as the first event. */
+type ThreadStartedEvent = {
+    type: "thread.started";
+    /** The identifier of the new thread. Can be used to resume the thread later. */
+    thread_id: string;
+};
+/**
+ * Emitted when a turn is started by sending a new prompt to the model.
+ * A turn encompasses all events that happen while the agent is processing the prompt.
+ */
+type TurnStartedEvent = {
+    type: "turn.started";
+};
+/** Describes the usage of tokens during a turn. */
+type Usage$1 = {
+    /** The number of input tokens used during the turn. */
+    input_tokens: number;
+    /** The number of cached input tokens used during the turn. */
+    cached_input_tokens: number;
+    /** The number of output tokens used during the turn. */
+    output_tokens: number;
+};
+/** Emitted when a turn is completed. Typically right after the assistant's response. */
+type TurnCompletedEvent = {
+    type: "turn.completed";
+    usage: Usage$1;
+};
+/** Indicates that a turn failed with an error. */
+type TurnFailedEvent = {
+    type: "turn.failed";
+    error: ThreadError;
+};
+/** Emitted when a new item is added to the thread. Typically the item is initially "in progress". */
+type ItemStartedEvent = {
+    type: "item.started";
+    item: ThreadItem;
+};
+/** Emitted when an item is updated. */
+type ItemUpdatedEvent = {
+    type: "item.updated";
+    item: ThreadItem;
+};
+/** Signals that an item has reached a terminal state—either success or failure. */
+type ItemCompletedEvent = {
+    type: "item.completed";
+    item: ThreadItem;
+};
+/** Fatal error emitted by the stream. */
+type ThreadError = {
+    message: string;
+};
+/** Represents an unrecoverable error emitted directly by the event stream. */
+type ThreadErrorEvent = {
+    type: "error";
+    message: string;
+};
+/** Top-level JSONL events emitted by codex exec. */
+type ThreadEvent = ThreadStartedEvent | TurnStartedEvent | TurnCompletedEvent | TurnFailedEvent | ItemStartedEvent | ItemUpdatedEvent | ItemCompletedEvent | ThreadErrorEvent;
+
+type TurnOptions = {
+    /** JSON schema describing the expected agent output. */
+    outputSchema?: unknown;
+};
+
+/** Completed turn. */
+type Turn = {
+    items: ThreadItem[];
+    finalResponse: string;
+    usage: Usage$1 | null;
+};
+/** Alias for `Turn` to describe the result of `run()`. */
+type RunResult = Turn;
+/** The result of the `runStreamed` method. */
+type StreamedTurn = {
+    events: AsyncGenerator<ThreadEvent>;
+};
+/** Alias for `StreamedTurn` to describe the result of `runStreamed()`. */
+type RunStreamedResult = StreamedTurn;
+/** An input to send to the agent. */
+type UserInput = {
+    type: "text";
+    text: string;
+} | {
+    type: "local_image";
+    path: string;
+};
+type Input = string | UserInput[];
+/** Respesent a thread of conversation with the agent. One thread can have multiple consecutive turns. */
+declare class Thread {
+    private _exec;
+    private _options;
+    private _id;
+    private _threadOptions;
+    /** Returns the ID of the thread. Populated after the first turn starts. */
+    get id(): string | null;
+    /** Provides the input to the agent and streams events as they are produced during the turn. */
+    runStreamed(input: Input, turnOptions?: TurnOptions): Promise<StreamedTurn>;
+    private runStreamedInternal;
+    /** Provides the input to the agent and returns the completed turn. */
+    run(input: Input, turnOptions?: TurnOptions): Promise<Turn>;
+}
+
+type ApprovalMode = "never" | "on-request" | "on-failure" | "untrusted";
+type SandboxMode = "read-only" | "workspace-write" | "danger-full-access";
+type ThreadOptions = {
+    model?: string;
+    sandboxMode?: SandboxMode;
+    workingDirectory?: string;
+    skipGitRepoCheck?: boolean;
+};
+
+type NativeToolInfo = {
+    name: string;
+    description?: string;
+    parameters?: unknown;
+    strict?: boolean;
+    supportsParallel?: boolean;
+};
+type NativeToolInvocation = {
+    toolName: string;
+    callId: string;
+    arguments?: string;
+    input?: string;
+};
+type NativeToolResult = {
+    output?: string;
+    success?: boolean;
+    error?: string;
+};
+
+type NativeToolDefinition = NativeToolInfo & {
+    handler: (call: NativeToolInvocation) => Promise<NativeToolResult> | NativeToolResult;
+};
+type CodexOptions = {
+    codexPathOverride?: string;
+    baseUrl?: string;
+    apiKey?: string;
+    tools?: NativeToolDefinition[];
+};
+
+/**
+ * Codex is the main class for interacting with the Codex agent.
+ *
+ * This is the native NAPI-based implementation that uses Rust bindings directly.
+ *
+ * Use the `startThread()` method to start a new thread or `resumeThread()` to resume a previously started thread.
+ */
+declare class Codex {
+    private exec;
+    private options;
+    private readonly nativeBinding;
+    constructor(options?: CodexOptions);
+    registerTool(tool: NativeToolDefinition): void;
+    /**
+     * Starts a new conversation with an agent.
+     * @returns A new thread instance.
+     */
+    startThread(options?: ThreadOptions): Thread;
+    /**
+     * Resumes a conversation with an agent based on the thread id.
+     * Threads are persisted in ~/.codex/sessions.
+     *
+     * @param id The id of the thread to resume.
+     * @returns A new thread instance.
+     */
+    resumeThread(id: string, options?: ThreadOptions): Thread;
+}
+
+/**
+ * Type definitions for OpenAI Agents JS framework compatibility
+ * Based on @openai/agents-core package
+ */
+interface ModelProvider {
+    /**
+     * Get a model by name
+     * @param modelName - The name of the model to get.
+     */
+    getModel(modelName?: string): Promise<Model> | Model;
+}
+interface Model {
+    /**
+     * Get a response from the model (buffered)
+     */
+    getResponse(request: ModelRequest): Promise<ModelResponse>;
+    /**
+     * Get a streamed response from the model
+     */
+    getStreamedResponse(request: ModelRequest): AsyncIterable<StreamEvent>;
+}
+interface ModelRequest {
+    systemInstructions?: string;
+    input: string | AgentInputItem[];
+    previousResponseId?: string;
+    conversationId?: string;
+    modelSettings: ModelSettings;
+    tools: SerializedTool[];
+    outputType: SerializedOutputType;
+    handoffs: SerializedHandoff[];
+    tracing: ModelTracing;
+    signal?: AbortSignal;
+    prompt?: Prompt;
+    overridePromptModel?: boolean;
+}
+interface ModelSettings {
+    temperature?: number;
+    topP?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
+    toolChoice?: ModelSettingsToolChoice;
+    parallelToolCalls?: boolean;
+    truncation?: "auto" | "disabled";
+    maxTokens?: number;
+    store?: boolean;
+    reasoning?: ModelSettingsReasoning;
+    text?: ModelSettingsText;
+    providerData?: Record<string, unknown>;
+}
+interface ModelSettingsToolChoice {
+    type: "auto" | "required" | "none" | "function";
+    functionName?: string;
+}
+interface ModelSettingsReasoning {
+    type: "internal" | "explicit";
+    maxTokens?: number;
+}
+interface ModelSettingsText {
+    format?: {
+        type: string;
+        schema?: Record<string, unknown>;
+    };
+}
+type AgentInputItem = InputText | InputImage | InputFile | InputAudio | InputFunctionCallResult | InputRefusal;
+interface InputText {
+    type: "input_text";
+    text: string;
+}
+interface InputImage {
+    type: "input_image";
+    image: string | {
+        url: string;
+    } | {
+        fileId: string;
+    };
+    detail?: "auto" | "low" | "high";
+}
+interface InputFile {
+    type: "input_file";
+    file: {
+        fileId: string;
+    };
+}
+interface InputAudio {
+    type: "input_audio";
+    audio: string | {
+        data: string;
+        format: string;
+    };
+    transcript?: string;
+}
+interface InputFunctionCallResult {
+    type: "function_call_result";
+    callId: string;
+    name: string;
+    result: string;
+}
+interface InputRefusal {
+    type: "input_refusal";
+    refusal: string;
+}
+interface ModelResponse {
+    usage: Usage;
+    output: AgentOutputItem[];
+    responseId?: string;
+    providerData?: Record<string, unknown>;
+}
+interface Usage {
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+    inputTokensDetails?: Array<Record<string, number>>;
+    outputTokensDetails?: Array<Record<string, number>>;
+}
+type AgentOutputItem = AssistantMessageItem | FunctionCallItem | Refusal | AudioContent | ImageContent | Reasoning;
+interface AssistantMessageItem {
+    type: "assistant_message";
+    role: "assistant";
+    status: "in_progress" | "completed";
+    content: OutputContent[];
+}
+interface FunctionCallItem {
+    type: "function_call";
+    callId: string;
+    name: string;
+    arguments: string;
+}
+interface Refusal {
+    type: "refusal";
+    refusal: string;
+}
+interface AudioContent {
+    type: "audio";
+    audio: string;
+    transcript?: string;
+}
+interface ImageContent {
+    type: "image";
+    image: string;
+}
+interface Reasoning {
+    type: "reasoning";
+    reasoning: string;
+}
+type OutputContent = OutputText | OutputImage | OutputAudio | OutputRefusal;
+interface OutputText {
+    type: "output_text";
+    text: string;
+}
+interface OutputImage {
+    type: "output_image";
+    image: string;
+}
+interface OutputAudio {
+    type: "output_audio";
+    audio: string;
+    transcript?: string;
+}
+interface OutputRefusal {
+    type: "output_refusal";
+    refusal: string;
+}
+type StreamEvent = ResponseStartedEvent | OutputTextDeltaEvent | OutputTextDoneEvent | OutputAudioDeltaEvent | OutputAudioDoneEvent | FunctionCallArgumentsDeltaEvent | FunctionCallArgumentsDoneEvent | ReasoningDeltaEvent | ReasoningDoneEvent | ResponseDoneEvent | ErrorEvent;
+interface ResponseStartedEvent {
+    type: "response_started";
+}
+interface OutputTextDeltaEvent {
+    type: "output_text_delta";
+    delta: string;
+}
+interface OutputTextDoneEvent {
+    type: "output_text_done";
+    text: string;
+}
+interface OutputAudioDeltaEvent {
+    type: "output_audio_delta";
+    delta: string;
+}
+interface OutputAudioDoneEvent {
+    type: "output_audio_done";
+    audio: string;
+    transcript?: string;
+}
+interface FunctionCallArgumentsDeltaEvent {
+    type: "function_call_arguments_delta";
+    callId: string;
+    name: string;
+    delta: string;
+}
+interface FunctionCallArgumentsDoneEvent {
+    type: "function_call_arguments_done";
+    callId: string;
+    name: string;
+    arguments: string;
+}
+interface ReasoningDeltaEvent {
+    type: "reasoning_delta";
+    delta: string;
+}
+interface ReasoningDoneEvent {
+    type: "reasoning_done";
+    reasoning: string;
+}
+interface ResponseDoneEvent {
+    type: "response_done";
+    response: ModelResponse;
+}
+interface ErrorEvent {
+    type: "error";
+    error: {
+        message: string;
+        code?: string;
+    };
+}
+interface SerializedTool {
+    type: "function";
+    name: string;
+    description?: string;
+    parameters?: Record<string, unknown>;
+}
+interface SerializedOutputType {
+    type: "json_schema";
+    schema: Record<string, unknown>;
+}
+interface SerializedHandoff {
+    name: string;
+    description?: string;
+}
+interface ModelTracing {
+    enabled: boolean;
+    metadata?: Record<string, unknown>;
+}
+interface Prompt {
+    model?: string;
+    template?: string;
+}
+
+/**
+ * Options for creating a CodexProvider
+ */
+interface CodexProviderOptions extends CodexOptions {
+    /**
+     * Default model to use when none is specified
+     */
+    defaultModel?: string;
+    /**
+     * Working directory for Codex operations
+     * @default process.cwd()
+     */
+    workingDirectory?: string;
+    /**
+     * Skip git repository check
+     * @default false
+     */
+    skipGitRepoCheck?: boolean;
+}
+/**
+ * Provider implementation that uses Codex as the backend for OpenAI Agents
+ *
+ * @example
+ * ```typescript
+ * import { CodexProvider } from '@openai/codex-native/agents';
+ * import { Agent, Runner } from '@openai/agents';
+ *
+ * const provider = new CodexProvider({
+ *   apiKey: process.env.CODEX_API_KEY,
+ *   defaultModel: 'claude-sonnet-4.5'
+ * });
+ *
+ * const agent = new Agent({
+ *   name: 'CodeAssistant',
+ *   instructions: 'You are a helpful coding assistant'
+ * });
+ *
+ * const runner = new Runner({ modelProvider: provider });
+ * const result = await runner.run(agent, 'Fix the failing tests');
+ * ```
+ */
+declare class CodexProvider implements ModelProvider {
+    private codex;
+    private options;
+    constructor(options?: CodexProviderOptions);
+    /**
+     * Lazy initialization of Codex instance
+     */
+    private getCodex;
+    getModel(modelName?: string): Model;
+}
+
+export { type AgentMessageItem, type ApprovalMode, Codex, type CodexOptions, CodexProvider, type CodexProviderOptions, type CommandExecutionItem, type ErrorItem, type FileChangeItem, type Input, type ItemCompletedEvent, type ItemStartedEvent, type ItemUpdatedEvent, type McpToolCallItem, type NativeToolDefinition, type NativeToolInvocation, type NativeToolResult, type ReasoningItem, type RunResult, type RunStreamedResult, type SandboxMode, Thread, type ThreadError, type ThreadErrorEvent, type ThreadEvent, type ThreadItem, type ThreadOptions, type ThreadStartedEvent, type TodoListItem, type TurnCompletedEvent, type TurnFailedEvent, type TurnOptions, type TurnStartedEvent, type Usage$1 as Usage, type UserInput, type WebSearchItem };