registry

type Catalog struct {
	SchemaVersion int     `json:"schema_version"`
	Name          string  `json:"name,omitempty"`
	UpdatedAt     string  `json:"updated_at,omitempty"`
	Plugins       []Entry `json:"plugins"`
}

type Entry struct {
	// ID is the stable, unique handle users type: `ty plugins add slack`.
	ID string `json:"id"`
	// Name is the human-facing title.
	Name string `json:"name"`
	// Description is one or two sentences on what the plugin does.
	Description string `json:"description"`
	// Author is a display name or GitHub handle.
	Author string `json:"author,omitempty"`
	// Source is the git URL to clone.
	Source string `json:"source"`
	// Subdir is the plugin's path inside Source, for collection repos that hold
	// many plugins. Empty means the repo root is the plugin.
	Subdir string `json:"subdir,omitempty"`
	// Homepage is a URL to read more (README, docs page).
	Homepage string `json:"homepage,omitempty"`
	// Category groups entries in the browser ("workflows", "notifications", …).
	Category string `json:"category,omitempty"`
	// Tags are free-form search keywords.
	Tags []string `json:"tags,omitempty"`
	// Provides lists the plugin's capability kinds ("workflow", "hook",
	// "action", "service", "routine") so a browser can say what you get.
	Provides []string `json:"provides,omitempty"`
	// Requires lists external prerequisites in plain words ("jq", "an ARC API
	// key") — the things that make an install fail confusingly if missing.
	Requires []string `json:"requires,omitempty"`
}

type Loader struct {
	// URLs are the remote catalogs to overlay onto the bundled snapshot, in
	// increasing precedence order.
	URLs []string
	// CacheDir is where fetched catalogs are cached.
	CacheDir string
	// TTL is how long a cached copy is served before re-fetching.
	TTL time.Duration
	// HTTP is the client used for fetches.
	HTTP *http.Client
	// Now is the clock, injectable for tests.
	Now func() time.Time
}

type Match struct {
	Entry Entry
	Score int
}

type Origin struct {
	// URL is the remote catalog, or "bundled" for the embedded snapshot.
	URL string
	// From is "bundled", "cache", or "network".
	From string
	// Entries is how many entries this layer contributed (before overlay).
	Entries int
	// Age is how old the served copy is; zero for a fresh fetch.
	Age time.Duration
	// Err is why a remote fetch was not used, if it failed.
	Err error
}

type Result struct {
	Entries []Entry
	Origins []Origin
}