forge

package module

Go to main page

Versions in this module

v1

v1.18.0

May 8, 2026

Changes in this version

type App

+ func (a *App) BaseURL() string

+ func (a *App) GeneratePreviewToken(prefix, slug string) string

type Config

+ PreviewTokenExpiry time.Duration

v1.17.0

May 5, 2026

Changes in this version

type App

+ func (a *App) AddSignalListener(fn func(Signal, string, any))

+ func (a *App) WebhookPool() WebhookJobQueue

+ func (a *App) WebhookStore() *WebhookStore

+ func (a *App) Webhooks(store *WebhookStore) *App

+ type Clock interface

+ After func(d time.Duration) <-chan time.Time

+ Now func() time.Time

type Config

+ WebhookWorkers int

+ type DeliveryLog struct

+ AttemptedAt time.Time

+ DurationMS int64

+ Error string

+ ID string

+ JobID string

+ StatusCode int

+ type OutboundJob struct

+ Attempts int

+ CreatedAt time.Time

+ EndpointID string

+ Event string

+ ExpiresAt time.Time

+ ID string

+ NextRetryAt time.Time

+ Payload []byte

+ SecretEnc string

+ Status string

+ TargetURL string

type Signal

+ const AfterSchedule

+ type Titled interface

+ ContentTitle func() string

+ type WebhookEndpoint struct

+ Active bool

+ CreatedAt time.Time

+ Events []string

+ ID string

+ TargetURL string

+ type WebhookEventPayload struct

+ Data json.RawMessage

+ Event string

+ ID string

+ Timestamp time.Time

+ type WebhookJobQueue interface

+ DeliveryStats func(ctx context.Context, endpointID string) (total, success, failed int, lastAttempt *time.Time, err error)

+ Enqueue func(ctx context.Context, job OutboundJob) error

+ ListDeliveryLogs func(ctx context.Context, jobID string) ([]DeliveryLog, error)

+ ListJobsForEndpoint func(ctx context.Context, endpointID string) ([]OutboundJob, error)

+ RetryDead func(ctx context.Context, jobID string) error

+ type WebhookStore struct

+ func NewWebhookStore(db DB, appSecret []byte) *WebhookStore

+ func (s *WebhookStore) Create(ctx context.Context, targetURL string, events []string) (WebhookEndpoint, string, error)

+ func (s *WebhookStore) DecryptSecret(ep WebhookEndpoint) ([]byte, error)

+ func (s *WebhookStore) Delete(ctx context.Context, id string) error

+ func (s *WebhookStore) EndpointsForEvent(ctx context.Context, event string) ([]WebhookEndpoint, error)

+ func (s *WebhookStore) List(ctx context.Context) ([]WebhookEndpoint, error)

v1.16.0

May 4, 2026

Changes in this version

type App

+ func (a *App) Static(prefix string, prod fs.FS, devDir string)

type Config

+ Dev bool

v1.15.0

May 4, 2026

Changes in this version

type MemoryRepo

+ func (r *MemoryRepo[T]) Seq(_ context.Context, opts ListOptions) iter.Seq2[T, error]

type SQLRepo

+ func (r *SQLRepo[T]) Seq(ctx context.Context, opts ListOptions) iter.Seq2[T, error]

+ type SeqRepository interface

+ Seq func(ctx context.Context, opts ListOptions) iter.Seq2[T, error]

v1.14.1

May 2, 2026

Changes in this version

type Option

+ func ListHeadFunc[T any](fn func(Context, []T) Head) Option

v1.14.0

May 2, 2026

Changes in this version

+ const Article

+ const CSRFCookieName

+ const Event

+ const FAQPage

+ const HowTo

+ const Organization

+ const Product

+ const Recipe

+ const Review

+ var ErrBadRequest = newSentinel(http.StatusBadRequest, "bad_request", "Bad request")

+ var ErrConflict = newSentinel(http.StatusConflict, "conflict", "Conflict")

+ var ErrForbidden = newSentinel(http.StatusForbidden, "forbidden", "Forbidden")

+ var ErrGone = newSentinel(http.StatusGone, "gone", "This content has been removed")

