@superatomai/sdk-node 0.0.43-mds → 0.0.44-dsp

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,15 +1,981 @@
1
1
  import { z } from 'zod';
2
2
  import Anthropic from '@anthropic-ai/sdk';
3
3
 
4
+ /**
5
+ * Script Flow Types
6
+ *
7
+ * Defines interfaces for the script-based query architecture:
8
+ * - ScriptRecipe: metadata for matching, validation, and quality tracking
9
+ * - ScriptResult: output from executing a script
10
+ * - ScriptMatch: result from the LLM-based script matcher
11
+ */
12
+
13
+ /**
14
+ * Recipe metadata stored alongside each script.
15
+ * Used for matching, validation, and quality tracking.
16
+ */
17
+ interface ScriptRecipe {
18
+ /** Unique script identifier */
19
+ id: string;
20
+ /** Version number (incremented on regeneration) */
21
+ version: number;
22
+ /** Human-readable name (e.g., "Revenue by Dimension") */
23
+ name: string;
24
+ /** Natural language description of what this script does */
25
+ intentDescription: string;
26
+ /** Keyword tags for quick filtering */
27
+ tags: string[];
28
+ /** Source tool IDs this script queries (e.g., ["mssql-abc123_query"]) */
29
+ sourceIds: string[];
30
+ /** Table names used (for future schema drift detection) */
31
+ tables: string[];
32
+ /** Parameter definitions — what can vary */
33
+ parameters: ScriptParameter[];
34
+ /** The script function body as a string. Loaded from disk (scripts-store/<fileBase>.ts). */
35
+ scriptBody: string;
36
+ /**
37
+ * On-disk filename stem for the body: scripts-store/<fileBase>.ts.
38
+ * Editable in the IDE. Decided at authoring time (slug of `name`, with a
39
+ * short id suffix on collision) and stable across promotion.
40
+ */
41
+ fileBase?: string;
42
+ /** sha256 of the on-disk body — lets the runtime detect manual edits. */
43
+ bodyHash?: string;
44
+ /** Project scope (single-VM deployments may leave this undefined). */
45
+ projectId?: string;
46
+ /** Times this script was used successfully */
47
+ successCount: number;
48
+ /** Times this script failed */
49
+ failureCount: number;
50
+ /** ISO timestamp of last usage */
51
+ lastUsed: string;
52
+ /** Original user question that created this script */
53
+ createdFrom: string;
54
+ /** ISO timestamp */
55
+ createdAt: string;
56
+ /** ISO timestamp */
57
+ updatedAt: string;
58
+ /**
59
+ * `recipe.id` of the parent this script was forked from.
60
+ * Undefined for root scripts (those written from scratch by MainAgent).
61
+ * See backend/docs/SCRIPT-FLOW-FORK-ADAPT.md.
62
+ */
63
+ parentId?: string;
64
+ /** 0 for root scripts; `parent.forkDepth + 1` for forks. Capped at 3. */
65
+ forkDepth?: number;
66
+ /**
67
+ * Brief description of what this fork changed vs its parent
68
+ * (sourced from the matcher's `modificationHint`).
69
+ */
70
+ forkReason?: string;
71
+ /**
72
+ * Validated component specs captured at authoring time. On a tier-high
73
+ * replay these are rebound to fresh queryIds deterministically — no
74
+ * component-generation LLM call, and the rendered columns can't drift from
75
+ * what was validated when the script was authored. Absent on recipes
76
+ * authored before this landed; those fall back to LLM component generation.
77
+ * See backend/docs/SCRIPT-COMPONENT-CONSISTENCY.md.
78
+ */
79
+ components?: ScriptComponentSpec[];
80
+ /**
81
+ * What the user explicitly asked the output to LOOK like, set by a display
82
+ * edit ("show that as a bar chart", "make the bars horizontal").
83
+ *
84
+ * Deliberately SEPARATE from `components`. Those are validated bindings that
85
+ * must be cleared on a data edit — after "break it down by brand" the axis
86
+ * keys are wrong, and after "use the mode" the stored title still says
87
+ * "Average…". A rendering CHOICE, by contrast, is still valid afterwards.
88
+ * Keeping them in one field meant every data edit silently discarded the
89
+ * user's chart type.
90
+ *
91
+ * Fed to the component generator as a hint whenever specs are (re)generated,
92
+ * so the chosen rendering comes back even after the SQL changes.
93
+ */
94
+ displayPreference?: ScriptDisplayPreference;
95
+ /**
96
+ * Lifecycle stage of this recipe on disk.
97
+ * - 'draft': written by MainAgent's write_script during a turn; filtered out
98
+ * of FTS results (status='verified' only) so the matcher never picks it.
99
+ * Filename is suffixed with `turnId` to keep concurrent turns
100
+ * from clobbering each other's drafts.
101
+ * - 'verified': promoted after `execute_script` succeeded; the matcher sees it.
102
+ * Filename drops the turn suffix unless a verified file with
103
+ * the same slug already exists (collision case keeps the suffix).
104
+ *
105
+ * Recipes loaded from disk without this field default to 'verified' so
106
+ * existing scripts keep working unchanged.
107
+ */
108
+ status?: 'draft' | 'verified';
109
+ /**
110
+ * Per-turn unique suffix used for draft filenames (e.g. `1714745623-x9k2`).
111
+ * Set when the draft is saved; carried until the recipe is promoted.
112
+ */
113
+ turnId?: string;
114
+ /**
115
+ * Last execution error captured by `recordDraftError` while the recipe was
116
+ * still a draft. Lets users open the draft .json file and see why it failed
117
+ * without grepping logs. Cleared on promotion to 'verified'.
118
+ */
119
+ lastError?: {
120
+ phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
121
+ message: string;
122
+ at: string;
123
+ attempt: number;
124
+ };
125
+ /** userId who committed the most recent edit (audit trail — recipes are project-scoped). */
126
+ editedBy?: string;
127
+ /** The instruction that produced the current version. */
128
+ editedFrom?: string;
129
+ /**
130
+ * Prior versions, newest last. The body itself is archived on disk as
131
+ * `<fileBase>.v<version>.ts`; this records what changed and who did it.
132
+ */
133
+ history?: ScriptVersionRecord[];
134
+ }
135
+ /**
136
+ * A durable, user-stated rendering choice for a recipe. Survives data edits.
137
+ */
138
+ interface ScriptDisplayPreference {
139
+ /** Component types the user's chosen rendering resolved to, e.g. ["DynamicBarChart"]. */
140
+ componentTypes: string[];
141
+ /** The instruction itself — carries nuance the types can't ("horizontal", "sorted descending"). */
142
+ instruction: string;
143
+ /** ISO timestamp of the display edit that set this. */
144
+ at: string;
145
+ }
146
+ /** One superseded version of a recipe body (see ScriptStore.commitEdit). */
147
+ interface ScriptVersionRecord {
148
+ /** Version number this record superseded (i.e. the OLD version). */
149
+ version: number;
150
+ /** ISO timestamp of the edit that superseded it. */
151
+ at: string;
152
+ /** userId who made the edit, when known. */
153
+ by?: string;
154
+ /** The edit instruction that caused the supersede. */
155
+ instruction?: string;
156
+ /** One-line summary of what changed, for the version picker. */
157
+ changeSummary?: string;
158
+ /** sha256 of the superseded body — pairs with `<fileBase>.v<version>.ts`. */
159
+ bodyHash?: string;
160
+ }
161
+ interface ScriptParameter {
162
+ /** Parameter name (used in script body as params.name) */
163
+ name: string;
164
+ /** Parameter type */
165
+ type: 'string' | 'number' | 'date' | 'date_range' | 'enum' | 'boolean';
166
+ /** Whether this parameter is required */
167
+ required: boolean;
168
+ /** Default value if not provided */
169
+ default?: any;
170
+ /** For enum type — maps user-facing values to internal values */
171
+ enumValues?: Record<string, string>;
172
+ /** Human-readable description (used in the matcher LLM prompt) */
173
+ description: string;
174
+ }
175
+ /**
176
+ * A reusable component binding captured when a script is authored. Stored on
177
+ * the recipe so tier-high replays rebuild components deterministically (rebind
178
+ * to fresh queryIds) instead of re-running the component-picker LLM.
179
+ */
180
+ interface ScriptComponentSpec {
181
+ /** Registered component name (e.g. "DynamicBarChart") — matched against the available component library. */
182
+ componentType: string;
183
+ /** `executedQuery.sourceId` to bind to (e.g. a tool id or 'computed:_final'), 'federation' for a cross-source component, or 'markdown' for a content-only narrative block (no data source). */
184
+ sourceRef: string;
185
+ /** Present only when sourceRef === 'federation' — the DuckDB SQL to re-execute on replay. */
186
+ federationSql?: string;
187
+ /** Present only when sourceRef === 'markdown' — the narrative text to render on replay (markdown has no data source, so its content must be persisted). */
188
+ content?: string;
189
+ title?: string;
190
+ description?: string;
191
+ /** Validated axis/value keys + aggregation — all referencing real columns of the bound source. */
192
+ config: Record<string, any>;
193
+ }
194
+ /**
195
+ * Result from executing a script via ScriptRunner.
196
+ */
197
+ interface ScriptResult {
198
+ /** Whether the script executed successfully */
199
+ success: boolean;
200
+ /** Combined data from all queries */
201
+ data: any[];
202
+ /** Program-generated narrative, when the script exports getAnalysis. */
203
+ analysis?: AnalysisOutput;
204
+ /**
205
+ * getAnalysis threw. `success` stays true — the data is valid, so the caller
206
+ * falls back to LLM prose rather than losing the answer.
207
+ */
208
+ analysisError?: string;
209
+ /** Program-generated component specs, when the script exports getComponents. */
210
+ components?: ScriptComponentSpec[];
211
+ /**
212
+ * getComponents threw or returned a non-array. `success` stays true — the data
213
+ * is valid, so the caller falls back to the recipe's stored specs and then to
214
+ * LLM generation rather than losing the dashboard.
215
+ */
216
+ componentsError?: string;
217
+ /** Individual query results tracked during execution */
218
+ executedQueries: ScriptQueryResult[];
219
+ /** Error message if failed */
220
+ error?: string;
221
+ /**
222
+ * Where in the lifecycle the error occurred. Lets MainAgent's fix-loop
223
+ * decide between "rewrite the whole draft" (compile) and "patch the
224
+ * specific line" (runtime).
225
+ */
226
+ errorPhase?: 'compile' | 'runtime' | 'timeout' | 'ipc';
227
+ /** Total execution time in milliseconds */
228
+ executionTimeMs: number;
229
+ }
230
+ /**
231
+ * A single query executed during script runtime.
232
+ * Tracked by ScriptContext for component generation and debugging.
233
+ */
234
+ interface ScriptQueryResult {
235
+ /** Source tool ID */
236
+ sourceId: string;
237
+ /** Human-readable source name */
238
+ sourceName: string;
239
+ /** The SQL that was executed */
240
+ sql: string;
241
+ /** Result data rows */
242
+ data: any[];
243
+ /** Number of rows returned */
244
+ count: number;
245
+ /** Total rows that matched before limit (if available) */
246
+ totalCount?: number;
247
+ /** Query execution time in milliseconds */
248
+ executionTimeMs: number;
249
+ /**
250
+ * True for rows that did NOT come from a real SQL execution — either a
251
+ * ctx.emit() dataset or the synthesized "computed:_final" entry that
252
+ * carries the script's post-JS returned data. The component generator
253
+ * uses this to route the resulting component through the script_dataset
254
+ * sentinel toolId so the frontend resolves it via the queryCache short-circuit.
255
+ */
256
+ virtual?: boolean;
257
+ }
258
+ /**
259
+ * Match tier returned by the LLM script matcher.
260
+ *
261
+ * - 'high': the script answers the question directly; only parameter values
262
+ * may differ. The runtime replays it with extracted params (cheapest path).
263
+ * - 'near': the script answers a STRUCTURALLY similar question but needs
264
+ * body modification (different metric, dimension, table, filter shape).
265
+ * The runtime forks the parent and adapts the body via MainAgent's normal
266
+ * write_script + execute_script loop — no SourceAgent dispatch needed.
267
+ * See backend/docs/SCRIPT-FLOW-FORK-ADAPT.md for the full design.
268
+ * - 'edit': the user is INSTRUCTING a change to the script that produced the
269
+ * previous answer (not asking a new question). Only reachable when the turn
270
+ * carries a ScriptBinding — without one the matcher coerces it to 'none', so
271
+ * a prompt regression can't turn this into a loose similarity path. The
272
+ * runtime runs MainAgent in edit mode and commits the result in place.
273
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md.
274
+ * - 'none': no script is relevant; full agent flow runs.
275
+ */
276
+ type MatchTier = 'high' | 'near' | 'edit' | 'none';
277
+ /**
278
+ * Which recipe produced the answer the user is currently looking at.
279
+ *
280
+ * Set whenever a turn's answer came from a script (replay, fresh authoring, or
281
+ * a committed edit) and carried on the UIBlock + saved conversation row. Two
282
+ * consumers:
283
+ * 1. The matcher — the 'edit' tier is ONLY reachable when a binding exists, so
284
+ * "use mode instead of mean" resolves to a concrete script instead of being
285
+ * matched on keywords it shares with no script name.
286
+ * 2. Cache invalidation — after an edit commits, conversations bound to that
287
+ * recipeId must be dropped, or the exact-match cache replays the pre-edit
288
+ * answer and the edit looks like a no-op.
289
+ *
290
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 1.
291
+ */
292
+ interface ScriptBinding {
293
+ recipeId: string;
294
+ /** Params the script ran with — the edit's starting point. */
295
+ params: Record<string, any>;
296
+ /** Recipe name at bind time (matcher catalog + user-facing confirmation). */
297
+ name: string;
298
+ /** Columns the last run returned — grounds the editor without a re-query. */
299
+ columns?: string[];
300
+ /**
301
+ * The question that produced this answer. Required for disambiguation when a
302
+ * thread ran several scripts — without it the candidates are just names and
303
+ * the matcher cannot resolve "use the mode for the WSP one".
304
+ */
305
+ userPrompt?: string;
306
+ }
307
+ /**
308
+ * Result from the LLM-based script matcher.
309
+ *
310
+ * For `tier: 'high'`, `extractedParams` carries the values to pass to the
311
+ * existing script. For `tier: 'near'`, `gaps` and `modificationHint` describe
312
+ * what the fork-author needs to change in the parent body.
313
+ */
314
+ interface ScriptMatch {
315
+ /** The matched script recipe */
316
+ recipe: ScriptRecipe;
317
+ /** Match tier — see MatchTier docs */
318
+ tier: MatchTier;
319
+ /** Similarity score (0-1, derived from LLM tier) */
320
+ similarity: number;
321
+ /**
322
+ * Legacy confidence level. Mirrors `tier === 'high'`/`'near'` for now;
323
+ * kept so existing callers compile while we migrate to tier-based logic.
324
+ */
325
+ confidence: 'high' | 'medium';
326
+ /** Parameters extracted from the user question by the LLM (tier='high') */
327
+ extractedParams?: Record<string, any>;
328
+ /**
329
+ * Proper nouns the question named, VERBATIM, with the parameter each fills.
330
+ *
331
+ * The matcher must NOT resolve these itself. Observed live: it substituted the
332
+ * customer name "PREMER ENRGES PHOTOOTAIC" into an id parameter believing that
333
+ * "the runtime will resolve the customer name to its PartyId(s)" — nothing on
334
+ * the replay path does, and `WHERE BillingPartyId IN (PREMER ENRGES
335
+ * PHOTOOTAIC)` reached SQL. Reported here, the runtime resolves them before
336
+ * replay and rejects the match when one cannot be resolved.
337
+ */
338
+ mentions?: Array<{
339
+ text: string;
340
+ param?: string;
341
+ }>;
342
+ /** Business concepts the question relies on (e.g. "outstanding balance"). */
343
+ entityTypes?: string[];
344
+ /** What the user question needs that the parent doesn't cover (tier='near') */
345
+ gaps?: string[];
346
+ /** One-sentence description of the change the fork-author should make (tier='near') */
347
+ modificationHint?: string;
348
+ /**
349
+ * Which HALF of the recipe the edit targets (tier='edit'). A recipe has two
350
+ * independently editable halves:
351
+ * - 'data' — the scriptBody: how the rows are produced (aggregation,
352
+ * filters, joins, grouping). Runs MainAgent in edit mode.
353
+ * - 'display' — the component specs: how those SAME rows are shown (chart
354
+ * type, orientation, columns, labels). Replays the proven SQL
355
+ * and regenerates the specs — never authors a script.
356
+ * Defaults to 'data' when the matcher omits it.
357
+ */
358
+ editTarget?: 'data' | 'display';
359
+ /**
360
+ * Self-contained restatement of the change the user asked for (tier='edit').
361
+ * MUST have pronouns/deixis resolved ("this", "it", "that column") — the edit
362
+ * prompt never sees the conversation history, so an unresolved instruction is
363
+ * unusable downstream.
364
+ */
365
+ editInstruction?: string;
366
+ /** Why the matcher made this choice (for logs and telemetry) */
367
+ reasoning?: string;
368
+ }
369
+
370
+ /**
371
+ * script-ipc.ts — Protocol definitions for parent/child IPC.
372
+ *
373
+ * Transport: newline-delimited JSON over the child's stdin/stdout.
374
+ * stderr is passed through for uncaught exceptions and compile errors.
375
+ *
376
+ * See backend/docs/SCRIPT-FLOW-IMPLEMENTATION.md § IPC Bridge.
377
+ */
378
+
379
+ /**
380
+ * What getAnalysis returns. `analysis` is the narrative and `summary` the short
381
+ * bullets the markdown block binds to — siblings over one dataset, never a
382
+ * summary OF the narrative. See backend/docs/ANALYSIS-AS-PROGRAM-DESIGN.md § 4.3.
383
+ */
384
+ interface AnalysisOutput {
385
+ analysis?: string;
386
+ summary?: string[];
387
+ method?: string;
388
+ }
389
+
390
+ /**
391
+ * StreamBuffer - Buffered streaming utility for smoother text delivery
392
+ * Batches small chunks together and flushes at regular intervals
393
+ */
394
+ type StreamCallback = (chunk: string) => void;
395
+ /**
396
+ * StreamBuffer class for managing buffered streaming output
397
+ * Provides smooth text delivery by batching small chunks
398
+ */
399
+ declare class StreamBuffer {
400
+ private buffer;
401
+ private flushTimer;
402
+ private callback;
403
+ private fullText;
404
+ constructor(callback?: StreamCallback);
405
+ /**
406
+ * Check if the buffer has a callback configured
407
+ */
408
+ hasCallback(): boolean;
409
+ /**
410
+ * Get all text that has been written (including already flushed)
411
+ */
412
+ getFullText(): string;
413
+ /**
414
+ * Write a chunk to the buffer
415
+ * Large chunks or chunks with newlines are flushed immediately
416
+ * Small chunks are batched and flushed after a short interval
417
+ *
418
+ * @param chunk - Text chunk to write
419
+ */
420
+ write(chunk: string): void;
421
+ /**
422
+ * Flush the buffer immediately
423
+ * Call this before tool execution or other operations that need clean output
424
+ */
425
+ flush(): void;
426
+ /**
427
+ * Internal flush implementation
428
+ */
429
+ private flushNow;
430
+ /**
431
+ * Clean up resources
432
+ * Call this when done with the buffer
433
+ */
434
+ dispose(): void;
435
+ }
436
+
437
+ /**
438
+ * ToolExecutorService - Handles execution of SQL queries and external tools
439
+ * Extracted from BaseLLM.generateTextResponse for better separation of concerns
440
+ */
441
+
442
+ /**
443
+ * External tool definition
444
+ */
445
+ interface ExternalTool {
446
+ id: string;
447
+ name: string;
448
+ description?: string;
449
+ /** Tool type: "source" = routed through SourceAgent, "direct" = called directly by MainAgent */
450
+ toolType?: 'source' | 'direct';
451
+ /** Full untruncated schema for source agent (all columns visible) */
452
+ fullSchema?: string;
453
+ /** Schema size tier: small (≤50 tables), medium (51-200), large (201-500), very_large (500+) */
454
+ schemaTier?: string;
455
+ /** Schema search function for very_large tier — keyword search over entities */
456
+ schemaSearchFn?: (keywords: string[]) => string;
457
+ /** `signal` fires when the user hits Stop mid-query — passed through to the backend's SourceTool.fn. */
458
+ fn: (input: any, signal?: AbortSignal) => Promise<any>;
459
+ limit?: number;
460
+ outputSchema?: any;
461
+ executionType?: 'immediate' | 'deferred';
462
+ userProvidedData?: any;
463
+ params?: Record<string, any>;
464
+ }
465
+ /**
466
+ * Executed tool tracking info
467
+ */
468
+ interface ExecutedToolInfo {
469
+ id: string;
470
+ name: string;
471
+ params: any;
472
+ result: {
473
+ _totalRecords: number;
474
+ _recordsShown: number;
475
+ _metadata?: any;
476
+ _sampleData: any[];
477
+ /** Bounded summary over the FULL fetched result (complete structure). */
478
+ _summary?: any;
479
+ /** Up to MAIN_AGENT_COMPLETE_ROWS rows — the complete result when small. */
480
+ _mainAgentRows?: any[];
481
+ };
482
+ outputSchema?: any;
483
+ sourceSchema?: string;
484
+ sourceType?: string;
485
+ }
486
+
487
+ /**
488
+ * Multi-Agent Architecture Types
489
+ *
490
+ * Defines interfaces for the hierarchical agent system:
491
+ * - Main Agent: ONE LLM.streamWithTools() call with source agent tools
492
+ * - Source Agents: independent agents that query individual data sources
493
+ *
494
+ * The main agent sees only source summaries. When it calls a source tool,
495
+ * the SourceAgent runs independently (own LLM, own retries) and returns clean data.
496
+ */
497
+
498
+ /**
499
+ * Per-entity detail: name, row count, and column names.
500
+ * Gives the main agent enough context to route to the right source.
501
+ */
502
+ interface EntityDetail {
503
+ /** Entity name (table, sheet, endpoint) */
504
+ name: string;
505
+ /** Approximate row count */
506
+ rowCount?: number;
507
+ /** Column/field names */
508
+ columns: string[];
509
+ /** Entity-level semantic summary (what the table means) — for main-agent routing. */
510
+ summary?: string;
511
+ }
512
+ /**
513
+ * Representation of a data source for the main agent.
514
+ * Contains entity names WITH column names so the LLM can route accurately.
515
+ */
516
+ interface SourceSummary {
517
+ /** Source ID (matches tool ID prefix) */
518
+ id: string;
519
+ /** Human-readable source name */
520
+ name: string;
521
+ /** Source type: postgres, excel, rest_api, etc. */
522
+ type: string;
523
+ /** Brief description of what data this source contains */
524
+ description: string;
525
+ /** Detailed entity info with column names for routing */
526
+ entityDetails: EntityDetail[];
527
+ /** The tool ID associated with this source */
528
+ toolId: string;
529
+ }
530
+ /**
531
+ * What a source agent returns after querying its data source.
532
+ * The main agent uses this to analyze and compose the final response.
533
+ */
534
+ interface SourceAgentResult {
535
+ /** Source ID */
536
+ sourceId: string;
537
+ /** Source name */
538
+ sourceName: string;
539
+ /** Whether the query succeeded */
540
+ success: boolean;
541
+ /** Result data rows */
542
+ data: any[];
543
+ /** Metadata about the query execution */
544
+ metadata: SourceAgentMetadata;
545
+ /** Tool execution info for the last successful query (backward compat) */
546
+ executedTool: ExecutedToolInfo;
547
+ /** All successful tool executions (primary + follow-up queries) */
548
+ allExecutedTools?: ExecutedToolInfo[];
549
+ /** Error message if failed */
550
+ error?: string;
551
+ }
552
+ interface SourceAgentMetadata {
553
+ /** Total rows that matched the query (before limit) */
554
+ totalRowsMatched: number;
555
+ /** Rows actually returned (after limit) */
556
+ rowsReturned: number;
557
+ /** Whether the result was truncated by the row limit */
558
+ isLimited: boolean;
559
+ /** The query/params that were executed */
560
+ queryExecuted?: string;
561
+ /** Execution time in milliseconds */
562
+ executionTimeMs: number;
563
+ }
564
+ /**
565
+ * A pre-built, multi-step UI flow registered with the SDK.
566
+ *
567
+ * When the main agent decides a user's question matches a workflow's whenToUse
568
+ * trigger, it picks the workflow instead of running source agents / generating
569
+ * dashboard components. The LLM extracts the workflow's required props from the
570
+ * prompt (using `propsSchema` as the tool input_schema) and the SDK returns the
571
+ * workflow component directly — no analysis text, no chart generation. The
572
+ * frontend renders the registered workflow component with the LLM-extracted
573
+ * props.
574
+ */
575
+ interface WorkflowDescriptor {
576
+ /** Unique workflow id (used as the LLM tool name) */
577
+ id: string;
578
+ /** Component name on the frontend (matches the registered React component) */
579
+ name: string;
580
+ /** Short human-readable description of what this workflow does */
581
+ description: string;
582
+ /**
583
+ * 1–2 sentence trigger condition. The LLM uses this to decide if the
584
+ * user's prompt matches this workflow. Be specific — e.g.
585
+ * "User wants to *initiate* an inventory transfer (review + submit POs),
586
+ * not just see analysis or charts."
587
+ */
588
+ whenToUse: string;
589
+ /**
590
+ * JSON-schema-style description of the props the workflow needs. Becomes
591
+ * the LLM tool's input_schema, so the model fills these from the prompt.
592
+ * Use the same shape as `params` on direct tools — string descriptors with
593
+ * an optional "(optional)" suffix.
594
+ *
595
+ * Example:
596
+ * ```
597
+ * {
598
+ * selectedStore: 'object — { id, name } of the source branch',
599
+ * minROI: 'number (optional) — only show transfers with ROI ≥ this',
600
+ * }
601
+ * ```
602
+ */
603
+ propsSchema: Record<string, string>;
604
+ /**
605
+ * Optional: static prop defaults merged with LLM-extracted props before
606
+ * the component is returned. Useful for things like the embedded
607
+ * `externalTool` config that the workflow uses to fetch its own data.
608
+ */
609
+ defaultProps?: Record<string, any>;
610
+ }
611
+ /**
612
+ * The workflow selection captured during a routing call.
613
+ * Set on AgentResponse when the LLM picks a workflow tool.
614
+ */
615
+ interface SelectedWorkflow {
616
+ /** Component name (matches WorkflowDescriptor.name) */
617
+ name: string;
618
+ /** Props extracted from the prompt + merged with workflow.defaultProps */
619
+ props: Record<string, any>;
620
+ }
621
+ /**
622
+ * Set when this turn applies a user-directed edit to an existing script instead
623
+ * of authoring a new one. MainAgent keeps the SAME harness (tools, loop,
624
+ * write_script/execute_script verification) and swaps only the system prompt —
625
+ * `agent-main-edit` instead of `agent-main`.
626
+ *
627
+ * The two framings contradict each other on whether to query a source first, so
628
+ * they must never be resident in one rendered prompt.
629
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md § D3.
630
+ */
631
+ interface EditContext {
632
+ /** Recipe being edited — the shadow draft records it as parentId. */
633
+ recipeId: string;
634
+ parentName: string;
635
+ parentBody: string;
636
+ /** Self-contained restatement of the change (from the matcher). */
637
+ instruction: string;
638
+ /** Columns the last run returned — grounds the edit without a re-query. */
639
+ lastResultColumns?: string[];
640
+ /** Rendered parameter list of the parent, for the prompt. */
641
+ parentParams?: string;
642
+ }
643
+ /**
644
+ * The complete response from the multi-agent system.
645
+ * Contains everything needed for text display + component generation.
646
+ */
647
+ interface AgentResponse {
648
+ /** Generated text response (analysis of the data) */
649
+ text: string;
650
+ /**
651
+ * Program-generated narrative when the script exported getAnalysis. `text`
652
+ * already carries `analysis.analysis`; this also exposes `summary`, which
653
+ * the markdown block binds to instead of being an LLM summary of the prose.
654
+ */
655
+ analysis?: AnalysisOutput;
656
+ /** All executed tools across all source agents (for component generation) */
657
+ executedTools: ExecutedToolInfo[];
658
+ /** Individual results from each source agent */
659
+ sourceResults: SourceAgentResult[];
660
+ /**
661
+ * Populated when MainAgent wrote AND successfully executed a script during its turn.
662
+ * Caller (agent-user-response.ts) persists it via ScriptStore.save().
663
+ * Absent when MainAgent didn't write one (trivial question / all attempts failed).
664
+ */
665
+ savedScript?: AgentWrittenScript;
666
+ /** Failed execute_script tool_result texts this turn, in order — see RunTrace.script.failedAttempts. */
667
+ failedScriptAttempts?: string[];
668
+ /**
669
+ * Set when the LLM routed the question to a registered workflow component.
670
+ * When present, the upstream caller should skip component generation and
671
+ * return this workflow as the response.
672
+ */
673
+ workflow?: SelectedWorkflow;
674
+ /**
675
+ * Validated component specs the agent authored via `write_components`.
676
+ * When present the caller assembles the dashboard from these instead of
677
+ * running the component-generation LLM. Absent when the agent didn't call
678
+ * the tool — the caller then falls back to `generateScriptComponents`.
679
+ * See backend/docs/COMPONENT-GENERATION-V2.md §2.2.
680
+ */
681
+ componentSpecs?: ScriptComponentSpec[];
682
+ /** Layout title/description from the same `write_components` call. */
683
+ componentLayout?: {
684
+ title: string;
685
+ description?: string;
686
+ };
687
+ }
688
+ /**
689
+ * A script MainAgent authored + verified during its turn. Shape aligns with
690
+ * what ScriptStore.save() needs — minus store-assigned fields (id, timestamps, counts).
691
+ */
692
+ interface AgentWrittenScript {
693
+ /**
694
+ * `ScriptRecipe.id` of the draft that was authored + verified during this turn.
695
+ * The caller passes this to `ScriptStore.promoteToVerified(recipeId, …)` to
696
+ * flip the draft to verified status and (when possible) drop the turn-suffix
697
+ * from its filename.
698
+ */
699
+ recipeId: string;
700
+ name: string;
701
+ intentDescription: string;
702
+ tags: string[];
703
+ parameters: Array<{
704
+ name: string;
705
+ type: 'string' | 'number' | 'date' | 'date_range' | 'enum' | 'boolean';
706
+ required: boolean;
707
+ default?: any;
708
+ enumValues?: Record<string, string>;
709
+ description: string;
710
+ }>;
711
+ scriptBody: string;
712
+ /** Source IDs referenced by the script (extracted from ctx.query calls) */
713
+ sourceIds: string[];
714
+ /** Tables referenced in the script's SQL (regex-extracted) */
715
+ tables: string[];
716
+ /** Executed queries from the verified run — fed to component generation */
717
+ executedQueries: Array<{
718
+ sourceId: string;
719
+ sourceName: string;
720
+ sql: string;
721
+ data: any[];
722
+ count: number;
723
+ totalCount?: number;
724
+ executionTimeMs: number;
725
+ /**
726
+ * True for synthetic entries (ctx.emit datasets, the computed:_final
727
+ * post-JS data). The component generator routes virtual sources through
728
+ * the script_dataset sentinel toolId so the frontend resolves them via
729
+ * queryCache instead of attempting to re-execute SQL.
730
+ */
731
+ virtual?: boolean;
732
+ }>;
733
+ /** The tool_result JSON MainAgent's LLM got back from execute_script — see RunTrace.script.executionResult. */
734
+ executionResult?: string;
735
+ }
736
+ /**
737
+ * Debug trace for a single chat_agent turn — which KB/schema nodes were
738
+ * retrieved and considered, and which script (if any) produced the answer.
739
+ * Persisted separately from the answer itself (fusion-5's
740
+ * `conversation_traces` table, written via `saveTrace`), never sent through
741
+ * `analyticsClient` (data-residency — see design doc §5).
742
+ */
743
+ interface RunTrace {
744
+ version: 1;
745
+ kbNodes: {
746
+ /**
747
+ * Always-on nodes included regardless of the question (getGlobalKnowledgeBase).
748
+ * `content` is the node's full text AS IT WAS at retrieval time — captured so a
749
+ * later edit/delete of the KB node doesn't erase what the LLM actually saw.
750
+ */
751
+ global: Array<{
752
+ kbId: string;
753
+ title: string;
754
+ content?: string;
755
+ }>;
756
+ /** Semantically matched for this specific question (getKnowledgeBase). Same `content` reasoning as above. */
757
+ query: Array<{
758
+ kbId: string;
759
+ title: string;
760
+ similarity?: number;
761
+ content?: string;
762
+ }>;
763
+ };
764
+ schemaNodes: {
765
+ /** MainAgent's cross-source prefilter — which sources were even considered. */
766
+ routing: Array<{
767
+ sourceId: string;
768
+ sourceName?: string;
769
+ similarity: number;
770
+ }>;
771
+ /** SourceAgent-scope per-source table resolution (MainAgent.preResolveSchema). */
772
+ preResolve: Array<{
773
+ sourceId: string;
774
+ table?: string;
775
+ description?: string;
776
+ similarity: number;
777
+ }>;
778
+ /**
779
+ * The exact {{SOURCE_SUMMARIES}} text injected into MainAgent's system prompt
780
+ * (agent-prompt-builder.ts's formatSummariesForPrompt output) — every
781
+ * registered source's catalog entry, not retrieval-specific, captured once per
782
+ * turn. This is what the main agent actually saw when deciding which source(s)
783
+ * to call.
784
+ */
785
+ mainAgentCatalog?: string;
786
+ /**
787
+ * One entry per SourceAgent dispatch (a source called twice in one turn gets
788
+ * two entries) — the exact {{FULL_SCHEMA}} text injected into that
789
+ * SourceAgent's own system prompt, however it was sourced, plus any
790
+ * search_schema follow-up lookups it made mid-conversation when the schema
791
+ * shown wasn't enough.
792
+ */
793
+ sourceAgentSchemas: Array<{
794
+ sourceId: string;
795
+ sourceName?: string;
796
+ /**
797
+ * The exact intent text MainAgent wrote for this dispatch (before the
798
+ * resolved-entities block gets appended by code — see
799
+ * buildResolvedEntitiesBlock) — what MainAgent actually asked this
800
+ * source agent to go find.
801
+ */
802
+ intent: string;
803
+ /** How `schemaText` was sourced — see SourceAgent.buildPrompt's fullSchema fallback chain. */
804
+ method: 'preresolved-embedding' | 'tool-full-schema' | 'tool-description' | 'none';
805
+ schemaText: string;
806
+ /** In call order — each search_schema tool call this SourceAgent made, and the exact result text handed back to its own LLM. */
807
+ searchSchemaLookups: Array<{
808
+ keywords: string[];
809
+ result: string;
810
+ }>;
811
+ /** The tool_result text MainAgent's LLM read back for this dispatch (formatResultForMainAgent output). */
812
+ result?: string;
813
+ }>;
814
+ };
815
+ /** The script that produced this answer, if any. Null for a general (no-tool) answer. */
816
+ script: {
817
+ /** True when an existing recipe was replayed unchanged (ScriptMatcher tier='high'). */
818
+ reused: boolean;
819
+ recipeId?: string | null;
820
+ body?: string | null;
821
+ /** Set when reused — the matcher's reasoning for picking this recipe. */
822
+ reasoning?: string | null;
823
+ /** The winning execute_script tool_result text. Only set when reused=false — a replay never re-runs execute_script. Failed attempts aren't kept. */
824
+ executionResult?: string | null;
825
+ /** Failed execute_script tool_result texts this turn, in order (before the winning one, if any). */
826
+ failedAttempts?: string[];
827
+ } | null;
828
+ /**
829
+ * `resolve_entities` tool activity this turn (see main-agent.ts's
830
+ * RESOLVE_ENTITIES_TOOL_DEF / handleResolveEntities) — names/identifiers the
831
+ * user mentioned, resolved to database ids before any SQL was written.
832
+ * Absent/empty entirely for a project with no entity-search collection
833
+ * registered, or a turn that named nothing.
834
+ */
835
+ entityResolution: {
836
+ /**
837
+ * The entity-type catalog text injected into MainAgent's system prompt
838
+ * (loadEntityCatalog's output) — what let the LLM name a concept instead
839
+ * of guessing the project's vocabulary. Captured once per turn.
840
+ */
841
+ catalogText?: string;
842
+ /**
843
+ * One entry per `resolve_entities` tool call this turn (a turn can call it
844
+ * more than once) — the FULL raw response from the entity-search
845
+ * collection, not just the trimmed {mention,entityType,instanceId,
846
+ * displayName} MainAgent keeps for itself to build the dispatch block.
847
+ * `score`/`ambiguous`/`alternatives` only exist here, nowhere else.
848
+ */
849
+ calls: Array<{
850
+ mentions: Array<{
851
+ text: string;
852
+ entityType?: string;
853
+ }>;
854
+ entityTypes: string[];
855
+ resolved: Array<{
856
+ mention: string;
857
+ entityType: string;
858
+ instanceId: string;
859
+ displayName: string;
860
+ attrs?: Record<string, any>;
861
+ score?: number;
862
+ ambiguous?: boolean;
863
+ alternatives?: Array<{
864
+ instanceId: string;
865
+ displayName: string;
866
+ score: number;
867
+ }>;
868
+ }>;
869
+ unresolved: string[];
870
+ entityMap: Record<string, any>;
871
+ unmatchedEntityTypes?: Array<{
872
+ requested: string;
873
+ candidates?: string[];
874
+ }>;
875
+ /** Set when the collection call itself failed (fails open — see handleResolveEntities). */
876
+ error?: string;
877
+ }>;
878
+ };
879
+ /**
880
+ * The prior-turn conversation context injected into this turn's prompt as
881
+ * CONVERSATION_HISTORY — exactly what each flow already builds for itself
882
+ * (chat: thread.getConversationContext(); report/dashboard: their own
883
+ * equivalents), captured as-is. Every call site sets this unconditionally
884
+ * (empty string '' when there's no prior context — new thread, or history
885
+ * trimmed to nothing), so an empty turn is visibly "no history" in the
886
+ * saved trace rather than a silently missing key. Optional only because
887
+ * traces saved before this field existed won't have it at all.
888
+ */
889
+ conversationHistory?: string;
890
+ /**
891
+ * The exact {{USER_ACCESS_CONTEXT}} text injected into MainAgent's system
892
+ * prompt — the per-user authorization config (sa-api users.config)
893
+ * rendered by buildUserAccessContext, as-is. Captured once (MainAgent's
894
+ * prompt is what SourceAgent's identical value is derived from — no need
895
+ * to duplicate it per source dispatch). Set unconditionally (empty string
896
+ * '' when there's no config for this user), so "no restrictions" is
897
+ * visible in the saved trace rather than a silently missing key. Optional
898
+ * only because traces saved before this field existed won't have it.
899
+ */
900
+ userAccessContext?: string;
901
+ }
902
+ /**
903
+ * Configuration for the multi-agent system.
904
+ * Controls limits, models, and behavior.
905
+ */
906
+ interface AgentConfig {
907
+ /** Max rows shown to the UI preview / inlined per source (default: 10) */
908
+ maxRowsPerSource: number;
909
+ /**
910
+ * Max rows a source query may FETCH from the DB server-side (default: 2000).
911
+ * Decoupled from what the main agent is shown: the full result is fetched and
912
+ * summarized (bounded), but only a small/complete slice enters LLM context.
913
+ * This lets small lookups (benchmark maps) arrive COMPLETE without letting
914
+ * large results blow up context.
915
+ */
916
+ maxRowsFetched: number;
917
+ /** Model for the main agent (routing + analysis in one LLM call) */
918
+ mainAgentModel: string;
919
+ /** Model for source agent query generation */
920
+ sourceAgentModel: string;
921
+ /** API key for LLM calls */
922
+ apiKey?: string;
923
+ /** Max retry attempts per source agent */
924
+ maxRetries: number;
925
+ /** Max tool calling iterations for the main agent loop */
926
+ maxIterations: number;
927
+ /** Global knowledge base context (static, same for all users/questions — cached in system prompt) */
928
+ globalKnowledgeBase?: string;
929
+ /** Per-request knowledge base context (user-specific + query-matched — dynamic, not cached) */
930
+ knowledgeBaseContext?: string;
931
+ /** Per-user authorization config (sa-api users.config), rendered to text — see buildUserAccessContext */
932
+ userAccessContext?: string;
933
+ /** Collections registry (ChromaDB search hooks) for embedding-based schema + source search */
934
+ collections?: any;
935
+ /** Optional project ID for scoping embedding searches */
936
+ projectId?: string;
937
+ /**
938
+ * Optional debug-trace accumulator for this turn (Phase 1, chat_agent only).
939
+ * When present, MainAgent-scope retrieval call sites (e.g. preResolveSchema)
940
+ * push their structured results into it. Absent for callers that don't care
941
+ * about trace capture (e.g. headless flows) — every push site must treat
942
+ * this as optional and never let a capture failure affect the real answer.
943
+ */
944
+ trace?: RunTrace;
945
+ }
946
+ /**
947
+ * Default agent configuration
948
+ */
949
+ declare const DEFAULT_AGENT_CONFIG: AgentConfig;
950
+
4
951
  /**
5
952
  * Unified UIBlock structure for database storage
6
- * Used in both bookmarks and user-conversations tables
953
+ * Used in both bookmarks and user-conversations tables.
954
+ *
955
+ * `analysis` always holds whatever real narration exists — the full answer on
956
+ * success, or whatever was actually streamed before a failure (may be empty).
957
+ * `error` is a dedicated field, null on success — it can be a plain string OR
958
+ * a structured object/array (e.g. the agent's raw `errors` list), whatever
959
+ * shape the failure naturally has; it's never coerced into `analysis`.
7
960
  */
