streamlinedTransform.ts
utils/streamlinedTransform.ts
No strong subsystem tag
202
Lines
5941
Bytes
2
Exports
15
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is one piece of the larger system. Its name, directory, imports, and exports show where it fits. Start by reading the exports and related files first.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with general runtime concerns. It contains 202 lines, 15 detected imports, and 2 detected exports.
Important relationships
Detected exports
createStreamlinedTransformershouldIncludeInStreamlined
Keywords
countsmessagecasetoolstexttoolcontentpromptpartscommands
Detected imports
src/entrypoints/agentSdkTypes.jssrc/entrypoints/sdk/controlTypes.jssrc/tools/FileEditTool/constants.jssrc/tools/FileReadTool/prompt.jssrc/tools/FileWriteTool/prompt.jssrc/tools/GlobTool/prompt.jssrc/tools/GrepTool/prompt.jssrc/tools/ListMcpResourcesTool/prompt.jssrc/tools/LSPTool/prompt.jssrc/tools/NotebookEditTool/constants.jssrc/tools/TaskStopTool/prompt.jssrc/tools/WebSearchTool/prompt.jssrc/utils/messages.jssrc/utils/shell/shellToolUtils.jssrc/utils/stringUtils.js
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
/**
* Transforms SDK messages for streamlined output mode.
*
* Streamlined mode is a "distillation-resistant" output format that:
* - Keeps text messages intact
* - Summarizes tool calls with cumulative counts (resets when text appears)
* - Omits thinking content
* - Strips tool list and model info from init messages
*/
import type { SDKAssistantMessage } from 'src/entrypoints/agentSdkTypes.js'
import type { StdoutMessage } from 'src/entrypoints/sdk/controlTypes.js'
import { FILE_EDIT_TOOL_NAME } from 'src/tools/FileEditTool/constants.js'
import { FILE_READ_TOOL_NAME } from 'src/tools/FileReadTool/prompt.js'
import { FILE_WRITE_TOOL_NAME } from 'src/tools/FileWriteTool/prompt.js'
import { GLOB_TOOL_NAME } from 'src/tools/GlobTool/prompt.js'
import { GREP_TOOL_NAME } from 'src/tools/GrepTool/prompt.js'
import { LIST_MCP_RESOURCES_TOOL_NAME } from 'src/tools/ListMcpResourcesTool/prompt.js'
import { LSP_TOOL_NAME } from 'src/tools/LSPTool/prompt.js'
import { NOTEBOOK_EDIT_TOOL_NAME } from 'src/tools/NotebookEditTool/constants.js'
import { TASK_STOP_TOOL_NAME } from 'src/tools/TaskStopTool/prompt.js'
import { WEB_SEARCH_TOOL_NAME } from 'src/tools/WebSearchTool/prompt.js'
import { extractTextContent } from 'src/utils/messages.js'
import { SHELL_TOOL_NAMES } from 'src/utils/shell/shellToolUtils.js'
import { capitalize } from 'src/utils/stringUtils.js'
type ToolCounts = {
searches: number
reads: number
writes: number
commands: number
other: number
}
/**
* Tool categories for summarization.
*/
const SEARCH_TOOLS = [
GREP_TOOL_NAME,
GLOB_TOOL_NAME,
WEB_SEARCH_TOOL_NAME,
LSP_TOOL_NAME,
]
const READ_TOOLS = [FILE_READ_TOOL_NAME, LIST_MCP_RESOURCES_TOOL_NAME]
const WRITE_TOOLS = [
FILE_WRITE_TOOL_NAME,
FILE_EDIT_TOOL_NAME,
NOTEBOOK_EDIT_TOOL_NAME,
]
const COMMAND_TOOLS = [...SHELL_TOOL_NAMES, 'Tmux', TASK_STOP_TOOL_NAME]
function categorizeToolName(toolName: string): keyof ToolCounts {
if (SEARCH_TOOLS.some(t => toolName.startsWith(t))) return 'searches'
if (READ_TOOLS.some(t => toolName.startsWith(t))) return 'reads'
if (WRITE_TOOLS.some(t => toolName.startsWith(t))) return 'writes'
if (COMMAND_TOOLS.some(t => toolName.startsWith(t))) return 'commands'
return 'other'
}
function createEmptyToolCounts(): ToolCounts {
return {
searches: 0,
reads: 0,
writes: 0,
commands: 0,
other: 0,
}
}
/**
* Generate a summary text for tool counts.
*/
function getToolSummaryText(counts: ToolCounts): string | undefined {
const parts: string[] = []
// Use similar phrasing to collapseReadSearch.ts
if (counts.searches > 0) {
parts.push(
`searched ${counts.searches} ${counts.searches === 1 ? 'pattern' : 'patterns'}`,
)
}
if (counts.reads > 0) {
parts.push(`read ${counts.reads} ${counts.reads === 1 ? 'file' : 'files'}`)
}
if (counts.writes > 0) {
parts.push(
`wrote ${counts.writes} ${counts.writes === 1 ? 'file' : 'files'}`,
)
}
if (counts.commands > 0) {
parts.push(
`ran ${counts.commands} ${counts.commands === 1 ? 'command' : 'commands'}`,
)
}
if (counts.other > 0) {
parts.push(`${counts.other} other ${counts.other === 1 ? 'tool' : 'tools'}`)
}
if (parts.length === 0) {
return undefined
}
return capitalize(parts.join(', '))
}
/**
* Count tool uses in an assistant message and add to existing counts.
*/
function accumulateToolUses(
message: SDKAssistantMessage,
counts: ToolCounts,
): void {
const content = message.message.content
if (!Array.isArray(content)) {
return
}
for (const block of content) {
if (block.type === 'tool_use' && 'name' in block) {
const category = categorizeToolName(block.name as string)
counts[category]++
}
}
}
/**
* Create a stateful transformer that accumulates tool counts between text messages.
* Tool counts reset when a message with text content is encountered.
*/
export function createStreamlinedTransformer(): (
message: StdoutMessage,
) => StdoutMessage | null {
let cumulativeCounts = createEmptyToolCounts()
return function transformToStreamlined(
message: StdoutMessage,
): StdoutMessage | null {
switch (message.type) {
case 'assistant': {
const content = message.message.content
const text = Array.isArray(content)
? extractTextContent(content, '\n').trim()
: ''
// Accumulate tool counts from this message
accumulateToolUses(message, cumulativeCounts)
if (text.length > 0) {
// Text message: emit text only, reset counts
cumulativeCounts = createEmptyToolCounts()
return {
type: 'streamlined_text',
text,
session_id: message.session_id,
uuid: message.uuid,
}
}
// Tool-only message: emit cumulative tool summary
const toolSummary = getToolSummaryText(cumulativeCounts)
if (!toolSummary) {
return null
}
return {
type: 'streamlined_tool_use_summary',
tool_summary: toolSummary,
session_id: message.session_id,
uuid: message.uuid,
}
}
case 'result':
// Keep result messages as-is (they have structured_output, permission_denials)
return message
case 'system':
case 'user':
case 'stream_event':
case 'tool_progress':
case 'auth_status':
case 'rate_limit_event':
case 'control_response':
case 'control_request':
case 'control_cancel_request':
case 'keep_alive':
return null
default:
return null
}
}
}
/**
* Check if a message should be included in streamlined output.
* Useful for filtering before transformation.
*/
export function shouldIncludeInStreamlined(message: StdoutMessage): boolean {
return message.type === 'assistant' || message.type === 'result'
}