LemonCliRunners.ClaudeSchema (lemon_cli_runners v0.1.0)

View Source

Claude CLI JSONL event schema definitions.

This module defines all the event types emitted by claude -p --output-format stream-json. Events are decoded from newline-delimited JSON (JSONL) format.

Event Categories

System Messages

  • StreamSystemMessage - Session initialization with metadata

Conversation Messages

  • StreamAssistantMessage - Claude's response with content blocks
  • StreamUserMessage - Tool results returned to Claude

Result Messages

  • StreamResultMessage - Final session result with usage stats

Content Block Types

  • TextBlock - Plain text response
  • ThinkingBlock - Extended thinking/reasoning
  • ToolUseBlock - Tool invocation request
  • ToolResultBlock - Tool execution result

Decoding

case ClaudeSchema.decode_event(json_line) do
  {:ok, %StreamSystemMessage{session_id: id}} -> ...
  {:ok, %StreamAssistantMessage{message: msg}} -> ...
  {:error, reason} -> ...
end

Summary

Types

content_block()

Union of all content block types

stream_event()

Union of all stream event types

Functions

decode_event(json)

Decode a JSON line into a stream event struct.

decode_event_map(data)

Decode a map (already parsed JSON) into a stream event struct.

Types

content_block()

@type content_block() ::
  LemonCliRunners.ClaudeSchema.TextBlock.t()
  | LemonCliRunners.ClaudeSchema.ThinkingBlock.t()
  | LemonCliRunners.ClaudeSchema.ToolUseBlock.t()
  | LemonCliRunners.ClaudeSchema.ToolResultBlock.t()

Union of all content block types

stream_event()

@type stream_event() ::
  LemonCliRunners.ClaudeSchema.StreamSystemMessage.t()
  | LemonCliRunners.ClaudeSchema.StreamAssistantMessage.t()
  | LemonCliRunners.ClaudeSchema.StreamUserMessage.t()
  | LemonCliRunners.ClaudeSchema.StreamResultMessage.t()

Union of all stream event types

Functions

decode_event(json)

@spec decode_event(String.t() | binary()) :: {:ok, stream_event()} | {:error, term()}

Decode a JSON line into a stream event struct.

Returns {:ok, event} on success or {:error, reason} on failure.

decode_event_map(data)

@spec decode_event_map(map()) :: {:ok, stream_event()} | {:error, term()}

Decode a map (already parsed JSON) into a stream event struct.