@useago/sdk 1.13.2 → 1.14.0

package/dist/widget.d.cts

@@ -245,6 +245,8 @@ declare class AgoClient {
      * Show the returned text as a draft; call `sendMessage` when the user sends it.
      */
     transcribeAudio(file: File, options?: TranscribeAudioOptions): Promise<AudioTranscription>;
+    /** The requested language, before UI fallback. */
+    getLanguage(): string | null;
     /**
      * 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
@@ -620,6 +622,9 @@ declare class AgoClient {
  * SDK Events
  */
 declare interface AgoClientEvents {
+    "config:changed": {
+        language: string | null;
+    };
     /**
      * The client-side context changed: a context entry or dynamic provider was
      * added/removed, or a stateful helper (e.g. `createFormCollector`) updated its
@@ -729,6 +734,11 @@ declare interface AgoClientEvents {
         result: unknown;
         error?: string;
     };
+    /** A validated form collector submission is about to call its submit target. */
+    "form:submitting": {
+        name: string;
+        values: Record<string, unknown>;
+    };
     /**
      * A form collector submitted successfully. `result` is the raw submit response
      * (POST body / handler return value / backend relay result) — the third-party
@@ -1951,7 +1961,7 @@ export declare interface MountChatWidgetOptions {
      * under each finished answer, and after a thumbs-down a small panel to say
      * what went wrong (reason chips plus a free-text comment).
      *
-     * `true` turns it on with English labels. Pass an object to translate the
+     * `true` turns it on with localized labels. Pass an object to translate the
      * strings, skip the "why" panel, or observe what was sent. Off by default.
      *
      * ```ts
@@ -1993,6 +2003,11 @@ export declare interface MountChatWidgetOptions {
         id: string;
         content: string;
     }) => void;
+    /** Called after validation, just before the form submission starts. */
+    onFormSubmitting?: (data: {
+        name: string;
+        values: Record<string, unknown>;
+    }) => void;
     /**
      * Called when a form collector submits successfully. `result` is the raw submit
      * response (the third-party API's answer); `values` are the submitted fields.
@@ -2628,6 +2643,7 @@ declare interface SubmitToolCallResult {
 
 /** A custom field of a ticket form. */
 declare interface TicketField {
+    prefillAliases?: string[];
     id: string;
     /** The key the ticketing backend expects; used as the submit key when set. */
     externalId?: string;
@@ -2674,6 +2690,7 @@ declare interface TicketFieldOption {
 
 /** The ticket form an agent's `ago_ticketing` tool opens in the conversation. */
 declare interface TicketForm {
+    embedDescription?: string;
     id: string;
     name?: string;
     /** `"form"` renders the SDK's own fields; `"embed"` hosts third-party HTML. */
@@ -2721,9 +2738,8 @@ declare interface ToolCallData {
 }
 
 /**
- * Every string the ticket form and its surrounding chrome show, with the
- * hosted widget's English defaults, so a non-English site can translate them
- * through `toolCallForm.labels`.
+ * Client-owned wording for the ticket form and its surrounding chrome.
+ * Hosts can customize individual strings through `toolCallForm.labels`.
  */
 export declare interface ToolCallFormLabels {
     useFormToCreateTicket: string;
@@ -2763,6 +2779,8 @@ export declare interface ToolCallFormLabels {
     submissionFailed: string;
     submissionFailedDescription: string;
     fileTooLarge: string;
+    fileSize: string;
+    removeFile: string;
     permissionDenied: string;
     validationFailed: string;
     pleaseCheckFields: string;
@@ -2799,16 +2817,21 @@ declare interface TranscribeAudioOptions {
     signal?: AbortSignal;
 }
 
-/** The MCP behavior hints AGO has no equivalent for. */
+/** Metadata for tools exposed through the WebMCP bridge. */
 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.
+     * Optional WebMCP metadata; all fields default to `false` in WebMCP.
+     * These annotations do not affect AGO's in-app agent or approval behavior.
      */
     annotations?: {
+        /** The tool only reads data and does not change state. */
         readOnlyHint?: boolean;
+        /** The output contains content untrusted by the tool author. */
         untrustedContentHint?: boolean;
+        /** Significant, real-world, or irreversible effects; independent of requiresApproval. */
+        consequentialHint?: boolean;
+        /** Intended for debugging and developer tooling. */
+        debugging?: boolean;
     };
     /**
      * This function navigates. The WebMCP call is held open until the function

package/dist/widget.d.ts

@@ -245,6 +245,8 @@ declare class AgoClient {
      * Show the returned text as a draft; call `sendMessage` when the user sends it.
      */
     transcribeAudio(file: File, options?: TranscribeAudioOptions): Promise<AudioTranscription>;
+    /** The requested language, before UI fallback. */
+    getLanguage(): string | null;
     /**
      * 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
@@ -620,6 +622,9 @@ declare class AgoClient {
  * SDK Events
  */
 declare interface AgoClientEvents {
+    "config:changed": {
+        language: string | null;
+    };
     /**
      * The client-side context changed: a context entry or dynamic provider was
      * added/removed, or a stateful helper (e.g. `createFormCollector`) updated its
@@ -729,6 +734,11 @@ declare interface AgoClientEvents {
         result: unknown;
         error?: string;
     };
+    /** A validated form collector submission is about to call its submit target. */
+    "form:submitting": {
+        name: string;
+        values: Record<string, unknown>;
+    };
     /**
      * A form collector submitted successfully. `result` is the raw submit response
      * (POST body / handler return value / backend relay result) — the third-party
@@ -1951,7 +1961,7 @@ export declare interface MountChatWidgetOptions {
      * under each finished answer, and after a thumbs-down a small panel to say
      * what went wrong (reason chips plus a free-text comment).
      *
-     * `true` turns it on with English labels. Pass an object to translate the
+     * `true` turns it on with localized labels. Pass an object to translate the
      * strings, skip the "why" panel, or observe what was sent. Off by default.
      *
      * ```ts
@@ -1993,6 +2003,11 @@ export declare interface MountChatWidgetOptions {
         id: string;
         content: string;
     }) => void;
+    /** Called after validation, just before the form submission starts. */
+    onFormSubmitting?: (data: {
+        name: string;
+        values: Record<string, unknown>;
+    }) => void;
     /**
      * Called when a form collector submits successfully. `result` is the raw submit
      * response (the third-party API's answer); `values` are the submitted fields.
@@ -2628,6 +2643,7 @@ declare interface SubmitToolCallResult {
 
 /** A custom field of a ticket form. */
 declare interface TicketField {
+    prefillAliases?: string[];
     id: string;
     /** The key the ticketing backend expects; used as the submit key when set. */
     externalId?: string;
@@ -2674,6 +2690,7 @@ declare interface TicketFieldOption {
 
 /** The ticket form an agent's `ago_ticketing` tool opens in the conversation. */
 declare interface TicketForm {
+    embedDescription?: string;
     id: string;
     name?: string;
     /** `"form"` renders the SDK's own fields; `"embed"` hosts third-party HTML. */
@@ -2721,9 +2738,8 @@ declare interface ToolCallData {
 }
 
 /**
- * Every string the ticket form and its surrounding chrome show, with the
- * hosted widget's English defaults, so a non-English site can translate them
- * through `toolCallForm.labels`.
+ * Client-owned wording for the ticket form and its surrounding chrome.
+ * Hosts can customize individual strings through `toolCallForm.labels`.
  */
 export declare interface ToolCallFormLabels {
     useFormToCreateTicket: string;
@@ -2763,6 +2779,8 @@ export declare interface ToolCallFormLabels {
     submissionFailed: string;
     submissionFailedDescription: string;
     fileTooLarge: string;
+    fileSize: string;
+    removeFile: string;
     permissionDenied: string;
     validationFailed: string;
     pleaseCheckFields: string;
@@ -2799,16 +2817,21 @@ declare interface TranscribeAudioOptions {
     signal?: AbortSignal;
 }
 
-/** The MCP behavior hints AGO has no equivalent for. */
+/** Metadata for tools exposed through the WebMCP bridge. */
 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.
+     * Optional WebMCP metadata; all fields default to `false` in WebMCP.
+     * These annotations do not affect AGO's in-app agent or approval behavior.
      */
     annotations?: {
+        /** The tool only reads data and does not change state. */
         readOnlyHint?: boolean;
+        /** The output contains content untrusted by the tool author. */
         untrustedContentHint?: boolean;
+        /** Significant, real-world, or irreversible effects; independent of requiresApproval. */
+        consequentialHint?: boolean;
+        /** Intended for debugging and developer tooling. */
+        debugging?: boolean;
     };
     /**
      * This function navigates. The WebMCP call is held open until the function