selfupdate

type Config struct {
	// Getenv reads the process environment (KORBIT_CLI_HOME, HOME/USERPROFILE,
	// LOCALAPPDATA, PATH). Injectable so tests point it at a temp dir.
	Getenv func(string) string
	// Now is the local clock in unix-ms, stamped into the manifest's installedAt.
	Now func() int64
	// Doer is the HTTP client self update / version resolution run through
	// (nil is fine for install/uninstall/doctor, which touch no network).
	Doer Doer
	// GOOS / GOARCH are the target platform (runtime.GOOS/GOARCH in production;
	// injectable so the path layout can be tested for another OS on this host).
	GOOS   string
	GOARCH string
	// Version is the running binary's version (internal/version.Version). A "dev"
	// value marks an unmanaged source build and is refused.
	Version string
	// Repo is the release repository (owner/name); empty means DefaultRepo.
	Repo string
	// ReleaseCertURL is the URL of the release-signing certificate on the trusted
	// docs host; empty means DefaultReleaseCertURL. Injectable so tests point it
	// at a stub endpoint.
	ReleaseCertURL string
	// PathConfirm is asked once per PATH location that needs the installer's entry
	// (each shell rc file on unix; the User PATH on windows) and returns whether to
	// apply it. nil means non-interactive (no TTY reachable) — PATH wiring then only
	// prints guidance instead of editing dotfiles (unix) / keeps the silent write
	// (windows). The cli layer wires a /dev/tty-backed confirm that renders the
	// addition's diff preview and defaults an empty answer to yes.
	PathConfirm func(add PathAddition) (bool, error)
	// Progress is the human progress/instruction sink (stderr). It is never the
	// result: everything an agent needs is in the returned struct.
	Progress io.Writer
	// Logger is the optional operational logger for the fragile network/filesystem
	// path (release resolution, each fetch, the signature/checksum verdicts, the
	// in-place binary swap, manifest writes, PATH edits). nil = silent (resolved
	// via logging.Or in log). It is distinct from Progress: Progress is program
	// output, Logger is the level-gated --debug/--log-level telemetry.
	Logger *slog.Logger
	// contains filtered or unexported fields
}

type DiffLine struct {
	Num  int    `json:"num,omitempty"`
	Text string `json:"text"`
}

type DoctorProblem struct {
	Field   string `json:"field"`
	Message string `json:"message"`
}

type DoctorReport struct {
	Managed          bool            `json:"managed"`
	Method           string          `json:"method,omitempty"`
	RunningVersion   string          `json:"runningVersion"`
	InstalledVersion string          `json:"installedVersion,omitempty"`
	RunningFrom      string          `json:"runningFrom"`
	Executable       string          `json:"executable"`
	ExecutableValid  bool            `json:"executableValid"`
	ExecutableDir    string          `json:"executableDir"`
	OnPath           bool            `json:"onPath"`
	Problems         []DoctorProblem `json:"problems"`
}

type Doer interface {
	Do(*http.Request) (*http.Response, error)
}

type FailedRemoval struct {
	Path   string `json:"path"`
	Reason string `json:"reason"`
}

type InstallResult struct {
	Version    string     `json:"version"`
	Executable string     `json:"executable"`
	SHA256     string     `json:"sha256"`
	Repaired   []string   `json:"repaired"` // healed states (always present; [] when clean)
	Path       PathResult `json:"path"`
	Warnings   []string   `json:"warnings,omitempty"`
}

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

type Manifest struct {
	Method      string `json:"method"` // MethodManagedScript
	Executable  string `json:"executable"`
	Version     string `json:"version"`
	OS          string `json:"os"`
	Arch        string `json:"arch"`
	SHA256      string `json:"sha256"`
	Repo        string `json:"repo"`
	InstalledAt string `json:"installedAt"` // unix-ms as a string
}

type PathAddition struct {
	Location string     `json:"location"`
	Context  []DiffLine `json:"context,omitempty"`
	Added    []DiffLine `json:"added"`
	NewFile  bool       `json:"newFile,omitempty"`
}

