@useago/sdk 1.7.2 → 1.12.0

package/dist/devtools.d.ts

@@ -53,6 +53,7 @@ declare class AgoClient {
     private contextRegistry;
     private eventEmitter;
     private activityLedger;
+    private errorWatcher;
     private lastSentPageState;
     private config;
     /** Conversations already warned about an empty reply (one warning each). */
@@ -222,6 +223,26 @@ declare class AgoClient {
      * `SSEHandler.parseToolCall` so persisted and streamed tool calls match.
      */
     private static mapPersistedToolCalls;
+    /**
+     * 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.
+     */
+    getConfig(): Promise<SdkConfig>;
+    /**
+     * The dashboard's home screen content. A starter card shows its
+     * `description` and sends its `initial_message`; one with neither is
+     * unusable and is dropped rather than rendered as an empty card.
+     */
+    private static mapHomePage;
+    private static mapTicketForm;
+    /**
+     * Create a support ticket (`POST /api/sdk/v1/tickets`, multipart). This is
+     * what the ticket form in the conversation does before it completes the
+     * `form` tool call with {@link submitToolCallForm}.
+     */
+    createTicket(input: CreateTicketInput): Promise<CreateTicketResult>;
     /**
      * Get messages for a conversation
      */
@@ -273,9 +294,40 @@ declare class AgoClient {
      */
     submitFormCollector(name: string, values: Record<string, unknown>): Promise<unknown>;
     /**
-     * Submit feedback for a message
+     * Report an answer: thumbs up/down, optionally with what went wrong.
+     *
+     * ```ts
+     * await client.submitFeedback(message.id, "negative", {
+     *   reasons: ["inaccurate"],
+     *   comment: "The price it quoted is from last year.",
+     * });
+     * ```
+     *
+     * A bare rating is a reaction (the thumbs counted in the dashboard). Adding a
+     * reason or a comment also files it in the feedback list, the analytics and
+     * the CSV export, so someone can act on it.
+     */
+    submitFeedback(messageId: string, rating: FeedbackRating, details?: FeedbackDetails): Promise<void>;
+    /**
+     * Report a whole conversation ("this chat is not working").
+     *
+     * ```ts
+     * await client.submitConversationFeedback(conversationId, "negative", {
+     *   reasons: ["information_not_found"],
+     *   comment: "It never answered my question.",
+     * });
+     * ```
+     *
+     * Feedback is stored per message, so this attaches the report to the last
+     * answer of the conversation, which is the one the user is reacting to.
+     * Returns the message id it landed on.
+     *
+     * Pass `lastMessageId` when you already have it (the widget does) to skip the
+     * lookup round-trip.
      */
-    submitFeedback(messageId: string, rating: "positive" | "negative"): Promise<void>;
+    submitConversationFeedback(conversationId: string, rating: FeedbackRating, details?: FeedbackDetails & {
+        lastMessageId?: string;
+    }): Promise<string>;
     /**
      * Register a client-side function that AGO can call.
      * Accepts either a definition object or (name, handler, schema) args.
@@ -449,6 +501,15 @@ declare class AgoClient {
     /* Excluded from this release type: emitProactiveEvent */
     /* Excluded from this release type: getHttp */
     /* Excluded from this release type: getConfiguredAgent */
+    /**
+     * How the SDK identifies the visitor: the configured `userEmail`, and
+     * whether a `userJwt` is set. The ticket form asks for an email when it has
+     * neither.
+     */
+    getUserIdentity(): {
+        email?: string;
+        hasJwt: boolean;
+    };
     /**
      * Enable automatic capture of the current browser page (URL + title).
      * Injected as a dynamic context entry named `browser-page`.
@@ -471,6 +532,26 @@ declare class AgoClient {
     private addActivity;
     private recordAgentAction;
     private registerActivityContext;
+    /**
+     * Start capturing the page's JavaScript errors (uncaught exceptions,
+     * unhandled rejections, `console.error` calls, {@link reportError}) and send
+     * the recent ones as the `errors:recent` context entry on every message.
+     * Same as setting `errorWatcher` in the config. Calling it again replaces
+     * the watcher (and its options); the captured errors are not kept.
+     */
+    enableErrorWatcher(options?: ErrorWatcherOptions): void;
+    /** Stop capturing errors and drop the `errors:recent` context entry. */
+    disableErrorWatcher(): void;
+    /**
+     * Record an error the app caught itself (React error boundary, Vue
+     * `errorHandler`, Angular `ErrorHandler`, a try/catch) so the agent sees it
+     * like an uncaught one. No-op unless the error watcher is enabled. `context`
+     * is size-clamped before it is stored; keep it small and free of secrets.
+     */
+    reportError(error: unknown, context?: Record<string, unknown>): void;
+    /** Errors the watcher currently holds, oldest first (a copy). Empty when disabled. */
+    getRecentErrors(): CapturedError[];
+    clearErrors(): void;
     /**
      * Subscribe to an event
      */
@@ -665,6 +746,12 @@ declare interface AgoClientEvents {
     };
     /** A user- or agent-action was recorded into the activity ledger. */
     "activity:recorded": ActivityEntry;
+    /**
+     * The error watcher captured a JavaScript error (uncaught exception,
+     * unhandled rejection, `console.error` call, or `reportError`). Fires on
+     * repeats too, with the updated `count`. Requires `errorWatcher` in the config.
+     */
+    "error:captured": CapturedError;
 }
 
 /**
@@ -685,6 +772,8 @@ declare interface AgoConfig {
     userEmail?: string;
     /** JWT token for authenticated users */
     userJwt?: string;
+    /** User metadata sent with messages. Use null to stop sending defaults. Not an authentication credential. */
+    metadata?: Record<string, unknown> | null;
     /** Enable debug logging */
     debug?: boolean;
     /**
@@ -744,6 +833,18 @@ declare interface AgoConfig {
      * default otherwise.
      */
     proactive?: ProactiveOptions;
+    /**
+     * Capture the page's JavaScript errors as agent context. When set, the SDK
+     * listens for uncaught exceptions and unhandled promise rejections, wraps
+     * `console.error` (calling through; restored on `destroy`), and sends the
+     * recent errors (deduplicated, capped, pruned after 10 min) as the
+     * `errors:recent` context entry on every message. `true` uses the defaults;
+     * pass {@link ErrorWatcherOptions} to tune the caps or add a `filter` that
+     * redacts messages. Off by default: error messages can carry PII or internal
+     * URLs, so enabling it is the host's call. Errors also feed the proactive
+     * mode's `jsErrors` signal. See `client.reportError()` for caught errors.
+     */
+    errorWatcher?: boolean | ErrorWatcherOptions;
 }
 
 declare type AgoEventHandler<K extends AgoEventName> = (data: AgoClientEvents[K]) => void;
@@ -907,12 +1008,53 @@ declare interface AgoStateControl<T = unknown> {
             enum?: (string | number)[];
         };
     };
