workspacesdk

type AgentConn interface {
	TailnetConn() *tailnet.Conn
	SetExtraHeaders(h http.Header)

	AwaitReachable(ctx context.Context) bool
	CallMCPTool(ctx context.Context, req CallMCPToolRequest) (CallMCPToolResponse, error)
	Close() error
	ContextConfig(ctx context.Context) (ContextConfigResponse, error)
	DebugLogs(ctx context.Context, opts ...DebugLogsOption) ([]byte, error)
	DebugMagicsock(ctx context.Context) ([]byte, error)
	DebugManifest(ctx context.Context) ([]byte, error)
	DialContext(ctx context.Context, network string, addr string) (net.Conn, error)
	AppHTTPClient() *http.Client
	GetPeerDiagnostics() tailnet.PeerDiagnostics
	ListContainers(ctx context.Context) (codersdk.WorkspaceAgentListContainersResponse, error)
	ListProcesses(ctx context.Context) (ListProcessesResponse, error)
	ListeningPorts(ctx context.Context) (codersdk.WorkspaceAgentListeningPortsResponse, error)
	Netcheck(ctx context.Context) (healthsdk.AgentNetcheckReport, error)
	Ping(ctx context.Context) (time.Duration, bool, *ipnstate.PingResult, error)
	ProcessOutput(ctx context.Context, id string, opts *ProcessOutputOptions) (ProcessOutputResponse, error)
	PrometheusMetrics(ctx context.Context) ([]byte, error)
	ReconnectingPTY(ctx context.Context, id uuid.UUID, height uint16, width uint16, command string, initOpts ...AgentReconnectingPTYInitOption) (net.Conn, error)
	DeleteDevcontainer(ctx context.Context, devcontainerID string) error
	RecreateDevcontainer(ctx context.Context, devcontainerID string) (codersdk.Response, error)
	SignalProcess(ctx context.Context, id string, signal string) error
	StartProcess(ctx context.Context, req StartProcessRequest) (StartProcessResponse, error)
	LS(ctx context.Context, path string, req LSRequest) (LSResponse, error)
	ResolvePath(ctx context.Context, path string) (string, error)
	ReadFile(ctx context.Context, path string, offset, limit int64) (io.ReadCloser, string, error)
	ReadFileLines(ctx context.Context, path string, offset, limit int64, limits ReadFileLinesLimits) (ReadFileLinesResponse, error)
	WriteFile(ctx context.Context, path string, reader io.Reader) error
	UploadChatFile(ctx context.Context, req UploadChatFileRequest) (AgentUploadChatFileResponse, error)
	EditFiles(ctx context.Context, edits FileEditRequest) (FileEditResponse, error)
	BundleFiles(ctx context.Context, req BundleFilesRequest) ([]byte, error)
	SSH(ctx context.Context) (*gonet.TCPConn, error)
	SSHClient(ctx context.Context) (*ssh.Client, error)
	SSHClientOnPort(ctx context.Context, port uint16) (*ssh.Client, error)
	SSHOnPort(ctx context.Context, port uint16) (*gonet.TCPConn, error)
	Speedtest(ctx context.Context, direction speedtest.Direction, duration time.Duration) ([]speedtest.Result, error)
	WatchContainers(ctx context.Context, logger slog.Logger) (<-chan codersdk.WorkspaceAgentListContainersResponse, io.Closer, error)
	WatchGit(ctx context.Context, logger slog.Logger, chatID uuid.UUID) (*wsjson.Stream[codersdk.WorkspaceAgentGitServerMessage, codersdk.WorkspaceAgentGitClientMessage], error)
	ConnectDesktopVNC(ctx context.Context) (net.Conn, error)
	ExecuteDesktopAction(ctx context.Context, action DesktopAction) (DesktopActionResponse, error)
	StartDesktopRecording(ctx context.Context, req StartDesktopRecordingRequest) error
	StopDesktopRecording(ctx context.Context, req StopDesktopRecordingRequest) (StopDesktopRecordingResponse, error)
}

type AgentConnFunc func(ctx context.Context, agentID uuid.UUID) (conn AgentConn, release func(), err error)

type AgentConnOptions struct {
	AgentID   uuid.UUID
	CloseFunc func() error
	Logger    slog.Logger
}

