components

type AIAction struct {
	Label string
	Hint  string
	Links []AILink
}

type AILink struct {
	Name     string
	URL      string
	Outbound string
}

type AIMenu struct {
	Context string
	Actions []AIAction
	// PackageText, on source views, is the same-origin URL of the whole
	// package as one text, for pasting into any assistant.
	PackageText string
	// MCP links to the gnomcp site, which explains how to install it.
	MCP AILink
}

type AnalyticsData struct {
	Enabled  bool
	PageType string
	// Path is the analytics pageview path (see analyticsPath) rendered as
	// data-sa-path; the client reports it to SimpleAnalytics in place of the
	// raw pathname.
	Path          string
	ChainId       string
	AssetsPath    string
	AssetsVersion string
	// Hostname, when non-empty, is rendered as data-hostname on the
	// SimpleAnalytics script tag to override the hostname SA reports.
	// Set this when the site listens on a host SA would otherwise report
	// incorrectly (for example a non-default port in local development).
	Hostname string
}

type ArticleData struct {
	ComponentContent Component
	Classes          string
	// SkipTarget makes the article the skip link's target (#main-content),
	// for views whose rail precedes it (see View.SkipTargetInBody).
	SkipTarget bool
}

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

type BreadcrumbData struct {
	Parts    []BreadcrumbPart
	ArgParts []BreadcrumbPart
	Queries  []QueryParam
	// Namespace is set on /r/<ns>/... and /p/<ns>/... paths, where the first
	// segment opens a menu: the listing it used to link, the namespace page,
	// and the Counterpart when there is one.
	Namespace string
	// Counterpart heads that menu with the other side of the project. Nil
	// when the other side holds no package.
	Counterpart *HeaderLink
}

type BreadcrumbPart struct {
	Name string
	URL  string
}

type CommandData struct {
	FuncName   string
	PkgPath    string
	ParamNames []string
	ChainId    string
	Remote     string
}

type Component interface {
	Render(w io.Writer) error
}

type DepGraph struct {
	// Name is the package's gnoweb path: at the centre of the graph a bare
	// "v0" would say nothing.
	Name    string
	Imports []ImportLink

	// LookupURL links to the page that computes importers. Set where this
	// deployment can compute them but the page does not.
	LookupURL string

	// Importers is set on the page that computed them.
	Importers *Importers
}

type DirData struct {
	PkgPath     string
	FileCounter int
	FilesLinks  FilesLinks
	Mode        ViewMode
	Readme      Component
	// Truncated is set on a listing that stopped at its cap.
	Truncated bool
	// Rail is an explorer listing's side rail (ui/listing_rail).
	Rail Component
	// Map is the listing drawn as a map; nil renders it as a list.
	Map Component
}

type DirLinkType int

type DocRenderer interface {
	RenderDocumentation(w io.Writer, src []byte) error
	RenderSource(w io.Writer, name string, src []byte) error
}

type FileClass struct {
	IsGno     bool
	IsTest    bool
	IsReadme  bool
	IsLicense bool
}

type FileFetcher interface {
	Fetch(ctx context.Context, pkgPath, fileName string, height int64) ([]byte, error)
}

type FileLink struct {
	Name      string
	Link      string
	IsTest    bool
	IsReadme  bool
	IsLicense bool
}

type FilesLinks []FullFileLink

type FooterData struct {
	Analytics   AnalyticsData
	Sections    []FooterSection
	LegalNotice string
	LegalLinks  []FooterLink
}

type FooterLink struct {
	Label string
	URL   string
	// Outbound, when set to one of the Outbound* constants, is rendered as
	// data-outbound on the link so SimpleAnalytics fires a named
	// outbound_<label> event instead of an anonymous outbound click.
	Outbound string
}

type FooterSection struct {
	Title string
	Links []FooterLink
}

type FullFileLink struct {
	Link string
	Name string
}

type FuncEntry struct {
	Name               string
	SignatureComponent Component
	Doc                Component
	Receiver           string
	Crossing           bool
	IsMethod           bool
	ActionURL          string
	AnchorID           string
	SourceURL          string // links to the exact file + line in source view
}

type HeadData struct {
	Title       string
	Description string
	Canonical   string
	// Robots is the content of the robots meta, as the handler decided it.
	Robots            string
	SiteName          string
	Image             string
	ImageAlt          string
	URL               string
	ChromaPath        string
	AssetsPath        string
	AnalyticsHostname string
	Remote            string
	ChainId           string
	AssetsVersion     string
}

