middleware

type BasicAuthConfig struct {
	Skipper        func(*zinc.Context) bool
	Extractor      BasicAuthExtractor
	Validator      BasicAuthValidator
	SuccessHandler zinc.RouteHandler
	ErrorHandler   BasicAuthErrorHandler
	Realm          string
}

type BasicAuthCredentials struct {
	Username string
	Password string
	Source   BasicAuthSource
}

type BasicAuthErrorHandler func(*zinc.Context, error) error

type BasicAuthExtractor func(*zinc.Context) (BasicAuthCredentials, error)

type BasicAuthIdentity struct {
	Username string
	Source   BasicAuthSource
}

type BasicAuthPair struct {
	Username string
	Password string
}

type BasicAuthSource string

type BasicAuthValidator func(*zinc.Context, BasicAuthCredentials) (bool, error)

type BodyDumpConfig struct {
	Skipper          func(*zinc.Context) bool
	Observe          BodyDumpObserver
	Redact           BodyDumpRedactor
	MaxRequestBytes  int64
	MaxResponseBytes int64
}

type BodyDumpObserver func(*zinc.Context, BodyDumpSnapshot)

type BodyDumpRedactor func(*zinc.Context, *BodyDumpSnapshot)

type BodyDumpSnapshot struct {
	Method            string
	Path              string
	RoutePath         string
	Status            int
	RequestBody       []byte
	ResponseBody      []byte
	RequestBytes      int64
	ResponseBytes     int64
	RequestTruncated  bool
	ResponseTruncated bool
	Error             error
}

type BodyLimitConfig struct {
	Skipper func(*zinc.Context) bool
	Limit   int64
}

type BodyLimitError struct {
	Limit    int64
	Observed int64
	Source   BodyLimitSource
}

type BodyLimitSource string

type CORSConfig struct {
	AllowOrigins     []string
	AllowMethods     []string
	AllowHeaders     []string
	ExposeHeaders    []string
	AllowCredentials bool
	MaxAge           int
	Skipper          func(*zinc.Context) bool
}

type CORSOption func(*CORSConfig)

type CSRFConfig struct {
	Skipper        func(*zinc.Context) bool
	Readers        []CSRFReader
	Generate       CSRFGenerator
	TokenBytes     int
	Cookie         CSRFCookie
	ExposeHeader   string
	TrustedOrigins []string
	AllowFetchSite CSRFFetchSiteDecider
	ErrorHandler   CSRFErrorHandler
}

type CSRFCookie struct {
	Name     string
	Domain   string
	Path     string
	MaxAge   int
	Secure   bool
	HTTPOnly bool
	SameSite http.SameSite
}

type CSRFDecision struct {
	Site    CSRFFetchSite
	Origin  string
	Trusted bool
}

type CSRFErrorHandler func(*zinc.Context, error) error

type CSRFFetchSite string

type CSRFFetchSiteDecider func(*zinc.Context, CSRFDecision) (bool, error)

type CSRFGenerator func(*zinc.Context) (string, error)

type CSRFReader func(*zinc.Context) ([]string, error)

type CSRFReason string

type CSRFState struct {
	Token      string
	CookieName string
	Issued     bool
	Verified   bool
	FetchSite  CSRFFetchSite
}

type CSRFViolation struct {
	Reason     CSRFReason
	CookieName string
	FetchSite  CSRFFetchSite
	Origin     string
	Cause      error
}

type CasbinAuthConfig struct {
	Skipper        func(*zinc.Context) bool
	Enforcer       CasbinEnforcer
	Subject        CasbinValueFunc
	Object         CasbinValueFunc
	Action         CasbinValueFunc
	SuccessHandler zinc.RouteHandler
	ErrorHandler   CasbinErrorHandler
}

type CasbinEnforcer interface {
	Enforce(args ...any) (bool, error)
}

type CasbinErrorHandler func(*zinc.Context, error) error

type CasbinValueFunc func(*zinc.Context) any

