middleware

type Authentication ¶ added in v0.7.0

type Authentication struct {
	Authenticator Authenticator
}

func NewAuthentication(authr Authenticator) *Authentication

func (m *Authentication) Apply(h http.Handler) http.Handler

func (*Authentication) Name() string

type Authenticator ¶ added in v0.7.0

type Authenticator interface {
	Authenticate(*http.Request) (any, error)
	OnError(http.ResponseWriter, *http.Request, error)
}

type Cache ¶

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

Cache returns a middleware that sets the "Cache-Control" header on HTTP responses, specifying that the response can be cached by any cache and defining the maximum age (in seconds) that the response is considered fresh. The duration parameter determines the max-age value. This middleware should be used to control client and proxy caching behavior for HTTP handlers.

func NewCache(dur time.Duration) *Cache

func (c *Cache) Apply(h http.Handler) http.Handler

func (*Cache) Name() string

type ColorScheme ¶

type ColorScheme struct {
	UseHeaders bool
	Key        string
}

ColorScheme is a middleware that manages the user's color scheme preference via a cookie. It checks for the "pacis_color_scheme" cookie in the incoming request. If the cookie exists and its value is "light" or "dark", it uses that value as the theme. Otherwise, it defaults to "light" and sets the cookie accordingly. The selected theme is stored in the request's context under the key "theme" for downstream handlers to access.

func NewColorScheme(key string) *ColorScheme

func (m *ColorScheme) Apply(h http.Handler) http.Handler

func (*ColorScheme) Name() string

type Gzip ¶

type Gzip struct {
	Dev bool
}

GzipHandler wraps an HTTP handler, to transparently gzip the response body if the client supports it (via the Accept-Encoding header). This will compress at the default compression level.

func DefaultGzip(dev bool) *Gzip

func (g *Gzip) Apply(h http.Handler) http.Handler

func (*Gzip) Name() string

type KeyType ¶

type KeyType string

type Locale ¶

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

Locale is a middleware that determines the user's preferred language from a cookie ("pacis_locale"), a "lang" form value, or the "Accept-Language" HTTP header, falling back to the provided default language if none are set or valid. It parses the locale, creates an i18n.Localizer, and injects both the localizer and the language tag into the request context for downstream handlers to use.

func NewLocale(key string, bundle *i18n.Bundle, defaultlang language.Tag) *Locale

func (l *Locale) Apply(h http.Handler) http.Handler

func (*Locale) Name() string

type Logger ¶

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

Logger returns a middleware that logs HTTP requests using the provided slog.Logger. It records the request method, status code, path, remote address, user agent, and duration. The middleware wraps the next http.Handler and logs the request details after it is served.

Example usage:

mux.Use(Logger(logger))

Parameters:

logger - the slog.Logger instance used for logging request details.

Returns:

A middleware function compatible with http.Handler.

func NewLogger(logger *slog.Logger) *Logger

func (l *Logger) Apply(h http.Handler) http.Handler

func (*Logger) Name() string

type Middleware ¶

type Middleware interface {
	Apply(http.Handler) http.Handler
}

type Recover ¶ added in v0.7.0

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

func NewRecover(logger *slog.Logger, callback func(any)) *Recover

func (m *Recover) Apply(h http.Handler) http.Handler

func (*Recover) Name() string