@superatomai/sdk-node 0.0.53-dsp → 0.0.53-mds
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 +359 -2614
- package/dist/index.d.ts +359 -2614
- package/dist/index.js +12022 -21916
- package/dist/index.mjs +12073 -21953
- package/package.json +5 -11
- package/dist/userResponse/scripts/script-bootstrap.d.mts +0 -2
- package/dist/userResponse/scripts/script-bootstrap.d.ts +0 -2
- package/dist/userResponse/scripts/script-bootstrap.js +0 -539
- package/dist/userResponse/scripts/script-bootstrap.mjs +0 -537
package/dist/index.d.ts
CHANGED
|
@@ -1,1073 +1,21 @@
|
|
|
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
|
-
/**
|
|
295
|
-
* The recipe's own version number at the moment THIS turn ran — not
|
|
296
|
-
* necessarily the recipe's current version. A later edit bumps the live
|
|
297
|
-
* version, so without this a past turn's binding would silently point at
|
|
298
|
-
* whatever the recipe looks like today instead of what actually produced
|
|
299
|
-
* that answer. Absent on bindings created before this field existed.
|
|
300
|
-
*/
|
|
301
|
-
version?: number;
|
|
302
|
-
/** Params the script ran with — the edit's starting point. */
|
|
303
|
-
params: Record<string, any>;
|
|
304
|
-
/** Recipe name at bind time (matcher catalog + user-facing confirmation). */
|
|
305
|
-
name: string;
|
|
306
|
-
/** Columns the last run returned — grounds the editor without a re-query. */
|
|
307
|
-
columns?: string[];
|
|
308
|
-
/**
|
|
309
|
-
* The question that produced this answer. Required for disambiguation when a
|
|
310
|
-
* thread ran several scripts — without it the candidates are just names and
|
|
311
|
-
* the matcher cannot resolve "use the mode for the WSP one".
|
|
312
|
-
*/
|
|
313
|
-
userPrompt?: string;
|
|
314
|
-
/**
|
|
315
|
-
* The polished analysis text this script actually produced last time it ran
|
|
316
|
-
* (the same programAnswer Thread.getConversationContext() shows elsewhere).
|
|
317
|
-
* Carried alongside the script's own shape (columns, params) so the matcher
|
|
318
|
-
* sees "what did this script actually say" right next to "what can I ask it
|
|
319
|
-
* to change", instead of needing a separate conversation-history transcript
|
|
320
|
-
* that would otherwise just repeat the same question this block already
|
|
321
|
-
* states. This is why ScriptMatcher's own prompt no longer receives a raw
|
|
322
|
-
* conversation-history transcript at all — this field is what replaced it.
|
|
323
|
-
*/
|
|
324
|
-
answerSummary?: string;
|
|
325
|
-
}
|
|
326
|
-
/**
|
|
327
|
-
* Result from the LLM-based script matcher.
|
|
328
|
-
*
|
|
329
|
-
* For `tier: 'high'`, `extractedParams` carries the values to pass to the
|
|
330
|
-
* existing script. For `tier: 'near'`, `gaps` and `modificationHint` describe
|
|
331
|
-
* what the fork-author needs to change in the parent body.
|
|
332
|
-
*/
|
|
333
|
-
interface ScriptMatch {
|
|
334
|
-
/** The matched script recipe */
|
|
335
|
-
recipe: ScriptRecipe;
|
|
336
|
-
/** Match tier — see MatchTier docs */
|
|
337
|
-
tier: MatchTier;
|
|
338
|
-
/** Similarity score (0-1, derived from LLM tier) */
|
|
339
|
-
similarity: number;
|
|
340
|
-
/**
|
|
341
|
-
* Legacy confidence level. Mirrors `tier === 'high'`/`'near'` for now;
|
|
342
|
-
* kept so existing callers compile while we migrate to tier-based logic.
|
|
343
|
-
*/
|
|
344
|
-
confidence: 'high' | 'medium';
|
|
345
|
-
/** Parameters extracted from the user question by the LLM (tier='high') */
|
|
346
|
-
extractedParams?: Record<string, any>;
|
|
347
|
-
/**
|
|
348
|
-
* Proper nouns the question named, VERBATIM, with the parameter each fills.
|
|
349
|
-
*
|
|
350
|
-
* The matcher must NOT resolve these itself. Observed live: it substituted the
|
|
351
|
-
* customer name "PREMER ENRGES PHOTOOTAIC" into an id parameter believing that
|
|
352
|
-
* "the runtime will resolve the customer name to its PartyId(s)" — nothing on
|
|
353
|
-
* the replay path does, and `WHERE BillingPartyId IN (PREMER ENRGES
|
|
354
|
-
* PHOTOOTAIC)` reached SQL. Reported here, the runtime resolves them before
|
|
355
|
-
* replay and rejects the match when one cannot be resolved.
|
|
356
|
-
*/
|
|
357
|
-
mentions?: Array<{
|
|
358
|
-
text: string;
|
|
359
|
-
param?: string;
|
|
360
|
-
}>;
|
|
361
|
-
/** Business concepts the question relies on (e.g. "outstanding balance"). */
|
|
362
|
-
entityTypes?: string[];
|
|
363
|
-
/** What the user question needs that the parent doesn't cover (tier='near') */
|
|
364
|
-
gaps?: string[];
|
|
365
|
-
/** One-sentence description of the change the fork-author should make (tier='near') */
|
|
366
|
-
modificationHint?: string;
|
|
367
|
-
/**
|
|
368
|
-
* Which HALF of the recipe the edit targets (tier='edit'). A recipe has two
|
|
369
|
-
* independently editable halves:
|
|
370
|
-
* - 'data' — the scriptBody: how the rows are produced (aggregation,
|
|
371
|
-
* filters, joins, grouping). Runs MainAgent in edit mode.
|
|
372
|
-
* - 'display' — the component specs: how those SAME rows are shown (chart
|
|
373
|
-
* type, orientation, columns, labels). Replays the proven SQL
|
|
374
|
-
* and regenerates the specs — never authors a script.
|
|
375
|
-
* Defaults to 'data' when the matcher omits it.
|
|
376
|
-
*/
|
|
377
|
-
editTarget?: 'data' | 'display';
|
|
378
|
-
/**
|
|
379
|
-
* Self-contained restatement of the change the user asked for (tier='edit').
|
|
380
|
-
* MUST have pronouns/deixis resolved ("this", "it", "that column") — the edit
|
|
381
|
-
* prompt never sees the conversation history, so an unresolved instruction is
|
|
382
|
-
* unusable downstream.
|
|
383
|
-
*/
|
|
384
|
-
editInstruction?: string;
|
|
385
|
-
/** Why the matcher made this choice (for logs and telemetry) */
|
|
386
|
-
reasoning?: string;
|
|
387
|
-
}
|
|
388
|
-
|
|
389
|
-
/**
|
|
390
|
-
* script-ipc.ts — Protocol definitions for parent/child IPC.
|
|
391
|
-
*
|
|
392
|
-
* Transport: newline-delimited JSON over the child's stdin/stdout.
|
|
393
|
-
* stderr is passed through for uncaught exceptions and compile errors.
|
|
394
|
-
*
|
|
395
|
-
* See backend/docs/SCRIPT-FLOW-IMPLEMENTATION.md § IPC Bridge.
|
|
396
|
-
*/
|
|
397
|
-
|
|
398
|
-
/**
|
|
399
|
-
* What getAnalysis returns. `analysis` is the narrative and `summary` the short
|
|
400
|
-
* bullets the markdown block binds to — siblings over one dataset, never a
|
|
401
|
-
* summary OF the narrative. See backend/docs/ANALYSIS-AS-PROGRAM-DESIGN.md § 4.3.
|
|
402
|
-
*/
|
|
403
|
-
interface AnalysisOutput {
|
|
404
|
-
analysis?: string;
|
|
405
|
-
summary?: string[];
|
|
406
|
-
method?: string;
|
|
407
|
-
}
|
|
408
|
-
|
|
409
|
-
/**
|
|
410
|
-
* StreamBuffer - Buffered streaming utility for smoother text delivery
|
|
411
|
-
* Batches small chunks together and flushes at regular intervals
|
|
412
|
-
*/
|
|
413
|
-
type StreamCallback = (chunk: string) => void;
|
|
414
|
-
/**
|
|
415
|
-
* StreamBuffer class for managing buffered streaming output
|
|
416
|
-
* Provides smooth text delivery by batching small chunks
|
|
417
|
-
*/
|
|
418
|
-
declare class StreamBuffer {
|
|
419
|
-
private buffer;
|
|
420
|
-
private flushTimer;
|
|
421
|
-
private callback;
|
|
422
|
-
private fullText;
|
|
423
|
-
constructor(callback?: StreamCallback);
|
|
424
|
-
/**
|
|
425
|
-
* Check if the buffer has a callback configured
|
|
426
|
-
*/
|
|
427
|
-
hasCallback(): boolean;
|
|
428
|
-
/**
|
|
429
|
-
* Get all text that has been written (including already flushed)
|
|
430
|
-
*/
|
|
431
|
-
getFullText(): string;
|
|
432
|
-
/**
|
|
433
|
-
* Write a chunk to the buffer
|
|
434
|
-
* Large chunks or chunks with newlines are flushed immediately
|
|
435
|
-
* Small chunks are batched and flushed after a short interval
|
|
436
|
-
*
|
|
437
|
-
* @param chunk - Text chunk to write
|
|
438
|
-
*/
|
|
439
|
-
write(chunk: string): void;
|
|
440
|
-
/**
|
|
441
|
-
* Flush the buffer immediately
|
|
442
|
-
* Call this before tool execution or other operations that need clean output
|
|
443
|
-
*/
|
|
444
|
-
flush(): void;
|
|
445
|
-
/**
|
|
446
|
-
* Internal flush implementation
|
|
447
|
-
*/
|
|
448
|
-
private flushNow;
|
|
449
|
-
/**
|
|
450
|
-
* Clean up resources
|
|
451
|
-
* Call this when done with the buffer
|
|
452
|
-
*/
|
|
453
|
-
dispose(): void;
|
|
454
|
-
}
|
|
455
|
-
|
|
456
|
-
/**
|
|
457
|
-
* ToolExecutorService - Handles execution of SQL queries and external tools
|
|
458
|
-
* Extracted from BaseLLM.generateTextResponse for better separation of concerns
|
|
459
|
-
*/
|
|
460
|
-
|
|
461
|
-
/**
|
|
462
|
-
* External tool definition
|
|
463
|
-
*/
|
|
464
|
-
interface ExternalTool {
|
|
465
|
-
id: string;
|
|
466
|
-
name: string;
|
|
467
|
-
description?: string;
|
|
468
|
-
/** Tool type: "source" = routed through SourceAgent, "direct" = called directly by MainAgent */
|
|
469
|
-
toolType?: 'source' | 'direct';
|
|
470
|
-
/** Full untruncated schema for source agent (all columns visible) */
|
|
471
|
-
fullSchema?: string;
|
|
472
|
-
/** Schema size tier: small (≤50 tables), medium (51-200), large (201-500), very_large (500+) */
|
|
473
|
-
schemaTier?: string;
|
|
474
|
-
/** Schema search function for very_large tier — keyword search over entities */
|
|
475
|
-
schemaSearchFn?: (keywords: string[]) => string;
|
|
476
|
-
/** `signal` fires when the user hits Stop mid-query — passed through to the backend's SourceTool.fn. */
|
|
477
|
-
fn: (input: any, signal?: AbortSignal) => Promise<any>;
|
|
478
|
-
limit?: number;
|
|
479
|
-
outputSchema?: any;
|
|
480
|
-
executionType?: 'immediate' | 'deferred';
|
|
481
|
-
userProvidedData?: any;
|
|
482
|
-
params?: Record<string, any>;
|
|
483
|
-
}
|
|
484
|
-
/**
|
|
485
|
-
* Executed tool tracking info
|
|
486
|
-
*/
|
|
487
|
-
interface ExecutedToolInfo {
|
|
488
|
-
id: string;
|
|
489
|
-
name: string;
|
|
490
|
-
params: any;
|
|
491
|
-
result: {
|
|
492
|
-
_totalRecords: number;
|
|
493
|
-
_recordsShown: number;
|
|
494
|
-
_metadata?: any;
|
|
495
|
-
_sampleData: any[];
|
|
496
|
-
/** Bounded summary over the FULL fetched result (complete structure). */
|
|
497
|
-
_summary?: any;
|
|
498
|
-
/** Up to MAIN_AGENT_COMPLETE_ROWS rows — the complete result when small. */
|
|
499
|
-
_mainAgentRows?: any[];
|
|
500
|
-
};
|
|
501
|
-
outputSchema?: any;
|
|
502
|
-
sourceSchema?: string;
|
|
503
|
-
sourceType?: string;
|
|
504
|
-
}
|
|
505
|
-
|
|
506
|
-
/**
|
|
507
|
-
* Multi-Agent Architecture Types
|
|
508
|
-
*
|
|
509
|
-
* Defines interfaces for the hierarchical agent system:
|
|
510
|
-
* - Main Agent: ONE LLM.streamWithTools() call with source agent tools
|
|
511
|
-
* - Source Agents: independent agents that query individual data sources
|
|
512
|
-
*
|
|
513
|
-
* The main agent sees only source summaries. When it calls a source tool,
|
|
514
|
-
* the SourceAgent runs independently (own LLM, own retries) and returns clean data.
|
|
515
|
-
*/
|
|
516
|
-
|
|
517
|
-
/**
|
|
518
|
-
* Per-entity detail: name, row count, and column names.
|
|
519
|
-
* Gives the main agent enough context to route to the right source.
|
|
520
|
-
*/
|
|
521
|
-
interface EntityDetail {
|
|
522
|
-
/** Entity name (table, sheet, endpoint) */
|
|
523
|
-
name: string;
|
|
524
|
-
/** Approximate row count */
|
|
525
|
-
rowCount?: number;
|
|
526
|
-
/** Column/field names */
|
|
527
|
-
columns: string[];
|
|
528
|
-
/** Entity-level semantic summary (what the table means) — for main-agent routing. */
|
|
529
|
-
summary?: string;
|
|
530
|
-
}
|
|
531
|
-
/**
|
|
532
|
-
* Representation of a data source for the main agent.
|
|
533
|
-
* Contains entity names WITH column names so the LLM can route accurately.
|
|
534
|
-
*/
|
|
535
|
-
interface SourceSummary {
|
|
536
|
-
/** Source ID (matches tool ID prefix) */
|
|
537
|
-
id: string;
|
|
538
|
-
/** Human-readable source name */
|
|
539
|
-
name: string;
|
|
540
|
-
/** Source type: postgres, excel, rest_api, etc. */
|
|
541
|
-
type: string;
|
|
542
|
-
/** Brief description of what data this source contains */
|
|
543
|
-
description: string;
|
|
544
|
-
/** Detailed entity info with column names for routing */
|
|
545
|
-
entityDetails: EntityDetail[];
|
|
546
|
-
/** The tool ID associated with this source */
|
|
547
|
-
toolId: string;
|
|
548
|
-
}
|
|
549
|
-
/**
|
|
550
|
-
* What a source agent returns after querying its data source.
|
|
551
|
-
* The main agent uses this to analyze and compose the final response.
|
|
552
|
-
*/
|
|
553
|
-
interface SourceAgentResult {
|
|
554
|
-
/** Source ID */
|
|
555
|
-
sourceId: string;
|
|
556
|
-
/** Source name */
|
|
557
|
-
sourceName: string;
|
|
558
|
-
/** Whether the query succeeded */
|
|
559
|
-
success: boolean;
|
|
560
|
-
/** Result data rows — bounded to MAIN_AGENT_COMPLETE_ROWS (Stage 2: what the LLM
|
|
561
|
-
* sees verbatim in its own prompt). NOT render-sized — do not bind a UI
|
|
562
|
-
* component's dataset to this field; use renderData instead. */
|
|
563
|
-
data: any[];
|
|
564
|
-
/** Result data rows bounded to MAX_ROWS_RENDERED (Stage 3: render-appropriate).
|
|
565
|
-
* This is what already-fetched (Stage 1, <=MAX_ROWS_FETCHED) rows look like
|
|
566
|
-
* before Stage 2 further truncates `data` down for the LLM's own context —
|
|
567
|
-
* use this, not `data`, whenever binding a UI component's dataset. */
|
|
568
|
-
renderData: any[];
|
|
569
|
-
/** Metadata about the query execution */
|
|
570
|
-
metadata: SourceAgentMetadata;
|
|
571
|
-
/** Tool execution info for the last successful query (backward compat) */
|
|
572
|
-
executedTool: ExecutedToolInfo;
|
|
573
|
-
/** All successful tool executions (primary + follow-up queries) */
|
|
574
|
-
allExecutedTools?: ExecutedToolInfo[];
|
|
575
|
-
/** Error message if failed */
|
|
576
|
-
error?: string;
|
|
577
|
-
}
|
|
578
|
-
interface SourceAgentMetadata {
|
|
579
|
-
/** Total rows that matched the query (before limit) */
|
|
580
|
-
totalRowsMatched: number;
|
|
581
|
-
/** Rows actually returned (after limit) */
|
|
582
|
-
rowsReturned: number;
|
|
583
|
-
/** Whether the result was truncated by the row limit */
|
|
584
|
-
isLimited: boolean;
|
|
585
|
-
/** The query/params that were executed */
|
|
586
|
-
queryExecuted?: string;
|
|
587
|
-
/** Execution time in milliseconds */
|
|
588
|
-
executionTimeMs: number;
|
|
589
|
-
}
|
|
590
|
-
/**
|
|
591
|
-
* A pre-built, multi-step UI flow registered with the SDK.
|
|
592
|
-
*
|
|
593
|
-
* When the main agent decides a user's question matches a workflow's whenToUse
|
|
594
|
-
* trigger, it picks the workflow instead of running source agents / generating
|
|
595
|
-
* dashboard components. The LLM extracts the workflow's required props from the
|
|
596
|
-
* prompt (using `propsSchema` as the tool input_schema) and the SDK returns the
|
|
597
|
-
* workflow component directly — no analysis text, no chart generation. The
|
|
598
|
-
* frontend renders the registered workflow component with the LLM-extracted
|
|
599
|
-
* props.
|
|
600
|
-
*/
|
|
601
|
-
interface WorkflowDescriptor {
|
|
602
|
-
/** Unique workflow id (used as the LLM tool name) */
|
|
603
|
-
id: string;
|
|
604
|
-
/** Component name on the frontend (matches the registered React component) */
|
|
605
|
-
name: string;
|
|
606
|
-
/** Short human-readable description of what this workflow does */
|
|
607
|
-
description: string;
|
|
608
|
-
/**
|
|
609
|
-
* 1–2 sentence trigger condition. The LLM uses this to decide if the
|
|
610
|
-
* user's prompt matches this workflow. Be specific — e.g.
|
|
611
|
-
* "User wants to *initiate* an inventory transfer (review + submit POs),
|
|
612
|
-
* not just see analysis or charts."
|
|
613
|
-
*/
|
|
614
|
-
whenToUse: string;
|
|
615
|
-
/**
|
|
616
|
-
* JSON-schema-style description of the props the workflow needs. Becomes
|
|
617
|
-
* the LLM tool's input_schema, so the model fills these from the prompt.
|
|
618
|
-
* Use the same shape as `params` on direct tools — string descriptors with
|
|
619
|
-
* an optional "(optional)" suffix.
|
|
620
|
-
*
|
|
621
|
-
* Example:
|
|
622
|
-
* ```
|
|
623
|
-
* {
|
|
624
|
-
* selectedStore: 'object — { id, name } of the source branch',
|
|
625
|
-
* minROI: 'number (optional) — only show transfers with ROI ≥ this',
|
|
626
|
-
* }
|
|
627
|
-
* ```
|
|
628
|
-
*/
|
|
629
|
-
propsSchema: Record<string, string>;
|
|
630
|
-
/**
|
|
631
|
-
* Optional: static prop defaults merged with LLM-extracted props before
|
|
632
|
-
* the component is returned. Useful for things like the embedded
|
|
633
|
-
* `externalTool` config that the workflow uses to fetch its own data.
|
|
634
|
-
*/
|
|
635
|
-
defaultProps?: Record<string, any>;
|
|
636
|
-
}
|
|
637
|
-
/**
|
|
638
|
-
* The workflow selection captured during a routing call.
|
|
639
|
-
* Set on AgentResponse when the LLM picks a workflow tool.
|
|
640
|
-
*/
|
|
641
|
-
interface SelectedWorkflow {
|
|
642
|
-
/** Component name (matches WorkflowDescriptor.name) */
|
|
643
|
-
name: string;
|
|
644
|
-
/** Props extracted from the prompt + merged with workflow.defaultProps */
|
|
645
|
-
props: Record<string, any>;
|
|
646
|
-
}
|
|
647
|
-
/**
|
|
648
|
-
* Set when this turn applies a user-directed edit to an existing script instead
|
|
649
|
-
* of authoring a new one. MainAgent keeps the SAME harness (tools, loop,
|
|
650
|
-
* write_script/execute_script verification) and swaps only the system prompt —
|
|
651
|
-
* `agent-main-edit` instead of `agent-main`.
|
|
652
|
-
*
|
|
653
|
-
* The two framings contradict each other on whether to query a source first, so
|
|
654
|
-
* they must never be resident in one rendered prompt.
|
|
655
|
-
* See backend/docs/SCRIPT-EDIT-DESIGN.md § D3.
|
|
656
|
-
*/
|
|
657
|
-
interface EditContext {
|
|
658
|
-
/** Recipe being edited — the shadow draft records it as parentId. */
|
|
659
|
-
recipeId: string;
|
|
660
|
-
parentName: string;
|
|
661
|
-
parentBody: string;
|
|
662
|
-
/** Self-contained restatement of the change (from the matcher). */
|
|
663
|
-
instruction: string;
|
|
664
|
-
/** Columns the last run returned — grounds the edit without a re-query. */
|
|
665
|
-
lastResultColumns?: string[];
|
|
666
|
-
/** Rendered parameter list of the parent, for the prompt. */
|
|
667
|
-
parentParams?: string;
|
|
668
|
-
}
|
|
669
|
-
/**
|
|
670
|
-
* The complete response from the multi-agent system.
|
|
671
|
-
* Contains everything needed for text display + component generation.
|
|
672
|
-
*/
|
|
673
|
-
interface AgentResponse {
|
|
674
|
-
/** Generated text response (analysis of the data) */
|
|
675
|
-
text: string;
|
|
676
|
-
/**
|
|
677
|
-
* Program-generated narrative when the script exported getAnalysis. `text`
|
|
678
|
-
* already carries `analysis.analysis`; this also exposes `summary`, which
|
|
679
|
-
* the markdown block binds to instead of being an LLM summary of the prose.
|
|
680
|
-
*/
|
|
681
|
-
analysis?: AnalysisOutput;
|
|
682
|
-
/** All executed tools across all source agents (for component generation) */
|
|
683
|
-
executedTools: ExecutedToolInfo[];
|
|
684
|
-
/** Individual results from each source agent */
|
|
685
|
-
sourceResults: SourceAgentResult[];
|
|
686
|
-
/**
|
|
687
|
-
* Populated when MainAgent wrote AND successfully executed a script during its turn.
|
|
688
|
-
* Caller (agent-user-response.ts) persists it via ScriptStore.save().
|
|
689
|
-
* Absent when MainAgent didn't write one (trivial question / all attempts failed).
|
|
690
|
-
*/
|
|
691
|
-
savedScript?: AgentWrittenScript;
|
|
692
|
-
/** Failed execute_script tool_result texts this turn, in order — see RunTrace.script.failedAttempts. */
|
|
693
|
-
failedScriptAttempts?: string[];
|
|
694
|
-
/**
|
|
695
|
-
* Set when the LLM routed the question to a registered workflow component.
|
|
696
|
-
* When present, the upstream caller should skip component generation and
|
|
697
|
-
* return this workflow as the response.
|
|
698
|
-
*/
|
|
699
|
-
workflow?: SelectedWorkflow;
|
|
700
|
-
/**
|
|
701
|
-
* Validated component specs the agent authored via `write_components`.
|
|
702
|
-
* When present the caller assembles the dashboard from these instead of
|
|
703
|
-
* running the component-generation LLM. Absent when the agent didn't call
|
|
704
|
-
* the tool — the caller then falls back to `generateScriptComponents`.
|
|
705
|
-
* See backend/docs/COMPONENT-GENERATION-V2.md §2.2.
|
|
706
|
-
*/
|
|
707
|
-
componentSpecs?: ScriptComponentSpec[];
|
|
708
|
-
/** Layout title/description from the same `write_components` call. */
|
|
709
|
-
componentLayout?: {
|
|
710
|
-
title: string;
|
|
711
|
-
description?: string;
|
|
712
|
-
};
|
|
713
|
-
}
|
|
714
|
-
/**
|
|
715
|
-
* A script MainAgent authored + verified during its turn. Shape aligns with
|
|
716
|
-
* what ScriptStore.save() needs — minus store-assigned fields (id, timestamps, counts).
|
|
717
|
-
*/
|
|
718
|
-
interface AgentWrittenScript {
|
|
719
|
-
/**
|
|
720
|
-
* `ScriptRecipe.id` of the draft that was authored + verified during this turn.
|
|
721
|
-
* The caller passes this to `ScriptStore.promoteToVerified(recipeId, …)` to
|
|
722
|
-
* flip the draft to verified status and (when possible) drop the turn-suffix
|
|
723
|
-
* from its filename.
|
|
724
|
-
*/
|
|
725
|
-
recipeId: string;
|
|
726
|
-
name: string;
|
|
727
|
-
intentDescription: string;
|
|
728
|
-
tags: string[];
|
|
729
|
-
parameters: Array<{
|
|
730
|
-
name: string;
|
|
731
|
-
type: 'string' | 'number' | 'date' | 'date_range' | 'enum' | 'boolean';
|
|
732
|
-
required: boolean;
|
|
733
|
-
default?: any;
|
|
734
|
-
enumValues?: Record<string, string>;
|
|
735
|
-
description: string;
|
|
736
|
-
}>;
|
|
737
|
-
scriptBody: string;
|
|
738
|
-
/** Source IDs referenced by the script (extracted from ctx.query calls) */
|
|
739
|
-
sourceIds: string[];
|
|
740
|
-
/** Tables referenced in the script's SQL (regex-extracted) */
|
|
741
|
-
tables: string[];
|
|
742
|
-
/** Executed queries from the verified run — fed to component generation */
|
|
743
|
-
executedQueries: Array<{
|
|
744
|
-
sourceId: string;
|
|
745
|
-
sourceName: string;
|
|
746
|
-
sql: string;
|
|
747
|
-
data: any[];
|
|
748
|
-
count: number;
|
|
749
|
-
totalCount?: number;
|
|
750
|
-
executionTimeMs: number;
|
|
751
|
-
/**
|
|
752
|
-
* True for synthetic entries (ctx.emit datasets, the computed:_final
|
|
753
|
-
* post-JS data). The component generator routes virtual sources through
|
|
754
|
-
* the script_dataset sentinel toolId so the frontend resolves them via
|
|
755
|
-
* queryCache instead of attempting to re-execute SQL.
|
|
756
|
-
*/
|
|
757
|
-
virtual?: boolean;
|
|
758
|
-
}>;
|
|
759
|
-
/** The tool_result JSON MainAgent's LLM got back from execute_script — see RunTrace.script.executionResult. */
|
|
760
|
-
executionResult?: string;
|
|
761
|
-
}
|
|
762
|
-
/**
|
|
763
|
-
* Debug trace for a single chat_agent turn — which KB/schema nodes were
|
|
764
|
-
* retrieved and considered, and which script (if any) produced the answer.
|
|
765
|
-
* Persisted separately from the answer itself (fusion-5's
|
|
766
|
-
* `conversation_traces` table, written via `saveTrace`), never sent through
|
|
767
|
-
* `analyticsClient` (data-residency — see design doc §5).
|
|
768
|
-
*/
|
|
769
|
-
interface RunTrace {
|
|
770
|
-
version: 1;
|
|
771
|
-
kbNodes: {
|
|
772
|
-
/**
|
|
773
|
-
* Always-on nodes included regardless of the question (getGlobalKnowledgeBase).
|
|
774
|
-
* `content` is the node's full text AS IT WAS at retrieval time — captured so a
|
|
775
|
-
* later edit/delete of the KB node doesn't erase what the LLM actually saw.
|
|
776
|
-
*/
|
|
777
|
-
global: Array<{
|
|
778
|
-
kbId: string;
|
|
779
|
-
title: string;
|
|
780
|
-
content?: string;
|
|
781
|
-
}>;
|
|
782
|
-
/** Semantically matched for this specific question (getKnowledgeBase). Same `content` reasoning as above. */
|
|
783
|
-
query: Array<{
|
|
784
|
-
kbId: string;
|
|
785
|
-
title: string;
|
|
786
|
-
similarity?: number;
|
|
787
|
-
content?: string;
|
|
788
|
-
}>;
|
|
789
|
-
};
|
|
790
|
-
schemaNodes: {
|
|
791
|
-
/** MainAgent's cross-source prefilter — which sources were even considered. */
|
|
792
|
-
routing: Array<{
|
|
793
|
-
sourceId: string;
|
|
794
|
-
sourceName?: string;
|
|
795
|
-
similarity: number;
|
|
796
|
-
}>;
|
|
797
|
-
/** SourceAgent-scope per-source table resolution (MainAgent.preResolveSchema). */
|
|
798
|
-
preResolve: Array<{
|
|
799
|
-
sourceId: string;
|
|
800
|
-
table?: string;
|
|
801
|
-
description?: string;
|
|
802
|
-
similarity: number;
|
|
803
|
-
}>;
|
|
804
|
-
/**
|
|
805
|
-
* The exact {{SOURCE_SUMMARIES}} text injected into MainAgent's system prompt
|
|
806
|
-
* (agent-prompt-builder.ts's formatSummariesForPrompt output) — every
|
|
807
|
-
* registered source's catalog entry, not retrieval-specific, captured once per
|
|
808
|
-
* turn. This is what the main agent actually saw when deciding which source(s)
|
|
809
|
-
* to call.
|
|
810
|
-
*/
|
|
811
|
-
mainAgentCatalog?: string;
|
|
812
|
-
/**
|
|
813
|
-
* One entry per SourceAgent dispatch (a source called twice in one turn gets
|
|
814
|
-
* two entries) — the exact {{FULL_SCHEMA}} text injected into that
|
|
815
|
-
* SourceAgent's own system prompt, however it was sourced, plus any
|
|
816
|
-
* search_schema follow-up lookups it made mid-conversation when the schema
|
|
817
|
-
* shown wasn't enough.
|
|
818
|
-
*/
|
|
819
|
-
sourceAgentSchemas: Array<{
|
|
820
|
-
sourceId: string;
|
|
821
|
-
sourceName?: string;
|
|
822
|
-
/**
|
|
823
|
-
* The exact intent text this dispatch's own prompt was built from —
|
|
824
|
-
* captured in SourceAgent.buildPrompt, so it ALREADY includes the
|
|
825
|
-
* resolved-entities and resolved-concepts blocks MainAgent appends by
|
|
826
|
-
* code before calling execute() (see buildResolvedEntitiesBlock /
|
|
827
|
-
* buildResolvedConceptsBlock) — not just what the LLM itself wrote.
|
|
828
|
-
*/
|
|
829
|
-
intent: string;
|
|
830
|
-
/** How `schemaText` was sourced — see SourceAgent.buildPrompt's fullSchema fallback chain. */
|
|
831
|
-
method: 'preresolved-embedding' | 'tool-full-schema' | 'tool-description' | 'none';
|
|
832
|
-
schemaText: string;
|
|
833
|
-
/** In call order — each search_schema tool call this SourceAgent made, and the exact result text handed back to its own LLM. */
|
|
834
|
-
searchSchemaLookups: Array<{
|
|
835
|
-
keywords: string[];
|
|
836
|
-
result: string;
|
|
837
|
-
}>;
|
|
838
|
-
/** The tool_result text MainAgent's LLM read back for this dispatch (formatResultForMainAgent output). */
|
|
839
|
-
result?: string;
|
|
840
|
-
/**
|
|
841
|
-
* The full resolved-concept bodies this dispatch's intent was built
|
|
842
|
-
* with (the same content already baked into `intent` via
|
|
843
|
-
* buildResolvedConceptsBlock, surfaced here structured/separately so a
|
|
844
|
-
* trace reader doesn't have to parse it back out of the raw text).
|
|
845
|
-
* Stamped AFTER execute() resolves — same timing as `result` above —
|
|
846
|
-
* specifically so its presence here is proof the concepts were part
|
|
847
|
-
* of the prompt actually sent, not just of what MainAgent intended to
|
|
848
|
-
* send before the call happened.
|
|
849
|
-
*/
|
|
850
|
-
resolvedConcepts?: Array<{
|
|
851
|
-
name: string;
|
|
852
|
-
kind: string;
|
|
853
|
-
body: string;
|
|
854
|
-
}>;
|
|
855
|
-
}>;
|
|
856
|
-
};
|
|
857
|
-
/** The script that produced this answer, if any. Null for a general (no-tool) answer. */
|
|
858
|
-
script: {
|
|
859
|
-
/** True when an existing recipe was replayed unchanged (ScriptMatcher tier='high'). */
|
|
860
|
-
reused: boolean;
|
|
861
|
-
recipeId?: string | null;
|
|
862
|
-
body?: string | null;
|
|
863
|
-
/** Set when reused — the matcher's reasoning for picking this recipe. */
|
|
864
|
-
reasoning?: string | null;
|
|
865
|
-
/** The winning execute_script tool_result text. Only set when reused=false — a replay never re-runs execute_script. Failed attempts aren't kept. */
|
|
866
|
-
executionResult?: string | null;
|
|
867
|
-
/** Failed execute_script tool_result texts this turn, in order (before the winning one, if any). */
|
|
868
|
-
failedAttempts?: string[];
|
|
869
|
-
} | null;
|
|
870
|
-
/**
|
|
871
|
-
* Everything ScriptMatcher.match() built and sent to its one LLM call this
|
|
872
|
-
* turn — Step 2 of the request flow, immediately after Step 1's exact-match
|
|
873
|
-
* check misses. Captured even when short-circuited before any LLM call, or
|
|
874
|
-
* when the call itself errored, so "why didn't this reuse a script" can
|
|
875
|
-
* always be answered from the trace alone, not just the outcome in `script`.
|
|
876
|
-
* See backend/docs/user-prompt-req-flow/SCRIPT-MATCH-IMPROVEMENTS.md.
|
|
877
|
-
*/
|
|
878
|
-
scriptMatcher: {
|
|
879
|
-
/**
|
|
880
|
-
* Exactly what went INTO the one LLM call — every placeholder value
|
|
881
|
-
* substituted into `.prompts/script-match/system.md`, plus the routing
|
|
882
|
-
* facts (isExplicitEdit, the two counts) that aren't literal prompt text
|
|
883
|
-
* but explain WHY the catalog/active-script blocks look the way they do.
|
|
884
|
-
*/
|
|
885
|
-
sent: {
|
|
886
|
-
/** Whether the raw prompt carried the explicit "edit :" prefix (see parseEditPrefix). */
|
|
887
|
-
isExplicitEdit: boolean;
|
|
888
|
-
/** The prefix-stripped question actually shown to the LLM (the USER_PROMPT placeholder). */
|
|
889
|
-
userPrompt: string;
|
|
890
|
-
/** The Edit Signal text handed to the LLM this turn (CONFIRMED/NOT CONFIRMED wording). */
|
|
891
|
-
editSignal: string;
|
|
892
|
-
/** The rendered "Scripts From Your Past Questions" catalog text (SCRIPT_CATALOG placeholder). */
|
|
893
|
-
scriptCatalog: string;
|
|
894
|
-
/** Distinct scripts actually in scriptCatalog, after health-filtering and the MAX_CATALOG_RECIPES cap. */
|
|
895
|
-
catalogRecipeCount: number;
|
|
896
|
-
/** The rendered "EDITABLE SCRIPTS" block text (ACTIVE_SCRIPT placeholder) — '' when the thread has no active bindings. */
|
|
897
|
-
activeScript: string;
|
|
898
|
-
/** Active bindings offered as edit candidates this turn. */
|
|
899
|
-
activeBindingCount: number;
|
|
900
|
-
};
|
|
901
|
-
/**
|
|
902
|
-
* Everything that came back OUT — the LLM's raw answer plus what the
|
|
903
|
-
* runtime decided to do with it. `tier` here is the FINAL tier after
|
|
904
|
-
* every coercion (near→none, the edit-prefix gate, candidate checks) —
|
|
905
|
-
* it can legitimately differ from `rawResponse.tier`.
|
|
906
|
-
*/
|
|
907
|
-
received: {
|
|
908
|
-
/** False when short-circuited before any LLM call (no catalog match AND no active bindings) — `rawResponse`/`tier` below don't apply. */
|
|
909
|
-
calledLLM: boolean;
|
|
910
|
-
/** The raw JSON the LLM returned, when calledLLM is true and the call didn't throw. */
|
|
911
|
-
rawResponse?: any;
|
|
912
|
-
/** Set when calledLLM is true and the call threw, or the response named an unknown script id. */
|
|
913
|
-
error?: string;
|
|
914
|
-
/** Final tier after ALL coercions. Null when short-circuited, errored, or the call/coercions landed on no match. */
|
|
915
|
-
tier: MatchTier | null;
|
|
916
|
-
};
|
|
917
|
-
} | null;
|
|
918
|
-
/**
|
|
919
|
-
* `resolve_entities` tool activity this turn (see main-agent.ts's
|
|
920
|
-
* RESOLVE_ENTITIES_TOOL_DEF / handleResolveEntities) — names/identifiers the
|
|
921
|
-
* user mentioned, resolved to database ids before any SQL was written.
|
|
922
|
-
* Absent/empty entirely for a project with no entity-search collection
|
|
923
|
-
* registered, or a turn that named nothing.
|
|
924
|
-
*/
|
|
925
|
-
entityResolution: {
|
|
926
|
-
/**
|
|
927
|
-
* The entity-type catalog text injected into MainAgent's system prompt
|
|
928
|
-
* (loadEntityCatalog's output) — what let the LLM name a concept instead
|
|
929
|
-
* of guessing the project's vocabulary. Captured once per turn.
|
|
930
|
-
*/
|
|
931
|
-
catalogText?: string;
|
|
932
|
-
/**
|
|
933
|
-
* One entry per `resolve_entities` tool call this turn (a turn can call it
|
|
934
|
-
* more than once) — the FULL raw response from the entity-search
|
|
935
|
-
* collection, not just the trimmed {mention,entityType,instanceId,
|
|
936
|
-
* displayName} MainAgent keeps for itself to build the dispatch block.
|
|
937
|
-
* `score`/`ambiguous`/`alternatives` only exist here, nowhere else.
|
|
938
|
-
*/
|
|
939
|
-
calls: Array<{
|
|
940
|
-
mentions: Array<{
|
|
941
|
-
text: string;
|
|
942
|
-
entityType?: string;
|
|
943
|
-
}>;
|
|
944
|
-
entityTypes: string[];
|
|
945
|
-
resolved: Array<{
|
|
946
|
-
mention: string;
|
|
947
|
-
entityType: string;
|
|
948
|
-
instanceId: string;
|
|
949
|
-
displayName: string;
|
|
950
|
-
attrs?: Record<string, any>;
|
|
951
|
-
score?: number;
|
|
952
|
-
ambiguous?: boolean;
|
|
953
|
-
alternatives?: Array<{
|
|
954
|
-
instanceId: string;
|
|
955
|
-
displayName: string;
|
|
956
|
-
score: number;
|
|
957
|
-
}>;
|
|
958
|
-
}>;
|
|
959
|
-
unresolved: string[];
|
|
960
|
-
entityMap: Record<string, any>;
|
|
961
|
-
unmatchedEntityTypes?: Array<{
|
|
962
|
-
requested: string;
|
|
963
|
-
candidates?: string[];
|
|
964
|
-
}>;
|
|
965
|
-
/** Set when the collection call itself failed (fails open — see handleResolveEntities). */
|
|
966
|
-
error?: string;
|
|
967
|
-
/** Set on an early return (unavailable / nothing named) so the call is still visible in the trace, not indistinguishable from never having run. */
|
|
968
|
-
note?: string;
|
|
969
|
-
}>;
|
|
970
|
-
};
|
|
971
|
-
/**
|
|
972
|
-
* The prior-turn conversation context injected into this turn's prompt as
|
|
973
|
-
* CONVERSATION_HISTORY — exactly what each flow already builds for itself
|
|
974
|
-
* (chat: thread.getConversationContext(); report/dashboard: their own
|
|
975
|
-
* equivalents), captured as-is. Every call site sets this unconditionally
|
|
976
|
-
* (empty string '' when there's no prior context — new thread, or history
|
|
977
|
-
* trimmed to nothing), so an empty turn is visibly "no history" in the
|
|
978
|
-
* saved trace rather than a silently missing key. Optional only because
|
|
979
|
-
* traces saved before this field existed won't have it at all.
|
|
980
|
-
*/
|
|
981
|
-
conversationHistory?: string;
|
|
982
|
-
/**
|
|
983
|
-
* The exact {{USER_ACCESS_CONTEXT}} text injected into MainAgent's system
|
|
984
|
-
* prompt — the per-user authorization config (sa-api users.config)
|
|
985
|
-
* rendered by buildUserAccessContext, as-is. Captured once (MainAgent's
|
|
986
|
-
* prompt is what SourceAgent's identical value is derived from — no need
|
|
987
|
-
* to duplicate it per source dispatch). Set unconditionally (empty string
|
|
988
|
-
* '' when there's no config for this user), so "no restrictions" is
|
|
989
|
-
* visible in the saved trace rather than a silently missing key. Optional
|
|
990
|
-
* only because traces saved before this field existed won't have it.
|
|
991
|
-
*/
|
|
992
|
-
userAccessContext?: string;
|
|
993
|
-
}
|
|
994
|
-
/**
|
|
995
|
-
* Configuration for the multi-agent system.
|
|
996
|
-
* Controls limits, models, and behavior.
|
|
997
|
-
*/
|
|
998
|
-
interface AgentConfig {
|
|
999
|
-
/** Max rows shown to the UI preview / inlined per source (default: 10) */
|
|
1000
|
-
maxRowsPerSource: number;
|
|
1001
|
-
/**
|
|
1002
|
-
* Max rows a source query may FETCH from the DB server-side (default: 2000).
|
|
1003
|
-
* Decoupled from what the main agent is shown: the full result is fetched and
|
|
1004
|
-
* summarized (bounded), but only a small/complete slice enters LLM context.
|
|
1005
|
-
* This lets small lookups (benchmark maps) arrive COMPLETE without letting
|
|
1006
|
-
* large results blow up context.
|
|
1007
|
-
*/
|
|
1008
|
-
maxRowsFetched: number;
|
|
1009
|
-
/** Model for the main agent (routing + analysis in one LLM call) */
|
|
1010
|
-
mainAgentModel: string;
|
|
1011
|
-
/** Model for source agent query generation */
|
|
1012
|
-
sourceAgentModel: string;
|
|
1013
|
-
/** API key for LLM calls */
|
|
1014
|
-
apiKey?: string;
|
|
1015
|
-
/** Max retry attempts per source agent */
|
|
1016
|
-
maxRetries: number;
|
|
1017
|
-
/** Max tool calling iterations for the main agent loop */
|
|
1018
|
-
maxIterations: number;
|
|
1019
|
-
/** Global knowledge base context (static, same for all users/questions — cached in system prompt) */
|
|
1020
|
-
globalKnowledgeBase?: string;
|
|
1021
|
-
/** Per-request knowledge base context (user-specific + query-matched — dynamic, not cached) */
|
|
1022
|
-
knowledgeBaseContext?: string;
|
|
1023
|
-
/** Per-user authorization config (sa-api users.config), rendered to text — see buildUserAccessContext */
|
|
1024
|
-
userAccessContext?: string;
|
|
1025
|
-
/** Collections registry (ChromaDB search hooks) for embedding-based schema + source search */
|
|
1026
|
-
collections?: any;
|
|
1027
|
-
/** Optional project ID for scoping embedding searches */
|
|
1028
|
-
projectId?: string;
|
|
1029
|
-
/**
|
|
1030
|
-
* Optional debug-trace accumulator for this turn (Phase 1, chat_agent only).
|
|
1031
|
-
* When present, MainAgent-scope retrieval call sites (e.g. preResolveSchema)
|
|
1032
|
-
* push their structured results into it. Absent for callers that don't care
|
|
1033
|
-
* about trace capture (e.g. headless flows) — every push site must treat
|
|
1034
|
-
* this as optional and never let a capture failure affect the real answer.
|
|
1035
|
-
*/
|
|
1036
|
-
trace?: RunTrace;
|
|
1037
|
-
}
|
|
1038
|
-
/**
|
|
1039
|
-
* Default agent configuration
|
|
1040
|
-
*/
|
|
1041
|
-
declare const DEFAULT_AGENT_CONFIG: AgentConfig;
|
|
1042
|
-
|
|
1043
4
|
/**
|
|
1044
5
|
* Unified UIBlock structure for database storage
|
|
1045
|
-
* Used in both bookmarks and user-conversations tables
|
|
1046
|
-
*
|
|
1047
|
-
* `analysis` always holds whatever real narration exists — the full answer on
|
|
1048
|
-
* success, or whatever was actually streamed before a failure (may be empty).
|
|
1049
|
-
* `error` is a dedicated field, null on success — it can be a plain string OR
|
|
1050
|
-
* a structured object/array (e.g. the agent's raw `errors` list), whatever
|
|
1051
|
-
* shape the failure naturally has; it's never coerced into `analysis`.
|
|
6
|
+
* Used in both bookmarks and user-conversations tables
|
|
1052
7
|
*/
|
|
1053
8
|
interface DBUIBlock {
|
|
1054
9
|
id: string;
|
|
1055
10
|
component: Record<string, any> | null;
|
|
1056
11
|
analysis: string | null;
|
|
1057
12
|
user_prompt: string;
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
*/
|
|
1065
|
-
scriptBinding?: {
|
|
1066
|
-
recipeId: string;
|
|
1067
|
-
params?: Record<string, any>;
|
|
1068
|
-
name?: string;
|
|
1069
|
-
columns?: string[];
|
|
1070
|
-
};
|
|
13
|
+
/**
|
|
14
|
+
* One line naming what the component actually showed. componentData is not
|
|
15
|
+
* persisted, so without this a rehydrated turn tells a later question only that
|
|
16
|
+
* some component existed — and a follow-up about it has nothing to refer to.
|
|
17
|
+
*/
|
|
18
|
+
data_summary?: string | null;
|
|
1071
19
|
}
|
|
1072
20
|
|
|
1073
21
|
/**
|
|
@@ -1218,7 +166,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1218
166
|
dependencies?: string[] | undefined;
|
|
1219
167
|
} | undefined;
|
|
1220
168
|
props?: Record<string, any> | undefined;
|
|
1221
|
-
data?: Record<string, any> | undefined;
|
|
1222
169
|
render?: any;
|
|
1223
170
|
states?: Record<string, any> | undefined;
|
|
1224
171
|
methods?: Record<string, {
|
|
@@ -1229,6 +176,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1229
176
|
fn: string;
|
|
1230
177
|
deps?: string[] | undefined;
|
|
1231
178
|
}[] | undefined;
|
|
179
|
+
data?: Record<string, any> | undefined;
|
|
1232
180
|
pages?: {
|
|
1233
181
|
id: string;
|
|
1234
182
|
name: string;
|
|
@@ -1250,7 +198,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1250
198
|
dependencies?: string[] | undefined;
|
|
1251
199
|
} | undefined;
|
|
1252
200
|
props?: Record<string, any> | undefined;
|
|
1253
|
-
data?: Record<string, any> | undefined;
|
|
1254
201
|
render?: any;
|
|
1255
202
|
states?: Record<string, any> | undefined;
|
|
1256
203
|
methods?: Record<string, {
|
|
@@ -1261,6 +208,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1261
208
|
fn: string;
|
|
1262
209
|
deps?: string[] | undefined;
|
|
1263
210
|
}[] | undefined;
|
|
211
|
+
data?: Record<string, any> | undefined;
|
|
1264
212
|
pages?: {
|
|
1265
213
|
id: string;
|
|
1266
214
|
name: string;
|
|
@@ -1286,7 +234,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1286
234
|
dependencies?: string[] | undefined;
|
|
1287
235
|
} | undefined;
|
|
1288
236
|
props?: Record<string, any> | undefined;
|
|
1289
|
-
data?: Record<string, any> | undefined;
|
|
1290
237
|
render?: any;
|
|
1291
238
|
states?: Record<string, any> | undefined;
|
|
1292
239
|
methods?: Record<string, {
|
|
@@ -1297,6 +244,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1297
244
|
fn: string;
|
|
1298
245
|
deps?: string[] | undefined;
|
|
1299
246
|
}[] | undefined;
|
|
247
|
+
data?: Record<string, any> | undefined;
|
|
1300
248
|
pages?: {
|
|
1301
249
|
id: string;
|
|
1302
250
|
name: string;
|
|
@@ -1322,7 +270,6 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1322
270
|
dependencies?: string[] | undefined;
|
|
1323
271
|
} | undefined;
|
|
1324
272
|
props?: Record<string, any> | undefined;
|
|
1325
|
-
data?: Record<string, any> | undefined;
|
|
1326
273
|
render?: any;
|
|
1327
274
|
states?: Record<string, any> | undefined;
|
|
1328
275
|
methods?: Record<string, {
|
|
@@ -1333,6 +280,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
|
|
|
1333
280
|
fn: string;
|
|
1334
281
|
deps?: string[] | undefined;
|
|
1335
282
|
}[] | undefined;
|
|
283
|
+
data?: Record<string, any> | undefined;
|
|
1336
284
|
pages?: {
|
|
1337
285
|
id: string;
|
|
1338
286
|
name: string;
|
|
@@ -1413,7 +361,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1413
361
|
dependencies?: string[] | undefined;
|
|
1414
362
|
} | undefined;
|
|
1415
363
|
props?: Record<string, any> | undefined;
|
|
1416
|
-
data?: Record<string, any> | undefined;
|
|
1417
364
|
render?: any;
|
|
1418
365
|
states?: Record<string, any> | undefined;
|
|
1419
366
|
methods?: Record<string, {
|
|
@@ -1424,6 +371,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1424
371
|
fn: string;
|
|
1425
372
|
deps?: string[] | undefined;
|
|
1426
373
|
}[] | undefined;
|
|
374
|
+
data?: Record<string, any> | undefined;
|
|
1427
375
|
}, {
|
|
1428
376
|
id: string;
|
|
1429
377
|
name?: string | undefined;
|
|
@@ -1437,7 +385,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1437
385
|
dependencies?: string[] | undefined;
|
|
1438
386
|
} | undefined;
|
|
1439
387
|
props?: Record<string, any> | undefined;
|
|
1440
|
-
data?: Record<string, any> | undefined;
|
|
1441
388
|
render?: any;
|
|
1442
389
|
states?: Record<string, any> | undefined;
|
|
1443
390
|
methods?: Record<string, {
|
|
@@ -1448,6 +395,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1448
395
|
fn: string;
|
|
1449
396
|
deps?: string[] | undefined;
|
|
1450
397
|
}[] | undefined;
|
|
398
|
+
data?: Record<string, any> | undefined;
|
|
1451
399
|
}>;
|
|
1452
400
|
data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
1453
401
|
context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -1465,7 +413,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1465
413
|
dependencies?: string[] | undefined;
|
|
1466
414
|
} | undefined;
|
|
1467
415
|
props?: Record<string, any> | undefined;
|
|
1468
|
-
data?: Record<string, any> | undefined;
|
|
1469
416
|
render?: any;
|
|
1470
417
|
states?: Record<string, any> | undefined;
|
|
1471
418
|
methods?: Record<string, {
|
|
@@ -1476,6 +423,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1476
423
|
fn: string;
|
|
1477
424
|
deps?: string[] | undefined;
|
|
1478
425
|
}[] | undefined;
|
|
426
|
+
data?: Record<string, any> | undefined;
|
|
1479
427
|
};
|
|
1480
428
|
data?: Record<string, any> | undefined;
|
|
1481
429
|
context?: Record<string, any> | undefined;
|
|
@@ -1493,7 +441,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1493
441
|
dependencies?: string[] | undefined;
|
|
1494
442
|
} | undefined;
|
|
1495
443
|
props?: Record<string, any> | undefined;
|
|
1496
|
-
data?: Record<string, any> | undefined;
|
|
1497
444
|
render?: any;
|
|
1498
445
|
states?: Record<string, any> | undefined;
|
|
1499
446
|
methods?: Record<string, {
|
|
@@ -1504,6 +451,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
|
|
|
1504
451
|
fn: string;
|
|
1505
452
|
deps?: string[] | undefined;
|
|
1506
453
|
}[] | undefined;
|
|
454
|
+
data?: Record<string, any> | undefined;
|
|
1507
455
|
};
|
|
1508
456
|
data?: Record<string, any> | undefined;
|
|
1509
457
|
context?: Record<string, any> | undefined;
|
|
@@ -1919,10 +867,6 @@ interface SuperatomSDKConfig {
|
|
|
1919
867
|
bundleDir?: string;
|
|
1920
868
|
promptsDir?: string;
|
|
1921
869
|
databaseType?: DatabaseType;
|
|
1922
|
-
/** BCP-47 locale for `fmt` in generated analyses, e.g. 'en-IN', 'en-US'. Defaults to 'en-IN'. */
|
|
1923
|
-
locale?: string;
|
|
1924
|
-
/** ISO-4217 currency for `fmt`, e.g. 'INR', 'USD'. Defaults to 'INR'. */
|
|
1925
|
-
currency?: string;
|
|
1926
870
|
ANTHROPIC_API_KEY?: string;
|
|
1927
871
|
GROQ_API_KEY?: string;
|
|
1928
872
|
GEMINI_API_KEY?: string;
|
|
@@ -1966,6 +910,13 @@ interface SuperatomSDKConfig {
|
|
|
1966
910
|
* Default: 5 minutes
|
|
1967
911
|
*/
|
|
1968
912
|
queryCacheTTL?: number;
|
|
913
|
+
/**
|
|
914
|
+
* Byte budget for cached query results, in MB.
|
|
915
|
+
* The cache evicts least-recently-used entries to stay under it, so a long TTL
|
|
916
|
+
* cannot grow the process until the host kills it. Keep it well below the
|
|
917
|
+
* process memory limit. Default: 1024 MB
|
|
918
|
+
*/
|
|
919
|
+
queryCacheMaxMB?: number;
|
|
1969
920
|
/**
|
|
1970
921
|
* Dashboard conversation history TTL (Time To Live) in minutes
|
|
1971
922
|
* Per-dashboard conversation histories expire after this duration
|
|
@@ -2070,7 +1021,7 @@ declare const KbNodesRequestPayloadSchema: z.ZodObject<{
|
|
|
2070
1021
|
content?: string | undefined;
|
|
2071
1022
|
}>>;
|
|
2072
1023
|
}, "strip", z.ZodTypeAny, {
|
|
2073
|
-
operation: "create" | "getOne" | "
|
|
1024
|
+
operation: "create" | "getOne" | "update" | "delete" | "getAll" | "search" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
|
|
2074
1025
|
data?: {
|
|
2075
1026
|
id?: number | undefined;
|
|
2076
1027
|
type?: "query" | "user" | "global" | undefined;
|
|
@@ -2093,7 +1044,7 @@ declare const KbNodesRequestPayloadSchema: z.ZodObject<{
|
|
|
2093
1044
|
content?: string | undefined;
|
|
2094
1045
|
} | undefined;
|
|
2095
1046
|
}, {
|
|
2096
|
-
operation: "create" | "getOne" | "
|
|
1047
|
+
operation: "create" | "getOne" | "update" | "delete" | "getAll" | "search" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
|
|
2097
1048
|
data?: {
|
|
2098
1049
|
id?: number | undefined;
|
|
2099
1050
|
type?: "query" | "user" | "global" | undefined;
|
|
@@ -2379,332 +1330,277 @@ declare class ReportManager {
|
|
|
2379
1330
|
* Get report count
|
|
2380
1331
|
* @returns Number of reports
|
|
2381
1332
|
*/
|
|
2382
|
-
getReportCount(): number;
|
|
1333
|
+
getReportCount(): number;
|
|
1334
|
+
}
|
|
1335
|
+
|
|
1336
|
+
/**
|
|
1337
|
+
* StreamBuffer - Buffered streaming utility for smoother text delivery
|
|
1338
|
+
* Batches small chunks together and flushes at regular intervals
|
|
1339
|
+
*/
|
|
1340
|
+
type StreamCallback = (chunk: string) => void;
|
|
1341
|
+
/**
|
|
1342
|
+
* StreamBuffer class for managing buffered streaming output
|
|
1343
|
+
* Provides smooth text delivery by batching small chunks
|
|
1344
|
+
*/
|
|
1345
|
+
declare class StreamBuffer {
|
|
1346
|
+
private buffer;
|
|
1347
|
+
private flushTimer;
|
|
1348
|
+
private callback;
|
|
1349
|
+
private fullText;
|
|
1350
|
+
constructor(callback?: StreamCallback);
|
|
1351
|
+
/**
|
|
1352
|
+
* Check if the buffer has a callback configured
|
|
1353
|
+
*/
|
|
1354
|
+
hasCallback(): boolean;
|
|
1355
|
+
/**
|
|
1356
|
+
* Get all text that has been written (including already flushed)
|
|
1357
|
+
*/
|
|
1358
|
+
getFullText(): string;
|
|
1359
|
+
/**
|
|
1360
|
+
* Write a chunk to the buffer
|
|
1361
|
+
* Large chunks or chunks with newlines are flushed immediately
|
|
1362
|
+
* Small chunks are batched and flushed after a short interval
|
|
1363
|
+
*
|
|
1364
|
+
* @param chunk - Text chunk to write
|
|
1365
|
+
*/
|
|
1366
|
+
write(chunk: string): void;
|
|
1367
|
+
/**
|
|
1368
|
+
* Flush the buffer immediately
|
|
1369
|
+
* Call this before tool execution or other operations that need clean output
|
|
1370
|
+
*/
|
|
1371
|
+
flush(): void;
|
|
1372
|
+
/**
|
|
1373
|
+
* Internal flush implementation
|
|
1374
|
+
*/
|
|
1375
|
+
private flushNow;
|
|
1376
|
+
/**
|
|
1377
|
+
* Clean up resources
|
|
1378
|
+
* Call this when done with the buffer
|
|
1379
|
+
*/
|
|
1380
|
+
dispose(): void;
|
|
2383
1381
|
}
|
|
2384
1382
|
|
|
2385
1383
|
/**
|
|
2386
|
-
*
|
|
2387
|
-
*
|
|
2388
|
-
* The SDK is standalone (no DB dependency). The backend implements this
|
|
2389
|
-
* interface over Postgres (full-text search + atomic counters) and injects it
|
|
2390
|
-
* via `collections['script-recipes']`, exactly like `collections['source-embeddings']`.
|
|
2391
|
-
* `ScriptStore` consumes it for all METADATA operations while keeping the
|
|
2392
|
-
* executable body on disk as scripts-store/<fileBase>.ts.
|
|
2393
|
-
*
|
|
2394
|
-
* All metadata rows are plain JSON (no scriptBody — that lives on disk).
|
|
2395
|
-
* See backend/docs/SCRIPT-FLOW-SCALING-ISSUES.md (#1, #3, #7).
|
|
1384
|
+
* ToolExecutorService - Handles execution of SQL queries and external tools
|
|
1385
|
+
* Extracted from BaseLLM.generateTextResponse for better separation of concerns
|
|
2396
1386
|
*/
|
|
2397
1387
|
|
|
2398
|
-
/**
|
|
2399
|
-
|
|
1388
|
+
/**
|
|
1389
|
+
* External tool definition
|
|
1390
|
+
*/
|
|
1391
|
+
interface ExternalTool {
|
|
2400
1392
|
id: string;
|
|
2401
|
-
projectId?: string | null;
|
|
2402
|
-
version: number;
|
|
2403
1393
|
name: string;
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
forkReason?: string | null;
|
|
2420
|
-
status: 'draft' | 'verified' | string;
|
|
2421
|
-
turnId?: string | null;
|
|
2422
|
-
editedBy?: string | null;
|
|
2423
|
-
editedFrom?: string | null;
|
|
2424
|
-
history?: ScriptVersionRecord[] | null;
|
|
2425
|
-
lastError?: {
|
|
2426
|
-
phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
|
|
2427
|
-
message: string;
|
|
2428
|
-
at: string;
|
|
2429
|
-
attempt: number;
|
|
2430
|
-
} | null;
|
|
2431
|
-
createdAt?: string | null;
|
|
2432
|
-
updatedAt?: string | null;
|
|
1394
|
+
description?: string;
|
|
1395
|
+
/** Tool type: "source" = routed through SourceAgent, "direct" = called directly by MainAgent */
|
|
1396
|
+
toolType?: 'source' | 'direct';
|
|
1397
|
+
/** Full untruncated schema for source agent (all columns visible) */
|
|
1398
|
+
fullSchema?: string;
|
|
1399
|
+
/** Schema size tier: small (≤50 tables), medium (51-200), large (201-500), very_large (500+) */
|
|
1400
|
+
schemaTier?: string;
|
|
1401
|
+
/** Schema search function for very_large tier — keyword search over entities */
|
|
1402
|
+
schemaSearchFn?: (keywords: string[]) => string;
|
|
1403
|
+
fn: (input: any) => Promise<any>;
|
|
1404
|
+
limit?: number;
|
|
1405
|
+
outputSchema?: any;
|
|
1406
|
+
executionType?: 'immediate' | 'deferred';
|
|
1407
|
+
userProvidedData?: any;
|
|
1408
|
+
params?: Record<string, any>;
|
|
2433
1409
|
}
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
}
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
|
|
2450
|
-
updateStats(id: string, patch: {
|
|
2451
|
-
successDelta?: number;
|
|
2452
|
-
failureDelta?: number;
|
|
2453
|
-
lastUsed?: string;
|
|
2454
|
-
}): Promise<void>;
|
|
2455
|
-
/** Flip a draft to verified, applying provenance + optional fork lineage. */
|
|
2456
|
-
promote(id: string, patch: {
|
|
2457
|
-
sourceIds: string[];
|
|
2458
|
-
tables: string[];
|
|
2459
|
-
fileBase?: string;
|
|
2460
|
-
parentId?: string;
|
|
2461
|
-
forkDepth?: number;
|
|
2462
|
-
forkReason?: string;
|
|
2463
|
-
components?: ScriptComponentSpec[];
|
|
2464
|
-
}): Promise<ScriptRecipeMetaRow | null>;
|
|
2465
|
-
/**
|
|
2466
|
-
* Commit a verified edit onto an EXISTING recipe: bump `version`, replace the
|
|
2467
|
-
* body-bearing metadata, append a history record, reset health counters, and
|
|
2468
|
-
* clear the component specs (they were validated against the old shape).
|
|
2469
|
-
* Returns the updated row, or null when the target is gone.
|
|
2470
|
-
* See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 5.
|
|
2471
|
-
*/
|
|
2472
|
-
commitEdit?(id: string, patch: {
|
|
2473
|
-
name?: string;
|
|
2474
|
-
intentDescription?: string;
|
|
2475
|
-
tags?: string[];
|
|
2476
|
-
parameters?: ScriptParameter[];
|
|
2477
|
-
bodyHash: string;
|
|
2478
|
-
/** New on-disk stem when the edit renamed the script; omitted otherwise. */
|
|
2479
|
-
fileBase?: string;
|
|
2480
|
-
sourceIds?: string[];
|
|
2481
|
-
tables?: string[];
|
|
2482
|
-
editedBy?: string;
|
|
2483
|
-
editedFrom?: string;
|
|
2484
|
-
historyEntry: {
|
|
2485
|
-
version: number;
|
|
2486
|
-
at: string;
|
|
2487
|
-
by?: string;
|
|
2488
|
-
instruction?: string;
|
|
2489
|
-
changeSummary?: string;
|
|
2490
|
-
bodyHash?: string;
|
|
2491
|
-
};
|
|
2492
|
-
}): Promise<ScriptRecipeMetaRow | null>;
|
|
2493
|
-
/** Stamp a draft's last execution error. */
|
|
2494
|
-
recordDraftError(id: string, err: {
|
|
2495
|
-
phase: string;
|
|
2496
|
-
message: string;
|
|
2497
|
-
attempt: number;
|
|
2498
|
-
at: string;
|
|
2499
|
-
}): Promise<void>;
|
|
2500
|
-
/** Delete a recipe row (body file removed separately). */
|
|
2501
|
-
remove(id: string): Promise<void>;
|
|
2502
|
-
/** True if `fileBase` is taken by a different recipe in this project. */
|
|
2503
|
-
fileBaseTaken(fileBase: string, excludeId: string, projectId?: string): Promise<boolean>;
|
|
1410
|
+
/**
|
|
1411
|
+
* Executed tool tracking info
|
|
1412
|
+
*/
|
|
1413
|
+
interface ExecutedToolInfo {
|
|
1414
|
+
id: string;
|
|
1415
|
+
name: string;
|
|
1416
|
+
params: any;
|
|
1417
|
+
result: {
|
|
1418
|
+
_totalRecords: number;
|
|
1419
|
+
_recordsShown: number;
|
|
1420
|
+
_metadata?: any;
|
|
1421
|
+
_sampleData: any[];
|
|
1422
|
+
};
|
|
1423
|
+
outputSchema?: any;
|
|
1424
|
+
sourceSchema?: string;
|
|
1425
|
+
sourceType?: string;
|
|
2504
1426
|
}
|
|
2505
|
-
/** Pull the injected store off the collections bag (or null if not wired). */
|
|
2506
|
-
declare function resolveScriptRecipeStore(collections: any): ScriptRecipeStore | null;
|
|
2507
1427
|
|
|
2508
1428
|
/**
|
|
2509
|
-
*
|
|
2510
|
-
*
|
|
2511
|
-
* Split of responsibilities:
|
|
2512
|
-
* - METADATA → injected `ScriptRecipeStore` (Postgres FTS + atomic counters),
|
|
2513
|
-
* resolved from `collections['script-recipes']`.
|
|
2514
|
-
* - BODY → scripts-store/<fileBase>.ts, editable in your IDE. Written
|
|
2515
|
-
* atomically (temp + rename); `bodyHash` (sha256) detects edits.
|
|
2516
|
-
*
|
|
2517
|
-
* The old "read every file every turn + send the whole catalog to the LLM"
|
|
2518
|
-
* matcher is gone — matching is `store.search(prompt)` (FTS shortlist). The
|
|
2519
|
-
* draft/verified filename dance is gone too: `status` is a DB column and the
|
|
2520
|
-
* file keeps a stable `<fileBase>.ts` name across promotion.
|
|
1429
|
+
* Multi-Agent Architecture Types
|
|
2521
1430
|
*
|
|
2522
|
-
*
|
|
2523
|
-
*
|
|
1431
|
+
* Defines interfaces for the hierarchical agent system:
|
|
1432
|
+
* - Main Agent: ONE LLM.streamWithTools() call with source agent tools
|
|
1433
|
+
* - Source Agents: independent agents that query individual data sources
|
|
2524
1434
|
*
|
|
2525
|
-
*
|
|
1435
|
+
* The main agent sees only source summaries. When it calls a source tool,
|
|
1436
|
+
* the SourceAgent runs independently (own LLM, own retries) and returns clean data.
|
|
2526
1437
|
*/
|
|
2527
1438
|
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
|
|
1439
|
+
/**
|
|
1440
|
+
* Per-entity detail: name, row count, and column names.
|
|
1441
|
+
* Gives the main agent enough context to route to the right source.
|
|
1442
|
+
*/
|
|
1443
|
+
interface EntityDetail {
|
|
1444
|
+
/** Entity name (table, sheet, endpoint) */
|
|
1445
|
+
name: string;
|
|
1446
|
+
/** Approximate row count */
|
|
1447
|
+
rowCount?: number;
|
|
1448
|
+
/** Column/field names */
|
|
1449
|
+
columns: string[];
|
|
1450
|
+
}
|
|
1451
|
+
/**
|
|
1452
|
+
* Representation of a data source for the main agent.
|
|
1453
|
+
* Contains entity names WITH column names so the LLM can route accurately.
|
|
1454
|
+
*/
|
|
1455
|
+
interface SourceSummary {
|
|
1456
|
+
/** Source ID (matches tool ID prefix) */
|
|
1457
|
+
id: string;
|
|
1458
|
+
/** Human-readable source name */
|
|
2533
1459
|
name: string;
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
* `commitEdit`, so the working script is never clobbered by an edit that
|
|
2543
|
-
* turns out not to run. See backend/docs/SCRIPT-EDIT-DESIGN.md § D5.
|
|
2544
|
-
*/
|
|
2545
|
-
parentId?: string;
|
|
1460
|
+
/** Source type: postgres, excel, rest_api, etc. */
|
|
1461
|
+
type: string;
|
|
1462
|
+
/** Brief description of what data this source contains */
|
|
1463
|
+
description: string;
|
|
1464
|
+
/** Detailed entity info with column names for routing */
|
|
1465
|
+
entityDetails: EntityDetail[];
|
|
1466
|
+
/** The tool ID associated with this source */
|
|
1467
|
+
toolId: string;
|
|
2546
1468
|
}
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
1469
|
+
/**
|
|
1470
|
+
* What a source agent returns after querying its data source.
|
|
1471
|
+
* The main agent uses this to analyze and compose the final response.
|
|
1472
|
+
*/
|
|
1473
|
+
interface SourceAgentResult {
|
|
1474
|
+
/** Source ID */
|
|
1475
|
+
sourceId: string;
|
|
1476
|
+
/** Source name */
|
|
1477
|
+
sourceName: string;
|
|
1478
|
+
/** Whether the query succeeded */
|
|
1479
|
+
success: boolean;
|
|
1480
|
+
/** Result data rows */
|
|
1481
|
+
data: any[];
|
|
1482
|
+
/** Metadata about the query execution */
|
|
1483
|
+
metadata: SourceAgentMetadata;
|
|
1484
|
+
/** Tool execution info for the last successful query (backward compat) */
|
|
1485
|
+
executedTool: ExecutedToolInfo;
|
|
1486
|
+
/** All successful tool executions (primary + follow-up queries) */
|
|
1487
|
+
allExecutedTools?: ExecutedToolInfo[];
|
|
1488
|
+
/** Error message if failed */
|
|
1489
|
+
error?: string;
|
|
2554
1490
|
}
|
|
2555
|
-
interface
|
|
2556
|
-
/**
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
1491
|
+
interface SourceAgentMetadata {
|
|
1492
|
+
/** Total rows that matched the query (before limit) */
|
|
1493
|
+
totalRowsMatched: number;
|
|
1494
|
+
/** Rows actually returned (after limit) */
|
|
1495
|
+
rowsReturned: number;
|
|
1496
|
+
/** Whether the result was truncated by the row limit */
|
|
1497
|
+
isLimited: boolean;
|
|
1498
|
+
/** The query/params that were executed */
|
|
1499
|
+
queryExecuted?: string;
|
|
1500
|
+
/** Execution time in milliseconds */
|
|
1501
|
+
executionTimeMs: number;
|
|
2563
1502
|
}
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
|
|
2575
|
-
|
|
2576
|
-
|
|
2577
|
-
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
|
-
/**
|
|
2581
|
-
|
|
2582
|
-
/**
|
|
2583
|
-
*
|
|
2584
|
-
*
|
|
2585
|
-
*
|
|
2586
|
-
*
|
|
2587
|
-
|
|
2588
|
-
|
|
2589
|
-
|
|
2590
|
-
*
|
|
2591
|
-
*
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
/** Create or update a recipe (metadata upsert + body write when changed). */
|
|
2595
|
-
save(recipe: ScriptRecipe): Promise<void>;
|
|
2596
|
-
/**
|
|
2597
|
-
* Persist (or update) a draft. Within a turn, retries that pass the same
|
|
2598
|
-
* `recipeId` overwrite the same row + file; a fresh `recipeId` mints a new
|
|
2599
|
-
* draft. The body is visible at scripts-store/<fileBase>.ts immediately.
|
|
2600
|
-
*/
|
|
2601
|
-
saveDraft(input: SaveDraftInput): Promise<ScriptRecipe>;
|
|
2602
|
-
/** Stamp a draft's last execution error (metadata only). */
|
|
2603
|
-
recordDraftError(recipeId: string, err: {
|
|
2604
|
-
phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
|
|
2605
|
-
message: string;
|
|
2606
|
-
attempt: number;
|
|
2607
|
-
}): Promise<void>;
|
|
2608
|
-
/**
|
|
2609
|
-
* Promote a successfully-executed draft into a verified script.
|
|
2610
|
-
* The on-disk body already exists at <fileBase>.ts (written at write_script
|
|
2611
|
-
* time) and keeps its name — only the DB row flips status + provenance.
|
|
2612
|
-
*/
|
|
2613
|
-
promoteToVerified(recipeId: string, input: PromoteToVerifiedInput): Promise<ScriptRecipe | null>;
|
|
2614
|
-
/**
|
|
2615
|
-
* Commit a user-directed edit: merge a VERIFIED shadow draft back onto the
|
|
2616
|
-
* recipe it was editing, as version N+1 under the SAME recipe id.
|
|
2617
|
-
*
|
|
2618
|
-
* Keeping the id stable is the point of the whole feature — every cached
|
|
2619
|
-
* conversation, `script_dataset` regeneration descriptor and persisted
|
|
2620
|
-
* component spec already points at it, so the correction applies retroactively
|
|
2621
|
-
* to replays instead of stranding them on the old body.
|
|
2622
|
-
*
|
|
2623
|
-
* Steps (see backend/docs/SCRIPT-EDIT-DESIGN.md § Component 5):
|
|
2624
|
-
* 1. archive the current body as `<fileBase>.v<version>.ts`
|
|
2625
|
-
* 2. write the edited body to the original fileBase (atomic)
|
|
2626
|
-
* 3. version++, copy name/description/params, append a history record
|
|
2627
|
-
* 4. reset health counters — the pre-edit failure history is stale
|
|
2628
|
-
* 5. clear component specs — they were validated against the OLD shape
|
|
2629
|
-
* 6. delete the shadow draft (row + file)
|
|
2630
|
-
*
|
|
2631
|
-
* Returns the updated recipe, or null when the commit could not be applied
|
|
2632
|
-
* (caller should then fall back to treating the draft as a new script).
|
|
2633
|
-
*/
|
|
2634
|
-
commitEdit(targetId: string, draft: {
|
|
2635
|
-
recipeId: string;
|
|
2636
|
-
name?: string;
|
|
2637
|
-
intentDescription?: string;
|
|
2638
|
-
tags?: string[];
|
|
2639
|
-
parameters?: ScriptParameter[];
|
|
2640
|
-
scriptBody: string;
|
|
2641
|
-
sourceIds?: string[];
|
|
2642
|
-
tables?: string[];
|
|
2643
|
-
}, meta: {
|
|
2644
|
-
instruction?: string;
|
|
2645
|
-
changeSummary?: string;
|
|
2646
|
-
editedBy?: string;
|
|
2647
|
-
}): Promise<ScriptRecipe | null>;
|
|
2648
|
-
/**
|
|
2649
|
-
* Drop a draft (row + body file). MainAgent calls this at end-of-turn when a
|
|
2650
|
-
* draft was authored but never verified — failed drafts are never matched, so
|
|
2651
|
-
* deleting them immediately avoids unbounded accumulation (#5). No-op if the
|
|
2652
|
-
* recipe isn't a draft (so a promoted/verified script is never removed here).
|
|
2653
|
-
*/
|
|
2654
|
-
discardDraft(recipeId: string): Promise<void>;
|
|
2655
|
-
/** Delete a recipe (row + body file). */
|
|
2656
|
-
delete(id: string): Promise<void>;
|
|
2657
|
-
/** Record a successful execution (atomic counter bump). */
|
|
2658
|
-
recordSuccess(id: string): Promise<void>;
|
|
2659
|
-
/** Record a failed execution (atomic counter bump). */
|
|
2660
|
-
recordFailure(id: string): Promise<void>;
|
|
2661
|
-
/** Absolute path to the .ts body for a recipe (used by the runner/MainAgent). */
|
|
2662
|
-
getScriptPath(recipe: ScriptRecipe): string;
|
|
2663
|
-
private removeById;
|
|
2664
|
-
private rowToRecipe;
|
|
2665
|
-
private recipeToRow;
|
|
2666
|
-
/** slug of name, with a short id suffix when the bare slug is already taken. */
|
|
2667
|
-
private computeFileBase;
|
|
2668
|
-
private toSlug;
|
|
2669
|
-
private hash;
|
|
2670
|
-
/**
|
|
2671
|
-
* Attach getComponents to the recipe body. The stored `components` column is
|
|
2672
|
-
* cleared at promotion (see promoteToVerified): once the body computes its own
|
|
2673
|
-
* specs, a stale spec array beside a live program is how the wrong one gets
|
|
2674
|
-
* read later. See backend/docs/COMPONENTS-AS-PROGRAM-DESIGN.md § 4.4.
|
|
2675
|
-
*/
|
|
2676
|
-
attachComponents(recipeId: string, componentsBody: string): Promise<boolean>;
|
|
2677
|
-
/**
|
|
2678
|
-
* Append (or replace) the `getAnalysis` export on an existing draft body.
|
|
2679
|
-
*
|
|
2680
|
-
* The narrative is authored AFTER execution, so it lands on a file that
|
|
2681
|
-
* already holds a working getData — rewriting the whole body would risk
|
|
2682
|
-
* losing the query that just succeeded. Replaces any earlier getAnalysis so
|
|
2683
|
-
* a retry does not stack duplicate exports.
|
|
2684
|
-
*/
|
|
2685
|
-
attachAnalysis(recipeId: string, analysisBody: string): Promise<boolean>;
|
|
2686
|
-
private bodyPath;
|
|
2687
|
-
private readBody;
|
|
2688
|
-
/** Directory holding superseded bodies. Dot-prefixed so IDEs/`ls` hide it. */
|
|
2689
|
-
private get archiveDir();
|
|
2690
|
-
/**
|
|
2691
|
-
* Archive a superseded body as `.versions/<fileBase>.v<n>.ts`.
|
|
1503
|
+
/**
|
|
1504
|
+
* A pre-built, multi-step UI flow registered with the SDK.
|
|
1505
|
+
*
|
|
1506
|
+
* When the main agent decides a user's question matches a workflow's whenToUse
|
|
1507
|
+
* trigger, it picks the workflow instead of running source agents / generating
|
|
1508
|
+
* dashboard components. The LLM extracts the workflow's required props from the
|
|
1509
|
+
* prompt (using `propsSchema` as the tool input_schema) and the SDK returns the
|
|
1510
|
+
* workflow component directly — no analysis text, no chart generation. The
|
|
1511
|
+
* frontend renders the registered workflow component with the LLM-extracted
|
|
1512
|
+
* props.
|
|
1513
|
+
*/
|
|
1514
|
+
interface WorkflowDescriptor {
|
|
1515
|
+
/** Unique workflow id (used as the LLM tool name) */
|
|
1516
|
+
id: string;
|
|
1517
|
+
/** Component name on the frontend (matches the registered React component) */
|
|
1518
|
+
name: string;
|
|
1519
|
+
/** Short human-readable description of what this workflow does */
|
|
1520
|
+
description: string;
|
|
1521
|
+
/**
|
|
1522
|
+
* 1–2 sentence trigger condition. The LLM uses this to decide if the
|
|
1523
|
+
* user's prompt matches this workflow. Be specific — e.g.
|
|
1524
|
+
* "User wants to *initiate* an inventory transfer (review + submit POs),
|
|
1525
|
+
* not just see analysis or charts."
|
|
1526
|
+
*/
|
|
1527
|
+
whenToUse: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* JSON-schema-style description of the props the workflow needs. Becomes
|
|
1530
|
+
* the LLM tool's input_schema, so the model fills these from the prompt.
|
|
1531
|
+
* Use the same shape as `params` on direct tools — string descriptors with
|
|
1532
|
+
* an optional "(optional)" suffix.
|
|
2692
1533
|
*
|
|
2693
|
-
*
|
|
2694
|
-
*
|
|
1534
|
+
* Example:
|
|
1535
|
+
* ```
|
|
1536
|
+
* {
|
|
1537
|
+
* selectedStore: 'object — { id, name } of the source branch',
|
|
1538
|
+
* minROI: 'number (optional) — only show transfers with ROI ≥ this',
|
|
1539
|
+
* }
|
|
1540
|
+
* ```
|
|
1541
|
+
*/
|
|
1542
|
+
propsSchema: Record<string, string>;
|
|
1543
|
+
/**
|
|
1544
|
+
* Optional: static prop defaults merged with LLM-extracted props before
|
|
1545
|
+
* the component is returned. Useful for things like the embedded
|
|
1546
|
+
* `externalTool` config that the workflow uses to fetch its own data.
|
|
2695
1547
|
*/
|
|
2696
|
-
|
|
1548
|
+
defaultProps?: Record<string, any>;
|
|
1549
|
+
}
|
|
1550
|
+
/**
|
|
1551
|
+
* The workflow selection captured during a routing call.
|
|
1552
|
+
* Set on AgentResponse when the LLM picks a workflow tool.
|
|
1553
|
+
*/
|
|
1554
|
+
interface SelectedWorkflow {
|
|
1555
|
+
/** Component name (matches WorkflowDescriptor.name) */
|
|
1556
|
+
name: string;
|
|
1557
|
+
/** Props extracted from the prompt + merged with workflow.defaultProps */
|
|
1558
|
+
props: Record<string, any>;
|
|
1559
|
+
}
|
|
1560
|
+
/**
|
|
1561
|
+
* The complete response from the multi-agent system.
|
|
1562
|
+
* Contains everything needed for text display + component generation.
|
|
1563
|
+
*/
|
|
1564
|
+
interface AgentResponse {
|
|
1565
|
+
/** Generated text response (analysis of the data) */
|
|
1566
|
+
text: string;
|
|
1567
|
+
/** All executed tools across all source agents (for component generation) */
|
|
1568
|
+
executedTools: ExecutedToolInfo[];
|
|
1569
|
+
/** Individual results from each source agent */
|
|
1570
|
+
sourceResults: SourceAgentResult[];
|
|
2697
1571
|
/**
|
|
2698
|
-
*
|
|
2699
|
-
*
|
|
2700
|
-
*
|
|
2701
|
-
* nothing linking them back to the live script.
|
|
1572
|
+
* Set when the LLM routed the question to a registered workflow component.
|
|
1573
|
+
* When present, the upstream caller should skip component generation and
|
|
1574
|
+
* return this workflow as the response.
|
|
2702
1575
|
*/
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
1576
|
+
workflow?: SelectedWorkflow;
|
|
1577
|
+
}
|
|
1578
|
+
/**
|
|
1579
|
+
* Configuration for the multi-agent system.
|
|
1580
|
+
* Controls limits, models, and behavior.
|
|
1581
|
+
*/
|
|
1582
|
+
interface AgentConfig {
|
|
1583
|
+
/** Max rows a source agent can return (default: 50) */
|
|
1584
|
+
maxRowsPerSource: number;
|
|
1585
|
+
/** Model for the main agent (routing + analysis in one LLM call) */
|
|
1586
|
+
mainAgentModel: string;
|
|
1587
|
+
/** Model for source agent query generation */
|
|
1588
|
+
sourceAgentModel: string;
|
|
1589
|
+
/** API key for LLM calls */
|
|
1590
|
+
apiKey?: string;
|
|
1591
|
+
/** Max retry attempts per source agent */
|
|
1592
|
+
maxRetries: number;
|
|
1593
|
+
/** Max tool calling iterations for the main agent loop */
|
|
1594
|
+
maxIterations: number;
|
|
1595
|
+
/** Global knowledge base context (static, same for all users/questions — cached in system prompt) */
|
|
1596
|
+
globalKnowledgeBase?: string;
|
|
1597
|
+
/** Per-request knowledge base context (user-specific + query-matched — dynamic, not cached) */
|
|
1598
|
+
knowledgeBaseContext?: string;
|
|
2707
1599
|
}
|
|
1600
|
+
/**
|
|
1601
|
+
* Default agent configuration
|
|
1602
|
+
*/
|
|
1603
|
+
declare const DEFAULT_AGENT_CONFIG: AgentConfig;
|
|
2708
1604
|
|
|
2709
1605
|
/**
|
|
2710
1606
|
* Main Agent (Orchestrator)
|
|
@@ -2723,267 +1619,21 @@ declare class ScriptStore {
|
|
|
2723
1619
|
|
|
2724
1620
|
declare class MainAgent {
|
|
2725
1621
|
private externalTools;
|
|
2726
|
-
private workflows;
|
|
2727
|
-
private config;
|
|
2728
|
-
private streamBuffer;
|
|
2729
|
-
|
|
2730
|
-
* Optional: when provided, MainAgent exposes the `write_script` /
|
|
2731
|
-
* `execute_script` tools to the LLM and persists drafts to disk via the
|
|
2732
|
-
* store. Headless callers (alert analyzer, metric resolver) omit these to
|
|
2733
|
-
* suppress script authoring entirely — drafts would otherwise leak onto
|
|
2734
|
-
* disk with no caller to promote or clean them up.
|
|
2735
|
-
*/
|
|
2736
|
-
private scriptStore;
|
|
2737
|
-
private turnId;
|
|
2738
|
-
private createdFromPrompt;
|
|
2739
|
-
private scriptState;
|
|
2740
|
-
/** Answer-flow component catalog (filtered + projected by the caller). */
|
|
2741
|
-
private componentCatalog;
|
|
2742
|
-
/** Specs accepted by `write_components` this turn; empty until it succeeds. */
|
|
2743
|
-
/**
|
|
2744
|
-
* Entities resolved this turn, appended verbatim to every source dispatch.
|
|
2745
|
-
*
|
|
2746
|
-
* Not left to the model to copy into its intent prose: observed live, the
|
|
2747
|
-
* MainAgent wrote names instead of ids on the first dispatch AND re-spelled
|
|
2748
|
-
* 'F D C LIMITED' as 'FDC Limited', so the source agent fell back to
|
|
2749
|
-
* `PartyName LIKE '%FDC%'` and found 2 of 3 customers. Carrying the ids
|
|
2750
|
-
* structurally makes that impossible rather than instruction-dependent.
|
|
2751
|
-
*/
|
|
2752
|
-
private resolvedEntities;
|
|
2753
|
-
/**
|
|
2754
|
-
* Concept bodies resolved this turn (via resolve_entities' embedded concept
|
|
2755
|
-
* lookup or a standalone resolve_concepts call) — retained the same way as
|
|
2756
|
-
* resolvedEntities above, so they can be attached to the SourceAgent dispatch.
|
|
2757
|
-
*
|
|
2758
|
-
* Without this, a concept resolved HERE (MainAgent's own tool loop) never
|
|
2759
|
-
* reaches SourceAgent at all: SourceAgent only gets the natural-language
|
|
2760
|
-
* `intent` MainAgent writes, which is a paraphrase, not the concept's
|
|
2761
|
-
* verbatim, authoritative body. Deduped on name so a mid-turn re-resolve
|
|
2762
|
-
* doesn't repeat an already-attached concept.
|
|
2763
|
-
*/
|
|
2764
|
-
private resolvedConcepts;
|
|
2765
|
-
private componentSpecs;
|
|
2766
|
-
private componentLayout;
|
|
2767
|
-
private renderComponentAttempts;
|
|
2768
|
-
/** Same repeated-violation tracking as ScriptState.lastAnalysisViolationTexts, for write_components. */
|
|
2769
|
-
private lastComponentsViolationTexts;
|
|
2770
|
-
/**
|
|
2771
|
-
* Fork mode — set when this turn is adapting a near-matching parent script.
|
|
2772
|
-
* In fork mode there is no legitimate "answer with bare text" outcome: the
|
|
2773
|
-
* only correct first move is a tool call (write_script, or a source tool for
|
|
2774
|
-
* schema discovery). We therefore force tool use on the first LLM iteration
|
|
2775
|
-
* so the model can't end its turn with a bare "I'll adapt…" preamble and zero
|
|
2776
|
-
* tool calls. Never set on the fresh-authoring / general-question path.
|
|
2777
|
-
*/
|
|
2778
|
-
private forkMode;
|
|
2779
|
-
/**
|
|
2780
|
-
* Edit mode — set when this turn applies a user-directed change to an
|
|
2781
|
-
* existing script. Swaps the system prompt to `agent-main-edit` and stamps
|
|
2782
|
-
* the shadow draft's parentId. Like fork mode there is no legitimate
|
|
2783
|
-
* "answer with bare text" outcome, so tool use is forced on iteration 1.
|
|
2784
|
-
* See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 4.
|
|
2785
|
-
*/
|
|
2786
|
-
private editContext;
|
|
2787
|
-
/** The recipe's durable rendering choice — see the constructor. */
|
|
2788
|
-
private displayPreference;
|
|
2789
|
-
/**
|
|
2790
|
-
* Per-turn cancellation signal (user hit "Stop"). Set at the top of
|
|
2791
|
-
* handleQuestion and read by the tool handler, the SourceAgent dispatch, and
|
|
2792
|
-
* the script subprocess so an abort tears down every layer of the turn.
|
|
2793
|
-
*/
|
|
2794
|
-
private abortSignal?;
|
|
2795
|
-
constructor(externalTools: ExternalTool[], config: AgentConfig, scriptStore?: ScriptStore, turnId?: string, streamBuffer?: StreamBuffer, workflows?: WorkflowDescriptor[], forkMode?: boolean, editContext?: EditContext, componentCatalog?: Component[],
|
|
2796
|
-
/**
|
|
2797
|
-
* The recipe's durable rendering choice, when it has one. A DATA edit
|
|
2798
|
-
* re-authors getComponents from scratch, so without this the user's chart
|
|
2799
|
-
* type is silently dropped whenever anyone changes the SQL.
|
|
2800
|
-
*/
|
|
2801
|
-
displayPreference?: {
|
|
2802
|
-
componentTypes: string[];
|
|
2803
|
-
instruction: string;
|
|
2804
|
-
});
|
|
2805
|
-
/** True when the turn is applying a user-directed script edit. */
|
|
2806
|
-
private get editMode();
|
|
2807
|
-
private get scriptingEnabled();
|
|
2808
|
-
/**
|
|
2809
|
-
* Handle a user question using the multi-agent system.
|
|
2810
|
-
*
|
|
2811
|
-
* This is ONE LLM.streamWithTools() call. The LLM:
|
|
2812
|
-
* 1. Sees source summaries + direct tool descriptions in system prompt
|
|
2813
|
-
* 2. Decides which tool(s) to call (routing)
|
|
2814
|
-
* 3. Source tools → SourceAgent runs independently → returns data
|
|
2815
|
-
* 4. Direct tools → fn() called directly with LLM params → returns data
|
|
2816
|
-
* 5. Generates final analysis text
|
|
2817
|
-
*/
|
|
2818
|
-
handleQuestion(userPrompt: string, apiKey?: string, conversationHistory?: string, streamCallback?: (chunk: string) => void, signal?: AbortSignal): Promise<AgentResponse>;
|
|
2819
|
-
/**
|
|
2820
|
-
* Tool definition, with the catalog rendered from the registered `Metadata`
|
|
2821
|
-
* the caller passed in. Generated rather than hand-written so it cannot drift
|
|
2822
|
-
* from what the frontend actually ships.
|
|
2823
|
-
*/
|
|
2824
|
-
private buildWriteComponentsToolDef;
|
|
2825
|
-
/**
|
|
2826
|
-
* Validate the agent's component picks against the REAL columns of each bound
|
|
2827
|
-
* dataset. All-or-nothing: any error rejects the whole call and returns the
|
|
2828
|
-
* findings, because a partially-accepted dashboard makes the retry ambiguous.
|
|
2829
|
-
*/
|
|
2830
|
-
private validateSpecs;
|
|
2831
|
-
/**
|
|
2832
|
-
* Author the dashboard as a program. Attaches getComponents to the draft, runs
|
|
2833
|
-
* it over the verified rows, then validates the specs it RETURNED — the program
|
|
2834
|
-
* is never trusted because it is a program, exactly as an authored spec is not.
|
|
2835
|
-
*/
|
|
2836
|
-
private handleWriteComponents;
|
|
2837
|
-
/**
|
|
2838
|
-
* Author the answer as a program. Runs after execute_script, so the body is
|
|
2839
|
-
* written with the result already known and can react to what it found.
|
|
2840
|
-
*
|
|
2841
|
-
* Rejects a body that types numbers rather than computing them — see
|
|
2842
|
-
* analysis-lint. A hardcoded figure is worse than prose: it freezes into the
|
|
2843
|
-
* recipe and replays unchanged while the data moves underneath it.
|
|
2844
|
-
*/
|
|
2845
|
-
private handleWriteAnalysis;
|
|
2846
|
-
private handleWriteScript;
|
|
2847
|
-
private handleExecuteScript;
|
|
2848
|
-
/**
|
|
2849
|
-
* Build the AgentWrittenScript payload the caller will hand to
|
|
2850
|
-
* `ScriptStore.promoteToVerified()`. Only returned when a verified
|
|
2851
|
-
* successful execution is on record.
|
|
2852
|
-
*/
|
|
2853
|
-
private buildSavedScript;
|
|
2854
|
-
private normalizeParameterList;
|
|
2855
|
-
/**
|
|
2856
|
-
* Which declared parameter NAMES never actually appear wired into the
|
|
2857
|
-
* script body — checked as plain text, not a real parser, so it only
|
|
2858
|
-
* catches the worst case (completely unreferenced) rather than every
|
|
2859
|
-
* subtler variant (e.g. used for display text while the SQL itself still
|
|
2860
|
-
* hardcodes the value). That worst case is exactly what's been observed:
|
|
2861
|
-
* a parameter declared purely for show, with the actual filter hardcoded.
|
|
2862
|
-
* Accepts `params.name`, `params['name']`/`params["name"]`, and a
|
|
2863
|
-
* destructuring binding (`const { name } = params`) as valid wiring.
|
|
2864
|
-
*/
|
|
2865
|
-
private findUnwiredParams;
|
|
2866
|
-
/**
|
|
2867
|
-
* Use the schema embedding collection to pre-select relevant tables for
|
|
2868
|
-
* this source + intent. Returns a formatted schema block if confidence is
|
|
2869
|
-
* high (top match ≥ 0.55 and ≥3 candidates), otherwise null.
|
|
2870
|
-
*
|
|
2871
|
-
* When this returns a block, we can skip the SourceAgent's `search_schema`
|
|
2872
|
-
* loop and reduce iteration budget. When it returns null, the SourceAgent
|
|
2873
|
-
* falls back to the existing LLM-driven keyword search (same as today).
|
|
2874
|
-
*/
|
|
2875
|
-
/**
|
|
2876
|
-
* Ids + verbatim names for everything resolved this turn, appended by CODE to
|
|
2877
|
-
* each source dispatch so neither omission nor re-spelling by the model can
|
|
2878
|
-
* lose them. Empty string when nothing was resolved, so intents are untouched
|
|
2879
|
-
* for questions that name no entities.
|
|
2880
|
-
*
|
|
2881
|
-
* Also appends `attrs.scopeSql` when the resolved instance carries one —
|
|
2882
|
-
* same "guaranteed by code" reasoning as the ids/names above, extended to
|
|
2883
|
-
* the one attrs field with a documented, cross-entity-type meaning: a
|
|
2884
|
-
* ready-made SQL predicate an entity's index precomputed (see
|
|
2885
|
-
* ENTITY-SEARCH-DESIGN.md's hierarchy-broadening pattern — branch/region/
|
|
2886
|
-
* state entity types attach it so a lane/route question never needs its
|
|
2887
|
-
* own city-matching join). Confirmed real cost of not doing this: a
|
|
2888
|
-
* branch/state resolved with scopeSql sat unused while the source agent
|
|
2889
|
-
* spent 4 failed exploratory queries rediscovering the exact same
|
|
2890
|
-
* branch-id list by hand (Invalid column name 'StateName'/'CityId'/
|
|
2891
|
-
* 'OrganizationLocationId', in that order, ~144s, before landing on ids
|
|
2892
|
-
* that were sitting in scopeSql from the very first resolve_entities
|
|
2893
|
-
* call). Other attrs (code, counts, etc.) are not dumped here — they are
|
|
2894
|
-
* descriptive, not actionable the way a precomputed predicate is, and
|
|
2895
|
-
* bloating every dispatch with all of them for no clear gain isn't worth
|
|
2896
|
-
* it; scopeSql is the one thing worth this guarantee today.
|
|
2897
|
-
*/
|
|
2898
|
-
private buildResolvedEntitiesBlock;
|
|
2899
|
-
/** Dedupe-and-retain helper shared by resolveConceptsForTurn and handleResolveConcepts. */
|
|
2900
|
-
private retainResolvedConcepts;
|
|
2901
|
-
/**
|
|
2902
|
-
* Same purpose as buildResolvedEntitiesBlock, for concept bodies instead of
|
|
2903
|
-
* entity ids — appended to the dispatch intent so SourceAgent's own,
|
|
2904
|
-
* independent LLM call receives the resolved definitions verbatim rather
|
|
2905
|
-
* than only MainAgent's paraphrased intent text.
|
|
2906
|
-
*/
|
|
2907
|
-
private buildResolvedConceptsBlock;
|
|
2908
|
-
/** True when the backend registered the entity-search collection. */
|
|
2909
|
-
private get entitySearchEnabled();
|
|
2910
|
-
/** True when the backend registered the concepts collection. */
|
|
2911
|
-
private get conceptsEnabled();
|
|
2912
|
-
/**
|
|
2913
|
-
* Concept names for the system prompt. Names ONLY — the body comes back from
|
|
2914
|
-
* resolve_concepts once the LLM has named one, exactly as with the entity
|
|
2915
|
-
* catalog. Putting bodies here would rebuild the always-on context problem
|
|
2916
|
-
* concepts exist to solve.
|
|
2917
|
-
*
|
|
2918
|
-
* Not cached, for the same reason loadEntityCatalog isn't: unchanged rows
|
|
2919
|
-
* render byte-identical text so the prompt-cache prefix still hits, and a
|
|
2920
|
-
* process cache would only buy a window where a new concept is invisible.
|
|
2921
|
-
*/
|
|
2922
|
-
private loadConceptCatalog;
|
|
2923
|
-
/**
|
|
2924
|
-
* The ALWAYS-INJECTED tier: preconditions no question is semantically close
|
|
2925
|
-
* to — date encodings, valid-row filters. These cannot be retrieval-gated.
|
|
2926
|
-
* "What was revenue last quarter?" has no similarity to "dates are DD/MM/YYYY
|
|
2927
|
-
* text", so leaving them to be requested means they are silently dropped and
|
|
2928
|
-
* the answer is confidently wrong rather than visibly missing.
|
|
2929
|
-
*
|
|
2930
|
-
* Bodies ARE included here — unlike the catalog — because there is nothing to
|
|
2931
|
-
* request: being unrequestable is what makes them invariants.
|
|
2932
|
-
*
|
|
2933
|
-
* Also retained into resolvedConcepts (same as an explicit resolve_concepts
|
|
2934
|
-
* call) so these bodies reach SourceAgent's dispatch too — an invariant is
|
|
2935
|
-
* meant to apply everywhere, not just wherever the model happens to ask for
|
|
2936
|
-
* something whose `requires` chain reaches it.
|
|
2937
|
-
*/
|
|
2938
|
-
private loadConceptInvariants;
|
|
2939
|
-
/**
|
|
2940
|
-
* Resolve the concepts for a turn, with a SERVER-SIDE FLOOR.
|
|
2941
|
-
*
|
|
2942
|
-
* Pinning a tool guarantees it is called; it does not guarantee the model
|
|
2943
|
-
* fills in the arguments. Observed: a question containing the exact words
|
|
2944
|
-
* "revenue forecast" produced a call with no concepts at all, and the agent
|
|
2945
|
-
* then used an incomplete copy of the formula from the knowledge base — the
|
|
2946
|
-
* resulting query filtered a customer id against a project column and
|
|
2947
|
-
* returned zero rows on every attempt.
|
|
2948
|
-
*
|
|
2949
|
-
* So when the model names nothing, scan the question itself for catalog names
|
|
2950
|
-
* and aliases on word boundaries. Precise (a literal name is evidence, not a
|
|
2951
|
-
* guess) and asymmetric in the safe direction: an unneeded definition costs a
|
|
2952
|
-
* few hundred ignorable tokens, a missing one costs a wrong answer.
|
|
2953
|
-
*/
|
|
2954
|
-
/**
|
|
2955
|
-
* Returns the tool-facing fields to spread into the resolve_entities JSON
|
|
2956
|
-
* response, PLUS a `_trace` field with everything the trace needs that the
|
|
2957
|
-
* model does not (asked/viaFloor/unmatched). Callers must pull `_trace` out
|
|
2958
|
-
* before spreading the rest into what the model sees — see handleResolveEntities.
|
|
2959
|
-
*/
|
|
2960
|
-
private resolveConceptsForTurn;
|
|
2961
|
-
/**
|
|
2962
|
-
* Never throws: a concept-store outage must degrade to "no definition found"
|
|
2963
|
-
* and leave the agent deriving the formula as it does today, not take the
|
|
2964
|
-
* whole answer down.
|
|
2965
|
-
*/
|
|
2966
|
-
private handleResolveConcepts;
|
|
1622
|
+
private workflows;
|
|
1623
|
+
private config;
|
|
1624
|
+
private streamBuffer;
|
|
1625
|
+
constructor(externalTools: ExternalTool[], config: AgentConfig, streamBuffer?: StreamBuffer, workflows?: WorkflowDescriptor[]);
|
|
2967
1626
|
/**
|
|
2968
|
-
*
|
|
2969
|
-
* LLM NAME a concept instead of guessing at our vocabulary — it can infer
|
|
2970
|
-
* that a question is about unpaid money, but not that we call that
|
|
2971
|
-
* `outstanding-balance`. Full `resolution` detail is fetched by the tool.
|
|
1627
|
+
* Handle a user question using the multi-agent system.
|
|
2972
1628
|
*
|
|
2973
|
-
*
|
|
2974
|
-
*
|
|
2975
|
-
*
|
|
2976
|
-
*
|
|
2977
|
-
*
|
|
2978
|
-
*
|
|
2979
|
-
*/
|
|
2980
|
-
private loadEntityCatalog;
|
|
2981
|
-
/**
|
|
2982
|
-
* Never throws: a resolver outage must degrade to "nothing resolved" and
|
|
2983
|
-
* leave the agent exactly as it was, not take the whole answer down.
|
|
1629
|
+
* This is ONE LLM.streamWithTools() call. The LLM:
|
|
1630
|
+
* 1. Sees source summaries + direct tool descriptions in system prompt
|
|
1631
|
+
* 2. Decides which tool(s) to call (routing)
|
|
1632
|
+
* 3. Source tools → SourceAgent runs independently → returns data
|
|
1633
|
+
* 4. Direct tools → fn() called directly with LLM params → returns data
|
|
1634
|
+
* 5. Generates final analysis text
|
|
2984
1635
|
*/
|
|
2985
|
-
|
|
2986
|
-
private preResolveSchema;
|
|
1636
|
+
handleQuestion(userPrompt: string, apiKey?: string, conversationHistory?: string, streamCallback?: (chunk: string) => void): Promise<AgentResponse>;
|
|
2987
1637
|
/**
|
|
2988
1638
|
* Execute a direct tool — call fn() with LLM-provided params, no SourceAgent.
|
|
2989
1639
|
*/
|
|
@@ -3051,43 +1701,6 @@ interface LLMOptions {
|
|
|
3051
1701
|
apiKey?: string;
|
|
3052
1702
|
baseURL?: string;
|
|
3053
1703
|
partial?: (chunk: string) => void;
|
|
3054
|
-
/**
|
|
3055
|
-
* Per-request cancellation. When the caller aborts this signal (user hit
|
|
3056
|
-
* "Stop"), the underlying provider request is cancelled and the call throws
|
|
3057
|
-
* a RequestAbortedError. Threaded into the provider `messages.create` request
|
|
3058
|
-
* options and checked between tool-loop iterations. Currently honored on the
|
|
3059
|
-
* Anthropic path (the agent flow's default provider).
|
|
3060
|
-
*/
|
|
3061
|
-
signal?: AbortSignal;
|
|
3062
|
-
/**
|
|
3063
|
-
* Forces a tool call on the FIRST iteration of streamWithTools only
|
|
3064
|
-
* (subsequent iterations revert to auto). Used by fork mode to stop the
|
|
3065
|
-
* model from ending its turn with a bare "I'll adapt the script…" preamble
|
|
3066
|
-
* and zero tool calls. `{ type: 'any' }` lets the model pick which tool
|
|
3067
|
-
* (write_script in the common case, a source tool for schema discovery);
|
|
3068
|
-
* `{ type: 'tool', name }` pins a specific tool. Honored on both the
|
|
3069
|
-
* Anthropic path and the OpenAI/OpenRouter path (mapped to OpenAI's
|
|
3070
|
-
* tool_choice: 'required' / a named function).
|
|
3071
|
-
*/
|
|
3072
|
-
firstIterationToolChoice?: {
|
|
3073
|
-
type: 'any';
|
|
3074
|
-
} | {
|
|
3075
|
-
type: 'tool';
|
|
3076
|
-
name: string;
|
|
3077
|
-
};
|
|
3078
|
-
/**
|
|
3079
|
-
* Internal — set only by the OpenRouter wrappers when the target is a Claude
|
|
3080
|
-
* model. Tells the OpenAI-wire path to emit Anthropic `cache_control`
|
|
3081
|
-
* breakpoints (OpenRouter forwards them to Anthropic for prompt caching).
|
|
3082
|
-
* Never set for direct OpenAI/Groq calls, so their requests are unchanged.
|
|
3083
|
-
*/
|
|
3084
|
-
_openrouterClaudeCaching?: boolean;
|
|
3085
|
-
/**
|
|
3086
|
-
* Internal — OpenRouter provider-routing preferences (forwarded as the
|
|
3087
|
-
* `provider` body field). Set by the OpenRouter wrappers to steer routing to
|
|
3088
|
-
* a fast backend (e.g. {sort:'throughput'}). Never set for direct OpenAI/Groq.
|
|
3089
|
-
*/
|
|
3090
|
-
_openrouterProvider?: Record<string, unknown>;
|
|
3091
1704
|
}
|
|
3092
1705
|
interface Tool {
|
|
3093
1706
|
name: string;
|
|
@@ -3140,41 +1753,15 @@ declare class LLM {
|
|
|
3140
1753
|
* (e.g. "claude-sonnet-4.5"). OpenRouter slugs drop the date suffix and use dotted versions.
|
|
3141
1754
|
*/
|
|
3142
1755
|
private static _toOpenRouterSlug;
|
|
3143
|
-
/**
|
|
3144
|
-
* Per-provider proxy base URL. Returns `${SUPERATOM_LLM_PROXY_URL}/<provider>`
|
|
3145
|
-
* when our Cloudflare LLM proxy is configured, else undefined (→ talk to the
|
|
3146
|
-
* provider directly, legacy behaviour). An explicit options.baseURL (e.g.
|
|
3147
|
-
* OpenRouter) always wins and is never overridden. See backend/docs/llm-proxy.md.
|
|
3148
|
-
*/
|
|
3149
|
-
private static _proxyBaseURL;
|
|
3150
1756
|
private static _openrouterOptions;
|
|
3151
|
-
private static _isRetryableProviderError;
|
|
3152
|
-
private static _withOpenrouterRetry;
|
|
3153
1757
|
private static _openrouterText;
|
|
3154
1758
|
private static _openrouterStream;
|
|
3155
1759
|
private static _openrouterStreamWithTools;
|
|
3156
|
-
/**
|
|
3157
|
-
* Build an Anthropic client. Routes through our Cloudflare LLM proxy when
|
|
3158
|
-
* SUPERATOM_LLM_PROXY_URL is set (each client ships a per-client proxy key as
|
|
3159
|
-
* ANTHROPIC_API_KEY and never holds the real key); otherwise talks to
|
|
3160
|
-
* api.anthropic.com directly. See backend/docs/llm-proxy.md.
|
|
3161
|
-
*/
|
|
3162
|
-
private static _anthropicClient;
|
|
3163
|
-
/** True when OpenRouter is configured as a fail-open fallback for Claude. */
|
|
3164
|
-
private static _openrouterAvailable;
|
|
3165
|
-
/** Remap an Anthropic model id to the OpenRouter model path for fail-open. */
|
|
3166
|
-
private static _anthropicFallbackModel;
|
|
3167
1760
|
private static _anthropicText;
|
|
3168
1761
|
private static _anthropicStream;
|
|
3169
1762
|
private static _anthropicStreamWithTools;
|
|
3170
1763
|
private static _groqText;
|
|
3171
1764
|
private static _groqStream;
|
|
3172
|
-
/**
|
|
3173
|
-
* Gemini request options carrying the proxy base URL, or undefined → talk to
|
|
3174
|
-
* generativelanguage.googleapis.com directly. The Google SDK takes baseUrl as a
|
|
3175
|
-
* per-model request option, not a constructor arg. See backend/docs/llm-proxy.md.
|
|
3176
|
-
*/
|
|
3177
|
-
private static _geminiRequestOptions;
|
|
3178
1765
|
private static _geminiText;
|
|
3179
1766
|
private static _geminiStream;
|
|
3180
1767
|
/**
|
|
@@ -3183,28 +1770,8 @@ declare class LLM {
|
|
|
3183
1770
|
*/
|
|
3184
1771
|
private static _cleanSchemaForGemini;
|
|
3185
1772
|
private static _geminiStreamWithTools;
|
|
3186
|
-
/** True for Anthropic/Claude model ids — gates OpenRouter prompt caching. */
|
|
3187
|
-
private static _isClaudeModel;
|
|
3188
|
-
/**
|
|
3189
|
-
* Build the OpenAI-wire system message. For OpenRouter + Claude
|
|
3190
|
-
* (cacheClaude=true) it emits content parts carrying Anthropic
|
|
3191
|
-
* `cache_control` breakpoints (preserving any the caller set, else marking
|
|
3192
|
-
* the last block), so OpenRouter forwards them to Anthropic for prompt
|
|
3193
|
-
* caching. Otherwise it returns a plain flattened string — unchanged for
|
|
3194
|
-
* direct OpenAI/Groq.
|
|
3195
|
-
*/
|
|
3196
|
-
private static _openaiSystemMessage;
|
|
3197
|
-
/**
|
|
3198
|
-
* Split an OpenAI-wire usage object. `prompt_tokens` INCLUDES cached tokens,
|
|
3199
|
-
* so we subtract them out (Anthropic-style: input excludes cache reads) and
|
|
3200
|
-
* report cached separately — this makes calculateCost price cache reads at
|
|
3201
|
-
* the discounted rate and reflects OpenRouter prompt-cache savings in logs.
|
|
3202
|
-
*/
|
|
3203
|
-
private static _openaiUsage;
|
|
3204
1773
|
private static _openaiText;
|
|
3205
1774
|
private static _openaiStream;
|
|
3206
|
-
/** Map the Anthropic-style firstIterationToolChoice to OpenAI's tool_choice. */
|
|
3207
|
-
private static _openaiToolChoice;
|
|
3208
1775
|
private static _openaiStreamWithTools;
|
|
3209
1776
|
/**
|
|
3210
1777
|
* Parse JSON string, handling markdown code blocks and surrounding text
|
|
@@ -3294,25 +1861,16 @@ declare class UILogCollector {
|
|
|
3294
1861
|
setUIBlockId(uiBlockId: string): void;
|
|
3295
1862
|
}
|
|
3296
1863
|
|
|
3297
|
-
/**
|
|
3298
|
-
* UIBlock represents a single user and assistant message block in a thread
|
|
3299
|
-
* Contains user question, component metadata, component data, text response, and available actions
|
|
3300
|
-
*/
|
|
3301
1864
|
declare class UIBlock {
|
|
3302
1865
|
private id;
|
|
3303
1866
|
private userQuestion;
|
|
3304
1867
|
private generatedComponentMetadata;
|
|
3305
1868
|
private componentData;
|
|
1869
|
+
/** Digest read back from storage; componentData is not persisted. */
|
|
1870
|
+
private restoredDataSummary;
|
|
3306
1871
|
private textResponse;
|
|
3307
1872
|
private actions;
|
|
3308
1873
|
private createdAt;
|
|
3309
|
-
/**
|
|
3310
|
-
* Which script recipe produced this answer, when a script did. Read on the
|
|
3311
|
-
* NEXT turn so the user can say "use mode instead" and have the matcher
|
|
3312
|
-
* resolve it to a concrete script (the `edit` tier is unreachable without it).
|
|
3313
|
-
* See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 1.
|
|
3314
|
-
*/
|
|
3315
|
-
private scriptBinding;
|
|
3316
1874
|
/**
|
|
3317
1875
|
* Creates a new UIBlock instance
|
|
3318
1876
|
* @param userQuestion - The user's question or input
|
|
@@ -3321,8 +1879,11 @@ declare class UIBlock {
|
|
|
3321
1879
|
* @param actions - Optional array of available actions
|
|
3322
1880
|
* @param id - Optional custom ID, generates UUID if not provided
|
|
3323
1881
|
* @param textResponse - Optional text response from LLM
|
|
1882
|
+
* @param createdAt - Optional original timestamp. Needed when a block is rebuilt from
|
|
1883
|
+
* storage: conversation context is ordered by this, so defaulting to now would make
|
|
1884
|
+
* a restored turn look newer than the live one.
|
|
3324
1885
|
*/
|
|
3325
|
-
constructor(userQuestion: string, componentData?: Record<string, any>, generatedComponentMetadata?: Record<string, any>, actions?: Action[], id?: string, textResponse?: string | null);
|
|
1886
|
+
constructor(userQuestion: string, componentData?: Record<string, any>, generatedComponentMetadata?: Record<string, any>, actions?: Action[], id?: string, textResponse?: string | null, createdAt?: Date, restoredDataSummary?: string | null);
|
|
3326
1887
|
/**
|
|
3327
1888
|
* Get the UIBlock ID
|
|
3328
1889
|
*/
|
|
@@ -3368,6 +1929,16 @@ declare class UIBlock {
|
|
|
3368
1929
|
* Set or update component data with size and row limits
|
|
3369
1930
|
*/
|
|
3370
1931
|
setComponentData(data: Record<string, any>): void;
|
|
1932
|
+
/**
|
|
1933
|
+
* One line describing the data this block's component was built from, for
|
|
1934
|
+
* conversation context. Reads the summary the data handler already stored —
|
|
1935
|
+
* record counts and the result's non-array aggregates — so a later turn can
|
|
1936
|
+
* refer to what was shown instead of guessing at it.
|
|
1937
|
+
*
|
|
1938
|
+
* Generic by construction: whatever scalar aggregates a tool returns are what
|
|
1939
|
+
* appear here, with no knowledge of any particular tool or domain.
|
|
1940
|
+
*/
|
|
1941
|
+
getDataSummaryLine(maxChars?: number): string | null;
|
|
3371
1942
|
/**
|
|
3372
1943
|
* Set or update text response
|
|
3373
1944
|
*/
|
|
@@ -3404,22 +1975,9 @@ declare class UIBlock {
|
|
|
3404
1975
|
* Clear all actions
|
|
3405
1976
|
*/
|
|
3406
1977
|
clearActions(): void;
|
|
3407
|
-
/** The program-generated half of the answer — see setProgramAnswer. */
|
|
3408
|
-
programAnswer?: string | null;
|
|
3409
|
-
/**
|
|
3410
|
-
* Bind this block to the script recipe that produced its answer.
|
|
3411
|
-
*/
|
|
3412
|
-
setScriptBinding(binding: Record<string, any> | null): void;
|
|
3413
|
-
/**
|
|
3414
|
-
* The program-generated half of the answer, kept verbatim so a reload can
|
|
3415
|
-
* replace exactly that text without disturbing the streamed narration.
|
|
3416
|
-
*/
|
|
3417
|
-
setProgramAnswer(text: string | null): void;
|
|
3418
|
-
getProgramAnswer(): string | null;
|
|
3419
1978
|
/**
|
|
3420
|
-
*
|
|
1979
|
+
* Get creation timestamp
|
|
3421
1980
|
*/
|
|
3422
|
-
getScriptBinding(): Record<string, any> | null;
|
|
3423
1981
|
getCreatedAt(): Date;
|
|
3424
1982
|
/**
|
|
3425
1983
|
* Convert UIBlock to JSON-serializable object
|
|
@@ -3427,6 +1985,16 @@ declare class UIBlock {
|
|
|
3427
1985
|
toJSON(): Record<string, any>;
|
|
3428
1986
|
}
|
|
3429
1987
|
|
|
1988
|
+
/** One stored turn, as a host's conversation collection hands it back. */
|
|
1989
|
+
interface HydratedTurn {
|
|
1990
|
+
id: string;
|
|
1991
|
+
userQuestion?: string;
|
|
1992
|
+
textResponse?: string | null;
|
|
1993
|
+
componentMetadata?: Record<string, any>;
|
|
1994
|
+
/** Compact digest of the data the turn's component was built from, if stored. */
|
|
1995
|
+
dataSummary?: string | null;
|
|
1996
|
+
createdAt?: Date | string;
|
|
1997
|
+
}
|
|
3430
1998
|
/**
|
|
3431
1999
|
* Thread represents a conversation thread containing multiple UIBlocks
|
|
3432
2000
|
* Each UIBlock in a thread represents a user question and assistant response pair
|
|
@@ -3435,6 +2003,7 @@ declare class Thread {
|
|
|
3435
2003
|
private id;
|
|
3436
2004
|
private uiblocks;
|
|
3437
2005
|
private createdAt;
|
|
2006
|
+
private hydrated;
|
|
3438
2007
|
/**
|
|
3439
2008
|
* Creates a new Thread instance
|
|
3440
2009
|
* @param id - Optional custom ID, generates UUID if not provided
|
|
@@ -3448,6 +2017,14 @@ declare class Thread {
|
|
|
3448
2017
|
* Add a UIBlock to the thread
|
|
3449
2018
|
*/
|
|
3450
2019
|
addUIBlock(uiblock: UIBlock): void;
|
|
2020
|
+
/**
|
|
2021
|
+
* Rebuild past turns from storage so a thread survives a restart or a new session.
|
|
2022
|
+
* Once only, and never over a block already held: anything in memory is the live
|
|
2023
|
+
* copy and may carry state the stored row does not.
|
|
2024
|
+
*/
|
|
2025
|
+
hydrate(turns: HydratedTurn[]): number;
|
|
2026
|
+
/** Whether hydration has already been attempted, successful or not. */
|
|
2027
|
+
isHydrated(): boolean;
|
|
3451
2028
|
/**
|
|
3452
2029
|
* Get a UIBlock by ID
|
|
3453
2030
|
*/
|
|
@@ -3487,40 +2064,7 @@ declare class Thread {
|
|
|
3487
2064
|
* @param currentUIBlockId - ID of current UIBlock to exclude from context (optional)
|
|
3488
2065
|
* @returns Formatted conversation history string
|
|
3489
2066
|
*/
|
|
3490
|
-
|
|
3491
|
-
* The script recipe bound to the most recent completed UIBlock — i.e. the
|
|
3492
|
-
* script behind the answer the user is currently looking at. Drives the
|
|
3493
|
-
* matcher's `edit` tier: without it, "use mode instead" has no target and
|
|
3494
|
-
* falls through to regeneration.
|
|
3495
|
-
* See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 1.
|
|
3496
|
-
*/
|
|
3497
|
-
getActiveScriptBinding(currentUIBlockId?: string): Record<string, any> | null;
|
|
3498
|
-
/**
|
|
3499
|
-
* The recent script-backed answers in this thread, newest first — the
|
|
3500
|
-
* candidate set a user-directed edit can target.
|
|
3501
|
-
*
|
|
3502
|
-
* Returning several rather than only the newest is what lets an instruction
|
|
3503
|
-
* name its own target ("use the mode for the WSP one"). With a single
|
|
3504
|
-
* candidate every edit lands on the most recent script, which silently edits
|
|
3505
|
-
* the wrong recipe whenever the user meant an earlier one.
|
|
3506
|
-
*
|
|
3507
|
-
* Deduped by recipeId (newest occurrence wins) so a long editing session on
|
|
3508
|
-
* one script doesn't crowd out the others. Each entry carries the question
|
|
3509
|
-
* that produced it — without that the candidates are indistinguishable.
|
|
3510
|
-
*
|
|
3511
|
-
* In-memory only: dies with the process. The caller falls back to the
|
|
3512
|
-
* persisted bindings when this comes back empty.
|
|
3513
|
-
* See backend/docs/SCRIPT-EDIT-DESIGN.md § Component 1.
|
|
3514
|
-
*/
|
|
3515
|
-
getScriptBindings(limit?: number, currentUIBlockId?: string): Record<string, any>[];
|
|
3516
|
-
/**
|
|
3517
|
-
* @param getScriptBody Resolves a script-backed turn's EXACT script, pinned
|
|
3518
|
-
* to the version that turn actually ran — never today's (possibly
|
|
3519
|
-
* since-edited) live body. Owned by the caller (needs a ScriptStore, which
|
|
3520
|
-
* Thread doesn't hold) — omit it and every turn falls back to the
|
|
3521
|
-
* no-script summary below.
|
|
3522
|
-
*/
|
|
3523
|
-
getConversationContext(limit?: number, currentUIBlockId?: string, getScriptBody?: (recipeId: string, version: number) => Promise<string | null>): Promise<string>;
|
|
2067
|
+
getConversationContext(limit?: number, currentUIBlockId?: string): string;
|
|
3524
2068
|
/**
|
|
3525
2069
|
* Convert Thread to JSON-serializable object
|
|
3526
2070
|
*/
|
|
@@ -4182,7 +2726,7 @@ declare abstract class BaseLLM {
|
|
|
4182
2726
|
* This helps provide intelligent suggestions for follow-up queries
|
|
4183
2727
|
* For general/conversational questions without components, pass textResponse instead
|
|
4184
2728
|
*/
|
|
4185
|
-
generateNextQuestions(originalUserPrompt: string, component?: Component | null, componentData?: Record<string, unknown>, apiKey?: string, conversationHistory?: string, textResponse?: string
|
|
2729
|
+
generateNextQuestions(originalUserPrompt: string, component?: Component | null, componentData?: Record<string, unknown>, apiKey?: string, conversationHistory?: string, textResponse?: string): Promise<string[]>;
|
|
4186
2730
|
}
|
|
4187
2731
|
|
|
4188
2732
|
interface AnthropicLLMConfig extends BaseLLMConfig {
|
|
@@ -4259,10 +2803,33 @@ declare class QueryCache {
|
|
|
4259
2803
|
private cache;
|
|
4260
2804
|
private ttlMs;
|
|
4261
2805
|
private maxCacheSize;
|
|
2806
|
+
private maxCacheBytes;
|
|
2807
|
+
private currentBytes;
|
|
4262
2808
|
private cleanupInterval;
|
|
4263
2809
|
private readonly algorithm;
|
|
4264
2810
|
private encryptionKey;
|
|
4265
2811
|
constructor();
|
|
2812
|
+
/**
|
|
2813
|
+
* Set the byte budget for cached result data.
|
|
2814
|
+
* @param megabytes - Budget in MB. Keep it well under the process memory limit.
|
|
2815
|
+
*/
|
|
2816
|
+
setMaxBytes(megabytes: number): void;
|
|
2817
|
+
/** Current estimated bytes held by the data cache. */
|
|
2818
|
+
getCurrentBytes(): number;
|
|
2819
|
+
/**
|
|
2820
|
+
* Rough retained size of a result, in bytes.
|
|
2821
|
+
*
|
|
2822
|
+
* Sampled rather than exact: stringifying a multi-megabyte result on every set()
|
|
2823
|
+
* would allocate the very memory this budget exists to protect. Estimated from a
|
|
2824
|
+
* few rows of the largest array in the payload, at 2 bytes per UTF-16 char.
|
|
2825
|
+
* Both error directions are safe — under-estimating evicts less than ideal,
|
|
2826
|
+
* over-estimating evicts more, and a miss only re-runs the query.
|
|
2827
|
+
*/
|
|
2828
|
+
private estimateBytes;
|
|
2829
|
+
/** Largest array at the top level or one level in — where result rows live. */
|
|
2830
|
+
private largestArray;
|
|
2831
|
+
/** Drop least-recently-used entries until the budget is satisfied. */
|
|
2832
|
+
private evictUntilUnderBudget;
|
|
4266
2833
|
/**
|
|
4267
2834
|
* Set the cache TTL (Time To Live)
|
|
4268
2835
|
* @param minutes - TTL in minutes (default: 10)
|
|
@@ -4388,808 +2955,6 @@ declare class DashboardConversationHistory {
|
|
|
4388
2955
|
}
|
|
4389
2956
|
declare const dashboardConversationHistory: DashboardConversationHistory;
|
|
4390
2957
|
|
|
4391
|
-
/**
|
|
4392
|
-
* Whole-dashboard generation via Pi, a terminal coding agent — as opposed to
|
|
4393
|
-
* DASH_COMP_REQ's single-widget-at-a-time flow. Runs Pi in-process via its
|
|
4394
|
-
* SDK (createAgentSession), not as a subprocess: no shell, no argument
|
|
4395
|
-
* quoting, no stdin/stdout piping, none of the Windows-specific subprocess
|
|
4396
|
-
* issues that came with spawning the `pi` CLI directly.
|
|
4397
|
-
*
|
|
4398
|
-
* Called from sdk-nodejs/src/dashboardAgent/index.ts (DASHBOARD_AGENT_REQ),
|
|
4399
|
-
* which owns the generic streaming/abort machinery (mirrors USER_PROMPT_REQ)
|
|
4400
|
-
* and passes `signal`/`onProgress` alongside the normal params — this stays
|
|
4401
|
-
* within CollectionHandler's loose (params) => Promise<result> typing, no
|
|
4402
|
-
* change needed to that shared type.
|
|
4403
|
-
*
|
|
4404
|
-
* This mechanism is generic and reusable across any deployment. What's
|
|
4405
|
-
* genuinely project-specific — where AGENTS.md lives, which model to use —
|
|
4406
|
-
* is supplied via `DashboardAgentCollectionConfig`, with defaults sensible
|
|
4407
|
-
* enough that most callers don't need to override them (see below). The
|
|
4408
|
-
* data-source tool list and the dashboard's current state both come from
|
|
4409
|
-
* things sdk-nodejs already exposes generically: `sdk.getTools()` (whatever
|
|
4410
|
-
* this deployment registered via `sdk.setTools()`) and `sdk.callCollection
|
|
4411
|
-
* ('dashboards', 'query', ...)` (whatever this deployment already registered
|
|
4412
|
-
* under that name/shape) — no per-deployment callback needed for either.
|
|
4413
|
-
* Same convention on the way out: after a successful run, the prompt and the
|
|
4414
|
-
* full response text are handed to `sdk.callCollection('dashboard-agent-
|
|
4415
|
-
* conversations', 'create', ...)` if this deployment has registered one —
|
|
4416
|
-
* skipped silently otherwise, since conversation history is optional.
|
|
4417
|
-
*
|
|
4418
|
-
* Pi verifies every query against the live database itself (via whatever
|
|
4419
|
-
* local tool-execution bridge the deployment exposes, e.g. an HTTP bridge
|
|
4420
|
-
* on localhost), but does NOT persist the result itself — it writes the
|
|
4421
|
-
* finished DSL to an absolute path inside `runtimeDir`, told to it explicitly
|
|
4422
|
-
* in the prompt, and stops there. This handler reads that file after the run
|
|
4423
|
-
* finishes and returns its content as `dashboard` in the result. The caller
|
|
4424
|
-
* (frontend) is the one that actually saves it, via whatever authenticated
|
|
4425
|
-
* create/update path any other dashboard edit goes through — Pi has no user
|
|
4426
|
-
* session/auth context of its own, so persistence shouldn't happen from
|
|
4427
|
-
* inside it.
|
|
4428
|
-
*
|
|
4429
|
-
* Session persistence: the FIRST call for a dashboardId pays the full cost
|
|
4430
|
-
* (explore KB, discover schema, plan, verify, build). Every call after that
|
|
4431
|
-
* resumes the same session file (SessionManager.open) so Pi has everything
|
|
4432
|
-
* it already learned — it only needs to reason about the new, smaller ask,
|
|
4433
|
-
* not rediscover the whole dashboard from scratch. The session's file path
|
|
4434
|
-
* (AgentSession.sessionFile) is captured right after creation and persisted
|
|
4435
|
-
* in a small local file, keyed by dashboardId, inside `runtimeDir`.
|
|
4436
|
-
*/
|
|
4437
|
-
interface DashboardAgentCollectionConfig {
|
|
4438
|
-
/**
|
|
4439
|
-
* Working directory Pi runs from — must contain AGENTS.md. This is a
|
|
4440
|
-
* version-controlled prompt file, so `cwd` is expected to live somewhere
|
|
4441
|
-
* like a `.prompts/` folder alongside the deployment's other prompts.
|
|
4442
|
-
* Default: `<process.cwd()>/.prompts/dashboard-agent` — the same
|
|
4443
|
-
* process.cwd()-based convention PromptLoader already uses for the main
|
|
4444
|
-
* agent's prompts, which needs no explicit override in the common case
|
|
4445
|
-
* (the backend process's own cwd already is its project root).
|
|
4446
|
-
*/
|
|
4447
|
-
cwd?: string;
|
|
4448
|
-
/**
|
|
4449
|
-
* Where drafts/, the session-id map, and dashboard.log get written —
|
|
4450
|
-
* separate from `cwd` deliberately, so this deployment's runtime state
|
|
4451
|
-
* (regenerated per session, safe to gitignore) doesn't sit inside the
|
|
4452
|
-
* same folder as the version-controlled AGENTS.md prompt.
|
|
4453
|
-
* Default: `<process.cwd()>/.pi-dashboard-agent-runtime`.
|
|
4454
|
-
*/
|
|
4455
|
-
runtimeDir?: string;
|
|
4456
|
-
/** Model provider (default: process.env.PI_AGENT_PROVIDER || 'openrouter'). */
|
|
4457
|
-
provider?: string;
|
|
4458
|
-
/** Model id (default: process.env.PI_AGENT_MODEL || 'anthropic/claude-sonnet-4.5'). */
|
|
4459
|
-
model?: string;
|
|
4460
|
-
/**
|
|
4461
|
-
* true (default): every request starts a brand-new pi session, with the 2
|
|
4462
|
-
* most recent prior responses (if any) injected into the prompt as
|
|
4463
|
-
* context — bounded cost per request, but pi re-explores schema/KB facts
|
|
4464
|
-
* it already verified in an earlier turn on this same dashboard.
|
|
4465
|
-
* false: resumes the same session file across requests on a given
|
|
4466
|
-
* dashboard — pi keeps everything it already learned, but context (and
|
|
4467
|
-
* cost) grows unbounded across turns (one observed turn: 2M+ cache-read
|
|
4468
|
-
* tokens after a handful of edits on the same dashboard).
|
|
4469
|
-
* Default: process.env.PI_AGENT_FRESH_SESSION !== 'false'.
|
|
4470
|
-
*/
|
|
4471
|
-
freshSession?: boolean;
|
|
4472
|
-
}
|
|
4473
|
-
declare function registerDashboardAgentCollection(sdk: SuperatomSDK, config?: DashboardAgentCollectionConfig): void;
|
|
4474
|
-
|
|
4475
|
-
/**
|
|
4476
|
-
* Coding-agent driver contract — one shape over every harness (codex today;
|
|
4477
|
-
* claude-code / opencode / pi next). Callers depend on this file only, never on
|
|
4478
|
-
* a harness SDK, so swapping the agent behind a task is a config change.
|
|
4479
|
-
*
|
|
4480
|
-
* Deliberately narrower than the harness SDKs it wraps: the three things a
|
|
4481
|
-
* production run needs and that harness abstractions usually omit — real abort,
|
|
4482
|
-
* real token accounting, and structured tool args — are part of the contract,
|
|
4483
|
-
* not per-driver extras.
|
|
4484
|
-
*/
|
|
4485
|
-
type AgentEventKind = 'turn' | 'message' | 'reasoning' | 'command' | 'tool' | 'file' | 'todo' | 'error';
|
|
4486
|
-
interface AgentEvent {
|
|
4487
|
-
kind: AgentEventKind;
|
|
4488
|
-
/** Stable across started→updated→completed, so a UI updates one block in place. */
|
|
4489
|
-
id?: string;
|
|
4490
|
-
text?: string;
|
|
4491
|
-
command?: string;
|
|
4492
|
-
output?: string;
|
|
4493
|
-
/** Tool calls carry real parsed args — never SQL scraped back out of a shell string. */
|
|
4494
|
-
tool?: {
|
|
4495
|
-
server?: string;
|
|
4496
|
-
name: string;
|
|
4497
|
-
args?: unknown;
|
|
4498
|
-
};
|
|
4499
|
-
status?: 'in_progress' | 'completed' | 'failed';
|
|
4500
|
-
done?: boolean;
|
|
4501
|
-
}
|
|
4502
|
-
interface AgentUsage {
|
|
4503
|
-
inputTokens: number;
|
|
4504
|
-
outputTokens: number;
|
|
4505
|
-
reasoningTokens: number;
|
|
4506
|
-
cacheReadTokens: number;
|
|
4507
|
-
cacheWriteTokens: number;
|
|
4508
|
-
/** Tool + command invocations. With tokens, separates "silently did nothing" from a real run. */
|
|
4509
|
-
toolCalls: number;
|
|
4510
|
-
/** Only when the harness reports it — codex reports tokens but not cost. */
|
|
4511
|
-
costUSD?: number;
|
|
4512
|
-
}
|
|
4513
|
-
interface AgentRunHandlers {
|
|
4514
|
-
/** Formatted live stream: assistant text deltas plus one-line tool/command markers. */
|
|
4515
|
-
onOutput?: (chunk: string) => void;
|
|
4516
|
-
onEvent?: (event: AgentEvent) => void;
|
|
4517
|
-
/** Assistant prose only — safe to show a non-technical user as progress. */
|
|
4518
|
-
onNarration?: (text: string) => void;
|
|
4519
|
-
onUsage?: (usage: AgentUsage) => void;
|
|
4520
|
-
/**
|
|
4521
|
-
* Polled once the turn is live. When it returns true the run ends immediately —
|
|
4522
|
-
* for tasks whose deliverable is a file, the moment it exists there is nothing
|
|
4523
|
-
* left to wait for.
|
|
4524
|
-
*/
|
|
4525
|
-
doneWhen?: () => boolean | Promise<boolean>;
|
|
4526
|
-
}
|
|
4527
|
-
type AgentRunStatus = 'completed' | 'early' | 'aborted' | 'error';
|
|
4528
|
-
interface AgentRunResult {
|
|
4529
|
-
status: AgentRunStatus;
|
|
4530
|
-
/** The final assistant message. */
|
|
4531
|
-
answer: string;
|
|
4532
|
-
ms: number;
|
|
4533
|
-
usage: AgentUsage;
|
|
4534
|
-
/**
|
|
4535
|
-
* Set when status is 'error'. Covers stream-reported failures too, which arrive
|
|
4536
|
-
* as events rather than thrown exceptions — a swallowed provider error is the
|
|
4537
|
-
* failure mode that otherwise looks like a successful empty run.
|
|
4538
|
-
*/
|
|
4539
|
-
error?: string;
|
|
4540
|
-
sessionId?: string;
|
|
4541
|
-
}
|
|
4542
|
-
interface McpServerSpec {
|
|
4543
|
-
command: string;
|
|
4544
|
-
args?: string[];
|
|
4545
|
-
env?: Record<string, string>;
|
|
4546
|
-
}
|
|
4547
|
-
interface CodingAgentSessionOptions {
|
|
4548
|
-
/** Working directory the agent operates in. Scope it to a runtime dir, not a source checkout. */
|
|
4549
|
-
cwd: string;
|
|
4550
|
-
model?: string;
|
|
4551
|
-
/** Resume a prior conversation — the value a previous run returned as sessionId. */
|
|
4552
|
-
resumeId?: string;
|
|
4553
|
-
/** Tools, as MCP servers. Keyed by server name, which shows up on every tool event. */
|
|
4554
|
-
mcpServers?: Record<string, McpServerSpec>;
|
|
4555
|
-
/**
|
|
4556
|
-
* Extra env for the agent process. By default only a small allowlist is passed
|
|
4557
|
-
* through (see ENV_ALLOWLIST) so an agent with shell access can't read the
|
|
4558
|
-
* backend's own secrets out of its environment.
|
|
4559
|
-
*/
|
|
4560
|
-
env?: Record<string, string>;
|
|
4561
|
-
/** Opt out of env scrubbing. Only for local debugging. */
|
|
4562
|
-
inheritEnv?: boolean;
|
|
4563
|
-
}
|
|
4564
|
-
interface CodingAgentSession {
|
|
4565
|
-
readonly harness: string;
|
|
4566
|
-
/** Structured event log vs. a raw terminal stream — the UI picks its renderer from this. */
|
|
4567
|
-
readonly kind: 'events' | 'pty';
|
|
4568
|
-
run(prompt: string, handlers?: AgentRunHandlers, signal?: AbortSignal): Promise<AgentRunResult>;
|
|
4569
|
-
/** Rolling structured events, for replay when a client reconnects mid-run. */
|
|
4570
|
-
events(): AgentEvent[];
|
|
4571
|
-
/** Rolling formatted text, same purpose as events() for text-oriented views. */
|
|
4572
|
-
buffer(): string;
|
|
4573
|
-
busy(): boolean;
|
|
4574
|
-
/** Persist this and pass it back as resumeId to continue the conversation. */
|
|
4575
|
-
sessionId(): string | undefined;
|
|
4576
|
-
/** Abandon the conversation; the next run starts fresh. */
|
|
4577
|
-
reset(): void;
|
|
4578
|
-
dispose(): void;
|
|
4579
|
-
}
|
|
4580
|
-
|
|
4581
|
-
/**
|
|
4582
|
-
* Harness registry. Kept separate from index.ts so collection.ts can reach the
|
|
4583
|
-
* factory without importing the module's own barrel (a cycle tsup would have to
|
|
4584
|
-
* resolve at bundle time).
|
|
4585
|
-
*/
|
|
4586
|
-
type Harness = 'codex';
|
|
4587
|
-
declare function createCodingAgentSession(harness: Harness, opts: CodingAgentSessionOptions): CodingAgentSession;
|
|
4588
|
-
|
|
4589
|
-
/**
|
|
4590
|
-
* Codex driver — OpenAI Codex via @openai/codex-sdk.
|
|
4591
|
-
*
|
|
4592
|
-
* FORMAT CONTRACT: written against @openai/codex-sdk 0.149.1. Harness event
|
|
4593
|
-
* shapes drift; if the event log goes blank after an SDK bump, check normEvent
|
|
4594
|
-
* against the package's dist/index.d.ts first.
|
|
4595
|
-
*
|
|
4596
|
-
* Three things this leans on that the SDK gives natively, so we don't reinvent
|
|
4597
|
-
* them: TurnOptions.signal (real cancellation), TurnCompletedEvent.usage (token
|
|
4598
|
-
* accounting), and mcp_tool_call items (tool args arrive parsed, not scraped
|
|
4599
|
-
* out of a shell command string).
|
|
4600
|
-
*
|
|
4601
|
-
* The package is an optionalDependency: every deployment gets it, but an
|
|
4602
|
-
* install that cannot fetch the ~309MB platform binary skips it rather than
|
|
4603
|
-
* failing. It is therefore loaded dynamically and its types mirrored
|
|
4604
|
-
* structurally below, so a VM without it still builds, starts, and runs
|
|
4605
|
-
* everything else — only the coding agent reports itself unavailable.
|
|
4606
|
-
*/
|
|
4607
|
-
type CodexSandboxMode = 'read-only' | 'workspace-write' | 'danger-full-access';
|
|
4608
|
-
type CodexReasoningEffort = 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'ultra';
|
|
4609
|
-
interface CodexSessionOptions extends CodingAgentSessionOptions {
|
|
4610
|
-
reasoningEffort?: CodexReasoningEffort;
|
|
4611
|
-
/**
|
|
4612
|
-
* Filesystem reach. Default 'workspace-write' — the agent writes its
|
|
4613
|
-
* deliverable into cwd and nothing else. 'danger-full-access' hands a
|
|
4614
|
-
* shell-capable agent the whole box; don't use it on a client VM.
|
|
4615
|
-
*/
|
|
4616
|
-
sandboxMode?: CodexSandboxMode;
|
|
4617
|
-
/** Network for commands the agent runs. Off by default; MCP tools don't need it. */
|
|
4618
|
-
networkAccessEnabled?: boolean;
|
|
4619
|
-
apiKey?: string;
|
|
4620
|
-
baseUrl?: string;
|
|
4621
|
-
/** Raw `--config` overrides merged into the codex config. */
|
|
4622
|
-
extraConfig?: Record<string, unknown>;
|
|
4623
|
-
approvalPolicy?: 'never' | 'on-request' | 'on-failure' | 'untrusted';
|
|
4624
|
-
}
|
|
4625
|
-
declare function createCodexSession(opts: CodexSessionOptions): CodingAgentSession;
|
|
4626
|
-
|
|
4627
|
-
/**
|
|
4628
|
-
* What makes an agent fire.
|
|
4629
|
-
*
|
|
4630
|
-
* Declared ON the definition, deliberately. If triggers lived at the call sites
|
|
4631
|
-
* instead — a counter in the conversation handler, a hook in the kb-nodes
|
|
4632
|
-
* collection — then adding an agent would mean editing unrelated files across
|
|
4633
|
-
* the backend, and no one file would tell you when an agent actually runs.
|
|
4634
|
-
* Here, an agent's folder plus its definition is the whole story.
|
|
4635
|
-
*
|
|
4636
|
-
* The deployment's only job is to announce that something happened:
|
|
4637
|
-
*
|
|
4638
|
-
* emitAgentEvent('conversation.answered', { threadId })
|
|
4639
|
-
* emitAgentEvent('kb-node.changed', { id, op: 'update' })
|
|
4640
|
-
*
|
|
4641
|
-
* Which agents care, and how many events it takes, is the agents' business.
|
|
4642
|
-
*/
|
|
4643
|
-
type AgentTrigger =
|
|
4644
|
-
/** Only runCodingAgent(). The default. */
|
|
4645
|
-
{
|
|
4646
|
-
type: 'manual';
|
|
4647
|
-
}
|
|
4648
|
-
/** Every N milliseconds while the process is up. */
|
|
4649
|
-
| {
|
|
4650
|
-
type: 'interval';
|
|
4651
|
-
everyMs: number;
|
|
4652
|
-
}
|
|
4653
|
-
/**
|
|
4654
|
-
* On a named event. `debounceMs` collapses a burst into one run — editing
|
|
4655
|
-
* five knowledge nodes in a row is one reason to rebuild, not five.
|
|
4656
|
-
*/
|
|
4657
|
-
| {
|
|
4658
|
-
type: 'event';
|
|
4659
|
-
on: string | string[];
|
|
4660
|
-
debounceMs?: number;
|
|
4661
|
-
}
|
|
4662
|
-
/**
|
|
4663
|
-
* Every Nth occurrence of an event. The count is PERSISTED, so "after 10
|
|
4664
|
-
* questions" survives a restart instead of silently starting over.
|
|
4665
|
-
*/
|
|
4666
|
-
| {
|
|
4667
|
-
type: 'count';
|
|
4668
|
-
on: string;
|
|
4669
|
-
every: number;
|
|
4670
|
-
};
|
|
4671
|
-
interface TriggerFireInfo {
|
|
4672
|
-
agentId: string;
|
|
4673
|
-
/** What set it off, for the log line. */
|
|
4674
|
-
reason: string;
|
|
4675
|
-
payload?: unknown;
|
|
4676
|
-
}
|
|
4677
|
-
/** Notified after every triggered run — for recording history or alerting. */
|
|
4678
|
-
type RunListener = (record: AgentRunRecord, info: TriggerFireInfo) => void;
|
|
4679
|
-
declare function onAgentRun(fn: RunListener): () => void;
|
|
4680
|
-
/**
|
|
4681
|
-
* Tell the agents something happened. Safe to call from anywhere, including a
|
|
4682
|
-
* request path — it never throws and never blocks: matching runs are started,
|
|
4683
|
-
* not awaited.
|
|
4684
|
-
*/
|
|
4685
|
-
declare function emitAgentEvent(event: string, payload?: unknown): void;
|
|
4686
|
-
/**
|
|
4687
|
-
* Start interval triggers. Call once at startup, after registerCodingAgents.
|
|
4688
|
-
* Event and count triggers need nothing started — they wake on emitAgentEvent.
|
|
4689
|
-
*/
|
|
4690
|
-
declare function startAgentTriggers(): void;
|
|
4691
|
-
declare function stopAgentTriggers(): void;
|
|
4692
|
-
/** What fires each agent — for a startup log or an admin screen. */
|
|
4693
|
-
declare function describeTriggers(): Array<{
|
|
4694
|
-
agentId: string;
|
|
4695
|
-
triggers: string[];
|
|
4696
|
-
}>;
|
|
4697
|
-
|
|
4698
|
-
/**
|
|
4699
|
-
* What a coding agent IS.
|
|
4700
|
-
*
|
|
4701
|
-
* An agent is a job description, not code that does the job: instructions, the
|
|
4702
|
-
* inputs it should be handed, the tools it may reach, the deliverable it must
|
|
4703
|
-
* produce, and what we do with that deliverable. The agent itself decides HOW —
|
|
4704
|
-
* it can read the inputs, write and run scripts over them, check its own work,
|
|
4705
|
-
* and iterate. That is the whole reason for using a coding agent rather than a
|
|
4706
|
-
* single LLM call: the job's data never has to fit in a context window.
|
|
4707
|
-
*
|
|
4708
|
-
* Adding an agent is a folder with a system.md, one file implementing this
|
|
4709
|
-
* interface, and one line in the registry. Nothing else changes.
|
|
4710
|
-
*/
|
|
4711
|
-
/** The disposable directory one run happens in. */
|
|
4712
|
-
interface Workspace {
|
|
4713
|
-
/** Absolute path the agent runs in. Everything below is relative to it. */
|
|
4714
|
-
dir: string;
|
|
4715
|
-
/** Unique per run — also the folder name, so runs never collide. */
|
|
4716
|
-
runId: string;
|
|
4717
|
-
/** Write a file into the workspace, creating parent directories. */
|
|
4718
|
-
write(relPath: string, contents: string): Promise<void>;
|
|
4719
|
-
/** Write JSON (pretty-printed — the agent reads these by eye as often as by script). */
|
|
4720
|
-
writeJson(relPath: string, value: unknown): Promise<void>;
|
|
4721
|
-
/** Write one JSON object per line. The right shape for anything the agent will stream or grep. */
|
|
4722
|
-
writeJsonl(relPath: string, rows: unknown[]): Promise<void>;
|
|
4723
|
-
/** Read a file the agent produced. Returns null when it isn't there. */
|
|
4724
|
-
read(relPath: string): Promise<string | null>;
|
|
4725
|
-
/** Absolute path for a workspace-relative path — for telling the agent where to write. */
|
|
4726
|
-
pathTo(relPath: string): string;
|
|
4727
|
-
}
|
|
4728
|
-
/** Minimal validator shape, so this file needn't depend on a schema library. */
|
|
4729
|
-
interface OutputValidator<T> {
|
|
4730
|
-
/** Throw with a useful message, or return the parsed value. Zod's `.parse` satisfies this. */
|
|
4731
|
-
parse(value: unknown): T;
|
|
4732
|
-
}
|
|
4733
|
-
interface OutputContract<T> {
|
|
4734
|
-
/**
|
|
4735
|
-
* Workspace-relative path the agent must write, e.g. 'out/concepts.json'.
|
|
4736
|
-
* Nothing else counts as the deliverable: the run ends the moment this
|
|
4737
|
-
* appears, and a run that finishes without it is a failure, not a partial
|
|
4738
|
-
* success.
|
|
4739
|
-
*/
|
|
4740
|
-
file: string;
|
|
4741
|
-
/** Validated before anything is persisted, so a malformed run fails loudly and applies nothing. */
|
|
4742
|
-
schema: OutputValidator<T>;
|
|
4743
|
-
}
|
|
4744
|
-
/** What apply() reports back — surfaced in the run record and to the caller. */
|
|
4745
|
-
interface ApplySummary {
|
|
4746
|
-
/** One line a human can read in a log or the UI. */
|
|
4747
|
-
summary: string;
|
|
4748
|
-
/** Whatever counts for this agent: {created, updated, skipped}, etc. */
|
|
4749
|
-
counts?: Record<string, number>;
|
|
4750
|
-
/** Anything the caller may want to inspect or show. */
|
|
4751
|
-
details?: unknown;
|
|
4752
|
-
}
|
|
4753
|
-
interface AgentRunContext {
|
|
4754
|
-
projectId?: string;
|
|
4755
|
-
userId?: string;
|
|
4756
|
-
/**
|
|
4757
|
-
* This run's id — also the workspace directory name. Passed so apply() can
|
|
4758
|
-
* stamp whatever it persists with the run that produced it, which is the
|
|
4759
|
-
* only link from a stored result back to the inputs and scripts behind it.
|
|
4760
|
-
*/
|
|
4761
|
-
runId?: string;
|
|
4762
|
-
/** The run's workspace, for an apply() that needs a file the agent left. */
|
|
4763
|
-
workspaceDir?: string;
|
|
4764
|
-
/** Cancels the run; forwarded to the driver's real abort. */
|
|
4765
|
-
signal?: AbortSignal;
|
|
4766
|
-
/** Live progress. Populated for chat mode; a task run may also stream to a log. */
|
|
4767
|
-
onOutput?: (chunk: string) => void;
|
|
4768
|
-
onEvent?: (event: AgentEvent) => void;
|
|
4769
|
-
onUsage?: (usage: AgentUsage) => void;
|
|
4770
|
-
}
|
|
4771
|
-
/**
|
|
4772
|
-
* How much an agent carries between runs.
|
|
4773
|
-
*
|
|
4774
|
-
* Codex manages its own context: it tracks the window and compacts when it
|
|
4775
|
-
* crosses `auto_compact_token_limit`, emitting a ContextCompacted event. That
|
|
4776
|
-
* happens with no involvement from us, so a persistent session survives
|
|
4777
|
-
* indefinitely on its own. (The mechanism is in the engine but not the
|
|
4778
|
-
* TypeScript SDK — Thread exposes only id/run/runStreamed — which is why there
|
|
4779
|
-
* is nothing here to call.)
|
|
4780
|
-
*
|
|
4781
|
-
* What compaction cannot do is make the session authoritative. It summarises to
|
|
4782
|
-
* make room, so detail is lost by design; and ~/.codex/sessions is a directory
|
|
4783
|
-
* on one machine, not the database. So durable facts belong in `memory/` files
|
|
4784
|
-
* and in the tables the agent writes through apply(), with the session free to
|
|
4785
|
-
* compact itself as it likes. Memory on disk, context managed by codex.
|
|
4786
|
-
*/
|
|
4787
|
-
interface SessionPolicy {
|
|
4788
|
-
/**
|
|
4789
|
-
* 'per-run' a fresh harness session each time (default).
|
|
4790
|
-
* 'persistent' resume the same session across runs, so the agent keeps its
|
|
4791
|
-
* working context. Always paired with durable files — never rely
|
|
4792
|
-
* on it alone.
|
|
4793
|
-
*/
|
|
4794
|
-
scope?: 'per-run' | 'persistent';
|
|
4795
|
-
/**
|
|
4796
|
-
* 'per-run' a throwaway directory per run (default); pruned by keepRuns.
|
|
4797
|
-
* 'persistent' one directory the agent owns across runs. `memory/` survives
|
|
4798
|
-
* untouched; `input/` is cleared each run so a stale input can
|
|
4799
|
-
* never be mistaken for this run's.
|
|
4800
|
-
*/
|
|
4801
|
-
workspace?: 'per-run' | 'persistent';
|
|
4802
|
-
/**
|
|
4803
|
-
* Safety valve, not the compaction mechanism — codex already compacts on its
|
|
4804
|
-
* own. Starts a fresh session after this many runs while keeping the
|
|
4805
|
-
* workspace, for when you want a hard ceiling on how much summarised history
|
|
4806
|
-
* an agent drags along, or a clean slate on a cadence. Omit by default.
|
|
4807
|
-
*/
|
|
4808
|
-
resetAfterTurns?: number;
|
|
4809
|
-
}
|
|
4810
|
-
interface CodingAgentDefinition<TInput = unknown, TOutput = unknown> {
|
|
4811
|
-
/** Stable id: the folder name under .prompts/coding-agents, and the key callers use. */
|
|
4812
|
-
id: string;
|
|
4813
|
-
/** Human-readable, for the UI and logs. */
|
|
4814
|
-
title: string;
|
|
4815
|
-
/** One line: what this agent is for. */
|
|
4816
|
-
description?: string;
|
|
4817
|
-
/**
|
|
4818
|
-
* 'task' — headless. Runs from a cron, an event, or a command; produces the
|
|
4819
|
-
* deliverable and applies it. Nobody is watching.
|
|
4820
|
-
* 'chat' — a person is typing. Streams, keeps its session across turns, and
|
|
4821
|
-
* is not required to produce a deliverable at all.
|
|
4822
|
-
*/
|
|
4823
|
-
mode: 'task' | 'chat';
|
|
4824
|
-
/**
|
|
4825
|
-
* Directory holding this agent's system.md. Defaults to
|
|
4826
|
-
* `<promptRoot>/<id>`. The runner copies system.md into the workspace as
|
|
4827
|
-
* AGENTS.md, which is the filename the harness actually reads from its
|
|
4828
|
-
* working directory — that indirection is what lets the instructions stay
|
|
4829
|
-
* version-controlled while the workspace stays disposable.
|
|
4830
|
-
*/
|
|
4831
|
-
promptDir?: string;
|
|
4832
|
-
/** Override the deployment default for this agent alone. */
|
|
4833
|
-
harness?: Harness;
|
|
4834
|
-
model?: string;
|
|
4835
|
-
/**
|
|
4836
|
-
* Let this agent's shell reach the network. Off by default.
|
|
4837
|
-
*
|
|
4838
|
-
* Needed by any agent given bridge shims (writeBridgeShims), which reach the
|
|
4839
|
-
* backend over localhost HTTP. Note the sandbox has no host allowlist, so
|
|
4840
|
-
* this grants the whole internet, not just the bridge — scope it to agents
|
|
4841
|
-
* that genuinely need it.
|
|
4842
|
-
*/
|
|
4843
|
-
networkAccessEnabled?: boolean;
|
|
4844
|
-
/**
|
|
4845
|
-
* Filesystem reach. Defaults to the driver's 'workspace-write'.
|
|
4846
|
-
* 'danger-full-access' removes the sandbox entirely — it is the only mode in
|
|
4847
|
-
* which codex permits MCP tool calls headlessly, which is exactly why the
|
|
4848
|
-
* shims exist instead.
|
|
4849
|
-
*/
|
|
4850
|
-
sandboxMode?: 'read-only' | 'workspace-write' | 'danger-full-access';
|
|
4851
|
-
/**
|
|
4852
|
-
* Tools this agent may reach, as MCP servers. Deliberately per-agent: an
|
|
4853
|
-
* agent that reads the knowledge base has no business holding a database
|
|
4854
|
-
* connection. Omit for an agent that only needs the files it is given.
|
|
4855
|
-
*/
|
|
4856
|
-
tools?: Record<string, McpServerSpec>;
|
|
4857
|
-
/**
|
|
4858
|
-
* Put the job's inputs in the workspace as FILES, not prompt text. A coding
|
|
4859
|
-
* agent can grep, aggregate and script over a file; it cannot do any of that
|
|
4860
|
-
* with text pasted into its prompt, and a large input would not fit there
|
|
4861
|
-
* anyway.
|
|
4862
|
-
*/
|
|
4863
|
-
prepare?(ws: Workspace, input: TInput, ctx: AgentRunContext): Promise<void>;
|
|
4864
|
-
/**
|
|
4865
|
-
* The short framing sent as the turn's prompt. Keep it short — the standing
|
|
4866
|
-
* instructions belong in system.md and the data belongs in files. Defaults
|
|
4867
|
-
* to a generic instruction naming the output path.
|
|
4868
|
-
*/
|
|
4869
|
-
buildPrompt?(ws: Workspace, input: TInput, ctx: AgentRunContext): string | Promise<string>;
|
|
4870
|
-
/** Required for 'task' mode; meaningless for 'chat'. */
|
|
4871
|
-
output?: OutputContract<TOutput>;
|
|
4872
|
-
/**
|
|
4873
|
-
* Persist the validated deliverable — through existing services, never raw
|
|
4874
|
-
* SQL from inside the agent. Keeping the write on this side is what makes a
|
|
4875
|
-
* run auditable and replayable: the artifact on disk is the same input
|
|
4876
|
-
* apply() would get again tomorrow.
|
|
4877
|
-
*/
|
|
4878
|
-
apply?(result: TOutput, input: TInput, ctx: AgentRunContext): Promise<ApplySummary>;
|
|
4879
|
-
/**
|
|
4880
|
-
* What makes this agent run. Declared here so an agent's folder plus this
|
|
4881
|
-
* file is the complete story of when it fires. See triggers.ts.
|
|
4882
|
-
*/
|
|
4883
|
-
trigger?: AgentTrigger | AgentTrigger[];
|
|
4884
|
-
/**
|
|
4885
|
-
* WHO this agent's accumulated state belongs to. Distinct from `mode`, which
|
|
4886
|
-
* is only how a run was triggered — the two were conflated before, so a
|
|
4887
|
-
* project agent someone chatted with silently got a private per-thread
|
|
4888
|
-
* workspace and lost its memory.
|
|
4889
|
-
*
|
|
4890
|
-
* 'project' ONE workspace and session for the whole deployment, whoever
|
|
4891
|
-
* invokes it. A concept builder is project-wide: everything it
|
|
4892
|
-
* learns should accumulate in one place, and a chat turn joins
|
|
4893
|
-
* that same workspace rather than forking a copy. Concurrent
|
|
4894
|
-
* runs serialise.
|
|
4895
|
-
* 'user' one per user, shared across that user's threads.
|
|
4896
|
-
* 'thread' one per conversation — an ordinary chat assistant.
|
|
4897
|
-
*
|
|
4898
|
-
* Default: 'thread' for mode 'chat', 'project' for mode 'task'.
|
|
4899
|
-
*/
|
|
4900
|
-
scope?: 'project' | 'user' | 'thread';
|
|
4901
|
-
/**
|
|
4902
|
-
* Kill the turn the moment the deliverable file appears, instead of letting
|
|
4903
|
-
* the agent finish.
|
|
4904
|
-
*
|
|
4905
|
-
* Off by default, and the reason is measured: an agent typically writes its
|
|
4906
|
-
* output and then keeps going — verifying, re-reading, summarising — so
|
|
4907
|
-
* stopping at the write cuts the turn well before codex emits
|
|
4908
|
-
* turn.completed, which is the only event carrying token usage. Early stop
|
|
4909
|
-
* therefore costs you all cost tracking, and skips the agent's own
|
|
4910
|
-
* self-check. Turn it on for a long-tailed agent where the file really is
|
|
4911
|
-
* the last thing that matters.
|
|
4912
|
-
*/
|
|
4913
|
-
stopOnDeliverable?: boolean;
|
|
4914
|
-
/** What this agent carries between runs. Default: nothing (fresh session and workspace). */
|
|
4915
|
-
session?: SessionPolicy;
|
|
4916
|
-
/** Hard cap for one run. Default 15 minutes. */
|
|
4917
|
-
timeoutMs?: number;
|
|
4918
|
-
}
|
|
4919
|
-
/** What a completed run reports. */
|
|
4920
|
-
interface AgentRunRecord<TOutput = unknown> {
|
|
4921
|
-
agentId: string;
|
|
4922
|
-
runId: string;
|
|
4923
|
-
/** The run's directory — instructions, inputs, scripts and output all still there. */
|
|
4924
|
-
workspaceDir: string;
|
|
4925
|
-
/**
|
|
4926
|
-
* 'early' the deliverable landed and we stopped the turn — a success, kept
|
|
4927
|
-
* distinct from 'completed' so a masked early exit is visible.
|
|
4928
|
-
* 'skipped' another run of this agent held the lock; nothing was done.
|
|
4929
|
-
*/
|
|
4930
|
-
status: 'completed' | 'early' | 'aborted' | 'error' | 'skipped';
|
|
4931
|
-
/** The agent's closing message. */
|
|
4932
|
-
answer: string;
|
|
4933
|
-
ms: number;
|
|
4934
|
-
usage: AgentUsage;
|
|
4935
|
-
/** Present when the agent produced and validated its deliverable. */
|
|
4936
|
-
output?: TOutput;
|
|
4937
|
-
/** Present when apply() ran. */
|
|
4938
|
-
applied?: ApplySummary;
|
|
4939
|
-
error?: string;
|
|
4940
|
-
/** Harness session id, for resuming a chat. */
|
|
4941
|
-
sessionId?: string;
|
|
4942
|
-
}
|
|
4943
|
-
|
|
4944
|
-
/**
|
|
4945
|
-
* The agent registry — one place that knows which agents this deployment has.
|
|
4946
|
-
*
|
|
4947
|
-
* Deliberately a plain module-level map rather than something on the SDK: a
|
|
4948
|
-
* cron job, a CLI command and the websocket handler all need to reach the same
|
|
4949
|
-
* agents, and only one of those has an SDK instance in hand.
|
|
4950
|
-
*/
|
|
4951
|
-
interface CodingAgentsConfig {
|
|
4952
|
-
/**
|
|
4953
|
-
* Where per-agent instruction folders live. Each agent reads
|
|
4954
|
-
* `<promptRoot>/<agent.id>/system.md`.
|
|
4955
|
-
* Default: `<cwd>/.prompts/coding-agents`, matching the .prompts convention
|
|
4956
|
-
* the rest of the deployment already uses.
|
|
4957
|
-
*/
|
|
4958
|
-
promptRoot?: string;
|
|
4959
|
-
/**
|
|
4960
|
-
* Root for run workspaces: `<runtimeDir>/<agentId>/<runId>/`. Regenerated
|
|
4961
|
-
* per run and safe to gitignore — deliberately not inside promptRoot, which
|
|
4962
|
-
* is version-controlled.
|
|
4963
|
-
* Default: `<cwd>/.coding-agent-runtime`.
|
|
4964
|
-
*/
|
|
4965
|
-
runtimeDir?: string;
|
|
4966
|
-
/** Fallback harness for agents that don't name one. */
|
|
4967
|
-
harness?: Harness;
|
|
4968
|
-
/** Fallback model. */
|
|
4969
|
-
model?: string;
|
|
4970
|
-
/** Tools every agent gets, merged under each agent's own (the agent's win on a name clash). */
|
|
4971
|
-
sharedTools?: Record<string, McpServerSpec>;
|
|
4972
|
-
/** Keep this many run directories per agent; older ones are pruned. 0 keeps everything. */
|
|
4973
|
-
keepRuns?: number;
|
|
4974
|
-
}
|
|
4975
|
-
/**
|
|
4976
|
-
* Register this deployment's agents. Call once at startup.
|
|
4977
|
-
*
|
|
4978
|
-
* Re-registering an id replaces it — that keeps hot-reload working in dev and
|
|
4979
|
-
* makes a double registration a no-op rather than a silent duplicate.
|
|
4980
|
-
*/
|
|
4981
|
-
declare function registerCodingAgents(definitions: CodingAgentDefinition<any, any>[], options?: CodingAgentsConfig): void;
|
|
4982
|
-
declare function getCodingAgent(id: string): CodingAgentDefinition<any, any> | undefined;
|
|
4983
|
-
declare function listCodingAgents(): Array<{
|
|
4984
|
-
id: string;
|
|
4985
|
-
title: string;
|
|
4986
|
-
description?: string;
|
|
4987
|
-
mode: 'task' | 'chat';
|
|
4988
|
-
}>;
|
|
4989
|
-
declare function getCodingAgentsConfig(): Required<Pick<CodingAgentsConfig, "harness" | "promptRoot" | "runtimeDir" | "keepRuns">> & CodingAgentsConfig;
|
|
4990
|
-
|
|
4991
|
-
interface RunAgentOptions<TInput> extends AgentRunContext {
|
|
4992
|
-
input?: TInput;
|
|
4993
|
-
/** Scopes a 'thread' agent. Ignored by a project-scoped one. */
|
|
4994
|
-
threadId?: string;
|
|
4995
|
-
/**
|
|
4996
|
-
* Escape hatch that pins the workspace directory outright. Almost never
|
|
4997
|
-
* right — it defeats the agent's own scope, which is how a project agent
|
|
4998
|
-
* ends up with a private copy per caller. Left for tests and one-offs.
|
|
4999
|
-
*/
|
|
5000
|
-
workspaceDir?: string;
|
|
5001
|
-
/** Resume the harness session — chat continuity across turns and restarts. */
|
|
5002
|
-
resumeId?: string;
|
|
5003
|
-
/** Overrides the definition's prompt entirely. Chat mode: this is the user's message. */
|
|
5004
|
-
prompt?: string;
|
|
5005
|
-
}
|
|
5006
|
-
/**
|
|
5007
|
-
* Run one agent, end to end.
|
|
5008
|
-
*
|
|
5009
|
-
* Never throws for an agent-side failure — a bad run comes back as a record
|
|
5010
|
-
* with status 'error', because callers are usually crons and message handlers
|
|
5011
|
-
* that must keep going. Genuinely programmer errors (unknown agent id) do throw.
|
|
5012
|
-
*/
|
|
5013
|
-
declare function runCodingAgent<TInput = unknown, TOutput = unknown>(agentId: string, options?: RunAgentOptions<TInput>): Promise<AgentRunRecord<TOutput>>;
|
|
5014
|
-
|
|
5015
|
-
/**
|
|
5016
|
-
* Write `./sources` and `./query` into an agent's workspace: read-only data
|
|
5017
|
-
* access as plain executables it runs with bash.
|
|
5018
|
-
*
|
|
5019
|
-
* Why not MCP: codex gates MCP tool calls on the sandbox. Under any sandboxed
|
|
5020
|
-
* mode they need approval, and a headless run must set approvalPolicy 'never',
|
|
5021
|
-
* which denies rather than grants — measured, not assumed. Only
|
|
5022
|
-
* danger-full-access permits them, and that removes the filesystem sandbox
|
|
5023
|
-
* entirely. Bash commands under workspace-write need no approval, so a shim
|
|
5024
|
-
* buys the same capability while the agent stays confined to its workspace.
|
|
5025
|
-
*
|
|
5026
|
-
* An MCP server for this was written and then removed: the same approval gate
|
|
5027
|
-
* applies to the Agents chat tab, which is equally headless from codex's point
|
|
5028
|
-
* of view, so it was unreachable everywhere. `mcpServers` stays plumbed through
|
|
5029
|
-
* the driver for third-party servers; see git history for the removed one.
|
|
5030
|
-
*
|
|
5031
|
-
* The cost is structured tool events: calls arrive as `bash → ./query ...`
|
|
5032
|
-
* rather than typed items with parsed arguments. That matters for a chat UI
|
|
5033
|
-
* with a human watching; for a headless task agent it does not.
|
|
5034
|
-
*
|
|
5035
|
-
* Requires networkAccessEnabled on the session — the shim reaches the bridge
|
|
5036
|
-
* over HTTP, and that is the whole point of it.
|
|
5037
|
-
*/
|
|
5038
|
-
declare function writeBridgeShims(ws: Workspace, opts: {
|
|
5039
|
-
bridgeUrl: string;
|
|
5040
|
-
sources: Array<{
|
|
5041
|
-
id: string;
|
|
5042
|
-
name?: string;
|
|
5043
|
-
description?: string;
|
|
5044
|
-
}>;
|
|
5045
|
-
maxRows?: number;
|
|
5046
|
-
}): void;
|
|
5047
|
-
|
|
5048
|
-
/**
|
|
5049
|
-
* Read-only SQL guard for any path that hands an agent a database.
|
|
5050
|
-
*
|
|
5051
|
-
* Defence in depth, NOT a boundary. The agent has a shell and can reach the
|
|
5052
|
-
* bridge directly, so anything enforced only here is advisory — it stops
|
|
5053
|
-
* mistakes, not determination. The real boundary is a database user without
|
|
5054
|
-
* write permission; this exists so a confused agent gets a clear correction
|
|
5055
|
-
* instead of a silent partial write.
|
|
5056
|
-
*/
|
|
5057
|
-
/** Throws with a message written for the agent to act on. */
|
|
5058
|
-
declare function assertReadOnlySql(sql: string): void;
|
|
5059
|
-
|
|
5060
|
-
/**
|
|
5061
|
-
* The 'coding-agent'.'run' collection — a chat turn against a coding agent.
|
|
5062
|
-
*
|
|
5063
|
-
* Generic on purpose: nothing here knows about dashboards, reports, or any
|
|
5064
|
-
* particular deliverable. It owns what every harness-backed chat needs — one
|
|
5065
|
-
* session per thread, a per-thread workspace, a run lock, and forwarding the
|
|
5066
|
-
* driver's callbacks to the transport. Task-specific flows (prompt assembly, a
|
|
5067
|
-
* draft-file contract, persistence) build on top of this rather than inside it.
|
|
5068
|
-
*/
|
|
5069
|
-
interface CodingAgentCollectionConfig {
|
|
5070
|
-
/**
|
|
5071
|
-
* Root for per-thread agent workspaces. Each thread gets its own directory
|
|
5072
|
-
* underneath, so one chat can't read or clobber another's files, and none of
|
|
5073
|
-
* them sit inside the backend's own source tree.
|
|
5074
|
-
* Default: `<process.cwd()>/.coding-agent-runtime`.
|
|
5075
|
-
*/
|
|
5076
|
-
runtimeDir?: string;
|
|
5077
|
-
/** Default harness when the request doesn't name one. */
|
|
5078
|
-
harness?: Harness;
|
|
5079
|
-
model?: string;
|
|
5080
|
-
/** Tools, as MCP servers, handed to every session. */
|
|
5081
|
-
mcpServers?: Record<string, McpServerSpec>;
|
|
5082
|
-
}
|
|
5083
|
-
declare function registerCodingAgentCollection(sdk: SuperatomSDK, config?: CodingAgentCollectionConfig): void;
|
|
5084
|
-
|
|
5085
|
-
/**
|
|
5086
|
-
* ScriptMatcher — LLM-Based Script Matching + Parameter Extraction
|
|
5087
|
-
*
|
|
5088
|
-
* Uses ONE LLM call to:
|
|
5089
|
-
* 1. Pick the best matching script from the library (or "none")
|
|
5090
|
-
* 2. Extract parameter values from the user question
|
|
5091
|
-
*
|
|
5092
|
-
* Why LLM over embeddings:
|
|
5093
|
-
* - Embeddings capture topic similarity ("overstock" ≈ "inventory" ≈ "revenue")
|
|
5094
|
-
* but can't distinguish structurally different questions about the same domain
|
|
5095
|
-
* - LLM understands that "overstock by warehouse" needs a different script than
|
|
5096
|
-
* "revenue by warehouse" even though they're semantically close
|
|
5097
|
-
* - One call does both matching AND parameter extraction
|
|
5098
|
-
*
|
|
5099
|
-
* When script library grows past ~50, add an embedding pre-filter
|
|
5100
|
-
* (ChromaDB narrows to top 10 → LLM picks from those 10).
|
|
5101
|
-
*/
|
|
5102
|
-
|
|
5103
|
-
declare class ScriptMatcher {
|
|
5104
|
-
private store;
|
|
5105
|
-
private collections?;
|
|
5106
|
-
private userId?;
|
|
5107
|
-
private trace?;
|
|
5108
|
-
constructor(store: ScriptStore, opts?: {
|
|
5109
|
-
collections?: any;
|
|
5110
|
-
userId?: string;
|
|
5111
|
-
trace?: RunTrace;
|
|
5112
|
-
});
|
|
5113
|
-
/**
|
|
5114
|
-
* Find the best matching script for a user question.
|
|
5115
|
-
* Uses ONE LLM call that picks the script AND extracts parameters.
|
|
5116
|
-
* Returns null if no script matches.
|
|
5117
|
-
*
|
|
5118
|
-
* Thin wrapper around `doMatch` whose only job is guaranteeing the trace
|
|
5119
|
-
* capture happens exactly once, on every exit path (short-circuit, normal
|
|
5120
|
-
* return, or the LLM call erroring) — see RunTrace.scriptMatcher.
|
|
5121
|
-
*/
|
|
5122
|
-
match(userPrompt: string, apiKey?: string, model?: string, signal?: AbortSignal, activeBindings?: ScriptBinding[]): Promise<ScriptMatch | null>;
|
|
5123
|
-
private doMatch;
|
|
5124
|
-
/**
|
|
5125
|
-
* Renders a recipe's declared parameters the same way in every prompt
|
|
5126
|
-
* section (catalog, active-script, edit candidates) so the LLM sees one
|
|
5127
|
-
* consistent format regardless of which block a script came from.
|
|
5128
|
-
*/
|
|
5129
|
-
private formatParamList;
|
|
5130
|
-
/**
|
|
5131
|
-
* Semantic search over THIS user's own past prompts (`conversation-history`
|
|
5132
|
-
* ChromaDB embeddings, already user-scoped) — not a project-wide name/tag
|
|
5133
|
-
* search. Groups hits by the recipe that answered them, so a script gets
|
|
5134
|
-
* ONE catalog entry carrying every matched past question, not one per hit.
|
|
5135
|
-
*
|
|
5136
|
-
* Scope is deliberate (see SCRIPT-MATCH-IMPROVEMENTS.md, Change 2): a
|
|
5137
|
-
* script only shows up here because THIS user has, before, asked something
|
|
5138
|
-
* similar that it answered — not because some other user's question did.
|
|
5139
|
-
*/
|
|
5140
|
-
private searchPromptHistory;
|
|
5141
|
-
/**
|
|
5142
|
-
* Build the script catalog string for the LLM prompt from prompt-history
|
|
5143
|
-
* matches: each script's declared parameters PLUS the actual past questions
|
|
5144
|
-
* of this user's that it answered (real precedent, not a hand-written
|
|
5145
|
-
* description) and what params they ran with.
|
|
5146
|
-
*/
|
|
5147
|
-
private buildPromptHistoryCatalog;
|
|
5148
|
-
/**
|
|
5149
|
-
* The recent script-backed answers in this thread — the bounded set an edit
|
|
5150
|
-
* may target. Rendered as its own prompt section (never merged into the
|
|
5151
|
-
* ranked catalog) so the `edit` rules have an unambiguous referent set, and
|
|
5152
|
-
* numbered newest-first so the prompt's "prefer the most recent when the
|
|
5153
|
-
* instruction is ambiguous" tie-break has something to point at.
|
|
5154
|
-
*
|
|
5155
|
-
* Each entry carries the QUESTION that produced it plus the columns it
|
|
5156
|
-
* returned — that is what lets the matcher resolve "use the mode for the WSP
|
|
5157
|
-
* one" instead of blindly taking the newest.
|
|
5158
|
-
*/
|
|
5159
|
-
private buildActiveScriptBlock;
|
|
5160
|
-
}
|
|
5161
|
-
|
|
5162
|
-
/**
|
|
5163
|
-
* ScriptRunner — Execute scripts in an isolated tsx subprocess.
|
|
5164
|
-
*
|
|
5165
|
-
* The subprocess approach replaces the earlier `new Function()` eval and gives us:
|
|
5166
|
-
* - Real sandbox (separate process, SIGKILL on timeout).
|
|
5167
|
-
* - Real TypeScript (tsx transpiles on the fly).
|
|
5168
|
-
* - npm imports available to scripts (clustering, stats, geo, etc.).
|
|
5169
|
-
*
|
|
5170
|
-
* Protocol: NDJSON over the child's stdin/stdout. See script-ipc.ts + backend/docs/SCRIPT-FLOW-IMPLEMENTATION.md.
|
|
5171
|
-
*/
|
|
5172
|
-
|
|
5173
|
-
interface RunScriptOptions {
|
|
5174
|
-
/** Data sources the script is allowed to query via ctx.query */
|
|
5175
|
-
externalTools: ExternalTool[];
|
|
5176
|
-
/** Optional — for propagating per-query UI progress to the user */
|
|
5177
|
-
streamBuffer?: StreamBuffer;
|
|
5178
|
-
/** Override the wall-clock timeout (default `SCRIPT_TIMEOUT_MS`, 60s). */
|
|
5179
|
-
timeoutMs?: number;
|
|
5180
|
-
/**
|
|
5181
|
-
* Per-turn cancellation signal. When the user hits "Stop" mid-run, the child
|
|
5182
|
-
* process group is SIGKILLed and the run resolves as an aborted failure (the
|
|
5183
|
-
* caller is already unwinding, so the result is discarded).
|
|
5184
|
-
*/
|
|
5185
|
-
signal?: AbortSignal;
|
|
5186
|
-
}
|
|
5187
|
-
/**
|
|
5188
|
-
* Execute a recipe by spawning a tsx child on the script's .ts file.
|
|
5189
|
-
* `scriptPath` is the absolute path to the saved `.ts` body.
|
|
5190
|
-
*/
|
|
5191
|
-
declare function runScript(recipe: ScriptRecipe, scriptPath: string, params: Record<string, any>, options: RunScriptOptions): Promise<ScriptResult>;
|
|
5192
|
-
|
|
5193
2958
|
type MessageTypeHandler = (message: IncomingMessage) => void | Promise<void>;
|
|
5194
2959
|
declare class SuperatomSDK {
|
|
5195
2960
|
private ws;
|
|
@@ -5207,6 +2972,7 @@ declare class SuperatomSDK {
|
|
|
5207
2972
|
private components;
|
|
5208
2973
|
private tools;
|
|
5209
2974
|
private workflows;
|
|
2975
|
+
private registryWaiters;
|
|
5210
2976
|
private anthropicApiKey;
|
|
5211
2977
|
private groqApiKey;
|
|
5212
2978
|
private geminiApiKey;
|
|
@@ -5225,8 +2991,6 @@ declare class SuperatomSDK {
|
|
|
5225
2991
|
private lastPong;
|
|
5226
2992
|
private readonly PING_INTERVAL_MS;
|
|
5227
2993
|
private readonly PONG_TIMEOUT_MS;
|
|
5228
|
-
private pendingOutbox;
|
|
5229
|
-
private readonly MAX_OUTBOX_SIZE;
|
|
5230
2994
|
constructor(config: SuperatomSDKConfig);
|
|
5231
2995
|
/**
|
|
5232
2996
|
* Initialize PromptLoader and load prompts into memory
|
|
@@ -5271,20 +3035,6 @@ declare class SuperatomSDK {
|
|
|
5271
3035
|
* Does NOT throw on closed connections — callers can check the return value if needed.
|
|
5272
3036
|
*/
|
|
5273
3037
|
send(message: Message): boolean;
|
|
5274
|
-
/**
|
|
5275
|
-
* Queue a message that couldn't be delivered because the socket was down,
|
|
5276
|
-
* to be resent once it reconnects. Drops the oldest entry once the bound is
|
|
5277
|
-
* hit — an outage long enough to fill this queue means the oldest queued
|
|
5278
|
-
* responses are for requests the caller has likely already given up on.
|
|
5279
|
-
*/
|
|
5280
|
-
private queuePendingMessage;
|
|
5281
|
-
/**
|
|
5282
|
-
* Resend everything queued while the socket was down, now that it's back
|
|
5283
|
-
* up. Uses this.ws.send() directly (not send()) so a message that fails
|
|
5284
|
-
* again goes back through queuePendingMessage() rather than being silently
|
|
5285
|
-
* dropped a second time.
|
|
5286
|
-
*/
|
|
5287
|
-
private flushPendingOutbox;
|
|
5288
3038
|
/**
|
|
5289
3039
|
* Register a message handler to receive all messages
|
|
5290
3040
|
*/
|
|
@@ -5324,14 +3074,6 @@ declare class SuperatomSDK {
|
|
|
5324
3074
|
*/
|
|
5325
3075
|
private handlePong;
|
|
5326
3076
|
private storeComponents;
|
|
5327
|
-
/**
|
|
5328
|
-
* The live, frontend-registered component catalog (name, type, description,
|
|
5329
|
-
* and full prop schema per component) — the same authoritative source
|
|
5330
|
-
* DASH_COMP_REQ's LLM prompt is built from. Exposed so other integrations
|
|
5331
|
-
* (e.g. the dashboard-agent script bridge) can read real component
|
|
5332
|
-
* contracts instead of maintaining a separate, driftable hand-written copy.
|
|
5333
|
-
*/
|
|
5334
|
-
getComponents(): Component[];
|
|
5335
3077
|
/**
|
|
5336
3078
|
* Set tools for the SDK instance
|
|
5337
3079
|
*/
|
|
@@ -5340,16 +3082,6 @@ declare class SuperatomSDK {
|
|
|
5340
3082
|
* Get the stored tools
|
|
5341
3083
|
*/
|
|
5342
3084
|
getTools(): Tool$1[];
|
|
5343
|
-
/**
|
|
5344
|
-
* Call a registered collection operation in-process — no WebSocket
|
|
5345
|
-
* round-trip, since the caller is already running inside this same SDK
|
|
5346
|
-
* instance. Lets SDK-internal features (e.g. the dashboard agent) reuse
|
|
5347
|
-
* whatever collection a deployment has already registered (e.g.
|
|
5348
|
-
* 'dashboards'.'query') by name/convention, instead of requiring a
|
|
5349
|
-
* separate callback purely to re-expose data a collection already serves.
|
|
5350
|
-
* Throws if the collection or operation isn't registered.
|
|
5351
|
-
*/
|
|
5352
|
-
callCollection<TResult = any>(collectionName: string, operation: string, params?: any): Promise<TResult>;
|
|
5353
3085
|
/**
|
|
5354
3086
|
* Register workflow components for the SDK instance.
|
|
5355
3087
|
*
|
|
@@ -5359,6 +3091,19 @@ declare class SuperatomSDK {
|
|
|
5359
3091
|
* the workflow component is returned directly, with the LLM-extracted props.
|
|
5360
3092
|
*/
|
|
5361
3093
|
setWorkflows(workflows: WorkflowDescriptor[]): void;
|
|
3094
|
+
/**
|
|
3095
|
+
* Make sure the agent has a tool surface before answering a prompt.
|
|
3096
|
+
*
|
|
3097
|
+
* Components and workflows are pushed by the browser once per page load and
|
|
3098
|
+
* kept only in memory, so a backend restart leaves both lists empty until
|
|
3099
|
+
* someone reloads a tab. The agent still answers — with no workflows to route
|
|
3100
|
+
* to and no components to render — which looks like a model regression rather
|
|
3101
|
+
* than lost state. Ask the client to re-send instead, and proceed regardless
|
|
3102
|
+
* so a stale or silent client degrades no worse than it does today.
|
|
3103
|
+
*/
|
|
3104
|
+
private ensureRegistry;
|
|
3105
|
+
/** Release anyone blocked in ensureRegistry() now that the list has arrived. */
|
|
3106
|
+
private resolveRegistryWaiters;
|
|
5362
3107
|
/**
|
|
5363
3108
|
* Get the registered workflow components.
|
|
5364
3109
|
*/
|
|
@@ -5393,4 +3138,4 @@ declare class SuperatomSDK {
|
|
|
5393
3138
|
getConversationSimilarityThreshold(): number;
|
|
5394
3139
|
}
|
|
5395
3140
|
|
|
5396
|
-
export { type Action, type AgentConfig, type
|
|
3141
|
+
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 };
|