@useago/sdk 1.4.2 → 1.4.4

package/dist/react.d.ts

@@ -58,12 +58,45 @@ declare class AgoClient {
     private config;
     /** Conversations already warned about an empty reply (one warning each). */
     private warnedEmptyConversations;
+    /** Paused turns awaiting auto-resume, keyed by assistant message id. */
+    private pendingResumes;
+    /** App-provided gate deciding WHEN a paused turn resumes (see {@link registerResumeGate}). */
+    private resumeGate;
     constructor(config: AgoConfig);
     /**
      * Send a message and receive a streaming response
      */
     sendMessage(content: string, options?: SendMessageOptions): Promise<AgoMessage>;
     private processSSEResponse;
+    private resolveClientFunctionsMode;
+    /**
+     * Register a gate deciding WHEN a paused turn resumes. The SDK still decides
+     * *whether* (it resumes once every waiting result is submitted); the gate only
+     * delays the continue call — e.g. `useAgoAutoContinueAfterNavigation` waits for
+     * the destination page to register its page state. One gate at a time (last
+     * registration wins). Returns an unregister function.
+     */
+    registerResumeGate(gate: ResumeGate): () => void;
+    /**
+     * Resume a turn paused on client function results (`WAITING_CLIENT`).
+     *
+     * Sends the CURRENT page's registered functions and context — the page may
+     * have changed since the pause (that's the point of pausing on a navigation) —
+     * and streams the continuation through the same event pipeline as
+     * `sendMessage`, so `message:chunk` / `message:complete` (or another
+     * `message:waiting-client` for chained pauses) fire as usual.
+     *
+     * The SDK calls this automatically after submitting the waiting results; call
+     * it manually only for custom flows (e.g. after restoring a reloaded page via
+     * {@link resumePendingClientFunctions}).
+     */
+    continueMessage(messageId: string): Promise<AgoMessage>;
+    /**
+     * Record one of the two auto-resume preconditions for a paused turn and fire
+     * the resume when both are in (see {@link PendingResume}).
+     */
+    private markResumeSignal;
+    private runAutoResume;
     /**
      * Detect a reply that completed as DONE with no content and no activity —
      * today's backend answers an unknown `agent` slug with an empty 200, which
@@ -96,9 +129,25 @@ declare class AgoClient {
      */
     getMessages(conversationId: string): Promise<AgoMessage[]>;
     /**
-     * Submit form data for a tool call
+     * Resume a turn left paused on client function results by a page reload.
+     *
+     * A paused turn (pause mode) survives a full reload: the backend keeps the
+     * assistant message in `WAITING_CLIENT` with its waiting tool calls. After
+     * restoring the conversation (`getConversation`) and re-registering the page's
+     * functions, call this: it re-executes each waiting client function through the
+     * registry, submits the results, and continues the turn.
+     *
+     * Opt-in on purpose — re-running functions on reload can be surprising (e.g. a
+     * navigation function would navigate again), so the app decides. Returns the
+     * resumed turn's final message, or `null` when there was nothing to resume or
+     * some waiting function is not registered on this page.
+     */
+    resumePendingClientFunctions(conversation: Conversation): Promise<AgoMessage | null>;
+    /**
+     * Submit form data for a tool call. The response's `resume` field (pause mode
+     * only) tells whether the paused turn is ready to be resumed.
      */
-    submitToolCallForm(toolCallId: string, formData: Record<string, unknown>): Promise<void>;
+    submitToolCallForm(toolCallId: string, formData: Record<string, unknown>): Promise<SubmitToolCallResult>;
     /**
      * Confirm a tool call
      */
@@ -145,7 +194,7 @@ declare class AgoClient {
      * ```
      */
     registerFunction(definition: ClientFunctionDefinition): void;
-    registerFunction(name: string, handler: ClientFunctionHandler, schema: Omit<ClientFunctionSchema, "name">): void;
+    registerFunction(name: string, handler: ClientFunctionHandler, schema: ClientFunctionRegisterOptions): void;
     /**
      * Short alias for `registerFunction`. Also accepts an array of definitions.
      *
@@ -171,6 +220,12 @@ declare class AgoClient {
      * the agent know *where* it is after it navigates (e.g. so auto-continuation
      * can apply page state on the destination), not just how to navigate away.
      *
+     * Routes may contain `:param` placeholders (`/users/:id`). Each distinct
+     * placeholder becomes a top-level string argument of `navigateToPage`
+     * (`{ page: "userDetail", id: "42" }`), so one route covers every detail
+     * page of an entity. Flat arguments only: nested object parameters are not
+     * reliably rendered to the model, so placeholders must not be named `page`.
+     *
      * @param navigate - A callback that performs the navigation (e.g. react-router's navigate)
      * @param routes - Map of route names to paths, with descriptions for the LLM
      */
@@ -338,6 +393,19 @@ declare interface AgoClientEvents {
      */
     "message:answer-complete": AgoMessage;
     "message:complete": AgoMessage;
+    /**
+     * The turn paused on client function call(s) (pause mode): the stream closed
+     * with status `WAITING_CLIENT` instead of `DONE`. `message:complete` does NOT
+     * fire for this stream — it fires when the resumed turn concludes, so one
+     * logical turn still emits exactly one `message:complete`. The SDK submits the
+     * function results and resumes automatically; listen to this to know the agent
+     * is waiting on the page (e.g. to keep a "working…" indicator up).
+     */
+    "message:waiting-client": {
+        conversationId: string;
+        messageId: string;
+        waitingToolCallIds: string[];
+    };
     /**
      * A reply finished as `DONE` with empty content and no tool calls, client
      * functions, or follow-up replies — usually an unknown `agent` slug (the
@@ -425,6 +493,24 @@ export declare interface AgoConfig {
      * event fires regardless of this setting.
      */
     warnOnEmptyReply?: boolean;
+    /**
+     * How the agent loop treats client function calls (requires backend support):
+     * - `"placeholder"` (default): the turn continues immediately on a placeholder
+     *   result; the real result is only visible to the agent on later turns.
+     * - `"pause"`: the turn stops on client function call(s) with status
+     *   `WAITING_CLIENT`; once every result is submitted, the SDK resumes the SAME
+     *   turn via `POST /messages/{id}/continue`, so the agent sees the real results.
+     * Older backends ignore the flag, so `"pause"` degrades to legacy behavior.
+     */
+    clientFunctionsMode?: ClientFunctionsMode;
+    /**
+     * Max serialized size (bytes) of a client function result before the SDK
+     * replaces it with a flagged, truncated preview. Everything a handler
+     * returns is sent into the LLM context, so this caps runaway payloads
+     * (raw API responses, full tables). Default `50000`. Override per function
+     * with `maxResultBytes` on its definition; `Infinity` disables the guard.
+     */
+    maxFunctionResultBytes?: number;
 }
 
 /**
@@ -636,6 +722,12 @@ declare interface ClientFunctionDefinition {
     description: string;
     parameters: ClientFunctionSchema["parameters"];
     handler: ClientFunctionHandler;
+    /**
+     * Max serialized result size in bytes before the SDK truncates it to a
+     * flagged preview (default: `AgoConfig.maxFunctionResultBytes`, 50 000).
+     * `Infinity` disables the guard for this function.
+     */
+    maxResultBytes?: number;
 }
 
 /**
@@ -650,6 +742,20 @@ declare interface ClientFunctionInvocation {
     conversationId: string;
 }
 
+/**
+ * Schema-plus-settings object accepted when registering a function: the schema
+ * (minus `name`) and SDK-side options that are NOT sent to the backend.
+ */
+declare type ClientFunctionRegisterOptions = Omit<ClientFunctionSchema, "name"> & {
+    /**
+     * Max serialized result size in bytes before the SDK truncates it to a
+     * flagged preview. Overrides the client-level default
+     * (`AgoConfig.maxFunctionResultBytes`, 50 000 by default). `Infinity`
+     * disables the guard for this function.
+     */
+    maxResultBytes?: number;
+};
+
 /**
  * Schema for a client-side function that AGO can call
  */
@@ -675,6 +781,9 @@ declare interface ClientFunctionSchema {
     };
 }
 
+/** See {@link AgoConfig.clientFunctionsMode}. */
+declare type ClientFunctionsMode = "placeholder" | "pause";
+
 /**
  * A single piece of context the client wants the LLM to know about.
  */
@@ -995,7 +1104,13 @@ export declare interface MessageProps {
     onFollowUpClick?: (reply: string) => void;
 }
 
-declare type MessageStatus = "IN_PROGRESS" | "DONE" | "ERROR" | "TODO" | "CANCELED";
+declare type MessageStatus = "IN_PROGRESS" | "DONE" | "ERROR" | "TODO" | "CANCELED"
+/**
+* The turn paused on client function call(s) (pause mode): the agent waits for
+* every waiting call to be submitted, then the turn resumes via
+* `continueMessage`. Not a final state.
+*/
+| "WAITING_CLIENT";
 
 declare interface MockAgoClient extends AgoClient {
     /**
@@ -1027,6 +1142,17 @@ declare interface MockAgoClientOptions {
 
 declare type MockFn = (...args: any[]) => any;
 
+/**
+ * Hook run before a paused turn is resumed, so the app controls WHEN the
+ * continuation fires (e.g. wait for the destination page to mount after a
+ * navigation). It must resolve — throwing or hanging blocks the resume; on
+ * timeout-style situations resolve anyway and let the agent conclude.
+ */
+declare type ResumeGate = (info: {
+    conversationId: string;
+    messageId: string;
+}) => Promise<void> | void;
+
 /**
  * Options for sending a message
  */
@@ -1044,6 +1170,8 @@ declare interface SendMessageOptions {
      * Requires backend support for the `hidden` flag; older backends ignore it.
      */
     hidden?: boolean;
+    /** Per-message override of {@link AgoConfig.clientFunctionsMode}. */
+    clientFunctionsMode?: ClientFunctionsMode;
 }
 
 /**
@@ -1085,6 +1213,8 @@ declare interface SSEChunkData {
     follow_up_replies?: string[];
     satisfaction_feedback?: unknown;
     ask_to_talk_to_human?: boolean;
+    /** Tool call ids still awaiting a client result, sent with the final `WAITING_CLIENT` event. */
+    waiting_tool_call_ids?: string[];
 }
 
 /**
@@ -1130,6 +1260,21 @@ export declare type SubmitConfig<V = Record<string, unknown>> = string | {
     destination?: string;
 } | false;
 
+/**
+ * Response of `POST /tool-calls/{id}/submit`. `resume` is only present when the
+ * tool call belongs to a turn paused on client functions (pause mode): `ready`
+ * flips to `true` once ALL waiting calls of that message are submitted, meaning
+ * the turn can be resumed via `continueMessage(resume.message_id)`.
+ */
+declare interface SubmitToolCallResult {
+    status: string;
+    result?: unknown;
+    resume?: {
+        message_id: string;
+        ready: boolean;
+    };
+}
+
 /**
  * Tool call data from SSE stream
  */
@@ -1166,12 +1311,20 @@ export declare function useAgo(config: UseAgoOptions | null): {
  * Auto-continue the agent after it navigates, so a "go to page B and change X"
  * request completes in one user gesture. Mount this once inside `AgoProvider`.
  *
- * How it works: when the agent calls the navigation function and that turn ends,
- * this waits for the destination page's `useAgoPageState` to register (so the
- * SDK will ship its `setPageState` + current state on the next send), then sends
- * a hidden continuation message. The agent then applies the state in a second
- * turn. The continuation is `hidden`, so it never shows in the transcript
- * (requires backend support for the `hidden` flag).
+ * Two mechanisms, picked by the turn's client-functions mode:
+ *
+ * - **Pause mode** (`clientFunctionsMode: "pause"`): the backend pauses the turn
+ *   on the navigation call (`message:waiting-client`) and the SDK resumes it once
+ *   the result is submitted. This hook only registers a *resume gate* that delays
+ *   the resume until the destination page's `useAgoPageState` registered (plus a
+ *   settle delay), so the continued turn ships the new page's `setPageState` and
+ *   current state. Same turn, no extra prompt, backend budget as the guardrail —
+ *   `continuationPrompt` and `maxDepth` are unused here.
+ *
+ * - **Placeholder mode** (legacy default): when the agent calls the navigation
+ *   function and that turn ends, this waits for the destination page's state to
+ *   register, then sends a hidden continuation message; the agent applies the
+ *   state in a second turn (requires backend support for the `hidden` flag).
  *
  * ```tsx
  * function AppShell() {
@@ -1274,6 +1427,12 @@ export declare interface UseAgoFunctionOptions {
         required?: string[];
     };
     handler: ClientFunctionHandler;
+    /**
+     * Max serialized result size in bytes before the SDK truncates it to a
+     * flagged preview (default: `AgoConfig.maxFunctionResultBytes`, 50 000).
+     * `Infinity` disables the guard for this function.
+     */
+    maxResultBytes?: number;
 }
 
 /**