chainmap

type Activity struct {
	// Calls, Callers and Gas are keyed by fully qualified package path. A
	// transaction's gas is shared evenly between the calls it makes, the
	// indexer reporting gas per transaction only.
	Calls   map[string]int
	Callers map[string]int
	Gas     map[string]int64

	// From and To are the heights counted, both inclusive.
	From, To int
	// Since is when block From was produced.
	Since time.Time

	// Partial is set when part of the window could not be read. A count is
	// then a lower bound, and a zero says nothing.
	Partial bool
}

type Deps struct {
	// Indexer answers activity and proposes importers. Optional: nil means
	// no indexer is configured.
	Indexer Indexer

	// Imports reads a package's imports from the chain: the graph's left
	// side, and the check on every importer the indexer proposes. Required.
	Imports ImportReader

	// Domain is the chain's domain (e.g. "gno.land"), which turns a gnoweb
	// path into the package path the indexer keys on.
	Domain string

	// Limiter bounds the per-IP rate of importer lookups. Optional.
	Limiter Limiter

	Logger *slog.Logger
}

type DepsData struct {
	// Title names the package in the heading, "ufmt/v0" for a versioned one.
	Title string
	Graph components.DepGraph
	// Indexer is the provenance footer, set when the indexer answered.
	Indexer *components.IndexerStatus
}

type Group struct {
	Key string

	Count    int
	Rect     Rect
	HueClass string
	// Head is the name band; nil when the group is too small to carry one.
	Head *Head

	Subgroups []*Subgroup
	// contains filtered or unexported fields
}

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

type Head struct {
	// Class is the band's block class: one partial draws both kinds.
	Class string
	Band  Rect
	Label Label
	// Zoom is the path the box maps, ending with a slash; empty when the box
	// has no map of its own.
	Zoom string
	// Query keeps the map's metric on the zoomed map; see MapData.Query.
	Query string
}

type ImportReader interface {
	Imports(ctx context.Context, pkgPath string) ([]string, error)
}

type Importers struct {
	// Paths are fully qualified and sorted.
	Paths []string
	// Capped is set when the search stopped at a limit: the indexer capped a
	// band, or there were more than maxCandidates. A retry cannot lift it.
	Capped bool
	// Unread is set when a candidate read failed or ran out of time, which a
	// retry can complete. The answer is then kept only briefly.
	Unread bool
	// AsOf is the indexer's last block when the lookup ran.
	AsOf int
}

type Indexer interface {
	LatestBlockHeight(ctx context.Context) (int, error)
	Block(ctx context.Context, height int) (*indexer.Block, error)
	CallsBetween(ctx context.Context, lower, upper int) ([]indexer.Tx, error)
	// DeploysQuoting returns the deploys in the heights (lower, upper] whose
	// source holds pkgPath as a Go string literal, delimiters included, so
	// that a path never matches inside a longer one.
	DeploysQuoting(ctx context.Context, pkgPath string, lower, upper int) ([]indexer.Tx, error)
	URL() string
}

type Label struct {
	Text       string
	X, Y, Size float64
}

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

type Listing struct {
	// Path is the listing's root, gnoweb-relative, e.g. "/r/gnoland".
	Path string
	// Paths are the gnoweb-relative package paths below Path.
	Paths []string
	// Up is the listing one level up, ending with a slash: the way back out
	// of a zoom. Empty when there is none, at a kind's root such as /r/ or
	// where the path above is a package, which has no listing to map.
	Up string
	// Metric is what the tiles are shaded by; the zero value is calls.
	Metric Metric
}

type MapData struct {
	// Root is the listing's root, ending with a slash.
	Root string
	// Up is the listing one level up; see Listing.Up.
	Up     string
	Groups []*Group

	// Window is the activity the tiles are coloured with, nil when there is
	// none; Activity then says why, or is empty when no indexer is
	// configured and the key says nothing about activity at all.
	Window   *Activity
	Activity string
	// Scale is the colour steps the tiles use, for the key.
	Scale []ScaleStep

	// Indexer is the provenance footer, set whenever the indexer answered.
	Indexer *components.IndexerStatus

	// Busiest are the realms ranking highest on the metric, set with
	// activity.
	Busiest []Tile

	// Metric is what the tiles are shaded by, and Query what a map link
	// appends after $map to keep it.
	Metric Metric
	Query  string
}

type Metric string

type Rect struct{ X, Y, W, H float64 }

type ScaleStep struct {
	Class, Range string
	// contains filtered or unexported fields
}

type Subgroup struct {
	Key string

	Rect Rect
	Head *Head

	Tiles []Tile
	// contains filtered or unexported fields
}

type Tile struct {
	Path  string // gnoweb-relative, the package's page
	Rect  Rect
	Label *Label
	// Title is the tooltip and accessible name: the full path, which the
	// label shortens, and the activity when there is any.
	Title string

	Calls, Callers int
	// Gas is the gas the realm's calls used over the window.
	Gas int64
	// Amount is the metric's value written for the key's busiest list.
	Amount string
	// Unknown marks a tile whose count the indexer could not settle.
	Unknown bool
	// ShadeClass is the activity colour, empty when the map shows none.
	ShadeClass string
}