@roo-code/types 1.4.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts DELETED
@@ -1,1664 +0,0 @@
1
- import { EventEmitter } from "events"
2
- import { Socket } from "node:net"
3
-
4
- type GlobalSettings = {
5
- currentApiConfigName?: string | undefined
6
- listApiConfigMeta?:
7
- | {
8
- id: string
9
- name: string
10
- apiProvider?:
11
- | (
12
- | "anthropic"
13
- | "glama"
14
- | "openrouter"
15
- | "bedrock"
16
- | "vertex"
17
- | "openai"
18
- | "ollama"
19
- | "vscode-lm"
20
- | "lmstudio"
21
- | "gemini"
22
- | "openai-native"
23
- | "mistral"
24
- | "deepseek"
25
- | "unbound"
26
- | "requesty"
27
- | "human-relay"
28
- | "fake-ai"
29
- | "xai"
30
- | "groq"
31
- | "chutes"
32
- | "litellm"
33
- )
34
- | undefined
35
- }[]
36
- | undefined
37
- pinnedApiConfigs?:
38
- | {
39
- [x: string]: boolean
40
- }
41
- | undefined
42
- lastShownAnnouncementId?: string | undefined
43
- customInstructions?: string | undefined
44
- taskHistory?:
45
- | {
46
- id: string
47
- number: number
48
- ts: number
49
- task: string
50
- tokensIn: number
51
- tokensOut: number
52
- cacheWrites?: number | undefined
53
- cacheReads?: number | undefined
54
- totalCost: number
55
- size?: number | undefined
56
- workspace?: string | undefined
57
- }[]
58
- | undefined
59
- autoApprovalEnabled?: boolean | undefined
60
- alwaysAllowReadOnly?: boolean | undefined
61
- alwaysAllowReadOnlyOutsideWorkspace?: boolean | undefined
62
- alwaysAllowWrite?: boolean | undefined
63
- alwaysAllowWriteOutsideWorkspace?: boolean | undefined
64
- writeDelayMs?: number | undefined
65
- alwaysAllowBrowser?: boolean | undefined
66
- alwaysApproveResubmit?: boolean | undefined
67
- requestDelaySeconds?: number | undefined
68
- alwaysAllowMcp?: boolean | undefined
69
- alwaysAllowModeSwitch?: boolean | undefined
70
- alwaysAllowSubtasks?: boolean | undefined
71
- alwaysAllowExecute?: boolean | undefined
72
- allowedCommands?: string[] | undefined
73
- browserToolEnabled?: boolean | undefined
74
- browserViewportSize?: string | undefined
75
- screenshotQuality?: number | undefined
76
- remoteBrowserEnabled?: boolean | undefined
77
- remoteBrowserHost?: string | undefined
78
- cachedChromeHostUrl?: string | undefined
79
- enableCheckpoints?: boolean | undefined
80
- ttsEnabled?: boolean | undefined
81
- ttsSpeed?: number | undefined
82
- soundEnabled?: boolean | undefined
83
- soundVolume?: number | undefined
84
- maxOpenTabsContext?: number | undefined
85
- maxWorkspaceFiles?: number | undefined
86
- showRooIgnoredFiles?: boolean | undefined
87
- maxReadFileLine?: number | undefined
88
- terminalOutputLineLimit?: number | undefined
89
- terminalShellIntegrationTimeout?: number | undefined
90
- terminalShellIntegrationDisabled?: boolean | undefined
91
- terminalCommandDelay?: number | undefined
92
- terminalPowershellCounter?: boolean | undefined
93
- terminalZshClearEolMark?: boolean | undefined
94
- terminalZshOhMy?: boolean | undefined
95
- terminalZshP10k?: boolean | undefined
96
- terminalZdotdir?: boolean | undefined
97
- terminalCompressProgressBar?: boolean | undefined
98
- rateLimitSeconds?: number | undefined
99
- diffEnabled?: boolean | undefined
100
- fuzzyMatchThreshold?: number | undefined
101
- experiments?:
102
- | {
103
- powerSteering: boolean
104
- }
105
- | undefined
106
- language?:
107
- | (
108
- | "ca"
109
- | "de"
110
- | "en"
111
- | "es"
112
- | "fr"
113
- | "hi"
114
- | "it"
115
- | "ja"
116
- | "ko"
117
- | "nl"
118
- | "pl"
119
- | "pt-BR"
120
- | "ru"
121
- | "tr"
122
- | "vi"
123
- | "zh-CN"
124
- | "zh-TW"
125
- )
126
- | undefined
127
- telemetrySetting?: ("unset" | "enabled" | "disabled") | undefined
128
- mcpEnabled?: boolean | undefined
129
- enableMcpServerCreation?: boolean | undefined
130
- mode?: string | undefined
131
- modeApiConfigs?:
132
- | {
133
- [x: string]: string
134
- }
135
- | undefined
136
- customModes?:
137
- | {
138
- slug: string
139
- name: string
140
- roleDefinition: string
141
- customInstructions?: string | undefined
142
- groups: (
143
- | ("read" | "edit" | "browser" | "command" | "mcp" | "modes")
144
- | [
145
- "read" | "edit" | "browser" | "command" | "mcp" | "modes",
146
- {
147
- fileRegex?: string | undefined
148
- description?: string | undefined
149
- },
150
- ]
151
- )[]
152
- source?: ("global" | "project") | undefined
153
- }[]
154
- | undefined
155
- customModePrompts?:
156
- | {
157
- [x: string]:
158
- | {
159
- roleDefinition?: string | undefined
160
- customInstructions?: string | undefined
161
- }
162
- | undefined
163
- }
164
- | undefined
165
- customSupportPrompts?:
166
- | {
167
- [x: string]: string | undefined
168
- }
169
- | undefined
170
- enhancementApiConfigId?: string | undefined
171
- historyPreviewCollapsed?: boolean | undefined
172
- }
173
-
174
- type ProviderSettings = {
175
- apiProvider?:
176
- | (
177
- | "anthropic"
178
- | "glama"
179
- | "openrouter"
180
- | "bedrock"
181
- | "vertex"
182
- | "openai"
183
- | "ollama"
184
- | "vscode-lm"
185
- | "lmstudio"
186
- | "gemini"
187
- | "openai-native"
188
- | "mistral"
189
- | "deepseek"
190
- | "unbound"
191
- | "requesty"
192
- | "human-relay"
193
- | "fake-ai"
194
- | "xai"
195
- | "groq"
196
- | "chutes"
197
- | "litellm"
198
- )
199
- | undefined
200
- includeMaxTokens?: boolean | undefined
201
- reasoningEffort?: ("low" | "medium" | "high") | undefined
202
- diffEnabled?: boolean | undefined
203
- fuzzyMatchThreshold?: number | undefined
204
- modelTemperature?: (number | null) | undefined
205
- rateLimitSeconds?: number | undefined
206
- modelMaxTokens?: number | undefined
207
- modelMaxThinkingTokens?: number | undefined
208
- apiModelId?: string | undefined
209
- apiKey?: string | undefined
210
- anthropicBaseUrl?: string | undefined
211
- anthropicUseAuthToken?: boolean | undefined
212
- glamaModelId?: string | undefined
213
- glamaApiKey?: string | undefined
214
- openRouterApiKey?: string | undefined
215
- openRouterModelId?: string | undefined
216
- openRouterBaseUrl?: string | undefined
217
- openRouterSpecificProvider?: string | undefined
218
- openRouterUseMiddleOutTransform?: boolean | undefined
219
- awsAccessKey?: string | undefined
220
- awsSecretKey?: string | undefined
221
- awsSessionToken?: string | undefined
222
- awsRegion?: string | undefined
223
- awsUseCrossRegionInference?: boolean | undefined
224
- awsUsePromptCache?: boolean | undefined
225
- awsProfile?: string | undefined
226
- awsUseProfile?: boolean | undefined
227
- awsCustomArn?: string | undefined
228
- vertexKeyFile?: string | undefined
229
- vertexJsonCredentials?: string | undefined
230
- vertexProjectId?: string | undefined
231
- vertexRegion?: string | undefined
232
- openAiBaseUrl?: string | undefined
233
- openAiApiKey?: string | undefined
234
- openAiLegacyFormat?: boolean | undefined
235
- openAiR1FormatEnabled?: boolean | undefined
236
- openAiModelId?: string | undefined
237
- openAiCustomModelInfo?:
238
- | ({
239
- maxTokens?: (number | null) | undefined
240
- maxThinkingTokens?: (number | null) | undefined
241
- contextWindow: number
242
- supportsImages?: boolean | undefined
243
- supportsComputerUse?: boolean | undefined
244
- supportsPromptCache: boolean
245
- inputPrice?: number | undefined
246
- outputPrice?: number | undefined
247
- cacheWritesPrice?: number | undefined
248
- cacheReadsPrice?: number | undefined
249
- description?: string | undefined
250
- reasoningEffort?: ("low" | "medium" | "high") | undefined
251
- thinking?: boolean | undefined
252
- minTokensPerCachePoint?: number | undefined
253
- maxCachePoints?: number | undefined
254
- cachableFields?: string[] | undefined
255
- tiers?:
256
- | {
257
- contextWindow: number
258
- inputPrice?: number | undefined
259
- outputPrice?: number | undefined
260
- cacheWritesPrice?: number | undefined
261
- cacheReadsPrice?: number | undefined
262
- }[]
263
- | undefined
264
- } | null)
265
- | undefined
266
- openAiUseAzure?: boolean | undefined
267
- azureApiVersion?: string | undefined
268
- openAiStreamingEnabled?: boolean | undefined
269
- enableReasoningEffort?: boolean | undefined
270
- openAiHostHeader?: string | undefined
271
- openAiHeaders?:
272
- | {
273
- [x: string]: string
274
- }
275
- | undefined
276
- ollamaModelId?: string | undefined
277
- ollamaBaseUrl?: string | undefined
278
- vsCodeLmModelSelector?:
279
- | {
280
- vendor?: string | undefined
281
- family?: string | undefined
282
- version?: string | undefined
283
- id?: string | undefined
284
- }
285
- | undefined
286
- lmStudioModelId?: string | undefined
287
- lmStudioBaseUrl?: string | undefined
288
- lmStudioDraftModelId?: string | undefined
289
- lmStudioSpeculativeDecodingEnabled?: boolean | undefined
290
- geminiApiKey?: string | undefined
291
- googleGeminiBaseUrl?: string | undefined
292
- openAiNativeApiKey?: string | undefined
293
- openAiNativeBaseUrl?: string | undefined
294
- mistralApiKey?: string | undefined
295
- mistralCodestralUrl?: string | undefined
296
- deepSeekBaseUrl?: string | undefined
297
- deepSeekApiKey?: string | undefined
298
- unboundApiKey?: string | undefined
299
- unboundModelId?: string | undefined
300
- requestyApiKey?: string | undefined
301
- requestyModelId?: string | undefined
302
- fakeAi?: unknown | undefined
303
- xaiApiKey?: string | undefined
304
- groqApiKey?: string | undefined
305
- chutesApiKey?: string | undefined
306
- litellmBaseUrl?: string | undefined
307
- litellmApiKey?: string | undefined
308
- litellmModelId?: string | undefined
309
- }
310
-
311
- type ProviderSettingsEntry = {
312
- id: string
313
- name: string
314
- apiProvider?:
315
- | (
316
- | "anthropic"
317
- | "glama"
318
- | "openrouter"
319
- | "bedrock"
320
- | "vertex"
321
- | "openai"
322
- | "ollama"
323
- | "vscode-lm"
324
- | "lmstudio"
325
- | "gemini"
326
- | "openai-native"
327
- | "mistral"
328
- | "deepseek"
329
- | "unbound"
330
- | "requesty"
331
- | "human-relay"
332
- | "fake-ai"
333
- | "xai"
334
- | "groq"
335
- | "chutes"
336
- | "litellm"
337
- )
338
- | undefined
339
- }
340
-
341
- type ClineMessage = {
342
- ts: number
343
- type: "ask" | "say"
344
- ask?:
345
- | (
346
- | "followup"
347
- | "command"
348
- | "command_output"
349
- | "completion_result"
350
- | "tool"
351
- | "api_req_failed"
352
- | "resume_task"
353
- | "resume_completed_task"
354
- | "mistake_limit_reached"
355
- | "browser_action_launch"
356
- | "use_mcp_server"
357
- )
358
- | undefined
359
- say?:
360
- | (
361
- | "error"
362
- | "api_req_started"
363
- | "api_req_finished"
364
- | "api_req_retried"
365
- | "api_req_retry_delayed"
366
- | "api_req_deleted"
367
- | "text"
368
- | "reasoning"
369
- | "completion_result"
370
- | "user_feedback"
371
- | "user_feedback_diff"
372
- | "command_output"
373
- | "shell_integration_warning"
374
- | "browser_action"
375
- | "browser_action_result"
376
- | "mcp_server_request_started"
377
- | "mcp_server_response"
378
- | "subtask_result"
379
- | "checkpoint_saved"
380
- | "rooignore_error"
381
- | "diff_error"
382
- )
383
- | undefined
384
- text?: string | undefined
385
- images?: string[] | undefined
386
- partial?: boolean | undefined
387
- reasoning?: string | undefined
388
- conversationHistoryIndex?: number | undefined
389
- checkpoint?:
390
- | {
391
- [x: string]: unknown
392
- }
393
- | undefined
394
- progressStatus?:
395
- | {
396
- icon?: string | undefined
397
- text?: string | undefined
398
- }
399
- | undefined
400
- }
401
-
402
- type TokenUsage = {
403
- totalTokensIn: number
404
- totalTokensOut: number
405
- totalCacheWrites?: number | undefined
406
- totalCacheReads?: number | undefined
407
- totalCost: number
408
- contextTokens: number
409
- }
410
-
411
- type RooCodeEvents = {
412
- message: [
413
- {
414
- taskId: string
415
- action: "created" | "updated"
416
- message: {
417
- ts: number
418
- type: "ask" | "say"
419
- ask?:
420
- | (
421
- | "followup"
422
- | "command"
423
- | "command_output"
424
- | "completion_result"
425
- | "tool"
426
- | "api_req_failed"
427
- | "resume_task"
428
- | "resume_completed_task"
429
- | "mistake_limit_reached"
430
- | "browser_action_launch"
431
- | "use_mcp_server"
432
- )
433
- | undefined
434
- say?:
435
- | (
436
- | "error"
437
- | "api_req_started"
438
- | "api_req_finished"
439
- | "api_req_retried"
440
- | "api_req_retry_delayed"
441
- | "api_req_deleted"
442
- | "text"
443
- | "reasoning"
444
- | "completion_result"
445
- | "user_feedback"
446
- | "user_feedback_diff"
447
- | "command_output"
448
- | "shell_integration_warning"
449
- | "browser_action"
450
- | "browser_action_result"
451
- | "mcp_server_request_started"
452
- | "mcp_server_response"
453
- | "subtask_result"
454
- | "checkpoint_saved"
455
- | "rooignore_error"
456
- | "diff_error"
457
- )
458
- | undefined
459
- text?: string | undefined
460
- images?: string[] | undefined
461
- partial?: boolean | undefined
462
- reasoning?: string | undefined
463
- conversationHistoryIndex?: number | undefined
464
- checkpoint?:
465
- | {
466
- [x: string]: unknown
467
- }
468
- | undefined
469
- progressStatus?:
470
- | {
471
- icon?: string | undefined
472
- text?: string | undefined
473
- }
474
- | undefined
475
- }
476
- },
477
- ]
478
- taskCreated: [string]
479
- taskStarted: [string]
480
- taskModeSwitched: [string, string]
481
- taskPaused: [string]
482
- taskUnpaused: [string]
483
- taskAskResponded: [string]
484
- taskAborted: [string]
485
- taskSpawned: [string, string]
486
- taskCompleted: [
487
- string,
488
- {
489
- totalTokensIn: number
490
- totalTokensOut: number
491
- totalCacheWrites?: number | undefined
492
- totalCacheReads?: number | undefined
493
- totalCost: number
494
- contextTokens: number
495
- },
496
- {
497
- [x: string]: {
498
- attempts: number
499
- failures: number
500
- }
501
- },
502
- ]
503
- taskTokenUsageUpdated: [
504
- string,
505
- {
506
- totalTokensIn: number
507
- totalTokensOut: number
508
- totalCacheWrites?: number | undefined
509
- totalCacheReads?: number | undefined
510
- totalCost: number
511
- contextTokens: number
512
- },
513
- ]
514
- taskToolFailed: [
515
- string,
516
- (
517
- | "execute_command"
518
- | "read_file"
519
- | "write_to_file"
520
- | "apply_diff"
521
- | "insert_content"
522
- | "search_and_replace"
523
- | "search_files"
524
- | "list_files"
525
- | "list_code_definition_names"
526
- | "browser_action"
527
- | "use_mcp_tool"
528
- | "access_mcp_resource"
529
- | "ask_followup_question"
530
- | "attempt_completion"
531
- | "switch_mode"
532
- | "new_task"
533
- | "fetch_instructions"
534
- ),
535
- string,
536
- ]
537
- }
538
-
539
- type IpcMessage =
540
- | {
541
- type: "Ack"
542
- origin: "server"
543
- data: {
544
- clientId: string
545
- pid: number
546
- ppid: number
547
- }
548
- }
549
- | {
550
- type: "TaskCommand"
551
- origin: "client"
552
- clientId: string
553
- data:
554
- | {
555
- commandName: "StartNewTask"
556
- data: {
557
- configuration: {
558
- apiProvider?:
559
- | (
560
- | "anthropic"
561
- | "glama"
562
- | "openrouter"
563
- | "bedrock"
564
- | "vertex"
565
- | "openai"
566
- | "ollama"
567
- | "vscode-lm"
568
- | "lmstudio"
569
- | "gemini"
570
- | "openai-native"
571
- | "mistral"
572
- | "deepseek"
573
- | "unbound"
574
- | "requesty"
575
- | "human-relay"
576
- | "fake-ai"
577
- | "xai"
578
- | "groq"
579
- | "chutes"
580
- | "litellm"
581
- )
582
- | undefined
583
- includeMaxTokens?: boolean | undefined
584
- reasoningEffort?: ("low" | "medium" | "high") | undefined
585
- diffEnabled?: boolean | undefined
586
- fuzzyMatchThreshold?: number | undefined
587
- modelTemperature?: (number | null) | undefined
588
- rateLimitSeconds?: number | undefined
589
- modelMaxTokens?: number | undefined
590
- modelMaxThinkingTokens?: number | undefined
591
- apiModelId?: string | undefined
592
- apiKey?: string | undefined
593
- anthropicBaseUrl?: string | undefined
594
- anthropicUseAuthToken?: boolean | undefined
595
- glamaModelId?: string | undefined
596
- glamaApiKey?: string | undefined
597
- openRouterApiKey?: string | undefined
598
- openRouterModelId?: string | undefined
599
- openRouterBaseUrl?: string | undefined
600
- openRouterSpecificProvider?: string | undefined
601
- openRouterUseMiddleOutTransform?: boolean | undefined
602
- awsAccessKey?: string | undefined
603
- awsSecretKey?: string | undefined
604
- awsSessionToken?: string | undefined
605
- awsRegion?: string | undefined
606
- awsUseCrossRegionInference?: boolean | undefined
607
- awsUsePromptCache?: boolean | undefined
608
- awsProfile?: string | undefined
609
- awsUseProfile?: boolean | undefined
610
- awsCustomArn?: string | undefined
611
- vertexKeyFile?: string | undefined
612
- vertexJsonCredentials?: string | undefined
613
- vertexProjectId?: string | undefined
614
- vertexRegion?: string | undefined
615
- openAiBaseUrl?: string | undefined
616
- openAiApiKey?: string | undefined
617
- openAiLegacyFormat?: boolean | undefined
618
- openAiR1FormatEnabled?: boolean | undefined
619
- openAiModelId?: string | undefined
620
- openAiCustomModelInfo?:
621
- | ({
622
- maxTokens?: (number | null) | undefined
623
- maxThinkingTokens?: (number | null) | undefined
624
- contextWindow: number
625
- supportsImages?: boolean | undefined
626
- supportsComputerUse?: boolean | undefined
627
- supportsPromptCache: boolean
628
- inputPrice?: number | undefined
629
- outputPrice?: number | undefined
630
- cacheWritesPrice?: number | undefined
631
- cacheReadsPrice?: number | undefined
632
- description?: string | undefined
633
- reasoningEffort?: ("low" | "medium" | "high") | undefined
634
- thinking?: boolean | undefined
635
- minTokensPerCachePoint?: number | undefined
636
- maxCachePoints?: number | undefined
637
- cachableFields?: string[] | undefined
638
- tiers?:
639
- | {
640
- contextWindow: number
641
- inputPrice?: number | undefined
642
- outputPrice?: number | undefined
643
- cacheWritesPrice?: number | undefined
644
- cacheReadsPrice?: number | undefined
645
- }[]
646
- | undefined
647
- } | null)
648
- | undefined
649
- openAiUseAzure?: boolean | undefined
650
- azureApiVersion?: string | undefined
651
- openAiStreamingEnabled?: boolean | undefined
652
- enableReasoningEffort?: boolean | undefined
653
- openAiHostHeader?: string | undefined
654
- openAiHeaders?:
655
- | {
656
- [x: string]: string
657
- }
658
- | undefined
659
- ollamaModelId?: string | undefined
660
- ollamaBaseUrl?: string | undefined
661
- vsCodeLmModelSelector?:
662
- | {
663
- vendor?: string | undefined
664
- family?: string | undefined
665
- version?: string | undefined
666
- id?: string | undefined
667
- }
668
- | undefined
669
- lmStudioModelId?: string | undefined
670
- lmStudioBaseUrl?: string | undefined
671
- lmStudioDraftModelId?: string | undefined
672
- lmStudioSpeculativeDecodingEnabled?: boolean | undefined
673
- geminiApiKey?: string | undefined
674
- googleGeminiBaseUrl?: string | undefined
675
- openAiNativeApiKey?: string | undefined
676
- openAiNativeBaseUrl?: string | undefined
677
- mistralApiKey?: string | undefined
678
- mistralCodestralUrl?: string | undefined
679
- deepSeekBaseUrl?: string | undefined
680
- deepSeekApiKey?: string | undefined
681
- unboundApiKey?: string | undefined
682
- unboundModelId?: string | undefined
683
- requestyApiKey?: string | undefined
684
- requestyModelId?: string | undefined
685
- fakeAi?: unknown | undefined
686
- xaiApiKey?: string | undefined
687
- groqApiKey?: string | undefined
688
- chutesApiKey?: string | undefined
689
- litellmBaseUrl?: string | undefined
690
- litellmApiKey?: string | undefined
691
- litellmModelId?: string | undefined
692
- currentApiConfigName?: string | undefined
693
- listApiConfigMeta?:
694
- | {
695
- id: string
696
- name: string
697
- apiProvider?:
698
- | (
699
- | "anthropic"
700
- | "glama"
701
- | "openrouter"
702
- | "bedrock"
703
- | "vertex"
704
- | "openai"
705
- | "ollama"
706
- | "vscode-lm"
707
- | "lmstudio"
708
- | "gemini"
709
- | "openai-native"
710
- | "mistral"
711
- | "deepseek"
712
- | "unbound"
713
- | "requesty"
714
- | "human-relay"
715
- | "fake-ai"
716
- | "xai"
717
- | "groq"
718
- | "chutes"
719
- | "litellm"
720
- )
721
- | undefined
722
- }[]
723
- | undefined
724
- pinnedApiConfigs?:
725
- | {
726
- [x: string]: boolean
727
- }
728
- | undefined
729
- lastShownAnnouncementId?: string | undefined
730
- customInstructions?: string | undefined
731
- taskHistory?:
732
- | {
733
- id: string
734
- number: number
735
- ts: number
736
- task: string
737
- tokensIn: number
738
- tokensOut: number
739
- cacheWrites?: number | undefined
740
- cacheReads?: number | undefined
741
- totalCost: number
742
- size?: number | undefined
743
- workspace?: string | undefined
744
- }[]
745
- | undefined
746
- autoApprovalEnabled?: boolean | undefined
747
- alwaysAllowReadOnly?: boolean | undefined
748
- alwaysAllowReadOnlyOutsideWorkspace?: boolean | undefined
749
- alwaysAllowWrite?: boolean | undefined
750
- alwaysAllowWriteOutsideWorkspace?: boolean | undefined
751
- writeDelayMs?: number | undefined
752
- alwaysAllowBrowser?: boolean | undefined
753
- alwaysApproveResubmit?: boolean | undefined
754
- requestDelaySeconds?: number | undefined
755
- alwaysAllowMcp?: boolean | undefined
756
- alwaysAllowModeSwitch?: boolean | undefined
757
- alwaysAllowSubtasks?: boolean | undefined
758
- alwaysAllowExecute?: boolean | undefined
759
- allowedCommands?: string[] | undefined
760
- browserToolEnabled?: boolean | undefined
761
- browserViewportSize?: string | undefined
762
- screenshotQuality?: number | undefined
763
- remoteBrowserEnabled?: boolean | undefined
764
- remoteBrowserHost?: string | undefined
765
- cachedChromeHostUrl?: string | undefined
766
- enableCheckpoints?: boolean | undefined
767
- ttsEnabled?: boolean | undefined
768
- ttsSpeed?: number | undefined
769
- soundEnabled?: boolean | undefined
770
- soundVolume?: number | undefined
771
- maxOpenTabsContext?: number | undefined
772
- maxWorkspaceFiles?: number | undefined
773
- showRooIgnoredFiles?: boolean | undefined
774
- maxReadFileLine?: number | undefined
775
- terminalOutputLineLimit?: number | undefined
776
- terminalShellIntegrationTimeout?: number | undefined
777
- terminalShellIntegrationDisabled?: boolean | undefined
778
- terminalCommandDelay?: number | undefined
779
- terminalPowershellCounter?: boolean | undefined
780
- terminalZshClearEolMark?: boolean | undefined
781
- terminalZshOhMy?: boolean | undefined
782
- terminalZshP10k?: boolean | undefined
783
- terminalZdotdir?: boolean | undefined
784
- terminalCompressProgressBar?: boolean | undefined
785
- experiments?:
786
- | {
787
- powerSteering: boolean
788
- }
789
- | undefined
790
- language?:
791
- | (
792
- | "ca"
793
- | "de"
794
- | "en"
795
- | "es"
796
- | "fr"
797
- | "hi"
798
- | "it"
799
- | "ja"
800
- | "ko"
801
- | "nl"
802
- | "pl"
803
- | "pt-BR"
804
- | "ru"
805
- | "tr"
806
- | "vi"
807
- | "zh-CN"
808
- | "zh-TW"
809
- )
810
- | undefined
811
- telemetrySetting?: ("unset" | "enabled" | "disabled") | undefined
812
- mcpEnabled?: boolean | undefined
813
- enableMcpServerCreation?: boolean | undefined
814
- mode?: string | undefined
815
- modeApiConfigs?:
816
- | {
817
- [x: string]: string
818
- }
819
- | undefined
820
- customModes?:
821
- | {
822
- slug: string
823
- name: string
824
- roleDefinition: string
825
- customInstructions?: string | undefined
826
- groups: (
827
- | ("read" | "edit" | "browser" | "command" | "mcp" | "modes")
828
- | [
829
- "read" | "edit" | "browser" | "command" | "mcp" | "modes",
830
- {
831
- fileRegex?: string | undefined
832
- description?: string | undefined
833
- },
834
- ]
835
- )[]
836
- source?: ("global" | "project") | undefined
837
- }[]
838
- | undefined
839
- customModePrompts?:
840
- | {
841
- [x: string]:
842
- | {
843
- roleDefinition?: string | undefined
844
- customInstructions?: string | undefined
845
- }
846
- | undefined
847
- }
848
- | undefined
849
- customSupportPrompts?:
850
- | {
851
- [x: string]: string | undefined
852
- }
853
- | undefined
854
- enhancementApiConfigId?: string | undefined
855
- historyPreviewCollapsed?: boolean | undefined
856
- }
857
- text: string
858
- images?: string[] | undefined
859
- newTab?: boolean | undefined
860
- }
861
- }
862
- | {
863
- commandName: "CancelTask"
864
- data: string
865
- }
866
- | {
867
- commandName: "CloseTask"
868
- data: string
869
- }
870
- }
871
- | {
872
- type: "TaskEvent"
873
- origin: "server"
874
- relayClientId?: string | undefined
875
- data:
876
- | {
877
- eventName: "message"
878
- payload: [
879
- {
880
- taskId: string
881
- action: "created" | "updated"
882
- message: {
883
- ts: number
884
- type: "ask" | "say"
885
- ask?:
886
- | (
887
- | "followup"
888
- | "command"
889
- | "command_output"
890
- | "completion_result"
891
- | "tool"
892
- | "api_req_failed"
893
- | "resume_task"
894
- | "resume_completed_task"
895
- | "mistake_limit_reached"
896
- | "browser_action_launch"
897
- | "use_mcp_server"
898
- )
899
- | undefined
900
- say?:
901
- | (
902
- | "error"
903
- | "api_req_started"
904
- | "api_req_finished"
905
- | "api_req_retried"
906
- | "api_req_retry_delayed"
907
- | "api_req_deleted"
908
- | "text"
909
- | "reasoning"
910
- | "completion_result"
911
- | "user_feedback"
912
- | "user_feedback_diff"
913
- | "command_output"
914
- | "shell_integration_warning"
915
- | "browser_action"
916
- | "browser_action_result"
917
- | "mcp_server_request_started"
918
- | "mcp_server_response"
919
- | "subtask_result"
920
- | "checkpoint_saved"
921
- | "rooignore_error"
922
- | "diff_error"
923
- )
924
- | undefined
925
- text?: string | undefined
926
- images?: string[] | undefined
927
- partial?: boolean | undefined
928
- reasoning?: string | undefined
929
- conversationHistoryIndex?: number | undefined
930
- checkpoint?:
931
- | {
932
- [x: string]: unknown
933
- }
934
- | undefined
935
- progressStatus?:
936
- | {
937
- icon?: string | undefined
938
- text?: string | undefined
939
- }
940
- | undefined
941
- }
942
- },
943
- ]
944
- }
945
- | {
946
- eventName: "taskCreated"
947
- payload: [string]
948
- }
949
- | {
950
- eventName: "taskStarted"
951
- payload: [string]
952
- }
953
- | {
954
- eventName: "taskModeSwitched"
955
- payload: [string, string]
956
- }
957
- | {
958
- eventName: "taskPaused"
959
- payload: [string]
960
- }
961
- | {
962
- eventName: "taskUnpaused"
963
- payload: [string]
964
- }
965
- | {
966
- eventName: "taskAskResponded"
967
- payload: [string]
968
- }
969
- | {
970
- eventName: "taskAborted"
971
- payload: [string]
972
- }
973
- | {
974
- eventName: "taskSpawned"
975
- payload: [string, string]
976
- }
977
- | {
978
- eventName: "taskCompleted"
979
- payload: [
980
- string,
981
- {
982
- totalTokensIn: number
983
- totalTokensOut: number
984
- totalCacheWrites?: number | undefined
985
- totalCacheReads?: number | undefined
986
- totalCost: number
987
- contextTokens: number
988
- },
989
- {
990
- [x: string]: {
991
- attempts: number
992
- failures: number
993
- }
994
- },
995
- ]
996
- }
997
- | {
998
- eventName: "taskTokenUsageUpdated"
999
- payload: [
1000
- string,
1001
- {
1002
- totalTokensIn: number
1003
- totalTokensOut: number
1004
- totalCacheWrites?: number | undefined
1005
- totalCacheReads?: number | undefined
1006
- totalCost: number
1007
- contextTokens: number
1008
- },
1009
- ]
1010
- }
1011
- }
1012
-
1013
- type TaskCommand =
1014
- | {
1015
- commandName: "StartNewTask"
1016
- data: {
1017
- configuration: {
1018
- apiProvider?:
1019
- | (
1020
- | "anthropic"
1021
- | "glama"
1022
- | "openrouter"
1023
- | "bedrock"
1024
- | "vertex"
1025
- | "openai"
1026
- | "ollama"
1027
- | "vscode-lm"
1028
- | "lmstudio"
1029
- | "gemini"
1030
- | "openai-native"
1031
- | "mistral"
1032
- | "deepseek"
1033
- | "unbound"
1034
- | "requesty"
1035
- | "human-relay"
1036
- | "fake-ai"
1037
- | "xai"
1038
- | "groq"
1039
- | "chutes"
1040
- | "litellm"
1041
- )
1042
- | undefined
1043
- includeMaxTokens?: boolean | undefined
1044
- reasoningEffort?: ("low" | "medium" | "high") | undefined
1045
- diffEnabled?: boolean | undefined
1046
- fuzzyMatchThreshold?: number | undefined
1047
- modelTemperature?: (number | null) | undefined
1048
- rateLimitSeconds?: number | undefined
1049
- modelMaxTokens?: number | undefined
1050
- modelMaxThinkingTokens?: number | undefined
1051
- apiModelId?: string | undefined
1052
- apiKey?: string | undefined
1053
- anthropicBaseUrl?: string | undefined
1054
- anthropicUseAuthToken?: boolean | undefined
1055
- glamaModelId?: string | undefined
1056
- glamaApiKey?: string | undefined
1057
- openRouterApiKey?: string | undefined
1058
- openRouterModelId?: string | undefined
1059
- openRouterBaseUrl?: string | undefined
1060
- openRouterSpecificProvider?: string | undefined
1061
- openRouterUseMiddleOutTransform?: boolean | undefined
1062
- awsAccessKey?: string | undefined
1063
- awsSecretKey?: string | undefined
1064
- awsSessionToken?: string | undefined
1065
- awsRegion?: string | undefined
1066
- awsUseCrossRegionInference?: boolean | undefined
1067
- awsUsePromptCache?: boolean | undefined
1068
- awsProfile?: string | undefined
1069
- awsUseProfile?: boolean | undefined
1070
- awsCustomArn?: string | undefined
1071
- vertexKeyFile?: string | undefined
1072
- vertexJsonCredentials?: string | undefined
1073
- vertexProjectId?: string | undefined
1074
- vertexRegion?: string | undefined
1075
- openAiBaseUrl?: string | undefined
1076
- openAiApiKey?: string | undefined
1077
- openAiLegacyFormat?: boolean | undefined
1078
- openAiR1FormatEnabled?: boolean | undefined
1079
- openAiModelId?: string | undefined
1080
- openAiCustomModelInfo?:
1081
- | ({
1082
- maxTokens?: (number | null) | undefined
1083
- maxThinkingTokens?: (number | null) | undefined
1084
- contextWindow: number
1085
- supportsImages?: boolean | undefined
1086
- supportsComputerUse?: boolean | undefined
1087
- supportsPromptCache: boolean
1088
- inputPrice?: number | undefined
1089
- outputPrice?: number | undefined
1090
- cacheWritesPrice?: number | undefined
1091
- cacheReadsPrice?: number | undefined
1092
- description?: string | undefined
1093
- reasoningEffort?: ("low" | "medium" | "high") | undefined
1094
- thinking?: boolean | undefined
1095
- minTokensPerCachePoint?: number | undefined
1096
- maxCachePoints?: number | undefined
1097
- cachableFields?: string[] | undefined
1098
- tiers?:
1099
- | {
1100
- contextWindow: number
1101
- inputPrice?: number | undefined
1102
- outputPrice?: number | undefined
1103
- cacheWritesPrice?: number | undefined
1104
- cacheReadsPrice?: number | undefined
1105
- }[]
1106
- | undefined
1107
- } | null)
1108
- | undefined
1109
- openAiUseAzure?: boolean | undefined
1110
- azureApiVersion?: string | undefined
1111
- openAiStreamingEnabled?: boolean | undefined
1112
- enableReasoningEffort?: boolean | undefined
1113
- openAiHostHeader?: string | undefined
1114
- openAiHeaders?:
1115
- | {
1116
- [x: string]: string
1117
- }
1118
- | undefined
1119
- ollamaModelId?: string | undefined
1120
- ollamaBaseUrl?: string | undefined
1121
- vsCodeLmModelSelector?:
1122
- | {
1123
- vendor?: string | undefined
1124
- family?: string | undefined
1125
- version?: string | undefined
1126
- id?: string | undefined
1127
- }
1128
- | undefined
1129
- lmStudioModelId?: string | undefined
1130
- lmStudioBaseUrl?: string | undefined
1131
- lmStudioDraftModelId?: string | undefined
1132
- lmStudioSpeculativeDecodingEnabled?: boolean | undefined
1133
- geminiApiKey?: string | undefined
1134
- googleGeminiBaseUrl?: string | undefined
1135
- openAiNativeApiKey?: string | undefined
1136
- openAiNativeBaseUrl?: string | undefined
1137
- mistralApiKey?: string | undefined
1138
- mistralCodestralUrl?: string | undefined
1139
- deepSeekBaseUrl?: string | undefined
1140
- deepSeekApiKey?: string | undefined
1141
- unboundApiKey?: string | undefined
1142
- unboundModelId?: string | undefined
1143
- requestyApiKey?: string | undefined
1144
- requestyModelId?: string | undefined
1145
- fakeAi?: unknown | undefined
1146
- xaiApiKey?: string | undefined
1147
- groqApiKey?: string | undefined
1148
- chutesApiKey?: string | undefined
1149
- litellmBaseUrl?: string | undefined
1150
- litellmApiKey?: string | undefined
1151
- litellmModelId?: string | undefined
1152
- currentApiConfigName?: string | undefined
1153
- listApiConfigMeta?:
1154
- | {
1155
- id: string
1156
- name: string
1157
- apiProvider?:
1158
- | (
1159
- | "anthropic"
1160
- | "glama"
1161
- | "openrouter"
1162
- | "bedrock"
1163
- | "vertex"
1164
- | "openai"
1165
- | "ollama"
1166
- | "vscode-lm"
1167
- | "lmstudio"
1168
- | "gemini"
1169
- | "openai-native"
1170
- | "mistral"
1171
- | "deepseek"
1172
- | "unbound"
1173
- | "requesty"
1174
- | "human-relay"
1175
- | "fake-ai"
1176
- | "xai"
1177
- | "groq"
1178
- | "chutes"
1179
- | "litellm"
1180
- )
1181
- | undefined
1182
- }[]
1183
- | undefined
1184
- pinnedApiConfigs?:
1185
- | {
1186
- [x: string]: boolean
1187
- }
1188
- | undefined
1189
- lastShownAnnouncementId?: string | undefined
1190
- customInstructions?: string | undefined
1191
- taskHistory?:
1192
- | {
1193
- id: string
1194
- number: number
1195
- ts: number
1196
- task: string
1197
- tokensIn: number
1198
- tokensOut: number
1199
- cacheWrites?: number | undefined
1200
- cacheReads?: number | undefined
1201
- totalCost: number
1202
- size?: number | undefined
1203
- workspace?: string | undefined
1204
- }[]
1205
- | undefined
1206
- autoApprovalEnabled?: boolean | undefined
1207
- alwaysAllowReadOnly?: boolean | undefined
1208
- alwaysAllowReadOnlyOutsideWorkspace?: boolean | undefined
1209
- alwaysAllowWrite?: boolean | undefined
1210
- alwaysAllowWriteOutsideWorkspace?: boolean | undefined
1211
- writeDelayMs?: number | undefined
1212
- alwaysAllowBrowser?: boolean | undefined
1213
- alwaysApproveResubmit?: boolean | undefined
1214
- requestDelaySeconds?: number | undefined
1215
- alwaysAllowMcp?: boolean | undefined
1216
- alwaysAllowModeSwitch?: boolean | undefined
1217
- alwaysAllowSubtasks?: boolean | undefined
1218
- alwaysAllowExecute?: boolean | undefined
1219
- allowedCommands?: string[] | undefined
1220
- browserToolEnabled?: boolean | undefined
1221
- browserViewportSize?: string | undefined
1222
- screenshotQuality?: number | undefined
1223
- remoteBrowserEnabled?: boolean | undefined
1224
- remoteBrowserHost?: string | undefined
1225
- cachedChromeHostUrl?: string | undefined
1226
- enableCheckpoints?: boolean | undefined
1227
- ttsEnabled?: boolean | undefined
1228
- ttsSpeed?: number | undefined
1229
- soundEnabled?: boolean | undefined
1230
- soundVolume?: number | undefined
1231
- maxOpenTabsContext?: number | undefined
1232
- maxWorkspaceFiles?: number | undefined
1233
- showRooIgnoredFiles?: boolean | undefined
1234
- maxReadFileLine?: number | undefined
1235
- terminalOutputLineLimit?: number | undefined
1236
- terminalShellIntegrationTimeout?: number | undefined
1237
- terminalShellIntegrationDisabled?: boolean | undefined
1238
- terminalCommandDelay?: number | undefined
1239
- terminalPowershellCounter?: boolean | undefined
1240
- terminalZshClearEolMark?: boolean | undefined
1241
- terminalZshOhMy?: boolean | undefined
1242
- terminalZshP10k?: boolean | undefined
1243
- terminalZdotdir?: boolean | undefined
1244
- terminalCompressProgressBar?: boolean | undefined
1245
- experiments?:
1246
- | {
1247
- powerSteering: boolean
1248
- }
1249
- | undefined
1250
- language?:
1251
- | (
1252
- | "ca"
1253
- | "de"
1254
- | "en"
1255
- | "es"
1256
- | "fr"
1257
- | "hi"
1258
- | "it"
1259
- | "ja"
1260
- | "ko"
1261
- | "nl"
1262
- | "pl"
1263
- | "pt-BR"
1264
- | "ru"
1265
- | "tr"
1266
- | "vi"
1267
- | "zh-CN"
1268
- | "zh-TW"
1269
- )
1270
- | undefined
1271
- telemetrySetting?: ("unset" | "enabled" | "disabled") | undefined
1272
- mcpEnabled?: boolean | undefined
1273
- enableMcpServerCreation?: boolean | undefined
1274
- mode?: string | undefined
1275
- modeApiConfigs?:
1276
- | {
1277
- [x: string]: string
1278
- }
1279
- | undefined
1280
- customModes?:
1281
- | {
1282
- slug: string
1283
- name: string
1284
- roleDefinition: string
1285
- customInstructions?: string | undefined
1286
- groups: (
1287
- | ("read" | "edit" | "browser" | "command" | "mcp" | "modes")
1288
- | [
1289
- "read" | "edit" | "browser" | "command" | "mcp" | "modes",
1290
- {
1291
- fileRegex?: string | undefined
1292
- description?: string | undefined
1293
- },
1294
- ]
1295
- )[]
1296
- source?: ("global" | "project") | undefined
1297
- }[]
1298
- | undefined
1299
- customModePrompts?:
1300
- | {
1301
- [x: string]:
1302
- | {
1303
- roleDefinition?: string | undefined
1304
- customInstructions?: string | undefined
1305
- }
1306
- | undefined
1307
- }
1308
- | undefined
1309
- customSupportPrompts?:
1310
- | {
1311
- [x: string]: string | undefined
1312
- }
1313
- | undefined
1314
- enhancementApiConfigId?: string | undefined
1315
- historyPreviewCollapsed?: boolean | undefined
1316
- }
1317
- text: string
1318
- images?: string[] | undefined
1319
- newTab?: boolean | undefined
1320
- }
1321
- }
1322
- | {
1323
- commandName: "CancelTask"
1324
- data: string
1325
- }
1326
- | {
1327
- commandName: "CloseTask"
1328
- data: string
1329
- }
1330
-
1331
- type TaskEvent =
1332
- | {
1333
- eventName: "message"
1334
- payload: [
1335
- {
1336
- taskId: string
1337
- action: "created" | "updated"
1338
- message: {
1339
- ts: number
1340
- type: "ask" | "say"
1341
- ask?:
1342
- | (
1343
- | "followup"
1344
- | "command"
1345
- | "command_output"
1346
- | "completion_result"
1347
- | "tool"
1348
- | "api_req_failed"
1349
- | "resume_task"
1350
- | "resume_completed_task"
1351
- | "mistake_limit_reached"
1352
- | "browser_action_launch"
1353
- | "use_mcp_server"
1354
- )
1355
- | undefined
1356
- say?:
1357
- | (
1358
- | "error"
1359
- | "api_req_started"
1360
- | "api_req_finished"
1361
- | "api_req_retried"
1362
- | "api_req_retry_delayed"
1363
- | "api_req_deleted"
1364
- | "text"
1365
- | "reasoning"
1366
- | "completion_result"
1367
- | "user_feedback"
1368
- | "user_feedback_diff"
1369
- | "command_output"
1370
- | "shell_integration_warning"
1371
- | "browser_action"
1372
- | "browser_action_result"
1373
- | "mcp_server_request_started"
1374
- | "mcp_server_response"
1375
- | "subtask_result"
1376
- | "checkpoint_saved"
1377
- | "rooignore_error"
1378
- | "diff_error"
1379
- )
1380
- | undefined
1381
- text?: string | undefined
1382
- images?: string[] | undefined
1383
- partial?: boolean | undefined
1384
- reasoning?: string | undefined
1385
- conversationHistoryIndex?: number | undefined
1386
- checkpoint?:
1387
- | {
1388
- [x: string]: unknown
1389
- }
1390
- | undefined
1391
- progressStatus?:
1392
- | {
1393
- icon?: string | undefined
1394
- text?: string | undefined
1395
- }
1396
- | undefined
1397
- }
1398
- },
1399
- ]
1400
- }
1401
- | {
1402
- eventName: "taskCreated"
1403
- payload: [string]
1404
- }
1405
- | {
1406
- eventName: "taskStarted"
1407
- payload: [string]
1408
- }
1409
- | {
1410
- eventName: "taskModeSwitched"
1411
- payload: [string, string]
1412
- }
1413
- | {
1414
- eventName: "taskPaused"
1415
- payload: [string]
1416
- }
1417
- | {
1418
- eventName: "taskUnpaused"
1419
- payload: [string]
1420
- }
1421
- | {
1422
- eventName: "taskAskResponded"
1423
- payload: [string]
1424
- }
1425
- | {
1426
- eventName: "taskAborted"
1427
- payload: [string]
1428
- }
1429
- | {
1430
- eventName: "taskSpawned"
1431
- payload: [string, string]
1432
- }
1433
- | {
1434
- eventName: "taskCompleted"
1435
- payload: [
1436
- string,
1437
- {
1438
- totalTokensIn: number
1439
- totalTokensOut: number
1440
- totalCacheWrites?: number | undefined
1441
- totalCacheReads?: number | undefined
1442
- totalCost: number
1443
- contextTokens: number
1444
- },
1445
- {
1446
- [x: string]: {
1447
- attempts: number
1448
- failures: number
1449
- }
1450
- },
1451
- ]
1452
- }
1453
- | {
1454
- eventName: "taskTokenUsageUpdated"
1455
- payload: [
1456
- string,
1457
- {
1458
- totalTokensIn: number
1459
- totalTokensOut: number
1460
- totalCacheWrites?: number | undefined
1461
- totalCacheReads?: number | undefined
1462
- totalCost: number
1463
- contextTokens: number
1464
- },
1465
- ]
1466
- }
1467
-
1468
- /**
1469
- * RooCodeEvent
1470
- */
1471
- declare enum RooCodeEventName {
1472
- Message = "message",
1473
- TaskCreated = "taskCreated",
1474
- TaskStarted = "taskStarted",
1475
- TaskModeSwitched = "taskModeSwitched",
1476
- TaskPaused = "taskPaused",
1477
- TaskUnpaused = "taskUnpaused",
1478
- TaskAskResponded = "taskAskResponded",
1479
- TaskAborted = "taskAborted",
1480
- TaskSpawned = "taskSpawned",
1481
- TaskCompleted = "taskCompleted",
1482
- TaskTokenUsageUpdated = "taskTokenUsageUpdated",
1483
- TaskToolFailed = "taskToolFailed",
1484
- }
1485
- /**
1486
- * IpcMessage
1487
- */
1488
- declare enum IpcMessageType {
1489
- Connect = "Connect",
1490
- Disconnect = "Disconnect",
1491
- Ack = "Ack",
1492
- TaskCommand = "TaskCommand",
1493
- TaskEvent = "TaskEvent",
1494
- }
1495
- declare enum IpcOrigin {
1496
- Client = "client",
1497
- Server = "server",
1498
- }
1499
-
1500
- /**
1501
- * RooCodeAPI
1502
- */
1503
- type RooCodeSettings = GlobalSettings & ProviderSettings
1504
- interface RooCodeAPI extends EventEmitter<RooCodeEvents> {
1505
- /**
1506
- * Starts a new task with an optional initial message and images.
1507
- * @param task Optional initial task message.
1508
- * @param images Optional array of image data URIs (e.g., "data:image/webp;base64,...").
1509
- * @returns The ID of the new task.
1510
- */
1511
- startNewTask({
1512
- configuration,
1513
- text,
1514
- images,
1515
- newTab,
1516
- }: {
1517
- configuration?: RooCodeSettings
1518
- text?: string
1519
- images?: string[]
1520
- newTab?: boolean
1521
- }): Promise<string>
1522
- /**
1523
- * Resumes a task with the given ID.
1524
- * @param taskId The ID of the task to resume.
1525
- * @throws Error if the task is not found in the task history.
1526
- */
1527
- resumeTask(taskId: string): Promise<void>
1528
- /**
1529
- * Checks if a task with the given ID is in the task history.
1530
- * @param taskId The ID of the task to check.
1531
- * @returns True if the task is in the task history, false otherwise.
1532
- */
1533
- isTaskInHistory(taskId: string): Promise<boolean>
1534
- /**
1535
- * Returns the current task stack.
1536
- * @returns An array of task IDs.
1537
- */
1538
- getCurrentTaskStack(): string[]
1539
- /**
1540
- * Clears the current task.
1541
- */
1542
- clearCurrentTask(lastMessage?: string): Promise<void>
1543
- /**
1544
- * Cancels the current task.
1545
- */
1546
- cancelCurrentTask(): Promise<void>
1547
- /**
1548
- * Sends a message to the current task.
1549
- * @param message Optional message to send.
1550
- * @param images Optional array of image data URIs (e.g., "data:image/webp;base64,...").
1551
- */
1552
- sendMessage(message?: string, images?: string[]): Promise<void>
1553
- /**
1554
- * Simulates pressing the primary button in the chat interface.
1555
- */
1556
- pressPrimaryButton(): Promise<void>
1557
- /**
1558
- * Simulates pressing the secondary button in the chat interface.
1559
- */
1560
- pressSecondaryButton(): Promise<void>
1561
- /**
1562
- * Returns true if the API is ready to use.
1563
- */
1564
- isReady(): boolean
1565
- /**
1566
- * Returns the current configuration.
1567
- * @returns The current configuration.
1568
- */
1569
- getConfiguration(): RooCodeSettings
1570
- /**
1571
- * Sets the configuration for the current task.
1572
- * @param values An object containing key-value pairs to set.
1573
- */
1574
- setConfiguration(values: RooCodeSettings): Promise<void>
1575
- /**
1576
- * Returns a list of all configured profile names
1577
- * @returns Array of profile names
1578
- */
1579
- getProfiles(): string[]
1580
- /**
1581
- * Returns the profile entry for a given name
1582
- * @param name The name of the profile
1583
- * @returns The profile entry, or undefined if the profile does not exist
1584
- */
1585
- getProfileEntry(name: string): ProviderSettingsEntry | undefined
1586
- /**
1587
- * Creates a new API configuration profile
1588
- * @param name The name of the profile
1589
- * @param profile The profile to create; defaults to an empty object
1590
- * @param activate Whether to activate the profile after creation; defaults to true
1591
- * @returns The ID of the created profile
1592
- * @throws Error if the profile already exists
1593
- */
1594
- createProfile(name: string, profile?: ProviderSettings, activate?: boolean): Promise<string>
1595
- /**
1596
- * Updates an existing API configuration profile
1597
- * @param name The name of the profile
1598
- * @param profile The profile to update
1599
- * @param activate Whether to activate the profile after update; defaults to true
1600
- * @returns The ID of the updated profile
1601
- * @throws Error if the profile does not exist
1602
- */
1603
- updateProfile(name: string, profile: ProviderSettings, activate?: boolean): Promise<string | undefined>
1604
- /**
1605
- * Creates a new API configuration profile or updates an existing one
1606
- * @param name The name of the profile
1607
- * @param profile The profile to create or update; defaults to an empty object
1608
- * @param activate Whether to activate the profile after upsert; defaults to true
1609
- * @returns The ID of the upserted profile
1610
- */
1611
- upsertProfile(name: string, profile: ProviderSettings, activate?: boolean): Promise<string | undefined>
1612
- /**
1613
- * Deletes a profile by name
1614
- * @param name The name of the profile to delete
1615
- * @throws Error if the profile does not exist
1616
- */
1617
- deleteProfile(name: string): Promise<void>
1618
- /**
1619
- * Returns the name of the currently active profile
1620
- * @returns The profile name, or undefined if no profile is active
1621
- */
1622
- getActiveProfile(): string | undefined
1623
- /**
1624
- * Changes the active API configuration profile
1625
- * @param name The name of the profile to activate
1626
- * @throws Error if the profile does not exist
1627
- */
1628
- setActiveProfile(name: string): Promise<string | undefined>
1629
- }
1630
- /**
1631
- * RooCodeIpcServer
1632
- */
1633
- type IpcServerEvents = {
1634
- [IpcMessageType.Connect]: [clientId: string]
1635
- [IpcMessageType.Disconnect]: [clientId: string]
1636
- [IpcMessageType.TaskCommand]: [clientId: string, data: TaskCommand]
1637
- [IpcMessageType.TaskEvent]: [relayClientId: string | undefined, data: TaskEvent]
1638
- }
1639
- interface RooCodeIpcServer extends EventEmitter<IpcServerEvents> {
1640
- listen(): void
1641
- broadcast(message: IpcMessage): void
1642
- send(client: string | Socket, message: IpcMessage): void
1643
- get socketPath(): string
1644
- get isListening(): boolean
1645
- }
1646
-
1647
- export {
1648
- type ClineMessage,
1649
- type GlobalSettings,
1650
- type IpcMessage,
1651
- IpcMessageType,
1652
- IpcOrigin,
1653
- type IpcServerEvents,
1654
- type ProviderSettings,
1655
- type ProviderSettingsEntry,
1656
- type RooCodeAPI,
1657
- RooCodeEventName,
1658
- type RooCodeEvents,
1659
- type RooCodeIpcServer,
1660
- type RooCodeSettings,
1661
- type TaskCommand,
1662
- type TaskEvent,
1663
- type TokenUsage,
1664
- }