vukem

Oct 19, 2026

Changes in this version

type App

+ func (a *App) RequireMailer() error

type Option

+ func WithHealthCheck(name string, check HealthCheck) Option

Oct 18, 2026

Changes in this version

type Option

+ func WithOpenAPI(info openapi.Info) Option

Oct 18, 2026

Changes in this version

type MiddlewareOptions

+ CSRFTokenFallback bool

type Option

+ func WithEventsFake(f *events.Fake) Option

+ func WithRateLimiters(f ratelimit.Factory) Option

+ func WithViewFuncs(funcs template.FuncMap) Option

Oct 18, 2026

Changes in this version

+ var ErrUseDefault = errors.New("vukem: use the configured default store")

type App

+ func (a *App) Flags() (*flags.Flags, error)

type Config

+ MaxHeaderBytes int

+ RateLimitIPv6Prefix int

+ type FlagSeeder interface

+ SeedFlags func(fs *flag.FlagSet)

type Option

+ func WithFlags(list ...flags.AnyFlag) Option

type TelegramConfig

+ APIURL string

Oct 17, 2026

Changes in this version

type App

+ func (a *App) DerivePreviousKeys(purpose string, n int) [][]byte

type MailConfig

+ MailtrapAPIToken config.Secret

+ MailtrapInboxID int64

Oct 17, 2026

Changes in this version

+ var ErrInstrumentTooLate = errors.New(...)

+ var ErrNotBooted = errors.New("vukem: routes after boot are pending; call Boot before Handler")

+ var ErrRoutesCompiled = errors.New(...)

+ var ErrWarmupRun = errors.New("vukem: a warmup app cannot boot or run")

+ func APIMiddlewareWith(app *App, r *router.Router, opts APIMiddlewareOptions) error

+ func ServeOpenAPIWith(app *App, r *router.Router, path string, opts OpenAPIOptions) *router.Route

+ type APIMiddlewareOptions struct

+ I18n *i18n.MiddlewareConfig

+ SecureHeaders func(cfg *middleware.SecureHeadersConfig)

type App

+ func (a *App) Instrument(in Instrumentation) error

+ func (a *App) MailLaterTx(ctx context.Context, ex database.Executor, mailable mail.Mailable, ...) error

+ type AppSeeder interface

+ SeedApp func(ctx context.Context, app *App) error

+ func NamedAppSeeder(name string, fn AppSeederFunc) AppSeeder

+ type AppSeederFunc func(ctx context.Context, app *App) error

+ func (f AppSeederFunc) SeedApp(ctx context.Context, app *App) error

type Config

+ HSTSForce bool

+ type Instrumentation struct

+ Jobs queue.Observer

+ Mail func(mail.Transport) mail.Transport

+ Queries database.QueryObserver

type MiddlewareOptions

+ I18n *i18n.MiddlewareConfig

+ type OpenAPIOptions struct

+ InProduction bool

+ PathPrefix string

type Option

+ func WithAppSeeders(seeders ...AppSeeder) Option

+ func WithQueryObservers(obs ...database.QueryObserver) Option

+ func WithRoutesAfterBoot(fn func(r *router.Router, app *App) error) Option

+ func WithTelegram(fn func(cfg *telegram.Config)) Option

type QueueConfig

+ InServe bool

type SessionConfig

+ RecordClient bool

type TelegramConfig

+ Log bool

+ RateLimit int

Oct 17, 2026

Changes in this version

+ const DefaultHealthCheckTimeout

+ var ErrLegacyMail = errors.New("vukem: clear-text mail job refused (QUEUE_ALLOW_LEGACY_MAIL is off)")

+ func DefaultMiddlewareWith(app *App, r *router.Router, opts MiddlewareOptions) error

type App

+ func (a *App) AddHealthCheckTimeout(name string, timeout time.Duration, check HealthCheck)

+ func (a *App) CheckHealth(ctx context.Context) map[string]error

+ func (a *App) DeriveKey(purpose string, n int) ([]byte, error)

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

+ func (a *App) Stderr() io.Writer

+ func (a *App) Stdin() io.Reader

+ func (a *App) Stdout() io.Writer

type Config

+ ClientIPHeader string

+ TrustForwardedProto bool

+ TrustedProxies string

+ type MiddlewareOptions struct

+ CSRFBypass []string

+ SecureHeaders func(cfg *middleware.SecureHeadersConfig)

+ SessionBypass []string