type AgentConnectionInfo struct {
	DERPMap                  *tailcfg.DERPMap `json:"derp_map"`
	DERPForceWebSockets      bool             `json:"derp_force_websockets"`
	DisableDirectConnections bool             `json:"disable_direct_connections"`
	HostnameSuffix           string           `json:"hostname_suffix,omitempty"`
}

type AgentReconnectingPTYInit struct {
	ID      uuid.UUID
	Height  uint16
	Width   uint16
	Command string
	// Container, if set, will attempt to exec into a running container visible to the agent.
	// This should be a unique container ID (implementation-dependent).
	Container string
	// ContainerUser, if set, will set the target user when execing into a container.
	// This can be a username or UID, depending on the underlying implementation.
	// This is ignored if Container is not set.
	ContainerUser string

	BackendType string
}

type AgentReconnectingPTYInitOption func(*AgentReconnectingPTYInit)

type AgentUpdate struct {
	Lifecycle codersdk.WorkspaceAgentLifecycle `json:"lifecycle"`
	ID        uuid.UUID                        `json:"id" format:"uuid"`
}

type AgentUploadChatFileResponse struct {
	// Path is the absolute path where the file was written on the workspace.
	Path string `json:"path"`
	// Name is the final basename after sanitization and collision suffixing.
	Name string `json:"name"`
	// Size is the number of bytes written to the workspace.
	Size int64 `json:"size"`
}

type BuildUpdate struct {
	Transition codersdk.WorkspaceTransition  `json:"transition"`
	JobStatus  codersdk.ProvisionerJobStatus `json:"job_status"`
}

type BundleFilesLimits struct {
	MaxFiles        int   `json:"max_files"`
	MaxBytesPerFile int64 `json:"max_bytes_per_file"`
	MaxTotalBytes   int64 `json:"max_total_bytes"`
}

type BundleFilesManifest struct {
	Requested []string                   `json:"requested"`
	Files     []BundleFilesManifestEntry `json:"files"`
	Errors    []BundleFilesManifestError `json:"errors"`
	Truncated bool                       `json:"truncated"`
	Limits    BundleFilesLimits          `json:"limits"`
}

type BundleFilesManifestEntry struct {
	Requested    string    `json:"requested"`
	Path         string    `json:"path"`
	ArchivePath  string    `json:"archive_path"`
	Size         int64     `json:"size"`
	ModTime      time.Time `json:"mod_time"`
	BytesWritten int64     `json:"bytes_written"`
	Truncated    bool      `json:"truncated"`
}

type BundleFilesManifestError struct {
	Requested string `json:"requested"`
	Path      string `json:"path,omitempty"`
	Reason    string `json:"reason"`
}

type BundleFilesRequest struct {
	Paths []string `json:"paths"`
}

type CallMCPToolRequest struct {
	// ToolName is the prefixed tool name (e.g. "github__create_issue").
	ToolName string `json:"tool_name"`
	// Arguments is the tool input as key-value pairs.
	Arguments map[string]any `json:"arguments"`
}

type CallMCPToolResponse struct {
	Content []MCPToolContent `json:"content"`
	IsError bool             `json:"is_error"`
}

type Client struct {
	// contains filtered or unexported fields
}

type CoderConnectQueryOptions struct {
	HostnameSuffix string
}

type ConnectionWatchEvent struct {
	Error       *WatchError  `json:"error"`
	BuildUpdate *BuildUpdate `json:"build_update,omitempty"`
	AgentUpdate *AgentUpdate `json:"agent_update,omitempty"`
}

type ContextConfigResponse struct {
	Parts []codersdk.ChatMessagePart `json:"parts"`
}

type DebugLogsOption func(*debugLogsConfig)

type DesktopAction struct {
	Action          string  `json:"action"`
	Coordinate      *[2]int `json:"coordinate,omitempty"`
	StartCoordinate *[2]int `json:"start_coordinate,omitempty"`
	Text            *string `json:"text,omitempty"`
	Duration        *int    `json:"duration,omitempty"`
	ScrollAmount    *int    `json:"scroll_amount,omitempty"`
	ScrollDirection *string `json:"scroll_direction,omitempty"`
	// ScaledWidth and ScaledHeight carry the declared model-facing desktop
	// geometry used for screenshot sizing and coordinate mapping.
	ScaledWidth  *int `json:"scaled_width,omitempty"`
	ScaledHeight *int `json:"scaled_height,omitempty"`
}

