gnoweb

type AliasKind int

type AliasTarget struct {
	Value string
	Kind  AliasKind
}

type AppConfig struct {
	// UnsafeHTML, if enabled, allows to use HTML in the markdown.
	UnsafeHTML bool
	// Analytics enables SimpleAnalytics.
	Analytics bool
	// NodeRemote is the remote address of the gno.land node.
	NodeRemote string
	// RemoteHelp is the remote of the gno.land node, as used in the help page.
	RemoteHelp string
	// ChainID is the chain id, used for constructing the help page.
	ChainID string
	// AssetsPath is the base path to the gnoweb assets.
	AssetsPath string
	// AssetDir, if set, will be used for assets instead of the embedded public directory.
	AssetsDir string
	// FaucetURL, if specified, will be the URL to which `/faucet` redirects.
	FaucetURL string
	// Domain is the domain used by the node.
	Domain string
	// Aliases is a map of aliases pointing to another path or a static file.
	Aliases map[string]AliasTarget
}

type ContentRenderer interface {
	// Render renders the content of a source file and write it on the given writer.
	// It returns a Table of Contents (Toc) and an error if any occurs.
	Render(w io.Writer, u *weburl.GnoURL, src []byte) (md.Toc, error)
}

type FileMeta struct {
	Lines  int
	SizeKb float64
}

type HTMLWebClient struct {
	Formatter *chromahtml.Formatter
	// contains filtered or unexported fields
}

type HTMLWebClientConfig struct {
	Domain            string
	RPCClient         *client.RPCClient
	ChromaStyle       *chroma.Style
	ChromaHTMLOptions []chromahtml.Option
}

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

type MarkdownRendererConfig struct {
	GoldmarkOptions []goldmark.Option
}

type MockPackage struct {
	Path      string
	Domain    string
	Files     map[string]string // filename -> body
	Functions []*doc.JSONFunc
}

type MockWebClient struct {
	Packages map[string]*MockPackage // path -> package
}

type RealmMeta struct {
	Toc md.Toc
}

type StaticMetadata struct {
	Domain     string
	AssetsPath string
	ChromaPath string
	RemoteHelp string
	ChainId    string
	Analytics  bool
}

type WebClient interface {
	// RenderRealm renders the content of a realm from a given path and
	// arguments into the giver `writer`. The method should ensures the rendered
	// content is safely handled and formatted.
	RenderRealm(w io.Writer, u *weburl.GnoURL, cr ContentRenderer) (*RealmMeta, error)

	// SourceFile fetches and writes the source file from a given
	// package path, file name and if raw. The method should ensures the source
	// file's content is safely handled and formatted.
	SourceFile(w io.Writer, pkgPath, fileName string, isRaw bool) (*FileMeta, error)

	// QueryPath list any path given the specified prefix
	QueryPaths(prefix string, limit int) ([]string, error)

	// Doc retrieves the JSON doc suitable for printing from a
	// specified package path.
	Doc(path string) (*doc.JSONDocumentation, error)

	// Sources lists all source files available in a specified
	// package path.
	Sources(path string) ([]string, error)
}

type WebHandler struct {
	Logger           *slog.Logger
	Static           StaticMetadata
	Client           WebClient
	MarkdownRenderer *MarkdownRenderer
	Aliases          map[string]AliasTarget
}

type WebHandlerConfig struct {
	Meta             StaticMetadata
	WebClient        WebClient
	MarkdownRenderer *MarkdownRenderer
	Aliases          map[string]AliasTarget
}