sources

type Backend ¶ added in v0.56.0

type Backend string

Backend identifies which forge driver services a source for a given repo. It is derived from the repo's git remote host (see DetectBackend).

ENUM(github, gitea)

const (
	// BackendGithub is a Backend of type github.
	BackendGithub Backend = "github"
	// BackendGitea is a Backend of type gitea.
	BackendGitea Backend = "gitea"
)

func DetectBackend(host string, overrides map[string]Backend) Backend

func ParseBackend(name string) (Backend, error)

func (x *Backend) AppendText(b []byte) ([]byte, error)

func (x Backend) IsValid() bool

func (x Backend) MarshalText() ([]byte, error)

func (x Backend) String() string

func (x *Backend) UnmarshalText(text []byte) error

type Capabilities ¶

type Capabilities struct {
	FetchDetail bool
}

Capabilities declares optional source behavior.

type Detail ¶

type Detail struct {
	Markdown *MarkdownDetail
}

Detail is an item's optional detail body, fetched via Source.FetchDetail. A nil Markdown means the item has no detail (a PR row, or a fetch that failed), so consumers render an empty body rather than panicking.

type FetchDetailParams ¶

type FetchDetailParams struct {
	ID    string
	Scope string
	// URI is the stable item URI when the source supplies one; optional.
	URI string
	// Dir is the local repository working directory, when one is known; see
	// SearchParams.Dir.
	Dir string
}

FetchDetailParams carries the scope/URI alongside the ID so detail requests are self-contained and do not rely on IDs implicitly encoding their repository/org. This keeps the contract general for sources added later.

type Item ¶

type Item struct {
	ID       string
	Title    string
	Subtitle string
	// URI is a stable identifier echoed back on FetchDetail; optional.
	URI    string
	Fields map[string]any
}

Item is a single browsable/selectable record returned by Search.

type Manifest ¶

type Manifest struct {
	ID           string
	DisplayName  string
	Capabilities Capabilities
	Picker       PickerManifest
}

Manifest describes a source's identity and how the picker should display its items.

type MarkdownDetail ¶

type MarkdownDetail struct {
	Content string
}

MarkdownDetail renders as markdown via the shared glamour renderer.

type PickerManifest ¶

type PickerManifest struct {
	Search SearchManifest
}

PickerManifest configures how the TUI picker searches a source's items.

type Registry ¶

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

Registry holds the set of sources configured for this hive instance in registration order, indexed by (id, backend) so a source id can be serviced by a different driver depending on the repo's forge.

func NewRegistry() *Registry

func (r *Registry) All(backend Backend) []RegistryEntry

func (r *Registry) Get(id string, backend Backend) (Source, TemplateConfig, bool)

func (r *Registry) IDs() []string

func (r *Registry) Register(id string, backend Backend, source Source, templates TemplateConfig, displayName string) error

type RegistryEntry ¶

type RegistryEntry struct {
	ID          string
	DisplayName string
	Source      Source
	Templates   TemplateConfig
}

RegistryEntry exposes a registered source's public fields for the picker.

type RenderedSession ¶

type RenderedSession struct {
	Name   string
	Prompt string
	Tags   []string
}

RenderedSession is the result of rendering a TemplateConfig against a selected Item, ready to pass into hive.CreateOptions.

func RenderSessionTemplates(cfg TemplateConfig, item Item, detail Detail) (RenderedSession, error)

type SearchManifest ¶

type SearchManifest struct {
	// DebounceMS is the delay before a query change issues a remote search;
	// zero uses the picker's default debounce.
	DebounceMS int
}

SearchManifest configures how the picker issues search queries.

type SearchParams ¶

type SearchParams struct {
	Query string
	Scope string
	// Dir is the local repository working directory, when one is known. CLI
	// backends run their binary here so it can resolve the target host/login
	// from the checkout's git remote (e.g. tea's login, gh's GHE host).
	// Empty when there is no local checkout.
	Dir string
	// Cursor is an opaque pagination cursor; empty for the first page.
	// Remote sources may ignore it.
	Cursor string
}

SearchParams carries a search query and scope to a source.

type SearchResult ¶

type SearchResult struct {
	Items []Item
	// NextCursor is opaque; empty when there are no further pages. This is a
	// seam for future pagination support and may always be left empty.
	NextCursor string
}

SearchResult is the response to a Search call.

type Source ¶

type Source interface {
	// Name returns the source's stable identifier (e.g. "github").
	Name() string
	// Available reports whether the source's runtime dependencies
	// (binaries, auth, etc.) are satisfied.
	Available(ctx context.Context) bool
	// Initialize returns the source's display/picker manifest.
	Initialize(ctx context.Context) (Manifest, error)
	// Search returns items matching the given query/scope.
	Search(ctx context.Context, params SearchParams) (SearchResult, error)
	// FetchDetail returns the detail view for a single item.
	FetchDetail(ctx context.Context, params FetchDetailParams) (Detail, error)
}

Source browses an external system and returns items hive can display and map into sessions. Implementations may run in-process (e.g. GitHub via the gh CLI).

type TemplateConfig ¶

type TemplateConfig struct {
	Name   string
	Prompt string
	Tags   []string
}

TemplateConfig holds the user-configured Go templates for mapping a selected source item into session creation inputs.