+ var ErrInternal = newSentinel(http.StatusInternalServerError, "internal_server_error", ...)

+ var ErrLastAdmin = newSentinel(http.StatusConflict, "last_admin", "Cannot revoke the last active admin token")

+ var ErrNotAcceptable = newSentinel(http.StatusNotAcceptable, "not_acceptable", "Not acceptable")

+ var ErrNotFound = newSentinel(http.StatusNotFound, "not_found", "Not found")

+ var ErrRequestTooLarge = newSentinel(http.StatusRequestEntityTooLarge, "request_too_large", "Request too large")

+ var ErrTooManyRequests = newSentinel(http.StatusTooManyRequests, "too_many_requests", "Too many requests")

+ var ErrUnauth = newSentinel(http.StatusUnauthorized, "unauthorized", "Unauthorized")

+ var GuestUser = User

+ func AbsURL(base, path string) string

+ func Authenticate(auth AuthFunc) func(http.Handler) http.Handler

+ func CORS(origin string) func(http.Handler) http.Handler

+ func CSRF(auth AuthFunc) func(http.Handler) http.Handler

+ func Chain(h http.Handler, middlewares ...func(http.Handler) http.Handler) http.Handler

+ func ClearCookie(w http.ResponseWriter, c Cookie)

+ func ConsentFor(r *http.Request, cat CookieCategory) bool

+ func Excerpt(text string, maxLen int) string

+ func GenerateSlug(input string) string

+ func GrantConsent(w http.ResponseWriter, cats ...CookieCategory)

+ func HasRole(userRoles []Role, required Role) bool

+ func InMemoryCache(ttl time.Duration, opts ...Option) func(http.Handler) http.Handler

+ func IsRole(userRoles []Role, required Role) bool

+ func MaxBodySize(n int64) func(http.Handler) http.Handler

+ func NewID() string

+ func NewRole(name string) roleBuilder

+ func QueryOne[T any](ctx context.Context, db DB, query string, args ...any) (T, error)

+ func Query[T any](ctx context.Context, db DB, query string, args ...any) ([]T, error)

+ func RateLimit(n int, d time.Duration, opts ...Option) func(http.Handler) http.Handler

+ func ReadCookie(r *http.Request, name string) (string, bool)

+ func Recoverer() func(http.Handler) http.Handler

+ func RequestLogger() func(http.Handler) http.Handler

+ func Require(errs ...error) error

+ func RevokeConsent(w http.ResponseWriter)

+ func RobotsTxt(cfg RobotsConfig, baseURL string) string

+ func RobotsTxtHandler(cfg RobotsConfig, baseURL string) http.HandlerFunc

+ func RunValidation(v any) error

+ func SchemaFor(head Head, content any) string

+ func SecurityHeaders() func(http.Handler) http.Handler

+ func SetCookie(w http.ResponseWriter, c Cookie, value string)

+ func SetCookieIfConsented(w http.ResponseWriter, r *http.Request, c Cookie, value string) bool

+ func SignToken(user User, secret string, ttl time.Duration) (string, error)

+ func TemplateFuncMap() template.FuncMap

+ func URL(parts ...string) string

+ func UniqueSlug(base string, exists func(string) bool) string

+ func ValidateStruct(v any) error

+ func WriteError(w http.ResponseWriter, r *http.Request, err error)

+ func WriteSitemapFragment(w io.Writer, entries []SitemapEntry) error

+ func WriteSitemapIndex(w io.Writer, fragmentURLs []string, lastMod time.Time) error

+ type AIDocSummary interface

+ AISummary func() string

+ type AIFeature int

+ const AIDoc

+ const LLMsTxt

+ const LLMsTxtFull

+ type Alternate struct

+ Locale string

+ URL string

+ type App struct

+ func New(cfg Config) *App

+ func (a *App) Config() Config

+ func (a *App) Content(v any, opts ...Option)

+ func (a *App) Cookies(decls ...Cookie)

+ func (a *App) CookiesManifestAuth(auth AuthFunc)

+ func (a *App) Handle(pattern string, handler http.Handler)

+ func (a *App) Handler() http.Handler

+ func (a *App) Health()

+ func (a *App) MCPModules() []MCPModule

