@superatomai/sdk-node 0.0.17 → 0.0.18-dsp

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,6 +1,17 @@
1
1
  import { z } from 'zod';
2
2
  import Anthropic from '@anthropic-ai/sdk';
3
3
 
4
+ /**
5
+ * Unified UIBlock structure for database storage
6
+ * Used in both bookmarks and user-conversations tables
7
+ */
8
+ interface DBUIBlock {
9
+ id: string;
10
+ component: Record<string, any> | null;
11
+ analysis: string | null;
12
+ user_prompt: string;
13
+ }
14
+
4
15
  /**
5
16
  * Log levels in hierarchical order
6
17
  * - errors: only error logs
@@ -48,7 +59,18 @@ declare class Logger {
48
59
  * Log debug message (only shown for verbose level)
49
60
  */
50
61
  debug(...args: any[]): void;
62
+ /**
63
+ * Write to log file
64
+ */
51
65
  file(...args: any[]): void;
66
+ /**
67
+ * Clear the log file (call at start of new user request)
68
+ */
69
+ clearFile(): void;
70
+ /**
71
+ * Log LLM method prompts with clear labeling
72
+ */
73
+ logLLMPrompt(methodName: string, promptType: 'system' | 'user', content: string | object | any[]): void;
52
74
  }
53
75
  declare const logger: Logger;
54
76
 
@@ -79,7 +101,27 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
79
101
  deps?: string[] | undefined;
80
102
  }>, "many">>;
81
103
  data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
82
- render: z.ZodType<any, z.ZodTypeDef, any>;
104
+ render: z.ZodOptional<z.ZodType<any, z.ZodTypeDef, any>>;
105
+ pages: z.ZodOptional<z.ZodArray<z.ZodObject<{
106
+ id: z.ZodString;
107
+ name: z.ZodString;
108
+ order: z.ZodNumber;
109
+ icon: z.ZodOptional<z.ZodString>;
110
+ render: z.ZodType<any, z.ZodTypeDef, any>;
111
+ }, "strip", z.ZodTypeAny, {
112
+ id: string;
113
+ name: string;
114
+ order: number;
115
+ icon?: string | undefined;
116
+ render?: any;
117
+ }, {
118
+ id: string;
119
+ name: string;
120
+ order: number;
121
+ icon?: string | undefined;
122
+ render?: any;
123
+ }>, "many">>;
124
+ defaultPageId: z.ZodOptional<z.ZodString>;
83
125
  query: z.ZodOptional<z.ZodObject<{
84
126
  graphql: z.ZodOptional<z.ZodString>;
85
127
  sql: z.ZodOptional<z.ZodString>;
@@ -118,6 +160,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
118
160
  dependencies?: string[] | undefined;
119
161
  } | undefined;
120
162
  props?: Record<string, any> | undefined;
163
+ render?: any;
121
164
  states?: Record<string, any> | undefined;
122
165
  methods?: Record<string, {
123
166
  fn: string;
@@ -128,7 +171,14 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
128
171
  deps?: string[] | undefined;
129
172
  }[] | undefined;
130
173
  data?: Record<string, any> | undefined;
131
- render?: any;
174
+ pages?: {
175
+ id: string;
176
+ name: string;
177
+ order: number;
178
+ icon?: string | undefined;
179
+ render?: any;
180
+ }[] | undefined;
181
+ defaultPageId?: string | undefined;
132
182
  }, {
133
183
  id: string;
134
184
  name?: string | undefined;
@@ -142,6 +192,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
142
192
  dependencies?: string[] | undefined;
143
193
  } | undefined;
144
194
  props?: Record<string, any> | undefined;
195
+ render?: any;
145
196
  states?: Record<string, any> | undefined;
146
197
  methods?: Record<string, {
147
198
  fn: string;
@@ -152,7 +203,14 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
152
203
  deps?: string[] | undefined;
153
204
  }[] | undefined;
154
205
  data?: Record<string, any> | undefined;
155
- render?: any;
206
+ pages?: {
207
+ id: string;
208
+ name: string;
209
+ order: number;
210
+ icon?: string | undefined;
211
+ render?: any;
212
+ }[] | undefined;
213
+ defaultPageId?: string | undefined;
156
214
  }>;
157
215
  data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
158
216
  context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
@@ -170,6 +228,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
170
228
  dependencies?: string[] | undefined;
171
229
  } | undefined;
172
230
  props?: Record<string, any> | undefined;
231
+ render?: any;
173
232
  states?: Record<string, any> | undefined;
174
233
  methods?: Record<string, {
175
234
  fn: string;
@@ -180,7 +239,14 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
180
239
  deps?: string[] | undefined;
181
240
  }[] | undefined;
182
241
  data?: Record<string, any> | undefined;
183
- render?: any;
242
+ pages?: {
243
+ id: string;
244
+ name: string;
245
+ order: number;
246
+ icon?: string | undefined;
247
+ render?: any;
248
+ }[] | undefined;
249
+ defaultPageId?: string | undefined;
184
250
  };
185
251
  data?: Record<string, any> | undefined;
186
252
  context?: Record<string, any> | undefined;
@@ -198,6 +264,7 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
198
264
  dependencies?: string[] | undefined;
199
265
  } | undefined;
200
266
  props?: Record<string, any> | undefined;
267
+ render?: any;
201
268
  states?: Record<string, any> | undefined;
202
269
  methods?: Record<string, {
203
270
  fn: string;
@@ -208,7 +275,14 @@ declare const DSLRendererPropsSchema$1: z.ZodObject<{
208
275
  deps?: string[] | undefined;
209
276
  }[] | undefined;
210
277
  data?: Record<string, any> | undefined;
211
- render?: any;
278
+ pages?: {
279
+ id: string;
280
+ name: string;
281
+ order: number;
282
+ icon?: string | undefined;
283
+ render?: any;
284
+ }[] | undefined;
285
+ defaultPageId?: string | undefined;
212
286
  };
213
287
  data?: Record<string, any> | undefined;
214
288
  context?: Record<string, any> | undefined;
@@ -281,6 +355,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
281
355
  dependencies?: string[] | undefined;
282
356
  } | undefined;
283
357
  props?: Record<string, any> | undefined;
358
+ render?: any;
284
359
  states?: Record<string, any> | undefined;
285
360
  methods?: Record<string, {
286
361
  fn: string;
@@ -291,7 +366,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
291
366
  deps?: string[] | undefined;
292
367
  }[] | undefined;
293
368
  data?: Record<string, any> | undefined;
294
- render?: any;
295
369
  }, {
296
370
  id: string;
297
371
  name?: string | undefined;
@@ -305,6 +379,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
305
379
  dependencies?: string[] | undefined;
306
380
  } | undefined;
307
381
  props?: Record<string, any> | undefined;
382
+ render?: any;
308
383
  states?: Record<string, any> | undefined;
309
384
  methods?: Record<string, {
310
385
  fn: string;
@@ -315,7 +390,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
315
390
  deps?: string[] | undefined;
316
391
  }[] | undefined;
317
392
  data?: Record<string, any> | undefined;
318
- render?: any;
319
393
  }>;
320
394
  data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
321
395
  context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
@@ -333,6 +407,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
333
407
  dependencies?: string[] | undefined;
334
408
  } | undefined;
335
409
  props?: Record<string, any> | undefined;
410
+ render?: any;
336
411
  states?: Record<string, any> | undefined;
337
412
  methods?: Record<string, {
338
413
  fn: string;
@@ -343,7 +418,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
343
418
  deps?: string[] | undefined;
344
419
  }[] | undefined;
345
420
  data?: Record<string, any> | undefined;
346
- render?: any;
347
421
  };
348
422
  data?: Record<string, any> | undefined;
349
423
  context?: Record<string, any> | undefined;
@@ -361,6 +435,7 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
361
435
  dependencies?: string[] | undefined;
362
436
  } | undefined;
363
437
  props?: Record<string, any> | undefined;
438
+ render?: any;
364
439
  states?: Record<string, any> | undefined;
365
440
  methods?: Record<string, {
366
441
  fn: string;
@@ -371,7 +446,6 @@ declare const DSLRendererPropsSchema: z.ZodObject<{
371
446
  deps?: string[] | undefined;
372
447
  }[] | undefined;
373
448
  data?: Record<string, any> | undefined;
374
- render?: any;
375
449
  };
376
450
  data?: Record<string, any> | undefined;
377
451
  context?: Record<string, any> | undefined;
@@ -384,6 +458,7 @@ declare const UserSchema: z.ZodObject<{
384
458
  password: z.ZodString;
385
459
  fullname: z.ZodOptional<z.ZodString>;
386
460
  role: z.ZodOptional<z.ZodString>;
461
+ userInfo: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
387
462
  wsIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
388
463
  }, "strip", z.ZodTypeAny, {
389
464
  username: string;
@@ -391,6 +466,7 @@ declare const UserSchema: z.ZodObject<{
391
466
  email?: string | undefined;
392
467
  fullname?: string | undefined;
393
468
  role?: string | undefined;
469
+ userInfo?: Record<string, unknown> | undefined;
394
470
  wsIds?: string[] | undefined;
395
471
  }, {
396
472
  username: string;
@@ -398,6 +474,7 @@ declare const UserSchema: z.ZodObject<{
398
474
  email?: string | undefined;
399
475
  fullname?: string | undefined;
400
476
  role?: string | undefined;
477
+ userInfo?: Record<string, unknown> | undefined;
401
478
  wsIds?: string[] | undefined;
402
479
  }>;
403
480
  type User = z.infer<typeof UserSchema>;
@@ -408,6 +485,7 @@ declare const UsersDataSchema: z.ZodObject<{
408
485
  password: z.ZodString;
409
486
  fullname: z.ZodOptional<z.ZodString>;
410
487
  role: z.ZodOptional<z.ZodString>;
488
+ userInfo: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
411
489
  wsIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
412
490
  }, "strip", z.ZodTypeAny, {
413
491
  username: string;
@@ -415,6 +493,7 @@ declare const UsersDataSchema: z.ZodObject<{
415
493
  email?: string | undefined;
416
494
  fullname?: string | undefined;
417
495
  role?: string | undefined;
496
+ userInfo?: Record<string, unknown> | undefined;
418
497
  wsIds?: string[] | undefined;
419
498
  }, {
420
499
  username: string;
@@ -422,6 +501,7 @@ declare const UsersDataSchema: z.ZodObject<{
422
501
  email?: string | undefined;
423
502
  fullname?: string | undefined;
424
503
  role?: string | undefined;
504
+ userInfo?: Record<string, unknown> | undefined;
425
505
  wsIds?: string[] | undefined;
426
506
  }>, "many">;
427
507
  }, "strip", z.ZodTypeAny, {
@@ -431,6 +511,7 @@ declare const UsersDataSchema: z.ZodObject<{
431
511
  email?: string | undefined;
432
512
  fullname?: string | undefined;
433
513
  role?: string | undefined;
514
+ userInfo?: Record<string, unknown> | undefined;
434
515
  wsIds?: string[] | undefined;
435
516
  }[];
436
517
  }, {
@@ -440,6 +521,7 @@ declare const UsersDataSchema: z.ZodObject<{
440
521
  email?: string | undefined;
441
522
  fullname?: string | undefined;
442
523
  role?: string | undefined;
524
+ userInfo?: Record<string, unknown> | undefined;
443
525
  wsIds?: string[] | undefined;
444
526
  }[];
445
527
  }>;
@@ -544,42 +626,439 @@ declare const IncomingMessageSchema: z.ZodObject<{
544
626
  payload?: unknown;
545
627
  }>;
546
628
  type IncomingMessage = z.infer<typeof IncomingMessageSchema>;
629
+ declare const ComponentSchema: z.ZodObject<{
630
+ id: z.ZodString;
631
+ name: z.ZodString;
632
+ displayName: z.ZodOptional<z.ZodString>;
633
+ isDisplayComp: z.ZodOptional<z.ZodBoolean>;
634
+ type: z.ZodString;
635
+ description: z.ZodString;
636
+ props: z.ZodObject<{
637
+ query: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>]>>>;
638
+ title: z.ZodOptional<z.ZodString>;
639
+ description: z.ZodOptional<z.ZodString>;
640
+ config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
641
+ actions: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
642
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
643
+ query: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>]>>>;
644
+ title: z.ZodOptional<z.ZodString>;
645
+ description: z.ZodOptional<z.ZodString>;
646
+ config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
647
+ actions: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
648
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
649
+ query: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>]>>>;
650
+ title: z.ZodOptional<z.ZodString>;
651
+ description: z.ZodOptional<z.ZodString>;
652
+ config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
653
+ actions: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
654
+ }, z.ZodTypeAny, "passthrough">>;
655
+ category: z.ZodOptional<z.ZodString>;
656
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
657
+ }, "strip", z.ZodTypeAny, {
658
+ id: string;
659
+ type: string;
660
+ name: string;
661
+ description: string;
662
+ props: {
663
+ description?: string | undefined;
664
+ query?: string | {} | null | undefined;
665
+ title?: string | undefined;
666
+ config?: Record<string, unknown> | undefined;
667
+ actions?: any[] | undefined;
668
+ } & {
669
+ [k: string]: unknown;
670
+ };
671
+ displayName?: string | undefined;
672
+ isDisplayComp?: boolean | undefined;
673
+ category?: string | undefined;
674
+ keywords?: string[] | undefined;
675
+ }, {
676
+ id: string;
677
+ type: string;
678
+ name: string;
679
+ description: string;
680
+ props: {
681
+ description?: string | undefined;
682
+ query?: string | {} | null | undefined;
683
+ title?: string | undefined;
684
+ config?: Record<string, unknown> | undefined;
685
+ actions?: any[] | undefined;
686
+ } & {
687
+ [k: string]: unknown;
688
+ };
689
+ displayName?: string | undefined;
690
+ isDisplayComp?: boolean | undefined;
691
+ category?: string | undefined;
692
+ keywords?: string[] | undefined;
693
+ }>;
694
+ type Component = z.infer<typeof ComponentSchema>;
695
+ declare const OutputFieldSchema: z.ZodObject<{
696
+ name: z.ZodString;
697
+ type: z.ZodEnum<["string", "number", "boolean", "date"]>;
698
+ description: z.ZodString;
699
+ }, "strip", z.ZodTypeAny, {
700
+ type: "string" | "number" | "boolean" | "date";
701
+ name: string;
702
+ description: string;
703
+ }, {
704
+ type: "string" | "number" | "boolean" | "date";
705
+ name: string;
706
+ description: string;
707
+ }>;
708
+ type OutputField = z.infer<typeof OutputFieldSchema>;
709
+ declare const OutputSchema: z.ZodObject<{
710
+ description: z.ZodString;
711
+ fields: z.ZodArray<z.ZodObject<{
712
+ name: z.ZodString;
713
+ type: z.ZodEnum<["string", "number", "boolean", "date"]>;
714
+ description: z.ZodString;
715
+ }, "strip", z.ZodTypeAny, {
716
+ type: "string" | "number" | "boolean" | "date";
717
+ name: string;
718
+ description: string;
719
+ }, {
720
+ type: "string" | "number" | "boolean" | "date";
721
+ name: string;
722
+ description: string;
723
+ }>, "many">;
724
+ }, "strip", z.ZodTypeAny, {
725
+ description: string;
726
+ fields: {
727
+ type: "string" | "number" | "boolean" | "date";
728
+ name: string;
729
+ description: string;
730
+ }[];
731
+ }, {
732
+ description: string;
733
+ fields: {
734
+ type: "string" | "number" | "boolean" | "date";
735
+ name: string;
736
+ description: string;
737
+ }[];
738
+ }>;
739
+ type ToolOutputSchema = z.infer<typeof OutputSchema>;
547
740
  declare const ToolSchema: z.ZodObject<{
548
741
  id: z.ZodString;
549
742
  name: z.ZodString;
550
743
  description: z.ZodString;
744
+ /** Tool type: "source" = routed through SourceAgent, "direct" = called directly by MainAgent */
745
+ toolType: z.ZodOptional<z.ZodEnum<["source", "direct"]>>;
746
+ /** Full untruncated schema for source agent (all columns visible) */
747
+ fullSchema: z.ZodOptional<z.ZodString>;
551
748
  params: z.ZodRecord<z.ZodString, z.ZodString>;
552
749
  fn: z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodAny>;
750
+ outputSchema: z.ZodOptional<z.ZodObject<{
751
+ description: z.ZodString;
752
+ fields: z.ZodArray<z.ZodObject<{
753
+ name: z.ZodString;
754
+ type: z.ZodEnum<["string", "number", "boolean", "date"]>;
755
+ description: z.ZodString;
756
+ }, "strip", z.ZodTypeAny, {
757
+ type: "string" | "number" | "boolean" | "date";
758
+ name: string;
759
+ description: string;
760
+ }, {
761
+ type: "string" | "number" | "boolean" | "date";
762
+ name: string;
763
+ description: string;
764
+ }>, "many">;
765
+ }, "strip", z.ZodTypeAny, {
766
+ description: string;
767
+ fields: {
768
+ type: "string" | "number" | "boolean" | "date";
769
+ name: string;
770
+ description: string;
771
+ }[];
772
+ }, {
773
+ description: string;
774
+ fields: {
775
+ type: "string" | "number" | "boolean" | "date";
776
+ name: string;
777
+ description: string;
778
+ }[];
779
+ }>>;
780
+ /** Cache policy. `false` = never cache (live data, write ops). Mirrors HTTP `Cache-Control: no-store`. */
781
+ cache: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<false>, z.ZodObject<{
782
+ ttlMs: z.ZodOptional<z.ZodNumber>;
783
+ }, "strip", z.ZodTypeAny, {
784
+ ttlMs?: number | undefined;
785
+ }, {
786
+ ttlMs?: number | undefined;
787
+ }>]>>;
553
788
  }, "strip", z.ZodTypeAny, {
554
789
  id: string;
555
790
  params: Record<string, string>;
556
791
  name: string;
557
792
  description: string;
558
793
  fn: (args_0: any, ...args: unknown[]) => any;
794
+ toolType?: "source" | "direct" | undefined;
795
+ fullSchema?: string | undefined;
796
+ outputSchema?: {
797
+ description: string;
798
+ fields: {
799
+ type: "string" | "number" | "boolean" | "date";
800
+ name: string;
801
+ description: string;
802
+ }[];
803
+ } | undefined;
804
+ cache?: false | {
805
+ ttlMs?: number | undefined;
806
+ } | undefined;
559
807
  }, {
560
808
  id: string;
561
809
  params: Record<string, string>;
562
810
  name: string;
563
811
  description: string;
564
812
  fn: (args_0: any, ...args: unknown[]) => any;
813
+ toolType?: "source" | "direct" | undefined;
814
+ fullSchema?: string | undefined;
815
+ outputSchema?: {
816
+ description: string;
817
+ fields: {
818
+ type: "string" | "number" | "boolean" | "date";
819
+ name: string;
820
+ description: string;
821
+ }[];
822
+ } | undefined;
823
+ cache?: false | {
824
+ ttlMs?: number | undefined;
825
+ } | undefined;
565
826
  }>;
