mirror of
https://github.com/RooVetGit/Roo-Code.git
synced 2026-08-28 05:27:24 +00:00
Publish Roo Code types to NPM (#3563)
This commit is contained in:
Chris Estreich
GitHub
parent
7a8613c34e
commit
f031914450
8 changed files with 7150 additions and 0 deletions
34
roo-code-types/.gitignore
vendored
Normal file
34
roo-code-types/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
# Dependency directories
|
||||
node_modules/
|
||||
npm-debug.log
|
||||
yarn-debug.log
|
||||
yarn-error.log
|
||||
|
||||
# Build output
|
||||
dist/
|
||||
build/
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
# Editor directories and files
|
||||
.idea/
|
||||
.vscode/
|
||||
*.suo
|
||||
*.ntvs*
|
||||
*.njsproj
|
||||
*.sln
|
||||
*.sw?
|
||||
|
||||
# OS generated files
|
||||
.DS_Store
|
||||
.DS_Store?
|
||||
._*
|
||||
.Spotlight-V100
|
||||
.Trashes
|
||||
ehthumbs.db
|
||||
Thumbs.db
|
||||
3
roo-code-types/.releaserc
Normal file
3
roo-code-types/.releaserc
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"branches": ["main"]
|
||||
}
|
||||
21
roo-code-types/LICENSE
Normal file
21
roo-code-types/LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2020 Roo Code Inc
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
58
roo-code-types/README.md
Normal file
58
roo-code-types/README.md
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
# Roo Code Types
|
||||
|
||||
TypeScript type definitions for Roo Code.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install roo-code-types
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
yarn add roo-code-types
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Import the types in your TypeScript files:
|
||||
|
||||
```typescript
|
||||
import {
|
||||
RooCodeAPI,
|
||||
RooCodeSettings,
|
||||
GlobalSettings,
|
||||
ProviderSettings,
|
||||
ClineMessage,
|
||||
TokenUsage,
|
||||
RooCodeEventName,
|
||||
RooCodeEvents,
|
||||
} from "roo-code-types"
|
||||
|
||||
// Use the types in your code
|
||||
const settings: RooCodeSettings = {
|
||||
// Your settings here
|
||||
}
|
||||
|
||||
// Example: Type an event handler
|
||||
function handleMessage(event: RooCodeEvents["message"][0]) {
|
||||
console.log(event.message.text)
|
||||
}
|
||||
```
|
||||
|
||||
## Available Types
|
||||
|
||||
- `GlobalSettings`: Global configuration settings for Roo Code
|
||||
- `ProviderSettings`: Provider-specific settings
|
||||
- `ProviderSettingsEntry`: Entry for a provider configuration
|
||||
- `ClineMessage`: Message structure for Cline interactions
|
||||
- `TokenUsage`: Structure for token usage information
|
||||
- `RooCodeEvents`: Event types for the Roo Code API
|
||||
- `RooCodeEventName`: Enum of event names
|
||||
- `RooCodeSettings`: Combined global and provider settings
|
||||
- `RooCodeAPI`: Interface for the Roo Code API
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
694
roo-code-types/index.d.ts
vendored
Normal file
694
roo-code-types/index.d.ts
vendored
Normal file
|
|
@ -0,0 +1,694 @@
|
|||
import { EventEmitter } from "events"
|
||||
|
||||
type GlobalSettings = {
|
||||
currentApiConfigName?: string | undefined
|
||||
listApiConfigMeta?:
|
||||
| {
|
||||
id: string
|
||||
name: string
|
||||
apiProvider?:
|
||||
| (
|
||||
| "anthropic"
|
||||
| "glama"
|
||||
| "openrouter"
|
||||
| "bedrock"
|
||||
| "vertex"
|
||||
| "openai"
|
||||
| "ollama"
|
||||
| "vscode-lm"
|
||||
| "lmstudio"
|
||||
| "gemini"
|
||||
| "openai-native"
|
||||
| "mistral"
|
||||
| "deepseek"
|
||||
| "unbound"
|
||||
| "requesty"
|
||||
| "human-relay"
|
||||
| "fake-ai"
|
||||
| "xai"
|
||||
| "groq"
|
||||
| "chutes"
|
||||
| "litellm"
|
||||
)
|
||||
| undefined
|
||||
}[]
|
||||
| undefined
|
||||
pinnedApiConfigs?:
|
||||
| {
|
||||
[x: string]: boolean
|
||||
}
|
||||
| undefined
|
||||
lastShownAnnouncementId?: string | undefined
|
||||
customInstructions?: string | undefined
|
||||
taskHistory?:
|
||||
| {
|
||||
id: string
|
||||
number: number
|
||||
ts: number
|
||||
task: string
|
||||
tokensIn: number
|
||||
tokensOut: number
|
||||
cacheWrites?: number | undefined
|
||||
cacheReads?: number | undefined
|
||||
totalCost: number
|
||||
size?: number | undefined
|
||||
workspace?: string | undefined
|
||||
}[]
|
||||
| undefined
|
||||
autoApprovalEnabled?: boolean | undefined
|
||||
alwaysAllowReadOnly?: boolean | undefined
|
||||
alwaysAllowReadOnlyOutsideWorkspace?: boolean | undefined
|
||||
alwaysAllowWrite?: boolean | undefined
|
||||
alwaysAllowWriteOutsideWorkspace?: boolean | undefined
|
||||
writeDelayMs?: number | undefined
|
||||
alwaysAllowBrowser?: boolean | undefined
|
||||
alwaysApproveResubmit?: boolean | undefined
|
||||
requestDelaySeconds?: number | undefined
|
||||
alwaysAllowMcp?: boolean | undefined
|
||||
alwaysAllowModeSwitch?: boolean | undefined
|
||||
alwaysAllowSubtasks?: boolean | undefined
|
||||
alwaysAllowExecute?: boolean | undefined
|
||||
allowedCommands?: string[] | undefined
|
||||
browserToolEnabled?: boolean | undefined
|
||||
browserViewportSize?: string | undefined
|
||||
screenshotQuality?: number | undefined
|
||||
remoteBrowserEnabled?: boolean | undefined
|
||||
remoteBrowserHost?: string | undefined
|
||||
cachedChromeHostUrl?: string | undefined
|
||||
enableCheckpoints?: boolean | undefined
|
||||
ttsEnabled?: boolean | undefined
|
||||
ttsSpeed?: number | undefined
|
||||
soundEnabled?: boolean | undefined
|
||||
soundVolume?: number | undefined
|
||||
maxOpenTabsContext?: number | undefined
|
||||
maxWorkspaceFiles?: number | undefined
|
||||
showRooIgnoredFiles?: boolean | undefined
|
||||
maxReadFileLine?: number | undefined
|
||||
terminalOutputLineLimit?: number | undefined
|
||||
terminalShellIntegrationTimeout?: number | undefined
|
||||
terminalShellIntegrationDisabled?: boolean | undefined
|
||||
terminalCommandDelay?: number | undefined
|
||||
terminalPowershellCounter?: boolean | undefined
|
||||
terminalZshClearEolMark?: boolean | undefined
|
||||
terminalZshOhMy?: boolean | undefined
|
||||
terminalZshP10k?: boolean | undefined
|
||||
terminalZdotdir?: boolean | undefined
|
||||
terminalCompressProgressBar?: boolean | undefined
|
||||
rateLimitSeconds?: number | undefined
|
||||
diffEnabled?: boolean | undefined
|
||||
fuzzyMatchThreshold?: number | undefined
|
||||
experiments?:
|
||||
| {
|
||||
powerSteering: boolean
|
||||
}
|
||||
| undefined
|
||||
language?:
|
||||
| (
|
||||
| "ca"
|
||||
| "de"
|
||||
| "en"
|
||||
| "es"
|
||||
| "fr"
|
||||
| "hi"
|
||||
| "it"
|
||||
| "ja"
|
||||
| "ko"
|
||||
| "nl"
|
||||
| "pl"
|
||||
| "pt-BR"
|
||||
| "ru"
|
||||
| "tr"
|
||||
| "vi"
|
||||
| "zh-CN"
|
||||
| "zh-TW"
|
||||
)
|
||||
| undefined
|
||||
telemetrySetting?: ("unset" | "enabled" | "disabled") | undefined
|
||||
mcpEnabled?: boolean | undefined
|
||||
enableMcpServerCreation?: boolean | undefined
|
||||
mode?: string | undefined
|
||||
modeApiConfigs?:
|
||||
| {
|
||||
[x: string]: string
|
||||
}
|
||||
| undefined
|
||||
customModes?:
|
||||
| {
|
||||
slug: string
|
||||
name: string
|
||||
roleDefinition: string
|
||||
customInstructions?: string | undefined
|
||||
groups: (
|
||||
| ("read" | "edit" | "browser" | "command" | "mcp" | "modes")
|
||||
| [
|
||||
"read" | "edit" | "browser" | "command" | "mcp" | "modes",
|
||||
{
|
||||
fileRegex?: string | undefined
|
||||
description?: string | undefined
|
||||
},
|
||||
]
|
||||
)[]
|
||||
source?: ("global" | "project") | undefined
|
||||
}[]
|
||||
| undefined
|
||||
customModePrompts?:
|
||||
| {
|
||||
[x: string]:
|
||||
| {
|
||||
roleDefinition?: string | undefined
|
||||
customInstructions?: string | undefined
|
||||
}
|
||||
| undefined
|
||||
}
|
||||
| undefined
|
||||
customSupportPrompts?:
|
||||
| {
|
||||
[x: string]: string | undefined
|
||||
}
|
||||
| undefined
|
||||
enhancementApiConfigId?: string | undefined
|
||||
historyPreviewCollapsed?: boolean | undefined
|
||||
}
|
||||
|
||||
type ProviderSettings = {
|
||||
apiProvider?:
|
||||
| (
|
||||
| "anthropic"
|
||||
| "glama"
|
||||
| "openrouter"
|
||||
| "bedrock"
|
||||
| "vertex"
|
||||
| "openai"
|
||||
| "ollama"
|
||||
| "vscode-lm"
|
||||
| "lmstudio"
|
||||
| "gemini"
|
||||
| "openai-native"
|
||||
| "mistral"
|
||||
| "deepseek"
|
||||
| "unbound"
|
||||
| "requesty"
|
||||
| "human-relay"
|
||||
| "fake-ai"
|
||||
| "xai"
|
||||
| "groq"
|
||||
| "chutes"
|
||||
| "litellm"
|
||||
)
|
||||
| undefined
|
||||
includeMaxTokens?: boolean | undefined
|
||||
reasoningEffort?: ("low" | "medium" | "high") | undefined
|
||||
diffEnabled?: boolean | undefined
|
||||
fuzzyMatchThreshold?: number | undefined
|
||||
modelTemperature?: (number | null) | undefined
|
||||
rateLimitSeconds?: number | undefined
|
||||
modelMaxTokens?: number | undefined
|
||||
modelMaxThinkingTokens?: number | undefined
|
||||
apiModelId?: string | undefined
|
||||
apiKey?: string | undefined
|
||||
anthropicBaseUrl?: string | undefined
|
||||
anthropicUseAuthToken?: boolean | undefined
|
||||
glamaModelId?: string | undefined
|
||||
glamaApiKey?: string | undefined
|
||||
openRouterApiKey?: string | undefined
|
||||
openRouterModelId?: string | undefined
|
||||
openRouterBaseUrl?: string | undefined
|
||||
openRouterSpecificProvider?: string | undefined
|
||||
openRouterUseMiddleOutTransform?: boolean | undefined
|
||||
awsAccessKey?: string | undefined
|
||||
awsSecretKey?: string | undefined
|
||||
awsSessionToken?: string | undefined
|
||||
awsRegion?: string | undefined
|
||||
awsUseCrossRegionInference?: boolean | undefined
|
||||
awsUsePromptCache?: boolean | undefined
|
||||
awsProfile?: string | undefined
|
||||
awsUseProfile?: boolean | undefined
|
||||
awsCustomArn?: string | undefined
|
||||
vertexKeyFile?: string | undefined
|
||||
vertexJsonCredentials?: string | undefined
|
||||
vertexProjectId?: string | undefined
|
||||
vertexRegion?: string | undefined
|
||||
openAiBaseUrl?: string | undefined
|
||||
openAiApiKey?: string | undefined
|
||||
openAiLegacyFormat?: boolean | undefined
|
||||
openAiR1FormatEnabled?: boolean | undefined
|
||||
openAiModelId?: string | undefined
|
||||
openAiCustomModelInfo?:
|
||||
| ({
|
||||
maxTokens?: (number | null) | undefined
|
||||
maxThinkingTokens?: (number | null) | undefined
|
||||
contextWindow: number
|
||||
supportsImages?: boolean | undefined
|
||||
supportsComputerUse?: boolean | undefined
|
||||
supportsPromptCache: boolean
|
||||
inputPrice?: number | undefined
|
||||
outputPrice?: number | undefined
|
||||
cacheWritesPrice?: number | undefined
|
||||
cacheReadsPrice?: number | undefined
|
||||
description?: string | undefined
|
||||
reasoningEffort?: ("low" | "medium" | "high") | undefined
|
||||
thinking?: boolean | undefined
|
||||
minTokensPerCachePoint?: number | undefined
|
||||
maxCachePoints?: number | undefined
|
||||
cachableFields?: string[] | undefined
|
||||
tiers?:
|
||||
| {
|
||||
contextWindow: number
|
||||
inputPrice?: number | undefined
|
||||
outputPrice?: number | undefined
|
||||
cacheWritesPrice?: number | undefined
|
||||
cacheReadsPrice?: number | undefined
|
||||
}[]
|
||||
| undefined
|
||||
} | null)
|
||||
| undefined
|
||||
openAiUseAzure?: boolean | undefined
|
||||
azureApiVersion?: string | undefined
|
||||
openAiStreamingEnabled?: boolean | undefined
|
||||
enableReasoningEffort?: boolean | undefined
|
||||
openAiHostHeader?: string | undefined
|
||||
openAiHeaders?:
|
||||
| {
|
||||
[x: string]: string
|
||||
}
|
||||
| undefined
|
||||
ollamaModelId?: string | undefined
|
||||
ollamaBaseUrl?: string | undefined
|
||||
vsCodeLmModelSelector?:
|
||||
| {
|
||||
vendor?: string | undefined
|
||||
family?: string | undefined
|
||||
version?: string | undefined
|
||||
id?: string | undefined
|
||||
}
|
||||
| undefined
|
||||
lmStudioModelId?: string | undefined
|
||||
lmStudioBaseUrl?: string | undefined
|
||||
lmStudioDraftModelId?: string | undefined
|
||||
lmStudioSpeculativeDecodingEnabled?: boolean | undefined
|
||||
geminiApiKey?: string | undefined
|
||||
googleGeminiBaseUrl?: string | undefined
|
||||
openAiNativeApiKey?: string | undefined
|
||||
openAiNativeBaseUrl?: string | undefined
|
||||
mistralApiKey?: string | undefined
|
||||
mistralCodestralUrl?: string | undefined
|
||||
deepSeekBaseUrl?: string | undefined
|
||||
deepSeekApiKey?: string | undefined
|
||||
unboundApiKey?: string | undefined
|
||||
unboundModelId?: string | undefined
|
||||
requestyApiKey?: string | undefined
|
||||
requestyModelId?: string | undefined
|
||||
fakeAi?: unknown | undefined
|
||||
xaiApiKey?: string | undefined
|
||||
groqApiKey?: string | undefined
|
||||
chutesApiKey?: string | undefined
|
||||
litellmBaseUrl?: string | undefined
|
||||
litellmApiKey?: string | undefined
|
||||
litellmModelId?: string | undefined
|
||||
}
|
||||
|
||||
type ProviderSettingsEntry = {
|
||||
id: string
|
||||
name: string
|
||||
apiProvider?:
|
||||
| (
|
||||
| "anthropic"
|
||||
| "glama"
|
||||
| "openrouter"
|
||||
| "bedrock"
|
||||
| "vertex"
|
||||
| "openai"
|
||||
| "ollama"
|
||||
| "vscode-lm"
|
||||
| "lmstudio"
|
||||
| "gemini"
|
||||
| "openai-native"
|
||||
| "mistral"
|
||||
| "deepseek"
|
||||
| "unbound"
|
||||
| "requesty"
|
||||
| "human-relay"
|
||||
| "fake-ai"
|
||||
| "xai"
|
||||
| "groq"
|
||||
| "chutes"
|
||||
| "litellm"
|
||||
)
|
||||
| undefined
|
||||
}
|
||||
|
||||
type ClineMessage = {
|
||||
ts: number
|
||||
type: "ask" | "say"
|
||||
ask?:
|
||||
| (
|
||||
| "followup"
|
||||
| "command"
|
||||
| "command_output"
|
||||
| "completion_result"
|
||||
| "tool"
|
||||
| "api_req_failed"
|
||||
| "resume_task"
|
||||
| "resume_completed_task"
|
||||
| "mistake_limit_reached"
|
||||
| "browser_action_launch"
|
||||
| "use_mcp_server"
|
||||
)
|
||||
| undefined
|
||||
say?:
|
||||
| (
|
||||
| "error"
|
||||
| "api_req_started"
|
||||
| "api_req_finished"
|
||||
| "api_req_retried"
|
||||
| "api_req_retry_delayed"
|
||||
| "api_req_deleted"
|
||||
| "text"
|
||||
| "reasoning"
|
||||
| "completion_result"
|
||||
| "user_feedback"
|
||||
| "user_feedback_diff"
|
||||
| "command_output"
|
||||
| "shell_integration_warning"
|
||||
| "browser_action"
|
||||
| "browser_action_result"
|
||||
| "mcp_server_request_started"
|
||||
| "mcp_server_response"
|
||||
| "subtask_result"
|
||||
| "checkpoint_saved"
|
||||
| "rooignore_error"
|
||||
| "diff_error"
|
||||
)
|
||||
| undefined
|
||||
text?: string | undefined
|
||||
images?: string[] | undefined
|
||||
partial?: boolean | undefined
|
||||
reasoning?: string | undefined
|
||||
conversationHistoryIndex?: number | undefined
|
||||
checkpoint?:
|
||||
| {
|
||||
[x: string]: unknown
|
||||
}
|
||||
| undefined
|
||||
progressStatus?:
|
||||
| {
|
||||
icon?: string | undefined
|
||||
text?: string | undefined
|
||||
}
|
||||
| undefined
|
||||
}
|
||||
|
||||
type TokenUsage = {
|
||||
totalTokensIn: number
|
||||
totalTokensOut: number
|
||||
totalCacheWrites?: number | undefined
|
||||
totalCacheReads?: number | undefined
|
||||
totalCost: number
|
||||
contextTokens: number
|
||||
}
|
||||
|
||||
type RooCodeEvents = {
|
||||
message: [
|
||||
{
|
||||
taskId: string
|
||||
action: "created" | "updated"
|
||||
message: {
|
||||
ts: number
|
||||
type: "ask" | "say"
|
||||
ask?:
|
||||
| (
|
||||
| "followup"
|
||||
| "command"
|
||||
| "command_output"
|
||||
| "completion_result"
|
||||
| "tool"
|
||||
| "api_req_failed"
|
||||
| "resume_task"
|
||||
| "resume_completed_task"
|
||||
| "mistake_limit_reached"
|
||||
| "browser_action_launch"
|
||||
| "use_mcp_server"
|
||||
)
|
||||
| undefined
|
||||
say?:
|
||||
| (
|
||||
| "error"
|
||||
| "api_req_started"
|
||||
| "api_req_finished"
|
||||
| "api_req_retried"
|
||||
| "api_req_retry_delayed"
|
||||
| "api_req_deleted"
|
||||
| "text"
|
||||
| "reasoning"
|
||||
| "completion_result"
|
||||
| "user_feedback"
|
||||
| "user_feedback_diff"
|
||||
| "command_output"
|
||||
| "shell_integration_warning"
|
||||
| "browser_action"
|
||||
| "browser_action_result"
|
||||
| "mcp_server_request_started"
|
||||
| "mcp_server_response"
|
||||
| "subtask_result"
|
||||
| "checkpoint_saved"
|
||||
| "rooignore_error"
|
||||
| "diff_error"
|
||||
)
|
||||
| undefined
|
||||
text?: string | undefined
|
||||
images?: string[] | undefined
|
||||
partial?: boolean | undefined
|
||||
reasoning?: string | undefined
|
||||
conversationHistoryIndex?: number | undefined
|
||||
checkpoint?:
|
||||
| {
|
||||
[x: string]: unknown
|
||||
}
|
||||
| undefined
|
||||
progressStatus?:
|
||||
| {
|
||||
icon?: string | undefined
|
||||
text?: string | undefined
|
||||
}
|
||||
| undefined
|
||||
}
|
||||
},
|
||||
]
|
||||
taskCreated: [string]
|
||||
taskStarted: [string]
|
||||
taskModeSwitched: [string, string]
|
||||
taskPaused: [string]
|
||||
taskUnpaused: [string]
|
||||
taskAskResponded: [string]
|
||||
taskAborted: [string]
|
||||
taskSpawned: [string, string]
|
||||
taskCompleted: [
|
||||
string,
|
||||
{
|
||||
totalTokensIn: number
|
||||
totalTokensOut: number
|
||||
totalCacheWrites?: number | undefined
|
||||
totalCacheReads?: number | undefined
|
||||
totalCost: number
|
||||
contextTokens: number
|
||||
},
|
||||
{
|
||||
[x: string]: {
|
||||
attempts: number
|
||||
failures: number
|
||||
}
|
||||
},
|
||||
]
|
||||
taskTokenUsageUpdated: [
|
||||
string,
|
||||
{
|
||||
totalTokensIn: number
|
||||
totalTokensOut: number
|
||||
totalCacheWrites?: number | undefined
|
||||
totalCacheReads?: number | undefined
|
||||
totalCost: number
|
||||
contextTokens: number
|
||||
},
|
||||
]
|
||||
taskToolFailed: [
|
||||
string,
|
||||
(
|
||||
| "execute_command"
|
||||
| "read_file"
|
||||
| "write_to_file"
|
||||
| "apply_diff"
|
||||
| "insert_content"
|
||||
| "search_and_replace"
|
||||
| "search_files"
|
||||
| "list_files"
|
||||
| "list_code_definition_names"
|
||||
| "browser_action"
|
||||
| "use_mcp_tool"
|
||||
| "access_mcp_resource"
|
||||
| "ask_followup_question"
|
||||
| "attempt_completion"
|
||||
| "switch_mode"
|
||||
| "new_task"
|
||||
| "fetch_instructions"
|
||||
),
|
||||
string,
|
||||
]
|
||||
}
|
||||
|
||||
/**
|
||||
* RooCodeEvent
|
||||
*/
|
||||
declare enum RooCodeEventName {
|
||||
Message = "message",
|
||||
TaskCreated = "taskCreated",
|
||||
TaskStarted = "taskStarted",
|
||||
TaskModeSwitched = "taskModeSwitched",
|
||||
TaskPaused = "taskPaused",
|
||||
TaskUnpaused = "taskUnpaused",
|
||||
TaskAskResponded = "taskAskResponded",
|
||||
TaskAborted = "taskAborted",
|
||||
TaskSpawned = "taskSpawned",
|
||||
TaskCompleted = "taskCompleted",
|
||||
TaskTokenUsageUpdated = "taskTokenUsageUpdated",
|
||||
TaskToolFailed = "taskToolFailed",
|
||||
}
|
||||
|
||||
type RooCodeSettings = GlobalSettings & ProviderSettings
|
||||
interface RooCodeAPI extends EventEmitter<RooCodeEvents> {
|
||||
/**
|
||||
* Starts a new task with an optional initial message and images.
|
||||
* @param task Optional initial task message.
|
||||
* @param images Optional array of image data URIs (e.g., "data:image/webp;base64,...").
|
||||
* @returns The ID of the new task.
|
||||
*/
|
||||
startNewTask({
|
||||
configuration,
|
||||
text,
|
||||
images,
|
||||
newTab,
|
||||
}: {
|
||||
configuration?: RooCodeSettings
|
||||
text?: string
|
||||
images?: string[]
|
||||
newTab?: boolean
|
||||
}): Promise<string>
|
||||
/**
|
||||
* Resumes a task with the given ID.
|
||||
* @param taskId The ID of the task to resume.
|
||||
* @throws Error if the task is not found in the task history.
|
||||
*/
|
||||
resumeTask(taskId: string): Promise<void>
|
||||
/**
|
||||
* Checks if a task with the given ID is in the task history.
|
||||
* @param taskId The ID of the task to check.
|
||||
* @returns True if the task is in the task history, false otherwise.
|
||||
*/
|
||||
isTaskInHistory(taskId: string): Promise<boolean>
|
||||
/**
|
||||
* Returns the current task stack.
|
||||
* @returns An array of task IDs.
|
||||
*/
|
||||
getCurrentTaskStack(): string[]
|
||||
/**
|
||||
* Clears the current task.
|
||||
*/
|
||||
clearCurrentTask(lastMessage?: string): Promise<void>
|
||||
/**
|
||||
* Cancels the current task.
|
||||
*/
|
||||
cancelCurrentTask(): Promise<void>
|
||||
/**
|
||||
* Sends a message to the current task.
|
||||
* @param message Optional message to send.
|
||||
* @param images Optional array of image data URIs (e.g., "data:image/webp;base64,...").
|
||||
*/
|
||||
sendMessage(message?: string, images?: string[]): Promise<void>
|
||||
/**
|
||||
* Simulates pressing the primary button in the chat interface.
|
||||
*/
|
||||
pressPrimaryButton(): Promise<void>
|
||||
/**
|
||||
* Simulates pressing the secondary button in the chat interface.
|
||||
*/
|
||||
pressSecondaryButton(): Promise<void>
|
||||
/**
|
||||
* Returns true if the API is ready to use.
|
||||
*/
|
||||
isReady(): boolean
|
||||
/**
|
||||
* Returns the current configuration.
|
||||
* @returns The current configuration.
|
||||
*/
|
||||
getConfiguration(): RooCodeSettings
|
||||
/**
|
||||
* Sets the configuration for the current task.
|
||||
* @param values An object containing key-value pairs to set.
|
||||
*/
|
||||
setConfiguration(values: RooCodeSettings): Promise<void>
|
||||
/**
|
||||
* Returns a list of all configured profile names
|
||||
* @returns Array of profile names
|
||||
*/
|
||||
getProfiles(): string[]
|
||||
/**
|
||||
* Returns the profile entry for a given name
|
||||
* @param name The name of the profile
|
||||
* @returns The profile entry, or undefined if the profile does not exist
|
||||
*/
|
||||
getProfileEntry(name: string): ProviderSettingsEntry | undefined
|
||||
/**
|
||||
* Creates a new API configuration profile
|
||||
* @param name The name of the profile
|
||||
* @param profile The profile to create; defaults to an empty object
|
||||
* @param activate Whether to activate the profile after creation; defaults to true
|
||||
* @returns The ID of the created profile
|
||||
* @throws Error if the profile already exists
|
||||
*/
|
||||
createProfile(name: string, profile?: ProviderSettings, activate?: boolean): Promise<string>
|
||||
/**
|
||||
* Updates an existing API configuration profile
|
||||
* @param name The name of the profile
|
||||
* @param profile The profile to update
|
||||
* @param activate Whether to activate the profile after update; defaults to true
|
||||
* @returns The ID of the updated profile
|
||||
* @throws Error if the profile does not exist
|
||||
*/
|
||||
updateProfile(name: string, profile: ProviderSettings, activate?: boolean): Promise<string | undefined>
|
||||
/**
|
||||
* Creates a new API configuration profile or updates an existing one
|
||||
* @param name The name of the profile
|
||||
* @param profile The profile to create or update; defaults to an empty object
|
||||
* @param activate Whether to activate the profile after upsert; defaults to true
|
||||
* @returns The ID of the upserted profile
|
||||
*/
|
||||
upsertProfile(name: string, profile: ProviderSettings, activate?: boolean): Promise<string | undefined>
|
||||
/**
|
||||
* Deletes a profile by name
|
||||
* @param name The name of the profile to delete
|
||||
* @throws Error if the profile does not exist
|
||||
*/
|
||||
deleteProfile(name: string): Promise<void>
|
||||
/**
|
||||
* Returns the name of the currently active profile
|
||||
* @returns The profile name, or undefined if no profile is active
|
||||
*/
|
||||
getActiveProfile(): string | undefined
|
||||
/**
|
||||
* Changes the active API configuration profile
|
||||
* @param name The name of the profile to activate
|
||||
* @throws Error if the profile does not exist
|
||||
*/
|
||||
setActiveProfile(name: string): Promise<string | undefined>
|
||||
}
|
||||
|
||||
export {
|
||||
type ClineMessage,
|
||||
type GlobalSettings,
|
||||
type ProviderSettings,
|
||||
type ProviderSettingsEntry,
|
||||
type RooCodeAPI,
|
||||
RooCodeEventName,
|
||||
type RooCodeEvents,
|
||||
type RooCodeSettings,
|
||||
type TokenUsage,
|
||||
}
|
||||
6302
roo-code-types/package-lock.json
generated
Normal file
6302
roo-code-types/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
37
roo-code-types/package.json
Normal file
37
roo-code-types/package.json
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
{
|
||||
"name": "roo-code-types",
|
||||
"version": "0.0.1",
|
||||
"description": "TypeScript type definitions for Roo Code",
|
||||
"author": "Roo Code Team",
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/RooVetGit/Roo-Code.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/RooVetGit/Roo-Code/issues"
|
||||
},
|
||||
"homepage": "https://github.com/RooVetGit/Roo-Code/tree/main/roo-code-types",
|
||||
"keywords": [
|
||||
"roo",
|
||||
"roo-code",
|
||||
"ai"
|
||||
],
|
||||
"main": "index.js",
|
||||
"types": "index.d.ts",
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"README.md"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "echo \"No build required - this package only contains type definitions\"",
|
||||
"prepublishOnly": "npm run build",
|
||||
"generate-types": "cd .. && npm run generate-types",
|
||||
"check-types": "tsc --noEmit",
|
||||
"release:test": "semantic-release --dry-run",
|
||||
"release": "semantic-release"
|
||||
},
|
||||
"devDependencies": {
|
||||
"semantic-release": "^24.2.3"
|
||||
}
|
||||
}
|
||||
|
|
@ -20,6 +20,7 @@ async function main() {
|
|||
|
||||
await $`npx tsup src/exports/interface.ts --dts-only -d out`
|
||||
await fs.copyFile('out/interface.d.ts', 'src/exports/roo-code.d.ts')
|
||||
await fs.copyFile('out/interface.d.ts', 'roo-code-types/index.d.ts')
|
||||
|
||||
await $`npx prettier --write src/exports/types.ts src/exports/roo-code.d.ts`
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue