@falai/agent 0.9.0-alpha-2 → 0.9.0

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.
Files changed (75) hide show
  1. package/dist/cjs/src/core/Agent.d.ts +31 -41
  2. package/dist/cjs/src/core/Agent.d.ts.map +1 -1
  3. package/dist/cjs/src/core/Agent.js +72 -1075
  4. package/dist/cjs/src/core/Agent.js.map +1 -1
  5. package/dist/cjs/src/core/ResponseModal.d.ts +205 -0
  6. package/dist/cjs/src/core/ResponseModal.d.ts.map +1 -0
  7. package/dist/cjs/src/core/ResponseModal.js +1328 -0
  8. package/dist/cjs/src/core/ResponseModal.js.map +1 -0
  9. package/dist/cjs/src/core/ResponsePipeline.js +1 -1
  10. package/dist/cjs/src/core/ResponsePipeline.js.map +1 -1
  11. package/dist/cjs/src/index.d.ts +3 -1
  12. package/dist/cjs/src/index.d.ts.map +1 -1
  13. package/dist/cjs/src/index.js +7 -1
  14. package/dist/cjs/src/index.js.map +1 -1
  15. package/dist/cjs/src/types/agent.d.ts +1 -0
  16. package/dist/cjs/src/types/agent.d.ts.map +1 -1
  17. package/dist/cjs/src/types/ai.d.ts +1 -1
  18. package/dist/cjs/src/types/ai.d.ts.map +1 -1
  19. package/dist/cjs/src/utils/clone.d.ts.map +1 -1
  20. package/dist/cjs/src/utils/clone.js +0 -4
  21. package/dist/cjs/src/utils/clone.js.map +1 -1
  22. package/dist/cjs/src/utils/history.d.ts +30 -1
  23. package/dist/cjs/src/utils/history.d.ts.map +1 -1
  24. package/dist/cjs/src/utils/history.js +169 -23
  25. package/dist/cjs/src/utils/history.js.map +1 -1
  26. package/dist/cjs/src/utils/index.d.ts +1 -1
  27. package/dist/cjs/src/utils/index.d.ts.map +1 -1
  28. package/dist/cjs/src/utils/index.js +5 -1
  29. package/dist/cjs/src/utils/index.js.map +1 -1
  30. package/dist/src/core/Agent.d.ts +31 -41
  31. package/dist/src/core/Agent.d.ts.map +1 -1
  32. package/dist/src/core/Agent.js +73 -1076
  33. package/dist/src/core/Agent.js.map +1 -1
  34. package/dist/src/core/ResponseModal.d.ts +205 -0
  35. package/dist/src/core/ResponseModal.d.ts.map +1 -0
  36. package/dist/src/core/ResponseModal.js +1323 -0
  37. package/dist/src/core/ResponseModal.js.map +1 -0
  38. package/dist/src/core/ResponsePipeline.js +1 -1
  39. package/dist/src/core/ResponsePipeline.js.map +1 -1
  40. package/dist/src/index.d.ts +3 -1
  41. package/dist/src/index.d.ts.map +1 -1
  42. package/dist/src/index.js +2 -1
  43. package/dist/src/index.js.map +1 -1
  44. package/dist/src/types/agent.d.ts +1 -0
  45. package/dist/src/types/agent.d.ts.map +1 -1
  46. package/dist/src/types/ai.d.ts +1 -1
  47. package/dist/src/types/ai.d.ts.map +1 -1
  48. package/dist/src/utils/clone.d.ts.map +1 -1
  49. package/dist/src/utils/clone.js +0 -4
  50. package/dist/src/utils/clone.js.map +1 -1
  51. package/dist/src/utils/history.d.ts +30 -1
  52. package/dist/src/utils/history.d.ts.map +1 -1
  53. package/dist/src/utils/history.js +165 -23
  54. package/dist/src/utils/history.js.map +1 -1
  55. package/dist/src/utils/index.d.ts +1 -1
  56. package/dist/src/utils/index.d.ts.map +1 -1
  57. package/dist/src/utils/index.js +1 -1
  58. package/dist/src/utils/index.js.map +1 -1
  59. package/docs/README.md +2 -1
  60. package/docs/api/README.md +160 -0
  61. package/docs/api/overview.md +66 -1
  62. package/docs/guides/migration/README.md +72 -0
  63. package/docs/guides/migration/response-modal-refactor.md +518 -0
  64. package/examples/advanced-patterns/streaming-responses.ts +169 -96
  65. package/examples/core-concepts/modern-streaming-api.ts +309 -0
  66. package/package.json +1 -1
  67. package/src/core/Agent.ts +95 -1488
  68. package/src/core/ResponseModal.ts +1722 -0
  69. package/src/core/ResponsePipeline.ts +1 -1
  70. package/src/index.ts +11 -0
  71. package/src/types/agent.ts +1 -0
  72. package/src/types/ai.ts +1 -1
  73. package/src/utils/clone.ts +6 -8
  74. package/src/utils/history.ts +190 -27
  75. package/src/utils/index.ts +4 -0