type DesktopActionResponse struct {
	Output           string `json:"output,omitempty"`
	ScreenshotData   string `json:"screenshot_data,omitempty"`
	ScreenshotWidth  int    `json:"screenshot_width,omitempty"`
	ScreenshotHeight int    `json:"screenshot_height,omitempty"`
}

type DesktopGeometry struct {
	NativeWidth    int
	NativeHeight   int
	DeclaredWidth  int
	DeclaredHeight int
}

type DialAgentOptions struct {
	Logger slog.Logger
	// BlockEndpoints forced a direct connection through DERP. The Client may
	// have DisableDirect set which will override this value.
	BlockEndpoints bool
	// CaptureHook is a callback that captures Disco packets and packets sent
	// into the tailnet tunnel.
	CaptureHook capture.Callback
	// Whether the client will send network telemetry events.
	// Enable instead of Disable so it's initialized to false (in tests).
	EnableTelemetry bool
	// ClientSessionID, when set, is attached to network telemetry events as
	// client_session_id so the session can be correlated across the client's
	// logs, requests, and telemetry.
	ClientSessionID string
}

type FileEdit struct {
	OldText    string `` /* 140-byte string literal not displayed */
	NewText    string `json:"new_text" description:"Text that replaces old_text."`
	ReplaceAll bool   `` /* 126-byte string literal not displayed */
}

type FileEditRequest struct {
	Files []FileEdits `json:"files"`
	// IncludeDiff asks the agent to compute a unified diff per file
	// and return it in FileEditResponse.Files[i].Diff. When false
	// (default) the agent skips diff computation and Files is nil.
	IncludeDiff bool `json:"include_diff,omitempty"`
}

type FileEditResponse struct {
	Files []FileEditResult `json:"files,omitempty"`
}

type FileEditResult struct {
	Path string `json:"path"`
	Diff string `json:"diff"`
}

type FileEdits struct {
	Path  string     `json:"path" description:"The absolute path of the file to edit, for example /home/coder/project/main.go."`
	Edits []FileEdit `json:"edits" description:"Edits that replace old text with new text, applied to this file in order."`
}

type LSFile struct {
	Name string `json:"name"`
	// e.g. "C:\\Users\\coder\\hello.txt"
	//      "/home/coder/hello.txt"
	AbsolutePathString string `json:"absolute_path_string"`
	IsDir              bool   `json:"is_dir"`
}

type LSRelativity string

type LSRequest struct {
	// e.g. [], ["repos", "coder"],
	Path []string `json:"path"`
	// Whether the supplied path is relative to the user's home directory,
	// or the root directory.
	Relativity LSRelativity `json:"relativity"`
}

type LSResponse struct {
	AbsolutePath []string `json:"absolute_path"`
	// Returned so clients can display the full path to the user, and
	// copy it to configure file sync
	// e.g. Windows: "C:\\Users\\coder"
	//      Linux: "/home/coder"
	AbsolutePathString string   `json:"absolute_path_string"`
	Contents           []LSFile `json:"contents"`
}

type ListProcessesResponse struct {
	Processes []ProcessInfo `json:"processes"`
}

type MCPToolContent struct {
	Type      string `json:"type"` // "text", "image", "audio", "resource"
	Text      string `json:"text,omitempty"`
	Data      string `json:"data,omitempty"` // base64 for binary
	MediaType string `json:"media_type,omitempty"`
}

type MCPToolInfo struct {
	// ServerName is the key from .mcp.json (e.g. "github").
	ServerName string `json:"server_name"`
	// Name is the prefixed tool name: "serverName__toolName".
	Name string `json:"name"`
	// Description is the tool's human-readable description.
	Description string `json:"description"`
	// Schema is the JSON Schema for the tool's input parameters.
	Schema map[string]any `json:"schema"`
	// Required lists required parameter names.
	Required []string `json:"required"`
}

type ProcessInfo struct {
	ID         string `json:"id"`
	Command    string `json:"command"`
	WorkDir    string `json:"workdir,omitempty"`
	Background bool   `json:"background"`
	Running    bool   `json:"running"`
	ExitCode   *int   `json:"exit_code,omitempty"`
	StartedAt  int64  `json:"started_at_unix"`
	ExitedAt   *int64 `json:"exited_at_unix,omitempty"`
}

