@runtypelabs/persona 4.13.0 → 4.15.0

package/dist/context-mentions.d.cts

@@ -1,5 +1,39 @@
 import { IconNode } from 'lucide';
 
+type AgentWidgetTransformSuggestionsContext = {
+    /**
+     * Fresh copy of the suggestions entering this plugin, already normalized:
+     * shorthand strings expanded and the effective send/fill behavior resolved.
+     */
+    suggestions: AgentWidgetResolvedSuggestion[];
+    surface: AgentWidgetSuggestionSurface;
+    source: AgentWidgetSuggestionSource;
+    config: AgentWidgetConfig;
+};
+type AgentWidgetRenderSuggestionContext = {
+    /** Fully normalized suggestion, including the effective send/fill behavior. */
+    suggestion: AgentWidgetResolvedSuggestion;
+    index: number;
+    surface: AgentWidgetSuggestionSurface;
+    source: AgentWidgetSuggestionSource;
+    variant: AgentWidgetSuggestionVariant;
+    streaming: boolean;
+    config: AgentWidgetConfig;
+    /** Build Persona's standard chip, card, or list item. */
+    defaultRenderer: () => HTMLElement;
+    /**
+     * Run the normal selection pipeline: DOM event, plugin selection hooks, then
+     * send or fill. Custom renderers should call this instead of sending directly.
+     */
+    select: () => void;
+};
+type AgentWidgetSuggestionSelectContext = {
+    suggestion: AgentWidgetResolvedSuggestion;
+    surface: AgentWidgetSuggestionSurface;
+    source: AgentWidgetSuggestionSource;
+    variant: AgentWidgetSuggestionVariant;
+    config: AgentWidgetConfig;
+};
 /**
  * Plugin interface for customizing widget components
  */
