@jrkropp/codex-js 0.1.4 → 0.3.0

package/dist/internal/codex/core/src/mcp/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./types.js";
+export * from "./manager.js";
+export { declared_openai_file_input_param_names, filter_tools, qualify_tool_infos, qualify_tools, tool_with_model_visible_input_schema, ToolFilter, type QualifiedToolInfo, type ToolInfo, } from "../../../codex-mcp/src/tools.js";
+export { CODEX_APPS_MCP_SERVER_NAME, MCP_TOOL_NAME_DELIMITER, MCP_TOOL_NAME_PREFIX, ToolPluginProvenance, qualified_mcp_tool_name_prefix, sanitize_responses_api_tool_name, } from "../../../codex-mcp/src/mcp/mod.js";
+export { CODEX_APPS_TOOLS_CACHE_DIR, CODEX_APPS_TOOLS_CACHE_SCHEMA_VERSION, CachedCodexAppsToolsLoad, CodexAppsToolsCacheContext, InMemoryCodexAppsToolsCacheStorage, codex_apps_tools_cache_key, filter_disallowed_codex_apps_tools, filter_non_codex_apps_mcp_tools_only, is_connector_id_allowed, load_cached_codex_apps_tools, load_startup_cached_codex_apps_tools_snapshot, normalize_codex_apps_callable_name, normalize_codex_apps_callable_namespace, normalize_codex_apps_tool_title, read_cached_codex_apps_tools, sanitize_name, write_cached_codex_apps_tools, write_cached_codex_apps_tools_if_needed, type CachedCodexAppsToolsLoad as CachedCodexAppsToolsLoadResult, type CodexAppsToolsCacheKey, type CodexAppsToolsCacheStorage, type CodexAuthLike, } from "../../../codex-mcp/src/codex_apps.js";
+export { McpConnectionManager as CodexMcpConnectionManager, is_mcp_client_auth_required_error, is_mcp_client_startup_timeout_error, mcp_init_error_display, startup_outcome_error_message, transport_origin, type McpStartupFailure, } from "../../../codex-mcp/src/connection_manager.js";
+export { AsyncManagedClient, CancellationToken as McpCancellationToken, DEFAULT_STARTUP_TIMEOUT, DEFAULT_TOOL_TIMEOUT, MCP_SANDBOX_STATE_META_CAPABILITY, MCP_TOOLS_FETCH_UNCACHED_DURATION_METRIC, MCP_TOOLS_LIST_DURATION_METRIC, RmcpJsonRpcClient, ManagedClient, StartupOutcomeError, StreamableHttpMcpTransport, UnsupportedStdioServerLauncher, elicitation_capability_for_server, list_tools_for_client_uncached, make_rmcp_client, start_server_task, validate_mcp_server_name, type McpClientFactoryOptions, type McpJsonRpcMessage, type McpJsonRpcTransport, type McpRuntimeEnvironment as McpClientRuntimeEnvironment, type McpServerConfig as McpTransportServerConfig, type McpServerTransportConfig, type ManagedClientInput, type RmcpClientLike, type RmcpListToolsResult, type RmcpRawTool, type StdioServerLauncher, } from "../../../codex-mcp/src/rmcp_client.js";
+export { McpOAuthScopesSource, McpOAuthLoginSupport, OAuthProviderError, compute_auth_status, compute_auth_statuses, discover_streamable_http_oauth, discover_supported_scopes, discovery_paths, oauth_login_support, resolve_oauth_scopes, should_retry_without_scopes, type McpAuthStatus, type McpAuthStatusEntry, type McpOAuthLoginConfig, type McpOAuthLoginSupport as McpOAuthLoginSupportResult, type McpServerConfig, type ResolvedMcpOAuthScopes, type StreamableHttpOAuthDiscovery, type CodexMcpAuthLike, } from "../../../codex-mcp/src/mcp/auth.js";
+export { ElicitationRequestManager, can_auto_accept_elicitation, elicitation_is_rejected_by_policy, mcp_permission_prompt_is_auto_approved, type CreateElicitationRequestParams, type ElicitationAction, type ElicitationEventSink, type ElicitationRequestEvent, type ElicitationResponse, type ElicitationReviewer, type ElicitationReviewerHandle, type ElicitationReviewRequest, type SendElicitation, } from "../../../codex-mcp/src/elicitation.js";
+export { CONNECTOR_AUTH_FAILURE_AUTH_REASON_KEY, CONNECTOR_AUTH_FAILURE_CONNECTOR_ID_KEY, CONNECTOR_AUTH_FAILURE_ERROR_ACTION_KEY, CONNECTOR_AUTH_FAILURE_ERROR_CODE_KEY, CONNECTOR_AUTH_FAILURE_ERROR_HTTP_STATUS_CODE_KEY, CONNECTOR_AUTH_FAILURE_IS_AUTH_FAILURE_KEY, CONNECTOR_AUTH_FAILURE_LINK_ID_KEY, CONNECTOR_AUTH_FAILURE_META_KEY, MCP_TOOL_CODEX_APPS_META_KEY, auth_elicitation_completed_result, auth_elicitation_id, auth_elicitation_message, build_auth_elicitation, build_auth_elicitation_plan, connector_auth_failure_from_tool_result, type CallToolResult, type CodexAppsAuthElicitation, type CodexAppsAuthElicitationPlan, type CodexAppsConnectorAuthFailure, } from "../../../codex-mcp/src/auth_elicitation.js";

