@useago/sdk 1.3.1 → 1.4.0

package/dist/widget.d.cts

@@ -154,6 +154,37 @@ declare class AgoClient {
         path: string;
         description: string;
     }>): void;
+    /**
+     * Register a "page state" function that lets AGO change the current page's
+     * state (filters, sort, view mode, selection…) and reads the current state
+     * back as dynamic context. This is the state-mutation mirror of
+     * {@link registerNavigationFunction}.
+     *
+     * It does two things:
+     * - Synthesizes ONE client function (default name `setPageState`) whose
+     *   properties are the controls — all optional, so the agent sets only the
+     *   ones the user asked for.
+     * - Registers a dynamic context provider (keyed `page-state:<fnName>`) that
+     *   reports each control's current `get()` value on every message.
+     *
+     * ```ts
+     * client.registerPageStateFunction([
+     *   {
+     *     name: "statusFilter",
+     *     description: "Filter the list by review status",
+     *     schema: { type: "string", enum: ["all", "pending", "approved"] },
+     *     get: () => filters.status,
+     *     set: (v) => setFilters({ ...filters, status: v }),
+     *   },
+     * ]);
+     * ```
+     */
+    registerPageStateFunction(controls: AgoStateControl[], opts?: AgoPageStateOptions): void;
+    /**
+     * Unregister a page state function and its dynamic context provider.
+     * Mirror of unregistering `navigateToPage`.
+     */
+    unregisterPageStateFunction(functionName?: string): void;
     /**
      * Register or update a piece of client-side context.
      * This context is sent with every message so the AI understands the user's situation.
@@ -386,9 +417,23 @@ declare interface AgoMessage {
     followUpReplies?: string[];
     /** Uploaded files on this message (usually the user's). */
     attachments?: AgoAttachment[];
+    /**
+     * True when the backend flagged this message as hidden (e.g. an
+     * auto-continuation nudge). Kept in the model's context but not displayed;
+     * UI helpers like `useMessages`/`ChatWidget` filter these out.
+     */
+    hidden?: boolean;
     createdAt: Date;
 }
 
+/**
+ * Options for {@link AgoClient.registerPageStateFunction}.
+ */
+declare interface AgoPageStateOptions {
+    /** Name of the synthesized client function. Defaults to "setPageState". */
+    functionName?: string;
+}
+
 /**
  * Knowledge source citation
  */
@@ -398,6 +443,32 @@ declare interface AgoSource {
     url?: string;
 }
 
+/**
+ * A single editable control on the current page (a filter, a sort, a view mode,
+ * a selection…). It becomes one optional property of the synthesized
+ * `setPageState` function, and its current value is surfaced back to the agent
+ * as dynamic context. This is the state-mutation mirror of a navigation route.
+ */
+declare interface AgoStateControl<T = unknown> {
+    /** Machine name of the control, e.g. "statusFilter". Becomes a property of the tool. */
+    name: string;
+    /** Description for the LLM, e.g. "Filter the list by review status". */
+    description: string;
+    /** JSON schema for a SINGLE field (like one property of navigateToPage). */
+    schema: {
+        type: "string" | "number" | "boolean" | "array";
+        enum?: (string | number)[];
+        items?: {
+            type: string;
+            enum?: (string | number)[];
+        };
+    };
+    /** Current value → pushed as dynamic context so the agent knows what to change. */
+    get?: () => T;
+    /** Apply the state change on the page. May be async. */
+    set: (value: T) => void | Promise<void>;
+}
+
 export declare interface AgoWidgetColors {
     button?: string;
     header?: string;
@@ -507,7 +578,11 @@ declare interface ClientFunctionSchema {
         properties: Record<string, {
             type: string;
             description?: string;
-            enum?: string[];
+            enum?: (string | number)[];
+            items?: {
+                type: string;
+                enum?: (string | number)[];
+            };
             default?: unknown;
         }>;
         required?: string[];
@@ -876,11 +951,13 @@ export declare interface MountChatWidgetOptions {
         /** Max viewport width (px) treated as "mobile". Defaults to `768`. */
         breakpoint?: number;
         /**
-         * Inline placement only: how the card enters full screen. `"focus"` (default)
-         * expands when the input is tapped/focused; `"manual"` expands only via
-         * `widget.open()`. Ignored for side placements (driven by the launcher).
+         * Inline placement only: how the card enters full screen.
+         * - `"tap"` (default): expands when anywhere on the compact card is tapped
+         * - `"focus"`: expands only when the input is tapped/focused.
+         * - `"manual"`: expands only via `widget.open()`.
+         * Ignored for side placements (driven by the launcher).
          */
-        trigger?: "focus" | "manual";
+        trigger?: "tap" | "focus" | "manual";
     };
     /**
      * Load the visitor's conversation list into `widget.threads` on mount and refresh
@@ -990,6 +1067,13 @@ declare interface SendMessageOptions {
     agentId?: string;
     /** File attachments */
     files?: File[];
+    /**
+     * Mark this message as hidden. The backend keeps it in the model's context but
+     * flags it so the UI never displays it. Used by auto-continuation to nudge the
+     * agent after a navigation without polluting the visible transcript.
+     * Requires backend support for the `hidden` flag; older backends ignore it.
+     */
+    hidden?: boolean;
 }
 
 /**

package/dist/widget.d.ts

@@ -154,6 +154,37 @@ declare class AgoClient {
         path: string;
         description: string;
     }>): void;
+    /**
+     * Register a "page state" function that lets AGO change the current page's
+     * state (filters, sort, view mode, selection…) and reads the current state
+     * back as dynamic context. This is the state-mutation mirror of
+     * {@link registerNavigationFunction}.
+     *
+     * It does two things:
+     * - Synthesizes ONE client function (default name `setPageState`) whose
+     *   properties are the controls — all optional, so the agent sets only the
+     *   ones the user asked for.
+     * - Registers a dynamic context provider (keyed `page-state:<fnName>`) that
+     *   reports each control's current `get()` value on every message.
+     *
+     * ```ts
+     * client.registerPageStateFunction([
+     *   {
+     *     name: "statusFilter",
+     *     description: "Filter the list by review status",
+     *     schema: { type: "string", enum: ["all", "pending", "approved"] },
+     *     get: () => filters.status,
+     *     set: (v) => setFilters({ ...filters, status: v }),
+     *   },
+     * ]);
+     * ```
+     */
+    registerPageStateFunction(controls: AgoStateControl[], opts?: AgoPageStateOptions): void;
+    /**
+     * Unregister a page state function and its dynamic context provider.
+     * Mirror of unregistering `navigateToPage`.
+     */
+    unregisterPageStateFunction(functionName?: string): void;
     /**
      * Register or update a piece of client-side context.
      * This context is sent with every message so the AI understands the user's situation.
@@ -386,9 +417,23 @@ declare interface AgoMessage {
     followUpReplies?: string[];
     /** Uploaded files on this message (usually the user's). */
     attachments?: AgoAttachment[];
+    /**
+     * True when the backend flagged this message as hidden (e.g. an
+     * auto-continuation nudge). Kept in the model's context but not displayed;
+     * UI helpers like `useMessages`/`ChatWidget` filter these out.
+     */
+    hidden?: boolean;
     createdAt: Date;
 }
 
