Class: ClaudeAgentSDK::MessageParser

Inherits:
Object
  • Object
show all
Defined in:
lib/claude_agent_sdk/message_parser.rb

Overview

Parse message from CLI output into typed Message objects

Class Method Summary collapse

Class Method Details

.parse(data) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 9

def self.parse(data)
  raise MessageParseError.new("Invalid message data type", data: data) unless data.is_a?(Hash)

  message_type = data[:type]
  raise MessageParseError.new("Message missing 'type' field", data: data) unless message_type

  case message_type
  when 'user'
    parse_user_message(data)
  when 'assistant'
    parse_assistant_message(data)
  when 'system'
    parse_system_message(data)
  when 'result'
    parse_result_message(data)
  when 'stream_event'
    parse_stream_event(data)
  when 'rate_limit_event'
    parse_rate_limit_event(data)
  when 'tool_progress'
    parse_tool_progress_message(data)
  when 'auth_status'
    parse_auth_status_message(data)
  when 'tool_use_summary'
    parse_tool_use_summary_message(data)
  when 'prompt_suggestion'
    parse_prompt_suggestion_message(data)
  end
  # Forward-compatible: returns nil for unrecognized message types so
  # newer CLI versions don't crash older SDK versions.
rescue KeyError => e
  raise MessageParseError.new("Missing required field: #{e.message}", data: data)
end

.parse_assistant_message(data) ⇒ Object

Raises:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 63

def self.parse_assistant_message(data)
  content = data.dig(:message, :content)
  raise MessageParseError.new("Missing content in assistant message", data: data) unless content

  content_blocks = content.map { |block| parse_content_block(block) }
  AssistantMessage.new(
    content: content_blocks,
    model: data.dig(:message, :model),
    parent_tool_use_id: data[:parent_tool_use_id],
    error: data[:error], # authentication_failed, billing_error, rate_limit, invalid_request, server_error, unknown
    usage: data.dig(:message, :usage),
    message_id: data.dig(:message, :id),
    stop_reason: data.dig(:message, :stop_reason),
    session_id: data[:session_id],
    uuid: data[:uuid]
  )
end

.parse_auth_status_message(data) ⇒ Object 



264
265
266
267
268
269
270
271
272
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 264

def self.parse_auth_status_message(data)
  AuthStatusMessage.new(
    uuid: data[:uuid],
    session_id: data[:session_id],
    is_authenticating: data[:isAuthenticating] || data[:is_authenticating],
    output: data[:output],
    error: data[:error]
  )
end

.parse_content_block(block) ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 291

def self.parse_content_block(block)
  case block[:type]
  when 'text'
    TextBlock.new(text: block[:text])
  when 'thinking'
    ThinkingBlock.new(thinking: block[:thinking], signature: block[:signature])
  when 'tool_use'
    ToolUseBlock.new(id: block[:id], name: block[:name], input: block[:input])
  when 'tool_result'
    ToolResultBlock.new(
      tool_use_id: block[:tool_use_id],
      content: block[:content],
      is_error: block[:is_error]
    )
  else
    # Forward-compatible: preserve unrecognized content block types (e.g., "document", "image")
    # so newer CLI versions don't crash older SDK versions.
    UnknownBlock.new(type: block[:type], data: block)
  end
end

.parse_prompt_suggestion_message(data) ⇒ Object 



283
284
285
286
287
288
289
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 283

def self.parse_prompt_suggestion_message(data)
  PromptSuggestionMessage.new(
    uuid: data[:uuid],
    session_id: data[:session_id],
    suggestion: data[:suggestion]
  )
end

.parse_rate_limit_event(data) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 232

def self.parse_rate_limit_event(data)
  info = data[:rate_limit_info] || {}
  rate_limit_info = RateLimitInfo.new(
    status: info[:status],
    resets_at: info[:resetsAt],
    rate_limit_type: info[:rateLimitType],
    utilization: info[:utilization],
    overage_status: info[:overageStatus],
    overage_resets_at: info[:overageResetsAt],
    overage_disabled_reason: info[:overageDisabledReason],
    raw: info
  )
  RateLimitEvent.new(
    rate_limit_info: rate_limit_info,
    uuid: data[:uuid],
    session_id: data[:session_id],
    raw_data: data
  )
end

.parse_result_message(data) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 202

def self.parse_result_message(data)
  ResultMessage.new(
    subtype: data[:subtype],
    duration_ms: data[:duration_ms],
    duration_api_ms: data[:duration_api_ms],
    is_error: data[:is_error],
    num_turns: data[:num_turns],
    session_id: data[:session_id],
    stop_reason: data[:stop_reason],
    total_cost_usd: data[:total_cost_usd],
    usage: data[:usage],
    result: data[:result],
    structured_output: data[:structured_output],
    model_usage: data[:modelUsage] || data[:model_usage],
    permission_denials: data[:permission_denials],
    errors: data[:errors],
    uuid: data[:uuid],
    fast_mode_state: data[:fastModeState] || data[:fast_mode_state]
  )
end

.parse_stream_event(data) ⇒ Object 



223
224
225
226
227
228
229
230
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 223

def self.parse_stream_event(data)
  StreamEvent.new(
    uuid: data[:uuid],
    session_id: data[:session_id],
    event: data[:event],
    parent_tool_use_id: data[:parent_tool_use_id]
  )
end

.parse_system_message(data) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 81