+    /** String-only: `""` means "clear" instead of being dropped as filler. */
+    clearable?: boolean;
     /** 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>;
+    set: (value: T) => void | AgoStateSetResult | Promise<void | AgoStateSetResult>;
 }
 
+/**
+ * Tagged outcome a page setter may return to reject or mark unchanged.
+ *
+ * Returning nothing (void) means APPLY. Returning an unrecognized JS value
+ * (e.g. a string from an assignment expression) is also treated as APPLY.
+ */
+declare type AgoStateSetResult = {
+    result: "rejected";
+    reason: string;
+} | {
+    result: "unchanged";
+};
+
+/** One JavaScript error captured on the page (deduplicated, see `count`). */
+declare interface CapturedError {
+    type: CapturedErrorType;
+    /** Error message, truncated to 500 chars. */
+    message: string;
+    /** Script URL the error came from, without its query string. */
+    source?: string;
+    line?: number;
+    col?: number;
+    /** Leading stack frames, truncated (see `maxStackChars`). */
+    stack?: string;
+    /** Pathname at capture time. */
+    route: string;
+    /** Epoch ms of the first occurrence. */
+    firstAt: number;
+    /** Epoch ms of the most recent occurrence. */
+    lastAt: number;
+    /** How many times this same error (type + message + source + line) fired. */
+    count: number;
+    /** App-provided context, manual reports only (size-clamped). */
+    context?: Record<string, unknown>;
+}
+
+/** How an error reached the watcher. */
+declare type CapturedErrorType = "error" | "unhandledrejection" | "console" | "manual";
+
 /**
  * Single-object function definition — combines name, schema, and handler.
  *
@@ -1046,6 +1188,30 @@ declare interface Conversation {
     messages?: AgoMessage[];
 }
 
+/** Input of `AgoClient.createTicket` (`POST /api/sdk/v1/tickets`). */
+declare interface CreateTicketInput {
+    subject: string;
+    body: string;
+    priority?: string;
+    typology?: string;
+    /** Conversation the ticket is filed from. */
+    conversationId?: string;
+    /** Reporter email, for a visitor the SDK does not otherwise identify. */
+    email?: string;
+    customFields?: Array<{
+        id: string;
+        value: string;
+    }>;
+    files?: File[];
+    ticketFormId?: string;
+}
+
+/** Response of `AgoClient.createTicket`. */
+declare interface CreateTicketResult {
+    id: string;
+    url?: string;
+}
+
 /** Options for {@link initDevPanel}. */
 export declare interface DevPanelOptions {
     /**
@@ -1053,7 +1219,9 @@ export declare interface DevPanelOptions {
      * function events, and renders the name + data of each entry in its live context
      * snapshot (`client.getContextSnapshot()`)
      */
-    client: Pick<AgoClient, "on" | "getRegisteredFunctions" | "getContextSnapshot">;
+    client: Pick<AgoClient, "on" | "off" | "getRegisteredFunctions" | "getContextSnapshot"> & {
+        executeClientFunction?: AgoClient["executeClientFunction"];
+    };
     /** Where to mount: a CSS selector, an Element, or `document.body` (default). */
     target?: string | Element;
     /**
@@ -1067,6 +1235,12 @@ export declare interface DevPanelOptions {
      * page (one per widget): pass e.g. the agent or widget name to tell them apart.
      */
     label?: string;
+    /**
+     * Mount a local function runner in the panel. The runner executes registered
+     * client functions locally via `client.executeClientFunction` and displays
+     * the result. It never submits to the backend. Developer-only.
+     */
+    enableFunctionRunner?: boolean;
 }
 
 /**
@@ -1076,6 +1250,54 @@ export declare interface DevPanelOptions {
  */
 declare type DynamicContextProvider = () => ContextEntry | null | undefined;
 