package/dist/internal/codex/core/src/mcp/manager.d.ts

@@ -0,0 +1,73 @@
+import type { McpResourceReadParams, McpResourceReadResponse, McpResourceInfo, McpResourceListParams, McpResourceListResponse, McpResourceTemplateInfo, McpResourceTemplateListResponse, McpRuntimeEnvironment, McpServerElicitationResponse, McpServerRefreshConfig, McpServerStatusListOptions, McpServerStatus, McpServerToolCallParams, McpServerToolCallResponse, McpToolInfo, McpRequestId } from "./types.js";
+import { McpConnectionManager as CodexMcpConnectionManager, type McpStartupFailure } from "../../../codex-mcp/src/connection_manager.js";
+import type { McpClientFactoryOptions, McpServerConfig as CodexMcpServerConfig } from "../../../codex-mcp/src/rmcp_client.js";
+export interface McpConnectionManager {
+    refresh_mcp_servers_now(config: McpServerRefreshConfig, environment: McpRuntimeEnvironment): Promise<void>;
+    list_server_statuses(options?: McpServerStatusListOptions): Promise<McpServerStatus[]>;
+    list_resources(params: McpResourceListParams): Promise<McpResourceListResponse>;
+    list_resource_templates(params: McpResourceListParams): Promise<McpResourceTemplateListResponse>;
+    read_resource(params: McpResourceReadParams): Promise<McpResourceReadResponse>;
+    call_tool(params: McpServerToolCallParams): Promise<McpServerToolCallResponse>;
+    resolve_tool_info(serverName: string, toolName: string): Promise<McpToolInfo | null>;
+    list_tools(): Promise<McpToolInfo[]>;
+    resolve_elicitation(serverName: string, id: McpRequestId, response: McpServerElicitationResponse): Promise<void>;
+    shutdown(): Promise<void>;
+}
+export declare class EmptyMcpConnectionManager implements McpConnectionManager {
+    static readonly instance: EmptyMcpConnectionManager;
+    refresh_mcp_servers_now(): Promise<void>;
+    list_server_statuses(): Promise<McpServerStatus[]>;
+    list_resources(params: McpResourceListParams): Promise<McpResourceListResponse>;
+    list_resource_templates(params: McpResourceListParams): Promise<McpResourceTemplateListResponse>;
+    read_resource(params: McpResourceReadParams): Promise<McpResourceReadResponse>;
+    call_tool(params: McpServerToolCallParams): Promise<McpServerToolCallResponse>;
+    resolve_tool_info(): Promise<McpToolInfo | null>;
+    list_tools(): Promise<McpToolInfo[]>;
+    resolve_elicitation(serverName: string): Promise<void>;
+    shutdown(): Promise<void>;
+}
+export type CodexMcpConnectionManagerAdapterOptions = {
+    client_factory_options?: McpClientFactoryOptions;
+};
+export declare class CodexMcpConnectionManagerAdapter implements McpConnectionManager {
+    private manager;
+    private readonly client_factory_options?;
+    private configured_servers;
+    private auth_statuses;
+    constructor(manager?: CodexMcpConnectionManager, options?: CodexMcpConnectionManagerAdapterOptions);
+    refresh_mcp_servers_now(config: McpServerRefreshConfig, environment: McpRuntimeEnvironment): Promise<void>;
+    list_server_statuses(options?: McpServerStatusListOptions): Promise<McpServerStatus[]>;
+    list_resources(params: McpResourceListParams): Promise<McpResourceListResponse>;
+    list_resource_templates(params: McpResourceListParams): Promise<McpResourceTemplateListResponse>;
+    read_resource(params: McpResourceReadParams): Promise<McpResourceReadResponse>;
+    call_tool(params: McpServerToolCallParams): Promise<McpServerToolCallResponse>;
+    resolve_tool_info(serverName: string, toolName: string): Promise<McpToolInfo | null>;
+    list_tools(): Promise<McpToolInfo[]>;
+    resolve_elicitation(serverName: string, id: McpRequestId, response: McpServerElicitationResponse): Promise<void>;
+    shutdown(): Promise<void>;
+    required_startup_failures(required_servers: readonly string[]): Promise<McpStartupFailure[]>;
+}
+export declare function normalize_mcp_server_configs(input: Record<string, unknown>): Map<string, CodexMcpServerConfig>;
+export declare function normalize_mcp_server_config(serverName: string, value: unknown): CodexMcpServerConfig;
+export type StaticMcpConnectionManagerOptions = {
+    resources?: Record<string, ReadonlyArray<McpResourceInfo>>;
+    resource_templates?: Record<string, ReadonlyArray<McpResourceTemplateInfo>>;
+    read_resources?: Record<string, McpResourceReadResponse>;
+};
+export declare class StaticMcpConnectionManager implements McpConnectionManager {
+    private readonly tools;
+    private readonly resources;
+    private readonly resource_templates;
+    private readonly read_resources;
+    constructor(tools?: readonly McpToolInfo[], options?: StaticMcpConnectionManagerOptions);
+    refresh_mcp_servers_now(): Promise<void>;
+    list_server_statuses(options?: McpServerStatusListOptions): Promise<McpServerStatus[]>;
+    list_resources(params: McpResourceListParams): Promise<McpResourceListResponse>;
+    list_resource_templates(params: McpResourceListParams): Promise<McpResourceTemplateListResponse>;
+    read_resource(params: McpResourceReadParams): Promise<McpResourceReadResponse>;
+    call_tool(params: McpServerToolCallParams): Promise<McpServerToolCallResponse>;
+    resolve_tool_info(serverName: string, toolName: string): Promise<McpToolInfo | null>;
+    list_tools(): Promise<McpToolInfo[]>;
+    resolve_elicitation(): Promise<void>;
+    shutdown(): Promise<void>;
+}

package/dist/internal/codex/core/src/mcp/types.d.ts

@@ -0,0 +1,165 @@
+import type { ThreadId } from "../ids.js";
+import type { ResponseInputItem } from "../models.js";
+export type McpRequestId = string | number;
+export declare const McpServerStartupState: {
+    readonly Starting: "starting";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+    readonly Cancelled: "cancelled";
+};
+export type McpServerStartupState = (typeof McpServerStartupState)[keyof typeof McpServerStartupState];
+export type McpAuthStatus = "unsupported" | "notLoggedIn" | "bearerToken" | "oAuth";
+export type McpServerStatus = {
+    name: string;
+    startup_state: McpServerStartupState;
+    error?: string | null;
+    tools?: McpToolInfo[];
+    resources?: McpResourceInfo[];
+    resource_templates?: McpResourceTemplateInfo[];
+    auth_status?: McpAuthStatus;
+    authStatus?: McpAuthStatus;
+    oauth?: {
+        status: "not_required" | "required" | "authenticated" | "failed";
+        error?: string | null;
+    } | null;
+};
+export type McpServerStatusDetail = "full" | "toolsAndAuthOnly";
+export type McpServerStatusListOptions = {
+    detail?: McpServerStatusDetail | null;
+};
+export type McpServerRegistry = {
+    servers: Record<string, unknown>;
+};
+export type McpServerRefreshConfig = {
+    mcp_servers: Record<string, unknown>;
+    mcp_oauth_credentials_store_mode?: unknown;
+};
+export type McpRuntimeEnvironment = {
+    cwd: string;
+    environment_id?: string | null;
+};
+export type McpToolInfo = {
+    /** Raw MCP server name used to route protocol calls. */
+    server_name: string;
+    /** Raw MCP tool name sent back to the MCP server. */
+    name: string;
+    /** Model-visible namespace. Defaults to Codex's qualified MCP namespace. */
+    callable_namespace?: string | null;
+    /** Model-visible tool name. Defaults to `name` for simple hosts. */
+    callable_name?: string | null;
+    namespace_description?: string | null;
+    title?: string | null;
+    description?: string | null;
+    input_schema?: unknown;
+    connector_id?: string | null;
+    connector_name?: string | null;
+    plugin_display_names?: string[];
+    source_label?: string | null;
+    mcp_app_resource_uri?: string | null;
+};
+export type McpResourceInfo = {
+    uri: string;
+    name?: string | null;
+    description?: string | null;
+    mime_type?: string | null;
+};
+export type McpResourceTemplateInfo = McpResourceInfo & {
+    uri_template: string;
+};
+export type McpResourceReadParams = {
+    thread_id?: ThreadId | null;
+    server_name: string;
+    uri: string;
+};
+export type McpResourceListParams = {
+    thread_id?: ThreadId | null;
+    server_name?: string | null;
+    cursor?: string | null;
+};
+export type McpResourceListResponse = {
+    server_name?: string | null;
+    resources: McpResourceInfo[];
+    next_cursor?: string | null;
+};
+export type McpResourceTemplateListResponse = {
+    server_name?: string | null;
+    resource_templates: McpResourceTemplateInfo[];
+    next_cursor?: string | null;
+};
+export type McpResourceReadResponse = {
+    server_name: string;
+    uri: string;
+    contents: unknown[];
+};
+export type McpServerToolCallParams = {
+    thread_id: ThreadId;
+    call_id?: string | null;
+    server_name: string;
+    tool_name: string;
+    arguments?: unknown;
+    meta?: unknown;
+};
+export type McpServerToolCallResponse = {
+    call_id?: string | null;
+    server_name: string;
+    tool_name: string;
+    output: unknown;
+    response_item?: ResponseInputItem | null;
+};
+export type McpServerOauthLoginParams = {
+    name: string;
+};
+export type McpServerOauthLoginResponse = {
+    status: "unsupported" | "started";
+    name: string;
+    message?: string | null;
+};
+export type McpServerElicitationRequest = {
+    type: "form";
+    meta?: unknown;
+    message: string;
+    requested_schema: unknown;
+} | {
+    type: "url";
+    meta?: unknown;
+    message: string;
+    url: string;
+    elicitation_id?: string | null;
+};
+export type McpServerElicitationAction = "accept" | "decline" | "cancel";
+export type McpServerElicitationResponse = {
+    action: McpServerElicitationAction;
+    content?: unknown;
+    meta?: unknown;
+};
+export type McpServerElicitationRequestEvent = {
+    turn_id: string;
+    server_name: string;
+    id: McpRequestId;
+    request: McpServerElicitationRequest;
+};
+export type McpServerElicitationResponseOp = {
+    type: "mcp_server_elicitation_response";
+    server_name: string;
+    id: McpRequestId;
+    response: McpServerElicitationResponse;
+};
+export type McpToolCallProgressEvent = {
+    call_id: string;
+    turn_id?: string | null;
+    server_name: string;
+    tool_name: string;
+    message?: string | null;
+    progress?: unknown;
+};
+export type McpServerStatusUpdatedEvent = {
+    status: McpServerStatus;
+};
+export type McpServerOauthLoginCompletedEvent = {
+    name: string;
+    status: "completed" | "failed" | "cancelled";
+    error?: string | null;
+};
+export declare function mcpToolDisplayName(tool: McpToolInfo): string;
+export declare function mcpToolCallableNamespace(tool: McpToolInfo): string;
+export declare function mcpToolCallableName(tool: McpToolInfo): string;

