1pub use crate::protocol_generated::types::*;
23
24pub mod methods {
29 pub const INITIALIZE: &str = "initialize";
31 pub const INITIALIZED: &str = "initialized";
32 pub const THREAD_START: &str = "thread/start";
33 pub const THREAD_ARCHIVE: &str = "thread/archive";
34 pub const THREAD_DELETE: &str = "thread/delete";
35 pub const TURN_START: &str = "turn/start";
36 pub const TURN_INTERRUPT: &str = "turn/interrupt";
37 pub const TURN_STEER: &str = "turn/steer";
38 pub const THREAD_RESUME: &str = "thread/resume";
39 pub const THREAD_FORK: &str = "thread/fork";
40 pub const THREAD_UNSUBSCRIBE: &str = "thread/unsubscribe";
41 pub const THREAD_NAME_SET: &str = "thread/name/set";
42 pub const THREAD_METADATA_UPDATE: &str = "thread/metadata/update";
43 pub const THREAD_ATTACHMENT_ADD: &str = "thread/attachment/add";
44 pub const THREAD_ATTACHMENT_LIST: &str = "thread/attachment/list";
45 pub const THREAD_ATTACHMENT_REMOVE: &str = "thread/attachment/remove";
46 pub const THREAD_ATTACHMENT_OWNER_LIST: &str = "thread/attachmentOwner/list";
47 pub const THREAD_UNARCHIVE: &str = "thread/unarchive";
48 pub const THREAD_COMPACT_START: &str = "thread/compact/start";
49 pub const THREAD_SHELLCOMMAND: &str = "thread/shellCommand";
50 pub const THREAD_APPROVEGUARDIANDENIEDACTION: &str = "thread/approveGuardianDeniedAction";
51 pub const THREAD_LIST: &str = "thread/list";
52 pub const THREAD_LOADED_LIST: &str = "thread/loaded/list";
53 pub const THREAD_READ: &str = "thread/read";
54 pub const THREAD_INJECT_ITEMS: &str = "thread/inject_items";
55 pub const THREAD_ITEMS_LIST: &str = "thread/items/list";
56 pub const THREAD_TURNS_LIST: &str = "thread/turns/list";
57 pub const THREAD_REVERT: &str = "thread/revert";
58 pub const SKILLS_LIST: &str = "skills/list";
59 pub const HOOKS_LIST: &str = "hooks/list";
60 pub const MARKETPLACE_ADD: &str = "marketplace/add";
61 pub const MARKETPLACE_REMOVE: &str = "marketplace/remove";
62 pub const MARKETPLACE_UPGRADE: &str = "marketplace/upgrade";
63 pub const PLUGIN_LIST: &str = "plugin/list";
64 pub const PLUGIN_READ: &str = "plugin/read";
65 pub const PLUGIN_SKILL_READ: &str = "plugin/skill/read";
66 pub const PLUGIN_SHARE_SAVE: &str = "plugin/share/save";
67 pub const PLUGIN_SHARE_UPDATETARGETS: &str = "plugin/share/updateTargets";
68 pub const PLUGIN_SHARE_LIST: &str = "plugin/share/list";
69 pub const PLUGIN_SHARE_CHECKOUT: &str = "plugin/share/checkout";
70 pub const PLUGIN_SHARE_DELETE: &str = "plugin/share/delete";
71 pub const APP_LIST: &str = "app/list";
72 pub const APP_READ: &str = "app/read";
73 pub const APP_INSTALLED: &str = "app/installed";
74 pub const FS_READFILE: &str = "fs/readFile";
75 pub const FS_WRITEFILE: &str = "fs/writeFile";
76 pub const FS_CREATEDIRECTORY: &str = "fs/createDirectory";
77 pub const FS_GETMETADATA: &str = "fs/getMetadata";
78 pub const FS_READDIRECTORY: &str = "fs/readDirectory";
79 pub const FS_REMOVE: &str = "fs/remove";
80 pub const FS_COPY: &str = "fs/copy";
81 pub const FS_WATCH: &str = "fs/watch";
82 pub const FS_UNWATCH: &str = "fs/unwatch";
83 pub const SKILLS_CONFIG_WRITE: &str = "skills/config/write";
84 pub const PLUGIN_INSTALL: &str = "plugin/install";
85 pub const PLUGIN_UNINSTALL: &str = "plugin/uninstall";
86 pub const REVIEW_START: &str = "review/start";
87 pub const MODEL_LIST: &str = "model/list";
88 pub const ACCOUNT_GATEWAYOAUTH_READ: &str = "account/gatewayOAuth/read";
89 pub const ACCOUNT_GATEWAYOAUTH_LOGIN: &str = "account/gatewayOAuth/login";
90 pub const ACCOUNT_GATEWAYOAUTH_CANCEL: &str = "account/gatewayOAuth/cancel";
91 pub const MODELPROVIDER_LIST: &str = "modelProvider/list";
92 pub const MODELPROVIDER_CAPABILITIES_READ: &str = "modelProvider/capabilities/read";
93 pub const EXPERIMENTALFEATURE_LIST: &str = "experimentalFeature/list";
94 pub const EXPERIMENTALFEATURE_ENABLEMENT_SET: &str = "experimentalFeature/enablement/set";
95 pub const MCPSERVER_OAUTH_LOGIN: &str = "mcpServer/oauth/login";
96 pub const CONFIG_MCPSERVER_RELOAD: &str = "config/mcpServer/reload";
97 pub const MCPSERVERSTATUS_LIST: &str = "mcpServerStatus/list";
98 pub const MCPSERVER_RESOURCE_READ: &str = "mcpServer/resource/read";
99 pub const MCPSERVER_TOOL_CALL: &str = "mcpServer/tool/call";
100 pub const WINDOWSSANDBOX_SETUPSTART: &str = "windowsSandbox/setupStart";
101 pub const WINDOWSSANDBOX_READINESS: &str = "windowsSandbox/readiness";
102 pub const ACCOUNT_LOGIN_START: &str = "account/login/start";
103 pub const ACCOUNT_LOGIN_CANCEL: &str = "account/login/cancel";
104 pub const ACCOUNT_LOGOUT: &str = "account/logout";
105 pub const ACCOUNT_RATELIMITS_READ: &str = "account/rateLimits/read";
106 pub const ACCOUNT_SENDADDCREDITSNUDGEEMAIL: &str = "account/sendAddCreditsNudgeEmail";
107 pub const FEEDBACK_UPLOAD: &str = "feedback/upload";
108 pub const FEEDBACK_SAVE: &str = "feedback/save";
109 pub const COMMAND_EXEC: &str = "command/exec";
110 pub const COMMAND_EXEC_WRITE: &str = "command/exec/write";
111 pub const COMMAND_EXEC_TERMINATE: &str = "command/exec/terminate";
112 pub const COMMAND_EXEC_RESIZE: &str = "command/exec/resize";
113 pub const CONFIG_READ: &str = "config/read";
114 pub const EXTERNALAGENTCONFIG_DETECT: &str = "externalAgentConfig/detect";
115 pub const EXTERNALAGENTCONFIG_IMPORT: &str = "externalAgentConfig/import";
116 pub const CONFIG_VALUE_WRITE: &str = "config/value/write";
117 pub const CONFIG_BATCHWRITE: &str = "config/batchWrite";
118 pub const CONFIGREQUIREMENTS_READ: &str = "configRequirements/read";
119 pub const ACCOUNT_READ: &str = "account/read";
120 pub const FUZZYFILESEARCH: &str = "fuzzyFileSearch";
121 pub const ACCOUNT_USAGE_READ: &str = "account/usage/read";
122 pub const PERMISSION_PROFILE_LIST: &str = "permissionProfile/list";
123 pub const PLUGIN_INSTALLED: &str = "plugin/installed";
124 pub const PLUGIN_RECONCILE: &str = "plugin/reconcile";
125 pub const SKILLS_EXTRA_ROOTS_SET: &str = "skills/extraRoots/set";
126 pub const THREAD_GOAL_GET: &str = "thread/goal/get";
127 pub const THREAD_GOAL_SET: &str = "thread/goal/set";
128 pub const THREAD_GOAL_CLEAR: &str = "thread/goal/clear";
129 pub const THREADSECTION_LIST: &str = "threadSection/list";
130 pub const THREADSECTION_CREATE: &str = "threadSection/create";
131 pub const THREADSECTION_UPDATE: &str = "threadSection/update";
132 pub const THREADSECTION_DELETE: &str = "threadSection/delete";
133 pub const THREAD_SECTION_MOVE: &str = "thread/section/move";
134 pub const ACCOUNT_RATELIMITRESETCREDIT_CONSUME: &str = "account/rateLimitResetCredit/consume";
135 pub const ACCOUNT_WORKSPACEMESSAGES_READ: &str = "account/workspaceMessages/read";
136 pub const EXTERNALAGENTCONFIG_IMPORT_READHISTORIES: &str =
137 "externalAgentConfig/import/readHistories";
138 pub const EXTERNALAGENTCONFIG_IMPORT_RECORDHISTORY: &str =
139 "externalAgentConfig/import/recordHistory";
140
141 pub const THREAD_STARTED: &str = "thread/started";
143 pub const STRICT_REVIEW_REQUIRED: &str = "autoApprovalReview/strictReviewRequired";
144 pub const PROJECT_CHANGED: &str = "project/changed";
145 pub const THREAD_PROJECT_UPDATED: &str = "thread/project/updated";
146 pub const THREAD_QUEUE_CHANGED: &str = "thread/queue/changed";
147 pub const THREAD_REVERTED: &str = "thread/reverted";
148 pub const THREAD_PREDICTION_UPDATED: &str = "thread/prediction/updated";
149 pub const MCP_SERVER_EVENT_STREAM: &str = "mcpServer/event/stream/notification";
150 pub const THREAD_STATUS_CHANGED: &str = "thread/status/changed";
151 pub const THREAD_READ_STATE_CHANGED: &str = "thread/readState/changed";
152 pub const THREAD_SECTION_CHANGED: &str = "thread/section/changed";
153 pub const THREAD_TOKEN_USAGE_UPDATED: &str = "thread/tokenUsage/updated";
154 pub const TURN_STARTED: &str = "turn/started";
155 pub const TURN_COMPLETED: &str = "turn/completed";
156 pub const ITEM_STARTED: &str = "item/started";
157 pub const ITEM_COMPLETED: &str = "item/completed";
158 pub const AGENT_MESSAGE_DELTA: &str = "item/agentMessage/delta";
159 pub const CMD_OUTPUT_DELTA: &str = "item/commandExecution/outputDelta";
160 pub const FILE_CHANGE_OUTPUT_DELTA: &str = "item/fileChange/outputDelta";
161 pub const REASONING_DELTA: &str = "item/reasoning/summaryTextDelta";
162 pub const ERROR: &str = "error";
163 pub const ACCOUNT_RATE_LIMITS_UPDATED: &str = "account/rateLimits/updated";
164 pub const MCP_SERVER_STARTUP_STATUS_UPDATED: &str = "mcpServer/startupStatus/updated";
165 pub const MCP_SERVER_OAUTH_LOGIN_COMPLETED: &str = "mcpServer/oauthLogin/completed";
166 pub const REMOTE_CONTROL_STATUS_CHANGED: &str = "remoteControl/status/changed";
167 pub const FILE_CHANGE_PATCH_UPDATED: &str = "item/fileChange/patchUpdated";
168 pub const PLAN_DELTA: &str = "item/plan/delta";
169 pub const TURN_PLAN_UPDATED: &str = "turn/plan/updated";
170 pub const TURN_DIFF_UPDATED: &str = "turn/diff/updated";
171 pub const REASONING_SUMMARY_PART_ADDED: &str = "item/reasoning/summaryPartAdded";
172 pub const REASONING_TEXT_DELTA: &str = "item/reasoning/textDelta";
173 pub const ACCOUNT_LOGIN_COMPLETED: &str = "account/login/completed";
174 pub const DEPRECATION_NOTICE: &str = "deprecationNotice";
175 pub const GUARDIAN_WARNING: &str = "guardianWarning";
176 pub const WARNING: &str = "warning";
177 pub const THREAD_ARCHIVED: &str = "thread/archived";
178 pub const THREAD_CLOSED: &str = "thread/closed";
179 pub const THREAD_DELETED: &str = "thread/deleted";
180 pub const THREAD_UNARCHIVED: &str = "thread/unarchived";
181 pub const THREAD_GOAL_CLEARED: &str = "thread/goal/cleared";
182 pub const THREAD_NAME_UPDATED: &str = "thread/name/updated";
183 pub const THREAD_ATTACHMENT_UPDATED: &str = "thread/attachment/updated";
184 pub const SKILLS_CHANGED: &str = "skills/changed";
185 pub const FS_CHANGED: &str = "fs/changed";
186 pub const CONFIG_WARNING: &str = "configWarning";
187 pub const ACCOUNT_UPDATED: &str = "account/updated";
188 pub const ACCOUNT_GATEWAY_OAUTH_CHANGED: &str = "account/gatewayOAuth/changed";
189 pub const APP_LIST_UPDATED: &str = "app/list/updated";
190 pub const COMMAND_EXEC_OUTPUT_DELTA: &str = "command/exec/outputDelta";
191 pub const EXTERNAL_AGENT_CONFIG_IMPORT_COMPLETED: &str = "externalAgentConfig/import/completed";
192 pub const FUZZY_FILE_SEARCH_SESSION_COMPLETED: &str = "fuzzyFileSearch/sessionCompleted";
193 pub const FUZZY_FILE_SEARCH_SESSION_UPDATED: &str = "fuzzyFileSearch/sessionUpdated";
194 pub const HOOK_COMPLETED: &str = "hook/completed";
195 pub const HOOK_STARTED: &str = "hook/started";
196 pub const ITEM_AUTO_APPROVAL_REVIEW_COMPLETED: &str = "item/autoApprovalReview/completed";
197 pub const ITEM_AUTO_APPROVAL_REVIEW_STARTED: &str = "item/autoApprovalReview/started";
198 pub const ITEM_COMMAND_EXEC_TERMINAL_INTERACTION: &str =
199 "item/commandExecution/terminalInteraction";
200 pub const ITEM_MCP_TOOL_CALL_PROGRESS: &str = "item/mcpToolCall/progress";
201 pub const MODEL_REROUTED: &str = "model/rerouted";
202 pub const MODEL_VERIFICATION: &str = "model/verification";
203 pub const PROCESS_EXITED: &str = "process/exited";
204 pub const PROCESS_OUTPUT_DELTA: &str = "process/outputDelta";
205 pub const SERVER_REQUEST_RESOLVED: &str = "serverRequest/resolved";
206 pub const THREAD_COMPACTED: &str = "thread/compacted";
207 pub const THREAD_GOAL_UPDATED: &str = "thread/goal/updated";
208 pub const THREAD_REALTIME_CLOSED: &str = "thread/realtime/closed";
209 pub const THREAD_REALTIME_ERROR: &str = "thread/realtime/error";
210 pub const THREAD_REALTIME_ITEM_ADDED: &str = "thread/realtime/itemAdded";
211 pub const THREAD_REALTIME_OUTPUT_AUDIO_DELTA: &str = "thread/realtime/outputAudio/delta";
212 pub const THREAD_REALTIME_SDP: &str = "thread/realtime/sdp";
213 pub const THREAD_REALTIME_STARTED: &str = "thread/realtime/started";
214 pub const THREAD_REALTIME_TRANSCRIPT_DELTA: &str = "thread/realtime/transcript/delta";
215 pub const THREAD_REALTIME_TRANSCRIPT_DONE: &str = "thread/realtime/transcript/done";
216 pub const THREAD_REALTIME_ITEM_STARTED: &str = "thread/realtime/item/started";
217 pub const THREAD_REALTIME_ITEM_COMPLETED: &str = "thread/realtime/item/completed";
218 pub const THREAD_REALTIME_ITEM_TRANSCRIPT_DELTA: &str = "thread/realtime/item/transcript/delta";
219 pub const MODEL_PROVIDER_AUTH_RECOVERY_STARTED: &str = "modelProvider/authRecoveryStarted";
220 pub const MODEL_PROVIDER_AUTH_RECOVERY_COMPLETED: &str = "modelProvider/authRecoveryCompleted";
221 pub const WINDOWS_WORLD_WRITABLE_WARNING: &str = "windows/worldWritableWarning";
222 pub const WINDOWS_SANDBOX_SETUP_COMPLETED: &str = "windowsSandbox/setupCompleted";
223 pub const THREAD_SETTINGS_UPDATED: &str = "thread/settings/updated";
224 pub const TURN_MODERATION_METADATA: &str = "turn/moderationMetadata";
225 pub const EXTERNAL_AGENT_CONFIG_IMPORT_PROGRESS: &str = "externalAgentConfig/import/progress";
226 pub const MODEL_SAFETY_BUFFERING_UPDATED: &str = "model/safetyBuffering/updated";
227 pub const THREAD_ENVIRONMENT_CONNECTED: &str = "thread/environment/connected";
228 pub const THREAD_ENVIRONMENT_DISCONNECTED: &str = "thread/environment/disconnected";
229
230 pub const CMD_EXEC_APPROVAL: &str = "item/commandExecution/requestApproval";
232 pub const FILE_CHANGE_APPROVAL: &str = "item/fileChange/requestApproval";
233 pub const TOOL_REQUEST_USER_INPUT: &str = "item/tool/requestUserInput";
234 pub const MCP_SERVER_ELICITATION_REQUEST: &str = "mcpServer/elicitation/request";
235 pub const PERMISSIONS_REQUEST_APPROVAL: &str = "item/permissions/requestApproval";
236 pub const ITEM_TOOL_CALL: &str = "item/tool/call";
237 pub const CHATGPT_AUTH_TOKENS_REFRESH: &str = "account/chatgptAuthTokens/refresh";
238 pub const ATTESTATION_GENERATE: &str = "attestation/generate";
239 pub const APPLY_PATCH_APPROVAL: &str = "applyPatchApproval";
240 pub const EXEC_COMMAND_APPROVAL: &str = "execCommandApproval";
241}
242
243impl FileChangeRequestApprovalResponse {
257 pub fn accept() -> Self {
259 Self {
260 decision: FileChangeApprovalDecision::Accept,
261 }
262 }
263
264 pub fn accept_for_session() -> Self {
266 Self {
267 decision: FileChangeApprovalDecision::AcceptForSession,
268 }
269 }
270
271 pub fn decline() -> Self {
273 Self {
274 decision: FileChangeApprovalDecision::Decline,
275 }
276 }
277
278 pub fn cancel() -> Self {
280 Self {
281 decision: FileChangeApprovalDecision::Cancel,
282 }
283 }
284}
285
286impl CommandExecutionRequestApprovalResponse {
287 pub fn accept() -> Self {
289 Self {
290 decision: CommandExecutionApprovalDecision::Accept,
291 }
292 }
293
294 pub fn accept_for_session() -> Self {
296 Self {
297 decision: CommandExecutionApprovalDecision::AcceptForSession,
298 }
299 }
300
301 pub fn decline() -> Self {
303 Self {
304 decision: CommandExecutionApprovalDecision::Decline,
305 }
306 }
307
308 pub fn cancel() -> Self {
310 Self {
311 decision: CommandExecutionApprovalDecision::Cancel,
312 }
313 }
314}
315
316impl ExecCommandApprovalResponse {
317 pub fn approved() -> Self {
319 Self {
320 decision: ReviewDecision::Approved,
321 }
322 }
323
324 pub fn approved_for_session() -> Self {
326 Self {
327 decision: ReviewDecision::ApprovedForSession,
328 }
329 }
330
331 pub fn denied(rejection: impl Into<String>) -> Self {
333 Self {
334 decision: ReviewDecision::Denied {
335 rejection: rejection.into(),
336 },
337 }
338 }
339
340 pub fn abort() -> Self {
342 Self {
343 decision: ReviewDecision::Abort,
344 }
345 }
346}
347
348impl ApplyPatchApprovalResponse {
349 pub fn approved() -> Self {
351 Self {
352 decision: ReviewDecision::Approved,
353 }
354 }
355
356 pub fn approved_for_session() -> Self {
358 Self {
359 decision: ReviewDecision::ApprovedForSession,
360 }
361 }
362
363 pub fn denied(rejection: impl Into<String>) -> Self {
365 Self {
366 decision: ReviewDecision::Denied {
367 rejection: rejection.into(),
368 },
369 }
370 }
371
372 pub fn abort() -> Self {
374 Self {
375 decision: ReviewDecision::Abort,
376 }
377 }
378}
379
380#[cfg(test)]
381mod tests {
382 use super::*;
383
384 #[test]
385 fn thread_start_params_default_is_empty_object() {
386 let p = ThreadStartParams::default();
387 assert_eq!(serde_json::to_value(&p).unwrap(), serde_json::json!({}));
388 }
389
390 #[test]
391 fn turn_start_params_default_round_trips() {
392 let p = TurnStartParams::default();
393 let v = serde_json::to_value(&p).unwrap();
394 assert_eq!(v["threadId"], "");
396 assert_eq!(v["input"], serde_json::json!([]));
397 }
398
399 #[test]
400 fn thread_resume_and_fork_params_default() {
401 let _ = ThreadResumeParams::default();
402 let _ = ThreadForkParams::default();
403 }
404
405 #[test]
406 fn file_change_approval_response_wire_shape() {
407 assert_eq!(
408 serde_json::to_value(FileChangeRequestApprovalResponse::accept()).unwrap(),
409 serde_json::json!({"decision": "accept"})
410 );
411 assert_eq!(
412 serde_json::to_value(FileChangeRequestApprovalResponse::decline()).unwrap(),
413 serde_json::json!({"decision": "decline"})
414 );
415 }
416
417 #[test]
418 fn command_execution_approval_response_wire_shape() {
419 assert_eq!(
420 serde_json::to_value(CommandExecutionRequestApprovalResponse::accept()).unwrap(),
421 serde_json::json!({"decision": "accept"})
422 );
423 assert_eq!(
424 serde_json::to_value(CommandExecutionRequestApprovalResponse::cancel()).unwrap(),
425 serde_json::json!({"decision": "cancel"})
426 );
427 }
428
429 #[test]
430 fn exec_and_apply_patch_approval_response_wire_shape() {
431 assert_eq!(
432 serde_json::to_value(ExecCommandApprovalResponse::approved()).unwrap(),
433 serde_json::json!({"decision": "approved"})
434 );
435 assert_eq!(
436 serde_json::to_value(ApplyPatchApprovalResponse::denied("keep the original file"))
437 .unwrap(),
438 serde_json::json!({"decision": {"denied": {"rejection": "keep the original file"}}})
439 );
440 }
441
442 #[test]
443 fn hook_event_name_model_request_round_trips() {
444 for (event, wire) in [
445 (HookEventName::PreModelRequest, "preModelRequest"),
446 (HookEventName::PostModelRequest, "postModelRequest"),
447 ] {
448 assert_eq!(serde_json::to_value(&event).unwrap(), wire);
449 assert_eq!(
450 serde_json::from_value::<HookEventName>(serde_json::json!(wire)).unwrap(),
451 event
452 );
453 }
454 }
455
456 #[test]
457 fn gcp_account_round_trips() {
458 let wire = serde_json::json!({"type": "gcp"});
459 assert_eq!(serde_json::to_value(Account::Gcp).unwrap(), wire);
460 assert_eq!(
461 serde_json::from_value::<Account>(wire).unwrap(),
462 Account::Gcp
463 );
464 let response: GetAccountResponse = serde_json::from_value(serde_json::json!({
465 "account": {"type": "gcp"},
466 "requiresOpenaiAuth": false
467 }))
468 .unwrap();
469 assert_eq!(response.account, Some(Account::Gcp));
470 }
471}