type ContextTimeoutConfig struct {
	Skipper      func(*zinc.Context) bool
	Timeout      time.Duration
	ErrorHandler ContextTimeoutErrorHandler
}

type ContextTimeoutError struct {
	Info  ContextTimeoutInfo
	Cause error
}

type ContextTimeoutErrorHandler func(*zinc.Context, *ContextTimeoutError) error

type ContextTimeoutInfo struct {
	Timeout  time.Duration
	Deadline time.Time
}

type DecompressConfig struct {
	Skipper             func(*zinc.Context) bool
	MaxDecompressedSize int64
}

type GzipConfig struct {
	Skipper   func(*zinc.Context) bool
	Level     int
	MinLength int
}

type HeaderRoute struct {
	Header     string
	Value      string
	Middleware zinc.Middleware
}

type JWTConfig struct {
	Skipper        func(*zinc.Context) bool
	Extractor      JWTExtractor
	NewClaims      func(*zinc.Context) jwtgo.Claims
	KeyFunc        JWTKeyFunc
	ParseTokenFunc JWTParseTokenFunc
	ParserOptions  []jwtgo.ParserOption
	Validate       JWTValidateFunc
	SuccessHandler zinc.RouteHandler
	ErrorHandler   JWTErrorHandler
	Realm          string
}

type JWTErrorHandler func(*zinc.Context, error) error

type JWTExtractor func(*zinc.Context) (string, error)

type JWTKeyFunc func(*zinc.Context, *jwtgo.Token) (any, error)

type JWTParseTokenFunc func(*zinc.Context, string) (*jwtgo.Token, error)

type JWTValidateFunc func(*zinc.Context, *jwtgo.Token) error

type JaegerConfig struct {
	Skipper   func(*zinc.Context) bool
	Observe   JaegerObserver
	Operation JaegerOperationName
	Now       func() time.Time
}

type JaegerObserver func(*zinc.Context, JaegerSpan) error

type JaegerOperationName func(*zinc.Context) string

type JaegerSpan struct {
	TraceID      string
	SpanID       string
	ParentSpanID string
	Flags        string
	Operation    string
	StartTime    time.Time
	Duration     time.Duration
	Error        error
}

type KeyAuthConfig struct {
	Skipper        func(*zinc.Context) bool
	Extractor      KeyAuthExtractor
	Validator      KeyAuthValidator
	SuccessHandler zinc.RouteHandler
	ErrorHandler   KeyAuthErrorHandler
}

type KeyAuthCredentials struct {
	Key    string
	Source KeyAuthSource
}

type KeyAuthErrorHandler func(*zinc.Context, error) error

type KeyAuthExtractor func(*zinc.Context) (KeyAuthCredentials, error)

type KeyAuthSource string

type KeyAuthState struct {
	Key    string
	Source KeyAuthSource
}

type KeyAuthValidator func(*zinc.Context, KeyAuthCredentials) (bool, error)

type MethodOverrideConfig struct {
	Skipper       func(*zinc.Context) bool
	Getter        MethodOverrideGetter
	SourceMethods []string
	Methods       []string
}

type MethodOverrideGetter func(*zinc.Context) string

type PrometheusConfig struct {
	Skipper func(*zinc.Context) bool
	Metrics *PrometheusMetrics
	Now     func() time.Time
}

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

type ProxyBalancer interface {
	Next(*zinc.Context) (*ProxyTarget, error)
}

type ProxyConfig struct {
	Skipper        func(*zinc.Context) bool
	Target         string
	Targets        []*ProxyTarget
	Balancer       ProxyBalancer
	Director       func(*http.Request)
	Modify         func(*http.Response) error
	ModifyResponse func(*http.Response) error
	ErrorHandler   func(http.ResponseWriter, *http.Request, error)
	Retries        int
	RetryFilter    func(*zinc.Context, error) bool
	Rewrite        map[string]string
	RegexRewrite   map[*regexp.Regexp]string
	Transport      http.RoundTripper
}

type ProxyTarget struct {
	Name string
	URL  *url.URL
}