8
961
  interface DBUIBlock {
9
962
  id: string;
10
963
  component: Record<string, any> | null;
11
964
  analysis: string | null;
12
965
  user_prompt: string;
966
+ error?: unknown | null;
967
+ /**
968
+ * The script recipe that produced this answer, when one did. Read back via
969
+ * `conversation-history.exactMatch` so an edit follow-up still has a target
970
+ * after a reload (the in-memory thread is gone by then), and indexed so
971
+ * committing an edit can purge every cached answer bound to the recipe.
972
+ */
973
+ scriptBinding?: {
974
+ recipeId: string;
975
+ params?: Record<string, any>;
976
+ name?: string;
977
+ columns?: string[];
978
+ };
13
979
  }
14
980
 
15
981
  /**
@@ -160,6 +1126,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
160
1126
  dependencies?: string[] | undefined;
161
1127
  } | undefined;
162
1128
  props?: Record<string, any> | undefined;
1129
+ data?: Record<string, any> | undefined;
163
1130
  render?: any;
164
1131
  states?: Record<string, any> | undefined;
165
1132
  methods?: Record<string, {
@@ -170,7 +1137,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
170
1137
  fn: string;
171
1138
  deps?: string[] | undefined;
172
1139
  }[] | undefined;
173
- data?: Record<string, any> | undefined;
174
1140
  pages?: {
175
1141
  id: string;
176
1142
  name: string;
@@ -192,6 +1158,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
192
1158
  dependencies?: string[] | undefined;
193
1159
  } | undefined;
194
1160
  props?: Record<string, any> | undefined;
1161
+ data?: Record<string, any> | undefined;
195
1162
  render?: any;
196
1163
  states?: Record<string, any> | undefined;
197
1164
  methods?: Record<string, {
@@ -202,7 +1169,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
202
1169
  fn: string;
203
1170
  deps?: string[] | undefined;
204
1171
  }[] | undefined;
205
- data?: Record<string, any> | undefined;
206
1172
  pages?: {
207
1173
  id: string;
208
1174
  name: string;
@@ -228,6 +1194,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
228
1194
  dependencies?: string[] | undefined;
229
1195
  } | undefined;
230
1196
  props?: Record<string, any> | undefined;
1197
+ data?: Record<string, any> | undefined;
231
1198
  render?: any;
232
1199
  states?: Record<string, any> | undefined;
233
1200
  methods?: Record<string, {
@@ -238,7 +1205,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
238
1205
  fn: string;
239
1206
  deps?: string[] | undefined;
240
1207
  }[] | undefined;
241
- data?: Record<string, any> | undefined;
242
1208
  pages?: {
243
1209
  id: string;
244
1210
  name: string;
@@ -264,6 +1230,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
264
1230
  dependencies?: string[] | undefined;
265
1231
  } | undefined;
266
1232
  props?: Record<string, any> | undefined;
1233
+ data?: Record<string, any> | undefined;
267
1234
  render?: any;
268
1235
  states?: Record<string, any> | undefined;
269
1236
  methods?: Record<string, {
@@ -274,7 +1241,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
274
1241
  fn: string;
275
1242
  deps?: string[] | undefined;
276
1243
  }[] | undefined;
277
- data?: Record<string, any> | undefined;
278
1244
  pages?: {
279
1245
  id: string;
280
1246
  name: string;
@@ -355,6 +1321,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
355
1321
  dependencies?: string[] | undefined;
356
1322
  } | undefined;
357
1323
  props?: Record<string, any> | undefined;
1324
+ data?: Record<string, any> | undefined;
358
1325
  render?: any;
359
1326
  states?: Record<string, any> | undefined;
360
1327
  methods?: Record<string, {
@@ -365,7 +1332,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
365
1332
  fn: string;
366
1333
  deps?: string[] | undefined;
367
1334
  }[] | undefined;
368
- data?: Record<string, any> | undefined;
369
1335
  }, {
370
1336
  id: string;
371
1337
  name?: string | undefined;
@@ -379,6 +1345,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
379
1345
  dependencies?: string[] | undefined;
380
1346
  } | undefined;
381
1347
  props?: Record<string, any> | undefined;
1348
+ data?: Record<string, any> | undefined;
382
1349
  render?: any;
383
1350
  states?: Record<string, any> | undefined;
384
1351
  methods?: Record<string, {
@@ -389,7 +1356,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
389
1356
  fn: string;
390
1357
  deps?: string[] | undefined;
391
1358
  }[] | undefined;
392
- data?: Record<string, any> | undefined;
393
1359
  }>;
394
1360
  data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
395
1361
  context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
@@ -407,6 +1373,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
407
1373
  dependencies?: string[] | undefined;
408
1374
  } | undefined;
409
1375
  props?: Record<string, any> | undefined;
1376
+ data?: Record<string, any> | undefined;
410
1377
  render?: any;
411
1378
  states?: Record<string, any> | undefined;
412
1379
  methods?: Record<string, {
@@ -417,7 +1384,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
417
1384
  fn: string;
418
1385
  deps?: string[] | undefined;
419
1386
  }[] | undefined;
420
- data?: Record<string, any> | undefined;
421
1387
  };
422
1388
  data?: Record<string, any> | undefined;
423
1389
  context?: Record<string, any> | undefined;
@@ -435,6 +1401,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
435
1401
  dependencies?: string[] | undefined;
436
1402
  } | undefined;
437
1403
  props?: Record<string, any> | undefined;
1404
+ data?: Record<string, any> | undefined;
438
1405
  render?: any;
439
1406
  states?: Record<string, any> | undefined;
440
1407
  methods?: Record<string, {
@@ -445,7 +1412,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
445
1412
  fn: string;
446
1413
  deps?: string[] | undefined;
447
1414
  }[] | undefined;
448
- data?: Record<string, any> | undefined;
449
1415
  };
450
1416
  data?: Record<string, any> | undefined;
451
1417
  context?: Record<string, any> | undefined;
@@ -861,6 +1827,10 @@ interface SuperatomSDKConfig {
861
1827
  bundleDir?: string;
862
1828
  promptsDir?: string;
863
1829
  databaseType?: DatabaseType;
1830
+ /** BCP-47 locale for `fmt` in generated analyses, e.g. 'en-IN', 'en-US'. Defaults to 'en-IN'. */
1831
+ locale?: string;
1832
+ /** ISO-4217 currency for `fmt`, e.g. 'INR', 'USD'. Defaults to 'INR'. */
1833
+ currency?: string;
864
1834
  ANTHROPIC_API_KEY?: string;
