Skip to main content

claude_codes/io/
claude_input.rs

1use serde::{Deserialize, Serialize};
2use serde_json::Value;
3use uuid::Uuid;
4
5use super::content_blocks::{ContentBlock, ImageBlock, ImageSource, TextBlock};
6use super::control::{ControlRequest, ControlResponse};
7use super::message_types::{MessageContent, UserMessage};
8
9/// Top-level enum for all possible Claude input messages.
10///
11/// Keep variants unboxed so pattern matches and constructors stay ergonomic.
12#[allow(clippy::large_enum_variant)]
13#[derive(Debug, Clone, Serialize, Deserialize)]
14#[serde(tag = "type", rename_all = "snake_case")]
15pub enum ClaudeInput {
16    /// User message input
17    User(UserMessage),
18
19    /// Control request (for initialization handshake)
20    ControlRequest(ControlRequest),
21
22    /// Control response (for tool permission responses)
23    ControlResponse(ControlResponse),
24
25    /// Raw JSON for untyped messages
26    #[serde(untagged)]
27    Raw(Value),
28}
29
30impl ClaudeInput {
31    /// Create a simple text user message
32    pub fn user_message(text: impl Into<String>, session_id: Uuid) -> Self {
33        Self::text_user_message(text, Some(session_id))
34    }
35
36    /// Create a simple text user message associated with the current CLI
37    /// process session.
38    pub fn user_message_without_session(text: impl Into<String>) -> Self {
39        Self::text_user_message(text, None)
40    }
41
42    fn text_user_message(text: impl Into<String>, session_id: Option<Uuid>) -> Self {
43        ClaudeInput::User(UserMessage {
44            message: MessageContent {
45                role: super::MessageRole::User,
46                content: vec![ContentBlock::Text(TextBlock {
47                    text: text.into(),
48                    citations: Vec::new(),
49                })],
50            },
51            session_id,
52            parent_tool_use_id: None,
53            uuid: None,
54            timestamp: None,
55            tool_use_result: None,
56            agent_id: None,
57            subagent_type: None,
58            task_description: None,
59            origin: None,
60            priority: None,
61            is_synthetic: None,
62            should_query: None,
63            is_meta: None,
64            is_visible_in_transcript_only: None,
65            is_virtual: None,
66            is_compact_summary: None,
67            summarize_metadata: None,
68            mcp_meta: None,
69            tool_result_meta: None,
70            source_tool_use_id: None,
71            source_tool_assistant_uuid: None,
72            image_paste_ids: None,
73            client_platform: None,
74            inbound_origin: None,
75            is_replay: None,
76            file_attachments: None,
77            seeded_summon: None,
78            client_composed: None,
79            text_not_typed: None,
80            initiator: None,
81            pasted_content: None,
82            historical: None,
83            server_received_wall_ms: None,
84            refused_message_id: None,
85            requeue_if_interrupted_within_ms: None,
86            ultrathink_typed: None,
87            tool_states: None,
88            plugin_prompt: None,
89            retracted_message_uuids: None,
90        })
91    }
92
93    /// Create a user message with content blocks
94    pub fn user_message_blocks(blocks: Vec<ContentBlock>, session_id: Uuid) -> Self {
95        ClaudeInput::User(UserMessage {
96            message: MessageContent {
97                role: super::MessageRole::User,
98                content: blocks,
99            },
100            session_id: Some(session_id),
101            parent_tool_use_id: None,
102            uuid: None,
103            timestamp: None,
104            tool_use_result: None,
105            agent_id: None,
106            subagent_type: None,
107            task_description: None,
108            origin: None,
109            priority: None,
110            is_synthetic: None,
111            should_query: None,
112            is_meta: None,
113            is_visible_in_transcript_only: None,
114            is_virtual: None,
115            is_compact_summary: None,
116            summarize_metadata: None,
117            mcp_meta: None,
118            tool_result_meta: None,
119            source_tool_use_id: None,
120            source_tool_assistant_uuid: None,
121            image_paste_ids: None,
122            client_platform: None,
123            inbound_origin: None,
124            is_replay: None,
125            file_attachments: None,
126            seeded_summon: None,
127            client_composed: None,
128            text_not_typed: None,
129            initiator: None,
130            pasted_content: None,
131            historical: None,
132            server_received_wall_ms: None,
133            refused_message_id: None,
134            requeue_if_interrupted_within_ms: None,
135            ultrathink_typed: None,
136            tool_states: None,
137            plugin_prompt: None,
138            retracted_message_uuids: None,
139        })
140    }
141
142    /// Create an interrupt control request.
143    ///
144    /// Serializes to the `control_request` envelope the CLI requires:
145    /// `{"type":"control_request","request_id":...,"request":{"subtype":"interrupt"}}`,
146    /// telling Claude to stop its current response and return control
147    /// without killing the session. The CLI acknowledges with a
148    /// `control_response` carrying the same `request_id`.
149    ///
150    /// `request_id` must be unique per request; the clients generate
151    /// `interrupt-<uuid>` ids.
152    pub fn interrupt(request_id: impl Into<String>) -> Self {
153        ClaudeInput::ControlRequest(ControlRequest {
154            request_id: request_id.into(),
155            request: super::ControlRequestPayload::Interrupt,
156        })
157    }
158
159    /// Create an `apply_flag_settings` control request, e.g. to change the
160    /// session's effort level or toggle ultracode mid-session.
161    ///
162    /// Serializes to
163    /// `{"type":"control_request","request_id":...,"request":{"subtype":"apply_flag_settings","settings":{...}}}`.
164    /// The CLI answers with a `control_response` carrying the same
165    /// `request_id`. The clients generate `apply-flag-settings-<uuid>` ids.
166    pub fn apply_flag_settings(
167        request_id: impl Into<String>,
168        settings: super::ApplyFlagSettingsRequest,
169    ) -> Self {
170        ClaudeInput::ControlRequest(ControlRequest {
171            request_id: request_id.into(),
172            request: super::ControlRequestPayload::ApplyFlagSettings(settings),
173        })
174    }
175
176    /// Create a user message with an image and optional text
177    /// Only supports JPEG, PNG, GIF, and WebP media types
178    pub fn user_message_with_image(
179        image_data: String,
180        media_type: super::MediaType,
181        text: Option<String>,
182        session_id: Uuid,
183    ) -> Result<Self, String> {
184        // Validate media type
185        match &media_type {
186            super::MediaType::Jpeg
187            | super::MediaType::Png
188            | super::MediaType::Gif
189            | super::MediaType::Webp => {}
190            other => {
191                return Err(format!(
192                    "Invalid media type '{}'. Only JPEG, PNG, GIF, and WebP are supported.",
193                    other
194                ));
195            }
196        }
197
198        let mut blocks = vec![ContentBlock::Image(ImageBlock {
199            source: ImageSource {
200                source_type: super::ImageSourceType::Base64,
201                media_type,
202                data: image_data,
203            },
204        })];
205
206        if let Some(text_content) = text {
207            blocks.push(ContentBlock::Text(TextBlock {
208                text: text_content,
209                citations: Vec::new(),
210            }));
211        }
212
213        Ok(Self::user_message_blocks(blocks, session_id))
214    }
215}
216
217#[cfg(test)]
218mod tests {
219    use super::*;
220
221    #[test]
222    fn test_interrupt_serializes_to_control_request_envelope() {
223        let input = ClaudeInput::interrupt("interrupt-abc");
224        assert_eq!(
225            serde_json::to_value(&input).unwrap(),
226            serde_json::json!({
227                "type": "control_request",
228                "request_id": "interrupt-abc",
229                "request": {"subtype": "interrupt"}
230            })
231        );
232    }
233
234    #[test]
235    fn test_serialize_user_message() {
236        let session_uuid = Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000").unwrap();
237        let input = ClaudeInput::user_message("Hello, Claude!", session_uuid);
238        let json = serde_json::to_string(&input).unwrap();
239        assert!(json.contains("\"type\":\"user\""));
240        assert!(json.contains("\"role\":\"user\""));
241        assert!(json.contains("\"text\":\"Hello, Claude!\""));
242        assert!(json.contains("550e8400-e29b-41d4-a716-446655440000"));
243    }
244
245    #[test]
246    fn test_serialize_user_message_without_session() {
247        let input = ClaudeInput::user_message_without_session("Hello, Claude!");
248        let json = serde_json::to_string(&input).unwrap();
249        assert!(json.contains("\"type\":\"user\""));
250        assert!(!json.contains("session_id"));
251    }
252}