+ Stateless bool

type Option

+ func WithCacheStoreFunc(fn func(app *App) (cache.Store, error)) Option

+ func WithJobsFunc(fn func(app *App) []queue.Registration) Option

+ func WithQueueDriverFunc(fn func(app *App) (queue.Driver, error)) Option

+ func WithSessionStoreFunc(fn func(app *App) (session.Store, error)) Option

+ func WithStderr(w io.Writer) Option

type QueueConfig

+ AllowLegacyMail bool

type ScheduleConfig

+ InServe bool

Oct 17, 2026

Changes in this version

type App

+ func (a *App) RateLimiters() (ratelimit.Factory, error)

+ type RateLimitConfig struct

+ Store string

Oct 17, 2026

Changes in this version

type Config

+ LogDedupWindow string

Oct 17, 2026

Changes in this version

type Config

+ H2C bool

Oct 16, 2026

Changes in this version

type App

+ Devtools *devtools.Devtools

type Config

+ Devtools bool

+ DevtoolsInsecureAllowRemote bool

type Option

+ func WithDevtools() Option

Oct 16, 2026

Changes in this version

type App

+ Crypt *crypt.Encrypter

+ I18n *i18n.Bundle

+ Inertia *inertia.Inertia

+ Vite *vite.Vite

type Config

+ PreviousKeys config.Secret

type Kind

+ const KindWarmup

type Option

+ func WithInertia(cfg inertia.Config) Option

+ func WithStdin(r io.Reader) Option

+ func WithTranslations(fsys fs.FS) Option

+ func WithVite(fsys fs.FS) Option

Oct 16, 2026

Changes in this version

type Option

+ func WithCacheStore(s cache.Store) Option

+ func WithSessionStore(s session.Store) Option

Oct 16, 2026

Changes in this version

+ const MailJobKind

+ var ErrNoFailedStore = errors.New(...)

type App

+ func (a *App) Call(ctx context.Context, name string, args []string) error

+ func (a *App) MailLater(ctx context.Context, mailable mail.Mailable, opts ...queue.Option) error

+ func (a *App) Queue() (*queue.Queue, error)

+ func (a *App) Schedule() (*schedule.Schedule, error)

type Option

+ func WithJobs(regs ...queue.Registration) Option

+ func WithQueueDriver(d queue.Driver) Option

+ func WithSchedule(fn func(s *schedule.Schedule, app *App)) Option

+ type QueueConfig struct

+ Concurrency int

+ Connection string

+ FailedTable string

+ Queues string

+ Table string

+ func (c QueueConfig) QueueNames() []string

+ type ScheduleConfig struct

+ Timezone string

Oct 16, 2026

Changes in this version

+ func ServeOpenAPI(app *App, r *router.Router, path string) *router.Route

type App

+ func (a *App) OpenAPI() (*openapi.Document, error)

type Config

+ APIVersion string

+ OpenAPIInProduction bool

+ OpenAPIPrefix string

Oct 16, 2026

Changes in this version

type App

+ Telegram *telegram.Handler

+ type TelegramConfig struct

+ BotToken config.Secret

+ ChatID string

+ MinLevel string

+ ThreadID int

Oct 16, 2026

Changes in this version

type App

+ Events *events.Bus

+ func (a *App) Cache() (*cache.Cache, error)

+ type CacheConfig struct

+ MaxEntries int

+ Prefix string

+ Store string

+ Table string

type Option

+ func WithListeners(regs ...events.Registration) Option

Oct 16, 2026

Changes in this version

+ func APIMiddleware(app *App, r *router.Router) error

Oct 16, 2026

Changes in this version

type App

+ func (a *App) Mailer() (*mail.Mailer, error)

+ type MailConfig struct

+ From string

+ Mailer string

+ ResendAPIKey config.Secret

+ SMTPHost string

+ SMTPInsecure bool

+ SMTPPassword config.Secret

+ SMTPPort int

+ SMTPUsername string

type Option

+ func WithMailTransport(t mail.Transport) Option

Oct 16, 2026

Changes in this version

type App

+ func (a *App) Seed(ctx context.Context) error

type Option

+ func WithSeeders(seeders ...Seeder) Option

+ type Seeder interface

+ Seed func(ctx context.Context, db *database.DB) error

+ type SeederFunc func(ctx context.Context, db *database.DB) error

+ func (f SeederFunc) Seed(ctx context.Context, db *database.DB) error

Oct 16, 2026