@@ -0,0 +1,1722 @@
1
+ /**
2
+ * ResponseModal handles all response generation logic for the Agent
3
+ * Provides both streaming and non-streaming response generation with unified logic
4
+ */
5
+
6
+ import type {
7
+ AgentResponse,
8
+ AgentResponseStreamChunk,
9
+ History,
10
+ SessionState,
11
+ StepRef,
12
+ HistoryItem,
13
+ Tool,
14
+ Event,
15
+ ToolEventData,
16
+ AgentStructuredResponse,
17
+ Term,
18
+ } from "../types";
19
+ import { EventKind, MessageRole } from "../types";
20
+ import type { Agent } from "./Agent";
21
+ import type { Route } from "./Route";
22
+ import { Step } from "./Step";
23
+ import { ResponseEngine } from "./ResponseEngine";
24
+ import { ResponsePipeline } from "./ResponsePipeline";
25
+ import { cloneDeep, mergeCollected, enterStep, getLastMessageFromHistory, render, logger, historyToEvents } from "../utils";
26
+ import { ToolExecutor } from "./ToolExecutor";
27
+ import { END_ROUTE_ID } from "../constants";
28
+
29
+ /**
30
+ * Configuration options for ResponseModal
31
+ */
32
+ export interface ResponseModalOptions {
33
+ /** Maximum number of tool loops allowed during response generation */
34
+ maxToolLoops?: number;
35
+ /** Enable automatic session saving after response generation */
36
+ enableAutoSave?: boolean;
37
+ /** Enable debug mode for detailed logging */
38
+ debugMode?: boolean;
39
+ }
40
+
41
+ /**
42
+ * Parameters for respond and respondStream methods
43
+ */
44
+ export interface RespondParams<TContext = unknown, TData = unknown> extends Record<string, unknown> {
45
+ history: History;
46
+ step?: StepRef;
47
+ session?: SessionState<TData>;
48
+ contextOverride?: Partial<TContext>;
49
+ signal?: AbortSignal;
50
+ }
51
+
52
+ /**
53
+ * Options for the modern stream() method
54
+ */
55
+ export interface StreamOptions<TContext = unknown> {
56
+ contextOverride?: Partial<TContext>;
57
+ signal?: AbortSignal;
58
+ history?: History; // Optional: override session history
59
+ }
60
+
61
+ /**
62
+ * Options for the modern generate() method
63
+ */
64
+ export interface GenerateOptions<TContext = unknown> {
65
+ contextOverride?: Partial<TContext>;
66
+ signal?: AbortSignal;
67
+ history?: History; // Optional: override session history
68
+ }
69
+
70
+ /**
71
+ * Error details for response generation failures
72
+ */
73
+ interface ResponseGenerationErrorDetails {
74
+ originalError?: unknown;
75
+ params?: Record<string, unknown>;
76
+ phase?: string;
77
+ context?: Record<string, unknown>;
78
+ }
79
+
80
+ /**
81
+ * Error class for response generation failures
82
+ */
83
+ export class ResponseGenerationError extends Error {
84
+ constructor(
85
+ message: string,
86
+ public readonly details?: ResponseGenerationErrorDetails
87
+ ) {
88
+ super(message);
89
+ this.name = 'ResponseGenerationError';
90
+
91
+ // Preserve stack trace from original error if available
92
+ if (details?.originalError instanceof Error && details.originalError.stack) {
93
+ this.stack = `${this.stack}\nCaused by: ${details.originalError.stack}`;
94
+ }
95
+ }
96
+
97
+ /**
98
+ * Create a ResponseGenerationError from an unknown error
99
+ */
100
+ static fromError(
101
+ error: unknown,
102
+ phase: string,
103
+ params?: Record<string, unknown>,
104
+ context?: Record<string, unknown>
105
+ ): ResponseGenerationError {
106
+ const message = error instanceof Error ? error.message : String(error);
107
+ return new ResponseGenerationError(
108
+ `Response generation failed in ${phase}: ${message}`,
109
+ { originalError: error, params, phase, context }
110
+ );
111
+ }
112
+
113
+ /**
114
+ * Check if an error is a ResponseGenerationError
115
+ */
116
+ static isResponseGenerationError(error: unknown): error is ResponseGenerationError {
117
+ return error instanceof ResponseGenerationError;
118
+ }
119
+ }
120
+
121
+ /**
122
+ * Common response context used across all response methods
123
+ */
124
+ interface ResponseContext<TContext = unknown, TData = unknown> {
125
+ effectiveContext: TContext;
126
+ session: SessionState<TData>;
127
+ history: HistoryItem[]; // Keep as HistoryItem[] for external API compatibility
128
+ selectedRoute?: Route<TContext, TData>;
129
+ selectedStep?: Step<TContext, TData>;
130
+ responseDirectives?: string[];
131
+ isRouteComplete: boolean;
132
+ }
133
+
134
+ /**
135
+ * ResponseModal class that encapsulates all response generation logic
136
+ * Uses unified approach for both streaming and non-streaming responses
137
+ */
138
+ export class ResponseModal<TContext = unknown, TData = unknown> {
139
+ private readonly responseEngine: ResponseEngine<TContext, TData>;
140
+ private readonly responsePipeline: ResponsePipeline<TContext, TData>;
141
+
142
+ constructor(
143
+ private readonly agent: Agent<TContext, TData>,
144
+ private readonly options?: ResponseModalOptions
145
+ ) {
146
+ // Initialize response engine
147
+ this.responseEngine = new ResponseEngine<TContext, TData>();
148
+
149
+ // Initialize response pipeline with agent dependencies
150
+ this.responsePipeline = new ResponsePipeline<TContext, TData>(
151
+ this.agent.getAgentOptions(),
152
+ this.agent.getRoutes(),
153
+ this.agent.getTools(),
154
+ this.agent.getRoutingEngine(),
155
+ this.agent.updateContext.bind(this.agent),
156
+ this.agent.getUpdateDataMethod(),
157
+ this.agent.updateCollectedData.bind(this.agent)
158
+ );
159
+ }
160
+
161
+ /**
162
+ * Generate a non-streaming response using unified logic
163
+ */
164
+ async respond(params: RespondParams<TContext, TData>): Promise<AgentResponse<TData>> {
165
+ try {
166
+ // Use unified response preparation and routing
167
+ const responseContext = await this.prepareUnifiedResponseContext(params);
168
+
169
+ // Generate response using unified logic
170
+ const result = await this.generateUnifiedResponse(responseContext);
171
+
172
+ // Finalize session
173
+ await this.finalizeSession(result.session!, responseContext.effectiveContext);
174
+
175
+ return result;
176
+
177
+ } catch (error) {
178
+ throw new ResponseGenerationError(
179
+ `Failed to generate response: ${error instanceof Error ? error.message : String(error)}`,
180
+ { originalError: error, params, phase: 'response_generation' }
181
+ );
182
+ }
183
+ }
184
+
185
+ /**
186
+ * Generate a streaming response using unified logic
187
+ */
188
+ async *respondStream(params: RespondParams<TContext, TData>): AsyncGenerator<AgentResponseStreamChunk<TData>> {
189
+ try {
190
+ // Use unified response preparation and routing
191
+ const responseContext = await this.prepareUnifiedResponseContext(params);
192
+
193
+ // Generate streaming response using unified logic
194
+ yield* this.generateUnifiedStreamingResponse(responseContext);
195
+
196
+ } catch (error) {
197
+ // Stream error to caller
198
+ yield {
199
+ delta: "",
200
+ accumulated: "",
201
+ done: true,
202
+ session: params.session || await this.agent.session.getOrCreate(),
203
+ error: new ResponseGenerationError(
204
+ `Streaming response failed: ${error instanceof Error ? error.message : String(error)}`,
205
+ { originalError: error, params, phase: 'streaming' }
206
+ ),
207
+ } as AgentResponseStreamChunk<TData>;
208
+ }
209
+ }
210
+
211
+ /**
212
+ * Modern streaming API - simple interface like chat()
213
+ */
214
+ async *stream(
215
+ message?: string,
216
+ options?: StreamOptions<TContext>
217
+ ): AsyncGenerator<AgentResponseStreamChunk<TData>> {
218
+ // Determine which history to use
219
+ let history: History;
220
+ if (options?.history) {
221
+ // Use provided history for this response only
222
+ history = options.history;
223
+ } else {
224
+ // Add user message to session history if provided
225
+ if (message) {
226
+ await this.agent.session.addMessage("user", message);
227
+ }
228
+ history = this.agent.session.getHistory();
229
+ }
230
+
231
+ // Get or create session
232
+ let session = await this.agent.session.getOrCreate();
233
+
234
+ // Merge agent's collected data into session (agent data takes precedence)
235
+ const collectedData = this.agent.getCollectedData();
236
+ if (Object.keys(collectedData).length > 0) {
237
+ session = mergeCollected(session, collectedData);
238
+ // Update the session manager with the merged data
239
+ await this.agent.session.setData(collectedData);
240
+ logger.debug("[ResponseModal] Merged agent collected data into stream session:", collectedData);
241
+ }
242
+
243
+ // Stream response using existing respondStream method
244
+ let finalMessage = "";
245
+ for await (const chunk of this.respondStream({
246
+ history,
247
+ session,
248
+ contextOverride: options?.contextOverride,
249
+ signal: options?.signal,
250
+ })) {
251
+ // Accumulate the final message for session history
252
+ if (chunk.done) {
253
+ finalMessage = chunk.accumulated;
254
+ }
255
+
256
+ yield chunk;
257
+ }
258
+
259
+ // Add agent response to session history (only if not using override history)
260
+ if (!options?.history && finalMessage) {
261
+ await this.agent.session.addMessage("assistant", finalMessage);
262
+ }
263
+ }
264
+
265
+ /**
266
+ * Modern non-streaming API - equivalent to chat() but more explicit
267
+ */
268
+ async generate(
269
+ message?: string,
270
+ options?: GenerateOptions<TContext>
271
+ ): Promise<AgentResponse<TData>> {
272
+ // Determine which history to use
273
+ let history: History;
274
+ if (options?.history) {
275
+ // Use provided history for this response only
276
+ history = options.history;
277
+ } else {
278
+ // Add user message to session history if provided
279
+ if (message) {
280
+ await this.agent.session.addMessage("user", message);
281
+ }
282
+ history = this.agent.session.getHistory();
283
+ }
284
+
285
+ // Get or create session
286
+ let session = await this.agent.session.getOrCreate();
287
+
288
+ // Merge agent's collected data into session (agent data takes precedence)
289
+ const collectedData = this.agent.getCollectedData();
290
+ if (Object.keys(collectedData).length > 0) {
291
+ session = mergeCollected(session, collectedData);
292
+ // Update the session manager with the merged data
293
+ await this.agent.session.setData(collectedData);
294
+ logger.debug("[ResponseModal] Merged agent collected data into generate session:", collectedData);
295
+ }
296
+
297
+ // Generate response using existing respond method
298
+ const result = await this.respond({
299
+ history,
300
+ session,
301
+ contextOverride: options?.contextOverride,
302
+ signal: options?.signal,
303
+ });
304
+
305
+ // Add agent response to session history (only if not using override history)
306
+ if (!options?.history) {
307
+ await this.agent.session.addMessage("assistant", result.message);
308
+ }
309
+
310
+ // Ensure the result includes the current session
311
+ return {
312
+ ...result,
313
+ session: result.session || this.agent.session.current,
314
+ };
315
+ }
316
+
317
+ /**
318
+ * Get the response engine instance
319
+ * @internal
320
+ */
321
+ getResponseEngine(): ResponseEngine<TContext, TData> {
322
+ return this.responseEngine;
323
+ }
324
+
325
+ /**
326
+ * Get the response pipeline instance
327
+ * @internal
328
+ */
329
+ getResponsePipeline(): ResponsePipeline<TContext, TData> {
330
+ return this.responsePipeline;
331
+ }
332
+
333
+ // UNIFIED RESPONSE LOGIC - Consolidates common logic between streaming and non-streaming
334
+ // ============================================================================
335
+
336
+ /**
337
+ * Unified response preparation - handles context setup, session management, and routing
338
+ * This consolidates common logic between streaming and non-streaming responses
339
+ * @private
340
+ */
341
+ private async prepareUnifiedResponseContext(params: RespondParams<TContext, TData>): Promise<ResponseContext<TContext, TData>> {
342
+ try {
343
+ const { history: simpleHistory, contextOverride, signal } = params;
344
+
345
+ // Validate input parameters
346
+ if (!simpleHistory) {
347
+ throw new ResponseGenerationError('History is required for response generation', { params, phase: 'validation' });
348
+ }
349
+
350
+ // Convert HistoryItem[] to Event[] for internal processing
351
+ const historyEvents = historyToEvents(simpleHistory);
352
+ // Keep original HistoryItem[] format for external APIs
353
+ const history = simpleHistory;
354
+
355
+ // Use ResponsePipeline for optimized context and session preparation
356
+ // This leverages existing optimizations and avoids code duplication
357
+ let responseContext: {
358
+ effectiveContext: TContext;
359
+ session: SessionState<TData>;
360
+ };
361
+ try {
362
+ // Set current context and session in pipeline for consistency
363
+ this.responsePipeline.setContext(await this.agent.getContext());
364
+ this.responsePipeline.setCurrentSession(this.agent.getCurrentSession());
365
+
366
+ responseContext = await this.responsePipeline.prepareResponseContext({
367
+ contextOverride,
368
+ session: params.session ? cloneDeep(params.session) : undefined,
369
+ });
370
+ } catch (error) {
371
+ throw ResponseGenerationError.fromError(error, 'pipeline_context_preparation', params);
372
+ }
373
+
374
+ const { effectiveContext } = responseContext;
375
+ let session = responseContext.session;
376
+
377
+ // Update our stored context if it was modified by beforeRespond hook
378
+ const storedContext = this.responsePipeline.getStoredContext();
379
+ if (storedContext !== undefined) {
380
+ try {
381
+ await this.agent.updateContext(storedContext as Partial<TContext>);
382
+ } catch (error) {
383
+ throw ResponseGenerationError.fromError(error, 'context_update_from_pipeline', params, { storedContext });
384
+ }
385
+ }
386
+
387
+ // Merge agent's collected data into session (agent data takes precedence)
388
+ const collectedData = this.agent.getCollectedData();
389
+ if (Object.keys(collectedData).length > 0) {
390
+ try {
391
+ session = mergeCollected(session, collectedData);
392
+ logger.debug("[ResponseModal] Merged agent collected data into session:", collectedData);
393
+ } catch (error) {
394
+ throw ResponseGenerationError.fromError(error, 'data_merging', params, { collectedData });
395
+ }
396
+ }
397
+
398
+ // PHASE 1: PREPARE - Execute prepare function if current step has one
399
+ try {
400
+ await this.executeStepPrepare(session, effectiveContext);
401
+ } catch (error) {
402
+ throw ResponseGenerationError.fromError(error, 'step_preparation', params, { session, effectiveContext });
403
+ }
404
+
405
+ // PHASE 2: ROUTING + STEP SELECTION - Determine which route and step to use
406
+ let routingResult: {
407
+ selectedRoute?: Route<TContext, TData>;
408
+ selectedStep?: Step<TContext, TData>;
409
+ responseDirectives?: string[];
410
+ session: SessionState<TData>;
411
+ isRouteComplete: boolean;
412
+ };
413
+ try {
414
+ routingResult = await this.handleUnifiedRoutingAndStepSelection({
415
+ session,
416
+ history: historyEvents,
417
+ context: effectiveContext,
418
+ signal,
419
+ });
420
+ } catch (error) {
421
+ throw ResponseGenerationError.fromError(error, 'routing_and_step_selection', params, { session, effectiveContext });
422
+ }
423
+
424
+ return {
425
+ effectiveContext,
426
+ session: routingResult.session,
427
+ history,
428
+ selectedRoute: routingResult.selectedRoute,
429
+ selectedStep: routingResult.selectedStep,
430
+ responseDirectives: routingResult.responseDirectives,
431
+ isRouteComplete: routingResult.isRouteComplete,
432
+ };
433
+ } catch (error) {
434
+ // Re-throw ResponseGenerationError as-is, wrap others
435
+ if (ResponseGenerationError.isResponseGenerationError(error)) {
436
+ throw error;
437
+ }
438
+ throw ResponseGenerationError.fromError(error, 'preparation', params);
439
+ }
440
+ }
441
+
442
+ /**
443
+ * Unified routing and step selection logic using ResponsePipeline for optimization
444
+ * @private
445
+ */
446
+ private async handleUnifiedRoutingAndStepSelection(params: {
447
+ session: SessionState<TData>;
448
+ history: Event[]; // Use Event[] for internal processing
449
+ context: TContext;
450
+ signal?: AbortSignal;
451
+ }): Promise<{
452
+ selectedRoute?: Route<TContext, TData>;
453
+ selectedStep?: Step<TContext, TData>;
454
+ responseDirectives?: string[];
455
+ session: SessionState<TData>;
456
+ isRouteComplete: boolean;
457
+ }> {
458
+ try {
459
+ // Use the ResponsePipeline for optimized routing and step selection
460
+ // This avoids duplicate logic and leverages existing optimizations
461
+ // ResponsePipeline expects Event[] for history
462
+ const routingResult = await this.responsePipeline.handleRoutingAndStepSelection({
463
+ session: params.session,
464
+ history: params.history, // Already Event[]
465
+ context: params.context,
466
+ signal: params.signal,
467
+ });
468
+
469
+ // Determine next step using pipeline method for consistency
470
+ const stepResult = this.responsePipeline.determineNextStep({
471
+ selectedRoute: routingResult.selectedRoute,
472
+ selectedStep: routingResult.selectedStep,
473
+ session: routingResult.session,
474
+ isRouteComplete: routingResult.isRouteComplete,
475
+ });
476
+
477
+ return {
478
+ selectedRoute: routingResult.selectedRoute,
479
+ selectedStep: stepResult.nextStep, // Use the determined next step
480
+ responseDirectives: routingResult.responseDirectives,
481
+ session: stepResult.session,
482
+ isRouteComplete: routingResult.isRouteComplete,
483
+ };
484
+ } catch (error) {
485
+ throw ResponseGenerationError.fromError(error, 'routing_optimization', params);
486
+ }
487
+ }
488
+
489
+ /**
490
+ * Unified response generation for non-streaming responses
491
+ * @private
492
+ */
493
+ private async generateUnifiedResponse(
494
+ responseContext: ResponseContext<TContext, TData>
495
+ ): Promise<AgentResponse<TData>> {
496
+ const { effectiveContext, session: initialSession, history, selectedRoute, selectedStep, responseDirectives, isRouteComplete } = responseContext;
497
+ let session = initialSession;
498
+
499
+ // Get last user message (needed for both route and completion handling)
500
+ // Convert HistoryItem[] to Event[] for internal processing
501
+ const historyEvents = historyToEvents(history);
502
+ const lastMessageText = getLastMessageFromHistory(historyEvents);
503
+
504
+ let message: string;
505
+ let toolCalls: Array<{ toolName: string; arguments: Record<string, unknown> }> | undefined = undefined;
506
+
507
+ if (selectedRoute && !isRouteComplete) {
508
+ // Handle normal route processing
509
+ const result = await this.processRouteResponse({
510
+ selectedRoute,
511
+ selectedStep,
512
+ responseDirectives,
513
+ session,
514
+ history,
515
+ context: effectiveContext,
516
+ lastMessageText,
517
+ historyEvents,
518
+ signal: responseContext.history ? undefined : undefined, // TODO: Fix signal passing
519
+ });
520
+
521
+ message = result.message;
522
+ toolCalls = result.toolCalls;
523
+ session = result.session;
524
+
525
+ } else if (isRouteComplete && selectedRoute) {
526
+ // Handle route completion
527
+ message = await this.handleRouteCompletion({
528
+ selectedRoute,
529
+ session,
530
+ context: effectiveContext,
531
+ lastMessageText,
532
+ historyEvents,
533
+ });
534
+
535
+ // Set step to END_ROUTE marker
536
+ session = enterStep(session, END_ROUTE_ID, "Route completed");
537
+ logger.debug(`[ResponseModal] Route ${selectedRoute.title} completed. Entered END_ROUTE step.`);
538
+
539
+ } else {
540
+ // Fallback: No routes defined, generate a simple response
541
+ message = await this.generateFallbackResponse({
542
+ history: historyEvents, // Use Event[] for fallback response
543
+ context: effectiveContext,
544
+ session,
545
+ });
546
+ }
547
+
548
+ return {
549
+ message,
550
+ session,
551
+ toolCalls,
552
+ isRouteComplete,
553
+ };
554
+ }
555
+
556
+ /**
557
+ * Unified streaming response generation
558
+ * @private
559
+ */
560
+ private async *generateUnifiedStreamingResponse(
561
+ responseContext: ResponseContext<TContext, TData>
562
+ ): AsyncGenerator<AgentResponseStreamChunk<TData>> {
563
+ const { effectiveContext, session: initialSession, history, selectedRoute, selectedStep, responseDirectives, isRouteComplete } = responseContext;
564
+ const session = initialSession;
565
+
566
+ // Get last user message (needed for both route and completion handling)
567
+ // Convert HistoryItem[] to Event[] for internal processing
568
+ const historyEvents = historyToEvents(history);
569
+ const lastMessageText = getLastMessageFromHistory(historyEvents);
570
+
571
+ if (selectedRoute && !isRouteComplete) {
572
+ // Handle normal route processing with streaming
573
+ yield* this.processRouteStreamingResponse({
574
+ selectedRoute,
575
+ selectedStep,
576
+ responseDirectives,
577
+ session,
578
+ history,
579
+ context: effectiveContext,
580
+ lastMessageText,
581
+ historyEvents,
582
+ });
583
+
584
+ } else if (isRouteComplete && selectedRoute) {
585
+ // Handle route completion streaming
586
+ yield* this.streamRouteCompletion({
587
+ selectedRoute,
588
+ session,
589
+ context: effectiveContext,
590
+ lastMessageText,
591
+ historyEvents,
592
+ });
593
+
594
+ } else {
595
+ // Fallback: No routes defined, stream a simple response
596
+ yield* this.streamFallbackResponse({
597
+ history: historyEvents, // Use Event[] for fallback response
598
+ context: effectiveContext,
599
+ session,
600
+ });
601
+ }
602
+ }
603
+ /**
604
+ * Execute prepare function for current step if available
605
+ * @private
606
+ */
607
+ private async executeStepPrepare(session: SessionState<TData>, context: TContext): Promise<void> {
608
+ if (session.currentRoute && session.currentStep) {
609
+ const currentRoute = this.agent.getRoutes().find(
610
+ (r) => r.id === session.currentRoute?.id
611
+ );
612
+ if (currentRoute) {
613
+ const currentStep = currentRoute.getStep(session.currentStep.id);
614
+ if (currentStep?.prepare) {
615
+ logger.debug(`[ResponseModal] Executing prepare for step: ${currentStep.id}`);
616
+ await this.executePrepareFinalize(
617
+ currentStep.prepare,
618
+ context,
619
+ session.data,
620
+ currentRoute,
621
+ currentStep
622
+ );
623
+ }
624
+ }
625
+ }
626
+ }
627
+
628
+ /**
629
+ * Execute finalize function for current step if available
630
+ * @private
631
+ */
632
+ private async executeStepFinalize(session: SessionState<TData>, context: TContext): Promise<void> {
633
+ if (session.currentRoute && session.currentStep) {
634
+ const currentRoute = this.agent.getRoutes().find(
635
+ (r) => r.id === session.currentRoute?.id
636
+ );
637
+ if (currentRoute) {
638
+ const currentStep = currentRoute.getStep(session.currentStep.id);
639
+ if (currentStep?.finalize) {
640
+ logger.debug(
641
+ `[ResponseModal] Executing finalize for step: ${currentStep.id}`
642
+ );
643
+ await this.executePrepareFinalize(
644
+ currentStep.finalize,
645
+ context,
646
+ session.data,
647
+ currentRoute,
648
+ currentStep
649
+ );
650
+ }
651
+ }
652
+ }
653
+ }
654
+
655
+ /**
656
+ * Process route response with unified tool execution and data collection
657
+ * @private
658
+ */
659
+ private async processRouteResponse(params: {
660
+ selectedRoute: Route<TContext, TData>;
661
+ selectedStep?: Step<TContext, TData>;
662
+ responseDirectives?: string[];
663
+ session: SessionState<TData>;
664
+ history: HistoryItem[]; // Keep as HistoryItem[] for AI provider compatibility
665
+ context: TContext;
666
+ lastMessageText: string; // String version for buildResponsePrompt
667
+ historyEvents: Event[]; // Event[] version for buildResponsePrompt
668
+ signal?: AbortSignal;
669
+ }): Promise<{
670
+ message: string;
671
+ toolCalls?: Array<{ toolName: string; arguments: Record<string, unknown> }>;
672
+ session: SessionState<TData>;
673
+ }> {
674
+ const { selectedRoute, selectedStep, responseDirectives, history, context, lastMessageText, historyEvents, signal } = params;
675
+ let session = params.session;
676
+
677
+ // Determine next step
678
+ let nextStep: Step<TContext, TData>;
679
+ if (selectedStep) {
680
+ nextStep = selectedStep;
681
+ } else {
682
+ // New route or no step selected - get initial step or first valid step
683
+ const routingEngine = this.agent.getRoutingEngine();
684
+ const candidates = routingEngine.getCandidateSteps(selectedRoute, undefined, session.data || {});
685
+ if (candidates.length > 0) {
686
+ nextStep = candidates[0].step;
687
+ logger.debug(`[ResponseModal] Using first valid step: ${nextStep.id} for new route`);
688
+ } else {
689
+ // Fallback to initial step even if it should be skipped
690
+ nextStep = selectedRoute.initialStep;
691
+ logger.warn(`[ResponseModal] No valid steps found, using initial step: ${nextStep.id}`);
692
+ }
693
+ }
694
+
695
+ // Update session with next step
696
+ session = enterStep(session, nextStep.id, nextStep.description);
697
+ logger.debug(`[ResponseModal] Entered step: ${nextStep.id}`);
698
+
699
+ // Build response schema for this route (with collect fields from step)
700
+ const responseSchema = this.responseEngine.responseSchemaForRoute(selectedRoute, nextStep, this.agent.getSchema());
701
+
702
+ // Build response prompt
703
+ const responsePrompt = await this.responseEngine.buildResponsePrompt({
704
+ route: selectedRoute,
705
+ currentStep: nextStep,
706
+ rules: selectedRoute.getRules(),
707
+ prohibitions: selectedRoute.getProhibitions(),
708
+ directives: responseDirectives,
709
+ history: historyEvents, // Use Event[] for buildResponsePrompt
710
+ lastMessage: lastMessageText, // Use string for buildResponsePrompt
711
+ agentOptions: this.agent.getAgentOptions(),
712
+ combinedGuidelines: [...this.agent.getGuidelines(), ...selectedRoute.getGuidelines()],
713
+ combinedTerms: this.mergeTerms(this.agent.getTerms(), selectedRoute.getTerms()),
714
+ context,
715
+ session,
716
+ agentSchema: this.agent.getSchema(),
717
+ });
718
+
719
+ // Collect available tools for AI
720
+ const availableTools = this.collectAvailableTools(selectedRoute, nextStep);
721
+
722
+ // Generate message using AI provider
723
+ const agentOptions = this.agent.getAgentOptions();
724
+ const result = await agentOptions.provider.generateMessage({
725
+ prompt: responsePrompt,
726
+ history: historyEvents, // Use Event[] for AI provider
727
+ context,
728
+ tools: availableTools,
729
+ signal,
730
+ parameters: responseSchema ? { jsonSchema: responseSchema, schemaName: "response_output" } : undefined,
731
+ });
732
+
733
+ let message = result.structured?.message || result.message;
734
+ let toolCalls = result.structured?.toolCalls;
735
+
736
+ // Execute tools with unified loop handling
737
+ const toolResult = await this.executeUnifiedToolLoop({
738
+ toolCalls,
739
+ context,
740
+ session,
741
+ history,
742
+ selectedRoute,
743
+ responsePrompt,
744
+ availableTools,
745
+ responseSchema,
746
+ signal,
747
+ });
748
+
749
+ session = toolResult.session;
750
+ toolCalls = toolResult.finalToolCalls;
751
+ if (toolResult.finalMessage) {
752
+ message = toolResult.finalMessage;
753
+ }
754
+
755
+ // Collect data from response
756
+ session = await this.collectDataFromResponse({ result, selectedRoute, nextStep, session });
757
+
758
+ return { message, toolCalls, session };
759
+ }
760
+
761
+ /**
762
+ * Process route streaming response with unified tool execution and data collection
763
+ * @private
764
+ */
765
+ private async *processRouteStreamingResponse(params: {
766
+ selectedRoute: Route<TContext, TData>;
767
+ selectedStep?: Step<TContext, TData>;
768
+ responseDirectives?: string[];
769
+ session: SessionState<TData>;
770
+ history: HistoryItem[];
771
+ context: TContext;
772
+ lastMessageText: string; // String version for buildResponsePrompt
773
+ historyEvents: Event[]; // Event[] version for buildResponsePrompt
774
+ signal?: AbortSignal;
775
+ }): AsyncGenerator<AgentResponseStreamChunk<TData>> {
776
+ const { selectedRoute, selectedStep, responseDirectives, history, context, lastMessageText, historyEvents, signal } = params;
777
+ let session = params.session;
778
+
779
+ // Determine next step (same logic as non-streaming)
780
+ let nextStep: Step<TContext, TData>;
781
+ if (selectedStep) {
782
+ nextStep = selectedStep;
783
+ } else {
784
+ const routingEngine = this.agent.getRoutingEngine();
785
+ const candidates = routingEngine.getCandidateSteps(selectedRoute, undefined, session.data || {});
786
+ if (candidates.length > 0) {
787
+ nextStep = candidates[0].step;
788
+ logger.debug(`[ResponseModal] Using first valid step: ${nextStep.id} for new route`);
789
+ } else {
790
+ nextStep = selectedRoute.initialStep;
791
+ logger.warn(`[ResponseModal] No valid steps found, using initial step: ${nextStep.id}`);
792
+ }
793
+ }
794
+
795
+ // Update session with next step
796
+ session = enterStep(session, nextStep.id, nextStep.description);
797
+ logger.debug(`[ResponseModal] Entered step: ${nextStep.id}`);
798
+
799
+ // Build response schema and prompt (same as non-streaming)
800
+ const responseSchema = this.responseEngine.responseSchemaForRoute(selectedRoute, nextStep, this.agent.getSchema());
801
+ const responsePrompt = await this.responseEngine.buildResponsePrompt({
802
+ route: selectedRoute,
803
+ currentStep: nextStep,
804
+ rules: selectedRoute.getRules(),
805
+ prohibitions: selectedRoute.getProhibitions(),
806
+ directives: responseDirectives,
807
+ history: historyEvents, // Use Event[] for buildResponsePrompt
808
+ lastMessage: lastMessageText, // Use string for buildResponsePrompt
809
+ agentOptions: this.agent.getAgentOptions(),
810
+ combinedGuidelines: [...this.agent.getGuidelines(), ...selectedRoute.getGuidelines()],
811
+ combinedTerms: this.mergeTerms(this.agent.getTerms(), selectedRoute.getTerms()),
812
+ context,
813
+ session,
814
+ agentSchema: this.agent.getSchema(),
815
+ });
816
+
817
+ // Collect available tools for AI
818
+ const availableTools = this.collectAvailableTools(selectedRoute, nextStep);
819
+
820
+ // Generate message stream using AI provider
821
+ const agentOptions = this.agent.getAgentOptions();
822
+ const stream = agentOptions.provider.generateMessageStream({
823
+ prompt: responsePrompt,
824
+ history: historyEvents, // Use Event[] for AI provider
825
+ context,
826
+ tools: availableTools,
827
+ signal,
828
+ parameters: { jsonSchema: responseSchema, schemaName: "response_stream_output" },
829
+ });
830
+
831
+ // Stream chunks with unified tool handling
832
+ for await (const chunk of stream) {
833
+ let toolCalls: Array<{ toolName: string; arguments: Record<string, unknown> }> | undefined = undefined;
834
+
835
+ // Extract tool calls from AI response on final chunk
836
+ if (chunk.done && chunk.structured?.toolCalls) {
837
+ toolCalls = chunk.structured.toolCalls;
838
+
839
+ // Execute tools with unified loop handling
840
+ const toolResult = await this.executeUnifiedToolLoop({
841
+ toolCalls,
842
+ context,
843
+ session,
844
+ history,
845
+ selectedRoute,
846
+ responsePrompt,
847
+ availableTools,
848
+ responseSchema,
849
+ signal,
850
+ });
851
+
852
+ session = toolResult.session;
853
+ toolCalls = toolResult.finalToolCalls;
854
+ }
855
+
856
+ // Extract collected data on final chunk
857
+ if (chunk.done && chunk.structured && nextStep.collect) {
858
+ session = await this.collectDataFromResponse({
859
+ result: { structured: chunk.structured },
860
+ selectedRoute,
861
+ nextStep,
862
+ session,
863
+ });
864
+ }
865
+
866
+ // Handle session finalization on final chunk
867
+ if (chunk.done) {
868
+ await this.finalizeSession(session, context);
869
+ }
870
+
871
+ yield {
872
+ delta: chunk.delta,
873
+ accumulated: chunk.accumulated,
874
+ done: chunk.done,
875
+ session,
876
+ toolCalls,
877
+ isRouteComplete: false,
878
+ metadata: chunk.metadata,
879
+ structured: chunk.structured,
880
+ };
881
+ }
882
+ }
883
+
884
+ /**
885
+ * Unified tool execution logic with loop handling
886
+ * Consolidates the complex tool execution logic from both streaming and non-streaming responses
887
+ * @private
888
+ */
889
+ private async executeUnifiedToolLoop(params: {
890
+ toolCalls?: Array<{ toolName: string; arguments: Record<string, unknown> }>;
891
+ context: TContext;
892
+ session: SessionState<TData>;
893
+ history: HistoryItem[];
894
+ selectedRoute?: Route<TContext, TData>;
895
+ responsePrompt: string;
896
+ availableTools: Array<{
897
+ id: string;
898
+ name: string;
899
+ description?: string;
900
+ parameters?: unknown;
901
+ }>;
902
+ responseSchema?: Record<string, unknown>;
903
+ signal?: AbortSignal;
904
+ }): Promise<{
905
+ session: SessionState<TData>;
906
+ finalToolCalls?: Array<{ toolName: string; arguments: Record<string, unknown> }>;
907
+ finalMessage?: string;
908
+ }> {
909
+ try {
910
+ const { context, history, selectedRoute, responsePrompt, availableTools, responseSchema, signal } = params;
911
+ let { toolCalls, session } = params;
912
+
913
+ // Convert HistoryItem[] to Event[] for internal processing
914
+ const historyEvents = historyToEvents(history);
915
+
916
+ // Execute initial dynamic tool calls
917
+ if (toolCalls && toolCalls.length > 0) {
918
+ logger.debug(`[ResponseModal] Executing ${toolCalls.length} dynamic tool calls`);
919
+
920
+ for (const toolCall of toolCalls) {
921
+ const tool = this.findAvailableTool(toolCall.toolName, selectedRoute);
922
+ if (!tool) {
923
+ logger.warn(`[ResponseModal] Tool not found: ${toolCall.toolName}`);
924
+ continue;
925
+ }
926
+
927
+ try {
928
+ const toolExecutor = new ToolExecutor<TContext, TData>();
929
+ const toolResult = await toolExecutor.executeTool({
930
+ tool: tool,
931
+ context,
932
+ updateContext: this.agent.updateContext.bind(this.agent),
933
+ updateData: this.agent.updateCollectedData.bind(this.agent),
934
+ history: historyEvents, // Use Event[] for tool execution
935
+ data: session.data,
936
+ toolArguments: toolCall.arguments,
937
+ });
938
+
939
+ // Check if tool execution was successful
940
+ if (!toolResult.success) {
941
+ logger.error(`[ResponseModal] Tool execution failed: ${toolCall.toolName} - ${toolResult.error}`);
942
+ // Continue with other tools rather than failing completely
943
+ continue;
944
+ }
945
+
946
+ // Update context with tool results
947
+ if (toolResult.contextUpdate) {
948
+ try {
949
+ await this.agent.updateContext(toolResult.contextUpdate as Partial<TContext>);
950
+ } catch (error) {
951
+ logger.error(`[ResponseModal] Failed to update context from tool ${toolCall.toolName}:`, error);
952
+ // Continue execution but log the error
953
+ }
954
+ }
955
+
956
+ // Update collected data with tool results
957
+ if (toolResult.dataUpdate) {
958
+ try {
959
+ const updateDataMethod = this.agent.getUpdateDataMethod();
960
+ session = await updateDataMethod(session, toolResult.dataUpdate as Partial<TData>);
961
+ logger.debug(`[ResponseModal] Tool updated collected data:`, toolResult.dataUpdate);
962
+ } catch (error) {
963
+ logger.error(`[ResponseModal] Failed to update data from tool ${toolCall.toolName}:`, error);
964
+ // Continue execution but log the error
965
+ }
966
+ }
967
+
968
+ logger.debug(`[ResponseModal] Executed dynamic tool: ${toolResult.toolName} (success: ${toolResult.success})`);
969
+ } catch (error) {
970
+ logger.error(`[ResponseModal] Tool execution error for ${toolCall.toolName}:`, error);
971
+ // Continue with other tools rather than failing the entire response
972
+ continue;
973
+ }
974
+ }
975
+ }
976
+
977
+ // TOOL LOOP: Allow AI to make follow-up tool calls after initial tool execution
978
+ const MAX_TOOL_LOOPS = this.options?.maxToolLoops || 5;
979
+ let toolLoopCount = 0;
980
+ let hasToolCalls = toolCalls && toolCalls.length > 0;
981
+ let finalMessage: string | undefined;
982
+
983
+ while (hasToolCalls && toolLoopCount < MAX_TOOL_LOOPS) {
984
+ toolLoopCount++;
985
+ logger.debug(`[ResponseModal] Starting tool loop ${toolLoopCount}/${MAX_TOOL_LOOPS}`);
986
+
987
+ // Create tool result events with proper Event format structure
988
+ const toolResultEvents: Event<ToolEventData>[] = [];
989
+ for (const toolCall of toolCalls || []) {
990
+ const tool = this.findAvailableTool(toolCall.toolName, selectedRoute);
991
+ if (tool) {
992
+ // Create proper Event format for tool results
993
+ const toolResultEvent: Event<ToolEventData> = {
994
+ kind: EventKind.TOOL,
995
+ source: MessageRole.AGENT,
996
+ timestamp: new Date().toISOString(),
997
+ data: {
998
+ tool_calls: [
999
+ {
1000
+ tool_id: toolCall.toolName,
1001
+ arguments: toolCall.arguments,
1002
+ result: {
1003
+ data: "Tool executed successfully",
1004
+ },
1005
+ },
1006
+ ],
1007
+ },
1008
+ };
1009
+ toolResultEvents.push(toolResultEvent);
1010
+ }
1011
+ }
1012
+
1013
+ // Create updated history with tool results (combine Event arrays)
1014
+ const updatedHistoryEvents = [...historyEvents, ...toolResultEvents];
1015
+
1016
+ // Make follow-up AI call to see if more tools are needed
1017
+ const agentOptions = this.agent.getAgentOptions();
1018
+ const followUpResult = await agentOptions.provider.generateMessage({
1019
+ prompt: responsePrompt,
1020
+ history: updatedHistoryEvents, // Use Event[] for AI provider
1021
+ context,
1022
+ tools: availableTools,
1023
+ parameters: responseSchema ? {
1024
+ jsonSchema: responseSchema,
1025
+ schemaName: "tool_followup",
1026
+ } : undefined,
1027
+ signal,
1028
+ });
1029
+
1030
+ // Check if follow-up call has more tool calls
1031
+ const followUpToolCalls = followUpResult.structured?.toolCalls;
1032
+ hasToolCalls = followUpToolCalls && followUpToolCalls.length > 0;
1033
+
1034
+ if (hasToolCalls) {
1035
+ logger.debug(`[ResponseModal] Follow-up call produced ${followUpToolCalls!.length} additional tool calls`);
1036
+
1037
+ // Execute the follow-up tool calls
1038
+ for (const toolCall of followUpToolCalls!) {
1039
+ const tool = this.findAvailableTool(toolCall.toolName, selectedRoute);
1040
+ if (!tool) {
1041
+ logger.warn(`[ResponseModal] Tool not found in follow-up: ${toolCall.toolName}`);
1042
+ continue;
1043
+ }
1044
+
1045
+ try {
1046
+ const toolExecutor = new ToolExecutor<TContext, TData>();
1047
+ const toolResult = await toolExecutor.executeTool({
1048
+ tool: tool,
1049
+ context,
1050
+ updateContext: this.agent.updateContext.bind(this.agent),
1051
+ updateData: this.agent.updateCollectedData.bind(this.agent),
1052
+ history: updatedHistoryEvents, // Use Event[] for tool execution
1053
+ data: session.data,
1054
+ toolArguments: toolCall.arguments,
1055
+ });
1056
+
1057
+ // Check if tool execution was successful
1058
+ if (!toolResult.success) {
1059
+ logger.error(`[ResponseModal] Follow-up tool execution failed: ${toolCall.toolName} - ${toolResult.error}`);
1060
+ continue;
1061
+ }
1062
+
1063
+ // Update context with follow-up tool results
1064
+ if (toolResult.contextUpdate) {
1065
+ try {
1066
+ await this.agent.updateContext(toolResult.contextUpdate as Partial<TContext>);
1067
+ } catch (error) {
1068
+ logger.error(`[ResponseModal] Failed to update context from follow-up tool ${toolCall.toolName}:`, error);
1069
+ }
1070
+ }
1071
+
1072
+ if (toolResult.dataUpdate) {
1073
+ try {
1074
+ const updateDataMethod = this.agent.getUpdateDataMethod();
1075
+ session = await updateDataMethod(session, toolResult.dataUpdate as Partial<TData>);
1076
+ logger.debug(`[ResponseModal] Follow-up tool updated collected data:`, toolResult.dataUpdate);
1077
+ } catch (error) {
1078
+ logger.error(`[ResponseModal] Failed to update data from follow-up tool ${toolCall.toolName}:`, error);
1079
+ }
1080
+ }
1081
+
1082
+ logger.debug(`[ResponseModal] Executed follow-up tool: ${toolResult.toolName} (success: ${toolResult.success})`);
1083
+ } catch (error) {
1084
+ logger.error(`[ResponseModal] Follow-up tool execution error for ${toolCall.toolName}:`, error);
1085
+ continue;
1086
+ }
1087
+ }
1088
+
1089
+ // Update toolCalls for next iteration or final response
1090
+ toolCalls = followUpToolCalls;
1091
+ } else {
1092
+ logger.debug(`[ResponseModal] Tool loop completed after ${toolLoopCount} iterations`);
1093
+ // Update final message and toolCalls from follow-up result if no more tools
1094
+ finalMessage = followUpResult.structured?.message || followUpResult.message;
1095
+ toolCalls = followUpToolCalls || [];
1096
+ break;
1097
+ }
1098
+ }
1099
+
1100
+ if (toolLoopCount >= MAX_TOOL_LOOPS) {
1101
+ logger.warn(`[ResponseModal] Tool loop limit reached (${MAX_TOOL_LOOPS}), stopping`);
1102
+ }
1103
+
1104
+ return {
1105
+ session,
1106
+ finalToolCalls: toolCalls,
1107
+ finalMessage,
1108
+ };
1109
+ } catch (error) {
1110
+ throw ResponseGenerationError.fromError(error, 'tool_execution', params, {
1111
+ toolCallsCount: params.toolCalls?.length || 0,
1112
+ availableToolsCount: params.availableTools.length
1113
+ });
1114
+ }
1115
+ } /**
1116
+ * Unified data collection from AI response
1117
+ * @private
1118
+ */
1119
+ private async collectDataFromResponse(params: {
1120
+ result: { structured?: AgentStructuredResponse };
1121
+ selectedRoute?: Route<TContext, TData>;
1122
+ nextStep?: Step<TContext, TData>;
1123
+ session: SessionState<TData>;
1124
+ }): Promise<SessionState<TData>> {
1125
+ try {
1126
+ const { result, selectedRoute, nextStep, session } = params;
1127
+ let updatedSession = session;
1128
+
1129
+ // Extract collected data from final response (only for route-based interactions)
1130
+ if (selectedRoute && result.structured && nextStep?.collect) {
1131
+ try {
1132
+ const collectedData: Record<string, unknown> = {};
1133
+ // AgentStructuredResponse extends Record<string, unknown>, so we can safely access properties
1134
+ const structuredData = result.structured;
1135
+
1136
+ for (const field of nextStep.collect) {
1137
+ const fieldKey = String(field);
1138
+ if (fieldKey in structuredData) {
1139
+ collectedData[fieldKey] = structuredData[fieldKey];
1140
+ }
1141
+ }
1142
+
1143
+ // Merge collected data into session using agent-level data validation
1144
+ if (Object.keys(collectedData).length > 0) {
1145
+ try {
1146
+ // Update agent-level collected data with validation
1147
+ await this.agent.updateCollectedData(collectedData as Partial<TData>);
1148
+
1149
+ // Update session with validated data
1150
+ const updateDataMethod = this.agent.getUpdateDataMethod();
1151
+ updatedSession = await updateDataMethod(updatedSession, collectedData as Partial<TData>);
1152
+ logger.debug(`[ResponseModal] Collected data:`, collectedData);
1153
+ } catch (error) {
1154
+ logger.error(`[ResponseModal] Failed to update collected data:`, error);
1155
+ // Continue without updating data rather than failing completely
1156
+ }
1157
+ }
1158
+ } catch (error) {
1159
+ logger.error(`[ResponseModal] Error during data collection:`, error);
1160
+ // Continue without collecting data rather than failing completely
1161
+ }
1162
+ }
1163
+
1164
+ // Extract any additional data from structured response
1165
+ // Since AgentStructuredResponse extends Record<string, unknown>, we can safely check for additional properties
1166
+ if (result.structured && "contextUpdate" in result.structured) {
1167
+ try {
1168
+ const contextUpdate = (result.structured as AgentStructuredResponse & { contextUpdate?: Partial<TContext> }).contextUpdate;
1169
+ if (contextUpdate) {
1170
+ await this.agent.updateContext(contextUpdate);
1171
+ }
1172
+ } catch (error) {
1173
+ logger.error(`[ResponseModal] Failed to update context from structured response:`, error);
1174
+ // Continue without updating context rather than failing completely
1175
+ }
1176
+ }
1177
+
1178
+ return updatedSession;
1179
+ } catch (error) {
1180
+ logger.error(`[ResponseModal] Error in collectDataFromResponse:`, error);
1181
+ // Return original session if data collection fails completely
1182
+ return params.session;
1183
+ }
1184
+ }
1185
+
1186
+ /**
1187
+ * Handle route completion logic
1188
+ * @private
1189
+ */
1190
+ private async handleRouteCompletion(params: {
1191
+ selectedRoute: Route<TContext, TData>;
1192
+ session: SessionState<TData>;
1193
+ context: TContext;
1194
+ lastMessageText: string; // String version for buildResponsePrompt
1195
+ historyEvents: Event[]; // Event[] version for buildResponsePrompt
1196
+ signal?: AbortSignal;
1197
+ }): Promise<string> {
1198
+ const { selectedRoute, session, context, lastMessageText, historyEvents, signal } = params;
1199
+
1200
+ // Get endStep spec from route
1201
+ const endStepSpec = selectedRoute.endStepSpec;
1202
+
1203
+ // Create a temporary step for completion message generation using endStep configuration
1204
+ const completionStep = new Step<TContext, TData>(selectedRoute.id, {
1205
+ description: endStepSpec.description,
1206
+ id: endStepSpec.id || END_ROUTE_ID,
1207
+ collect: endStepSpec.collect,
1208
+ requires: endStepSpec.requires,
1209
+ prompt: endStepSpec.prompt || "Summarize what was accomplished and confirm completion based on the conversation history and collected data",
1210
+ });
1211
+
1212
+ // Build response schema for completion
1213
+ const responseSchema = this.responseEngine.responseSchemaForRoute(selectedRoute, completionStep, this.agent.getSchema());
1214
+ const templateContext = { context, session, history: historyEvents }; // Use Event[] for template context
1215
+
1216
+ // Build completion response prompt
1217
+ const completionPrompt = await this.responseEngine.buildResponsePrompt({
1218
+ route: selectedRoute,
1219
+ currentStep: completionStep,
1220
+ rules: selectedRoute.getRules(),
1221
+ prohibitions: selectedRoute.getProhibitions(),
1222
+ directives: undefined, // No directives for completion
1223
+ history: historyEvents, // Use Event[] for buildResponsePrompt
1224
+ lastMessage: lastMessageText, // Use string for buildResponsePrompt
1225
+ agentOptions: this.agent.getAgentOptions(),
1226
+ combinedGuidelines: [...this.agent.getGuidelines(), ...selectedRoute.getGuidelines()],
1227
+ combinedTerms: this.mergeTerms(this.agent.getTerms(), selectedRoute.getTerms()),
1228
+ context,
1229
+ session,
1230
+ agentSchema: this.agent.getSchema(),
1231
+ });
1232
+
1233
+ // Generate completion message using AI provider
1234
+ const agentOptions = this.agent.getAgentOptions();
1235
+ const completionResult = await agentOptions.provider.generateMessage({
1236
+ prompt: completionPrompt,
1237
+ history: historyEvents, // Use Event[] for AI provider
1238
+ context,
1239
+ signal,
1240
+ parameters: { jsonSchema: responseSchema, schemaName: "completion_message" },
1241
+ });
1242
+
1243
+ const message = completionResult.structured?.message || completionResult.message;
1244
+ logger.debug(`[ResponseModal] Generated completion message for route: ${selectedRoute.title}`);
1245
+
1246
+ // Check for onComplete transition
1247
+ const transitionConfig = await selectedRoute.evaluateOnComplete({ data: session.data }, context);
1248
+
1249
+ if (transitionConfig) {
1250
+ // Find target route by ID or title
1251
+ const targetRoute = this.agent.getRoutes().find(
1252
+ (r) => r.id === transitionConfig.nextStep || r.title === transitionConfig.nextStep
1253
+ );
1254
+
1255
+ if (targetRoute) {
1256
+ const renderedCondition = await render(transitionConfig.condition, templateContext);
1257
+ // Set pending transition in session
1258
+ session.pendingTransition = {
1259
+ targetRouteId: targetRoute.id,
1260
+ condition: renderedCondition,
1261
+ reason: "route_complete",
1262
+ };
1263
+ logger.debug(`[ResponseModal] Route ${selectedRoute.title} completed with pending transition to: ${targetRoute.title}`);
1264
+ } else {
1265
+ logger.warn(`[ResponseModal] Route ${selectedRoute.title} completed but target route not found: ${transitionConfig.nextStep}`);
1266
+ }
1267
+ }
1268
+
1269
+ return message;
1270
+ }
1271
+
1272
+ /**
1273
+ * Stream route completion response
1274
+ * @private
1275
+ */
1276
+ private async *streamRouteCompletion(params: {
1277
+ selectedRoute: Route<TContext, TData>;
1278
+ session: SessionState<TData>;
1279
+ context: TContext;
1280
+ lastMessageText: string; // String version for buildResponsePrompt
1281
+ historyEvents: Event[]; // Event[] version for buildResponsePrompt
1282
+ signal?: AbortSignal;
1283
+ }): AsyncGenerator<AgentResponseStreamChunk<TData>> {
1284
+ const { selectedRoute, context, lastMessageText, historyEvents, signal } = params;
1285
+ let session = params.session;
1286
+
1287
+ // Get endStep spec from route
1288
+ const endStepSpec = selectedRoute.endStepSpec;
1289
+
1290
+ // Create a temporary step for completion message generation using endStep configuration
1291
+ const completionStep = new Step<TContext, TData>(selectedRoute.id, {
1292
+ description: endStepSpec.description,
1293
+ id: endStepSpec.id || END_ROUTE_ID,
1294
+ collect: endStepSpec.collect,
1295
+ requires: endStepSpec.requires,
1296
+ prompt: endStepSpec.prompt || "Summarize what was accomplished and confirm completion based on the conversation history and collected data",
1297
+ });
1298
+
1299
+ // Build response schema for completion
1300
+ const responseSchema = this.responseEngine.responseSchemaForRoute(selectedRoute, completionStep, this.agent.getSchema());
1301
+ const templateContext = { context, session, history: historyEvents }; // Use Event[] for template context
1302
+
1303
+ // Build completion response prompt
1304
+ const completionPrompt = await this.responseEngine.buildResponsePrompt({
1305
+ route: selectedRoute,
1306
+ currentStep: completionStep,
1307
+ rules: selectedRoute.getRules(),
1308
+ prohibitions: selectedRoute.getProhibitions(),
1309
+ directives: undefined, // No directives for completion
1310
+ history: historyEvents, // Use Event[] for buildResponsePrompt
1311
+ lastMessage: lastMessageText, // Use string for buildResponsePrompt
1312
+ agentOptions: this.agent.getAgentOptions(),
1313
+ combinedGuidelines: [...this.agent.getGuidelines(), ...selectedRoute.getGuidelines()],
1314
+ combinedTerms: this.mergeTerms(this.agent.getTerms(), selectedRoute.getTerms()),
1315
+ context,
1316
+ session,
1317
+ agentSchema: this.agent.getSchema(),
1318
+ });
1319
+
1320
+ // Stream completion message using AI provider
1321
+ const agentOptions = this.agent.getAgentOptions();
1322
+ const stream = agentOptions.provider.generateMessageStream({
1323
+ prompt: completionPrompt,
1324
+ history: historyEvents, // Use Event[] for AI provider
1325
+ context,
1326
+ signal,
1327
+ parameters: { jsonSchema: responseSchema, schemaName: "completion_message_stream" },
1328
+ });
1329
+
1330
+ logger.debug(`[ResponseModal] Streaming completion message for route: ${selectedRoute.title}`);
1331
+
1332
+ // Check for onComplete transition
1333
+ const transitionConfig = await selectedRoute.evaluateOnComplete({ data: session.data }, context);
1334
+
1335
+ if (transitionConfig) {
1336
+ // Find target route by ID or title
1337
+ const targetRoute = this.agent.getRoutes().find(
1338
+ (r) => r.id === transitionConfig.nextStep || r.title === transitionConfig.nextStep
1339
+ );
1340
+
1341
+ if (targetRoute) {
1342
+ const renderedCondition = await render(transitionConfig.condition, templateContext);
1343
+ // Set pending transition in session
1344
+ session = {
1345
+ ...session,
1346
+ pendingTransition: {
1347
+ targetRouteId: targetRoute.id,
1348
+ condition: renderedCondition,
1349
+ reason: "route_complete",
1350
+ },
1351
+ };
1352
+ logger.debug(`[ResponseModal] Route ${selectedRoute.title} completed with pending transition to: ${targetRoute.title}`);
1353
+ } else {
1354
+ logger.warn(`[ResponseModal] Route ${selectedRoute.title} completed but target route not found: ${transitionConfig.nextStep}`);
1355
+ }
1356
+ }
1357
+
1358
+ // Set step to END_ROUTE marker
1359
+ session = enterStep(session, END_ROUTE_ID, "Route completed");
1360
+ logger.debug(`[ResponseModal] Route ${selectedRoute.title} completed. Entered END_ROUTE step.`);
1361
+
1362
+ // Stream completion chunks
1363
+ for await (const chunk of stream) {
1364
+ // Update current session if we have one
1365
+ if (chunk.done) {
1366
+ await this.finalizeSession(session, context);
1367
+ }
1368
+
1369
+ yield {
1370
+ delta: chunk.delta,
1371
+ accumulated: chunk.accumulated,
1372
+ done: chunk.done,
1373
+ session,
1374
+ toolCalls: undefined,
1375
+ isRouteComplete: true,
1376
+ metadata: chunk.metadata,
1377
+ structured: chunk.structured,
1378
+ };
1379
+ }
1380
+ }
1381
+
1382
+ /**
1383
+ * Generate fallback response when no routes are available
1384
+ * @private
1385
+ */
1386
+ private async generateFallbackResponse(params: {
1387
+ history: Event[]; // Use Event[] for buildFallbackPrompt
1388
+ context: TContext;
1389
+ session: SessionState<TData>;
1390
+ signal?: AbortSignal;
1391
+ }): Promise<string> {
1392
+ const { history, context, session, signal } = params;
1393
+
1394
+ logger.debug(`[ResponseModal] No route selected, generating basic response`);
1395
+
1396
+ // Build basic response prompt without route context
1397
+ const fallbackPrompt = await this.responseEngine.buildFallbackPrompt({
1398
+ history,
1399
+ agentOptions: this.agent.getAgentOptions(),
1400
+ terms: this.agent.getTerms(),
1401
+ guidelines: this.agent.getGuidelines(),
1402
+ context,
1403
+ session,
1404
+ });
1405
+
1406
+ const agentOptions = this.agent.getAgentOptions();
1407
+ const result = await agentOptions.provider.generateMessage({
1408
+ prompt: fallbackPrompt,
1409
+ history,
1410
+ context,
1411
+ signal,
1412
+ parameters: {
1413
+ jsonSchema: {
1414
+ type: "object",
1415
+ properties: { message: { type: "string" } },
1416
+ required: ["message"],
1417
+ additionalProperties: false,
1418
+ },
1419
+ schemaName: "fallback_response",
1420
+ },
1421
+ });
1422
+
1423
+ return result.structured?.message || result.message;
1424
+ }
1425
+
1426
+ /**
1427
+ * Stream fallback response when no routes are available
1428
+ * @private
1429
+ */
1430
+ private async *streamFallbackResponse(params: {
1431
+ history: Event[]; // Use Event[] for buildFallbackPrompt
1432
+ context: TContext;
1433
+ session: SessionState<TData>;
1434
+ signal?: AbortSignal;
1435
+ }): AsyncGenerator<AgentResponseStreamChunk<TData>> {
1436
+ const { history, context, session, signal } = params;
1437
+
1438
+ const fallbackPrompt = await this.responseEngine.buildFallbackPrompt({
1439
+ history,
1440
+ agentOptions: this.agent.getAgentOptions(),
1441
+ terms: this.agent.getTerms(),
1442
+ guidelines: this.agent.getGuidelines(),
1443
+ context,
1444
+ session,
1445
+ });
1446
+
1447
+ const agentOptions = this.agent.getAgentOptions();
1448
+ const stream = agentOptions.provider.generateMessageStream({
1449
+ prompt: fallbackPrompt,
1450
+ history,
1451
+ context,
1452
+ signal,
1453
+ parameters: {
1454
+ jsonSchema: {
1455
+ type: "object",
1456
+ properties: { message: { type: "string" } },
1457
+ required: ["message"],
1458
+ additionalProperties: false,
1459
+ },
1460
+ schemaName: "fallback_stream_response",
1461
+ },
1462
+ });
1463
+
1464
+ for await (const chunk of stream) {
1465
+ // Update current session if we have one
1466
+ if (chunk.done) {
1467
+ await this.finalizeSession(session, context);
1468
+ }
1469
+
1470
+ yield {
1471
+ delta: chunk.delta,
1472
+ accumulated: chunk.accumulated,
1473
+ done: chunk.done,
1474
+ session,
1475
+ toolCalls: undefined,
1476
+ isRouteComplete: false,
1477
+ metadata: chunk.metadata,
1478
+ structured: chunk.structured,
1479
+ };
1480
+ }
1481
+ }
1482
+
1483
+ /**
1484
+ * Handle session persistence and finalization
1485
+ * @private
1486
+ */
1487
+ private async finalizeSession(session: SessionState<TData>, context: TContext): Promise<void> {
1488
+ // Auto-save session step to persistence if configured
1489
+ const persistenceManager = this.agent.getPersistenceManager();
1490
+ const agentOptions = this.agent.getAgentOptions();
1491
+ if (
1492
+ persistenceManager &&
1493
+ session.id &&
1494
+ (this.options?.enableAutoSave !== false && agentOptions.persistence?.autoSave !== false)
1495
+ ) {
1496
+ await persistenceManager.saveSessionState(session.id, session);
1497
+ logger.debug(`[ResponseModal] Auto-saved session step to persistence: ${session.id}`);
1498
+ }
1499
+
1500
+ // Execute finalize function
1501
+ await this.executeStepFinalize(session, context);
1502
+
1503
+ // Update current session if we have one
1504
+ const currentSession = this.agent.getCurrentSession();
1505
+ if (currentSession) {
1506
+ this.agent.setCurrentSession(session);
1507
+ }
1508
+ }
1509
+ // ============================================================================
1510
+ // UTILITY METHODS - Helper methods for tool management and other utilities
1511
+ // ============================================================================
1512
+
1513
+ /**
1514
+ * Find an available tool by name for the given route
1515
+ * Route-level tools take precedence over agent-level tools
1516
+ * @private
1517
+ */
1518
+ private findAvailableTool(
1519
+ toolName: string,
1520
+ route?: Route<TContext, TData>
1521
+ ): Tool<TContext, TData, unknown[], unknown> | undefined {
1522
+ // Check route-level tools first (if route provided)
1523
+ if (route) {
1524
+ const routeTool = route
1525
+ .getTools()
1526
+ .find((tool: Tool<TContext, TData, unknown[], unknown>) => tool.id === toolName || tool.name === toolName);
1527
+ if (routeTool) return routeTool;
1528
+ }
1529
+
1530
+ // Fall back to agent-level tools
1531
+ const agentTools = this.agent.getTools();
1532
+ return agentTools.find(
1533
+ (tool) => tool.id === toolName || tool.name === toolName
1534
+ );
1535
+ }
1536
+
1537
+ /**
1538
+ * Collect all available tools for the given route and step context
1539
+ * @private
1540
+ */
1541
+ private collectAvailableTools(
1542
+ route?: Route<TContext, TData>,
1543
+ step?: Step<TContext, TData>
1544
+ ): Array<{
1545
+ id: string;
1546
+ name: string;
1547
+ description?: string;
1548
+ parameters?: unknown;
1549
+ }> {
1550
+ const availableTools = new Map<string, Tool<TContext, TData, unknown[], unknown>>();
1551
+
1552
+ // Add agent-level tools
1553
+ this.agent.getTools().forEach((tool) => {
1554
+ availableTools.set(tool.id, tool);
1555
+ });
1556
+
1557
+ // Add route-level tools (these take precedence)
1558
+ if (route) {
1559
+ route.getTools().forEach((tool: Tool<TContext, TData, unknown[], unknown>) => {
1560
+ availableTools.set(tool.id, tool);
1561
+ });
1562
+ }
1563
+
1564
+ // Filter by step-level allowed tools if specified
1565
+ if (step?.tools) {
1566
+ const allowedToolIds = new Set<string>();
1567
+ const stepTools: Tool<TContext, TData, unknown[], unknown>[] = [];
1568
+
1569
+ for (const toolRef of step.tools) {
1570
+ if (typeof toolRef === "string") {
1571
+ // Reference to registered tool
1572
+ allowedToolIds.add(toolRef);
1573
+ } else {
1574
+ // Inline tool definition
1575
+ if (toolRef.id) {
1576
+ allowedToolIds.add(toolRef.id);
1577
+ stepTools.push(toolRef);
1578
+ }
1579
+ }
1580
+ }
1581
+
1582
+ // If step specifies tools, only include those
1583
+ if (allowedToolIds.size > 0) {
1584
+ const filteredTools = new Map<string, Tool<TContext, TData, unknown[], unknown>>();
1585
+ for (const toolId of Array.from(allowedToolIds)) {
1586
+ const tool = availableTools.get(toolId);
1587
+ if (tool) {
1588
+ filteredTools.set(toolId, tool);
1589
+ }
1590
+ }
1591
+ // Add inline tools
1592
+ stepTools.forEach((tool) => {
1593
+ if (tool.id) {
1594
+ filteredTools.set(tool.id, tool);
1595
+ }
1596
+ });
1597
+ availableTools.clear();
1598
+ filteredTools.forEach((tool, id) => availableTools.set(id, tool));
1599
+ }
1600
+ }
1601
+
1602
+ // Convert to the format expected by AI providers
1603
+ return Array.from(availableTools.values()).map((tool) => ({
1604
+ id: tool.id,
1605
+ name: tool.name || tool.id,
1606
+ description: tool.description,
1607
+ parameters: tool.parameters,
1608
+ }));
1609
+ }
1610
+
1611
+ /**
1612
+ * Execute a prepare or finalize function/tool
1613
+ * @private
1614
+ */
1615
+ private async executePrepareFinalize(
1616
+ prepareOrFinalize:
1617
+ | string
1618
+ | Tool<TContext, TData, unknown[], unknown>
1619
+ | ((context: TContext, data?: Partial<TData>) => void | Promise<void>)
1620
+ | undefined,
1621
+ context: TContext,
1622
+ data?: Partial<TData>,
1623
+ route?: Route<TContext, TData>,
1624
+ step?: Step<TContext, TData>
1625
+ ): Promise<void> {
1626
+ if (!prepareOrFinalize) return;
1627
+
1628
+ if (typeof prepareOrFinalize === "function") {
1629
+ // It's a function - call it directly
1630
+ await prepareOrFinalize(context, data);
1631
+ } else {
1632
+ // It's a tool reference - find and execute the tool
1633
+ let tool: Tool<TContext, TData, unknown[], unknown> | undefined;
1634
+
1635
+ if (typeof prepareOrFinalize === "string") {
1636
+ // Tool ID - find it in available tools
1637
+ const availableTools = new Map<string, Tool<TContext, TData, unknown[], unknown>>();
1638
+
1639
+ // Add agent-level tools
1640
+ this.agent.getTools().forEach((t) => {
1641
+ availableTools.set(t.id, t);
1642
+ });
1643
+
1644
+ // Add route-level tools
1645
+ if (route) {
1646
+ route.getTools().forEach((t: Tool<TContext, TData, unknown[], unknown>) => {
1647
+ availableTools.set(t.id, t);
1648
+ });
1649
+ }
1650
+
1651
+ // Add step-level tools
1652
+ if (step?.tools) {
1653
+ for (const toolRef of step.tools) {
1654
+ if (typeof toolRef === "string") {
1655
+ // Keep as is
1656
+ } else if (typeof toolRef === 'object' && 'id' in toolRef && toolRef.id) {
1657
+ availableTools.set(toolRef.id, toolRef);
1658
+ }
1659
+ }
1660
+ }
1661
+
1662
+ tool = availableTools.get(prepareOrFinalize);
1663
+ } else {
1664
+ // Tool object - use directly
1665
+ tool = prepareOrFinalize;
1666
+ }
1667
+
1668
+ if (tool) {
1669
+ const toolExecutor = new ToolExecutor<TContext, TData>();
1670
+ const result = await toolExecutor.executeTool({
1671
+ tool,
1672
+ context,
1673
+ updateContext: this.agent.updateContext.bind(this.agent),
1674
+ updateData: this.agent.updateCollectedData.bind(this.agent),
1675
+ history: [], // Empty history for prepare/finalize
1676
+ data,
1677
+ });
1678
+
1679
+ if (!result.success) {
1680
+ logger.error(
1681
+ `[ResponseModal] Tool execution failed in prepare/finalize: ${result.error}`
1682
+ );
1683
+ throw new Error(`Tool execution failed: ${result.error}`);
1684
+ }
1685
+ } else {
1686
+ logger.warn(
1687
+ `[ResponseModal] Tool not found for prepare/finalize: ${typeof prepareOrFinalize === "string"
1688
+ ? prepareOrFinalize
1689
+ : "inline tool"
1690
+ }`
1691
+ );
1692
+ }
1693
+ }
1694
+ }
1695
+
1696
+ /**
1697
+ * Merge terms with route-specific taking precedence on conflicts
1698
+ * @private
1699
+ */
1700
+ private mergeTerms(
1701
+ agentTerms: Term<TContext, TData>[],
1702
+ routeTerms: Term<TContext, TData>[]
1703
+ ): Term<TContext, TData>[] {
1704
+ const merged = new Map<string, Term<TContext, TData>>();
1705
+
1706
+ // Add agent terms first
1707
+ agentTerms.forEach((term) => {
1708
+ const name =
1709
+ typeof term.name === "string" ? term.name : term.name.toString();
1710
+ merged.set(name, term);
1711
+ });
1712
+
1713
+ // Add route terms (these take precedence)
1714
+ routeTerms.forEach((term) => {
1715
+ const name =
1716
+ typeof term.name === "string" ? term.name : term.name.toString();
1717
+ merged.set(name, term);
1718
+ });
1719
+
1720
+ return Array.from(merged.values());
1721
+ }
1722
+ }