ai

type Agent struct {
	ID     string   // stable config value (ai_agent)
	Name   string   // display name for the pane title and transcript
	Binary string   // executable resolved on PATH; its presence is the opt-in
	Args   []string // argv after the binary

	// Install says how to get the binary, shown when it is missing — the chat
	// pane is the one place a missing integration is worth explaining, since
	// the user opened it on purpose.
	Install string

	// Auth says how to sign in, shown when the agent refuses for lack of it.
	Auth string

	// SignInArgs is the argv after the binary that runs it as a language
	// server offering GitHub's device-flow sign-in (see signin.go). Nil when
	// dbc cannot sign the user in for this agent — then Auth is the only
	// way, and it names the agent's own login command.
	SignInArgs []string
}

type AuthStatus struct {
	Status string `json:"status"` // "OK", "AlreadySignedIn", "NotSignedIn", "NotAuthorized", …
	User   string `json:"user"`
}

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

type Column struct {
	Name string
	Type string
}

type Context struct {
	Conn   string // connection name
	Driver string // postgres | mysql | sqlite | bytdb — the model needs the dialect

	Query string // the statement the question is about; "" if none
	Err   string // the error the last run of it failed with, if it failed

	// Script names the Go script (its file name, "nightly.go") when the
	// question is asked from a script tab. Query then holds the script's
	// source, not SQL: Build fences it as Go and calls it "the script", so
	// the model neither reads Go as a malformed statement nor answers with
	// SQL that rewrites the whole file as one query. Err and the result
	// fields are then the last run of THIS script, when it was the last
	// thing the tab ran.
	Script string
	// Pipeline names the pipeline or job file ("orders.json") when the
	// question is asked from a pipeline or job tab, and PipelineKind says
	// which ("pipeline", "job"). Query then holds its JSON spec, not SQL:
	// Build fences it as JSON and calls it the pipeline (or job), so the
	// model neither reads the spec as a malformed statement nor answers
	// with SQL meant to replace it. Err is its last run's error, and the
	// result fields a preview's rows on screen.
	Pipeline     string
	PipelineKind string
	// ScriptConns are the configured connections, "name (driver)", for a
	// script, pipeline or job question: a script names its connections in
	// strings and a pipeline's nodes in their conn fields (neither tab has
	// a connection of its own), so these are the names they can use and
	// the dialect each one's SQL must be written in. Names and drivers are
	// configuration, not data, so they go on every connection.
	ScriptConns []string
	// ScriptAPI is the sdb API summary (sdbapi.Summary) the script is
	// written against, with the pipeline plugins (pipeline.Summary) a
	// pipeline's nodes — and a script's pipelines — are made of. The caller
	// sets it on the first script, pipeline or job question of a
	// conversation only: the agent keeps the session's history, so the
	// same ~2k tokens on every turn would buy nothing — the preamble's rule.
	ScriptAPI string

	// The last result. Columns nil means there is none (never run, or an
	// exec with nothing to show).
	Columns   []string
	Rows      [][]string
	Truncated bool // the fetch hit max_rows, so len(Rows) is not the table's size

	// Hidden lists the result columns (indices into Columns, ascending)
	// hidden in the grid. Build leaves their values out and names them. The
	// full rows are passed rather than a projected copy because the context
	// chip builds a Context every frame, and Build only projects the handful
	// of rows it actually sends.
	Hidden []int

	// Order is the grid's row order after a header sort: Order[i] is the
	// result row shown i-th. It may hold only a prefix — the rows that
	// could be sent — since the chip builds a Context every frame and a
	// full copy of a 10,000-row permutation per frame buys nothing. nil
	// means the result's own order. SortedBy names the sorted column (""
	// when unsorted) and SortDesc its direction.
	Order    []int
	SortedBy string
	SortDesc bool

	// Shared marks a result the user SHARED with the assistant on purpose —
	// a result tab picked with "Share with the assistant" — rather than the
	// one that rides along because it is Query's own last run. A shared
	// result is framed as such, goes even beside an error (Err is then the
	// query's, the result is another run's), and is named in the note.
	// SharedLabel names it as the UI does ("result 2"); SharedFrom is the
	// statement it is the result of, when that is not Query ("" when it is,
	// or for a script's shown result, whose statement is not known).
	Shared      bool
	SharedLabel string
	SharedFrom  string

	// SendRows is the connection's ai_rows opt-in; MaxRows is ai_context_rows.
	SendRows bool
	MaxRows  int

	// Plan is the query plan the user explained for Query, rendered as text
	// with dbc's findings ("" when there is none). A plan is how the
	// database will run the statement — table and index names, row counts
	// and timings — not what the rows hold, so like the schema it goes on
	// every connection. The literals it quotes in its conditions are the
	// user's own, from the SQL that is sent anyway.
	Plan string

	// Tables are the catalog's tables the query or question mentions. A
	// table with no Columns is still named in the Note — that is how the
	// context chip forecasts "schema of cats" before the columns have been
	// looked up — but is left out of the prompt text, so a caller building
	// the real prompt drops the ones the lookup could not describe.
	Tables []Table
}

type Event struct {
	Kind       EventKind
	Text       string
	Models     []Model
	ModelID    string
	StopReason string
	Err        error
}

type EventKind int

type Model struct {
	ID    string
	Name  string
	Usage string // Copilot's premium-request multiplier ("1x", "0x"), if given
}

type Options struct {
	// Dir is the agent's working directory and the ACP session's cwd. It must
	// be absolute; the spec requires it.
	Dir string
	// Model is the preferred model id. Empty, or an id the roster no longer
	// offers, keeps the agent's default — a stale saved preference must never
	// break the handshake.
	Model string
}

type Prompt struct {
	Text string
	Note string
}

type SignIn struct {
	UserCode        string
	VerificationURI string
	Status          AuthStatus
	// contains filtered or unexported fields
}

type Table struct {
	Name    string
	View    bool
	Columns []Column
}