566
827
  type Tool$1 = z.infer<typeof ToolSchema>;
567
828
  type CollectionOperation = 'getMany' | 'getOne' | 'query' | 'mutation' | 'updateOne' | 'deleteOne' | 'createOne';
568
829
  type CollectionHandler<TParams = any, TResult = any> = (params: TParams) => Promise<TResult> | TResult;
569
- type LLMProvider = 'anthropic' | 'groq';
830
+ type LLMProvider = 'anthropic' | 'groq' | 'gemini' | 'openai';
570
831
 
832
+ type DatabaseType = 'postgresql' | 'mssql' | 'snowflake' | 'mysql';
833
+ /**
834
+ * Model strategy for controlling which models are used for different tasks
835
+ * - 'best': Use the best model (e.g., Sonnet) for all tasks - highest quality, higher cost
836
+ * - 'fast': Use the fast model (e.g., Haiku) for all tasks - lower quality, lower cost
837
+ * - 'balanced': Use best model for complex tasks, fast model for simple tasks (default)
838
+ */
839
+ type ModelStrategy = 'best' | 'fast' | 'balanced';
840
+ /**
841
+ * Model configuration for DASH_COMP flow (dashboard component picking)
842
+ * Allows separate control of models used for component selection
843
+ */
844
+ interface DashCompModelConfig {
845
+ /**
846
+ * Primary model for DASH_COMP requests
847
+ * Format: "provider/model-name" (e.g., "anthropic/claude-sonnet-4-5-20250929")
848
+ */
849
+ model?: string;
850
+ /**
851
+ * Fast model for simpler DASH_COMP tasks (optional)
852
+ * Format: "provider/model-name" (e.g., "anthropic/claude-haiku-4-5-20251001")
853
+ */
854
+ fastModel?: string;
855
+ }
571
856
  interface SuperatomSDKConfig {
572
857
  url?: string;
573
- apiKey: string;
858
+ apiKey?: string;
574
859
  projectId: string;
575
- userId?: string;
576
860
  type?: string;
577
861
  bundleDir?: string;
578
862
  promptsDir?: string;
863
+ databaseType?: DatabaseType;
579
864
  ANTHROPIC_API_KEY?: string;
580
865
  GROQ_API_KEY?: string;
866
+ GEMINI_API_KEY?: string;
867
+ OPENAI_API_KEY?: string;
581
868
  LLM_PROVIDERS?: LLMProvider[];
582
869
  logLevel?: LogLevel;
870
+ /**
871
+ * Model selection strategy for LLM API calls:
872
+ * - 'best': Use best model for all tasks (highest quality, higher cost)
873
+ * - 'fast': Use fast model for all tasks (lower quality, lower cost)
874
+ * - 'balanced': Use best model for complex tasks, fast model for simple tasks (default)
875
+ */
876
+ modelStrategy?: ModelStrategy;
877
+ /**
878
+ * Model for the main agent (routing + analysis).
879
+ * Format: "provider/model-name" (e.g., "anthropic/claude-haiku-4-5-20251001")
880
+ * If not set, uses the provider's default model.
881
+ */
882
+ mainAgentModel?: string;
883
+ /**
884
+ * Model for source agents (per-source query generation).
885
+ * Format: "provider/model-name" (e.g., "anthropic/claude-haiku-4-5-20251001")
886
+ * If not set, uses the provider's default model.
887
+ */
888
+ sourceAgentModel?: string;
889
+ /**
890
+ * Separate model configuration for DASH_COMP flow (dashboard component picking)
891
+ * If not provided, falls back to provider-based model selection
892
+ */
893
+ dashCompModels?: DashCompModelConfig;
894
+ /**
895
+ * Similarity threshold for conversation search (semantic matching)
896
+ * Value between 0 and 1 (e.g., 0.8 = 80% similarity required)
897
+ * Higher values require closer matches, lower values allow more distant matches
898
+ * Default: 0.8
899
+ */
900
+ conversationSimilarityThreshold?: number;
901
+ /**
902
+ * Query cache TTL (Time To Live) in minutes
903
+ * Cached query results expire after this duration
904
+ * Default: 5 minutes
905
+ */
906
+ queryCacheTTL?: number;
907
+ /**
908
+ * Dashboard conversation history TTL (Time To Live) in minutes
909
+ * Per-dashboard conversation histories expire after this duration
910
+ * Default: 30 minutes
911
+ */
912
+ dashboardHistoryTTL?: number;
913
+ }
914
+
915
+ declare const KbNodesQueryFiltersSchema: z.ZodObject<{
916
+ query: z.ZodOptional<z.ZodString>;
917
+ category: z.ZodOptional<z.ZodString>;
918
+ tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
919
+ type: z.ZodOptional<z.ZodEnum<["global", "user", "query"]>>;
920
+ createdBy: z.ZodOptional<z.ZodString>;
921
+ }, "strip", z.ZodTypeAny, {
922
+ type?: "query" | "user" | "global" | undefined;
923
+ query?: string | undefined;
924
+ category?: string | undefined;
925
+ createdBy?: string | undefined;
926
+ tags?: string[] | undefined;
927
+ }, {
928
+ type?: "query" | "user" | "global" | undefined;
929
+ query?: string | undefined;
930
+ category?: string | undefined;
931
+ createdBy?: string | undefined;
932
+ tags?: string[] | undefined;
933
+ }>;
934
+ type KbNodesQueryFilters = z.infer<typeof KbNodesQueryFiltersSchema>;
935
+ declare const KbNodesRequestPayloadSchema: z.ZodObject<{
936
+ operation: z.ZodEnum<["create", "update", "delete", "getAll", "getOne", "search", "getByCategory", "getByUser", "getCategories", "getTags"]>;
937
+ data: z.ZodOptional<z.ZodObject<{
938
+ id: z.ZodOptional<z.ZodNumber>;
939
+ title: z.ZodOptional<z.ZodString>;
940
+ content: z.ZodOptional<z.ZodString>;
941
+ category: z.ZodOptional<z.ZodString>;
942
+ tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
943
+ type: z.ZodOptional<z.ZodEnum<["global", "user", "query"]>>;
944
+ createdBy: z.ZodOptional<z.ZodString>;
945
+ updatedBy: z.ZodOptional<z.ZodString>;
946
+ userId: z.ZodOptional<z.ZodString>;
947
+ query: z.ZodOptional<z.ZodString>;
948
+ filters: z.ZodOptional<z.ZodObject<{
949
+ query: z.ZodOptional<z.ZodString>;
950
+ category: z.ZodOptional<z.ZodString>;
951
+ tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
952
+ type: z.ZodOptional<z.ZodEnum<["global", "user", "query"]>>;
953
+ createdBy: z.ZodOptional<z.ZodString>;
954
+ }, "strip", z.ZodTypeAny, {
955
+ type?: "query" | "user" | "global" | undefined;
956
+ query?: string | undefined;
957
+ category?: string | undefined;
958
+ createdBy?: string | undefined;
959
+ tags?: string[] | undefined;
960
+ }, {
961
+ type?: "query" | "user" | "global" | undefined;
962
+ query?: string | undefined;
963
+ category?: string | undefined;
964
+ createdBy?: string | undefined;
965
+ tags?: string[] | undefined;
966
+ }>>;
967
+ limit: z.ZodOptional<z.ZodNumber>;
968
+ offset: z.ZodOptional<z.ZodNumber>;
969
+ }, "strip", z.ZodTypeAny, {
970
+ id?: number | undefined;
971
+ type?: "query" | "user" | "global" | undefined;
972
+ query?: string | undefined;
973
+ title?: string | undefined;
974
+ category?: string | undefined;
975
+ userId?: string | undefined;
976
+ limit?: number | undefined;
977
+ filters?: {
978
+ type?: "query" | "user" | "global" | undefined;
979
+ query?: string | undefined;
980
+ category?: string | undefined;
981
+ createdBy?: string | undefined;
982
+ tags?: string[] | undefined;
983
+ } | undefined;
984
+ createdBy?: string | undefined;
985
+ updatedBy?: string | undefined;
986
+ offset?: number | undefined;
987
+ tags?: string[] | undefined;
988
+ content?: string | undefined;
989
+ }, {
990
+ id?: number | undefined;
991
+ type?: "query" | "user" | "global" | undefined;
992
+ query?: string | undefined;
993
+ title?: string | undefined;
994
+ category?: string | undefined;
995
+ userId?: string | undefined;
996
+ limit?: number | undefined;
997
+ filters?: {
998
+ type?: "query" | "user" | "global" | undefined;
999
+ query?: string | undefined;
1000
+ category?: string | undefined;
1001
+ createdBy?: string | undefined;
1002
+ tags?: string[] | undefined;
1003
+ } | undefined;
1004
+ createdBy?: string | undefined;
1005
+ updatedBy?: string | undefined;
1006
+ offset?: number | undefined;
1007
+ tags?: string[] | undefined;
1008
+ content?: string | undefined;
1009
+ }>>;
1010
+ }, "strip", z.ZodTypeAny, {
1011
+ operation: "create" | "getOne" | "update" | "delete" | "getAll" | "search" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
1012
+ data?: {
1013
+ id?: number | undefined;
1014
+ type?: "query" | "user" | "global" | undefined;
1015
+ query?: string | undefined;
1016
+ title?: string | undefined;
1017
+ category?: string | undefined;
1018
+ userId?: string | undefined;
1019
+ limit?: number | undefined;
1020
+ filters?: {
1021
+ type?: "query" | "user" | "global" | undefined;
1022
+ query?: string | undefined;
1023
+ category?: string | undefined;
1024
+ createdBy?: string | undefined;
1025
+ tags?: string[] | undefined;
1026
+ } | undefined;
1027
+ createdBy?: string | undefined;
1028
+ updatedBy?: string | undefined;
1029
+ offset?: number | undefined;
1030
+ tags?: string[] | undefined;
1031
+ content?: string | undefined;
1032
+ } | undefined;
1033
+ }, {
1034
+ operation: "create" | "getOne" | "update" | "delete" | "getAll" | "search" | "getByCategory" | "getByUser" | "getCategories" | "getTags";
1035
+ data?: {
1036
+ id?: number | undefined;
1037
+ type?: "query" | "user" | "global" | undefined;
1038
+ query?: string | undefined;
1039
+ title?: string | undefined;
1040
+ category?: string | undefined;
1041
+ userId?: string | undefined;
1042
+ limit?: number | undefined;
1043
+ filters?: {
1044
+ type?: "query" | "user" | "global" | undefined;
1045
+ query?: string | undefined;
1046
+ category?: string | undefined;
1047
+ createdBy?: string | undefined;
1048
+ tags?: string[] | undefined;
1049
+ } | undefined;
1050
+ createdBy?: string | undefined;
1051
+ updatedBy?: string | undefined;
1052
+ offset?: number | undefined;
1053
+ tags?: string[] | undefined;
1054
+ content?: string | undefined;
1055
+ } | undefined;
1056
+ }>;
1057
+ type KbNodesRequestPayload = z.infer<typeof KbNodesRequestPayloadSchema>;
1058
+ interface T_RESPONSE {
1059
+ success: boolean;
1060
+ data?: any;
1061
+ errors: string[];
583
1062
  }
584
1063
 
585
1064
  /**
@@ -841,104 +1320,1126 @@ declare class ReportManager {
841
1320
  getReportCount(): number;
842
1321
  }
843
1322
 
844
- type SystemPrompt = string | Anthropic.Messages.TextBlockParam[];
845
- interface LLMMessages {
846
- sys: SystemPrompt;
847
- user: string;
848
- }
849
- interface LLMOptions {
850
- model?: string;
851
- maxTokens?: number;
852
- temperature?: number;
853
- topP?: number;
854
- apiKey?: string;
855
- partial?: (chunk: string) => void;
856
- }
857
- interface Tool {
858
- name: string;
859
- description: string;
860
- input_schema: {
861
- type: string;
862
- properties: Record<string, any>;
863
- required?: string[];
864
- };
865
- }
866
- declare class LLM {
867
- static text(messages: LLMMessages, options?: LLMOptions): Promise<string>;
868
- static stream<T = string>(messages: LLMMessages, options?: LLMOptions, json?: boolean): Promise<T extends string ? string : any>;
869
- static streamWithTools(messages: LLMMessages, tools: Tool[], toolHandler: (toolName: string, toolInput: any) => Promise<any>, options?: LLMOptions, maxIterations?: number): Promise<string>;
1323
+ /**
1324
+ * StreamBuffer - Buffered streaming utility for smoother text delivery
1325
+ * Batches small chunks together and flushes at regular intervals
1326
+ */
1327
+ type StreamCallback = (chunk: string) => void;
1328
+ /**
1329
+ * StreamBuffer class for managing buffered streaming output
1330
+ * Provides smooth text delivery by batching small chunks
1331
+ */
1332
+ declare class StreamBuffer {
1333
+ private buffer;
1334
+ private flushTimer;
1335
+ private callback;
1336
+ private fullText;
1337
+ constructor(callback?: StreamCallback);
870
1338
  /**
871
- * Normalize system prompt to Anthropic format
872
- * Converts string to array format if needed
873
- * @param sys - System prompt (string or array of blocks)
874
- * @returns Normalized system prompt for Anthropic API
1339
+ * Check if the buffer has a callback configured
875
1340
  */
876
- private static _normalizeSystemPrompt;
1341
+ hasCallback(): boolean;
877
1342
  /**
878
- * Log cache usage metrics from Anthropic API response
879
- * Shows cache hits, costs, and savings
1343
+ * Get all text that has been written (including already flushed)
880
1344
  */
881
- private static _logCacheUsage;
1345
+ getFullText(): string;
882
1346
  /**
883
- * Parse model string to extract provider and model name
884
- * @param modelString - Format: "provider/model-name" or just "model-name"
885
- * @returns [provider, modelName]
1347
+ * Write a chunk to the buffer
1348
+ * Large chunks or chunks with newlines are flushed immediately
1349
+ * Small chunks are batched and flushed after a short interval
886
1350
  *
887
- * @example
888
- * "anthropic/claude-sonnet-4-5" → ["anthropic", "claude-sonnet-4-5"]
889
- * "groq/openai/gpt-oss-120b" → ["groq", "openai/gpt-oss-120b"]
890
- * "claude-sonnet-4-5" → ["anthropic", "claude-sonnet-4-5"] (default)
1351
+ * @param chunk - Text chunk to write
891
1352
  */
892
- private static _parseModel;
893
- private static _anthropicText;
894
- private static _anthropicStream;
895
- private static _anthropicStreamWithTools;
896
- private static _groqText;
897
- private static _groqStream;
1353
+ write(chunk: string): void;
898
1354
  /**
899
- * Parse JSON string, handling markdown code blocks and surrounding text
900
- * Enhanced version with jsonrepair to handle malformed JSON from LLMs
901
- * @param text - Text that may contain JSON wrapped in ```json...``` or with surrounding text
902
- * @returns Parsed JSON object or array
1355
+ * Flush the buffer immediately
1356
+ * Call this before tool execution or other operations that need clean output
903
1357
  */
904
- private static _parseJSON;
1358
+ flush(): void;
1359
+ /**
1360
+ * Internal flush implementation
1361
+ */
1362
+ private flushNow;
1363
+ /**
1364
+ * Clean up resources
1365
+ * Call this when done with the buffer
1366
+ */
1367
+ dispose(): void;
905
1368
  }
