runtime

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

type CacheOptions struct {
	// Driver selects the cache store: "memory" (default) or "redis".
	Driver string
	// Prefix is prepended to every cache key on shared stores.
	Prefix string
	// RedisURL configures the redis driver, e.g. redis://localhost:6379/0.
	RedisURL string
}

type Check func(context.Context) error

type DevToolsOptions struct {
	// Enabled serves the development dashboard. The runtime refuses to
	// start when devtools are enabled outside the development environment.
	Enabled bool
	// Path is the dashboard mount point, defaulting to /_ginkit.
	Path string
}

type DocsOptions struct {
	// Enabled serves the OpenAPI spec and Swagger UI.
	Enabled bool
	// Path is the Swagger UI page, defaulting to /docs.
	Path string
	// SpecPath is the JSON document, defaulting to /openapi.json.
	SpecPath string
	// Title defaults to "API".
	Title string
	// Version defaults to "0.1.0".
	Version string
	// Description is the optional human-readable OpenAPI description.
	Description string
	// Servers lists the base URLs shown in the spec.
	Servers []string
	// BasicAuthUsername and BasicAuthPassword, when both set, protect the
	// docs and spec endpoints with HTTP basic auth.
	BasicAuthUsername string
	// BasicAuthPassword pairs with BasicAuthUsername to protect both docs routes.
	BasicAuthPassword string
}

type HTTPOptions struct {
	// Address is the HTTP listen address, defaulting to :8080.
	Address string
	// ReadTimeout limits time spent reading an entire request.
	ReadTimeout time.Duration
	// WriteTimeout limits time spent writing one response.
	WriteTimeout time.Duration
	// IdleTimeout limits how long an idle keep-alive connection is retained.
	IdleTimeout time.Duration
	// ShutdownTimeout bounds graceful HTTP and runner shutdown.
	ShutdownTimeout time.Duration
	// MaxBodyBytes rejects larger request bodies with body_too_large.
	MaxBodyBytes int64
	// UI enables session- and template-oriented browser defaults.
	UI bool
	// CORSOrigins is the explicit allowlist for cross-origin browser requests.
	CORSOrigins []string
	// RateLimit configures the per-client request limiter.
	RateLimit RateLimitOptions
	// TrustedProxies lists proxy IPs or CIDRs whose forwarded headers
	// (X-Forwarded-For) are honored when resolving client addresses. When
	// empty, no proxy is trusted and the socket peer address is used.
	TrustedProxies []string
}

type MetricsOptions struct {
	// Enabled mounts the metrics endpoint and records HTTP collectors.
	Enabled bool
	// Path is the scrape endpoint, defaulting to /metrics.
	Path string
	// Registry optionally receives the HTTP collectors instead of a new
	// registry with the standard Go and process collectors.
	Registry *prometheus.Registry
}

type Options struct {
	// Environment selects development or production safety behavior.
	Environment string
	// Logger receives runtime and request-scoped structured logs.
	Logger *slog.Logger
	// HTTP supplies server and middleware configuration.
	HTTP HTTPOptions
	// Validator replaces the default validator used by request binders.
	Validator *validation.Validator
	// ErrorMapper converts application errors into the canonical HTTP envelope.
	ErrorMapper httpx.Mapper
	// Readiness maps dependency names to checks exposed by the readiness route.
	Readiness map[string]Check
	// Database opens an owned database connection when non-nil.
	Database *runtimedb.Config
	// Metrics configures Prometheus instrumentation.
	Metrics MetricsOptions
	// PProf configures profiling routes.
	PProf PProfOptions
	// Cache configures the cache store returned by Application.Cache.
	Cache CacheOptions
	// Queue configures the queue returned by Application.Queue.
	Queue QueueOptions
	// Docs configures generated API documentation routes.
	Docs DocsOptions
	// DevTools configures the development-only diagnostics dashboard.
	DevTools DevToolsOptions
}

type PProfOptions struct {
	// Enabled mounts profiling routes only when the application explicitly opts in.
	Enabled bool
	// Prefix is the mount point, defaulting to /debug/pprof. The endpoints
	// expose process internals and must never be reachable publicly.
	Prefix string
}

type QueueOptions struct {
	// Driver selects the job backend: "sync" (default, inline execution) or
	// "redis" (asynq worker supervised by Run).
	Driver string
	// RedisURL configures the redis driver, e.g. redis://localhost:6379/0.
	RedisURL string
	// Concurrency is the redis worker goroutine count, defaulting to 10.
	Concurrency int
}

type RateLimitOptions struct {
	// Enabled store data used by this type.
	Enabled bool
	// RequestsPerMinute store data used by this type.
	RequestsPerMinute int
	// Burst store data used by this type.
	Burst int
	// Key store data used by this type.
	Key func(*gin.Context) string
}

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