type RateLimiterConfig struct {
	// Rate is the token refill rate per second
	Rate float64
	// Capacity is the maximum number of tokens in the bucket
	Capacity float64
	// IPLookup is the function to extract IP address for per-IP rate limiting
	// If nil, the rate limiter applies globally
	IPLookup func(*zinc.Context) string
	// KeyGenerator is a custom function to generate keys for rate limiting
	// If nil and IPLookup is set, IP is used as key
	// If both nil, global rate limiting is used
	KeyGenerator func(*zinc.Context) string
	// StatusCode is the response code when rate limit is exceeded
	StatusCode int
	// LimitReachedHandler is called when rate limit is reached
	LimitReachedHandler zinc.RouteHandler
}

type RecoverConfig struct {
	Skipper      func(*zinc.Context) bool
	Handler      RecoverHandler
	StackSize    int
	DisableStack bool
}

type RecoverError struct {
	Value any
	Stack []byte
}

type RecoverHandler func(*zinc.Context, *RecoverError) error

type RedirectConfig struct {
	Skipper    func(*zinc.Context) bool
	Rules      map[string]string
	StatusCode int
}

type RequestIDConfig struct {
	Skipper   func(*zinc.Context) bool
	Header    string
	Generator RequestIDGenerator
}

type RequestIDGenerator func(*zinc.Context) (string, error)

type RequestIDState struct {
	ID        string
	Header    string
	Generated bool
}

type RequestLoggerConfig struct {
	// Skipper skips logging when it returns true.
	Skipper func(*zinc.Context) bool
	// BeforeNextFunc runs before the rest of the middleware/handler chain.
	BeforeNextFunc func(*zinc.Context)
	// LogValuesFunc receives extracted values and should emit logs.
	// If nil, a default slog logger implementation is used.
	LogValuesFunc func(*zinc.Context, RequestLoggerValues) error
	// HandleError forwards returned errors through zinc's error handler before logging.
	HandleError bool
	// Logger is used by the default LogValuesFunc. If nil, slog.Default() is used.
	Logger *slog.Logger

	LogLatency       bool
	LogMethod        bool
	LogURI           bool
	LogRoutePath     bool
	LogStatus        bool
	LogError         bool
	LogRemoteIP      bool
	LogHost          bool
	LogUserAgent     bool
	LogRequestID     bool
	LogContentLength bool
	LogResponseSize  bool
	LogHeaders       []string
	LogQueryParams   []string
	// contains filtered or unexported fields
}

type RequestLoggerValues struct {
	StartTime     time.Time
	Latency       time.Duration
	Method        string
	URI           string
	RoutePath     string
	Status        int
	Error         error
	RemoteIP      string
	Host          string
	UserAgent     string
	RequestID     string
	ContentLength string
	ResponseSize  int64
	Headers       map[string][]string
	QueryParams   map[string][]string
}

type RewriteConfig struct {
	Skipper func(*zinc.Context) bool
	Rules   map[string]string
}

type SecureConfig struct {
	Skipper                         func(*zinc.Context) bool
	XSSProtection                   string
	ContentTypeNosniff              string
	XFrameOptions                   string
	HSTSMaxAge                      int
	HSTSExcludeSubdomains           bool
	ContentSecurityPolicy           string
	ContentSecurityPolicyReportOnly string
	ReferrerPolicy                  string
	CrossOriginResourcePolicy       string
	PermissionsPolicy               string
}

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

type SessionConfig struct {
	Skipper         func(*zinc.Context) bool
	Name            string
	Secret          []byte
	Path            string
	Domain          string
	MaxAge          int
	Secure          bool
	HTTPOnly        bool
	DisableHTTPOnly bool
	SameSite        http.SameSite
}

type StaticConfig struct {
	Skipper        func(*zinc.Context) bool
	Filesystem     fs.FS
	Root           string
	Prefix         string
	NextOnNotFound bool
}

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

type TrailingSlashConfig struct {
	Skipper    func(*zinc.Context) bool
	Add        bool
	Redirect   bool
	StatusCode int
}