+ func (a *App) MustParseTemplate(path string) *template.Template

+ func (a *App) Nav(items ...NavItem)

+ func (a *App) NavTree() *NavTree

+ func (a *App) Partials(dir string) *App

+ func (a *App) Redirect(from, to string, code RedirectCode)

+ func (a *App) RedirectManifestAuth(auth AuthFunc)

+ func (a *App) RedirectStore() *RedirectStore

+ func (a *App) Run(addr string) error

+ func (a *App) SEO(opts ...SEOOption)

+ func (a *App) Secret() []byte

+ func (a *App) TokenStore() *TokenStore

+ func (a *App) Use(mws ...func(http.Handler) http.Handler)

+ type AppSchema struct

+ Logo string

+ Name string

+ Type string

+ URL string

+ type AuthFunc interface

+ func AnyAuth(fns ...AuthFunc) AuthFunc

+ func BasicAuth(username, password string) AuthFunc

+ func BearerHMAC(secret string) AuthFunc

+ func CookieSession(name, secret string, opts ...Option) AuthFunc

+ type Breadcrumb struct

+ Label string

+ URL string

+ func Crumb(label, url string) Breadcrumb

+ func Crumbs(crumbs ...Breadcrumb) []Breadcrumb

+ type CacheStore struct

+ func NewCacheStore(ttl time.Duration, max int) *CacheStore

+ func (c *CacheStore) Flush()

+ func (c *CacheStore) Sweep()

+ type ChangeFreq string

+ const Always

+ const Daily

+ const Hourly

+ const Monthly

+ const Never

+ const Weekly

+ const Yearly

+ type Config struct

+ AppSchema *AppSchema

+ Auth AuthFunc

+ BaseURL string

+ DB DB

+ HTTPS bool

+ IdleTimeout time.Duration

+ MediaMaxSize int64

+ MediaPath string

+ NavMode NavMode

+ OGDefaults *OGDefaults

+ ReadTimeout time.Duration

+ Secret []byte

+ TokenStore *TokenStore

+ Version string

+ WriteTimeout time.Duration

+ func MustConfig(cfg Config) Config

+ type Context interface

+ Locale func() string

+ Request func() *http.Request

+ RequestID func() string

+ Response func() http.ResponseWriter

+ SiteName func() string

+ User func() User

+ func ContextFrom(w http.ResponseWriter, r *http.Request) Context

+ func NewBackgroundContext(siteName string) Context

+ func NewContextWithUser(user User) Context

+ func NewTestContext(user User) Context

+ type Cookie struct

+ Category CookieCategory

+ Domain string

+ HttpOnly bool

+ MaxAge int

+ Name string

+ Path string

+ Purpose string

+ SameSite http.SameSite

+ Secure bool

+ type CookieCategory string

+ const Analytics

+ const Marketing

+ const Necessary

+ const Preferences

+ type CrawlerPolicy string

+ const Allow

+ const AskFirst

+ const Disallow

+ type DB interface

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...any) *sql.Row

+ type Error interface

+ Code func() string

+ HTTPStatus func() int

+ Public func() string

+ type EventDetails struct

+ Address string

+ EndDate time.Time

+ Location string

+ StartDate time.Time

+ type EventProvider interface

+ EventDetails func() EventDetails

+ type FAQEntry struct

+ Answer string

+ Question string

+ type FAQProvider interface

+ FAQEntries func() []FAQEntry

+ type FeedConfig struct

+ Description string

+ Language string

+ Title string

+ type FeedStore struct

+ func NewFeedStore(siteName, baseURL string) *FeedStore

+ func (s *FeedStore) HasFeeds() bool

+ func (s *FeedStore) IndexHandler() http.Handler

+ func (s *FeedStore) ModuleHandler(prefix string) http.Handler

+ func (s *FeedStore) Set(prefix string, cfg FeedConfig, items []rssItem)

+ type From string

+ type Head struct

+ Alternates []Alternate

+ Author string

+ Breadcrumbs []Breadcrumb

+ Canonical string

+ Description string

+ Image Image

+ Modified time.Time

+ NoIndex bool

+ Published time.Time

+ Social SocialOverrides

+ Tags []string

+ Title string

+ Type string