def self.parse_system_message(data)
  case data[:subtype]
  when 'init'
    InitMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      agents: data[:agents], api_key_source: data[:apiKeySource] || data[:api_key_source],
      betas: data[:betas], claude_code_version: data[:claude_code_version],
      cwd: data[:cwd], tools: data[:tools], mcp_servers: data[:mcp_servers],
      model: data[:model], permission_mode: data[:permissionMode] || data[:permission_mode],
      slash_commands: data[:slash_commands], output_style: data[:output_style],
      skills: data[:skills], plugins: data[:plugins],
      fast_mode_state: data[:fastModeState] || data[:fast_mode_state]
    )
  when 'compact_boundary'
    raw_metadata = data[:compact_metadata]
    CompactBoundaryMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      compact_metadata: CompactMetadata.from_hash(raw_metadata)
    )
  when 'status'
    StatusMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      status: data[:status],
      permission_mode: data[:permissionMode] || data[:permission_mode]
    )
  when 'api_retry'
    APIRetryMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      attempt: data[:attempt], max_retries: data[:maxRetries] || data[:max_retries],
      retry_delay_ms: data[:retryDelayMs] || data[:retry_delay_ms],
      error_status: data[:errorStatus] || data[:error_status],
      error: data[:error]
    )
  when 'local_command_output'
    LocalCommandOutputMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      content: data[:content]
    )
  when 'hook_started'
    HookStartedMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      hook_id: data[:hookId] || data[:hook_id],
      hook_name: data[:hookName] || data[:hook_name],
      hook_event: data[:hookEvent] || data[:hook_event]
    )
  when 'hook_progress'
    HookProgressMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      hook_id: data[:hookId] || data[:hook_id],
      hook_name: data[:hookName] || data[:hook_name],
      hook_event: data[:hookEvent] || data[:hook_event],
      stdout: data[:stdout], stderr: data[:stderr], output: data[:output]
    )
  when 'hook_response'
    HookResponseMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      hook_id: data[:hookId] || data[:hook_id],
      hook_name: data[:hookName] || data[:hook_name],
      hook_event: data[:hookEvent] || data[:hook_event],
      output: data[:output], stdout: data[:stdout], stderr: data[:stderr],
      exit_code: data[:exitCode] || data[:exit_code],
      outcome: data[:outcome]
    )
  when 'session_state_changed'
    SessionStateChangedMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      state: data[:state]
    )
  when 'files_persisted'
    FilesPersistedMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      files: data[:files], failed: data[:failed],
      processed_at: data[:processedAt] || data[:processed_at]
    )
  when 'elicitation_complete'
    ElicitationCompleteMessage.new(
      subtype: data[:subtype], data: data,
      uuid: data[:uuid], session_id: data[:session_id],
      mcp_server_name: data[:mcpServerName] || data[:mcp_server_name],
      elicitation_id: data[:elicitationId] || data[:elicitation_id]
    )
  when 'task_started'
    TaskStartedMessage.new(
      subtype: data[:subtype], data: data,
      task_id: data[:task_id], description: data[:description],
      uuid: data[:uuid], session_id: data[:session_id],
      tool_use_id: data[:tool_use_id], task_type: data[:task_type],
      workflow_name: data[:workflowName] || data[:workflow_name],
      prompt: data[:prompt]
    )
  when 'task_progress'
    TaskProgressMessage.new(
      subtype: data[:subtype], data: data,
      task_id: data[:task_id], description: data[:description],
      usage: data[:usage], uuid: data[:uuid], session_id: data[:session_id],
      tool_use_id: data[:tool_use_id], last_tool_name: data[:last_tool_name],
      summary: data[:summary]
    )
  when 'task_notification'
    TaskNotificationMessage.new(
      subtype: data[:subtype], data: data,
      task_id: data[:task_id], status: data[:status],
      output_file: data[:output_file], summary: data[:summary],
      uuid: data[:uuid], session_id: data[:session_id],
      tool_use_id: data[:tool_use_id], usage: data[:usage]
    )
  else
    SystemMessage.new(subtype: data[:subtype], data: data)
  end
end

.parse_tool_progress_message(data) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 252

def self.parse_tool_progress_message(data)
  ToolProgressMessage.new(
    uuid: data[:uuid],
    session_id: data[:session_id],
    tool_use_id: data[:toolUseId] || data[:tool_use_id],
    tool_name: data[:toolName] || data[:tool_name],
    parent_tool_use_id: data[:parentToolUseId] || data[:parent_tool_use_id],
    elapsed_time_seconds: data[:elapsedTimeSeconds] || data[:elapsed_time_seconds],
    task_id: data[:taskId] || data[:task_id]
  )
end

.parse_tool_use_summary_message(data) ⇒ Object 



274
275
276
277
278
279
280
281
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 274

def self.parse_tool_use_summary_message(data)
  ToolUseSummaryMessage.new(
    uuid: data[:uuid],
    session_id: data[:session_id],
    summary: data[:summary],
    preceding_tool_use_ids: data[:precedingToolUseIds] || data[:preceding_tool_use_ids]
  )
end

.parse_user_message(data) ⇒ Object

Raises:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/claude_agent_sdk/message_parser.rb', line 43

def self.parse_user_message(data)
  parent_tool_use_id = data[:parent_tool_use_id]
  uuid = data[:uuid] # UUID for rewind support
  tool_use_result = data[:tool_use_result]
  message_data = data[:message]
  raise MessageParseError.new("Missing message field in user message", data: data) unless message_data

  content = message_data[:content]
  raise MessageParseError.new("Missing content in user message", data: data) unless content

  if content.is_a?(Array)
    content_blocks = content.map { |block| parse_content_block(block) }
    UserMessage.new(content: content_blocks, uuid: uuid, parent_tool_use_id: parent_tool_use_id,
                    tool_use_result: tool_use_result)
  else
    UserMessage.new(content: content, uuid: uuid, parent_tool_use_id: parent_tool_use_id,
                    tool_use_result: tool_use_result)
  end
end