type HeaderData struct {
	RealmPath string
	// SearchAction is the omnibar form's target. It exists so the bar works
	// with JavaScript disabled: the form submits here and the reader gets
	// the server-rendered results page. With JavaScript the controller
	// intercepts the submit, so this stays the fallback rather than the
	// normal path.
	SearchAction string
	RealmURL     weburl.GnoURL
	Breadcrumb   BreadcrumbData
	Links        HeaderLinks
	ChainId      string
	Remote       string
	Mode         ViewMode
	Static       bool
	// Origin is the request scheme+host the AI prompts link to.
	Origin string
	AI     *AIMenu
	Notice RealmNotice
	// Listing is set on a directory listing, whose tabs it carries.
	// MapTab is set by a directory listing large enough for a map: it then
	// offers its Directory and Map renderings as tabs.
	MapTab bool
}

type HeaderLink struct {
	Label    string
	URL      string
	Icon     string
	IsActive bool
	// Tooltip is shown on hover to explain what the link opens. Empty renders
	// no title attribute.
	Tooltip string
	// Outbound, when set to one of the Outbound* constants, is rendered as
	// data-outbound on the link so SimpleAnalytics fires a named
	// outbound_<label> event instead of an anonymous outbound click.
	Outbound string
	// Path is the plain path a menu item shows under its label, where URL
	// may carry a tab and an anchor ($source#subpackages).
	Path string
}

type HeaderLinks struct {
	General []HeaderLink
	Dev     []HeaderLink
}

type HelpData struct {
	// Selected function
	SelectedFunc string
	SelectedArgs map[string]string
	SelectedSend string

	RealmName   string
	Functions   []HelpFunction
	ChainId     string
	Remote      string
	PkgPath     string
	PkgFullPath string
	Doc         Component
	Domain      string
	Origin      string // request scheme+host; makes help URLs shareable
	// Community is set on packages outside the trusted paths, the pages that
	// show the realm notice.
	Community bool
}

type HelpFunction struct {
	*doc.JSONFunc
	DocComponent Component
}

type HelpTocData struct {
	Icon  string
	Items []HelpTocItem
}

type HelpTocItem struct {
	Link string
	Text string
}

type ImportLink struct {
	Path     string
	Kind     string // "stdlib" | "package" | "realm" | "external"
	Link     string
	External bool
}

type Importers struct {
	Links []ImportLink
	// Capped says the search stopped at a limit, so there may be more; a
	// reload cannot lift it.
	Capped bool
	// Retry says some candidates could not be read, which a reload may
	// complete.
	Retry bool
	// Unavailable says why there is no answer; Links is then empty.
	Unavailable string
}

type IndexData struct {
	HeadData
	HeaderData
	FooterData
	BodyView *View
	Mode     ViewMode
	Theme    string
	Banner   BannerData
	// SearchBase, when set, is the path the reader asked for before an alias
	// rewrote it. The header search posts there, as the JavaScript omnibar
	// does from window.location: on the home page it searches the chain,
	// not the realm the alias renders.
	SearchBase string
}

type IndexerStatus struct {
	URL       string
	LastBlock int
}

type License struct {
	Kind     string
	FileName string
}

type MapParts struct {
	Figure, Key Component
}

type OverviewData struct {
	PkgPath    string
	Title      string
	Synopsis   string
	PackageDoc Component
	Readme     Component

	Info    PackageInfo
	Stats   PackageStats
	Quality PackageQuality

	Funcs       []FuncEntry
	Types       []TypeEntry
	Consts      []ValueGroup
	Vars        []ValueGroup
	Files       []FileLink
	Subpackages []SubpackageLink
	Bugs        []string

	// SymbolsTruncated is set when funcs/types/values were capped at
	// maxOverviewSymbols; the template then shows a "view full source" notice.
	SymbolsTruncated bool

	// Graph draws the package between what it imports and, when an indexer
	// can tell, what imports it.
	Graph DepGraph

	ComponentTOC Component
}

type OverviewInput struct {
	URL         *weburl.GnoURL
	Files       []string
	Doc         *doc.JSONDocumentation
	Sources     map[string][]byte
	Subpaths    []string
	Readme      Component
	Domain      string
	DocRenderer DocRenderer
	// DepsURL is the page listing the package's importers, set only when
	// this deployment can compute them.
	DepsURL string
}