+ type HeadAssets struct

+ Links []HeadLink

+ Preconnect []string

+ Scripts []ScriptTag

+ Stylesheets []string

+ type HeadLink struct

+ Href string

+ Rel string

+ Sizes string

+ Type string

+ type Headable interface

+ Head func() Head

+ type HowToProvider interface

+ HowToSteps func() []HowToStep

+ type HowToStep struct

+ Name string

+ Text string

+ type Image struct

+ Alt string

+ Height int

+ URL string

+ Width int

+ type LLMsEntry struct

+ Summary string

+ Title string

+ URL string

+ type LLMsStore struct

+ func NewLLMsStore(siteName string) *LLMsStore

+ func (s *LLMsStore) CompactHandler() http.Handler

+ func (s *LLMsStore) FullHandler() http.Handler

+ func (s *LLMsStore) HasCompact() bool

+ func (s *LLMsStore) HasFull() bool

+ func (s *LLMsStore) SetCompact(prefix string, entries []LLMsEntry)

+ func (s *LLMsStore) SetFull(prefix string, body string)

+ type LLMsTemplateData struct

+ Description string

+ Entries []LLMsEntry

+ GeneratedAt string

+ ItemCount int

+ SiteName string

+ type ListOptions struct

+ Desc bool

+ OrderBy string

+ Page int

+ PerPage int

+ Status []Status

+ func (o ListOptions) Offset() int

+ type MCPField struct

+ Description string

+ Enum []string

+ Format string

+ JSONName string

+ MaxLength int

+ MinLength int

+ Name string

+ Required bool

+ Type string

+ type MCPMeta struct

+ Operations []MCPOperation

+ Prefix string

+ TypeName string

+ type MCPModule interface

+ MCPArchive func(ctx Context, slug string) error

+ MCPCreate func(ctx Context, fields map[string]any) (any, error)

+ MCPDelete func(ctx Context, slug string) error

+ MCPGet func(ctx Context, slug string) (any, error)

+ MCPList func(ctx Context, status ...Status) ([]any, error)

+ MCPMeta func() MCPMeta

+ MCPPublish func(ctx Context, slug string) error

+ MCPSchedule func(ctx Context, slug string, at time.Time) error

+ MCPSchema func() []MCPField

+ MCPUpdate func(ctx Context, slug string, fields map[string]any) (any, error)

+ type MCPOperation string

+ const MCPRead

+ const MCPWrite

+ type Markdownable interface

+ Markdown func() string

+ type MemoryRepo struct

+ func NewMemoryRepo[T any]() *MemoryRepo[T]

+ func (r *MemoryRepo[T]) Delete(_ context.Context, id string) error

+ func (r *MemoryRepo[T]) FindAll(_ context.Context, opts ListOptions) ([]T, error)

+ func (r *MemoryRepo[T]) FindByID(_ context.Context, id string) (T, error)

+ func (r *MemoryRepo[T]) FindBySlug(_ context.Context, slug string) (T, error)

+ func (r *MemoryRepo[T]) Save(_ context.Context, node T) error

+ type Module struct

+ func NewModule[T any](proto T, opts ...Option) *Module[T]

+ func (m *Module[T]) MCPArchive(ctx Context, slug string) error

+ func (m *Module[T]) MCPCreate(ctx Context, fields map[string]any) (any, error)

+ func (m *Module[T]) MCPDelete(ctx Context, slug string) error

+ func (m *Module[T]) MCPGet(ctx Context, slug string) (any, error)

+ func (m *Module[T]) MCPList(ctx Context, status ...Status) ([]any, error)

+ func (m *Module[T]) MCPMeta() MCPMeta

+ func (m *Module[T]) MCPPublish(ctx Context, slug string) error

+ func (m *Module[T]) MCPSchedule(ctx Context, slug string, at time.Time) error

+ func (m *Module[T]) MCPSchema() []MCPField

+ func (m *Module[T]) MCPUpdate(ctx Context, slug string, fields map[string]any) (any, error)

+ func (m *Module[T]) Register(mux *http.ServeMux)

+ func (m *Module[T]) Stop()

+ type NavItem struct

+ Children []*NavItem

+ Ghost bool

