@useago/sdk 1.4.1 → 1.4.3

package/dist/devtools.d.cts

@@ -39,12 +39,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
@@ -77,9 +110,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
      */
@@ -152,6 +201,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
      */
@@ -319,6 +374,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
@@ -406,6 +474,16 @@ 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;
 }
 
 declare type AgoEventHandler<K extends AgoEventName> = (data: AgoClientEvents[K]) => void;
@@ -536,6 +614,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.
  */
@@ -694,7 +775,24 @@ declare interface FormSchema {
 
 export declare function initDevPanel(options: DevPanelOptions): 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";
+
+/**
+ * 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
@@ -713,6 +811,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;
 }
 
 /**
@@ -754,6 +854,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[];
 }
 
 /**
@@ -778,6 +880,21 @@ 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
  */

package/dist/devtools.d.ts

@@ -39,12 +39,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
@@ -77,9 +110,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
      */
@@ -152,6 +201,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
      */
@@ -319,6 +374,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
@@ -406,6 +474,16 @@ 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;
 }
 
 declare type AgoEventHandler<K extends AgoEventName> = (data: AgoClientEvents[K]) => void;
@@ -536,6 +614,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.
  */
@@ -694,7 +775,24 @@ declare interface FormSchema {
 
 export declare function initDevPanel(options: DevPanelOptions): 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";
+
+/**
+ * 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
@@ -713,6 +811,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;
 }
 
 /**
@@ -754,6 +854,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[];
 }
 
 /**
@@ -778,6 +880,21 @@ 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
  */

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("./AgoClient-CRAnT4qE.cjs"),f=require("./createFormCollector-BB_l0Sia.cjs"),h=require("./createConversationSession-B8zfTL78.cjs"),p=require("./createMockClient-ucPENDzz.cjs");require("./testing.cjs");const g=require("./functions-Djnq-JAo.cjs");function w(e){return e}function S(e,o){return e.on("message:complete",o),()=>e.off("message:complete",o)}function E(e,o){return e.on("message:chunk",o),()=>e.off("message:chunk",o)}function y(e,o){return e.on("message:start",o),()=>e.off("message:start",o)}function F(e,o){return e.on("message:error",o),()=>e.off("message:error",o)}function b(e,o){return e.on("toolCall:received",o),()=>e.off("toolCall:received",o)}function v(e,o){return e.on("form:submitted",o),()=>e.off("form:submitted",o)}function M(e,o){return e.on("form:error",o),()=>e.off("form:error",o)}function q(e,o){return e.on("function:invoke",o),()=>e.off("function:invoke",o)}async function*k(e,o,l){const a=[];let n=null,i=!1;const m=s=>{a.push(s),n?.()},c=s=>m({type:"start",data:s}),t=s=>m({type:"chunk",data:s}),u=s=>{m({type:"complete",data:s}),i=!0,n?.()},d=s=>{m({type:"error",data:s}),i=!0,n?.()},C=s=>m({type:"toolCall",data:s});e.on("message:start",c),e.on("message:chunk",t),e.on("message:complete",u),e.on("message:error",d),e.on("toolCall:received",C),e.sendMessage(o,l).catch(()=>{i=!0,n?.()});try{for(;!i||a.length>0;)a.length>0?yield a.shift():(await new Promise(s=>{n=s}),n=null)}finally{e.off("message:start",c),e.off("message:chunk",t),e.off("message:complete",u),e.off("message:error",d),e.off("toolCall:received",C)}}function A(e){let o,l,a,n,i,m;if(typeof window<"u"&&window.AGO){const t=window.AGO;o=t.basepath,l=t.widgetId,a=t.agent||t.defaultAgent,n=t.permission,i=t.email,m=t.jwt}if(typeof document<"u"){const t=u=>document.querySelector(`meta[name="${u}"]`)?.getAttribute("content")||void 0;o=o||t("ago-base-url"),l=l||t("ago-widget-id"),a=a||t("ago-agent")||t("ago-agent-id"),n=n||t("ago-permission"),i=i||t("ago-user-email")}if(typeof document<"u"){const t=[document.body,...Array.from(document.querySelectorAll("script[data-ago-base-url]"))].filter(Boolean);for(const u of t)u&&(o=o||u.getAttribute("data-ago-base-url")||void 0,l=l||u.getAttribute("data-ago-widget-id")||void 0,a=a||u.getAttribute("data-ago-agent")||u.getAttribute("data-ago-agent-id")||void 0,n=n||u.getAttribute("data-ago-permission")||void 0,i=i||u.getAttribute("data-ago-user-email")||void 0)}o=e?.baseUrl||o,l=e?.widgetId||l,a=e?.agent||e?.defaultAgentId||a,n=e?.permission||n,i=e?.userEmail||i,m=e?.userJwt||m;const c=e?.debug;return o?{baseUrl:o,widgetId:l,agent:a,permission:n,userEmail:i,userJwt:m,debug:c}:null}function T(e){const o=A(e);if(!o)throw new r.AgoError('createAgo(): could not detect AGO configuration. Set window.AGO, add <meta name="ago-base-url">, or pass { baseUrl } explicitly.',"config_missing_base_url");return new r.AgoClient(o)}function I(e,o){return{...e,handler:o}}exports.AgoApiError=r.AgoApiError;exports.AgoClient=r.AgoClient;exports.AgoError=r.AgoError;exports.AgoFunctionError=r.AgoFunctionError;exports.AgoNetworkError=r.AgoNetworkError;exports.AgoStreamError=r.AgoStreamError;exports.ClientContextRegistry=r.ClientContextRegistry;exports.EventEmitter=r.EventEmitter;exports.FunctionRegistry=r.FunctionRegistry;exports.SSEHandler=r.SSEHandler;exports.autoDetectConfig=A;exports.canInlineImage=r.canInlineImage;exports.copyToClipboard=g.copyToClipboard;exports.createAgo=T;exports.createConversationSession=h.createConversationSession;exports.createFormCollector=f.createFormCollector;exports.createMessageStream=k;exports.createMockClient=p.createMockClient;exports.createStore=f.createStore;exports.defineFunction=w;exports.deriveFormStatus=f.deriveFormStatus;exports.formatFileSize=r.formatFileSize;exports.getLocalStorage=g.getLocalStorage;exports.getUserLocation=g.getUserLocation;exports.highlightElement=g.highlightElement;exports.isStreamNetworkError=r.isStreamNetworkError;exports.loadFormCollector=f.loadFormCollector;exports.logger=r.logger;exports.onFormError=M;exports.onFormSubmitted=v;exports.onFunctionInvoke=q;exports.onMessage=S;exports.onMessageChunk=E;exports.onMessageError=F;exports.onMessageStart=y;exports.onToolCall=b;exports.openUrl=g.openUrl;exports.safeAttachmentUrl=r.safeAttachmentUrl;exports.scrollToElement=g.scrollToElement;exports.setLocalStorage=g.setLocalStorage;exports.setTheme=g.setTheme;exports.showConfirmDialog=g.showConfirmDialog;exports.showNotification=g.showNotification;exports.showToast=g.showToast;exports.submitForm=g.submitForm;exports.trackEvent=g.trackEvent;exports.validateConfig=r.validateConfig;exports.withHandler=I;
+Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("./AgoClient-CMDVqNaH.cjs"),f=require("./createFormCollector-Bz_0IJ0Q.cjs"),h=require("./createConversationSession-CmBq7uGi.cjs"),p=require("./createMockClient-BSr-UV8R.cjs");require("./testing.cjs");const g=require("./functions-Djnq-JAo.cjs");function w(e){return e}function S(e,o){return e.on("message:complete",o),()=>e.off("message:complete",o)}function E(e,o){return e.on("message:chunk",o),()=>e.off("message:chunk",o)}function y(e,o){return e.on("message:start",o),()=>e.off("message:start",o)}function F(e,o){return e.on("message:error",o),()=>e.off("message:error",o)}function b(e,o){return e.on("toolCall:received",o),()=>e.off("toolCall:received",o)}function v(e,o){return e.on("form:submitted",o),()=>e.off("form:submitted",o)}function M(e,o){return e.on("form:error",o),()=>e.off("form:error",o)}function q(e,o){return e.on("function:invoke",o),()=>e.off("function:invoke",o)}async function*k(e,o,l){const a=[];let n=null,i=!1;const m=s=>{a.push(s),n?.()},c=s=>m({type:"start",data:s}),t=s=>m({type:"chunk",data:s}),u=s=>{m({type:"complete",data:s}),i=!0,n?.()},d=s=>{m({type:"error",data:s}),i=!0,n?.()},C=s=>m({type:"toolCall",data:s});e.on("message:start",c),e.on("message:chunk",t),e.on("message:complete",u),e.on("message:error",d),e.on("toolCall:received",C),e.sendMessage(o,l).catch(()=>{i=!0,n?.()});try{for(;!i||a.length>0;)a.length>0?yield a.shift():(await new Promise(s=>{n=s}),n=null)}finally{e.off("message:start",c),e.off("message:chunk",t),e.off("message:complete",u),e.off("message:error",d),e.off("toolCall:received",C)}}function A(e){let o,l,a,n,i,m;if(typeof window<"u"&&window.AGO){const t=window.AGO;o=t.basepath,l=t.widgetId,a=t.agent||t.defaultAgent,n=t.permission,i=t.email,m=t.jwt}if(typeof document<"u"){const t=u=>document.querySelector(`meta[name="${u}"]`)?.getAttribute("content")||void 0;o=o||t("ago-base-url"),l=l||t("ago-widget-id"),a=a||t("ago-agent")||t("ago-agent-id"),n=n||t("ago-permission"),i=i||t("ago-user-email")}if(typeof document<"u"){const t=[document.body,...Array.from(document.querySelectorAll("script[data-ago-base-url]"))].filter(Boolean);for(const u of t)u&&(o=o||u.getAttribute("data-ago-base-url")||void 0,l=l||u.getAttribute("data-ago-widget-id")||void 0,a=a||u.getAttribute("data-ago-agent")||u.getAttribute("data-ago-agent-id")||void 0,n=n||u.getAttribute("data-ago-permission")||void 0,i=i||u.getAttribute("data-ago-user-email")||void 0)}o=e?.baseUrl||o,l=e?.widgetId||l,a=e?.agent||e?.defaultAgentId||a,n=e?.permission||n,i=e?.userEmail||i,m=e?.userJwt||m;const c=e?.debug;return o?{baseUrl:o,widgetId:l,agent:a,permission:n,userEmail:i,userJwt:m,debug:c}:null}function T(e){const o=A(e);if(!o)throw new r.AgoError('createAgo(): could not detect AGO configuration. Set window.AGO, add <meta name="ago-base-url">, or pass { baseUrl } explicitly.',"config_missing_base_url");return new r.AgoClient(o)}function I(e,o){return{...e,handler:o}}exports.AgoApiError=r.AgoApiError;exports.AgoClient=r.AgoClient;exports.AgoError=r.AgoError;exports.AgoFunctionError=r.AgoFunctionError;exports.AgoNetworkError=r.AgoNetworkError;exports.AgoStreamError=r.AgoStreamError;exports.ClientContextRegistry=r.ClientContextRegistry;exports.EventEmitter=r.EventEmitter;exports.FunctionRegistry=r.FunctionRegistry;exports.SSEHandler=r.SSEHandler;exports.autoDetectConfig=A;exports.canInlineImage=r.canInlineImage;exports.copyToClipboard=g.copyToClipboard;exports.createAgo=T;exports.createConversationSession=h.createConversationSession;exports.createFormCollector=f.createFormCollector;exports.createMessageStream=k;exports.createMockClient=p.createMockClient;exports.createStore=f.createStore;exports.defineFunction=w;exports.deriveFormStatus=f.deriveFormStatus;exports.formatFileSize=r.formatFileSize;exports.getLocalStorage=g.getLocalStorage;exports.getUserLocation=g.getUserLocation;exports.highlightElement=g.highlightElement;exports.isStreamNetworkError=r.isStreamNetworkError;exports.loadFormCollector=f.loadFormCollector;exports.logger=r.logger;exports.onFormError=M;exports.onFormSubmitted=v;exports.onFunctionInvoke=q;exports.onMessage=S;exports.onMessageChunk=E;exports.onMessageError=F;exports.onMessageStart=y;exports.onToolCall=b;exports.openUrl=g.openUrl;exports.safeAttachmentUrl=r.safeAttachmentUrl;exports.scrollToElement=g.scrollToElement;exports.setLocalStorage=g.setLocalStorage;exports.setTheme=g.setTheme;exports.showConfirmDialog=g.showConfirmDialog;exports.showNotification=g.showNotification;exports.showToast=g.showToast;exports.submitForm=g.submitForm;exports.trackEvent=g.trackEvent;exports.validateConfig=r.validateConfig;exports.withHandler=I;

package/dist/index.d.cts

@@ -50,12 +50,45 @@ export 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
@@ -88,9 +121,25 @@ export 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.
      */
-    submitToolCallForm(toolCallId: string, formData: Record<string, unknown>): Promise<void>;
+    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<SubmitToolCallResult>;
     /**
      * Confirm a tool call
      */
@@ -163,6 +212,12 @@ export 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
      */
@@ -330,6 +385,19 @@ export 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
@@ -417,6 +485,16 @@ 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;
 }
 
 /**
@@ -694,6 +772,9 @@ export declare interface ClientFunctionSchema {
     };
 }
 
+/** See {@link AgoConfig.clientFunctionsMode}. */
+export declare type ClientFunctionsMode = "placeholder" | "pause";
+
 /**
  * A single piece of context the client wants the LLM to know about.
  */
