browser

type CloseRequest struct {
	ID string
	// Force closes the session even while a command holds it.
	Force bool
	// Keep ends the session instead of removing it: its browser closes and
	// its profile is free, and its history can still be exported for as long
	// as an ended session's.
	Keep bool
}

type DescribeRequest struct {
	ID string
	// Find shows only the outline's entries containing it.
	Find string
	// MaxChars bounds the outline; zero means DefaultDescribeChars.
	MaxChars int
	// Tree returns the page's accessibility tree as the model sees it, in
	// place of the outline.
	Tree bool
	// Screenshot saves a screenshot of the page under this name.
	Screenshot string
}

type DescribeResult struct {
	ID string `json:"id"`
	SessionPageView
	Tree         string    `json:"tree,omitempty"`
	Matches      *int      `json:"matches,omitempty"`
	Screenshot   string    `json:"screenshot,omitempty"`
	IdleDeadline time.Time `json:"idle_deadline"`
	Warnings     []string  `json:"warnings"`
	// Refused is the refusal the page shows, if any.
	Refused *SessionRefusal `json:"refused,omitempty"`
}

type DoRequest struct {
	ID string
	// Operation is one item of a browser step's with.do.
	Operation json.RawMessage
	// Variables holds the values of the variables the operation uses.
	Variables map[string]SessionVariable
	// OutlineChars bounds the page outline the result reports; zero omits
	// it.
	OutlineChars int
	// AllowWrites are the signatures of the writes the operation may send,
	// in a session whose write gate records; it sends no other.
	AllowWrites []string
}

type DoResult struct {
	ID string `json:"id"`
	// Index is the operation's place in the session's history, which
	// export refers to.
	Index  int    `json:"index"`
	Kind   string `json:"kind"`
	Status string `json:"status"`
	Detail string `json:"detail,omitempty"`
	// Error is why the operation failed.
	Error   *SessionError   `json:"error,omitempty"`
	Actions []SessionAction `json:"actions"`
	// Act is the act a step writes for an element operation.
	Act string `json:"act,omitempty"`
	// Into is the into a step writes for an element upload.
	Into string `json:"into,omitempty"`
	// Recorded reports that a step exported from the session replays the
	// act's or the upload's actions.
	Recorded bool           `json:"recorded"`
	Outputs  map[string]any `json:"outputs,omitempty"`
	// Screenshot is the file a screenshot operation saved.
	Screenshot string          `json:"screenshot,omitempty"`
	Downloads  []string        `json:"downloads"`
	Dialogs    []SessionDialog `json:"dialogs"`
	Blocked    map[string]int  `json:"blocked,omitempty"`
	// Writes are what the write gate decided since the previous command,
	// including what the page sent while it waited.
	Writes       []writegate.Event `json:"writes,omitempty"`
	Tokens       int               `json:"tokens"`
	DurationMS   int64             `json:"duration_ms"`
	Warnings     []string          `json:"warnings"`
	IdleDeadline time.Time         `json:"idle_deadline"`
	// Refused is the refusal the page shows after the operation, if any.
	Refused *SessionRefusal `json:"refused,omitempty"`
	SessionPageView
}

type ExportRequest struct {
	ID string
	// DAG and Step name the step that will run the exported operations; its
	// replay cache receives the acts' recordings.
	DAG  string
	Step string
	// Skip lists the history indices of operations to leave out.
	Skip []int
	// DryRun builds the step without writing recordings.
	DryRun bool
}

type ExportResult struct {
	ID  string `json:"id"`
	DAG string `json:"dag"`
	// Step is the step to put in the DAG's steps.
	Step ExportedStep `json:"step"`
	// CacheFile is where the recordings were written; empty on a dry run.
	CacheFile string `json:"cache_file,omitempty"`
	// Recordings counts the acts and uploads a first run replays.
	Recordings int `json:"recordings"`
	// CommitPoints counts the writes of the step's acts and uploads kept as
	// commit points to approve.
	CommitPoints int `json:"commit_points"`
	// Ops maps each operation of the step to the session's history.
	Ops []ExportedOperation `json:"ops"`
	// Variables says how to give the step each variable's value.
	Variables []ExportedVariable `json:"variables"`
	// LLM is the model the session used, for the DAG's llm block.
	LLM      *ir.LLMConfig `json:"llm,omitempty"`
	Warnings []string      `json:"warnings"`
}

type ExportedOperation struct {
	// SessionIndex is the operation's place in the session's history, and
	// Index its place in the step's with.do.
	SessionIndex int    `json:"session_index"`
	Index        int    `json:"index"`
	Kind         string `json:"kind"`
	// Recorded reports that the step's first run replays the act or upload.
	Recorded bool `json:"recorded"`
}

