omnisearch

type ClientAdapter interface {
	Realm(ctx context.Context, path, args string) ([]byte, error)
	Doc(ctx context.Context, path string, height int64) (*doc.JSONDocumentation, error)
	ListFiles(ctx context.Context, path string, height int64) ([]string, error)
}

type Deps struct {
	// Client answers the chain-backed selectors. Required.
	Client ClientAdapter

	// Directory lists realm and package paths for the discovery search.
	// Required.
	Directory Directory

	// Indexer answers the indexer-backed selectors. Optional: nil means no
	// indexer is configured and those selectors do not exist.
	Indexer Indexer

	// Domain is the chain's domain (e.g. "gno.land"), used to turn a gnoweb
	// path into the fully qualified package path the chain indexes under.
	Domain string

	// Limiter bounds the per-IP request rate. Optional; nil disables the
	// check.
	Limiter Limiter

	Logger *slog.Logger
}

type Directory interface {
	// Paths returns the realm and package paths, and whether the node capped
	// the listing. Truncation travels with the answer because a silent cap
	// is how a search comes to say "no such realm" about one that exists.
	Paths(ctx context.Context) (realms, packages []string, truncated bool, err error)
}

type Filter struct {
	Key   string
	Value string
}

type Group struct {
	Label   string
	Source  Source
	Results []Result

	// Err renders as a failure rather than being dropped: "could not ask" is
	// not "nothing matched".
	Err error

	// Truncated marks a partial answer: more may exist than Results holds.
	// Notice says why, in the reader's terms.
	Truncated bool
	Notice    string
}

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

type Indexer interface {
	LatestBlockHeight(ctx context.Context) (int, error)
	TxByHash(ctx context.Context, hash string) (*indexer.Tx, error)
	RecentByPackage(ctx context.Context, pkgPath string, limit int) ([]indexer.Tx, error)
	RecentByAddress(ctx context.Context, addr string, limit int) ([]indexer.Tx, error)
	Deploys(ctx context.Context, pkgPath string, limit int) ([]indexer.Tx, error)
	SourceContains(ctx context.Context, text, author string, limit int) ([]indexer.Tx, error)
	DeploysImporting(ctx context.Context, pkgPath string, limit int) ([]indexer.Tx, error)
	Block(ctx context.Context, height int) (*indexer.Block, error)
	URL() string
}

type IndexerStatus struct {
	URL       string
	LastBlock int
	// Err makes the footer say the freshness is unknown rather than omit it.
	Err error
}

type Limiter interface {
	AllowRequest(r *http.Request) bool
}

type Query struct {
	// Raw is the validated input, as typed; Text is what is left once the
	// qualifiers are removed.
	Raw  string
	Text string

	Filters []Filter

	// PkgPath is gnoweb-relative ("/r/demo/boards"), the form Doc/ListFiles
	// take and every href is built from. ChainPath is the same package
	// domain-qualified, the form the chain and the indexer use. Not
	// interchangeable.
	PkgPath   string
	ChainPath string
	// contains filtered or unexported fields
}

type Result struct {
	Title  string
	Detail string

	// Href is typed so escaping is enforced by construction. Empty when the
	// row has no destination.
	Href template.URL

	// Tags are short badges. Provenance is not among them — it belongs to
	// the group, and Group.Source carries it once.
	Tags []string
}

type Scope string

type SearchData struct {
	Query string

	// PkgPath is the scoped package, gnoweb-relative; empty when the URL
	// names none.
	PkgPath string

	// WholeChainHref, set on a scoped discovery search, repeats it without
	// the scope.
	WholeChainHref string

	// FormAction is explicit rather than `action=""`, which would re-submit
	// the webargs already in the path and grow the URL on every search.
	FormAction string

	Groups []Group

	// Selectors is the honest inventory of what this deployment can answer.
	Selectors []*Selector

	// UnknownFilter names a qualifier that is neither a selector nor a
	// narrowing keyword, so the page can say so instead of showing nothing.
	UnknownFilter string

	// Indexer is set only when an indexer-backed group ran; nil drops the
	// provenance footer entirely.
	Indexer *IndexerStatus
}

type Selector struct {
	// Name is the qualifier key, e.g. "tx" in `tx:9f2a`.
	Name string

	// Hint is the form shown in the omnibar's suggestion list.
	Hint  string
	Label string
	Scope Scope

	// Source is stamped by register from the table the selector is in, not
	// by the literal. See Handler.register.
	Source Source

	// Bare marks a selector typed without a colon (`imports`, `activity`).
	Bare bool

	// MinTerm raises MinTermLen where the term's selectivity sets the cost.
	MinTerm int

	// PageOnly keeps a fan-out selector off the per-keystroke JSON path.
	PageOnly bool
	// contains filtered or unexported fields
}

type Source string