@useago/sdk 1.12.0 → 1.13.1

package/dist/widget.d.ts

@@ -58,6 +58,8 @@ declare class AgoClient {
     private config;
     /** Conversations already warned about an empty reply (one warning each). */
     private warnedEmptyConversations;
+    /** Client functions the backend has accepted from a WebMCP call report. */
+    private declaredExternally;
     /** Whether the placeholder-mode page-data warning has already been logged. */
     private warnedPageDataPlaceholder;
     /** `readPageData` companions this SDK registered, so cleanup only removes its own. */
@@ -92,7 +94,12 @@ declare class AgoClient {
      * `null` otherwise.
      */
     proactive: ProactiveController | null;
+    /** Removes the mirrored WebMCP tools; `null` when the bridge is off. */
+    private detachWebMCP;
+    /** The `listPages` companion is live. */
+    private listPagesRegistered;
     constructor(config: AgoConfig);
+    private attachWebMCPBridge;
     /**
      * Send a message and receive a streaming response
      */
@@ -204,6 +211,12 @@ declare class AgoClient {
      * (the agent decides what to do next). No-op if the invocation is unknown.
      */
     rejectFunction(invocationId: string): Promise<void>;
+    /* Excluded from this release type: runExternalFunction */
+    /**
+     * Best-effort analytics for one WebMCP call. No agent: the caller is someone
+     * else's agent and cannot be known from `execute`.
+     */
+    private reportExternalCall;
     /**
      * Get a page of conversations, newest-first. `pageSize` is capped at 100 by
      * the backend (default 50). Returns the `{ data, has_more, total }` envelope
@@ -223,11 +236,20 @@ declare class AgoClient {
      * `SSEHandler.parseToolCall` so persisted and streamed tool calls match.
      */
     private static mapPersistedToolCalls;
+    /**
+     * Transcribe an audio file into editable text (`POST /api/sdk/v1/audio/transcriptions`).
+     * Requires speech to text to be enabled for the tenant. Supports FLAC, MP3,
+     * MP4, MPEG, MPGA, M4A, OGG, WAV and WebM files up to 25 MB.
+     * The filename must include the matching extension. For a MediaRecorder blob,
+     * wrap it in a File with the recording's extension and MIME type.
+     * Show the returned text as a draft; call `sendMessage` when the user sends it.
+     */
+    transcribeAudio(file: File, options?: TranscribeAudioOptions): Promise<AudioTranscription>;
     /**
      * The tenant's SDK configuration (`GET /api/sdk/v1/config`): per-permission
      * agents, the ticket form the agent's `ago_ticketing` tool opens, and the
-     * file-attachment flag. The vanilla widget fetches it once, when a ticket
-     * form first appears in a conversation.
+     * file-attachment and speech-to-text flags. The vanilla widget fetches it
+     * once, when a ticket form first appears in a conversation.
      */
     getConfig(): Promise<SdkConfig>;
     /**
@@ -364,6 +386,9 @@ declare class AgoClient {
      * Get all registered function schemas
      */
     getRegisteredFunctions(): ClientFunctionSchema[];
+    /** The callback form of `functions:changed`. Returns an unsubscribe. */
+    onFunctionsChanged(listener: () => void): () => void;
+    /* Excluded from this release type: getFunctionRegistrations */
     /**
      * Execute a registered client function locally, through the same
      * FunctionRegistry path (result-size guard, error wrapping) as agent-invoked
@@ -386,14 +411,15 @@ declare class AgoClient {
      * page of an entity. Flat arguments only: nested object parameters are not
      * reliably rendered to the model, so placeholders must not be named `page`.
      *
+     * For a large table, `{ catalogue: "onDemand" }` moves the route descriptions
+     * into a read-only `listPages` companion, leaving only the page names in the
+     * per-message schema. Routes may carry a `section` to group that companion.
+     *
      * @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
+     * @param opts - Where the catalogue lives; `"inline"` by default
      */
-    registerNavigationFunction(navigate: (path: string) => void, routes: Array<{
-        name: string;
-        path: string;
-        description: string;
-    }>): void;
+    registerNavigationFunction(navigate: (path: string) => void, routes: NavRoute[], opts?: AgoNavigationOptions): void;
     /**
      * Unregister the navigation function and its `current-page` context provider.
      */
@@ -696,6 +722,8 @@ declare interface AgoClientEvents {
      * call running immediately.
      */
     "function:awaiting-approval": ClientFunctionInvocation;
+    /** A function was registered or unregistered, or the registry cleared. */
+    "functions:changed": ClientFunctionSchema[];
     "function:result": {
         invocationId: string;
         result: unknown;
@@ -768,6 +796,8 @@ declare interface AgoConfig {
     defaultAgentId?: string;
     /** Permission name to apply to all requests (sent as `X-Widget-Permission`). Mirrors the widget's `window.AGO.permission`. */
     permission?: string;
+    /** Interface locale selected by the host app, sent as Accept-Language. Null clears the override. */
+    language?: string | null;
     /** User email for identification */
     userEmail?: string;
     /** JWT token for authenticated users */
@@ -845,6 +875,15 @@ declare interface AgoConfig {
      * mode's `jsErrors` signal. See `client.reportError()` for caught errors.
      */
     errorWatcher?: boolean | ErrorWatcherOptions;
+    /** Mirror every registered client function into the browser's WebMCP registry
+     * (`document.modelContext`), so an external agent can call the same functions
+     * the in-app agent calls. Off by default; no-ops without WebMCP.
+     *
+     * A mirrored function runs immediately: the approval gate
+     * ({@link approvalPolicy}, `requiresApproval`) covers the agent loop only.
+     * Use `webmcp: false` on a definition to keep it out.
+     */
+    webmcp?: boolean;
 }
 
 declare type AgoEventHandler<K extends AgoEventName> = (data: AgoClientEvents[K]) => void;
@@ -875,6 +914,16 @@ declare interface AgoMessage {
     createdAt: Date;
 }
 
+/**
+ * Where the route catalogue lives: `"inline"` (default) in `navigateToPage`'s
+ * description, or `"onDemand"` in a `listPages` companion's result.
+ */
+declare type AgoNavigationOptions = {
+    catalogue?: "inline";
+} | {
+    catalogue: "onDemand";
+};
+
 /**
  * What the page currently displays, returned to the agent as the *result* of
  * `setPageState` instead of only as context on the next message.
@@ -1058,6 +1107,11 @@ export declare interface AgoWidgetConfig {
     metadata?: Record<string, unknown>;
 }
 
+/** Editable text returned by `AgoClient.transcribeAudio`. */
+declare interface AudioTranscription {
+    text: string;
+}
+
 /** One JavaScript error captured on the page (deduplicated, see `count`). */
 declare interface CapturedError {
     type: CapturedErrorType;
@@ -1145,22 +1199,11 @@ export declare interface ChatWidgetHandle {
  * client.registerFunction(fn);
  * ```
  */
-declare interface ClientFunctionDefinition {
+declare interface ClientFunctionDefinition extends ClientFunctionSettings {
     name: string;
     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;
-    /**
-     * Require explicit user approval before this function runs. See
-     * {@link AgoConfig.approvalPolicy} — pause mode only. ORs with the policy.
-     */
-    requiresApproval?: boolean;
 }
 
 /**
@@ -1179,20 +1222,7 @@ declare interface ClientFunctionInvocation {
  * 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;
-    /**
-     * Require explicit user approval before this function runs. See
-     * {@link AgoConfig.approvalPolicy} — pause mode only. ORs with the policy.
-     */
-    requiresApproval?: boolean;
-};
+declare type ClientFunctionRegisterOptions = Omit<ClientFunctionSchema, "name"> & ClientFunctionSettings;
 
 /**
  * Schema for a client-side function that AGO can call
@@ -1219,6 +1249,28 @@ declare interface ClientFunctionSchema {
     };
 }
 
+/** SDK-side function settings that are never sent to the backend. */
+declare interface ClientFunctionSettings {
+    /**
+     * 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;
+    /**
+     * Require explicit user approval before this function runs. See
+     * {@link AgoConfig.approvalPolicy} — pause mode only. ORs with the policy.
+     */
+    requiresApproval?: boolean;
+    /**
+     * WebMCP metadata, read only when the bridge is on (`AgoConfig.webmcp`).
+     * `false` keeps this function out of WebMCP while leaving it available to the
+     * in-app agent.
+     */
+    webmcp?: WebMCPToolMeta | false;
+}
+
 /** See {@link AgoConfig.clientFunctionsMode}. */
 declare type ClientFunctionsMode = "placeholder" | "pause";
 
@@ -1400,6 +1452,8 @@ declare interface CreateTicketResult {
 
 export declare const DEFAULT_FEEDBACK_LABELS: FeedbackLabels;
 
+export declare const DEFAULT_SPEECH_TO_TEXT_LABELS: SpeechToTextLabels;
+
 export declare const DEFAULT_TOOL_CALL_FORM_LABELS: ToolCallFormLabels;
 
 export declare const DEFAULT_WIDGET_LABELS: WidgetLabels;
@@ -1708,12 +1762,22 @@ export declare interface MountChatWidgetOptions {
     placeholder?: string;
     /** Enable file attachments. */
     allowFiles?: boolean;
+    /** Microphone, live waveform and draft transcription. Checks the tenant flag. Default false. */
+    speechToText?: boolean | SpeechToTextOptions;
     /**
      * While the agent is answering, turn the send button into a Stop button that
      * interrupts the turn. Default `true`; set `false` to keep showing a disabled
      * spinner instead.
      */
     allowStop?: boolean;
+    /**
+     * Follow new messages and streamed replies while the reader is at the bottom.
+     * Defaults to `true`; sending a message or clicking the jump button resumes
+     * following. Set `false` to keep the scroll position during replies. Sending
+     * a message or clicking the jump button still jumps to the end once, without
+     * enabling follow for subsequent chunks.
+     */
+    autoScroll?: boolean;
     /** Widget height (number → px). Ignored when `placement` is `"left"`/`"right"`
      * (a side panel is always full-height). */
     height?: string | number;
@@ -1950,6 +2014,15 @@ export declare interface MountChatWidgetOptions {
     }) => void;
 }
 
+/** A navigable page. `path` may carry `:param` placeholders. */
+declare interface NavRoute {
+    name: string;
+    path: string;
+    description: string;
+    /** Only read under `catalogue: "onDemand"`. */
+    section?: string;
+}
+
 /**
  * Optional action attached to a nudge. Accepting a `functionName` action
  * executes the registered client function (same `FunctionRegistry` path as
@@ -2153,6 +2226,14 @@ declare interface ProactiveTriggerWhen {
  */
 export declare function readableTextColor(background: string | undefined): string;
 
+/**
+ * Registered function with handler
+ */
+declare interface RegisteredFunction extends ClientFunctionSettings {
+    schema: ClientFunctionSchema;
+    handler: ClientFunctionHandler;
+}
+
 /**
  * Tiny, dependency-free markdown → DOM renderer for the vanilla chat widget.
  *
@@ -2237,6 +2318,8 @@ declare interface SdkPermissionConfig {
     homePage?: SdkHomePageConfig;
     fileAttachmentsEnabled: boolean;
     voiceEnabled: boolean;
+    /** Whether audio uploads can be transcribed. Defaults to false on older backends. */
+    speechToTextEnabled: boolean;
 }
 
 /**
@@ -2408,6 +2491,26 @@ declare interface SignalsSnapshot {
     pageState: Record<string, unknown> | null;
 }
 
+/** Strings used by the microphone control in every widget. */
+export declare interface SpeechToTextLabels {
+    start: string;
+    finish: string;
+    cancel: string;
+    requesting: string;
+    recording: string;
+    transcribing: string;
+    limitApproaching: string;
+    permissionDenied: string;
+    recordingFailed: string;
+    tooLarge: string;
+    noSpeech: string;
+    transcriptionFailed: string;
+}
+
+export declare interface SpeechToTextOptions {
+    labels?: Partial<SpeechToTextLabels>;
+}
+
 /**
  * SSE stream chunk data
  */
@@ -2690,6 +2793,31 @@ declare interface ToolCallTicketPrefill {
 
 declare type ToolCallType = "form" | "confirmation_input" | "status_message" | "progress_indicator" | "client_function" | "reasoning" | "mcp_ui_resource";
 
+/** Options for `AgoClient.transcribeAudio`. */
+declare interface TranscribeAudioOptions {
+    /** Cancel the upload or stop waiting for its transcription. */
+    signal?: AbortSignal;
+}
+
+/** The MCP behavior hints AGO has no equivalent for. */
+declare interface WebMCPToolMeta {
+    /**
+     * Both default to `false`, so only set what is true: `readOnlyHint` marks a
+     * function that changes nothing, `untrustedContentHint` one whose result may
+     * carry third-party text.
+     */
+    annotations?: {
+        readOnlyHint?: boolean;
+        untrustedContentHint?: boolean;
+    };
+    /**
+     * This function navigates. The WebMCP call is held open until the function
+     * registry goes quiet, so the caller sees the destination page's tools rather
+     * than the departing page's. Already set on the built-in `navigateToPage`.
+     */
+    navigates?: boolean;
+}
+
 /**
  * The greeting shown before any conversation has started. Pass a plain string
  * for the classic centered empty-state placeholder, or an object to control how