+ Hidden bool

+ ID string

+ Label string

+ Module string

+ ParentID string

+ Path string

+ SortOrder int

+ type NavMode int

+ const NavModeCode

+ const NavModeDB

+ type NavTree struct

+ func (n *NavTree) Create(ctx context.Context, item NavItem) (NavItem, error)

+ func (n *NavTree) Delete(ctx context.Context, id string) error

+ func (n *NavTree) Get(id string) (NavItem, bool)

+ func (n *NavTree) HasDB() bool

+ func (n *NavTree) List() []NavItem

+ func (n *NavTree) Tree() []NavItem

+ func (n *NavTree) Update(ctx context.Context, item NavItem) (NavItem, error)

+ type Node struct

+ CreatedAt time.Time

+ ID string

+ PublishedAt time.Time

+ ScheduledAt *time.Time

+ Slug string

+ Status Status

+ UpdatedAt time.Time

+ func (n *Node) GetPublishedAt() time.Time

+ func (n *Node) GetSlug() string

+ func (n *Node) GetStatus() Status

+ type OGDefaults struct

+ Image Image

+ TwitterCreator string

+ TwitterSite string

+ type Option interface

+ var WithoutCSRF Option = withoutCSRFOption{}

+ func AIIndex(features ...AIFeature) Option

+ func At(prefix string) Option

+ func Auth(opts ...Option) Option

+ func Cache(ttl time.Duration) Option

+ func CacheMaxEntries(n int) Option

+ func ContextFunc(fn func(ctx Context, item any) (any, error)) Option

+ func Delete(r Role) Option

+ func DisableFeed() Option

+ func Feed(cfg FeedConfig) Option

+ func HeadFunc[T any](fn func(Context, T) Head) Option

+ func MCP(ops ...MCPOperation) Option

+ func ManifestAuth(auth AuthFunc) Option

+ func Middleware(mws ...func(http.Handler) http.Handler) Option

+ func On[T any](signal Signal, h func(Context, T) error) Option

+ func Read(r Role) Option

+ func Redirects(from From, to string) Option

+ func Repo[T any](r Repository[T]) Option

+ func Social(features ...SocialFeature) Option

+ func Templates(dir string) Option

+ func TemplatesOptional(dir string) Option

+ func TrustedProxy() Option

+ func WithoutID() Option

+ func Write(r Role) Option

+ type OrganizationDetails struct

+ Description string

+ Logo Image

+ Name string

+ URL string

+ type OrganizationProvider interface

+ OrganizationDetails func() OrganizationDetails

+ type PageHead struct

+ AppSchema template.HTML

+ Head Head

+ HeadAssets *HeadAssets

+ OGDefaults *OGDefaults

+ type RecipeDetails struct

+ Ingredients []string

+ Steps []HowToStep

+ type RecipeProvider interface

+ RecipeDetails func() RecipeDetails

+ type RedirectCode int

+ const Gone

+ const Permanent

+ type RedirectEntry struct

+ Code RedirectCode

+ From string

+ IsPrefix bool

+ To string

+ type RedirectStore struct

+ func NewRedirectStore() *RedirectStore

+ func (s *RedirectStore) Add(e RedirectEntry)

+ func (s *RedirectStore) All() []RedirectEntry

+ func (s *RedirectStore) Get(path string) (RedirectEntry, bool)

+ func (s *RedirectStore) Len() int

+ func (s *RedirectStore) Load(ctx context.Context, db DB) error

+ func (s *RedirectStore) Remove(ctx context.Context, db DB, from string) error

+ func (s *RedirectStore) Save(ctx context.Context, db DB, e RedirectEntry) error

+ type Registrator interface

+ Register func(mux *http.ServeMux)

+ type Repository interface

+ Delete func(ctx context.Context, id string) error

+ FindAll func(ctx context.Context, opts ListOptions) ([]T, error)

+ FindByID func(ctx context.Context, id string) (T, error)

+ FindBySlug func(ctx context.Context, slug string) (T, error)

+ Save func(ctx context.Context, node T) error

+ type ReviewDetails struct

+ BestRating float64

+ Body string

+ Rating float64

+ WorstRating float64

