eve/dist/src/harness/step-hooks.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

import type { GenerateTextOnStepStartCallback, PrepareStepFunction, ProviderMetadata, StepResult, ToolSet } from "ai";
import type { HarnessEmissionState } from "#harness/emission.js";
import { type AnthropicCacheMarker, type PromptCachePath } from "#harness/prompt-cache.js";
import { type HarnessEmitFn, type HarnessSession, type ToolLoopHarnessConfig } from "#harness/types.js";
/**
 * The subset of `StepResult` that the harness reads after a step completes.
 *
 * Used by both the streaming (`onStepEnd` callback) and non-streaming
 * (`generateText` result) code paths.
 */
export type HarnessStepResult = Pick<StepResult<ToolSet>, "content" | "finishReason" | "providerMetadata" | "response" | "text" | "toolCalls" | "toolResults" | "usage"> & {
    readonly invalidInputToolCallIds?: ReadonlySet<string>;
};
/**
 * Input for {@link buildStepHooks}.
 */
interface StepHooksInput {
    readonly auth?: import("#channel/types.js").SessionAuthContext | null;
    readonly cachePath: PromptCachePath;
    readonly emit?: HarnessEmitFn;
    readonly emissionState: HarnessEmissionState;
    /**
     * When `false`, `onStepStart` skips the `step.started` emission.
     * Used by the harness recovery path to avoid emitting `step.started`
     * twice when retrying the same step with a degraded toolset.
     *
     * Defaults to `true`.
     */
    readonly emitStepStarted?: boolean;
    readonly marker: AnthropicCacheMarker | undefined;
    readonly session: HarnessSession;
}
/**
 * Composable hooks returned by {@link buildStepHooks}.
 */
interface StepHooks {
    /**
     * `ToolLoopAgent` `onStepStart` callback.
     *
     * Emits the `step.started` event from the prepared step input.
     */
    readonly onStepStart: GenerateTextOnStepStartCallback<ToolSet>;
    /**
     * `ToolLoopAgent` `onStepEnd` callback.
     *
     * Emits `actions.requested`, `action.result`, and `step.completed` events
     * from the captured step result.
     */
    readonly onStepEnd: (step: StepResult<ToolSet>) => Promise<void>;
    /**
     * `ToolLoopAgent` `prepareStep` callback.
     *
     * Handles cache/provider metadata. Compaction happens in the tool-loop
     * before `agent.stream()`.
     */
    readonly prepareStep: PrepareStepFunction<ToolSet>;
    /**
     * Promise that resolves when `onStepEnd` has completed.
     *
     * Await this after consuming the stream to ensure all step events
     * have been emitted before proceeding to post-step handling.
     *
     * Resolves once per hooks instance: a retried model call must rebuild
     * hooks via a fresh `runOneModelCall` attempt. Re-running a call against
     * hooks whose `stepResult` already resolved reads the previous attempt's
     * result, not the retry's.
     *
     * Never settles when the step does not finish — e.g. the AI SDK's
     * incomplete-stream rejection (`NoOutputGeneratedError`) skips
     * `onStepEnd` entirely. Consumers must surface stream errors as
     * throws before awaiting this promise (`emitStreamContent` does), or
     * the await hangs.
     */
    readonly stepResult: Promise<HarnessStepResult>;
}
/**
 * Builds composable `onStepStart`, `prepareStep`, and `onStepEnd` closures that
 * own all step-internal work: emission, compaction, and prompt caching.
 *
 * The harness passes these hooks to `ToolLoopAgent` and reads the
 * results via `stepResult` after the agent finishes.
 */
export declare function buildStepHooks(input: StepHooksInput): StepHooks;
/**
 * Emits `actions.requested`, `action.result`, and `step.completed` events
 * from a captured step result.
 *
 * Tool calls and results that match `excludedActionToolNames`, belong to
 * tool-approval requests, or are marked `invalid` by the AI SDK (e.g. the
 * model emitted unparsable JSON) are filtered out of the emitted events.
 * The AI SDK feeds the invalid-call error back to the model on the next
 * step via `step.response.messages` so it can retry with well-formed
 * arguments — the runtime event stream only sees successfully parsed
 * tool calls.
 *
 * `handledInlineToolResultCallIds` contains results emitted by
 * `emitStreamContent` or sent to authorization. Skip them here.
 */
export declare function emitStepActions(emitFn: HarnessEmitFn, state: HarnessEmissionState, step: HarnessStepResult, options: {
    readonly emittedActionCallIds?: ReadonlySet<string>;
    readonly excludedActionCallIds?: ReadonlySet<string>;
    readonly excludedActionToolNames: ReadonlySet<string>;
    readonly handledInlineToolResultCallIds?: ReadonlySet<string>;
    readonly tools: ToolLoopHarnessConfig["tools"];
}): Promise<void>;
export declare function readGatewayGenerationId(providerMetadata: ProviderMetadata | undefined): string | undefined;
export {};