api

type Empty struct{}

type ExecStep struct {
	Script string            `json:"script"        yaml:"script"`
	Env    map[string]string `json:"env,omitempty" yaml:"env,omitempty"`
}

type ID string

type Kind string

type PingMessage struct {
	Message string
}

type ResizeArgs struct {
	Cols int
	Rows int
}

type ResponseWithFD struct {
	JSON any   // what to JSON-encode into "result"
	FDs  []int // file descriptors to pass via SCM_RIGHTS
}

type RestartPolicy string

type RunTarget string

type ShellSpec struct {
	Cwd        string            `json:"cwd,omitempty"        yaml:"cwd,omitempty"`
	Cmd        string            `json:"cmd"                  yaml:"cmd"`
	CmdArgs    []string          `json:"cmdArgs,omitempty"    yaml:"cmdArgs,omitempty"`
	Env        map[string]string `json:"env,omitempty"        yaml:"env,omitempty"`
	EnvInherit bool              `json:"inheritEnv,omitempty" yaml:"inheritEnv,omitempty"`
	Prompt     string            `json:"prompt,omitempty"     yaml:"prompt,omitempty"`
}

type StagesSpec struct {
	OnInit     []ExecStep `json:"onInit,omitempty"     yaml:"onInit,omitempty"`
	PostAttach []ExecStep `json:"postAttach,omitempty" yaml:"postAttach,omitempty"`
}

type SupervisedTerminal struct {
	Spec        *TerminalSpec
	Command     string
	CommandArgs []string // for local: ["bash","-i"]; for ssh: ["ssh","-tt","user@host"]
}

type SupervisorController interface {
	Run(doc *SupervisorDoc) error
	WaitReady() error
	Close(reason error) error
	WaitClose() error
	Detach() error
}

type SupervisorDoc struct {
	APIVersion Version            `json:"apiVersion" yaml:"apiVersion"`
	Kind       Kind               `json:"kind"       yaml:"kind"`
	Metadata   SupervisorMetadata `json:"metadata"`
	Spec       SupervisorSpec     `json:"spec"`
	Status     SupervisorStatus   `json:"status"`
}

type SupervisorMetadata struct {
	Name        string            `json:"name"                  yaml:"name"`
	Labels      map[string]string `json:"labels,omitempty"      yaml:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
}

type SupervisorMode int

type SupervisorSpec struct {
	ID         ID     `json:"id"`
	LogFile    string `json:"logDir"`
	SockerCtrl string `json:"socketCtrl"`
	RunPath    string `json:"runPath"`

	// Only valid when SupervisorMode == RunNewTerminal
	TerminalSpec *TerminalSpec `json:"terminal,omitempty"`

	// DetachKeystroke controls whether the detach keystroke (^] twice) is enabled.
	// When true, users can detach by pressing ^] twice. When false, detach keystroke is disabled.
	DetachKeystroke bool `json:"detachKeystroke,omitempty"`

	// SupervisorMode determines whether the supervisor runs a new terminal or attaches to an existing one.
	SupervisorMode SupervisorMode `json:"supervisorMode,omitempty"`
}

type SupervisorStatus struct {
	Pid               int                  `json:"pid"`
	BaseRunPath       string               `json:"baseRunPath"`
	SupervisorRunPath string               `json:"supervisorRunPath"`
	State             SupervisorStatusMode `json:"state"`
}

type SupervisorStatusMode int

type TerminalController interface {
	Run(spec *TerminalSpec) error
	WaitReady() error
	WaitClose() error
	Ping(ping *PingMessage) (*PingMessage, error)
	Close(reason error) error
	Resize(ResizeArgs)
	Detach(id *ID) error
	Attach(id *ID, reply *ResponseWithFD) error
	Metadata() (*TerminalDoc, error)
	State() (*TerminalStatusMode, error)
}

type TerminalDoc struct {
	APIVersion Version          `json:"apiVersion" yaml:"apiVersion"`
	Kind       Kind             `json:"kind"       yaml:"kind"`
	Metadata   TerminalMetadata `json:"metadata"`
	Spec       TerminalSpec     `json:"spec"`
	Status     TerminalStatus   `json:"status"`
}

type TerminalKind int

type TerminalMetadata struct {
	Name        string            `json:"name"                  yaml:"name"`
	Labels      map[string]string `json:"labels,omitempty"      yaml:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
}

type TerminalProfileDoc struct {
	APIVersion Version                 `json:"apiVersion" yaml:"apiVersion"`
	Kind       Kind                    `json:"kind"       yaml:"kind"`
	Metadata   TerminalProfileMetadata `json:"metadata"   yaml:"metadata"`
	Spec       TerminalProfileSpec     `json:"spec"       yaml:"spec"`
}

type TerminalProfileMetadata struct {
	Name        string            `json:"name"                  yaml:"name"`
	Labels      map[string]string `json:"labels,omitempty"      yaml:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
}

type TerminalProfileSpec struct {
	RunTarget     RunTarget     `json:"runTarget"     yaml:"runTarget"`
	RestartPolicy RestartPolicy `json:"restartPolicy" yaml:"restartPolicy"`
	Shell         ShellSpec     `json:"shell"         yaml:"shell"`
	Stages        StagesSpec    `json:"stages"        yaml:"stages"`
}

type TerminalSpec struct {
	ID     ID                `json:"id"`
	Kind   TerminalKind      `json:"kind"`
	Name   string            `json:"name"`
	Labels map[string]string `json:"labels"`

	Cwd         string   `json:"cwd,omitempty"`
	Command     string   `json:"command"`
	CommandArgs []string `json:"commandArgs"`
	EnvInherit  bool     `json:"inheritEnv"`
	Env         []string `json:"env"`
	Prompt      string   `json:"prompt"`
	SetPrompt   bool     `json:"setPrompt,omitempty"`

	RunPath     string `json:"runPath"`
	CaptureFile string `json:"captureFile"`
	LogFile     string `json:"logFile"`
	LogLevel    string `json:"logLevel"`
	SocketFile  string `json:"socketIO"`

	ProfileName string     `json:"profileName"`
	Stages      StagesSpec `json:"stages"`
}

type TerminalState int

type TerminalStatus struct {
	Pid             int                `json:"pid"`
	Tty             string             `json:"tty"`
	State           TerminalStatusMode `json:"state"`
	SocketFile      string             `json:"socketCtrl"`
	BaseRunPath     string             `json:"baseRunPath"`
	TerminalRunPath string             `json:"terminalRunPath"`
	LogFile         string             `json:"logFile"`
	LogLevel        string             `json:"logLevel"`
	CaptureFile     string             `json:"captureFile"`
	Attachers       []string           `json:"attachers"`
}

type TerminalStatusMode int

type Version string