Changes in this version

+ const DefaultIdleTimeout

+ const DefaultMaxHeaderBytes

+ const DefaultReadHeaderTimeout

+ const DefaultReadTimeout

+ const DefaultWriteTimeout

+ func DefaultMiddleware(app *App, r *router.Router) error

+ func Main(build BuildFunc) int

+ func RunMain(ctx context.Context, args []string, getenv func(string) (string, bool), ...) error

+ type App struct

+ Config Config

+ Key config.Key

+ Kind Kind

+ Log *slog.Logger

+ Router *router.Router

+ Source *config.Source

+ Views *view.Engine

+ func New(opts ...Option) (*App, error)

+ func (a *App) AddCommand(cmds ...Command)

+ func (a *App) AddHealthCheck(name string, check HealthCheck)

+ func (a *App) AddRunner(name string, r Runner)

+ func (a *App) Addr() string

+ func (a *App) Boot(ctx context.Context) error

+ func (a *App) Commands() []Command

+ func (a *App) DB() (*database.DB, error)

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

+ func (a *App) Migrator() (*schema.Migrator, error)

+ func (a *App) Now() time.Time

+ func (a *App) OnShutdown(fn func(context.Context) error)

+ func (a *App) Run(ctx context.Context) error

+ func (a *App) Sessions() (*session.Manager, error)

+ func (a *App) SetSessionStore(store session.Store)

+ func (a *App) Shutdown(ctx context.Context) error

+ type Booter interface

+ Boot func(ctx context.Context, app *App) error

+ type BuildFunc func(opts ...Option) (*App, error)

+ type Command interface

+ Description func() string

+ Flags func(fs *flag.FlagSet)

+ Name func() string

+ Run func(ctx context.Context, app *App, args []string) error

+ type CommandFunc struct

+ CommandName string

+ DefineFlags func(fs *flag.FlagSet)

+ Desc string

+ Fn func(ctx context.Context, app *App, args []string) error

+ func (c CommandFunc) Description() string

+ func (c CommandFunc) Flags(set *flag.FlagSet)

+ func (c CommandFunc) Name() string

+ func (c CommandFunc) Run(ctx context.Context, app *App, args []string) error

+ type Config struct

+ Debug bool

+ Env config.Env

+ Host string

+ Key config.Secret

+ LogFormat string

+ LogLevel string

+ Name string

+ Port int

+ ShutdownTimeout time.Duration

+ URL string

+ func (c *Config) IsProduction() bool

+ type DatabaseConfig struct

+ MaxIdle int

+ MaxOpen int

+ URL string

+ type HTTPServer struct

+ Listener net.Listener

+ Ready chan<- string

+ Server *http.Server

+ ShutdownTimeout time.Duration

+ func NewHTTPServer(addr string, handler http.Handler) *HTTPServer

+ func (s *HTTPServer) Run(ctx context.Context) error

+ type HealthCheck func(ctx context.Context) error

+ type Kind string

+ const KindConsole

+ const KindTest

+ const KindWeb

+ type KindFilter interface

+ Kinds func() []Kind

+ type Option func(*options) error

+ func WithClock(now func() time.Time) Option

+ func WithDatabaseDrivers(drivers ...database.Driver) Option

+ func WithEnv(fsys fs.FS, getenv func(string) (string, bool)) Option

+ func WithKind(k Kind) Option

+ func WithLogOutput(w io.Writer) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMigrations(migrations []schema.Migration) Option

+ func WithProviders(p ...Provider) Option

+ func WithReady(ch chan<- string) Option

+ func WithRoutes(fn func(r *router.Router, app *App) error) Option

+ func WithRunner(name string, r Runner) Option

+ func WithSource(src *config.Source) Option

+ func WithStdout(w io.Writer) Option

+ func WithViews(fsys fs.FS) Option

+ func WithoutHTTP() Option

+ type Provider interface

+ Register func(app *App) error

+ type ProviderFunc func(app *App) error

+ func (f ProviderFunc) Register(app *App) error

+ type Runner interface

+ Run func(ctx context.Context) error

+ type RunnerFunc func(ctx context.Context) error

+ func (f RunnerFunc) Run(ctx context.Context) error

+ type SessionConfig struct

+ CookieName string

+ Driver string

+ IdleTimeout time.Duration

+ Lifetime time.Duration

+ Secure string

+ type Shutdowner interface

+ Shutdown func(ctx context.Context, app *App) error