openhands / src /api /open-hands.types.ts
SaylorTwift's picture
SaylorTwift HF Staff
Add files using upload-large-folder tool
63522a5 verified
Raw
History Blame Contribute Delete
2.94 kB
import { ConversationStatus } from "#/types/conversation-status";
import { RuntimeStatus } from "#/types/runtime-status";
import { Provider } from "#/types/settings";
export interface ErrorResponse {
error: string;
}
export interface SaveFileSuccessResponse {
message: string;
}
export interface FileUploadSuccessResponse {
uploaded_files: string[];
skipped_files: { name: string; reason: string }[];
}
export interface FeedbackBodyResponse {
message: string;
feedback_id: string;
password: string;
}
export interface FeedbackResponse {
statusCode: number;
body: FeedbackBodyResponse;
}
export interface AuthenticationResponse {
message: string;
login?: string; // Only present when allow list is enabled
}
export interface Feedback {
version: string;
email: string;
token: string;
polarity: "positive" | "negative";
permissions: "public" | "private";
trajectory: unknown[];
}
export interface GetVSCodeUrlResponse {
vscode_url: string | null;
error?: string;
}
export interface GetTrajectoryResponse {
trajectory: unknown[] | null;
error?: string;
}
export interface RepositorySelection {
selected_repository: string | null;
selected_branch: string | null;
git_provider: Provider | null;
}
export type ConversationTrigger =
| "resolver"
| "gui"
| "suggested_task"
| "microagent_management"
| "automation";
export interface Conversation {
conversation_id: string;
title: string;
selected_repository: string | null;
selected_branch: string | null;
git_provider: Provider | null;
last_updated_at: string;
created_at: string;
status: ConversationStatus;
runtime_status: RuntimeStatus | null;
trigger?: ConversationTrigger;
url: string | null;
session_api_key: string | null;
pr_number?: number[] | null;
conversation_version?: "V0" | "V1";
sub_conversation_ids?: string[];
public?: boolean;
llm_model?: string | null;
}
export interface ResultSet<T> {
results: T[];
next_page_id: string | null;
}
/**
* @deprecated Use AgentServerGitChangeStatus for new code. This type is maintained for backward compatibility with V0 API.
*/
export type GitChangeStatus = "M" | "A" | "D" | "R" | "U";
export type AgentServerGitChangeStatus =
| "MOVED"
| "ADDED"
| "DELETED"
| "UPDATED";
export interface GitChange {
status: GitChangeStatus;
path: string;
}
export interface GitChangeDiff {
modified: string;
original: string;
}
export interface GitCommit {
sha: string;
shortSha: string;
subject: string;
author: string;
// ISO 8601 author date with UTC offset (git log %aI).
timestamp: string;
}
export interface GitCommitsPage {
commits: GitCommit[];
hasMore: boolean;
}
export interface InputMetadata {
name: string;
description: string;
}
export interface IOption<T> {
label: string;
value: T;
}
export type GetFilesResponse = string[];
export interface GetFileResponse {
code: string;
}