package/dist/internal/codex/core/src/mcp.d.ts

@@ -0,0 +1 @@
+export * from "./mcp/index.js";

package/dist/internal/codex/core/src/memory.d.ts

@@ -0,0 +1,21 @@
+export declare const ThreadMemoryMode: {
+    readonly Enabled: "Enabled";
+    readonly Disabled: "Disabled";
+};
+export type ThreadMemoryMode = (typeof ThreadMemoryMode)[keyof typeof ThreadMemoryMode];
+export declare const ThreadMemoryModeSessionMetaValue: {
+    readonly Enabled: "enabled";
+    readonly Disabled: "disabled";
+};
+export type ThreadMemoryModeSessionMetaValue = (typeof ThreadMemoryModeSessionMetaValue)[keyof typeof ThreadMemoryModeSessionMetaValue];
+export declare function threadMemoryModeToSessionMetaValue(mode: ThreadMemoryMode): ThreadMemoryModeSessionMetaValue;
+export type MemoryCitation = {
+    entries: MemoryCitationEntry[];
+    rolloutIds: string[];
+};
+export type MemoryCitationEntry = {
+    path: string;
+    lineStart: number;
+    lineEnd: number;
+    note: string;
+};

package/dist/internal/codex/core/src/model-provider.d.ts

@@ -0,0 +1,193 @@
+import { type CodexAuth, type ProviderAccountState } from "./auth.js";
+import { type Personality } from "./protocol.js";
+export declare const OPENAI_PROVIDER_ID = "openai";
+export declare const CHATGPT_CODEX_PROVIDER_ID = "chatgpt-codex";
+export declare const OPENAI_PROVIDER_NAME = "OpenAI";
+export declare const CHATGPT_CODEX_PROVIDER_NAME = "ChatGPT Codex";
+export declare const OPENAI_RESPONSES_BASE_URL = "https://api.openai.com/v1";
+export declare const CHATGPT_CODEX_BASE_URL = "https://chatgpt.com/backend-api/codex";
+export type WireApi = "responses";
+export type ModelProviderAuthInfo = {
+    command: string;
+    args?: string[] | null;
+    env?: Record<string, string> | null;
+};
+export type ModelProviderAwsAuthInfo = {
+    profile?: string | null;
+    region?: string | null;
+};
+export type ModelProviderInfo = {
+    name: string;
+    base_url?: string | null;
+    env_key?: string | null;
+    env_key_instructions?: string | null;
+    experimental_bearer_token?: string | null;
+    auth?: ModelProviderAuthInfo | null;
+    aws?: ModelProviderAwsAuthInfo | null;
+    wire_api?: WireApi;
+    query_params?: Record<string, string> | null;
+    http_headers?: Record<string, string> | null;
+    env_http_headers?: Record<string, string> | null;
+    request_max_retries?: number | null;
+    stream_max_retries?: number | null;
+    stream_idle_timeout_ms?: number | null;
+    websocket_connect_timeout_ms?: number | null;
+    requires_openai_auth?: boolean;
+    supports_websockets?: boolean;
+};
+export type ProviderCapabilities = {
+    namespace_tools: boolean;
+    image_generation: boolean;
+    web_search: boolean;
+};
+export type ProviderRuntimeConfig = {
+    name: string;
+    base_url: string;
+    responses_url: string;
+    query_params: Record<string, string> | null;
+    headers: Record<string, string>;
+    request_max_retries: number;
+    stream_max_retries: number;
+    stream_idle_timeout_ms: number;
+    websocket_connect_timeout_ms: number;
+    supports_websockets: boolean;
+};
+export type ModelServiceTier = {
+    id: string;
+    name: string;
+    description: string;
+};
+export type ReasoningEffortOption = {
+    reasoning_effort: string;
+    description: string;
+};
+export type ModelInfo = {
+    slug: string;
+    display_name: string;
+    description: string | null;
+    default_reasoning_level: string | null;
+    supported_reasoning_levels: ReasoningEffortOption[];
+    visibility: "list" | "hide" | "none";
+    supported_in_api: boolean;
+    priority: number;
+    upgrade: string | null;
+    upgrade_info: null;
+    availability_nux: null;
+    input_modalities: string[];
+    supports_personality: boolean;
+    additional_speed_tiers: string[];
+    service_tiers: ModelServiceTier[];
+    base_instructions: string;
+    model_messages?: ModelMessages | null;
+    context_window?: number | null;
+    max_context_window?: number | null;
+    auto_compact_token_limit?: number | null;
+    effective_context_window_percent?: number | null;
+};
+export type ModelMessages = {
+    instructions_template?: string | null;
+    instructions_variables?: ModelInstructionsVariables | null;
+};
+export type ModelInstructionsVariables = {
+    personality?: Record<string, string> | null;
+};
+export type ModelPreset = {
+    id: string;
+    model: string;
+    upgrade: string | null;
+    upgrade_info: null;
+    availability_nux: null;
+    display_name: string;
+    description: string;
+    hidden: boolean;
+    supported_reasoning_efforts: ReasoningEffortOption[];
+    default_reasoning_effort: string;
+    input_modalities: string[];
+    supports_personality: boolean;
+    additional_speed_tiers: string[];
+    service_tiers: ModelServiceTier[];
+    is_default: boolean;
+    supported_in_api: boolean;
+};
+export type Model = ModelPreset;
+export type ModelListParams = {
+    cursor?: string | null;
+    limit?: number | null;
+    include_hidden?: boolean | null;
+};
+export type ModelListResponse = {
+    data: ModelPreset[];
+    next_cursor: string | null;
+};
+export type RefreshStrategy = "online" | "offline" | "online_if_uncached";
+export type ModelsManager = {
+    list_models(params?: ModelListParams): ModelListResponse;
+    raw_model_catalog(refresh_strategy?: RefreshStrategy): {
+        models: ModelInfo[];
+    };
+    get_model_info(model: string): ModelInfo;
+    get_default_model(model?: string | null): string;
+    default_reasoning_effort(model?: string | null): string;
+};
+export declare function get_model_instructions(model_info: ModelInfo, personality?: Personality | null): string;
+export declare function resolvedContextWindow(modelInfo: ModelInfo): number | null;
+export declare function effectiveContextWindow(modelInfo: ModelInfo): number | null;
+export declare function autoCompactTokenLimit(modelInfo: ModelInfo): number | null;
+export type ModelProvider = {
+    info(): ModelProviderInfo;
+    account_state(): ProviderAccountState;
+    capabilities(): ProviderCapabilities;
+    runtime_config(auth?: CodexAuth | null): ProviderRuntimeConfig;
+    models_manager(): ModelsManager;
+};
+export declare const defaultProviderCapabilities: ProviderCapabilities;
+export declare function createOpenAiModelProviderInfo(base_url?: string | null): ModelProviderInfo;
+export declare function createChatgptCodexModelProviderInfo(): ModelProviderInfo;
+export declare function validateModelProviderInfo(provider: ModelProviderInfo): void;
+export declare class ConfiguredModelProvider implements ModelProvider {
+    private readonly providerInfo;
+    private readonly accountState;
+    private readonly providerCapabilities;
+    private readonly manager;
+    constructor(input: {
+        info: ModelProviderInfo;
+        account_state?: ProviderAccountState;
+        capabilities?: ProviderCapabilities;
+        models_manager?: ModelsManager;
+    });
+    info(): ModelProviderInfo;
+    account_state(): ProviderAccountState;
+    capabilities(): ProviderCapabilities;
+    runtime_config(auth?: CodexAuth | null): ProviderRuntimeConfig;
+    models_manager(): ModelsManager;
+}
+export declare class StaticModelsManager implements ModelsManager {
+    private readonly models;
+    constructor(models?: ModelInfo[]);
+    list_models(params?: ModelListParams): ModelListResponse;
+    raw_model_catalog(): {
+        models: ModelInfo[];
+    };
+    get_model_info(model: string): ModelInfo;
+    get_default_model(model?: string | null): string;
+    default_reasoning_effort(model?: string | null): string;
+    private build_available_models;
+}
+export declare function createModelProvider(input?: {
+    info?: ModelProviderInfo;
+    auth?: CodexAuth | null;
+    account_state?: ProviderAccountState;
+    capabilities?: ProviderCapabilities;
+    models_manager?: ModelsManager;
+}): ModelProvider;
+export declare function defaultModelsManager(): ModelsManager;
+export declare function listDefaultCodexModels(params?: ModelListParams): ModelListResponse;
+export declare function defaultCodexModels(): Model[];
+export declare function defaultCodexModelInfo(): ModelInfo[];
+export declare function defaultModelProviderAccountState(): ProviderAccountState;
+export declare function apiKeyProviderAccountState(): ProviderAccountState;
+export declare function providerRuntimeConfig(provider: ModelProviderInfo, auth: CodexAuth | null): ProviderRuntimeConfig;
+export declare function modelInfoToPreset(info: ModelInfo): ModelPreset;
+export declare function modelInfoFromSlug(slug: string): ModelInfo;
+export declare function isReasoningEffortSupported(model: string, effort: string | null | undefined, manager?: ModelsManager): boolean;
+export declare function resolveReasoningEffortForModel(model: string, effort: string | null | undefined, manager?: ModelsManager): string;