type PathEdit struct {
	// Location is the rc file path (unix) or a human label for the User PATH
	// (windows).
	Location string `json:"location"`
	// Lines are the removed lines, most-to-least specific as they appear; for a
	// file each carries its line number, for the User PATH a single entry (Num 0).
	Lines []DiffLine `json:"lines"`
}

type PathResult struct {
	Dir    string `json:"dir"`
	OnPath bool   `json:"onPath"`
	// Action is what was done: "already-on-path", "edited-shell-rc" (unix, on a
	// yes prompt), "added-user-path" (windows), or "instructions" (non-interactive
	// or declined — the user must add it themselves; see Hint).
	Action string   `json:"action"`
	Files  []string `json:"files,omitempty"` // shell rc files edited (unix)
	Hint   string   `json:"hint,omitempty"`  // the manual step / follow-up
}

type ProvenanceError struct {
	Message  string
	Guidance string
}

type UninstallOptions struct {
	// RemoveBinary removes the installed binary, the install manifest, and any
	// leftover swap file. A binary that cannot delete itself (the locked running
	// korbit.exe on Windows) is reported in Failed instead.
	RemoveBinary bool
	// RemoveData removes the CLI-home data files in DataPaths (config.json, the
	// journal) and, when the home is then empty, the home dir. Key material is
	// cleared first via ClearKeys.
	RemoveData bool
	// RemoveCaches removes the regenerable sandbox artifacts in Artifacts.
	RemoveCaches bool

	// Artifacts are the regenerable sandbox artifact dirs (resolved by the caller).
	// Removed only under RemoveCaches; non-existent entries ignored.
	Artifacts []string
	// DataPaths are the CLI-home data files to remove under RemoveData (config +
	// journal + sidecars). The key registry/vault are removed by ClearKeys instead.
	DataPaths []string
	// EditPaths are the PATH locations (from PathEdits) the user accepted undoing.
	EditPaths []string

	// ClearKeys clears every key's material from its backend and removes the key
	// files, returning removed lines + warnings. Called under the lock before
	// deleting DataPaths (RemoveData only); nil = skip. It lives in the cli layer
	// because it needs the key manager; running it here keeps every destructive
	// step under the one lock and in one returned result.
	ClearKeys func() (removed, warnings []string)
	// StopSandbox stops a sandbox running under the default state dir before its
	// caches are removed (RemoveCaches only); nil = skip. A stop error is a warning.
	StopSandbox func() error
}

type UninstallResult struct {
	// Removed lists files/dirs actually deleted (binary, manifest, data files,
	// caches, the emptied CLI home) plus a line per cleared API key.
	Removed []string `json:"removed,omitempty"`
	// Edited lists the PATH locations whose installer change was undone (a shell rc
	// file's managed block, or the User PATH entry).
	Edited []string `json:"edited,omitempty"`
	// Failed lists things that could not be removed/edited, with a reason (a locked
	// binary, a permission error, a non-empty dir, a failed edit).
	Failed []FailedRemoval `json:"failed,omitempty"`
	// KeptPaths lists PATH locations left as-is (the user declined, or none was
	// selected) so the summary can tell the user to edit them by hand. Set by the
	// cli layer, which knows what was offered vs accepted.
	KeptPaths []string `json:"keptPaths,omitempty"`
	// Warnings are non-fatal problems that aren't a specific failed removal (a
	// sandbox that could not be stopped, a home-containing cache refused).
	Warnings []string `json:"warnings,omitempty"`
}

type UpdateResult struct {
	PreviousVersion string `json:"previousVersion"`
	LatestVersion   string `json:"latestVersion"`
	Updated         bool   `json:"updated"`
	CheckedOnly     bool   `json:"checkedOnly"`
	Executable      string `json:"executable,omitempty"`
	SHA256          string `json:"sha256,omitempty"`
	// SignatureCheck records how the release signature was handled for an applied
	// update: SigVerified (verified against the published cert) or SigDisabled
	// (the docs host served an empty cert — the kill switch). Empty when no update
	// was applied (dry-run / already-latest), so an agent can audit from --json
	// output whether the binary it now runs was signature-verified.
	SignatureCheck string `json:"signatureCheck,omitempty"`
}