skills

type Build struct {
	Version  string
	Revision string
}

type Consent struct {
	// All is a person's yes for every target (the request field "adopt").
	All       bool
	Dirs      []string
	Harnesses []string
}

type Definition struct {
	ID string
	// Dir is the skill's directory, in skills/ and in a harness's skills
	// directory.
	Dir string
	// contains filtered or unexported fields
}

type Document struct {
	Schema int             `json:"schema"`
	Skills []Skill         `json:"skills"`
	Next   []envelope.Next `json:"next"`
}

type Env struct {
	Home   string
	Getenv func(string) string
}

type InstallDocument struct {
	Schema int    `json:"schema"`
	Skill  string `json:"skill"`
	Dir    string `json:"dir"`
	Name   string `json:"name"`
	DryRun bool   `json:"dry_run,omitempty"`
	// AlreadyUpToDate is set when no target changed.
	AlreadyUpToDate bool            `json:"already_up_to_date"`
	Outcomes        []Outcome       `json:"targets"`
	Next            []envelope.Next `json:"next"`
}

type InstallRequest struct {
	Skill     string          `json:"skill"`
	Harnesses []string        `json:"harnesses,omitempty"`
	Targets   []RequestTarget `json:"targets,omitempty"`
	DryRun    bool            `json:"dry_run,omitempty"`
	// ReplaceChanged replaces a copy the person edited since OVDB installed
	// it; only after they agreed to lose those edits.
	ReplaceChanged bool `json:"replace_changed,omitempty"`
	// Adopt takes over, in every target, a folder that was already there and
	// already is this skill, keeping a backup of it; only after the person
	// agreed to that. It is what clients from v0.22.0 to v0.28.x send. Without
	// it (and without AdoptDirs and AdoptHarnesses) such a folder is refused
	// and left untouched, which is what every client built before adoption
	// existed (v0.21.0) expects: the server never sends one a state or result
	// it did not ask for.
	Adopt bool `json:"adopt,omitempty"`
	// AdoptDirs are the skill folders (Target.Dir) the person was shown as
	// already there and agreed to have taken over. A folder that became
	// adoptable after they were shown the list is not among them, so it is
	// refused. The CLI and TUI send it instead of Adopt.
	AdoptDirs []string `json:"adopt_dirs,omitempty"`
	// AdoptHarnesses is AdoptDirs for the web console, which names harnesses
	// and never a directory.
	AdoptHarnesses []string `json:"adopt_harnesses,omitempty"`
}

type Installed struct {
	ID           string   `json:"id"`
	InstalledFor []string `json:"installed_for"`
	// UpdateAvailableFor lists the harnesses whose copy an older ovdb
	// installed; `ovdb skills install <id>` updates it.
	UpdateAvailableFor []string `json:"update_available_for"`
	// ChangedFor lists the harnesses whose copy the person edited.
	ChangedFor []string `json:"changed_for"`
}

type Outcome struct {
	Target
	// Result is one of skillsync's actions: added, updated, unchanged,
	// adopted, conflict (removed is never planned for an install).
	Result string `json:"result"`
	Reason string `json:"reason,omitempty"`
	// BackupPath is where the copy that was already there is kept after
	// Result adopted; empty for every other result and for a dry run.
	BackupPath string `json:"backup_path,omitempty"`
}

type RequestTarget struct {
	Harness   string `json:"harness,omitempty"`
	SkillsDir string `json:"skills_dir"`
}

type Skill struct {
	ID      string `json:"id"`
	Dir     string `json:"dir"`
	Name    string `json:"name"`
	Purpose string `json:"purpose"`
	Example string `json:"example"`
	// Command installs it; interfaces show it next to Install.
	Command string   `json:"command"`
	Targets []Target `json:"targets"`
	// InstalledFor lists the harnesses it is installed for.
	InstalledFor []string `json:"installed_for"`
}

type Target struct {
	Harness string `json:"harness,omitempty"`
	Name    string `json:"name"`
	// SkillsDir is the harness's skills directory.
	SkillsDir string `json:"skills_dir"`
	// Dir is where this skill is, or would be, installed.
	Dir       string `json:"dir"`
	Detected  bool   `json:"detected"`
	Installed bool   `json:"installed"`
	// State is one of the State constants.
	State string `json:"state"`
	// StateReason is skillsync's own reason for the state where it says more
	// than the state does: for another's folder what was found in it (a stray
	// ".DS_Store" in a copy of this skill), for a pending recovery what is
	// wrong. Empty for every other state, and left out of documents for
	// clients that predate it (see Document.ForClient).
	StateReason string `json:"state_reason,omitempty"`
}