gnoweb

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
}

type FileMeta struct {
	Lines  int
	SizeKb float64
}

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

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

type MockPackage struct {
	Path      string
	Domain    string
	Files     map[string]string // filename -> body
	Functions []vm.FunctionSignature
}

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

type PageData struct {
	Layout       string
	Component    string
	IsDevmodView bool
}

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, path string, args string) (*RealmMeta, error)

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

	// Functions retrieves a list of function signatures from a
	// specified package path.
	Functions(path string) ([]vm.FunctionSignature, 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
}

type WebHandlerConfig struct {
	Meta      StaticMetadata
	WebClient WebClient
}