type ProcessOutputOptions struct {
	// Wait enables blocking mode. When true, the request
	// blocks until the process exits or the context expires.
	Wait bool
}

type ProcessOutputResponse struct {
	Output    string             `json:"output"`
	Truncated *ProcessTruncation `json:"truncated,omitempty"`
	Running   bool               `json:"running"`
	ExitCode  *int               `json:"exit_code,omitempty"`
	Command   string             `json:"command,omitempty"`
}

type ProcessTruncation struct {
	OriginalBytes int    `json:"original_bytes"`
	RetainedBytes int    `json:"retained_bytes"`
	OmittedBytes  int    `json:"omitted_bytes"`
	Strategy      string `json:"strategy"`
}

type ReadFileLinesLimits struct {
	// MaxFileSize is the maximum file size (in bytes) that will be opened.
	MaxFileSize int64
	// MaxLineBytes is the per-line byte cap before truncation.
	MaxLineBytes int
	// MaxResponseLines is the maximum number of lines in a single response.
	MaxResponseLines int
	// MaxResponseBytes is the maximum total bytes of formatted output.
	MaxResponseBytes int
}

type ReadFileLinesResponse struct {
	Success    bool   `json:"success"`
	FileSize   int64  `json:"file_size,omitempty"`
	TotalLines int    `json:"total_lines,omitempty"`
	LinesRead  int    `json:"lines_read,omitempty"`
	Content    string `json:"content,omitempty"`
	Error      string `json:"error,omitempty"`
}

type ReconnectingPTYRequest struct {
	Data   string `json:"data,omitempty"`
	Height uint16 `json:"height,omitempty"`
	Width  uint16 `json:"width,omitempty"`
}

type ResolvePathResponse struct {
	ResolvedPath string `json:"resolved_path"`
}

type Resolver interface {
	LookupIP(ctx context.Context, network, host string) ([]net.IP, error)
}

type SignalProcessRequest struct {
	Signal string `json:"signal"`
}

type StartDesktopRecordingRequest struct {
	RecordingID string `json:"recording_id"`
}

type StartProcessRequest struct {
	Command    string            `json:"command"`
	WorkDir    string            `json:"workdir,omitempty"`
	Env        map[string]string `json:"env,omitempty"`
	Background bool              `json:"background,omitempty"`
}

type StartProcessResponse struct {
	ID      string `json:"id"`
	Started bool   `json:"started"`
}

type StopDesktopRecordingRequest struct {
	RecordingID string `json:"recording_id"`
}

type StopDesktopRecordingResponse struct {
	Body        io.ReadCloser
	ContentType string
}

type UploadChatFileRequest struct {
	// ChatID is the full chat UUID used to namespace the upload directory.
	ChatID string
	// Name is the filename. Coderd sanitizes it before the call; the
	// agent sanitizes again as defense in depth for direct tailnet
	// callers.
	Name string
	// Body must remain readable until UploadChatFile returns.
	Body io.Reader
}

type WatchError struct {
	Code      WatchErrorCode `json:"code"`
	Retryable bool           `json:"retryable"`
	Message   string         `json:"message"`
	Details   string         `json:"details,omitempty"`
}

type WatchErrorCode int

type WebsocketDialer struct {
	// contains filtered or unexported fields
}

type WebsocketDialerOption func(*WebsocketDialer)

type WorkspaceAgentReconnectingPTYOpts struct {
	AgentID   uuid.UUID
	Reconnect uuid.UUID
	Width     uint16
	Height    uint16
	Command   string

	// SignedToken is an optional signed token from the
	// issue-reconnecting-pty-signed-token endpoint. If set, the session token
	// on the client will not be sent.
	SignedToken string

	// Experimental: Container, if set, will attempt to exec into a running container
	// visible to the agent. This should be a unique container ID
	// (implementation-dependent).
	// ContainerUser is the user as which to exec into the container.
	// NOTE: This feature is currently experimental and is currently "opt-in".
	// In order to use this feature, the agent must have the environment variable
	// CODER_AGENT_DEVCONTAINERS_ENABLE set to "true".
	Container     string
	ContainerUser string

	// BackendType is the type of backend to use for the PTY. If not set, the
	// workspace agent will attempt to determine the preferred backend type.
	// Supported values are "screen" and "buffered".
	BackendType string
}