+ type ReviewProvider interface

+ ReviewDetails func() ReviewDetails

+ type RobotsConfig struct

+ AIScraper CrawlerPolicy

+ Disallow []string

+ Sitemaps bool

+ type Role string

+ const Admin

+ const Author

+ const Editor

+ const Guest

+ type SEOOption interface

+ type SQLRepo struct

+ func NewSQLRepo[T any](db DB, opts ...SQLRepoOption) *SQLRepo[T]

+ func (r *SQLRepo[T]) Delete(ctx context.Context, id string) error

+ func (r *SQLRepo[T]) FindAll(ctx context.Context, opts ListOptions) ([]T, error)

+ func (r *SQLRepo[T]) FindByID(ctx context.Context, id string) (T, error)

+ func (r *SQLRepo[T]) FindBySlug(ctx context.Context, slug string) (T, error)

+ func (r *SQLRepo[T]) Save(ctx context.Context, item T) error

+ type SQLRepoOption interface

+ func Table(name string) SQLRepoOption

+ type Scheduler struct

+ func (s *Scheduler) Start(ctx context.Context)

+ func (s *Scheduler) Wait()

+ type ScriptTag struct

+ Async bool

+ Body template.JS

+ Defer bool

+ Src string

+ type Signal string

+ const AfterArchive

+ const AfterCreate

+ const AfterDelete

+ const AfterPublish

+ const AfterUnpublish

+ const AfterUpdate

+ const BeforeCreate

+ const BeforeDelete

+ const BeforeUpdate

+ const SitemapRegenerate

+ type SitemapConfig struct

+ ChangeFreq ChangeFreq

+ Priority float64

+ type SitemapEntry struct

+ ChangeFreq ChangeFreq

+ LastMod time.Time

+ Loc string

+ Priority float64

+ func SitemapEntries[T SitemapNode](items []T, baseURL string, cfg SitemapConfig) []SitemapEntry

+ type SitemapNode interface

+ GetPublishedAt func() time.Time

+ GetSlug func() string

+ GetStatus func() Status

+ type SitemapPrioritiser interface

+ SitemapPriority func() float64

+ type SitemapStore struct

+ func NewSitemapStore() *SitemapStore

+ func (s *SitemapStore) Get(path string) ([]byte, bool)

+ func (s *SitemapStore) Handler() http.Handler

+ func (s *SitemapStore) IndexHandler(baseURL string) http.Handler

+ func (s *SitemapStore) Paths() []string

+ func (s *SitemapStore) Set(path string, data []byte)

+ type SocialFeature int

+ const OpenGraph

+ const TwitterCard

+ type SocialOverrides struct

+ Twitter TwitterMeta

+ type Status string

+ const Archived

+ const Draft

+ const Published

+ const Scheduled

+ type TemplateData struct

+ Content T

+ Extra any

+ Nav []NavItem

+ Request *http.Request

+ SiteName string

+ User User

+ func NewTemplateData[T any](ctx Context, content T, head Head, siteName string) TemplateData[T]

+ type TokenRecord struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ Name string

+ RevokedAt time.Time

+ Role string

+ type TokenStore struct

+ func NewTokenStore(db DB, secret string) *TokenStore

+ func (ts *TokenStore) Create(ctx context.Context, name, role string, ttl time.Duration) (string, error)

+ func (ts *TokenStore) List(ctx context.Context) ([]TokenRecord, error)

+ func (ts *TokenStore) Revoke(ctx context.Context, id string) error

+ type TwitterCardType string

+ const AppCard

+ const PlayerCard

+ const Summary

+ const SummaryLargeImage

+ type TwitterMeta struct

+ Card TwitterCardType

+ Creator string

+ type User struct

+ ID string

+ Name string

+ Roles []Role

+ func VerifyBearerToken(r *http.Request, secret []byte, store *TokenStore) (User, bool)

+ func (u User) HasRole(role Role) bool

+ func (u User) Is(role Role) bool

+ type Validatable interface

+ Validate func() error

+ type ValidationError struct

+ func Err(field, message string) *ValidationError

+ func (e *ValidationError) Code() string

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) HTTPStatus() int

+ func (e *ValidationError) Public() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL