import { type EveAgentStoreCallbacks, type EveAgentStoreSnapshot, type EveAgentStoreStatus, type PrepareSend } from "#client/eve-agent-store.js"; import type { EveAgentReducer } from "#client/reducer.js"; import type { ClientSession } from "#client/session.js"; import type { ConversationState } from "#client/conversation-state.js"; import type { MessageStreamEvent } from "#protocol/message.js"; import type { UserContent } from "ai"; import type { CancelSessionResult, ClientAuth, HeadersValue, RespondTurnOptions, SendTurnOptions, ClientSessionState } from "#client/types.js"; export type { PrepareSend }; /** * Lifecycle status of an eve agent session. * * - `"ready"`: idle, accepting a new turn. * - `"resuming"`: checking an attached session for events; submission is disabled. * - `"submitted"`: a turn was sent, no stream events received yet. * - `"streaming"`: stream events are arriving for the active turn. * - `"error"`: the last turn ended in a terminal failure (see `snapshot.error`). */ export type UseEveAgentStatus = EveAgentStoreStatus; /** * Snapshot of an eve agent session: `conversation` (canonical state), `data` * (the selected view), `events` (the authoritative server stream), `session` * (resumable cursor), `status`, and `error`. */ export type UseEveAgentSnapshot = EveAgentStoreSnapshot; /** * Snapshot plus commands returned by `useEveAgent`. */ export interface UseEveAgentHelpers extends UseEveAgentSnapshot { /** Requests durable cancellation of the active turn while continuing to receive its events. */ readonly cancel: () => Promise; /** Replays the attached durable session and follows its in-flight turn, if any. */ readonly resume: () => Promise; /** Creates the session without starting its first turn. */ readonly prewarm: () => Promise; /** Resets the session: detaches any local stream and clears events and projected data. */ readonly reset: () => void; /** Sends a message. While a turn is active, pass `turnPolicy: "steer"` to replace it. */ readonly send: (message: string | UserContent, options?: SendTurnOptions) => Promise; /** Answers pending HITL input requests. Rejects if a turn is already in flight. */ readonly respond: (inputResponses: Parameters[0], options?: RespondTurnOptions) => Promise; } /** * Configuration for creating or binding a React eve agent session. * * Session configuration is read when the hook creates its internal store; * remount the component to point at a different host, reducer, or session. * Lifecycle callbacks update on every render. * * For credentials or headers that must change without remounting, pass function * values to `auth` or `headers`; the client resolves those before each request. */ export interface UseEveAgentOptions extends EveAgentStoreCallbacks { /** * Named agent mounted by a framework integration such as `withEve({ agents })`. * * `agent: "support"` targets same-origin routes under * `/eve/support/v1/...`. Do not combine with `host`. */ readonly agent?: string; readonly auth?: ClientAuth; readonly headers?: HeadersValue; /** * Base URL for eve client requests. Do not combine with `agent`. * * Defaults to same-origin eve routes such as `/eve/v1/...`. Pass a same-origin * prefix such as `/api` for an app-owned proxy, or an absolute origin to talk * to an eve server directly. * * @default "" */ readonly host?: string; /** Ordered prefix of the session stream used to rehydrate projected state. */ readonly initialEvents?: readonly MessageStreamEvent[]; readonly initialSession?: ClientSessionState; /** * Project submitted user messages before eve confirms them with a * `message.received` stream event. * * Optimistic events are reducer-facing projection events only. They are not * exposed through `events`, which remains the authoritative eve stream. * * @default true */ readonly optimistic?: boolean; /** Follow each subagent call's session into `conversation.agents` while mounted. @default false */ readonly followSubagents?: boolean; /** * Prewarm an owned session when true. React observes this value across renders; * changing it from false to true prepares the current session, and reset checks * the latest rendered value before preparing the next session. * * Changing the value to false does not discard an existing session or abort * session creation already in flight. * * @default false */ readonly prewarm?: boolean; readonly reducer?: EveAgentReducer; /** * Replay the attached durable session after mount and follow its in-flight * turn, if any. Requires `initialSession` or `session`. * * @default false */ readonly resume?: boolean; readonly session?: ClientSession; } export declare function useEveAgent(options?: UseEveAgentOptions): UseEveAgentHelpers; export declare function useEveAgent(options: UseEveAgentOptions & { readonly reducer: EveAgentReducer; }): UseEveAgentHelpers;