tools

type ArgsPermissioner interface {
	PermissionForArgs(args map[string]any) Permission
}

type AskUserQuestion struct {
	Question           string
	Header             string
	Options            []string
	OptionDescriptions []string
	Recommended        string
	MultiSelect        bool
}

type Display struct {
	Summary string
	Kind    string // e.g. file, diff, search, shell
	// Preview is a multi-line, card-only body (e.g. a unified diff or file head)
	// for the TUI. It is NEVER sent to the model — Output stays the short summary
	// the model sees — so a rich code preview costs zero model tokens.
	Preview string
}

type ExecSessionController interface {
	ExecSessions() []ExecSessionSnapshot
	StopExecSession(id int) bool
	StopAllExecSessions() []int
}

type ExecSessionSnapshot struct {
	ID           int
	Command      string
	Cwd          string
	RelativeCwd  string
	StartedAt    time.Time
	LastUsedAt   time.Time
	TTY          bool
	Status       string
	ExitCode     *int
	RecentOutput string
	// OutputTruncated reflects the buffer's last-known truncation state (see
	// execOutputBuffer.peekTruncated), so a session listing (/ps) still shows
	// this even if the session is reaped before ever being polled again.
	OutputTruncated bool
}

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

type FileVersion struct {
	Hash  string
	Size  int64
	MTime time.Time
}

type LocalControlArtifactOptions struct {
	Browser      localcontrol.BrowserOptions
	Desktop      localcontrol.DesktopOptions
	Terminal     localcontrol.TerminalOptions
	ArtifactsDir string
}

type PathScope interface {
	Roots() []string
}

type Permission string

type PlanItem struct {
	ID      string
	Content string
	Status  string
	Notes   string
}

type PrePermissionRejecter interface {
	RejectBeforePermission(args map[string]any) (Result, bool)
}

type PropertySchema struct {
	Type        string          `json:"type"`
	Description string          `json:"description,omitempty"`
	Enum        []string        `json:"enum,omitempty"`
	Default     any             `json:"default,omitempty"`
	Items       *PropertySchema `json:"items,omitempty"`
	Minimum     *int            `json:"minimum,omitempty"`
	Maximum     *int            `json:"maximum,omitempty"`
	MinLength   *int            `json:"minLength,omitempty"`
	MinItems    *int            `json:"minItems,omitempty"`
	// Properties/Required describe nested object fields (for Type "object" or an
	// object-typed Items).
	Properties map[string]PropertySchema `json:"properties,omitempty"`
	Required   []string                  `json:"required,omitempty"`
}

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

type Result struct {
	Status          Status
	Output          string
	Truncated       bool
	Meta            map[string]string
	SandboxDecision *sandbox.Decision `json:"-"`
	// Redacted is set when secret scrubbing altered Output before it left the
	// tool-execution boundary.
	Redacted bool
	// ChangedFiles lists workspace-relative paths a mutating tool wrote;
	// entries under a granted extra write root are absolute, since
	// workspace-relative would be ambiguous there.
	ChangedFiles []string
	// Display carries a short, structured summary for the TUI / stream.
	Display Display
}

type RunOptions struct {
	PermissionGranted bool
	PermissionMode    string
	Autonomy          string
	Sandbox           *sandbox.Engine
	ToolCallID        string
	SessionID         string
	Model             string
	ReasoningEffort   string
	Depth             int
	Cwd               string
	// FileTracker, when set, records the version of each file read or written this
	// session so write_file/edit_file can refuse to clobber a file that changed on
	// disk outside Zero since it was last read. nil disables the feature entirely
	// (the read/write tools behave exactly as before).
	FileTracker *FileTracker
	// EnabledTools / DisabledTools carry the run's operator tool filters so a
	// filter-aware tool (tool_search) never discloses or loads an operator-hidden
	// tool. They use the same allow/deny semantics as the agent's filter gate:
	// denied if listed in DisabledTools; if EnabledTools is non-empty, allowed
	// only when listed in it.
	EnabledTools  []string
	DisabledTools []string
	// Progress, when set, is called with each stream-json event emitted by a
	// specialist child process while it runs. Used by the TUI to show live
	// tool-call progress in the specialist card. nil is a no-op (the default
	// for every non-Task tool).
	Progress func(streamjson.Event)
	// Diagnostics, when set, returns a formatted language-diagnostics block for
	// a file a mutating tool just wrote ("" when clean or no server available).
	// edit_file/write_file append it to their output so the model sees an error
	// it introduced in the same turn instead of waiting for a later verification
	// pass. nil disables inline diagnostics.
	Diagnostics func(ctx context.Context, absPath string) string
}

type Safety struct {
	SideEffect SideEffect
	Permission Permission
	Reason     string
	// AdvertiseInAuto allows selected non-allow tools to be visible in auto mode
	// while still requiring the normal permission flow before execution.
	AdvertiseInAuto bool
}

type SandboxPermissionOverride string

type ScaffoldOptions struct {
	// Name is the tool/plugin id (a single path segment).
	Name string
	// Dir is the toolbox directory to create the plugin under (typically the user
	// plugins root).
	Dir string
	// Description is an optional human description; a default is used when empty.
	Description string
	// Runtime selects the entry-stub language; defaults to RuntimeShell.
	Runtime ScaffoldRuntime
}

type ScaffoldResult struct {
	Name         string `json:"name"`
	PluginDir    string `json:"pluginDir"`
	ManifestPath string `json:"manifestPath"`
	EntryPath    string `json:"entryPath"`
}

type ScaffoldRuntime string

type Schema struct {
	Type                 string                    `json:"type"`
	Properties           map[string]PropertySchema `json:"properties,omitempty"`
	Required             []string                  `json:"required,omitempty"`
	AdditionalProperties bool                      `json:"additionalProperties"`
}

type SideEffect string

type Status string

type Tool interface {
	Name() string
	Description() string
	Parameters() Schema
	Safety() Safety
	Run(ctx context.Context, args map[string]any) Result
}