+declare interface ErrorWatcherOptions {
+    /** Max distinct errors kept. Oldest dropped first. Default 10. */
+    maxErrors?: number;
+    /**
+     * Errors older than this are pruned when the buffer is read, so a crash from
+     * an hour ago does not confuse the agent. Default 600 000 (10 min).
+     */
+    maxAgeMs?: number;
+    /** Max chars of stack kept per error. Default 2000. */
+    maxStackChars?: number;
+    /**
+     * Redact or drop an error before it is stored. Return the (possibly edited)
+     * error to keep it, `null` to drop it. Runs on every capture, so keep it cheap.
+     */
+    filter?: (error: CapturedError) => CapturedError | null;
+}
+
+/**
+ * Why the user is reporting a message (see `AgoClient.submitFeedback`).
+ *
+ * A rating on its own is a reaction (the thumbs count). Add a reason or a
+ * comment and the report also lands in the feedback dashboard, the analytics
+ * and the CSV export, where someone can act on it.
+ */
+declare interface FeedbackDetails {
+    /** What went wrong. Several can apply at once. */
+    reasons?: FeedbackReason[];
+    /** The user's own words. Trimmed server-side; 5000 characters max. */
+    comment?: string;
+}
+
+/** Thumbs up / thumbs down on an answer. */
+declare type FeedbackRating = "positive" | "negative";
+
+/**
+ * What went wrong with an answer. These are the four buckets the AGO feedback
+ * dashboard filters and charts on.
+ */
+declare type FeedbackReason = 
+/** The answer states something false. */
+"inaccurate"
+/** The answer is right but stops short. */
+| "incomplete"
+/** The agent could not find the information. */
+| "information_not_found"
+/** Something broke: the widget, a tool call, the stream. */
+| "technical_issue";
+
 /**
  * The backend-stored shape returned by `GET /api/sdk/v1/forms/{name}` (see
  * {@link AgoClient.getFormCollector}). Mirrors the persistable subset of
@@ -1217,7 +1439,7 @@ declare class HttpClient {
     private handleErrorResponse;
 }
 
-export declare function initDevPanel(options: DevPanelOptions): void;
+export declare function initDevPanel(options: DevPanelOptions): () => void;
 
 declare type MessageStatus = "IN_PROGRESS" | "DONE" | "ERROR" | "TODO" | "CANCELED"
 /**
@@ -1407,6 +1629,12 @@ declare interface ProactiveTriggerWhen {
     pageState?: Partial<Record<string, unknown>>;
     /** Min rage-click bursts on the current route. */
     rageClicks?: number;