package/dist/internal/codex/core/src/models.d.ts

@@ -0,0 +1,158 @@
+export type MessagePhase = "commentary" | "final_answer";
+export type ContentItem = {
+    type: "input_text";
+    text: string;
+} | {
+    type: "input_image";
+    image_url: string;
+    detail?: string | null;
+} | {
+    type: "output_text";
+    text: string;
+};
+export type FunctionCallOutputContentItem = {
+    type: "input_text";
+    text: string;
+} | {
+    type: "input_image";
+    image_url: string;
+    detail?: string | null;
+};
+export type FunctionCallOutputBody = {
+    type: "text";
+    text: string;
+} | {
+    type: "content_items";
+    items: FunctionCallOutputContentItem[];
+};
+export type FunctionCallOutputPayload = {
+    body: FunctionCallOutputBody;
+    success?: boolean | null;
+};
+export type MessageResponseInputItem = {
+    type: "message";
+    id?: string;
+    role: string;
+    content: ContentItem[];
+    phase?: MessagePhase | null;
+};
+export type FunctionCallOutputResponseInputItem = {
+    type: "function_call_output";
+    call_id: string;
+    output: FunctionCallOutputPayload;
+};
+export type CustomToolCallOutputResponseInputItem = {
+    type: "custom_tool_call_output";
+    call_id: string;
+    name?: string | null;
+    output: FunctionCallOutputPayload;
+};
+export type McpToolCallOutputResponseInputItem = {
+    type: "mcp_tool_call_output";
+    call_id: string;
+    output: unknown;
+};
+export type ToolSearchOutputResponseInputItem = {
+    type: "tool_search_output";
+    call_id: string;
+    status: "completed";
+    execution: "client";
+    tools: unknown[];
+};
+export type ResponseInputItem = MessageResponseInputItem | FunctionCallOutputResponseInputItem | CustomToolCallOutputResponseInputItem | McpToolCallOutputResponseInputItem | ToolSearchOutputResponseInputItem;
+export type ResponseMessageItem = {
+    type: "message";
+    id?: string;
+    role: string;
+    content: ContentItem[];
+    phase?: MessagePhase | null;
+};
+export type ReasoningItemReasoningSummary = Record<string, unknown>;
+export type ReasoningItemContent = Record<string, unknown>;
+export type ResponseReasoningItem = {
+    type: "reasoning";
+    id?: string;
+    summary: ReasoningItemReasoningSummary[];
+    content?: ReasoningItemContent[] | null;
+    encrypted_content?: string | null;
+};
+export type ResponseLocalShellCallItem = {
+    type: "local_shell_call";
+    id?: string | null;
+    call_id?: string | null;
+    status?: string | null;
+    action: Record<string, unknown>;
+};
+export type ResponseFunctionCallItem = {
+    type: "function_call";
+    id?: string | null;
+    name: string;
+    namespace?: string | null;
+    arguments: string;
+    call_id: string;
+};
+export type ResponseToolSearchCallItem = {
+    type: "tool_search_call";
+    id?: string | null;
+    call_id?: string | null;
+    status?: string | null;
+    execution: string;
+    arguments: unknown;
+};
+export type ResponseFunctionCallOutputItem = {
+    type: "function_call_output";
+    call_id: string;
+    output: FunctionCallOutputPayload;
+};
+export type ResponseCustomToolCallItem = {
+    type: "custom_tool_call";
+    id?: string | null;
+    status?: string | null;
+    call_id: string;
+    name: string;
+    input: string;
+};
+export type ResponseCustomToolCallOutputItem = {
+    type: "custom_tool_call_output";
+    call_id: string;
+    name?: string | null;
+    output: FunctionCallOutputPayload;
+};
+export type ResponseToolSearchOutputItem = {
+    type: "tool_search_output";
+    call_id?: string | null;
+    status: string;
+    execution: string;
+    tools: unknown[];
+};
+export type ResponseWebSearchCallItem = {
+    type: "web_search_call";
+    id?: string | null;
+    status?: string | null;
+    action?: Record<string, unknown> | null;
+};
+export type ResponseImageGenerationCallItem = {
+    type: "image_generation_call";
+    id: string;
+    status: string;
+    revised_prompt?: string | null;
+    result: string;
+    saved_path?: string;
+};
+export type ResponseCompactionItem = {
+    type: "compaction" | "context_compaction";
+    encrypted_content?: string | null;
+};
+export type ResponseOtherItem = {
+    type: "other";
+};
+export type ResponseItem = ResponseMessageItem | ResponseReasoningItem | ResponseLocalShellCallItem | ResponseFunctionCallItem | ResponseToolSearchCallItem | ResponseFunctionCallOutputItem | ResponseCustomToolCallItem | ResponseCustomToolCallOutputItem | ResponseToolSearchOutputItem | ResponseWebSearchCallItem | ResponseImageGenerationCallItem | ResponseCompactionItem | ResponseOtherItem;
+export type ResponseItemWire = (Omit<ResponseMessageItem, "phase"> & {
+    phase?: MessagePhase | null;
+}) | ResponseReasoningItem | ResponseLocalShellCallItem | ResponseFunctionCallItem | ResponseToolSearchCallItem | (Omit<ResponseFunctionCallOutputItem, "output"> & {
+    output: string | FunctionCallOutputContentItem[];
+}) | ResponseCustomToolCallItem | (Omit<ResponseCustomToolCallOutputItem, "output"> & {
+    output: string | FunctionCallOutputContentItem[];
+}) | ResponseToolSearchOutputItem | ResponseWebSearchCallItem | ResponseImageGenerationCallItem | ResponseCompactionItem | ResponseOtherItem;
+export declare function responseInputToResponseItem(item: ResponseInputItem): ResponseItem;
+export declare function functionCallOutputPayloadToWire(output: FunctionCallOutputPayload): string | FunctionCallOutputContentItem[];

