machine

type AddRequest struct {
	Name          string `json:"name"`
	SSHConfigHost string `json:"sshConfigHost"`
	Host          string `json:"host"`
	Port          int    `json:"port"`
	User          string `json:"user"`
	AuthMethod    string `json:"authMethod"`
	PrivateKey    string `json:"privateKey"`
	Passphrase    string `json:"passphrase"`
	Password      string `json:"password"`
	PersistMode   string `json:"persistMode"`
}

type AuthNeed struct {
	Kind string `json:"kind"`
	// KeyPath is the key a passphrase is for, as the config says it. "" is the key
	// uploaded for this machine.
	KeyPath string `json:"keyPath,omitempty"`
	// Host is who asks: "user@host", which can be a jump host on the way.
	Host string `json:"host"`
	// Prompt is the server's own question, when it asks through keyboard-interactive.
	Prompt string `json:"prompt,omitempty"`
	// Wrong: the last answer was refused.
	Wrong bool `json:"wrong,omitempty"`
	// CanPassword: asked for a passphrase, but the server would also take a password.
	CanPassword bool `json:"canPassword,omitempty"`
	// contains filtered or unexported fields
}

type CommandNotFoundError struct{ Command string }

type Config struct {
	ID            string       `json:"id"`
	Name          string       `json:"name"`
	Kind          string       `json:"kind"` // "local" | "ssh"
	Host          string       `json:"host"`
	Port          int          `json:"port"`
	User          string       `json:"user"`
	SSHConfigHost string       `json:"sshConfigHost"`
	AuthMethod    string       `json:"authMethod"` // "sshconfig" | "agent" | "key" | "password"
	CredRef       string       `json:"credRef,omitempty"`
	PersistMode   string       `json:"persistMode"` // "auto" | "tmux" | "direct"
	Probe         *ProbeResult `json:"probe,omitempty"`
}

type Creds struct {
	PrivateKey string `json:"privateKey,omitempty"`
	Passphrase string `json:"passphrase,omitempty"`
	Password   string `json:"password,omitempty"`
	// KeyPassphrases open key files of the hub user, by the path the config gives.
	KeyPassphrases map[string]string `json:"keyPassphrases,omitempty"`
}

type DirEntry struct {
	Name  string    `json:"name"`
	Dir   bool      `json:"dir"`
	Size  int64     `json:"size"`
	Mtime time.Time `json:"mtime,omitzero"`
}

type DirListing struct {
	Path    string     `json:"path"`
	Parent  string     `json:"parent"`
	Entries []DirEntry `json:"entries"`
}

type ExecResult struct {
	ExitCode   int
	Stdout     []byte
	Stderr     []byte
	TimedOut   bool
	IdleKilled bool
	Cancelled  bool
	Truncated  bool
}

type ExecSpec struct {
	Cwd string
	// Argv runs a program directly; Script runs a POSIX script instead.
	// Exactly one of them is set.
	Argv   []string
	Script string
	Env    []string // KEY=VALUE
	Stdin  []byte   // nil = /dev/null
	// Timeout bounds the whole run; IdleTimeout kills a run that printed
	// nothing on stdout/stderr for that long. Zero = no limit.
	Timeout     time.Duration
	IdleTimeout time.Duration
	MaxOutput   int64 // default DefaultExecMaxOutput
	// OnStdout, when set, receives stdout chunks as they arrive (from one
	// goroutine), e.g. stream-json lines of a headless CLI.
	OnStdout func([]byte)
}

type FileContent struct {
	Path      string    `json:"path"`
	Size      int64     `json:"size"`
	Mtime     time.Time `json:"mtime,omitzero"`
	Binary    bool      `json:"binary"`
	Truncated bool      `json:"truncated"`
	Content   string    `json:"content"`
}

type FileStat struct {
	Path   string    `json:"path"`
	Name   string    `json:"name"`
	Dir    bool      `json:"dir"`
	Size   int64     `json:"size"`
	Mtime  time.Time `json:"mtime,omitzero"`
	Exists bool      `json:"exists"`
}

type ForegroundSignaler interface {
	SignalForeground(ctx context.Context, wrapperPid int, sig string) error
}

type Foregrounder interface {
	Foreground(ctx context.Context, wrapperPid int) (pgid int, comm string, err error)
}

type GitInfo struct {
	IsRepo  bool   `json:"isRepo"`
	Branch  string `json:"branch"`
	Ahead   int    `json:"ahead"`
	Behind  int    `json:"behind"`
	Changed int    `json:"changed"`
	Error   string `json:"error"`
}

type HookForward struct {
	Port  int    `json:"port,omitempty"`
	Error string `json:"error,omitempty"`
}