865
1835
  GROQ_API_KEY?: string;
866
1836
  GEMINI_API_KEY?: string;
@@ -1008,7 +1978,7 @@ declare const KbNodesRequestPayloadSchema: z.ZodObject<{
1008
1978
  content?: string | undefined;
1009
1979
  }>>;
1010
1980
  }, "strip", z.ZodTypeAny, {
1011
- operation: "create" | "getOne" | "update" | "delete" | "getAll" | "search" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
1981
+ operation: "create" | "getOne" | "search" | "update" | "delete" | "getAll" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
1012
1982
  data?: {
1013
1983
  id?: number | undefined;
1014
1984
  type?: "query" | "user" | "global" | undefined;
@@ -1031,7 +2001,7 @@ declare const KbNodesRequestPayloadSchema: z.ZodObject<{
1031
2001
  content?: string | undefined;
1032
2002
  } | undefined;
1033
2003
  }, {
1034
- operation: "create" | "getOne" | "update" | "delete" | "getAll" | "search" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
2004
+ operation: "create" | "getOne" | "search" | "update" | "delete" | "getAll" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
1035
2005
  data?: {
1036
2006
  id?: number | undefined;
1037
2007
  type?: "query" | "user" | "global" | undefined;
@@ -1249,345 +2219,388 @@ declare class DashboardManager {
1249
2219
  */
1250
2220
  dashboardExists(dashboardId: string): boolean;
1251
2221
  /**
1252
- * Get dashboard count
1253
- * @returns Number of dashboards
1254
- */
1255
- getDashboardCount(): number;
1256
- }
1257
-
1258
- /**
1259
- * ReportManager class to handle CRUD operations on reports
1260
- * All operations read/write directly to files (no in-memory caching)
1261
- */
1262
- declare class ReportManager {
1263
- private reportsBasePath;
1264
- private projectId;
1265
- /**
1266
- * Initialize ReportManager with project ID
1267
- * @param projectId - Project ID to use in file path
1268
- */
1269
- constructor(projectId?: string);
1270
- /**
1271
- * Get the file path for a specific report
1272
- * @param reportId - Report ID
1273
- * @returns Full path to report data.json file
1274
- */
1275
- private getReportPath;
1276
- /**
1277
- * Create a new report
1278
- * @param reportId - Unique report ID
1279
- * @param report - Report data
1280
- * @returns Created report with metadata
1281
- */
1282
- createReport(reportId: string, report: DSLRendererProps): DSLRendererProps;
1283
- /**
1284
- * Get a specific report by ID
1285
- * @param reportId - Report ID
1286
- * @returns Report data or null if not found
1287
- */
1288
- getReport(reportId: string): DSLRendererProps | null;
1289
- /**
1290
- * Get all reports
1291
- * @returns Array of report objects with their IDs
1292
- */
1293
- getAllReports(): Array<{
1294
- reportId: string;
1295
- report: DSLRendererProps;
1296
- }>;
1297
- /**
1298
- * Update an existing report
1299
- * @param reportId - Report ID
1300
- * @param report - Updated report data
1301
- * @returns Updated report or null if not found
1302
- */
1303
- updateReport(reportId: string, report: DSLRendererProps): DSLRendererProps | null;
1304
- /**
1305
- * Delete a report
1306
- * @param reportId - Report ID
1307
- * @returns True if deleted, false if not found
1308
- */
1309
- deleteReport(reportId: string): boolean;
1310
- /**
1311
- * Check if a report exists
1312
- * @param reportId - Report ID
1313
- * @returns True if report exists, false otherwise
1314
- */
1315
- reportExists(reportId: string): boolean;
1316
- /**
1317
- * Get report count
1318
- * @returns Number of reports
1319
- */
1320
- getReportCount(): number;
1321
- }
1322
-
1323
- /**
1324
- * StreamBuffer - Buffered streaming utility for smoother text delivery
1325
- * Batches small chunks together and flushes at regular intervals
1326
- */
1327
- type StreamCallback = (chunk: string) => void;
1328
- /**
1329
- * StreamBuffer class for managing buffered streaming output
1330
- * Provides smooth text delivery by batching small chunks
1331
- */
1332
- declare class StreamBuffer {
1333
- private buffer;
1334
- private flushTimer;
1335
- private callback;
1336
- private fullText;
1337
- constructor(callback?: StreamCallback);
1338
- /**
1339
- * Check if the buffer has a callback configured
1340
- */
1341
- hasCallback(): boolean;
1342
- /**
1343
- * Get all text that has been written (including already flushed)
1344
- */
1345
- getFullText(): string;
1346
- /**
1347
- * Write a chunk to the buffer
1348
- * Large chunks or chunks with newlines are flushed immediately
1349
- * Small chunks are batched and flushed after a short interval
1350
- *
1351
- * @param chunk - Text chunk to write
1352
- */
1353
- write(chunk: string): void;
1354
- /**
1355
- * Flush the buffer immediately
1356
- * Call this before tool execution or other operations that need clean output
1357
- */
1358
- flush(): void;
1359
- /**
1360
- * Internal flush implementation
1361
- */
1362
- private flushNow;
1363
- /**
1364
- * Clean up resources
1365
- * Call this when done with the buffer
1366
- */
1367
- dispose(): void;
1368
- }
1369
-
1370
- /**
1371
- * ToolExecutorService - Handles execution of SQL queries and external tools
1372
- * Extracted from BaseLLM.generateTextResponse for better separation of concerns
1373
- */
1374
-
1375
- /**
1376
- * External tool definition
1377
- */
1378
- interface ExternalTool {
1379
- id: string;
1380
- name: string;
1381
- description?: string;
1382
- /** Tool type: "source" = routed through SourceAgent, "direct" = called directly by MainAgent */
1383
- toolType?: 'source' | 'direct';
1384
- /** Full untruncated schema for source agent (all columns visible) */
1385
- fullSchema?: string;
1386
- /** Schema size tier: small (≤50 tables), medium (51-200), large (201-500), very_large (500+) */
1387
- schemaTier?: string;
1388
- /** Schema search function for very_large tier — keyword search over entities */
1389
- schemaSearchFn?: (keywords: string[]) => string;
1390
- fn: (input: any) => Promise<any>;
1391
- limit?: number;
1392
- outputSchema?: any;
1393
- executionType?: 'immediate' | 'deferred';
1394
- userProvidedData?: any;
1395
- params?: Record<string, any>;
1396
- }
1397
- /**
1398
- * Executed tool tracking info
1399
- */
1400
- interface ExecutedToolInfo {
1401
- id: string;
1402
- name: string;
1403
- params: any;
1404
- result: {
1405
- _totalRecords: number;
1406
- _recordsShown: number;
1407
- _metadata?: any;
1408
- _sampleData: any[];
1409
- };
1410
- outputSchema?: any;
1411
- sourceSchema?: string;
1412
- sourceType?: string;
1413
- }
1414
-
1415
- /**
1416
- * Multi-Agent Architecture Types
1417
- *
1418
- * Defines interfaces for the hierarchical agent system:
1419
- * - Main Agent: ONE LLM.streamWithTools() call with source agent tools
1420
- * - Source Agents: independent agents that query individual data sources
1421
- *
1422
- * The main agent sees only source summaries. When it calls a source tool,
1423
- * the SourceAgent runs independently (own LLM, own retries) and returns clean data.
1424
- */
1425
-
1426
- /**
1427
- * Per-entity detail: name, row count, and column names.
1428
- * Gives the main agent enough context to route to the right source.
1429
- */
1430
- interface EntityDetail {
1431
- /** Entity name (table, sheet, endpoint) */
1432
- name: string;
1433
- /** Approximate row count */
1434
- rowCount?: number;
1435
- /** Column/field names */
1436
- columns: string[];
1437
- }
1438
- /**
1439
- * Representation of a data source for the main agent.
1440
- * Contains entity names WITH column names so the LLM can route accurately.
1441
- */
1442
- interface SourceSummary {
1443
- /** Source ID (matches tool ID prefix) */
1444
- id: string;
1445
- /** Human-readable source name */
1446
- name: string;
1447
- /** Source type: postgres, excel, rest_api, etc. */
1448
- type: string;
1449
- /** Brief description of what data this source contains */
1450
- description: string;
1451
- /** Detailed entity info with column names for routing */
1452
- entityDetails: EntityDetail[];
1453
- /** The tool ID associated with this source */
1454
- toolId: string;
1455
- }
1456
- /**
1457
- * What a source agent returns after querying its data source.
1458
- * The main agent uses this to analyze and compose the final response.
1459
- */
1460
- interface SourceAgentResult {
1461
- /** Source ID */
1462
- sourceId: string;
1463
- /** Source name */
1464
- sourceName: string;
1465
- /** Whether the query succeeded */
1466
- success: boolean;
1467
- /** Result data rows */
1468
- data: any[];
1469
- /** Metadata about the query execution */
1470
- metadata: SourceAgentMetadata;
1471
- /** Tool execution info for the last successful query (backward compat) */
1472
- executedTool: ExecutedToolInfo;
1473
- /** All successful tool executions (primary + follow-up queries) */
1474
- allExecutedTools?: ExecutedToolInfo[];
1475
- /** Error message if failed */
1476
- error?: string;
1477
- }
1478
- interface SourceAgentMetadata {
1479
- /** Total rows that matched the query (before limit) */
1480
- totalRowsMatched: number;
1481
- /** Rows actually returned (after limit) */
1482
- rowsReturned: number;
1483
- /** Whether the result was truncated by the row limit */
1484
- isLimited: boolean;
1485
- /** The query/params that were executed */
1486
- queryExecuted?: string;
1487
- /** Execution time in milliseconds */
1488
- executionTimeMs: number;
2222
+ * Get dashboard count
2223
+ * @returns Number of dashboards
2224
+ */
2225
+ getDashboardCount(): number;
1489
2226
  }
2227
+
1490
2228
  /**
1491
- * A pre-built, multi-step UI flow registered with the SDK.
1492
- *
1493
- * When the main agent decides a user's question matches a workflow's whenToUse
1494
- * trigger, it picks the workflow instead of running source agents / generating
1495
- * dashboard components. The LLM extracts the workflow's required props from the
1496
- * prompt (using `propsSchema` as the tool input_schema) and the SDK returns the
1497
- * workflow component directly — no analysis text, no chart generation. The
1498
- * frontend renders the registered workflow component with the LLM-extracted
1499
- * props.
2229
+ * ReportManager class to handle CRUD operations on reports
2230
+ * All operations read/write directly to files (no in-memory caching)
1500
2231
  */
1501
- interface WorkflowDescriptor {
1502
- /** Unique workflow id (used as the LLM tool name) */
1503
- id: string;
1504
- /** Component name on the frontend (matches the registered React component) */
1505
- name: string;
1506
- /** Short human-readable description of what this workflow does */
1507
- description: string;
2232
+ declare class ReportManager {
2233
+ private reportsBasePath;
2234
+ private projectId;
1508
2235
  /**
1509
- * 1–2 sentence trigger condition. The LLM uses this to decide if the
1510
- * user's prompt matches this workflow. Be specific e.g.
1511
- * "User wants to *initiate* an inventory transfer (review + submit POs),
1512
- * not just see analysis or charts."
2236
+ * Initialize ReportManager with project ID
2237
+ * @param projectId - Project ID to use in file path
1513
2238
  */
1514
- whenToUse: string;
2239
+ constructor(projectId?: string);
1515
2240
  /**
1516
- * JSON-schema-style description of the props the workflow needs. Becomes
1517
- * the LLM tool's input_schema, so the model fills these from the prompt.
1518
- * Use the same shape as `params` on direct tools — string descriptors with
1519
- * an optional "(optional)" suffix.
1520
- *
1521
- * Example:
1522
- * ```
1523
- * {
1524
- * selectedStore: 'object — { id, name } of the source branch',
1525
- * minROI: 'number (optional) — only show transfers with ROI ≥ this',
1526
- * }
1527
- * ```
2241
+ * Get the file path for a specific report
2242
+ * @param reportId - Report ID
2243
+ * @returns Full path to report data.json file
1528
2244
  */
1529
- propsSchema: Record<string, string>;
2245
+ private getReportPath;
1530
2246
  /**
1531
- * Optional: static prop defaults merged with LLM-extracted props before
1532
- * the component is returned. Useful for things like the embedded
1533
- * `externalTool` config that the workflow uses to fetch its own data.
2247
+ * Create a new report
2248
+ * @param reportId - Unique report ID
2249
+ * @param report - Report data
2250
+ * @returns Created report with metadata
1534
2251
  */
1535
- defaultProps?: Record<string, any>;
2252
+ createReport(reportId: string, report: DSLRendererProps): DSLRendererProps;
2253
+ /**
2254
+ * Get a specific report by ID
2255
+ * @param reportId - Report ID
2256
+ * @returns Report data or null if not found
2257
+ */
2258
+ getReport(reportId: string): DSLRendererProps | null;
2259
+ /**
2260
+ * Get all reports
2261
+ * @returns Array of report objects with their IDs
2262
+ */
2263
+ getAllReports(): Array<{
2264
+ reportId: string;
2265
+ report: DSLRendererProps;
2266
+ }>;
2267
+ /**
2268
+ * Update an existing report
2269
+ * @param reportId - Report ID
2270
+ * @param report - Updated report data
2271
+ * @returns Updated report or null if not found
2272
+ */
2273
+ updateReport(reportId: string, report: DSLRendererProps): DSLRendererProps | null;
2274
+ /**
2275
+ * Delete a report
2276
+ * @param reportId - Report ID
2277
+ * @returns True if deleted, false if not found
2278
+ */
2279
+ deleteReport(reportId: string): boolean;
2280
+ /**
2281
+ * Check if a report exists
2282
+ * @param reportId - Report ID
2283
+ * @returns True if report exists, false otherwise
2284
+ */
2285
+ reportExists(reportId: string): boolean;
2286
+ /**
2287
+ * Get report count
2288
+ * @returns Number of reports
2289
+ */
2290
+ getReportCount(): number;
1536
2291
  }
2292
+
1537
2293
  /**
1538
- * The workflow selection captured during a routing call.
1539
- * Set on AgentResponse when the LLM picks a workflow tool.
2294
+ * ScriptRecipeStore injected metadata backend for the script flow.
2295
+ *
2296
+ * The SDK is standalone (no DB dependency). The backend implements this
2297
+ * interface over Postgres (full-text search + atomic counters) and injects it
2298
+ * via `collections['script-recipes']`, exactly like `collections['source-embeddings']`.
2299
+ * `ScriptStore` consumes it for all METADATA operations while keeping the
2300
+ * executable body on disk as scripts-store/<fileBase>.ts.
2301
+ *
2302
+ * All metadata rows are plain JSON (no scriptBody — that lives on disk).
2303
+ * See backend/docs/SCRIPT-FLOW-SCALING-ISSUES.md (#1, #3, #7).
1540
2304
  */
1541
- interface SelectedWorkflow {
1542
- /** Component name (matches WorkflowDescriptor.name) */
2305
+
2306
+ /** One recipe's metadata as stored in Postgres (mirrors the script_recipes table). */
2307
+ interface ScriptRecipeMetaRow {
2308
+ id: string;
2309
+ projectId?: string | null;
2310
+ version: number;
1543
2311
  name: string;
1544
- /** Props extracted from the prompt + merged with workflow.defaultProps */
1545
- props: Record<string, any>;
2312
+ intentDescription: string;
2313
+ tags: string[] | null;
2314
+ createdFrom: string | null;
2315
+ sourceIds: string[] | null;
2316
+ tables: string[] | null;
2317
+ parameters: ScriptParameter[] | null;
2318
+ components?: ScriptComponentSpec[] | null;
2319
+ displayPreference?: ScriptDisplayPreference | null;
2320
+ fileBase: string;
2321
+ bodyHash?: string | null;
2322
+ successCount: number;
2323
+ failureCount: number;
2324
+ lastUsed: string | null;
2325
+ parentId?: string | null;
2326
+ forkDepth?: number | null;
2327
+ forkReason?: string | null;
2328
+ status: 'draft' | 'verified' | string;
2329
+ turnId?: string | null;
2330
+ editedBy?: string | null;
2331
+ editedFrom?: string | null;
2332
+ history?: ScriptVersionRecord[] | null;
2333
+ lastError?: {
2334
+ phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
2335
+ message: string;
2336
+ at: string;
2337
+ attempt: number;
2338
+ } | null;
2339
+ createdAt?: string | null;
2340
+ updatedAt?: string | null;
2341
+ }
2342
+ interface ScriptRecipeStore {
2343
+ /** FTS shortlist of healthy verified recipes for the matcher (metadata only). */
2344
+ search(params: {
2345
+ prompt: string;
2346
+ projectId?: string;
2347
+ limit?: number;
2348
+ }): Promise<ScriptRecipeMetaRow[]>;
2349
+ /** Fetch one recipe by id (any status). */
2350
+ getById(id: string): Promise<ScriptRecipeMetaRow | null>;
2351
+ /** Count healthy verified recipes (drives the "any scripts?" gate). */
2352
+ count(params?: {
2353
+ projectId?: string;
2354
+ }): Promise<number>;
2355
+ /** Insert or update a recipe row (keyed by id). */
2356
+ upsert(row: ScriptRecipeMetaRow): Promise<void>;
2357
+ /** Atomically bump counters / last-used. */
2358
+ updateStats(id: string, patch: {
2359
+ successDelta?: number;
2360
+ failureDelta?: number;
2361
+ lastUsed?: string;
2362
+ }): Promise<void>;
2363
+ /** Flip a draft to verified, applying provenance + optional fork lineage. */
2364
+ promote(id: string, patch: {
2365
+ sourceIds: string[];
2366
+ tables: string[];
2367
+ fileBase?: string;
2368
+ parentId?: string;
2369
+ forkDepth?: number;
2370
+ forkReason?: string;
2371
+ components?: ScriptComponentSpec[];
2372
+ }): Promise<ScriptRecipeMetaRow | null>;
2373
+ /**
2374
+ * Commit a verified edit onto an EXISTING recipe: bump `version`, replace the
2375
+ * body-bearing metadata, append a history record, reset health counters, and
2376
+ * clear the component specs (they were validated against the old shape).
2377
+ * Returns the updated row, or null when the target is gone.
2378
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 5.
2379
+ */
2380
+ commitEdit?(id: string, patch: {
2381
+ name?: string;
2382
+ intentDescription?: string;
2383
+ tags?: string[];
2384
+ parameters?: ScriptParameter[];
2385
+ bodyHash: string;
2386
+ /** New on-disk stem when the edit renamed the script; omitted otherwise. */
2387
+ fileBase?: string;
2388
+ sourceIds?: string[];
2389
+ tables?: string[];
2390
+ editedBy?: string;
2391
+ editedFrom?: string;
2392
+ historyEntry: {
2393
+ version: number;
2394
+ at: string;
2395
+ by?: string;
2396
+ instruction?: string;
2397
+ changeSummary?: string;
2398
+ bodyHash?: string;
2399
+ };
2400
+ }): Promise<ScriptRecipeMetaRow | null>;
2401
+ /** Stamp a draft's last execution error. */
2402
+ recordDraftError(id: string, err: {
2403
+ phase: string;
2404
+ message: string;
2405
+ attempt: number;
2406
+ at: string;
2407
+ }): Promise<void>;
2408
+ /** Delete a recipe row (body file removed separately). */
2409
+ remove(id: string): Promise<void>;
2410
+ /** True if `fileBase` is taken by a different recipe in this project. */
2411
+ fileBaseTaken(fileBase: string, excludeId: string, projectId?: string): Promise<boolean>;
1546
2412
  }
2413
+ /** Pull the injected store off the collections bag (or null if not wired). */
2414
+ declare function resolveScriptRecipeStore(collections: any): ScriptRecipeStore | null;
2415
+
1547
2416
  /**
1548
- * The complete response from the multi-agent system.
1549
- * Contains everything needed for text display + component generation.
2417
+ * ScriptStore Postgres metadata + on-disk body for script recipes.
2418
+ *
2419
+ * Split of responsibilities:
2420
+ * - METADATA → injected `ScriptRecipeStore` (Postgres FTS + atomic counters),
2421
+ * resolved from `collections['script-recipes']`.
2422
+ * - BODY → scripts-store/<fileBase>.ts, editable in your IDE. Written
2423
+ * atomically (temp + rename); `bodyHash` (sha256) detects edits.
2424
+ *
2425
+ * The old "read every file every turn + send the whole catalog to the LLM"
2426
+ * matcher is gone — matching is `store.search(prompt)` (FTS shortlist). The
2427
+ * draft/verified filename dance is gone too: `status` is a DB column and the
2428
+ * file keeps a stable `<fileBase>.ts` name across promotion.
2429
+ *
2430
+ * When no metadata store is injected, the store degrades to a safe no-op
2431
+ * (count 0 → script flow disabled) instead of crashing.
2432
+ *
2433
+ * See backend/docs/SCRIPT-FLOW-SCALING-ISSUES.md.
1550
2434
  */
1551
- interface AgentResponse {
1552
- /** Generated text response (analysis of the data) */
1553
- text: string;
1554
- /** All executed tools across all source agents (for component generation) */
1555
- executedTools: ExecutedToolInfo[];
1556
- /** Individual results from each source agent */
1557
- sourceResults: SourceAgentResult[];
2435
+
2436
+ interface SaveDraftInput {
2437
+ /** Reuse an existing draft (retry); omit to mint a new one. */
2438
+ recipeId?: string;
2439
+ /** Per-turn unique suffix, stable across retries within the turn. */
2440
+ turnId: string;
2441
+ name: string;
2442
+ intentDescription: string;
2443
+ tags: string[];
2444
+ parameters: ScriptParameter[];
2445
+ scriptBody: string;
2446
+ createdFrom: string;
2447
+ /**
2448
+ * Set when this draft is a SHADOW of an existing recipe being edited. The
2449
+ * draft is verified independently and merged back onto the parent via
2450
+ * `commitEdit`, so the working script is never clobbered by an edit that
2451
+ * turns out not to run. See backend/docs/SCRIPT-EDIT-DESIGN.md § D5.
2452
+ */
2453
+ parentId?: string;
2454
+ }
2455
+ interface PromoteToVerifiedInput {
2456
+ sourceIds: string[];
2457
+ tables: string[];
2458
+ parentId?: string;
2459
+ forkDepth?: number;
2460
+ forkReason?: string;
2461
+ components?: ScriptComponentSpec[];
2462
+ }
2463
+ interface ScriptStoreOptions {
2464
+ /** Explicit metadata store, or resolved from `collections['script-recipes']`. */
2465
+ store?: ScriptRecipeStore | null;
2466
+ collections?: any;
2467
+ /** Body directory (defaults to <cwd>/scripts-store). */
2468
+ baseDir?: string;
2469
+ /** Project scope stamped on every row. */
2470
+ projectId?: string;
2471
+ }
2472
+ declare function normalizeScriptBody(scriptBody: string): string;
2473
+ declare class ScriptStore {
2474
+ private store;
2475
+ private storeDir;
2476
+ private projectId?;
2477
+ constructor(opts?: ScriptStoreOptions);
2478
+ /** Whether a metadata store is wired (matcher / authoring are gated on this). */
2479
+ hasStore(): boolean;
2480
+ /** Number of healthy verified recipes (gates the script-matching path). */
2481
+ count(): Promise<number>;
2482
+ /**
2483
+ * FTS shortlist for the matcher (metadata only — bodies are loaded lazily by
2484
+ * `get()` once the LLM picks one). Returns verified, healthy recipes ranked
2485
+ * by relevance.
2486
+ */
2487
+ search(prompt: string, limit?: number): Promise<ScriptRecipe[]>;
2488
+ /** Fetch one recipe by id with its body loaded from disk. */
2489
+ get(id: string): Promise<ScriptRecipe | null>;
2490
+ /** Create or update a recipe (metadata upsert + body write when changed). */
2491
+ save(recipe: ScriptRecipe): Promise<void>;
2492
+ /**
2493
+ * Persist (or update) a draft. Within a turn, retries that pass the same
2494
+ * `recipeId` overwrite the same row + file; a fresh `recipeId` mints a new
2495
+ * draft. The body is visible at scripts-store/<fileBase>.ts immediately.
2496
+ */
2497
+ saveDraft(input: SaveDraftInput): Promise<ScriptRecipe>;
2498
+ /** Stamp a draft's last execution error (metadata only). */
2499
+ recordDraftError(recipeId: string, err: {
2500
+ phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
2501
+ message: string;
2502
+ attempt: number;
2503
+ }): Promise<void>;
2504
+ /**
2505
+ * Promote a successfully-executed draft into a verified script.
2506
+ * The on-disk body already exists at <fileBase>.ts (written at write_script
2507
+ * time) and keeps its name — only the DB row flips status + provenance.
2508
+ */
2509
+ promoteToVerified(recipeId: string, input: PromoteToVerifiedInput): Promise<ScriptRecipe | null>;
2510
+ /**
2511
+ * Commit a user-directed edit: merge a VERIFIED shadow draft back onto the
2512
+ * recipe it was editing, as version N+1 under the SAME recipe id.
2513
+ *
2514
+ * Keeping the id stable is the point of the whole feature — every cached
2515
+ * conversation, `script_dataset` regeneration descriptor and persisted
2516
+ * component spec already points at it, so the correction applies retroactively
2517
+ * to replays instead of stranding them on the old body.
2518
+ *
2519
+ * Steps (see backend/docs/SCRIPT-EDIT-DESIGN.md § Component 5):
2520
+ * 1. archive the current body as `<fileBase>.v<version>.ts`
2521
+ * 2. write the edited body to the original fileBase (atomic)
2522
+ * 3. version++, copy name/description/params, append a history record
2523
+ * 4. reset health counters — the pre-edit failure history is stale
2524
+ * 5. clear component specs — they were validated against the OLD shape
2525
+ * 6. delete the shadow draft (row + file)
2526
+ *
2527
+ * Returns the updated recipe, or null when the commit could not be applied
2528
+ * (caller should then fall back to treating the draft as a new script).
2529
+ */
2530
+ commitEdit(targetId: string, draft: {
2531
+ recipeId: string;
2532
+ name?: string;
2533
+ intentDescription?: string;
2534
+ tags?: string[];
2535
+ parameters?: ScriptParameter[];
2536
+ scriptBody: string;
2537
+ sourceIds?: string[];
2538
+ tables?: string[];
2539
+ }, meta: {
2540
+ instruction?: string;
2541
+ changeSummary?: string;
2542
+ editedBy?: string;
2543
+ }): Promise<ScriptRecipe | null>;
2544
+ /**
2545
+ * Drop a draft (row + body file). MainAgent calls this at end-of-turn when a
2546
+ * draft was authored but never verified — failed drafts are never matched, so
2547
+ * deleting them immediately avoids unbounded accumulation (#5). No-op if the
2548
+ * recipe isn't a draft (so a promoted/verified script is never removed here).
2549
+ */
2550
+ discardDraft(recipeId: string): Promise<void>;
2551
+ /** Delete a recipe (row + body file). */
2552
+ delete(id: string): Promise<void>;
2553
+ /** Record a successful execution (atomic counter bump). */
2554
+ recordSuccess(id: string): Promise<void>;
2555
+ /** Record a failed execution (atomic counter bump). */
2556
+ recordFailure(id: string): Promise<void>;
2557
+ /** Absolute path to the .ts body for a recipe (used by the runner/MainAgent). */
2558
+ getScriptPath(recipe: ScriptRecipe): string;
2559
+ private removeById;
2560
+ private rowToRecipe;
2561
+ private recipeToRow;
2562
+ /** slug of name, with a short id suffix when the bare slug is already taken. */
2563
+ private computeFileBase;
2564
+ private toSlug;
2565
+ private hash;
2566
+ /**
2567
+ * Attach getComponents to the recipe body. The stored `components` column is
2568
+ * cleared at promotion (see promoteToVerified): once the body computes its own
2569
+ * specs, a stale spec array beside a live program is how the wrong one gets
2570
+ * read later. See backend/docs/COMPONENTS-AS-PROGRAM-DESIGN.md § 4.4.
2571
+ */
2572
+ attachComponents(recipeId: string, componentsBody: string): Promise<boolean>;
2573
+ /**
2574
+ * Append (or replace) the `getAnalysis` export on an existing draft body.
2575
+ *
2576
+ * The narrative is authored AFTER execution, so it lands on a file that
2577
+ * already holds a working getData — rewriting the whole body would risk
2578
+ * losing the query that just succeeded. Replaces any earlier getAnalysis so
2579
+ * a retry does not stack duplicate exports.
2580
+ */
2581
+ attachAnalysis(recipeId: string, analysisBody: string): Promise<boolean>;
2582
+ private bodyPath;
2583
+ private readBody;
2584
+ /** Directory holding superseded bodies. Dot-prefixed so IDEs/`ls` hide it. */
2585
+ private get archiveDir();
2586
+ /**
2587
+ * Archive a superseded body as `.versions/<fileBase>.v<n>.ts`.
2588
+ *
2589
+ * Kept out of the main store directory on purpose — see commitEdit step 1.
2590
+ * To roll back: copy the file back over `scripts-store/<fileBase>.ts`.
2591
+ */
2592
+ private writeArchive;
1558
2593
  /**
1559
- * Set when the LLM routed the question to a registered workflow component.
1560
- * When present, the upstream caller should skip component generation and
1561
- * return this workflow as the response.
2594
+ * Move a recipe's archived versions to a new prefix when its fileBase changes,
2595
+ * so all versions of one recipe stay grouped. Without this, two renames would
2596
+ * scatter a single recipe's history across three prefixes in `.versions/` with
2597
+ * nothing linking them back to the live script.
1562
2598
  */
1563
- workflow?: SelectedWorkflow;
1564
- }
1565
- /**
1566
- * Configuration for the multi-agent system.
1567
- * Controls limits, models, and behavior.
1568
- */
1569
- interface AgentConfig {
1570
- /** Max rows a source agent can return (default: 50) */
1571
- maxRowsPerSource: number;
1572
- /** Model for the main agent (routing + analysis in one LLM call) */
1573
- mainAgentModel: string;
1574
- /** Model for source agent query generation */
1575
- sourceAgentModel: string;
1576
- /** API key for LLM calls */
1577
- apiKey?: string;
1578
- /** Max retry attempts per source agent */
1579
- maxRetries: number;
1580
- /** Max tool calling iterations for the main agent loop */
1581
- maxIterations: number;
1582
- /** Global knowledge base context (static, same for all users/questions — cached in system prompt) */
1583
- globalKnowledgeBase?: string;
1584
- /** Per-request knowledge base context (user-specific + query-matched — dynamic, not cached) */
1585
- knowledgeBaseContext?: string;
2599
+ private renameArchives;
2600
+ /** Atomic body write (temp + rename) so concurrent reads never see a partial file. */
2601
+ private writeBody;
2602
+ private unlinkBody;
1586
2603
  }
1587
- /**
1588
- * Default agent configuration
1589
- */
1590
- declare const DEFAULT_AGENT_CONFIG: AgentConfig;
1591
2604
 
1592
2605
  /**
1593
2606
  * Main Agent (Orchestrator)
@@ -1609,7 +2622,71 @@ declare class MainAgent {
1609
2622
  private workflows;
1610
2623
  private config;
1611
2624
  private streamBuffer;
1612
- constructor(externalTools: ExternalTool[], config: AgentConfig, streamBuffer?: StreamBuffer, workflows?: WorkflowDescriptor[]);
2625
+ /**
2626
+ * Optional: when provided, MainAgent exposes the `write_script` /
2627
+ * `execute_script` tools to the LLM and persists drafts to disk via the
2628
+ * store. Headless callers (alert analyzer, metric resolver) omit these to
2629
+ * suppress script authoring entirely — drafts would otherwise leak onto
2630
+ * disk with no caller to promote or clean them up.
2631
+ */
2632
+ private scriptStore;
2633
+ private turnId;
2634
+ private createdFromPrompt;
2635
+ private scriptState;
2636
+ /** Answer-flow component catalog (filtered + projected by the caller). */
2637
+ private componentCatalog;
2638
+ /** Specs accepted by `write_components` this turn; empty until it succeeds. */
2639
+ /**
2640
+ * Entities resolved this turn, appended verbatim to every source dispatch.
2641
+ *
2642
+ * Not left to the model to copy into its intent prose: observed live, the
2643
+ * MainAgent wrote names instead of ids on the first dispatch AND re-spelled
2644
+ * 'F D C LIMITED' as 'FDC Limited', so the source agent fell back to
2645
+ * `PartyName LIKE '%FDC%'` and found 2 of 3 customers. Carrying the ids
2646
+ * structurally makes that impossible rather than instruction-dependent.
2647
+ */
2648
+ private resolvedEntities;
2649
+ private componentSpecs;
2650
+ private componentLayout;
2651
+ private renderComponentAttempts;
2652
+ /**
2653
+ * Fork mode — set when this turn is adapting a near-matching parent script.
2654
+ * In fork mode there is no legitimate "answer with bare text" outcome: the
2655
+ * only correct first move is a tool call (write_script, or a source tool for
2656
+ * schema discovery). We therefore force tool use on the first LLM iteration
2657
+ * so the model can't end its turn with a bare "I'll adapt…" preamble and zero
2658
+ * tool calls. Never set on the fresh-authoring / general-question path.
2659
+ */
2660
+ private forkMode;
2661
+ /**
2662
+ * Edit mode — set when this turn applies a user-directed change to an
2663
+ * existing script. Swaps the system prompt to `agent-main-edit` and stamps
2664
+ * the shadow draft's parentId. Like fork mode there is no legitimate
2665
+ * "answer with bare text" outcome, so tool use is forced on iteration 1.
2666
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 4.
2667
+ */
2668
+ private editContext;
2669
+ /** The recipe's durable rendering choice — see the constructor. */
2670
+ private displayPreference;
2671
+ /**
2672
+ * Per-turn cancellation signal (user hit "Stop"). Set at the top of
2673
+ * handleQuestion and read by the tool handler, the SourceAgent dispatch, and
2674
+ * the script subprocess so an abort tears down every layer of the turn.
2675
+ */
2676
+ private abortSignal?;
2677
+ constructor(externalTools: ExternalTool[], config: AgentConfig, scriptStore?: ScriptStore, turnId?: string, streamBuffer?: StreamBuffer, workflows?: WorkflowDescriptor[], forkMode?: boolean, editContext?: EditContext, componentCatalog?: Component[],
2678
+ /**
2679
+ * The recipe's durable rendering choice, when it has one. A DATA edit
2680
+ * re-authors getComponents from scratch, so without this the user's chart
2681
+ * type is silently dropped whenever anyone changes the SQL.
2682
+ */
2683
+ displayPreference?: {
2684
+ componentTypes: string[];
2685
+ instruction: string;
2686
+ });
2687
+ /** True when the turn is applying a user-directed script edit. */
2688
+ private get editMode();
2689
+ private get scriptingEnabled();
1613
2690
  /**
1614
2691
  * Handle a user question using the multi-agent system.
1615
2692
  *
@@ -1620,7 +2697,98 @@ declare class MainAgent {
1620
2697
  * 4. Direct tools → fn() called directly with LLM params → returns data
1621
2698
  * 5. Generates final analysis text
1622
2699
  */
1623
- handleQuestion(userPrompt: string, apiKey?: string, conversationHistory?: string, streamCallback?: (chunk: string) => void): Promise<AgentResponse>;
2700
+ handleQuestion(userPrompt: string, apiKey?: string, conversationHistory?: string, streamCallback?: (chunk: string) => void, signal?: AbortSignal): Promise<AgentResponse>;
2701
+ /**
2702
+ * Tool definition, with the catalog rendered from the registered `Metadata`
2703
+ * the caller passed in. Generated rather than hand-written so it cannot drift
2704
+ * from what the frontend actually ships.
2705
+ */
2706
+ private buildWriteComponentsToolDef;
2707
+ /**
2708
+ * Validate the agent's component picks against the REAL columns of each bound
2709
+ * dataset. All-or-nothing: any error rejects the whole call and returns the
2710
+ * findings, because a partially-accepted dashboard makes the retry ambiguous.
2711
+ */
2712
+ private validateSpecs;
2713
+ /**
2714
+ * Author the dashboard as a program. Attaches getComponents to the draft, runs
2715
+ * it over the verified rows, then validates the specs it RETURNED — the program
2716
+ * is never trusted because it is a program, exactly as an authored spec is not.
2717
+ */
2718
+ private handleWriteComponents;
2719
+ /**
2720
+ * Author the answer as a program. Runs after execute_script, so the body is
2721
+ * written with the result already known and can react to what it found.
2722
+ *
2723
+ * Rejects a body that types numbers rather than computing them — see
2724
+ * analysis-lint. A hardcoded figure is worse than prose: it freezes into the
2725
+ * recipe and replays unchanged while the data moves underneath it.
2726
+ */
2727
+ private handleWriteAnalysis;
2728
+ private handleWriteScript;
2729
+ private handleExecuteScript;
2730
+ /**
2731
+ * Build the AgentWrittenScript payload the caller will hand to
2732
+ * `ScriptStore.promoteToVerified()`. Only returned when a verified
2733
+ * successful execution is on record.
2734
+ */
2735
+ private buildSavedScript;
2736
+ private normalizeParameterList;
2737
+ /**
2738
+ * Use the schema embedding collection to pre-select relevant tables for
2739
+ * this source + intent. Returns a formatted schema block if confidence is
2740
+ * high (top match ≥ 0.55 and ≥3 candidates), otherwise null.
2741
+ *
2742
+ * When this returns a block, we can skip the SourceAgent's `search_schema`
2743
+ * loop and reduce iteration budget. When it returns null, the SourceAgent
2744
+ * falls back to the existing LLM-driven keyword search (same as today).
2745
+ */
2746
+ /**
2747
+ * Ids + verbatim names for everything resolved this turn, appended by CODE to
2748
+ * each source dispatch so neither omission nor re-spelling by the model can
2749
+ * lose them. Empty string when nothing was resolved, so intents are untouched
2750
+ * for questions that name no entities.
2751
+ *
2752
+ * Also appends `attrs.scopeSql` when the resolved instance carries one —
2753
+ * same "guaranteed by code" reasoning as the ids/names above, extended to
2754
+ * the one attrs field with a documented, cross-entity-type meaning: a
2755
+ * ready-made SQL predicate an entity's index precomputed (see
2756
+ * ENTITY-SEARCH-DESIGN.md's hierarchy-broadening pattern — branch/region/
2757
+ * state entity types attach it so a lane/route question never needs its
2758
+ * own city-matching join). Confirmed real cost of not doing this: a
2759
+ * branch/state resolved with scopeSql sat unused while the source agent
2760
+ * spent 4 failed exploratory queries rediscovering the exact same
2761
+ * branch-id list by hand (Invalid column name 'StateName'/'CityId'/
2762
+ * 'OrganizationLocationId', in that order, ~144s, before landing on ids
2763
+ * that were sitting in scopeSql from the very first resolve_entities
2764
+ * call). Other attrs (code, counts, etc.) are not dumped here — they are
2765
+ * descriptive, not actionable the way a precomputed predicate is, and
2766
+ * bloating every dispatch with all of them for no clear gain isn't worth
2767
+ * it; scopeSql is the one thing worth this guarantee today.
2768
+ */
2769
+ private buildResolvedEntitiesBlock;
2770
+ /** True when the backend registered the entity-search collection. */
2771
+ private get entitySearchEnabled();
2772
+ /**
2773
+ * Compact catalog (type + gloss) for the system prompt. This is what lets the
2774
+ * LLM NAME a concept instead of guessing at our vocabulary — it can infer
2775
+ * that a question is about unpaid money, but not that we call that
2776
+ * `outstanding-balance`. Full `resolution` detail is fetched by the tool.
2777
+ *
2778
+ * Deliberately NOT cached in-process. The token cost is already handled by
2779
+ * prompt caching (the system prompt carries a cache_control breakpoint), and
2780
+ * re-reading a tiny PK-ordered table costs ~nothing. Fetching fresh does not
2781
+ * weaken the prompt cache either: unchanged data renders byte-identical text,
2782
+ * so the prefix still hits. A process cache would only buy a staleness window
2783
+ * in which a newly indexed entity is invisible to the agent.
2784
+ */
2785
+ private loadEntityCatalog;
2786
+ /**
2787
+ * Never throws: a resolver outage must degrade to "nothing resolved" and
2788
+ * leave the agent exactly as it was, not take the whole answer down.
2789
+ */
2790
+ private handleResolveEntities;
2791
+ private preResolveSchema;
1624
2792
  /**
1625
2793
  * Execute a direct tool — call fn() with LLM-provided params, no SourceAgent.
1626
2794
  */
@@ -1686,7 +2854,45 @@ interface LLMOptions {
1686
2854
  temperature?: number;
1687
2855
  topP?: number;
1688
2856
  apiKey?: string;
2857
+ baseURL?: string;
1689
2858
  partial?: (chunk: string) => void;
2859
+ /**
2860
+ * Per-request cancellation. When the caller aborts this signal (user hit
2861
+ * "Stop"), the underlying provider request is cancelled and the call throws
2862
+ * a RequestAbortedError. Threaded into the provider `messages.create` request
2863
+ * options and checked between tool-loop iterations. Currently honored on the
2864
+ * Anthropic path (the agent flow's default provider).
2865
+ */
2866
+ signal?: AbortSignal;
2867
+ /**
2868
+ * Forces a tool call on the FIRST iteration of streamWithTools only
2869
+ * (subsequent iterations revert to auto). Used by fork mode to stop the
2870
+ * model from ending its turn with a bare "I'll adapt the script…" preamble
2871
+ * and zero tool calls. `{ type: 'any' }` lets the model pick which tool
2872
+ * (write_script in the common case, a source tool for schema discovery);
2873
+ * `{ type: 'tool', name }` pins a specific tool. Honored on both the
2874
+ * Anthropic path and the OpenAI/OpenRouter path (mapped to OpenAI's
2875
+ * tool_choice: 'required' / a named function).
2876
+ */
2877
+ firstIterationToolChoice?: {
2878
+ type: 'any';
2879
+ } | {
2880
+ type: 'tool';
2881
+ name: string;
2882
+ };
2883
+ /**
2884
+ * Internal — set only by the OpenRouter wrappers when the target is a Claude
2885
+ * model. Tells the OpenAI-wire path to emit Anthropic `cache_control`
2886
+ * breakpoints (OpenRouter forwards them to Anthropic for prompt caching).
2887
+ * Never set for direct OpenAI/Groq calls, so their requests are unchanged.
2888
+ */
2889
+ _openrouterClaudeCaching?: boolean;
2890
+ /**
2891
+ * Internal — OpenRouter provider-routing preferences (forwarded as the
2892
+ * `provider` body field). Set by the OpenRouter wrappers to steer routing to
2893
+ * a fast backend (e.g. {sort:'throughput'}). Never set for direct OpenAI/Groq.
2894
+ */
2895
+ _openrouterProvider?: Record<string, unknown>;
1690
2896
  }
1691
2897
  interface Tool {
1692
2898
  name: string;
@@ -1708,6 +2914,16 @@ declare class LLM {
1708
2914
  * @returns Normalized system prompt for Anthropic API
1709
2915
  */
1710
2916
  private static _normalizeSystemPrompt;
2917
+ /**
2918
+ * Strip unpaired UTF-16 surrogates from every text field of a message set.
2919
+ *
2920
+ * A lone surrogate (from mid-pair string slicing or corrupt source data)
2921
+ * serializes to a bare `\udXXX` escape that strict JSON parsers — including
2922
+ * the one on Anthropic's API — reject with "no low surrogate in string",
2923
+ * failing the whole request. Sanitizing here, at the single boundary every
2924
+ * provider call flows through, guarantees no request can carry one.
2925
+ */
2926
+ private static _sanitizeMessages;
1711
2927
  /**
1712
2928
  * Log cache usage metrics from Anthropic API response
1713
2929
  * Shows cache hits, costs, and savings
@@ -1724,11 +2940,46 @@ declare class LLM {
1724
2940
  * "claude-sonnet-4-5" → ["anthropic", "claude-sonnet-4-5"] (default)
1725
2941
  */
1726
2942
  private static _parseModel;
2943
+ /**
2944
+ * Map an Anthropic model id (e.g. "claude-sonnet-4-5-20250929") to the OpenRouter slug
2945
+ * (e.g. "claude-sonnet-4.5"). OpenRouter slugs drop the date suffix and use dotted versions.
2946
+ */
2947
+ private static _toOpenRouterSlug;
2948
+ /**
2949
+ * Per-provider proxy base URL. Returns `${SUPERATOM_LLM_PROXY_URL}/<provider>`
2950
+ * when our Cloudflare LLM proxy is configured, else undefined (→ talk to the
2951
+ * provider directly, legacy behaviour). An explicit options.baseURL (e.g.
2952
+ * OpenRouter) always wins and is never overridden. See backend/docs/llm-proxy.md.
2953
+ */
2954
+ private static _proxyBaseURL;
2955
+ private static _openrouterOptions;
2956
+ private static _isRetryableProviderError;
2957
+ private static _withOpenrouterRetry;
2958
+ private static _openrouterText;
2959
+ private static _openrouterStream;
2960
+ private static _openrouterStreamWithTools;
2961
+ /**
2962
+ * Build an Anthropic client. Routes through our Cloudflare LLM proxy when
2963
+ * SUPERATOM_LLM_PROXY_URL is set (each client ships a per-client proxy key as
2964
+ * ANTHROPIC_API_KEY and never holds the real key); otherwise talks to
2965
+ * api.anthropic.com directly. See backend/docs/llm-proxy.md.
2966
+ */
2967
+ private static _anthropicClient;
2968
+ /** True when OpenRouter is configured as a fail-open fallback for Claude. */
2969
+ private static _openrouterAvailable;
2970
+ /** Remap an Anthropic model id to the OpenRouter model path for fail-open. */
2971
+ private static _anthropicFallbackModel;
1727
2972
  private static _anthropicText;
1728
2973
  private static _anthropicStream;
1729
2974
  private static _anthropicStreamWithTools;
1730
2975
  private static _groqText;
1731
2976
  private static _groqStream;
2977
+ /**
2978
+ * Gemini request options carrying the proxy base URL, or undefined → talk to
2979
+ * generativelanguage.googleapis.com directly. The Google SDK takes baseUrl as a
2980
+ * per-model request option, not a constructor arg. See backend/docs/llm-proxy.md.
2981
+ */
2982
+ private static _geminiRequestOptions;
1732
2983
  private static _geminiText;
1733
2984
  private static _geminiStream;
1734
2985
  /**
@@ -1737,8 +2988,28 @@ declare class LLM {
1737
2988
  */
1738
2989
  private static _cleanSchemaForGemini;
1739
2990
  private static _geminiStreamWithTools;
2991
+ /** True for Anthropic/Claude model ids — gates OpenRouter prompt caching. */
2992
+ private static _isClaudeModel;
2993
+ /**
2994
+ * Build the OpenAI-wire system message. For OpenRouter + Claude
2995
+ * (cacheClaude=true) it emits content parts carrying Anthropic
2996
+ * `cache_control` breakpoints (preserving any the caller set, else marking
2997
+ * the last block), so OpenRouter forwards them to Anthropic for prompt
2998
+ * caching. Otherwise it returns a plain flattened string — unchanged for
2999
+ * direct OpenAI/Groq.
3000
+ */
3001
+ private static _openaiSystemMessage;
3002
+ /**
3003
+ * Split an OpenAI-wire usage object. `prompt_tokens` INCLUDES cached tokens,
3004
+ * so we subtract them out (Anthropic-style: input excludes cache reads) and
3005
+ * report cached separately — this makes calculateCost price cache reads at
3006
+ * the discounted rate and reflects OpenRouter prompt-cache savings in logs.
3007
+ */
3008
+ private static _openaiUsage;
1740
3009
  private static _openaiText;
1741
3010
  private static _openaiStream;
3011
+ /** Map the Anthropic-style firstIterationToolChoice to OpenAI's tool_choice. */
3012
+ private static _openaiToolChoice;
1742
3013
  private static _openaiStreamWithTools;
1743
3014
  /**
1744
3015
  * Parse JSON string, handling markdown code blocks and surrounding text
@@ -1840,6 +3111,13 @@ declare class UIBlock {
1840
3111
  private textResponse;
1841
3112
  private actions;
1842
3113
  private createdAt;
3114
+ /**
3115
+ * Which script recipe produced this answer, when a script did. Read on the
3116
+ * NEXT turn so the user can say "use mode instead" and have the matcher
3117
+ * resolve it to a concrete script (the `edit` tier is unreachable without it).
3118
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 1.
3119
+ */
3120
+ private scriptBinding;
1843
3121
  /**
1844
3122
  * Creates a new UIBlock instance
1845
3123
  * @param userQuestion - The user's question or input
@@ -1931,9 +3209,22 @@ declare class UIBlock {
1931
3209
  * Clear all actions
1932
3210
  */
1933
3211
  clearActions(): void;
3212
+ /** The program-generated half of the answer — see setProgramAnswer. */
3213
+ programAnswer?: string | null;
1934
3214
  /**
1935
- * Get creation timestamp
3215
+ * Bind this block to the script recipe that produced its answer.
1936
3216
  */
3217
+ setScriptBinding(binding: Record<string, any> | null): void;
3218
+ /**
3219
+ * The program-generated half of the answer, kept verbatim so a reload can
3220
+ * replace exactly that text without disturbing the streamed narration.
3221
+ */
3222
+ setProgramAnswer(text: string | null): void;
3223
+ getProgramAnswer(): string | null;
3224
+ /**
3225
+ * The script recipe bound to this block, if any.
3226
+ */
3227
+ getScriptBinding(): Record<string, any> | null;
1937
3228
  getCreatedAt(): Date;
1938
3229
  /**
1939
3230
  * Convert UIBlock to JSON-serializable object
@@ -2001,6 +3292,32 @@ declare class Thread {
2001
3292
  * @param currentUIBlockId - ID of current UIBlock to exclude from context (optional)
2002
3293
  * @returns Formatted conversation history string
2003
3294
  */
3295
+ /**
3296
+ * The script recipe bound to the most recent completed UIBlock — i.e. the
3297
+ * script behind the answer the user is currently looking at. Drives the
3298
+ * matcher's `edit` tier: without it, "use mode instead" has no target and
3299
+ * falls through to regeneration.
3300
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 1.
3301
+ */
3302
+ getActiveScriptBinding(currentUIBlockId?: string): Record<string, any> | null;
3303
+ /**
3304
+ * The recent script-backed answers in this thread, newest first — the
3305
+ * candidate set a user-directed edit can target.
3306
+ *
3307
+ * Returning several rather than only the newest is what lets an instruction
3308
+ * name its own target ("use the mode for the WSP one"). With a single
3309
+ * candidate every edit lands on the most recent script, which silently edits
3310
+ * the wrong recipe whenever the user meant an earlier one.
3311
+ *
3312
+ * Deduped by recipeId (newest occurrence wins) so a long editing session on
3313
+ * one script doesn't crowd out the others. Each entry carries the question
3314
+ * that produced it — without that the candidates are indistinguishable.
3315
+ *
3316
+ * In-memory only: dies with the process. The caller falls back to the
3317
+ * persisted bindings when this comes back empty.
3318
+ * See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 1.
3319
+ */
3320
+ getScriptBindings(limit?: number, currentUIBlockId?: string): Record<string, any>[];
2004
3321
  getConversationContext(limit?: number, currentUIBlockId?: string): string;
2005
3322
  /**
2006
3323
  * Convert Thread to JSON-serializable object
@@ -2663,7 +3980,7 @@ declare abstract class BaseLLM {
2663
3980
  * This helps provide intelligent suggestions for follow-up queries
2664
3981
  * For general/conversational questions without components, pass textResponse instead
2665
3982
  */
2666
- generateNextQuestions(originalUserPrompt: string, component?: Component | null, componentData?: Record<string, unknown>, apiKey?: string, conversationHistory?: string, textResponse?: string): Promise<string[]>;
3983
+ generateNextQuestions(originalUserPrompt: string, component?: Component | null, componentData?: Record<string, unknown>, apiKey?: string, conversationHistory?: string, textResponse?: string, signal?: AbortSignal): Promise<string[]>;
2667
3984
  }
2668
3985
 
2669
3986
  interface AnthropicLLMConfig extends BaseLLMConfig {
@@ -2869,6 +4186,187 @@ declare class DashboardConversationHistory {
2869
4186
  }
2870
4187
  declare const dashboardConversationHistory: DashboardConversationHistory;
2871
4188
 
4189
+ /**
4190
+ * Whole-dashboard generation via Pi, a terminal coding agent — as opposed to
4191
+ * DASH_COMP_REQ's single-widget-at-a-time flow. Runs Pi in-process via its
4192
+ * SDK (createAgentSession), not as a subprocess: no shell, no argument
4193
+ * quoting, no stdin/stdout piping, none of the Windows-specific subprocess
4194
+ * issues that came with spawning the `pi` CLI directly.
4195
+ *
4196
+ * Called from sdk-nodejs/src/dashboardAgent/index.ts (DASHBOARD_AGENT_REQ),
4197
+ * which owns the generic streaming/abort machinery (mirrors USER_PROMPT_REQ)
4198
+ * and passes `signal`/`onProgress` alongside the normal params — this stays
4199
+ * within CollectionHandler's loose (params) => Promise<result> typing, no
4200
+ * change needed to that shared type.
4201
+ *
4202
+ * This mechanism is generic and reusable across any deployment. What's
4203
+ * genuinely project-specific — where AGENTS.md lives, which model to use —
4204
+ * is supplied via `DashboardAgentCollectionConfig`, with defaults sensible
4205
+ * enough that most callers don't need to override them (see below). The
4206
+ * data-source tool list and the dashboard's current state both come from
4207
+ * things sdk-nodejs already exposes generically: `sdk.getTools()` (whatever
4208
+ * this deployment registered via `sdk.setTools()`) and `sdk.callCollection
4209
+ * ('dashboards', 'query', ...)` (whatever this deployment already registered
4210
+ * under that name/shape) — no per-deployment callback needed for either.
4211
+ * Same convention on the way out: after a successful run, the prompt and the
4212
+ * full response text are handed to `sdk.callCollection('dashboard-agent-
4213
+ * conversations', 'create', ...)` if this deployment has registered one —
4214
+ * skipped silently otherwise, since conversation history is optional.
4215
+ *
4216
+ * Pi verifies every query against the live database itself (via whatever
4217
+ * local tool-execution bridge the deployment exposes, e.g. an HTTP bridge
4218
+ * on localhost), but does NOT persist the result itself — it writes the
4219
+ * finished DSL to an absolute path inside `runtimeDir`, told to it explicitly
4220
+ * in the prompt, and stops there. This handler reads that file after the run
4221
+ * finishes and returns its content as `dashboard` in the result. The caller
4222
+ * (frontend) is the one that actually saves it, via whatever authenticated
4223
+ * create/update path any other dashboard edit goes through — Pi has no user
4224
+ * session/auth context of its own, so persistence shouldn't happen from
4225
+ * inside it.
4226
+ *
4227
+ * Session persistence: the FIRST call for a dashboardId pays the full cost
4228
+ * (explore KB, discover schema, plan, verify, build). Every call after that
4229
+ * resumes the same session file (SessionManager.open) so Pi has everything
4230
+ * it already learned — it only needs to reason about the new, smaller ask,
4231
+ * not rediscover the whole dashboard from scratch. The session's file path
4232
+ * (AgentSession.sessionFile) is captured right after creation and persisted
4233
+ * in a small local file, keyed by dashboardId, inside `runtimeDir`.
4234
+ */
4235
+ interface DashboardAgentCollectionConfig {
4236
+ /**
4237
+ * Working directory Pi runs from — must contain AGENTS.md. This is a
4238
+ * version-controlled prompt file, so `cwd` is expected to live somewhere
4239
+ * like a `.prompts/` folder alongside the deployment's other prompts.
4240
+ * Default: `<process.cwd()>/.prompts/dashboard-agent` — the same
4241
+ * process.cwd()-based convention PromptLoader already uses for the main
4242
+ * agent's prompts, which needs no explicit override in the common case
4243
+ * (the backend process's own cwd already is its project root).
4244
+ */
4245
+ cwd?: string;
4246
+ /**
4247
+ * Where drafts/, the session-id map, and dashboard.log get written —
4248
+ * separate from `cwd` deliberately, so this deployment's runtime state
4249
+ * (regenerated per session, safe to gitignore) doesn't sit inside the
4250
+ * same folder as the version-controlled AGENTS.md prompt.
4251
+ * Default: `<process.cwd()>/.pi-dashboard-agent-runtime`.
4252
+ */
4253
+ runtimeDir?: string;
4254
+ /** Model provider (default: process.env.PI_AGENT_PROVIDER || 'openrouter'). */
4255
+ provider?: string;
4256
+ /** Model id (default: process.env.PI_AGENT_MODEL || 'anthropic/claude-sonnet-4.5'). */
4257
+ model?: string;
4258
+ /**
4259
+ * true (default): every request starts a brand-new pi session, with the 2
4260
+ * most recent prior responses (if any) injected into the prompt as
4261
+ * context — bounded cost per request, but pi re-explores schema/KB facts
4262
+ * it already verified in an earlier turn on this same dashboard.
4263
+ * false: resumes the same session file across requests on a given
4264
+ * dashboard — pi keeps everything it already learned, but context (and
4265
+ * cost) grows unbounded across turns (one observed turn: 2M+ cache-read
4266
+ * tokens after a handful of edits on the same dashboard).
4267
+ * Default: process.env.PI_AGENT_FRESH_SESSION !== 'false'.
4268
+ */
4269
+ freshSession?: boolean;
4270
+ }
4271
+ declare function registerDashboardAgentCollection(sdk: SuperatomSDK, config?: DashboardAgentCollectionConfig): void;
4272
+
4273
+ /**
4274
+ * ScriptMatcher — LLM-Based Script Matching + Parameter Extraction
4275
+ *
4276
+ * Uses ONE LLM call to:
4277
+ * 1. Pick the best matching script from the library (or "none")
4278
+ * 2. Extract parameter values from the user question
4279
+ *
4280
+ * Why LLM over embeddings:
4281
+ * - Embeddings capture topic similarity ("overstock" ≈ "inventory" ≈ "revenue")
4282
+ * but can't distinguish structurally different questions about the same domain
4283
+ * - LLM understands that "overstock by warehouse" needs a different script than
4284
+ * "revenue by warehouse" even though they're semantically close
4285
+ * - One call does both matching AND parameter extraction
4286
+ *
4287
+ * When script library grows past ~50, add an embedding pre-filter
4288
+ * (ChromaDB narrows to top 10 → LLM picks from those 10).
4289
+ */
4290
+
4291
+ declare class ScriptMatcher {
4292
+ private store;
4293
+ constructor(store: ScriptStore);
4294
+ /**
4295
+ * Find the best matching script for a user question.
4296
+ * Uses ONE LLM call that picks the script AND extracts parameters.
4297
+ * Returns null if no script matches.
4298
+ */
4299
+ match(userPrompt: string, apiKey?: string, model?: string, signal?: AbortSignal,
4300
+ /**
4301
+ * Recent script-backed answers in this thread, newest first. Presence of at
4302
+ * least one is what makes the `edit` tier reachable at all (see the guards
4303
+ * below), and handing over SEVERAL is what lets an instruction name its own
4304
+ * target instead of always hitting the most recent script.
4305
+ */
4306
+ activeBindings?: ScriptBinding[],
4307
+ /**
4308
+ * Recent conversation turns, most recent last. The gate needs this to tell
4309
+ * "this reply is an edit instruction for the active script" apart from
4310
+ * "this reply is answering a clarifying question about a DIFFERENT,
4311
+ * unresolved topic that never became a script" — a bare parameter-shaped
4312
+ * reply ("April 2025 to March 2026") is textually indistinguishable
4313
+ * between those two cases without seeing what the assistant just asked.
4314
+ * Once this tier is decided, nothing downstream re-checks it — the edit
4315
+ * path hands MainAgent a system prompt that explicitly instructs it to
4316
+ * trust the premise and not treat the turn as a new question — so this
4317
+ * gate is the only place that can catch a mismatch.
4318
+ */
4319
+ conversationHistory?: string): Promise<ScriptMatch | null>;
4320
+ /**
4321
+ * Build the script catalog string for the LLM prompt.
4322
+ * Each script gets: index, ID, name, description, and parameter definitions.
4323
+ */
4324
+ private buildScriptCatalog;
4325
+ /**
4326
+ * The recent script-backed answers in this thread — the bounded set an edit
4327
+ * may target. Rendered as its own prompt section (never merged into the
4328
+ * ranked catalog) so the `edit` rules have an unambiguous referent set, and
4329
+ * numbered newest-first so the prompt's "prefer the most recent when the
4330
+ * instruction is ambiguous" tie-break has something to point at.
4331
+ *
4332
+ * Each entry carries the QUESTION that produced it plus the columns it
4333
+ * returned — that is what lets the matcher resolve "use the mode for the WSP
4334
+ * one" instead of blindly taking the newest.
4335
+ */
4336
+ private buildActiveScriptBlock;
4337
+ }
4338
+
4339
+ /**
4340
+ * ScriptRunner — Execute scripts in an isolated tsx subprocess.
4341
+ *
4342
+ * The subprocess approach replaces the earlier `new Function()` eval and gives us:
4343
+ * - Real sandbox (separate process, SIGKILL on timeout).
4344
+ * - Real TypeScript (tsx transpiles on the fly).
4345
+ * - npm imports available to scripts (clustering, stats, geo, etc.).
4346
+ *
4347
+ * Protocol: NDJSON over the child's stdin/stdout. See script-ipc.ts + backend/docs/SCRIPT-FLOW-IMPLEMENTATION.md.
4348
+ */
4349
+
4350
+ interface RunScriptOptions {
4351
+ /** Data sources the script is allowed to query via ctx.query */
4352
+ externalTools: ExternalTool[];
4353
+ /** Optional — for propagating per-query UI progress to the user */
4354
+ streamBuffer?: StreamBuffer;
4355
+ /** Override the wall-clock timeout (default `SCRIPT_TIMEOUT_MS`, 60s). */
4356
+ timeoutMs?: number;
4357
+ /**
4358
+ * Per-turn cancellation signal. When the user hits "Stop" mid-run, the child
4359
+ * process group is SIGKILLed and the run resolves as an aborted failure (the
4360
+ * caller is already unwinding, so the result is discarded).
4361
+ */
4362
+ signal?: AbortSignal;
4363
+ }
4364
+ /**
4365
+ * Execute a recipe by spawning a tsx child on the script's .ts file.
4366
+ * `scriptPath` is the absolute path to the saved `.ts` body.
4367
+ */
4368
+ declare function runScript(recipe: ScriptRecipe, scriptPath: string, params: Record<string, any>, options: RunScriptOptions): Promise<ScriptResult>;
4369
+
2872
4370
  type MessageTypeHandler = (message: IncomingMessage) => void | Promise<void>;
2873
4371
  declare class SuperatomSDK {
2874
4372
  private ws;
@@ -2904,6 +4402,8 @@ declare class SuperatomSDK {
2904
4402
  private lastPong;
2905
4403
  private readonly PING_INTERVAL_MS;
2906
4404
  private readonly PONG_TIMEOUT_MS;
4405
+ private pendingOutbox;
4406
+ private readonly MAX_OUTBOX_SIZE;
2907
4407
  constructor(config: SuperatomSDKConfig);
2908
4408
  /**
2909
4409
  * Initialize PromptLoader and load prompts into memory
@@ -2948,6 +4448,20 @@ declare class SuperatomSDK {
2948
4448
  * Does NOT throw on closed connections — callers can check the return value if needed.
2949
4449
  */
2950
4450
  send(message: Message): boolean;
4451
+ /**
4452
+ * Queue a message that couldn't be delivered because the socket was down,
4453
+ * to be resent once it reconnects. Drops the oldest entry once the bound is
4454
+ * hit — an outage long enough to fill this queue means the oldest queued
4455
+ * responses are for requests the caller has likely already given up on.
4456
+ */
4457
+ private queuePendingMessage;
4458
+ /**
4459
+ * Resend everything queued while the socket was down, now that it's back
4460
+ * up. Uses this.ws.send() directly (not send()) so a message that fails
4461
+ * again goes back through queuePendingMessage() rather than being silently
4462
+ * dropped a second time.
4463
+ */
4464
+ private flushPendingOutbox;
2951
4465
  /**
2952
4466
  * Register a message handler to receive all messages
2953
4467
  */
@@ -2987,6 +4501,14 @@ declare class SuperatomSDK {
2987
4501
  */
2988
4502
  private handlePong;
2989
4503
  private storeComponents;
4504
+ /**
4505
+ * The live, frontend-registered component catalog (name, type, description,
4506
+ * and full prop schema per component) — the same authoritative source
4507
+ * DASH_COMP_REQ's LLM prompt is built from. Exposed so other integrations
4508
+ * (e.g. the dashboard-agent script bridge) can read real component
4509
+ * contracts instead of maintaining a separate, driftable hand-written copy.
4510
+ */
4511
+ getComponents(): Component[];
2990
4512
  /**
2991
4513
  * Set tools for the SDK instance
2992
4514
  */
@@ -2995,6 +4517,16 @@ declare class SuperatomSDK {
2995
4517
  * Get the stored tools
2996
4518
  */
2997
4519
  getTools(): Tool$1[];
4520
+ /**
4521
+ * Call a registered collection operation in-process — no WebSocket
4522
+ * round-trip, since the caller is already running inside this same SDK
4523
+ * instance. Lets SDK-internal features (e.g. the dashboard agent) reuse
4524
+ * whatever collection a deployment has already registered (e.g.
4525
+ * 'dashboards'.'query') by name/convention, instead of requiring a
4526
+ * separate callback purely to re-expose data a collection already serves.
4527
+ * Throws if the collection or operation isn't registered.
4528
+ */
4529
+ callCollection<TResult = any>(collectionName: string, operation: string, params?: any): Promise<TResult>;
2998
4530
  /**
2999
4531
  * Register workflow components for the SDK instance.
3000
4532
  *
@@ -3038,4 +4570,4 @@ declare class SuperatomSDK {
3038
4570
  getConversationSimilarityThreshold(): number;
3039
4571
  }
3040
4572
 
3041
- export { type Action, type AgentConfig, type AgentResponse, BM25L, type BM25LOptions, type BaseLLMConfig, CONTEXT_CONFIG, type CapturedLog, CleanupService, type CollectionHandler, type CollectionOperation, type DBUIBlock, DEFAULT_AGENT_CONFIG, type DatabaseType, type HybridSearchOptions, type IncomingMessage, type KbNodesQueryFilters, type KbNodesRequestPayload, LLM, type LLMUsageEntry, type LogLevel, MainAgent, type Message, type ModelStrategy, type OutputField, type RerankedResult, STORAGE_CONFIG, type SelectedWorkflow, SuperatomSDK, type SuperatomSDKConfig, type TaskType, Thread, ThreadManager, type Tool$1 as Tool, type ToolOutputSchema, UIBlock, UILogCollector, type User, UserManager, type UsersData, type WorkflowDescriptor, anthropicLLM, dashboardConversationHistory, geminiLLM, groqLLM, hybridRerank, llmUsageLogger, logger, openaiLLM, queryCache, rerankChromaResults, rerankConversationResults, userPromptErrorLogger };
4573
+ export { type Action, type AgentConfig, type AgentResponse, BM25L, type BM25LOptions, type BaseLLMConfig, CONTEXT_CONFIG, type CapturedLog, CleanupService, type CollectionHandler, type CollectionOperation, type DBUIBlock, DEFAULT_AGENT_CONFIG, type DashboardAgentCollectionConfig, type DatabaseType, type HybridSearchOptions, type IncomingMessage, type KbNodesQueryFilters, type KbNodesRequestPayload, LLM, type LLMUsageEntry, type LogLevel, MainAgent, type Message, type ModelStrategy, type OutputField, type RerankedResult, STORAGE_CONFIG, type ScriptComponentSpec, ScriptMatcher, type ScriptParameter, type ScriptRecipe, type ScriptRecipeMetaRow, type ScriptRecipeStore, type ScriptResult, ScriptStore, type ScriptStoreOptions, type SelectedWorkflow, SuperatomSDK, type SuperatomSDKConfig, type TaskType, Thread, ThreadManager, type Tool$1 as Tool, type ToolOutputSchema, UIBlock, UILogCollector, type User, UserManager, type UsersData, type WorkflowDescriptor, anthropicLLM, dashboardConversationHistory, geminiLLM, groqLLM, hybridRerank, llmUsageLogger, logger, normalizeScriptBody, openaiLLM, queryCache, registerDashboardAgentCollection, rerankChromaResults, rerankConversationResults, resolveScriptRecipeStore, runScript, userPromptErrorLogger };