package/dist/internal/codex/core/src/plan-mode.d.ts

@@ -0,0 +1 @@
+export declare const CODEX_PLAN_MODE_INSTRUCTIONS = "# Plan Mode (Conversational)\n\nYou work in 3 phases, and you should *chat your way* to a great plan before finalizing it. A great plan is very detailed\u2014intent- and implementation-wise\u2014so that it can be handed to another engineer or agent to be implemented right away. It must be **decision complete**, where the implementer does not need to make any decisions.\n\n## Mode rules (strict)\n\nYou are in **Plan Mode** until a developer message explicitly ends it.\n\nPlan Mode is not changed by user intent, tone, or imperative language. If a user asks for execution while still in Plan Mode, treat it as a request to **plan the execution**, not perform it.\n\n## Plan Mode vs update_plan tool\n\nPlan Mode is a collaboration mode that can involve requesting user input and eventually issuing a `<proposed_plan>` block.\n\nSeparately, `update_plan` is a checklist/progress/TODOs tool; it does not enter or exit Plan Mode. Do not confuse it with Plan mode or try to use it while in Plan mode. If you try to use `update_plan` in Plan mode, it will return an error.\n\n## Execution vs. mutation in Plan Mode\n\nYou may explore and execute **non-mutating** actions that improve the plan. You must not perform **mutating** actions.\n\n### Allowed (non-mutating, plan-improving)\n\nActions that gather truth, reduce ambiguity, or validate feasibility without changing repo-tracked state. Examples:\n\n* Reading or searching files, configs, schemas, types, manifests, and docs\n* Static analysis, inspection, and repo exploration\n* Dry-run style commands when they do not edit repo-tracked files\n* Tests, builds, or checks that may write to caches or build artifacts (for example, `target/`, `.cache/`, or snapshots) so long as they do not edit repo-tracked files\n\n### Not allowed (mutating, plan-executing)\n\nActions that implement the plan or change repo-tracked state. Examples:\n\n* Editing or writing files\n* Running formatters or linters that rewrite files\n* Applying patches, migrations, or codegen that updates repo-tracked files\n* Side-effectful commands whose purpose is to carry out the plan rather than refine it\n\nWhen in doubt: if the action would reasonably be described as \"doing the work\" rather than \"planning the work,\" do not do it.\n\n## PHASE 1 \u2014 Ground in the environment (explore first, ask second)\n\nBegin by grounding yourself in the actual environment. Eliminate unknowns in the prompt by discovering facts, not by asking the user. Resolve all questions that can be answered through exploration or inspection. Identify missing or ambiguous details only if they cannot be derived from the environment. Silent exploration between turns is allowed and encouraged.\n\nBefore asking the user any question, perform at least one targeted non-mutating exploration pass (for example: search relevant files, inspect likely entrypoints/configs, confirm current implementation shape), unless no local environment/repo is available.\n\nException: you may ask clarifying questions about the user's prompt before exploring, ONLY if there are obvious ambiguities or contradictions in the prompt itself. However, if ambiguity might be resolved by exploring, always prefer exploring first.\n\nDo not ask questions that can be answered from the repo or system (for example, \"where is this struct?\" or \"which UI component should we use?\" when exploration can make it clear). Only ask once you have exhausted reasonable non-mutating exploration.\n\n## PHASE 2 \u2014 Intent chat (what they actually want)\n\n* Keep asking until you can clearly state: goal + success criteria, audience, in/out of scope, constraints, current state, and the key preferences/tradeoffs.\n* Bias toward questions over guessing: if any high-impact ambiguity remains, do NOT plan yet\u2014ask.\n\n## PHASE 3 \u2014 Implementation chat (what/how we\u2019ll build)\n\n* Once intent is stable, keep asking until the spec is decision complete: approach, interfaces (APIs/schemas/I/O), data flow, edge cases/failure modes, testing + acceptance criteria, rollout/monitoring, and any migrations/compat constraints.\n\n## Asking questions\n\nCritical rules:\n\n* Strongly prefer using the `request_user_input` tool to ask any questions.\n* Offer only meaningful multiple\u2011choice options; don\u2019t include filler choices that are obviously wrong or irrelevant.\n* In rare cases where an unavoidable, important question can\u2019t be expressed with reasonable multiple\u2011choice options (due to extreme ambiguity), you may ask it directly without the tool.\n\nYou SHOULD ask many questions, but each question must:\n\n* materially change the spec/plan, OR\n* confirm/lock an assumption, OR\n* choose between meaningful tradeoffs.\n* not be answerable by non-mutating commands.\n\nUse the `request_user_input` tool only for decisions that materially change the plan, for confirming important assumptions, or for information that cannot be discovered via non-mutating exploration.\n\n## Two kinds of unknowns (treat differently)\n\n1. **Discoverable facts** (repo/system truth): explore first.\n\n   * Before asking, run targeted searches and check likely sources of truth (configs/manifests/entrypoints/schemas/types/constants).\n   * Ask only if: multiple plausible candidates; nothing found but you need a missing identifier/context; or ambiguity is actually product intent.\n   * If asking, present concrete candidates (paths/service names) + recommend one.\n   * Never ask questions you can answer from your environment (e.g., \u201Cwhere is this struct\u201D).\n\n2. **Preferences/tradeoffs** (not discoverable): ask early.\n\n   * These are intent or implementation preferences that cannot be derived from exploration.\n   * Provide 2\u20134 mutually exclusive options + a recommended default.\n   * If unanswered, proceed with the recommended option and record it as an assumption in the final plan.\n\n## Finalization rule\n\nOnly output the final plan when it is decision complete and leaves no decisions to the implementer.\n\nWhen you present the official plan, wrap it in a `<proposed_plan>` block so the client can render it specially:\n\n1) The opening tag must be on its own line.\n2) Start the plan content on the next line (no text on the same line as the tag).\n3) The closing tag must be on its own line.\n4) Use Markdown inside the block.\n5) Keep the tags exactly as `<proposed_plan>` and `</proposed_plan>` (do not translate or rename them), even if the plan content is in another language.\n\nExample:\n\n<proposed_plan>\nplan content\n</proposed_plan>\n\nplan content should be human and agent digestible. The final plan must be plan-only, concise by default, and include:\n\n* A clear title\n* A brief summary section\n* Important changes or additions to public APIs/interfaces/types\n* Test cases and scenarios\n* Explicit assumptions and defaults chosen where needed\n\nWhen possible, prefer a compact structure with 3-5 short sections, usually: Summary, Key Changes or Implementation Changes, Test Plan, and Assumptions. Do not include a separate Scope section unless scope boundaries are genuinely important to avoid mistakes.\n\nPrefer grouped implementation bullets by subsystem or behavior over file-by-file inventories. Mention files only when needed to disambiguate a non-obvious change, and avoid naming more than 3 paths unless extra specificity is necessary to prevent mistakes. Prefer behavior-level descriptions over symbol-by-symbol removal lists. For v1 feature-addition plans, do not invent detailed schema, validation, precedence, fallback, or wire-shape policy unless the request establishes it or it is needed to prevent a concrete implementation mistake; prefer the intended capability and minimum interface/behavior changes.\n\nKeep bullets short and avoid explanatory sub-bullets unless they are needed to prevent ambiguity. Prefer the minimum detail needed for implementation safety, not exhaustive coverage. Within each section, compress related changes into a few high-signal bullets and omit branch-by-branch logic, repeated invariants, and long lists of unaffected behavior unless they are necessary to prevent a likely implementation mistake. Avoid repeated repo facts and irrelevant edge-case or rollout detail. For straightforward refactors, keep the plan to a compact summary, key edits, tests, and assumptions. If the user asks for more detail, then expand.\n\nDo not ask \"should I proceed?\" in the final output. The user can easily switch out of Plan mode and request implementation if you have included a `<proposed_plan>` block in your response. Alternatively, they can decide to stay in Plan mode and continue refining the plan.\n\nOnly produce at most one `<proposed_plan>` block per turn, and only when you are presenting a complete spec.\n\nIf the user stays in Plan mode and asks for revisions after a prior `<proposed_plan>`, any new `<proposed_plan>` must be a complete replacement.";