@useago/sdk 1.9.0 → 1.12.0

package/dist/index.d.cts

@@ -92,6 +92,7 @@ export 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). */
@@ -261,6 +262,26 @@ export 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
      */
@@ -519,6 +540,15 @@ export 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`.
@@ -541,6 +571,26 @@ export 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
      */
@@ -735,6 +785,12 @@ export 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;
 }
 
 /**
@@ -755,6 +811,8 @@ export 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;
     /**
@@ -814,6 +872,18 @@ export 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;
 }
 
 /**
@@ -1151,6 +1221,32 @@ export declare function autoDetectConfig(overrides?: Partial<AgoConfig>): AgoCon
  */
 export declare function canInlineImage(attachment: AgoAttachment): boolean;
 
+/** One JavaScript error captured on the page (deduplicated, see `count`). */
+export 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. */
+export declare type CapturedErrorType = "error" | "unhandledrejection" | "console" | "manual";
+
 /**
  * Registry that collects client-side context from across the component tree.
  *
@@ -1559,8 +1655,36 @@ export declare function createMockClient(options?: MockAgoClientOptions): MockAg
 
 export declare function createStore<T>(initial: T, persist?: PersistOptions): Store<T>;
 
+/** 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;
+}
+
 export declare const DEFAULT_MAX_ACTIVITY_ENTRIES = 10;
 
+export declare const DEFAULT_MAX_ERROR_AGE_MS = 600000;
+
+export declare const DEFAULT_MAX_ERRORS = 10;
+
 /**
  * Create a reusable function definition.
  * Returns the same object — this is an identity function for discoverability and type-checking.
@@ -1603,6 +1727,83 @@ export declare function deriveFormStatus(schema: FormCollectorSchema, values: Pa
  */
 export declare type DynamicContextProvider = () => ContextEntry | null | undefined;
 
+/**
+ * Captures the page's JavaScript errors so they can ride along as agent
+ * context: uncaught exceptions (`window` `error` event), unhandled promise
+ * rejections, every `console.error` call, and errors the app reports itself
+ * via {@link report}.
+ *
+ * Errors are deduplicated by type + message + source + line (a repeat bumps
+ * `count` and `lastAt`), capped at `maxErrors`, and pruned after `maxAgeMs`
+ * when read. Messages and stacks are truncated so one error cannot bloat the
+ * context.
+ *
+ * `console.error` capture wraps the console method. This is the one sanctioned
+ * exception to the SDK's no-global-mutation rule: the wrapper always calls the
+ * original, ignores the SDK's own `[AGO SDK]` lines, and is restored by
+ * {@link destroy} when it is still installed (another library may have
+ * wrapped it after us; in that case ours stays in the chain and keeps calling
+ * through).
+ *
+ * Attached by `AgoClient` when `errorWatcher` is set in the config; usable
+ * standalone. Listeners are attached only by `start()` and removed by
+ * `destroy()`. No-op outside a browser (SSR).
+ */
+export declare class ErrorWatcher {
+    private readonly maxErrors;
+    private readonly maxAgeMs;
+    private readonly maxStackChars;
+    private readonly filter?;
+    private started;
+    private teardowns;
+    private errors;
+    private listeners;
+    /** True while a capture is being processed (a throw inside must not recurse). */
+    private capturing;
+    constructor(options?: ErrorWatcherOptions);
+    /** Attach the listeners and wrap `console.error`. Idempotent; no-op in SSR. */
+    start(): void;
+    /** Remove the listeners, restore `console.error`, drop subscribers. */
+    destroy(): void;
+    /**
+     * Record an error the app caught itself (error boundary, framework error
+     * handler, try/catch). `context` is size-clamped before it is stored.
+     */
+    report(error: unknown, context?: Record<string, unknown>): void;
+    /** Subscribe to captures (fires once per capture, repeats included). */
+    subscribe(listener: (error: CapturedError) => void): () => void;
+    /** Errors still within `maxAgeMs`, oldest first (a copy). */
+    getErrors(): CapturedError[];
+    clear(): void;
+    private onErrorEvent;
+    private onRejectionEvent;
+    private wrapConsoleError;
+    private onConsoleError;
+    private capture;
+    private notify;
+    private prune;
+    /** Drop the leading "Name: message" line stacks repeat, then cap the length. */
+    private trimStack;
+    private currentPathname;
+}
+
+export 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;
+}
+
 /**
  * Simple typed event emitter
  */
@@ -2371,6 +2572,12 @@ export 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). */
@@ -2414,10 +2621,69 @@ export declare function safeAttachmentUrl(url?: string): string | undefined;
  */
 export declare const scrollToElement: ClientFunctionDefinition;
 
+/** 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
  */
 export 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 */
@@ -2483,8 +2749,9 @@ export declare interface Signal {
 
 /**
  * Framework-agnostic collector of client-side friction signals: per-route
- * dwell time, idle time, route bounces (A→B→A→B), rage clicks, and app-pushed
- * field error counters. Attached to an `AgoClient` by `createAgoProactive`,
+ * dwell time, idle time, route bounces (A→B→A→B), rage clicks, app-pushed
+ * field error counters, and JavaScript error counts (pushed by the client's
+ * `ErrorWatcher` through `createAgoProactive`). Attached to an `AgoClient` by `createAgoProactive`,
  * the same way `ClientContextRegistry` is attached.
  *
  * Route observation is poll-on-demand rather than a `history.pushState` patch:
@@ -2516,6 +2783,7 @@ export declare class SignalCollector {
     private recentRoutes;
     private routeBounces;
     private rageClicks;
+    private jsErrors;
     private fieldErrors;
     private recentClicks;
     private signals;
@@ -2533,9 +2801,15 @@ export declare class SignalCollector {
      * Pass the field NAME only — values are never read, so no PII is collected.
      */
     signalFieldError(fieldName: string): void;
+    /**
+     * Pushed signal: a JavaScript error was captured on the page. Counter only;
+     * `kind` says how it was caught (`error`, `unhandledrejection`, `console`,
+     * `manual`). The message itself never enters the signals channel.
+     */
+    signalJsError(kind: string): void;
     /**
      * Subscribe to raw signals (route changes, bounces, rage clicks, field
-     * errors). Returns an unsubscribe function. Used by the proactive engine to
+     * errors, JS errors). Returns an unsubscribe function. Used by the proactive engine to
      * evaluate promptly instead of waiting for the next tick.
      */
     subscribe(listener: (signal: Signal) => void): () => void;
@@ -2605,6 +2879,12 @@ export 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
@@ -2628,7 +2908,7 @@ export declare interface SignalsSnapshot {
  * Privacy rule: signals carry **enums, counters, and paths only** — never field
  * values or free text — so no PII ever leaves the page through this channel.
  */
-export declare type SignalType = "route_change" | "route_bounce" | "rage_click" | "field_error";
+export declare type SignalType = "route_change" | "route_bounce" | "rage_click" | "field_error" | "js_error";
 
 /**
  * SSE stream chunk data
@@ -2671,6 +2951,13 @@ export 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[];
 }
@@ -2839,12 +3126,82 @@ export declare const submitForm: ClientFunctionDefinition;
 export 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
  */
@@ -2859,6 +3216,34 @@ export 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>;
 }
 
 export declare type ToolCallType = "form" | "confirmation_input" | "status_message" | "progress_indicator" | "client_function" | "reasoning" | "mcp_ui_resource";