type PackageInfo struct {
	Namespace   string
	PackagePath string
	PackageType string // "realm" | "pure"
	License     License
	GnoVersion  string
	Creator     string // gnomod [addpkg] creator address (on-chain deploys)
	Height      int    // gnomod [addpkg] deploy block height
	Draft       bool   // gnomod draft = not production-ready
	Private     bool   // gnomod private
}

type PackageQuality struct {
	HasReadme  bool
	HasTests   bool
	HasLicense bool
	HasPkgDoc  bool
}

type PackageStats struct {
	FileCount     int
	GnoFileCount  int
	TestCount     int
	FuncCount     int
	ExportedFunc  int
	TypeCount     int
	ConstCount    int
	VarCount      int
	ImportCount   int
	CrossingCount int
}

type QueryParam struct {
	Key   string
	Value string
}

type RealmData struct {
	ComponentContent Component
	TocItems         *RealmTOCData
}

type RealmNotice struct {
	// Text is shown at every width, unless Short is set.
	Text BannerData
	// Short, if set, replaces Text below the lg breakpoint.
	Short BannerData
}

type RealmTOCData struct {
	Items []*TocItem
}

type RedirectData struct {
	To        string
	Analytics AnalyticsData
}

type SnippetHighlighter interface {
	Render(fileName string, source []byte) (template.HTML, error)
}

type SourceData struct {
	PkgPath      string
	Files        []string
	FileName     string
	FileSize     string
	FileLines    int
	FileCounter  int
	FileDownload string
	FileSource   Component
}

type SourceTocData struct {
	Icon         string
	ReadmeFile   SourceTocItem
	LicenseFile  SourceTocItem
	GnoFiles     []SourceTocItem
	GnoTestFiles []SourceTocItem
	TomlFiles    []SourceTocItem
}

type SourceTocItem struct {
	Link string
	Text string
}

type StatusData struct {
	Title      string
	Body       string
	ButtonURL  string
	ButtonText string
}

type SubpackageLink struct {
	Name     string
	Path     string
	Synopsis string
}

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

type TocItem struct {
	Title string
	ID    string
	// Icon is an optional sprite id suffix (e.g. "kind-func") rendered as a
	// leading kind glyph. Empty means no glyph — realm/action/source TOCs leave
	// it unset, so only the package overview surfaces icons.
	Icon string
	// Link points off the current page, e.g. at a file in the source view. When
	// it is empty the item anchors to its own ID.
	Link  string
	Items []*TocItem
}

type TypeEntry struct {
	Name               string
	SignatureComponent Component
	Doc                Component
	Kind               string
	Methods            []FuncEntry
	AnchorID           string
	SourceURL          string
}

type UserContribution struct {
	Title       string
	URL         string
	Type        UserContributionType
	Description string
	Size        int
	Date        *time.Time
}

type UserContributionType int

type UserData struct {
	// Username is the name the page is titled by, empty when the namespace is
	// an address with no name behind it: the page is then titled by Address.
	Username string
	// Namespace is the namespace whose home realm the page links to: the
	// name's, the address's when only it has one, or the full address when no
	// name resolves. Links use this, never Username, which may be elided.
	Namespace string
	// HomeLabel is Namespace as the home button prints it, shortened when it
	// is an address, so it differs from Username whenever Namespace is one.
	HomeLabel string
	// Address is the full bech32 address, empty when none could be resolved.
	Address string
	// CurrentName is the name Username now resolves to, set only when it is
	// another one: Username is then an old name, and Address its new owner's.
	CurrentName string
	// Registration is what the registry answered, which an empty Username
	// cannot tell apart: no user, or no answer.
	Registration  UserRegistration
	Bio           string
	Teams         []struct{}
	Links         []UserLink
	Contributions []UserContribution
	PackageCount  int
	RealmCount    int
	PureCount     int
	Content       Component
}

type UserLink struct {
	Type  UserLinkType
	URL   string
	Title string
}

type UserLinkType string

type UserRegistration int

type ValueGroup struct {
	Kind               string // "const" | "var"
	Names              string
	SignatureComponent Component
	Doc                Component
	AnchorID           string
	SourceURL          string
}

type View struct {
	Type ViewType
	// SkipTargetInBody marks views that render their rail before the content
	// and so carry #main-content themselves, past the rail; <main> carries it
	// otherwise. Set by the constructor that picks the template.
	SkipTargetInBody bool
	Component
}

type ViewMode int

type ViewType string