plugins

type Catalog struct {
	Plugins []Listing `json:"plugins"`
	// Revoked are plugins pulled for a security problem; see Revocation.
	Revoked []Revocation `json:"revoked,omitempty"`
}

type Command struct {
	Name  string `yaml:"name" json:"name"`
	Usage string `yaml:"usage,omitempty" json:"usage,omitempty"`
	Run   string `yaml:"run" json:"run"`
}

type Endpoint struct {
	Path    string   `yaml:"path" json:"path"`
	Methods []string `yaml:"methods,omitempty" json:"methods,omitempty"`
	Run     string   `yaml:"run" json:"run"`
	// LoopbackOnly closes the endpoint to remote dashboards unless the user
	// turned on remote full access, like lerd's own host-action routes.
	LoopbackOnly bool `yaml:"loopback_only,omitempty" json:"loopback_only,omitempty"`
	// Timeout raises APILimit for this endpoint, up to ten minutes.
	Timeout string `yaml:"timeout,omitempty" json:"timeout,omitempty"`
}

type Failure struct {
	Plugin  string    `json:"plugin"`
	Surface string    `json:"surface"`
	What    string    `json:"what"`
	Error   string    `json:"error"`
	At      time.Time `json:"at"`
}

type Feature struct {
	Kind   string `json:"kind"`
	Name   string `json:"name"`
	Detail string `json:"detail,omitempty"`
}

type Listing struct {
	Name        string   `json:"name"`
	Description string   `json:"description,omitempty"`
	Repo        string   `json:"repo"`
	Commit      string   `json:"commit"`
	Author      string   `json:"author,omitempty"`
	Category    string   `json:"category,omitempty"`
	Tags        []string `json:"tags,omitempty"`
	// Version is the approved commit's own version, as its plugin.yaml says.
	Version string `json:"version,omitempty"`
	// Lerd is the approved commit's own `lerd` constraint.
	Lerd string `json:"lerd,omitempty"`
	// Requires is what the approved commit needs on the machine, as
	// Plugin.Requirements reads it.
	Requires []string `json:"requires,omitempty"`
	// Platforms is the approved commit's own `platforms`, empty for both.
	Platforms []string `json:"platforms,omitempty"`
	// Images are copied by the registry at the approved commit and published
	// beside the index, the first one being the preview. The index lists them
	// relative to itself; LoadCatalog hands them out as absolute URLs.
	Images []string `json:"images,omitempty"`
	// AddedAt and UpdatedAt are the days the plugin was first approved and its
	// current commit was; Stars is its repository's count when the index was built.
	AddedAt   string `json:"added_at,omitempty"`
	UpdatedAt string `json:"updated_at,omitempty"`
	Stars     int    `json:"stars,omitempty"`
}

type LoadError struct {
	Dir string
	Err error
}

type MCP struct {
	Skill string    `yaml:"skill,omitempty" json:"skill,omitempty"`
	Tools []MCPTool `yaml:"tools,omitempty" json:"tools,omitempty"`
}

type MCPTool struct {
	Name        string         `yaml:"name" json:"name"`
	Description string         `yaml:"description" json:"description"`
	InputSchema map[string]any `yaml:"input_schema,omitempty" json:"input_schema,omitempty"`
	Run         string         `yaml:"run" json:"run"`
	// Timeout raises MCPLimit for this tool, up to ten minutes.
	Timeout string `yaml:"timeout,omitempty" json:"timeout,omitempty"`
}

type Manifest struct {
	APIVersion  int    `yaml:"api_version" json:"api_version"`
	Name        string `yaml:"name" json:"name"`
	Version     string `yaml:"version,omitempty" json:"version,omitempty"`
	Description string `yaml:"description,omitempty" json:"description,omitempty"`
	// Lerd is the oldest lerd release the plugin needs, as a constraint like ">=1.37".
	Lerd         string            `yaml:"lerd,omitempty" json:"lerd,omitempty"`
	Commands     []Command         `yaml:"commands,omitempty" json:"commands,omitempty"`
	SiteCommands []SiteCommand     `yaml:"site_commands,omitempty" json:"site_commands,omitempty"`
	Hooks        map[string]string `yaml:"hooks,omitempty" json:"hooks,omitempty"`
	MCP          *MCP              `yaml:"mcp,omitempty" json:"mcp,omitempty"`
	API          []Endpoint        `yaml:"api,omitempty" json:"api,omitempty"`
	UI           *UI               `yaml:"ui,omitempty" json:"ui,omitempty"`
	// Provides maps each job the plugin takes over from lerd to the executable
	// lerd runs for it.
	Provides map[string]string `yaml:"provides,omitempty" json:"provides,omitempty"`
	// Requires names the commands the plugin's scripts call beyond their own
	// interpreters, which lerd reads from each script's first line.
	Requires []string `yaml:"requires,omitempty" json:"requires,omitempty"`
	// Platforms lists where the plugin runs, linux or macos; empty means both.
	Platforms []string `yaml:"platforms,omitempty" json:"platforms,omitempty"`
	// Icon is a single-colour SVG drawn for the plugin on its card, whatever it
	// adds; a rail page's own icon stands in when it is empty.
	Icon string `yaml:"icon,omitempty" json:"icon,omitempty"`
	// Docs is a markdown file of instructions the dashboard shows once the
	// plugin is installed, apart from the README its repository shows.
	Docs string `yaml:"docs,omitempty" json:"docs,omitempty"`
	// Screenshots are images in the plugin shown on its card in the dashboard.
	Screenshots []string `yaml:"screenshots,omitempty" json:"screenshots,omitempty"`
	// Notifications says the plugin may tell the user something through lerd's
	// notifications, which it can only do once the user has allowed it.
	Notifications bool `yaml:"notifications,omitempty" json:"notifications,omitempty"`
}

type Plugin struct {
	Manifest
	Dir string `json:"dir"`
}

type Revocation struct {
	Name    string   `json:"name"`
	Reason  string   `json:"reason"`
	At      string   `json:"at"`
	Commits []string `json:"commits,omitempty"`
}

type RevokedError struct{ Revocation }

type SiteCommand struct {
	Name        string `yaml:"name" json:"name"`
	Label       string `yaml:"label" json:"label"`
	Description string `yaml:"description,omitempty" json:"description,omitempty"`
	Confirm     bool   `yaml:"confirm,omitempty" json:"confirm,omitempty"`
	Run         string `yaml:"run" json:"run"`
	// Timeout raises SiteCommandLimit for this command, up to an hour.
	Timeout string `yaml:"timeout,omitempty" json:"timeout,omitempty"`
}

type Source struct {
	Repo   string `json:"repo"`
	Commit string `json:"commit"`
}

type UI struct {
	Page    *UIPage `yaml:"page,omitempty" json:"page,omitempty"`
	SiteTab *UIPage `yaml:"site_tab,omitempty" json:"site_tab,omitempty"`
	// OverviewCard is drawn on the Overview of the sites the user switched the
	// plugin's card on for.
	OverviewCard *UIPage `yaml:"overview_card,omitempty" json:"overview_card,omitempty"`
	// PageScript is injected into the pages of the sites the user switched the
	// plugin on for, and runs in those sites' own origin.
	PageScript string `yaml:"page_script,omitempty" json:"page_script,omitempty"`
}

type UIPage struct {
	Title string `yaml:"title" json:"title"`
	Icon  string `yaml:"icon,omitempty" json:"icon,omitempty"`
	Entry string `yaml:"entry" json:"entry"`
}