+/**
+ * Options for {@link AgoClient.registerPageStateFunction}.
+ */
+declare interface AgoPageStateOptions {
+    /** Name of the synthesized client function. Defaults to "setPageState". */
+    functionName?: string;
+}
+
 /**
  * Knowledge source citation
  */
@@ -398,6 +443,32 @@ declare interface AgoSource {
     url?: string;
 }
 
+/**
+ * A single editable control on the current page (a filter, a sort, a view mode,
+ * a selection…). It becomes one optional property of the synthesized
+ * `setPageState` function, and its current value is surfaced back to the agent
+ * as dynamic context. This is the state-mutation mirror of a navigation route.
+ */
+declare interface AgoStateControl<T = unknown> {
+    /** Machine name of the control, e.g. "statusFilter". Becomes a property of the tool. */
+    name: string;
+    /** Description for the LLM, e.g. "Filter the list by review status". */
+    description: string;
+    /** JSON schema for a SINGLE field (like one property of navigateToPage). */
+    schema: {
+        type: "string" | "number" | "boolean" | "array";
+        enum?: (string | number)[];
+        items?: {
+            type: string;
+            enum?: (string | number)[];
+        };
+    };
+    /** Current value → pushed as dynamic context so the agent knows what to change. */
+    get?: () => T;
+    /** Apply the state change on the page. May be async. */
+    set: (value: T) => void | Promise<void>;
+}
+
 export declare interface AgoWidgetColors {
     button?: string;
     header?: string;
@@ -507,7 +578,11 @@ declare interface ClientFunctionSchema {
         properties: Record<string, {
             type: string;
             description?: string;
-            enum?: string[];
+            enum?: (string | number)[];
+            items?: {
+                type: string;
+                enum?: (string | number)[];
+            };
             default?: unknown;
         }>;
         required?: string[];
@@ -876,11 +951,13 @@ export declare interface MountChatWidgetOptions {
         /** Max viewport width (px) treated as "mobile". Defaults to `768`. */
         breakpoint?: number;
         /**
-         * Inline placement only: how the card enters full screen. `"focus"` (default)
-         * expands when the input is tapped/focused; `"manual"` expands only via
-         * `widget.open()`. Ignored for side placements (driven by the launcher).
+         * Inline placement only: how the card enters full screen.
+         * - `"tap"` (default): expands when anywhere on the compact card is tapped
+         * - `"focus"`: expands only when the input is tapped/focused.
+         * - `"manual"`: expands only via `widget.open()`.
+         * Ignored for side placements (driven by the launcher).
          */
-        trigger?: "focus" | "manual";
+        trigger?: "tap" | "focus" | "manual";
     };
     /**
      * Load the visitor's conversation list into `widget.threads` on mount and refresh
@@ -990,6 +1067,13 @@ declare interface SendMessageOptions {
     agentId?: string;
     /** File attachments */
     files?: File[];
+    /**
+     * Mark this message as hidden. The backend keeps it in the model's context but
+     * flags it so the UI never displays it. Used by auto-continuation to nudge the
+     * agent after a navigation without polluting the visible transcript.
+     * Requires backend support for the `hidden` flag; older backends ignore it.
+     */
+    hidden?: boolean;
 }
 
 /**