type ExportedStep struct {
	ID     string       `json:"id"`
	Action string       `json:"action"`
	With   ExportedWith `json:"with"`
}

type ExportedVariable struct {
	Name  string `json:"name"`
	Value string `json:"value"`
	Note  string `json:"note"`
}

type ExportedWith struct {
	URL       string            `json:"url,omitempty"`
	Browser   *exportedBrowser  `json:"browser,omitempty"`
	Variables map[string]string `json:"variables,omitempty"`
	Do        []json.RawMessage `json:"do"`
}

type GateRequest struct {
	ID string
	// Person reports that a person holds the browser, whose writes the
	// gate sends; false hands it back to the gate's mode.
	Person bool
}

type GateResult struct {
	ID        string `json:"id"`
	WriteGate string `json:"write_gate"`
	// Person reports that the gate sends the browser's writes, which a
	// person makes.
	Person       bool      `json:"person"`
	IdleDeadline time.Time `json:"idle_deadline"`
}

type OpenResult struct {
	ID string `json:"id"`
	// TLSVerified confirms the proxy verified the final HTTPS page's host.
	// False means no such evidence was available, not a certificate failure.
	TLSVerified bool `json:"tls_verified"`
	// CDPURL is the browser's DevTools address, where an application can
	// show the page and let a person act on it.
	CDPURL       string    `json:"cdp_url"`
	Headless     bool      `json:"headless"`
	Profile      string    `json:"profile,omitempty"`
	Model        string    `json:"model,omitempty"`
	IdleDeadline time.Time `json:"idle_deadline"`
	Warnings     []string  `json:"warnings"`
	// Refused is the refusal the page shows, if any.
	Refused *SessionRefusal `json:"refused,omitempty"`
	// WriteGate is the write gate mode the browser runs in, empty without
	// a gate.
	WriteGate string `json:"write_gate,omitempty"`
	// Writes are what the gate decided while the page opened.
	Writes []writegate.Event `json:"writes,omitempty"`
	SessionPageView
}

type SessionAction struct {
	Selector    string   `json:"selector"`
	Description string   `json:"description,omitempty"`
	Method      string   `json:"method,omitempty"`
	Arguments   []string `json:"arguments,omitempty"`
}

type SessionDialog struct {
	Type    string `json:"type"`
	Message string `json:"message"`
}

type SessionError struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type SessionOptions struct {
	// URL is the page to open, if any.
	URL string
	// Profile keeps the browser's cookies and storage between sessions and
	// steps that name it.
	Profile        string
	Headless       bool
	Viewport       *SessionViewport
	Executable     string
	Proxy          string
	AllowedDomains []string
	// IdleTimeout closes the browser when no command arrives for that long;
	// zero means DefaultSessionIdleTimeout.
	IdleTimeout time.Duration
	// LLM is the model acts, extracts, and judged conditions ask; nil opens
	// a session without one.
	LLM *ir.LLMConfig
	// OutlineChars bounds the page outline the result reports; zero omits
	// it.
	OutlineChars int
	// WriteGate is the write gate mode the session asks for; the browser
	// runs in the stricter of it and the host's browser.write_gate.
	WriteGate string
	// WritePolicyFile is the write gate policy, naming the sign-in
	// endpoints whose writes the gate sends. The secrets its rules name are
	// read from the environment.
	WritePolicyFile string
}

type SessionPageView struct {
	URL   string `json:"url"`
	Title string `json:"title"`
	// Outline describes the page; empty when not asked for.
	Outline          string `json:"outline,omitempty"`
	OutlineTruncated bool   `json:"outline_truncated,omitempty"`
}

type SessionRefusal struct {
	Host   string `json:"host"`
	Status int    `json:"status"`
	// BotCheck names the check the site answered with, such as cloudflare.
	BotCheck string `json:"bot_check,omitempty"`
	// Message says what happened in a sentence.
	Message string `json:"message"`
}

type SessionSummary struct {
	ID string `json:"id"`
	// State is idle, busy while a command runs, or ended once the browser
	// closed.
	State        string     `json:"state"`
	URL          string     `json:"url"`
	Title        string     `json:"title"`
	CDPURL       string     `json:"cdp_url,omitempty"`
	Profile      string     `json:"profile,omitempty"`
	Headless     bool       `json:"headless"`
	Model        string     `json:"model,omitempty"`
	Operations   int        `json:"operations"`
	CreatedAt    time.Time  `json:"created_at"`
	LastUsedAt   time.Time  `json:"last_used_at"`
	IdleDeadline *time.Time `json:"idle_deadline,omitempty"`
}

type SessionVariable struct {
	Value string `json:"value,omitempty"`
	Env   string `json:"env,omitempty"`
}

type SessionViewport struct {
	Width  int
	Height int
}

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