@@ -12,6 +46,25 @@ interface AgentWidgetPlugin {
      * Optional priority (higher = runs first). Default: 0
      */
     priority?: number;
+    /**
+     * Transform, filter, enrich, or reorder suggestions. Hooks receive normalized
+     * items and compose in plugin priority order; the return value may use the
+     * loose shape (string shorthand included) and is re-normalized before the next
+     * hook. A per-item `behavior` set here survives. `maxItems` caps the list
+     * after the full chain. Return an empty array to hide the surface.
+     */
+    transformSuggestions?: (context: AgentWidgetTransformSuggestionsContext) => AgentWidgetSuggestion[];
+    /**
+     * Render one starter or follow-up suggestion. Return null to use Persona's
+     * default chip/card/list renderer. Call `select()` from custom interaction
+     * controls to preserve events, selection hooks, and send/fill behavior.
+     */
+    renderSuggestion?: (context: AgentWidgetRenderSuggestionContext) => HTMLElement | null;
+    /**
+     * Observe or intercept a suggestion selection. Return false to cancel the
+     * built-in send/fill action. Hooks run in plugin priority order.
+     */
+    onSuggestionSelect?: (context: AgentWidgetSuggestionSelectContext) => void | boolean;
     /**
      * Custom renderer for message bubbles
      * Return null to use default renderer
@@ -607,6 +660,14 @@ interface ReasoningBubbleTokens {
 interface ComposerChromeTokens {
     /** Box-shadow on the composer form (raw CSS, e.g. `none`). */
     shadow: string;
+    /** Inner padding of the composer form (raw CSS shorthand). @default "0.75rem 1rem" */
+    padding?: string;
+    /** Gap between the textarea row and the actions row. @default "0.5rem" */
+    gap?: string;
+    /** Composer textarea font-size. @default "0.875rem" */
+    fontSize?: string;
+    /** Composer textarea line-height. @default "1.25rem" */
+    lineHeight?: string;
 }
 /** Artifact toolbar chrome. */
 interface ArtifactToolbarTokens {
@@ -756,6 +817,26 @@ interface ScrollToBottomTokens extends ComponentTokenSet {
     fontSize?: string;
     iconSize?: string;
 }
+/** Visual tokens shared by one suggestion presentation variant. */
+interface SuggestionVariantTokens extends ComponentTokenSet {
+    gap?: string;
+    minHeight?: string;
+    fontSize?: string;
+    lineHeight?: string;
+    iconSize?: string;
+    hoverBackground?: TokenReference<'color'>;
+    hoverForeground?: TokenReference<'color'>;
+    hoverBorder?: TokenReference<'color'>;
+    pressedBackground?: TokenReference<'color'>;
+    focusRing?: TokenReference<'color'>;
+    disabledOpacity?: string;
+}
+/** Starter and follow-up suggestion chrome. */
+interface SuggestionTokens {
+    chip: SuggestionVariantTokens;
+    card: SuggestionVariantTokens;
+    list: SuggestionVariantTokens;
+}
 /** Toggle group chrome (used by createToggleGroup). */
 interface ToggleGroupTokens {
     /** Gap between toggle buttons. Default: 0 (connected). */
@@ -786,6 +867,8 @@ interface ComponentTokens {
     labelButton?: LabelButtonTokens;
     /** Scroll-to-bottom indicator styling tokens. */
     scrollToBottom?: ScrollToBottomTokens;
+    /** Starter prompt and follow-up suggestion styling tokens. */
+    suggestion?: SuggestionTokens;
     /** Toggle group styling tokens. */
     toggleGroup?: ToggleGroupTokens;
     /** Artifact toolbar, tab strip, and pane chrome. */
@@ -1080,7 +1163,24 @@ type RuntypeExecutionStreamEvent = ({
     type: "source";
     url?: string;
     [key: string]: unknown;
+} | {
+    executionId: string;
+    iteration?: number;
+    seq: number;
+    state: Record<string, unknown>;
+    type: "state_snapshot";
 } | ({
+    executionId: string;
+    iteration?: number;
+    patch: Array<{
+        from?: string;
+        op: "add" | "remove" | "replace" | "move" | "copy" | "test";
+        path: string;
+        value?: unknown;
+    }>;
+    seq: number;
+    type: "state_delta";
+}) | ({
     executionId: string;
     hiddenParameterNames?: Array<string>;
     iteration?: number;
@@ -1322,6 +1422,7 @@ declare const LUCIDE_ICONS: {
     readonly plus: IconNode;
     readonly minus: IconNode;
     readonly pencil: IconNode;
+    readonly "pen-line": IconNode;
     readonly trash: IconNode;
     readonly "trash-2": IconNode;
     readonly save: IconNode;
@@ -1364,11 +1465,13 @@ declare const LUCIDE_ICONS: {
     readonly folder: IconNode;
     readonly "folder-open": IconNode;
     readonly files: IconNode;
+    readonly "chart-column": IconNode;
     readonly sparkles: IconNode;
     readonly zap: IconNode;
     readonly sun: IconNode;
     readonly moon: IconNode;
     readonly flag: IconNode;
+    readonly lightbulb: IconNode;
     readonly monitor: IconNode;
     readonly smartphone: IconNode;
 };
@@ -1968,6 +2071,14 @@ type AgentToolsConfig = {
 };
 /** Artifact kinds for the Persona sidebar and dispatch payload */
 type PersonaArtifactKind = "markdown" | "component";
+type PersonaArtifactPresentation = {
+    /**
+     * Producer hint for where this artifact renders (content-disposition
+     * model). Beats configured defaults; loses to explicit `files`/`byKind`
+     * rules. Persona never infers it; the producer or host supplies it.
+     */
+    preferredMode?: PersonaArtifactDisplayModeInput;
+};
 /**
  * Agent configuration for agent execution mode.
  * When provided in the widget config, enables agent loop execution instead of flow dispatch.
@@ -2496,7 +2607,48 @@ type AgentWidgetArtifactsLayoutConfig = {
         jsonPayload: string;
     }) => void | Promise<void>;
 };
-type PersonaArtifactDisplayMode = "card" | "panel" | "inline";
+/**
+ * Where the artifact body renders by default. Every mode shows the compact
+ * reference in the transcript; the mode names where the body goes:
+ * nowhere yet (`collapsed`), the side panel (`panel`), or the conversation
+ * itself (`inline`).
+ */
+type PersonaArtifactDisplayMode = "collapsed" | "panel" | "inline";
+/**
+ * Accepted wherever a display mode is written. `"card"` is a deprecated
+ * alias of `"collapsed"` (the old name described the reference card, which
+ * every mode shows, instead of where the body renders). Resolution and
+ * parsing always canonicalize to `"collapsed"`.
+ */
+type PersonaArtifactDisplayModeInput = PersonaArtifactDisplayMode | "card";
+/**
+ * Display rules for file-backed artifacts. `byMediaType` keys are exact MIME
+ * types (`"text/html"`) or major-type wildcards (`"image/*"`), matched
+ * case-insensitively without parameters; exact beats wildcard.
+ */
+type PersonaArtifactFilesDisplayRules = {
+    default?: PersonaArtifactDisplayModeInput;
+    byMediaType?: Record<string, PersonaArtifactDisplayModeInput>;
+};
+/**
+ * Scoped artifact display rules. Matching resolves from the most specific
+ * selector to `default`; see `resolveArtifactDisplay`.
+ *
+ * Across preference layers, one merge rule applies everywhere: a string value
+ * replaces the whole subtree it names; an object refines it per key. So
+ * `files: "inline"` overrides every lower-layer file rule, while
+ * `files: { default: "inline" }` keeps lower-layer MIME exceptions.
+ */
+type PersonaArtifactDisplayRules = {
+    default?: PersonaArtifactDisplayModeInput;
+    byKind?: Partial<Record<PersonaArtifactKind, PersonaArtifactDisplayModeInput>>;
+    /**
+     * @deprecated Use `byKind`. When both are present, `byKind` wins.
+     */
+    byType?: Partial<Record<PersonaArtifactKind, PersonaArtifactDisplayModeInput>>;
+    /** Rules for any artifact carrying file metadata. */
+    files?: PersonaArtifactDisplayModeInput | PersonaArtifactFilesDisplayRules;
+};
 /** Context handed to custom artifact actions. Content fields are best-effort: resolved from live session state or, after a refresh, from the persisted reference-card payload. */
 type PersonaArtifactActionContext = {
     artifactId: string | null;
@@ -2553,13 +2705,10 @@ type AgentWidgetArtifactsFeature = {
     allowedTypes?: PersonaArtifactKind[];
     /**
      * Where artifact bodies render. A single mode applies to all artifacts;
-     * the object form sets a default plus per-type overrides.
+     * the object form sets a default plus scoped overrides.
      * Defaults to "panel" (current behavior).
      */
-    display?: PersonaArtifactDisplayMode | {
-        default?: PersonaArtifactDisplayMode;
-        byType?: Partial<Record<PersonaArtifactKind, PersonaArtifactDisplayMode>>;
-    };
+    display?: PersonaArtifactDisplayModeInput | PersonaArtifactDisplayRules;
     /** Split / drawer dimensions and launcher widen behavior */
     layout?: AgentWidgetArtifactsLayoutConfig;
     /**
@@ -3281,19 +3430,58 @@ type AgentWidgetFeatureFlags = {
      */
     askUserQuestion?: AgentWidgetAskUserQuestionFeature;
     /**
-     * Built-in `suggest_replies` quick-reply chips. When the assistant invokes
-     * the tool, the widget shows the suggestions as tappable chips above the
-     * composer (reusing the suggestion-chips surface) and immediately resumes
-     * the execution: fire-and-forget, no user input awaited.
+     * Built-in `suggest_replies` follow-ups. When the assistant invokes the
+     * tool, the widget shows the suggestions using `suggestions.followUps` and
+     * immediately resumes the execution: fire-and-forget, no user input awaited.
+     *
+     * @deprecated Both keys moved to `suggestions.followUps`: use
+     * `suggestions.followUps.enabled` and `suggestions.followUps.expose`. This
+     * alias keeps working per key, with `suggestions.followUps` winning.
      */
     suggestReplies?: AgentWidgetSuggestRepliesFeature;
 };
 /**
- * Feature config for the built-in `suggest_replies` quick-reply chips.
- * Chips render in the existing suggestions slot above the composer and are
- * styled by the widget-level `suggestionChipsConfig`. A tapped chip is sent
- * verbatim as the user's next message; chips clear once any user message
- * follows them.
+ * Persistable artifact-layout choices. The full layout config deliberately is
+ * not exposed because it also contains callbacks and embedder-owned chrome.
+ */
+type WidgetArtifactLayoutPreference = Pick<AgentWidgetArtifactsLayoutConfig, "paneWidth" | "paneMaxWidth" | "paneMinWidth" | "expandLauncherPanelWhenOpen" | "expandedPanelWidth" | "resizable" | "resizableMinWidth" | "resizableMaxWidth">;
+/**
+ * Curated, JSON-serializable display preferences in native `features` shape.
+ *
+ * Absence means inherit the next preference layer and ultimately Persona's
+ * current default. Persist only explicit choices; resetting a choice deletes
+ * its key.
+ *
+ * Capability facts (`artifacts.enabled`, `allowedTypes`), trusted iframe
+ * security, callbacks, actions, renderers, labels, and theme styling are
+ * intentionally excluded because they remain embedder/code-owned.
+ */
+type WidgetPreferenceSlice = {
+    showToolCalls?: boolean;
+    showReasoning?: boolean;
+    toolCallDisplay?: Pick<AgentWidgetToolCallDisplayFeature, "collapsedMode" | "expandable" | "grouped" | "groupedMode" | "loadingAnimation">;
+    reasoningDisplay?: Pick<AgentWidgetReasoningDisplayFeature, "expandable" | "activePreview">;
+    artifacts?: {
+        /**
+         * String and object forms are both persistable and mean different things
+         * when layers merge: a string replaces every lower-layer display rule; an
+         * object refines lower layers per selector key (same rule applies to
+         * `display.files`).
+         */
+        display?: PersonaArtifactDisplayModeInput | PersonaArtifactDisplayRules;
+        filePreview?: {
+            enabled?: boolean;
+        };
+        layout?: WidgetArtifactLayoutPreference;
+    };
+};
+/**
+ * Feature config for the built-in `suggest_replies` follow-ups.
+ *
+ * @deprecated Both keys moved to `suggestions.followUps`
+ * (`suggestions.followUps.enabled` / `suggestions.followUps.expose`), which
+ * also owns presentation, placement, and send/fill behavior. Resolution is
+ * per key with `suggestions.followUps` winning; removal waits for 5.0.
  */
 type AgentWidgetSuggestRepliesFeature = {
     /**
@@ -3301,14 +3489,18 @@ type AgentWidgetSuggestRepliesFeature = {
      * renders as a regular tool bubble and is NOT auto-resumed: only set this
      * with no server-side `suggest_replies` declaration, or the execution
      * parks awaiting a resume that never comes.
+     * @deprecated Use `suggestions.followUps.enabled`.
      */
     enabled?: boolean;
     /**
      * Advertise the built-in `suggest_replies` tool to the agent on every
      * dispatch via `clientTools[]`: no server-side `runtimeTools` declaration
-     * needed. Defaults to `false`: flows that already declare the tool via
-     * `runtimeTools` would otherwise present it to the model twice. Ignored
-     * when `enabled` is `false`.
+     * needed. Defaults to `false`. Declare the tool in one place: the API
+     * dedupes a double declaration by name with `clientTools[]` winning, so the
+     * model still sees exactly one tool, but the widget's description and schema
+     * win and the effective tool type becomes `local` (the execution pauses and
+     * the widget auto-resumes it). Ignored when `enabled` is `false`.
+     * @deprecated Use `suggestions.followUps.expose`.
      */
     expose?: boolean;
 };
@@ -3378,10 +3570,13 @@ type AgentWidgetAskUserQuestionFeature = {
      * matching {@link AskUserQuestionPayload}; when the model calls it, the
      * existing answer-pill sheet renders and the answer resumes the execution.
      *
-     * Defaults to `false`: flows that already declare `ask_user_question` via
-     * `runtimeTools` would otherwise present the tool to the model twice.
-     * Ignored when `enabled` is `false`: never offer the agent a question
-     * tool the widget can't render an answer UI for.
+     * Defaults to `false`. Declare the tool in one place: the API dedupes a
+     * double declaration by name with `clientTools[]` winning, so the model
+     * still sees exactly one tool, but the widget's description and schema win
+     * and the effective tool type becomes `local` (the execution pauses and the
+     * widget resumes it with the user's answer). Ignored when `enabled` is
+     * `false`: never offer the agent a question tool the widget can't render an
+     * answer UI for.
      */
     expose?: boolean;
     /** Slide-in animation duration in ms. Defaults to 180. */
@@ -3854,6 +4049,10 @@ type AgentWidgetSendButtonConfig = {
     paddingY?: string;
     iconText?: string;
     iconName?: string;
+    /** Icon glyph box in icon mode, e.g. "20px". Defaults to half of `size`. */
+    iconSize?: string;
+    /** Stroke width for the icon glyph, in viewBox units. Default 2. */
+    iconStrokeWidth?: number;
     useIcon?: boolean;
     tooltipText?: string;
     showTooltip?: boolean;
@@ -4577,6 +4776,109 @@ type AgentWidgetSuggestionChipsConfig = {
     paddingX?: string;
     paddingY?: string;
 };
+/** A suggested next action shown to the user. Strings remain supported as shorthand. */
+type AgentWidgetSuggestion = string | {
+    /** Stable analytics / DOM identity. Falls back to the prompt or label. */
+    id?: string;
+    /** Concise visible action label. */
+    label: string;
+    /** Text placed in the composer or sent. Defaults to `label`. */
+    prompt?: string;
+    /** Optional supporting copy, most useful with the `card` variant. */
+    description?: string;
+    /** Optional icon from Persona's bundled Lucide registry. */
+    icon?: IconName;
+    /**
+     * CSS color for this item's glyph. Tints the icon only: label, border,
+     * and background stay neutral. Ignored without an `icon`.
+     */
+    iconColor?: string;
+    /** Override the surface's click behavior for this item. */
+    behavior?: AgentWidgetSuggestionBehavior;
+    /** Visually promote one high-confidence action. */
+    emphasis?: "default" | "primary";
+};
+type AgentWidgetSuggestionBehavior = "send" | "fill";
+type AgentWidgetSuggestionVariant = "chip" | "card" | "list";
+type AgentWidgetSuggestionSurface = "starter" | "followUp";
+/**
+ * Who produced the rendered suggestions: static config, the agent's
+ * `suggest_replies` tool, or `controller.setFollowUpSuggestions`.
+ */
+type AgentWidgetSuggestionSource = "config" | "agent" | "host";
+/**
+ * A suggestion after Persona has normalized shorthand strings and resolved the
+ * effective click behavior. Plugin hooks receive this stable shape.
+ */
+type AgentWidgetResolvedSuggestion = {
+    id: string;
+    label: string;
+    prompt: string;
+    description?: string;
+    icon?: IconName;
+    /** CSS color for the glyph only; never the label, border, or background. */
+    iconColor?: string;
+    behavior: AgentWidgetSuggestionBehavior;
+    emphasis: "default" | "primary";
+};
+/** Presentation keys shared by every suggestion surface. */
+type AgentWidgetSuggestionSurfaceConfig = {
+    /** Item density. Defaults to `card` for starters and `chip` for follow-ups. */
+    variant?: AgentWidgetSuggestionVariant;
+    /** Default click behavior, overridable per item. Defaults to `send`. */
+    behavior?: AgentWidgetSuggestionBehavior;
+    /**
+     * Layout for items past the surface width. Defaults to `wrap` for starters
+     * and `scroll` for follow-ups. Applies to the `chip` variant only; the
+     * `card` and `list` layouts manage their own stacking.
+     */
+    overflow?: "scroll" | "wrap";
+    /** Maximum visible items. Defaults to 4. */
+    maxItems?: number;
+};
+type AgentWidgetStarterSuggestionsConfig = AgentWidgetSuggestionSurfaceConfig & {
+    /** Suggestions shown before the first user message. */
+    items?: AgentWidgetSuggestion[];
+    /**
+     * `auto` uses the welcome surface when the welcome card renders and the
+     * composer otherwise. Explicit values are literal: `welcome` renders
+     * nothing when the welcome card is hidden. Defaults to `auto`.
+     */
+    placement?: "auto" | "welcome" | "composer";
+};
+type AgentWidgetFollowUpSuggestionsConfig = AgentWidgetSuggestionSurfaceConfig & {
+    /**
+     * Enable the built-in `suggest_replies` follow-ups. Defaults to true. When
+     * false, `suggest_replies` renders as a regular tool bubble and is NOT
+     * auto-resumed: only set this with no server-side `suggest_replies`
+     * declaration, or the execution parks awaiting a resume that never comes.
+     */
+    enabled?: boolean;
+    /**
+     * Advertise the built-in `suggest_replies` tool to the agent on every
+     * dispatch via `clientTools[]`: no server-side `runtimeTools` declaration
+     * needed. Defaults to `false`. Declare the tool in one place: the API
+     * dedupes a double declaration by name with `clientTools[]` winning, so
+     * the model still sees exactly one tool, but the widget's description and
+     * schema win and the effective tool type becomes `local` (the execution
+     * pauses and the widget auto-resumes it). Ignored when `enabled` is
+     * `false`.
+     */
+    expose?: boolean;
+    /**
+     * `auto` places follow-ups after the transcript in regular panels and above
+     * the composer in composer-bar mode. Defaults to `auto`.
+     */
+    placement?: "auto" | "after-message" | "composer";
+};
+/**
+ * Structured suggestions configuration. The legacy `suggestionChips` and
+ * `suggestionChipsConfig` fields remain supported for backwards compatibility.
+ */
+type AgentWidgetSuggestionsConfig = {
+    starters?: AgentWidgetStarterSuggestionsConfig;
+    followUps?: AgentWidgetFollowUpSuggestionsConfig;
+};
 /**
  * Interface for pluggable stream parsers that extract text from streaming responses.
  * Parsers handle incremental parsing to extract text values from structured formats (JSON, XML, etc.).
@@ -5729,6 +6031,15 @@ type AgentWidgetConfig = {
      */
     colorScheme?: 'auto' | 'light' | 'dark';
     features?: AgentWidgetFeatureFlags;
+    /**
+     * Per-instance display overrides, applied over `features` through the
+     * preference allowlist (security/capability keys cannot pass). String
+     * `display` values replace the base rule subtree; objects refine it per
+     * key. Each `controller.update({ preferences })` replaces the previous
+     * slice wholesale (dropped keys revert to the base `features`); an
+     * explicit-undefined patch clears it entirely.
+     */
+    preferences?: WidgetPreferenceSlice;
     /**
      * When true, focus the chat input after the panel opens and the open animation completes.
      * Applies to launcher mode (user click, controller.open(), autoExpand) and inline mode (on init).
@@ -5749,7 +6060,11 @@ type AgentWidgetConfig = {
      * with `initialArtifacts`.
      */
     initialSelectedArtifactId?: string | null;
+    /** Rich starter and follow-up suggestion surfaces. */
+    suggestions?: AgentWidgetSuggestionsConfig;
+    /** @deprecated Prefer `suggestions.starters.items`. */
     suggestionChips?: string[];
+    /** @deprecated Prefer semantic tokens under `theme.components.suggestion`. */
     suggestionChipsConfig?: AgentWidgetSuggestionChipsConfig;
     debug?: boolean;
     formEndpoint?: string;
@@ -6489,6 +6804,8 @@ type PersonaArtifactRecord = {
     props?: Record<string, unknown>;
     /** Present when this markdown artifact is a previewable file (see PersonaArtifactFileMeta). */
     file?: PersonaArtifactFileMeta;
+    /** Optional presentation metadata such as the producer's display-mode hint. */
+    presentation?: PersonaArtifactPresentation;
 };
 
 /** The resolved bundle gathered at submit, merged into the user message. */