@agentfield/sdk 0.1.143-rc.3 → 0.1.143-rc.5

package/dist/index.d.ts

@@ -334,6 +334,8 @@ declare class AIClient {
     private readonly config;
     private rateLimiter?;
     constructor(config?: AIConfig);
+    /** Prompt-template overrides configured on this agent, if any (issue #229). */
+    get promptTemplates(): AIConfig['promptTemplates'];
     generate<T>(prompt: string, options: AIRequestOptions & {
         schema: ZodSchema<T>;
     }): Promise<T>;
@@ -1137,6 +1139,85 @@ declare class DidInterface {
     exportAuditTrail(filters?: AuditTrailFilters): Promise<AuditTrailExport>;
 }
 
+/**
+ * Configurable templates for the text and tool-message framing the SDK injects
+ * into LLM calls (issue #229).
+ *
+ * Field names line up with the Python SDK's `PromptTemplates` and the Go SDK's
+ * `PromptConfig` (`toolCallLimitReached`, `toolErrorFormatter`,
+ * `toolResultFormatter`). Defaults reproduce the SDK's prior output exactly, so
+ * a reasoner that never sets `promptTemplates` sees no change.
+ *
+ * The TypeScript SDK uses the Vercel AI SDK's native structured output
+ * (`generateObject`) and injects no schema instruction, so, unlike Python,
+ * there is no `schemaInstruction` field here.
+ */
+/** Formats a failed tool call before it is returned to the model. */
+type ToolErrorFormatter = (toolName: string, error: string) => unknown;
+/** Formats a successful tool call before it is returned to the model. */
+type ToolResultFormatter = (toolName: string, result: unknown) => unknown;
+interface PromptTemplates {
+    /**
+     * Optional system prompt describing how to use tools, appended after the
+     * caller's system prompt. Undefined means nothing is injected (the default),
+     * so existing `tools=` calls are unchanged; set it to opt in.
+     */
+    toolSystemPrompt?: string;
+    /** Message returned to the model when the tool-call limit is reached. */
+    toolCallLimitReached?: string;
+    /**
+     * Formats a failed tool call `(toolName, error)` before it is sent back to
+     * the model. Return a string to send verbatim, or any value to be returned
+     * as-is (the AI SDK serializes it).
+     */
+    toolErrorFormatter?: ToolErrorFormatter;
+    /**
+     * Formats a successful tool call `(toolName, result)` before it is sent back
+     * to the model. Return a string to send verbatim, or any value to be
+     * returned as-is.
+     */
+    toolResultFormatter?: ToolResultFormatter;
+}
+declare const DEFAULT_TOOL_CALL_LIMIT_REACHED = "Tool call limit reached. Please provide a final response.";
+/** Default tool-error framing: the prior `{ error, tool }` object. */
+declare const defaultToolErrorFormatter: ToolErrorFormatter;
+/** Default tool-result framing: the raw result, unframed. */
+declare const defaultToolResultFormatter: ToolResultFormatter;
+/** A fully-populated set of templates with every default filled in. */
+interface ResolvedPromptTemplates {
+    toolSystemPrompt?: string;
+    toolCallLimitReached: string;
+    toolErrorFormatter: ToolErrorFormatter;
+    toolResultFormatter: ToolResultFormatter;
+}
+/**
+ * Merges a partial override over the built-in defaults. An undefined field
+ * (or an undefined `overrides`) keeps the default; `toolSystemPrompt` stays
+ * undefined unless explicitly set.
+ */
+declare function resolvePromptTemplates(overrides?: Partial<PromptTemplates>): ResolvedPromptTemplates;
+/**
+ * Cross-SDK message-source taxonomy, shared with the Python and Go SDKs so a
+ * trace tagged in one SDK reads the same in another (issue #229).
+ * `sdk.schema_instruction` exists only in the Python SDK (which injects it;
+ * TypeScript uses native structured output).
+ */
+type MessageSource = 'user' | 'assistant' | 'sdk.tool_system_prompt' | 'sdk.tool_result' | 'sdk.tool_error' | 'sdk.tool_limit';
+declare const TRACE_SOURCE_USER = "user";
+declare const TRACE_SOURCE_ASSISTANT = "assistant";
+declare const TRACE_SOURCE_TOOL_SYSTEM_PROMPT = "sdk.tool_system_prompt";
+declare const TRACE_SOURCE_TOOL_RESULT = "sdk.tool_result";
+declare const TRACE_SOURCE_TOOL_ERROR = "sdk.tool_error";
+declare const TRACE_SOURCE_TOOL_LIMIT = "sdk.tool_limit";
+/**
+ * Tags a message the loop sent with where it came from. `message` references
+ * the wire content (not a reshaped copy); `source` uses the taxonomy above.
+ */
+interface TracedMessage {
+    message: unknown;
+    source: MessageSource;
+}
+
 /**
  * Tool calling support for AgentField agents.
  *
@@ -1163,6 +1244,11 @@ interface ToolCallConfig {
     agentIds?: string[];
     /** Filter by health status (default: "healthy"). */
     healthStatus?: string;
+    /**
+     * Overridable text and tool-message framing. Defaults reproduce the SDK's
+     * prior output byte-for-byte (issue #229).
+     */
+    promptTemplates?: Partial<PromptTemplates>;
 }
 interface ToolCallRecord {
     toolName: string;
@@ -1177,6 +1263,12 @@ interface ToolCallTrace {
     totalTurns: number;
     totalToolCalls: number;
     finalResponse?: string;
+    /**
+     * Each message the loop sent, tagged with its source. Optional and additive
+     * so callers that build a ToolCallTrace in their own tests are unaffected
+     * (issue #229).
+     */
+    messages?: TracedMessage[];
 }
 /**
  * Options for tool-calling in ctx.ai().
@@ -1531,11 +1623,11 @@ interface SkillOptions {
 
 interface HarnessConfig {
     /**
-     * Coding agent provider. Defaults to `aforge`, AgentField's native harness.
+     * Coding agent provider. Defaults to `codeaf`, AgentField's native harness.
      * When unset, `AGENTFIELD_HARNESS_PROVIDER` is consulted before the default.
      * An explicit value always wins.
      */
-    provider?: 'aforge' | 'claude-code' | 'codex' | 'gemini' | 'opencode' | 'pi' | 'omp';
+    provider?: 'codeaf' | 'aforge' | 'claude-code' | 'codex' | 'gemini' | 'opencode' | 'pi' | 'omp';
     /** Model identifier. Empty means the provider's own default. */
     model?: string;
     /**
@@ -1555,6 +1647,7 @@ interface HarnessConfig {
     env?: Record<string, string>;
     cwd?: string;
     projectDir?: string;
+    codeafBin?: string;
     aforgeBin?: string;
     codexBin?: string;
     geminiBin?: string;
@@ -1564,7 +1657,7 @@ interface HarnessConfig {
 }
 interface HarnessOptions {
     /**
-     * Coding agent provider. Defaults to `aforge`, AgentField's native harness.
+     * Coding agent provider. Defaults to `codeaf`, AgentField's native harness.
      * When unset, `AGENTFIELD_HARNESS_PROVIDER` is consulted before the default.
      * An explicit value always wins.
      */
@@ -1588,6 +1681,7 @@ interface HarnessOptions {
     env?: Record<string, string>;
     cwd?: string;
     projectDir?: string;
+    codeafBin?: string;
     aforgeBin?: string;
     codexBin?: string;
     geminiBin?: string;
@@ -1616,6 +1710,8 @@ interface Metrics {
 }
 type FailureType = 'none' | 'crash' | 'timeout' | 'api_error' | 'no_output' | 'schema';
 interface RawResult {
+    /** Actual adapter used, including alias resolution and legacy fallback. */
+    provider?: string;
     result?: string;
     messages: Array<Record<string, unknown>>;
     metrics: Metrics;
@@ -1625,6 +1721,8 @@ interface RawResult {
     returnCode?: number;
 }
 interface HarnessResult {
+    /** Actual provider used for this run. */
+    provider?: string;
     result?: string;
     parsed?: unknown;
     isError: boolean;
@@ -1714,6 +1812,11 @@ interface AIConfig {
     rateLimitJitterFactor?: number;
     rateLimitCircuitBreakerThreshold?: number;
     rateLimitCircuitBreakerTimeout?: number;
+    /**
+     * Overridable templates for text and tool-message framing the SDK injects
+     * into LLM calls. Merged over the defaults per call (issue #229).
+     */
+    promptTemplates?: Partial<PromptTemplates>;
 }
 interface MemoryConfig {
     defaultScope?: MemoryScope;
@@ -1901,6 +2004,7 @@ type RunnerOptions = Omit<HarnessOptions, 'schema'> & {
     maxDelay?: number;
     backoffFactor?: number;
     projectDir?: string;
+    codeafBin?: string;
     aforgeBin?: string;
     codexBin?: string;
     geminiBin?: string;
@@ -1923,6 +2027,12 @@ declare class HarnessRunner {
 
 type Environment = Readonly<Record<string, string | undefined>>;
 declare const PROVIDER_SPECS: {
+    readonly codeaf: {
+        readonly binary: "codeaf";
+        readonly versionArgs: readonly ["version"];
+        readonly installCommand: "af codeaf ensure";
+        readonly authEnvVars: readonly ["OPENROUTER_API_KEY"];
+    };
     readonly aforge: {
         readonly binary: "aforge";
         readonly versionArgs: readonly ["version"];
@@ -1967,7 +2077,7 @@ declare const PROVIDER_SPECS: {
     };
 };
 type HarnessProviderName = keyof typeof PROVIDER_SPECS;
-declare const SUPPORTED_PROVIDER_NAMES: readonly ("gemini" | "aforge" | "claude-code" | "codex" | "opencode" | "pi" | "omp")[];
+declare const SUPPORTED_PROVIDER_NAMES: readonly ("gemini" | "codeaf" | "aforge" | "claude-code" | "codex" | "opencode" | "pi" | "omp")[];
 interface ProviderHealth {
     provider: HarnessProviderName;
     binary: string | null;
@@ -2840,16 +2950,38 @@ declare function splitModelVariant(model: unknown): ModelVariant;
 declare function resolveModelAndVariant(options: Record<string, unknown>): ModelVariant;
 
 declare const SUPPORTED_PROVIDERS: ReadonlySet<string>;
-declare const DEFAULT_HARNESS_PROVIDER = "aforge";
+declare const DEFAULT_HARNESS_PROVIDER = "codeaf";
 declare const HARNESS_PROVIDER_ENV_VAR = "AGENTFIELD_HARNESS_PROVIDER";
 /**
  * Applies harness provider precedence: an explicit name wins, then
- * AGENTFIELD_HARNESS_PROVIDER, then DEFAULT_HARNESS_PROVIDER ("aforge").
+ * AGENTFIELD_HARNESS_PROVIDER, then DEFAULT_HARNESS_PROVIDER ("codeaf").
  * Blank / whitespace-only values are treated as unset.
  */
 declare function resolveProviderName(explicit?: string): string;
 declare function buildProvider(config: HarnessConfig): Promise<HarnessProvider>;
 
+/**
+ * Aforge CLI provider. `exec` is the default direct one-shot entry point; set
+ * `AGENTFIELD_AFORGE_COMMAND=do` to opt into Aforge's routed workflow.
+ */
+declare class AforgeProvider implements HarnessProvider {
+    private readonly deadline?;
+    private readonly bin;
+    constructor(bin?: string, deadline?: number | undefined);
+    execute(prompt: string, options: Record<string, unknown>): Promise<RawResult>;
+    private executeImpl;
+}
+
+declare const CODEAF_DEFAULT_MODEL = "~deepseek/deepseek-v4-flash-latest";
+/** Canonical CodeAF headless adapter, with lazy managed installation and legacy fallback. */
+declare class CodeafProvider implements HarnessProvider {
+    private readonly bin?;
+    private readonly alias;
+    constructor(bin?: string | undefined, alias?: boolean);
+    execute(prompt: string, options: Record<string, unknown>): Promise<RawResult>;
+    private executeImpl;
+}
+
 /**
  * Canonical execution status utilities for the AgentField TypeScript SDK.
  *
@@ -3186,4 +3318,4 @@ declare function simulateSchedule<R>(handler: (ctx: SimulatedContext) => R | Pro
  */
 declare function loadFixture(source: string): Record<string, unknown>;
 
-export { ACTIVE_STATUSES, AIClient, type AIConfig, type AIEmbeddingOptions, type AIRequestOptions, type AIStream, type AIToolRequestOptions, Agent, type AgentCapability, type AgentConfig, type AgentHandler, AgentRouter, type AgentRouterOptions, type AgentState, ApprovalClient, type ApprovalDecision, type ApprovalRequestResponse, ApprovalResult, type ApprovalStatusResponse, Audio, type AudioOutput, type AudioRequest, type AuditTrailExport, type AuditTrailFilters, type Awaitable, type BinaryResolver, CANONICAL_STATUSES, type CompactCapability, type CompactDiscoveryResponse, type CostEntry, type CostEntryInit, CostTracker, DEFAULT_HARNESS_PROVIDER, DIDAuthenticator, type DIDIdentity, type DIDIdentityPackage, type DIDRegistrationRequest, type DIDRegistrationResponse, type DeploymentType, DidClient, DidInterface, DidManager, type DidResolver, type DiscoveryFormat, type DiscoveryOptions, type DiscoveryPagination, type DiscoveryResponse, type DiscoveryResult, type EventTriggerBinding, type EventTriggerSpec, ExecutionContext, type ExecutionCredential, type ExecutionLogAttributes, type ExecutionLogBatchPayload, type ExecutionLogContext, type ExecutionLogEmitOptions, type ExecutionLogEntry, type ExecutionLogLevel, type ExecutionLogTransport, type ExecutionLogTransportPayload, type ExecutionLogWireEntry, ExecutionLogger, type ExecutionLoggerOptions, type ExecutionMetadata, ExecutionStatus, type ExecutionStatusValue, File, type FileOutput, type GenerateCredentialOptions, type GenerateCredentialParams, HARNESS_PROVIDER_ENV_VAR, HEADER_CALLER_DID, HEADER_DID_NONCE, HEADER_DID_SIGNATURE, HEADER_DID_TIMESTAMP, type HarnessConfig, type HarnessDoctorOptions, type HarnessOptions, type HarnessProvider, type HarnessProviderName, HarnessProviderUnavailable, type HarnessResult, HarnessRunner, type HealthStatus, Image, type ImageOutput, type ImageRequest, JWE_ALG, JWE_ENC, KEY_AGREEMENT_TYPE, MODEL_VARIANT_SEP, type MediaProvider, MediaProviderError, type MediaResponse, MediaRouter, type MemoryChangeEvent, MemoryClient, MemoryClientBase, type MemoryConfig, MemoryEventClient, type MemoryEventHandler, type MemoryEventHistoryOptions, type MemoryEventSubscriptionOptions, MemoryInterface, type MemoryRequestMetadata, type MemoryRequestOptions, type MemoryScope, type MemoryWatchHandler, type Metrics, type ModelVariant, type MultimodalContent, MultimodalResponse, OpenRouterMediaProvider, type OpenRouterMediaProviderOptions, PauseClock, PauseManager, type Payload, PayloadEncryptionError, type ProviderHealth, RateLimitError, type RateLimiterOptions, type RawExecutionContext, type RawResult, RealtimeSession, type ReasonerCapability, ReasonerContext, type ReasonerDefinition, type ReasonerHandler, type ReasonerOptions, type RequestApprovalPayload, SUPPORTED_PROVIDERS, SUPPORTED_PROVIDER_NAMES, SUPPORTED_SESSION_TRANSPORTS, type ScheduleTriggerBinding, type ScheduleTriggerSpec, type ServerlessAdapter, type ServerlessEvent, type ServerlessResponse, type SessionDefinition, type SessionOptions, type SessionProvider, type SessionTransport, type SessionTransportCapability, SessionTransportError, type SessionTurn, type SimulateScheduleOptions, type SimulateTriggerOptions, type SimulatedContext, type SkillCapability, SkillContext, type SkillDefinition, type SkillHandler, type SkillOptions, StatelessRateLimiter, TERMINAL_STATUSES, Text, type ToolCallConfig, type ToolCallRecord, type ToolCallTrace, type ToolsOption, type TriggerBinding, type TriggerContext, type TriggerEnvelope, type TurnDetection, USAGE_ENVELOPE_KEY, type UnwrapResult, type UsageEntryWire, type UsageSummaryWire, type VectorSearchOptions, type VectorSearchResult, type VersionProbe, Video, type VideoFrameImage, type VideoInputReference, type VideoRequest, type WaitForApprovalOptions, type WorkflowCredential, type WorkflowMetadata, type WorkflowProgressOptions, WorkflowReporter, type WrapperProbe, type ZodSchema, applyTriggerTransform, attachUsageToSyncResult, audioFromBase64, audioFromBuffer, audioFromFile, audioFromUrl, audioMediaType, buildProvider, buildSessionDefinition, buildToolConfig, capabilitiesToTools, capabilityToMetadataTool, capabilityToTool, createExecutionLogger, createHarnessResult, createMetrics, createMultimodalResponse, createRawResult, decrypt, decryptToString, deriveProvider, encryptForDid, encryptToJwk, ensureCliAvailable, eventTrigger, executeToolCallLoop, extractKeyAgreementJwk, fileFromBase64, fileFromBuffer, fileFromPath, fileFromUrl, findExecutable, generateX25519KeyPair, getCurrentContext, getCurrentSkillContext, guessUrlMimeType, harnessDoctor, imageFromBase64, imageFromBuffer, imageFromFile, imageFromUrl, installApprovalWebhookRoute, isActive, isExecutionLogBatchPayload, isTerminal, isTriggerEnvelope, loadFixture, normalizeExecutionLogEntry, normalizeSessionTransportValue, normalizeStatus, normalizeTurnDetection, resolveModelAndVariant, resolveProviderName, scheduleTrigger, serializeExecutionLogEntry, simulateSchedule, simulateTrigger, splitModelVariant, text, triggerToPayload, unwrapEnvelope, usageSummaryOrNull, validateSessionTransport, videoFromBase64, videoFromBuffer, videoFromFile, videoFromUrl };
+export { ACTIVE_STATUSES, AIClient, type AIConfig, type AIEmbeddingOptions, type AIRequestOptions, type AIStream, type AIToolRequestOptions, AforgeProvider, Agent, type AgentCapability, type AgentConfig, type AgentHandler, AgentRouter, type AgentRouterOptions, type AgentState, ApprovalClient, type ApprovalDecision, type ApprovalRequestResponse, ApprovalResult, type ApprovalStatusResponse, Audio, type AudioOutput, type AudioRequest, type AuditTrailExport, type AuditTrailFilters, type Awaitable, type BinaryResolver, CANONICAL_STATUSES, CODEAF_DEFAULT_MODEL, CodeafProvider, type CompactCapability, type CompactDiscoveryResponse, type CostEntry, type CostEntryInit, CostTracker, DEFAULT_HARNESS_PROVIDER, DEFAULT_TOOL_CALL_LIMIT_REACHED, DIDAuthenticator, type DIDIdentity, type DIDIdentityPackage, type DIDRegistrationRequest, type DIDRegistrationResponse, type DeploymentType, DidClient, DidInterface, DidManager, type DidResolver, type DiscoveryFormat, type DiscoveryOptions, type DiscoveryPagination, type DiscoveryResponse, type DiscoveryResult, type EventTriggerBinding, type EventTriggerSpec, ExecutionContext, type ExecutionCredential, type ExecutionLogAttributes, type ExecutionLogBatchPayload, type ExecutionLogContext, type ExecutionLogEmitOptions, type ExecutionLogEntry, type ExecutionLogLevel, type ExecutionLogTransport, type ExecutionLogTransportPayload, type ExecutionLogWireEntry, ExecutionLogger, type ExecutionLoggerOptions, type ExecutionMetadata, ExecutionStatus, type ExecutionStatusValue, File, type FileOutput, type GenerateCredentialOptions, type GenerateCredentialParams, HARNESS_PROVIDER_ENV_VAR, HEADER_CALLER_DID, HEADER_DID_NONCE, HEADER_DID_SIGNATURE, HEADER_DID_TIMESTAMP, type HarnessConfig, type HarnessDoctorOptions, type HarnessOptions, type HarnessProvider, type HarnessProviderName, HarnessProviderUnavailable, type HarnessResult, HarnessRunner, type HealthStatus, Image, type ImageOutput, type ImageRequest, JWE_ALG, JWE_ENC, KEY_AGREEMENT_TYPE, MODEL_VARIANT_SEP, type MediaProvider, MediaProviderError, type MediaResponse, MediaRouter, type MemoryChangeEvent, MemoryClient, MemoryClientBase, type MemoryConfig, MemoryEventClient, type MemoryEventHandler, type MemoryEventHistoryOptions, type MemoryEventSubscriptionOptions, MemoryInterface, type MemoryRequestMetadata, type MemoryRequestOptions, type MemoryScope, type MemoryWatchHandler, type MessageSource, type Metrics, type ModelVariant, type MultimodalContent, MultimodalResponse, OpenRouterMediaProvider, type OpenRouterMediaProviderOptions, PauseClock, PauseManager, type Payload, PayloadEncryptionError, type PromptTemplates, type ProviderHealth, RateLimitError, type RateLimiterOptions, type RawExecutionContext, type RawResult, RealtimeSession, type ReasonerCapability, ReasonerContext, type ReasonerDefinition, type ReasonerHandler, type ReasonerOptions, type RequestApprovalPayload, type ResolvedPromptTemplates, SUPPORTED_PROVIDERS, SUPPORTED_PROVIDER_NAMES, SUPPORTED_SESSION_TRANSPORTS, type ScheduleTriggerBinding, type ScheduleTriggerSpec, type ServerlessAdapter, type ServerlessEvent, type ServerlessResponse, type SessionDefinition, type SessionOptions, type SessionProvider, type SessionTransport, type SessionTransportCapability, SessionTransportError, type SessionTurn, type SimulateScheduleOptions, type SimulateTriggerOptions, type SimulatedContext, type SkillCapability, SkillContext, type SkillDefinition, type SkillHandler, type SkillOptions, StatelessRateLimiter, TERMINAL_STATUSES, TRACE_SOURCE_ASSISTANT, TRACE_SOURCE_TOOL_ERROR, TRACE_SOURCE_TOOL_LIMIT, TRACE_SOURCE_TOOL_RESULT, TRACE_SOURCE_TOOL_SYSTEM_PROMPT, TRACE_SOURCE_USER, Text, type ToolCallConfig, type ToolCallRecord, type ToolCallTrace, type ToolErrorFormatter, type ToolResultFormatter, type ToolsOption, type TracedMessage, type TriggerBinding, type TriggerContext, type TriggerEnvelope, type TurnDetection, USAGE_ENVELOPE_KEY, type UnwrapResult, type UsageEntryWire, type UsageSummaryWire, type VectorSearchOptions, type VectorSearchResult, type VersionProbe, Video, type VideoFrameImage, type VideoInputReference, type VideoRequest, type WaitForApprovalOptions, type WorkflowCredential, type WorkflowMetadata, type WorkflowProgressOptions, WorkflowReporter, type WrapperProbe, type ZodSchema, applyTriggerTransform, attachUsageToSyncResult, audioFromBase64, audioFromBuffer, audioFromFile, audioFromUrl, audioMediaType, buildProvider, buildSessionDefinition, buildToolConfig, capabilitiesToTools, capabilityToMetadataTool, capabilityToTool, createExecutionLogger, createHarnessResult, createMetrics, createMultimodalResponse, createRawResult, decrypt, decryptToString, defaultToolErrorFormatter, defaultToolResultFormatter, deriveProvider, encryptForDid, encryptToJwk, ensureCliAvailable, eventTrigger, executeToolCallLoop, extractKeyAgreementJwk, fileFromBase64, fileFromBuffer, fileFromPath, fileFromUrl, findExecutable, generateX25519KeyPair, getCurrentContext, getCurrentSkillContext, guessUrlMimeType, harnessDoctor, imageFromBase64, imageFromBuffer, imageFromFile, imageFromUrl, installApprovalWebhookRoute, isActive, isExecutionLogBatchPayload, isTerminal, isTriggerEnvelope, loadFixture, normalizeExecutionLogEntry, normalizeSessionTransportValue, normalizeStatus, normalizeTurnDetection, resolveModelAndVariant, resolvePromptTemplates, resolveProviderName, scheduleTrigger, serializeExecutionLogEntry, simulateSchedule, simulateTrigger, splitModelVariant, text, triggerToPayload, unwrapEnvelope, usageSummaryOrNull, validateSessionTransport, videoFromBase64, videoFromBuffer, videoFromFile, videoFromUrl };