type Host interface {
	ID() string
	Info() Info
	Connected() bool
	Start(spec StartSpec) (Proc, error)
	Probe(ctx context.Context, commands []string) (*ProbeResult, error)
	ListDir(ctx context.Context, path string) (*DirListing, error)

	// File API (docs/API-board.md §4). Paths are absolute or start with ~.
	Stat(ctx context.Context, path string) (*FileStat, error)
	ReadFile(ctx context.Context, path string, max int64) (*FileContent, error)
	// ReadAt returns up to n bytes of a regular file starting at off
	// (fewer at EOF), plus its stat. Used for transcript tails and
	// fs/read offset/tail.
	ReadAt(ctx context.Context, path string, off, n int64) ([]byte, *FileStat, error)
	OpenRaw(ctx context.Context, path string) (io.ReadCloser, *FileStat, error)
	WriteFile(ctx context.Context, path string, data []byte, opt WriteOptions) (*FileStat, error)
	// Mkdir creates one folder (parent must exist; an existing folder is
	// fine). Only for explicit user actions such as reply/save.
	Mkdir(ctx context.Context, path string) error
}

type HostKeyInfo struct {
	Fingerprint string `json:"fingerprint"`
	KeyType     string `json:"keyType"`
	Host        string `json:"host"`
}

type Info struct {
	ID               string       `json:"id"`
	Name             string       `json:"name"`
	Kind             string       `json:"kind"`
	Host             string       `json:"host"`
	Port             int          `json:"port"`
	User             string       `json:"user"`
	SSHConfigHost    string       `json:"sshConfigHost"`
	AuthMethod       string       `json:"authMethod"`
	PersistMode      string       `json:"persistMode"`
	EffectivePersist string       `json:"effectivePersist"`
	Status           string       `json:"status"`
	Error            string       `json:"error"`
	PendingHostKey   *HostKeyInfo `json:"pendingHostKey"`
	HostKeyMismatch  bool         `json:"hostKeyMismatch"`
	NeedsAuth        *AuthNeed    `json:"needsAuth"`
	Probe            *ProbeResult `json:"probe"`
	SessionCount     int          `json:"sessionCount"`
	// HookForward is the reverse port-forward used as the HTTP fallback
	// for agent hooks (SSH only; nil when not requested).
	HookForward *HookForward `json:"hookForward,omitempty"`
}

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

type PipeProc struct {
	Stdin  io.WriteCloser
	Stdout io.Reader
	// contains filtered or unexported fields
}

type ProbeResult struct {
	OS    string `json:"os"`
	Arch  string `json:"arch"`
	Shell string `json:"shell"`
	Home  string `json:"home"`
	Tmux  bool   `json:"tmux"`
	// TmuxVersion is `tmux -V` without the "tmux " prefix ("3.4").
	TmuxVersion string            `json:"tmuxVersion,omitempty"`
	Commands    map[string]string `json:"commands"`
	ProbedAt    time.Time         `json:"probedAt"`
}

type Proc interface {
	io.ReadWriteCloser
	Resize(cols, rows uint16) error
	Signal(sig string) error // "HUP" | "KILL"
	Wait() (exitCode int, err error)
}

type Registry struct {

	// Callbacks, set before Start.
	OnChange     func(Info)
	OnRemoved    func(id string)
	OnConnect    func(id string)
	SessionCount func(id string) int
	// PresetCommands lists commands the probe should look for.
	PresetCommands func() []string
	// HookHandler serves POST /nb/hook on reverse port-forwards; WantForward
	// says whether SSH machines should open one (settings hookChannel).
	HookHandler http.Handler
	WantForward func() bool
	// Log records what happens to the links (package connlog).
	Log func(connlog.Event)
	// contains filtered or unexported fields
}

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

type SSHConfigHost struct {
	Host         string `json:"host"`
	HostName     string `json:"hostName"`
	User         string `json:"user"`
	Port         int    `json:"port"`
	IdentityFile string `json:"identityFile"`
	ProxyJump    string `json:"proxyJump"`
}

type StartSpec struct {
	SessionID string
	Command   string   // "$SHELL" means the machine's login shell
	Args      []string // already chosen (args or resumeArgs)
	Cwd       string   // "" or "~" = home
	Env       []string // KEY=VALUE
	Cols      uint16
	Rows      uint16
	TmuxName  string // remote only: non-empty = run inside tmux session

	// Shell, when set, replaces Command/Args: a POSIX command line (already
	// quoted) run by the login shell, e.g. the agent wrapper
	// `exec /bin/sh -c "$NB_WRAP" nb fresh <id> 0`. Env is exported to it
	// (local: process env; remote: inline `export`).
	Shell string
	// Check is a command that must resolve on the login PATH before a
	// Shell launch (local only; CommandNotFoundError otherwise).
	Check string
}

type WriteOptions struct {
	// IfMtime, when set, must match the current mtime (else ErrMtimeMismatch).
	IfMtime *time.Time
	// Unique picks name-2.ext, name-3.ext, … when the path already exists.
	Unique bool
}