@@ -1276,7 +1357,13 @@ declare class Logger {
 
 export declare const logger: Logger;
 
-export declare type MessageStatus = "IN_PROGRESS" | "DONE" | "ERROR" | "TODO" | "CANCELED";
+export 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";
 
 export declare interface MockAgoClient extends AgoClient {
     /**
@@ -1386,6 +1473,17 @@ export declare interface RegisteredFunction {
     handler: ClientFunctionHandler;
 }
 
+/**
+ * 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.
+ */
+export declare type ResumeGate = (info: {
+    conversationId: string;
+    messageId: string;
+}) => Promise<void> | void;
+
 /**
  * Allow only URL schemes that are safe to put in an `<img src>` / `<a href>`.
  * Presigned attachment URLs are `https:` and optimistic previews are `blob:`;
@@ -1417,6 +1515,8 @@ export 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;
 }
 
 /**
@@ -1491,6 +1591,8 @@ export 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[];
 }
 
 /**
@@ -1505,6 +1607,7 @@ export declare class SSEHandler {
     private followUpReplies;
     private isFirstChunk;
     private answerCompleteEmitted;
+    private waitingClientEmitted;
     private firedClientFunctions;
     constructor(callbacks: SSEHandlerCallbacks);
     /**
@@ -1547,6 +1650,17 @@ declare interface SSEHandlerCallbacks {
      * with the message as it stands at that moment (no `followUpReplies` yet).
      */
     onAnswerComplete?: (message: AgoMessage) => void;
+    /**
+     * The turn paused on client function call(s) (pause mode): the backend closed
+     * the stream with `status: "WAITING_CLIENT"` and the tool call ids awaiting a
+     * result. {@link onComplete} does NOT fire for this stream — the turn is not
+     * over; it resumes in a separate request once every result is submitted.
+     */
+    onWaitingClient?: (data: {
+        conversationId: string;
+        messageId: string;
+        waitingToolCallIds: string[];
+    }) => void;
     onComplete?: (message: AgoMessage) => void;
     onError?: (error: Error) => void;
 }
@@ -1602,6 +1716,21 @@ export declare type SubmitConfig<V = Record<string, unknown>> = string | {
  */
 export declare const submitForm: ClientFunctionDefinition;
 
+/**
+ * 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)`.
+ */
+export declare interface SubmitToolCallResult {
+    status: string;
+    result?: unknown;
+    resume?: {
+        message_id: string;
+        ready: boolean;
+    };
+}
+
 /**
  * Tool call data from SSE stream
  */