components

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
	BuildTime  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
}

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

type BreadcrumbData struct {
	Parts    []BreadcrumbPart
	ArgParts []BreadcrumbPart
	Queries  []QueryParam
}

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 DirData struct {
	PkgPath     string
	FileCounter int
	FilesLinks  FilesLinks
	Mode        ViewMode
	Readme      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
	Image             string
	URL               string
	ChromaPath        string
	AssetsPath        string
	AnalyticsHostname string
	Remote            string
	ChainId           string
	BuildTime         string
}

type HeaderData struct {
	RealmPath  string
	RealmURL   weburl.GnoURL
	Breadcrumb BreadcrumbData
	Links      HeaderLinks
	ChainId    string
	Remote     string
	Mode       ViewMode
	Static     bool
}

type HeaderLink struct {
	Label    string
	URL      string
	Icon     string
	IsActive bool
	// 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 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
}

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
}

type IndexData struct {
	HeadData
	HeaderData
	FooterData
	BodyView *View
	Mode     ViewMode
	Theme    string
	Banner   BannerData
}

type License struct {
	Kind     string
	FileName string
}

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
	Imports     []ImportLink
	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

	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
}

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 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
	OverviewLink 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
	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      string
	Handlename    string
	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 ValueGroup struct {
	Kind               string // "const" | "var"
	Names              string
	SignatureComponent Component
	Doc                Component
	AnchorID           string
	SourceURL          string
}

type View struct {
	Type ViewType
	Component
}

type ViewMode int

type ViewType string