+    /**
+     * Min JavaScript errors captured on the current route. Needs the client's
+     * `errorWatcher` enabled; without it the count stays at 0 and the matcher
+     * never passes.
+     */
+    jsErrors?: number;
     /** Min A→B→A→B route oscillations this session. */
     routeBounces?: number;
     /** Per-field minimum error counts (field NAME → min count). */
@@ -1424,10 +1652,69 @@ declare type ResumeGate = (info: {
     messageId: string;
 }) => Promise<void> | void;
 
+/** Response of `GET /api/sdk/v1/config` (see `AgoClient.getConfig`). */
+declare interface SdkConfig {
+    permissions: SdkPermissionConfig[];
+    proactive: {
+        enabled: boolean;
+    };
+}
+
+/** The dashboard's home screen content (title, subtitle, starter cards). */
+declare interface SdkHomePageConfig {
+    title?: string;
+    /** Markdown. */
+    subtitle?: string;
+    starters: SdkHomeStarter[];
+    widgetStarter?: SdkWidgetStarter;
+}
+
+/**
+ * A conversation starter card configured in the AGO dashboard. `label` is what
+ * the card shows; clicking it sends `message`.
+ */
+declare interface SdkHomeStarter {
+    id: string;
+    /** The card's text (the starter's `description` in the dashboard). */
+    label: string;
+    /** What is sent when the card is clicked. */
+    message: string;
+    /** Answer with this agent instead of the configured default. */
+    agentId?: string;
+}
+
+/** One permission's configuration in {@link SdkConfig}. */
+declare interface SdkPermissionConfig {
+    id?: string;
+    name?: string;
+    displayName?: string;
+    agents: Array<{
+        id: string;
+        name?: string;
+    }>;
+    ticketForm?: TicketForm;
+    /** Home screen content, when the tenant configured one. */
+    homePage?: SdkHomePageConfig;
+    fileAttachmentsEnabled: boolean;
+    voiceEnabled: boolean;
+}
+
+/**
+ * The starter the dashboard sends by itself on a fresh visit, before the
+ * visitor types anything.
+ */
+declare interface SdkWidgetStarter {
+    id: string;
+    message: string;
+    agentId?: string;
+}
+
 /**
  * Options for sending a message
  */
 declare interface SendMessageOptions {
+    /** Replaces config.metadata for this message; null omits metadata for this message. */
+    metadata?: Record<string, unknown> | null;
     /** Existing conversation ID */
     conversationId?: string;
     /** Override default agent */
@@ -1476,6 +1763,12 @@ declare interface SignalsSnapshot {
     idleMs: number;
     /** Rage-click bursts detected on the current route. */
     rageClicks: number;
+    /**
+     * JavaScript errors captured on the current route (count only; the messages
+     * travel in `client_context` under `errors:recent`). Always `0` unless the
+     * client has `errorWatcher` enabled.
+     */
+    jsErrors: number;
     /**
      * A→B→A→B route oscillations detected in the recent route sequence. Rolling
      * session counter (cross-route by nature); trigger cooldowns and dismissal
@@ -1534,6 +1827,13 @@ declare interface SSEChunkData {
     follow_up_replies?: string[];
     satisfaction_feedback?: unknown;
     ask_to_talk_to_human?: boolean;
+    allowed_to_create_ticket?: boolean;
+    ticket?: ToolCallTicketPrefill;
+    mode?: "form" | "embed";
+    ticket_form_id?: string;
+    embed_html?: string;
+    embed_description?: string;
+    display_mode?: "collapsible" | "display" | "both";
     /** Tool call ids still awaiting a client result, sent with the final `WAITING_CLIENT` event. */
     waiting_tool_call_ids?: string[];
 }
@@ -1587,12 +1887,82 @@ declare type SubmitConfig<V = Record<string, unknown>> = string | {
 declare interface SubmitToolCallResult {
     status: string;
     result?: unknown;
+    /** Set when `status` is `"error"`. */
+    error?: string;
+    /** The ticket a ticketing `form` tool call resolved to, when it did. */
+    ticket?: {
+        ticket_id: string;
+        ticket_url?: string;
+        [key: string]: unknown;
+    };
     resume?: {
         message_id: string;
         ready: boolean;
     };
 }
 
+/** A custom field of a ticket form. */
+declare interface TicketField {
+    id: string;
+    /** The key the ticketing backend expects; used as the submit key when set. */
+    externalId?: string;
+    title?: string;
+    /** Field kind, e.g. `"text"`, `"checkbox"`, `"tagger"`. */
+    type?: string;
+    required: boolean;
+    /** Carried in the submission but never shown. */
+    hidden: boolean;
+    active?: boolean;
+    /** Bypass progressive disclosure, while still respecting conditions. */
+    alwaysVisible?: boolean;
+    regexpForValidation?: string;
+    position: number;
+    /** Non-empty turns the field into a select. */
+    options: TicketFieldOption[];
+    /** Show this field only when the parent field holds `conditionalFieldValue`. */
+    conditionalFieldId?: string;
+    /** Legacy comma-separated condition values. */
+    conditionalFieldValue?: string;
+    /** Takes precedence over conditionalFieldValue when non-empty. */
+    conditionalFieldValues?: string[];
+}
+
+/** An option of a ticket form field (`GET /config` → `ticket_form.fields[].options[]`). */
+declare interface TicketFieldOption {
+    id: string;
+    /** Label shown to the user. */
+    name?: string;
+    /** Value submitted. Falls back to `name` when absent. */
+    value?: string;
+    /** Preselected when the form opens. */
+    default: boolean;
+    /** A note shown under the field once this option is picked. */
+    message?: string;
+    messageType: "info" | "warning" | "danger";
+    position?: number;
+    group?: string;
+    noDisplay?: boolean;
+    conditionalFieldId?: string;
+    /** Available when the parent matches any of these values. */
+    conditionalFieldValues?: string[];
+}
+
+/** The ticket form an agent's `ago_ticketing` tool opens in the conversation. */
+declare interface TicketForm {
+    id: string;
+    name?: string;
+    /** `"form"` renders the SDK's own fields; `"embed"` hosts third-party HTML. */
+    mode: "form" | "embed";
+    showSubject: boolean;
+    showBody: boolean;
+    showPriority: boolean;
+    showTypology: boolean;
+    priorityTypologies?: string[];
+    successMessageText?: string;
+    successMessageUrlLabel?: string;
+    fields: TicketField[];
+}
+
 /**
  * Tool call data from SSE stream
  */
@@ -1607,6 +1977,34 @@ declare interface ToolCallData {
     data?: Record<string, unknown>;
     functionName?: string;
     arguments?: Record<string, unknown>;
+    /**
+     * Where the hosted widget shows the call: in the collapsible "reasoning"
+     * section, in the message body, or both. Absent means collapsible only.
+     */
+    displayMode?: "collapsible" | "display" | "both";
+    /** The user asked to talk to a human. */
+    askToTalkToHuman?: boolean;
+    /** `false` when the tenant blocks ticket creation for this visitor. */
+    allowedToCreateTicket?: boolean;
+    /** Fields the agent pre-filled from the conversation. */
+    ticket?: ToolCallTicketPrefill;
+    /** `"embed"` hosts third-party HTML (`embedHtml`); otherwise the SDK's form. */
+    mode?: "form" | "embed";
+    ticketFormId?: string;
+    embedHtml?: string;
+    embedDescription?: string;
+}
+
+/** The ticket the agent pre-filled on a ticketing `form` tool call. */
+declare interface ToolCallTicketPrefill {
+    subject?: string;
+    body?: string;
+    typology?: string;
+    priority?: string;
+    tag?: string;
+    products?: string[];
+    /** Keyed by the field's external id, or a lowercased, underscored title. */
+    custom_fields?: Record<string, string>;
 }
 
 declare type ToolCallType = "form" | "confirmation_input" | "status_message" | "progress_indicator" | "client_function" | "reasoning" | "mcp_ui_resource";