@ai-sdk/harness-codex 0.0.0 → 1.0.0-beta.11

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import * as _ai_sdk_harness from '@ai-sdk/harness';
+import { HarnessV1, HarnessV1BuiltinTool } from '@ai-sdk/harness';
+
+type CodexAuthOptions = {
+    readonly openaiCompatible?: {
+        readonly apiKey?: string;
+        readonly baseUrl?: string;
+        readonly modelProviderName?: string;
+        readonly queryParamsJson?: string;
+    };
+    readonly openai?: {
+        readonly apiKey?: string;
+        readonly baseUrl?: string;
+        readonly organization?: string;
+        readonly project?: string;
+    };
+    readonly gateway?: {
+        readonly apiKey?: string;
+        readonly baseUrl?: string;
+    };
+};
+
+type CodexHarnessSettings = {
+    readonly auth?: CodexAuthOptions;
+    /**
+     * OpenAI model id the underlying `codex` CLI should use. Leaving this unset
+     * pins the adapter default (`DEFAULT_CODEX_MODEL`).
+     */
+    readonly model?: string;
+    /**
+     * Reasoning effort for reasoning-capable models. Leaving this unset
+     * defers to the CLI's default.
+     */
+    readonly reasoningEffort?: 'low' | 'medium' | 'high';
+    /**
+     * When `true`, allow the underlying runtime to use live web search.
+     */
+    readonly webSearch?: boolean;
+    /**
+     * Override the port the bridge binds inside the sandbox. By default the
+     * adapter uses the first port the sandbox declares via `sandbox.ports`.
+     * Only set this if the sandbox declares multiple ports and the first one
+     * is reserved for something else.
+     */
+    readonly port?: number;
+    /** Maximum milliseconds to wait for the bridge to advertise its port. Defaults to 120000. */
+    readonly startupTimeoutMs?: number;
+};
+declare const CODEX_BUILTIN_TOOLS: {
+    readonly bash: HarnessV1BuiltinTool<{
+        command: string;
+    }, unknown>;
+    readonly webSearch: HarnessV1BuiltinTool<{
+        query: string;
+    }, unknown>;
+};
+declare function createCodex(settings?: CodexHarnessSettings): HarnessV1<typeof CODEX_BUILTIN_TOOLS>;
+
+/**
+ * Default `codex` harness instance with no overrides — suitable for the
+ * common case where the underlying `codex` CLI's defaults are fine.
+ * Equivalent to `createCodex()`.
+ */
+declare const codex: _ai_sdk_harness.HarnessV1<{
+    readonly bash: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        command: string;
+    }, unknown>;
+    readonly webSearch: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        query: string;
+    }, unknown>;
+}>;
+
+export { type CodexAuthOptions, type CodexHarnessSettings, codex, createCodex };