906
1369
 
907
- interface CapturedLog {
908
- timestamp: number;
909
- level: 'info' | 'error' | 'warn' | 'debug';
910
- message: string;
911
- type?: 'explanation' | 'query' | 'general';
912
- data?: Record<string, any>;
1370
+ /**
1371
+ * ToolExecutorService - Handles execution of SQL queries and external tools
1372
+ * Extracted from BaseLLM.generateTextResponse for better separation of concerns
1373
+ */
1374
+
1375
+ /**
1376
+ * External tool definition
1377
+ */
1378
+ interface ExternalTool {
1379
+ id: string;
1380
+ name: string;
1381
+ description?: string;
1382
+ /** Tool type: "source" = routed through SourceAgent, "direct" = called directly by MainAgent */
1383
+ toolType?: 'source' | 'direct';
1384
+ /** Full untruncated schema for source agent (all columns visible) */
1385
+ fullSchema?: string;
1386
+ /** Schema size tier: small (≤50 tables), medium (51-200), large (201-500), very_large (500+) */
1387
+ schemaTier?: string;
1388
+ /** Schema search function for very_large tier — keyword search over entities */
1389
+ schemaSearchFn?: (keywords: string[]) => string;
1390
+ fn: (input: any) => Promise<any>;
1391
+ limit?: number;
1392
+ outputSchema?: any;
1393
+ executionType?: 'immediate' | 'deferred';
1394
+ userProvidedData?: any;
1395
+ params?: Record<string, any>;
913
1396
  }
914
1397
  /**
915
- * UILogCollector captures logs during user prompt processing
916
- * and sends them to runtime via ui_logs message with uiBlockId as the message id
917
- * Logs are sent in real-time for streaming effect in the UI
918
- * Respects the global log level configuration
1398
+ * Executed tool tracking info
919
1399
  */
920
- declare class UILogCollector {
921
- private logs;
922
- private uiBlockId;
923
- private clientId;
924
- private sendMessage;
925
- private currentLogLevel;
926
- constructor(clientId: string, sendMessage: (message: Message) => void, uiBlockId?: string);
1400
+ interface ExecutedToolInfo {
1401
+ id: string;
1402
+ name: string;
1403
+ params: any;
1404
+ result: {
1405
+ _totalRecords: number;
1406
+ _recordsShown: number;
1407
+ _metadata?: any;
1408
+ _sampleData: any[];
1409
+ /** Bounded summary over the FULL fetched result (complete structure). */
1410
+ _summary?: any;
1411
+ /** Up to MAIN_AGENT_COMPLETE_ROWS rows — the complete result when small. */
1412
+ _mainAgentRows?: any[];
1413
+ };
1414
+ outputSchema?: any;
1415
+ sourceSchema?: string;
1416
+ sourceType?: string;
1417
+ }
1418
+
1419
+ /**
1420
+ * Multi-Agent Architecture Types
1421
+ *
1422
+ * Defines interfaces for the hierarchical agent system:
1423
+ * - Main Agent: ONE LLM.streamWithTools() call with source agent tools
1424
+ * - Source Agents: independent agents that query individual data sources
1425
+ *
1426
+ * The main agent sees only source summaries. When it calls a source tool,
1427
+ * the SourceAgent runs independently (own LLM, own retries) and returns clean data.
1428
+ */
1429
+
1430
+ /**
1431
+ * Per-entity detail: name, row count, and column names.
1432
+ * Gives the main agent enough context to route to the right source.
1433
+ */
1434
+ interface EntityDetail {
1435
+ /** Entity name (table, sheet, endpoint) */
1436
+ name: string;
1437
+ /** Approximate row count */
1438
+ rowCount?: number;
1439
+ /** Column/field names */
1440
+ columns: string[];
1441
+ }
1442
+ /**
1443
+ * Representation of a data source for the main agent.
1444
+ * Contains entity names WITH column names so the LLM can route accurately.
1445
+ */
1446
+ interface SourceSummary {
1447
+ /** Source ID (matches tool ID prefix) */
1448
+ id: string;
1449
+ /** Human-readable source name */
1450
+ name: string;
1451
+ /** Source type: postgres, excel, rest_api, etc. */
1452
+ type: string;
1453
+ /** Brief description of what data this source contains */
1454
+ description: string;
1455
+ /** Detailed entity info with column names for routing */
1456
+ entityDetails: EntityDetail[];
1457
+ /** The tool ID associated with this source */
1458
+ toolId: string;
1459
+ }
1460
+ /**
1461
+ * What a source agent returns after querying its data source.
1462
+ * The main agent uses this to analyze and compose the final response.
1463
+ */
1464
+ interface SourceAgentResult {
1465
+ /** Source ID */
1466
+ sourceId: string;
1467
+ /** Source name */
1468
+ sourceName: string;
1469
+ /** Whether the query succeeded */
1470
+ success: boolean;
1471
+ /** Result data rows */
1472
+ data: any[];
1473
+ /** Metadata about the query execution */
1474
+ metadata: SourceAgentMetadata;
1475
+ /** Tool execution info for the last successful query (backward compat) */
1476
+ executedTool: ExecutedToolInfo;
1477
+ /** All successful tool executions (primary + follow-up queries) */
1478
+ allExecutedTools?: ExecutedToolInfo[];
1479
+ /** Error message if failed */
1480
+ error?: string;
1481
+ }
1482
+ interface SourceAgentMetadata {
1483
+ /** Total rows that matched the query (before limit) */
1484
+ totalRowsMatched: number;
1485
+ /** Rows actually returned (after limit) */
1486
+ rowsReturned: number;
1487
+ /** Whether the result was truncated by the row limit */
1488
+ isLimited: boolean;
1489
+ /** The query/params that were executed */
1490
+ queryExecuted?: string;
1491
+ /** Execution time in milliseconds */
1492
+ executionTimeMs: number;
1493
+ }
1494
+ /**
1495
+ * A pre-built, multi-step UI flow registered with the SDK.
1496
+ *
1497
+ * When the main agent decides a user's question matches a workflow's whenToUse
1498
+ * trigger, it picks the workflow instead of running source agents / generating
1499
+ * dashboard components. The LLM extracts the workflow's required props from the
1500
+ * prompt (using `propsSchema` as the tool input_schema) and the SDK returns the
1501
+ * workflow component directly — no analysis text, no chart generation. The
1502
+ * frontend renders the registered workflow component with the LLM-extracted
1503
+ * props.
1504
+ */
1505
+ interface WorkflowDescriptor {
1506
+ /** Unique workflow id (used as the LLM tool name) */
1507
+ id: string;
1508
+ /** Component name on the frontend (matches the registered React component) */
1509
+ name: string;
1510
+ /** Short human-readable description of what this workflow does */
1511
+ description: string;
927
1512
  /**
928
- * Check if logging is enabled (uiBlockId is provided)
1513
+ * 1–2 sentence trigger condition. The LLM uses this to decide if the
1514
+ * user's prompt matches this workflow. Be specific — e.g.
1515
+ * "User wants to *initiate* an inventory transfer (review + submit POs),
1516
+ * not just see analysis or charts."
929
1517
  */
930
- isEnabled(): boolean;
1518
+ whenToUse: string;
931
1519
  /**
932
- * Check if a message should be logged based on current log level
1520
+ * JSON-schema-style description of the props the workflow needs. Becomes
1521
+ * the LLM tool's input_schema, so the model fills these from the prompt.
1522
+ * Use the same shape as `params` on direct tools — string descriptors with
1523
+ * an optional "(optional)" suffix.
1524
+ *
1525
+ * Example:
1526
+ * ```
1527
+ * {
1528
+ * selectedStore: 'object — { id, name } of the source branch',
1529
+ * minROI: 'number (optional) — only show transfers with ROI ≥ this',
1530
+ * }
1531
+ * ```
933
1532
  */
934
- private shouldLog;
1533
+ propsSchema: Record<string, string>;
935
1534
  /**
936
- * Add a log entry with timestamp and immediately send to runtime
937
- * Only logs that pass the log level filter are captured and sent
1535
+ * Optional: static prop defaults merged with LLM-extracted props before
1536
+ * the component is returned. Useful for things like the embedded
1537
+ * `externalTool` config that the workflow uses to fetch its own data.
938
1538
  */
939
- private addLog;
1539
+ defaultProps?: Record<string, any>;
1540
+ }
1541
+ /**
1542
+ * The workflow selection captured during a routing call.
1543
+ * Set on AgentResponse when the LLM picks a workflow tool.
1544
+ */
1545
+ interface SelectedWorkflow {
1546
+ /** Component name (matches WorkflowDescriptor.name) */
1547
+ name: string;
1548
+ /** Props extracted from the prompt + merged with workflow.defaultProps */
1549
+ props: Record<string, any>;
1550
+ }
1551
+ /**
1552
+ * The complete response from the multi-agent system.
1553
+ * Contains everything needed for text display + component generation.
1554
+ */
1555
+ interface AgentResponse {
1556
+ /** Generated text response (analysis of the data) */
1557
+ text: string;
1558
+ /** All executed tools across all source agents (for component generation) */
1559
+ executedTools: ExecutedToolInfo[];
1560
+ /** Individual results from each source agent */
1561
+ sourceResults: SourceAgentResult[];
940
1562
  /**
941
- * Send a single log to runtime immediately
1563
+ * Populated when MainAgent wrote AND successfully executed a script during its turn.
1564
+ * Caller (agent-user-response.ts) persists it via ScriptStore.save().
1565
+ * Absent when MainAgent didn't write one (trivial question / all attempts failed).
1566
+ */
1567
+ savedScript?: AgentWrittenScript;
1568
+ /**
1569
+ * Set when the LLM routed the question to a registered workflow component.
1570
+ * When present, the upstream caller should skip component generation and
1571
+ * return this workflow as the response.
1572
+ */
1573
+ workflow?: SelectedWorkflow;
1574
+ }
1575
+ /**
1576
+ * A script MainAgent authored + verified during its turn. Shape aligns with
1577
+ * what ScriptStore.save() needs — minus store-assigned fields (id, timestamps, counts).
1578
+ */
1579
+ interface AgentWrittenScript {
1580
+ /**
1581
+ * `ScriptRecipe.id` of the draft that was authored + verified during this turn.
1582
+ * The caller passes this to `ScriptStore.promoteToVerified(recipeId, …)` to
1583
+ * flip the draft to verified status and (when possible) drop the turn-suffix
1584
+ * from its filename.
1585
+ */
1586
+ recipeId: string;
1587
+ name: string;
1588
+ intentDescription: string;
1589
+ tags: string[];
1590
+ parameters: Array<{
1591
+ name: string;
1592
+ type: 'string' | 'number' | 'date' | 'date_range' | 'enum' | 'boolean';
1593
+ required: boolean;
1594
+ default?: any;
1595
+ enumValues?: Record<string, string>;
1596
+ description: string;
1597
+ }>;
1598
+ scriptBody: string;
1599
+ /** Source IDs referenced by the script (extracted from ctx.query calls) */
1600
+ sourceIds: string[];
1601
+ /** Tables referenced in the script's SQL (regex-extracted) */
1602
+ tables: string[];
1603
+ /** Executed queries from the verified run — fed to component generation */
1604
+ executedQueries: Array<{
1605
+ sourceId: string;
1606
+ sourceName: string;
1607
+ sql: string;
1608
+ data: any[];
1609
+ count: number;
1610
+ totalCount?: number;
1611
+ executionTimeMs: number;
1612
+ /**
1613
+ * True for synthetic entries (ctx.emit datasets, the computed:_final
1614
+ * post-JS data). The component generator routes virtual sources through
1615
+ * the script_dataset sentinel toolId so the frontend resolves them via
1616
+ * queryCache instead of attempting to re-execute SQL.
1617
+ */
1618
+ virtual?: boolean;
1619
+ }>;
1620
+ }
1621
+ /**
1622
+ * Configuration for the multi-agent system.
1623
+ * Controls limits, models, and behavior.
1624
+ */
1625
+ interface AgentConfig {
1626
+ /** Max rows shown to the UI preview / inlined per source (default: 10) */
1627
+ maxRowsPerSource: number;
1628
+ /**
1629
+ * Max rows a source query may FETCH from the DB server-side (default: 2000).
1630
+ * Decoupled from what the main agent is shown: the full result is fetched and
1631
+ * summarized (bounded), but only a small/complete slice enters LLM context.
1632
+ * This lets small lookups (benchmark maps) arrive COMPLETE without letting
1633
+ * large results blow up context.
1634
+ */
1635
+ maxRowsFetched: number;
1636
+ /** Model for the main agent (routing + analysis in one LLM call) */
1637
+ mainAgentModel: string;
1638
+ /** Model for source agent query generation */
1639
+ sourceAgentModel: string;
1640
+ /** API key for LLM calls */
1641
+ apiKey?: string;
1642
+ /** Max retry attempts per source agent */
1643
+ maxRetries: number;
1644
+ /** Max tool calling iterations for the main agent loop */
1645
+ maxIterations: number;
1646
+ /** Global knowledge base context (static, same for all users/questions — cached in system prompt) */
1647
+ globalKnowledgeBase?: string;
1648
+ /** Per-request knowledge base context (user-specific + query-matched — dynamic, not cached) */
1649
+ knowledgeBaseContext?: string;
1650
+ /** Collections registry (ChromaDB search hooks) for embedding-based schema + source search */
1651
+ collections?: any;
1652
+ /** Optional project ID for scoping embedding searches */
1653
+ projectId?: string;
1654
+ }
1655
+ /**
1656
+ * Default agent configuration
1657
+ */
1658
+ declare const DEFAULT_AGENT_CONFIG: AgentConfig;
1659
+
1660
+ /**
1661
+ * Script Flow Types
1662
+ *
1663
+ * Defines interfaces for the script-based query architecture:
1664
+ * - ScriptRecipe: metadata for matching, validation, and quality tracking
1665
+ * - ScriptResult: output from executing a script
1666
+ * - ScriptMatch: result from the LLM-based script matcher
1667
+ */
1668
+ /**
1669
+ * Recipe metadata stored alongside each script.
1670
+ * Used for matching, validation, and quality tracking.
1671
+ */
1672
+ interface ScriptRecipe {
1673
+ /** Unique script identifier */
1674
+ id: string;
1675
+ /** Version number (incremented on regeneration) */
1676
+ version: number;
1677
+ /** Human-readable name (e.g., "Revenue by Dimension") */
1678
+ name: string;
1679
+ /** Natural language description of what this script does */
1680
+ intentDescription: string;
1681
+ /** Keyword tags for quick filtering */
1682
+ tags: string[];
1683
+ /** Source tool IDs this script queries (e.g., ["mssql-abc123_query"]) */
1684
+ sourceIds: string[];
1685
+ /** Table names used (for future schema drift detection) */
1686
+ tables: string[];
1687
+ /** Parameter definitions — what can vary */
1688
+ parameters: ScriptParameter[];
1689
+ /** The script function body as a string. Loaded from disk (scripts-store/<fileBase>.ts). */
1690
+ scriptBody: string;
1691
+ /**
1692
+ * On-disk filename stem for the body: scripts-store/<fileBase>.ts.
1693
+ * Editable in the IDE. Decided at authoring time (slug of `name`, with a
1694
+ * short id suffix on collision) and stable across promotion.
1695
+ */
1696
+ fileBase?: string;
1697
+ /** sha256 of the on-disk body — lets the runtime detect manual edits. */
1698
+ bodyHash?: string;
1699
+ /** Project scope (single-VM deployments may leave this undefined). */
1700
+ projectId?: string;
1701
+ /** Times this script was used successfully */
1702
+ successCount: number;
1703
+ /** Times this script failed */
1704
+ failureCount: number;
1705
+ /** ISO timestamp of last usage */
1706
+ lastUsed: string;
1707
+ /** Original user question that created this script */
1708
+ createdFrom: string;
1709
+ /** ISO timestamp */
1710
+ createdAt: string;
1711
+ /** ISO timestamp */
1712
+ updatedAt: string;
1713
+ /**
1714
+ * `recipe.id` of the parent this script was forked from.
1715
+ * Undefined for root scripts (those written from scratch by MainAgent).
1716
+ * See backend/docs/SCRIPT-FLOW-FORK-ADAPT.md.
1717
+ */
1718
+ parentId?: string;
1719
+ /** 0 for root scripts; `parent.forkDepth + 1` for forks. Capped at 3. */
1720
+ forkDepth?: number;
1721
+ /**
1722
+ * Brief description of what this fork changed vs its parent
1723
+ * (sourced from the matcher's `modificationHint`).
1724
+ */
1725
+ forkReason?: string;
1726
+ /**
1727
+ * Validated component specs captured at authoring time. On a tier-high
1728
+ * replay these are rebound to fresh queryIds deterministically — no
1729
+ * component-generation LLM call, and the rendered columns can't drift from
1730
+ * what was validated when the script was authored. Absent on recipes
1731
+ * authored before this landed; those fall back to LLM component generation.
1732
+ * See backend/docs/SCRIPT-COMPONENT-CONSISTENCY.md.
1733
+ */
1734
+ components?: ScriptComponentSpec[];
1735
+ /**
1736
+ * Lifecycle stage of this recipe on disk.
1737
+ * - 'draft': written by MainAgent's write_script during a turn; filtered out
1738
+ * of FTS results (status='verified' only) so the matcher never picks it.
1739
+ * Filename is suffixed with `turnId` to keep concurrent turns
1740
+ * from clobbering each other's drafts.
1741
+ * - 'verified': promoted after `execute_script` succeeded; the matcher sees it.
1742
+ * Filename drops the turn suffix unless a verified file with
1743
+ * the same slug already exists (collision case keeps the suffix).
1744
+ *
1745
+ * Recipes loaded from disk without this field default to 'verified' so
1746
+ * existing scripts keep working unchanged.
1747
+ */
1748
+ status?: 'draft' | 'verified';
1749
+ /**
1750
+ * Per-turn unique suffix used for draft filenames (e.g. `1714745623-x9k2`).
1751
+ * Set when the draft is saved; carried until the recipe is promoted.
1752
+ */
1753
+ turnId?: string;
1754
+ /**
1755
+ * Last execution error captured by `recordDraftError` while the recipe was
1756
+ * still a draft. Lets users open the draft .json file and see why it failed
1757
+ * without grepping logs. Cleared on promotion to 'verified'.
1758
+ */
1759
+ lastError?: {
1760
+ phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
1761
+ message: string;
1762
+ at: string;
1763
+ attempt: number;
1764
+ };
1765
+ }
1766
+ interface ScriptParameter {
1767
+ /** Parameter name (used in script body as params.name) */
1768
+ name: string;
1769
+ /** Parameter type */
1770
+ type: 'string' | 'number' | 'date' | 'date_range' | 'enum' | 'boolean';
1771
+ /** Whether this parameter is required */
1772
+ required: boolean;
1773
+ /** Default value if not provided */
1774
+ default?: any;
1775
+ /** For enum type — maps user-facing values to internal values */
1776
+ enumValues?: Record<string, string>;
1777
+ /** Human-readable description (used in the matcher LLM prompt) */
1778
+ description: string;
1779
+ }
1780
+ /**
1781
+ * A reusable component binding captured when a script is authored. Stored on
1782
+ * the recipe so tier-high replays rebuild components deterministically (rebind
1783
+ * to fresh queryIds) instead of re-running the component-picker LLM.
1784
+ */
1785
+ interface ScriptComponentSpec {
1786
+ /** Registered component name (e.g. "DynamicBarChart") — matched against the available component library. */
1787
+ componentType: string;
1788
+ /** `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). */
1789
+ sourceRef: string;
1790
+ /** Present only when sourceRef === 'federation' — the DuckDB SQL to re-execute on replay. */
1791
+ federationSql?: string;
1792
+ /** Present only when sourceRef === 'markdown' — the narrative text to render on replay (markdown has no data source, so its content must be persisted). */
1793
+ content?: string;
1794
+ title?: string;
1795
+ description?: string;
1796
+ /** Validated axis/value keys + aggregation — all referencing real columns of the bound source. */
1797
+ config: Record<string, any>;
1798
+ }
1799
+ /**
1800
+ * Result from executing a script via ScriptRunner.
1801
+ */
1802
+ interface ScriptResult {
1803
+ /** Whether the script executed successfully */
1804
+ success: boolean;
1805
+ /** Combined data from all queries */
1806
+ data: any[];
1807
+ /** Individual query results tracked during execution */
1808
+ executedQueries: ScriptQueryResult[];
1809
+ /** Error message if failed */
1810
+ error?: string;
1811
+ /**
1812
+ * Where in the lifecycle the error occurred. Lets MainAgent's fix-loop
1813
+ * decide between "rewrite the whole draft" (compile) and "patch the
1814
+ * specific line" (runtime).
1815
+ */
1816
+ errorPhase?: 'compile' | 'runtime' | 'timeout' | 'ipc';
1817
+ /** Total execution time in milliseconds */
1818
+ executionTimeMs: number;
1819
+ }
1820
+ /**
1821
+ * A single query executed during script runtime.
1822
+ * Tracked by ScriptContext for component generation and debugging.
1823
+ */
1824
+ interface ScriptQueryResult {
1825
+ /** Source tool ID */
1826
+ sourceId: string;
1827
+ /** Human-readable source name */
1828
+ sourceName: string;
1829
+ /** The SQL that was executed */
1830
+ sql: string;
1831
+ /** Result data rows */
1832
+ data: any[];
1833
+ /** Number of rows returned */
1834
+ count: number;
1835
+ /** Total rows that matched before limit (if available) */
1836
+ totalCount?: number;
1837
+ /** Query execution time in milliseconds */
1838
+ executionTimeMs: number;
1839
+ /**
1840
+ * True for rows that did NOT come from a real SQL execution — either a
1841
+ * ctx.emit() dataset or the synthesized "computed:_final" entry that
1842
+ * carries the script's post-JS returned data. The component generator
1843
+ * uses this to route the resulting component through the script_dataset
1844
+ * sentinel toolId so the frontend resolves it via the queryCache short-circuit.
1845
+ */
1846
+ virtual?: boolean;
1847
+ }
1848
+ /**
1849
+ * Match tier returned by the LLM script matcher.
1850
+ *
1851
+ * - 'high': the script answers the question directly; only parameter values
1852
+ * may differ. The runtime replays it with extracted params (cheapest path).
1853
+ * - 'near': the script answers a STRUCTURALLY similar question but needs
1854
+ * body modification (different metric, dimension, table, filter shape).
1855
+ * The runtime forks the parent and adapts the body via MainAgent's normal
1856
+ * write_script + execute_script loop — no SourceAgent dispatch needed.
1857
+ * See backend/docs/SCRIPT-FLOW-FORK-ADAPT.md for the full design.
1858
+ * - 'none': no script is relevant; full agent flow runs.
1859
+ */
1860
+ type MatchTier = 'high' | 'near' | 'none';
1861
+ /**
1862
+ * Result from the LLM-based script matcher.
1863
+ *
1864
+ * For `tier: 'high'`, `extractedParams` carries the values to pass to the
1865
+ * existing script. For `tier: 'near'`, `gaps` and `modificationHint` describe
1866
+ * what the fork-author needs to change in the parent body.
1867
+ */
1868
+ interface ScriptMatch {
1869
+ /** The matched script recipe */
1870
+ recipe: ScriptRecipe;
1871
+ /** Match tier — see MatchTier docs */
1872
+ tier: MatchTier;
1873
+ /** Similarity score (0-1, derived from LLM tier) */
1874
+ similarity: number;
1875
+ /**
1876
+ * Legacy confidence level. Mirrors `tier === 'high'`/`'near'` for now;
1877
+ * kept so existing callers compile while we migrate to tier-based logic.
1878
+ */
1879
+ confidence: 'high' | 'medium';
1880
+ /** Parameters extracted from the user question by the LLM (tier='high') */
1881
+ extractedParams?: Record<string, any>;
1882
+ /** What the user question needs that the parent doesn't cover (tier='near') */
1883
+ gaps?: string[];
1884
+ /** One-sentence description of the change the fork-author should make (tier='near') */
1885
+ modificationHint?: string;
1886
+ /** Why the matcher made this choice (for logs and telemetry) */
1887
+ reasoning?: string;
1888
+ }
1889
+
1890
+ /**
1891
+ * ScriptRecipeStore — injected metadata backend for the script flow.
1892
+ *
1893
+ * The SDK is standalone (no DB dependency). The backend implements this
1894
+ * interface over Postgres (full-text search + atomic counters) and injects it
1895
+ * via `collections['script-recipes']`, exactly like `collections['source-embeddings']`.
1896
+ * `ScriptStore` consumes it for all METADATA operations while keeping the
1897
+ * executable body on disk as scripts-store/<fileBase>.ts.
1898
+ *
1899
+ * All metadata rows are plain JSON (no scriptBody — that lives on disk).
1900
+ * See backend/docs/SCRIPT-FLOW-SCALING-ISSUES.md (#1, #3, #7).
1901
+ */
1902
+
1903
+ /** One recipe's metadata as stored in Postgres (mirrors the script_recipes table). */
1904
+ interface ScriptRecipeMetaRow {
1905
+ id: string;
1906
+ projectId?: string | null;
1907
+ version: number;
1908
+ name: string;
1909
+ intentDescription: string;
1910
+ tags: string[] | null;
1911
+ createdFrom: string | null;
1912
+ sourceIds: string[] | null;
1913
+ tables: string[] | null;
1914
+ parameters: ScriptParameter[] | null;
1915
+ components?: ScriptComponentSpec[] | null;
1916
+ fileBase: string;
1917
+ bodyHash?: string | null;
1918
+ successCount: number;
1919
+ failureCount: number;
1920
+ lastUsed: string | null;
1921
+ parentId?: string | null;
1922
+ forkDepth?: number | null;
1923
+ forkReason?: string | null;
1924
+ status: 'draft' | 'verified' | string;
1925
+ turnId?: string | null;
1926
+ lastError?: {
1927
+ phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
1928
+ message: string;
1929
+ at: string;
1930
+ attempt: number;
1931
+ } | null;
1932
+ createdAt?: string | null;
1933
+ updatedAt?: string | null;
1934
+ }
1935
+ interface ScriptRecipeStore {
1936
+ /** FTS shortlist of healthy verified recipes for the matcher (metadata only). */
1937
+ search(params: {
1938
+ prompt: string;
1939
+ projectId?: string;
1940
+ limit?: number;
1941
+ }): Promise<ScriptRecipeMetaRow[]>;
1942
+ /** Fetch one recipe by id (any status). */
1943
+ getById(id: string): Promise<ScriptRecipeMetaRow | null>;
1944
+ /** Count healthy verified recipes (drives the "any scripts?" gate). */
1945
+ count(params?: {
1946
+ projectId?: string;
1947
+ }): Promise<number>;
1948
+ /** Insert or update a recipe row (keyed by id). */
1949
+ upsert(row: ScriptRecipeMetaRow): Promise<void>;
1950
+ /** Atomically bump counters / last-used. */
1951
+ updateStats(id: string, patch: {
1952
+ successDelta?: number;
1953
+ failureDelta?: number;
1954
+ lastUsed?: string;
1955
+ }): Promise<void>;
1956
+ /** Flip a draft to verified, applying provenance + optional fork lineage. */
1957
+ promote(id: string, patch: {
1958
+ sourceIds: string[];
1959
+ tables: string[];
1960
+ fileBase?: string;
1961
+ parentId?: string;
1962
+ forkDepth?: number;
1963
+ forkReason?: string;
1964
+ components?: ScriptComponentSpec[];
1965
+ }): Promise<ScriptRecipeMetaRow | null>;
1966
+ /** Stamp a draft's last execution error. */
1967
+ recordDraftError(id: string, err: {
1968
+ phase: string;
1969
+ message: string;
1970
+ attempt: number;
1971
+ at: string;
1972
+ }): Promise<void>;
1973
+ /** Delete a recipe row (body file removed separately). */
1974
+ remove(id: string): Promise<void>;
1975
+ /** True if `fileBase` is taken by a different recipe in this project. */
1976
+ fileBaseTaken(fileBase: string, excludeId: string, projectId?: string): Promise<boolean>;
1977
+ }
1978
+ /** Pull the injected store off the collections bag (or null if not wired). */
1979
+ declare function resolveScriptRecipeStore(collections: any): ScriptRecipeStore | null;
1980
+
1981
+ /**
1982
+ * ScriptStore — Postgres metadata + on-disk body for script recipes.
1983
+ *
1984
+ * Split of responsibilities:
1985
+ * - METADATA → injected `ScriptRecipeStore` (Postgres FTS + atomic counters),
1986
+ * resolved from `collections['script-recipes']`.
1987
+ * - BODY → scripts-store/<fileBase>.ts, editable in your IDE. Written
1988
+ * atomically (temp + rename); `bodyHash` (sha256) detects edits.
1989
+ *
1990
+ * The old "read every file every turn + send the whole catalog to the LLM"
1991
+ * matcher is gone — matching is `store.search(prompt)` (FTS shortlist). The
1992
+ * draft/verified filename dance is gone too: `status` is a DB column and the
1993
+ * file keeps a stable `<fileBase>.ts` name across promotion.
1994
+ *
1995
+ * When no metadata store is injected, the store degrades to a safe no-op
1996
+ * (count 0 → script flow disabled) instead of crashing.
1997
+ *
1998
+ * See backend/docs/SCRIPT-FLOW-SCALING-ISSUES.md.
1999
+ */
2000
+
2001
+ interface SaveDraftInput {
2002
+ /** Reuse an existing draft (retry); omit to mint a new one. */
2003
+ recipeId?: string;
2004
+ /** Per-turn unique suffix, stable across retries within the turn. */
2005
+ turnId: string;
2006
+ name: string;
2007
+ intentDescription: string;
2008
+ tags: string[];
2009
+ parameters: ScriptParameter[];
2010
+ scriptBody: string;
2011
+ createdFrom: string;
2012
+ }
2013
+ interface PromoteToVerifiedInput {
2014
+ sourceIds: string[];
2015
+ tables: string[];
2016
+ parentId?: string;
2017
+ forkDepth?: number;
2018
+ forkReason?: string;
2019
+ components?: ScriptComponentSpec[];
2020
+ }
2021
+ interface ScriptStoreOptions {
2022
+ /** Explicit metadata store, or resolved from `collections['script-recipes']`. */
2023
+ store?: ScriptRecipeStore | null;
2024
+ collections?: any;
2025
+ /** Body directory (defaults to <cwd>/scripts-store). */
2026
+ baseDir?: string;
2027
+ /** Project scope stamped on every row. */
2028
+ projectId?: string;
2029
+ }
2030
+ /**
2031
+ * Normalize a scriptBody into the on-disk form (strip a leading comment block,
2032
+ * ensure `export async function getData`). Exported for MainAgent.
2033
+ */
2034
+ declare function normalizeScriptBody(scriptBody: string): string;
2035
+ declare class ScriptStore {
2036
+ private store;
2037
+ private storeDir;
2038
+ private projectId?;
2039
+ constructor(opts?: ScriptStoreOptions);
2040
+ /** Whether a metadata store is wired (matcher / authoring are gated on this). */
2041
+ hasStore(): boolean;
2042
+ /** Number of healthy verified recipes (gates the script-matching path). */
2043
+ count(): Promise<number>;
2044
+ /**
2045
+ * FTS shortlist for the matcher (metadata only — bodies are loaded lazily by
2046
+ * `get()` once the LLM picks one). Returns verified, healthy recipes ranked
2047
+ * by relevance.
2048
+ */
2049
+ search(prompt: string, limit?: number): Promise<ScriptRecipe[]>;
2050
+ /** Fetch one recipe by id with its body loaded from disk. */
2051
+ get(id: string): Promise<ScriptRecipe | null>;
2052
+ /** Create or update a recipe (metadata upsert + body write when changed). */
2053
+ save(recipe: ScriptRecipe): Promise<void>;
2054
+ /**
2055
+ * Persist (or update) a draft. Within a turn, retries that pass the same
2056
+ * `recipeId` overwrite the same row + file; a fresh `recipeId` mints a new
2057
+ * draft. The body is visible at scripts-store/<fileBase>.ts immediately.
2058
+ */
2059
+ saveDraft(input: SaveDraftInput): Promise<ScriptRecipe>;
2060
+ /** Stamp a draft's last execution error (metadata only). */
2061
+ recordDraftError(recipeId: string, err: {
2062
+ phase: 'compile' | 'runtime' | 'timeout' | 'ipc';
2063
+ message: string;
2064
+ attempt: number;
2065
+ }): Promise<void>;
2066
+ /**
2067
+ * Promote a successfully-executed draft into a verified script.
2068
+ * The on-disk body already exists at <fileBase>.ts (written at write_script
2069
+ * time) and keeps its name — only the DB row flips status + provenance.
2070
+ */
2071
+ promoteToVerified(recipeId: string, input: PromoteToVerifiedInput): Promise<ScriptRecipe | null>;
2072
+ /**
2073
+ * Drop a draft (row + body file). MainAgent calls this at end-of-turn when a
2074
+ * draft was authored but never verified — failed drafts are never matched, so
2075
+ * deleting them immediately avoids unbounded accumulation (#5). No-op if the
2076
+ * recipe isn't a draft (so a promoted/verified script is never removed here).
2077
+ */
2078
+ discardDraft(recipeId: string): Promise<void>;
2079
+ /** Delete a recipe (row + body file). */
2080
+ delete(id: string): Promise<void>;
2081
+ /** Record a successful execution (atomic counter bump). */
2082
+ recordSuccess(id: string): Promise<void>;
2083
+ /** Record a failed execution (atomic counter bump). */
2084
+ recordFailure(id: string): Promise<void>;
2085
+ /** Absolute path to the .ts body for a recipe (used by the runner/MainAgent). */
2086
+ getScriptPath(recipe: ScriptRecipe): string;
2087
+ private removeById;
2088
+ private rowToRecipe;
2089
+ private recipeToRow;
2090
+ /** slug of name, with a short id suffix when the bare slug is already taken. */
2091
+ private computeFileBase;
2092
+ private toSlug;
2093
+ private hash;
2094
+ private bodyPath;
2095
+ private readBody;
2096
+ /** Atomic body write (temp + rename) so concurrent reads never see a partial file. */
2097
+ private writeBody;
2098
+ private unlinkBody;
2099
+ }
2100
+
2101
+ /**
2102
+ * Main Agent (Orchestrator)
2103
+ *
2104
+ * A single LLM.streamWithTools() call that handles everything:
2105
+ * - Routing: decides which source(s) to query based on summaries
2106
+ * - Querying: calls source tools (each wraps an independent SourceAgent)
2107
+ * - Direct tools: calls pre-built function tools directly with LLM-provided params
2108
+ * - Re-querying: if data is wrong/incomplete, calls tools again with modified intent
2109
+ * - Analysis: generates final text response from the data
2110
+ *
2111
+ * Two tool types:
2112
+ * - "source" tools: main agent sees summaries, SourceAgent handles SQL generation independently
2113
+ * - "direct" tools: main agent calls fn() directly with structured params (no SourceAgent)
2114
+ */
2115
+
2116
+ declare class MainAgent {
2117
+ private externalTools;
2118
+ private workflows;
2119
+ private config;
2120
+ private streamBuffer;
2121
+ /**
2122
+ * Optional: when provided, MainAgent exposes the `write_script` /
2123
+ * `execute_script` tools to the LLM and persists drafts to disk via the
2124
+ * store. Headless callers (alert analyzer, metric resolver) omit these to
2125
+ * suppress script authoring entirely — drafts would otherwise leak onto
2126
+ * disk with no caller to promote or clean them up.
2127
+ */
2128
+ private scriptStore;
2129
+ private turnId;
2130
+ private createdFromPrompt;
2131
+ private scriptState;
2132
+ /**
2133
+ * Fork mode — set when this turn is adapting a near-matching parent script.
2134
+ * In fork mode there is no legitimate "answer with bare text" outcome: the
2135
+ * only correct first move is a tool call (write_script, or a source tool for
2136
+ * schema discovery). We therefore force tool use on the first LLM iteration
2137
+ * so the model can't end its turn with a bare "I'll adapt…" preamble and zero
2138
+ * tool calls. Never set on the fresh-authoring / general-question path.
2139
+ */
2140
+ private forkMode;
2141
+ /**
2142
+ * Per-turn cancellation signal (user hit "Stop"). Set at the top of
2143
+ * handleQuestion and read by the tool handler, the SourceAgent dispatch, and
2144
+ * the script subprocess so an abort tears down every layer of the turn.
2145
+ */
2146
+ private abortSignal?;
2147
+ constructor(externalTools: ExternalTool[], config: AgentConfig, scriptStore?: ScriptStore, turnId?: string, streamBuffer?: StreamBuffer, workflows?: WorkflowDescriptor[], forkMode?: boolean);
2148
+ private get scriptingEnabled();
2149
+ /**
2150
+ * Handle a user question using the multi-agent system.
2151
+ *
2152
+ * This is ONE LLM.streamWithTools() call. The LLM:
2153
+ * 1. Sees source summaries + direct tool descriptions in system prompt
2154
+ * 2. Decides which tool(s) to call (routing)
2155
+ * 3. Source tools → SourceAgent runs independently → returns data
2156
+ * 4. Direct tools → fn() called directly with LLM params → returns data
2157
+ * 5. Generates final analysis text
2158
+ */
2159
+ handleQuestion(userPrompt: string, apiKey?: string, conversationHistory?: string, streamCallback?: (chunk: string) => void, signal?: AbortSignal): Promise<AgentResponse>;
2160
+ private handleWriteScript;
2161
+ private handleExecuteScript;
2162
+ /**
2163
+ * Build the AgentWrittenScript payload the caller will hand to
2164
+ * `ScriptStore.promoteToVerified()`. Only returned when a verified
2165
+ * successful execution is on record.
2166
+ */
2167
+ private buildSavedScript;
2168
+ private normalizeParameterList;
2169
+ /**
2170
+ * Use the schema embedding collection to pre-select relevant tables for
2171
+ * this source + intent. Returns a formatted schema block if confidence is
2172
+ * high (top match ≥ 0.55 and ≥3 candidates), otherwise null.
2173
+ *
2174
+ * When this returns a block, we can skip the SourceAgent's `search_schema`
2175
+ * loop and reduce iteration budget. When it returns null, the SourceAgent
2176
+ * falls back to the existing LLM-driven keyword search (same as today).
2177
+ */
2178
+ private preResolveSchema;
2179
+ /**
2180
+ * Execute a direct tool — call fn() with LLM-provided params, no SourceAgent.
2181
+ */
2182
+ private handleDirectTool;
2183
+ /**
2184
+ * Build the main agent's system prompt with source summaries, direct tool descriptions,
2185
+ * and workflow component descriptions.
2186
+ */
2187
+ private buildSystemPrompt;
2188
+ /**
2189
+ * Build tool definitions for source tools — summary-only descriptions.
2190
+ * The full schema is inside the SourceAgent which runs independently.
2191
+ */
2192
+ private buildSourceToolDefinitions;
2193
+ /**
2194
+ * Build tool definitions for direct tools — expose their actual params.
2195
+ * These are called directly by the main agent LLM, no SourceAgent.
2196
+ */
2197
+ private buildDirectToolDefinitions;
2198
+ /**
2199
+ * Capture a workflow selection. We do NOT execute anything — the LLM has
2200
+ * already extracted the props it wants the workflow rendered with. We
2201
+ * record the selection (via the capture callback) and return a short
2202
+ * acknowledgement so the LLM ends its turn cleanly without writing
2203
+ * analysis text or calling more tools.
2204
+ */
2205
+ private handleWorkflow;
2206
+ /**
2207
+ * Build LLM tool definitions for workflow components. The workflow's
2208
+ * propsSchema becomes the tool's input_schema so the LLM extracts props
2209
+ * directly from the prompt — same mechanic as direct tools.
2210
+ */
2211
+ private buildWorkflowToolDefinitions;
2212
+ /**
2213
+ * Format a source agent's result as a clean string for the main agent LLM.
2214
+ */
2215
+ private formatResultForMainAgent;
2216
+ /**
2217
+ * Get source summaries (for external inspection/debugging).
2218
+ */
2219
+ getSourceSummaries(): SourceSummary[];
2220
+ }
2221
+
2222
+ /**
2223
+ * Represents an action that can be performed on a UIBlock
2224
+ */
2225
+ interface Action {
2226
+ id: string;
2227
+ name: string;
2228
+ type: string;
2229
+ [key: string]: any;
2230
+ }
2231
+
2232
+ type SystemPrompt = string | Anthropic.Messages.TextBlockParam[];
2233
+ interface LLMMessages {
2234
+ sys: SystemPrompt;
2235
+ user: string;
2236
+ prefill?: string;
2237
+ }
2238
+ interface LLMOptions {
2239
+ model?: string;
2240
+ maxTokens?: number;
2241
+ temperature?: number;
2242
+ topP?: number;
2243
+ apiKey?: string;
2244
+ baseURL?: string;
2245
+ partial?: (chunk: string) => void;
2246
+ /**
2247
+ * Per-request cancellation. When the caller aborts this signal (user hit
2248
+ * "Stop"), the underlying provider request is cancelled and the call throws
2249
+ * a RequestAbortedError. Threaded into the provider `messages.create` request
2250
+ * options and checked between tool-loop iterations. Currently honored on the
2251
+ * Anthropic path (the agent flow's default provider).
2252
+ */
2253
+ signal?: AbortSignal;
2254
+ /**
2255
+ * Forces a tool call on the FIRST iteration of streamWithTools only
2256
+ * (subsequent iterations revert to auto). Used by fork mode to stop the
2257
+ * model from ending its turn with a bare "I'll adapt the script…" preamble
2258
+ * and zero tool calls. `{ type: 'any' }` lets the model pick which tool
2259
+ * (write_script in the common case, a source tool for schema discovery);
2260
+ * `{ type: 'tool', name }` pins a specific tool. Honored on both the
2261
+ * Anthropic path and the OpenAI/OpenRouter path (mapped to OpenAI's
2262
+ * tool_choice: 'required' / a named function).
2263
+ */
2264
+ firstIterationToolChoice?: {
2265
+ type: 'any';
2266
+ } | {
2267
+ type: 'tool';
2268
+ name: string;
2269
+ };
2270
+ /**
2271
+ * Internal — set only by the OpenRouter wrappers when the target is a Claude
2272
+ * model. Tells the OpenAI-wire path to emit Anthropic `cache_control`
2273
+ * breakpoints (OpenRouter forwards them to Anthropic for prompt caching).
2274
+ * Never set for direct OpenAI/Groq calls, so their requests are unchanged.
2275
+ */
2276
+ _openrouterClaudeCaching?: boolean;
2277
+ /**
2278
+ * Internal — OpenRouter provider-routing preferences (forwarded as the
2279
+ * `provider` body field). Set by the OpenRouter wrappers to steer routing to
2280
+ * a fast backend (e.g. {sort:'throughput'}). Never set for direct OpenAI/Groq.
2281
+ */
2282
+ _openrouterProvider?: Record<string, unknown>;
2283
+ }
2284
+ interface Tool {
2285
+ name: string;
2286
+ description: string;
2287
+ input_schema: {
2288
+ type: string;
2289
+ properties: Record<string, any>;
2290
+ required?: string[];
2291
+ };
2292
+ }
2293
+ declare class LLM {
2294
+ static text(messages: LLMMessages, options?: LLMOptions): Promise<string>;
2295
+ static stream<T = string>(messages: LLMMessages, options?: LLMOptions, json?: boolean): Promise<T extends string ? string : any>;
2296
+ static streamWithTools(messages: LLMMessages, tools: Tool[], toolHandler: (toolName: string, toolInput: any) => Promise<any>, options?: LLMOptions, maxIterations?: number): Promise<string>;
2297
+ /**
2298
+ * Normalize system prompt to Anthropic format
2299
+ * Converts string to array format if needed
2300
+ * @param sys - System prompt (string or array of blocks)
2301
+ * @returns Normalized system prompt for Anthropic API
2302
+ */
2303
+ private static _normalizeSystemPrompt;
2304
+ /**
2305
+ * Strip unpaired UTF-16 surrogates from every text field of a message set.
2306
+ *
2307
+ * A lone surrogate (from mid-pair string slicing or corrupt source data)
2308
+ * serializes to a bare `\udXXX` escape that strict JSON parsers — including
2309
+ * the one on Anthropic's API — reject with "no low surrogate in string",
2310
+ * failing the whole request. Sanitizing here, at the single boundary every
2311
+ * provider call flows through, guarantees no request can carry one.
2312
+ */
2313
+ private static _sanitizeMessages;
2314
+ /**
2315
+ * Log cache usage metrics from Anthropic API response
2316
+ * Shows cache hits, costs, and savings
2317
+ */
2318
+ private static _logCacheUsage;
2319
+ /**
2320
+ * Parse model string to extract provider and model name
2321
+ * @param modelString - Format: "provider/model-name" or just "model-name"
2322
+ * @returns [provider, modelName]
2323
+ *
2324
+ * @example
2325
+ * "anthropic/claude-sonnet-4-5" → ["anthropic", "claude-sonnet-4-5"]
2326
+ * "groq/openai/gpt-oss-120b" → ["groq", "openai/gpt-oss-120b"]
2327
+ * "claude-sonnet-4-5" → ["anthropic", "claude-sonnet-4-5"] (default)
2328
+ */
2329
+ private static _parseModel;
2330
+ /**
2331
+ * Map an Anthropic model id (e.g. "claude-sonnet-4-5-20250929") to the OpenRouter slug
2332
+ * (e.g. "claude-sonnet-4.5"). OpenRouter slugs drop the date suffix and use dotted versions.
2333
+ */
2334
+ private static _toOpenRouterSlug;
2335
+ /**
2336
+ * Per-provider proxy base URL. Returns `${SUPERATOM_LLM_PROXY_URL}/<provider>`
2337
+ * when our Cloudflare LLM proxy is configured, else undefined (→ talk to the
2338
+ * provider directly, legacy behaviour). An explicit options.baseURL (e.g.
2339
+ * OpenRouter) always wins and is never overridden. See backend/docs/llm-proxy.md.
2340
+ */
2341
+ private static _proxyBaseURL;
2342
+ private static _openrouterOptions;
2343
+ private static _openrouterText;
2344
+ private static _openrouterStream;
2345
+ private static _openrouterStreamWithTools;
2346
+ /**
2347
+ * Build an Anthropic client. Routes through our Cloudflare LLM proxy when
2348
+ * SUPERATOM_LLM_PROXY_URL is set (each client ships a per-client proxy key as
2349
+ * ANTHROPIC_API_KEY and never holds the real key); otherwise talks to
2350
+ * api.anthropic.com directly. See backend/docs/llm-proxy.md.
2351
+ */
2352
+ private static _anthropicClient;
2353
+ /** True when OpenRouter is configured as a fail-open fallback for Claude. */
2354
+ private static _openrouterAvailable;
2355
+ /** Remap an Anthropic model id to the OpenRouter model path for fail-open. */
2356
+ private static _anthropicFallbackModel;
2357
+ private static _anthropicText;
2358
+ private static _anthropicStream;
2359
+ private static _anthropicStreamWithTools;
2360
+ private static _groqText;
2361
+ private static _groqStream;
2362
+ /**
2363
+ * Gemini request options carrying the proxy base URL, or undefined → talk to
2364
+ * generativelanguage.googleapis.com directly. The Google SDK takes baseUrl as a
2365
+ * per-model request option, not a constructor arg. See backend/docs/llm-proxy.md.
2366
+ */
2367
+ private static _geminiRequestOptions;
2368
+ private static _geminiText;
2369
+ private static _geminiStream;
2370
+ /**
2371
+ * Recursively strip unsupported JSON Schema properties for Gemini
2372
+ * Gemini doesn't support: additionalProperties, $schema, etc.
2373
+ */
2374
+ private static _cleanSchemaForGemini;
2375
+ private static _geminiStreamWithTools;
2376
+ /** True for Anthropic/Claude model ids — gates OpenRouter prompt caching. */
2377
+ private static _isClaudeModel;
2378
+ /**
2379
+ * Build the OpenAI-wire system message. For OpenRouter + Claude
2380
+ * (cacheClaude=true) it emits content parts carrying Anthropic
2381
+ * `cache_control` breakpoints (preserving any the caller set, else marking
2382
+ * the last block), so OpenRouter forwards them to Anthropic for prompt
2383
+ * caching. Otherwise it returns a plain flattened string — unchanged for
2384
+ * direct OpenAI/Groq.
2385
+ */
2386
+ private static _openaiSystemMessage;
2387
+ /**
2388
+ * Split an OpenAI-wire usage object. `prompt_tokens` INCLUDES cached tokens,
2389
+ * so we subtract them out (Anthropic-style: input excludes cache reads) and
2390
+ * report cached separately — this makes calculateCost price cache reads at
2391
+ * the discounted rate and reflects OpenRouter prompt-cache savings in logs.
2392
+ */
2393
+ private static _openaiUsage;
2394
+ private static _openaiText;
2395
+ private static _openaiStream;
2396
+ /** Map the Anthropic-style firstIterationToolChoice to OpenAI's tool_choice. */
2397
+ private static _openaiToolChoice;
2398
+ private static _openaiStreamWithTools;
2399
+ /**
2400
+ * Parse JSON string, handling markdown code blocks and surrounding text
2401
+ * Enhanced version with jsonrepair to handle malformed JSON from LLMs
2402
+ * @param text - Text that may contain JSON wrapped in ```json...``` or with surrounding text
2403
+ * @returns Parsed JSON object or array
2404
+ */
2405
+ private static _parseJSON;
2406
+ }
2407
+
2408
+ interface CapturedLog {
2409
+ timestamp: number;
2410
+ level: 'info' | 'error' | 'warn' | 'debug';
2411
+ message: string;
2412
+ type?: 'explanation' | 'query' | 'general';
2413
+ data?: Record<string, any>;
2414
+ }
2415
+ /**
2416
+ * UILogCollector captures logs during user prompt processing
2417
+ * and sends them to runtime via ui_logs message with uiBlockId as the message id
2418
+ * Logs are sent in real-time for streaming effect in the UI
2419
+ * Respects the global log level configuration
2420
+ */
2421
+ declare class UILogCollector {
2422
+ private logs;
2423
+ private uiBlockId;
2424
+ private clientId;
2425
+ private sendMessage;
2426
+ private currentLogLevel;
2427
+ constructor(clientId: string, sendMessage: (message: Message) => void, uiBlockId?: string);
2428
+ /**
2429
+ * Check if logging is enabled (uiBlockId is provided)
2430
+ */
2431
+ isEnabled(): boolean;
2432
+ /**
2433
+ * Check if a message should be logged based on current log level
2434
+ */
2435
+ private shouldLog;
2436
+ /**
2437
+ * Add a log entry with timestamp and immediately send to runtime
2438
+ * Only logs that pass the log level filter are captured and sent
2439
+ */
2440
+ private addLog;
2441
+ /**
2442
+ * Send a single log to runtime immediately
942
2443
  */
943
2444
  private sendLogImmediately;
944
2445
  /**
@@ -983,16 +2484,6 @@ declare class UILogCollector {
983
2484
  setUIBlockId(uiBlockId: string): void;
984
2485
  }
985
2486
 
986
- /**
987
- * Represents an action that can be performed on a UIBlock
988
- */
989
- interface Action {
990
- id: string;
991
- name: string;
992
- type: string;
993
- [key: string]: any;
994
- }
995
-
996
2487
  /**
997
2488
  * UIBlock represents a single user and assistant message block in a thread
998
2489
  * Contains user question, component metadata, component data, text response, and available actions
@@ -1175,12 +2666,20 @@ declare class Thread {
1175
2666
 
1176
2667
  /**
1177
2668
  * ThreadManager manages all threads globally
1178
- * Provides methods to create, retrieve, and delete threads
2669
+ * Provides methods to create, retrieve, and delete threads.
2670
+ * Includes automatic cleanup to prevent unbounded memory growth.
1179
2671
  */
1180
2672
  declare class ThreadManager {
1181
2673
  private static instance;
1182
2674
  private threads;
2675
+ private cleanupInterval;
2676
+ private readonly threadTtlMs;
1183
2677
  private constructor();
2678
+ /**
2679
+ * Periodically remove threads older than 7 days.
2680
+ * Runs every hour to avoid frequent iteration over the map.
2681
+ */
2682
+ private startCleanup;
1184
2683
  /**
1185
2684
  * Get singleton instance of ThreadManager
1186
2685
  */
@@ -1310,15 +2809,17 @@ declare const STORAGE_CONFIG: {
1310
2809
  */
1311
2810
  MAX_ROWS_PER_BLOCK: number;
1312
2811
  /**
1313
- * Maximum size in bytes per UIBlock (1MB)
2812
+ * Maximum size in bytes per UIBlock (500KB - reduced to save memory)
1314
2813
  */
1315
2814
  MAX_SIZE_PER_BLOCK_BYTES: number;
1316
2815
  /**
1317
2816
  * Number of days to keep threads before cleanup
2817
+ * Note: This is for in-memory storage. Conversations are also persisted to database.
1318
2818
  */
1319
2819
  THREAD_RETENTION_DAYS: number;
1320
2820
  /**
1321
2821
  * Number of days to keep UIBlocks before cleanup
2822
+ * Note: This is for in-memory storage. Data is also persisted to database.
1322
2823
  */
1323
2824
  UIBLOCK_RETENTION_DAYS: number;
1324
2825
  };
@@ -1335,30 +2836,879 @@ declare const CONTEXT_CONFIG: {
1335
2836
  MAX_CONVERSATION_CONTEXT_BLOCKS: number;
1336
2837
  };
1337
2838
 
1338
- declare const SDK_VERSION = "0.0.8";
1339
- type MessageTypeHandler = (message: IncomingMessage) => void | Promise<void>;
1340
- declare class SuperatomSDK {
1341
- private ws;
1342
- private url;
1343
- private apiKey;
1344
- private projectId;
1345
- private userId;
1346
- private type;
1347
- private bundleDir;
1348
- private messageHandlers;
1349
- private messageTypeHandlers;
1350
- private connected;
1351
- private reconnectAttempts;
1352
- private maxReconnectAttempts;
1353
- private collections;
1354
- private components;
1355
- private tools;
1356
- private anthropicApiKey;
1357
- private groqApiKey;
1358
- private llmProviders;
2839
+ /**
2840
+ * LLM Usage Logger - Tracks token usage, costs, and timing for all LLM API calls
2841
+ */
2842
+ interface LLMUsageEntry {
2843
+ timestamp: string;
2844
+ requestId: string;
2845
+ provider: string;
2846
+ model: string;
2847
+ method: string;
2848
+ inputTokens: number;
2849
+ outputTokens: number;
2850
+ cacheReadTokens?: number;
2851
+ cacheWriteTokens?: number;
2852
+ totalTokens: number;
2853
+ costUSD: number;
2854
+ durationMs: number;
2855
+ toolCalls?: number;
2856
+ success: boolean;
2857
+ error?: string;
2858
+ }
2859
+ declare class LLMUsageLogger {
2860
+ private logStream;
2861
+ private logPath;
2862
+ private enabled;
2863
+ private sessionStats;
2864
+ constructor();
2865
+ private initLogStream;
2866
+ private writeHeader;
2867
+ /**
2868
+ * Calculate cost based on token usage and model
2869
+ */
2870
+ calculateCost(model: string, inputTokens: number, outputTokens: number, cacheReadTokens?: number, cacheWriteTokens?: number): number;
2871
+ /**
2872
+ * Log an LLM API call
2873
+ */
2874
+ log(entry: LLMUsageEntry): void;
2875
+ /**
2876
+ * Log session summary (call at end of request)
2877
+ */
2878
+ logSessionSummary(requestContext?: string): void;
2879
+ /**
2880
+ * Reset session stats (call at start of new user request)
2881
+ */
2882
+ resetSession(): void;
2883
+ /**
2884
+ * Reset the log file for a new request (clears previous logs)
2885
+ * Call this at the start of each USER_PROMPT_REQ
2886
+ */
2887
+ resetLogFile(requestContext?: string): void;
2888
+ /**
2889
+ * Get current session stats
2890
+ */
2891
+ getSessionStats(): {
2892
+ totalCalls: number;
2893
+ totalInputTokens: number;
2894
+ totalOutputTokens: number;
2895
+ totalCacheReadTokens: number;
2896
+ totalCacheWriteTokens: number;
2897
+ totalCostUSD: number;
2898
+ totalDurationMs: number;
2899
+ };
2900
+ /**
2901
+ * Generate a unique request ID
2902
+ */
2903
+ generateRequestId(): string;
2904
+ }
2905
+ declare const llmUsageLogger: LLMUsageLogger;
2906
+
2907
+ /**
2908
+ * User Prompt Error Logger - Captures detailed errors for USER_PROMPT_REQ
2909
+ * Logs full error details including raw strings for parse failures
2910
+ */
2911
+ declare class UserPromptErrorLogger {
2912
+ private logStream;
2913
+ private logPath;
2914
+ private enabled;
2915
+ private hasErrors;
2916
+ constructor();
2917
+ /**
2918
+ * Reset the error log file for a new request
2919
+ */
2920
+ resetLogFile(requestContext?: string): void;
2921
+ /**
2922
+ * Log a JSON parse error with the raw string that failed
2923
+ */
2924
+ logJsonParseError(context: string, rawString: string, error: Error): void;
2925
+ /**
2926
+ * Log a general error with full details
2927
+ */
2928
+ logError(context: string, error: Error | string, additionalData?: Record<string, any>): void;
2929
+ /**
2930
+ * Log a SQL query error with the full query
2931
+ */
2932
+ logSqlError(query: string, error: Error | string, params?: any[]): void;
2933
+ /**
2934
+ * Log an LLM API error
2935
+ */
2936
+ logLlmError(provider: string, model: string, method: string, error: Error | string, requestData?: any): void;
2937
+ /**
2938
+ * Log tool execution error
2939
+ */
2940
+ logToolError(toolName: string, toolInput: any, error: Error | string): void;
2941
+ /**
2942
+ * Write final summary if there were errors
2943
+ */
2944
+ writeSummary(): void;
2945
+ /**
2946
+ * Check if any errors were logged
2947
+ */
2948
+ hadErrors(): boolean;
2949
+ private write;
2950
+ }
2951
+ declare const userPromptErrorLogger: UserPromptErrorLogger;
2952
+
2953
+ /**
2954
+ * BM25L Reranker for hybrid semantic search
2955
+ *
2956
+ * BM25L is an improved variant of BM25 that provides better handling of
2957
+ * long documents and term frequency saturation. This implementation is
2958
+ * designed to rerank semantic search results from ChromaDB.
2959
+ *
2960
+ * The hybrid approach combines:
2961
+ * 1. Semantic similarity from ChromaDB embeddings (dense vectors)
2962
+ * 2. Lexical matching from BM25L (sparse, keyword-based)
2963
+ *
2964
+ * This addresses the weakness of pure semantic search which may miss
2965
+ * exact keyword matches that are important for user intent.
2966
+ */
2967
+ interface BM25LOptions {
2968
+ /** Term frequency saturation parameter (default: 1.5) */
2969
+ k1?: number;
2970
+ /** Length normalization parameter (default: 0.75) */
2971
+ b?: number;
2972
+ /** Lower-bound adjustment from BM25L paper (default: 0.5) */
2973
+ delta?: number;
2974
+ }
2975
+ interface RerankedResult<T> {
2976
+ item: T;
2977
+ originalIndex: number;
2978
+ semanticScore: number;
2979
+ bm25Score: number;
2980
+ hybridScore: number;
2981
+ }
2982
+ interface HybridSearchOptions extends BM25LOptions {
2983
+ /** Weight for semantic score (0-1, default: 0.7) */
2984
+ semanticWeight?: number;
2985
+ /** Weight for BM25 score (0-1, default: 0.3) */
2986
+ bm25Weight?: number;
2987
+ /** Minimum hybrid score threshold (0-1, default: 0) */
2988
+ minScore?: number;
2989
+ }
2990
+ /**
2991
+ * BM25L implementation for lexical scoring
2992
+ */
2993
+ declare class BM25L {
2994
+ private k1;
2995
+ private b;
2996
+ private delta;
2997
+ private documents;
2998
+ private docLengths;
2999
+ private avgDocLength;
3000
+ private termDocFreq;
3001
+ /**
3002
+ * @param documents - Array of raw documents (strings)
3003
+ * @param opts - Optional BM25L parameters
3004
+ */
3005
+ constructor(documents?: string[], opts?: BM25LOptions);
3006
+ /**
3007
+ * Tokenize text into lowercase alphanumeric tokens
3008
+ */
3009
+ tokenize(text: string): string[];
3010
+ /**
3011
+ * Compute IDF (Inverse Document Frequency) with smoothing
3012
+ */
3013
+ private idf;
3014
+ /**
3015
+ * Compute BM25L score for a single document
3016
+ */
3017
+ score(query: string, docIndex: number): number;
3018
+ /**
3019
+ * Search and rank all documents
3020
+ */
3021
+ search(query: string): Array<{
3022
+ index: number;
3023
+ score: number;
3024
+ }>;
3025
+ }
3026
+ /**
3027
+ * Hybrid reranker that combines semantic and BM25L scores
3028
+ *
3029
+ * @param query - The search query
3030
+ * @param items - Array of items to rerank
3031
+ * @param getDocument - Function to extract document text from an item
3032
+ * @param getSemanticScore - Function to extract semantic similarity score from an item
3033
+ * @param options - Hybrid search options
3034
+ * @returns Reranked items with hybrid scores
3035
+ */
3036
+ declare function hybridRerank<T>(query: string, items: T[], getDocument: (item: T) => string, getSemanticScore: (item: T) => number, options?: HybridSearchOptions): RerankedResult<T>[];
3037
+ /**
3038
+ * Simple reranking function for ChromaDB results
3039
+ *
3040
+ * This is a convenience wrapper for reranking ChromaDB query results
3041
+ * that follow the standard { ids, documents, metadatas, distances } format.
3042
+ *
3043
+ * @param query - The search query
3044
+ * @param chromaResults - ChromaDB query results
3045
+ * @param options - Hybrid search options
3046
+ * @returns Reranked results with hybrid scores
3047
+ */
3048
+ declare function rerankChromaResults(query: string, chromaResults: {
3049
+ ids: string[][];
3050
+ documents: (string | null)[][];
3051
+ metadatas: Record<string, any>[][];
3052
+ distances: number[][];
3053
+ }, options?: HybridSearchOptions): Array<{
3054
+ id: string;
3055
+ document: string | null;
3056
+ metadata: Record<string, any>;
3057
+ distance: number;
3058
+ semanticScore: number;
3059
+ bm25Score: number;
3060
+ hybridScore: number;
3061
+ }>;
3062
+ /**
3063
+ * Rerank conversation search results specifically
3064
+ *
3065
+ * This function is designed to work with the conversation-history.search collection
3066
+ * where we need to fetch more results initially and then rerank them.
3067
+ *
3068
+ * @param query - The user's search query
3069
+ * @param results - Array of conversation search results from ChromaDB
3070
+ * @param options - Hybrid search options
3071
+ * @returns Reranked results sorted by hybrid score
3072
+ */
3073
+ declare function rerankConversationResults<T extends {
3074
+ userPrompt?: string;
3075
+ similarity?: number;
3076
+ }>(query: string, results: T[], options?: HybridSearchOptions): Array<T & {
3077
+ hybridScore: number;
3078
+ bm25Score: number;
3079
+ }>;
3080
+
3081
+ /**
3082
+ * QueryExecutionService - Handles all query execution, validation, and retry logic
3083
+ * Extracted from BaseLLM for better separation of concerns
3084
+ */
3085
+
3086
+ /**
3087
+ * Context for component when requesting query fix
3088
+ */
3089
+ interface ComponentContext {
3090
+ name: string;
3091
+ type: string;
3092
+ title?: string;
3093
+ }
3094
+ /**
3095
+ * Result of query validation
3096
+ */
3097
+ interface QueryValidationResult {
3098
+ component: Component | null;
3099
+ queryKey: string;
3100
+ result: any;
3101
+ validated: boolean;
3102
+ }
3103
+ /**
3104
+ * Result of batch query validation
3105
+ */
3106
+ interface BatchValidationResult {
3107
+ components: Component[];
3108
+ queryResults: Map<string, any>;
3109
+ }
3110
+ /**
3111
+ * Configuration for QueryExecutionService
3112
+ */
3113
+ interface QueryExecutionServiceConfig {
3114
+ defaultLimit: number;
3115
+ getModelForTask: (taskType: 'simple' | 'complex') => string;
3116
+ getApiKey: (apiKey?: string) => string | undefined;
3117
+ providerName: string;
3118
+ }
3119
+ /**
3120
+ * QueryExecutionService handles all query-related operations
3121
+ */
3122
+ declare class QueryExecutionService {
3123
+ private config;
3124
+ constructor(config: QueryExecutionServiceConfig);
3125
+ /**
3126
+ * Get the cache key for a query
3127
+ * This ensures the cache key matches what the frontend will send
3128
+ */
3129
+ getQueryCacheKey(query: any): string;
3130
+ /**
3131
+ * Execute a query against the database
3132
+ * @param query - The SQL query to execute (string or object with sql/values)
3133
+ * @param collections - Collections object containing database execute function
3134
+ * @returns Object with result data and cache key
3135
+ */
3136
+ executeQuery(query: any, collections: any): Promise<{
3137
+ result: any;
3138
+ cacheKey: string;
3139
+ }>;
3140
+ /**
3141
+ * Request the LLM to fix a failed SQL query
3142
+ * @param failedQuery - The query that failed execution
3143
+ * @param errorMessage - The error message from the failed execution
3144
+ * @param componentContext - Context about the component
3145
+ * @param apiKey - Optional API key
3146
+ * @returns Fixed query string
3147
+ */
3148
+ requestQueryFix(failedQuery: string, errorMessage: string, componentContext: ComponentContext, apiKey?: string): Promise<string>;
3149
+ /**
3150
+ * Validate a single component's query with retry logic
3151
+ * @param component - The component to validate
3152
+ * @param collections - Collections object containing database execute function
3153
+ * @param apiKey - Optional API key for LLM calls
3154
+ * @returns Validation result with component, query key, and result
3155
+ */
3156
+ validateSingleQuery(component: Component, collections: any, apiKey?: string): Promise<QueryValidationResult>;
3157
+ /**
3158
+ * Validate multiple component queries in parallel
3159
+ * @param components - Array of components with potential queries
3160
+ * @param collections - Collections object containing database execute function
3161
+ * @param apiKey - Optional API key for LLM calls
3162
+ * @returns Object with validated components and query results map
3163
+ */
3164
+ validateComponentQueries(components: Component[], collections: any, apiKey?: string): Promise<BatchValidationResult>;
3165
+ }
3166
+
3167
+ /**
3168
+ * Task types for model selection
3169
+ * - 'complex': Text generation, component matching, parameter adaptation (uses best model in balanced mode)
3170
+ * - 'simple': Classification, action generation (uses fast model in balanced mode)
3171
+ */
3172
+ type TaskType = 'complex' | 'simple';
3173
+ interface BaseLLMConfig {
3174
+ model?: string;
3175
+ fastModel?: string;
3176
+ defaultLimit?: number;
3177
+ apiKey?: string;
3178
+ /**
3179
+ * Model selection strategy:
3180
+ * - 'best': Use best model for all tasks (highest quality, higher cost)
3181
+ * - 'fast': Use fast model for all tasks (lower quality, lower cost)
3182
+ * - 'balanced': Use best model for complex tasks, fast model for simple tasks (default)
3183
+ */
3184
+ modelStrategy?: ModelStrategy;
3185
+ conversationSimilarityThreshold?: number;
3186
+ }
3187
+ /**
3188
+ * BaseLLM abstract class for AI-powered component generation and matching
3189
+ * Provides common functionality for all LLM providers
3190
+ */
3191
+ declare abstract class BaseLLM {
3192
+ protected model: string;
3193
+ protected fastModel: string;
3194
+ protected defaultLimit: number;
3195
+ protected apiKey?: string;
3196
+ protected modelStrategy: ModelStrategy;
3197
+ protected conversationSimilarityThreshold: number;
3198
+ protected queryService: QueryExecutionService;
3199
+ constructor(config?: BaseLLMConfig);
3200
+ /**
3201
+ * Get the appropriate model based on task type and model strategy
3202
+ * @param taskType - 'complex' for text generation/matching, 'simple' for classification/actions
3203
+ * @returns The model string to use for this task
3204
+ */
3205
+ protected getModelForTask(taskType: TaskType): string;
3206
+ /**
3207
+ * Set the model strategy at runtime
3208
+ * @param strategy - 'best', 'fast', or 'balanced'
3209
+ */
3210
+ setModelStrategy(strategy: ModelStrategy): void;
3211
+ /**
3212
+ * Get the current model strategy
3213
+ * @returns The current model strategy
3214
+ */
3215
+ getModelStrategy(): ModelStrategy;
3216
+ /**
3217
+ * Set the conversation similarity threshold at runtime
3218
+ * @param threshold - Value between 0 and 1 (e.g., 0.8 = 80% similarity required)
3219
+ */
3220
+ setConversationSimilarityThreshold(threshold: number): void;
3221
+ /**
3222
+ * Get the current conversation similarity threshold
3223
+ * @returns The current threshold value
3224
+ */
3225
+ getConversationSimilarityThreshold(): number;
3226
+ /**
3227
+ * Get the default model for this provider (used for complex tasks like text generation)
3228
+ */
3229
+ protected abstract getDefaultModel(): string;
3230
+ /**
3231
+ * Get the default fast model for this provider (used for simple tasks: classification, matching, actions)
3232
+ * Should return a cheaper/faster model like Haiku for Anthropic
3233
+ */
3234
+ protected abstract getDefaultFastModel(): string;
3235
+ /**
3236
+ * Get the default API key from environment
3237
+ */
3238
+ protected abstract getDefaultApiKey(): string | undefined;
3239
+ /**
3240
+ * Get the provider name (for logging)
3241
+ */
3242
+ protected abstract getProviderName(): string;
3243
+ /**
3244
+ * Get the API key (from instance, parameter, or environment)
3245
+ */
3246
+ protected getApiKey(apiKey?: string): string | undefined;
3247
+ /**
3248
+ * Check if a component contains a Form (data_modification component)
3249
+ * Forms have hardcoded defaultValues that become stale when cached
3250
+ * This checks both single Form components and Forms inside MultiComponentContainer
3251
+ */
3252
+ protected containsFormComponent(component: any): boolean;
3253
+ /**
3254
+ * Match components from text response suggestions and generate follow-up questions
3255
+ * Takes a text response with component suggestions (c1:type format) and matches with available components
3256
+ * Also generates title, description, and intelligent follow-up questions (actions) based on the analysis
3257
+ * All components are placed in a default MultiComponentContainer layout
3258
+ * @param analysisContent - The text response containing component suggestions
3259
+ * @param components - List of available components
3260
+ * @param apiKey - Optional API key
3261
+ * @param componentStreamCallback - Optional callback to stream primary KPI component as soon as it's identified
3262
+ * @returns Object containing matched components, layout title/description, and follow-up actions
3263
+ */
3264
+ matchComponentsFromAnalysis(analysisContent: string, components: Component[], userPrompt: string, apiKey?: string, componentStreamCallback?: (component: Component) => void, deferredTools?: any[], executedTools?: any[], collections?: any, userId?: string): Promise<{
3265
+ components: Component[];
3266
+ layoutTitle: string;
3267
+ layoutDescription: string;
3268
+ actions: Action[];
3269
+ }>;
3270
+ /**
3271
+ * Classify user question into category and detect external tools needed
3272
+ * Determines if question is for data analysis, requires external tools, or needs text response
3273
+ */
3274
+ classifyQuestionCategory(userPrompt: string, apiKey?: string, conversationHistory?: string, externalTools?: any[]): Promise<{
3275
+ category: 'data_analysis' | 'data_modification' | 'general';
3276
+ externalTools: Array<{
3277
+ type: string;
3278
+ name: string;
3279
+ description: string;
3280
+ parameters: Record<string, any>;
3281
+ }>;
3282
+ dataAnalysisType?: 'visualization' | 'calculation' | 'comparison' | 'trend';
3283
+ reasoning: string;
3284
+ confidence: number;
3285
+ }>;
3286
+ /**
3287
+ * Adapt UI block parameters based on current user question
3288
+ * Takes a matched UI block from semantic search and modifies its props to answer the new question
3289
+ * Also adapts the cached text response to match the new question
3290
+ */
3291
+ adaptUIBlockParameters(currentUserPrompt: string, originalUserPrompt: string, matchedUIBlock: any, apiKey?: string, cachedTextResponse?: string): Promise<{
3292
+ success: boolean;
3293
+ adaptedComponent?: Component;
3294
+ adaptedTextResponse?: string;
3295
+ parametersChanged?: Array<{
3296
+ field: string;
3297
+ reason: string;
3298
+ }>;
3299
+ explanation: string;
3300
+ }>;
3301
+ /**
3302
+ * Generate text-based response for user question
3303
+ * This provides conversational text responses instead of component generation
3304
+ * Supports tool calling for query execution with automatic retry on errors (max 3 attempts)
3305
+ * After generating text response, if components are provided, matches suggested components
3306
+ */
3307
+ generateTextResponse(userPrompt: string, apiKey?: string, conversationHistory?: string, streamCallback?: (chunk: string) => void, collections?: any, components?: Component[], externalTools?: any[], category?: 'data_analysis' | 'data_modification' | 'general', userId?: string): Promise<T_RESPONSE>;
3308
+ /**
3309
+ * Main orchestration function with semantic search and multi-step classification
3310
+ * NEW FLOW (Recommended):
3311
+ * 1. Semantic search: Check previous conversations (>60% match)
3312
+ * - If match found → Adapt UI block parameters and return
3313
+ * 2. Category classification: Determine if data_analysis, requires_external_tools, or text_response
3314
+ * 3. Route appropriately based on category and response mode
3315
+ */
3316
+ handleUserRequest(userPrompt: string, components: Component[], apiKey?: string, conversationHistory?: string, responseMode?: 'component' | 'text', streamCallback?: (chunk: string) => void, collections?: any, externalTools?: any[], userId?: string): Promise<T_RESPONSE>;
3317
+ /**
3318
+ * Generate next questions that the user might ask based on the original prompt and generated component
3319
+ * This helps provide intelligent suggestions for follow-up queries
3320
+ * For general/conversational questions without components, pass textResponse instead
3321
+ */
3322
+ generateNextQuestions(originalUserPrompt: string, component?: Component | null, componentData?: Record<string, unknown>, apiKey?: string, conversationHistory?: string, textResponse?: string, signal?: AbortSignal): Promise<string[]>;
3323
+ }
3324
+
3325
+ interface AnthropicLLMConfig extends BaseLLMConfig {
3326
+ }
3327
+ /**
3328
+ * AnthropicLLM class for handling AI-powered component generation and matching using Anthropic Claude
3329
+ */
3330
+ declare class AnthropicLLM extends BaseLLM {
3331
+ constructor(config?: AnthropicLLMConfig);
3332
+ protected getDefaultModel(): string;
3333
+ protected getDefaultFastModel(): string;
3334
+ protected getDefaultApiKey(): string | undefined;
3335
+ protected getProviderName(): string;
3336
+ }
3337
+ declare const anthropicLLM: AnthropicLLM;
3338
+
3339
+ interface GroqLLMConfig extends BaseLLMConfig {
3340
+ }
3341
+ /**
3342
+ * GroqLLM class for handling AI-powered component generation and matching using Groq
3343
+ */
3344
+ declare class GroqLLM extends BaseLLM {
3345
+ constructor(config?: GroqLLMConfig);
3346
+ protected getDefaultModel(): string;
3347
+ protected getDefaultFastModel(): string;
3348
+ protected getDefaultApiKey(): string | undefined;
3349
+ protected getProviderName(): string;
3350
+ }
3351
+ declare const groqLLM: GroqLLM;
3352
+
3353
+ interface GeminiLLMConfig extends BaseLLMConfig {
3354
+ }
3355
+ /**
3356
+ * GeminiLLM class for handling AI-powered component generation and matching using Google Gemini
3357
+ */
3358
+ declare class GeminiLLM extends BaseLLM {
3359
+ constructor(config?: GeminiLLMConfig);
3360
+ protected getDefaultModel(): string;
3361
+ protected getDefaultFastModel(): string;
3362
+ protected getDefaultApiKey(): string | undefined;
3363
+ protected getProviderName(): string;
3364
+ }
3365
+ declare const geminiLLM: GeminiLLM;
3366
+
3367
+ interface OpenAILLMConfig extends BaseLLMConfig {
3368
+ }
3369
+ /**
3370
+ * OpenAILLM class for handling AI-powered component generation and matching using OpenAI GPT models
3371
+ */
3372
+ declare class OpenAILLM extends BaseLLM {
3373
+ constructor(config?: OpenAILLMConfig);
3374
+ protected getDefaultModel(): string;
3375
+ protected getDefaultFastModel(): string;
3376
+ protected getDefaultApiKey(): string | undefined;
3377
+ protected getProviderName(): string;
3378
+ }
3379
+ declare const openaiLLM: OpenAILLM;
3380
+
3381
+ /**
3382
+ * Query Cache — Two mechanisms:
3383
+ *
3384
+ * 1. `cache` (query string → result data) — TTL-based with max size, for avoiding re-execution
3385
+ * of recently validated queries. True LRU eviction: reads bubble entries to the back via
3386
+ * delete+re-set so the oldest *unused* entry is evicted, not the oldest *inserted*.
3387
+ *
3388
+ * 2. Encrypted queryId tokens — SQL is encrypted into the queryId itself (self-contained).
3389
+ * No server-side storage needed for SQL mappings. The token is decrypted on each request.
3390
+ * This eliminates the unbounded queryIdCache that previously grew forever and caused
3391
+ * memory bloat (hundreds of MBs after thousands of queries).
3392
+ *
3393
+ * Result data can still be cached temporarily via the data cache (mechanism 1).
3394
+ */
3395
+ declare class QueryCache {
3396
+ private cache;
3397
+ private ttlMs;
3398
+ private maxCacheSize;
3399
+ private cleanupInterval;
3400
+ private readonly algorithm;
3401
+ private encryptionKey;
3402
+ constructor();
3403
+ /**
3404
+ * Set the cache TTL (Time To Live)
3405
+ * @param minutes - TTL in minutes (default: 10)
3406
+ */
3407
+ setTTL(minutes: number): void;
3408
+ /**
3409
+ * Get the current TTL in minutes
3410
+ */
3411
+ getTTL(): number;
3412
+ /**
3413
+ * Store query result in data cache.
3414
+ * If the key already exists, it's removed first so the re-insert places it
3415
+ * at the back of the iteration order (LRU). Eviction only fires when adding
3416
+ * a genuinely new key past the size limit.
3417
+ */
3418
+ set(query: string, data: any): void;
3419
+ /**
3420
+ * Get cached result if exists and not expired.
3421
+ * On hit, re-inserts the entry so it moves to the back of the Map's
3422
+ * iteration order — turning FIFO eviction into true LRU.
3423
+ */
3424
+ get(query: string): any | null;
3425
+ /**
3426
+ * Check if query exists in cache (not expired)
3427
+ */
3428
+ has(query: string): boolean;
3429
+ /**
3430
+ * Remove a specific query from cache
3431
+ */
3432
+ delete(query: string): void;
3433
+ /**
3434
+ * Clear all cached entries
3435
+ */
3436
+ clear(): void;
3437
+ /**
3438
+ * Get cache statistics
3439
+ */
3440
+ getStats(): {
3441
+ size: number;
3442
+ queryIdCount: number;
3443
+ oldestEntryAge: number | null;
3444
+ };
3445
+ /**
3446
+ * Start periodic cleanup of expired data cache entries.
3447
+ */
3448
+ private startCleanup;
3449
+ /**
3450
+ * Encrypt a payload into a self-contained token.
3451
+ */
3452
+ private encrypt;
3453
+ /**
3454
+ * Decrypt a token back to the original payload.
3455
+ */
3456
+ private decrypt;
3457
+ /**
3458
+ * Store a query by generating an encrypted token as queryId.
3459
+ * The SQL is encrypted INTO the token — nothing stored in memory.
3460
+ * If data is provided, it's cached temporarily in the data cache.
3461
+ */
3462
+ storeQuery(query: any, data?: any): string;
3463
+ /**
3464
+ * Get a stored query by decrypting its token.
3465
+ * Returns the SQL + any cached result data.
3466
+ */
3467
+ getQuery(queryId: string): {
3468
+ query: any;
3469
+ data: any;
3470
+ } | null;
3471
+ /**
3472
+ * Update cached data for a queryId token
3473
+ */
3474
+ setQueryData(queryId: string, data: any): void;
3475
+ /**
3476
+ * Stop cleanup interval (for graceful shutdown)
3477
+ */
3478
+ destroy(): void;
3479
+ }
3480
+ declare const queryCache: QueryCache;
3481
+
3482
+ /**
3483
+ * Manages conversation history scoped per user + dashboard.
3484
+ * Each user-dashboard pair has its own isolated history that expires after a configurable TTL.
3485
+ */
3486
+ declare class DashboardConversationHistory {
3487
+ private histories;
3488
+ private ttlMs;
3489
+ private maxEntries;
3490
+ private cleanupInterval;
3491
+ constructor();
3492
+ /**
3493
+ * Set the TTL for dashboard histories
3494
+ * @param minutes - TTL in minutes
3495
+ */
3496
+ setTTL(minutes: number): void;
3497
+ /**
3498
+ * Set max entries per dashboard
3499
+ */
3500
+ setMaxEntries(max: number): void;
3501
+ /**
3502
+ * Add a conversation entry for a user's dashboard
3503
+ */
3504
+ addEntry(dashboardId: string, userPrompt: string, componentSummary: string, userId?: string): void;
3505
+ /**
3506
+ * Get formatted conversation history for a user's dashboard
3507
+ */
3508
+ getHistory(dashboardId: string, userId?: string): string;
3509
+ /**
3510
+ * Clear history for a specific user's dashboard
3511
+ */
3512
+ clearDashboard(dashboardId: string, userId?: string): void;
3513
+ /**
3514
+ * Clear all dashboard histories
3515
+ */
3516
+ clearAll(): void;
3517
+ /**
3518
+ * Start periodic cleanup of expired histories
3519
+ */
3520
+ private startCleanup;
3521
+ /**
3522
+ * Stop cleanup interval (for graceful shutdown)
3523
+ */
3524
+ destroy(): void;
3525
+ }
3526
+ declare const dashboardConversationHistory: DashboardConversationHistory;
3527
+
3528
+ /**
3529
+ * Whole-dashboard generation via Pi, a terminal coding agent — as opposed to
3530
+ * DASH_COMP_REQ's single-widget-at-a-time flow. Runs Pi in-process via its
3531
+ * SDK (createAgentSession), not as a subprocess: no shell, no argument
3532
+ * quoting, no stdin/stdout piping, none of the Windows-specific subprocess
3533
+ * issues that came with spawning the `pi` CLI directly.
3534
+ *
3535
+ * Called from sdk-nodejs/src/dashboardAgent/index.ts (DASHBOARD_AGENT_REQ),
3536
+ * which owns the generic streaming/abort machinery (mirrors USER_PROMPT_REQ)
3537
+ * and passes `signal`/`onProgress` alongside the normal params — this stays
3538
+ * within CollectionHandler's loose (params) => Promise<result> typing, no
3539
+ * change needed to that shared type.
3540
+ *
3541
+ * This mechanism is generic and reusable across any deployment. What's
3542
+ * genuinely project-specific — where AGENTS.md lives, which model to use —
3543
+ * is supplied via `DashboardAgentCollectionConfig`, with defaults sensible
3544
+ * enough that most callers don't need to override them (see below). The
3545
+ * data-source tool list and the dashboard's current state both come from
3546
+ * things sdk-nodejs already exposes generically: `sdk.getTools()` (whatever
3547
+ * this deployment registered via `sdk.setTools()`) and `sdk.callCollection
3548
+ * ('dashboards', 'query', ...)` (whatever this deployment already registered
3549
+ * under that name/shape) — no per-deployment callback needed for either.
3550
+ * Same convention on the way out: after a successful run, the prompt and the
3551
+ * full response text are handed to `sdk.callCollection('dashboard-agent-
3552
+ * conversations', 'create', ...)` if this deployment has registered one —
3553
+ * skipped silently otherwise, since conversation history is optional.
3554
+ *
3555
+ * Pi verifies every query against the live database itself (via whatever
3556
+ * local tool-execution bridge the deployment exposes, e.g. an HTTP bridge
3557
+ * on localhost), but does NOT persist the result itself — it writes the
3558
+ * finished DSL to an absolute path inside `runtimeDir`, told to it explicitly
3559
+ * in the prompt, and stops there. This handler reads that file after the run
3560
+ * finishes and returns its content as `dashboard` in the result. The caller
3561
+ * (frontend) is the one that actually saves it, via whatever authenticated
3562
+ * create/update path any other dashboard edit goes through — Pi has no user
3563
+ * session/auth context of its own, so persistence shouldn't happen from
3564
+ * inside it.
3565
+ *
3566
+ * Session persistence: the FIRST call for a dashboardId pays the full cost
3567
+ * (explore KB, discover schema, plan, verify, build). Every call after that
3568
+ * resumes the same session file (SessionManager.open) so Pi has everything
3569
+ * it already learned — it only needs to reason about the new, smaller ask,
3570
+ * not rediscover the whole dashboard from scratch. The session's file path
3571
+ * (AgentSession.sessionFile) is captured right after creation and persisted
3572
+ * in a small local file, keyed by dashboardId, inside `runtimeDir`.
3573
+ */
3574
+ interface DashboardAgentCollectionConfig {
3575
+ /**
3576
+ * Working directory Pi runs from — must contain AGENTS.md. This is a
3577
+ * version-controlled prompt file, so `cwd` is expected to live somewhere
3578
+ * like a `.prompts/` folder alongside the deployment's other prompts.
3579
+ * Default: `<process.cwd()>/.prompts/dashboard-agent` — the same
3580
+ * process.cwd()-based convention PromptLoader already uses for the main
3581
+ * agent's prompts, which needs no explicit override in the common case
3582
+ * (the backend process's own cwd already is its project root).
3583
+ */
3584
+ cwd?: string;
3585
+ /**
3586
+ * Where drafts/, the session-id map, and dashboard.log get written —
3587
+ * separate from `cwd` deliberately, so this deployment's runtime state
3588
+ * (regenerated per session, safe to gitignore) doesn't sit inside the
3589
+ * same folder as the version-controlled AGENTS.md prompt.
3590
+ * Default: `<process.cwd()>/.pi-dashboard-agent-runtime`.
3591
+ */
3592
+ runtimeDir?: string;
3593
+ /** Model provider (default: process.env.PI_AGENT_PROVIDER || 'openrouter'). */
3594
+ provider?: string;
3595
+ /** Model id (default: process.env.PI_AGENT_MODEL || 'anthropic/claude-sonnet-4.5'). */
3596
+ model?: string;
3597
+ /**
3598
+ * true (default): every request starts a brand-new pi session, with the 2
3599
+ * most recent prior responses (if any) injected into the prompt as
3600
+ * context — bounded cost per request, but pi re-explores schema/KB facts
3601
+ * it already verified in an earlier turn on this same dashboard.
3602
+ * false: resumes the same session file across requests on a given
3603
+ * dashboard — pi keeps everything it already learned, but context (and
3604
+ * cost) grows unbounded across turns (one observed turn: 2M+ cache-read
3605
+ * tokens after a handful of edits on the same dashboard).
3606
+ * Default: process.env.PI_AGENT_FRESH_SESSION !== 'false'.
3607
+ */
3608
+ freshSession?: boolean;
3609
+ }
3610
+ declare function registerDashboardAgentCollection(sdk: SuperatomSDK, config?: DashboardAgentCollectionConfig): void;
3611
+
3612
+ /**
3613
+ * ScriptMatcher — LLM-Based Script Matching + Parameter Extraction
3614
+ *
3615
+ * Uses ONE LLM call to:
3616
+ * 1. Pick the best matching script from the library (or "none")
3617
+ * 2. Extract parameter values from the user question
3618
+ *
3619
+ * Why LLM over embeddings:
3620
+ * - Embeddings capture topic similarity ("overstock" ≈ "inventory" ≈ "revenue")
3621
+ * but can't distinguish structurally different questions about the same domain
3622
+ * - LLM understands that "overstock by warehouse" needs a different script than
3623
+ * "revenue by warehouse" even though they're semantically close
3624
+ * - One call does both matching AND parameter extraction
3625
+ *
3626
+ * When script library grows past ~50, add an embedding pre-filter
3627
+ * (ChromaDB narrows to top 10 → LLM picks from those 10).
3628
+ */
3629
+
3630
+ declare class ScriptMatcher {
3631
+ private store;
3632
+ constructor(store: ScriptStore);
3633
+ /**
3634
+ * Find the best matching script for a user question.
3635
+ * Uses ONE LLM call that picks the script AND extracts parameters.
3636
+ * Returns null if no script matches.
3637
+ */
3638
+ match(userPrompt: string, apiKey?: string, model?: string, signal?: AbortSignal): Promise<ScriptMatch | null>;
3639
+ /**
3640
+ * Build the script catalog string for the LLM prompt.
3641
+ * Each script gets: index, ID, name, description, and parameter definitions.
3642
+ */
3643
+ private buildScriptCatalog;
3644
+ }
3645
+
3646
+ /**
3647
+ * ScriptRunner — Execute scripts in an isolated tsx subprocess.
3648
+ *
3649
+ * The subprocess approach replaces the earlier `new Function()` eval and gives us:
3650
+ * - Real sandbox (separate process, SIGKILL on timeout).
3651
+ * - Real TypeScript (tsx transpiles on the fly).
3652
+ * - npm imports available to scripts (clustering, stats, geo, etc.).
3653
+ *
3654
+ * Protocol: NDJSON over the child's stdin/stdout. See script-ipc.ts + backend/docs/SCRIPT-FLOW-IMPLEMENTATION.md.
3655
+ */
3656
+
3657
+ interface RunScriptOptions {
3658
+ /** Data sources the script is allowed to query via ctx.query */
3659
+ externalTools: ExternalTool[];
3660
+ /** Optional — for propagating per-query UI progress to the user */
3661
+ streamBuffer?: StreamBuffer;
3662
+ /** Override the wall-clock timeout (default `SCRIPT_TIMEOUT_MS`, 60s). */
3663
+ timeoutMs?: number;
3664
+ /**
3665
+ * Per-turn cancellation signal. When the user hits "Stop" mid-run, the child
3666
+ * process group is SIGKILLed and the run resolves as an aborted failure (the
3667
+ * caller is already unwinding, so the result is discarded).
3668
+ */
3669
+ signal?: AbortSignal;
3670
+ }
3671
+ /**
3672
+ * Execute a recipe by spawning a tsx child on the script's .ts file.
3673
+ * `scriptPath` is the absolute path to the saved `.ts` body.
3674
+ */
3675
+ declare function runScript(recipe: ScriptRecipe, scriptPath: string, params: Record<string, any>, options: RunScriptOptions): Promise<ScriptResult>;
3676
+
3677
+ type MessageTypeHandler = (message: IncomingMessage) => void | Promise<void>;
3678
+ declare class SuperatomSDK {
3679
+ private ws;
3680
+ private url;
3681
+ private apiKey?;
3682
+ private projectId;
3683
+ private type;
3684
+ private bundleDir;
3685
+ private messageHandlers;
3686
+ private messageTypeHandlers;
3687
+ private connected;
3688
+ private reconnectAttempts;
3689
+ private maxReconnectAttempts;
3690
+ private collections;
3691
+ private components;
3692
+ private tools;
3693
+ private workflows;
3694
+ private anthropicApiKey;
3695
+ private groqApiKey;
3696
+ private geminiApiKey;
3697
+ private openaiApiKey;
3698
+ private llmProviders;
3699
+ private databaseType;
3700
+ private modelStrategy;
3701
+ private mainAgentModel;
3702
+ private sourceAgentModel;
3703
+ private dashCompModels?;
3704
+ private conversationSimilarityThreshold;
1359
3705
  private userManager;
1360
3706
  private dashboardManager;
1361
3707
  private reportManager;
3708
+ private pingInterval;
3709
+ private lastPong;
3710
+ private readonly PING_INTERVAL_MS;
3711
+ private readonly PONG_TIMEOUT_MS;
1362
3712
  constructor(config: SuperatomSDKConfig);
1363
3713
  /**
1364
3714
  * Initialize PromptLoader and load prompts into memory
@@ -1398,9 +3748,11 @@ declare class SuperatomSDK {
1398
3748
  */
1399
3749
  private handleMessage;
1400
3750
  /**
1401
- * Send a message to the Superatom service
3751
+ * Send a message to the Superatom service.
3752
+ * Returns true if the message was sent, false if the WebSocket is not connected.
3753
+ * Does NOT throw on closed connections — callers can check the return value if needed.
1402
3754
  */
1403
- send(message: Message): void;
3755
+ send(message: Message): boolean;
1404
3756
  /**
1405
3757
  * Register a message handler to receive all messages
1406
3758
  */
@@ -1426,7 +3778,28 @@ declare class SuperatomSDK {
1426
3778
  */
1427
3779
  addCollection<TParams = any, TResult = any>(collectionName: string, operation: CollectionOperation | string, handler: CollectionHandler<TParams, TResult>): void;
1428
3780
  private handleReconnect;
3781
+ /**
3782
+ * Start heartbeat to keep WebSocket connection alive
3783
+ * Sends PING every 3 minutes to prevent idle timeout from cloud infrastructure
3784
+ */
3785
+ private startHeartbeat;
3786
+ /**
3787
+ * Stop the heartbeat interval
3788
+ */
3789
+ private stopHeartbeat;
3790
+ /**
3791
+ * Handle PONG response from server
3792
+ */
3793
+ private handlePong;
1429
3794
  private storeComponents;
3795
+ /**
3796
+ * The live, frontend-registered component catalog (name, type, description,
3797
+ * and full prop schema per component) — the same authoritative source
3798
+ * DASH_COMP_REQ's LLM prompt is built from. Exposed so other integrations
3799
+ * (e.g. the dashboard-agent script bridge) can read real component
3800
+ * contracts instead of maintaining a separate, driftable hand-written copy.
3801
+ */
3802
+ getComponents(): Component[];
1430
3803
  /**
1431
3804
  * Set tools for the SDK instance
1432
3805
  */
@@ -1435,6 +3808,57 @@ declare class SuperatomSDK {
1435
3808
  * Get the stored tools
1436
3809
  */
1437
3810
  getTools(): Tool$1[];
3811
+ /**
3812
+ * Call a registered collection operation in-process — no WebSocket
3813
+ * round-trip, since the caller is already running inside this same SDK
3814
+ * instance. Lets SDK-internal features (e.g. the dashboard agent) reuse
3815
+ * whatever collection a deployment has already registered (e.g.
3816
+ * 'dashboards'.'query') by name/convention, instead of requiring a
3817
+ * separate callback purely to re-expose data a collection already serves.
3818
+ * Throws if the collection or operation isn't registered.
3819
+ */
3820
+ callCollection<TResult = any>(collectionName: string, operation: string, params?: any): Promise<TResult>;
3821
+ /**
3822
+ * Register workflow components for the SDK instance.
3823
+ *
3824
+ * Workflows are pre-built multi-step UI flows the main agent can pick when
3825
+ * the user's prompt matches a workflow's `whenToUse` trigger. Picking a
3826
+ * workflow short-circuits analysis text + dashboard component generation —
3827
+ * the workflow component is returned directly, with the LLM-extracted props.
3828
+ */
3829
+ setWorkflows(workflows: WorkflowDescriptor[]): void;
3830
+ /**
3831
+ * Get the registered workflow components.
3832
+ */
3833
+ getWorkflows(): WorkflowDescriptor[];
3834
+ /**
3835
+ * Apply model strategy to all LLM provider singletons
3836
+ * @param strategy - 'best', 'fast', or 'balanced'
3837
+ */
3838
+ private applyModelStrategy;
3839
+ /**
3840
+ * Set model strategy at runtime
3841
+ * @param strategy - 'best', 'fast', or 'balanced'
3842
+ */
3843
+ setModelStrategy(strategy: ModelStrategy): void;
3844
+ /**
3845
+ * Get current model strategy
3846
+ */
3847
+ getModelStrategy(): ModelStrategy;
3848
+ /**
3849
+ * Apply conversation similarity threshold to all LLM provider singletons
3850
+ * @param threshold - Value between 0 and 1 (e.g., 0.8 = 80% similarity required)
3851
+ */
3852
+ private applyConversationSimilarityThreshold;
3853
+ /**
3854
+ * Set conversation similarity threshold at runtime
3855
+ * @param threshold - Value between 0 and 1 (e.g., 0.8 = 80% similarity required)
3856
+ */
3857
+ setConversationSimilarityThreshold(threshold: number): void;
3858
+ /**
3859
+ * Get current conversation similarity threshold
3860
+ */
3861
+ getConversationSimilarityThreshold(): number;
1438
3862
  }
1439
3863
 
1440
- export { type Action, CONTEXT_CONFIG, type CapturedLog, CleanupService, type CollectionHandler, type CollectionOperation, type IncomingMessage, LLM, type LogLevel, type Message, SDK_VERSION, STORAGE_CONFIG, SuperatomSDK, type SuperatomSDKConfig, Thread, ThreadManager, type Tool$1 as Tool, UIBlock, UILogCollector, type User, UserManager, type UsersData, logger };
3864
+ export { type Action, type AgentConfig, type AgentResponse, BM25L, type BM25LOptions, type BaseLLMConfig, CONTEXT_CONFIG, type CapturedLog, CleanupService, type CollectionHandler, type CollectionOperation, type DBUIBlock, DEFAULT_AGENT_CONFIG, type DashboardAgentCollectionConfig, type DatabaseType, type HybridSearchOptions, type IncomingMessage, type KbNodesQueryFilters, type KbNodesRequestPayload, LLM, type LLMUsageEntry, type LogLevel, MainAgent, type Message, type ModelStrategy, type OutputField, type RerankedResult, STORAGE_CONFIG, type ScriptComponentSpec, ScriptMatcher, type ScriptParameter, type ScriptRecipe, type ScriptRecipeMetaRow, type ScriptRecipeStore, type ScriptResult, ScriptStore, type ScriptStoreOptions, type SelectedWorkflow, SuperatomSDK, type SuperatomSDKConfig, type TaskType, Thread, ThreadManager, type Tool$1 as Tool, type ToolOutputSchema, UIBlock, UILogCollector, type User, UserManager, type UsersData, type WorkflowDescriptor, anthropicLLM, dashboardConversationHistory, geminiLLM, groqLLM, hybridRerank, llmUsageLogger, logger, normalizeScriptBody, openaiLLM, queryCache, registerDashboardAgentCollection, rerankChromaResults, rerankConversationResults, resolveScriptRecipeStore, runScript, userPromptErrorLogger };